@decaf-ts/for-angular 0.0.52 → 0.0.53

package/index.d.ts

@@ -1,5 +1,5 @@
 import * as i0 from '@angular/core';
-import { Type, Injector, ElementRef, EnvironmentInjector, OnChanges, OnDestroy, ChangeDetectorRef, Renderer2, EventEmitter, SimpleChanges, ViewContainerRef, TemplateRef, OnInit, AfterViewInit, ComponentMirror, ComponentRef, InjectionToken, Provider, EnvironmentProviders, ModuleWithProviders } from '@angular/core';
+import { Type, Injector, ElementRef, EnvironmentInjector, EnvironmentProviders, Provider, OnChanges, OnDestroy, ChangeDetectorRef, Renderer2, EventEmitter, SimpleChanges, ViewContainerRef, TemplateRef, OnInit, AfterViewInit, ComponentMirror, ComponentRef, InjectionToken, ModuleWithProviders } from '@angular/core';
 import { IonInput, IonSelect, IonTextarea, IonCheckbox, SpinnerTypes, InfiniteScrollCustomEvent, RefresherCustomEvent, MenuController } from '@ionic/angular';
 import { TextFieldTypes, SelectInterface, AutocompleteTypes, CheckboxCustomEvent, Color, PredefinedColors, OverlayEventDetail } from '@ionic/core';
 import * as i2 from '@angular/forms';
@@ -243,6 +243,7 @@ interface InputOption {
     text: string;
     value: string | number;
     disabled?: StringOrBoolean;
+    hidden?: StringOrBoolean;
     className?: string;
     icon?: string;
 }
@@ -968,6 +969,13 @@ type LayoutGridGap = (typeof LayoutGridGaps)[keyof typeof LayoutGridGaps];
  * @memberOf module:lib/engine/types
  */
 type ListItemPosition = (typeof ListItemPositions)[keyof typeof ListItemPositions];
+/**
+ * @description Represents an Angular dependency injection provider.
+ * @summary This type is a union of Angular's `EnvironmentProviders` and `Provider` types, allowing for flexible DI configuration.
+ * @typedef {EnvironmentProviders | Provider} AngularProvider
+ * @memberOf module:lib/engine/types
+ */
+type AngularProvider = EnvironmentProviders | Provider;
 
 /**
  * @module NgxMediaService
@@ -2891,11 +2899,11 @@ declare class CrudFieldComponent extends NgxFormFieldDirective implements OnInit
      * @summary Indicates whether the field labels should be translated based on the current language settings.
      * This is useful for applications supporting multiple languages.
      *
-     * @type {StringOrBoolean}
+     * @type {boolean}
      * @default true
      * @memberOf CrudFieldComponent
      */
