@salesforce/lds-runtime-mobile 1.342.0 → 1.343.0

package/dist/main.js

@@ -37,6 +37,7 @@ import formattingOptions from 'lightning/i18nCldrOptions';
 import ldsPrimingGraphqlBatch from '@salesforce/gate/lds.primingGraphqlBatch';
 import lmrPrimingUseSoql from '@salesforce/gate/lmr.primingUseSoql';
 import graphqlL2AdapterGate from '@salesforce/gate/lmr.graphqlL2Adapter';
+import productConsumedSideEffectsKillSwitch from '@salesforce/gate/com.salesforce.fieldservice.productConsumedSideEffectsKillSwitch';
 
 /**
  * Copyright (c) 2022, Salesforce, Inc.,
@@ -2764,13 +2765,6 @@ var DraftQueueOperationType;
     DraftQueueOperationType["ItemCompleted"] = "completed";
     DraftQueueOperationType["ItemFailed"] = "failed";
     DraftQueueOperationType["ItemUpdated"] = "updated";
-    /** @deprecated in 252. All Queue state changed events are consolidated in QueueStateChanged
-     * Planned to be removed in 256 (W-16217436) */
-    DraftQueueOperationType["QueueStarted"] = "started";
-    /** @deprecated in 252. All Queue state changed events are consolidated in QueueStateChanged
-     * Planned to be removed in 256 (W-16217436) */
-    DraftQueueOperationType["QueueStopped"] = "stopped";
-    /** @since 252 */
     DraftQueueOperationType["QueueStateChanged"] = "queueStateChanged";
 })(DraftQueueOperationType || (DraftQueueOperationType = {}));
 /**
@@ -2854,16 +2848,6 @@ class DraftManager {
                 throw Error('Unsupported event type');
         }
     }
-    draftQueueStateToOperationType(state) {
-        switch (state) {
-            case DraftQueueState.Started:
-                return DraftQueueOperationType.QueueStarted;
-            case DraftQueueState.Stopped:
-                return DraftQueueOperationType.QueueStopped;
-            default:
-                throw Error('Unsupported event type');
-        }
-    }
     /**
      * Enqueue a custom action on the DraftQueue for a handler
      * @param handler the handler's id
@@ -2925,8 +2909,7 @@ class DraftManager {
      *
      * @param listener The listener closure to subscribe to changes
      */
