zitejs 0.9.127 → 0.9.128

package/dist/cjs/backend/index.d.ts

@@ -22,6 +22,21 @@ export type ZiteTrigger = {
     label?: string;
     paused?: boolean;
     every?: never;
+    events?: never;
+} | {
+    /**
+     * The connection's name in `zite.config.json`, for a provider whose
+     * webhooks come through Zite's own app (Slack, HubSpot, Notion,
+     * Intercom, QuickBooks). Nothing is registered: the platform routes
+     * that account's events of these types to the endpoint.
+     */
+    integration: string;
+    /** Event names as the platform lists them for the provider, e.g. `message.channels`, `contact.creation`. */
+    events: string[];
+    /** The sentence the editor shows for what fires this endpoint, e.g. "When a message is posted in Slack". */
+    label?: string;
+    paused?: boolean;
+    every?: never;
 } | {
     /** `<n>m` (1–59) or `<n>h` (1–23). What makes the trigger a poll. */
     every: string;
@@ -30,6 +45,7 @@ export type ZiteTrigger = {
     /** The sentence the editor shows for this poll, e.g. "Every 10 minutes, new Stripe charges". */
     label?: string;
     paused?: boolean;
+    events?: never;
 };
 /**
  * What a provider trigger's `subscribe` export receives. Write it as
@@ -97,6 +113,8 @@ export type ZiteTriggerDelivery = {
     /** Ids earlier deliveries returned as `handled`, newest last. Skip these. */
     seen: string[];
 };
+/** What an app event trigger's run carries as `input.__webhook`: one event, no cursor. */
+export type ZiteAppEventDelivery = Omit<ZiteTriggerDelivery, "cursor" | "seen">;
 /**
  * What a poll-triggered run, or a provider trigger's delivery, returns for
  * the platform to keep: its new `cursor`, and the id of every item it acted
@@ -203,6 +221,10 @@ export interface EndpointConfig<TInput = unknown, TOutput = unknown, TStream ext
             every: string;
         } ? TInput & {
             __poll?: ZitePollInput;
+        } : TTrigger extends {
+            events: string[];
+        } ? TInput & {
+            __webhook?: ZiteAppEventDelivery;
         } : TTrigger extends {
             integration: string;
         } ? TInput & {

package/dist/cjs/backend/index.test.js

@@ -201,6 +201,32 @@ const requestContext = { user: { id: "u1", email: "a@b.c" } };
             context: { user: null },
         })).resolves.toEqual({ cursor: "sync1+1", handled: ["e2"] });
     });
+    (0, vitest_1.it)("types an app event trigger's run as one event, with no cursor to keep", async () => {
+        const endpoint = (0, index_js_1.createEndpoint)({
+            inputSchema: zod_1.z.object({ event: zod_1.z.object({ text: zod_1.z.string() }) }),
+            trigger: { integration: "team-slack", events: ["message.channels"] },
+            execute: async ({ input }) => {
+                // @ts-expect-error an app event delivery has no cursor
+                void input.__webhook?.cursor;
+                return { id: input.__webhook?.deliveryId ?? null };
+            },
+        });
+        await (0, vitest_1.expect)(endpoint.execute({
+            input: {
+                event: { text: "hi" },
+                __webhook: { headers: {}, deliveryId: "slack:Ev1" },
+            },
+            context: { user: null },
+        })).resolves.toEqual({ id: "slack:Ev1" });
+    });
+    (0, vitest_1.it)("refuses events on a trigger that also polls", () => {
+        (0, index_js_1.createEndpoint)({
+            inputSchema: zod_1.z.object({}),
+            // @ts-expect-error a poll can't also take events
+            trigger: { every: "5m", events: ["message.channels"] },
+            execute: async () => ({}),
+        });
+    });
     (0, vitest_1.it)("does not validate a webhook fire", async () => {
         const endpoint = (0, index_js_1.createEndpoint)({
             inputSchema: zod_1.z.object({ token: zod_1.z.string().min(10) }),

package/dist/cjs/bundle/index.js

@@ -592,10 +592,6 @@ ${bodySection}
             },
             minify: false,
             logLevel: 'silent',
-            // A script that imports an endpoint file's named exports (a trigger's
-            // subscribe/unsubscribe) must not carry the endpoint along with them:
-            // unused, its `createEndpoint(...)` and everything `execute` imports go.
-            pure: ['createEndpoint'],
             plugins: [plugin],
         });
         if (result.errors.length > 0) {

package/dist/cjs/sync/lib.js

@@ -1232,10 +1232,13 @@ function generateBackendWrapperTs(envVarNames = []) {
         "// Auto-generated type-narrowing wrapper. Do not edit manually.",
         "// Re-exports createEndpoint with context.user typed to the app User.",
         "",
-        "import type { ZiteRequestContext as _ZiteRequestContext, ZiteScheduledContext, ZiteErrorCode, ZiteSchedule, ZiteStreamInterface, ZiteTrigger, ZiteWebhook } from 'zitejs/backend/base';",
+        "import type { ZiteRequestContext as _ZiteRequestContext, ZiteScheduledContext, ZiteErrorCode, ZiteSchedule, ZiteStreamInterface, ZiteTrigger, ZiteTriggerDelivery, ZiteAppEventDelivery, ZitePollInput, ZiteWebhook } from 'zitejs/backend/base';",
         "import type { User } from 'zitejs/auth';",
         "",
         "export type { ZiteErrorCode, ZiteSchedule, ZiteScheduledContext, ZiteStreamInterface, ZiteTrigger, ZiteWebhook };",
+        // A trigger's registration exports are typed against these, and they
+        // only reach app code through this file.
+        "export type { ZiteAppEventDelivery, ZitePollInput, ZitePollResult, ZiteTriggerDelivery, ZiteTriggerSubscribe, ZiteTriggerSubscribeInput, ZiteTriggerSubscribeResult, ZiteTriggerUnsubscribe, ZiteTriggerUnsubscribeInput } from 'zitejs/backend/base';",
         // The pre-monorepo SDK put this in scope for every endpoint, so migrated
         // code can name it. `createEndpoint` infers the same thing without it.
         "export type InferSchemaType<T> = T extends { _output: infer U } ? U : T;",
@@ -1322,11 +1325,13 @@ function generateBackendWrapperTs(envVarNames = []) {
         "  schedule?: TSchedule;",
         "  /** When set, an inbound webhook can also trigger this endpoint. Like `schedule`, it widens `context` — a webhook fire has no session. */",
         "  webhook?: TWebhook;",
