@notionhq/workers 0.0.82

package/dist/worker.js

@@ -0,0 +1,219 @@
+import { createAutomationCapability } from "./capabilities/automation.js";
+import { createOAuthCapability } from "./capabilities/oauth.js";
+import { createSyncCapability } from "./capabilities/sync.js";
+import { createToolCapability } from "./capabilities/tool.js";
+class Worker {
+  #capabilities = /* @__PURE__ */ new Map();
+  /**
+   * Register a sync capability.
+   *
+   * Example:
+   *
+   * ```ts
+   * import { Worker } from "@notionhq/workers-sdk";
+   * import * as Builder from "@notionhq/workers-sdk/builder";
+   * import * as Schema from "@notionhq/workers-sdk/schema";
+   *
+   * const worker = new Worker();
+   * export default worker;
+   *
+   * worker.sync("tasksSync", {
+   *   primaryKeyProperty: "Task ID",
+   *   schema: {
+   *     defaultName: "Tasks",
+   *     properties: {
+   *       "Task Name": Schema.title(),
+   *       "Task ID": Schema.richText(),
+   *       Status: Schema.select([
+   *         { name: "Open", color: "default" },
+   *         { name: "Done", color: "green" },
+   *       ]),
+   *     },
+   *   },
+   *   execute: async () => {
+   *     const changes = [
+   *       {
+   *         key: "task-1",
+   *         properties: {
+   *           "Task Name": Builder.title("Write docs"),
+   *           "Task ID": Builder.richText("task-1"),
+   *           Status: Builder.select("Open"),
+   *         },
+   *       },
+   *     ];
+   *
+   *     return { changes, hasMore: false };
+   *   },
+   * });
+   * ```
+   *
+   * @param key - The unique key for this capability.
+   * @param config - The sync configuration.
+   * @returns The capability object.
+   */
+  sync(key, config) {
+    this.#validateUniqueKey(key);
+    const capability = createSyncCapability(key, config);
+    this.#capabilities.set(key, capability);
+    return capability;
+  }
+  /**
+   * Register a tool capability.
+   *
+   * Example:
+   *
+   * ```ts
+   * worker.tool<{ name: string }, string>("sayHello", {
+   *   title: "Say Hello",
+   *   description: "Say hello to the user",
+   *   schema: {
+   *     type: "object",
+   *     properties: {
+   *       name: { type: "string" },
+   *     },
+   *     required: ["name"],
+   *   },
+   *   execute: ({ name }, { notion }) => {
+   *     return `Hello, ${name}!`;
+   *   },
+   * })
+   * ```
+   *
+   *
+   * @param key - The unique key for this capability.
+   * @param config - The tool configuration.
+   * @returns The capability object.
+   */
+  tool(key, config) {
+    this.#validateUniqueKey(key);
+    const capability = createToolCapability(key, config);
+    this.#capabilities.set(key, capability);
+    return capability;
+  }
+  /**
+   * Register an automation capability.
+   *
+   * Example:
+   *
+   * ```ts
+   * const worker = new Worker();
+   * export default worker;
+   *
+   * worker.automation("sendWelcomeEmail", {
+   *   title: "Send Welcome Email",
+   *   description: "Sends a welcome email when a new user is added",
+   *   execute: async (event, { notion }) => {
+   *     const { pageId, pageData } = event;
+   *
+   *     // Access page properties from the Public API format
+   *     if (pageData) {
+   *       const name = pageData.properties.Name; // Access any property
+   *       const status = pageData.properties.Status;
+   *       console.log(`Processing: ${name}`);
+   *     }
+   *
+   *     // Your automation logic here
+   *     await sendEmail(pageId);
+   *   },
+   * })
+   * ```
+   *
+   * @param key - The unique key for this capability.
+   * @param config - The automation configuration.
+   * @returns The capability object.
+   */
+  automation(key, config) {
+    this.#validateUniqueKey(key);
+    const capability = createAutomationCapability(key, config);
+    this.#capabilities.set(key, capability);
+    return capability;
+  }
+  /**
+   * Register an OAuth capability.
+   *
+   * There are two ways to configure OAuth:
+   *
+   * 1. Notion-managed providers:
+   * ```ts
+   * const worker = new Worker();
+   * export default worker;
+   *
+   * worker.oauth("googleAuth", {
+   *   type: "notion_managed",
+   *   name: "my-google-auth",
+   *   provider: "google"
+   * })
+   * ```
+   *
+   * 2. User-managed OAuth configuration:
+   * ```ts
+   * const worker = new Worker();
+   * export default worker;
+   *
+   * worker.oauth("myCustomAuth", {
+   *   type: "user_managed",
+   *   name: "my-custom-oauth",
+   *   authorizationEndpoint: "https://provider.com/oauth/authorize",
+   *   tokenEndpoint: "https://provider.com/oauth/token",
+   *   scope: "read write",
+   *   clientId: process.env.CLIENT_ID,
+   *   clientSecret: process.env.CLIENT_SECRET,
+   *   authorizationParams: {
+   *     access_type: "offline",
+   *     prompt: "consent"
+   *   }
+   * })
+   * ```
+   *
+   * @param key - The unique key used to register this OAuth capability.
+   * @param config - The OAuth configuration (Notion-managed or user-managed) for this capability.
+   * @returns The registered OAuth capability.
+   */
+  oauth(key, config) {
+    this.#validateUniqueKey(key);
+    const capability = createOAuthCapability(key, config);
+    this.#capabilities.set(key, capability);
+    return capability;
+  }
+  /**
+   * Get all registered capabilities (for discovery) without their handlers.
+   */
+  get capabilities() {
+    return Array.from(this.#capabilities.values()).map((c) => ({
+      _tag: c._tag,
+      key: c.key,
+      config: c.config
+    }));
+  }
+  /**
+   * Execute a capability by key.
+   *
+   * @param key - The key of the capability to execute.
+   * @param context - The context to pass to the capability.
+   * @param options - Additional options for execution (e.g. for testing).
+   * @returns The result of the capability execution.
+   */
+  async run(key, context, options = {}) {
+    const capability = this.#capabilities.get(key);
+    if (!capability) {
+      throw new Error(`Capability "${key}" not found`);
+    }
+    if (capability._tag === "oauth") {
+      throw new Error(
+        `Cannot run OAuth capability "${key}" - OAuth capabilities only provide configuration`
+      );
+    }
+    return capability.handler(context, options);
+  }
+  #validateUniqueKey(key) {
+    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`);
+    }
+  }
+}
+export {
+  Worker
+};

package/package.json

@@ -0,0 +1,68 @@
+{
+	"name": "@notionhq/workers",
+	"version": "0.0.82",
+	"description": "An SDK for building workers for the Notion Workers platform",
+	"license": "UNLICENSED",
+	"type": "module",
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"default": "./dist/index.js"
+		},
+		"./block": {
+			"types": "./dist/block.d.ts",
+			"default": "./dist/block.js"
+		},
+		"./builder": {
+			"types": "./dist/builder.d.ts",
+			"default": "./dist/builder.js"
+		},
+		"./schema": {
+			"types": "./dist/schema.d.ts",
+			"default": "./dist/schema.js"
+		},
+		"./error": {
+			"types": "./dist/error.d.ts",
+			"default": "./dist/error.js"
+		},
+		"./types": {
+			"types": "./dist/types.d.ts",
+			"default": "./dist/types.js"
+		}
+	},
+	"engines": {
+		"node": ">=22.0.0",
+		"npm": ">=10.9.2"
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"files": [
+		"dist/",
+		"src/"
+	],
+	"scripts": {
+		"bootstrap": "mise install && mise exec -- lefthook install",
+		"build": "rm -rf dist && npm run build:types && npm run build:js",
+		"build:types": "tsc",
+		"build:js": "tsx scripts/build.ts",
+		"build:watch": "concurrently --group \"npm run build:watch:types\" \"npm run build:watch:js\"",
+		"build:watch:types": "tsc --watch",
+		"build:watch:js": "esbuild --watch --format=esm --outdir=dist --target=esnext --packages=external ./src/**.ts ./src/**/*.ts",
+		"test": "vitest run"
+	},
+	"devDependencies": {
+		"@types/node": "^24.10.0",
+		"concurrently": "^9.2.1",
+		"esbuild": "^0.27.3",
+		"tsx": "^4.20.6",
+		"typescript": "^5.9.3",
+		"vitest": "^4.0.8"
+	},
+	"peerDependencies": {
+		"@notionhq/client": "^2.2.15"
+	},
+	"dependencies": {
+		"ajv": "^8.17.1"
+	}
+}