@decaf-ts/ui-decorators 0.4.0

package/lib/model/index.cjs

@@ -0,0 +1,25 @@
+"use strict";
+/**
+ * @namespace model
+ * @memberOf ui-decorators
+ */
+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 });
+require("./model.cjs");
+__exportStar(require("./decorators.cjs"), exports);
+__exportStar(require("./overrides.cjs"), exports);
+
+//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInNyYy9tb2RlbC9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUE7OztHQUdHOzs7Ozs7Ozs7Ozs7Ozs7O0FBRUgsbUJBQWlCO0FBRWpCLCtDQUE2QjtBQUM3Qiw4Q0FBNEIiLCJmaWxlIjoibW9kZWwvaW5kZXguanMiLCJzb3VyY2VzQ29udGVudCI6WyIvKipcbiAqIEBuYW1lc3BhY2UgbW9kZWxcbiAqIEBtZW1iZXJPZiB1aS1kZWNvcmF0b3JzXG4gKi9cblxuaW1wb3J0IFwiLi9tb2RlbFwiO1xuXG5leHBvcnQgKiBmcm9tIFwiLi9kZWNvcmF0b3JzXCI7XG5leHBvcnQgKiBmcm9tIFwiLi9vdmVycmlkZXNcIjtcbiJdfQ==

package/lib/model/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @namespace model
+ * @memberOf ui-decorators
+ */
+import "./model";
+export * from "./decorators";
+export * from "./overrides";

