@uniformdev/automations-sdk 20.72.3-alpha.23 → 20.72.3-alpha.40

package/dist/api/index.d.mts

@@ -393,6 +393,8 @@ interface paths {
                 query: {
                     /** @description The project ID. */
                     projectId: string;
+                    /** @description Comma-separated list of automation public IDs to return. Omit to return all. */
+                    automationIDs?: string;
                 };
                 header?: never;
                 path?: never;
@@ -423,7 +425,7 @@ interface paths {
                                          * @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";
+                                        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" | "notification.created" | "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";
                                         /** @description Optional CEL boolean expression evaluated against { input, trigger }; the automation runs only when it is true. */
                                         filter?: string;
                                     } | {
@@ -470,7 +472,7 @@ interface paths {
                                 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. */
+                                    /** @description Role public IDs granted to the automation identity, keyed by project ID. */
                                     projects: {
                                         [key: string]: string[];
                                     };
@@ -516,7 +518,7 @@ interface paths {
                              * @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";
+                            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" | "notification.created" | "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";
                             /** @description Optional CEL boolean expression evaluated against { input, trigger }; the automation runs only when it is true. */
                             filter?: string;
                         } | {
@@ -764,6 +766,13 @@ type AutomationsClientOptions = Omit<ClientOptions, 'projectId'> & {
  */
 declare class AutomationsClient extends ApiClient<AutomationsClientOptions> {
     #private;
+    /**
+     * Fetches a single automation by public ID.
+     *
+     * @param publicId - The automation public ID.
+     * @throws ApiClientError with status 404 when no such automation exists.
+     */
+    get(publicId: string): Promise<AutomationSummary>;
     /**
      * Lists the automations configured for a project.
      */

package/dist/api/index.mjs

@@ -7,9 +7,28 @@ import {
 } from "../chunk-I6KKUHEY.mjs";
 
 // src/api/AutomationsClient.ts
-import { ApiClient } from "@uniformdev/context/api";
+import { ApiClient, ApiClientError } from "@uniformdev/context/api";
 var _automationsUrl, _runsUrl, _logsUrl;
 var _AutomationsClient = class _AutomationsClient extends ApiClient {
+  /**
+   * Fetches a single automation by public ID.
+   *
+   * @param publicId - The automation public ID.
+   * @throws ApiClientError with status 404 when no such automation exists.
+   */
+  async get(publicId) {
+    const { projectId } = this.options;
+    const url = this.createUrl(__privateGet(_AutomationsClient, _automationsUrl), {
+      projectId,
+      automationIDs: [publicId]
+    });
+    const { automations } = await this.apiClient(url);
+    const automation = automations[0];
+    if (!automation) {
+      throw new ApiClientError("Automation not found", "GET", url.toString(), 404, "Not Found");
+    }
+    return automation;
+  }
   /**
    * Lists the automations configured for a project.
    */

package/dist/index.d.mts

@@ -2,6 +2,7 @@ import { StandardSchemaV1 } from '@standard-schema/spec';
 import { WebhookEventName, WebhookPayloadFor } from '@uniformdev/webhooks';
 import { AutomationResult, AutomationLogEntry } from './schemas/index.mjs';
 export { f as formatAutomationWebhookUrl } from './formatAutomationWebhookUrl-CD1HQmu6.mjs';
+import { ApiClient, ClientOptions } from '@uniformdev/context/api';
 import 'zod';
 
 /**
@@ -370,4 +371,388 @@ declare function defineAutomation<const M extends AutomationMetadata>(config: {
     handler: HandlerFromAutomationMetadata<M>;
 }): AutomationDefinition<M>;
 
-export { type AiToolAutomationMetadata, type AiToolInputSchema, type AiToolTriggerConfig, type AutomationContext, type AutomationDefinition, type AutomationHandler, type AutomationInvokePayload, type AutomationInvoker, AutomationLogEntry, type AutomationLogLevel, type AutomationLogger, type AutomationMetadata, type AutomationPermissions, AutomationResult, type ComposableTriggerConfig, type ComposedAutomationMetadata, type CredentialsFromAutomationMetadata, type EventTriggerConfig, type HandlerFromAutomationMetadata, type IncomingWebhookInput, type IncomingWebhookTriggerConfig, type InputFromAutomationMetadata, type JsonSchemaObject, type ScheduleRunInput, type ScheduleTriggerConfig, type TriggerConfig, type TriggerFromAutomationMetadata, type UniformConnectionParams, defineAutomation };
+interface paths {
+    "/api/v1/notifications": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * @deprecated
+         * @description Lists the current user's notifications. Results are cursor-paginated newest-first and may be scoped to the current team. Omit teamId to list every notification for the caller.
+         */
+        get: {
+            parameters: {
+                query?: {
+                    /** @description Opaque cursor returned by the previous response. Omit to read the newest page of notifications. */
+                    cursor?: string;
+                    /** @description When true, only unread notifications are returned. */
+                    unreadOnly?: boolean | null;
+                    /** @description Optional team scope. Use teamId to limit results to one team. */
+                    teamId?: string;
+                    /** @description Maximum number of notifications to return. Defaults to 50. */
+                    limit?: number;
+                };
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description OK */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            notifications: {
+                                id: string;
+                                /**
+                                 * @description The notification content type. Currently, only text notifications are supported.
+                                 * @enum {string}
+                                 */
+                                type: "text";
+                                teamId: string;
+                                project: {
+                                    id: string;
+                                    name: string;
+                                } | null;
+                                author: {
+                                    subject: string;
+                                    name: string;
+                                } | null;
+                                summary: {
+                                    /** @enum {string} */
+                                    format: "markdown";
+                                    value: string;
+                                };
+                                entity?: {
+                                    entityId: string;
+                                    /** @enum {string} */
+                                    type: "entry" | "composition";
+                                    releaseId?: string;
+                                    editionId?: string;
+                                } | {
+                                    entityId: string;
+                                    /** @enum {string} */
+                                    type: "entryPattern" | "componentPattern" | "compositionPattern";
+                                    releaseId?: string;
+                                } | {
+                                    entityId: string;
+                                    /** @enum {string} */
+                                    type: "component" | "contentType" | "blockType" | "asset" | "audience" | "intent" | "enrichment" | "signal" | "quirk" | "test" | "projectMapNode";
+                                } | {
+                                    /** @enum {string} */
+                                    type: "external";
+                                    /** Format: uri */
+                                    url: string;
+                                };
+                                /** Format: date-time */
+                                createdAt: string;
+                                /** Format: date-time */
+                                readAt?: string | null;
+                            }[];
+                            cursor?: string;
+                            unreadCount: number;
+                        };
+                    };
+                };
+                400: components["responses"]["BadRequestError"];
+                401: components["responses"]["UnauthorizedError"];
+                403: components["responses"]["ForbiddenError"];
+                429: components["responses"]["RateLimitError"];
+                500: components["responses"]["InternalServerError"];
+            };
+        };
+        put?: never;
+        /**
+         * @deprecated
+         * @description Creates a project-scoped notification for recipients who belong to the project's team. The caller must have access to the project. A missing or inaccessible project returns 404.
+         */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        recipients: string[];
+                        /**
+                         * @description The notification content type. Currently, only text notifications are supported.
+                         * @default text
+                         * @enum {string}
+                         */
+                        type?: "text";
+                        summary: {
+                            /** @enum {string} */
+                            format: "markdown";
+                            value: string;
+                        };
+                        entity?: {
+                            entityId: string;
+                            /** @enum {string} */
+                            type: "entry" | "composition";
+                            releaseId?: string;
+                            editionId?: string;
+                        } | {
+                            entityId: string;
+                            /** @enum {string} */
+                            type: "entryPattern" | "componentPattern" | "compositionPattern";
+                            releaseId?: string;
+                        } | {
+                            entityId: string;
+                            /** @enum {string} */
+                            type: "component" | "contentType" | "blockType" | "asset" | "audience" | "intent" | "enrichment" | "signal" | "quirk" | "test" | "projectMapNode";
+                        } | {
+                            /** @enum {string} */
+                            type: "external";
+                            /** Format: uri */
+                            url: string;
+                        };
+                        projectId: string;
+                    };
+                };
+            };
+            responses: {
+                /** @description Created */
+                201: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            id: string;
+                            /**
+                             * @description The notification content type. Currently, only text notifications are supported.
+                             * @enum {string}
+                             */
+                            type: "text";
+                            teamId: string;
+                            project: {
+                                id: string;
+                                name: string;
+                            } | null;
+                            author: {
+                                subject: string;
+                                name: string;
+                            } | null;
+                            summary: {
+                                /** @enum {string} */
+                                format: "markdown";
+                                value: string;
+                            };
+                            entity?: {
+                                entityId: string;
+                                /** @enum {string} */
+                                type: "entry" | "composition";
+                                releaseId?: string;
+                                editionId?: string;
+                            } | {
+                                entityId: string;
+                                /** @enum {string} */
+                                type: "entryPattern" | "componentPattern" | "compositionPattern";
+                                releaseId?: string;
+                            } | {
+                                entityId: string;
+                                /** @enum {string} */
+                                type: "component" | "contentType" | "blockType" | "asset" | "audience" | "intent" | "enrichment" | "signal" | "quirk" | "test" | "projectMapNode";
+                            } | {
+                                /** @enum {string} */
+                                type: "external";
+                                /** Format: uri */
+                                url: string;
+                            };
+                            /** Format: date-time */
+                            createdAt: string;
+                            /** Format: date-time */
+                            readAt?: string | null;
+                        };
+                    };
+                };
+                400: components["responses"]["BadRequestError"];
+                401: components["responses"]["UnauthorizedError"];
+                403: components["responses"]["ForbiddenError"];
+                /** @description Project not found or inaccessible to the caller */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                429: components["responses"]["RateLimitError"];
+                500: components["responses"]["InternalServerError"];
+            };
+        };
+        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;
+        /**
+         * @deprecated
+         * @description Updates read state for the current user's notifications. Use target: ids to update specific notifications, or target: all to mark all notifications as read. Read-all may be scoped to a team.
+         */
+        patch: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        /** @enum {string} */
+                        target: "ids";
+                        ids: string[];
+                        read: boolean;
+                    } | {
+                        /** @enum {string} */
+                        target: "all";
+                        teamId?: string;
+                    };
+                };
+            };
+            responses: {
+                /** @description No Content */
+                204: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": unknown;
+                    };
+                };
+                400: components["responses"]["BadRequestError"];
+                401: components["responses"]["UnauthorizedError"];
+                403: components["responses"]["ForbiddenError"];
+                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 NotificationsApi = paths['/api/v1/notifications'];
+/** Query parameters for listing the current user's notifications. */
+type NotificationsGetParameters = NonNullable<NotificationsApi['get']['parameters']['query']>;
+/** A page of notifications for the current user. */
+type NotificationsGetResponse = NotificationsApi['get']['responses']['200']['content']['application/json'];
+/** A notification returned by the Notifications API. */
+type Notification = NotificationsGetResponse['notifications'][number];
+/** An entity referenced by a notification. */
+type NotificationEntity = NonNullable<Notification['entity']>;
+/** Parameters for creating a notification. */
+type NotificationPostParameters = NotificationsApi['post']['requestBody']['content']['application/json'];
+/** The notification created by the Notifications API. */
+type NotificationPostResponse = NotificationsApi['post']['responses']['201']['content']['application/json'];
+/** Parameters for updating notification read state. */
+type NotificationPatchParameters = NotificationsApi['patch']['requestBody']['content']['application/json'];
+
+/**
+ * API client for listing, creating, and updating notifications.
+ *
+ * @deprecated This API is experimental and may change without notice.
+ */
+declare class NotificationsClient extends ApiClient {
+    #private;
+    constructor(options: ClientOptions);
+    /**
+     * Lists notifications for the current user.
+     *
+     * @deprecated This API is experimental and may change without notice.
+     */
+    list(options?: NotificationsGetParameters): Promise<NotificationsGetResponse>;
+    /**
+     * Creates a notification for one or more recipients.
+     *
+     * @deprecated This API is experimental and may change without notice.
+     */
+    create(body: NotificationPostParameters): Promise<NotificationPostResponse>;
+    /**
+     * Updates the read state of the current user's notifications.
+     *
+     * @deprecated This API is experimental and may change without notice.
+     */
+    setReadState(body: NotificationPatchParameters): Promise<void>;
+}
+
+export { type AiToolAutomationMetadata, type AiToolInputSchema, type AiToolTriggerConfig, type AutomationContext, type AutomationDefinition, type AutomationHandler, type AutomationInvokePayload, type AutomationInvoker, AutomationLogEntry, type AutomationLogLevel, type AutomationLogger, type AutomationMetadata, type AutomationPermissions, AutomationResult, type ComposableTriggerConfig, type ComposedAutomationMetadata, type CredentialsFromAutomationMetadata, type EventTriggerConfig, type HandlerFromAutomationMetadata, type IncomingWebhookInput, type IncomingWebhookTriggerConfig, type InputFromAutomationMetadata, type JsonSchemaObject, type Notification, type NotificationEntity, type NotificationPatchParameters, type NotificationPostParameters, type NotificationPostResponse, NotificationsClient, type NotificationsGetParameters, type NotificationsGetResponse, type ScheduleRunInput, type ScheduleTriggerConfig, type TriggerConfig, type TriggerFromAutomationMetadata, type UniformConnectionParams, defineAutomation };

