@salesforce/nimbus-plugin-lds 1.124.1 → 1.124.3

package/dist/mocks/index.js

@@ -1,43 +1,43 @@
-/*eslint-env es2020 */
-class MockNimbusNetworkAdapter {
-    constructor() {
-        this.mockResponses = [];
-        this.sentRequests = [];
-    }
-    setMockResponse(mockResponse) {
-        this.mockResponses = [mockResponse];
-    }
-    setMockResponses(mockResponses) {
-        this.mockResponses = mockResponses;
-    }
-    sendRequest(request, onResponse, onError) {
-        this.sentRequests.push(request);
-        const mockResponse = this.mockResponses.shift();
-        // invoke callbacks on async tick to align with how real implementation works
-        setTimeout(() => {
-            if (mockResponse === undefined) {
-                onError({ type: 'unspecified', message: 'response not set' });
-            }
-            else {
-                onResponse(mockResponse);
-            }
-        }, 0);
-        return Promise.resolve('mocked cancel token');
-    }
-    cancelRequest(_token) {
-        throw Error('Method not implemented.');
-    }
-    setAsGlobalNimbusPlugin() {
-        var _a;
-        globalThis.__nimbus = {
-            ...(globalThis.__nimbus || {}),
-            plugins: {
-                // eslint-disable-next-line @salesforce/lds/no-optional-chaining
-                ...(((_a = globalThis.__nimbus) === null || _a === void 0 ? void 0 : _a.plugins) || {}),
-                LdsNetworkAdapter: this,
-            },
-        };
-    }
+/*eslint-env es2020 */
+class MockNimbusNetworkAdapter {
+    constructor() {
+        this.mockResponses = [];
+        this.sentRequests = [];
+    }
+    setMockResponse(mockResponse) {
+        this.mockResponses = [mockResponse];
+    }
+    setMockResponses(mockResponses) {
+        this.mockResponses = mockResponses;
+    }
+    sendRequest(request, onResponse, onError) {
+        this.sentRequests.push(request);
+        const mockResponse = this.mockResponses.shift();
+        // invoke callbacks on async tick to align with how real implementation works
+        setTimeout(() => {
+            if (mockResponse === undefined) {
+                onError({ type: 'unspecified', message: 'response not set' });
+            }
+            else {
+                onResponse(mockResponse);
+            }
+        }, 0);
+        return Promise.resolve('mocked cancel token');
+    }
+    cancelRequest(_token) {
+        throw Error('Method not implemented.');
+    }
+    setAsGlobalNimbusPlugin() {
+        var _a;
+        globalThis.__nimbus = {
+            ...(globalThis.__nimbus || {}),
+            plugins: {
+                // eslint-disable-next-line @salesforce/lds/no-optional-chaining
+                ...(((_a = globalThis.__nimbus) === null || _a === void 0 ? void 0 : _a.plugins) || {}),
+                LdsNetworkAdapter: this,
+            },
+        };
+    }
 }
 
 export { MockNimbusNetworkAdapter };

package/dist/{BinaryStorePlugin.d.ts → types/BinaryStorePlugin.d.ts}

@@ -1,82 +1,82 @@
-declare module 'nimbus-types' {
-    interface NimbusPlugins {
-        LdsBinaryStorePlugin: BinaryStorePlugin;
-    }
-}
-/**
- * A nimbus plugin for interacting with a binary file store.
- *
- * The implementation can be used as a "store" where the file in the store is the only
- * copy and there is essentially no expiration (the file is never stale). Or it can be
- * used as a "cache" where the canonical copy of the file exists somewhere else (like
- * on a remote server).
- *
- * The caching behavior should follow the "stale-while-revalidate" pattern, where
- * a cached file (which has a non-null expiration and a canonical URI) should always
- * return the cached version, and if the file is past expiration (ie: "stale") then
- * the implementation should attempt to re-downloaded the file from the canonical
- * URI in the background.
- *
- */
-export interface BinaryStorePlugin {
-    /**
-     * Stores a binary file in the store.  The file will not have a TTL. This is
-     * meant to store local-only files.
-     *
-     * @param data The data of the binary file to put into the store.
-     * @param type The MIME type of the binary file. Ex: "image/png".
-     * @param size The number of bytes of data contained within the file.
-     * @param onSuccess Callback to call with the string representing the URI of
-     *        the binary file.
-     * @param onError Callback to call if there was an error.
-     */
-    storeBinary(data: Uint8Array, type: string, size: number, onSuccess: (uri: string) => void, onError: (errorMessage: string) => void): void;
-    /**
-     * Caches a binary file in the store.  This is meant to locally cache a file
-     * thats source-of-truth exists at the given URL.
-     *
-     * If the file is unable to be downloaded the onError callback will be called.
-     *
-     * This method should return a URI to the file, which may or may not be the
-     * same as the remote URL. In other words, the URI returned to callers should
-     * be treated as opaque by the callers.
-     *
-     * @param url The URL of the file.
-     * @param ttlSeconds The TTL in seconds for this file.  The file's expiration
-     *        should be calculated by Date.now + ttlSeconds.
-     * @param onSuccess Callback to call with the string representing the URI of
-     *        the binary file.
-     * @param onError Callback to call if there was an error.
-     */
-    cacheBinary(url: string, ttlSeconds: number, onSuccess: (uri: string) => void, onError: (errorMessage: string) => void): void;
-    /**
-     * Removes the binary file given its URI.
-     *
-     * @param uri The URI of the binary file
-     * @param onSuccess Callback to be called once finished.  The wasFound
-     *        parameter will be true if the file existed and has been removed, or
-     *        false if the file does not exist.
-     * @param onError Callback to call if there was an unexpected error.
-     */
-    removeBinary(uri: string, onSuccess: (wasFound: boolean) => void, onError: (errorMessage: string) => void): void;
-    /**
-     * Set the canonical URL for the file at the given uri.  The file will immediately
-     * be marked as stale (since we know the file's source of truth has changed).
-     *
-     * If there is no file at the given URI then this method will immediately cache
-     * the file at the canonicalUrl (essentially the same as calling {@link cacheBinary}).
-     *
-     * This method should return a URI to the file, which may or may not be
-     * different from the original URI, and may or may not be the same as the
-     * canonicalUrl.
-     *
-     * @param uri The URI of the existing, local binary file
-     * @param canonicalUrl The new, canonical URL (a URL is a type of URI) of the file
-     * @param ttlSeconds The TTL in seconds for this file.  The file's expiration
-     *        should be calculated by Date.now + ttlSeconds.
-     * @param onSuccess Callback to call with the string representing the new URI
-     *        to the file, which may or may not be the same as canonicalUrl.
-     * @param onError Callback to call if there was an error.
-     */
-    setCanonicalUrl(uri: string, canonicalUrl: string, ttlSeconds: number, onSuccess: (uri: string) => void, onError: (errorMessage: string) => void): void;
-}
+declare module 'nimbus-types' {
+    interface NimbusPlugins {
+        LdsBinaryStorePlugin: BinaryStorePlugin;
+    }
+}
+/**
+ * A nimbus plugin for interacting with a binary file store.
+ *
+ * The implementation can be used as a "store" where the file in the store is the only
+ * copy and there is essentially no expiration (the file is never stale). Or it can be
+ * used as a "cache" where the canonical copy of the file exists somewhere else (like
+ * on a remote server).
+ *
+ * The caching behavior should follow the "stale-while-revalidate" pattern, where
+ * a cached file (which has a non-null expiration and a canonical URI) should always
+ * return the cached version, and if the file is past expiration (ie: "stale") then
+ * the implementation should attempt to re-downloaded the file from the canonical
+ * URI in the background.
+ *
+ */
+export interface BinaryStorePlugin {
+    /**
+     * Stores a binary file in the store.  The file will not have a TTL. This is
+     * meant to store local-only files.
+     *
+     * @param data The data of the binary file to put into the store.
+     * @param type The MIME type of the binary file. Ex: "image/png".
+     * @param size The number of bytes of data contained within the file.
+     * @param onSuccess Callback to call with the string representing the URI of
+     *        the binary file.
+     * @param onError Callback to call if there was an error.
+     */
+    storeBinary(data: Uint8Array, type: string, size: number, onSuccess: (uri: string) => void, onError: (errorMessage: string) => void): void;
+    /**
+     * Caches a binary file in the store.  This is meant to locally cache a file
+     * thats source-of-truth exists at the given URL.
+     *
+     * If the file is unable to be downloaded the onError callback will be called.
+     *
+     * This method should return a URI to the file, which may or may not be the
+     * same as the remote URL. In other words, the URI returned to callers should
+     * be treated as opaque by the callers.
+     *
+     * @param url The URL of the file.
+     * @param ttlSeconds The TTL in seconds for this file.  The file's expiration
+     *        should be calculated by Date.now + ttlSeconds.
+     * @param onSuccess Callback to call with the string representing the URI of
+     *        the binary file.
+     * @param onError Callback to call if there was an error.
+     */
+    cacheBinary(url: string, ttlSeconds: number, onSuccess: (uri: string) => void, onError: (errorMessage: string) => void): void;
+    /**
+     * Removes the binary file given its URI.
+     *
+     * @param uri The URI of the binary file
+     * @param onSuccess Callback to be called once finished.  The wasFound
+     *        parameter will be true if the file existed and has been removed, or
+     *        false if the file does not exist.
+     * @param onError Callback to call if there was an unexpected error.
+     */
+    removeBinary(uri: string, onSuccess: (wasFound: boolean) => void, onError: (errorMessage: string) => void): void;
+    /**
+     * Set the canonical URL for the file at the given uri.  The file will immediately
+     * be marked as stale (since we know the file's source of truth has changed).
+     *
+     * If there is no file at the given URI then this method will immediately cache
+     * the file at the canonicalUrl (essentially the same as calling {@link cacheBinary}).
+     *
+     * This method should return a URI to the file, which may or may not be
+     * different from the original URI, and may or may not be the same as the
+     * canonicalUrl.
+     *
+     * @param uri The URI of the existing, local binary file
+     * @param canonicalUrl The new, canonical URL (a URL is a type of URI) of the file
+     * @param ttlSeconds The TTL in seconds for this file.  The file's expiration
+     *        should be calculated by Date.now + ttlSeconds.
+     * @param onSuccess Callback to call with the string representing the new URI
+     *        to the file, which may or may not be the same as canonicalUrl.
+     * @param onError Callback to call if there was an error.
+     */
+    setCanonicalUrl(uri: string, canonicalUrl: string, ttlSeconds: number, onSuccess: (uri: string) => void, onError: (errorMessage: string) => void): void;
+}

package/dist/{DraftQueue.d.ts → types/DraftQueue.d.ts}

@@ -1,22 +1,22 @@
-declare module 'nimbus-types' {
-    interface NimbusPlugins {
-        LdsDraftQueue: DraftQueue;
-    }
-}
-/**
- * Defines the DraftQueue that allows LDS running in the webview to interact with the
- * DraftQueue instance running in JSCore. Since the method parameters are opaque
- * to the native container everything passed into the nimbus plugin is serialized
- * and the jscore-side of the plugin implementation will perform the
- * serialization/deserialization of the parameters
- */
-export interface DraftQueue {
-    /**
-     * A generic proxy method to invoke various methods on the draft queue
-     * @param methodName The name of the proxy method to invoke
-     * @param serializedArgsArray A serialized array of arguments
-     * @param resultCallback Success callback containing serialized result
-     * @param errorCallback Error callback containing serialized error
-     */
-    callProxyMethod(methodName: string, serializedArgsArray: string, resultCallback: (serializedResult: string) => void, errorCallback: (serializedError: string) => void): void;
-}
+declare module 'nimbus-types' {
+    interface NimbusPlugins {
+        LdsDraftQueue: DraftQueue;
+    }
+}
+/**
+ * Defines the DraftQueue that allows LDS running in the webview to interact with the
+ * DraftQueue instance running in JSCore. Since the method parameters are opaque
+ * to the native container everything passed into the nimbus plugin is serialized
+ * and the jscore-side of the plugin implementation will perform the
+ * serialization/deserialization of the parameters
+ */
+export interface DraftQueue {
+    /**
+     * A generic proxy method to invoke various methods on the draft queue
+     * @param methodName The name of the proxy method to invoke
+     * @param serializedArgsArray A serialized array of arguments
+     * @param resultCallback Success callback containing serialized result
+     * @param errorCallback Error callback containing serialized error
+     */
+    callProxyMethod(methodName: string, serializedArgsArray: string, resultCallback: (serializedResult: string) => void, errorCallback: (serializedError: string) => void): void;
+}

package/dist/{InspectorPlugin.d.ts → types/InspectorPlugin.d.ts}

@@ -1,8 +1,8 @@
-declare module 'nimbus-types' {
-    interface NimbusPlugins {
-        LdsInspectorPlugin: InspectorPlugin;
-    }
-}
-export interface InspectorPlugin {
-    sendAdapterReport(serializedReport: string): void;
-}
+declare module 'nimbus-types' {
+    interface NimbusPlugins {
+        LdsInspectorPlugin: InspectorPlugin;
+    }
+}
+export interface InspectorPlugin {
+    sendAdapterReport(serializedReport: string): void;
+}

package/dist/{JsSqliteStorePlugin → types/JsSqliteStorePlugin}/JsSqliteStorePlugin.d.ts

@@ -1,23 +1,23 @@
-import type { SqliteType, SqliteResult } from '@salesforce/lds-store-sql';
-import type { Database } from 'sql.js';
-import type { SqliteOperation, SqliteStorePlugin } from '../SqliteStorePlugin';
-import { JsSqliteStorePluginBase } from './JsSqliteStorePluginBase';
-type DatabaseFactory = () => Promise<Database>;
-/**
- * A class that implements the {@link SqliteStorePlugin} interface based on
- * sql.js (https://sql.js.org/)
- */
-export declare class JsSqliteStorePlugin extends JsSqliteStorePluginBase implements SqliteStorePlugin {
-    private db;
-    private readonly dbFactory;
-    /**
-     * @param factory A factory that returns a Promise to a sql.js Database object
-     */
-    constructor(factory: DatabaseFactory);
-    private factoryPromise;
-    private getDatabase;
-    resetDatabase(): void;
-    query(sql: string, params: SqliteType[], onResult: (result: SqliteResult) => void, onError: (message: string) => void): Promise<void>;
-    batchOperations(operations: SqliteOperation[], onCompletion: (error: string | null) => void): Promise<void>;
-}
-export {};
+import type { SqliteType, SqliteResult } from '@salesforce/lds-store-sql';
+import type { Database } from 'sql.js';
+import type { SqliteOperation, SqliteStorePlugin } from '../SqliteStorePlugin';
+import { JsSqliteStorePluginBase } from './JsSqliteStorePluginBase';
+type DatabaseFactory = () => Promise<Database>;
+/**
+ * A class that implements the {@link SqliteStorePlugin} interface based on
+ * sql.js (https://sql.js.org/)
+ */
+export declare class JsSqliteStorePlugin extends JsSqliteStorePluginBase implements SqliteStorePlugin {
+    private db;
+    private readonly dbFactory;
+    /**
+     * @param factory A factory that returns a Promise to a sql.js Database object
+     */
+    constructor(factory: DatabaseFactory);
+    private factoryPromise;
+    private getDatabase;
+    resetDatabase(): void;
+    query(sql: string, params: SqliteType[], onResult: (result: SqliteResult) => void, onError: (message: string) => void): Promise<void>;
+    batchOperations(operations: SqliteOperation[], onCompletion: (error: string | null) => void): Promise<void>;
+}
+export {};

package/dist/{JsSqliteStorePlugin → types/JsSqliteStorePlugin}/JsSqliteStorePluginBase.d.ts

@@ -1,17 +1,17 @@
-import type { SqliteType, SqliteResult } from '@salesforce/lds-store-sql';
-import type { SqliteOperation, SqliteStoreChange, SqliteStorePlugin } from '../SqliteStorePlugin';
-type ListenerMap = Map<string, (changes: SqliteStoreChange[]) => void>;
-export declare abstract class JsSqliteStorePluginBase implements SqliteStorePlugin {
-    private listenerCounter;
-    protected listeners: ListenerMap;
-    abstract query(sql: string, params: SqliteType[], onResult: (result: SqliteResult) => void, onError: (message: string) => void): Promise<void>;
-    abstract batchOperations(operations: SqliteOperation[], onCompletion: (error: string | null) => void): Promise<void>;
-    registerOnChangedListener(listener: (changes: SqliteStoreChange[]) => void): Promise<string>;
-    unsubscribeOnChangedListener(id: string): Promise<void>;
-    protected notifyListeners(operations: SqliteOperation[]): void;
-}
-/**
- * This function takes an unknown error and normalizes it to an Error object
- */
-export declare function normalizeError(error: unknown): Error;
-export {};
+import type { SqliteType, SqliteResult } from '@salesforce/lds-store-sql';
+import type { SqliteOperation, SqliteStoreChange, SqliteStorePlugin } from '../SqliteStorePlugin';
+type ListenerMap = Map<string, (changes: SqliteStoreChange[]) => void>;
+export declare abstract class JsSqliteStorePluginBase implements SqliteStorePlugin {
+    private listenerCounter;
+    protected listeners: ListenerMap;
+    abstract query(sql: string, params: SqliteType[], onResult: (result: SqliteResult) => void, onError: (message: string) => void): Promise<void>;
+    abstract batchOperations(operations: SqliteOperation[], onCompletion: (error: string | null) => void): Promise<void>;
+    registerOnChangedListener(listener: (changes: SqliteStoreChange[]) => void): Promise<string>;
+    unsubscribeOnChangedListener(id: string): Promise<void>;
+    protected notifyListeners(operations: SqliteOperation[]): void;
+}
+/**
+ * This function takes an unknown error and normalizes it to an Error object
+ */
+export declare function normalizeError(error: unknown): Error;
+export {};

package/dist/{JsSqliteStorePlugin → types/JsSqliteStorePlugin}/JsWorkerSqliteStorePlugin.d.ts

@@ -1,12 +1,12 @@
-import type { SqliteType, SqliteResult } from '@salesforce/lds-store-sql';
-import { JsSqliteStorePluginBase } from './JsSqliteStorePluginBase';
-import type { SqliteOperation, SqliteStorePlugin } from '../SqliteStorePlugin';
-export declare class JsSqliteStoreWebWorkerPlugin extends JsSqliteStorePluginBase implements SqliteStorePlugin {
-    private callbackId;
-    private readonly queryCallbackMap;
-    private readonly batchCallbackMap;
-    private readonly worker;
-    constructor();
-    query(sql: string, params: SqliteType[], onResult: (result: SqliteResult) => void, onError: (message: string) => void): Promise<void>;
-    batchOperations(operations: SqliteOperation[], onCompletion: (error: string | null) => void): Promise<void>;
-}
+import type { SqliteType, SqliteResult } from '@salesforce/lds-store-sql';
+import { JsSqliteStorePluginBase } from './JsSqliteStorePluginBase';
+import type { SqliteOperation, SqliteStorePlugin } from '../SqliteStorePlugin';
+export declare class JsSqliteStoreWebWorkerPlugin extends JsSqliteStorePluginBase implements SqliteStorePlugin {
+    private callbackId;
+    private readonly queryCallbackMap;
+    private readonly batchCallbackMap;
+    private readonly worker;
+    constructor();
+    query(sql: string, params: SqliteType[], onResult: (result: SqliteResult) => void, onError: (message: string) => void): Promise<void>;
+    batchOperations(operations: SqliteOperation[], onCompletion: (error: string | null) => void): Promise<void>;
+}

package/dist/{JsSqliteStorePlugin → types/JsSqliteStorePlugin}/JsWorkerSqliteStorePlugin.worker.d.ts

@@ -1,24 +1,24 @@
-import type { SqliteType } from '@salesforce/lds-store-sql';
-import type { SqliteOperation } from '../SqliteStorePlugin';
-export type QueryRequest = {
-    functionName: 'query';
-    sql: string;
-    params: SqliteType[];
-    callbackId: number;
-};
-export type BatchOperationsRequest = {
-    functionName: 'batchOperations';
-    operations: SqliteOperation[];
-    callbackId: number;
-};
-export type Response<T, E = Error> = {
-    callbackId: number;
-    functionName: 'query' | 'batchOperations';
-    result: T;
-    error: undefined;
-} | {
-    callbackId: number;
-    functionName: 'query' | 'batchOperations';
-    result: undefined;
-    error: E;
-};
+import type { SqliteType } from '@salesforce/lds-store-sql';
+import type { SqliteOperation } from '../SqliteStorePlugin';
+export type QueryRequest = {
+    functionName: 'query';
+    sql: string;
+    params: SqliteType[];
+    callbackId: number;
+};
+export type BatchOperationsRequest = {
+    functionName: 'batchOperations';
+    operations: SqliteOperation[];
+    callbackId: number;
+};
+export type Response<T, E = Error> = {
+    callbackId: number;
+    functionName: 'query' | 'batchOperations';
+    result: T;
+    error: undefined;
+} | {
+    callbackId: number;
+    functionName: 'query' | 'batchOperations';
+    result: undefined;
+    error: E;
+};

package/dist/{JsSqliteStorePlugin → types/JsSqliteStorePlugin}/PluginFunctions.d.ts

@@ -1,9 +1,9 @@
-import type { SqliteType, SqliteResult } from '@salesforce/lds-store-sql';
-import type { Database } from 'sql.js';
-import type { SqliteOperation } from '../SqliteStorePlugin';
-export declare function query(database: Database, sql: string, params: SqliteType[], onResult: (result: SqliteResult) => void, onError: (message: string) => void): void;
-/**
- * Performs the operations on the DB.  NOTE: this function does not do anything
- * with notifying change listeners.  Callers need to handle that.
- */
-export declare function batchOperations(database: Database, operations: SqliteOperation[]): void;
+import type { SqliteType, SqliteResult } from '@salesforce/lds-store-sql';
+import type { Database } from 'sql.js';
+import type { SqliteOperation } from '../SqliteStorePlugin';
+export declare function query(database: Database, sql: string, params: SqliteType[], onResult: (result: SqliteResult) => void, onError: (message: string) => void): void;
+/**
+ * Performs the operations on the DB.  NOTE: this function does not do anything
+ * with notifying change listeners.  Callers need to handle that.
+ */
+export declare function batchOperations(database: Database, operations: SqliteOperation[]): void;