@notionhq/custom-blocks 0.1.16 → 0.1.18

package/src/bridge/sandboxClient.ts

@@ -22,23 +22,34 @@ import { type MessageLogEntry, SandboxBridge } from "./SandboxBridge.js"
 
 export type { MessageLogEntry }
 
-const bridge = new SandboxBridge()
+let bridge: SandboxBridge | undefined
+
+function getBridge(): SandboxBridge {
+	if (!bridge) {
+		bridge = new SandboxBridge()
+	}
+	return bridge
+}
 
 export const customBlockHost = {
+	start: () => {
+		getBridge().startListening()
+	},
+
 	sendConnect: (manifestResult: ManifestLoadResult) => {
-		bridge.sendConnect(manifestResult)
+		getBridge().sendConnect(manifestResult)
 	},
 
 	awaitInit: (signal?: AbortSignal): Promise<void> => {
-		return bridge.awaitInit(signal)
+		return getBridge().awaitInit(signal)
 	},
 
 	subscribe: (listener: () => void) => {
-		return bridge.subscribe(listener)
+		return getBridge().subscribe(listener)
 	},
 
 	getState: (): CustomBlockHostState => {
-		return bridge.getHostState()
+		return getBridge().getHostState()
 	},
 
 	/**
@@ -46,17 +57,17 @@ export const customBlockHost = {
 	 * standalone preview state.
 	 */
 	setMockState: (message: InitMessage) => {
-		bridge.setMockState(message)
+		getBridge().setMockState(message)
 	},
 
 	postResize: (height: number) => {
-		bridge.postResize(height)
+		getBridge().postResize(height)
 	},
 }
 
 export const customBlockDataSources = {
 	query: (key: string, options?: UseDataSourceOptions) => {
-		bridge.queryDataSource(key, options)
+		getBridge().queryDataSource(key, options)
 	},
 
 	getView: (
@@ -64,18 +75,18 @@ export const customBlockDataSources = {
 		key: string,
 	): DataSourceQueryView => {
 		return getDataSourceQueryViewWithBridge(hostState, key, args =>
-			bridge.updateDataSourcePage(args),
+			getBridge().updateDataSourcePage(args),
 		)
 	},
 }
 
 export const messageLog = {
 	getSnapshot: (): readonly MessageLogEntry[] => {
-		return bridge.getMessageLog()
+		return getBridge().getMessageLog()
 	},
 
 	subscribe: (listener: () => void) => {
-		return bridge.subscribeToMessageLog(listener)
+		return getBridge().subscribeToMessageLog(listener)
 	},
 }
 
@@ -87,28 +98,28 @@ export const pages = {
 	 * Creates a new Notion page.
 	 */
 	create: (input: CreatePageArgs): Promise<CreatePageResult> => {
-		return bridge.createPage(input)
+		return getBridge().createPage(input)
 	},
 
 	/**
 	 * Fetches a page by id.
 	 */
 	get: (pageId: NotionPageId): Promise<GetPageResult> => {
-		return bridge.getPage(pageId)
+		return getBridge().getPage(pageId)
 	},
 
 	/**
 	 * Updates an existing page.
 	 */
 	update: (input: UpdatePageArgs): Promise<UpdatePageResult> => {
-		return bridge.updatePage(input)
+		return getBridge().updatePage(input)
 	},
 
 	/**
 	 * Soft-delete a page by archiving it.
 	 */
 	delete: (pageId: NotionPageId): Promise<UpdatePageResult> => {
-		return bridge.updatePage({ pageId, archived: true })
+		return getBridge().updatePage({ pageId, archived: true })
 	},
 }
 
@@ -120,13 +131,13 @@ export const users = {
 	 * Lists users visible in the current custom block workspace.
 	 */
 	list: (input?: ListUsersArgs): Promise<ListUsersResult> => {
-		return bridge.listUsers(input)
+		return getBridge().listUsers(input)
 	},
 
 	/**
 	 * Fetches a user by id.
 	 */
 	get: (userId: NotionUserId): Promise<GetUserResult> => {
-		return bridge.getUser(userId)
+		return getBridge().getUser(userId)
 	},
 }

package/src/index.ts

@@ -12,12 +12,6 @@ export type {
 	NotionCollectionSchema,
 	NotionDataSource,
 } from "@notionhq/custom-blocks-protocol/dataSources/dataSource.js"
-export type {
-	NotionDataSourcePage,
-	NotionDataSourcePageUpdateArgs,
-	NotionDataSourcePageUpdateInput,
-	NotionDataSourcePageUpdateResult,
-} from "@notionhq/custom-blocks-protocol/dataSources/dataSourcePage.js"
 export type { NotionDataSourceValue } from "@notionhq/custom-blocks-protocol/dataSources/dataSourceValue.js"
 export type {
 	NotionDate,
@@ -98,8 +92,6 @@ export type {
 	NotionPageCover,
 	NotionPageIcon,
 	NotionPageId,
-	NotionPagePropertyInputMap,
-	NotionPagePropertyInputValue,
 	NotionPagePropertyValue,
 	NotionPagePropertyWriteMap,
 } from "@notionhq/custom-blocks-protocol/pages/page.js"

package/src/init.ts

@@ -76,6 +76,7 @@ export function initCustomBlock(
 	opts: InitCustomBlockOptions = {},
 ): Promise<CustomBlockInitPayload> {
 	if (initPromise === undefined) {
+		customBlockHost.start()
 		initPromise = performHandshake(opts)
 	}
 	return initPromise

package/src/react/standalonePreview.ts

@@ -3,11 +3,13 @@ import {
 	notionBlockIdSchema,
 	notionPageIdSchema,
 } from "@notionhq/custom-blocks-protocol/ids.js"
+import { notionUserIdSchema } from "@notionhq/custom-blocks-protocol/users/user.js"
 import * as v from "valibot"
 import { customBlockHost } from "../bridge/sandboxClient.js"
 
 const previewBlockId = v.parse(notionBlockIdSchema, "")
 const previewPageId = v.parse(notionPageIdSchema, "")
+const previewUserId = v.parse(notionUserIdSchema, "")
 
 export function seedStandalonePreviewState() {
 	customBlockHost.setMockState({
@@ -23,7 +25,7 @@ export function seedStandalonePreviewState() {
 		dataSources: { bindings: {} },
 		currentUser: {
 			object: "user",
-			id: "",
+			id: previewUserId,
 			name: "Preview User",
 			avatar_url: null,
 			type: "person",

package/src/types.ts

@@ -1,7 +1,10 @@
 import type { NotionCollectionSchema } from "@notionhq/custom-blocks-protocol/dataSources/dataSource.js"
-import type { NotionDataSourcePage } from "@notionhq/custom-blocks-protocol/dataSources/dataSourcePage.js"
+import type { NotionDataSourceValue } from "@notionhq/custom-blocks-protocol/dataSources/dataSourceValue.js"
 import type { NotionPropertySchema } from "@notionhq/custom-blocks-protocol/dataSources/propertySchema.js"
-import type { NotionDataSourceId } from "@notionhq/custom-blocks-protocol/ids.js"
+import type {
+	NotionDataSourceId,
+	NotionPageId,
+} from "@notionhq/custom-blocks-protocol/ids.js"
 import type { NotionCreatePagePosition } from "@notionhq/custom-blocks-protocol/messages/createPage.js"
 import type { CustomBlockCreatePageErrorInfo } from "@notionhq/custom-blocks-protocol/messages/createPageResult.js"
 import type { CustomBlockGetPageErrorInfo } from "@notionhq/custom-blocks-protocol/messages/getPage.js"
@@ -15,25 +18,21 @@ import type { UpdatePageMessage } from "@notionhq/custom-blocks-protocol/message
 import type { CustomBlockUpdatePageErrorInfo } from "@notionhq/custom-blocks-protocol/messages/updatePageResult.js"
 import type {
 	NotionPage,
-	NotionPageId,
-	NotionPagePropertyInputMap,
+	NotionPageCover,
+	NotionPageIcon,
+	NotionPagePropertyValue,
 } from "@notionhq/custom-blocks-protocol/pages/page.js"
 import type {
 	NotionUser,
 	NotionUserList,
 } from "@notionhq/custom-blocks-protocol/users/user.js"
 
-export type {
-	NotionDataSourcePageUpdateArgs,
-	NotionDataSourcePageUpdateInput,
-	NotionDataSourcePageUpdateResult,
-} from "@notionhq/custom-blocks-protocol/dataSources/dataSourcePage.js"
 export type { CustomBlockErrorInfo } from "@notionhq/custom-blocks-protocol/errors.js"
 export type {
 	NotionDataSourceId,
+	NotionPageId,
 	NotionSpaceId,
 } from "@notionhq/custom-blocks-protocol/ids.js"
-export type { NotionPageId } from "@notionhq/custom-blocks-protocol/pages/page.js"
 export type {
 	NotionUser,
 	NotionUserId,
@@ -48,6 +47,69 @@ export type {
 	CustomBlockUpdatePageErrorInfo,
 }
 
+type WithOptionalPropertyId<T> = T extends { id: string }
+	? Omit<T, "id"> & { id?: string }
+	: never
+
+/**
+ * Public SDK page property write input. Keys may be raw property IDs or data source
+ * property keys. `id` is optional because the SDK resolves the final raw property ID
+ * from the map key before sending the bridge message.
+ */
+export type NotionPagePropertyInputValue =
+	WithOptionalPropertyId<NotionPagePropertyValue>
+
+export type NotionPagePropertyInputMap = {
+	[propertyIdOrKey: string]: NotionPagePropertyInputValue
+}
+
+/**
+ * Consumer-facing page shape returned from `useDataSource`. Derived from the bridge payload
+ * plus the data source's `propertyIdsByKey`.
+ */
+export type NotionDataSourcePage = {
+	id: NotionPageId
+	/**
+	 * Keyed mapping of raw property IDs to their value. Includes all properties on the data source,
+	 * including the four built-ins (`created_time`, `last_edited_time`, `created_by`,
+	 * `last_edited_by`).
+	 */
+	propertiesById: { [propertyId: string]: NotionDataSourceValue | undefined }
+	/**
+	 * Keyed mapping of user-defined keys to their value. Only includes properties that are mapped
+	 * to a raw property ID in the data source's `propertyIdsByKey`.
+	 */
+	propertiesByKey: { [key: string]: NotionDataSourceValue | undefined }
+	/**
+	 * Updates this page using the data source's property-key bindings. The SDK resolves property
+	 * keys to raw property IDs before sending the bridge message to the host.
+	 */
+	update: (
+		args: NotionDataSourcePageUpdateArgs,
+	) => Promise<NotionDataSourcePageUpdateResult>
+}
+
+export type NotionDataSourcePageUpdateArgs = {
+	properties?: NotionPagePropertyInputMap
+	icon?: NotionPageIcon
+	cover?: NotionPageCover
+	archived?: boolean
+}
+
+/**
+ * @deprecated Use `NotionDataSourcePageUpdateArgs` instead.
+ *
+ * TODO(custom-blocks): Remove this alias when bumping the SDK version to 0.2.0.
+ */
+export type NotionDataSourcePageUpdateInput = NotionDataSourcePageUpdateArgs
+
+export type NotionDataSourcePageUpdateResult =
+	| {
+			status: "success"
+			page: NotionPage
+	  }
+	| { status: "error"; error: CustomBlockUpdatePageErrorInfo }
+
 /**
  * Return shape of `useDataSource`.
  *