@notionhq/workers 0.6.0 → 0.7.0

package/src/worker.ts

@@ -11,11 +11,6 @@ import type {
 } from "./capabilities/automation.js";
 import { createAutomationCapability } from "./capabilities/automation.js";
 import type { CapabilityContext } from "./capabilities/context.js";
-import type {
-	CustomBlockCapability,
-	CustomBlockConfiguration,
-} from "./capabilities/custom-block.js";
-import { createCustomBlockCapability } from "./capabilities/custom-block.js";
 import type {
 	NotionManagedOAuthConfiguration,
 	OAuthCapability,
@@ -74,8 +69,7 @@ type Capability =
 	| AutomationCapability
 	| WorkflowCapability
 	| OAuthCapability
-	| WebhookCapability
-	| CustomBlockCapability;
+	| WebhookCapability;
 
 export type CapabilityType = Capability["_tag"];
 
@@ -111,7 +105,6 @@ type StoredCapability =
 	| AutomationCapability
 	| StoredWorkflowCapability
 	| OAuthCapability
-	| CustomBlockCapability
 	| WebhookCapability;
 
 /**
@@ -616,51 +609,6 @@ export class Worker {
 		return capability;
 	}
 
-	/**
-	 * Register a custom block capability.
-	 *
-	 * A custom block is a front-end view that the deploy pipeline builds from
-	 * the source entry into a deployable bundle. It can optionally declare a
-	 * data-source *schema* (`name`, and optional `description`, `icon`, and
-	 * `properties`) that the block reads.
-	 *
-	 * Example:
-	 *
-	 * ```ts
-	 * const worker = new Worker();
-	 * export default worker;
-	 *
-	 * worker.customBlock("issueBoard", {
-	 *   version: 1,
-	 *   path: "./views/issueBoard",
-	 *   dataSources: {
-	 *     issues: {
-	 *       name: "Issues",
-	 *       properties: {
-	 *         title: { name: "Title", type: "title" },
-	 *         status: { name: "Status", type: "status" },
-	 *       },
-	 *     },
-	 *   },
-	 * });
-	 * ```
-	 *
-	 * The manifest keys (`version`, `dataSources`) are top-level on the config;
-	 * the SDK assembles the deploy-wire `CustomBlockManifest` from them. Binding
-	 * each declared data source to a concrete managed database is instance-level
-	 * and handled at deploy time — the worker does not emit bindings.
-	 *
-	 * @param key - The unique key for this block (the block declaration key).
-	 * @param config - The custom block configuration (a `project`/`static` source folder + optional `version`/`dataSources` schema).
-	 * @returns The custom block capability.
-	 */
-	customBlock(key: string, config: CustomBlockConfiguration): CustomBlockCapability {
-		this.#validateUniqueKey(key);
-		const capability = createCustomBlockCapability(key, config);
-		this.#capabilities.set(key, capability);
-		return capability;
-	}
-
 	/**
 	 * Get all registered capabilities (for discovery) without their handlers.
 	 */
@@ -702,12 +650,6 @@ export class Worker {
 			);
 		}
 
-		if (capability._tag === "custom_block") {
-			throw new Error(
-				`Cannot run custom block capability "${key}" - custom blocks only provide configuration`,
-			);
-		}
-
 		if (!capability.handler) {
 			throw new Error(`Capability "${key}" cannot be executed`);
 		}

package/dist/capabilities/custom-block.d.ts

