@ngrx-traits/common 19.2.3 → 20.0.0-beta.2

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

@@ -1,5 +0,0 @@
-import { LoadEntitiesActions, LoadEntitiesState } from '../load-entities/load-entities.model';
-import { FilterEntitiesKeyedConfig, FilterEntitiesMutators, FilterEntitiesState } from './filter-entities.model';
-import { ƟFilterEntitiesActions } from './filter-entities.model.internal';
-export declare function createFilterInitialState<Entity, F>(previousInitialState: any, allConfigs: FilterEntitiesKeyedConfig<Entity, F>): LoadEntitiesState<Entity> & FilterEntitiesState<F>;
-export declare function createFilterTraitReducer<T, F, S extends LoadEntitiesState<T> & FilterEntitiesState<F>>(initialState: S, allActions: ƟFilterEntitiesActions<F> & LoadEntitiesActions<T>, allMutators: FilterEntitiesMutators<T, F>): import("@ngrx/store").ActionReducer<unknown extends S ? S : S, import("@ngrx/store").Action<string>>;

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

@@ -1,4 +0,0 @@
-import { FilterEntitiesSelectors, FilterEntitiesState } from './filter-entities.model';
-import { LoadEntitiesState } from '../load-entities';
-export declare function selectEntitiesFilter<Entity, F>(state: LoadEntitiesState<Entity> & FilterEntitiesState<F>): F | undefined;
-export declare function createFilterTraitSelectors<Entity, F>(): FilterEntitiesSelectors<Entity, F>;

package/filter-entities/index.d.ts

@@ -1,2 +0,0 @@
-export * from './filter-entities.trait';
-export * from './filter-entities.model';

package/load-entities/index.d.ts

@@ -1,2 +0,0 @@
-export * from './load-entities.model';
-export * from './load-entities.trait';

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

@@ -1,97 +0,0 @@
-import { KeyedConfig } from '@ngrx-traits/core';
-import { Comparer, EntityAdapter, EntityState, IdSelector } from '@ngrx/entity';
-import { Dictionary } from '@ngrx/entity/src/models';
-import { Action, ActionCreator } from '@ngrx/store/src/models';
-export type Status = 'loading' | 'success' | 'fail';
-export interface StatusState {
-    status?: Status;
-}
-export interface LoadEntitiesState<T> extends EntityState<T>, StatusState {
-}
-export type LoadEntitiesActions<T> = {
-    /**
-     * load entities from backend
-     */
-    loadEntities: ActionCreator<string, () => Action<string>>;
-    /**
-     * entities where loaded successfully
-     */
-    loadEntitiesSuccess: ActionCreator<string, (props: {
-        entities: T[];
-        total?: number;
-    }) => {
-        entities: T[];
-        total?: number;
-    } & Action<string>>;
-    /**
-     * entities failed loading
-     */
-    loadEntitiesFail: ActionCreator<string, (props?: {
-        error?: string;
-    }) => {
-        error?: string;
-    } & Action<string>>;
-};
-export type LoadEntitiesSelectors<T> = {
-    /**
-     * returns all ids of the entities in an array
-     * @param state
-     */
-    selectEntitiesIdsList: (state: LoadEntitiesState<T>) => string[] | number[];
-    /**
-     * returns all entities in a map with the id as key of the map
-     * @param state
-     */
-    selectEntitiesMap: (state: LoadEntitiesState<T>) => Dictionary<T>;
-    /**
-     * returns all entities in an array
-     * @param state
-     */
-    selectEntitiesList: (state: LoadEntitiesState<T>) => T[];
-    /**
-     * returns the total number of entities
-     * @param state
-     */
-    selectEntitiesTotal: (state: LoadEntitiesState<T>) => number;
-    /**
-     * is currently loading entities
-     * @param state
-     */
-    isEntitiesLoading: (state: LoadEntitiesState<T>) => boolean;
-    /**
-     * were the entities loaded successfully
-     * @param state
-     */
-    isEntitiesLoadingSuccess: (state: LoadEntitiesState<T>) => boolean;
-    /**
-     * did the entities fail loading
-     * @param state
-     */
-    isEntitiesLoadingFail: (state: LoadEntitiesState<T>) => boolean;
-};
-export type LoadEntitiesMutators<T> = {
-    /**
-     * set or replace all entities currently in store
-     * @param entities
-     * @param state
-     */
-    setEntitiesList<S extends LoadEntitiesState<T>>(entities: T[], state: S): S;
-};
-export type GenericActionCreator = ActionCreator<string, (...args: unknown[]) => Action<string>>;
-export declare const loadEntitiesTraitKey = "loadEntities";
-export type LoadEntitiesConfig<T = unknown> = {
-    /**
-     * Function that returns the id of an entity if not set it attempts to return the values
-     * of a property call id, this is pass to @ngrx/entity EntityAdapter
-     */
-    selectId?: IdSelector<T>;
-    /**
-     *  Default sort function for to @ngrx/entity EntityAdapter
-     */
-    sortComparer?: false | Comparer<T>;
-    /**
-     *  @ngrx/entity EntityAdapter
-     */
-    adapter: EntityAdapter<T>;
-};
-export type LoadEntitiesKeyedConfig<T> = KeyedConfig<typeof loadEntitiesTraitKey, LoadEntitiesConfig<T>>;

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

