@quadnix/octo 0.0.29 → 0.1.0

package/dist/models/account/account.model.js

@@ -15,14 +15,40 @@ import { AModel } from '../model.abstract.js';
 import { Region } from '../region/region.model.js';
 import { AccountSchema, AccountType } from './account.schema.js';
 /**
+ * An Account model is the cloud provider account the infrastructure below it is deployed into.
+ * It sits between the {@link App} and its {@link Region}s, so one app can span several accounts -
+ * e.g. a separate account per environment, or per cloud provider.
+ *
+ * Credentials are not held here. A module such as `AwsIniAccountModule` extends this model and
+ * supplies them through {@link Account.getCredentials}.
+ *
+ * @example
+ * ```ts
+ * const account = new Account(AccountType.AWS, '1234567890');
+ * app.addAccount(account);
+ * ```
+ *
  * @group Models/Account
+ *
+ * @see Definition of [Default Models](/docs/fundamentals/models#default-models).
  */
 let Account = Account_1 = class Account extends AModel {
+    /**
+     * @param accountType The cloud provider this account belongs to.
+     * @param accountId The provider's own identifier for the account.
+     */
     constructor(accountType, accountId) {
         super();
         this.accountId = accountId;
         this.accountType = accountType;
     }
+    /**
+     * @internal
+     */
+    static async unSynth(account, deReferenceContext) {
+        assert(!!deReferenceContext);
+        return new Account_1(account.accountType, account.accountId);
+    }
     /**
      * To add a {@link Region}.
      */
@@ -37,13 +63,20 @@ let Account = Account_1 = class Account extends AModel {
         }
         this.addChild('accountId', region, 'regionId');
     }
-    isAwsCredentials(credentials) {
-        return (Object.prototype.hasOwnProperty.call(credentials, 'accessKeyId') &&
-            Object.prototype.hasOwnProperty.call(credentials, 'secretAccessKey'));
-    }
+    /**
+     * The credentials this account authenticates with, for the paths octo drives itself rather than
+     * through a provider - an external resource's actions, most of all. The shape is the provider's
+     * own; octo only carries it from the model to whatever builds the client.
+     *
+     * @throws {@link ModelError} On the base model, which holds no credentials. Override it in the
+     * subclass a module creates.
+     */
     getCredentials() {
         throw new ModelError('Method not implemented! Use subclass', this);
     }
+    /**
+     * @internal
+     */
     setContext() {
         const parents = this.getParents();
         const app = parents['app']?.[0]?.to;
@@ -52,16 +85,15 @@ let Account = Account_1 = class Account extends AModel {
         }
         return [`${this.constructor.NODE_NAME}=${this.accountId}`, app.getContext()].join(',');
     }
+    /**
+     * @internal
+     */
     synth() {
         return {
             accountId: this.accountId,
             accountType: this.accountType,
         };
     }
