cloudcruise 0.0.2 → 0.0.3

package/dist/index.d.ts

@@ -11,6 +11,7 @@ export { WebhookClient } from './webhook/WebhookClient.js';
 export type { VaultEntry, GetVaultEntriesFilters, ProxyConfig, VaultPostPutHeadersInBody } from './vault/types.js';
 export type { Workflow, WorkflowInputSchema, WorkflowMetadata } from './workflows/types.js';
 export type { EventType, DryRun, Metadata, RunSpecificWebhook, PayloadWebhook, StartRunRequest, StartRunResponse, UserInteractionData, VideoUrl, SignedFileUrl, SignedScreenshotUrl, RunError, WorkflowError, RunResult, GetRunResult, WebhookEvent, WebhookReplayResponse, RunHandle, RunStreamOptions, SseEventName, SseMessage, RunEventEnvelope } from './runs/types.js';
+export { WebhookEventType } from './webhook/types.js';
 export type { WebhookPayload, WebhookVerificationOptions } from './webhook/types.js';
 export { VerificationError } from './webhook/types.js';
 export { InputValidationError } from './workflows/types.js';

package/dist/index.js

@@ -7,5 +7,6 @@ export { VaultClient } from './vault/VaultClient.js';
 export { WorkflowsClient } from './workflows/WorkflowsClient.js';
 export { RunsClient } from './runs/RunsClient.js';
 export { WebhookClient } from './webhook/WebhookClient.js';
+export { WebhookEventType } from './webhook/types.js';
 export { VerificationError } from './webhook/types.js';
 export { InputValidationError } from './workflows/types.js';

package/dist/webhook/WebhookClient.d.ts

@@ -1,5 +1,14 @@
-import type { WebhookPayload, WebhookVerificationOptions } from './types.js';
+import type { WebhookEventType, WebhookPayload, WebhookVerificationOptions } from './types.js';
 export declare class WebhookClient {
     constructor();
-    verifySignature(receivedData: any, receivedSignature: string, secretKey: string, options?: WebhookVerificationOptions): WebhookPayload;
+    /**
+     * Verifies the signature of an incoming webhook payload.
+     *
+     * @param receivedData - Raw request body supplied by the webhook sender.
+     * @param receivedSignature - Value from the `x-hmac-signature` request header. e.g req.headers["x-hmac-signature"]
+     * @param secretKey - Webhook secret configured in the CloudCruise portal.
+     * @param options - Optional overrides controlling signature verification behavior.
+     * @returns Verified webhook payload when the signature matches.
+     */
+    verifySignature<E extends WebhookEventType = WebhookEventType>(receivedData: any, receivedSignature: string, secretKey: string, options?: WebhookVerificationOptions): WebhookPayload<E>;
 }

package/dist/webhook/WebhookClient.js

