windows-development-sandbox 1.9.0 → 1.11.3

package/dist/cli/commands/storage/storage.js

@@ -1,179 +0,0 @@
-// `sandbox storage`: where everything kept between sandboxes lives, moving it to another folder (with the size, an
-// estimate and a warning first) and switching to a folder without moving. The work is in host/storage.
-import fs from 'node:fs';
-import path from 'node:path';
-import { userConfigPath, userDir } from '../../../core/config/index.js';
-import { diskUsage, humanBytes } from '../../../core/disk.js';
-import { askChoice, askName, askRequired } from '../../../core/prompt.js';
-import { expandPath, fail } from '../../../core/util/index.js';
-import { describeDuration, describeSize, estimate, holdsData, measureFolder, mountedSets, moveWarning, otherDataFolders, sharedDefaultRoot, StorageHistory, StorageMove, } from '../../../host/storage/index.js';
-import { isSandboxRunning } from '../../../host/sandbox/index.js';
-import { protectPrivateFolder } from '../../../host/sharing/index.js';
-import { watcherRunning } from '../../../sync/index.js';
-import { printJson, working } from '../../output/index.js';
-import { requireOnPc } from '../context.js';
-import { contained } from './contained.js';
-/** Why a move cannot start (a background sync is still on a data folder in the old storage), or null. */
-export function storageBusy(root) {
-    const mounted = mountedSets(root);
-    if (mounted.length > 0)
-        return ('The contained storage of "' +
-            mounted.join('", "') +
-            '" is mounted (a disk image; moving now would reach into it).');
-    const data = path.join(root, 'data');
-    try {
-        for (const name of fs.readdirSync(data))
-            if (watcherRunning(path.join(data, name)))
-                return 'The background sync of "' + name + '" is still finishing.';
-    }
-    catch {
-        // no data folder: nothing runs
-    }
-    return null;
-}
-function mover(ctx) {
-    return new StorageMove(ctx.loaded.configPath ?? userConfigPath(), () => storageBusy(ctx.storageRoot), isSandboxRunning, protectPrivateFolder);
-}
-/** The path as typed (variables and ~ expand, relative to the current folder). */
-function typedPath(value) {
-    return expandPath(value, process.cwd());
-}
-/** The folder typed, or picked from the default folder, folders that hold data and the drives (or typed in). */
-async function folderOf(ctx, value, what) {
-    if (value)
-        return typedPath(value);
-    const fix = 'Use: sandbox storage ' + what + ' <folder>';
-    const typed = 'type';
-    const known = [sharedDefaultRoot(), ...otherDataFolders(ctx.storageRoot, new StorageHistory(userDir()))];
-    const drives = diskUsage(ctx.storageRoot)
-        .filter((d) => !d.holdsStorage)
-        .map((d) => path.join(d.drive, 'AgentSandbox'));
-    const choices = [...new Set([...known, ...drives])]
-        .filter((f) => f.toLowerCase() !== ctx.storageRoot.toLowerCase())
-        .map((f) => ({ name: f, value: f }));
-    const picked = await askChoice('Which folder?', [...choices, { name: 'Type a path...', value: typed }], fix);
-    if (picked !== typed)
-        return picked;
-    const answer = await askName('Folder:', fix, (v) => v.length > 0 || 'Type a folder path.');
-    return typedPath(answer);
-}
-async function show(ctx) {
-    const history = new StorageHistory(userDir());
-    const measured = await working('Measuring your saved data (big folders take a moment)', () => measureFolder(ctx.storageRoot), !ctx.options.json);
-    const others = otherDataFolders(ctx.storageRoot, history);
-    const shared = sharedDefaultRoot();
-    if (printJson(ctx, {
-        root: ctx.storageRoot,
-        exists: fs.existsSync(ctx.storageRoot),
-        ...measured,
-        defaultRoot: shared,
-        otherFoldersWithData: others,
-    }))
-        return 0;
-    const inUse = shared.toLowerCase() === ctx.storageRoot.toLowerCase() ? ' (in use)' : '';
-    console.log('Your saved data is in: ' + ctx.storageRoot);
-    console.log('  ' + (holdsData(ctx.storageRoot) ? describeSize(measured) : 'nothing in it yet'));
-    console.log('The default folder is: ' + shared + inUse);
-    for (const other of others)
-        console.log('Another folder with data: ' + other);
-    console.log('\nMove it with: sandbox storage move <folder>  (or switch without moving: sandbox storage use <folder>)');
-    console.log('What takes the space: sandbox data');
-    return 0;
-}
-function printPlan(from, to, measured, copyOnly) {
-    const est = estimate(from, to, measured, copyOnly);
-    const time = est.sameVolume
-        ? 'a few seconds (same drive, nothing is copied)'
-        : describeDuration(est.seconds) + ' (copied to another drive)';
-    console.log('Move from: ' + from);
-    console.log('       to: ' + to);
-    console.log('     size: ' + describeSize(measured));
-    console.log('     time: ' + time);
-    const warning = moveWarning(measured, est);
-    if (warning)
-        console.log('Warning: ' + warning);
-    if (!est.fits)
-        fail('Not enough free space on the target drive.', 'Free some space or pick another drive.');
-}
-/** Moves the data with progress on the terminal; remembers both folders. Used by the command and the start offer. */
-export async function performMove(ctx, to, keepOld) {
-    const from = ctx.storageRoot;
-    const history = new StorageHistory(userDir());
-    let line = 'Moving your data';
-    const result = await working(() => line, () => mover(ctx).move(from, to, {
-        keepOld,
-        onProgress: (p) => {
-            line = 'Copying: ' + p.files.toLocaleString('en-US') + ' files, ' + humanBytes(p.bytes);
-        },
-    }));
-    history.remember(from);
-    history.remember(to);
-    return result;
-}
-async function move(ctx) {
-    const to = await folderOf(ctx, ctx.options.positionals[1], 'move');
-    const from = ctx.storageRoot;
-    if (!fs.existsSync(from))
-        fail('There is nothing to move: ' + from + ' does not exist.', 'Use sandbox storage use ' + to + ' to switch.');
-    mover(ctx).validate(from, to);
-    const measured = await working('Measuring your saved data', () => measureFolder(from), !ctx.options.json);
-    const keepOld = ctx.options.keepOld;
-    printPlan(from, to, measured, keepOld);
-    if (!ctx.options.yes) {
-        if (!(await askRequired('Move your data to ' + to + '?', 'Add --yes to move without asking.', true))) {
-            console.log('Nothing was moved.');
-            return 1;
-        }
-    }
-    const result = await performMove(ctx, to, keepOld);
-    if (printJson(ctx, result))
-        return 0;
-    const left = result.removedOld ? '' : '; the old folder is still at ' + result.from;
-    console.log('Moved ' + result.files.toLocaleString('en-US') + ' files. Your data is now in ' + result.to + left + '.');
-    for (const note of result.notes)
-        console.log(note);
-    console.log('Your settings now point to ' + result.pinned + ', so older versions find the data too.');
-    return 0;
-}
-async function use(ctx) {
-    const to = await folderOf(ctx, ctx.options.positionals[1], 'use');
-    if (to.toLowerCase() === ctx.storageRoot.toLowerCase()) {
-        console.log('That folder is in use already.');
-        return 0;
-    }
-    const busy = storageBusy(ctx.storageRoot);
-    if (busy)
-        fail(busy, 'Wait a minute, then try again.');
-    const state = holdsData(to)
-        ? to + ' is used as it is.'
-        : to + ' starts empty: tools, logins and history are set up again.';
-    console.log('Warning: your data stays in ' + ctx.storageRoot + '. ' + state);
-    if (!ctx.options.yes) {
-        if (!(await askRequired('Use ' + to + ' from now on, without moving your data?', 'Add --yes to switch without asking.'))) {
-            console.log('Nothing was changed.');
-            return 1;
-        }
-    }
-    new StorageHistory(userDir()).remember(ctx.storageRoot);
-    mover(ctx).pin(to);
-    console.log('Your data is now looked for in ' + to + '. Move it later with: sandbox storage move <folder>');
-    return 0;
-}
-/** `sandbox storage [show|move <folder>|use <folder>]`. */
-export function storage(ctx) {
-    requireOnPc('storage');
-    const [action = 'show'] = ctx.options.positionals;
-    switch (action) {
-        case 'show':
-        case 'info':
-            return show(ctx);
-        case 'move':
-            return move(ctx);
-        case 'use':
-            return use(ctx);
-        case 'contained':
-            return contained(ctx);
-        default:
-            return fail('Unknown storage action "' + action + '".', 'Use: sandbox storage, sandbox storage move <folder>, sandbox storage use <folder> or sandbox storage contained on|off|status');
-    }
-}

