parse-comcigan 0.0.3 → 0.0.5

package/README.md

@@ -31,7 +31,7 @@ import Comcigan from 'parse-comcigan';
 
 const comci = new Comcigan({
     "cacheMs": 10000, // 10초동안 캐시됩니다.
-    "doNotThrow": true, // true일때, status가 4 또는 5로 시작하면 throw 됩니다.
+    "doNotThrow": false, // false일때, status가 4 또는 5로 시작하면 throw 됩니다.
     "debug": (msg) => console.log(msg) // 모듈에서 디버그 메시지를 보내면 콘솔에 출력합니다.
 });
 ```
@@ -70,17 +70,27 @@ comci.SearchSchool("서울").then(data => {
 
 |파라메터|타입|필수|설명|
 |------|------|------|-----------|
-|schoolCode|number|Yes|학교 코드|
-|criteria|"weekday" or "period"|Yes|리스트 반환을 어떻게 할지 여부입니다.|
-|grade|number|Yes|학년|
-|classN|number|Yes|반|
+|options|[GetTimetableOptions](#gettimetableoptions)|Yes|옵션|
 
 ```typescript
-comci.GetTimetable(96211, "period", 3, 5).then(data => {
-    console.log(data[0][5]); // [요일][교시] 월요일 5교시
+comci.GetTimetable({
+    "schoolCode": 96211,
+    "criteria": "period",
+    "grade": 3,
+    "classN": 5,
+    "without8th": false
+}).then(data => {
+    console.log(data.timetable[0][7]); // [요일][교시] 월요일 8교시
 });
-comci.GetTimetable(96211, "weekday", 3, 5).then(data => {
-    console.log(data[5][0]); // [교시][요일] 월요일 5교시
+comci.GetTimetable({
+    "schoolCode": 96211,
+    "criteria": "weekday",
+    "grade": 3,
+    "classN": 5,
+    "without8th": true
+}).then(data => {
+    console.log(data.timetable[4][0]); // [교시][요일] 월요일 5교시
+    console.log(data.timetable[7]); // undefined
 });
 ```
 
@@ -120,8 +130,31 @@ comci.GetClassList(96211).then(data => {
 |changed|string|교사|Yes|
 |original|여기서 original만 빠진 오브젝트|원래 시간표|No|
 
+### GetTimetableOptions
+
+|파라메터|타입|필수|설명|
+|------|------|------|-----------|
+|schoolCode|number|Yes|학교 코드|
+|criteria|"weekday" or "period"|Yes|리스트 반환을 어떻게 할지 여부입니다.|
+|grade|number|Yes|학년|
+|classN|number|Yes|반|
+
 ## 업데이트 로그
 
+### 0.0.5
+
+- 문서의 많은 오류 수정
+- 8교시 제외 추가
+
+### 0.0.4
+
+- 모듈이 불러와지지 않던 버그 수정
+
+### 0.0.3
+
+- undefined 참조 버그 수정
+- 문서 잘못되어있던 버그 수정
+
 ### 0.0.2
 
 - package.json 수정

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "parse-comcigan",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "컴시간 알리미에서 시간표를 가져오는 라이브러리입니다.",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -14,7 +14,7 @@
     "dev": "nodemon --exec ts-node src/index.ts"
   },
   "devDependencies": {
-    "@types/node": "^22.14.1",
+    "@types/node": "^22.15.30",
     "nodemon": "^3.1.9",
     "ts-node": "^10.9.2",
     "typescript": "^5.8.3"
@@ -36,4 +36,4 @@
   "bugs": {
     "url": "https://github.com/Pro203S/parse-comcigan/issues"
   }
-}
+}

package/src/cache.ts

@@ -0,0 +1,32 @@
+export default class Cache {
+    private _cacheStorage: Collection<{
+        "timeout": NodeJS.Timeout;
+        "data": any;
+    }> = {};
+
+    public register(id: string, data: any, duration: number) {
+        this._cacheStorage[id] = {
+            "timeout": setTimeout(() => {
+                delete this._cacheStorage[id];
+            }, duration),
+            "data": data
+        };
+    }
+    public delete(id: string) {
+        clearTimeout(this._cacheStorage[id].timeout);
+        delete this._cacheStorage[id];
+    }
+    public clear() {
+        const caches = Object.keys(this._cacheStorage);
+        for (let cache of caches) {
+            clearTimeout(this._cacheStorage[cache].timeout);
+            delete this._cacheStorage[cache];
+        }
+    }
+    public has(id: string) {
+        return Boolean(this._cacheStorage[id]);
+    }
+    public get(id: string) {
+        return this._cacheStorage[id]?.data;
+    }
+}

package/src/index.ts

@@ -1,84 +1,33 @@
 import axios from 'axios';
 import iconv from 'iconv-lite';
+import Cache from './cache.js';
 
-class Cache {
-    private _cacheStorage: {
-        [id: string]: {
-            "timeout": NodeJS.Timeout;
-            "data": any;
-        }
-    } = {};
-
-    public register(id: string, data: any, duration: number) {
-        this._cacheStorage[id] = {
-            "timeout": setTimeout(() => {
-                delete this._cacheStorage[id];
-            }, duration),
-            "data": data
-        };
-    }
-    public delete(id: string) {
-        clearTimeout(this._cacheStorage[id].timeout);
-        delete this._cacheStorage[id];
-    }
-    public clear() {
-        const caches = Object.keys(this._cacheStorage);
-        for (let cache of caches) {
-            clearTimeout(this._cacheStorage[cache].timeout);
-            delete this._cacheStorage[cache];
-        }
-    }
-    public has(id: string) {
-        return Boolean(this._cacheStorage[id]);
-    }
-    public get(id: string) {
-        return this._cacheStorage[id]?.data;
-    }
-}
-
-//#region 내부 타입
-type RawComciganSearched = {
-    "학교검색": [
-        number,
-        string,
-        string,
-        number
-    ][];
-};
-type RawComciganTimetable = {
-    교사수: number;
-    성명: string[];
-    학급수: number[];
-    요일별시수: number[][];
-    과목명: any[];
-    시간표: any;
-    전일제: number[];
-    버젼: string;
-    동시수업수: number;
-    담임: number[][];
-    가상학급수: number[];
-    특별실수: number;
-    열람제한일: string;
-    저장일: string;
-    학기시작일자: string;
-    학교명: string;
-    지역명: string;
-    학년도: number;
-    분리?: number;
-    강의실: number;
-    시작일: string;
-    일과시간: string[];
-    일자자료: [number, string][];
-    오늘r: number;
-    학급시간표: any;
-    교사시간표: any[];
-    강의실시간표: any;
-    동시그룹: number[][];
-    컴시간?: string;
+//#region 타입 export
+export type GetTimetableOptions = {
+    /**
+     * 컴시간 학교 코드입니다.
+     */
+    "schoolCode": number,
+    /**
+     * 구분을 어떻게 할지 여부입니다.  
+     * 
+     * - weekday로 설정하면 시간표[교시][요일]로 과목과 선생님을 불러옵니다.
+     * - period로 설정하면 시간표[요일][교시]로 과목과 선생님을 불러옵니다.
+     */
+    "criteria": "weekday" | "period",
+    /**
+     * 학년입니다.
+     */
+    "grade": number,
+    /**
+     * 반입니다.
+     */
+    "classN": number,
+    /**
+     * 8교시를 빼고 리턴할지 여부입니다.
+     */
+    "without8th"?: boolean,
 };
-//#endregion
-
-//#region 외부 타입
 export interface ComciganInitializeType {
     /**
      * 이 기간동안 컴시간과 통신한 데이터가 캐시됩니다.  
@@ -230,7 +179,9 @@ export default class Comcigan {
      * @param schoolCode 
      * @param criteria 
      */
-    public async GetTimetable(schoolCode: number, criteria: "weekday" | "period", grade: number, classN: number): Promise<ComciganTimetable | undefined> {
+    public async GetTimetable(options: GetTimetableOptions): Promise<ComciganTimetable | undefined> {
+        const { schoolCode, criteria, grade, classN, without8th } = options;
+
         const str = `36174_${schoolCode}_1_4_0_3_1.00`;
         const route = (str.substring(9) + str.substring(0, 9)).split("").reverse().join("");
         const data = await this.request<string>(`7813?${route}`, true);
@@ -254,7 +205,7 @@ export default class Comcigan {
         if (criteria === "period") {
             for (let weekday = 1; weekday < WEEKDAY.length + 1; weekday++) {
                 const weekdayList: ComciganTimetableObject[] = [];
-                for (let period = 1; period < 9; period++) {
+                for (let period = 1; period < (without8th ? 8 : 9); period++) {
                     const o = origin[weekday][period];
                     const t = today[weekday][period];
 
@@ -292,7 +243,7 @@ export default class Comcigan {
                 toReturn.push(weekdayList);
             }
         } else {
-            for (let period = 1; period < 9; period++) {
+            for (let period = 1; period < (without8th ? 8 : 9); period++) {
                 const periodList: ComciganTimetableObject[] = [];
                 for (let weekday = 1; weekday < WEEKDAY.length + 1; weekday++) {
                     const o = origin[weekday][period];
@@ -356,9 +307,9 @@ export default class Comcigan {
         const json: RawComciganTimetable = JSON.parse(step2.slice(0, step2.indexOf("}") + 1));
         const rawClasses = json.학급수;
         if (!rawClasses) return [];
-        
+
         const toReturn: string[] = [];
-        
+
         for (let g = 1; g < rawClasses.length; g++) {
             for (let c = 1; c < rawClasses[g] + 1; c++) {
                 toReturn.push(`${g}-${c}`);

package/src/types/index.d.ts

@@ -0,0 +1,45 @@
+declare global {
+    type Collection<V = any> = { [key: string]: V };
+
+    type RawComciganSearched = {
+        "학교검색": [
+            number,
+            string,
+            string,
+            number
+        ][];
+    };
+    type RawComciganTimetable = {
+        교사수: number;
+        성명: string[];
+        학급수: number[];
+        요일별시수: number[][];
+        과목명: any[];
+        시간표: any;
+        전일제: number[];
+        버젼: string;
+        동시수업수: number;
+        담임: number[][];
+        가상학급수: number[];
+        특별실수: number;
+        열람제한일: string;
+        저장일: string;
+        학기시작일자: string;
+        학교명: string;
+        지역명: string;
+        학년도: number;
+        분리?: number;
+        강의실: number;
+        시작일: string;
+        일과시간: string[];
+        일자자료: [number, string][];
+        오늘r: number;
+        학급시간표: any;
+        교사시간표: any[];
+        강의실시간표: any;
+        동시그룹: number[][];
+        컴시간?: string;
+    };
+}
+
+export { }

package/tsconfig.json

@@ -11,7 +11,14 @@
     "esModuleInterop": true,
     "declaration": true,
     "strict": true,
-    "sourceMap": true
+    "sourceMap": true,
+    "types": [
+      "node"
+    ],
+    "typeRoots": [
+      "./src/types",
+      "./node_modules/@types"
+    ]
   },
   "include": [
     "src/**/*"