zinkee 0.1.7 → 0.1.9

package/package.json

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

package/src/commands/schemas.test.ts

@@ -269,6 +269,95 @@ describe("schemas commands", () => {
     });
   });
 
+  it("creates fields with a default value flag", async () => {
+    const configPath = createApiConfig();
+    const output = createStdoutBuffer();
+    const fetchMock = createFetchMock();
+    mockSchemaLookup(fetchMock);
+    fetchMock.mockResolvedValueOnce(
+      jsonResponse({
+        id: "field-budget",
+        type: "NumberField",
+        slug: "budget",
+        label: "Budget",
+        required: true,
+      }),
+    );
+    const program = buildProgram({ configPath, stdout: output.stdout });
+
+    await program.parseAsync([
+      "node",
+      "zinkee",
+      "--json",
+      "schemas",
+      "fields",
+      "create",
+      "contacts",
+      "--type",
+      "number",
+      "--slug",
+      "budget",
+      "--label",
+      "Budget",
+      "--required",
+      "true",
+      "--default",
+      "0",
+    ]);
+
+    expect(JSON.parse(String(fetchMock.mock.calls[1]?.[1]?.body))).toEqual({
+      type: "NumberField",
+      slug: "budget",
+      label: "Budget",
+      required: true,
+      config: {
+        defaultValue: "0",
+      },
+    });
+  });
+
+  it("lets the default value flag override raw config defaults", async () => {
+    const configPath = createApiConfig();
+    const output = createStdoutBuffer();
+    const fetchMock = createFetchMock();
+    mockSchemaLookup(fetchMock);
+    fetchMock.mockResolvedValueOnce(
+      jsonResponse({
+        id: "field-budget",
+        type: "NumberField",
+        slug: "budget",
+        label: "Budget",
+      }),
+    );
+    const program = buildProgram({ configPath, stdout: output.stdout });
+
+    await program.parseAsync([
+      "node",
+      "zinkee",
+      "--json",
+      "schemas",
+      "fields",
+      "create",
+      "contacts",
+      "--raw",
+      '{"type":"number","slug":"budget","label":"Budget","config":{"defaultValue":"10","formatOptions":{"format":"number"}}}',
+      "--default",
+      "0",
+    ]);
+
+    expect(JSON.parse(String(fetchMock.mock.calls[1]?.[1]?.body))).toEqual({
+      type: "NumberField",
+      slug: "budget",
+      label: "Budget",
+      config: {
+        defaultValue: "0",
+        formatOptions: {
+          format: "number",
+        },
+      },
+    });
+  });
+
   it("updates fields from a raw file and normalizes field UUID selectors", async () => {
     const configPath = createApiConfig();
     const output = createStdoutBuffer();
@@ -342,6 +431,52 @@ describe("schemas commands", () => {
     });
   });
 
+  it("updates fields with a default value flag", async () => {
+    const configPath = createApiConfig();
+    const output = createStdoutBuffer();
+    const fetchMock = createFetchMock();
+    mockSchemaLookup(fetchMock);
+    fetchMock.mockResolvedValueOnce(
+      jsonResponse({
+        id: "field-budget",
+        type: "NumberField",
+        slug: "budget",
+        label: "Budget",
+        required: false,
+      }),
+    );
+    fetchMock.mockResolvedValueOnce(
+      jsonResponse({
+        id: "field-budget",
+        type: "NumberField",
+        slug: "budget",
+        label: "Budget",
+        required: false,
+      }),
+    );
+    const program = buildProgram({ configPath, stdout: output.stdout });
+
+    await program.parseAsync([
+      "node",
+      "zinkee",
+      "--json",
+      "schemas",
+      "fields",
+      "update",
+      "contacts",
+      "550E8400-E29B-41D4-A716-446655440002",
+      "--default",
+      "0",
+    ]);
+
+    expect(JSON.parse(String(fetchMock.mock.calls[2]?.[1]?.body))).toEqual({
+      type: "NumberField",
+      config: {
+        defaultValue: "0",
+      },
+    });
+  });
+
   it("strips formula status from update payloads", async () => {
     const configPath = createApiConfig();
     const output = createStdoutBuffer();
@@ -590,6 +725,94 @@ describe("schemas commands", () => {
     });
   });
 
