@notionhq/custom-blocks-host 0.1.31 → 0.2.0

package/dist/lifecycle/initializationController.js

@@ -1,11 +1,15 @@
+import { DEFAULT_CONTRAST_MODE } from "../protocol/contrast.js";
+import { unreachable } from "../utils.js";
 import { initErrorForFailureReason } from "./initErrors.js";
 import { isValidBridgeProtocolVersion } from "./protocolVersion.js";
 const DEFAULT_NO_CONNECT_TIMEOUT_MS = 5_000;
+const DEFAULT_INITIAL_STATE_TIMEOUT_MS = 5_000;
 const DEFAULT_NO_INIT_RESULT_TIMEOUT_MS = 5_000;
 export function createInitializationController(options) {
-    const { blockId, getState, prepareInit, sendInitMessage, warn, flushPendingHostStateChanges, minBridgeProtocolVersion, noConnectTimeoutMs = DEFAULT_NO_CONNECT_TIMEOUT_MS, noInitResultTimeoutMs = DEFAULT_NO_INIT_RESULT_TIMEOUT_MS, stopHostWithFailure, onInitResult, onFailure, } = options;
+    const { prepareInit, sendInitMessage, warn, flushPendingHostStateChanges, minBridgeProtocolVersion, noConnectTimeoutMs = DEFAULT_NO_CONNECT_TIMEOUT_MS, initialStateTimeoutMs = DEFAULT_INITIAL_STATE_TIMEOUT_MS, noInitResultTimeoutMs = DEFAULT_NO_INIT_RESULT_TIMEOUT_MS, stopHostWithFailure, onInitResult, onFailure, } = options;
     let initStatus = "waitingForConnect";
     let noConnectTimeoutId;
+    let initialStateTimeoutId;
     let noInitResultTimeoutId;
     let activeInitializationId;
     let hasObservedIframeLoad = false;
@@ -16,6 +20,12 @@ export function createInitializationController(options) {
             noConnectTimeoutId = undefined;
         }
     }