package/lib/model/model.cjs

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+
+//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInNyYy9tb2RlbC9tb2RlbC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwiZmlsZSI6Im1vZGVsL21vZGVsLmpzIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgTW9kZWxFcnJvckRlZmluaXRpb24gfSBmcm9tIFwiQGRlY2FmLXRzL2RlY29yYXRvci12YWxpZGF0aW9uXCI7XG5pbXBvcnQge1xuICBCdWlsZGVyUmVnaXN0cnksXG4gIENvbXBhcmFibGUsXG4gIENvbnN0cnVjdG9yLFxuICBIYXNoYWJsZSxcbiAgTW9kZWxBcmcsXG4gIE1vZGVsQnVpbGRlckZ1bmN0aW9uLFxuICBNb2RlbENvbnN0cnVjdG9yLFxuICBTZXJpYWxpemFibGUsXG4gIFZhbGlkYXRhYmxlLFxufSBmcm9tIFwiQGRlY2FmLXRzL2RlY29yYXRvci12YWxpZGF0aW9uXCI7XG5cbmRlY2xhcmUgbW9kdWxlIFwiQGRlY2FmLXRzL2RlY29yYXRvci12YWxpZGF0aW9uXCIge1xuICAvLyBAdHMtZXhwZWN0LWVycm9yIGhhY2t5IG92ZXJyaWRlXG4gIGRlY2xhcmUgYWJzdHJhY3QgY2xhc3MgTW9kZWxcbiAgICBpbXBsZW1lbnRzIFZhbGlkYXRhYmxlLCBTZXJpYWxpemFibGUsIEhhc2hhYmxlLCBDb21wYXJhYmxlPE1vZGVsPlxuICB7XG4gICAgcHJvdGVjdGVkIGNvbnN0cnVjdG9yKGFyZz86IE1vZGVsQXJnPE1vZGVsPik7XG5cbiAgICBoYXNFcnJvcnMoLi4uZXhjbHVzaW9uczogYW55W10pOiBNb2RlbEVycm9yRGVmaW5pdGlvbiB8IHVuZGVmaW5lZDtcbiAgICBoYXNFcnJvcnMoXG4gICAgICBwcmV2aW91c1ZlcnNpb24/OiBNb2RlbCB8IGFueSxcbiAgICAgIC4uLmV4Y2x1c2lvbnM6IGFueVtdXG4gICAgKTogTW9kZWxFcnJvckRlZmluaXRpb24gfCB1bmRlZmluZWQ7XG5cbiAgICAvKipcbiAgICAgKiBAc3VtbWFyeSBDb21wYXJlIG9iamVjdCBlcXVhbGl0eSByZWN1cnNpdmVseVxuICAgICAqIEBwYXJhbSB7YW55fSBvYmogb2JqZWN0IHRvIGNvbXBhcmUgdG9cbiAgICAgKiBAcGFyYW0ge3N0cmluZ30gW2V4Y2VwdGlvbnNdIHByb3BlcnR5IG5hbWVzIHRvIGJlIGV4Y2x1ZGVkIGZyb20gdGhlIGNvbXBhcmlzb25cbiAgICAgKi9cbiAgICBlcXVhbHMob2JqOiBhbnksIC4uLmV4Y2VwdGlvbnM6IHN0cmluZ1tdKTogYm9vbGVhbjtcbiAgICAvKipcbiAgICAgKiBAc3VtbWFyeSBSZXR1cm5zIHRoZSBzZXJpYWxpemVkIG1vZGVsIGFjY29yZGluZyB0byB0aGUgY3VycmVudGx5IGRlZmluZWQge0BsaW5rIFNlcmlhbGl6ZXJ9XG4gICAgICovXG4gICAgc2VyaWFsaXplKCk6IHN0cmluZztcbiAgICAvKipcbiAgICAgKiBAc3VtbWFyeSBPdmVycmlkZSB0aGUgaW1wbGVtZW50YXRpb24gZm9yIGpzJ3MgJ3RvU3RyaW5nKCknIHdoaWNoIHN1Y2tzLi4uXG4gICAgICogQG92ZXJyaWRlXG4gICAgICovXG4gICAgdG9TdHJpbmcoKTogc3RyaW5nO1xuICAgIC8qKlxuICAgICAqIEBzdW1tYXJ5IERlZmluZXMgYSBkZWZhdWx0IGltcGxlbWVudGF0aW9uIGZvciBvYmplY3QgaGFzaC4gUmVsaWVzIG9uIGEgdmVyeSBiYXNpYyBpbXBsZW1lbnRhdGlvbiBiYXNlZCBvbiBKYXZhJ3Mgc3RyaW5nIGhhc2g7XG4gICAgICovXG4gICAgaGFzaCgpOiBzdHJpbmc7XG4gICAgLyoqXG4gICAgICogQHN1bW1hcnkgRGVzZXJpYWxpemVzIGEgTW9kZWxcbiAgICAgKiBAcGFyYW0ge3N0cmluZ30gc3RyXG4gICAgICpcbiAgICAgKiBAcGFyYW0gYXJnc1xuICAgICAqIEB0aHJvd3Mge0Vycm9yfSBJZiBpdCBmYWlscyB0byBwYXJzZSB0aGUgc3RyaW5nLCBvciBpZiBpdCBmYWlscyB0byBidWlsZCB0aGUgbW9kZWxcbiAgICAgKi9cbiAgICBzdGF0aWMgZGVzZXJpYWxpemUoc3RyOiBzdHJpbmcpOiBhbnk7XG4gICAgLyoqXG4gICAgICogQHN1bW1hcnkgUmVwb3B1bGF0ZXMgdGhlIE9iamVjdCBwcm9wZXJ0aWVzIHdpdGggdGhlIG9uZXMgZnJvbSB0aGUgbmV3IG9iamVjdFxuICAgICAqIEBkZXNjcmlwdGlvbiBJdGVyYXRlcyBhbGwgY29tbW9uIHByb3BlcnRpZXMgb2Ygb2JqIChpZiBleGlzdGluZykgYW5kIHNlbGYsIGFuZCBjb3BpZXMgdGhlbSBvbnRvIHNlbGZcbiAgICAgKlxuICAgICAqIEBwYXJhbSB7VH0gc2VsZlxuICAgICAqIEBwYXJhbSB7VCB8IFJlY29yZDxzdHJpbmcsIGFueT59IFtvYmpdXG4gICAgICpcbiAgICAgKi9cbiAgICBzdGF0aWMgZnJvbU9iamVjdDxUIGV4dGVuZHMgTW9kZWw+KFxuICAgICAgc2VsZjogVCxcbiAgICAgIG9iaj86IFQgfCBSZWNvcmQ8c3RyaW5nLCBhbnk+XG4gICAgKTogVDtcbiAgICAvKipcbiAgICAgKiBAc3VtbWFyeSBSZXBvcHVsYXRlcyB0aGUgaW5zdGFuY2Ugd2l0aCB0aGUgb25lcyBmcm9tIHRoZSBuZXcgTW9kZWwgT2JqZWN0XG4gICAgICogQGRlc2NyaXB0aW9uIEl0ZXJhdGVzIGFsbCBjb21tb24gcHJvcGVydGllcyBvZiBvYmogKGlmIGV4aXN0aW5nKSBhbmQgc2VsZiwgYW5kIGNvcGllcyB0aGVtIG9udG8gc2VsZi5cbiAgICAgKiBJcyBhd2FyZSBvZiBuZXN0ZWQgTW9kZWwgT2JqZWN0cyBhbmQgcmVidWlsZHMgdGhlbSBhbHNvLlxuICAgICAqIFdoZW4gTGlzdCBwcm9wZXJ0aWVzIGFyZSBkZWNvcmF0ZWQgd2l0aCB7QGxpbmsgbGlzdH0sIHRoZXkgbGlzdCBpdGVtcyB3aWxsIGFsc28gYmUgcmVidWlsdFxuICAgICAqXG4gICAgICogQHBhcmFtIHtUfSBzZWxmXG4gICAgICogQHBhcmFtIHtUIHwgUmVjb3JkPHN0cmluZywgYW55Pn0gW29ial1cbiAgICAgKlxuICAgICAqL1xuICAgIHN0YXRpYyBmcm9tTW9kZWw8VCBleHRlbmRzIE1vZGVsPihcbiAgICAgIHNlbGY6IFQsXG4gICAgICBvYmo/OiBUIHwgUmVjb3JkPHN0cmluZywgYW55PlxuICAgICk6IFQ7XG4gICAgLyoqXG4gICAgICogQHN1bW1hcnkgU2V0cyB0aGUgR2xvYmFsIHtAbGluayBNb2RlbEJ1aWxkZXJGdW5jdGlvbn1cbiAgICAgKiBAcGFyYW0ge01vZGVsQnVpbGRlckZ1bmN0aW9ufSBbYnVpbGRlcl1cbiAgICAgKi9cbiAgICBzdGF0aWMgc2V0QnVpbGRlcihidWlsZGVyPzogTW9kZWxCdWlsZGVyRnVuY3Rpb24pOiB2b2lkO1xuICAgIC8qKlxuICAgICAqIEBzdW1tYXJ5IFJldHJpZXZlcyB0aGUgY3VycmVudCBnbG9iYWwge0BsaW5rIE1vZGVsQnVpbGRlckZ1bmN0aW9ufVxuICAgICAqL1xuICAgIHN0YXRpYyBnZXRCdWlsZGVyKCk6IE1vZGVsQnVpbGRlckZ1bmN0aW9uIHwgdW5kZWZpbmVkO1xuICAgIC8qKlxuICAgICAqIFJldHVybnMgdGhlIGN1cnJlbnQge0BsaW5rIE1vZGVsUmVnaXN0cnlNYW5hZ2VyfVxuICAgICAqXG4gICAgICogQHJldHVybiBNb2RlbFJlZ2lzdHJ5LCBkZWZhdWx0cyB0byB7QGxpbmsgTW9kZWxSZWdpc3RyeU1hbmFnZXJ9XG4gICAgICovXG4gICAgcHJpdmF0ZSBzdGF0aWMgZ2V0UmVnaXN0cnk7XG4gICAgLyoqXG4gICAgICogUmV0dXJucyB0aGUgY3VycmVudCBhY3RpbmdNb2RlbFJlZ2lzdHJ5XG4gICAgICpcbiAgICAgKiBAcGFyYW0ge0J1aWxkZXJSZWdpc3RyeX0gbW9kZWxSZWdpc3RyeSB0aGUgbmV3IGltcGxlbWVudGF0aW9uIG9mIFJlZ2lzdHJ5XG4gICAgICovXG4gICAgc3RhdGljIHNldFJlZ2lzdHJ5KG1vZGVsUmVnaXN0cnk6IEJ1aWxkZXJSZWdpc3RyeTxhbnk+KTogdm9pZDtcbiAgICAvKipcbiAgICAgKiBAc3VtbWFyeSByZWdpc3RlciBuZXcgTW9kZWxzXG4gICAgICogQHBhcmFtIHthbnl9IGNvbnN0cnVjdG9yXG4gICAgICogQHBhcmFtIHtzdHJpbmd9IFtuYW1lXSB3aGVuIG5vdCBkZWZpbmVkLCB0aGUgbmFtZSBvZiB0aGUgY29uc3RydWN0b3Igd2lsbCBiZSB1c2VkXG4gICAgICpcbiAgICAgKiBAc2VlIE1vZGVsUmVnaXN0cnlcbiAgICAgKi9cbiAgICBzdGF0aWMgcmVnaXN0ZXI8VCBleHRlbmRzIE1vZGVsPihcbiAgICAgIGNvbnN0cnVjdG9yOiBNb2RlbENvbnN0cnVjdG9yPFQ+LFxuICAgICAgbmFtZT86IHN0cmluZ1xuICAgICk6IHZvaWQ7XG4gICAgLyoqXG4gICAgICogQHN1bW1hcnkgR2V0cyBhIHJlZ2lzdGVyZWQgTW9kZWwge0BsaW5rIE1vZGVsQ29uc3RydWN0b3J9XG4gICAgICogQHBhcmFtIHtzdHJpbmd9IG5hbWVcbiAgICAgKlxuICAgICAqIEBzZWUgTW9kZWxSZWdpc3RyeVxuICAgICAqL1xuICAgIHN0YXRpYyBnZXQ8VCBleHRlbmRzIE1vZGVsPihuYW1lOiBzdHJpbmcpOiBNb2RlbENvbnN0cnVjdG9yPFQ+IHwgdW5kZWZpbmVkO1xuICAgIC8qKlxuICAgICAqIEBwYXJhbSB7UmVjb3JkPHN0cmluZywgYW55Pn0gb2JqXG4gICAgICogQHBhcmFtIHtzdHJpbmd9IFtjbGF6el0gd2hlbiBwcm92aWRlZCwgaXQgd2lsbCBhdHRlbXB0IHRvIGZpbmQgdGhlIG1hdGNoaW5nIGNvbnN0cnVjdG9yXG4gICAgICpcbiAgICAgKiBAdGhyb3dzIEVycm9yIElmIGNsYXp6IGlzIG5vdCBmb3VuZCwgb3Igb2JqIGlzIG5vdCBhIHtAbGluayBNb2RlbH0gbWVhbmluZyBpdCBoYXMgbm8ge0BsaW5rIE1vZGVsS2V5cy5BTkNIT1J9IHByb3BlcnR5XG4gICAgICpcbiAgICAgKiBAc2VlIE1vZGVsUmVnaXN0cnlcbiAgICAgKi9cbiAgICBzdGF0aWMgYnVpbGQ8VCBleHRlbmRzIE1vZGVsPihvYmo/OiBSZWNvcmQ8c3RyaW5nLCBhbnk+LCBjbGF6ej86IHN0cmluZyk6IFQ7XG4gICAgc3RhdGljIGdldE1ldGFkYXRhPFYgZXh0ZW5kcyBNb2RlbD4obW9kZWw6IFYpOiBhbnk7XG4gICAgc3RhdGljIGdldEF0dHJpYnV0ZXM8ViBleHRlbmRzIE1vZGVsPihtb2RlbDogQ29uc3RydWN0b3I8Vj4gfCBWKTogc3RyaW5nW107XG4gICAgc3RhdGljIGVxdWFsczxWIGV4dGVuZHMgTW9kZWw+KFxuICAgICAgb2JqMTogVixcbiAgICAgIG9iajI6IFYsXG4gICAgICAuLi5leGNlcHRpb25zOiBhbnlbXVxuICAgICk6IGJvb2xlYW47XG4gICAgc3RhdGljIGhhc0Vycm9yczxWIGV4dGVuZHMgTW9kZWw+KFxuICAgICAgbW9kZWw6IFYsXG4gICAgICAuLi5leGNlcHRpb25zOiBhbnlbXVxuICAgICk6IE1vZGVsRXJyb3JEZWZpbml0aW9uIHwgdW5kZWZpbmVkO1xuICAgIHN0YXRpYyBzZXJpYWxpemU8ViBleHRlbmRzIE1vZGVsPihtb2RlbDogVik6IGFueTtcbiAgICBzdGF0aWMgaGFzaDxWIGV4dGVuZHMgTW9kZWw+KG1vZGVsOiBWKTogYW55O1xuICAgIC8qKlxuICAgICAqIEBzdW1tYXJ5IEJ1aWxkcyB0aGUga2V5IHRvIHN0b3JlIGFzIE1ldGFkYXRhIHVuZGVyIFJlZmxlY3Rpb25zXG4gICAgICogQGRlc2NyaXB0aW9uIGNvbmNhdGVuYXRlcyB7QGxpbmsgTW9kZWxLZXlzI1JFRkxFQ1R9IHdpdGggdGhlIHByb3ZpZGVkIGtleVxuICAgICAqIEBwYXJhbSB7c3RyaW5nfSBzdHJcbiAgICAgKi9cbiAgICBzdGF0aWMga2V5KHN0cjogc3RyaW5nKTogc3RyaW5nO1xuICAgIHJlbmRlcjxSPiguLi5hcmdzOiBhbnlbXSk6IFI7XG4gICAgc3RhdGljIHVpS2V5KGtleTogc3RyaW5nKTogc3RyaW5nO1xuICB9XG59XG4iXX0=

