@teleporthq/teleport-plugin-next-workflows 0.44.11 → 0.45.0

package/dist/cjs/automations/automations-scope.d.ts

@@ -0,0 +1,104 @@
+import type { ProjectUIDL, UIDLAutomationsDataSourceType, UIDLAutomationsSettings, UIDLWorkflow, UIDLWorkflows } from '@teleporthq/teleport-types';
+/**
+ * Automations: workflows started by a business event (`event-business-event
+ * { eventType }`, spec §5.2). They never run in a browser; the generated app
+ * runs them itself, off the request path, from a Postgres-backed queue:
+ *
+ * - `lib/automations/event-bus.js` records an event and kicks the queue;
+ * - `lib/automations/dispatcher.js` is the queue worker;
+ * - `lib/automations/registry.js` maps each event type to its handlers;
+ * - `lib/automations/handlers/<slug>-<id8>.js`, one per automation;
+ * - `lib/automations/hydrate/<entity>.js` reads the record an event is about;
+ * - `pages/api/automations/dispatch.js` runs the queue for the app itself;
+ * - `lib/automations/due-check.js` wakes it on the site's activity
+ *   (activity-kicks.ts).
+ *
+ * All of it is generated only when the project has at least one automation.
+ *
+ * Event types only generated routes record: `user-signed-up` and
+ * `user-deleted` (the signup and account-deletion routes, the signup node),
+ * `product-low-stock` (the data API), `waitlist-joined` and
+ * `waitlist-spot-opened` (the waitlist routes). The editor's shared event
+ * writer (teleport-gui `features/shared/builders/record-event-node.ts`, the
+ * one writer a browser can reach) refuses these types, so a row of one of
+ * them was written by the generated app itself. The `user` hydrator relies on
+ * it for `user-deleted`: the account's row is gone before the route records
+ * the event, so the snapshot the route recorded (`payload.user`, naming the
+ * event's own `entity_id`) stands in for the record. Any other event whose
+ * record is missing is refused ("No such <entity>").
+ */
+export declare const BUSINESS_EVENT_TRIGGER = "event-business-event";
+export declare const WAIT_NODE_TYPE = "general-wait";
+export declare const AUTOMATIONS_PATH: string[];
+export declare const AUTOMATION_HANDLERS_PATH: string[];
+export declare const AUTOMATION_HYDRATE_PATH: string[];
+export declare const AUTOMATIONS_DISPATCH_ROUTE_PATH: string[];
+export declare const AUTOMATIONS_DISPATCH_URL = "/api/automations/dispatch";
+/** Every generated file's key in the project structure starts with this. */
+export declare const AUTOMATIONS_FILE_KEY_PREFIX = "automations-";
+/** The queue's limits (spec §5.2). */
+export declare const AUTOMATION_QUEUE_LIMITS: {
+    /** Events claimed, and Waits resumed, per pass. */
+    batchSize: number;
+    /** An event is tried at most this many times. */
+    maxAttempts: number;
+    /** Older events are left alone. */
+    maxAgeDays: number;
+    /**
+     * How long the dispatcher waits for one handler. A handler still running
+     * then is left running (its delivery stays `running`): it is only taken
+     * over once its claim is stale, never while it may still be at work.
+     */
+    handlerTimeoutMs: number;
+    /**
+     * A dispatch starts no handler after this long, and hands back the claims
+     * it did not start, so one call stays inside a serverless time limit.
+     */
+    passDeadlineMs: number;
+    /** A claim older than this was left by a run that died, and is taken over. */
+    staleClaimMinutes: number;
+    /** The dispatch route's time limit on hosts that read it (Vercel). */
+    routeMaxDurationSeconds: number;
+};
+/**
+ * The platform `waitUntil` the bus uses on Vercel (lib/automations/wait-until.js).
+ * 2.x is the line that still runs on Node 18.
+ */
+export declare const VERCEL_FUNCTIONS_DEPENDENCY: {
+    name: string;
+    version: string;
+};
+/**
+ * The database the bus opens, from `uidl.automations` (the data source the
+ * editor keeps the automation tables in). Automations run only on the
+ * TeleportHQ-managed database (v1): the platform fills `TELEPORT_DB_*` for
+ * it, and the data API every event writer goes through opens it. Null for
+ * anything else: no bus is generated then.
+ */
+export declare const resolveAutomationsDatabase: (settings: UIDLAutomationsSettings | undefined | null) => UIDLAutomationsDataSourceType | null;
+/** Why a project with automations got no bus (the stub dispatch route answers it). */
+export declare const AUTOMATIONS_UNAVAILABLE_REASON = "no TeleportHQ database holds the automation tables";
+export declare const isAutomationWorkflow: (workflow: UIDLWorkflow | undefined | null) => boolean;
+/** The event an automation reacts to; empty when the trigger names none. */
+export declare const automationEventType: (workflow: UIDLWorkflow) => string;
+export declare const collectAutomationWorkflows: (workflows?: UIDLWorkflows | null) => UIDLWorkflow[];
+/**
+ * Whether the project gets the in-app event bus (`lib/automations/event-bus.js`):
+ * `generateAutomationFiles` writes it for the automations that name their
+ * event. The routes that record or wake business events (signup, account
+ * deletion, the data API) carry that code only then, so a project without
+ * automations keeps them byte for byte. Takes the project's workflows, or the
+ * automations `collectAutomationWorkflows` already found.
+ */
+export declare const hasAutomationEventBus: (workflows?: UIDLWorkflows | UIDLWorkflow[] | null) => boolean;
+/**
+ * Whether the generated app has the in-app event bus: an automation that names
+ * its event (`hasAutomationEventBus`) and a database the queue runs on
+ * (`resolveAutomationsDatabase`). The one gate of every plugin whose routes
+ * record or wake business events, so those routes, `utils/app-events.js` and
+ * `lib/automations/*` always agree.
+ */
+export declare const hasAutomationsBus: (uidl: Pick<ProjectUIDL, 'workflows' | 'automations'>) => boolean;
+export declare const automationEntityOf: (eventType: string) => string | null;
+export declare const automationEnvelopeKeys: (eventType: string) => string[] | null;
+//# sourceMappingURL=automations-scope.d.ts.map

