@decaf-ts/for-angular 0.0.25 → 0.0.27

package/components/crud-form/crud-form.component.d.ts

@@ -1,288 +0,0 @@
-import { ElementRef, EventEmitter, OnDestroy, OnInit } from '@angular/core';
-import { FormGroup } from '@angular/forms';
-import { IFormElement } from '../../engine/interfaces';
-import { CrudFormEvent, FieldUpdateMode, HandlerLike, HTMLFormTarget, RenderedModel } from '../../engine';
-import { CrudFormOptions } from './types';
-import { CrudOperations, OperationKeys } from '@decaf-ts/db-decorators';
-import { Model } from '@decaf-ts/decorator-validation';
-import * as i0 from "@angular/core";
-/**
- * @component CrudFormComponent
- * @example <ngx-decaf-crud-form
- *   action="create"
- *   operation="create"
- *   formGroup="formGroup"
- *   rendererId="rendererId"
- *   submitEvent="submitEvent"
- *   target="_self"
- *   method="event">
- * </ngx-decaf-crud-form>
- *
- * @param {string} action - The action to be performed (create, read, update, delete)
- * @param {CrudOperations} operation - The CRUD operation being performed (create, read, update, delete)
- * @param {FormGroup} formGroup - The form group
- * @param {string} rendererId - The renderer id
- * @param {SubmitEvent} submitEvent - The submit event
- * @param {string} target - The target
- * @param {string} method - The method
- */
-export declare class CrudFormComponent implements OnInit, IFormElement, OnDestroy, RenderedModel {
-    /**
-     * @description Repository model for data operations.
-     * @summary The data model repository that this component will use for CRUD operations.
-     * This provides a connection to the data layer for retrieving and manipulating data.
-     *
-     * @type {Model| undefined}
-     * @memberOf CrudFormComponent
-     */
-    model: Model | undefined;
-    /**
-     * @description The primary data model used for CRUD operations.
-     * @summary This input provides the main Model instance that the form interacts with for
-     * creating, reading, updating, or deleting records. It serves as the source of schema
-     * and validation rules for the form fields, and is required for most operations except
-     * for certain read or delete scenarios.
-     *
-     * @type {Model | undefined}
-     * @memberOf CrudFormComponent
-     */
-    modelId: Model | undefined;
-    /**
-     * @description Field update trigger mode for form validation.
-     * @summary Determines when form field validation should be triggered. Options include
-     * 'change', 'blur', or 'submit'. This affects the user experience by controlling
-     * when validation feedback is shown to the user during form interaction.
-     *
-     * @type {FieldUpdateMode}
-     * @default 'change'
-     * @memberOf CrudFormComponent
-     */
-    updateOn: FieldUpdateMode;
-    /**
-     * @description Reference to the reactive form DOM element.
-     * @summary ViewChild reference that provides direct access to the form's DOM element.
-     * This enables programmatic manipulation of the form element and access to native
-     * HTML form properties and methods when needed.
-     *
-     * @type {ElementRef}
-     * @memberOf CrudFormComponent
-     */
-    component: ElementRef;
-    /**
-     * @description Form submission target specification.
-     * @summary Specifies where to display the response after form submission, similar
-     * to the HTML form target attribute. Options include '_self', '_blank', '_parent',
-     * '_top', or a named frame. Controls the browser behavior for form responses.
-     *
-     * @type {HTMLFormTarget}
-     * @default '_self'
-     * @memberOf CrudFormComponent
-     */
-    target: HTMLFormTarget;
-    /**
-     * @description HTTP method or submission strategy for the form.
-     * @summary Defines how the form should be submitted. 'get' and 'post' correspond
-     * to standard HTTP methods for traditional form submission, while 'event' uses
-     * Angular event-driven submission for single-page application workflows.
-     *
-     * @type {'get' | 'post' | 'event'}
-     * @default 'event'
-     * @memberOf CrudFormComponent
-     */
-    method: 'get' | 'post' | 'event';
-    /**
-     * @description Configuration options for the CRUD form behavior.
-     * @summary Contains various configuration settings that control form rendering,
-     * validation, and behavior. These options are merged with default settings
-     * during component initialization to customize the form's functionality.
-     *
-     * @type {CrudFormOptions}
-     * @memberOf CrudFormComponent
-     */
-    options: CrudFormOptions;
-    /**
-     * @description Optional action identifier for form submission context.
-     * @summary Specifies a custom action name that will be included in the submit event.
-     * If not provided, defaults to the standard submit event constant. Used to
-     * distinguish between different types of form submissions within the same component.
-     *
-     * @type {string | undefined}
-     * @memberOf CrudFormComponent
-     */
-    action?: string;
-    /**
-     * @description The current CRUD operation being performed.
-     * @summary Specifies the type of operation this form is handling (CREATE, READ, UPDATE, DELETE).
-     * This is a required input that determines form behavior, validation rules, and available actions.
-     * The operation affects form state, button visibility, and submission logic.
-     *
-     * @type {CrudOperations}
-     * @required
-     * @memberOf CrudFormComponent
-     */
-    operation: CrudOperations;
-    /**
-     * @description Custom event handlers for form actions.
-     * @summary A record of event handler functions keyed by event names that can be
-     * triggered during form operations. These handlers provide extensibility for
-     * custom business logic and can be invoked for various form events and actions.
-     *
-     * @type {HandlerLike}
-     * @memberOf CrudFormComponent
-     */
-    handlers: HandlerLike;
-    /**
-     * @description Angular reactive FormGroup for form state management.
-     * @summary The FormGroup instance that manages all form controls, validation,
-     * and form state. This is the main interface for accessing form values and
-     * controlling form behavior. May be undefined for read-only operations.
-     *
-     * @type {FormGroup | undefined}
-     * @memberOf CrudFormComponent
-     */
-    formGroup: FormGroup | undefined;
-    /**
-     * @description Path to the parent FormGroup, if nested.
-     * @summary Full dot-delimited path of the parent FormGroup. Set only when is part of a nested structure.
-     *
-     * @type {string}
-     * @memberOf CrudFormComponent
-     */
-    childOf?: string;
-    /**
-     * @description Unique identifier for the form renderer.
-     * @summary A unique string identifier used to register and manage this form
-     * instance within the NgxFormService. This ID is also used as the HTML id
-     * attribute for the form element, enabling DOM queries and form management.
-     *
-     * @type {string}
-     * @memberOf CrudFormComponent
-     */
-    rendererId: string;
-    /**
-     * @description Unique identifier for the current record.
-     * @summary A unique identifier for the current record being displayed or manipulated.
-     * This is typically used in conjunction with the primary key for operations on specific records.
-     *
-     * @type {string | number}
-     * @memberOf CrudFormComponent
-     */
-    uid: string;
-    /**
-     * @description Unique identifier for the current record instance.
-     * @summary This property holds a unique string value that identifies the specific record being managed by the form.
-     * It is automatically generated if not provided, ensuring each form instance has a distinct identifier.
-     * The uid is used for tracking, referencing, and emitting events related to the current record, and may be used
-     * in conjunction with the primary key for CRUD operations.
-     *
-     * @type {string}
-     * @default Randomly generated 12-character string
-     * @memberOf CrudFormComponent
-     */
-    allowClear: boolean;
-    /**
-     * @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
-     * @memberOf CrudFormComponent
-     */
-    protected readonly OperationKeys: typeof OperationKeys;
-    /**
-     * @description Event emitter for form submission events.
-     * @summary Emits CrudFormEvent objects when the form is submitted, providing
-     * form data, component information, and any associated handlers to parent
-     * components. This enables decoupled handling of form submission logic.
-     *
-     * @type {EventEmitter<CrudFormEvent>}
-     * @memberOf CrudFormComponent
-     */
-    submitEvent: EventEmitter<CrudFormEvent>;
-    /**
-     * @description Logger instance for the component.
-     * @summary Provides logging capabilities for the component, allowing for consistent
-     * and structured logging of information, warnings, and errors. This logger is initialized
-     * in the ngOnInit method using the getLogger function from the ForAngularCommonModule.
-     *
-     * The logger is used throughout the component to record important events, debug information,
-     * and potential issues. It helps in monitoring the component's behavior, tracking the flow
-     * of operations, and facilitating easier debugging and maintenance.
-     *
-     * @type {Logger}
-     * @private
-     * @memberOf CrudFormComponent
-     */
-    private logger;
-    /**
-     * @description Angular Location service.
-     * @summary Injected service that provides access to the browser's URL and history.
-     * This service is used for interacting with the browser's history API, allowing
-     * for back navigation and URL manipulation outside of Angular's router.
-     *
-     * @private
-     * @type {Location}
-     * @memberOf CrudFormComponent
-     */
-    private location;
-    /**
-     * @description Component initialization lifecycle method.
-     * @summary Initializes the component by setting up the logger, configuring form state
-     * based on the operation type, and merging configuration options. For READ and DELETE
-     * operations, the formGroup is set to undefined since these operations don't require
-     * form input. Configuration options are merged with default settings.
-     *
-     * @returns {Promise<void>}
-     * @memberOf CrudFormComponent
-     */
-    ngOnInit(): Promise<void>;
-    /**
-     * @description Component cleanup lifecycle method.
-     * @summary Performs cleanup operations when the component is destroyed.
-     * Unregisters the FormGroup from the NgxFormService to prevent memory leaks
-     * and ensure proper resource cleanup.
-     *
-     * @returns {void}
-     * @memberOf CrudFormComponent
-     */
-    ngOnDestroy(): void;
-    /**
-     * @description Handles form submission with validation and event emission.
-     * @summary Processes form submission by first preventing default browser behavior,
-     * then validating all form fields using NgxFormService. If validation passes,
-     * extracts form data and emits a submitEvent with the data, component information,
-     * and any associated handlers. Returns false if validation fails.
-     *
-     * @param {SubmitEvent} event - The browser's native form submit event
-     * @returns {Promise<boolean | void>} Returns false if validation fails, void if successful
-     * @memberOf CrudFormComponent
-     */
-    submit(event: SubmitEvent): Promise<boolean | void>;
-    /**
-     * @description Handles form reset or navigation back functionality.
-     * @summary Provides different reset behavior based on the current operation.
-     * For CREATE and UPDATE operations, resets the form to its initial state.
-     * For READ and DELETE operations, navigates back in the browser history
-     * since these operations don't have modifiable form data to reset.
-     *
-     * @returns {void}
-     * @memberOf CrudFormComponent
-     */
-    handleReset(): void;
-    /**
-     * @description Handles delete operations by emitting delete events.
-     * @summary Processes delete requests by emitting a submit event with the
-     * record's unique identifier as data. This allows parent components to
-     * handle the actual deletion logic while maintaining separation of concerns.
-     * The event includes the uid and standard component identification.
-     *
-     * @returns {void}
-     * @memberOf CrudFormComponent
-     */
-    handleDelete(): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<CrudFormComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<CrudFormComponent, "ngx-decaf-crud-form", never, { "model": { "alias": "model"; "required": false; }; "modelId": { "alias": "modelId"; "required": false; }; "updateOn": { "alias": "updateOn"; "required": false; }; "target": { "alias": "target"; "required": false; }; "method": { "alias": "method"; "required": false; }; "options": { "alias": "options"; "required": false; }; "action": { "alias": "action"; "required": false; }; "operation": { "alias": "operation"; "required": true; }; "handlers": { "alias": "handlers"; "required": false; }; "formGroup": { "alias": "formGroup"; "required": false; }; "childOf": { "alias": "childOf"; "required": false; }; "rendererId": { "alias": "rendererId"; "required": false; }; "uid": { "alias": "uid"; "required": false; }; "allowClear": { "alias": "allowClear"; "required": false; }; }, { "submitEvent": "submitEvent"; }, never, ["*"], true, never>;
-}