package/lib/model/model.d.ts

@@ -0,0 +1,115 @@
+import { ModelErrorDefinition } from "@decaf-ts/decorator-validation";
+import { BuilderRegistry, Comparable, Constructor, Hashable, ModelArg, ModelBuilderFunction, ModelConstructor, Serializable, Validatable } from "@decaf-ts/decorator-validation";
+declare module "@decaf-ts/decorator-validation" {
+    abstract class Model implements Validatable, Serializable, Hashable, Comparable<Model> {
+        protected constructor(arg?: ModelArg<Model>);
+        hasErrors(...exclusions: any[]): ModelErrorDefinition | undefined;
+        hasErrors(previousVersion?: Model | any, ...exclusions: any[]): ModelErrorDefinition | undefined;
+        /**
+         * @summary Compare object equality recursively
+         * @param {any} obj object to compare to
+         * @param {string} [exceptions] property names to be excluded from the comparison
+         */
+        equals(obj: any, ...exceptions: string[]): boolean;
+        /**
+         * @summary Returns the serialized model according to the currently defined {@link Serializer}
+         */
+        serialize(): string;
+        /**
+         * @summary Override the implementation for js's 'toString()' which sucks...
+         * @override
+         */
+        toString(): string;
+        /**
+         * @summary Defines a default implementation for object hash. Relies on a very basic implementation based on Java's string hash;
+         */
+        hash(): string;
+        /**
+         * @summary Deserializes a Model
+         * @param {string} str
+         *
+         * @param args
+         * @throws {Error} If it fails to parse the string, or if it fails to build the model
+         */
+        static deserialize(str: string): any;
+        /**
+         * @summary Repopulates the Object properties with the ones from the new object
+         * @description Iterates all common properties of obj (if existing) and self, and copies them onto self
+         *
+         * @param {T} self
+         * @param {T | Record<string, any>} [obj]
+         *
+         */
+        static fromObject<T extends Model>(self: T, obj?: T | Record<string, any>): T;
+        /**
+         * @summary Repopulates the instance with the ones from the new Model Object
+         * @description Iterates all common properties of obj (if existing) and self, and copies them onto self.
+         * Is aware of nested Model Objects and rebuilds them also.
+         * When List properties are decorated with {@link list}, they list items will also be rebuilt
+         *
+         * @param {T} self
+         * @param {T | Record<string, any>} [obj]
+         *
+         */
+        static fromModel<T extends Model>(self: T, obj?: T | Record<string, any>): T;
+        /**
+         * @summary Sets the Global {@link ModelBuilderFunction}
+         * @param {ModelBuilderFunction} [builder]
+         */
+        static setBuilder(builder?: ModelBuilderFunction): void;
+        /**
+         * @summary Retrieves the current global {@link ModelBuilderFunction}
+         */
+        static getBuilder(): ModelBuilderFunction | undefined;
+        /**
+         * Returns the current {@link ModelRegistryManager}
+         *
+         * @return ModelRegistry, defaults to {@link ModelRegistryManager}
+         */
+        private static getRegistry;
+        /**
+         * Returns the current actingModelRegistry
+         *
+         * @param {BuilderRegistry} modelRegistry the new implementation of Registry
+         */
+        static setRegistry(modelRegistry: BuilderRegistry<any>): void;
+        /**
+         * @summary register new Models
+         * @param {any} constructor
+         * @param {string} [name] when not defined, the name of the constructor will be used
+         *
+         * @see ModelRegistry
+         */
+        static register<T extends Model>(constructor: ModelConstructor<T>, name?: string): void;
+        /**
+         * @summary Gets a registered Model {@link ModelConstructor}
+         * @param {string} name
+         *
+         * @see ModelRegistry
+         */
+        static get<T extends Model>(name: string): ModelConstructor<T> | undefined;
+        /**
+         * @param {Record<string, any>} obj
+         * @param {string} [clazz] when provided, it will attempt to find the matching constructor
+         *
+         * @throws Error If clazz is not found, or obj is not a {@link Model} meaning it has no {@link ModelKeys.ANCHOR} property
+         *
+         * @see ModelRegistry
+         */
+        static build<T extends Model>(obj?: Record<string, any>, clazz?: string): T;
+        static getMetadata<V extends Model>(model: V): any;
+        static getAttributes<V extends Model>(model: Constructor<V> | V): string[];
+        static equals<V extends Model>(obj1: V, obj2: V, ...exceptions: any[]): boolean;
+        static hasErrors<V extends Model>(model: V, ...exceptions: any[]): ModelErrorDefinition | undefined;
+        static serialize<V extends Model>(model: V): any;
+        static hash<V extends Model>(model: V): any;
+        /**
+         * @summary Builds the key to store as Metadata under Reflections
+         * @description concatenates {@link ModelKeys#REFLECT} with the provided key
+         * @param {string} str
+         */
+        static key(str: string): string;
+        render<R>(...args: any[]): R;
+        static uiKey(key: string): string;
+    }
+}

package/lib/model/overrides.cjs

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const decorator_validation_1 = require("@decaf-ts/decorator-validation");
+const constants_1 = require("../ui/constants.cjs");
+const Rendering_1 = require("../ui/Rendering.cjs");
+decorator_validation_1.Model.prototype.render = function (...args) {
+    return Rendering_1.RenderingEngine.render(this, ...args);
+};
+decorator_validation_1.Model.uiKey = function (key) {
+    return `${constants_1.UIKeys.REFLECT}${key}`;
+};
+
+//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInNyYy9tb2RlbC9vdmVycmlkZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFBQSx5RUFBdUQ7QUFDdkQsK0NBQXlDO0FBQ3pDLCtDQUFrRDtBQUVsRCw0QkFBSyxDQUFDLFNBQVMsQ0FBQyxNQUFNLEdBQUcsVUFBb0MsR0FBRyxJQUFXO0lBQ3pFLE9BQU8sMkJBQWUsQ0FBQyxNQUFNLENBQUMsSUFBSSxFQUFFLEdBQUcsSUFBSSxDQUFDLENBQUM7QUFDL0MsQ0FBQyxDQUFDO0FBRUYsNEJBQUssQ0FBQyxLQUFLLEdBQUcsVUFBVSxHQUFXO0lBQ2pDLE9BQU8sR0FBRyxrQkFBTSxDQUFDLE9BQU8sR0FBRyxHQUFHLEVBQUUsQ0FBQztBQUNuQyxDQUFDLENBQUMiLCJmaWxlIjoibW9kZWwvb3ZlcnJpZGVzLmpzIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgTW9kZWwgfSBmcm9tIFwiQGRlY2FmLXRzL2RlY29yYXRvci12YWxpZGF0aW9uXCI7XG5pbXBvcnQgeyBVSUtleXMgfSBmcm9tIFwiLi4vdWkvY29uc3RhbnRzXCI7XG5pbXBvcnQgeyBSZW5kZXJpbmdFbmdpbmUgfSBmcm9tIFwiLi4vdWkvUmVuZGVyaW5nXCI7XG5cbk1vZGVsLnByb3RvdHlwZS5yZW5kZXIgPSBmdW5jdGlvbiA8TSBleHRlbmRzIE1vZGVsPih0aGlzOiBNLCAuLi5hcmdzOiBhbnlbXSkge1xuICByZXR1cm4gUmVuZGVyaW5nRW5naW5lLnJlbmRlcih0aGlzLCAuLi5hcmdzKTtcbn07XG5cbk1vZGVsLnVpS2V5ID0gZnVuY3Rpb24gKGtleTogc3RyaW5nKSB7XG4gIHJldHVybiBgJHtVSUtleXMuUkVGTEVDVH0ke2tleX1gO1xufTtcbiJdfQ==