+  it("normalizes schedule field shorthand payloads into the backend shape", async () => {
+    const configPath = createApiConfig();
+    const output = createStdoutBuffer();
+    const fetchMock = createFetchMock();
+    mockSchemaLookup(fetchMock);
+    fetchMock.mockResolvedValueOnce(
+      jsonResponse({
+        id: "field-5",
+        type: "ScheduleField",
+        slug: "monthly-recurrence",
+        label: "Monthly Recurrence",
+      }),
+    );
+    const program = buildProgram({ configPath, stdout: output.stdout });
+
+    await program.parseAsync([
+      "node",
+      "zinkee",
+      "--json",
+      "schemas",
+      "fields",
+      "create",
+      "contacts",
+      "--raw",
+      '{"type":"schedule","slug":"monthly-recurrence","label":"Monthly Recurrence","referenceField":"c52efe3f-2825-4c60-a7e3-34dd4c1ce043","beginningPeriodField":"d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90","endingPeriodField":"d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90","frequency":"monthly"}',
+    ]);
+
+    expect(JSON.parse(String(fetchMock.mock.calls[1]?.[1]?.body))).toEqual({
+      type: "ScheduleField",
+      slug: "monthly-recurrence",
+      label: "Monthly Recurrence",
+      config: {
+        referenceField: "c52efe3f-2825-4c60-a7e3-34dd4c1ce043",
+        beginningPeriodField: "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
+        endingPeriodField: "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
+        frequency: "monthly",
+      },
+    });
+  });
+
+  it("rejects schedule fields with invalid frequency before hitting the backend", async () => {
+    const configPath = createApiConfig();
+    const output = createStdoutBuffer();
+    const fetchMock = createFetchMock();
+    const program = buildProgram({ configPath, stdout: output.stdout });
+
+    await expect(
+      program.parseAsync([
+        "node",
+        "zinkee",
+        "schemas",
+        "fields",
+        "create",
+        "contacts",
+        "--raw",
+        '{"type":"ScheduleField","slug":"weekly","label":"Weekly","config":{"referenceField":"c52efe3f-2825-4c60-a7e3-34dd4c1ce043","beginningPeriodField":"d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90","endingPeriodField":"d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90","frequency":"weekly"}}',
+      ]),
+    ).rejects.toThrowError(
+      'Schedule "frequency" must be "monthly" or "daily" (received "weekly").',
+    );
+
+    expect(fetchMock).not.toHaveBeenCalled();
+  });
+
+  it("rejects schedule fields missing required config fields", async () => {
+    const configPath = createApiConfig();
+    const output = createStdoutBuffer();
+    const fetchMock = createFetchMock();
+    const program = buildProgram({ configPath, stdout: output.stdout });
+
+    await expect(
+      program.parseAsync([
+        "node",
+        "zinkee",
+        "schemas",
+        "fields",
+        "create",
+        "contacts",
+        "--raw",
+        '{"type":"ScheduleField","slug":"recurrence","label":"Recurrence","config":{"frequency":"daily"}}',
+      ]),
+    ).rejects.toThrowError(
+      /Schedule fields require "referenceField", "beginningPeriodField", "endingPeriodField" and "frequency"/,
+    );
+
+    expect(fetchMock).not.toHaveBeenCalled();
+  });
+
   it("rejects unsupported field types before making network requests", async () => {
     const configPath = createApiConfig();
     const output = createStdoutBuffer();
@@ -612,7 +835,7 @@ describe("schemas commands", () => {
         "Bad",
       ]),
     ).rejects.toThrowError(
-      'Unsupported field type "InvalidField". Valid types: text, number, date, option, file, reference, formula, member, autoincremental.',
+      'Unsupported field type "InvalidField". Valid types: text, number, date, option, file, reference, formula, member, autoincremental, schedule.',
     );
 
     expect(fetchMock).not.toHaveBeenCalled();
@@ -626,16 +849,16 @@ describe("schemas commands", () => {
     const help = create?.helpInformation() ?? "";
 
     expect(help).toContain("--type <type>");
+    expect(help).toContain("--default <value>");
     expect(help).toContain("member");
     expect(help).toContain("autoincremental");
     expect(help).toContain("Raw payload shapes by type:");
-    expect(help).toContain('"type":"number","slug":"price-eur"');
+    expect(help).toContain('"type":"NumberField","slug":"quantity"');
     expect(help).toContain('"defaultValue":"0"');
-    expect(help).toContain('"symbolEnabled":true');
     expect(help).toContain('- member: Workspace member field.');
-    expect(help).toContain('"type":"member","slug":"owner","label":"Owner"');
+    expect(help).toContain('"type":"MemberField","slug":"owner","label":"Owner"');
     expect(help).toContain('- option: Dropdown/select field with options.');
-    expect(help).toContain('"type":"option","slug":"status","label":"Status"');
+    expect(help).toContain('"type":"OptionField","slug":"status","label":"Status"');
     expect(help).toContain('Use "zinkee --example schemas fields create --type <type>"');
   });
 
@@ -692,7 +915,7 @@ describe("schemas commands", () => {
         '{"type":"option","slug":"status","label":"Status","options":[{"id":1,"name":"Open","color":"default"}]}',
       ]),
     ).rejects.toThrowError(
-      'Invalid payload for field type "option". Expected raw shape: {"type":"option","slug":"status","label":"Status","config":{"options":[{"id":1,"name":"Open","color":"default"},{"id":2,"name":"Closed","color":"success"}]}}',
+      'Invalid payload for field type "option". Expected raw shape: {"type":"OptionField","slug":"status","label":"Status","config":{"options":[{"id":1,"name":"Open","color":"default"},{"id":2,"name":"Closed","color":"success"}]}}',
     );
   });
 

