@salesforce/lds-worker-api 0.1.0-dev1

package/dist/standalone/es/types/cachePurging.d.ts

@@ -0,0 +1,50 @@
+interface EvictStarted {
+    status: 'Started';
+}
+interface EvictRunning {
+    status: 'Running';
+    message: string;
+}
+interface BatchEvicted {
+    status: 'Evicted';
+    skippedEntries: string[];
+    evictedEntries: string[];
+}
+interface EvictSucceeded {
+    status: 'Succeeded';
+}
+interface EvictError {
+    status: 'Error';
+    message: string;
+}
+interface EvictCancelled {
+    status: 'Canceled';
+}
+export type EvictProgress = BatchEvicted | EvictSucceeded | EvictError | EvictCancelled;
+export type ProgressUpdateCallback = (progess: EvictProgress) => void;
+/**
+ * Purging records specified by an array of record id from durable store
+ * @param recordIds record id array
+ * @onProgressUpdate call back to report evict progress
+ *
+ * @returns started or already running based whether there's an active eviction going on or not.
+ *
+ * The record will not be purged if the record has draft.
+ */
+export declare function evictCacheRecordsByIds(recordIds: string[], onProgressUpdate: ProgressUpdateCallback): EvictStarted | EvictRunning;
+/**
+ * Purging the db entries which passed expired time by specified days
+ * from durable store.
+ * @param expiredByDays
+ * @param onProgressUpdate
+ *
+ * @returns started or already running based whether there's an active eviction going on or not.
+ *
+ * Important: records with draft, objectInfo entries will not be purged even expired by the specified days.
+ */
+export declare function evictExpiredCacheEntries(expiredByDays: number, onProgressUpdate: ProgressUpdateCallback): EvictStarted | EvictRunning;
+/**
+ * Signal to stop current eviction if there's an active eviction going on.
+ */
+export declare function stopEviction(): void;
+export {};

package/dist/standalone/es/types/customLuvioAdapter.d.ts

@@ -0,0 +1,13 @@
+import type { Unsubscribe } from '@luvio/engine';
+import { NativeAdapterRequestContext, type NativeCallbackValue, type NativeOnSnapshot } from './executeAdapter';
+import { type ImperativeAdapterMapValue, type AdapterMapValue } from './lightningAdapterApi';
+export declare function importLuvioAdapterModule(specifier: string): Promise<LuvioAdapterModule>;
+declare class LuvioAdapterModule {
+    imperativeAdapterMap: Record<string, ImperativeAdapterMapValue>;
+    dmlAdapterMap: Record<string, AdapterMapValue>;
+    constructor(module: any);
+    invokeAdapter<Config>(adapterName: string, config: Config, nativeAdapterRequestContext?: NativeAdapterRequestContext): Promise<NativeCallbackValue>;
+    subscribeAdapter<Config>(adapterName: string, config: Config, nativeAdapterRequestContext: NativeAdapterRequestContext, callback: NativeOnSnapshot): Unsubscribe;
+    private invokeDmlAdapter;
+}
+export {};

package/dist/standalone/es/types/customOneStoreAdapter.d.ts

@@ -0,0 +1,21 @@
+import type { Unsubscribe } from '@luvio/engine';
+export type OneStoreNativeCallbackValue = OneStoreNativeCallbackData | OneStoreNativeCallbackError;
+export type OneStoreNativeCallbackData = {
+    data: any | undefined;
+    error?: undefined;
+};
+export type OneStoreNativeCallbackError = {
+    data?: undefined;
+    error: string;
+};
+export declare function importOneStoreAdapterModule(specifier: string): Promise<OneStoreAdapterModule>;
+declare class OneStoreAdapterModule {
+    module: any;
+    constructor(module: any);
+    invoke<Config>(adapterOrCommandName: string, config: Config): Promise<OneStoreNativeCallbackValue>;
+    subscribe<Config>(adapterOrCommandName: string, config: Config, callback: (value: OneStoreNativeCallbackValue) => void): Promise<Unsubscribe | undefined>;
+    private isCommandWireAdapter;
+    private hasInvoke;
+    private hasSubscribe;
+}
+export {};

