@salesforce/lds-durable-storage 1.421.0

package/LICENSE.txt

@@ -0,0 +1,82 @@
+Terms of Use
+
+Copyright 2026 Salesforce, Inc. All rights reserved.
+
+These Terms of Use govern the download, installation, and/or use of this
+software provided by Salesforce, Inc. ("Salesforce") (the "Software"), were
+last updated on April 15, 2022, and constitute a legally binding
+agreement between you and Salesforce. If you do not agree to these Terms of
+Use, do not install or use the Software.
+
+Salesforce grants you a worldwide, non-exclusive, no-charge, royalty-free
+copyright license to reproduce, prepare derivative works of, publicly
+display, publicly perform, sublicense, and distribute the Software and
+derivative works subject to these Terms. These Terms shall be included in
+all copies or substantial portions of the Software.
+
+Subject to the limited rights expressly granted hereunder, Salesforce
+reserves all rights, title, and interest in and to all intellectual
+property subsisting in the Software. No rights are granted to you hereunder
+other than as expressly set forth herein. Users residing in countries on
+the United States Office of Foreign Assets Control sanction list, or which
+are otherwise subject to a US export embargo, may not use the Software.
+
+Implementation of the Software may require development work, for which you
+are responsible. The Software may contain bugs, errors and
+incompatibilities and is made available on an AS IS basis without support,
+updates, or service level commitments.
+
+Salesforce reserves the right at any time to modify, suspend, or
+discontinue, the Software (or any part thereof) with or without notice. You
+agree that Salesforce shall not be liable to you or to any third party for
+any modification, suspension, or discontinuance.
+
+You agree to defend Salesforce against any claim, demand, suit or
+proceeding made or brought against Salesforce by a third party arising out
+of or accruing from (a) your use of the Software, and (b) any application
+you develop with the Software that infringes any copyright, trademark,
+trade secret, trade dress, patent, or other intellectual property right of
+any person or defames any person or violates their rights of publicity or
+privacy (each a "Claim Against Salesforce"), and will indemnify Salesforce
+from any damages, attorney fees, and costs finally awarded against
+Salesforce as a result of, or for any amounts paid by Salesforce under a
+settlement approved by you in writing of, a Claim Against Salesforce,
+provided Salesforce (x) promptly gives you written notice of the Claim
+Against Salesforce, (y) gives you sole control of the defense and
+settlement of the Claim Against Salesforce (except that you may not settle
+any Claim Against Salesforce unless it unconditionally releases Salesforce
+of all liability), and (z) gives you all reasonable assistance, at your
+expense.
+
+WITHOUT LIMITING THE GENERALITY OF THE FOREGOING, THE SOFTWARE IS NOT
+SUPPORTED AND IS PROVIDED "AS IS," WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED. IN NO EVENT SHALL SALESFORCE HAVE ANY LIABILITY FOR ANY DAMAGES,
+INCLUDING, BUT NOT LIMITED TO, DIRECT, INDIRECT, SPECIAL, INCIDENTAL,
+PUNITIVE, OR CONSEQUENTIAL DAMAGES, OR DAMAGES BASED ON LOST PROFITS, DATA,
+OR USE, IN CONNECTION WITH THE SOFTWARE, HOWEVER CAUSED AND WHETHER IN
+CONTRACT, TORT, OR UNDER ANY OTHER THEORY OF LIABILITY, WHETHER OR NOT YOU
+HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+These Terms of Use shall be governed exclusively by the internal laws of
+the State of California, without regard to its conflicts of laws
+rules. Each party hereby consents to the exclusive jurisdiction of the
+state and federal courts located in San Francisco County, California to
+adjudicate any dispute arising out of or relating to these Terms of Use and
+the download, installation, and/or use of the Software. Except as expressly
+stated herein, these Terms of Use constitute the entire agreement between
+the parties, and supersede all prior and contemporaneous agreements,
+proposals, or representations, written or oral, concerning their subject
+matter. No modification, amendment, or waiver of any provision of these
+Terms of Use shall be effective unless it is by an update to these Terms of
+Use that Salesforce makes available, or is in writing and signed by the
+party against whom the modification, amendment, or waiver is to be
+asserted.
+
+Data Privacy: Salesforce may collect, process, and store device,
+system, and other information related to your use of the Software. This
+information includes, but is not limited to, IP address, user metrics, and
+other data ("Usage Data"). Salesforce may use Usage Data for analytics,
+product development, and marketing purposes. You acknowledge that files
+generated in conjunction with the Software may contain sensitive or
+confidential data, and you are solely responsible for anonymizing and
+protecting such data.