package/src/commands/schemas.ts

@@ -63,6 +63,7 @@ interface FieldCreateCommandOptions {
   slug?: string;
   label?: string;
   required?: boolean;
+  default?: string;
   raw?: string;
   rawFile?: string;
 }
@@ -70,6 +71,7 @@ interface FieldCreateCommandOptions {
 interface FieldUpdateCommandOptions {
   label?: string;
   required?: boolean;
+  default?: string;
   raw?: string;
   rawFile?: string;
 }
@@ -301,6 +303,29 @@ function buildSchemaUpdateInput(options: SchemaUpdateCommandOptions): UpdateSche
   return input;
 }
 
+function applyFieldDefaultValue(
+  input: CreateSchemaFieldInput | UpdateSchemaFieldInput,
+  defaultValue: string | undefined,
+): void {
+  if (defaultValue === undefined) {
+    return;
+  }
+
+  const config = input.config;
+
+  if (config !== undefined && !isJsonObject(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: FieldCreateCommandOptions,
 ): CreateSchemaFieldInput {
@@ -337,6 +362,8 @@ function buildFieldCreateInput(
     input.required = options.required;
   }
 
+  applyFieldDefaultValue(input, options.default);
+
   if ("config" in input && isJsonObject(input.config) && isEmptyObject(input.config)) {
     delete input.config;
   }
@@ -411,6 +438,8 @@ function buildFieldUpdateInput(
     input.required = options.required;
   }
 
+  applyFieldDefaultValue(input, options.default);
+
   return input;
 }
 
@@ -640,6 +669,7 @@ export function registerSchemasCommands(
     .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(
@@ -673,6 +703,7 @@ export function registerSchemasCommands(
     .argument("<field>", "field uuid or slug", parseUuidOrSlugSelector)
     .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(

package/src/index.test.ts

@@ -85,12 +85,12 @@ describe("project bootstrap", () => {
     );
 
     expect(output).toContain('zinkee --json schemas fields create contacts --raw');
-    expect(output).toContain('"type":"option"');
-    expect(output).not.toContain('"type":"text"');
-    expect(output).toContain("Create a option field");
+    expect(output).toContain('"type":"OptionField"');
+    expect(output).not.toContain('"type":"TextField"');
+    expect(output).toContain("Option field (select dropdown)");
   });
 
-  it("shows both number creation examples, including Moneda formatting", async () => {
+  it("shows every backend number variant, including currency formatting", async () => {
     let output = "";
 
     await showExamples(
@@ -105,9 +105,15 @@ describe("project bootstrap", () => {
       { type: "number" },
     );
 
-    expect(output).toContain('"slug":"amount"');
+    expect(output).toContain('"slug":"quantity"');
+    expect(output).toContain('"slug":"amount-eur"');
+    expect(output).toContain('"slug":"amount-usd"');
+    expect(output).toContain('"defaultValue":"0"');
     expect(output).toContain('"symbolEnabled":true');
+    expect(output).toContain('"symbolPosition":"before"');
     expect(output).toContain('"symbolPosition":"right"');
+    expect(output).toContain('"format":"percentage"');
+    expect(output).toContain('"durationFormat":"HH:MM"');
   });
 
   it("shows automation examples with descriptions and equivalent payloads", async () => {

package/src/utils/examples.test.ts

@@ -21,18 +21,54 @@ describe("getCommandExamples", () => {
     const examples = getCommandExamples("schemas fields create", { type: "member" });
 
     expect(examples).toHaveLength(1);
-    expect(examples[0]?.command).toContain('"type":"member"');
-    expect(examples[0]?.description).toContain("member field");
+    expect(examples[0]?.command).toContain('"type":"MemberField"');
+    expect(examples[0]?.description).toBe("Member field");
   });
 
-  it("returns both plain and currency-style examples for number fields", () => {
-    const examples = getCommandExamples("schemas fields create", { type: "number" });
+  it("returns monthly and daily variants for schedule fields", () => {
+    const examples = getCommandExamples("schemas fields create", { type: "schedule" });
 
     expect(examples).toHaveLength(2);
-    expect(examples[0]?.command).toContain('"slug":"amount"');
-    expect(examples[1]?.command).toContain('"symbolEnabled":true');
-    expect(examples[1]?.command).toContain('"symbolValue":" €"');
-    expect(examples[1]?.description).toContain("Moneda");
+    expect(examples.map((example) => example.description)).toEqual([
+      "Schedule field (monthly)",
+      "Schedule field (daily)",
+    ]);
+    expect(examples[0]?.command).toContain('"type":"ScheduleField"');
+    expect(examples[0]?.command).toContain('"frequency":"monthly"');
+    expect(examples[1]?.command).toContain('"frequency":"daily"');
+  });
+
+  it("covers every backend number field variant", () => {
+    const examples = getCommandExamples("schemas fields create", { type: "number" });
+
+    expect(examples).toHaveLength(6);
+
+    const descriptions = examples.map((example) => example.description);
+    expect(descriptions).toEqual([
+      "Number field (plain integer)",
+      "Number field (decimal with thousands)",
+      "Number field (currency € prefix)",
+      "Number field (currency $ suffix)",
+      "Number field (percentage)",
+      "Number field (duration HH:MM)",
+    ]);
+
+    expect(examples[0]?.command).toContain('"slug":"quantity"');
+    expect(examples[0]?.command).toContain('"format":"number"');
+
+    const eurCurrency = examples[2]?.command ?? "";
+    expect(eurCurrency).toContain('"format":"currency"');
+    expect(eurCurrency).toContain('"symbolEnabled":true');
+    expect(eurCurrency).toContain('"symbolPosition":"before"');
+    expect(eurCurrency).toContain('"symbolValue":"€"');
+
+    const usdCurrency = examples[3]?.command ?? "";
+    expect(usdCurrency).toContain('"symbolPosition":"right"');
+    expect(usdCurrency).toContain('"symbolValue":" $"');
+
+    expect(examples[4]?.command).toContain('"format":"percentage"');
+    expect(examples[5]?.command).toContain('"format":"duration"');
+    expect(examples[5]?.command).toContain('"durationFormat":"HH:MM"');
   });
 
   it("returns canonical automation creation examples", () => {