@decaf-ts/ui-decorators 0.5.9 → 0.5.10

package/lib/ui/decorators.cjs

@@ -11,50 +11,177 @@ const decorator_validation_1 = require("@decaf-ts/decorator-validation");
 const Rendering_1 = require("./Rendering.cjs");
 const db_decorators_1 = require("@decaf-ts/db-decorators");
 /**
- * @namespace ui-decorators.ui.decorators
- * @memberOf ui-decorators.ui
+ * @description Decorator that hides a property during specific CRUD operations
+ * @summary Controls property visibility based on operation type
+ * This decorator allows you to specify which CRUD operations should hide a property
+ * in the UI. The property will only be visible during operations not specified.
+ *
+ * @param operations - The CRUD operations during which the property should be hidden
+ * @return {Function} A property decorator function
+ *
+ * @function hideOn
+ * @category Property Decorators
+ *
+ * @example
+ * // Hide the password field during READ operations
+ * class User {
+ *   @attribute()
+ *   username: string;
+ *
+ *   @attribute()
+ *   @hideOn(OperationKeys.READ)
+ *   password: string;
+ * }
+ *
+ * @mermaid
+ * sequenceDiagram
+ *   participant Model
+ *   participant hideOn
+ *   participant RenderingEngine
+ *   participant UI
+ *   Model->>hideOn: Apply to property
+ *   hideOn->>Model: Add hidden metadata
+ *   RenderingEngine->>Model: Check if property should be hidden
+ *   Model->>RenderingEngine: Return hidden operations
+ *   RenderingEngine->>UI: Render or hide based on current operation
  */
 function hideOn(...operations) {
     return (0, decorator_validation_1.propMetadata)(Rendering_1.RenderingEngine.key(constants_1.UIKeys.HIDDEN), operations);
 }
