@ngrx-traits/common 19.2.2 → 20.0.0-beta.1

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

@@ -1,36 +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 declare type SortDirection = 'asc' | 'desc' | '';
-export interface Sort<T> {
-    /** The id of the column being sorted. */
-    active: keyof T;
-    /** The sort direction. */
-    direction: SortDirection;
-}
-export interface SortEntitiesState<T> {
-    sort: {
-        current: Sort<T>;
-        default: Sort<T>;
-    };
-}
-export type SortEntitiesActions<T> = {
-    sortEntities: ActionCreator<string, (props: Sort<T>) => Sort<T> & Action<string>>;
-    /**
-     * Sets the default sort back
-     */
-    resetEntitiesSort: ActionCreator<string, () => Action<string>>;
-};
-export type SortEntitiesSelectors<T> = {
-    selectEntitiesSort: (state: LoadEntitiesState<T> & SortEntitiesState<T>) => Sort<T>;
-};
-export type SortEntitiesMutators<T> = {
-    sortEntities<S extends LoadEntitiesState<T> & SortEntitiesState<T>>({ active, direction }: Sort<T>, state: S): S;
-};
-export declare const sortTraitKey = "sort";
-export interface SortEntitiesConfig<T> {
-    defaultSort: Sort<T>;
-    remote: boolean;
-}
-export type SortEntitiesKeyedConfig<T> = KeyedConfig<typeof sortTraitKey, SortEntitiesConfig<T>>;

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

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

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

@@ -1,41 +0,0 @@
-import { SortEntitiesActions, SortEntitiesConfig, SortEntitiesSelectors } from './sort-entities.model';
-/**
- * Generates ngrx code to sort locally or remotely a list of entities
- * @param config
- * @param config.defaultSort - Required field, Default entity prop for the sort
- * @param config.remote - Required field, default to false, when true disables local
- * sorting and every sort action call will now trigger a loadEntities action and the backend
- * should sort the data, use selectSort in the effect that call backend to get the requested sort,
- * when false all sorting is done in memory when the sort action is fired
- *
- * @example
- * // The following trait config
- * export interface TestState
- * extends EntityAndStatusState<Todo>, SortState<Todo>{}
- *
- *    const traits = createEntityFeatureFactory(
- *      {entityName: 'Todo'},
- *      addLoadEntitiesTrait<Todo>(),
- *      addSortEntitiesTrait<Todo>({
- *        remote: true,
- *        defaultSort: {active:'id', direction:'asc'}
- *      })
- *    )({
- *      actionsGroupKey: '[Todos]',
- *      featureSelector: createFeatureSelector<TestState>>(
- *        'todos',
- *      ),
- *    });
- * //   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.trait.effect.d.ts

@@ -1,6 +0,0 @@
-import { TraitEffect } from '@ngrx-traits/core';
-import { Type } from '@ngrx-traits/core';
-import { LoadEntitiesActions, LoadEntitiesKeyedConfig } from '../load-entities/load-entities.model';
-import { SortEntitiesActions, SortEntitiesKeyedConfig } from './sort-entities.model';
-import { EntitiesPaginationActions } from '../entities-pagination/entities-pagination.model';
-export declare function createSortTraitEffect<Entity>(allActions: LoadEntitiesActions<Entity> & SortEntitiesActions<Entity> & EntitiesPaginationActions, allConfigs: LoadEntitiesKeyedConfig<Entity> & SortEntitiesKeyedConfig<Entity>): Type<TraitEffect>[];

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

@@ -1,3 +0,0 @@
-import { LoadEntitiesKeyedConfig, LoadEntitiesSelectors } from '../load-entities/load-entities.model';
-import { SortEntitiesMutators } from './sort-entities.model';
-export declare function createSortTraitMutators<Entity>({ selectEntitiesList }: LoadEntitiesSelectors<Entity>, allConfigs: LoadEntitiesKeyedConfig<Entity>): SortEntitiesMutators<Entity>;

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

@@ -1,4 +0,0 @@
-import { LoadEntitiesActions, LoadEntitiesKeyedConfig, LoadEntitiesState } from '../load-entities';
-import { SortEntitiesActions, SortEntitiesKeyedConfig, SortEntitiesMutators, SortEntitiesState } from './sort-entities.model';
-export declare function createSortInitialState<Entity>(previousInitialState: any, allConfigs: SortEntitiesKeyedConfig<Entity>): LoadEntitiesState<Entity> & SortEntitiesState<Entity>;
-export declare function createSortTraitReducer<Entity, S extends LoadEntitiesState<Entity> & SortEntitiesState<Entity> = LoadEntitiesState<Entity> & SortEntitiesState<Entity>>(initialState: S, allActions: SortEntitiesActions<Entity> & LoadEntitiesActions<Entity>, allMutators: SortEntitiesMutators<Entity>, allConfigs: LoadEntitiesKeyedConfig<Entity> & SortEntitiesKeyedConfig<Entity>): import("@ngrx/store").ActionReducer<unknown extends S ? S : S, import("@ngrx/store").Action<string>>;

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

@@ -1,2 +0,0 @@
-import { SortEntitiesSelectors } from './sort-entities.model';
-export declare function createSortTraitSelectors<Entity>(): SortEntitiesSelectors<Entity>;

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

@@ -1,10 +0,0 @@
-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.
- */
-export declare function sortData<T>(data: T[], sort: Sort<T>): T[];