@enspirit/emb 0.0.9 → 0.1.1

package/dist/src/config/schema.json

@@ -1,34 +1,25 @@
 {
     "$id": "/schemas/config",
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "title": "EMB Config Schema",
+    "title": "EMBConfig",
     "type": "object",
+    "additionalProperties": false,
     "properties": {
         "project": {
-            "oneOf": [
-                {
-                    "type": "string",
-                    "minLength": 3,
-                    "description": "Shortcut for specifying the project name."
+            "type": "object",
+            "required": ["name"],
+            "properties": {
+                "name": {
+                    "$ref": "#/$defs/Identifier",
+                    "description": "The name of the project."
                 },
-                {
-                    "type": "object",
-                    "required": ["name"],
-                    "properties": {
-                        "name": {
-                            "type": "string",
-                            "minLength": 3,
-                            "description": "The name of the project."
-                        },
-                        "rootDir": {
-                            "type": "string",
-                            "minLength": 1,
-                            "description": "The root directory of the project."
-                        }
-                    },
-                    "additionalProperties": false
+                "rootDir": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The root directory of the project."
                 }
-            ]
+            },
+            "additionalProperties": false
         },
         "plugins": {
             "type": "array",
@@ -37,7 +28,7 @@
                 "required": ["name"],
                 "properties": {
                     "name": {
-                        "type": "string"
+                        "$ref": "#/$defs/Identifier"
                     },
                     "config": {}
                 },
@@ -57,31 +48,38 @@
             "additionalProperties": true
         },
         "defaults": {
-            "$ref": "#/$defs/defaults"
+            "$ref": "#/$defs/DefaultsConfig"
         },
         "components": {
-            "type": "array",
-            "items": {
-                "$ref": "#/$defs/component"
+            "type": "object",
+            "additionalProperties": {
+                "$ref": "#/$defs/ComponentConfig"
             }
         },
         "flavors": {
-            "type": "array",
-            "items": {
-                "$ref": "#/$defs/flavor"
+            "type": "object",
+            "additionalProperties": {
+                "$ref": "#/$defs/ProjectFlavorConfig"
             }
         },
         "tasks": {
-            "type": "array",
-            "items": {
-                "$ref": "#/$defs/task"
+            "type": "object",
+            "additionalProperties": {
+                "$ref": "#/$defs/TaskConfig"
             }
         }
     },
     "required": ["project"],
-    "additionalProperties": false,
     "$defs": {
-        "defaults": {
+        "Identifier": {
+            "type": "string",
+            "pattern": "^[a-zA-Z]+[\\w._-]+$"
+        },
+        "QualifiedIdentifier": {
+            "type": "string",
+            "pattern": "^([a-zA-Z]+[\\w._-]+:)?[a-zA-Z]+[\\w._-]+$"
+        },
+        "DefaultsConfig": {
             "type": "object",
             "description": "Default settings for build aspects",
             "additionalProperties": false,
@@ -90,8 +88,12 @@
                     "type": "object",
                     "description": "Default docker build settings",
                     "properties": {
-                        "tag": { "type": "string" },
-                        "target": { "type": "string" },
+                        "tag": {
+                            "type": "string"
+                        },
+                        "target": {
+                            "$ref": "#/$defs/Identifier"
+                        },
                         "buildArgs": {
                             "type": "object",
                             "additionalProperties": {
@@ -108,17 +110,14 @@
                 }
             }
         },
-        "task": {
+        "TaskConfig": {
             "type": "object",
-            "required": ["name"],
+            "required": [],
             "anyOf": [
                 { "required": ["script"] },
                 { "required": ["pre"] }
             ],
             "properties": {
-                "name": {
-                    "type": "string"
-                },
                 "description": {
                     "type": "string"
                 },
@@ -126,7 +125,7 @@
                     "type": "string"
                 },
                 "executor": {
-                    "type": "string"
+                    "$ref": "#/$defs/Identifier"
                 },
                 "options": {
                     "type": "object",
@@ -135,52 +134,19 @@
                 "pre": {
                     "type": "array",
                     "items": {
-                        "type": "string"
+                        "$ref": "#/$defs/Identifier"
                     }
                 }
             },
             "additionalProperties": false
         },
-        "component": {
+        "ComponentConfig": {
             "type": "object",
-            "required": ["name"],
+            "required": [],
             "properties": {
-                "name": {
+                "rootDir": {
                     "type": "string",
-                    "minLength": 3,
-                    "description": "The name 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": "Path to the component's root folder (relative to root of monorepo)"
                 },
                 "description": {
                     "type": "string",
@@ -188,39 +154,163 @@
                     "description": "A description of the component."
                 },
                 "tasks": {
-                    "type": "array",
-                    "items": {
-                        "$ref": "#/$defs/task"
+                    "type": "object",
+                    "additionalProperties": {
+                        "$ref": "#/$defs/TaskConfig"
+                    }
+                },
+                "resources": {
+                    "type": "object",
+                    "additionalProperties": {
+                        "$ref": "#/$defs/ResourceConfig"
+                    }
+                },
+                "flavors": {
+                    "type": "object",
+                    "additionalProperties": {
+                        "$ref": "#/$defs/ComponentFlavorConfig"
                     }
                 }
             },
             "additionalProperties": false
         },
-        "flavor": {
+        "DockerImageConfig": {
             "type": "object",
-            "required": ["name"],
             "properties": {
-                "name": {
-                    "type": "string"
-                },
-                "env": {
+                "buildArgs": {
                     "type": "object",
-                    "description": "Variables to install on the environment",
+                    "properties": {},
                     "additionalProperties": {
                         "type": "string"
                     }
                 },
-                "components": {
+                "target": {
+                    "type": "string",
+                    "description": "The stage to target for the build"
+                },
+                "dockerfile": {
+                    "type": "string",
+                    "description": "The Dockerfile to use"
+                }
+            },
+            "additionalProperties": false
+        },
+        "ProjectFlavorConfig": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [],
+            "properties": {
+                "defaults": {
+                    "$ref": "#/$defs/DefaultsConfig"
+                },
+                "patches": {
                     "type": "array",
                     "items": {
-                        "$ref": "#/$defs/component"
+                        "$ref": "#/$defs/JsonPatchOperation"
                     }
-                },
-                "defaults": {
-                    "$ref": "#/$defs/defaults"
+                }
+            }
+        },
+        "ResourceConfig": {
+            "type": "object",
+            "required": ["type"],
+            "properties": {
+                "type": { "type": "string" },
+                "params": {},
+                "dependencies": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/QualifiedIdentifier"
+                    },
+                    "uniqueItems": true
                 }
             },
+            "additionalProperties": false,
+            "allOf": [
+                {
+                    "if": {
+                        "properties": { "type": { "const": "docker/DockerImageConfig" } },
+                        "required": ["type"]
+                    },
+                    "then": {
+                        "properties": { "params": { "$ref": "#/$defs/DockerImageConfig" } }
+                    },
+                    "else": {
+                        "properties": { "params": { "type": "object" } }
+                    }
+                }
+            ]
+        },
+        "ComponentFlavorConfig": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [],
+            "properties": {
+                "patches": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/JsonPatchOperation"
+                    }
+                }
+            }
+        },
+        "JsonPatchAddOperation": {
+            "type": "object",
+            "properties": {
+                "op": { "const": "add" },
+                "path": { "type": "string", "minLength": 1 },
+                "value": {}
+            },
+            "required": ["op", "path", "value"],
+            "additionalProperties": false
+        },
+        "JsonPatchRemoveOperation": {
+            "type": "object",
+            "properties": {
+                "op": { "const": "remove" },
+                "path": { "type": "string", "minLength": 1 }
+            },
+            "required": ["op", "path"],
             "additionalProperties": false
+        },
+        "JsonPatchReplaceOperation": {
+            "type": "object",
+            "properties": {
+                "op": { "const": "replace" },
+                "path": { "type": "string", "minLength": 1 },
+                "value": {}
+            },
+            "required": ["op", "path", "value"],
+            "additionalProperties": false
+        },
+        "JsonPatchMoveOperation": {
+            "type": "object",
+            "properties": {
+                "op": { "const": "move" },
+                "path": { "type": "string", "minLength": 1 },
+                "from": { "type": "string", "minLength": 1 }
+            },
+            "required": ["op", "path", "from"],
+            "additionalProperties": false
+        },
+        "JsonPatchCopyOperation": {
+            "type": "object",
+            "properties": {
+                "op": { "const": "copy" },
+                "path": { "type": "string", "minLength": 1 },
+                "from": { "type": "string", "minLength": 1 }
+            },
+            "required": ["op", "path", "from"],
+            "additionalProperties": false
+        },
+        "JsonPatchOperation": {
+            "oneOf": [
+                { "$ref": "#/$defs/JsonPatchAddOperation" },
+                { "$ref": "#/$defs/JsonPatchRemoveOperation" },
+                { "$ref": "#/$defs/JsonPatchReplaceOperation" },
+                { "$ref": "#/$defs/JsonPatchMoveOperation" },
+                { "$ref": "#/$defs/JsonPatchCopyOperation" }
+            ]
         }
     }
 }

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

@@ -1,47 +1,14 @@
-import { EMBConfigSchema, Task } from './schema.js';
-export type UserConfig = EMBConfigSchema;
-export type IProjectConfig = {
-    name: string;
-    rootDir: string;
-};
-export type ComponentConfig = {
-    name: 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, string>;
-        labels?: Record<string, string>;
-        tag?: string;
-        target?: string;
-    };
-};
-export type FlavorConfig = {
-    components?: Array<ComponentConfig>;
-    defaults?: DefaultSettings;
-    env?: Record<string, string>;
-    name: string;
-};
-export type PluginConfig = {
-    config?: unknown;
-    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>;
+import { EMBConfig, ResourceConfig } from './schema.js';
+export * from './schema.js';
+type RemoveIndexSignature<T> = {
+    [K in keyof T as K extends string ? (string extends K ? never : K) : K]: T[K];
+};
+export type ProjectConfig = Required<EMBConfig['project']>;
+export type UserConfig = EMBConfig & {
+    project: ProjectConfig;
+};
+export type PluginConfig = Required<EMBConfig>['plugins'][number];
+export type IResourceConfig = RemoveIndexSignature<ResourceConfig>;
+export type QualifiedResourceConfig = IResourceConfig & {
+    id: string;
 };

package/dist/src/config/types.js

@@ -1 +1 @@
-export {};
+export * from './schema.js';

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

@@ -1,3 +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>;
+import { ComponentConfig, UserConfig } from './types.js';
+export declare const validateUserConfig: (pathOrObject: string | unknown) => Promise<UserConfig>;
+export declare const validateEmbfile: (pathOrObject: string | unknown) => Promise<ComponentConfig>;

package/dist/src/config/validation.js

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

package/dist/src/context.d.ts

@@ -1,3 +1,3 @@
 import { EmbContext } from './types.js';
 export declare const getContext: () => EmbContext;
-export declare const setContext: (ctx: EmbContext) => void;
+export declare const setContext: (ctx: EmbContext) => EmbContext;

package/dist/src/context.js

@@ -4,4 +4,5 @@ export const getContext = () => {
 };
 export const setContext = (ctx) => {
     context = ctx;
+    return ctx;
 };

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

@@ -1,4 +1,3 @@
-export * from './buildImage.js';
 export * from './deleteImage.js';
 export * from './listImages.js';
 export * from './pruneImages.js';

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

@@ -1,4 +1,3 @@
-export * from './buildImage.js';
 export * from './deleteImage.js';
 export * from './listImages.js';
 export * from './pruneImages.js';

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

@@ -1,7 +1,7 @@
+import './resources/index.js';
 export * from './compose/index.js';
 export * from './containers/index.js';
 export * from './images/index.js';
 export * from './operations/index.js';
 export * from './protobuf/index.js';
-export * from './types.js';
 export * from './utils.js';

package/dist/src/docker/index.js

@@ -1,7 +1,7 @@
+import './resources/index.js';
 export * from './compose/index.js';
 export * from './containers/index.js';
 export * from './images/index.js';
 export * from './operations/index.js';
 export * from './protobuf/index.js';
-export * from './types.js';
 export * from './utils.js';

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

@@ -58,8 +58,9 @@ export class ContainerExecOperation extends AbstractOperation {
             const onError = (err) => reject(err);
             const onEnd = async () => {
                 exec.inspect((error, res) => {
-                    if (error)
+                    if (error) {
                         return reject(error);
+                    }
                     const code = res?.ExitCode ?? 0;
                     if (code !== 0) {
                         const msg = res?.ProcessConfig?.entrypoint

package/dist/src/docker/operations/images/BuildImageOperation.d.ts

@@ -3,18 +3,17 @@ import { AbstractOperation } from '../../../operations/index.js';
 /**
  * https://docs.docker.com/reference/api/engine/version/v1.37/#tag/Image/operation/ImageBuild
  */
-declare const schema: z.ZodObject<{
-    buildArgs: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+export declare const BuildImageOperationInputSchema: z.ZodObject<{
     context: z.ZodString;
-    dockerfile: z.ZodString;
-    labels: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    dockerfile: z.ZodDefault<z.ZodOptional<z.ZodString>>;
     src: z.ZodArray<z.ZodString>;
-    tag: z.ZodString;
+    tag: z.ZodOptional<z.ZodString>;
+    buildArgs: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    labels: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
     target: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
-export declare class BuildImageOperation extends AbstractOperation<typeof schema, Array<unknown>> {
+export declare class BuildImageOperation extends AbstractOperation<typeof BuildImageOperationInputSchema, Array<unknown>> {
     private observer?;
     constructor(observer?: ((progress: string) => void) | undefined);
-    protected _run(input: z.input<typeof schema>): Promise<Array<unknown>>;
+    protected _run(input: z.input<typeof BuildImageOperationInputSchema>): Promise<Array<unknown>>;
 }
-export {};

package/dist/src/docker/operations/images/BuildImageOperation.js

@@ -4,29 +4,35 @@ import { AbstractOperation } from '../../../operations/index.js';
 /**
  * https://docs.docker.com/reference/api/engine/version/v1.37/#tag/Image/operation/ImageBuild
  */
-const schema = z.object({
-    buildArgs: z
-        .record(z.string(), z.string())
-        .optional()
-        .describe('Map of string pairs for build-time variables'),
+export const BuildImageOperationInputSchema = z.object({
+    //
     context: z.string().describe('Path to the build context'),
     dockerfile: z
         .string()
-        .describe('Path within the build context to the Dockerfile.'),
-    labels: z
-        .record(z.string(), z.string())
         .optional()
-        .describe('Arbitrary key/value labels to set on the image, as a JSON map of string pairs.'),
+        .default('Dockerfile')
+        .describe('Path within the build context to the Dockerfile.'),
     src: z.array(z.string()),
     tag: z.z
         .string()
+        .optional()
+        .describe('latest')
         .describe('A name and optional tag to apply to the image in the name:tag'),
+    //
+    buildArgs: z
+        .record(z.string(), z.string())
+        .optional()
+        .describe('Map of string pairs for build-time variables'),
+    labels: z
+        .record(z.string(), z.string())
+        .optional()
+        .describe('Arbitrary key/value labels to set on the image, as a JSON map of string pairs.'),
     target: z.string().optional().describe('Target build stage'),
 });
 export class BuildImageOperation extends AbstractOperation {
     observer;
     constructor(observer) {
-        super(schema);
+        super(BuildImageOperationInputSchema);
         this.observer = observer;
     }
     async _run(input) {