zinkee 0.1.44 → 0.1.46

package/src/completion/runtime.ts

@@ -1,150 +0,0 @@
-import type { Writable } from "node:stream";
-
-import { buildProgram } from "../program.js";
-import { getCompletions } from "./engine.js";
-import {
-  CompletionShellError,
-  currentEnvironment,
-  detectShell,
-  installCompletion,
-  parseShell,
-  type InstallEnvironment,
-} from "./install.js";
-import { renderScript, type SupportedShell } from "./scripts.js";
-
-export const COMPLETION_ENV_VAR = "_ZINKEE_COMPLETE";
-
-interface Stream {
-  write(chunk: string): unknown;
-}
-
-function getStream(stream: Stream | undefined, fallback: NodeJS.WriteStream): Stream {
-  return stream ?? (fallback as unknown as Writable);
-}
-
-function parseEnvWords(env: NodeJS.ProcessEnv): string[] {
-  const raw = env.COMP_WORDS ?? "";
-  if (raw.trim().length === 0) {
-    return [];
-  }
-  return raw.split(/\s+/).filter((token) => token.length > 0);
-}
-
-function parseEnvCwordIndex(env: NodeJS.ProcessEnv): number {
-  const raw = env.COMP_CWORD ?? "0";
-  const parsed = Number.parseInt(raw, 10);
-  if (Number.isNaN(parsed) || parsed < 0) {
-    return 0;
-  }
-  return parsed;
-}
-
-export function isCompletionRequest(env: NodeJS.ProcessEnv = process.env): boolean {
-  return typeof env[COMPLETION_ENV_VAR] === "string" && env[COMPLETION_ENV_VAR]!.length > 0;
-}
-
-export function runCompletionRequest(
-  env: NodeJS.ProcessEnv = process.env,
-  stdout?: Stream,
-): void {
-  const out = getStream(stdout, process.stdout);
-  try {
-    const program = buildProgram();
-    const candidates = getCompletions(program, {
-      words: parseEnvWords(env),
-      cwordIndex: parseEnvCwordIndex(env),
-    });
-    if (candidates.length > 0) {
-      out.write(`${candidates.join("\n")}\n`);
-    }
-  } catch {
-    // Completion must never crash the user's shell. Swallow.
-  }
-}
-
-export interface CompletionFlagRequest {
-  mode: "install" | "show";
-  shellOverride?: string;
-}
-
-export function extractCompletionFlag(argv: readonly string[]): CompletionFlagRequest | null {
-  for (let index = 0; index < argv.length; index += 1) {
-    const token = argv[index];
-    if (!token) {
-      continue;
-    }
-    if (token === "--install-completion" || token === "--show-completion") {
-      const mode = token === "--install-completion" ? "install" : "show";
-      const next = argv[index + 1];
-      const shellOverride = next && !next.startsWith("-") ? next : undefined;
-      return { mode, shellOverride };
-    }
-    if (token.startsWith("--install-completion=")) {
-      const value = token.slice("--install-completion=".length);
-      return { mode: "install", shellOverride: value || undefined };
-    }
-    if (token.startsWith("--show-completion=")) {
-      const value = token.slice("--show-completion=".length);
-      return { mode: "show", shellOverride: value || undefined };
-    }
-  }
-  return null;
-}
-
-function resolveShell(
-  request: CompletionFlagRequest,
-  env: InstallEnvironment,
-): SupportedShell {
-  if (request.shellOverride) {
-    return parseShell(request.shellOverride);
-  }
-  return detectShell(env);
-}
-
-export interface CompletionFlagDeps {
-  environment?: InstallEnvironment;
-  stdout?: Stream;
-  stderr?: Stream;
-}
-
-export function handleCompletionFlag(
-  request: CompletionFlagRequest,
-  deps: CompletionFlagDeps = {},
-): number {
-  const env = deps.environment ?? currentEnvironment();
-  const out = getStream(deps.stdout, process.stdout);
-  const err = getStream(deps.stderr, process.stderr);
-
-  let shell: SupportedShell;
-  try {
-    shell = resolveShell(request, env);
-  } catch (error) {
-    const message = error instanceof CompletionShellError ? error.message : String(error);
-    err.write(`${message}\n`);
-    return 1;
-  }
-
-  if (request.mode === "show") {
-    out.write(renderScript(shell));
-    return 0;
-  }
-
-  try {
-    const result = installCompletion(shell, env);
-    err.write(`zinkee completion installed for ${shell}.\n`);
-    err.write(`  script: ${result.scriptPath}\n`);
-    if (result.rcPath && result.rcPath !== result.scriptPath) {
-      err.write(
-        result.rcUpdated
-          ? `  updated: ${result.rcPath}\n`
-          : `  unchanged: ${result.rcPath}\n`,
-      );
-    }
-    err.write(`Restart your shell or open a new session to enable completion.\n`);
-    return 0;
-  } catch (error) {
-    const message = error instanceof Error ? error.message : String(error);
-    err.write(`Failed to install zinkee completion: ${message}\n`);
-    return 1;
-  }
-}

