@ngrx-traits/common 0.0.1

package/esm2015/set-entity/set-entity.trait.js

@@ -0,0 +1,52 @@
+import { capitalize, createTraitFactory, } from '@ngrx-traits/core';
+import { createAction, createReducer, on } from '@ngrx/store';
+/**
+ * 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
+ * const traits = createEntityFeatureFactory(
+ * addSetEntityTraits({
+ *        entityName: 'client',
+ *        actionProps: props<{ client: { id: number; name: string } }
+ *      }),
+ * )({
+ *      actionsGroupKey: 'Client',
+ *      featureSelector: createFeatureSelector<
+ *        SetEntityState<Client, 'client'>
+ *        >('client'),
+ *    });
+ *
+ * // will generate
+ * traits.actions.setClient({client: {id:123, name: 'gabs'}});
+ * traits.selectors.selectClient
+ */
+export function addSetEntityTrait({ entityName, actionProps, }) {
+    const capitalizedName = capitalize(entityName);
+    return createTraitFactory({
+        key: `load${capitalizedName}`,
+        config: { entityName, actionProps },
+        actions: ({ actionsGroupKey }) => {
+            const setEntity = createAction(`${actionsGroupKey} Set ${capitalizedName}`, actionProps);
+            return {
+                [`set${capitalizedName}`]: setEntity,
+            };
+        },
+        selectors: () => {
+            function selectEntity(state) {
+                return state[`${entityName}`];
+            }
+            return {
+                [`select${capitalizedName}`]: selectEntity,
+            };
+        },
+        initialState: ({ previousInitialState }) => previousInitialState,
+        reducer: ({ initialState, allActions }) => {
+            return createReducer(initialState, on(allActions[`set${capitalizedName}`], (state, action) => (Object.assign(Object.assign({}, state), { [entityName]: action[entityName] }))));
+        },
+    });
+}
+//# sourceMappingURL=set-entity.trait.js.map

package/esm2015/set-entity/set-entity.trait.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"set-entity.trait.js","sourceRoot":"","sources":["../../../../../../libs/ngrx-traits/common/src/lib/set-entity/set-entity.trait.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,kBAAkB,GAEnB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,EAAE,EAAE,MAAM,aAAa,CAAC;AAY9D;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,UAAU,iBAAiB,CAK/B,EACA,UAAU,EACV,WAAW,GAIZ;IACC,MAAM,eAAe,GAAG,UAAU,CAAC,UAAU,CAAC,CAAC;IAE/C,OAAO,kBAAkB,CAAC;QACxB,GAAG,EAAE,OAAO,eAAe,EAAE;QAC7B,MAAM,EAAE,EAAE,UAAU,EAAE,WAAW,EAAE;QACnC,OAAO,EAAE,CAAC,EAAE,eAAe,EAA6B,EAAE,EAAE;YAC1D,MAAM,SAAS,GAAG,YAAY,CAC5B,GAAG,eAAe,QAAQ,eAAe,EAAE,EAC3C,WAAkB,CACnB,CAAC;YAEF,OAAO;gBACL,CAAC,MAAM,eAAe,EAAE,CAAC,EAAE,SAAS;aACL,CAAC;QACpC,CAAC;QACD,SAAS,EAAE,GAAG,EAAE;YACd,SAAS,YAAY,CAAC,KAAY;gBAChC,OAAQ,KAAa,CAAC,GAAG,UAAU,EAAE,CAAW,CAAC;YACnD,CAAC;YAED,OAAO;gBACL,CAAC,SAAS,eAAe,EAAE,CAAC,EAAE,YAAY;aACV,CAAC;QACrC,CAAC;QACD,YAAY,EAAE,CAAC,EAAE,oBAAoB,EAAkC,EAAE,EAAE,CACzE,oBAA6B;QAC/B,OAAO,EAAE,CAAC,EAAE,YAAY,EAAE,UAAU,EAAE,EAAE,EAAE;YACxC,OAAO,aAAa,CAClB,YAAY,EACZ,EAAE,CACC,UAAkB,CAAC,MAAM,eAAe,EAAE,CAAC,EAC5C,CAAC,KAAU,EAAE,MAAW,EAAE,EAAE,CAAC,iCACxB,KAAK,KACR,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC,IAChC,CACH,CACF,CAAC;QACJ,CAAC;KACF,CAAC,CAAC;AACL,CAAC","sourcesContent":["import {\n  capitalize,\n  createTraitFactory,\n  TraitActionsFactoryConfig,\n} from '@ngrx-traits/core';\nimport { createAction, createReducer, on } from '@ngrx/store';\n\nimport {\n  SetEntityActions,\n  SetEntitySelectors,\n  SetEntityState,\n} from './set-entity.model';\nimport { TraitInitialStateFactoryConfig } from '@ngrx-traits/core';\nimport { ActionCreatorProps } from '@ngrx/store/src/models';\n\ntype RecordEntity<T> = T extends Record<string, infer J> ? J : never;\n\n/**\n * Generates ngrx code needed to set and entity in the store state\n * @param entityName - Entity name, should be in camel case\n * @param options.actionProps - param for the main request action,\n * use the props() function for its value\n * @returns the trait factory\n *\n * @example\n * const traits = createEntityFeatureFactory(\n * addSetEntityTraits({\n *        entityName: 'client',\n *        actionProps: props<{ client: { id: number; name: string } }\n *      }),\n * )({\n *      actionsGroupKey: 'Client',\n *      featureSelector: createFeatureSelector<\n *        SetEntityState<Client, 'client'>\n *        >('client'),\n *    });\n *\n * // will generate\n * traits.actions.setClient({client: {id:123, name: 'gabs'}});\n * traits.selectors.selectClient\n */\nexport function addSetEntityTrait<\n  J extends string,\n  Payload extends Record<J, any> | undefined = undefined,\n  Entity = RecordEntity<Payload>,\n  State = SetEntityState<Entity, J>\n>({\n  entityName,\n  actionProps,\n}: {\n  entityName: J;\n  actionProps?: ActionCreatorProps<Payload>;\n}) {\n  const capitalizedName = capitalize(entityName);\n\n  return createTraitFactory({\n    key: `load${capitalizedName}`,\n    config: { entityName, actionProps },\n    actions: ({ actionsGroupKey }: TraitActionsFactoryConfig) => {\n      const setEntity = createAction(\n        `${actionsGroupKey} Set ${capitalizedName}`,\n        actionProps as any\n      );\n\n      return {\n        [`set${capitalizedName}`]: setEntity,\n      } as SetEntityActions<Payload, J>;\n    },\n    selectors: () => {\n      function selectEntity(state: State) {\n        return (state as any)[`${entityName}`] as Entity;\n      }\n\n      return {\n        [`select${capitalizedName}`]: selectEntity,\n      } as SetEntitySelectors<Entity, J>;\n    },\n    initialState: ({ previousInitialState }: TraitInitialStateFactoryConfig) =>\n      previousInitialState as State,\n    reducer: ({ initialState, allActions }) => {\n      return createReducer(\n        initialState,\n        on(\n          (allActions as any)[`set${capitalizedName}`],\n          (state: any, action: any) => ({\n            ...state,\n            [entityName]: action[entityName],\n          })\n        )\n      );\n    },\n  });\n}\n"]}

