@notionhq/custom-blocks 0.0.78 → 0.1.0

package/bin/src/bridge/dataSources/propertySchema.js

@@ -1,148 +0,0 @@
-import * as v from "valibot";
-/**
- * Hex-token identifiers for Notion's named colors. Mirrors the public API's
- * `select.options[].color` enum
- * (https://developers.notion.com/reference/property-object#select).
- */
-export const notionPropertyColorSchema = v.picklist([
-    "default",
-    "gray",
-    "brown",
-    "orange",
-    "yellow",
-    "green",
-    "blue",
-    "purple",
-    "pink",
-    "red",
-    "gray_background",
-    "brown_background",
-    "orange_background",
-    "yellow_background",
-    "green_background",
-    "blue_background",
-    "purple_background",
-    "pink_background",
-    "red_background",
-    "default_background",
-]);
-export const notionPropertyOptionSchema = v.object({
-    id: v.string(),
-    name: v.string(),
-    color: v.optional(notionPropertyColorSchema),
-    description: v.optional(v.string()),
-});
-export const notionStatusGroupSchema = v.object({
-    id: v.string(),
-    name: v.string(),
-    color: v.optional(notionPropertyColorSchema),
-    option_ids: v.array(v.string()),
-});
-export const notionDualPropertySchema = v.object({
-    synced_property_id: v.string(),
-    synced_property_name: v.string(),
-});
-const baseProp = v.object({
-    name: v.string(),
-    description: v.optional(v.string()),
-});
-/**
- * Every Notion property type the bridge speaks, in a single readable list.
- * Mirrors the Notion public API
- * [property object](https://developers.notion.com/reference/property-object)
- * type field. Internal-only types (`button`, `verification`,
- * `last_visited_time`, `location`) and the four built-ins (`created_time`,
- * `last_edited_time`, `created_by`, `last_edited_by`) are included under their
- * bridge-native names.
- */
-export const NOTION_PROPERTY_TYPES = [
-    "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",
-];
-export const notionPropertyTypeSchema = v.picklist(NOTION_PROPERTY_TYPES);
-/**
- * Per-property schema as exposed by the host over the custom-block bridge.
- * The `type` discriminator must be one of {@link NOTION_PROPERTY_TYPES}.
- */
-export const notionPropertySchemaSchema = v.variant("type", [
-    v.object({ ...baseProp.entries, type: v.literal("title") }),
-    v.object({ ...baseProp.entries, type: v.literal("rich_text") }),
-    v.object({ ...baseProp.entries, type: v.literal("number") }),
-    v.object({ ...baseProp.entries, type: v.literal("checkbox") }),
-    v.object({ ...baseProp.entries, type: v.literal("url") }),
-    v.object({ ...baseProp.entries, type: v.literal("email") }),
-    v.object({ ...baseProp.entries, type: v.literal("phone_number") }),
-    v.object({
-        ...baseProp.entries,
-        type: v.literal("select"),
-        options: v.array(notionPropertyOptionSchema),
-    }),
-    v.object({
-        ...baseProp.entries,
-        type: v.literal("multi_select"),
-        options: v.array(notionPropertyOptionSchema),
-    }),
-    v.object({
-        ...baseProp.entries,
-        type: v.literal("status"),
-        options: v.array(notionPropertyOptionSchema),
-        groups: v.array(notionStatusGroupSchema),
-    }),
-    v.object({ ...baseProp.entries, type: v.literal("date") }),
-    v.object({ ...baseProp.entries, type: v.literal("people") }),
-    v.object({ ...baseProp.entries, type: v.literal("files") }),
-    v.object({ ...baseProp.entries, type: v.literal("unique_id") }),
-    v.object({
-        ...baseProp.entries,
-        type: v.literal("relation"),
-        data_source_id: v.optional(v.string()),
-        dual_property: v.optional(notionDualPropertySchema),
-    }),
-    v.object({ ...baseProp.entries, type: v.literal("place") }),
-    v.object({ ...baseProp.entries, type: v.literal("formula") }),
-    v.object({ ...baseProp.entries, type: v.literal("rollup") }),
-    // Internal-only types passed through under their bridge-native names.
-    v.object({ ...baseProp.entries, type: v.literal("button") }),
-    v.object({ ...baseProp.entries, type: v.literal("verification") }),
-    v.object({ ...baseProp.entries, type: v.literal("last_visited_time") }),
-    v.object({ ...baseProp.entries, type: v.literal("location") }),
-    // Synthetic built-ins. The host always emits one of each per data source.
-    v.object({ ...baseProp.entries, type: v.literal("created_time") }),
-    v.object({ ...baseProp.entries, type: v.literal("last_edited_time") }),
-    v.object({ ...baseProp.entries, type: v.literal("created_by") }),
-    v.object({ ...baseProp.entries, type: v.literal("last_edited_by") }),
-]);
-/**
- * The four synthetic built-in property IDs the host always includes in every
- * data source's `propertySchemasById` and every row's `propertiesById`.
- */
-export const NOTION_BUILTIN_PROPERTY_IDS = [
-    "created_time",
-    "last_edited_time",
-    "created_by",
-    "last_edited_by",
-];