package/README.md

@@ -0,0 +1,8 @@
+# @salesforce/lds-durable-storage
+
+Package for durable storage functionality used by LDS.
+
+## Development
+
+- Build: `yarn build`
+- Test: `yarn test:unit`

package/babel.config.js

@@ -0,0 +1 @@
+module.exports = require('../../babel.config');

package/dist/ldsDurableStorage.js

@@ -0,0 +1,37 @@
+/**
+ * Copyright (c) 2022, Salesforce, Inc.,
+ * All rights reserved.
+ * For full license text, see the LICENSE.txt file
+ */
+
+/*
+ *  ATTENTION!
+ *  THIS IS A GENERATED FILE FROM https://github.com/salesforce-experience-platform-emu/lds-lightning-platform
+ *  If you would like to contribute to LDS, please follow the steps outlined in the git repo.
+ *  Any changes made to this file in p4 will be automatically overwritten.
+ *  *******************************************************************************************
+ */
+/* proxy-compat-disable */
+function createStorage(config) {
+    return getDurableStorageImplementation().createStorage(config);
+}
+function clearStorages() {
+    return getDurableStorageImplementation().clearStorages();
+}
+let DurableStorageImplRef;
+function setDurableStorageImplementation(impl) {
+    DurableStorageImplRef = impl;
+}
+function getDurableStorageImplementation() {
+    if (DurableStorageImplRef) {
+        return DurableStorageImplRef;
+    }
+    // Default no-op implementation to avoid crashes if not set
+    return {
+        createStorage: () => null,
+        clearStorages: () => Promise.resolve([]),
+    };
+}
+
+export { clearStorages, createStorage, getDurableStorageImplementation, setDurableStorageImplementation };
+// version: 1.421.0-2828c95aef

package/dist/types/main.d.ts

@@ -0,0 +1,32 @@
+export interface Storage {
+    name: string;
+    get(key: string): Promise<unknown>;
+    getAll(keys?: string[]): Promise<Record<string, unknown>>;
+    set(key: string, value: unknown): Promise<void>;
+    setAll(values: object): Promise<void>;
+    getSize(): Promise<number>;
+    clear(): Promise<void>;
+    remove(key: string): Promise<unknown>;
+    removeAll(keys: string[]): Promise<unknown>;
+}
+export interface StorageConfig {
+    name: string;
+    persistent?: boolean;
+    secure?: boolean;
+    maxSize?: number;
+    expiration?: number;
+    clearOnInit?: boolean;
+    debugLogging?: boolean;
+    version?: string;
+}
+export declare function createStorage(config: StorageConfig): Storage | null;
+export declare function clearStorages(): Promise<void[]>;
+type DurableStorageCreateFn = (config: any) => unknown | null;
+type DurableStorageClearFn = () => Promise<unknown[]>;
+type DurableStorageImplementation = {
+    createStorage: DurableStorageCreateFn;
+    clearStorages: DurableStorageClearFn;
+};
+export declare function setDurableStorageImplementation(impl: DurableStorageImplementation): void;
+export declare function getDurableStorageImplementation(): DurableStorageImplementation;
+export {};

package/jest.config.js

@@ -0,0 +1,7 @@
+const baseConfig = require('../../scripts/jest/base.config');
+
+module.exports = {
+    ...baseConfig,
+    displayName: '@salesforce/lds-durable-storage',
+    roots: ['<rootDir>/src'],
+};

package/package.json

