@monterosa/sdk-storage-kit 0.18.2-rc.1

package/README.md

@@ -0,0 +1 @@
+# Monterosa JS SDK / Storage Kit

package/dist/api.d.ts

@@ -0,0 +1,104 @@
+/**
+ * @license
+ * api.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
+ */
+import { Unsubscribe } from '@monterosa/sdk-util';
+import { Experience } from '@monterosa/sdk-launcher-kit';
+import { StorageImpl } from './storage_impl';
+/**
+ * @internal
+ */
+export declare enum StorageAction {
+    Read = "storageRead",
+    Write = "storageWrite",
+    Remove = "storageRemove",
+    Clear = "storageClear"
+}
+/**
+ * @internal
+ */
+export declare const storage: StorageImpl;
+/**
+ * @internal
+ */
+export declare function listenStorageMessages(experience: Experience): Unsubscribe;
+/**
+ * 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.
+ */
+export declare function setStoragePersistent(persistent: boolean): void;
+/**
+ * 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.
+ */
+export declare function storageRead(key: string): Promise<string | null>;
+/**
+ * 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.
+ */
+export declare function storageWrite(key: string, value: string): Promise<void>;
+/**
+ * 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.
+ */
+export declare function storageRemove(key: string): Promise<void>;
+/**
+ * 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.
+ */
+export declare function storageClear(): Promise<void>;

package/dist/index.cjs.js

