@notionhq/apps 0.0.14 → 0.0.16

package/src/workflow.test.ts

@@ -8,7 +8,7 @@ import { afterEach, beforeEach, describe, expect, expectTypeOf, it, vi, type Moc
 import { ExecutionError } from "./error.js";
 import type { RunMetadata } from "./runtime-metadata.js";
 import { triggers, type NotionPageCreatedEvent } from "./triggers.generated.js";
-import { connections, createWorkflow, type StepContext, type WorkflowContext } from "./workflow.js";
+import { connections, workflow, type StepContext, type WorkflowContext } from "./workflow.js";
 
 let stdoutSpy: Mock<typeof process.stdout.write>;
 let checkpointDirectory: string | undefined;
@@ -39,7 +39,7 @@ const event = { type: "notion.page.created" } as NotionPageCreatedEvent;
 
 async function createWorkflowContext(): Promise<WorkflowContext<readonly []>> {
 	let context: WorkflowContext<readonly []> | undefined;
-	const workflow = createWorkflow({
+	const definition = workflow({
 		name: "Test workflow",
 		description: "Captures its workflow context",
 		triggers: [triggers.notionPageCreated()],
@@ -48,7 +48,7 @@ async function createWorkflowContext(): Promise<WorkflowContext<readonly []>> {
 		},
 	});
 
-	await workflow.handler(event, { concreteOutput: true });
+	await definition.handler(event, { concreteOutput: true });
 
 	if (!context) {
 		throw new Error("Workflow context was not created");
@@ -638,7 +638,7 @@ describe("step", () => {
 
 	it("resets duplicate key tracking for each workflow call", async () => {
 		const keys: string[] = [];
-		const workflow = createWorkflow({
+		const definition = workflow({
 			name: "Reuse step key",
 			description: "Checks that a key can be reused in a new invocation",
 			triggers: [triggers.notionPageCreated()],
@@ -654,14 +654,14 @@ describe("step", () => {
 			},
 		});
 
-		await workflow.handler(event, { concreteOutput: true });
-		await workflow.handler(event, { concreteOutput: true });
+		await definition.handler(event, { concreteOutput: true });
+		await definition.handler(event, { concreteOutput: true });
 
 		expect(keys).toEqual([workflowStepKey(["First"]), workflowStepKey(["First"])]);
 	});
 
 	it("writes step events under concreteOutput", async () => {
-		const workflow = createWorkflow({
+		const definition = workflow({
 			name: "Log Pages",
 			description: "Logs created pages",
 			triggers: [triggers.notionPageCreated()],
@@ -670,7 +670,7 @@ describe("step", () => {
 			},
 		});
 
-		await workflow.handler(event, { concreteOutput: true });
+		await definition.handler(event, { concreteOutput: true });
 
 		expect(stdoutSpy).toHaveBeenCalledTimes(3);
 		expect(stdoutSpy.mock.calls[0]?.[0]).toEqual(
@@ -721,17 +721,17 @@ async function writeRunMetadata(overrides: Partial<RunMetadata> = {}): Promise<v
 	process.env.NOTION_RUN_METADATA_PATH = metadataPath;
 }
 
-describe("createWorkflow", () => {
+describe("workflow", () => {
 	it("is tagged and exposes triggers in config", () => {
-		const workflow = createWorkflow({
+		const definition = workflow({
 			name: "Log Pages",
 			description: "Logs created pages",
 			triggers: [triggers.notionPageCreated()],
 			handler: () => {},
 		});
 
-		expect(workflow._tag).toBe("workflow");
-		expect(workflow.config).toEqual({
+		expect(definition._tag).toBe("workflow");
+		expect(definition.config).toEqual({
 			name: "Log Pages",
 			description: "Logs created pages",
 			triggers: [{ type: "notion.page.created" }],
@@ -739,7 +739,7 @@ describe("createWorkflow", () => {
 	});
 
 	it("declares a Calendar connection requirement", () => {
-		const workflow = createWorkflow({
+		const definition = workflow({
 			name: "Schedule Follow-up",
 			description: "Schedules a follow-up after a page is created",
 			triggers: [triggers.notionPageCreated()],
@@ -747,12 +747,12 @@ describe("createWorkflow", () => {
 			handler: () => {},
 		});
 
-		expect(workflow.config.connections).toEqual([{ type: "calendar" }]);
+		expect(definition.config.connections).toEqual([{ type: "calendar" }]);
 	});
 
 	it("rejects duplicate connection requirements", () => {
 		expect(() =>
-			createWorkflow({
+			workflow({
 				name: "Schedule Follow-up",
 				description: "Schedules a follow-up after a page is created",
 				triggers: [triggers.notionPageCreated()],
@@ -764,14 +764,14 @@ describe("createWorkflow", () => {
 
 	it("writes a success envelope after the handler runs", async () => {
 		const handler = vi.fn();
-		const workflow = createWorkflow({
+		const definition = workflow({
 			name: "Log Pages",
 			description: "Logs created pages",
 			triggers: [triggers.notionPageCreated()],
 			handler,
 		});
 
-		await workflow.handler(event);
+		await definition.handler(event);
 
 		expect(handler).toHaveBeenCalledWith(event, expect.anything());
 		expect(stdoutSpy).toHaveBeenCalledWith(
@@ -784,7 +784,7 @@ describe("createWorkflow", () => {
 			throw new Error("Metadata directory was not created");
 		}
 		const handler = vi.fn();
-		const workflow = createWorkflow({
+		const definition = workflow({
 			name: "Log Pages",
 			description: "Logs created pages",
 			triggers: [triggers.notionPageCreated()],
@@ -795,27 +795,27 @@ describe("createWorkflow", () => {
 		await writeFile(inputPath, JSON.stringify(fileEvent));
 		process.env.NOTION_INPUT_PAYLOAD_PATH = inputPath;
 
-		await workflow.handler(event, { concreteOutput: true });
+		await definition.handler(event, { concreteOutput: true });
 
 		expect(handler).toHaveBeenCalledWith(fileEvent, expect.anything());
 	});
 
 	it("returns the status without an envelope under concreteOutput", async () => {
-		const workflow = createWorkflow({
+		const definition = workflow({
 			name: "Log Pages",
 			description: "Logs created pages",
 			triggers: [triggers.notionPageCreated()],
 			handler: () => {},
 		});
 
-		await expect(workflow.handler(event, { concreteOutput: true })).resolves.toEqual({
+		await expect(definition.handler(event, { concreteOutput: true })).resolves.toEqual({
 			status: "success",
 		});
 		expect(stdoutSpy).not.toHaveBeenCalled();
 	});
 
 	it("writes an error envelope and throws ExecutionError on failure", async () => {
-		const workflow = createWorkflow({
+		const definition = workflow({
 			name: "Log Pages",
 			description: "Logs created pages",
 			triggers: [triggers.notionPageCreated()],
@@ -824,7 +824,7 @@ describe("createWorkflow", () => {
 			},
 		});
 
-		await expect(workflow.handler(event)).rejects.toBeInstanceOf(ExecutionError);
+		await expect(definition.handler(event)).rejects.toBeInstanceOf(ExecutionError);
 		expect(stdoutSpy).toHaveBeenCalledWith(
 			expect.stringContaining(
 				`<__notion_output__>{"_tag":"error","error":{"name":"ExecutionError","message":"Error during app execution: Error: boom"`,
@@ -836,7 +836,7 @@ describe("createWorkflow", () => {
 describe("connection-bound triggers", () => {
 	it("resolves typed trigger callbacks once and preserves event inference", () => {
 		let calls = 0;
-		const workflow = createWorkflow({
+		const definition = workflow({
 			name: "Typed triggers",
 			description: "Uses only declared provider keys",
 			connections: [connections.slack({ key: "support" }), connections.calendar()],
@@ -866,14 +866,14 @@ describe("connection-bound triggers", () => {
 			},
 		});
 		expect(calls).toBe(1);
-		expect(workflow.config.triggers).toEqual([
+		expect(definition.config.triggers).toEqual([
 			{ type: "slack.message", connectionKey: "support" },
 			{ type: "calendar.event.created", connectionKey: "calendar" },
 		]);
 	});
 
 	it("preserves the binding in the manifest and infers the event", () => {
-		const workflow = createWorkflow({
+		const definition = workflow({
 			name: "Support",
 			description: "Watch support messages",
 			connections: [connections.slack({ key: "support" })],
@@ -882,7 +882,7 @@ describe("connection-bound triggers", () => {
 				expectTypeOf(event.type).toEqualTypeOf<"slack.message">();
 			},
 		});
-		expect(workflow.config.triggers).toEqual([
+		expect(definition.config.triggers).toEqual([
 			{ type: "slack.message", connectionKey: "support" },
 		]);
 	});
@@ -892,7 +892,7 @@ describe("connection-bound triggers", () => {
 		{ requirements: [connections.slack({ key: "other" })] },
 	])("rejects missing or incompatible declarations: %j", ({ requirements }) => {
 		expect(() =>
-			createWorkflow({
+			workflow({
 				name: "Support",
 				description: "",
 				connections: requirements,
@@ -912,7 +912,7 @@ describe("connection-bound triggers", () => {
 			handler() {},
 		};
 		expect(() =>
-			createWorkflow({
+			workflow({
 				...configuration,
 				triggers: [
 					triggers.slackMessage({ connectionKey: "support" }),
@@ -921,7 +921,7 @@ describe("connection-bound triggers", () => {
 			}),
 		).toThrow("Duplicate");
 		expect(() =>
-			createWorkflow({
+			workflow({
 				...configuration,
 				triggers: [
 					triggers.slackMessage({ connectionKey: "support" }),
@@ -933,7 +933,7 @@ describe("connection-bound triggers", () => {
 	it("preserves existing unkeyed helpers", () => {
 		expect(triggers.slackMessage()).toEqual({ type: "slack.message" });
 		expect(() =>
-			createWorkflow({
+			workflow({
 				name: "Existing",
 				description: "",
 				triggers: [triggers.slackMessage()],

package/src/workflow.ts

@@ -38,7 +38,7 @@ export type WorkflowEventForTriggers<T extends readonly WorkflowTrigger[]> =
 export { connections, type WorkflowConnection, type WorkflowConnections } from "./connections.js";
 
 /**
- * Configuration passed to {@link createWorkflow}.
+ * Configuration passed to {@link workflow}.
  */
 export type WorkflowConfiguration<
 	TTriggers extends readonly [WorkflowTrigger, ...WorkflowTrigger[]],
@@ -81,7 +81,7 @@ export type WorkflowTriggerConfiguration<
 };
 
 /**
- * A workflow capability as returned by {@link createWorkflow}.
+ * A workflow capability as returned by {@link workflow}.
  *
  * Note that a workflow carries no key of its own — the build tool derives
  * the capability key from the file the workflow is default-exported from.
@@ -115,9 +115,9 @@ export type Workflow<
  * ```ts
  * // src/workflows/onPageCreated.ts
  * import { triggers } from "@notionhq/apps/triggers";
- * import { createWorkflow } from "@notionhq/apps/workflow";
+ * import { workflow } from "@notionhq/apps/workflow";
  *
- * export default createWorkflow({
+ * export default workflow({
  *   name: "Send Welcome Email",
  *   description: "Sends a welcome email when a new page is added",
  *   triggers: [triggers.notionPageCreated()],
@@ -131,18 +131,18 @@ export type Workflow<
  * });
  * ```
  */
-export function createWorkflow<
+export function workflow<
 	const TTriggers extends readonly [
 		WorkflowTriggerForConnections<NoInfer<TConnections>>,
 		...WorkflowTriggerForConnections<NoInfer<TConnections>>[],
 	],
 	const TConnections extends readonly WorkflowConnection[] = readonly [],
 >(configuration: WorkflowTriggerConfiguration<TTriggers, TConnections>): Workflow<TTriggers>;
-export function createWorkflow<
+export function workflow<
 	const TTriggers extends readonly [WorkflowTrigger, ...WorkflowTrigger[]],
 	const TConnections extends readonly WorkflowConnection[] = readonly [],
 >(configuration: WorkflowConfiguration<TTriggers, TConnections>): Workflow<TTriggers>;
-export function createWorkflow<
+export function workflow<
 	const TTriggers extends readonly [WorkflowTrigger, ...WorkflowTrigger[]],
 	const TConnections extends readonly WorkflowConnection[] = readonly [],
 >(