@@ -1,124 +0,0 @@
-/**
- * Icon for a custom block data source. Mirrors the server/client
- * `CustomBlockManifestIcon` (`@notionhq/shared/customViews/customBlockManifestTypes`).
- */
-export type CustomBlockManifestIcon = {
-    type: "emoji";
-    emoji: string;
-} | {
-    type: "external";
-    url: string;
-};
-/**
- * Public-API-shaped property type names usable in a custom block manifest.
- */
-export type CustomBlockManifestPropertyType = "title" | "rich_text" | "number" | "select" | "multi_select" | "status" | "date" | "people" | "files" | "checkbox" | "url" | "email" | "phone_number" | "formula" | "relation" | "rollup" | "created_time" | "created_by" | "last_edited_time" | "last_edited_by" | "last_visited_time" | "button" | "unique_id" | "location" | "verification" | "place";
-/**
- * Describes a single property exposed by a custom block data source.
- */
-export type CustomBlockManifestProperty = {
-    name: string;
-    description?: string;
-    type: CustomBlockManifestPropertyType;
-};
-/**
- * Rich schema describing one of a custom block's data sources.
- */
-export type CustomBlockManifestDataSource = {
-    /** Display name for the data source. */
-    name: string;
-    /** Optional human-readable description of the data source. */
-    description?: string;
-    /** Optional icon for the data source. */
-    icon?: CustomBlockManifestIcon;
-    /** Optional property schema keyed by property key. */
-    properties?: Record<string, CustomBlockManifestProperty>;
-};
-export type CustomBlockManifest = {
-    version: 1;
-    /**
-     * The block's datasources schema, mapping keys you name to {@link CustomBlockManifestDataSource}
-     *
-     * @example
-     *
-     * {
-     *   "myDataSource": {
-     *     "name": "My Data Source",
-     *     "description": "A description of my data source",
-     *     "icon": "icon.png",
-     *     "properties": {
-     *       "property1": {
-     *         "name": "Property 1",
-     *         "type": "string"
-     *       }
-     *     }
-     *   }
-     * }
-     */
-    dataSources: Record<string, CustomBlockManifestDataSource>;
-};
-/**
- * A custom block is a front-end web app served in an iframe in the client with live data access.
- *
- * Available `type`s are `project` (a buildable project dir) and `static` (an already-built dir served as-is).
- */
-export type CustomBlockConfiguration = ({
-    /** Buildable project dir (the default). */
-    type?: "project";
-    /** Path to the project dir, relative to the worker root (e.g. `"./blocks/foo"`). */
-    path: string;
-    /** Build command run in `path`. Defaults to `npm run build`. */
-    command?: string;
-    /** Built-output dir relative to `path`. Defaults to `dist`. */
-    output?: string;
-} | {
-    /** An already-built browser-bundle dir; served as-is, no build step. */
-    type: "static";
-    /** Path to the prebuilt dir, relative to the worker root. */
-    path: string;
-    command?: never;
-    output?: never;
-}) & Partial<CustomBlockManifest>;
-/**
- * The build source of a custom block, mirroring the server's
- * `BlockSourceDeclaration`. `project` is a buildable dir (`command` defaults to
- * `npm run build`, `output` to `dist`); `static` is an already-built dir served
- * as-is.
- */
-export type BlockSourceDeclaration = {
-    type: "project";
-    path: string;
-    command?: string;
-    output?: string;
-} | {
-    type: "static";
-    path: string;
-};
-/**
- * Config payload carried in the runtime manifest for a `_tag: "custom_block"`
- * capability entry. The server parses this (see `RawBlockCapabilityConfig` in
- * `capabilities-service.ts`): `source` is the build entry and `manifest` is the
- * author-declared {@link CustomBlockManifest} describing the block's data-source
- * schema. Data-source *bindings* are instance-level and are not carried here.
- */
-export type CustomBlockCapabilityConfig = {
-    source: BlockSourceDeclaration;
-    manifest: CustomBlockManifest;
-};
-/**
- * A custom-block capability entry. Unlike other capabilities it has no runtime
- * handler — it is a build-time/deploy-time declaration only, carried through
- * the manifest so the server can build and bind the block on deploy.
- */
-export type CustomBlockCapability = {
-    readonly _tag: "custom_block";
-    readonly key: string;
-    readonly config: CustomBlockCapabilityConfig;
-};
-/**
- * Builds a custom-block capability entry from its authoring configuration. The
- * author-declared `dataSources` schema is carried verbatim into the block
- * {@link CustomBlockManifest}; no bindings are emitted.
- */
-export declare function createCustomBlockCapability(key: string, config: CustomBlockConfiguration): CustomBlockCapability;
-//# sourceMappingURL=custom-block.d.ts.map

