@notionhq/custom-blocks 0.1.48 → 0.2.0

package/src/customBlock.ts

@@ -1,38 +1,15 @@
 import type { NotionContrastMode } from "@notionhq/custom-blocks-protocol/contrast.js"
-import type { NotionDataSource } from "@notionhq/custom-blocks-protocol/dataSources/dataSource.js"
 import type { NotionBlockId } from "@notionhq/custom-blocks-protocol/ids.js"
 import type { CustomBlockManifest } from "@notionhq/custom-blocks-protocol/manifest.js"
 import type { CustomBlockPage } from "@notionhq/custom-blocks-protocol/pages/page.js"
 import type { NotionParent } from "@notionhq/custom-blocks-protocol/parent.js"
 import type { NotionTheme } from "@notionhq/custom-blocks-protocol/theme.js"
 import type { NotionUser } from "@notionhq/custom-blocks-protocol/users/user.js"
-import { autoResize } from "./autoResize.js"
 import { subscribeToDataSource } from "./bridge/dataSources/subscribe.js"
-import type {
-	CustomBlockHostState,
-	InitializedHostState,
-} from "./bridge/hostState.js"
+import type { InitializedHostState } from "./bridge/hostState.js"
 import { notifyListener } from "./bridge/notifyListener.js"
 import { customBlockHost } from "./bridge/sandboxClient.js"
 
