@notionhq/apps 0.0.20 → 0.0.21

package/src/notion-as-code/notion-as-code-types.test.ts

@@ -0,0 +1,167 @@
+import { expectTypeOf, it } from "vitest";
+
+import type {
+	CustomAgentArgs,
+	CustomAgentPropertyUpdatedTrigger,
+	CustomAgentTrigger,
+	DatabasePageLayout,
+	NotionAsCodePropertyConfig,
+	PageArgs,
+	PageCoverReference,
+	PageLayoutPropertyModule,
+	SingleSourceDatabaseArgs,
+} from "./index.js";
+
+it("types page and database covers as URL references", () => {
+	expectTypeOf<{
+		type: "url";
+		url: "https://example.com/cover.png";
+		position: 0.25;
+	}>().toExtend<PageCoverReference>();
+	expectTypeOf<{
+		type: "external";
+		url: "https://example.com/cover.png";
+	}>().not.toExtend<PageCoverReference>();
+	expectTypeOf<PageArgs["cover"]>().toEqualTypeOf<PageCoverReference | undefined>();
+});
+
+it("requires configuration for each advanced property kind", () => {
+	expectTypeOf<{
+		type: "relation";
+		resourceId: "project";
+		targetDataSourceResourceId: "projects";
+		limit: 1;
+	}>().toExtend<NotionAsCodePropertyConfig>();
+	expectTypeOf<{
+		type: "relation";
+		resourceId: "project";
+	}>().not.toExtend<NotionAsCodePropertyConfig>();
+
+	expectTypeOf<{
+		type: "rollup";
+		resourceId: "total";
+		relationPropertyResourceId: "project";
+		targetPropertyResourceId: "estimate";
+		targetPropertyType: "number";
+		aggregation: "sum";
+	}>().toExtend<NotionAsCodePropertyConfig>();
+	expectTypeOf<{
+		type: "rollup";
+		resourceId: "invalid-total";
+		relationPropertyResourceId: "project";
+		targetPropertyResourceId: "name";
+		targetPropertyType: "title";
+		aggregation: "sum";
+	}>().not.toExtend<NotionAsCodePropertyConfig>();
+
+	expectTypeOf<{
+		type: "verification";
+		resourceId: "verification";
+		verifierPropertyResourceId: "owner";
+	}>().toExtend<NotionAsCodePropertyConfig>();
+	expectTypeOf<{
+		type: "verification";
+		resourceId: "verification";
+	}>().not.toExtend<NotionAsCodePropertyConfig>();
+});
+
+it("links page-layout property styles and relation groups to the data source schema", () => {
+	type Schema = {
+		Name: { type: "title"; resourceId: "name" };
+		Estimate: { type: "number"; resourceId: "estimate" };
+		Owner: { type: "person"; resourceId: "owner" };
+		Project: {
+			type: "relation";
+			resourceId: "project";
+			targetDataSourceResourceId: "projects";
+		};
+	};
+
+	expectTypeOf<{
+		type: "property";
+		property: "estimate";
+		style: "large";
+	}>().toExtend<PageLayoutPropertyModule<Schema>>();
+	expectTypeOf<{
+		type: "property";
+		property: "estimate";
+		style: "landscape";
+	}>().not.toExtend<PageLayoutPropertyModule<Schema>>();
+	expectTypeOf<{
+		type: "property";
+		property: "name";
+		style: "large";
+	}>().not.toExtend<PageLayoutPropertyModule<Schema>>();
+
+	type ValidLayout = {
+		main: [
+			{ type: "properties"; properties: [{ property: "name" }] },
+			{
+				type: "relations";
+				relations: [{ property: "project"; display: "pageSection" }];
+			},
+		];
+		pinnedProperties: ["owner"];
+	};
+	type InvalidRelationLayout = {
+		main: [
+			{ type: "properties"; properties: [{ property: "name" }] },
+			{
+				type: "relations";
+				relations: [{ property: "estimate"; display: "pageSection" }];
+			},
+		];
+	};
+	expectTypeOf<ValidLayout>().toExtend<DatabasePageLayout<Schema>>();
+	expectTypeOf<InvalidRelationLayout>().not.toExtend<DatabasePageLayout<Schema>>();
+
+	expectTypeOf<{
+		dataSourceResourceId: "tasks";
+		name: "Tasks";
+		schema: Schema;
+		pageLayout: ValidLayout;
+	}>().toExtend<SingleSourceDatabaseArgs<Schema>>();
+	expectTypeOf<{
+		dataSourceResourceId: "tasks";
+		name: "Tasks";
+		schema: Schema;
+		pageLayout: InvalidRelationLayout;
+	}>().not.toExtend<SingleSourceDatabaseArgs<Schema>>();
+});
+
+it("requires a meaningful custom agent trigger configuration", () => {
+	expectTypeOf<{
+		type: "recurrence";
+		resourceId: "weekday-trigger";
+		frequency: "week";
+		interval: 1;
+		start: "2026-09-21T09:00:00";
+		timeZone: "America/Los_Angeles";
+		weekdays: { MO: true; FR: true };
+	}>().toExtend<CustomAgentTrigger>();
+	expectTypeOf<{
+		type: "recurrence";
+		resourceId: "empty-weekdays";
+		frequency: "week";
+		interval: 1;
+		start: "2026-09-21T09:00:00";
+		timeZone: "America/Los_Angeles";
+		weekdays: {};
+	}>().not.toExtend<CustomAgentTrigger>();
+
+	expectTypeOf<{
+		type: "property_updated";
+		resourceId: "content-trigger";
+		dataSourceResourceId: "tasks";
+		triggerWhenPageContentEdited: true;
+	}>().toExtend<CustomAgentPropertyUpdatedTrigger>();
+	expectTypeOf<{
+		type: "property_updated";
+		resourceId: "empty-trigger";
+		dataSourceResourceId: "tasks";
+	}>().not.toExtend<CustomAgentPropertyUpdatedTrigger>();
+
+	expectTypeOf<CustomAgentArgs["triggers"]>().toEqualTypeOf<
+		readonly CustomAgentTrigger[] | undefined
+	>();
+});

