@decaf-ts/ui-decorators 0.5.32 → 0.6.1

package/lib/model/decorators.cjs

@@ -7,10 +7,8 @@ exports.uihandlers = uihandlers;
 exports.uilayout = uilayout;
 exports.uisteppedmodel = uisteppedmodel;
 const constants_1 = require("./../ui/constants.cjs");
-const reflection_1 = require("@decaf-ts/reflection");
-const Rendering_1 = require("./../ui/Rendering.cjs");
 const constants_2 = require("./../ui/constants.cjs");
-const decorator_validation_1 = require("@decaf-ts/decorator-validation");
+const decoration_1 = require("@decaf-ts/decoration");
 /**
  * @description Decorator that tags a class as a UI model
  * @summary Adds rendering capabilities to a model class by providing a render method
@@ -61,7 +59,7 @@ function uimodel(tag, props) {
             tag: tag || original.name,
             props: props,
         };
-        return (0, reflection_1.metadata)(Rendering_1.RenderingEngine.key(constants_1.UIKeys.UIMODEL), meta)(original);
+        return (0, decoration_1.metadata)(decoration_1.Metadata.key(constants_1.UIKeys.REFLECT, constants_1.UIKeys.UIMODEL), meta)(original);
     };
 }
 /**
@@ -97,7 +95,7 @@ function uimodel(tag, props) {
  *   RenderingEngine->>System: renders with custom engine
  */
 function renderedBy(engine) {
-    return (0, reflection_1.apply)((0, reflection_1.metadata)(Rendering_1.RenderingEngine.key(constants_1.UIKeys.RENDERED_BY), engine));
+    return (0, decoration_1.apply)((0, decoration_1.metadata)(decoration_1.Metadata.key(constants_1.UIKeys.REFLECT, constants_1.UIKeys.RENDERED_BY), engine));
 }
 /**
  * @description Decorator that tags a model as a list item for UI rendering
@@ -153,7 +151,7 @@ function uilistmodel(name, props) {
                 props: props,
             },
         };
-        return (0, reflection_1.metadata)(Rendering_1.RenderingEngine.key(constants_1.UIKeys.UILISTMODEL), meta)(original);
+        return (0, decoration_1.metadata)(decoration_1.Metadata.key(constants_1.UIKeys.REFLECT, constants_1.UIKeys.UILISTMODEL), meta)(original);
     };
 }
 /**
@@ -212,9 +210,9 @@ function uilistmodel(name, props) {
 function uihandlers(props) {
     return (original) => {
         const meta = {
-            handlers: props
+            handlers: props,
         };
-        return (0, reflection_1.metadata)(Rendering_1.RenderingEngine.key(constants_1.UIKeys.HANDLERS), meta)(original);
+        return (0, decoration_1.metadata)(decoration_1.Metadata.key(constants_1.UIKeys.REFLECT, constants_1.UIKeys.HANDLERS), meta)(original);
     };
 }
 /**
@@ -278,17 +276,17 @@ function uihandlers(props) {
 function uilayout(tag, colsMode = 1, rows = 1, props = {}) {
     return (original, propertyKey) => {
         return uimodel(tag, Object.assign({
-            ...(typeof colsMode === decorator_validation_1.ReservedModels.BOOLEAN ?
-                {
+            ...(typeof colsMode === "boolean"
+                ? {
                     flexMode: colsMode,
-                    cols: 1
-                } :
-                {
+                    cols: 1,
+                }
+                : {
                     flexMode: false,
-                    cols: colsMode
+                    cols: colsMode,
                 }),
             rows,
-            ...Object.assign({ breakpoint: constants_2.UIMediaBreakPoints.LARGE }, props)
+            ...Object.assign({ breakpoint: constants_2.UIMediaBreakPoints.LARGE }, props),
         }))(original, propertyKey);
     };
 }
@@ -374,7 +372,7 @@ function uilayout(tag, colsMode = 1, rows = 1, props = {}) {
  */
 function uisteppedmodel(tag, pages = 1, paginated = false, props = {}) {
     let pageTitles = [];
-    if (typeof pages === decorator_validation_1.ReservedModels.OBJECT) {
+    if (typeof pages === "object") {
         pageTitles = pages;
         pages = pageTitles.length;
     }
@@ -382,7 +380,7 @@ function uisteppedmodel(tag, pages = 1, paginated = false, props = {}) {
         pages,
         paginated,
         pageTitles,
-        props
+        props,
     });
 }
 //# sourceMappingURL=decorators.js.map

package/lib/model/decorators.d.ts

