@notionhq/custom-blocks 0.0.58

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

@@ -0,0 +1,90 @@
+import * as v from "valibot";
+import type { CustomBlockErrorInfo } from "../errors.js";
+export declare const customBlockQueryDataSourceErrorCodeSchema: v.StringSchema<undefined>;
+export type CustomBlockQueryDataSourceErrorCode = "query_data_source_failed" | "unknown_data_source_key" | "unmapped_data_source" | (string & {});
+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 the sandbox in response to a `queryDataSource` request.
+ */
+export declare const queryDataSourceResultMessageSchema: v.ObjectSchema<{
+    readonly type: v.LiteralSchema<"queryDataSourceResult", undefined>;
+    readonly requestId: v.StringSchema<undefined>;
+    readonly snapshotId: v.StringSchema<undefined>;
+    readonly items: v.ArraySchema<v.ObjectSchema<{
+        readonly id: v.CustomSchema<import("../ids.js").NotionPageId, v.ErrorMessage<v.CustomIssue> | undefined>;
+        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>;
+    readonly error: v.OptionalSchema<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>;
+//# sourceMappingURL=queryDataSourceResult.d.ts.map

package/dist/bridge/messages/queryDataSourceResult.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"queryDataSourceResult.d.ts","sourceRoot":"","sources":["../../../../../../../../../Users/nsarkar/work/custom-blocks/sdk/src/bridge/messages/queryDataSourceResult.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAE5B,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAA;AAIxD,eAAO,MAAM,yCAAyC,2BAAa,CAAA;AAEnE,MAAM,MAAM,mCAAmC,GAC5C,0BAA0B,GAC1B,yBAAyB,GACzB,sBAAsB,GACtB,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA;AAEhB,MAAM,MAAM,mCAAmC,GAC9C,oBAAoB,CAAC,mCAAmC,CAAC,CAAA;AAE1D,eAAO,MAAM,yCAAyC;;;;aAIpD,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;aAO7C,CAAA;AAEF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,WAAW,CACvD,OAAO,kCAAkC,CACzC,CAAA"}

package/dist/bridge/messages/queryDataSourceResult.js

@@ -0,0 +1,21 @@
+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 the sandbox in response to a `queryDataSource` request.
+ */
+export const queryDataSourceResultMessageSchema = v.object({
+    type: v.literal("queryDataSourceResult"),
+    requestId: v.string(),
+    snapshotId: v.string(),
+    items: v.array(notionDataSourcePageBridgeSchema),
+    hasMore: v.boolean(),
+    error: v.optional(customBlockQueryDataSourceErrorInfoSchema),
+});

package/dist/bridge/messages/ready.d.ts

@@ -0,0 +1,45 @@
+import * as v from "valibot";
+/**
+ * First message the sandbox sends after mount, kicking off the bridge handshake. The host replies
+ * with `init`.
+ */
+export declare const readyMessageSchema: v.UnionSchema<[v.ObjectSchema<{
+    readonly type: v.LiteralSchema<"ready", undefined>;
+    readonly bridgeProtocolVersion: v.NumberSchema<undefined>;
+    readonly sdkVersion: v.StringSchema<undefined>;
+    readonly status: v.LiteralSchema<"success", undefined>;
+    /**
+     * The data sources and settings the custom block expects, or null when the
+     * block has no manifest and no declared data requirements.
+     */
+    readonly manifest: v.UnionSchema<[v.ObjectSchema<{
+        readonly version: v.LiteralSchema<1, undefined>;
+        readonly dataSources: v.RecordSchema<v.StringSchema<undefined>, v.ObjectSchema<{
+            readonly name: v.StringSchema<undefined>;
+            readonly description: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+            readonly icon: v.OptionalSchema<v.VariantSchema<"type", [v.ObjectSchema<{
+                readonly type: v.LiteralSchema<"emoji", undefined>;
+                readonly emoji: v.StringSchema<undefined>;
+            }, undefined>, v.ObjectSchema<{
+                readonly type: v.LiteralSchema<"external", undefined>;
+                readonly url: v.StringSchema<undefined>;
+            }, undefined>], undefined>, undefined>;
+            readonly properties: v.OptionalSchema<v.RecordSchema<v.StringSchema<undefined>, v.ObjectSchema<{
+                readonly name: v.StringSchema<undefined>;
+                readonly description: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+                readonly type: v.PicklistSchema<readonly ["title", "rich_text", "number", "checkbox", "url", "email", "phone_number", "select", "multi_select", "status", "date", "people", "files", "unique_id", "relation", "place", "formula", "rollup", "button", "verification", "last_visited_time", "location", "created_time", "last_edited_time", "created_by", "last_edited_by"], undefined>;
+            }, undefined>, undefined>, {}>;
+        }, undefined>, undefined>;
+    }, undefined>, v.NullSchema<undefined>], undefined>;
+}, undefined>, v.ObjectSchema<{
+    readonly type: v.LiteralSchema<"ready", undefined>;
+    readonly bridgeProtocolVersion: v.NumberSchema<undefined>;
+    readonly sdkVersion: v.StringSchema<undefined>;
+    readonly status: v.LiteralSchema<"error", undefined>;
+    readonly error: v.ObjectSchema<{
+        readonly code: v.StringSchema<undefined>;
+        readonly message: v.StringSchema<undefined>;
+    }, undefined>;
+}, undefined>], undefined>;
+export type ReadyMessage = v.InferOutput<typeof readyMessageSchema>;
+//# sourceMappingURL=ready.d.ts.map

package/dist/bridge/messages/ready.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ready.d.ts","sourceRoot":"","sources":["../../../../../../../../../Users/nsarkar/work/custom-blocks/sdk/src/bridge/messages/ready.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAmB5B;;;GAGG;AACH,eAAO,MAAM,kBAAkB;;;;;IAG7B;;;OAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;0BASH,CAAA;AAEF,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,kBAAkB,CAAC,CAAA"}

package/dist/bridge/messages/ready.js

@@ -0,0 +1,37 @@
+import * as v from "valibot";
+import { customBlockReadyErrorSchema } from "../loadManifest.js";
+import { manifestSchema } from "../manifest.js";
+const readyMessageCommonEntries = {
+    type: v.literal("ready"),
+    /**
+     * Used to ensure that the host and client are using the same version of the bridge protocol. A
+     * single host needs to support multiple custom blocks built with different versions of the bridge
+     * protocol. Increment this number any time a breaking change is made to the bridge protocol.
+     */
+    bridgeProtocolVersion: v.number(),
+    /**
+     * Semver version of the SDK package that sent this ready message. Should only be used for
+     * analytics purposes. Business logic should compare against `bridgeProtocolVersion` instead.
+     */
+    sdkVersion: v.string(),
+};
+/**
+ * First message the sandbox sends after mount, kicking off the bridge handshake. The host replies
+ * with `init`.
+ */
+export const readyMessageSchema = v.union([
+    v.object({
+        status: v.literal("success"),
+        /**
+         * The data sources and settings the custom block expects, or null when the
+         * block has no manifest and no declared data requirements.
+         */
+        manifest: v.union([manifestSchema, v.null_()]),
+        ...readyMessageCommonEntries,
+    }),
+    v.object({
+        status: v.literal("error"),
+        error: customBlockReadyErrorSchema,
+        ...readyMessageCommonEntries,
+    }),
+]);

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

@@ -0,0 +1,12 @@
+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>;
+//# sourceMappingURL=resize.d.ts.map

package/dist/bridge/messages/resize.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resize.d.ts","sourceRoot":"","sources":["../../../../../../../../../Users/nsarkar/work/custom-blocks/sdk/src/bridge/messages/resize.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAE5B;;;;GAIG;AACH,eAAO,MAAM,mBAAmB;;;aAG9B,CAAA;AAEF,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,mBAAmB,CAAC,CAAA"}

package/dist/bridge/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)),
+});