sim 2.1.18-dev.133.1 → 2.1.18

package/dist/telemetry/client-info.d.ts

@@ -1,20 +0,0 @@
-/**
- * The `X-Sim-Client-Info` value: the same facts as the user agent, in the
- * header every official client sends, plus the AI coding agent driving this
- * shell (`none` when none is detected). The server reads this header, not the user
- * agent, so a request from the CLI is attributed to the CLI on every log line
- * and analytics event it produces.
- *
- * The agent is usage data, so it goes only where usage reporting is allowed:
- * `DO_NOT_TRACK`, `SIM_TELEMETRY_DISABLED`, and `sim telemetry disable` all
- * withhold it. Whether this build has a reporting destination is irrelevant —
- * the server, not the CLI, is what records it. Computed once per process.
- */
-export declare function clientInfoHeader(env?: NodeJS.ProcessEnv): string;
-/**
- * The headers that identify the CLI on every request it makes to a Sim
- * deployment: the user agent and `X-Sim-Client-Info`. One definition, so the
- * API client and the login flows cannot drift into identifying themselves
- * differently.
- */
-export declare function identityHeaders(): Record<string, string>;

package/dist/telemetry/coding-agent.d.ts

@@ -1,31 +0,0 @@
-/**
- * Detects the AI coding agent whose shell this process runs in.
- *
- * Agents mark the shells they spawn with an environment variable, and the CLI
- * reports that mark so usage driven by an agent can be told apart from a person
- * at a terminal. The checks, their order, and the names follow the GitHub CLI's
- * `internal/agents/detect.go` exactly: the generic `AI_AGENT` declaration
- * first, then vendor markers, with a more specific agent ahead of a broader
- * marker it also sets (Amp and Cowork both set `CLAUDECODE`).
- *
- * Four of that table's signals are deliberately left out, each one the GitHub
- * CLI itself marks as low confidence: `REPL_ID` (present in every Replit
- * environment), `GOOSE_PROVIDER` (Goose is merely configured),
- * `TERM_PROGRAM=kiro` (Kiro's terminal, which a person uses too), and a
- * `.pi/agent` entry on `PATH`. Each describes where a person is working rather
- * than an agent driving the command, so reporting it would attribute that
- * person's own commands to an agent.
- */
-/**
- * What the CLI reports when no agent is detected: a person at a terminal, or a
- * script. Sent explicitly so that an absent value means only that the client
- * did not report one — an older release, or reporting turned off.
- */
-export declare const NO_CODING_AGENT = "none";
-/**
- * The agent driving this shell, or `undefined` for a person at a terminal.
- *
- * `AI_AGENT` is the generic convention agents use to name themselves, and wins
- * over every vendor marker when it holds a well-formed name.
- */
-export declare function detectCodingAgent(env?: NodeJS.ProcessEnv): string | undefined;

package/dist/telemetry/index.d.ts

@@ -1,4 +0,0 @@
-export { createCommandTelemetry } from './invocation';
-export { DO_NOT_TRACK_VARIABLE, TELEMETRY_DISABLED_VARIABLE, type TelemetryStatus, telemetryStatus, } from './policy';
-export { loadTelemetryState, readTelemetryState, writeTelemetryState } from './state';
-export { builtInIngestTarget } from './transport';

package/dist/telemetry/invocation.d.ts

