@notionhq/custom-blocks 0.1.6 → 0.1.8

package/src/bridge/messages/hostToSandbox.ts

@@ -1,39 +0,0 @@
-import * as v from "valibot"
-import { contrastModeChangedMessageSchema } from "./contrastModeChanged.js"
-import { createPageResultMessageSchema } from "./createPageResult.js"
-import { currentUserChangedMessageSchema } from "./currentUserChanged.js"
-import { dataSourcesChangedMessageSchema } from "./dataSourcesChanged.js"
-import { getPageResultMessageSchema } from "./getPage.js"
-import { getUserResultMessageSchema } from "./getUser.js"
-import { initMessageSchema } from "./init.js"
-import { invalidSandboxMessageSchema } from "./invalidSandboxMessage.js"
-import { listUsersResultMessageSchema } from "./listUsers.js"
-import { pageChangedMessageSchema } from "./pageChanged.js"
-import { parentChangedMessageSchema } from "./parentChanged.js"
-import { queryDataSourceResultMessageSchema } from "./queryDataSourceResult.js"
-import { themeChangedMessageSchema } from "./themeChanged.js"
-import { updatePageResultMessageSchema } from "./updatePageResult.js"
-
-/**
- * Discriminated union of every message the host is allowed to send the sandbox.
- */
-export const hostToSandboxMessageSchema = v.variant("type", [
-	initMessageSchema,
-	themeChangedMessageSchema,
-	contrastModeChangedMessageSchema,
-	parentChangedMessageSchema,
-	pageChangedMessageSchema,
-	currentUserChangedMessageSchema,
-	dataSourcesChangedMessageSchema,
-	queryDataSourceResultMessageSchema,
-	createPageResultMessageSchema,
-	getPageResultMessageSchema,
-	getUserResultMessageSchema,
-	listUsersResultMessageSchema,
-	updatePageResultMessageSchema,
-	invalidSandboxMessageSchema,
-])
-
-export type HostToSandboxMessage = v.InferOutput<
-	typeof hostToSandboxMessageSchema
->

package/src/bridge/messages/init.ts

