@salesforce/lds-runtime-mobile 1.118.0 → 1.119.1

package/dist/__mocks__/o11y/client.d.ts

@@ -1,5 +1,5 @@
-import type { Instrumentation } from 'o11y/client';
+import { instrumentation } from './instrumentation';
 export { activity } from './activity';
 export { instrumentation } from './instrumentation';
 export { idleDetector } from './idleDetector';
-export declare function getInstrumentation(_name: string): Instrumentation;
+export declare function getInstrumentation(_name: string): typeof instrumentation;

package/dist/instrumentation/instrumentDraftQueue.d.ts

@@ -1,2 +1,5 @@
 import type { DraftQueue } from '@salesforce/lds-drafts';
-export declare function instrumentDraftQueue(queue: DraftQueue): void;
+/**
+ * A HOF that returns an instrumented DraftQueue
+ */
+export declare function instrumentDraftQueue(queue: DraftQueue): DraftQueue;

package/dist/instrumentation/metrics.d.ts

@@ -1,4 +1,6 @@
 export declare const O11Y_NAMESPACE_LDS_MOBILE = "lds-mobile";
+export declare const DRAFT_QUEUE_TOTAL_MERGE_ACTIONS_CALLS = "draft-queue-total-mergeActions-calls";
+export declare const ldsMobileInstrumentation: import("o11y/dist/modules/o11y/client/interfaces").Instrumentation;
 export declare function reportGraphqlQueryParseError(err: unknown): void;
 export declare function reportGraphqlSqlEvalPreconditionError(err: unknown): void;
 export declare function reportGraphqlCreateSnapshotError(err: unknown): void;
@@ -6,7 +8,7 @@ export declare function reportGraphQlEvalDbReadDuration(duration: number): void;
 export declare function reportGraphqlAdapterError(errorCode: string): void;
 export declare function reportDraftActionEvent(state: 'added' | 'completed' | 'deleted' | 'updated' | 'failed'): void;
 export declare function reportDraftQueueState(state: 'started' | 'error' | 'waiting' | 'stopped'): void;
-export declare function reportDraftAwareContentDocumentVersionSythensizeError(err: unknown): void;
+export declare function reportDraftAwareContentDocumentVersionSynthesizeError(err: unknown): void;
 export declare function reportDraftAwareContentVersionSynthesizeCalls(mimeType: string): void;
 /** Priming */
 export declare function reportPrimingSessionCreated(): void;

package/dist/instrumentation/withInstrumentation.d.ts

@@ -1,12 +1,12 @@
-type Operation = () => Promise<any>;
 export type WithInstrumentation = (operation: () => Promise<any>, config: InstrumentationConfig) => Promise<any>;
 export interface InstrumentationConfig {
     tags: Record<string, string>;
     metricName: string;
+    logError: boolean;
 }
 /**
- * Higher order function that instruments any async operation
- *
+ * HOF (high-order-function) that instruments any async operation.  If the operation
+ * has an error then the hasError param will be set on the call to o11y.incrementCounter
+ * and an "errorMessage" tag containing the Error.message will be added to the tags.
  */
-export declare const withInstrumentation: (operation: Operation, config?: InstrumentationConfig) => Promise<any>;
-export {};
+export declare const withInstrumentation: <T>(operation: () => Promise<T>, config?: InstrumentationConfig) => Promise<T>;

package/dist/main.js

