@quadnix/octo 0.0.23 → 0.0.24

package/dist/app.type.d.ts

@@ -2,7 +2,7 @@ import type { IDependency } from './functions/dependency/dependency.js';
 import type { ANode } from './functions/node/node.abstract.js';
 import type { IModelAction } from './models/model-action.interface.js';
 import type { AModel } from './models/model.abstract.js';
-import type { IModel } from './models/model.interface.js';
+import type { IModel, IModelReference } from './models/model.interface.js';
 import type { AModule } from './modules/module.abstract.js';
 import type { AAnchor } from './overlays/anchor.abstract.js';
 import type { BaseAnchorSchema } from './overlays/anchor.schema.js';
@@ -12,6 +12,9 @@ import type { IResourceAction } from './resources/resource-action.interface.js';
 import type { AResource } from './resources/resource.abstract.js';
 import type { BaseResourceSchema } from './resources/resource.schema.js';
 import type { ValidationUtility } from './utilities/validation/validation.utility.js';
+/**
+ * @group Types
+ */
 export declare class MatchingAnchor<S extends BaseAnchorSchema> {
     private readonly actual;
     private readonly schemaTranslator?;
@@ -22,6 +25,9 @@ export declare class MatchingAnchor<S extends BaseAnchorSchema> {
     }, any>;
     getSchemaInstance(): S;
 }