@@ -1,3 +0,0 @@
-import { LoadEntitiesKeyedConfig, LoadEntitiesMutators } from './load-entities.model';
-import { EntitiesPaginationKeyedConfig } from '../entities-pagination';
-export declare function createLoadEntitiesTraitMutators<Entity>(allConfigs: LoadEntitiesKeyedConfig<Entity> & EntitiesPaginationKeyedConfig): LoadEntitiesMutators<Entity>;

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

@@ -1,2 +0,0 @@
-import { LoadEntitiesActions } from './load-entities.model';
-export declare function createLoadEntitiesTraitActions<Entity>(actionsGroupKey: string, entitiesName: string): LoadEntitiesActions<Entity>;

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

@@ -1,44 +0,0 @@
-import { LoadEntitiesState, LoadEntitiesConfig } from './load-entities.model';
-/**
- * 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
- *
- * @example
- * // The following trait config
- *
- * export interface TestState
- * extends LoadEntitiesState<Todo>{}
- *
- *    const traits = createEntityFeatureFactory(
- *      {entityName: 'Todo'},
- *      addLoadEntitiesTrait<Todo>(),
- *    )({
- *      actionsGroupKey: '[Todos]',
- *      featureSelector: createFeatureSelector<TestState>>(
- *        'todos',
- *      ),
- *    });
- *
- * //   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.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-entities/load-entities.trait.reducer.d.ts

@@ -1,4 +0,0 @@
-import { LoadEntitiesState, LoadEntitiesActions, LoadEntitiesKeyedConfig, LoadEntitiesMutators } from './load-entities.model';
-import { EntitiesPaginationKeyedConfig } from '../entities-pagination';
-export declare function createLoadEntitiesInitialState<Entity>(previousInitialState: {} | undefined, allConfigs: LoadEntitiesKeyedConfig<Entity>): LoadEntitiesState<Entity>;
-export declare function createLoadEntitiesTraitReducer<T, S extends LoadEntitiesState<T>>(initialState: S, actions: LoadEntitiesActions<T>, allMutators: LoadEntitiesMutators<T>, allConfigs: LoadEntitiesKeyedConfig<T> & EntitiesPaginationKeyedConfig): import("@ngrx/store").ActionReducer<unknown extends S ? S : S, import("@ngrx/store").Action<string>>;

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

@@ -1,3 +0,0 @@
-import { LoadEntitiesKeyedConfig, LoadEntitiesSelectors } from './load-entities.model';
-import { FilterEntitiesKeyedConfig } from '../filter-entities';
-export declare function createLoadEntitiesTraitSelectors<Entity>(allConfigs?: LoadEntitiesKeyedConfig<Entity> & FilterEntitiesKeyedConfig<Entity, unknown>): LoadEntitiesSelectors<Entity>;

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

@@ -1,4 +0,0 @@
-import { StatusState } from './load-entities.model';
-export declare function isLoading<S extends StatusState>(state: S): boolean;
-export declare function isSuccess<S extends StatusState>(state: S): boolean;
-export declare function isFail<S extends StatusState>(state: S): boolean;

package/load-entity/index.d.ts

@@ -1,2 +0,0 @@
-export * from './load-entity.traits';
-export * from './load-entity.model';

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

@@ -1,9 +0,0 @@
-import { PostfixProps, PrefixProps, TraitActions } from '@ngrx-traits/core';
-import { AsyncActionActions, AsyncActionState } from '../async-action/async-action.model';
-export type LoadEntityActions<J extends string, Request extends object, Response extends object, Failure extends object> = PrefixProps<AsyncActionActions<Request, Response, Failure, J>, 'load'> & TraitActions;
-export type LoadEntityState<T, J extends string> = AsyncActionState<`load${Capitalize<J & string>}`> & PrefixProps<{
-    ''?: T;
-}, J>;
-export type LoadEntitySelectors<T, J extends string> = PostfixProps<{
-    select: (state: LoadEntityState<T, J>) => T;
-}, J>;

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

@@ -1,74 +0,0 @@
-import { ActionCreatorProps } from '@ngrx/store/src/models';
-import { LoadEntityState } from './load-entity.model';
-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. 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,
- * @param options.actionSuccessProps - Optional param for the request success
- * action, use the props() function for its value, if not present action success will have no params
- * @param options.actionFailProps - Optional param for the request fail action,
- * use the props() function for its value, if not present action fail will have no params
- * @returns the trait factory
- *
- * @example
- *
- * export interface TestState
- * extends LoadEntityState<Client,'client'>{}
- *
- * const traits = createEntityFeatureFactory(
- * ...addLoadEntityTraits({
- *        entityName: 'client',
- *        requestProps: props<{ id: string }>(),
- *        responseProps: props<{ client: Client }>(),
- *      }),
- * )({
- *      actionsGroupKey: 'Client',
- *      featureSelector: createFeatureSelector<
- *        LoadEntityState<Client, 'client'>
- *        >('client'),
- *    });
- *
- * //   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();
- * // 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 extends LoadEntityState<any, string> = LoadEntityState<Entity, J>>({ entityName, actionProps, actionSuccessProps, actionFailProps, }: {
-    entityName: J;
-    actionProps?: ActionCreatorProps<Request>;
-    actionSuccessProps?: ActionCreatorProps<Response>;
-    actionFailProps?: ActionCreatorProps<Failure>;
-}): readonly [import("@ngrx-traits/core").TraitFactory<import("@ngrx-traits/core").PrefixProps<import("@ngrx-traits/common").StatusState, `load${Capitalize<J>}`>, import("@ngrx-traits/core").PrefixProps<{
-    '': import("@ngrx-traits/common").ActionCreatorWithOptionalProps<Request>;
-    Success: import("@ngrx-traits/common").ActionCreatorWithOptionalProps<Response>;
-    Fail: import("@ngrx-traits/common").ActionCreatorWithOptionalProps<Failure>;
-}, `load${Capitalize<J>}`>, import("@ngrx-traits/core").PostfixProps<{
-    isLoading: (state: import("@ngrx-traits/core").PrefixProps<import("@ngrx-traits/common").StatusState, `load${Capitalize<J>}`>) => boolean;
-    isSuccess: (state: import("@ngrx-traits/core").PrefixProps<import("@ngrx-traits/common").StatusState, `load${Capitalize<J>}`>) => boolean;
-    isFail: (state: import("@ngrx-traits/core").PrefixProps<import("@ngrx-traits/common").StatusState, `load${Capitalize<J>}`>) => boolean;
-}, `load${Capitalize<J>}`>, {}, string, {
-    name: `load${Capitalize<J>}`;
-    actionProps: ActionCreatorProps<Request> | undefined;
-    actionSuccessProps: ActionCreatorProps<Response> | undefined;
-    actionFailProps: ActionCreatorProps<Failure> | undefined;
-}, import("@ngrx-traits/core").AllTraitConfigs>, import("@ngrx-traits/core").TraitFactory<State, {}, import("@ngrx-traits/core").PostfixProps<{
-    select: (state: LoadEntityState<Entity, J>) => Entity;
-}, J>, {}, `load${string}`, {
-    entityName: J;
-    actionProps: ActionCreatorProps<Request> | undefined;
-    actionSuccessProps: ActionCreatorProps<Response> | undefined;
-    actionFailProps: ActionCreatorProps<Failure> | undefined;
-}, import("@ngrx-traits/core").AllTraitConfigs>];
-export {};

package/reset/index.d.ts

@@ -1 +0,0 @@
-export * from './reset.trait';

package/reset/reset.trait.d.ts

@@ -1,30 +0,0 @@
-import { Action, ActionCreator } 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
- * @param traitConfig.resetOn - set an extra action which will also trigger a reset state,
- * useful if you want to create an action that reset several features states
- *
- * @example
- * // The following trait config
- *
- *    const traits = createEntityFeatureFactory(
- *      {entityName: 'Todo'},
- *      addLoadEntitiesTrait<Todo>(),
- *      addResetEntitiesStateTrait()
- *    )({
- *      actionsGroupKey: '[Todos]',
- *      featureSelector: createFeatureSelector<TestState>>(
- *        'todos',
- *      ),
- *    });
- * // generated actions
- * traits.actions.resetTodosState()
- */
-export declare function addResetEntitiesStateTrait(traitConfig?: {
-    resetOn?: readonly ActionCreator[];
-}): import("@ngrx-traits/core").TraitFactory<{}, {
-    resetEntitiesState: ActionCreator<`${string} Reset ${string} State`, () => Action<`${string} Reset ${string} State`>>;
-}, {}, {}, "reset", {
-    resetOn?: readonly ActionCreator[];
-}, import("@ngrx-traits/core").AllTraitConfigs>;