+/**
+ * @description Decorator that completely hides a property in all UI operations
+ * @summary Makes a property invisible in all CRUD operations
+ * This decorator is a convenience wrapper around hideOn that hides a property
+ * during all CRUD operations (CREATE, READ, UPDATE, DELETE).
+ *
+ * @return {Function} A property decorator function
+ *
+ * @function hidden
+ * @category Property Decorators
+ *
+ * @example
+ * // Completely hide the internalId field in the UI
+ * class Product {
+ *   @attribute()
+ *   name: string;
+ *
+ *   @attribute()
+ *   @hidden()
+ *   internalId: string;
+ * }
+ *
+ * @mermaid
+ * sequenceDiagram
+ *   participant Model
+ *   participant hidden
+ *   participant hideOn
+ *   participant RenderingEngine
+ *   Model->>hidden: Apply to property
+ *   hidden->>hideOn: Call with all operations
+ *   hideOn->>Model: Add hidden metadata
+ *   RenderingEngine->>Model: Check if property should be hidden
+ *   Model->>RenderingEngine: Return all operations
+ *   RenderingEngine->>UI: Always hide property
+ */
 function hidden() {
     return hideOn(db_decorators_1.OperationKeys.CREATE, db_decorators_1.OperationKeys.READ, db_decorators_1.OperationKeys.UPDATE, db_decorators_1.OperationKeys.DELETE);
 }
 /**
- * Adds the UIElement definition as metadata to the property, allowing it to be read by any {@link RenderStrategy}
+ * @description Decorator that specifies how a property should be rendered as a UI element
+ * @summary Maps a model property to a specific UI element with custom properties
+ * This decorator allows you to define which HTML element or component should be used
+ * to render a specific property, along with any additional properties to pass to that element.
+ *
+ * @param {string} tag The HTML element or component tag name to use for rendering
+ * @param {Record<string, any>} [props] Additional properties to pass to the element
+ * @param {boolean} [serialize=false] Whether the property should be serialized
+ * @return {Function} A property decorator function
+ *
+ * @function uielement
+ * @category Property Decorators
+ *
+ * @example
+ * // Render a property as a text input
+ * class LoginForm {
+ *   @attribute()
+ *   @uielement('input', { type: 'text', placeholder: 'Enter username' })
+ *   username: string;
  *
- * @param {string} tag The component/HTML element tag name
- * @param {{}} [props] The properties to pass to that component/HTML Element
- * @param serialize
+ *   @attribute()
+ *   @uielement('input', { type: 'password', placeholder: 'Enter password' })
+ *   password: string;
  *
- * @decorator uielement
+ *   @attribute()
+ *   @uielement('button', { class: 'btn-primary' })
+ *   submit: string = 'Login';
+ * }
  *
- * @category Decorators
- * @subcategory ui-decorators
+ * @mermaid
+ * sequenceDiagram
+ *   participant Model
+ *   participant uielement
+ *   participant RenderingEngine
+ *   participant UI
+ *   Model->>uielement: Apply to property
+ *   uielement->>Model: Add element metadata
+ *   RenderingEngine->>Model: Get element metadata
+ *   Model->>RenderingEngine: Return tag and props
+ *   RenderingEngine->>UI: Render with specified element
  */
 function uielement(tag, props, serialize = false) {
     return (original, propertyKey) => {
         const metadata = {
             tag: tag,
             serialize: serialize,
-            props: Object.assign({
+            props: Object.assign({}, props || {}, {
                 name: propertyKey,
-            }, props || {}),
+            }),
         };
         return (0, decorator_validation_1.propMetadata)(Rendering_1.RenderingEngine.key(constants_1.UIKeys.ELEMENT), metadata)(original, propertyKey);
     };
 }
 /**
- * Adds the UIProp definition as metadata to the property, allowing it to be read by any {@link RenderStrategy}
+ * @description Decorator that maps a model property to a UI component property
+ * @summary Specifies how a property should be passed to a UI component
+ * This decorator allows you to define how a model property should be mapped to
+ * a property of the UI component when rendering. It requires the class to be
+ * decorated with @uimodel.
  *
- * this requires a '@uimodel' with a defined tag
+ * @param {string} [propName] The name of the property to pass to the component (defaults to the property key)
+ * @param {boolean} [stringify=false] Whether to stringify the property value
+ * @return {Function} A property decorator function
  *
- * @param {string} [propName] the property name that will be passed to the component. defaults to the PropertyKey
+ * @function uiprop
+ * @category Property Decorators
  *
- * @decorator uiprop
+ * @example
+ * // Map model properties to component properties
+ * @uimodel('user-profile')
+ * class UserProfile {
+ *   @attribute()
+ *   @uiprop() // Will be passed as 'fullName' to the component
+ *   fullName: string;
  *
- * @category Decorators
- * @subcategory ui-decorators
+ *   @attribute()
+ *   @uiprop('userEmail') // Will be passed as 'userEmail' to the component
+ *   email: string;
+ *
+ *   @attribute()
+ *   @uiprop('userData', true) // Will be passed as stringified JSON
+ *   userData: Record<string, any>;
+ * }
+ *
+ * @mermaid
+ * sequenceDiagram
+ *   participant Model
+ *   participant uiprop
+ *   participant RenderingEngine
+ *   participant Component
+ *   Model->>uiprop: Apply to property
+ *   uiprop->>Model: Add prop metadata
+ *   RenderingEngine->>Model: Get prop metadata
+ *   Model->>RenderingEngine: Return prop name and stringify flag
+ *   RenderingEngine->>Component: Pass property with specified name
  */
 function uiprop(propName = undefined, stringify = false) {
     return (target, propertyKey) => {
@@ -66,24 +193,61 @@ function uiprop(propName = undefined, stringify = false) {
     };
 }
 /**
- * Adds the UIListProp definition as metadata to the property, allowing it to be read by any {@link RenderStrategy}
+ * @description Decorator that maps a model property to a list item component
+ * @summary Specifies how a property should be rendered in a list context
+ * This decorator allows you to define how a model property containing a list
+ * should be rendered. It requires the class to be decorated with @uilistitem.
+ *
+ * @param {string} [propName] The name of the property to pass to the list component (defaults to the property key)
+ * @param {Record<string, any>} [props] Additional properties to pass to the list container
+ * @return {Function} A property decorator function
+ *
+ * @function uilistprop
+ * @category Property Decorators
+ *
+ * @example
+ * // Define a list property with custom rendering
+ * @uimodel('todo-list')
+ * class TodoList {
+ *   @attribute()
+ *   title: string;
  *
- * this requires a '@uilistitem' with a defined tag
+ *   @attribute()
+ *   @uilistprop('items', { class: 'todo-items-container' })
+ *   items: TodoItem[];
+ * }
  *
- * @param {string} [propName] the property name that will be passed to the component. defaults to the PropertyKey
+ * @uilistitem('li', { class: 'todo-item' })
+ * class TodoItem extends Model {
+ *   @attribute()
+ *   text: string;
  *
- * @decorator uiprop
+ *   @attribute()
+ *   completed: boolean;
+ * }
  *
- * @category Decorators
- * @subcategory ui-decorators
+ * @mermaid
+ * sequenceDiagram
+ *   participant Model
+ *   participant uilistprop
+ *   participant RenderingEngine
+ *   participant ListContainer
+ *   participant ListItems
+ *   Model->>uilistprop: Apply to property
+ *   uilistprop->>Model: Add list prop metadata
+ *   RenderingEngine->>Model: Get list prop metadata
+ *   Model->>RenderingEngine: Return prop name and container props
+ *   RenderingEngine->>ListContainer: Create container with props
+ *   RenderingEngine->>ListItems: Render each item using @uilistitem
+ *   ListContainer->>RenderingEngine: Return rendered list
  */
 function uilistprop(propName = undefined, props) {
     return (target, propertyKey) => {
         const metadata = {
             name: propName || propertyKey,
-            props: props || {}
+            props: props || {},
         };
         (0, decorator_validation_1.propMetadata)(Rendering_1.RenderingEngine.key(constants_1.UIKeys.UILISTPROP), metadata)(target, propertyKey);
     };
 }
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZGVjb3JhdG9ycy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy91aS9kZWNvcmF0b3JzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBWUEsd0JBS0M7QUFFRCx3QkFPQztBQWNELDhCQXNCQztBQWNELHdCQWNDO0FBZUQsZ0NBY0M7QUF2SEQsNEJBQTBCO0FBQzFCLCtDQUFxQztBQUNyQyx5RUFBOEQ7QUFFOUQsK0NBQThDO0FBQzlDLDJEQUF3RDtBQUV4RDs7O0dBR0c7QUFFSCxTQUFnQixNQUFNLENBQUMsR0FBRyxVQUErQjtJQUN2RCxPQUFPLElBQUEsbUNBQVksRUFDakIsMkJBQWUsQ0FBQyxHQUFHLENBQUMsa0JBQU0sQ0FBQyxNQUFNLENBQUMsRUFDbEMsVUFBVSxDQUNYLENBQUM7QUFDSixDQUFDO0FBRUQsU0FBZ0IsTUFBTTtJQUNwQixPQUFPLE1BQU0sQ0FDWCw2QkFBYSxDQUFDLE1BQU0sRUFDcEIsNkJBQWEsQ0FBQyxJQUFJLEVBQ2xCLDZCQUFhLENBQUMsTUFBTSxFQUNwQiw2QkFBYSxDQUFDLE1BQU0sQ0FDckIsQ0FBQztBQUNKLENBQUM7QUFFRDs7Ozs7Ozs7Ozs7R0FXRztBQUNILFNBQWdCLFNBQVMsQ0FDdkIsR0FBVyxFQUNYLEtBQTJCLEVBQzNCLFlBQXFCLEtBQUs7SUFFMUIsT0FBTyxDQUFDLFFBQWEsRUFBRSxXQUFpQixFQUFFLEVBQUU7UUFDMUMsTUFBTSxRQUFRLEdBQXNCO1lBQ2xDLEdBQUcsRUFBRSxHQUFHO1lBQ1IsU0FBUyxFQUFFLFNBQVM7WUFDcEIsS0FBSyxFQUFFLE1BQU0sQ0FBQyxNQUFNLENBQ2xCO2dCQUNFLElBQUksRUFBRSxXQUFXO2FBQ2xCLEVBQ0QsS0FBSyxJQUFJLEVBQUUsQ0FDWjtTQUNGLENBQUM7UUFFRixPQUFPLElBQUEsbUNBQVksRUFBQywyQkFBZSxDQUFDLEdBQUcsQ0FBQyxrQkFBTSxDQUFDLE9BQU8sQ0FBQyxFQUFFLFFBQVEsQ0FBQyxDQUNoRSxRQUFRLEVBQ1IsV0FBVyxDQUNaLENBQUM7SUFDSixDQUFDLENBQUM7QUFDSixDQUFDO0FBRUQ7Ozs7Ozs7Ozs7O0dBV0c7QUFDSCxTQUFnQixNQUFNLENBQ3BCLFdBQStCLFNBQVMsRUFDeEMsWUFBcUIsS0FBSztJQUUxQixPQUFPLENBQUMsTUFBVyxFQUFFLFdBQW1CLEVBQUUsRUFBRTtRQUMxQyxNQUFNLFFBQVEsR0FBbUI7WUFDL0IsSUFBSSxFQUFFLFFBQVEsSUFBSSxXQUFXO1lBQzdCLFNBQVMsRUFBRSxTQUFTO1NBQ3JCLENBQUM7UUFDRixJQUFBLG1DQUFZLEVBQUMsMkJBQWUsQ0FBQyxHQUFHLENBQUMsa0JBQU0sQ0FBQyxJQUFJLENBQUMsRUFBRSxRQUFRLENBQUMsQ0FDdEQsTUFBTSxFQUNOLFdBQVcsQ0FDWixDQUFDO0lBQ0osQ0FBQyxDQUFDO0FBQ0osQ0FBQztBQUdEOzs7Ozs7Ozs7OztHQVdHO0FBQ0gsU0FBZ0IsVUFBVSxDQUN4QixXQUErQixTQUFTLEVBQ3hDLEtBQTJCO0lBRTNCLE9BQU8sQ0FBQyxNQUFXLEVBQUUsV0FBbUIsRUFBRSxFQUFFO1FBQ3hDLE1BQU0sUUFBUSxHQUFnQztZQUM5QyxJQUFJLEVBQUUsUUFBUSxJQUFJLFdBQVc7WUFDN0IsS0FBSyxFQUFFLEtBQUssSUFBSSxFQUFFO1NBQ25CLENBQUM7UUFDRixJQUFBLG1DQUFZLEVBQUMsMkJBQWUsQ0FBQyxHQUFHLENBQUMsa0JBQU0sQ0FBQyxVQUFVLENBQUMsRUFBRSxRQUFRLENBQUMsQ0FDNUQsTUFBTSxFQUNOLFdBQVcsQ0FDWixDQUFDO0lBQ0osQ0FBQyxDQUFDO0FBQ0osQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCBcInJlZmxlY3QtbWV0YWRhdGFcIjtcbmltcG9ydCB7IFVJS2V5cyB9IGZyb20gXCIuL2NvbnN0YW50c1wiO1xuaW1wb3J0IHsgcHJvcE1ldGFkYXRhIH0gZnJvbSBcIkBkZWNhZi10cy9kZWNvcmF0b3ItdmFsaWRhdGlvblwiO1xuaW1wb3J0IHsgQ3J1ZE9wZXJhdGlvbktleXMsIFVJRWxlbWVudE1ldGFkYXRhLCBVSUxpc3RQcm9wTWV0YWRhdGEsIFVJUHJvcE1ldGFkYXRhIH0gZnJvbSBcIi4vdHlwZXNcIjtcbmltcG9ydCB7IFJlbmRlcmluZ0VuZ2luZSB9IGZyb20gXCIuL1JlbmRlcmluZ1wiO1xuaW1wb3J0IHsgT3BlcmF0aW9uS2V5cyB9IGZyb20gXCJAZGVjYWYtdHMvZGItZGVjb3JhdG9yc1wiO1xuXG4vKipcbiAqIEBuYW1lc3BhY2UgdWktZGVjb3JhdG9ycy51aS5kZWNvcmF0b3JzXG4gKiBAbWVtYmVyT2YgdWktZGVjb3JhdG9ycy51aVxuICovXG5cbmV4cG9ydCBmdW5jdGlvbiBoaWRlT24oLi4ub3BlcmF0aW9uczogQ3J1ZE9wZXJhdGlvbktleXNbXSkge1xuICByZXR1cm4gcHJvcE1ldGFkYXRhPENydWRPcGVyYXRpb25LZXlzW10+KFxuICAgIFJlbmRlcmluZ0VuZ2luZS5rZXkoVUlLZXlzLkhJRERFTiksXG4gICAgb3BlcmF0aW9uc1xuICApO1xufVxuXG5leHBvcnQgZnVuY3Rpb24gaGlkZGVuKCkge1xuICByZXR1cm4gaGlkZU9uKFxuICAgIE9wZXJhdGlvbktleXMuQ1JFQVRFLFxuICAgIE9wZXJhdGlvbktleXMuUkVBRCxcbiAgICBPcGVyYXRpb25LZXlzLlVQREFURSxcbiAgICBPcGVyYXRpb25LZXlzLkRFTEVURVxuICApO1xufVxuXG4vKipcbiAqIEFkZHMgdGhlIFVJRWxlbWVudCBkZWZpbml0aW9uIGFzIG1ldGFkYXRhIHRvIHRoZSBwcm9wZXJ0eSwgYWxsb3dpbmcgaXQgdG8gYmUgcmVhZCBieSBhbnkge0BsaW5rIFJlbmRlclN0cmF0ZWd5fVxuICpcbiAqIEBwYXJhbSB7c3RyaW5nfSB0YWcgVGhlIGNvbXBvbmVudC9IVE1MIGVsZW1lbnQgdGFnIG5hbWVcbiAqIEBwYXJhbSB7e319IFtwcm9wc10gVGhlIHByb3BlcnRpZXMgdG8gcGFzcyB0byB0aGF0IGNvbXBvbmVudC9IVE1MIEVsZW1lbnRcbiAqIEBwYXJhbSBzZXJpYWxpemVcbiAqXG4gKiBAZGVjb3JhdG9yIHVpZWxlbWVudFxuICpcbiAqIEBjYXRlZ29yeSBEZWNvcmF0b3JzXG4gKiBAc3ViY2F0ZWdvcnkgdWktZGVjb3JhdG9yc1xuICovXG5leHBvcnQgZnVuY3Rpb24gdWllbGVtZW50KFxuICB0YWc6IHN0cmluZyxcbiAgcHJvcHM/OiBSZWNvcmQ8c3RyaW5nLCBhbnk+LFxuICBzZXJpYWxpemU6IGJvb2xlYW4gPSBmYWxzZVxuKSB7XG4gIHJldHVybiAob3JpZ2luYWw6IGFueSwgcHJvcGVydHlLZXk/OiBhbnkpID0+IHtcbiAgICBjb25zdCBtZXRhZGF0YTogVUlFbGVtZW50TWV0YWRhdGEgPSB7XG4gICAgICB0YWc6IHRhZyxcbiAgICAgIHNlcmlhbGl6ZTogc2VyaWFsaXplLFxuICAgICAgcHJvcHM6IE9iamVjdC5hc3NpZ24oXG4gICAgICAgIHtcbiAgICAgICAgICBuYW1lOiBwcm9wZXJ0eUtleSxcbiAgICAgICAgfSxcbiAgICAgICAgcHJvcHMgfHwge31cbiAgICAgICksXG4gICAgfTtcblxuICAgIHJldHVybiBwcm9wTWV0YWRhdGEoUmVuZGVyaW5nRW5naW5lLmtleShVSUtleXMuRUxFTUVOVCksIG1ldGFkYXRhKShcbiAgICAgIG9yaWdpbmFsLFxuICAgICAgcHJvcGVydHlLZXlcbiAgICApO1xuICB9O1xufVxuXG4vKipcbiAqIEFkZHMgdGhlIFVJUHJvcCBkZWZpbml0aW9uIGFzIG1ldGFkYXRhIHRvIHRoZSBwcm9wZXJ0eSwgYWxsb3dpbmcgaXQgdG8gYmUgcmVhZCBieSBhbnkge0BsaW5rIFJlbmRlclN0cmF0ZWd5fVxuICpcbiAqIHRoaXMgcmVxdWlyZXMgYSAnQHVpbW9kZWwnIHdpdGggYSBkZWZpbmVkIHRhZ1xuICpcbiAqIEBwYXJhbSB7c3RyaW5nfSBbcHJvcE5hbWVdIHRoZSBwcm9wZXJ0eSBuYW1lIHRoYXQgd2lsbCBiZSBwYXNzZWQgdG8gdGhlIGNvbXBvbmVudC4gZGVmYXVsdHMgdG8gdGhlIFByb3BlcnR5S2V5XG4gKlxuICogQGRlY29yYXRvciB1aXByb3BcbiAqXG4gKiBAY2F0ZWdvcnkgRGVjb3JhdG9yc1xuICogQHN1YmNhdGVnb3J5IHVpLWRlY29yYXRvcnNcbiAqL1xuZXhwb3J0IGZ1bmN0aW9uIHVpcHJvcChcbiAgcHJvcE5hbWU6IHN0cmluZyB8IHVuZGVmaW5lZCA9IHVuZGVmaW5lZCxcbiAgc3RyaW5naWZ5OiBib29sZWFuID0gZmFsc2Vcbikge1xuICByZXR1cm4gKHRhcmdldDogYW55LCBwcm9wZXJ0eUtleTogc3RyaW5nKSA9PiB7XG4gICAgY29uc3QgbWV0YWRhdGE6IFVJUHJvcE1ldGFkYXRhID0ge1xuICAgICAgbmFtZTogcHJvcE5hbWUgfHwgcHJvcGVydHlLZXksXG4gICAgICBzdHJpbmdpZnk6IHN0cmluZ2lmeSxcbiAgICB9O1xuICAgIHByb3BNZXRhZGF0YShSZW5kZXJpbmdFbmdpbmUua2V5KFVJS2V5cy5QUk9QKSwgbWV0YWRhdGEpKFxuICAgICAgdGFyZ2V0LFxuICAgICAgcHJvcGVydHlLZXlcbiAgICApO1xuICB9O1xufVxuXG5cbi8qKlxuICogQWRkcyB0aGUgVUlMaXN0UHJvcCBkZWZpbml0aW9uIGFzIG1ldGFkYXRhIHRvIHRoZSBwcm9wZXJ0eSwgYWxsb3dpbmcgaXQgdG8gYmUgcmVhZCBieSBhbnkge0BsaW5rIFJlbmRlclN0cmF0ZWd5fVxuICpcbiAqIHRoaXMgcmVxdWlyZXMgYSAnQHVpbGlzdGl0ZW0nIHdpdGggYSBkZWZpbmVkIHRhZ1xuICpcbiAqIEBwYXJhbSB7c3RyaW5nfSBbcHJvcE5hbWVdIHRoZSBwcm9wZXJ0eSBuYW1lIHRoYXQgd2lsbCBiZSBwYXNzZWQgdG8gdGhlIGNvbXBvbmVudC4gZGVmYXVsdHMgdG8gdGhlIFByb3BlcnR5S2V5XG4gKlxuICogQGRlY29yYXRvciB1aXByb3BcbiAqXG4gKiBAY2F0ZWdvcnkgRGVjb3JhdG9yc1xuICogQHN1YmNhdGVnb3J5IHVpLWRlY29yYXRvcnNcbiAqL1xuZXhwb3J0IGZ1bmN0aW9uIHVpbGlzdHByb3AoXG4gIHByb3BOYW1lOiBzdHJpbmcgfCB1bmRlZmluZWQgPSB1bmRlZmluZWQsXG4gIHByb3BzPzogUmVjb3JkPHN0cmluZywgYW55Pixcbikge1xuICByZXR1cm4gKHRhcmdldDogYW55LCBwcm9wZXJ0eUtleTogc3RyaW5nKSA9PiB7XG4gICAgICBjb25zdCBtZXRhZGF0YTogUGFydGlhbDxVSUxpc3RQcm9wTWV0YWRhdGE+ID0ge1xuICAgICAgbmFtZTogcHJvcE5hbWUgfHwgcHJvcGVydHlLZXksXG4gICAgICBwcm9wczogcHJvcHMgfHwge31cbiAgICB9O1xuICAgIHByb3BNZXRhZGF0YShSZW5kZXJpbmdFbmdpbmUua2V5KFVJS2V5cy5VSUxJU1RQUk9QKSwgbWV0YWRhdGEpKFxuICAgICAgdGFyZ2V0LFxuICAgICAgcHJvcGVydHlLZXlcbiAgICApO1xuICB9O1xufVxuIl19
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"decorators.js","sourceRoot":"","sources":["../../src/ui/decorators.ts"],"names":[],"mappings":";;AA+CA,wBAKC;AAqCD,wBAOC;AA4CD,8BAmBC;AA6CD,wBAcC;AAmDD,gCAcC;AA3RD,4BAA0B;AAC1B,+CAAqC;AACrC,yEAA8D;AAO9D,+CAA8C;AAC9C,2DAAwD;AAExD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,SAAgB,MAAM,CAAC,GAAG,UAA+B;IACvD,OAAO,IAAA,mCAAY,EACjB,2BAAe,CAAC,GAAG,CAAC,kBAAM,CAAC,MAAM,CAAC,EAClC,UAAU,CACX,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,SAAgB,MAAM;IACpB,OAAO,MAAM,CACX,6BAAa,CAAC,MAAM,EACpB,6BAAa,CAAC,IAAI,EAClB,6BAAa,CAAC,MAAM,EACpB,6BAAa,CAAC,MAAM,CACrB,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,SAAgB,SAAS,CACvB,GAAW,EACX,KAA2B,EAC3B,YAAqB,KAAK;IAE1B,OAAO,CAAC,QAAa,EAAE,WAAiB,EAAE,EAAE;QAC1C,MAAM,QAAQ,GAAsB;YAClC,GAAG,EAAE,GAAG;YACR,SAAS,EAAE,SAAS;YACpB,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,KAAK,IAAI,EAAE,EAAE;gBACpC,IAAI,EAAE,WAAW;aAClB,CAAC;SACH,CAAC;QAEF,OAAO,IAAA,mCAAY,EAAC,2BAAe,CAAC,GAAG,CAAC,kBAAM,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,CAChE,QAAQ,EACR,WAAW,CACZ,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,SAAgB,MAAM,CACpB,WAA+B,SAAS,EACxC,YAAqB,KAAK;IAE1B,OAAO,CAAC,MAAW,EAAE,WAAmB,EAAE,EAAE;QAC1C,MAAM,QAAQ,GAAmB;YAC/B,IAAI,EAAE,QAAQ,IAAI,WAAW;YAC7B,SAAS,EAAE,SAAS;SACrB,CAAC;QACF,IAAA,mCAAY,EAAC,2BAAe,CAAC,GAAG,CAAC,kBAAM,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,CACtD,MAAM,EACN,WAAW,CACZ,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,SAAgB,UAAU,CACxB,WAA+B,SAAS,EACxC,KAA2B;IAE3B,OAAO,CAAC,MAAW,EAAE,WAAmB,EAAE,EAAE;QAC1C,MAAM,QAAQ,GAAgC;YAC5C,IAAI,EAAE,QAAQ,IAAI,WAAW;YAC7B,KAAK,EAAE,KAAK,IAAI,EAAE;SACnB,CAAC;QACF,IAAA,mCAAY,EAAC,2BAAe,CAAC,GAAG,CAAC,kBAAM,CAAC,UAAU,CAAC,EAAE,QAAQ,CAAC,CAC5D,MAAM,EACN,WAAW,CACZ,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC","sourcesContent":["import \"reflect-metadata\";\nimport { UIKeys } from \"./constants\";\nimport { propMetadata } from \"@decaf-ts/decorator-validation\";\nimport {\n  CrudOperationKeys,\n  UIElementMetadata,\n  UIListPropMetadata,\n  UIPropMetadata,\n} from \"./types\";\nimport { RenderingEngine } from \"./Rendering\";\nimport { OperationKeys } from \"@decaf-ts/db-decorators\";\n\n/**\n * @description Decorator that hides a property during specific CRUD operations\n * @summary Controls property visibility based on operation type\n * This decorator allows you to specify which CRUD operations should hide a property\n * in the UI. The property will only be visible during operations not specified.\n *\n * @param operations - The CRUD operations during which the property should be hidden\n * @return {Function} A property decorator function\n *\n * @function hideOn\n * @category Property Decorators\n *\n * @example\n * // Hide the password field during READ operations\n * class User {\n *   @attribute()\n *   username: string;\n *\n *   @attribute()\n *   @hideOn(OperationKeys.READ)\n *   password: string;\n * }\n *\n * @mermaid\n * sequenceDiagram\n *   participant Model\n *   participant hideOn\n *   participant RenderingEngine\n *   participant UI\n *   Model->>hideOn: Apply to property\n *   hideOn->>Model: Add hidden metadata\n *   RenderingEngine->>Model: Check if property should be hidden\n *   Model->>RenderingEngine: Return hidden operations\n *   RenderingEngine->>UI: Render or hide based on current operation\n */\nexport function hideOn(...operations: CrudOperationKeys[]) {\n  return propMetadata<CrudOperationKeys[]>(\n    RenderingEngine.key(UIKeys.HIDDEN),\n    operations\n  );\n}\n\n/**\n * @description Decorator that completely hides a property in all UI operations\n * @summary Makes a property invisible in all CRUD operations\n * This decorator is a convenience wrapper around hideOn that hides a property\n * during all CRUD operations (CREATE, READ, UPDATE, DELETE).\n *\n * @return {Function} A property decorator function\n *\n * @function hidden\n * @category Property Decorators\n *\n * @example\n * // Completely hide the internalId field in the UI\n * class Product {\n *   @attribute()\n *   name: string;\n *\n *   @attribute()\n *   @hidden()\n *   internalId: string;\n * }\n *\n * @mermaid\n * sequenceDiagram\n *   participant Model\n *   participant hidden\n *   participant hideOn\n *   participant RenderingEngine\n *   Model->>hidden: Apply to property\n *   hidden->>hideOn: Call with all operations\n *   hideOn->>Model: Add hidden metadata\n *   RenderingEngine->>Model: Check if property should be hidden\n *   Model->>RenderingEngine: Return all operations\n *   RenderingEngine->>UI: Always hide property\n */\nexport function hidden() {\n  return hideOn(\n    OperationKeys.CREATE,\n    OperationKeys.READ,\n    OperationKeys.UPDATE,\n    OperationKeys.DELETE\n  );\n}\n\n/**\n * @description Decorator that specifies how a property should be rendered as a UI element\n * @summary Maps a model property to a specific UI element with custom properties\n * This decorator allows you to define which HTML element or component should be used\n * to render a specific property, along with any additional properties to pass to that element.\n *\n * @param {string} tag The HTML element or component tag name to use for rendering\n * @param {Record<string, any>} [props] Additional properties to pass to the element\n * @param {boolean} [serialize=false] Whether the property should be serialized\n * @return {Function} A property decorator function\n *\n * @function uielement\n * @category Property Decorators\n *\n * @example\n * // Render a property as a text input\n * class LoginForm {\n *   @attribute()\n *   @uielement('input', { type: 'text', placeholder: 'Enter username' })\n *   username: string;\n *\n *   @attribute()\n *   @uielement('input', { type: 'password', placeholder: 'Enter password' })\n *   password: string;\n *\n *   @attribute()\n *   @uielement('button', { class: 'btn-primary' })\n *   submit: string = 'Login';\n * }\n *\n * @mermaid\n * sequenceDiagram\n *   participant Model\n *   participant uielement\n *   participant RenderingEngine\n *   participant UI\n *   Model->>uielement: Apply to property\n *   uielement->>Model: Add element metadata\n *   RenderingEngine->>Model: Get element metadata\n *   Model->>RenderingEngine: Return tag and props\n *   RenderingEngine->>UI: Render with specified element\n */\nexport function uielement(\n  tag: string,\n  props?: Record<string, any>,\n  serialize: boolean = false\n) {\n  return (original: any, propertyKey?: any) => {\n    const metadata: UIElementMetadata = {\n      tag: tag,\n      serialize: serialize,\n      props: Object.assign({}, props || {}, {\n        name: propertyKey,\n      }),\n    };\n\n    return propMetadata(RenderingEngine.key(UIKeys.ELEMENT), metadata)(\n      original,\n      propertyKey\n    );\n  };\n}\n\n/**\n * @description Decorator that maps a model property to a UI component property\n * @summary Specifies how a property should be passed to a UI component\n * This decorator allows you to define how a model property should be mapped to\n * a property of the UI component when rendering. It requires the class to be\n * decorated with @uimodel.\n *\n * @param {string} [propName] The name of the property to pass to the component (defaults to the property key)\n * @param {boolean} [stringify=false] Whether to stringify the property value\n * @return {Function} A property decorator function\n *\n * @function uiprop\n * @category Property Decorators\n *\n * @example\n * // Map model properties to component properties\n * @uimodel('user-profile')\n * class UserProfile {\n *   @attribute()\n *   @uiprop() // Will be passed as 'fullName' to the component\n *   fullName: string;\n *\n *   @attribute()\n *   @uiprop('userEmail') // Will be passed as 'userEmail' to the component\n *   email: string;\n *\n *   @attribute()\n *   @uiprop('userData', true) // Will be passed as stringified JSON\n *   userData: Record<string, any>;\n * }\n *\n * @mermaid\n * sequenceDiagram\n *   participant Model\n *   participant uiprop\n *   participant RenderingEngine\n *   participant Component\n *   Model->>uiprop: Apply to property\n *   uiprop->>Model: Add prop metadata\n *   RenderingEngine->>Model: Get prop metadata\n *   Model->>RenderingEngine: Return prop name and stringify flag\n *   RenderingEngine->>Component: Pass property with specified name\n */\nexport function uiprop(\n  propName: string | undefined = undefined,\n  stringify: boolean = false\n) {\n  return (target: any, propertyKey: string) => {\n    const metadata: UIPropMetadata = {\n      name: propName || propertyKey,\n      stringify: stringify,\n    };\n    propMetadata(RenderingEngine.key(UIKeys.PROP), metadata)(\n      target,\n      propertyKey\n    );\n  };\n}\n\n/**\n * @description Decorator that maps a model property to a list item component\n * @summary Specifies how a property should be rendered in a list context\n * This decorator allows you to define how a model property containing a list\n * should be rendered. It requires the class to be decorated with @uilistitem.\n *\n * @param {string} [propName] The name of the property to pass to the list component (defaults to the property key)\n * @param {Record<string, any>} [props] Additional properties to pass to the list container\n * @return {Function} A property decorator function\n *\n * @function uilistprop\n * @category Property Decorators\n *\n * @example\n * // Define a list property with custom rendering\n * @uimodel('todo-list')\n * class TodoList {\n *   @attribute()\n *   title: string;\n *\n *   @attribute()\n *   @uilistprop('items', { class: 'todo-items-container' })\n *   items: TodoItem[];\n * }\n *\n * @uilistitem('li', { class: 'todo-item' })\n * class TodoItem extends Model {\n *   @attribute()\n *   text: string;\n *\n *   @attribute()\n *   completed: boolean;\n * }\n *\n * @mermaid\n * sequenceDiagram\n *   participant Model\n *   participant uilistprop\n *   participant RenderingEngine\n *   participant ListContainer\n *   participant ListItems\n *   Model->>uilistprop: Apply to property\n *   uilistprop->>Model: Add list prop metadata\n *   RenderingEngine->>Model: Get list prop metadata\n *   Model->>RenderingEngine: Return prop name and container props\n *   RenderingEngine->>ListContainer: Create container with props\n *   RenderingEngine->>ListItems: Render each item using @uilistitem\n *   ListContainer->>RenderingEngine: Return rendered list\n */\nexport function uilistprop(\n  propName: string | undefined = undefined,\n  props?: Record<string, any>\n) {\n  return (target: any, propertyKey: string) => {\n    const metadata: Partial<UIListPropMetadata> = {\n      name: propName || propertyKey,\n      props: props || {},\n    };\n    propMetadata(RenderingEngine.key(UIKeys.UILISTPROP), metadata)(\n      target,\n      propertyKey\n    );\n  };\n}\n"]}

