@decaf-ts/decoration 0.0.2

package/lib/metadata/Metadata.cjs

@@ -0,0 +1,203 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Metadata = void 0;
+const constants_1 = require("./../constants.cjs");
+require("reflect-metadata");
+/**
+ * @description Retrieves a nested value from an object given a path
+ * @summary Walks an object structure using a splitter-delimited path and returns the value at that location or undefined if any key is missing.
+ * @param {Record<string, any>} obj The object to traverse
+ * @param {string} path The path to the desired value (e.g., "a.b.c")
+ * @param {string} [splitter=ObjectKeySplitter] The delimiter used to split the path
+ * @return {*} The resolved value at the given path or undefined if not found
+ * @function getValueBySplitter
+ * @mermaid
+ * sequenceDiagram
+ *   participant C as Caller
+ *   participant F as getValueBySplitter
+ *   participant O as Object
+ *   C->>F: (obj, path, splitter)
+ *   F->>F: split path into keys
+ *   loop for each key
+ *     F->>O: access current[key]
+ *     alt missing or nullish
+ *       F-->>C: return undefined
+ *     end
+ *   end
+ *   F-->>C: return final value
+ * @memberOf module:decoration
+ */
+function getValueBySplitter(obj, path, splitter = constants_1.ObjectKeySplitter) {
+    const keys = path.split(splitter);
+    let current = obj;
+    for (const key of keys) {
+        if (current === null ||
+            current === undefined ||
+            !Object.prototype.hasOwnProperty.call(current, key))
+            return undefined;
+        current = current[key];
+    }
+    return current;
+}
+/**
+ * @description Sets a nested value on an object given a path
+ * @summary Traverses or creates intermediate objects following a splitter-delimited path and assigns the provided value at the destination key.
+ * @param {Record<string, any>} obj The object to mutate
+ * @param {string} path The destination path (e.g., "a.b.c")
+ * @param {*} value The value to set at the destination
+ * @param {string} [splitter=ObjectKeySplitter] The delimiter used to split the path
+ * @return {void}
+ * @function setValueBySplitter
+ * @mermaid
+ * sequenceDiagram
+ *   participant C as Caller
+ *   participant F as setValueBySplitter
+ *   participant O as Object
+ *   C->>F: (obj, path, value, splitter)
+ *   F->>F: split path into keys
+ *   loop for each key
+ *     alt key missing
+ *       F->>O: create intermediate object
+ *     else key exists
+ *       F->>O: descend into existing object
+ *     end
+ *   end
+ *   F-->>C: void
+ * @memberOf module:decoration
+ */
+function setValueBySplitter(obj, path, value, splitter = constants_1.ObjectKeySplitter) {
+    const keys = path.split(splitter).filter((k) => k.length > 0);
+    if (keys.length === 0)
+        return;
+    let current = obj;
+    for (let i = 0; i < keys.length - 1; i++) {
+        const key = keys[i];
+        if (current[key] === undefined ||
+            current[key] === null ||
+            typeof current[key] !== "object") {
+            current[key] = {};
+        }
+        current = current[key];
+    }
+    const lastKey = keys[keys.length - 1];
+    current[lastKey] = value;
+}
+/**
+ * @description Centralized runtime metadata store bound to constructors
+ * @summary Provides utilities to read and write structured metadata for classes and their members, with optional mirroring onto the constructor via a well-known symbol key. Supports nested key paths using a configurable splitter and offers both instance and static APIs.
+ * @template M The model type the metadata belongs to
+ * @template META Extends BasicMetadata<M> representing the metadata structure
+ * @class
+ * @example
+ * // Define and read metadata for a class
+ * class User { name!: string }
+ * Metadata.set(User, "description.class", "A user model");
+ * Metadata.set(User, "properties.name", String);
+ * const desc = Metadata.get(User, "description.class"); // "A user model"
+ * const type = Metadata.type(User, "name"); // String
+ * @mermaid
+ * sequenceDiagram
+ *   participant C as Constructor
+ *   participant S as Metadata (static)
+ *   C->>S: set(User, "properties.name", String)
+ *   C->>S: get(User, "properties.name")
+ *   S-->>C: String
+ */
+class Metadata {
+    /**
+     * @description In-memory storage of metadata by constructor symbol
+     * @summary Maps a Symbol derived from the constructor to its metadata object, enabling efficient lookup.
+     */
+    static { this._metadata = {}; }
+    /**
+     * @description Path delimiter for nested metadata keys
+     * @summary Used by get/set operations to navigate nested structures, defaults to ObjectKeySplitter.
+     */
+    static { this.splitter = constants_1.ObjectKeySplitter; }
+    /**
+     * @description Symbol key used to mirror metadata on the constructor
+     * @summary When mirroring is enabled, the metadata object is defined on the constructor under this non-enumerable key.
+     */
+    static { this.baseKey = constants_1.DecorationKeys.REFLECT; }
+    /**
+     * @description Controls whether metadata is mirrored onto the constructor
+     * @summary When true, the metadata object is defined on the constructor under the non-enumerable baseKey.
+     */
+    static { this.mirror = true; }
+    constructor() { }
+    /**
+     * @description Lists known property keys for a model
+     * @summary Reads the metadata entry and returns the names of properties that have recorded type information.
+     * @param {Constructor} model The target constructor
+     * @return {string[]|undefined} Array of property names or undefined if no metadata exists
+     */
+    static properties(model) {
+        const meta = this.get(model);
+        if (!meta)
+            return undefined;
+        return Object.keys(meta.properties);
+    }
+    /**
+     * @description Retrieves a human-readable description for a class or a property
+     * @summary Looks up the description stored under the metadata "description" map. If a property key is provided, returns the property's description; otherwise returns the class description.
+     * @template M
+     * @param {Constructor<M>} model The target constructor whose description is being retrieved
+     * @param {string} [prop] Optional property key for which to fetch the description
+     * @return {string|undefined} The description text if present, otherwise undefined
+     */
+    static description(model, prop) {
+        return this.get(model, [constants_1.DecorationKeys.DESCRIPTION, prop ? prop : constants_1.DecorationKeys.CLASS].join(constants_1.ObjectKeySplitter));
+    }
+    /**
+     * @description Retrieves the recorded design type for a property
+     * @summary Reads the metadata entry under "properties.<prop>" to return the constructor recorded for the given property name.
+     * @param {Constructor} model The target constructor
+     * @param {string} prop The property name whose type should be returned
+     * @return {Constructor|undefined} The constructor reference of the property type or undefined if not available
+     */
+    static type(model, prop) {
+        return this.get(model, `${constants_1.DecorationKeys.PROPERTIES}.${prop}`);
+    }
+    /**
+     * @description Retrieves metadata for a model or a specific key within it
+     * @summary When called with a constructor only, returns the entire metadata object associated with the model. When a key path is provided, returns the value stored at that nested key.
+     * @template M
+     * @template META
+     * @param {Constructor<M>} model The target constructor used to locate the metadata record
+     * @param {string} [key] Optional nested key path to fetch a specific value
+     * @return {META|*|undefined} The metadata object, the value at the key path, or undefined if nothing exists
+     */
+    static get(model, key) {
+        const symbol = Symbol.for(model.toString());
+        if (!this._metadata[symbol])
+            return undefined;
+        if (!key)
+            return this._metadata[symbol];
+        return getValueBySplitter(this._metadata[symbol], key, this.splitter);
+    }
+    /**
+     * @description Writes a metadata value at a given nested key path
+     * @summary Ensures the metadata record exists for the constructor, mirrors it on the constructor when enabled, and sets the provided value on the nested key path using the configured splitter.
+     * @param {Constructor} model The target constructor to which the metadata belongs
+     * @param {string} key The nested key path at which to store the value
+     * @param {*} value The value to store in the metadata
+     * @return {void}
+     */
+    static set(model, key, value) {
+        const symbol = Symbol.for(model.toString());
+        if (!this._metadata[symbol])
+            this._metadata[symbol] = {};
+        if (Metadata.mirror &&
+            !Object.prototype.hasOwnProperty.call(model, this.baseKey)) {
+            Object.defineProperty(model, this.baseKey, {
+                enumerable: false,
+                configurable: false,
+                writable: false,
+                value: this._metadata[symbol],
+            });
+        }
+        setValueBySplitter(this._metadata[symbol], key, value, this.splitter);
+    }
+}
+exports.Metadata = Metadata;
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"Metadata.js","sourceRoot":"","sources":["../../src/metadata/Metadata.ts"],"names":[],"mappings":";;;AACA,kDAAiE;AACjE,4BAA0B;AAE1B;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,SAAS,kBAAkB,CACzB,GAAwB,EACxB,IAAY,EACZ,WAAmB,6BAAiB;IAEpC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAClC,IAAI,OAAO,GAAG,GAAG,CAAC;IAElB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,IACE,OAAO,KAAK,IAAI;YAChB,OAAO,KAAK,SAAS;YACrB,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC;YAEnD,OAAO,SAAS,CAAC;QACnB,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACzB,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,SAAS,kBAAkB,CACzB,GAAwB,EACxB,IAAY,EACZ,KAAU,EACV,QAAQ,GAAG,6BAAiB;IAE5B,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAC9D,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO;IAE9B,IAAI,OAAO,GAAqB,GAAG,CAAC;IAEpC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QACzC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QACpB,IACE,OAAO,CAAC,GAAG,CAAC,KAAK,SAAS;YAC1B,OAAO,CAAC,GAAG,CAAC,KAAK,IAAI;YACrB,OAAO,OAAO,CAAC,GAAG,CAAC,KAAK,QAAQ,EAChC,CAAC;YACD,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;QACpB,CAAC;QACD,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACzB,CAAC;IAED,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACtC,OAAO,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC;AAC3B,CAAC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAa,QAAQ;IACnB;;;OAGG;aACY,cAAS,GAAwB,EAAE,CAAC;IAEnD;;;OAGG;aACI,aAAQ,GAAG,6BAAiB,CAAC;IACpC;;;OAGG;aACI,YAAO,GAAG,0BAAc,CAAC,OAAO,CAAC;IACxC;;;OAGG;aACI,WAAM,GAAY,IAAI,CAAC;IAE9B,gBAAuB,CAAC;IAExB;;;;;OAKG;IACH,MAAM,CAAC,UAAU,CAAC,KAAkB;QAClC,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC7B,IAAI,CAAC,IAAI;YAAE,OAAO,SAAS,CAAC;QAC5B,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,WAAW,CAAI,KAAqB,EAAE,IAAc;QACzD,OAAO,IAAI,CAAC,GAAG,CACb,KAAK,EACL,CAAC,0BAAc,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,0BAAc,CAAC,KAAK,CAAC,CAAC,IAAI,CACnE,6BAAiB,CAClB,CACF,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,CAAC,KAAkB,EAAE,IAAY;QAC1C,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,0BAAc,CAAC,UAAU,IAAI,IAAI,EAAE,CAAC,CAAC;IACjE,CAAC;IAuBD;;;;;;;;OAQG;IACH,MAAM,CAAC,GAAG,CAAC,KAAkB,EAAE,GAAY;QACzC,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC5C,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;YAAE,OAAO,SAAS,CAAC;QAC9C,IAAI,CAAC,GAAG;YAAE,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QACxC,OAAO,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,GAAG,CAAC,KAAkB,EAAE,GAAW,EAAE,KAAU;QACpD,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC5C,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;YAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,EAAS,CAAC;QAChE,IACE,QAAQ,CAAC,MAAM;YACf,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,EAC1D,CAAC;YACD,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,EAAE;gBACzC,UAAU,EAAE,KAAK;gBACjB,YAAY,EAAE,KAAK;gBACnB,QAAQ,EAAE,KAAK;gBACf,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;aAC9B,CAAC,CAAC;QACL,CAAC;QACD,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IACxE,CAAC;;AA7HH,4BA8HC","sourcesContent":["import { BasicMetadata, Constructor } from \"./types\";\nimport { DecorationKeys, ObjectKeySplitter } from \"../constants\";\nimport \"reflect-metadata\";\n\n/**\n * @description Retrieves a nested value from an object given a path\n * @summary Walks an object structure using a splitter-delimited path and returns the value at that location or undefined if any key is missing.\n * @param {Record<string, any>} obj The object to traverse\n * @param {string} path The path to the desired value (e.g., \"a.b.c\")\n * @param {string} [splitter=ObjectKeySplitter] The delimiter used to split the path\n * @return {*} The resolved value at the given path or undefined if not found\n * @function getValueBySplitter\n * @mermaid\n * sequenceDiagram\n *   participant C as Caller\n *   participant F as getValueBySplitter\n *   participant O as Object\n *   C->>F: (obj, path, splitter)\n *   F->>F: split path into keys\n *   loop for each key\n *     F->>O: access current[key]\n *     alt missing or nullish\n *       F-->>C: return undefined\n *     end\n *   end\n *   F-->>C: return final value\n * @memberOf module:decoration\n */\nfunction getValueBySplitter(\n  obj: Record<string, any>,\n  path: string,\n  splitter: string = ObjectKeySplitter\n): any {\n  const keys = path.split(splitter);\n  let current = obj;\n\n  for (const key of keys) {\n    if (\n      current === null ||\n      current === undefined ||\n      !Object.prototype.hasOwnProperty.call(current, key)\n    )\n      return undefined;\n    current = current[key];\n  }\n\n  return current;\n}\n\n/**\n * @description Sets a nested value on an object given a path\n * @summary Traverses or creates intermediate objects following a splitter-delimited path and assigns the provided value at the destination key.\n * @param {Record<string, any>} obj The object to mutate\n * @param {string} path The destination path (e.g., \"a.b.c\")\n * @param {*} value The value to set at the destination\n * @param {string} [splitter=ObjectKeySplitter] The delimiter used to split the path\n * @return {void}\n * @function setValueBySplitter\n * @mermaid\n * sequenceDiagram\n *   participant C as Caller\n *   participant F as setValueBySplitter\n *   participant O as Object\n *   C->>F: (obj, path, value, splitter)\n *   F->>F: split path into keys\n *   loop for each key\n *     alt key missing\n *       F->>O: create intermediate object\n *     else key exists\n *       F->>O: descend into existing object\n *     end\n *   end\n *   F-->>C: void\n * @memberOf module:decoration\n */\nfunction setValueBySplitter(\n  obj: Record<string, any>,\n  path: string,\n  value: any,\n  splitter = ObjectKeySplitter\n): void {\n  const keys = path.split(splitter).filter((k) => k.length > 0);\n  if (keys.length === 0) return;\n\n  let current: Record<any, any> = obj;\n\n  for (let i = 0; i < keys.length - 1; i++) {\n    const key = keys[i];\n    if (\n      current[key] === undefined ||\n      current[key] === null ||\n      typeof current[key] !== \"object\"\n    ) {\n      current[key] = {};\n    }\n    current = current[key];\n  }\n\n  const lastKey = keys[keys.length - 1];\n  current[lastKey] = value;\n}\n\n/**\n * @description Centralized runtime metadata store bound to constructors\n * @summary Provides utilities to read and write structured metadata for classes and their members, with optional mirroring onto the constructor via a well-known symbol key. Supports nested key paths using a configurable splitter and offers both instance and static APIs.\n * @template M The model type the metadata belongs to\n * @template META Extends BasicMetadata<M> representing the metadata structure\n * @class\n * @example\n * // Define and read metadata for a class\n * class User { name!: string }\n * Metadata.set(User, \"description.class\", \"A user model\");\n * Metadata.set(User, \"properties.name\", String);\n * const desc = Metadata.get(User, \"description.class\"); // \"A user model\"\n * const type = Metadata.type(User, \"name\"); // String\n * @mermaid\n * sequenceDiagram\n *   participant C as Constructor\n *   participant S as Metadata (static)\n *   C->>S: set(User, \"properties.name\", String)\n *   C->>S: get(User, \"properties.name\")\n *   S-->>C: String\n */\nexport class Metadata {\n  /**\n   * @description In-memory storage of metadata by constructor symbol\n   * @summary Maps a Symbol derived from the constructor to its metadata object, enabling efficient lookup.\n   */\n  private static _metadata: Record<symbol, any> = {};\n\n  /**\n   * @description Path delimiter for nested metadata keys\n   * @summary Used by get/set operations to navigate nested structures, defaults to ObjectKeySplitter.\n   */\n  static splitter = ObjectKeySplitter;\n  /**\n   * @description Symbol key used to mirror metadata on the constructor\n   * @summary When mirroring is enabled, the metadata object is defined on the constructor under this non-enumerable key.\n   */\n  static baseKey = DecorationKeys.REFLECT;\n  /**\n   * @description Controls whether metadata is mirrored onto the constructor\n   * @summary When true, the metadata object is defined on the constructor under the non-enumerable baseKey.\n   */\n  static mirror: boolean = true;\n\n  private constructor() {}\n\n  /**\n   * @description Lists known property keys for a model\n   * @summary Reads the metadata entry and returns the names of properties that have recorded type information.\n   * @param {Constructor} model The target constructor\n   * @return {string[]|undefined} Array of property names or undefined if no metadata exists\n   */\n  static properties(model: Constructor): string[] | undefined {\n    const meta = this.get(model);\n    if (!meta) return undefined;\n    return Object.keys(meta.properties);\n  }\n\n  /**\n   * @description Retrieves a human-readable description for a class or a property\n   * @summary Looks up the description stored under the metadata \"description\" map. If a property key is provided, returns the property's description; otherwise returns the class description.\n   * @template M\n   * @param {Constructor<M>} model The target constructor whose description is being retrieved\n   * @param {string} [prop] Optional property key for which to fetch the description\n   * @return {string|undefined} The description text if present, otherwise undefined\n   */\n  static description<M>(model: Constructor<M>, prop?: keyof M) {\n    return this.get(\n      model,\n      [DecorationKeys.DESCRIPTION, prop ? prop : DecorationKeys.CLASS].join(\n        ObjectKeySplitter\n      )\n    );\n  }\n\n  /**\n   * @description Retrieves the recorded design type for a property\n   * @summary Reads the metadata entry under \"properties.<prop>\" to return the constructor recorded for the given property name.\n   * @param {Constructor} model The target constructor\n   * @param {string} prop The property name whose type should be returned\n   * @return {Constructor|undefined} The constructor reference of the property type or undefined if not available\n   */\n  static type(model: Constructor, prop: string) {\n    return this.get(model, `${DecorationKeys.PROPERTIES}.${prop}`);\n  }\n\n  /**\n   * @description Retrieves metadata for a model or a specific key within it\n   * @summary When called with a constructor only, returns the entire metadata object associated with the model. When a key path is provided, returns the value stored at that nested key.\n   * @template M\n   * @template META\n   * @param {Constructor<M>} model The target constructor used to locate the metadata record\n   * @return {META|undefined} The metadata object, the value at the key path, or undefined if nothing exists\n   */\n  static get<M, META extends BasicMetadata<M> = BasicMetadata<M>>(\n    model: Constructor<M>\n  ): META | undefined;\n  /**\n   * @description Retrieves metadata for a model or a specific key within it\n   * @summary When called with a constructor only, returns the entire metadata object associated with the model. When a key path is provided, returns the value stored at that nested key.\n   * @template M\n   * @template META\n   * @param {Constructor<M>} model The target constructor used to locate the metadata record\n   * @param {string} key nested key path to fetch a specific value\n   * @return {META|*|undefined} The metadata object, the value at the key path, or undefined if nothing exists\n   */\n  static get(model: Constructor, key: string): any;\n  /**\n   * @description Retrieves metadata for a model or a specific key within it\n   * @summary When called with a constructor only, returns the entire metadata object associated with the model. When a key path is provided, returns the value stored at that nested key.\n   * @template M\n   * @template META\n   * @param {Constructor<M>} model The target constructor used to locate the metadata record\n   * @param {string} [key] Optional nested key path to fetch a specific value\n   * @return {META|*|undefined} The metadata object, the value at the key path, or undefined if nothing exists\n   */\n  static get(model: Constructor, key?: string) {\n    const symbol = Symbol.for(model.toString());\n    if (!this._metadata[symbol]) return undefined;\n    if (!key) return this._metadata[symbol];\n    return getValueBySplitter(this._metadata[symbol], key, this.splitter);\n  }\n\n  /**\n   * @description Writes a metadata value at a given nested key path\n   * @summary Ensures the metadata record exists for the constructor, mirrors it on the constructor when enabled, and sets the provided value on the nested key path using the configured splitter.\n   * @param {Constructor} model The target constructor to which the metadata belongs\n   * @param {string} key The nested key path at which to store the value\n   * @param {*} value The value to store in the metadata\n   * @return {void}\n   */\n  static set(model: Constructor, key: string, value: any) {\n    const symbol = Symbol.for(model.toString());\n    if (!this._metadata[symbol]) this._metadata[symbol] = {} as any;\n    if (\n      Metadata.mirror &&\n      !Object.prototype.hasOwnProperty.call(model, this.baseKey)\n    ) {\n      Object.defineProperty(model, this.baseKey, {\n        enumerable: false,\n        configurable: false,\n        writable: false,\n        value: this._metadata[symbol],\n      });\n    }\n    setValueBySplitter(this._metadata[symbol], key, value, this.splitter);\n  }\n}\n"]}

