@decaf-ts/for-angular 0.0.54 → 0.0.55

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/index.d.ts CHANGED
@@ -10,7 +10,7 @@ import * as _decaf_ts_decorator_validation from '@decaf-ts/decorator-validation'
10
10
  import { Model, VALIDATION_PARENT_KEY, ModelConstructor } from '@decaf-ts/decorator-validation';
11
11
  import { RepositoryFlags, Context, CrudOperations, OperationKeys, IRepository } from '@decaf-ts/db-decorators';
12
12
  import * as _ionic_angular_standalone from '@ionic/angular/standalone';
13
- import { ModalOptions, ItemReorderEventDetail, IonModal } from '@ionic/angular/standalone';
13
+ import { ModalOptions, SelectCustomEvent, ItemReorderEventDetail, IonModal } from '@ionic/angular/standalone';
14
14
  import { Constructor } from '@decaf-ts/decoration';
15
15
  import { Router } from '@angular/router';
16
16
  import * as i1 from '@angular/common';
@@ -21,7 +21,7 @@ import { HttpClient } from '@angular/common/http';
21
21
  import { Observable, Subscription } from 'rxjs';
22
22
  import { SafeHtml, DomSanitizer, Title } from '@angular/platform-browser';
23
23
  import { InjectablesRegistry } from '@decaf-ts/injectable-decorators';
24
- import { Logger } from '@decaf-ts/logging';
24
+ import { LoggedClass, Logger } from '@decaf-ts/logging';
25
25
 
26
26
  /**
27
27
  * @module lib/engine/interfaces
@@ -2421,7 +2421,22 @@ declare abstract class NgxFormFieldDirective extends NgxComponentDirective imple
2421
2421
  * @public
2422
2422
  */
2423
2423
  setValue(value: unknown): void;
2424
- handleModalChildChanges(): void;
2424
+ /**
2425
+ * @description Clears the current form control value as a response to a UI interact
2426
+ * @summary Set field value as undefined and prevents event propagation.
2427
+ * @param {Event} event - The value to set
2428
+ * @return {void}
2429
+ * @public
2430
+ */
2431
+ handleClearValue(event: Event): void;
2432
+ /**
2433
+ * @description Handles IonSelect change events emitted from modal child components.
2434
+ * @summary Forces change detection when rendered inside a modal and synchronizes the select value with the directive state.
2435
+ * @param {SelectCustomEvent<SelectChangeEventDetail>} event - IonSelect change event containing the selected value.
2436
+ * @return {void}
2437
+ * @public
2438
+ */
2439
+ handleModalChildChanges(event?: SelectCustomEvent): void;
2425
2440
  /**
2426
2441
  * @description Retrieves validation error messages for the field.
2427
2442
  * @summary Checks the form control for validation errors and returns formatted error messages.
@@ -3779,7 +3794,7 @@ declare class EmptyStateComponent extends CardComponent implements OnInit {
3779
3794
  * - A Promise resolving to the navigation result if buttonLink is a URL
3780
3795
  * @memberOf EmptyStateComponent
3781
3796
  */
3782
- handleClick(): boolean | void | Promise<boolean> | FunctionLike;
3797
+ handleClick(): Promise<void>;
3783
3798
  /**
3784
3799
  * @description Generates a localized and sanitized subtitle for search results.
3785
3800
  * @summary This method takes a content string, typically the subtitle, and processes it
@@ -4117,7 +4132,7 @@ declare class FieldsetComponent extends NgxFormDirective implements OnInit, Afte
4117
4132
  * @memberOf FieldsetComponent
4118
4133
  */
4119
4134
  ngAfterViewInit(): Promise<void>;
4120
- refresh(): Promise<void>;
4135
+ refresh(operation: CrudOperationKeys): Promise<void>;
4121
4136
  /**
4122
4137
  * @description Handles removal of the fieldset with slide animation.
4123
4138
  * @summary Initiates the removal process for the fieldset with a smooth slide-up animation.
@@ -5175,7 +5190,7 @@ declare class ListComponent extends NgxComponentDirective implements OnInit, OnD
5175
5190
  * @type {string | KeyValue | undefined}
5176
5191
  * @memberOf ListComponent
5177
5192
  */
5178
- sortDirection: OrderDirection;
5193
+ sortBy: string;
5179
5194
  /**
5180
5195
  * @description Sorting parameters for data fetching.
5181
5196
  * @summary Specifies how the fetched data should be sorted. This can be provided
@@ -5184,7 +5199,7 @@ declare class ListComponent extends NgxComponentDirective implements OnInit, OnD
5184
5199
  * @type {string | KeyValue | undefined}
5185
5200
  * @memberOf ListComponent
5186
5201
  */