package/esm2015/sort-entities/index.js

@@ -0,0 +1,4 @@
+export * from './sort-entities.model';
+export * from './sort-entities.trait';
+export * from './sort-entities.utils';
+//# sourceMappingURL=index.js.map

package/esm2015/sort-entities/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../libs/ngrx-traits/common/src/lib/sort-entities/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC","sourcesContent":["export * from './sort-entities.model';\nexport * from './sort-entities.trait';\nexport * from './sort-entities.utils';\n"]}

package/esm2015/sort-entities/sort-entities.model.js

@@ -0,0 +1,2 @@
+export const sortTraitKey = 'sort';
+//# sourceMappingURL=sort-entities.model.js.map

package/esm2015/sort-entities/sort-entities.model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sort-entities.model.js","sourceRoot":"","sources":["../../../../../../libs/ngrx-traits/common/src/lib/sort-entities/sort-entities.model.ts"],"names":[],"mappings":"AA6CA,MAAM,CAAC,MAAM,YAAY,GAAG,MAAM,CAAC","sourcesContent":["import { LoadEntitiesState } from '../load-entities/load-entities.model';\n\nimport { ActionCreator, TypedAction } from '@ngrx/store/src/models';\nimport { KeyedConfig } from '@ngrx-traits/core';\n\nexport declare type SortDirection = 'asc' | 'desc' | '';\n\nexport interface Sort<T> {\n  /** The id of the column being sorted. */\n  active: keyof T;\n  /** The sort direction. */\n  direction: SortDirection;\n}\n\nexport interface SortEntitiesState<T> {\n  sort: {\n    current: Sort<T>;\n    default: Sort<T>;\n  };\n}\n\nexport type SortEntitiesActions<T> = {\n  sortEntities: ActionCreator<\n    string,\n    (props: Sort<T>) => Sort<T> & TypedAction<string>\n  >;\n  /**\n   * Sets the default sort back\n   */\n  resetEntitiesSort: ActionCreator<string, () => TypedAction<string>>;\n};\n\nexport type SortEntitiesSelectors<T> = {\n  selectEntitiesSort: (\n    state: LoadEntitiesState<T> & SortEntitiesState<T>\n  ) => Sort<T>;\n};\n\nexport type SortEntitiesMutators<T> = {\n  sortEntities<S extends LoadEntitiesState<T> & SortEntitiesState<T>>(\n    { active, direction }: Sort<T>,\n    state: S\n  ): S;\n};\n\nexport const sortTraitKey = 'sort';\n\nexport interface SortEntitiesConfig<T> {\n  defaultSort: Sort<T>;\n  remote?: boolean;\n}\n\nexport type SortEntitiesKeyedConfig<T> = KeyedConfig<\n  typeof sortTraitKey,\n  SortEntitiesConfig<T>\n>;\n"]}

package/esm2015/sort-entities/sort-entities.trait.actions.js

@@ -0,0 +1,8 @@
+import { createAction, props } from '@ngrx/store';
+export function createSortTraitActions(actionsGroupKey, entitiesName) {
+    return {
+        sortEntities: createAction(`${actionsGroupKey} Sort ${entitiesName}`, props()),
+        resetEntitiesSort: createAction(`${actionsGroupKey} Reset ${entitiesName} Sort`),
+    };
+}
+//# sourceMappingURL=sort-entities.trait.actions.js.map

