@intellegens/cornerstone-client 0.0.1

package/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2025 Intellegens
+
+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,73 @@
+# Cornerstone TypeScript WebClient Services
+
+This project includes services for easy communication from a Cornerstone client application to the Cornerstone API.
+
+## Getting started
+
+1. Install dependencies:
+
+```bash
+npm install
+```
+
+2. Build the project:
+
+```bash
+npm run build
+```
+
+3. Run Client demo HTTP server:
+
+```bash
+npm run demo
+```
+
+4. Open
+
+http://localhost:3000
+
+## API reference
+
+### Config Service
+
+This service provides way to load configuration for a Cornerstone client application.
+
+```ts
+import { Config } from './index.js';
+await configAPI.initialize();
+```
+
+#### API base URL
+
+Detected by checking the `CORNERSTONE-API-BASEURL` response header and the `websettings.json` file.
+
+- First, it checks the response headers of the current URL for the 'CORNERSTONE-API-BASEURL ' header.
+- If the header is not found, it attempts to load the `websettings.json` file and looks for an `api` field.
+- If no API base URL is found, it defaults to `undefined`.
+
+### Auth Service
+
+This service provides authentication methods for managing user sessions in a Cornerstone client application.
+
+#### Usage
+
+To use the Auth service, first create an instance by passing the API URL. Then, you can use the login, logout, and whoAmI methods to authenticate and manage the user session.
+
+```ts
+import { Auth } from './index.js';
+const authAPI = new Auth('https://your-api-url.com');
+```
+
+#### Methods
+
+- login(username: string, password: string): Promise<User | undefined>
+
+This method logs the user in by sending the provided username and password to the API. If the login is successful, it returns the authenticated User object.
+
+- logout(): Promise<User | undefined>
+
+This method logs the user out by sending a request to the API to end the session. It returns undefined if the logout is successful
+
+- whoAmI(): Promise<User | undefined>
+
+This method checks the current session and returns the User object for the logged-in user. If no user is logged in, it returns undefined.

package/index.js

@@ -0,0 +1 @@
+export * from './services';

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@intellegens/cornerstone-client",
+  "version": "0.0.1",
+  "main": "index.js",
+  "type": "module",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "tsc",
+    "demo": "tsc && npx vite build && npx tsx ./demo"
+  },
+  "author": "",
+  "license": "MIT",
+  "description": "",
+  "devDependencies": {
+    "@eslint/js": "^9.21.0",
+    "@types/express": "^5.0.0",
+    "@types/node": "^22.13.9",
+    "eslint": "^9.21.0",
+    "eslint-config-prettier": "^10.0.1",
+    "express": "^4.21.2",
+    "globals": "^16.0.0",
+    "prettier": "^3.5.2",
+    "typescript-eslint": "^8.26.0",
+    "vite": "^6.2.0"
+  },
+  "dependencies": {
+    "http-proxy-middleware": "^3.0.3"
+  }
+}

package/services/auth/index.js