package/src/completion/scripts.ts

@@ -1,91 +0,0 @@
-export type SupportedShell = "bash" | "zsh" | "fish" | "powershell";
-
-const PROGRAM = "zinkee";
-const ENV_VAR = "_ZINKEE_COMPLETE";
-
-export function renderBashScript(): string {
-  return `_zinkee_completion() {
-    local IFS=$'\\n'
-    local response
-
-    response=$(env COMP_WORDS="\${COMP_WORDS[*]}" COMP_CWORD=$COMP_CWORD ${ENV_VAR}=bash_complete ${PROGRAM} 2>/dev/null)
-
-    COMPREPLY=( \${response} )
-    return 0
-}
-
-complete -o default -F _zinkee_completion ${PROGRAM}
-`;
-}
-
-export function renderZshScript(): string {
-  return `#compdef ${PROGRAM}
-
-_zinkee_completion() {
-    local -a response
-    (( ! $+commands[${PROGRAM}] )) && return 1
-
-    response=("\${(@f)$(env COMP_WORDS="\${words[*]}" COMP_CWORD=$((CURRENT - 1)) ${ENV_VAR}=zsh_complete ${PROGRAM} 2>/dev/null)}")
-
-    if [ -n "$response" ]; then
-        compadd -U -V unsorted -a response
-    fi
-}
-
-if [[ $zsh_eval_context[-1] == loadautofunc ]]; then
-    _zinkee_completion "$@"
-else
-    compdef _zinkee_completion ${PROGRAM}
-fi
-`;
-}
-
-export function renderFishScript(): string {
-  return `function __zinkee_completion
-    set -l tokens (commandline -opc) (commandline -ct)
-    set -l cword (math (count $tokens) - 1)
-    set -l joined (string join " " -- $tokens)
-
-    env COMP_WORDS="$joined" COMP_CWORD=$cword ${ENV_VAR}=fish_complete ${PROGRAM} 2>/dev/null
-end
-
-complete --no-files --command ${PROGRAM} --arguments '(__zinkee_completion)'
-`;
-}
-
-export function renderPowerShellScript(): string {
-  return `Register-ArgumentCompleter -Native -CommandName ${PROGRAM} -ScriptBlock {
-    param($wordToComplete, $commandAst, $cursorPosition)
-
-    $tokens = @($commandAst.CommandElements | ForEach-Object { $_.ToString() })
-    $cword = [Math]::Max(0, $tokens.Count - 1)
-
-    $env:COMP_WORDS = ($tokens -join ' ')
-    $env:COMP_CWORD = $cword
-    $env:${ENV_VAR} = 'powershell_complete'
-
-    try {
-        & ${PROGRAM} 2>$null | ForEach-Object {
-            [System.Management.Automation.CompletionResult]::new($_, $_, 'ParameterValue', $_)
-        }
-    } finally {
-        Remove-Item Env:COMP_WORDS -ErrorAction SilentlyContinue
-        Remove-Item Env:COMP_CWORD -ErrorAction SilentlyContinue
-        Remove-Item Env:${ENV_VAR} -ErrorAction SilentlyContinue
-    }
-}
-`;
-}
-
-export function renderScript(shell: SupportedShell): string {
-  switch (shell) {
-    case "bash":
-      return renderBashScript();
-    case "zsh":
-      return renderZshScript();
-    case "fish":
-      return renderFishScript();
-    case "powershell":
-      return renderPowerShellScript();
-  }
-}

package/src/config.test.ts

