@kuroson/cse-students 0.3.1

package/CHANGELOG.md

@@ -0,0 +1,28 @@
+# @kuroson/cse-students
+
+## 0.3.1
+
+### Patch Changes
+
+- 61adb1e: Updated dependency `@typescript-eslint/eslint-plugin` to `8.50.1`.
+  Updated dependency `@typescript-eslint/parser` to `8.50.1`.
+  Updated dependency `typescript-eslint` to `8.50.1`.
+  Updated dependency `next` to `16.1.1`.
+  Updated dependency `eslint-config-next` to `16.1.1`.
+  Updated dependency `@next/third-parties` to `16.1.1`.
+  Updated dependency `ldapts` to `8.0.31`.
+  Updated dependency `@next/eslint-plugin-next` to `16.1.1`.
+  Updated dependency `eslint-plugin-jest` to `29.10.1`.
+  Updated dependency `nodemailer` to `7.0.12`.
+
+## 0.3.0
+
+### Minor Changes
+
+- cdb0acc: Initial release
+
+## 0.2.0
+
+### Features
+
+- Initial public release

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Alvin Cherk
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,144 @@
+# @kuroson/cse-students
+
+Student enrolment parser for UNSW CSE courses.
+
+## Installation
+
+```bash
+npm install @kuroson/cse-students
+# or
+pnpm add @kuroson/cse-students
+# or
+yarn add @kuroson/cse-students
+```
+
+## Usage
+
+```typescript
+import { Students, cleanUpName } from "@kuroson/cse-students";
+import type { StudentEnrolment, TimetableInformation } from "@kuroson/cse-students";
+
+// Parse students from a file
+const students = new Students({
+  pathToFile: "./enrolments.txt",
+});
+
+// Or parse from a string
+const students = new Students({
+  givenInput: "zID|name|class\n1234567|Smith, John|T09A",
+});
+
+// With timetable information for class code mapping
+const timetable: TimetableInformation = [
+  {
+    classCode: "T09",
+    expandedClassCode: "T09A",
+    tuteLabLocation: ["1-5", "Mon 10:00", "K17-101", "1-5", "Mon 11:00", "K17-102"],
+    tutors: [{ zID: "z1234567", name: "John Smith" }],
+  },
+];
+
+const students = new Students({
+  pathToFile: "./enrolments.txt",
+  timeTable: timetable,
+});
+
+// With optional winston logger
+import { createLogger } from "winston";
+const logger = createLogger();
+
+const students = new Students({
+  pathToFile: "./enrolments.txt",
+  winstonLogger: logger,
+});
+
+// Get parsed students
+const studentList = students.getStudents();
+// Returns: StudentEnrolment[]
+
+// Get timetable key mappings
+const keys = students.getTimeTableKeys();
+```
+
+## API
+
+### `Students`
+
+Main class for parsing student enrolments.
+
+#### Constructor Options
+
+```typescript
+type InputOptions = {
+  timeTable?: TimetableInformation;
+  winstonLogger?: Logger;
+} & ({ givenInput: string; pathToFile?: never } | { pathToFile: string; givenInput?: never });
+```
+
+- `givenInput` - Raw enrolment data as a string (mutually exclusive with `pathToFile`)
+- `pathToFile` - Path to enrolment file (mutually exclusive with `givenInput`)
+- `timeTable` - Optional timetable information for class code mapping
+- `winstonLogger` - Optional winston logger instance
+
+#### Methods
+
+- `getStudents()` - Returns array of parsed student enrolments
+- `getTimeTableKeys()` - Returns mapping of expanded class codes to class codes
+
+### `cleanUpName(name: string)`
+
+Utility function to clean up student names from "Last, First" format.
+
+```typescript
+cleanUpName("Smith, John"); // Returns: "John Smith"
+```
+
+### Types
+
+#### `StudentEnrolment`
+
+```typescript
+type StudentEnrolment = {
+  zID: string;
+  name: string;
+  class: string;
+  classCode?: string;
+};
+```
+
+#### `TimetableInformation`
+
+```typescript
+type TimetableInformation = Array<{
+  classCode: string;
+  expandedClassCode: string;
+  otherExpandedClassCode?: string;
+  tuteLabLocation: [
+    tuteWeeks: string,
+    tuteTime: string,
+    tuteLocation: string,
+    labWeeks: string,
+    labTime: string,
+    labLocation: string,
+  ];
+  tutors: Array<{ zID: string; name: string }>;
+}>;
+```
+
+## Input Format
+
+The expected input format is pipe-delimited with a header row:
+
+```
+zID|name|class
+1234567|Smith, John|T09A
+7654321|Doe, Jane|T10B
+```
+
+## Requirements
+
+- Node.js >= 22
+
+## License
+
+MIT

