@notionhq/apps 0.0.16 → 0.0.17

package/src/workflow.ts

@@ -1,8 +1,9 @@
 import {
 	createWorkflowConnections,
-	validateConnectionRequirements,
+	normalizeConnectionRequirements,
 	validateTriggerConnections,
-	type WorkflowConnection,
+	type WorkflowConnectionDeclarations,
+	type WorkflowConnectionRequirement,
 	type WorkflowConnections,
 } from "./connections.js";
 import { createHash } from "node:crypto";
@@ -35,14 +36,22 @@ export type WorkflowEventForTrigger<T extends WorkflowTrigger> = WorkflowEventMa
 export type WorkflowEventForTriggers<T extends readonly WorkflowTrigger[]> =
 	WorkflowEventForTrigger<T[number]>;
 
-export { connections, type WorkflowConnection, type WorkflowConnections } from "./connections.js";
+export {
+	connections,
+	type WorkflowConnection,
+	type WorkflowConnectionDeclarations,
+	type WorkflowConnectionRequirement,
+	type WorkflowConnections,
+	type OAuthConfiguration,
+	type OAuthConnection,
+} from "./connections.js";
 
 /**
  * Configuration passed to {@link workflow}.
  */
 export type WorkflowConfiguration<
 	TTriggers extends readonly [WorkflowTrigger, ...WorkflowTrigger[]],
-	TConnections extends readonly WorkflowConnection[] = readonly WorkflowConnection[],
+	TConnections extends WorkflowConnectionDeclarations = WorkflowConnectionDeclarations,
 > = {
 	/**
 	 * A human-readable name for the workflow, shown in the UI when viewing workflows
@@ -75,7 +84,7 @@ export type WorkflowConfiguration<
 /** Configuration that checks trigger keys against declared connections. */
 export type WorkflowTriggerConfiguration<
 	TTriggers extends readonly [WorkflowTrigger, ...WorkflowTrigger[]],
-	TConnections extends readonly WorkflowConnection[],
+	TConnections extends WorkflowConnectionDeclarations,
 > = Omit<WorkflowConfiguration<TTriggers, TConnections>, "triggers"> & {
 	triggers: (context: { triggers: WorkflowTriggerCreators<NoInfer<TConnections>> }) => TTriggers;
 };
@@ -97,7 +106,7 @@ export type Workflow<
 		name: string;
 		description: string;
 		triggers: TTriggers;
-		connections?: readonly WorkflowConnection[];
+		connections?: readonly WorkflowConnectionRequirement[];
 	};
 	handler: (
 		event: WorkflowEventForTriggers<TTriggers>,
@@ -136,26 +145,30 @@ export function workflow<
 		WorkflowTriggerForConnections<NoInfer<TConnections>>,
 		...WorkflowTriggerForConnections<NoInfer<TConnections>>[],
 	],
-	const TConnections extends readonly WorkflowConnection[] = readonly [],
+	const TConnections extends WorkflowConnectionDeclarations = Record<never, never>,
 >(configuration: WorkflowTriggerConfiguration<TTriggers, TConnections>): Workflow<TTriggers>;
 export function workflow<
 	const TTriggers extends readonly [WorkflowTrigger, ...WorkflowTrigger[]],
-	const TConnections extends readonly WorkflowConnection[] = readonly [],
+	const TConnections extends WorkflowConnectionDeclarations = Record<never, never>,
 >(configuration: WorkflowConfiguration<TTriggers, TConnections>): Workflow<TTriggers>;
 export function workflow<
 	const TTriggers extends readonly [WorkflowTrigger, ...WorkflowTrigger[]],
-	const TConnections extends readonly WorkflowConnection[] = readonly [],
+	const TConnections extends WorkflowConnectionDeclarations = Record<never, never>,
 >(
 	configuration:
 		| WorkflowConfiguration<TTriggers, TConnections>
 		| WorkflowTriggerConfiguration<TTriggers, TConnections>,
 ): Workflow<TTriggers> {
+	const requirements = normalizeConnectionRequirements(configuration.connections ?? {});
+	const connectionDeclarations =
+		configuration.connections === undefined
+			? undefined
+			: structuredClone(configuration.connections);
 	const triggers =
 		typeof configuration.triggers === "function"
 			? configuration.triggers({ triggers: createWorkflowTriggers<TConnections>() })
 			: configuration.triggers;
-	validateConnectionRequirements(configuration.connections ?? []);
-	validateTriggerConnections(triggers, configuration.connections ?? []);
+	validateTriggerConnections(triggers, requirements);
 
 	return {
 		_tag: "workflow",
@@ -163,9 +176,7 @@ export function workflow<
 			name: configuration.name,
 			description: configuration.description,
 			triggers,
-			...(configuration.connections === undefined
-				? {}
-				: { connections: configuration.connections }),
+			...(configuration.connections === undefined ? {} : { connections: requirements }),
 		},
 		async handler(
 			event: WorkflowEventForTriggers<TTriggers>,
@@ -175,9 +186,12 @@ export function workflow<
 				event = await resolveRuntimeInput(event);
 				const runMetadata = readRunMetadata();
 				const baseContext = createCapabilityContext();
-				const capabilityContext: WorkflowContext = {
+				const capabilityContext: WorkflowContext<TConnections> = {
 					...baseContext,
-					connections: createWorkflowConnections(baseContext.notion),
+					connections: createWorkflowConnections(
+						baseContext.notion,
+						connectionDeclarations,
+					),
 					...runMetadata,
 					step: createStep(runMetadata),
 				};
@@ -240,7 +254,7 @@ type WorkflowStep = {
 
 /** Context passed to a workflow handler. */
 export type WorkflowContext<
-	TConnections extends readonly WorkflowConnection[] = readonly WorkflowConnection[],
+	TConnections extends WorkflowConnectionDeclarations = WorkflowConnectionDeclarations,
 > = CapabilityContext & {
 	connections: WorkflowConnections<TConnections>;
 } & RunMetadata & {