@salesforce/lds-worker-api 1.100.2

package/dist/standalone/umd/lightningAdapterApi.d.ts

@@ -0,0 +1,11 @@
+import type { ImperativeAdapter } from '@salesforce/lds-bindings';
+import type { Adapter } from '@luvio/engine';
+import * as gqlApi from 'force/ldsAdaptersGraphql';
+export declare const IMPERATIVE_ADAPTER_SUFFIX = "_imperative";
+export declare const UNSTABLE_ADAPTER_PREFIX = "unstable_";
+type AdapterMapValue = Adapter<unknown, unknown> | ImperativeAdapter<unknown, unknown> | undefined;
+type ImperativeAdapterMapValue = ImperativeAdapter<unknown, unknown> | undefined;
+declare function getDMLAdapterFromName(name: string): AdapterMapValue;
+declare function getImperativeAdapterFromName(name: string): ImperativeAdapterMapValue;
+declare function getImperativeAdapterNames(): string[];
+export { getImperativeAdapterFromName, getDMLAdapterFromName, getImperativeAdapterNames, gqlApi };

package/dist/standalone/umd/main.d.ts

@@ -0,0 +1,8 @@
+import { subscribeToAdapter, invokeAdapter, invokeAdapterWithMetadata, invokeAdapterWithDraftToReplace, executeAdapter, executeMutatingAdapter } from './executeAdapter';
+import { getImperativeAdapterNames } from './lightningAdapterApi';
+import { nimbusDraftQueue } from './nimbusDraftQueue';
+import { draftQueue, draftManager } from './draftQueueImplementation';
+import { setUiApiRecordTTL, setMetadataTTL } from './ttl';
+import { registerReportObserver } from '@salesforce/lds-runtime-mobile';
+import { createPrimingSession } from './primingApi';
+export { subscribeToAdapter, invokeAdapter, invokeAdapterWithMetadata, invokeAdapterWithDraftToReplace, executeAdapter, executeMutatingAdapter, nimbusDraftQueue, draftQueue, draftManager, setUiApiRecordTTL, setMetadataTTL, registerReportObserver, getImperativeAdapterNames, createPrimingSession, };

package/dist/standalone/umd/nimbusDraftQueue.d.ts

@@ -0,0 +1,6 @@
+import type { DraftQueue as NimbusDraftQueue } from '@salesforce/nimbus-plugin-lds';
+/**
+ * Implements the DraftQueue interface from nimbus-plugin-lds by passing requests
+ * to the instance of the lds-drafts' DraftQueue implementation
+ */
+export declare const nimbusDraftQueue: NimbusDraftQueue;

package/dist/standalone/umd/primingApi.d.ts

@@ -0,0 +1,19 @@
+interface PrimingError {
+    ids: string[];
+    code: ErrorCode;
+    message: string;
+}
+type ErrorCode = 'precondition-error' | 'not-found' | 'service-unavailable' | 'unknown';
+interface PrimingEventHandler {
+    onError?: (error: PrimingError) => void;
+    onPrimed?: (ids: string[]) => void;
+}
+export interface PrimingSessionConfig {
+    primingEventHandler?: PrimingEventHandler;
+    concurrency?: number;
+    batchSize?: number;
+}
+export declare function createPrimingSession(config: PrimingSessionConfig): {
+    enqueue: (work: PrimingWork) => Promise<void>;
+};
+export {};

package/dist/standalone/umd/responses.d.ts

