@intellegens/cornerstone-client 0.0.1 → 0.0.2

package/index.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intellegens/cornerstone-client",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "main": "index.js",
   "type": "module",
   "scripts": {

package/services/auth/index.d.ts

@@ -0,0 +1,46 @@
+import { User, UserInfo } from './types';
+export { User, UserInfo };
+/**
+ * Auth class is responsible for managing user authentication operations.
+ * It supports login, logout, and checking the current user's details.
+ *
+ * @export
+ * @class Auth
+ */
+export declare class Auth<TId, TUser = User<TId>> {
+    private _apiUrl;
+    user: TUser | undefined;
+    /**
+     * Creates an instance of Auth.
+     *
+     * @param {string} apiUrl
+     * @memberof Auth
+     */
+    constructor(apiUrl: string);
+    /**
+     * 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
+     */
+    whoAmI(): Promise<TUser>;
+    /**
+     * 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
+     */
+    login(username: string, password: string): Promise<TUser>;
+    /**
+     * Logs out the current user and clears their authentication state.
+     *
+     * @return {Promise<void>}
+     * @throws {Error} Error if fetch fails
+     * @memberof Auth
+     */
+    logout(): Promise<void>;
+}

package/services/auth/types/index.d.ts

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

package/services/auth/types/user-info.d.ts

@@ -0,0 +1,18 @@
+import { User } from './user';
+/**
+ * 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.
+ *
+ * @typedef {Object} UserInfo
+ * @property {TUser} user The user object.
+ * @property {Date} accessTokenExpiry The expiry date of the access token.
+ */
+export type UserInfo<TId, TUser = User<TId>> = {
+    user: TUser;
+    accessTokenExpiry: Date;
+};

package/services/auth/types/user.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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.
+ *
+ * @typedef {Object} User
+ * @property {TId} id The unique identifier of the user.
+ * @property {string} email The email address of the user.
+ */
+export type User<TId> = {
+    id: TId;
+    email: string;
+};

package/services/config/index.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Configuration class for managing the API
+ *
+ * @export
+ * @class Config
+ */
+export declare 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: string | 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
+     */
+    initialize(): Promise<void>;
+    /**
+     * 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
+     */
+    detectApiBaseUrl(): Promise<string | undefined>;
+}

package/services/index.d.ts

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