@@ -75,7 +75,7 @@ export declare function uimodel(tag?: string, props?: Record<string, any>): (ori
  *   Model->>RenderingEngine: uses specified engine
  *   RenderingEngine->>System: renders with custom engine
  */
-export declare function renderedBy(engine: string): (target: object, propertyKey?: string | symbol | unknown, descriptor?: PropertyDescriptor) => void;
+export declare function renderedBy(engine: string): (target: object, propertyKey?: string | symbol | unknown, descriptor?: PropertyDescriptor | number) => void;
 /**
  * @description Decorator that tags a model as a list item for UI rendering
  * @summary Specifies how a model should be rendered when displayed in a list context

package/lib/model/decorators.js.map

@@ -1 +1 @@
-{"version":3,"file":"decorators.js","sourceRoot":"","sources":["../../src/model/decorators.ts"],"names":[],"mappings":";;AAmDA,0BASC;AAkCD,gCAEC;AA+CD,kCAWC;AAuDD,gCAOC;AA4DD,4BAiBC;AAkFD,wCAYC;AAnYD,qDAAyC;AACzC,qDAAuD;AACvD,qDAAkD;AAElD,qDAAqD;AAErD,yEAAgE;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,SAAgB,OAAO,CAAC,GAAY,EAAE,KAA2B;IAC/D,6DAA6D;IAC7D,OAAO,CAAC,QAAa,EAAE,WAAiB,EAAE,EAAE;QAC1C,MAAM,IAAI,GAAoB;YAC5B,GAAG,EAAE,GAAG,IAAI,QAAQ,CAAC,IAAI;YACzB,KAAK,EAAE,KAAK;SACb,CAAC;QACF,OAAO,IAAA,qBAAQ,EAAC,2BAAe,CAAC,GAAG,CAAC,kBAAM,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC;IACvE,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,SAAgB,UAAU,CAAC,MAAc;IACvC,OAAO,IAAA,kBAAK,EAAC,IAAA,qBAAQ,EAAC,2BAAe,CAAC,GAAG,CAAC,kBAAM,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;AAC1E,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,SAAgB,WAAW,CAAC,IAAa,EAAE,KAA2B;IACpE,6DAA6D;IAC7D,OAAO,CAAC,QAAa,EAAE,WAAiB,EAAE,EAAE;QAC1C,MAAM,IAAI,GAAwB;YAChC,IAAI,EAAE;gBACJ,GAAG,EAAE,IAAI,IAAI,QAAQ,CAAC,IAAI;gBAC1B,KAAK,EAAE,KAAK;aACb;SACF,CAAC;QACF,OAAO,IAAA,qBAAQ,EAAC,2BAAe,CAAC,GAAG,CAAC,kBAAM,CAAC,WAAW,CAAC,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC;IAC3E,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoDG;AACH,SAAgB,UAAU,CAAC,KAA2B;IACpD,OAAO,CAAC,QAAa,EAAE,EAAE;QACvB,MAAM,IAAI,GAAG;YACX,QAAQ,EAAE,KAAK;SAChB,CAAC;QACF,OAAO,IAAA,qBAAQ,EAAC,2BAAe,CAAC,GAAG,CAAC,kBAAM,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC;IACxE,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyDG;AACH,SAAgB,QAAQ,CAAC,GAAW,EAAE,WAA6B,CAAC,EAAE,OAA0B,CAAC,EAAE,QAAa,EAAE;IAChH,OAAO,CAAC,QAAa,EAAE,WAAiB,EAAE,EAAE;QAC1C,OAAO,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,CAAC;YAC/B,GACA,CAAC,OAAO,QAAQ,KAAK,qCAAc,CAAC,OAAO,CAAC,CAAC;gBAC7C;oBACC,QAAQ,EAAE,QAAQ;oBAClB,IAAI,EAAE,CAAC;iBACP,CAAC,CAAC;gBACH;oBACC,QAAQ,EAAE,KAAK;oBACf,IAAI,EAAE,QAAQ;iBACd,CAAC;YACH,IAAI;YACJ,GAAG,MAAM,CAAC,MAAM,CAAC,EAAC,UAAU,EAAE,8BAAkB,CAAC,KAAK,EAAE,EAAE,KAAK,CAAC;SACjE,CAAC,CAAC,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IAC7B,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+EG;AACH,SAAgB,cAAc,CAAC,GAAW,EAAE,QAA8C,CAAC,EAAE,YAAqB,KAAK,EAAE,QAAa,EAAE;IACtI,IAAI,UAAU,GAAgC,EAAE,CAAC;IACjD,IAAI,OAAO,KAAK,KAAK,qCAAc,CAAC,MAAM,EAAE,CAAC;QAC3C,UAAU,GAAG,KAAoC,CAAC;QAClD,KAAK,GAAG,UAAU,CAAC,MAAM,CAAC;IAC5B,CAAC;IACD,OAAO,OAAO,CAAC,GAAG,EAAE;QAClB,KAAK;QACL,SAAS;QACT,UAAU;QACV,KAAK;KACN,CAAC,CAAC;AACL,CAAC"}
+{"version":3,"file":"decorators.js","sourceRoot":"","sources":["../../src/model/decorators.ts"],"names":[],"mappings":";;AAqDA,0BAYC;AAkCD,gCAIC;AA+CD,kCAcC;AAuDD,gCAUC;AA4DD,4BAwBC;AAkFD,wCAiBC;AA5ZD,qDAAyC;AAMzC,qDAAqD;AAErD,qDAAiE;AAEjE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,SAAgB,OAAO,CAAC,GAAY,EAAE,KAA2B;IAC/D,6DAA6D;IAC7D,OAAO,CAAC,QAAa,EAAE,WAAiB,EAAE,EAAE;QAC1C,MAAM,IAAI,GAAoB;YAC5B,GAAG,EAAE,GAAG,IAAI,QAAQ,CAAC,IAAI;YACzB,KAAK,EAAE,KAAK;SACb,CAAC;QACF,OAAO,IAAA,qBAAQ,EACb,qBAAQ,CAAC,GAAG,CAAC,kBAAM,CAAC,OAAO,EAAE,kBAAM,CAAC,OAAO,CAAC,EAC5C,IAAI,CACL,CAAC,QAAQ,CAAC,CAAC;IACd,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,SAAgB,UAAU,CAAC,MAAc;IACvC,OAAO,IAAA,kBAAK,EACV,IAAA,qBAAQ,EAAC,qBAAQ,CAAC,GAAG,CAAC,kBAAM,CAAC,OAAO,EAAE,kBAAM,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC,CACnE,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,SAAgB,WAAW,CAAC,IAAa,EAAE,KAA2B;IACpE,6DAA6D;IAC7D,OAAO,CAAC,QAAa,EAAE,WAAiB,EAAE,EAAE;QAC1C,MAAM,IAAI,GAAwB;YAChC,IAAI,EAAE;gBACJ,GAAG,EAAE,IAAI,IAAI,QAAQ,CAAC,IAAI;gBAC1B,KAAK,EAAE,KAAK;aACb;SACF,CAAC;QACF,OAAO,IAAA,qBAAQ,EACb,qBAAQ,CAAC,GAAG,CAAC,kBAAM,CAAC,OAAO,EAAE,kBAAM,CAAC,WAAW,CAAC,EAChD,IAAI,CACL,CAAC,QAAQ,CAAC,CAAC;IACd,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoDG;AACH,SAAgB,UAAU,CAAC,KAA2B;IACpD,OAAO,CAAC,QAAa,EAAE,EAAE;QACvB,MAAM,IAAI,GAAsB;YAC9B,QAAQ,EAAE,KAAK;SAChB,CAAC;QACF,OAAO,IAAA,qBAAQ,EACb,qBAAQ,CAAC,GAAG,CAAC,kBAAM,CAAC,OAAO,EAAE,kBAAM,CAAC,QAAQ,CAAC,EAC7C,IAAI,CACL,CAAC,QAAQ,CAAC,CAAC;IACd,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyDG;AACH,SAAgB,QAAQ,CACtB,GAAW,EACX,WAA6B,CAAC,EAC9B,OAA0B,CAAC,EAC3B,QAAa,EAAE;IAEf,OAAO,CAAC,QAAa,EAAE,WAAiB,EAAE,EAAE;QAC1C,OAAO,OAAO,CACZ,GAAG,EACH,MAAM,CAAC,MAAM,CAAC;YACZ,GAAG,CAAC,OAAO,QAAQ,KAAK,SAAS;gBAC/B,CAAC,CAAC;oBACE,QAAQ,EAAE,QAAQ;oBAClB,IAAI,EAAE,CAAC;iBACR;gBACH,CAAC,CAAC;oBACE,QAAQ,EAAE,KAAK;oBACf,IAAI,EAAE,QAAQ;iBACf,CAAC;YACN,IAAI;YACJ,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,8BAAkB,CAAC,KAAK,EAAE,EAAE,KAAK,CAAC;SAClE,CAAC,CACH,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IAC3B,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+EG;AACH,SAAgB,cAAc,CAC5B,GAAW,EACX,QAA8C,CAAC,EAC/C,YAAqB,KAAK,EAC1B,QAAa,EAAE;IAEf,IAAI,UAAU,GAAgC,EAAE,CAAC;IACjD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,UAAU,GAAG,KAAoC,CAAC;QAClD,KAAK,GAAG,UAAU,CAAC,MAAM,CAAC;IAC5B,CAAC;IACD,OAAO,OAAO,CAAC,GAAG,EAAE;QAClB,KAAK;QACL,SAAS;QACT,UAAU;QACV,KAAK;KACN,CAAC,CAAC;AACL,CAAC"}

package/lib/model/model.d.ts

@@ -1,4 +1,6 @@
 import { Renderable } from "./Renderable";
+import { Constructor } from "@decaf-ts/decoration";
+import { CrudOperationKeys, UIElementMetadata, UIHandlerMetadata, UILayoutMetadata, UIListModelMetadata, UIModelMetadata } from "../ui/index";
 declare module "@decaf-ts/decorator-validation" {
     interface Model extends Renderable {
         /**
@@ -11,4 +13,19 @@ declare module "@decaf-ts/decorator-validation" {
          */
         render<R>(...args: any[]): R;
     }
