@notionhq/custom-blocks-host 0.1.28 → 0.1.30

package/dist/createCustomBlockHost.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createCustomBlockHost.d.ts","sourceRoot":"","sources":["../src/createCustomBlockHost.ts"],"names":[],"mappings":"AAAA,OAAO,EAEN,KAAK,kBAAkB,EACvB,MAAM,8CAA8C,CAAA;AAErD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yCAAyC,CAAA;AACjF,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8CAA8C,CAAA;AAavF,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,4DAA4D,CAAA;AAoBtG,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gDAAgD,CAAA;AACrF,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,4CAA4C,CAAA;AAE9E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,2CAA2C,CAAA;AAC5E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gDAAgD,CAAA;AAIhF,OAAO,KAAK,EACX,iCAAiC,EACjC,2BAA2B,EAC3B,MAAM,sBAAsB,CAAA;AAE7B,OAAO,KAAK,EACX,sBAAsB,EACtB,uBAAuB,EACvB,2BAA2B,EAC3B,MAAM,qBAAqB,CAAA;AAc5B,MAAM,MAAM,sBAAsB,GAAG;IACpC,MAAM,EAAE,iBAAiB,CAAA;IACzB,aAAa,EAAE,MAAM,CAAA;IACrB;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAA;IACjC,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B,YAAY,EAAE,2BAA2B,CAAA;IACzC,QAAQ,EAAE,uBAAuB,CAAA;IACjC;;;OAGG;IACH,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,mBAAmB,KAAK,IAAI,CAAA;IACpD,gGAAgG;IAChG,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE;QACvB,QAAQ,EAAE,mBAAmB,CAAA;QAC7B,aAAa,CAAC,EAAE,MAAM,CAAA;KACtB,KAAK,IAAI,CAAA;IACV;;;;;OAKG;IACH,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,sBAAsB,KAAK,IAAI,CAAA;IACnD,KAAK,CAAC,EAAE,CAAC,SAAS,EAAE,2BAA2B,EAAE,OAAO,EAAE,OAAO,KAAK,IAAI,CAAA;CAC1E,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IACnC,IAAI,EAAE,MAAM,IAAI,CAAA;IAChB,IAAI,EAAE,CAAC,OAAO,EAAE,oBAAoB,KAAK,IAAI,CAAA;IAC7C,QAAQ,EAAE,CAAC,KAAK,EAAE,WAAW,KAAK,IAAI,CAAA;IACtC,eAAe,EAAE,CAAC,YAAY,EAAE,kBAAkB,KAAK,IAAI,CAAA;IAC3D,SAAS,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,IAAI,CAAA;IACzC,OAAO,EAAE,CAAC,IAAI,EAAE,eAAe,KAAK,IAAI,CAAA;IACxC,cAAc,EAAE,CAAC,WAAW,EAAE,iCAAiC,KAAK,IAAI,CAAA;IACxE,cAAc,EAAE,CAAC,WAAW,EAAE,UAAU,KAAK,IAAI,CAAA;IACjD,YAAY,EAAE,CAAC,IAAI,EAAE;QAAE,YAAY,EAAE,kBAAkB,CAAA;KAAE,KAAK,IAAI,CAAA;CAClE,CAAA;AAED,wBAAgB,qBAAqB,CACpC,OAAO,EAAE,sBAAsB,GAC7B,qBAAqB,CA+avB"}
+{"version":3,"file":"createCustomBlockHost.d.ts","sourceRoot":"","sources":["../src/createCustomBlockHost.ts"],"names":[],"mappings":"AAAA,OAAO,EAEN,KAAK,kBAAkB,EACvB,MAAM,8CAA8C,CAAA;AAErD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yCAAyC,CAAA;AACjF,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8CAA8C,CAAA;AAGvF,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,4DAA4D,CAAA;AAYtG,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gDAAgD,CAAA;AACrF,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,4CAA4C,CAAA;AAE9E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,2CAA2C,CAAA;AAC5E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gDAAgD,CAAA;AAIhF,OAAO,KAAK,EACX,iCAAiC,EACjC,2BAA2B,EAC3B,MAAM,sBAAsB,CAAA;AAE7B,OAAO,KAAK,EACX,sBAAsB,EACtB,uBAAuB,EACvB,2BAA2B,EAC3B,MAAM,qBAAqB,CAAA;AAc5B,MAAM,MAAM,sBAAsB,GAAG;IACpC,MAAM,EAAE,iBAAiB,CAAA;IACzB,aAAa,EAAE,MAAM,CAAA;IACrB;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAA;IACjC,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B,YAAY,EAAE,2BAA2B,CAAA;IACzC,QAAQ,EAAE,uBAAuB,CAAA;IACjC;;;OAGG;IACH,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,mBAAmB,KAAK,IAAI,CAAA;IACpD,gGAAgG;IAChG,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE;QACvB,QAAQ,EAAE,mBAAmB,CAAA;QAC7B,aAAa,CAAC,EAAE,MAAM,CAAA;KACtB,KAAK,IAAI,CAAA;IACV;;;;;OAKG;IACH,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,sBAAsB,KAAK,IAAI,CAAA;IACnD,KAAK,CAAC,EAAE,CAAC,SAAS,EAAE,2BAA2B,EAAE,OAAO,EAAE,OAAO,KAAK,IAAI,CAAA;CAC1E,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IACnC,IAAI,EAAE,MAAM,IAAI,CAAA;IAChB,IAAI,EAAE,CAAC,OAAO,EAAE,oBAAoB,KAAK,IAAI,CAAA;IAC7C,QAAQ,EAAE,CAAC,KAAK,EAAE,WAAW,KAAK,IAAI,CAAA;IACtC,eAAe,EAAE,CAAC,YAAY,EAAE,kBAAkB,KAAK,IAAI,CAAA;IAC3D,SAAS,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,IAAI,CAAA;IACzC,OAAO,EAAE,CAAC,IAAI,EAAE,eAAe,KAAK,IAAI,CAAA;IACxC,cAAc,EAAE,CAAC,WAAW,EAAE,iCAAiC,KAAK,IAAI,CAAA;IACxE,cAAc,EAAE,CAAC,WAAW,EAAE,UAAU,KAAK,IAAI,CAAA;IACjD,YAAY,EAAE,CAAC,IAAI,EAAE;QAAE,YAAY,EAAE,kBAAkB,CAAA;KAAE,KAAK,IAAI,CAAA;CAClE,CAAA;AAyBD,wBAAgB,qBAAqB,CACpC,OAAO,EAAE,sBAAsB,GAC7B,qBAAqB,CAqXvB"}

