@intellegens/cornerstone-client 0.0.8 → 0.0.10

package/data/api/dto/ReadSelectedOrderingPropertyDefinition.d.ts

@@ -0,0 +1,14 @@
+import { ReadSelectedOrderingDirection } from '@data';
+/**
+ * Defines the ordering property for a controller.
+ */
+export declare class ReadSelectedOrderingPropertyDefinition {
+    /**
+     * Gets or sets the property path.
+     */
+    PropertyPath: string;
+    /**
+     * Gets or sets the sort direction.
+     */
+    Direction: ReadSelectedOrderingDirection;
+}

package/data/api/dto/ReadSelectedOrderingPropertyDefinition.js

@@ -0,0 +1,14 @@
+import { ReadSelectedOrderingDirection } from '@data';
+/**
+ * Defines the ordering property for a controller.
+ */
+export class ReadSelectedOrderingPropertyDefinition {
+    /**
+     * Gets or sets the property path.
+     */
+    PropertyPath;
+    /**
+     * Gets or sets the sort direction.
+     */
+    Direction = ReadSelectedOrderingDirection.Ascending;
+}

package/data/api/dto/ReadSelectedPaginationDefinition.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Defines the pagination parameters for a controller.
+ */
+export declare class ReadSelectedPaginationDefinition {
+    /**
+     * Pagination offset
+     */
+    Skip?: number;
+    /**
+     * Pagination limit
+     */
+    Limit?: number;
+}

package/data/api/dto/ReadSelectedPaginationDefinition.js

@@ -0,0 +1,13 @@
+/**
+ * Defines the pagination parameters for a controller.
+ */
+export class ReadSelectedPaginationDefinition {
+    /**
+     * Pagination offset
+     */
+    Skip = 0;
+    /**
+     * Pagination limit
+     */
+    Limit = undefined;
+}

package/data/api/dto/index.d.ts

@@ -0,0 +1,6 @@
+export * from './ReadSelectedDefinition';
+export * from './ReadSelectedFilteringDefinition';
+export * from './ReadSelectedFilteringPropertyDefinition';
+export * from './ReadSelectedOrderingDefinition';
+export * from './ReadSelectedOrderingPropertyDefinition';
+export * from './ReadSelectedPaginationDefinition';

package/data/api/dto/index.js

@@ -0,0 +1,6 @@
+export * from './ReadSelectedDefinition';
+export * from './ReadSelectedFilteringDefinition';
+export * from './ReadSelectedFilteringPropertyDefinition';
+export * from './ReadSelectedOrderingDefinition';
+export * from './ReadSelectedOrderingPropertyDefinition';
+export * from './ReadSelectedPaginationDefinition';

package/data/api/enum/ReadSelectedComparisonOperator.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Represents the basic comparison operators that can be used in a controller.
+ */
+export declare enum ReadSelectedComparisonOperator {
+    /**
+     * Represents the equal comparison operator.
+     */
+    Equal = 0,
+    /**
+     * Represents the not equal comparison operator.
+     */
+    NotEqual = 1
+}

package/data/api/enum/ReadSelectedComparisonOperator.js

@@ -0,0 +1,25 @@
+/**
+ * Represents the basic comparison operators that can be used in a controller.
+ */
+export var ReadSelectedComparisonOperator;
+(function (ReadSelectedComparisonOperator) {
+    //#region Any type
+    /**
+     * Represents the equal comparison operator.
+     */
+    ReadSelectedComparisonOperator[ReadSelectedComparisonOperator["Equal"] = 0] = "Equal";
+    /**
+     * Represents the not equal comparison operator.
+     */
+    ReadSelectedComparisonOperator[ReadSelectedComparisonOperator["NotEqual"] = 1] = "NotEqual";
+    //#endregion
+    //#region Number
+    // ...
+    //#endregion
+    //#region String
+    // ...
+    //#endregion
+    //#region Time
+    // ...
+    //#endregion
+})(ReadSelectedComparisonOperator || (ReadSelectedComparisonOperator = {}));

package/data/api/enum/ReadSelectedLogicalOperator.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Represents the logical operators that can be used in a controller.
+ * - The `And` operator combines multiple conditions, requiring all of them to be true.
+ * - The `Or` operator combines multiple conditions, requiring at least one of them to be true.
+ */
+export declare enum ReadSelectedLogicalOperator {
+    /**
+     * Represents the logical AND operator.
+     */
+    And = 0,
+    /**
+     * Represents the logical OR operator.
+     */
+    Or = 1
+}

