@quadnix/octo 0.0.20 → 0.0.22

package/dist/models/region/region.model.js

@@ -8,42 +8,60 @@ var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
 var Region_1;
+import { strict as assert } from 'assert';
 import { Model } from '../../decorators/model.decorator.js';
+import { Validate } from '../../decorators/validate.decorator.js';
 import { AModel } from '../model.abstract.js';
+/**
+ * A Region model is a physical geographical area where the app can be deployed.
+ * Typically, for redundancy and low latency, an app is deployed in multiple regions.
+ * Therefore, it's common to have multiple region nodes under the app.
+ *
+ * @example
+ * ```ts
+ * const region = new Region('us-east-1');
+ * ```
+ * @group Models
+ * @see Definition of [Default Models](/docs/fundamentals/models#default-models).
+ */
 let Region = Region_1 = class Region extends AModel {
-    MODEL_NAME = 'region';
-    regionId;
     constructor(regionId) {
         super();
+        this.NODE_NAME = 'region';
         this.regionId = regionId;
     }
+    /**
+     * To add an {@link Environment}.
+     */
     addEnvironment(environment) {
         const childrenDependencies = this.getChildren('environment');
         if (!childrenDependencies['environment'])
             childrenDependencies['environment'] = [];
+        // Check for duplicates.
         const environments = childrenDependencies['environment'].map((d) => d.to);
         if (environments.find((e) => e.environmentName === environment.environmentName)) {
             throw new Error('Environment already exists!');
         }
         this.addChild('regionId', environment, 'environmentName');
     }
+    /**
+     * To add a {@link Subnet}.
+     */
     addSubnet(subnet) {
         const childrenDependencies = this.getChildren('subnet');
         if (!childrenDependencies['subnet'])
             childrenDependencies['subnet'] = [];
+        // Check for duplicates.
         const subnets = childrenDependencies['subnet'].map((d) => d.to);
         if (subnets.find((z) => z.subnetId === subnet.subnetId)) {
             throw new Error('Subnet already exists!');
         }
         this.addChild('regionId', subnet, 'subnetId');
     }
-    async diffProperties() {
-        return [];
-    }
     setContext() {
         const parents = this.getParents();
         const app = parents['app'][0].to;
-        return [`${this.MODEL_NAME}=${this.regionId}`, app.getContext()].join(',');
+        return [`${this.NODE_NAME}=${this.regionId}`, app.getContext()].join(',');
     }
     synth() {
         return {
@@ -51,9 +69,14 @@ let Region = Region_1 = class Region extends AModel {
         };
     }
     static async unSynth(region, deReferenceContext) {
+        assert(!!deReferenceContext);
         return new Region_1(region.regionId);
     }
 };
+__decorate([
+    Validate({ options: { maxLength: 32, minLength: 2, regex: /^[a-zA-Z][\w-]*[a-zA-Z0-9]$/ } }),
+    __metadata("design:type", String)
+], Region.prototype, "regionId", void 0);
 Region = Region_1 = __decorate([
     Model(),
     __metadata("design:paramtypes", [String])

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

@@ -1 +1 @@
-{"version":3,"file":"region.model.js","sourceRoot":"","sources":["../../../src/models/region/region.model.ts"],"names":[],"mappings":";;;;;;;;;;AACA,OAAO,EAAE,KAAK,EAAE,MAAM,qCAAqC,CAAC;AAG5D,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAKvC,IAAM,MAAM,cAAZ,MAAM,MAAO,SAAQ,MAAuB;IACxC,UAAU,GAAW,QAAQ,CAAC;IAE9B,QAAQ,CAAS;IAE1B,YAAY,QAAgB;QAC1B,KAAK,EAAE,CAAC;QAER,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED,cAAc,CAAC,WAAwB;QACrC,MAAM,oBAAoB,GAAG,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;QAC7D,IAAI,CAAC,oBAAoB,CAAC,aAAa,CAAC;YAAE,oBAAoB,CAAC,aAAa,CAAC,GAAG,EAAE,CAAC;QAGnF,MAAM,YAAY,GAAG,oBAAoB,CAAC,aAAa,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC1E,IAAI,YAAY,CAAC,IAAI,CAAC,CAAC,CAAc,EAAE,EAAE,CAAC,CAAC,CAAC,eAAe,KAAK,WAAW,CAAC,eAAe,CAAC,EAAE,CAAC;YAC7F,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACjD,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,WAAW,EAAE,iBAAiB,CAAC,CAAC;IAC5D,CAAC;IAED,SAAS,CAAC,MAAc;QACtB,MAAM,oBAAoB,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QACxD,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC;YAAE,oBAAoB,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;QAGzE,MAAM,OAAO,GAAG,oBAAoB,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAChE,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;YAChE,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC5C,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;IAChD,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,QAAQ,EAAE,EAAE,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC7E,CAAC;IAEQ,KAAK;QACZ,OAAO;YACL,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACxB,CAAC;IACJ,CAAC;IAED,MAAM,CAAU,KAAK,CAAC,OAAO,CAC3B,MAAe,EAEf,kBAA8D;QAE9D,OAAO,IAAI,QAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC;CACF,CAAA;AA1DY,MAAM;IADlB,KAAK,EAAE;;GACK,MAAM,CA0DlB"}
+{"version":3,"file":"region.model.js","sourceRoot":"","sources":["../../../src/models/region/region.model.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,QAAQ,CAAC;AAE1C,OAAO,EAAE,KAAK,EAAE,MAAM,qCAAqC,CAAC;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,wCAAwC,CAAC;AAElE,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAI9C;;;;;;;;;;;GAWG;AAEI,IAAM,MAAM,cAAZ,MAAM,MAAO,SAAQ,MAAuB;IAMjD,YAAY,QAAgB;QAC1B,KAAK,EAAE,CAAC;QAND,cAAS,GAAW,QAAQ,CAAC;QAQpC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,cAAc,CAAC,WAAwB;QACrC,MAAM,oBAAoB,GAAG,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;QAC7D,IAAI,CAAC,oBAAoB,CAAC,aAAa,CAAC;YAAE,oBAAoB,CAAC,aAAa,CAAC,GAAG,EAAE,CAAC;QAEnF,wBAAwB;QACxB,MAAM,YAAY,GAAG,oBAAoB,CAAC,aAAa,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC1E,IAAI,YAAY,CAAC,IAAI,CAAC,CAAC,CAAc,EAAE,EAAE,CAAC,CAAC,CAAC,eAAe,KAAK,WAAW,CAAC,eAAe,CAAC,EAAE,CAAC;YAC7F,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACjD,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,WAAW,EAAE,iBAAiB,CAAC,CAAC;IAC5D,CAAC;IAED;;OAEG;IACH,SAAS,CAAC,MAAc;QACtB,MAAM,oBAAoB,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QACxD,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC;YAAE,oBAAoB,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;QAEzE,wBAAwB;QACxB,MAAM,OAAO,GAAG,oBAAoB,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAChE,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;YAChE,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC5C,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;IAChD,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,QAAQ,EAAE,EAAE,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC5E,CAAC;IAEQ,KAAK;QACZ,OAAO;YACL,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACxB,CAAC;IACJ,CAAC;IAED,MAAM,CAAU,KAAK,CAAC,OAAO,CAC3B,MAAe,EACf,kBAA8D;QAE9D,MAAM,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC;QAE7B,OAAO,IAAI,QAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC;CACF,CAAA;AA1DU;IADR,QAAQ,CAAC,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,6BAA6B,EAAE,EAAE,CAAC;;wCACnE;AAJf,MAAM;IADlB,KAAK,EAAE;;GACK,MAAM,CA8DlB"}

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

@@ -1,4 +1,9 @@
 import type { Server } from './server.model.js';
+/**
+ * {@link Server} model interface.
+ *
+ * @group Model Interfaces
+ */
 export interface IServer {
     serverKey: Server['serverKey'];
 }

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

@@ -1,14 +1,29 @@
 import type { UnknownModel } from '../../app.type.js';
-import type { Diff } from '../../functions/diff/diff.js';
 import { Deployment } from '../deployment/deployment.model.js';
 import { AModel } from '../model.abstract.js';
 import type { IServer } from './server.interface.js';
+/**
+ * A Server model is a representation of the logical microservice.
+ * E.g. frontend, backend, database, payment-service, etc.
+ *
+ * @example
+ * ```ts
+ * const server = new Server('backend');
+ * ```
+ * @group Models
+ * @see Definition of [Default Models](/docs/fundamentals/models#default-models).
+ */
 export declare class Server extends AModel<IServer, Server> {
-    readonly MODEL_NAME: string;
+    readonly NODE_NAME: string;
+    /**
+     * The name of the server.
+     */
     readonly serverKey: string;
     constructor(serverKey: string);
+    /**
+     * To add a {@link Deployment}.
+     */
     addDeployment(deployment: Deployment): void;
-    diffProperties(): Promise<Diff[]>;
     setContext(): string;
     synth(): IServer;
     static unSynth(server: IServer, deReferenceContext: (context: string) => Promise<UnknownModel>): Promise<Server>;

package/dist/models/server/server.model.js

@@ -8,32 +8,45 @@ var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
 var Server_1;
+import { strict as assert } from 'assert';
 import { Model } from '../../decorators/model.decorator.js';
+import { Validate } from '../../decorators/validate.decorator.js';
 import { AModel } from '../model.abstract.js';
+/**
+ * A Server model is a representation of the logical microservice.
+ * E.g. frontend, backend, database, payment-service, etc.
+ *
+ * @example
+ * ```ts
+ * const server = new Server('backend');
+ * ```
+ * @group Models
+ * @see Definition of [Default Models](/docs/fundamentals/models#default-models).
+ */
 let Server = Server_1 = class Server extends AModel {
-    MODEL_NAME = 'server';
-    serverKey;
     constructor(serverKey) {
         super();
+        this.NODE_NAME = 'server';
         this.serverKey = serverKey;
     }
+    /**
+     * To add a {@link Deployment}.
+     */
     addDeployment(deployment) {
         const childrenDependencies = this.getChildren('deployment');
         if (!childrenDependencies['deployment'])
             childrenDependencies['deployment'] = [];
+        // Check for duplicates.
         const deployments = childrenDependencies['deployment'].map((d) => d.to);
         if (deployments.find((d) => d.deploymentTag === deployment.deploymentTag)) {
             throw new Error('Deployment already exists!');
         }
         this.addChild('serverKey', deployment, 'deploymentTag');
     }
-    async diffProperties() {
-        return [];
-    }
     setContext() {
         const parents = this.getParents();
         const app = parents['app'][0].to;
-        return [`${this.MODEL_NAME}=${this.serverKey}`, app.getContext()].join(',');
+        return [`${this.NODE_NAME}=${this.serverKey}`, app.getContext()].join(',');
     }
     synth() {
         return {
@@ -41,9 +54,14 @@ let Server = Server_1 = class Server extends AModel {
         };
     }
     static async unSynth(server, deReferenceContext) {
+        assert(!!deReferenceContext);
         return new Server_1(server.serverKey);
     }
 };
+__decorate([
+    Validate({ options: { maxLength: 64, minLength: 2, regex: /^[a-zA-Z][\w-]*[a-zA-Z0-9]$/ } }),
+    __metadata("design:type", String)
+], Server.prototype, "serverKey", void 0);
 Server = Server_1 = __decorate([
     Model(),
     __metadata("design:paramtypes", [String])

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

@@ -1 +1 @@
-{"version":3,"file":"server.model.js","sourceRoot":"","sources":["../../../src/models/server/server.model.ts"],"names":[],"mappings":";;;;;;;;;;AACA,OAAO,EAAE,KAAK,EAAE,MAAM,qCAAqC,CAAC;AAG5D,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAIvC,IAAM,MAAM,cAAZ,MAAM,MAAO,SAAQ,MAAuB;IACxC,UAAU,GAAW,QAAQ,CAAC;IAE9B,SAAS,CAAS;IAE3B,YAAY,SAAiB;QAC3B,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAED,aAAa,CAAC,UAAsB;QAClC,MAAM,oBAAoB,GAAG,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QAC5D,IAAI,CAAC,oBAAoB,CAAC,YAAY,CAAC;YAAE,oBAAoB,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC;QAGjF,MAAM,WAAW,GAAG,oBAAoB,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QACxE,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC,CAAa,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,KAAK,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC;YACtF,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAChD,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,UAAU,EAAE,eAAe,CAAC,CAAC;IAC1D,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,SAAS,EAAE,EAAE,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC9E,CAAC;IAEQ,KAAK;QACZ,OAAO;YACL,SAAS,EAAE,IAAI,CAAC,SAAS;SAC1B,CAAC;IACJ,CAAC;IAED,MAAM,CAAU,KAAK,CAAC,OAAO,CAC3B,MAAe,EAEf,kBAA8D;QAE9D,OAAO,IAAI,QAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACtC,CAAC;CACF,CAAA;AA7CY,MAAM;IADlB,KAAK,EAAE;;GACK,MAAM,CA6ClB"}
+{"version":3,"file":"server.model.js","sourceRoot":"","sources":["../../../src/models/server/server.model.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,QAAQ,CAAC;AAE1C,OAAO,EAAE,KAAK,EAAE,MAAM,qCAAqC,CAAC;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,wCAAwC,CAAC;AAElE,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAG9C;;;;;;;;;;GAUG;AAEI,IAAM,MAAM,cAAZ,MAAM,MAAO,SAAQ,MAAuB;IASjD,YAAY,SAAiB;QAC3B,KAAK,EAAE,CAAC;QATD,cAAS,GAAW,QAAQ,CAAC;QAUpC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAED;;OAEG;IACH,aAAa,CAAC,UAAsB;QAClC,MAAM,oBAAoB,GAAG,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QAC5D,IAAI,CAAC,oBAAoB,CAAC,YAAY,CAAC;YAAE,oBAAoB,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC;QAEjF,wBAAwB;QACxB,MAAM,WAAW,GAAG,oBAAoB,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QACxE,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC,CAAa,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,KAAK,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC;YACtF,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAChD,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,UAAU,EAAE,eAAe,CAAC,CAAC;IAC1D,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,SAAS,EAAE,EAAE,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC7E,CAAC;IAEQ,KAAK;QACZ,OAAO;YACL,SAAS,EAAE,IAAI,CAAC,SAAS;SAC1B,CAAC;IACJ,CAAC;IAED,MAAM,CAAU,KAAK,CAAC,OAAO,CAC3B,MAAe,EACf,kBAA8D;QAE9D,MAAM,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC;QAE7B,OAAO,IAAI,QAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACtC,CAAC;CACF,CAAA;AA1CU;IADR,QAAQ,CAAC,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,6BAA6B,EAAE,EAAE,CAAC;;yCAClE;AAPhB,MAAM;IADlB,KAAK,EAAE;;GACK,MAAM,CAiDlB"}

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

@@ -1,4 +1,9 @@
 import type { Service } from './service.model.js';
+/**
+ * {@link Service} model interface.
+ *
+ * @group Model Interfaces
+ */
 export interface IService {
     serviceId: Service['serviceId'];
 }

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

@@ -1,11 +1,24 @@
-import type { Diff } from '../../functions/diff/diff.js';
 import { AModel } from '../model.abstract.js';
 import type { IService } from './service.interface.js';
+/**
+ * A Service model can be any third-party service that your application relies on.
+ * What separates them from Server is that Services are hosted and managed outside of your infrastructure.
+ * An external Redis server on the cloud, or a managed Kafka queue from AWS, are a few examples.
+ *
+ * @example
+ * ```ts
+ * const service = new Service('MyService');
+ * ```
+ * @group Models
+ * @see Definition of [Default Models](/docs/fundamentals/models#default-models).
+ */
 export declare class Service extends AModel<IService, Service> {
-    readonly MODEL_NAME: string;
+    readonly NODE_NAME: string;
+    /**
+     * The ID of the service.
+     */
     readonly serviceId: string;
     constructor(serviceId: string);
-    diffProperties(previous: Service): Promise<Diff[]>;
     setContext(): string;
     synth(): IService;
 }

package/dist/models/service/service.model.js

@@ -8,26 +8,39 @@ var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
 import { Model } from '../../decorators/model.decorator.js';
+import { Validate } from '../../decorators/validate.decorator.js';
 import { AModel } from '../model.abstract.js';
+/**
+ * A Service model can be any third-party service that your application relies on.
+ * What separates them from Server is that Services are hosted and managed outside of your infrastructure.
+ * An external Redis server on the cloud, or a managed Kafka queue from AWS, are a few examples.
+ *
+ * @example
+ * ```ts
+ * const service = new Service('MyService');
+ * ```
+ * @group Models
+ * @see Definition of [Default Models](/docs/fundamentals/models#default-models).
+ */
 let Service = class Service extends AModel {
-    MODEL_NAME = 'service';
-    serviceId;
     constructor(serviceId) {
         super();
+        this.NODE_NAME = 'service';
         this.serviceId = serviceId;
     }
-    async diffProperties(previous) {
-        return [];
-    }
     setContext() {
         const parents = this.getParents();
         const app = parents['app'][0].to;
-        return [`${this.MODEL_NAME}=${this.serviceId}`, app.getContext()].join(',');
+        return [`${this.NODE_NAME}=${this.serviceId}`, app.getContext()].join(',');
     }
     synth() {
         throw new Error('Method not implemented! Use subclass');
     }
 };
+__decorate([
+    Validate({ options: { maxLength: 128, minLength: 2, regex: /^[a-zA-Z0-9][\w.-]*[a-zA-Z0-9]$/ } }),
+    __metadata("design:type", String)
+], Service.prototype, "serviceId", void 0);
 Service = __decorate([
     Model(),
     __metadata("design:paramtypes", [String])

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

@@ -1 +1 @@
-{"version":3,"file":"service.model.js","sourceRoot":"","sources":["../../../src/models/service/service.model.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,qCAAqC,CAAC;AAE5D,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAIvC,IAAM,OAAO,GAAb,MAAM,OAAQ,SAAQ,MAAyB;IAC3C,UAAU,GAAW,SAAS,CAAC;IAE/B,SAAS,CAAS;IAE3B,YAAY,SAAiB;QAC3B,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAGQ,KAAK,CAAC,cAAc,CAAC,QAAiB;QAC7C,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,SAAS,EAAE,EAAE,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC9E,CAAC;IAEQ,KAAK;QACZ,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;IAC1D,CAAC;CACF,CAAA;AAxBY,OAAO;IADnB,KAAK,EAAE;;GACK,OAAO,CAwBnB"}
+{"version":3,"file":"service.model.js","sourceRoot":"","sources":["../../../src/models/service/service.model.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,qCAAqC,CAAC;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,wCAAwC,CAAC;AAClE,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAG9C;;;;;;;;;;;GAWG;AAEI,IAAM,OAAO,GAAb,MAAM,OAAQ,SAAQ,MAAyB;IASpD,YAAY,SAAiB;QAC3B,KAAK,EAAE,CAAC;QATD,cAAS,GAAW,SAAS,CAAC;QAUrC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,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,SAAS,EAAE,EAAE,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC7E,CAAC;IAEQ,KAAK;QACZ,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;IAC1D,CAAC;CACF,CAAA;AAhBU;IADR,QAAQ,CAAC,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,iCAAiC,EAAE,EAAE,CAAC;;0CACvE;AAPhB,OAAO;IADnB,KAAK,EAAE;;GACK,OAAO,CAuBnB"}

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

@@ -1,5 +1,10 @@
 import type { IModelReference } from '../model.interface.js';
 import type { Subnet } from './subnet.model.js';
+/**
+ * {@link Subnet} model interface.
+ *
+ * @group Model Interfaces
+ */
 export interface ISubnet {
     options: Subnet['options'];
     region: IModelReference;

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

@@ -1,25 +1,72 @@
 import type { UnknownModel } from '../../app.type.js';
-import { Diff } from '../../functions/diff/diff.js';
 import { AModel } from '../model.abstract.js';
 import { Region } from '../region/region.model.js';
 import type { ISubnet } from './subnet.interface.js';
+/**
+ * The type of subnet.
+ */
 export declare enum SubnetType {
+    /**
+     * A public subnet is open to the internet,
+     * i.e. an {@link Execution} within this subnet can be accessed from the internet.
+     * Other than access from the internet, any other access needs to be explicitly allowed.
+     */
     PUBLIC = "public",
+    /**
+     * A private subnet has limited access to anything outside of this subnet, including access from the internet.
+     * Access to this subnet needs to be explicitly allowed.
+     */
     PRIVATE = "private"
 }
+/**
+ * A Subnet model is the logical sub-division of the region, e.g. a public and a private subnet.
+ * A subnet is often used to isolate parts of your infrastructure with access gates in the front.
+ * - A subnet can only belong to one region, but a region can have multiple subnets.
+ *
+ * @example
+ * ```ts
+ * const subnet = new Subnet(region, 'my-subnet');
+ * subnet.subnetType = SubnetType.PUBLIC;
+ * ```
+ * @group Models
+ * @see Definition of [Default Models](/docs/fundamentals/models#default-models).
+ */
 export declare class Subnet extends AModel<ISubnet, Subnet> {
-    readonly MODEL_NAME: string;
+    readonly NODE_NAME: string;
     private options;
+    /**
+     * The ID of the subnet.
+     * - Format is `{regionId}-{subnetName}`
+     */
     readonly subnetId: string;
+    /**
+     * The name of the subnet.
+     */
     readonly subnetName: string;
     constructor(region: Region, name: string);
+    /**
+     * To block/disable intra-network communication within self.
+     * When this is set to `true`,
+     * any execution within this subnet will not be able to communicate with other executions within the same subnet.
+     *
+     * @defaultValue `false`
+     * @experimental
+     */
     get disableSubnetIntraNetwork(): boolean;
     set disableSubnetIntraNetwork(disableSubnetIntraNetwork: boolean);
     get subnetType(): SubnetType;
     set subnetType(subnetType: SubnetType);
-    diffProperties(previous: Subnet): Promise<Diff[]>;
     setContext(): string;
     synth(): ISubnet;
     static unSynth(subnet: ISubnet, deReferenceContext: (context: string) => Promise<UnknownModel>): Promise<Subnet>;
+    /**
+     * To update the networking rules of this subnet to allow or deny connectivity from another subnet.
+     * The networking rules are bi-directional,
+     * i.e. if subnet A can connect to subnet B, then subnet B can also connect to subnet A.
+     *
+     * @param subnet The other subnet.
+     * @param allowConnections Set to `true` to allow this and the other subnet to connect.
+     * Set to `false` to block this and the other subnet from connecting.
+     */
     updateNetworkingRules(subnet: Subnet, allowConnections: boolean): void;
 }

package/dist/models/subnet/subnet.model.js

@@ -9,27 +9,59 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 };
 var Subnet_1;
 import { Model } from '../../decorators/model.decorator.js';
-import { Diff, DiffAction } from '../../functions/diff/diff.js';
+import { Validate } from '../../decorators/validate.decorator.js';
+import { DiffAction } from '../../functions/diff/diff.js';
 import { AModel } from '../model.abstract.js';
 import { Region } from '../region/region.model.js';
+/**
+ * The type of subnet.
+ */
 export var SubnetType;
 (function (SubnetType) {
+    /**
+     * A public subnet is open to the internet,
+     * i.e. an {@link Execution} within this subnet can be accessed from the internet.
+     * Other than access from the internet, any other access needs to be explicitly allowed.
+     */
     SubnetType["PUBLIC"] = "public";
+    /**
+     * A private subnet has limited access to anything outside of this subnet, including access from the internet.
+     * Access to this subnet needs to be explicitly allowed.
+     */
     SubnetType["PRIVATE"] = "private";
 })(SubnetType || (SubnetType = {}));
+/**
+ * A Subnet model is the logical sub-division of the region, e.g. a public and a private subnet.
+ * A subnet is often used to isolate parts of your infrastructure with access gates in the front.
+ * - A subnet can only belong to one region, but a region can have multiple subnets.
+ *
+ * @example
+ * ```ts
+ * const subnet = new Subnet(region, 'my-subnet');
+ * subnet.subnetType = SubnetType.PUBLIC;
+ * ```
+ * @group Models
+ * @see Definition of [Default Models](/docs/fundamentals/models#default-models).
+ */
 let Subnet = Subnet_1 = class Subnet extends AModel {
-    MODEL_NAME = 'subnet';
-    options = {
-        disableSubnetIntraNetwork: false,
-        subnetType: SubnetType.PRIVATE,
-    };
-    subnetId;
-    subnetName;
     constructor(region, name) {
         super();
+        this.NODE_NAME = 'subnet';
+        this.options = {
+            disableSubnetIntraNetwork: false,
+            subnetType: SubnetType.PRIVATE,
+        };
         this.subnetId = region.regionId + '-' + name;
         this.subnetName = name;
     }
+    /**
+     * To block/disable intra-network communication within self.
+     * When this is set to `true`,
+     * any execution within this subnet will not be able to communicate with other executions within the same subnet.
+     *
+     * @defaultValue `false`
+     * @experimental
+     */
     get disableSubnetIntraNetwork() {
         return this.options.disableSubnetIntraNetwork;
     }
@@ -42,20 +74,10 @@ let Subnet = Subnet_1 = class Subnet extends AModel {
     set subnetType(subnetType) {
         this.options.subnetType = subnetType || SubnetType.PRIVATE;
     }
-    async diffProperties(previous) {
-        const diffs = [];
-        if (previous.disableSubnetIntraNetwork !== this.disableSubnetIntraNetwork) {
-            diffs.push(new Diff(this, DiffAction.UPDATE, 'disableSubnetIntraNetwork', this.disableSubnetIntraNetwork));
-        }
-        if (previous.subnetType !== this.subnetType) {
-            throw new Error('Change of subnet type is not supported!');
-        }
-        return diffs;
-    }
     setContext() {
         const parents = this.getParents();
         const region = parents['region'][0].to;
-        return [`${this.MODEL_NAME}=${this.subnetId}`, region.getContext()].join(',');
+        return [`${this.NODE_NAME}=${this.subnetId}`, region.getContext()].join(',');
     }
     synth() {
         const parents = this.getParents();
@@ -74,6 +96,15 @@ let Subnet = Subnet_1 = class Subnet extends AModel {
         newSubnet.subnetType = subnet.options.subnetType;
         return newSubnet;
     }
+    /**
+     * To update the networking rules of this subnet to allow or deny connectivity from another subnet.
+     * The networking rules are bi-directional,
+     * i.e. if subnet A can connect to subnet B, then subnet B can also connect to subnet A.
+     *
+     * @param subnet The other subnet.
+     * @param allowConnections Set to `true` to allow this and the other subnet to connect.
+     * Set to `false` to block this and the other subnet from connecting.
+     */
     updateNetworkingRules(subnet, allowConnections) {
         const siblingDependencies = this.getSiblings('subnet');
         if (!siblingDependencies['subnet'])
@@ -81,15 +112,20 @@ let Subnet = Subnet_1 = class Subnet extends AModel {
         const subnets = siblingDependencies['subnet'].map((d) => d.to);
         if (allowConnections && !subnets.find((s) => s.subnetId === subnet.subnetId)) {
             const { thisToThatDependency, thatToThisDependency } = this.addRelationship(subnet);
-            thisToThatDependency.addBehavior('subnetId', DiffAction.ADD, 'subnetId', DiffAction.ADD);
-            thisToThatDependency.addBehavior('subnetId', DiffAction.ADD, 'subnetId', DiffAction.UPDATE);
-            thatToThisDependency.addBehavior('subnetId', DiffAction.DELETE, 'subnetId', DiffAction.DELETE);
+            thisToThatDependency.addBehavior('sibling', DiffAction.ADD, 'subnetId', DiffAction.ADD);
+            thisToThatDependency.addBehavior('sibling', DiffAction.ADD, 'subnetId', DiffAction.UPDATE);
+            thatToThisDependency.addBehavior('sibling', DiffAction.ADD, 'subnetId', DiffAction.ADD);
+            thatToThisDependency.addBehavior('sibling', DiffAction.ADD, 'subnetId', DiffAction.UPDATE);
         }
         else if (!allowConnections && subnets.find((s) => s.subnetId === subnet.subnetId)) {
             this.removeRelationship(subnet);
         }
     }
 };
+__decorate([
+    Validate({ options: { maxLength: 32, minLength: 2, regex: /^[a-zA-Z][\w-]*[a-zA-Z0-9]$/ } }),
+    __metadata("design:type", String)
+], Subnet.prototype, "subnetName", void 0);
 Subnet = Subnet_1 = __decorate([
     Model(),
     __metadata("design:paramtypes", [Region, String])

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

@@ -1 +1 @@
-{"version":3,"file":"subnet.model.js","sourceRoot":"","sources":["../../../src/models/subnet/subnet.model.ts"],"names":[],"mappings":";;;;;;;;;;AACA,OAAO,EAAE,KAAK,EAAE,MAAM,qCAAqC,CAAC;AAC5D,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAC;AAGnD,MAAM,CAAN,IAAY,UAGX;AAHD,WAAY,UAAU;IACpB,+BAAiB,CAAA;IACjB,iCAAmB,CAAA;AACrB,CAAC,EAHW,UAAU,KAAV,UAAU,QAGrB;AAGM,IAAM,MAAM,cAAZ,MAAM,MAAO,SAAQ,MAAuB;IACxC,UAAU,GAAW,QAAQ,CAAC;IAE/B,OAAO,GAAmE;QAChF,yBAAyB,EAAE,KAAK;QAChC,UAAU,EAAE,UAAU,CAAC,OAAO;KAC/B,CAAC;IAEO,QAAQ,CAAS;IAEjB,UAAU,CAAS;IAE5B,YAAY,MAAc,EAAE,IAAY;QACtC,KAAK,EAAE,CAAC;QAER,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,GAAG,GAAG,GAAG,IAAI,CAAC;QAC7C,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;IACzB,CAAC;IAED,IAAI,yBAAyB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,yBAAyB,CAAC;IAChD,CAAC;IAED,IAAI,yBAAyB,CAAC,yBAAkC;QAC9D,IAAI,CAAC,OAAO,CAAC,yBAAyB,GAAG,yBAAyB,CAAC;IACrE,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC;IACjC,CAAC;IAED,IAAI,UAAU,CAAC,UAAsB;QACnC,IAAI,CAAC,OAAO,CAAC,UAAU,GAAG,UAAU,IAAI,UAAU,CAAC,OAAO,CAAC;IAC7D,CAAC;IAEQ,KAAK,CAAC,cAAc,CAAC,QAAgB;QAC5C,MAAM,KAAK,GAAW,EAAE,CAAC;QAGzB,IAAI,QAAQ,CAAC,yBAAyB,KAAK,IAAI,CAAC,yBAAyB,EAAE,CAAC;YAC1E,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,MAAM,EAAE,2BAA2B,EAAE,IAAI,CAAC,yBAAyB,CAAC,CAAC,CAAC;QAC7G,CAAC;QACD,IAAI,QAAQ,CAAC,UAAU,KAAK,IAAI,CAAC,UAAU,EAAE,CAAC;YAC5C,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;QAC7D,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAEQ,UAAU;QACjB,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAClC,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACvC,OAAO,CAAC,GAAG,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,QAAQ,EAAE,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAChF,CAAC;IAEQ,KAAK;QACZ,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAClC,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAY,CAAC;QAEjD,OAAO;YACL,OAAO,EAAE,EAAE,yBAAyB,EAAE,IAAI,CAAC,yBAAyB,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE;YACnG,MAAM,EAAE,EAAE,OAAO,EAAE,MAAM,CAAC,UAAU,EAAE,EAAE;YACxC,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,UAAU,EAAE,IAAI,CAAC,UAAU;SAC5B,CAAC;IACJ,CAAC;IAED,MAAM,CAAU,KAAK,CAAC,OAAO,CAC3B,MAAe,EACf,kBAA8D;QAE9D,MAAM,MAAM,GAAG,CAAC,MAAM,kBAAkB,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAW,CAAC;QAC3E,MAAM,SAAS,GAAG,IAAI,QAAM,CAAC,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC;QAExD,SAAS,CAAC,yBAAyB,GAAG,MAAM,CAAC,OAAO,CAAC,yBAAyB,CAAC;QAC/E,SAAS,CAAC,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC;QAEjD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,qBAAqB,CAAC,MAAc,EAAE,gBAAyB;QAC7D,MAAM,mBAAmB,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QACvD,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC;YAAE,mBAAmB,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;QACvE,MAAM,OAAO,GAAG,mBAAmB,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAE/D,IAAI,gBAAgB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;YACrF,MAAM,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;YACpF,oBAAoB,CAAC,WAAW,CAAC,UAAU,EAAE,UAAU,CAAC,GAAG,EAAE,UAAU,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC;YACzF,oBAAoB,CAAC,WAAW,CAAC,UAAU,EAAE,UAAU,CAAC,GAAG,EAAE,UAAU,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;YAC5F,oBAAoB,CAAC,WAAW,CAAC,UAAU,EAAE,UAAU,CAAC,MAAM,EAAE,UAAU,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;QACjG,CAAC;aAAM,IAAI,CAAC,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC5F,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;CACF,CAAA;AA9FY,MAAM;IADlB,KAAK,EAAE;qCAac,MAAM;GAZf,MAAM,CA8FlB"}
+{"version":3,"file":"subnet.model.js","sourceRoot":"","sources":["../../../src/models/subnet/subnet.model.ts"],"names":[],"mappings":";;;;;;;;;;AACA,OAAO,EAAE,KAAK,EAAE,MAAM,qCAAqC,CAAC;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,wCAAwC,CAAC;AAClE,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC1D,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAC;AAGnD;;GAEG;AACH,MAAM,CAAN,IAAY,UAaX;AAbD,WAAY,UAAU;IACpB;;;;OAIG;IACH,+BAAiB,CAAA;IAEjB;;;OAGG;IACH,iCAAmB,CAAA;AACrB,CAAC,EAbW,UAAU,KAAV,UAAU,QAarB;AAED;;;;;;;;;;;;GAYG;AAEI,IAAM,MAAM,cAAZ,MAAM,MAAO,SAAQ,MAAuB;IAoBjD,YAAY,MAAc,EAAE,IAAY;QACtC,KAAK,EAAE,CAAC;QApBD,cAAS,GAAW,QAAQ,CAAC;QAE9B,YAAO,GAAmE;YAChF,yBAAyB,EAAE,KAAK;YAChC,UAAU,EAAE,UAAU,CAAC,OAAO;SAC/B,CAAC;QAiBA,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,GAAG,GAAG,GAAG,IAAI,CAAC;QAC7C,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;IACzB,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,yBAAyB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,yBAAyB,CAAC;IAChD,CAAC;IAED,IAAI,yBAAyB,CAAC,yBAAkC;QAC9D,IAAI,CAAC,OAAO,CAAC,yBAAyB,GAAG,yBAAyB,CAAC;IACrE,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC;IACjC,CAAC;IAED,IAAI,UAAU,CAAC,UAAsB;QACnC,IAAI,CAAC,OAAO,CAAC,UAAU,GAAG,UAAU,IAAI,UAAU,CAAC,OAAO,CAAC;IAC7D,CAAC;IAEQ,UAAU;QACjB,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAClC,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACvC,OAAO,CAAC,GAAG,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,QAAQ,EAAE,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC/E,CAAC;IAEQ,KAAK;QACZ,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAClC,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAY,CAAC;QAEjD,OAAO;YACL,OAAO,EAAE,EAAE,yBAAyB,EAAE,IAAI,CAAC,yBAAyB,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE;YACnG,MAAM,EAAE,EAAE,OAAO,EAAE,MAAM,CAAC,UAAU,EAAE,EAAE;YACxC,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,UAAU,EAAE,IAAI,CAAC,UAAU;SAC5B,CAAC;IACJ,CAAC;IAED,MAAM,CAAU,KAAK,CAAC,OAAO,CAC3B,MAAe,EACf,kBAA8D;QAE9D,MAAM,MAAM,GAAG,CAAC,MAAM,kBAAkB,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAW,CAAC;QAC3E,MAAM,SAAS,GAAG,IAAI,QAAM,CAAC,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC;QAExD,SAAS,CAAC,yBAAyB,GAAG,MAAM,CAAC,OAAO,CAAC,yBAAyB,CAAC;QAC/E,SAAS,CAAC,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC;QAEjD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;;;;OAQG;IACH,qBAAqB,CAAC,MAAc,EAAE,gBAAyB;QAC7D,MAAM,mBAAmB,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QACvD,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC;YAAE,mBAAmB,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;QACvE,MAAM,OAAO,GAAG,mBAAmB,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAE/D,IAAI,gBAAgB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;YACrF,MAAM,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;YACpF,oBAAoB,CAAC,WAAW,CAAC,SAAS,EAAE,UAAU,CAAC,GAAG,EAAE,UAAU,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC;YACxF,oBAAoB,CAAC,WAAW,CAAC,SAAS,EAAE,UAAU,CAAC,GAAG,EAAE,UAAU,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;YAC3F,oBAAoB,CAAC,WAAW,CAAC,SAAS,EAAE,UAAU,CAAC,GAAG,EAAE,UAAU,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC;YACxF,oBAAoB,CAAC,WAAW,CAAC,SAAS,EAAE,UAAU,CAAC,GAAG,EAAE,UAAU,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;QAC7F,CAAC;aAAM,IAAI,CAAC,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC5F,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;CACF,CAAA;AAxFU;IADR,QAAQ,CAAC,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,6BAA6B,EAAE,EAAE,CAAC;;0CACjE;AAlBjB,MAAM;IADlB,KAAK,EAAE;qCAqBc,MAAM;GApBf,MAAM,CA0GlB"}

package/dist/modules/module.container.d.ts

@@ -1,5 +1,5 @@
 import { Constructable } from '../app.type.js';
-import { type Module } from '../decorators/module.decorator.js';
+import { type IModuleOptions } from '../decorators/module.decorator.js';
 import { CommitHook } from '../functions/hook/commit.hook.js';
 import { ModelActionHook } from '../functions/hook/model-action.hook.js';
 import { ResourceActionHook } from '../functions/hook/resource-action.hook.js';
@@ -15,9 +15,11 @@ export declare class ModuleContainer {
     getModuleMetadata(module: Constructable<IModule<unknown>> | string): ModuleContainer['modules'][0] | undefined;
     getModuleMetadataIndex(module: Constructable<IModule<unknown>> | string): number;
     getOutput<T>(module: Constructable<IModule<T>> | string): T | undefined;
-    register(module: Constructable<IModule<unknown>>, properties: Parameters<typeof Module>[0]): void;
+    load(module: Constructable<IModule<unknown>>): void;
+    register(module: Constructable<IModule<unknown>>, properties: IModuleOptions): void;
     reset(): void;
     private setApplyOrder;
+    unload(module: Constructable<IModule<unknown>>): void;
 }
 export declare class ModuleContainerFactory {
     private static instance;

package/dist/modules/module.container.js

@@ -11,15 +11,12 @@ import { ModelActionHook } from '../functions/hook/model-action.hook.js';
 import { ResourceActionHook } from '../functions/hook/resource-action.hook.js';
 import { EventService } from '../services/event/event.service.js';
 export class ModuleContainer {
-    commitHook;
-    modelActionHook;
-    resourceActionHook;
-    modules = [];
-    outputs = {};
     constructor(commitHook, modelActionHook, resourceActionHook) {
         this.commitHook = commitHook;
         this.modelActionHook = modelActionHook;
         this.resourceActionHook = resourceActionHook;
+        this.modules = [];
+        this.outputs = {};
     }
     async apply() {
         for (const moduleMetadata of this.modules) {
@@ -43,6 +40,7 @@ export class ModuleContainer {
             }, []);
             for (const [i, { isArg, name }] of (properties.args || []).entries()) {
                 if (!isArg(args[i])) {
+                    // eslint-disable-next-line max-len
                     const message = `Module "${module.name}" requires an argument at position [${i}] of type "${name}", but received "${typeof args[i]}"!`;
                     throw new Error(message);
                 }
@@ -68,9 +66,15 @@ export class ModuleContainer {
         const name = typeof module === 'string' ? module : module.name;
         return name in this.outputs ? this.outputs[name] : undefined;
     }
+    load(module) {
+        const m = this.getModuleMetadata(module);
+        if (m) {
+            m.hidden = false;
+        }
+    }
     register(module, properties) {
         if (!this.modules.some((m) => m.module.name === module.name)) {
-            this.modules.push({ applied: false, applyOrder: -1, hidden: false, module, properties });
+            this.modules.push({ applied: false, applyOrder: -1, hidden: true, module, properties });
         }
     }
     reset() {
@@ -83,7 +87,7 @@ export class ModuleContainer {
         this.modules.map((m) => {
             m.applied = false;
             m.applyOrder = -1;
-            m.hidden = false;
+            m.hidden = true;
         });
     }
     setApplyOrder(moduleMetadata, seen = []) {
@@ -105,9 +109,14 @@ export class ModuleContainer {
         }
         moduleMetadata.applyOrder = Math.max(...parentModuleApplyOrders) + 1;
     }
+    unload(module) {
+        const m = this.getModuleMetadata(module);
+        if (m) {
+            m.hidden = true;
+        }
+    }
 }
 let ModuleContainerFactory = class ModuleContainerFactory {
-    static instance;
     static async create() {
         if (!this.instance) {
             const commitHook = CommitHook.getInstance();