@notionhq/custom-blocks-host 0.4.1 → 0.4.3

package/src/lifecycle/initErrors.ts

@@ -1,131 +0,0 @@
-import type { CustomBlockErrorInfo } from "@notionhq/custom-blocks-protocol/errors.js"
-
-/**
- * Initialization handshakes are one-shot: after an error, this host instance will not answer
- * another `connect` message. `isRetryable` means a fresh host and iframe could plausibly
- * initialize without changing block code or host configuration.
- */
-export function noConnectError(): CustomBlockErrorInfo<"no_connect"> {
-	return {
-		code: "no_connect",
-		message: "Sandbox did not send a connect message.",
-		// A fresh iframe may finish loading and send connect before the timeout.
-		isRetryable: true,
-	}
-}
-
-export function invalidConnectPayloadError(): CustomBlockErrorInfo<"invalid_connect_payload"> {
-	return {
-		code: "invalid_connect_payload",
-		message: "Sandbox sent an invalid connect message.",
-		// The sandbox must be updated to send a valid connect message.
-		isRetryable: false,
-	}
-}
-
-export function invalidProtocolVersionError(args: {
-	currentBridgeProtocolVersion: number | undefined
-}): CustomBlockErrorInfo<"invalid_protocol_version"> {
-	const { currentBridgeProtocolVersion } = args
-	return {
-		code: "invalid_protocol_version",
-		message: `Sandbox reported an invalid bridge protocol version: ${currentBridgeProtocolVersion}`,
-		// The sandbox must be updated to a supported protocol version.
-		isRetryable: false,
-	}
-}
-
-export function unsupportedProtocolVersionError(args: {
-	currentBridgeProtocolVersion: number
-	minBridgeProtocolVersion: number
-}): CustomBlockErrorInfo<"unsupported_protocol_version"> {
-	const { currentBridgeProtocolVersion, minBridgeProtocolVersion } = args
-	return {
-		code: "unsupported_protocol_version",
-		message: `Sandbox bridge protocol version ${currentBridgeProtocolVersion} is not supported. Minimum supported version is ${minBridgeProtocolVersion}.`,
-		// The sandbox must be updated to a supported protocol version.
-		isRetryable: false,
-	}
-}
-
-export function contextUnavailableError(): CustomBlockErrorInfo<"context_unavailable"> {
-	return {
-		code: "context_unavailable",
-		message: "Host page context is unavailable.",
-		// Page context may become available before a fresh initialization attempt.
-		isRetryable: true,
-	}
-}
-
-export function initialStateTimeoutError(): CustomBlockErrorInfo<"initial_state_timeout"> {
-	return {
-		code: "initial_state_timeout",
-		message: "Host did not prepare initial state before the timeout.",
-		// A fresh attempt may finish loading host dependencies before the timeout.
-		isRetryable: true,
-	}
-}
-
-export function missingDataSourceBindingError(): CustomBlockErrorInfo<"missing_data_source_binding"> {
-	return {
-		code: "missing_data_source_binding",
-		message: "A required data source is not mapped.",
-		// Host configuration must be changed before this block can initialize.
-		isRetryable: false,
-	}
-}
-
-export function missingPropertyBindingError(): CustomBlockErrorInfo<"missing_property_binding"> {
-	return {
-		code: "missing_property_binding",
-		message: "A required data source property is not mapped.",
-		// Host configuration must be changed before this block can initialize.
-		isRetryable: false,
-	}
-}
-
-export function invalidPropertyBindingError(): CustomBlockErrorInfo<"invalid_property_binding"> {
-	return {
-		code: "invalid_property_binding",
-		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,
-	}
-}
-
-export function noInitResultError(): CustomBlockErrorInfo<"no_init_result"> {
-	return {
-		code: "no_init_result",
-		message: "Sandbox did not acknowledge initialization.",
-		// A fresh iframe may process init and acknowledge it before the timeout.
-		isRetryable: true,
-	}
-}
-
-export function invalidInitResultPayloadError(): CustomBlockErrorInfo<"invalid_init_result_payload"> {
-	return {
-		code: "invalid_init_result_payload",
-		message: "Sandbox sent an invalid initialization result.",
-		// The sandbox must be updated to send a valid initialization result.
-		isRetryable: false,
-	}
-}
-
-export function unknownInitializationError(): CustomBlockErrorInfo<"unknown_error"> {
-	return {
-		code: "unknown_error",
-		message: "Unexpected error while initializing custom block.",
-		// Without a known transient cause, conservatively treat unknown errors as non-retryable.
-		isRetryable: false,
-	}
-}
-
-export function invalidLocalPreviewUrlError(): CustomBlockErrorInfo<"invalid_local_preview_url"> {
-	return {
-		code: "invalid_local_preview_url",
-		message:
-			"Local custom blocks require an HTTP(S) URL on localhost, a .localhost subdomain, or 127.0.0.1, without credentials and on a different origin from the host.",
-		isRetryable: false,
-	}
-}

