@decaf-ts/ui-decorators 0.4.5 → 0.4.6

package/lib/esm/model/decorators.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Tags the model as a uimodel, giving it the 'render' method
+ *
+ * @param {string} [tag] optional param. will render the provided elment wrapping the attribute uielements
+ * @param {{}} [props] optional param. Attributes to be passed to the tag element
+ * @param {function(any): void} [instanceCallback] optional callback returning the instance after creation for additional logic
+ *
+ * @decorator uimodel
+ *
+ * @mermaid
+ * sequenceDiagram
+ *   participant System
+ *   participant uimodel
+ *   participant constructor
+ *   participant instance
+ *   System->>uimodel:do(constructor)
+ *   uimodel->>constructor: Executes the constructor
+ *   constructor->>uimodel: returns instance
+ *   uimodel->>instance: adds the render method
+ *   uimodel->>System: returns UIModel instance
+ *
+ * @category Decorators
+ */
+export declare function uimodel(tag?: string, props?: Record<string, any>): (original: any, propertyKey?: any) => void;
+export declare function renderedBy(engine: string): (target: object, propertyKey?: string | symbol | unknown, descriptor?: PropertyDescriptor) => void;

package/lib/esm/model/decorators.js

@@ -0,0 +1,41 @@
+import { UIKeys } from "../ui/constants";
+import { apply, metadata } from "@decaf-ts/reflection";
+import { RenderingEngine } from "../ui/Rendering";
+/**
+ * Tags the model as a uimodel, giving it the 'render' method
+ *
+ * @param {string} [tag] optional param. will render the provided elment wrapping the attribute uielements
+ * @param {{}} [props] optional param. Attributes to be passed to the tag element
+ * @param {function(any): void} [instanceCallback] optional callback returning the instance after creation for additional logic
+ *
+ * @decorator uimodel
+ *
+ * @mermaid
+ * sequenceDiagram
+ *   participant System
+ *   participant uimodel
+ *   participant constructor
+ *   participant instance
+ *   System->>uimodel:do(constructor)
+ *   uimodel->>constructor: Executes the constructor
+ *   constructor->>uimodel: returns instance
+ *   uimodel->>instance: adds the render method
+ *   uimodel->>System: returns UIModel instance
+ *
+ * @category Decorators
+ */
+export function uimodel(tag, props) {
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    return (original, propertyKey) => {
+        const meta = {
+            tag: tag || original.name,
+            props: props,
+        };
+        return metadata(RenderingEngine.key(UIKeys.UIMODEL), meta)(original);
+    };
+}
+export function renderedBy(engine) {
+    return apply(metadata(RenderingEngine.key(UIKeys.RENDERED_BY), engine));
+}
+
+//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInNyYy9tb2RlbC9kZWNvcmF0b3JzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxNQUFNLEVBQUUsTUFBTSxpQkFBaUIsQ0FBQztBQUN6QyxPQUFPLEVBQUUsS0FBSyxFQUFFLFFBQVEsRUFBRSxNQUFNLHNCQUFzQixDQUFDO0FBQ3ZELE9BQU8sRUFBRSxlQUFlLEVBQUUsTUFBTSxpQkFBaUIsQ0FBQztBQUdsRDs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztHQXNCRztBQUNILE1BQU0sVUFBVSxPQUFPLENBQUMsR0FBWSxFQUFFLEtBQTJCO0lBQy9ELDZEQUE2RDtJQUM3RCxPQUFPLENBQUMsUUFBYSxFQUFFLFdBQWlCLEVBQUUsRUFBRTtRQUMxQyxNQUFNLElBQUksR0FBb0I7WUFDNUIsR0FBRyxFQUFFLEdBQUcsSUFBSSxRQUFRLENBQUMsSUFBSTtZQUN6QixLQUFLLEVBQUUsS0FBSztTQUNiLENBQUM7UUFDRixPQUFPLFFBQVEsQ0FBQyxlQUFlLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQyxPQUFPLENBQUMsRUFBRSxJQUFJLENBQUMsQ0FBQyxRQUFRLENBQUMsQ0FBQztJQUN2RSxDQUFDLENBQUM7QUFDSixDQUFDO0FBRUQsTUFBTSxVQUFVLFVBQVUsQ0FBQyxNQUFjO0lBQ3ZDLE9BQU8sS0FBSyxDQUFDLFFBQVEsQ0FBQyxlQUFlLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQyxXQUFXLENBQUMsRUFBRSxNQUFNLENBQUMsQ0FBQyxDQUFDO0FBQzFFLENBQUMiLCJmaWxlIjoibW9kZWwvZGVjb3JhdG9ycy5qcyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IFVJS2V5cyB9IGZyb20gXCIuLi91aS9jb25zdGFudHNcIjtcbmltcG9ydCB7IGFwcGx5LCBtZXRhZGF0YSB9IGZyb20gXCJAZGVjYWYtdHMvcmVmbGVjdGlvblwiO1xuaW1wb3J0IHsgUmVuZGVyaW5nRW5naW5lIH0gZnJvbSBcIi4uL3VpL1JlbmRlcmluZ1wiO1xuaW1wb3J0IHsgVUlNb2RlbE1ldGFkYXRhIH0gZnJvbSBcIi4uL3VpL3R5cGVzXCI7XG5cbi8qKlxuICogVGFncyB0aGUgbW9kZWwgYXMgYSB1aW1vZGVsLCBnaXZpbmcgaXQgdGhlICdyZW5kZXInIG1ldGhvZFxuICpcbiAqIEBwYXJhbSB7c3RyaW5nfSBbdGFnXSBvcHRpb25hbCBwYXJhbS4gd2lsbCByZW5kZXIgdGhlIHByb3ZpZGVkIGVsbWVudCB3cmFwcGluZyB0aGUgYXR0cmlidXRlIHVpZWxlbWVudHNcbiAqIEBwYXJhbSB7e319IFtwcm9wc10gb3B0aW9uYWwgcGFyYW0uIEF0dHJpYnV0ZXMgdG8gYmUgcGFzc2VkIHRvIHRoZSB0YWcgZWxlbWVudFxuICogQHBhcmFtIHtmdW5jdGlvbihhbnkpOiB2b2lkfSBbaW5zdGFuY2VDYWxsYmFja10gb3B0aW9uYWwgY2FsbGJhY2sgcmV0dXJuaW5nIHRoZSBpbnN0YW5jZSBhZnRlciBjcmVhdGlvbiBmb3IgYWRkaXRpb25hbCBsb2dpY1xuICpcbiAqIEBkZWNvcmF0b3IgdWltb2RlbFxuICpcbiAqIEBtZXJtYWlkXG4gKiBzZXF1ZW5jZURpYWdyYW1cbiAqICAgcGFydGljaXBhbnQgU3lzdGVtXG4gKiAgIHBhcnRpY2lwYW50IHVpbW9kZWxcbiAqICAgcGFydGljaXBhbnQgY29uc3RydWN0b3JcbiAqICAgcGFydGljaXBhbnQgaW5zdGFuY2VcbiAqICAgU3lzdGVtLT4+dWltb2RlbDpkbyhjb25zdHJ1Y3RvcilcbiAqICAgdWltb2RlbC0+PmNvbnN0cnVjdG9yOiBFeGVjdXRlcyB0aGUgY29uc3RydWN0b3JcbiAqICAgY29uc3RydWN0b3ItPj51aW1vZGVsOiByZXR1cm5zIGluc3RhbmNlXG4gKiAgIHVpbW9kZWwtPj5pbnN0YW5jZTogYWRkcyB0aGUgcmVuZGVyIG1ldGhvZFxuICogICB1aW1vZGVsLT4+U3lzdGVtOiByZXR1cm5zIFVJTW9kZWwgaW5zdGFuY2VcbiAqXG4gKiBAY2F0ZWdvcnkgRGVjb3JhdG9yc1xuICovXG5leHBvcnQgZnVuY3Rpb24gdWltb2RlbCh0YWc/OiBzdHJpbmcsIHByb3BzPzogUmVjb3JkPHN0cmluZywgYW55Pikge1xuICAvLyBlc2xpbnQtZGlzYWJsZS1uZXh0LWxpbmUgQHR5cGVzY3JpcHQtZXNsaW50L25vLXVudXNlZC12YXJzXG4gIHJldHVybiAob3JpZ2luYWw6IGFueSwgcHJvcGVydHlLZXk/OiBhbnkpID0+IHtcbiAgICBjb25zdCBtZXRhOiBVSU1vZGVsTWV0YWRhdGEgPSB7XG4gICAgICB0YWc6IHRhZyB8fCBvcmlnaW5hbC5uYW1lLFxuICAgICAgcHJvcHM6IHByb3BzLFxuICAgIH07XG4gICAgcmV0dXJuIG1ldGFkYXRhKFJlbmRlcmluZ0VuZ2luZS5rZXkoVUlLZXlzLlVJTU9ERUwpLCBtZXRhKShvcmlnaW5hbCk7XG4gIH07XG59XG5cbmV4cG9ydCBmdW5jdGlvbiByZW5kZXJlZEJ5KGVuZ2luZTogc3RyaW5nKSB7XG4gIHJldHVybiBhcHBseShtZXRhZGF0YShSZW5kZXJpbmdFbmdpbmUua2V5KFVJS2V5cy5SRU5ERVJFRF9CWSksIGVuZ2luZSkpO1xufVxuIl19

