@salesforce/lds-drafts 1.124.2 → 1.124.3

package/dist/{DraftAwareAdapter.d.ts → types/DraftAwareAdapter.d.ts}

@@ -1,6 +1,6 @@
-import type { DispatchResourceRequestContext, Luvio, Snapshot } from '@luvio/engine';
-import type { AbstractResourceRequestActionHandler } from './actionHandlers/AbstractResourceRequestActionHandler';
-export type AdapterBuildNetworkSnapshot<Config, Response> = (luvio: Luvio, config: Config, dispatchResourceRequestContext?: DispatchResourceRequestContext) => Promise<Snapshot<Response>>;
-export declare function buildLuvioOverrideForDraftAdapters<ResponseType = unknown, DraftMetadata = unknown>(luvio: Luvio, handler: AbstractResourceRequestActionHandler<ResponseType, DraftMetadata>, extractTargetIdFromCacheKey: (cacheKey: string) => string | undefined, options?: {
-    forDeleteAdapter?: boolean;
-}): Luvio;
+import type { DispatchResourceRequestContext, Luvio, Snapshot } from '@luvio/engine';
+import type { AbstractResourceRequestActionHandler } from './actionHandlers/AbstractResourceRequestActionHandler';
+export type AdapterBuildNetworkSnapshot<Config, Response> = (luvio: Luvio, config: Config, dispatchResourceRequestContext?: DispatchResourceRequestContext) => Promise<Snapshot<Response>>;
+export declare function buildLuvioOverrideForDraftAdapters<ResponseType = unknown, DraftMetadata = unknown>(luvio: Luvio, handler: AbstractResourceRequestActionHandler<ResponseType, DraftMetadata>, extractTargetIdFromCacheKey: (cacheKey: string) => string | undefined, options?: {
+    forDeleteAdapter?: boolean;
+}): Luvio;

package/dist/{DraftFetchResponse.d.ts → types/DraftFetchResponse.d.ts}

@@ -1,28 +1,28 @@
-import type { FetchErrorResponse, FetchResponse, Headers } from '@luvio/engine';
-import { HttpStatusCode } from '@luvio/engine';
-import type { DraftSynthesisErrorType, DraftSynthesisError } from './DraftSynthesisError';
-export declare const DRAFT_ERROR_CODE = "DRAFT_ERROR";
-export declare class DraftFetchResponse<T> implements FetchResponse<T> {
-    status: HttpStatusCode;
-    body: T;
-    headers: Headers;
-    constructor(status: HttpStatusCode, body: T);
-    get statusText(): string;
-    get ok(): boolean;
-}
-export declare class DraftErrorFetchResponse implements FetchErrorResponse {
-    status: HttpStatusCode;
-    body: unknown;
-    ok: boolean;
-    headers: Headers;
-    errorType: 'fetchResponse';
-    constructor(status: HttpStatusCode.BadRequest | HttpStatusCode.ServerError | HttpStatusCode.NotFound, body: unknown);
-    get statusText(): string;
-}
-export declare function createOkResponse<T>(body: T): DraftFetchResponse<T>;
-export declare function createBadRequestResponse(body: unknown): DraftErrorFetchResponse;
-export declare function createNotFoundResponse(body: unknown): DraftErrorFetchResponse;
-export declare function transformErrorToDraftSynthesisError(error: Error | DraftSynthesisError<unknown>): DraftErrorFetchResponse;
-export declare function createDraftSynthesisErrorResponse(message?: string, errorType?: DraftSynthesisErrorType): DraftErrorFetchResponse;
-export declare function createDeletedResponse(): DraftFetchResponse<void>;
-export declare function createInternalErrorResponse(): DraftErrorFetchResponse;
+import type { FetchErrorResponse, FetchResponse, Headers } from '@luvio/engine';
+import { HttpStatusCode } from '@luvio/engine';
+import type { DraftSynthesisErrorType, DraftSynthesisError } from './DraftSynthesisError';
+export declare const DRAFT_ERROR_CODE = "DRAFT_ERROR";
+export declare class DraftFetchResponse<T> implements FetchResponse<T> {
+    status: HttpStatusCode;
+    body: T;
+    headers: Headers;
+    constructor(status: HttpStatusCode, body: T);
+    get statusText(): string;
+    get ok(): boolean;
+}
+export declare class DraftErrorFetchResponse implements FetchErrorResponse {
+    status: HttpStatusCode;
+    body: unknown;
+    ok: boolean;
+    headers: Headers;
+    errorType: 'fetchResponse';
+    constructor(status: HttpStatusCode.BadRequest | HttpStatusCode.ServerError | HttpStatusCode.NotFound, body: unknown);
+    get statusText(): string;
+}
+export declare function createOkResponse<T>(body: T): DraftFetchResponse<T>;
+export declare function createBadRequestResponse(body: unknown): DraftErrorFetchResponse;
+export declare function createNotFoundResponse(body: unknown): DraftErrorFetchResponse;
+export declare function transformErrorToDraftSynthesisError(error: Error | DraftSynthesisError<unknown>): DraftErrorFetchResponse;
+export declare function createDraftSynthesisErrorResponse(message?: string, errorType?: DraftSynthesisErrorType): DraftErrorFetchResponse;
+export declare function createDeletedResponse(): DraftFetchResponse<void>;
+export declare function createInternalErrorResponse(): DraftErrorFetchResponse;