package/esm2015/sort-entities/sort-entities.trait.actions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sort-entities.trait.actions.js","sourceRoot":"","sources":["../../../../../../libs/ngrx-traits/common/src/lib/sort-entities/sort-entities.trait.actions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAGlD,MAAM,UAAU,sBAAsB,CACpC,eAAuB,EACvB,YAAoB;IAEpB,OAAO;QACL,YAAY,EAAE,YAAY,CACxB,GAAG,eAAe,SAAS,YAAY,EAAE,EACzC,KAAK,EAAgB,CACtB;QACD,iBAAiB,EAAE,YAAY,CAC7B,GAAG,eAAe,UAAU,YAAY,OAAO,CAChD;KACF,CAAC;AACJ,CAAC","sourcesContent":["import { createAction, props } from '@ngrx/store';\nimport { Sort, SortEntitiesActions } from './sort-entities.model';\n\nexport function createSortTraitActions<Entity>(\n  actionsGroupKey: string,\n  entitiesName: string\n): SortEntitiesActions<Entity> {\n  return {\n    sortEntities: createAction(\n      `${actionsGroupKey} Sort ${entitiesName}`,\n      props<Sort<Entity>>()\n    ),\n    resetEntitiesSort: createAction(\n      `${actionsGroupKey} Reset ${entitiesName} Sort`\n    ),\n  };\n}\n"]}

package/esm2015/sort-entities/sort-entities.trait.effect.js

@@ -0,0 +1,28 @@
+import { Injectable } from '@angular/core';
+import { TraitEffect } from '@ngrx-traits/core';
+import { createEffect, ofType } from '@ngrx/effects';
+import { concatMap } from 'rxjs/operators';
+import * as i0 from "@angular/core";
+export function createSortTraitEffect(allActions, allConfigs) {
+    const { remote } = allConfigs.sort;
+    class SortEffect extends TraitEffect {
+        constructor() {
+            super(...arguments);
+            this.remoteSort$ = createEffect(() => {
+                return this.actions$.pipe(ofType(allActions.sortEntities, allActions.resetEntitiesSort), concatMap(() => allActions.loadEntitiesFirstPage
+                    ? [
+                        allActions.clearEntitiesPagesCache(),
+                        allActions.loadEntitiesFirstPage(),
+                    ]
+                    : [allActions.loadEntities()]));
+            });
+        }
+    }
+    SortEffect.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "12.1.2", ngImport: i0, type: SortEffect, deps: null, target: i0.ɵɵFactoryTarget.Injectable });
+    SortEffect.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "12.1.2", ngImport: i0, type: SortEffect });
+    i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.1.2", ngImport: i0, type: SortEffect, decorators: [{
+                type: Injectable
+            }] });
+    return remote ? [SortEffect] : [];
+}
+//# sourceMappingURL=sort-entities.trait.effect.js.map

package/esm2015/sort-entities/sort-entities.trait.effect.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sort-entities.trait.effect.js","sourceRoot":"","sources":["../../../../../../libs/ngrx-traits/common/src/lib/sort-entities/sort-entities.trait.effect.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AACrD,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;;AAY3C,MAAM,UAAU,qBAAqB,CACnC,UAE2B,EAC3B,UAA6E;IAE7E,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,IAAK,CAAC;IAEpC,MACM,UAAW,SAAQ,WAAW;QADpC;;YAEE,gBAAW,GAAG,YAAY,CAAC,GAAG,EAAE;gBAC9B,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CACvB,MAAM,CAAC,UAAU,CAAC,YAAY,EAAE,UAAU,CAAC,iBAAiB,CAAC,EAC7D,SAAS,CAAC,GAAG,EAAE,CACb,UAAU,CAAC,qBAAqB;oBAC9B,CAAC,CAAC;wBACE,UAAU,CAAC,uBAAuB,EAAE;wBACpC,UAAU,CAAC,qBAAqB,EAAE;qBACnC;oBACH,CAAC,CAAC,CAAC,UAAU,CAAC,YAAY,EAAE,CAAC,CAChC,CACF,CAAC;YACJ,CAAC,CAAC,CAAC;SACJ;;2GAdK,UAAU;+GAAV,UAAU;+FAAV,UAAU;sBADf,UAAU;;IAgBX,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;CACnC","sourcesContent":["import { Injectable } from '@angular/core';\nimport { TraitEffect } from '@ngrx-traits/core';\nimport { createEffect, ofType } from '@ngrx/effects';\nimport { concatMap } from 'rxjs/operators';\nimport { Type } from '@ngrx-traits/core';\nimport {\n  LoadEntitiesActions,\n  LoadEntitiesKeyedConfig,\n} from '../load-entities/load-entities.model';\nimport {\n  SortEntitiesActions,\n  SortEntitiesKeyedConfig,\n} from './sort-entities.model';\nimport { EntitiesPaginationActions } from '../entities-pagination/entities-pagination.model';\n\nexport function createSortTraitEffect<Entity>(\n  allActions: LoadEntitiesActions<Entity> &\n    SortEntitiesActions<Entity> &\n    EntitiesPaginationActions,\n  allConfigs: LoadEntitiesKeyedConfig<Entity> & SortEntitiesKeyedConfig<Entity>\n): Type<TraitEffect>[] {\n  const { remote } = allConfigs.sort!;\n\n  @Injectable()\n  class SortEffect extends TraitEffect {\n    remoteSort$ = createEffect(() => {\n      return this.actions$.pipe(\n        ofType(allActions.sortEntities, allActions.resetEntitiesSort),\n        concatMap(() =>\n          allActions.loadEntitiesFirstPage\n            ? [\n                allActions.clearEntitiesPagesCache(),\n                allActions.loadEntitiesFirstPage(),\n              ]\n            : [allActions.loadEntities()]\n        )\n      );\n    });\n  }\n  return remote ? [SortEffect] : [];\n}\n"]}

package/esm2015/sort-entities/sort-entities.trait.js