package/data/api/enum/ReadSelectedLogicalOperator.js

@@ -0,0 +1,16 @@
+/**
+ * Represents the logical operators that can be used in a controller.
+ * - The `And` operator combines multiple conditions, requiring all of them to be true.
+ * - The `Or` operator combines multiple conditions, requiring at least one of them to be true.
+ */
+export var ReadSelectedLogicalOperator;
+(function (ReadSelectedLogicalOperator) {
+    /**
+     * Represents the logical AND operator.
+     */
+    ReadSelectedLogicalOperator[ReadSelectedLogicalOperator["And"] = 0] = "And";
+    /**
+     * Represents the logical OR operator.
+     */
+    ReadSelectedLogicalOperator[ReadSelectedLogicalOperator["Or"] = 1] = "Or";
+})(ReadSelectedLogicalOperator || (ReadSelectedLogicalOperator = {}));

package/data/api/enum/ReadSelectedOrderingDirection.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Represents options for ordering directions
+ */
+export declare enum ReadSelectedOrderingDirection {
+    /**
+     * Ascending ordering
+     */
+    Ascending = 0,
+    /**
+     * Descending ordering
+     */
+    Descending = 1
+}

package/data/api/enum/ReadSelectedOrderingDirection.js

@@ -0,0 +1,14 @@
+/**
+ * Represents options for ordering directions
+ */
+export var ReadSelectedOrderingDirection;
+(function (ReadSelectedOrderingDirection) {
+    /**
+     * Ascending ordering
+     */
+    ReadSelectedOrderingDirection[ReadSelectedOrderingDirection["Ascending"] = 0] = "Ascending";
+    /**
+     * Descending ordering
+     */
+    ReadSelectedOrderingDirection[ReadSelectedOrderingDirection["Descending"] = 1] = "Descending";
+})(ReadSelectedOrderingDirection || (ReadSelectedOrderingDirection = {}));

package/data/api/enum/ReadSelectedPropertyType.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Represents the basic property types that can be used in a controller.
+ * - The ReadSelectedPropertyType enum defines the basic property types that can be used in a fetch controller. These types include boolean, integer, long, and string.
+ */
+export declare enum ReadSelectedPropertyType {
+    /**
+     * Represents a boolean property type.
+     */
+    Bool = 0,
+    /**
+     * Represents an integer property type.
+     */
+    Int = 100,
+    /**
+     * Represents a long property type.
+     */
+    Long = 101,
+    /**
+     * Represents a string property type.
+     */
+    String = 200
+}

package/data/api/enum/ReadSelectedPropertyType.js

@@ -0,0 +1,32 @@
+/**
+ * Represents the basic property types that can be used in a controller.
+ * - The ReadSelectedPropertyType enum defines the basic property types that can be used in a fetch controller. These types include boolean, integer, long, and string.
+ */
+export var ReadSelectedPropertyType;
+(function (ReadSelectedPropertyType) {
+    //#region Boolean
+    /**
+     * Represents a boolean property type.
+     */
+    ReadSelectedPropertyType[ReadSelectedPropertyType["Bool"] = 0] = "Bool";
+    //#endregion
+    //#region Number
+    /**
+     * Represents an integer property type.
+     */
+    ReadSelectedPropertyType[ReadSelectedPropertyType["Int"] = 100] = "Int";
+    /**
+     * Represents a long property type.
+     */
+    ReadSelectedPropertyType[ReadSelectedPropertyType["Long"] = 101] = "Long";
+    //#endregion
+    //#region string
+    /**
+     * Represents a string property type.
+     */
+    ReadSelectedPropertyType[ReadSelectedPropertyType["String"] = 200] = "String";
+    //#endregion
+    //#region Time
+    // ...
+    //#endregion
+})(ReadSelectedPropertyType || (ReadSelectedPropertyType = {}));

package/data/api/enum/index.d.ts

@@ -0,0 +1,4 @@
+export * from './ReadSelectedComparisonOperator';
+export * from './ReadSelectedLogicalOperator';
+export * from './ReadSelectedOrderingDirection';
+export * from './ReadSelectedPropertyType';

package/data/api/enum/index.js