package/select-entities/index.d.ts

@@ -1,3 +0,0 @@
-export * from './select-entities.model';
-export * from './select-entities.trait';
-export * from './select-entities.utils';

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

@@ -1,42 +0,0 @@
-import { Dictionary } from '@ngrx/entity';
-import { Action } from '@ngrx/store';
-import { ActionCreator } from '@ngrx/store/src/models';
-import { LoadEntitiesState } from '../load-entities/load-entities.model';
-export interface SelectEntitiesState {
-    selectedIds: Dictionary<boolean>;
-}
-export type SelectEntitiesActions = {
-    selectEntities: ActionCreator<string, (props: {
-        id: number | string;
-    }) => {
-        id: number | string;
-    } & Action<string>>;
-    deselectEntities: ActionCreator<string, (props: {
-        id: number | string;
-    }) => {
-        id: number | string;
-    } & Action<string>>;
-    toggleSelectEntities: ActionCreator<string, (props: {
-        id: number | string;
-    }) => {
-        id: number | string;
-    } & Action<string>>;
-    toggleSelectAllEntities: ActionCreator<string, () => Action<string>>;
-    clearEntitiesSelection: ActionCreator<string, () => Action<string>>;
-};
-export type SelectEntitiesSelectors<Entity> = {
-    isAllEntitiesSelected: (state: LoadEntitiesState<Entity> & SelectEntitiesState) => Selected;
-    selectEntitiesIdsSelectedMap: (state: LoadEntitiesState<Entity> & SelectEntitiesState) => Dictionary<boolean>;
-    selectEntitiesIdsSelectedList: (state: LoadEntitiesState<Entity> & SelectEntitiesState) => number[] | string[];
-    selectEntitiesSelectedMap: (state: LoadEntitiesState<Entity> & SelectEntitiesState) => Dictionary<Entity>;
-    selectEntitiesSelectedList: (state: LoadEntitiesState<Entity> & SelectEntitiesState) => Entity[];
-    selectTotalSelectedEntities: (state: LoadEntitiesState<Entity> & SelectEntitiesState) => number;
-};
-export type SelectEntitiesMutators<Entity> = {
-    selectEntities: <S extends LoadEntitiesState<Entity> & SelectEntitiesState>(id: number | string, state: S) => S;
-    deselectEntities<S extends LoadEntitiesState<Entity> & SelectEntitiesState>(id: number | string, state: S): S;
-    toggleSelectEntities<S extends LoadEntitiesState<Entity> & SelectEntitiesState>(id: number | string, state: S): S;
-    toggleSelectAllEntities<S extends LoadEntitiesState<Entity> & SelectEntitiesState>(state: S): S;
-    clearEntitiesSelection<S extends LoadEntitiesState<Entity> & SelectEntitiesState>(state: S): S;
-};
-export type Selected = 'all' | 'some' | 'none';

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

