@quadnix/octo 0.0.20 → 0.0.21

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

@@ -5,10 +5,33 @@ 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;
+    /**
+     * 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;

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

@@ -9,17 +9,38 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 };
 var Execution_1;
 import { Model } from '../../decorators/model.decorator.js';
+import { Validate } from '../../decorators/validate.decorator.js';
 import { DiffUtility } from '../../functions/diff/diff.utility.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.MODEL_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 +48,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 +57,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;
@@ -94,6 +122,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,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;AAGnD;;;;;;;;;;;;;GAaG;AAEI,IAAM,SAAS,iBAAf,MAAM,SAAU,SAAQ,MAA6B;IAgB1D,YAAY,UAAsB,EAAE,WAAwB,EAAE,MAAc;QAC1E,KAAK,EAAE,CAAC;QAhBD,eAAU,GAAW,WAAW,CAAC;QAE1C;;;;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,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;AAnHU;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,CAiIrB"}

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

@@ -2,18 +2,53 @@ 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 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[]>;

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

@@ -10,15 +10,24 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 var Image_1;
 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.MODEL_NAME = 'image';
         this.imageId = `${imageName}:${imageTag}`;
         this.imageName = imageName;
         this.imageTag = imageTag;
@@ -41,12 +50,22 @@ let Image = Image_1 = class Image extends AModel {
             imageTag: this.imageTag,
         };
     }
-    static async unSynth(image, deReferenceContext) {
+    static async unSynth(image, 
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    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,OAAO,EAAE,MAAM,MAAM,CAAC;AAE/B,OAAO,EAAE,KAAK,EAAE,MAAM,qCAAqC,CAAC;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,wCAAwC,CAAC;AAElE,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,eAAU,GAAW,OAAO,CAAC;QAyBpC,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;IACb,6DAA6D;IAC7D,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;AA/CU;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,CA8DjB"}

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

@@ -1,9 +1,30 @@
 import type { ActionInputs, ActionOutputs } from '../app.type.js';
 import type { Diff } from '../functions/diff/diff.js';
+/**
+ * Actions are translation functions between Diff and underlying infrastructure.
+ * An action can translate a specific type of Diff into underlying infrastructure, and can revert it back.
+ */
 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>;
+    /**
+     * This function contains the logic to revert the diff(s) from the underlying infrastructure.
+     */
     revert(diff: Diff, actionInputs: ActionInputs, actionOutputs: ActionOutputs): Promise<ActionOutputs>;
 }

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

@@ -3,6 +3,21 @@ import { Dependency, type DependencyRelationship } from '../functions/dependency
 import { Diff } from '../functions/diff/diff.js';
 import type { AAnchor } from '../overlays/anchor.abstract.js';
 import type { IModel } from './model.interface.js';
