@softr/cli 0.1.6-se21219.17 → 0.1.6

package/README.md

@@ -226,27 +226,27 @@ crm/
   .softr-db/views/<tableId>.json  # the views of a table, once views list read them
 ```
 
-| Command                                                                                   | What it does                                                                                                                                                                                    |
-| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `db list`                                                                                 | The databases the token reaches, across all workspaces, with their workspace and number of tables.                                                                                              |
-| `db get [<database>] [--dir <path>]`                                                      | One database with its tables, by id or exact name. Outside a database directory it creates `./<name-slug>/`; inside one it refreshes the cache, and a different database is an error.           |
-| `db create <name> [--description <text>] [--workspace <id>] [--dir <path>]`               | Create an empty database and its directory. The workspace defaults to `SOFTR_WORKSPACE_ID`, else to your only or default workspace among those where the token grants `databases.schema:write`. |
-| `db update [<databaseId>] [--name <name>] [--description <text>] [--dir <path>]`          | Change the name, the description or both.                                                                                                                                                       |
-| `db delete [<databaseId>] [--force] [--dir <path>]`                                       | Delete a database. One that still has tables needs `--force`, which also deletes the tables and all their records. The directory keeps its `softr-db.jsonc`; the cache goes.                    |
-| `db tables list` / `get <table>`                                                          | The tables of the database; one table with its fields (ids, types, primary/required/read-only).                                                                                                 |
-| `db tables create <name> [--field <name:TYPE>]... [--primary-field <name>]`               | Create a table with at least one `--field`; the first one names a record.                                                                                                                       |
-| `db tables update <table> [--name] [--description]` / `delete <table> [--force]`          | Rename or describe a table; delete it (`--force` when it still has records).                                                                                                                    |
-| `db fields get <table> <field>`                                                           | One field with its options.                                                                                                                                                                     |
-| `db fields add <table> <name> --type <TYPE> [--options <json>] [--multiple]`              | Add a field. The types and their options: [field reference](https://docs.softr.io/softr-api/softr-database-api/table-fields/add-table-field).                                                   |
-| `db fields update <table> <field> [--name] [--type] [--options <json>] [--[no-]multiple]` | Change a field; what is not passed stays as it is, `--options` replaces the options as a whole.                                                                                                 |
-| `db fields delete <table> <field>`                                                        | Delete a field and its values in every record.                                                                                                                                                  |
-| `db views list <table>`                                                                   | The views of a table (the API reads views only).                                                                                                                                                |
-| `db records list <table> [--view <view>] [--limit <n>] [--offset <n>] [--all]`            | Records through a view, the table's default view unless `--view`; one page or `--all` in pages of 200.                                                                                          |
-| `db records search <table> [--filter <json>] [--sort <field[:desc]>]...`                  | Records by a filter ([operators](https://docs.softr.io/softr-api/softr-database-api/records/search-records)); without `--filter`, every record.                                                 |
-| `db records get <table> <recordId>`                                                       | One record.                                                                                                                                                                                     |
-| `db records create <table> --fields <json>` / `update <table> <recordId> --fields <json>` | Create a record, or change some of its fields. `--fields` is inline JSON, `@<file>` or `-`.                                                                                                     |
-| `db records delete <table> <recordId>`                                                    | Delete a record.                                                                                                                                                                                |
-| `db records upload <table> <recordId> <field> <file> [--name <fileName>]`                 | Add a local file to an attachment field, stored under the local file name unless `--name`.                                                                                                      |
+| Command                                                                                       | What it does                                                                                                                                                                                    |
+| --------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `db list`                                                                                     | The databases the token reaches, across all workspaces, with their workspace and number of tables.                                                                                              |
+| `db get [<database>] [--dir <path>]`                                                          | One database with its tables, by id or exact name. Outside a database directory it creates `./<name-slug>/`; inside one it refreshes the cache, and a different database is an error.           |
+| `db create <name> [--description <text>] [--workspace <id>] [--dir <path>]`                   | Create an empty database and its directory. The workspace defaults to `SOFTR_WORKSPACE_ID`, else to your only or default workspace among those where the token grants `databases.schema:write`. |
+| `db update [<databaseId>] [--name <name>] [--description <text>] [--dir <path>]`              | Change the name, the description or both.                                                                                                                                                       |
+| `db delete [<databaseId>] [--force] [--dir <path>]`                                           | Delete a database. One that still has tables needs `--force`, which also deletes the tables and all their records. The directory keeps its `softr-db.jsonc`; the cache goes.                    |
+| `db tables list` / `get <table>`                                                              | The tables of the database; one table with its fields (ids, types, primary/required/read-only).                                                                                                 |
+| `db tables create <name> [--field <name:TYPE>]... [--fields <json>] [--primary-field <name>]` | Create a table with at least one field: `--field` for types without options, `--fields` (a JSON array, `@<file>` or `-`) for any; the first one names a record.                                 |
+| `db tables update <table> [--name] [--description]` / `delete <table> [--force]`              | Rename or describe a table; delete it (`--force` when it still has records).                                                                                                                    |
+| `db fields get <table> <field>`                                                               | One field with its options.                                                                                                                                                                     |
+| `db fields add <table> <name> --type <TYPE> [--options <json>] [--multiple]`                  | Add a field. The types and their options: [field reference](https://docs.softr.io/softr-api/softr-database-api/table-fields/add-table-field).                                                   |
+| `db fields update <table> <field> [--name] [--type] [--options <json>] [--[no-]multiple]`     | Change a field; what is not passed stays as it is, `--options` replaces the options as a whole.                                                                                                 |
+| `db fields delete <table> <field>`                                                            | Delete a field and its values in every record.                                                                                                                                                  |
+| `db views list <table>`                                                                       | The views of a table (the API reads views only).                                                                                                                                                |
+| `db records list <table> [--view <view>] [--limit <n>] [--offset <n>] [--all]`                | Records through a view, the table's default view unless `--view`; one page or `--all` in pages of 200.                                                                                          |
+| `db records search <table> [--filter <json>] [--sort <field[:desc]>]...`                      | Records by a filter ([operators](https://docs.softr.io/softr-api/softr-database-api/records/search-records)); without `--filter`, every record.                                                 |
+| `db records get <table> <recordId>`                                                           | One record.                                                                                                                                                                                     |
+| `db records create <table> --fields <json>` / `update <table> <recordId> --fields <json>`     | Create a record, or change some of its fields. `--fields` is inline JSON, `@<file>` or `-`.                                                                                                     |
+| `db records delete <table> <recordId>`                                                        | Delete a record.                                                                                                                                                                                |
+| `db records upload <table> <recordId> <field> <file> [--name <fileName>]`                     | Add a local file to an attachment field, stored under the local file name unless `--name`.                                                                                                      |
 
 Tables and fields take an id or an exact name; a name two items share is an error that lists their ids. The table,
 field and view commands take the database from `--database <id>`, else `SOFTR_DATABASE_ID`, else the database

package/dist/cli.mjs

@@ -15697,7 +15697,11 @@ async function readJsonArgument(value, option, hint) {
     }
     text = Buffer.concat(chunks).toString("utf8");
   } else if (value.startsWith("@")) {
-    text = await readFile8(value.slice(1), "utf8");
+    try {
+      text = await readFile8(value.slice(1), "utf8");
+    } catch {
+      throw new CliError(`Cannot read ${value.slice(1)} for ${option}.`);
+    }
   }
   try {
     return JSON.parse(text);
@@ -15730,8 +15734,8 @@ async function currentTables(context, fresh) {
   context.cache = await refreshSchemaCache(context.client, context.dir, context.databaseId);
   return context.cache.tables;
 }
-async function findTable(context, reference, fresh = false) {
-  const table = byIdOrName(await currentTables(context, fresh), reference, "table") ?? (context.dir && !fresh ? byIdOrName(await currentTables(context, true), reference, "table") : void 0);
+function tableIn(context, tables, reference) {
+  const table = byIdOrName(tables, reference, "table");
   if (!table) {
     throw new CliError(
       `Database ${context.databaseId} has no table with the id or name "${reference}".`,
@@ -15740,7 +15744,14 @@ async function findTable(context, reference, fresh = false) {
   }
   return table;
 }
-async function findFields(context, table, references, fresh = false) {
+async function findTableOnServer(context, reference) {
+  return tableIn(context, await currentTables(context, true), reference);
+}
+async function findTableCached(context, reference) {
+  const cached = context.dir && context.cache ? byIdOrName(context.cache.tables, reference, "table") : void 0;
+  return cached ?? findTableOnServer(context, reference);
+}
+async function findFields(context, table, references) {
   const resolve = (current3) => {
     const fields2 = /* @__PURE__ */ new Map();
     for (const reference of references) {
@@ -15753,8 +15764,8 @@ async function findFields(context, table, references, fresh = false) {
   };
   let current2 = table;
   let fields = resolve(current2);
-  if (fields.size < new Set(references).size && context.dir && !fresh) {
-    current2 = await findTable(context, table.id, true);
+  if (fields.size < new Set(references).size && context.dir) {
+    current2 = await findTableOnServer(context, table.id);
     fields = resolve(current2);
   }
   const missing = references.filter((reference) => !fields.has(reference));
@@ -15766,9 +15777,34 @@ async function findFields(context, table, references, fresh = false) {
   }
   return { table: current2, fields };
 }
-async function findField(context, tableReference, reference, fresh = false) {
-  const found = await findFields(context, await findTable(context, tableReference, fresh), [reference], fresh);
-  return { table: found.table, field: found.fields.get(reference) };
+async function readViews(context, table) {
+  const views = await listViews(context.client, context.databaseId, table.id);
+  if (context.dir) {
+    await writeViewsCache(context.dir, table.id, views);
+  }
+  return views;
+}
+async function findView(context, table, reference) {
+  const cached = context.dir ? (await readViewsCache(context.dir, table.id))?.views : void 0;
+  const view = (cached ? byIdOrName(cached, reference, "view") : void 0) ?? byIdOrName(await readViews(context, table), reference, "view");
+  if (!view) {
+    throw new CliError(
+      `Table ${table.name} has no view with the id or name "${reference}".`,
+      `"softr db views list ${table.id}" shows its views.`
+    );
+  }
+  return view;
+}
+async function findField(context, tableReference, reference) {
+  const table = await findTableOnServer(context, tableReference);
+  const field = byIdOrName(table.fields, reference, "field");
+  if (!field) {
+    throw new CliError(
+      `Table ${table.name} has no field with the id or name "${reference}".`,
+      `"softr db tables get ${table.id}" shows its fields.`
+    );
+  }
+  return { table, field };
 }
 async function afterSchemaWrite(context) {
   if (context.dir) {
@@ -15787,6 +15823,21 @@ function parseFieldSpec(spec) {
   }
   return { name, type };
 }
+function parseFieldList(value) {
+  if (!Array.isArray(value)) {
+    throw new CliError(
+      "--fields must be a JSON array of fields.",
+      `For example: [{"name": "Stage", "type": "SELECT", "options": {...}}]`
+    );
+  }
+  return value.map((item, index) => {
+    const field = item;
+    if (!field || typeof field !== "object" || typeof field.name !== "string" || !field.name || typeof field.type !== "string" || !field.type) {
+      throw new CliError(`--fields item ${index + 1} needs a "name" and a "type".`);
+    }
+    return { ...field, name: field.name, type: field.type.toUpperCase() };
+  });
+}
 function renderTables(tables) {
   if (!tables.length) {
     return "The database has no tables. Create one with: softr db tables create <name>";
@@ -15849,7 +15900,7 @@ function registerTables(db2) {
   ).action(async (reference, opts, command) => {
     const options = globalOptions(command);
     const context = await schemaContext(opts);
-    const table = await findTable(context, reference, true);
+    const table = await findTableOnServer(context, reference);
     emit(options, renderTable(table), { table });
   });
   withDatabaseOptions(
@@ -15857,22 +15908,28 @@ function registerTables(db2) {
       "Create a table with at least one field; the first one names a record unless --primary-field says otherwise"
     ).argument("<name>", "the table name").option("--description <text>", "what the table holds").option(
       "--field <name:TYPE>",
-      `a field to create with it, repeatable (types and their options: ${FIELD_REFERENCE_URL}); add fields with options through "softr db fields add"`,
+      "a field of a type without options, repeatable",
       (value, previous) => [...previous, value],
       []
+    ).option(
+      "--fields <json>",
+      `fields as a JSON array of {name, type, options?, description?, allowMultipleEntries?}, @<file> or - for stdin; they follow the --field ones (types and options: ${FIELD_REFERENCE_URL})`
     ).option("--primary-field <name>", "the field that names a record (default: the first field)")
   ).action(
     async (name, opts, command) => {
       const options = globalOptions(command);
-      if (!opts.field.length) {
+      const fields = [
+        ...opts.field.map(parseFieldSpec),
+        ...opts.fields === void 0 ? [] : parseFieldList(await readJsonArgument(opts.fields, "--fields"))
+      ];
+      if (!fields.length) {
         throw new CliError(
-          'A table needs at least one field: pass --field <name>:<TYPE>, for example --field "Name:SINGLE_LINE_TEXT".',
-          "Repeat --field for more; the first one names a record unless --primary-field names another."
+          'A table needs at least one field: pass --field <name>:<TYPE>, for example --field "Name:SINGLE_LINE_TEXT", or --fields with a JSON array.',
+          "The first field names a record unless --primary-field names another."
         );
       }
-      const fields = opts.field.map(parseFieldSpec);
       if (opts.primaryField && !fields.some((field) => field.name === opts.primaryField)) {
-        throw new CliError(`--primary-field "${opts.primaryField}" is not one of the --field names.`);
+        throw new CliError(`--primary-field "${opts.primaryField}" is not one of the fields' names.`);
       }
       const context = await schemaContext(opts);
       const table = await createTable(context.client, context.databaseId, {
@@ -15894,7 +15951,7 @@ function registerTables(db2) {
       }
       const options = globalOptions(command);
       const context = await schemaContext(opts);
-      const current2 = await findTable(context, reference, true);
+      const current2 = await findTableOnServer(context, reference);
       const table = await updateTable(context.client, context.databaseId, current2.id, {
         name: opts.name ?? current2.name,
         description: opts.description ?? current2.description
@@ -15908,7 +15965,7 @@ function registerTables(db2) {
   ).action(async (reference, opts, command) => {
     const options = globalOptions(command);
     const context = await schemaContext(opts);
-    const table = await findTable(context, reference, true);
+    const table = await findTableOnServer(context, reference);
     await deleteTable(context.client, context.databaseId, table.id, opts.force === true);
     await afterSchemaWrite(context);
     emit(options, `Deleted table ${table.name} (${table.id}).`, { deleted: table.id });
@@ -15921,7 +15978,7 @@ function registerFields(db2) {
   ).action(async (tableReference, reference, opts, command) => {
     const options = globalOptions(command);
     const context = await schemaContext(opts);
-    const { table, field } = await findField(context, tableReference, reference, true);
+    const { table, field } = await findField(context, tableReference, reference);
     emit(options, renderField(table, field), { tableId: table.id, field });
   });
   withDatabaseOptions(
@@ -15931,7 +15988,7 @@ function registerFields(db2) {
       const options = globalOptions(command);
       const fieldOptions = await parseOptions(opts.options);
       const context = await schemaContext(opts);
-      const table = await findTable(context, tableReference);
+      const table = await findTableCached(context, tableReference);
       const field = await addField(context.client, context.databaseId, table.id, {
         name,
         type: opts.type.toUpperCase(),
@@ -15959,7 +16016,7 @@ function registerFields(db2) {
       }
       const options = globalOptions(command);
       const context = await schemaContext(opts);
-      const { table, field: current2 } = await findField(context, tableReference, reference, true);
+      const { table, field: current2 } = await findField(context, tableReference, reference);
       const field = await updateField(context.client, context.databaseId, table.id, current2.id, {
         name: opts.name ?? current2.name,
         type: opts.type?.toUpperCase() ?? current2.type,
@@ -15981,7 +16038,7 @@ function registerFields(db2) {
   ).action(async (tableReference, reference, opts, command) => {
     const options = globalOptions(command);
     const context = await schemaContext(opts);
-    const { table, field } = await findField(context, tableReference, reference, true);
+    const { table, field } = await findField(context, tableReference, reference);
     await deleteField(context.client, context.databaseId, table.id, field.id);
     await afterSchemaWrite(context);
     emit(options, `Deleted field ${field.name} (${field.id}) from ${table.name}.`, {
@@ -15997,11 +16054,8 @@ function registerViews(db2) {
   ).action(async (reference, opts, command) => {
     const options = globalOptions(command);
     const context = await schemaContext(opts);
-    const table = await findTable(context, reference, true);
-    const items = await listViews(context.client, context.databaseId, table.id);
-    if (context.dir) {
-      await writeViewsCache(context.dir, table.id, items);
-    }
+    const table = await findTableOnServer(context, reference);
+    const items = await readViews(context, table);
     emit(options, renderViews(items), { tableId: table.id, views: items });
   });
 }
@@ -16101,24 +16155,6 @@ function parseSort(spec) {
   }
   return { field: spec.trim(), sortType: "ASC" };
 }
-async function findView(context, table, reference) {
-  const fresh = async () => {
-    const views = await listViews(context.client, context.databaseId, table.id);
-    if (context.dir) {
-      await writeViewsCache(context.dir, table.id, views);
-    }
-    return views;
-  };
-  const cached = context.dir ? (await readViewsCache(context.dir, table.id))?.views : void 0;
-  const view = (cached ? byIdOrName(cached, reference, "view") : void 0) ?? byIdOrName(await fresh(), reference, "view");
-  if (!view) {
-    throw new CliError(
-      `Table ${table.name} has no view with the id or name "${reference}".`,
-      `"softr db views list ${table.id}" shows its views.`
-    );
-  }
-  return view;
-}
 function withFieldNames(record, table) {
   const names2 = new Map(table.fields.map((field) => [field.id, field.name]));
   return {
@@ -16158,7 +16194,7 @@ function registerRecords(db2) {
       const options = globalOptions(command);
       const pages = paging(opts);
       const context = await schemaContext(opts);
-      const table = await findTable(context, reference);
+      const table = await findTableCached(context, reference);
       const viewId = opts.view ? (await findView(context, table, opts.view)).id : void 0;
       const page = await readPages(
         pages,
@@ -16196,7 +16232,7 @@ function registerRecords(db2) {
       const context = await schemaContext(opts);
       const references = new Set(sorts.map((sort) => sort.field));
       fieldReferences(condition, references);
-      const { table, ids } = await fieldIdsFor(context, await findTable(context, reference), [...references]);
+      const { table, ids } = await fieldIdsFor(context, await findTableCached(context, reference), [...references]);
       const search = (offset2, limit) => ({
         paging: { offset: offset2, limit },
         ...sorts.length ? { sorting: sorts.map((sort) => ({ sortingField: ids.get(sort.field), sortType: sort.sortType })) } : {},
@@ -16216,7 +16252,7 @@ function registerRecords(db2) {
   ).action(async (reference, recordId, opts, command) => {
     const options = globalOptions(command);
     const context = await schemaContext(opts);
-    const table = await findTable(context, reference);
+    const table = await findTableCached(context, reference);
     const record = await getRecord(context.client, context.databaseId, table.id, recordId, !opts.fieldIds);
     emit(options, renderRecord(record), { tableId: table.id, record });
   });
@@ -16231,7 +16267,7 @@ function registerRecords(db2) {
     const options = globalOptions(command);
     const fields = asObject(await readJsonArgument(opts.fields, "--fields"), "--fields");
     const context = await schemaContext(opts);
-    const table = await findTable(context, reference);
+    const table = await findTableCached(context, reference);
     const record = await createRecord(
       context.client,
       context.databaseId,
@@ -16256,7 +16292,7 @@ function registerRecords(db2) {
         throw new CliError("Nothing to change: --fields is an empty object.");
       }
       const context = await schemaContext(opts);
-      const table = await findTable(context, reference);
+      const table = await findTableCached(context, reference);
       const record = await updateRecord(
         context.client,
         context.databaseId,
@@ -16273,7 +16309,7 @@ function registerRecords(db2) {
   ).action(async (reference, recordId, opts, command) => {
     const options = globalOptions(command);
     const context = await schemaContext(opts);
-    const table = await findTable(context, reference, true);
+    const table = await findTableOnServer(context, reference);
     await deleteRecord(context.client, context.databaseId, table.id, recordId);
     emit(options, `Deleted record ${recordId} from ${table.name}.`, { tableId: table.id, deleted: recordId });
   });
@@ -16291,13 +16327,12 @@ function registerRecords(db2) {
         throw new CliError(`Cannot read ${file}.`);
       }
       const context = await schemaContext(opts);
-      const found = await fieldIdsFor(context, await findTable(context, reference), [fieldReference]);
-      const fieldId = found.ids.get(fieldReference);
-      const fieldType = found.table.fields.find((field) => field.id === fieldId)?.type;
-      if (fieldType !== "ATTACHMENT") {
-        throw new CliError(`Field "${fieldReference}" has the type ${fieldType}; upload needs an ATTACHMENT field.`);
+      const found = await findFields(context, await findTableCached(context, reference), [fieldReference]);
+      const field = found.fields.get(fieldReference);
+      if (field.type !== "ATTACHMENT") {
+        throw new CliError(`Field "${fieldReference}" has the type ${field.type}; upload needs an ATTACHMENT field.`);
       }
-      const uploaded = await uploadAttachment(context.client, context.databaseId, found.table.id, recordId, fieldId, {
+      const uploaded = await uploadAttachment(context.client, context.databaseId, found.table.id, recordId, field.id, {
         name: opts.name ?? path12.basename(file),
         content
       });
@@ -17963,7 +17998,7 @@ Pass --workspace <id> to a command, or set SOFTR_WORKSPACE_ID, to work in one of
 // package.json
 var package_default = {
   name: "@softr/cli",
-  version: "0.1.6-se21219.17",
+  version: "0.1.6",
   description: "The Softr command line: build, test and publish Softr workflows from local files, manage Softr Databases; more Softr APIs to come",
   keywords: [
     "softr",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@softr/cli",
-  "version": "0.1.6-se21219.17",
+  "version": "0.1.6",
   "description": "The Softr command line: build, test and publish Softr workflows from local files, manage Softr Databases; more Softr APIs to come",
   "keywords": [
     "softr",