windmill-components 1.623.2 → 1.655.0

package/package/utils_deployable.d.ts

@@ -13,20 +13,124 @@ export declare function existsTrigger(data: {
     workspace: string;
     path: string;
 }, triggerKind: TriggerKind): Promise<boolean>;
-export declare function getTriggersDeployData(kind: TriggerKind, path: string, workspace: string): Promise<{
-    data: import("./gen").SqsTrigger;
+/**
+ * Get trigger deployment data with optional email preservation.
+ * @param onBehalfOfEmail - If set, the trigger will be deployed with this email and preserve_email=true.
+ */
+export declare function getTriggersDeployData(kind: TriggerKind, path: string, workspace: string, onBehalfOfEmail?: string): Promise<{
+    data: {
+        email: string | undefined;
+        preserve_email: boolean;
+        path: string;
+        script_path: string;
+        extra_perms: {
+            [key: string]: (boolean);
+        };
+        workspace_id: string;
+        edited_by: string;
+        edited_at: string;
+        is_flow: boolean;
+        mode: import("./gen").TriggerMode;
+        queue_url: string;
+        aws_auth_resource_type: import("./gen").AwsAuthResourceType;
+        aws_resource_path: string;
+        message_attributes?: Array<(string)> | null;
+        server_id?: string;
+        last_server_ping?: string;
+        error?: string;
+        error_handler_path?: string;
+        error_handler_args?: import("./gen").ScriptArgs;
+        retry?: import("./gen").Retry;
+    };
     createFn: typeof SqsTriggerService.createSqsTrigger;
     updateFn: typeof SqsTriggerService.updateSqsTrigger;
 } | {
-    data: import("./gen").KafkaTrigger;
+    data: {
+        email: string | undefined;
+        preserve_email: boolean;
+        path: string;
+        script_path: string;
+        extra_perms: {
+            [key: string]: (boolean);
+        };
+        workspace_id: string;
+        edited_by: string;
+        edited_at: string;
+        is_flow: boolean;
+        mode: import("./gen").TriggerMode;
+        kafka_resource_path: string;
+        group_id: string;
+        topics: Array<(string)>;
+        filters: Array<{
+            key: string;
+            value: unknown;
+        }>;
+        auto_offset_reset?: "latest" | "earliest";
+        auto_commit?: boolean;
+        server_id?: string;
+        last_server_ping?: string;
+        error?: string;
+        error_handler_path?: string;
+        error_handler_args?: import("./gen").ScriptArgs;
+        retry?: import("./gen").Retry;
+    };
     createFn: typeof KafkaTriggerService.createKafkaTrigger;
     updateFn: typeof KafkaTriggerService.updateKafkaTrigger;
 } | {
-    data: import("./gen").MqttTrigger;
+    data: {
+        email: string | undefined;
+        preserve_email: boolean;
+        path: string;
+        script_path: string;
+        extra_perms: {
+            [key: string]: (boolean);
+        };
+        workspace_id: string;
+        edited_by: string;
+        edited_at: string;
+        is_flow: boolean;
+        mode: import("./gen").TriggerMode;
+        mqtt_resource_path: string;
+        subscribe_topics: Array<import("./gen").MqttSubscribeTopic>;
+        v3_config?: import("./gen").MqttV3Config | null;
+        v5_config?: import("./gen").MqttV5Config | null;
+        client_id?: string | null;
+        client_version?: import("./gen").MqttClientVersion | null;
+        server_id?: string;
+        last_server_ping?: string;
+        error?: string;
+        error_handler_path?: string;
+        error_handler_args?: import("./gen").ScriptArgs;
+        retry?: import("./gen").Retry;
+    };
     createFn: typeof MqttTriggerService.createMqttTrigger;
     updateFn: typeof MqttTriggerService.updateMqttTrigger;
 } | {
-    data: import("./gen").NatsTrigger;
+    data: {
+        email: string | undefined;
+        preserve_email: boolean;
+        path: string;
+        script_path: string;
+        extra_perms: {
+            [key: string]: (boolean);
+        };
+        workspace_id: string;
+        edited_by: string;
+        edited_at: string;
+        is_flow: boolean;
+        mode: import("./gen").TriggerMode;
+        nats_resource_path: string;
+        use_jetstream: boolean;
+        stream_name?: string | null;
+        consumer_name?: string | null;
+        subjects: Array<(string)>;
+        server_id?: string;
+        last_server_ping?: string;
+        error?: string;
+        error_handler_path?: string;
+        error_handler_args?: import("./gen").ScriptArgs;
+        retry?: import("./gen").Retry;
+    };
     createFn: typeof NatsTriggerService.createNatsTrigger;
     updateFn: typeof NatsTriggerService.updateNatsTrigger;
 } | {
@@ -34,19 +138,135 @@ export declare function getTriggersDeployData(kind: TriggerKind, path: string, w
     createFn: typeof GcpTriggerService.createGcpTrigger;
     updateFn: typeof GcpTriggerService.updateGcpTrigger;
 } | {
-    data: import("./gen").PostgresTrigger;
+    data: {
+        email: string | undefined;
+        preserve_email: boolean;
+        path: string;
+        script_path: string;
+        extra_perms: {
+            [key: string]: (boolean);
+        };
+        workspace_id: string;
+        edited_by: string;
+        edited_at: string;
+        is_flow: boolean;
+        mode: import("./gen").TriggerMode;
+        postgres_resource_path: string;
+        publication_name: string;
+        server_id?: string;
+        replication_slot_name: string;
+        error?: string;
+        last_server_ping?: string;
+        error_handler_path?: string;
+        error_handler_args?: import("./gen").ScriptArgs;
+        retry?: import("./gen").Retry;
+    };
     createFn: typeof PostgresTriggerService.createPostgresTrigger;
     updateFn: typeof PostgresTriggerService.updatePostgresTrigger;
 } | {
-    data: import("./gen").WebsocketTrigger;
+    data: {
+        email: string | undefined;
+        preserve_email: boolean;
+        path: string;
+        script_path: string;
+        extra_perms: {
+            [key: string]: (boolean);
+        };
+        workspace_id: string;
+        edited_by: string;
+        edited_at: string;
+        is_flow: boolean;
+        mode: import("./gen").TriggerMode;
+        url: string;
+        server_id?: string;
+        last_server_ping?: string;
+        error?: string;
+        filters: Array<{
+            key: string;
+            value: unknown;
+        }>;
+        initial_messages?: Array<import("./gen").WebsocketTriggerInitialMessage> | null;
+        url_runnable_args?: import("./gen").ScriptArgs | null;
+        can_return_message: boolean;
+        can_return_error_result: boolean;
+        error_handler_path?: string;
+        error_handler_args?: import("./gen").ScriptArgs;
+        retry?: import("./gen").Retry;
+    };
     createFn: typeof WebsocketTriggerService.createWebsocketTrigger;
     updateFn: typeof WebsocketTriggerService.updateWebsocketTrigger;
 } | {
-    data: import("./gen").HttpTrigger;
+    data: {
+        email: string | undefined;
+        preserve_email: boolean;
+        path: string;
+        script_path: string;
+        extra_perms: {
+            [key: string]: (boolean);
+        };
+        workspace_id: string;
+        edited_by: string;
+        edited_at: string;
+        is_flow: boolean;
+        mode: import("./gen").TriggerMode;
+        route_path: string;
+        static_asset_config?: {
+            s3: string;
+            storage?: string;
+            filename?: string;
+        } | null;
+        http_method: import("./gen").HttpMethod;
+        authentication_resource_path?: string | null;
+        summary?: string | null;
+        description?: string | null;
+        request_type: import("./gen").HttpRequestType;
+        authentication_method: import("./gen").AuthenticationMethod;
+        is_static_website: boolean;
+        workspaced_route: boolean;
+        wrap_body: boolean;
+        raw_string: boolean;
+        error_handler_path?: string;
+        error_handler_args?: import("./gen").ScriptArgs;
+        retry?: import("./gen").Retry;
+    };
     createFn: typeof HttpTriggerService.createHttpTrigger;
     updateFn: typeof HttpTriggerService.updateHttpTrigger;
 } | {
-    data: import("./gen").Schedule;
+    data: {
+        email: string | undefined;
+        preserve_email: boolean;
+        path: string;
+        edited_by: string;
+        edited_at: string;
+        schedule: string;
+        timezone: string;
+        enabled: boolean;
+        script_path: string;
+        is_flow: boolean;
+        args?: import("./gen").ScriptArgs | null;
+        extra_perms: {
+            [key: string]: (boolean);
+        };
+        error?: string | null;
+        on_failure?: string | null;
+        on_failure_times?: number | null;
+        on_failure_exact?: boolean | null;
+        on_failure_extra_args?: import("./gen").ScriptArgs | null;
+        on_recovery?: string | null;
+        on_recovery_times?: number | null;
+        on_recovery_extra_args?: import("./gen").ScriptArgs | null;
+        on_success?: string | null;
+        on_success_extra_args?: import("./gen").ScriptArgs | null;
+        ws_error_handler_muted?: boolean;
+        retry?: import("./gen").Retry | null;
+        summary?: string | null;
+        description?: string | null;
+        no_flow_overlap?: boolean;
+        tag?: string | null;
+        paused_until?: string | null;
+        cron_version?: string | null;
+        dynamic_skip?: string | null;
+    };
     createFn: typeof ScheduleService.createSchedule;
     updateFn: typeof ScheduleService.updateSchedule;
 }>;
@@ -56,7 +276,7 @@ export declare function getTriggerValue(kind: TriggerKind, path: string, workspa
     is_flow: boolean;
     queue_url: string;
     aws_resource_path: string;
-    message_attributes: string[] | undefined;
+    message_attributes: string[] | null | undefined;
     kafka_resource_path?: undefined;
     topics?: undefined;
     group_id?: undefined;
@@ -165,11 +385,11 @@ export declare function getTriggerValue(kind: TriggerKind, path: string, workspa
     script_path: string;
     is_flow: boolean;
     mqtt_resource_path: string;
-    v3_config: import("./gen").MqttV3Config | undefined;
-    v5_config: import("./gen").MqttV5Config | undefined;
-    client_id: string | undefined;
+    v3_config: import("./gen").MqttV3Config | null | undefined;
+    v5_config: import("./gen").MqttV5Config | null | undefined;
+    client_id: string | null | undefined;
     subscribe_topics: import("./gen").MqttSubscribeTopic[];
-    client_version: import("./gen").MqttClientVersion | undefined;
+    client_version: import("./gen").MqttClientVersion | null | undefined;
     queue_url?: undefined;
     aws_resource_path?: undefined;
     message_attributes?: undefined;
@@ -221,8 +441,8 @@ export declare function getTriggerValue(kind: TriggerKind, path: string, workspa
     is_flow: boolean;
     nats_resource_path: string;
     use_jetstream: boolean;
-    stream_name: string | undefined;
-    consumer_name: string | undefined;
+    stream_name: string | null | undefined;
+    consumer_name: string | null | undefined;
     subjects: string[];
     queue_url?: undefined;
     aws_resource_path?: undefined;
@@ -385,13 +605,13 @@ export declare function getTriggerValue(kind: TriggerKind, path: string, workspa
     script_path: string;
     is_flow: boolean;
     url: string;
-    url_runnable_args: import("./gen").ScriptArgs | undefined;
+    url_runnable_args: import("./gen").ScriptArgs | null | undefined;
     can_return_message: boolean;
     filters: {
         key: string;
         value: unknown;
     }[];
-    initial_messages: import("./gen").WebsocketTriggerInitialMessage[] | undefined;
+    initial_messages: import("./gen").WebsocketTriggerInitialMessage[] | null | undefined;
     queue_url?: undefined;
     aws_resource_path?: undefined;
     message_attributes?: undefined;
@@ -447,11 +667,11 @@ export declare function getTriggerValue(kind: TriggerKind, path: string, workspa
         s3: string;
         storage?: string;
         filename?: string;
-    } | undefined;
+    } | null | undefined;
     request_type: import("./gen").HttpRequestType;
     authentication_method: import("./gen").AuthenticationMethod;
     is_static_website: boolean;
-    authentication_resource_path: string | undefined;
+    authentication_resource_path: string | null | undefined;
     mode?: undefined;
     queue_url?: undefined;
     aws_resource_path?: undefined;
@@ -500,24 +720,24 @@ export declare function getTriggerValue(kind: TriggerKind, path: string, workspa
 } | {
     script_path: string;
     is_flow: boolean;
-    on_failure: string | undefined;
+    on_failure: string | null | undefined;
     schedule: string;
     timezone: string;
-    on_failure_times: number | undefined;
-    on_failure_exact: boolean | undefined;
-    on_failure_extra_args: import("./gen").ScriptArgs | undefined;
-    on_recovery: string | undefined;
-    on_recovery_times: number | undefined;
-    on_recovery_extra_args: import("./gen").ScriptArgs | undefined;
-    on_success: string | undefined;
-    on_success_extra_args: import("./gen").ScriptArgs | undefined;
+    on_failure_times: number | null | undefined;
+    on_failure_exact: boolean | null | undefined;
+    on_failure_extra_args: import("./gen").ScriptArgs | null | undefined;
+    on_recovery: string | null | undefined;
+    on_recovery_times: number | null | undefined;
+    on_recovery_extra_args: import("./gen").ScriptArgs | null | undefined;
+    on_success: string | null | undefined;
+    on_success_extra_args: import("./gen").ScriptArgs | null | undefined;
     ws_error_handler_muted: boolean | undefined;
-    retry: import("./gen").Retry | undefined;
-    summary: string | undefined;
+    retry: import("./gen").Retry | null | undefined;
+    summary: string | null | undefined;
     no_flow_overlap: boolean | undefined;
-    tag: string | undefined;
-    paused_until: string | undefined;
-    cron_version: string | undefined;
+    tag: string | null | undefined;
+    paused_until: string | null | undefined;
+    cron_version: string | null | undefined;
     mode?: undefined;
     queue_url?: undefined;
     aws_resource_path?: undefined;
@@ -553,6 +773,10 @@ export declare function getTriggerValue(kind: TriggerKind, path: string, workspa
     is_static_website?: undefined;
     authentication_resource_path?: undefined;
 }>;
+/**
+ * Get the email for a trigger (used for on_behalf_of during deployment).
+ */
+export declare function getTriggerEmail(kind: TriggerKind, path: string, workspace: string): Promise<string | undefined>;
 export declare function getTriggerDependency(kind: TriggerKind, path: string, workspace: string): Promise<{
     kind: Kind;
     path: string;

package/package/utils_deployable.js

@@ -49,14 +49,19 @@ export async function existsTrigger(data, triggerKind) {
     }
     throw new Error(`Unexpected trigger kind ${triggerKind}. Allowed kinds are: routes, kafka, mqtt, postgres, sqs, gcp, websockets, nats, schedules.`);
 }
-export async function getTriggersDeployData(kind, path, workspace) {
+/**
+ * Get trigger deployment data with optional email preservation.
+ * @param onBehalfOfEmail - If set, the trigger will be deployed with this email and preserve_email=true.
+ */
+export async function getTriggersDeployData(kind, path, workspace, onBehalfOfEmail) {
+    const preserveEmail = onBehalfOfEmail !== undefined;
     if (kind === 'sqs') {
         const sqsTrigger = await SqsTriggerService.getSqsTrigger({
             workspace: workspace,
             path: path
         });
         return {
-            data: sqsTrigger,
+            data: { ...sqsTrigger, email: onBehalfOfEmail, preserve_email: preserveEmail },
             createFn: SqsTriggerService.createSqsTrigger,
             updateFn: SqsTriggerService.updateSqsTrigger
         };
@@ -67,7 +72,7 @@ export async function getTriggersDeployData(kind, path, workspace) {
             path: path
         });
         return {
-            data: kafkaTrigger,
+            data: { ...kafkaTrigger, email: onBehalfOfEmail, preserve_email: preserveEmail },
             createFn: KafkaTriggerService.createKafkaTrigger,
             updateFn: KafkaTriggerService.updateKafkaTrigger
         };
@@ -78,7 +83,7 @@ export async function getTriggersDeployData(kind, path, workspace) {
             path: path
         });
         return {
-            data: mqttTrigger,
+            data: { ...mqttTrigger, email: onBehalfOfEmail, preserve_email: preserveEmail },
             createFn: MqttTriggerService.createMqttTrigger,
             updateFn: MqttTriggerService.updateMqttTrigger
         };
@@ -89,7 +94,7 @@ export async function getTriggersDeployData(kind, path, workspace) {
             path: path
         });
         return {
-            data: natsTrigger,
+            data: { ...natsTrigger, email: onBehalfOfEmail, preserve_email: preserveEmail },
             createFn: NatsTriggerService.createNatsTrigger,
             updateFn: NatsTriggerService.updateNatsTrigger
         };
@@ -106,7 +111,10 @@ export async function getTriggersDeployData(kind, path, workspace) {
         }
         const data = {
             ...gcpTrigger,
-            base_endpoint: gcpTrigger.delivery_type === 'push' ? `${window.location.origin}${base}` : undefined
+            delivery_config: gcpTrigger.delivery_config ?? undefined,
+            base_endpoint: gcpTrigger.delivery_type === 'push' ? `${window.location.origin}${base}` : undefined,
+            email: onBehalfOfEmail,
+            preserve_email: preserveEmail
         };
         return {
             data,
@@ -120,7 +128,7 @@ export async function getTriggersDeployData(kind, path, workspace) {
             path: path
         });
         return {
-            data: postgresTrigger,
+            data: { ...postgresTrigger, email: onBehalfOfEmail, preserve_email: preserveEmail },
             createFn: PostgresTriggerService.createPostgresTrigger,
             updateFn: PostgresTriggerService.updatePostgresTrigger
         };
@@ -131,7 +139,7 @@ export async function getTriggersDeployData(kind, path, workspace) {
             path: path
         });
         return {
-            data: websocketTrigger,
+            data: { ...websocketTrigger, email: onBehalfOfEmail, preserve_email: preserveEmail },
             createFn: WebsocketTriggerService.createWebsocketTrigger,
             updateFn: WebsocketTriggerService.updateWebsocketTrigger
         };
@@ -142,7 +150,7 @@ export async function getTriggersDeployData(kind, path, workspace) {
             path: path
         });
         return {
-            data: httpTrigger,
+            data: { ...httpTrigger, email: onBehalfOfEmail, preserve_email: preserveEmail },
             createFn: HttpTriggerService.createHttpTrigger,
             updateFn: HttpTriggerService.updateHttpTrigger
         };
@@ -153,7 +161,7 @@ export async function getTriggersDeployData(kind, path, workspace) {
             path: path
         });
         return {
-            data: schedulesTrigger,
+            data: { ...schedulesTrigger, email: onBehalfOfEmail, preserve_email: preserveEmail },
             createFn: ScheduleService.createSchedule,
             updateFn: ScheduleService.updateSchedule
         };
@@ -311,6 +319,53 @@ export async function getTriggerValue(kind, path, workspace) {
     }
     throw new Error(`Unexpected trigger kind got: ${kind}`);
 }
+/**
+ * Get the email for a trigger (used for on_behalf_of during deployment).
+ */
+export async function getTriggerEmail(kind, path, workspace) {
+    try {
+        if (kind === 'sqs') {
+            const trigger = await SqsTriggerService.getSqsTrigger({ workspace, path });
+            return trigger.edited_by;
+        }
+        else if (kind === 'kafka') {
+            const trigger = await KafkaTriggerService.getKafkaTrigger({ workspace, path });
+            return trigger.edited_by;
+        }
+        else if (kind === 'mqtt') {
+            const trigger = await MqttTriggerService.getMqttTrigger({ workspace, path });
+            return trigger.edited_by;
+        }
+        else if (kind === 'nats') {
+            const trigger = await NatsTriggerService.getNatsTrigger({ workspace, path });
+            return trigger.edited_by;
+        }
+        else if (kind === 'gcp') {
+            const trigger = await GcpTriggerService.getGcpTrigger({ workspace, path });
+            return trigger.edited_by;
+        }
+        else if (kind === 'postgres') {
+            const trigger = await PostgresTriggerService.getPostgresTrigger({ workspace, path });
+            return trigger.edited_by;
+        }
+        else if (kind === 'websockets') {
+            const trigger = await WebsocketTriggerService.getWebsocketTrigger({ workspace, path });
+            return trigger.edited_by;
+        }
+        else if (kind === 'routes') {
+            const trigger = await HttpTriggerService.getHttpTrigger({ workspace, path });
+            return trigger.edited_by;
+        }
+        else if (kind === 'schedules') {
+            const trigger = await ScheduleService.getSchedule({ workspace, path });
+            return trigger.edited_by;
+        }
+    }
+    catch {
+        // Trigger may not exist in the workspace
+    }
+    return undefined;
+}
 function retrieveScriptOrFlowKind(path, is_flow) {
     return {
         kind: is_flow ? 'flow' : 'script',
@@ -395,7 +450,7 @@ export async function getTriggerDependency(kind, path, workspace) {
         result = retrieveKindsValues({
             script_path,
             is_flow,
-            resource_path: authentication_resource_path
+            resource_path: authentication_resource_path ?? undefined
         });
     }
     else if (kind === 'schedules') {

package/package/utils_workspace_deploy.d.ts

@@ -0,0 +1,31 @@
+import { type AdditionalInformation, type Kind } from './utils_deployable';
+export interface DeployItemParams {
+    kind: Kind;
+    path: string;
+    workspaceFrom: string;
+    workspaceTo: string;
+    additionalInformation?: AdditionalInformation;
+    /** The email to use for on_behalf_of. If set, preserve_on_behalf_of will be true. If undefined, deploying user's email is used. */
+    onBehalfOfEmail?: string;
+}
+export interface DeployResult {
+    success: boolean;
+    error?: string;
+}
+/**
+ * Deploy an item from one workspace to another.
+ * Handles all item kinds: flow, script, app, variable, resource, resource_type, folder, trigger.
+ */
+export declare function deployItem(params: DeployItemParams): Promise<DeployResult>;
+/**
+ * Check if an item already exists in the target workspace.
+ */
+export declare function checkItemExists(kind: Kind, path: string, workspace: string, additionalInformation?: AdditionalInformation): Promise<boolean>;
+/**
+ * Get the value of an item for diff comparison.
+ */
+export declare function getItemValue(kind: Kind, path: string, workspace: string, additionalInformation?: AdditionalInformation): Promise<unknown>;
+/**
+ * Get the on_behalf_of_email for a flow, script, app, or trigger (including schedule).
+ */
+export declare function getOnBehalfOfEmail(kind: Kind, path: string, workspace: string, additionalInformation?: AdditionalInformation): Promise<string | undefined>;