@notionhq/custom-blocks-host 0.1.8 → 0.1.10

package/src/lifecycle/types.ts

@@ -34,7 +34,11 @@ export type CustomBlockHostInitialState = {
 	blockId: NotionBlockId
 	parent: NotionParent
 	page: CustomBlockPage
-	manifest: CustomBlockManifest
+	/**
+	 * The host's persisted manifest, when one exists. If omitted, the host
+	 * requires the sandbox to provide a manifest in `connect`.
+	 */
+	manifest?: CustomBlockManifest
 	dataSources: CustomBlockHostInitialDataSources
 	currentUser: NotionUser
 }

package/src/messages/invalidSandboxMessage.ts

@@ -1,4 +1,4 @@
-import { readIncomingType } from "@notionhq/custom-blocks-protocol/incomingType.js"
+import { readIncomingType } from "@notionhq/custom-blocks-protocol/messages/incomingType.js"
 import type { InvalidSandboxMessage } from "@notionhq/custom-blocks-protocol/messages/invalidSandboxMessage.js"
 
 export type InvalidSandboxMessageResponse = {

package/src/messages/sandboxMessageRouter.ts

@@ -0,0 +1,176 @@
+import type { ConnectMessage } from "@notionhq/custom-blocks-protocol/messages/connect.js"
+import type { CreatePageMessage } from "@notionhq/custom-blocks-protocol/messages/createPage.js"
+import type { GetPageMessage } from "@notionhq/custom-blocks-protocol/messages/getPage.js"
+import type { GetUserMessage } from "@notionhq/custom-blocks-protocol/messages/getUser.js"
+import type { HostToSandboxMessage } from "@notionhq/custom-blocks-protocol/messages/hostToSandbox.js"
+import type { InitResultMessage } from "@notionhq/custom-blocks-protocol/messages/initResult.js"
+import { isInitHandshakeMessage } from "@notionhq/custom-blocks-protocol/messages/isInitHandshakeMessage.js"
+import type { ListUsersMessage } from "@notionhq/custom-blocks-protocol/messages/listUsers.js"
+import type { QueryDataSourceMessage } from "@notionhq/custom-blocks-protocol/messages/queryDataSource.js"
+import type { ResizeMessage } from "@notionhq/custom-blocks-protocol/messages/resize.js"
+import { sandboxToHostMessageSchema } from "@notionhq/custom-blocks-protocol/messages/sandboxToHost.js"
+import type { UnsubscribeDataSourceQueryMessage } from "@notionhq/custom-blocks-protocol/messages/unsubscribeDataSourceQuery.js"
+import type { UpdatePageMessage } from "@notionhq/custom-blocks-protocol/messages/updatePage.js"
+import * as v from "valibot"
+import { initErrorForFailureReason } from "../lifecycle/initErrors.js"
+import type { InitializationController } from "../lifecycle/initializationController.js"
+import type { InitStatus } from "../lifecycle/types.js"
+import { unreachable } from "../utils.js"
+import { getInvalidSandboxMessageResponse } from "./invalidSandboxMessage.js"
+import type { CustomBlockHostLogDirection } from "./types.js"
+
+const initializationIdentitySchema = v.object({
+	initializationId: v.string(),
+})
+
+export type SandboxMessageRouterOptions = {
+	iframe: HTMLIFrameElement
+	sandboxOrigin: string
+	getInitStatus: () => InitStatus
+	emit: (direction: CustomBlockHostLogDirection, payload: unknown) => void
+	post: (message: HostToSandboxMessage) => void
+	onInvalidConnect: InitializationController["handleInvalidConnect"]
+	onInvalidInitResult: InitializationController["handleInvalidInitResult"]
+	onConnect: (message: ConnectMessage) => void
+	onInitResult: (message: InitResultMessage) => void
+	onQueryDataSource: (message: QueryDataSourceMessage) => void | Promise<void>
+	onUnsubscribeDataSourceQuery: (
+		message: UnsubscribeDataSourceQueryMessage,
+	) => void
+	onCreatePage: (message: CreatePageMessage) => void | Promise<void>
+	onGetPage: (message: GetPageMessage) => void | Promise<void>
+	onGetUser: (message: GetUserMessage) => void | Promise<void>
+	onListUsers: (message: ListUsersMessage) => void | Promise<void>
+	onUpdatePage: (message: UpdatePageMessage) => void | Promise<void>
+	onResize: (message: ResizeMessage) => void
+}
+
+export function createSandboxMessageRouter(
+	options: SandboxMessageRouterOptions,
+): (event: MessageEvent) => void {
+	const {
+		iframe,
+		sandboxOrigin,
+		getInitStatus,
+		emit,
+		post,
+		onInvalidConnect,
+		onInvalidInitResult,
+		onConnect,
+		onInitResult,
+		onQueryDataSource,
+		onUnsubscribeDataSourceQuery,
+		onCreatePage,
+		onGetPage,
+		onGetUser,
+		onListUsers,
+		onUpdatePage,
+		onResize,
+	} = options
+
+	function onInvalidSandboxMessage(
+		data: unknown,
+		issues: readonly v.BaseIssue<unknown>[],
+	) {
+		emit("warn", {
+			message: "Ignored unsupported sandbox message",
+			payload: data,
+			issues,
+		})
+		const response = getInvalidSandboxMessageResponse(data)
+
+		if (response.incomingType === "connect") {
+			const parsedIdentity = v.safeParse(initializationIdentitySchema, data)
+			if (parsedIdentity.success) {
+				const responseType = onInvalidConnect({
+					initializationId: parsedIdentity.output.initializationId,
+					error: initErrorForFailureReason("invalid_connect_payload"),
+				})
+				if (responseType === "initErrorSent") {
+					// The controller already sent `init.error`, so no need to also send a NACK.
+					return
+				}
+			}
+		}
+
+		if (response.incomingType === "initResult") {
+			const parsedIdentity = v.safeParse(initializationIdentitySchema, data)
+			onInvalidInitResult({
+				initializationId: parsedIdentity.success
+					? parsedIdentity.output.initializationId
+					: undefined,
+				error: initErrorForFailureReason("invalid_init_result_payload"),
+			})
+		}
+
+		// Other messages get NACKed indicating they were invalid and skipped
+		if (response.nack !== undefined) {
+			post(response.nack)
+		}
+	}
+
+	return function onMessage(event: MessageEvent) {
+		// Verify the sender is this host's iframe, not another window with the same origin.
+		const isExpectedSource = event.source === iframe.contentWindow
+		// Verify the sender's origin, since the iframe can navigate to another origin.
+		const isExpectedOrigin = event.origin === sandboxOrigin
+		if (!isExpectedSource || !isExpectedOrigin) {
+			return
+		}
+
+		// Parse and validate the message from the sandbox.
+		const parsed = v.safeParse(sandboxToHostMessageSchema, event.data)
+		if (!parsed.success) {
+			onInvalidSandboxMessage(event.data, parsed.issues)
+			return
+		}
+
+		const message = parsed.output
+		if (!isInitHandshakeMessage(message) && getInitStatus() !== "success") {
+			emit("warn", {
+				message: `Ignored ${message.type} before initialization completed`,
+				payload: message,
+			})
+			return
+		}
+
+		emit("in", message)
+		switch (message.type) {
+			case "connect":
+				onConnect(message)
+				return
+			case "initResult":
+				onInitResult(message)
+				return
+			case "queryDataSource":
+				void onQueryDataSource(message)
+				return
+			case "unsubscribeDataSourceQuery":
+				onUnsubscribeDataSourceQuery(message)
+				return
+			case "createPage":
+				void onCreatePage(message)
+				return
+			case "getPage":
+				void onGetPage(message)
+				return
+			case "getUser":
+				void onGetUser(message)
+				return
+			case "listUsers":
+				void onListUsers(message)
+				return
+			case "updatePage":
+				void onUpdatePage(message)
+				return
+			case "resize":
+				onResize(message)
+				return
+			case "invalidHostMessage":
+				// The inbound log records this rejection. Do not reply, to avoid an error-response loop.
+				return
+			default:
+				unreachable(message)
+		}
+	}
+}

package/src/messages/types.ts

@@ -1,4 +1,3 @@
-import type { BridgeMessagePayload } from "@notionhq/custom-blocks-protocol/messagePayload.js"
 import type { CreatePageMessage } from "@notionhq/custom-blocks-protocol/messages/createPage.js"
 import type {
 	CreatePageResultMessage,
@@ -21,6 +20,7 @@ import type {
 	ListUsersMessage,
 	ListUsersResultMessage,
 } from "@notionhq/custom-blocks-protocol/messages/listUsers.js"
+import type { BridgeMessagePayload } from "@notionhq/custom-blocks-protocol/messages/messagePayload.js"
 import type { QueryDataSourceMessage } from "@notionhq/custom-blocks-protocol/messages/queryDataSource.js"
 import type { ResizeMessage } from "@notionhq/custom-blocks-protocol/messages/resize.js"
 import type { UpdatePageMessage } from "@notionhq/custom-blocks-protocol/messages/updatePage.js"

package/src/queries/types.ts

@@ -1,4 +1,4 @@
-import type { BridgeMessagePayload } from "@notionhq/custom-blocks-protocol/messagePayload.js"
+import type { BridgeMessagePayload } from "@notionhq/custom-blocks-protocol/messages/messagePayload.js"
 import type {
 	CustomBlockQueryDataSourceErrorInfo,
 	QueryDataSourceResultMessage,