@ngrx-traits/common 12.1.1 → 12.1.2

package/filter-entities/filter-entities.trait.d.ts

@@ -19,7 +19,7 @@ import { FilterEntitiesConfig, FilterEntitiesSelectors } from './filter-entities
  * // The following trait config
  *
  * export interface TestState
- * extends EntityAndStatusState<Todo>,FilterState<TodoFilter>{}
+ * extends LoadEntitiesState<Todo>, FilterEntitiesState<TodoFilter>{}
  *
  *    const traits = createEntityFeatureFactory(
  *      addLoadEntitiesTrait<Todo>(),
@@ -35,8 +35,13 @@ import { FilterEntitiesConfig, FilterEntitiesSelectors } from './filter-entities
  *        'todos',
  *      ),
  *    });
- * // will generate  the following actions and selectors, plus the ones generated by other traits
+ *
+ * //   adds following props to the state:
+ * //    filters?: TodoFilter;
+ *
+ * // generated actions
  * traits.actions.filterTodos()
+ * // generated selectors
  * traits.selectors.selectTodosFilter()
  */
 export declare function addFilterEntitiesTrait<Entity, F>({ defaultDebounceTime, defaultFilter, filterFn, isRemoteFilter, }?: FilterEntitiesConfig<Entity, F>): import("@ngrx-traits/core").TraitFactory<import("../load-entities/load-entities.model").LoadEntitiesState<Entity> & import("./filter-entities.model").FilterEntitiesState<F>, import("./filter-entities.model").FilterEntitiesActions<F>, FilterEntitiesSelectors<Entity, F>, import("./filter-entities.model").FilterEntitiesMutators<Entity, F>, "filter", FilterEntitiesConfig<Entity, F>, import("@ngrx-traits/core").AllTraitConfigs>;

package/load-entities/load-entities.trait.d.ts

@@ -1,11 +1,9 @@
 import { LoadEntitiesState, LoadEntitiesConfig } from './load-entities.model';
 /**
- * Generates the ngrx code needed to load a list of entities from the backend
- * with a load[EntitiesName], load[EntitiesName]Success, load[EntitiesName]Fail actions, and selectors to query the
- * entities like selectEntity[EntitiesName]List, selectEntity[EntitiesName]Ids, selectEntity[EntitiesName]Map, and its progress loading
- * with isLoading[EntitiesName],isLoading[EntitiesName]Success, isLoading[EntitiesName]Fail. This trait is the base for all other traits related
- * to a list of entities, the other will call loadEntities when needing data.
- * @param traitConfig - Config object fot the trait factory
+ * Generates the ngrx code needed to load a list of entities from the backend. This trait is the base for all other traits related
+ * to a list of entities, the other will call loadEntities when needing data. See the example for the list of actions and selectors this generates
+ *
+ * @param traitConfig - Config object for the trait factory
  * @param traitConfig.selectId - Function that returns the id of an entity
  * @param traitConfig.sortComparer - Default sort function for to @ngrx/entity EntityAdapter
  *
@@ -24,16 +22,23 @@ import { LoadEntitiesState, LoadEntitiesConfig } from './load-entities.model';
  *        'todos',
  *      ),
  *    });
- * // will generate the actions and selectors
+ *
+ * //   adds following props to the state:
+ * //    ids: string[] | number[];
+ * //    entities: Dictionary<Todo>;
+ * //    status?: 'loading' | 'success' | 'fail';
+ *
+ * // generated actions
  * traits.actions.loadTodos()
  * traits.actions.loadTodosSuccess({entities: todos})
  * traits.actions.loadTodosFail();
+ * // generated selectors
  * traits.selectors.selectTodosList
  * traits.selectors.selectTodosMap
  * traits.selectors.selectTodosIds
  * traits.selectors.selectTodosTotal
- * traits.selectors.isLoadingTodos
- * traits.selectors.isSuccessTodosSuccess
- * traits.selectors.isFailTodosFail
+ * traits.selectors.isTodosLoading
+ * traits.selectors.isTodosLoadingSuccess
+ * traits.selectors.isTodosLoadingFail
  */
 export declare function addLoadEntitiesTrait<Entity>(traitConfig?: Omit<LoadEntitiesConfig<Entity>, 'adapter'>): import("@ngrx-traits/core").TraitFactory<LoadEntitiesState<Entity>, import("./load-entities.model").LoadEntitiesActions<Entity>, import("./load-entities.model").LoadEntitiesSelectors<Entity>, import("./load-entities.model").LoadEntitiesMutators<Entity>, "loadEntities", LoadEntitiesConfig<Entity>, import("@ngrx-traits/core").AllTraitConfigs>;

