@monterosa/sdk-identify-kit 0.19.0-rc.6 → 2.0.0-rc.2

package/dist/api.d.ts

@@ -2,22 +2,42 @@
  * @license
  * identify-kit
  *
- * Copyright © 2023-2024 Monterosa Productions Limited. All rights reserved.
+ * Copyright © 2023-2026 Monterosa Productions Limited. All rights reserved.
  *
  * More details on the license can be found at https://www.monterosa.co/sdk/license
  */
 import { MonterosaSdk } from '@monterosa/sdk-core';
-import { Unsubscribe } from '@monterosa/sdk-util';
-import { Payload, ParentApplication } from '@monterosa/sdk-launcher-kit';
-import { IdentifyKit, Credentials, Signature, UserData, IdentifyOptions, IdentifyAction, IdentifyHook } from './types';
+import { Unsubscribe, TaskQueue } from '@monterosa/sdk-util';
+import { Payload } from '@monterosa/sdk-launcher-kit';
+import { IdentifyKit, LoginState, Credentials, Signature, UserData, IdentifyOptions, IdentifyAction, IdentifyHook } from './types';
 /**
  * @internal
  */
-export declare function parentAppRequest<T>(parentApp: ParentApplication, action: IdentifyAction, payload?: Payload): Promise<T>;
+export declare const taskQueue: TaskQueue;
+/**
+ * @internal
+ */
+export declare function parentAppRequest<T>(identify: IdentifyKit, action: IdentifyAction, payload?: Payload): Promise<T>;
 /**
  * @internal
  */
 export declare function registerIdentifyHook(hook: IdentifyHook): void;
+/**
+ * @internal
+ */
+export declare function loginTask(identify: IdentifyKit, credentials: Credentials): Promise<void>;
+/**
+ * @internal
+ */
+export declare function logoutTask(identify: IdentifyKit): Promise<void>;
+/**
+ * @internal
+ */
+export declare function enqueueLogin(identify: IdentifyKit, credentials: Credentials, prioritise?: boolean): void;
+/**
+ * @internal
+ */
+export declare function enqueueLogout(identify: IdentifyKit): void;
 /**
  * A factory function that creates a new instance of the `IdentifyKit` class,
  * which is a kit of the Monterosa SDK used for user identification.
@@ -141,166 +161,147 @@ export declare function requestLogin(identify: IdentifyKit): Promise<void>;
  */
 export declare function requestLogout(identify: IdentifyKit): Promise<void>;
 /**
- * A function that notifies that a user logged in.
- *
- * @example
- * ```javascript
- * import { getSpace } from '@monterosa/sdk-core';
- * import { getIdentify, notifyUserLoggedIn } from '@monterosa/sdk-identify-kit';
- *
- * const sdk = getSpace('host', 'sdk-id');
- * const identify = getIdentify(sdk);
- *
- * try {
- *   await notifyUserLoggedIn(identify);
+ * @internal
  *
- *   console.log('Notify that the user logged in successfully');
- * } catch (err) {
- *   console.error('Error notifying that the user logged in:', error.message)
- * }
- * ```
+ * Returns a signature for a user session. The signature is based on the
+ * user's identifying information provided in the `IdentifyKit` instance.
  *
  * @remarks
- * - If the app is running within a third-party application that uses
- *   the Monterosa SDK, the function delegates to the parent app
- *   to handle the notification process.
+ * This function does not handle errors. Callers are responsible for catching
+ * and handling failures.
  *
  * @param identify - An instance of the `IdentifyKit` class used for user
  *   identification.
- * @returns A Promise that resolves with `void` when the notification of the user
- *   logging in is completed.
+ * @param credentials - The credentials of the user.
+ *
+ * @returns A Promise that resolves to a `Signature` object.
+ */
+export declare function getSessionSignature(identify: IdentifyKit, credentials: Credentials): Promise<Signature>;
+/**
+ * A memoized version of the `getSessionSignature` function.
  */