package/components/crud-form/types.d.ts

@@ -1,17 +0,0 @@
-export interface FormReactiveSubmitEvent {
-    data: Record<string, unknown>;
-}
-export interface CrudFormOptions {
-    buttons: {
-        submit: {
-            icon?: string;
-            iconSlot?: 'start' | 'end';
-            text?: string;
-        };
-        clear?: {
-            icon?: string;
-            iconSlot?: 'start' | 'end';
-            text?: string;
-        };
-    };
-}

package/components/empty-state/empty-state.component.d.ts

@@ -1,300 +0,0 @@
-import { OnInit } from '@angular/core';
-import { StringOrBoolean } from '../../engine';
-import { NgxBaseComponent } from '../../engine/NgxBaseComponent';
-import { SafeHtml } from '@angular/platform-browser';
-import { FunctionLike } from '../../engine/types';
-import * as i0 from "@angular/core";
-/**
- * @description Component for displaying empty state messages with optional actions.
- * @summary This component provides a standardized way to display empty state messages
- * when no data is available or when a user needs to take an action to populate content.
- * It includes customizable title, subtitle, icon, and action button elements that can be
- * styled and configured through input properties. The component supports localization
- * and can trigger navigation or custom actions when the button is clicked.
- *
- * @mermaid
- * classDiagram
- *   class EmptyStateComponent {
- *     +string title
- *     +string titleColor
- *     +string subtitle
- *     +string subtitleColor
- *     +StringOrBoolean showIcon
- *     +string icon
- *     +string iconSize
- *     +string iconColor
- *     +string|Function buttonLink
- *     +string buttonText
- *     +string buttonFill
- *     +string buttonColor
- *     +string buttonSize
- *     +string searchValue
- *     -Router Router
- *     +ngOnInit()
- *     +handleClick()
- *   }
- *   EmptyStateComponent --|> NgxBaseComponent
- *   EmptyStateComponent --|> OnInit
- *
- * @extends {NgxBaseComponent}
- * @implements {OnInit}
- */
-export declare class EmptyStateComponent extends NgxBaseComponent implements OnInit {
-    /**
-     * @description The main title displayed in the empty state.
-     * @summary Specifies the primary message to show in the empty state component.
-     * This text is typically used to inform the user about why they're seeing an empty view.
-     * If translatable is true, this will be processed through the localization system.
-     *
-     * @type {string}
-     * @default "title"
-     * @memberOf EmptyStateComponent
-     */
-    title: string;
-    /**
-     * @description The color of the title text.
-     * @summary Specifies the color for the title text using the application's color system.
-     * The value should correspond to a color variable defined in the application's theme.
-     * The component will automatically prefix this with "color-" to create the CSS class.
-     *
-     * @type {string}
-     * @default 'gray-6'
-     * @memberOf EmptyStateComponent
-     */
-    titleColor: string;
-    /**
-     * @description The secondary message displayed in the empty state.
-     * @summary Provides additional context or instructions below the main title.
-     * This text is typically used to guide the user on what actions they can take.
-     * If translatable is true, this will be processed through the localization system.
-     *
-     * @type {string | undefined}
-     * @memberOf EmptyStateComponent
-     */
-    subtitle: string;
-    /**
-     * @description The color of the subtitle text.
-     * @summary Specifies the color for the subtitle text using the application's color system.
-     * The value should correspond to a color variable defined in the application's theme.
-     * The component will automatically prefix this with "color-" to create the CSS class.
-     *
-     * @type {string}
-     * @default 'gray-4'
-     * @memberOf EmptyStateComponent
-     */
-    subtitleColor: string;
-    /**
-     * @description Controls whether the icon is displayed.
-     * @summary Determines if the visual icon should be shown in the empty state.
-     * This can be provided as a boolean or a string that will be converted to a boolean.
-     * Icons help visually communicate the empty state context to users.
-     *
-     * @type {StringOrBoolean}
-     * @default true
-     * @memberOf EmptyStateComponent
-     */
-    showIcon: StringOrBoolean;
-    /**
-     * @description The name of the icon to display.
-     * @summary Specifies which icon to show when showIcon is true.
-     * The component uses the icon system defined in the application,
-     * and this value should correspond to an available icon name.
-     *
-     * @type {string}
-     * @default "ti-info-square-rounded"
-     * @memberOf EmptyStateComponent
-     */
-    icon: string;
-    /**
-     * @description The size of the displayed icon.
-     * @summary Controls the size of the icon shown in the empty state.
-     * Can be either 'large' or 'small' to accommodate different layout needs.
-     *
-     * @type {'large' | 'small' | undefined}
-     * @default 'large'
-     * @memberOf EmptyStateComponent
-     */
-    iconSize?: 'large' | 'small';
-    /**
-     * @description The color of the displayed icon.
-     * @summary Specifies the color for the icon using Ionic's predefined color system.
-     * This allows the icon to match the application's color scheme.
-     *
-     * @type {PredefinedColors | undefined}
-     * @default 'medium'
-     * @memberOf EmptyStateComponent
-     */
-    iconColor?: string;
-    /**
-     * @description The navigation target or action for the button.
-     * @summary Specifies where the button should navigate to when clicked or what function
-     * it should execute. This can be either a URL string or a function that handles navigation.
-     * When not provided, the button will not perform any action.
-     *
-     * @type {string | FunctionLike | undefined}
-     * @memberOf EmptyStateComponent
-     */
-    buttonLink?: string | FunctionLike;
-    /**
-     * @description The text displayed on the action button.
-     * @summary Specifies the label for the action button in the empty state.
-     * If translatable is true, this will be processed through the localization system.
-     * If not provided, the button will not display any text.
-     *
-     * @type {string | undefined}
-     * @memberOf EmptyStateComponent
-     */
-    buttonText?: string;
-    /**
-     * @description The fill style of the action button.
-     * @summary Controls the visual style of the button using Ionic's button fill options.
-     * 'solid' creates a button with a solid background, 'outline' creates a button with
-     * just a border, and 'clear' creates a button with no background or border.
-     *
-     * @type {'clear' | 'solid' | 'outline'}
-     * @default 'solid'
-     * @memberOf EmptyStateComponent
-     */
-    buttonFill: 'clear' | 'solid' | 'outline';
-    /**
-     * @description The color of the action button.
-     * @summary Specifies the color for the button using Ionic's color system.
-     * This allows the button to match the application's color scheme.
-     *
-     * @type {string}
-     * @default 'primary'
-     * @memberOf EmptyStateComponent
-     */
-    buttonColor: string;
-    /**
-     * @description The size of the action button.
-     * @summary Controls the size of the button shown in the empty state.
-     * Can be 'large', 'small', or 'default' to accommodate different layout needs.
-     *
-     * @type {'large' | 'small' | 'default'}
-     * @default 'default'
-     * @memberOf EmptyStateComponent
-     */
-    buttonSize: 'large' | 'small' | 'default';
-    /**
-     * @description The search value that resulted in no results.
-     * @summary When the empty state is shown due to a search with no results,
-     * this property can hold the search term that was used. This can be displayed
-     * in the empty state message to provide context to the user.
-     *
-     * @type {string}
-     * @memberOf EmptyStateComponent
-     */
-    searchValue: string;
-    /**
-     * @description Service for handling navigation operations.
-     * @summary Injected service that provides methods for navigating between routes.
-     * This service is used when the buttonLink is a string URL to navigate to that location.
-     *
-     * @private
-     * @type {Router}
-     * @memberOf EmptyStateComponent
-     */
-    private router;
-    private sanitizer;
-    private translate;
-    searchSubtitle: SafeHtml;
-    /**
-     * @description Creates an instance of EmptyStateComponent.
-     * @summary Initializes a new EmptyStateComponent by calling the parent class constructor
-     * with the component name for logging and identification purposes. This component provides
-     * a standardized way to display empty state messages with optional icons and action buttons.
-     *
-     * @memberOf EmptyStateComponent
-     */
-    constructor();
-    /**
-     * @description Initializes the component after Angular first displays the data-bound properties.
-     * @summary Sets up the component by processing boolean inputs, applying localization to text
-     * elements if translation is enabled, and formatting CSS classes for title and subtitle colors.
-     * This method prepares the component for user interaction by ensuring all properties are
-     * properly initialized and localized.
-     *
-     * @mermaid
-     * sequenceDiagram
-     *   participant A as Angular Lifecycle
-     *   participant E as EmptyStateComponent
-     *
-     *   A->>E: ngOnInit()
-     *   E->>E: Process translatable flag
-     *   E->>E: Process showIcon flag
-     *   E->>E: Get locale settings
-     *   alt translatable is true
-     *     E->>E: Localize title
-     *     E->>E: Localize subtitle
-     *     E->>E: Localize buttonText
-     *   end
-     *   E->>E: Format title CSS class
-     *   E->>E: Format subtitle CSS class
-     *
-     * @return {Promise<void>}
-     * @memberOf EmptyStateComponent
-     */
-    ngOnInit(): Promise<void>;
-    /**
-     * @description Handles click events on the action button.
-     * @summary This method is triggered when the user clicks the action button in the empty state
-     * component. It supports three navigation patterns: 1) no action when buttonLink is not provided,
-     * 2) custom function execution when buttonLink is a function, and 3) navigation to a specific URL
-     * when buttonLink is a string. This flexibility allows the empty state to trigger various actions
-     * based on the context in which it's used.
-     *
-     * @mermaid
-     * sequenceDiagram
-     *   participant U as User
-     *   participant E as EmptyStateComponent
-     *   participant N as Router
-     *
-     *   U->>E: Click action button
-     *   E->>E: handleClick()
-     *   alt buttonLink is not provided
-     *     E-->>U: Return false (no action)
-     *   else buttonLink is a function
-     *     E->>E: Execute buttonLink function
-     *     E-->>U: Return function result
-     *   else buttonLink is a URL string
-     *     E->>N: navigateForward(buttonLink)
-     *     N-->>E: Return navigation result
-     *     E-->>U: Return navigation result
-     *   end
-     *
-     * @return {boolean | void | Promise<boolean>}
-     *   - false if no action is taken
-     *   - The result of the buttonLink function if it's a function
-     *   - A Promise resolving to the navigation result if buttonLink is a URL
-     * @memberOf EmptyStateComponent
-     */
-    handleClick(): boolean | void | Promise<boolean>;
-    /**
-      * @description Generates a localized and sanitized subtitle for search results.
-      * @summary This method takes a content string, typically the subtitle, and processes it
-      * through the translation service. It replaces a placeholder ('value0') with the actual
-      * search value, then sanitizes the result to safely use as HTML. This is particularly
-      * useful for displaying dynamic, localized messages in the empty state when a search
-      * yields no results.
-      *
-      * @param {string} content - The content string to be translated and processed
-      * @return {Promise<SafeHtml>} A promise that resolves to a sanitized HTML string
-      *
-      * @mermaid
-      * sequenceDiagram
-      *   participant E as EmptyStateComponent
-      *   participant T as TranslateService
-      *   participant S as DomSanitizer
-      *
-      *   E->>T: instant(content, {'value0': searchValue})
-      *   T-->>E: Return translated string
-      *   E->>S: bypassSecurityTrustHtml(translatedString)
-      *   S-->>E: Return sanitized SafeHtml
-      *
-      * @memberOf EmptyStateComponent
-      */
-    getSearchSubtitle(content: string): Promise<SafeHtml>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<EmptyStateComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<EmptyStateComponent, "ngx-decaf-empty-state", never, { "title": { "alias": "title"; "required": false; }; "titleColor": { "alias": "titleColor"; "required": false; }; "subtitle": { "alias": "subtitle"; "required": false; }; "subtitleColor": { "alias": "subtitleColor"; "required": false; }; "showIcon": { "alias": "showIcon"; "required": false; }; "icon": { "alias": "icon"; "required": false; }; "iconSize": { "alias": "iconSize"; "required": false; }; "iconColor": { "alias": "iconColor"; "required": false; }; "buttonLink": { "alias": "buttonLink"; "required": false; }; "buttonText": { "alias": "buttonText"; "required": false; }; "buttonFill": { "alias": "buttonFill"; "required": false; }; "buttonColor": { "alias": "buttonColor"; "required": false; }; "buttonSize": { "alias": "buttonSize"; "required": false; }; "searchValue": { "alias": "searchValue"; "required": false; }; }, {}, never, never, true, never>;
-}