package/load-entity/load-entity.traits.d.ts

@@ -2,7 +2,8 @@ import { ActionCreatorProps } from '@ngrx/store/src/models';
 import { LoadEntityState } from './load-entity.model';
 declare type RecordEntity<T> = T extends Record<string, infer J> ? J : never;
 /**
- * Generates ngrx code needed to load and entity and store it in a state
+ * Generates ngrx code needed to load and entity and store it in a state. This action can be added
+ * more than once as long as the entityName para is different
  * @param entityName - Entity name, should be in camel case
  * @param options.actionProps - Optional param for the main request action,
  * use the props() function for its value, if not present action will have no params,
@@ -26,14 +27,19 @@ declare type RecordEntity<T> = T extends Record<string, infer J> ? J : never;
  *        >('client'),
  *    });
  *
- * // will generate
+ * //   adds following props to the state:
+ * //    loadClientStatus?: 'loading' | 'success' | 'fail';
+ * //    client?: Client;
+ *
+ * // generated actions
  * traits.actions.loadClient({id:123});
  * traits.actions.loadClientSuccess({client: {id: '123', name: 'gabs'}});
  * traits.actions.loadClientFail();
- * traits.selectors.selectClient
- * traits.selectors.isLoadingLoadClient
- * traits.selectors.isSuccessLoadClient
- * traits.selectors.isFailLoadClient
+ * // generated selectors
+ * traits.selectors.selectClient()
+ * traits.selectors.isLoadingLoadClient()
+ * traits.selectors.isSuccessLoadClient()
+ * traits.selectors.isFailLoadClient()
  */
 export declare function addLoadEntityTraits<J extends string, Request extends object | undefined = undefined, Response extends Record<J, any> | undefined = undefined, Failure extends object | undefined = undefined, Entity = RecordEntity<Response>, State = LoadEntityState<Entity, J>>({ entityName, actionProps, actionSuccessProps, actionFailProps, }: {
     entityName: J;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ngrx-traits/common",
-  "version": "12.1.1",
+  "version": "12.1.2",
   "peerDependencies": {
     "@angular/common": "^12.0.0",
     "@angular/compiler": "^12.0.0",
@@ -8,7 +8,7 @@
     "@ngrx/effects": "^12.2.0",
     "@ngrx/entity": "^12.2.0",
     "@ngrx/store": "^12.2.0",
-    "@ngrx-traits/core": "12.1.1",
+    "@ngrx-traits/core": "12.1.2",
     "rxjs": "~6.6.0"
   },
   "repository": {

package/reset/reset.trait.d.ts

@@ -1,4 +1,5 @@
 import { GenericActionCreator } from '../load-entities';
+import { ActionCreator, TypedAction } from '@ngrx/store/src/models';
 /**
  * Generates the ngrx code needed to reset the current state to the initial state.
  * @param traitConfig - Config object fot the trait factory
@@ -20,13 +21,13 @@ import { GenericActionCreator } from '../load-entities';
  *        'todos',
  *      ),
  *    });
- * // will generate  the following actions, plus the ones generated by other traits
+ * // generated actions
  * traits.actions.resetTodosState()
  */
 export declare function addResetEntitiesStateTrait(traitConfig?: {
     resetOn?: GenericActionCreator[];
 }): import("@ngrx-traits/core").TraitFactory<{}, {
-    resetEntitiesState: import("@ngrx/store").ActionCreator<string, () => import("@ngrx/store/src/models").TypedAction<string>>;
+    resetEntitiesState: ActionCreator<string, () => TypedAction<string>>;
 }, {}, {}, "reset", {
     resetOn?: GenericActionCreator[] | undefined;
 }, import("@ngrx-traits/core").AllTraitConfigs>;

package/select-entities/select-entities.trait.d.ts

@@ -17,13 +17,17 @@ import { SelectEntitiesSelectors, SelectEntitiesActions } from './select-entitie
  *        'todos',
  *      ),
  *    });
