@uniformdev/automations-sdk 20.50.2-alpha.109

package/dist/api/index.d.mts

@@ -0,0 +1,707 @@
+export { f as formatAutomationWebhookUrl } from '../formatAutomationWebhookUrl-CD1HQmu6.mjs';
+import { ApiClient, ClientOptions } from '@uniformdev/context/api';
+
+interface paths$2 {
+    "/api/v1/automation-run-logs": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description Returns the log entries for a single automation run. */
+        get: {
+            parameters: {
+                query: {
+                    /** @description The project ID. */
+                    projectId: string;
+                    /** @description The automation run ID. */
+                    runId: string;
+                };
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description 200 response */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description Log entries for the run. */
+                            logs: {
+                                /**
+                                 * @description Severity of the log entry.
+                                 * @enum {string}
+                                 */
+                                level: "info" | "warning" | "error";
+                                /** @description Log message text. */
+                                message: string;
+                                /**
+                                 * Format: date-time
+                                 * @description When the log entry was recorded.
+                                 */
+                                createdAt: string;
+                                /** @description Unique identifier for the log entry. */
+                                id: string;
+                            }[];
+                        };
+                    };
+                };
+                400: components$2["responses"]["BadRequestError"];
+                401: components$2["responses"]["UnauthorizedError"];
+                403: components$2["responses"]["ForbiddenError"];
+                /** @description Run not found in this project. */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                429: components$2["responses"]["RateLimitError"];
+                500: components$2["responses"]["InternalServerError"];
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        /** @description Handles preflight requests. This endpoint allows CORS. */
+        options: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description ok */
+                204: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+            };
+        };
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+}
+interface components$2 {
+    schemas: {
+        Error: {
+            /** @description Error message(s) that occurred while processing the request */
+            errorMessage?: string[] | string;
+        };
+    };
+    responses: {
+        /** @description Request input validation failed */
+        BadRequestError: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components$2["schemas"]["Error"];
+            };
+        };
+        /** @description API key or token was not valid */
+        UnauthorizedError: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components$2["schemas"]["Error"];
+            };
+        };
+        /** @description Permission was denied */
+        ForbiddenError: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components$2["schemas"]["Error"];
+            };
+        };
+        /** @description Too many requests in allowed time period */
+        RateLimitError: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content?: never;
+        };
+        /** @description Execution error occurred */
+        InternalServerError: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content?: never;
+        };
+    };
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+
+interface paths$1 {
+    "/api/v1/automation-runs": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description Lists automation runs for a project, optionally filtered by automation and status. */
+        get: {
+            parameters: {
+                query: {
+                    /** @description The project ID. */
+                    projectId: string;
+                    /** @description Filter to runs of a single automation. */
+                    publicId?: string;
+                    /** @description Comma-separated list of statuses to include. Statuses: running, success, rejected, unauthorized, failure, timeout, cycleAborted. */
+                    status?: string;
+                    /** @description Number of records to skip. */
+                    offset?: number | null;
+                    /** @description Maximum number of records to return. */
+                    limit?: number;
+                };
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description 200 response */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description Matching automation runs. */
+                            runs: {
+                                /** @description Unique identifier for the run. */
+                                id: string;
+                                /** @description Public ID of the automation that was run. */
+                                publicId: string;
+                                /** @description Name of the automation at run time. */
+                                name: string;
+                                /**
+                                 * @description Terminal or in-progress status of an automation run.
+                                 * @enum {string}
+                                 */
+                                status: "running" | "success" | "rejected" | "unauthorized" | "failure" | "timeout" | "cycleAborted";
+                                /** @description Input payload passed to the handler, or null for scheduled runs without input. */
+                                input?: unknown;
+                                /**
+                                 * Format: date-time
+                                 * @description When the run started.
+                                 */
+                                startedAt: string;
+                                /**
+                                 * Format: date-time
+                                 * @description When the run finished, or null while still running.
+                                 */
+                                completedAt: string | null;
+                                /** @description Run duration in milliseconds, or null while still running. */
+                                latencyMs: number | null;
+                            }[];
+                            /** @description Total number of runs matching the filter. */
+                            totalCount: number;
+                        };
+                    };
+                };
+                400: components$1["responses"]["BadRequestError"];
+                401: components$1["responses"]["UnauthorizedError"];
+                403: components$1["responses"]["ForbiddenError"];
+                429: components$1["responses"]["RateLimitError"];
+                500: components$1["responses"]["InternalServerError"];
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        /** @description Handles preflight requests. This endpoint allows CORS. */
+        options: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description ok */
+                204: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+            };
+        };
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+}
+interface components$1 {
+    schemas: {
+        Error: {
+            /** @description Error message(s) that occurred while processing the request */
+            errorMessage?: string[] | string;
+        };
+    };
+    responses: {
+        /** @description Request input validation failed */
+        BadRequestError: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components$1["schemas"]["Error"];
+            };
+        };
+        /** @description API key or token was not valid */
+        UnauthorizedError: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components$1["schemas"]["Error"];
+            };
+        };
+        /** @description Permission was denied */
+        ForbiddenError: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components$1["schemas"]["Error"];
+            };
+        };
+        /** @description Too many requests in allowed time period */
+        RateLimitError: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content?: never;
+        };
+        /** @description Execution error occurred */
+        InternalServerError: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content?: never;
+        };
+    };
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+
+interface paths {
+    "/api/v1/automations": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description Lists the automations for a project. */
+        get: {
+            parameters: {
+                query: {
+                    /** @description The project ID. */
+                    projectId: string;
+                };
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description 200 response */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description Automations configured for the project. */
+                            automations: {
+                                /** @description Stable public identifier for the automation. */
+                                publicId: string;
+                                /** @description Display name of the automation. */
+                                name: string;
+                                /** @description Optional description. */
+                                description: string | null;
+                                /** @description How the automation is triggered. */
+                                trigger: {
+                                    /**
+                                     * @description The internal webhook event name that triggers this automation.
+                                     * @enum {string}
+                                     */
+                                    type: "asset.deleted" | "asset.published" | "composition.changed" | "composition.deleted" | "composition.published" | "composition.release.changed" | "composition.release.deleted" | "composition.release.published" | "composition.release.restored" | "entry.changed" | "entry.deleted" | "entry.published" | "entry.release.changed" | "entry.release.deleted" | "entry.release.published" | "entry.release.restored" | "manifest.published" | "projectmap.delete" | "projectmap.node.delete" | "projectmap.node.insert" | "projectmap.node.update" | "projectmap.update" | "redirect.delete" | "redirect.insert" | "redirect.update" | "release.changed" | "release.deleted" | "release.launch_started" | "release.launched" | "workflow.transition";
+                                } | {
+                                    /** @enum {string} */
+                                    type: "schedule";
+                                    /** @description RFC 5545 recurrence rule for when the automation runs. */
+                                    rrule: string;
+                                    /** @description IANA timezone used to evaluate the recurrence rule. */
+                                    timezone: string;
+                                } | {
+                                    /** @enum {string} */
+                                    type: "incomingWebhook";
+                                } | {
+                                    /** @enum {string} */
+                                    type: "aiTool";
+                                    /** @description JSON Schema describing the AI tool arguments. */
+                                    inputSchema: {
+                                        [key: string]: unknown;
+                                    };
+                                };
+                                /** @description Whether the automation is enabled. */
+                                enabled: boolean;
+                                /**
+                                 * Format: date-time
+                                 * @description Next scheduled run time, or null when not applicable.
+                                 */
+                                nextRunAt: string | null;
+                                /**
+                                 * Format: date-time
+                                 * @description When the automation code was last deployed.
+                                 */
+                                lastDeployedAt: string;
+                                /** @description User ID of the last deployer. */
+                                lastDeployedBy: string;
+                                /**
+                                 * Format: date-time
+                                 * @description When the automation was first created.
+                                 */
+                                createdAt: string;
+                                /** @description User ID of the creator. */
+                                createdBy: string;
+                                /** @description Machine identity for the automation, or null if it has none. */
+                                identity: {
+                                    /** @description Role IDs granted to the automation identity, keyed by project (site) ID. */
+                                    projects: {
+                                        [key: string]: string[];
+                                    };
+                                } | null;
+                            }[];
+                        };
+                    };
+                };
+                400: components["responses"]["BadRequestError"];
+                401: components["responses"]["UnauthorizedError"];
+                403: components["responses"]["ForbiddenError"];
+                429: components["responses"]["RateLimitError"];
+                500: components["responses"]["InternalServerError"];
+            };
+        };
+        /** @description Deploys (creates or updates) an automation. */
+        put: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        /** @description The project ID. */
+                        projectId: string;
+                        /** @description Stable public identifier for the automation. */
+                        publicId: string;
+                        /** @description Display name of the automation. */
+                        name: string;
+                        /** @description For automations triggered as an AI tool, this is used to determine when an LLM should call the automation. For other triggers, this is for your reference and optional. */
+                        description?: string;
+                        /** @description How the automation is triggered. */
+                        trigger: {
+                            /**
+                             * @description The internal webhook event name that triggers this automation.
+                             * @enum {string}
+                             */
+                            type: "asset.deleted" | "asset.published" | "composition.changed" | "composition.deleted" | "composition.published" | "composition.release.changed" | "composition.release.deleted" | "composition.release.published" | "composition.release.restored" | "entry.changed" | "entry.deleted" | "entry.published" | "entry.release.changed" | "entry.release.deleted" | "entry.release.published" | "entry.release.restored" | "manifest.published" | "projectmap.delete" | "projectmap.node.delete" | "projectmap.node.insert" | "projectmap.node.update" | "projectmap.update" | "redirect.delete" | "redirect.insert" | "redirect.update" | "release.changed" | "release.deleted" | "release.launch_started" | "release.launched" | "workflow.transition";
+                        } | {
+                            /** @enum {string} */
+                            type: "schedule";
+                            /** @description RFC 5545 recurrence rule for when the automation runs. */
+                            rrule: string;
+                            /** @description IANA timezone used to evaluate the recurrence rule. */
+                            timezone: string;
+                        } | {
+                            /** @enum {string} */
+                            type: "incomingWebhook";
+                        } | {
+                            /** @enum {string} */
+                            type: "aiTool";
+                            /** @description JSON Schema describing the AI tool arguments. */
+                            inputSchema: {
+                                [key: string]: unknown;
+                            };
+                        };
+                        /** @description Role grants for the automation identity. The caller must hold each requested role (or be a team admin). When omitted, the automation will not receive Uniform API access credentials. */
+                        permissions?: {
+                            /** @description Role grant(s) on the project the automation is deployed to. */
+                            role: string | string[];
+                            /** @description Additional project role grants keyed by project ID for cross-project access within the same team. */
+                            projects?: {
+                                [key: string]: string | string[];
+                            };
+                        };
+                        /** @description Bundled JavaScript module for the automation handler. */
+                        code: string;
+                        /** @description Target date for runtime compatibility. Runtime changes after this date may not apply to this automation. */
+                        compatibilityDate?: string;
+                    };
+                };
+            };
+            responses: {
+                /** @description Deploy successful */
+                204: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                400: components["responses"]["BadRequestError"];
+                401: components["responses"]["UnauthorizedError"];
+                403: components["responses"]["ForbiddenError"];
+                429: components["responses"]["RateLimitError"];
+                500: components["responses"]["InternalServerError"];
+            };
+        };
+        post?: never;
+        /** @description Deletes an automation and its run history. */
+        delete: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        /** @description The project ID. */
+                        projectId: string;
+                        /** @description The automation public ID. */
+                        publicId: string;
+                    };
+                };
+            };
+            responses: {
+                /** @description Delete successful */
+                204: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                400: components["responses"]["BadRequestError"];
+                401: components["responses"]["UnauthorizedError"];
+                403: components["responses"]["ForbiddenError"];
+                /** @description Automation not found */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                429: components["responses"]["RateLimitError"];
+                500: components["responses"]["InternalServerError"];
+            };
+        };
+        /** @description Handles preflight requests. This endpoint allows CORS. */
+        options: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description ok */
+                204: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+            };
+        };
+        head?: never;
+        /** @description Toggles the enabled state of an automation. Disabled automations do not run when their trigger occurs. */
+        patch: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        /** @description The project ID. */
+                        projectId: string;
+                        /** @description The automation public ID. */
+                        publicId: string;
+                        /** @description Whether the automation should be enabled. */
+                        enabled: boolean;
+                    };
+                };
+            };
+            responses: {
+                /** @description Toggle successful */
+                204: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                400: components["responses"]["BadRequestError"];
+                401: components["responses"]["UnauthorizedError"];
+                403: components["responses"]["ForbiddenError"];
+                /** @description Automation not found */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                429: components["responses"]["RateLimitError"];
+                500: components["responses"]["InternalServerError"];
+            };
+        };
+        trace?: never;
+    };
+}
+interface components {
+    schemas: {
+        Error: {
+            /** @description Error message(s) that occurred while processing the request */
+            errorMessage?: string[] | string;
+        };
+    };
+    responses: {
+        /** @description Request input validation failed */
+        BadRequestError: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["Error"];
+            };
+        };
+        /** @description API key or token was not valid */
+        UnauthorizedError: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["Error"];
+            };
+        };
+        /** @description Permission was denied */
+        ForbiddenError: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["Error"];
+            };
+        };
+        /** @description Too many requests in allowed time period */
+        RateLimitError: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content?: never;
+        };
+        /** @description Execution error occurred */
+        InternalServerError: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content?: never;
+        };
+    };
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+
+type AutomationsListResponse = paths['/api/v1/automations']['get']['responses']['200']['content']['application/json'];
+type AutomationSummary = AutomationsListResponse['automations'][number];
+type AutomationTriggerType = AutomationSummary['trigger']['type'];
+type AutomationsDeployBody = paths['/api/v1/automations']['put']['requestBody']['content']['application/json'];
+/** Deploy input without the project ID, which the client injects from its options. */
+type AutomationsDeployInput = Omit<AutomationsDeployBody, 'projectId'>;
+type AutomationRunsListResponse = paths$1['/api/v1/automation-runs']['get']['responses']['200']['content']['application/json'];
+type AutomationRunSummary = AutomationRunsListResponse['runs'][number];
+type AutomationRunStatus = AutomationRunSummary['status'];
+type AutomationRunLogEntry = paths$2['/api/v1/automation-run-logs']['get']['responses']['200']['content']['application/json']['logs'][number];
+
+type AutomationsClientOptions = Omit<ClientOptions, 'projectId'> & {
+    projectId: string;
+};
+/**
+ * Project-scoped client for the Uniform Automations API. Project ID is passed
+ * explicitly in the body (writes) or query (reads) on each request.
+ */
+declare class AutomationsClient extends ApiClient<AutomationsClientOptions> {
+    #private;
+    /**
+     * Lists the automations configured for a project.
+     */
+    list(): Promise<AutomationsListResponse>;
+    /**
+     * Deploys (creates or updates) a single automation.
+     *
+     * @param input - The automation definition + bundled code.
+     */
+    deploy(input: AutomationsDeployInput): Promise<void>;
+    /**
+     * Toggles the enabled state of an automation.
+     *
+     * @param publicId - The automation public ID.
+     * @param enabled - The desired enabled state.
+     */
+    setEnabled(publicId: string, enabled: boolean): Promise<void>;
+    /**
+     * Deletes an automation.
+     *
+     * @param publicId - The automation public ID.
+     */
+    remove(publicId: string): Promise<void>;
+    /**
+     * Lists automation runs for the project, optionally filtered by automation and status.
+     */
+    listRuns(options?: {
+        publicId?: string;
+        statuses?: AutomationRunStatus[];
+        offset?: number;
+        limit?: number;
+    }): Promise<AutomationRunsListResponse>;
+    /**
+     * Returns the log entries for a single automation run.
+     *
+     * @param runId - The automation run ID.
+     */
+    listRunLogs(runId: string): Promise<AutomationRunLogEntry[]>;
+}
+
+export { type AutomationRunLogEntry, type AutomationRunStatus, type AutomationRunSummary, type AutomationRunsListResponse, type AutomationSummary, type AutomationTriggerType, AutomationsClient, type AutomationsClientOptions, type AutomationsDeployBody, type AutomationsDeployInput, type AutomationsListResponse };