@quadnix/octo 0.0.29 → 0.1.0

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

@@ -1 +1 @@
-{"version":3,"file":"execution.model.js","sourceRoot":"","sources":["../../../src/models/execution/execution.model.ts"],"names":[],"mappings":";;;;;;;;;;AACA,OAAO,EAAE,KAAK,EAAE,MAAM,qCAAqC,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,wCAAwC,CAAC;AACtE,OAAO,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,qCAAqC,CAAC;AAClE,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAC;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAC;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAC;AACnD,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAExD;;;;;;;;;;;;;;;GAeG;AAEI,IAAM,SAAS,iBAAf,MAAM,SAAU,SAAQ,MAAkC;IAG/D,YAAY,UAAsB,EAAE,WAAwB,EAAE,MAAc;QAC1E,KAAK,EAAE,CAAC;QAHD,yBAAoB,GAAwB,IAAI,GAAG,EAAE,CAAC;QAK7D,mDAAmD;QACnD,MAAM,kBAAkB,GAAG,WAAW,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;QAC5E,MAAM,aAAa,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;QAClE,IACE,kBAAkB,CAAC,MAAM,GAAG,CAAC;YAC7B,aAAa,CAAC,MAAM,GAAG,CAAC;YACvB,kBAAkB,CAAC,CAAC,CAAC,CAAC,EAAa,CAAC,QAAQ,KAAM,aAAa,CAAC,CAAC,CAAC,CAAC,EAAa,CAAC,QAAQ,EAC1F,CAAC;YACD,MAAM,IAAI,UAAU,CAAC,oDAAoD,EAAE,IAAI,CAAC,CAAC;QACnF,CAAC;QAED,wBAAwB;QACxB,MAAM,oBAAoB,GAAG,CAAC,UAAU,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CACvF,CAAC,CAAC,EAAa,EAAE,CAAC,CAAC,CAAC,EAAe,CACpC,CAAC;QACF,MAAM,qBAAqB,GAAG,CAAC,WAAW,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CACzF,CAAC,CAAC,EAAa,EAAE,CAAC,CAAC,CAAC,EAAe,CACpC,CAAC;QACF,MAAM,gBAAgB,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAC/E,CAAC,CAAC,EAAa,EAAE,CAAC,CAAC,CAAC,EAAe,CACpC,CAAC;QAEF,IACE,YAAY,CAAC,SAAS,CACpB,CAAC,CAAY,EAAE,CAAY,EAAW,EAAE;YACtC,OAAO,CAAC,CAAC,WAAW,KAAK,CAAC,CAAC,WAAW,CAAC;QACzC,CAAC,EACD,oBAAoB,EACpB,qBAAqB,EACrB,gBAAgB,CACjB,CAAC,MAAM,GAAG,CAAC,EACZ,CAAC;YACD,MAAM,IAAI,UAAU,CAAC,2BAA2B,EAAE,IAAI,CAAC,CAAC;QAC1D,CAAC;QAED,kGAAkG;QAClG,uEAAuE;QACvE,UAAU,CAAC,QAAQ,CAAC,eAAe,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;QAC1D,WAAW,CAAC,QAAQ,CAAC,iBAAiB,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;QAC7D,MAAM,CAAC,QAAQ,CAAC,UAAU,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;IACnD,CAAC;IAED;;;OAGG;IACH,IAAI,WAAW;QACb,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAClC,MAAM,UAAU,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,EAAgB,CAAC;QAC7D,MAAM,MAAM,GAAG,UAAU,CAAC,UAAU,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAY,CAAC;QACjE,MAAM,WAAW,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,EAAiB,CAAC;QAChE,MAAM,MAAM,GAAG,WAAW,CAAC,UAAU,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAY,CAAC;QAClE,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAY,CAAC;QACjD,OAAO;YACL,MAAM,CAAC,SAAS;YAChB,UAAU,CAAC,aAAa;YACxB,MAAM,CAAC,QAAQ;YACf,WAAW,CAAC,eAAe;YAC3B,MAAM,CAAC,UAAU;SAClB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACd,CAAC;IAEQ,UAAU;QACjB,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAClC,MAAM,UAAU,GAAG,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAgB,CAAC;QAChE,MAAM,WAAW,GAAG,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAiB,CAAC;QACnE,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAY,CAAC;QACpD,IAAI,CAAC,UAAU,IAAI,CAAC,WAAW,IAAI,CAAC,MAAM,EAAE,CAAC;YAC3C,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO;YACL,GAAI,IAAI,CAAC,WAAgC,CAAC,SAAS,IAAI,IAAI,CAAC,WAAW,EAAE;YACzE,UAAU,CAAC,UAAU,EAAE;YACvB,WAAW,CAAC,UAAU,EAAE;YACxB,MAAM,CAAC,UAAU,EAAE;SACpB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACd,CAAC;IAEQ,KAAK;QACZ,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAClC,MAAM,UAAU,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAe,CAAC;QAChE,MAAM,WAAW,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAgB,CAAC;QACnE,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAW,CAAC;QAEpD,OAAO;YACL,UAAU,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,UAAU,EAAE,EAAE;YAChD,WAAW,EAAE,EAAE,OAAO,EAAE,WAAW,CAAC,UAAU,EAAE,EAAE;YAClD,oBAAoB,EAAE,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,oBAAoB,IAAI,IAAI,GAAG,EAAE,CAAC;YAChF,MAAM,EAAE,EAAE,OAAO,EAAE,MAAM,CAAC,UAAU,EAAE,EAAE;SACzC,CAAC;IACJ,CAAC;IAED,MAAM,CAAU,KAAK,CAAC,OAAO,CAC3B,SAA0B,EAC1B,kBAA8D;QAE9D,MAAM,CAAC,UAAU,EAAE,WAAW,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,OAAO,CAAC,GAAG,CAAC;YAC3D,kBAAkB,CAAC,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC;YAChD,kBAAkB,CAAC,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC;YACjD,kBAAkB,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC;SAC7C,CAAC,CAAsC,CAAC;QACzC,MAAM,YAAY,GAAG,IAAI,WAAS,CAAC,UAAU,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC;QAEpE,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,oBAAoB,CAAC,EAAE,CAAC;YAC1E,YAAY,CAAC,oBAAoB,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACpD,CAAC;QAED,OAAO,YAAY,CAAC;IACtB,CAAC;CACF,CAAA;AAnHY,SAAS;IADrB,KAAK,CAAY,OAAO,EAAE,WAAW,EAAE,eAAe,CAAC;qCAI9B,UAAU,EAAe,WAAW,EAAU,MAAM;GAHjE,SAAS,CAmHrB"}
+{"version":3,"file":"execution.model.js","sourceRoot":"","sources":["../../../src/models/execution/execution.model.ts"],"names":[],"mappings":";;;;;;;;;;AACA,OAAO,EAAE,KAAK,EAAE,MAAM,qCAAqC,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,wCAAwC,CAAC;AACtE,OAAO,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,qCAAqC,CAAC;AAClE,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAC;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAC;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAC;AACnD,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAExD;;;;;;;;;;;;;;;GAeG;AAEI,IAAM,SAAS,iBAAf,MAAM,SAAU,SAAQ,MAAkC;IAG/D;;;OAGG;IACH,IAAI,WAAW;QACb,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAClC,MAAM,UAAU,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,EAAgB,CAAC;QAC7D,MAAM,MAAM,GAAG,UAAU,CAAC,UAAU,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAY,CAAC;QACjE,MAAM,WAAW,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,EAAiB,CAAC;QAChE,MAAM,MAAM,GAAG,WAAW,CAAC,UAAU,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAY,CAAC;QAClE,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAY,CAAC;QACjD,OAAO;YACL,MAAM,CAAC,SAAS;YAChB,UAAU,CAAC,aAAa;YACxB,MAAM,CAAC,QAAQ;YACf,WAAW,CAAC,eAAe;YAC3B,MAAM,CAAC,UAAU;SAClB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACd,CAAC;IAED;;;;;;;;OAQG;IACH,YAAY,UAAsB,EAAE,WAAwB,EAAE,MAAc;QAC1E,KAAK,EAAE,CAAC;QAhCD,yBAAoB,GAAwB,IAAI,GAAG,EAAE,CAAC;QAkC7D,mDAAmD;QACnD,MAAM,kBAAkB,GAAG,WAAW,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;QAC5E,MAAM,aAAa,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;QAClE,IACE,kBAAkB,CAAC,MAAM,GAAG,CAAC;YAC7B,aAAa,CAAC,MAAM,GAAG,CAAC;YACvB,kBAAkB,CAAC,CAAC,CAAC,CAAC,EAAa,CAAC,QAAQ,KAAM,aAAa,CAAC,CAAC,CAAC,CAAC,EAAa,CAAC,QAAQ,EAC1F,CAAC;YACD,MAAM,IAAI,UAAU,CAAC,oDAAoD,EAAE,IAAI,CAAC,CAAC;QACnF,CAAC;QAED,wBAAwB;QACxB,MAAM,oBAAoB,GAAG,CAAC,UAAU,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CACvF,CAAC,CAAC,EAAa,EAAE,CAAC,CAAC,CAAC,EAAe,CACpC,CAAC;QACF,MAAM,qBAAqB,GAAG,CAAC,WAAW,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CACzF,CAAC,CAAC,EAAa,EAAE,CAAC,CAAC,CAAC,EAAe,CACpC,CAAC;QACF,MAAM,gBAAgB,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAC/E,CAAC,CAAC,EAAa,EAAE,CAAC,CAAC,CAAC,EAAe,CACpC,CAAC;QAEF,IACE,YAAY,CAAC,SAAS,CACpB,CAAC,CAAY,EAAE,CAAY,EAAW,EAAE;YACtC,OAAO,CAAC,CAAC,WAAW,KAAK,CAAC,CAAC,WAAW,CAAC;QACzC,CAAC,EACD,oBAAoB,EACpB,qBAAqB,EACrB,gBAAgB,CACjB,CAAC,MAAM,GAAG,CAAC,EACZ,CAAC;YACD,MAAM,IAAI,UAAU,CAAC,2BAA2B,EAAE,IAAI,CAAC,CAAC;QAC1D,CAAC;QAED,kGAAkG;QAClG,uEAAuE;QACvE,UAAU,CAAC,QAAQ,CAAC,eAAe,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;QAC1D,WAAW,CAAC,QAAQ,CAAC,iBAAiB,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;QAC7D,MAAM,CAAC,QAAQ,CAAC,UAAU,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;IACnD,CAAC;IAED;;OAEG;IACH,MAAM,CAAU,KAAK,CAAC,OAAO,CAC3B,SAA0B,EAC1B,kBAA8D;QAE9D,MAAM,CAAC,UAAU,EAAE,WAAW,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,OAAO,CAAC,GAAG,CAAC;YAC3D,kBAAkB,CAAC,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC;YAChD,kBAAkB,CAAC,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC;YACjD,kBAAkB,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC;SAC7C,CAAC,CAAsC,CAAC;QACzC,MAAM,YAAY,GAAG,IAAI,WAAS,CAAC,UAAU,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC;QAEpE,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,oBAAoB,CAAC,EAAE,CAAC;YAC1E,YAAY,CAAC,oBAAoB,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACpD,CAAC;QAED,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;OAEG;IACM,UAAU;QACjB,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAClC,MAAM,UAAU,GAAG,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAgB,CAAC;QAChE,MAAM,WAAW,GAAG,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAiB,CAAC;QACnE,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAY,CAAC;QACpD,IAAI,CAAC,UAAU,IAAI,CAAC,WAAW,IAAI,CAAC,MAAM,EAAE,CAAC;YAC3C,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO;YACL,GAAI,IAAI,CAAC,WAAgC,CAAC,SAAS,IAAI,IAAI,CAAC,WAAW,EAAE;YACzE,UAAU,CAAC,UAAU,EAAE;YACvB,WAAW,CAAC,UAAU,EAAE;YACxB,MAAM,CAAC,UAAU,EAAE;SACpB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACd,CAAC;IAED;;OAEG;IACM,KAAK;QACZ,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAClC,MAAM,UAAU,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAe,CAAC;QAChE,MAAM,WAAW,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAgB,CAAC;QACnE,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAW,CAAC;QAEpD,OAAO;YACL,UAAU,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,UAAU,EAAE,EAAE;YAChD,WAAW,EAAE,EAAE,OAAO,EAAE,WAAW,CAAC,UAAU,EAAE,EAAE;YAClD,oBAAoB,EAAE,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,oBAAoB,IAAI,IAAI,GAAG,EAAE,CAAC;YAChF,MAAM,EAAE,EAAE,OAAO,EAAE,MAAM,CAAC,UAAU,EAAE,EAAE;SACzC,CAAC;IACJ,CAAC;CACF,CAAA;AArIY,SAAS;IADrB,KAAK,CAAY,OAAO,EAAE,WAAW,EAAE,eAAe,CAAC;qCAiC9B,UAAU,EAAe,WAAW,EAAU,MAAM;GAhCjE,SAAS,CAqIrB"}

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