+/**
+ * This is Octo's base class, and all other classes extend from it.
+ * It helps provide a common set of methods and properties that is core to Octo.
+ *
+ * Octo is built as a graph, and this base class can be considered as a generic node.
+ * Nodes can have children, and siblings, but only if connected via an edge, called {@link Dependency} here.
+ *
+ * From this base class, three more base classes are derived,
+ * - [Models](/docs/fundamentals/models)
+ * - [Resources](/docs/fundamentals/resources)
+ * - [Overlays](/docs/fundamentals/overlay-and-anchor)
+ *
+ * Each of these derived base classes, using the base methods of this class,
+ * define their own specific rules on how their graphs should be constructed.
+ */
 export declare abstract class AModel<I, T> implements IModel<I, T> {
     abstract readonly MODEL_NAME: string;
     readonly MODEL_TYPE: ModelType;
@@ -10,51 +25,301 @@ export declare abstract class AModel<I, T> implements IModel<I, T> {
     private readonly anchors;
     private context;
     private readonly dependencies;
+    /**
+     * To add an {@link Anchor}.
+     *
+     * Each node can store multiple anchors for reference.
+     * These anchors don't necessarily need to be parented by self, but must be unique,
+     * i.e. an anchor, identified by it's parent, cannot be added twice to self's list of anchors.
+     */
     addAnchor(anchor: AAnchor): void;
+    /**
+     * To add another node as a child of self.
+     *
+     * Every node must have a unique ID against other nodes of the same {@link MODEL_NAME}.
+     * This ID is how Octo differentiates similar nodes, and keeps track of them.
+     * But because each node is free to define their own fields,
+     * the fields containing the ID are a necessary input to this method.
+     *
+     * @example
+     * ```ts
+     * const region = new Region('region');
+     * const environment = new Environment('qa');
+     * region.addChild('regionId', environment, 'environmentName');
+     * ```
+     * @param onField The field in self which contains the unique ID.
+     * @param child The child node.
+     * @param toField The field in child which contains the unique ID.
+     * @returns
+     * - childToParentDependency: The dependency edge from child to self.
+     * - parentToChildDependency: The dependency edge from self to child.
+     */
     addChild(onField: keyof T | string, child: UnknownModel, toField: string): {
         childToParentDependency: Dependency;
         parentToChildDependency: Dependency;
     };
+    /**
+     * To add another node as a sibling of self.
+     *
+     * @example
+     * ```ts
+     * const region1 = new Region('region-1');
+     * const region2 = new Region('region-2');
+     * region1.addSibling(region2);
+     * ```
+     * @param to The sibling node.
+     * @returns
+     * - thatToThisDependency: The dependency edge from sibling to self.
+     * - thisToThatDependency: The dependency edge from self to sibling.
+     */
     addRelationship(to: UnknownModel): {
         thatToThisDependency: Dependency;
         thisToThatDependency: Dependency;
     };
+    /**
+     * To derive the name of the field in self which contains the ID.
+     *
+     * @remarks This method does a best attempt search of the field name by traversing all dependencies of self.
+     * But if the dependencies lack, or have not been added yet, this method might return `undefined`.
+     * That does not mean that such a field does not exist,
+     * but rather that it wasn't possible to derive the name at that point.
+     * @returns The name of the field in self which contains the ID, or `undefined` if not found.
+     */
     deriveDependencyField(): string | undefined;
+    /**
+     * Compares and calculates the difference between the current version of self node, and the previous version.
+     * - Recursively compares self children too.
+     *
+     * @param previous The previous version of self.
+     */
     diff(previous?: T): Promise<Diff[]>;
+    /**
+     * To compare properties of the current version of self node, vs. the previous version.
+     * It is a helper method to the `diff()` method.
+     * - This method is called by the {@link diff()} method.
+     *
+     * @param previous The previous version of self.
+     */
     abstract diffProperties(previous: T): Promise<Diff[]>;
+    /**
+     * To get all ancestors of self.
+     * - Includes parent nodes.
+     * - Might include sibling nodes, if they are necessary for self node to exist.
+     */
     getAncestors(): UnknownModel[];
+    /**
+     * To get an anchor with a given ID and parent.
+     *
+     * @param anchorId The ID of the anchor.
+     * @param parent The parent of the anchor.
+     * - If parent is not given, then self is considered the parent of this anchor.
+     */
     getAnchor(anchorId: string, parent?: UnknownModel): AAnchor | undefined;
+    /**
+     * To get the index of an anchor with a given ID and parent.
+     *
+     * @param anchorId The ID of the anchor.
+     * @param parent The parent of the anchor.
+     * - If parent is not given, then self is considered the parent of this anchor.
+     */
     getAnchorIndex(anchorId: string, parent?: UnknownModel): number;
+    /**
+     * To get all anchors, filtered by anchor properties.
+     *
+     * @param filters A set of filters, where `key` is the property name and `value` is the value to filter by.
+     */
     getAnchors(filters?: {
         key: string;
         value: any;
     }[]): AAnchor[];
+    /**
+     * To get a boundary (sub graph) of self.
+     * A boundary is a group of nodes that must belong together.
+     * The boundary consists of all nodes associated with self,
+     * which includes parents, grand parents, children, grand children, and siblings.
+     */
     getBoundaryMembers(): UnknownModel[];
+    /**
+     * To get a child of self that matches the given filters.
+     *
+     * @param modelName The {@link MODEL_NAME} of the child.
+     * @param filters A set of filters, to be applied on children,
+     * where `key` is the property name and `value` is the value to filter by.
+     * @throws {@link Error} If more than one child is found.
+     */
     getChild(modelName: string, filters?: {
         key: string;
         value: any;
     }[]): UnknownModel | undefined;
+    /**
+     * To get all children of self.
+     *
+     * @example
+     * ```ts
+     * const children = region.getChildren('environment');
+     * const environments = children['environment'].map((d) => d.to);
+     * ```
+     * @param modelName The {@link MODEL_NAME} of the children.
+     * @returns All children as an object with the {@link MODEL_NAME} as the key,
+     * and self's dependency to the child as the value.
+     */
     getChildren(modelName?: string): {
         [key: string]: Dependency[];
     };
+    /**
+     * To get the context of self.
+     * A context is a string representation of self that uniquely identifies self in the graph.
+     *
+     * @example
+     * ```ts
+     * const app = new App('my-app');
+     * const region = new Region('my-region');
+     * app.addRegion(region);
+     * const context = region.getContext(); // "region=my-region,app=my-app"
+     * ```
+     */
     getContext(): string;
+    /**
+     * To get all dependencies of self.
+     * - Can be filtered to just dependencies with a single node.
+     *
+     * @param to The other node. If present, will only return dependencies of self with this node.
+     */
     getDependencies(to?: UnknownModel): Dependency[];
+    /**
+     * To get a dependency of self with another node.
+     *
+     * @param to The other node.
+     * @param relationship The relationship between self and the other node.
+     * @returns The dependency with the other node having the given relationship, or `undefined` if not found.
+     */
     getDependency(to: UnknownModel, relationship: DependencyRelationship): Dependency | undefined;
+    /**
+     * To get the index of a dependency of self with another node.
+     *
+     * @param to The other node.
+     * @param relationship The relationship between self and the other node.
+     * @returns The index of the dependency with the other node having the given relationship, or `-1` if not found.
+     */
     getDependencyIndex(to: UnknownModel, relationship: DependencyRelationship): number;
+    /**
+     * To get all parent of self.
+     *
+     * @example
+     * ```ts
+     * const parents = environment.getParents('region');
+     * const regions = parents['region'].map((d) => d.to);
+     * ```
+     * @param modelName The {@link MODEL_NAME} of the parent.
+     * @returns All parents as an object with the {@link MODEL_NAME} as the key,
+     * and self's dependency to the parent as the value.
+     */
     getParents(modelName?: string): {
         [key: string]: Dependency[];
     };
+    /**
+     * To get all siblings of self.
+     *
+     * :::note Note
+     * Two environments, or two regions, etc. are not automatically considered siblings,
+     * unless they have a dependency between them.
+     *
+     * ```ts
+     * const environment1 = new Environment('qa');
+     * const environment2 = new Environment('prod');
+     * const region = new Region('region');
+     * region.addEnvironment(environment1);
+     * region.addEnvironment(environment2);
+     * environment1.getSiblings('environment'); // This won't return a dependency to environment2.
+     * ```
+     * :::
+     *
+     * @example
+     * ```ts
+     * const siblings = environment.getSiblings('image');
+     * const images = siblings['image'].map((d) => d.to);
+     * ```
+     * @param modelName The {@link MODEL_NAME} of the sibling.
+     * @returns All siblings as an object with the {@link MODEL_NAME} as the key,
+     * and self's dependency to the sibling as the value.
+     */
     getSiblings(modelName?: string): {
         [key: string]: Dependency[];
     };
+    /**
+     * To check if given node is an ancestor of self.
+     *
+     * @param model The other node.
+     */
     hasAncestor(model: UnknownModel): boolean;
+    /**
+     * To check if self is marked as deleted.
+     * A deleted node will be removed from the graph after the transaction.
+     */
     isMarkedDeleted(): boolean;
+    /**
+     * To mark self as deleted.
+     * A deleted node will be removed from the graph after the transaction.
+     * - A node cannot be deleted if it has dependencies.
+     * - Unless the dependency is a sibling dependency and `ignoreDirectRelationships` is `true`.
+     *
+     * @example
+     * ```ts
+     * const region1 = new Region('region-1');
+     * const environment = new Environment('environment');
+     * region1.addEnvironment(environment);
+     * const region2 = new Region('region-2');
+     * region1.addSibling(region2);
+     *
+     * // Cannot remove region1 because it has dependencies.
+     * region1.remove(); // throws.
+     *
+     * // Still can't remove region1 because it has a sibling dependency.
+     * environment.remove(); // ok.
+     * region1.remove(); // throws.
+     *
+     * // But can remove region1 when sibling relationships are ignored.
+     * region1.remove(true); // ok.
+     * ```
+     * @param ignoreDirectRelationships Whether to ignore sibling relationships.
+     * @throws {@link Error} If node contains dependencies to other nodes.
+     */
     remove(ignoreDirectRelationships?: boolean): void;
+    /**
+     * To remove all anchors from self.
+     */
     removeAllAnchors(): void;
+    /**
+     * To remove an anchor from self.
+     *
+     * @param anchor The anchor to remove.
+     */
     removeAnchor(anchor: AAnchor): void;
+    /**
+     * To remove a dependency from self.
+     *
+     * @param dependencyIndex The index of the dependency to remove.
+     */
     removeDependency(dependencyIndex: number): void;
+    /**
+     * To remove ALL dependencies from self for the given node.
+     *
+     * @param model The other node.
+     */
     removeRelationship(model: UnknownModel): void;
+    /**
+     * To set the context of self.
+     * A context is a string representation of self that uniquely identifies self in the graph.
+     */
     abstract setContext(): string;
+    /**
+     * Generates a serializable representation of self.
+     */
     abstract synth(): I;
+    /**
+     * To create self given its serialized representation.
+     * - First argument is the serialized representation.
+     * - Second argument is the `deReferenceContext()` function to resolve other nodes self depends on.
+     */
     static unSynth(...args: unknown[]): Promise<UnknownModel>;
 }