@supacloud/js 0.35.0 → 0.36.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/COMPATIBILITY.md +84 -0
- package/README.md +7 -0
- package/dist/api-error.d.mts +6 -0
- package/dist/{artifact-fetch.d.ts → artifact-fetch.d.cts} +1 -1
- package/dist/artifact-fetch.d.mts +6 -0
- package/dist/{artifact-link.d.ts → artifact-link.d.cts} +2 -2
- package/dist/artifact-link.d.mts +8 -0
- package/dist/{artifact-read.d.ts → artifact-read.d.cts} +2 -2
- package/dist/artifact-read.d.mts +13 -0
- package/dist/{artifact-register.d.ts → artifact-register.d.cts} +2 -2
- package/dist/artifact-register.d.mts +14 -0
- package/dist/{artifact-rpc.d.ts → artifact-rpc.d.cts} +1 -1
- package/dist/artifact-rpc.d.mts +2 -0
- package/dist/{artifacts.d.ts → artifacts.d.cts} +4 -4
- package/dist/artifacts.d.mts +53 -0
- package/dist/auth-fetch.d.mts +27 -0
- package/dist/bounded-rpc-fetch.d.mts +2 -0
- package/dist/{command-fetch.d.ts → command-fetch.d.cts} +1 -1
- package/dist/command-fetch.d.mts +6 -0
- package/dist/{commands.d.ts → commands.d.cts} +1 -1
- package/dist/commands.d.mts +44 -0
- package/dist/contracts.cjs +48 -0
- package/dist/contracts.d.mts +1 -0
- package/dist/index.cjs +3732 -0
- package/dist/{index.d.ts → index.d.cts} +20 -20
- package/dist/index.d.mts +360 -0
- package/dist/{oauth-clients.d.ts → oauth-clients.d.cts} +1 -1
- package/dist/oauth-clients.d.mts +95 -0
- package/dist/{oauth-server.d.ts → oauth-server.d.cts} +1 -1
- package/dist/oauth-server.d.mts +104 -0
- package/dist/{queue-rpc.d.ts → queue-rpc.d.cts} +1 -1
- package/dist/queue-rpc.d.mts +54 -0
- package/dist/reactive.cjs +119 -0
- package/dist/{reactive.d.ts → reactive.d.cts} +1 -1
- package/dist/reactive.d.mts +26 -0
- package/dist/{service-role-rpc.d.ts → service-role-rpc.d.cts} +1 -1
- package/dist/service-role-rpc.d.mts +2 -0
- package/dist/supabase-types.d.cts +9 -0
- package/dist/supabase-types.d.mts +9 -0
- package/dist/task-events.cjs +352 -0
- package/dist/task-events.d.mts +66 -0
- package/dist/{workflow-advance.d.ts → workflow-advance.d.cts} +2 -2
- package/dist/workflow-advance.d.mts +8 -0
- package/dist/{workflow-attempt.d.ts → workflow-attempt.d.cts} +1 -1
- package/dist/workflow-attempt.d.mts +4 -0
- package/dist/{workflow-cancel.d.ts → workflow-cancel.d.cts} +2 -2
- package/dist/workflow-cancel.d.mts +14 -0
- package/dist/{workflow-claim.d.ts → workflow-claim.d.cts} +2 -2
- package/dist/workflow-claim.d.mts +12 -0
- package/dist/{workflow-complete.d.ts → workflow-complete.d.cts} +2 -2
- package/dist/workflow-complete.d.mts +8 -0
- package/dist/{workflow-events.d.ts → workflow-events.d.cts} +2 -2
- package/dist/workflow-events.d.mts +14 -0
- package/dist/{workflow-fail.d.ts → workflow-fail.d.cts} +2 -2
- package/dist/workflow-fail.d.mts +8 -0
- package/dist/{workflow-fetch.d.ts → workflow-fetch.d.cts} +1 -1
- package/dist/workflow-fetch.d.mts +9 -0
- package/dist/workflow-json.d.mts +2 -0
- package/dist/{workflow-retry.d.ts → workflow-retry.d.cts} +2 -2
- package/dist/workflow-retry.d.mts +8 -0
- package/dist/{workflow-rpc.d.ts → workflow-rpc.d.cts} +1 -1
- package/dist/workflow-rpc.d.mts +6 -0
- package/dist/{workflow-run.d.ts → workflow-run.d.cts} +2 -2
- package/dist/workflow-run.d.mts +8 -0
- package/dist/{workflow-start.d.ts → workflow-start.d.cts} +2 -2
- package/dist/workflow-start.d.mts +8 -0
- package/dist/workflow-timestamp.d.mts +1 -0
- package/dist/{workflows.d.ts → workflows.d.cts} +10 -10
- package/dist/workflows.d.mts +141 -0
- package/package.json +48 -21
- /package/dist/{api-error.d.ts → api-error.d.cts} +0 -0
- /package/dist/{auth-fetch.d.ts → auth-fetch.d.cts} +0 -0
- /package/dist/{bounded-rpc-fetch.d.ts → bounded-rpc-fetch.d.cts} +0 -0
- /package/dist/{contracts.d.ts → contracts.d.cts} +0 -0
- /package/dist/{contracts.js → contracts.mjs} +0 -0
- /package/dist/{index.js → index.mjs} +0 -0
- /package/dist/{reactive.js → reactive.mjs} +0 -0
- /package/dist/{task-events.d.ts → task-events.d.cts} +0 -0
- /package/dist/{task-events.js → task-events.mjs} +0 -0
- /package/dist/{workflow-json.d.ts → workflow-json.d.cts} +0 -0
- /package/dist/{workflow-timestamp.d.ts → workflow-timestamp.d.cts} +0 -0
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import type { SupaCloudWorkflowAttemptRequest } from "./workflows.mjs";
|
|
2
|
+
export declare function workflowRequestFields(value: unknown, names: readonly string[]): Record<string, unknown>;
|
|
3
|
+
export declare function captureWorkflowAttempt(fields: Record<string, unknown>): SupaCloudWorkflowAttemptRequest;
|
|
4
|
+
export declare function captureWorkflowErrorMessage(value: unknown): string;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { SupaCloudApiError } from "./api-error.
|
|
2
|
-
import type { SupaCloudWorkflowRun } from "./workflows.
|
|
1
|
+
import { SupaCloudApiError } from "./api-error.cjs";
|
|
2
|
+
import type { SupaCloudWorkflowRun } from "./workflows.cjs";
|
|
3
3
|
export declare class SupaCloudWorkflowCancelError extends SupaCloudApiError {
|
|
4
4
|
readonly mutationMayHaveApplied: boolean;
|
|
5
5
|
constructor(mutationMayHaveApplied?: boolean);
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { SupaCloudApiError } from "./api-error.mjs";
|
|
2
|
+
import type { SupaCloudWorkflowRun } from "./workflows.mjs";
|
|
3
|
+
export declare class SupaCloudWorkflowCancelError extends SupaCloudApiError {
|
|
4
|
+
readonly mutationMayHaveApplied: boolean;
|
|
5
|
+
constructor(mutationMayHaveApplied?: boolean);
|
|
6
|
+
}
|
|
7
|
+
export declare function captureWorkflowCancel(runId: unknown, reason: unknown): {
|
|
8
|
+
runId: string;
|
|
9
|
+
reason: string;
|
|
10
|
+
};
|
|
11
|
+
export declare function decodeWorkflowCancel(value: unknown, request: {
|
|
12
|
+
runId: string;
|
|
13
|
+
reason: string;
|
|
14
|
+
}): SupaCloudWorkflowRun;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { SupaCloudApiError } from "./api-error.
|
|
2
|
-
import type { SupaCloudWorkflowClaimRequest, SupaCloudWorkflowClaimResult } from "./workflows.
|
|
1
|
+
import { SupaCloudApiError } from "./api-error.cjs";
|
|
2
|
+
import type { SupaCloudWorkflowClaimRequest, SupaCloudWorkflowClaimResult } from "./workflows.cjs";
|
|
3
3
|
export declare class SupaCloudWorkflowClaimInputError extends SupaCloudApiError {
|
|
4
4
|
readonly mutationMayHaveApplied = false;
|
|
5
5
|
constructor();
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { SupaCloudApiError } from "./api-error.mjs";
|
|
2
|
+
import type { SupaCloudWorkflowClaimRequest, SupaCloudWorkflowClaimResult } from "./workflows.mjs";
|
|
3
|
+
export declare class SupaCloudWorkflowClaimInputError extends SupaCloudApiError {
|
|
4
|
+
readonly mutationMayHaveApplied = false;
|
|
5
|
+
constructor();
|
|
6
|
+
}
|
|
7
|
+
export declare function captureWorkflowClaimRequest(value: unknown): Required<SupaCloudWorkflowClaimRequest>;
|
|
8
|
+
export declare class SupaCloudWorkflowClaimError extends SupaCloudApiError {
|
|
9
|
+
readonly mutationMayHaveApplied = true;
|
|
10
|
+
constructor();
|
|
11
|
+
}
|
|
12
|
+
export declare function decodeWorkflowClaim(value: unknown, expectedWorkerId: string): SupaCloudWorkflowClaimResult;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { SupaCloudApiError } from "./api-error.
|
|
2
|
-
import type { SupaCloudWorkflowCompleteRequest, SupaCloudWorkflowRun } from "./workflows.
|
|
1
|
+
import { SupaCloudApiError } from "./api-error.cjs";
|
|
2
|
+
import type { SupaCloudWorkflowCompleteRequest, SupaCloudWorkflowRun } from "./workflows.cjs";
|
|
3
3
|
export declare class SupaCloudWorkflowCompleteError extends SupaCloudApiError {
|
|
4
4
|
readonly mutationMayHaveApplied: boolean;
|
|
5
5
|
constructor(mutationMayHaveApplied?: boolean);
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { SupaCloudApiError } from "./api-error.mjs";
|
|
2
|
+
import type { SupaCloudWorkflowCompleteRequest, SupaCloudWorkflowRun } from "./workflows.mjs";
|
|
3
|
+
export declare class SupaCloudWorkflowCompleteError extends SupaCloudApiError {
|
|
4
|
+
readonly mutationMayHaveApplied: boolean;
|
|
5
|
+
constructor(mutationMayHaveApplied?: boolean);
|
|
6
|
+
}
|
|
7
|
+
export declare function captureWorkflowComplete(value: unknown): Required<SupaCloudWorkflowCompleteRequest>;
|
|
8
|
+
export declare function decodeWorkflowComplete(value: unknown, request: Required<SupaCloudWorkflowCompleteRequest>): SupaCloudWorkflowRun;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { SupaCloudApiError } from "./api-error.
|
|
2
|
-
import type { SupaCloudWorkflowEvent } from "./workflows.
|
|
1
|
+
import { SupaCloudApiError } from "./api-error.cjs";
|
|
2
|
+
import type { SupaCloudWorkflowEvent } from "./workflows.cjs";
|
|
3
3
|
export declare class SupaCloudWorkflowEventsError extends SupaCloudApiError {
|
|
4
4
|
readonly mutationMayHaveApplied = false;
|
|
5
5
|
constructor(input?: boolean);
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { SupaCloudApiError } from "./api-error.mjs";
|
|
2
|
+
import type { SupaCloudWorkflowEvent } from "./workflows.mjs";
|
|
3
|
+
export declare class SupaCloudWorkflowEventsError extends SupaCloudApiError {
|
|
4
|
+
readonly mutationMayHaveApplied = false;
|
|
5
|
+
constructor(input?: boolean);
|
|
6
|
+
}
|
|
7
|
+
type EventRequest = {
|
|
8
|
+
runId: string;
|
|
9
|
+
afterEventId: string;
|
|
10
|
+
limit: number;
|
|
11
|
+
};
|
|
12
|
+
export declare function captureWorkflowEvents(runId: unknown, options: unknown): EventRequest;
|
|
13
|
+
export declare function decodeWorkflowEvents(value: unknown, request: EventRequest): SupaCloudWorkflowEvent[];
|
|
14
|
+
export {};
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { SupaCloudApiError } from "./api-error.
|
|
2
|
-
import type { SupaCloudWorkflowFailRequest, SupaCloudWorkflowRun } from "./workflows.
|
|
1
|
+
import { SupaCloudApiError } from "./api-error.cjs";
|
|
2
|
+
import type { SupaCloudWorkflowFailRequest, SupaCloudWorkflowRun } from "./workflows.cjs";
|
|
3
3
|
export declare class SupaCloudWorkflowFailError extends SupaCloudApiError {
|
|
4
4
|
readonly mutationMayHaveApplied: boolean;
|
|
5
5
|
constructor(mutationMayHaveApplied?: boolean);
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { SupaCloudApiError } from "./api-error.mjs";
|
|
2
|
+
import type { SupaCloudWorkflowFailRequest, SupaCloudWorkflowRun } from "./workflows.mjs";
|
|
3
|
+
export declare class SupaCloudWorkflowFailError extends SupaCloudApiError {
|
|
4
|
+
readonly mutationMayHaveApplied: boolean;
|
|
5
|
+
constructor(mutationMayHaveApplied?: boolean);
|
|
6
|
+
}
|
|
7
|
+
export declare function captureWorkflowFail(value: unknown): SupaCloudWorkflowFailRequest;
|
|
8
|
+
export declare function decodeWorkflowFail(value: unknown, request: SupaCloudWorkflowFailRequest): SupaCloudWorkflowRun;
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { type FetchTransport } from "./bounded-rpc-fetch.mjs";
|
|
2
|
+
export interface SupaCloudWorkflowFetchOptions {
|
|
3
|
+
fetch?: FetchTransport;
|
|
4
|
+
}
|
|
5
|
+
/**
|
|
6
|
+
* Install in createClient's global.fetch before constructing the Supabase client.
|
|
7
|
+
* Only workflow RPCs are bounded; other Supabase requests pass through unchanged.
|
|
8
|
+
*/
|
|
9
|
+
export declare function createSupaCloudWorkflowFetch(options?: SupaCloudWorkflowFetchOptions): FetchTransport;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { SupaCloudApiError } from "./api-error.
|
|
2
|
-
import type { SupaCloudWorkflowRetryRequest, SupaCloudWorkflowRun } from "./workflows.
|
|
1
|
+
import { SupaCloudApiError } from "./api-error.cjs";
|
|
2
|
+
import type { SupaCloudWorkflowRetryRequest, SupaCloudWorkflowRun } from "./workflows.cjs";
|
|
3
3
|
export declare class SupaCloudWorkflowRetryError extends SupaCloudApiError {
|
|
4
4
|
readonly mutationMayHaveApplied: boolean;
|
|
5
5
|
constructor(mutationMayHaveApplied?: boolean);
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { SupaCloudApiError } from "./api-error.mjs";
|
|
2
|
+
import type { SupaCloudWorkflowRetryRequest, SupaCloudWorkflowRun } from "./workflows.mjs";
|
|
3
|
+
export declare class SupaCloudWorkflowRetryError extends SupaCloudApiError {
|
|
4
|
+
readonly mutationMayHaveApplied: boolean;
|
|
5
|
+
constructor(mutationMayHaveApplied?: boolean);
|
|
6
|
+
}
|
|
7
|
+
export declare function captureWorkflowRetry(value: unknown): Required<SupaCloudWorkflowRetryRequest>;
|
|
8
|
+
export declare function decodeWorkflowRetry(value: unknown, request: Required<SupaCloudWorkflowRetryRequest>): SupaCloudWorkflowRun;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { SupabaseClient } from "
|
|
1
|
+
import type { SupabaseClient } from "./supabase-types.cjs";
|
|
2
2
|
type WorkflowMutationName = "supacloud_workflow_start" | "supacloud_workflow_claim" | "supacloud_workflow_cancel" | "supacloud_workflow_complete" | "supacloud_workflow_fail" | "supacloud_workflow_advance" | "supacloud_workflow_retry";
|
|
3
3
|
type WorkflowReadName = "supacloud_workflow_get" | "supacloud_workflow_events";
|
|
4
4
|
export declare function invokeWorkflowMutation(supabase: SupabaseClient, functionName: WorkflowMutationName, request: object, unconfirmed: () => Error): Promise<unknown>;
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import type { SupabaseClient } from "./supabase-types.mjs";
|
|
2
|
+
type WorkflowMutationName = "supacloud_workflow_start" | "supacloud_workflow_claim" | "supacloud_workflow_cancel" | "supacloud_workflow_complete" | "supacloud_workflow_fail" | "supacloud_workflow_advance" | "supacloud_workflow_retry";
|
|
3
|
+
type WorkflowReadName = "supacloud_workflow_get" | "supacloud_workflow_events";
|
|
4
|
+
export declare function invokeWorkflowMutation(supabase: SupabaseClient, functionName: WorkflowMutationName, request: object, unconfirmed: () => Error): Promise<unknown>;
|
|
5
|
+
export declare function invokeWorkflowRead(supabase: SupabaseClient, functionName: WorkflowReadName, request: object, invalid: () => Error): Promise<unknown>;
|
|
6
|
+
export {};
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { SupaCloudApiError } from "./api-error.
|
|
2
|
-
import type { SupaCloudWorkflowRun } from "./workflows.
|
|
1
|
+
import { SupaCloudApiError } from "./api-error.cjs";
|
|
2
|
+
import type { SupaCloudWorkflowRun } from "./workflows.cjs";
|
|
3
3
|
export declare class SupaCloudWorkflowReadError extends SupaCloudApiError {
|
|
4
4
|
readonly mutationMayHaveApplied = false;
|
|
5
5
|
constructor(code?: string);
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { SupaCloudApiError } from "./api-error.mjs";
|
|
2
|
+
import type { SupaCloudWorkflowRun } from "./workflows.mjs";
|
|
3
|
+
export declare class SupaCloudWorkflowReadError extends SupaCloudApiError {
|
|
4
|
+
readonly mutationMayHaveApplied = false;
|
|
5
|
+
constructor(code?: string);
|
|
6
|
+
}
|
|
7
|
+
export declare function captureWorkflowRunId(value: unknown): string;
|
|
8
|
+
export declare function decodeWorkflowRun(value: unknown, expectedRunId: string, allowIdempotent?: boolean): SupaCloudWorkflowRun | null;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { SupaCloudApiError } from "./api-error.
|
|
2
|
-
import type { SupaCloudWorkflowRun, SupaCloudWorkflowStartRequest } from "./workflows.
|
|
1
|
+
import { SupaCloudApiError } from "./api-error.cjs";
|
|
2
|
+
import type { SupaCloudWorkflowRun, SupaCloudWorkflowStartRequest } from "./workflows.cjs";
|
|
3
3
|
export declare class SupaCloudWorkflowStartError extends SupaCloudApiError {
|
|
4
4
|
readonly mutationMayHaveApplied: boolean;
|
|
5
5
|
constructor(mutationMayHaveApplied?: boolean);
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { SupaCloudApiError } from "./api-error.mjs";
|
|
2
|
+
import type { SupaCloudWorkflowRun, SupaCloudWorkflowStartRequest } from "./workflows.mjs";
|
|
3
|
+
export declare class SupaCloudWorkflowStartError extends SupaCloudApiError {
|
|
4
|
+
readonly mutationMayHaveApplied: boolean;
|
|
5
|
+
constructor(mutationMayHaveApplied?: boolean);
|
|
6
|
+
}
|
|
7
|
+
export declare function captureWorkflowStart(value: unknown): Required<SupaCloudWorkflowStartRequest>;
|
|
8
|
+
export declare function decodeWorkflowStart(value: unknown, request: Required<SupaCloudWorkflowStartRequest>): SupaCloudWorkflowRun;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare function isWorkflowTimestamp(value: unknown): value is string;
|
|
@@ -1,13 +1,13 @@
|
|
|
1
|
-
import type { SupabaseClient } from "
|
|
2
|
-
export { SupaCloudWorkflowClaimError, SupaCloudWorkflowClaimInputError } from "./workflow-claim.
|
|
3
|
-
export { SupaCloudWorkflowReadError } from "./workflow-run.
|
|
4
|
-
export { SupaCloudWorkflowStartError } from "./workflow-start.
|
|
5
|
-
export { SupaCloudWorkflowCancelError } from "./workflow-cancel.
|
|
6
|
-
export { SupaCloudWorkflowCompleteError } from "./workflow-complete.
|
|
7
|
-
export { SupaCloudWorkflowFailError } from "./workflow-fail.
|
|
8
|
-
export { SupaCloudWorkflowAdvanceError } from "./workflow-advance.
|
|
9
|
-
export { SupaCloudWorkflowRetryError } from "./workflow-retry.
|
|
10
|
-
export { SupaCloudWorkflowEventsError } from "./workflow-events.
|
|
1
|
+
import type { SupabaseClient } from "./supabase-types.cjs";
|
|
2
|
+
export { SupaCloudWorkflowClaimError, SupaCloudWorkflowClaimInputError } from "./workflow-claim.cjs";
|
|
3
|
+
export { SupaCloudWorkflowReadError } from "./workflow-run.cjs";
|
|
4
|
+
export { SupaCloudWorkflowStartError } from "./workflow-start.cjs";
|
|
5
|
+
export { SupaCloudWorkflowCancelError } from "./workflow-cancel.cjs";
|
|
6
|
+
export { SupaCloudWorkflowCompleteError } from "./workflow-complete.cjs";
|
|
7
|
+
export { SupaCloudWorkflowFailError } from "./workflow-fail.cjs";
|
|
8
|
+
export { SupaCloudWorkflowAdvanceError } from "./workflow-advance.cjs";
|
|
9
|
+
export { SupaCloudWorkflowRetryError } from "./workflow-retry.cjs";
|
|
10
|
+
export { SupaCloudWorkflowEventsError } from "./workflow-events.cjs";
|
|
11
11
|
export type SupaCloudWorkflowRunStatus = "queued" | "running" | "completed" | "failed" | "cancelled";
|
|
12
12
|
export type SupaCloudWorkflowStepStatus = "queued" | "running" | "completed" | "failed" | "dead_lettered" | "cancelled";
|
|
13
13
|
export type SupaCloudWorkflowJson = Record<string, unknown>;
|
|
@@ -0,0 +1,141 @@
|
|
|
1
|
+
import type { SupabaseClient } from "./supabase-types.mjs";
|
|
2
|
+
export { SupaCloudWorkflowClaimError, SupaCloudWorkflowClaimInputError } from "./workflow-claim.mjs";
|
|
3
|
+
export { SupaCloudWorkflowReadError } from "./workflow-run.mjs";
|
|
4
|
+
export { SupaCloudWorkflowStartError } from "./workflow-start.mjs";
|
|
5
|
+
export { SupaCloudWorkflowCancelError } from "./workflow-cancel.mjs";
|
|
6
|
+
export { SupaCloudWorkflowCompleteError } from "./workflow-complete.mjs";
|
|
7
|
+
export { SupaCloudWorkflowFailError } from "./workflow-fail.mjs";
|
|
8
|
+
export { SupaCloudWorkflowAdvanceError } from "./workflow-advance.mjs";
|
|
9
|
+
export { SupaCloudWorkflowRetryError } from "./workflow-retry.mjs";
|
|
10
|
+
export { SupaCloudWorkflowEventsError } from "./workflow-events.mjs";
|
|
11
|
+
export type SupaCloudWorkflowRunStatus = "queued" | "running" | "completed" | "failed" | "cancelled";
|
|
12
|
+
export type SupaCloudWorkflowStepStatus = "queued" | "running" | "completed" | "failed" | "dead_lettered" | "cancelled";
|
|
13
|
+
export type SupaCloudWorkflowJson = Record<string, unknown>;
|
|
14
|
+
export interface SupaCloudWorkflowStep {
|
|
15
|
+
stepId: string;
|
|
16
|
+
stepKey: string;
|
|
17
|
+
status: SupaCloudWorkflowStepStatus;
|
|
18
|
+
input: SupaCloudWorkflowJson;
|
|
19
|
+
output: SupaCloudWorkflowJson;
|
|
20
|
+
errorMessage: string;
|
|
21
|
+
attempts: number;
|
|
22
|
+
maxAttempts: number;
|
|
23
|
+
retryDelaySeconds: number;
|
|
24
|
+
queueMessageId: string;
|
|
25
|
+
claimedBy: string | null;
|
|
26
|
+
claimedAt: string | null;
|
|
27
|
+
completedAt: string | null;
|
|
28
|
+
nextStepKey: string | null;
|
|
29
|
+
createdAt: string;
|
|
30
|
+
updatedAt: string;
|
|
31
|
+
}
|
|
32
|
+
export interface SupaCloudWorkflowRun {
|
|
33
|
+
runId: string;
|
|
34
|
+
workflowName: string;
|
|
35
|
+
workflowVersion: string;
|
|
36
|
+
status: SupaCloudWorkflowRunStatus;
|
|
37
|
+
input: SupaCloudWorkflowJson;
|
|
38
|
+
output: SupaCloudWorkflowJson;
|
|
39
|
+
errorMessage: string;
|
|
40
|
+
rowVersion: string;
|
|
41
|
+
createdAt: string;
|
|
42
|
+
startedAt: string | null;
|
|
43
|
+
completedAt: string | null;
|
|
44
|
+
updatedAt: string;
|
|
45
|
+
idempotent: boolean;
|
|
46
|
+
steps: SupaCloudWorkflowStep[];
|
|
47
|
+
}
|
|
48
|
+
export interface SupaCloudWorkflowStartRequest {
|
|
49
|
+
runId: string;
|
|
50
|
+
workflowName: string;
|
|
51
|
+
workflowVersion: string;
|
|
52
|
+
firstStepKey: string;
|
|
53
|
+
input?: SupaCloudWorkflowJson;
|
|
54
|
+
maxAttempts?: number;
|
|
55
|
+
}
|
|
56
|
+
export interface SupaCloudWorkflowClaimRequest {
|
|
57
|
+
workerId: string;
|
|
58
|
+
visibilityTimeoutSeconds?: number;
|
|
59
|
+
}
|
|
60
|
+
export interface SupaCloudWorkflowClaim {
|
|
61
|
+
status: "claimed";
|
|
62
|
+
runId: string;
|
|
63
|
+
workflowName: string;
|
|
64
|
+
workflowVersion: string;
|
|
65
|
+
stepId: string;
|
|
66
|
+
stepKey: string;
|
|
67
|
+
input: SupaCloudWorkflowJson;
|
|
68
|
+
messageId: string;
|
|
69
|
+
attempt: number;
|
|
70
|
+
maxAttempts: number;
|
|
71
|
+
workerId: string;
|
|
72
|
+
}
|
|
73
|
+
export interface SupaCloudWorkflowDeadLetter {
|
|
74
|
+
status: "dead_lettered";
|
|
75
|
+
runId: string;
|
|
76
|
+
stepId: string;
|
|
77
|
+
stepKey: string;
|
|
78
|
+
messageId: string;
|
|
79
|
+
attempt: number;
|
|
80
|
+
maxAttempts: number;
|
|
81
|
+
}
|
|
82
|
+
export interface SupaCloudWorkflowDiscardedMessage {
|
|
83
|
+
status: "discarded";
|
|
84
|
+
reason: "invalid_message" | "orphaned_message" | "step_not_claimable" | string;
|
|
85
|
+
messageId: string;
|
|
86
|
+
runId?: string;
|
|
87
|
+
stepId?: string;
|
|
88
|
+
}
|
|
89
|
+
export type SupaCloudWorkflowClaimResult = SupaCloudWorkflowClaim | SupaCloudWorkflowDeadLetter | SupaCloudWorkflowDiscardedMessage | null;
|
|
90
|
+
export interface SupaCloudWorkflowAttemptRequest {
|
|
91
|
+
stepId: string;
|
|
92
|
+
messageId: string;
|
|
93
|
+
attempt: number;
|
|
94
|
+
workerId: string;
|
|
95
|
+
}
|
|
96
|
+
export interface SupaCloudWorkflowAdvanceRequest extends SupaCloudWorkflowAttemptRequest {
|
|
97
|
+
output?: SupaCloudWorkflowJson;
|
|
98
|
+
nextStepKey: string;
|
|
99
|
+
nextInput?: SupaCloudWorkflowJson;
|
|
100
|
+
nextMaxAttempts?: number;
|
|
101
|
+
}
|
|
102
|
+
export interface SupaCloudWorkflowCompleteRequest extends SupaCloudWorkflowAttemptRequest {
|
|
103
|
+
stepOutput?: SupaCloudWorkflowJson;
|
|
104
|
+
runOutput?: SupaCloudWorkflowJson;
|
|
105
|
+
}
|
|
106
|
+
export interface SupaCloudWorkflowRetryRequest extends SupaCloudWorkflowAttemptRequest {
|
|
107
|
+
errorMessage: string;
|
|
108
|
+
delaySeconds?: number;
|
|
109
|
+
}
|
|
110
|
+
export interface SupaCloudWorkflowFailRequest extends SupaCloudWorkflowAttemptRequest {
|
|
111
|
+
errorMessage: string;
|
|
112
|
+
}
|
|
113
|
+
export interface SupaCloudWorkflowEvent {
|
|
114
|
+
eventId: string;
|
|
115
|
+
runId: string;
|
|
116
|
+
stepId: string | null;
|
|
117
|
+
eventType: string;
|
|
118
|
+
attempt: number | null;
|
|
119
|
+
details: SupaCloudWorkflowJson;
|
|
120
|
+
createdAt: string;
|
|
121
|
+
}
|
|
122
|
+
/**
|
|
123
|
+
* Service-role-only durable workflow RPC client. Constructed by
|
|
124
|
+
* `createSupaCloudClient`; never expose a service-role key in browser code.
|
|
125
|
+
*/
|
|
126
|
+
export declare class SupaCloudWorkflowsClient<TClient extends SupabaseClient = SupabaseClient> {
|
|
127
|
+
private readonly supabase;
|
|
128
|
+
constructor(supabase: TClient);
|
|
129
|
+
start(request: SupaCloudWorkflowStartRequest): Promise<SupaCloudWorkflowRun>;
|
|
130
|
+
claim(request: SupaCloudWorkflowClaimRequest): Promise<SupaCloudWorkflowClaimResult>;
|
|
131
|
+
advance(request: SupaCloudWorkflowAdvanceRequest): Promise<SupaCloudWorkflowRun>;
|
|
132
|
+
complete(request: SupaCloudWorkflowCompleteRequest): Promise<SupaCloudWorkflowRun>;
|
|
133
|
+
retry(request: SupaCloudWorkflowRetryRequest): Promise<SupaCloudWorkflowRun>;
|
|
134
|
+
fail(request: SupaCloudWorkflowFailRequest): Promise<SupaCloudWorkflowRun>;
|
|
135
|
+
cancel(runId: string, reason: string): Promise<SupaCloudWorkflowRun>;
|
|
136
|
+
get(runId: string): Promise<SupaCloudWorkflowRun | null>;
|
|
137
|
+
events(runId: string, options?: {
|
|
138
|
+
afterEventId?: string;
|
|
139
|
+
limit?: number;
|
|
140
|
+
}): Promise<SupaCloudWorkflowEvent[]>;
|
|
141
|
+
}
|
package/package.json
CHANGED
|
@@ -1,31 +1,51 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@supacloud/js",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.36.1",
|
|
4
4
|
"description": "Platform SDK for SupaCloud, built on top of supabase-js",
|
|
5
5
|
"type": "module",
|
|
6
|
-
"main": "./dist/index.
|
|
7
|
-
"module": "./dist/index.
|
|
8
|
-
"types": "./dist/index.d.
|
|
6
|
+
"main": "./dist/index.cjs",
|
|
7
|
+
"module": "./dist/index.mjs",
|
|
8
|
+
"types": "./dist/index.d.mts",
|
|
9
9
|
"exports": {
|
|
10
10
|
".": {
|
|
11
|
-
"
|
|
12
|
-
|
|
13
|
-
|
|
11
|
+
"import": {
|
|
12
|
+
"types": "./dist/index.d.mts",
|
|
13
|
+
"default": "./dist/index.mjs"
|
|
14
|
+
},
|
|
15
|
+
"require": {
|
|
16
|
+
"types": "./dist/index.d.cts",
|
|
17
|
+
"default": "./dist/index.cjs"
|
|
18
|
+
}
|
|
14
19
|
},
|
|
15
20
|
"./task-events": {
|
|
16
|
-
"
|
|
17
|
-
|
|
18
|
-
|
|
21
|
+
"import": {
|
|
22
|
+
"types": "./dist/task-events.d.mts",
|
|
23
|
+
"default": "./dist/task-events.mjs"
|
|
24
|
+
},
|
|
25
|
+
"require": {
|
|
26
|
+
"types": "./dist/task-events.d.cts",
|
|
27
|
+
"default": "./dist/task-events.cjs"
|
|
28
|
+
}
|
|
19
29
|
},
|
|
20
30
|
"./contracts": {
|
|
21
|
-
"
|
|
22
|
-
|
|
23
|
-
|
|
31
|
+
"import": {
|
|
32
|
+
"types": "./dist/contracts.d.mts",
|
|
33
|
+
"default": "./dist/contracts.mjs"
|
|
34
|
+
},
|
|
35
|
+
"require": {
|
|
36
|
+
"types": "./dist/contracts.d.cts",
|
|
37
|
+
"default": "./dist/contracts.cjs"
|
|
38
|
+
}
|
|
24
39
|
},
|
|
25
40
|
"./reactive": {
|
|
26
|
-
"
|
|
27
|
-
|
|
28
|
-
|
|
41
|
+
"import": {
|
|
42
|
+
"types": "./dist/reactive.d.mts",
|
|
43
|
+
"default": "./dist/reactive.mjs"
|
|
44
|
+
},
|
|
45
|
+
"require": {
|
|
46
|
+
"types": "./dist/reactive.d.cts",
|
|
47
|
+
"default": "./dist/reactive.cjs"
|
|
48
|
+
}
|
|
29
49
|
}
|
|
30
50
|
},
|
|
31
51
|
"files": [
|
|
@@ -33,18 +53,22 @@
|
|
|
33
53
|
"LICENSE-APACHE-2.0.txt",
|
|
34
54
|
"dist",
|
|
35
55
|
"README.md",
|
|
56
|
+
"COMPATIBILITY.md",
|
|
36
57
|
"REACTIVE.md"
|
|
37
58
|
],
|
|
38
59
|
"scripts": {
|
|
39
60
|
"test": "bun test",
|
|
40
61
|
"build": "bun run clean && bun run build:js && bun run build:types",
|
|
41
|
-
"build:js": "bun build
|
|
42
|
-
"build:types": "tsc -p tsconfig.json --emitDeclarationOnly",
|
|
62
|
+
"build:js": "bun run build:js:esm && bun run build:js:cjs",
|
|
63
|
+
"build:types": "tsc -p tsconfig.json --emitDeclarationOnly && node ../../scripts/copy-dual-declarations.mjs dist",
|
|
43
64
|
"clean": "rm -rf dist",
|
|
44
|
-
"prepublishOnly": "bun run build",
|
|
65
|
+
"prepublishOnly": "bun run build && bun run check:package",
|
|
45
66
|
"typecheck:consumer": "tsc -p tsconfig.consumer.json --noEmit",
|
|
46
67
|
"typecheck": "tsc -p tsconfig.json --noEmit",
|
|
47
|
-
"typecheck:test": "tsc -p tsconfig.test.json --noEmit"
|
|
68
|
+
"typecheck:test": "tsc -p tsconfig.test.json --noEmit",
|
|
69
|
+
"check:package": "node ../../.github/scripts/esm-package-policy.mjs --pack .",
|
|
70
|
+
"build:js:esm": "bun build src/index.ts src/task-events.ts --outdir dist --format esm --entry-naming \"[name].mjs\" --chunk-naming \"[name]-[hash].mjs\" --target node --external @supabase/supabase-js --external @supacloud/contracts && bun build src/contracts.ts --outdir dist --format esm --entry-naming \"[name].mjs\" --chunk-naming \"[name]-[hash].mjs\" --target browser --external @supacloud/contracts && bun build src/reactive.ts --outdir dist --format esm --entry-naming \"[name].mjs\" --chunk-naming \"[name]-[hash].mjs\" --target browser --external rxjs",
|
|
71
|
+
"build:js:cjs": "bun build src/index.ts src/task-events.ts --outdir dist --format cjs --entry-naming \"[name].cjs\" --chunk-naming \"[name]-[hash].cjs\" --target node --external @supabase/supabase-js --external @supacloud/contracts && bun build src/contracts.ts --outdir dist --format cjs --entry-naming \"[name].cjs\" --chunk-naming \"[name]-[hash].cjs\" --target browser --external @supacloud/contracts && bun build src/reactive.ts --outdir dist --format cjs --entry-naming \"[name].cjs\" --chunk-naming \"[name]-[hash].cjs\" --target browser --external rxjs"
|
|
48
72
|
},
|
|
49
73
|
"keywords": [
|
|
50
74
|
"supacloud",
|
|
@@ -63,12 +87,15 @@
|
|
|
63
87
|
"@supabase/supabase-js": "^2.115.0"
|
|
64
88
|
},
|
|
65
89
|
"dependencies": {
|
|
66
|
-
"@supacloud/contracts": "0.
|
|
90
|
+
"@supacloud/contracts": "0.8.0",
|
|
67
91
|
"rxjs": "7.8.2"
|
|
68
92
|
},
|
|
69
93
|
"devDependencies": {
|
|
70
94
|
"@types/bun": "^1.4.2",
|
|
71
95
|
"@supabase/supabase-js": "^2.115.0",
|
|
72
96
|
"typescript": "^7.0.2"
|
|
97
|
+
},
|
|
98
|
+
"engines": {
|
|
99
|
+
"node": ">=22.12.0"
|
|
73
100
|
}
|
|
74
101
|
}
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|