5187
- sortBy: string;
5202
+ sortDirection: OrderDirection;
5188
5203
  /**
5189
5204
  * @description Controls whether sorting functionality is disabled.
5190
5205
  * @summary When set to true, disables the sort controls and prevents users from
@@ -5735,7 +5750,7 @@ declare class ListComponent extends NgxComponentDirective implements OnInit, OnD
5735
5750
  mapResults(data: KeyValue[]): KeyValue[];
5736
5751
  parseSearchValue(): string | IFilterQuery;
5737
5752
  static ɵfac: i0.ɵɵFactoryDeclaration<ListComponent, never>;
5738
- static ɵcmp: i0.ɵɵComponentDeclaration<ListComponent, "ngx-decaf-list", never, { "type": { "alias": "type"; "required": false; }; "showSearchbar": { "alias": "showSearchbar"; "required": false; }; "data": { "alias": "data"; "required": false; }; "source": { "alias": "source"; "required": false; }; "start": { "alias": "start"; "required": false; }; "limit": { "alias": "limit"; "required": false; }; "loadMoreData": { "alias": "loadMoreData"; "required": false; }; "lines": { "alias": "lines"; "required": false; }; "inset": { "alias": "inset"; "required": false; }; "scrollThreshold": { "alias": "scrollThreshold"; "required": false; }; "scrollPosition": { "alias": "scrollPosition"; "required": false; }; "loadingText": { "alias": "loadingText"; "required": false; }; "showRefresher": { "alias": "showRefresher"; "required": false; }; "createButton": { "alias": "createButton"; "required": false; }; "loadingSpinner": { "alias": "loadingSpinner"; "required": false; }; "enableFilter": { "alias": "enableFilter"; "required": false; }; "sortDirection": { "alias": "sortDirection"; "required": false; }; "sortBy": { "alias": "sortBy"; "required": false; }; "disableSort": { "alias": "disableSort"; "required": false; }; "empty": { "alias": "empty"; "required": false; }; }, { "clickEvent": "clickEvent"; }, never, ["*"], true, never>;
5753
+ static ɵcmp: i0.ɵɵComponentDeclaration<ListComponent, "ngx-decaf-list", never, { "type": { "alias": "type"; "required": false; }; "showSearchbar": { "alias": "showSearchbar"; "required": false; }; "data": { "alias": "data"; "required": false; }; "source": { "alias": "source"; "required": false; }; "start": { "alias": "start"; "required": false; }; "limit": { "alias": "limit"; "required": false; }; "loadMoreData": { "alias": "loadMoreData"; "required": false; }; "lines": { "alias": "lines"; "required": false; }; "inset": { "alias": "inset"; "required": false; }; "scrollThreshold": { "alias": "scrollThreshold"; "required": false; }; "scrollPosition": { "alias": "scrollPosition"; "required": false; }; "loadingText": { "alias": "loadingText"; "required": false; }; "showRefresher": { "alias": "showRefresher"; "required": false; }; "createButton": { "alias": "createButton"; "required": false; }; "loadingSpinner": { "alias": "loadingSpinner"; "required": false; }; "enableFilter": { "alias": "enableFilter"; "required": false; }; "sortBy": { "alias": "sortBy"; "required": false; }; "sortDirection": { "alias": "sortDirection"; "required": false; }; "disableSort": { "alias": "disableSort"; "required": false; }; "empty": { "alias": "empty"; "required": false; }; }, { "clickEvent": "clickEvent"; }, never, ["*"], true, never>;
5739
5754
  }
5740
5755
 
5741
5756
  /**
@@ -7242,6 +7257,16 @@ declare class ModalComponent extends NgxParentComponentDirective implements OnIn
7242
7257
  * @returns {Promise<IonModal>} - A promise that resolves with the modal instance.
7243
7258
  */
7244
7259
  declare function getNgxModalComponent(props?: Partial<ModalComponent>, modalProps?: Partial<ModalOptions>, injector?: EnvironmentInjector): Promise<IonModal>;
7260
+ /**
7261
+ * @description Retrieves a modal component instance.
7262
+ * @summary Creates and initializes a modal component with the provided properties and options.
7263
+ *
7264
+ * @param {Partial<ModalComponent>} [props={}] - Properties to initialize the modal component.
7265
+ * @param {Partial<ModalOptions>} [modalProps={}] - Additional modal options.
7266
+ * @param {EnvironmentInjector} [injector] - Optional environment injector for dependency injection.
7267
+ * @returns {Promise<IonModal>} - A promise that resolves with the modal instance.
7268
+ */
7269
+ declare function getNgxModalCrudComponent(model: Partial<Model>, props?: Partial<ModalComponent>, modalProps?: Partial<ModalOptions>, injector?: EnvironmentInjector): Promise<IonModal>;
7245
7270
  /**
7246
7271
  * @description Presents a lightbox modal with inline content.
7247
7272
  * @summary Displays a modal in lightbox mode with the specified content and properties.
@@ -7300,7 +7325,7 @@ declare class IconComponent implements OnInit {
7300
7325
  buttonShape: 'round' | 'default';
7301
7326
  width: string;
7302
7327
  size?: 'large' | 'small' | 'default';
7303
- type: 'image' | 'ionic';
7328
+ type: 'image' | 'ionic' | 'icon';
7304
7329
  isSvg: boolean;
7305
7330
  initialized: boolean;
7306
7331
  inline: boolean;
@@ -8591,9 +8616,10 @@ declare class NgxFormService {
8591
8616
  */
