@decaf-ts/decoration 0.0.7 → 0.0.8

package/lib/decorators.d.ts

@@ -1,34 +1,74 @@
 /**
- * @description Assigns arbitrary metadata to a target using a string key
- * @summary Decorator factory that stores a key/value pair in the central Metadata store for the provided class or member.
- * @param {string} key The metadata key to associate with the target
- * @param {any} value The metadata value to store under the given key
- * @return A decorator that writes the metadata when applied
+ * @description Assigns arbitrary metadata to a target using a string key.
+ * @summary Decorator factory that stores a key/value pair in the central metadata store for the provided class or member.
+ * @param {string} key Metadata key to associate with the target.
+ * @param {any} value Metadata value to store under the given key.
+ * @return {ClassDecorator|MethodDecorator|PropertyDecorator|ParameterDecorator} Decorator that writes the metadata when applied.
  * @function metadata
  * @category Decorators
  */
-export declare function metadata(key: string, value: any): (model: any, prop?: any, descriptor?: PropertyDescriptor) => void;
+export declare function metadata(key: string, value: any): (model: any, prop?: any, descriptor?: PropertyDescriptor | number) => void;
 /**
- * @description Captures and stores a property's design type
- * @summary Decorator factory that reads the reflected design:type for a property and registers it in the Metadata store under the properties map.
- * @return A decorator that records the property's type metadata when applied
+ * @description Captures and stores a property's design type.
+ * @summary Decorator factory that reads the reflected `design:type` for a property and registers it in the metadata store under the properties map.
+ * @return {PropertyDecorator} Decorator that records the property's type metadata when applied.
  * @function prop
  * @category Property Decorators
  */
 export declare function prop(): (model: object, prop: any) => void;
 /**
- * @description Records method design-time metadata
+ * @description Captures a single parameter type for the decorated method.
+ * @summary Decorator factory that ensures the method metadata is initialised and stores the reflected parameter constructor at the provided index.
+ * @return {ParameterDecorator} Decorator that records the parameter type when applied.
+ * @function param
+ * @category Parameter Decorators
+ * @mermaid
+ * sequenceDiagram
+ *   participant U as User Code
+ *   participant P as param()
+ *   participant M as Metadata
+ *   U->>P: param()(target, key, index)
+ *   P->>U: method()(target, key, descriptor)
+ *   P->>M: params(constructor, key)
+ *   M-->>P: parameter constructors[]
+ *   P->>M: set(methods.key.index, constructor)
+ *   P-->>U: parameter recorded
+ */
+export declare function param(): (model: object, prop: string | symbol | undefined, index: number) => void;
+/**
+ * @description Extends a parameter decorator with additional metadata.
+ * @summary Applies the default `param()` decorator and augments the stored metadata with an arbitrary key/value pair.
+ * @param {string} key Metadata key to associate with the parameter.
+ * @param {any} value Metadata value persisted under the given key.
+ * @return {ParameterDecorator} Decorator that records both the parameter design type and additional metadata.
+ * @function paramMetadata
+ * @category Parameter Decorators
+ */
+export declare function paramMetadata(key: string, value: any): (target: any, prop: any, index: number) => void;
+/**
+ * @description Records method design-time metadata.
  * @summary Decorator factory that captures a method's reflected parameter and return types, storing them under the appropriate metadata keys so they can be inspected at runtime.
- * @return A decorator that persists the method's signature information into the Metadata store when applied
+ * @return {MethodDecorator} Decorator that persists the method's signature information into the metadata store when applied.
  * @function method
+ * @mermaid
+ * sequenceDiagram
+ *   participant U as User Code
+ *   participant F as method()
+ *   participant M as Metadata
+ *   U->>F: method()(target, key, descriptor)
+ *   F->>U: Reflect.getOwnMetadata(design:paramtypes)
+ *   F->>U: Reflect.getOwnMetadata(design:returntype)
+ *   F->>M: set(methods.key.design:paramtypes, params)
+ *   F->>M: set(methods.key.design:returntype, returnType)
+ *   F-->>U: decorated function
  * @category Method Decorators
  */
 export declare function method(): (obj: any, prop?: any, descriptor?: any) => void;
 /**
- * @description Decorator factory that applies multiple decorators to a single target
- * @summary Creates a composite decorator that applies multiple decorators in sequence, correctly handling class, method, and property decorators.
- * @param {Array<ClassDecorator | MethodDecorator | PropertyDecorator>} decorators - Array of decorators to apply
- * @return {Function} A decorator function that applies all provided decorators to the target
+ * @description Decorator factory that applies multiple decorators to a single target.
+ * @summary Creates a composite decorator that applies multiple decorators in sequence, correctly handling class, method, property, and parameter decorators.
+ * @param {Array<ClassDecorator|MethodDecorator|PropertyDecorator|ParameterDecorator>} decorators Collection of decorators to apply.
+ * @return {ClassDecorator|MethodDecorator|PropertyDecorator|ParameterDecorator} Decorator function that applies all provided decorators to the target.
  * @function apply
  * @mermaid
  * sequenceDiagram
@@ -43,22 +83,32 @@ export declare function method(): (obj: any, prop?: any, descriptor?: any) => vo
  *   end
  * @category Decorators
  */
-export declare function apply(...decorators: Array<ClassDecorator | MethodDecorator | PropertyDecorator>): (target: object, propertyKey?: string | symbol | unknown, descriptor?: PropertyDescriptor) => void;
+export declare function apply(...decorators: Array<ClassDecorator | MethodDecorator | PropertyDecorator | ParameterDecorator>): (target: object, propertyKey?: string | symbol | unknown, descriptor?: PropertyDescriptor | number) => void;
 /**
- * @description Creates a property metadata decorator
- * @summary Convenience factory that combines metadata(key, value) and prop() to both set an arbitrary metadata key and record the property's design type.
- * @param {string} key The metadata key to set for the property
- * @param {*} value The metadata value to associate with the key
- * @return A decorator that sets the metadata and captures the property's type
+ * @description Creates a property metadata decorator.
+ * @summary Convenience factory that combines `metadata(key, value)` and `prop()` to both set an arbitrary metadata key and record the property's design type.
+ * @param {string} key Metadata key to set for the property.
+ * @param {any} value Metadata value to associate with the key.
+ * @return {PropertyDecorator} Decorator that sets the metadata and captures the property's type.
  * @function propMetadata
  * @category Property Decorators
  */
