@salesforce/lds-runtime-mobile 1.315.0 → 1.317.0

package/dist/types/draftsAdapters/AbstractResourceRequestActionHandler.d.ts

@@ -0,0 +1,71 @@
+import type { NetworkAdapter, ResourceRequest, Luvio, DurableStoreKeyMetadataMap } from '@luvio/engine';
+import type { DraftAction, CompletedDraftAction, QueueOperation, PendingDraftAction, DraftActionMetadata, DraftQueue } from '@salesforce/lds-drafts';
+import { ProcessActionResult } from '@salesforce/lds-drafts';
+import type { ActionHandler, DraftIdAndKeyMapping } from '@salesforce/lds-drafts';
+export type ResponseIngestionEntry<T = unknown> = {
+    response: T;
+    synchronousIngest: AbstractResourceRequestActionHandler<T, unknown>['synchronousIngest'];
+    buildCacheKeysForResponse: AbstractResourceRequestActionHandler<T, unknown>['buildCacheKeysFromResponse'];
+};
+export declare const DEFAULT_FIELD_LAST_MODIFIED_DATE = "LastModifiedDate";
+export declare const DEFAULT_FIELD_CREATED_DATE = "CreatedDate";
+export declare abstract class AbstractResourceRequestActionHandler<ResponseType, DraftMetadata> implements ActionHandler<ResourceRequest, DraftMetadata, ResponseType> {
+    protected readonly draftQueue: DraftQueue;
+    protected readonly networkAdapter: NetworkAdapter;
+    protected readonly getLuvio: () => Luvio;
+    ephemeralRedirects: {
+        [key: string]: string;
+    };
+    isIdempotencySupported: boolean;
+    isLdsIdempotencyWriteDisabled: boolean;
+    isBackdatingEnabled: boolean;
+    constructor(draftQueue: DraftQueue, networkAdapter: NetworkAdapter, getLuvio: () => Luvio);
+    enqueue(data: ResourceRequest): Promise<PendingDraftAction<ResourceRequest>>;
+    handleAction(action: DraftAction<ResourceRequest, ResponseType>, actionCompleted: (action: CompletedDraftAction<ResourceRequest, ResponseType>) => Promise<void>, actionErrored: (action: DraftAction<ResourceRequest, ResponseType>, retry: boolean, retryDelayInMs?: number, actionDataChanged?: boolean) => Promise<void>): Promise<ProcessActionResult>;
+    handleIdempotencyServerError(responseBody: any, action: DraftAction<ResourceRequest, ResponseType>, updateIdempotencyKey: boolean, ...targetErrorCodes: string[]): boolean;
+    isUiApiErrors(body: any): boolean;
+    isBackdatingError(body: any, action: DraftAction<ResourceRequest, ResponseType>): any;
+    buildPendingAction(request: ResourceRequest, queue: DraftAction<unknown, unknown>[]): Promise<PendingDraftAction<ResourceRequest>>;
+    handleActionEnqueued(_action: PendingDraftAction<ResourceRequest>): Promise<void>;
+    handleActionRemoved(action: DraftAction<ResourceRequest, ResponseType>): Promise<void>;
+    getQueueOperationsForCompletingDrafts(queue: DraftAction<unknown, unknown>[], action: CompletedDraftAction<ResourceRequest, ResponseType>): QueueOperation[];
+    getRedirectMappings(action: CompletedDraftAction<ResourceRequest, ResponseType>): DraftIdAndKeyMapping[] | undefined;
+    handleActionCompleted(action: CompletedDraftAction<ResourceRequest, ResponseType>, queueOperations: QueueOperation[], allHandlers: ActionHandler<unknown, unknown, unknown>[]): Promise<void>;
+    handleReplaceAction(targetAction: DraftAction<ResourceRequest, ResponseType>, sourceAction: DraftAction<ResourceRequest, ResponseType>): DraftAction<ResourceRequest, ResponseType>;
+    mergeActions(targetAction: DraftAction<ResourceRequest, ResponseType>, sourceAction: DraftAction<ResourceRequest, ResponseType>): DraftAction<ResourceRequest, ResponseType>;
+    shouldDeleteActionByTagOnRemoval(action: DraftAction<ResourceRequest, ResponseType>): boolean;
+    updateMetadata(_existingMetadata: DraftActionMetadata, incomingMetadata: DraftActionMetadata): DraftActionMetadata;
+    private isActionOfType;
+    protected reingestRecord(action: DraftAction<ResourceRequest, ResponseType>): Promise<void>;
+    getDraftIdsFromAction(action: DraftAction<ResourceRequest, ResponseType>): string[];
+    hasIdempotencySupport(): boolean;
+    ingestResponses(responses: ResponseIngestionEntry[], action: DraftAction<ResourceRequest, ResponseType>): Promise<void>;
+    evictKey(key: string): Promise<void>;
+    abstract handlerId: string;
+    abstract canHandlePublish(key: string): boolean;
+    abstract canRepresentationContainDraftMetadata(representationName: string): boolean;
+    /**
+     * Extracts or synthesizes an id from a given resource request
+     * @throws if the id cannot be determined or synthesized
+     * @param request the request to get the id from
+     */
+    abstract getIdFromRequest(request: ResourceRequest): Promise<string>;
+    abstract getIdFromResponseBody(responseBody: ResponseType): string;
+    abstract buildTagForTargetId(id: string): string;
+    abstract buildCacheKeysFromResponse(response: ResponseType): DurableStoreKeyMetadataMap;
+    abstract synchronousIngest(response: ResponseType, action: DraftAction<ResourceRequest, ResponseType>): void;
+    abstract getDataForAction(action: DraftAction<ResourceRequest, ResponseType>): Promise<ResponseType | undefined>;
+    abstract getDraftMetadata(key: string): Promise<DraftMetadata | undefined>;
+    abstract applyDraftsToIncomingData(key: string, data: unknown, draftMetadata: DraftMetadata | undefined, publishFn: (key: string, data: any) => void): void;
+    /**
+     * Returns true if the given targetId is a for a draft-created record
+     *
+     * @param targetId the targetId to check
+     */
+    abstract isDraftId(targetId: string): boolean;
+    /**
+     * Overlay the sourceBody over top of the targetBody
+     */
+    abstract mergeRequestBody<T = unknown>(targetBody: T, sourceBody: T): T;
+}
+export declare function isResourceRequestAction(action: DraftAction<unknown, unknown>): action is DraftAction<ResourceRequest, unknown>;

