@quadnix/octo 0.0.30 → 0.2.0

package/dist/app.type.js

@@ -1,48 +1,96 @@
 /* Classes */
 /**
+ * An anchor found by schema, paired with the translation needed to read it as that schema.
+ *
+ * {@link AModel.getAnchorsMatchingSchema} returns these rather than raw anchors: the anchor you
+ * matched may have been declared against a different version of the schema, and this is what keeps
+ * that difference out of your module. Read it with `getSchemaInstance()`.
+ *
  * @group Types
  */
 export class MatchingAnchor {
+    /**
+     * @param actual The anchor that was matched.
+     * @param schemaTranslator Reads `actual` as the matched schema, when the two differ.
+     */
     constructor(actual, schemaTranslator) {
         this.actual = actual;
         this.schemaTranslator = schemaTranslator;
     }
-    hasSchemaTranslator() {
-        return !!this.schemaTranslator;
-    }
+    /**
+     * The anchor itself, with its properties hidden - read those through
+     * {@link MatchingAnchor.getSchemaInstance}.
+     */
     getActual() {
         return this.actual;
     }
+    /**
+     * The anchor read as the schema you matched on.
+     */
     getSchemaInstance() {
         return this.hasSchemaTranslator() ? this.schemaTranslator(this.actual.synth()) : this.actual.synth();
     }
+    /**
+     * Whether the match went through a schema translation.
+     */
+    hasSchemaTranslator() {
+        return !!this.schemaTranslator;
+    }
 }
 /**
+ * A model found by schema. See {@link MatchingAnchor}.
+ *
  * @group Types
  */
 export class MatchingModel {
+    /**
+     * @param actual The model that was matched.
+     * @param schemaTranslator Reads `actual` as the matched schema, when the two differ.
+     */
     constructor(actual, schemaTranslator) {
         this.actual = actual;
         this.schemaTranslator = schemaTranslator;
     }
-    hasSchemaTranslator() {
-        return !!this.schemaTranslator;
-    }
+    /**
+     * The model itself, with its schema hidden - read it through
+     * {@link MatchingModel.getSchemaInstance}.
+     */
     getActual() {
         return this.actual;
     }
+    /**
+     * The model read as the schema you matched on.
+     */
     getSchemaInstance() {
         return this.hasSchemaTranslator() ? this.schemaTranslator(this.actual.synth()) : this.actual.synth();
     }
+    /**
+     * Whether the match went through a schema translation.
+     */
+    hasSchemaTranslator() {
+        return !!this.schemaTranslator;
+    }
 }
 /**
+ * A resource found by schema. See {@link MatchingAnchor}.
+ *
+ * Pass one wherever a resource parent is expected, and the translation is carried into the graph, so
+ * the child keeps reading its parent through the schema it was written against.
+ *
  * @group Types
  */
 export class MatchingResource {
+    /**
+     * @param actual The resource that was matched.
+     * @param schemaTranslator Reads `actual` as the matched schema, when the two differ.
+     */
     constructor(actual, schemaTranslator) {
         this.actual = actual;
         this.schemaTranslator = schemaTranslator;
     }
+    /**
+     * @internal
+     */
     addChild(...args) {
         const results = this.actual.addChild(...args);
         if (!(args[1].parents[args[1].parents.length - 1] instanceof MatchingResource) &&
@@ -52,18 +100,32 @@ export class MatchingResource {
         }
         return results;
     }
-    hasSchemaTranslator() {
-        return !!this.schemaTranslator;
-    }
+    /**
+     * The resource itself, with its schema hidden - read it through
+     * {@link MatchingResource.getSchemaInstance}.
+     */
     getActual() {
         return this.actual;
     }
+    /**
+     * The resource read as the schema you matched on.
+     */
     getSchemaInstance() {
         return this.hasSchemaTranslator() ? this.schemaTranslator(this.actual.synth()) : this.actual.synth();
     }
+    /**
+     * The resource read as the schema you matched on, with its `response` typed as fully populated.
+     * Only call it from a resource action, where the parent is guaranteed to already exist.
+     */
     getSchemaInstanceInResourceAction() {
         return this.getSchemaInstance();
     }
+    /**
+     * Whether the match went through a schema translation.
+     */
+    hasSchemaTranslator() {
+        return !!this.schemaTranslator;
+    }
 }
 /* Enumerations */
 /**
@@ -91,12 +153,21 @@ export var ValidationType;
 })(ValidationType || (ValidationType = {}));
 /* Functions */
 /**
+ * Whether a node was registered under the given name, e.g. `region`.
+ *
+ * Use it to identify a base model without importing the subclass that implements it.
+ *
  * @group Types
  */
 export function hasNodeName(node, nodeName) {
     return node.constructor.NODE_NAME === nodeName;
 }
 /**
+ * Marks a placeholder value that a later step fills in - typically a resource property whose real
+ * value is only known once the infrastructure exists.
+ *
+ * It is a type assertion and nothing more; it emits the string you give it.
+ *
  * @group Types
  */
 export function stub(value) {

package/dist/app.type.js.map

@@ -1 +1 @@
-{"version":3,"file":"app.type.js","sourceRoot":"","sources":["../src/app.type.ts"],"names":[],"mappings":"AAeA,aAAa;AAEb;;GAEG;AACH,MAAM,OAAO,cAAc;IACzB,YACmB,MAAuB,EACvB,gBAAoC;QADpC,WAAM,GAAN,MAAM,CAAiB;QACvB,qBAAgB,GAAhB,gBAAgB,CAAoB;IACpD,CAAC;IAEJ,mBAAmB;QACjB,OAAO,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC;IACjC,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,iBAAiB;QACf,OAAO,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAE,IAAI,CAAC,MAAM,CAAC,KAAK,EAAQ,CAAC;IAC/G,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,aAAa;IACxB,YACmB,MAAsB,EACtB,gBAAoC;QADpC,WAAM,GAAN,MAAM,CAAgB;QACtB,qBAAgB,GAAhB,gBAAgB,CAAoB;IACpD,CAAC;IAEJ,mBAAmB;QACjB,OAAO,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC;IACjC,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,iBAAiB;QACf,OAAO,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAE,IAAI,CAAC,MAAM,CAAC,KAAK,EAAQ,CAAC;IAC/G,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,gBAAgB;IAC3B,YACmB,MAAyB,EACjC,gBAAmD;QAD3C,WAAM,GAAN,MAAM,CAAmB;QACjC,qBAAgB,GAAhB,gBAAgB,CAAmC;IAC3D,CAAC;IAEJ,QAAQ,CACN,GAAG,IAAgE;QAEnE,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC;QAE9C,IACE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,YAAY,gBAAgB,CAAC;YACzE,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAqB,CAAC,UAAU,KAAK,IAAI,CAAC,SAAS,EAAE,CAAC,UAAU,EAC3G,CAAC;YACD,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;YACtB,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7B,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,mBAAmB;QACjB,OAAO,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC;IACjC,CAAC;IAED,SAAS;QAMP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,iBAAiB;QACf,OAAO,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAE,IAAI,CAAC,MAAM,CAAC,KAAK,EAAQ,CAAC;IAC/G,CAAC;IAED,iCAAiC;QAC/B,OAAO,IAAI,CAAC,iBAAiB,EAA4E,CAAC;IAC5G,CAAC;CACF;AAED,kBAAkB;AAElB;;GAEG;AACH,MAAM,CAAN,IAAY,QAIX;AAJD,WAAY,QAAQ;IAClB,2BAAe,CAAA;IACf,+BAAmB,CAAA;IACnB,iCAAqB,CAAA;AACvB,CAAC,EAJW,QAAQ,KAAR,QAAQ,QAInB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,cASX;AATD,WAAY,cAAc;IACxB,mCAAiB,CAAA;IACjB,sCAAoB,CAAA;IACpB,0CAAwB,CAAA;IACxB,4CAA0B,CAAA;IAC1B,wCAAsB,CAAA;IACtB,0CAAwB,CAAA;IACxB,0CAAwB,CAAA;IACxB,iCAAe,CAAA;AACjB,CAAC,EATW,cAAc,KAAd,cAAc,QASzB;AAgBD,eAAe;AAEf;;GAEG;AACH,MAAM,UAAU,WAAW,CAAC,IAAiB,EAAE,QAAgB;IAC7D,OAAQ,IAAI,CAAC,WAA4B,CAAC,SAAS,KAAK,QAAQ,CAAC;AACnE,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,IAAI,CAAI,KAAa;IACnC,OAAO,KAAU,CAAC;AACpB,CAAC"}
+{"version":3,"file":"app.type.js","sourceRoot":"","sources":["../src/app.type.ts"],"names":[],"mappings":"AA2BA,aAAa;AAEb;;;;;;;;GAQG;AACH,MAAM,OAAO,cAAc;IACzB;;;OAGG;IACH,YACmB,MAAuB,EACvB,gBAAoC;QADpC,WAAM,GAAN,MAAM,CAAiB;QACvB,qBAAgB,GAAhB,gBAAgB,CAAoB;IACpD,CAAC;IAEJ;;;OAGG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;OAEG;IACH,iBAAiB;QACf,OAAO,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAE,IAAI,CAAC,MAAM,CAAC,KAAK,EAAQ,CAAC;IAC/G,CAAC;IAED;;OAEG;IACH,mBAAmB;QACjB,OAAO,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC;IACjC,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,aAAa;IACxB;;;OAGG;IACH,YACmB,MAAsB,EACtB,gBAAoC;QADpC,WAAM,GAAN,MAAM,CAAgB;QACtB,qBAAgB,GAAhB,gBAAgB,CAAoB;IACpD,CAAC;IAEJ;;;OAGG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;OAEG;IACH,iBAAiB;QACf,OAAO,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAE,IAAI,CAAC,MAAM,CAAC,KAAK,EAAQ,CAAC;IAC/G,CAAC;IAED;;OAEG;IACH,mBAAmB;QACjB,OAAO,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC;IACjC,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,OAAO,gBAAgB;IAC3B;;;OAGG;IACH,YACmB,MAAyB,EACjC,gBAAmD;QAD3C,WAAM,GAAN,MAAM,CAAmB;QACjC,qBAAgB,GAAhB,gBAAgB,CAAmC;IAC3D,CAAC;IAEJ;;OAEG;IACH,QAAQ,CACN,GAAG,IAAgE;QAEnE,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC;QAE9C,IACE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,YAAY,gBAAgB,CAAC;YACzE,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAqB,CAAC,UAAU,KAAK,IAAI,CAAC,SAAS,EAAE,CAAC,UAAU,EAC3G,CAAC;YACD,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;YACtB,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7B,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;OAGG;IACH,SAAS;QAMP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;OAEG;IACH,iBAAiB;QACf,OAAO,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAE,IAAI,CAAC,MAAM,CAAC,KAAK,EAAQ,CAAC;IAC/G,CAAC;IAED;;;OAGG;IACH,iCAAiC;QAC/B,OAAO,IAAI,CAAC,iBAAiB,EAA4E,CAAC;IAC5G,CAAC;IAED;;OAEG;IACH,mBAAmB;QACjB,OAAO,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC;IACjC,CAAC;CACF;AAED,kBAAkB;AAElB;;GAEG;AACH,MAAM,CAAN,IAAY,QAIX;AAJD,WAAY,QAAQ;IAClB,2BAAe,CAAA;IACf,+BAAmB,CAAA;IACnB,iCAAqB,CAAA;AACvB,CAAC,EAJW,QAAQ,KAAR,QAAQ,QAInB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,cASX;AATD,WAAY,cAAc;IACxB,mCAAiB,CAAA;IACjB,sCAAoB,CAAA;IACpB,0CAAwB,CAAA;IACxB,4CAA0B,CAAA;IAC1B,wCAAsB,CAAA;IACtB,0CAAwB,CAAA;IACxB,0CAAwB,CAAA;IACxB,iCAAe,CAAA;AACjB,CAAC,EATW,cAAc,KAAd,cAAc,QASzB;AAgBD,eAAe;AAEf;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CAAC,IAAiB,EAAE,QAAgB;IAC7D,OAAQ,IAAI,CAAC,WAA4B,CAAC,SAAS,KAAK,QAAQ,CAAC;AACnE,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,IAAI,CAAI,KAAa;IACnC,OAAO,KAAU,CAAC;AACpB,CAAC"}

package/dist/decorators/action.decorator.d.ts

@@ -1,14 +1,18 @@
 import type { Constructable, UnknownNode } from '../app.type.js';
 /**
- * An `@Action` is a class decorator to be placed on top of a class that represents an action of one of ModelType.
- * - A NodeType.MODEL action must implement the {@link IModelAction} interface.
- * - A NodeType.OVERLAY action must implement the {@link IModelAction} interface.
- * - A NodeType.RESOURCE action must implement the {@link IResourceAction} interface.
+ * An `@Action` is a class decorator to be placed on top of a class that reacts to a change in the node it is
+ * declared for. Octo diffs your infrastructure on every run, and invokes the actions whose node changed.
+ *
+ * The interface the action implements is determined by the node it is declared for.
+ * - An action for a model or an overlay implements {@link IModelAction}, and produces resources.
+ * - An action for a resource implements {@link IResourceAction}, and talks to the cloud provider.
+ *
+ * The decorated class is resolved through the {@link Container}, so it must have a registered {@link Factory}.
  *
  * @example
  * ```ts
- * @Action(MyModelClass)
- * export class MyModelAction implements IModelAction { ... }
+ * @Action(MyModel)
+ * export class AddMyModelAction implements IModelAction<MyModule> { ... }
  * ```
  * @group Decorators
  * @param forNode The class of node for which this action is being declared.

package/dist/decorators/action.decorator.js

@@ -5,25 +5,38 @@ import { AModel } from '../models/model.abstract.js';
 import { AOverlay } from '../overlays/overlay.abstract.js';
 import { AResource } from '../resources/resource.abstract.js';
 import { TransactionService } from '../services/transaction/transaction.service.js';
+/**
+ * @internal
+ */
 function isModel(nodeClass) {
     return nodeClass.prototype instanceof AModel;
 }
+/**
+ * @internal
+ */
 function isOverlay(nodeClass) {
     return nodeClass.prototype instanceof AOverlay;
 }
+/**
+ * @internal
+ */
 function isResource(nodeClass) {
     return nodeClass.prototype instanceof AResource;
 }
 /**
- * An `@Action` is a class decorator to be placed on top of a class that represents an action of one of ModelType.
- * - A NodeType.MODEL action must implement the {@link IModelAction} interface.
- * - A NodeType.OVERLAY action must implement the {@link IModelAction} interface.
- * - A NodeType.RESOURCE action must implement the {@link IResourceAction} interface.
+ * An `@Action` is a class decorator to be placed on top of a class that reacts to a change in the node it is
+ * declared for. Octo diffs your infrastructure on every run, and invokes the actions whose node changed.
+ *
+ * The interface the action implements is determined by the node it is declared for.
+ * - An action for a model or an overlay implements {@link IModelAction}, and produces resources.
+ * - An action for a resource implements {@link IResourceAction}, and talks to the cloud provider.
+ *
+ * The decorated class is resolved through the {@link Container}, so it must have a registered {@link Factory}.
  *
  * @example
  * ```ts
- * @Action(MyModelClass)
- * export class MyModelAction implements IModelAction { ... }
+ * @Action(MyModel)
+ * export class AddMyModelAction implements IModelAction<MyModule> { ... }
  * ```
  * @group Decorators
  * @param forNode The class of node for which this action is being declared.

package/dist/decorators/action.decorator.js.map

@@ -1 +1 @@
-{"version":3,"file":"action.decorator.js","sourceRoot":"","sources":["../../src/decorators/action.decorator.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,EAAE,eAAe,EAAE,MAAM,wCAAwC,CAAC;AACzE,OAAO,EAAE,kBAAkB,EAAE,MAAM,2CAA2C,CAAC;AAC/E,OAAO,EAAE,MAAM,EAAE,MAAM,6BAA6B,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3D,OAAO,EAAE,SAAS,EAAE,MAAM,mCAAmC,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,gDAAgD,CAAC;AAEpF,SAAS,OAAO,CAAC,SAAqC;IACpD,OAAO,SAAS,CAAC,SAAS,YAAY,MAAM,CAAC;AAC/C,CAAC;AAED,SAAS,SAAS,CAAC,SAAqC;IACtD,OAAO,SAAS,CAAC,SAAS,YAAY,QAAQ,CAAC;AACjD,CAAC;AAED,SAAS,UAAU,CAAC,SAAqC;IACvD,OAAO,SAAS,CAAC,SAAS,YAAY,SAAS,CAAC;AAClD,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,MAAM,CAAwB,OAAyB;IACrE,MAAM,SAAS,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;IAE1C,OAAO,UAAU,WAAgB;QAC/B,MAAM,OAAO,GAAG,SAAS,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,kBAAkB,EAAE,EAAE;YAClF,IAAI,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC5C,yBAAyB;gBACzB,MAAM,WAAW,GAAG,MAAM,SAAS,CAAC,GAAG,CAAsB,WAAW,CAAC,IAAI,CAAC,CAAC;gBAC/E,kBAAkB,CAAC,oBAAoB,CAAC,OAAO,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;gBAEhE,gCAAgC;gBAChC,eAAe,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;YACvD,CAAC;iBAAM,IAAI,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC9B,2BAA2B;gBAC3B,MAAM,WAAW,GAAG,MAAM,SAAS,CAAC,GAAG,CAAsB,WAAW,CAAC,IAAI,CAAC,CAAC;gBAC/E,kBAAkB,CAAC,sBAAsB,CAAC,OAAO,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;gBAElE,kCAAkC;gBAClC,eAAe,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;YACvD,CAAC;iBAAM,IAAI,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC/B,4BAA4B;gBAC5B,MAAM,cAAc,GAAG,MAAM,SAAS,CAAC,GAAG,CAAyB,WAAW,CAAC,IAAI,CAAC,CAAC;gBACrF,kBAAkB,CAAC,uBAAuB,CAAC,OAAO,EAAE,CAAC,cAAc,CAAC,CAAC,CAAC;gBAEtE,mCAAmC;gBACnC,kBAAkB,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;YAC7D,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CAAC,UAAU,OAAO,CAAC,IAAI,2CAA2C,CAAC,CAAC;YACrF,CAAC;QACH,CAAC,CAAC,CAAC;QACH,SAAS,CAAC,+BAA+B,CAAC,OAAO,CAAC,CAAC;IACrD,CAAC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"action.decorator.js","sourceRoot":"","sources":["../../src/decorators/action.decorator.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,EAAE,eAAe,EAAE,MAAM,wCAAwC,CAAC;AACzE,OAAO,EAAE,kBAAkB,EAAE,MAAM,2CAA2C,CAAC;AAC/E,OAAO,EAAE,MAAM,EAAE,MAAM,6BAA6B,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3D,OAAO,EAAE,SAAS,EAAE,MAAM,mCAAmC,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,gDAAgD,CAAC;AAEpF;;GAEG;AACH,SAAS,OAAO,CAAC,SAAqC;IACpD,OAAO,SAAS,CAAC,SAAS,YAAY,MAAM,CAAC;AAC/C,CAAC;AAED;;GAEG;AACH,SAAS,SAAS,CAAC,SAAqC;IACtD,OAAO,SAAS,CAAC,SAAS,YAAY,QAAQ,CAAC;AACjD,CAAC;AAED;;GAEG;AACH,SAAS,UAAU,CAAC,SAAqC;IACvD,OAAO,SAAS,CAAC,SAAS,YAAY,SAAS,CAAC;AAClD,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,MAAM,CAAwB,OAAyB;IACrE,MAAM,SAAS,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;IAE1C,OAAO,UAAU,WAAgB;QAC/B,MAAM,OAAO,GAAG,SAAS,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,kBAAkB,EAAE,EAAE;YAClF,IAAI,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC5C,yBAAyB;gBACzB,MAAM,WAAW,GAAG,MAAM,SAAS,CAAC,GAAG,CAAsB,WAAW,CAAC,IAAI,CAAC,CAAC;gBAC/E,kBAAkB,CAAC,oBAAoB,CAAC,OAAO,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;gBAEhE,gCAAgC;gBAChC,eAAe,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;YACvD,CAAC;iBAAM,IAAI,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC9B,2BAA2B;gBAC3B,MAAM,WAAW,GAAG,MAAM,SAAS,CAAC,GAAG,CAAsB,WAAW,CAAC,IAAI,CAAC,CAAC;gBAC/E,kBAAkB,CAAC,sBAAsB,CAAC,OAAO,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;gBAElE,kCAAkC;gBAClC,eAAe,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;YACvD,CAAC;iBAAM,IAAI,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC/B,4BAA4B;gBAC5B,MAAM,cAAc,GAAG,MAAM,SAAS,CAAC,GAAG,CAAyB,WAAW,CAAC,IAAI,CAAC,CAAC;gBACrF,kBAAkB,CAAC,uBAAuB,CAAC,OAAO,EAAE,CAAC,cAAc,CAAC,CAAC,CAAC;gBAEtE,mCAAmC;gBACnC,kBAAkB,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;YAC7D,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CAAC,UAAU,OAAO,CAAC,IAAI,2CAA2C,CAAC,CAAC;YACrF,CAAC;QACH,CAAC,CAAC,CAAC;QACH,SAAS,CAAC,+BAA+B,CAAC,OAAO,CAAC,CAAC;IACrD,CAAC,CAAC;AACJ,CAAC"}

package/dist/decorators/anchor.decorator.d.ts

@@ -1,14 +1,21 @@
 /**
- * An `@Anchor` is a class decorator to be placed on top of a class that represents an anchor.
- * - An anchor must extend the {@link AAnchor} class.
+ * An `@Anchor` is a class decorator and must be placed on top of a class representing an anchor.
+ * - An anchor must also extend the {@link AAnchor} class.
  *
  * @example
  * ```ts
- * @Anchor('my-package')
- * export class MyAnchor extends AAnchor { ... }
+ * @Anchor('@example')
+ * export class MyAnchor extends AAnchor<MyAnchorSchema, MyModel> { ... }
  * ```
+ *
  * @group Decorators
+ *
+ * @param packageName - The name of the package under which the anchor is registered.
+ * Selecting a unique package name helps avoid collisions between same anchor class names across different libraries.
+ * You will reuse the same package name throughout your library for different Octo components you create.
+ *
  * @returns The decorated class.
- * @see Definition of [Anchors](/docs/fundamentals/overlays).
+ *
+ * @see Definition of [Anchors](/docs/fundamentals/anchors).
  */
 export declare function Anchor(packageName: string): (constructor: any) => void;

package/dist/decorators/anchor.decorator.js

@@ -3,17 +3,24 @@ import { AAnchor } from '../overlays/anchor.abstract.js';
 import { ModelSerializationService } from '../services/serialization/model/model-serialization.service.js';
 import { ValidationUtility } from '../utilities/validation/validation.utility.js';
 /**
- * An `@Anchor` is a class decorator to be placed on top of a class that represents an anchor.
- * - An anchor must extend the {@link AAnchor} class.
+ * An `@Anchor` is a class decorator and must be placed on top of a class representing an anchor.
+ * - An anchor must also extend the {@link AAnchor} class.
  *
  * @example
  * ```ts
- * @Anchor('my-package')
- * export class MyAnchor extends AAnchor { ... }
+ * @Anchor('@example')
+ * export class MyAnchor extends AAnchor<MyAnchorSchema, MyModel> { ... }
  * ```
+ *
  * @group Decorators
+ *
+ * @param packageName - The name of the package under which the anchor is registered.
+ * Selecting a unique package name helps avoid collisions between same anchor class names across different libraries.
+ * You will reuse the same package name throughout your library for different Octo components you create.
+ *
  * @returns The decorated class.
- * @see Definition of [Anchors](/docs/fundamentals/overlays).
+ *
+ * @see Definition of [Anchors](/docs/fundamentals/anchors).
  */
 export function Anchor(packageName) {
     const container = Container.getInstance();

package/dist/decorators/anchor.decorator.js.map

@@ -1 +1 @@
-{"version":3,"file":"anchor.decorator.js","sourceRoot":"","sources":["../../src/decorators/anchor.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,EAAE,OAAO,EAAE,MAAM,gCAAgC,CAAC;AACzD,OAAO,EAAE,yBAAyB,EAAE,MAAM,gEAAgE,CAAC;AAC3G,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAElF;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,MAAM,CAAC,WAAmB;IACxC,MAAM,SAAS,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;IAE1C,OAAO,UAAU,WAAgB;QAC/B,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,WAAW,EAAE,2BAA2B,CAAC,EAAE,CAAC;YAC/E,MAAM,IAAI,KAAK,CAAC,yBAAyB,WAAW,EAAE,CAAC,CAAC;QAC1D,CAAC;QACD,IAAI,CAAC,CAAC,WAAW,CAAC,SAAS,YAAY,OAAO,CAAC,EAAE,CAAC;YAChD,MAAM,IAAI,KAAK,CAAC,UAAU,WAAW,CAAC,IAAI,kCAAkC,CAAC,CAAC;QAChF,CAAC;QAED,WAAW,CAAC,YAAY,GAAG,WAAW,CAAC;QAEvC,MAAM,OAAO,GAAG,SAAS,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC,IAAI,CAAC,CAAC,yBAAyB,EAAE,EAAE;YAC1F,yBAAyB,CAAC,aAAa,CAAC,GAAG,WAAW,IAAI,WAAW,CAAC,IAAI,EAAE,EAAE,WAAW,CAAC,CAAC;QAC7F,CAAC,CAAC,CAAC;QACH,SAAS,CAAC,+BAA+B,CAAC,OAAO,CAAC,CAAC;IACrD,CAAC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"anchor.decorator.js","sourceRoot":"","sources":["../../src/decorators/anchor.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,EAAE,OAAO,EAAE,MAAM,gCAAgC,CAAC;AACzD,OAAO,EAAE,yBAAyB,EAAE,MAAM,gEAAgE,CAAC;AAC3G,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAElF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,MAAM,CAAC,WAAmB;IACxC,MAAM,SAAS,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;IAE1C,OAAO,UAAU,WAAgB;QAC/B,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,WAAW,EAAE,2BAA2B,CAAC,EAAE,CAAC;YAC/E,MAAM,IAAI,KAAK,CAAC,yBAAyB,WAAW,EAAE,CAAC,CAAC;QAC1D,CAAC;QACD,IAAI,CAAC,CAAC,WAAW,CAAC,SAAS,YAAY,OAAO,CAAC,EAAE,CAAC;YAChD,MAAM,IAAI,KAAK,CAAC,UAAU,WAAW,CAAC,IAAI,kCAAkC,CAAC,CAAC;QAChF,CAAC;QAED,WAAW,CAAC,YAAY,GAAG,WAAW,CAAC;QAEvC,MAAM,OAAO,GAAG,SAAS,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC,IAAI,CAAC,CAAC,yBAAyB,EAAE,EAAE;YAC1F,yBAAyB,CAAC,aAAa,CAAC,GAAG,WAAW,IAAI,WAAW,CAAC,IAAI,EAAE,EAAE,WAAW,CAAC,CAAC;QAC7F,CAAC,CAAC,CAAC;QACH,SAAS,CAAC,+BAA+B,CAAC,OAAO,CAAC,CAAC;IACrD,CAAC,CAAC;AACJ,CAAC"}

package/dist/decorators/enable-hook.decorator.d.ts

@@ -16,7 +16,7 @@ type Hook = 'CommitHook';
  *
  * @returns The decorated method.
  *
- * @see Definition of [Hooks](/docs/fundamentals/modules#hooks).
+ * @see Definition of [Hooks](/docs/techniques/hooks).
  */
 export declare function EnableHook(hook: Hook): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
 export {};

package/dist/decorators/enable-hook.decorator.js

@@ -16,7 +16,7 @@ import { CommitHook } from '../functions/hook/commit.hook.js';
  *
  * @returns The decorated method.
  *
- * @see Definition of [Hooks](/docs/fundamentals/modules#hooks).
+ * @see Definition of [Hooks](/docs/techniques/hooks).
  */
 export function EnableHook(hook) {
     return function (_target, _propertyKey, descriptor) {

package/dist/decorators/factory.decorator.d.ts

@@ -1,61 +1,45 @@
 import type { Constructable } from '../app.type.js';
 /**
  * A `@Factory` is a class decorator to be placed on top of a class that represents a factory.
- * A factory is responsible for creating instances of a class.
+ * A factory is responsible for creating instances of a class - Octo resolves every service through one
+ * rather than calling `new`, which is what lets you swap an internal implementation for your own.
  *
- * It is possible to generate multiple factories for the same class
- * by assigning a unique set of metadata to the factory.
- * Of all registered factories, only one can be the default factory.
+ * The same class may have several factories, told apart by their metadata.
+ * The factory registered without metadata is the default.
  *
  * @example
  * ```ts
  * // Factory definition.
  * @Factory<MyService>(MyService, { metadata: { key: 'value' } })
  * export class MyServiceFactory {
- *   static async create(arg1, arg2, ...): Promise<MyService> { ... }
+ *   static async create(arg1, arg2): Promise<MyService> { ... }
  * }
  *
+ * const container = Container.getInstance();
+ *
  * // Get instance using default factory.
- * const myService = await Container.get(MyService);
+ * const myService = await container.get(MyService);
  *
  * // Get instance using specific factory.
- * const myService = await Container.get(MyService, { metadata: { key: 'value' } });
+ * const myService = await container.get(MyService, { metadata: { key: 'value' } });
  *
  * // Pass args to factory.
- * const myService = await Container.get(MyService, { args: [arg1, arg2, ...] });
+ * const myService = await container.get(MyService, { args: [arg1, arg2] });
  * ```
  * @group Decorators
  * @param type The type of class that the factory creates.
  * @param options Allows registering multiple factories for the same class that differ by metadata.
  * @remarks
- * If the factory is dependent on other factories, it should not block creation of its instance.
+ * A factory that produces a singleton must `await` its own dependencies *before* the instance check.
+ * Awaiting inside the check is a race - concurrent callers each pass the check while suspended,
+ * and each gets a different instance.
  * ```ts
- * // Correct, since creation of instance is not blocked.
- * // In this case, when multiple code paths are trying to get Container.get(MyService) at the same time,
- * // each of them will `await` for OtherService to get resolved,
- * // and the first to resolve will be able to create the instance, that the rest will re-use.
- * export class MyServiceFactory {
- *   private static instance: MyService;
- *   static async create(): Promise<MyService> {
- *     const otherInstance = await Container.get(OtherService);
- *     if (!this.instance) {
- *       this.instance = new MyService(otherInstance);
- *     }
- *   }
- * }
- * ```
- * ```ts
- * // Wrong, since creation of instance is blocked.
- * // In this case, when multiple code paths are trying to get Container.get(MyService) at the same time,
- * // each of them will get a new instance since during `await` there is race condition.
- * export class MyServiceFactory {
- *   private static instance: MyService;
- *   static async create(): Promise<MyService> {
- *     if (!this.instance) {
- *       const otherInstance = await Container.get(OtherService);
- *       this.instance = new MyService(otherInstance);
- *     }
+ * static async create(): Promise<MyService> {
+ *   const otherInstance = await Container.get(OtherService); // Await first.
+ *   if (!this.instance) {
+ *     this.instance = new MyService(otherInstance);
  *   }
+ *   return this.instance;
  * }
  * ```
  * @returns The decorated class.

package/dist/decorators/factory.decorator.js

@@ -1,61 +1,45 @@
 import { Container } from '../functions/container/container.js';
 /**
  * A `@Factory` is a class decorator to be placed on top of a class that represents a factory.
- * A factory is responsible for creating instances of a class.
+ * A factory is responsible for creating instances of a class - Octo resolves every service through one
+ * rather than calling `new`, which is what lets you swap an internal implementation for your own.
  *
- * It is possible to generate multiple factories for the same class
- * by assigning a unique set of metadata to the factory.
- * Of all registered factories, only one can be the default factory.
+ * The same class may have several factories, told apart by their metadata.
+ * The factory registered without metadata is the default.
  *
  * @example
  * ```ts
  * // Factory definition.
  * @Factory<MyService>(MyService, { metadata: { key: 'value' } })
  * export class MyServiceFactory {
- *   static async create(arg1, arg2, ...): Promise<MyService> { ... }
+ *   static async create(arg1, arg2): Promise<MyService> { ... }
  * }
  *
+ * const container = Container.getInstance();
+ *
  * // Get instance using default factory.
- * const myService = await Container.get(MyService);
+ * const myService = await container.get(MyService);
  *
  * // Get instance using specific factory.
- * const myService = await Container.get(MyService, { metadata: { key: 'value' } });
+ * const myService = await container.get(MyService, { metadata: { key: 'value' } });
  *
  * // Pass args to factory.
- * const myService = await Container.get(MyService, { args: [arg1, arg2, ...] });
+ * const myService = await container.get(MyService, { args: [arg1, arg2] });
  * ```
  * @group Decorators
  * @param type The type of class that the factory creates.
  * @param options Allows registering multiple factories for the same class that differ by metadata.
  * @remarks
- * If the factory is dependent on other factories, it should not block creation of its instance.
+ * A factory that produces a singleton must `await` its own dependencies *before* the instance check.
+ * Awaiting inside the check is a race - concurrent callers each pass the check while suspended,
+ * and each gets a different instance.
  * ```ts
- * // Correct, since creation of instance is not blocked.
- * // In this case, when multiple code paths are trying to get Container.get(MyService) at the same time,
- * // each of them will `await` for OtherService to get resolved,
- * // and the first to resolve will be able to create the instance, that the rest will re-use.
- * export class MyServiceFactory {
- *   private static instance: MyService;
- *   static async create(): Promise<MyService> {
- *     const otherInstance = await Container.get(OtherService);
- *     if (!this.instance) {
- *       this.instance = new MyService(otherInstance);
- *     }
- *   }
- * }
- * ```
- * ```ts
- * // Wrong, since creation of instance is blocked.
- * // In this case, when multiple code paths are trying to get Container.get(MyService) at the same time,
- * // each of them will get a new instance since during `await` there is race condition.
- * export class MyServiceFactory {
- *   private static instance: MyService;
- *   static async create(): Promise<MyService> {
- *     if (!this.instance) {
- *       const otherInstance = await Container.get(OtherService);
- *       this.instance = new MyService(otherInstance);
- *     }
+ * static async create(): Promise<MyService> {
+ *   const otherInstance = await Container.get(OtherService); // Await first.
+ *   if (!this.instance) {
+ *     this.instance = new MyService(otherInstance);
  *   }
+ *   return this.instance;
  * }
  * ```
  * @returns The decorated class.

package/dist/decorators/factory.decorator.js.map

@@ -1 +1 @@
-{"version":3,"file":"factory.decorator.js","sourceRoot":"","sources":["../../src/decorators/factory.decorator.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4DG;AACH,MAAM,UAAU,OAAO,CACrB,IAA+B,EAC/B,OAEC;IAED,MAAM,SAAS,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;IAE1C,OAAO,UAAU,WAA2D;QAC1E,SAAS,CAAC,eAAe,CAAI,IAAI,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"factory.decorator.js","sourceRoot":"","sources":["../../src/decorators/factory.decorator.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,MAAM,UAAU,OAAO,CACrB,IAA+B,EAC/B,OAEC;IAED,MAAM,SAAS,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;IAE1C,OAAO,UAAU,WAA2D;QAC1E,SAAS,CAAC,eAAe,CAAI,IAAI,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC,CAAC;AACJ,CAAC"}

package/dist/decorators/model.decorator.d.ts

@@ -1,4 +1,4 @@
-import { type Constructable, type ModelSchema, type UnknownModel } from '../app.type.js';
+import { type Constructable, type ModelName, type ModelSchema, type UnknownModel } from '../app.type.js';
 /**
  * A `@Model` is a class decorator and must be placed on top of a class representing a model.
  * - A model must also extend a base model class.
@@ -15,14 +15,12 @@ import { type Constructable, type ModelSchema, type UnknownModel } from '../app.
  * @param packageName - The name of the package under which the model is registered.
  * Selecting a unique package name helps avoid collisions between same model class names across different libraries.
  * You will reuse the same package name throughout your library for different Octo components you create.
- * @param modelName - a string that uniquely represents the base model you are extending.
- * Octo provides names for each of the base models, and you must use the same name.
- * E.g. for region base model, the model name is `region`.
+ * @param modelName - The name of the base model you are extending, e.g. `region` for {@link Region}.
  * @param schema - The schema of the model.
  *
  * @returns The decorated class.
  *
  * @see Definition of [Models](/docs/fundamentals/models).
- * @see {@link App} and {@link Region} are a few base models. More can be found in the same folder.
+ * @see {@link App}, {@link Region}, and {@link Server} for the base models you can extend.
  */
-export declare function Model<T extends UnknownModel>(packageName: string, modelName: string, schema: Constructable<ModelSchema<T>>): (constructor: any) => void;
+export declare function Model<T extends UnknownModel>(packageName: string, modelName: ModelName, schema: Constructable<ModelSchema<T>>): (constructor: any) => void;

package/dist/decorators/model.decorator.js

@@ -20,15 +20,13 @@ import { ValidationUtility } from '../utilities/validation/validation.utility.js
  * @param packageName - The name of the package under which the model is registered.
  * Selecting a unique package name helps avoid collisions between same model class names across different libraries.
  * You will reuse the same package name throughout your library for different Octo components you create.
- * @param modelName - a string that uniquely represents the base model you are extending.
- * Octo provides names for each of the base models, and you must use the same name.
- * E.g. for region base model, the model name is `region`.
+ * @param modelName - The name of the base model you are extending, e.g. `region` for {@link Region}.
  * @param schema - The schema of the model.
  *
  * @returns The decorated class.
  *
  * @see Definition of [Models](/docs/fundamentals/models).
- * @see {@link App} and {@link Region} are a few base models. More can be found in the same folder.
+ * @see {@link App}, {@link Region}, and {@link Server} for the base models you can extend.
  */
 export function Model(packageName, modelName, schema) {
     const container = Container.getInstance();
@@ -36,9 +34,6 @@ export function Model(packageName, modelName, schema) {
         if (!ValidationUtility.validateRegex(packageName, /^[@A-Za-z][\w-]+[A-Za-z]$/)) {
             throw new Error(`Invalid package name: ${packageName}`);
         }
-        if (!ValidationUtility.validateRegex(modelName, /^[A-Za-z][\w-]+[A-Za-z]$/)) {
-            throw new Error(`Invalid model name: ${modelName}`);
-        }
         if (!(constructor.prototype instanceof AModel) || constructor.prototype instanceof AOverlay) {
             throw new Error(`Class "${constructor.name}" must extend the AModel class!`);
         }

package/dist/decorators/model.decorator.js.map

@@ -1 +1 @@
-{"version":3,"file":"model.decorator.js","sourceRoot":"","sources":["../../src/decorators/model.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAwC,QAAQ,EAAqB,MAAM,gBAAgB,CAAC;AACnG,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,EAAE,MAAM,EAAE,MAAM,6BAA6B,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3D,OAAO,EAAE,yBAAyB,EAAE,MAAM,gEAAgE,CAAC;AAC3G,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAElF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,UAAU,KAAK,CACnB,WAAmB,EACnB,SAAiB,EACjB,MAAqC;IAErC,MAAM,SAAS,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;IAE1C,OAAO,UAAU,WAAgB;QAC/B,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,WAAW,EAAE,2BAA2B,CAAC,EAAE,CAAC;YAC/E,MAAM,IAAI,KAAK,CAAC,yBAAyB,WAAW,EAAE,CAAC,CAAC;QAC1D,CAAC;QACD,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,SAAS,EAAE,0BAA0B,CAAC,EAAE,CAAC;YAC5E,MAAM,IAAI,KAAK,CAAC,uBAAuB,SAAS,EAAE,CAAC,CAAC;QACtD,CAAC;QACD,IAAI,CAAC,CAAC,WAAW,CAAC,SAAS,YAAY,MAAM,CAAC,IAAI,WAAW,CAAC,SAAS,YAAY,QAAQ,EAAE,CAAC;YAC5F,MAAM,IAAI,KAAK,CAAC,UAAU,WAAW,CAAC,IAAI,iCAAiC,CAAC,CAAC;QAC/E,CAAC;QAED,WAAW,CAAC,SAAS,GAAG,SAAS,CAAC;QAClC,WAAW,CAAC,YAAY,GAAG,WAAW,CAAC;QACvC,WAAW,CAAC,WAAW,GAAG,MAAM,CAAC;QACjC,WAAW,CAAC,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC;QAEvC,MAAM,OAAO,GAAG,SAAS,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC,IAAI,CAAC,CAAC,yBAAyB,EAAE,EAAE;YAC1F,yBAAyB,CAAC,aAAa,CAAC,GAAG,WAAW,IAAI,WAAW,CAAC,IAAI,EAAE,EAAE,WAAW,CAAC,CAAC;QAC7F,CAAC,CAAC,CAAC;QACH,SAAS,CAAC,+BAA+B,CAAC,OAAO,CAAC,CAAC;IACrD,CAAC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"model.decorator.js","sourceRoot":"","sources":["../../src/decorators/model.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAwD,QAAQ,EAAqB,MAAM,gBAAgB,CAAC;AACnH,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,EAAE,MAAM,EAAE,MAAM,6BAA6B,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3D,OAAO,EAAE,yBAAyB,EAAE,MAAM,gEAAgE,CAAC;AAC3G,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAElF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,UAAU,KAAK,CACnB,WAAmB,EACnB,SAAoB,EACpB,MAAqC;IAErC,MAAM,SAAS,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;IAE1C,OAAO,UAAU,WAAgB;QAC/B,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,WAAW,EAAE,2BAA2B,CAAC,EAAE,CAAC;YAC/E,MAAM,IAAI,KAAK,CAAC,yBAAyB,WAAW,EAAE,CAAC,CAAC;QAC1D,CAAC;QACD,IAAI,CAAC,CAAC,WAAW,CAAC,SAAS,YAAY,MAAM,CAAC,IAAI,WAAW,CAAC,SAAS,YAAY,QAAQ,EAAE,CAAC;YAC5F,MAAM,IAAI,KAAK,CAAC,UAAU,WAAW,CAAC,IAAI,iCAAiC,CAAC,CAAC;QAC/E,CAAC;QAED,WAAW,CAAC,SAAS,GAAG,SAAS,CAAC;QAClC,WAAW,CAAC,YAAY,GAAG,WAAW,CAAC;QACvC,WAAW,CAAC,WAAW,GAAG,MAAM,CAAC;QACjC,WAAW,CAAC,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC;QAEvC,MAAM,OAAO,GAAG,SAAS,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC,IAAI,CAAC,CAAC,yBAAyB,EAAE,EAAE;YAC1F,yBAAyB,CAAC,aAAa,CAAC,GAAG,WAAW,IAAI,WAAW,CAAC,IAAI,EAAE,EAAE,WAAW,CAAC,CAAC;QAC7F,CAAC,CAAC,CAAC;QACH,SAAS,CAAC,+BAA+B,CAAC,OAAO,CAAC,CAAC;IACrD,CAAC,CAAC;AACJ,CAAC"}

package/dist/decorators/module.decorator.d.ts

@@ -1,21 +1,27 @@
 import type { Constructable, ModuleSchema } from '../app.type.js';
 /**
- * A `@Module` is a class decorator to be placed on top of a class that represents a module.
- * - A Module class must implement the {@link IModule} interface.
- * - The {@link IModule.onInit} method is called to initialize the module,
- * and is where you will *define* your infrastructure.
+ * A `@Module` is a class decorator and must be placed on top of a class representing a module.
+ * - A module must also extend the {@link AModule} class.
+ * - For type safety, the type of module being decorated is passed to the decorator.
+ *
+ * Decorating a class registers it with Octo, which is what makes the module loadable by name
+ * with {@link Octo.loadModule}.
  *
  * @example
  * ```ts
- * @Module<MyInputInterface, OutputModel>('my-package', {})
- * export class MyModule implements IModule<Region> {
- *   constructor(inputs: IMyInputs) { ... }
- *
- *   async onInit(): Promise<Region> { ... }
- * }
+ * @Module<MyModule>('@example', MyModuleSchema)
+ * export class MyModule extends AModule<MyModuleSchema, MyRegion> { ... }
  * ```
+ *
  * @group Decorators
+ *
+ * @param packageName - The name of the package under which the module is registered.
+ * Selecting a unique package name helps avoid collisions between same module class names across different libraries.
+ * You will reuse the same package name throughout your library for different Octo components you create.
+ * @param schema - The schema of the module, describing the inputs it accepts.
+ *
  * @returns The decorated class.
+ *
  * @see Definition of [Modules](/docs/fundamentals/modules).
  */
 export declare function Module<T>(packageName: string, schema: Constructable<ModuleSchema<T>>): (constructor: any) => void;