@notionhq/custom-blocks-host 0.3.3 → 0.3.5

package/src/lifecycle/legacyPage.ts

@@ -0,0 +1,183 @@
+import type { NotionDataSourcePageBridge } from "@notionhq/custom-blocks-protocol/dataSources/dataSourcePage.js"
+import type { NotionDataSourceValue } from "@notionhq/custom-blocks-protocol/dataSources/dataSourceValue.js"
+import type { NotionPagePropertyValue } from "@notionhq/custom-blocks-protocol/pages/page.js"
+import { unreachable } from "../utils.js"
+
+export function toLegacyQueryPage(page: NotionDataSourcePageBridge) {
+	const propertiesById: Record<string, NotionDataSourceValue | undefined> = {}
+	for (const property of Object.values(page.properties)) {
+		if (property) {
+			propertiesById[property.id] = toLegacyProperty(property)
+		}
+	}
+	return {
+		id: page.id,
+		is_archived: page.is_archived,
+		in_trash: page.in_trash,
+		propertiesById,
+	}
+}
+
+function plainText(items: Record<string, unknown>[]): string {
+	return items
+		.map(item => {
+			if (typeof item.plain_text === "string") {
+				return item.plain_text
+			}
+			const text = item.text
+			return text &&
+				typeof text === "object" &&
+				"content" in text &&
+				typeof text.content === "string"
+				? text.content
+				: ""
+		})
+		.join("")
+}
+
+function timestamp(
+	value: string | number | null | undefined,
+): NotionDataSourceValue | undefined {
+	if (value === undefined || value === null || value === "") {
+		return undefined
+	}
+	const date = new Date(value)
+	if (!Number.isFinite(date.getTime())) {
+		return undefined
+	}
+	return {
+		type: "datetime",
+		start_date: date.toISOString().slice(0, 10),
+		start_time: date.toISOString().slice(11, 16),
+		time_zone: "UTC",
+	}
+}
+
+function legacyDate(value: {
+	start: string
+	end?: string | null
+	time_zone?: string | null
+}): NotionDataSourceValue {
+	const timed = value.start.includes("T") || value.time_zone != null
+	const offset = value.start.match(/([+-])(\d{2}):(\d{2})$/)
+	const offsetMinutes = offset
+		? (Number(offset[2]) * 60 + Number(offset[3])) *
+			(offset[1] === "-" ? -1 : 1)
+		: 0
+	const parts = (input: string) => {
+		if (!input.includes("T")) {
+			return { date: input, time: "00:00" }
+		}
+		const wallClock = input.match(
+			/^(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2})(?::\d{2}(?:\.\d+)?)?$/,
+		)
+		if (wallClock) {
+			return { date: wallClock[1], time: wallClock[2] }
+		}
+		if (!value.time_zone) {
+			const local = new Date(
+				new Date(input).getTime() + offsetMinutes * 60_000,
+			).toISOString()
+			return { date: local.slice(0, 10), time: local.slice(11, 16) }
+		}
+		const entries = new Intl.DateTimeFormat("en-CA", {
+			timeZone: value.time_zone,
+			year: "numeric",
+			month: "2-digit",
+			day: "2-digit",
+			hour: "2-digit",
+			minute: "2-digit",
+			hourCycle: "h23",
+		}).formatToParts(new Date(input))
+		const get = (type: string) =>
+			entries.find(part => part.type === type)?.value
+		return {
+			date: `${get("year")}-${get("month")}-${get("day")}`,
+			time: `${get("hour")}:${get("minute")}`,
+		}
+	}
+	const start = parts(value.start)
+	const end = value.end ? parts(value.end) : undefined
+	if (!timed) {
+		return end
+			? { type: "daterange", start_date: start.date, end_date: end.date }
+			: { type: "date", start_date: start.date }
+	}
+	const zone =
+		value.time_zone ??
+		(offsetMinutes === 0
+			? "UTC"
+			: `UTC${offsetMinutes < 0 ? "-" : "+"}${Math.floor(Math.abs(offsetMinutes) / 60)}${Math.abs(offsetMinutes) % 60 === 0 ? "" : `:${String(Math.abs(offsetMinutes) % 60).padStart(2, "0")}`}`)
+	return end
+		? {
+				type: "datetimerange",
+				start_date: start.date,
+				start_time: start.time,
+				end_date: end.date,
+				end_time: end.time,
+				time_zone: zone,
+			}
+		: {
+				type: "datetime",
+				start_date: start.date,
+				start_time: start.time,
+				time_zone: zone,
+			}
+}
+
+function toLegacyProperty(
+	property: NotionPagePropertyValue,
+): NotionDataSourceValue | undefined {
+	switch (property.type) {
+		case "title":
+			return plainText(property.title)
+		case "rich_text":
+			return plainText(property.rich_text)
+		case "number":
+			return property.number ?? undefined
+		case "checkbox":
+			return property.checkbox
+		case "url":
+			return property.url ?? ""
+		case "email":
+			return property.email ?? ""
+		case "phone_number":
+			return property.phone_number ?? ""
+		case "select":
+			return property.select?.name
+		case "status":
+			return property.status?.name
+		case "multi_select":
+			return property.multi_select.flatMap(option => option.name ?? [])
+		case "date":
+			return property.date ? legacyDate(property.date) : undefined
+		case "people":
+			return property.people.map(person =>
+				person.object === "group"
+					? {
+							id: person.id,
+							table: "space_permission_group",
+							spaceId: person.id.split("|")[1],
+						}
+					: { id: person.id, table: "notion_user" },
+			)
+		case "relation":
+			return property.relation.map(page => ({ id: page.id, table: "block" }))
+		case "files":
+			return property.files.map(file => file.name).join(",")
+		case "place":
+			return ""
+		case "created_time":
+			return timestamp(property.created_time)
+		case "last_edited_time":
+			return timestamp(property.last_edited_time)
+		case "last_visited_time":
+			return timestamp(property.last_visited_time)
+		case "created_by":
+			return property.created_by ? [property.created_by] : undefined
+		case "last_edited_by":
+			return property.last_edited_by ? [property.last_edited_by] : undefined
+		default:
+			return unreachable(property)
+	}
+}