@@ -0,0 +1,53 @@
+import { createSortTraitMutators } from './sort-entities.trait.mutators';
+import { createSortInitialState, createSortTraitReducer, } from './sort-entities.trait.reducer';
+import { createSortTraitSelectors } from './sort-entities.trait.selectors';
+import { createSortTraitEffect } from './sort-entities.trait.effect';
+import { sortTraitKey, } from './sort-entities.model';
+import { loadEntitiesTraitKey, } from '../load-entities/load-entities.model';
+import { createTraitFactory } from '@ngrx-traits/core';
+import { createSortTraitActions } from './sort-entities.trait.actions';
+/**
+ * Generates ngrx code to sort locally or remotely a list of entities
+ * @param config
+ * @param config.defaultSort - Required, Default entity prop for the sort
+ * @param config.remote - Optional 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(
+ *      addLoadEntitiesTrait<Todo>(),
+ *      addSortEntitiesTrait<Todo>({
+ *        defaultSort: {active:'id', direction:'asc'}
+ *      })
+ *    )({
+ *      actionsGroupKey: '[Todos]',
+ *      featureSelector: createFeatureSelector<TestState>>(
+ *        'todos',
+ *      ),
+ *    });
+ * // will generate  the following actions and selectors, plus the ones generated by other traits
+ * traits.actions.sortTodos({active:'id', direction:'desc'})
+ * traits.actions.resetTodosSort()
+ *
+ * traits.selectors.selectTodosSort()
+ */
+export function addSortEntitiesTrait({ remote = false, defaultSort, }) {
+    return createTraitFactory({
+        key: sortTraitKey,
+        depends: [loadEntitiesTraitKey],
+        config: { remote, defaultSort },
+        actions: ({ actionsGroupKey, entitiesName }) => createSortTraitActions(actionsGroupKey, entitiesName),
+        selectors: () => createSortTraitSelectors(),
+        mutators: ({ allSelectors, allConfigs }) => createSortTraitMutators(allSelectors, allConfigs),
+        initialState: ({ previousInitialState, allConfigs, }) => createSortInitialState(previousInitialState, allConfigs),
+        reducer: ({ initialState, allActions, allMutators, allConfigs }) => createSortTraitReducer(initialState, allActions, allMutators, allConfigs),
+        effects: ({ allActions, allConfigs }) => createSortTraitEffect(allActions, allConfigs),
+    });
+}
+//# sourceMappingURL=sort-entities.trait.js.map

