finki-auth 1.6.0 → 1.8.0

package/README.md

@@ -1,6 +1,6 @@
 # FINKI Auth
 
-NPM (Node) package for managing authentication and sessions for FCSE CAS and the other services. Uses an HTTP client under the hood, and not a full browser (such as Puppeteer).
+Node.js package for managing authentication and cookies for FCSE's services, built using [axios](https://github.com/axios/axios).
 
 ## Features
 
@@ -21,16 +21,43 @@ You can add the package to your NPM project by running `npm i finki-auth`.
 ## Example
 
 ```ts
-import { CasAuthentication, Service } from "finki-auth";
+import {
+  CasAuthentication,
+  Service,
+  isCookieValid,
+  isCookieHeaderValid,
+} from "finki-auth";
 
-const auth = new CasAuthentication(credentials.username, credentials.password);
-const rawCookies = await auth.authenticate(Service.COURSES);
+const credentials = {
+  username: "example",
+  password: "secret_password",
+};
 
-const cookies: Record<string, string> = {};
+const auth = new CasAuthentication(credentials);
 
-for (const { key, value } of rawCookies) {
-  cookies[key] = value;
-}
+await auth.authenticate(Service.COURSES);
+
+// Get array of cookie objects
+const cookies = await auth.getCookie(Service.COURSES);
+
+// Get cookie header directly for sending requests
+const cookieHeader = await auth.buildCookieHeader(Service.COURSES);
+
+// Check if the cookie is still valid, and if not, call `authenticate` again
+const isCookieValid = await auth.isCookieValid(Service.COURSES);
+
+if (!isCookieValid) await auth.authenticate();
+
+// There are also some utility functions available:
+const isCookieValidStandalone = await isCookieValid({
+  service: Service.COURSES,
+  cookies,
+});
+
+const isCookieHeaderValidStandalone = await isCookieHeaderValid({
+  service: Service.COURSES,
+  cookieHeader,
+});
 ```
 
 ## License

package/dist/authentication.d.ts

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

package/dist/{auth.js → authentication.js}

@@ -3,13 +3,14 @@ import { wrapper } from 'axios-cookiejar-support';
 import { JSDOM } from 'jsdom';
 import { CookieJar } from 'tough-cookie';
 import { z } from 'zod';
-import { SERVICE_LOGIN_URLS } from './constants.js';
+import { SERVICE_LOGIN_URLS, SERVICE_URLS } from './constants.js';
 import { Service } from './lib/Service.js';