package/lib/ui/decorators.d.ts

@@ -1,47 +1,211 @@
 import "reflect-metadata";
 import { CrudOperationKeys } from "./types";
 /**
- * @namespace ui-decorators.ui.decorators
- * @memberOf ui-decorators.ui
+ * @description Decorator that hides a property during specific CRUD operations
+ * @summary Controls property visibility based on operation type
+ * This decorator allows you to specify which CRUD operations should hide a property
+ * in the UI. The property will only be visible during operations not specified.
+ *
+ * @param operations - The CRUD operations during which the property should be hidden
+ * @return {Function} A property decorator function
+ *
+ * @function hideOn
+ * @category Property Decorators
+ *
+ * @example
+ * // Hide the password field during READ operations
+ * class User {
+ *   @attribute()
+ *   username: string;
+ *
+ *   @attribute()
+ *   @hideOn(OperationKeys.READ)
+ *   password: string;
+ * }
+ *
+ * @mermaid
+ * sequenceDiagram
+ *   participant Model
+ *   participant hideOn
+ *   participant RenderingEngine
+ *   participant UI
+ *   Model->>hideOn: Apply to property
+ *   hideOn->>Model: Add hidden metadata
+ *   RenderingEngine->>Model: Check if property should be hidden
+ *   Model->>RenderingEngine: Return hidden operations
+ *   RenderingEngine->>UI: Render or hide based on current operation
  */
 export declare function hideOn(...operations: CrudOperationKeys[]): (target: object, propertyKey?: string | symbol | unknown, descriptor?: PropertyDescriptor) => void;