@@ -0,0 +1,19 @@
+{
+    "name": "@salesforce/lds-durable-storage",
+    "version": "1.421.0",
+    "license": "SEE LICENSE IN LICENSE.txt",
+    "description": "LDS Durable Storage",
+    "main": "dist/ldsDurableStorage.js",
+    "module": "dist/ldsDurableStorage.js",
+    "types": "dist/types/main.d.ts",
+    "scripts": {
+        "prepare": "yarn build",
+        "build": "rollup --bundleConfigAsCjs --config rollup.config.js",
+        "clean": "rm -rf dist",
+        "test:unit": "jest",
+        "test:debug": "node --inspect-brk ../../node_modules/.bin/jest --runInBand"
+    },
+    "volta": {
+        "extends": "../../package.json"
+    }
+}

package/rollup.config.js

@@ -0,0 +1,42 @@
+import resolve from '@rollup/plugin-node-resolve';
+import typescript from '@rollup/plugin-typescript';
+import replace from '@rollup/plugin-replace';
+
+import * as packageJson from './package.json';
+import {
+    buildBanner,
+    buildFooter,
+    copyrightHeaderPlugin,
+    readGitHash,
+} from '../../scripts/rollup/rollup-utils';
+
+const banner = buildBanner(true);
+const footer = buildFooter(packageJson.version);
+const hash = readGitHash();
+
+const ldsDurableStorage = {
+    input: './src/main.ts',
+
+    external: [],
+
+    output: {
+        file: 'dist/ldsDurableStorage.js',
+        format: 'esm',
+        banner,
+        footer,
+    },
+
+    plugins: [
+        copyrightHeaderPlugin,
+        resolve(),
+        typescript({
+            declarationDir: 'types',
+        }),
+        replace({
+            'process.env.VERSION': JSON.stringify(hash),
+            preventAssignment: true,
+        }),
+    ],
+};
+
+export default [ldsDurableStorage];

package/src/__tests__/main.spec.ts

@@ -0,0 +1,104 @@
+beforeEach(() => {
+    jest.resetModules();
+});
+
+describe('@salesforce/lds-durable-storage', () => {
+    describe('getDurableStorageImplementation', () => {
+        it('returns an implementation with createStorage and clearStorages', () => {
+            const { getDurableStorageImplementation } = require('../main');
+            const impl = getDurableStorageImplementation();
+            expect(impl).toHaveProperty('createStorage');
+            expect(impl).toHaveProperty('clearStorages');
+            expect(typeof impl.createStorage).toBe('function');
+            expect(typeof impl.clearStorages).toBe('function');
+        });
+
+        it('returns default no-op when no custom implementation is set', () => {
+            const { getDurableStorageImplementation } = require('../main');
+            const impl = getDurableStorageImplementation();
+            expect(impl.createStorage({})).toBeNull();
+            return expect(impl.clearStorages()).resolves.toEqual([]);
+        });
+    });
+
+    describe('setDurableStorageImplementation', () => {
+        it('replaces the implementation returned by getDurableStorageImplementation', () => {
+            const {
+                setDurableStorageImplementation,
+                getDurableStorageImplementation,
+            } = require('../main');
+            const customCreateStorage = jest.fn().mockReturnValue({ storage: true });
+            const customClearStorages = jest.fn().mockResolvedValue([]);
+            setDurableStorageImplementation({
+                createStorage: customCreateStorage,
+                clearStorages: customClearStorages,
+            });
+
+            const impl = getDurableStorageImplementation();
+            expect(impl.createStorage).toBe(customCreateStorage);
+            expect(impl.clearStorages).toBe(customClearStorages);
+        });
+    });
+
+    describe('createStorage', () => {
+        it('delegates to the current implementation and returns its result', () => {
+            const { createStorage, setDurableStorageImplementation } = require('../main');
+            const mockStorage = { get: jest.fn(), set: jest.fn() };
+            const createStorageImpl = jest.fn().mockReturnValue(mockStorage);
+            setDurableStorageImplementation({
+                createStorage: createStorageImpl,
+                clearStorages: () => Promise.resolve([]),
+            });
+
+            const config = { name: 'test', maxSize: 1024 };
+            const result = createStorage(config);
+
+            expect(createStorageImpl).toHaveBeenCalledWith(config);
+            expect(result).toBe(mockStorage);
+        });
+
+        it('returns undefined when implementation returns undefined', () => {
+            const { createStorage, setDurableStorageImplementation } = require('../main');
+            setDurableStorageImplementation({
+                createStorage: () => undefined,
+                clearStorages: () => Promise.resolve([]),
+            });
+            const result = createStorage({});
+            expect(result).toBeUndefined();
+        });
+    });
+
+    describe('clearStorages', () => {
+        it('delegates to the current implementation and returns its promise', async () => {
+            const { clearStorages, setDurableStorageImplementation } = require('../main');
+            const resolvedValues = [undefined, undefined];
+            const clearStoragesImpl = jest.fn().mockResolvedValue(resolvedValues);
+            setDurableStorageImplementation({
+                createStorage: () => null,
+                clearStorages: clearStoragesImpl,
+            });
+
+            const result = await clearStorages();
+
+            expect(clearStoragesImpl).toHaveBeenCalled();
+            expect(result).toEqual(resolvedValues);
+        });
+
+        it('returns resolved empty array when using default no-op implementation', async () => {
+            const { clearStorages } = require('../main');
+            const result = await clearStorages();
+            expect(result).toEqual([]);
+        });
+
+        it('propagates rejection from implementation', async () => {
+            const { clearStorages, setDurableStorageImplementation } = require('../main');
+            const error = new Error('clear failed');
+            setDurableStorageImplementation({
+                createStorage: () => null,
+                clearStorages: () => Promise.reject(error),
+            });
+
+            await expect(clearStorages()).rejects.toThrow('clear failed');
+        });
+    });
+});

