@enspirit/emb 0.0.5 → 0.0.7

package/dist/src/config/schema.d.ts

@@ -3,32 +3,18 @@
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
  * and run json-schema-to-typescript to regenerate this file.
  */
-export type Component = string | {
-    /**
-     * The name of the component.
-     */
+export type Task = Task1 & {
     name: string;
-    /**
-     * The directory of the component.
-     */
-    context?: string;
-    /**
-     * A description of the component.
-     */
     description?: string;
-    buildArgs?: {
+    script?: string;
+    executor?: string;
+    options?: {
         [k: string]: unknown;
     };
-    dependencies?: string[];
-    /**
-     * The stage to target for the build
-     */
-    target?: string;
-    /**
-     * The Dockerfile to use
-     */
-    dockerfile?: string;
-    tasks?: Task[];
+    pre?: string[];
+};
+export type Task1 = {
+    [k: string]: unknown;
 };
 export interface EMBConfigSchema {
     project: string | {
@@ -60,6 +46,7 @@ export interface EMBConfigSchema {
     defaults?: Defaults;
     components?: Component[];
     flavors?: Flavor[];
+    tasks?: Task[];
 }
 /**
  * Default settings for build aspects
@@ -72,7 +59,7 @@ export interface Defaults {
         tag?: string;
         target?: string;
         buildArgs?: {
-            [k: string]: unknown;
+            [k: string]: string;
         };
         labels?: {
             [k: string]: string;
@@ -80,14 +67,34 @@ export interface Defaults {
         [k: string]: unknown;
     };
 }
-export interface Task {
+export interface Component {
+    /**
+     * The name of the component.
+     */
     name: string;
-    description?: string;
-    script: string;
-    executor?: string;
-    options?: {
-        [k: string]: unknown;
+    docker?: {
+        /**
+         * The directory of the component.
+         */
+        context?: string;
+        buildArgs?: {
+            [k: string]: string;
+        };
+        dependencies?: string[];
+        /**
+         * The stage to target for the build
+         */
+        target?: string;
+        /**
+         * The Dockerfile to use
+         */
+        dockerfile?: string;
     };
+    /**
+     * A description of the component.
+     */
+    description?: string;
+    tasks?: Task[];
 }
 export interface Flavor {
     name: string;

package/dist/src/config/schema.json

@@ -70,6 +70,12 @@
             "items": {
                 "$ref": "#/$defs/flavor"
             }
+        },
+        "tasks": {
+            "type": "array",
+            "items": {
+                "$ref": "#/$defs/task"
+            }
         }
     },
     "required": ["project"],
@@ -88,7 +94,9 @@
                         "target": { "type": "string" },
                         "buildArgs": {
                             "type": "object",
-                            "additionalProperties": true
+                            "additionalProperties": {
+                                "type": "string"
+                            }
                         },
                         "labels": {
                             "type": "object",
@@ -102,7 +110,11 @@
         },
         "task": {
             "type": "object",
-            "required": ["name", "script"],
+            "required": ["name"],
+            "anyOf": [
+                { "required": ["script"] },
+                { "required": ["pre"] }
+            ],
             "properties": {
                 "name": {
                     "type": "string"
@@ -119,40 +131,39 @@
                 "options": {
                     "type": "object",
                     "additionalProperties": true
+                },
+                "pre": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
                 }
             },
             "additionalProperties": false
         },
         "component": {
-            "oneOf": [
-                {
+            "type": "object",
+            "required": ["name"],
+            "properties": {
+                "name": {
                     "type": "string",
                     "minLength": 3,
-                    "description": "Shortcut for specifying the component name."
+                    "description": "The name of the component."
                 },
-                {
+                "docker": {
                     "type": "object",
-                    "required": ["name"],
                     "properties": {
-                        "name": {
-                            "type": "string",
-                            "minLength": 3,
-                            "description": "The name of the component."
-                        },
                         "context": {
                             "type": "string",
                             "minLength": 1,
                             "description": "The directory of the component."
                         },
-                        "description": {
-                            "type": "string",
-                            "minLength": 1,
-                            "description": "A description of the component."
-                        },
                         "buildArgs": {
                             "type": "object",
                             "properties": {},
-                            "additionalProperties": true
+                            "additionalProperties": {
+                                "type": "string"
+                            }
                         },
                         "dependencies": {
                             "type": "array",
@@ -167,17 +178,23 @@
                         "dockerfile": {
                             "type": "string",
                             "description": "The Dockerfile to use"
-                        },
-                        "tasks": {
-                            "type": "array",
-                            "items": {
-                                "$ref": "#/$defs/task"
-                            }
                         }
                     },
                     "additionalProperties": false
+                },
+                "description": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "A description of the component."
+                },
+                "tasks": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/task"
+                    }
                 }
-            ]
+            },
+            "additionalProperties": false
         },
         "flavor": {
             "type": "object",

package/dist/src/config/types.d.ts

@@ -5,18 +5,20 @@ export type IProjectConfig = {
     rootDir: string;
 };
 export type ComponentConfig = {
-    buildArgs?: Record<PropertyKey, string>;
-    context?: string;
-    dependencies?: Array<string>;
-    dockerfile?: string;
-    labels?: Record<string, string>;
     name: string;
-    target?: string;
+    docker?: {
+        buildArgs?: Record<string, string>;
+        context?: string;
+        dependencies?: Array<string>;
+        dockerfile?: string;
+        labels?: Record<string, string>;
+        target?: string;
+    };
     tasks?: Array<Task>;
 };
 export type DefaultSettings = {
     docker?: {
-        buildArgs?: Record<string, unknown>;
+        buildArgs?: Record<string, string>;
         labels?: Record<string, string>;
         tag?: string;
         target?: string;
@@ -33,11 +35,13 @@ export type PluginConfig = {
     name: string;
 };
 export type IMonorepoConfig = {
+    currentFlavor?: string;
     components: Array<ComponentConfig>;
     defaults?: DefaultSettings;
     env?: Record<string, string>;
     flavors?: Array<FlavorConfig>;
     plugins?: Array<PluginConfig>;
     project: IProjectConfig;
+    tasks?: Array<Task>;
     vars?: Record<string, unknown>;
 };

package/dist/src/config/validation.d.ts

@@ -1 +1,3 @@
+import { Component } from './schema.js';
 export declare const validateUserConfig: (pathOrObject: string | unknown) => Promise<import("./types.js").IMonorepoConfig>;
+export declare const validateEmbfile: (pathOrObject: string | unknown) => Promise<Component>;

package/dist/src/config/validation.js

@@ -3,8 +3,9 @@ import { readFile, stat } from 'node:fs/promises';
 import yaml from 'yaml';
 import { toProjectConfig } from './convert.js';
 import configSchema from './schema.json' with { type: 'json' };
+const ajv = new Ajv();
+ajv.addSchema(configSchema);
 export const validateUserConfig = async (pathOrObject) => {
-    const ajv = new Ajv();
     let userConfig;
     if (typeof pathOrObject === 'string') {
         if (await stat(pathOrObject)) {
@@ -24,3 +25,27 @@ export const validateUserConfig = async (pathOrObject) => {
     }
     return toProjectConfig(userConfig);
 };
+export const validateEmbfile = async (pathOrObject) => {
+    let component;
+    if (typeof pathOrObject === 'string') {
+        if (await stat(pathOrObject)) {
+            const cfgYaml = (await readFile(pathOrObject)).toString();
+            component = yaml.parse(cfgYaml.toString());
+        }
+        else {
+            throw new Error(`Could not find file: ${pathOrObject}`);
+        }
+    }
+    else {
+        component = pathOrObject;
+    }
+    const validate = ajv.getSchema('/schemas/config#/$defs/component');
+    if (!validate) {
+        throw new Error('Could not find the JSON schema validator for Embfile');
+    }
+    if (!validate(component)) {
+        ajv.errors.forEach((err) => console.error(err));
+        throw new Error(`Your .emb.yml is incorrect`);
+    }
+    return component;
+};

package/dist/src/docker/compose/index.d.ts

@@ -1,7 +1 @@
-export type DockerComposeOptions = {
-    cwd?: string;
-};
-export type UpOptions = DockerComposeOptions & {};
-export declare const up: (opts?: UpOptions) => Promise<import("child_process").ChildProcessWithoutNullStreams>;
-export type DownOptions = DockerComposeOptions & {};
-export declare const down: (opts?: UpOptions) => Promise<import("child_process").ChildProcessWithoutNullStreams>;
+export * from './operations/index.js';

package/dist/src/docker/compose/index.js

@@ -1,13 +1 @@
-import { spawn } from 'node:child_process';
-export const up = async (opts) => {
-    return spawn('docker', ['compose', 'up', '-d'], {
-        cwd: opts?.cwd,
-        env: process.env,
-    });
-};
-export const down = async (opts) => {
-    return spawn('docker', ['compose', 'down'], {
-        cwd: opts?.cwd,
-        env: process.env,
-    });
-};
+export * from './operations/index.js';

package/dist/src/docker/compose/operations/ComposeDownOperation.d.ts

@@ -0,0 +1,12 @@
+import { Readable } from 'node:stream';
+import * as z from 'zod';
+import { AbstractOperation } from '../../../operations/index.js';
+/**
+ * https://docs.docker.com/reference/cli/docker/compose/down/
+ */
+declare const schema: z.ZodOptional<z.ZodObject<{}, z.core.$strip>>;
+export declare class ComposeDownOperation extends AbstractOperation<typeof schema, Readable> {
+    constructor();
+    protected _run(_input: z.input<typeof schema>): Promise<Readable>;
+}
+export {};

package/dist/src/docker/compose/operations/ComposeDownOperation.js

@@ -0,0 +1,21 @@
+import { getContext } from '../../../index.js';
+import * as z from 'zod';
+import { ExecuteLocalCommandOperation } from '../../../monorepo/index.js';
+import { AbstractOperation } from '../../../operations/index.js';
+/**
+ * https://docs.docker.com/reference/cli/docker/compose/down/
+ */
+const schema = z.object({}).optional();
+export class ComposeDownOperation extends AbstractOperation {
+    constructor() {
+        super(schema);
+    }
+    async _run(_input) {
+        const { monorepo } = getContext();
+        const command = ['docker', 'compose', 'down'];
+        return monorepo.run(new ExecuteLocalCommandOperation(), {
+            script: command.join(' '),
+            workingDir: monorepo.rootDir,
+        });
+    }
+}

package/dist/src/docker/compose/operations/ComposeUpOperation.d.ts

@@ -0,0 +1,13 @@
+import * as z from 'zod';
+import { AbstractOperation } from '../../../operations/index.js';
+/**
+ * https://docs.docker.com/reference/cli/docker/compose/up/
+ */
+declare const schema: z.ZodOptional<z.ZodObject<{
+    forceRecreate: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>>;
+export declare class ComposeUpOperation extends AbstractOperation<typeof schema, void> {
+    constructor();
+    protected _run(input: z.input<typeof schema>): Promise<void>;
+}
+export {};

package/dist/src/docker/compose/operations/ComposeUpOperation.js

@@ -0,0 +1,39 @@
+import { getContext } from '../../../index.js';
+import { Listr } from 'listr2';
+import * as z from 'zod';
+import { ExecuteLocalCommandOperation } from '../../../monorepo/index.js';
+import { AbstractOperation } from '../../../operations/index.js';
+/**
+ * https://docs.docker.com/reference/cli/docker/compose/up/
+ */
+const schema = z
+    .object({
+    forceRecreate: z
+        .boolean()
+        .optional()
+        .describe("Recreate containers even if their configuration and image haven't changed"),
+})
+    .optional();
+export class ComposeUpOperation extends AbstractOperation {
+    constructor() {
+        super(schema);
+    }
+    async _run(input) {
+        const { monorepo } = getContext();
+        const command = ['docker', 'compose', 'up', '-d'];
+        if (input?.forceRecreate) {
+            command.push('--force-recreate');
+        }
+        const task = new Listr({
+            rendererOptions: { persistentOutput: true },
+            async task() {
+                return monorepo.run(new ExecuteLocalCommandOperation(), {
+                    script: command.join(' '),
+                    workingDir: monorepo.rootDir,
+                });
+            },
+            title: 'Starting project',
+        });
+        await task.run();
+    }
+}

package/dist/src/docker/compose/operations/index.d.ts

@@ -0,0 +1,2 @@
+export * from './ComposeDownOperation.js';
+export * from './ComposeUpOperation.js';

package/dist/src/docker/compose/operations/index.js

@@ -0,0 +1,2 @@
+export * from './ComposeDownOperation.js';
+export * from './ComposeUpOperation.js';

package/dist/src/docker/operations/containers/ExecContainerOperation.d.ts

@@ -0,0 +1,22 @@
+import { Writable } from 'node:stream';
+import * as z from 'zod';
+import { AbstractOperation } from '../../../operations/index.js';
+/**
+ * https://docs.docker.com/reference/api/engine/version/v1.37/#tag/Exec/operation/ContainerExec
+ */
+declare const schema: z.ZodObject<{
+    attachStderr: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+    attachStdin: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+    attachStdout: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+    container: z.ZodString;
+    env: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    script: z.ZodString;
+    tty: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+    workingDir: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export declare class ContainerExecOperation extends AbstractOperation<typeof schema, void> {
+    protected out?: Writable | undefined;
+    constructor(out?: Writable | undefined);
+    protected _run(input: z.input<typeof schema>): Promise<void>;
+}
+export {};

package/dist/src/docker/operations/containers/ExecContainerOperation.js

@@ -0,0 +1,78 @@
+import * as z from 'zod';
+import { AbstractOperation } from '../../../operations/index.js';
+/**
+ * https://docs.docker.com/reference/api/engine/version/v1.37/#tag/Exec/operation/ContainerExec
+ */
+const schema = z.object({
+    attachStderr: z
+        .boolean()
+        .default(false)
+        .optional()
+        .describe('Attach to `stderr` of the exec command.'),
+    attachStdin: z
+        .boolean()
+        .default(false)
+        .optional()
+        .describe('Attach to `stdin` of the exec command.'),
+    attachStdout: z
+        .boolean()
+        .default(false)
+        .optional()
+        .describe('Attach to `stdout` of the exec command.'),
+    container: z.string().describe('ID or name of the container'),
+    env: z
+        .record(z.string(), z.string())
+        .optional()
+        .describe('A list of environment variables in the form'),
+    script: z.string().describe('Command to run, as a string'),
+    tty: z.boolean().default(false).optional().describe('Allocate a pseudo-TTY'),
+    workingDir: z
+        .string()
+        .optional()
+        .describe('The working directory for the exec process inside the container'),
+});
+export class ContainerExecOperation extends AbstractOperation {
+    out;
+    constructor(out) {
+        super(schema);
+        this.out = out;
+    }
+    async _run(input) {
+        const container = await this.context.docker.getContainer(input.container);
+        const envVars = Object.entries(input.env || {}).reduce((arr, [key, value]) => {
+            return [...arr, `${key}=${value}`];
+        }, []);
+        const options = {
+            AttachStderr: input.attachStderr,
+            AttachStdin: input.attachStdin,
+            AttachStdout: input.attachStdout,
+            Cmd: ['bash', '-eu', '-o', 'pipefail', '-c', input.script],
+            Env: envVars,
+            Tty: input.tty,
+            WorkingDir: input.workingDir,
+        };
+        const exec = await container.exec(options);
+        const stream = await exec.start({});
+        container.modem.demuxStream(stream, this.out || process.stdout, this.out || process.stderr);
+        await new Promise((resolve, reject) => {
+            const onError = (err) => reject(err);
+            const onEnd = async () => {
+                exec.inspect((error, res) => {
+                    if (error)
+                        return reject(error);
+                    const code = res?.ExitCode ?? 0;
+                    if (code !== 0) {
+                        const msg = res?.ProcessConfig?.entrypoint
+                            ? `container exec failed (exit ${code})`
+                            : `command failed (exit ${code})`;
+                        return reject(new Error(msg));
+                    }
+                    resolve();
+                });
+            };
+            stream.on('error', onError);
+            stream.on('end', onEnd);
+            stream.on('close', onEnd); // some engines emit 'close' not 'end'
+        });
+    }
+}

package/dist/src/docker/operations/containers/index.d.ts

@@ -1,2 +1,3 @@
+export * from './ExecContainerOperation.js';
 export * from './ListContainersOperation.js';
 export * from './PruneContainersOperation.js';

package/dist/src/docker/operations/containers/index.js

@@ -1,2 +1,3 @@
+export * from './ExecContainerOperation.js';
 export * from './ListContainersOperation.js';
 export * from './PruneContainersOperation.js';

package/dist/src/monorepo/component.d.ts

@@ -7,8 +7,8 @@ export declare class Component {
     protected monorepo: Monorepo;
     constructor(_config: ComponentConfig, monorepo: Monorepo);
     get config(): ComponentConfig;
-    get context(): string | undefined;
-    get dependencies(): Component[];
+    get context(): string;
+    get dependencies(): string[];
     get imageName(): string;
     get imageTag(): string;
     get labels(): {

package/dist/src/monorepo/component.js

@@ -12,10 +12,10 @@ export class Component {
         return structuredClone(this._config);
     }
     get context() {
-        return this.config.context;
+        return this.config.docker?.context || this.name;
     }
     get dependencies() {
-        return this.monorepo.components.filter((c) => this.config.dependencies?.includes(c.name));
+        return this.config.docker?.dependencies || [];
     }
     get imageName() {
         return join(this.monorepo.name, this.name);
@@ -26,7 +26,7 @@ export class Component {
     get labels() {
         return {
             'emb/component': this.name,
-            ...this._config.labels,
+            ...this._config.docker?.labels,
         };
     }
     get name() {
@@ -60,9 +60,9 @@ export class Component {
     }
     async toDockerBuild() {
         return {
-            buildArgs: await this.monorepo.expand(deepmerge()(this.monorepo.defaults.docker?.buildArgs || {}, this.config.buildArgs || {})),
+            buildArgs: await this.monorepo.expand(deepmerge()(this.monorepo.defaults.docker?.buildArgs || {}, this.config.docker?.buildArgs || {})),
             context: this.rootdir,
-            dockerfile: this.config.dockerfile || 'Dockerfile',
+            dockerfile: this.config.docker?.dockerfile || 'Dockerfile',
             labels: deepmerge()({
                 ...this.monorepo.defaults.docker?.labels,
             }, this.labels),
@@ -71,7 +71,7 @@ export class Component {
             tag: this.imageTag
                 ? await this.monorepo.expand(this.imageTag)
                 : 'latest',
-            target: this.config.target || this.monorepo.defaults?.docker?.target,
+            target: this.config.docker?.target || this.monorepo.defaults?.docker?.target,
         };
     }
 }

package/dist/src/monorepo/config.d.ts

@@ -1,16 +1,19 @@
-import { ComponentConfig, DefaultSettings, FlavorConfig, IMonorepoConfig, IProjectConfig, PluginConfig } from '../config/index.js';
+import { ComponentConfig, DefaultSettings, FlavorConfig, IMonorepoConfig, IProjectConfig, PluginConfig, Task } from '../config/index.js';
 export declare class MonorepoConfig implements IMonorepoConfig {
-    components: ComponentConfig[];
+    currentFlavor: string;
     defaults: DefaultSettings;
     env: Record<string, string>;
     flavors: Array<FlavorConfig>;
     plugins: Array<PluginConfig>;
     project: IProjectConfig;
     vars: Record<string, unknown>;
+    tasks: Array<Task>;
+    private _components;
     constructor(config: IMonorepoConfig);
+    get components(): ComponentConfig[];
     component(name: string): ComponentConfig;
     flavor(name: string): FlavorConfig;
-    toJSON(): Required<IMonorepoConfig>;
+    toJSON(): IMonorepoConfig;
     with(overrides: Partial<IMonorepoConfig>): MonorepoConfig;
     withFlavor(name: string): MonorepoConfig;
 }