zinkee 0.1.44 → 0.1.45

package/src/commands/profiles.test.ts

@@ -1,191 +0,0 @@
-import { mkdtempSync, readFileSync, writeFileSync } from "node:fs";
-import { tmpdir } from "node:os";
-import { join } from "node:path";
-
-import { describe, expect, it } from "vitest";
-
-import { buildProgram } from "../index.js";
-
-function createTempConfig(contents: string): string {
-  const dir = mkdtempSync(join(tmpdir(), "zinkee-profiles-"));
-  const filePath = join(dir, "config.toml");
-  writeFileSync(filePath, contents, "utf8");
-  return filePath;
-}
-
-function createStdoutBuffer() {
-  let output = "";
-
-  return {
-    stdout: {
-      write(chunk: string) {
-        output += chunk;
-        return true;
-      },
-    },
-    read() {
-      return output;
-    },
-  };
-}
-
-describe("profiles commands", () => {
-  it("registers the profiles command group", () => {
-    const program = buildProgram();
-
-    expect(program.commands.some((command) => command.name() === "profiles")).toBe(true);
-  });
-
-  it("redacts secrets when showing a profile", async () => {
-    const configPath = createTempConfig(`
-default_profile = "prod"
-
-[profiles.prod]
-api_key = "secret-token-1234"
-base_url = "https://api.zinkee.test"
-`);
-    const output = createStdoutBuffer();
-    const program = buildProgram({ configPath, stdout: output.stdout });
-
-    await program.parseAsync(["node", "zinkee", "profiles", "get", "prod"]);
-
-    expect(output.read()).toContain("apiKey");
-    expect(output.read()).toContain("********1234");
-    expect(output.read()).not.toContain("secret-token-1234");
-  });
-
-  it("adds a profile and writes a TOML config file", async () => {
-    const configPath = join(mkdtempSync(join(tmpdir(), "zinkee-profiles-add-")), "config.toml");
-    const output = createStdoutBuffer();
-    const program = buildProgram({ configPath, stdout: output.stdout });
-
-    await program.parseAsync([
-      "node",
-      "zinkee",
-      "profiles",
-      "add",
-      "local",
-      "--api-key",
-      "new-token-5678",
-      "--base-url",
-      "http://localhost:8088",
-    ]);
-
-    const saved = readFileSync(configPath, "utf8");
-
-    expect(output.read()).toContain('Added profile "local".');
-    expect(saved).toContain('[profiles.local]');
-    expect(saved).toContain('api_key = "new-token-5678"');
-    expect(saved).toContain('base_url = "http://localhost:8088"');
-    expect(saved).toContain('default_profile = "local"');
-  });
-
-  it("rejects a malformed base URL when adding a profile", async () => {
-    const configPath = join(
-      mkdtempSync(join(tmpdir(), "zinkee-profiles-add-bad-url-")),
-      "config.toml",
-    );
-    const output = createStdoutBuffer();
-    const program = buildProgram({ configPath, stdout: output.stdout });
-
-    await expect(
-      program.parseAsync([
-        "node",
-        "zinkee",
-        "profiles",
-        "add",
-        "broken",
-        "--api-key",
-        "any",
-        "--base-url",
-        "api-z2.zinkee.com",
-      ]),
-    ).rejects.toMatchObject({
-      name: "CliError",
-      code: "configuration_error",
-      message: '"--base-url" must be an absolute http(s) URL.',
-    });
-  });
-
-  it("rejects a non-http(s) base URL when adding a profile", async () => {
-    const configPath = join(
-      mkdtempSync(join(tmpdir(), "zinkee-profiles-add-ftp-")),
-      "config.toml",
-    );
-    const output = createStdoutBuffer();
-    const program = buildProgram({ configPath, stdout: output.stdout });
-
-    await expect(
-      program.parseAsync([
-        "node",
-        "zinkee",
-        "profiles",
-        "add",
-        "broken",
-        "--api-key",
-        "any",
-        "--base-url",
-        "ftp://api-z2.zinkee.com",
-      ]),
-    ).rejects.toMatchObject({
-      name: "CliError",
-      code: "configuration_error",
-      message: '"--base-url" must be an absolute http(s) URL.',
-    });
-  });
-
-  it("normalizes trailing slashes when adding a profile", async () => {
-    const configPath = join(
-      mkdtempSync(join(tmpdir(), "zinkee-profiles-add-slash-")),
-      "config.toml",
-    );
-    const output = createStdoutBuffer();
-    const program = buildProgram({ configPath, stdout: output.stdout });
-
-    await program.parseAsync([
-      "node",
-      "zinkee",
-      "profiles",
-      "add",
-      "local",
-      "--api-key",
-      "any",
-      "--base-url",
-      "https://api-z2.zinkee.com///",
-    ]);
-
-    const saved = readFileSync(configPath, "utf8");
-
-    expect(saved).toContain('base_url = "https://api-z2.zinkee.com"');
-  });
-
-  it("rejects a malformed base URL when updating a profile", async () => {
-    const configPath = createTempConfig(`
-[profiles.prod]
-api_key = "secret"
-base_url = "https://api-z2.zinkee.com"
-`);
-    const output = createStdoutBuffer();
-    const program = buildProgram({ configPath, stdout: output.stdout });
-
-    await expect(
-      program.parseAsync([
-        "node",
-        "zinkee",
-        "profiles",
-        "update",
-        "prod",
-        "--base-url",
-        "not a url",
-      ]),
-    ).rejects.toMatchObject({
-      name: "CliError",
-      code: "configuration_error",
-      message: '"--base-url" must be an absolute http(s) URL.',
-    });
-
-    const saved = readFileSync(configPath, "utf8");
-
-    expect(saved).toContain('base_url = "https://api-z2.zinkee.com"');
-  });
-});