-    static async unSynth(account, deReferenceContext) {
-        assert(!!deReferenceContext);
-        return new Account_1(account.accountType, account.accountId);
-    }
 };
 Account = Account_1 = __decorate([
     Model('@octo', 'account', AccountSchema),

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

@@ -1 +1 @@
-{"version":3,"file":"account.model.js","sourceRoot":"","sources":["../../../src/models/account/account.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,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAQjE;;GAEG;AAEI,IAAM,OAAO,eAAb,MAAM,OAAQ,SAAQ,MAA8B;IAKzD,YAAY,WAAwB,EAAE,SAAiB;QACrD,KAAK,EAAE,CAAC;QAER,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;IACjC,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,UAAU,CAAC,wBAAwB,EAAE,IAAI,CAAC,CAAC;QACvD,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;IACjD,CAAC;IAED,gBAAgB,CAAC,WAAkD;QACjE,OAAO,CACL,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE,aAAa,CAAC;YAChE,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE,iBAAiB,CAAC,CACrE,CAAC;IACJ,CAAC;IAED,cAAc;QACZ,MAAM,IAAI,UAAU,CAAC,sCAAsC,EAAE,IAAI,CAAC,CAAC;IACrE,CAAC;IAEQ,UAAU;QACjB,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAClC,MAAM,GAAG,GAAG,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QACpC,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,CAAC,GAAI,IAAI,CAAC,WAA8B,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,EAAE,EAAE,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC7G,CAAC;IAEQ,KAAK;QACZ,OAAO;YACL,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,WAAW,EAAE,IAAI,CAAC,WAAW;SAC9B,CAAC;IACJ,CAAC;IAED,MAAM,CAAU,KAAK,CAAC,OAAO,CAC3B,OAAsB,EACtB,kBAA8D;QAE9D,MAAM,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC;QAE7B,OAAO,IAAI,SAAO,CAAC,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;IAC7D,CAAC;CACF,CAAA;AA9DY,OAAO;IADnB,KAAK,CAAU,OAAO,EAAE,SAAS,EAAE,aAAa,CAAC;;GACrC,OAAO,CA8DnB"}
+{"version":3,"file":"account.model.js","sourceRoot":"","sources":["../../../src/models/account/account.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,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAEjE;;;;;;;;;;;;;;;;;GAiBG;AAEI,IAAM,OAAO,eAAb,MAAM,OAAQ,SAAQ,MAA8B;IAKzD;;;OAGG;IACH,YAAY,WAAwB,EAAE,SAAiB;QACrD,KAAK,EAAE,CAAC;QAER,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,MAAM,CAAU,KAAK,CAAC,OAAO,CAC3B,OAAsB,EACtB,kBAA8D;QAE9D,MAAM,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC;QAE7B,OAAO,IAAI,SAAO,CAAC,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;IAC7D,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,UAAU,CAAC,wBAAwB,EAAE,IAAI,CAAC,CAAC;QACvD,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;;OAOG;IACH,cAAc;QACZ,MAAM,IAAI,UAAU,CAAC,sCAAsC,EAAE,IAAI,CAAC,CAAC;IACrE,CAAC;IAED;;OAEG;IACM,UAAU;QACjB,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAClC,MAAM,GAAG,GAAG,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QACpC,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,CAAC,GAAI,IAAI,CAAC,WAA8B,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,EAAE,EAAE,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC7G,CAAC;IAED;;OAEG;IACM,KAAK;QACZ,OAAO;YACL,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,WAAW,EAAE,IAAI,CAAC,WAAW;SAC9B,CAAC;IACJ,CAAC;CACF,CAAA;AA5EY,OAAO;IADnB,KAAK,CAAU,OAAO,EAAE,SAAS,EAAE,aAAa,CAAC;;GACrC,OAAO,CA4EnB"}

package/dist/models/account/account.schema.d.ts

@@ -1,13 +1,25 @@
 /**
+ * The cloud provider an {@link Account} belongs to.
+ *
  * @group Models/Account
  */
 export declare enum AccountType {
-    AWS = "aws"
+    AWS = "aws",
+    Azure = "azure",
+    GCP = "gcp"
 }
 /**
+ * Schema of the {@link Account} model.
+ *
  * @group Models/Account
  */
 export declare class AccountSchema {
+    /**
+     * The provider's own identifier for the account, e.g. an AWS account number.
+     */
     accountId: string;
+    /**
+     * The cloud provider this account belongs to.
+     */
     accountType: AccountType;
 }

package/dist/models/account/account.schema.js

@@ -1,17 +1,29 @@
 import { Schema } from '../../functions/schema/schema.js';
 /**
+ * The cloud provider an {@link Account} belongs to.
+ *
  * @group Models/Account
  */
 export var AccountType;
 (function (AccountType) {
     AccountType["AWS"] = "aws";
+    AccountType["Azure"] = "azure";
+    AccountType["GCP"] = "gcp";
 })(AccountType || (AccountType = {}));
 /**
+ * Schema of the {@link Account} model.
+ *
  * @group Models/Account
  */
 export class AccountSchema {
     constructor() {
+        /**
+         * The provider's own identifier for the account, e.g. an AWS account number.
+         */
         this.accountId = Schema();
+        /**
+         * The cloud provider this account belongs to.
+         */
         this.accountType = Schema();
     }
 }

package/dist/models/account/account.schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"account.schema.js","sourceRoot":"","sources":["../../../src/models/account/account.schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAC;AAE1D;;GAEG;AACH,MAAM,CAAN,IAAY,WAEX;AAFD,WAAY,WAAW;IACrB,0BAAW,CAAA;AACb,CAAC,EAFW,WAAW,KAAX,WAAW,QAEtB;AAED;;GAEG;AACH,MAAM,OAAO,aAAa;IAA1B;QACE,cAAS,GAAG,MAAM,EAAU,CAAC;QAE7B,gBAAW,GAAG,MAAM,EAAe,CAAC;IACtC,CAAC;CAAA"}
+{"version":3,"file":"account.schema.js","sourceRoot":"","sources":["../../../src/models/account/account.schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAC;AAE1D;;;;GAIG;AACH,MAAM,CAAN,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,0BAAW,CAAA;IACX,8BAAe,CAAA;IACf,0BAAW,CAAA;AACb,CAAC,EAJW,WAAW,KAAX,WAAW,QAItB;AAED;;;;GAIG;AACH,MAAM,OAAO,aAAa;IAA1B;QACE;;WAEG;QACH,cAAS,GAAG,MAAM,EAAU,CAAC;QAE7B;;WAEG;QACH,gBAAW,GAAG,MAAM,EAAe,CAAC;IACtC,CAAC;CAAA"}

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

@@ -21,7 +21,17 @@ import { AppSchema } from './app.schema.js';
  */
 export declare class App extends AModel<AppSchema, App> {
     readonly name: string;
+    /**
+     * @param name The name of the app.
+     */
     constructor(name: string);
+    /**
+     * @internal
+     */
+    static unSynth(app: AppSchema, deReferenceContext: (context: string) => Promise<UnknownModel>): Promise<App>;
+    /**
+     * To add an {@link Account}.
+     */
     addAccount(account: Account): void;
     /**
      * To add an {@link Image}.
@@ -39,7 +49,12 @@ export declare class App extends AModel<AppSchema, App> {
      * To add a {@link Service}.
      */
     addService(service: Service): void;
+    /**
+     * @internal
+     */
     setContext(): string;
+    /**
+     * @internal
+     */
     synth(): AppSchema;
-    static unSynth(app: AppSchema, deReferenceContext: (context: string) => Promise<UnknownModel>): Promise<App>;
 }

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

@@ -32,10 +32,23 @@ import { AppSchema } from './app.schema.js';
  * @see Definition of [Default Models](/docs/fundamentals/models#default-models).
  */
 let App = App_1 = class App extends AModel {
+    /**
+     * @param name The name of the app.
+     */
     constructor(name) {
         super();
         this.name = name;
     }
+    /**
+     * @internal
+     */
+    static async unSynth(app, deReferenceContext) {
+        assert(!!deReferenceContext);
+        return new App_1(app.name);
+    }
+    /**
+     * To add an {@link Account}.
+     */
     addAccount(account) {
         const childrenDependencies = this.getChildren('account');
         if (!childrenDependencies['account'])
@@ -103,18 +116,20 @@ let App = App_1 = class App extends AModel {
         }
         this.addChild('name', service, 'serviceId');
     }
+    /**
+     * @internal
+     */
     setContext() {
         return `${this.constructor.NODE_NAME}=${this.name}`;
     }
+    /**
+     * @internal
+     */
     synth() {
         return {
             name: this.name,
         };
     }
-    static async unSynth(app, deReferenceContext) {
-        assert(!!deReferenceContext);
-        return new App_1(app.name);
-    }
 };
 App = App_1 = __decorate([
     Model('@octo', 'app', AppSchema),

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":";;;;;;;;;;AAAA,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,QAAQ,CAAC;AAE1C,OAAO,EAAE,KAAK,EAAE,MAAM,qCAAqC,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AACtD,OAAO,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAC;AAChD,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AACzD,OAAO,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAC;AACnD,OAAO,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AACtD,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C;;;;;;;;;;;;GAYG;AAEI,IAAM,GAAG,WAAT,MAAM,GAAI,SAAQ,MAAsB;IAG7C,YAAY,IAAY;QACtB,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,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;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,UAAU,CAAC,yBAAyB,EAAE,IAAI,CAAC,CAAC;QACxD,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;IAC9C,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,UAAU,CAAC,uBAAuB,EAAE,IAAI,CAAC,CAAC;QACtD,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,UAAU,CAAC,0BAA0B,EAAE,IAAI,CAAC,CAAC;QACzD,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,SAAS,KAAK,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;YAClE,MAAM,IAAI,UAAU,CAAC,wBAAwB,EAAE,IAAI,CAAC,CAAC;QACvD,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,UAAU,CAAC,yBAAyB,EAAE,IAAI,CAAC,CAAC;QACxD,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;IAC9C,CAAC;IAEQ,UAAU;QACjB,OAAO,GAAI,IAAI,CAAC,WAA0B,CAAC,SAAS,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;IACtE,CAAC;IAEQ,KAAK;QACZ,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;SAChB,CAAC;IACJ,CAAC;IAED,MAAM,CAAU,KAAK,CAAC,OAAO,CAC3B,GAAc,EACd,kBAA8D;QAE9D,MAAM,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC;QAE7B,OAAO,IAAI,KAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC;CACF,CAAA;AAlGY,GAAG;IADf,KAAK,CAAM,OAAO,EAAE,KAAK,EAAE,SAAS,CAAC;;GACzB,GAAG,CAkGf"}
+{"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,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AACtD,OAAO,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAC;AAChD,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AACzD,OAAO,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAC;AACnD,OAAO,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AACtD,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C;;;;;;;;;;;;GAYG;AAEI,IAAM,GAAG,WAAT,MAAM,GAAI,SAAQ,MAAsB;IAG7C;;OAEG;IACH,YAAY,IAAY;QACtB,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED;;OAEG;IACH,MAAM,CAAU,KAAK,CAAC,OAAO,CAC3B,GAAc,EACd,kBAA8D;QAE9D,MAAM,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC;QAE7B,OAAO,IAAI,KAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC3B,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,UAAU,CAAC,yBAAyB,EAAE,IAAI,CAAC,CAAC;QACxD,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;IAC9C,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,UAAU,CAAC,uBAAuB,EAAE,IAAI,CAAC,CAAC;QACtD,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,UAAU,CAAC,0BAA0B,EAAE,IAAI,CAAC,CAAC;QACzD,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,SAAS,KAAK,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;YAClE,MAAM,IAAI,UAAU,CAAC,wBAAwB,EAAE,IAAI,CAAC,CAAC;QACvD,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,UAAU,CAAC,yBAAyB,EAAE,IAAI,CAAC,CAAC;QACxD,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;IAC9C,CAAC;IAED;;OAEG;IACM,UAAU;QACjB,OAAO,GAAI,IAAI,CAAC,WAA0B,CAAC,SAAS,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;IACtE,CAAC;IAED;;OAEG;IACM,KAAK;QACZ,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;SAChB,CAAC;IACJ,CAAC;CACF,CAAA;AAjHY,GAAG;IADf,KAAK,CAAM,OAAO,EAAE,KAAK,EAAE,SAAS,CAAC;;GACzB,GAAG,CAiHf"}

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

@@ -1,6 +1,12 @@
 /**
+ * Schema of the {@link App} model.
+ *
  * @group Models/App
  */
 export declare class AppSchema {
+    /**
+     * The name of the app. It is the root of every other node's context, so renaming it re-creates
+     * the entire infrastructure.
+     */
     name: string;
 }

package/dist/models/app/app.schema.js

@@ -10,10 +10,16 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 import { Validate } from '../../decorators/validate.decorator.js';
 import { Schema } from '../../functions/schema/schema.js';
 /**
+ * Schema of the {@link App} model.
+ *
  * @group Models/App
  */
 export class AppSchema {
     constructor() {
+        /**
+         * The name of the app. It is the root of every other node's context, so renaming it re-creates
+         * the entire infrastructure.
+         */
         this.name = Schema();
     }
 }

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

@@ -1 +1 @@
-{"version":3,"file":"app.schema.js","sourceRoot":"","sources":["../../../src/models/app/app.schema.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,wCAAwC,CAAC;AAClE,OAAO,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAC;AAE1D;;GAEG;AACH,MAAM,OAAO,SAAS;IAAtB;QAEE,SAAI,GAAG,MAAM,EAAU,CAAC;IAC1B,CAAC;CAAA;AADC;IADC,QAAQ,CAAC,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,6BAA6B,EAAE,EAAE,CAAC;;uCACrE"}
+{"version":3,"file":"app.schema.js","sourceRoot":"","sources":["../../../src/models/app/app.schema.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,wCAAwC,CAAC;AAClE,OAAO,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAC;AAE1D;;;;GAIG;AACH,MAAM,OAAO,SAAS;IAAtB;QACE;;;WAGG;QAEH,SAAI,GAAG,MAAM,EAAU,CAAC;IAC1B,CAAC;CAAA;AADC;IADC,QAAQ,CAAC,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,6BAA6B,EAAE,EAAE,CAAC;;uCACrE"}

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

@@ -16,8 +16,20 @@ import { DeploymentSchema } from './deployment.schema.js';
  */
 export declare class Deployment extends AModel<DeploymentSchema, Deployment> {
     readonly deploymentTag: string;
+    /**
+     * @param deploymentTag The tag identifying the server's code at this point in time.
+     */
     constructor(deploymentTag: string);
+    /**
+     * @internal
+     */
+    static unSynth(deployment: DeploymentSchema, deReferenceContext: (context: string) => Promise<UnknownModel>): Promise<Deployment>;
+    /**
+     * @internal
+     */
     setContext(): string | undefined;
+    /**
+     * @internal
+     */
     synth(): DeploymentSchema;
-    static unSynth(deployment: DeploymentSchema, deReferenceContext: (context: string) => Promise<UnknownModel>): Promise<Deployment>;
 }

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

@@ -26,10 +26,23 @@ import { DeploymentSchema } from './deployment.schema.js';
  * @see Definition of [Default Models](/docs/fundamentals/models#default-models).
  */
 let Deployment = Deployment_1 = class Deployment extends AModel {
+    /**
+     * @param deploymentTag The tag identifying the server's code at this point in time.
+     */
     constructor(deploymentTag) {
         super();
         this.deploymentTag = deploymentTag;
     }
+    /**
+     * @internal
+     */
+    static async unSynth(deployment, deReferenceContext) {
+        assert(!!deReferenceContext);
+        return new Deployment_1(deployment.deploymentTag);
+    }
+    /**
+     * @internal
+     */
     setContext() {
         const parents = this.getParents();
         const parent = parents['server']?.[0]?.to;
@@ -38,15 +51,14 @@ let Deployment = Deployment_1 = class Deployment extends AModel {
         }
         return [`${this.constructor.NODE_NAME}=${this.deploymentTag}`, parent.getContext()].join(',');
     }
+    /**
+     * @internal
+     */
     synth() {
         return {
             deploymentTag: this.deploymentTag,
         };
     }
-    static async unSynth(deployment, deReferenceContext) {
-        assert(!!deReferenceContext);
-        return new Deployment_1(deployment.deploymentTag);
-    }
 };
 Deployment = Deployment_1 = __decorate([
     Model('@octo', 'deployment', DeploymentSchema),

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":";;;;;;;;;;AAAA,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,QAAQ,CAAC;AAE1C,OAAO,EAAE,KAAK,EAAE,MAAM,qCAAqC,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE1D;;;;;;;;;;;;GAYG;AAEI,IAAM,UAAU,kBAAhB,MAAM,UAAW,SAAQ,MAAoC;IAGlE,YAAY,aAAqB;QAC/B,KAAK,EAAE,CAAC;QACR,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,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QAC1C,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,CAAC,GAAI,IAAI,CAAC,WAAiC,CAAC,SAAS,IAAI,IAAI,CAAC,aAAa,EAAE,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAC7G,GAAG,CACJ,CAAC;IACJ,CAAC;IAEQ,KAAK;QACZ,OAAO;YACL,aAAa,EAAE,IAAI,CAAC,aAAa;SAClC,CAAC;IACJ,CAAC;IAED,MAAM,CAAU,KAAK,CAAC,OAAO,CAC3B,UAA4B,EAC5B,kBAA8D;QAE9D,MAAM,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC;QAE7B,OAAO,IAAI,YAAU,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IAClD,CAAC;CACF,CAAA;AAjCY,UAAU;IADtB,KAAK,CAAa,OAAO,EAAE,YAAY,EAAE,gBAAgB,CAAC;;GAC9C,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,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE1D;;;;;;;;;;;;GAYG;AAEI,IAAM,UAAU,kBAAhB,MAAM,UAAW,SAAQ,MAAoC;IAGlE;;OAEG;IACH,YAAY,aAAqB;QAC/B,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;IACrC,CAAC;IAED;;OAEG;IACH,MAAM,CAAU,KAAK,CAAC,OAAO,CAC3B,UAA4B,EAC5B,kBAA8D;QAE9D,MAAM,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC;QAE7B,OAAO,IAAI,YAAU,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IAClD,CAAC;IAED;;OAEG;IACM,UAAU;QACjB,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAClC,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QAC1C,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,CAAC,GAAI,IAAI,CAAC,WAAiC,CAAC,SAAS,IAAI,IAAI,CAAC,aAAa,EAAE,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAC7G,GAAG,CACJ,CAAC;IACJ,CAAC;IAED;;OAEG;IACM,KAAK;QACZ,OAAO;YACL,aAAa,EAAE,IAAI,CAAC,aAAa;SAClC,CAAC;IACJ,CAAC;CACF,CAAA;AA7CY,UAAU;IADtB,KAAK,CAAa,OAAO,EAAE,YAAY,EAAE,gBAAgB,CAAC;;GAC9C,UAAU,CA6CtB"}

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

@@ -1,4 +1,6 @@
 /**
+ * Schema of the {@link Deployment} model.
+ *
  * @group Models/Deployment
  */
 export declare class DeploymentSchema {

package/dist/models/deployment/deployment.schema.js

@@ -10,6 +10,8 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 import { Validate } from '../../decorators/validate.decorator.js';
 import { Schema } from '../../functions/schema/schema.js';
 /**
+ * Schema of the {@link Deployment} model.
+ *
  * @group Models/Deployment
  */
 export class DeploymentSchema {

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

@@ -1 +1 @@
-{"version":3,"file":"deployment.schema.js","sourceRoot":"","sources":["../../../src/models/deployment/deployment.schema.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,wCAAwC,CAAC;AAClE,OAAO,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAC;AAE1D;;GAEG;AACH,MAAM,OAAO,gBAAgB;IAA7B;QACE;;;WAGG;QAEH,kBAAa,GAAG,MAAM,EAAU,CAAC;IACnC,CAAC;CAAA;AADC;IADC,QAAQ,CAAC,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,gCAAgC,EAAE,EAAE,CAAC;;uDAC/D"}
+{"version":3,"file":"deployment.schema.js","sourceRoot":"","sources":["../../../src/models/deployment/deployment.schema.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,wCAAwC,CAAC;AAClE,OAAO,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAC;AAE1D;;;;GAIG;AACH,MAAM,OAAO,gBAAgB;IAA7B;QACE;;;WAGG;QAEH,kBAAa,GAAG,MAAM,EAAU,CAAC;IACnC,CAAC;CAAA;AADC;IADC,QAAQ,CAAC,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,gCAAgC,EAAE,EAAE,CAAC;;uDAC/D"}

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

@@ -17,8 +17,20 @@ import { EnvironmentSchema } from './environment.schema.js';
 export declare class Environment extends AModel<EnvironmentSchema, Environment> {
     readonly environmentName: string;
     readonly environmentVariables: Map<string, string>;
+    /**
+     * @param environmentName The name of the environment, unique within its region.
+     */
     constructor(environmentName: string);
+    /**
+     * @internal
+     */
+    static unSynth(environment: EnvironmentSchema, deReferenceContext: (context: string) => Promise<UnknownModel>): Promise<Environment>;
+    /**
+     * @internal
+     */
     setContext(): string | undefined;
+    /**
+     * @internal
+     */
     synth(): EnvironmentSchema;
-    static unSynth(environment: EnvironmentSchema, deReferenceContext: (context: string) => Promise<UnknownModel>): Promise<Environment>;
 }

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

@@ -26,11 +26,28 @@ import { EnvironmentSchema } from './environment.schema.js';
  * @see Definition of [Default Models](/docs/fundamentals/models#default-models).
  */
 let Environment = Environment_1 = class Environment extends AModel {
+    /**
+     * @param environmentName The name of the environment, unique within its region.
+     */
     constructor(environmentName) {
         super();
         this.environmentVariables = new Map();
         this.environmentName = environmentName;
     }
+    /**
+     * @internal
+     */
+    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]);
+        }
+        return newEnvironment;
+    }
+    /**
+     * @internal
+     */
     setContext() {
         const parents = this.getParents();
         const region = parents['region']?.[0]?.to;
@@ -39,20 +56,15 @@ let Environment = Environment_1 = class Environment extends AModel {
         }
         return [`${this.constructor.NODE_NAME}=${this.environmentName}`, region.getContext()].join(',');
     }
+    /**
+     * @internal
+     */
     synth() {
         return {
             environmentName: this.environmentName,
             environmentVariables: Object.fromEntries(this.environmentVariables || new Map()),
         };
     }
-    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]);
-        }
-        return newEnvironment;
-    }
 };
 Environment = Environment_1 = __decorate([
     Model('@octo', 'environment', EnvironmentSchema),

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":";;;;;;;;;;AAAA,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,QAAQ,CAAC;AAE1C,OAAO,EAAE,KAAK,EAAE,MAAM,qCAAqC,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAC9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAE5D;;;;;;;;;;;;GAYG;AAEI,IAAM,WAAW,mBAAjB,MAAM,WAAY,SAAQ,MAAsC;IAKrE,YAAY,eAAuB;QACjC,KAAK,EAAE,CAAC;QAHD,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,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QAC1C,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,CAAC,GAAI,IAAI,CAAC,WAAkC,CAAC,SAAS,IAAI,IAAI,CAAC,eAAe,EAAE,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAChH,GAAG,CACJ,CAAC;IACJ,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,WAA8B,EAC9B,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;AAxCY,WAAW;IADvB,KAAK,CAAc,OAAO,EAAE,aAAa,EAAE,iBAAiB,CAAC;;GACjD,WAAW,CAwCvB"}
+{"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,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAC9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAE5D;;;;;;;;;;;;GAYG;AAEI,IAAM,WAAW,mBAAjB,MAAM,WAAY,SAAQ,MAAsC;IAKrE;;OAEG;IACH,YAAY,eAAuB;QACjC,KAAK,EAAE,CAAC;QAND,yBAAoB,GAAwB,IAAI,GAAG,EAAE,CAAC;QAO7D,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;IACzC,CAAC;IAED;;OAEG;IACH,MAAM,CAAU,KAAK,CAAC,OAAO,CAC3B,WAA8B,EAC9B,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;IAED;;OAEG;IACM,UAAU;QACjB,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAClC,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QAC1C,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,CAAC,GAAI,IAAI,CAAC,WAAkC,CAAC,SAAS,IAAI,IAAI,CAAC,eAAe,EAAE,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAChH,GAAG,CACJ,CAAC;IACJ,CAAC;IAED;;OAEG;IACM,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;CACF,CAAA;AApDY,WAAW;IADvB,KAAK,CAAc,OAAO,EAAE,aAAa,EAAE,iBAAiB,CAAC;;GACjD,WAAW,CAoDvB"}

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

@@ -1,4 +1,6 @@
 /**
+ * Schema of the {@link Environment} model.
+ *
  * @group Models/Environment
  */
 export declare class EnvironmentSchema {

package/dist/models/environment/environment.schema.js

@@ -10,6 +10,8 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 import { Validate } from '../../decorators/validate.decorator.js';
 import { Schema } from '../../functions/schema/schema.js';
 /**
+ * Schema of the {@link Environment} model.
+ *
  * @group Models/Environment
  */
 export class EnvironmentSchema {

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

@@ -1 +1 @@
-{"version":3,"file":"environment.schema.js","sourceRoot":"","sources":["../../../src/models/environment/environment.schema.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,wCAAwC,CAAC;AAClE,OAAO,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAC;AAE1D;;GAEG;AACH,MAAM,OAAO,iBAAiB;IAA9B;QACE;;;WAGG;QAEH,oBAAe,GAAG,MAAM,EAAU,CAAC;QAEnC;;WAEG;QAOH,yBAAoB,GAAG,MAAM,EAA6B,CAAC;IAC7D,CAAC;CAAA;AAZC;IADC,QAAQ,CAAC,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,6BAA6B,EAAE,EAAE,CAAC;;0DAC1D;AAWnC;IANC,QAAQ,CAAC;QACR,QAAQ,EAAE,CAAC,KAAgC,EAAY,EAAE;YACvD,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC5B,CAAC;QACD,OAAO,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,6BAA6B,EAAE;KAC/E,CAAC;;+DACyD"}
+{"version":3,"file":"environment.schema.js","sourceRoot":"","sources":["../../../src/models/environment/environment.schema.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,wCAAwC,CAAC;AAClE,OAAO,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAC;AAE1D;;;;GAIG;AACH,MAAM,OAAO,iBAAiB;IAA9B;QACE;;;WAGG;QAEH,oBAAe,GAAG,MAAM,EAAU,CAAC;QAEnC;;WAEG;QAOH,yBAAoB,GAAG,MAAM,EAA6B,CAAC;IAC7D,CAAC;CAAA;AAZC;IADC,QAAQ,CAAC,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,6BAA6B,EAAE,EAAE,CAAC;;0DAC1D;AAWnC;IANC,QAAQ,CAAC;QACR,QAAQ,EAAE,CAAC,KAAgC,EAAY,EAAE;YACvD,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC5B,CAAC;QACD,OAAO,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,6BAA6B,EAAE;KAC/E,CAAC;;+DACyD"}

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

@@ -22,13 +22,31 @@ import { ExecutionSchema } from './execution.schema.js';
  */
 export declare class Execution extends AModel<ExecutionSchema, Execution> {
     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;
+    /**
+     * All three parents claim the new execution as their child, so the graph is complete on construction.
+     *
+     * @param deployment The deployment whose code this execution runs.
+     * @param environment The environment this execution runs in.
+     * @param subnet The subnet this execution is placed in.
+     * @throws {@link ModelError} If the environment and subnet are in different regions, or an
+     * identical execution already exists.
+     */
+    constructor(deployment: Deployment, environment: Environment, subnet: Subnet);
+    /**
+     * @internal
+     */
+    static unSynth(execution: ExecutionSchema, deReferenceContext: (context: string) => Promise<UnknownModel>): Promise<Execution>;
+    /**
+     * @internal
+     */
     setContext(): string | undefined;
+    /**
+     * @internal
+     */
     synth(): ExecutionSchema;
-    static unSynth(execution: ExecutionSchema, deReferenceContext: (context: string) => Promise<UnknownModel>): Promise<Execution>;
 }

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

@@ -35,6 +35,34 @@ import { ExecutionSchema } from './execution.schema.js';
  * @see Definition of [Default Models](/docs/fundamentals/models#default-models).
  */
 let Execution = Execution_1 = class Execution extends AModel {
+    /**
+     * 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;
+        const server = deployment.getParents()['server'][0].to;
+        const environment = parents['environment'][0].to;
+        const region = environment.getParents()['region'][0].to;
+        const subnet = parents['subnet'][0].to;
+        return [
+            server.serverKey,
+            deployment.deploymentTag,
+            region.regionId,
+            environment.environmentName,
+            subnet.subnetName,
+        ].join('-');
+    }
+    /**
+     * All three parents claim the new execution as their child, so the graph is complete on construction.
+     *
+     * @param deployment The deployment whose code this execution runs.
+     * @param environment The environment this execution runs in.
+     * @param subnet The subnet this execution is placed in.
+     * @throws {@link ModelError} If the environment and subnet are in different regions, or an
+     * identical execution already exists.
+     */
     constructor(deployment, environment, subnet) {
         super();
         this.environmentVariables = new Map();
@@ -62,24 +90,23 @@ let Execution = Execution_1 = class Execution extends AModel {
         subnet.addChild('subnetId', this, 'executionId');
     }
     /**
-     * An `executionId` is a unique identifier for this execution.
-     * - Format of executionId is `{serverKey}-{deploymentTag}-{regionId}-{environmentName}-{subnetName}`
+     * @internal
      */
-    get executionId() {
-        const parents = this.getParents();
-        const deployment = parents['deployment'][0].to;
-        const server = deployment.getParents()['server'][0].to;
-        const environment = parents['environment'][0].to;
-        const region = environment.getParents()['region'][0].to;
-        const subnet = parents['subnet'][0].to;
-        return [
-            server.serverKey,
-            deployment.deploymentTag,
-            region.regionId,
-            environment.environmentName,
-            subnet.subnetName,
-        ].join('-');
+    static async unSynth(execution, deReferenceContext) {
+        const [deployment, environment, subnet] = (await Promise.all([
+            deReferenceContext(execution.deployment.context),
+            deReferenceContext(execution.environment.context),
+            deReferenceContext(execution.subnet.context),
+        ]));
+        const newExecution = new Execution_1(deployment, environment, subnet);
+        for (const [key, value] of Object.entries(execution.environmentVariables)) {
+            newExecution.environmentVariables.set(key, value);
+        }
+        return newExecution;
     }
+    /**
+     * @internal
+     */
     setContext() {
         const parents = this.getParents();
         const deployment = parents['deployment']?.[0]?.to;
@@ -95,6 +122,9 @@ let Execution = Execution_1 = class Execution extends AModel {
             subnet.getContext(),
         ].join(',');
     }
+    /**
+     * @internal
+     */
     synth() {
         const parents = this.getParents();
         const deployment = parents['deployment'][0]['to'];
@@ -107,18 +137,6 @@ let Execution = Execution_1 = class Execution extends AModel {
             subnet: { context: subnet.getContext() },
         };
     }
-    static async unSynth(execution, deReferenceContext) {
-        const [deployment, environment, subnet] = (await Promise.all([
-            deReferenceContext(execution.deployment.context),
-            deReferenceContext(execution.environment.context),
-            deReferenceContext(execution.subnet.context),
-        ]));
-        const newExecution = new Execution_1(deployment, environment, subnet);
-        for (const [key, value] of Object.entries(execution.environmentVariables)) {
-            newExecution.environmentVariables.set(key, value);
-        }
-        return newExecution;
-    }
 };
 Execution = Execution_1 = __decorate([
     Model('@octo', 'execution', ExecutionSchema),