package/dist/capabilities/custom-block.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"custom-block.d.ts","sourceRoot":"","sources":["../../src/capabilities/custom-block.ts"],"names":[],"mappings":"AAIA;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAChC;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAChC;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC;AAErC;;GAEG;AACH,MAAM,MAAM,+BAA+B,GACxC,OAAO,GACP,WAAW,GACX,QAAQ,GACR,QAAQ,GACR,cAAc,GACd,QAAQ,GACR,MAAM,GACN,QAAQ,GACR,OAAO,GACP,UAAU,GACV,KAAK,GACL,OAAO,GACP,cAAc,GACd,SAAS,GACT,UAAU,GACV,QAAQ,GACR,cAAc,GACd,YAAY,GACZ,kBAAkB,GAClB,gBAAgB,GAChB,mBAAmB,GACnB,QAAQ,GACR,WAAW,GACX,UAAU,GACV,cAAc,GACd,OAAO,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,+BAA+B,CAAC;CACtC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC3C,wCAAwC;IACxC,IAAI,EAAE,MAAM,CAAC;IACb,8DAA8D;IAC9D,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,yCAAyC;IACzC,IAAI,CAAC,EAAE,uBAAuB,CAAC;IAC/B,sDAAsD;IACtD,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,2BAA2B,CAAC,CAAC;CACzD,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IACjC,OAAO,EAAE,CAAC,CAAC;IACX;;;;;;;;;;;;;;;;;;OAkBG;IACH,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,6BAA6B,CAAC,CAAC;CAC3D,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,GAAG,CACpC;IACA,2CAA2C;IAC3C,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,oFAAoF;IACpF,IAAI,EAAE,MAAM,CAAC;IACb,gEAAgE;IAChE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,+DAA+D;IAC/D,MAAM,CAAC,EAAE,MAAM,CAAC;CACf,GACD;IACA,wEAAwE;IACxE,IAAI,EAAE,QAAQ,CAAC;IACf,6DAA6D;IAC7D,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,KAAK,CAAC;IAChB,MAAM,CAAC,EAAE,KAAK,CAAC;CACd,CACH,GACA,OAAO,CAAC,mBAAmB,CAAC,CAAC;AAE9B;;;;;GAKG;AACH,MAAM,MAAM,sBAAsB,GAC/B;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,GACpE;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC;AAEpC;;;;;;GAMG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACzC,MAAM,EAAE,sBAAsB,CAAC;IAC/B,QAAQ,EAAE,mBAAmB,CAAC;CAC9B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IACnC,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAC;IAC9B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,MAAM,EAAE,2BAA2B,CAAC;CAC7C,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,2BAA2B,CAC1C,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,wBAAwB,GAC9B,qBAAqB,CAsBvB"}

package/dist/capabilities/custom-block.js

@@ -1,22 +0,0 @@
-function createCustomBlockCapability(key, config) {
-  const source = config.type === "static" ? { type: "static", path: config.path } : {
-    type: "project",
-    path: config.path,
-    ...config.command !== void 0 ? { command: config.command } : {},
-    ...config.output !== void 0 ? { output: config.output } : {}
-  };
-  return {
-    _tag: "custom_block",
-    key,
-    config: {
-      source,
-      manifest: {
-        version: config.version ?? 1,
-        dataSources: config.dataSources ?? {}
-      }
-    }
-  };
-}
-export {
-  createCustomBlockCapability
-};

package/src/capabilities/custom-block.ts

