@notionhq/custom-blocks-host 0.0.1

package/dist/protocol/messages/queryDataSource.js

@@ -0,0 +1,123 @@
+import * as v from "valibot";
+import { notionDataSourceIdSchema } from "../ids.js";
+const emptyOperatorSchema = v.union([
+    v.object({ is_empty: v.literal(true) }),
+    v.object({ is_not_empty: v.literal(true) }),
+]);
+const stringOrStringArraySchema = v.union([v.string(), v.array(v.string())]);
+export const customBlockTextFilterOperatorSchema = v.union([
+    v.object({ equals: v.string() }),
+    v.object({ does_not_equal: v.string() }),
+    v.object({ contains: v.string() }),
+    v.object({ does_not_contain: v.string() }),
+    v.object({ starts_with: v.string() }),
+    v.object({ ends_with: v.string() }),
+    emptyOperatorSchema,
+]);
+export const customBlockNumberFilterOperatorSchema = v.union([
+    v.object({ equals: v.number() }),
+    v.object({ does_not_equal: v.number() }),
+    v.object({ greater_than: v.number() }),
+    v.object({ less_than: v.number() }),
+    v.object({ greater_than_or_equal_to: v.number() }),
+    v.object({ less_than_or_equal_to: v.number() }),
+    emptyOperatorSchema,
+]);
+export const customBlockCheckboxFilterOperatorSchema = v.union([
+    v.object({ equals: v.boolean() }),
+    v.object({ does_not_equal: v.boolean() }),
+]);
+export const customBlockOptionFilterOperatorSchema = v.union([
+    v.object({ equals: stringOrStringArraySchema }),
+    v.object({ does_not_equal: stringOrStringArraySchema }),
+    emptyOperatorSchema,
+]);
+export const customBlockContainsFilterOperatorSchema = v.union([
+    v.object({ contains: stringOrStringArraySchema }),
+    v.object({ contains_all: stringOrStringArraySchema }),
+    v.object({ does_not_contain: stringOrStringArraySchema }),
+    emptyOperatorSchema,
+]);
+export const customBlockDateFilterOperatorSchema = v.union([
+    v.object({ equals: v.string() }),
+    v.object({ before: v.string() }),
+    v.object({ after: v.string() }),
+    v.object({ on_or_before: v.string() }),
+    v.object({ on_or_after: v.string() }),
+    emptyOperatorSchema,
+]);
+export const resolvedCustomBlockDataSourcePropertyFilterSchema = v.union([
+    v.object({
+        propertyId: v.string(),
+        title: customBlockTextFilterOperatorSchema,
+    }),
+    v.object({
+        propertyId: v.string(),
+        rich_text: customBlockTextFilterOperatorSchema,
+    }),
+    v.object({
+        propertyId: v.string(),
+        url: customBlockTextFilterOperatorSchema,
+    }),
+    v.object({
+        propertyId: v.string(),
+        email: customBlockTextFilterOperatorSchema,
+    }),
+    v.object({
+        propertyId: v.string(),
+        phone_number: customBlockTextFilterOperatorSchema,
+    }),
+    v.object({
+        propertyId: v.string(),
+        number: customBlockNumberFilterOperatorSchema,
+    }),
+    v.object({
+        propertyId: v.string(),
+        checkbox: customBlockCheckboxFilterOperatorSchema,
+    }),
+    v.object({
+        propertyId: v.string(),
+        select: customBlockOptionFilterOperatorSchema,
+    }),
+    v.object({
+        propertyId: v.string(),
+        multi_select: customBlockContainsFilterOperatorSchema,
+    }),
+    v.object({
+        propertyId: v.string(),
+        status: customBlockOptionFilterOperatorSchema,
+    }),
+    v.object({
+        propertyId: v.string(),
+        date: customBlockDateFilterOperatorSchema,
+    }),
+]);
+export const resolvedCustomBlockDataSourceFilterSchema = v.union([
+    resolvedCustomBlockDataSourcePropertyFilterSchema,
+    v.object({
+        and: v.array(resolvedCustomBlockDataSourcePropertyFilterSchema),
+    }),
+]);
+/** Maximum number of sort properties accepted in one data source query. */
+export const CUSTOM_BLOCK_DATA_SOURCE_QUERY_MAX_SORTS = 10;
+export const resolvedCustomBlockDataSourceSortSchema = v.object({
+    propertyId: v.string(),
+    direction: v.picklist(["ascending", "descending"]),
+});
+/**
+ * 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(),
+    /** A sandbox-resolved property filter. */
+    filter: v.optional(resolvedCustomBlockDataSourceFilterSchema),
+    /** Sandbox-resolved property sorts, in priority order. */
+    sorts: v.optional(v.array(resolvedCustomBlockDataSourceSortSchema)),
+});

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