-export declare function propMetadata(key: string, value: any): (target: object, propertyKey?: string | symbol | unknown, descriptor?: PropertyDescriptor) => void;
+export declare function propMetadata(key: string, value: any): (target: object, propertyKey?: string | symbol | unknown, descriptor?: PropertyDescriptor | number) => void;
+/**
+ * @description Creates a method metadata decorator.
+ * @summary Convenience factory that combines `metadata(key, value)` and `method()` to both set an arbitrary metadata key and record the method's design return and param types.
+ * @param {string} key Metadata key to set for the property.
+ * @param {any} value Metadata value to associate with the key.
+ * @return {PropertyDecorator} Decorator that sets the metadata and captures the property's type.
+ * @function methodMetadata
+ * @category Method Decorators
+ */
+export declare function methodMetadata(key: string, value: any): (target: object, propertyKey?: string | symbol | unknown, descriptor?: PropertyDescriptor | number) => void;
 /**
- * @description Attaches a human-readable description to a class or member
- * @summary Decorator factory that stores a textual description in the Metadata store under the appropriate description key for a class or its property.
- * @param {string} desc The descriptive text to associate with the class or property
- * @return A decorator that records the description when applied
+ * @description Attaches a human-readable description to a class or member.
+ * @summary Decorator factory that stores a textual description in the metadata store under the appropriate description key for a class or its property.
+ * @param {string} desc Descriptive text to associate with the class or property.
+ * @return {ClassDecorator|MethodDecorator|PropertyDecorator} Decorator that records the description when applied.
  * @function description
  * @category Decorators
  */

package/lib/esm/constants.d.ts

@@ -1,53 +1,53 @@
 import { BasicMetadata } from "./metadata/types";
 /**
- * @description Default flavour identifier for the decorator system
- * @summary Defines the default flavour used by the Decoration class when no specific flavour is provided.
- * This constant is used throughout the library as the fallback flavour for decorators.
+ * @description Default flavour identifier for the decorator system.
+ * @summary Defines the default flavour used by the Decoration class when no specific flavour is provided. This constant is used throughout the library as the fallback flavour for decorators.
  * @const DefaultFlavour
  * @memberOf module:decoration
  */
 export declare const DefaultFlavour = "decaf";
 /**
- * @description Character used to split nested metadata keys
- * @summary The delimiter used by the metadata store to traverse nested object paths when reading/writing values.
+ * @description Character used to split nested metadata keys.
+ * @summary Defines the delimiter the metadata store uses to traverse nested object paths when reading or writing values.
  * @const ObjectKeySplitter
  * @memberOf module:decoration
  */
 export declare const ObjectKeySplitter = ".";
 /**
- * @description Enum containing metadata keys used for reflection in the model system
- * @summary Defines the various Model keys used for reflection and metadata storage.
- * These keys are used throughout the library to store and retrieve metadata about models,
- * their properties, and their behavior.
- * @readonly
+ * @description Metadata token registry for the decoration system.
+ * @summary Enumerates the keys used during reflection and metadata storage for classes, properties, methods, descriptions, and registered libraries.
  * @enum {string}
  * @readonly
+ * @const DecorationKeys
  * @memberOf module:decoration
  */
 export declare enum DecorationKeys {
+    /** @description Storage bucket for decoration-aware library registrations. */
     LIBRARIES = "libraries",
-    /** Storage key used on the constructor to mirror runtime metadata */
+    /** @description Storage key mirrored on constructors that holds runtime metadata. */
     REFLECT = "__decaf",
-    /** Map of model property keys to their reflected design types */
+    /** @description Container of reflected property metadata for a model. */
     PROPERTIES = "properties",
-    /** Map of model method keys to their reflected design params and return types */
+    /** @description Container of reflected method metadata for a model. */
     METHODS = "methods",
-    /** Key under which the model's constructor is stored */
+    /** @description Key under which the model constructor reference is persisted. */
     CLASS = "class",
-    /** Container of human-friendly descriptions per class and property */
+    /** @description Human-readable descriptions for classes and members. */
     DESCRIPTION = "description",
-    /** Holds the original constructor - for constructor override**/
+    /** @description Storage slot tracking the original constructor when overridden. */
     CONSTRUCTOR = "constructor",
-    /** Reflect metadata key for design time type of a property */
+    /** @description Collected parameter metadata for configured decorators. */
+    PARAMETERS = "parameters",
+    /** @description Reflect metadata key for a property's design type. */
     DESIGN_TYPE = "design:type",
-    /** Reflect metadata key for constructor parameter types */
+    /** @description Reflect metadata key for recorded constructor parameter types. */
     DESIGN_PARAMS = "design:paramtypes",
-    /** Reflect metadata key for method return type */
+    /** @description Reflect metadata key for a method's return type. */
     DESIGN_RETURN = "design:returntype"
 }
 /**
- * @description Default metadata instance
- * @summary Concrete default metadata object used when initializing metadata for a model
+ * @description Default metadata instance.
+ * @summary Provides the default metadata shape used when initializing new metadata entries for a model.
  * @const DefaultMetadata
  * @memberOf module:decoration
  */

package/lib/esm/constants.js