@@ -1,98 +0,0 @@
-import type { Command } from 'commander';
-import { type IngestTarget, sendCapture } from './transport';
-/**
- * Usage reporting for one CLI invocation: what ran, whether it worked, and
- * how long it took. One event per command, sent after the command finishes.
- *
- * What is sent is the smallest set that answers "how is the CLI used": the
- * command's name, the names of the flags typed, how many positional arguments
- * there were, the exit code, the duration, and the runtime it ran on. What is
- * never sent is anything the user typed — no argument values, flag values,
- * paths, or error messages — matching the policy the Stripe, GitHub, and
- * Supabase CLIs converge on. See {@link CommandEventProperties}.
- */
-export declare const COMMAND_EVENT = "cli_command_executed";
-/** The user-facing name of this reporting, as `$lib` in each event. */
-declare const LIBRARY_NAME = "sim-cli";
-export declare const USAGE_DATA_DOCS_URL = "https://docs.sim.ai/cli/usage-data";
-/**
- * Printed once, the first time reporting would happen on an interactive
- * terminal, the way the Vercel and Next.js notices are. The run that shows it
- * is not reported, so nothing leaves the machine before the user has read
- * that something will.
- */
-export declare const FIRST_RUN_NOTICE: string;
-/**
- * The event's properties. Kept in one place so the documentation page can be
- * checked against it and a new property is a deliberate addition here.
- */
-export interface CommandEventProperties {
-    /** Analytics library conventions: the reporting client and its version. */
-    $lib: typeof LIBRARY_NAME;
-    $lib_version: string;
-    /** Events are anonymous and must not create a person profile per device. */
-    $process_person_profile: false;
-    /** Commands close in time share a session, so a sequence of commands can be read back. */
-    $session_id: string;
-    /** The command's position within its session. */
-    session_sequence: number;
-    /** The same surface name the server stamps on requests carrying `X-Sim-Client-Info`. */
-    surface: 'cli';
-    /** The command's path, such as `workflows list` — never its arguments. */
-    command: string;
-    /** The long names of flags that were typed, such as `--output`; never their values. */
-    flags: string[];
-    /** How many positional arguments were given; never what they were. */
-    arg_count: number;
-    exit_code: number;
-    /** Time from process start to completion, in milliseconds. */
-    duration_ms: number;
-    /** The failure's class name, such as `SimApiError`; never its message. */
-    error_name?: string;
-    /** The API's machine-readable error code, such as `NOT_FOUND`. */
-    error_code?: string;
-    http_status?: number;
-    cli_version: string;
-    node_version: string;
-    os: string;
-    arch: string;
-    /** Whether stdout was a terminal, which separates people from scripts. */
-    is_tty: boolean;
-    is_ci: boolean;
-    /** The AI coding agent driving this shell, or `none` when none was detected. */
-    coding_agent: string;
-    /** Whether the profile targets Sim's hosted deployment or a self-hosted one; never the address. */
-    endpoint_kind?: 'hosted' | 'self_hosted';
-}
-export interface InvocationOutcome {
-    exitCode: number;
-    error?: unknown;
-}
-export interface CommandTelemetryOptions {
-    env?: NodeJS.ProcessEnv;
-    ingestTarget?: () => IngestTarget | undefined;
-    send?: typeof sendCapture;
-    now?: () => Date;
-    /** Milliseconds since the process started, for the duration. */
-    elapsed?: () => number;
-    /** Whether stdout is a terminal: the `is_tty` property, which separates people from scripts. */
-    stdoutIsTty?: boolean;
-    /** Whether stderr is a terminal: where the notice would go, so whether anyone would see it. */
-    stderrIsTty?: boolean;
-    /** Where the first-run notice goes; stderr, so piped output stays clean. */
-    write?: (message: string) => void;
-    /** Registers the listener that reports when the process ends; the real process by default. */
-    onExit?: (listener: (exitCode: number) => void) => void;
-}
-export interface CommandTelemetry {
-    /** Installs the hook that records which command is about to run, and the exit listener that reports it. */
-    observe(program: Command): void;
-    /**
-     * Reports the recorded command, given how it ended. Idempotent, and a no-op
-     * when nothing was recorded: the entrypoint calls it with the failure it
-     * explained, and the exit listener calls it for every other way out.
-     */
-    complete(outcome: InvocationOutcome): void;
-}
-export declare function createCommandTelemetry(options?: CommandTelemetryOptions): CommandTelemetry;
-export {};

package/dist/telemetry/policy.d.ts

