@monterosa/sdk-storage-kit 2.0.0-rc.1 → 2.0.0-rc.3

package/dist/api.d.ts

@@ -26,6 +26,9 @@ export declare function handleExperienceUnmounted(experience: Experience): void;
  * @internal
  */
 export declare function parentAppRequest(parentApp: ParentApplication, action: StorageAction.Read, payload?: Payload): Promise<string | null>;
+/**
+ * @internal
+ */
 export declare function parentAppRequest(parentApp: ParentApplication, action: StorageAction.Write | StorageAction.Remove | StorageAction.Clear, payload?: Payload): Promise<undefined>;
 /**
  * The `setStoragePersistent` function is a simple function that allows to

package/dist/index.cjs

@@ -0,0 +1,426 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var sdkUtil = require('@monterosa/sdk-util');
+var sdkLauncherKit = require('@monterosa/sdk-launcher-kit');
+
+/**
+ * @license
+ * types.ts
+ * storage-kit
+ *
+ * Copyright © 2025 Monterosa Productions Limited. All rights reserved.
+ *
+ * More details on the license can be found at https://www.monterosa.co/sdk/license
+ */
+/**
+ * Storage bridge action types used internally to communicate with the parent application.
+ */
+var StorageAction;
+(function (StorageAction) {
+    /**
+     * Read a value from storage.
+     */
+    StorageAction["Read"] = "storageRead";
+    /**
+     * Write a value to storage.
+     */
+    StorageAction["Write"] = "storageWrite";
+    /**
+     * Remove a value from storage.
+     */
+    StorageAction["Remove"] = "storageRemove";
+    /**
+     * Clear all values from storage.
+     */
+    StorageAction["Clear"] = "storageClear";
+})(StorageAction || (StorageAction = {}));
+/**
+ * Defines a set of error codes that may be encountered when using the
+ * Storage kit of the Monterosa SDK.
+ *
+ * @example
+ * ```javascript
+ * try {
+ *   // some code that uses the StorageKit
+ * } catch (err) {
+ *   if (err.code === StorageError.ParentAppError) {
+ *     // handle parent app error
+ *   } else {
+ *     // handle other error types
+ *   }
+ * }
+ * ```
+ *
+ * @remarks
+ * - The `StorageError` enum provides a convenient way to handle errors
+ *   encountered when using the `StorageKit` module. By checking the code
+ *   property of the caught error against the values of the enum, the error
+ *   type can be determined and appropriate action taken.
+ *
+ * - The `StorageError` enum is not intended to be instantiated or extended.
+ */
+exports.StorageError = void 0;
+(function (StorageError) {
+    /**
+     * Indicates an error occurred in the parent app.
+     */
+    StorageError["ParentAppError"] = "parent_app_error";
+    /**
+     * Indicates a timeout occurred when communicating with the parent app.
+     */
+    StorageError["ParentTimeoutError"] = "parent_timeout_error";
+    /**
+     * Indicates an error occurred when reading from the storage.
+     */
+    StorageError["ReadError"] = "read_error";
+    /**
+     * Indicates an error occurred when writing to the storage.
+     */
+    StorageError["WriteError"] = "write_error";
+    /**
+     * Indicates an error occurred when removing from the storage.
+     */
+    StorageError["RemoveError"] = "remove_error";
+    /**
+     * Indicates an error occurred when clearing the storage.
+     */
+    StorageError["ClearError"] = "clear_error";
+})(exports.StorageError || (exports.StorageError = {}));
+/**
+ * @internal
+ */
+const StorageErrorMessages = {
+    [exports.StorageError.ParentAppError]: (error) => `Parent application error: ${error}`,
+    [exports.StorageError.ParentTimeoutError]: (error) => `Parent application timeout: ${error}. Please check if the storage-kit is imported on the parent page.`,
+    [exports.StorageError.ReadError]: (error) => `Storage read error: ${error}`,
+    [exports.StorageError.WriteError]: (error) => `Storage write error: ${error}`,
+    [exports.StorageError.RemoveError]: (error) => `Storage remove error: ${error}`,
+    [exports.StorageError.ClearError]: (error) => `Storage clear error: ${error}`,
+};
+
+/**
+ * @license
+ * storage_impl.ts
+ * storage-kit
+ *
+ * Copyright © 2025 Monterosa Productions Limited. All rights reserved.
+ *
+ * More details on the license can be found at https://www.monterosa.co/sdk/license
+ */
+class StorageImpl {
+    constructor() {
+        this.memoryStore = {};
+        this.accessible = sdkUtil.checkAvailability();
+        this._persistent = true;
+    }
+    set persistent(newValue) {
+        const oldValue = this._persistent;
+        if (oldValue === newValue) {
+            return;
+        }
+        const swapToStorage = newValue === true && this.accessible;
+        const swapToMemory = newValue === false && this.accessible;
+        if (swapToStorage) {
+            for (const [key, value] of Object.entries(this.memoryStore)) {
+                sdkUtil.setItem(key, value);
+            }
+        }
+        if (swapToMemory) {
+            sdkUtil.clear();
+        }
+        this._persistent = newValue;
+    }
+    get persistent() {
+        return this._persistent;
+    }
+    getItem(key) {
+        if (this.persistent && this.accessible) {
+            return sdkUtil.getItem(key);
+        }
+        if (Object.prototype.hasOwnProperty.call(this.memoryStore, key)) {
+            return this.memoryStore[key];
+        }
+        return null;
+    }
+    setItem(key, value) {
+        if (this.persistent && this.accessible) {
+            sdkUtil.setItem(key, value);
+        }
+        this.memoryStore[key] = value;
+    }
+    removeItem(key) {
+        if (this.persistent && this.accessible) {
+            sdkUtil.removeItem(key);
+        }
+        delete this.memoryStore[key];
+    }
+    clear() {
+        if (this.persistent && this.accessible) {
+            sdkUtil.clear();
+        }
+        this.memoryStore = {};
+    }
+}
+
+/**
+ * @license
+ * api.ts
+ * storage-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
+ */
+/**
+ * @internal
+ */
+const storage = new StorageImpl();
+/**
+ * @internal
+ */
+const unsubs = new Map();
+/**
+ * @internal
+ */
+function handleExperienceEmbedded(experience) {
+    const unsub = sdkLauncherKit.onSdkMessage(experience, (message) => {
+        var _a;
+        if (!Object.values(StorageAction).includes(message.action)) {
+            return;
+        }
+        try {
+            let payload = {};
+            switch (message.action) {
+                case StorageAction.Read:
+                    payload = {
+                        key: message.payload.key,
+                        value: storage.getItem(message.payload.key),
+                    };
+                    break;
+                case StorageAction.Write:
+                    payload = {
+                        key: message.payload.key,
+                    };
+                    storage.setItem(message.payload.key, message.payload.value);
+                    break;
+                case StorageAction.Remove:
+                    payload = {
+                        key: message.payload.key,
+                    };
+                    storage.removeItem(message.payload.key);
+                    break;
+                case StorageAction.Clear:
+                    storage.clear();
+                    break;
+            }
+            sdkLauncherKit.respondToSdkMessage(experience, message, payload);
+        }
+        catch (err) {
+            const errorMessage = sdkUtil.getErrorMessage(err);
+            const key = (_a = message.payload) === null || _a === void 0 ? void 0 : _a.key;
+            const keyInfo = key ? ` for key "${key}"` : '';
+            console.error(`Unable to handle storage action ${message.action}${keyInfo} with error: ${errorMessage}`);
+            sdkLauncherKit.respondToSdkMessage(experience, message, {
+                key: message.payload.key,
+                error: errorMessage,
+            });
+        }
+    });
+    unsubs.set(experience.id, unsub);
+}
+/**
+ * @internal
+ */
+function handleExperienceUnmounted(experience) {
+    const unsub = unsubs.get(experience.id);
+    if (unsub) {
+        unsub();
+        unsubs.delete(experience.id);
+    }
+}
+/**
+ * @internal
+ */
+async function parentAppRequest(parentApp, action, payload) {
+    try {
+        const response = await sdkLauncherKit.sendSdkRequest(parentApp, action, payload);
+        const { value, error } = response.payload;
+        if (error !== undefined) {
+            throw sdkUtil.createError(exports.StorageError.ParentAppError, StorageErrorMessages, error);
+        }
+        return value;
+    }
+    catch (err) {
+        if (err instanceof sdkUtil.MonterosaError &&
+            err.code === sdkLauncherKit.BridgeError.RequestTimeoutError) {
+            const errorMessage = sdkUtil.getErrorMessage(err);
+            throw sdkUtil.createError(exports.StorageError.ParentTimeoutError, StorageErrorMessages, errorMessage);
+        }
+        throw err;
+    }
+}
+/**
+ * The `setStoragePersistent` function is a simple function that allows to
+ * control the persistence of the SDK storage. If the argument `persistent` is
+ * set to `true`, then the storage will be persistent across browser sessions
+ * and if it is set to `false`, then the storage will save to memory.
+ * It is  important to note that the use of persistent storage may be subject
+ * to laws and regulations, such as those related to data privacy and protection.
+ *
+ * @remarks
+ * - We transition from persistent to memory and memory to persistent in
+ *   a seamless manner for you
+ *
+ * - By default we store in memory
+ *
+ * - The value of storage persistent persists across session (aka put it to true,
+ *   it will remain so, put it back to false, it will remain so)
+ *
+ * - You have the responsibility to comply with any laws and regulations, and
+ *   store only the data if you know it's valid to do so
+ *
+ * @param persistent - Determines whether or not SDK storage should persist
+ * across browser sessions.
+ */
+function setStoragePersistent(persistent) {
+    storage.persistent = persistent;
+}
+/**
+ * The function allows to read data from the SDK storage.
+ *
+ * @param key - The name of the item to be read from storage.
+ *
+ * @throws
+ * The function throws an error if there is a timeout reading the data
+ * from the parent application storage.
+ *
+ * @returns A promise that resolves to the value
+ * of the item in storage or `null` if the item doesn't exist.
+ */
+async function storageRead(key) {
+    const parentApp = sdkLauncherKit.getParentApplication();
+    let value = null;
+    try {
+        if (parentApp !== null) {
+            value = await parentAppRequest(parentApp, StorageAction.Read, {
+                key,
+            });
+        }
+        else {
+            value = storage.getItem(key);
+        }
+    }
+    catch (err) {
+        const errorMessage = sdkUtil.getErrorMessage(err);
+        console.error(`Unable to read storage item "${key}" with error: ${errorMessage}`);
+        throw sdkUtil.createError(exports.StorageError.ReadError, StorageErrorMessages, errorMessage);
+    }
+    return value;
+}
+/**
+ * The function allows to write data to the SDK storage.
+ *
+ * @param key - A name of the item to be stored.
+ * @param value - A value to be stored.
+ *
+ * @throws
+ * The function throws an error if there is a timeout writing the data
+ * to the parent's application storage.
+ *
+ * @returns A promise that resolves to `void` once the data has
+ * been successfully stored.
+ */
+async function storageWrite(key, value) {
+    const parentApp = sdkLauncherKit.getParentApplication();
+    try {
+        if (parentApp !== null) {
+            await parentAppRequest(parentApp, StorageAction.Write, {
+                key,
+                value,
+            });
+        }
+        else {
+            storage.setItem(key, value);
+        }
+    }
+    catch (err) {
+        const errorMessage = sdkUtil.getErrorMessage(err);
+        console.error(`Unable to write storage item "${key}" with error: ${errorMessage}`);
+        throw sdkUtil.createError(exports.StorageError.WriteError, StorageErrorMessages, errorMessage);
+    }
+}
+/**
+ * The function allows to remove an item from the SDK storage.
+ *
+ * @param key - A name of the item to be removed.
+ *
+ * @throws
+ * The function throws an error if there is a timeout removing the data
+ * from the parent's application storage.
+ *
+ * @returns A promise that resolves to `void` once the data has
+ * been successfully removed.
+ */
+async function storageRemove(key) {
+    const parentApp = sdkLauncherKit.getParentApplication();
+    try {
+        if (parentApp !== null) {
+            await parentAppRequest(parentApp, StorageAction.Remove, { key });
+        }
+        else {
+            storage.removeItem(key);
+        }
+    }
+    catch (err) {
+        const errorMessage = sdkUtil.getErrorMessage(err);
+        console.error(`Unable to remove storage item "${key}" with error: ${errorMessage}`);
+        throw sdkUtil.createError(exports.StorageError.RemoveError, StorageErrorMessages, errorMessage);
+    }
+}
+/**
+ * The function allows to clear all data from the SDK storage.
+ *
+ * @throws
+ * The function throws an error if there is a timeout clearing the parent's
+ * application storage.
+ *
+ * @returns A promise that resolves to `void` once the data has been
+ * successfully cleared.
+ */
+async function storageClear() {
+    const parentApp = sdkLauncherKit.getParentApplication();
+    try {
+        if (parentApp !== null) {
+            await parentAppRequest(parentApp, StorageAction.Clear);
+        }
+        else {
+            storage.clear();
+        }
+    }
+    catch (err) {
+        const errorMessage = sdkUtil.getErrorMessage(err);
+        console.error(`Unable to clear storage with error: ${errorMessage}`);
+        throw sdkUtil.createError(exports.StorageError.ClearError, StorageErrorMessages, errorMessage);
+    }
+}
+sdkLauncherKit.onStateChanged((experience, state) => {
+    if (state === 'mounted') {
+        handleExperienceEmbedded(experience);
+    }
+    else if (state === 'unmounted') {
+        handleExperienceUnmounted(experience);
+    }
+});
+
+exports.handleExperienceEmbedded = handleExperienceEmbedded;
+exports.handleExperienceUnmounted = handleExperienceUnmounted;
+exports.parentAppRequest = parentAppRequest;
+exports.setStoragePersistent = setStoragePersistent;
+exports.storage = storage;
+exports.storageClear = storageClear;
+exports.storageRead = storageRead;
+exports.storageRemove = storageRemove;
+exports.storageWrite = storageWrite;
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sources":["../src/types.ts","../src/storage_impl.ts","../src/api.ts"],"sourcesContent":["/**\n * @license\n * types.ts\n * storage-kit\n *\n * Copyright © 2025 Monterosa Productions Limited. All rights reserved.\n *\n * More details on the license can be found at https://www.monterosa.co/sdk/license\n */\n\n/**\n * Storage bridge action types used internally to communicate with the parent application.\n */\nexport enum StorageAction {\n  /**\n   * Read a value from storage.\n   */\n  Read = 'storageRead',\n  /**\n   * Write a value to storage.\n   */\n  Write = 'storageWrite',\n  /**\n   * Remove a value from storage.\n   */\n  Remove = 'storageRemove',\n  /**\n   * Clear all values from storage.\n   */\n  Clear = 'storageClear',\n}\n\n/**\n * Response payload returned from a storage bridge request.\n */\nexport type ResponsePayload = {\n  /**\n   * The storage key that was operated on.\n   */\n  key: string;\n  /**\n   * The value read from storage, or `null` if not found. Only present for read\n   * operations.\n   */\n  value?: string | null;\n  /**\n   * Error message, if the operation failed.\n   */\n  error?: string;\n};\n\n/**\n * Defines a set of error codes that may be encountered when using the\n * Storage kit of the Monterosa SDK.\n *\n * @example\n * ```javascript\n * try {\n *   // some code that uses the StorageKit\n * } catch (err) {\n *   if (err.code === StorageError.ParentAppError) {\n *     // handle parent app error\n *   } else {\n *     // handle other error types\n *   }\n * }\n * ```\n *\n * @remarks\n * - The `StorageError` enum provides a convenient way to handle errors\n *   encountered when using the `StorageKit` module. By checking the code\n *   property of the caught error against the values of the enum, the error\n *   type can be determined and appropriate action taken.\n *\n * - The `StorageError` enum is not intended to be instantiated or extended.\n */\nexport enum StorageError {\n  /**\n   * Indicates an error occurred in the parent app.\n   */\n  ParentAppError = 'parent_app_error',\n  /**\n   * Indicates a timeout occurred when communicating with the parent app.\n   */\n  ParentTimeoutError = 'parent_timeout_error',\n  /**\n   * Indicates an error occurred when reading from the storage.\n   */\n  ReadError = 'read_error',\n  /**\n   * Indicates an error occurred when writing to the storage.\n   */\n  WriteError = 'write_error',\n  /**\n   * Indicates an error occurred when removing from the storage.\n   */\n  RemoveError = 'remove_error',\n  /**\n   * Indicates an error occurred when clearing the storage.\n   */\n  ClearError = 'clear_error',\n}\n\n/**\n * @internal\n */\nexport const StorageErrorMessages = {\n  [StorageError.ParentAppError]: (error: string) =>\n    `Parent application error: ${error}`,\n  [StorageError.ParentTimeoutError]: (error: string) =>\n    `Parent application timeout: ${error}. Please check if the storage-kit is imported on the parent page.`,\n  [StorageError.ReadError]: (error: string) => `Storage read error: ${error}`,\n  [StorageError.WriteError]: (error: string) => `Storage write error: ${error}`,\n  [StorageError.RemoveError]: (error: string) =>\n    `Storage remove error: ${error}`,\n  [StorageError.ClearError]: (error: string) => `Storage clear error: ${error}`,\n};\n","/**\n * @license\n * storage_impl.ts\n * storage-kit\n *\n * Copyright © 2025 Monterosa Productions Limited. All rights reserved.\n *\n * More details on the license can be found at https://www.monterosa.co/sdk/license\n */\n\nimport {\n  checkAvailability,\n  getItem,\n  setItem,\n  removeItem,\n  clear,\n} from '@monterosa/sdk-util';\n\nexport class StorageImpl {\n  private memoryStore: { [key: string]: string } = {};\n  private accessible: boolean = checkAvailability();\n  private _persistent: boolean = true;\n\n  set persistent(newValue: boolean) {\n    const oldValue = this._persistent;\n\n    if (oldValue === newValue) {\n      return;\n    }\n\n    const swapToStorage = newValue === true && this.accessible;\n    const swapToMemory = newValue === false && this.accessible;\n\n    if (swapToStorage) {\n      for (const [key, value] of Object.entries(this.memoryStore)) {\n        setItem(key, value);\n      }\n    }\n\n    if (swapToMemory) {\n      clear();\n    }\n\n    this._persistent = newValue;\n  }\n\n  get persistent(): boolean {\n    return this._persistent;\n  }\n\n  getItem(key: string): string | null {\n    if (this.persistent && this.accessible) {\n      return getItem(key);\n    }\n\n    if (Object.prototype.hasOwnProperty.call(this.memoryStore, key)) {\n      return this.memoryStore[key];\n    }\n\n    return null;\n  }\n\n  setItem(key: string, value: string): void {\n    if (this.persistent && this.accessible) {\n      setItem(key, value);\n    }\n\n    this.memoryStore[key] = value;\n  }\n\n  removeItem(key: string): void {\n    if (this.persistent && this.accessible) {\n      removeItem(key);\n    }\n\n    delete this.memoryStore[key];\n  }\n\n  clear(): void {\n    if (this.persistent && this.accessible) {\n      clear();\n    }\n\n    this.memoryStore = {};\n  }\n}\n","/**\n * @license\n * api.ts\n * storage-kit\n *\n * Copyright © 2025-2026 Monterosa Productions Limited. All rights reserved.\n *\n * More details on the license can be found at https://www.monterosa.co/sdk/license\n */\n\nimport {\n  MonterosaError,\n  createError,\n  getErrorMessage,\n} from '@monterosa/sdk-util';\nimport {\n  Experience,\n  Payload,\n  ParentApplication,\n  getParentApplication,\n  sendSdkRequest,\n  respondToSdkMessage,\n  onStateChanged,\n  onSdkMessage,\n  BridgeError,\n} from '@monterosa/sdk-launcher-kit';\n\nimport {\n  StorageAction,\n  ResponsePayload,\n  StorageError,\n  StorageErrorMessages,\n} from './types';\nimport { StorageImpl } from './storage_impl';\n\n/**\n * @internal\n */\nexport const storage = new StorageImpl();\n\n/**\n * @internal\n */\nconst unsubs: Map<string, () => void> = new Map();\n\n/**\n * @internal\n */\nexport function handleExperienceEmbedded(experience: Experience) {\n  const unsub = onSdkMessage(experience, (message) => {\n    if (\n      !Object.values(StorageAction).includes(message.action as StorageAction)\n    ) {\n      return;\n    }\n\n    try {\n      let payload: Payload = {};\n\n      switch (message.action) {\n        case StorageAction.Read:\n          payload = {\n            key: message.payload.key,\n            value: storage.getItem(message.payload.key),\n          };\n          break;\n        case StorageAction.Write:\n          payload = {\n            key: message.payload.key,\n          };\n          storage.setItem(message.payload.key, message.payload.value);\n          break;\n        case StorageAction.Remove:\n          payload = {\n            key: message.payload.key,\n          };\n          storage.removeItem(message.payload.key);\n          break;\n        case StorageAction.Clear:\n          storage.clear();\n          break;\n      }\n\n      respondToSdkMessage(experience, message, payload);\n    } catch (err) {\n      const errorMessage = getErrorMessage(err);\n      const key = message.payload?.key;\n      const keyInfo = key ? ` for key \"${key}\"` : '';\n\n      console.error(\n        `Unable to handle storage action ${message.action}${keyInfo} with error: ${errorMessage}`,\n      );\n\n      respondToSdkMessage(experience, message, {\n        key: message.payload.key,\n        error: errorMessage,\n      });\n    }\n  });\n\n  unsubs.set(experience.id, unsub);\n}\n\n/**\n * @internal\n */\nexport function handleExperienceUnmounted(experience: Experience) {\n  const unsub = unsubs.get(experience.id);\n\n  if (unsub) {\n    unsub();\n    unsubs.delete(experience.id);\n  }\n}\n\n/**\n * @internal\n */\nexport async function parentAppRequest(\n  parentApp: ParentApplication,\n  action: StorageAction.Read,\n  payload?: Payload,\n): Promise<string | null>;\n\n/**\n * @internal\n */\nexport async function parentAppRequest(\n  parentApp: ParentApplication,\n  action: StorageAction.Write | StorageAction.Remove | StorageAction.Clear,\n  payload?: Payload,\n): Promise<undefined>;\n\n/**\n * @internal\n */\nexport async function parentAppRequest(\n  parentApp: ParentApplication,\n  action: StorageAction,\n  payload?: Payload,\n): Promise<string | null | undefined> {\n  try {\n    const response = await sendSdkRequest(parentApp, action, payload);\n\n    const { value, error } = response.payload as ResponsePayload;\n\n    if (error !== undefined) {\n      throw createError(\n        StorageError.ParentAppError,\n        StorageErrorMessages,\n        error,\n      );\n    }\n\n    return value;\n  } catch (err) {\n    if (\n      err instanceof MonterosaError &&\n      err.code === BridgeError.RequestTimeoutError\n    ) {\n      const errorMessage = getErrorMessage(err);\n\n      throw createError(\n        StorageError.ParentTimeoutError,\n        StorageErrorMessages,\n        errorMessage,\n      );\n    }\n\n    throw err;\n  }\n}\n\n/**\n * The `setStoragePersistent` function is a simple function that allows to\n * control the persistence of the SDK storage. If the argument `persistent` is\n * set to `true`, then the storage will be persistent across browser sessions\n * and if it is set to `false`, then the storage will save to memory.\n * It is  important to note that the use of persistent storage may be subject\n * to laws and regulations, such as those related to data privacy and protection.\n *\n * @remarks\n * - We transition from persistent to memory and memory to persistent in\n *   a seamless manner for you\n *\n * - By default we store in memory\n *\n * - The value of storage persistent persists across session (aka put it to true,\n *   it will remain so, put it back to false, it will remain so)\n *\n * - You have the responsibility to comply with any laws and regulations, and\n *   store only the data if you know it's valid to do so\n *\n * @param persistent - Determines whether or not SDK storage should persist\n * across browser sessions.\n */\nexport function setStoragePersistent(persistent: boolean): void {\n  storage.persistent = persistent;\n}\n\n/**\n * The function allows to read data from the SDK storage.\n *\n * @param key - The name of the item to be read from storage.\n *\n * @throws\n * The function throws an error if there is a timeout reading the data\n * from the parent application storage.\n *\n * @returns A promise that resolves to the value\n * of the item in storage or `null` if the item doesn't exist.\n */\nexport async function storageRead(key: string): Promise<string | null> {\n  const parentApp = getParentApplication();\n\n  let value: string | null = null;\n\n  try {\n    if (parentApp !== null) {\n      value = await parentAppRequest(parentApp, StorageAction.Read, {\n        key,\n      });\n    } else {\n      value = storage.getItem(key);\n    }\n  } catch (err) {\n    const errorMessage = getErrorMessage(err);\n\n    console.error(\n      `Unable to read storage item \"${key}\" with error: ${errorMessage}`,\n    );\n\n    throw createError(\n      StorageError.ReadError,\n      StorageErrorMessages,\n      errorMessage,\n    );\n  }\n\n  return value;\n}\n\n/**\n * The function allows to write data to the SDK storage.\n *\n * @param key - A name of the item to be stored.\n * @param value - A value to be stored.\n *\n * @throws\n * The function throws an error if there is a timeout writing the data\n * to the parent's application storage.\n *\n * @returns A promise that resolves to `void` once the data has\n * been successfully stored.\n */\nexport async function storageWrite(key: string, value: string): Promise<void> {\n  const parentApp = getParentApplication();\n\n  try {\n    if (parentApp !== null) {\n      await parentAppRequest(parentApp, StorageAction.Write, {\n        key,\n        value,\n      });\n    } else {\n      storage.setItem(key, value);\n    }\n  } catch (err) {\n    const errorMessage = getErrorMessage(err);\n\n    console.error(\n      `Unable to write storage item \"${key}\" with error: ${errorMessage}`,\n    );\n\n    throw createError(\n      StorageError.WriteError,\n      StorageErrorMessages,\n      errorMessage,\n    );\n  }\n}\n\n/**\n * The function allows to remove an item from the SDK storage.\n *\n * @param key - A name of the item to be removed.\n *\n * @throws\n * The function throws an error if there is a timeout removing the data\n * from the parent's application storage.\n *\n * @returns A promise that resolves to `void` once the data has\n * been successfully removed.\n */\nexport async function storageRemove(key: string): Promise<void> {\n  const parentApp = getParentApplication();\n\n  try {\n    if (parentApp !== null) {\n      await parentAppRequest(parentApp, StorageAction.Remove, { key });\n    } else {\n      storage.removeItem(key);\n    }\n  } catch (err) {\n    const errorMessage = getErrorMessage(err);\n\n    console.error(\n      `Unable to remove storage item \"${key}\" with error: ${errorMessage}`,\n    );\n\n    throw createError(\n      StorageError.RemoveError,\n      StorageErrorMessages,\n      errorMessage,\n    );\n  }\n}\n\n/**\n * The function allows to clear all data from the SDK storage.\n *\n * @throws\n * The function throws an error if there is a timeout clearing the parent's\n * application storage.\n *\n * @returns A promise that resolves to `void` once the data has been\n * successfully cleared.\n */\nexport async function storageClear(): Promise<void> {\n  const parentApp = getParentApplication();\n\n  try {\n    if (parentApp !== null) {\n      await parentAppRequest(parentApp, StorageAction.Clear);\n    } else {\n      storage.clear();\n    }\n  } catch (err) {\n    const errorMessage = getErrorMessage(err);\n\n    console.error(`Unable to clear storage with error: ${errorMessage}`);\n\n    throw createError(\n      StorageError.ClearError,\n      StorageErrorMessages,\n      errorMessage,\n    );\n  }\n}\n\nonStateChanged((experience, state) => {\n  if (state === 'mounted') {\n    handleExperienceEmbedded(experience);\n  } else if (state === 'unmounted') {\n    handleExperienceUnmounted(experience);\n  }\n});\n"],"names":["StorageError","checkAvailability","setItem","clear","getItem","removeItem","onSdkMessage","respondToSdkMessage","getErrorMessage","sendSdkRequest","createError","MonterosaError","BridgeError","getParentApplication","onStateChanged"],"mappings":";;;;;;;AAAA;;;;;;;;AAQG;AAEH;;AAEG;AACH,IAAY,aAiBX,CAAA;AAjBD,CAAA,UAAY,aAAa,EAAA;AACvB;;AAEG;AACH,IAAA,aAAA,CAAA,MAAA,CAAA,GAAA,aAAoB,CAAA;AACpB;;AAEG;AACH,IAAA,aAAA,CAAA,OAAA,CAAA,GAAA,cAAsB,CAAA;AACtB;;AAEG;AACH,IAAA,aAAA,CAAA,QAAA,CAAA,GAAA,eAAwB,CAAA;AACxB;;AAEG;AACH,IAAA,aAAA,CAAA,OAAA,CAAA,GAAA,cAAsB,CAAA;AACxB,CAAC,EAjBW,aAAa,KAAb,aAAa,GAiBxB,EAAA,CAAA,CAAA,CAAA;AAqBD;;;;;;;;;;;;;;;;;;;;;;;;AAwBG;AACSA,8BAyBX;AAzBD,CAAA,UAAY,YAAY,EAAA;AACtB;;AAEG;AACH,IAAA,YAAA,CAAA,gBAAA,CAAA,GAAA,kBAAmC,CAAA;AACnC;;AAEG;AACH,IAAA,YAAA,CAAA,oBAAA,CAAA,GAAA,sBAA2C,CAAA;AAC3C;;AAEG;AACH,IAAA,YAAA,CAAA,WAAA,CAAA,GAAA,YAAwB,CAAA;AACxB;;AAEG;AACH,IAAA,YAAA,CAAA,YAAA,CAAA,GAAA,aAA0B,CAAA;AAC1B;;AAEG;AACH,IAAA,YAAA,CAAA,aAAA,CAAA,GAAA,cAA4B,CAAA;AAC5B;;AAEG;AACH,IAAA,YAAA,CAAA,YAAA,CAAA,GAAA,aAA0B,CAAA;AAC5B,CAAC,EAzBWA,oBAAY,KAAZA,oBAAY,GAyBvB,EAAA,CAAA,CAAA,CAAA;AAED;;AAEG;AACI,MAAM,oBAAoB,GAAG;AAClC,IAAA,CAACA,oBAAY,CAAC,cAAc,GAAG,CAAC,KAAa,KAC3C,CAA6B,0BAAA,EAAA,KAAK,CAAE,CAAA;AACtC,IAAA,CAACA,oBAAY,CAAC,kBAAkB,GAAG,CAAC,KAAa,KAC/C,CAA+B,4BAAA,EAAA,KAAK,CAAmE,iEAAA,CAAA;AACzG,IAAA,CAACA,oBAAY,CAAC,SAAS,GAAG,CAAC,KAAa,KAAK,CAAuB,oBAAA,EAAA,KAAK,CAAE,CAAA;AAC3E,IAAA,CAACA,oBAAY,CAAC,UAAU,GAAG,CAAC,KAAa,KAAK,CAAwB,qBAAA,EAAA,KAAK,CAAE,CAAA;AAC7E,IAAA,CAACA,oBAAY,CAAC,WAAW,GAAG,CAAC,KAAa,KACxC,CAAyB,sBAAA,EAAA,KAAK,CAAE,CAAA;AAClC,IAAA,CAACA,oBAAY,CAAC,UAAU,GAAG,CAAC,KAAa,KAAK,CAAwB,qBAAA,EAAA,KAAK,CAAE,CAAA;CAC9E;;ACpHD;;;;;;;;AAQG;MAUU,WAAW,CAAA;AAAxB,IAAA,WAAA,GAAA;QACU,IAAW,CAAA,WAAA,GAA8B,EAAE,CAAC;QAC5C,IAAU,CAAA,UAAA,GAAYC,yBAAiB,EAAE,CAAC;QAC1C,IAAW,CAAA,WAAA,GAAY,IAAI,CAAC;KAgErC;IA9DC,IAAI,UAAU,CAAC,QAAiB,EAAA;AAC9B,QAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC;QAElC,IAAI,QAAQ,KAAK,QAAQ,EAAE;YACzB,OAAO;AACR,SAAA;QAED,MAAM,aAAa,GAAG,QAAQ,KAAK,IAAI,IAAI,IAAI,CAAC,UAAU,CAAC;QAC3D,MAAM,YAAY,GAAG,QAAQ,KAAK,KAAK,IAAI,IAAI,CAAC,UAAU,CAAC;AAE3D,QAAA,IAAI,aAAa,EAAE;AACjB,YAAA,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;AAC3D,gBAAAC,eAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AACrB,aAAA;AACF,SAAA;AAED,QAAA,IAAI,YAAY,EAAE;AAChB,YAAAC,aAAK,EAAE,CAAC;AACT,SAAA;AAED,QAAA,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAC;KAC7B;AAED,IAAA,IAAI,UAAU,GAAA;QACZ,OAAO,IAAI,CAAC,WAAW,CAAC;KACzB;AAED,IAAA,OAAO,CAAC,GAAW,EAAA;AACjB,QAAA,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,EAAE;AACtC,YAAA,OAAOC,eAAO,CAAC,GAAG,CAAC,CAAC;AACrB,SAAA;AAED,QAAA,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,CAAC,EAAE;AAC/D,YAAA,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;AAC9B,SAAA;AAED,QAAA,OAAO,IAAI,CAAC;KACb;IAED,OAAO,CAAC,GAAW,EAAE,KAAa,EAAA;AAChC,QAAA,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,EAAE;AACtC,YAAAF,eAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AACrB,SAAA;AAED,QAAA,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;KAC/B;AAED,IAAA,UAAU,CAAC,GAAW,EAAA;AACpB,QAAA,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,EAAE;YACtCG,kBAAU,CAAC,GAAG,CAAC,CAAC;AACjB,SAAA;AAED,QAAA,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;KAC9B;IAED,KAAK,GAAA;AACH,QAAA,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,EAAE;AACtC,YAAAF,aAAK,EAAE,CAAC;AACT,SAAA;AAED,QAAA,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;KACvB;AACF;;ACrFD;;;;;;;;AAQG;AA2BH;;AAEG;AACU,MAAA,OAAO,GAAG,IAAI,WAAW,GAAG;AAEzC;;AAEG;AACH,MAAM,MAAM,GAA4B,IAAI,GAAG,EAAE,CAAC;AAElD;;AAEG;AACG,SAAU,wBAAwB,CAAC,UAAsB,EAAA;IAC7D,MAAM,KAAK,GAAGG,2BAAY,CAAC,UAAU,EAAE,CAAC,OAAO,KAAI;;AACjD,QAAA,IACE,CAAC,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAuB,CAAC,EACvE;YACA,OAAO;AACR,SAAA;QAED,IAAI;YACF,IAAI,OAAO,GAAY,EAAE,CAAC;YAE1B,QAAQ,OAAO,CAAC,MAAM;gBACpB,KAAK,aAAa,CAAC,IAAI;AACrB,oBAAA,OAAO,GAAG;AACR,wBAAA,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG;wBACxB,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC;qBAC5C,CAAC;oBACF,MAAM;gBACR,KAAK,aAAa,CAAC,KAAK;AACtB,oBAAA,OAAO,GAAG;AACR,wBAAA,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG;qBACzB,CAAC;AACF,oBAAA,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;oBAC5D,MAAM;gBACR,KAAK,aAAa,CAAC,MAAM;AACvB,oBAAA,OAAO,GAAG;AACR,wBAAA,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG;qBACzB,CAAC;oBACF,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;oBACxC,MAAM;gBACR,KAAK,aAAa,CAAC,KAAK;oBACtB,OAAO,CAAC,KAAK,EAAE,CAAC;oBAChB,MAAM;AACT,aAAA;AAED,YAAAC,kCAAmB,CAAC,UAAU,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;AACnD,SAAA;AAAC,QAAA,OAAO,GAAG,EAAE;AACZ,YAAA,MAAM,YAAY,GAAGC,uBAAe,CAAC,GAAG,CAAC,CAAC;YAC1C,MAAM,GAAG,GAAG,CAAA,EAAA,GAAA,OAAO,CAAC,OAAO,MAAA,IAAA,IAAA,EAAA,KAAA,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAE,GAAG,CAAC;AACjC,YAAA,MAAM,OAAO,GAAG,GAAG,GAAG,CAAa,UAAA,EAAA,GAAG,CAAG,CAAA,CAAA,GAAG,EAAE,CAAC;AAE/C,YAAA,OAAO,CAAC,KAAK,CACX,CAAA,gCAAA,EAAmC,OAAO,CAAC,MAAM,CAAA,EAAG,OAAO,CAAA,aAAA,EAAgB,YAAY,CAAA,CAAE,CAC1F,CAAC;AAEF,YAAAD,kCAAmB,CAAC,UAAU,EAAE,OAAO,EAAE;AACvC,gBAAA,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG;AACxB,gBAAA,KAAK,EAAE,YAAY;AACpB,aAAA,CAAC,CAAC;AACJ,SAAA;AACH,KAAC,CAAC,CAAC;IAEH,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;AACnC,CAAC;AAED;;AAEG;AACG,SAAU,yBAAyB,CAAC,UAAsB,EAAA;IAC9D,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;AAExC,IAAA,IAAI,KAAK,EAAE;AACT,QAAA,KAAK,EAAE,CAAC;AACR,QAAA,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;AAC9B,KAAA;AACH,CAAC;AAoBD;;AAEG;AACI,eAAe,gBAAgB,CACpC,SAA4B,EAC5B,MAAqB,EACrB,OAAiB,EAAA;IAEjB,IAAI;QACF,MAAM,QAAQ,GAAG,MAAME,6BAAc,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAElE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,QAAQ,CAAC,OAA0B,CAAC;QAE7D,IAAI,KAAK,KAAK,SAAS,EAAE;YACvB,MAAMC,mBAAW,CACfV,oBAAY,CAAC,cAAc,EAC3B,oBAAoB,EACpB,KAAK,CACN,CAAC;AACH,SAAA;AAED,QAAA,OAAO,KAAK,CAAC;AACd,KAAA;AAAC,IAAA,OAAO,GAAG,EAAE;QACZ,IACE,GAAG,YAAYW,sBAAc;AAC7B,YAAA,GAAG,CAAC,IAAI,KAAKC,0BAAW,CAAC,mBAAmB,EAC5C;AACA,YAAA,MAAM,YAAY,GAAGJ,uBAAe,CAAC,GAAG,CAAC,CAAC;YAE1C,MAAME,mBAAW,CACfV,oBAAY,CAAC,kBAAkB,EAC/B,oBAAoB,EACpB,YAAY,CACb,CAAC;AACH,SAAA;AAED,QAAA,MAAM,GAAG,CAAC;AACX,KAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;AAsBG;AACG,SAAU,oBAAoB,CAAC,UAAmB,EAAA;AACtD,IAAA,OAAO,CAAC,UAAU,GAAG,UAAU,CAAC;AAClC,CAAC;AAED;;;;;;;;;;;AAWG;AACI,eAAe,WAAW,CAAC,GAAW,EAAA;AAC3C,IAAA,MAAM,SAAS,GAAGa,mCAAoB,EAAE,CAAC;IAEzC,IAAI,KAAK,GAAkB,IAAI,CAAC;IAEhC,IAAI;QACF,IAAI,SAAS,KAAK,IAAI,EAAE;YACtB,KAAK,GAAG,MAAM,gBAAgB,CAAC,SAAS,EAAE,aAAa,CAAC,IAAI,EAAE;gBAC5D,GAAG;AACJ,aAAA,CAAC,CAAC;AACJ,SAAA;AAAM,aAAA;AACL,YAAA,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;AAC9B,SAAA;AACF,KAAA;AAAC,IAAA,OAAO,GAAG,EAAE;AACZ,QAAA,MAAM,YAAY,GAAGL,uBAAe,CAAC,GAAG,CAAC,CAAC;QAE1C,OAAO,CAAC,KAAK,CACX,CAAA,6BAAA,EAAgC,GAAG,CAAiB,cAAA,EAAA,YAAY,CAAE,CAAA,CACnE,CAAC;QAEF,MAAME,mBAAW,CACfV,oBAAY,CAAC,SAAS,EACtB,oBAAoB,EACpB,YAAY,CACb,CAAC;AACH,KAAA;AAED,IAAA,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;;;;;AAYG;AACI,eAAe,YAAY,CAAC,GAAW,EAAE,KAAa,EAAA;AAC3D,IAAA,MAAM,SAAS,GAAGa,mCAAoB,EAAE,CAAC;IAEzC,IAAI;QACF,IAAI,SAAS,KAAK,IAAI,EAAE;AACtB,YAAA,MAAM,gBAAgB,CAAC,SAAS,EAAE,aAAa,CAAC,KAAK,EAAE;gBACrD,GAAG;gBACH,KAAK;AACN,aAAA,CAAC,CAAC;AACJ,SAAA;AAAM,aAAA;AACL,YAAA,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AAC7B,SAAA;AACF,KAAA;AAAC,IAAA,OAAO,GAAG,EAAE;AACZ,QAAA,MAAM,YAAY,GAAGL,uBAAe,CAAC,GAAG,CAAC,CAAC;QAE1C,OAAO,CAAC,KAAK,CACX,CAAA,8BAAA,EAAiC,GAAG,CAAiB,cAAA,EAAA,YAAY,CAAE,CAAA,CACpE,CAAC;QAEF,MAAME,mBAAW,CACfV,oBAAY,CAAC,UAAU,EACvB,oBAAoB,EACpB,YAAY,CACb,CAAC;AACH,KAAA;AACH,CAAC;AAED;;;;;;;;;;;AAWG;AACI,eAAe,aAAa,CAAC,GAAW,EAAA;AAC7C,IAAA,MAAM,SAAS,GAAGa,mCAAoB,EAAE,CAAC;IAEzC,IAAI;QACF,IAAI,SAAS,KAAK,IAAI,EAAE;AACtB,YAAA,MAAM,gBAAgB,CAAC,SAAS,EAAE,aAAa,CAAC,MAAM,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;AAClE,SAAA;AAAM,aAAA;AACL,YAAA,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;AACzB,SAAA;AACF,KAAA;AAAC,IAAA,OAAO,GAAG,EAAE;AACZ,QAAA,MAAM,YAAY,GAAGL,uBAAe,CAAC,GAAG,CAAC,CAAC;QAE1C,OAAO,CAAC,KAAK,CACX,CAAA,+BAAA,EAAkC,GAAG,CAAiB,cAAA,EAAA,YAAY,CAAE,CAAA,CACrE,CAAC;QAEF,MAAME,mBAAW,CACfV,oBAAY,CAAC,WAAW,EACxB,oBAAoB,EACpB,YAAY,CACb,CAAC;AACH,KAAA;AACH,CAAC;AAED;;;;;;;;;AASG;AACI,eAAe,YAAY,GAAA;AAChC,IAAA,MAAM,SAAS,GAAGa,mCAAoB,EAAE,CAAC;IAEzC,IAAI;QACF,IAAI,SAAS,KAAK,IAAI,EAAE;YACtB,MAAM,gBAAgB,CAAC,SAAS,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC;AACxD,SAAA;AAAM,aAAA;YACL,OAAO,CAAC,KAAK,EAAE,CAAC;AACjB,SAAA;AACF,KAAA;AAAC,IAAA,OAAO,GAAG,EAAE;AACZ,QAAA,MAAM,YAAY,GAAGL,uBAAe,CAAC,GAAG,CAAC,CAAC;AAE1C,QAAA,OAAO,CAAC,KAAK,CAAC,uCAAuC,YAAY,CAAA,CAAE,CAAC,CAAC;QAErE,MAAME,mBAAW,CACfV,oBAAY,CAAC,UAAU,EACvB,oBAAoB,EACpB,YAAY,CACb,CAAC;AACH,KAAA;AACH,CAAC;AAEDc,6BAAc,CAAC,CAAC,UAAU,EAAE,KAAK,KAAI;IACnC,IAAI,KAAK,KAAK,SAAS,EAAE;QACvB,wBAAwB,CAAC,UAAU,CAAC,CAAC;AACtC,KAAA;SAAM,IAAI,KAAK,KAAK,WAAW,EAAE;QAChC,yBAAyB,CAAC,UAAU,CAAC,CAAC;AACvC,KAAA;AACH,CAAC,CAAC;;;;;;;;;;;;"}

