@salesforce/nimbus-plugin-lds 1.124.2 → 1.124.3

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

@@ -1,89 +1,89 @@
-declare module 'nimbus-types' {
-    interface NimbusPlugins {
-        LdsNetworkAdapter: NetworkAdapter;
-    }
-}
-/**
- *  ObservabilityContext helps us trace the path of a request
- *  through the Native and JS layers
- */
-export interface ObservabilityContext {
-    /**
-     * Uniquely identify a root activity like Priming, Navigation etc
-     * Multiple adapter calls can be tied to one root activity
-     *
-     * Optional
-     */
-    rootId?: string;
-    /**
-     * Should we transmit the activity from the client side
-     *
-     * Required if rootId is provided.
-     */
-    isRootActivitySampled?: boolean;
-    /**
-     * Uniquely identifies each adapter call
-     *
-     * Optional
-     */
-    traceId?: string;
-}
-/**
- * A `NetworkError` represents a type of transient request error and an associated message
- * if one is available.
- */
-export interface NetworkError {
-    type: 'timeout' | 'unspecified';
-    message: string | null;
-}
-/**
- * A `NetworkAdapter` is capable of handling `Request`s and generating `Response`s.
- */
-export interface NetworkAdapter {
-    /**
-     * Send the request, returning a token that can be used to cancel the request.
-     *
-     * @param request the request to handle
-     * @param onResponse called when a Response is received
-     * @param onError called when there is an error handling the `Request`. The `error`
-     * is a NetworkError describing what caused the error.
-     * @returns {Promise<string>} A promise resolving to a token for this request
-     */
-    sendRequest(request: Request, onResponse: (response: Response) => void, onError: (error: NetworkError) => void): Promise<string>;
-    /**
-     * Attempt to cancel a request associated with the specified token.
-     *
-     * @param token a token returned from `sendRequest`
-     * @returns {void}
-     */
-    cancelRequest(token: string): void;
-}
-/**
- * An HTTP request
- */
-export interface Request {
-    method: 'GET' | 'PUT' | 'POST' | 'PATCH' | 'DELETE';
-    priority: 'background' | 'normal' | 'high';
-    path: string;
-    headers: {
-        [key: string]: string;
-    };
-    queryParams: {
-        [key: string]: string;
-    };
-    body: string | null;
-    observabilityContext: ObservabilityContext | null;
-}
-/**
- * An HTTP response
- */
-export interface Response {
-    status: number;
-    headers: {
-        [key: string]: string;
-    };
-    /**
-     * A string-encoded object or null.
-     */
-    body: string | null;
-}
+declare module 'nimbus-types' {
+    interface NimbusPlugins {
+        LdsNetworkAdapter: NetworkAdapter;
+    }
+}
+/**
+ *  ObservabilityContext helps us trace the path of a request
+ *  through the Native and JS layers
+ */
+export interface ObservabilityContext {
+    /**
+     * Uniquely identify a root activity like Priming, Navigation etc
+     * Multiple adapter calls can be tied to one root activity
+     *
+     * Optional
+     */
+    rootId?: string;
+    /**
+     * Should we transmit the activity from the client side
+     *
+     * Required if rootId is provided.
+     */
+    isRootActivitySampled?: boolean;
+    /**
+     * Uniquely identifies each adapter call
+     *
+     * Optional
+     */
+    traceId?: string;
+}
+/**
+ * A `NetworkError` represents a type of transient request error and an associated message
+ * if one is available.
+ */
+export interface NetworkError {
+    type: 'timeout' | 'unspecified';
+    message: string | null;
+}
+/**
+ * A `NetworkAdapter` is capable of handling `Request`s and generating `Response`s.
+ */
+export interface NetworkAdapter {
+    /**
+     * Send the request, returning a token that can be used to cancel the request.
+     *
+     * @param request the request to handle
+     * @param onResponse called when a Response is received
+     * @param onError called when there is an error handling the `Request`. The `error`
+     * is a NetworkError describing what caused the error.
+     * @returns {Promise<string>} A promise resolving to a token for this request
+     */
+    sendRequest(request: Request, onResponse: (response: Response) => void, onError: (error: NetworkError) => void): Promise<string>;
+    /**
+     * Attempt to cancel a request associated with the specified token.
+     *
+     * @param token a token returned from `sendRequest`
+     * @returns {void}
+     */
+    cancelRequest(token: string): void;
+}
+/**
+ * An HTTP request
+ */
+export interface Request {
+    method: 'GET' | 'PUT' | 'POST' | 'PATCH' | 'DELETE';
+    priority: 'background' | 'normal' | 'high';
+    path: string;
+    headers: {
+        [key: string]: string;
+    };
+    queryParams: {
+        [key: string]: string;
+    };
+    body: string | null;
+    observabilityContext: ObservabilityContext | null;
+}
+/**
+ * An HTTP response
+ */
+export interface Response {
+    status: number;
+    headers: {
+        [key: string]: string;
+    };
+    /**
+     * A string-encoded object or null.
+     */
+    body: string | null;
+}

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