package/src/main.ts

@@ -0,0 +1,56 @@
+// Public API delegates to shared utilities
+export interface Storage {
+    name: string;
+    get(key: string): Promise<unknown>;
+    getAll(keys?: string[]): Promise<Record<string, unknown>>;
+    set(key: string, value: unknown): Promise<void>;
+    setAll(values: object): Promise<void>;
+    getSize(): Promise<number>;
+    clear(): Promise<void>;
+    remove(key: string): Promise<unknown>;
+    removeAll(keys: string[]): Promise<unknown>;
+}
+
+export interface StorageConfig {
+    name: string;
+    persistent?: boolean;
+    secure?: boolean;
+    maxSize?: number;
+    expiration?: number;
+    clearOnInit?: boolean;
+    debugLogging?: boolean;
+    version?: string;
+}
+
+export function createStorage(config: StorageConfig): Storage | null {
+    return getDurableStorageImplementation().createStorage(config) as Storage | null;
+}
+
+export function clearStorages(): Promise<void[]> {
+    return getDurableStorageImplementation().clearStorages() as Promise<void[]>;
+}
+
+// Durable Storage implementation registry
+type DurableStorageCreateFn = (config: any) => unknown | null;
+type DurableStorageClearFn = () => Promise<unknown[]>;
+type DurableStorageImplementation = {
+    createStorage: DurableStorageCreateFn;
+    clearStorages: DurableStorageClearFn;
+};
+
+let DurableStorageImplRef: DurableStorageImplementation | undefined;
+
+export function setDurableStorageImplementation(impl: DurableStorageImplementation): void {
+    DurableStorageImplRef = impl;
+}
+
+export function getDurableStorageImplementation(): DurableStorageImplementation {
+    if (DurableStorageImplRef) {
+        return DurableStorageImplRef;
+    }
+    // Default no-op implementation to avoid crashes if not set
+    return {
+        createStorage: () => null,
+        clearStorages: () => Promise.resolve([]),
+    };
+}

package/tsconfig.json

@@ -0,0 +1,4 @@
+{
+    "extends": "../../tsconfig.json",
+    "include": ["src", "typings"]
+}