zinkee 0.1.44 → 0.1.45

package/src/utils/argv-rewrite.ts

@@ -1,269 +0,0 @@
-import type { Command } from "commander";
-
-export const HOISTABLE_GLOBAL_FLAGS = {
-  "--profile": "value",
-  "--base-url": "value",
-  "--api-key": "value",
-  "--read-only": "boolean",
-  "--json": "boolean",
-} as const satisfies Record<string, "value" | "boolean">;
-
-type HoistableFlagName = keyof typeof HOISTABLE_GLOBAL_FLAGS;
-
-function isHoistableFlag(flagName: string): flagName is HoistableFlagName {
-  return Object.hasOwn(HOISTABLE_GLOBAL_FLAGS, flagName);
-}
-
-export interface OptionMetadata {
-  valueFlags: Set<string>;
-  booleanFlags: Set<string>;
-  localOptionsByCommand: Map<string, Set<string>>;
-}
-
-function getCommandPath(command: Command): string {
-  const parts: string[] = [];
-  let cursor: Command | null = command;
-  while (cursor && cursor.parent) {
-    parts.unshift(cursor.name());
-    cursor = cursor.parent;
-  }
-  return parts.join(" ");
-}
-
-export function buildOptionMetadata(program: Command): OptionMetadata {
-  const valueFlags = new Set<string>();
-  const booleanFlags = new Set<string>();
-  const localOptionsByCommand = new Map<string, Set<string>>();
-
-  function visit(command: Command, isRoot: boolean): void {
-    const localFlags = new Set<string>();
-
-    for (const option of command.options) {
-      if (!option.long) continue;
-
-      if (option.required || option.optional) {
-        valueFlags.add(option.long);
-      } else {
-        booleanFlags.add(option.long);
-      }
-
-      if (!isRoot) {
-        localFlags.add(option.long);
-      }
-    }
-
-    if (!isRoot) {
-      localOptionsByCommand.set(getCommandPath(command), localFlags);
-    }
-
-    for (const sub of command.commands) {
-      visit(sub, false);
-    }
-  }
-
-  visit(program, true);
-  return { valueFlags, booleanFlags, localOptionsByCommand };
-}
-
-export function createDefaultOptionMetadata(): OptionMetadata {
-  return {
-    valueFlags: new Set([
-      "--profile",
-      "--base-url",
-      "--api-key",
-      "--install-completion",
-      "--show-completion",
-    ]),
-    booleanFlags: new Set([
-      "--read-only",
-      "--json",
-      "--example",
-      "--help",
-    ]),
-    localOptionsByCommand: new Map(),
-  };
-}
-
-interface FlagSplit {
-  flagName: string;
-  inlineValue: string | undefined;
-}
-
-function isFlagToken(token: string): boolean {
-  return token.length > 1 && token.startsWith("-");
-}
-
-function splitFlagToken(token: string): FlagSplit {
-  if (token.startsWith("--") && token.includes("=")) {
-    const eqIdx = token.indexOf("=");
-    return {
-      flagName: token.slice(0, eqIdx),
-      inlineValue: token.slice(eqIdx + 1),
-    };
-  }
-  return { flagName: token, inlineValue: undefined };
-}
-
-function flagConsumesValue(flagName: string, optionMeta: OptionMetadata): boolean {
-  if (optionMeta.valueFlags.has(flagName)) {
-    return true;
-  }
-  if (optionMeta.booleanFlags.has(flagName)) {
-    return false;
-  }
-  return true;
-}
-
-interface OperandPosition {
-  index: number;
-  token: string;
-}
-
-export function collectOperandTokens(
-  userArgs: readonly string[],
-  optionMeta: OptionMetadata,
-  options: { skipFlag?: string } = {},
-): OperandPosition[] {
-  const operands: OperandPosition[] = [];
-  let i = 0;
-  while (i < userArgs.length) {
-    const token = userArgs[i] as string;
-
-    if (token === "--") {
-      break;
-    }
-
-    if (isFlagToken(token)) {
-      const { flagName, inlineValue } = splitFlagToken(token);
-
-      if (options.skipFlag !== undefined && flagName === options.skipFlag) {
-        i += 1;
-        continue;
-      }
-
-      if (inlineValue !== undefined) {
-        i += 1;
-        continue;
-      }
-
-      const consumes = flagConsumesValue(flagName, optionMeta);
-      const next = userArgs[i + 1];
-      if (consumes && next !== undefined && !isFlagToken(next)) {
-        i += 2;
-      } else {
-        i += 1;
-      }
-      continue;
-    }
-
-    operands.push({ index: i, token });
-    i += 1;
-  }
-  return operands;
-}
-
-export interface CommandPathMatch {
-  commandName: string;
-  firstArgvIndex: number;
-  lastArgvIndex: number;
-}
-
-export function findCommandPath(
-  operands: readonly OperandPosition[],
-  registry: Record<string, unknown>,
-): CommandPathMatch | null {
-  if (operands.length === 0) return null;
-
-  const commandsByLength = Object.keys(registry).sort(
-    (left, right) => right.split(" ").length - left.split(" ").length,
-  );
-
-  for (let start = 0; start < operands.length; start += 1) {
-    for (const commandName of commandsByLength) {
-      const parts = commandName.split(" ");
-      if (start + parts.length > operands.length) continue;
-
-      let matches = true;
-      for (let j = 0; j < parts.length; j += 1) {
-        if (operands[start + j]!.token !== parts[j]) {
-          matches = false;
-          break;
-        }
-      }
-
-      if (matches) {
-        return {
-          commandName,
-          firstArgvIndex: operands[start]!.index,
-          lastArgvIndex: operands[start + parts.length - 1]!.index,
-        };
-      }
-    }
-  }
-
-  return null;
-}
-
-export function hoistGlobalOptions(
-  argv: readonly string[],
-  optionMeta: OptionMetadata,
-  registry: Record<string, unknown>,
-): string[] {
-  if (argv.length < 3) return [...argv];
-
-  const userArgs = argv.slice(2);
-  const operands = collectOperandTokens(userArgs, optionMeta);
-  const cmdPath = findCommandPath(operands, registry);
-
-  if (!cmdPath) return [...argv];
-
-  const localOptions =
-    optionMeta.localOptionsByCommand.get(cmdPath.commandName) ?? new Set<string>();
-
-  const hoisted: string[] = [];
-  const remaining: string[] = [];
-  let i = 0;
-
-  while (i < userArgs.length) {
-    const token = userArgs[i] as string;
-
-    if (token === "--") {
-      remaining.push(...userArgs.slice(i));
-      break;
-    }
-
-    if (!isFlagToken(token)) {
-      remaining.push(token);
-      i += 1;
-      continue;
-    }
-
-    const { flagName, inlineValue } = splitFlagToken(token);
-
-    if (!isHoistableFlag(flagName)) {
-      remaining.push(token);
-      i += 1;
-      continue;
-    }
-
-    const isAfterCommandPath = i > cmdPath.lastArgvIndex;
-    const collidesWithLocal = localOptions.has(flagName);
-
-    const target = isAfterCommandPath && collidesWithLocal ? remaining : hoisted;
-    target.push(token);
-
-    const spec = HOISTABLE_GLOBAL_FLAGS[flagName];
-    if (spec === "value" && inlineValue === undefined) {
-      const next = userArgs[i + 1];
-      if (next !== undefined && !isFlagToken(next)) {
-        target.push(next);
-        i += 2;
-        continue;
-      }
-    }
-
-    i += 1;
-  }
-
-  return [argv[0] as string, argv[1] as string, ...hoisted, ...remaining];
-}

