finki-auth 1.1.0

package/LICENSE

@@ -0,0 +1,22 @@
+
+MIT License
+
+Copyright (c) 2025 Delemangi
+
+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,11 @@
+# FINKI Auth
+
+This is an NPM package for managing authentication and sessions for FCSE CAS and the other services. Currently supported:
+
+- CAS
+- Courses
+- Diplomas
+
+## License
+
+This project is licensed under the MIT license.

package/dist/constants.d.ts

@@ -0,0 +1,5 @@
+export declare const SERVICE_URLS: {
+    readonly cas: "https://cas.finki.ukim.mk/cas/login";
+    readonly courses: "https://courses.finki.ukim.mk/login/index.php";
+    readonly diplomas: "http://diplomski.finki.ukim.mk/Account/LoginCAS";
+};

package/dist/constants.js

@@ -0,0 +1,6 @@
+import { Service } from './lib/Service.js';
+export const SERVICE_URLS = {
+    [Service.CAS]: 'https://cas.finki.ukim.mk/cas/login',
+    [Service.COURSES]: 'https://courses.finki.ukim.mk/login/index.php',
+    [Service.DIPLOMAS]: 'http://diplomski.finki.ukim.mk/Account/LoginCAS',
+};

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+import { Service } from './lib/Service.js';
+export declare class CasAuthentication {
+    private readonly password;
+    private readonly session;
+    private readonly username;
+    constructor(username: string, password: string);
+    authenticate: (service: Service) => Promise<import("tough-cookie").Cookie[]>;
+    private readonly getCookies;
+    private readonly getFormData;
+}

package/dist/index.js

@@ -0,0 +1,58 @@
+import axios from 'axios';
+import { wrapper } from 'axios-cookiejar-support';
+import { JSDOM } from 'jsdom';
+import { CookieJar } from 'tough-cookie';
+import { z } from 'zod';
+import { SERVICE_URLS } from './constants.js';
+import { Service } from './lib/Service.js';
+export class CasAuthentication {
+    password;
+    session;
+    username;
+    constructor(username, password) {
+        this.username = username;
+        this.password = password;
+        const cookieJar = new CookieJar();
+        const client = axios.create({
+            jar: cookieJar,
+            validateStatus: (status) => status >= 200 && status < 400,
+        });
+        // @ts-expect-error axios-cookiejar-support has old typings. This used to be an issue in all axios related packages
+        this.session = wrapper(client);
+    }
+    authenticate = async (service) => {
+        const fullUrl = `${SERVICE_URLS[Service.CAS]}?service=${encodeURIComponent(SERVICE_URLS[service])}`;
+        const initialRequest = await this.session.get(fullUrl);
+        const { data } = z.string().safeParse(initialRequest.data);
+        if (!data) {
+            throw new Error('Failed to parse initial request data');
+        }
+        const { window } = new JSDOM(data);
+        const hiddenInputs = window.document.querySelectorAll('input[type="hidden"]');
+        const urlSearchParams = this.getFormData(hiddenInputs);
+        await this.session.post(fullUrl, urlSearchParams);
+        return this.getCookies(service);
+    };
+    getCookies = async (service) => {
+        const casCookies = (await this.session.defaults.jar?.getCookies(SERVICE_URLS[Service.CAS])) ?? [];
+        const serviceCookies = service
+            ? ((await this.session.defaults.jar?.getCookies(SERVICE_URLS[service])) ??
+                [])
+            : [];
+        return [...casCookies, ...serviceCookies];
+    };
+    getFormData = (inputs) => {
+        const urlSearchParams = new URLSearchParams();
+        for (const input of inputs) {
+            const name = input.getAttribute('name');
+            const value = input.getAttribute('value');
+            if (name) {
+                urlSearchParams.append(name, value ?? '');
+            }
+        }
+        urlSearchParams.append('username', this.username);
+        urlSearchParams.append('password', this.password);
+        urlSearchParams.append('submit', 'LOGIN');
+        return urlSearchParams;
+    };
+}