package/dist/standalone/es/types/draftQueueImplementation.d.ts

@@ -0,0 +1,2 @@
+declare const draftManager: import("@salesforce/lds-drafts").DraftManager, draftQueue: import("@salesforce/lds-drafts").DraftQueue;
+export { draftManager, draftQueue };

package/dist/standalone/es/types/executeAdapter.d.ts

@@ -0,0 +1,103 @@
+import type { AdapterRequestContext, CachePolicy, LuvioAdapterEventObserver } from '@luvio/engine';
+import type { DataCallbackTuple } from '@salesforce/lds-bindings';
+import type { DraftQueueItemMetadata } from '@salesforce/lds-drafts';
+import type { NativeErrorResponse } from './responses';
+import type { ObservabilityContext } from '@salesforce/lds-runtime-mobile';
+export declare const ldsMobileInstrumentation: import("o11y/dist/modules/o11y/client/interfaces").Instrumentation;
+export type NativeCallbackValue = NativeCallbackData | NativeCallbackError | NativeCallbackErrors;
+export type NativeCallbackData = {
+    data: any | undefined;
+    error?: undefined;
+    errors?: undefined;
+};
+export type NativeCallbackError = {
+    data?: undefined;
+    error: NativeErrorResponse;
+    errors?: undefined;
+};
+export type NativeCallbackErrors = {
+    data?: undefined;
+    error?: undefined;
+    errors: NativeErrorResponse[];
+};
+export type NativeOnSnapshot = (value: NativeCallbackValue) => void;
+export type NativeOnResponse = (value: NativeCallbackValue) => void;
+export type Unsubscribe = () => void;
+type NativeCachePolicy = CachePolicy;
+type NativeAdapterRequestPriority = 'high' | 'normal' | 'background';
+type NativeObservabilityContext = ObservabilityContext;
+type NativeLuvioEventObserver = LuvioAdapterEventObserver;
+export interface NativeAdapterRequestContext {
+    cachePolicy?: NativeCachePolicy;
+    priority?: NativeAdapterRequestPriority;
+    observabilityContext?: NativeObservabilityContext;
+    luvioEventObserver?: NativeLuvioEventObserver;
+}
+/**
+ * Coerces a request context passed in from native to a luvio request context
+ * @param nativeRequestContext request context passed in from native
+ * @returns Coerced luvio request context
+ */
+export declare function buildAdapterRequestContext(nativeRequestContext: NativeAdapterRequestContext | undefined): AdapterRequestContext | undefined;
+export declare function buildInvalidConfigError(error: unknown): NativeCallbackError;
+export declare function buildNativeCallbackValue(adapterCallbackValue: DataCallbackTuple<unknown>): NativeCallbackValue;
+/**
+ * Executes the adapter with the given adapterId and config.  Will call onSnapshot
+ * callback with data or error.  Returns an unsubscribe function that should
+ * be called to stop receiving updated snapshots.
+ *
+ * This function returns an error if the given adapterId cannot be found or is not
+ * a GET wire adapter.  It will also return an error if it fails to parse the config string.
+ */
+export declare function subscribeToAdapter(adapterId: string, config: string, onSnapshot: NativeOnSnapshot, nativeAdapterRequestContext?: NativeAdapterRequestContext): Unsubscribe;
+/**
+ * @deprecated There is no situation in which any consumer actually wants to replace the draft.
+ * call {@link invokeAdapterWithDraftToMerge} instead`.
+ * Keep it for now for app back compatibility.
+ * Will be removed in future, ideally 2 releases later.
+ */
+export declare function invokeAdapterWithDraftToReplace(adapterId: string, config: string, draftIdToReplace: string, onResponse: NativeOnResponse, nativeAdapterRequestContext?: NativeAdapterRequestContext): void;
+/**
+ * Executes the specified adapter with the given @param adapterId and @param config. Then
+ * it merges the draft with the given id with the draft generated by
+ * the mutating adapter. Will call onResult callback once with data or error.
+ *
+ * This function returns an error if the given adapterId cannot be found, or if the
+ * adapterId is not a mutating adapter if a draft isn't created, or
+ * if it fails to parse the given config string.
+ *
+ * If the @param adapterId is deleteRecod, the invocation of it will generate a delele draft.
+ * The newly generated delete draft will replace the draft specified by @param targetDraftId
+ */
+export declare function invokeAdapterWithDraftToMerge(adapterId: string, config: string, targetDraftId: string, onResponse: NativeOnResponse, nativeAdapterRequestContext?: NativeAdapterRequestContext): void;
+/**
+ * Executes the specified adapter with the given adapterId and config. Then
+ * it sets the given metadata on the draft created by the mutating adapter.  Will call
+ * onResult callback once with data or error.
+ *
+ * This function returns an error if the given adapterId cannot be found, or if the
+ * adapterId is not a mutating adapter, or if a draft isn't created, or if it
+ * fails to parse the given config string.
+ */
+export declare function invokeAdapterWithMetadata(adapterId: string, config: string, metadata: DraftQueueItemMetadata, onResponse: NativeOnResponse, nativeAdapterRequestContext?: NativeAdapterRequestContext): void;
+/**
+ * Executes the specified adapter with the given adapterId and config.  Will call
+ * onResponse callback once with data or error.
+ *
+ * This function returns an error if the given adapterId cannot be found or if it
+ * fails to parse the given config string.
+ */
+export declare function invokeAdapter(adapterId: string, config: string, onResponse: NativeOnResponse, nativeAdapterRequestContext?: NativeAdapterRequestContext): void;
+/**
+ * @deprecated Use invokeAdapter or subscribeToAdapter instead
+ *
+ * W-9173084 Will remove this
+ */
+export declare function executeAdapter(adapterId: string, config: string, onSnapshot: NativeOnSnapshot, nativeAdapterRequestContext?: NativeAdapterRequestContext): Unsubscribe;
+/**
+ * @deprecated Use invokeAdapter instead
+ *
+ * W-9173084 Will remove this
+ */
+export declare function executeMutatingAdapter(adapterId: string, config: string, onResult: NativeOnResponse, nativeAdapterRequestContext?: NativeAdapterRequestContext): void;
+export {};