package/src/utils/errors.test.ts

@@ -1,85 +0,0 @@
-import { describe, expect, it } from "vitest";
-
-import { ApiClientError } from "../client.js";
-
-import { formatCliErrorJson } from "./errors.js";
-
-describe("formatCliErrorJson", () => {
-  it("preserves backend reason, action, requestId, and status details", () => {
-    const error = new ApiClientError(
-      "http_error",
-      "Request failed with status 409 for PATCH https://api.example.com/api/v2/automations/1.",
-      {
-        url: "https://api.example.com/api/v2/automations/1",
-        method: "PATCH",
-        status: 409,
-        responseBody: {
-          error: {
-            reason: "schema_locked",
-            action: "retry_later",
-            message: "Schema is locked.",
-          },
-          meta: {
-            requestId: "req_123",
-          },
-        },
-      },
-    );
-
-    expect(JSON.parse(formatCliErrorJson(error, { exitCode: 1 }))).toEqual({
-      error: {
-        code: "http_error",
-        message: "Schema is locked.",
-        exitCode: 1,
-        details: {
-          reason: "schema_locked",
-          action: "retry_later",
-          requestId: "req_123",
-          status: 409,
-        },
-      },
-      meta: {
-        requestId: "req_123",
-        status: 409,
-        exitCode: 1,
-      },
-    });
-  });
-
-  it("preserves network_error code for transport-layer failures", () => {
-    const error = new ApiClientError(
-      "network_error",
-      "Request failed for GET https://api.example.com/api/v2/schemas: getaddrinfo ENOTFOUND api.example.com.",
-      {
-        url: "https://api.example.com/api/v2/schemas",
-        method: "GET",
-        cause: new Error("getaddrinfo ENOTFOUND api.example.com"),
-      },
-    );
-
-    expect(JSON.parse(formatCliErrorJson(error)).error.code).toBe("network_error");
-  });
-
-  it("preserves timeout code for aborted requests", () => {
-    const error = new ApiClientError("timeout", "Request timed out after 10ms.", {
-      url: "https://api.example.com/api/v2/schemas",
-      method: "GET",
-    });
-
-    expect(JSON.parse(formatCliErrorJson(error)).error.code).toBe("timeout");
-  });
-
-  it("preserves invalid_json code for unparseable responses", () => {
-    const error = new ApiClientError(
-      "invalid_json",
-      "Failed to parse JSON response from GET https://api.example.com/api/v2/schemas.",
-      {
-        url: "https://api.example.com/api/v2/schemas",
-        method: "GET",
-        responseText: "<html>oops</html>",
-      },
-    );
-
-    expect(JSON.parse(formatCliErrorJson(error)).error.code).toBe("invalid_json");
-  });
-});

