@notionhq/apps 0.0.12 → 0.0.14

package/src/workflow.ts

@@ -1,3 +1,10 @@
+import {
+	createWorkflowConnections,
+	validateConnectionRequirements,
+	validateTriggerConnections,
+	type WorkflowConnection,
+	type WorkflowConnections,
+} from "./connections.js";
 import { createHash } from "node:crypto";
 import { readFile } from "node:fs/promises";
 import { join } from "node:path";
@@ -8,7 +15,13 @@ import { ExecutionError } from "./error.js";
 import { writeOutput } from "./output.js";
 import { resolveRuntimeInput } from "./runtime-input.js";
 import { readRunMetadata, type RunMetadata } from "./runtime-metadata.js";
-import type { WorkflowEventMap, WorkflowTrigger } from "./triggers.generated.js";
+import { createWorkflowTriggers } from "./triggers.generated.js";
+import type {
+	WorkflowEventMap,
+	WorkflowTrigger,
+	WorkflowTriggerCreators,
+	WorkflowTriggerForConnections,
+} from "./triggers.generated.js";
 
 type HandlerOptions = {
 	/** Return the concrete result instead of writing the output envelope. */
@@ -22,24 +35,14 @@ export type WorkflowEventForTrigger<T extends WorkflowTrigger> = WorkflowEventMa
 export type WorkflowEventForTriggers<T extends readonly WorkflowTrigger[]> =
 	WorkflowEventForTrigger<T[number]>;
 
-/** A connection that a workflow needs before it can run. */
-export type WorkflowConnection = {
-	type: "calendar";
-};
-
-/** Connection requirements supported by workflow capabilities. */
-export const connections = {
-	/** Require an authorized Calendar connection. */
-	calendar(): WorkflowConnection {
-		return { type: "calendar" };
-	},
-};
+export { connections, type WorkflowConnection, type WorkflowConnections } from "./connections.js";
 
 /**
  * Configuration passed to {@link createWorkflow}.
  */
 export type WorkflowConfiguration<
 	TTriggers extends readonly [WorkflowTrigger, ...WorkflowTrigger[]],
+	TConnections extends readonly WorkflowConnection[] = readonly WorkflowConnection[],
 > = {
 	/**
 	 * A human-readable name for the workflow, shown in the UI when viewing workflows
@@ -61,14 +64,22 @@ export type WorkflowConfiguration<
 	/**
 	 * Connections that must be set up before this workflow can run.
 	 */
-	connections?: readonly WorkflowConnection[];
+	connections?: TConnections;
 
 	handler: (
 		event: WorkflowEventForTriggers<TTriggers>,
-		context: WorkflowContext,
+		context: WorkflowContext<TConnections>,
 	) => Promise<void> | void;
 };
 
+/** Configuration that checks trigger keys against declared connections. */
+export type WorkflowTriggerConfiguration<
+	TTriggers extends readonly [WorkflowTrigger, ...WorkflowTrigger[]],
+	TConnections extends readonly WorkflowConnection[],
+> = Omit<WorkflowConfiguration<TTriggers, TConnections>, "triggers"> & {
+	triggers: (context: { triggers: WorkflowTriggerCreators<NoInfer<TConnections>> }) => TTriggers;
+};
+
 /**
  * A workflow capability as returned by {@link createWorkflow}.
  *
@@ -120,25 +131,38 @@ export type Workflow<
  * });
  * ```
  */
+export function createWorkflow<
+	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<
 	const TTriggers extends readonly [WorkflowTrigger, ...WorkflowTrigger[]],
->(configuration: WorkflowConfiguration<TTriggers>): Workflow<TTriggers> {
-	if (configuration.connections !== undefined) {
-		const connectionTypes = new Set<string>();
-		for (const connection of configuration.connections) {
-			if (connectionTypes.has(connection.type)) {
-				throw new Error(`Duplicate workflow connection: ${connection.type}`);
-			}
-			connectionTypes.add(connection.type);
-		}
-	}
+	const TConnections extends readonly WorkflowConnection[] = readonly [],
+>(configuration: WorkflowConfiguration<TTriggers, TConnections>): Workflow<TTriggers>;
+export function createWorkflow<
+	const TTriggers extends readonly [WorkflowTrigger, ...WorkflowTrigger[]],
+	const TConnections extends readonly WorkflowConnection[] = readonly [],
+>(
+	configuration:
+		| WorkflowConfiguration<TTriggers, TConnections>
+		| WorkflowTriggerConfiguration<TTriggers, TConnections>,
+): Workflow<TTriggers> {
+	const triggers =
+		typeof configuration.triggers === "function"
+			? configuration.triggers({ triggers: createWorkflowTriggers<TConnections>() })
+			: configuration.triggers;
+	validateConnectionRequirements(configuration.connections ?? []);
+	validateTriggerConnections(triggers, configuration.connections ?? []);
 
 	return {
 		_tag: "workflow",
 		config: {
 			name: configuration.name,
 			description: configuration.description,
-			triggers: configuration.triggers,
+			triggers,
 			...(configuration.connections === undefined
 				? {}
 				: { connections: configuration.connections }),
@@ -150,8 +174,10 @@ export function createWorkflow<
 			try {
 				event = await resolveRuntimeInput(event);
 				const runMetadata = readRunMetadata();
+				const baseContext = createCapabilityContext();
 				const capabilityContext: WorkflowContext = {
-					...createCapabilityContext(),
+					...baseContext,
+					connections: createWorkflowConnections(baseContext.notion),
 					...runMetadata,
 					step: createStep(runMetadata),
 				};
@@ -213,8 +239,11 @@ type WorkflowStep = {
 };
 
 /** Context passed to a workflow handler. */
-export type WorkflowContext = CapabilityContext &
-	RunMetadata & {
+export type WorkflowContext<
+	TConnections extends readonly WorkflowConnection[] = readonly WorkflowConnection[],
+> = CapabilityContext & {
+	connections: WorkflowConnections<TConnections>;
+} & RunMetadata & {
 		/**
 		 * Run an observable unit of work within the workflow.
 		 *