-        "  /** When set, a workspace connection's events (registered by `src/triggers/<endpointId>/subscribe.ts`) or a poll also fire this endpoint. Like `webhook`, it widens `context` — a trigger fire has no session. */",
+        "  /** When set, a connection's events (registered by this file's own `subscribe` export) or a poll (`every`) also fire this endpoint. Like `webhook`, it widens `context` — a trigger fire has no session. */",
         "  trigger?: TTrigger;",
         "  execute: (",
         "    params: {",
-        "      input: TInput;",
+        // Mirrors the base module: a poll's run carries `__poll`, a provider
+        // trigger's delivery `__webhook`.
+        "      input: TTrigger extends { every: string } ? TInput & { __poll?: ZitePollInput } : TTrigger extends { events: string[] } ? TInput & { __webhook?: ZiteAppEventDelivery } : TTrigger extends { integration: string } ? TInput & { __webhook?: ZiteTriggerDelivery } : TInput;",
         "      context: TSchedule extends ZiteSchedule ? ZiteRequestContext | ZiteScheduledContext : TWebhook extends ZiteWebhook ? ZiteRequestContext | ZiteScheduledContext : TTrigger extends ZiteTrigger ? ZiteRequestContext | ZiteScheduledContext : ZiteRequestContext;",
         "    } & (TStream extends true ? { stream: ZiteStreamInterface } : {}),",
         "  ) => Promise<TOutput> | TOutput;",

package/dist/cjs/sync/lib.test.js

@@ -387,6 +387,14 @@ const duplicateIdentifierErrorsIn = (source) => {
         (0, vitest_1.expect)(output).toContain('TTrigger extends ZiteTrigger | undefined = undefined');
         (0, vitest_1.expect)(output).toContain('ZiteTrigger, ZiteWebhook }');
     });
+    (0, vitest_1.it)('passes the trigger registration types and trigger inputs through to app code', () => {
+        (0, vitest_1.expect)(output).toContain('ZiteTriggerSubscribe, ZiteTriggerSubscribeInput');
+        (0, vitest_1.expect)(output).toContain('ZiteTriggerUnsubscribe, ZiteTriggerUnsubscribeInput');
+        (0, vitest_1.expect)(output).toContain("TTrigger extends { every: string } ? TInput & { __poll?: ZitePollInput }");
+        (0, vitest_1.expect)(output).toContain('TInput & { __webhook?: ZiteTriggerDelivery }');
+        (0, vitest_1.expect)(output).toContain("TTrigger extends { events: string[] } ? TInput & { __webhook?: ZiteAppEventDelivery }");
+        (0, vitest_1.expect)(output).not.toContain('src/triggers/');
+    });
     (0, vitest_1.it)('exports ZiteError', () => {
         (0, vitest_1.expect)(output).toContain('ZiteError');
     });

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

