@decaf-ts/ui-decorators 0.6.20 → 0.7.1

package/lib/ui/types.d.ts

@@ -1,186 +0,0 @@
-/**
- * @description Type definitions for UI components and rendering
- * @summary Defines types and interfaces used throughout the UI decorators library
- * This module contains type definitions for field properties, UI metadata,
- * and other structures used in rendering UI components.
- * @module ui/types
- * @memberOf module:ui-decorators
- */
-import { OperationKeys } from "@decaf-ts/db-decorators";
-import { ElementSizes, UIKeys, UIMediaBreakPoints } from "./constants";
-import { DecafEventHandler } from "./DecafEventHandler";
-/**
- * @description Interface for defining a UI field or component
- * @summary Represents a renderable UI element with properties and children
- * This interface defines the structure of a UI field or component, including
- * its tag name, properties, and optional children elements.
- *
- * @interface FieldDefinition
- * @template T Additional properties type (defaults to void)
- * @memberOf module:ui-decorators
- *
- * @property {string} tag - The HTML element or component tag name
- * @property {string} [rendererId] - Optional ID of the renderer to use
- * @property props - Combined properties for the field
- * @property {FieldDefinition[]} [children] - Optional child elements
- * @property {UIListItemElementMetadata} [item] - Optional list item metadata
- */
-export interface FieldDefinition<T = void> {
-    tag: string;
-    rendererId?: string;
-    props: T & FieldProperties;
-    children?: FieldDefinition<T>[];
-    item?: UIListItemElementMetadata;
-    col?: number | string[];
-    row?: number | string[];
-}
-/**
- * @description Interface for field properties including validation
- * @summary Defines common properties and validation rules for UI fields
- * This interface defines the standard properties that can be applied to
- * UI fields, including basic attributes and validation rules.
- *
- * @interface FieldProperties
- * @memberOf module:ui-decorators
- *
- * @property {string} name - The name of the field
- * @property {string} path - The full hierarchical path of the field
- * @property {string} childOf - The parent path of the immediate parent field, if nested
- * @property {string} type - The type of the field (e.g., 'text', 'number')
- * @property {string|number|Date} value - The current value of the field
- * @property {boolean} [hidden] - Whether the field is hidden
- * @property {boolean} [disabled] - Whether the field is disabled
- * @property {boolean} [required] - Whether the field is required
- * @property {boolean} [readonly] - Whether the field is read-only
- * @property {number} [maxLength] - Maximum length for text fields
- * @property {number} [minLength] - Minimum length for text fields
- * @property {number|Date} [max] - Maximum value for numeric or date fields
- * @property {number|Date} [min] - Minimum value for numeric or date fields
- * @property {string} [pattern] - Regex pattern for validation
- * @property {number} [step] - Step value for numeric fields
- * @property {string} [format] - Format string for date fields
- * @property {string} [equals] - Field must equal the value of this field
- * @property {string} [diff] - Field must differ from the value of this field
- * @property {string} [lessThan] - Field must be less than this field
- * @property {string} [lessThanOrEqual] - Field must be less than or equal to this field
- * @property {string} [greaterThan] - Field must be greater than this field
- * @property {string} [greaterThanOrEqual] - Field must be greater than or equal to this field
- */
-export interface FieldProperties {
-    name: string;
-    path: string;
-    childOf?: string;
-    type: string;
-    value: string | number | Date | string[] | number[] | Date[];
-    hidden?: boolean | CrudOperationKeys[];
-    disabled?: boolean;
-    required?: boolean;
-    readonly?: boolean;
-    maxLength?: number;
-    minLength?: number;
-    max?: number | Date;
-    min?: number | Date;
-    pattern?: string;
-    step?: number;
-    format?: string;
-    pk?: string;
-    subType?: string;
-    multiple?: boolean;
-    customTypes?: string | string[];
-    validationMessage?: string | string[];
-    options?: Record<string, unknown>[];
-    row?: number;
-    col?: number;
-    page?: number;
-    [UIKeys.EQUALS]?: string;
-    [UIKeys.DIFF]?: string;
-    [UIKeys.LESS_THAN]?: string;
-    [UIKeys.LESS_THAN_OR_EQUAL]?: string;
-    [UIKeys.GREATER_THAN]?: string;
-    [UIKeys.GREATER_THAN_OR_EQUAL]?: string;
-}
-/**
- * @typedef UIElementMetadata
- * @memberOf module:ui-decorators
- */
-export type UIElementMetadata = {
-    tag: string;
-    props?: Record<string, any>;
-    serialize?: boolean;
-};
-/**
- * @typedef UIElementMetadata
- * @memberOf module:ui-decorators
- */
-export type UIModelMetadata = Omit<UIElementMetadata, "serialize">;
-/**
- * @typedef UIPropMetadata
- * @memberOf module:ui-decorators
- */
-export type UIPropMetadata = {
-    name: string;
-    stringify: boolean;
-};
-/**
- * @typedef CrudOperationKeys
- * @memberOf module:ui-decorators
- */
-export type CrudOperationKeys = OperationKeys.CREATE | OperationKeys.READ | OperationKeys.UPDATE | OperationKeys.DELETE;
-/**
- * @typedef UIListPropMetadata
- * @memberOf module:ui-decorators
- */
-export type UIListPropMetadata = {
-    name: string;
-    props: Record<string, any>;
-};
-/**
- * @typedef UIListModelMetadata
- * @memberOf module:ui-decorators
- */
-export type UIListModelMetadata = {
-    item: UIListItemElementMetadata;
-};
-/**
- * @typedef UIListItemElementMetadata
- * @memberOf module:ui-decorators
- */
-export type UIListItemElementMetadata = {
-    tag: string;
-    props?: Record<string, any>;
-    mapper?: Record<string, string>;
-};
-/**
- * @typedef UILayoutMetadata
- * @memberOf module:ui-decorators
- */
-export type UILayoutMetadata = {
-    cols?: number;
-    rows?: number | string[];
-    props?: Record<string, any>;
-};
-/**
- * @typedef UIClassMetadata
- * @memberOf module:ui-decorators
- */
-export type UIClassMetadata = UILayoutMetadata | UIModelMetadata | UIHandlerMetadata | UIListModelMetadata;
-export type UILayoutCol = number | typeof ElementSizes.half | typeof ElementSizes.full | typeof ElementSizes.auto | typeof ElementSizes.expand;
-export type UIListItemPosition = "title" | "description" | "info" | "subinfo";
-export type UIFunctionLike = (...args: any[]) => any | Promise<any>;
-export type UIEventName = keyof Pick<DecafEventHandler, "render" | "initialize" | "handleClick" | "refresh">;
-export type UIEventProperty = Record<string, UIFunctionLike>;
-export type UIHandlerMetadata = {
-    handlers?: UIEventProperty;
-};
-/**
- * @typedef UILayoutPropMetadata
- * @memberOf module:ui-decorators
- */
-export type UILayoutPropMetadata = {
-    name: string;
-    props: Record<string, any> & {
-        col: UILayoutCol;
-        row: number | string[];
-    };
-};
-export type UIMediaBreakPointsType = UIMediaBreakPoints.SMALL | UIMediaBreakPoints.MEDIUM | UIMediaBreakPoints.LARGE | UIMediaBreakPoints.XLARGE;