package/dist/index.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Persists key-value data across sessions via the parent application.
+ *
+ * @packageDocumentation
+ */
 /**
  * @license
  * index.ts
@@ -7,10 +12,5 @@
  *
  * More details on the license can be found at https://www.monterosa.co/sdk/license
  */
-/**
- * Monterosa SDK / Storage Kit
- *
- * @packageDocumentation
- */
 export * from './api';
 export { StorageError } from './types';

package/dist/{index.esm.js → index.js}

@@ -10,11 +10,26 @@ import { onStateChanged, onSdkMessage, respondToSdkMessage, sendSdkRequest, Brid
  *
  * More details on the license can be found at https://www.monterosa.co/sdk/license
  */
+/**
+ * Storage bridge action types used internally to communicate with the parent application.
+ */
 var StorageAction;
 (function (StorageAction) {
+    /**
+     * Read a value from storage.
+     */
     StorageAction["Read"] = "storageRead";
+    /**
+     * Write a value to storage.
+     */
     StorageAction["Write"] = "storageWrite";
+    /**
+     * Remove a value from storage.
+     */
     StorageAction["Remove"] = "storageRemove";
+    /**
+     * Clear all values from storage.
+     */
     StorageAction["Clear"] = "storageClear";
 })(StorageAction || (StorageAction = {}));
 /**
@@ -26,7 +41,7 @@ var StorageAction;
  * try {
  *   // some code that uses the StorageKit
  * } catch (err) {
- *   if (err.code === StorageError.ParentApp) {
+ *   if (err.code === StorageError.ParentAppError) {
  *     // handle parent app error
  *   } else {
  *     // handle other error types
@@ -221,6 +236,9 @@ function handleExperienceUnmounted(experience) {
         unsubs.delete(experience.id);
     }
 }
+/**
+ * @internal
+ */
 async function parentAppRequest(parentApp, action, payload) {
     try {
         const response = await sendSdkRequest(parentApp, action, payload);
@@ -393,4 +411,4 @@ onStateChanged((experience, state) => {
 });
 
 export { StorageError, handleExperienceEmbedded, handleExperienceUnmounted, parentAppRequest, setStoragePersistent, storage, storageClear, storageRead, storageRemove, storageWrite };
-//# sourceMappingURL=index.esm.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/types.ts","../src/storage_impl.ts","../src/api.ts"],"sourcesContent":["/**\n * @license\n * types.ts\n * storage-kit\n *\n * Copyright © 2025 Monterosa Productions Limited. All rights reserved.\n *\n * More details on the license can be found at https://www.monterosa.co/sdk/license\n */\n\n/**\n * Storage bridge action types used internally to communicate with the parent application.\n */\nexport enum StorageAction {\n  /**\n   * Read a value from storage.\n   */\n  Read = 'storageRead',\n  /**\n   * Write a value to storage.\n   */\n  Write = 'storageWrite',\n  /**\n   * Remove a value from storage.\n   */\n  Remove = 'storageRemove',\n  /**\n   * Clear all values from storage.\n   */\n  Clear = 'storageClear',\n}\n\n/**\n * Response payload returned from a storage bridge request.\n */\nexport type ResponsePayload = {\n  /**\n   * The storage key that was operated on.\n   */\n  key: string;\n  /**\n   * The value read from storage, or `null` if not found. Only present for read\n   * operations.\n   */\n  value?: string | null;\n  /**\n   * Error message, if the operation failed.\n   */\n  error?: string;\n};\n\n/**\n * Defines a set of error codes that may be encountered when using the\n * Storage kit of the Monterosa SDK.\n *\n * @example\n * ```javascript\n * try {\n *   // some code that uses the StorageKit\n * } catch (err) {\n *   if (err.code === StorageError.ParentAppError) {\n *     // handle parent app error\n *   } else {\n *     // handle other error types\n *   }\n * }\n * ```\n *\n * @remarks\n * - The `StorageError` enum provides a convenient way to handle errors\n *   encountered when using the `StorageKit` module. By checking the code\n *   property of the caught error against the values of the enum, the error\n *   type can be determined and appropriate action taken.\n *\n * - The `StorageError` enum is not intended to be instantiated or extended.\n */\nexport enum StorageError {\n  /**\n   * Indicates an error occurred in the parent app.\n   */\n  ParentAppError = 'parent_app_error',\n  /**\n   * Indicates a timeout occurred when communicating with the parent app.\n   */\n  ParentTimeoutError = 'parent_timeout_error',\n  /**\n   * Indicates an error occurred when reading from the storage.\n   */\n  ReadError = 'read_error',\n  /**\n   * Indicates an error occurred when writing to the storage.\n   */\n  WriteError = 'write_error',\n  /**\n   * Indicates an error occurred when removing from the storage.\n   */\n  RemoveError = 'remove_error',\n  /**\n   * Indicates an error occurred when clearing the storage.\n   */\n  ClearError = 'clear_error',\n}\n\n/**\n * @internal\n */\nexport const StorageErrorMessages = {\n  [StorageError.ParentAppError]: (error: string) =>\n    `Parent application error: ${error}`,\n  [StorageError.ParentTimeoutError]: (error: string) =>\n    `Parent application timeout: ${error}. Please check if the storage-kit is imported on the parent page.`,\n  [StorageError.ReadError]: (error: string) => `Storage read error: ${error}`,\n  [StorageError.WriteError]: (error: string) => `Storage write error: ${error}`,\n  [StorageError.RemoveError]: (error: string) =>\n    `Storage remove error: ${error}`,\n  [StorageError.ClearError]: (error: string) => `Storage clear error: ${error}`,\n};\n","/**\n * @license\n * storage_impl.ts\n * storage-kit\n *\n * Copyright © 2025 Monterosa Productions Limited. All rights reserved.\n *\n * More details on the license can be found at https://www.monterosa.co/sdk/license\n */\n\nimport {\n  checkAvailability,\n  getItem,\n  setItem,\n  removeItem,\n  clear,\n} from '@monterosa/sdk-util';\n\nexport class StorageImpl {\n  private memoryStore: { [key: string]: string } = {};\n  private accessible: boolean = checkAvailability();\n  private _persistent: boolean = true;\n\n  set persistent(newValue: boolean) {\n    const oldValue = this._persistent;\n\n    if (oldValue === newValue) {\n      return;\n    }\n\n    const swapToStorage = newValue === true && this.accessible;\n    const swapToMemory = newValue === false && this.accessible;\n\n    if (swapToStorage) {\n      for (const [key, value] of Object.entries(this.memoryStore)) {\n        setItem(key, value);\n      }\n    }\n\n    if (swapToMemory) {\n      clear();\n    }\n\n    this._persistent = newValue;\n  }\n\n  get persistent(): boolean {\n    return this._persistent;\n  }\n\n  getItem(key: string): string | null {\n    if (this.persistent && this.accessible) {\n      return getItem(key);\n    }\n\n    if (Object.prototype.hasOwnProperty.call(this.memoryStore, key)) {\n      return this.memoryStore[key];\n    }\n\n    return null;\n  }\n\n  setItem(key: string, value: string): void {\n    if (this.persistent && this.accessible) {\n      setItem(key, value);\n    }\n\n    this.memoryStore[key] = value;\n  }\n\n  removeItem(key: string): void {\n    if (this.persistent && this.accessible) {\n      removeItem(key);\n    }\n\n    delete this.memoryStore[key];\n  }\n\n  clear(): void {\n    if (this.persistent && this.accessible) {\n      clear();\n    }\n\n    this.memoryStore = {};\n  }\n}\n","/**\n * @license\n * api.ts\n * storage-kit\n *\n * Copyright © 2025-2026 Monterosa Productions Limited. All rights reserved.\n *\n * More details on the license can be found at https://www.monterosa.co/sdk/license\n */\n\nimport {\n  MonterosaError,\n  createError,\n  getErrorMessage,\n} from '@monterosa/sdk-util';\nimport {\n  Experience,\n  Payload,\n  ParentApplication,\n  getParentApplication,\n  sendSdkRequest,\n  respondToSdkMessage,\n  onStateChanged,\n  onSdkMessage,\n  BridgeError,\n} from '@monterosa/sdk-launcher-kit';\n\nimport {\n  StorageAction,\n  ResponsePayload,\n  StorageError,\n  StorageErrorMessages,\n} from './types';\nimport { StorageImpl } from './storage_impl';\n\n/**\n * @internal\n */\nexport const storage = new StorageImpl();\n\n/**\n * @internal\n */\nconst unsubs: Map<string, () => void> = new Map();\n\n/**\n * @internal\n */\nexport function handleExperienceEmbedded(experience: Experience) {\n  const unsub = onSdkMessage(experience, (message) => {\n    if (\n      !Object.values(StorageAction).includes(message.action as StorageAction)\n    ) {\n      return;\n    }\n\n    try {\n      let payload: Payload = {};\n\n      switch (message.action) {\n        case StorageAction.Read:\n          payload = {\n            key: message.payload.key,\n            value: storage.getItem(message.payload.key),\n          };\n          break;\n        case StorageAction.Write:\n          payload = {\n            key: message.payload.key,\n          };\n          storage.setItem(message.payload.key, message.payload.value);\n          break;\n        case StorageAction.Remove:\n          payload = {\n            key: message.payload.key,\n          };\n          storage.removeItem(message.payload.key);\n          break;\n        case StorageAction.Clear:\n          storage.clear();\n          break;\n      }\n\n      respondToSdkMessage(experience, message, payload);\n    } catch (err) {\n      const errorMessage = getErrorMessage(err);\n      const key = message.payload?.key;\n      const keyInfo = key ? ` for key \"${key}\"` : '';\n\n      console.error(\n        `Unable to handle storage action ${message.action}${keyInfo} with error: ${errorMessage}`,\n      );\n\n      respondToSdkMessage(experience, message, {\n        key: message.payload.key,\n        error: errorMessage,\n      });\n    }\n  });\n\n  unsubs.set(experience.id, unsub);\n}\n\n/**\n * @internal\n */\nexport function handleExperienceUnmounted(experience: Experience) {\n  const unsub = unsubs.get(experience.id);\n\n  if (unsub) {\n    unsub();\n    unsubs.delete(experience.id);\n  }\n}\n\n/**\n * @internal\n */\nexport async function parentAppRequest(\n  parentApp: ParentApplication,\n  action: StorageAction.Read,\n  payload?: Payload,\n): Promise<string | null>;\n\n/**\n * @internal\n */\nexport async function parentAppRequest(\n  parentApp: ParentApplication,\n  action: StorageAction.Write | StorageAction.Remove | StorageAction.Clear,\n  payload?: Payload,\n): Promise<undefined>;\n\n/**\n * @internal\n */\nexport async function parentAppRequest(\n  parentApp: ParentApplication,\n  action: StorageAction,\n  payload?: Payload,\n): Promise<string | null | undefined> {\n  try {\n    const response = await sendSdkRequest(parentApp, action, payload);\n\n    const { value, error } = response.payload as ResponsePayload;\n\n    if (error !== undefined) {\n      throw createError(\n        StorageError.ParentAppError,\n        StorageErrorMessages,\n        error,\n      );\n    }\n\n    return value;\n  } catch (err) {\n    if (\n      err instanceof MonterosaError &&\n      err.code === BridgeError.RequestTimeoutError\n    ) {\n      const errorMessage = getErrorMessage(err);\n\n      throw createError(\n        StorageError.ParentTimeoutError,\n        StorageErrorMessages,\n        errorMessage,\n      );\n    }\n\n    throw err;\n  }\n}\n\n/**\n * The `setStoragePersistent` function is a simple function that allows to\n * control the persistence of the SDK storage. If the argument `persistent` is\n * set to `true`, then the storage will be persistent across browser sessions\n * and if it is set to `false`, then the storage will save to memory.\n * It is  important to note that the use of persistent storage may be subject\n * to laws and regulations, such as those related to data privacy and protection.\n *\n * @remarks\n * - We transition from persistent to memory and memory to persistent in\n *   a seamless manner for you\n *\n * - By default we store in memory\n *\n * - The value of storage persistent persists across session (aka put it to true,\n *   it will remain so, put it back to false, it will remain so)\n *\n * - You have the responsibility to comply with any laws and regulations, and\n *   store only the data if you know it's valid to do so\n *\n * @param persistent - Determines whether or not SDK storage should persist\n * across browser sessions.\n */\nexport function setStoragePersistent(persistent: boolean): void {\n  storage.persistent = persistent;\n}\n\n/**\n * The function allows to read data from the SDK storage.\n *\n * @param key - The name of the item to be read from storage.\n *\n * @throws\n * The function throws an error if there is a timeout reading the data\n * from the parent application storage.\n *\n * @returns A promise that resolves to the value\n * of the item in storage or `null` if the item doesn't exist.\n */\nexport async function storageRead(key: string): Promise<string | null> {\n  const parentApp = getParentApplication();\n\n  let value: string | null = null;\n\n  try {\n    if (parentApp !== null) {\n      value = await parentAppRequest(parentApp, StorageAction.Read, {\n        key,\n      });\n    } else {\n      value = storage.getItem(key);\n    }\n  } catch (err) {\n    const errorMessage = getErrorMessage(err);\n\n    console.error(\n      `Unable to read storage item \"${key}\" with error: ${errorMessage}`,\n    );\n\n    throw createError(\n      StorageError.ReadError,\n      StorageErrorMessages,\n      errorMessage,\n    );\n  }\n\n  return value;\n}\n\n/**\n * The function allows to write data to the SDK storage.\n *\n * @param key - A name of the item to be stored.\n * @param value - A value to be stored.\n *\n * @throws\n * The function throws an error if there is a timeout writing the data\n * to the parent's application storage.\n *\n * @returns A promise that resolves to `void` once the data has\n * been successfully stored.\n */\nexport async function storageWrite(key: string, value: string): Promise<void> {\n  const parentApp = getParentApplication();\n\n  try {\n    if (parentApp !== null) {\n      await parentAppRequest(parentApp, StorageAction.Write, {\n        key,\n        value,\n      });\n    } else {\n      storage.setItem(key, value);\n    }\n  } catch (err) {\n    const errorMessage = getErrorMessage(err);\n\n    console.error(\n      `Unable to write storage item \"${key}\" with error: ${errorMessage}`,\n    );\n\n    throw createError(\n      StorageError.WriteError,\n      StorageErrorMessages,\n      errorMessage,\n    );\n  }\n}\n\n/**\n * The function allows to remove an item from the SDK storage.\n *\n * @param key - A name of the item to be removed.\n *\n * @throws\n * The function throws an error if there is a timeout removing the data\n * from the parent's application storage.\n *\n * @returns A promise that resolves to `void` once the data has\n * been successfully removed.\n */\nexport async function storageRemove(key: string): Promise<void> {\n  const parentApp = getParentApplication();\n\n  try {\n    if (parentApp !== null) {\n      await parentAppRequest(parentApp, StorageAction.Remove, { key });\n    } else {\n      storage.removeItem(key);\n    }\n  } catch (err) {\n    const errorMessage = getErrorMessage(err);\n\n    console.error(\n      `Unable to remove storage item \"${key}\" with error: ${errorMessage}`,\n    );\n\n    throw createError(\n      StorageError.RemoveError,\n      StorageErrorMessages,\n      errorMessage,\n    );\n  }\n}\n\n/**\n * The function allows to clear all data from the SDK storage.\n *\n * @throws\n * The function throws an error if there is a timeout clearing the parent's\n * application storage.\n *\n * @returns A promise that resolves to `void` once the data has been\n * successfully cleared.\n */\nexport async function storageClear(): Promise<void> {\n  const parentApp = getParentApplication();\n\n  try {\n    if (parentApp !== null) {\n      await parentAppRequest(parentApp, StorageAction.Clear);\n    } else {\n      storage.clear();\n    }\n  } catch (err) {\n    const errorMessage = getErrorMessage(err);\n\n    console.error(`Unable to clear storage with error: ${errorMessage}`);\n\n    throw createError(\n      StorageError.ClearError,\n      StorageErrorMessages,\n      errorMessage,\n    );\n  }\n}\n\nonStateChanged((experience, state) => {\n  if (state === 'mounted') {\n    handleExperienceEmbedded(experience);\n  } else if (state === 'unmounted') {\n    handleExperienceUnmounted(experience);\n  }\n});\n"],"names":[],"mappings":";;;AAAA;;;;;;;;AAQG;AAEH;;AAEG;AACH,IAAY,aAiBX,CAAA;AAjBD,CAAA,UAAY,aAAa,EAAA;AACvB;;AAEG;AACH,IAAA,aAAA,CAAA,MAAA,CAAA,GAAA,aAAoB,CAAA;AACpB;;AAEG;AACH,IAAA,aAAA,CAAA,OAAA,CAAA,GAAA,cAAsB,CAAA;AACtB;;AAEG;AACH,IAAA,aAAA,CAAA,QAAA,CAAA,GAAA,eAAwB,CAAA;AACxB;;AAEG;AACH,IAAA,aAAA,CAAA,OAAA,CAAA,GAAA,cAAsB,CAAA;AACxB,CAAC,EAjBW,aAAa,KAAb,aAAa,GAiBxB,EAAA,CAAA,CAAA,CAAA;AAqBD;;;;;;;;;;;;;;;;;;;;;;;;AAwBG;IACS,aAyBX;AAzBD,CAAA,UAAY,YAAY,EAAA;AACtB;;AAEG;AACH,IAAA,YAAA,CAAA,gBAAA,CAAA,GAAA,kBAAmC,CAAA;AACnC;;AAEG;AACH,IAAA,YAAA,CAAA,oBAAA,CAAA,GAAA,sBAA2C,CAAA;AAC3C;;AAEG;AACH,IAAA,YAAA,CAAA,WAAA,CAAA,GAAA,YAAwB,CAAA;AACxB;;AAEG;AACH,IAAA,YAAA,CAAA,YAAA,CAAA,GAAA,aAA0B,CAAA;AAC1B;;AAEG;AACH,IAAA,YAAA,CAAA,aAAA,CAAA,GAAA,cAA4B,CAAA;AAC5B;;AAEG;AACH,IAAA,YAAA,CAAA,YAAA,CAAA,GAAA,aAA0B,CAAA;AAC5B,CAAC,EAzBW,YAAY,KAAZ,YAAY,GAyBvB,EAAA,CAAA,CAAA,CAAA;AAED;;AAEG;AACI,MAAM,oBAAoB,GAAG;AAClC,IAAA,CAAC,YAAY,CAAC,cAAc,GAAG,CAAC,KAAa,KAC3C,CAA6B,0BAAA,EAAA,KAAK,CAAE,CAAA;AACtC,IAAA,CAAC,YAAY,CAAC,kBAAkB,GAAG,CAAC,KAAa,KAC/C,CAA+B,4BAAA,EAAA,KAAK,CAAmE,iEAAA,CAAA;AACzG,IAAA,CAAC,YAAY,CAAC,SAAS,GAAG,CAAC,KAAa,KAAK,CAAuB,oBAAA,EAAA,KAAK,CAAE,CAAA;AAC3E,IAAA,CAAC,YAAY,CAAC,UAAU,GAAG,CAAC,KAAa,KAAK,CAAwB,qBAAA,EAAA,KAAK,CAAE,CAAA;AAC7E,IAAA,CAAC,YAAY,CAAC,WAAW,GAAG,CAAC,KAAa,KACxC,CAAyB,sBAAA,EAAA,KAAK,CAAE,CAAA;AAClC,IAAA,CAAC,YAAY,CAAC,UAAU,GAAG,CAAC,KAAa,KAAK,CAAwB,qBAAA,EAAA,KAAK,CAAE,CAAA;CAC9E;;ACpHD;;;;;;;;AAQG;MAUU,WAAW,CAAA;AAAxB,IAAA,WAAA,GAAA;QACU,IAAW,CAAA,WAAA,GAA8B,EAAE,CAAC;QAC5C,IAAU,CAAA,UAAA,GAAY,iBAAiB,EAAE,CAAC;QAC1C,IAAW,CAAA,WAAA,GAAY,IAAI,CAAC;KAgErC;IA9DC,IAAI,UAAU,CAAC,QAAiB,EAAA;AAC9B,QAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC;QAElC,IAAI,QAAQ,KAAK,QAAQ,EAAE;YACzB,OAAO;AACR,SAAA;QAED,MAAM,aAAa,GAAG,QAAQ,KAAK,IAAI,IAAI,IAAI,CAAC,UAAU,CAAC;QAC3D,MAAM,YAAY,GAAG,QAAQ,KAAK,KAAK,IAAI,IAAI,CAAC,UAAU,CAAC;AAE3D,QAAA,IAAI,aAAa,EAAE;AACjB,YAAA,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;AAC3D,gBAAA,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AACrB,aAAA;AACF,SAAA;AAED,QAAA,IAAI,YAAY,EAAE;AAChB,YAAA,KAAK,EAAE,CAAC;AACT,SAAA;AAED,QAAA,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAC;KAC7B;AAED,IAAA,IAAI,UAAU,GAAA;QACZ,OAAO,IAAI,CAAC,WAAW,CAAC;KACzB;AAED,IAAA,OAAO,CAAC,GAAW,EAAA;AACjB,QAAA,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,EAAE;AACtC,YAAA,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC;AACrB,SAAA;AAED,QAAA,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,CAAC,EAAE;AAC/D,YAAA,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;AAC9B,SAAA;AAED,QAAA,OAAO,IAAI,CAAC;KACb;IAED,OAAO,CAAC,GAAW,EAAE,KAAa,EAAA;AAChC,QAAA,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,EAAE;AACtC,YAAA,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AACrB,SAAA;AAED,QAAA,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;KAC/B;AAED,IAAA,UAAU,CAAC,GAAW,EAAA;AACpB,QAAA,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,EAAE;YACtC,UAAU,CAAC,GAAG,CAAC,CAAC;AACjB,SAAA;AAED,QAAA,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;KAC9B;IAED,KAAK,GAAA;AACH,QAAA,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,EAAE;AACtC,YAAA,KAAK,EAAE,CAAC;AACT,SAAA;AAED,QAAA,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;KACvB;AACF;;ACrFD;;;;;;;;AAQG;AA2BH;;AAEG;AACU,MAAA,OAAO,GAAG,IAAI,WAAW,GAAG;AAEzC;;AAEG;AACH,MAAM,MAAM,GAA4B,IAAI,GAAG,EAAE,CAAC;AAElD;;AAEG;AACG,SAAU,wBAAwB,CAAC,UAAsB,EAAA;IAC7D,MAAM,KAAK,GAAG,YAAY,CAAC,UAAU,EAAE,CAAC,OAAO,KAAI;;AACjD,QAAA,IACE,CAAC,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAuB,CAAC,EACvE;YACA,OAAO;AACR,SAAA;QAED,IAAI;YACF,IAAI,OAAO,GAAY,EAAE,CAAC;YAE1B,QAAQ,OAAO,CAAC,MAAM;gBACpB,KAAK,aAAa,CAAC,IAAI;AACrB,oBAAA,OAAO,GAAG;AACR,wBAAA,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG;wBACxB,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC;qBAC5C,CAAC;oBACF,MAAM;gBACR,KAAK,aAAa,CAAC,KAAK;AACtB,oBAAA,OAAO,GAAG;AACR,wBAAA,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG;qBACzB,CAAC;AACF,oBAAA,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;oBAC5D,MAAM;gBACR,KAAK,aAAa,CAAC,MAAM;AACvB,oBAAA,OAAO,GAAG;AACR,wBAAA,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG;qBACzB,CAAC;oBACF,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;oBACxC,MAAM;gBACR,KAAK,aAAa,CAAC,KAAK;oBACtB,OAAO,CAAC,KAAK,EAAE,CAAC;oBAChB,MAAM;AACT,aAAA;AAED,YAAA,mBAAmB,CAAC,UAAU,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;AACnD,SAAA;AAAC,QAAA,OAAO,GAAG,EAAE;AACZ,YAAA,MAAM,YAAY,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC;YAC1C,MAAM,GAAG,GAAG,CAAA,EAAA,GAAA,OAAO,CAAC,OAAO,MAAA,IAAA,IAAA,EAAA,KAAA,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAE,GAAG,CAAC;AACjC,YAAA,MAAM,OAAO,GAAG,GAAG,GAAG,CAAa,UAAA,EAAA,GAAG,CAAG,CAAA,CAAA,GAAG,EAAE,CAAC;AAE/C,YAAA,OAAO,CAAC,KAAK,CACX,CAAA,gCAAA,EAAmC,OAAO,CAAC,MAAM,CAAA,EAAG,OAAO,CAAA,aAAA,EAAgB,YAAY,CAAA,CAAE,CAC1F,CAAC;AAEF,YAAA,mBAAmB,CAAC,UAAU,EAAE,OAAO,EAAE;AACvC,gBAAA,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG;AACxB,gBAAA,KAAK,EAAE,YAAY;AACpB,aAAA,CAAC,CAAC;AACJ,SAAA;AACH,KAAC,CAAC,CAAC;IAEH,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;AACnC,CAAC;AAED;;AAEG;AACG,SAAU,yBAAyB,CAAC,UAAsB,EAAA;IAC9D,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;AAExC,IAAA,IAAI,KAAK,EAAE;AACT,QAAA,KAAK,EAAE,CAAC;AACR,QAAA,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;AAC9B,KAAA;AACH,CAAC;AAoBD;;AAEG;AACI,eAAe,gBAAgB,CACpC,SAA4B,EAC5B,MAAqB,EACrB,OAAiB,EAAA;IAEjB,IAAI;QACF,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAElE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,QAAQ,CAAC,OAA0B,CAAC;QAE7D,IAAI,KAAK,KAAK,SAAS,EAAE;YACvB,MAAM,WAAW,CACf,YAAY,CAAC,cAAc,EAC3B,oBAAoB,EACpB,KAAK,CACN,CAAC;AACH,SAAA;AAED,QAAA,OAAO,KAAK,CAAC;AACd,KAAA;AAAC,IAAA,OAAO,GAAG,EAAE;QACZ,IACE,GAAG,YAAY,cAAc;AAC7B,YAAA,GAAG,CAAC,IAAI,KAAK,WAAW,CAAC,mBAAmB,EAC5C;AACA,YAAA,MAAM,YAAY,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC;YAE1C,MAAM,WAAW,CACf,YAAY,CAAC,kBAAkB,EAC/B,oBAAoB,EACpB,YAAY,CACb,CAAC;AACH,SAAA;AAED,QAAA,MAAM,GAAG,CAAC;AACX,KAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;AAsBG;AACG,SAAU,oBAAoB,CAAC,UAAmB,EAAA;AACtD,IAAA,OAAO,CAAC,UAAU,GAAG,UAAU,CAAC;AAClC,CAAC;AAED;;;;;;;;;;;AAWG;AACI,eAAe,WAAW,CAAC,GAAW,EAAA;AAC3C,IAAA,MAAM,SAAS,GAAG,oBAAoB,EAAE,CAAC;IAEzC,IAAI,KAAK,GAAkB,IAAI,CAAC;IAEhC,IAAI;QACF,IAAI,SAAS,KAAK,IAAI,EAAE;YACtB,KAAK,GAAG,MAAM,gBAAgB,CAAC,SAAS,EAAE,aAAa,CAAC,IAAI,EAAE;gBAC5D,GAAG;AACJ,aAAA,CAAC,CAAC;AACJ,SAAA;AAAM,aAAA;AACL,YAAA,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;AAC9B,SAAA;AACF,KAAA;AAAC,IAAA,OAAO,GAAG,EAAE;AACZ,QAAA,MAAM,YAAY,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC;QAE1C,OAAO,CAAC,KAAK,CACX,CAAA,6BAAA,EAAgC,GAAG,CAAiB,cAAA,EAAA,YAAY,CAAE,CAAA,CACnE,CAAC;QAEF,MAAM,WAAW,CACf,YAAY,CAAC,SAAS,EACtB,oBAAoB,EACpB,YAAY,CACb,CAAC;AACH,KAAA;AAED,IAAA,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;;;;;AAYG;AACI,eAAe,YAAY,CAAC,GAAW,EAAE,KAAa,EAAA;AAC3D,IAAA,MAAM,SAAS,GAAG,oBAAoB,EAAE,CAAC;IAEzC,IAAI;QACF,IAAI,SAAS,KAAK,IAAI,EAAE;AACtB,YAAA,MAAM,gBAAgB,CAAC,SAAS,EAAE,aAAa,CAAC,KAAK,EAAE;gBACrD,GAAG;gBACH,KAAK;AACN,aAAA,CAAC,CAAC;AACJ,SAAA;AAAM,aAAA;AACL,YAAA,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AAC7B,SAAA;AACF,KAAA;AAAC,IAAA,OAAO,GAAG,EAAE;AACZ,QAAA,MAAM,YAAY,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC;QAE1C,OAAO,CAAC,KAAK,CACX,CAAA,8BAAA,EAAiC,GAAG,CAAiB,cAAA,EAAA,YAAY,CAAE,CAAA,CACpE,CAAC;QAEF,MAAM,WAAW,CACf,YAAY,CAAC,UAAU,EACvB,oBAAoB,EACpB,YAAY,CACb,CAAC;AACH,KAAA;AACH,CAAC;AAED;;;;;;;;;;;AAWG;AACI,eAAe,aAAa,CAAC,GAAW,EAAA;AAC7C,IAAA,MAAM,SAAS,GAAG,oBAAoB,EAAE,CAAC;IAEzC,IAAI;QACF,IAAI,SAAS,KAAK,IAAI,EAAE;AACtB,YAAA,MAAM,gBAAgB,CAAC,SAAS,EAAE,aAAa,CAAC,MAAM,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;AAClE,SAAA;AAAM,aAAA;AACL,YAAA,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;AACzB,SAAA;AACF,KAAA;AAAC,IAAA,OAAO,GAAG,EAAE;AACZ,QAAA,MAAM,YAAY,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC;QAE1C,OAAO,CAAC,KAAK,CACX,CAAA,+BAAA,EAAkC,GAAG,CAAiB,cAAA,EAAA,YAAY,CAAE,CAAA,CACrE,CAAC;QAEF,MAAM,WAAW,CACf,YAAY,CAAC,WAAW,EACxB,oBAAoB,EACpB,YAAY,CACb,CAAC;AACH,KAAA;AACH,CAAC;AAED;;;;;;;;;AASG;AACI,eAAe,YAAY,GAAA;AAChC,IAAA,MAAM,SAAS,GAAG,oBAAoB,EAAE,CAAC;IAEzC,IAAI;QACF,IAAI,SAAS,KAAK,IAAI,EAAE;YACtB,MAAM,gBAAgB,CAAC,SAAS,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC;AACxD,SAAA;AAAM,aAAA;YACL,OAAO,CAAC,KAAK,EAAE,CAAC;AACjB,SAAA;AACF,KAAA;AAAC,IAAA,OAAO,GAAG,EAAE;AACZ,QAAA,MAAM,YAAY,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC;AAE1C,QAAA,OAAO,CAAC,KAAK,CAAC,uCAAuC,YAAY,CAAA,CAAE,CAAC,CAAC;QAErE,MAAM,WAAW,CACf,YAAY,CAAC,UAAU,EACvB,oBAAoB,EACpB,YAAY,CACb,CAAC;AACH,KAAA;AACH,CAAC;AAED,cAAc,CAAC,CAAC,UAAU,EAAE,KAAK,KAAI;IACnC,IAAI,KAAK,KAAK,SAAS,EAAE;QACvB,wBAAwB,CAAC,UAAU,CAAC,CAAC;AACtC,KAAA;SAAM,IAAI,KAAK,KAAK,WAAW,EAAE;QAChC,yBAAyB,CAAC,UAAU,CAAC,CAAC;AACvC,KAAA;AACH,CAAC,CAAC;;;;"}

package/dist/types.d.ts

@@ -7,15 +7,43 @@
  *
  * More details on the license can be found at https://www.monterosa.co/sdk/license
  */
+/**
+ * Storage bridge action types used internally to communicate with the parent application.
+ */
 export declare enum StorageAction {
+    /**
+     * Read a value from storage.
+     */
     Read = "storageRead",
+    /**
+     * Write a value to storage.
+     */
     Write = "storageWrite",
+    /**
+     * Remove a value from storage.
+     */
     Remove = "storageRemove",
+    /**
+     * Clear all values from storage.
+     */
     Clear = "storageClear"
 }
+/**
+ * Response payload returned from a storage bridge request.
+ */
 export type ResponsePayload = {
+    /**
+     * The storage key that was operated on.
+     */
     key: string;
+    /**
+     * The value read from storage, or `null` if not found. Only present for read
+     * operations.
+     */
     value?: string | null;
+    /**
+     * Error message, if the operation failed.
+     */
     error?: string;
 };
 /**
@@ -27,7 +55,7 @@ export type ResponsePayload = {
  * try {
  *   // some code that uses the StorageKit
  * } catch (err) {
- *   if (err.code === StorageError.ParentApp) {
+ *   if (err.code === StorageError.ParentAppError) {
  *     // handle parent app error
  *   } else {
  *     // handle other error types