@intellegens/cornerstone-client 0.0.9999-alpha-7 → 0.0.9999-alpha-8

package/README.md

@@ -7,19 +7,19 @@ This project includes services for easy communication from a Cornerstone client
 1. Install dependencies:
 
 ```bash
-npm install
+pnpm install
 ```
 
 2. Build the project:
 
 ```bash
-npm run build
+pnpm run build
 ```
 
 3. Run Client demo HTTP server:
 
 ```bash
-npm run demo
+pnpm run demo
 ```
 
 4. Open

package/data/auth/index.d.ts

@@ -1 +1,2 @@
 export * from './dto';
+export * from './policy';

package/data/auth/index.js

@@ -1 +1,2 @@
 export * from './dto';
+export * from './policy';

package/data/auth/policy.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Interface for policies that can be checked.
+ *
+ * @interface IPolicy<TParams extends unknown[]>
+ * @template TParams - The type of the parameters that will be passed to the policy check function.
+ */
+export interface IPolicy<TParams extends unknown[]> {
+    /**
+     * Checks if the policy is valid for the given parameters.
+     *
+     * @param params - Parameters to pass to the policy check function.
+     * @return A promise that resolves if the policy is valid, rejects otherwise.
+     */
+    check(...params: TParams): Promise<boolean>;
+}
+/**
+ * Base class for policies. It implements the IPolicy interface.
+ *
+ * @class PolicyBase
+ * @template TParams - The type of the parameters that will be passed to the policy check function.
+ */
+export declare class PolicyBase<TParams extends unknown[]> implements IPolicy<TParams> {
+    /**
+     * Checks if the policy is valid for the given parameters.
+     *
+     * @return A promise that resolves if the policy is valid, rejects otherwise.
+     * @throws {Error} Error if not implemented.
+     */
+    check(): Promise<boolean>;
+}
+/**
+ * Class for policies that can be checked.
+ *
+ * @class Policy
+ * @template TParams - The type of the parameters that will be passed to the policy check function.
+ */
+export declare class Policy<TParams extends unknown[]> extends PolicyBase<TParams> {
+    private readonly _verificationFn;
+    /**
+     * Creates a new policy.
+     *
+     * @param verificationFn - The function that will be used to verify the policy.
+     */
+    constructor(verificationFn: (...params: TParams) => Promise<boolean>);
+    /**
+     * Checks if the policy is valid for the given parameters.
+     *
+     * @param params - Parameters to pass to the policy check function.
+     * @return A promise that resolves if the policy is valid, rejects otherwise.
+     */
+    check(...params: TParams): Promise<boolean>;
+}

package/data/auth/policy.js

@@ -0,0 +1,44 @@
+/**
+ * Base class for policies. It implements the IPolicy interface.
+ *
+ * @class PolicyBase
+ * @template TParams - The type of the parameters that will be passed to the policy check function.
+ */
+export class PolicyBase {
+    /**
+     * Checks if the policy is valid for the given parameters.
+     *
+     * @return A promise that resolves if the policy is valid, rejects otherwise.
+     * @throws {Error} Error if not implemented.
+     */
+    async check() {
+        throw new Error('Not implemented');
+    }
+}
+/**
+ * Class for policies that can be checked.
+ *
+ * @class Policy
+ * @template TParams - The type of the parameters that will be passed to the policy check function.
+ */
+export class Policy extends PolicyBase {
+    _verificationFn;
+    /**
+     * Creates a new policy.
+     *
+     * @param verificationFn - The function that will be used to verify the policy.
+     */
+    constructor(verificationFn) {
+        super();
+        this._verificationFn = verificationFn;
+    }
+    /**
+     * Checks if the policy is valid for the given parameters.
+     *
+     * @param params - Parameters to pass to the policy check function.
+     * @return A promise that resolves if the policy is valid, rejects otherwise.
+     */
+    async check(...params) {
+        return this._verificationFn(...params);
+    }
+}

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@intellegens/cornerstone-client",
-  "version": "0.0.9999-alpha-7",
+  "version": "0.0.9999-alpha-8",
   "private": false,
   "publishable": true,
-  "main": "./index.js",
-  "types": "./index.d.ts",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "type": "module",
   "author": "Intellegens",
   "license": "MIT",
