datanotes 1.5.0 → 2.0.1

package/SECURITY.md

@@ -2,8 +2,8 @@
 
 ## Reporting a vulnerability
 
-Please report vulnerabilities privately, through GitHub's **Report a vulnerability** button on this
-repository (Security → Advisories), not in a public issue. You will get an answer within a week.
+Please report vulnerabilities privately, by email to the maintainer listed on the npm package
+page ([npmjs.com/package/datanotes](https://www.npmjs.com/package/datanotes)), not in public. You will get an answer within a week.
 Include the version, how to reproduce it and what an attacker gains.
 
 ## Security model

package/dist/api/index.cjs

@@ -274,7 +274,7 @@ var OPERATIONS = [
               },
               "path": {
                 "type": "string",
-                "description": "database.yaml#catalog.schema.table (or a legacy schema note)."
+                "description": "database.yaml#catalog.schema.table."
               },
               "description": {
                 "type": "string",
@@ -289,6 +289,7 @@ var OPERATIONS = [
             },
             "required": [
               "name",
+              "catalog",
               "schema",
               "qualified",
               "path"
@@ -386,7 +387,8 @@ var OPERATIONS = [
               "description": "Folder of the table's rows."
             },
             "inDatabase": {
-              "type": "boolean"
+              "type": "boolean",
+              "description": "Always true."
             },
             "rowPath": {
               "type": "string",
@@ -400,6 +402,7 @@ var OPERATIONS = [
           "required": [
             "folder",
             "inDatabase",
+            "rowPath",
             "archive"
           ],
           "additionalProperties": true
@@ -486,7 +489,7 @@ var OPERATIONS = [
               },
               "dense": {
                 "type": "boolean",
-                "description": "Also a top-level schema field."
+                "description": "Written on every row (with its default)."
               }
             },
             "required": [
@@ -505,7 +508,7 @@ var OPERATIONS = [
           "items": {
             "type": "string"
           },
-          "description": "Top-level schema fields without a column entry."
+          "description": "Table defaults without a column (written on every new row), and the table property."
         },
         "qualified": {
           "type": "string",
@@ -7646,7 +7649,7 @@ var OPERATIONS = [
   },
   {
     "name": "infer_table",
-    "description": "Read-only schema inference from notes' frontmatter.\n- `folder` (recursive; \"\" = whole vault) and/or `paths`: notes not yet in a table. Returns\n  `columns` (type, enum `values`, link `ref` to the table most targets belong to, `required`,\n  `unique`, `dense`, `from` when the property name is not a valid column name, `stats`),\n  `proposal` ready for create_table (`name`, `options.filename` or `timeColumn`, `columns`) and\n  `adopt` ready for adopt_rows (`paths`, `rename`, `relocate: false`), plus `notes` to read.\n  Review the proposal (names, enums, required) before creating; ask the user when unsure.\n- `table`: keys the table's rows use but the table does not declare (candidates for add_column,\n  or keys to drop from rows).\nA string column becomes an enum with at most `max_enum_values` distinct values (default 12).",
+    "description": "Read-only schema inference from notes' frontmatter.\n- `folder` (recursive; \"\" = whole vault) and/or `paths`: notes not yet in a table. Returns\n  `columns` (type, enum `values`, link `ref` to the table most targets belong to, `required`,\n  `unique`, `dense`, `from` when the property name is not a valid column name, `stats`),\n  `proposal` ready for create_table (`name`, `options.filename` or `timeColumn`, `columns`) and\n  `adopt` ready for adopt_rows (`paths`, `rename`, `relocate: false`), plus `notes` to read.\n  Review the proposal (names, enums, required) before creating; ask the user when unsure.\n- `table`: keys the table's rows use but the table does not declare (candidates for add_column,\n  or keys to drop from rows).\nA string column becomes an enum when its values repeat: at least 3 notes, at most `max_enum_values`\ndistinct values (default 12), each used twice on average, short texts.",
     "inputSchema": {
       "additionalProperties": false,
       "properties": {
@@ -10445,7 +10448,7 @@ var OPERATIONS = [
   },
   {
     "name": "create_view",
-    "description": "Create (or `replace`) a view: a named select stored in database.yaml. Name it with the prefix\n`vw_` (e.g. `vw_open_tasks`): views share names and folders with tables. `query` takes the\nselect_rows parameters (table, columns, where, order_by, limit, join, group_by, aggregates, expand;\nrelative dates keep it current) and must run now. `comment` and `aliases` let agents find it;\n`labels` are column headings. Read it with select_rows(table=<view>). A note shows it with a\n```datanotes block containing `view: <name>` (drawn live by the client; nothing is written into\nthe note). Filters may read the note that shows the view: `{this.date}`, `{this.date+1d}` (a\nfrontmatter value, date arithmetic), `{this.link}` (a link to that note), `{this.name}`. The view\nalso gets a note in its schema folder.",
+    "description": "Create (or `replace`) a view: a named select stored in database.yaml. Name it with the prefix\n`vw_` (e.g. `vw_open_tasks`): views share names and folders with tables. `query` takes the\nselect_rows parameters (table, columns, where, order_by, limit, join, group_by, aggregates, expand;\nrelative dates keep it current) and must run now. `comment` and `aliases` let agents find it;\n`labels` are column headings. Views are selected with select_rows(table=<view>), which may narrow them further\n(where, columns, order_by, limit). A view writes no note: it lives only in database.yaml.",
     "inputSchema": {
       "additionalProperties": false,
       "properties": {
@@ -12328,7 +12331,7 @@ function describeRefusal(data) {
   const op = data.op ?? "operation";
   const failed = (data.failed ?? []).length > 0;
   let head = failed ? `${op} failed` : `${op} refused \u2014 nothing was written`;
-  if (data.migrationId) head += ` (journal ${String(data.migrationId)}; use undo_migration to revert what was applied)`;
+  if (failed && data.migrationId) head += ` (journal ${String(data.migrationId)}; use undo_migration to revert what was applied)`;
   return head + (shown.length ? `:
 ${shown.join("\n")}` : "");
 }

package/dist/api/index.js

@@ -232,7 +232,7 @@ var OPERATIONS = [
               },
               "path": {
                 "type": "string",
-                "description": "database.yaml#catalog.schema.table (or a legacy schema note)."
+                "description": "database.yaml#catalog.schema.table."
               },
               "description": {
                 "type": "string",
@@ -247,6 +247,7 @@ var OPERATIONS = [
             },
             "required": [
               "name",
+              "catalog",
               "schema",
               "qualified",
               "path"
@@ -344,7 +345,8 @@ var OPERATIONS = [
               "description": "Folder of the table's rows."
             },
             "inDatabase": {
-              "type": "boolean"
+              "type": "boolean",
+              "description": "Always true."
             },
             "rowPath": {
               "type": "string",
@@ -358,6 +360,7 @@ var OPERATIONS = [
           "required": [
             "folder",
             "inDatabase",
+            "rowPath",
             "archive"
           ],
           "additionalProperties": true
@@ -444,7 +447,7 @@ var OPERATIONS = [
               },
               "dense": {
                 "type": "boolean",
-                "description": "Also a top-level schema field."
+                "description": "Written on every row (with its default)."
               }
             },
             "required": [
@@ -463,7 +466,7 @@ var OPERATIONS = [
           "items": {
             "type": "string"
           },
-          "description": "Top-level schema fields without a column entry."
+          "description": "Table defaults without a column (written on every new row), and the table property."
         },
         "qualified": {
           "type": "string",
@@ -7604,7 +7607,7 @@ var OPERATIONS = [
   },
   {
     "name": "infer_table",
-    "description": "Read-only schema inference from notes' frontmatter.\n- `folder` (recursive; \"\" = whole vault) and/or `paths`: notes not yet in a table. Returns\n  `columns` (type, enum `values`, link `ref` to the table most targets belong to, `required`,\n  `unique`, `dense`, `from` when the property name is not a valid column name, `stats`),\n  `proposal` ready for create_table (`name`, `options.filename` or `timeColumn`, `columns`) and\n  `adopt` ready for adopt_rows (`paths`, `rename`, `relocate: false`), plus `notes` to read.\n  Review the proposal (names, enums, required) before creating; ask the user when unsure.\n- `table`: keys the table's rows use but the table does not declare (candidates for add_column,\n  or keys to drop from rows).\nA string column becomes an enum with at most `max_enum_values` distinct values (default 12).",
+    "description": "Read-only schema inference from notes' frontmatter.\n- `folder` (recursive; \"\" = whole vault) and/or `paths`: notes not yet in a table. Returns\n  `columns` (type, enum `values`, link `ref` to the table most targets belong to, `required`,\n  `unique`, `dense`, `from` when the property name is not a valid column name, `stats`),\n  `proposal` ready for create_table (`name`, `options.filename` or `timeColumn`, `columns`) and\n  `adopt` ready for adopt_rows (`paths`, `rename`, `relocate: false`), plus `notes` to read.\n  Review the proposal (names, enums, required) before creating; ask the user when unsure.\n- `table`: keys the table's rows use but the table does not declare (candidates for add_column,\n  or keys to drop from rows).\nA string column becomes an enum when its values repeat: at least 3 notes, at most `max_enum_values`\ndistinct values (default 12), each used twice on average, short texts.",
     "inputSchema": {
       "additionalProperties": false,
       "properties": {
@@ -10403,7 +10406,7 @@ var OPERATIONS = [
   },
   {
     "name": "create_view",
-    "description": "Create (or `replace`) a view: a named select stored in database.yaml. Name it with the prefix\n`vw_` (e.g. `vw_open_tasks`): views share names and folders with tables. `query` takes the\nselect_rows parameters (table, columns, where, order_by, limit, join, group_by, aggregates, expand;\nrelative dates keep it current) and must run now. `comment` and `aliases` let agents find it;\n`labels` are column headings. Read it with select_rows(table=<view>). A note shows it with a\n```datanotes block containing `view: <name>` (drawn live by the client; nothing is written into\nthe note). Filters may read the note that shows the view: `{this.date}`, `{this.date+1d}` (a\nfrontmatter value, date arithmetic), `{this.link}` (a link to that note), `{this.name}`. The view\nalso gets a note in its schema folder.",
+    "description": "Create (or `replace`) a view: a named select stored in database.yaml. Name it with the prefix\n`vw_` (e.g. `vw_open_tasks`): views share names and folders with tables. `query` takes the\nselect_rows parameters (table, columns, where, order_by, limit, join, group_by, aggregates, expand;\nrelative dates keep it current) and must run now. `comment` and `aliases` let agents find it;\n`labels` are column headings. Views are selected with select_rows(table=<view>), which may narrow them further\n(where, columns, order_by, limit). A view writes no note: it lives only in database.yaml.",
     "inputSchema": {
       "additionalProperties": false,
       "properties": {
@@ -12286,7 +12289,7 @@ function describeRefusal(data) {
   const op = data.op ?? "operation";
   const failed = (data.failed ?? []).length > 0;
   let head = failed ? `${op} failed` : `${op} refused \u2014 nothing was written`;
-  if (data.migrationId) head += ` (journal ${String(data.migrationId)}; use undo_migration to revert what was applied)`;
+  if (failed && data.migrationId) head += ` (journal ${String(data.migrationId)}; use undo_migration to revert what was applied)`;
   return head + (shown.length ? `:
 ${shown.join("\n")}` : "");
 }