package/dist/{DraftIdMapping.d.ts → types/DraftIdMapping.d.ts}

@@ -1,12 +1,12 @@
-import type { DurableStore } from '@luvio/environments';
-export interface DraftKeyMapping {
-    draftKey: string;
-    canonicalKey: string;
-}
-export declare const DRAFT_ID_MAPPINGS_SEGMENT = "DRAFT_ID_MAPPINGS";
-export declare function generateDraftIdMappingKey(draftIdMapping: DraftKeyMapping): string;
-/**
- *
- * @param mappingIds (optional) requested mapping ids, if undefined all will be retrieved
- */
-export declare function getDraftIdMappings(durableStore: DurableStore, mappingIds?: string[]): Promise<DraftKeyMapping[]>;
+import type { DurableStore } from '@luvio/environments';
+export interface DraftKeyMapping {
+    draftKey: string;
+    canonicalKey: string;
+}
+export declare const DRAFT_ID_MAPPINGS_SEGMENT = "DRAFT_ID_MAPPINGS";
+export declare function generateDraftIdMappingKey(draftIdMapping: DraftKeyMapping): string;
+/**
+ *
+ * @param mappingIds (optional) requested mapping ids, if undefined all will be retrieved
+ */
+export declare function getDraftIdMappings(durableStore: DurableStore, mappingIds?: string[]): Promise<DraftKeyMapping[]>;

package/dist/{DraftManager.d.ts → types/DraftManager.d.ts}

