@notionhq/workers 0.6.0 → 0.7.0

package/src/block.ts

@@ -0,0 +1,525 @@
+// ============================================================================
+// Block Type Definitions
+// ============================================================================
+
+// Color types
+type ApiColor =
+	| "default"
+	| "gray"
+	| "brown"
+	| "orange"
+	| "yellow"
+	| "green"
+	| "blue"
+	| "purple"
+	| "pink"
+	| "red"
+	| "gray_background"
+	| "brown_background"
+	| "orange_background"
+	| "yellow_background"
+	| "green_background"
+	| "blue_background"
+	| "purple_background"
+	| "pink_background"
+	| "red_background";
+
+// Rich text annotations
+type RichTextAnnotations = {
+	bold: boolean;
+	italic: boolean;
+	strikethrough: boolean;
+	underline: boolean;
+	code: boolean;
+	color: ApiColor;
+};
+
+// Base rich text structure
+type RichTextBase = {
+	plain_text: string;
+	href: string | null;
+	annotations: RichTextAnnotations;
+};
+
+// Text content
+type TextContent = {
+	content: string;
+	link: { url: string } | null;
+};
+
+// Equation content
+type EquationContent = {
+	expression: string;
+};
+
+// Date mention
+type DateMention = {
+	type: "date";
+	date: {
+		start: string;
+		end?: string | null;
+		time_zone?: string | null;
+	};
+};
+
+// Custom emoji mention
+type CustomEmojiMention = {
+	type: "custom_emoji";
+	custom_emoji: {
+		id: string;
+		name?: string;
+		url?: string;
+	};
+};
+
+// Link preview mention
+type LinkPreviewMention = {
+	type: "link_preview";
+	link_preview: {
+		url: string;
+	};
+};
+
+// Link mention
+type LinkMention = {
+	type: "link_mention";
+	link_mention: {
+		href: string;
+	};
+};
+
+// All mention types
+type MentionContent = DateMention | CustomEmojiMention | LinkPreviewMention | LinkMention;
+
+// Rich text item
+type RichTextItem = RichTextBase &
+	(
+		| { type: "text"; text: TextContent }
+		| { type: "mention"; mention: MentionContent }
+		| { type: "equation"; equation: EquationContent }
+	);
+
+// Rich text array
+type RichText = RichTextItem[];
+
+// Icon types
+type EmojiIcon = {
+	type: "emoji";
+	emoji: string;
+};
+
+type ExternalIcon = {
+	type: "external";
+	external: { url: string };
+};
+
+type FileIcon = {
+	type: "file";
+	file: {
+		url: string;
+		expiry_time: string;
+	};
+};
+
+type Icon = EmojiIcon | ExternalIcon | FileIcon;
+
+// File object types
+type ExternalFile = {
+	type: "external";
+	external: {
+		url: string;
+	};
+};
+
+type HostedFile = {
+	type: "file";
+	file: {
+		url: string;
+		expiry_time: string;
+	};
+	name?: string;
+};
+
+type FileObject = ExternalFile | HostedFile;
+
+// Base block structure
+type BlockBase = {
+	object: "block";
+};
+
+// Text blocks
+type ParagraphBlock = BlockBase & {
+	type: "paragraph";
+	paragraph: {
+		rich_text: RichText;
+		color?: ApiColor;
+		children?: Block[];
+	};
+};
+
+type Heading1Block = BlockBase & {
+	type: "heading_1";
+	heading_1: {
+		rich_text: RichText;
+		color?: ApiColor;
+		is_toggleable?: boolean;
+		children?: Block[];
+	};
+};
+
+type Heading2Block = BlockBase & {
+	type: "heading_2";
+	heading_2: {
+		rich_text: RichText;
+		color?: ApiColor;
+		is_toggleable?: boolean;
+		children?: Block[];
+	};
+};
+
+type Heading3Block = BlockBase & {
+	type: "heading_3";
+	heading_3: {
+		rich_text: RichText;
+		color?: ApiColor;
+		is_toggleable?: boolean;
+		children?: Block[];
+	};
+};
+
+type BulletedListItemBlock = BlockBase & {
+	type: "bulleted_list_item";
+	bulleted_list_item: {
+		rich_text: RichText;
+		color?: ApiColor;
+		children?: Block[];
+	};
+};
+
+type NumberedListItemBlock = BlockBase & {
+	type: "numbered_list_item";
+	numbered_list_item: {
+		rich_text: RichText;
+		color?: ApiColor;
+		children?: Block[];
+	};
+};
+
+type ToDoBlock = BlockBase & {
+	type: "to_do";
+	to_do: {
+		rich_text: RichText;
+		checked: boolean;
+		color?: ApiColor;
+		children?: Block[];
+	};
+};
+
+type ToggleBlock = BlockBase & {
+	type: "toggle";
+	toggle: {
+		rich_text: RichText;
+		color?: ApiColor;
+		children?: Block[];
+	};
+};
+
+type QuoteBlock = BlockBase & {
+	type: "quote";
+	quote: {
+		rich_text: RichText;
+		color?: ApiColor;
+		children?: Block[];
+	};
+};
+
+type CalloutBlock = BlockBase & {
+	type: "callout";
+	callout: {
+		rich_text: RichText;
+		icon?: Icon | null;
+		color?: ApiColor;
+		children?: Block[];
+	};
+};
+
+// Code block
+type CodeBlock = BlockBase & {
+	type: "code";
+	code: {
+		rich_text: RichText;
+		caption?: RichText;
+		language: string;
+	};
+};
+
+// Equation block
+type EquationBlock = BlockBase & {
+	type: "equation";
+	equation: {
+		expression: string;
+	};
+};
+
+// Divider block
+type DividerBlock = BlockBase & {
+	type: "divider";
+	divider: Record<string, never>;
+};
+
+// Breadcrumb block
+type BreadcrumbBlock = BlockBase & {
+	type: "breadcrumb";
+	breadcrumb: Record<string, never>;
+};
+
+// Table of contents block
+type TableOfContentsBlock = BlockBase & {
+	type: "table_of_contents";
+	table_of_contents: {
+		color?: ApiColor;
+	};
+};
+
+// Column layout blocks
+type ColumnListBlock = BlockBase & {
+	type: "column_list";
+	column_list: {
+		children: ColumnBlock[];
+	};
+};
+
+type ColumnBlock = BlockBase & {
+	type: "column";
+	column: {
+		children?: Block[];
+	};
+};
+
+// Media blocks
+type ImageBlock = BlockBase & {
+	type: "image";
+	image: FileObject & {
+		caption?: RichText;
+	};
+};
+
+type VideoBlock = BlockBase & {
+	type: "video";
+	video: FileObject & {
+		caption?: RichText;
+	};
+};
+
+type AudioBlock = BlockBase & {
+	type: "audio";
+	audio: FileObject & {
+		caption?: RichText;
+	};
+};
+
+type PDFBlock = BlockBase & {
+	type: "pdf";
+	pdf: FileObject & {
+		caption?: RichText;
+	};
+};
+
+type FileBlock = BlockBase & {
+	type: "file";
+	file: FileObject & {
+		caption?: RichText;
+	};
+};
+
+// Embed and bookmark blocks
+type EmbedBlock = BlockBase & {
+	type: "embed";
+	embed: {
+		url: string;
+		caption?: RichText;
+	};
+};
+
+type BookmarkBlock = BlockBase & {
+	type: "bookmark";
+	bookmark: {
+		url: string;
+		caption?: RichText;
+	};
+};
+
+// Link preview block
+type LinkPreviewBlock = BlockBase & {
+	type: "link_preview";
+	link_preview: {
+		url: string;
+	};
+};
+
+// Reference blocks
+type ChildPageBlock = BlockBase & {
+	type: "child_page";
+	child_page: {
+		title: string;
+	};
+};
+
+type ChildDatabaseBlock = BlockBase & {
+	type: "child_database";
+	child_database: {
+		title: string;
+	};
+};
+
+// type LinkToPageBlock = BlockBase & {
+// 	type: "link_to_page"
+// 	link_to_page:
+// 		| { type: "page_id"; page_id: string }
+// 		| { type: "database_id"; database_id: string }
+// }
+
+// // Synced block
+// type SyncedBlock = BlockBase & {
+// 	type: "synced_block"
+// 	synced_block: {
+// 		synced_from: {
+// 			type: "block_id"
+// 			block_id: string
+// 		} | null
+// 		children?: Block[]
+// 	}
+// }
+
+// Template block
+type TemplateBlock = BlockBase & {
+	type: "template";
+	template: {
+		rich_text: RichText;
+		children?: Block[];
+	};
+};
+
+// Table blocks
+type TableBlock = BlockBase & {
+	type: "table";
+	table: {
+		table_width: number;
+		has_column_header: boolean;
+		has_row_header: boolean;
+		children: TableRowBlock[];
+	};
+};
+
+type TableRowBlock = BlockBase & {
+	type: "table_row";
+	table_row: {
+		cells: RichText[];
+	};
+};
+
+// AI block
+type AIBlock = BlockBase & {
+	type: "ai_block";
+	ai_block: {
+		prompt?: string;
+	};
+};
+
+// Unsupported block
+type UnsupportedBlock = BlockBase & {
+	type: "unsupported";
+	unsupported: Record<string, never>;
+};
+
+// All block types union
+type Block =
+	| ParagraphBlock
+	| Heading1Block
+	| Heading2Block
+	| Heading3Block
+	| BulletedListItemBlock
+	| NumberedListItemBlock
+	| ToDoBlock
+	| ToggleBlock
+	| QuoteBlock
+	| CalloutBlock
+	| CodeBlock
+	| EquationBlock
+	| DividerBlock
+	| BreadcrumbBlock
+	| TableOfContentsBlock
+	| ColumnListBlock
+	| ColumnBlock
+	| ImageBlock
+	| VideoBlock
+	| AudioBlock
+	| PDFBlock
+	| FileBlock
+	| EmbedBlock
+	| BookmarkBlock
+	| LinkPreviewBlock
+	| ChildPageBlock
+	| ChildDatabaseBlock
+	| TemplateBlock
+	| TableBlock
+	| TableRowBlock
+	| AIBlock
+	| UnsupportedBlock;
+
+// Export all types
+export type {
+	AIBlock,
+	ApiColor,
+	AudioBlock,
+	Block,
+	BlockBase,
+	BookmarkBlock,
+	BreadcrumbBlock,
+	BulletedListItemBlock,
+	CalloutBlock,
+	ChildDatabaseBlock,
+	ChildPageBlock,
+	CodeBlock,
+	ColumnBlock,
+	ColumnListBlock,
+	CustomEmojiMention,
+	DateMention,
+	DividerBlock,
+	EmbedBlock,
+	EmojiIcon,
+	EquationBlock,
+	EquationContent,
+	ExternalFile,
+	ExternalIcon,
+	FileBlock,
+	FileIcon,
+	FileObject,
+	Heading1Block,
+	Heading2Block,
+	Heading3Block,
+	HostedFile,
+	Icon,
+	ImageBlock,
+	LinkMention,
+	LinkPreviewBlock,
+	LinkPreviewMention,
+	MentionContent,
+	NumberedListItemBlock,
+	ParagraphBlock,
+	PDFBlock,
+	QuoteBlock,
+	RichText,
+	RichTextAnnotations,
+	RichTextBase,
+	RichTextItem,
+	TableBlock,
+	TableOfContentsBlock,
+	TableRowBlock,
+	TemplateBlock,
+	TextContent,
+	ToDoBlock,
+	ToggleBlock,
+	UnsupportedBlock,
+	VideoBlock,
+};