+/**
+ * @group Types
+ */
 export declare class MatchingModel<S extends object> {
     private readonly actual;
     private readonly schemaTranslator?;
@@ -30,6 +36,9 @@ export declare class MatchingModel<S extends object> {
     getActual(): AModel<Record<never, never>, any>;
     getSchemaInstance(): S;
 }
+/**
+ * @group Types
+ */
 export declare class MatchingResource<S extends BaseResourceSchema> {
     private readonly actual;
     readonly schemaTranslator?: ((synth: BaseResourceSchema) => S) | undefined;
@@ -48,11 +57,17 @@ export declare class MatchingResource<S extends BaseResourceSchema> {
         response: Required<S['response']>;
     };
 }
+/**
+ * @internal
+ */
 export declare enum NodeType {
     MODEL = "model",
     OVERLAY = "overlay",
     RESOURCE = "resource"
 }
+/**
+ * @internal
+ */
 export declare enum ValidationType {
     CUSTOM = "custom",
     IS_MODEL = "isModel",
@@ -63,6 +78,9 @@ export declare enum ValidationType {
     MIN_LENGTH = "minLength",
     REGEX = "regex"
 }
+/**
+ * @internal
+ */
 export type ValidationTypeOptions = {
     [ValidationType.CUSTOM]: Parameters<typeof ValidationUtility.validateCustom>[1];
     [ValidationType.IS_MODEL]: Parameters<typeof ValidationUtility.validateIsModel>[1];
@@ -73,22 +91,43 @@ export type ValidationTypeOptions = {
     [ValidationType.MIN_LENGTH]: Parameters<typeof ValidationUtility.validateMinLength>[1];
     [ValidationType.REGEX]: Parameters<typeof ValidationUtility.validateRegex>[1];
 };
+/**
+ * @group Types
+ */
 export declare function hasNodeName(node: UnknownNode, nodeName: string): boolean;
+/**
+ * @group Types
+ */
 export declare function stub<T>(value: string): T;
+/**
+ * @internal
+ */
 export type ActionInputs = EnhancedModuleSchema<UnknownModule>;
+/**
+ * @group Types
+ */
 export type ActionOutputs = {
     [key: string]: UnknownResource;
 };
+/**
+ * @internal
+ */
 export type ClassRequiredProperties<T> = {
     [K in keyof T]: undefined extends T[K] ? never : K;
 }[keyof T];
 export type ClassOptionalProperties<T> = {
     [K in keyof T]: undefined extends T[K] ? K : never;
 }[keyof T];
+/**
+ * @group Types
+ */
 export type DiffValueTypePropertyUpdate = {
     key: string;
     value: unknown;
 };
+/**
+ * @group Types
+ */
 export type DiffValueTypeTagUpdate = {
     add: {
         [key: string]: string;
@@ -98,16 +137,28 @@ export type DiffValueTypeTagUpdate = {
         [key: string]: string;
     };
 };
+/**
+ * @internal
+ */
 export type ObjectKeyValue<T> = {
     [K in keyof T]: {
         key: K;
         value: T[K];
     };
 }[keyof T];
+/**
+ * @group Types
+ */
 export type Constructable<T> = new (...args: any[]) => T;
+/**
+ * @group Types
+ */
 export type ModelSerializedOutput = {
     anchors: (AnchorSchema<UnknownAnchor> & {
         className: string;
+        location: IModelReference & {
+            type: NodeType;
+        };
     })[];
     dependencies: IDependency[];
     models: {
@@ -121,6 +172,9 @@ export type ModelSerializedOutput = {
         overlay: OverlaySchema<UnknownOverlay>;
     }[];
 };
+/**
+ * @group Types
+ */
 export type ResourceSerializedOutput = {
     dependencies: IDependency[];
     resources: {
@@ -130,6 +184,9 @@ export type ResourceSerializedOutput = {
         };
     };
 };
+/**
+ * @internal
+ */
 export type TransactionOptions = {
     enableResourceCapture?: boolean;
     yieldModelDiffs?: boolean;
@@ -137,8 +194,17 @@ export type TransactionOptions = {
     yieldResourceDiffs?: boolean;
     yieldResourceTransaction?: boolean;
 };
+/**
+ * @internal
+ */
 export type ModifyInterface<T, R> = Omit<T, keyof R> & R;
+/**
+ * @group Types
+ */
 export type AnchorSchema<T> = T extends AAnchor<infer S, any> ? S : never;
+/**
+ * @group Types
+ */
 export type EnhancedModuleSchema<T extends UnknownModule> = {
     inputs: {
         [K in keyof ModuleSchemaInputs<T>]: ModuleSchema<T>[K];
@@ -148,23 +214,71 @@ export type EnhancedModuleSchema<T extends UnknownModule> = {
     overlays: Record<string, UnknownOverlay>;
     resources: Record<string, UnknownResource>;
 };
+/**
+ * @internal
+ */
 export type ModelSchema<T> = T extends AModel<infer S, any> ? S : never;
+/**
+ * @internal
+ */
 export type ModuleOutput<M> = M extends AModule<any, infer T> ? T : never;
+/**
+ * @group Types
+ */
 export type ModuleSchema<T> = T extends AModule<infer S, any> ? S : never;
+/**
+ * @group Types
+ */
 export type ModuleSchemaInputs<T> = {
     [K in ClassRequiredProperties<ModuleSchema<T>>]: ModuleSchema<T>[K];
 } & {
     [K in ClassOptionalProperties<ModuleSchema<T>>]?: ModuleSchema<T>[K];
 };
+/**
+ * @internal
+ */
 export type NodeSchema<T> = T extends ANode<infer S, any> ? S : never;
+/**
+ * @group Types
+ */
 export type OverlaySchema<T> = T extends AOverlay<infer S, any> ? S : never;
+/**
+ * @group Types
+ */
 export type ResourceSchema<T> = T extends AResource<infer S, any> ? S : never;
+/**
+ * @internal
+ */
 export type IUnknownModel = IModel<unknown, any>;
+/**
+ * @internal
+ */
 export type IUnknownModelAction = IModelAction<any>;
+/**
+ * @internal
+ */
 export type IUnknownResourceAction = IResourceAction<any>;
+/**
+ * @internal
+ */
 export type UnknownAnchor = AAnchor<BaseAnchorSchema, UnknownModel>;
+/**
+ * @internal
+ */
 export type UnknownModel = AModel<unknown, any>;
+/**
+ * @internal
+ */
 export type UnknownModule = AModule<unknown, any>;
+/**
+ * @internal
+ */
 export type UnknownNode = ANode<unknown, unknown>;
+/**
+ * @internal
+ */
 export type UnknownOverlay = AOverlay<BaseOverlaySchema, any>;
+/**
+ * @internal
+ */
 export type UnknownResource = AResource<any, any>;

package/dist/app.type.js

@@ -1,4 +1,7 @@
 /* Classes */
+/**
+ * @group Types
+ */
 export class MatchingAnchor {
     constructor(actual, schemaTranslator) {
         this.actual = actual;
@@ -14,6 +17,9 @@ export class MatchingAnchor {
         return this.hasSchemaTranslator() ? this.schemaTranslator(this.actual.synth()) : this.actual.synth();
     }
 }
+/**
+ * @group Types
+ */
 export class MatchingModel {
     constructor(actual, schemaTranslator) {
         this.actual = actual;
@@ -29,6 +35,9 @@ export class MatchingModel {
         return this.hasSchemaTranslator() ? this.schemaTranslator(this.actual.synth()) : this.actual.synth();
     }
 }
+/**
+ * @group Types
+ */
 export class MatchingResource {
     constructor(actual, schemaTranslator) {
         this.actual = actual;
@@ -57,12 +66,18 @@ export class MatchingResource {
     }
 }
 /* Enumerations */
+/**
+ * @internal
+ */
 export var NodeType;
 (function (NodeType) {
     NodeType["MODEL"] = "model";
     NodeType["OVERLAY"] = "overlay";
     NodeType["RESOURCE"] = "resource";
 })(NodeType || (NodeType = {}));
+/**
+ * @internal
+ */
 export var ValidationType;
 (function (ValidationType) {
     ValidationType["CUSTOM"] = "custom";
@@ -75,9 +90,15 @@ export var ValidationType;
     ValidationType["REGEX"] = "regex";
 })(ValidationType || (ValidationType = {}));
 /* Functions */
+/**
+ * @group Types
+ */
 export function hasNodeName(node, nodeName) {
     return node.constructor.NODE_NAME === nodeName;
 }
+/**
+ * @group Types
+ */
 export function stub(value) {
     return 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;AACb,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,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,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;AAClB,MAAM,CAAN,IAAY,QAIX;AAJD,WAAY,QAAQ;IAClB,2BAAe,CAAA;IACf,+BAAmB,CAAA;IACnB,iCAAqB,CAAA;AACvB,CAAC,EAJW,QAAQ,KAAR,QAAQ,QAInB;AAED,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;AAaD,eAAe;AACf,MAAM,UAAU,WAAW,CAAC,IAAiB,EAAE,QAAgB;IAC7D,OAAQ,IAAI,CAAC,WAA4B,CAAC,SAAS,KAAK,QAAQ,CAAC;AACnE,CAAC;AAED,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":"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"}

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

@@ -7,10 +7,15 @@ type Hook = 'CommitHook';
  * @EnableHook('CommitHook')
  * async commitTransaction(): Promise<void> { ... }
  * ```
+ *
  * @group Decorators
+ *
  * @internal
+ *
  * @param hook The only values supported are `CommitHook`.
+ *
  * @returns The decorated method.
+ *
  * @see Definition of [Hooks](/docs/fundamentals/modules#hooks).
  */
 export declare function EnableHook(hook: Hook): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;

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

@@ -7,10 +7,15 @@ import { CommitHook } from '../functions/hook/commit.hook.js';
  * @EnableHook('CommitHook')
  * async commitTransaction(): Promise<void> { ... }
  * ```
+ *
  * @group Decorators
+ *
  * @internal
+ *
  * @param hook The only values supported are `CommitHook`.
+ *
  * @returns The decorated method.
+ *
  * @see Definition of [Hooks](/docs/fundamentals/modules#hooks).
  */
 export function EnableHook(hook) {

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

@@ -1 +1 @@
-{"version":3,"file":"enable-hook.decorator.js","sourceRoot":"","sources":["../../src/decorators/enable-hook.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,kCAAkC,CAAC;AAI9D;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,UAAU,CAAC,IAAU;IACnC,OAAO,UAAU,OAAY,EAAE,YAAoB,EAAE,UAA8B;QACjF,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,YAAY;gBACf,UAAU,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;gBAC/C,MAAM;YACR;gBACE,MAAM,IAAI,KAAK,CAAC,iBAAiB,IAAI,IAAI,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"enable-hook.decorator.js","sourceRoot":"","sources":["../../src/decorators/enable-hook.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,kCAAkC,CAAC;AAI9D;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAU,UAAU,CAAC,IAAU;IACnC,OAAO,UAAU,OAAY,EAAE,YAAoB,EAAE,UAA8B;QACjF,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,YAAY;gBACf,UAAU,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;gBAC/C,MAAM;YACR;gBACE,MAAM,IAAI,KAAK,CAAC,iBAAiB,IAAI,IAAI,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC,CAAC;AACJ,CAAC"}

package/dist/decorators/event-source.decorator.d.ts

@@ -10,9 +10,13 @@ import type { Event } from '../events/index.js';
  * @EventSource(MyEvent)
  * myMethod(): void { ... }
  * ```
+ *
  * @group Decorators
+ *
  * @internal
+ *
  * @param ofType The type of event being emitted.
+ *
  * @returns The decorated method.
  */
 export declare function EventSource(ofType: Constructable<Event<unknown>>): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;

package/dist/decorators/event-source.decorator.js

@@ -1,4 +1,3 @@
-import { Container } from '../functions/container/container.js';
 import { EventService } from '../services/event/event.service.js';
 /**
  * An `@EventSource` is a method decorator to enable automatic event emission.
@@ -10,18 +9,18 @@ import { EventService } from '../services/event/event.service.js';
  * @EventSource(MyEvent)
  * myMethod(): void { ... }
  * ```
+ *
  * @group Decorators
+ *
  * @internal
+ *
  * @param ofType The type of event being emitted.
+ *
  * @returns The decorated method.
  */
 export function EventSource(ofType) {
-    const container = Container.getInstance();
     return function (_target, _propertyKey, descriptor) {
-        const promise = container.get(EventService).then((eventService) => {
-            ofType.registrar(eventService, descriptor);
-        });
-        container.registerStartupUnhandledPromise(promise);
+        ofType.registrar(EventService.getInstance(), descriptor);
     };
 }
 //# sourceMappingURL=event-source.decorator.js.map

package/dist/decorators/event-source.decorator.js.map

@@ -1 +1 @@
-{"version":3,"file":"event-source.decorator.js","sourceRoot":"","sources":["../../src/decorators/event-source.decorator.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAElE;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,WAAW,CACzB,MAAqC;IAErC,MAAM,SAAS,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;IAE1C,OAAO,UAAU,OAAY,EAAE,YAAoB,EAAE,UAA8B;QACjF,MAAM,OAAO,GAAG,SAAS,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,EAAE;YAC/D,MAAc,CAAC,SAAS,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;QACH,SAAS,CAAC,+BAA+B,CAAC,OAAO,CAAC,CAAC;IACrD,CAAC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"event-source.decorator.js","sourceRoot":"","sources":["../../src/decorators/event-source.decorator.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAElE;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAU,WAAW,CACzB,MAAqC;IAErC,OAAO,UAAU,OAAY,EAAE,YAAoB,EAAE,UAA8B;QAChF,MAAc,CAAC,SAAS,CAAC,YAAY,CAAC,WAAW,EAAE,EAAE,UAAU,CAAC,CAAC;IACpE,CAAC,CAAC;AACJ,CAAC"}

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

@@ -1,15 +1,28 @@
 import { type Constructable, type ModelSchema, type UnknownModel } from '../app.type.js';
 /**
- * A `@Model` is a class decorator to be placed on top of a class that represents a model.
- * - A model must extend the {@link AModel} class.
+ * 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.
+ * - For type safety, the type of model being decorated is passed to the decorator.
  *
  * @example
  * ```ts
- * @Model('my-package', 'my-name')
- * export class MyModel extends AModel<IMyModel, MyModel> { ... }
+ * @Model<MyModel>('@example', 'region', MyModelSchema)
+ * export class MyModel extends Region { ... }
  * ```
+ *
  * @group Decorators
+ *
+ * @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 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.
  */
 export declare function Model<T extends UnknownModel>(packageName: string, modelName: string, schema: Constructable<ModelSchema<T>>): (constructor: any) => void;

package/dist/decorators/model.decorator.js

@@ -5,17 +5,30 @@ import { AOverlay } from '../overlays/overlay.abstract.js';
 import { ModelSerializationService } from '../services/serialization/model/model-serialization.service.js';
 import { ValidationUtility } from '../utilities/validation/validation.utility.js';
 /**
- * A `@Model` is a class decorator to be placed on top of a class that represents a model.
- * - A model must extend the {@link AModel} class.
+ * 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.
+ * - For type safety, the type of model being decorated is passed to the decorator.
  *
  * @example
  * ```ts
- * @Model('my-package', 'my-name')
- * export class MyModel extends AModel<IMyModel, MyModel> { ... }
+ * @Model<MyModel>('@example', 'region', MyModelSchema)
+ * export class MyModel extends Region { ... }
  * ```
+ *
  * @group Decorators
+ *
+ * @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 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.
  */
 export function Model(packageName, modelName, schema) {
     const container = Container.getInstance();

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;;;;;;;;;;;;GAYG;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,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"}

package/dist/decorators/on-event.decorator.js

@@ -1,4 +1,3 @@
-import { Container } from '../functions/container/container.js';
 import { EventService } from '../services/event/event.service.js';
 /**
  * An `@OnEvent` is a method decorator to listen to an event.
@@ -18,12 +17,8 @@ import { EventService } from '../services/event/event.service.js';
  * @returns The decorated method.
  */
 export function OnEvent(ofType) {
-    const container = Container.getInstance();
     return function (target, _propertyKey, descriptor) {
-        const promise = container.get(EventService).then((eventService) => {
-            eventService.registerListeners(ofType, target, descriptor);
-        });
-        container.registerStartupUnhandledPromise(promise);
+        EventService.getInstance().registerListeners(ofType, target, descriptor);
     };
 }
 //# sourceMappingURL=on-event.decorator.js.map

package/dist/decorators/on-event.decorator.js.map

@@ -1 +1 @@
-{"version":3,"file":"on-event.decorator.js","sourceRoot":"","sources":["../../src/decorators/on-event.decorator.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAElE;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,OAAO,CACrB,MAAqC;IAErC,MAAM,SAAS,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;IAE1C,OAAO,UAAU,MAAW,EAAE,YAAoB,EAAE,UAA8B;QAChF,MAAM,OAAO,GAAG,SAAS,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,EAAE;YAChE,YAAY,CAAC,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;QACH,SAAS,CAAC,+BAA+B,CAAC,OAAO,CAAC,CAAC;IACrD,CAAC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"on-event.decorator.js","sourceRoot":"","sources":["../../src/decorators/on-event.decorator.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAElE;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,OAAO,CACrB,MAAqC;IAErC,OAAO,UAAU,MAAW,EAAE,YAAoB,EAAE,UAA8B;QAChF,YAAY,CAAC,WAAW,EAAE,CAAC,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;IAC3E,CAAC,CAAC;AACJ,CAAC"}

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

@@ -1,15 +1,24 @@
 import { type Constructable, type OverlaySchema, type UnknownOverlay } from '../app.type.js';
 /**
- * An `@Overlay` is a class decorator to be placed on top of a class that represents an overlay.
- * - An overlay must extend the {@link AOverlay} class.
+ * An `@Overlay` is a class decorator and must be placed on top of a class representing an overlay.
+ * - An overlay must also extend the {@link AOverlay} class.
+ * - For type safety, the type of overlay being decorated is passed to the decorator.
  *
  * @example
  * ```ts
- * @Overlay('my-package', 'my-name')
- * export class MyOverlay extends AOverlay<MyOverlay> { ... }
+ * @Overlay<MyOverlay>('@example', 'my-name', MyOverlaySchema)
+ * export class MyOverlay extends AOverlay<MyOverlaySchema, MyOverlay> { ... }
  * ```
  * @group Decorators
+ *
+ * @param packageName - The name of the package under which the overlay is registered.
+ * Selecting a unique package name helps avoid collisions between same overlay class names across different libraries.
+ * You will reuse the same package name throughout your library for different Octo components you create.
+ * @param overlayName - a string that uniquely represents the name of the overlay.
+ * @param schema - The schema of the overlay.
+ *
  * @returns The decorated class.
- * @see Definition of [Overlays](/docs/fundamentals/overlay-and-anchor).
+ *
+ * @see Definition of [Overlays](/docs/fundamentals/overlays).
  */
 export declare function Overlay<T extends UnknownOverlay>(packageName: string, overlayName: string, schema: Constructable<OverlaySchema<T>>): (constructor: any) => void;

package/dist/decorators/overlay.decorator.js

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

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

@@ -1 +1 @@
-{"version":3,"file":"overlay.decorator.js","sourceRoot":"","sources":["../../src/decorators/overlay.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsB,QAAQ,EAA2C,MAAM,gBAAgB,CAAC;AACvG,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,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;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,OAAO,CACrB,WAAmB,EACnB,WAAmB,EACnB,MAAuC;IAEvC,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,WAAW,EAAE,0BAA0B,CAAC,EAAE,CAAC;YAC9E,MAAM,IAAI,KAAK,CAAC,yBAAyB,WAAW,EAAE,CAAC,CAAC;QAC1D,CAAC;QACD,IAAI,CAAC,CAAC,WAAW,CAAC,SAAS,YAAY,QAAQ,CAAC,EAAE,CAAC;YACjD,MAAM,IAAI,KAAK,CAAC,UAAU,WAAW,CAAC,IAAI,mCAAmC,CAAC,CAAC;QACjF,CAAC;QAED,WAAW,CAAC,SAAS,GAAG,WAAW,CAAC;QACpC,WAAW,CAAC,YAAY,GAAG,WAAW,CAAC;QACvC,WAAW,CAAC,WAAW,GAAG,MAAM,CAAC;QACjC,WAAW,CAAC,SAAS,GAAG,QAAQ,CAAC,OAAO,CAAC;QAEzC,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":"overlay.decorator.js","sourceRoot":"","sources":["../../src/decorators/overlay.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsB,QAAQ,EAA2C,MAAM,gBAAgB,CAAC;AACvG,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,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;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,OAAO,CACrB,WAAmB,EACnB,WAAmB,EACnB,MAAuC;IAEvC,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,WAAW,EAAE,0BAA0B,CAAC,EAAE,CAAC;YAC9E,MAAM,IAAI,KAAK,CAAC,yBAAyB,WAAW,EAAE,CAAC,CAAC;QAC1D,CAAC;QACD,IAAI,CAAC,CAAC,WAAW,CAAC,SAAS,YAAY,QAAQ,CAAC,EAAE,CAAC;YACjD,MAAM,IAAI,KAAK,CAAC,UAAU,WAAW,CAAC,IAAI,mCAAmC,CAAC,CAAC;QACjF,CAAC;QAED,WAAW,CAAC,SAAS,GAAG,WAAW,CAAC;QACpC,WAAW,CAAC,YAAY,GAAG,WAAW,CAAC;QACvC,WAAW,CAAC,WAAW,GAAG,MAAM,CAAC;QACjC,WAAW,CAAC,SAAS,GAAG,QAAQ,CAAC,OAAO,CAAC;QAEzC,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/resource.decorator.d.ts

@@ -1,15 +1,25 @@
 import { type Constructable, type ResourceSchema, type UnknownResource } from '../app.type.js';
 /**
- * A `@Resource` is a class decorator to be placed on top of a class that represents a resource.
- * - A resource must extend the {@link AResource} class.
+ * A `@Resource` is a class decorator and must be placed on top of a class representing a resource.
+ * - A resource must also extend the {@link AResource} class.
+ * - For type safety, the type of resource being decorated is passed to the decorator.
  *
  * @example
  * ```ts
- * @Resource('my-package', 'my-name')
- * export class MyResource extends AResource<MyResource> { ... }
+ * @Resource<MyResource>('@example', 'my-name', MyResourceSchema)
+ * export class MyResource extends AResource<MyResourceSchema, MyResource> { ... }
  * ```
+ *
  * @group Decorators
+ *
+ * @param packageName - The name of the package under which the resource is registered.
+ * Selecting a unique package name helps avoid collisions between same resource class names across different libraries.
+ * You will reuse the same package name throughout your library for different Octo components you create.
+ * @param resourceName - a string that uniquely represents the name of the resource.
+ * @param schema - The schema of the resource.
+ *
  * @returns The decorated class.
- * @see Definition of [Resources](http://localhost:3000/docs/fundamentals/resources).
+ *
+ * @see Definition of [Resources](/docs/fundamentals/resources).
  */
 export declare function Resource<T extends UnknownResource>(packageName: string, resourceName: string, schema: Constructable<ResourceSchema<T>>): (constructor: any) => void;

package/dist/decorators/resource.decorator.js

@@ -4,17 +4,27 @@ import { AResource } from '../resources/resource.abstract.js';
 import { ResourceSerializationService } from '../services/serialization/resource/resource-serialization.service.js';
 import { ValidationUtility } from '../utilities/validation/validation.utility.js';
 /**
- * A `@Resource` is a class decorator to be placed on top of a class that represents a resource.
- * - A resource must extend the {@link AResource} class.
+ * A `@Resource` is a class decorator and must be placed on top of a class representing a resource.
+ * - A resource must also extend the {@link AResource} class.
+ * - For type safety, the type of resource being decorated is passed to the decorator.
  *
  * @example
  * ```ts
- * @Resource('my-package', 'my-name')
- * export class MyResource extends AResource<MyResource> { ... }
+ * @Resource<MyResource>('@example', 'my-name', MyResourceSchema)
+ * export class MyResource extends AResource<MyResourceSchema, MyResource> { ... }
  * ```
+ *
  * @group Decorators
+ *
+ * @param packageName - The name of the package under which the resource is registered.
+ * Selecting a unique package name helps avoid collisions between same resource class names across different libraries.
+ * You will reuse the same package name throughout your library for different Octo components you create.
+ * @param resourceName - a string that uniquely represents the name of the resource.
+ * @param schema - The schema of the resource.
+ *
  * @returns The decorated class.
- * @see Definition of [Resources](http://localhost:3000/docs/fundamentals/resources).
+ *
+ * @see Definition of [Resources](/docs/fundamentals/resources).
  */
 export function Resource(packageName, resourceName, schema) {
     const container = Container.getInstance();