@@ -1,161 +1,161 @@
-import type { CustomActionResult } from './actionHandlers/CustomActionHandler';
-import type { DraftActionStatus, DraftQueue, DraftActionMetadata } from './DraftQueue';
-import { DraftQueueState } from './DraftQueue';
-/**
- * Representation of the current state of the draft queue.
- * Includes the overall state as well as a list of draft
- * items that are currently in the queue.
- */
-export interface DraftManagerState {
-    queueState: DraftQueueState;
-    items: DraftQueueItem[];
-}
-export type DraftQueueItemMetadata = {
-    [key: string]: string;
-};
-export type DraftManagerCustomActionExecutor = (item: DraftQueueItem, completed: (result: CustomActionResult) => void) => void;
-/**
- * An item in the draft queue that loosely maps to
- * a DraftAction
- */
-export interface DraftQueueItem {
-    /** The id of the Draft Action Item */
-    id: string;
-    /** The unique id of the target item */
-    targetId?: string;
-    /** The current status of this item */
-    state: DraftActionStatus;
-    /** The type of operation this item represents */
-    operationType: DraftActionOperationType;
-    /** Timestamp as unix epoch time */
-    timestamp: number;
-    /** undefined unless item is in an error state */
-    error?: undefined | DraftQueueItemError;
-    /** The stored metadata for the draft queue item */
-    metadata: DraftQueueItemMetadata;
-}
-/**
- * An error of a draft action that was submitted and failed
- */
-export interface DraftQueueItemError {
-    /** The status code of the response */
-    status: number;
-    /** The headers of the response */
-    headers: {
-        [key: string]: string;
-    };
-    /** A flag representing the status of the response */
-    ok: boolean;
-    /** A summary of the response */
-    statusText: string;
-    /** A stringified object representing the body of the response */
-    bodyString: string;
-}
-/**
- * Denotes what kind of operation a DraftQueueItem represents.
- */
-export declare enum DraftActionOperationType {
-    Create = "create",
-    Update = "update",
-    Delete = "delete",
-    Custom = "custom"
-}
-export declare enum DraftQueueOperationType {
-    ItemAdded = "added",
-    ItemDeleted = "deleted",
-    ItemCompleted = "completed",
-    ItemFailed = "failed",
-    ItemUpdated = "updated",
-    QueueStarted = "started",
-    QueueStopped = "stopped"
-}
-/**
- * A closure that draft queue change listeners pass to
- * receive updates when the draft queue changes.
- */
-export declare type DraftQueueListener = (state: DraftManagerState, operationType: DraftQueueOperationType, queueItem?: DraftQueueItem) => void;
-export declare class DraftManager {
-    private draftQueue;
-    private listeners;
-    constructor(draftQueue: DraftQueue);
-    private shouldEmitDraftEvent;
-    private draftQueueEventTypeToOperationType;
-    private draftQueueStateToOperationType;
-    /**
-     * Enqueue a custom action on the DraftQueue for a handler
-     * @param handler the handler's id
-     * @param targetId
-     * @param tag - the key to group with in durable store
-     * @param metadata
-     * @returns
-     */
-    addCustomAction(handler: string, targetId: string, tag: string, metadata: DraftActionMetadata): Promise<DraftQueueItem>;
-    /**
-     * Get the current state of each of the DraftActions in the DraftQueue
-     * @returns A promise of an array of the state of each item in the DraftQueue
-     */
-    getQueue(): Promise<DraftManagerState>;
-    /**
-     * Starts the draft queue and begins processing the first item in the queue.
-     */
-    startQueue(): Promise<void>;
-    /**
-     * Stops the draft queue from processing more draft items after any current
-     * in progress items are finished.
-     */
-    stopQueue(): Promise<void>;
-    /**
-     * Subscribes the listener to changes to the draft queue.
-     *
-     * Returns a closure to invoke in order to unsubscribe the listener
-     * from changes to the draft queue.
-     *
-     * @param listener The listener closure to subscribe to changes
-     */
-    registerDraftQueueChangedListener(listener: DraftQueueListener): () => Promise<void>;
-    /**
-     * Creates a custom action handler for the given handler
-     * @param handlerId
-     * @param executor
-     * @returns
-     */
-    setCustomActionExecutor(handlerId: string, executor: DraftManagerCustomActionExecutor): Promise<() => Promise<void>>;
-    private buildDraftQueueItem;
-    private callListeners;
-    /**
-     * Removes the draft action identified by actionId from the draft queue.
-     *
-     * @param actionId The action identifier
-     *
-     * @returns The current state of the draft queue
-     */
-    removeDraftAction(actionId: string): Promise<DraftManagerState>;
-    /**
-     * Replaces the resource request of `withAction` for the resource request
-     * of `actionId`. Action ids cannot be equal. Both actions must be acting
-     * on the same target object, and neither can currently be in progress.
-     *
-     * @param actionId The id of the draft action to replace
-     * @param withActionId The id of the draft action that will replace the other
-     */
-    replaceAction(actionId: string, withActionId: string): Promise<DraftQueueItem>;
-    /**
-     * Merges two actions into a single target action. The target action maintains
-     * its position in the queue, while the source action is removed from the queue.
-     * Action ids cannot be equal. Both actions must be acting on the same target
-     * object, and neither can currently be in progress.
-     *
-     * @param targetActionId The draft action id of the target action. This action
-     * will be replaced with the merged result.
-     * @param sourceActionId The draft action id to merge onto the target. This
-     * action will be removed after the merge.
-     */
-    mergeActions(targetActionId: string, sourceActionId: string): Promise<DraftQueueItem>;
-    /**
-     * Sets the metadata object of the specified action to the
-     * provided metadata
-     * @param actionId The id of the action to set the metadata on
-     * @param metadata The metadata to set on the specified action
-     */
-    setMetadata(actionId: string, metadata: DraftQueueItemMetadata): Promise<DraftQueueItem>;
-}
+import type { CustomActionResult } from './actionHandlers/CustomActionHandler';
+import type { DraftActionStatus, DraftQueue, DraftActionMetadata } from './DraftQueue';
+import { DraftQueueState } from './DraftQueue';
+/**
+ * Representation of the current state of the draft queue.
+ * Includes the overall state as well as a list of draft
+ * items that are currently in the queue.
+ */
+export interface DraftManagerState {
+    queueState: DraftQueueState;
+    items: DraftQueueItem[];
+}
+export type DraftQueueItemMetadata = {
+    [key: string]: string;
+};
+export type DraftManagerCustomActionExecutor = (item: DraftQueueItem, completed: (result: CustomActionResult) => void) => void;
+/**
+ * An item in the draft queue that loosely maps to
+ * a DraftAction
+ */
+export interface DraftQueueItem {
+    /** The id of the Draft Action Item */
+    id: string;
+    /** The unique id of the target item */
+    targetId?: string;
+    /** The current status of this item */
+    state: DraftActionStatus;
+    /** The type of operation this item represents */
+    operationType: DraftActionOperationType;
+    /** Timestamp as unix epoch time */
+    timestamp: number;
+    /** undefined unless item is in an error state */
+    error?: undefined | DraftQueueItemError;
+    /** The stored metadata for the draft queue item */
+    metadata: DraftQueueItemMetadata;
+}
+/**
+ * An error of a draft action that was submitted and failed
+ */
+export interface DraftQueueItemError {
+    /** The status code of the response */
+    status: number;
+    /** The headers of the response */
+    headers: {
+        [key: string]: string;
+    };
+    /** A flag representing the status of the response */
+    ok: boolean;
+    /** A summary of the response */
+    statusText: string;
+    /** A stringified object representing the body of the response */
+    bodyString: string;
+}
+/**
+ * Denotes what kind of operation a DraftQueueItem represents.
+ */
+export declare enum DraftActionOperationType {
+    Create = "create",
+    Update = "update",
+    Delete = "delete",
+    Custom = "custom"
+}
+export declare enum DraftQueueOperationType {
+    ItemAdded = "added",
+    ItemDeleted = "deleted",
+    ItemCompleted = "completed",
+    ItemFailed = "failed",
+    ItemUpdated = "updated",
+    QueueStarted = "started",
+    QueueStopped = "stopped"
+}
+/**
+ * A closure that draft queue change listeners pass to
+ * receive updates when the draft queue changes.
+ */
+export declare type DraftQueueListener = (state: DraftManagerState, operationType: DraftQueueOperationType, queueItem?: DraftQueueItem) => void;
+export declare class DraftManager {
+    private draftQueue;
+    private listeners;
+    constructor(draftQueue: DraftQueue);
+    private shouldEmitDraftEvent;
+    private draftQueueEventTypeToOperationType;
+    private draftQueueStateToOperationType;
+    /**
+     * Enqueue a custom action on the DraftQueue for a handler
+     * @param handler the handler's id
+     * @param targetId
+     * @param tag - the key to group with in durable store
+     * @param metadata
+     * @returns
+     */
+    addCustomAction(handler: string, targetId: string, tag: string, metadata: DraftActionMetadata): Promise<DraftQueueItem>;
+    /**
+     * Get the current state of each of the DraftActions in the DraftQueue
+     * @returns A promise of an array of the state of each item in the DraftQueue
+     */
+    getQueue(): Promise<DraftManagerState>;
+    /**
+     * Starts the draft queue and begins processing the first item in the queue.
+     */
+    startQueue(): Promise<void>;
+    /**
+     * Stops the draft queue from processing more draft items after any current
+     * in progress items are finished.
+     */
+    stopQueue(): Promise<void>;
+    /**
+     * Subscribes the listener to changes to the draft queue.
+     *
+     * Returns a closure to invoke in order to unsubscribe the listener
+     * from changes to the draft queue.
+     *
+     * @param listener The listener closure to subscribe to changes
+     */
+    registerDraftQueueChangedListener(listener: DraftQueueListener): () => Promise<void>;
+    /**
+     * Creates a custom action handler for the given handler
+     * @param handlerId
+     * @param executor
+     * @returns
+     */
+    setCustomActionExecutor(handlerId: string, executor: DraftManagerCustomActionExecutor): Promise<() => Promise<void>>;
+    private buildDraftQueueItem;
+    private callListeners;
+    /**
+     * Removes the draft action identified by actionId from the draft queue.
+     *
+     * @param actionId The action identifier
+     *
+     * @returns The current state of the draft queue
+     */
+    removeDraftAction(actionId: string): Promise<DraftManagerState>;
+    /**
+     * Replaces the resource request of `withAction` for the resource request
+     * of `actionId`. Action ids cannot be equal. Both actions must be acting
+     * on the same target object, and neither can currently be in progress.
+     *
+     * @param actionId The id of the draft action to replace
+     * @param withActionId The id of the draft action that will replace the other
+     */
+    replaceAction(actionId: string, withActionId: string): Promise<DraftQueueItem>;
+    /**
+     * Merges two actions into a single target action. The target action maintains
+     * its position in the queue, while the source action is removed from the queue.
+     * Action ids cannot be equal. Both actions must be acting on the same target
+     * object, and neither can currently be in progress.
+     *
+     * @param targetActionId The draft action id of the target action. This action
+     * will be replaced with the merged result.
+     * @param sourceActionId The draft action id to merge onto the target. This
+     * action will be removed after the merge.
+     */
+    mergeActions(targetActionId: string, sourceActionId: string): Promise<DraftQueueItem>;
+    /**
+     * Sets the metadata object of the specified action to the
+     * provided metadata
+     * @param actionId The id of the action to set the metadata on
+     * @param metadata The metadata to set on the specified action
+     */
+    setMetadata(actionId: string, metadata: DraftQueueItemMetadata): Promise<DraftQueueItem>;
+}