package/src/index.ts

@@ -1,10 +1,3 @@
-export type {
-	CustomBlockCapability,
-	CustomBlockCapabilityConfig,
-	CustomBlockConfiguration,
-	CustomBlockManifest,
-	CustomBlockManifestDataSource,
-} from "./capabilities/custom-block.js";
 export { emojiIcon, imageCover, imageIcon, notionIcon, place } from "./builder.js";
 export type {
 	AiConnectorArchetype,

package/src/worker.test.ts

@@ -141,153 +141,6 @@ describe("Worker", () => {
 		]);
 	});
 
-	it("registers a project custom block from a folder path (type defaults to project)", () => {
-		const worker = new Worker();
-
-		worker.customBlock("visualBlock", {
-			path: "./views/visual",
-		});
-
-		expect(worker.manifest.capabilities).toEqual([
-			{
-				_tag: "custom_block",
-				key: "visualBlock",
-				config: {
-					source: { type: "project", path: "./views/visual" },
-					manifest: {
-						version: 1,
-						dataSources: {},
-					},
-				},
-			},
-		]);
-	});
-
-	it("carries a project's custom build command and output dir", () => {
-		const worker = new Worker();
-
-		worker.customBlock("built", {
-			path: "./app",
-			command: "npm run build-prod",
-			output: "build",
-		});
-
-		expect(worker.manifest.capabilities).toEqual([
-			{
-				_tag: "custom_block",
-				key: "built",
-				config: {
-					source: {
-						type: "project",
-						path: "./app",
-						command: "npm run build-prod",
-						output: "build",
-					},
-					manifest: { version: 1, dataSources: {} },
-				},
-			},
-		]);
-	});
-
-	it("registers a static custom block served as-is", () => {
-		const worker = new Worker();
-
-		worker.customBlock("prebuilt", { type: "static", path: "./dist" });
-
-		expect(worker.manifest.capabilities).toEqual([
-			{
-				_tag: "custom_block",
-				key: "prebuilt",
-				config: {
-					source: { type: "static", path: "./dist" },
-					manifest: { version: 1, dataSources: {} },
-				},
-			},
-		]);
-	});
-
-	it("carries the author-declared data-source schema verbatim into the manifest", () => {
-		const worker = new Worker();
-
-		worker.customBlock("issueBoard", {
-			path: "./views/issueBoard",
-			dataSources: {
-				issues: {
-					name: "Issues",
-					description: "The team's issues",
-					icon: { type: "emoji", emoji: "🐛" },
-					properties: {
-						title: { name: "Title", type: "title" },
-						status: {
-							name: "Status",
-							description: "Workflow state",
-							type: "status",
-						},
-					},
-				},
-			},
-		});
-
-		expect(worker.manifest.capabilities).toEqual([
-			{
-				_tag: "custom_block",
-				key: "issueBoard",
-				config: {
-					source: { type: "project", path: "./views/issueBoard" },
-					manifest: {
-						version: 1,
-						dataSources: {
-							issues: {
-								name: "Issues",
-								description: "The team's issues",
-								icon: { type: "emoji", emoji: "🐛" },
-								properties: {
-									title: { name: "Title", type: "title" },
-									status: {
-										name: "Status",
-										description: "Workflow state",
-										type: "status",
-									},
-								},
-							},
-						},
-					},
-				},
-			},
-		]);
-	});
-
-	it("threads a top-level manifest version into the generated manifest", () => {
-		const worker = new Worker();
-
-		worker.customBlock("versioned", {
-			path: "./views/versioned",
-			version: 1,
-		});
-
-		expect(worker.manifest.capabilities).toEqual([
-			{
-				_tag: "custom_block",
-				key: "versioned",
-				config: {
-					source: { type: "project", path: "./views/versioned" },
-					manifest: { version: 1, dataSources: {} },
-				},
-			},
-		]);
-	});
-
-	it("cannot run a custom block capability", async () => {
-		const worker = new Worker();
-		worker.customBlock("visualBlock", {
-			path: "./views/visual",
-		});
-
-		await expect(worker.run("visualBlock", {})).rejects.toThrow(
-			'Cannot run custom block capability "visualBlock"',
-		);
-	});
-
 	it("rejects duplicate keys across databases, pacers, and capabilities", () => {
 		const worker = new Worker();
 		const db = worker.database("shared-key", {