@decaf-ts/ui-decorators 0.4.5 → 0.4.6

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

@@ -0,0 +1,11 @@
+/**
+ * @namespace ui-decorators.ui
+ * @memberOf ui-decorators
+ */
+export * from "./constants";
+export * from "./decorators";
+export * from "./errors";
+export * from "./interfaces";
+export * from "./Rendering";
+export * from "./types";
+export * from "./utils";

package/lib/esm/ui/index.js

@@ -0,0 +1,13 @@
+/**
+ * @namespace ui-decorators.ui
+ * @memberOf ui-decorators
+ */
+export * from "./constants";
+export * from "./decorators";
+export * from "./errors";
+export * from "./interfaces";
+export * from "./Rendering";
+export * from "./types";
+export * from "./utils";
+
+//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInNyYy91aS9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQTs7O0dBR0c7QUFFSCxjQUFjLGFBQWEsQ0FBQztBQUM1QixjQUFjLGNBQWMsQ0FBQztBQUM3QixjQUFjLFVBQVUsQ0FBQztBQUN6QixjQUFjLGNBQWMsQ0FBQztBQUM3QixjQUFjLGFBQWEsQ0FBQztBQUM1QixjQUFjLFNBQVMsQ0FBQztBQUN4QixjQUFjLFNBQVMsQ0FBQyIsImZpbGUiOiJ1aS9pbmRleC5qcyIsInNvdXJjZXNDb250ZW50IjpbIi8qKlxuICogQG5hbWVzcGFjZSB1aS1kZWNvcmF0b3JzLnVpXG4gKiBAbWVtYmVyT2YgdWktZGVjb3JhdG9yc1xuICovXG5cbmV4cG9ydCAqIGZyb20gXCIuL2NvbnN0YW50c1wiO1xuZXhwb3J0ICogZnJvbSBcIi4vZGVjb3JhdG9yc1wiO1xuZXhwb3J0ICogZnJvbSBcIi4vZXJyb3JzXCI7XG5leHBvcnQgKiBmcm9tIFwiLi9pbnRlcmZhY2VzXCI7XG5leHBvcnQgKiBmcm9tIFwiLi9SZW5kZXJpbmdcIjtcbmV4cG9ydCAqIGZyb20gXCIuL3R5cGVzXCI7XG5leHBvcnQgKiBmcm9tIFwiLi91dGlsc1wiO1xuIl19

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

@@ -0,0 +1,5 @@
+import { FieldProperties } from "./types";
+import { CrudOperations } from "@decaf-ts/db-decorators";
+export interface CrudFormField extends FieldProperties {
+    operation: CrudOperations;
+}

package/lib/esm/ui/interfaces.js

@@ -0,0 +1,3 @@
+export {};
+
+//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInNyYy91aS9pbnRlcmZhY2VzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiIiLCJmaWxlIjoidWkvaW50ZXJmYWNlcy5qcyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IEZpZWxkUHJvcGVydGllcyB9IGZyb20gXCIuL3R5cGVzXCI7XG5pbXBvcnQgeyBDcnVkT3BlcmF0aW9ucyB9IGZyb20gXCJAZGVjYWYtdHMvZGItZGVjb3JhdG9yc1wiO1xuXG5leHBvcnQgaW50ZXJmYWNlIENydWRGb3JtRmllbGQgZXh0ZW5kcyBGaWVsZFByb3BlcnRpZXMge1xuICBvcGVyYXRpb246IENydWRPcGVyYXRpb25zO1xufVxuIl19

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

