@igo2/common 20.0.1 → 20.1.0-next.10

package/entity/index.d.ts

@@ -1,10 +1,11 @@
 import { Observable, ReplaySubject, BehaviorSubject } from 'rxjs';
-import * as i0 from '@angular/core';
-import { ChangeDetectorRef, OnInit, OnDestroy, EventEmitter, OnChanges, ElementRef, SimpleChanges, TrackByFunction } from '@angular/core';
+import * as _angular_core from '@angular/core';
+import { ChangeDetectorRef, OnInit, OnDestroy, OnChanges, ElementRef, SimpleChanges, TrackByFunction } from '@angular/core';
+import * as _igo2_common_entity from '@igo2/common/entity';
 import { FocusMonitor } from '@angular/cdk/a11y';
 import { NgControl, NgForm, FormControlName, UntypedFormGroup } from '@angular/forms';
 import { ErrorStateMatcher } from '@angular/material/core';
-import { MatPaginator, PageEvent } from '@angular/material/paginator';
+import { MatPaginator } from '@angular/material/paginator';
 import { MatTableDataSource } from '@angular/material/table';
 
 declare enum EntityOperationType {
@@ -86,28 +87,7 @@ interface EntityTableColumnValidation {
 interface TableRelation {
     table: string;
 }
-interface EntityTableColumn {
-    validation?: EntityTableColumnValidation;
-    name: string;
-    title: string;
-    renderer?: EntityTableColumnRenderer;
-    valueAccessor?: (entity: object, record: EntityRecord<object>) => any;
-    visible?: boolean;
-    linkColumnForce?: string;
-    sort?: boolean;
-    type?: string;
-    multiple?: boolean;
-    domainValues?: SelectOption[];
-    relation?: TableRelation;
-    tooltip?: string;
-    cellClassFunc?: (entity: object, record: EntityRecord<object>) => Record<string, boolean>;
-    step?: number;
-    icon?: string;
-    onBlur?: (event: Event) => void;
-    onChange?: (event: Event) => void;
-    onClick?: (event: Event) => void;
-    onFocus?: (event: Event) => void;
-}
+type EntityTableColumn = SelectEntityTableColumn | BaseEntityTableColumn;
 interface SelectOption {
     id: number;
     value: string;
@@ -121,6 +101,90 @@ interface EntityTableButton {
     style?: 'mat-mini-fab' | 'mat-icon-button';
     editMode?: boolean;
 }
+type AnyEntityField = AnyChoiceEntityField | BaseEntityField;
+type AnyChoiceEntityField = ChoiceEntityFieldWithDomain | ChoiceEntityFieldWithLabelField;
+interface ChoiceEntityFieldWithDomain extends BaseChoiceEntityField {
+    domainValues: SelectOption[];
+}
+interface ChoiceEntityFieldWithLabelField extends BaseChoiceEntityField {
+    labelField: string;
+}
+interface BaseChoiceEntityField extends BaseEntityField {
+    domainValues?: SelectOption[];
+    type: 'list' | 'autocomplete';
+    dataType: EntityDataType;
+    /** Define the caracters who structure the array. This allow a workaround to handle stringify list with custom caracter */
+    arrayIdentifier?: [string, string];
+}
+type EntityDataType = 'string' | 'number' | 'object';
+interface BaseEntityField {
+    multiple?: boolean;
+    name: string;
+    relation?: EntityRelation;
+    type?: string;
+}
+interface EntityRelation {
+    table?: string;
+    url?: string;
+    params?: EntityRelationParam;
+    choiceList?: {
+        path?: {
+            /**
+             * The list property allows you to determine a path to resolve to access the list in an Object.
+             * This is required when the API returns an Object instead of a raw List
+             **/
+            list?: string;
+            /** Default is "id" */
+            id?: string;
+            /** Default is "value" */
+            value?: string;
+        };
+    };
+}
+interface EntityRelationParam {
+    name?: string;
+    field: string;
+}
+type SelectEntityTableColumn = AnyChoiceEntityField & BaseEntityTableColumn;
+interface BaseEntityTableColumn extends BaseEntityField {
+    primary?: boolean;
+    renderer?: EntityTableColumnRenderer;
+    sort?: boolean;
+    step?: number;
+    title: string;
+    tooltip?: string;
+    validation?: EntityTableColumnValidation & {
+        send?: boolean;
+    };
+    visible?: boolean;
+    icon?: string;
+    linkColumnForce?: string;
+    cellClassFunc?: (entity: object, record: EntityRecord<object>) => {
+        [key: string]: boolean;
+    };
+    valueAccessor?: (entity: object, record?: EntityRecord<object>) => any;
+    onBlur?: (event: Event) => void;
+    onChange?: (event: Event) => void;
+    onClick?: (event: Event) => void;
+    onFocus?: (event: Event) => void;
+}
+
+declare class EntityService {
+    private http;
+    private configService;
+    encodeListValue(state: EntityState, column: SelectEntityTableColumn): EntityState | string;
+    getDomainValues(field: AnyChoiceEntityField, paramsValue?: {
+        [key: string]: unknown;
+    }): Observable<SelectOption[]>;
+    resolveDomainValues(state: EntityState, column: SelectEntityTableColumn): unknown | unknown[];
+    private buildUrl;
+    private parseDomainValues;
+    private getRelationFilterParamName;
+    private findDomainValue;
+    private parseListValue;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<EntityService, never>;
+    static ɵprov: _angular_core.ɵɵInjectableDeclaration<EntityService>;
+}
 
 /**
  * Get an entity's named property. Nested properties are supported
@@ -170,6 +234,9 @@ declare function getEntityIcon(entity: object): string;
  * @returns Entity revision
  */
 declare function getEntityRevision(entity: object): number;
+declare function getColumnKeyWithoutPropertiesTag(key: string): string;
+declare function isChoiceField(field: AnyEntityField): field is AnyChoiceEntityField;
+declare function isChoiceFieldWithLabelField(field: AnyEntityField): field is ChoiceEntityFieldWithLabelField;
 
 interface EntityStateManagerOptions<E extends object> {
     getKey?: (entity: object) => EntityKey;
@@ -1066,39 +1133,39 @@ declare class EntitySelectorComponent implements OnInit, OnDestroy {
     /**
      * Entity store
      */
-    store: EntityStore<object>;
+    readonly store: _angular_core.InputSignal<EntityStore<object, _igo2_common_entity.EntityState>>;
     /**
      * Title accessor
      */
-    titleAccessor: (object: any) => string;
+    readonly titleAccessor: _angular_core.InputSignal<(object: any) => string>;
     /**
      * Text to display when nothing is selected
      */
-    emptyText: string;
+    readonly emptyText: _angular_core.InputSignal<string>;
     /**
      * Wheter selecting many entities is allowed
      */
-    multi: boolean;
+    readonly multi: _angular_core.InputSignal<boolean>;
     /**
      * Text to display for the select all option
      */
-    multiAllText: string;
+    readonly multiAllText: _angular_core.InputSignal<string>;
     /**
      * Text to display for the select none option
      */
-    multiNoneText: string;
+    readonly multiNoneText: _angular_core.InputSignal<string>;
     /**
      * Field placeholder
      */
-    placeholder: string;
+    readonly placeholder: _angular_core.InputSignal<string>;
     /**
      * Wheter the selector is disabled or not
      */
-    disabled: boolean;
+    readonly disabled: _angular_core.InputSignal<boolean>;
     /**
      * Event emitted when the selection changes
      */
-    selectedChange: EventEmitter<EntitySelectorChange<any>>;
+    readonly selectedChange: _angular_core.OutputEmitterRef<EntitySelectorChange<any>>;
     /**
      * Create a store watcher and subscribe to the selected entity
      * @internal
@@ -1118,17 +1185,17 @@ declare class EntitySelectorComponent implements OnInit, OnDestroy {
     }): void;
     private onSelectFromStore;
     private updateMultiToggleWithEntities;
-    static ɵfac: i0.ɵɵFactoryDeclaration<EntitySelectorComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<EntitySelectorComponent, "igo-entity-selector", never, { "store": { "alias": "store"; "required": false; }; "titleAccessor": { "alias": "titleAccessor"; "required": false; }; "emptyText": { "alias": "emptyText"; "required": false; }; "multi": { "alias": "multi"; "required": false; }; "multiAllText": { "alias": "multiAllText"; "required": false; }; "multiNoneText": { "alias": "multiNoneText"; "required": false; }; "placeholder": { "alias": "placeholder"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; }, { "selectedChange": "selectedChange"; }, never, never, true, never>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<EntitySelectorComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<EntitySelectorComponent, "igo-entity-selector", never, { "store": { "alias": "store"; "required": false; "isSignal": true; }; "titleAccessor": { "alias": "titleAccessor"; "required": false; "isSignal": true; }; "emptyText": { "alias": "emptyText"; "required": false; "isSignal": true; }; "multi": { "alias": "multi"; "required": false; "isSignal": true; }; "multiAllText": { "alias": "multiAllText"; "required": false; "isSignal": true; }; "multiNoneText": { "alias": "multiNoneText"; "required": false; "isSignal": true; }; "placeholder": { "alias": "placeholder"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; }, { "selectedChange": "selectedChange"; }, never, never, true, never>;
 }
 
 /**
  * @deprecated import the EntitySelectorComponent directly
  */
 declare class IgoEntitySelectorModule {
-    static ɵfac: i0.ɵɵFactoryDeclaration<IgoEntitySelectorModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<IgoEntitySelectorModule, never, [typeof EntitySelectorComponent], [typeof EntitySelectorComponent]>;
-    static ɵinj: i0.ɵɵInjectorDeclaration<IgoEntitySelectorModule>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<IgoEntitySelectorModule, never>;
+    static ɵmod: _angular_core.ɵɵNgModuleDeclaration<IgoEntitySelectorModule, never, [typeof EntitySelectorComponent], [typeof EntitySelectorComponent]>;
+    static ɵinj: _angular_core.ɵɵInjectorDeclaration<IgoEntitySelectorModule>;
 }
 
 interface EntityTablePaginatorOptions {
@@ -1195,7 +1262,7 @@ declare class EntityTableComponent implements OnInit, OnChanges, OnDestroy {
     /**
      * Entity store
      */
-    store: EntityStore<object>;
+    readonly store: _angular_core.InputSignal<EntityStore<object, EntityState>>;
     /**
      * Table paginator
      */
@@ -1205,37 +1272,37 @@ declare class EntityTableComponent implements OnInit, OnChanges, OnDestroy {
     /**
      * Table template
      */
-    template: EntityTableTemplate;
+    readonly template: _angular_core.InputSignal<EntityTableTemplate>;
     /**
      * Scroll behavior on selection
      */
-    scrollBehavior: EntityTableScrollBehavior;
+    readonly scrollBehavior: _angular_core.InputSignal<EntityTableScrollBehavior>;
     /**
      * Whether nulls should be first when sorting
      */
-    sortNullsFirst: boolean;
+    readonly sortNullsFirst: _angular_core.InputSignal<boolean>;
     /**
      * Show the table paginator or not. False by default.
      */
-    withPaginator: boolean;
+    readonly withPaginator: _angular_core.InputSignal<boolean>;
     /**
      * Paginator options
      */
-    paginatorOptions: EntityTablePaginatorOptions;
+    readonly paginatorOptions: _angular_core.InputSignal<EntityTablePaginatorOptions>;
     /**
      * Event emitted when an entity (row) is clicked
      */
-    entityClick: EventEmitter<object>;
+    readonly entityClick: _angular_core.OutputEmitterRef<object>;
     /**
      * Event emitted when an entity (row) is selected
      */
-    entitySelectChange: EventEmitter<{
+    readonly entitySelectChange: _angular_core.OutputEmitterRef<{
         added: object[];
     }>;
     /**
      * Event emitted when the table sort is changed.
      */
-    entitySortChange: EventEmitter<{
+    readonly entitySortChange: _angular_core.OutputEmitterRef<{
         column: EntityTableColumn;
         direction: string;
     }>;
@@ -1456,17 +1523,17 @@ declare class EntityTableComponent implements OnInit, OnChanges, OnDestroy {
      * Retrieve column name without his "properties" tag (useful for edition workspace properties)
      */
     getColumnKeyWithoutPropertiesTag(column: string): string;
-    static ɵfac: i0.ɵɵFactoryDeclaration<EntityTableComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<EntityTableComponent, "igo-entity-table", never, { "store": { "alias": "store"; "required": false; }; "paginator": { "alias": "paginator"; "required": false; }; "template": { "alias": "template"; "required": false; }; "scrollBehavior": { "alias": "scrollBehavior"; "required": false; }; "sortNullsFirst": { "alias": "sortNullsFirst"; "required": false; }; "withPaginator": { "alias": "withPaginator"; "required": false; }; "paginatorOptions": { "alias": "paginatorOptions"; "required": false; }; }, { "entityClick": "entityClick"; "entitySelectChange": "entitySelectChange"; "entitySortChange": "entitySortChange"; }, never, never, true, never>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<EntityTableComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<EntityTableComponent, "igo-entity-table", never, { "store": { "alias": "store"; "required": false; "isSignal": true; }; "paginator": { "alias": "paginator"; "required": false; }; "template": { "alias": "template"; "required": false; "isSignal": true; }; "scrollBehavior": { "alias": "scrollBehavior"; "required": false; "isSignal": true; }; "sortNullsFirst": { "alias": "sortNullsFirst"; "required": false; "isSignal": true; }; "withPaginator": { "alias": "withPaginator"; "required": false; "isSignal": true; }; "paginatorOptions": { "alias": "paginatorOptions"; "required": false; "isSignal": true; }; }, { "entityClick": "entityClick"; "entitySelectChange": "entitySelectChange"; "entitySortChange": "entitySortChange"; }, never, never, true, never>;
 }
 
 /**
  * @deprecated import the EntityTableComponent directly
  */
 declare class IgoEntityTableModule {
-    static ɵfac: i0.ɵɵFactoryDeclaration<IgoEntityTableModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<IgoEntityTableModule, never, [typeof EntityTableComponent], [typeof EntityTableComponent]>;
-    static ɵinj: i0.ɵɵInjectorDeclaration<IgoEntityTableModule>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<IgoEntityTableModule, never>;
+    static ɵmod: _angular_core.ɵɵNgModuleDeclaration<IgoEntityTableModule, never, [typeof EntityTableComponent], [typeof EntityTableComponent]>;
+    static ɵinj: _angular_core.ɵɵInjectorDeclaration<IgoEntityTableModule>;
 }
 
 declare class EntityTablePaginatorComponent implements OnChanges, OnDestroy {
@@ -1481,25 +1548,21 @@ declare class EntityTablePaginatorComponent implements OnChanges, OnDestroy {
     private count$$;
     private entitySortChange$$;
     private paginationLabelTranslation$$;
-    entitySortChange$: BehaviorSubject<boolean>;
+    readonly entitySortChange$: _angular_core.InputSignal<BehaviorSubject<boolean>>;
     /**
      * Entity store
      */
-    store: EntityStore<object>;
+    readonly store: _angular_core.InputSignal<EntityStore<object, _igo2_common_entity.EntityState>>;
     /**
      * Paginator options
      */
-    paginatorOptions: EntityTablePaginatorOptions;
-    /**
-     * Event emitted when the paginator changes the page size or page index.
-     */
-    page: EventEmitter<PageEvent>;
+    readonly paginatorOptions: _angular_core.InputSignal<EntityTablePaginatorOptions>;
     length: number;
     /**
      * Paginator emitted.
      */
-    paginatorChange: EventEmitter<MatPaginator>;
-    paginator: MatPaginator;
+    readonly paginatorChange: _angular_core.OutputEmitterRef<MatPaginator>;
+    readonly paginator: _angular_core.Signal<MatPaginator>;
     ngOnChanges(): void;
     initPaginatorOptions(): void;
     translateLabels(): void;
@@ -1507,17 +1570,17 @@ declare class EntityTablePaginatorComponent implements OnChanges, OnDestroy {
     private unsubscribeAll;
     ngOnDestroy(): void;
     emitPaginator(): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<EntityTablePaginatorComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<EntityTablePaginatorComponent, "igo-entity-table-paginator", never, { "entitySortChange$": { "alias": "entitySortChange$"; "required": false; }; "store": { "alias": "store"; "required": false; }; "paginatorOptions": { "alias": "paginatorOptions"; "required": false; }; }, { "page": "page"; "paginatorChange": "paginatorChange"; }, never, never, true, never>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<EntityTablePaginatorComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<EntityTablePaginatorComponent, "igo-entity-table-paginator", never, { "entitySortChange$": { "alias": "entitySortChange$"; "required": false; "isSignal": true; }; "store": { "alias": "store"; "required": false; "isSignal": true; }; "paginatorOptions": { "alias": "paginatorOptions"; "required": false; "isSignal": true; }; }, { "paginatorChange": "paginatorChange"; }, never, never, true, never>;
 }
 
 /**
  * @deprecated import the EntityTablePaginatorComponent directly
  */
 declare class IgoEntityTablePaginatorModule {
-    static ɵfac: i0.ɵɵFactoryDeclaration<IgoEntityTablePaginatorModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<IgoEntityTablePaginatorModule, never, [typeof EntityTablePaginatorComponent], [typeof EntityTablePaginatorComponent]>;
-    static ɵinj: i0.ɵɵInjectorDeclaration<IgoEntityTablePaginatorModule>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<IgoEntityTablePaginatorModule, never>;
+    static ɵmod: _angular_core.ɵɵNgModuleDeclaration<IgoEntityTablePaginatorModule, never, [typeof EntityTablePaginatorComponent], [typeof EntityTablePaginatorComponent]>;
+    static ɵinj: _angular_core.ɵɵInjectorDeclaration<IgoEntityTablePaginatorModule>;
 }
 
 declare const ENTITY_DIRECTIVES: readonly [typeof EntitySelectorComponent, typeof EntityTableComponent, typeof EntityTablePaginatorComponent];
@@ -1525,10 +1588,10 @@ declare const ENTITY_DIRECTIVES: readonly [typeof EntitySelectorComponent, typeo
  * @deprecated import the components directly or ENTITY_DIRECTIVES for every components/directives
  */
 declare class IgoEntityModule {
-    static ɵfac: i0.ɵɵFactoryDeclaration<IgoEntityModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<IgoEntityModule, never, [typeof EntitySelectorComponent, typeof EntityTableComponent, typeof EntityTablePaginatorComponent], [typeof EntitySelectorComponent, typeof EntityTableComponent, typeof EntityTablePaginatorComponent]>;
-    static ɵinj: i0.ɵɵInjectorDeclaration<IgoEntityModule>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<IgoEntityModule, never>;
+    static ɵmod: _angular_core.ɵɵNgModuleDeclaration<IgoEntityModule, never, [typeof EntitySelectorComponent, typeof EntityTableComponent, typeof EntityTablePaginatorComponent], [typeof EntitySelectorComponent, typeof EntityTableComponent, typeof EntityTablePaginatorComponent]>;
+    static ɵinj: _angular_core.ɵɵInjectorDeclaration<IgoEntityModule>;
 }
 
-export { ENTITY_DIRECTIVES, EntityOperationType, EntitySelectorComponent, EntityStateManager, EntityStore, EntityStoreFilterCustomFuncStrategy, EntityStoreFilterSelectionStrategy, EntityStoreStrategy, EntityStoreWatcher, EntityTableColumnRenderer, EntityTableComponent, EntityTablePaginatorComponent, EntityTableScrollBehavior, EntityTableSelectionState, EntityTransaction, EntityView, IgoEntityModule, IgoEntitySelectorModule, IgoEntityTableModule, IgoEntityTablePaginatorModule, getEntityIcon, getEntityId, getEntityProperty, getEntityRevision, getEntityTitle, getEntityTitleHtml };
-export type { EntityFilterClause, EntityJoinClause, EntityKey, EntityOperation, EntityOperationState, EntityRecord, EntitySelectorChange, EntitySortClause, EntityState, EntityStoreOptions, EntityStoreStrategyFuncOptions, EntityStoreStrategyOptions, EntityTableButton, EntityTableColumn, EntityTableColumnValidation, EntityTablePaginatorOptions, EntityTableTemplate, EntityTransactionCommitHandler, EntityTransactionOptions, SelectOption, TableRelation };
+export { ENTITY_DIRECTIVES, EntityOperationType, EntitySelectorComponent, EntityService, EntityStateManager, EntityStore, EntityStoreFilterCustomFuncStrategy, EntityStoreFilterSelectionStrategy, EntityStoreStrategy, EntityStoreWatcher, EntityTableColumnRenderer, EntityTableComponent, EntityTablePaginatorComponent, EntityTableScrollBehavior, EntityTableSelectionState, EntityTransaction, EntityView, IgoEntityModule, IgoEntitySelectorModule, IgoEntityTableModule, IgoEntityTablePaginatorModule, getColumnKeyWithoutPropertiesTag, getEntityIcon, getEntityId, getEntityProperty, getEntityRevision, getEntityTitle, getEntityTitleHtml, isChoiceField, isChoiceFieldWithLabelField };
+export type { AnyChoiceEntityField, AnyEntityField, BaseEntityTableColumn, ChoiceEntityFieldWithDomain, ChoiceEntityFieldWithLabelField, EntityDataType, EntityFilterClause, EntityJoinClause, EntityKey, EntityOperation, EntityOperationState, EntityRecord, EntityRelation, EntityRelationParam, EntitySelectorChange, EntitySortClause, EntityState, EntityStoreOptions, EntityStoreStrategyFuncOptions, EntityStoreStrategyOptions, EntityTableButton, EntityTableColumn, EntityTableColumnValidation, EntityTablePaginatorOptions, EntityTableTemplate, EntityTransactionCommitHandler, EntityTransactionOptions, SelectEntityTableColumn, SelectOption, TableRelation };