@notionhq/custom-blocks 0.1.6 → 0.1.8

package/src/host/lifecycle/initErrors.ts

@@ -1,165 +0,0 @@
-import type {
-	CustomBlockInitErrorCode,
-	CustomBlockInitErrorInfo,
-} from "../../bridge/messages/init.js"
-
-const UNKNOWN_ERROR_MESSAGE =
-	"Unexpected error while initializing custom block."
-
-/**
- * Returns the error info for a given `init` failure code.
- *
- * `init` handshakes are one-shot: after an `init` error, this host instance will not answer another
- * `connect` message. `isRetryable` means a fresh iframe / `init` attempt could plausibly succeed
- * without changing block code or host configuration.
- */
-export function initErrorForFailureReason(
-	reason: CustomBlockInitErrorCode,
-	data: {
-		minBridgeProtocolVersion?: number
-		currentBridgeProtocolVersion?: number
-	} = {},
-): CustomBlockInitErrorInfo {
-	switch (reason) {
-		case "no_connect":
-			return {
-				code: reason,
-				message: "Sandbox did not send a connect message.",
-				isRetryable: true,
-			}
-		case "invalid_connect":
-			return {
-				code: reason,
-				message: "Sandbox sent an invalid connect message.",
-				// The sandbox must be updated to send a valid connect message.
-				isRetryable: false,
-			}
-		case "manifest_unavailable":
-			return {
-				code: reason,
-				message: "The custom block manifest is unavailable.",
-				isRetryable: true,
-			}
-		case "manifest_invalid":
-			return {
-				code: reason,
-				message: "Sandbox sent an invalid manifest.",
-				// The sandbox must be updated to a valid manifest.
-				isRetryable: false,
-			}
-		case "invalid_protocol_version": {
-			const versionText = data.currentBridgeProtocolVersion
-				? `: ${data.currentBridgeProtocolVersion}`
-				: "."
-			return {
-				code: reason,
-				message: `Sandbox reported an invalid bridge protocol version ${versionText}`,
-				// The sandbox must be updated to a supported protocol version.
-				isRetryable: false,
-			}
-		}
-		case "unsupported_protocol_version": {
-			const currentVersionText = data.currentBridgeProtocolVersion
-				? `${data.currentBridgeProtocolVersion} `
-				: ""
-			const minVersionText = data.minBridgeProtocolVersion
-				? ` Minimum supported version is ${data.minBridgeProtocolVersion}.`
-				: ""
-			return {
-				code: reason,
-				message: `Sandbox bridge protocol version ${currentVersionText}is not supported.${minVersionText}`,
-				// The sandbox must be updated to a supported protocol version.
-				isRetryable: false,
-			}
-		}
-		case "context_unavailable":
-			return {
-				code: reason,
-				message: "Host page context is unavailable.",
-				isRetryable: true,
-			}
-		case "current_user_unavailable":
-			return {
-				code: reason,
-				message: "Current user is unavailable.",
-				isRetryable: true,
-			}
-		case "missing_data_source_binding":
-			return {
-				code: reason,
-				message: "A required data source is not mapped.",
-				// Host configuration must be changed before this block can initialize.
-				isRetryable: false,
-			}
-		case "data_source_unavailable":
-			return {
-				code: reason,
-				message: "A mapped data source is unavailable.",
-				// This error combines some retryable errors (e.g. data source failed to load) with
-				// some non-retryable errors (e.g. data source does not exist or user does not have
-				// access). Fallback to assuming the error is retryable.
-				isRetryable: true,
-			}
-		case "missing_property_binding":
-			return {
-				code: reason,
-				message: "A required data source property is not mapped.",
-				// Host configuration must be changed before this block can initialize.
-				isRetryable: false,
-			}
-		case "invalid_property_binding":
-			return {
-				code: reason,
-				message: "A mapped data source property is missing or incompatible.",
-				// The bound property's schema must be updated or the binding must be updated to
-				// a property with a compatible schema.
-				isRetryable: false,
-			}
-		case "no_init_result":
-			return {
-				code: reason,
-				message: "Sandbox did not acknowledge initialization.",
-				isRetryable: true,
-			}
-		case "invalid_init_result":
-			return {
-				code: reason,
-				message: "Sandbox sent an invalid initialization result.",
-				isRetryable: false,
-			}
-		case "invalid_init_bindings":
-			return {
-				code: reason,
-				message: "Sandbox rejected the host-provided data source bindings.",
-				isRetryable: false,
-			}
-		case "not_in_iframe":
-			return {
-				code: reason,
-				message: "<NotionCustomBlock> only works inside an iframe.",
-				// The block must be embedded in an iframe.
-				isRetryable: false,
-			}
-		case "init_timeout":
-			return {
-				code: reason,
-				message: "Host did not respond to init before the timeout.",
-				isRetryable: true,
-			}
-		case "unknown_error":
-			return {
-				code: reason,
-				message: UNKNOWN_ERROR_MESSAGE,
-				// Treat unknown errors as non-retryable.
-				isRetryable: false,
-			}
-		default:
-			console.warn(`Unexpected custom block init error: ${reason}`)
-			return {
-				code: reason,
-				message: UNKNOWN_ERROR_MESSAGE,
-				// Treat unknown error codes as non-retryable.
-				isRetryable: false,
-			}
-	}
-}