package/lib/model/overrides.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/ui/Rendering.cjs

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RenderingEngine = void 0;
+const db_decorators_1 = require("@decaf-ts/db-decorators");
+const decorator_validation_1 = require("@decaf-ts/decorator-validation");
+const constants_1 = require("./constants.cjs");
+class RenderingEngine {
+    constructor(flavour) {
+        this.flavour = flavour;
+        this.initialized = false;
+        RenderingEngine.register(this);
+    }
+    static register(engine) {
+        this.cache = this.cache || {};
+        if (engine.flavour in this.cache)
+            throw new db_decorators_1.InternalError(`Rendering engine under ${engine.flavour} already exists`);
+        this.cache[engine.flavour] = engine;
+        this.current = engine;
+    }
+    static getOrBoot(obj) {
+        if (obj instanceof RenderingEngine)
+            return obj;
+        const engine = new obj();
+        engine.initialize(); // make the booting async. use the initialized flag to control it
+        return engine;
+    }
+    static get(flavour) {
+        if (!flavour)
+            return this.getOrBoot(this.current);
+        if (!(flavour in this.cache))
+            throw new db_decorators_1.InternalError(`Rendering engine under ${flavour} does not exist`);
+        return this.getOrBoot(this.cache[flavour]);
+    }
+    static render(model, ...args) {
+        const constructor = decorator_validation_1.Model.get(model.constructor.name);
+        if (!constructor)
+            throw new db_decorators_1.InternalError("No model registered found");
+        const flavour = Reflect.getMetadata(decorator_validation_1.Model.uiKey(constants_1.UIKeys.UIMODEL), constructor);
+        return this.get(flavour).render(model, ...args);
+    }
+}
+exports.RenderingEngine = RenderingEngine;
+
+//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInNyYy91aS9SZW5kZXJpbmcudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEsMkRBQXdEO0FBQ3hELHlFQUl3QztBQUN4QywyQ0FBcUM7QUFFckMsTUFBc0IsZUFBZTtJQVNuQyxZQUErQixPQUFlO1FBQWYsWUFBTyxHQUFQLE9BQU8sQ0FBUTtRQUZwQyxnQkFBVyxHQUFZLEtBQUssQ0FBQztRQUdyQyxlQUFlLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQyxDQUFDO0lBQ2pDLENBQUM7SUFLRCxNQUFNLENBQUMsUUFBUSxDQUFDLE1BQXVCO1FBQ3JDLElBQUksQ0FBQyxLQUFLLEdBQUcsSUFBSSxDQUFDLEtBQUssSUFBSSxFQUFFLENBQUM7UUFDOUIsSUFBSSxNQUFNLENBQUMsT0FBTyxJQUFJLElBQUksQ0FBQyxLQUFLO1lBQzlCLE1BQU0sSUFBSSw2QkFBYSxDQUNyQiwwQkFBMEIsTUFBTSxDQUFDLE9BQU8saUJBQWlCLENBQzFELENBQUM7UUFDSixJQUFJLENBQUMsS0FBSyxDQUFDLE1BQU0sQ0FBQyxPQUFPLENBQUMsR0FBRyxNQUFNLENBQUM7UUFDcEMsSUFBSSxDQUFDLE9BQU8sR0FBRyxNQUFNLENBQUM7SUFDeEIsQ0FBQztJQUVPLE1BQU0sQ0FBQyxTQUFTLENBQ3RCLEdBQW1EO1FBRW5ELElBQUksR0FBRyxZQUFZLGVBQWU7WUFBRSxPQUFPLEdBQUcsQ0FBQztRQUMvQyxNQUFNLE1BQU0sR0FBb0IsSUFBSSxHQUFHLEVBQUUsQ0FBQztRQUMxQyxNQUFNLENBQUMsVUFBVSxFQUFFLENBQUMsQ0FBQyxpRUFBaUU7UUFDdEYsT0FBTyxNQUFNLENBQUM7SUFDaEIsQ0FBQztJQUVELE1BQU0sQ0FBQyxHQUFHLENBQUMsT0FBZ0I7UUFDekIsSUFBSSxDQUFDLE9BQU87WUFBRSxPQUFPLElBQUksQ0FBQyxTQUFTLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxDQUFDO1FBQ2xELElBQUksQ0FBQyxDQUFDLE9BQU8sSUFBSSxJQUFJLENBQUMsS0FBSyxDQUFDO1lBQzFCLE1BQU0sSUFBSSw2QkFBYSxDQUNyQiwwQkFBMEIsT0FBTyxpQkFBaUIsQ0FDbkQsQ0FBQztRQUNKLE9BQU8sSUFBSSxDQUFDLFNBQVMsQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUM7SUFDN0MsQ0FBQztJQUVELE1BQU0sQ0FBQyxNQUFNLENBQWtCLEtBQVEsRUFBRSxHQUFHLElBQVc7UUFDckQsTUFBTSxXQUFXLEdBQUcsNEJBQUssQ0FBQyxHQUFHLENBQUMsS0FBSyxDQUFDLFdBQVcsQ0FBQyxJQUFJLENBQUMsQ0FBQztRQUN0RCxJQUFJLENBQUMsV0FBVztZQUFFLE1BQU0sSUFBSSw2QkFBYSxDQUFDLDJCQUEyQixDQUFDLENBQUM7UUFDdkUsTUFBTSxPQUFPLEdBQUcsT0FBTyxDQUFDLFdBQVcsQ0FDakMsNEJBQUssQ0FBQyxLQUFLLENBQUMsa0JBQU0sQ0FBQyxPQUFPLENBQUMsRUFDM0IsV0FBc0MsQ0FDdkMsQ0FBQztRQUNGLE9BQU8sSUFBSSxDQUFDLEdBQUcsQ0FBQyxPQUFPLENBQUMsQ0FBQyxNQUFNLENBQUMsS0FBSyxFQUFFLEdBQUcsSUFBSSxDQUFDLENBQUM7SUFDbEQsQ0FBQztDQUNGO0FBckRELDBDQXFEQyIsImZpbGUiOiJ1aS9SZW5kZXJpbmcuanMiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBJbnRlcm5hbEVycm9yIH0gZnJvbSBcIkBkZWNhZi10cy9kYi1kZWNvcmF0b3JzXCI7XG5pbXBvcnQge1xuICBDb25zdHJ1Y3RvcixcbiAgTW9kZWwsXG4gIE1vZGVsQ29uc3RydWN0b3IsXG59IGZyb20gXCJAZGVjYWYtdHMvZGVjb3JhdG9yLXZhbGlkYXRpb25cIjtcbmltcG9ydCB7IFVJS2V5cyB9IGZyb20gXCIuL2NvbnN0YW50c1wiO1xuXG5leHBvcnQgYWJzdHJhY3QgY2xhc3MgUmVuZGVyaW5nRW5naW5lIHtcbiAgcHJpdmF0ZSBzdGF0aWMgY2FjaGU6IFJlY29yZDxcbiAgICBzdHJpbmcsXG4gICAgQ29uc3RydWN0b3I8UmVuZGVyaW5nRW5naW5lPiB8IFJlbmRlcmluZ0VuZ2luZVxuICA+O1xuICBwcml2YXRlIHN0YXRpYyBjdXJyZW50OiBDb25zdHJ1Y3RvcjxSZW5kZXJpbmdFbmdpbmU+IHwgUmVuZGVyaW5nRW5naW5lO1xuXG4gIHByb3RlY3RlZCBpbml0aWFsaXplZDogYm9vbGVhbiA9IGZhbHNlO1xuXG4gIHByb3RlY3RlZCBjb25zdHJ1Y3RvcihyZWFkb25seSBmbGF2b3VyOiBzdHJpbmcpIHtcbiAgICBSZW5kZXJpbmdFbmdpbmUucmVnaXN0ZXIodGhpcyk7XG4gIH1cblxuICBhYnN0cmFjdCBpbml0aWFsaXplKC4uLmFyZ3M6IGFueVtdKTogUHJvbWlzZTx2b2lkPjtcbiAgYWJzdHJhY3QgcmVuZGVyKC4uLmFyZ3M6IGFueVtdKTogYW55O1xuXG4gIHN0YXRpYyByZWdpc3RlcihlbmdpbmU6IFJlbmRlcmluZ0VuZ2luZSkge1xuICAgIHRoaXMuY2FjaGUgPSB0aGlzLmNhY2hlIHx8IHt9O1xuICAgIGlmIChlbmdpbmUuZmxhdm91ciBpbiB0aGlzLmNhY2hlKVxuICAgICAgdGhyb3cgbmV3IEludGVybmFsRXJyb3IoXG4gICAgICAgIGBSZW5kZXJpbmcgZW5naW5lIHVuZGVyICR7ZW5naW5lLmZsYXZvdXJ9IGFscmVhZHkgZXhpc3RzYFxuICAgICAgKTtcbiAgICB0aGlzLmNhY2hlW2VuZ2luZS5mbGF2b3VyXSA9IGVuZ2luZTtcbiAgICB0aGlzLmN1cnJlbnQgPSBlbmdpbmU7XG4gIH1cblxuICBwcml2YXRlIHN0YXRpYyBnZXRPckJvb3QoXG4gICAgb2JqOiBDb25zdHJ1Y3RvcjxSZW5kZXJpbmdFbmdpbmU+IHwgUmVuZGVyaW5nRW5naW5lXG4gICk6IFJlbmRlcmluZ0VuZ2luZSB7XG4gICAgaWYgKG9iaiBpbnN0YW5jZW9mIFJlbmRlcmluZ0VuZ2luZSkgcmV0dXJuIG9iajtcbiAgICBjb25zdCBlbmdpbmU6IFJlbmRlcmluZ0VuZ2luZSA9IG5ldyBvYmooKTtcbiAgICBlbmdpbmUuaW5pdGlhbGl6ZSgpOyAvLyBtYWtlIHRoZSBib290aW5nIGFzeW5jLiB1c2UgdGhlIGluaXRpYWxpemVkIGZsYWcgdG8gY29udHJvbCBpdFxuICAgIHJldHVybiBlbmdpbmU7XG4gIH1cblxuICBzdGF0aWMgZ2V0KGZsYXZvdXI/OiBzdHJpbmcpOiBSZW5kZXJpbmdFbmdpbmUge1xuICAgIGlmICghZmxhdm91cikgcmV0dXJuIHRoaXMuZ2V0T3JCb290KHRoaXMuY3VycmVudCk7XG4gICAgaWYgKCEoZmxhdm91ciBpbiB0aGlzLmNhY2hlKSlcbiAgICAgIHRocm93IG5ldyBJbnRlcm5hbEVycm9yKFxuICAgICAgICBgUmVuZGVyaW5nIGVuZ2luZSB1bmRlciAke2ZsYXZvdXJ9IGRvZXMgbm90IGV4aXN0YFxuICAgICAgKTtcbiAgICByZXR1cm4gdGhpcy5nZXRPckJvb3QodGhpcy5jYWNoZVtmbGF2b3VyXSk7XG4gIH1cblxuICBzdGF0aWMgcmVuZGVyPE0gZXh0ZW5kcyBNb2RlbD4obW9kZWw6IE0sIC4uLmFyZ3M6IGFueVtdKTogYW55IHtcbiAgICBjb25zdCBjb25zdHJ1Y3RvciA9IE1vZGVsLmdldChtb2RlbC5jb25zdHJ1Y3Rvci5uYW1lKTtcbiAgICBpZiAoIWNvbnN0cnVjdG9yKSB0aHJvdyBuZXcgSW50ZXJuYWxFcnJvcihcIk5vIG1vZGVsIHJlZ2lzdGVyZWQgZm91bmRcIik7XG4gICAgY29uc3QgZmxhdm91ciA9IFJlZmxlY3QuZ2V0TWV0YWRhdGEoXG4gICAgICBNb2RlbC51aUtleShVSUtleXMuVUlNT0RFTCksXG4gICAgICBjb25zdHJ1Y3RvciBhcyBNb2RlbENvbnN0cnVjdG9yPE1vZGVsPlxuICAgICk7XG4gICAgcmV0dXJuIHRoaXMuZ2V0KGZsYXZvdXIpLnJlbmRlcihtb2RlbCwgLi4uYXJncyk7XG4gIH1cbn1cbiJdfQ==