@@ -1,57 +1,57 @@
 /**
- * @description Default flavour identifier for the decorator system
- * @summary Defines the default flavour used by the Decoration class when no specific flavour is provided.
- * This constant is used throughout the library as the fallback flavour for decorators.
+ * @description Default flavour identifier for the decorator system.
+ * @summary Defines the default flavour used by the Decoration class when no specific flavour is provided. This constant is used throughout the library as the fallback flavour for decorators.
  * @const DefaultFlavour
  * @memberOf module:decoration
  */
 export const DefaultFlavour = "decaf";
 /**
- * @description Character used to split nested metadata keys
- * @summary The delimiter used by the metadata store to traverse nested object paths when reading/writing values.
+ * @description Character used to split nested metadata keys.
+ * @summary Defines the delimiter the metadata store uses to traverse nested object paths when reading or writing values.
  * @const ObjectKeySplitter
  * @memberOf module:decoration
  */
 export const ObjectKeySplitter = ".";
 /**
- * @description Enum containing metadata keys used for reflection in the model system
- * @summary Defines the various Model keys used for reflection and metadata storage.
- * These keys are used throughout the library to store and retrieve metadata about models,
- * their properties, and their behavior.
- * @readonly
+ * @description Metadata token registry for the decoration system.
+ * @summary Enumerates the keys used during reflection and metadata storage for classes, properties, methods, descriptions, and registered libraries.
  * @enum {string}
  * @readonly
+ * @const DecorationKeys
  * @memberOf module:decoration
  */
 export var DecorationKeys;
 (function (DecorationKeys) {
+    /** @description Storage bucket for decoration-aware library registrations. */
     DecorationKeys["LIBRARIES"] = "libraries";
-    /** Storage key used on the constructor to mirror runtime metadata */
+    /** @description Storage key mirrored on constructors that holds runtime metadata. */
     DecorationKeys["REFLECT"] = "__decaf";
-    /** Map of model property keys to their reflected design types */
+    /** @description Container of reflected property metadata for a model. */
     DecorationKeys["PROPERTIES"] = "properties";
-    /** Map of model method keys to their reflected design params and return types */
+    /** @description Container of reflected method metadata for a model. */
     DecorationKeys["METHODS"] = "methods";
-    /** Key under which the model's constructor is stored */
+    /** @description Key under which the model constructor reference is persisted. */
     DecorationKeys["CLASS"] = "class";
-    /** Container of human-friendly descriptions per class and property */
+    /** @description Human-readable descriptions for classes and members. */
     DecorationKeys["DESCRIPTION"] = "description";
-    /** Holds the original constructor - for constructor override**/
+    /** @description Storage slot tracking the original constructor when overridden. */
     DecorationKeys["CONSTRUCTOR"] = "constructor";
-    /** Reflect metadata key for design time type of a property */
+    /** @description Collected parameter metadata for configured decorators. */
+    DecorationKeys["PARAMETERS"] = "parameters";
+    /** @description Reflect metadata key for a property's design type. */
     DecorationKeys["DESIGN_TYPE"] = "design:type";
-    /** Reflect metadata key for constructor parameter types */
+    /** @description Reflect metadata key for recorded constructor parameter types. */
     DecorationKeys["DESIGN_PARAMS"] = "design:paramtypes";
-    /** Reflect metadata key for method return type */
+    /** @description Reflect metadata key for a method's return type. */
     DecorationKeys["DESIGN_RETURN"] = "design:returntype";
 })(DecorationKeys || (DecorationKeys = {}));
 /**
- * @description Default metadata instance
- * @summary Concrete default metadata object used when initializing metadata for a model
+ * @description Default metadata instance.
+ * @summary Provides the default metadata shape used when initializing new metadata entries for a model.
  * @const DefaultMetadata
  * @memberOf module:decoration
  */
 export const DefaultMetadata = {
     [DecorationKeys.PROPERTIES]: [],
 };
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uc3RhbnRzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2NvbnN0YW50cy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFFQTs7Ozs7O0dBTUc7QUFDSCxNQUFNLENBQUMsTUFBTSxjQUFjLEdBQUcsT0FBTyxDQUFDO0FBRXRDOzs7OztHQUtHO0FBQ0gsTUFBTSxDQUFDLE1BQU0saUJBQWlCLEdBQUcsR0FBRyxDQUFDO0FBRXJDOzs7Ozs7Ozs7R0FTRztBQUNILE1BQU0sQ0FBTixJQUFZLGNBb0JYO0FBcEJELFdBQVksY0FBYztJQUN4Qix5Q0FBdUIsQ0FBQTtJQUN2QixxRUFBcUU7SUFDckUscUNBQStCLENBQUE7SUFDL0IsaUVBQWlFO0lBQ2pFLDJDQUF5QixDQUFBO0lBQ3pCLGlGQUFpRjtJQUNqRixxQ0FBbUIsQ0FBQTtJQUNuQix3REFBd0Q7SUFDeEQsaUNBQWUsQ0FBQTtJQUNmLHNFQUFzRTtJQUN0RSw2Q0FBMkIsQ0FBQTtJQUMzQixnRUFBZ0U7SUFDaEUsNkNBQTJCLENBQUE7SUFDM0IsOERBQThEO0lBQzlELDZDQUEyQixDQUFBO0lBQzNCLDJEQUEyRDtJQUMzRCxxREFBbUMsQ0FBQTtJQUNuQyxrREFBa0Q7SUFDbEQscURBQW1DLENBQUE7QUFDckMsQ0FBQyxFQXBCVyxjQUFjLEtBQWQsY0FBYyxRQW9CekI7QUFFRDs7Ozs7R0FLRztBQUNILE1BQU0sQ0FBQyxNQUFNLGVBQWUsR0FBdUI7SUFDakQsQ0FBQyxjQUFjLENBQUMsVUFBVSxDQUFDLEVBQUUsRUFBRTtDQUNDLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBCYXNpY01ldGFkYXRhIH0gZnJvbSBcIi4vbWV0YWRhdGEvdHlwZXNcIjtcblxuLyoqXG4gKiBAZGVzY3JpcHRpb24gRGVmYXVsdCBmbGF2b3VyIGlkZW50aWZpZXIgZm9yIHRoZSBkZWNvcmF0b3Igc3lzdGVtXG4gKiBAc3VtbWFyeSBEZWZpbmVzIHRoZSBkZWZhdWx0IGZsYXZvdXIgdXNlZCBieSB0aGUgRGVjb3JhdGlvbiBjbGFzcyB3aGVuIG5vIHNwZWNpZmljIGZsYXZvdXIgaXMgcHJvdmlkZWQuXG4gKiBUaGlzIGNvbnN0YW50IGlzIHVzZWQgdGhyb3VnaG91dCB0aGUgbGlicmFyeSBhcyB0aGUgZmFsbGJhY2sgZmxhdm91ciBmb3IgZGVjb3JhdG9ycy5cbiAqIEBjb25zdCBEZWZhdWx0Rmxhdm91clxuICogQG1lbWJlck9mIG1vZHVsZTpkZWNvcmF0aW9uXG4gKi9cbmV4cG9ydCBjb25zdCBEZWZhdWx0Rmxhdm91ciA9IFwiZGVjYWZcIjtcblxuLyoqXG4gKiBAZGVzY3JpcHRpb24gQ2hhcmFjdGVyIHVzZWQgdG8gc3BsaXQgbmVzdGVkIG1ldGFkYXRhIGtleXNcbiAqIEBzdW1tYXJ5IFRoZSBkZWxpbWl0ZXIgdXNlZCBieSB0aGUgbWV0YWRhdGEgc3RvcmUgdG8gdHJhdmVyc2UgbmVzdGVkIG9iamVjdCBwYXRocyB3aGVuIHJlYWRpbmcvd3JpdGluZyB2YWx1ZXMuXG4gKiBAY29uc3QgT2JqZWN0S2V5U3BsaXR0ZXJcbiAqIEBtZW1iZXJPZiBtb2R1bGU6ZGVjb3JhdGlvblxuICovXG5leHBvcnQgY29uc3QgT2JqZWN0S2V5U3BsaXR0ZXIgPSBcIi5cIjtcblxuLyoqXG4gKiBAZGVzY3JpcHRpb24gRW51bSBjb250YWluaW5nIG1ldGFkYXRhIGtleXMgdXNlZCBmb3IgcmVmbGVjdGlvbiBpbiB0aGUgbW9kZWwgc3lzdGVtXG4gKiBAc3VtbWFyeSBEZWZpbmVzIHRoZSB2YXJpb3VzIE1vZGVsIGtleXMgdXNlZCBmb3IgcmVmbGVjdGlvbiBhbmQgbWV0YWRhdGEgc3RvcmFnZS5cbiAqIFRoZXNlIGtleXMgYXJlIHVzZWQgdGhyb3VnaG91dCB0aGUgbGlicmFyeSB0byBzdG9yZSBhbmQgcmV0cmlldmUgbWV0YWRhdGEgYWJvdXQgbW9kZWxzLFxuICogdGhlaXIgcHJvcGVydGllcywgYW5kIHRoZWlyIGJlaGF2aW9yLlxuICogQHJlYWRvbmx5XG4gKiBAZW51bSB7c3RyaW5nfVxuICogQHJlYWRvbmx5XG4gKiBAbWVtYmVyT2YgbW9kdWxlOmRlY29yYXRpb25cbiAqL1xuZXhwb3J0IGVudW0gRGVjb3JhdGlvbktleXMge1xuICBMSUJSQVJJRVMgPSBcImxpYnJhcmllc1wiLFxuICAvKiogU3RvcmFnZSBrZXkgdXNlZCBvbiB0aGUgY29uc3RydWN0b3IgdG8gbWlycm9yIHJ1bnRpbWUgbWV0YWRhdGEgKi9cbiAgUkVGTEVDVCA9IGBfXyR7RGVmYXVsdEZsYXZvdXJ9YCxcbiAgLyoqIE1hcCBvZiBtb2RlbCBwcm9wZXJ0eSBrZXlzIHRvIHRoZWlyIHJlZmxlY3RlZCBkZXNpZ24gdHlwZXMgKi9cbiAgUFJPUEVSVElFUyA9IFwicHJvcGVydGllc1wiLFxuICAvKiogTWFwIG9mIG1vZGVsIG1ldGhvZCBrZXlzIHRvIHRoZWlyIHJlZmxlY3RlZCBkZXNpZ24gcGFyYW1zIGFuZCByZXR1cm4gdHlwZXMgKi9cbiAgTUVUSE9EUyA9IFwibWV0aG9kc1wiLFxuICAvKiogS2V5IHVuZGVyIHdoaWNoIHRoZSBtb2RlbCdzIGNvbnN0cnVjdG9yIGlzIHN0b3JlZCAqL1xuICBDTEFTUyA9IFwiY2xhc3NcIixcbiAgLyoqIENvbnRhaW5lciBvZiBodW1hbi1mcmllbmRseSBkZXNjcmlwdGlvbnMgcGVyIGNsYXNzIGFuZCBwcm9wZXJ0eSAqL1xuICBERVNDUklQVElPTiA9IFwiZGVzY3JpcHRpb25cIixcbiAgLyoqIEhvbGRzIHRoZSBvcmlnaW5hbCBjb25zdHJ1Y3RvciAtIGZvciBjb25zdHJ1Y3RvciBvdmVycmlkZSoqL1xuICBDT05TVFJVQ1RPUiA9IFwiY29uc3RydWN0b3JcIixcbiAgLyoqIFJlZmxlY3QgbWV0YWRhdGEga2V5IGZvciBkZXNpZ24gdGltZSB0eXBlIG9mIGEgcHJvcGVydHkgKi9cbiAgREVTSUdOX1RZUEUgPSBcImRlc2lnbjp0eXBlXCIsXG4gIC8qKiBSZWZsZWN0IG1ldGFkYXRhIGtleSBmb3IgY29uc3RydWN0b3IgcGFyYW1ldGVyIHR5cGVzICovXG4gIERFU0lHTl9QQVJBTVMgPSBcImRlc2lnbjpwYXJhbXR5cGVzXCIsXG4gIC8qKiBSZWZsZWN0IG1ldGFkYXRhIGtleSBmb3IgbWV0aG9kIHJldHVybiB0eXBlICovXG4gIERFU0lHTl9SRVRVUk4gPSBcImRlc2lnbjpyZXR1cm50eXBlXCIsXG59XG5cbi8qKlxuICogQGRlc2NyaXB0aW9uIERlZmF1bHQgbWV0YWRhdGEgaW5zdGFuY2VcbiAqIEBzdW1tYXJ5IENvbmNyZXRlIGRlZmF1bHQgbWV0YWRhdGEgb2JqZWN0IHVzZWQgd2hlbiBpbml0aWFsaXppbmcgbWV0YWRhdGEgZm9yIGEgbW9kZWxcbiAqIEBjb25zdCBEZWZhdWx0TWV0YWRhdGFcbiAqIEBtZW1iZXJPZiBtb2R1bGU6ZGVjb3JhdGlvblxuICovXG5leHBvcnQgY29uc3QgRGVmYXVsdE1ldGFkYXRhOiBCYXNpY01ldGFkYXRhPGFueT4gPSB7XG4gIFtEZWNvcmF0aW9uS2V5cy5QUk9QRVJUSUVTXTogW10sXG59IGFzIHVua25vd24gYXMgQmFzaWNNZXRhZGF0YTxhbnk+O1xuIl19
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uc3RhbnRzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2NvbnN0YW50cy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFFQTs7Ozs7R0FLRztBQUNILE1BQU0sQ0FBQyxNQUFNLGNBQWMsR0FBRyxPQUFPLENBQUM7QUFFdEM7Ozs7O0dBS0c7QUFDSCxNQUFNLENBQUMsTUFBTSxpQkFBaUIsR0FBRyxHQUFHLENBQUM7QUFFckM7Ozs7Ozs7R0FPRztBQUNILE1BQU0sQ0FBTixJQUFZLGNBdUJYO0FBdkJELFdBQVksY0FBYztJQUN4Qiw4RUFBOEU7SUFDOUUseUNBQXVCLENBQUE7SUFDdkIscUZBQXFGO0lBQ3JGLHFDQUErQixDQUFBO0lBQy9CLHlFQUF5RTtJQUN6RSwyQ0FBeUIsQ0FBQTtJQUN6Qix1RUFBdUU7SUFDdkUscUNBQW1CLENBQUE7SUFDbkIsaUZBQWlGO0lBQ2pGLGlDQUFlLENBQUE7SUFDZix3RUFBd0U7SUFDeEUsNkNBQTJCLENBQUE7SUFDM0IsbUZBQW1GO0lBQ25GLDZDQUEyQixDQUFBO0lBQzNCLDJFQUEyRTtJQUMzRSwyQ0FBeUIsQ0FBQTtJQUN6QixzRUFBc0U7SUFDdEUsNkNBQTJCLENBQUE7SUFDM0Isa0ZBQWtGO0lBQ2xGLHFEQUFtQyxDQUFBO0lBQ25DLG9FQUFvRTtJQUNwRSxxREFBbUMsQ0FBQTtBQUNyQyxDQUFDLEVBdkJXLGNBQWMsS0FBZCxjQUFjLFFBdUJ6QjtBQUVEOzs7OztHQUtHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sZUFBZSxHQUF1QjtJQUNqRCxDQUFDLGNBQWMsQ0FBQyxVQUFVLENBQUMsRUFBRSxFQUFFO0NBQ0MsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IEJhc2ljTWV0YWRhdGEgfSBmcm9tIFwiLi9tZXRhZGF0YS90eXBlc1wiO1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBEZWZhdWx0IGZsYXZvdXIgaWRlbnRpZmllciBmb3IgdGhlIGRlY29yYXRvciBzeXN0ZW0uXG4gKiBAc3VtbWFyeSBEZWZpbmVzIHRoZSBkZWZhdWx0IGZsYXZvdXIgdXNlZCBieSB0aGUgRGVjb3JhdGlvbiBjbGFzcyB3aGVuIG5vIHNwZWNpZmljIGZsYXZvdXIgaXMgcHJvdmlkZWQuIFRoaXMgY29uc3RhbnQgaXMgdXNlZCB0aHJvdWdob3V0IHRoZSBsaWJyYXJ5IGFzIHRoZSBmYWxsYmFjayBmbGF2b3VyIGZvciBkZWNvcmF0b3JzLlxuICogQGNvbnN0IERlZmF1bHRGbGF2b3VyXG4gKiBAbWVtYmVyT2YgbW9kdWxlOmRlY29yYXRpb25cbiAqL1xuZXhwb3J0IGNvbnN0IERlZmF1bHRGbGF2b3VyID0gXCJkZWNhZlwiO1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBDaGFyYWN0ZXIgdXNlZCB0byBzcGxpdCBuZXN0ZWQgbWV0YWRhdGEga2V5cy5cbiAqIEBzdW1tYXJ5IERlZmluZXMgdGhlIGRlbGltaXRlciB0aGUgbWV0YWRhdGEgc3RvcmUgdXNlcyB0byB0cmF2ZXJzZSBuZXN0ZWQgb2JqZWN0IHBhdGhzIHdoZW4gcmVhZGluZyBvciB3cml0aW5nIHZhbHVlcy5cbiAqIEBjb25zdCBPYmplY3RLZXlTcGxpdHRlclxuICogQG1lbWJlck9mIG1vZHVsZTpkZWNvcmF0aW9uXG4gKi9cbmV4cG9ydCBjb25zdCBPYmplY3RLZXlTcGxpdHRlciA9IFwiLlwiO1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBNZXRhZGF0YSB0b2tlbiByZWdpc3RyeSBmb3IgdGhlIGRlY29yYXRpb24gc3lzdGVtLlxuICogQHN1bW1hcnkgRW51bWVyYXRlcyB0aGUga2V5cyB1c2VkIGR1cmluZyByZWZsZWN0aW9uIGFuZCBtZXRhZGF0YSBzdG9yYWdlIGZvciBjbGFzc2VzLCBwcm9wZXJ0aWVzLCBtZXRob2RzLCBkZXNjcmlwdGlvbnMsIGFuZCByZWdpc3RlcmVkIGxpYnJhcmllcy5cbiAqIEBlbnVtIHtzdHJpbmd9XG4gKiBAcmVhZG9ubHlcbiAqIEBjb25zdCBEZWNvcmF0aW9uS2V5c1xuICogQG1lbWJlck9mIG1vZHVsZTpkZWNvcmF0aW9uXG4gKi9cbmV4cG9ydCBlbnVtIERlY29yYXRpb25LZXlzIHtcbiAgLyoqIEBkZXNjcmlwdGlvbiBTdG9yYWdlIGJ1Y2tldCBmb3IgZGVjb3JhdGlvbi1hd2FyZSBsaWJyYXJ5IHJlZ2lzdHJhdGlvbnMuICovXG4gIExJQlJBUklFUyA9IFwibGlicmFyaWVzXCIsXG4gIC8qKiBAZGVzY3JpcHRpb24gU3RvcmFnZSBrZXkgbWlycm9yZWQgb24gY29uc3RydWN0b3JzIHRoYXQgaG9sZHMgcnVudGltZSBtZXRhZGF0YS4gKi9cbiAgUkVGTEVDVCA9IGBfXyR7RGVmYXVsdEZsYXZvdXJ9YCxcbiAgLyoqIEBkZXNjcmlwdGlvbiBDb250YWluZXIgb2YgcmVmbGVjdGVkIHByb3BlcnR5IG1ldGFkYXRhIGZvciBhIG1vZGVsLiAqL1xuICBQUk9QRVJUSUVTID0gXCJwcm9wZXJ0aWVzXCIsXG4gIC8qKiBAZGVzY3JpcHRpb24gQ29udGFpbmVyIG9mIHJlZmxlY3RlZCBtZXRob2QgbWV0YWRhdGEgZm9yIGEgbW9kZWwuICovXG4gIE1FVEhPRFMgPSBcIm1ldGhvZHNcIixcbiAgLyoqIEBkZXNjcmlwdGlvbiBLZXkgdW5kZXIgd2hpY2ggdGhlIG1vZGVsIGNvbnN0cnVjdG9yIHJlZmVyZW5jZSBpcyBwZXJzaXN0ZWQuICovXG4gIENMQVNTID0gXCJjbGFzc1wiLFxuICAvKiogQGRlc2NyaXB0aW9uIEh1bWFuLXJlYWRhYmxlIGRlc2NyaXB0aW9ucyBmb3IgY2xhc3NlcyBhbmQgbWVtYmVycy4gKi9cbiAgREVTQ1JJUFRJT04gPSBcImRlc2NyaXB0aW9uXCIsXG4gIC8qKiBAZGVzY3JpcHRpb24gU3RvcmFnZSBzbG90IHRyYWNraW5nIHRoZSBvcmlnaW5hbCBjb25zdHJ1Y3RvciB3aGVuIG92ZXJyaWRkZW4uICovXG4gIENPTlNUUlVDVE9SID0gXCJjb25zdHJ1Y3RvclwiLFxuICAvKiogQGRlc2NyaXB0aW9uIENvbGxlY3RlZCBwYXJhbWV0ZXIgbWV0YWRhdGEgZm9yIGNvbmZpZ3VyZWQgZGVjb3JhdG9ycy4gKi9cbiAgUEFSQU1FVEVSUyA9IFwicGFyYW1ldGVyc1wiLFxuICAvKiogQGRlc2NyaXB0aW9uIFJlZmxlY3QgbWV0YWRhdGEga2V5IGZvciBhIHByb3BlcnR5J3MgZGVzaWduIHR5cGUuICovXG4gIERFU0lHTl9UWVBFID0gXCJkZXNpZ246dHlwZVwiLFxuICAvKiogQGRlc2NyaXB0aW9uIFJlZmxlY3QgbWV0YWRhdGEga2V5IGZvciByZWNvcmRlZCBjb25zdHJ1Y3RvciBwYXJhbWV0ZXIgdHlwZXMuICovXG4gIERFU0lHTl9QQVJBTVMgPSBcImRlc2lnbjpwYXJhbXR5cGVzXCIsXG4gIC8qKiBAZGVzY3JpcHRpb24gUmVmbGVjdCBtZXRhZGF0YSBrZXkgZm9yIGEgbWV0aG9kJ3MgcmV0dXJuIHR5cGUuICovXG4gIERFU0lHTl9SRVRVUk4gPSBcImRlc2lnbjpyZXR1cm50eXBlXCIsXG59XG5cbi8qKlxuICogQGRlc2NyaXB0aW9uIERlZmF1bHQgbWV0YWRhdGEgaW5zdGFuY2UuXG4gKiBAc3VtbWFyeSBQcm92aWRlcyB0aGUgZGVmYXVsdCBtZXRhZGF0YSBzaGFwZSB1c2VkIHdoZW4gaW5pdGlhbGl6aW5nIG5ldyBtZXRhZGF0YSBlbnRyaWVzIGZvciBhIG1vZGVsLlxuICogQGNvbnN0IERlZmF1bHRNZXRhZGF0YVxuICogQG1lbWJlck9mIG1vZHVsZTpkZWNvcmF0aW9uXG4gKi9cbmV4cG9ydCBjb25zdCBEZWZhdWx0TWV0YWRhdGE6IEJhc2ljTWV0YWRhdGE8YW55PiA9IHtcbiAgW0RlY29yYXRpb25LZXlzLlBST1BFUlRJRVNdOiBbXSxcbn0gYXMgdW5rbm93biBhcyBCYXNpY01ldGFkYXRhPGFueT47XG4iXX0=