package/src/host/lifecycle/protocolVersion.ts

@@ -1,3 +0,0 @@
-export function isValidBridgeProtocolVersion(version: number): boolean {
-	return Number.isFinite(version) && Number.isInteger(version) && version >= 1
-}

package/src/host/lifecycle/types.ts

@@ -1,40 +0,0 @@
-import type { NotionContrastMode } from "../../bridge/contrast.js"
-import type { NotionDataSourceBindings } from "../../bridge/dataSources/dataSource.js"
-import type { NotionBlockId } from "../../bridge/ids.js"
-import type { CustomBlockManifest } from "../../bridge/manifest.js"
-import type { ConnectMessage } from "../../bridge/messages/connect.js"
-import type { CustomBlockPage } from "../../bridge/pages/page.js"
-import type { NotionParent } from "../../bridge/parent.js"
-import type { NotionTheme } from "../../bridge/theme.js"
-import type { NotionUser } from "../../bridge/users/user.js"
-
-export type ConnectSuccessMessage = Extract<
-	ConnectMessage,
-	{ status: "success" }
->
-
-export type InitStatus =
-	| "waitingForConnect"
-	| "waitingForInitResult"
-	| "success"
-	| "error"
-
-export type CustomBlockHostDataSourcesPayload = {
-	bindings: NotionDataSourceBindings
-}
-
-export type CustomBlockHostInitialDataSources =
-	| CustomBlockHostDataSourcesPayload
-	| ((connect: ConnectSuccessMessage) => CustomBlockHostDataSourcesPayload)
-
-export type CustomBlockHostInitialState = {
-	theme: NotionTheme
-	// TODO(custom-blocks): Make this required when next bumping the protocol version.
-	contrastMode?: NotionContrastMode
-	blockId: NotionBlockId
-	parent: NotionParent
-	page: CustomBlockPage
-	manifest: CustomBlockManifest
-	dataSources: CustomBlockHostInitialDataSources
-	currentUser: NotionUser
-}

package/src/host/messages/invalidSandboxMessage.ts

@@ -1,35 +0,0 @@
-import { readIncomingType } from "../../bridge/incomingType.js"
-import type { InvalidSandboxMessage } from "../../bridge/messages/invalidSandboxMessage.js"
-
-export type InvalidSandboxMessageResponse = {
-	incomingType: string | undefined
-	nack?: InvalidSandboxMessage
-}
-
-export function getInvalidSandboxMessageResponse(
-	data: unknown,
-): InvalidSandboxMessageResponse {
-	const incomingType = readIncomingType(data)
-	if (
-		incomingType === "invalidHostMessage" ||
-		incomingType === "invalidSandboxMessage"
-	) {
-		return { incomingType }
-	}
-	return {
-		incomingType,
-		nack: {
-			type: "invalidSandboxMessage",
-			reason: nackReasonForInvalidSandboxMessage(incomingType),
-		},
-	}
-}
-
-function nackReasonForInvalidSandboxMessage(
-	incomingType: string | undefined,
-): string {
-	if (incomingType !== undefined) {
-		return `Unsupported sandbox message of type "${incomingType}"`
-	}
-	return "Unsupported sandbox message (no `type` field or non-object payload)"
-}

