@notionhq/custom-blocks-dev-shell 0.1.65 → 0.1.66

package/data/people.json

@@ -1,6 +1,5 @@
 {
 	"type": "built-in",
-	"key": "people",
 	"name": "People",
 	"icon": "👤",
 	"schema": {

package/data/radar.json

@@ -1,6 +1,5 @@
 {
 	"type": "built-in",
-	"key": "default",
 	"name": "Radar",
 	"icon": "📡",
 	"schema": {

package/data/tasks.json

@@ -1,6 +1,5 @@
 {
 	"type": "built-in",
-	"key": "tasks",
 	"name": "Tasks",
 	"icon": "✅",
 	"schema": {

package/dist-cli/convert.js

@@ -17,11 +17,10 @@ const UNSUPPORTED_TYPE_FALLBACK = "rich_text";
 export function parseConvertArgs(argv) {
     const args = {
         input: undefined,
-        key: undefined,
         name: undefined,
     };
     const rejectUnknown = (arg) => {
-        throw new Error(`Unknown convert option "${arg}". Supported: --in <file>, --key <key>, --name <name>.`);
+        throw new Error(`Unknown convert option "${arg}". Supported: --in <file>, --name <name>.`);
     };
     parseCliArgs({
         argv,
@@ -29,9 +28,6 @@ export function parseConvertArgs(argv) {
             "--in": value => {
                 args.input = value;
             },
-            "--key": value => {
-                args.key = value;
-            },
             "--name": value => {
                 args.name = value;
             },
@@ -68,16 +64,14 @@ export function convertSample(input, overrides = {}) {
     const sample = parsed.output;
     const warnings = [];
     const mappings = buildPropertyMappings(sample.properties, sample.results, warnings);
-    const key = overrides.key ?? slugify(sample.name ?? "") ?? "data_source";
-    const name = overrides.name ?? (sample.name || undefined) ?? key;
+    const name = overrides.name ?? (sample.name || undefined);
     const schema = {};
     for (const mapping of mappings.values()) {
         schema[mapping.key] = { name: mapping.name, type: mapping.type };
     }
     const source = {
         type: "syncedFromProd",
-        key,
-        name,
+        ...(name !== undefined ? { name } : {}),
         schema,
         rows: (sample.results ?? []).map(row => convertRow(row, mappings)),
     };
@@ -207,7 +201,6 @@ export async function runConvert(argv) {
         throw new Error(`Input is not valid JSON — ${formatUnknownError(error)}`);
     }
     const { source, warnings } = convertSample(parsed, {
-        ...(args.key !== undefined ? { key: args.key } : {}),
         ...(args.name !== undefined ? { name: args.name } : {}),
     });
     for (const warning of warnings) {

package/dist-cli/data-sources.js

@@ -60,7 +60,6 @@ export function readDataSources(dataDir) {
 const nonEmptyString = v.pipe(v.string(), v.nonEmpty());
 export const sourceFileSchema = v.object({
     type: v.optional(v.picklist(DEV_SHELL_DATA_SOURCE_TYPES), "worker"),
-    key: v.optional(nonEmptyString),
     name: v.optional(nonEmptyString),
     icon: v.optional(v.string()),
     schema: v.optional(v.record(v.string(), v.object({
@@ -71,7 +70,7 @@ export const sourceFileSchema = v.object({
 });
 /**
  * Parse and validate one source file. Structural mistakes throw with the file
- * and problem named; omitted `key`/`name` fall back to the filename, and
+ * and problem named; the filename defines identity and the default `name`, and
  * omitted `schema`/`rows` to empty — so the minimal valid file is `{}`.
  */
 function readSource(file) {
@@ -93,12 +92,11 @@ function readSource(file) {
     }
     const { type, icon, schema, rows } = result.output;
     const filename = basename(file, ".json");
-    const key = result.output.key ?? filename;
     return {
         type,
-        key,
+        key: filename,
         filename,
-        name: result.output.name ?? key,
+        name: result.output.name ?? filename,
         ...(icon !== undefined ? { icon } : {}),
         schema: Object.fromEntries(Object.entries(schema).map(([propertyKey, property]) => [
             propertyKey,

package/dist-cli/materialize.js

@@ -23,8 +23,7 @@ const TYPE_ALIASES = {
 };
 /**
  * Generated files are namespaced so they never shadow authored files. The
- * filename and `key` carry the prefix — keys must stay unique for bindings to
- * be unambiguous — while the display name stays as declared, so the sidebar
+ * filename carries the prefix, while the display name stays as declared, so the sidebar
  * shows the clean name.
  */
 const WORKER_PREFIX = "worker_";
@@ -69,14 +68,12 @@ export function materializeWorkerSchemaDataSources(manifest, dataDir) {
     }
     mkdirSync(dataDir, { recursive: true });
     for (const [key, descriptor] of descriptors) {
-        // The key is the worker's contract and lands verbatim in the file's
-        // `key`; the filename is ours, so path-hostile characters (`/`, `..`)
-        // are encoded rather than allowed to leave `dataDir` or crash the write.
+        // Replace path-hostile characters so the filename stays inside `dataDir`.
         const file = resolve(dataDir, `${WORKER_PREFIX}${fileSafe(key)}.json`);
         if (existsSync(file)) {
             continue;
         }
-        writeFileSync(file, `${JSON.stringify(buildSource(key, descriptor), null, 2)}\n`);
+        writeFileSync(file, `${JSON.stringify(buildSource(descriptor), null, 2)}\n`);
     }
 }
 function fileSafe(key) {
@@ -90,7 +87,7 @@ function samePropertySchemas(left, right) {
             left[key].type === right[key].type &&
             (left[key].name ?? key) === (right[key].name ?? key)));
 }
-function buildSource(key, descriptor) {
+function buildSource(descriptor) {
     const { name, properties } = descriptor;
     const schema = {};
     for (const [propertyKey, property] of Object.entries(properties)) {
@@ -101,7 +98,6 @@ function buildSource(key, descriptor) {
     }
     return {
         type: "worker",
-        key: `${WORKER_PREFIX}${key}`,
         name,
         schema,
         rows: [],

package/dist-cli/prebuilt.js

@@ -2,21 +2,18 @@
  * Copy the shell's pre-built sources (`data/*.json`, shipped in the
  * package) into a worker's data directory. Like materialization, existing
  * worker data always wins: a bundled source is skipped when its filename is
- * already taken, and also when its `key` is already claimed by any existing
- * source — `key` is a source's binding/lookup identity, so a duplicate would
- * make one of the two ambiguous.
+ * already taken. The filename defines the source identity.
  */
 import { copyFileSync, existsSync, mkdirSync } from "node:fs";
 import { resolve } from "node:path";
 import { readDataSources } from "./data-sources.js";
 export function copyPrebuiltDataSources(prebuiltDir, dataDir) {
     mkdirSync(dataDir, { recursive: true });
-    const existingKeys = new Set(readDataSources(dataDir).map(source => source.key));
     const written = [];
     for (const source of readDataSources(prebuiltDir)) {
         const filename = `${source.filename}.json`;
         const target = resolve(dataDir, filename);
-        if (existsSync(target) || existingKeys.has(source.key)) {
+        if (existsSync(target)) {
             continue;
         }
         copyFileSync(resolve(prebuiltDir, filename), target);

package/docs/data-sources.md

@@ -14,7 +14,6 @@ supports the following types today:
 ```json
 {
   "type": "worker",
-  "key": "tasks",
   "name": "Tasks",
   "icon": "✅",
   "schema": {
@@ -37,17 +36,16 @@ supports the following types today:
 
 - `type` — the source's kind. Hand-authored files declare `"worker"` (the
   default); the pre-built sources the shell adds carry `"built-in"`.
-- `key` — what blocks bind against; make it match a `dataSources` key from
-  `worker.customBlock(...)` so properties auto-match. Defaults to the
-  filename.
-- `name` — the label shown in the shell sidebar. Defaults to `key`.
+- `name` — the label shown in the shell sidebar. If omitted, it defaults to
+  the filename without `.json`.
 - `icon` — optional emoji shown alongside the name.
-- `schema` — property key → `{ name, type }`. Use the same property keys and
+- `schema` — maps each property key to `{ name, type }`. If omitted, it defaults
+  to `{}`. Use the same property keys and
   types the block declares. Types: `title`, `rich_text`, `number`, `select`,
   `multi_select`, `status`, `date`, `checkbox`, `url`, `email`,
   `phone_number`, `people`, `files`, `relation`.
-- `rows` — each row needs a unique string `id`; property values live under
-  their schema keys.
+- `rows` — the source records. If omitted, it defaults to `[]`. Each row needs
+  a unique string `id`. Store property values under their schema keys.
 
 Value shapes by property type:
 
@@ -67,8 +65,8 @@ Value shapes by property type:
 Files are validated at spin-up, before they reach the shell UI. A malformed
 file fails the run with the file and problem named, e.g.
 `data/tasks.json: rows.0.id: Invalid key: Expected "id" but received undefined`.
-Omitted `key`/`name` fall back to the filename; omitted `schema`/`rows` to
-empty.
+The filename without `.json` is the source identity used by bindings and
+source pickers. Renaming a file changes its identity.
 
 ## Querying
 
@@ -86,7 +84,7 @@ materializes a file for every data source the worker declares — both
 schemas — that doesn't already have one: `data/worker_<key>.json`, the declared
 schema with empty `rows`, mirroring a managed database before any sync.
 
-- The `worker_` prefix on the filename and `key` namespaces generated files
+- The `worker_` prefix on the filename namespaces generated files
   away from ones you author yourself, so both coexist; the display `name`
   stays as declared, so the sidebar shows the clean name.
 - Files are only ever written when absent: fill in `rows` freely and your

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@notionhq/custom-blocks-dev-shell",
-  "version": "0.1.65",
+  "version": "0.1.66",
   "description": "Local preview shell for Notion custom block workers.",
   "license": "MIT",
   "type": "module",