@@ -1,99 +0,0 @@
-import * as v from "valibot"
-import { DEFAULT_CONTRAST_MODE, notionContrastModeSchema } from "../contrast.js"
-import { notionDataSourceBindingsSchema } from "../dataSources/dataSource.js"
-import type { CustomBlockErrorCode, CustomBlockErrorInfo } from "../errors.js"
-import { notionBlockIdSchema } from "../ids.js"
-import { manifestSchema } from "../manifest.js"
-import { customBlockPageSchema } from "../pages/page.js"
-import { notionParentSchema } from "../parent.js"
-import { notionThemeSchema } from "../theme.js"
-import { notionUserSchema } from "../users/user.js"
-import type { CustomBlockInitResultErrorCode } from "./initResult.js"
-
-// The schema accepts any string code. The type lists known codes for
-// autocomplete, with an open string fallback for newer senders.
-export const customBlockInitErrorCodeSchema = v.string()
-
-export type CustomBlockInitErrorCode = CustomBlockErrorCode<
-	| "manifest_unavailable"
-	| "manifest_invalid"
-	| "invalid_protocol_version"
-	| "unsupported_protocol_version"
-	| "context_unavailable"
-	| "current_user_unavailable"
-	| "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
- * received in `init`, errors the sandbox reports in `initResult`, and failures
- * detected locally while running `initCustomBlock()`.
- */
-export type CustomBlockInitializationErrorCode =
-	| CustomBlockInitErrorCode
-	| CustomBlockInitResultErrorCode
-	| CustomBlockErrorCode<"not_in_iframe" | "init_timeout">
-
-export type CustomBlockInitializationErrorInfo =
-	CustomBlockErrorInfo<CustomBlockInitializationErrorCode>
-
-export const customBlockInitErrorInfoSchema = v.object({
-	code: customBlockInitErrorCodeSchema,
-	message: v.string(),
-	isRetryable: v.boolean(),
-})
-
-export class CustomBlockInitializationError
-	extends Error
-	implements CustomBlockErrorInfo
-{
-	constructor(error: CustomBlockInitializationErrorInfo) {
-		super(error.message)
-		this.name = "CustomBlockInitializationError"
-		this.code = error.code
-		this.isRetryable = error.isRetryable
-	}
-
-	code: CustomBlockInitializationErrorCode
-	isRetryable: boolean
-}
-
-/**
- * Initialization message sent by the host to the sandbox exactly once, in response to the
- * sandbox's `connect` message. The sandbox echoes `initializationId` in `initResult`. After
- * successful initialization, live updates flow through narrower messages
- * (`themeChanged`, `contrastModeChanged`, `parentChanged`, `pageChanged`,
- * `dataSourcesChanged`).
- */
-export const initMessageSchema = v.variant("status", [
-	v.object({
-		type: v.literal("init"),
-		initializationId: v.string(),
-		status: v.literal("success"),
-		theme: notionThemeSchema,
-		// TODO(custom-blocks): Make this required when next bumping the protocol version.
-		contrastMode: v.optional(notionContrastModeSchema, DEFAULT_CONTRAST_MODE),
-		blockId: notionBlockIdSchema,
-		parent: notionParentSchema,
-		page: customBlockPageSchema,
-		manifest: manifestSchema,
-		dataSources: v.object({
-			bindings: notionDataSourceBindingsSchema,
-		}),
-		currentUser: notionUserSchema,
-	}),
-	v.object({
-		type: v.literal("init"),
-		initializationId: v.string(),
-		status: v.literal("error"),
-		error: customBlockInitErrorInfoSchema,
-	}),
-])
-
-export type InitMessage = v.InferOutput<typeof initMessageSchema>

package/src/bridge/messages/initResult.ts

@@ -1,37 +0,0 @@
-import * as v from "valibot"
-import type { CustomBlockErrorCode, CustomBlockErrorInfo } from "../errors.js"
-
-// The schema accepts any string code. The type lists known codes for
-// autocomplete, with an open string fallback for newer senders.
-export const customBlockInitResultErrorCodeSchema = v.string()
-
-export type CustomBlockInitResultErrorCode =
-	CustomBlockErrorCode<"invalid_init_bindings">
-
-export type CustomBlockInitResultErrorInfo =
-	CustomBlockErrorInfo<CustomBlockInitResultErrorCode>
-
-export const customBlockInitResultErrorInfoSchema = v.object({
-	code: customBlockInitResultErrorCodeSchema,
-	message: v.string(),
-	isRetryable: v.boolean(),
-})
-
-/**
- * Acknowledges whether the sandbox successfully applied the host's `init` response.
- */
-export const initResultMessageSchema = v.variant("status", [
-	v.object({
-		type: v.literal("initResult"),
-		initializationId: v.string(),
-		status: v.literal("success"),
-	}),
-	v.object({
-		type: v.literal("initResult"),
-		initializationId: v.string(),
-		status: v.literal("error"),
-		error: customBlockInitResultErrorInfoSchema,
-	}),
-])
-
-export type InitResultMessage = v.InferOutput<typeof initResultMessageSchema>

package/src/bridge/messages/invalidHostMessage.ts

@@ -1,16 +0,0 @@
-import * as v from "valibot"
-
-/**
- * Sent by the sandbox back to the host when an inbound host-to-sandbox message could not be parsed
- * (unknown `type`, schema mismatch, etc.). The host should never reply to an `invalidHostMessage`
- * with another bridge error message.
- */
-export const invalidHostMessageSchema = v.object({
-	type: v.literal("invalidHostMessage"),
-	/**
-	 * A human-readable string intended for sandbox-side logging. It has no structured contract.
-	 */
-	reason: v.string(),
-})
-
-export type InvalidHostMessage = v.InferOutput<typeof invalidHostMessageSchema>