@@ -1,2 +0,0 @@
-import { SelectEntitiesActions } from './select-entities.model';
-export declare function createSelectEntitiesTraitActions(actionsGroupKey: string, entitiesName: string): SelectEntitiesActions;

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

@@ -1,39 +0,0 @@
-import { SelectEntitiesSelectors, SelectEntitiesActions } from './select-entities.model';
-/**
- * Generates ngrx code to add multi selection to a list
- *
- * @example
- * // The following trait config
- *
- * export interface TestState
- * extends EntityAndStatusState<Todo>,MultipleSelectionState{}
- *
- *    const traits = createEntityFeatureFactory(
- *      {entityName: 'Todo'},
- *      addLoadEntitiesTrait<Todo>(),
- *      addSelectEntitiesTrait<Todo>()
- *    )({
- *      actionsGroupKey: '[Todos]',
- *      featureSelector: createFeatureSelector<TestState>>(
- *        'todos',
- *      ),
- *    });
- *
- * //   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()
- * traits.selectors.selectTodosSelectedMap()
- * traits.selectors.selectTodosSelectedList()
- * traits.selectors.selectTotalSelectedTodos()
- */
-export declare function addSelectEntitiesTrait<Entity>(): import("@ngrx-traits/core").TraitFactory<import("../load-entities/load-entities.model").LoadEntitiesState<Entity> & import("./select-entities.model").SelectEntitiesState, SelectEntitiesActions, SelectEntitiesSelectors<Entity>, import("./select-entities.model").SelectEntitiesMutators<Entity>, "SelectEntities", unknown, import("@ngrx-traits/core").AllTraitConfigs>;

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