package/esm2015/sort-entities/sort-entities.trait.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sort-entities.trait.js","sourceRoot":"","sources":["../../../../../../libs/ngrx-traits/common/src/lib/sort-entities/sort-entities.trait.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAC;AACzE,OAAO,EACL,sBAAsB,EACtB,sBAAsB,GACvB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,wBAAwB,EAAE,MAAM,iCAAiC,CAAC;AAC3E,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AACrE,OAAO,EAKL,YAAY,GACb,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAIL,oBAAoB,GACrB,MAAM,sCAAsC,CAAC;AAK9C,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AACvD,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AAOvE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,UAAU,oBAAoB,CAAS,EAC3C,MAAM,GAAG,KAAK,EACd,WAAW,GACgB;IAC3B,OAAO,kBAAkB,CAAC;QACxB,GAAG,EAAE,YAAY;QACjB,OAAO,EAAE,CAAC,oBAAoB,CAAC;QAC/B,MAAM,EAAE,EAAE,MAAM,EAAE,WAAW,EAAgC;QAC7D,OAAO,EAAE,CAAC,EAAE,eAAe,EAAE,YAAY,EAA6B,EAAE,EAAE,CACxE,sBAAsB,CAAS,eAAe,EAAE,YAAY,CAAC;QAC/D,SAAS,EAAE,GAAG,EAAE,CAAC,wBAAwB,EAAU;QACnD,QAAQ,EAAE,CAAC,EAAE,YAAY,EAAE,UAAU,EAAmC,EAAE,EAAE,CAC1E,uBAAuB,CACrB,YAC+B,EAC/B,UAAU,CACX;QACH,YAAY,EAAE,CAAC,EACb,oBAAoB,EACpB,UAAU,GACqB,EAAE,EAAE,CACnC,sBAAsB,CAAS,oBAAoB,EAAE,UAAU,CAAC;QAClE,OAAO,EAAE,CAAC,EAAE,YAAY,EAAE,UAAU,EAAE,WAAW,EAAE,UAAU,EAAE,EAAE,EAAE,CACjE,sBAAsB,CACpB,YAAY,EACZ,UAAuE,EACvE,WAAW,EACX,UAEiC,CAClC;QACH,OAAO,EAAE,CAAC,EAAE,UAAU,EAAE,UAAU,EAAE,EAAE,EAAE,CACtC,qBAAqB,CACnB,UAE2B,EAC3B,UACiC,CAClC;KACJ,CAAC,CAAC;AACL,CAAC","sourcesContent":["import { createSortTraitMutators } from './sort-entities.trait.mutators';\nimport {\n  createSortInitialState,\n  createSortTraitReducer,\n} from './sort-entities.trait.reducer';\nimport { createSortTraitSelectors } from './sort-entities.trait.selectors';\nimport { createSortTraitEffect } from './sort-entities.trait.effect';\nimport {\n  SortEntitiesActions,\n  SortEntitiesConfig,\n  SortEntitiesKeyedConfig,\n  SortEntitiesSelectors,\n  sortTraitKey,\n} from './sort-entities.model';\nimport {\n  LoadEntitiesActions,\n  LoadEntitiesKeyedConfig,\n  LoadEntitiesSelectors,\n  loadEntitiesTraitKey,\n} from '../load-entities/load-entities.model';\nimport {\n  EntitiesPaginationActions,\n  EntitiesPaginationKeyedConfig,\n} from '../entities-pagination/entities-pagination.model';\nimport { createTraitFactory } from '@ngrx-traits/core';\nimport { createSortTraitActions } from './sort-entities.trait.actions';\nimport {\n  TraitActionsFactoryConfig,\n  TraitInitialStateFactoryConfig,\n  TraitStateMutatorsFactoryConfig,\n} from '@ngrx-traits/core';\n\n/**\n * Generates ngrx code to sort locally or remotely a list of entities\n * @param config\n * @param config.defaultSort - Required, Default entity prop for the sort\n * @param config.remote - Optional field, default to false, when true disables local\n * sorting and every sort action call will now trigger a loadEntities action and the backend\n * should sort the data, use selectSort in the effect that call backend to get the requested sort,\n * when false all sorting is done in memory when the sort action is fired\n *\n * @example\n * // The following trait config\n * export interface TestState\n * extends EntityAndStatusState<Todo>, SortState<Todo>{}\n *\n *    const traits = createEntityFeatureFactory(\n *      addLoadEntitiesTrait<Todo>(),\n *      addSortEntitiesTrait<Todo>({\n *        defaultSort: {active:'id', direction:'asc'}\n *      })\n *    )({\n *      actionsGroupKey: '[Todos]',\n *      featureSelector: createFeatureSelector<TestState>>(\n *        'todos',\n *      ),\n *    });\n * // will generate  the following actions and selectors, plus the ones generated by other traits\n * traits.actions.sortTodos({active:'id', direction:'desc'})\n * traits.actions.resetTodosSort()\n *\n * traits.selectors.selectTodosSort()\n */\nexport function addSortEntitiesTrait<Entity>({\n  remote = false,\n  defaultSort,\n}: SortEntitiesConfig<Entity>) {\n  return createTraitFactory({\n    key: sortTraitKey,\n    depends: [loadEntitiesTraitKey],\n    config: { remote, defaultSort } as SortEntitiesConfig<Entity>,\n    actions: ({ actionsGroupKey, entitiesName }: TraitActionsFactoryConfig) =>\n      createSortTraitActions<Entity>(actionsGroupKey, entitiesName),\n    selectors: () => createSortTraitSelectors<Entity>(),\n    mutators: ({ allSelectors, allConfigs }: TraitStateMutatorsFactoryConfig) =>\n      createSortTraitMutators<Entity>(\n        allSelectors as SortEntitiesSelectors<Entity> &\n          LoadEntitiesSelectors<Entity>,\n        allConfigs\n      ),\n    initialState: ({\n      previousInitialState,\n      allConfigs,\n    }: TraitInitialStateFactoryConfig) =>\n      createSortInitialState<Entity>(previousInitialState, allConfigs),\n    reducer: ({ initialState, allActions, allMutators, allConfigs }) =>\n      createSortTraitReducer<Entity>(\n        initialState,\n        allActions as SortEntitiesActions<Entity> & LoadEntitiesActions<Entity>,\n        allMutators,\n        allConfigs as LoadEntitiesKeyedConfig<Entity> &\n          EntitiesPaginationKeyedConfig &\n          SortEntitiesKeyedConfig<Entity>\n      ),\n    effects: ({ allActions, allConfigs }) =>\n      createSortTraitEffect(\n        allActions as LoadEntitiesActions<Entity> &\n          SortEntitiesActions<Entity> &\n          EntitiesPaginationActions,\n        allConfigs as LoadEntitiesKeyedConfig<Entity> &\n          SortEntitiesKeyedConfig<Entity>\n      ),\n  });\n}\n"]}

package/esm2015/sort-entities/sort-entities.trait.mutators.js

@@ -0,0 +1,13 @@
+import { sortData } from './sort-entities.utils';
+export function createSortTraitMutators({ selectEntitiesList }, allConfigs) {
+    function sortEntities({ active, direction }, state) {
+        const { adapter } = allConfigs.loadEntities;
+        const entities = selectEntitiesList(state);
+        const sortedIds = sortData(entities, { active, direction }).map((v) => adapter.selectId(v));
+        return Object.assign(Object.assign({}, state), { ids: sortedIds, sort: Object.assign(Object.assign({}, state.sort), { current: { active, direction } }) });
+    }
+    return {
+        sortEntities,
+    };
+}
+//# sourceMappingURL=sort-entities.trait.mutators.js.map