package/src/bridge/messages/invalidSandboxMessage.ts

@@ -1,18 +0,0 @@
-import * as v from "valibot"
-
-/**
- * Sent by the host back to the sandbox when an inbound sandbox-to-host message could not be parsed
- * (unknown `type`, schema mismatch, etc.). The sandbox should never reply to an
- * `invalidSandboxMessage` with another bridge error message.
- */
-export const invalidSandboxMessageSchema = v.object({
-	type: v.literal("invalidSandboxMessage"),
-	/**
-	 * A human-readable string intended for sandbox-side logging. It has no structured contract.
-	 */
-	reason: v.string(),
-})
-
-export type InvalidSandboxMessage = v.InferOutput<
-	typeof invalidSandboxMessageSchema
->

package/src/bridge/messages/listUsers.ts

@@ -1,50 +0,0 @@
-import * as v from "valibot"
-import type { CustomBlockErrorCode, CustomBlockErrorInfo } from "../errors.js"
-import { notionUserListSchema } from "../users/user.js"
-
-// The schema accepts any string code. The type lists known codes for
-// autocomplete, with an open string fallback for newer senders.
-export const customBlockListUsersErrorCodeSchema = v.string()
-
-export type CustomBlockListUsersErrorCode =
-	CustomBlockErrorCode<"list_users_failed">
-
-export type CustomBlockListUsersErrorInfo =
-	CustomBlockErrorInfo<CustomBlockListUsersErrorCode>
-
-export const customBlockListUsersErrorInfoSchema = v.object({
-	code: customBlockListUsersErrorCodeSchema,
-	message: v.string(),
-	isRetryable: v.boolean(),
-})
-
-/**
- * Sandbox -> host: list users visible in the custom block's workspace.
- */
-export const listUsersMessageSchema = v.object({
-	type: v.literal("listUsers"),
-	requestId: v.string(),
-	startCursor: v.optional(v.string()),
-	pageSize: v.optional(v.number()),
-})
-
-export type ListUsersMessage = v.InferOutput<typeof listUsersMessageSchema>
-
-export const listUsersResultMessageSchema = v.variant("status", [
-	v.object({
-		type: v.literal("listUsersResult"),
-		requestId: v.string(),
-		status: v.literal("success"),
-		list: notionUserListSchema,
-	}),
-	v.object({
-		type: v.literal("listUsersResult"),
-		requestId: v.string(),
-		status: v.literal("error"),
-		error: customBlockListUsersErrorInfoSchema,
-	}),
-])
-
-export type ListUsersResultMessage = v.InferOutput<
-	typeof listUsersResultMessageSchema
->

package/src/bridge/messages/pageChanged.ts

@@ -1,12 +0,0 @@
-import * as v from "valibot"
-import { customBlockPageSchema } from "../pages/page.js"
-
-/**
- * Message sent by the host whenever the custom block's nearest page ancestor changes.
- */
-export const pageChangedMessageSchema = v.object({
-	type: v.literal("pageChanged"),
-	page: customBlockPageSchema,
-})
-
-export type PageChangedMessage = v.InferOutput<typeof pageChangedMessageSchema>

package/src/bridge/messages/parentChanged.ts

@@ -1,14 +0,0 @@
-import * as v from "valibot"
-import { notionParentSchema } from "../parent.js"
-
-/**
- * Message sent by the host whenever the custom block's parent changes.
- */
-export const parentChangedMessageSchema = v.object({
-	type: v.literal("parentChanged"),
-	parent: notionParentSchema,
-})
-
-export type ParentChangedMessage = v.InferOutput<
-	typeof parentChangedMessageSchema
->

package/src/bridge/messages/queryDataSource.ts