- * // will generate  the following actions and selectors, plus the ones generated by other traits
+ *
+ * //   adds following props to the state:
+ * //    selectedIds: Dictionary<boolean>;
+ *
+ * // generated actions
  * traits.actions.selectTodos({id})
  * traits.actions.deselectTodos({id})
  * traits.actions.toggleSectTodos({id})
  * traits.actions.toggleSelectAllTodos()
  * traits.actions.clearTodosSelection()
- *
+ * //generated selectors
  * traits.selectors.isAllTodosSelected()
  * traits.selectors.selectTodosIdsSelectedMap()
  * traits.selectors.selectTodosIdsSelectedList()

package/select-entity/select-entity.trait.d.ts

@@ -19,11 +19,15 @@ import { SelectEntityActions, SelectEntityConfig } from './select-entity.model';
  *        'todos',
  *      ),
  *    });
- * // will generate  the following actions and selectors, plus the ones generated by other traits
+ *
+ * //   adds following props to the state:
+ * //     selectedId?: number | string;
+ *
+ * // generated actions
  * traits.actions.selectTodo({id})
  * traits.actions.deselectTodo()
  * traits.actions.toggleSelectTodo({id})
- *
+ * //generated selectors
  * traits.selectors.selectTodoIdSelected()
  * traits.selectors.selectTodoSelected()
  */

package/set-entity/set-entity.trait.d.ts

@@ -12,7 +12,7 @@ declare type RecordEntity<T> = T extends Record<string, infer J> ? J : never;
  * const traits = createEntityFeatureFactory(
  * addSetEntityTraits({
  *        entityName: 'client',
- *        actionProps: props<{ client: { id: number; name: string } }
+ *        actionProps: props<{ client: Client }
  *      }),
  * )({
  *      actionsGroupKey: 'Client',
@@ -20,10 +20,13 @@ declare type RecordEntity<T> = T extends Record<string, infer J> ? J : never;
  *        SetEntityState<Client, 'client'>
  *        >('client'),
  *    });
+ * //   adds following props to the state:
+ * //    client?: Client;
  *
- * // will generate
+ * // generated actions
  * traits.actions.setClient({client: {id:123, name: 'gabs'}});
- * traits.selectors.selectClient
+ * //generated selectors
+ * traits.selectors.selectClient()
  */
 export declare function addSetEntityTrait<J extends string, Payload extends Record<J, any> | undefined = undefined, Entity = RecordEntity<Payload>, State = SetEntityState<Entity, J>>({ entityName, actionProps, }: {
     entityName: J;

package/sort-entities/sort-entities.trait.d.ts

@@ -24,10 +24,16 @@ import { SortEntitiesActions, SortEntitiesConfig, SortEntitiesSelectors } from '
  *        'todos',
  *      ),
  *    });
- * // will generate  the following actions and selectors, plus the ones generated by other traits
+ * //   adds following props to the state:
+ * //      sort: {
+ * //        current: Sort<Todo>;
+ * //        default: Sort<Todo>;
+ * //      }
+ *
+ * // generated actions
  * traits.actions.sortTodos({active:'id', direction:'desc'})
  * traits.actions.resetTodosSort()
- *
+ * //generated selectors
  * traits.selectors.selectTodosSort()
  */
 export declare function addSortEntitiesTrait<Entity>({ remote, defaultSort, }: SortEntitiesConfig<Entity>): import("@ngrx-traits/core").TraitFactory<import("../load-entities/load-entities.model").LoadEntitiesState<Entity> & import("./sort-entities.model").SortEntitiesState<Entity>, SortEntitiesActions<Entity>, SortEntitiesSelectors<Entity>, import("./sort-entities.model").SortEntitiesMutators<Entity>, "sort", SortEntitiesConfig<Entity>, import("@ngrx-traits/core").AllTraitConfigs>;

package/sort-entities/sort-entities.utils.d.ts

@@ -1,6 +1,8 @@
 import { Sort } from './sort-entities.model';
 export declare function _isNumberValue(value: any): boolean;
 /**
+ * @internal
+ * @ignore
  * Gets a sorted copy of the data array based on the state of the Sort.
  * @param data The array of data that should be sorted.
  * @param sort The connected MatSort that holds the current sort state.