package/esm2015/sort-entities/sort-entities.trait.mutators.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sort-entities.trait.mutators.js","sourceRoot":"","sources":["../../../../../../libs/ngrx-traits/common/src/lib/sort-entities/sort-entities.trait.mutators.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAEjD,MAAM,UAAU,uBAAuB,CACrC,EAAE,kBAAkB,EAAiC,EACrD,UAA2C;IAE3C,SAAS,YAAY,CAEnB,EAAE,MAAM,EAAE,SAAS,EAAgB,EAAE,KAAQ;QAC7C,MAAM,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,YAAa,CAAC;QAC7C,MAAM,QAAQ,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAC3C,MAAM,SAAS,GAAG,QAAQ,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CACpE,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CACpB,CAAC;QACF,uCACK,KAAK,KACR,GAAG,EAAE,SAAS,EACd,IAAI,kCAAO,KAAK,CAAC,IAAI,KAAE,OAAO,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,OACrD;IACJ,CAAC;IACD,OAAO;QACL,YAAY;KACb,CAAC;AACJ,CAAC","sourcesContent":["import {\n  LoadEntitiesKeyedConfig,\n  LoadEntitiesSelectors,\n  LoadEntitiesState,\n} from '../load-entities/load-entities.model';\nimport {\n  Sort,\n  SortEntitiesMutators,\n  SortEntitiesState,\n} from './sort-entities.model';\nimport { sortData } from './sort-entities.utils';\n\nexport function createSortTraitMutators<Entity>(\n  { selectEntitiesList }: LoadEntitiesSelectors<Entity>,\n  allConfigs: LoadEntitiesKeyedConfig<Entity>\n): SortEntitiesMutators<Entity> {\n  function sortEntities<\n    S extends LoadEntitiesState<Entity> & SortEntitiesState<Entity>\n  >({ active, direction }: Sort<Entity>, state: S) {\n    const { adapter } = allConfigs.loadEntities!;\n    const entities = selectEntitiesList(state);\n    const sortedIds = sortData(entities, { active, direction }).map((v) =>\n      adapter.selectId(v)\n    );\n    return {\n      ...state,\n      ids: sortedIds,\n      sort: { ...state.sort, current: { active, direction } },\n    };\n  }\n  return {\n    sortEntities,\n  };\n}\n"]}

package/esm2015/sort-entities/sort-entities.trait.reducer.js

@@ -0,0 +1,22 @@
+import { createReducer, on } from '@ngrx/store';
+export function createSortInitialState(previousInitialState, allConfigs) {
+    const { defaultSort } = allConfigs.sort;
+    return Object.assign(Object.assign({}, previousInitialState), { sort: {
+            current: defaultSort,
+            default: defaultSort,
+        } });
+}
+export function createSortTraitReducer(initialState, allActions, allMutators, allConfigs) {
+    const { remote } = allConfigs.sort;
+    return createReducer(initialState, on(allActions.sortEntities, (state, { active, direction }) => !remote
+        ? allMutators.sortEntities({ active, direction }, state)
+        : Object.assign(Object.assign({}, state), { sort: Object.assign(Object.assign({}, state.sort), { current: { active, direction } }) })), on(allActions.resetEntitiesSort, (state) => {
+        var _a, _b, _c;
+        return ((_a = state.sort) === null || _a === void 0 ? void 0 : _a.default)
+            ? !remote
+                ? allMutators.sortEntities((_b = state.sort) === null || _b === void 0 ? void 0 : _b.default, state)
+                : Object.assign(Object.assign({}, state), { sort: Object.assign(Object.assign({}, state.sort), { current: (_c = state.sort) === null || _c === void 0 ? void 0 : _c.default }) })
+            : state;
+    }));
+}
+//# sourceMappingURL=sort-entities.trait.reducer.js.map

package/esm2015/sort-entities/sort-entities.trait.reducer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sort-entities.trait.reducer.js","sourceRoot":"","sources":["../../../../../../libs/ngrx-traits/common/src/lib/sort-entities/sort-entities.trait.reducer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,EAAE,EAAE,MAAM,aAAa,CAAC;AAahD,MAAM,UAAU,sBAAsB,CACpC,oBAAyB,EACzB,UAA2C;IAE3C,MAAM,EAAE,WAAW,EAAE,GAAG,UAAU,CAAC,IAAK,CAAC;IAEzC,uCACK,oBAAoB,KACvB,IAAI,EAAE;YACJ,OAAO,EAAE,WAAW;YACpB,OAAO,EAAE,WAAW;SACrB,IACD;AACJ,CAAC;AAED,MAAM,UAAU,sBAAsB,CAMpC,YAAe,EACf,UAAqE,EACrE,WAAyC,EACzC,UAA6E;IAE7E,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,IAAK,CAAC;IAEpC,OAAO,aAAa,CAClB,YAAY,EACZ,EAAE,CAAC,UAAU,CAAC,YAAY,EAAE,CAAC,KAAK,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,EAAE,CAC3D,CAAC,MAAM;QACL,CAAC,CAAC,WAAW,CAAC,YAAY,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,KAAK,CAAC;QACxD,CAAC,iCACM,KAAK,KACR,IAAI,kCAAO,KAAK,CAAC,IAAI,KAAE,OAAO,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,MACtD,CACN,EACD,EAAE,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAC,KAAK,EAAE,EAAE;;QACzC,OAAA,CAAA,MAAA,KAAK,CAAC,IAAI,0CAAE,OAAO;YACjB,CAAC,CAAC,CAAC,MAAM;gBACP,CAAC,CAAC,WAAW,CAAC,YAAY,CAAC,MAAA,KAAK,CAAC,IAAI,0CAAE,OAAO,EAAE,KAAK,CAAC;gBACtD,CAAC,iCACM,KAAK,KACR,IAAI,kCAAO,KAAK,CAAC,IAAI,KAAE,OAAO,EAAE,MAAA,KAAK,CAAC,IAAI,0CAAE,OAAO,MACpD;YACL,CAAC,CAAC,KAAK,CAAA;KAAA,CACV,CACF,CAAC;AACJ,CAAC","sourcesContent":["import { createReducer, on } from '@ngrx/store';\nimport {\n  LoadEntitiesActions,\n  LoadEntitiesKeyedConfig,\n  LoadEntitiesState,\n} from '../load-entities';\nimport {\n  SortEntitiesActions,\n  SortEntitiesKeyedConfig,\n  SortEntitiesMutators,\n  SortEntitiesState,\n} from './sort-entities.model';\n\nexport function createSortInitialState<Entity>(\n  previousInitialState: any,\n  allConfigs: SortEntitiesKeyedConfig<Entity>\n): LoadEntitiesState<Entity> & SortEntitiesState<Entity> {\n  const { defaultSort } = allConfigs.sort!;\n\n  return {\n    ...previousInitialState,\n    sort: {\n      current: defaultSort,\n      default: defaultSort,\n    },\n  };\n}\n\nexport function createSortTraitReducer<\n  Entity,\n  S extends LoadEntitiesState<Entity> &\n    SortEntitiesState<Entity> = LoadEntitiesState<Entity> &\n    SortEntitiesState<Entity>\n>(\n  initialState: S,\n  allActions: SortEntitiesActions<Entity> & LoadEntitiesActions<Entity>,\n  allMutators: SortEntitiesMutators<Entity>,\n  allConfigs: LoadEntitiesKeyedConfig<Entity> & SortEntitiesKeyedConfig<Entity>\n) {\n  const { remote } = allConfigs.sort!;\n\n  return createReducer(\n    initialState,\n    on(allActions.sortEntities, (state, { active, direction }) =>\n      !remote\n        ? allMutators.sortEntities({ active, direction }, state)\n        : {\n            ...state,\n            sort: { ...state.sort, current: { active, direction } },\n          }\n    ),\n    on(allActions.resetEntitiesSort, (state) =>\n      state.sort?.default\n        ? !remote\n          ? allMutators.sortEntities(state.sort?.default, state)\n          : {\n              ...state,\n              sort: { ...state.sort, current: state.sort?.default },\n            }\n        : state\n    )\n  );\n}\n"]}

