@superdurable/dex 1.15.0 → 1.17.0

package/dist/src/gen/dex.d.ts

@@ -4,6 +4,24 @@ import { Duration } from "./google/protobuf/duration.js";
 import { Empty } from "./google/protobuf/empty.js";
 import { NullValue } from "./google/protobuf/struct.js";
 export declare const protobufPackage = "dex";
+/**
+ * Identifies the engine behind a Dex Server. Clients use it only to adapt behavior that differs
+ * between engines.
+ */
+export declare enum ServerEngine {
+    /**
+     * SERVER_ENGINE_UNSPECIFIED - The Server does not report its engine. Servers released before this field existed are the
+     * Go Server on Temporal or Cadence.
+     */
+    SERVER_ENGINE_UNSPECIFIED = 0,
+    /** SERVER_ENGINE_TEMPORAL - The Go Server running on Temporal. */
+    SERVER_ENGINE_TEMPORAL = 1,
+    /** SERVER_ENGINE_CADENCE - The Go Server running on Cadence. */
+    SERVER_ENGINE_CADENCE = 2,
+    /** SERVER_ENGINE_ZD - server-zd: the zero-dependency Server that keeps all state in object storage. */
+    SERVER_ENGINE_ZD = 3,
+    UNRECOGNIZED = -1
+}
 /** Explains why a Worker declined a task. */
 export declare enum PollWorkerTaskRejectReason {
     /** POLL_WORKER_TASK_REJECT_REASON_UNSPECIFIED - No rejection reason was supplied. */
@@ -16,7 +34,10 @@ export declare enum PollWorkerTaskRejectReason {
     POLL_WORKER_TASK_REJECT_REASON_UNKNOWN_RPC = 3,
     UNRECOGNIZED = -1
 }
-/** Distinguishes no available Worker, a disconnected Worker, and a missing Step or RPC registration. */
+/**
+ * Distinguishes no available Worker, a disconnected Worker, and a missing Step or RPC registration.
+ * Go Server internals; server-zd does not serve or persist them.
+ */
 export declare enum DispatchTaskErrorReason {
     DISPATCH_TASK_ERROR_REASON_UNSPECIFIED = 0,
     DISPATCH_TASK_ERROR_REASON_NO_WORKER_AVAILABLE = 1,
@@ -41,12 +62,14 @@ export declare enum IndexType {
 export declare enum WaitForMethodFailurePolicy {
     WAIT_FOR_METHOD_FAILURE_POLICY_UNSPECIFIED = 0,
     WAIT_FOR_METHOD_FAILURE_POLICY_FAIL_FLOW_ON_FAILURE = 1,
+    /** WAIT_FOR_METHOD_FAILURE_POLICY_PROCEED_ON_FAILURE - Execute runs after the final WaitFor failure. */
     WAIT_FOR_METHOD_FAILURE_POLICY_PROCEED_ON_FAILURE = 2,
     UNRECOGNIZED = -1
 }
 export declare enum ExecuteMethodFailurePolicy {
     EXECUTE_METHOD_FAILURE_POLICY_UNSPECIFIED = 0,
     EXECUTE_METHOD_FAILURE_POLICY_FAIL_FLOW_ON_EXECUTE_METHOD_FAILURE = 1,
+    /** EXECUTE_METHOD_FAILURE_POLICY_PROCEED_TO_CONFIGURED_STEP - The configured recovery Step starts after the final Execute failure. */
     EXECUTE_METHOD_FAILURE_POLICY_PROCEED_TO_CONFIGURED_STEP = 2,
     UNRECOGNIZED = -1
 }
@@ -65,7 +88,10 @@ export declare enum ActiveStepSearchMode {
     ACTIVE_STEP_SEARCH_MODE_DISABLED = 3,
     UNRECOGNIZED = -1
 }
-/** Was optimize_activity: false=SYNC, true=ASYNC. Timer is always optimized by the server. */
+/**
+ * Was optimize_activity: false=SYNC, true=ASYNC. Timer is always optimized by the server.
+ * On server-zd both durabilities record the same events. ASYNC advances without waiting for the commit; there is no local phase.
+ */
 export declare enum StepDurability {
     STEP_DURABILITY_UNSPECIFIED = 0,
     STEP_DURABILITY_SYNC = 1,
@@ -91,10 +117,14 @@ export declare enum FlowStatus {
     FLOW_STATUS_RUNNING = 1,
     FLOW_STATUS_COMPLETED = 2,
     FLOW_STATUS_FAILED = 3,
-    /** FLOW_STATUS_SERVER_SIDE_TIMEOUT_INTERNAL_ONLY - Reserved for reporting a backend hard timeout; applications must not depend on this status. */
+    /**
+     * FLOW_STATUS_SERVER_SIDE_TIMEOUT_INTERNAL_ONLY - Reserved for reporting a backend hard timeout; applications must not depend on this status.
+     * server-zd never returns this status.
+     */
     FLOW_STATUS_SERVER_SIDE_TIMEOUT_INTERNAL_ONLY = 4,
     FLOW_STATUS_TERMINATED = 5,
     FLOW_STATUS_CANCELED = 6,
+    /** FLOW_STATUS_CONTINUED_AS_NEW - server-zd never returns this status. */
     FLOW_STATUS_CONTINUED_AS_NEW = 7,
     UNRECOGNIZED = -1
 }
@@ -110,7 +140,10 @@ export declare enum FlowErrorType {
     FLOW_ERROR_TYPE_INTERNAL = 6,
     UNRECOGNIZED = -1
 }
-/** PendingStepMethodPhase reports the latest persisted backend lifecycle event. */
+/**
+ * PendingStepMethodPhase reports the latest persisted backend lifecycle event.
+ * On server-zd, SCHEDULED waits for locks or dispatch. STARTED means an attempt is running.
+ */
 export declare enum PendingStepMethodPhase {
     PENDING_STEP_METHOD_PHASE_UNSPECIFIED = 0,
     PENDING_STEP_METHOD_PHASE_SCHEDULED = 1,
@@ -225,6 +258,8 @@ export interface ServerInfo {
     minimumSupportedProtocolVersion: number;
     /** Newest protocol version implemented by this Server. */
     currentProtocolVersion: number;
+    /** The engine behind this Server. */
+    serverEngine: ServerEngine;
 }
 /** Carries one Worker frame on a pull stream. Register must be the first frame. */
 export interface PollWorkerTaskRequest {
@@ -369,7 +404,10 @@ export interface PollWorkerTaskReconnect {
 /** Checks that an idle pull stream remains responsive. */
 export interface PollWorkerTaskPing {
 }
-/** Describes one task dispatched to a Dex task queue. */
+/**
+ * Describes one task dispatched to a Dex task queue.
+ * Go Server internals; server-zd does not serve or persist them.
+ */
 export interface DispatchTaskRequest {
     /** Selects the initial queue: a sticky Worker ID or a Flow type. */
     queue: string;
@@ -406,7 +444,10 @@ export interface DispatchTaskRequest {
     /** Allows matching to return UNKNOWN_NAME after a Worker rejects an unknown Step type or RPC name. */
     supportsUnknownNameError: boolean;
 }
-/** Reports assignment changes, relays Worker output, then ends with a result, Worker error, or dispatch error. */
+/**
+ * Reports assignment changes, relays Worker output, then ends with a result, Worker error, or dispatch error.
+ * Go Server internals; server-zd does not serve or persist them.
+ */
 export interface DispatchTaskResponse {
     output: {
         $case: "waitFor";
@@ -439,19 +480,28 @@ export interface DispatchTaskResponse {
     /** Identifies a Worker that rejected the task's Step type or RPC name. */
     rejectedByAppWorkerId: string;
 }
-/** Reports a failure before Dex receives a Worker result. */
+/**
+ * Reports a failure before Dex receives a Worker result.
+ * Go Server internals; server-zd does not serve or persist them.
+ */
 export interface DispatchTaskError {
     reason: DispatchTaskErrorReason;
     detail: string;
 }
 export interface Value {
     kind: //
-    /** Hydrate from blob storage, then replace with string_value. */
+    /**
+     * Hydrate from blob storage, then replace with string_value.
+     * The Server chooses this reference text; clients must treat it as opaque.
+     */
     {
         $case: "internalBlobIdForStringValue";
         value: string;
     } | //
-    /** Hydrate from blob storage, then replace with obj_value. */
+    /**
+     * Hydrate from blob storage, then replace with obj_value.
+     * The Server chooses this reference text; clients must treat it as opaque.
+     */
     {
         $case: "internalBlobIdForObjValue";
         value: string;
@@ -532,7 +582,14 @@ export interface Context {
     /** Previous Step method failure supplied only to its configured recovery method. */
     recoveryError: RecoveryErrorInfo | undefined;
     lastHeartbeatValue: Value | undefined;
+    /**
+     * server-zd only: the run attempt that dispatched this invocation. It starts at 1 and
+     * increases on each time travel. On server-zd, run_id stays the same across run attempts,
+     * so combine both when an idempotency key must change after time travel.
+     */
+    runAttempt: number;
 }
+/** server-zd never sets this. */
 export interface LocalActivityMetadata {
     currentStepExecutionId: string;
     fromStepExecutionId: string;
@@ -544,6 +601,7 @@ export interface RetryPolicy {
     maximumAttempts: number;
     totalDurationSeconds: number;
 }
+/** server-zd does not support Flow retry and rejects a set policy with INVALID_ARGUMENT. */
 export interface FlowRetryPolicy {
     initialIntervalSeconds: number;
     backoffCoefficient: number;
@@ -557,7 +615,9 @@ export interface StepOptions {
     executeRetryPolicy: RetryPolicy | undefined;
     waitForFailurePolicy: WaitForMethodFailurePolicy;
     executeFailurePolicy: ExecuteMethodFailurePolicy;
+    /** Step type started after the final Execute failure. */
     executeFailureProceedStepType: string;
+    /** Options of the recovery Step. */
     executeFailureProceedStepOptions: StepOptions | undefined;
     skipWaitFor: boolean;
     waitForDurabilityOverride: StepDurability;
@@ -577,7 +637,9 @@ export interface FlowTimeoutHandlerOptions {
     heartbeatTimeoutSeconds: number;
     retryPolicy: RetryPolicy | undefined;
     failurePolicy: ExecuteMethodFailurePolicy;
+    /** Step type started after the final timeout handler failure. */
     failureProceedStepType: string;
+    /** Options of the recovery Step. */
     failureProceedStepOptions: StepOptions | undefined;
     durabilityOverride: StepDurability;
     lockAttributeKeys: string[];
@@ -590,7 +652,9 @@ export interface FlowAlreadyStartedOptions {
 }
 export interface FlowStartOptions {
     idReusePolicy: IdReusePolicy;
+    /** server-zd rejects a positive start delay with INVALID_ARGUMENT. */
     flowStartDelaySeconds: number;
+    /** server-zd rejects a set policy with INVALID_ARGUMENT. */
     retryPolicy: FlowRetryPolicy | undefined;
     attributes: AttributeWrite[];
     flowConfigOverride: FlowConfig | undefined;
@@ -599,7 +663,9 @@ export interface FlowStartOptions {
 }
 export interface FlowConfig {
     activeStepSearchMode?: ActiveStepSearchMode | undefined;
+    /** server-zd ignores this field. */
     continueAsNewThreshold?: number | undefined;
+    /** server-zd ignores this field. */
     continueAsNewPageSizeInBytes?: number | undefined;
     stepDurability?: StepDurability | undefined;
     workerTarget: WorkerTarget | undefined;
@@ -610,8 +676,12 @@ export interface AttributeStoreNames {
     names: string[];
 }
 export interface WorkerTarget {
-    /** Plaintext gRPC dial target, not an HTTP URL. */
+    /**
+     * Plaintext gRPC dial target, not an HTTP URL.
+     * server-zd accepts only is_pull_mode and rejects address targets with INVALID_ARGUMENT.
+     */
     address: string;
+    /** server-zd accepts only is_pull_mode and rejects address targets with INVALID_ARGUMENT. */
     isHeadlessAddress: boolean;
     /** Routes work through a connected pull Worker; mutually exclusive with address. */
     isPullMode: boolean;
@@ -758,6 +828,7 @@ export interface SearchFlowsRequest {
     query: string;
     pageSize: number;
     nextPageToken: string;
+    /** server-zd ignores this field. */
     includeContinuedAsNew: boolean;
 }
 export interface SearchFlowsResponse {
@@ -794,12 +865,15 @@ export interface GetFlowSummaryRequest {
 }
 export interface GetFlowSummaryResponse {
     flowExecutionId: FlowExecutionID | undefined;
+    /** On server-zd this always equals run_id. */
     firstRunId: string;
     requestId: string;
     flowType: string;
     flowStatus: FlowStatus;
     startTime: Date | undefined;
     closeTime: Date | undefined;
+    /** server-zd only: the current run attempt of this run. */
+    runAttempt: number;
 }
 export interface InternalAsyncStepInputSnapshot {
     methodOptions: StepMethodOptions | undefined;
@@ -821,6 +895,11 @@ export interface GetHistoryEventsRequest {
     startInternalEventId: bigint;
     estimatePageSize: number;
     nextPageToken: Uint8Array;
+    /**
+     * server-zd only: selects the run attempt whose lineage is returned. Zero selects the current
+     * run attempt.
+     */
+    runAttempt: number;
 }
 export interface GetHistoryEventsResponse {
     events: FlowHistoryEvent[];
@@ -830,6 +909,8 @@ export interface GetHistoryEventsResponse {
 export interface FlowHistoryEvent {
     eventId: bigint;
     eventTime: Date | undefined;
+    /** server-zd only: the run attempt that recorded this event. */
+    runAttempt: number;
     payload: {
         $case: "flowStartedOrContinued";
         value: FlowStartedOrContinuedHistoryEvent;
@@ -872,6 +953,12 @@ export interface FlowHistoryEvent {
 export interface TimeTravelForkHistoryEvent {
     /** Previous run containing the original history branch. */
     previousRunId: string;
+    /** server-zd only: the run attempt that was current before this time travel. */
+    previousRunAttempt: number;
+    /** server-zd only: the run attempt of the point this time travel returned to. */
+    targetRunAttempt: number;
+    /** server-zd only: the event ID of the point this time travel returned to. */
+    targetEventId: bigint;
 }
 export interface FlowStartedOrContinuedHistoryEvent {
     flowExecutionId: FlowExecutionID | undefined;
@@ -883,7 +970,9 @@ export interface FlowStartedOrContinuedHistoryEvent {
     startOrContinue: {
         $case: "initialStart";
         value: FlowInitialStart;
-    } | {
+    } | //
+    /** server-zd never sets this. */
+    {
         $case: "continuedStart";
         value: FlowContinuedStart;
     } | undefined;
@@ -894,6 +983,7 @@ export interface FlowInitialStart {
     stepOptions: StepOptions | undefined;
     initialAttributes: KV[];
 }
+/** server-zd never sets this. */
 export interface FlowContinuedStart {
     previousRunId: string;
     stepsToStart: StepMovement[];
@@ -914,6 +1004,7 @@ export interface FlowClosedHistoryEvent {
     results: StepCompletionOutput[];
     errorType: FlowErrorType;
     errorMessage: string;
+    /** server-zd never sets this. */
     continuedToRunId: string;
     stickyAppWorkerId: string;
 }
@@ -1073,9 +1164,16 @@ export interface ResetFlowRequest {
     /** Skips reapplying RPCs, Channel publications, and Attribute writes after the reset point. */
     skipWritesReapply: boolean;
     stepMethod: FlowResetStepMethod;
+    /**
+     * server-zd only: selects the run attempt whose history is searched for the reset point.
+     * Zero selects the current run attempt.
+     */
+    runAttempt: number;
 }
 export interface ResetFlowResponse {
     runId: string;
+    /** server-zd only: the run attempt created by this time travel. run_id does not change there. */
+    runAttempt: number;
 }
 export interface InvokeRPCRequest {
     flowId: string;
@@ -1089,7 +1187,10 @@ export interface InvokeRPCRequest {
      * read-modify-write. Empty means no locking and uses the configured RPC path.
      */
     lockAttributeKeys: string[];
-    /** Per-call UUID, SDK-generated and future-overridable; identical retries reuse it. Temporal Update paths use it as the run-scoped Update ID; Continue-as-New resets scope. */
+    /**
+     * Per-call UUID, SDK-generated and future-overridable; identical retries reuse it. Temporal Update paths use it as the run-scoped Update ID; Continue-as-New resets scope.
+     * server-zd deduplicates it for the whole run.
+     */
     requestId: string;
     /**
      * Requests transactional reads and writes. Attribute locking enables it
@@ -1139,6 +1240,7 @@ export interface WaitForStepCompletionRequest {
      * Use a positive value only to reclaim accepted waits left in flight after callers exit.
      * Temporal permits 10 in-flight Updates per Workflow Execution. Active callers transparently
      * start a new generation. Zero disables rollover; each rollover adds Update history.
+     * server-zd ignores this field.
      */
     internalHandlerTimeoutSeconds: number;
     /** Optional logical idempotency key. Empty derives wait-for-step-completion:{Step execution ID}. */
@@ -1159,6 +1261,7 @@ export interface WaitForAttributeRequest {
      * Use a positive value only to reclaim accepted waits left in flight after callers exit.
      * Temporal permits 10 in-flight Updates per Workflow Execution. Active callers transparently
      * start a new generation. Zero disables rollover; each rollover adds Update history.
+     * server-zd ignores this field.
      */
     internalHandlerTimeoutSeconds: number;
     /** Optional logical idempotency key. Empty derives wait-for-attribute:{encoded condition}. */
@@ -1245,7 +1348,10 @@ export interface InvokeWaitForMethodRequest_LoadedChannelMessagesEntry {
     value: ChannelValues | undefined;
 }
 export interface InvokeWaitForMethodResponse {
-    /** Server-populated lineage input for local activity history. */
+    /**
+     * Server-populated lineage input for local activity history.
+     * server-zd never sets this.
+     */
     localActivityMetadata: LocalActivityMetadata | undefined;
     upsertAttributes: AttributeWrite[];
     waitingCondition: WaitingCondition | undefined;
@@ -1302,7 +1408,10 @@ export interface InvokeExecuteMethodRequest_LoadedChannelMessagesEntry {
     value: ChannelValues | undefined;
 }
 export interface InvokeExecuteMethodResponse {
-    /** Server-populated lineage input for local activity history. */
+    /**
+     * Server-populated lineage input for local activity history.
+     * server-zd never sets this.
+     */
     localActivityMetadata: LocalActivityMetadata | undefined;
     stepDecision: StepDecision | undefined;
     upsertAttributes: AttributeWrite[];
@@ -1397,7 +1506,9 @@ export interface WaitingConditionState {
 export interface SubFlowOptions {
     reusePolicy: SubFlowReusePolicy;
     flowTimeoutSeconds: number;
+    /** server-zd rejects a positive start delay with INVALID_ARGUMENT. */
     flowStartDelaySeconds: number;
+    /** server-zd rejects a set policy with INVALID_ARGUMENT. */
     retryPolicy: FlowRetryPolicy | undefined;
     attributes: AttributeWrite[];
     flowConfigOverride: FlowConfig | undefined;
@@ -1595,6 +1706,7 @@ export interface RecoveryErrorInfo {
     errorType: string;
 }
 export interface InternalLocalStepActivityFailure {
+    /** server-zd never sets this. */
     localActivityMetadata: LocalActivityMetadata | undefined;
     firstAttemptTimestamp: bigint;
     methodOptions: StepMethodOptions | undefined;
@@ -2190,6 +2302,7 @@ export declare const FlowServiceService: {
         readonly responseSerialize: (value: WaitForAttributeResponse) => Buffer;
         readonly responseDeserialize: (value: Buffer) => WaitForAttributeResponse;
     };
+    /** server-zd returns UNIMPLEMENTED. */
     readonly triggerContinueAsNew: {
         readonly path: "/dex.FlowService/TriggerContinueAsNew";
         readonly requestStream: false;
@@ -2236,6 +2349,7 @@ export interface FlowServiceServer extends UntypedServiceImplementation {
     updateFlowConfig: handleUnaryCall<UpdateFlowConfigRequest, Empty>;
     waitForStepCompletion: handleUnaryCall<WaitForStepCompletionRequest, WaitForStepCompletionResponse>;
     waitForAttribute: handleUnaryCall<WaitForAttributeRequest, WaitForAttributeResponse>;
+    /** server-zd returns UNIMPLEMENTED. */
     triggerContinueAsNew: handleUnaryCall<TriggerContinueAsNewRequest, Empty>;
     healthCheck: handleUnaryCall<Empty, HealthInfo>;
 }
@@ -2316,6 +2430,7 @@ export interface FlowServiceClient extends Client {
     waitForAttribute(request: WaitForAttributeRequest, callback: (error: ServiceError | null, response: WaitForAttributeResponse) => void): ClientUnaryCall;
     waitForAttribute(request: WaitForAttributeRequest, metadata: Metadata, callback: (error: ServiceError | null, response: WaitForAttributeResponse) => void): ClientUnaryCall;
     waitForAttribute(request: WaitForAttributeRequest, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: WaitForAttributeResponse) => void): ClientUnaryCall;
+    /** server-zd returns UNIMPLEMENTED. */
     triggerContinueAsNew(request: TriggerContinueAsNewRequest, callback: (error: ServiceError | null, response: Empty) => void): ClientUnaryCall;
     triggerContinueAsNew(request: TriggerContinueAsNewRequest, metadata: Metadata, callback: (error: ServiceError | null, response: Empty) => void): ClientUnaryCall;
     triggerContinueAsNew(request: TriggerContinueAsNewRequest, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: Empty) => void): ClientUnaryCall;
@@ -2328,7 +2443,10 @@ export declare const FlowServiceClient: {
     service: typeof FlowServiceService;
     serviceName: string;
 };
-/** Hosted by Dex worker; server calls these RPCs. */
+/**
+ * Hosted by Dex worker; server calls these RPCs.
+ * server-zd supports only pull Workers and never calls WorkerService.
+ */
 export type WorkerServiceService = typeof WorkerServiceService;
 export declare const WorkerServiceService: {
     readonly invokeWaitForMethod: {
@@ -2407,7 +2525,10 @@ export declare const WorkerTaskServiceClient: {
     service: typeof WorkerTaskServiceService;
     serviceName: string;
 };
-/** Hosted on the internal listener; server instances route tasks and Worker streams to queue owners. */
+/**
+ * Hosted on the internal listener; server instances route tasks and Worker streams to queue owners.
+ * Go Server internals; server-zd does not serve or persist them.
+ */
 export type MatchingServiceService = typeof MatchingServiceService;
 export declare const MatchingServiceService: {
     /** Streams Worker output frames and a final result or dispatch error. */
@@ -2451,7 +2572,10 @@ export declare const MatchingServiceClient: {
     service: typeof MatchingServiceService;
     serviceName: string;
 };
-/** Server-internal only (interpreter CAN activity → API). Not SDK-facing. */
+/**
+ * Server-internal only (interpreter CAN activity → API). Not SDK-facing.
+ * Go Server internals; server-zd does not serve or persist them.
+ */
 export type InternalServiceService = typeof InternalServiceService;
 export declare const InternalServiceService: {
     readonly dumpFlowForContinueAsNew: {