+/**
+ * @description Decorator that completely hides a property in all UI operations
+ * @summary Makes a property invisible in all CRUD operations
+ * This decorator is a convenience wrapper around hideOn that hides a property
+ * during all CRUD operations (CREATE, READ, UPDATE, DELETE).
+ *
+ * @return {Function} A property decorator function
+ *
+ * @function hidden
+ * @category Property Decorators
+ *
+ * @example
+ * // Completely hide the internalId field in the UI
+ * class Product {
+ *   @attribute()
+ *   name: string;
+ *
+ *   @attribute()
+ *   @hidden()
+ *   internalId: string;
+ * }
+ *
+ * @mermaid
+ * sequenceDiagram
+ *   participant Model
+ *   participant hidden
+ *   participant hideOn
+ *   participant RenderingEngine
+ *   Model->>hidden: Apply to property
+ *   hidden->>hideOn: Call with all operations
+ *   hideOn->>Model: Add hidden metadata
+ *   RenderingEngine->>Model: Check if property should be hidden
+ *   Model->>RenderingEngine: Return all operations
+ *   RenderingEngine->>UI: Always hide property
+ */
 export declare function hidden(): (target: object, propertyKey?: string | symbol | unknown, descriptor?: PropertyDescriptor) => void;
 /**
- * Adds the UIElement definition as metadata to the property, allowing it to be read by any {@link RenderStrategy}
+ * @description Decorator that specifies how a property should be rendered as a UI element
+ * @summary Maps a model property to a specific UI element with custom properties
+ * This decorator allows you to define which HTML element or component should be used
+ * to render a specific property, along with any additional properties to pass to that element.
+ *
+ * @param {string} tag The HTML element or component tag name to use for rendering
+ * @param {Record<string, any>} [props] Additional properties to pass to the element
+ * @param {boolean} [serialize=false] Whether the property should be serialized
+ * @return {Function} A property decorator function
+ *
+ * @function uielement
+ * @category Property Decorators
+ *
+ * @example
+ * // Render a property as a text input
+ * class LoginForm {
+ *   @attribute()
+ *   @uielement('input', { type: 'text', placeholder: 'Enter username' })
+ *   username: string;
  *
- * @param {string} tag The component/HTML element tag name
- * @param {{}} [props] The properties to pass to that component/HTML Element
- * @param serialize
+ *   @attribute()
+ *   @uielement('input', { type: 'password', placeholder: 'Enter password' })
+ *   password: string;
  *
- * @decorator uielement
+ *   @attribute()
+ *   @uielement('button', { class: 'btn-primary' })
+ *   submit: string = 'Login';
+ * }
  *
- * @category Decorators
- * @subcategory ui-decorators
+ * @mermaid
+ * sequenceDiagram
+ *   participant Model
+ *   participant uielement
+ *   participant RenderingEngine
+ *   participant UI
+ *   Model->>uielement: Apply to property
+ *   uielement->>Model: Add element metadata
+ *   RenderingEngine->>Model: Get element metadata
+ *   Model->>RenderingEngine: Return tag and props
+ *   RenderingEngine->>UI: Render with specified element
  */
 export declare function uielement(tag: string, props?: Record<string, any>, serialize?: boolean): (original: any, propertyKey?: any) => void;
 /**
- * Adds the UIProp definition as metadata to the property, allowing it to be read by any {@link RenderStrategy}
+ * @description Decorator that maps a model property to a UI component property
+ * @summary Specifies how a property should be passed to a UI component
+ * This decorator allows you to define how a model property should be mapped to
+ * a property of the UI component when rendering. It requires the class to be
+ * decorated with @uimodel.
  *
- * this requires a '@uimodel' with a defined tag
+ * @param {string} [propName] The name of the property to pass to the component (defaults to the property key)
+ * @param {boolean} [stringify=false] Whether to stringify the property value
+ * @return {Function} A property decorator function
  *
- * @param {string} [propName] the property name that will be passed to the component. defaults to the PropertyKey
+ * @function uiprop
+ * @category Property Decorators
  *
- * @decorator uiprop
+ * @example
+ * // Map model properties to component properties
+ * @uimodel('user-profile')
+ * class UserProfile {
+ *   @attribute()
+ *   @uiprop() // Will be passed as 'fullName' to the component
+ *   fullName: string;
  *
- * @category Decorators
- * @subcategory ui-decorators
+ *   @attribute()
+ *   @uiprop('userEmail') // Will be passed as 'userEmail' to the component
+ *   email: string;
+ *
+ *   @attribute()
+ *   @uiprop('userData', true) // Will be passed as stringified JSON
+ *   userData: Record<string, any>;
+ * }
+ *
+ * @mermaid
+ * sequenceDiagram
+ *   participant Model
+ *   participant uiprop
+ *   participant RenderingEngine
+ *   participant Component
+ *   Model->>uiprop: Apply to property
+ *   uiprop->>Model: Add prop metadata
+ *   RenderingEngine->>Model: Get prop metadata
+ *   Model->>RenderingEngine: Return prop name and stringify flag
+ *   RenderingEngine->>Component: Pass property with specified name
  */
 export declare function uiprop(propName?: string | undefined, stringify?: boolean): (target: any, propertyKey: string) => void;
 /**
- * Adds the UIListProp definition as metadata to the property, allowing it to be read by any {@link RenderStrategy}
+ * @description Decorator that maps a model property to a list item component
+ * @summary Specifies how a property should be rendered in a list context
+ * This decorator allows you to define how a model property containing a list
+ * should be rendered. It requires the class to be decorated with @uilistitem.
+ *
+ * @param {string} [propName] The name of the property to pass to the list component (defaults to the property key)
+ * @param {Record<string, any>} [props] Additional properties to pass to the list container
+ * @return {Function} A property decorator function
+ *
+ * @function uilistprop
+ * @category Property Decorators
+ *
+ * @example
+ * // Define a list property with custom rendering
+ * @uimodel('todo-list')
+ * class TodoList {
+ *   @attribute()
+ *   title: string;
  *
- * this requires a '@uilistitem' with a defined tag
+ *   @attribute()
+ *   @uilistprop('items', { class: 'todo-items-container' })
+ *   items: TodoItem[];
+ * }
  *
- * @param {string} [propName] the property name that will be passed to the component. defaults to the PropertyKey
+ * @uilistitem('li', { class: 'todo-item' })
+ * class TodoItem extends Model {
+ *   @attribute()
+ *   text: string;
  *
- * @decorator uiprop
+ *   @attribute()
+ *   completed: boolean;
+ * }
  *
- * @category Decorators
- * @subcategory ui-decorators
+ * @mermaid
+ * sequenceDiagram
+ *   participant Model
+ *   participant uilistprop
+ *   participant RenderingEngine
+ *   participant ListContainer
+ *   participant ListItems
+ *   Model->>uilistprop: Apply to property
+ *   uilistprop->>Model: Add list prop metadata
+ *   RenderingEngine->>Model: Get list prop metadata
+ *   Model->>RenderingEngine: Return prop name and container props
+ *   RenderingEngine->>ListContainer: Create container with props
+ *   RenderingEngine->>ListItems: Render each item using @uilistitem
+ *   ListContainer->>RenderingEngine: Return rendered list
  */
 export declare function uilistprop(propName?: string | undefined, props?: Record<string, any>): (target: any, propertyKey: string) => void;