package/lib/metadata/Metadata.d.ts

@@ -0,0 +1,99 @@
+import { BasicMetadata, Constructor } from "./types";
+import { DecorationKeys } from "../constants";
+import "reflect-metadata";
+/**
+ * @description Centralized runtime metadata store bound to constructors
+ * @summary Provides utilities to read and write structured metadata for classes and their members, with optional mirroring onto the constructor via a well-known symbol key. Supports nested key paths using a configurable splitter and offers both instance and static APIs.
+ * @template M The model type the metadata belongs to
+ * @template META Extends BasicMetadata<M> representing the metadata structure
+ * @class
+ * @example
+ * // Define and read metadata for a class
+ * class User { name!: string }
+ * Metadata.set(User, "description.class", "A user model");
+ * Metadata.set(User, "properties.name", String);
+ * const desc = Metadata.get(User, "description.class"); // "A user model"
+ * const type = Metadata.type(User, "name"); // String
+ * @mermaid
+ * sequenceDiagram
+ *   participant C as Constructor
+ *   participant S as Metadata (static)
+ *   C->>S: set(User, "properties.name", String)
+ *   C->>S: get(User, "properties.name")
+ *   S-->>C: String
+ */
+export declare class Metadata {
+    /**
+     * @description In-memory storage of metadata by constructor symbol
+     * @summary Maps a Symbol derived from the constructor to its metadata object, enabling efficient lookup.
+     */
+    private static _metadata;
+    /**
+     * @description Path delimiter for nested metadata keys
+     * @summary Used by get/set operations to navigate nested structures, defaults to ObjectKeySplitter.
+     */
+    static splitter: string;
+    /**
+     * @description Symbol key used to mirror metadata on the constructor
+     * @summary When mirroring is enabled, the metadata object is defined on the constructor under this non-enumerable key.
+     */
+    static baseKey: DecorationKeys;
+    /**
+     * @description Controls whether metadata is mirrored onto the constructor
+     * @summary When true, the metadata object is defined on the constructor under the non-enumerable baseKey.
+     */
+    static mirror: boolean;
+    private constructor();
+    /**
+     * @description Lists known property keys for a model
+     * @summary Reads the metadata entry and returns the names of properties that have recorded type information.
+     * @param {Constructor} model The target constructor
+     * @return {string[]|undefined} Array of property names or undefined if no metadata exists
+     */
+    static properties(model: Constructor): string[] | undefined;
+    /**
+     * @description Retrieves a human-readable description for a class or a property
+     * @summary Looks up the description stored under the metadata "description" map. If a property key is provided, returns the property's description; otherwise returns the class description.
+     * @template M
+     * @param {Constructor<M>} model The target constructor whose description is being retrieved
+     * @param {string} [prop] Optional property key for which to fetch the description
+     * @return {string|undefined} The description text if present, otherwise undefined
+     */
+    static description<M>(model: Constructor<M>, prop?: keyof M): any;
+    /**
+     * @description Retrieves the recorded design type for a property
+     * @summary Reads the metadata entry under "properties.<prop>" to return the constructor recorded for the given property name.
+     * @param {Constructor} model The target constructor
+     * @param {string} prop The property name whose type should be returned
+     * @return {Constructor|undefined} The constructor reference of the property type or undefined if not available
+     */
+    static type(model: Constructor, prop: string): any;
+    /**
+     * @description Retrieves metadata for a model or a specific key within it
+     * @summary When called with a constructor only, returns the entire metadata object associated with the model. When a key path is provided, returns the value stored at that nested key.
+     * @template M
+     * @template META
+     * @param {Constructor<M>} model The target constructor used to locate the metadata record
+     * @return {META|undefined} The metadata object, the value at the key path, or undefined if nothing exists
+     */
+    static get<M, META extends BasicMetadata<M> = BasicMetadata<M>>(model: Constructor<M>): META | undefined;
+    /**
+     * @description Retrieves metadata for a model or a specific key within it
+     * @summary When called with a constructor only, returns the entire metadata object associated with the model. When a key path is provided, returns the value stored at that nested key.
+     * @template M
+     * @template META
+     * @param {Constructor<M>} model The target constructor used to locate the metadata record
+     * @param {string} key nested key path to fetch a specific value
+     * @return {META|*|undefined} The metadata object, the value at the key path, or undefined if nothing exists
+     */
+    static get(model: Constructor, key: string): any;
+    /**
+     * @description Writes a metadata value at a given nested key path
+     * @summary Ensures the metadata record exists for the constructor, mirrors it on the constructor when enabled, and sets the provided value on the nested key path using the configured splitter.
+     * @param {Constructor} model The target constructor to which the metadata belongs
+     * @param {string} key The nested key path at which to store the value
+     * @param {*} value The value to store in the metadata
+     * @return {void}
+     */
+    static set(model: Constructor, key: string, value: any): void;
+}