@@ -0,0 +1,44 @@
+import type { FetchResponse, FetchErrorResponse, Headers, AdapterErrorResponse, NetworkAdapterErrorResponse } from '@luvio/engine';
+import { HttpStatusCode } from '@luvio/engine';
+export declare const NATIVE_ERROR_CODE = "NATIVE_ERROR";
+export declare const NON_MUTATING_ADAPTER_MESSAGE = "adapterId must be a mutating adapter";
+export declare const NO_DRAFT_CREATED_MESSAGE = "the adapter did not generate a draft";
+export declare const DRAFT_DOESNT_EXIST_MESSAGE = "the specified draft does not exist";
+/**
+ * Error objects don't serialize well over the js-native wire, so our class turns
+ * an Error into an object that serializes real nice
+ */
+export declare class NativeNetworkAdapterErrorResponse implements NetworkAdapterErrorResponse {
+    message: string;
+    name: string;
+    errorType: NetworkAdapterErrorResponse['errorType'];
+    constructor(error: NetworkAdapterErrorResponse);
+}
+export declare class NativeAdapterErrorResponse implements AdapterErrorResponse {
+    errorType: AdapterErrorResponse['errorType'];
+    error: unknown;
+    constructor(error: AdapterErrorResponse);
+}
+/**
+ * NativeErrorResponse is the native version of Luvio's ErrorResponse type.
+ *
+ * It is either a non-ok http response or an Error.  It has a discriminator property
+ * "errorType" to distinguish between the two types of errors.
+ */
+export type NativeErrorResponse = NativeFetchErrorResponse | NativeNetworkAdapterErrorResponse | NativeAdapterErrorResponse;
+export declare class NativeFetchResponse<T> implements FetchResponse<T> {
+    status: HttpStatusCode;
+    body: T;
+    headers: Headers;
+    constructor(status: HttpStatusCode, body: T);
+    get statusText(): string;
+    get ok(): boolean;
+}
+export declare class NativeFetchErrorResponse extends NativeFetchResponse<unknown> implements FetchErrorResponse {
+    errorType: FetchErrorResponse['errorType'];
+}
+export declare function createNativeFetchErrorResponse(message: string): NativeFetchErrorResponse;
+/**
+ * This function takes an unknown error and normalizes it to an Error object
+ */
+export declare function normalizeError(error: unknown): Error;

package/dist/standalone/umd/standalone-stubs/instrumentation.d.ts

@@ -0,0 +1,21 @@
+export declare const instrumentation: {
+    instrumentAdapter(createFunction: Function, _metadata: any): Function;
+};
+export declare function instrumentAdapter(createFunction: Function, _metadata: any): Function;
+export declare function incrementGetRecordNotifyChangeAllowCount(): void;
+export declare function incrementGetRecordNotifyChangeDropCount(): void;
+export declare function incrementNotifyRecordUpdateAvailableAllowCount(): void;
+export declare function incrementNotifyRecordUpdateAvailableDropCount(): void;
+export declare function refreshApiEvent(): void;
+export declare function instrumentGraphqlAdapter(createFunction: Function, _metadata: any): Function;
+export declare function setLdsAdaptersUiapiInstrumentation(_uiapiRegistration: any): void;
+export declare function setLdsNetworkAdapterInstrumentation(_networkAdapterRegistration: any): void;
+export declare function setupInstrumentation(_luvio: any, _store: any): void;
+export declare function instrumentLuvio(_context: unknown): void;
+export declare const REFRESH_UIAPI_KEY = "refreshUiApi";
+export declare const METRIC_KEYS: {};
+export declare const O11Y_NAMESPACE_LDS_MOBILE = "lds-mobile";
+export declare const withInstrumentation: () => undefined;
+export declare class MetricsReporter {
+    reportGraphqlQueryParseError(): void;
+}

package/dist/standalone/umd/standalone-stubs/o11y.d.ts

@@ -0,0 +1,18 @@
+import type { IdleDetector, Activity } from 'o11y/dist/modules/o11y/client/interfaces';
+export declare const idleDetector: IdleDetector;
+export declare const activity: Partial<Activity>;
+type MetricsTags = Record<string, number | string | boolean>;
+declare function startActivity(_name: string): Activity;
+export declare const mockInstrumentation: {
+    startActivity: typeof startActivity;
+    error: () => void;
+    trackValue: (_operation: string, _value: number, _hasError?: boolean, _tags?: MetricsTags) => void;
+    incrementCounter: (_operation: string, _increment?: number, _hasError?: boolean, _tags?: MetricsTags) => void;
+};
+export declare const getInstrumentation: () => {
+    startActivity: typeof startActivity;
+    error: () => void;
+    trackValue: (_operation: string, _value: number, _hasError?: boolean, _tags?: MetricsTags) => void;
+    incrementCounter: (_operation: string, _increment?: number, _hasError?: boolean, _tags?: MetricsTags) => void;
+};
+export {};