@@ -1,362 +0,0 @@
-import { describe, expect, it } from "vitest";
-
-import {
-  DEFAULT_PRODUCTION_BASE_URL,
-  ENV_API_KEY,
-  ENV_BASE_URL,
-  ENV_PROFILE,
-  parseConfig,
-  redactConfig,
-  redactSecret,
-  readRuntimeConfig,
-  readEnvApiKey,
-  readEnvBaseUrl,
-  readEnvProfile,
-  removeProfileConfig,
-  resolveProfile,
-  serializeConfig,
-  setDefaultProfile,
-  setProfileConfig,
-} from "./config.js";
-import { resolveRuntimeContext } from "./runtime-context.js";
-
-describe("parseConfig", () => {
-  it("reads the legacy config shape without migration", () => {
-    const config = parseConfig(`
-default_profile = "prod"
-
-[profiles.prod]
-api_key = "token"
-base_url = "https://api.zinkee.com"
-retry_count = 3
-`);
-
-    expect(config.defaultProfile).toBe("prod");
-    expect(config.profiles.prod?.apiKey).toBe("token");
-    expect(config.profiles.prod?.baseUrl).toBe("https://api.zinkee.com");
-    expect(config.profiles.prod?.retry_count).toBe(3);
-  });
-});
-
-describe("readRuntimeConfig", () => {
-  it("returns an empty runtime config when the file does not exist", () => {
-    expect(readRuntimeConfig("/tmp/definitely-missing-zinkee-config.toml")).toEqual({
-      profiles: {},
-    });
-  });
-});
-
-describe("resolveProfile", () => {
-  it("prefers explicit profile over default_profile", () => {
-    const config = {
-      defaultProfile: "prod",
-      profiles: {
-        prod: { apiKey: "a" },
-        local: { apiKey: "b", baseUrl: "http://localhost:8088" },
-      },
-    };
-
-    expect(resolveProfile(config, { profile: "local" }).name).toBe("local");
-  });
-
-  it("throws a clear error when the explicit profile is missing", () => {
-    const config = {
-      defaultProfile: "prod",
-      profiles: {
-        prod: { apiKey: "a" },
-      },
-    };
-
-    expect(() => resolveProfile(config, { profile: "local" })).toThrowError(
-      'Profile "local" not found in config.',
-    );
-  });
-
-  it("throws a clear error when no effective profile exists", () => {
-    const config = {
-      profiles: {},
-    };
-
-    expect(() => resolveProfile(config)).toThrowError("No profile could be resolved from config.");
-  });
-});
-
-describe("resolveRuntimeContext", () => {
-  it("applies profile, baseUrl, apiKey, readOnly, and json overrides cleanly", () => {
-    const config = {
-      defaultProfile: "prod",
-      profiles: {
-        prod: { apiKey: "token", baseUrl: "https://api.zinkee.com" },
-        local: { apiKey: "local-token", baseUrl: "http://localhost:8088" },
-      },
-    };
-
-    expect(
-      resolveRuntimeContext(config, {
-        profile: "local",
-        baseUrl: "http://127.0.0.1:8088",
-        apiKey: "override-token",
-        readOnly: true,
-        json: false,
-      }),
-    ).toEqual({
-      profile: "local",
-      baseUrl: "http://127.0.0.1:8088",
-      apiKey: "override-token",
-      readOnly: true,
-      json: false,
-      profileSource: "flag",
-      baseUrlSource: "flag",
-      apiKeySource: "flag",
-    });
-  });
-
-  it("resolves runtime directly from env vars without config", () => {
-    const previousApiKey = process.env[ENV_API_KEY];
-    const previousBaseUrl = process.env[ENV_BASE_URL];
-    const previousProfile = process.env[ENV_PROFILE];
-    process.env[ENV_API_KEY] = "env-token";
-    process.env[ENV_BASE_URL] = "http://localhost:8088/";
-    delete process.env[ENV_PROFILE];
-
-    try {
-      expect(resolveRuntimeContext({ profiles: {} }, {})).toEqual({
-        profile: "runtime",
-        baseUrl: "http://localhost:8088",
-        apiKey: "env-token",
-        readOnly: false,
-        json: false,
-        profileSource: undefined,
-        baseUrlSource: "env",
-        apiKeySource: "env",
-      });
-    } finally {
-      if (previousApiKey === undefined) delete process.env[ENV_API_KEY];
-      else process.env[ENV_API_KEY] = previousApiKey;
-      if (previousBaseUrl === undefined) delete process.env[ENV_BASE_URL];
-      else process.env[ENV_BASE_URL] = previousBaseUrl;
-      if (previousProfile === undefined) delete process.env[ENV_PROFILE];
-      else process.env[ENV_PROFILE] = previousProfile;
-    }
-  });
-
-  it("prefers env vars over config values", () => {
-    const previousApiKey = process.env[ENV_API_KEY];
-    const previousBaseUrl = process.env[ENV_BASE_URL];
-    const previousProfile = process.env[ENV_PROFILE];
-    process.env[ENV_API_KEY] = "env-token";
-    process.env[ENV_BASE_URL] = "http://localhost:8088";
-    process.env[ENV_PROFILE] = "local";
-
-    try {
-      expect(
-        resolveRuntimeContext({
-          defaultProfile: "prod",
-          profiles: {
-            prod: { apiKey: "prod-token", baseUrl: "https://api.zinkee.com" },
-            local: { apiKey: "local-token", baseUrl: "http://127.0.0.1:9999" },
-          },
-        }, {}),
-      ).toEqual({
-        profile: "local",
-        baseUrl: "http://localhost:8088",
-        apiKey: "env-token",
-        readOnly: false,
-        json: false,
-        profileSource: "env",
-        baseUrlSource: "env",
-        apiKeySource: "env",
-      });
-    } finally {
-      if (previousApiKey === undefined) delete process.env[ENV_API_KEY];
-      else process.env[ENV_API_KEY] = previousApiKey;
-      if (previousBaseUrl === undefined) delete process.env[ENV_BASE_URL];
-      else process.env[ENV_BASE_URL] = previousBaseUrl;
-      if (previousProfile === undefined) delete process.env[ENV_PROFILE];
-      else process.env[ENV_PROFILE] = previousProfile;
-    }
-  });
-
-  it("falls back to the production base URL when the resolved profile has no base URL", () => {
-    expect(
-      resolveRuntimeContext({
-        defaultProfile: "prod",
-        profiles: {
-          prod: { apiKey: "prod-token" },
-        },
-      }, {}),
-    ).toEqual({
-      profile: "prod",
-      baseUrl: DEFAULT_PRODUCTION_BASE_URL,
-      apiKey: "prod-token",
-      readOnly: false,
-      json: false,
-      profileSource: "config",
-      baseUrlSource: "config",
-      apiKeySource: "config",
-    });
-  });
-
-  it("still prefers an explicit base URL override over the production fallback", () => {
-    expect(
-      resolveRuntimeContext({
-        defaultProfile: "prod",
-        profiles: {
-          prod: { apiKey: "prod-token" },
-        },
-      }, {
-        profile: "prod",
-        baseUrl: "http://localhost:8088",
-        apiKey: "override-token",
-      }),
-    ).toEqual({
-      profile: "prod",
-      baseUrl: "http://localhost:8088",
-      apiKey: "override-token",
-      readOnly: false,
-      json: false,
-      profileSource: "flag",
-      baseUrlSource: "flag",
-      apiKeySource: "flag",
-    });
-  });
-
-  it("throws a clear error when runtime api key is provided without base url", () => {
-    const previousApiKey = process.env[ENV_API_KEY];
-    const previousBaseUrl = process.env[ENV_BASE_URL];
-    process.env[ENV_API_KEY] = "env-token";
-    delete process.env[ENV_BASE_URL];
-
-    try {
-      expect(() => resolveRuntimeContext({ profiles: {} }, {})).toThrowError(
-        `Runtime API key was provided, but ${ENV_BASE_URL} or --base-url is missing.`,
-      );
-    } finally {
-      if (previousApiKey === undefined) delete process.env[ENV_API_KEY];
-      else process.env[ENV_API_KEY] = previousApiKey;
-      if (previousBaseUrl === undefined) delete process.env[ENV_BASE_URL];
-      else process.env[ENV_BASE_URL] = previousBaseUrl;
-    }
-  });
-
-  it("throws a clear error when runtime base url is provided without api key", () => {
-    const previousApiKey = process.env[ENV_API_KEY];
-    const previousBaseUrl = process.env[ENV_BASE_URL];
-    delete process.env[ENV_API_KEY];
-    process.env[ENV_BASE_URL] = "http://localhost:8088";
-
-    try {
-      expect(() => resolveRuntimeContext({ profiles: {} }, {})).toThrowError(
-        `Runtime base URL was provided, but ${ENV_API_KEY} or --api-key is missing.`,
-      );
-    } finally {
-      if (previousApiKey === undefined) delete process.env[ENV_API_KEY];
-      else process.env[ENV_API_KEY] = previousApiKey;
-      if (previousBaseUrl === undefined) delete process.env[ENV_BASE_URL];
-      else process.env[ENV_BASE_URL] = previousBaseUrl;
-    }
-  });
-
-  it("rejects a --base-url override that is not an absolute http(s) URL", () => {
-    expect(() =>
-      resolveRuntimeContext({ profiles: {} }, { baseUrl: "api-z2.zinkee.com", apiKey: "k" }),
-    ).toThrowError('"--base-url" must be an absolute http(s) URL.');
-
-    expect(() =>
-      resolveRuntimeContext(
-        { profiles: {} },
-        { baseUrl: "ftp://api-z2.zinkee.com", apiKey: "k" },
-      ),
-    ).toThrowError('"--base-url" must be an absolute http(s) URL.');
-  });
-
-  it("normalizes trailing slashes on a --base-url override", () => {
-    expect(
-      resolveRuntimeContext(
-        { profiles: {} },
-        { baseUrl: "https://api-z2.zinkee.com///", apiKey: "k" },
-      ).baseUrl,
-    ).toBe("https://api-z2.zinkee.com");
-  });
-});
-
-describe("env readers", () => {
-  it("normalizes env values", () => {
-    expect(readEnvApiKey({ [ENV_API_KEY]: " token " } as NodeJS.ProcessEnv)).toBe("token");
-    expect(readEnvProfile({ [ENV_PROFILE]: " local " } as NodeJS.ProcessEnv)).toBe("local");
-    expect(readEnvBaseUrl({ [ENV_BASE_URL]: " http://localhost:8088/ " } as NodeJS.ProcessEnv)).toBe(
-      "http://localhost:8088",
-    );
-  });
-});
-
-describe("config mutation helpers", () => {
-  it("serializes updates back to the legacy TOML shape", () => {
-    const nextConfig = setDefaultProfile(
-      setProfileConfig(
-        {
-          profiles: {},
-        },
-        "local",
-        {
-          apiKey: "token",
-          baseUrl: "http://localhost:8088",
-        },
-      ),
-      "local",
-    );
-
-    expect(serializeConfig(nextConfig)).toContain('default_profile = "local"');
-    expect(serializeConfig(nextConfig)).toContain('[profiles.local]');
-    expect(serializeConfig(nextConfig)).toContain('api_key = "token"');
-    expect(serializeConfig(nextConfig)).toContain('base_url = "http://localhost:8088"');
-  });
-
-  it("removes a deleted default profile cleanly", () => {
-    const config = {
-      defaultProfile: "prod",
-      profiles: {
-        prod: { apiKey: "token" },
-        local: { apiKey: "other" },
-      },
-    };
-
-    expect(removeProfileConfig(config, "prod")).toEqual({
-      defaultProfile: undefined,
-      profiles: {
-        local: { apiKey: "other" },
-      },
-    });
-  });
-});
-
-describe("redaction helpers", () => {
-  it("redacts secrets while keeping the last four characters", () => {
-    expect(redactSecret("secret-token-1234")).toBe("********1234");
-    expect(redactSecret("abc")).toBe("********");
-  });
-
-  it("redacts config output without mutating other fields", () => {
-    expect(
-      redactConfig({
-        defaultProfile: "prod",
-        profiles: {
-          prod: {
-            apiKey: "secret-token-1234",
-            baseUrl: "https://api.zinkee.test",
-            retry_count: 3,
-          },
-        },
-      }),
-    ).toEqual({
-      defaultProfile: "prod",
-      profiles: {
-        prod: {
-          apiKey: "********1234",
-          baseUrl: "https://api.zinkee.test",
-          retry_count: 3,
-        },
-      },
-    });
-  });
-});