package/dist/standalone/es/types/language.d.ts

@@ -0,0 +1,13 @@
+declare const create: {
+    (o: object | null): any;
+    (o: object | null, properties: PropertyDescriptorMap & ThisType<any>): any;
+}, keys: {
+    (o: object): string[];
+    (o: {}): string[];
+};
+declare const stringify: {
+    (value: any, replacer?: ((this: any, key: string, value: any) => any) | undefined, space?: string | number | undefined): string;
+    (value: any, replacer?: (string | number)[] | null | undefined, space?: string | number | undefined): string;
+}, parse: (text: string, reviver?: ((this: any, key: string, value: any) => any) | undefined) => any;
+declare const isArray: (arg: any) => arg is any[];
+export { create as ObjectCreate, keys as ObjectKeys, stringify as JSONStringify, parse as JSONParse, isArray as IsArray, };

package/dist/standalone/es/types/lightningAdapterApi.d.ts

@@ -0,0 +1,15 @@
+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_";
+export type AdapterMapValue = Adapter<unknown, unknown> | ImperativeAdapter<unknown, unknown> | undefined;
+export type ImperativeAdapterMapValue = ImperativeAdapter<unknown, unknown> | undefined;
+export declare function buildAdapterMaps(map: Record<string, AdapterMapValue>): {
+    dmlAdapterMap: Record<string, AdapterMapValue>;
+    imperativeAdapterMap: Record<string, ImperativeAdapterMapValue>;
+};
+declare function getDMLAdapterFromName(name: string): AdapterMapValue;
+declare function getImperativeAdapterFromName(name: string): ImperativeAdapterMapValue;
+declare function getImperativeAdapterNames(): string[];
+export { getImperativeAdapterFromName, getDMLAdapterFromName, getImperativeAdapterNames, gqlApi };