+    namespace Model {
+        function renderedBy<M extends Model>(model: Constructor<M>): string | undefined;
+        function uiPropertiesOf<M extends Model>(model: Constructor<M>): string[] | undefined;
+        function uiDecorationOf<M extends Model>(model: Constructor<M>, prop: keyof M, key?: string): any;
+        function uiModelOf<M extends Model>(model: Constructor<M>): UIModelMetadata | undefined;
+        function uiElementOf<M extends Model>(model: Constructor<M>, prop: keyof M): UIElementMetadata | undefined;
+        function uiListModelOf<M extends Model>(model: Constructor<M>): UIListModelMetadata | undefined;
+        function uiHandlersFor<M extends Model>(model: Constructor<M>): UIHandlerMetadata | undefined;
+        function uiLayoutOf<M extends Model>(model: Constructor<M>): UILayoutMetadata | undefined;
+        function uiTypeOf<M extends Model>(model: Constructor<M>, prop: keyof M): UILayoutMetadata | undefined;
+        function uiIsHidden<M extends Model>(model: Constructor<M>, prop: keyof M): boolean;
+        function uiHiddenOn<M extends Model>(model: Constructor<M>, prop: keyof M): CrudOperationKeys[] | false;
+        function uiHiddenOn<M extends Model>(model: Constructor<M>, prop: keyof M, op: CrudOperationKeys): boolean;
+        function uiHiddenOn<M extends Model>(model: Constructor<M>, prop: keyof M, op?: CrudOperationKeys): CrudOperationKeys[] | boolean;
+    }
 }

