@decaf-ts/for-angular 0.0.11 → 0.0.13

package/dist/lib/components/list-item/list-item.component.d.ts

@@ -1,390 +0,0 @@
-import { EventEmitter, OnInit } from '@angular/core';
-import { CrudOperations } from '@decaf-ts/db-decorators';
-import { StringOrBoolean } from '../../engine/types';
-import { NgxBaseComponent } from '../../engine/NgxBaseComponent';
-import { ListItemCustomEvent } from '../../engine';
-import * as i0 from "@angular/core";
-/**
- * @description A component for displaying a list item with various customization options.
- * @summary The ListItemComponent is an Angular component that extends NgxBaseComponent. It provides a flexible and customizable list item interface with support for icons, buttons, and various text elements. The component also handles actions and navigation based on user interactions.
- *
- * @class
- * @extends NgxBaseComponent
- *
- * @param {string} [lines='none'] - Determines the line style of the item. Can be 'inset', 'inseet', or 'none'.
- * @param {Record<string, any>} item - The data item to be displayed in the list item.
- * @param {string} icon - The name of the icon to be displayed.
- * @param {'start' | 'end'} [iconSlot='start'] - The position of the icon within the item.
- * @param {StringOrBoolean} [button=true] - Determines if the item should behave as a button.
- * @param {string} [title] - The main title of the list item.
- * @param {string} [description] - A description for the list item.
- * @param {string} [info] - Additional information for the list item.
- * @param {string} [subinfo] - Sub-information for the list item.
- *
- * @example
- * <ngx-decaf-list-item
- *   [item]="dataItem"
- *   icon="star"
- *   title="Item Title"
- *   description="Item Description"
- *   (clickEvent)="handleItemClick($event)">
- * </ngx-decaf-list-item>
- *
- * @mermaid
- * sequenceDiagram
- *   participant C as Component
- *   participant V as View
- *   participant U as User
- *   C->>V: Initialize component
- *   V->>U: Display list item
- *   U->>V: Click on item or action
- *   V->>C: Trigger handleAction()
- *   C->>C: Process action
- *   C->>V: Update view or navigate
- */
-export declare class ListItemComponent extends NgxBaseComponent implements OnInit {
-    /**
-     * @description Reference to the action menu popover component.
-     * @summary ViewChild reference that provides access to the HTMLIonPopoverElement
-     * used for displaying action menus. This reference is used to programmatically
-     * control the popover, such as dismissing it when necessary.
-     *
-     * @type {HTMLIonPopoverElement}
-     * @memberOf ListItemComponent
-     */
-    actionMenuComponent: HTMLIonPopoverElement;
-    /**
-     * @description Controls the display of lines around the list item.
-     * @summary Determines how lines are displayed around the list item borders.
-     * 'inset' shows lines with padding, 'full' shows full-width lines, and 'none'
-     * removes all lines. This affects the visual separation between list items.
-     *
-     * @type {'inset' | 'full' | 'none'}
-     * @default 'inset'
-     * @memberOf ListItemComponent
-     */
-    lines: 'inset' | 'full' | 'none';
-    /**
-     * @description The data object associated with this list item.
-     * @summary Contains the raw data that this list item represents. This object
-     * is used to extract display information and for passing to event handlers
-     * when the item is interacted with. It overrides the base item property.
-     *
-     * @type {Record<string, unknown>}
-     * @memberOf ListItemComponent
-     */
-    item: Record<string, unknown>;
-    /**
-     * @description The name of the icon to display in the list item.
-     * @summary Specifies which icon to display using Ionic's icon system.
-     * The icon name should correspond to an available Ionic icon or a custom
-     * icon that has been registered with the icon registry.
-     *
-     * @type {string}
-     * @memberOf ListItemComponent
-     */
-    icon: string;
-    /**
-     * @description Position of the icon within the list item.
-     * @summary Determines whether the icon appears at the start (left in LTR languages)
-     * or end (right in LTR languages) of the list item. This affects the overall
-     * layout and visual hierarchy of the item content.
-     *
-     * @type {'start' | 'end'}
-     * @default 'start'
-     * @memberOf ListItemComponent
-     */
-    iconSlot: 'start' | 'end';
-    /**
-     * @description Controls whether the list item behaves as a clickable button.
-     * @summary When set to true, the list item will have button-like behavior including
-     * hover effects, click handling, and appropriate accessibility attributes.
-     * When false, the item is displayed as static content without interactive behavior.
-     *
-     * @type {StringOrBoolean}
-     * @default true
-     * @memberOf ListItemComponent
-     */
-    button: StringOrBoolean;
-    /**
-     * @description The main title text displayed in the list item.
-     * @summary Sets the primary text content that appears prominently in the list item.
-     * This is typically the most important information about the item and is displayed
-     * with emphasis in the component's visual hierarchy.
-     *
-     * @type {string}
-     * @memberOf ListItemComponent
-     */
-    title?: string;
-    /**
-     * @description Secondary descriptive text for the list item.
-     * @summary Provides additional context or details about the item. This text
-     * is typically displayed below the title with less visual emphasis.
-     * Useful for providing context without cluttering the main title.
-     *
-     * @type {string}
-     * @memberOf ListItemComponent
-     */
-    description?: string;
-    /**
-     * @description Additional information text for the list item.
-     * @summary Displays supplementary information that provides extra context
-     * about the item. This could include metadata, status information, or
-     * other relevant details that don't fit in the title or description.
-     *
-     * @type {string}
-     * @memberOf ListItemComponent
-     */
-    info?: string;
-    /**
-     * @description Sub-information text displayed in the list item.
-     * @summary Provides tertiary level information that complements the info field.
-     * This is typically used for additional metadata or contextual details
-     * that are useful but not critical for understanding the item.
-     *
-     * @type {string}
-     * @memberOf ListItemComponent
-     */
-    subinfo?: string;
-    /**
-     * @description Event emitter for list item click interactions.
-     * @summary Emits custom events when the list item is clicked or when actions
-     * are performed on it. The emitted event contains information about the action,
-     * the item data, and other relevant context for parent components to handle.
-     *
-     * @type {EventEmitter<ListItemCustomEvent>}
-     * @memberOf ListItemComponent
-     */
-    clickEvent: EventEmitter<ListItemCustomEvent>;
-    /**
-     * @description Flag indicating whether slide items are currently enabled.
-     * @summary Controls the visibility of slide actions based on screen size and
-     * available operations. When true, users can swipe on the item to reveal
-     * action buttons for operations like edit and delete.
-     *
-     * @type {boolean}
-     * @default false
-     * @memberOf ListItemComponent
-     */
-    showSlideItems: boolean;
-    /**
-     * @description Current window width in pixels.
-     * @summary Stores the current browser window width which is used to determine
-     * responsive behavior, such as when to show or hide slide items based on
-     * screen size. Updated automatically on window resize events.
-     *
-     * @type {number}
-     * @memberOf ListItemComponent
-     */
-    windowWidth: number;
-    /**
-     * @description Flag indicating whether the action menu popover is currently open.
-     * @summary Tracks the state of the action menu to prevent multiple instances
-     * from being opened simultaneously and to ensure proper cleanup when actions
-     * are performed. Used for managing the popover lifecycle.
-     *
-     * @type {boolean}
-     * @default false
-     * @memberOf ListItemComponent
-     */
-    actionMenuOpen: boolean;
-    /**
-     * @description Angular NavController service for handling navigation.
-     * @summary Injected service that provides methods for programmatic navigation
-     * within the Ionic application. Used for navigating to different routes when
-     * list item actions are performed or when the item itself is clicked.
-     *
-     * @private
-     * @type {NavController}
-     * @memberOf ListItemComponent
-     */
-    private navController;
-    /**
-     * @description Creates an instance of ListItemComponent.
-     * @summary Initializes a new ListItemComponent by calling the parent class constructor
-     * with the component name for logging and identification purposes. Also registers
-     * all available Ionic icons to ensure they can be displayed in the component.
-     *
-     * @memberOf ListItemComponent
-     */
-    constructor();
-    /**
-     * @description Initializes the component after Angular first displays the data-bound properties.
-     * @summary Sets up the component by determining slide item visibility, processing boolean inputs,
-     * building CSS class names based on properties, and capturing the current window width.
-     * This method prepares the component for user interaction by ensuring all properties are
-     * properly initialized and responsive behavior is configured.
-     *
-     * @mermaid
-     * sequenceDiagram
-     *   participant A as Angular Lifecycle
-     *   participant L as ListItemComponent
-     *   participant W as Window
-     *
-     *   A->>L: ngOnInit()
-     *   L->>L: enableSlideItems()
-     *   L->>L: Process button boolean
-     *   L->>L: Build className with flex classes
-     *   alt operations exist
-     *     L->>L: Add 'action' class
-     *   end
-     *   L->>W: getWindowWidth()
-     *   W-->>L: Return current width
-     *   L->>L: Store windowWidth
-     *
-     * @return {Promise<void>}
-     * @memberOf ListItemComponent
-     */
-    ngOnInit(): Promise<void>;
-    /**
-     * @description Handles user interactions and actions performed on the list item.
-     * @summary This method is the central action handler for list item interactions. It manages
-     * event propagation, dismisses open action menus, removes focus traps, and either emits
-     * events for parent components to handle or performs navigation based on the component's
-     * route configuration. This method supports both event-driven and navigation-driven architectures.
-     *
-     * @param {CrudOperations} action - The type of CRUD operation being performed
-     * @param {Event} event - The browser event that triggered the action
-     * @param {HTMLElement} [target] - Optional target element for the event
-     * @return {Promise<boolean|void>} A promise that resolves to navigation success or void for events
-     *
-     * @mermaid
-     * sequenceDiagram
-     *   participant U as User
-     *   participant L as ListItemComponent
-     *   participant P as Parent Component
-     *   participant N as NavController
-     *   participant E as Event System
-     *
-     *   U->>L: Perform action (click/swipe)
-     *   L->>L: stopPropagation()
-     *   alt actionMenuOpen
-     *     L->>L: Dismiss action menu
-     *   end
-     *   L->>L: removeFocusTrap()
-     *   alt No route configured
-     *     L->>E: windowEventEmitter()
-     *     L->>P: clickEvent.emit()
-     *   else Route configured
-     *     L->>N: redirect(action, uid)
-     *     N-->>L: Return navigation result
-     *   end
-     *
-     * @memberOf ListItemComponent
-     */
-    handleAction(action: CrudOperations, event: Event, target?: HTMLElement): Promise<boolean | void>;
-    /**
-     * @description Responsive handler that enables or disables slide items based on screen size and operations.
-     * @summary This method is automatically called when the window is resized and also during component
-     * initialization. It determines whether slide actions should be available based on the current
-     * window width and the presence of UPDATE or DELETE operations. Slide items are typically hidden
-     * on larger screens where there's space for dedicated action buttons.
-     *
-     * @return {boolean} True if slide items should be shown, false otherwise
-     *
-     * @mermaid
-     * sequenceDiagram
-     *   participant W as Window
-     *   participant L as ListItemComponent
-     *   participant U as UI
-     *
-     *   W->>L: resize event
-     *   L->>W: getWindowWidth()
-     *   W-->>L: Return current width
-     *   L->>L: Store windowWidth
-     *   alt No operations OR width > 768px
-     *     L->>U: showSlideItems = false
-     *   else Operations include UPDATE/DELETE
-     *     L->>U: showSlideItems = true
-     *   end
-     *   L-->>U: Return showSlideItems value
-     *
-     * @memberOf ListItemComponent
-     */
-    enableSlideItems(): boolean;
-    /**
-     * @description Animates and removes an element from the DOM.
-     * @summary This method applies CSS animation classes to create a smooth fade-out effect
-     * before removing the element from the DOM. The animation enhances user experience by
-     * providing visual feedback when items are deleted or removed from lists. The timing
-     * is coordinated with the CSS animation duration to ensure the element is removed
-     * after the animation completes.
-     *
-     * @param {HTMLElement} element - The DOM element to animate and remove
-     * @return {void}
-     *
-     * @mermaid
-     * sequenceDiagram
-     *   participant L as ListItemComponent
-     *   participant E as HTMLElement
-     *   participant D as DOM
-     *
-     *   L->>E: Add animation classes
-     *   Note over E: uk-animation-fade, uk-animation-medium, uk-animation-reverse
-     *   E->>E: Start fade animation
-     *   L->>L: setTimeout(600ms)
-     *   Note over L: Wait for animation to complete
-     *   L->>D: element.remove()
-     *   D->>D: Remove element from DOM
-     *
-     * @memberOf ListItemComponent
-     */
-    removeElement(element: HTMLElement): void;
-    /**
-     * @description Navigates to a new route based on the specified action and item ID.
-     * @summary This method constructs a navigation URL using the component's route configuration,
-     * the specified action, and an item identifier. It uses Ionic's NavController to perform
-     * forward navigation with appropriate animations. This method is typically used for
-     * CRUD operations where each action (create, read, update, delete) has its own route.
-     *
-     * @param {string} action - The action to be performed (e.g., 'edit', 'view', 'delete')
-     * @param {string} [id] - The unique identifier of the item to be acted upon
-     * @return {Promise<boolean>} A promise that resolves to true if navigation was successful
-     *
-     * @mermaid
-     * sequenceDiagram
-     *   participant L as ListItemComponent
-     *   participant N as NavController
-     *   participant R as Router
-     *
-     *   L->>L: redirect(action, id)
-     *   L->>L: Construct URL: /{route}/{action}/{id}
-     *   L->>N: navigateForward(url)
-     *   N->>R: Navigate to constructed URL
-     *   R-->>N: Return navigation result
-     *   N-->>L: Return boolean success
-     *
-     * @memberOf ListItemComponent
-     */
-    redirect(action: string, id?: string): Promise<boolean>;
-    /**
-     * @description Presents the actions menu popover for the list item.
-     * @summary This method handles the display of a contextual action menu when triggered by user
-     * interaction (typically a long press or right-click). It stops event propagation to prevent
-     * unwanted side effects, removes any existing focus traps for accessibility, configures the
-     * popover with the triggering event, and opens the action menu. The menu typically contains
-     * available CRUD operations for the item.
-     *
-     * @param {Event} event - The event that triggered the action menu request
-     * @return {void}
-     *
-     * @mermaid
-     * sequenceDiagram
-     *   participant U as User
-     *   participant L as ListItemComponent
-     *   participant P as Popover
-     *   participant A as Accessibility
-     *
-     *   U->>L: Trigger action menu (long press/right-click)
-     *   L->>L: stopPropagation()
-     *   L->>A: removeFocusTrap()
-     *   L->>P: Set event reference
-     *   L->>L: actionMenuOpen = true
-     *   L->>P: Display popover with actions
-     *
-     * @memberOf ListItemComponent
-     */
-    presentActionsMenu(event: Event): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ListItemComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<ListItemComponent, "ngx-decaf-list-item", never, { "lines": { "alias": "lines"; "required": false; }; "item": { "alias": "item"; "required": false; }; "icon": { "alias": "icon"; "required": false; }; "iconSlot": { "alias": "iconSlot"; "required": false; }; "button": { "alias": "button"; "required": false; }; "title": { "alias": "title"; "required": false; }; "description": { "alias": "description"; "required": false; }; "info": { "alias": "info"; "required": false; }; "subinfo": { "alias": "subinfo"; "required": false; }; }, { "clickEvent": "clickEvent"; }, never, ["[slot='end']"], true, never>;
-}

