@daffodil/search 0.0.0-PLACEHOLDER

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (146) hide show
  1. package/.eslintrc.js +52 -0
  2. package/README.md +11 -0
  3. package/driver/federated/README.md +3 -0
  4. package/driver/federated/ng-package.json +8 -0
  5. package/driver/federated/package.json +3 -0
  6. package/driver/federated/src/config/default.ts +6 -0
  7. package/driver/federated/src/config/interface.ts +21 -0
  8. package/driver/federated/src/config/public_api.ts +5 -0
  9. package/driver/federated/src/index.ts +1 -0
  10. package/driver/federated/src/injection-tokens/drivers.token.spec.ts +64 -0
  11. package/driver/federated/src/injection-tokens/drivers.token.ts +37 -0
  12. package/driver/federated/src/public_api.ts +4 -0
  13. package/driver/federated/src/search-driver.module.ts +62 -0
  14. package/driver/federated/src/search.service.spec.ts +86 -0
  15. package/driver/federated/src/search.service.ts +49 -0
  16. package/driver/in-memory/ng-package.json +8 -0
  17. package/driver/in-memory/package.json +3 -0
  18. package/driver/in-memory/src/backend/search.service.spec.ts +111 -0
  19. package/driver/in-memory/src/backend/search.service.ts +83 -0
  20. package/driver/in-memory/src/driver/search-driver.module.ts +33 -0
  21. package/driver/in-memory/src/driver/search.service.spec.ts +75 -0
  22. package/driver/in-memory/src/driver/search.service.ts +33 -0
  23. package/driver/in-memory/src/index.ts +1 -0
  24. package/driver/in-memory/src/injection-tokens/backends.token.spec.ts +69 -0
  25. package/driver/in-memory/src/injection-tokens/backends.token.ts +36 -0
  26. package/driver/in-memory/src/interfaces/get-backend.interface.ts +17 -0
  27. package/driver/in-memory/src/interfaces/public_api.ts +1 -0
  28. package/driver/in-memory/src/public_api.ts +7 -0
  29. package/driver/ng-package.json +8 -0
  30. package/driver/package.json +3 -0
  31. package/driver/src/errors/invalid-api-response.ts +17 -0
  32. package/driver/src/errors/map.ts +16 -0
  33. package/driver/src/errors/public_api.ts +9 -0
  34. package/driver/src/errors/query-too-short.ts +17 -0
  35. package/driver/src/index.ts +1 -0
  36. package/driver/src/interfaces/response.interface.ts +18 -0
  37. package/driver/src/interfaces/search-service-kinded.interface.ts +17 -0
  38. package/driver/src/interfaces/search-service.interface.ts +42 -0
  39. package/driver/src/public_api.ts +9 -0
  40. package/driver/testing/ng-package.json +8 -0
  41. package/driver/testing/package.json +3 -0
  42. package/driver/testing/src/drivers/public_api.ts +2 -0
  43. package/driver/testing/src/drivers/search-driver.module.ts +31 -0
  44. package/driver/testing/src/drivers/search.service.spec.ts +29 -0
  45. package/driver/testing/src/drivers/search.service.ts +37 -0
  46. package/driver/testing/src/index.ts +1 -0
  47. package/driver/testing/src/public_api.ts +1 -0
  48. package/karma.conf.js +11 -0
  49. package/ng-package.json +7 -0
  50. package/ng-package.prod.json +7 -0
  51. package/package.json +40 -0
  52. package/routing/ng-package.json +8 -0
  53. package/routing/package.json +3 -0
  54. package/routing/src/index.ts +1 -0
  55. package/routing/src/injection-tokens/public_api.ts +6 -0
  56. package/routing/src/injection-tokens/search-options/builder.token.ts +10 -0
  57. package/routing/src/injection-tokens/search-options/builders.token.spec.ts +35 -0
  58. package/routing/src/injection-tokens/search-options/builders.token.ts +42 -0
  59. package/routing/src/module.ts +26 -0
  60. package/routing/src/public_api.ts +3 -0
  61. package/routing/src/resolvers/public_api.ts +1 -0
  62. package/routing/src/resolvers/search/search.resolver.spec.ts +166 -0
  63. package/routing/src/resolvers/search/search.resolver.ts +65 -0
  64. package/src/index.ts +1 -0
  65. package/src/injection-tokens/error-matcher.token.ts +12 -0
  66. package/src/injection-tokens/public_api.ts +1 -0
  67. package/src/models/public_api.ts +2 -0
  68. package/src/models/search-result-collection.type.ts +6 -0
  69. package/src/models/search-result.type.ts +10 -0
  70. package/src/public_api.ts +3 -0
  71. package/src/transforms/public_api.ts +1 -0
  72. package/src/transforms/results-to-collection.spec.ts +28 -0
  73. package/src/transforms/results-to-collection.ts +14 -0
  74. package/state/ng-package.json +8 -0
  75. package/state/package.json +3 -0
  76. package/state/src/actions/search.actions.ts +93 -0
  77. package/state/src/config/default.ts +10 -0
  78. package/state/src/config/interface.ts +20 -0
  79. package/state/src/config/public_api.ts +3 -0
  80. package/state/src/config/token.ts +11 -0
  81. package/state/src/effects/incremental.effects.spec.ts +205 -0
  82. package/state/src/effects/incremental.effects.ts +74 -0
  83. package/state/src/effects/page.effects.spec.ts +179 -0
  84. package/state/src/effects/page.effects.ts +57 -0
  85. package/state/src/facades/public_api.ts +4 -0
  86. package/state/src/facades/search/base.facade.spec.ts +148 -0
  87. package/state/src/facades/search/base.facade.ts +53 -0
  88. package/state/src/facades/search/incremental.facade.ts +25 -0
  89. package/state/src/facades/search/page.facade.ts +25 -0
  90. package/state/src/facades/search/search-facade.interface.ts +38 -0
  91. package/state/src/incremental.module.ts +35 -0
  92. package/state/src/index.ts +1 -0
  93. package/state/src/page.module.ts +15 -0
  94. package/state/src/public_api.ts +9 -0
  95. package/state/src/reducers/incremental/public_api.ts +1 -0
  96. package/state/src/reducers/incremental/reducer.spec.ts +142 -0
  97. package/state/src/reducers/incremental/reducer.ts +34 -0
  98. package/state/src/reducers/page/public_api.ts +1 -0
  99. package/state/src/reducers/page/reducer.spec.ts +142 -0
  100. package/state/src/reducers/page/reducer.ts +34 -0
  101. package/state/src/reducers/public_api.ts +11 -0
  102. package/state/src/reducers/reducers.interface.ts +19 -0
  103. package/state/src/reducers/reducers.spec.ts +16 -0
  104. package/state/src/reducers/reducers.ts +13 -0
  105. package/state/src/reducers/search/adapter.spec.ts +130 -0
  106. package/state/src/reducers/search/adapter.ts +71 -0
  107. package/state/src/reducers/search/initial-state.ts +11 -0
  108. package/state/src/reducers/search/interface.ts +26 -0
  109. package/state/src/reducers/search/public_api.ts +3 -0
  110. package/state/src/reducers/store-feature-key.ts +4 -0
  111. package/state/src/reducers/token/extra.token.spec.ts +35 -0
  112. package/state/src/reducers/token/extra.token.ts +44 -0
  113. package/state/src/reducers/token/public_api.ts +4 -0
  114. package/state/src/reducers/token/reducers.token.spec.ts +51 -0
  115. package/state/src/reducers/token/reducers.token.ts +33 -0
  116. package/state/src/search.module.ts +15 -0
  117. package/state/src/selectors/incremental/selectors.ts +21 -0
  118. package/state/src/selectors/page/selectors.ts +21 -0
  119. package/state/src/selectors/public_api.ts +4 -0
  120. package/state/src/selectors/search-feature.selector.ts +27 -0
  121. package/state/src/selectors/search.selector.spec.ts +137 -0
  122. package/state/src/selectors/search.selector.ts +78 -0
  123. package/state/testing/ng-package.json +8 -0
  124. package/state/testing/package.json +3 -0
  125. package/state/testing/src/index.ts +1 -0
  126. package/state/testing/src/mock-search-facade.ts +24 -0
  127. package/state/testing/src/public_api.ts +2 -0
  128. package/state/testing/src/search-testing.module.ts +19 -0
  129. package/test.ts +23 -0
  130. package/testing/ng-package.json +8 -0
  131. package/testing/package.json +3 -0
  132. package/testing/src/factories/kind.factory.spec.ts +57 -0
  133. package/testing/src/factories/kind.factory.ts +37 -0
  134. package/testing/src/factories/public_api.ts +2 -0
  135. package/testing/src/factories/search-result.factory.spec.ts +39 -0
  136. package/testing/src/factories/search-result.factory.ts +26 -0
  137. package/testing/src/index.ts +1 -0
  138. package/testing/src/injection-tokens/factories/kind.token.spec.ts +51 -0
  139. package/testing/src/injection-tokens/factories/kind.token.ts +43 -0
  140. package/testing/src/injection-tokens/public_api.ts +4 -0
  141. package/testing/src/public_api.ts +4 -0
  142. package/testing/src/testing.module.ts +18 -0
  143. package/tsconfig.json +38 -0
  144. package/tsconfig.lib.json +28 -0
  145. package/tsconfig.lib.prod.json +9 -0
  146. package/tsconfig.spec.json +17 -0
