@salesforce/lds-runtime-mobile 1.316.0 → 1.317.0

package/sfdc/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/sfdc/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/sfdc/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/sfdc/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/sfdc/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/sfdc/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';