-export declare function notifyUserLoggedIn(identify: IdentifyKit): Promise<void>;
+export declare const getSessionSignatureMemoized: (...args: any[]) => Promise<Signature>;
 /**
- * A function that notifies that a user logged out.
+ * The function that takes an instance of `IdentifyKit` as its argument and
+ * returns a Promise that resolves to a key-value object representing user data.
  *
  * @example
  * ```javascript
- * import { getSpace } from '@monterosa/sdk-core';
- * import { getIdentify, notifyUserLoggedOut } from '@monterosa/sdk-identify-kit';
+ * import { configure } from '@monterosa/sdk-core';
+ * import { getIdentify, getUserData } from '@monterosa/sdk-identify-kit';
  *
- * const sdk = getSpace('host', 'sdk-id');
- * const identify = getIdentify(sdk);
+ * configure({ host: '...', projectId: '...' });
  *
- * try {
- *   await notifyUserLoggedOut(identify);
+ * const identify = getIdentify();
+ * const userData = await getUserData(identify);
  *
- *   console.log('Notify that the user logged out successfully');
- * } catch (err) {
- *   console.error('Error notifying that the user logged out:', error.message)
- * }
+ * console.log('User data:', userData);
  * ```
  *
  * @remarks
  * - If the app is running within a third-party application that uses
  *   the Monterosa SDK, the function delegates to the parent app
- *   to handle the notification process.
+ *   to get user data.
  *
- * @param identify - An instance of the `IdentifyKit` class used for user
- *   identification.
- * @returns A Promise that resolves with `void` when the notification of the user
- *   logging out is completed.
+ * - If the request is successful, the function resolves with a key-value object
+ *   representing user data. If not, a `MonterosaError` is thrown.
+ *
+ * @param identify - An instance of `IdentifyKit` that provides the user
+ *   identification functionality.
+ * @returns A Promise that resolves to a key-value object representing user data.
+ *   The structure and content of the user data object depend on the identify
+ *   service provider and may vary. It typically contains information about the user,
+ *   but the specific fields are determined by the Identify service provider.
  */
-export declare function notifyUserLoggedOut(identify: IdentifyKit): Promise<void>;
+export declare function getUserData(identify: IdentifyKit): Promise<UserData>;
 /**
- * Returns a signature for a user session. The signature is based on the
- * user's identifying information provided in the `IdentifyKit` instance.
+ * Sets the user's authentication credentials.
  *
  * @example
  * ```javascript
  * import { configure } from '@monterosa/sdk-core';
- * import { getIdentify, getSession } from '@monterosa/sdk-identify-kit';
- * import { getConnect, login } from '@monterosa/sdk-connect-kit';
+ * import { getIdentify, setCredentials } from '@monterosa/sdk-identify-kit';
  *
  * configure({ host: '...', projectId: '...' });
  *
+ * const credentials = { token: 'abc123' };
  * const identify = getIdentify();
- * const session = await getSession(identify);
  *
- * const connect = await getConnect();
- * await login(connect, ...session);
+ * await setCredentials(identify, credentials)
  * ```
  *
  * @remarks
  * - If the app is running within a third-party application that uses
  *   the Monterosa SDK, the function delegates to the parent app
- *   to get session signature.
+ *   to set user credentials.
  *
- * - If the request is successful, the function resolves with `Signature`.
+ * - If the request is successful, the function resolves to `void`.
  *   If not, a `MonterosaError` is thrown.
  *
- * - The function can be used to fetch a signature for a user session that
- *   can be used to authenticate user with `ConnectKit`.
- *
- * @param identify - An instance of the `IdentifyKit` class used for user
- *   identification.
- * @returns A Promise that resolves to an object of type `Signature`.
+ * @param identify - An instance of `IdentifyKit` that provides the user
+ *   identification functionality.
+ * @param credentials - An object representing the user's authentication
+ *   credentials.
+ * @returns A Promise that resolves to `void`.
  */