package/dist/standalone/umd/standalone.d.ts

@@ -0,0 +1 @@
+export * from './main';

package/dist/standalone/umd/ttl.d.ts

@@ -0,0 +1,2 @@
+export declare function setUiApiRecordTTL(ttl: number): Promise<void>;
+export declare function setMetadataTTL(ttl: number): Promise<void>;

package/package.json

@@ -0,0 +1,74 @@
+{
+    "name": "@salesforce/lds-worker-api",
+    "version": "1.100.2",
+    "license": "SEE LICENSE IN LICENSE.txt",
+    "description": "",
+    "main": "dist/standalone/umd/lds-worker-api.js",
+    "module": "dist/standalone/es/lds-worker-api.js",
+    "files": [
+        "dist",
+        "src/__tests__/data-driven-tests/fixtures"
+    ],
+    "exports": {
+        ".": {
+            "import": "./dist/standalone/es/lds-worker-api.js",
+            "require": "./dist/standalone/umd/lds-worker-api.js",
+            "types": "./dist/standalone/es/main.d.ts"
+        },
+        "./sfdc": {
+            "import": "./dist/sfdc/es/ldsWorkerApi.js",
+            "types": "./dist/sfdc/es/main.d.ts",
+            "default": "./dist/sfdc/es/ldsWorkerApi.js"
+        },
+        "./test-fixtures": {
+            "default": "./src/__tests__/data-driven-tests/fixtures"
+        }
+    },
+    "scripts": {
+        "prepare": "yarn build",
+        "build": "rollup --config rollup.config.js",
+        "test:unit": "NODE_ENV=production jest",
+        "test:size": "bundlesize",
+        "clean": "rm -rf dist",
+        "release:corejar": "yarn build && ../core-build/scripts/core.js --name=lds-worker-api"
+    },
+    "devDependencies": {
+        "@luvio/adapter-test-library": "0.135.4",
+        "@luvio/engine": "0.135.4",
+        "@luvio/environments": "0.135.4",
+        "@oat-sa/rollup-plugin-wildcard-external": "^0.1.0",
+        "@salesforce/lds-adapters-graphql": "^1.100.2",
+        "@salesforce/lds-adapters-uiapi": "^1.100.2",
+        "@salesforce/lds-default-luvio": "^1.100.2",
+        "@salesforce/lds-drafts": "^1.100.2",
+        "@salesforce/lds-graphql-parser": "^1.100.2",
+        "@salesforce/lds-luvio-engine": "^1.100.2",
+        "@salesforce/lds-priming": "^1.100.2",
+        "@salesforce/lds-runtime-mobile": "^1.100.2",
+        "@salesforce/nimbus-plugin-lds": "^1.100.2",
+        "ajv": "^8.11.0",
+        "glob": "^7.1.5",
+        "nimbus-types": "^2.0.0-alpha1",
+        "o11y": "244.0.0",
+        "wait-for-expect": "^3.0.2"
+    },
+    "bundlesize": [
+        {
+            "path": "./dist/sfdc/es/ldsWorkerApi.js",
+            "maxSize": "7.5 kB",
+            "compression": "brotli"
+        }
+    ],
+    "sfdc": {
+        "overrides": {
+            "artifactDirectory": "dist/sfdc/es",
+            "artifacts": {
+                "ldsWorkerApi.js": {
+                    "output": {
+                        "path": "ui-bridge-components/modules/native/ldsWorkerApi/ldsWorkerApi.js"
+                    }
+                }
+            }
+        }
+    }
+}