package/dist/types/draftsAdapters/ContentDocumentCompositeRepresentation/ContentDocumentCompositeRepresentationActionHandler.d.ts

@@ -1,6 +1,6 @@
 import type { DurableStoreKeyMetadataMap, Luvio, NetworkAdapter, ResourceRequest } from '@luvio/engine';
-import { AbstractResourceRequestActionHandler } from '@salesforce/lds-drafts';
-import type { ResponseIngestionEntry, PendingDraftAction, DraftAction, DraftQueue, CompletedDraftAction, DraftIdAndKeyMapping } from '@salesforce/lds-drafts';
+import { AbstractResourceRequestActionHandler, type ResponseIngestionEntry } from '../AbstractResourceRequestActionHandler';
+import type { PendingDraftAction, DraftAction, DraftQueue, CompletedDraftAction, DraftIdAndKeyMapping } from '@salesforce/lds-drafts';
 import type { RecordEffectingHandler } from '../RecordRepresentation/actionHandlers/RecordEffectingHandler';
 import type { DraftRecordOperation, RecordDraftMetadata } from '../RecordRepresentation/replayDraftsOnRecord';
 import type { UiApiDraftRecordService } from '../UiApiDraftRecordService';

package/dist/types/draftsAdapters/IdempotentWrite.d.ts