@@ -0,0 +1,92 @@
+/**
+ * Auth class is responsible for managing user authentication operations.
+ * It supports login, logout, and checking the current user's details.
+ *
+ * @export
+ * @class Auth
+ */
+export class Auth {
+    _apiUrl;
+    user = undefined;
+    /**
+     * Creates an instance of Auth.
+     *
+     * @param {string} apiUrl
+     * @memberof Auth
+     */
+    constructor(apiUrl) {
+        this._apiUrl = apiUrl;
+    }
+    /**
+     * Retrieves the current user's details if they are logged in.
+     *
+     * @return {Promise<TUser>} Currently logged in user
+     * @throws {Error} Error if fetch fails
+     * @memberof Auth
+     */
+    async whoAmI() {
+        try {
+            const response = await fetch(`${this._apiUrl}/auth/who-am-i`, { credentials: 'include' });
+            if (response.ok) {
+                const info = await response.json();
+                return (this.user = info.user);
+            }
+            else {
+                throw new Error('Failed checking authentication status');
+            }
+        }
+        catch (error) {
+            throw error instanceof Error ? error : new Error('Failed checking authentication status');
+        }
+    }
+    /**
+     * Logs in a user using their username and password, and retrieves the user data.
+     *
+     * @param {string} username Login credentials: username
+     * @param {string} password Login credentials: password
+     * @return {Promise<TUser>} Currently logged in user
+     * @throws {Error} Error if fetch fails
+     * @memberof Auth
+     */
+    async login(username, password) {
+        try {
+            const response = await fetch(`${this._apiUrl}/auth/signin`, {
+                method: 'POST',
+                headers: { 'Content-Type': 'application/json' },
+                body: JSON.stringify({ username, password }),
+                credentials: 'include',
+            });
+            if (response.ok) {
+                return (this.user = await this.whoAmI());
+            }
+            else {
+                throw new Error('Failed user login');
+            }
+        }
+        catch (error) {
+            throw error instanceof Error ? error : new Error('Failed user login');
+        }
+    }
+    /**
+     * Logs out the current user and clears their authentication state.
+     *
+     * @return {Promise<void>}
+     * @throws {Error} Error if fetch fails
+     * @memberof Auth
+     */
+    async logout() {
+        try {
+            const response = await fetch(`${this._apiUrl}/auth/logout`, { credentials: 'include' });
+            if (response.ok) {
+                this.user = undefined;
+                return;
+            }
+            else {
+                throw new Error('Failed user logout');
+            }
+        }
+        catch (error) {
+            throw error instanceof Error ? error : new Error('Failed user logout');
+        }
+    }
+}

package/services/auth/types/index.js

@@ -0,0 +1,2 @@
+export * from './user';
+export * from './user-info';

package/services/auth/types/user-info.js

@@ -0,0 +1 @@
+export {};

package/services/auth/types/user.js

@@ -0,0 +1 @@
+export {};

package/services/config/index.js

@@ -0,0 +1,69 @@
+/**
+ * Configuration class for managing the API
+ *
+ * @export
+ * @class Config
+ */
+export class Config {
+    /**
+     * The base URL of the API. It is undefined by default and gets populated through the initialization process.
+     *
+     * @type {(string | undefined)}
+     * @memberof Config
+     */
+    apiBaseUrl = undefined;
+    /**
+     * Initializes the configuration by detecting the API base URL.
+     *
+     * This method calls all methods that need to be called during the config phase.
+     *
+     * @async
+     * @return {Promise<void>} Resolves when the API base URL is detected.
+     * @memberof Config
+     */
+    async initialize() {
+        await this.detectApiBaseUrl();
+    }
+    /**
+     * Detects the API base URL by checking the `CORNERSTONE-API-BASEURL` header and the `websettings.json` file.
+     *
+     * First, it checks the response headers of the current URL for the 'CORNERSTONE-API-BASEURL' header.
+     * If the header is not found, it attempts to load the `websettings.json` file and looks for an `api` field.
+     * If no API base URL is found, it defaults to `undefined`.
+     *
+     * @return {Promise<string | undefined>} Returns the API base URL
+     * @throws {Error} Throws error if fetch fails
+     * @memberof Config
+     */
+    async detectApiBaseUrl() {
+        // Initialize a globally tracked error
+        let error = undefined;
+        // Check CORNERSTONE-API-BASEURL header for API base URL
+        try {
+            const currentUrlResponse = await fetch(window.location.href, { method: 'GET' });
+            const apiHeader = currentUrlResponse.headers.get('CORNERSTONE-API-BASEURL');
+            if (apiHeader)
+                return (this.apiBaseUrl = apiHeader);
+        }
+        catch (err) {
+            error = err instanceof Error ? err : new Error('Failed loading configuration from response header!');
+        }
+        // Check ./websettings.json header for API base URL
+        try {
+            const webSettingsResponse = await fetch('./websettings.json', { method: 'GET' });
+            if (webSettingsResponse.status === 404)
+                return (this.apiBaseUrl = undefined);
+            const webSettings = await webSettingsResponse.json();
+            if (webSettings?.api)
+                return (this.apiBaseUrl = webSettings.api);
+        }
+        catch (err) {
+            error = err instanceof Error ? err : new Error('Failed loading configuration from settings file!');
+        }
+        // Check if error caught
+        if (error !== undefined)
+            throw error;
+        // Default to no API found
+        return (this.apiBaseUrl = undefined);
+    }
+}

package/services/index.js

@@ -0,0 +1,2 @@
+export * from './config';
+export * from './auth';