zinkee 0.1.8 → 0.1.10

package/README.md

@@ -131,7 +131,7 @@ Simple field types use `--type`, `--slug`, `--label`:
 
 ```bash
 zinkee schemas fields create projects --type text --slug name --label "Name"
-zinkee schemas fields create projects --type number --slug budget --label "Budget"
+zinkee schemas fields create projects --type number --slug budget --label "Budget" --required true --default 0
 zinkee schemas fields create projects --type date --slug start-date --label "Start Date"
 zinkee schemas fields create projects --type file --slug attachment --label "Attachment"
 zinkee schemas fields create projects --type autoincremental --slug code --label "Code"
@@ -188,6 +188,12 @@ zinkee schemas fields create projects --raw '{
 
 ### Update field config
 
+Use `--default <value>` for the common default-value case:
+
+```bash
+zinkee schemas fields update projects budget --default 0
+```
+
 PATCH bodies are flat (no `set` / `unset` wrapper). Config properties must be wrapped inside a `config` key:
 
 ```bash

package/dist/index.js

@@ -2858,7 +2858,7 @@ var specificExamples = {
   "sort": [
     { "field": "id", "direction": "DESC" }
   ],
-  "page": { "offset": 0, "size": 10 }
+  "page": { "offset": 0, "limit": 10 }
 }`,
       response: `{
   "records": [
@@ -2893,7 +2893,19 @@ var specificExamples = {
     { "field": "amount", "direction": "DESC" },
     { "field": "contact-name", "direction": "ASC" }
   ],
-  "page": { "offset": 0, "size": 25 }
+  "page": { "offset": 0, "limit": 25 }
+}`
+    },
+    {
+      description: "Filter by status with a free-text search term.",
+      command: `zinkee --json records query contacts --select id,contact-name,status --where "status in OPEN" --limit 25 --raw '{"search":{"term":"garcia"}}'`,
+      raw: `{
+  "select": ["id", "contact-name", "status"],
+  "where": [
+    { "field": "status", "op": "in", "value": ["OPEN"] }
+  ],
+  "search": { "term": "garcia" },
+  "page": { "offset": 0, "limit": 25 }
 }`
     },
     {
@@ -2904,7 +2916,7 @@ var specificExamples = {
   "where": [
     { "field": "contact-name", "op": "contains", "value": "Lovelace" }
   ],
-  "page": { "offset": 0, "size": 50 }
+  "page": { "offset": 0, "limit": 50 }
 }`
     },
     {
@@ -10292,6 +10304,22 @@ function buildSchemaUpdateInput(options) {
   }
   return input;
 }
+function applyFieldDefaultValue(input, defaultValue) {
+  if (defaultValue === void 0) {
+    return;
+  }
+  const config = input.config;
+  if (config !== void 0 && !isJsonObject6(config)) {
+    throw new CliError(
+      "invalid_cli_usage",
+      'Expected field "config" to be a JSON object when using "--default".'
+    );
+  }
+  input.config = {
+    ...config ?? {},
+    defaultValue
+  };
+}
 function buildFieldCreateInput(options) {
   const raw = normalizeSchemaFieldCreatePayload(readRawObject4(options.raw, options.rawFile));
   const rawType = typeof raw.type === "string" ? raw.type : void 0;
@@ -10320,6 +10348,7 @@ function buildFieldCreateInput(options) {
   if (options.required !== void 0) {
     input.required = options.required;
   }
+  applyFieldDefaultValue(input, options.default);
   if ("config" in input && isJsonObject6(input.config) && isEmptyObject5(input.config)) {
     delete input.config;
   }
@@ -10362,6 +10391,7 @@ function buildFieldUpdateInput(currentType, options) {
   if (options.required !== void 0) {
     input.required = options.required;
   }
+  applyFieldDefaultValue(input, options.default);
   return input;
 }
 async function resolveSchemaSelector2(api, selector2) {
@@ -10489,7 +10519,7 @@ function registerSchemasCommands(program, options = {}) {
     }
     emitFieldsTable(stdout, [data]);
   });
-  fields.command("create").description(`Create a field in a schema.${buildSchemaFieldCreateHelpText()}`).argument("<schema>", "schema uuid or slug", parseUuidOrSlugSelector8).option("--type <type>", `field type (${formatSchemaFieldTypes()})`).option("--slug <slug>", "field slug").option("--label <label>", "field label").option("--required <bool>", "required flag", parseBooleanFlag).option("--raw <json>", "raw JSON object payload (see type-specific shapes in --help)").option("--raw-file <path>", "path to a raw JSON object payload").action(async function action(schema, commandOptions) {
+  fields.command("create").description(`Create a field in a schema.${buildSchemaFieldCreateHelpText()}`).argument("<schema>", "schema uuid or slug", parseUuidOrSlugSelector8).option("--type <type>", `field type (${formatSchemaFieldTypes()})`).option("--slug <slug>", "field slug").option("--label <label>", "field label").option("--required <bool>", "required flag", parseBooleanFlag).option("--default <value>", "default field value").option("--raw <json>", "raw JSON object payload (see type-specific shapes in --help)").option("--raw-file <path>", "path to a raw JSON object payload").action(async function action(schema, commandOptions) {
     const { api, json, readOnly } = createSchemasApi(this, filePath);
     ensureWritable7("schemas fields create", readOnly, "write");
     const input = buildFieldCreateInput(commandOptions);
@@ -10506,7 +10536,7 @@ function registerSchemasCommands(program, options = {}) {
     }
     writeLine10(stdout, `Created field "${data.slug ?? commandOptions.slug}".`);
   });
-  fields.command("update").description("Update a field in a schema").argument("<schema>", "schema uuid or slug", parseUuidOrSlugSelector8).argument("<field>", "field uuid or slug", parseUuidOrSlugSelector8).option("--label <label>", "field label").option("--required <bool>", "required flag", parseBooleanFlag).option("--raw <json>", "raw JSON object payload").option("--raw-file <path>", "path to a raw JSON object payload").action(async function action(schema, field, commandOptions) {
+  fields.command("update").description("Update a field in a schema").argument("<schema>", "schema uuid or slug", parseUuidOrSlugSelector8).argument("<field>", "field uuid or slug", parseUuidOrSlugSelector8).option("--label <label>", "field label").option("--required <bool>", "required flag", parseBooleanFlag).option("--default <value>", "default field value").option("--raw <json>", "raw JSON object payload").option("--raw-file <path>", "path to a raw JSON object payload").action(async function action(schema, field, commandOptions) {
     const { api, json, readOnly } = createSchemasApi(this, filePath);
     ensureWritable7("schemas fields update", readOnly, "write");
     const resolvedSchema = await resolveSchemaSelector2(api, schema);