+import { getCookieValidity } from './utils.js';
 export class CasAuthentication {
     password;
     session;
     username;
-    constructor(username, password) {
+    constructor({ password, username }) {
         this.username = username;
         this.password = password;
         const cookieJar = new CookieJar();
@@ -19,8 +20,14 @@ export class CasAuthentication {
         });
         this.session = wrapper(client);
     }
+    static getFullLoginUrl = (service) => {
+        if (service === Service.CAS) {
+            return SERVICE_LOGIN_URLS[Service.CAS];
+        }
+        return `${SERVICE_LOGIN_URLS[Service.CAS]}?service=${encodeURIComponent(SERVICE_LOGIN_URLS[service])}`;
+    };
     authenticate = async (service) => {
-        const fullUrl = `${SERVICE_LOGIN_URLS[Service.CAS]}?service=${encodeURIComponent(SERVICE_LOGIN_URLS[service])}`;
+        const fullUrl = CasAuthentication.getFullLoginUrl(service);
         const initialRequest = await this.session.get(fullUrl);
         const { data } = z.string().safeParse(initialRequest.data);
         if (!data) {
@@ -30,14 +37,24 @@ export class CasAuthentication {
         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_LOGIN_URLS[Service.CAS])) ?? [];
-        const serviceCookies = service
-            ? ((await this.session.defaults.jar?.getCookies(SERVICE_LOGIN_URLS[service])) ?? [])
-            : [];
-        return [...casCookies, ...serviceCookies];
+    buildCookieHeader = async (service) => {
+        const cookies = await this.getCookie(service);
+        return cookies.map(({ key, value }) => `${key}=${value}`).join('; ');
+    };
+    getCookie = async (service) => {
+        const serviceLoginUrl = SERVICE_LOGIN_URLS[service];
+        const serviceCookies = await this.session.defaults.jar?.getCookies(serviceLoginUrl);
+        return serviceCookies ?? [];
+    };
+    isCookieValid = async (service) => {
+        const url = SERVICE_URLS[service];
+        const cookies = await this.getCookie(service);
+        const jar = new CookieJar();
+        for (const cookie of cookies) {
+            await jar.setCookie(cookie, url);
+        }
+        return await getCookieValidity({ cookieJar: jar, service });
     };
     getFormData = (inputs) => {
         const urlSearchParams = new URLSearchParams();

package/dist/constants.d.ts

@@ -1,5 +1,5 @@
 export declare const SERVICE_URLS: {
-    readonly cas: "https://cas.finki.ukim.mk";
+    readonly cas: "https://cas.finki.ukim.mk/cas";
     readonly consultations: "https://consultations.finki.ukim.mk";
     readonly courses: "https://courses.finki.ukim.mk";
     readonly diplomas: "http://diplomski.finki.ukim.mk";
@@ -16,8 +16,8 @@ export declare const SERVICE_LOGIN_URLS: {
     readonly masters: "https://magisterski.finki.ukim.mk/login";
     readonly old_courses: "https://oldcourses.finki.ukim.mk/login/index.php";
 };
-export declare const SERVICE_USER_ELEMENT_SELECTORS: {
-    readonly cas: "";
+export declare const SERVICE_SUCCESS_SELECTORS: {
+    readonly cas: "div.success";
     readonly consultations: "a#username";
     readonly courses: "span.usertext.me-1";
     readonly diplomas: "#logoutForm > ul > li:nth-child(1) > a";

package/dist/constants.js

@@ -1,6 +1,6 @@
 import { Service } from './lib/Service.js';
 export const SERVICE_URLS = {
-    [Service.CAS]: 'https://cas.finki.ukim.mk',
+    [Service.CAS]: 'https://cas.finki.ukim.mk/cas',
     [Service.CONSULTATIONS]: 'https://consultations.finki.ukim.mk',
     [Service.COURSES]: 'https://courses.finki.ukim.mk',
     [Service.DIPLOMAS]: 'http://diplomski.finki.ukim.mk',
@@ -17,8 +17,8 @@ export const SERVICE_LOGIN_URLS = {
     [Service.MASTERS]: 'https://magisterski.finki.ukim.mk/login',
     [Service.OLD_COURSES]: 'https://oldcourses.finki.ukim.mk/login/index.php',
 };
-export const SERVICE_USER_ELEMENT_SELECTORS = {
-    [Service.CAS]: '',
+export const SERVICE_SUCCESS_SELECTORS = {
+    [Service.CAS]: 'div.success',
     [Service.CONSULTATIONS]: 'a#username',
     [Service.COURSES]: 'span.usertext.me-1',
     [Service.DIPLOMAS]: '#logoutForm > ul > li:nth-child(1) > a',

package/dist/index.d.ts

@@ -1,3 +1,3 @@
-export { CasAuthentication } from './auth.js';
+export { CasAuthentication } from './authentication.js';
 export { Service } from './lib/Service.js';
-export { isCookieValid } from './session.js';
+export { isCookieHeaderValid, isCookieValid } from './utils.js';

package/dist/index.js

@@ -1,3 +1,3 @@
-export { CasAuthentication } from './auth.js';
+export { CasAuthentication } from './authentication.js';
 export { Service } from './lib/Service.js';
-export { isCookieValid } from './session.js';
+export { isCookieHeaderValid, isCookieValid } from './utils.js';

package/dist/utils.d.ts

@@ -0,0 +1,14 @@
+import { type Cookie, CookieJar } from 'tough-cookie';
+import type { Service } from './lib/Service.js';
+export declare const getCookieValidity: ({ cookieJar, service, }: {
+    cookieJar: CookieJar;
+    service: Service;
+}) => Promise<boolean>;
+export declare const isCookieValid: ({ cookies, service, }: {
+    cookies: Cookie[];
+    service: Service;
+}) => Promise<boolean>;
+export declare const isCookieHeaderValid: ({ cookieHeader, service, }: {
+    cookieHeader: string;
+    service: Service;
+}) => Promise<boolean>;

package/dist/utils.js

@@ -0,0 +1,45 @@
+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_SUCCESS_SELECTORS, SERVICE_URLS } from './constants.js';
+export const getCookieValidity = async ({ cookieJar, service, }) => {
+    const url = SERVICE_URLS[service];
+    const userElementSelector = SERVICE_SUCCESS_SELECTORS[service];
+    const client = wrapper(axios.create({ jar: cookieJar }));
+    const response = await client.get(url);
+    const html = z.string().parse(response.data);
+    const { window } = new JSDOM(html);
+    const userElement = window.document.querySelector(userElementSelector);
+    switch (userElement?.textContent) {
+        case undefined:
+        case 'Најава':
+            return false;
+        default:
+            return true;
+    }
+};
+export const isCookieValid = async ({ cookies, service, }) => {
+    const url = SERVICE_URLS[service];
+    const jar = new CookieJar();
+    for (const cookie of cookies) {
+        await jar.setCookie(cookie, url);
+    }
+    return getCookieValidity({ cookieJar: jar, service });
+};
+export const isCookieHeaderValid = async ({ cookieHeader, service, }) => {
+    const url = SERVICE_URLS[service];
+    const jar = new CookieJar();
+    const cookies = cookieHeader
+        ? cookieHeader.split('; ').map((cookie) => {
+            const [key, ...valParts] = cookie.split('=');
+            const value = valParts.join('=');
+            return { key, value };
+        })
+        : [];
+    for (const { key, value } of cookies) {
+        await jar.setCookie(`${key}=${value}`, url);
+    }
+    return getCookieValidity({ cookieJar: jar, service });
+};

package/package.json

@@ -63,7 +63,7 @@
     "commit": "cz",
     "commitlint": "commitlint --edit",
     "format": "eslint --ignore-pattern \"**/test/*\" --fix .",
-    "lint": "eslint . --ignore-pattern \"**/test/*\" --no-warn-ignored --cache",
+    "lint": "tsc --noEmit && eslint . --ignore-pattern \"**/test/*\" --no-warn-ignored --cache",
     "prepare": "husky",
     "package": "npm run build && npm pack",
     "release": "npm run build && semantic-release",
@@ -72,5 +72,5 @@
   },
   "type": "module",
   "types": "dist/index.d.ts",
-  "version": "1.6.0"
+  "version": "1.8.0"
 }

package/dist/auth.d.ts

@@ -1,10 +0,0 @@
-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/lib/axios.d.ts

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

package/dist/lib/axios.js

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

package/dist/session.d.ts

@@ -1,2 +0,0 @@
-import type { Service } from './lib/Service.js';
-export declare const isCookieValid: (service: Service, cookies: string) => Promise<boolean>;

package/dist/session.js

@@ -1,29 +0,0 @@
-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, SERVICE_USER_ELEMENT_SELECTORS } from './constants.js';
-export const isCookieValid = async (service, cookies) => {
-    const url = SERVICE_URLS[service];
-    const userElementSelector = SERVICE_USER_ELEMENT_SELECTORS[service];
-    const jar = new CookieJar();
-    if (cookies) {
-        const cookiePairs = cookies.split('; ');
-        for (const pair of cookiePairs) {
-            await jar.setCookie(pair, url);
-        }
-    }
-    const client = wrapper(axios.create({ jar }));
-    const response = await client.get(url);
-    const html = z.string().parse(response.data);
-    const { window } = new JSDOM(html);
-    const userElement = window.document.querySelector(userElementSelector);
-    switch (userElement?.textContent) {
-        case undefined:
-        case 'Најава':
-            return false;
-        default:
-            return true;
-    }
-};