@@ -0,0 +1,46 @@
+import { OperationKeys } from "@decaf-ts/db-decorators";
+export interface FieldDefinition<T = void> {
+    tag: string;
+    rendererId?: string;
+    props: T & FieldProperties;
+    children?: FieldDefinition<T>[];
+}
+export interface FieldProperties {
+    name: string;
+    type: string;
+    value: string | number | Date;
+    hidden?: boolean;
+    disabled?: boolean;
+    required?: boolean;
+    readonly?: boolean;
+    maxLength?: number;
+    minLength?: number;
+    max?: number | Date;
+    min?: number | Date;
+    pattern?: string;
+    step?: number;
+    format?: string;
+}
+/**
+ * @typedef UIElementMetadata
+ * @memberOf ui-decorators.ui.decorators
+ */
+export type UIElementMetadata = {
+    tag: string;
+    props?: Record<string, any>;
+    serialize?: boolean;
+};
+/**
+ * @typedef UIElementMetadata
+ * @memberOf ui-decorators.ui.decorators
+ */
+export type UIModelMetadata = Omit<UIElementMetadata, "serialize">;
+/**
+ * @typedef UIPropMetadata
+ * @memberOf ui-decorators.ui.decorators
+ */
+export type UIPropMetadata = {
+    name: string;
+    stringify: boolean;
+};
+export type CrudOperationKeys = OperationKeys.CREATE | OperationKeys.READ | OperationKeys.UPDATE | OperationKeys.DELETE;

package/lib/esm/ui/types.js

@@ -0,0 +1,3 @@
+export {};
+
+//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInNyYy91aS90eXBlcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwiZmlsZSI6InVpL3R5cGVzLmpzIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgT3BlcmF0aW9uS2V5cyB9IGZyb20gXCJAZGVjYWYtdHMvZGItZGVjb3JhdG9yc1wiO1xuXG5leHBvcnQgaW50ZXJmYWNlIEZpZWxkRGVmaW5pdGlvbjxUID0gdm9pZD4ge1xuICB0YWc6IHN0cmluZztcbiAgcmVuZGVyZXJJZD86IHN0cmluZztcbiAgcHJvcHM6IFQgJiBGaWVsZFByb3BlcnRpZXM7XG4gIGNoaWxkcmVuPzogRmllbGREZWZpbml0aW9uPFQ+W107XG59XG5cbmV4cG9ydCBpbnRlcmZhY2UgRmllbGRQcm9wZXJ0aWVzIHtcbiAgbmFtZTogc3RyaW5nO1xuICB0eXBlOiBzdHJpbmc7XG4gIHZhbHVlOiBzdHJpbmcgfCBudW1iZXIgfCBEYXRlO1xuICBoaWRkZW4/OiBib29sZWFuO1xuICBkaXNhYmxlZD86IGJvb2xlYW47XG4gIC8vIFZhbGlkYXRpb25cbiAgcmVxdWlyZWQ/OiBib29sZWFuO1xuICByZWFkb25seT86IGJvb2xlYW47XG4gIG1heExlbmd0aD86IG51bWJlcjtcbiAgbWluTGVuZ3RoPzogbnVtYmVyO1xuICBtYXg/OiBudW1iZXIgfCBEYXRlO1xuICBtaW4/OiBudW1iZXIgfCBEYXRlO1xuICBwYXR0ZXJuPzogc3RyaW5nO1xuICBzdGVwPzogbnVtYmVyO1xuICBmb3JtYXQ/OiBzdHJpbmc7XG59XG5cbi8qKlxuICogQHR5cGVkZWYgVUlFbGVtZW50TWV0YWRhdGFcbiAqIEBtZW1iZXJPZiB1aS1kZWNvcmF0b3JzLnVpLmRlY29yYXRvcnNcbiAqL1xuZXhwb3J0IHR5cGUgVUlFbGVtZW50TWV0YWRhdGEgPSB7XG4gIHRhZzogc3RyaW5nO1xuICBwcm9wcz86IFJlY29yZDxzdHJpbmcsIGFueT47XG4gIHNlcmlhbGl6ZT86IGJvb2xlYW47XG59O1xuXG4vKipcbiAqIEB0eXBlZGVmIFVJRWxlbWVudE1ldGFkYXRhXG4gKiBAbWVtYmVyT2YgdWktZGVjb3JhdG9ycy51aS5kZWNvcmF0b3JzXG4gKi9cbmV4cG9ydCB0eXBlIFVJTW9kZWxNZXRhZGF0YSA9IE9taXQ8VUlFbGVtZW50TWV0YWRhdGEsIFwic2VyaWFsaXplXCI+O1xuXG4vKipcbiAqIEB0eXBlZGVmIFVJUHJvcE1ldGFkYXRhXG4gKiBAbWVtYmVyT2YgdWktZGVjb3JhdG9ycy51aS5kZWNvcmF0b3JzXG4gKi9cbmV4cG9ydCB0eXBlIFVJUHJvcE1ldGFkYXRhID0ge1xuICBuYW1lOiBzdHJpbmc7XG4gIHN0cmluZ2lmeTogYm9vbGVhbjtcbn07XG5cbmV4cG9ydCB0eXBlIENydWRPcGVyYXRpb25LZXlzID1cbiAgfCBPcGVyYXRpb25LZXlzLkNSRUFURVxuICB8IE9wZXJhdGlvbktleXMuUkVBRFxuICB8IE9wZXJhdGlvbktleXMuVVBEQVRFXG4gIHwgT3BlcmF0aW9uS2V5cy5ERUxFVEU7XG4iXX0=

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

