@daffodil/product 0.42.4 → 0.43.0

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 (407) hide show
  1. package/driver/errors/codes.enum.d.ts +3 -0
  2. package/driver/errors/map.d.ts +7 -0
  3. package/driver/errors/product-not-found.d.ts +8 -0
  4. package/driver/errors/public_api.d.ts +3 -0
  5. package/driver/magento/models/aggregation.d.ts +17 -0
  6. package/driver/magento/models/filter-type-field.interface.d.ts +7 -0
  7. package/driver/magento/models/filter-type.enum.d.ts +5 -0
  8. package/driver/magento/models/filters.d.ts +13 -0
  9. package/driver/magento/models/get-filter-types-response.interface.d.ts +6 -0
  10. package/driver/magento/models/page-info.d.ts +6 -0
  11. package/driver/magento/models/public_api.d.ts +8 -0
  12. package/driver/magento/models/sort-fields.d.ts +9 -0
  13. package/driver/magento/models/sort.d.ts +7 -0
  14. package/driver/magento/queries/fragments/page-info.d.ts +1 -0
  15. package/driver/magento/queries/fragments/product-aggregations.d.ts +1 -0
  16. package/driver/magento/queries/fragments/sort-fields.d.ts +1 -0
  17. package/driver/magento/queries/get-filter-types.d.ts +2 -0
  18. package/driver/magento/queries/public_api.d.ts +4 -0
  19. package/driver/magento/testing/factories/aggregation/aggregation.factory.d.ts +12 -0
  20. package/driver/magento/testing/factories/aggregation/public_api.d.ts +3 -0
  21. package/driver/magento/testing/factories/aggregation/type/price.factory.d.ts +8 -0
  22. package/driver/magento/testing/factories/aggregation/type/select.factory.d.ts +8 -0
  23. package/driver/magento/testing/factories/filter-type-field.factory.d.ts +8 -0
  24. package/driver/magento/testing/factories/page-info.factory.d.ts +8 -0
  25. package/driver/magento/testing/factories/public_api.d.ts +4 -0
  26. package/driver/magento/testing/factories/sort-fields.factory.d.ts +8 -0
  27. package/driver/magento/transforms/aggregate/add-metadata-types-to-aggregates.d.ts +2 -0
  28. package/driver/magento/transforms/aggregate/get-matched-attribute-type.d.ts +2 -0
  29. package/driver/magento/transforms/aggregate/public_api.d.ts +3 -0
  30. package/driver/magento/transforms/aggregate/transform.d.ts +3 -0
  31. package/driver/magento/transforms/aggregate/type/equal.d.ts +3 -0
  32. package/driver/magento/transforms/aggregate/type/range.d.ts +8 -0
  33. package/driver/magento/transforms/applied-filter-transformer.service.d.ts +18 -0
  34. package/driver/magento/transforms/applied-sort-option.d.ts +3 -0
  35. package/driver/magento/transforms/collection-metadata.d.ts +7 -0
  36. package/driver/magento/transforms/public_api.d.ts +4 -0
  37. package/driver/magento/transforms/sort-options/sort-default-option-first.d.ts +2 -0
  38. package/driver/public_api.d.ts +1 -0
  39. package/errors/codes.enum.d.ts +15 -0
  40. package/errors/map.d.ts +5 -0
  41. package/errors/public_api.d.ts +2 -0
  42. package/esm2020/driver/errors/codes.enum.mjs +5 -0
  43. package/esm2020/driver/errors/map.mjs +9 -0
  44. package/esm2020/driver/errors/product-not-found.mjs +12 -0
  45. package/esm2020/driver/errors/public_api.mjs +4 -0
  46. package/esm2020/driver/magento/models/aggregation.mjs +2 -0
  47. package/esm2020/driver/magento/models/filter-type-field.interface.mjs +2 -0
  48. package/esm2020/driver/magento/models/filter-type.enum.mjs +7 -0
  49. package/esm2020/driver/magento/models/filters.mjs +9 -0
  50. package/esm2020/driver/magento/models/get-filter-types-response.interface.mjs +2 -0
  51. package/esm2020/driver/magento/models/page-info.mjs +2 -0
  52. package/esm2020/driver/magento/models/public_api.mjs +4 -1
  53. package/esm2020/driver/magento/models/sort-fields.mjs +2 -0
  54. package/esm2020/driver/magento/models/sort.mjs +6 -0
  55. package/esm2020/driver/magento/queries/fragments/page-info.mjs +9 -0
  56. package/esm2020/driver/magento/queries/fragments/product-aggregations.mjs +14 -0
  57. package/esm2020/driver/magento/queries/fragments/sort-fields.mjs +11 -0
  58. package/esm2020/driver/magento/queries/get-filter-types.mjs +15 -0
  59. package/esm2020/driver/magento/queries/public_api.mjs +5 -1
  60. package/esm2020/driver/magento/testing/factories/aggregation/aggregation.factory.mjs +24 -0
  61. package/esm2020/driver/magento/testing/factories/aggregation/public_api.mjs +4 -0
  62. package/esm2020/driver/magento/testing/factories/aggregation/type/price.factory.mjs +50 -0
  63. package/esm2020/driver/magento/testing/factories/aggregation/type/select.factory.mjs +45 -0
  64. package/esm2020/driver/magento/testing/factories/filter-type-field.factory.mjs +32 -0
  65. package/esm2020/driver/magento/testing/factories/page-info.factory.mjs +25 -0
  66. package/esm2020/driver/magento/testing/factories/public_api.mjs +5 -1
  67. package/esm2020/driver/magento/testing/factories/sort-fields.factory.mjs +29 -0
  68. package/esm2020/driver/magento/transforms/aggregate/add-metadata-types-to-aggregates.mjs +8 -0
  69. package/esm2020/driver/magento/transforms/aggregate/get-matched-attribute-type.mjs +2 -0
  70. package/esm2020/driver/magento/transforms/aggregate/public_api.mjs +4 -0
  71. package/esm2020/driver/magento/transforms/aggregate/transform.mjs +14 -0
  72. package/esm2020/driver/magento/transforms/aggregate/type/equal.mjs +16 -0
  73. package/esm2020/driver/magento/transforms/aggregate/type/range.mjs +15 -0
  74. package/esm2020/driver/magento/transforms/applied-filter-transformer.service.mjs +59 -0
  75. package/esm2020/driver/magento/transforms/applied-sort-option.mjs +14 -0
  76. package/esm2020/driver/magento/transforms/collection-metadata.mjs +22 -0
  77. package/esm2020/driver/magento/transforms/public_api.mjs +5 -1
  78. package/esm2020/driver/magento/transforms/sort-options/sort-default-option-first.mjs +12 -0
  79. package/esm2020/driver/public_api.mjs +2 -1
  80. package/esm2020/errors/codes.enum.mjs +12 -0
  81. package/esm2020/errors/map.mjs +8 -0
  82. package/esm2020/errors/public_api.mjs +3 -0
  83. package/esm2020/filters/array-to-dict/array-to-dict.mjs +6 -0
  84. package/esm2020/filters/behaviors/apply/apply-filter.mjs +24 -0
  85. package/esm2020/filters/behaviors/apply/apply-request-to-filters.mjs +12 -0
  86. package/esm2020/filters/behaviors/apply/apply-requests-to-filters.mjs +12 -0
  87. package/esm2020/filters/behaviors/apply/public_api.mjs +4 -0
  88. package/esm2020/filters/behaviors/clear/clear-filter.mjs +21 -0
  89. package/esm2020/filters/behaviors/clear/clear-filters.mjs +12 -0
  90. package/esm2020/filters/behaviors/clear/public_api.mjs +3 -0
  91. package/esm2020/filters/behaviors/remove/public_api.mjs +4 -0
  92. package/esm2020/filters/behaviors/remove/remove-filter.mjs +25 -0
  93. package/esm2020/filters/behaviors/remove/remove-request-from-filters.mjs +12 -0
  94. package/esm2020/filters/behaviors/remove/remove-requests-from-filters.mjs +13 -0
  95. package/esm2020/filters/behaviors/toggle/public_api.mjs +3 -0
  96. package/esm2020/filters/behaviors/toggle/toggle-request-on-filters.mjs +10 -0
  97. package/esm2020/filters/behaviors/toggle/toggle.mjs +22 -0
  98. package/esm2020/filters/compute-applied-filters/compute-applied-filters.mjs +21 -0
  99. package/esm2020/filters/errors/codes.enum.mjs +13 -0
  100. package/esm2020/filters/errors/filter-not-found.error.mjs +12 -0
  101. package/esm2020/filters/errors/map.mjs +15 -0
  102. package/esm2020/filters/errors/public_api.mjs +5 -0
  103. package/esm2020/filters/errors/request-name-mismatch.error.mjs +13 -0
  104. package/esm2020/filters/errors/request-type-mismatch.error.mjs +13 -0
  105. package/esm2020/filters/errors/unknown-filter-type.error.mjs +13 -0
  106. package/esm2020/filters/find-applied/find-applied-options.mjs +5 -0
  107. package/esm2020/filters/find-applied/public_api.mjs +2 -0
  108. package/esm2020/filters/is-applied/is-filter-applied.mjs +18 -0
  109. package/esm2020/filters/is-applied/is-toggle-request-applied-to-filter.mjs +18 -0
  110. package/esm2020/filters/is-applied/public_api.mjs +3 -0
  111. package/esm2020/filters/public_api.mjs +14 -0
  112. package/esm2020/filters/to-request/filter-to-request.mjs +20 -0
  113. package/esm2020/filters/to-request/filters-to-requests.mjs +15 -0
  114. package/esm2020/filters/to-request/public_api.mjs +3 -0
  115. package/esm2020/filters/type/equal/array-to-dict/option.mjs +6 -0
  116. package/esm2020/filters/type/equal/behaviors/apply/apply.mjs +20 -0
  117. package/esm2020/filters/type/equal/behaviors/clear/clear.mjs +17 -0
  118. package/esm2020/filters/type/equal/behaviors/remove/remove.mjs +23 -0
  119. package/esm2020/filters/type/equal/behaviors/toggle/toggle.mjs +24 -0
  120. package/esm2020/filters/type/equal/is-applied/is-applied.mjs +5 -0
  121. package/esm2020/filters/type/equal/is-applied/is-toggle-request-applied-to-filter.mjs +5 -0
  122. package/esm2020/filters/type/equal/public_api.mjs +2 -0
  123. package/esm2020/filters/type/equal/to-request/filter-to-request.mjs +17 -0
  124. package/esm2020/filters/type/range/array-to-dict/pair.mjs +7 -0
  125. package/esm2020/filters/type/range/behaviors/apply/apply.mjs +24 -0
  126. package/esm2020/filters/type/range/behaviors/clear/clear.mjs +11 -0
  127. package/esm2020/filters/type/range/behaviors/remove/remove.mjs +17 -0
  128. package/esm2020/filters/type/range/behaviors/toggle/toggle.mjs +15 -0
  129. package/esm2020/filters/type/range/compute-pair-label.mjs +3 -0
  130. package/esm2020/filters/type/range/is-applied/is-applied.mjs +5 -0
  131. package/esm2020/filters/type/range/is-applied/is-toggle-request-applied-to-filter.mjs +6 -0
  132. package/esm2020/filters/type/range/public_api.mjs +3 -0
  133. package/esm2020/filters/type/range/to-request/filter-to-request.mjs +19 -0
  134. package/esm2020/filters/type/range-numeric/to-request/filter-to-request.mjs +6 -0
  135. package/esm2020/filters/validators/public_api.mjs +3 -0
  136. package/esm2020/filters/validators/request-name-match.mjs +16 -0
  137. package/esm2020/filters/validators/request-type-match.mjs +12 -0
  138. package/esm2020/helpers/collection/build-request.mjs +10 -0
  139. package/esm2020/helpers/has-discount.mjs +8 -0
  140. package/esm2020/helpers/has-price-range.mjs +8 -0
  141. package/esm2020/helpers/public_api.mjs +4 -0
  142. package/esm2020/models/collection/collection.interface.mjs +2 -0
  143. package/esm2020/models/collection/metadata.interface.mjs +2 -0
  144. package/esm2020/models/collection/public_api.mjs +2 -0
  145. package/esm2020/models/collection/request.interface.mjs +2 -0
  146. package/esm2020/models/filters/filter-base.mjs +2 -0
  147. package/esm2020/models/filters/filter-option-base.mjs +2 -0
  148. package/esm2020/models/filters/filter-option.mjs +2 -0
  149. package/esm2020/models/filters/filter-request.mjs +2 -0
  150. package/esm2020/models/filters/filter-toggle-request.mjs +2 -0
  151. package/esm2020/models/filters/filter.mjs +2 -0
  152. package/esm2020/models/filters/filterable.mjs +2 -0
  153. package/esm2020/models/filters/public_api.mjs +5 -0
  154. package/esm2020/models/filters/type/equal/filter.mjs +2 -0
  155. package/esm2020/models/filters/type/equal/option.mjs +2 -0
  156. package/esm2020/models/filters/type/equal/public_api.mjs +2 -0
  157. package/esm2020/models/filters/type/equal/request.mjs +2 -0
  158. package/esm2020/models/filters/type/equal/toggle-request.mjs +2 -0
  159. package/esm2020/models/filters/type/filter-type.mjs +9 -0
  160. package/esm2020/models/filters/type/range/filter-base.mjs +2 -0
  161. package/esm2020/models/filters/type/range/option.mjs +2 -0
  162. package/esm2020/models/filters/type/range/pair.mjs +2 -0
  163. package/esm2020/models/filters/type/range/public_api.mjs +2 -0
  164. package/esm2020/models/filters/type/range/request-base.mjs +2 -0
  165. package/esm2020/models/filters/type/range/request-option.mjs +2 -0
  166. package/esm2020/models/filters/type/range/separator.mjs +6 -0
  167. package/esm2020/models/filters/type/range-numeric/filter.mjs +2 -0
  168. package/esm2020/models/filters/type/range-numeric/public_api.mjs +2 -0
  169. package/esm2020/models/filters/type/range-numeric/request.mjs +2 -0
  170. package/esm2020/models/filters/type/range-numeric/toggle-request.mjs +2 -0
  171. package/esm2020/models/public_api.mjs +6 -0
  172. package/esm2020/public_api.mjs +5 -5
  173. package/esm2020/routing/config/default.mjs +28 -0
  174. package/esm2020/routing/config/interface.mjs +2 -0
  175. package/esm2020/routing/config/public_api.mjs +3 -0
  176. package/esm2020/routing/config/token.mjs +10 -0
  177. package/esm2020/routing/constants/collection-request-fields.mjs +11 -0
  178. package/esm2020/routing/constants/public_api.mjs +2 -0
  179. package/esm2020/routing/effects/collection.effects.mjs +35 -0
  180. package/esm2020/routing/effects/public_api.mjs +2 -0
  181. package/esm2020/routing/models/collection-request-query-param-transforms.interface.mjs +2 -0
  182. package/esm2020/routing/models/collection-request-query-params.interface.mjs +2 -0
  183. package/esm2020/routing/models/public_api.mjs +2 -0
  184. package/esm2020/routing/module.mjs +34 -0
  185. package/esm2020/routing/public_api.mjs +7 -1
  186. package/esm2020/routing/services/get-query-params-from-request.service.mjs +31 -0
  187. package/esm2020/routing/services/get-request-from-route.service.mjs +34 -0
  188. package/esm2020/routing/services/public_api.mjs +3 -0
  189. package/esm2020/state/actions/collection.actions.mjs +2 -0
  190. package/esm2020/state/actions/public_api.mjs +2 -1
  191. package/esm2020/state/facades/collection/facade.interface.mjs +2 -0
  192. package/esm2020/state/facades/collection/facade.mjs +26 -0
  193. package/esm2020/state/facades/public_api.mjs +2 -1
  194. package/esm2020/state/product-state.module.mjs +4 -4
  195. package/esm2020/state/public_api.mjs +1 -1
  196. package/esm2020/state/reducers/collection/public_api.mjs +2 -0
  197. package/esm2020/state/reducers/collection/reducer.mjs +37 -0
  198. package/esm2020/state/reducers/collection/state.interface.mjs +2 -0
  199. package/esm2020/state/reducers/injection-tokens/extra.token.mjs +27 -0
  200. package/esm2020/state/reducers/injection-tokens/public_api.mjs +2 -1
  201. package/esm2020/state/reducers/injection-tokens/reducers.token.mjs +18 -0
  202. package/esm2020/state/reducers/product/product.reducer.mjs +3 -3
  203. package/esm2020/state/reducers/public_api.mjs +3 -2
  204. package/esm2020/state/selectors/collection/selector-factory.mjs +19 -0
  205. package/esm2020/state/selectors/public_api.mjs +2 -1
  206. package/esm2020/state/testing/mock-product-collection-facade.mjs +26 -0
  207. package/esm2020/state/testing/public_api.mjs +2 -1
  208. package/esm2020/testing/factories/collection/collection.factory.mjs +32 -0
  209. package/esm2020/testing/factories/collection/metadata.factory.mjs +34 -0
  210. package/esm2020/testing/factories/collection/request.factory.mjs +36 -0
  211. package/esm2020/testing/factories/filters/filter.factory.mjs +50 -0
  212. package/esm2020/testing/factories/filters/public_api.mjs +5 -0
  213. package/esm2020/testing/factories/filters/request.factory.mjs +27 -0
  214. package/esm2020/testing/factories/filters/toggle-request.mjs +35 -0
  215. package/esm2020/testing/factories/filters/type/equal/option.mjs +29 -0
  216. package/esm2020/testing/factories/filters/type/equal/public_api.mjs +4 -0
  217. package/esm2020/testing/factories/filters/type/equal/request.mjs +29 -0
  218. package/esm2020/testing/factories/filters/type/equal/toggle-request.mjs +29 -0
  219. package/esm2020/testing/factories/filters/type/equal.mjs +30 -0
  220. package/esm2020/testing/factories/filters/type/public_api.mjs +5 -0
  221. package/esm2020/testing/factories/filters/type/range-numeric/option.mjs +27 -0
  222. package/esm2020/testing/factories/filters/type/range-numeric/pair.mjs +37 -0
  223. package/esm2020/testing/factories/filters/type/range-numeric/public_api.mjs +6 -0
  224. package/esm2020/testing/factories/filters/type/range-numeric/request-option.mjs +27 -0
  225. package/esm2020/testing/factories/filters/type/range-numeric/request.mjs +38 -0
  226. package/esm2020/testing/factories/filters/type/range-numeric/toggle-request.mjs +38 -0
  227. package/esm2020/testing/factories/filters/type/range-numeric.mjs +32 -0
  228. package/esm2020/testing/factories/public_api.mjs +5 -1
  229. package/fesm2015/daffodil-product-driver-magento-testing.mjs +177 -2
  230. package/fesm2015/daffodil-product-driver-magento-testing.mjs.map +1 -1
  231. package/fesm2015/daffodil-product-driver-magento.mjs +211 -9
  232. package/fesm2015/daffodil-product-driver-magento.mjs.map +1 -1
  233. package/fesm2015/daffodil-product-driver.mjs +24 -1
  234. package/fesm2015/daffodil-product-driver.mjs.map +1 -1
  235. package/fesm2015/daffodil-product-routing.mjs +176 -5
  236. package/fesm2015/daffodil-product-routing.mjs.map +1 -1
  237. package/fesm2015/daffodil-product-state-testing.mjs +24 -1
  238. package/fesm2015/daffodil-product-state-testing.mjs.map +1 -1
  239. package/fesm2015/daffodil-product-state.mjs +114 -12
  240. package/fesm2015/daffodil-product-state.mjs.map +1 -1
  241. package/fesm2015/daffodil-product-testing.mjs +417 -3
  242. package/fesm2015/daffodil-product-testing.mjs.map +1 -1
  243. package/fesm2015/daffodil-product.mjs +518 -1
  244. package/fesm2015/daffodil-product.mjs.map +1 -1
  245. package/fesm2020/daffodil-product-driver-magento-testing.mjs +177 -2
  246. package/fesm2020/daffodil-product-driver-magento-testing.mjs.map +1 -1
  247. package/fesm2020/daffodil-product-driver-magento.mjs +224 -9
  248. package/fesm2020/daffodil-product-driver-magento.mjs.map +1 -1
  249. package/fesm2020/daffodil-product-driver.mjs +24 -1
  250. package/fesm2020/daffodil-product-driver.mjs.map +1 -1
  251. package/fesm2020/daffodil-product-routing.mjs +170 -5
  252. package/fesm2020/daffodil-product-routing.mjs.map +1 -1
  253. package/fesm2020/daffodil-product-state-testing.mjs +24 -1
  254. package/fesm2020/daffodil-product-state-testing.mjs.map +1 -1
  255. package/fesm2020/daffodil-product-state.mjs +127 -12
  256. package/fesm2020/daffodil-product-state.mjs.map +1 -1
  257. package/fesm2020/daffodil-product-testing.mjs +436 -3
  258. package/fesm2020/daffodil-product-testing.mjs.map +1 -1
  259. package/fesm2020/daffodil-product.mjs +574 -1
  260. package/fesm2020/daffodil-product.mjs.map +1 -1
  261. package/filters/array-to-dict/array-to-dict.d.ts +5 -0
  262. package/filters/behaviors/apply/apply-filter.d.ts +8 -0
  263. package/filters/behaviors/apply/apply-request-to-filters.d.ts +8 -0
  264. package/filters/behaviors/apply/apply-requests-to-filters.d.ts +8 -0
  265. package/filters/behaviors/apply/public_api.d.ts +3 -0
  266. package/filters/behaviors/clear/clear-filter.d.ts +8 -0
  267. package/filters/behaviors/clear/clear-filters.d.ts +8 -0
  268. package/filters/behaviors/clear/public_api.d.ts +2 -0
  269. package/filters/behaviors/remove/public_api.d.ts +3 -0
  270. package/filters/behaviors/remove/remove-filter.d.ts +9 -0
  271. package/filters/behaviors/remove/remove-request-from-filters.d.ts +8 -0
  272. package/filters/behaviors/remove/remove-requests-from-filters.d.ts +9 -0
  273. package/filters/behaviors/toggle/public_api.d.ts +2 -0
  274. package/filters/behaviors/toggle/toggle-request-on-filters.d.ts +6 -0
  275. package/filters/behaviors/toggle/toggle.d.ts +6 -0
  276. package/filters/compute-applied-filters/compute-applied-filters.d.ts +6 -0
  277. package/filters/errors/codes.enum.d.ts +11 -0
  278. package/filters/errors/filter-not-found.error.d.ts +8 -0
  279. package/filters/errors/map.d.ts +13 -0
  280. package/filters/errors/public_api.d.ts +4 -0
  281. package/filters/errors/request-name-mismatch.error.d.ts +9 -0
  282. package/filters/errors/request-type-mismatch.error.d.ts +9 -0
  283. package/filters/errors/unknown-filter-type.error.d.ts +9 -0
  284. package/filters/find-applied/find-applied-options.d.ts +5 -0
  285. package/filters/find-applied/public_api.d.ts +1 -0
  286. package/filters/is-applied/is-filter-applied.d.ts +5 -0
  287. package/filters/is-applied/is-toggle-request-applied-to-filter.d.ts +5 -0
  288. package/filters/is-applied/public_api.d.ts +2 -0
  289. package/filters/public_api.d.ts +13 -0
  290. package/filters/to-request/filter-to-request.d.ts +6 -0
  291. package/filters/to-request/filters-to-requests.d.ts +6 -0
  292. package/filters/to-request/public_api.d.ts +2 -0
  293. package/filters/type/equal/array-to-dict/option.d.ts +5 -0
  294. package/filters/type/equal/behaviors/apply/apply.d.ts +8 -0
  295. package/filters/type/equal/behaviors/clear/clear.d.ts +8 -0
  296. package/filters/type/equal/behaviors/remove/remove.d.ts +11 -0
  297. package/filters/type/equal/behaviors/toggle/toggle.d.ts +11 -0
  298. package/filters/type/equal/is-applied/is-applied.d.ts +5 -0
  299. package/filters/type/equal/is-applied/is-toggle-request-applied-to-filter.d.ts +5 -0
  300. package/filters/type/equal/public_api.d.ts +1 -0
  301. package/filters/type/equal/to-request/filter-to-request.d.ts +5 -0
  302. package/filters/type/range/array-to-dict/pair.d.ts +5 -0
  303. package/filters/type/range/behaviors/apply/apply.d.ts +8 -0
  304. package/filters/type/range/behaviors/clear/clear.d.ts +8 -0
  305. package/filters/type/range/behaviors/remove/remove.d.ts +11 -0
  306. package/filters/type/range/behaviors/toggle/toggle.d.ts +10 -0
  307. package/filters/type/range/compute-pair-label.d.ts +1 -0
  308. package/filters/type/range/is-applied/is-applied.d.ts +5 -0
  309. package/filters/type/range/is-applied/is-toggle-request-applied-to-filter.d.ts +5 -0
  310. package/filters/type/range/public_api.d.ts +2 -0
  311. package/filters/type/range/to-request/filter-to-request.d.ts +5 -0
  312. package/filters/type/range-numeric/to-request/filter-to-request.d.ts +5 -0
  313. package/filters/validators/public_api.d.ts +2 -0
  314. package/filters/validators/request-name-match.d.ts +7 -0
  315. package/filters/validators/request-type-match.d.ts +7 -0
  316. package/helpers/collection/build-request.d.ts +5 -0
  317. package/helpers/has-discount.d.ts +7 -0
  318. package/helpers/has-price-range.d.ts +7 -0
  319. package/helpers/public_api.d.ts +3 -0
  320. package/models/collection/collection.interface.d.ts +14 -0
  321. package/models/collection/metadata.interface.d.ts +8 -0
  322. package/models/collection/public_api.d.ts +3 -0
  323. package/models/collection/request.interface.d.ts +8 -0
  324. package/models/filters/filter-base.d.ts +24 -0
  325. package/models/filters/filter-option-base.d.ts +9 -0
  326. package/models/filters/filter-option.d.ts +6 -0
  327. package/models/filters/filter-request.d.ts +7 -0
  328. package/models/filters/filter-toggle-request.d.ts +6 -0
  329. package/models/filters/filter.d.ts +9 -0
  330. package/models/filters/filterable.d.ts +10 -0
  331. package/models/filters/public_api.d.ts +11 -0
  332. package/models/filters/type/equal/filter.d.ts +24 -0
  333. package/models/filters/type/equal/option.d.ts +19 -0
  334. package/models/filters/type/equal/public_api.d.ts +4 -0
  335. package/models/filters/type/equal/request.d.ts +18 -0
  336. package/models/filters/type/equal/toggle-request.d.ts +18 -0
  337. package/models/filters/type/filter-type.d.ts +7 -0
  338. package/models/filters/type/range/filter-base.d.ts +23 -0
  339. package/models/filters/type/range/option.d.ts +14 -0
  340. package/models/filters/type/range/pair.d.ts +20 -0
  341. package/models/filters/type/range/public_api.d.ts +6 -0
  342. package/models/filters/type/range/request-base.d.ts +20 -0
  343. package/models/filters/type/range/request-option.d.ts +14 -0
  344. package/models/filters/type/range/separator.d.ts +5 -0
  345. package/models/filters/type/range-numeric/filter.d.ts +11 -0
  346. package/models/filters/type/range-numeric/public_api.d.ts +3 -0
  347. package/models/filters/type/range-numeric/request.d.ts +11 -0
  348. package/models/filters/type/range-numeric/toggle-request.d.ts +12 -0
  349. package/models/public_api.d.ts +5 -0
  350. package/package.json +3 -3
  351. package/public_api.d.ts +4 -4
  352. package/routing/config/default.d.ts +7 -0
  353. package/routing/config/interface.d.ts +18 -0
  354. package/routing/config/public_api.d.ts +3 -0
  355. package/routing/config/token.d.ts +6 -0
  356. package/routing/constants/collection-request-fields.d.ts +5 -0
  357. package/routing/constants/public_api.d.ts +1 -0
  358. package/routing/effects/collection.effects.d.ts +20 -0
  359. package/routing/effects/public_api.d.ts +1 -0
  360. package/routing/models/collection-request-query-param-transforms.interface.d.ts +22 -0
  361. package/routing/models/collection-request-query-params.interface.d.ts +8 -0
  362. package/routing/models/public_api.d.ts +2 -0
  363. package/routing/module.d.ts +9 -0
  364. package/routing/public_api.d.ts +6 -0
  365. package/routing/services/get-query-params-from-request.service.d.ts +15 -0
  366. package/routing/services/get-request-from-route.service.d.ts +16 -0
  367. package/routing/services/public_api.d.ts +2 -0
  368. package/state/actions/collection.actions.d.ts +43 -0
  369. package/state/actions/public_api.d.ts +1 -0
  370. package/state/facades/collection/facade.d.ts +25 -0
  371. package/state/facades/collection/facade.interface.d.ts +16 -0
  372. package/state/facades/public_api.d.ts +2 -0
  373. package/state/reducers/collection/public_api.d.ts +2 -0
  374. package/state/reducers/collection/reducer.d.ts +23 -0
  375. package/state/reducers/collection/state.interface.d.ts +5 -0
  376. package/state/reducers/injection-tokens/extra.token.d.ts +23 -0
  377. package/state/reducers/injection-tokens/public_api.d.ts +1 -0
  378. package/state/reducers/injection-tokens/reducers.token.d.ts +11 -0
  379. package/state/reducers/product/product.reducer.d.ts +1 -1
  380. package/state/reducers/public_api.d.ts +2 -1
  381. package/state/selectors/collection/selector-factory.d.ts +24 -0
  382. package/state/selectors/public_api.d.ts +1 -0
  383. package/state/testing/mock-product-collection-facade.d.ts +19 -0
  384. package/state/testing/public_api.d.ts +1 -0
  385. package/testing/factories/collection/collection.factory.d.ts +20 -0
  386. package/testing/factories/collection/metadata.factory.d.ts +19 -0
  387. package/testing/factories/collection/request.factory.d.ts +21 -0
  388. package/testing/factories/filters/filter.factory.d.ts +18 -0
  389. package/testing/factories/filters/public_api.d.ts +4 -0
  390. package/testing/factories/filters/request.factory.d.ts +15 -0
  391. package/testing/factories/filters/toggle-request.d.ts +18 -0
  392. package/testing/factories/filters/type/equal/option.d.ts +17 -0
  393. package/testing/factories/filters/type/equal/public_api.d.ts +3 -0
  394. package/testing/factories/filters/type/equal/request.d.ts +16 -0
  395. package/testing/factories/filters/type/equal/toggle-request.d.ts +16 -0
  396. package/testing/factories/filters/type/equal.d.ts +17 -0
  397. package/testing/factories/filters/type/public_api.d.ts +4 -0
  398. package/testing/factories/filters/type/range-numeric/option.d.ts +15 -0
  399. package/testing/factories/filters/type/range-numeric/pair.d.ts +23 -0
  400. package/testing/factories/filters/type/range-numeric/public_api.d.ts +5 -0
  401. package/testing/factories/filters/type/range-numeric/request-option.d.ts +15 -0
  402. package/testing/factories/filters/type/range-numeric/request.d.ts +23 -0
  403. package/testing/factories/filters/type/range-numeric/toggle-request.d.ts +20 -0
  404. package/testing/factories/filters/type/range-numeric.d.ts +19 -0
  405. package/testing/factories/public_api.d.ts +4 -0
  406. package/esm2020/helpers.mjs +0 -15
  407. package/helpers.d.ts +0 -13
