@notionhq/custom-blocks 0.1.21 → 0.1.23

package/bin/notion-custom-blocks/build.js

@@ -3,8 +3,8 @@ import * as fs from "node:fs";
 import * as path from "node:path";
 import { pathToFileURL } from "node:url";
 import { packDirToTarGz } from "./tar.js";
-export const BUILD_OUTPUT_SENTINEL = "<__notion_custom_block__>";
-export const BUILD_OUTPUT_SENTINEL_CLOSE = "</__notion_custom_block__>";
+const BUILD_OUTPUT_SENTINEL = "<__notion_custom_block__>";
+const BUILD_OUTPUT_SENTINEL_CLOSE = "</__notion_custom_block__>";
 const WORKER_ENTRY = "dist/index.js";
 /**
  * Build every `_tag: "custom_block"` view declared by the worker.

package/bin/notion-custom-blocks/tar.js

@@ -26,7 +26,7 @@ export function packDirToTarGz(dir) {
     return { tarGz, checksumCrc32: crc32Base64(tarGz) };
 }
 /** Base64-encoded big-endian crc32, matching the server's `CRC32_BASE64_REGEX`. */
-export function crc32Base64(data) {
+function crc32Base64(data) {
     const checksum = zlib.crc32(data) >>> 0;
     const buf = Buffer.alloc(4);
     buf.writeUInt32BE(checksum);

package/dist/bridge/dataSources/resolveProperty.d.ts

@@ -2,7 +2,6 @@ import type { NotionDataSource } from "../../protocol/dataSources/dataSource.js"
 import type { CustomBlockPropertyErrorInfo } from "../../protocol/dataSources/errors.js";
 import type { NotionPagePropertyWriteMap } from "../../protocol/pages/page.js";
 import type { NotionPagePropertyInputMap } from "../../types.js";
-export type { CustomBlockPropertyErrorCode, CustomBlockPropertyErrorInfo, } from "../../protocol/dataSources/errors.js";
 export type PropertyWriteMapResolutionResult = {
     status: "success";
     properties: NotionPagePropertyWriteMap;

package/dist/bridge/dataSources/resolveProperty.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"resolveProperty.d.ts","sourceRoot":"","sources":["../../../../../home/runner/work/custom-blocks/custom-blocks/sdk/src/bridge/dataSources/resolveProperty.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4DAA4D,CAAA;AAClG,OAAO,KAAK,EAEX,4BAA4B,EAC5B,MAAM,wDAAwD,CAAA;AAC/D,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,gDAAgD,CAAA;AAGhG,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,gBAAgB,CAAA;AAEhE,YAAY,EACX,4BAA4B,EAC5B,4BAA4B,GAC5B,MAAM,wDAAwD,CAAA;AAE/D,MAAM,MAAM,gCAAgC,GACzC;IAAE,MAAM,EAAE,SAAS,CAAC;IAAC,UAAU,EAAE,0BAA0B,CAAA;CAAE,GAC7D;IAAE,MAAM,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,4BAA4B,CAAA;CAAE,CAAA;AAS3D;;;;;;GAMG;AACH,wBAAgB,oCAAoC,CAAC,IAAI,EAAE;IAC1D,UAAU,EAAE,gBAAgB,GAAG,SAAS,CAAA;IACxC,UAAU,EAAE,0BAA0B,CAAA;IACtC,aAAa,EAAE,MAAM,CAAA;CACrB,GAAG,gCAAgC,CAwDnC;AAED;;;GAGG;AACH,wBAAgB,sCAAsC,CAAC,IAAI,EAAE;IAC5D,UAAU,EAAE,gBAAgB,GAAG,SAAS,CAAA;IACxC,UAAU,EAAE,MAAM,CAAA;IAClB,aAAa,EAAE,MAAM,CAAA;CACrB,GACE;IAAE,MAAM,EAAE,SAAS,CAAC;IAAC,UAAU,EAAE,MAAM,CAAA;CAAE,GACzC;IAAE,MAAM,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,4BAA4B,CAAA;CAAE,CAsB1D"}
+{"version":3,"file":"resolveProperty.d.ts","sourceRoot":"","sources":["../../../../../home/runner/work/custom-blocks/custom-blocks/sdk/src/bridge/dataSources/resolveProperty.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4DAA4D,CAAA;AAClG,OAAO,KAAK,EAEX,4BAA4B,EAC5B,MAAM,wDAAwD,CAAA;AAC/D,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,gDAAgD,CAAA;AAGhG,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,gBAAgB,CAAA;AAEhE,MAAM,MAAM,gCAAgC,GACzC;IAAE,MAAM,EAAE,SAAS,CAAC;IAAC,UAAU,EAAE,0BAA0B,CAAA;CAAE,GAC7D;IAAE,MAAM,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,4BAA4B,CAAA;CAAE,CAAA;AAS3D;;;;;;GAMG;AACH,wBAAgB,oCAAoC,CAAC,IAAI,EAAE;IAC1D,UAAU,EAAE,gBAAgB,GAAG,SAAS,CAAA;IACxC,UAAU,EAAE,0BAA0B,CAAA;IACtC,aAAa,EAAE,MAAM,CAAA;CACrB,GAAG,gCAAgC,CAwDnC;AAED;;;GAGG;AACH,wBAAgB,sCAAsC,CAAC,IAAI,EAAE;IAC5D,UAAU,EAAE,gBAAgB,GAAG,SAAS,CAAA;IACxC,UAAU,EAAE,MAAM,CAAA;IAClB,aAAa,EAAE,MAAM,CAAA;CACrB,GACE;IAAE,MAAM,EAAE,SAAS,CAAC;IAAC,UAAU,EAAE,MAAM,CAAA;CAAE,GACzC;IAAE,MAAM,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,4BAA4B,CAAA;CAAE,CAsB1D"}

package/dist/bridge/sandboxClient.d.ts

@@ -3,7 +3,6 @@ import type { CreatePageArgs, CreatePageResult, GetPageResult, GetUserResult, Li
 import { type CustomBlockHostState, type DataSourceQueryView } from "./hostState.js";
 import type { ManifestLoadResult } from "./loadManifest.js";
 import { type MessageLogEntry } from "./SandboxBridge.js";
-export type { MessageLogEntry };
 export declare const customBlockHost: {
     start: () => void;
     sendConnect: (manifestResult: ManifestLoadResult) => void;

package/dist/bridge/sandboxClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sandboxClient.d.ts","sourceRoot":"","sources":["../../../../home/runner/work/custom-blocks/custom-blocks/sdk/src/bridge/sandboxClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mDAAmD,CAAA;AACpF,OAAO,KAAK,EACX,cAAc,EACd,gBAAgB,EAChB,aAAa,EACb,aAAa,EACb,aAAa,EACb,eAAe,EACf,YAAY,EACZ,YAAY,EACZ,cAAc,EACd,gBAAgB,EAChB,oBAAoB,EACpB,MAAM,aAAa,CAAA;AACpB,OAAO,EACN,KAAK,oBAAoB,EACzB,KAAK,mBAAmB,EAExB,MAAM,gBAAgB,CAAA;AACvB,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAC3D,OAAO,EAAE,KAAK,eAAe,EAAiB,MAAM,oBAAoB,CAAA;AAExE,YAAY,EAAE,eAAe,EAAE,CAAA;AAW/B,eAAO,MAAM,eAAe;;kCAKG,kBAAkB;yBAI3B,WAAW,KAAG,OAAO,CAAC,IAAI,CAAC;0BAI1B,MAAM,IAAI;oBAIlB,oBAAoB;IAIlC;;;OAGG;4BACqB,WAAW;;yBAQd,MAAM;CAG3B,CAAA;AAED,eAAO,MAAM,sBAAsB;iBACrB,MAAM,YAAY,oBAAoB;yBAKvC,oBAAoB,OAC1B,MAAM,KACT,mBAAmB;CAKtB,CAAA;AAED,eAAO,MAAM,UAAU;uBACL,SAAS,eAAe,EAAE;0BAIrB,MAAM,IAAI;CAGhC,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,KAAK;IACjB;;OAEG;oBACa,cAAc,KAAG,OAAO,CAAC,gBAAgB,CAAC;IAI1D;;OAEG;kBACW,YAAY,KAAG,OAAO,CAAC,aAAa,CAAC;IAInD;;OAEG;oBACa,cAAc,KAAG,OAAO,CAAC,gBAAgB,CAAC;IAI1D;;OAEG;qBACc,YAAY,KAAG,OAAO,CAAC,gBAAgB,CAAC;CAGzD,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,KAAK;IACjB;;OAEG;mBACY,aAAa,KAAG,OAAO,CAAC,eAAe,CAAC;IAIvD;;OAEG;kBACW,YAAY,KAAG,OAAO,CAAC,aAAa,CAAC;CAGnD,CAAA"}
+{"version":3,"file":"sandboxClient.d.ts","sourceRoot":"","sources":["../../../../home/runner/work/custom-blocks/custom-blocks/sdk/src/bridge/sandboxClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mDAAmD,CAAA;AACpF,OAAO,KAAK,EACX,cAAc,EACd,gBAAgB,EAChB,aAAa,EACb,aAAa,EACb,aAAa,EACb,eAAe,EACf,YAAY,EACZ,YAAY,EACZ,cAAc,EACd,gBAAgB,EAChB,oBAAoB,EACpB,MAAM,aAAa,CAAA;AACpB,OAAO,EACN,KAAK,oBAAoB,EACzB,KAAK,mBAAmB,EAExB,MAAM,gBAAgB,CAAA;AACvB,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAC3D,OAAO,EAAE,KAAK,eAAe,EAAiB,MAAM,oBAAoB,CAAA;AAWxE,eAAO,MAAM,eAAe;;kCAKG,kBAAkB;yBAI3B,WAAW,KAAG,OAAO,CAAC,IAAI,CAAC;0BAI1B,MAAM,IAAI;oBAIlB,oBAAoB;IAIlC;;;OAGG;4BACqB,WAAW;;yBAQd,MAAM;CAG3B,CAAA;AAED,eAAO,MAAM,sBAAsB;iBACrB,MAAM,YAAY,oBAAoB;yBAKvC,oBAAoB,OAC1B,MAAM,KACT,mBAAmB;CAKtB,CAAA;AAED,eAAO,MAAM,UAAU;uBACL,SAAS,eAAe,EAAE;0BAIrB,MAAM,IAAI;CAGhC,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,KAAK;IACjB;;OAEG;oBACa,cAAc,KAAG,OAAO,CAAC,gBAAgB,CAAC;IAI1D;;OAEG;kBACW,YAAY,KAAG,OAAO,CAAC,aAAa,CAAC;IAInD;;OAEG;oBACa,cAAc,KAAG,OAAO,CAAC,gBAAgB,CAAC;IAI1D;;OAEG;qBACc,YAAY,KAAG,OAAO,CAAC,gBAAgB,CAAC;CAGzD,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,KAAK;IACjB;;OAEG;mBACY,aAAa,KAAG,OAAO,CAAC,eAAe,CAAC;IAIvD;;OAEG;kBACW,YAAY,KAAG,OAAO,CAAC,aAAa,CAAC;CAGnD,CAAA"}

package/dist/react/useRuntimeState.d.ts

@@ -65,14 +65,16 @@ export declare function useContrastMode(): NotionContrastMode;
  */
 export declare function useCurrentUser(): NotionUser;
 /**
- * Returns the authoritative manifest received from the host — the semantic
- * data source keys plus their declared `name`, `description`, and property declarations.
+ * Returns the manifest that the block declared and the host provided during initialization.
+ * It lists each semantic data source key with its declared name, description, icon, and
+ * property definitions. Use this hook to list keys when the UI supports multiple data sources,
+ * such as in a data source selector.
  *
  * Throws if called before `initCustomBlock` has resolved.
  *
- * This is the configuration the block declared, not host-resolved bindings: use
- * `useDataSource(key)` for rows and resolved schema. Handy for enumerating the declared
- * data source keys (e.g. picking a default key, or rendering a key switcher).
+ * The manifest does not include the concrete Notion data source IDs mapped to those keys or
+ * any row data. Use `useDataSource(key)` with a declared key to read rows and access the
+ * resolved property IDs and schemas.
  */
 export declare function useManifest(): CustomBlockManifest;
 //# sourceMappingURL=useRuntimeState.d.ts.map

package/dist/react/useRuntimeState.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useRuntimeState.d.ts","sourceRoot":"","sources":["../../../../home/runner/work/custom-blocks/custom-blocks/sdk/src/react/useRuntimeState.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,8CAA8C,CAAA;AACtF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,yCAAyC,CAAA;AAC5E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8CAA8C,CAAA;AACvF,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;AAIhF;;;;;;;GAOG;AACH,wBAAgB,UAAU,IAAI,aAAa,CAE1C;AAED;;;;;;;;GAQG;AACH,wBAAgB,SAAS,IAAI,YAAY,CAExC;AAED;;;;;;;;GAQG;AACH,wBAAgB,OAAO,IAAI,eAAe,CAEzC;AAED;;;;;;;GAOG;AACH,wBAAgB,QAAQ,IAAI,WAAW,CAEtC;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,IAAI,kBAAkB,CAKpD;AAED;;;;;;;;;GASG;AACH,wBAAgB,cAAc,IAAI,UAAU,CAE3C;AAED;;;;;;;;;GASG;AACH,wBAAgB,WAAW,IAAI,mBAAmB,CAEjD"}
+{"version":3,"file":"useRuntimeState.d.ts","sourceRoot":"","sources":["../../../../home/runner/work/custom-blocks/custom-blocks/sdk/src/react/useRuntimeState.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,8CAA8C,CAAA;AACtF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,yCAAyC,CAAA;AAC5E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8CAA8C,CAAA;AACvF,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;AAIhF;;;;;;;GAOG;AACH,wBAAgB,UAAU,IAAI,aAAa,CAE1C;AAED;;;;;;;;GAQG;AACH,wBAAgB,SAAS,IAAI,YAAY,CAExC;AAED;;;;;;;;GAQG;AACH,wBAAgB,OAAO,IAAI,eAAe,CAEzC;AAED;;;;;;;GAOG;AACH,wBAAgB,QAAQ,IAAI,WAAW,CAEtC;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,IAAI,kBAAkB,CAKpD;AAED;;;;;;;;;GASG;AACH,wBAAgB,cAAc,IAAI,UAAU,CAE3C;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,WAAW,IAAI,mBAAmB,CAEjD"}

package/dist/react/useRuntimeState.js

@@ -72,14 +72,16 @@ export function useCurrentUser() {
     return useSyncExternalStore(customBlock.subscribe, customBlock.getCurrentUser);
 }
 /**
- * Returns the authoritative manifest received from the host — the semantic
- * data source keys plus their declared `name`, `description`, and property declarations.
+ * Returns the manifest that the block declared and the host provided during initialization.
+ * It lists each semantic data source key with its declared name, description, icon, and
+ * property definitions. Use this hook to list keys when the UI supports multiple data sources,
+ * such as in a data source selector.
  *
  * Throws if called before `initCustomBlock` has resolved.
  *
- * This is the configuration the block declared, not host-resolved bindings: use
- * `useDataSource(key)` for rows and resolved schema. Handy for enumerating the declared
- * data source keys (e.g. picking a default key, or rendering a key switcher).
+ * The manifest does not include the concrete Notion data source IDs mapped to those keys or
+ * any row data. Use `useDataSource(key)` with a declared key to read rows and access the
+ * resolved property IDs and schemas.
  */
 export function useManifest() {
     return useSyncExternalStore(customBlock.subscribe, customBlock.getManifest);

package/dist/version.js

@@ -4,4 +4,4 @@
  *
  * WARNING: Generated during SDK publish. Do not edit in the published package.
  */
-export const CUSTOM_BLOCKS_SDK_VERSION = "0.1.21"
+export const CUSTOM_BLOCKS_SDK_VERSION = "0.1.23"

package/docs/data-sources.md

@@ -6,7 +6,7 @@ The mapping from those semantic keys to concrete Notion data sources is stored o
 
 Use `ManifestDataSource`, `ManifestProperty`, and `ManifestIcon` when code needs the corresponding definition metadata types.
 
-At runtime, your code references the semantic key and the SDK handles the lookup for you. Use `useDataSource(key)` for the rows themselves (it also exposes the resolved schema), and `useManifest()` when you need the declared data source keys and their declarations (e.g. picking a default key, or rendering a key switcher). For non-React renderers, `customBlock.getManifest()` exposes the same manifest, but row querying is currently only exposed through the React `useDataSource` hook.
+At runtime, your code references the semantic key and the SDK handles the lookup for you. Use `useDataSource(key)` for the rows themselves (it also exposes the resolved schema), and use `useManifest()` when the UI must enumerate declared data sources, such as a dynamic key switcher. For non-React renderers, `customBlock.getManifest()` exposes the same manifest, but row querying is currently only exposed through the React `useDataSource` hook.
 
 ## Pages within a data source
 
@@ -66,14 +66,14 @@ Query failures follow the SDK's [error-handling contract](./errors.md).
 function useManifest(): CustomBlockManifest;
 ```
 
-Returns the authoritative block manifest received from the host during initialization, including the semantic data source keys plus their declared `name`, `description`, and property declarations. Handy for enumerating declared keys:
+Returns the authoritative block manifest received from the host during initialization, including the semantic data source keys plus their declared `name`, `description`, and property declarations. Most blocks should query a declared key directly:
 
 ```tsx
-const manifest = useManifest();
-const keys = Object.keys(manifest.dataSources);
-const activeKey = keys[0] ?? "default";
+const query = useDataSource("tasks");
 ```
 
+Use `useManifest()` when the UI must enumerate declarations, such as a switcher that supports multiple data sources.
+
 This API throws if called before initialization. This does not include host-resolved bindings nor does it include any actual data rows.
 
 ### `customBlock.getManifest()`

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@notionhq/custom-blocks",
-	"version": "0.1.21",
+	"version": "0.1.23",
 	"license": "MIT",
 	"type": "module",
 	"publishConfig": {

package/src/bridge/dataSources/resolveProperty.ts

@@ -8,11 +8,6 @@ import { notionPagePropertyValueSchema } from "@notionhq/custom-blocks-protocol/
 import * as v from "valibot"
 import type { NotionPagePropertyInputMap } from "../../types.js"
 
-export type {
-	CustomBlockPropertyErrorCode,
-	CustomBlockPropertyErrorInfo,
-} from "@notionhq/custom-blocks-protocol/dataSources/errors.js"
-
 export type PropertyWriteMapResolutionResult =
 	| { status: "success"; properties: NotionPagePropertyWriteMap }
 	| { status: "error"; error: CustomBlockPropertyErrorInfo }

package/src/bridge/sandboxClient.ts

@@ -20,8 +20,6 @@ import {
 import type { ManifestLoadResult } from "./loadManifest.js"
 import { type MessageLogEntry, SandboxBridge } from "./SandboxBridge.js"
 
-export type { MessageLogEntry }
-
 let bridge: SandboxBridge | undefined
 
 function getBridge(): SandboxBridge {

package/src/react/useRuntimeState.ts

@@ -89,14 +89,16 @@ export function useCurrentUser(): NotionUser {
 }
 
 /**
- * Returns the authoritative manifest received from the host — the semantic
- * data source keys plus their declared `name`, `description`, and property declarations.
+ * Returns the manifest that the block declared and the host provided during initialization.
+ * It lists each semantic data source key with its declared name, description, icon, and
+ * property definitions. Use this hook to list keys when the UI supports multiple data sources,
+ * such as in a data source selector.
  *
  * Throws if called before `initCustomBlock` has resolved.
  *
- * This is the configuration the block declared, not host-resolved bindings: use
- * `useDataSource(key)` for rows and resolved schema. Handy for enumerating the declared
- * data source keys (e.g. picking a default key, or rendering a key switcher).
+ * The manifest does not include the concrete Notion data source IDs mapped to those keys or
+ * any row data. Use `useDataSource(key)` with a declared key to read rows and access the
+ * resolved property IDs and schemas.
  */
 export function useManifest(): CustomBlockManifest {
 	return useSyncExternalStore(customBlock.subscribe, customBlock.getManifest)