package/src/notion-as-code/page.test.ts

@@ -4,6 +4,30 @@ import { notion, type PageArgs, type PropertyValue } from "./index.js";
 import { finishMetadataRecording, startMetadataRecording } from "./recorder.js";
 
 describe("Notion-as-Code page declarations", () => {
+	it("records typed URL covers", () => {
+		const recorder = startMetadataRecording();
+
+		notion.page({
+			resourceId: "url-cover-page",
+			cover: {
+				type: "url",
+				url: "https://example.com/cover.png",
+				position: 0.25,
+			},
+		});
+
+		expect(finishMetadataRecording(recorder).intents).toEqual([
+			expect.objectContaining({
+				resourceId: "url-cover-page",
+				cover: {
+					type: "url",
+					url: "https://example.com/cover.png",
+					position: 0.25,
+				},
+			}),
+		]);
+	});
+
 	it("records a regular page title separately from Markdown content", () => {
 		const properties = {
 			title: notion.text("Workflow guide"),

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

@@ -1,6 +1,7 @@
 import {
 	APPS_WORKSPACE_RESOURCE_ID,
 	type PageIntent,
+	type PageCoverReference,
 	type Parent,
 	type ResourceId,
 } from "./intents.js";
@@ -56,8 +57,7 @@ export type PageArgs = {
 	resourceId: ResourceId;
 	/** Omit to create a private top-level page in the Apps workspace. */
 	parent?: Parent;
-	// TODO: Port cover types.
-	cover?: unknown;
+	cover?: PageCoverReference;
 	/**
 	 * Page properties, including the page title.
 	 *