feat: tiClrminfo

src/client.ts

@@ -12,6 +12,7 @@ import type {
   SchoolScheduleParam,
   SchulAflcoinfoParam,
   SpsTimetableParam,
+  TiClrminfoParam,
 } from './types'
 
 export class Neis extends NeisRequest {
@@ -128,6 +129,16 @@ export class Neis extends NeisRequest {
   async getAflcoOne(params: SchulAflcoinfoParam) {
     return firstOf(this.schulAflcoinfoRaw(params))
   }
+
+  /** tiClrminfo */
+  async getClrm(params: TiClrminfoParam) {
+    return this.tiClrminfoRaw(params)
+  }
+
+  /** tiClrminfo */
+  async getClrmOne(params: TiClrminfoParam) {
+    return firstOf(this.tiClrminfoRaw(params))
+  }
 }
 
 const firstOf = <T>(promise: Promise<T[]>) => promise.then((res) => res[0])

src/http.ts

@@ -24,6 +24,8 @@ import type {
   SchulAflcoinfoResponse,
   SpsTimetableParam,
   SpsTimetableResponse,
+  TiClrminfoParam,
+  TiClrminfoResponse,
 } from './types'
 import type { AxiosInstance, AxiosRequestConfig } from 'axios'
 import axios from 'axios'
@@ -119,6 +121,10 @@ export class NeisRequest {
     return this.get<SchulAflcoinfoResponse>('schulAflcoinfo', params)
   }
 
+  protected async tiClrminfoRaw(params: TiClrminfoParam) {
+    return this.get<TiClrminfoResponse>('tiClrminfo', params)
+  }
+
   private async get<T>(endpoint: string, params: Params) {
     return this.request<T>('GET', endpoint, 5000, params)
   }

src/types.ts

@@ -149,6 +149,23 @@ export interface SchulAflcoinfoParam extends DefaultParamWithSchoolParam {
   readonly DGHT_CRSE_SC_NM?: string
 }
 
+export interface TiClrminfoParam extends DefaultParamWithSchoolParam {
+  /** 학년도 */
+  readonly AY?: string
+  /** 학년 */
+  readonly GRADE?: string
+  /** 학기 */
+  readonly SEM?: string
+  /** 학교과정명 */
+  readonly SCHUL_CRSE_SC_NM?: string
+  /** 주야과정명 */
+  readonly DGHT_CRSE_SC_NM?: string
+  /** 계열명 */
+  readonly ORD_SC_NM?: string
+  /** 학과명 */
+  readonly DDDEP_NM?: string
+}
+
 export type Params =
   | SchoolInfoParam
   | MealServiceDietInfoParam
@@ -161,6 +178,7 @@ export type Params =
   | ClassInfoParam
   | SchoolMajorinfoParam
   | SchulAflcoinfoParam
+  | TiClrminfoParam
 
 interface BaseSchoolResponse {
   /** 시도교육청코드 */
@@ -401,3 +419,24 @@ export interface SchulAflcoinfoResponse extends BaseSchoolResponse {
   /** 수정일 */
   readonly LOAD_DTM: string
 }
+
+export interface TiClrminfoResponse extends BaseSchoolResponse {
+  /** 학년도 */
+  readonly AY: string
+  /** 학년 */
+  readonly GRADE: string
+  /** 학기 */
+  readonly SEM: string
+  /** 학교과정명 */
+  readonly SCHUL_CRSE_SC_NM: string
+  /** 주야과정명 */
+  readonly DGHT_CRSE_SC_NM: string
+  /** 계열명 */
+  readonly ORD_SC_NM: string
+  /** 학과명 */
+  readonly DDDEP_NM: string
+  /** 강의실명 */
+  readonly CLRM_NM: string
+  /** 수정일 */
+  readonly LOAD_DTM: string
+}

tests/TiClrminfo.test.ts

@@ -0,0 +1,26 @@
+import type { TiClrminfoResponse } from '../src'
+import { AE, SE } from './constants'
+import { neis } from './utils'
+
+describe('TiClrminfo', () => {
+  it('should return TiClrminfoResponse[]', async () => {
+    const data = await neis.getClrm({
+      ATPT_OFCDC_SC_CODE: AE,
+      SD_SCHUL_CODE: SE,
+    })
+
+    expect(data).toMatchObject<TiClrminfoResponse[]>(data)
+  })
+
+  it('should return TiClrminfoResponse', async () => {
+    const data = await neis.getClrmOne({
+      ATPT_OFCDC_SC_CODE: AE,
+      SD_SCHUL_CODE: SE,
+      AY: '2023',
+      GRADE: '1',
+      SEM: '1',
+    })
+
+    expect(data).toMatchObject<TiClrminfoResponse>(data)
+  })
+})