@quadnix/octo 0.0.20 → 0.0.22

package/dist/main.js

@@ -8,10 +8,11 @@ var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
 import { strict as assert } from 'assert';
-import { Container } from './decorators/container.js';
+import { Container } from './functions/container/container.js';
 import { EnableHook } from './decorators/enable-hook.decorator.js';
 import { App } from './models/app/app.model.js';
 import { ModuleContainer } from './modules/module.container.js';
+import { OverlayDataRepository } from './overlays/overlay-data.repository.js';
 import { ResourceDataRepository } from './resources/resource-data.repository.js';
 import { CaptureService } from './services/capture/capture.service.js';
 import { InputService } from './services/input/input.service.js';
@@ -19,56 +20,88 @@ import { ModelSerializationService } from './services/serialization/model/model-
 import { ResourceSerializationService } from './services/serialization/resource/resource-serialization.service.js';
 import { StateManagementService } from './services/state-management/state-management.service.js';
 import { TransactionService } from './services/transaction/transaction.service.js';
+import { ValidationService } from './services/validation/validation.service.js';
 export class Octo {
-    modelStateFileName = 'models.json';
-    resourceStateFileName = 'resources.json';
-    previousApp;
-    captureService;
-    inputService;
-    modelSerializationService;
-    resourceDataRepository;
-    resourceSerializationService;
-    stateManagementService;
-    transactionService;
-    async beginTransaction(app, options) {
-        const diffs = await app.diff(this.previousApp);
-        return this.transactionService.beginTransaction(diffs, options || {});
+    constructor() {
+        this.modelStateFileName = 'models.json';
+        this.actualResourceStateFileName = 'resources-actual.json';
+        this.oldResourceStateFileName = 'resources-old.json';
     }
-    async commitTransaction(app, modelTransaction) {
+    async *beginTransaction(app, { enableResourceCapture = false, yieldModelDiffs = false, yieldModelTransaction = false, yieldResourceDiffs = false, yieldResourceTransaction = false, } = {}) {
+        const diffs = await app.diff();
+        const transaction = await this.transactionService.beginTransaction(diffs, {
+            enableResourceCapture,
+            yieldModelDiffs,
+            yieldModelTransaction: true,
+            yieldResourceDiffs,
+            yieldResourceTransaction: true,
+        });
+        if (yieldModelDiffs) {
+            yield (await transaction.next()).value;
+        }
+        const modelTransaction = (await transaction.next()).value;
+        if (yieldModelTransaction) {
+            yield modelTransaction;
+        }
+        let resourceTransaction = [];
+        try {
+            if (yieldResourceDiffs) {
+                yield (await transaction.next()).value;
+            }
+            resourceTransaction = (await transaction.next()).value;
+            if (yieldResourceTransaction) {
+                yield resourceTransaction;
+            }
+            return (await transaction.next()).value;
+        }
+        finally {
+            await this.commitTransaction(app, modelTransaction, resourceTransaction);
+        }
+    }
+    async commitTransaction(app, modelTransaction, resourceTransaction = []) {
+        // `modelTransaction` is used by hooks of type CommitHook.
         assert(!!modelTransaction);
+        assert(!!resourceTransaction);
+        // Save the state of the new app and its resources.
         await this.saveModelState(app);
         await this.saveResourceState();
+        // Reset the runtime environment with the latest state.
         await this.retrieveResourceState();
-        this.previousApp = await this.retrieveModelState();
     }
     async compose() {
-        const moduleContainer = await Container.get(ModuleContainer);
-        await moduleContainer.apply();
+        await this.moduleContainer.apply();
+        const result = this.validationService.validate();
+        if (!result.pass) {
+            throw new Error('Validation error!');
+        }
     }
     getAllResources() {
-        return this.resourceDataRepository.getByProperties();
+        return this.resourceDataRepository.getNewResourcesByProperties();
     }
-    async getModuleOutput(module) {
-        const moduleContainer = await Container.get(ModuleContainer);
-        return moduleContainer.getOutput(module);
+    getModuleOutput(module) {
+        return this.moduleContainer.getOutput(module);
     }
     async initialize(stateProvider, initializeInContainer = [], excludeInContainer = []) {
         [
             this.captureService,
             this.inputService,
             this.modelSerializationService,
+            this.moduleContainer,
             this.resourceDataRepository,
             this.resourceSerializationService,
             this.stateManagementService,
             this.transactionService,
+            this.validationService,
         ] = await Promise.all([
             Container.get(CaptureService),
             Container.get(InputService),
             Container.get(ModelSerializationService),
+            Container.get(ModuleContainer),
             Container.get(ResourceDataRepository),
             Container.get(ResourceSerializationService),
-            Container.get(StateManagementService, { args: [stateProvider] }),
+            Container.get(StateManagementService, { args: [true, stateProvider] }),
             Container.get(TransactionService),
+            Container.get(ValidationService),
         ]);
         for (const exclude of excludeInContainer) {
             Container.unRegisterFactory(exclude.type);
@@ -76,34 +109,40 @@ export class Octo {
         for (const initialize of initializeInContainer) {
             await Container.get(initialize.type, initialize.options);
         }
+        // Reset the runtime environment with the latest state.
         await this.retrieveResourceState();
-        this.previousApp = await this.retrieveModelState();
     }
-    registerCapture(resourceId, properties, response) {
-        this.captureService.registerCapture(resourceId, properties, response);
+    loadModules(modules) {
+        for (const module of modules) {
+            this.moduleContainer.load(module);
+        }
+    }
+    registerCapture(resourceId, response) {
+        this.captureService.registerCapture(resourceId, response);
     }
     registerInputs(inputs) {
         this.inputService.registerInputs(inputs);
     }
-    async retrieveModelState() {
-        const { data: modelSerializedOutput } = await this.stateManagementService.getModelState(this.modelStateFileName);
-        return Object.keys(modelSerializedOutput.models).length > 0
-            ? (await this.modelSerializationService.deserialize(modelSerializedOutput))
-            : undefined;
-    }
     async retrieveResourceState() {
-        const { data: resourceSerializedOutput } = await this.stateManagementService.getResourceState(this.resourceStateFileName);
-        await this.resourceSerializationService.deserialize(resourceSerializedOutput);
+        const { data: actualSerializedOutput } = await this.stateManagementService.getResourceState(this.actualResourceStateFileName);
+        const { data: oldSerializedOutput } = await this.stateManagementService.getResourceState(this.oldResourceStateFileName);
+        // Initialize previous resource state.
+        await this.resourceSerializationService.deserialize(actualSerializedOutput, oldSerializedOutput);
     }
     async saveModelState(app) {
         const modelSerializedOutput = await this.modelSerializationService.serialize(app);
         await this.stateManagementService.saveModelState(this.modelStateFileName, modelSerializedOutput, {
             version: 1,
         });
+        await Container.get(OverlayDataRepository, { args: [true] });
     }
     async saveResourceState() {
-        const resourceSerializedOutput = await this.resourceSerializationService.serialize();
-        await this.stateManagementService.saveResourceState(this.resourceStateFileName, resourceSerializedOutput, {
+        const actualSerializedOutput = await this.resourceSerializationService.serializeActualResources();
+        await this.stateManagementService.saveResourceState(this.actualResourceStateFileName, actualSerializedOutput, {
+            version: 1,
+        });
+        const oldSerializedOutput = await this.resourceSerializationService.serializeNewResources();
+        await this.stateManagementService.saveResourceState(this.oldResourceStateFileName, oldSerializedOutput, {
             version: 1,
         });
     }
@@ -111,7 +150,7 @@ export class Octo {
 __decorate([
     EnableHook('CommitHook'),
     __metadata("design:type", Function),
-    __metadata("design:paramtypes", [App, Array]),
+    __metadata("design:paramtypes", [App, Array, Array]),
     __metadata("design:returntype", Promise)
 ], Octo.prototype, "commitTransaction", null);
 //# sourceMappingURL=main.js.map

package/dist/main.js.map

@@ -1 +1 @@
-{"version":3,"file":"main.js","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,QAAQ,CAAC;AAE1C,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,OAAO,EAAE,UAAU,EAAE,MAAM,uCAAuC,CAAC;AAEnE,OAAO,EAAE,GAAG,EAAE,MAAM,2BAA2B,CAAC;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAEhE,OAAO,EAAE,sBAAsB,EAAE,MAAM,yCAAyC,CAAC;AAEjF,OAAO,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAC;AACvE,OAAO,EAAE,YAAY,EAAE,MAAM,mCAAmC,CAAC;AACjE,OAAO,EAAE,yBAAyB,EAAE,MAAM,+DAA+D,CAAC;AAC1G,OAAO,EAAE,4BAA4B,EAAE,MAAM,qEAAqE,CAAC;AACnH,OAAO,EAAE,sBAAsB,EAAE,MAAM,yDAAyD,CAAC;AAEjG,OAAO,EAAE,kBAAkB,EAAE,MAAM,+CAA+C,CAAC;AAEnF,MAAM,OAAO,IAAI;IACE,kBAAkB,GAAW,aAAa,CAAC;IAC3C,qBAAqB,GAAW,gBAAgB,CAAC;IAE1D,WAAW,CAAkB;IAE7B,cAAc,CAAiB;IAC/B,YAAY,CAAe;IAC3B,yBAAyB,CAA4B;IACrD,sBAAsB,CAAyB;IAC/C,4BAA4B,CAA+B;IAC3D,sBAAsB,CAAyB;IAC/C,kBAAkB,CAAqB;IAE/C,KAAK,CAAC,gBAAgB,CACpB,GAAQ,EACR,OAA4B;QAE5B,MAAM,KAAK,GAAG,MAAM,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC/C,OAAO,IAAI,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,KAAK,EAAE,OAAO,IAAI,EAAE,CAAC,CAAC;IACxE,CAAC;IAGK,AAAN,KAAK,CAAC,iBAAiB,CAAC,GAAQ,EAAE,gBAAkC;QAElE,MAAM,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC;QAG3B,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;QAC/B,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAG/B,MAAM,IAAI,CAAC,qBAAqB,EAAE,CAAC;QACnC,IAAI,CAAC,WAAW,GAAG,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;IACrD,CAAC;IAED,KAAK,CAAC,OAAO;QACX,MAAM,eAAe,GAAG,MAAM,SAAS,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;QAC7D,MAAM,eAAe,CAAC,KAAK,EAAE,CAAC;IAChC,CAAC;IAED,eAAe;QACb,OAAO,IAAI,CAAC,sBAAsB,CAAC,eAAe,EAAE,CAAC;IACvD,CAAC;IAED,KAAK,CAAC,eAAe,CAAI,MAA0C;QACjE,MAAM,eAAe,GAAG,MAAM,SAAS,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;QAC7D,OAAO,eAAe,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;IAED,KAAK,CAAC,UAAU,CACd,aAA6B,EAC7B,wBAGM,EAAE,EACR,qBAEM,EAAE;QAER;YACE,IAAI,CAAC,cAAc;YACnB,IAAI,CAAC,YAAY;YACjB,IAAI,CAAC,yBAAyB;YAC9B,IAAI,CAAC,sBAAsB;YAC3B,IAAI,CAAC,4BAA4B;YACjC,IAAI,CAAC,sBAAsB;YAC3B,IAAI,CAAC,kBAAkB;SACxB,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACpB,SAAS,CAAC,GAAG,CAAC,cAAc,CAAC;YAC7B,SAAS,CAAC,GAAG,CAAC,YAAY,CAAC;YAC3B,SAAS,CAAC,GAAG,CAAC,yBAAyB,CAAC;YACxC,SAAS,CAAC,GAAG,CAAC,sBAAsB,CAAC;YACrC,SAAS,CAAC,GAAG,CAAC,4BAA4B,CAAC;YAC3C,SAAS,CAAC,GAAG,CAAC,sBAAsB,EAAE,EAAE,IAAI,EAAE,CAAC,aAAa,CAAC,EAAE,CAAC;YAChE,SAAS,CAAC,GAAG,CAAC,kBAAkB,CAAC;SAClC,CAAC,CAAC;QAEH,KAAK,MAAM,OAAO,IAAI,kBAAkB,EAAE,CAAC;YACzC,SAAS,CAAC,iBAAiB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC5C,CAAC;QACD,KAAK,MAAM,UAAU,IAAI,qBAAqB,EAAE,CAAC;YAC/C,MAAM,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;QAC3D,CAAC;QAGD,MAAM,IAAI,CAAC,qBAAqB,EAAE,CAAC;QACnC,IAAI,CAAC,WAAW,GAAG,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;IACrD,CAAC;IAED,eAAe,CACb,UAA2B,EAC3B,UAAoC,EACpC,QAAgC;QAEhC,IAAI,CAAC,cAAc,CAAC,eAAe,CAAC,UAAU,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;IACxE,CAAC;IAED,cAAc,CAAC,MAAoB;QACjC,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;IAEO,KAAK,CAAC,kBAAkB;QAC9B,MAAM,EAAE,IAAI,EAAE,qBAAqB,EAAE,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,aAAa,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAGjH,OAAO,MAAM,CAAC,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC;YACzD,CAAC,CAAE,CAAC,MAAM,IAAI,CAAC,yBAAyB,CAAC,WAAW,CAAC,qBAAqB,CAAC,CAAS;YACpF,CAAC,CAAC,SAAS,CAAC;IAChB,CAAC;IAEO,KAAK,CAAC,qBAAqB;QACjC,MAAM,EAAE,IAAI,EAAE,wBAAwB,EAAE,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,gBAAgB,CAC3F,IAAI,CAAC,qBAAqB,CAC3B,CAAC;QAGF,MAAM,IAAI,CAAC,4BAA4B,CAAC,WAAW,CAAC,wBAAwB,CAAC,CAAC;IAChF,CAAC;IAEO,KAAK,CAAC,cAAc,CAAC,GAAQ;QACnC,MAAM,qBAAqB,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAClF,MAAM,IAAI,CAAC,sBAAsB,CAAC,cAAc,CAAC,IAAI,CAAC,kBAAkB,EAAE,qBAAqB,EAAE;YAC/F,OAAO,EAAE,CAAC;SACX,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,iBAAiB;QAC7B,MAAM,wBAAwB,GAAG,MAAM,IAAI,CAAC,4BAA4B,CAAC,SAAS,EAAE,CAAC;QACrF,MAAM,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,IAAI,CAAC,qBAAqB,EAAE,wBAAwB,EAAE;YACxG,OAAO,EAAE,CAAC;SACX,CAAC,CAAC;IACL,CAAC;CACF;AA9GO;IADL,UAAU,CAAC,YAAY,CAAC;;qCACI,GAAG;;6CAW/B"}
+{"version":3,"file":"main.js","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,QAAQ,CAAC;AAE1C,OAAO,EAAE,SAAS,EAAE,MAAM,oCAAoC,CAAC;AAC/D,OAAO,EAAE,UAAU,EAAE,MAAM,uCAAuC,CAAC;AAEnE,OAAO,EAAE,GAAG,EAAE,MAAM,2BAA2B,CAAC;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAEhE,OAAO,EAAE,qBAAqB,EAAE,MAAM,uCAAuC,CAAC;AAC9E,OAAO,EAAE,sBAAsB,EAAE,MAAM,yCAAyC,CAAC;AAEjF,OAAO,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAC;AACvE,OAAO,EAAE,YAAY,EAAE,MAAM,mCAAmC,CAAC;AACjE,OAAO,EAAE,yBAAyB,EAAE,MAAM,+DAA+D,CAAC;AAC1G,OAAO,EAAE,4BAA4B,EAAE,MAAM,qEAAqE,CAAC;AACnH,OAAO,EAAE,sBAAsB,EAAE,MAAM,yDAAyD,CAAC;AAEjG,OAAO,EAAE,kBAAkB,EAAE,MAAM,+CAA+C,CAAC;AACnF,OAAO,EAAE,iBAAiB,EAAE,MAAM,6CAA6C,CAAC;AAEhF,MAAM,OAAO,IAAI;IAAjB;QACmB,uBAAkB,GAAW,aAAa,CAAC;QAC3C,gCAA2B,GAAW,uBAAuB,CAAC;QAC9D,6BAAwB,GAAW,oBAAoB,CAAC;IAqL3E,CAAC;IAzKC,KAAK,CAAC,CAAC,gBAAgB,CACrB,GAAQ,EACR,EACE,qBAAqB,GAAG,KAAK,EAC7B,eAAe,GAAG,KAAK,EACvB,qBAAqB,GAAG,KAAK,EAC7B,kBAAkB,GAAG,KAAK,EAC1B,wBAAwB,GAAG,KAAK,MACV,EAAE;QAE1B,MAAM,KAAK,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;QAC/B,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,KAAK,EAAE;YACxE,qBAAqB;YACrB,eAAe;YACf,qBAAqB,EAAE,IAAI;YAC3B,kBAAkB;YAClB,wBAAwB,EAAE,IAAI;SAC/B,CAAC,CAAC;QAEH,IAAI,eAAe,EAAE,CAAC;YACpB,MAAM,CAAC,MAAM,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC;QACzC,CAAC;QAED,MAAM,gBAAgB,GAAG,CAAC,MAAM,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC;QAC1D,IAAI,qBAAqB,EAAE,CAAC;YAC1B,MAAM,gBAAgB,CAAC;QACzB,CAAC;QAED,IAAI,mBAAmB,GAAqB,EAAE,CAAC;QAC/C,IAAI,CAAC;YACH,IAAI,kBAAkB,EAAE,CAAC;gBACvB,MAAM,CAAC,MAAM,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC;YACzC,CAAC;YAED,mBAAmB,GAAG,CAAC,MAAM,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC;YACvD,IAAI,wBAAwB,EAAE,CAAC;gBAC7B,MAAM,mBAAmB,CAAC;YAC5B,CAAC;YAED,OAAO,CAAC,MAAM,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC;QAC1C,CAAC;gBAAS,CAAC;YACT,MAAM,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,gBAAgB,EAAE,mBAAmB,CAAC,CAAC;QAC3E,CAAC;IACH,CAAC;IAGa,AAAN,KAAK,CAAC,iBAAiB,CAC7B,GAAQ,EACR,gBAAkC,EAClC,sBAAwC,EAAE;QAE1C,0DAA0D;QAC1D,MAAM,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC;QAC3B,MAAM,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC;QAE9B,mDAAmD;QACnD,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;QAC/B,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAE/B,uDAAuD;QACvD,MAAM,IAAI,CAAC,qBAAqB,EAAE,CAAC;IACrC,CAAC;IAED,KAAK,CAAC,OAAO;QACX,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;QAEnC,MAAM,MAAM,GAAG,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE,CAAC;QACjD,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;QACvC,CAAC;IACH,CAAC;IAED,eAAe;QACb,OAAO,IAAI,CAAC,sBAAsB,CAAC,2BAA2B,EAAE,CAAC;IACnE,CAAC;IAED,eAAe,CAAI,MAA0C;QAC3D,OAAO,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAChD,CAAC;IAED,KAAK,CAAC,UAAU,CACd,aAA6B,EAC7B,wBAGM,EAAE,EACR,qBAEM,EAAE;QAER;YACE,IAAI,CAAC,cAAc;YACnB,IAAI,CAAC,YAAY;YACjB,IAAI,CAAC,yBAAyB;YAC9B,IAAI,CAAC,eAAe;YACpB,IAAI,CAAC,sBAAsB;YAC3B,IAAI,CAAC,4BAA4B;YACjC,IAAI,CAAC,sBAAsB;YAC3B,IAAI,CAAC,kBAAkB;YACvB,IAAI,CAAC,iBAAiB;SACvB,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACpB,SAAS,CAAC,GAAG,CAAC,cAAc,CAAC;YAC7B,SAAS,CAAC,GAAG,CAAC,YAAY,CAAC;YAC3B,SAAS,CAAC,GAAG,CAAC,yBAAyB,CAAC;YACxC,SAAS,CAAC,GAAG,CAAC,eAAe,CAAC;YAC9B,SAAS,CAAC,GAAG,CAAC,sBAAsB,CAAC;YACrC,SAAS,CAAC,GAAG,CAAC,4BAA4B,CAAC;YAC3C,SAAS,CAAC,GAAG,CAAC,sBAAsB,EAAE,EAAE,IAAI,EAAE,CAAC,IAAI,EAAE,aAAa,CAAC,EAAE,CAAC;YACtE,SAAS,CAAC,GAAG,CAAC,kBAAkB,CAAC;YACjC,SAAS,CAAC,GAAG,CAAC,iBAAiB,CAAC;SACjC,CAAC,CAAC;QAEH,KAAK,MAAM,OAAO,IAAI,kBAAkB,EAAE,CAAC;YACzC,SAAS,CAAC,iBAAiB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC5C,CAAC;QACD,KAAK,MAAM,UAAU,IAAI,qBAAqB,EAAE,CAAC;YAC/C,MAAM,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;QAC3D,CAAC;QAED,uDAAuD;QACvD,MAAM,IAAI,CAAC,qBAAqB,EAAE,CAAC;IACrC,CAAC;IAED,WAAW,CAAC,OAAsC;QAChD,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;IAED,eAAe,CAAyB,UAA2B,EAAE,QAAgC;QACnG,IAAI,CAAC,cAAc,CAAC,eAAe,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;IAC5D,CAAC;IAED,cAAc,CAAC,MAAoB;QACjC,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;IAEO,KAAK,CAAC,qBAAqB;QACjC,MAAM,EAAE,IAAI,EAAE,sBAAsB,EAAE,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,gBAAgB,CACzF,IAAI,CAAC,2BAA2B,CACjC,CAAC;QACF,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,gBAAgB,CACtF,IAAI,CAAC,wBAAwB,CAC9B,CAAC;QAEF,sCAAsC;QACtC,MAAM,IAAI,CAAC,4BAA4B,CAAC,WAAW,CAAC,sBAAsB,EAAE,mBAAmB,CAAC,CAAC;IACnG,CAAC;IAEO,KAAK,CAAC,cAAc,CAAC,GAAQ;QACnC,MAAM,qBAAqB,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAClF,MAAM,IAAI,CAAC,sBAAsB,CAAC,cAAc,CAAC,IAAI,CAAC,kBAAkB,EAAE,qBAAqB,EAAE;YAC/F,OAAO,EAAE,CAAC;SACX,CAAC,CAAC;QAEH,MAAM,SAAS,CAAC,GAAG,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC/D,CAAC;IAEO,KAAK,CAAC,iBAAiB;QAC7B,MAAM,sBAAsB,GAAG,MAAM,IAAI,CAAC,4BAA4B,CAAC,wBAAwB,EAAE,CAAC;QAClG,MAAM,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,IAAI,CAAC,2BAA2B,EAAE,sBAAsB,EAAE;YAC5G,OAAO,EAAE,CAAC;SACX,CAAC,CAAC;QAEH,MAAM,mBAAmB,GAAG,MAAM,IAAI,CAAC,4BAA4B,CAAC,qBAAqB,EAAE,CAAC;QAC5F,MAAM,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,IAAI,CAAC,wBAAwB,EAAE,mBAAmB,EAAE;YACtG,OAAO,EAAE,CAAC;SACX,CAAC,CAAC;IACL,CAAC;CACF;AA3He;IADb,UAAU,CAAC,YAAY,CAAC;;qCAElB,GAAG;;6CAcT"}

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

@@ -1,4 +1,9 @@
 import type { App } from './app.model.js';
+/**
+ * {@link App} model interface.
+ *
+ * @group Model Interfaces
+ */
 export interface IApp {
     name: App['name'];
 }

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

@@ -1,5 +1,4 @@
 import type { UnknownModel } from '../../app.type.js';
-import type { Diff } from '../../functions/diff/diff.js';
 import { Image } from '../image/image.model.js';
 import { AModel } from '../model.abstract.js';
 import { Pipeline } from '../pipeline/pipeline.model.js';
@@ -7,15 +6,43 @@ import { Region } from '../region/region.model.js';
 import { Server } from '../server/server.model.js';
 import { Service } from '../service/service.model.js';
 import type { IApp } from './app.interface.js';
+/**
+ * An App model is the parent of all other models.
+ * It represents the main app for whom the infrastructure is being created.
+ *
+ * @example
+ * ```ts
+ * const app = new App('MyApp');
+ * ```
+ * @group Models
+ * @see Definition of [Default Models](/docs/fundamentals/models#default-models).
+ */
 export declare class App extends AModel<IApp, App> {
-    readonly MODEL_NAME: string;
+    readonly NODE_NAME: string;
+    /**
+     * The name of the app.
+     */
     readonly name: string;
     constructor(name: string);
-    diffProperties(): Promise<Diff[]>;
+    /**
+     * To add an {@link Image}.
+     */
     addImage(image: Image): void;
+    /**
+     * To add a {@link Pipeline}.
+     */
     addPipeline(pipeline: Pipeline): void;
+    /**
+     * To add a {@link Region}.
+     */
     addRegion(region: Region): void;
+    /**
+     * To add a {@link Server}.
+     */
     addServer(server: Server): void;
+    /**
+     * To add a {@link Service}.
+     */
     addService(service: Service): void;
     setContext(): string;
     synth(): IApp;

package/dist/models/app/app.model.js

@@ -8,62 +8,91 @@ var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
 var App_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';
+/**
+ * An App model is the parent of all other models.
+ * It represents the main app for whom the infrastructure is being created.
+ *
+ * @example
+ * ```ts
+ * const app = new App('MyApp');
+ * ```
+ * @group Models
+ * @see Definition of [Default Models](/docs/fundamentals/models#default-models).
+ */
 let App = App_1 = class App extends AModel {
-    MODEL_NAME = 'app';
-    name;
     constructor(name) {
         super();
+        this.NODE_NAME = 'app';
         this.name = name;
     }
-    async diffProperties() {
-        return [];
-    }
+    /**
+     * To add an {@link Image}.
+     */
     addImage(image) {
         const childrenDependencies = this.getChildren('image');
         if (!childrenDependencies['image'])
             childrenDependencies['image'] = [];
+        // Check for duplicates.
         const images = childrenDependencies['image'].map((d) => d.to);
         if (images.find((i) => i.imageId === image.imageId)) {
             throw new Error('Image already exists!');
         }
         this.addChild('name', image, 'imageId');
     }
+    /**
+     * To add a {@link Pipeline}.
+     */
     addPipeline(pipeline) {
         const childrenDependencies = this.getChildren('pipeline');
         if (!childrenDependencies['pipeline'])
             childrenDependencies['pipeline'] = [];
+        // Check for duplicates.
         const pipelines = childrenDependencies['pipeline'].map((d) => d.to);
         if (pipelines.find((p) => p.pipelineName === pipeline.pipelineName)) {
             throw new Error('Pipeline already exists!');
         }
         this.addChild('name', pipeline, 'pipelineName');
     }
+    /**
+     * To add a {@link Region}.
+     */
     addRegion(region) {
         const childrenDependencies = this.getChildren('region');
         if (!childrenDependencies['region'])
             childrenDependencies['region'] = [];
+        // Check for duplicates.
         const regions = childrenDependencies['region'].map((d) => d.to);
         if (regions.find((r) => r.regionId === region.regionId)) {
             throw new Error('Region already exists!');
         }
         this.addChild('name', region, 'regionId');
     }
+    /**
+     * To add a {@link Server}.
+     */
     addServer(server) {
         const childrenDependencies = this.getChildren('server');
         if (!childrenDependencies['server'])
             childrenDependencies['server'] = [];
+        // Check for duplicates.
         const servers = childrenDependencies['server'].map((d) => d.to);
         if (servers.find((s) => s.serverKey === server.serverKey)) {
             throw new Error('Server already exists!');
         }
         this.addChild('name', server, 'serverKey');
     }
+    /**
+     * To add a {@link Service}.
+     */
     addService(service) {
         const childrenDependencies = this.getChildren('service');
         if (!childrenDependencies['service'])
             childrenDependencies['service'] = [];
+        // Check for duplicates.
         const services = childrenDependencies['service'].map((d) => d.to);
         if (services.find((s) => s.serviceId === service.serviceId)) {
             throw new Error('Service already exists!');
@@ -71,7 +100,7 @@ let App = App_1 = class App extends AModel {
         this.addChild('name', service, 'serviceId');
     }
     setContext() {
-        return `${this.MODEL_NAME}=${this.name}`;
+        return `${this.NODE_NAME}=${this.name}`;
     }
     synth() {
         return {
@@ -79,9 +108,14 @@ let App = App_1 = class App extends AModel {
         };
     }
     static async unSynth(app, deReferenceContext) {
+        assert(!!deReferenceContext);
         return new App_1(app.name);
     }
 };
+__decorate([
+    Validate({ options: { maxLength: 64, minLength: 2, regex: /^[a-zA-Z][\w-]*[a-zA-Z0-9]$/ } }),
+    __metadata("design:type", String)
+], App.prototype, "name", void 0);
 App = App_1 = __decorate([
     Model(),
     __metadata("design:paramtypes", [String])

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

@@ -1 +1 @@
-{"version":3,"file":"app.model.js","sourceRoot":"","sources":["../../../src/models/app/app.model.ts"],"names":[],"mappings":";;;;;;;;;;AACA,OAAO,EAAE,KAAK,EAAE,MAAM,qCAAqC,CAAC;AAG5D,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAQvC,IAAM,GAAG,WAAT,MAAM,GAAI,SAAQ,MAAiB;IAC/B,UAAU,GAAW,KAAK,CAAC;IAE3B,IAAI,CAAS;IAEtB,YAAY,IAAY;QACtB,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAEQ,KAAK,CAAC,cAAc;QAC3B,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,QAAQ,CAAC,KAAY;QACnB,MAAM,oBAAoB,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QACvD,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC;YAAE,oBAAoB,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;QAGvE,MAAM,MAAM,GAAG,oBAAoB,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC9D,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;YAC3D,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;QAC3C,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC;IAC1C,CAAC;IAED,WAAW,CAAC,QAAkB;QAC5B,MAAM,oBAAoB,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;QAC1D,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC;YAAE,oBAAoB,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC;QAG7E,MAAM,SAAS,GAAG,oBAAoB,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QACpE,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC,CAAW,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,KAAK,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;YAC9E,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAC9C,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,EAAE,cAAc,CAAC,CAAC;IAClD,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,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;IAC5C,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,SAAS,KAAK,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;YAClE,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC5C,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAC7C,CAAC;IAED,UAAU,CAAC,OAAgB;QACzB,MAAM,oBAAoB,GAAG,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;QACzD,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC;YAAE,oBAAoB,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC;QAG3E,MAAM,QAAQ,GAAG,oBAAoB,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAClE,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAU,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,KAAK,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;YACrE,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAC7C,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;IAC9C,CAAC;IAEQ,UAAU;QACjB,OAAO,GAAG,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;IAC3C,CAAC;IAEQ,KAAK;QACZ,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;SAChB,CAAC;IACJ,CAAC;IAED,MAAM,CAAU,KAAK,CAAC,OAAO,CAC3B,GAAS,EAET,kBAA8D;QAE9D,OAAO,IAAI,KAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC;CACF,CAAA;AA3FY,GAAG;IADf,KAAK,EAAE;;GACK,GAAG,CA2Ff"}
+{"version":3,"file":"app.model.js","sourceRoot":"","sources":["../../../src/models/app/app.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;AAO9C;;;;;;;;;;GAUG;AAEI,IAAM,GAAG,WAAT,MAAM,GAAI,SAAQ,MAAiB;IASxC,YAAY,IAAY;QACtB,KAAK,EAAE,CAAC;QATD,cAAS,GAAW,KAAK,CAAC;QAUjC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,KAAY;QACnB,MAAM,oBAAoB,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QACvD,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC;YAAE,oBAAoB,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;QAEvE,wBAAwB;QACxB,MAAM,MAAM,GAAG,oBAAoB,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC9D,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;YAC3D,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;QAC3C,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC;IAC1C,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,QAAkB;QAC5B,MAAM,oBAAoB,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;QAC1D,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC;YAAE,oBAAoB,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC;QAE7E,wBAAwB;QACxB,MAAM,SAAS,GAAG,oBAAoB,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QACpE,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC,CAAW,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,KAAK,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;YAC9E,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAC9C,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,EAAE,cAAc,CAAC,CAAC;IAClD,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,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;IAC5C,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,SAAS,KAAK,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;YAClE,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC5C,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAC7C,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,OAAgB;QACzB,MAAM,oBAAoB,GAAG,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;QACzD,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC;YAAE,oBAAoB,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC;QAE3E,wBAAwB;QACxB,MAAM,QAAQ,GAAG,oBAAoB,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAClE,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAU,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,KAAK,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;YACrE,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAC7C,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;IAC9C,CAAC;IAEQ,UAAU;QACjB,OAAO,GAAG,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;IAC1C,CAAC;IAEQ,KAAK;QACZ,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;SAChB,CAAC;IACJ,CAAC;IAED,MAAM,CAAU,KAAK,CAAC,OAAO,CAC3B,GAAS,EACT,kBAA8D;QAE9D,MAAM,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC;QAE7B,OAAO,IAAI,KAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC;CACF,CAAA;AApGU;IADR,QAAQ,CAAC,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,6BAA6B,EAAE,EAAE,CAAC;;iCACvE;AAPX,GAAG;IADf,KAAK,EAAE;;GACK,GAAG,CA2Gf"}

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

@@ -1,4 +1,9 @@
 import type { Deployment } from './deployment.model.js';
+/**
+ * {@link Deployment} model interface.
+ *
+ * @group Model Interfaces
+ */
 export interface IDeployment {
     deploymentTag: Deployment['deploymentTag'];
 }

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

@@ -1,12 +1,25 @@
 import type { UnknownModel } from '../../app.type.js';
-import type { Diff } from '../../functions/diff/diff.js';
 import { AModel } from '../model.abstract.js';
 import type { IDeployment } from './deployment.interface.js';
+/**
+ * A deployment model is an instance of server's code at a specific point in time.
+ * Every change/commit in server code should generate a new deployment.
+ *
+ * @example
+ * ```ts
+ * const deployment = new Deployment('v0.0.1');
+ * ```
+ * @group Models
+ * @see Definition of [Default Models](/docs/fundamentals/models#default-models).
+ */
 export declare class Deployment extends AModel<IDeployment, Deployment> {
-    readonly MODEL_NAME: string;
+    readonly NODE_NAME: string;
+    /**
+     * The identifying tag that can point to the server's code at a specific point in time.
+     * Could be a version number or a commit hash.
+     */
     readonly deploymentTag: string;
     constructor(deploymentTag: string);
-    diffProperties(): Promise<Diff[]>;
     setContext(): string;
     synth(): IDeployment;
     static unSynth(deployment: IDeployment, deReferenceContext: (context: string) => Promise<UnknownModel>): Promise<Deployment>;

package/dist/models/deployment/deployment.model.js

@@ -8,22 +8,31 @@ var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
 var Deployment_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 deployment model is an instance of server's code at a specific point in time.
+ * Every change/commit in server code should generate a new deployment.
+ *
+ * @example
+ * ```ts
+ * const deployment = new Deployment('v0.0.1');
+ * ```
+ * @group Models
+ * @see Definition of [Default Models](/docs/fundamentals/models#default-models).
+ */
 let Deployment = Deployment_1 = class Deployment extends AModel {
-    MODEL_NAME = 'deployment';
-    deploymentTag;
     constructor(deploymentTag) {
         super();
+        this.NODE_NAME = 'deployment';
         this.deploymentTag = deploymentTag;
     }
-    async diffProperties() {
-        return [];
-    }
     setContext() {
         const parents = this.getParents();
         const parent = parents['server'][0].to;
-        return [`${this.MODEL_NAME}=${this.deploymentTag}`, parent.getContext()].join(',');
+        return [`${this.NODE_NAME}=${this.deploymentTag}`, parent.getContext()].join(',');
     }
     synth() {
         return {
@@ -31,9 +40,14 @@ let Deployment = Deployment_1 = class Deployment extends AModel {
         };
     }
     static async unSynth(deployment, deReferenceContext) {
+        assert(!!deReferenceContext);
         return new Deployment_1(deployment.deploymentTag);
     }
 };
+__decorate([
+    Validate({ options: { maxLength: 32, minLength: 2, regex: /^[a-zA-Z0-9][\w.-]*[a-zA-Z0-9]$/ } }),
+    __metadata("design:type", String)
+], Deployment.prototype, "deploymentTag", void 0);
 Deployment = Deployment_1 = __decorate([
     Model(),
     __metadata("design:paramtypes", [String])

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

@@ -1 +1 @@
-{"version":3,"file":"deployment.model.js","sourceRoot":"","sources":["../../../src/models/deployment/deployment.model.ts"],"names":[],"mappings":";;;;;;;;;;AACA,OAAO,EAAE,KAAK,EAAE,MAAM,qCAAqC,CAAC;AAE5D,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAIvC,IAAM,UAAU,kBAAhB,MAAM,UAAW,SAAQ,MAA+B;IACpD,UAAU,GAAW,YAAY,CAAC;IAElC,aAAa,CAAS;IAE/B,YAAY,aAAqB;QAC/B,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;IACrC,CAAC;IAEQ,KAAK,CAAC,cAAc;QAC3B,OAAO,EAAE,CAAC;IACZ,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,aAAa,EAAE,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACrF,CAAC;IAEQ,KAAK;QACZ,OAAO;YACL,aAAa,EAAE,IAAI,CAAC,aAAa;SAClC,CAAC;IACJ,CAAC;IAED,MAAM,CAAU,KAAK,CAAC,OAAO,CAC3B,UAAuB,EAEvB,kBAA8D;QAE9D,OAAO,IAAI,YAAU,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IAClD,CAAC;CACF,CAAA;AAjCY,UAAU;IADtB,KAAK,EAAE;;GACK,UAAU,CAiCtB"}
+{"version":3,"file":"deployment.model.js","sourceRoot":"","sources":["../../../src/models/deployment/deployment.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;AAClE,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAG9C;;;;;;;;;;GAUG;AAEI,IAAM,UAAU,kBAAhB,MAAM,UAAW,SAAQ,MAA+B;IAU7D,YAAY,aAAqB;QAC/B,KAAK,EAAE,CAAC;QAVD,cAAS,GAAW,YAAY,CAAC;QAWxC,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;IACrC,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,aAAa,EAAE,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACpF,CAAC;IAEQ,KAAK;QACZ,OAAO;YACL,aAAa,EAAE,IAAI,CAAC,aAAa;SAClC,CAAC;IACJ,CAAC;IAED,MAAM,CAAU,KAAK,CAAC,OAAO,CAC3B,UAAuB,EACvB,kBAA8D;QAE9D,MAAM,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC;QAE7B,OAAO,IAAI,YAAU,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IAClD,CAAC;CACF,CAAA;AA3BU;IADR,QAAQ,CAAC,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,iCAAiC,EAAE,EAAE,CAAC;;iDAClE;AARpB,UAAU;IADtB,KAAK,EAAE;;GACK,UAAU,CAmCtB"}

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

@@ -1,4 +1,9 @@
 import type { Environment } from './environment.model.js';
+/**
+ * {@link Environment} model interface.
+ *
+ * @group Model Interfaces
+ */
 export interface IEnvironment {
     environmentName: Environment['environmentName'];
     environmentVariables: {

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

@@ -1,13 +1,29 @@
 import type { UnknownModel } from '../../app.type.js';
-import type { Diff } from '../../functions/diff/diff.js';
 import { AModel } from '../model.abstract.js';
 import type { IEnvironment } from './environment.interface.js';
+/**
+ * An Environment model is the logical sub-section of a Region which isolates one runtime environment from another.
+ * E.g. qa, staging, production, etc.
+ *
+ * @example
+ * ```ts
+ * const environment = new Environment('qa');
+ * ```
+ * @group Models
+ * @see Definition of [Default Models](/docs/fundamentals/models#default-models).
+ */
 export declare class Environment extends AModel<IEnvironment, Environment> {
-    readonly MODEL_NAME: string;
+    readonly NODE_NAME: string;
+    /**
+     * The name of the environment.
+     * An environment must be unique within a Region. But multiple Regions can share the same environment name.
+     */
     readonly environmentName: string;
+    /**
+     * A set of environment variables to be passed to any {@link Execution} running in this environment.
+     */
     readonly environmentVariables: Map<string, string>;
     constructor(environmentName: string);
-    diffProperties(previous: Environment): Promise<Diff[]>;
     setContext(): string;
     synth(): IEnvironment;
     static unSynth(environment: IEnvironment, deReferenceContext: (context: string) => Promise<UnknownModel>): Promise<Environment>;

package/dist/models/environment/environment.model.js

@@ -8,24 +8,35 @@ var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
 var Environment_1;
+import { strict as assert } from 'assert';
 import { Model } from '../../decorators/model.decorator.js';
-import { DiffUtility } from '../../functions/diff/diff.utility.js';
+import { Validate } from '../../decorators/validate.decorator.js';
 import { AModel } from '../model.abstract.js';
+/**
+ * An Environment model is the logical sub-section of a Region which isolates one runtime environment from another.
+ * E.g. qa, staging, production, etc.
+ *
+ * @example
+ * ```ts
+ * const environment = new Environment('qa');
+ * ```
+ * @group Models
+ * @see Definition of [Default Models](/docs/fundamentals/models#default-models).
+ */
 let Environment = Environment_1 = class Environment extends AModel {
-    MODEL_NAME = 'environment';
-    environmentName;
-    environmentVariables = new Map();
     constructor(environmentName) {
         super();
+        this.NODE_NAME = 'environment';
+        /**
+         * A set of environment variables to be passed to any {@link Execution} running in this environment.
+         */
+        this.environmentVariables = new Map();
         this.environmentName = environmentName;
     }
-    async diffProperties(previous) {
-        return DiffUtility.diffMap(previous, this, 'environmentVariables');
-    }
     setContext() {
         const parents = this.getParents();
         const region = parents['region'][0].to;
-        return [`${this.MODEL_NAME}=${this.environmentName}`, region.getContext()].join(',');
+        return [`${this.NODE_NAME}=${this.environmentName}`, region.getContext()].join(',');
     }
     synth() {
         return {
@@ -34,6 +45,7 @@ let Environment = Environment_1 = class Environment extends AModel {
         };
     }
     static async unSynth(environment, deReferenceContext) {
+        assert(!!deReferenceContext);
         const newEnvironment = new Environment_1(environment.environmentName);
         for (const key in environment.environmentVariables) {
             newEnvironment.environmentVariables.set(key, environment.environmentVariables[key]);
@@ -41,6 +53,19 @@ let Environment = Environment_1 = class Environment extends AModel {
         return newEnvironment;
     }
 };
+__decorate([
+    Validate({ options: { maxLength: 32, minLength: 2, regex: /^[a-zA-Z][\w-]*[a-zA-Z0-9]$/ } }),
+    __metadata("design:type", String)
+], Environment.prototype, "environmentName", void 0);
+__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)
+], Environment.prototype, "environmentVariables", void 0);
 Environment = Environment_1 = __decorate([
     Model(),
     __metadata("design:paramtypes", [String])

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

@@ -1 +1 @@
-{"version":3,"file":"environment.model.js","sourceRoot":"","sources":["../../../src/models/environment/environment.model.ts"],"names":[],"mappings":";;;;;;;;;;AACA,OAAO,EAAE,KAAK,EAAE,MAAM,qCAAqC,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,sCAAsC,CAAC;AAEnE,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAIvC,IAAM,WAAW,mBAAjB,MAAM,WAAY,SAAQ,MAAiC;IACvD,UAAU,GAAW,aAAa,CAAC;IAEnC,eAAe,CAAS;IAExB,oBAAoB,GAAwB,IAAI,GAAG,EAAE,CAAC;IAE/D,YAAY,eAAuB;QACjC,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;IACzC,CAAC;IAEQ,KAAK,CAAC,cAAc,CAAC,QAAqB;QACjD,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,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACvC,OAAO,CAAC,GAAG,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,eAAe,EAAE,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACvF,CAAC;IAEQ,KAAK;QACZ,OAAO;YACL,eAAe,EAAE,IAAI,CAAC,eAAe;YACrC,oBAAoB,EAAE,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,oBAAoB,IAAI,IAAI,GAAG,EAAE,CAAC;SACjF,CAAC;IACJ,CAAC;IAED,MAAM,CAAU,KAAK,CAAC,OAAO,CAC3B,WAAyB,EAEzB,kBAA8D;QAE9D,MAAM,cAAc,GAAG,IAAI,aAAW,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC;QAEpE,KAAK,MAAM,GAAG,IAAI,WAAW,CAAC,oBAAoB,EAAE,CAAC;YACnD,cAAc,CAAC,oBAAoB,CAAC,GAAG,CAAC,GAAG,EAAE,WAAW,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC,CAAC;QACtF,CAAC;QAED,OAAO,cAAc,CAAC;IACxB,CAAC;CACF,CAAA;AA1CY,WAAW;IADvB,KAAK,EAAE;;GACK,WAAW,CA0CvB"}
+{"version":3,"file":"environment.model.js","sourceRoot":"","sources":["../../../src/models/environment/environment.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;AAClE,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAG9C;;;;;;;;;;GAUG;AAEI,IAAM,WAAW,mBAAjB,MAAM,WAAY,SAAQ,MAAiC;IAqBhE,YAAY,eAAuB;QACjC,KAAK,EAAE,CAAC;QArBD,cAAS,GAAW,aAAa,CAAC;QAS3C;;WAEG;QAOM,yBAAoB,GAAwB,IAAI,GAAG,EAAE,CAAC;QAI7D,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;IACzC,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,eAAe,EAAE,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACtF,CAAC;IAEQ,KAAK;QACZ,OAAO;YACL,eAAe,EAAE,IAAI,CAAC,eAAe;YACrC,oBAAoB,EAAE,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,oBAAoB,IAAI,IAAI,GAAG,EAAE,CAAC;SACjF,CAAC;IACJ,CAAC;IAED,MAAM,CAAU,KAAK,CAAC,OAAO,CAC3B,WAAyB,EACzB,kBAA8D;QAE9D,MAAM,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC;QAE7B,MAAM,cAAc,GAAG,IAAI,aAAW,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC;QACpE,KAAK,MAAM,GAAG,IAAI,WAAW,CAAC,oBAAoB,EAAE,CAAC;YACnD,cAAc,CAAC,oBAAoB,CAAC,GAAG,CAAC,GAAG,EAAE,WAAW,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC,CAAC;QACtF,CAAC;QACD,OAAO,cAAc,CAAC;IACxB,CAAC;CACF,CAAA;AA3CU;IADR,QAAQ,CAAC,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,6BAA6B,EAAE,EAAE,CAAC;;oDAC5D;AAWxB;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;yDAA6B;AAnBpD,WAAW;IADvB,KAAK,EAAE;;GACK,WAAW,CAmDvB"}