@decaf-ts/for-angular 0.0.11 → 0.0.13

package/dist/lib/for-angular.module.d.ts

@@ -1,45 +0,0 @@
-import { ModuleWithProviders } from '@angular/core';
-import { Logger } from '@decaf-ts/logging';
-import { FunctionLike } from './engine';
-import * as i0 from "@angular/core";
-import * as i1 from "@ionic/angular/standalone";
-import * as i2 from "@angular/common";
-import * as i3 from "@angular/forms";
-import * as i4 from "@ngx-translate/core";
-export declare function getLogger(instance: string | FunctionLike | unknown): Logger;
-/**
- * @description Main Angular module for the Decaf framework
- * @summary The ForAngularModule provides the core functionality for integrating Decaf with Angular applications.
- * It imports and exports common Angular and Ionic components and modules needed for Decaf applications,
- * including form handling, translation support, and Ionic UI components. This module can be imported
- * directly or via the forRoot() method for proper initialization in the application's root module.
- *
- * @class ForAngularModule
- * @example
- * ```typescript
- * // In your app module:
- * @NgModule({
- *   imports: [
- *     ForAngularModule.forRoot(),
- *     // other imports
- *   ],
- *   // ...
- * })
- * export class AppModule {}
- * ```
- */
-export declare class ForAngularModule {
-    /**
-     * @description Creates a module with providers for root module import
-     * @summary This static method provides the proper way to import the ForAngularModule in the application's
-     * root module. It returns a ModuleWithProviders object that includes the ForAngularModule itself.
-     * Using forRoot() ensures that the module and its providers are properly initialized and only
-     * instantiated once in the application.
-     *
-     * @return {ModuleWithProviders<ForAngularModule>} The module with its providers
-     */
-    static forRoot(): ModuleWithProviders<ForAngularModule>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ForAngularModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<ForAngularModule, never, [typeof i1.IonApp, typeof i1.IonRouterOutlet, typeof i1.IonSplitPane, typeof i1.IonImg, typeof i1.IonText, typeof i1.IonTitle, typeof i1.IonButton, typeof i1.IonRouterLink, typeof i1.IonContent, typeof i2.CommonModule, typeof i3.FormsModule, typeof i3.ReactiveFormsModule, typeof i4.TranslateModule, typeof i4.TranslatePipe], [typeof i1.IonApp, typeof i1.IonRouterOutlet, typeof i1.IonSplitPane, typeof i1.IonImg, typeof i1.IonText, typeof i1.IonTitle, typeof i1.IonButton, typeof i1.IonRouterLink, typeof i1.IonContent, typeof i2.CommonModule, typeof i3.FormsModule, typeof i3.ReactiveFormsModule, typeof i4.TranslateModule, typeof i4.TranslatePipe]>;
-    static ɵinj: i0.ɵɵInjectorDeclaration<ForAngularModule>;
-}

package/dist/lib/helpers/index.d.ts

@@ -1,12 +0,0 @@
-/**
- * @module helpers
- * @description Utility helpers for Angular Decaf applications
- * @summary The helpers module provides a collection of utility functions and types
- * that assist with common tasks in Decaf Angular applications. It includes functions
- * for array manipulation, date formatting, logging, string operations, and various
- * utility functions for working with Angular components and services. These helpers
- * simplify common operations and promote code reuse across the application.
- * Key exports include logging utilities, string manipulation functions, and component
- * utility functions.
- */
-export * from './utils';

package/dist/lib/helpers/utils.d.ts

