@cloud-cli/dx 1.0.0

package/README.md

@@ -0,0 +1,22 @@
+## DX
+
+Run Docker containers
+
+## Install
+
+```
+npm i @cloud-cli/dx
+```
+
+## Usage
+
+```bash
+cy dx.list
+cy dx.status
+cy dx.add --name node-app --image node --version latest --command 'node --version' --volumes 'volume:/container/path' --ports '1234:80'
+cy dx.start --name node-app --env 'FOO=bar' --ports '1234:80'
+cy dx.status --name node-app
+cy dx.logs --name node-app
+cy dx.stop --name node-app
+cy dx.remove --name node-app
+```

package/dist/containers.d.ts

@@ -0,0 +1,16 @@
+export declare function getRunningContainers(): Promise<string[]>;
+interface GetLogsOptions {
+    name: string;
+    lines?: string;
+}
+export declare function getLogs({ name, lines }: GetLogsOptions): Promise<string>;
+interface RunOptions {
+    name: string;
+    env?: string[];
+}
+export declare function runContainer(options: RunOptions): Promise<boolean>;
+export interface StopOptions {
+    name: string;
+}
+export declare function stopContainer(options: StopOptions): Promise<boolean>;
+export {};

package/dist/containers.js

@@ -0,0 +1,50 @@
+import { exec } from '@cloud-cli/exec';
+import { findContainer } from './store.js';
+export async function getRunningContainers() {
+    const ps = await exec('docker', ['ps', '--format', '{{.Names}}']);
+    if (!ps.ok) {
+        throw new Error('Failed to list containers: ' + ps.stderr);
+    }
+    return getListFromString(ps.stdout);
+}
+export async function getLogs({ name, lines }) {
+    if (!name) {
+        throw new Error('Name not specified');
+    }
+    const args = ['logs', name];
+    if (lines) {
+        args.push('-n', String(Number(lines)));
+    }
+    const sh = await exec('docker', args);
+    if (sh.ok) {
+        return sh.stdout;
+    }
+    return '';
+}
+const defaultRunOptions = { env: [] };
+export async function runContainer(options) {
+    options = { ...defaultRunOptions, ...options };
+    const { name } = options;
+    if (!name) {
+        throw new Error('Name is required');
+    }
+    const container = await findContainer(name);
+    const env = options.env.flatMap((e) => ['-e', e]);
+    const volumes = container.volumes
+        .split(',')
+        .filter(Boolean)
+        .map((v) => `-v${v}`);
+    const ports = container.ports
+        .split(',')
+        .filter(Boolean)
+        .map((p) => `-p${p}`);
+    await exec('docker', ['run', '--rm', '--detach', '--name', name, ...volumes, ...ports, ...env, container.image]);
+    return true;
+}
+export async function stopContainer(options) {
+    await exec('docker', ['stop', '-t', '5', options.name]);
+    return true;
+}
+function getListFromString(string) {
+    return string.trim().split('\n').filter(Boolean);
+}

package/dist/images.d.ts

@@ -0,0 +1,3 @@
+export declare function pull(options: {
+    image: string;
+}): Promise<boolean>;

package/dist/images.js

@@ -0,0 +1,11 @@
+import { exec } from '@cloud-cli/exec';
+export async function pull(options) {
+    return (await exec('docker', ['pull', options.image])).ok;
+}
+/*
+async getImages(): Promise<string[]> {
+  const list = await this.shellExec('docker', ['image', 'ls', '--format', '{{.Repository}}']);
+
+  return list.filter((s: string) => s !== '<none>');
+}
+*/ 

package/dist/index.d.ts

@@ -0,0 +1,19 @@
+import { init } from '@cloud-cli/cli';
+import { getRunningContainers, getLogs, runContainer, stopContainer } from './containers.js';
+import { addContainer, removeContainer, listContainers, updateContainer } from './store.js';
+import { pull } from './images.js';
+declare function reload(): Promise<void>;
+declare const _default: {
+    pull: typeof pull;
+    add: typeof addContainer;
+    remove: typeof removeContainer;
+    list: typeof listContainers;
+    update: typeof updateContainer;
+    run: typeof runContainer;
+    stop: typeof stopContainer;
+    ps: typeof getRunningContainers;
+    logs: typeof getLogs;
+    reload: typeof reload;
+    [init]: typeof reload;
+};
+export default _default;

package/dist/index.js