@@ -1,20 +0,0 @@
-import * as v from "valibot"
-import { notionDataSourceIdSchema } from "../ids.js"
-
-/**
- * Message sent by the sandbox to ask the host for the current rows in a resolved
- * Notion data source.
- */
-export const queryDataSourceMessageSchema = v.object({
-	type: v.literal("queryDataSource"),
-	/** Stable for the lifetime of this query subscription. */
-	subscriptionId: v.string(),
-	/** The raw Notion data source ID to read from. */
-	dataSourceId: notionDataSourceIdSchema,
-	/** The number of items to return in each subscription update. */
-	limit: v.number(),
-})
-
-export type QueryDataSourceMessage = v.InferOutput<
-	typeof queryDataSourceMessageSchema
->

package/src/bridge/messages/queryDataSourceResult.ts

@@ -1,45 +0,0 @@
-import * as v from "valibot"
-import { notionDataSourcePageBridgeSchema } from "../dataSources/dataSourcePage.js"
-import type { CustomBlockErrorCode, CustomBlockErrorInfo } from "../errors.js"
-
-// The schema accepts any string code. The type lists known codes for
-// autocomplete, with an open string fallback for newer senders.
-export const customBlockQueryDataSourceErrorCodeSchema = v.string()
-
-export type CustomBlockQueryDataSourceErrorCode = CustomBlockErrorCode<
-	| "query_data_source_failed"
-	| "unknown_data_source_key"
-	| "unmapped_data_source"
->
-
-export type CustomBlockQueryDataSourceErrorInfo =
-	CustomBlockErrorInfo<CustomBlockQueryDataSourceErrorCode>
-
-export const customBlockQueryDataSourceErrorInfoSchema = v.object({
-	code: customBlockQueryDataSourceErrorCodeSchema,
-	message: v.string(),
-	isRetryable: v.boolean(),
-})
-
-/**
- * Message sent by the host to update a `queryDataSource` subscription.
- */
-export const queryDataSourceResultMessageSchema = v.variant("status", [
-	v.object({
-		type: v.literal("queryDataSourceResult"),
-		subscriptionId: v.string(),
-		status: v.literal("success"),
-		items: v.array(notionDataSourcePageBridgeSchema),
-		hasMore: v.boolean(),
-	}),
-	v.object({
-		type: v.literal("queryDataSourceResult"),
-		subscriptionId: v.string(),
-		status: v.literal("error"),
-		error: customBlockQueryDataSourceErrorInfoSchema,
-	}),
-])
-
-export type QueryDataSourceResultMessage = v.InferOutput<
-	typeof queryDataSourceResultMessageSchema
->

package/src/bridge/messages/resize.ts

@@ -1,13 +0,0 @@
-import * as v from "valibot"
-
-/**
- * Message sent by the sandbox whenever its measured content height changes, so the host can resize
- * the surrounding iframe to match. The host is free to clamp the value or ignore it. The sandbox
- * always reports the most recent measurement.
- */
-export const resizeMessageSchema = v.object({
-	type: v.literal("resize"),
-	height: v.pipe(v.number(), v.finite(), v.minValue(0)),
-})
-
-export type ResizeMessage = v.InferOutput<typeof resizeMessageSchema>

package/src/bridge/messages/sandboxToHost.ts

@@ -1,32 +0,0 @@
-import * as v from "valibot"
-import { connectMessageSchema } from "./connect.js"
-import { createPageMessageSchema } from "./createPage.js"
-import { getPageMessageSchema } from "./getPage.js"
-import { getUserMessageSchema } from "./getUser.js"
-import { initResultMessageSchema } from "./initResult.js"
-import { invalidHostMessageSchema } from "./invalidHostMessage.js"
-import { listUsersMessageSchema } from "./listUsers.js"
-import { queryDataSourceMessageSchema } from "./queryDataSource.js"
-import { resizeMessageSchema } from "./resize.js"
-import { updatePageMessageSchema } from "./updatePage.js"
-
-/**
- * Union of every message the sandbox is allowed to send the host. Useful for hosts to validate
- * inbound traffic from sandboxes without re-implementing validation logic.
- */
-export const sandboxToHostMessageSchema = v.union([
-	connectMessageSchema,
-	initResultMessageSchema,
-	queryDataSourceMessageSchema,
-	createPageMessageSchema,
-	getPageMessageSchema,
-	getUserMessageSchema,
-	listUsersMessageSchema,
-	updatePageMessageSchema,
-	resizeMessageSchema,
-	invalidHostMessageSchema,
-])
-
-export type SandboxToHostMessage = v.InferOutput<
-	typeof sandboxToHostMessageSchema
->

