zinkee 0.1.12 → 0.1.17

package/package.json

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

package/src/api/records.ts

@@ -133,6 +133,13 @@ export class RecordsApi {
     );
   }
 
+  clearRecords(schema: NormalizedUuidOrSlug): Promise<Record<string, unknown>> {
+    return this.client.requestJson<Record<string, unknown>>(
+      `/api/v2/schemas/${selectorValue(schema)}/records:clear`,
+      { method: "DELETE" },
+    );
+  }
+
   private normalizeQueryInput(query: RecordQueryInput): Record<string, unknown> {
     const where = query.where?.map((expression) => ({
       field: expression.field,

package/src/cli-examples.ts

@@ -18,11 +18,6 @@ export interface ExampleRequest {
   filters: {
     type?: string;
   };
-  overrides: {
-    profile?: string;
-    baseUrl?: string;
-    apiKey?: string;
-  };
   json: boolean;
 }
 
@@ -48,46 +43,6 @@ function extractExampleFilters(tokens: readonly string[]): { type?: string } {
   return filters;
 }
 
-function extractExampleOverrides(tokens: readonly string[]): {
-  profile?: string;
-  baseUrl?: string;
-  apiKey?: string;
-} {
-  const overrides: {
-    profile?: string;
-    baseUrl?: string;
-    apiKey?: string;
-  } = {};
-
-  for (let index = 0; index < tokens.length; index += 1) {
-    const token = tokens[index];
-    const value = tokens[index + 1];
-
-    if (!value || value.startsWith("-")) {
-      continue;
-    }
-
-    if (token === "--profile") {
-      overrides.profile = value;
-      index += 1;
-      continue;
-    }
-
-    if (token === "--base-url") {
-      overrides.baseUrl = value;
-      index += 1;
-      continue;
-    }
-
-    if (token === "--api-key") {
-      overrides.apiKey = value;
-      index += 1;
-    }
-  }
-
-  return overrides;
-}
-
 export function extractExampleRequest(
   argv: readonly string[],
   optionMeta: OptionMetadata = createDefaultOptionMetadata(),
@@ -109,27 +64,17 @@ export function extractExampleRequest(
   return {
     commandName: cmdPath.commandName,
     filters: extractExampleFilters(remainingTokens),
-    overrides: extractExampleOverrides(argv),
     json: argv.includes("--json"),
   };
 }
 
-export async function showExamples(
+export function showExamples(
   commandName: string,
   json: boolean,
   stdout?: CommandIo,
   filters: { type?: string } = {},
-  options: {
-    enabled?: boolean;
-    configPath?: string;
-    overrides?: {
-      profile?: string;
-      baseUrl?: string;
-      apiKey?: string;
-    };
-  } = {},
-): Promise<void> {
-  const examples = await getResolvedCommandExamples(commandName, filters, options);
+): void {
+  const examples = getResolvedCommandExamples(commandName, filters);
 
   if (examples.length === 0) {
     throw new CliError("invalid_cli_usage", `No examples registered for "${commandName}".`);

package/src/cli-runner.ts

@@ -65,15 +65,11 @@ export async function runCli(argv: string[]): Promise<void> {
     const exampleRequest = extractExampleRequest(argv, optionMeta);
 
     if (exampleRequest) {
-      await showExamples(
+      showExamples(
         exampleRequest.commandName,
         exampleRequest.json,
         undefined,
         exampleRequest.filters,
-        {
-          enabled: true,
-          overrides: exampleRequest.overrides,
-        },
       );
       throw new ExampleDisplayed();
     }

package/src/command-registry.ts

@@ -665,6 +665,13 @@ export const commandRegistry = {
     supportsRaw: false,
     output: writeOutput,
   },
+  "records clear": {
+    command: "records clear",
+    accessLevel: "destructive",
+    supportsExample: true,
+    supportsRaw: false,
+    output: writeOutput,
+  },
   "comments list": {
     command: "comments list",
     accessLevel: "read",

package/src/commands/automations.test.ts

@@ -335,7 +335,7 @@ describe("automations commands", () => {
       "--target-schema",
       "schema-1",
       "--map-json",
-      'owner={"rawValue":null,"source":{"type":"TRIGGER","id":"payload_value"}}',
+      'owner={"rawValue":null,"source":{"type":"TRIGGER","id":"f1e1d000-0000-0000-0000-000000000005"}}',
     ]);
 
     expect(JSON.parse(String(fetchMock.mock.calls[0]?.[1]?.body))).toEqual({
@@ -348,7 +348,7 @@ describe("automations commands", () => {
             rawValue: null,
             source: {
               type: "TRIGGER",
-              id: "payload_value",
+              id: "f1e1d000-0000-0000-0000-000000000005",
             },
           },
         },
@@ -378,7 +378,7 @@ describe("automations commands", () => {
       "--target-schema",
       "schema-1",
       "--condition-json",
-      '{"field":"status","comparator":"eq","values":[{"rawValue":null,"source":{"type":"TRIGGER","id":"payload_value"}}]}',
+      '{"field":"status","comparator":"eq","values":[{"rawValue":null,"source":{"type":"TRIGGER","id":"f1e1d000-0000-0000-0000-000000000005"}}]}',
     ]);
 
     expect(JSON.parse(String(fetchMock.mock.calls[0]?.[1]?.body))).toEqual({
@@ -395,7 +395,7 @@ describe("automations commands", () => {
                 rawValue: null,
                 source: {
                   type: "TRIGGER",
-                  id: "payload_value",
+                  id: "f1e1d000-0000-0000-0000-000000000005",
                 },
               },
             ],
@@ -471,7 +471,7 @@ describe("automations commands", () => {
         "--trigger-field",
         "field-1",
         "--condition-json",
-        '{"field":"status","comparator":"eq","values":[{"rawValue":null,"source":{"type":"TRIGGER","id":"payload_value"}}]}',
+        '{"field":"status","comparator":"eq","values":[{"rawValue":null,"source":{"type":"TRIGGER","id":"f1e1d000-0000-0000-0000-000000000005"}}]}',
       ]),
     ).rejects.toThrowError('Expected trigger condition 1 value 1 to use only literal "rawValue" values.');
 

package/src/commands/displays.test.ts

@@ -151,7 +151,7 @@ describe("displays commands", () => {
       "--name",
       "Revenue",
       "--chart-type",
-      "bar",
+      "bars",
     ]);
 
     const init = fetchMock.mock.calls[0]?.[1];
@@ -159,7 +159,7 @@ describe("displays commands", () => {
     expect(JSON.parse(String(init?.body))).toMatchObject({
       type: "CHART",
       presentation: { name: "Revenue" },
-      chart: { chartType: "bar" },
+      chart: { chartType: "bars" },
     });
     expect(JSON.parse(output.read())).toEqual({
       data: { displayId: "display-1", widgetId: "widget-1" },

package/src/commands/records.test.ts

@@ -364,4 +364,62 @@ describe("records commands", () => {
 
     expect(fetchMock).not.toHaveBeenCalled();
   });
+
+  it("clears all records in a schema", async () => {
+    const configPath = createApiConfig();
+    const output = createStdoutBuffer();
+    const fetchMock = createFetchMock();
+    mockSchemaLookup(fetchMock);
+    fetchMock.mockResolvedValueOnce(
+      jsonResponse({
+        schemaId: "schema-1",
+        cleared: true,
+      }),
+    );
+    const program = buildProgram({ configPath, stdout: output.stdout });
+
+    await program.parseAsync([
+      "node",
+      "zinkee",
+      "--json",
+      "records",
+      "clear",
+      "contacts",
+    ]);
+
+    const init = fetchMock.mock.calls[1]?.[1];
+
+    expect(fetchMock.mock.calls[1]?.[0]).toBe(
+      "https://api.zinkee.test/api/v2/schemas/schema-1/records:clear",
+    );
+    expect(init?.method).toBe("DELETE");
+    expect(init?.body).toBeUndefined();
+
+    const payload = JSON.parse(output.read());
+
+    expect(payload.data).toEqual({
+      schemaId: "schema-1",
+      cleared: true,
+    });
+  });
+
+  it("blocks records clear in read-only mode", async () => {
+    const configPath = createApiConfig();
+    const output = createStdoutBuffer();
+    const fetchMock = createFetchMock();
+    const program = buildProgram({ configPath, stdout: output.stdout });
+
+    await expect(
+      program.parseAsync([
+        "node",
+        "zinkee",
+        "--read-only",
+        "records",
+        "clear",
+        "contacts",
+      ]),
+    ).rejects.toThrowError('Command "records clear" is not allowed in read-only mode.');
+
+    expect(fetchMock).not.toHaveBeenCalled();
+  });
 });

package/src/commands/records.ts

@@ -723,4 +723,23 @@ export function registerRecordsCommands(
 
       writeLine(stdout, `Deleted record "${record.value}" from schema "${schema.value}".`);
     });
+
+  records
+    .command("clear")
+    .description("Delete all records from a schema's table")
+    .argument("<schema>", "schema uuid or slug", parseUuidOrSlugSelector)
+    .action(async function action(this: Command, schema: NormalizedUuidOrSlug) {
+      const { api, schemasApi, json, readOnly } = createRecordsApi(this, filePath);
+      ensureWritable("records clear", readOnly, "destructive");
+      const resolvedSchema = await resolveSchemaSelector(schemasApi, schema);
+
+      const data = await api.clearRecords(resolvedSchema);
+
+      if (json) {
+        emitJson(stdout, "records clear", data, filePath);
+        return;
+      }
+
+      writeLine(stdout, `Cleared all records from schema "${schema.value}".`);
+    });
 }

package/src/index.test.ts

@@ -37,7 +37,6 @@ describe("project bootstrap", () => {
     ).toEqual({
       commandName: "records query",
       filters: {},
-      overrides: {},
       json: true,
     });
   });
@@ -62,9 +61,6 @@ describe("project bootstrap", () => {
       filters: {
         type: "option",
       },
-      overrides: {
-        profile: "local",
-      },
       json: false,
     });
   });
@@ -75,7 +71,6 @@ describe("project bootstrap", () => {
     ).toEqual({
       commandName: "schemas list",
       filters: {},
-      overrides: {},
       json: false,
     });
   });
@@ -96,12 +91,11 @@ describe("project bootstrap", () => {
     ).toEqual({
       commandName: "schemas fields create",
       filters: { type: "option" },
-      overrides: {},
       json: false,
     });
   });
 
-  it("extracts example overrides regardless of --example position", () => {
+  it("extracts example requests regardless of --example position", () => {
     expect(
       extractExampleRequest([
         "node",
@@ -116,7 +110,6 @@ describe("project bootstrap", () => {
     ).toEqual({
       commandName: "schemas list",
       filters: {},
-      overrides: { profile: "staging" },
       json: true,
     });
   });

package/src/utils/examples.test.ts

@@ -1,6 +1,7 @@
 import { describe, expect, it } from "vitest";
 
-import { getCommandExamples } from "./examples.js";
+import { commandRegistry } from "../command-registry.js";
+import { getCommandExamples, getResolvedCommandExamples } from "./examples.js";
 
 describe("getCommandExamples", () => {
   it("returns registered examples for complex commands", () => {
@@ -250,4 +251,24 @@ describe("getCommandExamples", () => {
     expect(getCommandExamples("config show")[0]?.response).toContain('"defaultProfile": "prod"');
     expect(getCommandExamples("config validate")[0]?.response).toContain('"valid": true');
   });
+
+  it.each(Object.keys(commandRegistry))(
+    "returns at least one example for %s",
+    (commandName) => {
+      const examples = getCommandExamples(commandName);
+      expect(examples.length, `${commandName} has no examples`).toBeGreaterThan(0);
+      for (const example of examples) {
+        expect(example.command, `${commandName} example missing command`).toBeTruthy();
+        expect(example.description, `${commandName} example missing description`).toBeTruthy();
+      }
+    },
+  );
+
+  it("getResolvedCommandExamples is synchronous and matches getCommandExamples", () => {
+    for (const commandName of Object.keys(commandRegistry)) {
+      const resolved = getResolvedCommandExamples(commandName);
+      expect(resolved, `${commandName} resolved must not be a thenable`).not.toHaveProperty("then");
+      expect(resolved).toEqual(getCommandExamples(commandName));
+    }
+  });
 });