-/** @deprecated Use individual context types and getters after `initCustomBlock` resolves. */
-export type CustomBlockState =
-	| {
-			status: "uninitialized"
-			theme: NotionTheme
-			contrastMode: NotionContrastMode
-	  }
-	| {
-			status: "initialized"
-			theme: NotionTheme
-			contrastMode: NotionContrastMode
-			blockId: NotionBlockId
-			parent: NotionParent
-			page: CustomBlockPage
-			currentUser: NotionUser
-			dataSources: NotionDataSource[]
-	  }
-
 type Unsubscribe = () => void
 
 /**
@@ -45,16 +22,6 @@ type Unsubscribe = () => void
  * subscription is no longer needed.
  */
 export const customBlock = {
-	/** @deprecated Use an individual subscription method, such as `subscribeToTheme()` or `subscribeToCurrentUser()`. */
-	subscribe(listener: () => void): Unsubscribe {
-		return customBlockHost.subscribe(listener)
-	},
-
-	/** @deprecated Use an individual getter method, such as `getTheme()` or `getCurrentUser()`, after `initCustomBlock()` resolves. */
-	getState(): CustomBlockState {
-		return toPublicState(customBlockHost.getState())
-	},
-
 	/**
 	 * Get the current user viewing the block.
 	 * Throws if called before SDK initialization completes.
@@ -171,8 +138,6 @@ export const customBlock = {
 		return subscribeToContext({ key: "manifest", listener })
 	},
 
-	autoResize,
-
 	/**
 	 * Registers a listener that receives the current query snapshot and later updates.
 	 * Returns a function that removes this listener. Other listeners remain subscribed.
@@ -180,35 +145,6 @@ export const customBlock = {
 	subscribeToDataSource,
 }
 
-let lastHostState: CustomBlockHostState | undefined
-let lastPublicState: CustomBlockState | undefined
-
-function toPublicState(hostState: CustomBlockHostState): CustomBlockState {
-	if (hostState === lastHostState && lastPublicState !== undefined) {
-		return lastPublicState
-	}
-	lastHostState = hostState
-	if (hostState.status === "uninitialized") {
-		lastPublicState = {
-			status: "uninitialized",
-			theme: hostState.theme,
-			contrastMode: hostState.contrastMode,
-		}
-		return lastPublicState
-	}
-	lastPublicState = {
-		status: "initialized",
-		theme: hostState.theme,
-		contrastMode: hostState.contrastMode,
-		blockId: hostState.blockId,
-		parent: hostState.parent,
-		page: hostState.page,
-		currentUser: hostState.currentUser,
-		dataSources: hostState.dataSources,
-	}
-	return lastPublicState
-}
-
 function getInitializedHostState(methodName: string): InitializedHostState {
 	const hostState = customBlockHost.getState()
 	if (hostState.status !== "initialized") {

package/src/index.ts

@@ -98,7 +98,7 @@ export type {
 export type { NotionParent } from "@notionhq/custom-blocks-protocol/parent.js"
 export type { NotionTheme } from "@notionhq/custom-blocks-protocol/theme.js"
 export { pages, users } from "./bridge/sandboxClient.js"
-export { type CustomBlockState, customBlock } from "./customBlock.js"
+export { customBlock } from "./customBlock.js"
 export {
 	type CustomBlockInitPayload,
 	initCustomBlock,

package/src/react/NotionCustomBlock.tsx

@@ -1,10 +1,10 @@
 import type { CustomBlockInitializationError } from "@notionhq/custom-blocks-protocol/messages/init.js"
 import { type ReactNode, useEffect, useLayoutEffect, useState } from "react"
+import { autoResize } from "../autoResize.js"
 import { customBlockHost } from "../bridge/sandboxClient.js"
 import { NotInIframeError } from "../init.js"
 import { DebugMessageLog } from "./DebugMessageLog.js"
 import { seedStandalonePreviewState } from "./standalonePreview.js"
-import { useCustomBlockAutoResize } from "./useCustomBlockAutoResize.js"
 import { useCustomBlockInit } from "./useCustomBlockInit.js"
 import { useCustomBlockHost } from "./useHostState.js"
 import "./NotionCustomBlock.css"
@@ -25,14 +25,6 @@ export type NotionCustomBlockProps = {
 	 * rendered with developer details — replace it for production templates.
 	 */
 	errorFallback?: ReactNode | ((error: Error) => ReactNode)
-	/**
-	 * Whether to post resize messages after initialization and dynamically resize the block.
-	 *
-	 * @deprecated TODO(custom-blocks): Remove this prop when bumping the SDK version to 0.2.0.
-	 *
-	 * @default true
-	 */
-	autoResize?: boolean
 }
 
 /**
@@ -57,15 +49,21 @@ export function NotionCustomBlock({
 	children,
 	fallback = null,
 	errorFallback,
-	autoResize = true,
 }: NotionCustomBlockProps) {
 	const init = useCustomBlockInit()
-	useCustomBlockAutoResize({ enabled: init.isLoaded && autoResize })
 	// True if the block has no host (i.e. it's running in standalone preview).
 	const isStandalone = init.error instanceof NotInIframeError
 	const host = useCustomBlockHost()
 	const [debugOpen, setDebugOpen] = useState(false)
 
+	// Keep the host iframe height in sync with the block's content after initialization.
+	useEffect(() => {
+		if (!init.isLoaded || typeof window === "undefined") {
+			return
+		}
+		return autoResize({ target: document.getElementById("root") })
+	}, [init.isLoaded])
+
 	useEffect(() => {
 		const onKeyDown = (e: KeyboardEvent) => {
 			if (e.key === "\\") {

package/src/react/index.ts

@@ -15,7 +15,6 @@ export {
 	NotionTokenScope,
 	type NotionTokenScopeProps,
 } from "./NotionTokenScope.js"
-export { useCustomBlockAutoResize } from "./useCustomBlockAutoResize.js"
 export {
 	type UseCustomBlockInitResult,
 	useCustomBlockInit,

package/src/types.ts

@@ -85,11 +85,10 @@ export type NotionPagePropertyInputMap = {
  */
 export type NotionDataSourcePage = {
 	id: NotionPageId
-	// TODO(custom-blocks): Require is_archived and in_trash in bridge protocol v4.
 	/** Whether the page or an ancestor is archived. */
-	is_archived?: boolean
+	is_archived: boolean
 	/** Whether the page or an ancestor is in Trash. */
-	in_trash?: boolean
+	in_trash: boolean
 	/**
 	 * 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`,
@@ -116,27 +115,10 @@ export type NotionDataSourcePageUpdateArgs = {
 	properties?: NotionPagePropertyInputMap
 	icon?: NotionPageIcon
 	cover?: NotionPageCover
-	/** Whether to archive this page. Takes precedence over archived. */
+	/** Whether to archive this page. */
 	is_archived?: boolean
-	/** @deprecated Use is_archived instead. */
-	// TODO(custom-blocks): Remove archived when upgrading to bridge protocol v4.
-	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
-
-/**
- * @deprecated Use `UpdatePageResult` instead.
- *
- * TODO(custom-blocks): Remove this alias when bumping the SDK version to 0.2.0.
- */
-export type NotionDataSourcePageUpdateResult = UpdatePageResult
-
 export type NotionDataSourceTextFilterOperator = CustomBlockTextFilterOperator
 export type NotionDataSourceNumberFilterOperator =
 	CustomBlockNumberFilterOperator
@@ -256,13 +238,6 @@ export type CreatePageArgs = {
 	position?: NotionCreatePagePosition
 }
 
-/**
- * @deprecated Use `CreatePageArgs` instead.
- *
- * TODO(custom-blocks): Remove this alias when bumping the SDK version to 0.2.0.
- */
-export type CreatePageInput = CreatePageArgs
-
 /**
  * The result of a `sdk.pages.create` API call.
  */
@@ -275,20 +250,10 @@ export type UpdatePageArgs = Omit<
 	UpdatePageMessage,
 	"type" | "requestId" | "archived"
 > & {
-	/** Whether to archive this page. Takes precedence over archived. */
+	/** Whether to archive this page. */
 	is_archived?: boolean
-	/** @deprecated Use is_archived instead. */
-	// TODO(custom-blocks): Remove archived when upgrading to bridge protocol v4.
-	archived?: boolean
 }
 
-/**
- * @deprecated Use `UpdatePageArgs` instead.
- *
- * TODO(custom-blocks): Remove this alias when bumping the SDK version to 0.2.0.
- */
-export type UpdatePageInput = UpdatePageArgs
-
 /**
  * Result of `sdk.pages.get`.
  */
@@ -307,13 +272,6 @@ export type UpdatePageResult = BridgeMessagePayload<
 
 export type ListUsersArgs = Omit<ListUsersMessage, "type" | "requestId">
 
-/**
- * @deprecated Use `ListUsersArgs` instead.
- *
- * TODO(custom-blocks): Remove this alias when bumping the SDK version to 0.2.0.
- */
-export type ListUsersInput = ListUsersArgs
-
 export type ListUsersResult = BridgeMessagePayload<
 	ListUsersResultMessage,
 	CustomBlockListUsersErrorInfo

package/dist/react/useCustomBlockAutoResize.d.ts

@@ -1,26 +0,0 @@
-/**
- * Measures the sandbox's `#root` element and posts `resize` messages so the host iframe
- * matches the block's border-box height. Unchanged values are deduped.
- *
- * `<NotionCustomBlock>` calls this hook for you. Only use it directly in a custom
- * initialization wrapper that does not render `<NotionCustomBlock>`.
- *
- * @deprecated Use CSS `max-height` and `overflow` to constrain block content instead.
- *
- * @example
- * function App() {
- *   const [enabled, setEnabled] = useState(true)
- *   useCustomBlockAutoResize({ enabled })
- *   return <div>…</div>
- * }
- */
-export declare function useCustomBlockAutoResize(args?: {
-    /**
-     * Whether or not the hook is enabled. To disable this behavior, pass `false`. This is
-     * provided as an argument to allow for conditional disabling of the hook.
-     *
-     * @default true
-     */
-    enabled?: boolean;
-}): void;
-//# sourceMappingURL=useCustomBlockAutoResize.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"useCustomBlockAutoResize.d.ts","sourceRoot":"","sources":["../../src/react/useCustomBlockAutoResize.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,wBAAwB,CACvC,IAAI,GAAE;IACL;;;;;OAKG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;CACZ,GACJ,IAAI,CAYN"}

package/dist/react/useCustomBlockAutoResize.js

@@ -1,31 +0,0 @@
-import { useEffect } from "react";
-import { customBlock } from "../customBlock.js";
-/**
- * Measures the sandbox's `#root` element and posts `resize` messages so the host iframe
- * matches the block's border-box height. Unchanged values are deduped.
- *
- * `<NotionCustomBlock>` calls this hook for you. Only use it directly in a custom
- * initialization wrapper that does not render `<NotionCustomBlock>`.
- *
- * @deprecated Use CSS `max-height` and `overflow` to constrain block content instead.
- *
- * @example
- * function App() {
- *   const [enabled, setEnabled] = useState(true)
- *   useCustomBlockAutoResize({ enabled })
- *   return <div>…</div>
- * }
- */
-export function useCustomBlockAutoResize(args = {}) {
-    const { enabled = true } = args;
-    useEffect(() => {
-        if (!enabled) {
-            return;
-        }
-        if (typeof window === "undefined") {
-            return;
-        }
-        const target = document.getElementById("root");
-        return customBlock.autoResize({ target });
-    }, [enabled]);
-}

package/src/react/useCustomBlockAutoResize.ts

@@ -1,42 +0,0 @@
-import { useEffect } from "react"
-import { customBlock } from "../customBlock.js"
-
-/**
- * Measures the sandbox's `#root` element and posts `resize` messages so the host iframe
- * matches the block's border-box height. Unchanged values are deduped.
- *
- * `<NotionCustomBlock>` calls this hook for you. Only use it directly in a custom
- * initialization wrapper that does not render `<NotionCustomBlock>`.
- *
- * @deprecated Use CSS `max-height` and `overflow` to constrain block content instead.
- *
- * @example
- * function App() {
- *   const [enabled, setEnabled] = useState(true)
- *   useCustomBlockAutoResize({ enabled })
- *   return <div>…</div>
- * }
- */
-export function useCustomBlockAutoResize(
-	args: {
-		/**
-		 * Whether or not the hook is enabled. To disable this behavior, pass `false`. This is
-		 * provided as an argument to allow for conditional disabling of the hook.
-		 *
-		 * @default true
-		 */
-		enabled?: boolean
-	} = {},
-): void {
-	const { enabled = true } = args
-	useEffect(() => {
-		if (!enabled) {
-			return
-		}
-		if (typeof window === "undefined") {
-			return
-		}
-		const target = document.getElementById("root")
-		return customBlock.autoResize({ target })
-	}, [enabled])
-}

package/vite-plugin/index.d.ts

@@ -1,12 +0,0 @@
-export type NotionCustomBlockPlugin = {
-	name: string
-}
-
-/**
- * Vite plugin for Notion custom blocks.
- *
- * @deprecated This compatibility stub does nothing. Remove it from Vite config when possible.
- *
- * TODO(custom-blocks): Remove this when bumping bridge SDK version to 0.2.0.
- */
-export function notionCustomBlock(): NotionCustomBlockPlugin

package/vite-plugin/index.js

@@ -1,11 +0,0 @@
-/**
- * Vite plugin for Notion custom blocks.
- *
- * @deprecated This is just a compatibility stub to ensure existing block code can continue to work
- * with the new SDK.
- *
- * TODO(custom-blocks): Remove this when bumping bridge SDK version to 0.2.0.
- */
-export function notionCustomBlock() {
-	return { name: "custom-blocks:legacy-vite-plugin" }
-}