package/src/lifecycle/normalizeHostToSandboxMessage.ts

@@ -1,46 +1,18 @@
-import { NOTION_BUILTIN_PROPERTY_SCHEMAS } from "@notionhq/custom-blocks-protocol/dataSources/propertySchema.js"
-import type { HostToSandboxMessage } from "@notionhq/custom-blocks-protocol/messages/hostToSandbox.js"
+import type {
+	HostToSandboxMessage,
+	HostToSandboxMessageLegacy,
+} from "@notionhq/custom-blocks-protocol/messages/hostToSandbox.js"
+import { normalizeQueryPage } from "./normalizeQueryPage.js"
 
 /**
  * Normalizes an outgoing message for the bridge protocol version requested by the sandbox.
  */
 // TODO(custom-blocks): Remove this function when MIN_HOST_SUPPORTED_BRIDGE_PROTOCOL_VERSION
-// reaches 5.
+// reaches 6.
 export function normalizeHostToSandboxMessage(
 	message: HostToSandboxMessage,
 	bridgeProtocolVersion: number,
-): HostToSandboxMessage {
-	// The latest SDK version does not need any normalization.
-	if (bridgeProtocolVersion >= 5) {
-		return message
-	}
-	const containsDataSources =
-		(message.type === "init" && message.status === "success") ||
-		message.type === "dataSourcesChanged"
-	if (!containsDataSources) {
-		return message
-	}
-	// Protocol 5 excludes synthetic IDs such as created_time from collectionSchema.propertiesById.
-	// Older SDKs derive read schemas from that map. Restore those entries in outgoing copies so
-	// host query validation still uses the actual database schema.
-	return {
-		...message,
-		dataSources: {
-			bindings: Object.fromEntries(
-				Object.entries(message.dataSources.bindings).map(([key, binding]) => [
-					key,
-					{
-						...binding,
-						collectionSchema: {
-							...binding.collectionSchema,
-							propertiesById: {
-								...binding.collectionSchema?.propertiesById,
-								...NOTION_BUILTIN_PROPERTY_SCHEMAS,
-							},
-						},
-					},
-				]),
-			),
-		},
-	}
+): HostToSandboxMessageLegacy {
+	const normalizedMessage = normalizeQueryPage(message, bridgeProtocolVersion)
+	return normalizedMessage
 }

