@notionhq/custom-blocks-host 0.2.19 → 0.2.21

package/dist/protocol/messages/updatePageResult.d.ts

@@ -160,6 +160,34 @@ export declare const updatePageResultMessageSchema: v.VariantSchema<"status", [v
                 readonly aws_place_id: v.OptionalSchema<v.NullableSchema<v.StringSchema<undefined>, undefined>, undefined>;
                 readonly google_place_id: v.OptionalSchema<v.NullableSchema<v.StringSchema<undefined>, undefined>, undefined>;
             }, undefined>, undefined>;
+        }, undefined>, v.ObjectSchema<{
+            readonly id: v.StringSchema<undefined>;
+            readonly type: v.LiteralSchema<"created_time", undefined>;
+            readonly created_time: v.NullableSchema<v.StringSchema<undefined>, undefined>;
+        }, undefined>, v.ObjectSchema<{
+            readonly id: v.StringSchema<undefined>;
+            readonly type: v.LiteralSchema<"last_edited_time", undefined>;
+            readonly last_edited_time: v.NullableSchema<v.StringSchema<undefined>, undefined>;
+        }, undefined>, v.ObjectSchema<{
+            readonly id: v.StringSchema<undefined>;
+            readonly type: v.LiteralSchema<"created_by", undefined>;
+            readonly created_by: v.NullableSchema<v.ObjectSchema<{
+                readonly id: v.StringSchema<undefined>;
+                readonly table: v.PicklistSchema<["notion_user", "bot", "organization_bot"], undefined>;
+                readonly spaceId: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+            }, undefined>, undefined>;
+        }, undefined>, v.ObjectSchema<{
+            readonly id: v.StringSchema<undefined>;
+            readonly type: v.LiteralSchema<"last_edited_by", undefined>;
+            readonly last_edited_by: v.NullableSchema<v.ObjectSchema<{
+                readonly id: v.StringSchema<undefined>;
+                readonly table: v.PicklistSchema<["notion_user", "bot", "organization_bot"], undefined>;
+                readonly spaceId: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+            }, undefined>, undefined>;
+        }, undefined>, v.ObjectSchema<{
+            readonly id: v.StringSchema<undefined>;
+            readonly type: v.LiteralSchema<"last_visited_time", undefined>;
+            readonly last_visited_time: v.NullableSchema<v.StringSchema<undefined>, undefined>;
         }, undefined>], undefined>, undefined>;
         readonly created_time: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
         readonly last_edited_time: v.OptionalSchema<v.StringSchema<undefined>, undefined>;

package/dist/protocol/pages/page.d.ts

@@ -283,9 +283,37 @@ export declare const notionPagePropertyValueSchema: v.VariantSchema<"type", [v.O
         readonly aws_place_id: v.OptionalSchema<v.NullableSchema<v.StringSchema<undefined>, undefined>, undefined>;
         readonly google_place_id: v.OptionalSchema<v.NullableSchema<v.StringSchema<undefined>, undefined>, undefined>;
     }, undefined>, undefined>;
+}, undefined>, v.ObjectSchema<{
+    readonly id: v.StringSchema<undefined>;
+    readonly type: v.LiteralSchema<"created_time", undefined>;
+    readonly created_time: v.NullableSchema<v.StringSchema<undefined>, undefined>;
+}, undefined>, v.ObjectSchema<{
+    readonly id: v.StringSchema<undefined>;
+    readonly type: v.LiteralSchema<"last_edited_time", undefined>;
+    readonly last_edited_time: v.NullableSchema<v.StringSchema<undefined>, undefined>;
+}, undefined>, v.ObjectSchema<{
+    readonly id: v.StringSchema<undefined>;
+    readonly type: v.LiteralSchema<"created_by", undefined>;
+    readonly created_by: v.NullableSchema<v.ObjectSchema<{
+        readonly id: v.StringSchema<undefined>;
+        readonly table: v.PicklistSchema<["notion_user", "bot", "organization_bot"], undefined>;
+        readonly spaceId: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+    }, undefined>, undefined>;
+}, undefined>, v.ObjectSchema<{
+    readonly id: v.StringSchema<undefined>;
+    readonly type: v.LiteralSchema<"last_edited_by", undefined>;
+    readonly last_edited_by: v.NullableSchema<v.ObjectSchema<{
+        readonly id: v.StringSchema<undefined>;
+        readonly table: v.PicklistSchema<["notion_user", "bot", "organization_bot"], undefined>;
+        readonly spaceId: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+    }, undefined>, undefined>;
+}, undefined>, v.ObjectSchema<{
+    readonly id: v.StringSchema<undefined>;
+    readonly type: v.LiteralSchema<"last_visited_time", undefined>;
+    readonly last_visited_time: v.NullableSchema<v.StringSchema<undefined>, undefined>;
 }, undefined>], undefined>;
 export type NotionPagePropertyValue = v.InferOutput<typeof notionPagePropertyValueSchema>;