@@ -0,0 +1,4 @@
+export * from './ReadSelectedComparisonOperator';
+export * from './ReadSelectedLogicalOperator';
+export * from './ReadSelectedOrderingDirection';
+export * from './ReadSelectedPropertyType';

package/data/api/index.d.ts

@@ -0,0 +1,3 @@
+export * from './enum';
+export * from './interface';
+export * from './dto';

package/data/api/index.js

@@ -0,0 +1,3 @@
+export * from './enum';
+export * from './interface';
+export * from './dto';

package/data/api/interface/IIdentifiable.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Interface for entities that have a Id property.
+ * Will be used as a primary key in the database.
+ */
+export interface IIdentifiable<TKey> {
+    /**
+     * Gets or sets the Id of the entity.
+     */
+    Id: TKey;
+}

package/data/api/interface/IIdentifiable.js

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

package/data/api/interface/IIdentifiableByGuid.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Interface for entities that have a Guid property.
+ */
+export interface IIdentifiableByGuid {
+    /**
+     * Gets or sets the Guid of the entity.
+     */
+    Guid: string;
+}

package/data/api/interface/IIdentifiableByGuid.js

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

package/data/api/interface/index.d.ts

@@ -0,0 +1,2 @@
+export * from './IIdentifiable';
+export * from './IIdentifiableByGuid';

package/data/api/interface/index.js

@@ -0,0 +1,2 @@
+export * from './IIdentifiable';
+export * from './IIdentifiableByGuid';

package/data/api/read/ReadSelectedDefinition.d.ts

@@ -0,0 +1,2 @@
+export declare class ReadSelectedDefinition {
+}

package/data/api/read/ReadSelectedDefinition.js

@@ -0,0 +1,2 @@
+export class ReadSelectedDefinition {
+}

package/data/api/read/ReadSelectedFilteringDefinition.d.ts

@@ -0,0 +1,2 @@
+export declare class ReadSelectedFilteringDefinition {
+}

package/data/api/read/ReadSelectedFilteringDefinition.js

@@ -0,0 +1,2 @@
+export class ReadSelectedFilteringDefinition {
+}

package/data/api/read/ReadSelectedFilteringPropertyDefinition.d.ts

@@ -0,0 +1,2 @@
+export declare class ReadSelectedFilteringPropertyDefinition {
+}

package/data/api/read/ReadSelectedFilteringPropertyDefinition.js

@@ -0,0 +1,2 @@
+export class ReadSelectedFilteringPropertyDefinition {
+}

package/data/api/read/ReadSelectedOrderingDefinition.d.ts

@@ -0,0 +1,2 @@
+export declare class ReadSelectedOrderingDefinition {
+}

package/data/api/read/ReadSelectedOrderingDefinition.js

@@ -0,0 +1,2 @@
+export class ReadSelectedOrderingDefinition {
+}

package/data/api/read/ReadSelectedOrderingPropertyDefinition.d.ts

@@ -0,0 +1,2 @@
+export declare class ReadSelectedOrderingPropertyDefinition {
+}

package/data/api/read/ReadSelectedOrderingPropertyDefinition.js

@@ -0,0 +1,2 @@
+export class ReadSelectedOrderingPropertyDefinition {
+}

package/data/api/read/ReadSelectedPaginationDefinition.d.ts

@@ -0,0 +1,2 @@
+export declare class ReadSelectedPaginationDefinition {
+}

package/data/api/read/ReadSelectedPaginationDefinition.js

@@ -0,0 +1,2 @@
+export class ReadSelectedPaginationDefinition {
+}

package/data/api/read/index.d.ts

@@ -0,0 +1,6 @@
+export * from './ReadSelectedDefinition';
+export * from './ReadSelectedFilteringDefinition';
+export * from './ReadSelectedFilteringPropertyDefinition';
+export * from './ReadSelectedOrderingDefinition';
+export * from './ReadSelectedOrderingPropertyDefinition';
+export * from './ReadSelectedPaginationDefinition';

package/data/api/read/index.js

@@ -0,0 +1,6 @@
+export * from './ReadSelectedDefinition';
+export * from './ReadSelectedFilteringDefinition';
+export * from './ReadSelectedFilteringPropertyDefinition';
+export * from './ReadSelectedOrderingDefinition';
+export * from './ReadSelectedOrderingPropertyDefinition';
+export * from './ReadSelectedPaginationDefinition';