@@ -1,38 +0,0 @@
-import type { TelemetryState } from './state';
-/**
- * The switch every CLI that reports usage honours before its own: `DO_NOT_TRACK=1`
- * expresses a lack of consent to any usage reporting, from any tool. Spec at
- * consoledonottrack.com; `true` is accepted as well, as Turborepo, Wrangler,
- * and the GitHub CLI do.
- */
-export declare const DO_NOT_TRACK_VARIABLE = "DO_NOT_TRACK";
-/** The CLI's own switch, for turning reporting off in one environment or CI job. */
-export declare const TELEMETRY_DISABLED_VARIABLE = "SIM_TELEMETRY_DISABLED";
-export type TelemetryDisabledReason = 
-/** `DO_NOT_TRACK` is set. */
-'do_not_track'
-/** `SIM_TELEMETRY_DISABLED` is set. */
- | 'environment'
-/** The user ran `sim telemetry disable`. */
- | 'setting'
-/** This build was made without a reporting destination, so there is nowhere to send to. */
- | 'unconfigured';
-export type TelemetryStatus = {
-    enabled: true;
-} | {
-    enabled: false;
-    reason: TelemetryDisabledReason;
-};
-export interface TelemetryStatusInput {
-    env: NodeJS.ProcessEnv;
-    state: Pick<TelemetryState, 'enabled'>;
-    /** Whether the build carries a reporting destination. */
-    configured: boolean;
-}
-/**
- * Whether usage reporting is on, and if not, the first reason that turns it
- * off. The order is the order of authority: the universal opt-out, then the
- * environment, then the saved setting, then whether this build can report at
- * all — so `sim telemetry status` names the reason the user can act on.
- */
-export declare function telemetryStatus({ env, state, configured }: TelemetryStatusInput): TelemetryStatus;

package/dist/telemetry/state.d.ts

@@ -1,47 +0,0 @@
-/**
- * Two commands closer together than this belong to one session, the way the
- * Vercel and Supabase CLIs group them. Far above a person's pause between
- * commands and far below a lunch break, so a session reads as one sitting.
- */
-export declare const SESSION_IDLE_MS: number;
-declare const STATE_VERSION = 1;
-export interface TelemetrySession {
-    id: string;
-    /** When the last command in this session ran, for the idle cutoff. */
-    lastActiveAt: string;
-    /** Commands recorded in this session so far; the next one is `sequence + 1`. */
-    sequence: number;
-}
-export interface TelemetryState {
-    /** Unknown versions are treated as absent. */
-    version: typeof STATE_VERSION;
-    /**
-     * A random id for this installation, minted the first time telemetry runs.
-     * It ties one device's commands together and nothing else: it is not derived
-     * from hardware, the account, or the network.
-     */
-    deviceId: string;
-    /** `false` after `sim telemetry disable`; absent or `true` otherwise. */
-    enabled?: boolean;
-    /** When the first-run notice was printed; absent until it has been. */
-    noticeShownAt?: string;
-    session?: TelemetrySession;
-}
-/**
- * The persisted state, or `null` when there is none worth trusting.
- *
- * Validated field by field: the file is the user's to edit or corrupt, and a
- * document that fails validation is replaced rather than repaired, so a bad
- * `deviceId` never leaks into an event.
- */
-export declare function readTelemetryState(path?: string): TelemetryState | null;
-/** The persisted state, or a fresh one when there is none. */
-export declare function loadTelemetryState(path?: string): TelemetryState;
-export declare function writeTelemetryState(state: TelemetryState, path?: string): void;
-/**
- * The session the next command belongs to: the current one, advanced by one,
- * when it was active within {@link SESSION_IDLE_MS}; otherwise a new one. A
- * clock that moved backwards reads as idle, which only starts a new session.
- */
-export declare function nextSession(state: TelemetryState, now: Date): TelemetrySession;
-export {};

package/dist/telemetry/transport.d.ts