package/lib/esm/model/index.d.ts

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

package/lib/esm/model/index.js

@@ -0,0 +1,10 @@
+/**
+ * @namespace model
+ * @memberOf ui-decorators
+ */
+import "./model";
+export * from "./decorators";
+export * from "./overrides";
+export * from "./Renderable";
+
+//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInNyYy9tb2RlbC9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQTs7O0dBR0c7QUFFSCxPQUFPLFNBQVMsQ0FBQztBQUVqQixjQUFjLGNBQWMsQ0FBQztBQUM3QixjQUFjLGFBQWEsQ0FBQztBQUM1QixjQUFjLGNBQWMsQ0FBQyIsImZpbGUiOiJtb2RlbC9pbmRleC5qcyIsInNvdXJjZXNDb250ZW50IjpbIi8qKlxuICogQG5hbWVzcGFjZSBtb2RlbFxuICogQG1lbWJlck9mIHVpLWRlY29yYXRvcnNcbiAqL1xuXG5pbXBvcnQgXCIuL21vZGVsXCI7XG5cbmV4cG9ydCAqIGZyb20gXCIuL2RlY29yYXRvcnNcIjtcbmV4cG9ydCAqIGZyb20gXCIuL292ZXJyaWRlc1wiO1xuZXhwb3J0ICogZnJvbSBcIi4vUmVuZGVyYWJsZVwiO1xuIl19