package/lib/ui/errors.cjs

@@ -2,10 +2,38 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RenderingError = void 0;
 const db_decorators_1 = require("@decaf-ts/db-decorators");
+/**
+ * @description Error thrown when a rendering operation fails
+ * @summary Specialized error for rendering failures in UI components
+ * This error is thrown when the rendering engine encounters an error while
+ * attempting to render a UI component or model.
+ *
+ * @param {string|Error} msg The error message or original error
+ *
+ * @class RenderingError
+ * @extends BaseError
+ * @category Errors
+ *
+ * @example
+ * // Throwing a rendering error
+ * try {
+ *   // Rendering code that might fail
+ *   if (!component.canRender()) {
+ *     throw new RenderingError('Component cannot be rendered');
+ *   }
+ * } catch (error) {
+ *   console.error('Rendering failed:', error.message);
+ * }
+ */
 class RenderingError extends db_decorators_1.BaseError {
+    /**
+     * @description Creates a new RenderingError instance
+     * @summary Initializes the error with a message or original error
+     * @param {string|Error} msg The error message or original error
+     */
     constructor(msg) {
         super(RenderingError.name, msg);
     }
 }
 exports.RenderingError = RenderingError;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZXJyb3JzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL3VpL2Vycm9ycy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQSwyREFBb0Q7QUFFcEQsTUFBYSxjQUFlLFNBQVEseUJBQVM7SUFDM0MsWUFBWSxHQUFtQjtRQUM3QixLQUFLLENBQUMsY0FBYyxDQUFDLElBQUksRUFBRSxHQUFHLENBQUMsQ0FBQztJQUNsQyxDQUFDO0NBQ0Y7QUFKRCx3Q0FJQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IEJhc2VFcnJvciB9IGZyb20gXCJAZGVjYWYtdHMvZGItZGVjb3JhdG9yc1wiO1xuXG5leHBvcnQgY2xhc3MgUmVuZGVyaW5nRXJyb3IgZXh0ZW5kcyBCYXNlRXJyb3Ige1xuICBjb25zdHJ1Y3Rvcihtc2c6IHN0cmluZyB8IEVycm9yKSB7XG4gICAgc3VwZXIoUmVuZGVyaW5nRXJyb3IubmFtZSwgbXNnKTtcbiAgfVxufVxuIl19
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZXJyb3JzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL3VpL2Vycm9ycy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQSwyREFBb0Q7QUFFcEQ7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7R0FzQkc7QUFDSCxNQUFhLGNBQWUsU0FBUSx5QkFBUztJQUMzQzs7OztPQUlHO0lBQ0gsWUFBWSxHQUFtQjtRQUM3QixLQUFLLENBQUMsY0FBYyxDQUFDLElBQUksRUFBRSxHQUFHLENBQUMsQ0FBQztJQUNsQyxDQUFDO0NBQ0Y7QUFURCx3Q0FTQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IEJhc2VFcnJvciB9IGZyb20gXCJAZGVjYWYtdHMvZGItZGVjb3JhdG9yc1wiO1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBFcnJvciB0aHJvd24gd2hlbiBhIHJlbmRlcmluZyBvcGVyYXRpb24gZmFpbHNcbiAqIEBzdW1tYXJ5IFNwZWNpYWxpemVkIGVycm9yIGZvciByZW5kZXJpbmcgZmFpbHVyZXMgaW4gVUkgY29tcG9uZW50c1xuICogVGhpcyBlcnJvciBpcyB0aHJvd24gd2hlbiB0aGUgcmVuZGVyaW5nIGVuZ2luZSBlbmNvdW50ZXJzIGFuIGVycm9yIHdoaWxlXG4gKiBhdHRlbXB0aW5nIHRvIHJlbmRlciBhIFVJIGNvbXBvbmVudCBvciBtb2RlbC5cbiAqXG4gKiBAcGFyYW0ge3N0cmluZ3xFcnJvcn0gbXNnIFRoZSBlcnJvciBtZXNzYWdlIG9yIG9yaWdpbmFsIGVycm9yXG4gKlxuICogQGNsYXNzIFJlbmRlcmluZ0Vycm9yXG4gKiBAZXh0ZW5kcyBCYXNlRXJyb3JcbiAqIEBjYXRlZ29yeSBFcnJvcnNcbiAqXG4gKiBAZXhhbXBsZVxuICogLy8gVGhyb3dpbmcgYSByZW5kZXJpbmcgZXJyb3JcbiAqIHRyeSB7XG4gKiAgIC8vIFJlbmRlcmluZyBjb2RlIHRoYXQgbWlnaHQgZmFpbFxuICogICBpZiAoIWNvbXBvbmVudC5jYW5SZW5kZXIoKSkge1xuICogICAgIHRocm93IG5ldyBSZW5kZXJpbmdFcnJvcignQ29tcG9uZW50IGNhbm5vdCBiZSByZW5kZXJlZCcpO1xuICogICB9XG4gKiB9IGNhdGNoIChlcnJvcikge1xuICogICBjb25zb2xlLmVycm9yKCdSZW5kZXJpbmcgZmFpbGVkOicsIGVycm9yLm1lc3NhZ2UpO1xuICogfVxuICovXG5leHBvcnQgY2xhc3MgUmVuZGVyaW5nRXJyb3IgZXh0ZW5kcyBCYXNlRXJyb3Ige1xuICAvKipcbiAgICogQGRlc2NyaXB0aW9uIENyZWF0ZXMgYSBuZXcgUmVuZGVyaW5nRXJyb3IgaW5zdGFuY2VcbiAgICogQHN1bW1hcnkgSW5pdGlhbGl6ZXMgdGhlIGVycm9yIHdpdGggYSBtZXNzYWdlIG9yIG9yaWdpbmFsIGVycm9yXG4gICAqIEBwYXJhbSB7c3RyaW5nfEVycm9yfSBtc2cgVGhlIGVycm9yIG1lc3NhZ2Ugb3Igb3JpZ2luYWwgZXJyb3JcbiAgICovXG4gIGNvbnN0cnVjdG9yKG1zZzogc3RyaW5nIHwgRXJyb3IpIHtcbiAgICBzdXBlcihSZW5kZXJpbmdFcnJvci5uYW1lLCBtc2cpO1xuICB9XG59XG4iXX0=

