@notionhq/workers 0.5.0 → 0.6.0

package/src/capabilities/workflow.test.ts

@@ -1,19 +1,7 @@
-import {
-	afterEach,
-	beforeEach,
-	describe,
-	expect,
-	expectTypeOf,
-	it,
-	type Mock,
-	vi,
-} from "vitest";
+import { afterEach, beforeEach, describe, expect, expectTypeOf, it, type Mock, vi } from "vitest";
+
 import { ExecutionError } from "../error.js";
-import {
-	type CapabilityContext,
-	Worker,
-	type WorkflowConfiguration,
-} from "../index.js";
+import { type CapabilityContext, Worker, type WorkflowConfiguration } from "../index.js";
 import {
 	type NotionPageCreatedEvent,
 	type NotionPageCreatedTrigger,
@@ -66,9 +54,7 @@ describe("createWorkflowCapability", () => {
 	let stdoutSpy: Mock<typeof process.stdout.write>;
 
 	beforeEach(() => {
-		stdoutSpy = vi
-			.spyOn(process.stdout, "write")
-			.mockImplementation(() => true);
+		stdoutSpy = vi.spyOn(process.stdout, "write").mockImplementation(() => true);
 	});
 
 	afterEach(() => {
@@ -82,13 +68,8 @@ describe("createWorkflowCapability", () => {
 	});
 
 	it("requires trigger declarations in workflow configuration", () => {
-		type PageAddedConfiguration = WorkflowConfiguration<
-			readonly [NotionPageCreatedTrigger]
-		>;
-		type ConfigurationWithoutTriggers = Omit<
-			PageAddedConfiguration,
-			"triggers"
-		>;
+		type PageAddedConfiguration = WorkflowConfiguration<readonly [NotionPageCreatedTrigger]>;
+		type ConfigurationWithoutTriggers = Omit<PageAddedConfiguration, "triggers">;
 
 		expectTypeOf<ConfigurationWithoutTriggers>().not.toMatchTypeOf<PageAddedConfiguration>();
 	});
@@ -137,9 +118,9 @@ describe("createWorkflowCapability", () => {
 			execute,
 		});
 
-		await expect(
-			capability.handler(pageCreatedEvent, { concreteOutput: true }),
-		).resolves.toEqual({ status: "success" });
+		await expect(capability.handler(pageCreatedEvent, { concreteOutput: true })).resolves.toEqual({
+			status: "success",
+		});
 		expect(execute).toHaveBeenCalledWith(
 			pageCreatedEvent,
 			expect.objectContaining({ notion: expect.any(Object) }),
@@ -172,9 +153,7 @@ describe("createWorkflowCapability", () => {
 			},
 		});
 
-		await expect(capability.handler(pageCreatedEvent)).rejects.toThrow(
-			ExecutionError,
-		);
+		await expect(capability.handler(pageCreatedEvent)).rejects.toThrow(ExecutionError);
 		expect(stdoutSpy).toHaveBeenCalledWith(
 			expect.stringContaining(
 				'"_tag":"error","error":{"name":"ExecutionError","message":"Error during worker execution: Error: Something went wrong"',

package/src/capabilities/workflow.ts

@@ -1,8 +1,5 @@
 import { ExecutionError } from "../error.js";
-import type {
-	WorkflowEventMap,
-	WorkflowTrigger,
-} from "../triggers.generated.js";
+import type { WorkflowEventMap, WorkflowTrigger } from "../triggers.generated.js";
 import type { HandlerOptions } from "../types.js";
 import type { CapabilityContext } from "./context.js";
 import { createCapabilityContext } from "./context.js";
@@ -10,8 +7,7 @@ import { writeOutput } from "./output.js";
 
 export type WorkflowEvent = WorkflowEventMap[keyof WorkflowEventMap];
 
-export type WorkflowEventForTrigger<T extends WorkflowTrigger> =
-	WorkflowEventMap[T["type"]];
+export type WorkflowEventForTrigger<T extends WorkflowTrigger> = WorkflowEventMap[T["type"]];
 
 export type WorkflowEventForTriggers<T extends readonly WorkflowTrigger[]> =
 	WorkflowEventForTrigger<T[number]>;
@@ -46,10 +42,10 @@ export type WorkflowConfiguration<
 };
 
 export type WorkflowCapability<
-	TTriggers extends readonly [
+	TTriggers extends readonly [WorkflowTrigger, ...WorkflowTrigger[]] = readonly [
 		WorkflowTrigger,
 		...WorkflowTrigger[],
-	] = readonly [WorkflowTrigger, ...WorkflowTrigger[]],
+	],
 > = {
 	_tag: "workflow";
 	key: string;
@@ -73,10 +69,7 @@ export type WorkflowCapability<
  */
 export function createWorkflowCapability<
 	const TTriggers extends readonly [WorkflowTrigger, ...WorkflowTrigger[]],
->(
-	key: string,
-	config: WorkflowConfiguration<TTriggers>,
-): WorkflowCapability<TTriggers> {
+>(key: string, config: WorkflowConfiguration<TTriggers>): WorkflowCapability<TTriggers> {
 	return {
 		_tag: "workflow",
 		key,

package/src/index.ts

@@ -1,10 +1,11 @@
-export {
-	emojiIcon,
-	imageCover,
-	imageIcon,
-	notionIcon,
-	place,
-} from "./builder.js";
+export type {
+	CustomBlockCapability,
+	CustomBlockCapabilityConfig,
+	CustomBlockConfiguration,
+	CustomBlockManifest,
+	CustomBlockManifestDataSource,
+} from "./capabilities/custom-block.js";
+export { emojiIcon, imageCover, imageIcon, notionIcon, place } from "./builder.js";
 export type {
 	AiConnectorArchetype,
 	AiConnectorCapability,
@@ -43,11 +44,7 @@ export type {
 	SyncExecutionResult,
 	SyncMode,
 } from "./capabilities/sync.js";
-export type {
-	ToolCapability,
-	ToolConfiguration,
-	ToolHints,
-} from "./capabilities/tool.js";
+export type { ToolCapability, ToolConfiguration, ToolHints } from "./capabilities/tool.js";
 export type {
 	WebhookCapability,
 	WebhookConfiguration,

package/src/json-schema.test.ts

@@ -12,6 +12,7 @@
  * This ensures tsc sees the error on the line immediately after the directive.
  */
 import { describe, expect, it } from "vitest";
+
 import type {
 	AnyJSONSchema,
 	JSONSchema,
@@ -671,10 +672,7 @@ describe("JSONSchema — complex schemas", () => {
 
 describe("JSONSchema — structural type assertions", () => {
 	it("JSONSchemaObjectDef requires additionalProperties to be false", () => {
-		type _Proof = Assert<
-			JSONSchemaObjectDef<{ x: number }>["additionalProperties"],
-			false
-		>;
+		type _Proof = Assert<JSONSchemaObjectDef<{ x: number }>["additionalProperties"], false>;
 	});
 
 	it("JSONSchemaArrayDef minItems is restricted to 0 | 1", () => {

package/src/json-schema.ts

@@ -45,16 +45,18 @@ interface ForbiddenCompositionKeywords {
 
 // ---- Individual schema definitions ----
 
-export interface JSONSchemaStringDef<T extends string = string>
-	extends ForbiddenCompositionKeywords {
+export interface JSONSchemaStringDef<
+	T extends string = string,
+> extends ForbiddenCompositionKeywords {
 	type: "string";
 	description?: string;
 	format?: JSONSchemaStringFormat;
 	enum?: readonly T[];
 }
 
-export interface JSONSchemaNumberDef<T extends number = number>
-	extends ForbiddenCompositionKeywords {
+export interface JSONSchemaNumberDef<
+	T extends number = number,
+> extends ForbiddenCompositionKeywords {
 	type: "number" | "integer";
 	description?: string;
 	enum?: readonly T[];
@@ -70,8 +72,7 @@ export interface JSONSchemaNullDef extends ForbiddenCompositionKeywords {
 	description?: string;
 }
 
-export interface JSONSchemaArrayDef<E = unknown>
-	extends ForbiddenCompositionKeywords {
+export interface JSONSchemaArrayDef<E = unknown> extends ForbiddenCompositionKeywords {
 	type: "array";
 	description?: string;
 	items: JSONSchema<E>;

package/src/pacer.test.ts

@@ -83,9 +83,7 @@ describe("pacerWait", () => {
 	it("throws when pacer key not found in runtime context", async () => {
 		setPacerState({ pacers: {} });
 
-		await expect(pacerWait("unknown")).rejects.toThrow(
-			'Pacer "unknown" not found',
-		);
+		await expect(pacerWait("unknown")).rejects.toThrow('Pacer "unknown" not found');
 	});
 
 	it("preserves allowedRequests and intervalMs across calls", async () => {

package/src/pacer_internal.ts

@@ -39,11 +39,7 @@ export function initPacerState(
 	declarations?: readonly PacerDeclaration[],
 ): void {
 	const pacers = runtimePacers ?? {};
-	if (
-		Object.keys(pacers).length === 0 &&
-		declarations &&
-		declarations.length > 0
-	) {
+	if (Object.keys(pacers).length === 0 && declarations && declarations.length > 0) {
 		const localPacers: Record<string, PacerEntry> = {};
 		for (const decl of declarations) {
 			localPacers[decl.key] = {

package/src/schema-builder.test.ts

@@ -1,11 +1,7 @@
 import { describe, expect, it } from "vitest";
+
 import type { JSONSchema } from "./json-schema.js";
-import {
-	getSchema,
-	type Infer,
-	j,
-	type SchemaBuilder,
-} from "./schema-builder.js";
+import { getSchema, type Infer, j, type SchemaBuilder } from "./schema-builder.js";
 
 // ---------------------------------------------------------------------------
 // 1. Primitives
@@ -188,9 +184,7 @@ describe("json-schema-builder — array", () => {
 	});
 
 	it("array of objects", () => {
-		const schema = getSchema(
-			j.array(j.object({ name: j.string(), age: j.number() })),
-		);
+		const schema = getSchema(j.array(j.object({ name: j.string(), age: j.number() })));
 		expect(schema).toEqual({
 			type: "array",
 			items: {
@@ -351,9 +345,7 @@ describe("json-schema-builder — anyOf", () => {
 	});
 
 	it("anyOf with description", () => {
-		expect(
-			getSchema(j.anyOf(j.string(), j.number()).describe("string or number")),
-		).toEqual({
+		expect(getSchema(j.anyOf(j.string(), j.number()).describe("string or number"))).toEqual({
 			anyOf: [{ type: "string" }, { type: "number" }],
 			description: "string or number",
 		});
@@ -463,12 +455,8 @@ describe("json-schema-builder — discriminated unions", () => {
 
 	it("discriminated union with descriptions on individual variants", () => {
 		const schema = j.anyOf(
-			j
-				.object({ type: j.enum("text"), value: j.string() })
-				.describe("A text node"),
-			j
-				.object({ type: j.enum("image"), url: j.string() })
-				.describe("An image node"),
+			j.object({ type: j.enum("text"), value: j.string() }).describe("A text node"),
+			j.object({ type: j.enum("image"), url: j.string() }).describe("An image node"),
 		);
 
 		const raw = getSchema(schema) as unknown as {
@@ -497,9 +485,7 @@ describe("json-schema-builder — discriminated unions", () => {
 		expect(raw.properties.content.anyOf).toHaveLength(2);
 
 		// The content field is in required
-		expect(
-			(getSchema(schema) as unknown as Record<string, unknown>).required,
-		).toContain("content");
+		expect((getSchema(schema) as unknown as Record<string, unknown>).required).toContain("content");
 	});
 
 	it("nullable discriminated union", () => {
@@ -614,15 +600,7 @@ describe("json-schema-builder — integration", () => {
 				},
 				createdAt: { type: "string", format: "date-time" },
 			},
-			required: [
-				"foo",
-				"bar",
-				"count",
-				"tags",
-				"address",
-				"nickname",
-				"createdAt",
-			],
+			required: ["foo", "bar", "count", "tags", "address", "nickname", "createdAt"],
 			additionalProperties: false,
 		});
 	});
@@ -634,9 +612,7 @@ describe("json-schema-builder — integration", () => {
 
 describe("json-schema-builder — constraint enforcement", () => {
 	it("object always has required matching properties keys", () => {
-		const schema = getSchema(
-			j.object({ x: j.number(), y: j.string(), z: j.boolean() }),
-		);
+		const schema = getSchema(j.object({ x: j.number(), y: j.string(), z: j.boolean() }));
 		const raw = schema as unknown as Record<string, unknown>;
 		expect(raw.required).toEqual(["x", "y", "z"]);
 		expect(raw.additionalProperties).toBe(false);
@@ -669,8 +645,7 @@ describe("json-schema-builder — constraint enforcement", () => {
 			}),
 		);
 		const raw = schema as unknown as Record<string, unknown>;
-		const outer = (raw as { properties: { outer: Record<string, unknown> } })
-			.properties.outer;
+		const outer = (raw as { properties: { outer: Record<string, unknown> } }).properties.outer;
 		expect(outer.required).toEqual(["inner"]);
 		expect(outer.additionalProperties).toBe(false);
 	});

package/src/schema-builder.ts

@@ -47,12 +47,8 @@ function makeBuilder<T>(schema: AnyJSONSchema): SchemaBuilder<T> {
 			return makeBuilder<T>({ ...schema, description: text });
 		},
 		nullable() {
-			const { description: desc, ...rest } = schema as unknown as Record<
-				string,
-				unknown
-			>;
-			const inner =
-				desc !== undefined ? (rest as unknown as AnyJSONSchema) : schema;
+			const { description: desc, ...rest } = schema as unknown as Record<string, unknown>;
+			const inner = desc !== undefined ? (rest as unknown as AnyJSONSchema) : schema;
 			const wrapper: Record<string, unknown> = {
 				anyOf: [inner, { type: "null" }],
 			};
@@ -82,15 +78,9 @@ export function boolean(): SchemaBuilder<boolean> {
 
 // ---- Enum ----
 
-function enumBuilder<T extends string>(
-	...values: readonly T[]
-): SchemaBuilder<T>;
-function enumBuilder<T extends number>(
-	...values: readonly T[]
-): SchemaBuilder<T>;
-function enumBuilder(
-	...values: readonly (string | number)[]
-): SchemaBuilder<unknown> {
+function enumBuilder<T extends string>(...values: readonly T[]): SchemaBuilder<T>;
+function enumBuilder<T extends number>(...values: readonly T[]): SchemaBuilder<T>;
+function enumBuilder(...values: readonly (string | number)[]): SchemaBuilder<unknown> {
 	const type = typeof values[0] === "string" ? "string" : "number";
 	return makeBuilder({ type, enum: values } as AnyJSONSchema);
 }
@@ -155,7 +145,6 @@ export function object<P extends Record<string, SchemaBuilder<unknown>>>(
 	const schemaProps: Record<string, AnyJSONSchema> = {};
 	const keys = Object.keys(properties);
 	for (const key of keys) {
-		// biome-ignore lint/style/noNonNullAssertion: key comes from Object.keys(properties)
 		schemaProps[key] = getSchema(properties[key]!);
 	}
 	return makeBuilder({

package/src/schema.ts

@@ -1,10 +1,4 @@
-import type {
-	DateFormat,
-	Icon,
-	NumberFormat,
-	SelectOption,
-	StatusGroup,
-} from "./types.js";
+import type { DateFormat, Icon, NumberFormat, SelectOption, StatusGroup } from "./types.js";
 
 /**
  * Supported property types for sync schemas.
@@ -182,9 +176,7 @@ export function multiSelect(options: SelectOption[]): PropertyConfiguration {
 /**
  * Creates a status property definition with groups.
  */
-export function status(config: {
-	groups: StatusGroup[];
-}): PropertyConfiguration {
+export function status(config: { groups: StatusGroup[] }): PropertyConfiguration {
 	return { type: "status", groups: config.groups };
 }
 

package/src/types.ts

@@ -118,13 +118,7 @@ export type NumberFormat =
 /**
  * Date format types
  */
-export type DateFormat =
-	| "relative"
-	| "MM/DD/YYYY"
-	| "DD/MM/YYYY"
-	| "YYYY/MM/DD"
-	| "ll"
-	| "MMM d";
+export type DateFormat = "relative" | "MM/DD/YYYY" | "DD/MM/YYYY" | "YYYY/MM/DD" | "ll" | "MMM d";
 
 import type { NoticonName } from "./icon-names.js";
 

package/src/worker.test.ts

@@ -141,6 +141,153 @@ describe("Worker", () => {
 		]);
 	});
 
+	it("registers a project custom block from a folder path (type defaults to project)", () => {
+		const worker = new Worker();
+
+		worker.customBlock("visualBlock", {
+			path: "./views/visual",
+		});
+
+		expect(worker.manifest.capabilities).toEqual([
+			{
+				_tag: "custom_block",
+				key: "visualBlock",
+				config: {
+					source: { type: "project", path: "./views/visual" },
+					manifest: {
+						version: 1,
+						dataSources: {},
+					},
+				},
+			},
+		]);
+	});
+
+	it("carries a project's custom build command and output dir", () => {
+		const worker = new Worker();
+
+		worker.customBlock("built", {
+			path: "./app",
+			command: "npm run build-prod",
+			output: "build",
+		});
+
+		expect(worker.manifest.capabilities).toEqual([
+			{
+				_tag: "custom_block",
+				key: "built",
+				config: {
+					source: {
+						type: "project",
+						path: "./app",
+						command: "npm run build-prod",
+						output: "build",
+					},
+					manifest: { version: 1, dataSources: {} },
+				},
+			},
+		]);
+	});
+
+	it("registers a static custom block served as-is", () => {
+		const worker = new Worker();
+
+		worker.customBlock("prebuilt", { type: "static", path: "./dist" });
+
+		expect(worker.manifest.capabilities).toEqual([
+			{
+				_tag: "custom_block",
+				key: "prebuilt",
+				config: {
+					source: { type: "static", path: "./dist" },
+					manifest: { version: 1, dataSources: {} },
+				},
+			},
+		]);
+	});
+
+	it("carries the author-declared data-source schema verbatim into the manifest", () => {
+		const worker = new Worker();
+
+		worker.customBlock("issueBoard", {
+			path: "./views/issueBoard",
+			dataSources: {
+				issues: {
+					name: "Issues",
+					description: "The team's issues",
+					icon: { type: "emoji", emoji: "🐛" },
+					properties: {
+						title: { name: "Title", type: "title" },
+						status: {
+							name: "Status",
+							description: "Workflow state",
+							type: "status",
+						},
+					},
+				},
+			},
+		});
+
+		expect(worker.manifest.capabilities).toEqual([
+			{
+				_tag: "custom_block",
+				key: "issueBoard",
+				config: {
+					source: { type: "project", path: "./views/issueBoard" },
+					manifest: {
+						version: 1,
+						dataSources: {
+							issues: {
+								name: "Issues",
+								description: "The team's issues",
+								icon: { type: "emoji", emoji: "🐛" },
+								properties: {
+									title: { name: "Title", type: "title" },
+									status: {
+										name: "Status",
+										description: "Workflow state",
+										type: "status",
+									},
+								},
+							},
+						},
+					},
+				},
+			},
+		]);
+	});
+
+	it("threads a top-level manifest version into the generated manifest", () => {
+		const worker = new Worker();
+
+		worker.customBlock("versioned", {
+			path: "./views/versioned",
+			version: 1,
+		});
+
+		expect(worker.manifest.capabilities).toEqual([
+			{
+				_tag: "custom_block",
+				key: "versioned",
+				config: {
+					source: { type: "project", path: "./views/versioned" },
+					manifest: { version: 1, dataSources: {} },
+				},
+			},
+		]);
+	});
+
+	it("cannot run a custom block capability", async () => {
+		const worker = new Worker();
+		worker.customBlock("visualBlock", {
+			path: "./views/visual",
+		});
+
+		await expect(worker.run("visualBlock", {})).rejects.toThrow(
+			'Cannot run custom block capability "visualBlock"',
+		);
+	});
+
 	it("rejects duplicate keys across databases, pacers, and capabilities", () => {
 		const worker = new Worker();
 		const db = worker.database("shared-key", {