package/src/host/messages/types.ts

@@ -1,67 +0,0 @@
-import type { CreatePageMessage } from "../../bridge/messages/createPage.js"
-import type { CustomBlockCreatePageErrorInfo } from "../../bridge/messages/createPageResult.js"
-import type {
-	CustomBlockGetPageErrorInfo,
-	GetPageMessage,
-} from "../../bridge/messages/getPage.js"
-import type {
-	CustomBlockGetUserErrorInfo,
-	GetUserMessage,
-} from "../../bridge/messages/getUser.js"
-import type {
-	CustomBlockListUsersErrorInfo,
-	ListUsersMessage,
-} from "../../bridge/messages/listUsers.js"
-import type { QueryDataSourceMessage } from "../../bridge/messages/queryDataSource.js"
-import type { ResizeMessage } from "../../bridge/messages/resize.js"
-import type { UpdatePageMessage } from "../../bridge/messages/updatePage.js"
-import type { CustomBlockUpdatePageErrorInfo } from "../../bridge/messages/updatePageResult.js"
-import type { NotionPage } from "../../bridge/pages/page.js"
-import type { NotionUser, NotionUserList } from "../../bridge/users/user.js"
-import type { CustomBlockHostQueryDataSourceResult } from "../queries/types.js"
-
-type MaybePromise<T> = T | Promise<T>
-
-export type CustomBlockHostCreatePageResult =
-	| { status: "success"; page: NotionPage }
-	| { status: "error"; error: CustomBlockCreatePageErrorInfo }
-
-export type CustomBlockHostGetPageResult =
-	| { status: "success"; page: NotionPage }
-	| { status: "error"; error: CustomBlockGetPageErrorInfo }
-
-export type CustomBlockHostUpdatePageResult =
-	| { status: "success"; page: NotionPage }
-	| { status: "error"; error: CustomBlockUpdatePageErrorInfo }
-
-export type CustomBlockHostGetUserResult =
-	| { status: "success"; user: NotionUser }
-	| { status: "error"; error: CustomBlockGetUserErrorInfo }
-
-export type CustomBlockHostListUsersResult =
-	| { status: "success"; list: NotionUserList }
-	| { status: "error"; error: CustomBlockListUsersErrorInfo }
-
-export type CustomBlockHostHandlers = {
-	queryDataSource: (
-		message: QueryDataSourceMessage,
-	) => MaybePromise<CustomBlockHostQueryDataSourceResult>
-	createPage?: (
-		message: CreatePageMessage,
-	) => MaybePromise<CustomBlockHostCreatePageResult>
-	getPage?: (
-		message: GetPageMessage,
-	) => MaybePromise<CustomBlockHostGetPageResult>
-	getUser?: (
-		message: GetUserMessage,
-	) => MaybePromise<CustomBlockHostGetUserResult>
-	listUsers?: (
-		message: ListUsersMessage,
-	) => MaybePromise<CustomBlockHostListUsersResult>
-	updatePage?: (
-		message: UpdatePageMessage,
-	) => MaybePromise<CustomBlockHostUpdatePageResult>
-	resize?: (message: ResizeMessage) => void
-}
-
-export type CustomBlockHostLogDirection = "in" | "out" | "warn"

package/src/host/queries/querySubscriptions.ts