-export declare const notionPagePropertyWriteMapSchema: v.RecordSchema<v.StringSchema<undefined>, v.VariantSchema<"type", [v.ObjectSchema<{
+export declare const notionPagePropertyReadMapSchema: v.RecordSchema<v.StringSchema<undefined>, v.VariantSchema<"type", [v.ObjectSchema<{
     readonly id: v.StringSchema<undefined>;
     readonly type: v.LiteralSchema<"title", undefined>;
     readonly title: v.ArraySchema<v.RecordSchema<v.StringSchema<undefined>, v.UnknownSchema, undefined>, undefined>;
@@ -409,8 +437,39 @@ export declare const notionPagePropertyWriteMapSchema: v.RecordSchema<v.StringSc
         readonly aws_place_id: v.OptionalSchema<v.NullableSchema<v.StringSchema<undefined>, undefined>, undefined>;
         readonly google_place_id: v.OptionalSchema<v.NullableSchema<v.StringSchema<undefined>, undefined>, undefined>;
     }, undefined>, undefined>;
+}, undefined>, v.ObjectSchema<{
+    readonly id: v.StringSchema<undefined>;
+    readonly type: v.LiteralSchema<"created_time", undefined>;
+    readonly created_time: v.NullableSchema<v.StringSchema<undefined>, undefined>;
+}, undefined>, v.ObjectSchema<{
+    readonly id: v.StringSchema<undefined>;
+    readonly type: v.LiteralSchema<"last_edited_time", undefined>;
+    readonly last_edited_time: v.NullableSchema<v.StringSchema<undefined>, undefined>;
+}, undefined>, v.ObjectSchema<{
+    readonly id: v.StringSchema<undefined>;
+    readonly type: v.LiteralSchema<"created_by", undefined>;
+    readonly created_by: v.NullableSchema<v.ObjectSchema<{
+        readonly id: v.StringSchema<undefined>;
+        readonly table: v.PicklistSchema<["notion_user", "bot", "organization_bot"], undefined>;
+        readonly spaceId: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+    }, undefined>, undefined>;
+}, undefined>, v.ObjectSchema<{
+    readonly id: v.StringSchema<undefined>;
+    readonly type: v.LiteralSchema<"last_edited_by", undefined>;
+    readonly last_edited_by: v.NullableSchema<v.ObjectSchema<{
+        readonly id: v.StringSchema<undefined>;
+        readonly table: v.PicklistSchema<["notion_user", "bot", "organization_bot"], undefined>;
+        readonly spaceId: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+    }, undefined>, undefined>;
+}, undefined>, v.ObjectSchema<{
+    readonly id: v.StringSchema<undefined>;
+    readonly type: v.LiteralSchema<"last_visited_time", undefined>;
+    readonly last_visited_time: v.NullableSchema<v.StringSchema<undefined>, undefined>;
 }, undefined>], undefined>, undefined>;
-export type NotionPagePropertyWriteMap = v.InferOutput<typeof notionPagePropertyWriteMapSchema>;
+export type NotionPagePropertyReadMap = v.InferOutput<typeof notionPagePropertyReadMapSchema>;
+export type NotionPagePropertyWriteMap = Record<string, Exclude<NotionPagePropertyValue, {
+    type: "created_time" | "last_edited_time" | "created_by" | "last_edited_by" | "last_visited_time";
+}>>;
 /**
  * The `Page` object returned in `createPageResult` messages.
  */
@@ -559,6 +618,34 @@ export declare const notionPageSchema: v.ObjectSchema<{
             readonly aws_place_id: v.OptionalSchema<v.NullableSchema<v.StringSchema<undefined>, undefined>, undefined>;
             readonly google_place_id: v.OptionalSchema<v.NullableSchema<v.StringSchema<undefined>, undefined>, undefined>;
         }, undefined>, undefined>;
+    }, undefined>, v.ObjectSchema<{
+        readonly id: v.StringSchema<undefined>;
+        readonly type: v.LiteralSchema<"created_time", undefined>;
+        readonly created_time: v.NullableSchema<v.StringSchema<undefined>, undefined>;
+    }, undefined>, v.ObjectSchema<{
+        readonly id: v.StringSchema<undefined>;
+        readonly type: v.LiteralSchema<"last_edited_time", undefined>;
+        readonly last_edited_time: v.NullableSchema<v.StringSchema<undefined>, undefined>;
+    }, undefined>, v.ObjectSchema<{
+        readonly id: v.StringSchema<undefined>;
+        readonly type: v.LiteralSchema<"created_by", undefined>;
+        readonly created_by: v.NullableSchema<v.ObjectSchema<{
+            readonly id: v.StringSchema<undefined>;
+            readonly table: v.PicklistSchema<["notion_user", "bot", "organization_bot"], undefined>;
+            readonly spaceId: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+        }, undefined>, undefined>;
+    }, undefined>, v.ObjectSchema<{
+        readonly id: v.StringSchema<undefined>;
+        readonly type: v.LiteralSchema<"last_edited_by", undefined>;
+        readonly last_edited_by: v.NullableSchema<v.ObjectSchema<{
+            readonly id: v.StringSchema<undefined>;
+            readonly table: v.PicklistSchema<["notion_user", "bot", "organization_bot"], undefined>;
+            readonly spaceId: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+        }, undefined>, undefined>;
+    }, undefined>, v.ObjectSchema<{
+        readonly id: v.StringSchema<undefined>;
+        readonly type: v.LiteralSchema<"last_visited_time", undefined>;
+        readonly last_visited_time: v.NullableSchema<v.StringSchema<undefined>, undefined>;
     }, undefined>], undefined>, undefined>;
     readonly created_time: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
     readonly last_edited_time: v.OptionalSchema<v.StringSchema<undefined>, undefined>;

