docs: improved docs for withEntitiesRemoteScrollPagination, and fixed…

… old names

apps/example-app/src/app/examples/signals/infinete-scroll-page/components/products-branch-dropdown/products-branch.store.ts

@@ -42,37 +42,3 @@ export const ProductsBranchStore = signalStore(
   }),
   withLogger('branchStore'),
 );
-// const collection = 'products';
-// export const ProductsBranchStore2 = signalStore(
-//   withEntities({
-//     entity,
-//     collection,
-//   }),
-//   withCallStatus({ initialValue: 'loading', collection }),
-//   withEntitiesRemoteFilter({
-//     entity,
-//     defaultFilter: { search: '' },
-//     collection,
-//   }),
-//   withEntitiesRemoteScrollPagination({
-//     bufferSize: 30,
-//     entity,
-//     collection,
-//   }),
-//   withEntitiesLoadingCall({
-//     collection,
-//     fetchEntities: async ({ productsRequest, productsFilter }) => {
-//       const res = await lastValueFrom(
-//         inject(BranchService).getBranches({
-//           search: productsFilter().search,
-//           skip: productsRequest().startIndex,
-//           take: productsRequest().size,
-//         }),
-//       );
-//       return { entities: res.resultList, total: res.total };
-//     },
-//   }),
-//   withLogger('branchStore'),
-// );
-// const store = new ProductsBranchStore2();
-// getInfiniteScrollDataSource({ store, collection, entity });

apps/example-app/src/app/examples/signals/product-list-paginated-page/product.store.ts

@@ -37,11 +37,6 @@ export const ProductsRemoteStore = signalStore(
     pageSize: 5,
     pagesToCache: 2,
   }),