package/lib/ui/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/ui/types.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;;AAGH,+CAAuE"}

package/lib/ui/utils.d.ts

@@ -1,27 +0,0 @@
-import { Model } from "@decaf-ts/decorator-validation";
-import { FieldProperties, UIFunctionLike } from "./types";
-import { Constructor } from "@decaf-ts/decoration";
-/**
- *
- * Type guard that verifies if a provided UI function-like value is a class constructor.
- */
-export declare const isClassConstructor: <C>(fn: UIFunctionLike | Constructor<C>) => fn is Constructor<C>;
-/**
- * Derives the metadata key for a UI attribute on a decorated property.
- *
- * @param prop - Property name decorated on the UI model.
- * @param key - Attribute identifier stored under the property metadata.
- * @returns Fully qualified metadata key scoped to `UIKeys.REFLECT`.
- */
-export declare function getUIAttributeKey(prop: string, key: string): string;
-/**
- * @function formatByType
- *
- * @memberOf module:ui-decorators
- */
-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;
-export declare function revertHtml(value: string): string;
-export declare function generateUIModelID<M extends Model>(model: M): string;

package/lib/ui/utils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/ui/utils.ts"],"names":[],"mappings":";;;AA4BA,8CAEC;AAOD,oCAWC;AAED,4CAuDC;AAED,sCAOC;AAED,gCAWC;AAED,gCAUC;AAED,8CAcC;AA3JD,yEAKwC;AACxC,+CAAuE;AACvE,2DAAwD;AAExD,qDAA6E;AAE7E;;;GAGG;AACI,MAAM,kBAAkB,GAAG,CAChC,EAAmC,EACb,EAAE;IACxB,OAAO,OAAO,EAAE,KAAK,UAAU,IAAI,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;AACjE,CAAC,CAAC;AAJW,QAAA,kBAAkB,sBAI7B;AAEF;;;;;;GAMG;AACH,SAAgB,iBAAiB,CAAC,IAAY,EAAE,GAAW;IACzD,OAAO,qBAAQ,CAAC,GAAG,CAAC,kBAAM,CAAC,OAAO,EAAE,2BAAc,CAAC,UAAU,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;AAC5E,CAAC;AAED;;;;GAIG;AACH,SAAgB,YAAY,CAC1B,IAAS,EACT,KAAU,EACV,GAAG,IAAe;IAElB,IAAI,IAAI,KAAK,kBAAM,CAAC,IAAI,EAAE,CAAC;QACzB,IAAI,CAAC,KAAK;YAAE,OAAO,EAAE,CAAC;QACtB,MAAM,MAAM,GAAY,IAAI,CAAC,KAAK,EAAa,IAAI,2BAAe,CAAC;QACnE,OAAO,IAAA,iCAAU,EAAC,IAAI,IAAI,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,CAAC;IAC7C,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAgB,gBAAgB,CAC9B,IAAY,EACZ,KAAsB,EACtB,UAA2B;IAE3B,IAAI,MAAM,GAAuC,SAAS,CAAC;IAC3D,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;YAChB,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;gBACjC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CACd,gBAAgB,CACd,qCAAc,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,EACxC,CAAC,EACD,UAAU,CACX,CACF;gBACH,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;YACZ,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC1B,MAAM;QACR,CAAC;QACD,KAAK,2BAAe,CAAC,MAAM;YACzB,MAAM,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;YAC9B,MAAM;QACR,KAAK,2BAAe,CAAC,IAAI,CAAC,CAAC,CAAC;YAC1B,MAAM,MAAM,GAAuB,UAAU,CAAC,MAAM,CAAC;YACrD,IAAI,KAAK,IAAI,GAAG,KAAK,EAAE,CAAC,IAAI,EAAE,CAAC,MAAM,EAAE,CAAC;gBACtC,MAAM;oBACJ,OAAO,KAAK,KAAK,qCAAc,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE;wBACvD,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC;wBACjB,CAAC,CAAC,KAAK;4BACL,CAAC,CAAC,MAAM;gCACN,CAAC,CAAC,IAAA,gCAAS,EAAC,MAAM,EAAE,KAAK,CAAC;gCAC1B,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC;4BACnB,CAAC,CAAC,SAAS,CAAC;YACpB,CAAC;YACD,MAAM;QACR,CAAC;QACD;YACE,MAAM;gBACJ,OAAO,KAAK,KAAK,qCAAc,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE;oBACvD,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;wBACpB,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC;wBACjB,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;oBACzB,CAAC,CAAC,OAAO,KAAK,KAAK,qCAAc,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE;wBAC1D,CAAC,CAAC,KAAK;wBACP,CAAC,CAAC,OAAO,KAAK,KAAK,qCAAc,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE;4BACzD,CAAC,CAAC,UAAU,CAAC,KAAe,CAAC;4BAC7B,CAAC,CAAC,MAAM,CAAC;IACrB,CAAC;IACD,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE,CAAC;QAClC,MAAM,IAAI,6BAAa,CACrB,iCAAiC,IAAI,SAAS,OAAO,KAAK,MAAM,KAAK,EAAE,CACxE,CAAC;IACJ,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAgB,aAAa,CAAC,KAAsB;IAClD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAE7D,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IAC7B,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;QAAE,OAAO,MAAM,CAAC;IAElC,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAgB,UAAU,CAAC,KAAa;IACtC,IAAI,CAAC,KAAK;QAAE,OAAO,KAAK,CAAC;IAEzB,MAAM,aAAa,GAA2B;QAC5C,GAAG,EAAE,OAAO;QACZ,GAAG,EAAE,MAAM;QACX,GAAG,EAAE,MAAM;KACZ,CAAC;IACF,OAAO,GAAG,KAAK,EAAE,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,EAAE;QAC1C,OAAO,aAAa,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC;IACnC,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAgB,UAAU,CAAC,KAAa;IACtC,MAAM,aAAa,GAA2B;QAC5C,OAAO,EAAE,GAAG;QACZ,MAAM,EAAE,GAAG;QACX,MAAM,EAAE,GAAG;KACZ,CAAC;IAEF,OAAO,GAAG,KAAK,EAAE,CAAC,OAAO,CAAC,kBAAkB,EAAE,CAAC,GAAG,EAAE,EAAE;QACpD,OAAO,aAAa,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC;IACnC,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAgB,iBAAiB,CAAkB,KAAQ;IACzD,IAAI,EAAE,GAA6B,IAAI,CAAC,GAAG,EAAE,CAAC;IAC9C,IAAI,CAAC;QACH,MAAM,EAAE,GAAG,4BAAK,CAAC,EAAE,CAAC,KAAK,CAAC,WAA6B,CAAC,CAAC;QACzD,IAAI,EAAE;YACJ,EAAE,GAAG,KAAK,CACR,4BAAK,CAAC,EAAE,CAAC,KAAK,CAAC,WAA6B,CAAuB,CACjD,CAAC;QACvB,6DAA6D;IAC/D,CAAC;IAAC,OAAO,CAAU,EAAE,CAAC;QACpB,cAAc;IAChB,CAAC;IACD,MAAM,IAAI,GAAG,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,OAAO,GAAG,IAAI,IAAI,EAAE,EAAE,CAAC;AACzB,CAAC"}

package/lib/ui/validator.d.ts

@@ -1,9 +0,0 @@
-import { DecafTranslateService } from "./DecafTranslateService";
-declare module "@decaf-ts/decorator-validation" {
-    interface BaseValidator {
-        translateService: DecafTranslateService;
-    }
-    namespace BaseValidator {
-        let translateService: DecafTranslateService;
-    }
-}