package/lib/esm/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";
+import { Renderable } from "./Renderable";
+declare module "@decaf-ts/decorator-validation" {
+    abstract class Model implements Validatable, Serializable, Hashable, Comparable<Model>, Renderable {
+        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;
+    }
+}

package/lib/esm/model/model.js

@@ -0,0 +1,3 @@
+export {};
+
+//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInNyYy9tb2RlbC9tb2RlbC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwiZmlsZSI6Im1vZGVsL21vZGVsLmpzIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgTW9kZWxFcnJvckRlZmluaXRpb24gfSBmcm9tIFwiQGRlY2FmLXRzL2RlY29yYXRvci12YWxpZGF0aW9uXCI7XG5pbXBvcnQge1xuICBCdWlsZGVyUmVnaXN0cnksXG4gIENvbXBhcmFibGUsXG4gIENvbnN0cnVjdG9yLFxuICBIYXNoYWJsZSxcbiAgTW9kZWxBcmcsXG4gIE1vZGVsQnVpbGRlckZ1bmN0aW9uLFxuICBNb2RlbENvbnN0cnVjdG9yLFxuICBTZXJpYWxpemFibGUsXG4gIFZhbGlkYXRhYmxlLFxufSBmcm9tIFwiQGRlY2FmLXRzL2RlY29yYXRvci12YWxpZGF0aW9uXCI7XG5pbXBvcnQgeyBSZW5kZXJhYmxlIH0gZnJvbSBcIi4vUmVuZGVyYWJsZVwiO1xuXG5kZWNsYXJlIG1vZHVsZSBcIkBkZWNhZi10cy9kZWNvcmF0b3ItdmFsaWRhdGlvblwiIHtcbiAgLy8gQHRzLWV4cGVjdC1lcnJvciBoYWNreSBvdmVycmlkZVxuICBkZWNsYXJlIGFic3RyYWN0IGNsYXNzIE1vZGVsXG4gICAgaW1wbGVtZW50c1xuICAgICAgVmFsaWRhdGFibGUsXG4gICAgICBTZXJpYWxpemFibGUsXG4gICAgICBIYXNoYWJsZSxcbiAgICAgIENvbXBhcmFibGU8TW9kZWw+LFxuICAgICAgUmVuZGVyYWJsZVxuICB7XG4gICAgcHJvdGVjdGVkIGNvbnN0cnVjdG9yKGFyZz86IE1vZGVsQXJnPE1vZGVsPik7XG5cbiAgICBoYXNFcnJvcnMoLi4uZXhjbHVzaW9uczogYW55W10pOiBNb2RlbEVycm9yRGVmaW5pdGlvbiB8IHVuZGVmaW5lZDtcbiAgICBoYXNFcnJvcnMoXG4gICAgICBwcmV2aW91c1ZlcnNpb24/OiBNb2RlbCB8IGFueSxcbiAgICAgIC4uLmV4Y2x1c2lvbnM6IGFueVtdXG4gICAgKTogTW9kZWxFcnJvckRlZmluaXRpb24gfCB1bmRlZmluZWQ7XG5cbiAgICAvKipcbiAgICAgKiBAc3VtbWFyeSBDb21wYXJlIG9iamVjdCBlcXVhbGl0eSByZWN1cnNpdmVseVxuICAgICAqIEBwYXJhbSB7YW55fSBvYmogb2JqZWN0IHRvIGNvbXBhcmUgdG9cbiAgICAgKiBAcGFyYW0ge3N0cmluZ30gW2V4Y2VwdGlvbnNdIHByb3BlcnR5IG5hbWVzIHRvIGJlIGV4Y2x1ZGVkIGZyb20gdGhlIGNvbXBhcmlzb25cbiAgICAgKi9cbiAgICBlcXVhbHMob2JqOiBhbnksIC4uLmV4Y2VwdGlvbnM6IHN0cmluZ1tdKTogYm9vbGVhbjtcbiAgICAvKipcbiAgICAgKiBAc3VtbWFyeSBSZXR1cm5zIHRoZSBzZXJpYWxpemVkIG1vZGVsIGFjY29yZGluZyB0byB0aGUgY3VycmVudGx5IGRlZmluZWQge0BsaW5rIFNlcmlhbGl6ZXJ9XG4gICAgICovXG4gICAgc2VyaWFsaXplKCk6IHN0cmluZztcbiAgICAvKipcbiAgICAgKiBAc3VtbWFyeSBPdmVycmlkZSB0aGUgaW1wbGVtZW50YXRpb24gZm9yIGpzJ3MgJ3RvU3RyaW5nKCknIHdoaWNoIHN1Y2tzLi4uXG4gICAgICogQG92ZXJyaWRlXG4gICAgICovXG4gICAgdG9TdHJpbmcoKTogc3RyaW5nO1xuICAgIC8qKlxuICAgICAqIEBzdW1tYXJ5IERlZmluZXMgYSBkZWZhdWx0IGltcGxlbWVudGF0aW9uIGZvciBvYmplY3QgaGFzaC4gUmVsaWVzIG9uIGEgdmVyeSBiYXNpYyBpbXBsZW1lbnRhdGlvbiBiYXNlZCBvbiBKYXZhJ3Mgc3RyaW5nIGhhc2g7XG4gICAgICovXG4gICAgaGFzaCgpOiBzdHJpbmc7XG4gICAgLyoqXG4gICAgICogQHN1bW1hcnkgRGVzZXJpYWxpemVzIGEgTW9kZWxcbiAgICAgKiBAcGFyYW0ge3N0cmluZ30gc3RyXG4gICAgICpcbiAgICAgKiBAcGFyYW0gYXJnc1xuICAgICAqIEB0aHJvd3Mge0Vycm9yfSBJZiBpdCBmYWlscyB0byBwYXJzZSB0aGUgc3RyaW5nLCBvciBpZiBpdCBmYWlscyB0byBidWlsZCB0aGUgbW9kZWxcbiAgICAgKi9cbiAgICBzdGF0aWMgZGVzZXJpYWxpemUoc3RyOiBzdHJpbmcpOiBhbnk7XG4gICAgLyoqXG4gICAgICogQHN1bW1hcnkgUmVwb3B1bGF0ZXMgdGhlIE9iamVjdCBwcm9wZXJ0aWVzIHdpdGggdGhlIG9uZXMgZnJvbSB0aGUgbmV3IG9iamVjdFxuICAgICAqIEBkZXNjcmlwdGlvbiBJdGVyYXRlcyBhbGwgY29tbW9uIHByb3BlcnRpZXMgb2Ygb2JqIChpZiBleGlzdGluZykgYW5kIHNlbGYsIGFuZCBjb3BpZXMgdGhlbSBvbnRvIHNlbGZcbiAgICAgKlxuICAgICAqIEBwYXJhbSB7VH0gc2VsZlxuICAgICAqIEBwYXJhbSB7VCB8IFJlY29yZDxzdHJpbmcsIGFueT59IFtvYmpdXG4gICAgICpcbiAgICAgKi9cbiAgICBzdGF0aWMgZnJvbU9iamVjdDxUIGV4dGVuZHMgTW9kZWw+KFxuICAgICAgc2VsZjogVCxcbiAgICAgIG9iaj86IFQgfCBSZWNvcmQ8c3RyaW5nLCBhbnk+XG4gICAgKTogVDtcbiAgICAvKipcbiAgICAgKiBAc3VtbWFyeSBSZXBvcHVsYXRlcyB0aGUgaW5zdGFuY2Ugd2l0aCB0aGUgb25lcyBmcm9tIHRoZSBuZXcgTW9kZWwgT2JqZWN0XG4gICAgICogQGRlc2NyaXB0aW9uIEl0ZXJhdGVzIGFsbCBjb21tb24gcHJvcGVydGllcyBvZiBvYmogKGlmIGV4aXN0aW5nKSBhbmQgc2VsZiwgYW5kIGNvcGllcyB0aGVtIG9udG8gc2VsZi5cbiAgICAgKiBJcyBhd2FyZSBvZiBuZXN0ZWQgTW9kZWwgT2JqZWN0cyBhbmQgcmVidWlsZHMgdGhlbSBhbHNvLlxuICAgICAqIFdoZW4gTGlzdCBwcm9wZXJ0aWVzIGFyZSBkZWNvcmF0ZWQgd2l0aCB7QGxpbmsgbGlzdH0sIHRoZXkgbGlzdCBpdGVtcyB3aWxsIGFsc28gYmUgcmVidWlsdFxuICAgICAqXG4gICAgICogQHBhcmFtIHtUfSBzZWxmXG4gICAgICogQHBhcmFtIHtUIHwgUmVjb3JkPHN0cmluZywgYW55Pn0gW29ial1cbiAgICAgKlxuICAgICAqL1xuICAgIHN0YXRpYyBmcm9tTW9kZWw8VCBleHRlbmRzIE1vZGVsPihcbiAgICAgIHNlbGY6IFQsXG4gICAgICBvYmo/OiBUIHwgUmVjb3JkPHN0cmluZywgYW55PlxuICAgICk6IFQ7XG4gICAgLyoqXG4gICAgICogQHN1bW1hcnkgU2V0cyB0aGUgR2xvYmFsIHtAbGluayBNb2RlbEJ1aWxkZXJGdW5jdGlvbn1cbiAgICAgKiBAcGFyYW0ge01vZGVsQnVpbGRlckZ1bmN0aW9ufSBbYnVpbGRlcl1cbiAgICAgKi9cbiAgICBzdGF0aWMgc2V0QnVpbGRlcihidWlsZGVyPzogTW9kZWxCdWlsZGVyRnVuY3Rpb24pOiB2b2lkO1xuICAgIC8qKlxuICAgICAqIEBzdW1tYXJ5IFJldHJpZXZlcyB0aGUgY3VycmVudCBnbG9iYWwge0BsaW5rIE1vZGVsQnVpbGRlckZ1bmN0aW9ufVxuICAgICAqL1xuICAgIHN0YXRpYyBnZXRCdWlsZGVyKCk6IE1vZGVsQnVpbGRlckZ1bmN0aW9uIHwgdW5kZWZpbmVkO1xuICAgIC8qKlxuICAgICAqIFJldHVybnMgdGhlIGN1cnJlbnQge0BsaW5rIE1vZGVsUmVnaXN0cnlNYW5hZ2VyfVxuICAgICAqXG4gICAgICogQHJldHVybiBNb2RlbFJlZ2lzdHJ5LCBkZWZhdWx0cyB0byB7QGxpbmsgTW9kZWxSZWdpc3RyeU1hbmFnZXJ9XG4gICAgICovXG4gICAgcHJpdmF0ZSBzdGF0aWMgZ2V0UmVnaXN0cnk7XG4gICAgLyoqXG4gICAgICogUmV0dXJucyB0aGUgY3VycmVudCBhY3RpbmdNb2RlbFJlZ2lzdHJ5XG4gICAgICpcbiAgICAgKiBAcGFyYW0ge0J1aWxkZXJSZWdpc3RyeX0gbW9kZWxSZWdpc3RyeSB0aGUgbmV3IGltcGxlbWVudGF0aW9uIG9mIFJlZ2lzdHJ5XG4gICAgICovXG4gICAgc3RhdGljIHNldFJlZ2lzdHJ5KG1vZGVsUmVnaXN0cnk6IEJ1aWxkZXJSZWdpc3RyeTxhbnk+KTogdm9pZDtcbiAgICAvKipcbiAgICAgKiBAc3VtbWFyeSByZWdpc3RlciBuZXcgTW9kZWxzXG4gICAgICogQHBhcmFtIHthbnl9IGNvbnN0cnVjdG9yXG4gICAgICogQHBhcmFtIHtzdHJpbmd9IFtuYW1lXSB3aGVuIG5vdCBkZWZpbmVkLCB0aGUgbmFtZSBvZiB0aGUgY29uc3RydWN0b3Igd2lsbCBiZSB1c2VkXG4gICAgICpcbiAgICAgKiBAc2VlIE1vZGVsUmVnaXN0cnlcbiAgICAgKi9cbiAgICBzdGF0aWMgcmVnaXN0ZXI8VCBleHRlbmRzIE1vZGVsPihcbiAgICAgIGNvbnN0cnVjdG9yOiBNb2RlbENvbnN0cnVjdG9yPFQ+LFxuICAgICAgbmFtZT86IHN0cmluZ1xuICAgICk6IHZvaWQ7XG4gICAgLyoqXG4gICAgICogQHN1bW1hcnkgR2V0cyBhIHJlZ2lzdGVyZWQgTW9kZWwge0BsaW5rIE1vZGVsQ29uc3RydWN0b3J9XG4gICAgICogQHBhcmFtIHtzdHJpbmd9IG5hbWVcbiAgICAgKlxuICAgICAqIEBzZWUgTW9kZWxSZWdpc3RyeVxuICAgICAqL1xuICAgIHN0YXRpYyBnZXQ8VCBleHRlbmRzIE1vZGVsPihuYW1lOiBzdHJpbmcpOiBNb2RlbENvbnN0cnVjdG9yPFQ+IHwgdW5kZWZpbmVkO1xuICAgIC8qKlxuICAgICAqIEBwYXJhbSB7UmVjb3JkPHN0cmluZywgYW55Pn0gb2JqXG4gICAgICogQHBhcmFtIHtzdHJpbmd9IFtjbGF6el0gd2hlbiBwcm92aWRlZCwgaXQgd2lsbCBhdHRlbXB0IHRvIGZpbmQgdGhlIG1hdGNoaW5nIGNvbnN0cnVjdG9yXG4gICAgICpcbiAgICAgKiBAdGhyb3dzIEVycm9yIElmIGNsYXp6IGlzIG5vdCBmb3VuZCwgb3Igb2JqIGlzIG5vdCBhIHtAbGluayBNb2RlbH0gbWVhbmluZyBpdCBoYXMgbm8ge0BsaW5rIE1vZGVsS2V5cy5BTkNIT1J9IHByb3BlcnR5XG4gICAgICpcbiAgICAgKiBAc2VlIE1vZGVsUmVnaXN0cnlcbiAgICAgKi9cbiAgICBzdGF0aWMgYnVpbGQ8VCBleHRlbmRzIE1vZGVsPihvYmo/OiBSZWNvcmQ8c3RyaW5nLCBhbnk+LCBjbGF6ej86IHN0cmluZyk6IFQ7XG4gICAgc3RhdGljIGdldE1ldGFkYXRhPFYgZXh0ZW5kcyBNb2RlbD4obW9kZWw6IFYpOiBhbnk7XG4gICAgc3RhdGljIGdldEF0dHJpYnV0ZXM8ViBleHRlbmRzIE1vZGVsPihtb2RlbDogQ29uc3RydWN0b3I8Vj4gfCBWKTogc3RyaW5nW107XG4gICAgc3RhdGljIGVxdWFsczxWIGV4dGVuZHMgTW9kZWw+KFxuICAgICAgb2JqMTogVixcbiAgICAgIG9iajI6IFYsXG4gICAgICAuLi5leGNlcHRpb25zOiBhbnlbXVxuICAgICk6IGJvb2xlYW47XG4gICAgc3RhdGljIGhhc0Vycm9yczxWIGV4dGVuZHMgTW9kZWw+KFxuICAgICAgbW9kZWw6IFYsXG4gICAgICAuLi5leGNlcHRpb25zOiBhbnlbXVxuICAgICk6IE1vZGVsRXJyb3JEZWZpbml0aW9uIHwgdW5kZWZpbmVkO1xuICAgIHN0YXRpYyBzZXJpYWxpemU8ViBleHRlbmRzIE1vZGVsPihtb2RlbDogVik6IGFueTtcbiAgICBzdGF0aWMgaGFzaDxWIGV4dGVuZHMgTW9kZWw+KG1vZGVsOiBWKTogYW55O1xuICAgIC8qKlxuICAgICAqIEBzdW1tYXJ5IEJ1aWxkcyB0aGUga2V5IHRvIHN0b3JlIGFzIE1ldGFkYXRhIHVuZGVyIFJlZmxlY3Rpb25zXG4gICAgICogQGRlc2NyaXB0aW9uIGNvbmNhdGVuYXRlcyB7QGxpbmsgTW9kZWxLZXlzI1JFRkxFQ1R9IHdpdGggdGhlIHByb3ZpZGVkIGtleVxuICAgICAqIEBwYXJhbSB7c3RyaW5nfSBzdHJcbiAgICAgKi9cbiAgICBzdGF0aWMga2V5KHN0cjogc3RyaW5nKTogc3RyaW5nO1xuICAgIHJlbmRlcjxSPiguLi5hcmdzOiBhbnlbXSk6IFI7XG4gIH1cbn1cbiJdfQ==