package/src/lifecycle/normalizeQueryPage.ts

@@ -0,0 +1,25 @@
+import type {
+	HostToSandboxMessage,
+	HostToSandboxMessageLegacy,
+} from "@notionhq/custom-blocks-protocol/messages/hostToSandbox.js"
+import { LEGACY_PROPERTY_SHAPE_PROTOCOL_VERSION } from "@notionhq/custom-blocks-protocol/protocolVersion.js"
+import { toLegacyQueryPage } from "./legacyPage.js"
+
+export function normalizeQueryPage(
+	message: HostToSandboxMessageLegacy | HostToSandboxMessage,
+	bridgeProtocolVersion: number,
+): HostToSandboxMessageLegacy {
+	if (
+		bridgeProtocolVersion < LEGACY_PROPERTY_SHAPE_PROTOCOL_VERSION &&
+		message.type === "queryDataSourceResult" &&
+		message.status === "success"
+	) {
+		return {
+			...message,
+			items: message.items.map(page =>
+				"properties" in page ? toLegacyQueryPage(page) : page,
+			),
+		}
+	}
+	return message
+}

package/src/messages/parseExternalUrl.ts

@@ -0,0 +1,18 @@
+const MAX_EXTERNAL_URL_LENGTH = 2048
+
+/** Returns a normalized, credential-free HTTP or HTTPS URL. */
+export function parseExternalUrl(input: string): string | undefined {
+	if (input.length > MAX_EXTERNAL_URL_LENGTH || !URL.canParse(input)) {
+		return undefined
+	}
+	const parsed = new URL(input)
+	if (
+		(parsed.protocol !== "http:" && parsed.protocol !== "https:") ||
+		parsed.username !== "" ||
+		parsed.password !== "" ||
+		parsed.href.length > MAX_EXTERNAL_URL_LENGTH
+	) {
+		return undefined
+	}
+	return parsed.href
+}

package/src/messages/sandboxMessageRouter.ts

@@ -6,6 +6,7 @@ import type { InitResultMessage } from "@notionhq/custom-blocks-protocol/message
 import type { InvalidSandboxMessage } from "@notionhq/custom-blocks-protocol/messages/invalidSandboxMessage.js"
 import { isInitHandshakeMessage } from "@notionhq/custom-blocks-protocol/messages/isInitHandshakeMessage.js"
 import type { ListUsersMessage } from "@notionhq/custom-blocks-protocol/messages/listUsers.js"
+import type { OpenExternalUrlMessage } from "@notionhq/custom-blocks-protocol/messages/openExternalUrl.js"
 import type { OpenPageMessage } from "@notionhq/custom-blocks-protocol/messages/openPage.js"
 import type { QueryDataSourceMessage } from "@notionhq/custom-blocks-protocol/messages/queryDataSource.js"
 import type { ResizeMessage } from "@notionhq/custom-blocks-protocol/messages/resize.js"
@@ -49,6 +50,7 @@ export type SandboxMessageRouterOptions = {
 	) => void
 	onCreatePage: (message: CreatePageMessage) => void | Promise<void>
 	onOpenPage: (message: OpenPageMessage) => void | Promise<void>
+	onOpenExternalUrl: (message: OpenExternalUrlMessage) => void | Promise<void>
 	onGetPage: (message: GetPageMessage) => void | Promise<void>
 	onGetUser: (message: GetUserMessage) => void | Promise<void>
 	onListUsers: (message: ListUsersMessage) => void | Promise<void>