package/dist/protocol/pages/page.js

@@ -5,6 +5,7 @@
  * shape the host delivers for messages like `createPageResult`.
  */
 import * as v from "valibot";
+import { notionRecordPointerSchema } from "../dataSources/recordPointer.js";
 import { notionPageIdSchema } from "../ids.js";
 import { notionParentSchema } from "../parent.js";
 /**
@@ -117,6 +118,11 @@ const notionPlaceInputSchema = v.object({
 const pagePropertyBaseSchema = {
     id: v.string(),
 };
+const metadataActorSchema = v.nullable(v.object({
+    ...notionRecordPointerSchema.entries,
+    table: v.picklist(["notion_user", "bot", "organization_bot"]),
+    spaceId: v.optional(v.string()),
+}));
 /**
  * A page property value.
  */
@@ -197,8 +203,33 @@ export const notionPagePropertyValueSchema = v.variant("type", [
         type: v.literal("place"),
         place: v.nullable(notionPlaceInputSchema),
     }),
+    v.object({
+        ...pagePropertyBaseSchema,
+        type: v.literal("created_time"),
+        created_time: nullableStringSchema,
+    }),
+    v.object({
+        ...pagePropertyBaseSchema,
+        type: v.literal("last_edited_time"),
+        last_edited_time: nullableStringSchema,
+    }),
+    v.object({
+        ...pagePropertyBaseSchema,
+        type: v.literal("created_by"),
+        created_by: metadataActorSchema,
+    }),
+    v.object({
+        ...pagePropertyBaseSchema,
+        type: v.literal("last_edited_by"),
+        last_edited_by: metadataActorSchema,
+    }),
+    v.object({
+        ...pagePropertyBaseSchema,
+        type: v.literal("last_visited_time"),
+        last_visited_time: nullableStringSchema,
+    }),
 ]);