@@ -1,71 +0,0 @@
-import type { NotionDataSourceId } from "../../bridge/ids.js"
-import type { QueryDataSourceMessage } from "../../bridge/messages/queryDataSource.js"
-import type { CustomBlockHostQueryDataSourceResult } from "./types.js"
-
-export type QueryRefresh = {
-	subscriptionId: string
-	response: CustomBlockHostQueryDataSourceResult
-}
-
-type QuerySubscriptionToken = object
-
-type QuerySubscriptionState = {
-	dataSourceId: NotionDataSourceId
-	limit: number
-	token: QuerySubscriptionToken
-}
-
-export class QuerySubscriptions {
-	private readonly bySubscriptionId = new Map<string, QuerySubscriptionState>()
-
-	track(message: QueryDataSourceMessage): QuerySubscriptionToken {
-		const token = {}
-		this.bySubscriptionId.set(message.subscriptionId, {
-			dataSourceId: message.dataSourceId,
-			limit: message.limit,
-			token,
-		})
-		return token
-	}
-
-	isCurrent(subscriptionId: string, token: QuerySubscriptionToken): boolean {
-		return this.bySubscriptionId.get(subscriptionId)?.token === token
-	}
-
-	resolveRefreshes(args: {
-		dataSourceId: NotionDataSourceId
-		response: CustomBlockHostQueryDataSourceResult
-	}): QueryRefresh[] {
-		const refreshes: QueryRefresh[] = []
-		for (const [subscriptionId, queryState] of this.bySubscriptionId) {
-			if (queryState.dataSourceId !== args.dataSourceId) {
-				continue
-			}
-			queryState.token = {}
-			refreshes.push({
-				subscriptionId,
-				response: limitResponse(args.response, queryState.limit),
-			})
-		}
-		return refreshes
-	}
-
-	clear() {
-		this.bySubscriptionId.clear()
-	}
-}
-
-function limitResponse(
-	response: CustomBlockHostQueryDataSourceResult,
-	limit: number,
-): CustomBlockHostQueryDataSourceResult {
-	if (response.status === "error") {
-		return response
-	}
-	const items = response.items.slice(0, limit)
-	return {
-		status: "success",
-		items,
-		hasMore: response.hasMore || response.items.length > items.length,
-	}
-}

package/src/host/queries/types.ts

@@ -1,13 +0,0 @@
-import type { NotionDataSourcePageBridge } from "../../bridge/dataSources/dataSourcePage.js"
-import type { CustomBlockQueryDataSourceErrorInfo } from "../../bridge/messages/queryDataSourceResult.js"
-
-export type CustomBlockHostQueryDataSourceResult =
-	| {
-			status: "success"
-			items: NotionDataSourcePageBridge[]
-			hasMore: boolean
-	  }
-	| {
-			status: "error"
-			error: CustomBlockQueryDataSourceErrorInfo
-	  }

package/src/host.ts