package/lib/metadata/index.cjs

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./Metadata.cjs"), exports);
+__exportStar(require("./types.cjs"), exports);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvbWV0YWRhdGEvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLGlEQUEyQjtBQUMzQiw4Q0FBd0IiLCJzb3VyY2VzQ29udGVudCI6WyJleHBvcnQgKiBmcm9tIFwiLi9NZXRhZGF0YVwiO1xuZXhwb3J0ICogZnJvbSBcIi4vdHlwZXNcIjtcbiJdfQ==

package/lib/metadata/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./Metadata";
+export * from "./types";

package/lib/metadata/types.cjs

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const constants_1 = require("./../constants.cjs");
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvbWV0YWRhdGEvdHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFBQSxrREFBOEMiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBEZWNvcmF0aW9uS2V5cyB9IGZyb20gXCIuLi9jb25zdGFudHNcIjtcblxuZXhwb3J0IHR5cGUgQmFzaWNNZXRhZGF0YTxNPiA9IHtcbiAgW0RlY29yYXRpb25LZXlzLkNMQVNTXTogQ29uc3RydWN0b3I8TT47XG4gIFtEZWNvcmF0aW9uS2V5cy5ERVNDUklQVElPTl0/OiBSZWNvcmQ8XG4gICAga2V5b2YgTSB8IGAke0RlY29yYXRpb25LZXlzLkNMQVNTfWAsXG4gICAgc3RyaW5nXG4gID47XG4gIFtEZWNvcmF0aW9uS2V5cy5QUk9QRVJUSUVTXTogUmVjb3JkPGtleW9mIE0sIENvbnN0cnVjdG9yPE0+IHwgdW5kZWZpbmVkPjtcbn07XG5cbi8qKlxuICogQGRlc2NyaXB0aW9uIENvbnN0cnVjdG9yIHR5cGUgZm9yIGNyZWF0aW5nIGluc3RhbmNlcyBvZiBhIGdpdmVuIG9iamVjdCB0eXBlXG4gKiBAc3VtbWFyeSBEZWZpbmVzIGEgZ2VuZXJpYyBjb25zdHJ1Y3RvciBzaWduYXR1cmUgdGhhdCBjYW4gaW5zdGFudGlhdGUgb2JqZWN0cyBvZiB0eXBlIE9CSiB3aXRoIGFueSBhcmd1bWVudHMuXG4gKiBAdGVtcGxhdGUgT0JKXG4gKiBAdHlwZWRlZiB7Q29uc3RydWN0b3I8T0JKPn0gQ29uc3RydWN0b3JcbiAqIEBtZW1iZXJPZiBtb2R1bGU6ZGVjb3JhdGlvblxuICovXG5leHBvcnQgdHlwZSBDb25zdHJ1Y3RvcjxPQkogPSBhbnk+ID0geyBuZXcgKC4uLmFyZ3M6IGFueVtdKTogT0JKIH07XG4iXX0=