@@ -1,9 +1,17 @@
 import type { IModelReference } from '../model.interface.js';
 /**
+ * Schema of the {@link Execution} model.
+ *
  * @group Models/Execution
  */
 export declare class ExecutionSchema {
+    /**
+     * The deployment whose code this execution runs.
+     */
     deployment: IModelReference;
+    /**
+     * The environment this execution runs in.
+     */
     environment: IModelReference;
     /**
      * A set of environment variables to be passed to the Docker container.
@@ -13,5 +21,8 @@ export declare class ExecutionSchema {
     environmentVariables: {
         [key: string]: string;
     };
+    /**
+     * The subnet this execution is placed in. It must belong to the same region as the environment.
+     */
     subnet: IModelReference;
 }

package/dist/models/execution/execution.schema.js

@@ -10,11 +10,19 @@ 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 Execution} model.
+ *
  * @group Models/Execution
  */
 export class ExecutionSchema {
     constructor() {
+        /**
+         * The deployment whose code this execution runs.
+         */
         this.deployment = Schema();
+        /**
+         * The environment this execution runs in.
+         */
         this.environment = Schema();
         /**
          * A set of environment variables to be passed to the Docker container.
@@ -22,6 +30,9 @@ export class ExecutionSchema {
          * option while running a Docker container.
          */
         this.environmentVariables = Schema();
+        /**
+         * The subnet this execution is placed in. It must belong to the same region as the environment.
+         */
         this.subnet = Schema();
     }
 }

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