+    function clearInitialStateTimeout() {
+        if (initialStateTimeoutId !== undefined) {
+            window.clearTimeout(initialStateTimeoutId);
+            initialStateTimeoutId = undefined;
+        }
+    }
     function clearNoInitResultTimeout() {
         if (noInitResultTimeoutId !== undefined) {
             window.clearTimeout(noInitResultTimeoutId);
@@ -24,12 +34,22 @@ export function createInitializationController(options) {
     }
     function sendInitError(args) {
         const { initializationId, error } = args;
-        if (initStatus !== "waitingForConnect") {
-            return;
+        switch (initStatus) {
+            case "waitingForConnect":
+            case "preparingInit":
+                break;
+            case "waitingForInitResult":
+            case "initialized":
+            case "error":
+            case "stopped":
+                return;
+            default:
+                return unreachable(initStatus);
         }
         initStatus = "error";
         activeInitializationId = initializationId;
         clearNoConnectTimeout();
+        clearInitialStateTimeout();
         sendInitMessage({
             type: "init",
             initializationId,
@@ -38,54 +58,78 @@ export function createInitializationController(options) {
         });
         onFailure?.(error);
     }
-    function prepareAndSendInit(connect) {
-        if (initStatus !== "waitingForConnect") {
-            return false;
-        }
-        const preparation = prepareInit(connect);
-        // The embedder can stop the host when it receives the manifest.
-        // If that happens, do not continue initialization or start its timer.
+    async function prepareAndSendInit(connect) {
         if (initStatus !== "waitingForConnect") {
-            return false;
+            return;
         }
-        if (preparation.status === "error") {
-            sendInitError({
+        initStatus = "preparingInit";
+        activeInitializationId = connect.initializationId;
+        clearNoConnectTimeout();
+        initialStateTimeoutId = window.setTimeout(() => {
+            if (initStatus !== "preparingInit") {
+                return;
+            }
+            const error = initErrorForFailureReason("initial_state_timeout");
+            warn({
+                ...error,
                 initializationId: connect.initializationId,
-                error: preparation.error,
             });
-            return false;
+            sendInitError({ initializationId: connect.initializationId, error });
+        }, initialStateTimeoutMs);
+        try {
+            const preparation = await prepareInit(connect);
+            if (initStatus !== "preparingInit") {
+                return;
+            }
+            clearInitialStateTimeout();
+            if (preparation.status === "error") {
+                sendInitError({
+                    initializationId: connect.initializationId,
+                    error: preparation.error,
+                });
+                return;
+            }
+            initStatus = "waitingForInitResult";
+            const message = {
+                type: "init",
+                initializationId: connect.initializationId,
+                status: "success",
+                theme: preparation.initialState.theme,
+                contrastMode: preparation.initialState.contrastMode ?? DEFAULT_CONTRAST_MODE,
+                blockId: preparation.initialState.blockId,
+                parent: preparation.initialState.parent,
+                page: preparation.initialState.page,
+                currentUser: preparation.initialState.currentUser,
+                manifest: preparation.initialState.manifest,
+                dataSources: preparation.initialState.dataSources,
+            };
+            sendInitMessage(message);
+            noInitResultTimeoutId = window.setTimeout(() => {
+                if (initStatus !== "waitingForInitResult") {
+                    return;
+                }
+                initStatus = "error";
+                const error = initErrorForFailureReason("no_init_result");
+                onFailure?.(error);
+                warn({
+                    ...error,
+                    initializationId: connect.initializationId,
+                });
+            }, noInitResultTimeoutMs);
         }
-        initStatus = "waitingForInitResult";
-        activeInitializationId = connect.initializationId;
-        clearNoConnectTimeout();
-        const state = getState();
-        const message = {
-            type: "init",
-            initializationId: connect.initializationId,
-            status: "success",
-            theme: state.theme,
-            contrastMode: state.contrastMode,
-            blockId,
-            parent: state.parent,
-            page: state.page,
-            manifest: preparation.manifest,
-            dataSources: preparation.dataSources,
-            currentUser: state.currentUser,
-        };
-        sendInitMessage(message);
-        noInitResultTimeoutId = window.setTimeout(() => {
-            if (initStatus !== "waitingForInitResult") {
+        catch (error) {
+            if (initStatus !== "preparingInit") {
                 return;
             }
-            initStatus = "error";
-            const error = initErrorForFailureReason("no_init_result");
             warn({
-                message: "Sandbox did not send initResult",
+                message: "Failed to prepare custom block initialization",
+                error,
+            });
+            sendInitError({
                 initializationId: connect.initializationId,
+                error: initErrorForFailureReason("unknown_error"),
             });
-            onFailure?.(error);
-        }, noInitResultTimeoutMs);
-        return true;
+        }
     }
     function handleConnect(message) {
         if (initStatus === "stopped") {
@@ -124,9 +168,8 @@ export function createInitializationController(options) {
             });
             return;
         }
-        if (prepareAndSendInit(message)) {
-            hasConnectedSandbox = true;
-        }
+        hasConnectedSandbox = true;
+        void prepareAndSendInit(message);
     }
     function handleInvalidConnect(args) {
         if (initStatus === "stopped") {
@@ -208,12 +251,11 @@ export function createInitializationController(options) {
             return;
         }
         clearNoInitResultTimeout();
+        initStatus = message.status === "success" ? "initialized" : "error";
         if (message.status === "success") {
-            initStatus = "initialized";
             flushPendingHostStateChanges();
         }
         else {
-            initStatus = "error";
             onFailure?.(message.error);
         }
         onInitResult?.(message);
@@ -221,6 +263,7 @@ export function createInitializationController(options) {
     function stop() {
         initStatus = "stopped";
         clearNoConnectTimeout();
+        clearInitialStateTimeout();
         clearNoInitResultTimeout();
     }
     return {

package/dist/lifecycle/types.d.ts

@@ -3,6 +3,7 @@ import type { NotionDataSourceBindings } from "../protocol/dataSources/dataSourc
 import type { NotionBlockId } from "../protocol/ids.js";
 import type { CustomBlockManifest } from "../protocol/manifest.js";
 import type { ConnectMessage } from "../protocol/messages/connect.js";
+import type { CustomBlockInitErrorInfo } from "../protocol/messages/init.js";
 import type { CustomBlockPage } from "../protocol/pages/page.js";
 import type { NotionParent } from "../protocol/parent.js";
 import type { NotionTheme } from "../protocol/theme.js";
@@ -14,6 +15,8 @@ export type ConnectSuccessMessage = Extract<ConnectMessage, {
 export type InitStatus = 
 /** The host is waiting for the sandbox's first `connect` message. */
 "waitingForConnect"
+/** The host is waiting for `getInitialState` to prepare `init`. */
+ | "preparingInit"
 /** The host is waiting for a matching `initResult` after it sends `init`. */
  | "waitingForInitResult"
 /** The host is initialized and can send live updates. */
@@ -25,7 +28,6 @@ export type InitStatus =
 export type CustomBlockHostDataSourcesPayload = {
     bindings: NotionDataSourceBindings;
 };
-export type CustomBlockHostInitialDataSources = CustomBlockHostDataSourcesPayload | ((connect: ConnectSuccessMessage) => CustomBlockHostDataSourcesPayload);
 export type CustomBlockHostInitialState = {
     theme: NotionTheme;
     /**
@@ -36,12 +38,16 @@ export type CustomBlockHostInitialState = {
     blockId: NotionBlockId;
     parent: NotionParent;
     page: CustomBlockPage;
-    /**
-     * 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;
+    manifest: CustomBlockManifest;
+    dataSources: CustomBlockHostDataSourcesPayload;
     currentUser: NotionUser;
 };
+export type CustomBlockHostInitialStateResult = {
+    status: "success";
+    initialState: CustomBlockHostInitialState;
+} | {
+    status: "error";
+    error: CustomBlockInitErrorInfo;
+};
+export type CustomBlockHostGetInitialState = (connect: ConnectSuccessMessage) => Promise<CustomBlockHostInitialStateResult>;
 //# sourceMappingURL=types.d.ts.map

package/dist/lifecycle/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/lifecycle/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,8CAA8C,CAAA;AACtF,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,4DAA4D,CAAA;AAC1G,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,yCAAyC,CAAA;AAC5E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8CAA8C,CAAA;AACvF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sDAAsD,CAAA;AAC1F,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gDAAgD,CAAA;AACrF,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,4CAA4C,CAAA;AAC9E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,2CAA2C,CAAA;AAC5E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gDAAgD,CAAA;AAEhF,MAAM,MAAM,qBAAqB,GAAG,OAAO,CAC1C,cAAc,EACd;IAAE,MAAM,EAAE,SAAS,CAAA;CAAE,CACrB,CAAA;AAED,gEAAgE;AAChE,MAAM,MAAM,UAAU;AACrB,qEAAqE;AACnE,mBAAmB;AACrB,6EAA6E;GAC3E,sBAAsB;AACxB,yDAAyD;GACvD,aAAa;AACf,gFAAgF;GAC9E,OAAO;AACT,2EAA2E;GACzE,SAAS,CAAA;AAEZ,MAAM,MAAM,iCAAiC,GAAG;IAC/C,QAAQ,EAAE,wBAAwB,CAAA;CAClC,CAAA;AAED,MAAM,MAAM,iCAAiC,GAC1C,iCAAiC,GACjC,CAAC,CAAC,OAAO,EAAE,qBAAqB,KAAK,iCAAiC,CAAC,CAAA;AAE1E,MAAM,MAAM,2BAA2B,GAAG;IACzC,KAAK,EAAE,WAAW,CAAA;IAClB;;;OAGG;IACH,YAAY,CAAC,EAAE,kBAAkB,CAAA;IACjC,OAAO,EAAE,aAAa,CAAA;IACtB,MAAM,EAAE,YAAY,CAAA;IACpB,IAAI,EAAE,eAAe,CAAA;IACrB;;;OAGG;IACH,QAAQ,CAAC,EAAE,mBAAmB,CAAA;IAC9B,WAAW,EAAE,iCAAiC,CAAA;IAC9C,WAAW,EAAE,UAAU,CAAA;CACvB,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/lifecycle/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,8CAA8C,CAAA;AACtF,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,4DAA4D,CAAA;AAC1G,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,yCAAyC,CAAA;AAC5E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8CAA8C,CAAA;AACvF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sDAAsD,CAAA;AAC1F,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,mDAAmD,CAAA;AACjG,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gDAAgD,CAAA;AACrF,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,4CAA4C,CAAA;AAC9E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,2CAA2C,CAAA;AAC5E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gDAAgD,CAAA;AAEhF,MAAM,MAAM,qBAAqB,GAAG,OAAO,CAC1C,cAAc,EACd;IAAE,MAAM,EAAE,SAAS,CAAA;CAAE,CACrB,CAAA;AAED,gEAAgE;AAChE,MAAM,MAAM,UAAU;AACrB,qEAAqE;AACnE,mBAAmB;AACrB,mEAAmE;GACjE,eAAe;AACjB,6EAA6E;GAC3E,sBAAsB;AACxB,yDAAyD;GACvD,aAAa;AACf,gFAAgF;GAC9E,OAAO;AACT,2EAA2E;GACzE,SAAS,CAAA;AAEZ,MAAM,MAAM,iCAAiC,GAAG;IAC/C,QAAQ,EAAE,wBAAwB,CAAA;CAClC,CAAA;AAED,MAAM,MAAM,2BAA2B,GAAG;IACzC,KAAK,EAAE,WAAW,CAAA;IAClB;;;OAGG;IACH,YAAY,CAAC,EAAE,kBAAkB,CAAA;IACjC,OAAO,EAAE,aAAa,CAAA;IACtB,MAAM,EAAE,YAAY,CAAA;IACpB,IAAI,EAAE,eAAe,CAAA;IACrB,QAAQ,EAAE,mBAAmB,CAAA;IAC7B,WAAW,EAAE,iCAAiC,CAAA;IAC9C,WAAW,EAAE,UAAU,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,iCAAiC,GAC1C;IACA,MAAM,EAAE,SAAS,CAAA;IACjB,YAAY,EAAE,2BAA2B,CAAA;CACxC,GACD;IACA,MAAM,EAAE,OAAO,CAAA;IACf,KAAK,EAAE,wBAAwB,CAAA;CAC9B,CAAA;AAEJ,MAAM,MAAM,8BAA8B,GAAG,CAC5C,OAAO,EAAE,qBAAqB,KAC1B,OAAO,CAAC,iCAAiC,CAAC,CAAA"}

package/dist/protocol/messages/init.d.ts

@@ -2,7 +2,7 @@ import * as v from "valibot";
 import type { CustomBlockErrorCode, CustomBlockErrorInfo } from "../errors.js";
 import type { CustomBlockInitResultErrorCode } from "./initResult.js";
 export declare const customBlockInitErrorCodeSchema: v.StringSchema<undefined>;
-export type CustomBlockInitErrorCode = CustomBlockErrorCode<"manifest_unavailable" | "manifest_invalid" | "invalid_connect_payload" | "invalid_protocol_version" | "unsupported_protocol_version" | "init_timeout" | "context_unavailable" | "current_user_unavailable" | "missing_data_source_binding" | "data_source_unavailable" | "missing_property_binding" | "invalid_property_binding">;
+export type CustomBlockInitErrorCode = CustomBlockErrorCode<"manifest_unavailable" | "manifest_invalid" | "invalid_connect_payload" | "invalid_protocol_version" | "unsupported_protocol_version" | "init_timeout" | "context_unavailable" | "current_user_unavailable" | "initial_state_timeout" | "missing_data_source_binding" | "data_source_unavailable" | "missing_property_binding" | "invalid_property_binding">;
 export type CustomBlockInitErrorInfo = CustomBlockErrorInfo<CustomBlockInitErrorCode>;
 /**
  * Every initialization failure visible to block code. This combines errors

package/package.json

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