package/dist/standalone/es/types/main.d.ts

@@ -0,0 +1,11 @@
+import { subscribeToAdapter, invokeAdapter, invokeAdapterWithMetadata, invokeAdapterWithDraftToReplace, invokeAdapterWithDraftToMerge, 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';
+import { evictCacheRecordsByIds, evictExpiredCacheEntries, stopEviction } from './cachePurging';
+import { importLuvioAdapterModule } from './customLuvioAdapter';
+import { importOneStoreAdapterModule } from './customOneStoreAdapter';
+export { subscribeToAdapter, invokeAdapter, invokeAdapterWithMetadata, invokeAdapterWithDraftToReplace, invokeAdapterWithDraftToMerge, executeAdapter, executeMutatingAdapter, nimbusDraftQueue, draftQueue, draftManager, setUiApiRecordTTL, setMetadataTTL, registerReportObserver, getImperativeAdapterNames, createPrimingSession, evictCacheRecordsByIds, evictExpiredCacheEntries, stopEviction, importLuvioAdapterModule, importOneStoreAdapterModule, };

package/dist/standalone/es/types/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/es/types/primingApi.d.ts

@@ -0,0 +1,25 @@
+import type { PrimingSession } from '@salesforce/lds-runtime-mobile';
+interface PrimingError {
+    ids: string[];
+    code: ErrorCode;
+    message: string;
+}
+type ErrorCode = 'precondition-error' | 'not-found' | 'service-protection-error' | 'service-unavailable' | 'canceled' | 'unknown';
+export 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, context?: import("@salesforce/lds-runtime-mobile").ObservabilityContext | undefined) => Promise<void>;
+    cancel: () => void;
+    on: <K extends keyof import("@salesforce/lds-runtime-mobile/dist/types/priming").PrimingEvents>(eventName: K, callback: (payload: import("@salesforce/lds-runtime-mobile/dist/types/priming").PrimingEvents[K]) => void) => PrimingSession;
+    once: <K_1 extends keyof import("@salesforce/lds-runtime-mobile/dist/types/priming").PrimingEvents>(eventName: K_1, callback: (payload: import("@salesforce/lds-runtime-mobile/dist/types/priming").PrimingEvents[K_1]) => void) => PrimingSession;
+    off: <K_2 extends keyof import("@salesforce/lds-runtime-mobile/dist/types/priming").PrimingEvents>(eventName: K_2, callback: (payload: import("@salesforce/lds-runtime-mobile/dist/types/priming").PrimingEvents[K_2]) => void) => PrimingSession;
+    registerEventHandler: (handler: PrimingEventHandler) => () => void;
+};
+export {};

package/dist/standalone/es/types/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/es/types/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/es/types/standalone-stubs/o11y.d.ts

@@ -0,0 +1,23 @@
+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;
+declare function log(_schema: any, _data?: any): void;
+export declare const mockInstrumentation: {
+    log: typeof log;
+    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;
+    bucketValue: (_operation: string, _value: number, _buckets: number[]) => void;
+};
+export declare const getInstrumentation: () => {
+    log: typeof log;
+    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;
+    bucketValue: (_operation: string, _value: number, _buckets: number[]) => void;
+};
+export {};

package/dist/standalone/es/types/standalone-stubs/unwrap.d.ts

@@ -0,0 +1 @@
+export declare function unwrap<T>(data: T): T;

package/dist/standalone/es/types/standalone.d.ts

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

package/dist/standalone/es/types/ttl.d.ts

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