8592
8617
 
8593
8618
  declare abstract class NgxEventHandler extends DecafEventHandler {
8619
+ changeDetectorRef: ChangeDetectorRef;
8594
8620
  constructor();
8595
- refresh(args?: unknown[]): Promise<void>;
8596
- preview(args?: unknown[]): Promise<void>;
8621
+ refresh(...args: unknown[]): Promise<void>;
8622
+ preview(...args: unknown[]): Promise<void>;
8597
8623
  }
8598
8624
 
8599
8625
  /**
@@ -9253,12 +9279,23 @@ declare function isDarkMode(): Promise<boolean>;
9253
9279
  * @memberOf module:lib/helpers/utils
9254
9280
  */
9255
9281
  declare function filterString(original: string | string[], value: string, contain?: boolean): string;
9282
+ /**
9283
+ * @summary Retrieves the icon associated with a menu item based on its label.
9284
+ *
9285
+ * @param {string} label - The label of the menu item to search for. The search is case-insensitive.
9286
+ * @param {IMenuItem[]} menu - An array of menu items to search within.
9287
+ * @returns {string} The icon associated with the menu item if found, otherwise an empty string.
9288
+ */
9289
+ declare function getMenuIcon(label: string, menu: IMenuItem[]): string;
9256
9290
 
9257
- declare class DecafFakerRepository<T extends Model> {
9291
+ declare class DecafFakerRepository<T extends Model> extends LoggedClass {
9258
9292
  protected model: string | Model;
9259
9293
  protected limit: number;
9294
+ protected propFnMapper?: KeyValue;
9260
9295
  protected data: T[];
9261
9296
  protected _repository: DecafRepository<Model> | undefined;
9297
+ protected pk: string | undefined;
9298
+ protected pkType?: string;
9262
9299
  constructor(model: string | Model, limit?: number);
9263
9300
  protected get repository(): DecafRepository<Model>;
9264
9301
  initialize(): Promise<void>;
@@ -9560,5 +9597,5 @@ declare class I18nParser extends TranslateParser {
9560
9597
  */
9561
9598
  declare function provideDecafI18nConfig(config?: RootTranslateServiceConfig, resources?: I18nResourceConfigType, versionedSuffix?: boolean): AngularProvider[];
9562
9599
 
9563
- 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, SelectFieldInterfaces, 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 };
9600
+ 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, SelectFieldInterfaces, SteppedFormComponent, WindowColorSchemes, cleanSpaces, dataMapper, decafPageTransition, filterString, formatDate, generateRandomValue, getFakerData, getInjectablesRegistry, getLocaleContext, getLocaleContextByKey, getLocaleFromClassName, getLocaleLanguage, getLogger, getMenuIcon, getModelAndRepository, getNgxInlineModal, getNgxModalComponent, getNgxModalCrudComponent, getNgxSelectOptionsModal, getOnWindow, getOnWindowDocument, getWindow, getWindowDocument, getWindowWidth, isDarkMode, isDevelopmentMode, isNotUndefined, isValidDate, itemMapper, parseToValidDate, presentNgxInlineModal, presentNgxLightBoxModal, provideDecafDbAdapter, provideDecafDynamicComponents, provideDecafI18nConfig, provideDecafI18nLoader, provideDecafPageTransition, removeFocusTrap, setOnWindow, stringToBoolean, windowEventEmitter };
9564
9601
  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, IModelComponentSubmitEvent, IPaginationCustomEvent, IRenderedModel, ISortObject, IWindowResizeEvent, InputOption, KeyValue, LayoutGridGap, ListItemCustomEvent, ListItemPosition, PossibleInputTypes, RadioOption, RawQuery, SelectOption, StringOrBoolean, WindowColorScheme };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@decaf-ts/for-angular",
3
- "version": "0.0.54",
3
+ "version": "0.0.55",
4
4
  "author": "Tiago Venceslau and Contributors",
5
5
  "license": "MPL-2.0 OR AGPL-3.0",
6
6
  "repository": {