@decaf-ts/for-angular 0.0.25 → 0.0.26

package/engine/interfaces.d.ts

@@ -1,271 +0,0 @@
-import { FormArray, FormControl, FormGroup } from '@angular/forms';
-import { ElementRef, EnvironmentInjector, Injector, Type } from '@angular/core';
-import { OrderDirection } from '@decaf-ts/core';
-import { AngularFieldDefinition, FieldUpdateMode, KeyValue, StringOrBoolean } from './types';
-import { FieldProperties } from '@decaf-ts/ui-decorators';
-/**
- * @description Interface for components that hold an ElementRef
- * @summary Defines a component holder interface that provides access to the underlying DOM element through ElementRef
- * @interface IComponentHolder
- * @memberOf module:engine
- */
-export interface IComponentHolder {
-    /**
-     * @description Reference to the component's DOM element
-     * @property {ElementRef} component - The ElementRef instance providing access to the native DOM element
-     */
-    component: ElementRef;
-}
-/**
- * @description Interface for form components that hold both an ElementRef and a FormGroup
- * @summary Extends IComponentHolder to include a FormGroup for form handling capabilities
- * @interface IFormElement
- * @memberOf module:engine
- */
-export interface IFormElement extends IComponentHolder {
-    /**
-     * @description The Angular FormGroup associated with this form element
-     * @property {FormGroup|undefined} formGroup - The form group instance for managing form controls and validation
-     */
-    formGroup: FormGroup | undefined;
-}
-/**
- * @description Interface for fieldset item representation in the UI.
- * @summary Defines the structure for items displayed in the reorderable list within the fieldset.
- * Each item represents a value added to the fieldset with display properties for the UI.
- * @memberOf module:engine
- */
-export interface IFieldSetItem {
-    /** @description Sequential index number for ordering items in the list */
-    index: number;
-    /** @description Primary display text for the item */
-    title: string;
-    /** @description Optional secondary text providing additional item details */
-    description?: string;
-}
-/**
- * @description Interface for fieldset validation event data.
- * @summary Defines the structure of validation events emitted when form validation occurs.
- * Used for communication between form components and the fieldset container.
- * @memberOf module:engine
- */
-export interface IFieldSetValidationEvent {
-    /** @description The FormGroup containing the validated form controls */
-    formGroup: FormArray | FormGroup;
-    /** @description The current form value being validated */
-    value: unknown;
-    /** @description Whether the form validation passed or failed */
-    isValid: boolean;
-}
-/**
- * @description Interface for individual filter query items
- * @summary Defines the structure of a single filter criterion in a filter query.
- * Each item represents one condition to be applied to the data, consisting of
- * an index (field name), a condition (comparison operator), and a value to compare against.
- * @interface IFilterQueryItem
- * @property {string} [index] - Optional field name or index to filter on
- * @property {string} [condition] - Optional comparison condition (e.g., 'Equal', 'Contains', 'Greater Than')
- * @property {string} [value] - Optional value to compare the field against
- * @memberOf module:engine
- */
-export interface IFilterQueryItem {
-    index?: string;
-    condition?: string;
-    value?: string;
-}
-/**
- * @description Interface for sorting configuration objects
- * @summary Defines the structure for specifying sort criteria including the field
- * to sort by and the direction of the sort (ascending or descending).
- * @interface ISortObject
- * @property {string} value - The field name or property to sort by
- * @property {OrderDirection} direction - The sort direction (ASC or DSC)
- * @memberOf module:engine
- */
-export interface ISortObject {
-    value: string;
-    direction: OrderDirection;
-}
-/**
- * @description Interface for complete filter query configuration
- * @summary Defines the complete structure for filter and sort operations.
- * Combines multiple filter criteria with sorting configuration to provide
- * comprehensive data filtering and ordering capabilities.
- * @interface IFilterQuery
- * @property {IFilterQueryItem[] | undefined} query - Array of filter criteria or undefined for no filtering
- * @property {ISortObject} sort - Sorting configuration specifying field and direction
- * @memberOf module:engine
- */
-export interface IFilterQuery {
-    query: IFilterQueryItem[] | undefined;
-    sort: ISortObject;
-}
-/**
- * @description Component input properties
- * @summary Extends FieldProperties with additional properties specific to Angular components.
- * Includes update mode for form controls and optional FormGroup and FormControl references.
- * @interface IComponentInput
- * @property {FieldUpdateMode} [updateMode] - When the field value should be updated
- * @property {FormGroup} [formGroup] - Optional FormGroup reference
- * @property {FormControl} [formControl] - Optional FormControl reference
- * @memberOf module:engine
- */
-export interface IComponentInput extends FieldProperties {
-    updateMode?: FieldUpdateMode;
-    formGroup?: FormGroup;
-    formControl?: FormControl;
-}
-/**
- * @description Component configuration structure
- * @summary Defines the configuration for dynamically creating Angular components.
- * Contains the component name, input properties, injector, and optional child components.
- * @interface IComponentConfig
- * @property {string} component - The name of the component to render
- * @property {IComponentInput} inputs - The input properties for the component
- * @property {EnvironmentInjector | Injector} injector - The Angular injector for dependency injection
- * @property {IComponentConfig[]} [children] - Optional child component configurations
- * @memberOf module:engine
- */
-export interface IComponentConfig {
-    component: string;
-    inputs: IComponentInput;
-    injector: EnvironmentInjector | Injector;
-    children?: IComponentConfig[];
-}
-/**
- * @description Metadata structure for Angular components
- * @summary Defines the structure of metadata for Angular components, including
- * change detection strategy, selector, standalone status, imports, template, and styles.
- * This is used for reflection and dynamic component creation.
- * @interface ComponentMetadata
- * @property {number} changeDetection - The change detection strategy number
- * @property {string} selector - The CSS selector for the component
- * @property {boolean} standalone - Whether the component is standalone
- * @property imports - Array of imported modules/components
- * @property {string} template - The HTML template for the component
- * @property {string[]} styles - Array of CSS styles for the component
- * @memberOf module:engine
- */
-export interface ComponentMetadata {
-    changeDetection: number;
-    selector: string;
-    standalone: boolean;
-    imports: (new (...args: unknown[]) => unknown)[];
-    template: string;
-    styles: string[];
-}
-/**
- * @description Output structure from the Angular rendering engine
- * @summary Defines the structure of the output produced by the NgxRenderingEngine
- * when rendering a component. Contains the component type, inputs, injector,
- * content nodes, and child components.
- * @typedef {Object} AngularDynamicOutput
- * @property {Type<unknown>} component - The Angular component type
- * @property {string} [rendererId] - Optional unique ID for the rendered component
- * @property {Record<string, unknown>} [inputs] - Optional input properties for the component
- * @property {Injector} [injector] - Optional Angular injector for dependency injection
- * @property {Node[][]} [content] - Optional content nodes for projection
- * @property {AngularDynamicOutput[]} [children] - Optional child components
- * @property {Type<unknown>} [instance] - Optional component instance
- * @property {FormGroup} [formGroup] - Optional component FormGroup
- * @property {FormControl} [formControl] - Optional component FormControl
- * @memberOf module:engine
- */
-export interface AngularDynamicOutput {
-    component?: Type<unknown>;
-    rendererId?: string;
-    inputs?: Record<string, unknown>;
-    injector?: Injector;
-    content?: Node[][];
-    children?: AngularDynamicOutput[];
-    instance?: Type<unknown>;
-    formGroup?: FormGroup;
-    formControl?: FormControl;
-}
-/**
- * @description Base option type for input components
- * @summary Defines the common structure for options used in select, radio, and checkbox inputs.
- * Contains properties for the display text, value, disabled state, CSS class, and icon.
- * @interface InputOption
- * @property {string} text - The display text for the option
- * @property {string|number} value - The value associated with the option
- * @property {StringOrBoolean} [disabled] - Whether the option is disabled
- * @property {string} [className] - CSS class name for styling the option
- * @property {string} [icon] - Icon to display with the option
- * @memberOf module:engine
- */
-export interface InputOption {
-    text: string;
-    value: string | number;
-    disabled?: StringOrBoolean;
-    className?: string;
-    icon?: string;
-}
-/**
- * @description Interface for list component refresh events
- * @summary Defines the structure of a refresh event for list components.
- * Contains an array of key-value pairs representing the new data for the list.
- * @interface IListComponentRefreshEvent
- * @property {KeyValue[]} data - Array of key-value pairs representing the new data
- * @memberOf module:engine
- */
-export interface IListComponentRefreshEvent {
-    data: KeyValue[];
-}
-/**
- * @description Form service control structure
- * @summary Defines the structure for a form control managed by the form service.
- * Contains the FormGroup control and the associated field properties for rendering.
- * @interface FormServiceControl
- * @property {FormGroup} control - The Angular FormGroup for the control
- * @property {AngularFieldDefinition} props - The field properties for rendering the control
- * @memberOf module:engine
- */
-export interface FormServiceControl {
-    control: FormGroup;
-    props: AngularFieldDefinition;
-}
-/**
- * @description Interface for list item custom events
- * @summary Defines the structure of custom events triggered by list items.
- * Extends BaseCustomEvent with additional properties for the action and primary key.
- * @interface ListItemCustomEvent
- * @property {string} action - The action performed on the list item
- * @property {string} [pk] - Optional primary key of the affected item
- * @property {any} data - The data associated with the event (inherited from BaseCustomEvent)
- * @property {HTMLElement} [target] - The target element (inherited from BaseCustomEvent)
- * @property {string} [name] - The name of the event (inherited from BaseCustomEvent)
- * @property {string} component - The component that triggered the event (inherited from BaseCustomEvent)
- * @memberOf module:engine
- */
-export interface ListItemCustomEvent extends BaseCustomEvent {
-    action: string;
-    pk?: string;
-}
-/**
- * @description Base interface for custom events
- * @summary Defines the base structure for custom events in the application.
- * Contains properties for the event data, target element, name, and component.
- * @interface BaseCustomEvent
- * @property {any} data - The data associated with the event
- * @property {HTMLElement} [target] - The target element that triggered the event
- * @property {string} [name] - The name of the event
- * @property {string} component - The component that triggered the event
- * @memberOf module:engine
- */
-export interface BaseCustomEvent {
-    name: string;
-    component?: string;
-    data?: unknown;
-    target?: HTMLElement;
-}
-/**
- * Configuration for internationalization (i18n) resource file paths.
- *
- * @property prefix - The prefix to be used for the resource file path.
- * @property suffix - The suffix to be appended to the resource file path.
- */
-export interface I18nResourceConfig {
-    prefix: string;
-    suffix: string;
-}