package/dist/index.mjs

@@ -1,7 +1,10 @@
 import {
   formatAutomationWebhookUrl
 } from "./chunk-TWKWPWN3.mjs";
-import "./chunk-I6KKUHEY.mjs";
+import {
+  __privateAdd,
+  __privateGet
+} from "./chunk-I6KKUHEY.mjs";
 
 // src/runtime.ts
 function captureLog(logs, level, message) {
@@ -65,7 +68,54 @@ function defineAutomation(config) {
   const invoker = (payload) => runAutomationHandler(config.handler, payload, { requireUniformCredentials });
   return Object.assign(invoker, { metadata: config.metadata });
 }
+
+// src/NotificationsClient.ts
+import { ApiClient } from "@uniformdev/context/api";
+var _url;
+var _NotificationsClient = class _NotificationsClient extends ApiClient {
+  constructor(options) {
+    super(options);
+  }
+  /**
+   * Lists notifications for the current user.
+   *
+   * @deprecated This API is experimental and may change without notice.
+   */
+  async list(options) {
+    const fetchUri = this.createUrl(__privateGet(_NotificationsClient, _url), options);
+    return await this.apiClient(fetchUri);
+  }
+  /**
+   * Creates a notification for one or more recipients.
+   *
+   * @deprecated This API is experimental and may change without notice.
+   */
+  async create(body) {
+    const fetchUri = this.createUrl(__privateGet(_NotificationsClient, _url));
+    return await this.apiClient(fetchUri, {
+      method: "POST",
+      body: JSON.stringify(body)
+    });
+  }
+  /**
+   * Updates the read state of the current user's notifications.
+   *
+   * @deprecated This API is experimental and may change without notice.
+   */
+  async setReadState(body) {
+    const fetchUri = this.createUrl(__privateGet(_NotificationsClient, _url));
+    await this.apiClient(fetchUri, {
+      method: "PATCH",
+      body: JSON.stringify(body),
+      expectNoContent: true
+    });
+  }
+};
+_url = new WeakMap();
+__privateAdd(_NotificationsClient, _url, "/api/v1/notifications");
+var NotificationsClient = _NotificationsClient;
 export {
+  NotificationsClient,
   defineAutomation,
   formatAutomationWebhookUrl
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/automations-sdk",
-  "version": "20.72.3-alpha.23+cbe06f1e8a",
+  "version": "20.72.3-alpha.40+ffbec41570",
   "description": "Uniform Automations SDK",
   "license": "SEE LICENSE IN LICENSE.txt",
   "exports": {
@@ -40,8 +40,8 @@
   ],
   "dependencies": {
     "@standard-schema/spec": "^1.1.0",
-    "@uniformdev/context": "20.72.3-alpha.23+cbe06f1e8a",
-    "@uniformdev/webhooks": "20.72.3-alpha.23+cbe06f1e8a"
+    "@uniformdev/context": "20.72.3-alpha.40+ffbec41570",
+    "@uniformdev/webhooks": "20.72.3-alpha.40+ffbec41570"
   },
   "peerDependencies": {
     "ai": "^6.0.0",
@@ -62,5 +62,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "cbe06f1e8a5bb93b0e3cae6b1c8774f21c10506e"
+  "gitHead": "ffbec41570c4266c69674871c97146bf7bf86383"
 }