@ecodev/natural 47.2.0 → 47.3.1

package/lib/classes/abstract-editable-list.d.ts

@@ -55,6 +55,8 @@ export declare class NaturalAbstractEditableList<TService extends NaturalAbstrac
      *  - AbstractModelService.getPartialVariablesForCreation()
      *  - AbstractModelService.getPartialVariablesForUpdate()
      *  - some other required treatment.
+     *
+     * TODO return type is incorrect and should be closer to `Partial<T>[]` or an even looser type, because we don't really know what fields exists in the form. When we fix this, we should also remove type coercing in unit tests.
      */
     getItems(): T[];
     /**

package/lib/modules/relations/relations.component.d.ts

@@ -7,9 +7,8 @@ import { HierarchicFiltersConfiguration } from '../../modules/hierarchic-selecto
 import { LinkableObject, NaturalLinkMutationService } from '../../services/link-mutation.service';
 import { NaturalHierarchicConfiguration } from '../hierarchic-selector/classes/hierarchic-configuration';
 import { NaturalHierarchicSelectorDialogService } from '../hierarchic-selector/hierarchic-selector-dialog/hierarchic-selector-dialog.service';
-import { Filter } from '../search/classes/graphql-doctrine.types';
 import { NaturalAbstractModelService } from '../../services/abstract-model.service';
-import { Literal } from '../../types/types';
+import { ExtractTallOne, ExtractVall } from '../../types/types';
 import * as i0 from "@angular/core";
 /**
  * Custom template usage :
@@ -19,11 +18,11 @@ import * as i0 from "@angular/core";
  *     </ng-template>
  * </natural-relations>
  */
