@augment-vir/node 31.43.2 → 31.44.0

package/README.md

@@ -2,8 +2,6 @@
 
 A collection of augments, helpers types, functions, and classes only for Node.js (backend) JavaScript environments.
 
--   Includes a custom Prisma API built on its CLI: [`prisma`](https://electrovir.github.io/augment-vir/variables/prisma.html).
--   Includes a custom Docker API built on its CLI: [`docker`](https://electrovir.github.io/augment-vir/variables/docker.html).
 -   Includes an easy to use shell script runner: [`runShellCommand`](https://electrovir.github.io/augment-vir/functions/runShellCommand.html).
 -   and much more!
 

package/dist/file-paths.mock.d.ts

@@ -10,9 +10,3 @@ export declare const workspaceQueryPackageJsonPath: string;
 export declare const tempWorkspaceQueryFile: string;
 export declare const recursiveFileReadDir: string;
 export declare const invalidPackageDirPath: string;
-export declare const testPrismaSchemaPath: string;
-export declare const testPrismaSchema2Path: string;
-export declare const testInvalidPrismaSchemaPath: string;
-export declare const testSqliteDbPath: string;
-export declare const generatedPrismaClientDirPath: string;
-export declare const testPrismaMigrationsDirPath: string;

package/dist/file-paths.mock.js

@@ -12,9 +12,3 @@ export const workspaceQueryPackageJsonPath = join(workspaceQueryDir, 'package.js
 export const tempWorkspaceQueryFile = join(workspaceQueryDir, 'temp-workspace-query-output.ts');
 export const recursiveFileReadDir = join(testFilesDir, 'recursive-reading');
 export const invalidPackageDirPath = join(testFilesDir, 'invalid-package');
-export const testPrismaSchemaPath = join(testFilesDir, 'schema.prisma');
-export const testPrismaSchema2Path = join(testFilesDir, 'schema2.prisma');
-export const testInvalidPrismaSchemaPath = join(testFilesDir, 'invalid-schema.prisma');
-export const testSqliteDbPath = join(notCommittedDirPath, 'dev.db');
-export const generatedPrismaClientDirPath = join(nodePackageDir, 'node_modules', '.prisma');
-export const testPrismaMigrationsDirPath = join(testFilesDir, 'migrations');

package/dist/index.d.ts

@@ -1,4 +1,3 @@
-export * from './augments/docker.js';
 export * from './augments/fs/dir-contents.js';
 export * from './augments/fs/download.js';
 export * from './augments/fs/json.js';

package/dist/index.js

@@ -1,4 +1,3 @@
-export * from './augments/docker.js';
 export * from './augments/fs/dir-contents.js';
 export * from './augments/fs/download.js';
 export * from './augments/fs/json.js';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/node",
-    "version": "31.43.2",
+    "version": "31.44.0",
     "description": "A collection of augments, helpers types, functions, and classes only for Node.js (backend) JavaScript environments.",
     "keywords": [
         "augment",
@@ -38,8 +38,8 @@
         "test:update": "npm test"
     },
     "dependencies": {
-        "@augment-vir/assert": "^31.43.2",
-        "@augment-vir/common": "^31.43.2",
+        "@augment-vir/assert": "^31.44.0",
+        "@augment-vir/common": "^31.44.0",
         "@date-vir/duration": "^8.0.0",
         "ansi-styles": "^6.2.3",
         "sanitize-filename": "^1.6.3",
@@ -49,8 +49,7 @@
         "typed-event-target": "^4.1.0"
     },
     "devDependencies": {
-        "@augment-vir/test": "^31.43.2",
-        "@prisma/client": "^6.17.1",
+        "@augment-vir/test": "^31.44.0",
         "@types/node": "^24.9.1",
         "@web/dev-server-esbuild": "^1.0.4",
         "@web/test-runner": "^0.20.2",
@@ -59,7 +58,6 @@
         "@web/test-runner-visual-regression": "^0.10.0",
         "c8": "^10.1.3",
         "istanbul-smart-text-reporter": "^1.1.5",
-        "prisma": "^6.17.1",
         "typescript": "^5.9.3"
     },
     "peerDependencies": {

package/src/file-paths.mock.ts

@@ -20,10 +20,3 @@ export const tempWorkspaceQueryFile = join(workspaceQueryDir, 'temp-workspace-qu
 export const recursiveFileReadDir = join(testFilesDir, 'recursive-reading');
 
 export const invalidPackageDirPath = join(testFilesDir, 'invalid-package');
-
-export const testPrismaSchemaPath = join(testFilesDir, 'schema.prisma');
-export const testPrismaSchema2Path = join(testFilesDir, 'schema2.prisma');
-export const testInvalidPrismaSchemaPath = join(testFilesDir, 'invalid-schema.prisma');
-export const testSqliteDbPath = join(notCommittedDirPath, 'dev.db');
-export const generatedPrismaClientDirPath = join(nodePackageDir, 'node_modules', '.prisma');
-export const testPrismaMigrationsDirPath = join(testFilesDir, 'migrations');

package/src/index.ts

@@ -1,4 +1,3 @@
-export * from './augments/docker.js';
 export * from './augments/fs/dir-contents.js';
 export * from './augments/fs/download.js';
 export * from './augments/fs/json.js';

package/dist/augments/docker.d.ts

@@ -1,92 +0,0 @@
-import { getContainerInfo } from '../docker/containers/container-info.js';
-import { getContainerLogs, getContainerStatus, waitUntilContainerExited, waitUntilContainerRemoved, waitUntilContainerRunning } from '../docker/containers/container-status.js';
-import { copyToContainer } from '../docker/containers/copy-to-container.js';
-import { makeEnvFlags, makePortMapFlags, makeVolumeFlags } from '../docker/containers/docker-command-inputs.js';
-import { killContainer } from '../docker/containers/kill-container.js';
-import { runContainerCommand } from '../docker/containers/run-command.js';
-import { runContainer } from '../docker/containers/run-container.js';
-import { tryOrKillContainer } from '../docker/containers/try-or-kill-container.js';
-import { isImageInLocalRegistry, removeImageFromLocalRegistry, updateImage } from '../docker/docker-image.js';
-import { isDockerRunning, startDocker } from '../docker/docker-startup.js';
-export { type DockerContainerInfo, type DockerContainerInfoState, } from '../docker/containers/container-info.js';
-export { DockerContainerStatus, exitedDockerContainerStatuses, } from '../docker/containers/container-status.js';
-export { type CopyToDockerContainerParams } from '../docker/containers/copy-to-container.js';
-export { type DockerEnvMap, type DockerPortMap, type DockerVolumeMap, type DockerVolumeMappingType, } from '../docker/containers/docker-command-inputs.js';
-export { type RunDockerContainerCommandParams } from '../docker/containers/run-command.js';
-export { type RunDockerContainerParams } from '../docker/containers/run-container.js';
-/**
- * Centralized Docker API.
- *
- * @deprecated Use the [docker-vir](https://www.npmjs.com/package/docker-vir) package instead.
- * @category Node : Docker
- * @category Package : @augment-vir/node
- * @package [`@augment-vir/node`](https://www.npmjs.com/package/@augment-vir/node)
- */
-export declare const docker: {
-    /** Detects if the Docker service is running. */
-    isRunning: typeof isDockerRunning;
-    /**
-     * Tries to start Docker based ont he current operating system's supported commands. The success
-     * of this operation is heavily dependent on how you have Docker setup on your system.
-     */
-    start: typeof startDocker;
-    image: {
-        /** Downloads an image if it is missing from the local registry. */
-        update: typeof updateImage;
-        /** Removes an image from the local registry. */
-        remove: typeof removeImageFromLocalRegistry;
-        /** Detects if an image exists in the local registry. */
-        exists: typeof isImageInLocalRegistry;
-    };
-    container: {
-        /**
-         * Get the current status of a container. If the container does not exist at all, the status
-         * will be {@link DockerContainerStatus.Removed}.
-         */
-        getStatus: typeof getContainerStatus;
-        /** Wait until a container is running and responsive. */
-        waitUntilRunning: typeof waitUntilContainerRunning;
-        /**
-         * Wait until a container has a status that can be classified as "exited".
-         *
-         * @see {@link exitedDockerContainerStatuses}
-         */
-        waitUntilExited: typeof waitUntilContainerExited;
-        /** Wait until a container is completely removed. */
-        waitUntilRemoved: typeof waitUntilContainerRemoved;
-        /**
-         * Runs a callback (which presumably will run a command within the given `containerName`)
-         * and kills the container if the callback fails.
-         */
-        tryOrKill: typeof tryOrKillContainer;
-        /** Run a container that isn't already running. */
-        run: typeof runContainer;
-        /** Kill a container. */
-        kill: typeof killContainer;
-        /** Copy a file or directory to a container. */
-        copyTo: typeof copyToContainer;
-        /** Run a command on a container that is already running. */
-        runCommand: typeof runContainerCommand;
-        /** Run `docker inspect` on a container and return its output. */
-        getInfo: typeof getContainerInfo;
-        /** Get a container's logs. */
-        getLogs: typeof getContainerLogs;
-    };
-    util: {
-        /**
-         * Manually create a string of volume mapping flags. This is automatically done already
-         * inside the run container methods.
-         */
-        makeVolumeFlags: typeof makeVolumeFlags;
-        /**
-         * Manually create a string of port mapping flags. This is automatically done already inside
-         * the run container methods.
-         */
-        makePortMapFlags: typeof makePortMapFlags;
-        /**
-         * Manually create a string of env mapping flags. This is automatically done already inside
-         * the run container methods.
-         */
-        makeEnvFlags: typeof makeEnvFlags;
-    };
-};

package/dist/augments/docker.js

@@ -1,87 +0,0 @@
-import { getContainerInfo } from '../docker/containers/container-info.js';
-import { getContainerLogs, getContainerStatus, waitUntilContainerExited, waitUntilContainerRemoved, waitUntilContainerRunning, } from '../docker/containers/container-status.js';
-import { copyToContainer } from '../docker/containers/copy-to-container.js';
-import { makeEnvFlags, makePortMapFlags, makeVolumeFlags, } from '../docker/containers/docker-command-inputs.js';
-import { killContainer } from '../docker/containers/kill-container.js';
-import { runContainerCommand } from '../docker/containers/run-command.js';
-import { runContainer } from '../docker/containers/run-container.js';
-import { tryOrKillContainer } from '../docker/containers/try-or-kill-container.js';
-import { isImageInLocalRegistry, removeImageFromLocalRegistry, updateImage, } from '../docker/docker-image.js';
-import { isDockerRunning, startDocker } from '../docker/docker-startup.js';
-export { DockerContainerStatus, exitedDockerContainerStatuses, } from '../docker/containers/container-status.js';
-/**
- * Centralized Docker API.
- *
- * @deprecated Use the [docker-vir](https://www.npmjs.com/package/docker-vir) package instead.
- * @category Node : Docker
- * @category Package : @augment-vir/node
- * @package [`@augment-vir/node`](https://www.npmjs.com/package/@augment-vir/node)
- */
-export const docker = {
-    /** Detects if the Docker service is running. */
-    isRunning: isDockerRunning,
-    /**
-     * Tries to start Docker based ont he current operating system's supported commands. The success
-     * of this operation is heavily dependent on how you have Docker setup on your system.
-     */
-    start: startDocker,
-    image: {
-        /** Downloads an image if it is missing from the local registry. */
-        update: updateImage,
-        /** Removes an image from the local registry. */
-        remove: removeImageFromLocalRegistry,
-        /** Detects if an image exists in the local registry. */
-        exists: isImageInLocalRegistry,
-    },
-    container: {
-        /**
-         * Get the current status of a container. If the container does not exist at all, the status
-         * will be {@link DockerContainerStatus.Removed}.
-         */
-        getStatus: getContainerStatus,
-        /** Wait until a container is running and responsive. */
-        waitUntilRunning: waitUntilContainerRunning,
-        /**
-         * Wait until a container has a status that can be classified as "exited".
-         *
-         * @see {@link exitedDockerContainerStatuses}
-         */
-        waitUntilExited: waitUntilContainerExited,
-        /** Wait until a container is completely removed. */
-        waitUntilRemoved: waitUntilContainerRemoved,
-        /**
-         * Runs a callback (which presumably will run a command within the given `containerName`)
-         * and kills the container if the callback fails.
-         */
-        tryOrKill: tryOrKillContainer,
-        /** Run a container that isn't already running. */
-        run: runContainer,
-        /** Kill a container. */
-        kill: killContainer,
-        /** Copy a file or directory to a container. */
-        copyTo: copyToContainer,
-        /** Run a command on a container that is already running. */
-        runCommand: runContainerCommand,
-        /** Run `docker inspect` on a container and return its output. */
-        getInfo: getContainerInfo,
-        /** Get a container's logs. */
-        getLogs: getContainerLogs,
-    },
-    util: {
-        /**
-         * Manually create a string of volume mapping flags. This is automatically done already
-         * inside the run container methods.
-         */
-        makeVolumeFlags,
-        /**
-         * Manually create a string of port mapping flags. This is automatically done already inside
-         * the run container methods.
-         */
-        makePortMapFlags,
-        /**
-         * Manually create a string of env mapping flags. This is automatically done already inside
-         * the run container methods.
-         */
-        makeEnvFlags,
-    },
-};

package/dist/docker/containers/container-info.d.ts

@@ -1,57 +0,0 @@
-import { type JsonCompatibleArray, type JsonCompatibleObject } from '@augment-vir/common';
-import { type DockerContainerStatus } from './container-status.js';
-/**
- * Properties on {@link DockerContainerInfo}.State, retrieved from `docker.container.getInfo()`.
- *
- * @category Node : Docker : Util
- * @category Package : @augment-vir/node
- * @package [`@augment-vir/node`](https://www.npmjs.com/package/@augment-vir/node)
- */
-export type DockerContainerInfoState = {
-    Status: DockerContainerStatus;
-    Running: boolean;
-    Paused: boolean;
-    Restarting: boolean;
-    OOMKilled: boolean;
-    Dead: boolean;
-    Pid: number;
-    ExitCode: number;
-    Error: string;
-    StartedAt: string;
-    FinishedAt: string;
-};
-/** This type signature is incomplete. Add to it as necessary. */
-/**
- * Properties on the output from `docker.container.getInfo()`. Not all these properties are filled
- * in all the way, particularly most of properties with nested objects.
- *
- * @category Node : Docker : Util
- * @category Package : @augment-vir/node
- * @package [`@augment-vir/node`](https://www.npmjs.com/package/@augment-vir/node)
- */
-export type DockerContainerInfo = Readonly<{
-    Id: string;
-    Created: string;
-    Path: string;
-    Args: ReadonlyArray<string>;
-    State: DockerContainerInfoState;
-    Image: string;
-    ResolvConfPath: string;
-    HostnamePath: string;
-    HostsPath: string;
-    LogPath: string;
-    Name: string;
-    RestartCount: number;
-    Driver: string;
-    Platform: string;
-    MountLabel: string;
-    ProcessLabel: string;
-    AppArmorProfile: string;
-    ExecIDs: unknown;
-    HostConfig: JsonCompatibleObject;
-    GraphDriver: JsonCompatibleObject;
-    Mounts: JsonCompatibleArray;
-    Config: JsonCompatibleObject;
-    NetworkSettings: JsonCompatibleObject;
-}>;
-export declare function getContainerInfo(containerNameOrId: string): Promise<DockerContainerInfo | undefined>;

package/dist/docker/containers/container-info.js

@@ -1,18 +0,0 @@
-import { runShellCommand } from '../../augments/terminal/shell.js';
-export async function getContainerInfo(containerNameOrId) {
-    const command = `docker inspect '${containerNameOrId}'`;
-    const output = await runShellCommand(command);
-    if (output.stderr.includes('Error: No such object')) {
-        return undefined;
-    }
-    const parsedOutput = JSON.parse(output.stdout);
-    /** Edge cases that I don't know how to intentionally trigger. */
-    /* node:coverage ignore next 5 */
-    if (parsedOutput.length === 0) {
-        throw new Error(`Got no output from "${command}"`);
-    }
-    else if (parsedOutput.length > 1) {
-        throw new Error(`Got more than one output from "${command}"`);
-    }
-    return parsedOutput[0];
-}

package/dist/docker/containers/container-status.d.ts

@@ -1,32 +0,0 @@
-export declare function getContainerLogs(containerNameOrId: string, latestLineCount?: number): Promise<string>;
-/**
- * All possible statuses for an existing container.
- *
- * @category Node : Docker : Util
- * @category Package : @augment-vir/node
- * @package [`@augment-vir/node`](https://www.npmjs.com/package/@augment-vir/node)
- */
-export declare enum DockerContainerStatus {
-    Created = "created",
-    Running = "running",
-    Paused = "paused",
-    Restarting = "restarting",
-    Exited = "exited",
-    Removing = "removing",
-    Dead = "dead",
-    /** This is not a native Docker status but indicates that the container does not exist. */
-    Removed = "removed"
-}
-/**
- * Statuses from {@link DockerContainerStatus} that indicate that a container has been exited in some
- * way.
- *
- * @category Node : Docker : Util
- * @category Package : @augment-vir/node
- * @package [`@augment-vir/node`](https://www.npmjs.com/package/@augment-vir/node)
- */
-export declare const exitedDockerContainerStatuses: DockerContainerStatus[];
-export declare function getContainerStatus(containerNameOrId: string): Promise<DockerContainerStatus>;
-export declare function waitUntilContainerRunning(containerNameOrId: string, failureMessage?: string | undefined): Promise<void>;
-export declare function waitUntilContainerRemoved(containerNameOrId: string, failureMessage?: string | undefined): Promise<void>;
-export declare function waitUntilContainerExited(containerNameOrId: string, failureMessage?: string | undefined): Promise<void>;

package/dist/docker/containers/container-status.js

@@ -1,68 +0,0 @@
-import { assert, waitUntil } from '@augment-vir/assert';
-import { runShellCommand } from '../../augments/terminal/shell.js';
-export async function getContainerLogs(containerNameOrId, latestLineCount) {
-    const latestLinesArg = latestLineCount == undefined ? '' : `--tail ${latestLineCount}`;
-    const logResult = await runShellCommand(`docker logs ${latestLinesArg} '${containerNameOrId}'`, { rejectOnError: true });
-    return logResult.stdout;
-}
-/**
- * All possible statuses for an existing container.
- *
- * @category Node : Docker : Util
- * @category Package : @augment-vir/node
- * @package [`@augment-vir/node`](https://www.npmjs.com/package/@augment-vir/node)
- */
-export var DockerContainerStatus;
-(function (DockerContainerStatus) {
-    DockerContainerStatus["Created"] = "created";
-    DockerContainerStatus["Running"] = "running";
-    DockerContainerStatus["Paused"] = "paused";
-    DockerContainerStatus["Restarting"] = "restarting";
-    DockerContainerStatus["Exited"] = "exited";
-    DockerContainerStatus["Removing"] = "removing";
-    DockerContainerStatus["Dead"] = "dead";
-    /** This is not a native Docker status but indicates that the container does not exist. */
-    DockerContainerStatus["Removed"] = "removed";
-})(DockerContainerStatus || (DockerContainerStatus = {}));
-/**
- * Statuses from {@link DockerContainerStatus} that indicate that a container has been exited in some
- * way.
- *
- * @category Node : Docker : Util
- * @category Package : @augment-vir/node
- * @package [`@augment-vir/node`](https://www.npmjs.com/package/@augment-vir/node)
- */
-export const exitedDockerContainerStatuses = [
-    DockerContainerStatus.Dead,
-    DockerContainerStatus.Removed,
-    DockerContainerStatus.Exited,
-];
-export async function getContainerStatus(containerNameOrId) {
-    const statusResult = await runShellCommand(`docker container inspect -f '{{.State.Status}}' '${containerNameOrId}'`);
-    if (statusResult.exitCode !== 0) {
-        return DockerContainerStatus.Removed;
-    }
-    const status = statusResult.stdout.trim();
-    assert.isEnumValue(status, DockerContainerStatus, 'Unexpected container status value');
-    return status;
-}
-export async function waitUntilContainerRunning(containerNameOrId, failureMessage) {
-    await waitUntil.isTrue(async () => {
-        /** Check if logs can be accessed yet. */
-        await getContainerLogs(containerNameOrId, 1);
-        const status = await getContainerStatus(containerNameOrId);
-        return status === DockerContainerStatus.Running;
-    }, {}, failureMessage);
-}
-export async function waitUntilContainerRemoved(containerNameOrId, failureMessage) {
-    await waitUntil.isTrue(async () => {
-        const status = await getContainerStatus(containerNameOrId);
-        return status === DockerContainerStatus.Removed;
-    }, {}, failureMessage);
-}
-export async function waitUntilContainerExited(containerNameOrId, failureMessage) {
-    await waitUntil.isTrue(async () => {
-        const status = await getContainerStatus(containerNameOrId);
-        return exitedDockerContainerStatuses.includes(status);
-    }, {}, failureMessage);
-}

package/dist/docker/containers/copy-to-container.d.ts

@@ -1,14 +0,0 @@
-/**
- * Parameters for `docker.container.copyTo`.
- *
- * @category Node : Docker : Util
- * @category Package : @augment-vir/node
- * @package [`@augment-vir/node`](https://www.npmjs.com/package/@augment-vir/node)
- */
-export type CopyToDockerContainerParams = {
-    hostPath: string;
-    containerAbsolutePath: string;
-    containerNameOrId: string;
-    dockerFlags?: ReadonlyArray<string>;
-};
-export declare function copyToContainer({ containerAbsolutePath, hostPath, containerNameOrId, dockerFlags, }: CopyToDockerContainerParams): Promise<void>;

package/dist/docker/containers/copy-to-container.js

@@ -1,10 +0,0 @@
-import { addSuffix } from '@augment-vir/common';
-import { stat } from 'node:fs/promises';
-import { runShellCommand } from '../../augments/terminal/shell.js';
-export async function copyToContainer({ containerAbsolutePath, hostPath, containerNameOrId, dockerFlags = [], }) {
-    const isDir = (await stat(hostPath)).isDirectory();
-    const suffix = isDir ? '/.' : '';
-    const fullHostPath = addSuffix({ value: hostPath, suffix });
-    const extraInputs = dockerFlags.join(' ');
-    await runShellCommand(`docker cp ${extraInputs} '${fullHostPath}' '${containerNameOrId}:${containerAbsolutePath}'`, { rejectOnError: true });
-}

package/dist/docker/containers/docker-command-inputs.d.ts

@@ -1,74 +0,0 @@
-/**
- * Used for `type` in {@link DockerVolumeMap}. These types are apparently only relevant for running
- * Docker on macOS and are potentially irrelevant now. It's likely best to leave the `type` property
- * empty (`undefined`).
- *
- * @category Node : Docker : Util
- * @category Package : @augment-vir/node
- * @package [`@augment-vir/node`](https://www.npmjs.com/package/@augment-vir/node)
- */
-export declare enum DockerVolumeMappingType {
-    Cached = "cached",
-    Delegated = "delegated"
-}
-/**
- * A mapping of a single docker volume for mounting host files to a container.
- *
- * @category Node : Docker : Util
- * @category Package : @augment-vir/node
- * @package [`@augment-vir/node`](https://www.npmjs.com/package/@augment-vir/node)
- */
-export type DockerVolumeMap = {
-    hostAbsolutePath: string;
-    containerAbsolutePath: string;
-    type?: DockerVolumeMappingType | undefined;
-};
-export declare function makeVolumeFlags(volumeMapping?: ReadonlyArray<DockerVolumeMap>): string;
-/**
- * A single docker container port mapping. This is usually used in an array.
- *
- * @category Node : Docker : Util
- * @category Package : @augment-vir/node
- * @package [`@augment-vir/node`](https://www.npmjs.com/package/@augment-vir/node)
- */
-export type DockerPortMap = {
-    hostPort: number;
-    containerPort: number;
-};
-/**
- * A set of environment mappings for a docker container.
- *
- * - Each key in this object represents the env var name within the Docker container.
- * - Each `value` property can be either the value that the env var should be set to _or_ an existing
- *   env var's interpolation into the value.
- * - If the value string is meant to be interpolated within the shell context, make sure to set
- *   `allowInterpolation` to `true`. Otherwise, it's best to leave it as `false`.
- *
- * @category Node : Docker : Util
- * @category Package : @augment-vir/node
- * @example
- *
- * ```ts
- * const envMapping: DockerEnvMap = {
- *     VAR_1: {
- *         value: 'hi',
- *         // set to false because this is a raw string value that is not meant to be interpolated
- *         allowInterpolation: false,
- *     },
- *     VAR_2: {
- *         // the value here will be interpolated from the current shell's value for `EXISTING_VAR`
- *         value: '$EXISTING_VAR',
- *         // set to true to allow '$EXISTING_VAR' to be interpolated by the shell
- *         allowInterpolation: true,
- *     },
- * };
- * ```
- *
- * @package [`@augment-vir/node`](https://www.npmjs.com/package/@augment-vir/node)
- */
-export type DockerEnvMap<RequiredKeys extends string = string> = Readonly<Record<RequiredKeys | string, {
-    value: string;
-    allowInterpolation: boolean;
-}>>;
-export declare function makePortMapFlags(portMapping?: ReadonlyArray<DockerPortMap> | undefined): string;
-export declare function makeEnvFlags(envMapping?: DockerEnvMap | undefined): string;

package/dist/docker/containers/docker-command-inputs.js

@@ -1,45 +0,0 @@
-import { wrapString } from '@augment-vir/common';
-/**
- * Used for `type` in {@link DockerVolumeMap}. These types are apparently only relevant for running
- * Docker on macOS and are potentially irrelevant now. It's likely best to leave the `type` property
- * empty (`undefined`).
- *
- * @category Node : Docker : Util
- * @category Package : @augment-vir/node
- * @package [`@augment-vir/node`](https://www.npmjs.com/package/@augment-vir/node)
- */
-export var DockerVolumeMappingType;
-(function (DockerVolumeMappingType) {
-    DockerVolumeMappingType["Cached"] = "cached";
-    DockerVolumeMappingType["Delegated"] = "delegated";
-})(DockerVolumeMappingType || (DockerVolumeMappingType = {}));
-export function makeVolumeFlags(volumeMapping) {
-    if (!volumeMapping) {
-        return '';
-    }
-    const parts = volumeMapping.map((volume) => {
-        const mountType = volume.type ? `:${volume.type}` : '';
-        return `-v '${volume.hostAbsolutePath}':'${volume.containerAbsolutePath}'${mountType}`;
-    });
-    return parts.join(' ');
-}
-export function makePortMapFlags(portMapping) {
-    if (!portMapping) {
-        return '';
-    }
-    return portMapping
-        .map((portMap) => {
-        return `-p ${portMap.hostPort}:${portMap.containerPort}`;
-    })
-        .join(' ');
-}
-export function makeEnvFlags(envMapping) {
-    if (!envMapping) {
-        return '';
-    }
-    const flags = Object.entries(envMapping).map(([key, { value, allowInterpolation },]) => {
-        const quote = allowInterpolation ? '"' : "'";
-        return `-e ${key}=${wrapString({ value, wrapper: quote })}`;
-    });
-    return flags.join(' ');
-}

package/dist/docker/containers/kill-container.d.ts

@@ -1,10 +0,0 @@
-import { type PartialWithUndefined } from '@augment-vir/core';
-export declare function killContainer(containerNameOrId: string, options?: PartialWithUndefined<{
-    /**
-     * If set to `true`, the container will be killed but won't be removed. (You'll still see it
-     * in your Docker Dashboard but it'll have a status of exited.)
-     *
-     * @default false
-     */
-    keepContainer: boolean;
-}>): Promise<void>;

package/dist/docker/containers/kill-container.js

@@ -1,12 +0,0 @@
-import { runShellCommand } from '../../augments/terminal/shell.js';
-import { waitUntilContainerExited, waitUntilContainerRemoved } from './container-status.js';
-export async function killContainer(containerNameOrId, options = {}) {
-    await runShellCommand(`docker kill '${containerNameOrId}'`);
-    if (options.keepContainer) {
-        await waitUntilContainerExited(containerNameOrId);
-    }
-    else {
-        await runShellCommand(`docker rm '${containerNameOrId}'`);
-        await waitUntilContainerRemoved(containerNameOrId);
-    }
-}

package/dist/docker/containers/run-command.d.ts

@@ -1,18 +0,0 @@
-import { type DockerEnvMap } from './docker-command-inputs.js';
-/**
- * Parameters for `docker.container.runCommand`.
- *
- * @category Node : Docker : Util
- * @category Package : @augment-vir/node
- * @package [`@augment-vir/node`](https://www.npmjs.com/package/@augment-vir/node)
- */
-export type RunDockerContainerCommandParams = {
-    /** Creates an interactive shell connection. */
-    tty?: boolean | undefined;
-    containerNameOrId: string;
-    command: string;
-    envMapping?: DockerEnvMap | undefined;
-    executionEnv?: Record<string, string> | undefined;
-    dockerFlags?: ReadonlyArray<string> | undefined;
-};
-export declare function runContainerCommand({ tty, containerNameOrId, command, envMapping, executionEnv, dockerFlags, }: RunDockerContainerCommandParams): Promise<import("../../augments/terminal/shell.js").ShellOutput>;