@shardflux/cli 0.4.0 → 0.5.0

package/dist/commands.d.ts

@@ -1,5 +1,8 @@
-import type { RunResult, Shardflux, Workspace } from '@shardflux/sdk';
+import type { AccountClientOptions, RunResult, Shardflux, ShardfluxAccount, Workspace } from '@shardflux/sdk';
 import type { Values } from './args.js';
+import type { CredentialStore, StoredApiKey, StoredSession } from './credentials.js';
+import type { Input, StdinLike } from './input.js';
+import type { Distribution, UpdateView } from './update-check.js';
 import type { TimingRecorder } from './timing.js';
 export interface Writer {
     write(chunk: string | Uint8Array): boolean;
@@ -7,11 +10,17 @@ export interface Writer {
 export interface Io {
     stdout: Writer;
     stderr: Writer;
-    stdin: AsyncIterable<Buffer | string> & {
-        isTTY?: boolean;
-    };
+    /** Data for files/secrets, and passwords (piped lines, or a no-echo prompt when it is a terminal with setRawMode). */
+    stdin: StdinLike;
     env: Record<string, string | undefined>;
 }
+/** The project API key in use and where it came from. */
+export interface ResolvedApiKey {
+    token: string;
+    source: 'env' | 'file';
+    /** The saved key's metadata, when it came from the credentials file. */
+    saved?: StoredApiKey;
+}
 export interface Ctx {
     io: Io;
     json: boolean;
@@ -26,15 +35,68 @@ export interface Ctx {
     timing: boolean;
     /** Timings and the last observed operation of the traced SDK calls this command made (the client's onProgress). */
     traces: TimingRecorder;
+    /** The project API key client: SHARDFLUX_API_KEY, else the key saved for this API URL (`shard setup`). */
     cloud(): Shardflux;
+    /** The project API key without building a client (throws AuthConfigError when there is none). */
+    apiKey(): ResolvedApiKey;
+    /** The user session client: SHARDFLUX_SESSION_TOKEN, else the saved session (`shard auth login`). Rotations are saved. */
+    account(): ShardfluxAccount;
+    /** Where a session would come from, without loading it: 'env', 'file' or null (signed out). */
+    sessionSource(): 'env' | 'file' | null;
+    /** Client options for the SDK's pre-session calls (register, verify, login, reset): this API URL, fetch, user agent. */
+    accountOptions(): AccountClientOptions;
+    /**
+     * Saves a new session for this API URL. When it belongs to another person than the saved one (another user id, or
+     * `email` for a sign-in still waiting for its code), their default organization, project and key are dropped.
+     */
+    saveSession(session: StoredSession, email?: string): {
+        replaced: StoredSession | null;
+        switched: boolean;
+    };
+    /** A credential this command received (redacted from error output). */
+    addSecret(value: string): void;
+    /** The update status for `shard version` (forced: ask the API now). Null when unknown. */
+    versionStatus(force: boolean): Promise<UpdateView | null>;
+    /** The credentials file (config directory from the environment). */
+    store: CredentialStore;
+    /** Passwords and codes: piped lines, or no-echo prompts on a terminal. */
+    input: Input;
+    /** The package that runs the CLI (the version check's identity). */
+    distribution: Distribution;
+    /** This machine's name (default API key name of `shard setup`). */
+    hostname(): string;
 }
 export type Handler = (ctx: Ctx, values: Values, positionals: string[]) => Promise<number>;
+export declare const str: (v: Values[string]) => string | undefined;
+export declare const strs: (v: Values[string]) => string[];
+export declare function out(ctx: Ctx, human: string, machine: unknown): void;
+export declare function waitTimeout(values: Values): number;
 /**
  * `<id|key>`: a UUID is tried as an id first; anything else (or an unknown UUID) as an exact workspace key, across every
  * lifetime and purpose (sessions, drafts and test instances are hidden from the default list), preferring the live
  * workspace over tombstones of ended sessions that had the same key (contracts §19.11).
  */
 export declare function resolveWorkspace(ctx: Ctx, ref: string): Promise<Workspace>;
+export declare function oneOf<T extends string>(values: Values, option: string, allowed: readonly T[]): T | undefined;
+export declare function listLimit(values: Values, max: number): number | undefined;
+/** `<slug>@<version>`. */
+export declare function parseSlugVersion(text: string, what: string): {
+    slug: string;
+    version: number;
+};
+export declare function fileExists(path: string): Promise<boolean>;
+export declare function readInput(ctx: Ctx, source: string, max: number, what: string): Promise<Uint8Array>;
+export declare function principal(ctx: Ctx): Promise<{
+    api_url: string;
+    organization_id: string;
+    project_id: string;
+    api_key: {
+        id: string;
+        key_id: string;
+    };
+    tool_permissions: ("git" | "exec" | "files" | "pty" | "process" | "browser")[];
+}>;
 /** The exit code `shard exec` returns for a finished command. */
 export declare function execExitCode(r: Pick<RunResult, 'exitCode' | 'termSignal' | 'timedOut'>): number;
-export declare const HANDLERS: Record<string, Handler>;
+/** The project-key commands; handlers.ts adds the account plane's. */
+export declare const KEY_HANDLERS: Record<string, Handler>;