@@ -1,47 +0,0 @@
-import { type ChildProcess } from 'node:child_process';
-export declare const DEFAULT_INGEST_HOST = "https://us.i.posthog.com";
-export interface IngestTarget {
-    key: string;
-    host: string;
-}
-/**
- * The destination this build was made with, if any. The key is a PostHog
- * project token — a public, write-only value — baked into the published build
- * by `bun build --env='SIM_CLI_TELEMETRY_*'` the way the Supabase CLI injects
- * its own at link time. A checkout built without one has no destination and
- * reports nothing, and a self-hosted deployment can point its own build at its
- * own project.
- *
- * Both reads must stay literal `process.env.<NAME>` expressions, the only form
- * the bundler substitutes. They are made on each call rather than at module
- * load so that, unbundled, the answer follows the environment a caller set.
- */
-export declare function builtInIngestTarget(): IngestTarget | undefined;
-/** One event in the shape PostHog's capture endpoint accepts. */
-export interface CaptureRequest<Properties extends object = Record<string, unknown>> {
-    api_key: string;
-    event: string;
-    distinct_id: string;
-    timestamp: string;
-    properties: Properties;
-}
-export type SpawnSender = (command: string, args: readonly string[], options: {
-    detached: boolean;
-    env: NodeJS.ProcessEnv;
-    stdio: 'ignore';
-    windowsHide: boolean;
-}) => Pick<ChildProcess, 'unref' | 'once'>;
-/**
- * Sends one event from a process whose lifetime is its own.
- *
- * The command has finished and the user has their prompt back; nothing about
- * delivery should change that. An in-process request would keep the event loop
- * alive for as long as the network took to answer — a DNS lookup on a dead
- * network cannot be cancelled at all — so the request is made by a detached
- * child that the parent does not wait for, the way the GitHub and Vercel CLIs
- * send theirs. The child bounds its own life with a deadline. The request
- * travels in the child's environment rather than on argv because the
- * environment is handed over at spawn time, so the parent can exit at once
- * without a pipe left half-written.
- */
-export declare function sendCapture(target: IngestTarget, request: CaptureRequest<object>, spawnSender?: SpawnSender): void;

package/dist/terminal/secret-input.d.ts

@@ -1,15 +0,0 @@
-import type { ReadStream } from 'node:tty';
-import { SimApiError } from '../http/client';
-/**
- * Raised when the user abandons the prompt with Ctrl-C or Ctrl-D, so the caller
- * can exit 130 rather than folding an abort into the generic failure code.
- */
-export declare class SecretInputCancelledError extends SimApiError {
-    constructor();
-}
-interface SecretOutput {
-    write(value: string): unknown;
-}
-/** Reads a secret from a TTY while rendering one mask character per entered character. */
-export declare function promptSecret(input?: ReadStream, output?: SecretOutput): Promise<string>;
-export {};

package/dist/terminal.d.ts

@@ -1,7 +0,0 @@
-import type { Command } from 'commander';
-/**
- * Anything the CLI can explain prints as one line and exits with its code. A
- * failure is reported here, where its class and code are known; every other
- * way the process ends is reported from the exit listener telemetry installs.
- */
-export declare function runTerminalCli(suppliedProgram?: Command): Promise<void>;

package/dist/transfer/local-file.d.ts

@@ -1,16 +0,0 @@
-import { type EmbedContext } from '../embed-context';
-/** Both positional file spellings address the caller's same path. */
-export declare function embeddedFileKey(path: string): string;
-/**
- * An embedded run executes in-process on the hosting server, so a positional path must
- * never reach the server's filesystem. Only the caller-provided file reader may
- * resolve it; missing capabilities and read failures stay explicit.
- */
-export declare function embeddedFileContent(embedded: EmbedContext, path: string): Promise<string | Uint8Array<ArrayBuffer>>;
-export declare function contentTypeFor(name: string): string;
-export interface LocalFile {
-    name: string;
-    size: number;
-}
-/** Validates the size and name shared by every local-file transfer. */
-export declare function localFile(path: string, override?: string): Promise<LocalFile>;

package/dist/transfer/streaming-upload.d.ts

@@ -1,16 +0,0 @@
-/** One forward-only file stream shared by a PUT or successive multipart requests. */
-export declare class StreamingUpload {
-    private readonly size;
-    private position;
-    private pending;
-    private closed;
-    private readonly reader;
-    private readonly onAbort;
-    private readonly stopped;
-    readonly signal: AbortSignal;
-    constructor(stream: ReadableStream<Uint8Array>, size: number, signal?: AbortSignal);
-    slice(start: number, end: number): ReadableStream<Uint8Array>;
-    assertConsumed(end: number): void;
-    verifyComplete(): Promise<void>;
-    close(): Promise<void>;
-}

package/dist/transfer/upload-session.d.ts