@@ -1,2 +0,0 @@
-import { SelectEntitiesMutators, SelectEntitiesSelectors } from './select-entities.model';
-export declare function createSelectEntitiesTraitMutators<Entity>({ isAllEntitiesSelected, }: SelectEntitiesSelectors<Entity>): SelectEntitiesMutators<Entity>;

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

@@ -1,8 +0,0 @@
-import { LoadEntitiesActions, LoadEntitiesKeyedConfig, LoadEntitiesState } from '../load-entities/load-entities.model';
-import { SortEntitiesActions, SortEntitiesKeyedConfig } from '../sort-entities/sort-entities.model';
-import { SelectEntitiesMutators, SelectEntitiesActions, SelectEntitiesState } from './select-entities.model';
-import { CrudEntitiesActions } from '../crud-entities/crud-entities.model';
-import { EntitiesPaginationActions, EntitiesPaginationKeyedConfig } from '../entities-pagination/entities-pagination.model';
-import { FilterEntitiesActions } from '../filter-entities';
-export declare function createSelectEntitiesInitialState<Entity>(previousInitialState: any): LoadEntitiesState<Entity> & SelectEntitiesState;
-export declare function createSelectEntitiesTraitReducer<Entity, S extends LoadEntitiesState<Entity> & SelectEntitiesState>(initialState: S, allActions: SelectEntitiesActions & CrudEntitiesActions<Entity> & SortEntitiesActions<Entity> & LoadEntitiesActions<Entity> & FilterEntitiesActions<any> & EntitiesPaginationActions, allMutators: SelectEntitiesMutators<Entity>, allConfigs: LoadEntitiesKeyedConfig<Entity> & EntitiesPaginationKeyedConfig & SortEntitiesKeyedConfig<Entity>): import("@ngrx/store").ActionReducer<unknown extends S ? S : S, import("@ngrx/store").Action<string>>;

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

@@ -1,3 +0,0 @@
-import { SelectEntitiesSelectors } from './select-entities.model';
-import { LoadEntitiesSelectors } from '../load-entities';
-export declare function createSelectEntitiesTraitSelectors<Entity>(previousSelectors: LoadEntitiesSelectors<Entity>): SelectEntitiesSelectors<Entity>;

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

@@ -1,7 +0,0 @@
-import { SelectEntitiesState } from './select-entities.model';
-import { LoadEntitiesState } from '../load-entities';
-export declare function deselectEntities<S extends SelectEntitiesState>(id: number | string, state: S): S;
-export declare function selectEntities<S extends SelectEntitiesState>(id: number | string, state: S): S;
-export declare function toggleSelectEntities<S extends SelectEntitiesState>(id: number | string, state: S): S;
-export declare function clearEntitiesSelection<S extends SelectEntitiesState>(state: S): S;
-export declare function selectTotalSelectedEntities<Entity, S extends LoadEntitiesState<Entity> & SelectEntitiesState>(state: S): number;

