daystar-verify 1.0.0

package/.github/workflows/publish.yml

@@ -0,0 +1,27 @@
+name: Publish to npm
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: "https://registry.npmjs.org"
+
+      - uses: pnpm/action-setup@v3
+        with:
+          version: 10
+
+      - run: pnpm install
+      - run: pnpm run build
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/README.md

@@ -0,0 +1,75 @@
+# daystar-verify
+
+Verify that a student exists at Daystar University by authenticating against the student portal.
+
+## Installation
+
+```bash
+npm install daystar-verify
+# or
+pnpm add daystar-verify
+```
+
+## Environment Variable
+
+Set the Daystar portal URL in your environment:
+
+```bash
+DAYSTAR_PORTAL_URL=https://your-portal-url.com
+```
+
+## Usage
+
+```ts
+import { fetchSessionToken, login } from "daystar-verify";
+
+async function verifyStudent(admno: string, password: string) {
+  const token = await fetchSessionToken();
+  const session = await login(token, admno, password);
+  return session;
+}
+```
+
+## Error Handling
+
+Both functions throw on failure, so wrap in a try/catch:
+
+```ts
+import { fetchSessionToken, login } from "daystar-verify";
+
+async function verifyStudent(admno: string, password: string) {
+  try {
+    const token = await fetchSessionToken();
+    const session = await login(token, admno, password);
+    return session;
+  } catch (err) {
+    console.error("Verification failed:", err.message);
+  }
+}
+```
+
+Common errors:
+
+- `Failed to communicate with server` — portal is unreachable
+- `Failed to retrieve session token` — unexpected response from portal
+- `Unauthorised Login. Visit Registrar's Office` — invalid credentials
+
+## API
+
+### `fetchSessionToken(): Promise<string>`
+
+Hits the portal root and retrieves an initial session cookie required for login.
+
+### `login(sessionId, admno, password): Promise<string>`
+
+Authenticates the student and returns a session string on success.
+
+| Parameter   | Type     | Description                              |
+|-------------|----------|------------------------------------------|
+| `sessionId` | `string` | Token returned by `fetchSessionToken()`  |
+| `admno`     | `string` | Student admission number                 |
+| `password`  | `string` | Student password                         |
+
+## License
+
+ISC

package/dist/auth.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Fetches a session token from the server.
+ * @returns The session token as a string.
+ * @throws If the request fails or the token cannot be retrieved.
+ */
+export declare function fetchSessionToken(): Promise<string>;
+/**
+ * Logs in a user and returns the session cookie.
+ * @param sessionId
+ * @param admno
+ * @param password
+ * @returns
+ */
+export declare function login(sessionId: string, admno: string, password: string): Promise<string>;
+//# sourceMappingURL=auth.d.ts.map

package/dist/auth.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../src/auth.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,wBAAsB,iBAAiB,IAAI,OAAO,CAAC,MAAM,CAAC,CASzD;AAED;;;;;;GAMG;AACH,wBAAsB,KAAK,CACzB,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,MAAM,CAAC,CAsBjB"}

package/dist/auth.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchSessionToken = fetchSessionToken;
+exports.login = login;
+const config_1 = require("./config");
+/**
+ * Fetches a session token from the server.
+ * @returns The session token as a string.
+ * @throws If the request fails or the token cannot be retrieved.
+ */
+async function fetchSessionToken() {
+    const res = await fetch(`${config_1.config.baseUrl}/`);
+    if (!res.ok)
+        throw new Error("Failed to communicate with server");
+    const cookie = res.headers.get("set-cookie") ?? "";
+    const token = cookie.split(" ")[0];
+    if (!token)
+        throw new Error("Failed to retrieve session token");
+    return token;
+}
+/**
+ * Logs in a user and returns the session cookie.
+ * @param sessionId
+ * @param admno
+ * @param password
+ * @returns
+ */
+async function login(sessionId, admno, password) {
+    if (!sessionId)
+        throw new Error("sessionId is empty");
+    const res = await fetch(`${config_1.config.baseUrl}/Login/LoginUser`, {
+        method: "POST",
+        headers: {
+            "Content-Type": "application/json",
+            Cookie: sessionId,
+        },
+        body: JSON.stringify({ Username: admno, Password: password }),
+    });
+    if (!res.ok)
+        throw new Error(`Request failed with status ${res.status}`);
+    const body = await res.json();
+    if (!body.success)
+        throw new Error(body.message ?? "Login failed");
+    const newCookie = res.headers.get("set-cookie") ?? "";
+    const userSession = `${sessionId} ${newCookie}`.trim();
+    if (!userSession)
+        throw new Error("Failed to retrieve user session");
+    return userSession;
+}
+//# sourceMappingURL=auth.js.map