package/lib/ui/Rendering.d.ts

@@ -0,0 +1,14 @@
+import { Model } from "@decaf-ts/decorator-validation";
+export declare abstract class RenderingEngine {
+    readonly flavour: string;
+    private static cache;
+    private static current;
+    protected initialized: boolean;
+    protected constructor(flavour: string);
+    abstract initialize(...args: any[]): Promise<void>;
+    abstract render(...args: any[]): any;
+    static register(engine: RenderingEngine): void;
+    private static getOrBoot;
+    static get(flavour?: string): RenderingEngine;
+    static render<M extends Model>(model: M, ...args: any[]): any;
+}

package/lib/ui/constants.cjs

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UIKeys = void 0;
+const decorator_validation_1 = require("@decaf-ts/decorator-validation");
+/**
+ * @enum UIKeys
+ * @category Constants
+ */
+exports.UIKeys = {
+    REFLECT: `${decorator_validation_1.ModelKeys.REFLECT}.ui.`,
+    UIMODEL: "uimodel",
+    RENDERED_BY: "rendered-by",
+    ELEMENT: "element",
+    PROP: "prop",
+    NAME: "name",
+    NAME_PREFIX: "input-",
+    CUSTOM_PROPS: "customValidationProps",
+    TYPE: "type",
+    SUB_TYPE: "subtype",
+    READ_ONLY: "readonly",
+    REQUIRED: decorator_validation_1.ValidationKeys.REQUIRED,
+    MIN: decorator_validation_1.ValidationKeys.MIN,
+    MIN_LENGTH: decorator_validation_1.ValidationKeys.MIN_LENGTH,
+    MAX: decorator_validation_1.ValidationKeys.MAX,
+    MAX_LENGTH: decorator_validation_1.ValidationKeys.MAX_LENGTH,
+    PATTERN: decorator_validation_1.ValidationKeys.PATTERN,
+    URL: decorator_validation_1.ValidationKeys.URL,
+    STEP: decorator_validation_1.ValidationKeys.STEP,
+    DATE: decorator_validation_1.ValidationKeys.DATE,
+    EMAIL: decorator_validation_1.ValidationKeys.EMAIL,
+    PASSWORD: decorator_validation_1.ValidationKeys.PASSWORD,
+};
+
+//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInNyYy91aS9jb25zdGFudHMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEseUVBQTJFO0FBRTNFOzs7R0FHRztBQUNVLFFBQUEsTUFBTSxHQUFHO0lBQ3BCLE9BQU8sRUFBRSxHQUFHLGdDQUFTLENBQUMsT0FBTyxNQUFNO0lBQ25DLE9BQU8sRUFBRSxTQUFTO0lBQ2xCLFdBQVcsRUFBRSxhQUFhO0lBQzFCLE9BQU8sRUFBRSxTQUFTO0lBQ2xCLElBQUksRUFBRSxNQUFNO0lBQ1osSUFBSSxFQUFFLE1BQU07SUFDWixXQUFXLEVBQUUsUUFBUTtJQUNyQixZQUFZLEVBQUUsdUJBQXVCO0lBRXJDLElBQUksRUFBRSxNQUFNO0lBQ1osUUFBUSxFQUFFLFNBQVM7SUFFbkIsU0FBUyxFQUFFLFVBQVU7SUFDckIsUUFBUSxFQUFFLHFDQUFjLENBQUMsUUFBUTtJQUNqQyxHQUFHLEVBQUUscUNBQWMsQ0FBQyxHQUFHO0lBQ3ZCLFVBQVUsRUFBRSxxQ0FBYyxDQUFDLFVBQVU7SUFDckMsR0FBRyxFQUFFLHFDQUFjLENBQUMsR0FBRztJQUN2QixVQUFVLEVBQUUscUNBQWMsQ0FBQyxVQUFVO0lBQ3JDLE9BQU8sRUFBRSxxQ0FBYyxDQUFDLE9BQU87SUFDL0IsR0FBRyxFQUFFLHFDQUFjLENBQUMsR0FBRztJQUN2QixJQUFJLEVBQUUscUNBQWMsQ0FBQyxJQUFJO0lBQ3pCLElBQUksRUFBRSxxQ0FBYyxDQUFDLElBQUk7SUFDekIsS0FBSyxFQUFFLHFDQUFjLENBQUMsS0FBSztJQUMzQixRQUFRLEVBQUUscUNBQWMsQ0FBQyxRQUFRO0NBQ2xDLENBQUMiLCJmaWxlIjoidWkvY29uc3RhbnRzLmpzIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgTW9kZWxLZXlzLCBWYWxpZGF0aW9uS2V5cyB9IGZyb20gXCJAZGVjYWYtdHMvZGVjb3JhdG9yLXZhbGlkYXRpb25cIjtcblxuLyoqXG4gKiBAZW51bSBVSUtleXNcbiAqIEBjYXRlZ29yeSBDb25zdGFudHNcbiAqL1xuZXhwb3J0IGNvbnN0IFVJS2V5cyA9IHtcbiAgUkVGTEVDVDogYCR7TW9kZWxLZXlzLlJFRkxFQ1R9LnVpLmAsXG4gIFVJTU9ERUw6IFwidWltb2RlbFwiLFxuICBSRU5ERVJFRF9CWTogXCJyZW5kZXJlZC1ieVwiLFxuICBFTEVNRU5UOiBcImVsZW1lbnRcIixcbiAgUFJPUDogXCJwcm9wXCIsXG4gIE5BTUU6IFwibmFtZVwiLFxuICBOQU1FX1BSRUZJWDogXCJpbnB1dC1cIixcbiAgQ1VTVE9NX1BST1BTOiBcImN1c3RvbVZhbGlkYXRpb25Qcm9wc1wiLFxuXG4gIFRZUEU6IFwidHlwZVwiLFxuICBTVUJfVFlQRTogXCJzdWJ0eXBlXCIsXG5cbiAgUkVBRF9PTkxZOiBcInJlYWRvbmx5XCIsXG4gIFJFUVVJUkVEOiBWYWxpZGF0aW9uS2V5cy5SRVFVSVJFRCxcbiAgTUlOOiBWYWxpZGF0aW9uS2V5cy5NSU4sXG4gIE1JTl9MRU5HVEg6IFZhbGlkYXRpb25LZXlzLk1JTl9MRU5HVEgsXG4gIE1BWDogVmFsaWRhdGlvbktleXMuTUFYLFxuICBNQVhfTEVOR1RIOiBWYWxpZGF0aW9uS2V5cy5NQVhfTEVOR1RILFxuICBQQVRURVJOOiBWYWxpZGF0aW9uS2V5cy5QQVRURVJOLFxuICBVUkw6IFZhbGlkYXRpb25LZXlzLlVSTCxcbiAgU1RFUDogVmFsaWRhdGlvbktleXMuU1RFUCxcbiAgREFURTogVmFsaWRhdGlvbktleXMuREFURSxcbiAgRU1BSUw6IFZhbGlkYXRpb25LZXlzLkVNQUlMLFxuICBQQVNTV09SRDogVmFsaWRhdGlvbktleXMuUEFTU1dPUkQsXG59O1xuIl19