package/lib/ui/errors.d.ts

@@ -1,4 +1,32 @@
 import { BaseError } from "@decaf-ts/db-decorators";
+/**
+ * @description Error thrown when a rendering operation fails
+ * @summary Specialized error for rendering failures in UI components
+ * This error is thrown when the rendering engine encounters an error while
+ * attempting to render a UI component or model.
+ *
+ * @param {string|Error} msg The error message or original error
+ *
+ * @class RenderingError
+ * @extends BaseError
+ * @category Errors
+ *
+ * @example
+ * // Throwing a rendering error
+ * try {
+ *   // Rendering code that might fail
+ *   if (!component.canRender()) {
+ *     throw new RenderingError('Component cannot be rendered');
+ *   }
+ * } catch (error) {
+ *   console.error('Rendering failed:', error.message);
+ * }
+ */
 export declare class RenderingError extends BaseError {
+    /**
+     * @description Creates a new RenderingError instance
+     * @summary Initializes the error with a message or original error
+     * @param {string|Error} msg The error message or original error
+     */
     constructor(msg: string | Error);
 }

package/lib/ui/index.cjs

@@ -1,8 +1,4 @@
 "use strict";
-/**
- * @namespace ui-decorators.ui
- * @memberOf ui-decorators
- */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -25,4 +21,4 @@ __exportStar(require("./interfaces.cjs"), exports);
 __exportStar(require("./Rendering.cjs"), exports);
 __exportStar(require("./types.cjs"), exports);
 __exportStar(require("./utils.cjs"), exports);
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvdWkvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBOzs7R0FHRzs7Ozs7Ozs7Ozs7Ozs7OztBQUVILGtEQUE0QjtBQUM1QixtREFBNkI7QUFDN0IsK0NBQXlCO0FBQ3pCLG1EQUE2QjtBQUM3QixrREFBNEI7QUFDNUIsOENBQXdCO0FBQ3hCLDhDQUF3QiIsInNvdXJjZXNDb250ZW50IjpbIi8qKlxuICogQG5hbWVzcGFjZSB1aS1kZWNvcmF0b3JzLnVpXG4gKiBAbWVtYmVyT2YgdWktZGVjb3JhdG9yc1xuICovXG5cbmV4cG9ydCAqIGZyb20gXCIuL2NvbnN0YW50c1wiO1xuZXhwb3J0ICogZnJvbSBcIi4vZGVjb3JhdG9yc1wiO1xuZXhwb3J0ICogZnJvbSBcIi4vZXJyb3JzXCI7XG5leHBvcnQgKiBmcm9tIFwiLi9pbnRlcmZhY2VzXCI7XG5leHBvcnQgKiBmcm9tIFwiLi9SZW5kZXJpbmdcIjtcbmV4cG9ydCAqIGZyb20gXCIuL3R5cGVzXCI7XG5leHBvcnQgKiBmcm9tIFwiLi91dGlsc1wiO1xuIl19
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvdWkvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLGtEQUE0QjtBQUM1QixtREFBNkI7QUFDN0IsK0NBQXlCO0FBQ3pCLG1EQUE2QjtBQUM3QixrREFBNEI7QUFDNUIsOENBQXdCO0FBQ3hCLDhDQUF3QiIsInNvdXJjZXNDb250ZW50IjpbImV4cG9ydCAqIGZyb20gXCIuL2NvbnN0YW50c1wiO1xuZXhwb3J0ICogZnJvbSBcIi4vZGVjb3JhdG9yc1wiO1xuZXhwb3J0ICogZnJvbSBcIi4vZXJyb3JzXCI7XG5leHBvcnQgKiBmcm9tIFwiLi9pbnRlcmZhY2VzXCI7XG5leHBvcnQgKiBmcm9tIFwiLi9SZW5kZXJpbmdcIjtcbmV4cG9ydCAqIGZyb20gXCIuL3R5cGVzXCI7XG5leHBvcnQgKiBmcm9tIFwiLi91dGlsc1wiO1xuIl19