@@ -1,18 +0,0 @@
-import { SimClient } from '../http/client';
-export type UploadTransfer = {
-    method: 'put';
-    url: string;
-    headers: Record<string, string>;
-} | {
-    method: 'multipart';
-    partSize: number;
-    partCount: number;
-};
-export interface UploadSession {
-    basePath: string;
-    uploadToken: string;
-    transfer: UploadTransfer;
-    size: number;
-}
-/** Uploads and completes a signed transfer, aborting its session if the transfer fails. */
-export declare function finishUploadSession<T>(client: SimClient, workspaceId: string, session: UploadSession, path: string): Promise<T>;

package/dist/update/check.d.ts

@@ -1,53 +0,0 @@
-/**
- * The once-a-day "there is a newer sim" notice.
- *
- * It exists because a missing subcommand is indistinguishable from a feature
- * that was never built: someone on 2.1.2 looking for `sim tools execute` — added
- * in 2.1.5 — sees a help listing without it and concludes the CLI cannot do it.
- * The version is the only thing that can tell them otherwise.
- *
- * Registry and cache failures suppress the courtesy notice. Installation only
- * happens when the user explicitly runs `sim update`.
- */
-export interface UpdateCheckOptions {
-    /** Current working directory. Injected so project-local installation detection is testable. */
-    cwd?: string;
-    currentVersion?: string;
-    env?: NodeJS.ProcessEnv;
-    /** Whether stderr is a terminal. Injected so the suppression rule is testable. */
-    isTty?: boolean;
-    /** Location of the running module, used to recognise npx and local builds. */
-    modulePath?: string;
-    now?: Date;
-    /** Registry transport. Injectable so network behavior can be tested without global state. */
-    registryRequest?: RegistryRequest;
-    write?: (message: string) => void;
-}
-interface RegistryRequestOptions {
-    headers: Record<string, string>;
-    maxResponseBytes: number;
-    timeoutMs: number;
-}
-type RegistryRequest = (url: URL, options: RegistryRequestOptions) => Promise<string | null>;
-/**
- * The command that upgrades *this* installation.
- *
- * The path is asked first because it describes the installation; the
- * environment is a fallback because for a globally installed CLI it usually
- * describes nothing but the shell that happened to invoke it.
- */
-export declare function upgradeCommand(modulePath?: string, env?: NodeJS.ProcessEnv): string;
-/**
- * Uses a daily cache before telling the user their installation is out of date.
- *
- * Wired as a root `preAction` hook rather than a teardown in the entrypoint for
- * two structural reasons: commander answers `--help` and `--version` during
- * parsing, before any action hook runs, so the two most latency-sensitive
- * invocations are excluded by construction rather than by a check; and some
- * commands call `process.exit` directly, which a `finally` would never see.
- *
- * Never throws, writes only plain text to stderr, and stays silent when stderr
- * is redirected. The caller runs this before the user's actual command.
- */
-export declare function announceUpdateIfAvailable(options?: UpdateCheckOptions): Promise<void>;
-export {};

package/dist/update/install.d.ts

@@ -1,20 +0,0 @@
-export declare class CliUpdateError extends Error {
-}
-declare const PACKAGE_MANAGERS: readonly ['npm', 'pnpm', 'bun', 'yarn'];
-export type PackageManager = (typeof PACKAGE_MANAGERS)[number];
-interface PackageManagerOptions {
-    env: NodeJS.ProcessEnv;
-    capture: boolean;
-}
-type RunPackageManager = (manager: PackageManager, args: string[], options: PackageManagerOptions) => Promise<string>;
-interface InstallUpdateOptions {
-    modulePath?: string;
-    env?: NodeJS.ProcessEnv;
-    currentVersion?: string;
-    packageManager?: PackageManager;
-    run?: RunPackageManager;
-    write?: (message: string) => void;
-}
-/** Updates the verified global installation and reports the version actually installed. */
-export declare function installUpdate(options?: InstallUpdateOptions): Promise<void>;
-export {};

package/dist/version.d.ts

@@ -1,10 +0,0 @@
-export declare function cliVersion(): string;
-/**
- * Identifies the CLI to the API, the way every other terminal client does.
- *
- * Without it a CLI request is indistinguishable from any other API traffic, so
- * a bug that only reproduces on one CLI version cannot be found in the server's
- * own logs. The runtime and platform ride along for the same reason: they are
- * the first things asked about a transport failure that only some users see.
- */
-export declare function userAgent(): string;