@@ -74,6 +76,7 @@ export function createSandboxMessageRouter(
 		onCreatePage,
 		onGetPage,
 		onOpenPage,
+		onOpenExternalUrl,
 		onGetUser,
 		onListUsers,
 		onUpdatePage,
@@ -86,7 +89,7 @@ export function createSandboxMessageRouter(
 	) {
 		emit("warn", {
 			message: "Ignored unsupported sandbox message",
-			payload: data,
+			payload: redactExternalUrl(data),
 			issues,
 		})
 		const response = getInvalidSandboxMessageResponse(data)
@@ -145,12 +148,12 @@ export function createSandboxMessageRouter(
 		if (!isInitHandshakeMessage(message) && getInitStatus() !== "initialized") {
 			emit("warn", {
 				message: `Ignored ${message.type} before initialization completed`,
-				payload: message,
+				payload: redactExternalUrl(message),
 			})
 			return
 		}
 
-		emit("in", message)
+		emit("in", redactExternalUrl(message))
 		switch (message.type) {
 			case "connect":
 				onConnect(message)
@@ -170,6 +173,9 @@ export function createSandboxMessageRouter(
 			case "openPage":
 				void onOpenPage(message)
 				return
+			case "openExternalUrl":
+				void onOpenExternalUrl(message)
+				return
 			case "getPage":
 				void onGetPage(message)
 				return
@@ -193,3 +199,18 @@ export function createSandboxMessageRouter(
 		}
 	}
 }
+
+function redactExternalUrl(data: unknown): unknown {
+	if (
+		typeof data === "object" &&
+		data !== null &&
+		"type" in data &&
+		data.type === "openExternalUrl"
+	) {
+		return {
+			type: "openExternalUrl",
+			...("requestId" in data ? { requestId: data.requestId } : {}),
+		}
+	}
+	return data
+}

package/src/messages/types.ts

@@ -26,6 +26,12 @@ import type {
 	listUsersResultMessageSchema,
 } from "@notionhq/custom-blocks-protocol/messages/listUsers.js"
 import type { BridgeMessagePayload } from "@notionhq/custom-blocks-protocol/messages/messagePayload.js"
+import type {
+	CustomBlockOpenExternalUrlErrorInfo,
+	OpenExternalUrlMessage,
+	OpenExternalUrlResultMessage,
+	openExternalUrlMessageSchema,
+} from "@notionhq/custom-blocks-protocol/messages/openExternalUrl.js"
 import type {
 	CustomBlockOpenPageErrorInfo,
 	OpenPageMessage,
@@ -88,6 +94,15 @@ export type CustomBlockHostOpenPageResult = BridgeMessagePayload<
 	CustomBlockOpenPageErrorInfo
 >
 
+export type CustomBlockHostOpenExternalUrlResult = BridgeMessagePayload<
+	OpenExternalUrlResultMessage,
+	CustomBlockOpenExternalUrlErrorInfo
+>
+
+export type CustomBlockHostNavigationContext = {
+	signal: AbortSignal
+}
+
 export type CustomBlockHostHandlers = {
 	queryDataSource: (
 		message: QueryDataSourceMessage,
@@ -107,6 +122,10 @@ export type CustomBlockHostHandlers = {
 	openPage?: (
 		message: OpenPageMessage,
 	) => MaybePromise<CustomBlockHostOpenPageResult>
+	openExternalUrl?: (
+		message: OpenExternalUrlMessage,
+		context: CustomBlockHostNavigationContext,
+	) => MaybePromise<CustomBlockHostOpenExternalUrlResult>
 	updatePage?: (
 		message: UpdatePageMessage,
 	) => MaybePromise<CustomBlockHostUpdatePageResult>
@@ -139,6 +158,10 @@ export type ListUsersMessageInput = InferInput<typeof listUsersMessageSchema>
 
 export type OpenPageMessageInput = InferInput<typeof openPageMessageSchema>
 
+export type OpenExternalUrlMessageInput = InferInput<
+	typeof openExternalUrlMessageSchema
+>
+
 export type QueryDataSourceMessageInput = InferInput<
 	typeof queryDataSourceMessageSchema
 >