@@ -0,0 +1,351 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var sdkLauncherKit = require('@monterosa/sdk-launcher-kit');
+var sdkUtil = require('@monterosa/sdk-util');
+
+/*! *****************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+
+function __awaiter(thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+}
+
+function __generator(thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+}
+
+/**
+ * @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
+ */
+var StorageImpl = /** @class */ (function () {
+    function StorageImpl() {
+        this.memoryStore = {};
+        this.accessible = sdkUtil.checkAvailability();
+        this._persistent = true;
+    }
+    Object.defineProperty(StorageImpl.prototype, "persistent", {
+        get: function () {
+            return this._persistent;
+        },
+        set: function (newValue) {
+            var oldValue = this._persistent;
+            if (oldValue === newValue) {
+                return;
+            }
+            var swapToStorage = newValue === true && this.accessible;
+            var swapToMemory = newValue === false && this.accessible;
+            if (swapToStorage) {
+                for (var _i = 0, _a = Object.entries(this.memoryStore); _i < _a.length; _i++) {
+                    var _b = _a[_i], key = _b[0], value = _b[1];
+                    sdkUtil.setItem(key, value);
+                }
+            }
+            if (swapToMemory) {
+                sdkUtil.clear();
+            }
+            this._persistent = newValue;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    StorageImpl.prototype.getItem = function (key) {
+        if (this.persistent && this.accessible) {
+            return sdkUtil.getItem(key);
+        }
+        if (Object.prototype.hasOwnProperty.call(this.memoryStore, key)) {
+            return this.memoryStore[key];
+        }
+        return null;
+    };
+    StorageImpl.prototype.setItem = function (key, value) {
+        if (this.persistent && this.accessible) {
+            sdkUtil.setItem(key, value);
+        }
+        this.memoryStore[key] = value;
+    };
+    StorageImpl.prototype.removeItem = function (key) {
+        if (this.persistent && this.accessible) {
+            sdkUtil.removeItem(key);
+        }
+        delete this.memoryStore[key];
+    };
+    StorageImpl.prototype.clear = function () {
+        if (this.persistent && this.accessible) {
+            sdkUtil.clear();
+        }
+        this.memoryStore = {};
+    };
+    return StorageImpl;
+}());
+
+/**
+ * @license
+ * api.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
+ */
+/**
+ * @internal
+ */
+exports.StorageAction = void 0;
+(function (StorageAction) {
+    StorageAction["Read"] = "storageRead";
+    StorageAction["Write"] = "storageWrite";
+    StorageAction["Remove"] = "storageRemove";
+    StorageAction["Clear"] = "storageClear";
+})(exports.StorageAction || (exports.StorageAction = {}));
+/**
+ * @internal
+ */
+var storage = new StorageImpl();
+/**
+ * @internal
+ */
+function listenStorageMessages(experience) {
+    return sdkLauncherKit.onSdkMessage(experience, function (message) {
+        var payload = {};
+        if (!Object.values(exports.StorageAction).includes(message.action)) {
+            return;
+        }
+        switch (message.action) {
+            case exports.StorageAction.Read:
+                payload = {
+                    value: storage.getItem(message.payload.key),
+                };
+                break;
+            case exports.StorageAction.Write:
+                storage.setItem(message.payload.key, message.payload.value);
+                break;
+            case exports.StorageAction.Remove:
+                storage.removeItem(message.payload.key);
+                break;
+            case exports.StorageAction.Clear:
+                storage.clear();
+                break;
+        }
+        sdkLauncherKit.respondToSdkMessage(experience, message, payload);
+    });
+}
+/**
+ * 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.
+ */
+function storageRead(key) {
+    return __awaiter(this, void 0, void 0, function () {
+        var parentApp, value, result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    parentApp = sdkLauncherKit.getParentApplication();
+                    value = null;
+                    if (!(parentApp !== null)) return [3 /*break*/, 2];
+                    return [4 /*yield*/, sdkLauncherKit.sendSdkRequest(parentApp, exports.StorageAction.Read, {
+                            key: key,
+                        })];
+                case 1:
+                    result = _a.sent();
+                    value = result.payload.value;
+                    return [3 /*break*/, 3];
+                case 2:
+                    value = storage.getItem(key);
+                    _a.label = 3;
+                case 3: return [2 /*return*/, Promise.resolve(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.
+ */
+function storageWrite(key, value) {
+    return __awaiter(this, void 0, void 0, function () {
+        var parentApp;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    parentApp = sdkLauncherKit.getParentApplication();
+                    if (!(parentApp !== null)) return [3 /*break*/, 2];
+                    return [4 /*yield*/, sdkLauncherKit.sendSdkRequest(parentApp, exports.StorageAction.Write, {
+                            key: key,
+                            value: value,
+                        })];
+                case 1:
+                    _a.sent();
+                    return [3 /*break*/, 3];
+                case 2:
+                    storage.setItem(key, value);
+                    _a.label = 3;
+                case 3: return [2 /*return*/, Promise.resolve()];
+            }
+        });
+    });
+}
+/**
+ * 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.
+ */
+function storageRemove(key) {
+    return __awaiter(this, void 0, void 0, function () {
+        var parentApp;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    parentApp = sdkLauncherKit.getParentApplication();
+                    if (!(parentApp !== null)) return [3 /*break*/, 2];
+                    return [4 /*yield*/, sdkLauncherKit.sendSdkRequest(parentApp, exports.StorageAction.Remove, { key: key })];
+                case 1:
+                    _a.sent();
+                    return [3 /*break*/, 3];
+                case 2:
+                    storage.removeItem(key);
+                    _a.label = 3;
+                case 3: return [2 /*return*/, Promise.resolve()];
+            }
+        });
+    });
+}
+/**
+ * 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.
+ */
+function storageClear() {
+    return __awaiter(this, void 0, void 0, function () {
+        var parentApp;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    parentApp = sdkLauncherKit.getParentApplication();
+                    if (!(parentApp !== null)) return [3 /*break*/, 2];
+                    return [4 /*yield*/, sdkLauncherKit.sendSdkRequest(parentApp, exports.StorageAction.Clear)];
+                case 1:
+                    _a.sent();
+                    return [3 /*break*/, 3];
+                case 2:
+                    storage.clear();
+                    _a.label = 3;
+                case 3: return [2 /*return*/, Promise.resolve()];
+            }
+        });
+    });
+}
+sdkLauncherKit.registerEmbedHook(listenStorageMessages);
+
+exports.listenStorageMessages = listenStorageMessages;
+exports.setStoragePersistent = setStoragePersistent;
+exports.storage = storage;
+exports.storageClear = storageClear;
+exports.storageRead = storageRead;
+exports.storageRemove = storageRemove;
+exports.storageWrite = storageWrite;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":["../src/storage_impl.ts","../src/api.ts"],"sourcesContent":["/**\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 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 { Unsubscribe } from '@monterosa/sdk-util';\nimport {\n  Experience,\n  Payload,\n  registerEmbedHook,\n  getParentApplication,\n  sendSdkRequest,\n  respondToSdkMessage,\n  onSdkMessage,\n} from '@monterosa/sdk-launcher-kit';\n\nimport { StorageImpl } from './storage_impl';\n\n/**\n * @internal\n */\nexport enum StorageAction {\n  Read = 'storageRead',\n  Write = 'storageWrite',\n  Remove = 'storageRemove',\n  Clear = 'storageClear',\n}\n\n/**\n * @internal\n */\nexport const storage = new StorageImpl();\n\n/**\n * @internal\n */\nexport function listenStorageMessages(experience: Experience): Unsubscribe {\n  return onSdkMessage(experience, (message) => {\n    let payload: Payload = {};\n\n    if (\n      !Object.values(StorageAction).includes(message.action as StorageAction)\n    ) {\n      return;\n    }\n\n    switch (message.action) {\n      case StorageAction.Read:\n        payload = {\n          value: storage.getItem(message.payload.key),\n        };\n        break;\n      case StorageAction.Write:\n        storage.setItem(message.payload.key, message.payload.value);\n        break;\n      case StorageAction.Remove:\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  });\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  if (parentApp !== null) {\n    const result = await sendSdkRequest(parentApp, StorageAction.Read, {\n      key,\n    });\n\n    value = result.payload.value as string;\n  } else {\n    value = storage.getItem(key);\n  }\n\n  return Promise.resolve(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  if (parentApp !== null) {\n    await sendSdkRequest(parentApp, StorageAction.Write, {\n      key,\n      value,\n    });\n  } else {\n    storage.setItem(key, value);\n  }\n\n  return Promise.resolve();\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  if (parentApp !== null) {\n    await sendSdkRequest(parentApp, StorageAction.Remove, { key });\n  } else {\n    storage.removeItem(key);\n  }\n\n  return Promise.resolve();\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  if (parentApp !== null) {\n    await sendSdkRequest(parentApp, StorageAction.Clear);\n  } else {\n    storage.clear();\n  }\n\n  return Promise.resolve();\n}\n\nregisterEmbedHook(listenStorageMessages);\n"],"names":["checkAvailability","setItem","clear","getItem","removeItem","StorageAction","onSdkMessage","respondToSdkMessage","getParentApplication","sendSdkRequest","registerEmbedHook"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;;;;;;;;;AAkBA;IAAA;QACU,gBAAW,GAA8B,EAAE,CAAC;QAC5C,eAAU,GAAYA,yBAAiB,EAAE,CAAC;QAC1C,gBAAW,GAAY,IAAI,CAAC;KAgErC;IA9DC,sBAAI,mCAAU;aAuBd;YACE,OAAO,IAAI,CAAC,WAAW,CAAC;SACzB;aAzBD,UAAe,QAAiB;YAC9B,IAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC;YAElC,IAAI,QAAQ,KAAK,QAAQ,EAAE;gBACzB,OAAO;aACR;YAED,IAAM,aAAa,GAAG,QAAQ,KAAK,IAAI,IAAI,IAAI,CAAC,UAAU,CAAC;YAC3D,IAAM,YAAY,GAAG,QAAQ,KAAK,KAAK,IAAI,IAAI,CAAC,UAAU,CAAC;YAE3D,IAAI,aAAa,EAAE;gBACjB,KAA2B,UAAgC,EAAhC,KAAA,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,EAAhC,cAAgC,EAAhC,IAAgC,EAAE;oBAAlD,IAAA,WAAY,EAAX,GAAG,QAAA,EAAE,KAAK,QAAA;oBACpBC,eAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;iBACrB;aACF;YAED,IAAI,YAAY,EAAE;gBAChBC,aAAK,EAAE,CAAC;aACT;YAED,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAC;SAC7B;;;OAAA;IAMD,6BAAO,GAAP,UAAQ,GAAW;QACjB,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,EAAE;YACtC,OAAOC,eAAO,CAAC,GAAG,CAAC,CAAC;SACrB;QAED,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,CAAC,EAAE;YAC/D,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;SAC9B;QAED,OAAO,IAAI,CAAC;KACb;IAED,6BAAO,GAAP,UAAQ,GAAW,EAAE,KAAa;QAChC,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,EAAE;YACtCF,eAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;SACrB;QAED,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;KAC/B;IAED,gCAAU,GAAV,UAAW,GAAW;QACpB,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,EAAE;YACtCG,kBAAU,CAAC,GAAG,CAAC,CAAC;SACjB;QAED,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;KAC9B;IAED,2BAAK,GAAL;QACE,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,EAAE;YACtCF,aAAK,EAAE,CAAC;SACT;QAED,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;KACvB;IACH,kBAAC;AAAD,CAAC;;ACrFD;;;;;;;;;AAuBA;;;AAGYG;AAAZ,WAAY,aAAa;IACvB,qCAAoB,CAAA;IACpB,uCAAsB,CAAA;IACtB,yCAAwB,CAAA;IACxB,uCAAsB,CAAA;AACxB,CAAC,EALWA,qBAAa,KAAbA,qBAAa,QAKxB;AAED;;;IAGa,OAAO,GAAG,IAAI,WAAW,GAAG;AAEzC;;;SAGgB,qBAAqB,CAAC,UAAsB;IAC1D,OAAOC,2BAAY,CAAC,UAAU,EAAE,UAAC,OAAO;QACtC,IAAI,OAAO,GAAY,EAAE,CAAC;QAE1B,IACE,CAAC,MAAM,CAAC,MAAM,CAACD,qBAAa,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAuB,CAAC,EACvE;YACA,OAAO;SACR;QAED,QAAQ,OAAO,CAAC,MAAM;YACpB,KAAKA,qBAAa,CAAC,IAAI;gBACrB,OAAO,GAAG;oBACR,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC;iBAC5C,CAAC;gBACF,MAAM;YACR,KAAKA,qBAAa,CAAC,KAAK;gBACtB,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;gBAC5D,MAAM;YACR,KAAKA,qBAAa,CAAC,MAAM;gBACvB,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;gBACxC,MAAM;YACR,KAAKA,qBAAa,CAAC,KAAK;gBACtB,OAAO,CAAC,KAAK,EAAE,CAAC;gBAChB,MAAM;SACT;QAEDE,kCAAmB,CAAC,UAAU,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;KACnD,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;SAuBgB,oBAAoB,CAAC,UAAmB;IACtD,OAAO,CAAC,UAAU,GAAG,UAAU,CAAC;AAClC,CAAC;AAED;;;;;;;;;;;;SAYsB,WAAW,CAAC,GAAW;;;;;;oBACrC,SAAS,GAAGC,mCAAoB,EAAE,CAAC;oBAErC,KAAK,GAAkB,IAAI,CAAC;0BAE5B,SAAS,KAAK,IAAI,CAAA,EAAlB,wBAAkB;oBACL,qBAAMC,6BAAc,CAAC,SAAS,EAAEJ,qBAAa,CAAC,IAAI,EAAE;4BACjE,GAAG,KAAA;yBACJ,CAAC,EAAA;;oBAFI,MAAM,GAAG,SAEb;oBAEF,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,KAAe,CAAC;;;oBAEvC,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;;wBAG/B,sBAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,EAAC;;;;CAC/B;AAED;;;;;;;;;;;;;SAasB,YAAY,CAAC,GAAW,EAAE,KAAa;;;;;;oBACrD,SAAS,GAAGG,mCAAoB,EAAE,CAAC;0BAErC,SAAS,KAAK,IAAI,CAAA,EAAlB,wBAAkB;oBACpB,qBAAMC,6BAAc,CAAC,SAAS,EAAEJ,qBAAa,CAAC,KAAK,EAAE;4BACnD,GAAG,KAAA;4BACH,KAAK,OAAA;yBACN,CAAC,EAAA;;oBAHF,SAGE,CAAC;;;oBAEH,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;;wBAG9B,sBAAO,OAAO,CAAC,OAAO,EAAE,EAAC;;;;CAC1B;AAED;;;;;;;;;;;;SAYsB,aAAa,CAAC,GAAW;;;;;;oBACvC,SAAS,GAAGG,mCAAoB,EAAE,CAAC;0BAErC,SAAS,KAAK,IAAI,CAAA,EAAlB,wBAAkB;oBACpB,qBAAMC,6BAAc,CAAC,SAAS,EAAEJ,qBAAa,CAAC,MAAM,EAAE,EAAE,GAAG,KAAA,EAAE,CAAC,EAAA;;oBAA9D,SAA8D,CAAC;;;oBAE/D,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;;wBAG1B,sBAAO,OAAO,CAAC,OAAO,EAAE,EAAC;;;;CAC1B;AAED;;;;;;;;;;SAUsB,YAAY;;;;;;oBAC1B,SAAS,GAAGG,mCAAoB,EAAE,CAAC;0BAErC,SAAS,KAAK,IAAI,CAAA,EAAlB,wBAAkB;oBACpB,qBAAMC,6BAAc,CAAC,SAAS,EAAEJ,qBAAa,CAAC,KAAK,CAAC,EAAA;;oBAApD,SAAoD,CAAC;;;oBAErD,OAAO,CAAC,KAAK,EAAE,CAAC;;wBAGlB,sBAAO,OAAO,CAAC,OAAO,EAAE,EAAC;;;;CAC1B;AAEDK,gCAAiB,CAAC,qBAAqB,CAAC;;;;;;;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @license
+ * index.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
+ */
+/**
+ * Monterosa SDK / Storage Kit
+ *
+ * @packageDocumentation
+ */
+export * from './api';

package/dist/index.esm2017.js

@@ -0,0 +1,242 @@
+import { registerEmbedHook, onSdkMessage, respondToSdkMessage, getParentApplication, sendSdkRequest } from '@monterosa/sdk-launcher-kit';
+import { checkAvailability, setItem, clear, getItem, removeItem } from '@monterosa/sdk-util';
+
+/**
+ * @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 = 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)) {
+                setItem(key, value);
+            }
+        }
+        if (swapToMemory) {
+            clear();
+        }
+        this._persistent = newValue;
+    }
+    get persistent() {
+        return this._persistent;
+    }
+    getItem(key) {
+        if (this.persistent && this.accessible) {
+            return getItem(key);
+        }
+        if (Object.prototype.hasOwnProperty.call(this.memoryStore, key)) {
+            return this.memoryStore[key];
+        }
+        return null;
+    }
+    setItem(key, value) {
+        if (this.persistent && this.accessible) {
+            setItem(key, value);
+        }
+        this.memoryStore[key] = value;
+    }
+    removeItem(key) {
+        if (this.persistent && this.accessible) {
+            removeItem(key);
+        }
+        delete this.memoryStore[key];
+    }
+    clear() {
+        if (this.persistent && this.accessible) {
+            clear();
+        }
+        this.memoryStore = {};
+    }
+}
+
+/**
+ * @license
+ * api.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
+ */
+/**
+ * @internal
+ */
+var StorageAction;
+(function (StorageAction) {
+    StorageAction["Read"] = "storageRead";
+    StorageAction["Write"] = "storageWrite";
+    StorageAction["Remove"] = "storageRemove";
+    StorageAction["Clear"] = "storageClear";
+})(StorageAction || (StorageAction = {}));
+/**
+ * @internal
+ */
+const storage = new StorageImpl();
+/**
+ * @internal
+ */
+function listenStorageMessages(experience) {
+    return onSdkMessage(experience, (message) => {
+        let payload = {};
+        if (!Object.values(StorageAction).includes(message.action)) {
+            return;
+        }
+        switch (message.action) {
+            case StorageAction.Read:
+                payload = {
+                    value: storage.getItem(message.payload.key),
+                };
+                break;
+            case StorageAction.Write:
+                storage.setItem(message.payload.key, message.payload.value);
+                break;
+            case StorageAction.Remove:
+                storage.removeItem(message.payload.key);
+                break;
+            case StorageAction.Clear:
+                storage.clear();
+                break;
+        }
+        respondToSdkMessage(experience, message, payload);
+    });
+}
+/**
+ * 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 = getParentApplication();
+    let value = null;
+    if (parentApp !== null) {
+        const result = await sendSdkRequest(parentApp, StorageAction.Read, {
+            key,
+        });
+        value = result.payload.value;
+    }
+    else {
+        value = storage.getItem(key);
+    }
+    return Promise.resolve(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 = getParentApplication();
+    if (parentApp !== null) {
+        await sendSdkRequest(parentApp, StorageAction.Write, {
+            key,
+            value,
+        });
+    }
+    else {
+        storage.setItem(key, value);
+    }
+    return Promise.resolve();
+}
+/**
+ * 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 = getParentApplication();
+    if (parentApp !== null) {
+        await sendSdkRequest(parentApp, StorageAction.Remove, { key });
+    }
+    else {
+        storage.removeItem(key);
+    }
+    return Promise.resolve();
+}
+/**
+ * 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 = getParentApplication();
+    if (parentApp !== null) {
+        await sendSdkRequest(parentApp, StorageAction.Clear);
+    }
+    else {
+        storage.clear();
+    }
+    return Promise.resolve();
+}
+registerEmbedHook(listenStorageMessages);
+
+export { StorageAction, listenStorageMessages, setStoragePersistent, storage, storageClear, storageRead, storageRemove, storageWrite };
+//# sourceMappingURL=index.esm2017.js.map

package/dist/index.esm2017.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.esm2017.js","sources":["../src/storage_impl.ts","../src/api.ts"],"sourcesContent":["/**\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 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 { Unsubscribe } from '@monterosa/sdk-util';\nimport {\n  Experience,\n  Payload,\n  registerEmbedHook,\n  getParentApplication,\n  sendSdkRequest,\n  respondToSdkMessage,\n  onSdkMessage,\n} from '@monterosa/sdk-launcher-kit';\n\nimport { StorageImpl } from './storage_impl';\n\n/**\n * @internal\n */\nexport enum StorageAction {\n  Read = 'storageRead',\n  Write = 'storageWrite',\n  Remove = 'storageRemove',\n  Clear = 'storageClear',\n}\n\n/**\n * @internal\n */\nexport const storage = new StorageImpl();\n\n/**\n * @internal\n */\nexport function listenStorageMessages(experience: Experience): Unsubscribe {\n  return onSdkMessage(experience, (message) => {\n    let payload: Payload = {};\n\n    if (\n      !Object.values(StorageAction).includes(message.action as StorageAction)\n    ) {\n      return;\n    }\n\n    switch (message.action) {\n      case StorageAction.Read:\n        payload = {\n          value: storage.getItem(message.payload.key),\n        };\n        break;\n      case StorageAction.Write:\n        storage.setItem(message.payload.key, message.payload.value);\n        break;\n      case StorageAction.Remove:\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  });\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  if (parentApp !== null) {\n    const result = await sendSdkRequest(parentApp, StorageAction.Read, {\n      key,\n    });\n\n    value = result.payload.value as string;\n  } else {\n    value = storage.getItem(key);\n  }\n\n  return Promise.resolve(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  if (parentApp !== null) {\n    await sendSdkRequest(parentApp, StorageAction.Write, {\n      key,\n      value,\n    });\n  } else {\n    storage.setItem(key, value);\n  }\n\n  return Promise.resolve();\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  if (parentApp !== null) {\n    await sendSdkRequest(parentApp, StorageAction.Remove, { key });\n  } else {\n    storage.removeItem(key);\n  }\n\n  return Promise.resolve();\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  if (parentApp !== null) {\n    await sendSdkRequest(parentApp, StorageAction.Clear);\n  } else {\n    storage.clear();\n  }\n\n  return Promise.resolve();\n}\n\nregisterEmbedHook(listenStorageMessages);\n"],"names":[],"mappings":";;;AAAA;;;;;;;;;MAkBa,WAAW;IAAxB;QACU,gBAAW,GAA8B,EAAE,CAAC;QAC5C,eAAU,GAAY,iBAAiB,EAAE,CAAC;QAC1C,gBAAW,GAAY,IAAI,CAAC;KAgErC;IA9DC,IAAI,UAAU,CAAC,QAAiB;QAC9B,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC;QAElC,IAAI,QAAQ,KAAK,QAAQ,EAAE;YACzB,OAAO;SACR;QAED,MAAM,aAAa,GAAG,QAAQ,KAAK,IAAI,IAAI,IAAI,CAAC,UAAU,CAAC;QAC3D,MAAM,YAAY,GAAG,QAAQ,KAAK,KAAK,IAAI,IAAI,CAAC,UAAU,CAAC;QAE3D,IAAI,aAAa,EAAE;YACjB,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;gBAC3D,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;aACrB;SACF;QAED,IAAI,YAAY,EAAE;YAChB,KAAK,EAAE,CAAC;SACT;QAED,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAC;KAC7B;IAED,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,WAAW,CAAC;KACzB;IAED,OAAO,CAAC,GAAW;QACjB,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,EAAE;YACtC,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC;SACrB;QAED,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,CAAC,EAAE;YAC/D,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;SAC9B;QAED,OAAO,IAAI,CAAC;KACb;IAED,OAAO,CAAC,GAAW,EAAE,KAAa;QAChC,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,EAAE;YACtC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;SACrB;QAED,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;KAC/B;IAED,UAAU,CAAC,GAAW;QACpB,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,EAAE;YACtC,UAAU,CAAC,GAAG,CAAC,CAAC;SACjB;QAED,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;KAC9B;IAED,KAAK;QACH,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,EAAE;YACtC,KAAK,EAAE,CAAC;SACT;QAED,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;KACvB;;;ACpFH;;;;;;;;;AAuBA;;;IAGY;AAAZ,WAAY,aAAa;IACvB,qCAAoB,CAAA;IACpB,uCAAsB,CAAA;IACtB,yCAAwB,CAAA;IACxB,uCAAsB,CAAA;AACxB,CAAC,EALW,aAAa,KAAb,aAAa,QAKxB;AAED;;;MAGa,OAAO,GAAG,IAAI,WAAW,GAAG;AAEzC;;;SAGgB,qBAAqB,CAAC,UAAsB;IAC1D,OAAO,YAAY,CAAC,UAAU,EAAE,CAAC,OAAO;QACtC,IAAI,OAAO,GAAY,EAAE,CAAC;QAE1B,IACE,CAAC,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAuB,CAAC,EACvE;YACA,OAAO;SACR;QAED,QAAQ,OAAO,CAAC,MAAM;YACpB,KAAK,aAAa,CAAC,IAAI;gBACrB,OAAO,GAAG;oBACR,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC;iBAC5C,CAAC;gBACF,MAAM;YACR,KAAK,aAAa,CAAC,KAAK;gBACtB,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;gBAC5D,MAAM;YACR,KAAK,aAAa,CAAC,MAAM;gBACvB,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;gBACxC,MAAM;YACR,KAAK,aAAa,CAAC,KAAK;gBACtB,OAAO,CAAC,KAAK,EAAE,CAAC;gBAChB,MAAM;SACT;QAED,mBAAmB,CAAC,UAAU,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;KACnD,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;SAuBgB,oBAAoB,CAAC,UAAmB;IACtD,OAAO,CAAC,UAAU,GAAG,UAAU,CAAC;AAClC,CAAC;AAED;;;;;;;;;;;;AAYO,eAAe,WAAW,CAAC,GAAW;IAC3C,MAAM,SAAS,GAAG,oBAAoB,EAAE,CAAC;IAEzC,IAAI,KAAK,GAAkB,IAAI,CAAC;IAEhC,IAAI,SAAS,KAAK,IAAI,EAAE;QACtB,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,SAAS,EAAE,aAAa,CAAC,IAAI,EAAE;YACjE,GAAG;SACJ,CAAC,CAAC;QAEH,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,KAAe,CAAC;KACxC;SAAM;QACL,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;KAC9B;IAED,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAChC,CAAC;AAED;;;;;;;;;;;;;AAaO,eAAe,YAAY,CAAC,GAAW,EAAE,KAAa;IAC3D,MAAM,SAAS,GAAG,oBAAoB,EAAE,CAAC;IAEzC,IAAI,SAAS,KAAK,IAAI,EAAE;QACtB,MAAM,cAAc,CAAC,SAAS,EAAE,aAAa,CAAC,KAAK,EAAE;YACnD,GAAG;YACH,KAAK;SACN,CAAC,CAAC;KACJ;SAAM;QACL,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;KAC7B;IAED,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;AAC3B,CAAC;AAED;;;;;;;;;;;;AAYO,eAAe,aAAa,CAAC,GAAW;IAC7C,MAAM,SAAS,GAAG,oBAAoB,EAAE,CAAC;IAEzC,IAAI,SAAS,KAAK,IAAI,EAAE;QACtB,MAAM,cAAc,CAAC,SAAS,EAAE,aAAa,CAAC,MAAM,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;KAChE;SAAM;QACL,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;KACzB;IAED,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;AAC3B,CAAC;AAED;;;;;;;;;;AAUO,eAAe,YAAY;IAChC,MAAM,SAAS,GAAG,oBAAoB,EAAE,CAAC;IAEzC,IAAI,SAAS,KAAK,IAAI,EAAE;QACtB,MAAM,cAAc,CAAC,SAAS,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC;KACtD;SAAM;QACL,OAAO,CAAC,KAAK,EAAE,CAAC;KACjB;IAED,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;AAC3B,CAAC;AAED,iBAAiB,CAAC,qBAAqB,CAAC;;;;"}

package/dist/index.esm5.js

@@ -0,0 +1,341 @@
+import { registerEmbedHook, onSdkMessage, respondToSdkMessage, getParentApplication, sendSdkRequest } from '@monterosa/sdk-launcher-kit';
+import { setItem, clear, getItem, removeItem, checkAvailability } from '@monterosa/sdk-util';
+
+/*! *****************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+
+function __awaiter(thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+}
+
+function __generator(thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+}
+
+/**
+ * @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
+ */
+var StorageImpl = /** @class */ (function () {
+    function StorageImpl() {
+        this.memoryStore = {};
+        this.accessible = checkAvailability();
+        this._persistent = true;
+    }
+    Object.defineProperty(StorageImpl.prototype, "persistent", {
+        get: function () {
+            return this._persistent;
+        },
+        set: function (newValue) {
+            var oldValue = this._persistent;
+            if (oldValue === newValue) {
+                return;
+            }
+            var swapToStorage = newValue === true && this.accessible;
+            var swapToMemory = newValue === false && this.accessible;
+            if (swapToStorage) {
+                for (var _i = 0, _a = Object.entries(this.memoryStore); _i < _a.length; _i++) {
+                    var _b = _a[_i], key = _b[0], value = _b[1];
+                    setItem(key, value);
+                }
+            }
+            if (swapToMemory) {
+                clear();
+            }
+            this._persistent = newValue;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    StorageImpl.prototype.getItem = function (key) {
+        if (this.persistent && this.accessible) {
+            return getItem(key);
+        }
+        if (Object.prototype.hasOwnProperty.call(this.memoryStore, key)) {
+            return this.memoryStore[key];
+        }
+        return null;
+    };
+    StorageImpl.prototype.setItem = function (key, value) {
+        if (this.persistent && this.accessible) {
+            setItem(key, value);
+        }
+        this.memoryStore[key] = value;
+    };
+    StorageImpl.prototype.removeItem = function (key) {
+        if (this.persistent && this.accessible) {
+            removeItem(key);
+        }
+        delete this.memoryStore[key];
+    };
+    StorageImpl.prototype.clear = function () {
+        if (this.persistent && this.accessible) {
+            clear();
+        }
+        this.memoryStore = {};
+    };
+    return StorageImpl;
+}());
+
+/**
+ * @license
+ * api.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
+ */
+/**
+ * @internal
+ */
+var StorageAction;
+(function (StorageAction) {
+    StorageAction["Read"] = "storageRead";
+    StorageAction["Write"] = "storageWrite";
+    StorageAction["Remove"] = "storageRemove";
+    StorageAction["Clear"] = "storageClear";
+})(StorageAction || (StorageAction = {}));
+/**
+ * @internal
+ */
+var storage = new StorageImpl();
+/**
+ * @internal
+ */
+function listenStorageMessages(experience) {
+    return onSdkMessage(experience, function (message) {
+        var payload = {};
+        if (!Object.values(StorageAction).includes(message.action)) {
+            return;
+        }
+        switch (message.action) {
+            case StorageAction.Read:
+                payload = {
+                    value: storage.getItem(message.payload.key),
+                };
+                break;
+            case StorageAction.Write:
+                storage.setItem(message.payload.key, message.payload.value);
+                break;
+            case StorageAction.Remove:
+                storage.removeItem(message.payload.key);
+                break;
+            case StorageAction.Clear:
+                storage.clear();
+                break;
+        }
+        respondToSdkMessage(experience, message, payload);
+    });
+}
+/**
+ * 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.
+ */
+function storageRead(key) {
+    return __awaiter(this, void 0, void 0, function () {
+        var parentApp, value, result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    parentApp = getParentApplication();
+                    value = null;
+                    if (!(parentApp !== null)) return [3 /*break*/, 2];
+                    return [4 /*yield*/, sendSdkRequest(parentApp, StorageAction.Read, {
+                            key: key,
+                        })];
+                case 1:
+                    result = _a.sent();
+                    value = result.payload.value;
+                    return [3 /*break*/, 3];
+                case 2:
+                    value = storage.getItem(key);
+                    _a.label = 3;
+                case 3: return [2 /*return*/, Promise.resolve(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.
+ */
+function storageWrite(key, value) {
+    return __awaiter(this, void 0, void 0, function () {
+        var parentApp;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    parentApp = getParentApplication();
+                    if (!(parentApp !== null)) return [3 /*break*/, 2];
+                    return [4 /*yield*/, sendSdkRequest(parentApp, StorageAction.Write, {
+                            key: key,
+                            value: value,
+                        })];
+                case 1:
+                    _a.sent();
+                    return [3 /*break*/, 3];
+                case 2:
+                    storage.setItem(key, value);
+                    _a.label = 3;
+                case 3: return [2 /*return*/, Promise.resolve()];
+            }
+        });
+    });
+}
+/**
+ * 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.
+ */
+function storageRemove(key) {
+    return __awaiter(this, void 0, void 0, function () {
+        var parentApp;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    parentApp = getParentApplication();
+                    if (!(parentApp !== null)) return [3 /*break*/, 2];
+                    return [4 /*yield*/, sendSdkRequest(parentApp, StorageAction.Remove, { key: key })];
+                case 1:
+                    _a.sent();
+                    return [3 /*break*/, 3];
+                case 2:
+                    storage.removeItem(key);
+                    _a.label = 3;
+                case 3: return [2 /*return*/, Promise.resolve()];
+            }
+        });
+    });
+}
+/**
+ * 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.
+ */
+function storageClear() {
+    return __awaiter(this, void 0, void 0, function () {
+        var parentApp;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    parentApp = getParentApplication();
+                    if (!(parentApp !== null)) return [3 /*break*/, 2];
+                    return [4 /*yield*/, sendSdkRequest(parentApp, StorageAction.Clear)];
+                case 1:
+                    _a.sent();
+                    return [3 /*break*/, 3];
+                case 2:
+                    storage.clear();
+                    _a.label = 3;
+                case 3: return [2 /*return*/, Promise.resolve()];
+            }
+        });
+    });
+}
+registerEmbedHook(listenStorageMessages);
+
+export { StorageAction, listenStorageMessages, setStoragePersistent, storage, storageClear, storageRead, storageRemove, storageWrite };
+//# sourceMappingURL=index.esm5.js.map

package/dist/index.esm5.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.esm5.js","sources":["../src/storage_impl.ts","../src/api.ts"],"sourcesContent":["/**\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 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 { Unsubscribe } from '@monterosa/sdk-util';\nimport {\n  Experience,\n  Payload,\n  registerEmbedHook,\n  getParentApplication,\n  sendSdkRequest,\n  respondToSdkMessage,\n  onSdkMessage,\n} from '@monterosa/sdk-launcher-kit';\n\nimport { StorageImpl } from './storage_impl';\n\n/**\n * @internal\n */\nexport enum StorageAction {\n  Read = 'storageRead',\n  Write = 'storageWrite',\n  Remove = 'storageRemove',\n  Clear = 'storageClear',\n}\n\n/**\n * @internal\n */\nexport const storage = new StorageImpl();\n\n/**\n * @internal\n */\nexport function listenStorageMessages(experience: Experience): Unsubscribe {\n  return onSdkMessage(experience, (message) => {\n    let payload: Payload = {};\n\n    if (\n      !Object.values(StorageAction).includes(message.action as StorageAction)\n    ) {\n      return;\n    }\n\n    switch (message.action) {\n      case StorageAction.Read:\n        payload = {\n          value: storage.getItem(message.payload.key),\n        };\n        break;\n      case StorageAction.Write:\n        storage.setItem(message.payload.key, message.payload.value);\n        break;\n      case StorageAction.Remove:\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  });\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  if (parentApp !== null) {\n    const result = await sendSdkRequest(parentApp, StorageAction.Read, {\n      key,\n    });\n\n    value = result.payload.value as string;\n  } else {\n    value = storage.getItem(key);\n  }\n\n  return Promise.resolve(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  if (parentApp !== null) {\n    await sendSdkRequest(parentApp, StorageAction.Write, {\n      key,\n      value,\n    });\n  } else {\n    storage.setItem(key, value);\n  }\n\n  return Promise.resolve();\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  if (parentApp !== null) {\n    await sendSdkRequest(parentApp, StorageAction.Remove, { key });\n  } else {\n    storage.removeItem(key);\n  }\n\n  return Promise.resolve();\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  if (parentApp !== null) {\n    await sendSdkRequest(parentApp, StorageAction.Clear);\n  } else {\n    storage.clear();\n  }\n\n  return Promise.resolve();\n}\n\nregisterEmbedHook(listenStorageMessages);\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;;;;;;;;;AAkBA;IAAA;QACU,gBAAW,GAA8B,EAAE,CAAC;QAC5C,eAAU,GAAY,iBAAiB,EAAE,CAAC;QAC1C,gBAAW,GAAY,IAAI,CAAC;KAgErC;IA9DC,sBAAI,mCAAU;aAuBd;YACE,OAAO,IAAI,CAAC,WAAW,CAAC;SACzB;aAzBD,UAAe,QAAiB;YAC9B,IAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC;YAElC,IAAI,QAAQ,KAAK,QAAQ,EAAE;gBACzB,OAAO;aACR;YAED,IAAM,aAAa,GAAG,QAAQ,KAAK,IAAI,IAAI,IAAI,CAAC,UAAU,CAAC;YAC3D,IAAM,YAAY,GAAG,QAAQ,KAAK,KAAK,IAAI,IAAI,CAAC,UAAU,CAAC;YAE3D,IAAI,aAAa,EAAE;gBACjB,KAA2B,UAAgC,EAAhC,KAAA,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,EAAhC,cAAgC,EAAhC,IAAgC,EAAE;oBAAlD,IAAA,WAAY,EAAX,GAAG,QAAA,EAAE,KAAK,QAAA;oBACpB,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;iBACrB;aACF;YAED,IAAI,YAAY,EAAE;gBAChB,KAAK,EAAE,CAAC;aACT;YAED,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAC;SAC7B;;;OAAA;IAMD,6BAAO,GAAP,UAAQ,GAAW;QACjB,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,EAAE;YACtC,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC;SACrB;QAED,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,CAAC,EAAE;YAC/D,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;SAC9B;QAED,OAAO,IAAI,CAAC;KACb;IAED,6BAAO,GAAP,UAAQ,GAAW,EAAE,KAAa;QAChC,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,EAAE;YACtC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;SACrB;QAED,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;KAC/B;IAED,gCAAU,GAAV,UAAW,GAAW;QACpB,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,EAAE;YACtC,UAAU,CAAC,GAAG,CAAC,CAAC;SACjB;QAED,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;KAC9B;IAED,2BAAK,GAAL;QACE,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,EAAE;YACtC,KAAK,EAAE,CAAC;SACT;QAED,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;KACvB;IACH,kBAAC;AAAD,CAAC;;ACrFD;;;;;;;;;AAuBA;;;IAGY;AAAZ,WAAY,aAAa;IACvB,qCAAoB,CAAA;IACpB,uCAAsB,CAAA;IACtB,yCAAwB,CAAA;IACxB,uCAAsB,CAAA;AACxB,CAAC,EALW,aAAa,KAAb,aAAa,QAKxB;AAED;;;IAGa,OAAO,GAAG,IAAI,WAAW,GAAG;AAEzC;;;SAGgB,qBAAqB,CAAC,UAAsB;IAC1D,OAAO,YAAY,CAAC,UAAU,EAAE,UAAC,OAAO;QACtC,IAAI,OAAO,GAAY,EAAE,CAAC;QAE1B,IACE,CAAC,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAuB,CAAC,EACvE;YACA,OAAO;SACR;QAED,QAAQ,OAAO,CAAC,MAAM;YACpB,KAAK,aAAa,CAAC,IAAI;gBACrB,OAAO,GAAG;oBACR,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC;iBAC5C,CAAC;gBACF,MAAM;YACR,KAAK,aAAa,CAAC,KAAK;gBACtB,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;gBAC5D,MAAM;YACR,KAAK,aAAa,CAAC,MAAM;gBACvB,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;gBACxC,MAAM;YACR,KAAK,aAAa,CAAC,KAAK;gBACtB,OAAO,CAAC,KAAK,EAAE,CAAC;gBAChB,MAAM;SACT;QAED,mBAAmB,CAAC,UAAU,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;KACnD,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;SAuBgB,oBAAoB,CAAC,UAAmB;IACtD,OAAO,CAAC,UAAU,GAAG,UAAU,CAAC;AAClC,CAAC;AAED;;;;;;;;;;;;SAYsB,WAAW,CAAC,GAAW;;;;;;oBACrC,SAAS,GAAG,oBAAoB,EAAE,CAAC;oBAErC,KAAK,GAAkB,IAAI,CAAC;0BAE5B,SAAS,KAAK,IAAI,CAAA,EAAlB,wBAAkB;oBACL,qBAAM,cAAc,CAAC,SAAS,EAAE,aAAa,CAAC,IAAI,EAAE;4BACjE,GAAG,KAAA;yBACJ,CAAC,EAAA;;oBAFI,MAAM,GAAG,SAEb;oBAEF,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,KAAe,CAAC;;;oBAEvC,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;;wBAG/B,sBAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,EAAC;;;;CAC/B;AAED;;;;;;;;;;;;;SAasB,YAAY,CAAC,GAAW,EAAE,KAAa;;;;;;oBACrD,SAAS,GAAG,oBAAoB,EAAE,CAAC;0BAErC,SAAS,KAAK,IAAI,CAAA,EAAlB,wBAAkB;oBACpB,qBAAM,cAAc,CAAC,SAAS,EAAE,aAAa,CAAC,KAAK,EAAE;4BACnD,GAAG,KAAA;4BACH,KAAK,OAAA;yBACN,CAAC,EAAA;;oBAHF,SAGE,CAAC;;;oBAEH,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;;wBAG9B,sBAAO,OAAO,CAAC,OAAO,EAAE,EAAC;;;;CAC1B;AAED;;;;;;;;;;;;SAYsB,aAAa,CAAC,GAAW;;;;;;oBACvC,SAAS,GAAG,oBAAoB,EAAE,CAAC;0BAErC,SAAS,KAAK,IAAI,CAAA,EAAlB,wBAAkB;oBACpB,qBAAM,cAAc,CAAC,SAAS,EAAE,aAAa,CAAC,MAAM,EAAE,EAAE,GAAG,KAAA,EAAE,CAAC,EAAA;;oBAA9D,SAA8D,CAAC;;;oBAE/D,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;;wBAG1B,sBAAO,OAAO,CAAC,OAAO,EAAE,EAAC;;;;CAC1B;AAED;;;;;;;;;;SAUsB,YAAY;;;;;;oBAC1B,SAAS,GAAG,oBAAoB,EAAE,CAAC;0BAErC,SAAS,KAAK,IAAI,CAAA,EAAlB,wBAAkB;oBACpB,qBAAM,cAAc,CAAC,SAAS,EAAE,aAAa,CAAC,KAAK,CAAC,EAAA;;oBAApD,SAAoD,CAAC;;;oBAErD,OAAO,CAAC,KAAK,EAAE,CAAC;;wBAGlB,sBAAO,OAAO,CAAC,OAAO,EAAE,EAAC;;;;CAC1B;AAED,iBAAiB,CAAC,qBAAqB,CAAC;;;;"}

package/dist/storage_impl.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @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
+ */
+export declare class StorageImpl {
+    private memoryStore;
+    private accessible;
+    private _persistent;
+    set persistent(newValue: boolean);
+    get persistent(): boolean;
+    getItem(key: string): string | null;
+    setItem(key: string, value: string): void;
+    removeItem(key: string): void;
+    clear(): void;
+}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@monterosa/sdk-storage-kit",
+  "version": "0.18.2-rc.1",
+  "description": "Storage Kit for the Monterosa JS SDK",
+  "author": "Monterosa <hello@monterosa.co.uk> (https://www.monterosa.co/)",
+  "main": "dist/index.cjs.js",
+  "browser": "dist/index.esm2017.js",
+  "module": "dist/index.esm2017.js",
+  "esm5": "dist/index.esm5.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "dev": "rollup -c -w",
+    "build": "rollup -c",
+    "test": "jest --color",
+    "test:watch": "jest --color --watchAll",
+    "test:ci": "jest --color --ci --reporters=jest-junit --coverage",
+    "api-report": "api-extractor run --local --verbose"
+  },
+  "keywords": [],
+  "license": "MIT",
+  "peerDependencies": {
+    "@monterosa/sdk-core": "0.x",
+    "@monterosa/sdk-launcher-kit": "0.x",
+    "@monterosa/sdk-util": "0.x"
+  },
+  "dependencies": {
+    "@monterosa/sdk-core": "^0.18.2-rc.1",
+    "@monterosa/sdk-launcher-kit": "^0.18.2-rc.1",
+    "@monterosa/sdk-util": "^0.18.2-rc.1"
+  },
+  "devDependencies": {
+    "@rollup/plugin-json": "^4.1.0",
+    "@types/jest": "^27.0.1",
+    "jest": "^27.1.0",
+    "jest-junit": "^13.0.0",
+    "rollup": "^2.57.0",
+    "rollup-plugin-typescript2": "^0.30.0",
+    "ts-jest": "^27.0.5",
+    "tslib": "^2.3.0",
+    "typescript": "^4.4.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "d2903789e355e14e4c119dcc14c1a25cc4e6b940"
+}