@@ -0,0 +1,7 @@
1
+ import { DaffProductFilterRequest, DaffProductFilter, DaffProductFilterToggleRequest } from '../../models/public_api';
2
+ /**
3
+ * Ensures that the names of the filter and the filter request match.
4
+ *
5
+ * @throws {@link DaffProductFilterNotFound} if the names do not match.
6
+ */
7
+ export declare const daffProductValidateFilterRequestNameMatch: (request: DaffProductFilterRequest | DaffProductFilterToggleRequest, filter: DaffProductFilter) => void;
@@ -0,0 +1,7 @@
1
+ import { DaffProductFilterRequest, DaffProductFilter, DaffProductFilterToggleRequest } from '../../models/public_api';
2
+ /**
3
+ * Ensures that the types of the filter and the filter request match.
4
+ *
5
+ * @throws {@link DaffProductFilterRequestTypeMismatch} if the types do not match.
6
+ */
7
+ export declare const daffProductValidateFilterRequestTypeMatch: (request: DaffProductFilterRequest | DaffProductFilterToggleRequest, filter: DaffProductFilter) => void;
@@ -0,0 +1,5 @@
1
+ import { DaffProductCollectionMetadata, DaffProductCollectionRequest } from '../../models/public_api';
2
+ /**
3
+ * Builds a {@link DaffProductCollectionRequest} from {@link DaffProductCollectionMetadata}.
4
+ */
5
+ export declare const daffProductCollectionBuildRequestFromMetadata: (metadata: DaffProductCollectionMetadata) => Partial<DaffProductCollectionRequest>;
@@ -0,0 +1,7 @@
1
+ import { DaffPriceRange } from '../models/public_api';
2
+ /**
3
+ * Returns whether a DaffPriceRange has a discount.
4
+ *
5
+ * @param priceRange a DaffPriceRange
6
+ */
7
+ export declare const productPriceRangeHasDiscount: (priceRange: DaffPriceRange) => boolean;
@@ -0,0 +1,7 @@
1
+ import { DaffPriceRange } from '../models/public_api';
2
+ /**
3
+ * Returns whether the min and max prices of a DaffPriceRange are different.
4
+ *
5
+ * @param priceRange a DaffPriceRange
6
+ */
7
+ export declare const productPriceRangeHasPriceRange: (priceRange: DaffPriceRange) => boolean;
@@ -0,0 +1,3 @@
1
+ export { daffProductCollectionBuildRequestFromMetadata } from './collection/build-request';
2
+ export { productPriceRangeHasDiscount } from './has-discount';
3
+ export { productPriceRangeHasPriceRange } from './has-price-range';
@@ -0,0 +1,14 @@
1
+ import { DaffCollection } from '@daffodil/core';
2
+ import { DaffProduct } from '../product';
3
+ import { DaffProductCollectionMetadata } from './metadata.interface';
4
+ /**
5
+ * A product collection.
6
+ *
7
+ * @inheritdoc
8
+ */
9
+ export interface DaffProductCollection extends DaffCollection<DaffProduct> {
10
+ /**
11
+ * The metadata for this product collection.
12
+ */
13
+ metadata: DaffProductCollectionMetadata;
14
+ }
@@ -0,0 +1,8 @@
1
+ import { DaffCollectionMetadata } from '@daffodil/core';
2
+ import { DaffProductFilterable } from '../filters/public_api';
3
+ /**
4
+ * The `DaffProductCollectionMetadata` describes the state of an abstract collection of products.
5
+ * It supports filtering, sorting, and pagination.
6
+ */
7
+ export interface DaffProductCollectionMetadata extends DaffCollectionMetadata, DaffProductFilterable {
8
+ }
@@ -0,0 +1,3 @@
1
+ export { DaffProductCollectionMetadata } from './metadata.interface';
2
+ export { DaffProductCollection } from './collection.interface';
3
+ export { DaffProductCollectionRequest } from './request.interface';
@@ -0,0 +1,8 @@
1
+ import { DaffCollectionRequest } from '@daffodil/core';
2
+ import { DaffProductFilterRequest } from '../filters/public_api';
3
+ export interface DaffProductCollectionRequest extends DaffCollectionRequest {
4
+ /**
5
+ * The properties by which to filter the items of the product collection being requested.
6
+ */
7
+ filterRequests?: DaffProductFilterRequest[];
8
+ }
@@ -0,0 +1,24 @@
1
+ import { DaffProductFilterOptionBase } from './filter-option-base';
2
+ import { DaffProductFilterType } from './type/filter-type';
3
+ /**
4
+ * The base type of a product filter.
5
+ */
6
+ export interface DaffProductFilterBase {
7
+ /**
8
+ * The end-user facing string that explains the filter e.g. "Color".
9
+ */
10
+ label: string;
11
+ /**
12
+ * The name of the filter e.g. "color".
13
+ */
14
+ name: string;
15
+ /**
16
+ * The type of the filter. This is used to determine the specific behavior of the filter.
17
+ */
18
+ type: DaffProductFilterType;
19
+ /**
20
+ * The available options by which to filter a product, e.g. "red", "blue", or "green".
21
+ * The type of options changes per type of filter.
22
+ */
23
+ options: Record<string, DaffProductFilterOptionBase>;
24
+ }
@@ -0,0 +1,9 @@
1
+ /**
2
+ * The base type of a product filter option.
3
+ */
4
+ export interface DaffProductFilterOptionBase {
5
+ /**
6
+ * Whether or not the filter option is applied.
7
+ */
8
+ applied: boolean;
9
+ }
@@ -0,0 +1,6 @@
1
+ import { DaffProductFilter } from './filter';
2
+ /**
3
+ * A given option of a particular filter, e.g. "Blue" is a DaffProductFilterOption
4
+ * of the {@link DaffProductFilter} "Color".
5
+ */
6
+ export declare type DaffProductFilterOption = DaffProductFilter['options'][string];
@@ -0,0 +1,7 @@
1
+ import { DaffProductFilterEqualRequest } from './type/equal/request';
2
+ import { DaffProductFilterRangeNumericRequest } from './type/range-numeric/request';
3
+ /**
4
+ * A DaffProductFilterRequest is used to modify the applied or unapplied state of
5
+ * the options of a {@link DaffProductFilter}.
6
+ */
7
+ export declare type DaffProductFilterRequest = DaffProductFilterEqualRequest | DaffProductFilterRangeNumericRequest;
@@ -0,0 +1,6 @@
1
+ import { DaffProductFilterEqualToggleRequest } from './type/equal/toggle-request';
2
+ import { DaffProductFilterRangeNumericToggleRequest } from './type/range-numeric/public_api';
3
+ /**
4
+ * A DaffProductFilterToggleRequest is used to toggle a filter option between an applied and unapplied state.
5
+ */
6
+ export declare type DaffProductFilterToggleRequest = DaffProductFilterEqualToggleRequest | DaffProductFilterRangeNumericToggleRequest;
@@ -0,0 +1,9 @@
1
+ import { DaffProductFilterEqual } from './type/equal/filter';
2
+ import { DaffProductFilterRangeNumeric } from './type/range-numeric/filter';
3
+ /**
4
+ * A single product filter along with its options. For example, a filter may be
5
+ * something like "Color" with options of "Red", "Blue", and "Green".
6
+ *
7
+ * Importantly, filters have "types" which determine their behavior. See {@link DaffProductFilterType} for a complete list.
8
+ */
9
+ export declare type DaffProductFilter = DaffProductFilterRangeNumeric | DaffProductFilterEqual;
@@ -0,0 +1,10 @@
1
+ import { DaffProductFilter } from './filter';
2
+ /**
3
+ * Describes an object that allows a specific product to be filterable.
4
+ */
5
+ export interface DaffProductFilterable {
6
+ /**
7
+ * The filters available on the product.
8
+ */
9
+ filters: Record<DaffProductFilter['name'], DaffProductFilter>;
10
+ }
@@ -0,0 +1,11 @@
1
+ export { DaffProductFilterBase } from './filter-base';
2
+ export { DaffProductFilterOptionBase } from './filter-option-base';
3
+ export { DaffProductFilter } from './filter';
4
+ export { DaffProductFilterOption } from './filter-option';
5
+ export { DaffProductFilterRequest } from './filter-request';
6
+ export { DaffProductFilterToggleRequest } from './filter-toggle-request';
7
+ export { DaffProductFilterable } from './filterable';
8
+ export { DaffProductFilterType } from './type/filter-type';
9
+ export * from './type/equal/public_api';
10
+ export * from './type/range/public_api';
11
+ export * from './type/range-numeric/public_api';
@@ -0,0 +1,24 @@
1
+ import { DaffProductFilterBase } from '../../filter-base';
2
+ import { DaffProductFilterType } from '../filter-type';
3
+ import { DaffProductFilterEqualOption } from './option';
4
+ /**
5
+ * A DaffProductFilterEqual is used to represent filters where
6
+ * there is a set of well-defined dictionary-like values that are exactly
7
+ * matchable. For example, one such filter may be a "Color" filter with options
8
+ * of "Red", "Green", or "Blue" where a user can which filters options from the set
9
+ * to apply.
10
+ *
11
+ * It is important to note that this kind of filter does not imply how combinations of
12
+ * options are applied to collections of items, items that are "Red" AND "Green" vs.
13
+ * items that are "Red" OR "Green".
14
+ */
15
+ export interface DaffProductFilterEqual extends DaffProductFilterBase {
16
+ /**
17
+ * The filter type for this model is always of type "DaffProductFilterType.Equal".
18
+ */
19
+ type: DaffProductFilterType.Equal;
20
+ /**
21
+ * A dictionary of filter options.
22
+ */
23
+ options: Record<DaffProductFilterEqualOption['value'], DaffProductFilterEqualOption>;
24
+ }
@@ -0,0 +1,19 @@
1
+ import { DaffProductFilterOptionBase } from '../../filter-option-base';
2
+ /**
3
+ * The individual options applicable to a filter. Such an option may be something like
4
+ * "Red" or "Green", "Tall" or "Short", etc.
5
+ */
6
+ export interface DaffProductFilterEqualOption extends DaffProductFilterOptionBase {
7
+ /**
8
+ * The id of the filter option.
9
+ */
10
+ value: string;
11
+ /**
12
+ * A label to represent the filter option in the UI.
13
+ */
14
+ label: string;
15
+ /**
16
+ * The number of products that would be returned after application of this filter.
17
+ */
18
+ count: number;
19
+ }
@@ -0,0 +1,4 @@
1
+ export { DaffProductFilterEqual } from './filter';
2
+ export { DaffProductFilterEqualOption } from './option';
3
+ export { DaffProductFilterEqualRequest } from './request';
4
+ export { DaffProductFilterEqualToggleRequest } from './toggle-request';
@@ -0,0 +1,18 @@
1
+ import { DaffProductFilterType } from '../filter-type';
2
+ /**
3
+ * A request used to modify the applied status of a {@link DaffProductFilterEqual}.
4
+ */
5
+ export interface DaffProductFilterEqualRequest {
6
+ /**
7
+ * The type of filter request.
8
+ */
9
+ type: DaffProductFilterType.Equal;
10
+ /**
11
+ * The name of the filter; e.g. color.
12
+ */
13
+ name: string;
14
+ /**
15
+ * An array of filter options; e.g. green and red.
16
+ */
17
+ value: string[];
18
+ }
@@ -0,0 +1,18 @@
1
+ import { DaffProductFilterType } from '../filter-type';
2
+ /**
3
+ * A request used to toggle the applied status of a {@link DaffProductFilterEqual}.
4
+ */
5
+ export interface DaffProductFilterEqualToggleRequest {
6
+ /**
7
+ * The type of filter request.
8
+ */
9
+ type: DaffProductFilterType.Equal;
10
+ /**
11
+ * The name of the filter; e.g. color.
12
+ */
13
+ name: string;
14
+ /**
15
+ * The value of the filter option; e.g. red.
16
+ */
17
+ value: string;
18
+ }
@@ -0,0 +1,7 @@
1
+ /**
2
+ * The known types of filters.
3
+ */
4
+ export declare enum DaffProductFilterType {
5
+ Equal = "equal",
6
+ RangeNumeric = "rangeNumeric"
7
+ }
@@ -0,0 +1,23 @@
1
+ import { DaffProductFilterBase } from '../../filter-base';
2
+ import { DaffProductFilterRangePair } from './pair';
3
+ /**
4
+ * A base type for a range-style filter where there is a continuous distribution
5
+ * that can be selected from. E.g. numbers from 0 through 100, letters from "a"
6
+ * through "z", or dates from "1970-01-01" through "1971-01-01".
7
+ *
8
+ * Note that this is the generic base allowing for stricter type implementations.
9
+ */
10
+ export interface DaffProductFilterRangeBase<T> extends DaffProductFilterBase {
11
+ /**
12
+ * The minimum value for the filter range.
13
+ */
14
+ min: T;
15
+ /**
16
+ * The maximum value for the filter range.
17
+ */
18
+ max: T;
19
+ /**
20
+ * A dictionary of filter range options.
21
+ */
22
+ options: Record<string, DaffProductFilterRangePair<T>>;
23
+ }
@@ -0,0 +1,14 @@
1
+ /**
2
+ * A particular option of a range pair.
3
+ * Holds a value and a label.
4
+ */
5
+ export interface DaffProductFilterRangeOption<T> {
6
+ /**
7
+ * The value for the range option; e.g. "10" for a price range option.
8
+ */
9
+ value: T;
10
+ /**
11
+ * A label to represent the range option in the UI.
12
+ */
13
+ label: string;
14
+ }
@@ -0,0 +1,20 @@
1
+ import { DaffProductFilterOptionBase } from '../../filter-option-base';
2
+ import { DaffProductFilterRangeOption } from './option';
3
+ /**
4
+ * An pair of options of the product range filter.
5
+ * Specifies a pair of min and max values.
6
+ */
7
+ export interface DaffProductFilterRangePair<T> extends DaffProductFilterOptionBase {
8
+ /**
9
+ * The range pair is always set to applied, because a filter range pair exists if it is applied and does not exist if it is not applied.
10
+ */
11
+ applied: true;
12
+ /**
13
+ * The minimum range option of the filter range pair.
14
+ */
15
+ min: DaffProductFilterRangeOption<T>;
16
+ /**
17
+ * The maximum range option of the filter range pair.
18
+ */
19
+ max: DaffProductFilterRangeOption<T>;
20
+ }
@@ -0,0 +1,6 @@
1
+ export { DaffProductFilterRangeBase } from './filter-base';
2
+ export { DaffProductFilterRangeOption } from './option';
3
+ export { DaffProductFilterRangePair } from './pair';
4
+ export { DaffProductFromToFilterSeparator } from './separator';
5
+ export { DaffProductFilterRangeRequestBase } from './request-base';
6
+ export { DaffProductFilterRangeRequestOption } from './request-option';
@@ -0,0 +1,20 @@
1
+ import { DaffProductFilterType } from '../filter-type';
2
+ import { DaffProductFilterRangeRequestOption } from '../range/public_api';
3
+ /**
4
+ * The base interface for range requests. Range requests have a name and a
5
+ * single defining the min and max values between which to filter.
6
+ */
7
+ export interface DaffProductFilterRangeRequestBase<T> {
8
+ /**
9
+ * The type of filter.
10
+ */
11
+ type: DaffProductFilterType;
12
+ /**
13
+ * The name/code of the filter; e.g. price.
14
+ */
15
+ name: string;
16
+ /**
17
+ * The value of the filter range.
18
+ */
19
+ value: DaffProductFilterRangeRequestOption<T>;
20
+ }
@@ -0,0 +1,14 @@
1
+ /**
2
+ * The request option represents the minimum and maximum values that
3
+ * are going to be filtered as defined by a {@link DaffProductFilterRangeRequestBase}.
4
+ */
5
+ export interface DaffProductFilterRangeRequestOption<T> {
6
+ /**
7
+ * The minimum value of the filter range.
8
+ */
9
+ min: T;
10
+ /**
11
+ * The maximum value of the filter range.
12
+ */
13
+ max: T;
14
+ }
@@ -0,0 +1,5 @@
1
+ /**
2
+ * The separator between a range type filter's values
3
+ * e.g. "price": "30-40".
4
+ */
5
+ export declare const DaffProductFromToFilterSeparator = "-";
@@ -0,0 +1,11 @@
1
+ import { DaffProductFilterType } from '../filter-type';
2
+ import { DaffProductFilterRangeBase } from '../range/public_api';
3
+ /**
4
+ * An interface that describes filters that are a range of numbers; i.e. prices.
5
+ */
6
+ export interface DaffProductFilterRangeNumeric extends DaffProductFilterRangeBase<number> {
7
+ /**
8
+ * The type of filter.
9
+ */
10
+ type: DaffProductFilterType.RangeNumeric;
11
+ }
@@ -0,0 +1,3 @@
1
+ export { DaffProductFilterRangeNumeric } from './filter';
2
+ export { DaffProductFilterRangeNumericRequest } from './request';
3
+ export { DaffProductFilterRangeNumericToggleRequest } from './toggle-request';
@@ -0,0 +1,11 @@
1
+ import { DaffProductFilterType } from '../filter-type';
2
+ import { DaffProductFilterRangeRequestBase } from '../range/public_api';
3
+ /**
4
+ * Describes filter range requests for numbers; i.e. prices.
5
+ */
6
+ export interface DaffProductFilterRangeNumericRequest extends DaffProductFilterRangeRequestBase<number> {
7
+ /**
8
+ * The filter type.
9
+ */
10
+ type: DaffProductFilterType.RangeNumeric;
11
+ }
@@ -0,0 +1,12 @@
1
+ import { DaffProductFilterType } from '../filter-type';
2
+ import { DaffProductFilterRangeRequestBase } from '../range/request-base';
3
+ /**
4
+ * An interface to describe toggle requests for ranged numeric filters. For example, the request could be to
5
+ * toggle a price filter for the "10-20" range.
6
+ */
7
+ export interface DaffProductFilterRangeNumericToggleRequest extends DaffProductFilterRangeRequestBase<number> {
8
+ /**
9
+ * The filter type.
10
+ */
11
+ type: DaffProductFilterType.RangeNumeric;
12
+ }
@@ -0,0 +1,5 @@
1
+ export * from './prices';
2
+ export * from './product';
3
+ export * from './product-image';
4
+ export * from './filters/public_api';
5
+ export * from './collection/public_api';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@daffodil/product",
3
- "version": "0.42.4",
3
+ "version": "0.43.0",
4
4
  "description": "Interfaces built for daffodil/state",