package/lib/esm/decoration/Decoration.d.ts

@@ -1,6 +1,6 @@
 import { DecorationBuilderBuild, DecorationBuilderEnd, DecorationBuilderMid, DecorationBuilderStart, FlavourResolver, IDecorationBuilder } from "./types";
 /**
- * @description Union type covering supported decorator kinds
+ * @description Union type covering supported decorator kinds.
  * @summary Represents any of the standard TypeScript decorator signatures (class, property, or method), enabling flexible registration and application within the Decoration system.
  * @template T
  * @typeDef DecoratorTypes
@@ -8,7 +8,7 @@ import { DecorationBuilderBuild, DecorationBuilderEnd, DecorationBuilderMid, Dec
  */
 export type DecoratorTypes = ClassDecorator | PropertyDecorator | MethodDecorator;
 /**
- * @description Type definition for a decorator factory function
+ * @description Type definition for a decorator factory function.
  * @summary Represents a function that accepts arbitrary arguments and returns a concrete decorator function to be applied to a target.
  * @template A
  * @typeDef DecoratorFactory
@@ -16,11 +16,11 @@ export type DecoratorTypes = ClassDecorator | PropertyDecorator | MethodDecorato
  */
 export type DecoratorFactory = (...args: any[]) => DecoratorTypes;
 /**
- * @description Argument bundle for a decorator factory
+ * @description Argument bundle for a decorator factory.
  * @summary Object form used to defer decorator creation, carrying both the factory function and its argument list to be invoked later during application.
  * @typeDef DecoratorFactoryArgs
- * @property {DecoratorFactory} decorator The factory function that produces a decorator when invoked
- * @property {any[]} args list of arguments to pass to the decorator factory
+ * @property {DecoratorFactory} decorator Factory function that produces a decorator when invoked.
+ * @property {any[]} args List of arguments to pass to the decorator factory.
  * @memberOf module:decoration
  */
 export type DecoratorFactoryArgs = {
@@ -28,20 +28,17 @@ export type DecoratorFactoryArgs = {
     args: any[];
 };
 /**
- * @description Union that represents either a ready-to-apply decorator or a factory with arguments
+ * @description Union that represents either a ready-to-apply decorator or a factory with arguments.
  * @summary Allows registering decorators in two forms: as direct decorator functions or as deferred factories paired with their argument lists for later instantiation.
  * @typeDef DecoratorData
  * @memberOf module:decoration
  */
 export type DecoratorData = DecoratorTypes | DecoratorFactoryArgs;
 /**
- * @description A decorator management class that handles flavoured decorators
- * @summary The Decoration class provides a builder pattern for creating and managing decorators with different flavours.
- * It supports registering, extending, and applying decorators with context-aware flavour resolution.
- * The class implements a fluent interface for defining, extending, and applying decorators with different flavours,
- * allowing for framework-specific decorator implementations while maintaining a consistent API.
- * @template T Type of the decorator (ClassDecorator | PropertyDecorator | MethodDecorator)
- * @param {string} [flavour] Optional flavour parameter for the decorator context
+ * @description A decorator management class that handles flavoured decorators.
+ * @summary The Decoration class provides a builder pattern for creating and managing decorators with different flavours. It supports registering, extending, and applying decorators with context-aware flavour resolution, allowing framework-specific implementations while maintaining a consistent API.
+ * @template T Type of the decorator (ClassDecorator | PropertyDecorator | MethodDecorator).
+ * @param {string} [flavour=DefaultFlavour] Optional flavour parameter for the decorator context.
  * @class
  * @example
  * ```typescript
@@ -79,64 +76,63 @@ export type DecoratorData = DecoratorTypes | DecoratorFactoryArgs;
 export declare class Decoration implements IDecorationBuilder {
     private flavour;
     /**
-     * @description Static map of registered decorators
-     * @summary Stores all registered decorators organized by key and flavour
+     * @description Static map of registered decorators.
+     * @summary Stores all registered decorators organised by key and flavour.
      */
     private static decorators;
     /**
-     * @description Function to resolve flavour from a target
-     * @summary Resolver function that determines the appropriate flavour for a given target
+     * @description Function to resolve flavour from a target.
+     * @summary Resolver function that determines the appropriate flavour for a given target.
      */
     private static flavourResolver;
     /**
-     * @description Set of decorators for the current context
+     * @description Set of decorators for the current context.
      */
     private decorators?;
     /**
-     * @description Set of additional decorators
+     * @description Set of additional decorators.
      */
     private extras?;
     /**
-     * @description Current decorator key
+     * @description Current decorator key.
      */
     private key?;
     constructor(flavour?: string);
     /**
-     * @description Sets the key for the decoration builder
-     * @summary Initializes a new decoration chain with the specified key
-     * @param {string} key The identifier for the decorator
-     * @return {DecorationBuilderMid} Builder instance for method chaining
+     * @description Sets the key for the decoration builder.
+     * @summary Initialises a new decoration chain with the specified key.
+     * @param {string} key Identifier for the decorator.
+     * @return {DecorationBuilderMid} Builder instance for method chaining.
      */
     for(key: string): DecorationBuilderMid;
     /**
-     * @description Adds decorators to the current context
-     * @summary Internal method to add decorators with addon support
-     * @param {boolean} [addon=false] Whether the decorators are addons
-     * @param decorators Array of decorators
-     * @return {this} Current instance for chaining
+     * @description Adds decorators to the current context.
+     * @summary Internal method to add decorators with addon support.
+     * @param {boolean} [addon=false] Indicates whether the decorators are additive extras.
+     * @param {...DecoratorData} decorators Decorators to register for the configured key.
+     * @return {this} Current instance for chaining.
      */
     private decorate;
     /**
-     * @description Defines the base decorators
-     * @summary Sets the primary decorators for the current context
-     * @param decorators Decorators to define
-     * @return Builder instance for finishing the chain
+     * @description Defines the base decorators.
+     * @summary Sets the primary decorators for the current context.
+     * @param {...DecoratorData} decorators Decorators to define.
+     * @return {DecorationBuilderEnd} Builder instance for finishing the chain (also implements DecorationBuilderBuild).
      */
     define(...decorators: DecoratorData[]): DecorationBuilderEnd & DecorationBuilderBuild;
     /**
-     * @description Extends existing decorators
-     * @summary Adds additional decorators to the current context
-     * @param decorators Additional decorators
-     * @return {DecorationBuilderBuild} Builder instance for building the decorator
+     * @description Extends existing decorators.
+     * @summary Adds additional decorators to the current context.
+     * @param {...DecoratorData} decorators Additional decorators to register as addons.
+     * @return {DecorationBuilderBuild} Builder instance for building the decorator.
      */
     extend(...decorators: DecoratorData[]): DecorationBuilderBuild;
     /**
-     * @description Factory that creates a context-aware decorator for a key/flavour
-     * @summary Produces a decorator function bound to the provided key and flavour. The resulting decorator resolves the actual
-     * decorators to apply at invocation time based on the target's resolved flavour and the registered base and extra decorators.
-     * @param {string} key The decoration key used to look up registered decorators
-     * @param {string} [f=DefaultFlavour] Optional explicit flavour to bind the factory to
-     * @return {function(object, any, TypedPropertyDescriptor<any>): any} A decorator function that applies the resolved decorators
+     * @description Factory that creates a context-aware decorator for a key/flavour.
+     * @summary Produces a decorator function bound to the provided key and flavour. The resulting decorator resolves the actual decorators to apply at invocation time based on the target's resolved flavour and the registered base and extra decorators.
+     * @param {string} key Decoration key used to look up registered decorators.
+     * @param {string} [f=DefaultFlavour] Explicit flavour to bind the factory to.
+     * @return {ClassDecorator|MethodDecorator|PropertyDecorator|ParameterDecorator} Decorator function that applies the resolved decorators.
      * @mermaid
      * sequenceDiagram
      *   participant U as User Code
@@ -159,38 +155,40 @@ export declare class Decoration implements IDecorationBuilder {
         descriptor: TypedPropertyDescriptor<any> | undefined;
     };
     /**
-     * @description Creates the final decorator function
-     * @summary Builds and returns the decorator factory function
-     * @return {function(any, any?, TypedPropertyDescriptor?): any} The generated decorator function
+     * @description Creates the final decorator function.
+     * @summary Builds and returns the decorator factory function.
+     * @return {ClassDecorator|MethodDecorator|PropertyDecorator|ParameterDecorator} Generated decorator function ready for application.
      */
     apply(): (target: any, propertyKey?: any, descriptor?: TypedPropertyDescriptor<any>) => any;
     /**
-     * @description Registers decorators for a specific key and flavour
-     * @summary Internal method to store decorators in the static registry
-     * @param {string} key Decorator key
-     * @param {string} flavour Decorator flavour
-     * @param [decorators] Primary decorators
-     * @param [extras] Additional decorators
+     * @description Registers decorators for a specific key and flavour.
+     * @summary Internal method to store decorators in the static registry.
+     * @param {string} key Decorator key.
+     * @param {string} flavour Decorator flavour.
+     * @param {Set<DecoratorData>} [decorators] Primary decorators registered for the key.
+     * @param {Set<DecoratorData>} [extras] Additional decorators registered as flavour-specific addons.
+     * @return {void}
      */
     private static register;
     /**
-     * @description Sets the global flavour resolver
-     * @summary Configures the function used to determine decorator flavours
-     * @param {FlavourResolver} resolver Function to resolve flavours
+     * @description Sets the global flavour resolver.
+     * @summary Configures the function used to determine decorator flavours.
+     * @param {FlavourResolver} resolver Function to resolve flavours.
+     * @return {void}
      */
     static setFlavourResolver(resolver: FlavourResolver): void;
     /**
-     * @description Convenience static entry to start a decoration builder
+     * @description Convenience static entry to start a decoration builder.
      * @summary Creates a new Decoration instance and initiates the builder chain with the provided key.
-     * @param {string} key The decoration key to configure
-     * @return {DecorationBuilderMid} A builder instance for chaining definitions
+     * @param {string} key Decoration key to configure.
+     * @return {DecorationBuilderMid} Builder instance for chaining definitions.
      */
     static for(key: string): DecorationBuilderMid;
     /**
-     * @description Starts a builder for a specific flavour
+     * @description Starts a builder for a specific flavour.
      * @summary Convenience method to begin a Decoration builder chain bound to the given flavour identifier, allowing registration of flavour-specific decorators.
-     * @param {string} flavour The flavour name to bind to the builder
-     * @return {DecorationBuilderStart} A builder start interface to continue configuration
+     * @param {string} flavour Flavour name to bind to the builder.
+     * @return {DecorationBuilderStart} Builder start interface to continue configuration.
      */
     static flavouredAs(flavour: string): DecorationBuilderStart;
 }