package/dist/cjs/automations/automations-scope.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"automations-scope.d.ts","sourceRoot":"","sources":["../../../src/automations/automations-scope.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,WAAW,EACX,6BAA6B,EAC7B,uBAAuB,EACvB,YAAY,EACZ,aAAa,EACd,MAAM,4BAA4B,CAAA;AAEnC;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AAEH,eAAO,MAAM,sBAAsB,yBAAyB,CAAA;AAC5D,eAAO,MAAM,cAAc,iBAAiB,CAAA;AAE5C,eAAO,MAAM,gBAAgB,UAAyB,CAAA;AACtD,eAAO,MAAM,wBAAwB,UAAoC,CAAA;AACzE,eAAO,MAAM,uBAAuB,UAAmC,CAAA;AACvE,eAAO,MAAM,+BAA+B,UAAkC,CAAA;AAC9E,eAAO,MAAM,wBAAwB,8BAA8B,CAAA;AAEnE,4EAA4E;AAC5E,eAAO,MAAM,2BAA2B,iBAAiB,CAAA;AAEzD,sCAAsC;AACtC,eAAO,MAAM,uBAAuB;IAClC,mDAAmD;;IAEnD,iDAAiD;;IAEjD,mCAAmC;;IAEnC;;;;OAIG;;IAEH;;;OAGG;;IAEH,8EAA8E;;IAE9E,sEAAsE;;CAEvE,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,2BAA2B;;;CAAoD,CAAA;AAE5F;;;;;;GAMG;AACH,eAAO,MAAM,0BAA0B,aAC3B,uBAAuB,GAAG,SAAS,GAAG,IAAI,KACnD,6BAA6B,GAAG,IACqC,CAAA;AAExE,sFAAsF;AACtF,eAAO,MAAM,8BAA8B,uDAAuD,CAAA;AAElG,eAAO,MAAM,oBAAoB,aAAc,YAAY,GAAG,SAAS,GAAG,IAAI,KAAG,OACK,CAAA;AAEtF,4EAA4E;AAC5E,eAAO,MAAM,mBAAmB,aAAc,YAAY,KAAG,MAG5D,CAAA;AAED,eAAO,MAAM,0BAA0B,eAAgB,aAAa,GAAG,IAAI,KAAG,YAAY,EACJ,CAAA;AAEtF;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB,eACpB,aAAa,GAAG,YAAY,EAAE,GAAG,IAAI,KAChD,OAKF,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,SAAU,KAAK,WAAW,EAAE,WAAW,GAAG,aAAa,CAAC,KAAG,OACO,CAAA;AAyBhG,eAAO,MAAM,kBAAkB,cAAe,MAAM,KAAG,MAAM,GAAG,IAS/D,CAAA;AA0BD,eAAO,MAAM,sBAAsB,cAAe,MAAM,KAAG,MAAM,EAAE,GAAG,IAGrE,CAAA"}

