@notionhq/custom-blocks-host 0.3.5 → 0.3.7

package/dist/protocol/pages/page.js

@@ -5,6 +5,7 @@
  * shape the host delivers for messages like `createPageResult`.
  */
 import * as v from "valibot";
+import { notionDateReminderSchema, notionDateTimeReminderSchema, notionDisabledReminderSchema, } from "../dataSources/dateValue.js";
 import { notionRecordPointerSchema } from "../dataSources/recordPointer.js";
 import { notionPageIdSchema } from "../ids.js";
 import { notionParentSchema } from "../parent.js";
@@ -75,11 +76,26 @@ const notionSelectOptionInputSchema = v.union([
         description: v.optional(nullableStringSchema),
     }),
 ]);
-const notionDateInputSchema = v.object({
+const dateInputEntries = {
     start: v.string(),
     end: v.optional(nullableStringSchema),
     time_zone: v.optional(nullableStringSchema),
-});
+    reminder: v.optional(v.union([notionDateTimeReminderSchema, notionDisabledReminderSchema])),
+};
+const notionDateInputSchema = v.union([
+    v.object({
+        ...dateInputEntries,
+        start: v.pipe(v.string(), v.includes("T")),
+    }),
+    v.object({
+        ...dateInputEntries,
+        time_zone: v.string(),
+    }),
+    v.object({
+        ...dateInputEntries,
+        reminder: v.optional(v.union([notionDateReminderSchema, notionDisabledReminderSchema])),
+    }),
+]);
 const notionUserInputSchema = v.union([
     v.object({
         object: v.optional(v.literal("user")),
@@ -118,6 +134,7 @@ const notionPlaceInputSchema = v.object({
 const pagePropertyBaseSchema = {
     id: v.string(),
 };
+// TODO(custom-blocks): Make spaceId required for metadataActor
 const metadataActorSchema = v.nullable(v.object({
     ...notionRecordPointerSchema.entries,
     table: v.picklist(["notion_user", "bot", "organization_bot"]),
@@ -229,15 +246,35 @@ export const notionPagePropertyValueSchema = v.variant("type", [
         last_visited_time: nullableStringSchema,
     }),
 ]);
-export const notionPagePropertyReadMapSchema = v.record(v.string(), notionPagePropertyValueSchema);
+export const notionPagePropertyWriteMapSchema = v.record(v.string(), notionPagePropertyValueSchema);
+export const notionPagePropertyReadMapSchema = v.record(v.string(), v.nullable(notionPagePropertyValueSchema));
 /**
  * The `Page` object returned in `createPageResult` messages.
  */
-export const notionPageSchema = v.object({
+export const notionPageDataSchema = v.object({
     object: v.literal("page"),
     id: notionPageIdSchema,
     parent: notionParentSchema,
     properties: notionPagePropertyReadMapSchema,
+    created_by: v.optional(metadataActorSchema, null),
+    last_edited_by: v.optional(metadataActorSchema, null),
+    last_visited_time: v.optional(v.nullable(v.string()), null),
+    created_time: v.optional(v.nullable(v.string()), null),
+    last_edited_time: v.optional(v.nullable(v.string()), null),
+    icon: v.optional(v.nullable(notionPageIconSchema), null),
+    cover: v.optional(v.nullable(notionPageCoverSchema), null),
+    url: v.optional(v.nullable(v.string()), null),
+    public_url: v.optional(v.nullable(v.string()), null),
+    /** Whether the page or an ancestor is archived. */
+    is_archived: v.boolean(),
+    /** Whether the page or an ancestor is in Trash. */
+    in_trash: v.boolean(),
+});
+export const legacyNotionPageSchema = v.object({
+    object: v.literal("page"),
+    id: notionPageIdSchema,
+    parent: notionParentSchema,
+    properties: notionPagePropertyWriteMapSchema,
     created_time: v.optional(v.string()),
     last_edited_time: v.optional(v.string()),
     icon: v.optional(notionPageIconSchema),

package/dist/protocol/protocolVersion.js

@@ -4,6 +4,6 @@
  * older versions, so this value does not set the minimum or maximum they accept.
  */
 export const LATEST_BRIDGE_PROTOCOL_VERSION = 6;
-// Protocol 6 introduces name-keyed property objects for data source queries.
+// Protocol 6 introduces unified pages with name-keyed property objects.
 // Keep this cutoff fixed when the latest protocol version increases.
 export const LEGACY_PROPERTY_SHAPE_PROTOCOL_VERSION = 6;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@notionhq/custom-blocks-host",
-  "version": "0.3.5",
+  "version": "0.3.7",
   "description": "Reusable host runtime for Notion custom blocks.",
   "license": "MIT",
   "type": "module",

package/src/dateValue.ts

@@ -0,0 +1,120 @@
+import type {
+	NotionDate,
+	NotionDateRange,
+	NotionDateTime,
+	NotionDateTimeRange,
+} from "@notionhq/custom-blocks-protocol/dataSources/dateValue.js"
+import type { NotionDateInput } from "@notionhq/custom-blocks-protocol/pages/page.js"
+
+export type CustomBlockDateValue =
+	| NotionDate
+	| NotionDateRange
+	| (NotionDateTime & { time_zone: string })
+	| (NotionDateTimeRange & { time_zone: string })
+
+export class InvalidNotionDateError extends Error {}
+
+export function toNotionDateValue(
+	value: NotionDateInput,
+): CustomBlockDateValue {
+	try {
+		return convertDateValue(value)
+	} catch (error) {
+		if (error instanceof RangeError) {
+			throw new InvalidNotionDateError(error.message)
+		}
+		throw error
+	}
+}
+
+function convertDateValue(value: NotionDateInput): CustomBlockDateValue {
+	const { start, end, time_zone, reminder } = value
+	if (!start.split("T")[0]) {
+		throw new InvalidNotionDateError("Date values must include a date.")
+	}
+	const timed = start.includes("T") || time_zone != null
+	const offset = start.match(/([+-])(\d{2}):(\d{2})$/)
+	const offsetMinutes = offset
+		? (Number(offset[2]) * 60 + Number(offset[3])) *
+			(offset[1] === "-" ? -1 : 1)
+		: 0
+	const fixedZone = time_zone?.match(/^UTC(?:([+-])(\d{1,2})(?::(\d{2}))?)?$/)
+	const targetOffsetMinutes = fixedZone
+		? (Number(fixedZone[2] ?? 0) * 60 + Number(fixedZone[3] ?? 0)) *
+			(fixedZone[1] === "-" ? -1 : 1)
+		: offsetMinutes
+	const parts = (input: string) => {
+		if (!input.split("T")[0]) {
+			throw new InvalidNotionDateError("Date values must include a date.")
+		}
+		if (!input.includes("T")) {
+			return { date: input, time: "00:00" }
+		}
+		const wallClock = input.match(
+			/^(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2})(?::\d{2}(?:\.\d+)?)?$/,
+		)
+		if (wallClock) {
+			return { date: wallClock[1], time: wallClock[2] }
+		}
+		if (!time_zone || fixedZone) {
+			const local = new Date(
+				new Date(input).getTime() + targetOffsetMinutes * 60_000,
+			).toISOString()
+			return { date: local.slice(0, 10), time: local.slice(11, 16) }
+		}
+		const entries = new Intl.DateTimeFormat("en-CA", {
+			timeZone: time_zone,
+			year: "numeric",
+			month: "2-digit",
+			day: "2-digit",
+			hour: "2-digit",
+			minute: "2-digit",
+			hourCycle: "h23",
+		}).formatToParts(new Date(input))
+		const get = (type: string) =>
+			entries.find(part => part.type === type)?.value
+		return {
+			date: `${get("year")}-${get("month")}-${get("day")}`,
+			time: `${get("hour")}:${get("minute")}`,
+		}
+	}
+	const startParts = parts(start)
+	const endParts = end ? parts(end) : undefined
+	if (!timed) {
+		if (reminder && !("time" in reminder) && reminder.unit !== "none") {
+			throw new InvalidNotionDateError(
+				"Hour and minute reminders require a date with a time.",
+			)
+		}
+		return endParts
+			? {
+					type: "daterange",
+					start_date: startParts.date,
+					end_date: endParts.date,
+					reminder,
+				}
+			: { type: "date", start_date: startParts.date, reminder }
+	}
+	const zone =
+		time_zone ??
+		(offsetMinutes === 0
+			? "UTC"
+			: `UTC${offsetMinutes < 0 ? "-" : "+"}${Math.floor(Math.abs(offsetMinutes) / 60)}${Math.abs(offsetMinutes) % 60 === 0 ? "" : `:${String(Math.abs(offsetMinutes) % 60).padStart(2, "0")}`}`)
+	return endParts
+		? {
+				type: "datetimerange",
+				start_date: startParts.date,
+				start_time: startParts.time,
+				end_date: endParts.date,
+				end_time: endParts.time,
+				time_zone: zone,
+				reminder,
+			}
+		: {
+				type: "datetime",
+				start_date: startParts.date,
+				start_time: startParts.time,
+				time_zone: zone,
+				reminder,
+			}
+}

package/src/index.ts

@@ -1,7 +1,4 @@
-export type {
-	LegacyNotionDataSourcePageBridge,
-	NotionDataSourcePageBridge,
-} from "@notionhq/custom-blocks-protocol/dataSources/dataSourcePage.js"
+export type { LegacyNotionDataSourcePageBridge } from "@notionhq/custom-blocks-protocol/dataSources/dataSourcePage.js"
 export type { NotionPropertySchemasById } from "@notionhq/custom-blocks-protocol/dataSources/propertySchema.js"
 export type { CustomBlockErrorInfo } from "@notionhq/custom-blocks-protocol/errors.js"
 export type { NotionPageId } from "@notionhq/custom-blocks-protocol/ids.js"
@@ -37,6 +34,7 @@ export type {
 	NotionDateInput,
 	NotionFileInput,
 	NotionPageCover,
+	NotionPageData,
 	NotionPageIcon,
 	NotionPagePropertyReadMap,
 	NotionPagePropertyValue,
@@ -57,6 +55,11 @@ export {
 	type CustomBlockHostOptions,
 	createCustomBlockHost,
 } from "./createCustomBlockHost.js"
+export {
+	type CustomBlockDateValue,
+	InvalidNotionDateError,
+	toNotionDateValue,
+} from "./dateValue.js"
 export { toNotionPageId } from "./ids.js"
 export type { CustomBlockHostManifestOptions } from "./lifecycle/manifestOptions.js"
 export type {

package/src/lifecycle/legacyPage.ts

@@ -1,9 +1,35 @@
-import type { NotionDataSourcePageBridge } from "@notionhq/custom-blocks-protocol/dataSources/dataSourcePage.js"
 import type { NotionDataSourceValue } from "@notionhq/custom-blocks-protocol/dataSources/dataSourceValue.js"
-import type { NotionPagePropertyValue } from "@notionhq/custom-blocks-protocol/pages/page.js"
+import type {
+	LegacyNotionPage,
+	NotionPagePropertyValue,
+	notionPageDataSchema,
+} from "@notionhq/custom-blocks-protocol/pages/page.js"
+import type { InferOutput } from "valibot"
+import { toNotionDateValue } from "../dateValue.js"
 import { unreachable } from "../utils.js"
 
-export function toLegacyQueryPage(page: NotionDataSourcePageBridge) {
+export function toLegacyPage(
+	page: InferOutput<typeof notionPageDataSchema>,
+): LegacyNotionPage {
+	return {
+		...page,
+		properties: Object.fromEntries(
+			Object.values(page.properties).flatMap(property =>
+				property ? [[property.id, property]] : [],
+			),
+		),
+		icon: page.icon ?? undefined,
+		cover: page.cover ?? undefined,
+		created_time: page.created_time ?? undefined,
+		last_edited_time: page.last_edited_time ?? undefined,
+		url: page.url ?? undefined,
+		public_url: page.public_url ?? undefined,
+	}
+}
+
+export function toLegacyQueryPage(
+	page: InferOutput<typeof notionPageDataSchema>,
+) {
 	const propertiesById: Record<string, NotionDataSourceValue | undefined> = {}
 	for (const property of Object.values(page.properties)) {
 		if (property) {
@@ -53,78 +79,6 @@ function timestamp(
 	}
 }
 
-function legacyDate(value: {
-	start: string
-	end?: string | null
-	time_zone?: string | null
-}): NotionDataSourceValue {
-	const timed = value.start.includes("T") || value.time_zone != null
-	const offset = value.start.match(/([+-])(\d{2}):(\d{2})$/)
-	const offsetMinutes = offset
-		? (Number(offset[2]) * 60 + Number(offset[3])) *
-			(offset[1] === "-" ? -1 : 1)
-		: 0
-	const parts = (input: string) => {
-		if (!input.includes("T")) {
-			return { date: input, time: "00:00" }
-		}
-		const wallClock = input.match(
-			/^(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2})(?::\d{2}(?:\.\d+)?)?$/,
-		)
-		if (wallClock) {
-			return { date: wallClock[1], time: wallClock[2] }
-		}
-		if (!value.time_zone) {
-			const local = new Date(
-				new Date(input).getTime() + offsetMinutes * 60_000,
-			).toISOString()
-			return { date: local.slice(0, 10), time: local.slice(11, 16) }
-		}
-		const entries = new Intl.DateTimeFormat("en-CA", {
-			timeZone: value.time_zone,
-			year: "numeric",
-			month: "2-digit",
-			day: "2-digit",
-			hour: "2-digit",
-			minute: "2-digit",
-			hourCycle: "h23",
-		}).formatToParts(new Date(input))
-		const get = (type: string) =>
-			entries.find(part => part.type === type)?.value
-		return {
-			date: `${get("year")}-${get("month")}-${get("day")}`,
-			time: `${get("hour")}:${get("minute")}`,
-		}
-	}
-	const start = parts(value.start)
-	const end = value.end ? parts(value.end) : undefined
-	if (!timed) {
-		return end
-			? { type: "daterange", start_date: start.date, end_date: end.date }
-			: { type: "date", start_date: start.date }
-	}
-	const zone =
-		value.time_zone ??
-		(offsetMinutes === 0
-			? "UTC"
-			: `UTC${offsetMinutes < 0 ? "-" : "+"}${Math.floor(Math.abs(offsetMinutes) / 60)}${Math.abs(offsetMinutes) % 60 === 0 ? "" : `:${String(Math.abs(offsetMinutes) % 60).padStart(2, "0")}`}`)
-	return end
-		? {
-				type: "datetimerange",
-				start_date: start.date,
-				start_time: start.time,
-				end_date: end.date,
-				end_time: end.time,
-				time_zone: zone,
-			}
-		: {
-				type: "datetime",
-				start_date: start.date,
-				start_time: start.time,
-				time_zone: zone,
-			}
-}
-
 function toLegacyProperty(
 	property: NotionPagePropertyValue,
 ): NotionDataSourceValue | undefined {
@@ -150,7 +104,7 @@ function toLegacyProperty(
 		case "multi_select":
 			return property.multi_select.flatMap(option => option.name ?? [])
 		case "date":
-			return property.date ? legacyDate(property.date) : undefined
+			return property.date ? toNotionDateValue(property.date) : undefined
 		case "people":
 			return property.people.map(person =>
 				person.object === "group"

package/src/lifecycle/normalizeHostToSandboxMessage.ts

@@ -2,7 +2,7 @@ import type {
 	HostToSandboxMessage,
 	HostToSandboxMessageLegacy,
 } from "@notionhq/custom-blocks-protocol/messages/hostToSandbox.js"
-import { normalizeQueryPage } from "./normalizeQueryPage.js"
+import { normalizeToLegacyPage } from "./normalizePage.js"
 
 /**
  * Normalizes an outgoing message for the bridge protocol version requested by the sandbox.
@@ -13,6 +13,17 @@ export function normalizeHostToSandboxMessage(
 	message: HostToSandboxMessage,
 	bridgeProtocolVersion: number,
 ): HostToSandboxMessageLegacy {
-	const normalizedMessage = normalizeQueryPage(message, bridgeProtocolVersion)
+	if (
+		message.type !== "queryDataSourceResult" &&
+		message.type !== "getPageResult" &&
+		message.type !== "createPageResult" &&
+		message.type !== "updatePageResult"
+	) {
+		return message
+	}
+	const normalizedMessage = normalizeToLegacyPage(
+		message,
+		bridgeProtocolVersion,
+	)
 	return normalizedMessage
 }

package/src/lifecycle/normalizePage.ts

@@ -0,0 +1,35 @@
+import type { CreatePageResultMessage } from "@notionhq/custom-blocks-protocol/messages/createPageResult.js"
+import type { GetPageResultMessage } from "@notionhq/custom-blocks-protocol/messages/getPage.js"
+import type { HostToSandboxMessageLegacy } from "@notionhq/custom-blocks-protocol/messages/hostToSandbox.js"
+import type { QueryDataSourceResultMessage } from "@notionhq/custom-blocks-protocol/messages/queryDataSourceResult.js"
+import type { UpdatePageResultMessage } from "@notionhq/custom-blocks-protocol/messages/updatePageResult.js"
+import { LEGACY_PROPERTY_SHAPE_PROTOCOL_VERSION } from "@notionhq/custom-blocks-protocol/protocolVersion.js"
+import { unreachable } from "../utils.js"
+import { toLegacyPage, toLegacyQueryPage } from "./legacyPage.js"
+
+export function normalizeToLegacyPage(
+	message:
+		| CreatePageResultMessage
+		| GetPageResultMessage
+		| UpdatePageResultMessage
+		| QueryDataSourceResultMessage,
+	bridgeProtocolVersion: number,
+): HostToSandboxMessageLegacy {
+	// Forward up to date messages
+	if (bridgeProtocolVersion >= LEGACY_PROPERTY_SHAPE_PROTOCOL_VERSION) {
+		return message
+	}
+	if (message.status === "error") {
+		return message
+	}
+	switch (message.type) {
+		case "queryDataSourceResult":
+			return { ...message, items: message.items.map(toLegacyQueryPage) }
+		case "getPageResult":
+		case "createPageResult":
+		case "updatePageResult":
+			return { ...message, page: toLegacyPage(message.page) }
+		default:
+			return unreachable(message)
+	}
+}

package/src/messages/types.ts

@@ -57,7 +57,7 @@ import type {
 import type { InferInput } from "valibot"
 import type { CustomBlockHostQueryDataSourceResult } from "../queries/types.js"
 
-type MaybePromise<T> = T | Promise<T>
+export type MaybePromise<T> = T | Promise<T>
 
 /**
  * Host results use InferInput so adapters can return plain string IDs.

package/dist/lifecycle/normalizeQueryPage.d.ts

@@ -1,3 +0,0 @@
-import type { HostToSandboxMessage, HostToSandboxMessageLegacy } from "../protocol/messages/hostToSandbox.js";
-export declare function normalizeQueryPage(message: HostToSandboxMessageLegacy | HostToSandboxMessage, bridgeProtocolVersion: number): HostToSandboxMessageLegacy;
-//# sourceMappingURL=normalizeQueryPage.d.ts.map

package/dist/lifecycle/normalizeQueryPage.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"normalizeQueryPage.d.ts","sourceRoot":"","sources":["../../src/lifecycle/normalizeQueryPage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACX,oBAAoB,EACpB,0BAA0B,EAC1B,MAAM,4DAA4D,CAAA;AAInE,wBAAgB,kBAAkB,CACjC,OAAO,EAAE,0BAA0B,GAAG,oBAAoB,EAC1D,qBAAqB,EAAE,MAAM,GAC3B,0BAA0B,CAc5B"}

package/dist/lifecycle/normalizeQueryPage.js

@@ -1,13 +0,0 @@
-import { LEGACY_PROPERTY_SHAPE_PROTOCOL_VERSION } from "../protocol/protocolVersion.js";
-import { toLegacyQueryPage } from "./legacyPage.js";
-export function normalizeQueryPage(message, bridgeProtocolVersion) {
-    if (bridgeProtocolVersion < LEGACY_PROPERTY_SHAPE_PROTOCOL_VERSION &&
-        message.type === "queryDataSourceResult" &&
-        message.status === "success") {
-        return {
-            ...message,
-            items: message.items.map(page => "properties" in page ? toLegacyQueryPage(page) : page),
-        };
-    }
-    return message;
-}

package/src/lifecycle/normalizeQueryPage.ts

@@ -1,25 +0,0 @@
-import type {
-	HostToSandboxMessage,
-	HostToSandboxMessageLegacy,
-} from "@notionhq/custom-blocks-protocol/messages/hostToSandbox.js"
-import { LEGACY_PROPERTY_SHAPE_PROTOCOL_VERSION } from "@notionhq/custom-blocks-protocol/protocolVersion.js"
-import { toLegacyQueryPage } from "./legacyPage.js"
-
-export function normalizeQueryPage(
-	message: HostToSandboxMessageLegacy | HostToSandboxMessage,
-	bridgeProtocolVersion: number,
-): HostToSandboxMessageLegacy {
-	if (
-		bridgeProtocolVersion < LEGACY_PROPERTY_SHAPE_PROTOCOL_VERSION &&
-		message.type === "queryDataSourceResult" &&
-		message.status === "success"
-	) {
-		return {
-			...message,
-			items: message.items.map(page =>
-				"properties" in page ? toLegacyQueryPage(page) : page,
-			),
-		}
-	}
-	return message
-}