@quadnix/octo 0.0.30 → 0.1.0

package/dist/models/server/server.schema.js

@@ -10,12 +10,14 @@ 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 Server} model.
+ *
  * @group Models/Server
  */
 export class ServerSchema {
     constructor() {
         /**
-         * The name of the server.
+         * The name of the server, unique within the {@link App}.
          */
         this.serverKey = Schema();
     }

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

@@ -1 +1 @@
-{"version":3,"file":"server.schema.js","sourceRoot":"","sources":["../../../src/models/server/server.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,YAAY;IAAzB;QACE;;WAEG;QAEH,cAAS,GAAG,MAAM,EAAU,CAAC;IAC/B,CAAC;CAAA;AADC;IADC,QAAQ,CAAC,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,6BAA6B,EAAE,EAAE,CAAC;;+CAChE"}
+{"version":3,"file":"server.schema.js","sourceRoot":"","sources":["../../../src/models/server/server.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,YAAY;IAAzB;QACE;;WAEG;QAEH,cAAS,GAAG,MAAM,EAAU,CAAC;IAC/B,CAAC;CAAA;AADC;IADC,QAAQ,CAAC,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,6BAA6B,EAAE,EAAE,CAAC;;+CAChE"}

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

@@ -5,9 +5,14 @@ import { ServiceSchema } from './service.schema.js';
  * 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.
  *
+ * `Service` carries nothing but an ID, so it is only useful when extended - a subclass adds the fields
+ * the third-party service actually needs, and overrides `synth()`. Calling `synth()` on `Service`
+ * itself throws.
+ *
  * @example
  * ```ts
- * const service = new Service('MyService');
+ * @Model<MyService>('@example', 'service', MyServiceSchema)
+ * export class MyService extends Service { ... }
  * ```
  *
  * @group Models/Service
@@ -16,7 +21,16 @@ import { ServiceSchema } from './service.schema.js';
  */
 export declare class Service extends AModel<ServiceSchema, Service> {
     readonly serviceId: string;
+    /**
+     * @param serviceId The ID of the service, unique within the app.
+     */
     constructor(serviceId: string);
+    /**
+     * @internal
+     */
     setContext(): string | undefined;
+    /**
+     * @internal
+     */
     synth(): ServiceSchema;
 }

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

@@ -17,9 +17,14 @@ import { ServiceSchema } from './service.schema.js';
  * 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.
  *
+ * `Service` carries nothing but an ID, so it is only useful when extended - a subclass adds the fields
+ * the third-party service actually needs, and overrides `synth()`. Calling `synth()` on `Service`
+ * itself throws.
+ *
  * @example
  * ```ts
- * const service = new Service('MyService');
+ * @Model<MyService>('@example', 'service', MyServiceSchema)
+ * export class MyService extends Service { ... }
  * ```
  *
  * @group Models/Service
@@ -27,10 +32,16 @@ import { ServiceSchema } from './service.schema.js';
  * @see Definition of [Default Models](/docs/fundamentals/models#default-models).
  */
 let Service = Service_1 = class Service extends AModel {
+    /**
+     * @param serviceId The ID of the service, unique within the app.
+     */
     constructor(serviceId) {
         super();
         this.serviceId = serviceId;
     }
+    /**
+     * @internal
+     */
     setContext() {
         const parents = this.getParents();
         const app = parents['app']?.[0]?.to;
@@ -39,6 +50,9 @@ let Service = Service_1 = class Service extends AModel {
         }
         return [`${this.constructor.NODE_NAME}=${this.serviceId}`, app.getContext()].join(',');
     }
+    /**
+     * @internal
+     */
     synth() {
         throw new ModelError('Method not implemented! Use subclass', this);
     }

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;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpD;;;;;;;;;;;;;GAaG;AAEI,IAAM,OAAO,eAAb,MAAM,OAAQ,SAAQ,MAA8B;IAGzD,YAAY,SAAiB;QAC3B,KAAK,EAAE,CAAC;QACR,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,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,MAAM,IAAI,UAAU,CAAC,sCAAsC,EAAE,IAAI,CAAC,CAAC;IACrE,CAAC;CACF,CAAA;AApBY,OAAO;IADnB,KAAK,CAAU,OAAO,EAAE,SAAS,EAAE,aAAa,CAAC;;GACrC,OAAO,CAoBnB"}
+{"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,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpD;;;;;;;;;;;;;;;;;;GAkBG;AAEI,IAAM,OAAO,eAAb,MAAM,OAAQ,SAAQ,MAA8B;IAGzD;;OAEG;IACH,YAAY,SAAiB;QAC3B,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,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,MAAM,IAAI,UAAU,CAAC,sCAAsC,EAAE,IAAI,CAAC,CAAC;IACrE,CAAC;CACF,CAAA;AA7BY,OAAO;IADnB,KAAK,CAAU,OAAO,EAAE,SAAS,EAAE,aAAa,CAAC;;GACrC,OAAO,CA6BnB"}

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

@@ -1,9 +1,12 @@
 /**
+ * Schema of the {@link Service} model.
+ * Subclasses extend this schema to declare whatever the third-party service needs.
+ *
  * @group Models/Service
  */
 export declare class ServiceSchema {
     /**
-     * The ID of the service.
+     * The ID of the service, unique within the {@link App}.
      */
     serviceId: string;
 }

package/dist/models/service/service.schema.js

@@ -10,12 +10,15 @@ 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 Service} model.
+ * Subclasses extend this schema to declare whatever the third-party service needs.
+ *
  * @group Models/Service
  */
 export class ServiceSchema {
     constructor() {
         /**
-         * The ID of the service.
+         * The ID of the service, unique within the {@link App}.
          */
         this.serviceId = Schema();
     }

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

@@ -1 +1 @@
-{"version":3,"file":"service.schema.js","sourceRoot":"","sources":["../../../src/models/service/service.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,aAAa;IAA1B;QACE;;WAEG;QAEH,cAAS,GAAG,MAAM,EAAU,CAAC;IAC/B,CAAC;CAAA;AADC;IADC,QAAQ,CAAC,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,iCAAiC,EAAE,EAAE,CAAC;;gDACrE"}
+{"version":3,"file":"service.schema.js","sourceRoot":"","sources":["../../../src/models/service/service.schema.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,wCAAwC,CAAC;AAClE,OAAO,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAC;AAE1D;;;;;GAKG;AACH,MAAM,OAAO,aAAa;IAA1B;QACE;;WAEG;QAEH,cAAS,GAAG,MAAM,EAAU,CAAC;IAC/B,CAAC;CAAA;AADC;IADC,QAAQ,CAAC,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,iCAAiC,EAAE,EAAE,CAAC;;gDACrE"}

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

@@ -18,10 +18,8 @@ import { SubnetSchema, SubnetType } from './subnet.schema.js';
  * @see Definition of [Default Models](/docs/fundamentals/models#default-models).
  */
 export declare class Subnet extends AModel<SubnetSchema, Subnet> {
-    private options;
     readonly subnetId: string;
     readonly subnetName: string;
-    constructor(region: Region, name: string);
     /**
      * To block/disable intra-network communication within self.
      * When this is set to `true`,
@@ -31,12 +29,38 @@ export declare class Subnet extends AModel<SubnetSchema, Subnet> {
      * @experimental
      */
     get disableSubnetIntraNetwork(): boolean;
+    /**
+     * @internal
+     */
     set disableSubnetIntraNetwork(disableSubnetIntraNetwork: boolean);
+    /**
+     * Whether this subnet is reachable from the internet.
+     *
+     * @defaultValue {@link SubnetType.PRIVATE}
+     */
     get subnetType(): SubnetType;
+    /**
+     * @internal
+     */
     set subnetType(subnetType: SubnetType);
+    private options;
+    /**
+     * @param region The region this subnet belongs to.
+     * @param name The name of the subnet. The subnet's ID is derived from the region and this name.
+     */
+    constructor(region: Region, name: string);
+    /**
+     * @internal
+     */
+    static unSynth(subnet: SubnetSchema, deReferenceContext: (context: string) => Promise<UnknownModel>): Promise<Subnet>;
+    /**
+     * @internal
+     */
     setContext(): string | undefined;
+    /**
+     * @internal
+     */
     synth(): SubnetSchema;
-    static unSynth(subnet: SubnetSchema, 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 uni-directional,

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

@@ -28,15 +28,6 @@ import { SubnetSchema, SubnetType } from './subnet.schema.js';
  * @see Definition of [Default Models](/docs/fundamentals/models#default-models).
  */
 let Subnet = Subnet_1 = class Subnet extends AModel {
-    constructor(region, name) {
-        super();
-        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`,
@@ -48,15 +39,52 @@ let Subnet = Subnet_1 = class Subnet extends AModel {
     get disableSubnetIntraNetwork() {
         return this.options.disableSubnetIntraNetwork;
     }
+    /**
+     * @internal
+     */
     set disableSubnetIntraNetwork(disableSubnetIntraNetwork) {
         this.options.disableSubnetIntraNetwork = disableSubnetIntraNetwork;
     }
+    /**
+     * Whether this subnet is reachable from the internet.
+     *
+     * @defaultValue {@link SubnetType.PRIVATE}
+     */
     get subnetType() {
         return this.options.subnetType;
     }
+    /**
+     * @internal
+     */
     set subnetType(subnetType) {
         this.options.subnetType = subnetType || SubnetType.PRIVATE;
     }
+    /**
+     * @param region The region this subnet belongs to.
+     * @param name The name of the subnet. The subnet's ID is derived from the region and this name.
+     */
+    constructor(region, name) {
+        super();
+        this.options = {
+            disableSubnetIntraNetwork: false,
+            subnetType: SubnetType.PRIVATE,
+        };
+        this.subnetId = region.regionId + '-' + name;
+        this.subnetName = name;
+    }
+    /**
+     * @internal
+     */
+    static async unSynth(subnet, deReferenceContext) {
+        const region = (await deReferenceContext(subnet.region.context));
+        const newSubnet = new Subnet_1(region, subnet.subnetName);
+        newSubnet.disableSubnetIntraNetwork = subnet.options.disableSubnetIntraNetwork;
+        newSubnet.subnetType = subnet.options.subnetType;
+        return newSubnet;
+    }
+    /**
+     * @internal
+     */
     setContext() {
         const parents = this.getParents();
         const region = parents['region']?.[0]?.to;
@@ -65,6 +93,9 @@ let Subnet = Subnet_1 = class Subnet extends AModel {
         }
         return [`${this.constructor.NODE_NAME}=${this.subnetId}`, region.getContext()].join(',');
     }
+    /**
+     * @internal
+     */
     synth() {
         const parents = this.getParents();
         const region = parents['region'][0].to;
@@ -75,13 +106,6 @@ let Subnet = Subnet_1 = class Subnet extends AModel {
             subnetName: this.subnetName,
         };
     }
-    static async unSynth(subnet, deReferenceContext) {
-        const region = (await deReferenceContext(subnet.region.context));
-        const newSubnet = new Subnet_1(region, subnet.subnetName);
-        newSubnet.disableSubnetIntraNetwork = subnet.options.disableSubnetIntraNetwork;
-        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 uni-directional,

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,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC1D,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAE9C,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAE9D;;;;;;;;;;;;;;GAcG;AAEI,IAAM,MAAM,cAAZ,MAAM,MAAO,SAAQ,MAA4B;IAUtD,YAAY,MAAc,EAAE,IAAY;QACtC,KAAK,EAAE,CAAC;QAVF,YAAO,GAA4B;YACzC,yBAAyB,EAAE,KAAK;YAChC,UAAU,EAAE,UAAU,CAAC,OAAO;SAC/B,CAAC;QAQA,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,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,WAA6B,CAAC,SAAS,IAAI,IAAI,CAAC,QAAQ,EAAE,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC9G,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,MAAoB,EACpB,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,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;YAC9D,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;AAhGY,MAAM;IADlB,KAAK,CAAS,OAAO,EAAE,QAAQ,EAAE,YAAY,CAAC;;GAClC,MAAM,CAgGlB"}
+{"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,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC1D,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAE9C,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAE9D;;;;;;;;;;;;;;GAcG;AAEI,IAAM,MAAM,cAAZ,MAAM,MAAO,SAAQ,MAA4B;IAKtD;;;;;;;OAOG;IACH,IAAI,yBAAyB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,yBAAyB,CAAC;IAChD,CAAC;IAED;;OAEG;IACH,IAAI,yBAAyB,CAAC,yBAAkC;QAC9D,IAAI,CAAC,OAAO,CAAC,yBAAyB,GAAG,yBAAyB,CAAC;IACrE,CAAC;IAED;;;;OAIG;IACH,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,IAAI,UAAU,CAAC,UAAsB;QACnC,IAAI,CAAC,OAAO,CAAC,UAAU,GAAG,UAAU,IAAI,UAAU,CAAC,OAAO,CAAC;IAC7D,CAAC;IAOD;;;OAGG;IACH,YAAY,MAAc,EAAE,IAAY;QACtC,KAAK,EAAE,CAAC;QAVF,YAAO,GAA4B;YACzC,yBAAyB,EAAE,KAAK;YAChC,UAAU,EAAE,UAAU,CAAC,OAAO;SAC/B,CAAC;QAQA,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,GAAG,GAAG,GAAG,IAAI,CAAC;QAC7C,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,MAAM,CAAU,KAAK,CAAC,OAAO,CAC3B,MAAoB,EACpB,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;;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,WAA6B,CAAC,SAAS,IAAI,IAAI,CAAC,QAAQ,EAAE,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC9G,CAAC;IAED;;OAEG;IACM,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;;;;;;;;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,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;YAC9D,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;AAxHY,MAAM;IADlB,KAAK,CAAS,OAAO,EAAE,QAAQ,EAAE,YAAY,CAAC;;GAClC,MAAM,CAwHlB"}

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

@@ -18,13 +18,22 @@ export declare enum SubnetType {
     PRIVATE = "private"
 }
 /**
+ * Schema of the {@link Subnet} model.
+ *
  * @group Models/Subnet
  */
 export declare class SubnetSchema {
+    /**
+     * The behavior options of the subnet.
+     * - See {@link Subnet.disableSubnetIntraNetwork} and {@link SubnetType}.
+     */
     options: {
         disableSubnetIntraNetwork: boolean;
         subnetType: SubnetType;
     };
+    /**
+     * The region this subnet belongs to.
+     */
     region: IModelReference;
     /**
      * The ID of the subnet.

package/dist/models/subnet/subnet.schema.js

@@ -29,11 +29,20 @@ export var SubnetType;
     SubnetType["PRIVATE"] = "private";
 })(SubnetType || (SubnetType = {}));
 /**
+ * Schema of the {@link Subnet} model.
+ *
  * @group Models/Subnet
  */
 export class SubnetSchema {
     constructor() {
+        /**
+         * The behavior options of the subnet.
+         * - See {@link Subnet.disableSubnetIntraNetwork} and {@link SubnetType}.
+         */
         this.options = Schema();
+        /**
+         * The region this subnet belongs to.
+         */
         this.region = Schema();
         /**
          * The ID of the subnet.

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

@@ -1 +1 @@
-{"version":3,"file":"subnet.schema.js","sourceRoot":"","sources":["../../../src/models/subnet/subnet.schema.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,wCAAwC,CAAC;AAClE,OAAO,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAC;AAG1D;;;;GAIG;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;;GAEG;AACH,MAAM,OAAO,YAAY;IAAzB;QACE,YAAO,GAAG,MAAM,EAAkE,CAAC;QAEnF,WAAM,GAAG,MAAM,EAAmB,CAAC;QAEnC;;;WAGG;QACH,aAAQ,GAAG,MAAM,EAAU,CAAC;QAE5B;;WAEG;QAEH,eAAU,GAAG,MAAM,EAAU,CAAC;IAChC,CAAC;CAAA;AADC;IADC,QAAQ,CAAC,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,6BAA6B,EAAE,EAAE,CAAC;;gDAC/D"}
+{"version":3,"file":"subnet.schema.js","sourceRoot":"","sources":["../../../src/models/subnet/subnet.schema.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,wCAAwC,CAAC;AAClE,OAAO,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAC;AAG1D;;;;GAIG;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;;;;GAIG;AACH,MAAM,OAAO,YAAY;IAAzB;QACE;;;WAGG;QACH,YAAO,GAAG,MAAM,EAAkE,CAAC;QAEnF;;WAEG;QACH,WAAM,GAAG,MAAM,EAAmB,CAAC;QAEnC;;;WAGG;QACH,aAAQ,GAAG,MAAM,EAAU,CAAC;QAE5B;;WAEG;QAEH,eAAU,GAAG,MAAM,EAAU,CAAC;IAChC,CAAC;CAAA;AADC;IADC,QAAQ,CAAC,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,6BAA6B,EAAE,EAAE,CAAC;;gDAC/D"}

package/dist/modes/apply-transaction.d.ts

@@ -0,0 +1,23 @@
+import type { DiffMetadata } from '../functions/diff/diff-metadata.js';
+import type { App } from '../models/app/app.model.js';
+/**
+ * The result of applying the model transaction once: the model transaction and the resource diffs,
+ * with the resource graph built and swept into terraform as a side effect. `commit` consumes the
+ * model transaction; `generate` and `validate` consume the resource diffs.
+ */
+export interface ModelTransactionResult {
+    modelTransaction: DiffMetadata[][];
+    resourceDiffs: DiffMetadata[][];
+}
+/**
+ * Applies the model transaction: derives the full resource graph from intent (running every model
+ * action once) and sweeps it into terraform, returning the model transaction and resource diffs.
+ *
+ * This is the single "build" step of a lifecycle. In production each of generate/validate/commit is
+ * a separate process and builds its own; a single-process driver (e.g. the test harness) can build
+ * once and hand the same {@link ModelTransactionResult} to all three modes, so the graph is derived
+ * once rather than three times. No resource actions run here — that is `generateTerraform`'s path.
+ *
+ * @internal
+ */
+export declare function applyModelTransaction(app: App): Promise<ModelTransactionResult>;

package/dist/modes/apply-transaction.js

@@ -0,0 +1,25 @@
+import { Container } from '../functions/container/container.js';
+import { TransactionService } from '../services/transaction/transaction.service.js';
+/**
+ * Applies the model transaction: derives the full resource graph from intent (running every model
+ * action once) and sweeps it into terraform, returning the model transaction and resource diffs.
+ *
+ * This is the single "build" step of a lifecycle. In production each of generate/validate/commit is
+ * a separate process and builds its own; a single-process driver (e.g. the test harness) can build
+ * once and hand the same {@link ModelTransactionResult} to all three modes, so the graph is derived
+ * once rather than three times. No resource actions run here — that is `generateTerraform`'s path.
+ *
+ * @internal
+ */
+export async function applyModelTransaction(app) {
+    const transactionService = await Container.getInstance().get(TransactionService);
+    const transaction = transactionService.beginTransaction(await app.diff(), {
+        generateTerraform: true,
+        yieldModelTransaction: true,
+        yieldResourceDiffs: true,
+    });
+    const modelTransaction = (await transaction.next()).value;
+    const resourceDiffs = (await transaction.next()).value;
+    return { modelTransaction, resourceDiffs };
+}
+//# sourceMappingURL=apply-transaction.js.map

package/dist/modes/apply-transaction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"apply-transaction.js","sourceRoot":"","sources":["../../src/modes/apply-transaction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAGhE,OAAO,EAAE,kBAAkB,EAAE,MAAM,gDAAgD,CAAC;AAYpF;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAAC,GAAQ;IAClD,MAAM,kBAAkB,GAAG,MAAM,SAAS,CAAC,WAAW,EAAE,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;IAEjF,MAAM,WAAW,GAAG,kBAAkB,CAAC,gBAAgB,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,EAAE;QACxE,iBAAiB,EAAE,IAAI;QACvB,qBAAqB,EAAE,IAAI;QAC3B,kBAAkB,EAAE,IAAI;KACzB,CAAC,CAAC;IAEH,MAAM,gBAAgB,GAAG,CAAC,MAAM,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,KAAyB,CAAC;IAC9E,MAAM,aAAa,GAAG,CAAC,MAAM,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,KAAyB,CAAC;IAE3E,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,CAAC;AAC7C,CAAC"}

package/dist/modes/commit.mode.d.ts

@@ -0,0 +1,54 @@
+import type { TerraformFolderOutput, TerraformResourceOutput } from '../app.type.js';
+import type { CommitModeCompletedEvent } from '../events/index.js';
+import type { DiffMetadata } from '../functions/diff/diff-metadata.js';
+import type { ModelTransactionResult } from './apply-transaction.js';
+export type TerraformOutputs = Record<string, {
+    value: unknown;
+}>;
+/**
+ * Records a terraform apply back into octo's state: Committed ← Cloud. The catch-up step of the
+ * cycle, not a drift resolver.
+ *
+ * Operates on the resource graph the `transaction` already built: reads every module folder's outputs
+ * from the caller-supplied `outputs` map (keyed by module id), populates resource responses by the
+ * `${resourceId}-${key}` convention, and syncs the actual graph to the new graph.
+ *
+ * Rejects — all-or-nothing, throwing before any mutation: a declared output that is missing
+ * (partial apply) or carries a null value (broken apply). `partial` turns those rejections into
+ * warnings and keeps every resource whose outputs did not all resolve out of the committed graph,
+ * which is what lets a failed apply still record the half that worked. Outputs are demanded only for the
+ * modules the sweep filled — never for an emptied (deleted) folder, whose destroy simply drops its
+ * resources from the committed state. Warns: outputs supplied for a folder that is neither in
+ * intent nor in the committed folder record (`previousFolders`) are ignored — octo never fails on,
+ * or touches, a folder it does not recognize; re-declaring the module in intent re-adopts it.
+ *
+ * Returns the model transaction so {@link Octo} can run the persistence + commit hooks it owns,
+ * plus a description of what was committed for the caller to emit and surface.
+ *
+ * `previousMappings` is the octo→terraform mapping persisted by the last commit. It supplies the
+ * module and addresses of resources being deleted, which this run's sweep no longer renders.
+ *
+ * @internal
+ */
+export declare function commit({ outputs, partial, previousFolders, previousMappings, transaction, }: {
+    outputs: Map<string, TerraformOutputs>;
+    partial?: boolean;
+    previousFolders?: TerraformFolderOutput[];
+    previousMappings?: TerraformResourceOutput[];
+    transaction: ModelTransactionResult;
+}): Promise<{
+    emptiedModuleIds: string[];
+    externalResourceIds: string[];
+    modelTransaction: DiffMetadata[][];
+    resources: CommitModeCompletedEvent['payload']['resources'];
+    responses: {
+        key: string;
+        previousValue?: string;
+        resourceContext: string;
+        value: string;
+    }[];
+    warnings: {
+        message: string;
+        moduleId?: string;
+    }[];
+}>;