package/lib/esm/model/overrides.d.ts

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

package/lib/esm/model/overrides.js

@@ -0,0 +1,7 @@
+import { Model } from "@decaf-ts/decorator-validation";
+import { RenderingEngine } from "../ui/Rendering";
+Model.prototype.render = function (...args) {
+    return RenderingEngine.render(this, ...args);
+};
+
+//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInNyYy9tb2RlbC9vdmVycmlkZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLEtBQUssRUFBRSxNQUFNLGdDQUFnQyxDQUFDO0FBQ3ZELE9BQU8sRUFBRSxlQUFlLEVBQUUsTUFBTSxpQkFBaUIsQ0FBQztBQUVsRCxLQUFLLENBQUMsU0FBUyxDQUFDLE1BQU0sR0FBRyxVQUFvQyxHQUFHLElBQVc7SUFDekUsT0FBTyxlQUFlLENBQUMsTUFBTSxDQUFDLElBQUksRUFBRSxHQUFHLElBQUksQ0FBQyxDQUFDO0FBQy9DLENBQUMsQ0FBQyIsImZpbGUiOiJtb2RlbC9vdmVycmlkZXMuanMiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBNb2RlbCB9IGZyb20gXCJAZGVjYWYtdHMvZGVjb3JhdG9yLXZhbGlkYXRpb25cIjtcbmltcG9ydCB7IFJlbmRlcmluZ0VuZ2luZSB9IGZyb20gXCIuLi91aS9SZW5kZXJpbmdcIjtcblxuTW9kZWwucHJvdG90eXBlLnJlbmRlciA9IGZ1bmN0aW9uIDxNIGV4dGVuZHMgTW9kZWw+KHRoaXM6IE0sIC4uLmFyZ3M6IGFueVtdKSB7XG4gIHJldHVybiBSZW5kZXJpbmdFbmdpbmUucmVuZGVyKHRoaXMsIC4uLmFyZ3MpO1xufTtcbiJdfQ==