package/dist/cli/menu/add-agent.d.ts

@@ -1,47 +0,0 @@
-import type { Harness } from '../../core/types.js';
-import type { App } from '../tui/index.js';
-import type { ConfigFile } from '../../app/features/settings/index.js';
-import type { Draft } from './settings/draft.js';
-/** How a new agent gets into the sandbox. */
-export type AgentSource = 'npm' | 'uv' | 'host';
-/** Nothing wrong with the name (true), or what is wrong. Pure. */
-export declare function agentNameProblem(name: string, taken: readonly string[]): true | string;
-/** The command a package usually provides: "@scope/my-agent@latest" gives "my-agent". Pure. */
-export declare function commandFromPackage(pkg: string): string;
-/** The config entry for a new agent. Pure. */
-export declare function newAgent(source: AgentSource, what: string, command: string, hostDir?: string): Harness;
-/** What `harnesses` should say with `name` taken out. Pure. */
-export declare function withoutAgent(current: unknown, name: string): Record<string, unknown>;
-/** Writes a setting to your config file now, or adds it to the unsaved changes when it has some already. */
-export declare function writeOrStage(file: ConfigFile, draft: Draft, key: string[], value: unknown): {
-    saved: boolean;
-};
-/** What `harnesses` should say with `name` added to what is staged or in the file now. Pure. */
-export declare function withAgent(current: unknown, name: string, harness: Harness): Record<string, unknown>;
-/** Makes `name` the agent that starts by default (written now, or joined to unsaved changes to that setting). */
-export declare function makeDefaultAgent(file: ConfigFile, draft: Draft, name: string): {
-    saved: boolean;
-};
-/** Takes an agent you added out of your settings (the built-in ones are not removable). */
-export declare function removeAgent(file: ConfigFile, draft: Draft, name: string): {
-    saved: boolean;
-};
-export interface AddedAgent {
-    readonly name: string;
-    /** Written to your config file now (false: waiting for Ctrl+S with the other unsaved changes). */
-    readonly saved: boolean;
-}
-export declare class AddAgent {
-    private readonly app;
-    private readonly file;
-    private readonly draft;
-    /** Every agent that exists now (the new name must be different). */
-    private readonly taken;
-    constructor(app: App, file: ConfigFile, draft: Draft, 
-    /** Every agent that exists now (the new name must be different). */
-    taken: readonly string[]);
-    /** Asks, then adds the agent. Undefined when you backed out. */
-    run(): Promise<AddedAgent | undefined>;
-    /** Validates and writes (or stages) the entry. */
-    private add;
-}

