@quadnix/octo 0.0.20 → 0.0.22

package/dist/models/execution/execution.interface.d.ts

@@ -1,4 +1,9 @@
 import type { IModelReference } from '../model.interface.js';
+/**
+ * {@link Execution} model interface.
+ *
+ * @group Model Interfaces
+ */
 export interface IExecution {
     deployment: IModelReference;
     environment: IModelReference;

package/dist/models/execution/execution.model.d.ts

@@ -1,16 +1,37 @@
 import type { UnknownModel } from '../../app.type.js';
-import type { Diff } from '../../functions/diff/diff.js';
 import { Deployment } from '../deployment/deployment.model.js';
 import { Environment } from '../environment/environment.model.js';
 import { AModel } from '../model.abstract.js';
 import { Subnet } from '../subnet/subnet.model.js';
 import type { IExecution } from './execution.interface.js';
+/**
+ * An Execution model is the combination of a {@link Deployment}, an {@link Environment}, and a {@link Subnet}.
+ * It represents a physical server, running the deployment code, in the given environment, placed in the given subnet.
+ *
+ * @example
+ * ```ts
+ * const deployment = new Deployment('v0.0.1');
+ * const environment = new Environment('qa');
+ * const subnet = new Subnet(region, 'private');
+ * const execution = new Execution(deployment, environment, subnet);
+ * ```
+ * @group Models
+ * @see Definition of [Default Models](/docs/fundamentals/models#default-models).
+ */
 export declare class Execution extends AModel<IExecution, Execution> {
-    readonly MODEL_NAME: string;
+    readonly NODE_NAME: string;
+    /**
+     * A set of environment variables to be passed to the Docker container.
+     * It represents setting the [--env](https://docs.docker.com/compose/environment-variables/set-environment-variables/)
+     * option while running a Docker container.
+     */
     readonly environmentVariables: Map<string, string>;
     constructor(deployment: Deployment, environment: Environment, subnet: Subnet);
+    /**
+     * An `executionId` is a unique identifier for this execution.
+     * - Format of executionId is `{serverKey}-{deploymentTag}-{regionId}-{environmentName}-{subnetName}`
+     */
     get executionId(): string;
-    diffProperties(previous: Execution): Promise<Diff[]>;
     setContext(): string;
     synth(): IExecution;
     static unSynth(execution: IExecution, deReferenceContext: (context: string) => Promise<UnknownModel>): Promise<Execution>;

package/dist/models/execution/execution.model.js

@@ -9,17 +9,37 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 };
 var Execution_1;
 import { Model } from '../../decorators/model.decorator.js';
-import { DiffUtility } from '../../functions/diff/diff.utility.js';
+import { Validate } from '../../decorators/validate.decorator.js';
 import { ArrayUtility } from '../../utilities/array/array.utility.js';
 import { Deployment } from '../deployment/deployment.model.js';
 import { Environment } from '../environment/environment.model.js';
 import { AModel } from '../model.abstract.js';
 import { Subnet } from '../subnet/subnet.model.js';
+/**
+ * An Execution model is the combination of a {@link Deployment}, an {@link Environment}, and a {@link Subnet}.
+ * It represents a physical server, running the deployment code, in the given environment, placed in the given subnet.
+ *
+ * @example
+ * ```ts
+ * const deployment = new Deployment('v0.0.1');
+ * const environment = new Environment('qa');
+ * const subnet = new Subnet(region, 'private');
+ * const execution = new Execution(deployment, environment, subnet);
+ * ```
+ * @group Models
+ * @see Definition of [Default Models](/docs/fundamentals/models#default-models).
+ */
 let Execution = Execution_1 = class Execution extends AModel {
-    MODEL_NAME = 'execution';
-    environmentVariables = new Map();
     constructor(deployment, environment, subnet) {
         super();
+        this.NODE_NAME = 'execution';
+        /**
+         * A set of environment variables to be passed to the Docker container.
+         * It represents setting the [--env](https://docs.docker.com/compose/environment-variables/set-environment-variables/)
+         * option while running a Docker container.
+         */
+        this.environmentVariables = new Map();
+        // Check if execution can be placed in this subnet.
         const environmentRegions = environment.getParents('region')['region'] || [];
         const subnetRegions = subnet.getParents('region')['region'] || [];
         if (environmentRegions.length > 0 &&
@@ -27,6 +47,7 @@ let Execution = Execution_1 = class Execution extends AModel {
             environmentRegions[0].to.regionId !== subnetRegions[0].to.regionId) {
             throw new Error('Environment and Subnet must be in the same region!');
         }
+        // Check for duplicates.
         const deploymentExecutions = (deployment.getChildren('execution')['execution'] || []).map((d) => d.to);
         const environmentExecutions = (environment.getChildren('execution')['execution'] || []).map((d) => d.to);
         const subnetExecutions = (subnet.getChildren('execution')['execution'] || []).map((d) => d.to);
@@ -35,10 +56,16 @@ let Execution = Execution_1 = class Execution extends AModel {
         }, deploymentExecutions, environmentExecutions, subnetExecutions).length > 0) {
             throw new Error('Execution already exists!');
         }
+        // In order for this execution to properly have defined its parent-child relationship, all parents
+        // must claim it as their child. Doing it here, prevents the confusion.
         deployment.addChild('deploymentTag', this, 'executionId');
         environment.addChild('environmentName', this, 'executionId');
         subnet.addChild('subnetId', this, 'executionId');
     }
+    /**
+     * An `executionId` is a unique identifier for this execution.
+     * - Format of executionId is `{serverKey}-{deploymentTag}-{regionId}-{environmentName}-{subnetName}`
+     */
     get executionId() {
         const parents = this.getParents();
         const deployment = parents['deployment'][0].to;
@@ -54,16 +81,13 @@ let Execution = Execution_1 = class Execution extends AModel {
             subnet.subnetName,
         ].join('-');
     }
-    async diffProperties(previous) {
-        return DiffUtility.diffMap(previous, this, 'environmentVariables');
-    }
     setContext() {
         const parents = this.getParents();
         const deployment = parents['deployment'][0]['to'];
         const environment = parents['environment'][0]['to'];
         const subnet = parents['subnet'][0]['to'];
         return [
-            `${this.MODEL_NAME}=${this.executionId}`,
+            `${this.NODE_NAME}=${this.executionId}`,
             deployment.getContext(),
             environment.getContext(),
             subnet.getContext(),
@@ -94,6 +118,15 @@ let Execution = Execution_1 = class Execution extends AModel {
         return newExecution;
     }
 };
+__decorate([
+    Validate({
+        destruct: (value) => {
+            return Array.from(value.keys());
+        },
+        options: { maxLength: 64, minLength: 2, regex: /^[a-zA-Z][\w-]*[a-zA-Z0-9]$/ },
+    }),
+    __metadata("design:type", Map)
+], Execution.prototype, "environmentVariables", void 0);
 Execution = Execution_1 = __decorate([
     Model(),
     __metadata("design:paramtypes", [Deployment, Environment, Subnet])

package/dist/models/execution/execution.model.js.map

@@ -1 +1 @@
-{"version":3,"file":"execution.model.js","sourceRoot":"","sources":["../../../src/models/execution/execution.model.ts"],"names":[],"mappings":";;;;;;;;;;AACA,OAAO,EAAE,KAAK,EAAE,MAAM,qCAAqC,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,sCAAsC,CAAC;AAEnE,OAAO,EAAE,YAAY,EAAE,MAAM,wCAAwC,CAAC;AACtE,OAAO,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,qCAAqC,CAAC;AAClE,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAG9C,OAAO,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAC;AAI5C,IAAM,SAAS,iBAAf,MAAM,SAAU,SAAQ,MAA6B;IACjD,UAAU,GAAW,WAAW,CAAC;IAEjC,oBAAoB,GAAwB,IAAI,GAAG,EAAE,CAAC;IAE/D,YAAY,UAAsB,EAAE,WAAwB,EAAE,MAAc;QAC1E,KAAK,EAAE,CAAC;QAGR,MAAM,kBAAkB,GAAG,WAAW,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;QAC5E,MAAM,aAAa,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;QAClE,IACE,kBAAkB,CAAC,MAAM,GAAG,CAAC;YAC7B,aAAa,CAAC,MAAM,GAAG,CAAC;YACvB,kBAAkB,CAAC,CAAC,CAAC,CAAC,EAAa,CAAC,QAAQ,KAAM,aAAa,CAAC,CAAC,CAAC,CAAC,EAAa,CAAC,QAAQ,EAC1F,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;QACxE,CAAC;QAGD,MAAM,oBAAoB,GAAG,CAAC,UAAU,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CACvF,CAAC,CAAC,EAAa,EAAE,CAAC,CAAC,CAAC,EAAe,CACpC,CAAC;QACF,MAAM,qBAAqB,GAAG,CAAC,WAAW,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CACzF,CAAC,CAAC,EAAa,EAAE,CAAC,CAAC,CAAC,EAAe,CACpC,CAAC;QACF,MAAM,gBAAgB,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAC/E,CAAC,CAAC,EAAa,EAAE,CAAC,CAAC,CAAC,EAAe,CACpC,CAAC;QAEF,IACE,YAAY,CAAC,SAAS,CACpB,CAAC,CAAY,EAAE,CAAY,EAAW,EAAE;YACtC,OAAO,CAAC,CAAC,WAAW,KAAK,CAAC,CAAC,WAAW,CAAC;QACzC,CAAC,EACD,oBAAoB,EACpB,qBAAqB,EACrB,gBAAgB,CACjB,CAAC,MAAM,GAAG,CAAC,EACZ,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;QAC/C,CAAC;QAID,UAAU,CAAC,QAAQ,CAAC,eAAe,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;QAC1D,WAAW,CAAC,QAAQ,CAAC,iBAAiB,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;QAC7D,MAAM,CAAC,QAAQ,CAAC,UAAU,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;IACnD,CAAC;IAED,IAAI,WAAW;QACb,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAClC,MAAM,UAAU,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,EAAgB,CAAC;QAC7D,MAAM,MAAM,GAAG,UAAU,CAAC,UAAU,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAY,CAAC;QACjE,MAAM,WAAW,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,EAAiB,CAAC;QAChE,MAAM,MAAM,GAAG,WAAW,CAAC,UAAU,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAY,CAAC;QAClE,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAY,CAAC;QACjD,OAAO;YACL,MAAM,CAAC,SAAS;YAChB,UAAU,CAAC,aAAa;YACxB,MAAM,CAAC,QAAQ;YACf,WAAW,CAAC,eAAe;YAC3B,MAAM,CAAC,UAAU;SAClB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACd,CAAC;IAEQ,KAAK,CAAC,cAAc,CAAC,QAAmB;QAC/C,OAAO,WAAW,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,EAAE,sBAAsB,CAAC,CAAC;IACrE,CAAC;IAEQ,UAAU;QACjB,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAClC,MAAM,UAAU,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAe,CAAC;QAChE,MAAM,WAAW,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAgB,CAAC;QACnE,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAW,CAAC;QACpD,OAAO;YACL,GAAG,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,WAAW,EAAE;YACxC,UAAU,CAAC,UAAU,EAAE;YACvB,WAAW,CAAC,UAAU,EAAE;YACxB,MAAM,CAAC,UAAU,EAAE;SACpB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACd,CAAC;IAEQ,KAAK;QACZ,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAClC,MAAM,UAAU,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAe,CAAC;QAChE,MAAM,WAAW,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAgB,CAAC;QACnE,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAW,CAAC;QAEpD,OAAO;YACL,UAAU,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,UAAU,EAAE,EAAE;YAChD,WAAW,EAAE,EAAE,OAAO,EAAE,WAAW,CAAC,UAAU,EAAE,EAAE;YAClD,oBAAoB,EAAE,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,oBAAoB,IAAI,IAAI,GAAG,EAAE,CAAC;YAChF,MAAM,EAAE,EAAE,OAAO,EAAE,MAAM,CAAC,UAAU,EAAE,EAAE;SACzC,CAAC;IACJ,CAAC;IAED,MAAM,CAAU,KAAK,CAAC,OAAO,CAC3B,SAAqB,EACrB,kBAA8D;QAE9D,MAAM,CAAC,UAAU,EAAE,WAAW,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,OAAO,CAAC,GAAG,CAAC;YAC3D,kBAAkB,CAAC,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC;YAChD,kBAAkB,CAAC,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC;YACjD,kBAAkB,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC;SAC7C,CAAC,CAAsC,CAAC;QACzC,MAAM,YAAY,GAAG,IAAI,WAAS,CAAC,UAAU,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC;QAEpE,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,oBAAoB,CAAC,EAAE,CAAC;YAC1E,YAAY,CAAC,oBAAoB,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACpD,CAAC;QAED,OAAO,YAAY,CAAC;IACtB,CAAC;CACF,CAAA;AAlHY,SAAS;IADrB,KAAK,EAAE;qCAMkB,UAAU,EAAe,WAAW,EAAU,MAAM;GALjE,SAAS,CAkHrB"}
+{"version":3,"file":"execution.model.js","sourceRoot":"","sources":["../../../src/models/execution/execution.model.ts"],"names":[],"mappings":";;;;;;;;;;AACA,OAAO,EAAE,KAAK,EAAE,MAAM,qCAAqC,CAAC;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,wCAAwC,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,MAAM,wCAAwC,CAAC;AACtE,OAAO,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,qCAAqC,CAAC;AAClE,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAG9C,OAAO,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAC;AAGnD;;;;;;;;;;;;;GAaG;AAEI,IAAM,SAAS,iBAAf,MAAM,SAAU,SAAQ,MAA6B;IAgB1D,YAAY,UAAsB,EAAE,WAAwB,EAAE,MAAc;QAC1E,KAAK,EAAE,CAAC;QAhBD,cAAS,GAAW,WAAW,CAAC;QAEzC;;;;WAIG;QAOM,yBAAoB,GAAwB,IAAI,GAAG,EAAE,CAAC;QAK7D,mDAAmD;QACnD,MAAM,kBAAkB,GAAG,WAAW,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;QAC5E,MAAM,aAAa,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;QAClE,IACE,kBAAkB,CAAC,MAAM,GAAG,CAAC;YAC7B,aAAa,CAAC,MAAM,GAAG,CAAC;YACvB,kBAAkB,CAAC,CAAC,CAAC,CAAC,EAAa,CAAC,QAAQ,KAAM,aAAa,CAAC,CAAC,CAAC,CAAC,EAAa,CAAC,QAAQ,EAC1F,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;QACxE,CAAC;QAED,wBAAwB;QACxB,MAAM,oBAAoB,GAAG,CAAC,UAAU,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CACvF,CAAC,CAAC,EAAa,EAAE,CAAC,CAAC,CAAC,EAAe,CACpC,CAAC;QACF,MAAM,qBAAqB,GAAG,CAAC,WAAW,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CACzF,CAAC,CAAC,EAAa,EAAE,CAAC,CAAC,CAAC,EAAe,CACpC,CAAC;QACF,MAAM,gBAAgB,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAC/E,CAAC,CAAC,EAAa,EAAE,CAAC,CAAC,CAAC,EAAe,CACpC,CAAC;QAEF,IACE,YAAY,CAAC,SAAS,CACpB,CAAC,CAAY,EAAE,CAAY,EAAW,EAAE;YACtC,OAAO,CAAC,CAAC,WAAW,KAAK,CAAC,CAAC,WAAW,CAAC;QACzC,CAAC,EACD,oBAAoB,EACpB,qBAAqB,EACrB,gBAAgB,CACjB,CAAC,MAAM,GAAG,CAAC,EACZ,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;QAC/C,CAAC;QAED,kGAAkG;QAClG,uEAAuE;QACvE,UAAU,CAAC,QAAQ,CAAC,eAAe,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;QAC1D,WAAW,CAAC,QAAQ,CAAC,iBAAiB,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;QAC7D,MAAM,CAAC,QAAQ,CAAC,UAAU,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;IACnD,CAAC;IAED;;;OAGG;IACH,IAAI,WAAW;QACb,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAClC,MAAM,UAAU,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,EAAgB,CAAC;QAC7D,MAAM,MAAM,GAAG,UAAU,CAAC,UAAU,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAY,CAAC;QACjE,MAAM,WAAW,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,EAAiB,CAAC;QAChE,MAAM,MAAM,GAAG,WAAW,CAAC,UAAU,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAY,CAAC;QAClE,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAY,CAAC;QACjD,OAAO;YACL,MAAM,CAAC,SAAS;YAChB,UAAU,CAAC,aAAa;YACxB,MAAM,CAAC,QAAQ;YACf,WAAW,CAAC,eAAe;YAC3B,MAAM,CAAC,UAAU;SAClB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACd,CAAC;IAEQ,UAAU;QACjB,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAClC,MAAM,UAAU,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAe,CAAC;QAChE,MAAM,WAAW,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAgB,CAAC;QACnE,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAW,CAAC;QACpD,OAAO;YACL,GAAG,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,WAAW,EAAE;YACvC,UAAU,CAAC,UAAU,EAAE;YACvB,WAAW,CAAC,UAAU,EAAE;YACxB,MAAM,CAAC,UAAU,EAAE;SACpB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACd,CAAC;IAEQ,KAAK;QACZ,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAClC,MAAM,UAAU,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAe,CAAC;QAChE,MAAM,WAAW,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAgB,CAAC;QACnE,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAW,CAAC;QAEpD,OAAO;YACL,UAAU,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,UAAU,EAAE,EAAE;YAChD,WAAW,EAAE,EAAE,OAAO,EAAE,WAAW,CAAC,UAAU,EAAE,EAAE;YAClD,oBAAoB,EAAE,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,oBAAoB,IAAI,IAAI,GAAG,EAAE,CAAC;YAChF,MAAM,EAAE,EAAE,OAAO,EAAE,MAAM,CAAC,UAAU,EAAE,EAAE;SACzC,CAAC;IACJ,CAAC;IAED,MAAM,CAAU,KAAK,CAAC,OAAO,CAC3B,SAAqB,EACrB,kBAA8D;QAE9D,MAAM,CAAC,UAAU,EAAE,WAAW,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,OAAO,CAAC,GAAG,CAAC;YAC3D,kBAAkB,CAAC,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC;YAChD,kBAAkB,CAAC,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC;YACjD,kBAAkB,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC;SAC7C,CAAC,CAAsC,CAAC;QACzC,MAAM,YAAY,GAAG,IAAI,WAAS,CAAC,UAAU,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC;QAEpE,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,oBAAoB,CAAC,EAAE,CAAC;YAC1E,YAAY,CAAC,oBAAoB,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACpD,CAAC;QAED,OAAO,YAAY,CAAC;IACtB,CAAC;CACF,CAAA;AA/GU;IANR,QAAQ,CAAC;QACR,QAAQ,EAAE,CAAC,KAA0B,EAAY,EAAE;YACjD,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;QAClC,CAAC;QACD,OAAO,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,6BAA6B,EAAE;KAC/E,CAAC;8BAC6B,GAAG;uDAA6B;AAdpD,SAAS;IADrB,KAAK,EAAE;qCAiBkB,UAAU,EAAe,WAAW,EAAU,MAAM;GAhBjE,SAAS,CA6HrB"}

package/dist/models/image/image.interface.d.ts

@@ -1,4 +1,9 @@
 import type { Image } from './image.model.js';
+/**
+ * {@link Image} model interface.
+ *
+ * @group Model Interfaces
+ */
 export interface IImage {
     dockerOptions: Image['dockerOptions'];
     imageId: Image['imageId'];

package/dist/models/image/image.model.d.ts

@@ -1,22 +1,55 @@
 import type { UnknownModel } from '../../app.type.js';
-import type { Diff } from '../../functions/diff/diff.js';
 import { AModel } from '../model.abstract.js';
 import type { IImage } from './image.interface.js';
+/**
+ * Options passed to the Docker engine while building the image.
+ */
 export interface IImageDockerOptions {
+    /**
+     * Absolute path of the Dockerfile.
+     */
     dockerfilePath: string;
+    /**
+     * Build arguments, same as [--build-arg](https://docs.docker.com/build/guide/build-args/) option.
+     */
     buildArgs?: {
         [key: string]: string;
     };
+    /**
+     * To suppress Docker output, same as [--quiet](https://docs.docker.com/reference/cli/docker/container/run/) option.
+     */
     quiet?: boolean;
 }
+/**
+ * An Image model represents a Docker image, to either build, or run, your microservices.
+ *
+ * @example
+ * ```ts
+ * const image = new Image('nginx', '2.4', { dockerfilePath: './Dockerfile' });
+ *
+ * const image = new Image('docker/hello-world', '1.0', { dockerfilePath: './Dockerfile' });
+ * ```
+ * @group Models
+ * @see Definition of [Default Models](/docs/fundamentals/models#default-models).
+ */
 export declare class Image extends AModel<IImage, Image> {
-    readonly MODEL_NAME: string;
+    readonly NODE_NAME: string;
     readonly dockerOptions: IImageDockerOptions;
+    /**
+     * An imageId is the unique identifier for this image.
+     * - Format of imageId is `{imageName}:{imageTag}`
+     */
     readonly imageId: string;
+    /**
+     * The name of the image, same as [namespace in Docker](https://docs.docker.com/reference/cli/docker/image/tag/).
+     */
     readonly imageName: string;
+    /**
+     * The tag of the image, same as [tag in Docker](https://docs.docker.com/reference/cli/docker/image/tag/).
+     * - Unlike Docker, `imageTag` is mandatory in Octo.
+     */
     readonly imageTag: string;
     constructor(imageName: string, imageTag: string, options: IImageDockerOptions);
-    diffProperties(): Promise<Diff[]>;
     setContext(): string;
     synth(): IImage;
     static unSynth(image: IImage, deReferenceContext: (context: string) => Promise<UnknownModel>): Promise<Image>;

package/dist/models/image/image.model.js

@@ -8,30 +8,37 @@ var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
 var Image_1;
+import { strict as assert } from 'assert';
 import { resolve } from 'path';
 import { Model } from '../../decorators/model.decorator.js';
+import { Validate } from '../../decorators/validate.decorator.js';
 import { AModel } from '../model.abstract.js';
+/**
+ * An Image model represents a Docker image, to either build, or run, your microservices.
+ *
+ * @example
+ * ```ts
+ * const image = new Image('nginx', '2.4', { dockerfilePath: './Dockerfile' });
+ *
+ * const image = new Image('docker/hello-world', '1.0', { dockerfilePath: './Dockerfile' });
+ * ```
+ * @group Models
+ * @see Definition of [Default Models](/docs/fundamentals/models#default-models).
+ */
 let Image = Image_1 = class Image extends AModel {
-    MODEL_NAME = 'image';
-    dockerOptions;
-    imageId;
-    imageName;
-    imageTag;
     constructor(imageName, imageTag, options) {
         super();
+        this.NODE_NAME = 'image';
         this.imageId = `${imageName}:${imageTag}`;
         this.imageName = imageName;
         this.imageTag = imageTag;
         options.dockerfilePath = resolve(options.dockerfilePath);
         this.dockerOptions = options;
     }
-    async diffProperties() {
-        return [];
-    }
     setContext() {
         const parents = this.getParents();
         const app = parents['app'][0].to;
-        return [`${this.MODEL_NAME}=${this.imageId}`, app.getContext()].join(',');
+        return [`${this.NODE_NAME}=${this.imageId}`, app.getContext()].join(',');
     }
     synth() {
         return {
@@ -42,11 +49,20 @@ let Image = Image_1 = class Image extends AModel {
         };
     }
     static async unSynth(image, deReferenceContext) {
+        assert(!!deReferenceContext);
         return new Image_1(image.imageName, image.imageTag, {
             ...image.dockerOptions,
         });
     }
 };
+__decorate([
+    Validate({ options: { maxLength: 32, minLength: 2, regex: /^[a-zA-Z@][\w\-\/]*[a-zA-Z0-9]$/ } }),
+    __metadata("design:type", String)
+], Image.prototype, "imageName", void 0);
+__decorate([
+    Validate({ options: { maxLength: 32, minLength: 2, regex: /^[a-zA-Z0-9][\w.-]*[a-zA-Z0-9]$/ } }),
+    __metadata("design:type", String)
+], Image.prototype, "imageTag", void 0);
 Image = Image_1 = __decorate([
     Model(),
     __metadata("design:paramtypes", [String, String, Object])

package/dist/models/image/image.model.js.map

@@ -1 +1 @@
-{"version":3,"file":"image.model.js","sourceRoot":"","sources":["../../../src/models/image/image.model.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAE/B,OAAO,EAAE,KAAK,EAAE,MAAM,qCAAqC,CAAC;AAE5D,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAUvC,IAAM,KAAK,aAAX,MAAM,KAAM,SAAQ,MAAqB;IACrC,UAAU,GAAW,OAAO,CAAC;IAE7B,aAAa,CAAsB;IAEnC,OAAO,CAAS;IAEhB,SAAS,CAAS;IAElB,QAAQ,CAAS;IAE1B,YAAY,SAAiB,EAAE,QAAgB,EAAE,OAA4B;QAC3E,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,OAAO,GAAG,GAAG,SAAS,IAAI,QAAQ,EAAE,CAAC;QAC1C,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAEzB,OAAO,CAAC,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QACzD,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC;IAC/B,CAAC;IAEQ,KAAK,CAAC,cAAc;QAC3B,OAAO,EAAE,CAAC;IACZ,CAAC;IAEQ,UAAU;QACjB,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAClC,MAAM,GAAG,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACjC,OAAO,CAAC,GAAG,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC5E,CAAC;IAEQ,KAAK;QACZ,OAAO;YACL,aAAa,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YAC7D,OAAO,EAAE,IAAI,CAAC,QAAQ;YACtB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACxB,CAAC;IACJ,CAAC;IAED,MAAM,CAAU,KAAK,CAAC,OAAO,CAC3B,KAAa,EAEb,kBAA8D;QAE9D,OAAO,IAAI,OAAK,CAAC,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,QAAQ,EAAE;YAChD,GAAG,KAAK,CAAC,aAAa;SACvB,CAAC,CAAC;IACL,CAAC;CACF,CAAA;AAjDY,KAAK;IADjB,KAAK,EAAE;;GACK,KAAK,CAiDjB"}
+{"version":3,"file":"image.model.js","sourceRoot":"","sources":["../../../src/models/image/image.model.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,QAAQ,CAAC;AAC1C,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAE/B,OAAO,EAAE,KAAK,EAAE,MAAM,qCAAqC,CAAC;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,wCAAwC,CAAC;AAClE,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAuB9C;;;;;;;;;;;GAWG;AAEI,IAAM,KAAK,aAAX,MAAM,KAAM,SAAQ,MAAqB;IAwB9C,YAAY,SAAiB,EAAE,QAAgB,EAAE,OAA4B;QAC3E,KAAK,EAAE,CAAC;QAxBD,cAAS,GAAW,OAAO,CAAC;QAyBnC,IAAI,CAAC,OAAO,GAAG,GAAG,SAAS,IAAI,QAAQ,EAAE,CAAC;QAC1C,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAEzB,OAAO,CAAC,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QACzD,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC;IAC/B,CAAC;IAEQ,UAAU;QACjB,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAClC,MAAM,GAAG,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACjC,OAAO,CAAC,GAAG,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC3E,CAAC;IAEQ,KAAK;QACZ,OAAO;YACL,aAAa,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YAC7D,OAAO,EAAE,IAAI,CAAC,QAAQ;YACtB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACxB,CAAC;IACJ,CAAC;IAED,MAAM,CAAU,KAAK,CAAC,OAAO,CAC3B,KAAa,EACb,kBAA8D;QAE9D,MAAM,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC;QAE7B,OAAO,IAAI,OAAK,CAAC,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,QAAQ,EAAE;YAChD,GAAG,KAAK,CAAC,aAAa;SACvB,CAAC,CAAC;IACL,CAAC;CACF,CAAA;AA5CU;IADR,QAAQ,CAAC,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,iCAAiC,EAAE,EAAE,CAAC;;wCACtE;AAOlB;IADR,QAAQ,CAAC,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,iCAAiC,EAAE,EAAE,CAAC;;uCACvE;AAtBf,KAAK;IADjB,KAAK,EAAE;;GACK,KAAK,CA2DjB"}

package/dist/models/model-action.interface.d.ts

@@ -1,9 +1,26 @@
 import type { ActionInputs, ActionOutputs } from '../app.type.js';
 import type { Diff } from '../functions/diff/diff.js';
+/**
+ * Model Actions are translation functions between Diff and underlying resources.
+ * These actions can translate a specific type of Diff into individual resources.
+ */
 export interface IModelAction {
+    /**
+     * The name of the action.
+     * It can be used to easily identify an action and its purpose.
+     */
     readonly ACTION_NAME: string;
+    /**
+     * This function contains the list of inputs to ask before processing the diff.
+     * A missing input key will not be populated in the inputs provided to the action.
+     */
     collectInput(diff: Diff): Extract<keyof ActionInputs, string>[];
+    /**
+     * This function determines if the handle is applicable to the diff.
+     */
     filter(diff: Diff): boolean;
+    /**
+     * This function contains the logic to apply the diff(s) to the underlying infrastructure.
+     */
     handle(diff: Diff, actionInputs: ActionInputs, actionOutputs: ActionOutputs): Promise<ActionOutputs>;
-    revert(diff: Diff, actionInputs: ActionInputs, actionOutputs: ActionOutputs): Promise<ActionOutputs>;
 }

package/dist/models/model.abstract.d.ts

@@ -1,59 +1,24 @@
-import { ModelType, type UnknownModel } from '../app.type.js';
-import { Dependency, type DependencyRelationship } from '../functions/dependency/dependency.js';
+import { NodeType, type UnknownModel } from '../app.type.js';
 import { Diff } from '../functions/diff/diff.js';
+import { ANode } from '../functions/node/node.abstract.js';
 import type { AAnchor } from '../overlays/anchor.abstract.js';
 import type { IModel } from './model.interface.js';
-export declare abstract class AModel<I, T> implements IModel<I, T> {
-    abstract readonly MODEL_NAME: string;
-    readonly MODEL_TYPE: ModelType;
-    private _deleteMarker;
+export declare abstract class AModel<I, T> extends ANode<I, T> implements IModel<I, T> {
+    abstract readonly NODE_NAME: string;
+    readonly NODE_TYPE: NodeType;
     private readonly anchors;
-    private context;
-    private readonly dependencies;
     addAnchor(anchor: AAnchor): void;
-    addChild(onField: keyof T | string, child: UnknownModel, toField: string): {
-        childToParentDependency: Dependency;
-        parentToChildDependency: Dependency;
-    };
-    addRelationship(to: UnknownModel): {
-        thatToThisDependency: Dependency;
-        thisToThatDependency: Dependency;
-    };
     deriveDependencyField(): string | undefined;
-    diff(previous?: T): Promise<Diff[]>;
-    abstract diffProperties(previous: T): Promise<Diff[]>;
-    getAncestors(): UnknownModel[];
+    diff(): Promise<Diff[]>;
+    diffProperties(): Promise<Diff[]>;
     getAnchor(anchorId: string, parent?: UnknownModel): AAnchor | undefined;
     getAnchorIndex(anchorId: string, parent?: UnknownModel): number;
     getAnchors(filters?: {
         key: string;
         value: any;
     }[]): AAnchor[];
-    getBoundaryMembers(): UnknownModel[];
-    getChild(modelName: string, filters?: {
-        key: string;
-        value: any;
-    }[]): UnknownModel | undefined;
-    getChildren(modelName?: string): {
-        [key: string]: Dependency[];
-    };
-    getContext(): string;
-    getDependencies(to?: UnknownModel): Dependency[];
-    getDependency(to: UnknownModel, relationship: DependencyRelationship): Dependency | undefined;
-    getDependencyIndex(to: UnknownModel, relationship: DependencyRelationship): number;
-    getParents(modelName?: string): {
-        [key: string]: Dependency[];
-    };
-    getSiblings(modelName?: string): {
-        [key: string]: Dependency[];
-    };
-    hasAncestor(model: UnknownModel): boolean;
-    isMarkedDeleted(): boolean;
-    remove(ignoreDirectRelationships?: boolean): void;
     removeAllAnchors(): void;
     removeAnchor(anchor: AAnchor): void;
-    removeDependency(dependencyIndex: number): void;
-    removeRelationship(model: UnknownModel): void;
     abstract setContext(): string;
     abstract synth(): I;
     static unSynth(...args: unknown[]): Promise<UnknownModel>;