@enspirit/emb 0.0.6 → 0.0.7

package/dist/src/config/schema.json

@@ -70,6 +70,12 @@
             "items": {
                 "$ref": "#/$defs/flavor"
             }
+        },
+        "tasks": {
+            "type": "array",
+            "items": {
+                "$ref": "#/$defs/task"
+            }
         }
     },
     "required": ["project"],
@@ -104,7 +110,11 @@
         },
         "task": {
             "type": "object",
-            "required": ["name", "script"],
+            "required": ["name"],
+            "anyOf": [
+                { "required": ["script"] },
+                { "required": ["pre"] }
+            ],
             "properties": {
                 "name": {
                     "type": "string"
@@ -121,6 +131,12 @@
                 "options": {
                     "type": "object",
                     "additionalProperties": true
+                },
+                "pre": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
                 }
             },
             "additionalProperties": false
@@ -134,37 +150,43 @@
                     "minLength": 3,
                     "description": "The name of the component."
                 },
-                "context": {
-                    "type": "string",
-                    "minLength": 1,
-                    "description": "The directory of the component."
+                "docker": {
+                    "type": "object",
+                    "properties": {
+                        "context": {
+                            "type": "string",
+                            "minLength": 1,
+                            "description": "The directory of the component."
+                        },
+                        "buildArgs": {
+                            "type": "object",
+                            "properties": {},
+                            "additionalProperties": {
+                                "type": "string"
+                            }
+                        },
+                        "dependencies": {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        },
+                        "target": {
+                            "type": "string",
+                            "description": "The stage to target for the build"
+                        },
+                        "dockerfile": {
+                            "type": "string",
+                            "description": "The Dockerfile to use"
+                        }
+                    },
+                    "additionalProperties": false
                 },
                 "description": {
                     "type": "string",
                     "minLength": 1,
                     "description": "A description of the component."
                 },
-                "buildArgs": {
-                    "type": "object",
-                    "properties": {},
-                    "additionalProperties": {
-                        "type": "string"
-                    }
-                },
-                "dependencies": {
-                    "type": "array",
-                    "items": {
-                        "type": "string"
-                    }
-                },
-                "target": {
-                    "type": "string",
-                    "description": "The stage to target for the build"
-                },
-                "dockerfile": {
-                    "type": "string",
-                    "description": "The Dockerfile to use"
-                },
                 "tasks": {
                     "type": "array",
                     "items": {

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

@@ -5,13 +5,15 @@ export type IProjectConfig = {
     rootDir: string;
 };
 export type ComponentConfig = {
-    buildArgs?: Record<string, 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 = {
@@ -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/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/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,17 +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 {
+    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;
 }

package/dist/src/monorepo/config.js

@@ -1,12 +1,16 @@
 import deepMerge from '@fastify/deepmerge';
 import { deepMergeArray } from '../utils/index.js';
 export class MonorepoConfig {
+    // the flavor we come from
+    currentFlavor;
+    //
     defaults;
     env;
     flavors;
     plugins;
     project;
     vars;
+    tasks;
     _components;
     constructor(config) {
         this._components = config.components.reduce((map, cmp) => {
@@ -19,6 +23,8 @@ export class MonorepoConfig {
         this.flavors = config.flavors || [];
         this.env = config.env || {};
         this.plugins = config.plugins || [];
+        this.tasks = config.tasks || [];
+        this.currentFlavor = config.currentFlavor || 'default';
     }
     get components() {
         return [...this._components.values()];
@@ -39,6 +45,7 @@ export class MonorepoConfig {
     }
     toJSON() {
         return {
+            currentFlavor: this.currentFlavor,
             components: this.components,
             defaults: this.defaults,
             env: this.env,
@@ -46,11 +53,13 @@ export class MonorepoConfig {
             plugins: this.plugins,
             project: this.project,
             vars: this.vars,
+            tasks: this.tasks,
         };
     }
     with(overrides) {
         const newConfig = {
             ...this.toJSON(),
+            ...overrides,
             components: deepMerge({
                 mergeArray() {
                     // Merge components by identifying them by name
@@ -59,7 +68,7 @@ export class MonorepoConfig {
                     });
                 },
             })(this.components, overrides?.components || []),
-            defaults: deepMerge()(this.defaults, overrides.defaults),
+            defaults: deepMerge()(this.defaults || {}, overrides.defaults || {}),
             env: deepMerge()(this.env, overrides?.env || {}),
             project: deepMerge()(this.project, overrides?.project || {}),
             vars: deepMerge()(this.vars, overrides?.vars || {}),
@@ -67,6 +76,9 @@ export class MonorepoConfig {
         return new MonorepoConfig(newConfig);
     }
     withFlavor(name) {
-        return this.with(this.flavor(name));
+        return this.with({
+            ...this.flavor(name),
+            currentFlavor: name,
+        });
     }
 }

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

@@ -1,7 +1,9 @@
 export * from './component.js';
 export * from './config.js';
 export * from './monorepo.js';
+export * from './operations/index.js';
 export * from './plugins/index.js';
 export * from './store/index.js';
+export * from './taskManagerFactory.js';
 export * from './types.js';
 export * from './utils/index.js';

package/dist/src/monorepo/index.js

@@ -1,7 +1,9 @@
 export * from './component.js';
 export * from './config.js';
 export * from './monorepo.js';
+export * from './operations/index.js';
 export * from './plugins/index.js';
 export * from './store/index.js';
+export * from './taskManagerFactory.js';
 export * from './types.js';
 export * from './utils/index.js';

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

@@ -1,12 +1,11 @@
 import { IMonorepoConfig } from '../config/index.js';
-import { IOperation } from '../operations/types.js';
+import { IOperation } from '../operations/index.js';
 import { TemplateExpander } from '../utils/index.js';
 import { Component } from './component.js';
 import { EMBStore } from './store/index.js';
 import { TaskInfo } from './types.js';
 export declare class Monorepo {
     private _config;
-    private _env;
     private _store;
     private initialized;
     constructor(config: IMonorepoConfig);
@@ -16,12 +15,15 @@ export declare class Monorepo {
     get flavors(): string[];
     get name(): string;
     get rootDir(): string;
+    get currentFlavor(): string;
     get store(): EMBStore;
     get tasks(): TaskInfo[];
     get vars(): Record<string, unknown>;
     component(name: string): Component;
+    task(nameOrId: string): TaskInfo;
     expand(str: string, expander?: TemplateExpander): Promise<string>;
     expand<R extends Record<string, unknown>>(record: R, expander?: TemplateExpander): Promise<R>;
+    private installStore;
     init(): Promise<Monorepo>;
     join(...paths: string[]): string;
     run<I, O>(operation: IOperation<I, O>, args: I): Promise<O>;

package/dist/src/monorepo/monorepo.js

@@ -6,12 +6,10 @@ import { getPlugin } from './plugins/index.js';
 import { EMBStore } from './store/index.js';
 export class Monorepo {
     _config;
-    _env;
     _store;
     initialized = false;
     constructor(config) {
         this._config = new MonorepoConfig(config);
-        this._env = config.env || {};
     }
     // TODO: cache/improve
     get components() {
@@ -32,13 +30,22 @@ export class Monorepo {
     get rootDir() {
         return this._config.project.rootDir;
     }
+    get currentFlavor() {
+        return this._config.currentFlavor;
+    }
     get store() {
         return this._store;
     }
     get tasks() {
+        const globalTasks = (this._config.tasks || [])?.map((t) => {
+            return {
+                ...t,
+                id: `global:${t.name}`,
+            };
+        });
         return this.components.reduce((tasks, cmp) => {
             return [...tasks, ...cmp.tasks];
-        }, []);
+        }, globalTasks);
     }
     get vars() {
         return this._config.vars;
@@ -46,6 +53,20 @@ export class Monorepo {
     component(name) {
         return new Component(this._config.component(name), this);
     }
+    task(nameOrId) {
+        const byId = this.tasks.find((t) => t.id === nameOrId);
+        if (byId) {
+            return byId;
+        }
+        const found = this.tasks.filter((t) => t.name === nameOrId);
+        if (found.length > 1) {
+            throw new Error(`Task name ambigous, found multiple matches: ${nameOrId}`);
+        }
+        if (found.length === 0) {
+            throw new Error(`Task not found: ${nameOrId}`);
+        }
+        return found[0];
+    }
     async expand(strOrRecord, expander = new TemplateExpander()) {
         const options = {
             default: 'vars',
@@ -59,13 +80,16 @@ export class Monorepo {
         }
         return expander.expandRecord(strOrRecord, options);
     }
+    async installStore(store) {
+        this._store = store || new EMBStore(this);
+        await this._store.init();
+    }
     // Initialize
     async init() {
         if (this.initialized) {
             throw new Error('Monorepo already initialized');
         }
-        this._store = new EMBStore(this);
-        await this._store.init();
+        await this.installStore();
         const plugins = this._config.plugins.map((p) => {
             const PluginClass = getPlugin(p.name);
             return new PluginClass(p.config, this);
@@ -100,7 +124,7 @@ export class Monorepo {
     }
     async withFlavor(name) {
         const repo = new Monorepo(this._config.withFlavor(name));
-        await repo.init();
+        await repo.installStore();
         return repo;
     }
 }

package/dist/src/monorepo/operations/components/BuildComponentsOperation.d.ts

@@ -1,11 +1,20 @@
 import * as z from 'zod';
+import { DockerComponentBuild } from '../../../docker/index.js';
 import { AbstractOperation } from '../../../operations/index.js';
+export type BuildComponentMeta = {
+    dryRun?: boolean;
+    cacheHit?: boolean;
+    build: DockerComponentBuild;
+    preBuildMeta?: string;
+    sentinelFile: string;
+};
 declare const schema: z.ZodObject<{
     components: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    dryRun: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$strip>;
-export declare class BuildComponentsOperation extends AbstractOperation<typeof schema, Array<unknown>> {
+export declare class BuildComponentsOperation extends AbstractOperation<typeof schema, Record<string, BuildComponentMeta>> {
     constructor();
-    protected _run(input: z.input<typeof schema>): Promise<Array<unknown>>;
+    protected _run(input: z.input<typeof schema>): Promise<Record<string, BuildComponentMeta>>;
     private buildComponent;
 }
 export {};