package/src/commands/profiles.ts

@@ -1,303 +0,0 @@
-import type { Writable } from "node:stream";
-
-import { Command } from "commander";
-
-import {
-  defaultConfigPath,
-  ProfileResolutionError,
-  readConfigIfExists,
-  redactProfile,
-  removeProfileConfig,
-  setDefaultProfile,
-  setProfileConfig,
-  validateBaseUrl,
-  writeConfig,
-} from "../config.js";
-import type { AppConfig, ProfileConfig } from "../types.js";
-import { CliError } from "../utils/errors.js";
-import { buildJsonSuccess, printTable } from "../utils/output.js";
-
-interface CommandIo {
-  write(chunk: string): unknown;
-}
-
-export interface RegisterProfilesCommandsOptions {
-  configPath?: string;
-  stdout?: CommandIo;
-}
-
-interface GlobalOptions {
-  json?: boolean;
-}
-
-export interface DisplayProfile extends ProfileConfig {
-  name: string;
-  isDefault: boolean;
-}
-
-function getCommandIo(stdout: CommandIo | undefined): CommandIo {
-  return stdout ?? (process.stdout as Writable);
-}
-
-function writeLine(stdout: CommandIo, value: string): void {
-  stdout.write(`${value}\n`);
-}
-
-function getGlobalOptions(command: Command): GlobalOptions {
-  return command.optsWithGlobals<GlobalOptions>();
-}
-
-function emitJson(
-  stdout: CommandIo,
-  commandName: string,
-  data: unknown,
-  configPath: string,
-): void {
-  writeLine(
-    stdout,
-    JSON.stringify(buildJsonSuccess(data, { command: commandName, configPath })),
-  );
-}
-
-function readRequiredConfig(filePath: string): AppConfig {
-  const config = readConfigIfExists(filePath);
-
-  if (config) {
-    return config;
-  }
-
-  throw new CliError("configuration_error", `Config file not found at ${filePath}.`);
-}
-
-function getRequiredProfile(config: AppConfig, profileName: string): ProfileConfig {
-  const profile = config.profiles[profileName];
-
-  if (profile) {
-    return profile;
-  }
-
-  throw new CliError("configuration_error", `Profile "${profileName}" not found in config.`);
-}
-
-function toDisplayProfile(
-  profileName: string,
-  profile: ProfileConfig,
-  defaultProfile: string | undefined,
-): DisplayProfile {
-  return {
-    name: profileName,
-    isDefault: defaultProfile === profileName,
-    ...redactProfile(profile),
-  };
-}
-
-function loadConfigForAdd(filePath: string): AppConfig {
-  return readConfigIfExists(filePath) ?? { profiles: {} };
-}
-
-function normalizeProfileBaseUrl(baseUrl: string | undefined): string | undefined {
-  if (baseUrl === undefined) {
-    return undefined;
-  }
-
-  try {
-    return validateBaseUrl(baseUrl, '"--base-url"');
-  } catch (error) {
-    if (error instanceof ProfileResolutionError) {
-      throw new CliError("configuration_error", error.message);
-    }
-
-    throw error;
-  }
-}
-
-function emitProfilesTable(stdout: CommandIo, data: readonly DisplayProfile[]): void {
-  printTable(
-    data.map((profile) => ({
-      name: profile.name,
-      default: profile.isDefault ? "yes" : "",
-      baseUrl: profile.baseUrl ?? "",
-      apiKey: profile.apiKey ?? "",
-    })),
-    ["name", "default", "baseUrl", "apiKey"],
-    stdout,
-  );
-}
-
-export function registerProfilesCommands(
-  program: Command,
-  options: RegisterProfilesCommandsOptions = {},
-): void {
-  const filePath = options.configPath ?? defaultConfigPath;
-  const stdout = getCommandIo(options.stdout);
-  const profiles = program.command("profiles").description("Manage local CLI profiles");
-
-  profiles
-    .command("list")
-    .description("List configured profiles")
-    .action(function action(this: Command) {
-      const config = readRequiredConfig(filePath);
-      const data = Object.entries(config.profiles).map(([name, profile]) =>
-        toDisplayProfile(name, profile, config.defaultProfile),
-      );
-
-      if (getGlobalOptions(this).json) {
-        emitJson(stdout, "profiles list", data, filePath);
-        return;
-      }
-
-      emitProfilesTable(stdout, data);
-    });
-
-  profiles
-    .command("get")
-    .description("Show a single configured profile")
-    .argument("<profile>", "profile name")
-    .action(function action(this: Command, profileName: string) {
-      const config = readRequiredConfig(filePath);
-      const profile = getRequiredProfile(config, profileName);
-      const data = toDisplayProfile(profileName, profile, config.defaultProfile);
-
-      if (getGlobalOptions(this).json) {
-        emitJson(stdout, "profiles get", data, filePath);
-        return;
-      }
-
-      emitProfilesTable(stdout, [data]);
-    });
-
-  profiles
-    .command("use")
-    .description("Set the default profile")
-    .argument("<profile>", "profile name")
-    .action(function action(this: Command, profileName: string) {
-      const config = readRequiredConfig(filePath);
-      getRequiredProfile(config, profileName);
-
-      const nextConfig = setDefaultProfile(config, profileName);
-      writeConfig(nextConfig, filePath);
-      const data = {
-        profile: profileName,
-        defaultProfile: nextConfig.defaultProfile,
-      };
-
-      if (getGlobalOptions(this).json) {
-        emitJson(stdout, "profiles use", data, filePath);
-        return;
-      }
-
-      writeLine(stdout, `Using profile "${profileName}".`);
-    });
-
-  profiles
-    .command("add")
-    .description("Add a profile to the local config")
-    .argument("<profile>", "profile name")
-    .requiredOption("--api-key <token>", "API key")
-    .option("--base-url <url>", "base URL")
-    .action(function action(
-      this: Command,
-      profileName: string,
-      commandOptions: { apiKey: string; baseUrl?: string },
-    ) {
-      const config = loadConfigForAdd(filePath);
-
-      if (config.profiles[profileName]) {
-        throw new CliError(
-          "configuration_error",
-          `Profile "${profileName}" already exists in config.`,
-        );
-      }
-
-      const baseUrl = normalizeProfileBaseUrl(commandOptions.baseUrl);
-
-      let nextConfig = setProfileConfig(config, profileName, {
-        apiKey: commandOptions.apiKey,
-        baseUrl,
-      });
-
-      if (!nextConfig.defaultProfile) {
-        nextConfig = setDefaultProfile(nextConfig, profileName);
-      }
-
-      writeConfig(nextConfig, filePath);
-      const data = toDisplayProfile(
-        profileName,
-        nextConfig.profiles[profileName] ?? {},
-        nextConfig.defaultProfile,
-      );
-
-      if (getGlobalOptions(this).json) {
-        emitJson(stdout, "profiles add", data, filePath);
-        return;
-      }
-
-      writeLine(stdout, `Added profile "${profileName}".`);
-    });
-
-  profiles
-    .command("update")
-    .description("Update an existing profile")
-    .argument("<profile>", "profile name")
-    .option("--api-key <token>", "API key")
-    .option("--base-url <url>", "base URL")
-    .action(function action(
-      this: Command,
-      profileName: string,
-      commandOptions: { apiKey?: string; baseUrl?: string },
-    ) {
-      if (commandOptions.apiKey === undefined && commandOptions.baseUrl === undefined) {
-        throw new CliError(
-          "configuration_error",
-          'Provide at least one of "--api-key" or "--base-url".',
-        );
-      }
-
-      const config = readRequiredConfig(filePath);
-      getRequiredProfile(config, profileName);
-
-      const baseUrl = normalizeProfileBaseUrl(commandOptions.baseUrl);
-
-      const nextConfig = setProfileConfig(config, profileName, {
-        apiKey: commandOptions.apiKey,
-        baseUrl,
-      });
-
-      writeConfig(nextConfig, filePath);
-      const data = toDisplayProfile(
-        profileName,
-        nextConfig.profiles[profileName] ?? {},
-        nextConfig.defaultProfile,
-      );
-
-      if (getGlobalOptions(this).json) {
-        emitJson(stdout, "profiles update", data, filePath);
-        return;
-      }
-
-      writeLine(stdout, `Updated profile "${profileName}".`);
-    });
-
-  profiles
-    .command("remove")
-    .description("Remove a profile from the local config")
-    .argument("<profile>", "profile name")
-    .action(function action(this: Command, profileName: string) {
-      const config = readRequiredConfig(filePath);
-      getRequiredProfile(config, profileName);
-
-      const nextConfig = removeProfileConfig(config, profileName);
-      writeConfig(nextConfig, filePath);
-      const data = {
-        profile: profileName,
-        defaultProfile: nextConfig.defaultProfile,
-      };
-
-      if (getGlobalOptions(this).json) {
-        emitJson(stdout, "profiles remove", data, filePath);
-        return;
-      }
-
-      writeLine(stdout, `Removed profile "${profileName}".`);
-    });
-}