zinkee 0.1.28 → 0.1.30

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zinkee",
-  "version": "0.1.28",
+  "version": "0.1.30",
   "description": "CLI for Zinkee API v2",
   "type": "module",
   "bin": {

package/src/api/records.ts

@@ -38,7 +38,6 @@ export interface CreateRecordInput {
 }
 
 export interface UpdateRecordInput {
-  [key: string]: unknown;
   set?: Record<string, unknown>;
   unset?: string[];
 }

package/src/api/schemas.ts

@@ -17,6 +17,7 @@ export interface ApiSchema {
   slug?: string;
   auditable?: boolean;
   commentable?: boolean;
+  highlightedField?: string;
   fields?: ApiSchemaField[];
 }
 
@@ -32,6 +33,7 @@ export interface UpdateSchemaInput {
   slug?: string;
   auditable?: boolean;
   commentable?: boolean;
+  highlightedField?: string;
 }
 
 export interface CreateSchemaFieldInput {

package/src/commands/records.test.ts

@@ -412,7 +412,7 @@ describe("records commands", () => {
     });
   });
 
-  it("updates records with the patch-style set and unset contract", async () => {
+  it("wraps raw-file fields into the set payload", async () => {
     const configPath = createApiConfig();
     const output = createStdoutBuffer();
     const fetchMock = createFetchMock();
@@ -423,15 +423,9 @@ describe("records commands", () => {
     writeFileSync(
       rawFile,
       JSON.stringify({
-        set: {
-          status: "inactive",
-          metadata: {
-            imported: true,
-          },
-        },
-        unset: ["legacyCode"],
-        audit: {
-          reason: "sync",
+        status: "inactive",
+        metadata: {
+          imported: true,
         },
       }),
       "utf8",
@@ -472,9 +466,6 @@ describe("records commands", () => {
     );
     expect(init?.method).toBe("PATCH");
     expect(JSON.parse(String(init?.body))).toEqual({
-      audit: {
-        reason: "sync",
-      },
       set: {
         status: "active",
         metadata: {
@@ -484,7 +475,81 @@ describe("records commands", () => {
           tier: "gold",
         },
       },
-      unset: ["legacyCode", "tempField"],
+      unset: ["tempField"],
+    });
+  });
+
+  it("wraps bare raw fields into the set payload", async () => {
+    const configPath = createApiConfig();
+    const output = createStdoutBuffer();
+    const fetchMock = createFetchMock();
+    mockSchemaLookup(fetchMock);
+    fetchMock.mockResolvedValueOnce(
+      jsonResponse({
+        id: "550e8400-e29b-41d4-a716-446655440001",
+        uno: "prueba mod",
+      }),
+    );
+    const program = buildProgram({ configPath, stdout: output.stdout });
+
+    await program.parseAsync([
+      "node",
+      "zinkee",
+      "--json",
+      "records",
+      "update",
+      "contacts",
+      "550E8400-E29B-41D4-A716-446655440001",
+      "--raw",
+      '{"uno":"prueba mod"}',
+    ]);
+
+    const init = fetchMock.mock.calls[1]?.[1];
+
+    expect(fetchMock.mock.calls[1]?.[0]).toBe(
+      "https://api.zinkee.test/api/v2/schemas/schema-1/records/550e8400-e29b-41d4-a716-446655440001",
+    );
+    expect(init?.method).toBe("PATCH");
+    expect(JSON.parse(String(init?.body))).toEqual({
+      set: {
+        uno: "prueba mod",
+      },
+    });
+  });
+
+  it("lets --set override raw fields with the same key", async () => {
+    const configPath = createApiConfig();
+    const output = createStdoutBuffer();
+    const fetchMock = createFetchMock();
+    mockSchemaLookup(fetchMock);
+    fetchMock.mockResolvedValueOnce(
+      jsonResponse({
+        id: "550e8400-e29b-41d4-a716-446655440001",
+      }),
+    );
+    const program = buildProgram({ configPath, stdout: output.stdout });
+
+    await program.parseAsync([
+      "node",
+      "zinkee",
+      "--json",
+      "records",
+      "update",
+      "contacts",
+      "550E8400-E29B-41D4-A716-446655440001",
+      "--raw",
+      '{"uno":"raw value"}',
+      "--set",
+      "uno=set value",
+    ]);
+
+    const init = fetchMock.mock.calls[1]?.[1];
+
+    expect(init?.method).toBe("PATCH");
+    expect(JSON.parse(String(init?.body))).toEqual({
+      set: {
+        uno: "set value",
+      },
     });
   });
 

package/src/commands/records.ts

@@ -421,50 +421,16 @@ function buildRecordCreateInput(
   return { values };
 }
 
-function readRawSetPayload(raw: JsonObject): Record<string, unknown> {
-  const setValue = raw.set;
-
-  if (setValue === undefined) {
-    return {};
-  }
-
-  if (!isJsonObject(setValue)) {
-    throw new CliError(
-      "invalid_cli_usage",
-      'Expected raw update payload field "set" to be a JSON object.',
-    );
-  }
-
-  return { ...setValue };
-}
-
-function readRawUnsetPayload(raw: JsonObject): string[] {
-  const unsetValue = raw.unset;
-
-  if (unsetValue === undefined) {
-    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: RecordsUpdateCommandOptions,
 ): UpdateRecordInput {
   const raw = readRawObject(options.raw, options.rawFile);
-  const input: UpdateRecordInput = { ...raw };
+  const input: UpdateRecordInput = {};
   const setPayload = {
-    ...readRawSetPayload(raw),
+    ...raw,
     ...buildAssignmentObject(options.set, options.setJson),
   };
-  const unsetPayload = [...readRawUnsetPayload(raw), ...(options.unset ?? [])];
+  const unsetPayload = [...(options.unset ?? [])];
 
   for (const key of Object.keys(setPayload)) {
     const unsetIndex = unsetPayload.indexOf(key);
@@ -684,8 +650,8 @@ export function registerRecordsCommands(
     .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")
+    .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(
       this: Command,
       schema: NormalizedUuidOrSlug,

package/src/commands/schemas.test.ts

@@ -968,4 +968,84 @@ describe("schemas commands", () => {
       },
     });
   });
+
+  it("updates a schema highlighted field by slug after resolving the field id", async () => {
+    const configPath = createApiConfig();
+    const output = createStdoutBuffer();
+    const fetchMock = createFetchMock();
+    mockSchemaLookup(fetchMock);
+    fetchMock.mockResolvedValueOnce(
+      jsonResponse({
+        id: "schema-1",
+        slug: "contacts",
+        fields: [
+          {
+            id: "550e8400-e29b-41d4-a716-446655440001",
+            slug: "email",
+            type: "TextField",
+            label: "Email",
+          },
+        ],
+      }),
+    );
+    fetchMock.mockResolvedValueOnce(
+      jsonResponse({
+        id: "schema-1",
+        slug: "contacts",
+        highlightedField: "550e8400-e29b-41d4-a716-446655440001",
+      }),
+    );
+    const program = buildProgram({ configPath, stdout: output.stdout });
+
+    await program.parseAsync([
+      "node",
+      "zinkee",
+      "--json",
+      "schemas",
+      "update",
+      "contacts",
+      "--highlighted-field",
+      "email",
+    ]);
+
+    expect(fetchMock.mock.calls[2]?.[0]).toBe("https://api.zinkee.test/api/v2/schemas/schema-1");
+    expect(fetchMock.mock.calls[2]?.[1]?.method).toBe("PATCH");
+    expect(JSON.parse(String(fetchMock.mock.calls[2]?.[1]?.body))).toEqual({
+      highlightedField: "550e8400-e29b-41d4-a716-446655440001",
+    });
+  });
+
+  it("updates a schema highlighted field by uuid without extra lookups", async () => {
+    const configPath = createApiConfig();
+    const output = createStdoutBuffer();
+    const fetchMock = createFetchMock();
+    fetchMock.mockResolvedValueOnce(
+      jsonResponse({
+        id: "550e8400-e29b-41d4-a716-446655440000",
+        slug: "contacts",
+        highlightedField: "550e8400-e29b-41d4-a716-446655440001",
+      }),
+    );
+    const program = buildProgram({ configPath, stdout: output.stdout });
+
+    await program.parseAsync([
+      "node",
+      "zinkee",
+      "--json",
+      "schemas",
+      "update",
+      "550e8400-e29b-41d4-a716-446655440000",
+      "--highlighted-field",
+      "550e8400-e29b-41d4-a716-446655440001",
+    ]);
+
+    expect(fetchMock).toHaveBeenCalledTimes(1);
+    expect(fetchMock.mock.calls[0]?.[0]).toBe(
+      "https://api.zinkee.test/api/v2/schemas/550e8400-e29b-41d4-a716-446655440000",
+    );
+    expect(fetchMock.mock.calls[0]?.[1]?.method).toBe("PATCH");
+    expect(JSON.parse(String(fetchMock.mock.calls[0]?.[1]?.body))).toEqual({
+      highlightedField: "550e8400-e29b-41d4-a716-446655440001",
+    });
+  });
 });

package/src/commands/schemas.ts

@@ -56,6 +56,7 @@ interface SchemaUpdateCommandOptions {
   slug?: string;
   auditable?: boolean;
   commentable?: boolean;
+  highlightedField?: NormalizedUuidOrSlug;
 }
 
 interface FieldCreateCommandOptions {
@@ -568,6 +569,11 @@ export function registerSchemasCommands(
     .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",
+      parseUuidOrSlugSelector,
+    )
     .action(async function action(
       this: Command,
       schema: NormalizedUuidOrSlug,
@@ -579,10 +585,19 @@ export function registerSchemasCommands(
 
       const input = buildSchemaUpdateInput(commandOptions);
 
+      if (commandOptions.highlightedField !== undefined) {
+        const resolvedField = await resolveFieldSelector(
+          api,
+          resolvedSchema,
+          commandOptions.highlightedField,
+        );
+        input.highlightedField = resolvedField.value;
+      }
+
       if (isEmptyObject(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".',
         );
       }
 

package/src/utils/examples.ts

@@ -228,6 +228,7 @@ const specificExamples: Record<string, readonly CommandExample[]> = {
   },
   "auditable": true,
   "commentable": true,
+  "highlightedField": "c60b8526-5835-4c9f-aecd-9a16c7704a34",
   "fields": [
     {
       "id": "c60b8526-5835-4c9f-aecd-9a16c7704a34",
@@ -259,6 +260,14 @@ const specificExamples: Record<string, readonly CommandExample[]> = {
       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"
 }`,
     },
   ]),
@@ -1904,6 +1913,7 @@ const specificExamples: Record<string, readonly CommandExample[]> = {
   },
   "auditable": true,
   "commentable": true,
+  "highlightedField": "c60b8526-5835-4c9f-aecd-9a16c7704a34",
   "fields": [
     {
       "id": "c60b8526-5835-4c9f-aecd-9a16c7704a34",