-export declare class NaturalRelationsComponent<TService extends NaturalAbstractModelService<any, any, PaginatedData<Literal>, QueryVariables, any, any, any, any, any, any>> extends NaturalAbstractController implements OnInit, OnChanges, OnDestroy {
+export declare class NaturalRelationsComponent<TService extends NaturalAbstractModelService<unknown, any, PaginatedData<LinkableObject>, QueryVariables, unknown, any, unknown, any, unknown, any>> extends NaturalAbstractController implements OnInit, OnChanges, OnDestroy {
     private readonly linkMutationService;
     private readonly hierarchicSelectorDialog;
     private select?;
-    itemTemplate?: TemplateRef<any>;
+    itemTemplate?: TemplateRef<unknown>;
     service?: TService;
     /**
      * The placeholder used in the button to add a new relation
@@ -32,11 +31,11 @@ export declare class NaturalRelationsComponent<TService extends NaturalAbstractM
     /**
      * Filter for autocomplete selector
      */
-    autocompleteSelectorFilter?: Filter;
+    autocompleteSelectorFilter?: ExtractVall<TService>['filter'] | null | undefined;
     /**
      * Function to customize the rendering of the selected item as text in input
      */
-    displayWith?: (item: any) => string;
+    displayWith?: (item: ExtractTallOne<TService> | null) => string;
     /**
      * Whether the relations can be changed
      */
@@ -65,7 +64,7 @@ export declare class NaturalRelationsComponent<TService extends NaturalAbstractM
     /**
      * Listing service instance
      */
-    dataSource?: NaturalDataSource;
+    dataSource?: NaturalDataSource<PaginatedData<LinkableObject>>;
     loading: boolean;
     /**
      * Table columns
@@ -88,7 +87,7 @@ export declare class NaturalRelationsComponent<TService extends NaturalAbstractM
      * So if the relations are from one action -> to many objectives, then the filter must filter
      * the objectives that have indeed a relation to the particular action.
      */
-    set filter(filter: Filter);
+    set filter(filter: ExtractVall<TService>['filter']);
     ngOnInit(): void;
     ngOnChanges(): void;
     /**
@@ -101,9 +100,9 @@ export declare class NaturalRelationsComponent<TService extends NaturalAbstractM
      * Refetch result to display it in table
      * TODO : could maybe use "update" attribute of apollo.mutate function to update table faster (but hard to do it here)
      */
-    addRelations(relations: LinkableObject[]): void;
+    addRelations(relations: (LinkableObject | ExtractTallOne<TService> | string | null)[]): void;
     pagination(event?: PageEvent): void;
-    getDisplayFn(): (item: any) => string;
+    getDisplayFn(): (item: ExtractTallOne<TService> | null) => string;
     openNaturalHierarchicSelector(): void;
     /**
      * Get list from database

package/lib/modules/select/select/select.component.d.ts

@@ -11,28 +11,40 @@ import * as i0 from "@angular/core";
 type V<TService> = string | ExtractTallOne<TService>;
 /**
  * Default usage:
- * <natural-select [service]="amazingServiceInstance" [(model)]="amazingModel" (modelChange)=amazingChangeFn($event)></natural-select>
+ * ```html
+ * <natural-select [service]="myServiceInstance" [(model)]="myModel" (modelChange)=myChangeFn($event)></natural-select>
+ * ```
  *
  * Custom template usage :
+ * ```html
  * <natural-select [service]="svc" [(ngModel)]="model">
  *     <ng-template let-item="item">
  *         <span>{{ item.xxx }}</span>
  *     </ng-template>
  * </natural-select>
+ * ```
  *
- * [(ngModel)] and (ngModelChange) are optional
+ * `[(ngModel)]` and `(ngModelChange)` are optional.
  *
  * Placeholder :
- * <natural-select placeholder="amazing placeholder">
+ * ```html
+ * <natural-select placeholder="my placeholder"></natural-select>
+ * ```
  *
  * Never float placeholder :
- * <natural-select placeholder="amazing placeholder" floatPlaceholder="never">
+ * ```html
+ * <natural-select placeholder="my placeholder" floatPlaceholder="never"></natural-select>
+ * ```
  *
- * Search with like %xxx% on specified attribute name instead of custom filter on whole object
- * <natural-select [searchField]="string">
+ * Search with like %xxx% on specified field `name` instead of custom filter on whole object
+ * ```html
+ * <natural-select searchField="name"></natural-select>
+ * ```
  *
  * Allows to input free string without selecting an option from autocomplete suggestions
- * <natural-select [optionRequired]="false">
+ * ```html
+ * <natural-select [optionRequired]="false"></natural-select>
+ * ```
  */
 export declare class NaturalSelectComponent<TService extends NaturalAbstractModelService<any, any, PaginatedData<Literal>, QueryVariables, any, any, any, any, any, any>> extends AbstractSelect<V<TService>, V<TService>> implements OnInit, OnDestroy, ControlValueAccessor, AfterViewInit {
     autoTrigger: MatAutocompleteTrigger;
@@ -46,9 +58,13 @@ export declare class NaturalSelectComponent<TService extends NaturalAbstractMode
      */
     optionRequired: boolean;
     /**
-     * The filter attribute to bind when searching for a term
+     * The field on which to search for, default to 'custom'.
      */
     searchField: 'custom' | string;
+    /**
+     * The operator with which to search for, default to 'search' if `searchField` is 'custom', else 'like'.
+     */
+    searchOperator: 'search' | string | null;
     /**
      * Additional filter for query
      */
@@ -58,7 +74,7 @@ export declare class NaturalSelectComponent<TService extends NaturalAbstractMode
      */
     items: null | Observable<readonly any[]>;
     /**
-     * Whether a we are searching something
+     * Whether we are searching something
      */
     loading: boolean;
     /**
@@ -92,7 +108,8 @@ export declare class NaturalSelectComponent<TService extends NaturalAbstractMode
     search(term: V<TService> | null): void;
     showClearButton(): boolean;
     private getSearchFilter;
+    getVariablesForDebug(): Readonly<QueryVariables> | undefined;
     static ɵfac: i0.ɵɵFactoryDeclaration<NaturalSelectComponent<any>, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<NaturalSelectComponent<any>, "natural-select", never, { "service": "service"; "optionRequired": "optionRequired"; "searchField": "searchField"; "filter": "filter"; "disabled": "disabled"; }, {}, ["itemTemplate"], never, false, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<NaturalSelectComponent<any>, "natural-select", never, { "service": "service"; "optionRequired": "optionRequired"; "searchField": "searchField"; "searchOperator": "searchOperator"; "filter": "filter"; "disabled": "disabled"; }, {}, ["itemTemplate"], never, false, never>;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ecodev/natural",
-  "version": "47.2.0",
+  "version": "47.3.1",
   "license": "MIT",
   "repository": "github:Ecodev/natural",
   "sideEffects": false,