@@ -1,152 +1,152 @@
-declare module 'nimbus-types' {
-    interface NimbusPlugins {
-        LdsSqliteStore: SqliteStorePlugin;
-    }
-}
-import type { SqliteResult, SqliteType } from '@salesforce/lds-store-sql';
-/**
- * A plugin interface that is backed by a sqlite database and
- * used by a `SqliteStore`.
- */
-export interface SqliteStorePlugin {
-    /**
-     * @see SqliteStore.query
-     */
-    query(sql: string, params: SqliteType[], onResult: (result: SqliteResult) => void, onError: (message: string) => void): Promise<void>;
-    /**
-     * Perform a set of operations on the underlying database.
-     */
-    batchOperations(operations: SqliteOperation[], onCompletion: (error: string | null) => void): Promise<void>;
-    /**
-     * Setup a listener to be notified of changes to the Durable Store
-     *
-     * @param listener callback taking an array of store changes
-     * @returns {Promise<string>} a generated id of the listener to unsubscribe with
-     */
-    registerOnChangedListener(listener: (changes: SqliteStoreChange[]) => void): Promise<string>;
-    /**
-     *
-     * @param id the identifier given from registerOnChangedListener
-     */
-    unsubscribeOnChangedListener(id: string): Promise<void>;
-}
-/**
- * An operation to perform on the database.
- */
-interface SqliteOperationBase {
-    table: 'lds_data' | 'lds_internal' | 'lds_env_drafts' | 'lds_env_draft_id_map';
-    keyColumn: string;
-    context: SqliteOperationContext;
-}
-/**
- * An upsert attempts to insert rows into the database. If
- * there is a primary key or unique constraint violation it
- * can attempt to update the existing rows.
- *
- * ex:
- * ```javascript
- * let operation = {
- *   type: "upsert",
- *   table: "luvio_internal",
- *   columns: ["key", "namespace", "data", "metadata"],
- *   keyColumn: "key",
- *   conflictColumns: ["key", "namespace"],
- *   rows: [
- *     ["001002003004005001", "ADAPTER_CONTEXT",  "{'a': 1, 'b': 2}", "{}"],
- *     ["001002003004005002", "ADAPTER_CONTEXT", "{'a': 3, 'b': 5}", "{}"]
- *   ],
- *   context: {
- *     segment: "ADAPTER_CONTEXT"
- *   }
- * }
- * ```
- *
- * ```sql
- * insert into luvio_internal (key, namespace, data, metadata)
- * values (?, ?, ?, ?)
- * on conflict (key, namespace) do
- * update set value = excluded.value, metada = excluded.metadata
- * ```
- */
-interface SqliteUpsert extends SqliteOperationBase {
-    type: 'upsert';
-    conflictColumns: string[];
-    columns: string[];
-    rows: SqliteType[][];
-}
-/**
- * Delete rows from the database.
- *
- * ex:
- * ```javascript
- * let operation = {
- *   type: "delete",
- *   table: "luvio_data",
- *   keyColumn: "key",
- *   ids: ["001002003004005001", "001002003004005002"],
- *   context: {
- *     segment: "DEFAULT"
- *   }
- * }
- * ```
- *
- * ```sql
- * delete from luvio_data where key in ("001002003004005001", "001002003004005002")
- * ```
- */
-interface SqliteDelete extends SqliteOperationBase {
-    type: 'delete';
-    ids: string[];
-}
-export type SqliteOperation = SqliteDelete | SqliteUpsert;
-export declare function isUpsertOperation(operation: SqliteOperation): operation is SqliteUpsert;
-/**
- * Operations can pass any context object along with the operation.
- * This context is opaque to the plugin and will be included in any
- * change notifications generated from the operation.
- */
-export type SqliteOperationContext = {
-    [s: string]: SqliteType;
-};
-/**
- * A change from the underlying sqlite database triggered by executing a set of operations.
- *
- * Example:
- *
- * The following operation:
- *
- * ```javascript
- * let operation = {
- *   type: "delete",
- *   table: "luvio_data",
- *   keyColumn: "key",
- *   ids: ["001", "002"],
- *   context: {
- *     segment: "DEFAULT"
- *   }
- * }
- * ```
- *
- * should trigger the following change:
- * ```javascript
- * {
- *   type: "delete",
- *   table: "luvio_data",
- *   keys: ["001", "002"],
- *   context: {
- *     segment: "DEFAULT"
- *   }
- * }
- * ```
- */
-export interface SqliteStoreChange {
-    type: SqliteOperation['type'];
-    table: string;
-    keys: SqliteType[];
-    context: SqliteOperationContext;
-}
-export declare const sortedSchemaMigrations: Array<{
-    version: number;
-    sql: string;
-}>;
-export {};
+declare module 'nimbus-types' {
+    interface NimbusPlugins {
+        LdsSqliteStore: SqliteStorePlugin;
+    }
+}
+import type { SqliteResult, SqliteType } from '@salesforce/lds-store-sql';
+/**
+ * A plugin interface that is backed by a sqlite database and
+ * used by a `SqliteStore`.
+ */
+export interface SqliteStorePlugin {
+    /**
+     * @see SqliteStore.query
+     */
+    query(sql: string, params: SqliteType[], onResult: (result: SqliteResult) => void, onError: (message: string) => void): Promise<void>;
+    /**
+     * Perform a set of operations on the underlying database.
+     */
+    batchOperations(operations: SqliteOperation[], onCompletion: (error: string | null) => void): Promise<void>;
+    /**
+     * Setup a listener to be notified of changes to the Durable Store
+     *
+     * @param listener callback taking an array of store changes
+     * @returns {Promise<string>} a generated id of the listener to unsubscribe with
+     */
+    registerOnChangedListener(listener: (changes: SqliteStoreChange[]) => void): Promise<string>;
+    /**
+     *
+     * @param id the identifier given from registerOnChangedListener
+     */
+    unsubscribeOnChangedListener(id: string): Promise<void>;
+}
+/**
+ * An operation to perform on the database.
+ */
+interface SqliteOperationBase {
+    table: 'lds_data' | 'lds_internal' | 'lds_env_drafts' | 'lds_env_draft_id_map';
+    keyColumn: string;
+    context: SqliteOperationContext;
+}
+/**
+ * An upsert attempts to insert rows into the database. If
+ * there is a primary key or unique constraint violation it
+ * can attempt to update the existing rows.
+ *
+ * ex:
+ * ```javascript
+ * let operation = {
+ *   type: "upsert",
+ *   table: "luvio_internal",
+ *   columns: ["key", "namespace", "data", "metadata"],
+ *   keyColumn: "key",
+ *   conflictColumns: ["key", "namespace"],
+ *   rows: [
+ *     ["001002003004005001", "ADAPTER_CONTEXT",  "{'a': 1, 'b': 2}", "{}"],
+ *     ["001002003004005002", "ADAPTER_CONTEXT", "{'a': 3, 'b': 5}", "{}"]
+ *   ],
+ *   context: {
+ *     segment: "ADAPTER_CONTEXT"
+ *   }
+ * }
+ * ```
+ *
+ * ```sql
+ * insert into luvio_internal (key, namespace, data, metadata)
+ * values (?, ?, ?, ?)
+ * on conflict (key, namespace) do
+ * update set value = excluded.value, metada = excluded.metadata
+ * ```
+ */
+interface SqliteUpsert extends SqliteOperationBase {
+    type: 'upsert';
+    conflictColumns: string[];
+    columns: string[];
+    rows: SqliteType[][];
+}
+/**
+ * Delete rows from the database.
+ *
+ * ex:
+ * ```javascript
+ * let operation = {
+ *   type: "delete",
+ *   table: "luvio_data",
+ *   keyColumn: "key",
+ *   ids: ["001002003004005001", "001002003004005002"],
+ *   context: {
+ *     segment: "DEFAULT"
+ *   }
+ * }
+ * ```
+ *
+ * ```sql
+ * delete from luvio_data where key in ("001002003004005001", "001002003004005002")
+ * ```
+ */
+interface SqliteDelete extends SqliteOperationBase {
+    type: 'delete';
+    ids: string[];
+}
+export type SqliteOperation = SqliteDelete | SqliteUpsert;
+export declare function isUpsertOperation(operation: SqliteOperation): operation is SqliteUpsert;
+/**
+ * Operations can pass any context object along with the operation.
+ * This context is opaque to the plugin and will be included in any
+ * change notifications generated from the operation.
+ */
+export type SqliteOperationContext = {
+    [s: string]: SqliteType;
+};
+/**
+ * A change from the underlying sqlite database triggered by executing a set of operations.
+ *
+ * Example:
+ *
+ * The following operation:
+ *
+ * ```javascript
+ * let operation = {
+ *   type: "delete",
+ *   table: "luvio_data",
+ *   keyColumn: "key",
+ *   ids: ["001", "002"],
+ *   context: {
+ *     segment: "DEFAULT"
+ *   }
+ * }
+ * ```
+ *
+ * should trigger the following change:
+ * ```javascript
+ * {
+ *   type: "delete",
+ *   table: "luvio_data",
+ *   keys: ["001", "002"],
+ *   context: {
+ *     segment: "DEFAULT"
+ *   }
+ * }
+ * ```
+ */
+export interface SqliteStoreChange {
+    type: SqliteOperation['type'];
+    table: string;
+    keys: SqliteType[];
+    context: SqliteOperationContext;
+}
+export declare const sortedSchemaMigrations: Array<{
+    version: number;
+    sql: string;
+}>;
+export {};

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

