zinkee 0.1.34 → 0.1.35

package/README.md

@@ -302,6 +302,11 @@ zinkee --json records get projects <record-uuid>
 # Update
 zinkee records update projects <record-uuid> --set status=2
 
+# Reference fields: pass the target record id (bare UUID or "recordId::label" — the label is
+# ignored) or an exact display value. The server stores the canonical "recordId::displayValue"
+# and rejects unknown references (reason "data_field_reference_not_found").
+zinkee records create deals --set deal-name="Acme renewal" --set customer-ref=<target-record-uuid>
+
 # Delete one or more records (--record is repeatable)
 zinkee records delete projects --record <record-uuid> --record <record-uuid>
 

package/dist/index.js

@@ -2850,7 +2850,7 @@ var specificExamples = {
 }`
     },
     {
-      description: "Create many records from a JSON array file (one object per record, slug -> value). Best-effort: valid records are created and invalid ones are reported per index in 'errors'. ReferenceField values must match the target's current targetDisplayField.",
+      description: "Create many records from a JSON array file (one object per record, slug -> value). Best-effort: valid records are created and invalid ones are reported per index in 'errors'. ReferenceField values accept the target record id (a bare UUID, or the compound 'recordId::anything' whose label is ignored) or an exact display value; the server stores the canonical 'recordId::displayValue'.",
       command: `zinkee --json records create contacts --records-file ./records.json`,
       raw: `{
   "records": [
@@ -2881,6 +2881,29 @@ var specificExamples = {
       "action": "Use a valid field slug from the schema and retry."
     }
   ]
+}`
+    },
+    {
+      description: "Set a ReferenceField by the target record id (a bare UUID, or the compound 'recordId::anything' whose label is ignored) or by an exact display value. The server resolves and stores the canonical 'recordId::displayValue'. Unknown references are rejected per index with reason 'data_field_reference_not_found'.",
+      command: `zinkee --json records create deals --set deal-name="Acme renewal" --set customer-ref=00000000-0000-0000-0000-000000000000`,
+      raw: `{
+  "records": [
+    {
+      "deal-name": "Acme renewal",
+      "customer-ref": "00000000-0000-0000-0000-000000000000"
+    }
+  ]
+}`,
+      response: `{
+  "created": [],
+  "errors": [
+    {
+      "index": 0,
+      "reason": "data_field_reference_not_found",
+      "message": "Referenced record was not found in the target schema.",
+      "action": "Use an existing record id or an existing display value for this reference field."
+    }
+  ]
 }`
     }
   ]),
@@ -2922,6 +2945,22 @@ var specificExamples = {
       command: "zinkee --json records update contacts 550e8400-e29b-41d4-a716-446655440000 --unset contact-email --unset due-date",
       raw: `{
   "unset": ["contact-email", "due-date"]
+}`
+    },
+    {
+      description: "Set a ReferenceField on an existing record. Pass the target record id (a bare UUID, or the compound 'recordId::anything' whose label is ignored) or an exact display value; the response shows the canonical 'recordId::displayValue' the server stored. If the reference doesn't exist the whole update is rejected with reason 'data_field_reference_not_found'.",
+      command: "zinkee --json records update deals 550e8400-e29b-41d4-a716-446655440000 --set customer-ref=8ad602a1-f6e3-43f6-9ab2-f1c5afc99621",
+      raw: `{
+  "set": {
+    "customer-ref": "8ad602a1-f6e3-43f6-9ab2-f1c5afc99621"
+  }
+}`,
+      response: `{
+  "recordId": "550e8400-e29b-41d4-a716-446655440000",
+  "values": {
+    "deal-name": "Acme renewal",
+    "customer-ref": "8ad602a1-f6e3-43f6-9ab2-f1c5afc99621::Acme Corp"
+  }
 }`
     }
   ]),
@@ -11347,7 +11386,12 @@ function registerRecordsCommands(program, options = {}) {
     }
     emitTable4(stdout, data);
   });
-  records.command("create").description("Create one or more records").argument("<schema>", "schema uuid or slug", parseUuidOrSlugSelector8).option("--set <field=value>", "set a string field", collectKeyValueAssignments, []).option("--set-json <field=json>", "set a structured field", collectJsonAssignments, []).option("--raw <json>", "raw JSON object payload").option("--raw-file <path>", "path to a raw JSON object payload").option(
+  records.command("create").description("Create one or more records").argument("<schema>", "schema uuid or slug", parseUuidOrSlugSelector8).option(
+    "--set <field=value>",
+    "set a string field (reference fields: a record id, 'recordId::label', or an exact display value)",
+    collectKeyValueAssignments,
+    []
+  ).option("--set-json <field=json>", "set a structured field", collectJsonAssignments, []).option("--raw <json>", "raw JSON object payload").option("--raw-file <path>", "path to a raw JSON object payload").option(
     "--records-file <path>",
     "path to a JSON array of record objects (mutually exclusive with --set/--set-json/--raw/--raw-file)"
   ).action(async function action(schema, commandOptions) {
@@ -11368,7 +11412,12 @@ function registerRecordsCommands(program, options = {}) {
       }
     }
   });
-  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) {
+  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 (reference fields: a record id, 'recordId::label', or an exact display value)",
+    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);