@automate.ax/catalog 0.62.0 → 0.63.0

package/dist/index.d.ts

@@ -1,3 +1,3 @@
 export { airtableService, anthropicService, apolloService, asanaService, brevoService, cerebrasService, cloudflareService, cohereService, deepinfraService, deepseekService, firecrawlService, fireworksService, getIntegrationService, githubService, googleGenaiService, googleService, groqService, huggingfaceService, integrationCatalog, linearService, microsoftService, millionverifierService, mistralService, openaiService, openrouterService, perplexityService, postgresService, resendService, scrapflyService, slackService, tidycalService, togetheraiService, trelloService, vercelAiGatewayService, vercelService, whatsappService, xaiService, type IntegrationServiceId, } from "./catalog.js";
 export { defineIntegrationCatalog, defineIntegrationService, integrationScope, type IntegrationAccountConnectionOption, type IntegrationAccountRequirement, type IntegrationConnectionDefinition, type IntegrationFormField, type IntegrationScopeRequirement, type IntegrationServiceDefinition, type ScopeRequirementGroup, type TriggerDefinition, type TriggerPresentation, type TriggerPresentationContext, type TriggerPresentationDetail, type TriggerScopePresentation, type TriggerPresentationValue, } from "./types.js";
-export { getHttpTriggerEndpoint, getHttpTriggerEndpointKey, getTriggerDefinition, getTriggerName, getTriggerPresentation, isTriggerVisible, triggerCatalog, triggerDefinitions, type HttpTriggerEndpointOptions, type HttpTriggerScope, type TriggerType, } from "./triggers/index.js";
+export { getDashboardRunEndpoint, getDashboardRunEndpointKey, getHttpTriggerEndpoint, getHttpTriggerEndpointKey, DASHBOARD_RUN_CONFIG_SCHEMA, getTriggerDefinition, getTriggerName, getTriggerPresentation, isTriggerVisible, triggerCatalog, triggerDefinitions, type DashboardRunConfig, type DashboardRunEndpointOptions, type DashboardRunField, type HttpTriggerEndpointOptions, type HttpTriggerScope, type TriggerType, } from "./triggers/index.js";

package/dist/index.js

@@ -1,3 +1,3 @@
 export { airtableService, anthropicService, apolloService, asanaService, brevoService, cerebrasService, cloudflareService, cohereService, deepinfraService, deepseekService, firecrawlService, fireworksService, getIntegrationService, githubService, googleGenaiService, googleService, groqService, huggingfaceService, integrationCatalog, linearService, microsoftService, millionverifierService, mistralService, openaiService, openrouterService, perplexityService, postgresService, resendService, scrapflyService, slackService, tidycalService, togetheraiService, trelloService, vercelAiGatewayService, vercelService, whatsappService, xaiService, } from "./catalog.js";
 export { defineIntegrationCatalog, defineIntegrationService, integrationScope, } from "./types.js";
-export { getHttpTriggerEndpoint, getHttpTriggerEndpointKey, getTriggerDefinition, getTriggerName, getTriggerPresentation, isTriggerVisible, triggerCatalog, triggerDefinitions, } from "./triggers/index.js";
+export { getDashboardRunEndpoint, getDashboardRunEndpointKey, getHttpTriggerEndpoint, getHttpTriggerEndpointKey, DASHBOARD_RUN_CONFIG_SCHEMA, getTriggerDefinition, getTriggerName, getTriggerPresentation, isTriggerVisible, triggerCatalog, triggerDefinitions, } from "./triggers/index.js";

package/dist/triggers/core.d.ts