@@ -1,181 +0,0 @@
-// ============================================================================
-// Custom Block Authoring API
-// ============================================================================
-
-/**
- * Icon for a custom block data source. Mirrors the server/client
- * `CustomBlockManifestIcon` (`@notionhq/shared/customViews/customBlockManifestTypes`).
- */
-export type CustomBlockManifestIcon =
-	| { type: "emoji"; emoji: string }
-	| { type: "external"; url: string };
-
-/**
- * Public-API-shaped property type names usable in a custom block manifest.
- */
-export type CustomBlockManifestPropertyType =
-	| "title"
-	| "rich_text"
-	| "number"
-	| "select"
-	| "multi_select"
-	| "status"
-	| "date"
-	| "people"
-	| "files"
-	| "checkbox"
-	| "url"
-	| "email"
-	| "phone_number"
-	| "formula"
-	| "relation"
-	| "rollup"
-	| "created_time"
-	| "created_by"
-	| "last_edited_time"
-	| "last_edited_by"
-	| "last_visited_time"
-	| "button"
-	| "unique_id"
-	| "location"
-	| "verification"
-	| "place";
-
-/**
- * Describes a single property exposed by a custom block data source.
- */
-export type CustomBlockManifestProperty = {
-	name: string;
-	description?: string;
-	type: CustomBlockManifestPropertyType;
-};
-
-/**
- * Rich schema describing one of a custom block's data sources.
- */
-export type CustomBlockManifestDataSource = {
-	/** Display name for the data source. */
-	name: string;
-	/** Optional human-readable description of the data source. */
-	description?: string;
-	/** Optional icon for the data source. */
-	icon?: CustomBlockManifestIcon;
-	/** Optional property schema keyed by property key. */
-	properties?: Record<string, CustomBlockManifestProperty>;
-};
-
-export type CustomBlockManifest = {
-	version: 1;
-	/**
-	 * The block's datasources schema, mapping keys you name to {@link CustomBlockManifestDataSource}
-	 *
-	 * @example
-	 *
-	 * {
-	 *   "myDataSource": {
-	 *     "name": "My Data Source",
-	 *     "description": "A description of my data source",
-	 *     "icon": "icon.png",
-	 *     "properties": {
-	 *       "property1": {
-	 *         "name": "Property 1",
-	 *         "type": "string"
-	 *       }
-	 *     }
-	 *   }
-	 * }
-	 */
-	dataSources: Record<string, CustomBlockManifestDataSource>;
-};
-
-/**
- * A custom block is a front-end web app served in an iframe in the client with live data access.
- *
- * Available `type`s are `project` (a buildable project dir) and `static` (an already-built dir served as-is).
- */
-export type CustomBlockConfiguration = (
-	| {
-			/** Buildable project dir (the default). */
-			type?: "project";
-			/** Path to the project dir, relative to the worker root (e.g. `"./blocks/foo"`). */
-			path: string;
-			/** Build command run in `path`. Defaults to `npm run build`. */
-			command?: string;
-			/** Built-output dir relative to `path`. Defaults to `dist`. */
-			output?: string;
-	  }
-	| {
-			/** An already-built browser-bundle dir; served as-is, no build step. */
-			type: "static";
-			/** Path to the prebuilt dir, relative to the worker root. */
-			path: string;
-			command?: never;
-			output?: never;
-	  }
-) &
-	Partial<CustomBlockManifest>;
-
-/**
- * The build source of a custom block, mirroring the server's
- * `BlockSourceDeclaration`. `project` is a buildable dir (`command` defaults to
- * `npm run build`, `output` to `dist`); `static` is an already-built dir served
- * as-is.
- */
-export type BlockSourceDeclaration =
-	| { type: "project"; path: string; command?: string; output?: string }
-	| { type: "static"; path: string };
-
-/**
- * Config payload carried in the runtime manifest for a `_tag: "custom_block"`
- * capability entry. The server parses this (see `RawBlockCapabilityConfig` in
- * `capabilities-service.ts`): `source` is the build entry and `manifest` is the
- * author-declared {@link CustomBlockManifest} describing the block's data-source
- * schema. Data-source *bindings* are instance-level and are not carried here.
- */
-export type CustomBlockCapabilityConfig = {
-	source: BlockSourceDeclaration;
-	manifest: CustomBlockManifest;
-};
-
-/**
- * A custom-block capability entry. Unlike other capabilities it has no runtime
- * handler — it is a build-time/deploy-time declaration only, carried through
- * the manifest so the server can build and bind the block on deploy.
- */
-export type CustomBlockCapability = {
-	readonly _tag: "custom_block";
-	readonly key: string;
-	readonly config: CustomBlockCapabilityConfig;
-};
-
-/**
- * Builds a custom-block capability entry from its authoring configuration. The
- * author-declared `dataSources` schema is carried verbatim into the block
- * {@link CustomBlockManifest}; no bindings are emitted.
- */
-export function createCustomBlockCapability(
-	key: string,
-	config: CustomBlockConfiguration,
-): CustomBlockCapability {
-	const source: BlockSourceDeclaration =
-		config.type === "static"
-			? { type: "static", path: config.path }
-			: {
-					type: "project",
-					path: config.path,
-					...(config.command !== undefined ? { command: config.command } : {}),
-					...(config.output !== undefined ? { output: config.output } : {}),
-				};
-
-	return {
-		_tag: "custom_block",
-		key,
-		config: {
-			source,
-			manifest: {
-				version: config.version ?? 1,
-				dataSources: config.dataSources ?? {},
-			},
-		},
-	};
-}