-  // withEntitiesRemoteScrollPagination({
-  //   bufferSize: 5,
-  //   collection,
-  //   entity
-  // }),
   withEntitiesRemoteSort({
     entity,
     collection,

libs/ngrx-traits/signals/src/lib/with-entities-filter/with-entities-local-filter.ts

@@ -39,7 +39,9 @@ import {
 /**
  * Generates necessary state, computed and methods for locally filtering entities in the store,
  * the generated filter[collenction]Entities method will filter the entities based on the filter function
- * and is debounced by default. Requires withEntities to be used.
+ * and is debounced by default.
+ *
+ * Requires withEntities to be used.
  *
  * @param config
  * @param config.filterFn - The function that will be used to filter the entities
@@ -65,7 +67,7 @@ import {
  *   }),
  *  );
  *
- *  // generates the following signals
+ * // generates the following signals
  *  store.productsFilter // { search: string }
  *  // generates the following computed signals
  *  store.isProductsFilterChanged // boolean
@@ -95,7 +97,9 @@ export function withEntitiesLocalFilter<
 /**
  * Generates necessary state, computed and methods for locally filtering entities in the store,
  * the generated filter[collenction]Entities method will filter the entities based on the filter function
- * and is debounced by default. Requires withEntities to be used.
+ * and is debounced by default.
+ *
+ * Requires withEntities to be used.
  *
  * @param config
  * @param config.filterFn - The function that will be used to filter the entities
@@ -155,6 +159,7 @@ export function withEntitiesLocalFilter<
     methods: NamedEntitiesFilterMethods<Collection, Filter>;
   }
 >;
+
 export function withEntitiesLocalFilter<
   Entity extends { id: string | number },
   Collection extends string,

libs/ngrx-traits/signals/src/lib/with-entities-filter/with-entities-remote-filter.ts

@@ -42,7 +42,9 @@ import {
  * the generated filter[collection]Entities method will filter the entities by calling set[collection]Loading()
  * and you should either create an effect that listens toe [collection]Loading can call the api with the [collection]Filter params
  * or use withEntitiesLoadingCall to call the api with the [collection]Filter params
- * and is debounced by default. Requires withEntities and withCallStatus to be present before this function.
+ * and is debounced by default.
+ *
+ * Requires withEntities and withCallStatus to be present before this function.
  * @param config
  * @param config.defaultFilter - The default filter to be used
  * @param config.entity - The entity type to be used
@@ -79,9 +81,9 @@ import {
  * //     effect(() => {
  * //       if (isProductsLoading()) {
  * //         inject(ProductService)
- * //            .getProducts({
+ * //              .getProducts({
  * //                 search: productsFilter().name,
- * //             })
+ * //               })
  * //           .pipe(
  * //             takeUntilDestroyed(),
  * //             tap((res) =>
@@ -131,7 +133,9 @@ export function withEntitiesRemoteFilter<
  * the generated filter[collection]Entities method will filter the entities by calling set[collection]Loading()
  * and you should either create an effect that listens toe [collection]Loading can call the api with the [collection]Filter params
  * or use withEntitiesLoadingCall to call the api with the [collection]Filter params
- * and is debounced by default. Requires withEntities and withCallStatus to be present before this function.
+ * and is debounced by default.
+ *
+ * Requires withEntities and withCallStatus to be present before this function.
  * @param config
  * @param config.defaultFilter - The default filter to be used
  * @param config.entity - The entity type to be used

libs/ngrx-traits/signals/src/lib/with-entities-loading-call/with-entities-loading-call.spec.ts

@@ -151,7 +151,7 @@ describe('withEntitiesLoadingCall', () => {
       });
     }));
 
-    it('should set[Collection]LoadResult if fetchEntities returns an a {entities: Entity[], total: number} ', fakeAsync(() => {
+    it('should set[Collection]Result if fetchEntities returns an a {entities: Entity[], total: number} ', fakeAsync(() => {
       TestBed.runInInjectionContext(() => {
         const Store = signalStore(
           withEntities({

libs/ngrx-traits/signals/src/lib/with-entities-loading-call/with-entities-loading-call.ts

@@ -62,7 +62,9 @@ import { getWithEntitiesRemotePaginationKeys } from '../with-entities-pagination
  * to the store using the setAllEntities method or the setEntitiesResult method
  * if it exists (comes from withEntitiesRemotePagination),
  * if an error occurs it will set the error to the store using set[Collection]Error with the error.
+ *
  * Requires withEntities and withCallStatus to be present in the store.
+ *
  * @param config - Configuration object
  * @param config.fetchEntities - A function that fetches the entities from a remote source the return type
  * @param config.collection - The collection name
@@ -156,7 +158,9 @@ export function withEntitiesLoadingCall<
  * to the store using the setAllEntities method or the setEntitiesResult method
  * if it exists (comes from withEntitiesRemotePagination),
  * if an error occurs it will set the error to the store using set[Collection]Error with the error.
+ *
  * Requires withEntities and withCallStatus to be present in the store.
+ *
  * @param config - Configuration object
  * @param config.fetchEntities - A function that fetches the entities from a remote source the return type
  * @param config.collection - The collection name

libs/ngrx-traits/signals/src/lib/with-entities-pagination/with-entities-local-pagination.ts

@@ -36,6 +36,7 @@ import {
 
 /**
  * Generates necessary state, computed and methods for local pagination of entities in the store.
+ *
  * Requires withEntities to be present in the store.
  * @param config
  * @param config.pageSize - The number of entities to show per page
@@ -54,7 +55,7 @@ import {
  *     entity,
  *     collection,
  *     pageSize: 5,
- *   }));
+ *   }),
  *
  *   // generates the following signals
  *   store.productsPagination // { currentPage: 0, pageSize: 5 }
@@ -83,6 +84,7 @@ export function withEntitiesLocalPagination<
 >;
 /**
  * Generates necessary state, computed and methods for local pagination of entities in the store.
+ *
  * Requires withEntities to be present in the store.
  * @param config
  * @param config.pageSize - The number of entities to show per page

libs/ngrx-traits/signals/src/lib/with-entities-pagination/with-entities-remote-pagination.ts

@@ -54,10 +54,12 @@ import {
  * Generates necessary state, computed and methods for remote pagination of entities in the store.
  * When the page changes, it will try to load the current page from cache if it's not present,
  * it will call set[collection]Loading(), and you should either create an effect that listens to [collection]Loading
- * and call the api with the [collection]PagedRequest params and use set[Collection]LoadResult to set the result
+ * and call the api with the [collection]PagedRequest params and use set[Collection]Result to set the result
  * and changing the status errors manually
  * or use withEntitiesLoadingCall to call the api with the [collection]PagedRequest params which handles setting
- * the result and errors automatically. Requires withEntities and withCallStatus to be present before this function.
+ * the result and errors automatically.
+ *
+ * Requires withEntities and withCallStatus to be present before this function.
  * @param config
  * @param config.pageSize - The number of entities to show per page
  * @param config.currentPage - The current page to show
@@ -66,7 +68,9 @@ import {
  * @param config.collection - The name of the collection
  *
  * @example
- * export const ProductsRemoteStore = signalStore(
+ * const entity = type<Product>();
+ * const collection = 'products';
+ * export const store = signalStore(
  *   { providedIn: 'root' },
  *   // required withEntities and withCallStatus
  *   withEntities({ entity, collection }),
@@ -96,7 +100,7 @@ import {
  *     },
  *   }),
  * // withEntitiesLoadingCall is the same as doing the following:
- * // withHooks(({ productsLoading, setProductsError, setProductsLoadResult, ...state }) => ({
+ * // withHooks(({ productsLoading, setProductsError, setProductsResult, ...state }) => ({
  * //   onInit: async () => {
  * //     effect(() => {
  * //       if (isProductsLoading()) {
@@ -110,7 +114,7 @@ import {
  * //             tap((res) =>
  * //               patchState(
  * //                 state,
- * //                 setProductsLoadResult(res.resultList, res.total),
+ * //                 setProductsResult({ entities: res.resultList, total: res.total } ),
  * //               ),
  * //             ),
  * //             catchError((error) => {
@@ -130,7 +134,7 @@ import {
  *  store.productsPagedRequest // { startIndex: number, size: number, page: number }
  *  // generates the following methods
  *  store.loadProductsPage({ pageIndex: number, forceLoad?: boolean }) // loads the page and sets the requestPage to the pageIndex
- *  store.setProductsLoadResult(entities: Product[], total: number) // appends the entities to the cache of entities and total
+ *  store.setProductsResult(entities: Product[], total: number) // appends the entities to the cache of entities and total
  */
 export function withEntitiesRemotePagination<
   Entity extends { id: string | number },
@@ -155,10 +159,12 @@ export function withEntitiesRemotePagination<
  * Generates necessary state, computed and methods for remote pagination of entities in the store.
  * When the page changes, it will try to load the current page from cache if it's not present,
  * it will call set[collection]Loading(), and you should either create an effect that listens to [collection]Loading
- * and call the api with the [collection]PagedRequest params and use set[Collection]LoadResult to set the result
+ * and call the api with the [collection]PagedRequest params and use set[Collection]Result to set the result
  * and changing the status errors manually
  * or use withEntitiesLoadingCall to call the api with the [collection]PagedRequest params which handles setting
- * the result and errors automatically. Requires withEntities and withCallStatus to be present before this function.
+ * the result and errors automatically.
+ *
+ * Requires withEntities and withCallStatus to be present before this function.
  * @param config
  * @param config.pageSize - The number of entities to show per page
  * @param config.currentPage - The current page to show
@@ -199,7 +205,7 @@ export function withEntitiesRemotePagination<
  *     },
  *   }),
  * // withEntitiesLoadingCall is the same as doing the following:
