zinkee 0.1.28 → 0.1.30

package/.claude/settings.local.json

@@ -52,7 +52,19 @@
       "Bash(zinkee --json profiles list)",
       "Bash(zinkee displays *)",
       "Bash(chmod +x /tmp/audit_search.sh)",
-      "Bash(/tmp/audit_search.sh)"
+      "Bash(/tmp/audit_search.sh)",
+      "Bash(head -60 CLAUDE.md)",
+      "Bash(head -40 AGENTS.md)",
+      "Bash(xargs cat)",
+      "Bash(./gradlew :api:test --tests \"com.zinkee.api.service.v2.data.DataV2TranslatorTest\" --tests \"com.zinkee.api.service.v2.data.DataV2ServiceTest\" --tests \"com.zinkee.api.domain.model.v2.data.DataV2PatchRecordRequestTest\")",
+      "Bash(./gradlew :api:test --tests \"com.zinkee.api.service.v2.data.DataV2ServiceTest\" --tests \"com.zinkee.api.domain.model.v2.data.DataV2PatchRecordRequestTest\")",
+      "Bash(./gradlew :api:spotlessApply)",
+      "Bash(./gradlew :api:test :api:spotbugsMain spotlessCheck)",
+      "Bash(./gradlew :api:spotbugsMain)",
+      "Bash(./gradlew spotlessCheck)",
+      "Bash(git --no-pager diff --stat)",
+      "Bash(git --no-pager diff -- src/commands/records.ts src/api/records.ts)",
+      "Bash(echo \"===EXIT: $?===\")"
     ]
   }
 }

package/AGENTS.md

@@ -48,6 +48,19 @@ Use this order when reasoning about behavior:
 - parsers live in `src/parsers`
 - shell completion (engine, scripts, install, runtime) lives in `src/completion`
 
+## API Examples (`--example`)
+
+- `--example` output comes 100% from hand-written `src/utils/examples.ts`
+  (`specificExamples`, keyed by command path e.g. `"schemas update"`). No
+  codegen, no OpenAPI import.
+- These MIRROR the swagger `@ExampleObject`s in the `z2-backend` repo
+  (`api/src/main/java/com/zinkee/api/infra/web/v2/ApiV2<Resource>Documentation.java`).
+  When you add/change an example on either side, update the other with the same
+  payload (request `raw` and `response`). Nothing keeps them in sync
+  automatically.
+- Keep `response` shapes aligned with the backend DTO field order (e.g.
+  `SchemaV2ResourceResponse`: `… commentable, highlightedField, fields`).
+
 ## Testing
 
 Prefer focused command tests and parser/client unit tests.

package/dist/index.js

@@ -2402,6 +2402,7 @@ var specificExamples = {
   },
   "auditable": true,
   "commentable": true,
+  "highlightedField": "c60b8526-5835-4c9f-aecd-9a16c7704a34",
   "fields": [
     {
       "id": "c60b8526-5835-4c9f-aecd-9a16c7704a34",
@@ -2432,6 +2433,13 @@ var specificExamples = {
       command: "zinkee --json schemas update contacts --auditable true",
       raw: `{
   "auditable": true
+}`
+    },
+    {
+      description: "Set the highlighted (main) field of a schema.",
+      command: "zinkee --json schemas update contacts --highlighted-field contact-name",
+      raw: `{
+  "highlightedField": "c60b8526-5835-4c9f-aecd-9a16c7704a34"
 }`
     }
   ]),
@@ -3973,6 +3981,7 @@ var specificExamples = {
   },
   "auditable": true,
   "commentable": true,