package/lib/ui/constants.d.ts

@@ -0,0 +1,28 @@
+/**
+ * @enum UIKeys
+ * @category Constants
+ */
+export declare const UIKeys: {
+    REFLECT: string;
+    UIMODEL: string;
+    RENDERED_BY: string;
+    ELEMENT: string;
+    PROP: string;
+    NAME: string;
+    NAME_PREFIX: string;
+    CUSTOM_PROPS: string;
+    TYPE: string;
+    SUB_TYPE: string;
+    READ_ONLY: string;
+    REQUIRED: string;
+    MIN: string;
+    MIN_LENGTH: string;
+    MAX: string;
+    MAX_LENGTH: string;
+    PATTERN: string;
+    URL: string;
+    STEP: string;
+    DATE: string;
+    EMAIL: string;
+    PASSWORD: string;
+};

package/lib/ui/decorators.cjs

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.uiprop = void 0;
+exports.uielement = uielement;
+require("reflect-metadata");
+const constants_1 = require("./constants.cjs");
+const decorator_validation_1 = require("@decaf-ts/decorator-validation");
+/**
+ * @namespace ui-decorators.ui.decorators
+ * @memberOf ui-decorators.ui
+ */
+/**
+ *
+ * @param {string} key
+ *
+ * @function getUIKey
+ *
+ * @memberOf ui-decorators.ui.decorators
+ */
+const getUIKey = (key) => constants_1.UIKeys.REFLECT + key;
+/**
+ * Adds the UIElement definition as metadata to the property, allowing it to be read by any {@link RenderStrategy}
+ *
+ * @param {string} tag The component/HTML element tag name
+ * @param {{}} [props] The properties to pass to that component/HTML Element
+ * @param {any[]} [args] optional arguments that will be passed to the rendering strategy.
+ *
+ * @decorator uielement
+ *
+ * @category Decorators
+ * @subcategory ui-decorators
+ */
+function uielement(tag, props, serialize = false, ...args) {
+    const metadata = {
+        tag: tag,
+        serialize: serialize,
+        props: props,
+        args: args,
+    };
+    return (0, decorator_validation_1.propMetadata)(getUIKey(constants_1.UIKeys.ELEMENT), metadata);
+}
+/**
+ * Adds the UIProp definition as metadata to the property, allowing it to be read by any {@link RenderStrategy}
+ *
+ * this requires a '@uimodel' with a defined tag
+ *
+ * @param {string} [propName] the property name that will be passed to the component. defaults to the PropertyKey
+ *
+ * @decorator uiprop
+ *
+ * @category Decorators
+ * @subcategory ui-decorators
+ */
+const uiprop = (propName = undefined, stringify = false) => (target, propertyKey) => {
+    const metadata = {
+        name: propName || propertyKey,
+        stringify: stringify,
+    };
+    Reflect.defineMetadata(getUIKey(constants_1.UIKeys.PROP), metadata, target, propertyKey);
+};
+exports.uiprop = uiprop;
+
+//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInNyYy91aS9kZWNvcmF0b3JzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQTBDQSw4QkFhQztBQXZERCw0QkFBMEI7QUFDMUIsMkNBQXFDO0FBQ3JDLHlFQUE4RDtBQUU5RDs7O0dBR0c7QUFFSDs7Ozs7OztHQU9HO0FBQ0gsTUFBTSxRQUFRLEdBQUcsQ0FBQyxHQUFXLEVBQUUsRUFBRSxDQUFDLGtCQUFNLENBQUMsT0FBTyxHQUFHLEdBQUcsQ0FBQztBQWF2RDs7Ozs7Ozs7Ozs7R0FXRztBQUNILFNBQWdCLFNBQVMsQ0FDdkIsR0FBVyxFQUNYLEtBQWtDLEVBQ2xDLFlBQXFCLEtBQUssRUFDMUIsR0FBRyxJQUFXO0lBRWQsTUFBTSxRQUFRLEdBQXNCO1FBQ2xDLEdBQUcsRUFBRSxHQUFHO1FBQ1IsU0FBUyxFQUFFLFNBQVM7UUFDcEIsS0FBSyxFQUFFLEtBQUs7UUFDWixJQUFJLEVBQUUsSUFBSTtLQUNYLENBQUM7SUFDRixPQUFPLElBQUEsbUNBQVksRUFBQyxRQUFRLENBQUMsa0JBQU0sQ0FBQyxPQUFPLENBQUMsRUFBRSxRQUFRLENBQUMsQ0FBQztBQUMxRCxDQUFDO0FBVUQ7Ozs7Ozs7Ozs7O0dBV0c7QUFDSSxNQUFNLE1BQU0sR0FDakIsQ0FBQyxXQUErQixTQUFTLEVBQUUsWUFBcUIsS0FBSyxFQUFFLEVBQUUsQ0FDekUsQ0FBQyxNQUFXLEVBQUUsV0FBbUIsRUFBRSxFQUFFO0lBQ25DLE1BQU0sUUFBUSxHQUFtQjtRQUMvQixJQUFJLEVBQUUsUUFBUSxJQUFJLFdBQVc7UUFDN0IsU0FBUyxFQUFFLFNBQVM7S0FDckIsQ0FBQztJQUVGLE9BQU8sQ0FBQyxjQUFjLENBQ3BCLFFBQVEsQ0FBQyxrQkFBTSxDQUFDLElBQUksQ0FBQyxFQUNyQixRQUFRLEVBQ1IsTUFBTSxFQUNOLFdBQVcsQ0FDWixDQUFDO0FBQ0osQ0FBQyxDQUFDO0FBZFMsUUFBQSxNQUFNLFVBY2YiLCJmaWxlIjoidWkvZGVjb3JhdG9ycy5qcyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCBcInJlZmxlY3QtbWV0YWRhdGFcIjtcbmltcG9ydCB7IFVJS2V5cyB9IGZyb20gXCIuL2NvbnN0YW50c1wiO1xuaW1wb3J0IHsgcHJvcE1ldGFkYXRhIH0gZnJvbSBcIkBkZWNhZi10cy9kZWNvcmF0b3ItdmFsaWRhdGlvblwiO1xuXG4vKipcbiAqIEBuYW1lc3BhY2UgdWktZGVjb3JhdG9ycy51aS5kZWNvcmF0b3JzXG4gKiBAbWVtYmVyT2YgdWktZGVjb3JhdG9ycy51aVxuICovXG5cbi8qKlxuICpcbiAqIEBwYXJhbSB7c3RyaW5nfSBrZXlcbiAqXG4gKiBAZnVuY3Rpb24gZ2V0VUlLZXlcbiAqXG4gKiBAbWVtYmVyT2YgdWktZGVjb3JhdG9ycy51aS5kZWNvcmF0b3JzXG4gKi9cbmNvbnN0IGdldFVJS2V5ID0gKGtleTogc3RyaW5nKSA9PiBVSUtleXMuUkVGTEVDVCArIGtleTtcblxuLyoqXG4gKiBAdHlwZWRlZiBVSUVsZW1lbnRNZXRhZGF0YVxuICogQG1lbWJlck9mIHVpLWRlY29yYXRvcnMudWkuZGVjb3JhdG9yc1xuICovXG5leHBvcnQgdHlwZSBVSUVsZW1lbnRNZXRhZGF0YSA9IHtcbiAgdGFnOiBzdHJpbmc7XG4gIGFyZ3M/OiBhbnlbXTtcbiAgcHJvcHM/OiBSZWNvcmQ8c3RyaW5nLCBhbnk+O1xuICBzZXJpYWxpemU/OiBib29sZWFuO1xufTtcblxuLyoqXG4gKiBBZGRzIHRoZSBVSUVsZW1lbnQgZGVmaW5pdGlvbiBhcyBtZXRhZGF0YSB0byB0aGUgcHJvcGVydHksIGFsbG93aW5nIGl0IHRvIGJlIHJlYWQgYnkgYW55IHtAbGluayBSZW5kZXJTdHJhdGVneX1cbiAqXG4gKiBAcGFyYW0ge3N0cmluZ30gdGFnIFRoZSBjb21wb25lbnQvSFRNTCBlbGVtZW50IHRhZyBuYW1lXG4gKiBAcGFyYW0ge3t9fSBbcHJvcHNdIFRoZSBwcm9wZXJ0aWVzIHRvIHBhc3MgdG8gdGhhdCBjb21wb25lbnQvSFRNTCBFbGVtZW50XG4gKiBAcGFyYW0ge2FueVtdfSBbYXJnc10gb3B0aW9uYWwgYXJndW1lbnRzIHRoYXQgd2lsbCBiZSBwYXNzZWQgdG8gdGhlIHJlbmRlcmluZyBzdHJhdGVneS5cbiAqXG4gKiBAZGVjb3JhdG9yIHVpZWxlbWVudFxuICpcbiAqIEBjYXRlZ29yeSBEZWNvcmF0b3JzXG4gKiBAc3ViY2F0ZWdvcnkgdWktZGVjb3JhdG9yc1xuICovXG5leHBvcnQgZnVuY3Rpb24gdWllbGVtZW50KFxuICB0YWc6IHN0cmluZyxcbiAgcHJvcHM/OiB7IFtpbmRleGVyOiBzdHJpbmddOiBhbnkgfSxcbiAgc2VyaWFsaXplOiBib29sZWFuID0gZmFsc2UsXG4gIC4uLmFyZ3M6IGFueVtdXG4pIHtcbiAgY29uc3QgbWV0YWRhdGE6IFVJRWxlbWVudE1ldGFkYXRhID0ge1xuICAgIHRhZzogdGFnLFxuICAgIHNlcmlhbGl6ZTogc2VyaWFsaXplLFxuICAgIHByb3BzOiBwcm9wcyxcbiAgICBhcmdzOiBhcmdzLFxuICB9O1xuICByZXR1cm4gcHJvcE1ldGFkYXRhKGdldFVJS2V5KFVJS2V5cy5FTEVNRU5UKSwgbWV0YWRhdGEpO1xufVxuLyoqXG4gKiBAdHlwZWRlZiBVSVByb3BNZXRhZGF0YVxuICogQG1lbWJlck9mIHVpLWRlY29yYXRvcnMudWkuZGVjb3JhdG9yc1xuICovXG5leHBvcnQgdHlwZSBVSVByb3BNZXRhZGF0YSA9IHtcbiAgbmFtZTogc3RyaW5nO1xuICBzdHJpbmdpZnk6IGJvb2xlYW47XG59O1xuXG4vKipcbiAqIEFkZHMgdGhlIFVJUHJvcCBkZWZpbml0aW9uIGFzIG1ldGFkYXRhIHRvIHRoZSBwcm9wZXJ0eSwgYWxsb3dpbmcgaXQgdG8gYmUgcmVhZCBieSBhbnkge0BsaW5rIFJlbmRlclN0cmF0ZWd5fVxuICpcbiAqIHRoaXMgcmVxdWlyZXMgYSAnQHVpbW9kZWwnIHdpdGggYSBkZWZpbmVkIHRhZ1xuICpcbiAqIEBwYXJhbSB7c3RyaW5nfSBbcHJvcE5hbWVdIHRoZSBwcm9wZXJ0eSBuYW1lIHRoYXQgd2lsbCBiZSBwYXNzZWQgdG8gdGhlIGNvbXBvbmVudC4gZGVmYXVsdHMgdG8gdGhlIFByb3BlcnR5S2V5XG4gKlxuICogQGRlY29yYXRvciB1aXByb3BcbiAqXG4gKiBAY2F0ZWdvcnkgRGVjb3JhdG9yc1xuICogQHN1YmNhdGVnb3J5IHVpLWRlY29yYXRvcnNcbiAqL1xuZXhwb3J0IGNvbnN0IHVpcHJvcCA9XG4gIChwcm9wTmFtZTogc3RyaW5nIHwgdW5kZWZpbmVkID0gdW5kZWZpbmVkLCBzdHJpbmdpZnk6IGJvb2xlYW4gPSBmYWxzZSkgPT5cbiAgKHRhcmdldDogYW55LCBwcm9wZXJ0eUtleTogc3RyaW5nKSA9PiB7XG4gICAgY29uc3QgbWV0YWRhdGE6IFVJUHJvcE1ldGFkYXRhID0ge1xuICAgICAgbmFtZTogcHJvcE5hbWUgfHwgcHJvcGVydHlLZXksXG4gICAgICBzdHJpbmdpZnk6IHN0cmluZ2lmeSxcbiAgICB9O1xuXG4gICAgUmVmbGVjdC5kZWZpbmVNZXRhZGF0YShcbiAgICAgIGdldFVJS2V5KFVJS2V5cy5QUk9QKSxcbiAgICAgIG1ldGFkYXRhLFxuICAgICAgdGFyZ2V0LFxuICAgICAgcHJvcGVydHlLZXlcbiAgICApO1xuICB9O1xuIl19