package/esm2015/sort-entities/sort-entities.trait.selectors.js

@@ -0,0 +1,10 @@
+export function createSortTraitSelectors() {
+    function selectEntitiesSort(state) {
+        var _a;
+        return (_a = state.sort) === null || _a === void 0 ? void 0 : _a.current;
+    }
+    return {
+        selectEntitiesSort,
+    };
+}
+//# sourceMappingURL=sort-entities.trait.selectors.js.map

package/esm2015/sort-entities/sort-entities.trait.selectors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sort-entities.trait.selectors.js","sourceRoot":"","sources":["../../../../../../libs/ngrx-traits/common/src/lib/sort-entities/sort-entities.trait.selectors.ts"],"names":[],"mappings":"AAKA,MAAM,UAAU,wBAAwB;IAGtC,SAAS,kBAAkB,CAAC,KAAgC;;QAC1D,OAAO,MAAA,KAAK,CAAC,IAAI,0CAAE,OAAO,CAAC;IAC7B,CAAC;IACD,OAAO;QACL,kBAAkB;KACnB,CAAC;AACJ,CAAC","sourcesContent":["import {\n  SortEntitiesSelectors,\n  SortEntitiesState,\n} from './sort-entities.model';\n\nexport function createSortTraitSelectors<\n  Entity\n>(): SortEntitiesSelectors<Entity> {\n  function selectEntitiesSort(state: SortEntitiesState<Entity>) {\n    return state.sort?.current;\n  }\n  return {\n    selectEntitiesSort,\n  };\n}\n"]}

package/esm2015/sort-entities/sort-entities.utils.js