@@ -0,0 +1,33 @@
+import type { HttpStatusCode, Headers } from '@luvio/engine';
+export interface UIApiError {
+    errorCode: string;
+    message: string | null;
+}
+export declare const enum IdempotentWriteSpecificHttpStatusCode {
+    RequestTimeout = 408,
+    Conflict = 409,
+    BadGateway = 502,
+    ServiceUnavailable = 503,
+    UnProcessableEntity = 422
+}
+/**
+ * The http status code which could be returned from idempotent write.
+ */
+export type IdempotentWriteHttpStatusCode = IdempotentWriteSpecificHttpStatusCode | HttpStatusCode;
+export declare const HTTP_HEADER_RETRY_AFTER = "Retry-After";
+export declare const HTTP_HEADER_IDEMPOTENCY_KEY = "Idempotency-Key";
+export declare const ERROR_CODE_IDEMPOTENCY_FEATURE_NOT_ENABLED = "IDEMPOTENCY_FEATURE_NOT_ENABLED";
+export declare const ERROR_CODE_IDEMPOTENCY_NOT_SUPPORTED = "IDEMPOTENCY_NOT_SUPPORTED";
+export declare const ERROR_CODE_IDEMPOTENCY_KEY_USED_DIFFERENT_USER = "IDEMPOTENCY_KEY_USED_DIFFERENT_USER";
+export declare const ERROR_CODE_IDEMPOTENCY_CONCURRENT_REQUEST = "IDEMPOTENCY_CONCURRENT_REQUEST";
+export declare const ERROR_CODE_IDEMPOTENCY_KEY_ALREADY_USED = "IDEMPOTENCY_KEY_ALREADY_USED";
+export declare const ERROR_CODE_IDEMPOTENCY_BACKEND_OPERATION_ERROR = "IDEMPOTENCY_BACKEND_OPERATION_ERROR";
+/**
+ * Get the retry after in milliseconds from the response headers, undefined if not specified.
+ * The header could have two different format.
+ * Retry-After: <http-date>, like Wed, 21 Oct 2015 07:28:00 GMT
+ * Retry-After: <delay-seconds>, like 1.5s
+ * @param headers http headers
+ * @returns the time to delat in millisconds.
+ */
+export declare function getRetryAfterInMs(headers?: Headers): number | undefined;

package/dist/types/draftsAdapters/QuickActionExecutionRepresentation/QuickActionExecutionRepresentationHandler.d.ts

@@ -1,5 +1,5 @@
 import type { DraftAction, DraftQueue, PendingDraftAction } from '@salesforce/lds-drafts';
-import { AbstractResourceRequestActionHandler } from '@salesforce/lds-drafts';
+import { AbstractResourceRequestActionHandler } from '../AbstractResourceRequestActionHandler';
 import type { PerformActionInputRepresentation, QuickActionExecutionRepresentation } from '../../adapters/main';
 import type { DurableStoreKeyMetadataMap, Luvio, NetworkAdapter, ResourceRequest } from '@luvio/engine';
 import type { UiApiDraftRecordService } from '../UiApiDraftRecordService';

package/dist/types/draftsAdapters/QuickActionExecutionRepresentation/UpdateRecordQuickActionExecutionRepresentationHandler.d.ts

@@ -1,5 +1,5 @@
 import type { ActionHandler, CompletedDraftAction, DraftAction, DraftQueue, PendingDraftAction, QueueOperation } from '@salesforce/lds-drafts';
-import { AbstractResourceRequestActionHandler } from '@salesforce/lds-drafts';
+import { AbstractResourceRequestActionHandler } from '../AbstractResourceRequestActionHandler';
 import type { DurableStoreKeyMetadataMap, Luvio, NetworkAdapter, ResourceRequest } from '@luvio/engine';
 import type { PerformActionInputRepresentation, QuickActionExecutionRepresentation } from '../../adapters/main';
 import type { UiApiDraftRecordService } from '../UiApiDraftRecordService';

package/dist/types/draftsAdapters/RecordRepresentation/actionHandlers/UiApiRecordActionHandler.d.ts