+  "highlightedField": "c60b8526-5835-4c9f-aecd-9a16c7704a34",
   "fields": [
     {
       "id": "c60b8526-5835-4c9f-aecd-9a16c7704a34",
@@ -10984,40 +10993,14 @@ function buildRecordCreateInput(options) {
   }
   return { values };
 }
-function readRawSetPayload2(raw) {
-  const setValue = raw.set;
-  if (setValue === void 0) {
-    return {};
-  }
-  if (!isJsonObject6(setValue)) {
-    throw new CliError(
-      "invalid_cli_usage",
-      'Expected raw update payload field "set" to be a JSON object.'
-    );
-  }
-  return { ...setValue };
-}
-function readRawUnsetPayload2(raw) {
-  const unsetValue = raw.unset;
-  if (unsetValue === void 0) {
-    return [];
-  }
-  if (!Array.isArray(unsetValue) || !unsetValue.every((value) => typeof value === "string")) {
-    throw new CliError(
-      "invalid_cli_usage",
-      'Expected raw update payload field "unset" to be an array of strings.'
-    );
-  }
-  return [...unsetValue];
-}
 function buildRecordUpdateInput(options) {
   const raw = readRawObject3(options.raw, options.rawFile);
-  const input = { ...raw };
+  const input = {};
   const setPayload = {
-    ...readRawSetPayload2(raw),
+    ...raw,
     ...buildAssignmentObject(options.set, options.setJson)
   };
-  const unsetPayload = [...readRawUnsetPayload2(raw), ...options.unset ?? []];
+  const unsetPayload = [...options.unset ?? []];
   for (const key of Object.keys(setPayload)) {
     const unsetIndex = unsetPayload.indexOf(key);
     if (unsetIndex !== -1) {
@@ -11145,7 +11128,7 @@ function registerRecordsCommands(program, options = {}) {
     }
     writeLine10(stdout, `Created record "${getRecordIdentifier(data)}".`);
   });
-  records.command("update").description("Update a record").argument("<schema>", "schema uuid or slug", parseUuidOrSlugSelector8).argument("<record>", "record uuid or slug", parseUuidOrSlugSelector8).option("--set <field=value>", "set a string field", collectKeyValueAssignments, []).option("--set-json <field=json>", "set a structured field", collectJsonAssignments, []).option("--unset <field>", "unset a field", collectStringValues, []).option("--raw <json>", "raw JSON object payload").option("--raw-file <path>", "path to a raw JSON object payload").action(async function action(schema, record, commandOptions) {
+  records.command("update").description("Update a record").argument("<schema>", "schema uuid or slug", parseUuidOrSlugSelector8).argument("<record>", "record uuid or slug", parseUuidOrSlugSelector8).option("--set <field=value>", "set a string field", collectKeyValueAssignments, []).option("--set-json <field=json>", "set a structured field", collectJsonAssignments, []).option("--unset <field>", "unset a field", collectStringValues, []).option("--raw <json>", "raw JSON object of fields to set").option("--raw-file <path>", "path to a JSON object of fields to set").action(async function action(schema, record, commandOptions) {
     const { api, schemasApi, json, readOnly } = createRecordsApi(this, filePath);
     ensureWritable7("records update", readOnly, "write");
     const resolvedSchema = await resolveSchemaSelector(schemasApi, schema);
@@ -11524,15 +11507,27 @@ function registerSchemasCommands(program, options = {}) {
     }
     writeLine11(stdout, `Created schema "${data.slug ?? commandOptions.slug}".`);
   });
-  schemas.command("update").description("Update a schema").argument("<schema>", "schema uuid or slug", parseUuidOrSlugSelector9).option("--name <name>", "schema name").option("--slug <slug>", "schema slug").option("--auditable <bool>", "auditable flag", parseBooleanFlag).option("--commentable <bool>", "commentable flag", parseBooleanFlag).action(async function action(schema, commandOptions) {
+  schemas.command("update").description("Update a schema").argument("<schema>", "schema uuid or slug", parseUuidOrSlugSelector9).option("--name <name>", "schema name").option("--slug <slug>", "schema slug").option("--auditable <bool>", "auditable flag", parseBooleanFlag).option("--commentable <bool>", "commentable flag", parseBooleanFlag).option(
+    "--highlighted-field <field>",
+    "highlighted (main) field uuid or slug",
+    parseUuidOrSlugSelector9
+  ).action(async function action(schema, commandOptions) {
     const { api, json, readOnly } = createSchemasApi(this, filePath);
     ensureWritable8("schemas update", readOnly, "write");
     const resolvedSchema = await resolveSchemaSelector2(api, schema);
     const input = buildSchemaUpdateInput(commandOptions);
+    if (commandOptions.highlightedField !== void 0) {
+      const resolvedField = await resolveFieldSelector(
+        api,
+        resolvedSchema,
+        commandOptions.highlightedField
+      );
+      input.highlightedField = resolvedField.value;
+    }
     if (isEmptyObject6(input)) {
       throw new CliError(
         "invalid_cli_usage",
-        'Provide at least one schema field to update via "--name", "--slug", "--auditable", or "--commentable".'
+        'Provide at least one schema field to update via "--name", "--slug", "--auditable", "--commentable", or "--highlighted-field".'
       );
     }
     const data = await api.updateSchema(resolvedSchema, input);