package/src/__tests__/data-driven-tests/fixtures/adapter-testcases/adapter-testcase.schema.json

@@ -0,0 +1,83 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema",
+    "$id": "./fixtures/adapter-testcases/adapter-testcase.schema.json",
+    "title": "Adapter Test Case",
+    "description": "A test case for Adapter, defining inputs, network responses, and expected outputs",
+    "type": "object",
+    "properties": {
+        "testCaseName": {
+            "description": "The name of the test case.",
+            "type": "string"
+        },
+        "adapters": {
+            "description": "The adapters to invoke.",
+            "type": "array",
+            "items": {
+                "$ref": "#/$defs/Adapter"
+            }
+        },
+        "networkMocks": {
+            "description": "Mock network responses. Should be an array of paths to *.network-mock.json files (paths are relative to 'fixtures' folder).",
+            "type": "array",
+            "items": {
+                "type": "string"
+            }
+        },
+        "beforeJS": {
+            "description": "Javascript code to run at the beginning of the test case. Should be inline script or a path to *.js file. the stirng will be treated as a js file path if the string ends with .js",
+            "type": "string"
+        },
+        "afterJS": {
+            "description": "Javascript code to run at the end of the test case.",
+            "type": "string"
+        },
+        "l2DataSetPath": {
+            "description": "The data rows to populate into lds_data L2 table. Should be a path to *.tsv file. IMPORTANT: *.tsv uses tab as field separator. Default VSCode editor don't support tab character well. Install VSCode TSV plugin to solve it.",
+            "type": "string"
+        },
+        "freezeTime": {
+            "description": "If set to true then test runners MUST freeze time to 2020-01-01T00:00:00.000Z before the test and increment the frozen time by 1ms after each adapter is called, or else the adapter results will not be deterministic and adapter sequencing won't work.  NOTE: Adapter/environment code uses either Date.now or 'new Date()' to get current time, so overriding Date.now() and Date.constructor is one potential way to freeze time.",
+            "type": "boolean"
+        },
+        "disabled": {
+            "description": "Should this test be disabled (ie: not picked automatically by test runner)?",
+            "type": "boolean"
+        }
+    },
+    "additionalProperties": false,
+    "required": ["testCaseName", "adapters"],
+
+    "$defs": {
+        "Adapter": {
+            "type": "object",
+            "properties": {
+                "name": {
+                    "description": "The name of the adapter to invoke.",
+                    "type": "string"
+                },
+                "config": {
+                    "description": "The config to pass into the adapter.",
+                    "type": "object"
+                },
+                "requestContext": {
+                    "description": "The requestContext to pass into the adapter.",
+                    "type": "object"
+                },
+                "expectedToSucceed": {
+                    "description": "The adapter call expected to succeed or error out. If not specified, expectedSnapshot will be checked if expectedSnapshot specified",
+                    "type": "boolean"
+                },
+                "expectedResult": {
+                    "description": "The snapshot data/error that comes back from the adapter. Should be the path to a JSON file (relative to 'fixtures' folder).",
+                    "type": "string"
+                },
+                "_comment": {
+                    "description": "comment for the adapter purpose",
+                    "type": "string"
+                }
+            },
+            "additionalProperties": false,
+            "required": ["name", "config"]
+        }
+    }
+}

package/src/__tests__/data-driven-tests/fixtures/adapter-testcases/createRecord/name-displayValue-response.adapter-snapshot.result.json