package/lib/esm/ui/Rendering.d.ts

@@ -0,0 +1,183 @@
+import { Model, ValidationMetadata } from "@decaf-ts/decorator-validation";
+import { FieldDefinition } from "./types";
+/**
+ * @description Abstract class for rendering UI components based on model metadata.
+ * @summary The RenderingEngine class provides a framework for converting model metadata into UI field definitions.
+ * It handles the translation of model properties to UI elements, applies validation rules, and manages different rendering flavors.
+ * This class is designed to be extended by specific rendering implementations.
+ *
+ * @template T The type of the rendering result, defaults to void
+ * @template R The type of the field definition, defaults to FieldDefinition<T>
+ *
+ * @param {string} flavour - The flavor of the rendering engine.
+ *
+ * @class RenderingEngine
+ */
+export declare abstract class RenderingEngine<T = void, R = FieldDefinition<T>> {
+    readonly flavour: string;
+    /**
+     * @description Cache for storing rendering engine instances or constructors.
+     * @private
+     * @static
+     */
+    private static cache;
+    /**
+     * @description The currently active rendering engine.
+     * @private
+     * @static
+     */
+    private static current;
+    /**
+     * Flag indicating whether the rendering engine has been initialized.
+     */
+    protected initialized: boolean;
+    protected constructor(flavour: string);
+    /**
+     * @description Initializes the rendering engine.
+     * @summary Abstract method to be implemented by subclasses for specific initialization logic.
+     *
+     * @param {...any[]} args - Any additional arguments needed for initialization.
+     * @returns {Promise<void>} A promise that resolves when initialization is complete.
+     *
+     * @abstract
+     */
+    abstract initialize(...args: any[]): Promise<void>;
+    /**
+     * @description Translates between model types and HTML input types.
+     * @summary Converts model data types to appropriate HTML input types and vice versa.
+     *
+     * @param {string} key - The key to translate.
+     * @param {boolean} [toView=true] - Direction of translation (true for model to view, false for view to model).
+     * @returns {string} The translated type.
+     */
+    translate(key: string, toView?: boolean): string;
+    /**
+     * @description Checks if a type is validatable by its nature.
+     * @summary Determines if a given UI key represents a type that is inherently validatable.
+     *
+     * @param {string} key - The UI key to check.
+     * @returns {boolean} True if the type is validatable, false otherwise.
+     */
+    protected isValidatableByType(key: string): boolean;
+    /**
+     * @description Checks if a type is validatable by attribute.
+     * @summary Determines if a given UI key represents a validation that can be applied as an attribute.
+     *
+     * @param {string} key - The UI key to check.
+     * @returns {boolean} True if the type is validatable by attribute, false otherwise.
+     */
+    protected isValidatableByAttribute(key: string): boolean;
+    /**
+     * @description Converts validation metadata to an attribute value.
+     * @summary Transforms validation metadata into a value suitable for use as an HTML attribute.
+     *
+     * @param {string} key - The validation key.
+     * @param {ValidationMetadata} value - The validation metadata.
+     * @returns {string | number | boolean} The converted attribute value.
+     * @throws {Error} If the given key is not validatable by attribute.
+     */
+    protected toAttributeValue(key: string, value: ValidationMetadata): string | number | boolean;
+    /**
+     * @description Converts a model to a field definition.
+     * @summary Processes a model instance, extracting UI-related metadata and validation rules to create a field definition.
+     *
+     * @template M Type extending Model
+     * @template T Type referencing the specific Rendering engine field properties/inputs
+     * @param {M} model - The model instance to convert.
+     * @param {Record<string, unknown>} [globalProps={}] - Global properties to apply to all child elements.
+     * @param {boolean} [generateId=true] - Flag indicating whether to populate the rendererId property.
+     * @returns {FieldDefinition<T>} A field definition object representing the UI structure of the model.
+     * @throws {RenderingError} If no UI definitions are set for the model or if there are invalid decorators.
+     *
+     * @mermaid
+     * sequenceDiagram
+     *  participant C as Client
+     *  participant RE as RenderingEngine
+     *  participant R as Reflection
+     *  participant M as Model
+     *  C->>RE: toFieldDefinition(model, globalProps)
+     *  RE->>R: getMetadata(UIKeys.UIMODEL, model.constructor)
+     *  R-->>RE: UIModelMetadata
+     *  RE->>R: getAllPropertyDecorators(model, UIKeys.REFLECT)
+     *  R-->>RE: Record<string, DecoratorMetadata[]>
+     *  RE->>R: getAllPropertyDecorators(model, ValidationKeys.REFLECT)
+     *  R-->>RE: Record<string, DecoratorMetadata<ValidationMetadata>[]>
+     *  loop For each property
+     *    RE->>RE: Process UI decorators
+     *    RE->>RE: Apply validation rules
+     *  end
+     *  RE-->>C: FieldDefinition<T>
+     */
+    protected toFieldDefinition<M extends Model>(model: M, globalProps?: Record<string, unknown>, generateId?: boolean): FieldDefinition<T>;
+    /**
+     * @description Renders a model with global properties and additional arguments.
+     * @summary Abstract method to be implemented by subclasses to define specific rendering behavior.
+     *
+     * @template M Type extending Model
+     * @template R Rendering engine implementation specific output type
+     * @param {M} model - The model to be rendered.
+     * @param {Record<string, unknown>} globalProps - Global properties to be applied to all elements during rendering.
+     * @param {...any[]} args - Additional arguments that may be required for specific rendering implementations.
+     * @returns {R} The rendered result, type depends on the specific implementation.
+     *
+     * @abstract
+     */
+    abstract render<M extends Model>(model: M, globalProps: Record<string, unknown>, ...args: any[]): R;
+    /**
+     * @description Registers a rendering engine instance.
+     * @summary Adds a rendering engine to the static cache and sets it as the current engine.
+     *
+     * @param {RenderingEngine<unknown, unknown>} engine - The rendering engine to register.
+     * @throws {InternalError} If an engine with the same flavor already exists.
+     *
+     * @static
+     */
+    static register(engine: RenderingEngine<unknown, unknown>): void;
+    /**
+     * @description Retrieves or initializes a rendering engine.
+     * @summary Gets an existing engine instance or creates and initializes a new one if given a constructor.
+     *
+     * @template O The type of the rendering engine output
+     * @param {Constructor<RenderingEngine<O>> | RenderingEngine<O>} obj - The engine instance or constructor.
+     * @returns {RenderingEngine<O>} The initialized rendering engine.
+     *
+     * @private
+     * @static
+     */
+    private static getOrBoot;
+    /**
+     * @description Retrieves a rendering engine by flavor.
+     * @summary Gets the current rendering engine or a specific one by flavor.
+     *
+     * @template O The type of the rendering engine output
+     * @param {string} [flavour] - The flavor of the rendering engine to retrieve.
+     * @returns {RenderingEngine<O>} The requested rendering engine.
+     * @throws {InternalError} If the requested flavor does not exist.
+     *
+     * @static
+     */
+    static get<O>(flavour?: string): RenderingEngine<O>;
+    /**
+     * @description Renders a model using the appropriate rendering engine.
+     * @summary Determines the correct rendering engine for a model and invokes its render method.
+     *
+     * @template M Type extending Model
+     * @param {M} model - The model to render.
+     * @param {...any[]} args - Additional arguments to pass to the render method.
+     * @returns {any} The result of the rendering process.
+     * @throws {InternalError} If no registered model is found.
+     *
+     * @static
+     */
+    static render<M extends Model>(model: M, ...args: any[]): any;
+    /**
+     * @description Generates a metadata key for UI-related properties.
+     * @summary Prefixes a given key with the UI reflection prefix.
+     *
+     * @param {string} key - The key to prefix.
+     * @returns {string} The prefixed key.
+     *
+     * @static
+     */
+    static key(key: string): string;
+}