package/dist/cjs/automations/automations-scope.js

@@ -0,0 +1,176 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.automationEnvelopeKeys = exports.automationEntityOf = exports.hasAutomationsBus = exports.hasAutomationEventBus = exports.collectAutomationWorkflows = exports.automationEventType = exports.isAutomationWorkflow = exports.AUTOMATIONS_UNAVAILABLE_REASON = exports.resolveAutomationsDatabase = exports.VERCEL_FUNCTIONS_DEPENDENCY = exports.AUTOMATION_QUEUE_LIMITS = exports.AUTOMATIONS_FILE_KEY_PREFIX = exports.AUTOMATIONS_DISPATCH_URL = exports.AUTOMATIONS_DISPATCH_ROUTE_PATH = exports.AUTOMATION_HYDRATE_PATH = exports.AUTOMATION_HANDLERS_PATH = exports.AUTOMATIONS_PATH = exports.WAIT_NODE_TYPE = exports.BUSINESS_EVENT_TRIGGER = void 0;
+/**
+ * Automations: workflows started by a business event (`event-business-event
+ * { eventType }`, spec §5.2). They never run in a browser; the generated app
+ * runs them itself, off the request path, from a Postgres-backed queue:
+ *
+ * - `lib/automations/event-bus.js` records an event and kicks the queue;
+ * - `lib/automations/dispatcher.js` is the queue worker;
+ * - `lib/automations/registry.js` maps each event type to its handlers;
+ * - `lib/automations/handlers/<slug>-<id8>.js`, one per automation;
+ * - `lib/automations/hydrate/<entity>.js` reads the record an event is about;
+ * - `pages/api/automations/dispatch.js` runs the queue for the app itself;
+ * - `lib/automations/due-check.js` wakes it on the site's activity
+ *   (activity-kicks.ts).
+ *
+ * All of it is generated only when the project has at least one automation.
+ *
+ * Event types only generated routes record: `user-signed-up` and
+ * `user-deleted` (the signup and account-deletion routes, the signup node),
+ * `product-low-stock` (the data API), `waitlist-joined` and
+ * `waitlist-spot-opened` (the waitlist routes). The editor's shared event
+ * writer (teleport-gui `features/shared/builders/record-event-node.ts`, the
+ * one writer a browser can reach) refuses these types, so a row of one of
+ * them was written by the generated app itself. The `user` hydrator relies on
+ * it for `user-deleted`: the account's row is gone before the route records
+ * the event, so the snapshot the route recorded (`payload.user`, naming the
+ * event's own `entity_id`) stands in for the record. Any other event whose
+ * record is missing is refused ("No such <entity>").
+ */
+exports.BUSINESS_EVENT_TRIGGER = 'event-business-event';
+exports.WAIT_NODE_TYPE = 'general-wait';
+exports.AUTOMATIONS_PATH = ['lib', 'automations'];
+exports.AUTOMATION_HANDLERS_PATH = [...exports.AUTOMATIONS_PATH, 'handlers'];
+exports.AUTOMATION_HYDRATE_PATH = [...exports.AUTOMATIONS_PATH, 'hydrate'];
+exports.AUTOMATIONS_DISPATCH_ROUTE_PATH = ['pages', 'api', 'automations'];
+exports.AUTOMATIONS_DISPATCH_URL = '/api/automations/dispatch';
+/** Every generated file's key in the project structure starts with this. */
+exports.AUTOMATIONS_FILE_KEY_PREFIX = 'automations-';
+/** The queue's limits (spec §5.2). */
+exports.AUTOMATION_QUEUE_LIMITS = {
+    /** Events claimed, and Waits resumed, per pass. */
+    batchSize: 20,
+    /** An event is tried at most this many times. */
+    maxAttempts: 5,
+    /** Older events are left alone. */
+    maxAgeDays: 3,
+    /**
+     * How long the dispatcher waits for one handler. A handler still running
+     * then is left running (its delivery stays `running`): it is only taken
+     * over once its claim is stale, never while it may still be at work.
+     */
+    handlerTimeoutMs: 25000,
+    /**
+     * A dispatch starts no handler after this long, and hands back the claims
+     * it did not start, so one call stays inside a serverless time limit.
+     */
+    passDeadlineMs: 50000,
+    /** A claim older than this was left by a run that died, and is taken over. */
+    staleClaimMinutes: 15,
+    /** The dispatch route's time limit on hosts that read it (Vercel). */
+    routeMaxDurationSeconds: 60,
+};
+/**
+ * The platform `waitUntil` the bus uses on Vercel (lib/automations/wait-until.js).
+ * 2.x is the line that still runs on Node 18.
+ */
+exports.VERCEL_FUNCTIONS_DEPENDENCY = { name: '@vercel/functions', version: '^2.2.13' };
+/**
+ * The database the bus opens, from `uidl.automations` (the data source the
+ * editor keeps the automation tables in). Automations run only on the
+ * TeleportHQ-managed database (v1): the platform fills `TELEPORT_DB_*` for
+ * it, and the data API every event writer goes through opens it. Null for
+ * anything else: no bus is generated then.
+ */
+const resolveAutomationsDatabase = (settings) => settings && settings.dataSourceType === 'teleport' ? 'teleport' : null;
+exports.resolveAutomationsDatabase = resolveAutomationsDatabase;
+/** Why a project with automations got no bus (the stub dispatch route answers it). */
+exports.AUTOMATIONS_UNAVAILABLE_REASON = 'no TeleportHQ database holds the automation tables';
+const isAutomationWorkflow = (workflow) => !!workflow && !!workflow.trigger && workflow.trigger.type === exports.BUSINESS_EVENT_TRIGGER;
+exports.isAutomationWorkflow = isAutomationWorkflow;
+/** The event an automation reacts to; empty when the trigger names none. */
+const automationEventType = (workflow) => {
+    const eventType = workflow.trigger.config ? workflow.trigger.config.eventType : undefined;
+    return typeof eventType === 'string' ? eventType.trim() : '';
+};
+exports.automationEventType = automationEventType;
+const collectAutomationWorkflows = (workflows) => Object.values((workflows && workflows.workflows) || {}).filter(exports.isAutomationWorkflow);
+exports.collectAutomationWorkflows = collectAutomationWorkflows;
+/**
+ * Whether the project gets the in-app event bus (`lib/automations/event-bus.js`):
+ * `generateAutomationFiles` writes it for the automations that name their
+ * event. The routes that record or wake business events (signup, account
+ * deletion, the data API) carry that code only then, so a project without
+ * automations keeps them byte for byte. Takes the project's workflows, or the
+ * automations `collectAutomationWorkflows` already found.
+ */
+const hasAutomationEventBus = (workflows) => {
+    const automations = Array.isArray(workflows)
+        ? workflows.filter(exports.isAutomationWorkflow)
+        : (0, exports.collectAutomationWorkflows)(workflows);
+    return automations.some((workflow) => (0, exports.automationEventType)(workflow) !== '');
+};
+exports.hasAutomationEventBus = hasAutomationEventBus;
+/**
+ * Whether the generated app has the in-app event bus: an automation that names
+ * its event (`hasAutomationEventBus`) and a database the queue runs on
+ * (`resolveAutomationsDatabase`). The one gate of every plugin whose routes
+ * record or wake business events, so those routes, `utils/app-events.js` and
+ * `lib/automations/*` always agree.
+ */
+const hasAutomationsBus = (uidl) => (0, exports.hasAutomationEventBus)(uidl.workflows) && (0, exports.resolveAutomationsDatabase)(uidl.automations) !== null;
+exports.hasAutomationsBus = hasAutomationsBus;
+/**
+ * The envelope key of the record an event type is about — the catalog's
+ * `entity` (teleport-gui `packages/workflow-schema/src/constants/business-events.ts`),
+ * which this package cannot import. Types are named `<area>-<what happened>`,
+ * so the prefix decides, except for the two gift-card events, whose blocks
+ * differ. Null for an event without a known record (a plugin's own events):
+ * its details come from the event's payload alone.
+ */
+const ENTITY_BY_PREFIX = [
+    ['order-', 'order'],
+    ['subscription-', 'subscription'],
+    ['booking-', 'booking'],
+    ['invoice-', 'invoice'],
+    ['cart-', 'cart'],
+    ['product-', 'product'],
+    ['user-', 'user'],
+    ['form-', 'form'],
+    ['newsletter-', 'subscriber'],
+    ['review-', 'review'],
+    // The waitlist plugin's events (waitlist-joined, waitlist-spot-opened).
+    ['waitlist-', 'waitlist'],
+];
+const automationEntityOf = (eventType) => {
+    if (eventType === 'gift-card-issued') {
+        return 'giftCards';
+    }
+    if (eventType === 'gift-card-credited') {
+        return 'giftCard';
+    }
+    const match = ENTITY_BY_PREFIX.find(([prefix]) => eventType.startsWith(prefix));
+    return match ? match[1] : null;
+};
+exports.automationEntityOf = automationEntityOf;
+/**
+ * The envelope keys besides `event` and `actor` an event type carries — the
+ * top-level blocks of the catalog's details: the entity, plus what some types
+ * add (a refund, a parcel, the status it moved from). Null for an event the
+ * catalog does not describe (a plugin's own): its payload is kept whole.
+ */
+const EXTRA_ENVELOPE_KEYS = {
+    'order-awaiting-confirmation': ['payment'],
+    'order-late-payment': ['payment'],
+    'order-duplicate-payment': ['payment'],
+    'order-underpaid': ['payment'],
+    'order-refunded': ['refund'],
+    'order-partially-refunded': ['refund'],
+    'order-refund-failed': ['refund'],
+    'order-status-changed': ['from', 'to'],
+    'order-shipment-created': ['shipment'],
+    'order-shipment-updated': ['shipment'],
+    'order-shipment-delivered': ['shipment'],
+    'order-digital-delivered': ['delivery'],
+    'gift-card-issued': ['order'],
+    'gift-card-credited': ['order'],
+    'booking-moved': ['from'],
+};
+const automationEnvelopeKeys = (eventType) => {
+    const entity = (0, exports.automationEntityOf)(eventType);
+    return entity ? [entity, ...(EXTRA_ENVELOPE_KEYS[eventType] || [])] : null;
+};
+exports.automationEnvelopeKeys = automationEnvelopeKeys;
+//# sourceMappingURL=automations-scope.js.map