@@ -0,0 +1,61 @@
+{
+    "data": {
+        "apiName": "Aircraft",
+        "childRelationships": {},
+        "fields": {
+            "LastFliedBy": {
+                "displayValue": null,
+                "value": {
+                    "apiName": "Pilot",
+                    "childRelationships": {},
+                    "fields": {
+                        "FirstName": {
+                            "displayValue": null,
+                            "value": "Tom"
+                        },
+                        "LastName": {
+                            "displayValue": null,
+                            "value": "Hanks"
+                        },
+                        "Name": {
+                            "displayValue": null,
+                            "value": null
+                        }
+                    },
+                    "id": "a010GR4ORmHKPlBQNX",
+                    "lastModifiedById": "005B0000000GR4OIAW",
+                    "lastModifiedDate": "2020-01-01T00:00:00.001Z",
+                    "recordTypeId": "012000000000000AAA",
+                    "recordTypeInfo": null,
+                    "systemModstamp": "2020-01-01T00:00:00.001Z",
+                    "drafts": {
+                        "created": true,
+                        "edited": false,
+                        "deleted": false,
+                        "serverValues": {},
+                        "draftActionIds": ["157783680000100"],
+                        "latestDraftActionId": "157783680000100"
+                    }
+                }
+            },
+            "LastFliedById": {
+                "displayValue": null,
+                "value": "a010GR4ORmHKPlBQNX"
+            }
+        },
+        "id": "a0w0GR4ORmHKPlCQNX",
+        "lastModifiedById": "005B0000000GR4OIAW",
+        "lastModifiedDate": "2020-01-01T00:00:00.003Z",
+        "recordTypeId": "012000000000000AAA",
+        "recordTypeInfo": null,
+        "systemModstamp": "2020-01-01T00:00:00.002Z",
+        "drafts": {
+            "created": true,
+            "edited": true,
+            "deleted": false,
+            "serverValues": {},
+            "draftActionIds": ["157783680000200", "157783680000300"],
+            "latestDraftActionId": "157783680000300"
+        }
+    }
+}

package/src/__tests__/data-driven-tests/fixtures/adapter-testcases/createRecord/name-displayValue.adapter-testcase.json

@@ -0,0 +1,67 @@
+{
+    "testCaseName": "updateRecord shows correct name.displayValue for nested record",
+    "adapters": [
+        {
+            "_comment": "create pilot Chesley Burnett",
+            "name": "createRecord",
+            "config": {
+                "apiName": "Pilot",
+                "fields": {
+                    "FirstName": "Chesley",
+                    "LastName": "Burnett"
+                }
+            }
+        },
+        {
+            "_comment": "create pilot Tom Hanks",
+            "name": "createRecord",
+            "config": {
+                "apiName": "Pilot",
+                "fields": {
+                    "FirstName": "Tom",
+                    "LastName": "Hanks"
+                }
+            }
+        },
+        {
+            "_comment": "create record aircraft(Boeing 737) last flied by Chesley Burnett",
+            "name": "createRecord",
+            "config": {
+                "apiName": "Aircraft",
+                "fields": {
+                    "Name": "Boeing 737 9765",
+                    "LastFliedById": "a010GR4ORmHKPlAQNX"
+                }
+            }
+        },
+        {
+            "_comment": "update Boeing 737 record last flied by to Tom Hanks",
+            "name": "updateRecord",
+            "config": {
+                "recordId": "a0w0GR4ORmHKPlCQNX",
+                "fields": {
+                    "LastFliedById": "a010GR4ORmHKPlBQNX"
+                }
+            }
+        },
+        {
+            "_comment": "get Boeing 737 record last flied by name",
+            "name": "getRecord",
+            "config": {
+                "recordId": "a0w0GR4ORmHKPlCQNX",
+                "fields": [
+                    "Aircraft.LastFliedById",
+                    "Aircraft.LastFliedBy.Name",
+                    "Aircraft.LastFliedBy.FirstName",
+                    "Aircraft.LastFliedBy.LastName"
+                ]
+            },
+            "expectedResult": "./adapter-testcases/createRecord/name-displayValue-response.adapter-snapshot.result.json"
+        }
+    ],
+    "networkMocks": [
+        "./adapter-testcases/createRecord/objectInfos/Pilot-objectInfo.network-mock.json",
+        "./adapter-testcases/createRecord/objectInfos/Aircraft-objectInfo.network-mock.json"
+    ],
+    "freezeTime": true
+}