package/src/bridge/messages/themeChanged.ts

@@ -1,15 +0,0 @@
-import * as v from "valibot"
-import { notionThemeSchema } from "../theme.js"
-
-/**
- * Message sent by the host every time the theme changes after the initial
- * `init` handshake.
- */
-export const themeChangedMessageSchema = v.object({
-	type: v.literal("themeChanged"),
-	theme: notionThemeSchema,
-})
-
-export type ThemeChangedMessage = v.InferOutput<
-	typeof themeChangedMessageSchema
->

package/src/bridge/messages/updatePage.ts

@@ -1,22 +0,0 @@
-import * as v from "valibot"
-import { notionPageIdSchema } from "../ids.js"
-import {
-	notionPageCoverSchema,
-	notionPageIconSchema,
-	notionPagePropertyWriteMapSchema,
-} from "../pages/page.js"
-
-/**
- * Sandbox -> host: patch an existing page.
- */
-export const updatePageMessageSchema = v.object({
-	type: v.literal("updatePage"),
-	requestId: v.string(),
-	pageId: notionPageIdSchema,
-	properties: v.optional(notionPagePropertyWriteMapSchema),
-	icon: v.optional(notionPageIconSchema),
-	cover: v.optional(notionPageCoverSchema),
-	archived: v.optional(v.boolean()),
-})
-
-export type UpdatePageMessage = v.InferOutput<typeof updatePageMessageSchema>

package/src/bridge/messages/updatePageResult.ts

@@ -1,49 +0,0 @@
-import * as v from "valibot"
-import type { CustomBlockErrorCode, CustomBlockErrorInfo } from "../errors.js"
-import { notionPageSchema } from "../pages/page.js"
-
-// The schema accepts any string code. The type lists known codes for
-// autocomplete, with an open string fallback for newer senders.
-export const customBlockUpdatePageErrorCodeSchema = v.string()
-
-export type CustomBlockUpdatePageErrorCode = CustomBlockErrorCode<
-	| "update_page_failed"
-	| "invalid_page_update"
-	| "page_access_failed"
-	| "collection_access_failed"
-	| "unmapped_property"
-	| "property_id_mismatch"
-	| "duplicate_property"
-	| "invalid_property_value"
->
-
-export type CustomBlockUpdatePageErrorInfo =
-	CustomBlockErrorInfo<CustomBlockUpdatePageErrorCode>
-
-export const customBlockUpdatePageErrorInfoSchema = v.object({
-	code: customBlockUpdatePageErrorCodeSchema,
-	message: v.string(),
-	isRetryable: v.boolean(),
-})
-
-/**
- * Host -> sandbox: result for a page update request.
- */
-export const updatePageResultMessageSchema = v.variant("status", [
-	v.object({
-		type: v.literal("updatePageResult"),
-		requestId: v.string(),
-		status: v.literal("success"),
-		page: notionPageSchema,
-	}),
-	v.object({
-		type: v.literal("updatePageResult"),
-		requestId: v.string(),
-		status: v.literal("error"),
-		error: customBlockUpdatePageErrorInfoSchema,
-	}),
-])
-
-export type UpdatePageResultMessage = v.InferOutput<
-	typeof updatePageResultMessageSchema
->