@@ -22,6 +22,21 @@ export type ZiteTrigger = {
     label?: string;
     paused?: boolean;
     every?: never;
+    events?: never;
+} | {
+    /**
+     * The connection's name in `zite.config.json`, for a provider whose
+     * webhooks come through Zite's own app (Slack, HubSpot, Notion,
+     * Intercom, QuickBooks). Nothing is registered: the platform routes
+     * that account's events of these types to the endpoint.
+     */
+    integration: string;
+    /** Event names as the platform lists them for the provider, e.g. `message.channels`, `contact.creation`. */
+    events: string[];
+    /** The sentence the editor shows for what fires this endpoint, e.g. "When a message is posted in Slack". */
+    label?: string;
+    paused?: boolean;
+    every?: never;
 } | {
     /** `<n>m` (1–59) or `<n>h` (1–23). What makes the trigger a poll. */
     every: string;
@@ -30,6 +45,7 @@ export type ZiteTrigger = {
     /** The sentence the editor shows for this poll, e.g. "Every 10 minutes, new Stripe charges". */
     label?: string;
     paused?: boolean;
+    events?: never;
 };
 /**
  * What a provider trigger's `subscribe` export receives. Write it as
@@ -97,6 +113,8 @@ export type ZiteTriggerDelivery = {
     /** Ids earlier deliveries returned as `handled`, newest last. Skip these. */
     seen: string[];
 };
+/** What an app event trigger's run carries as `input.__webhook`: one event, no cursor. */
+export type ZiteAppEventDelivery = Omit<ZiteTriggerDelivery, "cursor" | "seen">;
 /**
  * What a poll-triggered run, or a provider trigger's delivery, returns for
  * the platform to keep: its new `cursor`, and the id of every item it acted
@@ -203,6 +221,10 @@ export interface EndpointConfig<TInput = unknown, TOutput = unknown, TStream ext
             every: string;
         } ? TInput & {
             __poll?: ZitePollInput;
+        } : TTrigger extends {
+            events: string[];
+        } ? TInput & {
+            __webhook?: ZiteAppEventDelivery;
         } : TTrigger extends {
             integration: string;
         } ? TInput & {

package/dist/esm/backend/index.test.js

@@ -199,6 +199,32 @@ describe("platform-triggered runs", () => {
             context: { user: null },
         })).resolves.toEqual({ cursor: "sync1+1", handled: ["e2"] });
     });
+    it("types an app event trigger's run as one event, with no cursor to keep", async () => {
+        const endpoint = createEndpoint({
+            inputSchema: z.object({ event: z.object({ text: z.string() }) }),
+            trigger: { integration: "team-slack", events: ["message.channels"] },
+            execute: async ({ input }) => {
+                // @ts-expect-error an app event delivery has no cursor
+                void input.__webhook?.cursor;
+                return { id: input.__webhook?.deliveryId ?? null };
+            },
+        });
+        await expect(endpoint.execute({
+            input: {
+                event: { text: "hi" },
+                __webhook: { headers: {}, deliveryId: "slack:Ev1" },
+            },
+            context: { user: null },
+        })).resolves.toEqual({ id: "slack:Ev1" });
+    });
+    it("refuses events on a trigger that also polls", () => {
+        createEndpoint({
+            inputSchema: z.object({}),
+            // @ts-expect-error a poll can't also take events
+            trigger: { every: "5m", events: ["message.channels"] },
+            execute: async () => ({}),
+        });
+    });
     it("does not validate a webhook fire", async () => {
         const endpoint = createEndpoint({
             inputSchema: z.object({ token: z.string().min(10) }),

package/dist/esm/bundle/index.js

@@ -554,10 +554,6 @@ ${bodySection}
             },
             minify: false,
             logLevel: 'silent',
-            // A script that imports an endpoint file's named exports (a trigger's
-            // subscribe/unsubscribe) must not carry the endpoint along with them:
-            // unused, its `createEndpoint(...)` and everything `execute` imports go.
-            pure: ['createEndpoint'],
             plugins: [plugin],
         });
         if (result.errors.length > 0) {

package/dist/esm/sync/lib.js

@@ -1217,10 +1217,13 @@ export function generateBackendWrapperTs(envVarNames = []) {
         "// Auto-generated type-narrowing wrapper. Do not edit manually.",
         "// Re-exports createEndpoint with context.user typed to the app User.",
         "",
-        "import type { ZiteRequestContext as _ZiteRequestContext, ZiteScheduledContext, ZiteErrorCode, ZiteSchedule, ZiteStreamInterface, ZiteTrigger, ZiteWebhook } from 'zitejs/backend/base';",
+        "import type { ZiteRequestContext as _ZiteRequestContext, ZiteScheduledContext, ZiteErrorCode, ZiteSchedule, ZiteStreamInterface, ZiteTrigger, ZiteTriggerDelivery, ZiteAppEventDelivery, ZitePollInput, ZiteWebhook } from 'zitejs/backend/base';",
         "import type { User } from 'zitejs/auth';",
         "",
         "export type { ZiteErrorCode, ZiteSchedule, ZiteScheduledContext, ZiteStreamInterface, ZiteTrigger, ZiteWebhook };",
+        // A trigger's registration exports are typed against these, and they
+        // only reach app code through this file.
+        "export type { ZiteAppEventDelivery, ZitePollInput, ZitePollResult, ZiteTriggerDelivery, ZiteTriggerSubscribe, ZiteTriggerSubscribeInput, ZiteTriggerSubscribeResult, ZiteTriggerUnsubscribe, ZiteTriggerUnsubscribeInput } from 'zitejs/backend/base';",
         // The pre-monorepo SDK put this in scope for every endpoint, so migrated
         // code can name it. `createEndpoint` infers the same thing without it.
         "export type InferSchemaType<T> = T extends { _output: infer U } ? U : T;",
@@ -1307,11 +1310,13 @@ export function generateBackendWrapperTs(envVarNames = []) {
         "  schedule?: TSchedule;",
         "  /** When set, an inbound webhook can also trigger this endpoint. Like `schedule`, it widens `context` — a webhook fire has no session. */",
         "  webhook?: TWebhook;",
