awaitly 2.0.0 → 3.0.0

package/dist/store-contract-BI98VYmX.d.ts

@@ -0,0 +1,66 @@
+import { h as StepResult, R as ResumeState, b as WorkflowSnapshot } from './types-BDTxgKKc.js';
+
+/**
+ * Serialization for ResumeState to/from JSON-safe format.
+ * Centralizes Map serialization so adapters don't re-implement it.
+ */
+
+/**
+ * JSON-serializable resume state. Use this shape when persisting to storage.
+ * Discriminator `kind: "ResumeState"` enables adapters and migrations to detect format.
+ */
+type SerializedResumeState = {
+    kind: "ResumeState";
+    steps: [string, StepResult][];
+};
+/**
+ * Serialize resume state to a JSON-safe object. Preserves step order (array).
+ * Use with JSON.stringify for storage; adapters can rely on this shape.
+ *
+ * @example
+ * const serialized = serializeResumeState(collector.getResumeState());
+ * await store.save(id, JSON.stringify(serialized));
+ */
+declare function serializeResumeState(state: ResumeState): SerializedResumeState;
+/**
+ * Type guard for SerializedResumeState. Use when loading from storage to discriminate from WorkflowSnapshot.
+ */
+declare function isSerializedResumeState(x: unknown): x is SerializedResumeState;
+/**
+ * Deserialize from JSON-parsed object back to ResumeState (runtime Map).
+ *
+ * @example
+ * const parsed = JSON.parse(await store.load(id));
+ * if (isSerializedResumeState(parsed)) {
+ *   const state = deserializeResumeState(parsed);
+ *   await workflow.run(fn, { resumeState: state });
+ * }
+ */
+declare function deserializeResumeState(raw: SerializedResumeState): ResumeState;
+
+/**
+ * Extended persistence contract: save/load accept both WorkflowSnapshot and ResumeState.
+ * Use type guards (isWorkflowSnapshot, isResumeState, isSerializedResumeState) in adapters.
+ * Core persistence.SnapshotStore stays narrow; this module defines the broad contract and helpers.
+ */
+
+/** What stores persist (JSON/database shape). Use for type discrimination in adapters. */
+type PersistedWorkflowState = WorkflowSnapshot | SerializedResumeState;
+/** What save() can accept: snapshot or runtime resume state. Adapters branch with type guards. */
+type StoreSaveInput = WorkflowSnapshot | ResumeState;
+/** What load() can return. Use toResumeState() or loadResumeState for type-safe restore. */
+type StoreLoadResult = WorkflowSnapshot | ResumeState | null;
+/**
+ * Convert a loaded value to ResumeState for workflow.run(fn, { resumeState }).
+ * - If loaded is already ResumeState, returns it.
+ * - If loaded is null or WorkflowSnapshot, returns undefined (use run(fn, { snapshot }) for snapshots).
+ * Two explicit flows: resume from ResumeState vs resume from snapshot; don't pass snapshot to resumeState.
+ *
+ * @example
+ * const loaded = await store.load('wf-123');
+ * const resumeState = toResumeState(loaded);
+ * if (resumeState) await workflow.run(fn, { resumeState });
+ */
+declare function toResumeState(loaded: StoreLoadResult): ResumeState | undefined;
+
+export { type PersistedWorkflowState as P, type SerializedResumeState as S, type StoreLoadResult as a, type StoreSaveInput as b, deserializeResumeState as d, isSerializedResumeState as i, serializeResumeState as s, toResumeState as t };

package/dist/store-contract-C2HyR_o6.d.cts

@@ -0,0 +1,66 @@
+import { h as StepResult, R as ResumeState, b as WorkflowSnapshot } from './types-C9Y71dua.cjs';
+
+/**
+ * Serialization for ResumeState to/from JSON-safe format.
+ * Centralizes Map serialization so adapters don't re-implement it.
+ */
+
+/**
+ * JSON-serializable resume state. Use this shape when persisting to storage.
+ * Discriminator `kind: "ResumeState"` enables adapters and migrations to detect format.
+ */
+type SerializedResumeState = {
+    kind: "ResumeState";
+    steps: [string, StepResult][];
+};
+/**
+ * Serialize resume state to a JSON-safe object. Preserves step order (array).
+ * Use with JSON.stringify for storage; adapters can rely on this shape.
+ *
+ * @example
+ * const serialized = serializeResumeState(collector.getResumeState());
+ * await store.save(id, JSON.stringify(serialized));
+ */
+declare function serializeResumeState(state: ResumeState): SerializedResumeState;
+/**
+ * Type guard for SerializedResumeState. Use when loading from storage to discriminate from WorkflowSnapshot.
+ */
+declare function isSerializedResumeState(x: unknown): x is SerializedResumeState;
+/**
+ * Deserialize from JSON-parsed object back to ResumeState (runtime Map).
+ *
+ * @example
+ * const parsed = JSON.parse(await store.load(id));
+ * if (isSerializedResumeState(parsed)) {
+ *   const state = deserializeResumeState(parsed);
+ *   await workflow.run(fn, { resumeState: state });
+ * }
+ */
+declare function deserializeResumeState(raw: SerializedResumeState): ResumeState;
+
+/**
+ * Extended persistence contract: save/load accept both WorkflowSnapshot and ResumeState.
+ * Use type guards (isWorkflowSnapshot, isResumeState, isSerializedResumeState) in adapters.
+ * Core persistence.SnapshotStore stays narrow; this module defines the broad contract and helpers.
+ */
+
+/** What stores persist (JSON/database shape). Use for type discrimination in adapters. */
+type PersistedWorkflowState = WorkflowSnapshot | SerializedResumeState;
+/** What save() can accept: snapshot or runtime resume state. Adapters branch with type guards. */
+type StoreSaveInput = WorkflowSnapshot | ResumeState;
+/** What load() can return. Use toResumeState() or loadResumeState for type-safe restore. */
+type StoreLoadResult = WorkflowSnapshot | ResumeState | null;
+/**
+ * Convert a loaded value to ResumeState for workflow.run(fn, { resumeState }).
+ * - If loaded is already ResumeState, returns it.
+ * - If loaded is null or WorkflowSnapshot, returns undefined (use run(fn, { snapshot }) for snapshots).
+ * Two explicit flows: resume from ResumeState vs resume from snapshot; don't pass snapshot to resumeState.
+ *
+ * @example
+ * const loaded = await store.load('wf-123');
+ * const resumeState = toResumeState(loaded);
+ * if (resumeState) await workflow.run(fn, { resumeState });
+ */
+declare function toResumeState(loaded: StoreLoadResult): ResumeState | undefined;
+
+export { type PersistedWorkflowState as P, type SerializedResumeState as S, type StoreLoadResult as a, type StoreSaveInput as b, deserializeResumeState as d, isSerializedResumeState as i, serializeResumeState as s, toResumeState as t };