@sumaris-net/ngx-components 18.22.11 → 18.22.12

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sumaris-net/ngx-components",
   "description": "SUMARiS Angular components",
-  "version": "18.22.11",
+  "version": "18.22.12",
   "author": "contact@e-is.pro",
   "license": "AGPL-3.0",
   "readmeFilename": "README.md",

package/src/app/shared/services/entity-service.class.d.ts

@@ -16,12 +16,12 @@ export declare interface LoadResult<T> {
     errors?: any[];
     fetchMore?: FetchMoreFn<LoadResult<T>>;
 }
-export type SuggestFn<T, F> = (value: any, filter?: F, sortBy?: string | keyof T, sortDirection?: SortDirection, opts?: {
+export type SuggestFn<T, F, R = T[] | LoadResult<T>> = (value: any, filter?: F, sortBy?: string | keyof T, sortDirection?: SortDirection, opts?: {
     fetchPolicy?: FetchPolicy;
     offset?: number;
     size?: number;
     [key: string]: any;
-}) => Promise<T[] | LoadResult<T>>;
+}) => Promise<R>;
 export declare interface SuggestService<T, F> {
     suggest: SuggestFn<T, F>;
 }
@@ -93,5 +93,24 @@ export declare interface IEntitiesService<T, F, O extends EntitiesServiceWatchOp
 export type LoadResultByPageFn<T> = (offset: number, size: number) => Promise<LoadResult<T>>;
 export interface IEntityFullService<T, ID, F, O extends EntitiesServiceWatchOptions & EntityServiceLoadOptions> extends IEntityService<T, ID, O>, IEntitiesService<T, F, O> {
 }
+/**
+ * Merges two LoadResult objects into a single LoadResult object by combining their data arrays and summing their total counts.
+ *
+ * @param {LoadResult<T>} res1 - The first LoadResult object to merge.
+ * @param {LoadResult<T>} res2 - The second LoadResult object to merge.
+ * @return {LoadResult<T>} A new LoadResult object containing the combined data and total count from both input objects.
+ */
 export declare function mergeLoadResult<T>(res1: LoadResult<T>, res2: LoadResult<T>): LoadResult<T>;
+/**
+ * Converts an array of items or an already structured LoadResult object
+ * into a LoadResult object.
+ *
+ * @param {T[] | LoadResult<T>} res - The input which can either be an
+ * array of items or a LoadResult object.
+ *
+ * @return {LoadResult<T>} Returns a LoadResult object. If the input is
+ * an array, it is converted into a LoadResult object with the data property
+ * containing the array. If the input is already a LoadResult, it is returned as is.
+ */
+export declare function toLoadResult<T>(res: T[] | LoadResult<T>): LoadResult<T> | T[];
 export declare function isEntityService<T, ID>(service: any): service is IEntityService<T, ID>;

package/src/assets/manifest.json

@@ -2,7 +2,7 @@
   "name": "ngx-sumaris-components",
   "short_name": "ngx-sumaris-components",
   "manifest_version": 1,
-  "version": "18.22.11",
+  "version": "18.22.12",
   "default_locale": "fr",
   "description": "Angular components for building beautiful and responsive Apps",
   "icons": [{