package/dist/cjs/automations/automations-scope.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"automations-scope.js","sourceRoot":"","sources":["../../../src/automations/automations-scope.ts"],"names":[],"mappings":";;;AAQA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AAEU,QAAA,sBAAsB,GAAG,sBAAsB,CAAA;AAC/C,QAAA,cAAc,GAAG,cAAc,CAAA;AAE/B,QAAA,gBAAgB,GAAG,CAAC,KAAK,EAAE,aAAa,CAAC,CAAA;AACzC,QAAA,wBAAwB,GAAG,CAAC,GAAG,wBAAgB,EAAE,UAAU,CAAC,CAAA;AAC5D,QAAA,uBAAuB,GAAG,CAAC,GAAG,wBAAgB,EAAE,SAAS,CAAC,CAAA;AAC1D,QAAA,+BAA+B,GAAG,CAAC,OAAO,EAAE,KAAK,EAAE,aAAa,CAAC,CAAA;AACjE,QAAA,wBAAwB,GAAG,2BAA2B,CAAA;AAEnE,4EAA4E;AAC/D,QAAA,2BAA2B,GAAG,cAAc,CAAA;AAEzD,sCAAsC;AACzB,QAAA,uBAAuB,GAAG;IACrC,mDAAmD;IACnD,SAAS,EAAE,EAAE;IACb,iDAAiD;IACjD,WAAW,EAAE,CAAC;IACd,mCAAmC;IACnC,UAAU,EAAE,CAAC;IACb;;;;OAIG;IACH,gBAAgB,EAAE,KAAK;IACvB;;;OAGG;IACH,cAAc,EAAE,KAAK;IACrB,8EAA8E;IAC9E,iBAAiB,EAAE,EAAE;IACrB,sEAAsE;IACtE,uBAAuB,EAAE,EAAE;CAC5B,CAAA;AAED;;;GAGG;AACU,QAAA,2BAA2B,GAAG,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,EAAE,SAAS,EAAE,CAAA;AAE5F;;;;;;GAMG;AACI,MAAM,0BAA0B,GAAG,CACxC,QAAoD,EACd,EAAE,CACxC,QAAQ,IAAI,QAAQ,CAAC,cAAc,KAAK,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAA;AAH3D,QAAA,0BAA0B,8BAGiC;AAExE,sFAAsF;AACzE,QAAA,8BAA8B,GAAG,oDAAoD,CAAA;AAE3F,MAAM,oBAAoB,GAAG,CAAC,QAAyC,EAAW,EAAE,CACzF,CAAC,CAAC,QAAQ,IAAI,CAAC,CAAC,QAAQ,CAAC,OAAO,IAAI,QAAQ,CAAC,OAAO,CAAC,IAAI,KAAK,8BAAsB,CAAA;AADzE,QAAA,oBAAoB,wBACqD;AAEtF,4EAA4E;AACrE,MAAM,mBAAmB,GAAG,CAAC,QAAsB,EAAU,EAAE;IACpE,MAAM,SAAS,GAAG,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAA;IACzF,OAAO,OAAO,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAA;AAC9D,CAAC,CAAA;AAHY,QAAA,mBAAmB,uBAG/B;AAEM,MAAM,0BAA0B,GAAG,CAAC,SAAgC,EAAkB,EAAE,CAC7F,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,IAAI,SAAS,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,4BAAoB,CAAC,CAAA;AADzE,QAAA,0BAA0B,8BAC+C;AAEtF;;;;;;;GAOG;AACI,MAAM,qBAAqB,GAAG,CACnC,SAAiD,EACxC,EAAE;IACX,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC;QAC1C,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,4BAAoB,CAAC;QACxC,CAAC,CAAC,IAAA,kCAA0B,EAAC,SAAS,CAAC,CAAA;IACzC,OAAO,WAAW,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,IAAA,2BAAmB,EAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAA;AAC7E,CAAC,CAAA;AAPY,QAAA,qBAAqB,yBAOjC;AAED;;;;;;GAMG;AACI,MAAM,iBAAiB,GAAG,CAAC,IAAoD,EAAW,EAAE,CACjG,IAAA,6BAAqB,EAAC,IAAI,CAAC,SAAS,CAAC,IAAI,IAAA,kCAA0B,EAAC,IAAI,CAAC,WAAW,CAAC,KAAK,IAAI,CAAA;AADnF,QAAA,iBAAiB,qBACkE;AAEhG;;;;;;;GAOG;AACH,MAAM,gBAAgB,GAA4B;IAChD,CAAC,QAAQ,EAAE,OAAO,CAAC;IACnB,CAAC,eAAe,EAAE,cAAc,CAAC;IACjC,CAAC,UAAU,EAAE,SAAS,CAAC;IACvB,CAAC,UAAU,EAAE,SAAS,CAAC;IACvB,CAAC,OAAO,EAAE,MAAM,CAAC;IACjB,CAAC,UAAU,EAAE,SAAS,CAAC;IACvB,CAAC,OAAO,EAAE,MAAM,CAAC;IACjB,CAAC,OAAO,EAAE,MAAM,CAAC;IACjB,CAAC,aAAa,EAAE,YAAY,CAAC;IAC7B,CAAC,SAAS,EAAE,QAAQ,CAAC;IACrB,wEAAwE;IACxE,CAAC,WAAW,EAAE,UAAU,CAAC;CAC1B,CAAA;AAEM,MAAM,kBAAkB,GAAG,CAAC,SAAiB,EAAiB,EAAE;IACrE,IAAI,SAAS,KAAK,kBAAkB,EAAE;QACpC,OAAO,WAAW,CAAA;KACnB;IACD,IAAI,SAAS,KAAK,oBAAoB,EAAE;QACtC,OAAO,UAAU,CAAA;KAClB;IACD,MAAM,KAAK,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAA;IAC/E,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;AAChC,CAAC,CAAA;AATY,QAAA,kBAAkB,sBAS9B;AAED;;;;;GAKG;AACH,MAAM,mBAAmB,GAA6B;IACpD,6BAA6B,EAAE,CAAC,SAAS,CAAC;IAC1C,oBAAoB,EAAE,CAAC,SAAS,CAAC;IACjC,yBAAyB,EAAE,CAAC,SAAS,CAAC;IACtC,iBAAiB,EAAE,CAAC,SAAS,CAAC;IAC9B,gBAAgB,EAAE,CAAC,QAAQ,CAAC;IAC5B,0BAA0B,EAAE,CAAC,QAAQ,CAAC;IACtC,qBAAqB,EAAE,CAAC,QAAQ,CAAC;IACjC,sBAAsB,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC;IACtC,wBAAwB,EAAE,CAAC,UAAU,CAAC;IACtC,wBAAwB,EAAE,CAAC,UAAU,CAAC;IACtC,0BAA0B,EAAE,CAAC,UAAU,CAAC;IACxC,yBAAyB,EAAE,CAAC,UAAU,CAAC;IACvC,kBAAkB,EAAE,CAAC,OAAO,CAAC;IAC7B,oBAAoB,EAAE,CAAC,OAAO,CAAC;IAC/B,eAAe,EAAE,CAAC,MAAM,CAAC;CAC1B,CAAA;AAEM,MAAM,sBAAsB,GAAG,CAAC,SAAiB,EAAmB,EAAE;IAC3E,MAAM,MAAM,GAAG,IAAA,0BAAkB,EAAC,SAAS,CAAC,CAAA;IAC5C,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,GAAG,CAAC,mBAAmB,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;AAC5E,CAAC,CAAA;AAHY,QAAA,sBAAsB,0BAGlC"}

