@notionhq/apps 0.0.32 → 0.0.34

package/src/events-types.test.ts

@@ -0,0 +1,110 @@
+import { resolve } from "node:path";
+import ts from "typescript";
+import { expect, it } from "vitest";
+
+it("checks property references and schedule variants in user code", () => {
+	const cases = [
+		{
+			name: "property",
+			valid: true,
+			expression:
+				"events.notionPageUpdated({ dataSource: tasks.dataSource, properties: [tasks.dataSource.properties.Status] })",
+		},
+		{
+			name: "content",
+			valid: true,
+			expression:
+				"events.notionPageUpdated({ dataSource: tasks.dataSource, includePageContent: true })",
+		},
+		{
+			name: "typo",
+			valid: false,
+			expression:
+				"events.notionPageUpdated({ dataSource: tasks.dataSource, properties: [tasks.dataSource.properties.Statuz] })",
+		},
+		{
+			name: "string",
+			valid: false,
+			expression:
+				'events.notionPageUpdated({ dataSource: tasks.dataSource, properties: ["Status"] })',
+		},
+		{
+			name: "other_source",
+			valid: false,
+			expression:
+				"events.notionPageUpdated({ dataSource: tasks.dataSource, properties: [other.dataSource.properties.Name] })",
+		},
+		{
+			name: "unsupported_property",
+			valid: false,
+			expression:
+				"events.notionPageUpdated({ dataSource: tasks.dataSource, properties: [tasks.dataSource.properties.Files] })",
+		},
+		{
+			name: "empty",
+			valid: false,
+			expression:
+				"events.notionPageUpdated({ dataSource: tasks.dataSource, properties: [] })",
+		},
+		{
+			name: "no_watch",
+			valid: false,
+			expression: "events.notionPageUpdated({ dataSource: tasks.dataSource })",
+		},
+		{
+			name: "weekly",
+			valid: true,
+			expression:
+				'events.scheduled({ frequency: "week", interval: 1, weekdays: { MO: true }, start: "2026-09-23", timeZone: "UTC" })',
+		},
+		{
+			name: "no_weekday",
+			valid: false,
+			expression:
+				'events.scheduled({ frequency: "week", interval: 1, weekdays: {}, start: "2026-09-23", timeZone: "UTC" })',
+		},
+	];
+	const fixtures = new Map(
+		cases.map((testCase) => [
+			resolve("src", `__events_${testCase.name}.ts`),
+			`
+		import { database, events } from "./index.js";
+		const tasks = database("tasks", { name: "Tasks", dataSourceResourceId: "tasks-source", schema: {
+			Name: { type: "title", resourceId: "name" }, Status: { type: "select", resourceId: "status", options: [] }, Files: { type: "file", resourceId: "files" }
+		} });
+		const other = database("other", { name: "Other", dataSourceResourceId: "other-source", schema: {
+			Name: { type: "title", resourceId: "other-name" }
+		} });
+		${testCase.expression};
+	`,
+		]),
+	);
+	const config = ts.readConfigFile(resolve("tsconfig.json"), ts.sys.readFile);
+	const parsed = ts.parseJsonConfigFileContent(config.config, ts.sys, process.cwd());
+	const host = ts.createCompilerHost(parsed.options);
+	const getSourceFile = host.getSourceFile.bind(host);
+	host.getSourceFile = (fileName, languageVersion, onError, shouldCreateNewSourceFile) => {
+		const fixture = fixtures.get(fileName);
+		return fixture === undefined
+			? getSourceFile(fileName, languageVersion, onError, shouldCreateNewSourceFile)
+			: ts.createSourceFile(fileName, fixture, languageVersion, true);
+	};
+	const program = ts.createProgram(
+		[...fixtures.keys()],
+		{ ...parsed.options, noEmit: true },
+		host,
+	);
+	const diagnostics = ts.getPreEmitDiagnostics(program);
+	expect(
+		diagnostics.filter(
+			(diagnostic) => !diagnostic.file || !fixtures.has(diagnostic.file.fileName),
+		),
+	).toEqual([]);
+	for (const testCase of cases) {
+		const errors = diagnostics.filter(
+			(diagnostic) =>
+				diagnostic.file?.fileName === resolve("src", `__events_${testCase.name}.ts`),
+		);
+		expect(errors.length === 0, testCase.name).toBe(testCase.valid);
+	}
+});