package/dist/createCustomBlockHost.js

@@ -45,6 +45,22 @@ export function createCustomBlockHost(options) {
         emit("out", sandboxMessage);
         iframe.contentWindow?.postMessage(sandboxMessage, sandboxOrigin);
     }
+    /**
+     * Invokes a one-shot handler and posts its result with the request's ID.
+     * Each result type is named `<request type>Result` by the bridge protocol.
+     */
+    async function respondToRequest(message, handler) {
+        if (handler === undefined) {
+            return;
+        }
+        const response = await handler(message);
+        const result = {
+            type: `${message.type}Result`,
+            requestId: message.requestId,
+            ...response,
+        };
+        post(result);
+    }
     function postQueryDataSourceResult(args) {
         const message = args.response.status === "error"
             ? {
@@ -83,78 +99,6 @@ export function createCustomBlockHost(options) {
             response,
         });
     }
-    async function handleCreatePage(message) {
-        if (handlers.createPage === undefined) {
-            return;
-        }
-        const response = await handlers.createPage(message);
-        const result = {
-            type: "createPageResult",
-            requestId: message.requestId,
-            ...response,
-        };
-        post(result);
-    }
-    async function handleGetPage(message) {
-        if (handlers.getPage === undefined) {
-            return;
-        }
-        const response = await handlers.getPage(message);
-        const result = {
-            type: "getPageResult",
-            requestId: message.requestId,
-            ...response,
-        };
-        post(result);
-    }
-    async function handleGetUser(message) {
-        if (handlers.getUser === undefined) {
-            return;
-        }
-        const response = await handlers.getUser(message);
-        const result = {
-            type: "getUserResult",
-            requestId: message.requestId,
-            ...response,
-        };
-        post(result);
-    }
-    async function handleListUsers(message) {
-        if (handlers.listUsers === undefined) {
-            return;
-        }
-        const response = await handlers.listUsers(message);
-        const result = {
-            type: "listUsersResult",
-            requestId: message.requestId,
-            ...response,
-        };
-        post(result);
-    }
-    async function handleOpenPage(message) {
-        if (handlers.openPage === undefined) {
-            return;
-        }
-        const response = await handlers.openPage(message);
-        const result = {
-            type: "openPageResult",
-            requestId: message.requestId,
-            ...response,
-        };
-        post(result);
-    }
-    async function handleUpdatePage(message) {
-        if (handlers.updatePage === undefined) {
-            return;
-        }
-        const response = await handlers.updatePage(message);
-        const result = {
-            type: "updatePageResult",
-            requestId: message.requestId,
-            ...response,
-        };
-        post(result);
-    }
     /**
      * Sends any pending host state changes to the sandbox. It is possible for these to change
      * between when the host sends `init` and when the sandbox responds with `initResult`. The host
@@ -258,12 +202,12 @@ export function createCustomBlockHost(options) {
         onInitResult: initializationController.handleInitResult,
         onQueryDataSource: handleQuery,
         onUnsubscribeDataSourceQuery: message => querySubscriptions.unsubscribe(message.subscriptionId),
-        onCreatePage: handleCreatePage,
-        onGetPage: handleGetPage,
-        onOpenPage: handleOpenPage,
-        onGetUser: handleGetUser,
-        onListUsers: handleListUsers,
-        onUpdatePage: handleUpdatePage,
+        onCreatePage: message => respondToRequest(message, handlers.createPage),
+        onGetPage: message => respondToRequest(message, handlers.getPage),
+        onOpenPage: message => respondToRequest(message, handlers.openPage),
+        onGetUser: message => respondToRequest(message, handlers.getUser),
+        onListUsers: message => respondToRequest(message, handlers.listUsers),
+        onUpdatePage: message => respondToRequest(message, handlers.updatePage),
         onResize: message => handlers.resize?.(message),
     });
     window.addEventListener("message", onMessage);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@notionhq/custom-blocks-host",
-  "version": "0.1.28",
+  "version": "0.1.30",
   "description": "Reusable host runtime for Notion custom blocks.",
   "license": "MIT",
   "type": "module",

package/src/createCustomBlockHost.ts

@@ -6,27 +6,10 @@ import type { NotionCollectionSchema } from "@notionhq/custom-blocks-protocol/da
 import type { NotionDataSourceId } from "@notionhq/custom-blocks-protocol/ids.js"
 import type { CustomBlockManifest } from "@notionhq/custom-blocks-protocol/manifest.js"
 import type { ContrastModeChangedMessage } from "@notionhq/custom-blocks-protocol/messages/contrastModeChanged.js"
-import type { CreatePageMessage } from "@notionhq/custom-blocks-protocol/messages/createPage.js"
-import type { CreatePageResultMessage } from "@notionhq/custom-blocks-protocol/messages/createPageResult.js"
 import type { DataSourcesChangedMessage } from "@notionhq/custom-blocks-protocol/messages/dataSourcesChanged.js"
-import type {
-	GetPageMessage,
-	GetPageResultMessage,
-} from "@notionhq/custom-blocks-protocol/messages/getPage.js"
-import type {
-	GetUserMessage,
-	GetUserResultMessage,
-} from "@notionhq/custom-blocks-protocol/messages/getUser.js"
 import type { HostToSandboxMessage } from "@notionhq/custom-blocks-protocol/messages/hostToSandbox.js"
 import type { CustomBlockInitErrorCode } from "@notionhq/custom-blocks-protocol/messages/init.js"
-import type {
-	ListUsersMessage,
-	ListUsersResultMessage,
-} from "@notionhq/custom-blocks-protocol/messages/listUsers.js"
-import type {
-	OpenPageMessage,
-	OpenPageResultMessage,
-} from "@notionhq/custom-blocks-protocol/messages/openPage.js"
+import type { BridgeMessagePayload } from "@notionhq/custom-blocks-protocol/messages/messagePayload.js"
 import type { PageChangedMessage } from "@notionhq/custom-blocks-protocol/messages/pageChanged.js"
 import type { ParentChangedMessage } from "@notionhq/custom-blocks-protocol/messages/parentChanged.js"
 import type { QueryDataSourceMessage } from "@notionhq/custom-blocks-protocol/messages/queryDataSource.js"
@@ -34,9 +17,8 @@ import type {
 	CustomBlockQueryDataSourceErrorInfo,
 	QueryDataSourceResultMessage,
 } from "@notionhq/custom-blocks-protocol/messages/queryDataSourceResult.js"
+import type { SandboxToHostMessage } from "@notionhq/custom-blocks-protocol/messages/sandboxToHost.js"
 import type { ThemeChangedMessage } from "@notionhq/custom-blocks-protocol/messages/themeChanged.js"
-import type { UpdatePageMessage } from "@notionhq/custom-blocks-protocol/messages/updatePage.js"
-import type { UpdatePageResultMessage } from "@notionhq/custom-blocks-protocol/messages/updatePageResult.js"
 import type { CustomBlockPage } from "@notionhq/custom-blocks-protocol/pages/page.js"
 import type { NotionParent } from "@notionhq/custom-blocks-protocol/parent.js"
 import { LATEST_BRIDGE_PROTOCOL_VERSION } from "@notionhq/custom-blocks-protocol/protocolVersion.js"
@@ -113,6 +95,29 @@ export type CustomBlockHostHandle = {
 	refreshQuery: (args: { dataSourceId: NotionDataSourceId }) => void
 }
 
+/**
+ * A request that expects one result correlated by `requestId`.
+ * Query subscriptions use `subscriptionId` and can receive repeated results.
+ */
+type OneShotRequest = Extract<SandboxToHostMessage, { requestId: string }>
+
+/** The matching host result message, named `<request type>Result` by the protocol. */
+type ResultForRequest<Request extends OneShotRequest> = Extract<
+	HostToSandboxMessage,
+	{ type: `${Request["type"]}Result` }
+>
+
+/** The result's success or error payload, without the bridge envelope fields. */
+type ResultPayloadForRequest<Request extends OneShotRequest> =
+	BridgeMessagePayload<ResultForRequest<Request>>
+
+/** Returns one result payload. `respondToRequest` adds the message type and request ID. */
+type OneShotHandler<Request extends OneShotRequest> = (
+	message: Request,
+) =>
+	| ResultPayloadForRequest<Request>
+	| Promise<ResultPayloadForRequest<Request>>
+
 export function createCustomBlockHost(
 	options: CustomBlockHostOptions,
 ): CustomBlockHostHandle {
@@ -171,6 +176,26 @@ export function createCustomBlockHost(
 		iframe.contentWindow?.postMessage(sandboxMessage, sandboxOrigin)
 	}
 
+	/**
+	 * Invokes a one-shot handler and posts its result with the request's ID.
+	 * Each result type is named `<request type>Result` by the bridge protocol.
+	 */
+	async function respondToRequest<Request extends OneShotRequest>(
+		message: Request,
+		handler: OneShotHandler<Request> | undefined,
+	) {
+		if (handler === undefined) {
+			return
+		}
+		const response = await handler(message)
+		const result = {
+			type: `${message.type}Result` as const,
+			requestId: message.requestId,
+			...response,
+		} as HostToSandboxMessage
+		post(result)
+	}
+
 	function postQueryDataSourceResult(args: {
 		subscriptionId: string
 		response: CustomBlockHostQueryDataSourceResult
@@ -221,84 +246,6 @@ export function createCustomBlockHost(
 		})
 	}
 
-	async function handleCreatePage(message: CreatePageMessage) {
-		if (handlers.createPage === undefined) {
-			return
-		}
-		const response = await handlers.createPage(message)
-		const result: CreatePageResultMessage = {
-			type: "createPageResult",
-			requestId: message.requestId,
-			...response,
-		}
-		post(result)
-	}
-
-	async function handleGetPage(message: GetPageMessage) {
-		if (handlers.getPage === undefined) {
-			return
-		}
-		const response = await handlers.getPage(message)
-		const result: GetPageResultMessage = {
-			type: "getPageResult",
-			requestId: message.requestId,
-			...response,
-		}
-		post(result)
-	}
-
-	async function handleGetUser(message: GetUserMessage) {
-		if (handlers.getUser === undefined) {
-			return
-		}
-		const response = await handlers.getUser(message)
-		const result: GetUserResultMessage = {
-			type: "getUserResult",
-			requestId: message.requestId,
-			...response,
-		}
-		post(result)
-	}
-
-	async function handleListUsers(message: ListUsersMessage) {
-		if (handlers.listUsers === undefined) {
-			return
-		}
-		const response = await handlers.listUsers(message)
-		const result: ListUsersResultMessage = {
-			type: "listUsersResult",
-			requestId: message.requestId,
-			...response,
-		}
-		post(result)
-	}
-
-	async function handleOpenPage(message: OpenPageMessage) {
-		if (handlers.openPage === undefined) {
-			return
-		}
-		const response = await handlers.openPage(message)
-		const result: OpenPageResultMessage = {
-			type: "openPageResult",
-			requestId: message.requestId,
-			...response,
-		}
-		post(result)
-	}
-
-	async function handleUpdatePage(message: UpdatePageMessage) {
-		if (handlers.updatePage === undefined) {
-			return
-		}
-		const response = await handlers.updatePage(message)
-		const result: UpdatePageResultMessage = {
-			type: "updatePageResult",
-			requestId: message.requestId,
-			...response,
-		}
-		post(result)
-	}
-
 	/**
 	 * Sends any pending host state changes to the sandbox. It is possible for these to change
 	 * between when the host sends `init` and when the sandbox responds with `initResult`. The host
@@ -411,12 +358,12 @@ export function createCustomBlockHost(
 		onQueryDataSource: handleQuery,
 		onUnsubscribeDataSourceQuery: message =>
 			querySubscriptions.unsubscribe(message.subscriptionId),
-		onCreatePage: handleCreatePage,
-		onGetPage: handleGetPage,
-		onOpenPage: handleOpenPage,
-		onGetUser: handleGetUser,
-		onListUsers: handleListUsers,
-		onUpdatePage: handleUpdatePage,
+		onCreatePage: message => respondToRequest(message, handlers.createPage),
+		onGetPage: message => respondToRequest(message, handlers.getPage),
+		onOpenPage: message => respondToRequest(message, handlers.openPage),
+		onGetUser: message => respondToRequest(message, handlers.getUser),
+		onListUsers: message => respondToRequest(message, handlers.listUsers),
+		onUpdatePage: message => respondToRequest(message, handlers.updatePage),
 		onResize: message => handlers.resize?.(message),
 	})