package/dist/cjs/automations/dispatcher-source.d.ts

@@ -0,0 +1,72 @@
+export declare const staleEventSql: (workflowIds: string) => string;
+/**
+ * The events a pass takes besides the new ones: a failed one, and a stale
+ * `pending` one (below the attempt limit, of an automation that is on; or
+ * past it, only to be settled).
+ */
+export declare const retriableEventsSql: (eventTypes: string, workflowIds: string) => string;
+/**
+ * The Waits a pass resumes: due ones of an automation that is on (a
+ * switched-off one's stay parked), and those whose resume was left running
+ * for longer than the stale window.
+ */
+export declare const dueWaitsSql: (workflowIds: string) => string;
+/**
+ * The delivery guarantee, worded for the editor's History drawer:
+ *
+ * Every automation runs at least once for each event of its type recorded
+ * while it is on, and normally exactly once. A run that fails is retried the
+ * next time the site is active, up to 5 attempts per event. A run that is
+ * still going after 25 seconds is left to finish; if it never reports back
+ * (its server stopped), it is run again 15 minutes later — so an automation
+ * that is slow or interrupted can run twice for the same event. A run that
+ * fails after a Wait is retried from the step after that Wait. A new event is
+ * picked up within 3 days; a Wait resumes the next time the site is active
+ * after its time has passed.
+ */
+export declare const AUTOMATION_DELIVERY_GUARANTEE: string;
+/**
+ * `lib/automations/dispatcher.js`. `entityByType` maps every event type of
+ * the registry to its envelope key, `envelopeKeysByType` to its catalog blocks
+ * (null: keep the payload whole); `hydratedEntities` are the entities a
+ * `hydrate/<entity>.js` module was generated for.
+ */
+export declare const generateAutomationDispatcherCode: (options: {
+    entityByType: Record<string, string | null>;
+    envelopeKeysByType: Record<string, string[] | null>;
+    hydratedEntities: string[];
+}) => string;
+/**
+ * `pages/api/automations/dispatch.js`: POST, for this app's own server code
+ * (the app secret in `x-internal-data-secret`) or a signed request (the cron
+ * signature, see cron-request-verification.ts). Runs the queue and answers
+ * `{ claimed, delivered, failed, resumed }`.
+ *
+ * `{ test: true, workflowId, event }` runs that one automation once instead
+ * and answers the same, plus `wouldWait` when the test met a Wait. A test acts
+ * on what its body says, so it is taken only from a signed request whose
+ * signature covers the body (`x-teleport-body-sha256`): 400 "Unsigned body"
+ * otherwise, and 400 naming what is missing when `workflowId` or `event` is.
+ * The route reads its body itself (`bodyParser: false`) to hash exactly what
+ * was sent. A request that presents none of the credentials is refused (401)
+ * before a byte of its body is read, unless the site allows unsigned calls (a
+ * local run, `TELEPORT_CRON_ALLOW_UNSIGNED`); a body over 64 KB is refused
+ * (413) without reading past it.
+ *
+ * A signed request is taken once: its execution id, bound into the signature,
+ * is remembered (`takeSignedRequest`, table `teleport_automation_requests`)
+ * for as long as that signature could still verify, and the same request
+ * again is refused (409) before anything runs. A captured request cannot run
+ * an automation a second time. When the database cannot say whether it was
+ * seen, the request is refused (503). The app's own calls (the app secret)
+ * name no execution and are never remembered.
+ */
+export declare const generateAutomationDispatchRouteCode: () => string;
+/**
+ * `pages/api/automations/dispatch.js` for a project whose automations cannot
+ * run (no bus was generated, see generateAutomationFiles): every request is
+ * answered 503 with the reason, so the editor's test-event proxy shows the
+ * owner that sentence instead of a missing page.
+ */
+export declare const generateAutomationsUnavailableRouteCode: (reason: string) => string;
+//# sourceMappingURL=dispatcher-source.d.ts.map

package/dist/cjs/automations/dispatcher-source.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dispatcher-source.d.ts","sourceRoot":"","sources":["../../../src/automations/dispatcher-source.ts"],"names":[],"mappings":"AA0CA,eAAO,MAAM,aAAa,gBAAiB,MAAM,KAAG,MAMqD,CAAA;AASzG;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,eAAgB,MAAM,eAAe,MAAM,KAAG,MAKoB,CAAA;AAEjG;;;;GAIG;AACH,eAAO,MAAM,WAAW,gBAAiB,MAAM,KAAG,MAIqD,CAAA;AAkKvG;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,6BAA6B,QAM4E,CAAA;AAEtH;;;;;GAKG;AACH,eAAO,MAAM,gCAAgC,YAAa;IACxD,YAAY,EAAE,OAAO,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,CAAA;IAC3C,kBAAkB,EAAE,OAAO,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,CAAA;IACnD,gBAAgB,EAAE,MAAM,EAAE,CAAA;CAC3B,KAAG,MAgkBH,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,mCAAmC,QAAO,MAqLtD,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,uCAAuC,WAAY,MAAM,KAAG,MAQxE,CAAA"}