package/dist/auth.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.js","sourceRoot":"","sources":["../src/auth.ts"],"names":[],"mappings":";;AAOA,8CASC;AASD,sBA0BC;AAnDD,qCAAkC;AAElC;;;;GAIG;AACI,KAAK,UAAU,iBAAiB;IACrC,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,eAAM,CAAC,OAAO,GAAG,CAAC,CAAC;IAC9C,IAAI,CAAC,GAAG,CAAC,EAAE;QAAE,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;IAElE,MAAM,MAAM,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC;IACnD,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACnC,IAAI,CAAC,KAAK;QAAE,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;IAEhE,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,KAAK,CACzB,SAAiB,EACjB,KAAa,EACb,QAAgB;IAEhB,IAAI,CAAC,SAAS;QAAE,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;IAEtD,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,eAAM,CAAC,OAAO,kBAAkB,EAAE;QAC3D,MAAM,EAAE,MAAM;QACd,OAAO,EAAE;YACP,cAAc,EAAE,kBAAkB;YAClC,MAAM,EAAE,SAAS;SAClB;QACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC;KAC9D,CAAC,CAAC;IAEH,IAAI,CAAC,GAAG,CAAC,EAAE;QAAE,MAAM,IAAI,KAAK,CAAC,8BAA8B,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;IAEzE,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;IAC9B,IAAI,CAAC,IAAI,CAAC,OAAO;QAAE,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,OAAO,IAAI,cAAc,CAAC,CAAC;IAEnE,MAAM,SAAS,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC;IACtD,MAAM,WAAW,GAAG,GAAG,SAAS,IAAI,SAAS,EAAE,CAAC,IAAI,EAAE,CAAC;IACvD,IAAI,CAAC,WAAW;QAAE,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;IAErE,OAAO,WAAW,CAAC;AACrB,CAAC"}

package/dist/config.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Configuration for the Daystar Verify package.
+ */
+export declare const config: {
+    baseUrl: string;
+};
+//# sourceMappingURL=config.d.ts.map

package/dist/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,MAAM;;CAElB,CAAC"}

package/dist/config.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.config = void 0;
+/**
+ * Configuration for the Daystar Verify package.
+ */
+exports.config = {
+    baseUrl: process.env.DAYSTAR_PORTAL_URL ?? "",
+};
+//# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACU,QAAA,MAAM,GAAG;IACpB,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,kBAAkB,IAAI,EAAE;CAC9C,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import { fetchSessionToken, login } from "./auth";
+import { config } from "./config";
+export { fetchSessionToken, login, config };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AAClD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,OAAO,EAAE,iBAAiB,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC"}

package/dist/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.config = exports.login = exports.fetchSessionToken = void 0;
+const auth_1 = require("./auth");
+Object.defineProperty(exports, "fetchSessionToken", { enumerable: true, get: function () { return auth_1.fetchSessionToken; } });
+Object.defineProperty(exports, "login", { enumerable: true, get: function () { return auth_1.login; } });
+const config_1 = require("./config");
+Object.defineProperty(exports, "config", { enumerable: true, get: function () { return config_1.config; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,iCAAkD;AAGzC,kGAHA,wBAAiB,OAGA;AAAE,sFAHA,YAAK,OAGA;AAFjC,qCAAkC;AAEC,uFAF1B,eAAM,OAE0B"}

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "daystar-verify",
+  "version": "1.0.0",
+  "description": "",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc"
+  },
+  "keywords": [
+    "daystar",
+    "student",
+    "verify"
+  ],
+  "author": "victor musembi",
+  "license": "ISC",
+  "packageManager": "pnpm@10.18.2",
+  "devDependencies": {
+    "@types/node": "^25.5.2",
+    "dotenv": "^17.4.1",
+    "tsx": "^4.21.0",
+    "typescript": "^6.0.2"
+  }
+}

package/src/auth.ts

@@ -0,0 +1,52 @@
+import { config } from "./config";
+
+/**
+ * Fetches a session token from the server.
+ * @returns The session token as a string.
+ * @throws If the request fails or the token cannot be retrieved.
+ */
+export async function fetchSessionToken(): Promise<string> {
+  const res = await fetch(`${config.baseUrl}/`);
+  if (!res.ok) throw new Error("Failed to communicate with server");
+
+  const cookie = res.headers.get("set-cookie") ?? "";
+  const token = cookie.split(" ")[0];
+  if (!token) throw new Error("Failed to retrieve session token");
+
+  return token;
+}
+
+/**
+ * Logs in a user and returns the session cookie.
+ * @param sessionId
+ * @param admno
+ * @param password
+ * @returns
+ */
+export async function login(
+  sessionId: string,
+  admno: string,
+  password: string,
+): Promise<string> {
+  if (!sessionId) throw new Error("sessionId is empty");
+
+  const res = await fetch(`${config.baseUrl}/Login/LoginUser`, {
+    method: "POST",
+    headers: {
+      "Content-Type": "application/json",
+      Cookie: sessionId,
+    },
+    body: JSON.stringify({ Username: admno, Password: password }),
+  });
+
+  if (!res.ok) throw new Error(`Request failed with status ${res.status}`);
+
+  const body = await res.json();
+  if (!body.success) throw new Error(body.message ?? "Login failed");
+
+  const newCookie = res.headers.get("set-cookie") ?? "";
+  const userSession = `${sessionId} ${newCookie}`.trim();
+  if (!userSession) throw new Error("Failed to retrieve user session");
+
+  return userSession;
+}

package/src/config.ts

@@ -0,0 +1,6 @@
+/**
+ * Configuration for the Daystar Verify package.
+ */
+export const config = {
+  baseUrl: process.env.DAYSTAR_PORTAL_URL ?? "",
+};

package/src/index.ts

@@ -0,0 +1,4 @@
+import { fetchSessionToken, login } from "./auth";
+import { config } from "./config";
+
+export { fetchSessionToken, login, config };

package/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "./dist",
+    "module": "commonjs",
+    "moduleResolution": "node10",
+    "ignoreDeprecations": "6.0",
+    "target": "esnext",
+    "types": [
+      "node"
+    ],
+    "sourceMap": true,
+    "declaration": true,
+    "declarationMap": true,
+    "noUncheckedIndexedAccess": true,
+    "exactOptionalPropertyTypes": true,
+    "strict": true,
+    "isolatedModules": true,
+    "moduleDetection": "force",
+    "skipLibCheck": true
+  },
+  "include": [
+    "src"
+  ]
+}