package/dist/lib/Service.d.ts

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+export declare enum Service {
+    CAS = "cas",
+    COURSES = "courses",
+    DIPLOMAS = "diplomas"
+}
+export declare const ServiceSchema: z.ZodNativeEnum<typeof Service>;

package/dist/lib/Service.js

@@ -0,0 +1,8 @@
+import { z } from 'zod';
+export var Service;
+(function (Service) {
+    Service["CAS"] = "cas";
+    Service["COURSES"] = "courses";
+    Service["DIPLOMAS"] = "diplomas";
+})(Service || (Service = {}));
+export const ServiceSchema = z.nativeEnum(Service);

package/dist/lib/axios.d.ts

@@ -0,0 +1,7 @@
+import type { CookieJar } from 'tough-cookie';
+import 'axios';
+declare module 'axios' {
+    interface AxiosRequestConfig {
+        jar?: CookieJar;
+    }
+}

package/dist/lib/axios.js

@@ -0,0 +1 @@
+import 'axios';

package/dist/tests/utils.d.ts

@@ -0,0 +1,5 @@
+import 'dotenv/config';
+export declare const getCredentials: () => {
+    password: string;
+    username: string;
+};

package/dist/tests/utils.js

@@ -0,0 +1,13 @@
+/* eslint-disable n/no-process-env */
+import 'dotenv/config';
+import assert from 'node:assert';
+export const getCredentials = () => {
+    const username = process.env['CAS_USERNAME'];
+    const password = process.env['CAS_PASSWORD'];
+    assert(username);
+    assert(password);
+    return {
+        password,
+        username,
+    };
+};

package/package.json

@@ -0,0 +1,77 @@
+{
+  "author": {
+    "email": "milev.stefan@gmail.com",
+    "name": "Delemangi",
+    "url": "https://delemangi.com"
+  },
+  "bugs": {
+    "url": "https://github.com/Delemangi/finki-auth/issues"
+  },
+  "config": {
+    "commitizen": {
+      "path": "cz-conventional-changelog"
+    }
+  },
+  "dependencies": {
+    "axios": "^1.8.4",
+    "axios-cookiejar-support": "^5.0.5",
+    "jsdom": "^26.0.0",
+    "tough-cookie": "^5.1.2",
+    "zod": "^3.24.2"
+  },
+  "description": "Authentication for FCSE services",
+  "devDependencies": {
+    "@commitlint/cli": "^19.8.0",
+    "@commitlint/config-conventional": "^19.8.0",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
+    "@types/jsdom": "^21.1.7",
+    "@types/superagent": "^8.1.9",
+    "commitizen": "^4.3.1",
+    "cz-conventional-changelog": "^3.3.0",
+    "dotenv": "^16.5.0",
+    "eslint": "^9.24.0",
+    "eslint-config-imperium": "^2.2.0",
+    "husky": "^9.1.7",
+    "rimraf": "^6.0.1",
+    "semantic-release": "^24.2.3",
+    "typescript": "~5.8.3",
+    "vitest": "^3.1.1"
+  },
+  "engines": {
+    "node": "^20 || ^22"
+  },
+  "files": [
+    "dist",
+    "!**/*.test.*",
+    "!test"
+  ],
+  "homepage": "https://github.com/Delemangi/finki-auth",
+  "keywords": [
+    "finki",
+    "auth",
+    "authentication"
+  ],
+  "license": "MIT",
+  "main": "dist/index.js",
+  "name": "finki-auth",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Delemangi/finki-auth.git"
+  },
+  "scripts": {
+    "build": "rimraf dist && tsc",
+    "commit": "cz",
+    "commitlint": "commitlint --edit",
+    "format": "eslint --ignore-pattern \"**/test/*\" --fix .",
+    "lint": "eslint . --ignore-pattern \"**/test/*\" --no-warn-ignored --cache",
+    "prepare": "husky",
+    "package": "npm run build && npm pack",
+    "release": "semantic-release",
+    "release:dry": "npm run release -- --dry-run",
+    "test": "vitest run --exclude dist"
+  },
+  "type": "module",
+  "types": "dist/index.d.ts",
+  "version": "1.1.0"
+}