package/src/utils/errors.ts

@@ -1,191 +0,0 @@
-import { ApiClientError } from "../client.js";
-import type { JsonEnvelopeMeta, JsonErrorEnvelope } from "../types.js";
-
-import { buildJsonError } from "./output.js";
-
-export type CliErrorCode =
-  | "unknown_error"
-  | "invalid_cli_usage"
-  | "configuration_error"
-  | "command_not_allowed_in_read_only_mode"
-  | "network_error"
-  | "http_error"
-  | "timeout"
-  | "invalid_json";
-
-export const cliExitCodeByErrorCode = {
-  unknown_error: 1,
-  invalid_cli_usage: 2,
-  configuration_error: 2,
-  command_not_allowed_in_read_only_mode: 7,
-  network_error: 1,
-  http_error: 1,
-  timeout: 1,
-  invalid_json: 1,
-} as const satisfies Record<CliErrorCode, number>;
-
-export interface CliErrorDetails {
-  [key: string]: unknown;
-}
-
-export interface CliErrorPayload {
-  code: CliErrorCode;
-  message: string;
-  exitCode: number;
-  details?: CliErrorDetails;
-}
-
-const errorCodeByName: Record<string, CliErrorCode> = {
-  ProfileResolutionError: "configuration_error",
-};
-
-export class CliError extends Error {
-  override name = "CliError";
-
-  readonly code: CliErrorCode;
-
-  readonly exitCode: number;
-
-  readonly details?: CliErrorDetails;
-
-  constructor(
-    code: CliErrorCode,
-    message: string,
-    details: CliErrorDetails = {},
-    exitCode: number = cliExitCodeByErrorCode[code],
-  ) {
-    super(message);
-    this.code = code;
-    this.exitCode = exitCode;
-
-    if (Object.keys(details).length > 0) {
-      this.details = details;
-    }
-  }
-
-  toJSON(): CliErrorPayload {
-    const payload: CliErrorPayload = {
-      code: this.code,
-      message: this.message,
-      exitCode: this.exitCode,
-    };
-
-    if (this.details) {
-      payload.details = this.details;
-    }
-
-    return payload;
-  }
-}
-
-export function isCliError(error: unknown): error is CliError {
-  return error instanceof CliError;
-}
-
-function isRecord(value: unknown): value is Record<string, unknown> {
-  return typeof value === "object" && value !== null && !Array.isArray(value);
-}
-
-function readString(value: unknown): string | undefined {
-  return typeof value === "string" && value.trim().length > 0 ? value : undefined;
-}
-
-function readNumber(value: unknown): number | undefined {
-  return typeof value === "number" ? value : undefined;
-}
-
-function extractApiErrorDetails(error: ApiClientError): {
-  message: string;
-  details: CliErrorDetails;
-  meta: JsonEnvelopeMeta;
-} {
-  const details: CliErrorDetails = {};
-  const meta: JsonEnvelopeMeta = {};
-  const responseBody = isRecord(error.responseBody) ? error.responseBody : undefined;
-  const errorBody = responseBody?.error;
-  const backendError = isRecord(errorBody) ? errorBody : responseBody;
-  const backendMeta = isRecord(responseBody?.meta) ? responseBody.meta : undefined;
-  const reason =
-    readString(backendError?.reason) ??
-    readString(backendError?.code);
-  const action = readString(backendError?.action);
-  const requestId =
-    readString(backendMeta?.requestId) ??
-    readString(responseBody?.requestId) ??
-    readString(backendError?.requestId);
-  const status =
-    readNumber(backendError?.status) ??
-    readNumber(responseBody?.status) ??
-    error.status;
-  const backendMessage = readString(backendError?.message);
-
-  if (reason !== undefined) {
-    details.reason = reason;
-  }
-
-  if (action !== undefined) {
-    details.action = action;
-  }
-
-  if (requestId !== undefined) {
-    details.requestId = requestId;
-    meta.requestId = requestId;
-  }
-
-  if (status !== undefined) {
-    details.status = status;
-    meta.status = status;
-  }
-
-  return {
-    message: backendMessage ?? error.message,
-    details,
-    meta,
-  };
-}
-
-export function toCliError(error: unknown): CliError {
-  if (error instanceof CliError) {
-    return error;
-  }
-
-  if (error instanceof ApiClientError) {
-    const apiError = extractApiErrorDetails(error);
-
-    return new CliError(error.code, apiError.message, apiError.details);
-  }
-
-  if (error instanceof Error) {
-    return new CliError(errorCodeByName[error.name] ?? "unknown_error", error.message);
-  }
-
-  return new CliError("unknown_error", "Unknown error");
-}
-
-export function getExitCode(error: unknown): number {
-  return toCliError(error).exitCode;
-}
-
-export function buildJsonCliError<TMeta extends JsonEnvelopeMeta = JsonEnvelopeMeta>(
-  error: unknown,
-  meta: TMeta = {} as TMeta,
-): JsonErrorEnvelope<CliErrorPayload, TMeta> {
-  const cliError = toCliError(error);
-  const apiErrorMeta =
-    error instanceof ApiClientError
-      ? extractApiErrorDetails(error).meta
-      : {};
-
-  return buildJsonError(cliError.toJSON(), { ...apiErrorMeta, ...meta } as TMeta);
-}
-
-export function formatCliErrorText(error: unknown): string {
-  return toCliError(error).message;
-}
-
-export function formatCliErrorJson<TMeta extends JsonEnvelopeMeta = JsonEnvelopeMeta>(
-  error: unknown,
-  meta: TMeta = {} as TMeta,
-): string {
-  return JSON.stringify(buildJsonCliError(error, meta));
-}