@@ -1,182 +0,0 @@
-/**
- * Host-side entrypoint for `@notionhq/custom-blocks/host`.
- *
- * Re-exports the bridge valibot schemas and data-source binding types so
- * anything implementing the host side of the bridge can validate inbound
- * sandbox traffic and shape outbound traffic without reaching into private
- * `bridge/*` paths.
- *
- * Nothing here is intended for use inside a sandboxed custom block; that
- * surface lives in the default `@notionhq/custom-blocks` entrypoint.
- */
-
-export type { NotionContrastMode } from "./bridge/contrast.js"
-export { notionContrastModeSchema } from "./bridge/contrast.js"
-export type {
-	NotionDataSourceBinding,
-	NotionDataSourceBindings,
-} from "./bridge/dataSources/dataSource.js"
-export {
-	notionDataSourceBindingSchema,
-	notionDataSourceBindingsSchema,
-} from "./bridge/dataSources/dataSource.js"
-export type { NotionDataSourcePageBridge } from "./bridge/dataSources/dataSourcePage.js"
-export { notionDataSourcePageBridgeSchema } from "./bridge/dataSources/dataSourcePage.js"
-export type {
-	CustomBlockDataSourceResolutionErrorCode,
-	CustomBlockDataSourceResolutionErrorInfo,
-} from "./bridge/dataSources/errors.js"
-export { customBlockDataSourceResolutionErrorCodeSchema } from "./bridge/dataSources/errors.js"
-export type {
-	CustomBlockPropertyErrorCode,
-	CustomBlockPropertyErrorInfo,
-} from "./bridge/dataSources/resolveProperty.js"
-export { customBlockPropertyErrorCodeSchema } from "./bridge/dataSources/resolveProperty.js"
-export type { CustomBlockErrorInfo } from "./bridge/errors.js"
-export { customBlockErrorInfoSchema } from "./bridge/errors.js"
-export {
-	notionBlockIdSchema,
-	notionDataSourceIdSchema,
-	notionPageIdSchema,
-} from "./bridge/ids.js"
-export { readIncomingType } from "./bridge/incomingType.js"
-export type { ConnectMessage } from "./bridge/messages/connect.js"
-export { connectMessageSchema } from "./bridge/messages/connect.js"
-export type { ContrastModeChangedMessage } from "./bridge/messages/contrastModeChanged.js"
-export { contrastModeChangedMessageSchema } from "./bridge/messages/contrastModeChanged.js"
-export type { CreatePageMessage } from "./bridge/messages/createPage.js"
-export { createPageMessageSchema } from "./bridge/messages/createPage.js"
-export type {
-	CreatePageResultMessage,
-	CustomBlockCreatePageErrorCode,
-	CustomBlockCreatePageErrorInfo,
-} from "./bridge/messages/createPageResult.js"
-export {
-	createPageResultMessageSchema,
-	customBlockCreatePageErrorCodeSchema,
-	customBlockCreatePageErrorInfoSchema,
-} from "./bridge/messages/createPageResult.js"
-export type { CurrentUserChangedMessage } from "./bridge/messages/currentUserChanged.js"
-export { currentUserChangedMessageSchema } from "./bridge/messages/currentUserChanged.js"
-export type { DataSourcesChangedMessage } from "./bridge/messages/dataSourcesChanged.js"
-export { dataSourcesChangedMessageSchema } from "./bridge/messages/dataSourcesChanged.js"
-export type {
-	CustomBlockGetPageErrorCode,
-	CustomBlockGetPageErrorInfo,
-	GetPageMessage,
-	GetPageResultMessage,
-} from "./bridge/messages/getPage.js"
-export {
-	customBlockGetPageErrorCodeSchema,
-	customBlockGetPageErrorInfoSchema,
-	getPageMessageSchema,
-	getPageResultMessageSchema,
-} from "./bridge/messages/getPage.js"
-export type {
-	CustomBlockGetUserErrorCode,
-	CustomBlockGetUserErrorInfo,
-	GetUserMessage,
-	GetUserResultMessage,
-} from "./bridge/messages/getUser.js"
-export {
-	customBlockGetUserErrorCodeSchema,
-	customBlockGetUserErrorInfoSchema,
-	getUserMessageSchema,
-	getUserResultMessageSchema,
-} from "./bridge/messages/getUser.js"
-export type { HostToSandboxMessage } from "./bridge/messages/hostToSandbox.js"
-export { hostToSandboxMessageSchema } from "./bridge/messages/hostToSandbox.js"
-export type {
-	CustomBlockInitErrorCode,
-	CustomBlockInitErrorInfo,
-	InitMessage,
-} from "./bridge/messages/init.js"
-export {
-	customBlockInitErrorCodeSchema,
-	customBlockInitErrorInfoSchema,
-	initMessageSchema,
-} from "./bridge/messages/init.js"
-export type {
-	CustomBlockInitResultErrorCode,
-	CustomBlockInitResultErrorInfo,
-	InitResultMessage,
-} from "./bridge/messages/initResult.js"
-export {
-	customBlockInitResultErrorCodeSchema,
-	customBlockInitResultErrorInfoSchema,
-	initResultMessageSchema,
-} from "./bridge/messages/initResult.js"
-export type { InvalidHostMessage } from "./bridge/messages/invalidHostMessage.js"
-export { invalidHostMessageSchema } from "./bridge/messages/invalidHostMessage.js"
-export type { InvalidSandboxMessage } from "./bridge/messages/invalidSandboxMessage.js"
-export { invalidSandboxMessageSchema } from "./bridge/messages/invalidSandboxMessage.js"
-export type {
-	CustomBlockListUsersErrorCode,
-	CustomBlockListUsersErrorInfo,
-	ListUsersMessage,
-	ListUsersResultMessage,
-} from "./bridge/messages/listUsers.js"
-export {
-	customBlockListUsersErrorCodeSchema,
-	customBlockListUsersErrorInfoSchema,
-	listUsersMessageSchema,
-	listUsersResultMessageSchema,
-} from "./bridge/messages/listUsers.js"
-export type { PageChangedMessage } from "./bridge/messages/pageChanged.js"
-export { pageChangedMessageSchema } from "./bridge/messages/pageChanged.js"
-export type { ParentChangedMessage } from "./bridge/messages/parentChanged.js"
-export { parentChangedMessageSchema } from "./bridge/messages/parentChanged.js"
-export type { QueryDataSourceMessage } from "./bridge/messages/queryDataSource.js"
-export { queryDataSourceMessageSchema } from "./bridge/messages/queryDataSource.js"
-export type {
-	CustomBlockQueryDataSourceErrorCode,
-	CustomBlockQueryDataSourceErrorInfo,
-	QueryDataSourceResultMessage,
-} from "./bridge/messages/queryDataSourceResult.js"
-export {
-	customBlockQueryDataSourceErrorCodeSchema,
-	customBlockQueryDataSourceErrorInfoSchema,
-	queryDataSourceResultMessageSchema,
-} from "./bridge/messages/queryDataSourceResult.js"
-export type { ResizeMessage } from "./bridge/messages/resize.js"
-export { resizeMessageSchema } from "./bridge/messages/resize.js"
-export type { SandboxToHostMessage } from "./bridge/messages/sandboxToHost.js"
-export { sandboxToHostMessageSchema } from "./bridge/messages/sandboxToHost.js"
-export type { ThemeChangedMessage } from "./bridge/messages/themeChanged.js"
-export { themeChangedMessageSchema } from "./bridge/messages/themeChanged.js"
-export type { UpdatePageMessage } from "./bridge/messages/updatePage.js"
-export { updatePageMessageSchema } from "./bridge/messages/updatePage.js"
-export type {
-	CustomBlockUpdatePageErrorCode,
-	CustomBlockUpdatePageErrorInfo,
-	UpdatePageResultMessage,
-} from "./bridge/messages/updatePageResult.js"
-export {
-	customBlockUpdatePageErrorCodeSchema,
-	customBlockUpdatePageErrorInfoSchema,
-	updatePageResultMessageSchema,
-} from "./bridge/messages/updatePageResult.js"
-export type { CustomBlockPage } from "./bridge/pages/page.js"
-export { customBlockPageSchema } from "./bridge/pages/page.js"
-export { notionParentSchema } from "./bridge/parent.js"
-export {
-	type CustomBlockHostHandle,
-	type CustomBlockHostOptions,
-	createCustomBlockHost,
-} from "./host/createCustomBlockHost.js"
-export type {
-	ConnectSuccessMessage,
-	CustomBlockHostDataSourcesPayload,
-	CustomBlockHostInitialDataSources,
-	CustomBlockHostInitialState,
-} from "./host/lifecycle/types.js"
-export type {
-	CustomBlockHostCreatePageResult,
-	CustomBlockHostGetPageResult,
-	CustomBlockHostGetUserResult,
-	CustomBlockHostHandlers,
-	CustomBlockHostListUsersResult,
-	CustomBlockHostLogDirection,
-	CustomBlockHostUpdatePageResult,
-} from "./host/messages/types.js"
-export type { CustomBlockHostQueryDataSourceResult } from "./host/queries/types.js"