package/data/auth/User/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Represents a user with an identifier and email address.
+ *
+ * @template TId The type of the user identifier.
+ *
+ * @param {TId} id The unique identifier for the user.
+ * @param {string} email The email address associated with the user.
+ */
+export type User<TId> = {
+    id: TId;
+    email: string;
+};

package/data/auth/User/index.js

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

package/data/auth/UserInfo/index.d.ts

@@ -0,0 +1,14 @@
+import { User } from '@data';
+/**
+ * Represents user information along with access token expiry.
+ *
+ * @template TId The type of the user identifier.
+ * @template TUser The type of the user object, defaulting to `User<TId>`.
+ *
+ * @param {TUser} user The user object containing user details.
+ * @param {Date} accessTokenExpiry The date and time when the access token will expire.
+ */
+export type UserInfo<TId, TUser = User<TId>> = {
+    user: TUser;
+    accessTokenExpiry: Date;
+};

package/data/auth/UserInfo/index.js

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

package/data/auth/index.d.ts

@@ -0,0 +1,2 @@
+export * from './User';
+export * from './UserInfo';

package/data/auth/index.js

@@ -0,0 +1,2 @@
+export * from './User';
+export * from './UserInfo';

package/data/index.d.ts

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

package/data/index.js

@@ -0,0 +1,3 @@
+//export * from './_generated';
+export * from './auth';
+export * from './api';

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@intellegens/cornerstone-client",
-  "version": "0.0.8",
+  "version": "0.0.10",
   "main": "index.js",
   "type": "module",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "build": "tsc",
-    "demo": "tsc && npx vite build && npx tsx ./demo"
+    "build": "npm run transpile-types && tsc",
+    "demo": "npm run build && npx vite build && npx tsx ./demo",
+    "transpile-types": "cd ../utils/cli && npm run cli zod-gen -- --input '../../client/src/data/_generated/json' --output '../../client/src/data/_generated'"
   },
   "author": "",
   "license": "MIT",

package/services/api/client/ApiCrudControllerClient/index.d.ts

@@ -0,0 +1,11 @@
+import { ApiReadControllerClient } from '@services';
+/**
+ * Generic API client for consuming any Cornerstone CrudController
+ *
+ * @export
+ * @class ApiReadControllerClient
+ * @template TKey - Type of the entity key (e.g., number, string, GUID, etc.)
+ * @template TDto - Data Transfer Object representing the entity
+ */
+export declare class ApiCrudControllerClient<TKey, TDto> extends ApiReadControllerClient<TKey, TDto> {
+}

package/services/api/client/ApiCrudControllerClient/index.js

@@ -0,0 +1,11 @@
+import { ApiReadControllerClient } from '@services';
+/**
+ * Generic API client for consuming any Cornerstone CrudController
+ *
+ * @export
+ * @class ApiReadControllerClient
+ * @template TKey - Type of the entity key (e.g., number, string, GUID, etc.)
+ * @template TDto - Data Transfer Object representing the entity
+ */
+export class ApiCrudControllerClient extends ApiReadControllerClient {
+}

package/services/api/client/ApiReadControllerClient/index.d.ts

@@ -0,0 +1,34 @@
+import { IIdentifiable, ReadSelectedDefinition } from '@data';
+/**
+ * Generic API client for consuming any Cornerstone ReadController
+ *
+ * @export
+ * @class ApiReadControllerClient
+ * @template TKey - Type of the entity key (e.g., number, string, GUID, etc.)
+ * @template TDto - Data Transfer Object representing the entity
+ */
+export declare class ApiReadControllerClient<TKey, TDto = IIdentifiable<TKey>> {
+    private readonly baseControllerPath;
+    /**
+     * Constructor
+     * @param baseControllerPath Base path to API controller
+     */
+    constructor(baseControllerPath: string);
+    /**
+     * Fetches selected entities based on a filter definition.
+     * @param {any} definition - The filter definition object
+     * @returns {Promise<TDto[]>} List of entities that match the selection criteria
+     */
+    readSelected(definition: ReadSelectedDefinition): Promise<TDto[]>;
+    /**
+     * Fetches a single entity by its ID.
+     * @param {TKey} id - The ID of the entity
+     * @returns {Promise<TDto | undefined>} The requested entity
+     */
+    readSingle(id: TKey): Promise<TDto>;
+    /**
+     * Fetches all entities from the read controller.
+     * @returns {Promise<TDto[]>} List of all entities
+     */
+    readAll(): Promise<TDto[]>;
+}