@@ -1,253 +0,0 @@
-import { InjectablesRegistry } from '@decaf-ts/injectable-decorators';
-import { KeyValue, StringOrBoolean } from '../engine/types';
-import { FunctionLike } from '../engine/types';
-/**
- * @description Retrieves the singleton instance of the injectables registry
- * @summary This function implements the singleton pattern for the InjectablesRegistry.
- * It returns the existing registry instance if one exists, or creates a new instance
- * if none exists. The registry is used to store and retrieve injectable dependencies
- * throughout the application.
- *
- * @return {InjectablesRegistry} The singleton injectables registry instance
- *
- * @function getInjectablesRegistry
- * @memberOf module:for-angular
- */
-export declare function getInjectablesRegistry(): InjectablesRegistry;
-/**
- * @description Determines if the application is running in development mode
- * @summary This function checks whether the application is currently running in a development
- * environment. It uses Angular's isDevMode() function and also checks the window context
- * and hostname against the provided context parameter. This is useful for enabling
- * development-specific features or logging.
- *
- * @param {string} [context='localhost'] - The context string to check against the current environment
- * @return {boolean} True if the application is running in development mode, false otherwise
- *
- * @function isDevelopmentMode
- * @memberOf module:for-angular
- */
-export declare function isDevelopmentMode(context?: string): boolean;
-/**
- * @description Dispatches a custom event to the document window
- * @summary This function creates and dispatches a custom event to the browser window.
- * It's useful for cross-component communication or for triggering application-wide events.
- * The function allows specifying the event name, detail data, and additional event properties.
- *
- * @param {string} name - The name of the custom event to dispatch
- * @param {unknown} detail - The data to include in the event's detail property
- * @param {object} [props] - Optional additional properties for the custom event
- * @return {void}
- *
- * @function windowEventEmitter
- * @memberOf module:for-angular
- */
-export declare function windowEventEmitter(name: string, detail: unknown, props?: object): void;
-/**
- * @description Retrieves a property from the window's document object
- * @summary This function provides a safe way to access properties on the window's document object.
- * It uses the getWindowDocument function to get a reference to the document, then accesses
- * the specified property. This is useful for browser environment interactions that need
- * to access document properties.
- *
- * @param {string} key - The name of the property to retrieve from the document object
- * @return {any} The value of the specified property, or undefined if the document or property doesn't exist
- *
- * @function getOnWindowDocument
- * @memberOf module:for-angular
- */
-export declare function getOnWindowDocument(key: string): Document | undefined;
-/**
- * @description Retrieves the document object from the window
- * @summary This function provides a safe way to access the document object from the window.
- * It uses the getOnWindow function to retrieve the 'document' property from the window object.
- * This is useful for browser environment interactions that need access to the document.
- *
- * @return {Document | undefined} The window's document object, or undefined if it doesn't exist
- *
- * @function getWindowDocument
- * @memberOf module:for-angular
- */
-export declare function getWindowDocument(): Document | undefined;
-/**
- * @description Retrieves a property from the window object
- * @summary This function provides a safe way to access properties on the window object.
- * It uses the getWindow function to get a reference to the window, then accesses
- * the specified property. This is useful for browser environment interactions that need
- * to access window properties or APIs.
- *
- * @param {string} key - The name of the property to retrieve from the window object
- * @return {unknown | undefined} The value of the specified property, or undefined if the window or property doesn't exist
- *
- * @function getOnWindow
- * @memberOf module:for-angular
- */
-export declare function getOnWindow(key: string): unknown | undefined;
-/**
- * @description Sets a property on the window object
- * @summary This function provides a way to set properties on the window object.
- * It uses the getWindow function to get a reference to the window, then sets
- * the specified property to the provided value. This is useful for storing
- * global data or functions that need to be accessible across the application.
- *
- * @param {string} key - The name of the property to set on the window object
- * @param {any} value - The value to assign to the property
- * @return {void}
- *
- * @function setOnWindow
- * @memberOf module:for-angular
- */
-export declare function setOnWindow(key: string, value: unknown): void;
-/**
- * @description Retrieves the global window object
- * @summary This function provides a safe way to access the global window object.
- * It uses globalThis to ensure compatibility across different JavaScript environments.
- * This is the core function used by other window-related utility functions to
- * access the window object.
- *
- * @return {Window} The global window object
- *
- * @function getWindow
- * @memberOf module:for-angular
- */
-export declare function getWindow(): Window & KeyValue;
-/**
- * @description Retrieves the width of the browser window
- * @summary This function provides a convenient way to get the current width of the browser window.
- * It uses the getOnWindow function to access the 'innerWidth' property of the window object.
- * This is useful for responsive design implementations and viewport-based calculations.
- *
- * @return {number | undefined} The current width of the browser window in pixels
- *
- * @function getWindowWidth
- * @memberOf module:for-angular
- */
-export declare function getWindowWidth(): number;
-/**
- * @description Checks if a value is  not undefined
- * @summary This utility function determines whether a given value is not undefined.
- * It's a simple wrapper that makes code more readable when checking for defined values.
- * The function is particularly useful for checking StringOrBoolean properties that might be undefined.
- *
- * @param {StringOrBoolean | undefined} prop - The property to check
- * @return {boolean} True if the property is not undefined, false otherwise
- *
- * @function isNotUndefined
- * @memberOf module:for-angular
- */
-export declare function isNotUndefined(prop: StringOrBoolean | undefined): boolean;
-/**
- * @description Generates a locale string from a class name or instance
- * @summary This utility function converts a class name or instance into a locale string
- * that can be used for internationalization purposes. It handles different input types
- * (string, function, or object) and applies formatting rules to generate a consistent
- * locale identifier. For short names (less than 3 parts), it reverses the dot-separated
- * string. For longer names, it uses the last part as a prefix and joins the rest with
- * underscores.
- *
- * @param {string|FunctionLike|object} instance - The input to generate the locale from (class name, constructor, or instance)
- * @param {string} [suffix] - Optional string to append to the instance name before processing
- * @return {string} A formatted locale string derived from the input
- *
- * @function getLocaleFromClassName
- * @memberOf module:for-angular
- */
-export declare function getLocaleFromClassName(instance: string | FunctionLike | object, suffix?: string): string;
-/**
- * @description Generates a localized string by combining locale and phrase
- * @summary This utility function creates a properly formatted locale string by combining
- * a locale identifier with a phrase. It handles edge cases such as empty phrases,
- * missing locales, and phrases that already include the locale prefix. This function
- * is useful for ensuring consistent formatting of localized strings throughout the application.
- *
- * @param {string} locale - The locale identifier (e.g., 'en', 'fr')
- * @param {string | undefined} phrase - The phrase to localize
- * @return {string} The formatted locale string, or empty string if phrase is undefined
- *
- * @function generateLocaleFromString
- * @memberOf module:for-angular
- */
-export declare function generateLocaleFromString(locale: string, phrase: string | undefined): string;
-/**
- * @description Retrieves the current locale language
- * @summary This utility function gets the current locale language based on the user's browser settings.
- * It provides a consistent way to access the user's language preference throughout the application.
- * The function returns the browser's navigator.language value, defaulting to 'en' if not available.
- *
- * @return {string} The current locale language (e.g., 'en', 'fr')
- *
- * @function getLocaleLanguage
- * @memberOf module:for-angular
- */
-export declare function getLocaleLanguage(): string;
-/**
- * @description Generates a random string or number of specified length
- * @summary This utility function creates a random string of a specified length.
- * It can generate either alphanumeric strings (including uppercase and lowercase letters)
- * or numeric-only strings. This is useful for creating random IDs, temporary passwords,
- * or other random identifiers throughout the application.
- *
- * @param {number} [length=8] - The length of the random value to generate
- * @param {boolean} [onlyNumbers=false] - Whether to generate only numeric characters
- * @return {string} A randomly generated string of the specified length and character set
- *
- * @function generateRandomValue
- * @memberOf module:for-angular
- */
-export declare function generateRandomValue(length?: number, onlyNumbers?: boolean): string;
-/**
- * Converts a string representation of a boolean or a boolean value to a boolean type.
- *
- * @export
- * @param {('true' | 'false' | boolean)} prop - The value to convert. Can be the string 'true', 'false', or a boolean.
- * @returns {boolean} The boolean representation of the input value. Returns true if the input is the string 'true' or boolean true, false otherwise.
- */
-export declare function stringToBoolean(prop: 'true' | 'false' | boolean): boolean;
-/**
- * Checks if a value is a valid Date object
- *
- * @param {(string | Date | number)} date - The value to check. Can be a Date object, a timestamp number, or a date string
- * @return {boolean} Returns true if the value is a valid Date object (not NaN), otherwise false
- */
-export declare function isValidDate(date: string | Date | number): boolean;
-/**
- * Formats a date into a localized string representation
- *
- * @param {(string | Date | number)} date - The date to format. Can be a Date object, a timestamp number, or a date string
- * @param {string} [locale] - The locale to use for formatting. If not provided, the system's locale will be used
- * @return {(Date | string)} A formatted date string in the format DD/MM/YYYY according to the specified locale,
- *                           or the original input as a string if the date is invalid
- */
-export declare function formatDate(date: string | Date | number, locale?: string | undefined): Date | string;
-/**
- * Attempts to parse a date string, Date object, or number into a valid Date object
- *
- * @param {(string | Date | number)} date - The date to parse. Can be a Date object, a timestamp number,
- *                                         or a date string in the format "DD/MM/YYYY HH:MM:SS:MS"
- * @return {(Date | null)} A valid Date object if parsing is successful, or null if the date is invalid
- *                         or doesn't match the expected format
- */
-export declare function parseToValidDate(date: string | Date | number): Date | null;
-/**
- * Maps an item object using a provided mapper object and optional additional properties.
- *
- * @param {KeyValue} item - The source object to be mapped.
- * @param {KeyValue} mapper - An object that defines the mapping rules. Keys represent the new property names,
- *                            and values represent the path to the corresponding values in the source object.
- * @param {KeyValue} [props] - Optional additional properties to be included in the mapped object.
- * @returns {KeyValue} A new object with properties mapped according to the mapper object and including any additional properties.
- */
-export declare function itemMapper(item: KeyValue, mapper: KeyValue, props?: KeyValue): KeyValue;
-/**
- * Maps an array of data objects using a provided mapper object.
- *
- * @template T - The type of the resulting mapped items.
- * @param {any[]} data - The array of data objects to be mapped.
- * @param {KeyValue} mapper - An object that defines the mapping rules.
- * @param {KeyValue} [props] - Additional properties to be included in the mapped items.
- *
- * @returns {T[]} - The array of mapped items. If an item in the original array does not have any non-null values after mapping,
- * the original item is returned instead.
- */
-export declare function dataMapper<T>(data: T[], mapper: KeyValue, props?: KeyValue): T[];
-export declare function removeFocusTrap(): void;

package/dist/lib/index.d.ts

@@ -1,5 +0,0 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@decaf-ts/for-angular" />
-export * from './public-apis';

package/dist/lib/interfaces.d.ts

@@ -1,28 +0,0 @@
-import { FormGroup } from '@angular/forms';
-import { ElementRef } from '@angular/core';
-/**
- * @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 ComponentHolder
- * @memberOf module:for-angular
- */
-export interface ComponentHolder {
-    /**
-     * @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 ComponentHolder to include a FormGroup for form handling capabilities
- * @interface FormElement
- * @memberOf module:for-angular
- */
-export interface FormElement extends ComponentHolder {
-    /**
-     * @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;
-}

package/dist/lib/public-apis.d.ts

@@ -1,13 +0,0 @@
-import '@decaf-ts/ui-decorators';
-export * from './components';
-export * from './engine';
-export * from './directives';
-export * from './helpers';
-export * from './for-angular.module';
-/**
- * @description Angular integration for the Decaf framework
- * @summary This module provides Angular components and services for integrating with the Decaf framework.
- * It includes components for rendering models, CRUD operations, and form handling, as well as
- * rendering engines and utility functions to facilitate Angular application development with Decaf.
- * @module for-angular
- */