@@ -0,0 +1,22 @@
+import { init } from '@cloud-cli/cli';
+import { Resource } from '@cloud-cli/store';
+import { Container } from './store.js';
+import { getRunningContainers, getLogs, runContainer, stopContainer } from './containers.js';
+import { addContainer, removeContainer, listContainers, updateContainer } from './store.js';
+import { pull } from './images.js';
+async function reload() {
+    await Resource.create(Container);
+}
+export default {
+    pull,
+    add: addContainer,
+    remove: removeContainer,
+    list: listContainers,
+    update: updateContainer,
+    run: runContainer,
+    stop: stopContainer,
+    ps: getRunningContainers,
+    logs: getLogs,
+    reload,
+    [init]: reload
+};

package/dist/store.d.ts

@@ -0,0 +1,26 @@
+import { Resource } from '@cloud-cli/store';
+export declare class Container extends Resource {
+    id: number;
+    name: string;
+    image: string;
+    ports: string;
+    volumes: string;
+}
+interface ContainerName {
+    name: string;
+}
+interface AddContainerOptions extends ContainerName {
+    image: string;
+    volumes?: string;
+    ports?: string;
+}
+export declare function addContainer(options: AddContainerOptions): Promise<Container>;
+export declare function removeContainer(options: ContainerName): Promise<boolean>;
+interface UpdateOptions extends ContainerName {
+    ports?: string;
+    volumes?: string;
+}
+export declare function updateContainer(options: UpdateOptions): Promise<Container>;
+export declare function listContainers(): Promise<Container[]>;
+export declare function findContainer(name: string): Promise<Container | null>;
+export {};

package/dist/store.js

@@ -0,0 +1,79 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import { Model, Resource, Primary, NotNull, Property, Query } from '@cloud-cli/store';
+let Container = class Container extends Resource {
+};
+__decorate([
+    Primary(),
+    NotNull(),
+    Property(Number)
+], Container.prototype, "id", void 0);
+__decorate([
+    NotNull(),
+    Property(String)
+], Container.prototype, "name", void 0);
+__decorate([
+    NotNull(),
+    Property(String)
+], Container.prototype, "image", void 0);
+__decorate([
+    NotNull(),
+    Property(String)
+], Container.prototype, "ports", void 0);
+__decorate([
+    NotNull(),
+    Property(String)
+], Container.prototype, "volumes", void 0);
+Container = __decorate([
+    Model('container')
+], Container);
+export { Container };
+export async function addContainer(options) {
+    const { name, image } = options;
+    const volumes = (options.volumes ? sanitiseVolumes(options.volumes) : '');
+    const ports = (options.ports ? sanitisePorts(options.ports) : '');
+    const container = new Container({ name, image, volumes, ports });
+    const id = await container.save();
+    container.id = id;
+    return container;
+}
+export async function removeContainer(options) {
+    const found = await findContainer(options.name);
+    if (found) {
+        await found.remove();
+        return true;
+    }
+    throw new Error('Container not found: ' + options.name);
+}
+const optionSplitter = /,\s*/;
+export async function updateContainer(options) {
+    let { ports, volumes, name } = options;
+    const container = await findContainer(name);
+    if (ports) {
+        container.ports = sanitisePorts(ports);
+    }
+    if (volumes) {
+        container.volumes = sanitiseVolumes(volumes);
+    }
+    await container.save();
+    return container;
+}
+export async function listContainers() {
+    return Resource.find(Container, new Query());
+}
+export async function findContainer(name) {
+    const found = await Resource.find(Container, new Query().where('name').is(name));
+    return found[0] || null;
+}
+const portTester = /^\d+:\d+$/;
+function sanitisePorts(ports) {
+    return ports.split(optionSplitter).map(s => s.trim()).filter(s => portTester.test(s)).join(',');
+}
+const volumeTester = /^\S+:\S+$/;
+function sanitiseVolumes(volumes) {
+    return volumes.split(optionSplitter).map(s => s.trim()).filter(s => volumeTester.test(s)).join(',');
+}

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@cloud-cli/dx",
+  "version": "1.0.0",
+  "description": "Docker container management",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "type": "module",
+  "prettier": "@cloud-cli/prettier-config",
+  "scripts": {
+    "test": "jest",
+    "tdd": "jest --watch",
+    "build": "rm -rf ./dist/* && tsc"
+  },
+  "keywords": [
+    "cloudy"
+  ],
+  "license": "MIT",
+  "author": "Darlan Alves <me@darlanalv.es>",
+  "devDependencies": {
+    "@cloud-cli/jest-config": "^1.0.0",
+    "@cloud-cli/prettier-config": "^1.0.0",
+    "@cloud-cli/typescript-config": "^1.0.1",
+    "typescript": "^4.4.2"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/cloud-cli/dx.git"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@cloud-cli/cli": "^1.4.4",
+    "@cloud-cli/exec": "^1.0.4",
+    "@cloud-cli/store": "^1.5.1"
+  }
+}