@@ -1 +1 @@
-{"version":3,"file":"execution.schema.js","sourceRoot":"","sources":["../../../src/models/execution/execution.schema.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,wCAAwC,CAAC;AAClE,OAAO,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAC;AAG1D;;GAEG;AACH,MAAM,OAAO,eAAe;IAA5B;QACE,eAAU,GAAG,MAAM,EAAmB,CAAC;QAEvC,gBAAW,GAAG,MAAM,EAAmB,CAAC;QAExC;;;;WAIG;QAOH,yBAAoB,GAAG,MAAM,EAA6B,CAAC;QAE3D,WAAM,GAAG,MAAM,EAAmB,CAAC;IACrC,CAAC;CAAA;AAHC;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;;6DACyD"}
+{"version":3,"file":"execution.schema.js","sourceRoot":"","sources":["../../../src/models/execution/execution.schema.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,wCAAwC,CAAC;AAClE,OAAO,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAC;AAG1D;;;;GAIG;AACH,MAAM,OAAO,eAAe;IAA5B;QACE;;WAEG;QACH,eAAU,GAAG,MAAM,EAAmB,CAAC;QAEvC;;WAEG;QACH,gBAAW,GAAG,MAAM,EAAmB,CAAC;QAExC;;;;WAIG;QAOH,yBAAoB,GAAG,MAAM,EAA6B,CAAC;QAE3D;;WAEG;QACH,WAAM,GAAG,MAAM,EAAmB,CAAC;IACrC,CAAC;CAAA;AANC;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;;6DACyD"}

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

@@ -2,12 +2,38 @@ import type { UnknownModel } from '../../app.type.js';
 import { AModel } from '../model.abstract.js';
 import { FilesystemSchema } from './filesystem.schema.js';
 /**
+ * A Filesystem model is a network filesystem shared by the executions of a region.
+ * It exists so that state which must outlive a container - uploads, caches, shared data - has somewhere to live.
+ *
+ * A filesystem belongs to one {@link Region}. Mounting it into a {@link Subnet} is the job of a module,
+ * e.g. `AwsSimpleSubnetModule` via its `localFilesystems` input.
+ *
+ * @example
+ * ```ts
+ * const filesystem = new Filesystem('shared-uploads');
+ * region.addFilesystem(filesystem);
+ * ```
+ *
  * @group Models/Filesystem
+ *
+ * @see Definition of [Default Models](/docs/fundamentals/models#default-models).
  */
 export declare class Filesystem extends AModel<FilesystemSchema, Filesystem> {
     readonly filesystemName: string;
+    /**
+     * @param filesystemName The name of the filesystem, unique within its region.
+     */
     constructor(filesystemName: string);
+    /**
+     * @internal
+     */
+    static unSynth(filesystem: FilesystemSchema, deReferenceContext: (context: string) => Promise<UnknownModel>): Promise<Filesystem>;
+    /**
+     * @internal
+     */
     setContext(): string | undefined;
+    /**
+     * @internal
+     */
     synth(): FilesystemSchema;
-    static unSynth(filesystem: FilesystemSchema, deReferenceContext: (context: string) => Promise<UnknownModel>): Promise<Filesystem>;
 }

package/dist/models/filesystem/filesystem.model.js

@@ -13,13 +13,40 @@ import { Model } from '../../decorators/model.decorator.js';
 import { AModel } from '../model.abstract.js';
 import { FilesystemSchema } from './filesystem.schema.js';
 /**
+ * A Filesystem model is a network filesystem shared by the executions of a region.
+ * It exists so that state which must outlive a container - uploads, caches, shared data - has somewhere to live.
+ *
+ * A filesystem belongs to one {@link Region}. Mounting it into a {@link Subnet} is the job of a module,
+ * e.g. `AwsSimpleSubnetModule` via its `localFilesystems` input.
+ *
+ * @example
+ * ```ts
+ * const filesystem = new Filesystem('shared-uploads');
+ * region.addFilesystem(filesystem);
+ * ```
+ *
  * @group Models/Filesystem
+ *
+ * @see Definition of [Default Models](/docs/fundamentals/models#default-models).
  */
 let Filesystem = Filesystem_1 = class Filesystem extends AModel {
+    /**
+     * @param filesystemName The name of the filesystem, unique within its region.
+     */
     constructor(filesystemName) {
         super();
         this.filesystemName = filesystemName;
     }
+    /**
+     * @internal
+     */
+    static async unSynth(filesystem, deReferenceContext) {
+        assert(!!deReferenceContext);
+        return new Filesystem_1(filesystem.filesystemName);
+    }
+    /**
+     * @internal
+     */
     setContext() {
         const parents = this.getParents();
         const region = parents['region']?.[0]?.to;
@@ -28,15 +55,14 @@ let Filesystem = Filesystem_1 = class Filesystem extends AModel {
         }
         return [`${this.constructor.NODE_NAME}=${this.filesystemName}`, region.getContext()].join(',');
     }
+    /**
+     * @internal
+     */
     synth() {
         return {
             filesystemName: this.filesystemName,
         };
     }
-    static async unSynth(filesystem, deReferenceContext) {
-        assert(!!deReferenceContext);
-        return new Filesystem_1(filesystem.filesystemName);
-    }
 };
 Filesystem = Filesystem_1 = __decorate([
     Model('@octo', 'filesystem', FilesystemSchema),

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

@@ -1 +1 @@
-{"version":3,"file":"filesystem.model.js","sourceRoot":"","sources":["../../../src/models/filesystem/filesystem.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;;GAEG;AAEI,IAAM,UAAU,kBAAhB,MAAM,UAAW,SAAQ,MAAoC;IAGlE,YAAY,cAAsB;QAChC,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;IACvC,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,cAAc,EAAE,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAC9G,GAAG,CACJ,CAAC;IACJ,CAAC;IAEQ,KAAK;QACZ,OAAO;YACL,cAAc,EAAE,IAAI,CAAC,cAAc;SACpC,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,cAAc,CAAC,CAAC;IACnD,CAAC;CACF,CAAA;AAjCY,UAAU;IADtB,KAAK,CAAa,OAAO,EAAE,YAAY,EAAE,gBAAgB,CAAC;;GAC9C,UAAU,CAiCtB"}
+{"version":3,"file":"filesystem.model.js","sourceRoot":"","sources":["../../../src/models/filesystem/filesystem.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;;;;;;;;;;;;;;;;GAgBG;AAEI,IAAM,UAAU,kBAAhB,MAAM,UAAW,SAAQ,MAAoC;IAGlE;;OAEG;IACH,YAAY,cAAsB;QAChC,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;IACvC,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,cAAc,CAAC,CAAC;IACnD,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,cAAc,EAAE,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAC9G,GAAG,CACJ,CAAC;IACJ,CAAC;IAED;;OAEG;IACM,KAAK;QACZ,OAAO;YACL,cAAc,EAAE,IAAI,CAAC,cAAc;SACpC,CAAC;IACJ,CAAC;CACF,CAAA;AA7CY,UAAU;IADtB,KAAK,CAAa,OAAO,EAAE,YAAY,EAAE,gBAAgB,CAAC;;GAC9C,UAAU,CA6CtB"}

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

@@ -1,6 +1,11 @@
 /**
+ * Schema of the {@link Filesystem} model.
+ *
  * @group Models/Filesystem
  */
 export declare class FilesystemSchema {
+    /**
+     * The name of the filesystem, unique within its {@link Region}.
+     */
     filesystemName: string;
 }

package/dist/models/filesystem/filesystem.schema.js

@@ -10,10 +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 Filesystem} model.
+ *
  * @group Models/Filesystem
  */
 export class FilesystemSchema {
     constructor() {
+        /**
+         * The name of the filesystem, unique within its {@link Region}.
+         */
         this.filesystemName = Schema();
     }
 }

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

@@ -1 +1 @@
-{"version":3,"file":"filesystem.schema.js","sourceRoot":"","sources":["../../../src/models/filesystem/filesystem.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;QAEE,mBAAc,GAAG,MAAM,EAAU,CAAC;IACpC,CAAC;CAAA;AADC;IADC,QAAQ,CAAC,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,6BAA6B,EAAE,EAAE,CAAC;;wDAC3D"}
+{"version":3,"file":"filesystem.schema.js","sourceRoot":"","sources":["../../../src/models/filesystem/filesystem.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;;WAEG;QAEH,mBAAc,GAAG,MAAM,EAAU,CAAC;IACpC,CAAC;CAAA;AADC;IADC,QAAQ,CAAC,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,6BAA6B,EAAE,EAAE,CAAC;;wDAC3D"}

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

@@ -3,12 +3,12 @@ import { AModel } from '../model.abstract.js';
 import { ImageSchema } from './image.schema.js';
 /**
  * An Image model represents a Docker image, to either build, or run, your microservices.
+ * Images belong to the {@link App} rather than to a region, so the same image can be deployed anywhere.
  *
  * @example
  * ```ts
- * const image = new Image('nginx', '2.4', { dockerfilePath: './Dockerfile' });
- *
- * const image = new Image('docker/hello-world', '1.0', { dockerfilePath: './Dockerfile' });
+ * const image = new Image('nginx', '2.4');
+ * app.addImage(image);
  * ```
  *
  * @group Models/Image
@@ -19,8 +19,21 @@ export declare class Image extends AModel<ImageSchema, Image> {
     readonly imageFamily: string;
     readonly imageId: string;
     readonly imageName: string;
+    /**
+     * @param imageFamily The repository name shared by all versions of this image.
+     * @param imageName The version or tag of this image within its family.
+     */
     constructor(imageFamily: string, imageName: string);
+    /**
+     * @internal
+     */
+    static unSynth(image: ImageSchema, deReferenceContext: (context: string) => Promise<UnknownModel>): Promise<Image>;
+    /**
+     * @internal
+     */
     setContext(): string | undefined;
+    /**
+     * @internal
+     */
     synth(): ImageSchema;
-    static unSynth(image: ImageSchema, deReferenceContext: (context: string) => Promise<UnknownModel>): Promise<Image>;
 }

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

@@ -14,12 +14,12 @@ import { AModel } from '../model.abstract.js';
 import { ImageSchema } from './image.schema.js';
 /**
  * An Image model represents a Docker image, to either build, or run, your microservices.
+ * Images belong to the {@link App} rather than to a region, so the same image can be deployed anywhere.
  *
  * @example
  * ```ts
- * const image = new Image('nginx', '2.4', { dockerfilePath: './Dockerfile' });
- *
- * const image = new Image('docker/hello-world', '1.0', { dockerfilePath: './Dockerfile' });
+ * const image = new Image('nginx', '2.4');
+ * app.addImage(image);
  * ```
  *
  * @group Models/Image
@@ -27,12 +27,26 @@ import { ImageSchema } from './image.schema.js';
  * @see Definition of [Default Models](/docs/fundamentals/models#default-models).
  */
 let Image = Image_1 = class Image extends AModel {
+    /**
+     * @param imageFamily The repository name shared by all versions of this image.
+     * @param imageName The version or tag of this image within its family.
+     */
     constructor(imageFamily, imageName) {
         super();
         this.imageFamily = imageFamily;
         this.imageId = `${imageFamily}/${imageName}`;
         this.imageName = imageName;
     }
+    /**
+     * @internal
+     */
+    static async unSynth(image, deReferenceContext) {
+        assert(!!deReferenceContext);
+        return new Image_1(image.imageFamily, image.imageName);
+    }
+    /**
+     * @internal
+     */
     setContext() {
         const parents = this.getParents();
         const app = parents['app']?.[0]?.to;
@@ -41,6 +55,9 @@ let Image = Image_1 = class Image extends AModel {
         }
         return [`${this.constructor.NODE_NAME}=${this.imageId}`, app.getContext()].join(',');
     }
+    /**
+     * @internal
+     */
     synth() {
         return {
             imageFamily: this.imageFamily,
@@ -48,10 +65,6 @@ let Image = Image_1 = class Image extends AModel {
             imageName: this.imageName,
         };
     }
-    static async unSynth(image, deReferenceContext) {
-        assert(!!deReferenceContext);
-        return new Image_1(image.imageFamily, image.imageName);
-    }
 };
 Image = Image_1 = __decorate([
     Model('@octo', 'image', ImageSchema),

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

@@ -1 +1 @@
-{"version":3,"file":"image.model.js","sourceRoot":"","sources":["../../../src/models/image/image.model.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,OAAO,EAAE,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,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD;;;;;;;;;;;;;GAaG;AAEI,IAAM,KAAK,aAAX,MAAM,KAAM,SAAQ,MAA0B;IAOnD,YAAY,WAAmB,EAAE,SAAiB;QAChD,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,OAAO,GAAG,GAAG,WAAW,IAAI,SAAS,EAAE,CAAC;QAC7C,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,WAA4B,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACzG,CAAC;IAEQ,KAAK;QACZ,OAAO;YACL,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,SAAS,EAAE,IAAI,CAAC,SAAS;SAC1B,CAAC;IACJ,CAAC;IAED,MAAM,CAAU,KAAK,CAAC,OAAO,CAC3B,KAAkB,EAClB,kBAA8D;QAE9D,MAAM,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC;QAE7B,OAAO,IAAI,OAAK,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IACvD,CAAC;CACF,CAAA;AAvCY,KAAK;IADjB,KAAK,CAAQ,OAAO,EAAE,OAAO,EAAE,WAAW,CAAC;;GAC/B,KAAK,CAuCjB"}
+{"version":3,"file":"image.model.js","sourceRoot":"","sources":["../../../src/models/image/image.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,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD;;;;;;;;;;;;;GAaG;AAEI,IAAM,KAAK,aAAX,MAAM,KAAM,SAAQ,MAA0B;IAOnD;;;OAGG;IACH,YAAY,WAAmB,EAAE,SAAiB;QAChD,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,OAAO,GAAG,GAAG,WAAW,IAAI,SAAS,EAAE,CAAC;QAC7C,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAED;;OAEG;IACH,MAAM,CAAU,KAAK,CAAC,OAAO,CAC3B,KAAkB,EAClB,kBAA8D;QAE9D,MAAM,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC;QAE7B,OAAO,IAAI,OAAK,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IACvD,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,WAA4B,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACzG,CAAC;IAED;;OAEG;IACM,KAAK;QACZ,OAAO;YACL,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,SAAS,EAAE,IAAI,CAAC,SAAS;SAC1B,CAAC;IACJ,CAAC;CACF,CAAA;AApDY,KAAK;IADjB,KAAK,CAAQ,OAAO,EAAE,OAAO,EAAE,WAAW,CAAC;;GAC/B,KAAK,CAoDjB"}

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

@@ -1,12 +1,20 @@
 /**
+ * Schema of the {@link Image} model.
+ *
  * @group Models/Image
  */
 export declare class ImageSchema {
+    /**
+     * The family this image belongs to, i.e. the repository name shared by all of its versions.
+     */
     imageFamily: string;
     /**
      * An imageId is the unique identifier for this image.
      * - Format of imageId is `{imageFamily}/{imageName}`
      */
     imageId: string;
+    /**
+     * The name of this image within its family, i.e. its version or tag.
+     */
     imageName: string;
 }

package/dist/models/image/image.schema.js

@@ -10,16 +10,24 @@ 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 Image} model.
+ *
  * @group Models/Image
  */
 export class ImageSchema {
     constructor() {
+        /**
+         * The family this image belongs to, i.e. the repository name shared by all of its versions.
+         */
         this.imageFamily = Schema();
         /**
          * An imageId is the unique identifier for this image.
          * - Format of imageId is `{imageFamily}/{imageName}`
          */
         this.imageId = Schema();
+        /**
+         * The name of this image within its family, i.e. its version or tag.
+         */
         this.imageName = Schema();
     }
 }

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

@@ -1 +1 @@
-{"version":3,"file":"image.schema.js","sourceRoot":"","sources":["../../../src/models/image/image.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,WAAW;IAAxB;QAEE,gBAAW,GAAG,MAAM,EAAU,CAAC;QAE/B;;;WAGG;QACH,YAAO,GAAG,MAAM,EAAU,CAAC;QAG3B,cAAS,GAAG,MAAM,EAAU,CAAC;IAC/B,CAAC;CAAA;AAVC;IADC,QAAQ,CAAC,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,iCAAiC,EAAE,EAAE,CAAC;;gDAClE;AAS/B;IADC,QAAQ,CAAC,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,gCAAgC,EAAE,EAAE,CAAC;;8CACnE"}
+{"version":3,"file":"image.schema.js","sourceRoot":"","sources":["../../../src/models/image/image.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,WAAW;IAAxB;QACE;;WAEG;QAEH,gBAAW,GAAG,MAAM,EAAU,CAAC;QAE/B;;;WAGG;QACH,YAAO,GAAG,MAAM,EAAU,CAAC;QAE3B;;WAEG;QAEH,cAAS,GAAG,MAAM,EAAU,CAAC;IAC/B,CAAC;CAAA;AAbC;IADC,QAAQ,CAAC,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,iCAAiC,EAAE,EAAE,CAAC;;gDAClE;AAY/B;IADC,QAAQ,CAAC,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,gCAAgC,EAAE,EAAE,CAAC;;8CACnE"}

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

@@ -1,18 +1,31 @@
 import type { ActionOutputs, EnhancedModuleSchema, UnknownModule } from '../app.type.js';
 import type { Diff } from '../functions/diff/diff.js';
 /**
- * Model Actions are translation functions between Diff and underlying resources.
- * These actions can translate a specific type of Diff into individual resources.
+ * A model action translates a change in intent into resources.
+ *
+ * Octo diffs your models, and for every {@link Diff} it produces it asks each registered action
+ * whether the diff is its concern. The actions that accept it declare the resources that change
+ * has to bring about. This is the only place a model becomes infrastructure.
+ *
+ * Register the class with {@link Action}, and a {@link Factory} to construct it.
  *
  * @group Models
+ *
+ * @see Definition of [Actions](/docs/fundamentals/actions).
  */
 export interface IModelAction<T extends UnknownModule> {
     /**
-     * This function determines if the handle is applicable to the diff.
+     * Whether this action handles the given diff.
+     * Typically a check on the diff's node, field, and action.
      */
     filter(diff: Diff): boolean;
     /**
-     * This function contains the logic to apply the diff(s) to the underlying infrastructure.
+     * Declares the resources this diff calls for.
+     *
+     * @param diff The diff that passed {@link IModelAction.filter}.
+     * @param actionInputs The module's inputs, metadata, and the nodes it produced.
+     * @param actionOutputs The resources declared so far by earlier actions in this transaction.
+     * @returns `actionOutputs`, with this action's resources added.
      */
     handle(diff: Diff, actionInputs: EnhancedModuleSchema<T>, actionOutputs: ActionOutputs): Promise<ActionOutputs>;
 }

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

@@ -6,35 +6,130 @@ import type { BaseOverlaySchema } from '../overlays/overlay.schema.js';
 import type { BaseResourceSchema } from '../resources/resource.schema.js';
 import type { IModel } from './model.interface.js';
 /**
+ * The base class of every model - the nodes that describe your infrastructure as *intent*,
+ * before any cloud resource is involved.
+ *
+ * You rarely extend `AModel` directly. Extend one of the base models Octo ships - {@link App},
+ * {@link Region}, {@link Server}, and so on - so that the rest of the ecosystem knows what your
+ * model is. `AModel` is where the behavior common to all of them lives: anchors, and the queries a
+ * module uses to find what other modules have already built.
+ *
  * @group Models
+ *
+ * @see Definition of [Models](/docs/fundamentals/models).
  */
 export declare abstract class AModel<S, T extends UnknownModel> extends ANode<S, T> implements IModel<S, T> {
+    /**
+     * The anchors attached to this model, whether declared on it or borrowed from another model.
+     */
     readonly anchors: (MatchingAnchor<BaseAnchorSchema> | UnknownAnchor)[];
+    /**
+     * @internal
+     */
+    static unSynth(...args: unknown[]): Promise<UnknownModel>;
+    /**
+     * To attach an {@link AAnchor} to this model.
+     * An anchor is only added once - re-adding the same anchor, identified by its ID and parent, throws.
+     */
     addAnchor(anchor: MatchingAnchor<BaseAnchorSchema> | UnknownAnchor): void;
+    /**
+     * @internal
+     */
     deriveDependencyField(): string | undefined;
+    /**
+     * @internal
+     */
     diff(): Promise<Diff[]>;
+    /**
+     * @internal
+     */
     diffProperties(): Promise<Diff[]>;
+    /**
+     * To get an attached anchor by its ID.
+     *
+     * @param anchorId The ID of the anchor.
+     * @param parent The model that declared the anchor. Defaults to self.
+     */
     getAnchor(anchorId: string, parent?: UnknownModel): UnknownAnchor | undefined;
+    /**
+     * The position of an attached anchor in {@link AModel.anchors}, or `-1` when it is not attached.
+     *
+     * @param anchorId The ID of the anchor.
+     * @param parent The model that declared the anchor. Defaults to self.
+     */
     getAnchorIndex(anchorId: string, parent?: UnknownModel): number;
+    /**
+     * To get all attached anchors, narrowed by anchor class and/or by the value of their properties.
+     *
+     * @param filters Each filter is a property `key` the anchor must carry with the given `value`.
+     * @param types The anchor classes to keep. An empty list keeps every class.
+     */
     getAnchors(filters?: {
         key: string;
         value: unknown;
     }[], types?: Constructable<MatchingAnchor<BaseAnchorSchema> | UnknownAnchor>[]): UnknownAnchor[];
+    /**
+     * To find anchors by their *schema* rather than by their class.
+     *
+     * This is how a module consumes what another module produced without importing its classes -
+     * you match on the shape you need, and any anchor satisfying that shape is returned.
+     * Anchors that do not satisfy the schema are skipped, not reported as errors.
+     *
+     * @param from The anchor schema to match against.
+     * @param propertyFilters Each filter is a property `key` the anchor must carry with the given `value`.
+     * @param options `searchBoundaryMembers` searches the whole boundary this model belongs to.
+     * Set it to `false` to search only this model.
+     *
+     * @see Definition of [Anchors](/docs/fundamentals/anchors).
+     */
     getAnchorsMatchingSchema<S extends BaseAnchorSchema>(from: Constructable<S>, propertyFilters?: ObjectKeyValue<S['properties']>[], { searchBoundaryMembers }?: {
         searchBoundaryMembers?: boolean;
     }): Promise<MatchingAnchor<S>[]>;
+    /**
+     * To find models by their schema. See {@link AModel.getAnchorsMatchingSchema}.
+     *
+     * @param schema The model schema to match against.
+     * @param filters Each filter is a schema `key` the model must carry with the given `value`.
+     * @param options `searchBoundaryMembers` searches the whole boundary this model belongs to.
+     * Set it to `false` to search only this model.
+     */
     getModelsMatchingSchema<S extends object>(schema: Constructable<S>, filters?: ObjectKeyValue<S>[], { searchBoundaryMembers }?: {
         searchBoundaryMembers?: boolean;
     }): Promise<MatchingModel<S>[]>;
+    /**
+     * To find overlays by their schema. See {@link AModel.getAnchorsMatchingSchema}.
+     *
+     * @param schema The overlay schema to match against.
+     * @param propertyFilters Each filter is a property `key` the overlay must carry with the given `value`.
+     * @param options `searchBoundaryMembers` searches the whole boundary this model belongs to.
+     * Set it to `false` to search only this model.
+     */
     getOverlaysMatchingSchema<S extends BaseOverlaySchema>(schema: Constructable<S>, propertyFilters?: ObjectKeyValue<S['properties']>[], { searchBoundaryMembers }?: {
         searchBoundaryMembers?: boolean;
     }): Promise<MatchingModel<S>[]>;
+    /**
+     * To find resources by their schema. See {@link AModel.getAnchorsMatchingSchema}.
+     *
+     * Only resources produced by the modules that own the searched models are considered, so this
+     * returns another module's resources rather than every resource in the run.
+     *
+     * @param schema The resource schema to match against.
+     * @param propertyFilters Each filter is a property `key` the resource must carry with the given `value`.
+     * @param responseFilters Each filter is a response `key` the resource must carry with the given `value`.
+     * @param options `searchBoundaryMembers` searches the whole boundary this model belongs to.
+     * Set it to `false` to search only this model.
+     */
     getResourcesMatchingSchema<S extends BaseResourceSchema>(schema: Constructable<S>, propertyFilters?: ObjectKeyValue<S['properties']>[], responseFilters?: ObjectKeyValue<S['response']>[], { searchBoundaryMembers }?: {
         searchBoundaryMembers?: boolean;
     }): Promise<MatchingResource<S>[]>;
+    /**
+     * To detach every anchor from this model.
+     */
     removeAllAnchors(): void;
+    /**
+     * To detach an anchor from this model. Detaching an anchor that is not attached is a no-op.
+     */
     removeAnchor(anchor: MatchingAnchor<BaseAnchorSchema> | UnknownAnchor): void;
     abstract setContext(): string | undefined;
     abstract synth(): S;
-    static unSynth(...args: unknown[]): Promise<UnknownModel>;
 }