@@ -3,11 +3,15 @@ export class WebhookClient {
     constructor() {
         // No makeRequest needed for webhook verification
     }
-    /*
-    1. receivedSignature will be in the request header: "x-hmac-signature"
-    2. receivedData will be the request body.
-    3. secretKey is the key you set when creating this webhook in the CloudCruise portal.
-    */
+    /**
+     * Verifies the signature of an incoming webhook payload.
+     *
+     * @param receivedData - Raw request body supplied by the webhook sender.
+     * @param receivedSignature - Value from the `x-hmac-signature` request header. e.g req.headers["x-hmac-signature"]
+     * @param secretKey - Webhook secret configured in the CloudCruise portal.
+     * @param options - Optional overrides controlling signature verification behavior.
+     * @returns Verified webhook payload when the signature matches.
+     */
     verifySignature(receivedData, receivedSignature, secretKey, options) {
         return verifyMessage(receivedData, receivedSignature, secretKey, options);
     }

package/dist/webhook/types.d.ts

@@ -1,13 +1,115 @@
-import { EventType } from "../runs/types";
 export declare class VerificationError extends Error {
     readonly statusCode: number;
     constructor(message?: string, statusCode?: number);
 }
-export interface WebhookPayload {
-    event: EventType;
-    expires_at: number;
-    [key: string]: any;
-}
 export interface WebhookVerificationOptions {
     allowExpired?: boolean;
 }
+export declare enum WebhookEventType {
+    ExecutionQueued = "execution.queued",
+    ExecutionStart = "execution.start",
+    ExecutionStep = "execution.step",
+    InteractionWaiting = "interaction.waiting",
+    InteractionFinished = "interaction.finished",
+    AgentErrorAnalysis = "agent.error_analysis",
+    ExecutionRequeued = "execution.requeued",
+    ExecutionSuccess = "execution.success",
+    ExecutionFailed = "execution.failed",
+    ExecutionStopped = "execution.stopped"
+}
+export interface ExecutionQueuedPayload {
+    session_id: string;
+    workflow_id: string;
+}
+export interface ExecutionStartPayload {
+    session_id: string;
+    workflow_id: string;
+    live_view_url?: string;
+}
+export interface ExecutionStepPayload {
+    session_id: string;
+    workflow_id: string;
+    current_step: string;
+    next_step: string;
+}
+export interface InteractionWaitingPayload {
+    session_id: string;
+    workflow_id: string;
+    current_step: string;
+    missing_properties: string[];
+    expected_json_schema_datamodel: Record<string, any>;
+    message: string;
+}
+export type InteractionFinishedPayload = {
+    session_id: string;
+    workflow_id: string;
+    current_step: string;
+    missing_properties: [];
+    expected_json_schema_datamodel: Record<string, any>;
+    message: string;
+} | {
+    session_id: string;
+    workflow_id: string;
+    provided_input: any;
+    message?: string;
+    expected_json_schema_datamodel: Record<string, any>;
+};
+export interface AgentErrorAnalysisPayload {
+    analysis_step_name: string;
+    ai_analysis?: string;
+    root_cause_analysis?: string;
+    error_category?: string;
+}
+export interface ExecutionRequeuedPayload {
+    session_id: string;
+    workflow_id: string;
+    retry_attempt: number;
+    max_retries?: number;
+    next_execution_time: string;
+    delay_ms: number;
+}
+export interface EndRunError {
+    message: string;
+    error_id: string;
+    full_url?: string;
+    created_at: string;
+    error_code?: string;
+    action_type?: string;
+    action_display_name?: string;
+    llm_error_category?: string;
+}
+export interface EndRunPayload {
+    session_id: string;
+    workflow_id: string;
+    data: any;
+    input_variables: Record<string, any>;
+    errors: EndRunError[];
+    status: "execution.success" | "execution.failed" | "execution.stopped";
+    encrypted_variables: string[] | null;
+    file_urls: any[] | null;
+}
+export interface ExecutionStoppedEarlyPayload {
+    message: string;
+    error_code: string;
+    session_id: string;
+}
+export interface WebhookEnvelope<E extends WebhookEventType, P> {
+    event: E;
+    timestamp: number;
+    expires_at: number;
+    payload: P;
+    metadata?: Record<string, any>;
+}
+export type WebhookPayloadMap = {
+    [WebhookEventType.ExecutionQueued]: ExecutionQueuedPayload;
+    [WebhookEventType.ExecutionStart]: ExecutionStartPayload;
+    [WebhookEventType.ExecutionStep]: ExecutionStepPayload;
+    [WebhookEventType.InteractionWaiting]: InteractionWaitingPayload;
+    [WebhookEventType.InteractionFinished]: InteractionFinishedPayload;
+    [WebhookEventType.AgentErrorAnalysis]: AgentErrorAnalysisPayload;
+    [WebhookEventType.ExecutionRequeued]: ExecutionRequeuedPayload;
+    [WebhookEventType.ExecutionSuccess]: EndRunPayload;
+    [WebhookEventType.ExecutionFailed]: EndRunPayload;
+    [WebhookEventType.ExecutionStopped]: EndRunPayload | ExecutionStoppedEarlyPayload;
+};
+export type WebhookPayload<E extends WebhookEventType = WebhookEventType> = E extends WebhookEventType ? WebhookEnvelope<E, WebhookPayloadMap[E]> : never;

package/dist/webhook/types.js

@@ -6,3 +6,16 @@ export class VerificationError extends Error {
         this.name = "VerificationError";
     }
 }
+export var WebhookEventType;
+(function (WebhookEventType) {
+    WebhookEventType["ExecutionQueued"] = "execution.queued";
+    WebhookEventType["ExecutionStart"] = "execution.start";
+    WebhookEventType["ExecutionStep"] = "execution.step";
+    WebhookEventType["InteractionWaiting"] = "interaction.waiting";
+    WebhookEventType["InteractionFinished"] = "interaction.finished";
+    WebhookEventType["AgentErrorAnalysis"] = "agent.error_analysis";
+    WebhookEventType["ExecutionRequeued"] = "execution.requeued";
+    WebhookEventType["ExecutionSuccess"] = "execution.success";
+    WebhookEventType["ExecutionFailed"] = "execution.failed";
+    WebhookEventType["ExecutionStopped"] = "execution.stopped";
+})(WebhookEventType || (WebhookEventType = {}));

package/dist/webhook/utils.d.ts

@@ -1,2 +1,2 @@
-import { type WebhookPayload, type WebhookVerificationOptions } from './types.js';
-export declare function verifyMessage(receivedData: any, receivedSignature: string, secretKey: string, options?: WebhookVerificationOptions): WebhookPayload;
+import { WebhookEventType, type WebhookPayload, type WebhookVerificationOptions } from './types.js';
+export declare function verifyMessage<E extends WebhookEventType = WebhookEventType>(receivedData: any, receivedSignature: string, secretKey: string, options?: WebhookVerificationOptions): WebhookPayload<E>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cloudcruise",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "The official CloudCruise JS/TS client.",
   "homepage": "https://github.com/CloudCruise/cloudcruise-js#readme",
   "bugs": {