package/dist/index.cjs

@@ -0,0 +1,57 @@
+'use strict';
+
+require('winston');
+var fs = require('fs');
+
+// src/Students.ts
+var readFileFrom = (path, encoding = "utf-8") => {
+  if (fs.existsSync(path)) {
+    return fs.readFileSync(path, encoding);
+  }
+  throw new Error(`Failed to read file from expected directory: ${path}`);
+};
+var cleanUpName = (name) => {
+  const [last, first] = name.trim().split(",");
+  let finalName = `${first.trim()} ${last.trim()}`.replace(/'/g, "");
+  if (finalName.startsWith(".")) {
+    finalName = finalName.slice(1).trim();
+  }
+  return finalName.trim();
+};
+
+// src/Students.ts
+var Students = class {
+  students;
+  timeTableKeys = {};
+  constructor(inputOptions) {
+    const { timeTable, givenInput, pathToFile, winstonLogger: logger } = inputOptions;
+    this.timeTableKeys = timeTable?.reduce((acc, curr) => {
+      acc[curr.expandedClassCode] = curr.classCode;
+      return acc;
+    }, {}) ?? {};
+    const input = givenInput ?? readFileFrom(pathToFile, "utf-8");
+    const lines = input.split("\n").slice(1).filter((x) => x.length !== 0);
+    const students = lines.map((line) => {
+      const [zID, name, classCode] = line.split("|");
+      const alternativeClass = timeTable?.find((x) => x.otherExpandedClassCode === classCode);
+      return {
+        zID: `z${zID.trim()}`,
+        name: cleanUpName(name),
+        class: alternativeClass?.otherExpandedClassCode?.trim() ?? classCode?.trim() ?? "N/A",
+        classCode: alternativeClass?.classCode?.trim() ?? (classCode !== void 0 ? this.timeTableKeys[classCode.trim()] ?? "N/A" : "N/A")
+      };
+    });
+    logger?.verbose(`Read ${students.length} students`);
+    this.students = students.sort((a, b) => a.zID.localeCompare(b.zID));
+  }
+  /**
+   * Get the students as an array
+   */
+  getStudents = () => [...this.students];
+  getTimeTableKeys = () => ({ ...this.timeTableKeys });
+};
+
+exports.Students = Students;
+exports.cleanUpName = cleanUpName;
+//# sourceMappingURL=index.cjs.map
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/utils.ts","../src/Students.ts"],"names":["existsSync","readFileSync"],"mappings":";;;;;;AAQO,IAAM,YAAA,GAAe,CAAC,IAAA,EAAc,QAAA,GAA2B,OAAA,KAAoB;AACxF,EAAA,IAAIA,aAAA,CAAW,IAAI,CAAA,EAAG;AACpB,IAAA,OAAOC,eAAA,CAAa,MAAM,QAAQ,CAAA;AAAA,EACpC;AACA,EAAA,MAAM,IAAI,KAAA,CAAM,CAAA,6CAAA,EAAgD,IAAI,CAAA,CAAE,CAAA;AACxE,CAAA;AAMO,IAAM,WAAA,GAAc,CAAC,IAAA,KAAyB;AACnD,EAAA,MAAM,CAAC,MAAM,KAAK,CAAA,GAAI,KAAK,IAAA,EAAK,CAAE,MAAM,GAAG,CAAA;AAC3C,EAAA,IAAI,SAAA,GAAY,CAAA,EAAG,KAAA,CAAM,IAAA,EAAM,CAAA,CAAA,EAAI,IAAA,CAAK,IAAA,EAAM,CAAA,CAAA,CAAG,OAAA,CAAQ,IAAA,EAAM,EAAE,CAAA;AACjE,EAAA,IAAI,SAAA,CAAU,UAAA,CAAW,GAAG,CAAA,EAAG;AAC7B,IAAA,SAAA,GAAY,SAAA,CAAU,KAAA,CAAM,CAAC,CAAA,CAAE,IAAA,EAAK;AAAA,EACtC;AACA,EAAA,OAAO,UAAU,IAAA,EAAK;AACxB;;;ACjBO,IAAM,WAAN,MAAe;AAAA,EACH,QAAA;AAAA,EACA,gBAAuD,EAAC;AAAA,EAElE,YAAY,YAAA,EAA4B;AAC7C,IAAA,MAAM,EAAE,SAAA,EAAW,UAAA,EAAY,UAAA,EAAY,aAAA,EAAe,QAAO,GAAI,YAAA;AAErE,IAAA,IAAA,CAAK,aAAA,GACH,SAAA,EAAW,MAAA,CAAO,CAAC,KAAgC,IAAA,KAAS;AAC1D,MAAA,GAAA,CAAI,IAAA,CAAK,iBAAiB,CAAA,GAAI,IAAA,CAAK,SAAA;AACnC,MAAA,OAAO,GAAA;AAAA,IACT,CAAA,EAAG,EAAE,CAAA,IAAK,EAAC;AAEb,IAAA,MAAM,KAAA,GAAQ,UAAA,IAAc,YAAA,CAAa,UAAA,EAAY,OAAO,CAAA;AAC5D,IAAA,MAAM,KAAA,GAAQ,KAAA,CACX,KAAA,CAAM,IAAI,CAAA,CACV,KAAA,CAAM,CAAC,CAAA,CACP,MAAA,CAAO,CAAC,CAAA,KAAM,CAAA,CAAE,WAAW,CAAC,CAAA;AAC/B,IAAA,MAAM,QAAA,GAA+B,KAAA,CAAM,GAAA,CAAI,CAAC,IAAA,KAAS;AACvD,MAAA,MAAM,CAAC,GAAA,EAAK,IAAA,EAAM,SAAS,CAAA,GAAI,IAAA,CAAK,MAAM,GAAG,CAAA;AAK7C,MAAA,MAAM,mBAAmB,SAAA,EAAW,IAAA,CAAK,CAAC,CAAA,KAAM,CAAA,CAAE,2BAA2B,SAAS,CAAA;AAEtF,MAAA,OAAO;AAAA,QACL,GAAA,EAAK,CAAA,CAAA,EAAI,GAAA,CAAI,IAAA,EAAM,CAAA,CAAA;AAAA,QACnB,IAAA,EAAM,YAAY,IAAI,CAAA;AAAA,QACtB,OAAO,gBAAA,EAAkB,sBAAA,EAAwB,MAAK,IAAK,SAAA,EAAW,MAAK,IAAK,KAAA;AAAA,QAChF,SAAA,EACE,gBAAA,EAAkB,SAAA,EAAW,IAAA,EAAK,KACjC,SAAA,KAAc,MAAA,GAAa,IAAA,CAAK,aAAA,CAAc,SAAA,CAAU,IAAA,EAAM,KAAK,KAAA,GAAS,KAAA;AAAA,OACjF;AAAA,IACF,CAAC,CAAA;AACD,IAAA,MAAA,EAAQ,OAAA,CAAQ,CAAA,KAAA,EAAQ,QAAA,CAAS,MAAM,CAAA,SAAA,CAAW,CAAA;AAClD,IAAA,IAAA,CAAK,QAAA,GAAW,QAAA,CAAS,IAAA,CAAK,CAAC,CAAA,EAAG,CAAA,KAAM,CAAA,CAAE,GAAA,CAAI,aAAA,CAAc,CAAA,CAAE,GAAG,CAAC,CAAA;AAAA,EACpE;AAAA;AAAA;AAAA;AAAA,EAKO,WAAA,GAAc,MAAM,CAAC,GAAG,KAAK,QAAQ,CAAA;AAAA,EACrC,gBAAA,GAAmB,OAAO,EAAE,GAAG,KAAK,aAAA,EAAc,CAAA;AAC3D","file":"index.cjs","sourcesContent":["import { existsSync, readFileSync } from 'fs';\n\n/**\n * Reads input from a file and returns a string\n * @throws { Error } if the file does not exist\n * @param path path of file\n * @param encoding encoding, defaulted to \"utf-8\"\n */\nexport const readFileFrom = (path: string, encoding: BufferEncoding = 'utf-8'): string => {\n  if (existsSync(path)) {\n    return readFileSync(path, encoding);\n  }\n  throw new Error(`Failed to read file from expected directory: ${path}`);\n};\n\n/**\n * Cleans up the name by removing leading/trailing spaces and removing any leading periods\n * @param name in the format \"Last, First\"\n */\nexport const cleanUpName = (name: string): string => {\n  const [last, first] = name.trim().split(',') as [string, string];\n  let finalName = `${first.trim()} ${last.trim()}`.replace(/'/g, '');\n  if (finalName.startsWith('.')) {\n    finalName = finalName.slice(1).trim();\n  }\n  return finalName.trim();\n};\n","import { type Logger } from 'winston';\nimport type { StudentEnrolment, TimetableInformation } from './types';\nimport { cleanUpName, readFileFrom } from './utils';\n\ntype InputOptions = {\n  timeTable?: TimetableInformation;\n  winstonLogger?: Logger;\n} & ({ givenInput: string; pathToFile?: never } | { pathToFile: string; givenInput?: never });\n\nexport class Students {\n  private readonly students: StudentEnrolment[];\n  private readonly timeTableKeys: { [key: string]: string | undefined } = {};\n\n  public constructor(inputOptions: InputOptions) {\n    const { timeTable, givenInput, pathToFile, winstonLogger: logger } = inputOptions;\n\n    this.timeTableKeys =\n      timeTable?.reduce((acc: typeof this.timeTableKeys, curr) => {\n        acc[curr.expandedClassCode] = curr.classCode;\n        return acc;\n      }, {}) ?? {};\n\n    const input = givenInput ?? readFileFrom(pathToFile, 'utf-8');\n    const lines = input\n      .split('\\n')\n      .slice(1)\n      .filter((x) => x.length !== 0);\n    const students: StudentEnrolment[] = lines.map((line) => {\n      const [zID, name, classCode] = line.split('|') as [string, string, string | undefined];\n\n      /**\n       * This is in case teaching decides to combine classes but not update the fucking enrolments\n       */\n      const alternativeClass = timeTable?.find((x) => x.otherExpandedClassCode === classCode);\n\n      return {\n        zID: `z${zID.trim()}`,\n        name: cleanUpName(name),\n        class: alternativeClass?.otherExpandedClassCode?.trim() ?? classCode?.trim() ?? 'N/A',\n        classCode:\n          alternativeClass?.classCode?.trim() ??\n          (classCode !== undefined ? (this.timeTableKeys[classCode.trim()] ?? 'N/A') : 'N/A'),\n      };\n    });\n    logger?.verbose(`Read ${students.length} students`);\n    this.students = students.sort((a, b) => a.zID.localeCompare(b.zID));\n  }\n\n  /**\n   * Get the students as an array\n   */\n  public getStudents = () => [...this.students];\n  public getTimeTableKeys = () => ({ ...this.timeTableKeys });\n}\n"]}

package/dist/index.d.cts

@@ -0,0 +1,59 @@
+import { Logger } from 'winston';
+
+type StudentEnrolment = {
+    zID: string;
+    name: string;
+    class: string;
+    classCode?: string;
+};
+type TimetableInformation = Array<{
+    classCode: string;
+    expandedClassCode: string;
+    /**
+     * This is in case teaching decides to combine classes but not update the fucking enrolments
+     */
+    otherExpandedClassCode?: string;
+    tuteLabLocation: [
+        tuteWeeks: string,
+        tuteTime: string,
+        tuteLocation: string,
+        labWeeks: string,
+        labTime: string,
+        labLocation: string
+    ];
+    tutors: Array<{
+        zID: string;
+        name: string;
+    }>;
+}>;
+
+type InputOptions = {
+    timeTable?: TimetableInformation;
+    winstonLogger?: Logger;
+} & ({
+    givenInput: string;
+    pathToFile?: never;
+} | {
+    pathToFile: string;
+    givenInput?: never;
+});
+declare class Students {
+    private readonly students;
+    private readonly timeTableKeys;
+    constructor(inputOptions: InputOptions);
+    /**
+     * Get the students as an array
+     */
+    getStudents: () => StudentEnrolment[];
+    getTimeTableKeys: () => {
+        [key: string]: string | undefined;
+    };
+}
+
+/**
+ * Cleans up the name by removing leading/trailing spaces and removing any leading periods
+ * @param name in the format "Last, First"
+ */
+declare const cleanUpName: (name: string) => string;
+
+export { type StudentEnrolment, Students, type TimetableInformation, cleanUpName };

package/dist/index.d.ts

@@ -0,0 +1,59 @@
+import { Logger } from 'winston';
+
+type StudentEnrolment = {
+    zID: string;
+    name: string;
+    class: string;
+    classCode?: string;
+};
+type TimetableInformation = Array<{
+    classCode: string;
+    expandedClassCode: string;
+    /**
+     * This is in case teaching decides to combine classes but not update the fucking enrolments
+     */
+    otherExpandedClassCode?: string;
+    tuteLabLocation: [
+        tuteWeeks: string,
+        tuteTime: string,
+        tuteLocation: string,
+        labWeeks: string,
+        labTime: string,
+        labLocation: string
+    ];
+    tutors: Array<{
+        zID: string;
+        name: string;
+    }>;
+}>;
+
+type InputOptions = {
+    timeTable?: TimetableInformation;
+    winstonLogger?: Logger;
+} & ({
+    givenInput: string;
+    pathToFile?: never;
+} | {
+    pathToFile: string;
+    givenInput?: never;
+});
+declare class Students {
+    private readonly students;
+    private readonly timeTableKeys;
+    constructor(inputOptions: InputOptions);
+    /**
+     * Get the students as an array
+     */
+    getStudents: () => StudentEnrolment[];
+    getTimeTableKeys: () => {
+        [key: string]: string | undefined;
+    };
+}
+
+/**
+ * Cleans up the name by removing leading/trailing spaces and removing any leading periods
+ * @param name in the format "Last, First"
+ */
+declare const cleanUpName: (name: string) => string;
+
+export { type StudentEnrolment, Students, type TimetableInformation, cleanUpName };

package/dist/index.js

@@ -0,0 +1,54 @@
+import 'winston';
+import { existsSync, readFileSync } from 'fs';
+
+// src/Students.ts
+var readFileFrom = (path, encoding = "utf-8") => {
+  if (existsSync(path)) {
+    return readFileSync(path, encoding);
+  }
+  throw new Error(`Failed to read file from expected directory: ${path}`);
+};
+var cleanUpName = (name) => {
+  const [last, first] = name.trim().split(",");
+  let finalName = `${first.trim()} ${last.trim()}`.replace(/'/g, "");
+  if (finalName.startsWith(".")) {
+    finalName = finalName.slice(1).trim();
+  }
+  return finalName.trim();
+};
+
+// src/Students.ts
+var Students = class {
+  students;
+  timeTableKeys = {};
+  constructor(inputOptions) {
+    const { timeTable, givenInput, pathToFile, winstonLogger: logger } = inputOptions;
+    this.timeTableKeys = timeTable?.reduce((acc, curr) => {
+      acc[curr.expandedClassCode] = curr.classCode;
+      return acc;
+    }, {}) ?? {};
+    const input = givenInput ?? readFileFrom(pathToFile, "utf-8");
+    const lines = input.split("\n").slice(1).filter((x) => x.length !== 0);
+    const students = lines.map((line) => {
+      const [zID, name, classCode] = line.split("|");
+      const alternativeClass = timeTable?.find((x) => x.otherExpandedClassCode === classCode);
+      return {
+        zID: `z${zID.trim()}`,
+        name: cleanUpName(name),
+        class: alternativeClass?.otherExpandedClassCode?.trim() ?? classCode?.trim() ?? "N/A",
+        classCode: alternativeClass?.classCode?.trim() ?? (classCode !== void 0 ? this.timeTableKeys[classCode.trim()] ?? "N/A" : "N/A")
+      };
+    });
+    logger?.verbose(`Read ${students.length} students`);
+    this.students = students.sort((a, b) => a.zID.localeCompare(b.zID));
+  }
+  /**
+   * Get the students as an array
+   */
+  getStudents = () => [...this.students];
+  getTimeTableKeys = () => ({ ...this.timeTableKeys });
+};
+
+export { Students, cleanUpName };
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/utils.ts","../src/Students.ts"],"names":[],"mappings":";;;;AAQO,IAAM,YAAA,GAAe,CAAC,IAAA,EAAc,QAAA,GAA2B,OAAA,KAAoB;AACxF,EAAA,IAAI,UAAA,CAAW,IAAI,CAAA,EAAG;AACpB,IAAA,OAAO,YAAA,CAAa,MAAM,QAAQ,CAAA;AAAA,EACpC;AACA,EAAA,MAAM,IAAI,KAAA,CAAM,CAAA,6CAAA,EAAgD,IAAI,CAAA,CAAE,CAAA;AACxE,CAAA;AAMO,IAAM,WAAA,GAAc,CAAC,IAAA,KAAyB;AACnD,EAAA,MAAM,CAAC,MAAM,KAAK,CAAA,GAAI,KAAK,IAAA,EAAK,CAAE,MAAM,GAAG,CAAA;AAC3C,EAAA,IAAI,SAAA,GAAY,CAAA,EAAG,KAAA,CAAM,IAAA,EAAM,CAAA,CAAA,EAAI,IAAA,CAAK,IAAA,EAAM,CAAA,CAAA,CAAG,OAAA,CAAQ,IAAA,EAAM,EAAE,CAAA;AACjE,EAAA,IAAI,SAAA,CAAU,UAAA,CAAW,GAAG,CAAA,EAAG;AAC7B,IAAA,SAAA,GAAY,SAAA,CAAU,KAAA,CAAM,CAAC,CAAA,CAAE,IAAA,EAAK;AAAA,EACtC;AACA,EAAA,OAAO,UAAU,IAAA,EAAK;AACxB;;;ACjBO,IAAM,WAAN,MAAe;AAAA,EACH,QAAA;AAAA,EACA,gBAAuD,EAAC;AAAA,EAElE,YAAY,YAAA,EAA4B;AAC7C,IAAA,MAAM,EAAE,SAAA,EAAW,UAAA,EAAY,UAAA,EAAY,aAAA,EAAe,QAAO,GAAI,YAAA;AAErE,IAAA,IAAA,CAAK,aAAA,GACH,SAAA,EAAW,MAAA,CAAO,CAAC,KAAgC,IAAA,KAAS;AAC1D,MAAA,GAAA,CAAI,IAAA,CAAK,iBAAiB,CAAA,GAAI,IAAA,CAAK,SAAA;AACnC,MAAA,OAAO,GAAA;AAAA,IACT,CAAA,EAAG,EAAE,CAAA,IAAK,EAAC;AAEb,IAAA,MAAM,KAAA,GAAQ,UAAA,IAAc,YAAA,CAAa,UAAA,EAAY,OAAO,CAAA;AAC5D,IAAA,MAAM,KAAA,GAAQ,KAAA,CACX,KAAA,CAAM,IAAI,CAAA,CACV,KAAA,CAAM,CAAC,CAAA,CACP,MAAA,CAAO,CAAC,CAAA,KAAM,CAAA,CAAE,WAAW,CAAC,CAAA;AAC/B,IAAA,MAAM,QAAA,GAA+B,KAAA,CAAM,GAAA,CAAI,CAAC,IAAA,KAAS;AACvD,MAAA,MAAM,CAAC,GAAA,EAAK,IAAA,EAAM,SAAS,CAAA,GAAI,IAAA,CAAK,MAAM,GAAG,CAAA;AAK7C,MAAA,MAAM,mBAAmB,SAAA,EAAW,IAAA,CAAK,CAAC,CAAA,KAAM,CAAA,CAAE,2BAA2B,SAAS,CAAA;AAEtF,MAAA,OAAO;AAAA,QACL,GAAA,EAAK,CAAA,CAAA,EAAI,GAAA,CAAI,IAAA,EAAM,CAAA,CAAA;AAAA,QACnB,IAAA,EAAM,YAAY,IAAI,CAAA;AAAA,QACtB,OAAO,gBAAA,EAAkB,sBAAA,EAAwB,MAAK,IAAK,SAAA,EAAW,MAAK,IAAK,KAAA;AAAA,QAChF,SAAA,EACE,gBAAA,EAAkB,SAAA,EAAW,IAAA,EAAK,KACjC,SAAA,KAAc,MAAA,GAAa,IAAA,CAAK,aAAA,CAAc,SAAA,CAAU,IAAA,EAAM,KAAK,KAAA,GAAS,KAAA;AAAA,OACjF;AAAA,IACF,CAAC,CAAA;AACD,IAAA,MAAA,EAAQ,OAAA,CAAQ,CAAA,KAAA,EAAQ,QAAA,CAAS,MAAM,CAAA,SAAA,CAAW,CAAA;AAClD,IAAA,IAAA,CAAK,QAAA,GAAW,QAAA,CAAS,IAAA,CAAK,CAAC,CAAA,EAAG,CAAA,KAAM,CAAA,CAAE,GAAA,CAAI,aAAA,CAAc,CAAA,CAAE,GAAG,CAAC,CAAA;AAAA,EACpE;AAAA;AAAA;AAAA;AAAA,EAKO,WAAA,GAAc,MAAM,CAAC,GAAG,KAAK,QAAQ,CAAA;AAAA,EACrC,gBAAA,GAAmB,OAAO,EAAE,GAAG,KAAK,aAAA,EAAc,CAAA;AAC3D","file":"index.js","sourcesContent":["import { existsSync, readFileSync } from 'fs';\n\n/**\n * Reads input from a file and returns a string\n * @throws { Error } if the file does not exist\n * @param path path of file\n * @param encoding encoding, defaulted to \"utf-8\"\n */\nexport const readFileFrom = (path: string, encoding: BufferEncoding = 'utf-8'): string => {\n  if (existsSync(path)) {\n    return readFileSync(path, encoding);\n  }\n  throw new Error(`Failed to read file from expected directory: ${path}`);\n};\n\n/**\n * Cleans up the name by removing leading/trailing spaces and removing any leading periods\n * @param name in the format \"Last, First\"\n */\nexport const cleanUpName = (name: string): string => {\n  const [last, first] = name.trim().split(',') as [string, string];\n  let finalName = `${first.trim()} ${last.trim()}`.replace(/'/g, '');\n  if (finalName.startsWith('.')) {\n    finalName = finalName.slice(1).trim();\n  }\n  return finalName.trim();\n};\n","import { type Logger } from 'winston';\nimport type { StudentEnrolment, TimetableInformation } from './types';\nimport { cleanUpName, readFileFrom } from './utils';\n\ntype InputOptions = {\n  timeTable?: TimetableInformation;\n  winstonLogger?: Logger;\n} & ({ givenInput: string; pathToFile?: never } | { pathToFile: string; givenInput?: never });\n\nexport class Students {\n  private readonly students: StudentEnrolment[];\n  private readonly timeTableKeys: { [key: string]: string | undefined } = {};\n\n  public constructor(inputOptions: InputOptions) {\n    const { timeTable, givenInput, pathToFile, winstonLogger: logger } = inputOptions;\n\n    this.timeTableKeys =\n      timeTable?.reduce((acc: typeof this.timeTableKeys, curr) => {\n        acc[curr.expandedClassCode] = curr.classCode;\n        return acc;\n      }, {}) ?? {};\n\n    const input = givenInput ?? readFileFrom(pathToFile, 'utf-8');\n    const lines = input\n      .split('\\n')\n      .slice(1)\n      .filter((x) => x.length !== 0);\n    const students: StudentEnrolment[] = lines.map((line) => {\n      const [zID, name, classCode] = line.split('|') as [string, string, string | undefined];\n\n      /**\n       * This is in case teaching decides to combine classes but not update the fucking enrolments\n       */\n      const alternativeClass = timeTable?.find((x) => x.otherExpandedClassCode === classCode);\n\n      return {\n        zID: `z${zID.trim()}`,\n        name: cleanUpName(name),\n        class: alternativeClass?.otherExpandedClassCode?.trim() ?? classCode?.trim() ?? 'N/A',\n        classCode:\n          alternativeClass?.classCode?.trim() ??\n          (classCode !== undefined ? (this.timeTableKeys[classCode.trim()] ?? 'N/A') : 'N/A'),\n      };\n    });\n    logger?.verbose(`Read ${students.length} students`);\n    this.students = students.sort((a, b) => a.zID.localeCompare(b.zID));\n  }\n\n  /**\n   * Get the students as an array\n   */\n  public getStudents = () => [...this.students];\n  public getTimeTableKeys = () => ({ ...this.timeTableKeys });\n}\n"]}

package/package.json

@@ -0,0 +1,81 @@
+{
+  "name": "@kuroson/cse-students",
+  "version": "0.3.1",
+  "description": "Student enrolment parser for UNSW CSE courses",
+  "license": "MIT",
+  "author": "Alvin Cherk <a.cherk@unsw.edu.au>",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "package.json",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md"
+  ],
+  "devDependencies": {
+    "@eslint/js": "9.39.2",
+    "@types/jest": "30.0.0",
+    "@types/node": "24.10.4",
+    "@typescript-eslint/eslint-plugin": "8.50.1",
+    "depcheck": "1.4.7",
+    "eslint": "9.39.2",
+    "eslint-config-prettier": "10.1.8",
+    "eslint-plugin-jest": "29.10.1",
+    "eslint-plugin-prettier": "5.5.4",
+    "eslint-plugin-unused-imports": "4.3.0",
+    "jest": "30.2.0",
+    "prettier": "3.7.4",
+    "ts-jest": "29.4.6",
+    "tsup": "8.5.1",
+    "typescript": "5.9.3",
+    "typescript-eslint": "8.50.1",
+    "winston": "3.19.0"
+  },
+  "peerDependencies": {
+    "typescript": ">=5.0.0",
+    "winston": ">=3.0.0"
+  },
+  "peerDependenciesMeta": {
+    "typescript": {
+      "optional": true
+    },
+    "winston": {
+      "optional": true
+    }
+  },
+  "engines": {
+    "node": ">=22"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "depcheck": {
+    "ignores": [],
+    "skip-missing": true
+  },
+  "scripts": {
+    "build:all": "tsup",
+    "depcheck": "depcheck",
+    "lint": "eslint './**/*.{ts,js}'",
+    "lint:fix": "eslint './**/*.{ts,js}' --fix",
+    "test": "jest",
+    "test:cov": "jest --coverage",
+    "typecheck": "tsc --noEmit"
+  }
+}