-export declare function getSessionSignature(identify: IdentifyKit): Promise<Signature>;
+export declare function setCredentials(identify: IdentifyKit, credentials: Credentials): Promise<void>;
 /**
- * The function that takes an instance of `IdentifyKit` as its argument and
- * returns a Promise that resolves to a key-value object representing user data.
+ * Clears the user's authentication credentials.
  *
  * @example
  * ```javascript
  * import { configure } from '@monterosa/sdk-core';
- * import { getIdentify, getUserData } from '@monterosa/sdk-identify-kit';
+ * import { getIdentify, clearCredentials } from '@monterosa/sdk-identify-kit';
  *
  * configure({ host: '...', projectId: '...' });
  *
  * const identify = getIdentify();
- * const userData = await getUserData(identify);
  *
- * console.log('User data:', userData);
+ * await clearCredentials(identify);
  * ```
  *
  * @remarks
  * - If the app is running within a third-party application that uses
  *   the Monterosa SDK, the function delegates to the parent app
- *   to get user data.
+ *   to clear user credentials.
  *
- * - If the request is successful, the function resolves with a key-value object
- *   representing user data. If not, a `MonterosaError` is thrown.
+ * - If the request is successful, the function resolves to `void`.
+ *   If not, a `MonterosaError` is thrown.
  *
  * @param identify - An instance of `IdentifyKit` that provides the user
  *   identification functionality.
- * @returns A Promise that resolves to a key-value object representing user data.
- *   The structure and content of the user data object depend on the identify
- *   service provider and may vary. It typically contains information about the user,
- *   but the specific fields are determined by the Idenitfy service provider.
+ * @returns A Promise that resolves to `void`.
  */
-export declare function getUserData(identify: IdentifyKit): Promise<UserData>;
+export declare function clearCredentials(identify: IdentifyKit): Promise<void>;
 /**
- * Sets the user's authentication credentials.
+ * Registers a callback function that will be called whenever the `LoginState`
+ * object associated with the `IdentifyKit` instance is updated.
  *
  * @example
  * ```javascript
  * import { configure } from '@monterosa/sdk-core';
- * import { getIdentify, setCredentials } from '@monterosa/sdk-identify-kit';
+ * import { getIdentify, onStateUpdated } from '@monterosa/sdk-identify-kit';
  *
  * configure({ host: '...', projectId: '...' });
  *
- * const credentials = { token: 'abc123' };
  * const identify = getIdentify();
  *
- * await setCredentials(identify, credentials)
- * ```
- *
- * @remarks
- * - If the app is running within a third-party application that uses
- *   the Monterosa SDK, the function delegates to the parent app
- *   to set user credentials.
+ * const unsubscribe = onStateUpdated(identify, (state) => {
+ *   console.log("State updated:", state);
+ * });
  *
- * - If the request is successful, the function resolves to `void`.
- *   If not, a `MonterosaError` is thrown.
+ * // Call unsubscribe() to unregister the callback function
+ * // unsubscribe();
+ * ```
  *
  * @param identify - An instance of `IdentifyKit` that provides the user
  *   identification functionality.
- * @param credentials - An object representing the user's authentication
- *   credentials.
- * @returns A Promise that resolves to `void`.
+ * @param callback - The callback function to register. This function will be
+ *   called with the updated `LoginState` object as its only argument.
+ * @returns An `Unsubscribe` function that can be called to unregister
+ *   the callback function.
  */
-export declare function setCredentials(identify: IdentifyKit, credentials: Credentials): Promise<void>;
+export declare function onStateUpdated(identify: IdentifyKit, callback: (state: LoginState) => void): Unsubscribe;
 /**
  * Registers a callback function that will be called whenever the `Credentials`
  * object associated with the `IdentifyKit` instance is updated.
@@ -430,7 +431,7 @@ export declare function onUserDataUpdated(identify: IdentifyKit, callback: (user
  * @param identify - An instance of `IdentifyKit` that provides the user
  *   identification functionality.
  * @param callback - The callback function to register. This function will
- *   be called when a login is requested by an experience.
+ *   be called when a login is requested by an Experience.
  * @returns An `Unsubscribe` function that can be called to unregister
  *   the callback function.
  */