package/dist/cli/menu/add-agent.js

@@ -1,168 +0,0 @@
-// "Add an agent": a few questions (how it installs, its name, its package or program) that end in a new entry of
-// `harnesses` in your own config file. It is written at once, unless harnesses has unsaved changes in Settings (then
-// it joins them). Everything else about the agent (arguments, login folders ...) is edited in Settings > Agents &
-// sessions.
-import { DEFAULTS } from '../../core/config/index.js';
-import { HarnessSchema, NameSchema, describeIssues } from '../../core/schema/index.js';
-import { fail } from '../../core/util/index.js';
-import { askPath } from './settings/ask-path.js';
-/** Nothing wrong with the name (true), or what is wrong. Pure. */
-export function agentNameProblem(name, taken) {
-    const typed = name.trim();
-    if (!typed)
-        return 'Type a name.';
-    const parsed = NameSchema.safeParse(typed);
-    if (!parsed.success)
-        return 'Use letters, numbers, - and _ only.';
-    if (taken.some((t) => t.toLowerCase() === typed.toLowerCase()))
-        return typed + ' is an agent already.';
-    return true;
-}
-/** The command a package usually provides: "@scope/my-agent@latest" gives "my-agent". Pure. */
-export function commandFromPackage(pkg) {
-    const version = pkg.lastIndexOf('@');
-    const bare = version > 0 ? pkg.slice(0, version) : pkg;
-    return (bare.split(/[\\/]/).pop() ?? '').replace(/[^A-Za-z0-9._-]/g, '');
-}
-/** The config entry for a new agent. Pure. */
-export function newAgent(source, what, command, hostDir = 'auto') {
-    const common = { arguments: [], environment: {} };
-    if (source === 'npm')
-        return { ...common, npmPackage: what, npmBin: command };
-    if (source === 'uv')
-        return { ...common, uvPackage: what, uvBin: command };
-    return { ...common, hostExecutable: what, hostDir };
-}
-/** What `harnesses` should say with `name` taken out. Pure. */
-export function withoutAgent(current, name) {
-    const rest = { ...(current && typeof current === 'object' ? current : {}) };
-    delete rest[name];
-    return rest;
-}
-/** Writes a setting to your config file now, or adds it to the unsaved changes when it has some already. */
-export function writeOrStage(file, draft, key, value) {
-    if (draft.has(file, key)) {
-        draft.stage(file, key, value);
-        return { saved: false };
-    }
-    const result = file.set(key, value);
-    if (typeof result === 'object')
-        fail('It could not be saved: ' + result.problems.join('; '));
-    return { saved: true };
-}
-/** What `harnesses` should say with `name` added to what is staged or in the file now. Pure. */
-export function withAgent(current, name, harness) {
-    return { ...(current && typeof current === 'object' ? current : {}), [name]: harness };
-}
-/** The staged value of a setting, else what your own file says (what `harnesses` or `defaultHarness` will be). */
-function current(file, draft, key) {
-    return draft.has(file, key) ? draft.value(file, key) : file.valueInFile(key);
-}
-/** Makes `name` the agent that starts by default (written now, or joined to unsaved changes to that setting). */
-export function makeDefaultAgent(file, draft, name) {
-    return writeOrStage(file, draft, ['defaultHarness'], name);
-}
-/** Takes an agent you added out of your settings (the built-in ones are not removable). */
-export function removeAgent(file, draft, name) {
-    if (name in DEFAULTS.harnesses)
-        fail(name + ' is built in, so it cannot be removed.');
-    const key = ['harnesses'];
-    const standing = current(file, draft, ['defaultHarness']) ?? file.userConfig().defaultHarness;
-    if (standing === name)
-        fail(name + ' is the default agent.', 'Make another agent the default first.');
-    const rest = withoutAgent(current(file, draft, key), name);
-    // Nothing of your own left: the setting goes (the built-in agents need no line).
-    return writeOrStage(file, draft, key, Object.keys(rest).length ? rest : undefined);
-}
-export class AddAgent {
-    app;
-    file;
-    draft;
-    taken;
-    constructor(app, file, draft, 
-    /** Every agent that exists now (the new name must be different). */
-    taken) {
-        this.app = app;
-        this.file = file;
-        this.draft = draft;
-        this.taken = taken;
-    }
-    /** Asks, then adds the agent. Undefined when you backed out. */
-    async run() {
-        const path = ['Agents', 'Add an agent'];
-        const source = await this.app.choose(path, 'How does the agent get into the sandbox?', [
-            {
-                value: 'npm',
-                label: 'An npm package',
-                description: 'Installed inside the sandbox with npm once and kept (e.g. @openai/codex).',
-            },
-            {
-                value: 'uv',
-                label: 'A Python package',
-                description: 'Installed inside the sandbox with uv once and kept (e.g. aider-chat).',
-            },
-            {
-                value: 'host',
-                label: 'A program on this PC',
-                description: 'An .exe copied from this PC into the sandbox (looked up on PATH and in ~/.local/bin).',
-            },
-        ]);
-        if (!source)
-            return undefined;
-        const name = await this.app.text({
-            path,
-            label: 'Name of the agent',
-            about: ['What you type after "sandbox", e.g. sandbox <name>. Letters, numbers, - and _.'],
-            validate: (v) => agentNameProblem(v, this.taken),
-        });
-        if (!name)
-            return undefined;
-        if (source === 'host') {
-            const exe = await askPath(this.app, {
-                path,
-                title: 'Choose the program (.exe)',
-                about: ['The agent program on this PC. It is copied into the sandbox. A bare file name is looked up on PATH.'],
-                kind: 'file',
-                validate: (v) => (v.trim() ? true : 'Choose a file.'),
-            });
-            if (!exe)
-                return undefined;
-            const slash = Math.max(exe.lastIndexOf('\\'), exe.lastIndexOf('/'));
-            const dir = slash > 0 ? exe.slice(0, slash) : 'auto';
-            return this.add(name.trim(), newAgent('host', exe.slice(slash + 1), '', dir));
-        }
-        const what = await this.app.text({
-            path,
-            label: source === 'npm' ? 'npm package' : 'Python package',
-            about: [
-                source === 'npm'
-                    ? 'The package to install, optionally with a version: @scope/name or name@latest.'
-                    : 'The package for `uv tool install`.',
-            ],
-            validate: (v) => (v.trim() ? true : 'Type it.'),
-        });
-        if (!what)
-            return undefined;
-        const command = await this.app.text({
-            path,
-            label: 'Command',
-            about: ['The command the package provides; it is what runs inside the sandbox.'],
-            initial: commandFromPackage(what.trim()),
-            validate: (v) => (/^[A-Za-z0-9._-]+$/.test(v.trim()) ? true : 'Letters, numbers, . - and _ only.'),
-        });
-        if (!command)
-            return undefined;
-        return this.add(name.trim(), newAgent(source, what.trim(), command.trim()));
-    }
-    /** Validates and writes (or stages) the entry. */
-    add(name, harness) {
-        const checked = HarnessSchema.safeParse(harness);
-        if (!checked.success)
-            fail('That agent is not valid: ' + describeIssues(checked.error).join('; '));
-        const key = ['harnesses'];
-        return {
-            name,
-            ...writeOrStage(this.file, this.draft, key, withAgent(current(this.file, this.draft, key), name, harness)),
-        };
-    }
-}