package/src/messages/types.ts

@@ -1,171 +0,0 @@
-import type { CustomBlockErrorInfo } from "@notionhq/custom-blocks-protocol/errors.js"
-import type {
-	CreatePageMessage,
-	createPageMessageSchema,
-} from "@notionhq/custom-blocks-protocol/messages/createPage.js"
-import type {
-	CustomBlockCreatePageErrorInfo,
-	createPageResultMessageSchema,
-} from "@notionhq/custom-blocks-protocol/messages/createPageResult.js"
-import type {
-	CustomBlockGetPageErrorInfo,
-	GetPageMessage,
-	getPageMessageSchema,
-	getPageResultMessageSchema,
-} from "@notionhq/custom-blocks-protocol/messages/getPage.js"
-import type {
-	CustomBlockGetUserErrorInfo,
-	GetUserMessage,
-	getUserMessageSchema,
-	getUserResultMessageSchema,
-} from "@notionhq/custom-blocks-protocol/messages/getUser.js"
-import type {
-	CustomBlockListUsersErrorInfo,
-	ListUsersMessage,
-	listUsersMessageSchema,
-	listUsersResultMessageSchema,
-} from "@notionhq/custom-blocks-protocol/messages/listUsers.js"
-import type { BridgeMessagePayload } from "@notionhq/custom-blocks-protocol/messages/messagePayload.js"
-import type {
-	CustomBlockOpenExternalUrlErrorInfo,
-	OpenExternalUrlMessage,
-	OpenExternalUrlResultMessage,
-	openExternalUrlMessageSchema,
-} from "@notionhq/custom-blocks-protocol/messages/openExternalUrl.js"
-import type {
-	CustomBlockOpenPageErrorInfo,
-	OpenPageMessage,
-	openPageMessageSchema,
-	openPageResultMessageSchema,
-} from "@notionhq/custom-blocks-protocol/messages/openPage.js"
-import type {
-	QueryDataSourceMessage,
-	queryDataSourceMessageSchema,
-} from "@notionhq/custom-blocks-protocol/messages/queryDataSource.js"
-import type {
-	ResizeMessage,
-	resizeMessageSchema,
-} from "@notionhq/custom-blocks-protocol/messages/resize.js"
-import type {
-	UpdatePageMessage,
-	updatePageMessageSchema,
-} from "@notionhq/custom-blocks-protocol/messages/updatePage.js"
-import type {
-	CustomBlockUpdatePageErrorInfo,
-	updatePageResultMessageSchema,
-} from "@notionhq/custom-blocks-protocol/messages/updatePageResult.js"
-import type { InferInput } from "valibot"
-import type { CustomBlockHostQueryDataSourceResult } from "../queries/types.js"
-
-export type MaybePromise<T> = T | Promise<T>
-
-/**
- * Host results use InferInput so adapters can return plain string IDs.
- * The runtime validates results before sending them and assigns protocol ID brands.
- * Handler requests use parsed protocol types, whose IDs are already branded.
- */
-export type CustomBlockHostCreatePageResult = BridgeMessagePayload<
-	InferInput<typeof createPageResultMessageSchema>,
-	CustomBlockCreatePageErrorInfo
->
-
-export type CustomBlockHostGetPageResult = BridgeMessagePayload<
-	InferInput<typeof getPageResultMessageSchema>,
-	CustomBlockGetPageErrorInfo
->
-
-export type CustomBlockHostUpdatePageResult = BridgeMessagePayload<
-	InferInput<typeof updatePageResultMessageSchema>,
-	CustomBlockUpdatePageErrorInfo
->
-
-export type CustomBlockHostGetUserResult = BridgeMessagePayload<
-	InferInput<typeof getUserResultMessageSchema>,
-	CustomBlockGetUserErrorInfo
->
-
-export type CustomBlockHostListUsersResult = BridgeMessagePayload<
-	InferInput<typeof listUsersResultMessageSchema>,
-	CustomBlockListUsersErrorInfo
->
-
-export type CustomBlockHostOpenPageResult = BridgeMessagePayload<
-	InferInput<typeof openPageResultMessageSchema>,
-	CustomBlockOpenPageErrorInfo
->
-
-export type CustomBlockHostOpenExternalUrlResult = BridgeMessagePayload<
-	OpenExternalUrlResultMessage,
-	CustomBlockOpenExternalUrlErrorInfo
->
-
-export type CustomBlockHostNavigationContext = {
-	signal: AbortSignal
-}
-
-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>
-	openPage?: (
-		message: OpenPageMessage,
-	) => MaybePromise<CustomBlockHostOpenPageResult>
-	openExternalUrl?: (
-		message: OpenExternalUrlMessage,
-		context: CustomBlockHostNavigationContext,
-	) => MaybePromise<CustomBlockHostOpenExternalUrlResult>
-	updatePage?: (
-		message: UpdatePageMessage,
-	) => MaybePromise<CustomBlockHostUpdatePageResult>
-	resize?: (message: ResizeMessage) => void
-}
-
-export type CustomBlockHostFailure = CustomBlockErrorInfo & {
-	/** The handshake step or host lifecycle event that failed. */
-	phase: /** The sandbox's connect message is missing, invalid, unsupported, or reports a startup error. */
-		| "connect"
-		/** The host cannot prepare or validate initial state, or preparation times out. */
-		| "init"
-		/** The sandbox's initialization acknowledgment is missing, invalid, or reports an error. */
-		| "initResult"
-		/** An iframe reload or unavailable page context stops the host, before or after initialization succeeds. */
-		| "runtime"
-	/** Who reported or detected the failure, regardless of who caused it. */
-	source: "host" | "sandbox"
-}
-
-export type CustomBlockHostLogDirection = "in" | "out" | "warn"
-
-export type CreatePageMessageInput = InferInput<typeof createPageMessageSchema>
-
-export type GetPageMessageInput = InferInput<typeof getPageMessageSchema>
-
-export type GetUserMessageInput = InferInput<typeof getUserMessageSchema>
-
-export type ListUsersMessageInput = InferInput<typeof listUsersMessageSchema>
-
-export type OpenPageMessageInput = InferInput<typeof openPageMessageSchema>
-
-export type OpenExternalUrlMessageInput = InferInput<
-	typeof openExternalUrlMessageSchema
->
-
-export type QueryDataSourceMessageInput = InferInput<
-	typeof queryDataSourceMessageSchema
->
-
-export type ResizeMessageInput = InferInput<typeof resizeMessageSchema>
-
-export type UpdatePageMessageInput = InferInput<typeof updatePageMessageSchema>

package/src/queries/types.ts

@@ -1,11 +0,0 @@
-import type { BridgeMessagePayload } from "@notionhq/custom-blocks-protocol/messages/messagePayload.js"
-import type {
-	CustomBlockQueryDataSourceErrorInfo,
-	queryDataSourceResultMessageSchema,
-} from "@notionhq/custom-blocks-protocol/messages/queryDataSourceResult.js"
-import type { InferInput } from "valibot"
-
-export type CustomBlockHostQueryDataSourceResult = BridgeMessagePayload<
-	InferInput<typeof queryDataSourceResultMessageSchema>,
-	CustomBlockQueryDataSourceErrorInfo
->