package/lib/ui/index.d.ts

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

package/lib/ui/interfaces.cjs

@@ -1,3 +1,11 @@
 "use strict";
+/**
+ * @description Interfaces for UI form components
+ * @summary Defines interfaces for form fields with CRUD operations
+ * This module contains interfaces that extend basic field properties with
+ * CRUD operation information for form generation.
+ * @module ui/interfaces
+ * @memberOf module:ui-decorators
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW50ZXJmYWNlcy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy91aS9pbnRlcmZhY2VzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiIiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBGaWVsZFByb3BlcnRpZXMgfSBmcm9tIFwiLi90eXBlc1wiO1xuaW1wb3J0IHsgQ3J1ZE9wZXJhdGlvbnMgfSBmcm9tIFwiQGRlY2FmLXRzL2RiLWRlY29yYXRvcnNcIjtcblxuZXhwb3J0IGludGVyZmFjZSBDcnVkRm9ybUZpZWxkIGV4dGVuZHMgRmllbGRQcm9wZXJ0aWVzIHtcbiAgb3BlcmF0aW9uOiBDcnVkT3BlcmF0aW9ucztcbn1cbiJdfQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW50ZXJmYWNlcy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy91aS9pbnRlcmZhY2VzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQTs7Ozs7OztHQU9HIiwic291cmNlc0NvbnRlbnQiOlsiLyoqXG4gKiBAZGVzY3JpcHRpb24gSW50ZXJmYWNlcyBmb3IgVUkgZm9ybSBjb21wb25lbnRzXG4gKiBAc3VtbWFyeSBEZWZpbmVzIGludGVyZmFjZXMgZm9yIGZvcm0gZmllbGRzIHdpdGggQ1JVRCBvcGVyYXRpb25zXG4gKiBUaGlzIG1vZHVsZSBjb250YWlucyBpbnRlcmZhY2VzIHRoYXQgZXh0ZW5kIGJhc2ljIGZpZWxkIHByb3BlcnRpZXMgd2l0aFxuICogQ1JVRCBvcGVyYXRpb24gaW5mb3JtYXRpb24gZm9yIGZvcm0gZ2VuZXJhdGlvbi5cbiAqIEBtb2R1bGUgdWkvaW50ZXJmYWNlc1xuICogQG1lbWJlck9mIG1vZHVsZTp1aS1kZWNvcmF0b3JzXG4gKi9cblxuaW1wb3J0IHsgRmllbGRQcm9wZXJ0aWVzIH0gZnJvbSBcIi4vdHlwZXNcIjtcbmltcG9ydCB7IENydWRPcGVyYXRpb25zIH0gZnJvbSBcIkBkZWNhZi10cy9kYi1kZWNvcmF0b3JzXCI7XG5cbi8qKlxuICogQGRlc2NyaXB0aW9uIEZvcm0gZmllbGQgaW50ZXJmYWNlIHdpdGggQ1JVRCBvcGVyYXRpb24gaW5mb3JtYXRpb25cbiAqIEBzdW1tYXJ5IEV4dGVuZHMgYmFzaWMgZmllbGQgcHJvcGVydGllcyB3aXRoIGEgc3BlY2lmaWMgQ1JVRCBvcGVyYXRpb25cbiAqIFRoaXMgaW50ZXJmYWNlIHJlcHJlc2VudHMgYSBmb3JtIGZpZWxkIHRoYXQgaXMgYXNzb2NpYXRlZCB3aXRoIGEgc3BlY2lmaWNcbiAqIENSVUQgb3BlcmF0aW9uIChDcmVhdGUsIFJlYWQsIFVwZGF0ZSwgRGVsZXRlKS4gSXQgY29tYmluZXMgYWxsIHRoZSBzdGFuZGFyZFxuICogZmllbGQgcHJvcGVydGllcyB3aXRoIGFuIG9wZXJhdGlvbiBwcm9wZXJ0eS5cbiAqXG4gKiBAaW50ZXJmYWNlIENydWRGb3JtRmllbGRcbiAqIEBleHRlbmRzIEZpZWxkUHJvcGVydGllc1xuICogQG1lbWJlck9mIG1vZHVsZTp1aS1kZWNvcmF0b3JzXG4gKlxuICogQHByb3BlcnR5IHtDcnVkT3BlcmF0aW9uc30gb3BlcmF0aW9uIC0gVGhlIENSVUQgb3BlcmF0aW9uIGFzc29jaWF0ZWQgd2l0aCB0aGlzIGZpZWxkXG4gKi9cbmV4cG9ydCBpbnRlcmZhY2UgQ3J1ZEZvcm1GaWVsZCBleHRlbmRzIEZpZWxkUHJvcGVydGllcyB7XG4gIC8qKlxuICAgKiBAZGVzY3JpcHRpb24gVGhlIENSVUQgb3BlcmF0aW9uIGFzc29jaWF0ZWQgd2l0aCB0aGlzIGZpZWxkXG4gICAqIEBzdW1tYXJ5IFNwZWNpZmllcyB3aGljaCBvcGVyYXRpb24gKENyZWF0ZSwgUmVhZCwgVXBkYXRlLCBEZWxldGUpIHRoaXMgZmllbGQgaXMgZm9yXG4gICAqL1xuICBvcGVyYXRpb246IENydWRPcGVyYXRpb25zO1xufVxuIl19