@@ -1,3 +1,47 @@
+import * as z from "zod/mini";
+export declare const DASHBOARD_RUN_CONFIG_SCHEMA: z.ZodMiniObject<{
+    description: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    fields: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
+        maxLength: z.ZodMiniOptional<z.ZodMiniNumberFormat>;
+        minLength: z.ZodMiniOptional<z.ZodMiniNumberFormat>;
+        placeholder: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        type: z.ZodMiniEnum<{
+            email: "email";
+            text: "text";
+            url: "url";
+            textarea: "textarea";
+        }>;
+        description: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        label: z.ZodMiniString<string>;
+        required: z.ZodMiniPrefault<z.ZodMiniBoolean<boolean>>;
+    }, z.core.$strip>, z.ZodMiniObject<{
+        max: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
+        min: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
+        placeholder: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        step: z.ZodMiniPrefault<z.ZodMiniNumber<number>>;
+        type: z.ZodMiniLiteral<"number">;
+        description: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        label: z.ZodMiniString<string>;
+        required: z.ZodMiniPrefault<z.ZodMiniBoolean<boolean>>;
+    }, z.core.$strip>, z.ZodMiniObject<{
+        options: z.ZodMiniArray<z.ZodMiniObject<{
+            label: z.ZodMiniString<string>;
+            value: z.ZodMiniString<string>;
+        }, z.core.$strip>>;
+        placeholder: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        type: z.ZodMiniLiteral<"select">;
+        description: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        label: z.ZodMiniString<string>;
+        required: z.ZodMiniPrefault<z.ZodMiniBoolean<boolean>>;
+    }, z.core.$strip>, z.ZodMiniObject<{
+        type: z.ZodMiniLiteral<"checkbox">;
+        description: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        label: z.ZodMiniString<string>;
+        required: z.ZodMiniPrefault<z.ZodMiniBoolean<boolean>>;
+    }, z.core.$strip>], "type">>;
+    submitLabel: z.ZodMiniPrefault<z.ZodMiniString<string>>;
+    title: z.ZodMiniString<string>;
+}, z.core.$strip>;
 export declare const coreTriggerDefinitions: {
     readonly automationInvoked: {
         readonly getDetails: ({ config }: import("..").TriggerPresentationContext) => {
@@ -26,7 +70,62 @@ export declare const coreTriggerDefinitions: {
         readonly name: "HTTP request";
         readonly type: "http.request";
     };
+    readonly dashboardRun: {
+        readonly getDetails: ({ config }: import("..").TriggerPresentationContext) => {
+            label: string;
+            value: string;
+        }[];
+        readonly icon: "automation";
+        readonly name: "Dashboard run";
+        readonly type: "dashboard.run";
+    };
 };
+interface DashboardRunFieldBase {
+    /** Supporting text shown below the field. */
+    description?: string;
+    /** Visible field label. */
+    label: string;
+    /** Whether the form must contain a value. Defaults to true. */
+    required?: boolean;
+}
+export type DashboardRunField = (DashboardRunFieldBase & {
+    maxLength?: number;
+    minLength?: number;
+    placeholder?: string;
+    type: "email" | "text" | "textarea" | "url";
+}) | (DashboardRunFieldBase & {
+    max?: number;
+    min?: number;
+    placeholder?: string;
+    /** Increment used by the number input. Defaults to 1. */
+    step?: number;
+    type: "number";
+}) | (DashboardRunFieldBase & {
+    options: readonly {
+        label: string;
+        value: string;
+    }[];
+    placeholder?: string;
+    type: "select";
+}) | (DashboardRunFieldBase & {
+    type: "checkbox";
+});
+export interface DashboardRunConfig<TFields extends Record<string, DashboardRunField> = Record<string, DashboardRunField>> {
+    /** Supporting text shown below the form title. */
+    description?: string;
+    /** Named fields rendered in declaration order. */
+    fields: TFields;
+    /** Submit button text. Defaults to "Run". */
+    submitLabel?: string;
+    /** Form heading. */
+    title: string;
+}
+export interface DashboardRunEndpointOptions {
+    appOrigin: string;
+    automationId: string;
+    hookSlot: number;
+    scopePath?: readonly number[];
+}
 export type HttpTriggerScope = "trigger" | "automation" | "project";
 export interface HttpTriggerEndpointOptions {
     appOrigin: string;
@@ -48,3 +147,17 @@ export declare function getHttpTriggerEndpoint(options: HttpTriggerEndpointOptio
  * @param options - Trigger and owning resource identity.
  */
 export declare function getHttpTriggerEndpointKey(options: Omit<HttpTriggerEndpointOptions, "appOrigin">): string;
+/**
+ * Returns the organization-authenticated submission endpoint for one dashboard
+ * run.
+ *
+ * @param options - Public origin and trigger identity.
+ */
+export declare function getDashboardRunEndpoint(options: DashboardRunEndpointOptions): string;
+/**
+ * Returns the durable endpoint identity for one dashboard run trigger.
+ *
+ * @param options - Trigger and owning automation identity.
+ */
+export declare function getDashboardRunEndpointKey(options: Omit<DashboardRunEndpointOptions, "appOrigin">): string;
+export {};

package/dist/triggers/core.js

@@ -9,6 +9,60 @@ const HTTP_PRESENTATION_CONFIG_SCHEMA = z.object({
 const INVOCATION_PRESENTATION_CONFIG_SCHEMA = z.object({
     entrypoint: z.string(),
 });
+const FIELD_NAME_SCHEMA = z
+    .string()
+    .check(z.trim(), z.minLength(1), z.maxLength(100));
+const FIELD_LABEL_SCHEMA = z
+    .string()
+    .check(z.trim(), z.minLength(1), z.maxLength(255));
+const FIELD_DESCRIPTION_SCHEMA = z.string().check(z.maxLength(2_000));
+const FIELD_LENGTH_SCHEMA = z.int().check(z.nonnegative());
+const DASHBOARD_RUN_FIELD_BASE_SCHEMA = {
+    description: z.optional(FIELD_DESCRIPTION_SCHEMA),
+    label: FIELD_LABEL_SCHEMA,
+    required: z.prefault(z.boolean(), true),
+};
+const DASHBOARD_RUN_TEXT_FIELD_SCHEMA = z.object({
+    ...DASHBOARD_RUN_FIELD_BASE_SCHEMA,
+    maxLength: z.optional(FIELD_LENGTH_SCHEMA),
+    minLength: z.optional(FIELD_LENGTH_SCHEMA),
+    placeholder: z.optional(z.string()),
+    type: z.enum(["email", "text", "textarea", "url"]),
+});
+const DASHBOARD_RUN_NUMBER_FIELD_SCHEMA = z.object({
+    ...DASHBOARD_RUN_FIELD_BASE_SCHEMA,
+    max: z.optional(z.number()),
+    min: z.optional(z.number()),
+    placeholder: z.optional(z.string()),
+    step: z.prefault(z.number().check(z.positive()), 1),
+    type: z.literal("number"),
+});
+const DASHBOARD_RUN_SELECT_FIELD_SCHEMA = z.object({
+    ...DASHBOARD_RUN_FIELD_BASE_SCHEMA,
+    options: z
+        .array(z.object({
+        label: FIELD_LABEL_SCHEMA,
+        value: FIELD_NAME_SCHEMA,
+    }))
+        .check(z.minLength(1)),
+    placeholder: z.optional(z.string()),
+    type: z.literal("select"),
+});
+const DASHBOARD_RUN_CHECKBOX_FIELD_SCHEMA = z.object({
+    ...DASHBOARD_RUN_FIELD_BASE_SCHEMA,
+    type: z.literal("checkbox"),
+});
+export const DASHBOARD_RUN_CONFIG_SCHEMA = z.object({
+    description: z.optional(FIELD_DESCRIPTION_SCHEMA),
+    fields: z.record(FIELD_NAME_SCHEMA, z.discriminatedUnion("type", [
+        DASHBOARD_RUN_TEXT_FIELD_SCHEMA,
+        DASHBOARD_RUN_NUMBER_FIELD_SCHEMA,
+        DASHBOARD_RUN_SELECT_FIELD_SCHEMA,
+        DASHBOARD_RUN_CHECKBOX_FIELD_SCHEMA,
+    ])),
+    submitLabel: z.prefault(z.string().check(z.trim(), z.minLength(1), z.maxLength(100)), "Run"),
+    title: z.string().check(z.trim(), z.minLength(1), z.maxLength(255)),
+});
 export const coreTriggerDefinitions = {
     automationInvoked: {
         getDetails: ({ config }) => [
@@ -49,6 +103,17 @@ export const coreTriggerDefinitions = {
         name: "HTTP request",
         type: "http.request",
     },
+    dashboardRun: {
+        getDetails: ({ config }) => [
+            {
+                label: "Run form",
+                value: DASHBOARD_RUN_CONFIG_SCHEMA.parse(config).title,
+            },
+        ],
+        icon: "automation",
+        name: "Dashboard run",
+        type: "dashboard.run",
+    },
 };
 /**
  * Returns the public URL for one deployed HTTP trigger.
@@ -73,3 +138,23 @@ export function getHttpTriggerEndpointKey(options) {
         options.hookSlot,
     ].join(".")}`;
 }
+/**
+ * Returns the organization-authenticated submission endpoint for one dashboard
+ * run.
+ *
+ * @param options - Public origin and trigger identity.
+ */
+export function getDashboardRunEndpoint(options) {
+    return new URL(`/api/dashboard-runs/${getDashboardRunEndpointKey(options)}`, options.appOrigin).toString();
+}
+/**
+ * Returns the durable endpoint identity for one dashboard run trigger.
+ *
+ * @param options - Trigger and owning automation identity.
+ */
+export function getDashboardRunEndpointKey(options) {
+    return `${options.automationId}:${[
+        ...(options.scopePath ?? []),
+        options.hookSlot,
+    ].join(".")}`;
+}

package/dist/triggers/index.d.ts

@@ -1,5 +1,5 @@
 import type { TriggerDefinition, TriggerPresentation, TriggerPresentationContext, TriggerScopePresentation } from "../types.js";
-export { getHttpTriggerEndpoint, getHttpTriggerEndpointKey, type HttpTriggerEndpointOptions, type HttpTriggerScope, } from "./core.js";
+export { getDashboardRunEndpoint, getDashboardRunEndpointKey, getHttpTriggerEndpoint, getHttpTriggerEndpointKey, DASHBOARD_RUN_CONFIG_SCHEMA, type DashboardRunConfig, type DashboardRunEndpointOptions, type DashboardRunField, type HttpTriggerEndpointOptions, type HttpTriggerScope, } from "./core.js";
 /** Plain shared definitions for every public trigger type. */
 export declare const triggerDefinitions: {
     readonly whatsappMessageDelivered: {
@@ -1075,6 +1075,15 @@ export declare const triggerDefinitions: {
         readonly name: "HTTP request";
         readonly type: "http.request";
     };
+    readonly dashboardRun: {
+        readonly getDetails: ({ config }: TriggerPresentationContext) => {
+            label: string;
+            value: string;
+        }[];
+        readonly icon: "automation";
+        readonly name: "Dashboard run";
+        readonly type: "dashboard.run";
+    };
     readonly brevoTransactionalBlocked: {
         readonly account: {
             readonly connectionOptions: readonly [{
@@ -1555,6 +1564,14 @@ export declare const triggerCatalog: ({
     };
     icon: "webhook";
     type: "http.request";
+} | {
+    name: string;
+    getDetails: ({ config }: TriggerPresentationContext) => {
+        label: string;
+        value: string;
+    }[];
+    icon: "automation";
+    type: "dashboard.run";
 } | {
     name: string;
     account: {

package/dist/triggers/index.js

@@ -12,7 +12,7 @@ import { trelloTriggerDefinitions } from "./trello.js";
 import { vercelTriggerDefinitions } from "./vercel.js";
 import { whatsappTriggerDefinitions } from "./whatsapp.js";
 import { getIntegrationService } from "../catalog.js";
-export { getHttpTriggerEndpoint, getHttpTriggerEndpointKey, } from "./core.js";
+export { getDashboardRunEndpoint, getDashboardRunEndpointKey, getHttpTriggerEndpoint, getHttpTriggerEndpointKey, DASHBOARD_RUN_CONFIG_SCHEMA, } from "./core.js";
 /** Plain shared definitions for every public trigger type. */
 export const triggerDefinitions = {
     ...airtableTriggerDefinitions,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automate.ax/catalog",
-  "version": "0.62.0",
+  "version": "0.63.0",
   "description": "Shared integration service and trigger definitions for Automate.ax.",
   "license": "MIT",
   "repository": {

package/src/index.ts

@@ -57,14 +57,20 @@ export {
   type TriggerPresentationValue,
 } from "./types"
 export {
+  getDashboardRunEndpoint,
+  getDashboardRunEndpointKey,
   getHttpTriggerEndpoint,
   getHttpTriggerEndpointKey,
+  DASHBOARD_RUN_CONFIG_SCHEMA,
   getTriggerDefinition,
   getTriggerName,
   getTriggerPresentation,
   isTriggerVisible,
   triggerCatalog,
   triggerDefinitions,
+  type DashboardRunConfig,
+  type DashboardRunEndpointOptions,
+  type DashboardRunField,
   type HttpTriggerEndpointOptions,
   type HttpTriggerScope,
   type TriggerType,

package/src/triggers/core.ts

@@ -11,6 +11,69 @@ const HTTP_PRESENTATION_CONFIG_SCHEMA = z.object({
 const INVOCATION_PRESENTATION_CONFIG_SCHEMA = z.object({
   entrypoint: z.string(),
 })
+const FIELD_NAME_SCHEMA = z
+  .string()
+  .check(z.trim(), z.minLength(1), z.maxLength(100))
+const FIELD_LABEL_SCHEMA = z
+  .string()
+  .check(z.trim(), z.minLength(1), z.maxLength(255))
+const FIELD_DESCRIPTION_SCHEMA = z.string().check(z.maxLength(2_000))
+const FIELD_LENGTH_SCHEMA = z.int().check(z.nonnegative())
+const DASHBOARD_RUN_FIELD_BASE_SCHEMA = {
+  description: z.optional(FIELD_DESCRIPTION_SCHEMA),
+  label: FIELD_LABEL_SCHEMA,
+  required: z.prefault(z.boolean(), true),
+}
+const DASHBOARD_RUN_TEXT_FIELD_SCHEMA = z.object({
+  ...DASHBOARD_RUN_FIELD_BASE_SCHEMA,
+  maxLength: z.optional(FIELD_LENGTH_SCHEMA),
+  minLength: z.optional(FIELD_LENGTH_SCHEMA),
+  placeholder: z.optional(z.string()),
+  type: z.enum(["email", "text", "textarea", "url"]),
+})
+const DASHBOARD_RUN_NUMBER_FIELD_SCHEMA = z.object({
+  ...DASHBOARD_RUN_FIELD_BASE_SCHEMA,
+  max: z.optional(z.number()),
+  min: z.optional(z.number()),
+  placeholder: z.optional(z.string()),
+  step: z.prefault(z.number().check(z.positive()), 1),
+  type: z.literal("number"),
+})
+const DASHBOARD_RUN_SELECT_FIELD_SCHEMA = z.object({
+  ...DASHBOARD_RUN_FIELD_BASE_SCHEMA,
+  options: z
+    .array(
+      z.object({
+        label: FIELD_LABEL_SCHEMA,
+        value: FIELD_NAME_SCHEMA,
+      }),
+    )
+    .check(z.minLength(1)),
+  placeholder: z.optional(z.string()),
+  type: z.literal("select"),
+})
+const DASHBOARD_RUN_CHECKBOX_FIELD_SCHEMA = z.object({
+  ...DASHBOARD_RUN_FIELD_BASE_SCHEMA,
+  type: z.literal("checkbox"),
+})
+
+export const DASHBOARD_RUN_CONFIG_SCHEMA = z.object({
+  description: z.optional(FIELD_DESCRIPTION_SCHEMA),
+  fields: z.record(
+    FIELD_NAME_SCHEMA,
+    z.discriminatedUnion("type", [
+      DASHBOARD_RUN_TEXT_FIELD_SCHEMA,
+      DASHBOARD_RUN_NUMBER_FIELD_SCHEMA,
+      DASHBOARD_RUN_SELECT_FIELD_SCHEMA,
+      DASHBOARD_RUN_CHECKBOX_FIELD_SCHEMA,
+    ]),
+  ),
+  submitLabel: z.prefault(
+    z.string().check(z.trim(), z.minLength(1), z.maxLength(100)),
+    "Run",
+  ),
+  title: z.string().check(z.trim(), z.minLength(1), z.maxLength(255)),
+})
 
 export const coreTriggerDefinitions = {
   automationInvoked: {
@@ -60,8 +123,81 @@ export const coreTriggerDefinitions = {
     name: "HTTP request",
     type: "http.request",
   },
+  dashboardRun: {
+    getDetails: ({ config }) => [
+      {
+        label: "Run form",
+        value: DASHBOARD_RUN_CONFIG_SCHEMA.parse(config).title,
+      },
+    ],
+    icon: "automation",
+    name: "Dashboard run",
+    type: "dashboard.run",
+  },
 } as const satisfies Record<string, TriggerDefinition>
 
+interface DashboardRunFieldBase {
+  /** Supporting text shown below the field. */
+  description?: string
+
+  /** Visible field label. */
+  label: string
+
+  /** Whether the form must contain a value. Defaults to true. */
+  required?: boolean
+}
+
+export type DashboardRunField =
+  | (DashboardRunFieldBase & {
+      maxLength?: number
+      minLength?: number
+      placeholder?: string
+      type: "email" | "text" | "textarea" | "url"
+    })
+  | (DashboardRunFieldBase & {
+      max?: number
+      min?: number
+      placeholder?: string
+
+      /** Increment used by the number input. Defaults to 1. */
+      step?: number
+      type: "number"
+    })
+  | (DashboardRunFieldBase & {
+      options: readonly { label: string; value: string }[]
+      placeholder?: string
+      type: "select"
+    })
+  | (DashboardRunFieldBase & {
+      type: "checkbox"
+    })
+
+export interface DashboardRunConfig<
+  TFields extends Record<string, DashboardRunField> = Record<
+    string,
+    DashboardRunField
+  >,
+> {
+  /** Supporting text shown below the form title. */
+  description?: string
+
+  /** Named fields rendered in declaration order. */
+  fields: TFields
+
+  /** Submit button text. Defaults to "Run". */
+  submitLabel?: string
+
+  /** Form heading. */
+  title: string
+}
+
+export interface DashboardRunEndpointOptions {
+  appOrigin: string
+  automationId: string
+  hookSlot: number
+  scopePath?: readonly number[]
+}
+
 export type HttpTriggerScope = "trigger" | "automation" | "project"
 
 export interface HttpTriggerEndpointOptions {
@@ -100,3 +236,30 @@ export function getHttpTriggerEndpointKey(
     options.hookSlot,
   ].join(".")}`
 }
+
+/**
+ * Returns the organization-authenticated submission endpoint for one dashboard
+ * run.
+ *
+ * @param options - Public origin and trigger identity.
+ */
+export function getDashboardRunEndpoint(options: DashboardRunEndpointOptions) {
+  return new URL(
+    `/api/dashboard-runs/${getDashboardRunEndpointKey(options)}`,
+    options.appOrigin,
+  ).toString()
+}
+
+/**
+ * Returns the durable endpoint identity for one dashboard run trigger.
+ *
+ * @param options - Trigger and owning automation identity.
+ */
+export function getDashboardRunEndpointKey(
+  options: Omit<DashboardRunEndpointOptions, "appOrigin">,
+) {
+  return `${options.automationId}:${[
+    ...(options.scopePath ?? []),
+    options.hookSlot,
+  ].join(".")}`
+}

package/src/triggers/index.ts

@@ -20,8 +20,14 @@ import type {
 } from "../types"
 
 export {
+  getDashboardRunEndpoint,
+  getDashboardRunEndpointKey,
   getHttpTriggerEndpoint,
   getHttpTriggerEndpointKey,
+  DASHBOARD_RUN_CONFIG_SCHEMA,
+  type DashboardRunConfig,
+  type DashboardRunEndpointOptions,
+  type DashboardRunField,
   type HttpTriggerEndpointOptions,
   type HttpTriggerScope,
 } from "./core"