package/engine/types.d.ts

@@ -1,200 +0,0 @@
-import { IonCheckbox, IonInput, IonSelect, IonTextarea } from '@ionic/angular';
-import { TextFieldTypes } from '@ionic/core';
-import { FormArray, FormGroup } from '@angular/forms';
-import { BaseCustomEvent, FormServiceControl, InputOption } from './interfaces';
-import { Adapter, Repository } from '@decaf-ts/core';
-import { Context, RepositoryFlags } from '@decaf-ts/db-decorators';
-import { Constructor, Model } from '@decaf-ts/decorator-validation';
-export type HandlerLike = Record<string, (...args: unknown[]) => unknown | Promise<unknown>>;
-export interface RawQuery<M extends Model> {
-    select: undefined | (keyof M)[];
-    from: Constructor<M>;
-    where: (el: M) => boolean;
-    sort?: (el: M, el2: M) => number;
-    limit?: number;
-    skip?: number;
-}
-export type DecafRepositoryAdapter<F extends RepositoryFlags = RepositoryFlags, C extends Context<F> = Context<F>> = Adapter<any, any, RawQuery<any>, F, C>;
-export type DecafRepository<M extends Model> = Repository<M, RawQuery<M>, DecafRepositoryAdapter<RepositoryFlags, Context<RepositoryFlags>>, RepositoryFlags, Context<RepositoryFlags>>;
-/**
- * @description Generic key-value pair type
- * @summary Represents a generic object with string keys and any type of values.
- * This is commonly used for dynamic data structures where the properties are not known at compile time.
- * @typedef {Record<string, any>} KeyValue
- * @memberOf module:engine
- */
-export type KeyValue = Record<string, any>;
-/**
- * @description Generic function type
- * @summary Represents a function that accepts any number of arguments of any type
- * and returns any type. This is useful for defining function parameters or variables
- * where the exact function signature is not known at compile time.
- * @typedef FunctionLike
- * @memberOf module:engine
- */
-export type FunctionLike = (...args: any[]) => any;
-/**
- * @description Element size options for UI components
- * @summary Defines the possible size values that can be applied to UI elements.
- * These sizes control the dimensions and layout behavior of components.
- * @typedef {('small'|'medium'|'large'|'xlarge'|'2xlarge'|'auto'|'expand'|'block')} ElementSizes
- * @memberOf module:engine
- */
-export type ElementSizes = 'small' | 'medium' | 'large' | 'xlarge' | '2xlarge' | 'auto' | 'expand' | 'block';
-/**
- * @description Basic position options for UI elements
- * @summary Defines the possible position values that can be applied to UI elements.
- * These positions control the alignment and placement of components.
- * @typedef {('left'|'center'|'right'|'top'|'bottom')} ElementPositions
- * @memberOf module:engine
- */
-export type ElementPositions = 'left' | 'center' | 'right' | 'top' | 'bottom';
-/**
- * @description Extended position options for flex layouts
- * @summary Extends the basic ElementPositions with additional flex-specific position values.
- * These positions are used for controlling alignment and distribution in flex containers.
- * @typedef {(ElementPositions|'stretch'|'middle'|'around'|'between')} FlexPositions
- * @memberOf module:engine
- */
-export type FlexPositions = ElementPositions | 'stretch' | 'middle' | 'around' | 'between';
-/**
- * @description Update mode options for form fields
- * @summary Defines when form field values should be updated in the model.
- * - 'change': Update on every change event
- * - 'blur': Update when the field loses focus
- * - 'submit': Update only when the form is submitted
- * @typedef {('change'|'blur'|'submit')} FieldUpdateMode
- * @memberOf module:engine
- */
-export type FieldUpdateMode = 'change' | 'blur' | 'submit';
-/**
- * @description Interface for models that can be rendered
- * @summary Defines the basic structure for models that can be rendered by the engine.
- * Contains an optional rendererId that uniquely identifies the rendered instance.
- * @interface RenderedModel
- * @property {string} [rendererId] - Optional unique ID for the rendered model instance
- * @memberOf module:engine
- */
-export interface RenderedModel {
-    rendererId?: string;
-}
-/**
- * @description Possible input types for form fields
- * @summary Defines the possible input types that can be used in form fields.
- * Includes standard HTML input types like checkbox, radio, and select,
- * as well as Ionic's TextFieldTypes and textarea.
- * @typedef {('checkbox'|'radio'|'select'|TextFieldTypes|'textarea')} PossibleInputTypes
- * @memberOf module:engine
- */
-export type PossibleInputTypes = 'checkbox' | 'radio' | 'select' | TextFieldTypes | 'textarea';
-/**
- * @description Field definition for Angular components
- * @summary A comprehensive type that combines properties from various Ionic components
- * to define the structure of a field in an Angular form. It omits certain properties
- * from IonInput, picks specific properties from IonSelect, IonTextarea, and IonCheckbox,
- * and adds custom properties like type and className.
- * @typedef {Object} AngularFieldDefinition
- * @property {PossibleInputTypes} type - The type of input field
- * @property {string|string[]} className - CSS class name(s) for the field
- * @property {string} [cancelText] - Text for the cancel button (from IonSelect)
- * @property {string} [interface] - Interface style for select (from IonSelect)
- * @property {string} [selectedText] - Text for selected option (from IonSelect)
- * @property {Object} [interfaceOptions] - Options for the interface (from IonSelect)
- * @property {number} [rows] - Number of rows for textarea (from IonTextarea)
- * @property {number} [cols] - Number of columns for textarea (from IonTextarea)
- * @property {string} [alignment] - Alignment of checkbox (from IonCheckbox)
- * @property {string} [justify] - Justification of checkbox (from IonCheckbox)
- * @property {boolean} [checked] - Whether checkbox is checked (from IonCheckbox)
- * @memberOf module:engine
- */
-export type AngularFieldDefinition = Omit<IonInput, 'ionInput' | 'ionFocus' | 'ionChange' | 'ionBlur' | 'getInputElement' | 'setFocus' | 'label' | 'el' | 'z' | 'type'> & Pick<IonSelect, 'cancelText' | 'interface' | 'selectedText' | 'interfaceOptions'> & Pick<IonTextarea, 'rows' | 'cols'> & Pick<IonCheckbox, 'alignment' | 'justify' | 'checked'> & {
-    type: PossibleInputTypes;
-    className: string | string[];
-} & Record<string, unknown>;
-/**
- * @description String or boolean representation of a boolean value
- * @summary Represents a value that can be either a boolean or a string representation of a boolean.
- * This is useful for handling attribute values that can be specified as either strings or booleans.
- * @typedef {('true'|'false'|boolean)} StringOrBoolean
- * @memberOf module:engine
- */
-export type StringOrBoolean = 'true' | 'false' | boolean;
-/**
- * @description Option type for CRUD field inputs
- * @summary Represents a union type that can be either a SelectOption or RadioOption.
- * This is used for defining options in form fields that support both select and radio input types.
- * @typedef {(SelectOption|RadioOption)} CrudFieldOption
- * @memberOf module:engine
- */
-export type CrudFieldOption = SelectOption | RadioOption;
-/**
- * @description Option type for select inputs
- * @summary Extends the InputOption interface with a selected property to indicate
- * whether the option is selected by default.
- * @memberOf module:engine
- */
-export type SelectOption = InputOption & {
-    selected?: boolean;
-};
-/**
- * @description Option type for radio inputs
- * @summary Extends the InputOption interface with a checked property to indicate
- * whether the option is checked by default.
- * @memberOf module:engine
- */
-export type RadioOption = InputOption & {
-    checked?: boolean;
-};
-/**
- * @description Option type for checkbox inputs
- * @summary Alias for RadioOption, as checkbox options have the same structure as radio options.
- * @typedef {RadioOption} CheckboxOption
- * @memberOf module:engine
- */
-export type CheckboxOption = RadioOption;
-/**
- * @description Target options for HTML forms
- * @summary Defines the possible target values for HTML forms, including standard targets
- * like '_blank', '_self', '_parent', and '_top', as well as custom string values.
- * @typedef {('_blank'|'_self'|'_parent'|'_top'|string)} HTMLFormTarget
- * @memberOf module:engine
- */
-export type HTMLFormTarget = '_blank' | '_self' | '_parent' | '_top' | string;
-/**
- * @description Type for form service controls
- * @summary Defines the structure of form controls managed by the form service.
- * It's a nested record where the outer key is the form group name, the inner key
- * is the control name, and the value contains the form group and field properties.
- * @typedef {Record<string, Record<string, { control: FormGroup; props: AngularFieldDefinition }>>} FormServiceControls
- * @memberOf module:engine
- */
-export type FormServiceControls = Record<string, Record<string, FormServiceControl>>;
-/**
- * @description Renderer custom event type
- * @summary Combines BaseCustomEvent with KeyValue properties to create a flexible
- * custom event type for renderer components. This allows events to carry both
- * standard event properties and additional custom data.
- * @typedef RendererCustomEvent
- * @memberOf module:engine
- */
-export type RendererCustomEvent = BaseCustomEvent & KeyValue;
-/**
- * @description CRUD form event type
- * @summary Extends BaseCustomEvent to include optional handlers for CRUD form operations.
- * This event type is used for form-related actions like create, read, update, and delete operations.
- * @typedef CrudFormEvent
- * @property {Record<string, any>} [handlers] - Optional handlers for form operations
- * @memberOf module:engine
- */
-export type CrudFormEvent = BaseCustomEvent & {
-    handlers?: Record<string, any>;
-};
-export type FormParent = FormGroup | FormArray;
-/**
- * @description Form parent group tuple
- * @summary Represents a tuple containing a FormGroup and its associated string identifier.
- * This is used for managing hierarchical form structures and parent-child relationships.
- * @typedef {[FormParent, string]} FormParentGroup
- * @memberOf module:engine
- */
-export type FormParentGroup = [FormParent, string];