@@ -0,0 +1,61 @@
+const MAX_SAFE_INTEGER = 9007199254740991;
+export function _isNumberValue(value) {
+    // parseFloat(value) handles most of the cases we're interested in (it treats null, empty string,
+    // and other non-number values as NaN, where Number just uses 0) but it considers the string
+    // '123hello' to be a valid number. Therefore we also check if Number(value) is NaN.
+    return !isNaN(parseFloat(value)) && !isNaN(Number(value));
+}
+function sortingDataAccessor(data, sortHeaderId) {
+    const value = data[sortHeaderId];
+    if (_isNumberValue(value)) {
+        const numberValue = Number(value);
+        // Numbers beyond `MAX_SAFE_INTEGER` can't be compared reliably so we
+        // leave them as strings. For more info: https://goo.gl/y5vbSg
+        return numberValue < MAX_SAFE_INTEGER ? numberValue : value;
+    }
+    return value;
+}
+/**
+ * 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 function sortData(data, sort) {
+    const active = sort.active;
+    const direction = sort.direction;
+    if (!active || direction === '') {
+        return data;
+    }
+    return data.sort((a, b) => {
+        const valueA = sortingDataAccessor(a, active);
+        const valueB = sortingDataAccessor(b, active);
+        // If both valueA and valueB exist (truthy), then compare the two. Otherwise, check if
+        // one value exists while the other doesn't. In this case, existing value should come last.
+        // This avoids inconsistent results when comparing values to undefined/null.
+        // If neither value exists, return 0 (equal).
+        let comparatorResult = 0;
+        if (valueA != null && valueB != null) {
+            // Check if one value is greater than the other; if equal, comparatorResult should remain 0.
+            if (typeof valueA === 'string' || typeof valueB === 'string') {
+                // if either values are a string, then force both to be strings before localCompare
+                comparatorResult = valueA.toString().localeCompare(valueB.toString());
+            }
+            else {
+                if (valueA > valueB) {
+                    comparatorResult = 1;
+                }
+                else if (valueA < valueB) {
+                    comparatorResult = -1;
+                }
+            }
+        }
+        else if (valueA != null) {
+            comparatorResult = 1;
+        }
+        else if (valueB != null) {
+            comparatorResult = -1;
+        }
+        return comparatorResult * (direction === 'asc' ? 1 : -1);
+    });
+}
+//# sourceMappingURL=sort-entities.utils.js.map

package/esm2015/sort-entities/sort-entities.utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sort-entities.utils.js","sourceRoot":"","sources":["../../../../../../libs/ngrx-traits/common/src/lib/sort-entities/sort-entities.utils.ts"],"names":[],"mappings":"AAEA,MAAM,gBAAgB,GAAG,gBAAgB,CAAC;AAE1C,MAAM,UAAU,cAAc,CAAC,KAAU;IACvC,iGAAiG;IACjG,4FAA4F;IAC5F,oFAAoF;IACpF,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,KAAY,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;AACnE,CAAC;AAED,SAAS,mBAAmB,CAC1B,IAAO,EACP,YAAoB;IAEpB,MAAM,KAAK,GAAI,IAA+B,CAAC,YAAY,CAAC,CAAC;IAE7D,IAAI,cAAc,CAAC,KAAK,CAAC,EAAE;QACzB,MAAM,WAAW,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;QAElC,qEAAqE;QACrE,8DAA8D;QAC9D,OAAO,WAAW,GAAG,gBAAgB,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC;KAC7D;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,QAAQ,CAAI,IAAS,EAAE,IAAa;IAClD,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;IAC3B,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;IACjC,IAAI,CAAC,MAAM,IAAI,SAAS,KAAK,EAAE,EAAE;QAC/B,OAAO,IAAI,CAAC;KACb;IAED,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QACxB,MAAM,MAAM,GAAG,mBAAmB,CAAC,CAAC,EAAE,MAAgB,CAAC,CAAC;QACxD,MAAM,MAAM,GAAG,mBAAmB,CAAC,CAAC,EAAE,MAAgB,CAAC,CAAC;QAExD,sFAAsF;QACtF,2FAA2F;QAC3F,4EAA4E;QAC5E,6CAA6C;QAC7C,IAAI,gBAAgB,GAAG,CAAC,CAAC;QACzB,IAAI,MAAM,IAAI,IAAI,IAAI,MAAM,IAAI,IAAI,EAAE;YACpC,4FAA4F;YAE5F,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;gBAC5D,mFAAmF;gBACnF,gBAAgB,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC,aAAa,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;aACvE;iBAAM;gBACL,IAAI,MAAM,GAAG,MAAM,EAAE;oBACnB,gBAAgB,GAAG,CAAC,CAAC;iBACtB;qBAAM,IAAI,MAAM,GAAG,MAAM,EAAE;oBAC1B,gBAAgB,GAAG,CAAC,CAAC,CAAC;iBACvB;aACF;SACF;aAAM,IAAI,MAAM,IAAI,IAAI,EAAE;YACzB,gBAAgB,GAAG,CAAC,CAAC;SACtB;aAAM,IAAI,MAAM,IAAI,IAAI,EAAE;YACzB,gBAAgB,GAAG,CAAC,CAAC,CAAC;SACvB;QAED,OAAO,gBAAgB,GAAG,CAAC,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import { Sort } from './sort-entities.model';\n\nconst MAX_SAFE_INTEGER = 9007199254740991;\n\nexport function _isNumberValue(value: any): boolean {\n  // parseFloat(value) handles most of the cases we're interested in (it treats null, empty string,\n  // and other non-number values as NaN, where Number just uses 0) but it considers the string\n  // '123hello' to be a valid number. Therefore we also check if Number(value) is NaN.\n  return !isNaN(parseFloat(value as any)) && !isNaN(Number(value));\n}\n\nfunction sortingDataAccessor<T>(\n  data: T,\n  sortHeaderId: string\n): string | number {\n  const value = (data as { [key: string]: any })[sortHeaderId];\n\n  if (_isNumberValue(value)) {\n    const numberValue = Number(value);\n\n    // Numbers beyond `MAX_SAFE_INTEGER` can't be compared reliably so we\n    // leave them as strings. For more info: https://goo.gl/y5vbSg\n    return numberValue < MAX_SAFE_INTEGER ? numberValue : value;\n  }\n\n  return value;\n}\n\n/**\n * Gets a sorted copy of the data array based on the state of the Sort.\n * @param data The array of data that should be sorted.\n * @param sort The connected MatSort that holds the current sort state.\n */\nexport function sortData<T>(data: T[], sort: Sort<T>): T[] {\n  const active = sort.active;\n  const direction = sort.direction;\n  if (!active || direction === '') {\n    return data;\n  }\n\n  return data.sort((a, b) => {\n    const valueA = sortingDataAccessor(a, active as string);\n    const valueB = sortingDataAccessor(b, active as string);\n\n    // If both valueA and valueB exist (truthy), then compare the two. Otherwise, check if\n    // one value exists while the other doesn't. In this case, existing value should come last.\n    // This avoids inconsistent results when comparing values to undefined/null.\n    // If neither value exists, return 0 (equal).\n    let comparatorResult = 0;\n    if (valueA != null && valueB != null) {\n      // Check if one value is greater than the other; if equal, comparatorResult should remain 0.\n\n      if (typeof valueA === 'string' || typeof valueB === 'string') {\n        // if either values are a string, then force both to be strings before localCompare\n        comparatorResult = valueA.toString().localeCompare(valueB.toString());\n      } else {\n        if (valueA > valueB) {\n          comparatorResult = 1;\n        } else if (valueA < valueB) {\n          comparatorResult = -1;\n        }\n      }\n    } else if (valueA != null) {\n      comparatorResult = 1;\n    } else if (valueB != null) {\n      comparatorResult = -1;\n    }\n\n    return comparatorResult * (direction === 'asc' ? 1 : -1);\n  });\n}\n"]}