-        "  /** When set, a workspace connection's events (registered by `src/triggers/<endpointId>/subscribe.ts`) or a poll also fire this endpoint. Like `webhook`, it widens `context` — a trigger fire has no session. */",
+        "  /** When set, a connection's events (registered by this file's own `subscribe` export) or a poll (`every`) also fire this endpoint. Like `webhook`, it widens `context` — a trigger fire has no session. */",
         "  trigger?: TTrigger;",
         "  execute: (",
         "    params: {",
-        "      input: TInput;",
+        // Mirrors the base module: a poll's run carries `__poll`, a provider
+        // trigger's delivery `__webhook`.
+        "      input: TTrigger extends { every: string } ? TInput & { __poll?: ZitePollInput } : TTrigger extends { events: string[] } ? TInput & { __webhook?: ZiteAppEventDelivery } : TTrigger extends { integration: string } ? TInput & { __webhook?: ZiteTriggerDelivery } : TInput;",
         "      context: TSchedule extends ZiteSchedule ? ZiteRequestContext | ZiteScheduledContext : TWebhook extends ZiteWebhook ? ZiteRequestContext | ZiteScheduledContext : TTrigger extends ZiteTrigger ? ZiteRequestContext | ZiteScheduledContext : ZiteRequestContext;",
         "    } & (TStream extends true ? { stream: ZiteStreamInterface } : {}),",
         "  ) => Promise<TOutput> | TOutput;",

package/dist/esm/sync/lib.test.js

@@ -382,6 +382,14 @@ describe('generateBackendWrapperTs', () => {
         expect(output).toContain('TTrigger extends ZiteTrigger | undefined = undefined');
         expect(output).toContain('ZiteTrigger, ZiteWebhook }');
     });
+    it('passes the trigger registration types and trigger inputs through to app code', () => {
+        expect(output).toContain('ZiteTriggerSubscribe, ZiteTriggerSubscribeInput');
+        expect(output).toContain('ZiteTriggerUnsubscribe, ZiteTriggerUnsubscribeInput');
+        expect(output).toContain("TTrigger extends { every: string } ? TInput & { __poll?: ZitePollInput }");
+        expect(output).toContain('TInput & { __webhook?: ZiteTriggerDelivery }');
+        expect(output).toContain("TTrigger extends { events: string[] } ? TInput & { __webhook?: ZiteAppEventDelivery }");
+        expect(output).not.toContain('src/triggers/');
+    });
     it('exports ZiteError', () => {
         expect(output).toContain('ZiteError');
     });

package/package.json

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