@@ -1,10 +1,10 @@
-import type * as NimbusTypes from 'nimbus-types';
-export type { NimbusTypes };
-export type { NetworkAdapter, Request, Response, NetworkError, ObservabilityContext, } from './NetworkAdapter';
-export type { DraftQueue } from './DraftQueue';
-export type { SqliteStorePlugin, SqliteOperation } from './SqliteStorePlugin';
-export type { BinaryStorePlugin } from './BinaryStorePlugin';
-export type { InspectorPlugin } from './InspectorPlugin';
-export { sortedSchemaMigrations, isUpsertOperation } from './SqliteStorePlugin';
-export { JsSqliteStorePlugin } from './JsSqliteStorePlugin/JsSqliteStorePlugin';
-export { JsSqliteStoreWebWorkerPlugin } from './JsSqliteStorePlugin/JsWorkerSqliteStorePlugin';
+import type * as NimbusTypes from 'nimbus-types';
+export type { NimbusTypes };
+export type { NetworkAdapter, Request, Response, NetworkError, ObservabilityContext, } from './NetworkAdapter';
+export type { DraftQueue } from './DraftQueue';
+export type { SqliteStorePlugin, SqliteOperation } from './SqliteStorePlugin';
+export type { BinaryStorePlugin } from './BinaryStorePlugin';
+export type { InspectorPlugin } from './InspectorPlugin';
+export { sortedSchemaMigrations, isUpsertOperation } from './SqliteStorePlugin';
+export { JsSqliteStorePlugin } from './JsSqliteStorePlugin/JsSqliteStorePlugin';
+export { JsSqliteStoreWebWorkerPlugin } from './JsSqliteStorePlugin/JsWorkerSqliteStorePlugin';