@@ -0,0 +1,13 @@
+import { Model } from "@decaf-ts/decorator-validation";
+import { FieldProperties } from "./types";
+/**
+ * @function formatByType
+ *
+ * @memberOf ui-decorators-web.ui
+ */
+export declare function formatByType(type: any, value: any, ...args: unknown[]): string | number;
+export declare function parseValueByType(type: string, value: string | number, fieldProps: FieldProperties): string | number | Date;
+export declare function parseToNumber(value: string | number): number | undefined;
+export declare function escapeHtml(value: string): string | undefined;
+export declare function revertHtml(value: string): string;
+export declare function generateUIModelID<M extends Model>(model: M): string;

package/lib/esm/ui/utils.js

@@ -0,0 +1,88 @@
+import { formatDate, parseDate, ReservedModels, } from "@decaf-ts/decorator-validation";
+import { HTML5DateFormat, HTML5InputTypes, UIKeys } from "./constants";
+import { findModelId, InternalError } from "@decaf-ts/db-decorators";
+/**
+ * @function formatByType
+ *
+ * @memberOf ui-decorators-web.ui
+ */
+export function formatByType(type, value, ...args) {
+    if (type === UIKeys.DATE) {
+        const format = args.shift() || HTML5DateFormat;
+        return formatDate(new Date(value), format);
+    }
+    return value;
+}
+export function parseValueByType(type, value, fieldProps) {
+    let result = undefined;
+    switch (type) {
+        case HTML5InputTypes.NUMBER:
+            result = parseToNumber(value);
+            break;
+        case HTML5InputTypes.DATE: {
+            const format = fieldProps.format;
+            result =
+                typeof value === ReservedModels.NUMBER
+                    ? new Date(value)
+                    : value
+                        ? format
+                            ? parseDate(format, value)
+                            : new Date(value)
+                        : undefined;
+            break;
+        }
+        default:
+            result =
+                typeof value === ReservedModels.STRING
+                    ? escapeHtml(value)
+                    : result;
+    }
+    if (typeof result === "undefined") {
+        throw new InternalError(`Failed to parse value of type ${type} from ${typeof value} - ${value}`);
+    }
+    return result;
+}
+export function parseToNumber(value) {
+    if (typeof value === "number" && !isNaN(value))
+        return value;
+    const parsed = Number(value);
+    if (!isNaN(parsed))
+        return parsed;
+    return undefined;
+}
+export function escapeHtml(value) {
+    if (!value)
+        return undefined;
+    const tagsToReplace = {
+        "&": "&",
+        "<": "&lt;",
+        ">": "&gt;",
+    };
+    return `${value}`.replace(/[&<>]/g, (tag) => {
+        return tagsToReplace[tag] || tag;
+    });
+}
+export function revertHtml(value) {
+    const tagsToReplace = {
+        "&amp;": "&",
+        "&lt;": "<",
+        "&gt;": ">",
+    };
+    return `${value}`.replace(/&lt;|&gt;|&amp;/g, (tag) => {
+        return tagsToReplace[tag] || tag;
+    });
+}
+export function generateUIModelID(model) {
+    let id;
+    try {
+        id = findModelId(model);
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    }
+    catch (e) {
+        id = Date.now();
+    }
+    const name = model.constructor.name;
+    return `${name}-${id}`;
+}
+
+//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInNyYy91aS91dGlscy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQ0wsVUFBVSxFQUVWLFNBQVMsRUFDVCxjQUFjLEdBQ2YsTUFBTSxnQ0FBZ0MsQ0FBQztBQUN4QyxPQUFPLEVBQUUsZUFBZSxFQUFFLGVBQWUsRUFBRSxNQUFNLEVBQUUsTUFBTSxhQUFhLENBQUM7QUFDdkUsT0FBTyxFQUFFLFdBQVcsRUFBRSxhQUFhLEVBQUUsTUFBTSx5QkFBeUIsQ0FBQztBQUdyRTs7OztHQUlHO0FBQ0gsTUFBTSxVQUFVLFlBQVksQ0FDMUIsSUFBUyxFQUNULEtBQVUsRUFDVixHQUFHLElBQWU7SUFFbEIsSUFBSSxJQUFJLEtBQUssTUFBTSxDQUFDLElBQUksRUFBRSxDQUFDO1FBQ3pCLE1BQU0sTUFBTSxHQUFZLElBQUksQ0FBQyxLQUFLLEVBQWEsSUFBSSxlQUFlLENBQUM7UUFDbkUsT0FBTyxVQUFVLENBQUMsSUFBSSxJQUFJLENBQUMsS0FBSyxDQUFDLEVBQUUsTUFBTSxDQUFDLENBQUM7SUFDN0MsQ0FBQztJQUNELE9BQU8sS0FBSyxDQUFDO0FBQ2YsQ0FBQztBQUVELE1BQU0sVUFBVSxnQkFBZ0IsQ0FDOUIsSUFBWSxFQUNaLEtBQXNCLEVBQ3RCLFVBQTJCO0lBRTNCLElBQUksTUFBTSxHQUF1QyxTQUFTLENBQUM7SUFDM0QsUUFBUSxJQUFJLEVBQUUsQ0FBQztRQUNiLEtBQUssZUFBZSxDQUFDLE1BQU07WUFDekIsTUFBTSxHQUFHLGFBQWEsQ0FBQyxLQUFLLENBQUMsQ0FBQztZQUM5QixNQUFNO1FBQ1IsS0FBSyxlQUFlLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQztZQUMxQixNQUFNLE1BQU0sR0FBdUIsVUFBVSxDQUFDLE1BQU0sQ0FBQztZQUNyRCxNQUFNO2dCQUNKLE9BQU8sS0FBSyxLQUFLLGNBQWMsQ0FBQyxNQUFNO29CQUNwQyxDQUFDLENBQUMsSUFBSSxJQUFJLENBQUMsS0FBSyxDQUFDO29CQUNqQixDQUFDLENBQUMsS0FBSzt3QkFDTCxDQUFDLENBQUMsTUFBTTs0QkFDTixDQUFDLENBQUMsU0FBUyxDQUFDLE1BQU0sRUFBRSxLQUFLLENBQUM7NEJBQzFCLENBQUMsQ0FBQyxJQUFJLElBQUksQ0FBQyxLQUFLLENBQUM7d0JBQ25CLENBQUMsQ0FBQyxTQUFTLENBQUM7WUFDbEIsTUFBTTtRQUNSLENBQUM7UUFDRDtZQUNFLE1BQU07Z0JBQ0osT0FBTyxLQUFLLEtBQUssY0FBYyxDQUFDLE1BQU07b0JBQ3BDLENBQUMsQ0FBQyxVQUFVLENBQUMsS0FBZSxDQUFDO29CQUM3QixDQUFDLENBQUMsTUFBTSxDQUFDO0lBQ2pCLENBQUM7SUFDRCxJQUFJLE9BQU8sTUFBTSxLQUFLLFdBQVcsRUFBRSxDQUFDO1FBQ2xDLE1BQU0sSUFBSSxhQUFhLENBQ3JCLGlDQUFpQyxJQUFJLFNBQVMsT0FBTyxLQUFLLE1BQU0sS0FBSyxFQUFFLENBQ3hFLENBQUM7SUFDSixDQUFDO0lBQ0QsT0FBTyxNQUFNLENBQUM7QUFDaEIsQ0FBQztBQUVELE1BQU0sVUFBVSxhQUFhLENBQUMsS0FBc0I7SUFDbEQsSUFBSSxPQUFPLEtBQUssS0FBSyxRQUFRLElBQUksQ0FBQyxLQUFLLENBQUMsS0FBSyxDQUFDO1FBQUUsT0FBTyxLQUFLLENBQUM7SUFFN0QsTUFBTSxNQUFNLEdBQUcsTUFBTSxDQUFDLEtBQUssQ0FBQyxDQUFDO0lBQzdCLElBQUksQ0FBQyxLQUFLLENBQUMsTUFBTSxDQUFDO1FBQUUsT0FBTyxNQUFNLENBQUM7SUFFbEMsT0FBTyxTQUFTLENBQUM7QUFDbkIsQ0FBQztBQUVELE1BQU0sVUFBVSxVQUFVLENBQUMsS0FBYTtJQUN0QyxJQUFJLENBQUMsS0FBSztRQUFFLE9BQU8sU0FBUyxDQUFDO0lBRTdCLE1BQU0sYUFBYSxHQUEyQjtRQUM1QyxHQUFHLEVBQUUsT0FBTztRQUNaLEdBQUcsRUFBRSxNQUFNO1FBQ1gsR0FBRyxFQUFFLE1BQU07S0FDWixDQUFDO0lBQ0YsT0FBTyxHQUFHLEtBQUssRUFBRSxDQUFDLE9BQU8sQ0FBQyxRQUFRLEVBQUUsQ0FBQyxHQUFHLEVBQUUsRUFBRTtRQUMxQyxPQUFPLGFBQWEsQ0FBQyxHQUFHLENBQUMsSUFBSSxHQUFHLENBQUM7SUFDbkMsQ0FBQyxDQUFDLENBQUM7QUFDTCxDQUFDO0FBRUQsTUFBTSxVQUFVLFVBQVUsQ0FBQyxLQUFhO0lBQ3RDLE1BQU0sYUFBYSxHQUEyQjtRQUM1QyxPQUFPLEVBQUUsR0FBRztRQUNaLE1BQU0sRUFBRSxHQUFHO1FBQ1gsTUFBTSxFQUFFLEdBQUc7S0FDWixDQUFDO0lBRUYsT0FBTyxHQUFHLEtBQUssRUFBRSxDQUFDLE9BQU8sQ0FBQyxrQkFBa0IsRUFBRSxDQUFDLEdBQUcsRUFBRSxFQUFFO1FBQ3BELE9BQU8sYUFBYSxDQUFDLEdBQUcsQ0FBQyxJQUFJLEdBQUcsQ0FBQztJQUNuQyxDQUFDLENBQUMsQ0FBQztBQUNMLENBQUM7QUFFRCxNQUFNLFVBQVUsaUJBQWlCLENBQWtCLEtBQVE7SUFDekQsSUFBSSxFQUFtQixDQUFDO0lBQ3hCLElBQUksQ0FBQztRQUNILEVBQUUsR0FBRyxXQUFXLENBQUMsS0FBSyxDQUFDLENBQUM7UUFDeEIsNkRBQTZEO0lBQy9ELENBQUM7SUFBQyxPQUFPLENBQVUsRUFBRSxDQUFDO1FBQ3BCLEVBQUUsR0FBRyxJQUFJLENBQUMsR0FBRyxFQUFFLENBQUM7SUFDbEIsQ0FBQztJQUNELE1BQU0sSUFBSSxHQUFHLEtBQUssQ0FBQyxXQUFXLENBQUMsSUFBSSxDQUFDO0lBQ3BDLE9BQU8sR0FBRyxJQUFJLElBQUksRUFBRSxFQUFFLENBQUM7QUFDekIsQ0FBQyIsImZpbGUiOiJ1aS91dGlscy5qcyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7XG4gIGZvcm1hdERhdGUsXG4gIE1vZGVsLFxuICBwYXJzZURhdGUsXG4gIFJlc2VydmVkTW9kZWxzLFxufSBmcm9tIFwiQGRlY2FmLXRzL2RlY29yYXRvci12YWxpZGF0aW9uXCI7XG5pbXBvcnQgeyBIVE1MNURhdGVGb3JtYXQsIEhUTUw1SW5wdXRUeXBlcywgVUlLZXlzIH0gZnJvbSBcIi4vY29uc3RhbnRzXCI7XG5pbXBvcnQgeyBmaW5kTW9kZWxJZCwgSW50ZXJuYWxFcnJvciB9IGZyb20gXCJAZGVjYWYtdHMvZGItZGVjb3JhdG9yc1wiO1xuaW1wb3J0IHsgRmllbGRQcm9wZXJ0aWVzIH0gZnJvbSBcIi4vdHlwZXNcIjtcblxuLyoqXG4gKiBAZnVuY3Rpb24gZm9ybWF0QnlUeXBlXG4gKlxuICogQG1lbWJlck9mIHVpLWRlY29yYXRvcnMtd2ViLnVpXG4gKi9cbmV4cG9ydCBmdW5jdGlvbiBmb3JtYXRCeVR5cGUoXG4gIHR5cGU6IGFueSxcbiAgdmFsdWU6IGFueSxcbiAgLi4uYXJnczogdW5rbm93bltdXG4pOiBzdHJpbmcgfCBudW1iZXIge1xuICBpZiAodHlwZSA9PT0gVUlLZXlzLkRBVEUpIHtcbiAgICBjb25zdCBmb3JtYXQ6IHN0cmluZyA9IChhcmdzLnNoaWZ0KCkgYXMgc3RyaW5nKSB8fCBIVE1MNURhdGVGb3JtYXQ7XG4gICAgcmV0dXJuIGZvcm1hdERhdGUobmV3IERhdGUodmFsdWUpLCBmb3JtYXQpO1xuICB9XG4gIHJldHVybiB2YWx1ZTtcbn1cblxuZXhwb3J0IGZ1bmN0aW9uIHBhcnNlVmFsdWVCeVR5cGUoXG4gIHR5cGU6IHN0cmluZyxcbiAgdmFsdWU6IHN0cmluZyB8IG51bWJlcixcbiAgZmllbGRQcm9wczogRmllbGRQcm9wZXJ0aWVzXG4pOiBzdHJpbmcgfCBudW1iZXIgfCBEYXRlIHtcbiAgbGV0IHJlc3VsdDogc3RyaW5nIHwgbnVtYmVyIHwgRGF0ZSB8IHVuZGVmaW5lZCA9IHVuZGVmaW5lZDtcbiAgc3dpdGNoICh0eXBlKSB7XG4gICAgY2FzZSBIVE1MNUlucHV0VHlwZXMuTlVNQkVSOlxuICAgICAgcmVzdWx0ID0gcGFyc2VUb051bWJlcih2YWx1ZSk7XG4gICAgICBicmVhaztcbiAgICBjYXNlIEhUTUw1SW5wdXRUeXBlcy5EQVRFOiB7XG4gICAgICBjb25zdCBmb3JtYXQ6IHN0cmluZyB8IHVuZGVmaW5lZCA9IGZpZWxkUHJvcHMuZm9ybWF0O1xuICAgICAgcmVzdWx0ID1cbiAgICAgICAgdHlwZW9mIHZhbHVlID09PSBSZXNlcnZlZE1vZGVscy5OVU1CRVJcbiAgICAgICAgICA/IG5ldyBEYXRlKHZhbHVlKVxuICAgICAgICAgIDogdmFsdWVcbiAgICAgICAgICAgID8gZm9ybWF0XG4gICAgICAgICAgICAgID8gcGFyc2VEYXRlKGZvcm1hdCwgdmFsdWUpXG4gICAgICAgICAgICAgIDogbmV3IERhdGUodmFsdWUpXG4gICAgICAgICAgICA6IHVuZGVmaW5lZDtcbiAgICAgIGJyZWFrO1xuICAgIH1cbiAgICBkZWZhdWx0OlxuICAgICAgcmVzdWx0ID1cbiAgICAgICAgdHlwZW9mIHZhbHVlID09PSBSZXNlcnZlZE1vZGVscy5TVFJJTkdcbiAgICAgICAgICA/IGVzY2FwZUh0bWwodmFsdWUgYXMgc3RyaW5nKVxuICAgICAgICAgIDogcmVzdWx0O1xuICB9XG4gIGlmICh0eXBlb2YgcmVzdWx0ID09PSBcInVuZGVmaW5lZFwiKSB7XG4gICAgdGhyb3cgbmV3IEludGVybmFsRXJyb3IoXG4gICAgICBgRmFpbGVkIHRvIHBhcnNlIHZhbHVlIG9mIHR5cGUgJHt0eXBlfSBmcm9tICR7dHlwZW9mIHZhbHVlfSAtICR7dmFsdWV9YFxuICAgICk7XG4gIH1cbiAgcmV0dXJuIHJlc3VsdDtcbn1cblxuZXhwb3J0IGZ1bmN0aW9uIHBhcnNlVG9OdW1iZXIodmFsdWU6IHN0cmluZyB8IG51bWJlcikge1xuICBpZiAodHlwZW9mIHZhbHVlID09PSBcIm51bWJlclwiICYmICFpc05hTih2YWx1ZSkpIHJldHVybiB2YWx1ZTtcblxuICBjb25zdCBwYXJzZWQgPSBOdW1iZXIodmFsdWUpO1xuICBpZiAoIWlzTmFOKHBhcnNlZCkpIHJldHVybiBwYXJzZWQ7XG5cbiAgcmV0dXJuIHVuZGVmaW5lZDtcbn1cblxuZXhwb3J0IGZ1bmN0aW9uIGVzY2FwZUh0bWwodmFsdWU6IHN0cmluZykge1xuICBpZiAoIXZhbHVlKSByZXR1cm4gdW5kZWZpbmVkO1xuXG4gIGNvbnN0IHRhZ3NUb1JlcGxhY2U6IFJlY29yZDxzdHJpbmcsIHN0cmluZz4gPSB7XG4gICAgXCImXCI6IFwiJmFtcDtcIixcbiAgICBcIjxcIjogXCImbHQ7XCIsXG4gICAgXCI+XCI6IFwiJmd0O1wiLFxuICB9O1xuICByZXR1cm4gYCR7dmFsdWV9YC5yZXBsYWNlKC9bJjw+XS9nLCAodGFnKSA9PiB7XG4gICAgcmV0dXJuIHRhZ3NUb1JlcGxhY2VbdGFnXSB8fCB0YWc7XG4gIH0pO1xufVxuXG5leHBvcnQgZnVuY3Rpb24gcmV2ZXJ0SHRtbCh2YWx1ZTogc3RyaW5nKSB7XG4gIGNvbnN0IHRhZ3NUb1JlcGxhY2U6IFJlY29yZDxzdHJpbmcsIHN0cmluZz4gPSB7XG4gICAgXCImYW1wO1wiOiBcIiZcIixcbiAgICBcIiZsdDtcIjogXCI8XCIsXG4gICAgXCImZ3Q7XCI6IFwiPlwiLFxuICB9O1xuXG4gIHJldHVybiBgJHt2YWx1ZX1gLnJlcGxhY2UoLyZsdDt8Jmd0O3wmYW1wOy9nLCAodGFnKSA9PiB7XG4gICAgcmV0dXJuIHRhZ3NUb1JlcGxhY2VbdGFnXSB8fCB0YWc7XG4gIH0pO1xufVxuXG5leHBvcnQgZnVuY3Rpb24gZ2VuZXJhdGVVSU1vZGVsSUQ8TSBleHRlbmRzIE1vZGVsPihtb2RlbDogTSkge1xuICBsZXQgaWQ6IHN0cmluZyB8IG51bWJlcjtcbiAgdHJ5IHtcbiAgICBpZCA9IGZpbmRNb2RlbElkKG1vZGVsKTtcbiAgICAvLyBlc2xpbnQtZGlzYWJsZS1uZXh0LWxpbmUgQHR5cGVzY3JpcHQtZXNsaW50L25vLXVudXNlZC12YXJzXG4gIH0gY2F0Y2ggKGU6IHVua25vd24pIHtcbiAgICBpZCA9IERhdGUubm93KCk7XG4gIH1cbiAgY29uc3QgbmFtZSA9IG1vZGVsLmNvbnN0cnVjdG9yLm5hbWU7XG4gIHJldHVybiBgJHtuYW1lfS0ke2lkfWA7XG59XG4iXX0=