package/lib/metadata/types.d.ts

@@ -0,0 +1,16 @@
+import { DecorationKeys } from "../constants";
+export type BasicMetadata<M> = {
+    [DecorationKeys.CLASS]: Constructor<M>;
+    [DecorationKeys.DESCRIPTION]?: Record<keyof M | `${DecorationKeys.CLASS}`, string>;
+    [DecorationKeys.PROPERTIES]: Record<keyof M, Constructor<M> | undefined>;
+};
+/**
+ * @description Constructor type for creating instances of a given object type
+ * @summary Defines a generic constructor signature that can instantiate objects of type OBJ with any arguments.
+ * @template OBJ
+ * @typedef {Constructor<OBJ>} Constructor
+ * @memberOf module:decoration
+ */
+export type Constructor<OBJ = any> = {
+    new (...args: any[]): OBJ;
+};

package/package.json

@@ -0,0 +1,114 @@
+{
+  "name": "@decaf-ts/decoration",
+  "version": "0.0.2",
+  "description": "Decoration and metadata mechanisms for decaf-ts",
+  "type": "module",
+  "exports": {
+    "require": "./lib/index.cjs",
+    "import": "./lib/esm/index.js"
+  },
+  "types": "lib/index.d.ts",
+  "scripts": {
+    "do-install": "TOKEN=$(cat .token) npm install",
+    "update-dependencies": "PREFIX=\"decaf-ts\"; npm ls | grep \"$PREFIX\" | awk -F/ '{print $NF}' | sed 's/@.*//' | xargs -I package npm update @\"$PREFIX\"/package",
+    "update-scripts": "npx update-scripts",
+    "on-first-run": "npx update-scripts --boot",
+    "set-git-auth": "git config url.\"https://api:$(cat .token)@github.com/\".insteadOf \"https://github.com/\" && git config url.\"https://ssh:$(cat .token)@github.com/\".insteadOf \"ssh://git@github.com/\" && git config url.\"https://git:$(cat .token)@github.com/\".insteadOf \"git@github.com:\"",
+    "flash-forward": "npx npm-check-updates -u && npm run do-install",
+    "reset": "rm -rf * && git checkout . && git pull && npm run do-install",
+    "build": "npx build-scripts --dev",
+    "build:prod": "npx build-scripts --prod",
+    "test": "jest --runInBand --coverage --detectOpenHandles",
+    "test:unit": "jest --testPathPattern=\"/tests/unit\" --passWithNoTests --detectOpenHandles",
+    "test:integration": "jest --testPathPattern=\"/tests/(integration)\" --passWithNoTests --detectOpenHandles",
+    "test:all": "jest --testPathPattern=\"/tests\" --passWithNoTests --detectOpenHandles",
+    "test:circular": "dpdm -T --no-warning --no-tree ./src/index.ts",
+    "coverage": "rimraf ./workdocs/reports/data/*.json && npm run test:all -- --coverage --config=./workdocs/reports/jest.coverage.config.ts",
+    "lint": "eslint .",
+    "lint-fix": "eslint --fix .",
+    "prepare-pr": "npm run lint-fix && npm run build:prod && npm run coverage && npm run docs",
+    "prepare-release": "npm run lint-fix && npm run build:prod && npm run coverage && npm run docs",
+    "release": "./bin/tag-release.sh",
+    "clean-publish": "npx clean-publish",
+    "drawings": "for FILE in workdocs/drawings/*.drawio; do echo \"converting $FILE to image...\" && docker run --rm -v $(pwd):/data rlespinasse/drawio-export --format png $FILE; done && cp -rf workdocs/drawings/export/* workdocs/resources/",
+    "uml": "cd workdocs/uml && for FILE in ./*.puml; do docker run --rm -v $(pwd):/work -w /work miy4/plantuml -DPLANTUML_LIMIT_SIZE=8192 -tpng $FILE; done && cd ../.. && cp -fr workdocs/uml/*.png workdocs/resources/",
+    "docs": "npx rimraf ./docs && mkdir docs && npx build-scripts --docs",
+    "publish-docs": "docker run -it --rm --user $(id -u):$(id -g) -v \"$(pwd)/workdocs/confluence:/content\" -e ATLASSIAN_API_TOKEN=$(cat .confluence-token) ghcr.io/markdown-confluence/publish:latest"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/decaf-ts/decoration.git"
+  },
+  "engines": {
+    "node": ">=20.0.0",
+    "npm": ">=10.0.0"
+  },
+  "files": [
+    "lib",
+    "dist"
+  ],
+  "keywords": [
+    "plantuml",
+    "mermaid",
+    "uml",
+    "drawio",
+    "mddocs",
+    "md",
+    "jsdoc",
+    "doc",
+    "docs",
+    "documentation",
+    "test",
+    "reports",
+    "confluence",
+    "ci/cd",
+    "ci",
+    "cd",
+    "template",
+    "typescript",
+    "ts"
+  ],
+  "author": "Tiago Venceslau",
+  "bugs": {
+    "url": "https://github.com/decaf-ts/decoration/issues"
+  },
+  "homepage": "https://github.com/decaf-ts/decoration#readme",
+  "devDependencies": {
+    "@decaf-ts/logging": "latest",
+    "@decaf-ts/utils": "latest",
+    "@eslint/js": "^9.25.1",
+    "@rollup/plugin-commonjs": "^28.0.3",
+    "@rollup/plugin-json": "^6.1.0",
+    "@rollup/plugin-node-resolve": "^16.0.1",
+    "@rollup/plugin-typescript": "^12.1.2",
+    "@stylistic/eslint-plugin": "^4.2.0",
+    "@types/jest": "^29.5.14",
+    "clean-publish": "^5.1.0",
+    "dpdm": "^3.14.0",
+    "eslint": "^9.25.1",
+    "eslint-config-prettier": "^10.1.2",
+    "eslint-plugin-prettier": "^5.2.6",
+    "globals": "^16.0.0",
+    "jest": "^29.7.0",
+    "jest-html-reporters": "^3.1.7",
+    "jest-junit": "^16.0.0",
+    "jsdoc": "^4.0.4",
+    "jsdoc-mermaid": "^1.0.0",
+    "markdown-include": "^0.4.3",
+    "minimist": "^1.2.8",
+    "nodemon": "^3.1.9",
+    "npm-check-updates": "^18.0.0",
+    "prettier": "3.5.3",
+    "rimraf": "^6.0.1",
+    "rollup": "^4.40.0",
+    "ts-jest": "^29.3.2",
+    "ts-loader": "^9.5.2",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.8.3",
+    "typescript-eslint": "^8.31.0"
+  },
+  "peerDependencies": {
+    "reflect-metadata": "^0.2.2",
+    "typed-object-accumulator": "^0.1.5"
+  }
+}