- * // withHooks(({ productsLoading, setProductsError, setProductsLoadResult, ...state }) => ({
+ * // withHooks(({ productsLoading, setProductsError, setProductsResult, ...state }) => ({
  * //   onInit: async () => {
  * //     effect(() => {
  * //       if (isProductsLoading()) {
@@ -213,7 +219,7 @@ export function withEntitiesRemotePagination<
  * //             tap((res) =>
  * //               patchState(
  * //                 state,
- * //                 setProductsLoadResult(res.resultList, res.total),
+ * //                 setProductsResult({ entities: res.resultList, total: res.total } ),
  * //               ),
  * //             ),
  * //             catchError((error) => {
@@ -233,7 +239,7 @@ export function withEntitiesRemotePagination<
  *  store.productsPagedRequest // { startIndex: number, size: number, page: number }
  *  // generates the following methods
  *  store.loadProductsPage({ pageIndex: number, forceLoad?: boolean }) // loads the page and sets the requestPage to the pageIndex
- *  store.setProductsLoadResult(entities: Product[], total: number) // appends the entities to the cache of entities and total
+ *  store.setProductsResult(entities: Product[], total: number) // appends the entities to the cache of entities and total
  */
 
 export function withEntitiesRemotePagination<
@@ -262,7 +268,7 @@ export function withEntitiesRemotePagination<
  * Generates necessary state, computed and methods for remote pagination of entities in the store.
  * When the page changes, it will try to load the current page from cache if it's not present,
  * it will call set[collection]Loading(), and you should either create an effect that listens to [collection]Loading
- * and call the api with the [collection]PagedRequest params and use set[Collection]LoadResult to set the result
+ * and call the api with the [collection]PagedRequest params and use set[Collection]Result to set the result
  * and changing the status errors manually
  * or use withEntitiesLoadingCall to call the api with the [collection]PagedRequest params which handles setting
  * the result and errors automatically. Requires withEntities and withCallStatus to be used.
@@ -307,7 +313,7 @@ export function withEntitiesRemotePagination<
  *     },
  *   }),
  * // withEntitiesLoadingCall is the same as doing the following:
- * // withHooks(({ productsLoading, setProductsError, setProductsLoadResult, ...state }) => ({
+ * // withHooks(({ productsLoading, setProductsError, setProductsResult, ...state }) => ({
  * //   onInit: async () => {
  * //     effect(() => {
  * //       if (isProductsLoading()) {
@@ -321,7 +327,7 @@ export function withEntitiesRemotePagination<
  * //             tap((res) =>
  * //               patchState(
  * //                 state,
- * //                 setProductsLoadResult(res.resultList, res.total),
+ * //                 setProductsResult({ entities: res.resultList, total: res.total } ),
  * //               ),
  * //             ),
  * //             catchError((error) => {
@@ -341,7 +347,7 @@ export function withEntitiesRemotePagination<
  *  store.productsPagedRequest // { startIndex: number, size: number, page: number }
  *  // generates the following methods
  *  store.loadProductsPage({ pageIndex: number, forceLoad?: boolean }) // loads the page and sets the requestPage to the pageIndex
- *  store.setProductsLoadResult(entities: Product[], total: number) // appends the entities to the cache of entities and total
+ *  store.setProductsResult(entities: Product[], total: number) // appends the entities to the cache of entities and total
  */
 export function withEntitiesRemotePagination<
   Entity extends { id: string | number },