5
5
  "repository": {
6
6
  "type": "git",
@@ -18,7 +18,7 @@
18
18
  "peerDependencies": {
19
19
  "@angular/common": "^13.0.0",
20
20
  "@angular/core": "^13.0.0",
21
- "@daffodil/core": "0.42.4",
21
+ "@daffodil/core": "0.43.0",
22
22
  "@ngrx/effects": "^13.0.0",
23
23
  "@ngrx/entity": "^13.0.0",
24
24
  "@ngrx/store": "^13.0.0",
@@ -26,7 +26,7 @@
26
26
  },
27
27
  "optionalDependencies": {
28
28
  "@apollo/client": "^3.0.0",
29
- "@daffodil/driver": "0.42.4",
29
+ "@daffodil/driver": "0.43.0",
30
30
  "angular-in-memory-web-api": "^0.13.0",
31
31
  "apollo-angular": "^3.0.1",
32
32
  "@faker-js/faker": "^5.5.3"
package/public_api.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- export * from './models/prices';
2
- export * from './models/product';
3
- export * from './models/product-image';
4
- export * from './helpers';
1
+ export * from './models/public_api';
2
+ export * from './filters/public_api';
3
+ export * from './errors/public_api';
4
+ export * from './helpers/public_api';
5
5
  export * from './injection-tokens/public_api';
@@ -0,0 +1,7 @@
1
+ import { DaffBase64Service } from '@daffodil/core';
2
+ import { DaffProductRoutingConfig } from './interface';
3
+ export declare const DAFF_PRODUCT_ROUTING_QUERY_PARAM_REQUEST_MAP: DaffProductRoutingConfig['params'];
4
+ /**
5
+ * The default configuration for the {@link DaffProductRoutingConfig}.
6
+ */
7
+ export declare const daffProductRoutingConfigDefaultFactory: (base64: DaffBase64Service) => DaffProductRoutingConfig;
@@ -0,0 +1,18 @@
1
+ import { DaffProductCollectionRequestQueryParams, DaffProductCollectionRequestQueryParamTransforms } from '../models/public_api';
2
+ /**
3
+ * An interface for providing `@daffodil/product/routing` with necessary config values.
4
+ */
5
+ export interface DaffProductRoutingConfig {
6
+ /**
7
+ * The query params transforms for each product collection request field.
8
+ *
9
+ * See {@link DaffProductCollectionRequestQueryParamTransforms}.
10
+ */
11
+ transforms?: DaffProductCollectionRequestQueryParamTransforms;
12
+ /**
13
+ * The mapping of query param fields.
14
+ *
15
+ * See {@link DaffProductCollectionRequestQueryParams}.
16
+ */
17
+ params?: DaffProductCollectionRequestQueryParams;
18
+ }
@@ -0,0 +1,3 @@
1
+ export { daffProductRoutingConfigDefaultFactory, DAFF_PRODUCT_ROUTING_QUERY_PARAM_REQUEST_MAP, } from './default';
2
+ export { DaffProductRoutingConfig } from './interface';
3
+ export { DAFF_PRODUCT_ROUTING_CONFIG } from './token';
@@ -0,0 +1,6 @@
1
+ import { InjectionToken } from '@angular/core';
2
+ import { DaffProductRoutingConfig } from './interface';
3
+ /**
4
+ * The token used to provide @daffodil/product/routing config data.
5
+ */
6
+ export declare const DAFF_PRODUCT_ROUTING_CONFIG: InjectionToken<DaffProductRoutingConfig>;
@@ -0,0 +1,5 @@
1
+ import { DaffProductCollectionRequest } from '@daffodil/product';
2
+ /**
3
+ * A list of request fields that can be transformed to and from query params.
4
+ */
5
+ export declare const DAFF_PRODUCT_COLLECTION_REQUEST_FIELDS: (keyof DaffProductCollectionRequest)[];
@@ -0,0 +1 @@
1
+ export { DAFF_PRODUCT_COLLECTION_REQUEST_FIELDS } from './collection-request-fields';
@@ -0,0 +1,20 @@
1
+ import { ActivatedRoute, Router } from '@angular/router';
2
+ import { Actions } from '@ngrx/effects';
3
+ import { DaffProductCollectionFacadeInterface } from '@daffodil/product/state';
4
+ import { DaffProductGetQueryParamsFromRequest } from '../services/public_api';
5
+ /**
6
+ * An abstract class that provides an effect for modifying the browser URL.
7
+ */
8
+ export declare abstract class DaffProductRoutingCollectionEffects {
9
+ private actions$;
10
+ private router;
11
+ private actionTypes;
12
+ private facade;
13
+ private getQueryParams;
14
+ private route;
15
+ constructor(actions$: Actions, router: Router, actionTypes: string[], facade: DaffProductCollectionFacadeInterface, getQueryParams: DaffProductGetQueryParamsFromRequest, route: ActivatedRoute);
16
+ /**
17
+ * Updates the URL according to the product collection request in state.
18
+ */
19
+ update$: import("rxjs").Observable<never> & import("@ngrx/effects").CreateEffectMetadata;
20
+ }
@@ -0,0 +1 @@
1
+ export { DaffProductRoutingCollectionEffects } from './collection.effects';
@@ -0,0 +1,22 @@
1
+ import { DaffProductCollectionRequest } from '@daffodil/product';
2
+ declare type DaffProductCollectionRequestValue = DaffProductCollectionRequest[keyof DaffProductCollectionRequest];
3
+ /**
4
+ * Transforms for storing and retrieving {@link DaffProductCollectionRequest} values in a route's query params.
5
+ */
6
+ export interface DaffProductCollectionRequestQueryParamTransform<T extends DaffProductCollectionRequestValue = DaffProductCollectionRequestValue> {
7
+ /**
8
+ * A function that is given the value of a query param and
9
+ * returns the value that will be set to the product collection request.
10
+ */
11
+ request?: (queryParam: string) => T;
12
+ /**
13
+ * A function that is given the value of a product collection request field and
14
+ * returns the value that will be set to the query params.
15
+ */
16
+ queryParam?: (requestValue: T) => string;
17
+ }
18
+ /**
19
+ * A collection of optional {@link DaffProductCollectionRequestQueryParamTransform}s.
20
+ */
21
+ export declare type DaffProductCollectionRequestQueryParamTransforms = Partial<Record<keyof DaffProductCollectionRequest, DaffProductCollectionRequestQueryParamTransform>>;
22
+ export {};
@@ -0,0 +1,8 @@
1
+ import { DaffProductCollectionRequest } from '@daffodil/product';
2
+ /**
3
+ * An object containing a mapping of a {@link DaffProductCollectionRequest} field to a query param name.
4
+ * Setting a value for one of these fields will cause a resolver that operates on a product collection
5
+ * to include the value of that specified query param after transforming it according to {@link DaffProductCollectionRequestQueryParamTransforms}.
6
+ * Omitting a value for a field will disable using a query param for the request value.
7
+ */
8
+ export declare type DaffProductCollectionRequestQueryParams = Partial<Record<keyof DaffProductCollectionRequest, string>>;
@@ -0,0 +1,2 @@
1
+ export { DaffProductCollectionRequestQueryParamTransform, DaffProductCollectionRequestQueryParamTransforms, } from './collection-request-query-param-transforms.interface';
2
+ export { DaffProductCollectionRequestQueryParams } from './collection-request-query-params.interface';
@@ -0,0 +1,9 @@
1
+ import { ModuleWithProviders } from '@angular/core';
2
+ import { DaffProductRoutingConfig } from './config/public_api';
3
+ import * as i0 from "@angular/core";
4
+ export declare class DaffProductRoutingModule {
5
+ static withConfig(config?: DaffProductRoutingConfig): ModuleWithProviders<DaffProductRoutingModule>;
6
+ static ɵfac: i0.ɵɵFactoryDeclaration<DaffProductRoutingModule, never>;
7
+ static ɵmod: i0.ɵɵNgModuleDeclaration<DaffProductRoutingModule, never, never, never>;
8
+ static ɵinj: i0.ɵɵInjectorDeclaration<DaffProductRoutingModule>;
9
+ }
@@ -1 +1,7 @@
1
1
  export * from './resolvers/public_api';
2
+ export * from './config/public_api';
3
+ export * from './services/public_api';
4
+ export * from './models/public_api';
5
+ export * from './constants/public_api';
6
+ export * from './effects/public_api';
7
+ export * from './module';