package/dist/{mocks → types/mocks}/MockNimbusNetworkAdapter.d.ts

@@ -1,10 +1,10 @@
-import type { NetworkAdapter, NetworkError, Request, Response } from '../NetworkAdapter';
-export declare class MockNimbusNetworkAdapter implements NetworkAdapter {
-    private mockResponses;
-    sentRequests: Request[];
-    setMockResponse(mockResponse: Response): void;
-    setMockResponses(mockResponses: Response[]): void;
-    sendRequest(request: Request, onResponse: (response: Response) => void, onError: (error: NetworkError) => void): Promise<string>;
-    cancelRequest(_token: string): void;
-    setAsGlobalNimbusPlugin(): void;
-}
+import type { NetworkAdapter, NetworkError, Request, Response } from '../NetworkAdapter';
+export declare class MockNimbusNetworkAdapter implements NetworkAdapter {
+    private mockResponses;
+    sentRequests: Request[];
+    setMockResponse(mockResponse: Response): void;
+    setMockResponses(mockResponses: Response[]): void;
+    sendRequest(request: Request, onResponse: (response: Response) => void, onError: (error: NetworkError) => void): Promise<string>;
+    cancelRequest(_token: string): void;
+    setAsGlobalNimbusPlugin(): void;
+}

package/dist/{mocks → types/mocks}/index.d.ts

@@ -1 +1 @@
-export { MockNimbusNetworkAdapter } from './MockNimbusNetworkAdapter';
+export { MockNimbusNetworkAdapter } from './MockNimbusNetworkAdapter';

package/package.json

@@ -1,9 +1,9 @@
 {
     "name": "@salesforce/nimbus-plugin-lds",
-    "version": "1.124.2",
+    "version": "1.124.3",
     "license": "SEE LICENSE IN LICENSE.txt",
     "description": "Nimbus plugins for LDS on Mobile native integrations: durable store, networking, and draft queue.",
-    "types": "dist/index.d.ts",
+    "types": "dist/types/index.d.ts",
     "main": "dist/index.js",
     "module": "dist/index.js",
     "files": [
@@ -12,12 +12,12 @@
     ],
     "exports": {
         ".": {
-            "types": "./dist/index.d.ts",
+            "types": "./dist/types/index.d.ts",
             "import": "./dist/index.js",
             "default": "./dist/index.js"
         },
         "./mocks": {
-            "types": "./dist/mocks/index.d.ts",
+            "types": "./dist/types/index.d.ts",
             "import": "./dist/mocks/index.js",
             "default": "./dist/mocks/index.js"
         }