package/dist/cli/menu/apps.d.ts

@@ -1,69 +0,0 @@
-import { type AppCategory, type AppEntry } from '../../shared/apps/index.js';
-import { type Category, type ListItem } from '../tui/index.js';
-import type { ConfigFile } from '../../app/features/settings/index.js';
-import type { Draft } from './settings/draft.js';
-export declare const CUSTOM = "@custom:";
-/** The catalogue has many small categories; the menu shows these few groups so the navigation stays short. */
-export declare const APP_GROUPS: readonly [{
-    readonly id: "editors";
-    readonly label: "Editors & docs";
-    readonly description: "Code and text editors (VS Code is on by default), plus diagrams and document conversion.";
-    readonly members: readonly ["editors", "diagrams"];
-}, {
-    readonly id: "clients";
-    readonly label: "DB & API clients";
-    readonly description: "GUIs for the sandbox databases, tools to send HTTP, REST and GraphQL requests, and to inspect traffic.";
-    readonly members: readonly ["databases", "api", "network"];
-}, {
-    readonly id: "tools";
-    readonly label: "Git & utilities";
-    readonly description: "Git GUIs and terminal UIs, archives, file search and comparing, process tools, and decompilers.";
-    readonly members: readonly ["git", "utilities", "reversing"];
-}, {
-    readonly id: "cli";
-    readonly label: "Command-line & cloud";
-    readonly description: "Small developer tools (JSON, search, builds, media ...) and tools for clouds and Kubernetes.";
-    readonly members: readonly ["cli", "cloud"];
-}, {
-    readonly id: "play";
-    readonly label: "Browsers & games";
-    readonly description: "Browsers for testing web apps, and game engines and editors (they draw with OpenGL on the CPU).";
-    readonly members: readonly ["browsers", "gamedev"];
-}];
-/** The group an app category is shown under. */
-export declare function groupOf(category: AppCategory): string;
-/** The row in Apps that opens the "request an app" issue form (its id is not an app). */
-export declare const REQUEST_APP = "@request-app";
-/** This project's new-issue page on GitHub. */
-export declare const ISSUES_URL = "https://github.com/JoshDiDuca/windows-development-sandbox/issues/new";
-/** The new-issue address with a title and a body to fill in (the page needs no login to show it). */
-export declare function requestAppUrl(): string;
-export declare class AppsModel {
-    private readonly file;
-    private readonly dataPath;
-    constructor(file: ConfigFile, dataPath: string);
-    /** The catalogue entries this file can change (a project cannot change an app that has a setting of its own). */
-    entries(): AppEntry[];
-    categories(): Category[];
-    /** Downloaded already (into this data folder), so the next sandbox starts it without a download. */
-    private installed;
-    private savedInstall;
-    /** Is the entry on in the saved file? */
-    private savedOn;
-    /** Is the entry on once the staged changes are saved? */
-    isOn(entry: AppEntry, draft: Draft): boolean;
-    /** Your own programs (apps.custom), staged or saved. */
-    custom(draft: Draft): Record<string, {
-        name: string;
-        github?: string;
-        url?: string;
-        cli?: boolean;
-    }>;
-    private item;
-    items(draft: Draft): ListItem<string>[];
-    /** Stages the ticks of the list: only what differs from the saved file is kept in the draft. */
-    stageTicks(draft: Draft, ticked: readonly string[]): void;
-}
-/** For notices: "12 apps chosen". */
-export declare function appsSummary(file: ConfigFile): string;
-export declare function appLabel(id: string): string;