@notionhq/workers 0.1.0 → 0.2.0

package/dist/worker.d.ts

@@ -7,8 +7,137 @@ import type { Schema } from "./schema.js";
 import type { HandlerOptions, JSONValue } from "./types.js";
 export type { AutomationConfiguration, AutomationEvent, CapabilityContext, OAuthConfiguration, NotionManagedOAuthConfiguration, UserManagedOAuthConfiguration, SyncConfiguration, ToolConfiguration, };
 type Capability = SyncCapability | ToolCapability<any, any> | AutomationCapability | OAuthCapability;
+/**
+ * Configuration for a database that Notion creates and manages on behalf
+ * of the worker. The database is created on first deploy and its schema
+ * is migrated on subsequent deploys.
+ */
+export type ManagedDatabaseConfig<PK extends string, S extends Schema<PK>> = {
+    type: "managed";
+    /**
+     * The title for the database when it is first created in Notion.
+     *
+     * Updating this after the database has been created will not change the
+     * title of the database — users may rename it freely.
+     */
+    initialTitle: string;
+    /**
+     * The property that serves as the primary key for matching records.
+     * Must be a property defined in the schema. The value of this property
+     * should match the `key` field on each sync change.
+     */
+    primaryKeyProperty: PK;
+    /**
+     * The database schema. Notion will migrate the database to match
+     * the given schema on worker deploy.
+     */
+    schema: S;
+};
+/**
+ * Configuration union for all database types.
+ * Currently only `"managed"` is supported.
+ */
+export type DatabaseConfig<PK extends string, S extends Schema<PK>> = ManagedDatabaseConfig<PK, S>;
+/**
+ * An opaque handle returned by `worker.database()`. Pass this to
+ * `worker.sync()` to associate a sync capability with the database.
+ */
+export type DatabaseHandle<PK extends string, S extends Schema<PK>> = {
+    readonly key: string;
+    readonly config: DatabaseConfig<PK, S>;
+};
+/** Internal type-erased alias for storing heterogeneous databases. */
+type RegisteredDatabase = DatabaseHandle<string, Schema<string>>;
+/**
+ * Configuration for a pacer that rate-limits requests to an external API.
+ * If multiple syncs share a pacer, the server apportions the budget evenly.
+ */
+export type PacerConfig = {
+    /** Maximum number of requests allowed per interval. */
+    allowedRequests: number;
+    /** The interval window in milliseconds. */
+    intervalMs: number;
+};
+/**
+ * An opaque handle returned by `worker.pacer()`. Call `handle.wait()`
+ * before each API request to stay under the rate limit.
+ */
+export type PacerHandle = {
+    readonly key: string;
+    readonly config: PacerConfig;
+    /**
+     * Wait until a request can proceed under this pacer's rate limit.
+     *
+     * Call this before **every** API request inside your sync's `execute` function.
+     * The pacer ensures requests are evenly spaced over the interval window.
+     *
+     * @example
+     * ```ts
+     * const apiPacer = worker.pacer("myApi", { allowedRequests: 10, intervalMs: 1000 });
+     *
+     * worker.sync("mySync", {
+     *   database: myDb,
+     *   execute: async () => {
+     *     await apiPacer.wait();
+     *     const data = await fetchFromApi();
+     *     // ...
+     *   },
+     * });
+     * ```
+     */
+    wait(): Promise<void>;
+};
+/**
+ * A pacer declaration as it appears in the manifest.
+ */
+export type PacerDeclaration = {
+    readonly key: string;
+    readonly config: PacerConfig;
+};
+/** A capability entry stripped of its handler, used in the manifest. */
+type CapabilityManifestEntry = Pick<Capability, "_tag" | "key" | "config">;
+/**
+ * The full worker manifest, read by the server at deploy time to discover
+ * databases, pacers, capabilities, and the SDK version.
+ */
+export type WorkerManifest = {
+    readonly sdkVersion: string;
+    readonly databases: readonly RegisteredDatabase[];
+    readonly pacers: readonly PacerDeclaration[];
+    readonly capabilities: readonly CapabilityManifestEntry[];
+};
 export declare class Worker {
     #private;
+    database<PK extends string, S extends Schema<PK>>(key: string, config: DatabaseConfig<PK, S>): DatabaseHandle<PK, S>;
+    /**
+     * Register a pacer for rate-limiting requests to an external API.
+     *
+     * Multiple syncs can share a pacer — the server will apportion the
+     * budget evenly across all syncs that reference it.
+     *
+     * Example:
+     *
+     * ```ts
+     * const jiraPacer = worker.pacer("jira", {
+     *   allowedRequests: 10,
+     *   intervalMs: 1000,
+     * });
+     *
+     * worker.sync("jiraSync", {
+     *   database: tasks,
+     *   execute: async (state, { notion }) => {
+     *     await jiraPacer.wait();
+     *     const data = await fetchFromJira();
+     *     // ...
+     *   },
+     * });
+     * ```
+     *
+     * @param key - The unique key for this pacer.
+     * @param config - The rate limit configuration.
+     * @returns A pacer handle. Call `handle.wait()` before each API request.
+     */
+    pacer(key: string, config: PacerConfig): PacerHandle;
     /**
      * Register a sync capability.
      *
@@ -22,26 +151,29 @@ export declare class Worker {
      * const worker = new Worker();
      * export default worker;
      *
-     * worker.sync("tasksSync", {
-     *   primaryKeyProperty: "Task ID",
+     * const tasks = worker.database("tasks", {
+     *   type: "managed",
+     *   initialTitle: "Tasks",
      *   schema: {
-     *     defaultName: "Tasks",
      *     properties: {
      *       "Task Name": Schema.title(),
-     *       "Task ID": Schema.richText(),
      *       Status: Schema.select([
      *         { name: "Open", color: "default" },
      *         { name: "Done", color: "green" },
      *       ]),
      *     },
      *   },
+     * });
+     *
+     * worker.sync("tasksSync", {
+     *   database: tasks,
      *   execute: async () => {
      *     const changes = [
      *       {
      *         key: "task-1",
+     *         type: "upsert",
      *         properties: {
      *           "Task Name": Builder.title("Write docs"),
-     *           "Task ID": Builder.richText("task-1"),
      *           Status: Builder.select("Open"),
      *         },
      *       },
@@ -159,6 +291,7 @@ export declare class Worker {
      * Get all registered capabilities (for discovery) without their handlers.
      */
     get capabilities(): Pick<Capability, "_tag" | "key" | "config">[];
+    get manifest(): WorkerManifest;
     /**
      * Execute a capability by key.
      *

package/dist/worker.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"worker.d.ts","sourceRoot":"","sources":["../src/worker.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACX,oBAAoB,EACpB,uBAAuB,EACvB,eAAe,EACf,MAAM,8BAA8B,CAAC;AAEtC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AACnE,OAAO,KAAK,EACX,+BAA+B,EAC/B,eAAe,EACf,kBAAkB,EAClB,6BAA6B,EAC7B,MAAM,yBAAyB,CAAC;AAEjC,OAAO,KAAK,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAEhF,OAAO,KAAK,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAEhF,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAG5D,YAAY,EACX,uBAAuB,EACvB,eAAe,EACf,iBAAiB,EACjB,kBAAkB,EAClB,+BAA+B,EAC/B,6BAA6B,EAC7B,iBAAiB,EACjB,iBAAiB,GACjB,CAAC;AAMF,KAAK,UAAU,GACZ,cAAc,GAEd,cAAc,CAAC,GAAG,EAAE,GAAG,CAAC,GACxB,oBAAoB,GACpB,eAAe,CAAC;AAMnB,qBAAa,MAAM;;IAGlB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,IAAI,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,CAAC,EAAE,CAAC,EAAE,OAAO,GAAG,OAAO,EAC9D,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,iBAAiB,CAAC,EAAE,EAAE,CAAC,EAAE,OAAO,CAAC,GACvC,cAAc;IAOjB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,IAAI,CAAC,CAAC,SAAS,SAAS,EAAE,CAAC,SAAS,SAAS,GAAG,SAAS,EACxD,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,GAC7B,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC;IAQvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,UAAU,CACT,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,uBAAuB,GAC7B,oBAAoB;IAOvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IACH,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,GAAG,eAAe;IAO/D;;OAEG;IACH,IAAI,YAAY,IAAI,IAAI,CAAC,UAAU,EAAE,MAAM,GAAG,KAAK,GAAG,QAAQ,CAAC,EAAE,CAMhE;IAED;;;;;;;OAOG;IACG,GAAG,CACR,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,OAAO,EAChB,OAAO,GAAE,cAAmB,GAC1B,OAAO,CAAC,OAAO,CAAC;CAyBnB"}
+{"version":3,"file":"worker.d.ts","sourceRoot":"","sources":["../src/worker.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACX,oBAAoB,EACpB,uBAAuB,EACvB,eAAe,EACf,MAAM,8BAA8B,CAAC;AAEtC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AACnE,OAAO,KAAK,EACX,+BAA+B,EAC/B,eAAe,EACf,kBAAkB,EAClB,6BAA6B,EAC7B,MAAM,yBAAyB,CAAC;AAEjC,OAAO,KAAK,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAEhF,OAAO,KAAK,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAGhF,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAG5D,YAAY,EACX,uBAAuB,EACvB,eAAe,EACf,iBAAiB,EACjB,kBAAkB,EAClB,+BAA+B,EAC/B,6BAA6B,EAC7B,iBAAiB,EACjB,iBAAiB,GACjB,CAAC;AAMF,KAAK,UAAU,GACZ,cAAc,GAEd,cAAc,CAAC,GAAG,EAAE,GAAG,CAAC,GACxB,oBAAoB,GACpB,eAAe,CAAC;AAEnB;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,CAAC,EAAE,CAAC,IAAI;IAC5E,IAAI,EAAE,SAAS,CAAC;IAChB;;;;;OAKG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,kBAAkB,EAAE,EAAE,CAAC;IACvB;;;OAGG;IACH,MAAM,EAAE,CAAC,CAAC;CACV,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,cAAc,CACzB,EAAE,SAAS,MAAM,EACjB,CAAC,SAAS,MAAM,CAAC,EAAE,CAAC,IACjB,qBAAqB,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;AAEjC;;;GAGG;AACH,MAAM,MAAM,cAAc,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,CAAC,EAAE,CAAC,IAAI;IACrE,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;CACvC,CAAC;AAEF,sEAAsE;AACtE,KAAK,kBAAkB,GAAG,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;AAEjE;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG;IACzB,uDAAuD;IACvD,eAAe,EAAE,MAAM,CAAC;IACxB,2CAA2C;IAC3C,UAAU,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG;IACzB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC;IAC7B;;;;;;;;;;;;;;;;;;;OAmBG;IACH,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC9B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC;CAC7B,CAAC;AAEF,wEAAwE;AACxE,KAAK,uBAAuB,GAAG,IAAI,CAAC,UAAU,EAAE,MAAM,GAAG,KAAK,GAAG,QAAQ,CAAC,CAAC;AAE3E;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG;IAC5B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,SAAS,EAAE,SAAS,kBAAkB,EAAE,CAAC;IAClD,QAAQ,CAAC,MAAM,EAAE,SAAS,gBAAgB,EAAE,CAAC;IAC7C,QAAQ,CAAC,YAAY,EAAE,SAAS,uBAAuB,EAAE,CAAC;CAC1D,CAAC;AA0BF,qBAAa,MAAM;;IAKlB,QAAQ,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,CAAC,EAAE,CAAC,EAC/C,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,cAAc,CAAC,EAAE,EAAE,CAAC,CAAC,GAC3B,cAAc,CAAC,EAAE,EAAE,CAAC,CAAC;IAOxB;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,GAAG,WAAW;IAUpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiDG;IACH,IAAI,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,CAAC,EAAE,CAAC,EAAE,OAAO,GAAG,OAAO,EAC9D,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,iBAAiB,CAAC,EAAE,EAAE,CAAC,EAAE,OAAO,CAAC,GACvC,cAAc;IAOjB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,IAAI,CAAC,CAAC,SAAS,SAAS,EAAE,CAAC,SAAS,SAAS,GAAG,SAAS,EACxD,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,GAC7B,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC;IAQvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,UAAU,CACT,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,uBAAuB,GAC7B,oBAAoB;IAOvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IACH,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,GAAG,eAAe;IAO/D;;OAEG;IACH,IAAI,YAAY,IAAI,IAAI,CAAC,UAAU,EAAE,MAAM,GAAG,KAAK,GAAG,QAAQ,CAAC,EAAE,CAMhE;IAED,IAAI,QAAQ,IAAI,cAAc,CAO7B;IAED;;;;;;;OAOG;IACG,GAAG,CACR,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,OAAO,EAChB,OAAO,GAAE,cAAmB,GAC1B,OAAO,CAAC,OAAO,CAAC;CA6BnB"}

package/dist/worker.js

@@ -2,8 +2,63 @@ import { createAutomationCapability } from "./capabilities/automation.js";
 import { createOAuthCapability } from "./capabilities/oauth.js";
 import { createSyncCapability } from "./capabilities/sync.js";
 import { createToolCapability } from "./capabilities/tool.js";
+import { pacerWait } from "./pacer_internal.js";
+import { createRequire } from "node:module";
+const SDK_VERSION = (() => {
+  const require2 = createRequire(import.meta.url);
+  const packageJson = require2("../package.json");
+  if (typeof packageJson !== "object" || packageJson === null || !("version" in packageJson) || typeof packageJson.version !== "string") {
+    throw new Error("Failed to read SDK version from package.json");
+  }
+  return packageJson.version;
+})();
 class Worker {
   #capabilities = /* @__PURE__ */ new Map();
+  #databases = /* @__PURE__ */ new Map();
+  #pacers = /* @__PURE__ */ new Map();
+  database(key, config) {
+    this.#validateUniqueKey(key);
+    const database = { key, config };
+    this.#databases.set(key, { key, config });
+    return database;
+  }
+  /**
+   * Register a pacer for rate-limiting requests to an external API.
+   *
+   * Multiple syncs can share a pacer — the server will apportion the
+   * budget evenly across all syncs that reference it.
+   *
+   * Example:
+   *
+   * ```ts
+   * const jiraPacer = worker.pacer("jira", {
+   *   allowedRequests: 10,
+   *   intervalMs: 1000,
+   * });
+   *
+   * worker.sync("jiraSync", {
+   *   database: tasks,
+   *   execute: async (state, { notion }) => {
+   *     await jiraPacer.wait();
+   *     const data = await fetchFromJira();
+   *     // ...
+   *   },
+   * });
+   * ```
+   *
+   * @param key - The unique key for this pacer.
+   * @param config - The rate limit configuration.
+   * @returns A pacer handle. Call `handle.wait()` before each API request.
+   */
+  pacer(key, config) {
+    this.#validateUniqueKey(key);
+    this.#pacers.set(key, { key, config });
+    return {
+      key,
+      config,
+      wait: () => pacerWait(key)
+    };
+  }
   /**
    * Register a sync capability.
    *
@@ -17,26 +72,29 @@ class Worker {
    * const worker = new Worker();
    * export default worker;
    *
-   * worker.sync("tasksSync", {
-   *   primaryKeyProperty: "Task ID",
+   * const tasks = worker.database("tasks", {
+   *   type: "managed",
+   *   initialTitle: "Tasks",
    *   schema: {
-   *     defaultName: "Tasks",
    *     properties: {
    *       "Task Name": Schema.title(),
-   *       "Task ID": Schema.richText(),
    *       Status: Schema.select([
    *         { name: "Open", color: "default" },
    *         { name: "Done", color: "green" },
    *       ]),
    *     },
    *   },
+   * });
+   *
+   * worker.sync("tasksSync", {
+   *   database: tasks,
    *   execute: async () => {
    *     const changes = [
    *       {
    *         key: "task-1",
+   *         type: "upsert",
    *         properties: {
    *           "Task Name": Builder.title("Write docs"),
-   *           "Task ID": Builder.richText("task-1"),
    *           Status: Builder.select("Open"),
    *         },
    *       },
@@ -180,6 +238,14 @@ class Worker {
       config: c.config
     }));
   }
+  get manifest() {
+    return {
+      sdkVersion: SDK_VERSION,
+      databases: Array.from(this.#databases.values()),
+      pacers: Array.from(this.#pacers.values()),
+      capabilities: this.capabilities
+    };
+  }
   /**
    * Execute a capability by key.
    *
@@ -204,8 +270,8 @@ class Worker {
     if (!key || typeof key !== "string") {
       throw new Error("Capability key must be a non-empty string");
     }
-    if (this.#capabilities.has(key)) {
-      throw new Error(`Capability with key "${key}" already registered`);
+    if (this.#capabilities.has(key) || this.#databases.has(key) || this.#pacers.has(key)) {
+      throw new Error(`Worker item with key "${key}" already registered`);
     }
   }
 }

package/dist/worker.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=worker.test.d.ts.map

package/dist/worker.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"worker.test.d.ts","sourceRoot":"","sources":["../src/worker.test.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@notionhq/workers",
-	"version": "0.1.0",
+	"version": "0.2.0",
 	"description": "An SDK for building workers for the Notion Workers platform",
 	"license": "MIT",
 	"type": "module",
@@ -32,6 +32,10 @@
 		"./types": {
 			"types": "./dist/types.d.ts",
 			"default": "./dist/types.js"
+		},
+		"./pacer": {
+			"types": "./dist/pacer.d.ts",
+			"default": "./dist/pacer.js"
 		}
 	},
 	"engines": {
@@ -69,6 +73,7 @@
 		"@notionhq/client": "^2.2.15"
 	},
 	"dependencies": {
-		"ajv": "^8.17.1"
+		"ajv": "^8.17.1",
+		"ajv-formats": "^3.0.1"
 	}
 }

package/src/ajv-formats.d.ts

@@ -0,0 +1,7 @@
+// ajv-formats is CJS-only and doesn't ship types compatible with
+// moduleResolution: "nodenext". This declaration provides the correct
+// callable default export signature so we can import it without suppression.
+declare module "ajv-formats" {
+	import type { Ajv } from "ajv";
+	export default function addFormats(ajv: Ajv): Ajv;
+}

package/src/capabilities/automation.test.ts

@@ -59,7 +59,7 @@ describe("createAutomationCapability", () => {
 			}),
 		);
 		expect(stdoutSpy).toHaveBeenCalledWith(
-			`\n<output>{"_tag":"success","value":{"status":"success"}}</output>\n`,
+			`\n<__notion_output__>{"_tag":"success","value":{"status":"success"}}</__notion_output__>\n`,
 		);
 	});
 
@@ -105,7 +105,7 @@ describe("createAutomationCapability", () => {
 			}),
 		);
 		expect(stdoutSpy).toHaveBeenCalledWith(
-			`\n<output>{"_tag":"success","value":{"status":"success"}}</output>\n`,
+			`\n<__notion_output__>{"_tag":"success","value":{"status":"success"}}</__notion_output__>\n`,
 		);
 	});
 

package/src/capabilities/automation.ts

@@ -111,7 +111,7 @@ export function createAutomationCapability(
 					return { status: "success" };
 				} else {
 					process.stdout.write(
-						`\n<output>${JSON.stringify({ _tag: "success", value: { status: "success" } })}</output>\n`,
+						`\n<__notion_output__>${JSON.stringify({ _tag: "success", value: { status: "success" } })}</__notion_output__>\n`,
 					);
 				}
 			} catch (err) {
@@ -119,7 +119,7 @@ export function createAutomationCapability(
 
 				if (!options?.concreteOutput) {
 					process.stdout.write(
-						`\n<output>${JSON.stringify({ _tag: "error", error: { name: error.name, message: error.message, trace: error.stack } })}</output>\n`,
+						`\n<__notion_output__>${JSON.stringify({ _tag: "error", error: { name: error.name, message: error.message, trace: error.stack } })}</__notion_output__>\n`,
 					);
 				}
 

package/src/capabilities/sync.test.ts

@@ -10,6 +10,7 @@ import {
 import * as Builder from "../builder.js";
 import { ExecutionError } from "../error.js";
 import * as Schema from "../schema.js";
+import { Worker } from "../worker.js";
 import { createSyncCapability } from "./sync.js";
 
 describe("Worker.sync", () => {
@@ -35,29 +36,6 @@ describe("Worker.sync", () => {
 				config: { twoWay: false },
 			});
 		});
-
-		it("can be used in a schema definition", () => {
-			const capability = createSyncCapability("tasksSync", {
-				primaryKeyProperty: "Task ID",
-				schema: {
-					defaultName: "Tasks",
-					properties: {
-						"Task ID": Schema.title(),
-						Project: Schema.relation("projectsSync"),
-					},
-				},
-				execute: async () => ({
-					changes: [],
-					hasMore: false,
-				}),
-			});
-
-			expect(capability.config.schema.properties.Project).toEqual({
-				type: "relation",
-				relatedSyncKey: "projectsSync",
-				config: { twoWay: false },
-			});
-		});
 	});
 
 	describe("Builder.relation", () => {
@@ -82,15 +60,21 @@ describe("Worker.sync", () => {
 
 	describe("SyncedObject with relation properties", () => {
 		it("allows relation values in synced objects", async () => {
-			const capability = createSyncCapability("tasksSync", {
+			const worker = new Worker();
+			const tasks = worker.database("tasks", {
+				type: "managed",
+				initialTitle: "Tasks",
 				primaryKeyProperty: "Task ID",
 				schema: {
-					defaultName: "Tasks",
 					properties: {
 						"Task ID": Schema.title(),
 						Project: Schema.relation("projectsSync"),
 					},
 				},
+			});
+
+			const capability = createSyncCapability("tasksSync", {
+				database: tasks,
 				execute: async () => ({
 					changes: [
 						{
@@ -117,22 +101,27 @@ describe("Worker.sync", () => {
 				}),
 			});
 
-			// Verify the capability is properly configured
 			expect(capability._tag).toBe("sync");
-			expect(capability.config.primaryKeyProperty).toBe("Task ID");
+			expect(capability.config.databaseKey).toBe("tasks");
 		});
 	});
 
 	describe("handler output envelope", () => {
 		it("wraps successful result in success envelope", async () => {
-			const capability = createSyncCapability("testSync", {
+			const worker = new Worker();
+			const db = worker.database("test", {
+				type: "managed",
+				initialTitle: "Test",
 				primaryKeyProperty: "ID",
 				schema: {
-					defaultName: "Test",
 					properties: {
 						ID: Schema.title(),
 					},
 				},
+			});
+
+			const capability = createSyncCapability("testSync", {
+				database: db,
 				execute: async () => ({
 					changes: [],
 					hasMore: false,
@@ -142,19 +131,25 @@ describe("Worker.sync", () => {
 			await capability.handler();
 
 			expect(stdoutSpy).toHaveBeenCalledWith(
-				`\n<output>${JSON.stringify({ _tag: "success", value: { changes: [], hasMore: false, nextUserContext: undefined } })}</output>\n`,
+				`\n<__notion_output__>${JSON.stringify({ _tag: "success", value: { changes: [], hasMore: false, nextUserContext: undefined, nextPacerStates: {} } })}</__notion_output__>\n`,
 			);
 		});
 
 		it("wraps error in error envelope", async () => {
-			const capability = createSyncCapability("errorSync", {
+			const worker = new Worker();
+			const db = worker.database("test", {
+				type: "managed",
+				initialTitle: "Test",
 				primaryKeyProperty: "ID",
 				schema: {
-					defaultName: "Test",
 					properties: {
 						ID: Schema.title(),
 					},
 				},
+			});
+
+			const capability = createSyncCapability("errorSync", {
+				database: db,
 				execute: async () => {
 					throw new Error("sync failed");
 				},
@@ -169,5 +164,67 @@ describe("Worker.sync", () => {
 				expect.stringContaining(`"name":"ExecutionError"`),
 			);
 		});
+
+		it("emits sync output with key and default targetDatabaseKey", async () => {
+			const worker = new Worker();
+			const tasks = worker.database("tasks", {
+				type: "managed",
+				initialTitle: "Tasks",
+				primaryKeyProperty: "Name",
+				schema: {
+					properties: {
+						Name: Schema.title(),
+					},
+				},
+			});
+
+			const capability = createSyncCapability("tasksSync", {
+				database: tasks,
+				execute: async () => ({
+					changes: [
+						{
+							type: "upsert" as const,
+							key: "task-1",
+							properties: {
+								Name: Builder.title("Write docs"),
+							},
+						},
+						{
+							type: "delete" as const,
+							key: "task-2",
+						},
+					],
+					hasMore: false,
+				}),
+			});
+
+			await capability.handler();
+
+			expect(stdoutSpy).toHaveBeenCalledWith(
+				`\n<__notion_output__>${JSON.stringify({
+					_tag: "success",
+					value: {
+						changes: [
+							{
+								type: "upsert",
+								key: "task-1",
+								properties: {
+									Name: Builder.title("Write docs"),
+								},
+								targetDatabaseKey: "tasks",
+							},
+							{
+								type: "delete",
+								key: "task-2",
+								targetDatabaseKey: "tasks",
+							},
+						],
+						hasMore: false,
+						nextUserContext: undefined,
+						nextPacerStates: {},
+					},
+				})}</__notion_output__>\n`,
+			);
+		});
 	});
 });