package/bin/src/bridge/manifest.js

@@ -1,40 +0,0 @@
-import * as v from "valibot";
-import { notionPropertyTypeSchema } from "./dataSources/propertySchema.js";
-/**
- * User-authored manifest declaring the data sources the custom block expects.
- * Lives at `custom_blocks.json` in the project root. The sandbox may send it in
- * `connect`, and the host returns the authoritative manifest in `init`. The
- * `notionCustomBlock` Vite plugin from
- * `@notionhq/custom-blocks/vite` wires the JSON file into the dev server and
- * the build output.
- */
-/**
- * Decorative icon attached to a manifest data source. Mirrors the
- * `emoji` / `external` icon variants the public Notion API uses, so the host
- * can render a recognizable affordance next to the slot in setup UI.
- */
-export const manifestIconSchema = v.variant("type", [
-    v.object({
-        type: v.literal("emoji"),
-        emoji: v.string(),
-    }),
-    v.object({
-        type: v.literal("external"),
-        url: v.string(),
-    }),
-]);
-export const manifestPropertySchema = v.object({
-    name: v.string(),
-    description: v.optional(v.string()),
-    type: notionPropertyTypeSchema,
-});
-export const manifestDataSourceSchema = v.object({
-    name: v.string(),
-    description: v.optional(v.string()),
-    icon: v.optional(manifestIconSchema),
-    properties: v.optional(v.record(v.string(), manifestPropertySchema), {}),
-});
-export const manifestSchema = v.object({
-    version: v.literal(1),
-    dataSources: v.record(v.string(), manifestDataSourceSchema),
-});

package/dist/host/lifecycle/ready.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ready.d.ts","sourceRoot":"","sources":["../../../../../home/runner/work/custom-blocks/custom-blocks/sdk/src/host/lifecycle/ready.ts"],"names":[],"mappings":"AAAA,wBAAgB,4BAA4B,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAErE"}

package/docs/manifest.md

@@ -1,42 +0,0 @@
-# Manifest
-
-A custom block declares its required data sources in `custom_blocks.json` at the project root. Notion uses the manifest to know what semantic keys the block expects, what shape each property should be, and what to show when an admin is configuring the block.
-
-```json
-{
-  "version": 1,
-  "dataSources": {
-    "tasks": {
-      "name": "Tasks",
-      "description": "The collection of tasks to render",
-      "properties": {
-        "title": { "name": "Title", "type": "title" },
-        "dueDate": { "name": "Due date", "type": "date" }
-      }
-    }
-  }
-}
-```
-
-`initCustomBlock()` fetches the manifest and forwards it with `connect`. The `notionCustomBlock()` Vite plugin from `@notionhq/custom-blocks/vite` serves it in dev and emits it into `dist/` on build. If the file is missing, the SDK omits `manifest` from `connect`. If the file is unavailable for another reason or invalid, the SDK sends `connect` with `status: "error"` and an `error` payload. The host returns its authoritative manifest in `init`. The SDK uses that manifest even when it differs from the manifest sent in `connect`.
-
-## Vite plugin
-
-```ts
-import { defineConfig } from "vite";
-import react from "@vitejs/plugin-react";
-import { notionCustomBlock } from "@notionhq/custom-blocks/vite";
-
-export default defineConfig({
-  plugins: [react(), notionCustomBlock()],
-});
-```
-
-In dev, the plugin serves `custom_blocks.json` from the project root so HMR + the SDK handshake see the same file. On `vite build`, it emits `custom_blocks.json` into `dist/` as a separate asset alongside the bundled HTML and JS.
-
-## Types
-
-- `CustomBlockManifest` — the parsed shape of `custom_blocks.json`.
-- `ManifestDataSource` — a single entry in `dataSources` (name, description, properties).
-- `ManifestProperty` — a single property declaration inside a `ManifestDataSource`.
-- `ManifestIcon` — the icon variant accepted on a `ManifestDataSource`.