@domino-sdk/relay 1.6.0 → 1.9.0

package/dist/action-9Xl0StBg.d.ts

@@ -0,0 +1,33 @@
+import { R as RequestError } from './request-error-D_dUPLwo.js';
+
+/** SDK input convenience; the wire request always carries a key. */
+type OptionalActionId<T> = T extends {
+    actionId: string;
+} ? Omit<T, "actionId"> & {
+    actionId?: string;
+} : never;
+/** One logical write. Keep this object until its outcome is definite. */
+type RelayAction<T> = {
+    /** The pending write's key, also available on its uncertain error as `operationId`. */
+    readonly actionId: string | undefined;
+    readonly busy: boolean;
+    readonly error: RequestError | undefined;
+    /**
+     * Starts a write with a generated key. While an uncertain write is pending, replays its saved
+     * callback instead of accepting a different write. Concurrent calls share one request.
+     * Put refreshes and other follow-up work outside the callback.
+     */
+    run(task: (actionId: string) => Promise<T>): Promise<T>;
+    /** Replays the exact pending callback and key, only when the error's recovery is `replay`. */
+    retry(): Promise<T>;
+    /** Acknowledge an authoritative, definite outcome after reconciliation. Refuses while busy. */
+    settle(): boolean;
+};
+/**
+ * Owns a mutation key across uncertain answers. A definite success or refusal ends the action;
+ * the next `run` gets a new key. `reconcile` failures stay pending and cannot be replayed.
+ * In-memory only: persist the key yourself if recovery must survive a reload or process restart.
+ */
+declare function createRelayAction<T = unknown>(): RelayAction<T>;
+
+export { type OptionalActionId as O, type RelayAction as R, createRelayAction as c };