@@ -0,0 +1,130 @@
1
+ import { DaffStateError } from '@daffodil/core/state';
2
+ import {
3
+ DaffSearchResult,
4
+ daffSearchTransformResultsToCollection,
5
+ } from '@daffodil/search';
6
+ import {
7
+ daffSearchInitialState as initialState,
8
+ DaffSearchReducerState,
9
+ } from '@daffodil/search/state';
10
+ import { DaffSearchResultFactory } from '@daffodil/search/testing';
11
+
12
+ import { DaffSearchStateReducerAdapter } from './adapter';
13
+
14
+ describe('@daffodil/search/state | DaffSearchStateReducerAdapter', () => {
15
+ let searchResultFactory: DaffSearchResultFactory;
16
+ let adapter: DaffSearchStateReducerAdapter;
17
+
18
+ beforeEach(() => {
19
+ searchResultFactory = new DaffSearchResultFactory();
20
+ });
21
+
22
+ describe('search', () => {
23
+ let result: DaffSearchReducerState;
24
+ let query: string;
25
+
26
+ beforeEach(() => {
27
+ adapter = new DaffSearchStateReducerAdapter({
28
+ ...initialState,
29
+ recent: [
30
+ 'some other recent search query',
31
+ ],
32
+ });
33
+ query = 'query';
34
+
35
+ result = adapter.search(query);
36
+ });
37
+
38
+ it('should add the query to the list of recent searches', () => {
39
+ expect(result.recent).toContain(query);
40
+ });
41
+
42
+ it('sets loading state to true', () => {
43
+ expect(result.loading).toEqual(true);
44
+ });
45
+
46
+ it('should reset the results', () => {
47
+ expect(result.results).toEqual({});
48
+ });
49
+ });
50
+
51
+ describe('storeResults', () => {
52
+ let mockError: DaffStateError;
53
+ let mockSearchResult: DaffSearchResult;
54
+ let result: DaffSearchReducerState;
55
+ let state: DaffSearchReducerState;
56
+
57
+ beforeEach(() => {
58
+ mockError = {
59
+ code: 'error code',
60
+ message: 'error message',
61
+ };
62
+ state = {
63
+ ...initialState,
64
+ loading: true,
65
+ errors: [mockError],
66
+ results: {
67
+ resultKind: ['testId1'],
68
+ },
69
+ };
70
+ adapter = new DaffSearchStateReducerAdapter(state);
71
+ mockSearchResult = searchResultFactory.create({
72
+ kind: 'resultKind',
73
+ });
74
+
75
+ result = adapter.storeResults(daffSearchTransformResultsToCollection([mockSearchResult]));
76
+ });
77
+
78
+ it('sets loading to false', () => {
79
+ expect(result.loading).toEqual(false);
80
+ });
81
+
82
+ it('should reset errors', () => {
83
+ expect(result.errors).toEqual([]);
84
+ });
85
+
86
+ it('should set the search result IDs to the results dict', () => {
87
+ expect(result.results.resultKind).toEqual([mockSearchResult.id]);
88
+ });
89
+ });
90
+
91
+ describe('storeError', () => {
92
+ let result;
93
+ let state: DaffSearchReducerState;
94
+ let mockError: DaffStateError;
95
+
96
+ beforeEach(() => {
97
+ mockError = {
98
+ code: 'error code',
99
+ message: 'error message',
100
+ };
101
+ state = {
102
+ ...initialState,
103
+ loading: true,
104
+ errors: [
105
+ { code: 'firstErrorCode', message: 'firstErrorMessage' },
106
+ ],
107
+ results: {
108
+ type: ['result'],
109
+ },
110
+ };
111
+
112
+ adapter = new DaffSearchStateReducerAdapter(state);
113
+
114
+ result = adapter.storeError(mockError);
115
+ });
116
+
117
+ it('adds the error in action.payload to state.errors', () => {
118
+ expect(result.errors).toContain(mockError);
119
+ expect(result.errors.length).toEqual(2);
120
+ });
121
+
122
+ it('sets loading to false', () => {
123
+ expect(result.loading).toEqual(false);
124
+ });
125
+
126
+ it('clears search results', () => {
127
+ expect(result.results).toEqual({});
128
+ });
129
+ });
130
+ });
@@ -0,0 +1,71 @@
1
+ import { DaffStateError } from '@daffodil/core/state';
2
+ import {
3
+ DaffSearchResult,
4
+ DaffSearchResultCollection,
5
+ } from '@daffodil/search';
6
+
7
+ import { DaffSearchReducerState } from './interface';
8
+
9
+ /**
10
+ * Manages {@link DaffSearchReducerState}.
11
+ */
12
+ export class DaffSearchStateReducerAdapter<T extends DaffSearchResult = DaffSearchResult> {
13
+ constructor(
14
+ private state: DaffSearchReducerState<T>,
15
+ ) {}
16
+
17
+ /**
18
+ * Begins the search operation flow.
19
+ * Sets loading to true and stores the query in the list of recent searches.
20
+ * Resets the collection of results.
21
+ */
22
+ search(query: string): DaffSearchReducerState<T> {
23
+ // get unique values
24
+ const recent = [...new Set([
25
+ query,
26
+ ...this.state.recent,
27
+ ])];
28
+ return {
29
+ ...this.state,
30
+ loading: true,
31
+ recent,
32
+ results: <Record<T['kind'], T['id'][]>>{},
33
+ };
34
+ }
35
+
36
+ /**
37
+ * Stores the results of a completed search.
38
+ * Also sets loading to false and resets errors.
39
+ */
40
+ storeResults(collection: DaffSearchResultCollection<T>): DaffSearchReducerState<T> {
41
+ const results = Object.keys(collection).reduce((acc, k) => {
42
+ if (Object.prototype.hasOwnProperty.call(collection, k)) {
43
+ acc[k] = collection[k].map(({ id }) => id);
44
+ }
45
+ return acc;
46
+ }, <DaffSearchReducerState<T>['results']>{});
47
+
48
+ return {
49
+ ...this.state,
50
+ loading: false,
51
+ errors: [],
52
+ results,
53
+ };
54
+ }
55
+
56
+ /**
57
+ * Stores the from a failed search.
58
+ * Also sets loading to false.
59
+ */
60
+ storeError(error: DaffStateError): DaffSearchReducerState<T> {
61
+ return {
62
+ ...this.state,
63
+ errors: [
64
+ ...this.state.errors,
65
+ error,
66
+ ],
67
+ loading: false,
68
+ results: <DaffSearchReducerState<T>['results']>{},
69
+ };
70
+ }
71
+ }
@@ -0,0 +1,11 @@
1
+ import { DaffSearchReducerState } from './interface';
2
+
3
+ /**
4
+ * The initial state for the main search state, see {@link DaffSearchReducerState}.
5
+ */
6
+ export const daffSearchInitialState: DaffSearchReducerState = {
7
+ loading: false,
8
+ errors: [],
9
+ results: {},
10
+ recent: [],
11
+ };
@@ -0,0 +1,26 @@
1
+ import { DaffStateError } from '@daffodil/core/state';
2
+ import { DaffSearchResult } from '@daffodil/search';
3
+
4
+ /**
5
+ * The main search state.
6
+ * Contains info about the current or most recent search operation.
7
+ */
8
+ export interface DaffSearchReducerState<T extends DaffSearchResult = DaffSearchResult> {
9
+ /**
10
+ * Whether there is a pending search operation.
11
+ */
12
+ loading: boolean;
13
+ /**
14
+ * A list of search errors, if any.
15
+ */
16
+ errors: DaffStateError[];
17
+ /**
18
+ * The result IDs of the most recent search grouped by kind.
19
+ */
20
+ results: Record<T['kind'], T['id'][]>;
21
+ /**
22
+ * A list of the most recently used search queries.
23
+ * Does not include incremental searches.
24
+ */
25
+ recent: string[];
26
+ }
@@ -0,0 +1,3 @@
1
+ export { DaffSearchStateReducerAdapter } from './adapter';
2
+ export { DaffSearchReducerState } from './interface';
3
+ export { daffSearchInitialState } from './initial-state';
@@ -0,0 +1,4 @@
1
+ /**
2
+ * The key under which the search feature state will be stored.
3
+ */
4
+ export const DAFF_SEARCH_STORE_FEATURE_KEY = 'daffSearch';
@@ -0,0 +1,35 @@
1
+ import { TestBed } from '@angular/core/testing';
2
+ import { ActionReducer } from '@ngrx/store';
3
+
4
+ import { DaffSearchReducersState } from '@daffodil/search/state';
5
+
6
+ import {
7
+ daffSearchProvideExtraReducers,
8
+ DAFF_SEARCH_EXTRA_REDUCERS,
9
+ } from './extra.token';
10
+
11
+ describe('daffSearchProvideExtraReducers', () => {
12
+ let reducers: ActionReducer<DaffSearchReducersState>[];
13
+ let result: ActionReducer<DaffSearchReducersState>[];
14
+
15
+ beforeEach(() => {
16
+ reducers = [
17
+ (state, action) => state,
18
+ (state, action) => state,
19
+ ];
20
+
21
+ TestBed.configureTestingModule({
22
+ providers: [
23
+ ...daffSearchProvideExtraReducers(...reducers),
24
+ ],
25
+ });
26
+
27
+ result = TestBed.inject(DAFF_SEARCH_EXTRA_REDUCERS);
28
+ });
29
+
30
+ it('should provide the reducers to the token', () => {
31
+ reducers.forEach(reducer => {
32
+ expect(result).toContain(reducer);
33
+ });
34
+ });
35
+ });
@@ -0,0 +1,44 @@
1
+ import {
2
+ InjectionToken,
3
+ Provider,
4
+ } from '@angular/core';
5
+ import { ActionReducer } from '@ngrx/store';
6
+
7
+ import { DaffSearchResult } from '@daffodil/search';
8
+
9
+ import { DaffSearchReducersState } from '../reducers.interface';
10
+
11
+ /**
12
+ * A token to hold the injectable extra reducers.
13
+ *
14
+ * Prefer using {@link daffSearchProvideExtraReducers}.
15
+ */
16
+ export const DAFF_SEARCH_EXTRA_REDUCERS = new InjectionToken<ActionReducer<DaffSearchReducersState>[]>(
17
+ 'DAFF_SEARCH_EXTRA_REDUCERS',
18
+ {
19
+ factory: () => [],
20
+ providedIn: 'any',
21
+ },
22
+ );
23
+
24
+ /**
25
+ * Provides additional reducers that run after the standard Daffodil cart reducers.
26
+ *
27
+ * ```ts
28
+ * providers: [
29
+ * ...daffSearchProvideExtraReducers(
30
+ * myReducer1,
31
+ * myReducer2
32
+ * )
33
+ * ]
34
+ * ```
35
+ */
36
+ export function daffSearchProvideExtraReducers<T extends DaffSearchResult = DaffSearchResult>(
37
+ ...reducers: ActionReducer<DaffSearchReducersState<T>>[]
38
+ ): Provider[] {
39
+ return reducers.map(reducer => ({
40
+ provide: DAFF_SEARCH_EXTRA_REDUCERS,
41
+ useValue: reducer,
42
+ multi: true,
43
+ }));
44
+ }
@@ -0,0 +1,4 @@
1
+ export {
2
+ daffSearchProvideExtraReducers,
3
+ DAFF_SEARCH_EXTRA_REDUCERS,
4
+ } from './extra.token';
@@ -0,0 +1,51 @@
1
+ import { TestBed } from '@angular/core/testing';
2
+ import { ActionReducer } from '@ngrx/store';
3
+
4
+ import {
5
+ daffSearchProvideExtraReducers,
6
+ DaffSearchReducersState,
7
+ daffSearchInitialState,
8
+ DaffSearchLoad,
9
+ } from '@daffodil/search/state';
10
+
11
+ import { DAFF_SEARCH_REDUCERS } from './reducers.token';
12
+
13
+ describe('daffSearchProvideExtraReducers', () => {
14
+ let extraQuery: string;
15
+
16
+ let extraReducer: ActionReducer<DaffSearchReducersState>;
17
+ let reducer: ActionReducer<DaffSearchReducersState>;
18
+ let result: DaffSearchReducersState;
19
+
20
+ beforeEach(() => {
21
+ const initialState: DaffSearchReducersState = {
22
+ search: daffSearchInitialState,
23
+ incremental: daffSearchInitialState,
24
+ };
25
+ extraReducer = (state, action) => ({
26
+ ...state,
27
+ search: {
28
+ ...state.search,
29
+ recent: [
30
+ ...state.search.recent,
31
+ extraQuery,
32
+ ],
33
+ },
34
+ });
35
+
36
+ TestBed.configureTestingModule({
37
+ providers: [
38
+ ...daffSearchProvideExtraReducers(extraReducer),
39
+ ],
40
+ });
41
+
42
+ extraQuery = 'extra';
43
+ reducer = TestBed.inject(DAFF_SEARCH_REDUCERS);
44
+
45
+ result = reducer(initialState, new DaffSearchLoad('any'));
46
+ });
47
+
48
+ it('should run the extra reducer after the daffodil reducers', () => {
49
+ expect(result.search.recent[1]).toEqual(extraQuery);
50
+ });
51
+ });
@@ -0,0 +1,33 @@
1
+ import {
2
+ inject,
3
+ InjectionToken,
4
+ } from '@angular/core';
5
+ import {
6
+ ActionReducer,
7
+ combineReducers,
8
+ } from '@ngrx/store';
9
+
10
+ import { daffComposeReducers } from '@daffodil/core/state';
11
+ // these unused imports are a workaround
12
+ import { DaffSearchResult } from '@daffodil/search';
13
+
14
+ import { daffSearchReducers } from '../reducers';
15
+ import { DaffSearchReducersState } from '../reducers.interface';
16
+ import { DAFF_SEARCH_EXTRA_REDUCERS } from './extra.token';
17
+
18
+ /**
19
+ * An internal token to hold the Daffodil search reducers.
20
+ * Includes the extra and standard reducers.
21
+ *
22
+ * @docs-private
23
+ */
24
+ export const DAFF_SEARCH_REDUCERS = new InjectionToken<ActionReducer<DaffSearchReducersState>>(
25
+ 'DAFF_SEARCH_REDUCERS',
26
+ {
27
+ providedIn: 'any',
28
+ factory: () => daffComposeReducers([
29
+ combineReducers(daffSearchReducers),
30
+ ...inject(DAFF_SEARCH_EXTRA_REDUCERS),
31
+ ]),
32
+ },
33
+ );
@@ -0,0 +1,15 @@
1
+ import { NgModule } from '@angular/core';
2
+ import { StoreModule } from '@ngrx/store';
3
+
4
+ import { DAFF_SEARCH_STORE_FEATURE_KEY } from './reducers/public_api';
5
+ import { DAFF_SEARCH_REDUCERS } from './reducers/token/reducers.token';
6
+
7
+ /**
8
+ * Creates the search feature store.
9
+ */
10
+ @NgModule({
11
+ imports: [
12
+ StoreModule.forFeature(DAFF_SEARCH_STORE_FEATURE_KEY, DAFF_SEARCH_REDUCERS),
13
+ ],
14
+ })
15
+ export class DaffSearchStateModule {}
@@ -0,0 +1,21 @@
1
+ import { createSelector } from '@ngrx/store';
2
+
3
+ import { DaffSearchResult } from '@daffodil/search';
4
+
5
+ import { getDaffSearchReducersStateSelector } from '../search-feature.selector';
6
+ import {
7
+ daffSearchCreateSearchSelectors,
8
+ DaffSearchSelectors,
9
+ } from '../search.selector';
10
+
11
+ const { selectSearchFeatureState } = getDaffSearchReducersStateSelector();
12
+ const selectIncrementalState = createSelector(
13
+ selectSearchFeatureState,
14
+ state => state.incremental,
15
+ );
16
+
17
+ export const daffSearchGetIncrementalSelectors = (() => {
18
+ let cache;
19
+ return <T extends DaffSearchResult = DaffSearchResult>(): DaffSearchSelectors<T> =>
20
+ cache = cache || daffSearchCreateSearchSelectors<T>(selectIncrementalState);
21
+ })();
@@ -0,0 +1,21 @@
1
+ import { createSelector } from '@ngrx/store';
2
+
3
+ import { DaffSearchResult } from '@daffodil/search';
4
+
5
+ import { getDaffSearchReducersStateSelector } from '../search-feature.selector';
6
+ import {
7
+ daffSearchCreateSearchSelectors,
8
+ DaffSearchSelectors,
9
+ } from '../search.selector';
10
+
11
+ const { selectSearchFeatureState } = getDaffSearchReducersStateSelector();
12
+ const selectSearchState = createSelector(
13
+ selectSearchFeatureState,
14
+ state => state.search,
15
+ );
16
+
17
+ export const daffSearchGetPageSelectors = (() => {
18
+ let cache;
19
+ return <T extends DaffSearchResult = DaffSearchResult>(): DaffSearchSelectors<T> =>
20
+ cache = cache || daffSearchCreateSearchSelectors<T>(selectSearchState);
21
+ })();
@@ -0,0 +1,4 @@
1
+ export * from './search.selector';
2
+ export * from './page/selectors';
3
+ export * from './incremental/selectors';
4
+ export * from './search-feature.selector';
@@ -0,0 +1,27 @@
1
+ import {
2
+ createFeatureSelector,
3
+ MemoizedSelector,
4
+ } from '@ngrx/store';
5
+
6
+ import { DaffSearchResult } from '@daffodil/search';
7
+
8
+ import {
9
+ DaffSearchStateRootSlice,
10
+ DaffSearchReducersState,
11
+ DAFF_SEARCH_STORE_FEATURE_KEY,
12
+ } from '../reducers/public_api';
13
+
14
+ /**
15
+ * Selector for the search feature state.
16
+ */
17
+ export interface DaffSearchFeatureSelector<T extends DaffSearchResult = DaffSearchResult> {
18
+ selectSearchFeatureState: MemoizedSelector<DaffSearchStateRootSlice<T>, DaffSearchReducersState<T>>;
19
+ }
20
+
21
+ export const getDaffSearchReducersStateSelector = (() => {
22
+ let cache;
23
+ return <T extends DaffSearchResult = DaffSearchResult>(): DaffSearchFeatureSelector<T> =>
24
+ cache = cache || {
25
+ selectSearchFeatureState: createFeatureSelector<DaffSearchReducersState<T>>(DAFF_SEARCH_STORE_FEATURE_KEY),
26
+ };
27
+ })();
@@ -0,0 +1,137 @@
1
+ import { TestBed } from '@angular/core/testing';
2
+ import {
3
+ Store,
4
+ StoreModule,
5
+ select,
6
+ combineReducers,
7
+ createSelector,
8
+ } from '@ngrx/store';
9
+ import { cold } from 'jasmine-marbles';
10
+
11
+ import {
12
+ DaffSearchResult,
13
+ daffSearchTransformResultsToCollection,
14
+ } from '@daffodil/search';
15
+ import {
16
+ DaffSearchLoad,
17
+ DaffSearchLoadSuccess,
18
+ daffSearchReducers,
19
+ DaffSearchStateRootSlice,
20
+ DAFF_SEARCH_STORE_FEATURE_KEY,
21
+ } from '@daffodil/search/state';
22
+ import { DaffSearchResultFactory } from '@daffodil/search/testing';
23
+
24
+ import { getDaffSearchReducersStateSelector } from './search-feature.selector';
25
+ import { daffSearchCreateSearchSelectors } from './search.selector';
26
+
27
+ const { selectSearchFeatureState } = getDaffSearchReducersStateSelector();
28
+ const selectSearchState = createSelector(
29
+ selectSearchFeatureState,
30
+ state => state.search,
31
+ );
32
+
33
+ describe('@daffodil/search/state | daffSearchCreateSearchSelectors', () => {
34
+ let store: Store<DaffSearchStateRootSlice>;
35
+
36
+ let searchResultFactory: DaffSearchResultFactory;
37
+
38
+ let loading: boolean;
39
+ let errors: string[];
40
+ let mockSearchResults: DaffSearchResult[];
41
+
42
+ const {
43
+ selectSearchLoading,
44
+ selectSearchErrors,
45
+ selectSearchResultIds,
46
+ selectRecent,
47
+ } = daffSearchCreateSearchSelectors(selectSearchState);
48
+
49
+ beforeEach(() => {
50
+ TestBed.configureTestingModule({
51
+ imports: [
52
+ StoreModule.forRoot({
53
+ [DAFF_SEARCH_STORE_FEATURE_KEY]: combineReducers(daffSearchReducers),
54
+ }),
55
+ ],
56
+ });
57
+
58
+ store = TestBed.inject(Store);
59
+ searchResultFactory = TestBed.inject(DaffSearchResultFactory);
60
+
61
+ mockSearchResults = searchResultFactory.createMany();
62
+ loading = false;
63
+ errors = [];
64
+ });
65
+
66
+ describe('selectSearchLoading', () => {
67
+ it('should select the loading property of the search state', () => {
68
+ const selector = store.pipe(select(selectSearchLoading));
69
+ const expected = cold('a', { a: loading });
70
+
71
+ expect(selector).toBeObservable(expected);
72
+ });
73
+ });
74
+
75
+ describe('selectSearchErrors', () => {
76
+ it('should select the error property of the search state', () => {
77
+ const selector = store.pipe(select(selectSearchErrors));
78
+ const expected = cold('a', { a: errors });
79
+
80
+ expect(selector).toBeObservable(expected);
81
+ });
82
+ });
83
+
84
+ describe('selectSearchResultIds', () => {
85
+ it('should initially be an empty dictionary', () => {
86
+ const selector = store.pipe(select(selectSearchResultIds));
87
+ const expected = cold('a', { a: {}});
88
+
89
+ expect(selector).toBeObservable(expected);
90
+ });
91
+
92
+ describe('when search results have been loaded', () => {
93
+ beforeEach(() => {
94
+ store.dispatch(new DaffSearchLoadSuccess({
95
+ collection: daffSearchTransformResultsToCollection(mockSearchResults),
96
+ metadata: {},
97
+ }));
98
+ });
99
+
100
+ it('should select the specified search result collection', () => {
101
+ const selector = store.pipe(select(selectSearchResultIds));
102
+ const expected = cold('a', { a: {
103
+ [mockSearchResults[0].kind]: [mockSearchResults[0].id],
104
+ }});
105
+
106
+ expect(selector).toBeObservable(expected);
107
+ });
108
+ });
109
+ });
110
+
111
+ describe('selectRecent', () => {
112
+ describe('when there have been no recent search queries', () => {
113
+ it('should be an empty array', () => {
114
+ const selector = store.pipe(select(selectRecent));
115
+ const expected = cold('a', { a: []});
116
+
117
+ expect(selector).toBeObservable(expected);
118
+ });
119
+ });
120
+
121
+ describe('when there have been recent search queries', () => {
122
+ let query: string;
123
+
124
+ beforeEach(() => {
125
+ query = 'query';
126
+ store.dispatch(new DaffSearchLoad(query));
127
+ });
128
+
129
+ it('should contain the recent search queries', () => {
130
+ const selector = store.pipe(select(selectRecent));
131
+ const expected = cold('a', { a: jasmine.arrayContaining([query]) });
132
+
133
+ expect(selector).toBeObservable(expected);
134
+ });
135
+ });
136
+ });
137
+ });