-export const notionPagePropertyWriteMapSchema = v.record(v.string(), notionPagePropertyValueSchema);
+export const notionPagePropertyReadMapSchema = v.record(v.string(), notionPagePropertyValueSchema);
 /**
  * The `Page` object returned in `createPageResult` messages.
  */
@@ -206,7 +237,7 @@ export const notionPageSchema = v.object({
     object: v.literal("page"),
     id: notionPageIdSchema,
     parent: notionParentSchema,
-    properties: notionPagePropertyWriteMapSchema,
+    properties: notionPagePropertyReadMapSchema,
     created_time: v.optional(v.string()),
     last_edited_time: v.optional(v.string()),
     icon: v.optional(notionPageIconSchema),

package/dist/protocol/protocolVersion.d.ts

@@ -3,4 +3,5 @@
  * Increase this value for breaking wire changes. Hosts can continue to accept
  * older versions, so this value does not set the minimum or maximum they accept.
  */
-export declare const LATEST_BRIDGE_PROTOCOL_VERSION = 5;
+export declare const LATEST_BRIDGE_PROTOCOL_VERSION = 6;
+export declare const LEGACY_PROPERTY_SHAPE_PROTOCOL_VERSION = 6;

package/dist/protocol/protocolVersion.js

@@ -3,4 +3,7 @@
  * Increase this value for breaking wire changes. Hosts can continue to accept
  * older versions, so this value does not set the minimum or maximum they accept.
  */
-export const LATEST_BRIDGE_PROTOCOL_VERSION = 5;
+export const LATEST_BRIDGE_PROTOCOL_VERSION = 6;
+// Protocol 6 introduces name-keyed property objects for data source queries.
+// 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.2.19",
+  "version": "0.2.21",
   "description": "Reusable host runtime for Notion custom blocks.",
   "license": "MIT",
   "type": "module",

package/src/ids.ts

@@ -0,0 +1,9 @@
+import {
+	type NotionPageId,
+	notionPageIdSchema,
+} from "@notionhq/custom-blocks-protocol/ids.js"
+import * as v from "valibot"
+
+export function toNotionPageId(id: string): NotionPageId {
+	return v.parse(notionPageIdSchema, id)
+}

package/src/index.ts

@@ -1,4 +1,10 @@
+export type {
+	LegacyNotionDataSourcePageBridge,
+	NotionDataSourcePageBridge,
+} 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"
 export type { CreatePageMessage } from "@notionhq/custom-blocks-protocol/messages/createPage.js"
 export type { GetPageMessage } from "@notionhq/custom-blocks-protocol/messages/getPage.js"
 export type { GetUserMessage } from "@notionhq/custom-blocks-protocol/messages/getUser.js"
@@ -30,11 +36,13 @@ export type {
 	NotionFileInput,
 	NotionPageCover,
 	NotionPageIcon,
+	NotionPagePropertyReadMap,
 	NotionPagePropertyValue,
 	NotionPagePropertyWriteMap,
 	NotionRichTextItem,
 	NotionSelectOptionInput,
 } from "@notionhq/custom-blocks-protocol/pages/page.js"
+export { LEGACY_PROPERTY_SHAPE_PROTOCOL_VERSION } from "@notionhq/custom-blocks-protocol/protocolVersion.js"
 export {
 	type AutoBindableProperty,
 	getAutoBoundPropertyIdsByKey,
@@ -44,6 +52,7 @@ export {
 	type CustomBlockHostOptions,
 	createCustomBlockHost,
 } from "./createCustomBlockHost.js"
+export { toNotionPageId } from "./ids.js"
 export type {
 	ConnectSuccessMessage,
 	CustomBlockHostDataSourcesPayload,