package/lib/ui/decorators.d.ts

@@ -0,0 +1,47 @@
+import "reflect-metadata";
+/**
+ * @typedef UIElementMetadata
+ * @memberOf ui-decorators.ui.decorators
+ */
+export type UIElementMetadata = {
+    tag: string;
+    args?: any[];
+    props?: Record<string, any>;
+    serialize?: boolean;
+};
+/**
+ * Adds the UIElement definition as metadata to the property, allowing it to be read by any {@link RenderStrategy}
+ *
+ * @param {string} tag The component/HTML element tag name
+ * @param {{}} [props] The properties to pass to that component/HTML Element
+ * @param {any[]} [args] optional arguments that will be passed to the rendering strategy.
+ *
+ * @decorator uielement
+ *
+ * @category Decorators
+ * @subcategory ui-decorators
+ */
+export declare function uielement(tag: string, props?: {
+    [indexer: string]: any;
+}, serialize?: boolean, ...args: any[]): (target: object, propertyKey?: any, descriptor?: any) => void;
+/**
+ * @typedef UIPropMetadata
+ * @memberOf ui-decorators.ui.decorators
+ */
+export type UIPropMetadata = {
+    name: string;
+    stringify: boolean;
+};
+/**
+ * Adds the UIProp definition as metadata to the property, allowing it to be read by any {@link RenderStrategy}
+ *
+ * this requires a '@uimodel' with a defined tag
+ *
+ * @param {string} [propName] the property name that will be passed to the component. defaults to the PropertyKey
+ *
+ * @decorator uiprop
+ *
+ * @category Decorators
+ * @subcategory ui-decorators
+ */
+export declare const uiprop: (propName?: string | undefined, stringify?: boolean) => (target: any, propertyKey: string) => void;