@@ -0,0 +1,93 @@
+import * as v from "valibot";
+import type { CustomBlockErrorCode, CustomBlockErrorInfo } from "../errors.js";
+export declare const customBlockQueryDataSourceErrorCodeSchema: v.StringSchema<undefined>;
+export type CustomBlockQueryDataSourceErrorCode = CustomBlockErrorCode<"query_data_source_failed" | "invalid_data_source_query" | "invalid_data_source_query_filter" | "invalid_data_source_query_sort" | "unknown_data_source_key" | "unmapped_data_source">;
+export type CustomBlockQueryDataSourceErrorInfo = CustomBlockErrorInfo<CustomBlockQueryDataSourceErrorCode>;
+export declare const customBlockQueryDataSourceErrorInfoSchema: v.ObjectSchema<{
+    readonly code: v.StringSchema<undefined>;
+    readonly message: v.StringSchema<undefined>;
+    readonly isRetryable: v.BooleanSchema<undefined>;
+}, undefined>;
+/**
+ * Message sent by the host to update a `queryDataSource` subscription.
+ */
+export declare const queryDataSourceResultMessageSchema: v.VariantSchema<"status", [v.ObjectSchema<{
+    readonly type: v.LiteralSchema<"queryDataSourceResult", undefined>;
+    readonly subscriptionId: v.StringSchema<undefined>;
+    readonly status: v.LiteralSchema<"success", undefined>;
+    readonly items: v.ArraySchema<v.ObjectSchema<{
+        readonly id: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.BrandAction<string, "NotionPageId">]>;
+        readonly propertiesById: v.RecordSchema<v.StringSchema<undefined>, v.OptionalSchema<v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>, v.BooleanSchema<undefined>, v.VariantSchema<"type", [v.ObjectSchema<{
+            readonly type: v.LiteralSchema<"date", undefined>;
+            readonly start_date: v.StringSchema<undefined>;
+            readonly reminder: v.OptionalSchema<v.UnionSchema<[v.ObjectSchema<{
+                readonly unit: v.PicklistSchema<["year", "month", "week", "day"], undefined>;
+                readonly value: v.NumberSchema<undefined>;
+                readonly time: v.StringSchema<undefined>;
+                readonly defaultTimeZone: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+            }, undefined>, v.ObjectSchema<{
+                readonly unit: v.LiteralSchema<"none", undefined>;
+            }, undefined>], undefined>, undefined>;
+        }, undefined>, v.ObjectSchema<{
+            readonly type: v.LiteralSchema<"daterange", undefined>;
+            readonly start_date: v.StringSchema<undefined>;
+            readonly end_date: v.StringSchema<undefined>;
+            readonly reminder: v.OptionalSchema<v.UnionSchema<[v.ObjectSchema<{
+                readonly unit: v.PicklistSchema<["year", "month", "week", "day"], undefined>;
+                readonly value: v.NumberSchema<undefined>;
+                readonly time: v.StringSchema<undefined>;
+                readonly defaultTimeZone: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+            }, undefined>, v.ObjectSchema<{
+                readonly unit: v.LiteralSchema<"none", undefined>;
+            }, undefined>], undefined>, undefined>;
+        }, undefined>, v.ObjectSchema<{
+            readonly type: v.LiteralSchema<"datetime", undefined>;
+            readonly start_date: v.StringSchema<undefined>;
+            readonly start_time: v.StringSchema<undefined>;
+            readonly time_zone: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+            readonly reminder: v.OptionalSchema<v.UnionSchema<[v.UnionSchema<[v.ObjectSchema<{
+                readonly unit: v.PicklistSchema<["year", "month", "week", "day"], undefined>;
+                readonly value: v.NumberSchema<undefined>;
+                readonly time: v.StringSchema<undefined>;
+                readonly defaultTimeZone: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+            }, undefined>, v.ObjectSchema<{
+                readonly unit: v.PicklistSchema<["hour", "minute"], undefined>;
+                readonly value: v.NumberSchema<undefined>;
+            }, undefined>], undefined>, v.ObjectSchema<{
+                readonly unit: v.LiteralSchema<"none", undefined>;
+            }, undefined>], undefined>, undefined>;
+        }, undefined>, v.ObjectSchema<{
+            readonly type: v.LiteralSchema<"datetimerange", undefined>;
+            readonly start_date: v.StringSchema<undefined>;
+            readonly start_time: v.StringSchema<undefined>;
+            readonly end_date: v.StringSchema<undefined>;
+            readonly end_time: v.StringSchema<undefined>;
+            readonly time_zone: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+            readonly reminder: v.OptionalSchema<v.UnionSchema<[v.UnionSchema<[v.ObjectSchema<{
+                readonly unit: v.PicklistSchema<["year", "month", "week", "day"], undefined>;
+                readonly value: v.NumberSchema<undefined>;
+                readonly time: v.StringSchema<undefined>;
+                readonly defaultTimeZone: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+            }, undefined>, v.ObjectSchema<{
+                readonly unit: v.PicklistSchema<["hour", "minute"], undefined>;
+                readonly value: v.NumberSchema<undefined>;
+            }, undefined>], undefined>, v.ObjectSchema<{
+                readonly unit: v.LiteralSchema<"none", undefined>;
+            }, undefined>], undefined>, undefined>;
+        }, undefined>], undefined>, v.ArraySchema<v.StringSchema<undefined>, undefined>, v.ArraySchema<v.ObjectSchema<{
+            readonly id: v.StringSchema<undefined>;
+            readonly table: v.StringSchema<undefined>;
+        }, undefined>, undefined>], undefined>, undefined>, undefined>;
+    }, undefined>, undefined>;
+    readonly hasMore: v.BooleanSchema<undefined>;
+}, undefined>, v.ObjectSchema<{
+    readonly type: v.LiteralSchema<"queryDataSourceResult", undefined>;
+    readonly subscriptionId: v.StringSchema<undefined>;
+    readonly status: v.LiteralSchema<"error", undefined>;
+    readonly error: v.ObjectSchema<{
+        readonly code: v.StringSchema<undefined>;
+        readonly message: v.StringSchema<undefined>;
+        readonly isRetryable: v.BooleanSchema<undefined>;
+    }, undefined>;
+}, undefined>], undefined>;
+export type QueryDataSourceResultMessage = v.InferOutput<typeof queryDataSourceResultMessageSchema>;

package/dist/protocol/messages/queryDataSourceResult.js

@@ -0,0 +1,28 @@
+import * as v from "valibot";
+import { notionDataSourcePageBridgeSchema } from "../dataSources/dataSourcePage.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 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,
+    }),
+]);

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

@@ -0,0 +1,11 @@
+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 declare const resizeMessageSchema: v.ObjectSchema<{
+    readonly type: v.LiteralSchema<"resize", undefined>;
+    readonly height: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.FiniteAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
+}, undefined>;
+export type ResizeMessage = v.InferOutput<typeof resizeMessageSchema>;

package/dist/protocol/messages/resize.js

@@ -0,0 +1,10 @@
+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)),
+});