package/lib/index.cjs

@@ -0,0 +1,29 @@
+"use strict";
+/**
+ * @module 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 });
+exports.VERSION = void 0;
+__exportStar(require("./model/index.cjs"), exports);
+__exportStar(require("./ui/index.cjs"), exports);
+/**
+ * @summary stores the current package version
+ * @description this is how you should document a constant
+ * @const VERSION
+ * @memberOf module:ui-decorators
+ */
+exports.VERSION = "0.4.6";

package/lib/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @module ui-decorators
+ */
+export * from "./model";
+export * from "./ui";
+/**
+ * @summary stores the current package version
+ * @description this is how you should document a constant
+ * @const VERSION
+ * @memberOf module:ui-decorators
+ */
+export declare const VERSION = "0.4.6";

package/lib/model/Renderable.cjs

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/model/Renderable.d.ts

@@ -0,0 +1,3 @@
+export interface Renderable {
+    render<R>(...args: any[]): R;
+}

package/lib/model/decorators.cjs

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.uimodel = uimodel;
+exports.renderedBy = renderedBy;
+const constants_1 = require("../ui/constants.cjs");
+const reflection_1 = require("@decaf-ts/reflection");
+const Rendering_1 = require("../ui/Rendering.cjs");
+/**
+ * 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
+ */
+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 (0, reflection_1.metadata)(Rendering_1.RenderingEngine.key(constants_1.UIKeys.UIMODEL), meta)(original);
+    };
+}
+function renderedBy(engine) {
+    return (0, reflection_1.apply)((0, reflection_1.metadata)(Rendering_1.RenderingEngine.key(constants_1.UIKeys.RENDERED_BY), engine));
+}

package/lib/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/model/index.cjs

@@ -0,0 +1,24 @@
+"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);
+__exportStar(require("./Renderable.cjs"), exports);

package/lib/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/model/model.cjs

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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";
+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/model/overrides.cjs

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const decorator_validation_1 = require("@decaf-ts/decorator-validation");
+const Rendering_1 = require("../ui/Rendering.cjs");
+decorator_validation_1.Model.prototype.render = function (...args) {
+    return Rendering_1.RenderingEngine.render(this, ...args);
+};

package/lib/model/overrides.d.ts

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