package/lib/model/overrides.cjs

@@ -10,6 +10,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const decorator_validation_1 = require("@decaf-ts/decorator-validation");
 const Rendering_1 = require("./../ui/Rendering.cjs");
+const decoration_1 = require("@decaf-ts/decoration");
+const index_1 = require("./../ui/index.cjs");
+require("./model.cjs");
+const db_decorators_1 = require("@decaf-ts/db-decorators");
 /**
  * @description Renders the model using the appropriate rendering engine
  * @summary Delegates rendering to the RenderingEngine based on model metadata
@@ -23,4 +27,74 @@ 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.renderedBy = function (model) {
+    return decoration_1.Metadata.get(model, decoration_1.Metadata.key(index_1.UIKeys.REFLECT, index_1.UIKeys.RENDERED_BY));
+}.bind(decorator_validation_1.Model);
+decorator_validation_1.Model.uiPropertiesOf = function (model) {
+    const meta = decoration_1.Metadata.get(model, decoration_1.Metadata.key(index_1.UIKeys.REFLECT, decoration_1.DecorationKeys.PROPERTIES));
+    if (!meta)
+        return undefined;
+    return Object.keys(meta);
+}.bind(decorator_validation_1.Model);
+decorator_validation_1.Model.uiDecorationOf = function (model, prop, key) {
+    const meta = decoration_1.Metadata.get(model, decoration_1.Metadata.key(index_1.UIKeys.REFLECT, decoration_1.DecorationKeys.PROPERTIES, prop));
+    if (!meta)
+        return undefined;
+    if (!key)
+        return meta;
+    return meta[key];
+};
+decorator_validation_1.Model.uiModelOf = function (model) {
+    return decoration_1.Metadata.get(model, decoration_1.Metadata.key(index_1.UIKeys.REFLECT, index_1.UIKeys.UIMODEL));
+};
+decorator_validation_1.Model.uiElementOf = function (model, prop) {
+    return decoration_1.Metadata.get(model, (0, index_1.getUIAttributeKey)(prop, index_1.UIKeys.ELEMENT));
+};
+decorator_validation_1.Model.uiListModelOf = function (model) {
+    return decoration_1.Metadata.get(model, decoration_1.Metadata.key(index_1.UIKeys.REFLECT, index_1.UIKeys.UILISTMODEL));
+};
+decorator_validation_1.Model.uiHandlersFor = function (model) {
+    return decoration_1.Metadata.get(model, decoration_1.Metadata.key(index_1.UIKeys.REFLECT, index_1.UIKeys.HANDLERS));
+};
+decorator_validation_1.Model.uiLayoutOf = function (model) {
+    return decoration_1.Metadata.get(model, decoration_1.Metadata.key(index_1.UIKeys.REFLECT, index_1.UIKeys.UILAYOUT));
+};
+decorator_validation_1.Model.uiIsHidden = function (model, prop) {
+    return !!decoration_1.Metadata.get(model, (0, index_1.getUIAttributeKey)(prop, index_1.UIKeys.HIDDEN));
+};
+decorator_validation_1.Model.uiIsHiddenOn = function (model, prop, op) {
+    const meta = decoration_1.Metadata.get(model, (0, index_1.getUIAttributeKey)(prop, index_1.UIKeys.HIDDEN));
+    if (!meta)
+        return false;
+    if (!op)
+        return meta;
+    return meta.includes(op);
+};
+decorator_validation_1.Model.uiTypeOf = function (model, prop) {
+    const meta = decoration_1.Metadata.get(model, decoration_1.Metadata.key(index_1.UIKeys.REFLECT, decoration_1.DecorationKeys.PROPERTIES, prop));
+    if (!meta)
+        throw new db_decorators_1.NotFoundError(`No metadata found for property '${prop}' on model '${model.name}'`);
+    const keys = Object.keys(meta).filter((k) => [index_1.UIKeys.PROP, index_1.UIKeys.ELEMENT, index_1.UIKeys.CHILD].includes(k));
+    if (keys.length === 0)
+        throw new db_decorators_1.NotFoundError(`No UI type metadata found for property '${prop}' on model '${model.name}'`);
+    if (keys.length > 1)
+        throw new index_1.RenderingError(`Only one type of decoration is allowed. Please choose between @uiprop, @uichild or @uielement`);
+    return meta[keys[0]];
+};
+//
+// (Metadata as any).uiElements = function <M extends Model>(
+//   model: Constructor<M>
+// ): string[] | undefined {
+//   const props = Metadata.uiPropertiesOf(model);
+//   if (!props) return undefined;
+//   return props
+//     .map((prop) => Metadata.get(model, getUIAttributeKey(prop, UIKeys.ELEMENT)))
+//     .filter(Boolean);
+// }.bind(Model);
+decorator_validation_1.Model.uiListItems = function (model) {
+    const meta = decoration_1.Metadata.get(model, decoration_1.Metadata.key(index_1.UIKeys.REFLECT, decoration_1.DecorationKeys.PROPERTIES));
+    if (!meta)
+        return undefined;
+    return Object.keys(meta);
+}.bind(decorator_validation_1.Model);
 //# sourceMappingURL=overrides.js.map

package/lib/model/overrides.d.ts

@@ -6,4 +6,4 @@
  * @module model/overrides
  * @memberOf module:ui-decorators/model
  */
