@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
package/.eslintrc.js ADDED
@@ -0,0 +1,52 @@
1
+ module.exports = {
2
+ extends: '../../.eslintrc.js',
3
+ ignorePatterns: [
4
+ '!**/*'
5
+ ],
6
+ overrides: [
7
+ {
8
+ files: [
9
+ '*.ts'
10
+ ],
11
+ parserOptions: {
12
+ project: [
13
+ 'libs/search/tsconfig.lib.json',
14
+ 'libs/search/tsconfig.spec.json'
15
+ ],
16
+ createDefaultProgram: true
17
+ },
18
+ rules: {
19
+ '@angular-eslint/component-class-suffix': [
20
+ 'error',
21
+ {
22
+ suffixes: [
23
+ 'Component'
24
+ ]
25
+ }
26
+ ],
27
+ '@angular-eslint/component-selector': [
28
+ 'error',
29
+ {
30
+ type: 'element',
31
+ prefix: 'lib',
32
+ style: 'kebab-case'
33
+ }
34
+ ],
35
+ '@angular-eslint/directive-selector': [
36
+ 'error',
37
+ {
38
+ type: 'attribute',
39
+ prefix: 'lib',
40
+ style: 'camelCase'
41
+ }
42
+ ],
43
+ }
44
+ },
45
+ {
46
+ files: [
47
+ '*.html'
48
+ ],
49
+ rules: {}
50
+ }
51
+ ]
52
+ }
package/README.md ADDED
@@ -0,0 +1,11 @@
1
+ # @daffodil/search
2
+
3
+ `@daffodil/search` contains the main features required to build search in an Angular app. `@daffodil/search` doesn't inherently support searching for any particular entities but instead provides base models and extension points that are utilized by other libraries.
4
+
5
+ See [`@daffodil/search-product`](../search-product/README.md) for an example of such a library.
6
+
7
+ ## Installation
8
+
9
+ ```
10
+ npm install @daffodil/search
11
+ ```
@@ -0,0 +1,3 @@
1
+ # @daffodil/search/driver/federated
2
+
3
+ A Daffodil search driver for delegating search responsibilities to child drivers. Child driver registration is done by providing to the `DAFF_SEARCH_FEDERATED_DRIVERS` injection token.
@@ -0,0 +1,8 @@
1
+ {
2
+ "$schema": "../../../../../node_modules/ng-packagr/ng-package.schema.json",
3
+ "dest": "../../dist/search/driver/federated",
4
+ "deleteDestPath": false,
5
+ "lib": {
6
+ "entryFile": "src/index.ts"
7
+ }
8
+ }
@@ -0,0 +1,3 @@
1
+ {
2
+ "name": "@daffodil/search/driver/federated"
3
+ }
@@ -0,0 +1,6 @@
1
+ import { DaffSearchFederatedDriverConfig } from './interface';
2
+
3
+ /**
4
+ * The default configuration for the {@link DaffSearchFederatedDriverConfig}.
5
+ */
6
+ export const SEARCH_FEDERATED_CONFIG_DEFAULT: DaffSearchFederatedDriverConfig = {};
@@ -0,0 +1,21 @@
1
+ import { InjectionToken } from '@angular/core';
2
+
3
+ import { SEARCH_FEDERATED_CONFIG_DEFAULT } from './default';
4
+
5
+ /**
6
+ * The token used to provide @daffodil/search/driver/federated config data.
7
+ * Mandatory for the Magento driver.
8
+ */
9
+ export const SEARCH_FEDERATED_CONFIG_TOKEN = new InjectionToken<DaffSearchFederatedDriverConfig>('SEARCH_FEDERATED_CONFIG_TOKEN', { factory: () => SEARCH_FEDERATED_CONFIG_DEFAULT });
10
+
11
+ /**
12
+ * An interface for providing @daffodil/search/driver/federated with necessary config values.
13
+ */
14
+ export interface DaffSearchFederatedDriverConfig {
15
+ /**
16
+ * The search driver kind that is the main kind of search result.
17
+ * Optional.
18
+ * If set, the search response metadata will be entirely from this kind.
19
+ */
20
+ preferredDriverKind?: string;
21
+ }
@@ -0,0 +1,5 @@
1
+ export { SEARCH_FEDERATED_CONFIG_DEFAULT } from './default';
2
+ export {
3
+ SEARCH_FEDERATED_CONFIG_TOKEN,
4
+ DaffSearchFederatedDriverConfig,
5
+ } from './interface';
@@ -0,0 +1 @@
1
+ export * from './public_api';
@@ -0,0 +1,64 @@
1
+ import {
2
+ Injectable,
3
+ Type,
4
+ } from '@angular/core';
5
+ import { TestBed } from '@angular/core/testing';
6
+ import { of } from 'rxjs';
7
+
8
+ import { DaffSearchDriverKindedInterface } from '@daffodil/search/driver';
9
+
10
+ import {
11
+ daffProvideSearchFederatedDrivers,
12
+ DAFF_SEARCH_FEDERATED_DRIVERS,
13
+ } from './drivers.token';
14
+
15
+ @Injectable({
16
+ providedIn: 'root',
17
+ })
18
+ class TestDriver1 implements DaffSearchDriverKindedInterface {
19
+ kind = 'TestDriver1';
20
+ search(query: string) {
21
+ return of({
22
+ collection: {},
23
+ metadata: {},
24
+ });
25
+ }
26
+ }
27
+
28
+ @Injectable({
29
+ providedIn: 'root',
30
+ })
31
+ class TestDriver2 implements DaffSearchDriverKindedInterface {
32
+ kind = 'TestDriver2';
33
+ search(query: string) {
34
+ return of({
35
+ collection: {},
36
+ metadata: {},
37
+ });
38
+ }
39
+ }
40
+
41
+ describe('@daffodil/search/driver/federated | daffProvideSearchFederatedDrivers', () => {
42
+ let drivers: Type<DaffSearchDriverKindedInterface>[];
43
+ let result: DaffSearchDriverKindedInterface[];
44
+
45
+ beforeEach(() => {
46
+ drivers = [
47
+ TestDriver1,
48
+ TestDriver2,
49
+ ];
50
+
51
+ TestBed.configureTestingModule({
52
+ providers: [
53
+ ...daffProvideSearchFederatedDrivers(...drivers),
54
+ ],
55
+ });
56
+
57
+ result = TestBed.inject(DAFF_SEARCH_FEDERATED_DRIVERS);
58
+ });
59
+
60
+ it('should provide driver instances to the token', () => {
61
+ expect(result).toContain(jasmine.any(TestDriver1));
62
+ expect(result).toContain(jasmine.any(TestDriver2));
63
+ });
64
+ });
@@ -0,0 +1,37 @@
1
+ import {
2
+ InjectionToken,
3
+ Provider,
4
+ Type,
5
+ } from '@angular/core';
6
+
7
+ import { DaffSearchResult } from '@daffodil/search';
8
+ import { DaffSearchDriverKindedInterface } from '@daffodil/search/driver';
9
+
10
+ /**
11
+ * A multi-provider injection token for providing feature-specific search platform drivers.
12
+ * This allows disparate modules to contribute to the business logic of performing searches while
13
+ * preventing tight coupling of said modules.
14
+ */
15
+ export const DAFF_SEARCH_FEDERATED_DRIVERS = new InjectionToken<DaffSearchDriverKindedInterface[]>(
16
+ 'DAFF_SEARCH_FEDERATED_DRIVERS',
17
+ { factory: () => []},
18
+ );
19
+
20
+ /**
21
+ * Provides feature drivers for the federated search driver.
22
+ *
23
+ * See {@link DAFF_SEARCH_FEDERATED_DRIVERS}.
24
+ *
25
+ * ```ts
26
+ * providers: [
27
+ * ...daffProvideSearchFederatedDrivers(MySearchDriver)
28
+ * ]
29
+ * ```
30
+ */
31
+ export function daffProvideSearchFederatedDrivers(...drivers: Type<DaffSearchDriverKindedInterface>[]): Provider[] {
32
+ return drivers.map(driver => ({
33
+ provide: DAFF_SEARCH_FEDERATED_DRIVERS,
34
+ useExisting: driver,
35
+ multi: true,
36
+ }));
37
+ }
@@ -0,0 +1,4 @@
1
+ export * from './injection-tokens/drivers.token';
2
+
3
+ export { DaffSearchFederatedDriver } from './search.service';
4
+ export { DaffSearchFederatedDriverModule } from './search-driver.module';
@@ -0,0 +1,62 @@
1
+ import { CommonModule } from '@angular/common';
2
+ import {
3
+ NgModule,
4
+ ModuleWithProviders,
5
+ } from '@angular/core';
6
+
7
+ import { DaffSearchDriver } from '@daffodil/search/driver';
8
+
9
+ import {
10
+ DaffSearchFederatedDriverConfig,
11
+ SEARCH_FEDERATED_CONFIG_DEFAULT,
12
+ SEARCH_FEDERATED_CONFIG_TOKEN,
13
+ } from './config/public_api';
14
+ import { DaffSearchFederatedDriver } from './search.service';
15
+
16
+ /**
17
+ * Provides the {@link DaffSearchFederatedDriver} as the {@link DaffSearchDriver}.
18
+ */
19
+ @NgModule({
20
+ imports: [
21
+ CommonModule,
22
+ ],
23
+ })
24
+ export class DaffSearchFederatedDriverModule {
25
+ static forRoot(config: DaffSearchFederatedDriverConfig = SEARCH_FEDERATED_CONFIG_DEFAULT): ModuleWithProviders<DaffSearchFederatedDriverModule> {
26
+ return {
27
+ ngModule: DaffSearchFederatedDriverModule,
28
+ providers: [
29
+ {
30
+ provide: DaffSearchDriver,
31
+ useExisting: DaffSearchFederatedDriver,
32
+ },
33
+ {
34
+ provide: SEARCH_FEDERATED_CONFIG_TOKEN,
35
+ useValue: {
36
+ ...SEARCH_FEDERATED_CONFIG_DEFAULT,
37
+ ...config,
38
+ },
39
+ },
40
+ ],
41
+ };
42
+ }
43
+
44
+ static forFeature(config: DaffSearchFederatedDriverConfig = SEARCH_FEDERATED_CONFIG_DEFAULT): ModuleWithProviders<DaffSearchFederatedDriverModule> {
45
+ return {
46
+ ngModule: DaffSearchFederatedDriverModule,
47
+ providers: [
48
+ {
49
+ provide: DaffSearchDriver,
50
+ useClass: DaffSearchFederatedDriver,
51
+ },
52
+ {
53
+ provide: SEARCH_FEDERATED_CONFIG_TOKEN,
54
+ useValue: {
55
+ ...SEARCH_FEDERATED_CONFIG_DEFAULT,
56
+ ...config,
57
+ },
58
+ },
59
+ ],
60
+ };
61
+ }
62
+ }
@@ -0,0 +1,86 @@
1
+ import { Injectable } from '@angular/core';
2
+ import { TestBed } from '@angular/core/testing';
3
+ import { cold } from 'jasmine-marbles';
4
+ import {
5
+ Observable,
6
+ of,
7
+ } from 'rxjs';
8
+
9
+ import { DaffSearchResultCollection } from '@daffodil/search';
10
+ import {
11
+ DaffSearchDriverKindedInterface,
12
+ DaffSearchDriverResponse,
13
+ } from '@daffodil/search/driver';
14
+ import { daffProvideSearchFederatedDrivers } from '@daffodil/search/driver/federated';
15
+
16
+ import { DaffSearchFederatedDriver } from './search.service';
17
+
18
+ @Injectable({
19
+ providedIn: 'root',
20
+ })
21
+ class TestDriver1 implements DaffSearchDriverKindedInterface {
22
+ kind = 'TestDriver1';
23
+
24
+ search(query: string) {
25
+ return of({
26
+ collection: {
27
+ testDriver1: [],
28
+ },
29
+ metadata: {},
30
+ });
31
+ }
32
+ }
33
+
34
+ @Injectable({
35
+ providedIn: 'root',
36
+ })
37
+ class TestDriver2 implements DaffSearchDriverKindedInterface {
38
+ kind = 'TestDriver2';
39
+
40
+ search(query: string) {
41
+ return of({
42
+ collection: {
43
+ testDriver2: [],
44
+ },
45
+ metadata: {},
46
+ });
47
+ }
48
+ }
49
+
50
+ describe('@daffodil/search/driver/federated | DaffSearchFederatedDriver', () => {
51
+ let service: DaffSearchFederatedDriver;
52
+
53
+ beforeEach(() => {
54
+ TestBed.configureTestingModule({
55
+ providers: [
56
+ DaffSearchFederatedDriver,
57
+ ...daffProvideSearchFederatedDrivers(TestDriver1, TestDriver2),
58
+ ],
59
+ });
60
+
61
+ service = TestBed.inject(DaffSearchFederatedDriver);
62
+ });
63
+
64
+ it('should be created', () => {
65
+ expect(service).toBeTruthy();
66
+ });
67
+
68
+ describe('search | invoking injected drivers', () => {
69
+ let result: Observable<DaffSearchDriverResponse>;
70
+
71
+ beforeEach(() => {
72
+ result = service.search('query');
73
+ });
74
+
75
+ it('should invoke and collect the result from the injected drivers', () => {
76
+ const expected = cold('(a|)', { a: jasmine.objectContaining({
77
+ collection: {
78
+ testDriver1: jasmine.truthy(),
79
+ testDriver2: jasmine.truthy(),
80
+ },
81
+ }) });
82
+
83
+ expect(result).toBeObservable(expected);
84
+ });
85
+ });
86
+ });
@@ -0,0 +1,49 @@
1
+ import {
2
+ Inject,
3
+ Injectable,
4
+ } from '@angular/core';
5
+ import {
6
+ combineLatest,
7
+ Observable,
8
+ } from 'rxjs';
9
+ import { map } from 'rxjs/operators';
10
+
11
+ import {
12
+ DaffSearchDriverInterface,
13
+ DaffSearchDriverKindedInterface,
14
+ DaffSearchDriverOptions,
15
+ DaffSearchDriverResponse,
16
+ } from '@daffodil/search/driver';
17
+
18
+ import {
19
+ DaffSearchFederatedDriverConfig,
20
+ SEARCH_FEDERATED_CONFIG_TOKEN,
21
+ } from './config/public_api';
22
+ import { DAFF_SEARCH_FEDERATED_DRIVERS } from './injection-tokens/drivers.token';
23
+
24
+ /**
25
+ * A service for calling and combining the results of provided federated search drivers.
26
+ *
27
+ * @inheritdoc
28
+ */
29
+ @Injectable({
30
+ providedIn: 'root',
31
+ })
32
+ export class DaffSearchFederatedDriver implements DaffSearchDriverInterface {
33
+ constructor(
34
+ @Inject(DAFF_SEARCH_FEDERATED_DRIVERS) private drivers: DaffSearchDriverKindedInterface[],
35
+ @Inject(SEARCH_FEDERATED_CONFIG_TOKEN) private config: DaffSearchFederatedDriverConfig,
36
+ ) {}
37
+
38
+ search(query: string, options: DaffSearchDriverOptions = {}): Observable<DaffSearchDriverResponse> {
39
+ return combineLatest(this.drivers.reduce<Record<string, Observable<DaffSearchDriverResponse>>>((acc, driver) => {
40
+ acc[driver.kind] = driver.search(query, options);
41
+ return acc;
42
+ }, {})).pipe(
43
+ map(responses => ({
44
+ collection: Object.assign({}, ...Object.values(responses).map(({ collection }) => collection)),
45
+ metadata: this.config.preferredDriverKind ? responses[this.config.preferredDriverKind].metadata : {},
46
+ })),
47
+ );
48
+ }
49
+ }
@@ -0,0 +1,8 @@
1
+ {
2
+ "$schema": "../../../../node_modules/ng-packagr/ng-package.schema.json",
3
+ "dest": "../../dist/search/driver/in-memory",
4
+ "deleteDestPath": false,
5
+ "lib": {
6
+ "entryFile": "src/index.ts"
7
+ }
8
+ }
@@ -0,0 +1,3 @@
1
+ {
2
+ "name": "@daffodil/search/driver/in-memory"
3
+ }
@@ -0,0 +1,111 @@
1
+ import { Injectable } from '@angular/core';
2
+ import { TestBed } from '@angular/core/testing';
3
+ import {
4
+ RequestInfo,
5
+ STATUS,
6
+ } from 'angular-in-memory-web-api';
7
+ import {
8
+ Observable,
9
+ of,
10
+ } from 'rxjs';
11
+
12
+ import {
13
+ DaffSearchResult,
14
+ daffSearchTransformResultsToCollection,
15
+ } from '@daffodil/search';
16
+ import {
17
+ DaffSearchInMemoryChildBackend,
18
+ daffProvideSearchInMemoryBackends,
19
+ } from '@daffodil/search/driver/in-memory';
20
+ import {
21
+ DaffSearchResultFactory,
22
+ DaffSearchTestingModule,
23
+ } from '@daffodil/search/testing';
24
+
25
+ import { DaffInMemoryBackendSearchDriver } from './search.service';
26
+
27
+ describe('@daffodil/search/driver/in-memory | DaffInMemoryBackendSearchDriver', () => {
28
+ let service: DaffInMemoryBackendSearchDriver;
29
+ let resultFactory: DaffSearchResultFactory;
30
+ let mockResults1: DaffSearchResult[];
31
+ let mockResults2: DaffSearchResult[];
32
+
33
+ @Injectable({
34
+ providedIn: 'root',
35
+ })
36
+ class TestBackend1 implements DaffSearchInMemoryChildBackend {
37
+ kind = 'TestBackend1';
38
+
39
+ get(reqInfo: RequestInfo) {
40
+ return reqInfo.utils.createResponse$(() => ({
41
+ body: {
42
+ collection: daffSearchTransformResultsToCollection(mockResults1),
43
+ metadata: {},
44
+ },
45
+ status: STATUS.OK,
46
+ }));
47
+ }
48
+ }
49
+
50
+ @Injectable({
51
+ providedIn: 'root',
52
+ })
53
+ class TestBackend2 implements DaffSearchInMemoryChildBackend {
54
+ kind = 'TestBackend2';
55
+
56
+ get(reqInfo: RequestInfo) {
57
+ return reqInfo.utils.createResponse$(() => ({
58
+ body: {
59
+ collection: daffSearchTransformResultsToCollection(mockResults2),
60
+ metadata: {},
61
+ },
62
+ status: STATUS.OK,
63
+ }));
64
+ }
65
+ }
66
+
67
+ beforeEach(() => {
68
+ TestBed.configureTestingModule({
69
+ imports: [
70
+ DaffSearchTestingModule,
71
+ ],
72
+ providers: [
73
+ DaffInMemoryBackendSearchDriver,
74
+ ...daffProvideSearchInMemoryBackends(TestBackend1, TestBackend2),
75
+ ],
76
+ });
77
+
78
+ service = TestBed.inject(DaffInMemoryBackendSearchDriver);
79
+ resultFactory = TestBed.inject(DaffSearchResultFactory);
80
+
81
+ mockResults1 = resultFactory.createMany(3, { kind: 'TestBackend1' });
82
+ mockResults2 = resultFactory.createMany(3, { kind: 'TestBackend2' });
83
+ });
84
+
85
+ it('should be created', () => {
86
+ expect(service).toBeTruthy();
87
+ });
88
+
89
+ describe('get', () => {
90
+ let reqInfoStub;
91
+ let result: Observable<any>;
92
+
93
+ beforeEach(() => {
94
+ reqInfoStub = {
95
+ utils: {
96
+ createResponse$: (func) => of(func()),
97
+ },
98
+ };
99
+
100
+ result = service.get(reqInfoStub);
101
+ });
102
+
103
+ it('should return results from all of the provided backends', done => {
104
+ result.subscribe(res => {
105
+ expect(res.body.collection['TestBackend1']).toEqual(jasmine.arrayContaining(mockResults1));
106
+ expect(res.body.collection['TestBackend2']).toEqual(jasmine.arrayContaining(mockResults2));
107
+ done();
108
+ });
109
+ });
110
+ });
111
+ });
@@ -0,0 +1,83 @@
1
+ import {
2
+ Inject,
3
+ Injectable,
4
+ } from '@angular/core';
5
+ import {
6
+ InMemoryDbService,
7
+ RequestInfoUtilities,
8
+ ParsedRequestUrl,
9
+ STATUS,
10
+ RequestInfo,
11
+ } from 'angular-in-memory-web-api';
12
+ import {
13
+ combineLatest,
14
+ Observable,
15
+ } from 'rxjs';
16
+ import {
17
+ map,
18
+ switchMap,
19
+ } from 'rxjs/operators';
20
+
21
+ import { DaffSearchDriverResponse } from '@daffodil/search/driver';
22
+
23
+ import { DAFF_SEARCH_IN_MEMORY_BACKENDS } from '../injection-tokens/backends.token';
24
+ import { DaffSearchInMemoryChildBackend } from '../interfaces/public_api';
25
+
26
+ /**
27
+ * An in-memory service that delegates search queries to child backends
28
+ * via the {@link DAFF_SEARCH_IN_MEMORY_BACKENDS}.
29
+ */
30
+ @Injectable({
31
+ providedIn: 'root',
32
+ })
33
+ export class DaffInMemoryBackendSearchDriver implements InMemoryDbService {
34
+ constructor(
35
+ @Inject(DAFF_SEARCH_IN_MEMORY_BACKENDS) private backends: DaffSearchInMemoryChildBackend[],
36
+ ) {}
37
+
38
+ /**
39
+ * Automatically called as part of the InMemoryDbService to parse incoming urls to match the InMemory backend urls.
40
+ *
41
+ * @param url initial url
42
+ * @param utils utility to parse url
43
+ * @returns ParsedRequestUrl
44
+ * @docs-private
45
+ */
46
+ parseRequestUrl(url: string, utils: RequestInfoUtilities): ParsedRequestUrl {
47
+ return utils.parseRequestUrl(url);
48
+ }
49
+
50
+ /**
51
+ * @docs-private
52
+ */
53
+ createDb(): any {
54
+ return {};
55
+ }
56
+
57
+ /**
58
+ * Searches for entities in child backends.
59
+ *
60
+ * @param reqInfo request object
61
+ * @returns An http response object
62
+ */
63
+ get(reqInfo: RequestInfo) {
64
+ const responses = this.backends.map(backend => backend.get(reqInfo));
65
+ return combineLatest(responses).pipe(
66
+ map(resps =>
67
+ resps.reduce((acc, resp) => {
68
+ acc.collection = {
69
+ ...acc.collection,
70
+ ...resp.body.collection,
71
+ };
72
+ return acc;
73
+ }, <DaffSearchDriverResponse>{
74
+ metadata: {},
75
+ }),
76
+ ),
77
+ switchMap(resp => reqInfo.utils.createResponse$(() => ({
78
+ status: STATUS.OK,
79
+ body: resp,
80
+ }))),
81
+ );
82
+ }
83
+ }
@@ -0,0 +1,33 @@
1
+ import { CommonModule } from '@angular/common';
2
+ import {
3
+ NgModule,
4
+ ModuleWithProviders,
5
+ } from '@angular/core';
6
+
7
+ import { DaffSearchDriver } from '@daffodil/search/driver';
8
+ import { DaffSearchTestingModule } from '@daffodil/search/testing';
9
+
10
+ import { DaffInMemorySearchDriver } from './search.service';
11
+
12
+ /**
13
+ * Provides the {@link DaffInMemorySearchDriver} as the {@link DaffSearchDriver}.
14
+ */
15
+ @NgModule({
16
+ imports: [
17
+ CommonModule,
18
+ DaffSearchTestingModule,
19
+ ],
20
+ })
21
+ export class DaffSearchInMemoryDriverModule {
22
+ static forRoot(): ModuleWithProviders<DaffSearchInMemoryDriverModule> {
23
+ return {
24
+ ngModule: DaffSearchInMemoryDriverModule,
25
+ providers: [
26
+ {
27
+ provide: DaffSearchDriver,
28
+ useExisting: DaffInMemorySearchDriver,
29
+ },
30
+ ],
31
+ };
32
+ }
33
+ }