package/lib/ui/index.cjs

@@ -0,0 +1,25 @@
+"use strict";
+/**
+ * @namespace ui-decorators.ui
+ * @memberOf ui-decorators
+ */
+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("./constants.cjs"), exports);
+__exportStar(require("./decorators.cjs"), exports);
+__exportStar(require("./Rendering.cjs"), exports);
+
+//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInNyYy91aS9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUE7OztHQUdHOzs7Ozs7Ozs7Ozs7Ozs7O0FBRUgsOENBQTRCO0FBQzVCLCtDQUE2QjtBQUM3Qiw4Q0FBNEIiLCJmaWxlIjoidWkvaW5kZXguanMiLCJzb3VyY2VzQ29udGVudCI6WyIvKipcbiAqIEBuYW1lc3BhY2UgdWktZGVjb3JhdG9ycy51aVxuICogQG1lbWJlck9mIHVpLWRlY29yYXRvcnNcbiAqL1xuXG5leHBvcnQgKiBmcm9tIFwiLi9jb25zdGFudHNcIjtcbmV4cG9ydCAqIGZyb20gXCIuL2RlY29yYXRvcnNcIjtcbmV4cG9ydCAqIGZyb20gXCIuL1JlbmRlcmluZ1wiO1xuIl19

package/lib/ui/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @namespace ui-decorators.ui
+ * @memberOf ui-decorators
+ */
+export * from "./constants";
+export * from "./decorators";
+export * from "./Rendering";

package/package.json

@@ -0,0 +1,109 @@
+{
+  "name": "@decaf-ts/ui-decorators",
+  "version": "0.4.0",
+  "description": "Extension of decorator validation to ui elements to allow for web integration",
+  "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": "rimraf node_modules/@decaf-ts package-lock.json && npm run do-install",
+    "flash-forward": "npx npm-check-updates -u && npm run do-install",
+    "reset": "rm -rf * && git checkout . && git pull && npm run do-install",
+    "build": "rimraf ./lib && rimraf ./dist && gulp dev",
+    "build:prod": "rimraf ./lib && rimraf ./dist && gulp prod",
+    "test": "jest --coverage --testPathPattern=\"/tests/unit\" --passWithNoTests --detectOpenHandles",
+    "test:integration": "jest --coverage --testPathPattern=\"/tests/(integration)\" --passWithNoTests --detectOpenHandles",
+    "test:all": "jest --coverage --testPathPattern=\"/tests/(unit|integration)\" --passWithNoTests --detectOpenHandles",
+    "lint": "eslint .",
+    "lint-fix": "eslint --fix ./src/*",
+    "test:circular": "dpdm -T --no-warning --no-tree ./src/index.ts",
+    "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",
+    "coverage": "npm run test:all && cd workdocs && jest-coverage-badges",
+    "docs": "npx rimraf ./docs && mkdir docs && npm run do-install -- better-docs taffydb && gulp docs; npm remove better-docs taffydb"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/decaf-ts/ui-decorators.git"
+  },
+  "engines": {
+    "node": ">=20.0.0",
+    "npm": ">=10.0.0"
+  },
+  "files": [
+    "lib",
+    "dist"
+  ],
+  "keywords": [
+    "plantuml",
+    "mermaid",
+    "uml",
+    "drawio",
+    "mddocs",
+    "md",
+    "jsdoc",
+    "doc",
+    "docs",
+    "documentation",
+    "ci/cd",
+    "ci",
+    "cd",
+    "template",
+    "typescript",
+    "ts"
+  ],
+  "author": "Tiago Venceslau",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/decaf-ts/ui-decorators/issues"
+  },
+  "homepage": "https://github.com/decaf-ts/ui-decorators#readme",
+  "devDependencies": {
+    "@eslint/js": "^9.14.0",
+    "@types/jest": "^29.5.14",
+    "@typescript-eslint/eslint-plugin": "^8.14.0",
+    "clean-publish": "^5.1.0",
+    "dpdm": "^3.14.0",
+    "eslint": "^9.14.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "globals": "^15.12.0",
+    "gulp": "^5.0.0",
+    "gulp-if": "^3.0.0",
+    "gulp-rename": "^2.0.0",
+    "gulp-replace": "^1.1.4",
+    "gulp-run-command": "^0.0.10",
+    "gulp-sourcemaps": "^2.6.5",
+    "gulp-typescript": "^6.0.0-alpha.1",
+    "gulp-uglify": "^3.0.2",
+    "jest": "^29.7.0",
+    "jest-coverage-badges": "^1.0.0",
+    "jest-junit": "^16.0.0",
+    "jsdoc": "^4.0.4",
+    "jsdoc-mermaid": "^1.0.0",
+    "markdown-include": "^0.4.3",
+    "merge-stream": "^2.0.0",
+    "nodemon": "^3.1.7",
+    "npm-check-updates": "^17.1.10",
+    "prettier": "^3.3.3",
+    "rimraf": "^6.0.1",
+    "ts-jest": "^29.2.5",
+    "ts-loader": "^9.5.1",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.6.3",
+    "typescript-eslint": "^8.14.0",
+    "vinyl-named": "^1.1.0",
+    "webpack-stream": "^7.0.0"
+  },
+  "peerDependencies": {
+    "@decaf-ts/db-decorators": "latest",
+    "@decaf-ts/decorator-validation": "latest",
+    "@decaf-ts/reflection": "latest",
+    "reflect-metadata": "^0.2.1"
+  }
+}