package/select-entity/index.d.ts

@@ -1,2 +0,0 @@
-export * from './select-entity.trait';
-export * from './select-entity.model';

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

@@ -1,34 +0,0 @@
-import { KeyedConfig } from '@ngrx-traits/core';
-import { Action } from '@ngrx/store';
-import { ActionCreator } from '@ngrx/store/src/models';
-import { LoadEntitiesState } from '../load-entities/load-entities.model';
-export interface SelectEntityState {
-    selectedId?: number | string;
-}
-export type SelectEntityActions = {
-    selectEntity: ActionCreator<string, (props: {
-        id: number | string;
-    }) => {
-        id: number | string;
-    } & Action<string>>;
-    deselectEntity: ActionCreator<string, () => Action<string>>;
-    toggleSelectEntity: ActionCreator<string, (props: {
-        id: number | string;
-    }) => {
-        id: number | string;
-    } & Action<string>>;
-};
-export type SelectEntitySelectors<T> = {
-    selectEntityIdSelected: (state: LoadEntitiesState<T> & SelectEntityState) => string | number | undefined;
-    selectEntitySelected: (state: LoadEntitiesState<T> & SelectEntityState) => T | undefined;
-};
-export type SelectEntityMutators<T> = {
-    selectEntity<S extends LoadEntitiesState<T> & SelectEntityState>(id: string | number, state: S): S;
-    deselectEntity<S extends LoadEntitiesState<T> & SelectEntityState>(state: S): S;
-    toggleSelectEntity<S extends LoadEntitiesState<T> & SelectEntityState>(id: string | number, state: S): S;
-};
-export interface SelectEntityConfig {
-    selectedId?: string | number;
-}
-export declare const selectEntityTraitKey = "singleSelection";
-export type SelectEntityKeyedConfig = KeyedConfig<typeof selectEntityTraitKey, SelectEntityConfig>;

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

@@ -1,2 +0,0 @@
-import { SelectEntityActions } from './select-entity.model';
-export declare function createSelectEntityTraitActions(actionsGroupKey: string, entityName: string): SelectEntityActions;

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

@@ -1,35 +0,0 @@
-import { SelectEntityActions, SelectEntityConfig } from './select-entity.model';
-/**
- * Generates ngrx code to add single selection to a list
- * @param config
- * @param config.selectedId - Default selected id
- *
- * @example
- * // The following trait config
- *
- * export interface TestState
- * extends EntityAndStatusState<Todo>,SelectEntityState{}
- *
- *    const traits = createEntityFeatureFactory(
- *      {entityName: 'Todo'},
- *      addLoadEntitiesTrait<Todo>(),
- *      addSelectEntityTrait<Todo>()
- *    )({
- *      actionsGroupKey: '[Todos]',
- *      featureSelector: createFeatureSelector<TestState>>(
- *        'todos',
- *      ),
- *    });
- *
- * //   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()
- */
-export declare function addSelectEntityTrait<Entity>(config?: SelectEntityConfig): import("@ngrx-traits/core").TraitFactory<import("../load-entities/load-entities.model").LoadEntitiesState<Entity> & import("./select-entity.model").SelectEntityState, SelectEntityActions, import("./select-entity.model").SelectEntitySelectors<Entity>, import("./select-entity.model").SelectEntityMutators<unknown>, "singleSelection", SelectEntityConfig, import("@ngrx-traits/core").AllTraitConfigs>;

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

@@ -1,2 +0,0 @@
-import { SelectEntityMutators } from './select-entity.model';
-export declare function createSelectEntityTraitMutators<Entity>(): SelectEntityMutators<Entity>;

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