-    registerDraftQueueChangedListener(listener, version = undefined) {
-        this.listenerVersion = version;
+    registerDraftQueueChangedListener(listener, _version = undefined) {
         this.listeners.push(listener);
         return () => {
             this.listeners = this.listeners.filter((l) => {
@@ -3042,12 +3025,7 @@ class DraftManager {
         const managerState = await this.getQueue();
         let operationType, item;
         if (isDraftQueueStateChangeEvent(event)) {
-            if (this.listenerVersion === undefined) {
-                operationType = this.draftQueueStateToOperationType(event.state);
-            }
-            else {
-                operationType = DraftQueueOperationType.QueueStateChanged;
-            }
+            operationType = DraftQueueOperationType.QueueStateChanged;
         }
         else {
             const { action, type } = event;
@@ -44703,16 +44681,22 @@ function singlePredicateToSql(predicate, defaultAlias, isChildNotPredicate = fal
             }
         }
         else {
-            const { sql: questionSql, binding: valueBinding } = handleExtractedPredicateValue(boundValue, false);
-            // SQLite is case sensitive by default, SOQL is case in-sensitive by default
-            // For pick list includes or excludeds, prefix and suffix the field value with ';' to guarantee the query accuracy.
-            if (dataType === 'MultiPicklist' && (operator === 'LIKE' || operator === 'NOT LIKE')) {
-                sql = buildMultiPicklistSQL(predicate, valueBinding, questionSql);
+            if (value === null && dataType !== 'MultiPicklist') {
+                sql = `json_extract("${alias}".data, '${leftPath}') ${operator} NULL`;
             }
             else {
-                sql = `json_extract("${alias}".data, '${leftPath}') ${operator} ${questionSql}${isCaseSensitive === true ? '' : ` COLLATE NOCASE`}`;
+                const { sql: questionSql, binding: valueBinding } = handleExtractedPredicateValue(boundValue, false);
+                // SQLite is case sensitive by default, SOQL is case in-sensitive by default
+                // For pick list includes or excludeds, prefix and suffix the field value with ';' to guarantee the query accuracy.
+                if (dataType === 'MultiPicklist' &&
+                    (operator === 'LIKE' || operator === 'NOT LIKE')) {
+                    sql = buildMultiPicklistSQL(predicate, valueBinding, questionSql);
+                }
+                else {
+                    sql = `json_extract("${alias}".data, '${leftPath}') ${operator} ${questionSql}${isCaseSensitive === true ? '' : ` COLLATE NOCASE`}`;
+                }
+                binding.push(...valueBinding);
             }
-            binding.push(...valueBinding);
         }
     }
     return { sql, binding };
@@ -55102,10 +55086,18 @@ function isStoreRecordError(storeRecord) {
     return storeRecord.__type === 'error';
 }
 
-// SFS to implement custom side effects here
-// see packages/lds-runtime-mobile/src/__tests__/integration/sideEffects/examples/BananasSideEffects.ts for examples
-// see packages/lds-runtime-mobile/src/__tests__/integration/sideEffects/side-effect-integration.spec.ts for example tests
-var sfsSideEffectHooks = [];
+function createSfsSideEffectHooks(durableRecordStore) {
+    if (productConsumedSideEffectsKillSwitch.isOpen({ fallback: false })) {
+        return [];
+    }
+    return [
+    // SFS FSCore needs to implement code to bypass it's existing "side effect" code for Product Consumed.
+    // W-17683696 is the work that will enable the code below after FSCore's W-17422735 is completed.
+    // new ProductConsumedCreatedHook(),
+    // new ProductConsumedUpdatedHook(durableRecordStore),
+    // new ProductConsumedDeletedHook(durableRecordStore),
+    ];
+}
 
 // so eslint doesn't complain about nimbus
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -55187,7 +55179,7 @@ function getRuntime() {
         lazySideEffectService = new SideEffectService(lazyDurableRecordStore, lazyObjectInfoService, userId, formatDisplayValue);
         const draftService = new UiApiDraftRecordService(() => lazyLuvio, lazyDurableStore, lazyObjectInfoService, newRecordId, lazySideEffectStore, lazyDurableRecordStore);
         const uiApiRecordHandler = new UiApiActionHandler(() => lazyLuvio, lazyNetworkAdapter, lazyDraftQueue, getRecord, lazyObjectInfoService, isGenerated, draftService, lazySideEffectService, lazyDurableRecordStore);
-        uiApiRecordHandler.setSideEffectHooks(sfsSideEffectHooks);
+        uiApiRecordHandler.setSideEffectHooks(createSfsSideEffectHooks());
         const quickActionHandler = new QuickActionExecutionRepresentationHandler(() => lazyLuvio, draftService, lazyDraftQueue, lazyNetworkAdapter, isGenerated, lazySideEffectService, lazyObjectInfoService, getRecord);
         const updateRecordQuickActionHandler = new UpdateRecordQuickActionExecutionRepresentationHandler(() => lazyLuvio, draftService, lazyDraftQueue, lazyNetworkAdapter, isGenerated, lazySideEffectService);
         const contentDocumentCompositeActionHandler = new ContentDocumentCompositeRepresentationActionHandler(() => lazyLuvio, userId, draftService, lazyObjectInfoService, lazyDraftQueue, lazyNetworkAdapter, isGenerated, NimbusBinaryStore, lazySideEffectService);
@@ -55298,4 +55290,4 @@ register({
 });
 
 export { O11Y_NAMESPACE_LDS_MOBILE, getRuntime, ingest$1o as ingestDenormalizedRecordRepresentation, registerReportObserver, reportGraphqlQueryParseError };
-// version: 1.342.0-651bed9637
+// version: 1.343.0-f39f04aaf6

package/dist/types/sfs/ProductConsumedSideEffects.d.ts

@@ -0,0 +1,26 @@
+import { SideEffect } from '../drafts/sideEffects';
+import type { CreateSideEffectHook, DeleteSideEffectHook, UpdateSideEffectHook } from '../drafts/records/actionHandlers/SideEffectHook';
+import { DurableRecordStore } from '../durableStore/DurableRecordStore';
+export declare const instrumentation: import("o11y/dist/modules/o11y/client/interfaces").Instrumentation;
+export declare class ProductConsumedCreatedHook implements CreateSideEffectHook {
+    on: 'post';
+    apiName: string;
+    private static COUNTER_NAME;
+    then(draftActionId: string, draftActionTimestamp: number, _draftRecordId: string, fields: Record<string, any>): Promise<SideEffect[]>;
+}
+export declare class ProductConsumedUpdatedHook implements UpdateSideEffectHook {
+    private readonly durableRecordStore;
+    on: 'patch';
+    apiName: string;
+    private static COUNTER_NAME;
+    constructor(durableRecordStore: DurableRecordStore);
+    then(draftActionId: string, draftActionTimestamp: number, draftRecordId: string, fields: Record<string, any>): Promise<SideEffect[]>;
+}
+export declare class ProductConsumedDeletedHook implements DeleteSideEffectHook {
+    private readonly durableRecordStore;
+    on: 'delete';
+    apiName: string;
+    private static COUNTER_NAME;
+    constructor(durableRecordStore: DurableRecordStore);
+    then(draftActionId: string, draftActionTimestamp: number, draftRecordId: string): Promise<SideEffect[]>;
+}

package/dist/types/sfs/sfsCustomSideEffects.d.ts

@@ -1,3 +1,3 @@
+import { DurableRecordStore } from '../durableStore/DurableRecordStore';
 import type { SideEffectHook } from '../drafts/records/actionHandlers/SideEffectHook';
-declare const _default: SideEffectHook[];
-export default _default;
+export declare function createSfsSideEffectHooks(durableRecordStore: DurableRecordStore): SideEffectHook[];

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforce/lds-runtime-mobile",
-    "version": "1.342.0",
+    "version": "1.343.0",
     "license": "SEE LICENSE IN LICENSE.txt",
     "description": "LDS runtime for mobile/hybrid environments.",
     "main": "dist/main.js",
@@ -32,23 +32,23 @@
         "release:corejar": "yarn build && ../core-build/scripts/core.js --name=lds-runtime-mobile"
     },
     "dependencies": {
-        "@salesforce/lds-adapters-uiapi": "^1.342.0",
-        "@salesforce/lds-bindings": "^1.342.0",
-        "@salesforce/lds-instrumentation": "^1.342.0",
+        "@salesforce/lds-adapters-uiapi": "^1.343.0",
+        "@salesforce/lds-bindings": "^1.343.0",
+        "@salesforce/lds-instrumentation": "^1.343.0",
         "@salesforce/user": "0.0.21",
         "o11y": "250.7.0"
     },
     "devDependencies": {
-        "@salesforce/lds-adapters-graphql": "^1.342.0",
-        "@salesforce/lds-drafts": "^1.342.0",
-        "@salesforce/lds-durable-records": "^1.342.0",
-        "@salesforce/lds-network-adapter": "^1.342.0",
-        "@salesforce/lds-network-nimbus": "^1.342.0",
-        "@salesforce/lds-store-binary": "^1.342.0",
-        "@salesforce/lds-store-nimbus": "^1.342.0",
-        "@salesforce/lds-store-sql": "^1.342.0",
-        "@salesforce/lds-utils-adapters": "^1.342.0",
-        "@salesforce/nimbus-plugin-lds": "^1.342.0",
+        "@salesforce/lds-adapters-graphql": "^1.343.0",
+        "@salesforce/lds-drafts": "^1.343.0",
+        "@salesforce/lds-durable-records": "^1.343.0",
+        "@salesforce/lds-network-adapter": "^1.343.0",
+        "@salesforce/lds-network-nimbus": "^1.343.0",
+        "@salesforce/lds-store-binary": "^1.343.0",
+        "@salesforce/lds-store-nimbus": "^1.343.0",
+        "@salesforce/lds-store-sql": "^1.343.0",
+        "@salesforce/lds-utils-adapters": "^1.343.0",
+        "@salesforce/nimbus-plugin-lds": "^1.343.0",
         "babel-plugin-dynamic-import-node": "^2.3.3",
         "wait-for-expect": "^3.0.2"
     },

package/sfdc/main.js

@@ -37,6 +37,7 @@ import formattingOptions from 'lightning/i18nCldrOptions';
 import ldsPrimingGraphqlBatch from '@salesforce/gate/lds.primingGraphqlBatch';
 import lmrPrimingUseSoql from '@salesforce/gate/lmr.primingUseSoql';
 import graphqlL2AdapterGate from '@salesforce/gate/lmr.graphqlL2Adapter';
+import productConsumedSideEffectsKillSwitch from '@salesforce/gate/com.salesforce.fieldservice.productConsumedSideEffectsKillSwitch';
 
 /**
  * Copyright (c) 2022, Salesforce, Inc.,
@@ -2764,13 +2765,6 @@ var DraftQueueOperationType;
     DraftQueueOperationType["ItemCompleted"] = "completed";
     DraftQueueOperationType["ItemFailed"] = "failed";
     DraftQueueOperationType["ItemUpdated"] = "updated";
-    /** @deprecated in 252. All Queue state changed events are consolidated in QueueStateChanged
-     * Planned to be removed in 256 (W-16217436) */
-    DraftQueueOperationType["QueueStarted"] = "started";
-    /** @deprecated in 252. All Queue state changed events are consolidated in QueueStateChanged
-     * Planned to be removed in 256 (W-16217436) */
-    DraftQueueOperationType["QueueStopped"] = "stopped";
-    /** @since 252 */
     DraftQueueOperationType["QueueStateChanged"] = "queueStateChanged";
 })(DraftQueueOperationType || (DraftQueueOperationType = {}));
 /**
@@ -2854,16 +2848,6 @@ class DraftManager {
                 throw Error('Unsupported event type');
         }
     }
-    draftQueueStateToOperationType(state) {
-        switch (state) {
-            case DraftQueueState.Started:
-                return DraftQueueOperationType.QueueStarted;
-            case DraftQueueState.Stopped:
-                return DraftQueueOperationType.QueueStopped;
-            default:
-                throw Error('Unsupported event type');
-        }
-    }
     /**
      * Enqueue a custom action on the DraftQueue for a handler
      * @param handler the handler's id
@@ -2925,8 +2909,7 @@ class DraftManager {
      *
      * @param listener The listener closure to subscribe to changes
      */
-    registerDraftQueueChangedListener(listener, version = undefined) {
-        this.listenerVersion = version;
+    registerDraftQueueChangedListener(listener, _version = undefined) {
         this.listeners.push(listener);
         return () => {
             this.listeners = this.listeners.filter((l) => {
@@ -3042,12 +3025,7 @@ class DraftManager {
         const managerState = await this.getQueue();
         let operationType, item;
         if (isDraftQueueStateChangeEvent(event)) {
-            if (this.listenerVersion === undefined) {
-                operationType = this.draftQueueStateToOperationType(event.state);
-            }
-            else {
-                operationType = DraftQueueOperationType.QueueStateChanged;
-            }
+            operationType = DraftQueueOperationType.QueueStateChanged;
         }
         else {
             const { action, type } = event;
@@ -44703,16 +44681,22 @@ function singlePredicateToSql(predicate, defaultAlias, isChildNotPredicate = fal
             }
         }
         else {
-            const { sql: questionSql, binding: valueBinding } = handleExtractedPredicateValue(boundValue, false);
-            // SQLite is case sensitive by default, SOQL is case in-sensitive by default
-            // For pick list includes or excludeds, prefix and suffix the field value with ';' to guarantee the query accuracy.
-            if (dataType === 'MultiPicklist' && (operator === 'LIKE' || operator === 'NOT LIKE')) {
-                sql = buildMultiPicklistSQL(predicate, valueBinding, questionSql);
+            if (value === null && dataType !== 'MultiPicklist') {
+                sql = `json_extract("${alias}".data, '${leftPath}') ${operator} NULL`;
             }
             else {
-                sql = `json_extract("${alias}".data, '${leftPath}') ${operator} ${questionSql}${isCaseSensitive === true ? '' : ` COLLATE NOCASE`}`;
+                const { sql: questionSql, binding: valueBinding } = handleExtractedPredicateValue(boundValue, false);
+                // SQLite is case sensitive by default, SOQL is case in-sensitive by default
+                // For pick list includes or excludeds, prefix and suffix the field value with ';' to guarantee the query accuracy.
+                if (dataType === 'MultiPicklist' &&
+                    (operator === 'LIKE' || operator === 'NOT LIKE')) {
+                    sql = buildMultiPicklistSQL(predicate, valueBinding, questionSql);
+                }
+                else {
+                    sql = `json_extract("${alias}".data, '${leftPath}') ${operator} ${questionSql}${isCaseSensitive === true ? '' : ` COLLATE NOCASE`}`;
+                }
+                binding.push(...valueBinding);
             }
-            binding.push(...valueBinding);
         }
     }
     return { sql, binding };
@@ -55102,10 +55086,18 @@ function isStoreRecordError(storeRecord) {
     return storeRecord.__type === 'error';
 }
 
-// SFS to implement custom side effects here
-// see packages/lds-runtime-mobile/src/__tests__/integration/sideEffects/examples/BananasSideEffects.ts for examples
-// see packages/lds-runtime-mobile/src/__tests__/integration/sideEffects/side-effect-integration.spec.ts for example tests
-var sfsSideEffectHooks = [];
+function createSfsSideEffectHooks(durableRecordStore) {
+    if (productConsumedSideEffectsKillSwitch.isOpen({ fallback: false })) {
+        return [];
+    }
+    return [
+    // SFS FSCore needs to implement code to bypass it's existing "side effect" code for Product Consumed.
+    // W-17683696 is the work that will enable the code below after FSCore's W-17422735 is completed.
+    // new ProductConsumedCreatedHook(),
+    // new ProductConsumedUpdatedHook(durableRecordStore),
+    // new ProductConsumedDeletedHook(durableRecordStore),
+    ];
+}
 
 // so eslint doesn't complain about nimbus
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -55187,7 +55179,7 @@ function getRuntime() {
         lazySideEffectService = new SideEffectService(lazyDurableRecordStore, lazyObjectInfoService, userId, formatDisplayValue);
         const draftService = new UiApiDraftRecordService(() => lazyLuvio, lazyDurableStore, lazyObjectInfoService, newRecordId, lazySideEffectStore, lazyDurableRecordStore);
         const uiApiRecordHandler = new UiApiActionHandler(() => lazyLuvio, lazyNetworkAdapter, lazyDraftQueue, getRecord, lazyObjectInfoService, isGenerated, draftService, lazySideEffectService, lazyDurableRecordStore);
-        uiApiRecordHandler.setSideEffectHooks(sfsSideEffectHooks);
+        uiApiRecordHandler.setSideEffectHooks(createSfsSideEffectHooks());
         const quickActionHandler = new QuickActionExecutionRepresentationHandler(() => lazyLuvio, draftService, lazyDraftQueue, lazyNetworkAdapter, isGenerated, lazySideEffectService, lazyObjectInfoService, getRecord);
         const updateRecordQuickActionHandler = new UpdateRecordQuickActionExecutionRepresentationHandler(() => lazyLuvio, draftService, lazyDraftQueue, lazyNetworkAdapter, isGenerated, lazySideEffectService);
         const contentDocumentCompositeActionHandler = new ContentDocumentCompositeRepresentationActionHandler(() => lazyLuvio, userId, draftService, lazyObjectInfoService, lazyDraftQueue, lazyNetworkAdapter, isGenerated, NimbusBinaryStore, lazySideEffectService);
@@ -55298,4 +55290,4 @@ register({
 });
 
 export { O11Y_NAMESPACE_LDS_MOBILE, getRuntime, ingest$1o as ingestDenormalizedRecordRepresentation, registerReportObserver, reportGraphqlQueryParseError };
-// version: 1.342.0-651bed9637
+// version: 1.343.0-f39f04aaf6

package/sfdc/types/sfs/ProductConsumedSideEffects.d.ts

@@ -0,0 +1,26 @@
+import { SideEffect } from '../drafts/sideEffects';
+import type { CreateSideEffectHook, DeleteSideEffectHook, UpdateSideEffectHook } from '../drafts/records/actionHandlers/SideEffectHook';
+import { DurableRecordStore } from '../durableStore/DurableRecordStore';
+export declare const instrumentation: import("o11y/dist/modules/o11y/client/interfaces").Instrumentation;
+export declare class ProductConsumedCreatedHook implements CreateSideEffectHook {
+    on: 'post';
+    apiName: string;
+    private static COUNTER_NAME;
+    then(draftActionId: string, draftActionTimestamp: number, _draftRecordId: string, fields: Record<string, any>): Promise<SideEffect[]>;
+}
+export declare class ProductConsumedUpdatedHook implements UpdateSideEffectHook {
+    private readonly durableRecordStore;
+    on: 'patch';
+    apiName: string;
+    private static COUNTER_NAME;
+    constructor(durableRecordStore: DurableRecordStore);
+    then(draftActionId: string, draftActionTimestamp: number, draftRecordId: string, fields: Record<string, any>): Promise<SideEffect[]>;
+}
+export declare class ProductConsumedDeletedHook implements DeleteSideEffectHook {
+    private readonly durableRecordStore;
+    on: 'delete';
+    apiName: string;
+    private static COUNTER_NAME;
+    constructor(durableRecordStore: DurableRecordStore);
+    then(draftActionId: string, draftActionTimestamp: number, draftRecordId: string): Promise<SideEffect[]>;
+}

package/sfdc/types/sfs/sfsCustomSideEffects.d.ts

@@ -1,3 +1,3 @@
+import { DurableRecordStore } from '../durableStore/DurableRecordStore';
 import type { SideEffectHook } from '../drafts/records/actionHandlers/SideEffectHook';
-declare const _default: SideEffectHook[];
-export default _default;
+export declare function createSfsSideEffectHooks(durableRecordStore: DurableRecordStore): SideEffectHook[];