package/dist/lib/components/model-renderer/model-renderer.component.d.ts

@@ -1,96 +0,0 @@
-import { EventEmitter, OnChanges, OnDestroy, SimpleChanges, TemplateRef, ViewContainerRef } from '@angular/core';
-import { Model } from '@decaf-ts/decorator-validation';
-import { AngularDynamicOutput, RenderedModel } from '../../engine';
-import { RendererCustomEvent } from '../../engine/types';
-import * as i0 from "@angular/core";
-/**
- * @description Component for rendering dynamic models
- * @summary This component is responsible for dynamically rendering models,
- * handling model changes, and managing event subscriptions for the rendered components.
- * It uses the NgxRenderingEngine2 to render the models and supports both string and Model inputs.
- * @class
- * @template M - Type extending Model
- * @param {Injector} injector - Angular Injector for dependency injection
- * @example
- * <ngx-decaf-model-renderer
- *   [model]="myModel"
- *   [globals]="globalVariables"
- *   (listenEvent)="handleEvent($event)">
- * </ngx-decaf-model-renderer>
- * @mermaid
- * sequenceDiagram
- *   participant App
- *   participant ModelRenderer
- *   participant RenderingEngine
- *   participant Model
- *   App->>ModelRenderer: Input model
- *   ModelRenderer->>Model: Parse if string
- *   Model-->>ModelRenderer: Parsed model
- *   ModelRenderer->>RenderingEngine: Render model
- *   RenderingEngine-->>ModelRenderer: Rendered output
- *   ModelRenderer->>ModelRenderer: Subscribe to events
- *   ModelRenderer-->>App: Emit events
- */
-export declare class ModelRendererComponent<M extends Model> implements OnChanges, OnDestroy, RenderedModel {
-    /**
-     * @description Input model to be rendered
-     * @summary Can be a Model instance or a JSON string representation of a model
-     */
-    model: M | string | undefined;
-    /**
-     * @description Global variables to be passed to the rendered component
-     */
-    globals: Record<string, unknown>;
-    /**
-     * @description Template reference for inner content
-     */
-    inner?: TemplateRef<unknown>;
-    /**
-     * @description Output of the rendered model
-     */
-    output?: AngularDynamicOutput;
-    /**
-     * @description Unique identifier for the renderer
-     */
-    rendererId?: string;
-    /**
-     * @description View container reference for dynamic component rendering
-     */
-    vcr: ViewContainerRef;
-    /**
-     * @description Event emitter for custom events from the rendered component
-     */
-    listenEvent: EventEmitter<RendererCustomEvent>;
-    /**
-     * @description Instance of the NgxRenderingEngine2
-     */
-    private render;
-    /**
-     * @description Instance of the rendered component
-     */
-    private instance;
-    private injector;
-    /**
-     * @description Refreshes the rendered model
-     * @param {string | M} model - The model to be rendered
-     */
-    private refresh;
-    /**
-     * @description Lifecycle hook that is called when data-bound properties of a directive change
-     * @param {SimpleChanges} changes - Object containing changes
-     */
-    ngOnChanges(changes: SimpleChanges): void;
-    /**
-     * @description Lifecycle hook that is called when a directive, pipe, or service is destroyed
-     * @return {Promise<void>}
-     */
-    ngOnDestroy(): Promise<void>;
-    private subscribeEvents;
-    /**
-     * @description Unsubscribes from events emitted by the rendered component
-     */
-    private unsubscribeEvents;
-    protected readonly JSON: JSON;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ModelRendererComponent<any>, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<ModelRendererComponent<any>, "ngx-decaf-model-renderer", never, { "model": { "alias": "model"; "required": true; }; "globals": { "alias": "globals"; "required": false; }; "rendererId": { "alias": "rendererId"; "required": false; }; }, { "listenEvent": "listenEvent"; }, never, never, true, never>;
-}

package/dist/lib/components/pagination/constants.d.ts

@@ -1,7 +0,0 @@
-import { BaseCustomEvent } from "../../engine";
-export type PaginationCustomEvent = BaseCustomEvent & {
-    data: {
-        page: number;
-        direction: 'next' | 'previous';
-    };
-};