zitejs 0.10.0-start.5 → 0.10.0-start.6

package/dist/esm/start/describe.d.ts

@@ -1,3 +1,4 @@
+import type { ZiteTrigger } from "../backend/index.js";
 import type { LoadedWorkflow } from "./workflowRun.js";
 import type { WorkflowConfig } from "./workflow.js";
 export type Access = {
@@ -26,7 +27,13 @@ export type DescribedWorkflow = {
     file: string;
     description?: string;
     schedule?: WorkflowConfig["schedule"];
-    trigger?: WorkflowConfig["trigger"];
+    /** As declared, without a provider trigger's `subscribe` and `unsubscribe`. */
+    trigger?: ZiteTrigger;
+    /** A provider trigger's: whether it can be taken down, and a hash of both functions' code, so publish registers it again when they change. */
+    registration?: {
+        unsubscribe: boolean;
+        hash: string;
+    };
     problems: string[];
 };
 export type Description = {

package/dist/esm/start/describe.js

@@ -123,6 +123,19 @@ export function describeRoutes(routesById) {
     }
     return out;
 }
+// cyrb53: enough to tell when the code changed, which is all publish asks.
+const sourceHash = (text) => {
+    let h1 = 0xdeadbeef;
+    let h2 = 0x41c6ce57;
+    for (let i = 0; i < text.length; i++) {
+        const ch = text.charCodeAt(i);
+        h1 = Math.imul(h1 ^ ch, 2654435761);
+        h2 = Math.imul(h2 ^ ch, 1597334677);
+    }
+    h1 = Math.imul(h1 ^ (h1 >>> 16), 2246822507) ^ Math.imul(h2 ^ (h2 >>> 13), 3266489909);
+    h2 = Math.imul(h2 ^ (h2 >>> 16), 2246822507) ^ Math.imul(h1 ^ (h1 >>> 13), 3266489909);
+    return (4294967296 * (2097151 & h2) + (h1 >>> 0)).toString(16).padStart(14, "0");
+};
 // A workflow's id is its export name: what the host invokes it by and the editor shows.
 export function describeWorkflows(workflows) {
     return workflows.map(({ id, file, workflow }) => {
@@ -133,7 +146,21 @@ export function describeWorkflows(workflows) {
         if (elsewhere)
             problems.push(`duplicate-workflow: ${id} is also exported from ${elsewhere.file}`);
         const { description, schedule, trigger } = workflow.config;
-        return { id, file, description, ...(schedule ? { schedule } : { trigger }), problems };
+        if (schedule)
+            return { id, file, description, schedule, problems };
+        if (!trigger || trigger.every !== undefined || trigger.events !== undefined) {
+            return { id, file, description, trigger, problems };
+        }
+        const { subscribe, unsubscribe, ...declared } = trigger;
+        if (typeof subscribe !== "function") {
+            problems.push("workflow-trigger-unregistered: a provider trigger needs `subscribe` to register it with the provider");
+            return { id, file, description, trigger: declared, problems };
+        }
+        const registration = {
+            unsubscribe: typeof unsubscribe === "function",
+            hash: sourceHash(`${String(subscribe)}\n${typeof unsubscribe === "function" ? String(unsubscribe) : ""}`),
+        };
+        return { id, file, description, trigger: declared, registration, problems };
     });
 }
 export async function describeApp(opts) {

package/dist/esm/start/index.d.ts

@@ -1,9 +1,9 @@
 import type { User } from "./types.js";
 export type { User, ZiteRequestContext } from "./types.js";
 export { createZiteRouter, type ZiteRouterContext } from "./router.js";
-export { createWorkflow, type Workflow, type WorkflowArgs, type WorkflowConfig } from "./workflow.js";
+export { createWorkflow, type StartProviderTrigger, type StartTrigger, type Workflow, type WorkflowArgs, type WorkflowConfig, } from "./workflow.js";
 export type { ZiteSchedule } from "../schedules/index.js";
-export type { ZiteTrigger } from "../backend/index.js";
+export type { ZiteTrigger, ZiteTriggerSubscribe, ZiteTriggerSubscribeInput, ZiteTriggerSubscribeResult, ZiteTriggerUnsubscribe, ZiteTriggerUnsubscribeInput, } from "../backend/index.js";
 declare module "@tanstack/start-client-core" {
     interface ServerFnOptions {
         /** What this function does, in a sentence. Shown in the editor. */

package/dist/esm/start/index.js

@@ -4,7 +4,7 @@ import { USAGE_TOKEN_QUERY_PARAM } from "../auth/constants.js";
 import { currentHost } from "./host.js";
 import { getHost, inScope, runInScope } from "./scope.js";
 export { createZiteRouter } from "./router.js";
-export { createWorkflow } from "./workflow.js";
+export { createWorkflow, } from "./workflow.js";
 const STATUS = {
     BAD_REQUEST: 400,
     INVALID_INPUT: 400,

package/dist/esm/start/registration.d.ts

@@ -0,0 +1,13 @@
+import type { LoadedWorkflow } from "./workflowRun.js";
+export type RegistrationResult = {
+    ok: true;
+    output: unknown;
+} | {
+    ok: false;
+    error: {
+        code: string;
+        message: string;
+    };
+};
+/** Undefined when the workflow has no such function. */
+export declare function runRegistration(workflows: LoadedWorkflow[], name: string, op: unknown, input: unknown): Promise<RegistrationResult | undefined>;

package/dist/esm/start/registration.js

@@ -0,0 +1,21 @@
+// Server-only: a provider trigger's `subscribe` or `unsubscribe`, which the host
+// runs at publish. Not a run: nothing is logged, since what `subscribe` returns
+// carries the provider's signing secret.
+import { errorOf } from "./runLog.js";
+import { runInScope } from "./scope.js";
+/** Undefined when the workflow has no such function. */
+export async function runRegistration(workflows, name, op, input) {
+    const trigger = workflows.find((w) => w.id === name)?.workflow.config.trigger;
+    if (!trigger || !("subscribe" in trigger))
+        return undefined;
+    const fn = op === "subscribe" ? trigger.subscribe : op === "unsubscribe" ? trigger.unsubscribe : undefined;
+    if (typeof fn !== "function")
+        return undefined;
+    try {
+        const output = await runInScope({ kind: "workflow", user: null }, () => fn(input));
+        return { ok: true, output: output ?? null };
+    }
+    catch (error) {
+        return { ok: false, error: errorOf(error) };
+    }
+}

package/dist/esm/start/server.js

@@ -1,5 +1,6 @@
 import { ZiteError, ZITE_ERROR_STATUS } from "./index.js";
 import { describeApp } from "./describe.js";
+import { runRegistration } from "./registration.js";
 import { preview } from "./runLog.js";
 import { getHost, requireScope, runWithHost } from "./scope.js";
 import { loadWorkflows, loggedInput, runWorkflow } from "./workflowRun.js";
@@ -52,7 +53,7 @@ const watchOutboundFetches = () => {
     };
 };
 const decodeUser = (value) => JSON.parse(new TextDecoder().decode(Uint8Array.from(atob(value.replace(/-/g, "+").replace(/_/g, "/")), (c) => c.charCodeAt(0))));
-const INVOKE_KINDS = new Set(["webhook", "describe", "workflow", "warm"]);
+const INVOKE_KINDS = new Set(["webhook", "describe", "workflow", "register", "warm"]);
 /** What the host dispatched this request with. Headers are ignored: props are the only thing it alone can set. */
 export function hostContextFromProps(request, props) {
     return {
@@ -129,6 +130,19 @@ async function invokeWorkflow(request, host, workflows) {
     });
     return Response.json(result, { status: result.ok ? 200 : 500 });
 }
+// The host sends `{ op, input }`: `subscribe` with the platform's notification
+// URL and secret, or `unsubscribe` with what `subscribe` returned.
+async function invokeRegistration(request, host, workflows) {
+    if (request.method !== "POST" || new URL(request.url).pathname !== INVOKE_PATH)
+        return new Response("Not found", { status: 404 });
+    const name = host.invoke?.name ?? "";
+    const body = (await request.json().catch(() => null));
+    const result = await runRegistration(workflows, name, body?.op, body?.input);
+    if (!result) {
+        return Response.json({ ok: false, error: { code: "NOT_FOUND", message: `${name} has no ${String(body?.op)}` } }, { status: 404 });
+    }
+    return Response.json(result, { status: result.ok ? 200 : 500 });
+}
 const isZiteError = (error) => error instanceof Error && error.name === "ZiteError" && error.code in ZITE_ERROR_STATUS;
 // TanStack renders any loader error as a 500. A page refused with a ZiteError
 // (a missing role, a record that isn't there) answers with that error's status.
@@ -167,7 +181,11 @@ export function createZiteHandlers(options) {
                 workflows: await loadedWorkflows(),
             }));
         }
-        let response = await runWithHost(host, async () => host.invoke?.kind === "workflow" ? invokeWorkflow(request, host, await loadedWorkflows()) : options.handler.fetch(request));
+        let response = await runWithHost(host, async () => host.invoke?.kind === "workflow"
+            ? invokeWorkflow(request, host, await loadedWorkflows())
+            : host.invoke?.kind === "register"
+                ? invokeRegistration(request, host, await loadedWorkflows())
+                : options.handler.fetch(request));
         const status = response.status === 500 ? pageStatus(host) : undefined;
         if (status)
             response = new Response(response.body, { status, headers: response.headers });

package/dist/esm/start/types.d.ts

@@ -65,7 +65,7 @@ export type PlatformBinding = {
 };
 export type HostMode = "live" | "preview" | "validate";
 export type HostInvoke = {
-    kind: "webhook" | "describe" | "workflow" | "warm";
+    kind: "webhook" | "describe" | "workflow" | "register" | "warm";
     name: string;
 };
 /** The per-request props the host dispatches with. Only the host can set them. */

package/dist/esm/start/workflow.d.ts

@@ -1,6 +1,20 @@
-import type { ZiteTrigger, ZiteTriggerContext } from "../backend/index.js";
+import type { ZiteTrigger, ZiteTriggerContext, ZiteTriggerSubscribe, ZiteTriggerUnsubscribe } from "../backend/index.js";
 import type { ZiteSchedule } from "../schedules/index.js";
 declare const WORKFLOW: unique symbol;
+type ProviderTriggerBase = Extract<ZiteTrigger, {
+    every?: never;
+    events?: never;
+}>;
+/**
+ * A provider trigger, registered with the provider by its `subscribe` when the
+ * app is published and taken down by its `unsubscribe` when it no longer is.
+ * Both run on the platform with only the trigger's own connection.
+ */
+export type StartProviderTrigger = ProviderTriggerBase & {
+    subscribe: ZiteTriggerSubscribe;
+    unsubscribe?: ZiteTriggerUnsubscribe;
+};
+export type StartTrigger = Exclude<ZiteTrigger, ProviderTriggerBase> | StartProviderTrigger;
 export type WorkflowConfig = {
     /** What this workflow does, in a sentence. Shown in the editor. */
     description?: string;
@@ -8,7 +22,7 @@ export type WorkflowConfig = {
     schedule: ZiteSchedule;
     trigger?: never;
 } | {
-    trigger: ZiteTrigger;
+    trigger: StartTrigger;
     schedule?: never;
 });
 /** What a workflow's handler gets. A trigger adds `trigger`, typed by the kind it declares. */

package/dist/esm/start/workflow.test-d.js

@@ -13,10 +13,25 @@ describe("createWorkflow handler args", () => {
         createWorkflow({ trigger: { integration: "slack", events: ["message.channels"] } }).handler(({ trigger }) => {
             expectTypeOf(trigger).toEqualTypeOf();
         });
-        createWorkflow({ trigger: { integration: "asana" } }).handler(({ trigger }) => {
+        createWorkflow({
+            trigger: { integration: "asana", subscribe: async () => ({ externalId: "w1" }), unsubscribe: async () => { } },
+        }).handler(({ trigger }) => {
             expectTypeOf(trigger).toEqualTypeOf();
         });
     });
+    it("registers a provider trigger with subscribe", () => {
+        // @ts-expect-error nothing would register it with the provider
+        createWorkflow({ trigger: { integration: "asana" } });
+        createWorkflow({
+            trigger: {
+                integration: "github",
+                subscribe: (input) => {
+                    expectTypeOf(input.notificationUrl).toEqualTypeOf();
+                    return { externalId: "1", secret: input.secret };
+                },
+            },
+        });
+    });
     it("takes a schedule or a trigger, not both", () => {
         // @ts-expect-error a workflow runs on one or the other
         createWorkflow({ schedule: { scheduleType: "oneTime", fireAt: "x", timezone: "UTC" }, trigger: { every: "5m" } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zitejs",
-  "version": "0.10.0-start.5",
+  "version": "0.10.0-start.6",
   "description": "The Zite framework — build apps on Zite Database",
   "type": "module",
   "sideEffects": false,