-    translatable: StringOrBoolean;
+    translatable: boolean;
     constructor();
     /**
      * @description Component initialization lifecycle method.
@@ -9250,116 +9258,6 @@ declare class DecafFakerRepository<T extends Model> {
 }
 declare function getFakerData<T extends Model>(limit: number | undefined, data: Record<string, FunctionLike>, model?: string): T[];
 
-/**
- * @description Retrieves the locale context for a given class, object, or string.
- * @summary Resolves the locale context by extracting the class name or using the provided suffix.
- *
- * @param {FunctionLike | object | string} clazz - The class, object, or string to derive the locale context from.
- * @param {string} [suffix] - An optional suffix to append to the locale context.
- * @returns {string} - The resolved locale context string.
- */
-declare function getLocaleContext(clazz: FunctionLike | object | string, 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
- */
-declare function getLocaleContextByKey(locale: string, phrase: string | undefined): string;
-/**
- * @description Factory function for creating an instance of I18nLoader.
- * @summary Configures and returns an I18nLoader instance with the specified HTTP client and translation resources.
- *
- * @param {HttpClient} http - The HTTP client used to fetch translation resources.
- * @returns {TranslateLoader} - An instance of I18nLoader configured with the provided HTTP client and resources.
- */
-declare function I18nLoaderFactory(http: HttpClient): TranslateLoader;
-/**
- * @description Provides the I18nLoader configuration.
- * @summary Configures the translation resources and versioned suffix for the I18nLoader.
- *
- * @param {I18nResourceConfigType} [resources=[]] - The translation resources to be used by the loader.
- * @param {boolean} [versionedSuffix=false] - Whether to append a versioned suffix to resource URLs.
- * @returns {object} - The configuration object for the I18nLoader.
- */
-declare function provideI18nLoader(resources?: I18nResourceConfigType, versionedSuffix?: boolean): {
-    provide: i0.InjectionToken<I18nToken>;
-    useValue: {
-        resources: I18nResourceConfig[];
-        versionedSuffix: boolean;
-    };
-};
-/**
- * @description Custom implementation of TranslateLoader for loading translations.
- * @summary Fetches and merges translation resources, supporting versioned suffixes and recursive merging.
- */
-declare class I18nLoader implements TranslateLoader {
-    private http;
-    private resources;
-    private versionedSuffix;
-    /**
-     * @param {HttpClient} http - The HTTP client used to fetch translation resources.
-     * @param {I18nResourceConfig[]} [resources=[]] - The translation resources to be loaded.
-     * @param {boolean} [versionedSuffix=false] - Whether to append a versioned suffix to resource URLs.
-     */
-    constructor(http: HttpClient, resources?: I18nResourceConfig[], versionedSuffix?: boolean);
-    /**
-     * @description Appends a versioned suffix to the resource URL if enabled.
-     * @summary Generates a versioned suffix based on the current date.
-     *
-     * @param {string} suffix - The original suffix of the resource URL.
-     * @returns {string} - The modified suffix with a version string appended.
-     */
-    private getSuffix;
-    /**
-     * @description Fetches and merges translations for the specified language.
-     * @summary Loads translation resources, merges them recursively, and includes library keys.
-     *
-     * @param {string} lang - The language code for the translations to load.
-     * @returns {Observable<TranslationObject>} - An observable that emits the merged translation object.
-     */
-    getTranslation(lang: string): Observable<TranslationObject>;
-}
-/**
- * @description Custom implementation of TranslateParser for interpolation.
- * @summary Extends TranslateParser to support string formatting with parameters.
- */
-declare class I18nParser extends TranslateParser {
-    /**
-     * @description Interpolates a translation string with parameters.
-     * @summary Replaces placeholders in the translation string with parameter values.
-     *
-     * @param {string} value - The translation string to interpolate.
-     * @param {object | string} [params={}] - The parameters to replace placeholders with.
-     * @returns {string} - The interpolated translation string.
-     */
-    interpolate(value: string, params?: object | string): string;
-}
-/**
- * @description Provides the internationalization (i18n) configuration for the application.
- * @summary Configures the translation service with a fallback language, default language, custom parser, and loader.
- *
- * @param {RootTranslateServiceConfig} [config={fallbackLang: 'en', lang: 'en'}] - The configuration for the translation service, including fallback and default languages.
- * @param {I18nResourceConfigType} [resources=[]] - The translation resources to be used by the loader.
- * @param {boolean} [versionedSuffix=false] - Whether to append a versioned suffix to resource URLs.
- * @returns {Array} - An array of providers for the translation service and loader.
- */
-declare function provideI18n(config?: RootTranslateServiceConfig, resources?: I18nResourceConfigType, versionedSuffix?: boolean): (i0.EnvironmentProviders | {
-    provide: i0.InjectionToken<I18nToken>;
-    useValue: {
-        resources: I18nResourceConfig[];
-        versionedSuffix: boolean;
-    };
-} | i0.Provider[])[];
-
 declare const DB_ADAPTER_PROVIDER = "DB_ADAPTER_PROVIDER";
 /**
  * @description Injection token for registering the database adapter provider.
@@ -9422,7 +9320,7 @@ declare const I18N_CONFIG_TOKEN: InjectionToken<I18nToken>;
  *   { provide: CPTKN, useValue: provideDynamicComponents(MyComponent, AnotherComponent) }
  * ]
  */
-declare function provideDynamicComponents(...components: unknown[]): Constructor<unknown>[];
+declare function provideDecafDynamicComponents(...components: unknown[]): Constructor<unknown>[];
 /**
  * @description Retrieves the repository instance for a given model.
  * @summary Creates or retrieves a DecafRepository instance for the specified model. This function
@@ -9469,7 +9367,7 @@ declare function getModelAndRepository(model: Model | string): {
  *   provideDbAdapter(PostgresAdapter, { host: 'localhost', port: 5432 })
  * ]
  */
-declare function provideDbAdapter<DbAdapter extends {
+declare function provideDecafDbAdapter<DbAdapter extends {
     flavour: string;
 }>(clazz: Constructor<DbAdapter>, options?: KeyValue, flavour?: string): Provider;
 /**
@@ -9550,5 +9448,109 @@ declare class ForAngularCommonModule {
     static ɵinj: i0.ɵɵInjectorDeclaration<ForAngularCommonModule>;
 }
 
-export { ActionRoles, AngularEngineKeys, BaseComponentProps, CPTKN, CardComponent, ComponentEventNames, ComponentRendererComponent, ComponentsTagNames, CrudFieldComponent, CrudFormComponent, CssClasses, DB_ADAPTER_PROVIDER, DB_ADAPTER_PROVIDER_TOKEN, DecafFakerRepository, DefaultFormReactiveOptions, DefaultListEmptyOptions, DefaultModalOptions, Dynamic, DynamicModule, ElementPositions, ElementSizes, EmptyStateComponent, FieldsetComponent, FileUploadComponent, FilterComponent, ForAngularCommonModule, ForAngularComponentsModule, FormConstants, I18N_CONFIG_TOKEN, I18nLoader, I18nLoaderFactory, I18nParser, IconComponent, LOCALE_ROOT_TOKEN, LayoutComponent, LayoutGridGaps, ListComponent, ListComponentsTypes, ListItemComponent, ListItemPositions, LoggerLevels, ModalComponent, ModelRendererComponent, NgxComponentDirective, NgxEventHandler, NgxFormDirective, NgxFormFieldDirective, NgxFormService, NgxMediaService, NgxModelPageDirective, NgxPageDirective, NgxParentComponentDirective, NgxRenderingEngine, NgxSvgDirective, PaginationComponent, RouteDirections, SearchbarComponent, SteppedFormComponent, WindowColorSchemes, cleanSpaces, dataMapper, decafPageTransition, filterString, formatDate, generateRandomValue, getFakerData, getInjectablesRegistry, getLocaleContext, getLocaleContextByKey, getLocaleFromClassName, getLocaleLanguage, getLogger, getModelAndRepository, getNgxInlineModal, getNgxModalComponent, getNgxSelectOptionsModal, getOnWindow, getOnWindowDocument, getWindow, getWindowDocument, getWindowWidth, isDarkMode, isDevelopmentMode, isNotUndefined, isValidDate, itemMapper, parseToValidDate, presentNgxInlineModal, presentNgxLightBoxModal, provideDbAdapter, provideDecafPageTransition, provideDynamicComponents, provideI18n, provideI18nLoader, removeFocusTrap, setOnWindow, stringToBoolean, windowEventEmitter };
-export type { ActionRole, AngularDynamicOutput, AngularFieldDefinition, CheckboxOption, ComponentMetadata, CrudFieldOption, DecafRepository, DecafRepositoryAdapter, ElementPosition, ElementSize, FieldUpdateMode, FlexPosition, FormParent, FormParentGroup, FormServiceControl, FormServiceControls, FunctionLike, HTML5InputType, HTMLFormTarget, I18nResourceConfig, I18nResourceConfigType, I18nToken, IBaseCustomEvent, IComponentConfig, IComponentHolder, IComponentProperties, ICrudFormEvent, ICrudFormOptions, IFieldSetItem, IFieldSetValidationEvent, IFileUploadError, IFilterQuery, IFilterQueryItem, IFormComponentProperties, IFormElement, IFormReactiveSubmitEvent, IListComponentRefreshEvent, IListEmptyOptions, IMenuItem, IModelPageCustomEvent, IPaginationCustomEvent, IRenderedModel, ISortObject, IWindowResizeEvent, InputOption, KeyValue, LayoutGridGap, ListItemCustomEvent, ListItemPosition, PossibleInputTypes, RadioOption, RawQuery, SelectOption, StringOrBoolean, WindowColorScheme };
+/**
+ * @description Retrieves the locale context for a given class, object, or string.
+ * @summary Resolves the locale context by extracting the class name or using the provided suffix.
+ *
+ * @param {FunctionLike | object | string} clazz - The class, object, or string to derive the locale context from.
+ * @param {string} [suffix] - An optional suffix to append to the locale context.
+ * @returns {string} - The resolved locale context string.
+ */
+declare function getLocaleContext(clazz: FunctionLike | object | string, 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
+ */
+declare function getLocaleContextByKey(locale: string, phrase: string | undefined): string;
+/**
+ * @description Factory function for creating an instance of I18nLoader.
+ * @summary Configures and returns an I18nLoader instance with the specified HTTP client and translation resources.
+ *
+ * @param {HttpClient} http - The HTTP client used to fetch translation resources.
+ * @returns {TranslateLoader} - An instance of I18nLoader configured with the provided HTTP client and resources.
+ */
+declare function I18nLoaderFactory(http: HttpClient): TranslateLoader;
+/**
+ * @description Provides the I18nLoader configuration.
+ * @summary Configures the translation resources and versioned suffix for the I18nLoader.
+ *
+ * @param {I18nResourceConfigType} [resources=[]] - The translation resources to be used by the loader.
+ * @param {boolean} [versionedSuffix=false] - Whether to append a versioned suffix to resource URLs.
+ * @returns {object} - The configuration object for the I18nLoader.
+ */
+declare function provideDecafI18nLoader(resources?: I18nResourceConfigType, versionedSuffix?: boolean): {
+    provide: typeof I18N_CONFIG_TOKEN;
+    useValue: {
+        resources: I18nResourceConfig[];
+        versionedSuffix: boolean;
+    };
+};
+/**
+ * @description Custom implementation of TranslateLoader for loading translations.
+ * @summary Fetches and merges translation resources, supporting versioned suffixes and recursive merging.
+ */
+declare class I18nLoader implements TranslateLoader {
+    private http;
+    private resources;
+    private versionedSuffix;
+    /**
+     * @param {HttpClient} http - The HTTP client used to fetch translation resources.
+     * @param {I18nResourceConfig[]} [resources=[]] - The translation resources to be loaded.
+     * @param {boolean} [versionedSuffix=false] - Whether to append a versioned suffix to resource URLs.
+     */
+    constructor(http: HttpClient, resources?: I18nResourceConfig[], versionedSuffix?: boolean);
+    /**
+     * @description Appends a versioned suffix to the resource URL if enabled.
+     * @summary Generates a versioned suffix based on the current date.
+     *
+     * @param {string} suffix - The original suffix of the resource URL.
+     * @returns {string} - The modified suffix with a version string appended.
+     */
+    private getSuffix;
+    /**
+     * @description Fetches and merges translations for the specified language.
+     * @summary Loads translation resources, merges them recursively, and includes library keys.
+     *
+     * @param {string} lang - The language code for the translations to load.
+     * @returns {Observable<TranslationObject>} - An observable that emits the merged translation object.
+     */
+    getTranslation(lang: string): Observable<TranslationObject>;
+}
+/**
+ * @description Custom implementation of TranslateParser for interpolation.
+ * @summary Extends TranslateParser to support string formatting with parameters.
+ */
+declare class I18nParser extends TranslateParser {
+    /**
+     * @description Interpolates a translation string with parameters.
+     * @summary Replaces placeholders in the translation string with parameter values.
+     *
+     * @param {string} value - The translation string to interpolate.
+     * @param {object | string} [params={}] - The parameters to replace placeholders with.
+     * @returns {string} - The interpolated translation string.
+     */
+    interpolate(value: string, params?: object | string): string;
+}
+/**
+ * @description Provides the internationalization (i18n) configuration for the application.
+ * @summary Configures the translation service with a fallback language, default language, custom parser, and loader.
+ *
+ * @param {RootTranslateServiceConfig} [config={fallbackLang: 'en', lang: 'en'}] - The configuration for the translation service, including fallback and default languages.
+ * @param {I18nResourceConfigType} [resources=[]] - The translation resources to be used by the loader.
+ * @param {boolean} [versionedSuffix=false] - Whether to append a versioned suffix to resource URLs.
+ * @returns {AngularProvider[]} - An array of providers for the translation service and loader.
+ */
+declare function provideDecafI18nConfig(config?: RootTranslateServiceConfig, resources?: I18nResourceConfigType, versionedSuffix?: boolean): AngularProvider[];
+
+export { ActionRoles, AngularEngineKeys, BaseComponentProps, CPTKN, CardComponent, ComponentEventNames, ComponentRendererComponent, ComponentsTagNames, CrudFieldComponent, CrudFormComponent, CssClasses, DB_ADAPTER_PROVIDER, DB_ADAPTER_PROVIDER_TOKEN, DecafFakerRepository, DefaultFormReactiveOptions, DefaultListEmptyOptions, DefaultModalOptions, Dynamic, DynamicModule, ElementPositions, ElementSizes, EmptyStateComponent, FieldsetComponent, FileUploadComponent, FilterComponent, ForAngularCommonModule, ForAngularComponentsModule, FormConstants, I18N_CONFIG_TOKEN, I18nLoader, I18nLoaderFactory, I18nParser, IconComponent, LOCALE_ROOT_TOKEN, LayoutComponent, LayoutGridGaps, ListComponent, ListComponentsTypes, ListItemComponent, ListItemPositions, LoggerLevels, ModalComponent, ModelRendererComponent, NgxComponentDirective, NgxEventHandler, NgxFormDirective, NgxFormFieldDirective, NgxFormService, NgxMediaService, NgxModelPageDirective, NgxPageDirective, NgxParentComponentDirective, NgxRenderingEngine, NgxSvgDirective, PaginationComponent, RouteDirections, SearchbarComponent, SteppedFormComponent, WindowColorSchemes, cleanSpaces, dataMapper, decafPageTransition, filterString, formatDate, generateRandomValue, getFakerData, getInjectablesRegistry, getLocaleContext, getLocaleContextByKey, getLocaleFromClassName, getLocaleLanguage, getLogger, getModelAndRepository, getNgxInlineModal, getNgxModalComponent, getNgxSelectOptionsModal, getOnWindow, getOnWindowDocument, getWindow, getWindowDocument, getWindowWidth, isDarkMode, isDevelopmentMode, isNotUndefined, isValidDate, itemMapper, parseToValidDate, presentNgxInlineModal, presentNgxLightBoxModal, provideDecafDbAdapter, provideDecafDynamicComponents, provideDecafI18nConfig, provideDecafI18nLoader, provideDecafPageTransition, removeFocusTrap, setOnWindow, stringToBoolean, windowEventEmitter };
+export type { ActionRole, AngularDynamicOutput, AngularFieldDefinition, AngularProvider, CheckboxOption, ComponentMetadata, CrudFieldOption, DecafRepository, DecafRepositoryAdapter, ElementPosition, ElementSize, FieldUpdateMode, FlexPosition, FormParent, FormParentGroup, FormServiceControl, FormServiceControls, FunctionLike, HTML5InputType, HTMLFormTarget, I18nResourceConfig, I18nResourceConfigType, I18nToken, IBaseCustomEvent, IComponentConfig, IComponentHolder, IComponentProperties, ICrudFormEvent, ICrudFormOptions, IFieldSetItem, IFieldSetValidationEvent, IFileUploadError, IFilterQuery, IFilterQueryItem, IFormComponentProperties, IFormElement, IFormReactiveSubmitEvent, IListComponentRefreshEvent, IListEmptyOptions, IMenuItem, IModelPageCustomEvent, IPaginationCustomEvent, IRenderedModel, ISortObject, IWindowResizeEvent, InputOption, KeyValue, LayoutGridGap, ListItemCustomEvent, ListItemPosition, PossibleInputTypes, RadioOption, RawQuery, SelectOption, StringOrBoolean, WindowColorScheme };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@decaf-ts/for-angular",
-  "version": "0.0.52",
+  "version": "0.0.53",
   "author": "Tiago Venceslau and Contributors",
   "license": "MPL-2.0 OR AGPL-3.0",
   "repository": {