@@ -14,32 +14,32 @@
     "cornerstone"
   ],
   "scripts": {
-    "clean": "npx --yes rimraf '{dist}'",
+    "clean": "pnpx rimraf '{dist}'",
     "test": "jest",
     "coverage": "jest --coverage",
-    "build": "npm run clean && tsc && tsc-alias",
-    "start": "npm run build && npx vite build && npx tsx ./demo"
+    "build": "pnpm run clean && tsc && tsc-alias",
+    "start": "pnpm run build && pnpx vite build && pnpx tsx ./demo"
   },
   "devDependencies": {
-    "@eslint/js": "^9.21.0",
-    "@types/express": "^5.0.0",
-    "@types/jest": "^29.5.12",
-    "@types/node": "^22.13.9",
-    "eslint": "^9.21.0",
-    "eslint-config-prettier": "^10.0.1",
-    "express": "^4.21.2",
-    "globals": "^16.0.0",
-    "jest": "^29.7.0",
-    "jest-environment-jsdom": "^29.7.0",
-    "prettier": "^3.5.2",
-    "ts-jest": "^29.1.2",
-    "tsc-alias": "^1.8.11",
-    "typescript-eslint": "^8.26.0",
-    "vite": "6.3.4",
-    "zod": "^3.24.2"
+    "@eslint/js": "catalog:",
+    "@types/express": "catalog:",
+    "@types/jest": "catalog:",
+    "@types/node": "catalog:",
+    "eslint": "catalog:",
+    "eslint-config-prettier": "catalog:",
+    "express": "catalog:",
+    "globals": "catalog:",
+    "jest": "catalog:",
+    "jest-environment-jsdom": "catalog:",
+    "prettier": "catalog:",
+    "ts-jest": "catalog:",
+    "tsc-alias": "catalog:",
+    "typescript-eslint": "catalog:",
+    "vite": "catalog:",
+    "zod": "catalog:"
   },
   "dependencies": {
     "http-proxy-middleware": "^3.0.3",
-    "typescript": "^5.4.5"
+    "typescript": "catalog:"
   }
 }

package/services/auth/client/AuthService/index.d.ts

@@ -60,4 +60,8 @@ export declare class AuthService<TKey, TUser extends UserDto<TKey> = UserDto<TKe
      * to update local authentication state to unauthenticated
      */
     handleNoAuthApiResponse(): void;
+    /**
+     * True if a user is currently loaded (post whoAmI/signIn)
+     */
+    isAuthenticated(): boolean;
 }

package/services/auth/client/AuthService/index.js

@@ -150,4 +150,11 @@ export class AuthService {
     handleNoAuthApiResponse() {
         this.user = undefined;
     }
+    // #region Client-side authorization helpers
+    /**
+     * True if a user is currently loaded (post whoAmI/signIn)
+     */
+    isAuthenticated() {
+        return !!this.user;
+    }
 }

package/utils/authorization/index.d.ts

@@ -0,0 +1,17 @@
+import { IPolicy } from '../../data';
+/**
+ * Checks if a policy is valid for the given parameters.
+ *
+ * @param policy Policy to check, either an instance or a class.
+ * @param params Parameters to pass to the policy check function.
+ * @returns A promise that resolves if the policy is valid, rejects otherwise.
+ */
+export declare function check<TParams extends unknown[]>(policy: IPolicy<TParams> | (new () => IPolicy<TParams>), ...params: TParams): Promise<boolean>;
+/**
+ * Composes multiple policies into a single policy.
+ *
+ * @param composition Composition method, either 'AND' or 'OR'.
+ * @param policies Policies to compose.
+ * @returns A new policy that represents the composition of the policies.
+ */
+export declare function compose<TParams extends unknown[]>(composition: 'AND' | 'OR', ...policies: IPolicy<TParams>[]): IPolicy<TParams>;

package/utils/authorization/index.js

@@ -0,0 +1,45 @@
+import { PolicyBase } from '../../data';
+/**
+ * Checks if a policy is valid for the given parameters.
+ *
+ * @param policy Policy to check, either an instance or a class.
+ * @param params Parameters to pass to the policy check function.
+ * @returns A promise that resolves if the policy is valid, rejects otherwise.
+ */
+export async function check(policy, ...params) {
+    // If passed an instance of a policy
+    if (policy instanceof PolicyBase) {
+        return policy.check(...params);
+    }
+    // If passed a policy class
+    else {
+        return new policy().check(...params);
+    }
+}
+/**
+ * Composes multiple policies into a single policy.
+ *
+ * @param composition Composition method, either 'AND' or 'OR'.
+ * @param policies Policies to compose.
+ * @returns A new policy that represents the composition of the policies.
+ */
+export function compose(composition, ...policies) {
+    return {
+        check: async (...params) => {
+            // Check all policies
+            if (composition === 'AND') {
+                const results = await Promise.allSettled(policies.map(policy => policy.check(...params)));
+                return results.every(result => result);
+            }
+            // Check any policies, exit as soon as any are true
+            else if (composition === 'OR') {
+                const results = await Promise.allSettled(policies.map(policy => policy.check(...params)));
+                return results.some(result => result);
+            }
+            // Invalid composition
+            else {
+                throw new Error('Invalid composition');
+            }
+        },
+    };
+}