@@ -2,7 +2,7 @@ import type { Adapter, DurableStoreKeyMetadataMap, Luvio, NetworkAdapter, Resour
 import type { GetRecordConfig, ObjectInfoRepresentation, RecordRepresentation, RecordRepresentationNormalized, RecordInputRepresentation } from '../../../adapters/main';
 import type { ActionHandler, CompletedDraftAction, DraftAction, DraftActionMetadata, DraftIdAndKeyMapping, DraftQueue, PendingDraftAction, QueueOperation } from '@salesforce/lds-drafts';
 import type { FieldRepresentation, ObjectInfoService } from '../../utils/types';
-import { AbstractResourceRequestActionHandler } from '@salesforce/lds-drafts';
+import { AbstractResourceRequestActionHandler } from '../../AbstractResourceRequestActionHandler';
 import type { DraftRecordOperation, RecordDraftMetadata } from '../replayDraftsOnRecord';
 import type { UiApiDraftRecordService, ReferenceIdFieldInfo } from '../../UiApiDraftRecordService';
 import type { RecordEffectingHandler } from './RecordEffectingHandler';

package/dist/types/instrumentation/metrics.d.ts

@@ -8,8 +8,9 @@ export declare function reportGraphqlCreateSnapshotError(err: unknown): void;
 export declare function reportGraphQlEvalDbReadDuration(duration: number): void;
 export declare function reportGraphqlAdapterError(errorCode: string): void;
 export declare function reportGraphqlQueryInstrumentation(data: QueryInstrumentation): void;
-export declare function reportDraftActionEvent(state: 'added' | 'uploading' | 'completed' | 'deleted' | 'updated' | 'failed'): void;
-export declare function reportDraftQueueState(state: 'started' | 'error' | 'waiting' | 'stopped'): void;
+export declare function incrementGraphQLRefreshUndfined(): void;
+export declare function reportDraftActionEvent(state: 'added' | 'uploading' | 'completed' | 'deleted' | 'updated' | 'failed', draftCount: number, message?: string): void;
+export declare function reportDraftQueueState(state: 'started' | 'error' | 'waiting' | 'stopped', draftCount: number): void;
 export declare function reportDraftAwareContentDocumentVersionSynthesizeError(err: unknown): void;
 export declare function reportDraftAwareContentVersionSynthesizeCalls(mimeType: string): void;
 /** Priming */

package/dist/types/sideEffects/SideEffectService.d.ts

@@ -0,0 +1,27 @@
+import { type DurableStore } from '@luvio/environments';
+import type { FormatDisplayValue } from '../draftsAdapters/RecordRepresentation/actionHandlers/UiApiRecordActionHandler';
+import type { ObjectInfoService } from '../utils/ObjectInfoService';
+import type { CreateRecordSideEffect, DeleteRecordSideEffect, UpdateRecordSideEffect } from './sideEffects';
+export declare class SideEffectService {
+    private readonly durableStore;
+    private readonly objectInfoService;
+    private readonly userId;
+    private readonly formatDisplayValue;
+    constructor(durableStore: DurableStore, objectInfoService: ObjectInfoService, userId: string, formatDisplayValue: FormatDisplayValue);
+    createRecordCreateSideEffect(recordId: string, draftActionId: string, uniqueId: string, apiName: string, timestamp: number, fields: Record<string, any>): Promise<CreateRecordSideEffect>;
+    createRecordUpdateSideEffect(recordId: string, draftActionId: string, uniqueId: string, apiName: string, timestamp: number, fields: Record<string, any>): Promise<UpdateRecordSideEffect>;
+    createRecordDeleteSideEffect(recordId: string, draftActionId: string, uniqueId: string, apiName: string, timestamp: number, fields: Record<string, any>): Promise<DeleteRecordSideEffect>;
+    private createSideEffect;
+    private createLink;
+    private synthesizeRecordFromParts;
+    private generateSystemFields;
+    private synthesizeFieldsFromParts;
+    private generateRecordPatch;
+    private getCompoundNameFields;
+    private formatDateTimeField;
+    private ensureObjectInfo;
+    private fillMissingFields;
+    private determineRecordTypeId;
+    private handleReferenceField;
+    private patchIfExists;
+}

package/dist/types/sideEffects/SideEffectStore.d.ts

@@ -0,0 +1,14 @@
+import type { DurableStore } from '@luvio/environments';
+import type { SideEffect } from './sideEffects';
+export declare class SideEffectStore {
+    private readonly durableStore;
+    private allEffects;
+    private keyToEffectMap;
+    constructor(durableStore: DurableStore);
+    addEffects(effects: SideEffect[]): Promise<void>;
+    removeEffects(effects: SideEffect[]): Promise<void>;
+    getEffects(key: string): SideEffect[] | undefined;
+    getEffectsByTag(tag: string): SideEffect[];
+    private initialize;
+    private regenerateKeyToEffectMap;
+}

package/dist/types/sideEffects/index.d.ts

@@ -0,0 +1,2 @@
+export { SideEffectStore } from './SideEffectStore';
+export type { SideEffect } from './sideEffects';

package/dist/types/sideEffects/sideEffectEnvironment.d.ts

@@ -0,0 +1,3 @@
+import type { DurableEnvironment } from '@luvio/environments';
+import type { SideEffectStore } from './SideEffectStore';
+export declare function enableSideEffectsOnEnvironment(env: DurableEnvironment, sideEffectStore: SideEffectStore): DurableEnvironment;

package/dist/types/sideEffects/sideEffects.d.ts

@@ -0,0 +1,31 @@
+import type { DurableRecordRepresentation } from '@salesforce/lds-durable-records';
+interface BaseRecordSideEffect {
+    key: string;
+    tag: string;
+    uniqueId: string;
+    timestamp: number;
+}
+export interface CreateRecordSideEffect extends BaseRecordSideEffect {
+    type: 'record-create';
+    record: DurableRecordRepresentation;
+}
+export interface UpdateRecordSideEffect extends BaseRecordSideEffect {
+    type: 'record-update';
+    recordPatch: Partial<DurableRecordRepresentation>;
+}
+export interface DeleteRecordSideEffect extends BaseRecordSideEffect {
+    type: 'record-delete';
+}
+export type SideEffect = CreateRecordSideEffect | UpdateRecordSideEffect | DeleteRecordSideEffect;
+/**
+ * Removes any existing effects on a record and re-applies the given ordered list and returns the record
+ * with the updated side effects applied.
+ *
+ * If the record contains effects applied to it and we no longer
+ * have any effects to apply to it, they will be removed and the result returned without any side effect applied
+ *
+ * @param record The base record to apply effects to to. If undefined the first effect must be a record-create operation
+ * @param sideEffects The list of effects to apply to the record
+ */
+export declare function resetAndApplyEffects(record: DurableRecordRepresentation | undefined, sideEffects: SideEffect[] | undefined): DurableRecordRepresentation | undefined;
+export {};

package/dist/types/utils/ObjectInfoService.d.ts

@@ -32,6 +32,7 @@ export declare class ObjectInfoService {
      * from the adapter.
      */
     getObjectInfos(apiNames: string[]): Promise<ObjectInfoMap>;
+    getObjectInfo(apiName: string): Promise<ObjectInfoRepresentation | undefined>;
     getObjectInfoDirectory(): Promise<ObjectInfoDirectoryRepresentation | undefined>;
     ensureObjectInfoCached: (apiName: string, entry?: ObjectInfoRepresentation) => Promise<void>;
     getCachedObjectInfoStatus: () => Promise<Map<string, ObjectInfoStatus>>;

package/dist/types/utils/language.d.ts

@@ -19,11 +19,11 @@ 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 push: (...items: any[]) => number, join: (separator?: string | undefined) => string, slice: (start?: number | undefined, end?: number | undefined) => any[];
+declare const push: (...items: any[]) => number, join: (separator?: string | undefined) => string, slice: (start?: number | undefined, end?: number | undefined) => any[], shift: () => any;
 declare const isArray: (arg: any) => arg is any[], from: {
     <T>(arrayLike: ArrayLike<T>): T[];
     <T_1, U>(arrayLike: ArrayLike<T_1>, mapfn: (v: T_1, k: number) => U, thisArg?: any): U[];
     <T_2>(iterable: Iterable<T_2> | ArrayLike<T_2>): T_2[];
     <T_3, U_1>(iterable: Iterable<T_3> | ArrayLike<T_3>, mapfn: (v: T_3, k: number) => U_1, thisArg?: any): U_1[];
 };
-export { keys as ObjectKeys, create as ObjectCreate, assign as ObjectAssign, entries as ObjectEntries, push as ArrayPrototypePush, join as ArrayPrototypeJoin, slice as ArrayPrototypeSlice, isArray as ArrayIsArray, from as ArrayFrom, stringify as JSONStringify, parse as JSONParse, };
+export { keys as ObjectKeys, create as ObjectCreate, assign as ObjectAssign, entries as ObjectEntries, push as ArrayPrototypePush, join as ArrayPrototypeJoin, slice as ArrayPrototypeSlice, shift as ArrayPrototypeShift, isArray as ArrayIsArray, from as ArrayFrom, stringify as JSONStringify, parse as JSONParse, };

package/package.json

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