@@ -4346,54 +4346,27 @@ function makeStoreEval(preconditioner, objectInfoService, userId, contextProvide
  * For full license text, see the LICENSE.txt file
  */
 
-/* Ideally we would use AbortController but it does not exist in V8, if it is ever polyfilled we can swap for it */
+/* Ideally we would use AbortController but it does not exist in V8, this is a simplified version */
 class LdsAbortController {
-    constructor() {
-        this.signal = new AbortSignal();
-    }
-    abort() {
-        this.signal.abort();
-    }
-}
-class AbortSignal {
     constructor() {
         this._aborted = false;
-        this.listeners = new Map();
+        this.listeners = new Set();
     }
     get aborted() {
         return this._aborted;
     }
-    addEventListener(type, listener) {
-        let listeners = this.listeners.get(type);
-        if (!listeners) {
-            listeners = new Set();
-            this.listeners.set(type, listeners);
-        }
-        listeners.add(listener);
-    }
-    removeEventListener(type, listener) {
-        const listeners = this.listeners.get(type);
-        if (listeners) {
-            listeners.delete(listener);
-            if (listeners.size === 0) {
-                this.listeners.delete(type);
-            }
-        }
+    addEventListener(listener) {
+        this.listeners.add(listener);
     }
-    dispatchEvent(event) {
-        const listeners = this.listeners.get(event.type);
-        if (listeners) {
-            for (const listener of listeners) {
-                listener(this, event);
-            }
-        }
-        return !event.defaultPrevented;
+    removeEventListener(listener) {
+        this.listeners.delete(listener);
     }
     abort() {
         if (!this.aborted) {
             this._aborted = true;
-            const abortEvent = new Event('abort');
-            this.dispatchEvent(abortEvent);
+            for (const listener of this.listeners) {
+                listener();
+            }
         }
     }
 }
@@ -14007,8 +13980,9 @@ const DRAFT_QUEUE_ACTION_COMPLETED = 'draft-queue-action-completed';
 const DRAFT_QUEUE_ACTION_DELETED = 'draft-queue-action-deleted';
 const DRAFT_QUEUE_ACTION_UPDATED = 'draft-queue-action-updated';
 const DRAFT_QUEUE_ACTION_FAILED = 'draft-queue-action-failed';
+const DRAFT_QUEUE_TOTAL_MERGE_ACTIONS_CALLS = 'draft-queue-total-mergeActions-calls';
 /** Content Document */
-const CREATE_CONTENT_DOCUMENT_AND_VERSION_TOTAL_SYNTHESIZE_CALLS = 'content-document-version-total-sythesize-calls';
+const CREATE_CONTENT_DOCUMENT_AND_VERSION_TOTAL_SYNTHESIZE_CALLS = 'content-document-version-total-synthesize-calls';
 const CREATE_CONTENT_DOCUMENT_AND_VERSION_DRAFT_SYNTHESIZE_ERROR = 'create-content-document-version-draft-synthesize-error';
 /** Priming */
 const PRIMING_TOTAL_SESSION_COUNT = 'priming-total-session-count';
@@ -14086,7 +14060,7 @@ function reportDraftQueueState(state) {
             break;
     }
 }
-function reportDraftAwareContentDocumentVersionSythensizeError(err) {
+function reportDraftAwareContentDocumentVersionSynthesizeError(err) {
     let error;
     if (err.body !== undefined) {
         error = err.body;
@@ -14123,6 +14097,36 @@ function reportPrimingSuccess(recordCount) {
     ldsMobileInstrumentation.incrementCounter(PRIMING_TOTAL_PRIMED_COUNT, recordCount, undefined);
 }
 
+/**
+ * HOF (high-order-function) that instruments any async operation.  If the operation
+ * has an error then the hasError param will be set on the call to o11y.incrementCounter
+ * and an "errorMessage" tag containing the Error.message will be added to the tags.
+ */
+const withInstrumentation = (operation, config) => {
+    if (config === undefined) {
+        // No instrumentation is needed for the method. Return as is.
+        return operation();
+    }
+    const { tags, metricName, logError } = config;
+    let hasError = false;
+    return operation()
+        .catch((err) => {
+        hasError = true;
+        const error = normalizeError(err);
+        tags['errorMessage'] = error.message;
+        if (logError) {
+            ldsMobileInstrumentation.error(error);
+        }
+        throw err;
+    })
+        .finally(() => {
+        ldsMobileInstrumentation.incrementCounter(metricName, 1, hasError, tags);
+    });
+};
+
+/**
+ * A HOF that returns an instrumented DraftQueue
+ */
 function instrumentDraftQueue(queue) {
     queue.registerOnChangedListener((draftQueueEvent) => {
         switch (draftQueueEvent.type) {
@@ -14160,6 +14164,14 @@ function instrumentDraftQueue(queue) {
         }
         return Promise.resolve();
     });
+    const mergeActions = function (targetActionId, sourceActionId) {
+        return withInstrumentation(() => queue.mergeActions(targetActionId, sourceActionId), {
+            metricName: DRAFT_QUEUE_TOTAL_MERGE_ACTIONS_CALLS,
+            tags: {},
+            logError: false,
+        });
+    };
+    return create(queue, { mergeActions: { value: mergeActions } });
 }
 
 // so eslint doesn't complain about nimbus
@@ -14170,8 +14182,7 @@ function buildLdsDraftQueue(durableStore) {
         return new NimbusDraftQueue();
     }
     const draftQueue = new DurableDraftQueue(new DurableDraftStore(durableStore));
-    instrumentDraftQueue(draftQueue);
-    return draftQueue;
+    return instrumentDraftQueue(draftQueue);
 }
 
 /**
@@ -14400,7 +14411,7 @@ function instrumentContentDocumentVersionAdapter(adapter) {
                 const { data } = customEvent;
                 switch (data.type) {
                     case 'create-content-document-and-version-synthesized-response-error':
-                        reportDraftAwareContentDocumentVersionSythensizeError(data.error);
+                        reportDraftAwareContentDocumentVersionSynthesizeError(data.error);
                         break;
                     case 'create-content-document-and-version-synthesize-response-start': {
                         reportDraftAwareContentVersionSynthesizeCalls(data.mimeType);
@@ -15063,7 +15074,7 @@ class PrimingSession extends EventEmitter {
                     return this.recordLoader
                         .fetchRecordData(batch, abortController)
                         .then(async (result) => {
-                        if (abortController.signal.aborted) {
+                        if (abortController.aborted) {
                             return;
                         }
                         this.emit('batch-fetched', {
@@ -15102,7 +15113,7 @@ class PrimingSession extends EventEmitter {
                                     .reduce((a, b) => a.concat(b), []),
                                 duration: Date.now() - beforeWrite,
                             });
-                            if (abortController.signal.aborted) {
+                            if (abortController.aborted) {
                                 return;
                             }
                             if (errors.length > 0) {
@@ -15356,7 +15367,7 @@ class NimbusPrimingNetworkAdapter {
             let listener;
             const unregisterListener = () => {
                 if (listener) {
-                    abortController.signal.removeEventListener('abort', listener);
+                    abortController.removeEventListener(listener);
                 }
             };
             __nimbus.plugins.LdsNetworkAdapter
@@ -15388,7 +15399,7 @@ class NimbusPrimingNetworkAdapter {
                 listener = () => {
                     __nimbus.plugins.LdsNetworkAdapter.cancelRequest(cancellationToken);
                 };
-                abortController.signal.addEventListener('abort', listener);
+                abortController.addEventListener(listener);
             });
         });
     }
@@ -15611,4 +15622,4 @@ register({
 });
 
 export { getRuntime, registerReportObserver, reportGraphqlQueryParseError };
-// version: 1.118.0-ad6b2cf1f
+// version: 1.119.1-91ad6f5b7

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforce/lds-runtime-mobile",
-    "version": "1.118.0",
+    "version": "1.119.1",
     "license": "SEE LICENSE IN LICENSE.txt",
     "description": "LDS runtime for mobile/hybrid environments.",
     "main": "dist/main.js",

package/sfdc/__mocks__/o11y/client.d.ts

@@ -1,5 +1,5 @@
-import type { Instrumentation } from 'o11y/client';
+import { instrumentation } from './instrumentation';
 export { activity } from './activity';
 export { instrumentation } from './instrumentation';
 export { idleDetector } from './idleDetector';
-export declare function getInstrumentation(_name: string): Instrumentation;
+export declare function getInstrumentation(_name: string): typeof instrumentation;

package/sfdc/instrumentation/instrumentDraftQueue.d.ts

@@ -1,2 +1,5 @@
 import type { DraftQueue } from '@salesforce/lds-drafts';
-export declare function instrumentDraftQueue(queue: DraftQueue): void;
+/**
+ * A HOF that returns an instrumented DraftQueue
+ */
+export declare function instrumentDraftQueue(queue: DraftQueue): DraftQueue;

package/sfdc/instrumentation/metrics.d.ts

@@ -1,4 +1,6 @@
 export declare const O11Y_NAMESPACE_LDS_MOBILE = "lds-mobile";
+export declare const DRAFT_QUEUE_TOTAL_MERGE_ACTIONS_CALLS = "draft-queue-total-mergeActions-calls";
+export declare const ldsMobileInstrumentation: import("o11y/dist/modules/o11y/client/interfaces").Instrumentation;
 export declare function reportGraphqlQueryParseError(err: unknown): void;
 export declare function reportGraphqlSqlEvalPreconditionError(err: unknown): void;
 export declare function reportGraphqlCreateSnapshotError(err: unknown): void;
@@ -6,7 +8,7 @@ export declare function reportGraphQlEvalDbReadDuration(duration: number): void;
 export declare function reportGraphqlAdapterError(errorCode: string): void;
 export declare function reportDraftActionEvent(state: 'added' | 'completed' | 'deleted' | 'updated' | 'failed'): void;
 export declare function reportDraftQueueState(state: 'started' | 'error' | 'waiting' | 'stopped'): void;
-export declare function reportDraftAwareContentDocumentVersionSythensizeError(err: unknown): void;
+export declare function reportDraftAwareContentDocumentVersionSynthesizeError(err: unknown): void;
 export declare function reportDraftAwareContentVersionSynthesizeCalls(mimeType: string): void;
 /** Priming */
 export declare function reportPrimingSessionCreated(): void;

package/sfdc/instrumentation/withInstrumentation.d.ts

@@ -1,12 +1,12 @@
-type Operation = () => Promise<any>;
 export type WithInstrumentation = (operation: () => Promise<any>, config: InstrumentationConfig) => Promise<any>;
 export interface InstrumentationConfig {
     tags: Record<string, string>;
     metricName: string;
+    logError: boolean;
 }
 /**
- * Higher order function that instruments any async operation
- *
+ * HOF (high-order-function) that instruments any async operation.  If the operation
+ * has an error then the hasError param will be set on the call to o11y.incrementCounter
+ * and an "errorMessage" tag containing the Error.message will be added to the tags.
  */
-export declare const withInstrumentation: (operation: Operation, config?: InstrumentationConfig) => Promise<any>;
-export {};
+export declare const withInstrumentation: <T>(operation: () => Promise<T>, config?: InstrumentationConfig) => Promise<T>;

package/sfdc/main.js

@@ -4346,54 +4346,27 @@ function makeStoreEval(preconditioner, objectInfoService, userId, contextProvide
  * For full license text, see the LICENSE.txt file
  */
 
-/* Ideally we would use AbortController but it does not exist in V8, if it is ever polyfilled we can swap for it */
+/* Ideally we would use AbortController but it does not exist in V8, this is a simplified version */
 class LdsAbortController {
-    constructor() {
-        this.signal = new AbortSignal();
-    }
-    abort() {
-        this.signal.abort();
-    }
-}
-class AbortSignal {
     constructor() {
         this._aborted = false;
-        this.listeners = new Map();
+        this.listeners = new Set();
     }
     get aborted() {
         return this._aborted;
     }
-    addEventListener(type, listener) {
-        let listeners = this.listeners.get(type);
-        if (!listeners) {
-            listeners = new Set();
-            this.listeners.set(type, listeners);
-        }
-        listeners.add(listener);
-    }
-    removeEventListener(type, listener) {
-        const listeners = this.listeners.get(type);
-        if (listeners) {
-            listeners.delete(listener);
-            if (listeners.size === 0) {
-                this.listeners.delete(type);
-            }
-        }
+    addEventListener(listener) {
+        this.listeners.add(listener);
     }
-    dispatchEvent(event) {
-        const listeners = this.listeners.get(event.type);
-        if (listeners) {
-            for (const listener of listeners) {
-                listener(this, event);
-            }
-        }
-        return !event.defaultPrevented;
+    removeEventListener(listener) {
+        this.listeners.delete(listener);
     }
     abort() {
         if (!this.aborted) {
             this._aborted = true;
-            const abortEvent = new Event('abort');
-            this.dispatchEvent(abortEvent);
+            for (const listener of this.listeners) {
+                listener();
+            }
         }
     }
 }
@@ -14007,8 +13980,9 @@ const DRAFT_QUEUE_ACTION_COMPLETED = 'draft-queue-action-completed';
 const DRAFT_QUEUE_ACTION_DELETED = 'draft-queue-action-deleted';
 const DRAFT_QUEUE_ACTION_UPDATED = 'draft-queue-action-updated';
 const DRAFT_QUEUE_ACTION_FAILED = 'draft-queue-action-failed';
+const DRAFT_QUEUE_TOTAL_MERGE_ACTIONS_CALLS = 'draft-queue-total-mergeActions-calls';
 /** Content Document */
-const CREATE_CONTENT_DOCUMENT_AND_VERSION_TOTAL_SYNTHESIZE_CALLS = 'content-document-version-total-sythesize-calls';
+const CREATE_CONTENT_DOCUMENT_AND_VERSION_TOTAL_SYNTHESIZE_CALLS = 'content-document-version-total-synthesize-calls';
 const CREATE_CONTENT_DOCUMENT_AND_VERSION_DRAFT_SYNTHESIZE_ERROR = 'create-content-document-version-draft-synthesize-error';
 /** Priming */
 const PRIMING_TOTAL_SESSION_COUNT = 'priming-total-session-count';
@@ -14086,7 +14060,7 @@ function reportDraftQueueState(state) {
             break;
     }
 }
-function reportDraftAwareContentDocumentVersionSythensizeError(err) {
+function reportDraftAwareContentDocumentVersionSynthesizeError(err) {
     let error;
     if (err.body !== undefined) {
         error = err.body;
@@ -14123,6 +14097,36 @@ function reportPrimingSuccess(recordCount) {
     ldsMobileInstrumentation.incrementCounter(PRIMING_TOTAL_PRIMED_COUNT, recordCount, undefined);
 }
 
+/**
+ * HOF (high-order-function) that instruments any async operation.  If the operation
+ * has an error then the hasError param will be set on the call to o11y.incrementCounter
+ * and an "errorMessage" tag containing the Error.message will be added to the tags.
+ */
+const withInstrumentation = (operation, config) => {
+    if (config === undefined) {
+        // No instrumentation is needed for the method. Return as is.
+        return operation();
+    }
+    const { tags, metricName, logError } = config;
+    let hasError = false;
+    return operation()
+        .catch((err) => {
+        hasError = true;
+        const error = normalizeError(err);
+        tags['errorMessage'] = error.message;
+        if (logError) {
+            ldsMobileInstrumentation.error(error);
+        }
+        throw err;
+    })
+        .finally(() => {
+        ldsMobileInstrumentation.incrementCounter(metricName, 1, hasError, tags);
+    });
+};
+
+/**
+ * A HOF that returns an instrumented DraftQueue
+ */
 function instrumentDraftQueue(queue) {
     queue.registerOnChangedListener((draftQueueEvent) => {
         switch (draftQueueEvent.type) {
@@ -14160,6 +14164,14 @@ function instrumentDraftQueue(queue) {
         }
         return Promise.resolve();
     });
+    const mergeActions = function (targetActionId, sourceActionId) {
+        return withInstrumentation(() => queue.mergeActions(targetActionId, sourceActionId), {
+            metricName: DRAFT_QUEUE_TOTAL_MERGE_ACTIONS_CALLS,
+            tags: {},
+            logError: false,
+        });
+    };
+    return create(queue, { mergeActions: { value: mergeActions } });
 }
 
 // so eslint doesn't complain about nimbus
@@ -14170,8 +14182,7 @@ function buildLdsDraftQueue(durableStore) {
         return new NimbusDraftQueue();
     }
     const draftQueue = new DurableDraftQueue(new DurableDraftStore(durableStore));
-    instrumentDraftQueue(draftQueue);
-    return draftQueue;
+    return instrumentDraftQueue(draftQueue);
 }
 
 /**
@@ -14400,7 +14411,7 @@ function instrumentContentDocumentVersionAdapter(adapter) {
                 const { data } = customEvent;
                 switch (data.type) {
                     case 'create-content-document-and-version-synthesized-response-error':
-                        reportDraftAwareContentDocumentVersionSythensizeError(data.error);
+                        reportDraftAwareContentDocumentVersionSynthesizeError(data.error);
                         break;
                     case 'create-content-document-and-version-synthesize-response-start': {
                         reportDraftAwareContentVersionSynthesizeCalls(data.mimeType);
@@ -15063,7 +15074,7 @@ class PrimingSession extends EventEmitter {
                     return this.recordLoader
                         .fetchRecordData(batch, abortController)
                         .then(async (result) => {
-                        if (abortController.signal.aborted) {
+                        if (abortController.aborted) {
                             return;
                         }
                         this.emit('batch-fetched', {
@@ -15102,7 +15113,7 @@ class PrimingSession extends EventEmitter {
                                     .reduce((a, b) => a.concat(b), []),
                                 duration: Date.now() - beforeWrite,
                             });
-                            if (abortController.signal.aborted) {
+                            if (abortController.aborted) {
                                 return;
                             }
                             if (errors.length > 0) {
@@ -15356,7 +15367,7 @@ class NimbusPrimingNetworkAdapter {
             let listener;
             const unregisterListener = () => {
                 if (listener) {
-                    abortController.signal.removeEventListener('abort', listener);
+                    abortController.removeEventListener(listener);
                 }
             };
             __nimbus.plugins.LdsNetworkAdapter
@@ -15388,7 +15399,7 @@ class NimbusPrimingNetworkAdapter {
                 listener = () => {
                     __nimbus.plugins.LdsNetworkAdapter.cancelRequest(cancellationToken);
                 };
-                abortController.signal.addEventListener('abort', listener);
+                abortController.addEventListener(listener);
             });
         });
     }
@@ -15611,4 +15622,4 @@ register({
 });
 
 export { getRuntime, registerReportObserver, reportGraphqlQueryParseError };
-// version: 1.118.0-ad6b2cf1f
+// version: 1.119.1-91ad6f5b7