@@ -1,8 +0,0 @@
-import { LoadEntitiesActions, LoadEntitiesKeyedConfig, LoadEntitiesState } from '../load-entities/load-entities.model';
-import { SortEntitiesActions, SortEntitiesKeyedConfig } from '../sort-entities/sort-entities.model';
-import { SelectEntityActions, SelectEntityKeyedConfig, SelectEntityMutators, SelectEntityState } from './select-entity.model';
-import { CrudEntitiesActions } from '../crud-entities/crud-entities.model';
-import { EntitiesPaginationActions, EntitiesPaginationKeyedConfig } from '../entities-pagination/entities-pagination.model';
-import { FilterEntitiesActions } from '../filter-entities';
-export declare function createSelectEntityInitialState<Entity>(previousInitialState: any, allConfigs: SelectEntityKeyedConfig): LoadEntitiesState<Entity> & SelectEntityState;
-export declare function createSelectEntityTraitReducer<Entity, S extends LoadEntitiesState<Entity> & SelectEntityState>(initialState: S, allActions: SelectEntityActions & CrudEntitiesActions<Entity> & SortEntitiesActions<Entity> & EntitiesPaginationActions & FilterEntitiesActions<any> & LoadEntitiesActions<Entity>, allMutators: SelectEntityMutators<Entity>, allConfigs: SelectEntityKeyedConfig & LoadEntitiesKeyedConfig<Entity> & EntitiesPaginationKeyedConfig & SortEntitiesKeyedConfig<Entity>): import("@ngrx/store").ActionReducer<unknown extends S ? S : S, import("@ngrx/store").Action<string>>;

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

@@ -1,2 +0,0 @@
-import { SelectEntitySelectors } from './select-entity.model';
-export declare function createSelectEntityTraitSelectors<Entity>(): SelectEntitySelectors<Entity>;

package/set-entity/index.d.ts

@@ -1,2 +0,0 @@
-export * from './set-entity.model';
-export * from './set-entity.trait';

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

@@ -1,17 +0,0 @@
-import { PostfixProps } from '@ngrx-traits/core';
-import { Action } from '@ngrx/store';
-import { ActionCreator } from '@ngrx/store/src/models';
-type SetActions<T> = {
-    /**
-     * set entity in the store
-     */
-    set: ActionCreator<string, (props: T) => Action<string>>;
-};
-export type SetEntityActions<Entity, J extends string> = PostfixProps<SetActions<Entity>, J>;
-export type SetEntityState<Entity, J extends string> = {
-    [key in `${J}`]?: Entity;
-};
-export type SetEntitySelectors<Entity, J extends string> = PostfixProps<{
-    select: (state: SetEntityState<Entity, J>) => Entity;
-}, J>;
-export {};

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

@@ -1,46 +0,0 @@
-import { SetEntityState } from './set-entity.model';
-import { ActionCreatorProps } from '@ngrx/store/src/models';
-type RecordEntity<T> = T extends Record<string, infer J> ? J : never;
-/**
- * Generates ngrx code needed to set and entity in the store state
- * @param entityName - Entity name, should be in camel case
- * @param options.actionProps - param for the main request action,
- * use the props() function for its value
- * @returns the trait factory
- *
- * @example
- *
- * export interface TestState
- * extends SetEntityState<Client,'client'>{}
- *
- * const traits = createEntityFeatureFactory(
- * addSetEntityTraits({
- *        entityName: 'client',
- *        actionProps: props<{ client: Client }
- *      }),
- * )({
- *      actionsGroupKey: 'Client',
- *      featureSelector: createFeatureSelector<
- *        SetEntityState<Client, 'client'>
- *        >('client'),
- *    });
- * //   adds following props to the state:
- * //    client?: Client;
- *
- * // generated actions
- * traits.actions.setClient({client: {id:123, name: 'gabs'}});
- * //generated selectors
- * traits.selectors.selectClient()
- */
-export declare function addSetEntityTrait<J extends string, Payload extends Record<J, any> | undefined = undefined, Entity = RecordEntity<Payload>, State extends SetEntityState<Entity, J> = SetEntityState<Entity, J>>({ entityName, actionProps, }: {
-    entityName: J;
-    actionProps?: ActionCreatorProps<Payload>;
-}): import("@ngrx-traits/core").TraitFactory<State, import("@ngrx-traits/core").PostfixProps<{
-    set: import("@ngrx/store").ActionCreator<string, (props: Payload) => import("@ngrx/store").Action<string>>;
-}, J>, import("@ngrx-traits/core").PostfixProps<{
-    select: (state: SetEntityState<Entity, J>) => Entity;
-}, J>, {}, `load${string}`, {
-    entityName: J;
-    actionProps: ActionCreatorProps<Payload> | undefined;
-}, import("@ngrx-traits/core").AllTraitConfigs>;
-export {};

package/sort-entities/index.d.ts

@@ -1,3 +0,0 @@
-export * from './sort-entities.model';
-export * from './sort-entities.trait';
-export * from './sort-entities.utils';