@@ -459,92 +460,13 @@ export declare function onLoginRequestedByExperience(identify: IdentifyKit, call
  * @param identify - An instance of `IdentifyKit` that provides the user
  *   identification functionality.
  * @param callback - The callback function to register. This function will
- *   be called when a logout is requested by an experience.
+ *   be called when a logout is requested by an Experience.
  * @returns An `Unsubscribe` function that can be called to unregister
  *   the callback function.
  */
 export declare function onLogoutRequestedByExperience(identify: IdentifyKit, callback: () => void): Unsubscribe;
 /**
- * Registers a callback function that will be called when the credentials validation fails.
- *
- * @example
- * ```javascript
- * import { configure } from '@monterosa/sdk-core';
- * import { getIdentify, onCredentialsValidationFailed } from '@monterosa/sdk-identify-kit';
- *
- * configure({ host: '...', projectId: '...' });
  *
- * const identify = getIdentify();
- *
- * const unsubscribe = onCredentialsValidationFailed(identify, (error) => {
- *   console.log(error);
- * });
- *
- * // Call unsubscribe() to unregister the callback function
- * // unsubscribe();
- * ```
- *
- * @param identify - An instance of `IdentifyKit` that provides the user
- *   identification functionality.
- * @param callback - The callback function to register. This function will
- *   be called when an error occured.
- * @returns An `Unsubscribe` function that can be called to unregister
- *   the callback function.
- */
-export declare function onCredentialsValidationFailed(identify: IdentifyKit, callback: (error: string) => void): Unsubscribe;
-/**
- * Registers a callback function that will be called when a notification that
- * a user is logged in sent.
- *
- * @example
- * ```javascript
- * import { getSpace } from '@monterosa/sdk-core';
- * import { getIdentify, onUserLoggedIn } from '@monterosa/sdk-identify-kit';
- *
- * const sdk = getSpace('host', 'sdk-id');
- * const identify = getIdentify(sdk);
- *
- * const unsubscribe = onUserLoggedIn(identify, () => {
- *   console.log('User logged in successfully');
- * });
- *
- * // Call unsubscribe() to unregister the callback function
- * // unsubscribe();
- * ```
- *
- * @param identify - An instance of `IdentifyKit` that provides the user
- *   identification functionality.
- * @param callback - The callback function to register. This function will
- *   be called when a notification that the user logged in is called.
- * @returns An `Unsubscribe` function that can be called to unregister
- *   the callback function.
- */
-export declare function onUserLoggedIn(identify: IdentifyKit, callback: () => void): Unsubscribe;
-/**
- * Registers a callback function that will be called when a notification that
- * a user is logged out sent.
- *
- * @example
- * ```javascript
- * import { getSpace } from '@monterosa/sdk-core';
- * import { getIdentify, onUserLoggedOut } from '@monterosa/sdk-identify-kit';
- *
- * const sdk = getSpace('host', 'sdk-id');
- * const identify = getIdentify(sdk);
- *
- * const unsubscribe = onUserLoggedOut(identify, () => {
- *   console.log('User logged out successfully');
- * });
- *
- * // Call unsubscribe() to unregister the callback function
- * // unsubscribe();
- * ```
- *
- * @param identify - An instance of `IdentifyKit` that provides the user
- *   identification functionality.
- * @param callback - The callback function to register. This function will
- *   be called when a notification that the user logged out is called.
- * @returns An `Unsubscribe` function that can be called to unregister
- *   the callback function.
+ * @internal
  */
-export declare function onUserLoggedOut(identify: IdentifyKit, callback: () => void): Unsubscribe;
+export declare function watchConnectionStatus(identify: IdentifyKit): Promise<void>;

package/dist/bridge.d.ts

@@ -2,12 +2,21 @@
  * @license
  * @monterosa/sdk-identify-kit
  *
- * Copyright © 2023-2024 Monterosa Productions Limited. All rights reserved.
+ * Copyright © 2023-2026 Monterosa Productions Limited. All rights reserved.
  *
  * More details on the license can be found at https://www.monterosa.co/sdk/license
  */
+import { Experience } from '@monterosa/sdk-launcher-kit';
 import { IdentifyKit } from './types';
 /**
  * @internal
  */
 export declare function parentMessagesHook(identify: IdentifyKit): () => void;
+/**
+ * @internal
+ */
+export declare function handleExperienceEmbedded(experience: Experience): void;
+/**
+ * @internal
+ */
+export declare function handleExperienceUnmounted(experience: Experience): void;

package/dist/constants.d.ts

@@ -8,4 +8,3 @@
  */
 export declare const EXTENSION_ID = "lvis-id-custom-tab";
 export declare const SIGNATURE_TTL = 10000;
-export declare const USER_DATA_TTL = 10000;

package/dist/experiences.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @license
+ * @monterosa/sdk-identify-kit
+ *
+ * Copyright © 2025-2026 Monterosa Productions Limited. All rights reserved.
+ *
+ * More details on the license can be found at https://www.monterosa.co/sdk/license
+ */
+import type { Unsubscribe } from '@monterosa/sdk-util';
+import type { Experience } from '@monterosa/sdk-launcher-kit';
+export declare function getExperiences(): Experience[];
+export declare function addExperience(experience: Experience, unsubs?: Unsubscribe[]): void;
+export declare function deleteExperience(experience: Experience): void;

package/dist/identify.d.ts

@@ -2,15 +2,16 @@
  * @license
  * @monterosa/sdk-identify-kit
  *
- * Copyright © 2023-2024 Monterosa Productions Limited. All rights reserved.
+ * Copyright © 2023 Monterosa Productions Limited. All rights reserved.
  *
  * More details on the license can be found at https://www.monterosa.co/sdk/license
  */
 import { MonterosaSdk } from '@monterosa/sdk-core';
 import { Emitter } from '@monterosa/sdk-util';
-import { IdentifyKit, IdentifyOptions, Credentials, Signature, UserData } from './types';
+import { IdentifyKit, IdentifyOptions, LoginState, Credentials, Signature, UserData } from './types';
 export default class Identify extends Emitter implements IdentifyKit {
     sdk: MonterosaSdk;
+    private wasLoggedIn;
     private host?;
     private readonly _options;
     private _credentials;
@@ -18,10 +19,11 @@ export default class Identify extends Emitter implements IdentifyKit {
     private _userData;
     private signatureExpireTimeout;
     private userDataExpireTimeout;
+    _state: LoginState;
     constructor(sdk: MonterosaSdk, options?: IdentifyOptions);
-    expireSignature(delay: number): void;
-    expireUserData(delay: number): void;
     private static fetchIdentifyHost;
+    get state(): LoginState;
+    set state(state: LoginState);
     get options(): IdentifyOptions;
     set signature(signature: Signature | null);
     get signature(): Signature | null;
@@ -29,5 +31,7 @@ export default class Identify extends Emitter implements IdentifyKit {
     get credentials(): Credentials | null;
     set userData(data: UserData | null);
     get userData(): UserData | null;
+    get shouldLoginOnReconnect(): boolean;
+    reset(): void;
     getUrl(path?: string): Promise<string>;
 }

package/dist/index.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Handles user authentication and identity management.
+ *
+ * @packageDocumentation
+ */
 /**
  * @license
  * @monterosa/sdk-identify-kit
@@ -6,11 +11,6 @@
  *
  * More details on the license can be found at https://www.monterosa.co/sdk/license
  */
-/**
- * Monterosa SDK / Identify Kit
- *
- * @packageDocumentation
- */
 import './bridge';
-export * from './api';
-export { Credentials, Signature, UserData, IdentifyKit, IdentifyOptions, IdentifyError, } from './types';
+export { getIdentify, requestLogin, requestLogout, getUserData, setCredentials, clearCredentials, onStateUpdated, onCredentialsUpdated, onSignatureUpdated, onUserDataUpdated, onLoginRequestedByExperience, onLogoutRequestedByExperience, } from './api';
+export { Credentials, Signature, UserData, IdentifyKit, IdentifyOptions, IdentifyError, LoginState, LoginPolicy, } from './types';