-export {};
+import "./model";

package/lib/model/overrides.js.map

@@ -1 +1 @@
-{"version":3,"file":"overrides.js","sourceRoot":"","sources":["../../src/model/overrides.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;;AAEH,yEAAuD;AACvD,qDAAkD;AAElD;;;;;;;;;GASG;AACH,4BAAK,CAAC,SAAS,CAAC,MAAM,GAAG,UAAoC,GAAG,IAAW;IACzE,OAAO,2BAAe,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC;AAC/C,CAAC,CAAC"}
+{"version":3,"file":"overrides.js","sourceRoot":"","sources":["../../src/model/overrides.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;;AAEH,yEAAuD;AACvD,qDAAkD;AAClD,qDAA6E;AAC7E,6CAOqB;AACrB,uBAAiB;AACjB,2DAAwD;AAExD;;;;;;;;;GASG;AACH,4BAAK,CAAC,SAAS,CAAC,MAAM,GAAG,UAAoC,GAAG,IAAW;IACzE,OAAO,2BAAe,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC;AAC/C,CAAC,CAAC;AAED,4BAAa,CAAC,UAAU,GAAG,UAC1B,KAAqB;IAErB,OAAO,qBAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,qBAAQ,CAAC,GAAG,CAAC,cAAM,CAAC,OAAO,EAAE,cAAM,CAAC,WAAW,CAAC,CAAC,CAAC;AAC/E,CAAC,CAAC,IAAI,CAAC,4BAAK,CAAC,CAAC;AAEb,4BAAa,CAAC,cAAc,GAAG,UAC9B,KAAqB;IAErB,MAAM,IAAI,GAAG,qBAAQ,CAAC,GAAG,CACvB,KAAK,EACL,qBAAQ,CAAC,GAAG,CAAC,cAAM,CAAC,OAAO,EAAE,2BAAc,CAAC,UAAU,CAAC,CACxD,CAAC;IACF,IAAI,CAAC,IAAI;QAAE,OAAO,SAAS,CAAC;IAC5B,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC3B,CAAC,CAAC,IAAI,CAAC,4BAAK,CAAC,CAAC;AAEb,4BAAa,CAAC,cAAc,GAAG,UAC9B,KAAqB,EACrB,IAAY,EACZ,GAAY;IAEZ,MAAM,IAAI,GAAG,qBAAQ,CAAC,GAAG,CACvB,KAAK,EACL,qBAAQ,CAAC,GAAG,CAAC,cAAM,CAAC,OAAO,EAAE,2BAAc,CAAC,UAAU,EAAE,IAAI,CAAC,CAC9D,CAAC;IACF,IAAI,CAAC,IAAI;QAAE,OAAO,SAAS,CAAC;IAC5B,IAAI,CAAC,GAAG;QAAE,OAAO,IAAI,CAAC;IACtB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;AACnB,CAAC,CAAC;AAED,4BAAa,CAAC,SAAS,GAAG,UACzB,KAAqB;IAErB,OAAO,qBAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,qBAAQ,CAAC,GAAG,CAAC,cAAM,CAAC,OAAO,EAAE,cAAM,CAAC,OAAO,CAAC,CAAC,CAAC;AAC3E,CAAC,CAAC;AAED,4BAAa,CAAC,WAAW,GAAG,UAC3B,KAAqB,EACrB,IAAY;IAEZ,OAAO,qBAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,IAAA,yBAAiB,EAAC,IAAI,EAAE,cAAM,CAAC,OAAO,CAAC,CAAC,CAAC;AACtE,CAAC,CAAC;AAED,4BAAa,CAAC,aAAa,GAAG,UAC7B,KAAqB;IAErB,OAAO,qBAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,qBAAQ,CAAC,GAAG,CAAC,cAAM,CAAC,OAAO,EAAE,cAAM,CAAC,WAAW,CAAC,CAAC,CAAC;AAC/E,CAAC,CAAC;AAED,4BAAa,CAAC,aAAa,GAAG,UAC7B,KAAqB;IAErB,OAAO,qBAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,qBAAQ,CAAC,GAAG,CAAC,cAAM,CAAC,OAAO,EAAE,cAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;AAC5E,CAAC,CAAC;AAED,4BAAa,CAAC,UAAU,GAAG,UAC1B,KAAqB;IAErB,OAAO,qBAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,qBAAQ,CAAC,GAAG,CAAC,cAAM,CAAC,OAAO,EAAE,cAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;AAC5E,CAAC,CAAC;AAED,4BAAa,CAAC,UAAU,GAAG,UAC1B,KAAqB,EACrB,IAAY;IAEZ,OAAO,CAAC,CAAC,qBAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,IAAA,yBAAiB,EAAC,IAAI,EAAE,cAAM,CAAC,MAAM,CAAC,CAAC,CAAC;AACvE,CAAC,CAAC;AAED,4BAAa,CAAC,YAAY,GAAG,UAC5B,KAAqB,EACrB,IAAY,EACZ,EAAsB;IAEtB,MAAM,IAAI,GAAG,qBAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,IAAA,yBAAiB,EAAC,IAAI,EAAE,cAAM,CAAC,MAAM,CAAC,CAAC,CAAC;IACzE,IAAI,CAAC,IAAI;QAAE,OAAO,KAAK,CAAC;IACxB,IAAI,CAAC,EAAE;QAAE,OAAO,IAA2B,CAAC;IAC5C,OAAQ,IAA4B,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;AACpD,CAAC,CAAC;AAED,4BAAa,CAAC,QAAQ,GAAG,UACxB,KAAqB,EACrB,IAAY;IAEZ,MAAM,IAAI,GAAG,qBAAQ,CAAC,GAAG,CACvB,KAAK,EACL,qBAAQ,CAAC,GAAG,CAAC,cAAM,CAAC,OAAO,EAAE,2BAAc,CAAC,UAAU,EAAE,IAAI,CAAC,CAC9D,CAAC;IACF,IAAI,CAAC,IAAI;QACP,MAAM,IAAI,6BAAa,CACrB,mCAAmC,IAAI,eAAe,KAAK,CAAC,IAAI,GAAG,CACpE,CAAC;IACJ,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAC1C,CAAC,cAAM,CAAC,IAAI,EAAE,cAAM,CAAC,OAAO,EAAE,cAAM,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CACxD,CAAC;IACF,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QACnB,MAAM,IAAI,6BAAa,CACrB,2CAA2C,IAAI,eAAe,KAAK,CAAC,IAAI,GAAG,CAC5E,CAAC;IACJ,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC;QACjB,MAAM,IAAI,sBAAc,CACtB,+FAA+F,CAChG,CAAC;IACJ,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;AACvB,CAAC,CAAC;AACF,EAAE;AACF,6DAA6D;AAC7D,0BAA0B;AAC1B,4BAA4B;AAC5B,kDAAkD;AAClD,kCAAkC;AAClC,iBAAiB;AACjB,mFAAmF;AACnF,wBAAwB;AACxB,iBAAiB;AAEhB,4BAAa,CAAC,WAAW,GAAG,UAE3B,KAAqB;IAErB,MAAM,IAAI,GAAG,qBAAQ,CAAC,GAAG,CACvB,KAAK,EACL,qBAAQ,CAAC,GAAG,CAAC,cAAM,CAAC,OAAO,EAAE,2BAAc,CAAC,UAAU,CAAC,CACxD,CAAC;IACF,IAAI,CAAC,IAAI;QAAE,OAAO,SAAS,CAAC;IAC5B,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC3B,CAAC,CAAC,IAAI,CAAC,4BAAK,CAAC,CAAC"}

package/lib/ui/DecafComponent.cjs

@@ -0,0 +1,100 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DecafComponent = void 0;
+const logging_1 = require("@decaf-ts/logging");
+const db_decorators_1 = require("@decaf-ts/db-decorators");
+class DecafComponent extends logging_1.LoggedClass {
+    constructor() {
+        super();
+        /**
+         * @description Flag to enable or disable dark mode support for the component.
+         * @summary When enabled, the component will automatically detect the system's dark mode
+         * preference using the media service and apply appropriate styling classes. This flag
+         * controls whether the component should respond to dark mode changes and apply the
+         * dark palette class to its DOM element. By default, dark mode support is disabled.
+         * @protected
+         * @type {boolean}
+         * @default false
+         */
+        this.enableDarkMode = true;
+        /**
+         * @description Flag to enable or disable dark mode support for the component.
+         * @summary When enabled, the component will automatically detect the system's dark mode
+         * preference using the media service and apply appropriate styling classes. This flag
+         * controls whether the component should respond to dark mode changes and apply the
+         * dark palette class to its DOM element. By default, dark mode support is disabled.
+         * @protected
+         * @type {boolean}
+         * @default false
+         */
+        this.isDarkMode = false;
+        /**
+         * @description Configuration for list item rendering behavior.
+         * @summary Defines how list items should be rendered in the component.
+         * This property holds a configuration object that specifies the tag name
+         * and other properties needed to render list items correctly. The tag property
+         * identifies which component should be used to render each item in a list.
+         * Additional properties can be included to customize the rendering behavior.
+         * @type {Record<string, unknown>}
+         * @default {tag: ""}
+         */
+        this.item = { tag: '' };
+        /**
+         * @description Dynamic properties configuration for runtime customization.
+         * @summary Contains key-value pairs of dynamic properties that can be applied to the component
+         * at runtime. This flexible configuration object allows for dynamic property assignment without
+         * requiring explicit input bindings for every possible configuration option. Properties from
+         * this object are parsed and applied to the component instance through the parseProps method,
+         * enabling customizable component behavior based on external configuration.
+         * @type {Record<string, unknown>}
+         * @default {}
+         */
+        this.props = {};
+        /**
+         * @description Base route path for component navigation.
+         * @summary Defines the base route path used for navigation actions related to this component.
+         * This is often used as a prefix for constructing navigation URLs when transitioning between
+         * different operations or views. The route helps establish the component's position in the
+         * application's routing hierarchy.
+         * @type {string}
+         */
+        this.route = "";
+        /**
+         * @description Controls whether borders are displayed around the component.
+         * @summary Boolean flag that determines if the component should be visually outlined with borders.
+         * When true, borders are shown to visually separate the component from surrounding content.
+         *
+         * @type {boolean}
+         * @default false
+         */
+        this.borders = false;
+        /**
+         * @description Reference to CRUD operation constants for template usage.
+         * @summary Exposes the OperationKeys enum to the component template, enabling
+         * conditional rendering and behavior based on operation types. This protected
+         * readonly property ensures that template logic can access operation constants
+         * while maintaining encapsulation and preventing accidental modification.
+         * @protected
+         * @readonly
+         */
+        this.OperationKeys = db_decorators_1.OperationKeys;
+        /**
+         * @description Initialization status flag for the component.
+         * @summary Tracks whether the component has completed its initialization process.
+         * This flag is used to prevent duplicate initialization and to determine if
+         * certain operations that require initialization can be performed.
+         * @type {boolean}
+         * @default false
+         */
+        this.initialized = false;
+        this.handlers = {};
+    }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    async render(...args) { }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    async initialize(...args) {
+        this.initialized = true;
+    }
+}
+exports.DecafComponent = DecafComponent;
+//# sourceMappingURL=DecafComponent.js.map

package/lib/ui/DecafComponent.d.ts

@@ -0,0 +1,195 @@
+import { LoggedClass } from '@decaf-ts/logging';
+import { UIFunctionLike } from './types';
+import { Model } from '@decaf-ts/decorator-validation';
+import { IRepository, OperationKeys } from '@decaf-ts/db-decorators';
+export declare abstract class DecafComponent extends LoggedClass {
+    /**
+     * @description Name identifier for the component instance.
+     * @summary Provides a string identifier that can be used to name or label the component
+     * instance. This name can be used for debugging purposes, logging, or to identify specific
+     * component instances within a larger application structure. It serves as a human-readable
+     * identifier that helps distinguish between multiple instances of the same component type.
+     * @type {string}
+     */
+    protected name: string;
+    /**
+     * @description Parent component identifier for hierarchical component relationships.
+     * @summary Specifies the identifier of the parent component in a hierarchical component structure.
+     * This property establishes a parent-child relationship between components, allowing for
+     * proper nesting and organization of components within a layout. It can be used to track
+     * component dependencies and establish component hierarchies for rendering and event propagation.
+     * @type {string | undefined}
+     */
+    protected childOf: string | undefined;
+    /**
+     * @description Unique identifier for the component instance.
+     * @summary A unique identifier automatically generated for each component instance.
+     * This UID is used for DOM element identification, component tracking, and debugging purposes.
+     * By default, it generates a random 16-character value, but it can be explicitly set via input.
+     * @type {string | number}
+     * @default generateRandomValue(16)
+     */
+    protected uid?: string | number;
+    /**
+     * @description Data model or model name for component operations.
+     * @summary The data model that this component will use for CRUD operations. This can be provided
+     * as a Model instance, a model constructor, or a string representing the model's registered name.
+     * When set, this property provides the component with access to the model's schema, validation rules,
+     * and metadata needed for rendering and data operations.
+     * @type {Model | string | undefined}
+     */
+    protected model: Model | string | undefined;
+    /**
+   * @description Primary key field name for the data model.
+   * @summary Specifies which field in the model should be used as the primary key.
+   * This is typically used for identifying unique records in operations like update and delete.
+   * If not explicitly set, it defaults to the repository's configured primary key or 'id'.
+   * @type {string}
+   * @default 'id'
+   */
+    pk: string;
+    /**
+     * @description Primary key value of the current model instance.
+     * @summary Specifies the primary key value for the current model record being displayed or
+     * manipulated by the component. This identifier is used for CRUD operations that target
+     * specific records, such as read, update, and delete operations. The value corresponds to
+     * the field designated as the primary key in the model definition.
+     * @type {string | number | bigint | string[] | number[] | bigint[]}
+     */
+    protected modelId?: string | number | bigint | string[] | number[] | bigint[];
+    /**
+     * @description Flag to enable or disable dark mode support for the component.
+     * @summary When enabled, the component will automatically detect the system's dark mode
+     * preference using the media service and apply appropriate styling classes. This flag
+     * controls whether the component should respond to dark mode changes and apply the
+     * dark palette class to its DOM element. By default, dark mode support is disabled.
+     * @protected
+     * @type {boolean}
+     * @default false
+     */
+    protected enableDarkMode: boolean;
+    /**
+     * @description Flag to enable or disable dark mode support for the component.
+     * @summary When enabled, the component will automatically detect the system's dark mode
+     * preference using the media service and apply appropriate styling classes. This flag
+     * controls whether the component should respond to dark mode changes and apply the
+     * dark palette class to its DOM element. By default, dark mode support is disabled.
+     * @protected
+     * @type {boolean}
+     * @default false
+     */
+    protected isDarkMode: boolean;
+    /**
+     * @description Current locale identifier for component internationalization.
+     * @summary Specifies the locale code (e.g., 'en-US', 'pt-BR') used for translating UI text
+     * and formatting data according to regional conventions. This property can be set to override
+     * the default application locale for this specific component instance, enabling per-component
+     * localization when needed.
+     * @type {string | undefined}
+     */
+    locale?: string;
+    /**
+     * @description Configuration for list item rendering behavior.
+     * @summary Defines how list items should be rendered in the component.
+     * This property holds a configuration object that specifies the tag name
+     * and other properties needed to render list items correctly. The tag property
+     * identifies which component should be used to render each item in a list.
+     * Additional properties can be included to customize the rendering behavior.
+     * @type {Record<string, unknown>}
+     * @default {tag: ""}
+     */
+    item: Record<string, unknown>;
+    /**
+     * @description Dynamic properties configuration for runtime customization.
+     * @summary Contains key-value pairs of dynamic properties that can be applied to the component
+     * at runtime. This flexible configuration object allows for dynamic property assignment without
+     * requiring explicit input bindings for every possible configuration option. Properties from
+     * this object are parsed and applied to the component instance through the parseProps method,
+     * enabling customizable component behavior based on external configuration.
+     * @type {Record<string, unknown>}
+     * @default {}
+     */
+    props: Record<string, unknown>;
+    /**
+     * @description Base route path for component navigation.
+     * @summary Defines the base route path used for navigation actions related to this component.
+     * This is often used as a prefix for constructing navigation URLs when transitioning between
+     * different operations or views. The route helps establish the component's position in the
+     * application's routing hierarchy.
+     * @type {string}
+     */
+    route?: string;
+    /**
+     * @description Controls whether borders are displayed around the component.
+     * @summary Boolean flag that determines if the component should be visually outlined with borders.
+     * When true, borders are shown to visually separate the component from surrounding content.
+     *
+     * @type {boolean}
+     * @default false
+     */
+    borders: boolean;
+    /**
+     * @description Component name identifier for logging and localization contexts.
+     * @summary Stores the component's name which is used as a key for logging contexts
+     * and as a base for locale resolution. Can be injected via the CPTKN token or defaults
+     * to "NgxComponentDirective" if not provided.
+     * @protected
+     * @type {string | undefined}
+     */
+    protected componentName?: string;
+    /**
+     * @description Root key for component locale context resolution.
+     * @summary Defines the base key used to resolve localization contexts for this component.
+     * If not explicitly provided, it defaults to the component's name. This key is used to
+     * load appropriate translation resources and locale-specific configurations.
+     * @protected
+     * @type {string | undefined}
+     */
+    protected localeRoot?: string;
+    /**
+     * @description Reference to CRUD operation constants for template usage.
+     * @summary Exposes the OperationKeys enum to the component template, enabling
+     * conditional rendering and behavior based on operation types. This protected
+     * readonly property ensures that template logic can access operation constants
+     * while maintaining encapsulation and preventing accidental modification.
+     * @protected
+     * @readonly
+     */
+    protected readonly OperationKeys: typeof OperationKeys;
+    /**
+     * @description Angular Location service.
+     * @summary Injected service that provides direct access to the browser's URL and history.
+     * Unlike the Router, Location allows for low-level manipulation of the browser's history stack
+     * and URL path, such as programmatically navigating back or forward, or updating the URL without
+     * triggering a route change. This is useful for scenarios where you need to interact with the
+     * browser history or URL outside of Angular's routing system, such as closing modals, handling
+     * popstate events, or supporting custom navigation logic.
+     *
+     */
+    protected location: any;
+    /**
+     * @description Repository instance for data layer operations.
+     * @summary Provides a connection to the data layer for retrieving and manipulating data.
+     * This is an instance of the DecafRepository class, initialized lazily in the repository getter.
+     * The repository is used to perform CRUD (Create, Read, Update, Delete) operations on the
+     * data model and provides methods for querying and filtering data based on specific criteria.
+     * @type {DecafRepository<Model>}
+     * @private
+     * @memberOf module:lib/engine/NgxComponentDirective
+     */
+    protected _repository?: IRepository<Model>;
+    /**
+     * @description Initialization status flag for the component.
+     * @summary Tracks whether the component has completed its initialization process.
+     * This flag is used to prevent duplicate initialization and to determine if
+     * certain operations that require initialization can be performed.
+     * @type {boolean}
+     * @default false
+     */
+    protected initialized: boolean;
+    protected events?: Record<keyof Pick<DecafComponent, 'render' | 'initialize'>, UIFunctionLike>;
+    protected handlers: Record<string, UIFunctionLike>;
+    constructor();
+    render(...args: unknown[]): Promise<void>;
+    initialize(...args: unknown[]): Promise<void>;
+}

package/lib/ui/DecafComponent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DecafComponent.js","sourceRoot":"","sources":["../../src/ui/DecafComponent.ts"],"names":[],"mappings":";;;AAAA,+CAAgD;AAGhD,2DAAqE;AAGrE,MAAsB,cAAe,SAAQ,qBAAW;IA4NtD;QACE,KAAK,EAAE,CAAC;QA5JV;;;;;;;;;WASG;QACO,mBAAc,GAAY,IAAI,CAAC;QAEzC;;;;;;;;;WASG;QACO,eAAU,GAAY,KAAK,CAAC;QActC;;;;;;;;;WASG;QACH,SAAI,GAA4B,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC;QAG5C;;;;;;;;;WASG;QACH,UAAK,GAA4B,EAAE,CAAC;QAGpC;;;;;;;WAOG;QACH,UAAK,GAAY,EAAE,CAAC;QAEpB;;;;;;;WAOG;QACH,YAAO,GAAY,KAAK,CAAC;QAuBzB;;;;;;;;WAQG;QACgB,kBAAa,GAAG,6BAAa,CAAC;QA6BjD;;;;;;;WAOG;QACO,gBAAW,GAAY,KAAK,CAAC;QAI7B,aAAQ,GAAmC,EAAE,CAAC;IAIxD,CAAC;IAED,6DAA6D;IAC7D,KAAK,CAAC,MAAM,CAAC,GAAG,IAAe,IAAkB,CAAC;IAElD,6DAA6D;IAC7D,KAAK,CAAC,UAAU,CAAC,GAAG,IAAe;QACjC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;IAC1B,CAAC;CAEF;AAxOD,wCAwOC"}