@notionhq/workers 0.5.0 → 0.7.0

package/src/builder.ts

@@ -234,9 +234,7 @@ export function relation(primaryKey: string): RelationReference {
  */
 function validateDateString(dateString: string): void {
 	if (!/^\d{4}-\d{2}-\d{2}$/.test(dateString)) {
-		throw new Error(
-			`Invalid date format: ${dateString}. Expected YYYY-MM-DD format.`,
-		);
+		throw new Error(`Invalid date format: ${dateString}. Expected YYYY-MM-DD format.`);
 	}
 
 	const date = new Date(dateString);
@@ -290,10 +288,7 @@ export function emojiIcon(emoji: string): Icon {
  * @param icon - The name of the Notion icon (e.g., "checkmark", "pizza", "rocket")
  * @param color - The color variant (defaults to "gray")
  */
-export function notionIcon(
-	icon: NoticonName,
-	color: NoticonColor = "gray",
-): Icon {
+export function notionIcon(icon: NoticonName, color: NoticonColor = "gray"): Icon {
 	return {
 		type: "notion",
 		icon,
@@ -319,9 +314,7 @@ export function imageIcon(url: string): Icon {
  */
 export function imageCover(url: string, position = 0.5): Cover {
 	if (!Number.isFinite(position) || position < 0 || position > 1) {
-		throw new Error(
-			`Invalid cover position: ${position}. Expected a number between 0 and 1.`,
-		);
+		throw new Error(`Invalid cover position: ${position}. Expected a number between 0 and 1.`);
 	}
 
 	return {

package/src/capabilities/ai_connector.test.ts

@@ -1,12 +1,5 @@
-import {
-	afterEach,
-	beforeEach,
-	describe,
-	expect,
-	it,
-	type Mock,
-	vi,
-} from "vitest";
+import { afterEach, beforeEach, describe, expect, it, type Mock, vi } from "vitest";
+
 import { ExecutionError } from "../error.js";
 import { getPacerState } from "../pacer_internal.js";
 import { Worker } from "../worker.js";
@@ -17,9 +10,7 @@ describe("Worker.aiConnector", () => {
 	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(() => {
@@ -86,12 +77,8 @@ describe("Worker.aiConnector", () => {
 
 		await capability.handler();
 
-		expect(stdoutSpy).toHaveBeenCalledWith(
-			expect.stringContaining(`"_tag":"success"`),
-		);
-		expect(stdoutSpy).toHaveBeenCalledWith(
-			expect.stringContaining(`"thread-1"`),
-		);
+		expect(stdoutSpy).toHaveBeenCalledWith(expect.stringContaining(`"_tag":"success"`));
+		expect(stdoutSpy).toHaveBeenCalledWith(expect.stringContaining(`"thread-1"`));
 	});
 
 	it("passes state through from legacy runtime userContext", async () => {
@@ -106,15 +93,9 @@ describe("Worker.aiConnector", () => {
 			execute,
 		});
 
-		await capability.handler(
-			{ userContext: { cursor: "cursor-1" } },
-			{ concreteOutput: true },
-		);
+		await capability.handler({ userContext: { cursor: "cursor-1" } }, { concreteOutput: true });
 
-		expect(execute).toHaveBeenCalledWith(
-			{ cursor: "cursor-1" },
-			expect.anything(),
-		);
+		expect(execute).toHaveBeenCalledWith({ cursor: "cursor-1" }, expect.anything());
 		expect(stdoutSpy).not.toHaveBeenCalled();
 	});
 
@@ -161,9 +142,7 @@ describe("Worker.aiConnector", () => {
 				},
 			},
 		});
-		expect(
-			result.nextPacerStates.api?.lastScheduledAtMs,
-		).toBeGreaterThanOrEqual(before);
+		expect(result.nextPacerStates.api?.lastScheduledAtMs).toBeGreaterThanOrEqual(before);
 	});
 
 	describe("pacer local fallback", () => {
@@ -243,9 +222,7 @@ describe("Worker.aiConnector", () => {
 		});
 
 		await expect(capability.handler()).rejects.toThrow(ExecutionError);
-		expect(stdoutSpy).toHaveBeenCalledWith(
-			expect.stringContaining(`"_tag":"error"`),
-		);
+		expect(stdoutSpy).toHaveBeenCalledWith(expect.stringContaining(`"_tag":"error"`));
 	});
 
 	it("accepts chat records at compile time", () => {

package/src/capabilities/ai_connector.ts

@@ -85,18 +85,14 @@ export type AiConnectorChangeUpsert<A extends AiConnectorArchetype> = {
 	record: AiConnectorRecordByArchetype[A];
 };
 
-export type AiConnectorChange<A extends AiConnectorArchetype> =
-	AiConnectorChangeUpsert<A>;
+export type AiConnectorChange<A extends AiConnectorArchetype> = AiConnectorChangeUpsert<A>;
 
 export type AiConnectorExecutionResult<
 	A extends AiConnectorArchetype,
 	State = unknown,
 > = StatefulExecutionResult<AiConnectorChange<A>, State>;
 
-export type AiConnectorConfiguration<
-	A extends AiConnectorArchetype,
-	State = unknown,
-> = {
+export type AiConnectorConfiguration<A extends AiConnectorArchetype, State = unknown> = {
 	/**
 	 * The Notion record ID of an existing custom connector in the target workspace.
 	 *
@@ -113,9 +109,7 @@ export type AiConnectorConfiguration<
 	) => Promise<AiConnectorExecutionResult<A, State>>;
 };
 
-export type AiConnectorCapability = ReturnType<
-	typeof createAiConnectorCapability
->;
+export type AiConnectorCapability = ReturnType<typeof createAiConnectorCapability>;
 
 type NormalizedAiConnectorConfiguration<A extends AiConnectorArchetype> = {
 	aiConnectorId: string;
@@ -131,10 +125,7 @@ type AiConnectorHandlerResult<A extends AiConnectorArchetype, State> = {
 	nextPacerStates: Record<string, PacerEntry>;
 };
 
-export function createAiConnectorCapability<
-	A extends AiConnectorArchetype,
-	State = unknown,
->(
+export function createAiConnectorCapability<A extends AiConnectorArchetype, State = unknown>(
 	key: string,
 	configuration: AiConnectorConfiguration<A, State>,
 	pacerDeclarations?: readonly PacerDeclaration[],
@@ -150,10 +141,7 @@ export function createAiConnectorCapability<
 				? {}
 				: { schedule: parseSchedule(configuration.schedule) }),
 		} satisfies NormalizedAiConnectorConfiguration<A>,
-		async handler(
-			runtimeContext?: StatefulRuntimeContext<State>,
-			options?: HandlerOptions,
-		) {
+		async handler(runtimeContext?: StatefulRuntimeContext<State>, options?: HandlerOptions) {
 			const capabilityContext = createCapabilityContext("ai_connector");
 			const state = runtimeContext?.state ?? runtimeContext?.userContext;
 

package/src/capabilities/automation.test.ts

@@ -1,12 +1,5 @@
-import {
-	afterEach,
-	beforeEach,
-	describe,
-	expect,
-	it,
-	type Mock,
-	vi,
-} from "vitest";
+import { afterEach, beforeEach, describe, expect, it, type Mock, vi } from "vitest";
+
 import { ExecutionError } from "../error.js";
 import type { PageObjectResponse } from "./automation.js";
 import { createAutomationCapability } from "./automation.js";
@@ -15,9 +8,7 @@ describe("createAutomationCapability", () => {
 	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(() => {

package/src/capabilities/automation.ts

@@ -64,10 +64,7 @@ export interface AutomationConfiguration {
 	 * @param context - The capability execution context (Notion client, etc.)
 	 * @returns A promise that resolves when the automation completes
 	 */
-	execute: (
-		event: AutomationEvent,
-		context: CapabilityContext,
-	) => Promise<void> | void;
+	execute: (event: AutomationEvent, context: CapabilityContext) => Promise<void> | void;
 }
 
 /**
@@ -78,9 +75,7 @@ export interface AutomationHandlerResult {
 	description: string;
 }
 
-export type AutomationCapability = ReturnType<
-	typeof createAutomationCapability
->;
+export type AutomationCapability = ReturnType<typeof createAutomationCapability>;
 
 /**
  * Creates an automation capability from configuration.
@@ -89,10 +84,7 @@ export type AutomationCapability = ReturnType<
  * @param config - The automation configuration.
  * @returns The capability object.
  */
-export function createAutomationCapability(
-	key: string,
-	config: AutomationConfiguration,
-) {
+export function createAutomationCapability(key: string, config: AutomationConfiguration) {
 	return {
 		_tag: "automation" as const,
 		key,

package/src/capabilities/context.ts

@@ -1,5 +1,6 @@
 import { Client } from "@notionhq/client";
 import type { ClientOptions } from "@notionhq/client/build/src/Client.js";
+
 import type { CapabilityType } from "../worker.js";
 
 export type CapabilityContext = {
@@ -32,9 +33,7 @@ function missingTokenMessage(capabilityType: CapabilityType): string {
 	);
 }
 
-function createUnauthenticatedNotionProxy(
-	capabilityType: CapabilityType,
-): Client {
+function createUnauthenticatedNotionProxy(capabilityType: CapabilityType): Client {
 	return new Proxy({} as Client, {
 		get(_target, prop) {
 			if (prop === "then" || typeof prop === "symbol") {
@@ -45,9 +44,7 @@ function createUnauthenticatedNotionProxy(
 	});
 }
 
-export function createCapabilityContext(
-	capabilityType: CapabilityType,
-): CapabilityContext {
+export function createCapabilityContext(capabilityType: CapabilityType): CapabilityContext {
 	const options: ClientOptions = {};
 
 	if (process.env.NOTION_API_BASE_URL) {

package/src/capabilities/oauth.test.ts

@@ -1,4 +1,5 @@
 import { afterEach, describe, expect, it } from "vitest";
+
 import { createOAuthCapability } from "./oauth.js";
 
 describe("oauth", () => {

package/src/capabilities/oauth.ts

@@ -84,9 +84,7 @@ export interface UserManagedOAuthConfiguration {
 /**
  * Union type representing either Notion-managed or user-managed OAuth configuration.
  */
-export type OAuthConfiguration =
-	| NotionManagedOAuthConfiguration
-	| UserManagedOAuthConfiguration;
+export type OAuthConfiguration = NotionManagedOAuthConfiguration | UserManagedOAuthConfiguration;
 
 export type OAuthCapability = ReturnType<typeof createOAuthCapability>;
 

package/src/capabilities/output.ts

@@ -2,7 +2,5 @@
  * Writes a notion_output envelope to stdout using the shared wire format.
  */
 export function writeOutput(value: unknown): void {
-	process.stdout.write(
-		`\n<__notion_output__>${JSON.stringify(value)}</__notion_output__>\n`,
-	);
+	process.stdout.write(`\n<__notion_output__>${JSON.stringify(value)}</__notion_output__>\n`);
 }

package/src/capabilities/stateful-capability.test.ts

@@ -1,4 +1,5 @@
 import { describe, expect, it } from "vitest";
+
 import { parseSchedule } from "./stateful-capability.js";
 
 describe("stateful capability shared primitives", () => {

package/src/capabilities/stateful-capability.ts

@@ -73,14 +73,10 @@ export function parseSchedule(schedule: Schedule): SyncSchedule {
 	}
 
 	if (intervalMs < MIN_INTERVAL_MS) {
-		throw new Error(
-			`Schedule interval must be at least 1 minute. Got: "${schedule}"`,
-		);
+		throw new Error(`Schedule interval must be at least 1 minute. Got: "${schedule}"`);
 	}
 	if (intervalMs > MAX_INTERVAL_MS) {
-		throw new Error(
-			`Schedule interval must be at most 7 days. Got: "${schedule}"`,
-		);
+		throw new Error(`Schedule interval must be at most 7 days. Got: "${schedule}"`);
 	}
 
 	return { type: "interval", intervalMs };

package/src/capabilities/sync.test.ts

@@ -1,12 +1,5 @@
-import {
-	afterEach,
-	beforeEach,
-	describe,
-	expect,
-	it,
-	type Mock,
-	vi,
-} from "vitest";
+import { afterEach, beforeEach, describe, expect, it, type Mock, vi } from "vitest";
+
 import * as Builder from "../builder.js";
 import { ExecutionError, RateLimitError } from "../error.js";
 import { getPacerState } from "../pacer_internal.js";
@@ -18,9 +11,7 @@ describe("Worker.sync", () => {
 	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(() => {
@@ -47,10 +38,7 @@ describe("Worker.sync", () => {
 		});
 
 		it("can be used to build relation arrays", () => {
-			const value = [
-				Builder.relation("project-123"),
-				Builder.relation("project-456"),
-			];
+			const value = [Builder.relation("project-123"), Builder.relation("project-456")];
 
 			expect(value).toEqual([
 				{ type: "primaryKey", value: "project-123" },
@@ -81,9 +69,9 @@ describe("Worker.sync", () => {
 		});
 
 		it("rejects cover positions outside the supported range", () => {
-			expect(() =>
-				Builder.imageCover("https://example.com/cover.jpg", 1.5),
-			).toThrow("Expected a number between 0 and 1");
+			expect(() => Builder.imageCover("https://example.com/cover.jpg", 1.5)).toThrow(
+				"Expected a number between 0 and 1",
+			);
 		});
 	});
 
@@ -119,10 +107,7 @@ describe("Worker.sync", () => {
 							key: "task-2",
 							properties: {
 								"Task ID": Builder.title("TASK-002"),
-								Project: [
-									Builder.relation("project-123"),
-									Builder.relation("project-456"),
-								],
+								Project: [Builder.relation("project-123"), Builder.relation("project-456")],
 							},
 						},
 					],
@@ -307,12 +292,8 @@ describe("Worker.sync", () => {
 
 			await expect(capability.handler()).rejects.toThrow(ExecutionError);
 
-			expect(stdoutSpy).toHaveBeenCalledWith(
-				expect.stringContaining(`"_tag":"error"`),
-			);
-			expect(stdoutSpy).toHaveBeenCalledWith(
-				expect.stringContaining(`"name":"ExecutionError"`),
-			);
+			expect(stdoutSpy).toHaveBeenCalledWith(expect.stringContaining(`"_tag":"error"`));
+			expect(stdoutSpy).toHaveBeenCalledWith(expect.stringContaining(`"name":"ExecutionError"`));
 		});
 
 		it("wraps RateLimitError in error envelope with _tag rate_limit", async () => {
@@ -337,12 +318,8 @@ describe("Worker.sync", () => {
 
 			await expect(capability.handler()).rejects.toThrow(RateLimitError);
 
-			expect(stdoutSpy).toHaveBeenCalledWith(
-				expect.stringContaining(`"_tag":"rate_limit"`),
-			);
-			expect(stdoutSpy).toHaveBeenCalledWith(
-				expect.stringContaining(`"name":"RateLimitError"`),
-			);
+			expect(stdoutSpy).toHaveBeenCalledWith(expect.stringContaining(`"_tag":"rate_limit"`));
+			expect(stdoutSpy).toHaveBeenCalledWith(expect.stringContaining(`"name":"RateLimitError"`));
 		});
 
 		it("includes retryAfter in rate_limit error envelope when provided", async () => {
@@ -371,18 +348,14 @@ describe("Worker.sync", () => {
 				.map((call) => String(call[0]))
 				.find((s) => s.includes(`"_tag":"rate_limit"`)) as string;
 			const parsed = JSON.parse(
-				output.replace(
-					/\n<__notion_output__>(.*)<\/__notion_output__>\n/,
-					"$1",
-				),
+				output.replace(/\n<__notion_output__>(.*)<\/__notion_output__>\n/, "$1"),
 			);
 			expect(parsed).toEqual({
 				_tag: "error",
 				error: {
 					_tag: "rate_limit",
 					name: "RateLimitError",
-					message:
-						"Error during worker execution: Rate limited by external API",
+					message: "Error during worker execution: Rate limited by external API",
 					retryAfter: 30,
 				},
 			});
@@ -414,10 +387,7 @@ describe("Worker.sync", () => {
 				.map((call) => String(call[0]))
 				.find((s) => s.includes(`"_tag":"rate_limit"`)) as string;
 			const parsed = JSON.parse(
-				output.replace(
-					/\n<__notion_output__>(.*)<\/__notion_output__>\n/,
-					"$1",
-				),
+				output.replace(/\n<__notion_output__>(.*)<\/__notion_output__>\n/, "$1"),
 			);
 			expect(parsed.error.retryAfter).toBeUndefined();
 		});

package/src/capabilities/sync.ts

@@ -1,14 +1,6 @@
 import { ExecutionError, RateLimitError } from "../error.js";
-import {
-	getPacerState,
-	initPacerState,
-	type PacerDeclaration,
-} from "../pacer_internal.js";
-import type {
-	PropertyConfiguration,
-	PropertySchema,
-	Schema,
-} from "../schema.js";
+import { getPacerState, initPacerState, type PacerDeclaration } from "../pacer_internal.js";
+import type { PropertyConfiguration, PropertySchema, Schema } from "../schema.js";
 import type {
 	Cover,
 	HandlerOptions,
@@ -62,10 +54,7 @@ export type SyncMode = StatefulCapabilityMode;
 /**
  * A change representing a record to be created or updated.
  */
-export type SyncChangeUpsert<
-	PK extends string,
-	S extends PropertySchema<PK>,
-> = {
+export type SyncChangeUpsert<PK extends string, S extends PropertySchema<PK>> = {
 	/**
 	 * The type of change. Use `"upsert"` to create or update a record.
 	 */
@@ -168,11 +157,7 @@ export type SyncExecutionResult<PK extends string, State = unknown> = {
 /**
  * Configuration for a sync capability that syncs data to a database.
  */
-export type SyncConfiguration<
-	PK extends string,
-	S extends Schema<PK>,
-	State = unknown,
-> = {
+export type SyncConfiguration<PK extends string, S extends Schema<PK>, State = unknown> = {
 	/**
 	 * The database to sync data into.
 	 */
@@ -233,11 +218,7 @@ export type SyncCapability = ReturnType<typeof createSyncCapability>;
  * @returns A handler function that executes the sync function, and passes data
  * needed to complete the sync back to the platform.
  */
-export function createSyncCapability<
-	PK extends string,
-	S extends Schema<PK>,
-	Context = unknown,
->(
+export function createSyncCapability<PK extends string, S extends Schema<PK>, Context = unknown>(
 	key: string,
 	syncConfiguration: SyncConfiguration<PK, S, Context>,
 	pacerDeclarations?: readonly PacerDeclaration[],
@@ -249,14 +230,9 @@ export function createSyncCapability<
 			databaseKey: syncConfiguration.database.key,
 			primaryKeyProperty: syncConfiguration.database.config.primaryKeyProperty,
 			mode: syncConfiguration.mode,
-			schedule: syncConfiguration.schedule
-				? parseSchedule(syncConfiguration.schedule)
-				: undefined,
+			schedule: syncConfiguration.schedule ? parseSchedule(syncConfiguration.schedule) : undefined,
 		},
-		async handler(
-			runtimeContext?: StatefulRuntimeContext<Context>,
-			options?: HandlerOptions,
-		) {
+		async handler(runtimeContext?: StatefulRuntimeContext<Context>, options?: HandlerOptions) {
 			const capabilityContext = createCapabilityContext("sync");
 			const state = runtimeContext?.state ?? runtimeContext?.userContext;
 
@@ -264,10 +240,7 @@ export function createSyncCapability<
 
 			let executionResult: SyncExecutionResult<PK, Context>;
 			try {
-				executionResult = await syncConfiguration.execute(
-					state,
-					capabilityContext,
-				);
+				executionResult = await syncConfiguration.execute(state, capabilityContext);
 			} catch (err) {
 				if (err instanceof RateLimitError) {
 					if (!options?.concreteOutput) {
@@ -277,9 +250,7 @@ export function createSyncCapability<
 								_tag: "rate_limit",
 								name: err.name,
 								message: err.message,
-								...(err.retryAfter !== undefined
-									? { retryAfter: err.retryAfter }
-									: {}),
+								...(err.retryAfter !== undefined ? { retryAfter: err.retryAfter } : {}),
 							},
 						};
 						writeOutput(envelope);
@@ -304,8 +275,7 @@ export function createSyncCapability<
 
 			const changes = executionResult.changes.map((change) => ({
 				...change,
-				targetDatabaseKey:
-					change.targetDatabaseKey ?? syncConfiguration.database.key,
+				targetDatabaseKey: change.targetDatabaseKey ?? syncConfiguration.database.key,
 			}));
 
 			const result = {