package/src/{triggers.generated.ts → events.generated.ts}

@@ -1,7 +1,12 @@
-// Generated by scripts/generate-triggers.ts — do not edit by hand.
+// Generated by scripts/generate-events.ts — do not edit by hand.
 // Regenerate with: pnpm run generate
 
 import type { WorkflowConnectionDeclarations, WorkflowConnectionKeys } from "./connections.js";
+import { scheduled, notionPageCreated, notionPageUpdated } from "./configured-events.js";
+import type { NotionPageCreatedTrigger, NotionPageUpdatedTrigger, PageUpdatedOptions, RecurrenceTrigger } from "./configured-events.js";
+import type { DataSourceHandle } from "./notion-as-code/database.js";
+import type { NotionAsCodeSchema } from "./notion-as-code/intents.js";
+import type { RecurrenceSchedule } from "./notion-as-code/recurrence.js";
 
 import type {
 	CalendarEventCanceledEvent,
@@ -25,7 +30,7 @@ import type {
 	SlackMessageEvent,
 	SlackReactionAddedEvent,
 	WebhookEvent,
-} from "./triggers.js";
+} from "./events.js";
 
 export type {
 	Actor,
@@ -72,7 +77,10 @@ export type {
 	VendorActor,
 	VendorExtensions,
 	WebhookEvent,
-} from "./triggers.js";
+} from "./events.js";
+
+export type { NotionPageCreatedTrigger, NotionPageUpdatedTrigger, PageUpdatedOptions, RecurrenceTrigger } from "./configured-events.js";
+export type { RecurrenceSchedule } from "./notion-as-code/recurrence.js";
 
 /** Triggers immediately after a new message is posted in Slack (includes new threads and replies) */
 export type SlackMessageTrigger<TKey extends string = string> = {
@@ -144,16 +152,6 @@ export type CalendarEventCanceledTrigger<TKey extends string = string> = {
 	connectionKey?: TKey;
 };
 
-/** A page has been added to a database. */
-export type NotionPageCreatedTrigger = {
-	type: "notion.page.created";
-};
-
-/** A page was updated. */
-export type NotionPageUpdatedTrigger = {
-	type: "notion.page.updated";
-};
-
 /** A page was deleted. */
 export type NotionPageDeletedTrigger = {
 	type: "notion.page.deleted";
@@ -196,13 +194,8 @@ export type GoogleDriveOauthFilesChangedTrigger<TKey extends string = string> =
 	connectionKey?: TKey;
 };
 
-/** A recurring schedule fired. */
-export type RecurrenceTrigger = {
-	type: "recurrence";
-};
-
 /** Creators for each event that can trigger a workflow. */
-export const triggers = {
+export const events = {
 	/**
 	 * Declare that a workflow can run on `slack.message` events.
 	 *
@@ -323,27 +316,9 @@ export const triggers = {
 		};
 	},
 
-	/**
-	 * Declare that a workflow can run on `notion.page.created` events.
-	 *
-	 * A page has been added to a database.
-	 */
-	notionPageCreated(): NotionPageCreatedTrigger {
-		return {
-			type: "notion.page.created",
-		};
-	},
+	notionPageCreated,
 
-	/**
-	 * Declare that a workflow can run on `notion.page.updated` events.
-	 *
-	 * A page was updated.
-	 */
-	notionPageUpdated(): NotionPageUpdatedTrigger {
-		return {
-			type: "notion.page.updated",
-		};
-	},
+	notionPageUpdated,
 
 	/**
 	 * Declare that a workflow can run on `notion.page.deleted` events.
@@ -434,20 +409,11 @@ export const triggers = {
 		};
 	},
 
-	/**
-	 * Declare that a workflow can run on `recurrence` events.
-	 *
-	 * A recurring schedule fired.
-	 */
-	scheduled(): RecurrenceTrigger {
-		return {
-			type: "recurrence",
-		};
-	},
+	scheduled,
 } as const;
 
 /** Trigger creators restricted to the workflow's declared provider keys. */
-export type WorkflowTriggerCreators<TConnections extends WorkflowConnectionDeclarations> = {
+export type WorkflowEventCreators<TConnections extends WorkflowConnectionDeclarations> = {
 	slackMessage(options?: { connectionKey: WorkflowConnectionKeys<TConnections, "slack"> }): SlackMessageTrigger<WorkflowConnectionKeys<TConnections, "slack">>;
 	slackReactionAdded(options?: { connectionKey: WorkflowConnectionKeys<TConnections, "slack"> }): SlackReactionAddedTrigger<WorkflowConnectionKeys<TConnections, "slack">>;
 	slackAppMention(options?: { connectionKey: WorkflowConnectionKeys<TConnections, "slack"> }): SlackAppMentionTrigger<WorkflowConnectionKeys<TConnections, "slack">>;
@@ -458,8 +424,8 @@ export type WorkflowTriggerCreators<TConnections extends WorkflowConnectionDecla
 	calendarEventCreated(options?: { connectionKey: WorkflowConnectionKeys<TConnections, "calendar"> }): CalendarEventCreatedTrigger<WorkflowConnectionKeys<TConnections, "calendar">>;
 	calendarEventUpdated(options?: { connectionKey: WorkflowConnectionKeys<TConnections, "calendar"> }): CalendarEventUpdatedTrigger<WorkflowConnectionKeys<TConnections, "calendar">>;
 	calendarEventCanceled(options?: { connectionKey: WorkflowConnectionKeys<TConnections, "calendar"> }): CalendarEventCanceledTrigger<WorkflowConnectionKeys<TConnections, "calendar">>;
-	notionPageCreated(): NotionPageCreatedTrigger;
-	notionPageUpdated(): NotionPageUpdatedTrigger;
+	notionPageCreated(options?: { dataSource: DataSourceHandle }): NotionPageCreatedTrigger;
+	notionPageUpdated<const Schema extends NotionAsCodeSchema>(options?: PageUpdatedOptions<Schema>): NotionPageUpdatedTrigger;
 	notionPageDeleted(): NotionPageDeletedTrigger;
 	notionMeetingNoteSummaryCompleted(): NotionMeetingNoteSummaryCompletedTrigger;
 	notionCommentAdded(): NotionCommentAddedTrigger;
@@ -468,7 +434,7 @@ export type WorkflowTriggerCreators<TConnections extends WorkflowConnectionDecla
 	notionDatabaseAgentUpdated(): NotionDatabaseAgentUpdatedTrigger;
 	webhook(): WebhookTrigger;
 	googleDriveOauthFilesChanged(options?: { connectionKey: WorkflowConnectionKeys<TConnections, "googleDriveOauth"> }): GoogleDriveOauthFilesChangedTrigger<WorkflowConnectionKeys<TConnections, "googleDriveOauth">>;
-	scheduled(): RecurrenceTrigger;
+	scheduled(options?: RecurrenceSchedule): RecurrenceTrigger;
 };
 
 /** Triggers whose connection keys belong to the declared provider. */
@@ -496,8 +462,8 @@ export type WorkflowTriggerForConnections<TConnections extends WorkflowConnectio
 	| RecurrenceTrigger;
 
 /** @internal */
-export function createWorkflowTriggers<TConnections extends WorkflowConnectionDeclarations>(): WorkflowTriggerCreators<TConnections> {
-	return triggers;
+export function createWorkflowEvents<TConnections extends WorkflowConnectionDeclarations>(): WorkflowEventCreators<TConnections> {
+	return events;
 }
 
 /** Event that can trigger a workflow. */

package/src/index.ts

@@ -1,3 +1,4 @@
+export { events } from "./events.generated.js";
 export { customBlock, type CustomBlockHandle } from "./custom-block.js";
 export { customAgent } from "./notion-as-code/custom-agent.js";
 export { database } from "./notion-as-code/database.js";

package/src/notion-as-code/custom-agent.ts

@@ -3,67 +3,21 @@ import type { CustomAgentIntent, NotionAsCodeIcon, ResourceId } from "./intents.
 import { recordIntent } from "./recorder.js";
 import { assertUserResourceId } from "./resource.js";
 
-type RecurrenceWeekday = "MO" | "TU" | "WE" | "TH" | "FR" | "SA" | "SU";
-
-/** A nonempty selection of weekdays for a weekly recurrence. */
-export type RecurrenceWeekdays = {
-	[Day in RecurrenceWeekday]?: true;
-} & {
-	[Day in RecurrenceWeekday]: Required<Pick<Record<RecurrenceWeekday, true>, Day>>;
-}[RecurrenceWeekday];
-
-export type MonthlyWeekdayOccurrence = "1st" | "2nd" | "3rd" | "4th" | "last";
-
-export type MonthlyRecurrenceRestriction =
-	| { type: "day_of_month"; day: number }
-	| {
-			type: "weekday_of_month";
-			weekday: RecurrenceWeekday;
-			occurrence: MonthlyWeekdayOccurrence;
-	  };
-
-export type RecurrenceScheduleEnd =
-	| { type: "date"; endsAt: string }
-	| { type: "occurrences"; count: number };
-
-type RecurrenceScheduleBase = {
-	interval: number;
-	start: string;
-	timeZone: string;
-	end?: RecurrenceScheduleEnd;
-};
-
-export type HourlyRecurrenceSchedule = RecurrenceScheduleBase & {
-	frequency: "hour";
-};
-
-export type DailyRecurrenceSchedule = RecurrenceScheduleBase & {
-	frequency: "day";
-};
-
-export type WeeklyRecurrenceSchedule = RecurrenceScheduleBase & {
-	frequency: "week";
-	weekdays: RecurrenceWeekdays;
-};
-
-export type MonthlyRecurrenceSchedule = RecurrenceScheduleBase & {
-	frequency: "month";
-	monthlyRestriction: MonthlyRecurrenceRestriction;
-};
-
-export type YearlyRecurrenceSchedule = RecurrenceScheduleBase & {
-	frequency: "year";
-};
-
-export type CustomAgentRecurrenceSchedule = (
-	| HourlyRecurrenceSchedule
-	| DailyRecurrenceSchedule
-	| WeeklyRecurrenceSchedule
-	| MonthlyRecurrenceSchedule
-	| YearlyRecurrenceSchedule
-) & {
-	type: "recurrence";
-};
+import type { RecurrenceSchedule } from "./recurrence.js";
+export type {
+	RecurrenceWeekdays,
+	MonthlyWeekdayOccurrence,
+	MonthlyRecurrenceRestriction,
+	RecurrenceScheduleEnd,
+	HourlyRecurrenceSchedule,
+	DailyRecurrenceSchedule,
+	WeeklyRecurrenceSchedule,
+	MonthlyRecurrenceSchedule,
+	YearlyRecurrenceSchedule,
+	RecurrenceSchedule,
+} from "./recurrence.js";
+
+export type CustomAgentRecurrenceSchedule = RecurrenceSchedule & { type: "recurrence" };
 
 export type CustomAgentTriggerBase = {
 	resourceId: ResourceId;

package/src/notion-as-code/database.ts

@@ -118,6 +118,20 @@ export type ChildDatabaseArgs<
 	| ChildMultiSourceDatabaseArgs<DataSources>
 	| Omit<ViewOnlyDatabaseArgs, "parent">;
 
+export type PropertyHandle<
+	Property extends NotionAsCodeSchema[string] = NotionAsCodeSchema[string],
+> = {
+	readonly resourceType: "property";
+	readonly resourceId: Property["resourceId"];
+	readonly dataSourceResourceId: string;
+	readonly name: string;
+	readonly propertyType: Property["type"];
+};
+
+export type DataSourceProperties<Schema extends NotionAsCodeSchema> = {
+	readonly [Name in keyof Schema]: PropertyHandle<Schema[Name]>;
+};
+
 /** A source handle retains its keyed authoring schema for sync inference. */
 export type DataSourceHandle<Schema extends NotionAsCodeSchema = NotionAsCodeSchema> = {
 	readonly resourceType: "dataSource";
@@ -125,6 +139,7 @@ export type DataSourceHandle<Schema extends NotionAsCodeSchema = NotionAsCodeSch
 	readonly name: string;
 	readonly description?: string;
 	readonly schema: Schema;
+	readonly properties: DataSourceProperties<Schema>;
 	readonly database: Database<AppsSchemaForSchema<Schema>>;
 	addPage: (args: ChildPageArgs) => PageHandle;
 };
@@ -501,6 +516,7 @@ function createDataSourceHandle(
 	schema: NotionAsCodeSchema,
 	databaseDescription: string | undefined,
 ): DataSourceHandle {
+	const propertyEntries: Array<[string, PropertyHandle]> = [];
 	const propertyResourceIds = new Set<string>();
 	const propertyNames = new Set<string>();
 	for (const property of dataSource.properties) {
@@ -517,6 +533,16 @@ function createDataSourceHandle(
 		}
 		propertyResourceIds.add(property.resourceId);
 		propertyNames.add(property.name);
+		propertyEntries.push([
+			property.name,
+			{
+				resourceType: "property",
+				resourceId: property.resourceId,
+				dataSourceResourceId: dataSource.resourceId,
+				name: property.name,
+				propertyType: property.type,
+			},
+		]);
 	}
 	const description = dataSource.description ?? databaseDescription;
 
@@ -526,6 +552,7 @@ function createDataSourceHandle(
 		name: dataSource.name,
 		...(description === undefined ? {} : { description }),
 		schema,
+		properties: Object.fromEntries(propertyEntries),
 		database: createAppsDatabase(dataSource.resourceId, dataSource),
 		addPage(pageArgs) {
 			return createPage(pageArgs, { type: "resourceId", resourceId: dataSource.resourceId });

package/src/notion-as-code/index.ts

@@ -62,6 +62,8 @@ export type {
 	ChildSingleSourceDatabaseArgs,
 	DataSourceArgs,
 	DataSourceHandle,
+	DataSourceProperties,
+	PropertyHandle,
 	DataSourceMap,
 	DatabaseArgs,
 	DatabaseHandle,

package/src/notion-as-code/recurrence.ts

@@ -0,0 +1,58 @@
+type RecurrenceWeekday = "MO" | "TU" | "WE" | "TH" | "FR" | "SA" | "SU";
+
+/** A nonempty selection of weekdays for a weekly recurrence. */
+export type RecurrenceWeekdays = {
+	[Day in RecurrenceWeekday]?: true;
+} & {
+	[Day in RecurrenceWeekday]: Required<Pick<Record<RecurrenceWeekday, true>, Day>>;
+}[RecurrenceWeekday];
+
+export type MonthlyWeekdayOccurrence = "1st" | "2nd" | "3rd" | "4th" | "last";
+
+export type MonthlyRecurrenceRestriction =
+	| { type: "day_of_month"; day: number }
+	| {
+			type: "weekday_of_month";
+			weekday: RecurrenceWeekday;
+			occurrence: MonthlyWeekdayOccurrence;
+	  };
+
+export type RecurrenceScheduleEnd =
+	| { type: "date"; endsAt: string }
+	| { type: "occurrences"; count: number };
+
+type RecurrenceScheduleBase = {
+	interval: number;
+	start: string;
+	timeZone: string;
+	end?: RecurrenceScheduleEnd;
+};
+
+export type HourlyRecurrenceSchedule = RecurrenceScheduleBase & {
+	frequency: "hour";
+};
+
+export type DailyRecurrenceSchedule = RecurrenceScheduleBase & {
+	frequency: "day";
+};
+
+export type WeeklyRecurrenceSchedule = RecurrenceScheduleBase & {
+	frequency: "week";
+	weekdays: RecurrenceWeekdays;
+};
+
+export type MonthlyRecurrenceSchedule = RecurrenceScheduleBase & {
+	frequency: "month";
+	monthlyRestriction: MonthlyRecurrenceRestriction;
+};
+
+export type YearlyRecurrenceSchedule = RecurrenceScheduleBase & {
+	frequency: "year";
+};
+
+export type RecurrenceSchedule =
+	| HourlyRecurrenceSchedule
+	| DailyRecurrenceSchedule
+	| WeeklyRecurrenceSchedule
+	| MonthlyRecurrenceSchedule
+	| YearlyRecurrenceSchedule;

package/src/workflow-access-types.test.ts

@@ -3,7 +3,7 @@ import { expectTypeOf, it } from "vitest";
 import { customAgent } from "./notion-as-code/custom-agent.js";
 import { database } from "./notion-as-code/database.js";
 import { page } from "./notion-as-code/page.js";
-import { triggers } from "./triggers.generated.js";
+import { events } from "./events.generated.js";
 import { access, workflow } from "./workflow.js";
 
 it("infers access aliases and rejects resource-specific levels", () => {
@@ -26,7 +26,7 @@ it("infers access aliases and rejects resource-specific levels", () => {
 	workflow({
 		name: "Access types",
 		description: "Checks access types",
-		triggers: [triggers.notionPageCreated()],
+		triggers: [events.notionPageCreated()],
 		access: {
 			home: access.view(home),
 			singleDatabase: access.edit(singleDatabase),
@@ -54,7 +54,7 @@ it("infers access aliases and rejects resource-specific levels", () => {
 		workflow({
 			name: "Agent access types",
 			description: "Checks custom agent access types",
-			triggers: [triggers.notionPageCreated()],
+			triggers: [events.notionPageCreated()],
 			// @ts-expect-error Custom agents only support the call level.
 			access: { agent: { resource: agent, level: "view" } },
 			handler: () => {},
@@ -63,7 +63,7 @@ it("infers access aliases and rejects resource-specific levels", () => {
 		workflow({
 			name: "Page access types",
 			description: "Checks page access types",
-			triggers: [triggers.notionPageCreated()],
+			triggers: [events.notionPageCreated()],
 			// @ts-expect-error Pages do not support the custom-agent call level.
 			access: { home: { resource: home, level: "call" } },
 			handler: () => {},

package/src/workflow-connections-types.test.ts

@@ -1,5 +1,5 @@
 import { expectTypeOf, it } from "vitest";
-import { triggers } from "./triggers.generated.js";
+import { events } from "./events.generated.js";
 import { connections, workflow, type WorkflowConnectionDeclarations } from "./workflow.js";
 
 it("infers only the declared provider clients", () => {
@@ -7,7 +7,7 @@ it("infers only the declared provider clients", () => {
 		name: "Mail",
 		description: "Read the configured mailbox",
 		connections: { inbox: connections.mail() },
-		triggers: ({ triggers }) => [triggers.mailEmailReceived({ connectionKey: "inbox" })],
+		triggers: ({ events }) => [events.mailEmailReceived({ connectionKey: "inbox" })],
 		handler(_event, context) {
 			expectTypeOf<keyof typeof context.connections>().toEqualTypeOf<"inbox">();
 			expectTypeOf(context.connections.inbox.searchEmails).toBeFunction();
@@ -19,7 +19,7 @@ it("infers only the declared provider clients", () => {
 	workflow({
 		name: "Calendar",
 		description: "Calendar only",
-		triggers: [triggers.notionPageCreated()],
+		triggers: [events.notionPageCreated()],
 		connections: { work: connections.calendar() },
 		handler(_event, context) {
 			expectTypeOf<keyof typeof context.connections>().toEqualTypeOf<"work">();
@@ -37,7 +37,7 @@ it("infers only the declared provider clients", () => {
 	workflow({
 		name: "Multiple providers",
 		description: "Preserves clients in a separately declared object",
-		triggers: [triggers.notionPageCreated()],
+		triggers: [events.notionPageCreated()],
 		connections: requirements,
 		handler(_event, context) {
 			expectTypeOf<keyof typeof context.connections>().toEqualTypeOf<
@@ -51,7 +51,7 @@ it("exposes no providers for omitted or empty connections", () => {
 	workflow({
 		name: "No connections",
 		description: "Omitted",
-		triggers: [triggers.notionPageCreated()],
+		triggers: [events.notionPageCreated()],
 		handler(_event, context) {
 			expectTypeOf<keyof typeof context.connections>().toEqualTypeOf<never>();
 		},
@@ -59,7 +59,7 @@ it("exposes no providers for omitted or empty connections", () => {
 	workflow({
 		name: "No connections",
 		description: "Empty",
-		triggers: [triggers.notionPageCreated()],
+		triggers: [events.notionPageCreated()],
 		connections: {},
 		handler(_event, context) {
 			expectTypeOf<keyof typeof context.connections>().toEqualTypeOf<never>();
@@ -72,7 +72,7 @@ it("preserves literal declarations checked with satisfies", () => {
 	workflow({
 		name: "Slack",
 		description: "Slack only",
-		triggers: [triggers.notionPageCreated()],
+		triggers: [events.notionPageCreated()],
 		connections: requirements,
 		handler(_event, context) {
 			expectTypeOf<keyof typeof context.connections>().toEqualTypeOf<"support">();