package/services/api/client/ApiReadControllerClient/index.js

@@ -0,0 +1,74 @@
+import { apiInitializationService } from '@services';
+/**
+ * Generic API client for consuming any Cornerstone ReadController
+ *
+ * @export
+ * @class ApiReadControllerClient
+ * @template TKey - Type of the entity key (e.g., number, string, GUID, etc.)
+ * @template TDto - Data Transfer Object representing the entity
+ */
+export class ApiReadControllerClient {
+    baseControllerPath;
+    /**
+     * Constructor
+     * @param baseControllerPath Base path to API controller
+     */
+    constructor(baseControllerPath) {
+        this.baseControllerPath = baseControllerPath;
+    }
+    /**
+     * Fetches selected entities based on a filter definition.
+     * @param {any} definition - The filter definition object
+     * @returns {Promise<TDto[]>} List of entities that match the selection criteria
+     */
+    async readSelected(definition) {
+        try {
+            const url = await apiInitializationService.getApiUrl(this.baseControllerPath, `/ReadSelected`);
+            const response = await fetch(url, {
+                method: 'POST',
+                headers: { 'Content-Type': 'application/json' },
+                body: JSON.stringify(definition),
+                credentials: 'include',
+            });
+            if (!response.ok)
+                throw new Error('Failed to fetch selected records');
+            return response.json();
+        }
+        catch (err) {
+            throw err instanceof Error ? err : new Error('Unknown error fetching selected records');
+        }
+    }
+    /**
+     * Fetches a single entity by its ID.
+     * @param {TKey} id - The ID of the entity
+     * @returns {Promise<TDto | undefined>} The requested entity
+     */
+    async readSingle(id) {
+        try {
+            const url = await apiInitializationService.getApiUrl(this.baseControllerPath, `/ReadSingle?id=${encodeURIComponent(String(id))}`);
+            const response = await fetch(url, { credentials: 'include' });
+            if (!response.ok)
+                throw new Error('Failed to fetch single record');
+            return response.json();
+        }
+        catch (err) {
+            throw err instanceof Error ? err : new Error('Unknown error fetching single record');
+        }
+    }
+    /**
+     * Fetches all entities from the read controller.
+     * @returns {Promise<TDto[]>} List of all entities
+     */
+    async readAll() {
+        try {
+            const url = await apiInitializationService.getApiUrl(this.baseControllerPath, `/ReadAll`);
+            const response = await fetch(url, { credentials: 'include' });
+            if (!response.ok)
+                throw new Error('Failed to fetch all records');
+            return response.json();
+        }
+        catch (err) {
+            throw err instanceof Error ? err : new Error('Unknown error fetching all records');
+        }
+    }
+}

package/services/api/client/index.d.ts

@@ -1,2 +1,2 @@
-export * from './read';
-export * from './crud';
+export * from './ApiReadControllerClient';
+export * from './ApiCrudControllerClient';

package/services/api/client/index.js

@@ -1,2 +1,2 @@
-export * from './read';
-export * from './crud';
+export * from './ApiReadControllerClient';
+export * from './ApiCrudControllerClient';

package/services/api/initialization/index.d.ts

@@ -54,11 +54,23 @@ export declare class ApiInitializationService {
      * Composes a full API URL for a provided endpoint path.
      *
      * @async
-     * @param relativeEndpointPath Relative endpoint path
+     * @param relativeEndpointPathSections Relative endpoint path sections
      * @return {Promise<string | undefined>} Returns the API endpoint's URL
      * @throws {Error} Throws error if API base URL detection fails
      */
-    getApiUrl(relativeEndpointPath: string): Promise<string>;
+    getApiUrl(...relativeEndpointPathSections: string[]): Promise<string>;
+    /**
+     * Removes starting '/' character
+     * @param str String to remove the starting '/' character from
+     * @returns String with starting '/' character  removed
+     */
+    private removeStartsWithSlashChar;
+    /**
+     * Removes ending '/' character
+     * @param str String to remove the ending '/' character from
+     * @returns String with ending '/' character  removed
+     */
+    private removeEndsWithSlashChar;
 }
 /**
  * Singleton instance of ApiInitializationService