feat(signals): allow withEntitiesLoadingCall to receive a factory fun…

…ction for config the factory function config will receive the store , and allow access to it in the fetchEntities, onSuccess and onErro methods Fix #95
gabrielguerrero · Jun 6, 2024 · 6ec7c61 · 6ec7c61
1 parent 172a221
commit 6ec7c61
Show file tree

Hide file tree

Showing 5 changed files with 805 additions and 370 deletions.
diff --git a/apps/example-app/src/app/examples/signals/infinete-scroll-page/products-branch.store.ts b/apps/example-app/src/app/examples/signals/infinete-scroll-page/products-branch.store.ts
@@ -30,8 +30,8 @@ export const ProductsBranchStore = signalStore(
       pageSize: 10,
       entity,
     }),
-    withEntitiesLoadingCall({
-      fetchEntities: async ({ entitiesPagedRequest, entitiesFilter }) => {
+    withEntitiesLoadingCall(({ entitiesPagedRequest, entitiesFilter }) => ({
+      fetchEntities: async () => {
         const res = await lastValueFrom(
           inject(BranchService).getBranches({
             search: entitiesFilter().search,
@@ -41,7 +41,7 @@ export const ProductsBranchStore = signalStore(
         );
         return { entities: res.resultList };
       },
-    }),
+    })),
   ),
   signalStoreFeature(
     withEntities({

diff --git a/apps/example-app/src/app/examples/signals/product-shop-page/products-shop.store.ts b/apps/example-app/src/app/examples/signals/product-shop-page/products-shop.store.ts
@@ -118,26 +118,24 @@ export const ProductsShopStore = signalStore(
   { providedIn: 'root' },
   productsStoreFeature,
   orderItemsStoreFeature,
-  withEntitiesLoadingCall({
-    collection: productsCollection,
-    fetchEntities: async ({
-      productsPagedRequest,
-      productsFilter,
-      productsSort,
-    }) => {
-      const res = await lastValueFrom(
-        inject(ProductService).getProducts({
-          search: productsFilter().search,
-          skip: productsPagedRequest().startIndex,
-          take: productsPagedRequest().size,
-          sortAscending: productsSort().direction === 'asc',
-          sortColumn: productsSort().field,
-        }),
-      );
-      return { entities: res.resultList, total: res.total };
-    },
-    mapError: (error) => (error as Error).message,
-  }),
+  withEntitiesLoadingCall(
+    ({ productsPagedRequest, productsFilter, productsSort }) => ({
+      collection: productsCollection,
+      fetchEntities: async () => {
+        const res = await lastValueFrom(
+          inject(ProductService).getProducts({
+            search: productsFilter().search,
+            skip: productsPagedRequest().startIndex,
+            take: productsPagedRequest().size,
+            sortAscending: productsSort().direction === 'asc',
+            sortColumn: productsSort().field,
+          }),
+        );
+        return { entities: res.resultList, total: res.total };
+      },
+      mapError: (error) => (error as Error).message,
+    }),
+  ),
   withCalls(({ orderItemsEntities }, snackBar = inject(MatSnackBar)) => ({
     loadProductDetail: ({ id }: { id: string }) =>
       inject(ProductService).getProductDetail(id),

diff --git a/libs/ngrx-traits/signals/api-docs.md b/libs/ngrx-traits/signals/api-docs.md
@@ -339,7 +339,7 @@ if an error occurs it will set the error to the store using set[Collection]Error
 
 | Param | Description |
 | --- | --- |
-| config | <p>Configuration object</p> |
+| config | <p>Configuration object or factory function that returns the configuration object</p> |
 | config.fetchEntities | <p>A function that fetches the entities from a remote source the return type</p> |
 | config.collection | <p>The collection name</p> |
 | config.onSuccess | <p>A function that is called when the fetchEntities is successful</p> |