@etohq/utils 2.0.1 → 2.0.5

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 (512) hide show
  1. package/dist/analytics/index.d.ts +0 -18
  2. package/dist/analytics/index.d.ts.map +1 -1
  3. package/dist/analytics/index.js +0 -18
  4. package/dist/analytics/index.js.map +1 -1
  5. package/dist/approval/evaluate.d.ts +69 -0
  6. package/dist/approval/evaluate.d.ts.map +1 -0
  7. package/dist/approval/evaluate.js +90 -0
  8. package/dist/approval/evaluate.js.map +1 -0
  9. package/dist/approval/index.d.ts +2 -0
  10. package/dist/approval/index.d.ts.map +1 -0
  11. package/dist/{access-link → approval}/index.js +1 -10
  12. package/dist/approval/index.js.map +1 -0
  13. package/dist/bundles.d.ts +1 -1
  14. package/dist/bundles.d.ts.map +1 -1
  15. package/dist/bundles.js +2 -2
  16. package/dist/bundles.js.map +1 -1
  17. package/dist/caching/index.d.ts.map +1 -1
  18. package/dist/caching/index.js +3 -1
  19. package/dist/caching/index.js.map +1 -1
  20. package/dist/common/api-error.d.ts.map +1 -1
  21. package/dist/common/api-error.js.map +1 -1
  22. package/dist/common/big-number.d.ts.map +1 -1
  23. package/dist/common/big-number.js +1 -1
  24. package/dist/common/big-number.js.map +1 -1
  25. package/dist/common/build-regexp-if-valid.d.ts.map +1 -1
  26. package/dist/common/build-regexp-if-valid.js +4 -2
  27. package/dist/common/build-regexp-if-valid.js.map +1 -1
  28. package/dist/common/constants.d.ts.map +1 -1
  29. package/dist/common/constants.js +262 -22
  30. package/dist/common/constants.js.map +1 -1
  31. package/dist/common/create-psql-index-helper.d.ts.map +1 -1
  32. package/dist/common/create-psql-index-helper.js +7 -0
  33. package/dist/common/create-psql-index-helper.js.map +1 -1
  34. package/dist/common/define-config.d.ts.map +1 -1
  35. package/dist/common/define-config.js +2 -1
  36. package/dist/common/define-config.js.map +1 -1
  37. package/dist/common/domains.d.ts.map +1 -1
  38. package/dist/common/domains.js +7 -3
  39. package/dist/common/domains.js.map +1 -1
  40. package/dist/common/env-editor.js +1 -1
  41. package/dist/common/env-editor.js.map +1 -1
  42. package/dist/common/eto-container.js +1 -1
  43. package/dist/common/eto-container.js.map +1 -1
  44. package/dist/common/flatten-object-to-key-value-pairs.d.ts.map +1 -1
  45. package/dist/common/flatten-object-to-key-value-pairs.js +8 -4
  46. package/dist/common/flatten-object-to-key-value-pairs.js.map +1 -1
  47. package/dist/common/get-resolved-plugins.d.ts.map +1 -1
  48. package/dist/common/get-resolved-plugins.js.map +1 -1
  49. package/dist/common/get-smallest-unit.js +1 -1
  50. package/dist/common/get-smallest-unit.js.map +1 -1
  51. package/dist/common/is-email.d.ts.map +1 -1
  52. package/dist/common/is-email.js.map +1 -1
  53. package/dist/common/load-env.d.ts.map +1 -1
  54. package/dist/common/load-env.js +3 -1
  55. package/dist/common/load-env.js.map +1 -1
  56. package/dist/common/math.d.ts.map +1 -1
  57. package/dist/common/math.js +9 -7
  58. package/dist/common/math.js.map +1 -1
  59. package/dist/common/merge-plugin-modules.d.ts.map +1 -1
  60. package/dist/common/merge-plugin-modules.js +1 -3
  61. package/dist/common/merge-plugin-modules.js.map +1 -1
  62. package/dist/common/normalize-import-path-with-source.js +1 -1
  63. package/dist/common/normalize-import-path-with-source.js.map +1 -1
  64. package/dist/common/parse-stringify-if-necessary.js +1 -1
  65. package/dist/common/parse-stringify-if-necessary.js.map +1 -1
  66. package/dist/common/read-dir-recursive.d.ts.map +1 -1
  67. package/dist/common/read-dir-recursive.js +6 -1
  68. package/dist/common/read-dir-recursive.js.map +1 -1
  69. package/dist/common/reserved-slugs.d.ts.map +1 -1
  70. package/dist/common/reserved-slugs.js.map +1 -1
  71. package/dist/core-flows/events.d.ts.map +1 -1
  72. package/dist/core-flows/events.js.map +1 -1
  73. package/dist/dal/mikro-orm/db-error-mapper.js +1 -1
  74. package/dist/dal/mikro-orm/db-error-mapper.js.map +1 -1
  75. package/dist/dal/mikro-orm/mikro-orm-create-connection.d.ts.map +1 -1
  76. package/dist/dal/mikro-orm/mikro-orm-create-connection.js +26 -2
  77. package/dist/dal/mikro-orm/mikro-orm-create-connection.js.map +1 -1
  78. package/dist/dal/mikro-orm/mikro-orm-repository.d.ts.map +1 -1
  79. package/dist/dal/mikro-orm/mikro-orm-repository.js +64 -13
  80. package/dist/dal/mikro-orm/mikro-orm-repository.js.map +1 -1
  81. package/dist/dal/mikro-orm/mikro-orm-serializer-old.d.ts.map +1 -1
  82. package/dist/dal/mikro-orm/mikro-orm-serializer-old.js +4 -3
  83. package/dist/dal/mikro-orm/mikro-orm-serializer-old.js.map +1 -1
  84. package/dist/dal/mikro-orm/mikro-orm-serializer.d.ts.map +1 -1
  85. package/dist/dal/mikro-orm/mikro-orm-serializer.js +42 -21
  86. package/dist/dal/mikro-orm/mikro-orm-serializer.js.map +1 -1
  87. package/dist/dal/mikro-orm/sql-migration-generator.d.ts.map +1 -1
  88. package/dist/dal/mikro-orm/sql-migration-generator.js.map +1 -1
  89. package/dist/dal/mikro-orm/utils.d.ts.map +1 -1
  90. package/dist/dal/mikro-orm/utils.js +6 -3
  91. package/dist/dal/mikro-orm/utils.js.map +1 -1
  92. package/dist/dev-server/handlers/step-handler.d.ts.map +1 -1
  93. package/dist/dev-server/handlers/step-handler.js.map +1 -1
  94. package/dist/dml/entity-builder.d.ts +23 -2
  95. package/dist/dml/entity-builder.d.ts.map +1 -1
  96. package/dist/dml/entity-builder.js +29 -6
  97. package/dist/dml/entity-builder.js.map +1 -1
  98. package/dist/dml/entity.d.ts +16 -1
  99. package/dist/dml/entity.d.ts.map +1 -1
  100. package/dist/dml/entity.js +31 -2
  101. package/dist/dml/entity.js.map +1 -1
  102. package/dist/dml/errors.d.ts +12 -0
  103. package/dist/dml/errors.d.ts.map +1 -1
  104. package/dist/dml/errors.js +21 -1
  105. package/dist/dml/errors.js.map +1 -1
  106. package/dist/dml/helpers/create-graphql.js +2 -2
  107. package/dist/dml/helpers/create-graphql.js.map +1 -1
  108. package/dist/dml/helpers/create-mikro-orm-entity.d.ts.map +1 -1
  109. package/dist/dml/helpers/create-mikro-orm-entity.js +33 -6
  110. package/dist/dml/helpers/create-mikro-orm-entity.js.map +1 -1
  111. package/dist/dml/helpers/entity-builder/define-property.d.ts +0 -3
  112. package/dist/dml/helpers/entity-builder/define-property.d.ts.map +1 -1
  113. package/dist/dml/helpers/entity-builder/define-property.js +80 -25
  114. package/dist/dml/helpers/entity-builder/define-property.js.map +1 -1
  115. package/dist/dml/helpers/entity-builder/define-relationship.js +2 -2
  116. package/dist/dml/helpers/entity-builder/define-relationship.js.map +1 -1
  117. package/dist/dml/helpers/mikro-orm/apply-indexes.d.ts.map +1 -1
  118. package/dist/dml/helpers/mikro-orm/apply-indexes.js.map +1 -1
  119. package/dist/dml/helpers/mikro-orm/custom-type/geo-json-geometry.d.ts.map +1 -1
  120. package/dist/dml/helpers/mikro-orm/custom-type/geo-json-geometry.js.map +1 -1
  121. package/dist/dml/properties/base.d.ts +37 -0
  122. package/dist/dml/properties/base.d.ts.map +1 -1
  123. package/dist/dml/properties/base.js +55 -2
  124. package/dist/dml/properties/base.js.map +1 -1
  125. package/dist/dml/properties/computed.d.ts.map +1 -1
  126. package/dist/dml/properties/computed.js.map +1 -1
  127. package/dist/dml/properties/enum.d.ts +9 -1
  128. package/dist/dml/properties/enum.d.ts.map +1 -1
  129. package/dist/dml/properties/enum.js +3 -3
  130. package/dist/dml/properties/enum.js.map +1 -1
  131. package/dist/dml/properties/id.d.ts +7 -0
  132. package/dist/dml/properties/id.d.ts.map +1 -1
  133. package/dist/dml/properties/id.js +1 -0
  134. package/dist/dml/properties/id.js.map +1 -1
  135. package/dist/dml/properties/index.d.ts +1 -0
  136. package/dist/dml/properties/index.d.ts.map +1 -1
  137. package/dist/dml/properties/index.js +1 -0
  138. package/dist/dml/properties/index.js.map +1 -1
  139. package/dist/dml/properties/json.d.ts +4 -0
  140. package/dist/dml/properties/json.d.ts.map +1 -1
  141. package/dist/dml/properties/nullable.d.ts.map +1 -1
  142. package/dist/dml/properties/nullable.js.map +1 -1
  143. package/dist/dml/properties/primary-key.d.ts.map +1 -1
  144. package/dist/dml/properties/primary-key.js.map +1 -1
  145. package/dist/dml/properties/tsvector.d.ts +30 -0
  146. package/dist/dml/properties/tsvector.d.ts.map +1 -0
  147. package/dist/dml/properties/tsvector.js +40 -0
  148. package/dist/dml/properties/tsvector.js.map +1 -0
  149. package/dist/dml/relations/base.d.ts.map +1 -1
  150. package/dist/dml/relations/base.js.map +1 -1
  151. package/dist/dml/relations/nullable.d.ts.map +1 -1
  152. package/dist/dml/relations/nullable.js.map +1 -1
  153. package/dist/event-bus/message-aggregator.d.ts.map +1 -1
  154. package/dist/event-bus/message-aggregator.js +2 -1
  155. package/dist/event-bus/message-aggregator.js.map +1 -1
  156. package/dist/file/abstract-file-provider.d.ts.map +1 -1
  157. package/dist/file/abstract-file-provider.js.map +1 -1
  158. package/dist/graphql/index.d.ts +10 -1
  159. package/dist/graphql/index.d.ts.map +1 -1
  160. package/dist/graphql/index.js +17 -3
  161. package/dist/graphql/index.js.map +1 -1
  162. package/dist/index.d.ts +2 -1
  163. package/dist/index.d.ts.map +1 -1
  164. package/dist/index.js +2 -1
  165. package/dist/index.js.map +1 -1
  166. package/dist/migrations/index.d.ts +0 -3
  167. package/dist/migrations/index.d.ts.map +1 -1
  168. package/dist/migrations/index.js +38 -3
  169. package/dist/migrations/index.js.map +1 -1
  170. package/dist/modules-sdk/build-query.js +1 -1
  171. package/dist/modules-sdk/build-query.js.map +1 -1
  172. package/dist/modules-sdk/create-pg-connection.d.ts.map +1 -1
  173. package/dist/modules-sdk/create-pg-connection.js +62 -0
  174. package/dist/modules-sdk/create-pg-connection.js.map +1 -1
  175. package/dist/modules-sdk/define-link.js +2 -2
  176. package/dist/modules-sdk/define-link.js.map +1 -1
  177. package/dist/modules-sdk/definition.d.ts +19 -7
  178. package/dist/modules-sdk/definition.d.ts.map +1 -1
  179. package/dist/modules-sdk/definition.js +18 -6
  180. package/dist/modules-sdk/definition.js.map +1 -1
  181. package/dist/modules-sdk/eto-internal-service.d.ts.map +1 -1
  182. package/dist/modules-sdk/eto-internal-service.js.map +1 -1
  183. package/dist/modules-sdk/eto-service.d.ts.map +1 -1
  184. package/dist/modules-sdk/eto-service.js +10 -5
  185. package/dist/modules-sdk/eto-service.js.map +1 -1
  186. package/dist/modules-sdk/joiner-config-builder.d.ts.map +1 -1
  187. package/dist/modules-sdk/joiner-config-builder.js +3 -1
  188. package/dist/modules-sdk/joiner-config-builder.js.map +1 -1
  189. package/dist/modules-sdk/load-module-database-config.d.ts.map +1 -1
  190. package/dist/modules-sdk/load-module-database-config.js +6 -3
  191. package/dist/modules-sdk/load-module-database-config.js.map +1 -1
  192. package/dist/modules-sdk/loaders/load-models.d.ts.map +1 -1
  193. package/dist/modules-sdk/loaders/load-models.js +6 -2
  194. package/dist/modules-sdk/loaders/load-models.js.map +1 -1
  195. package/dist/modules-sdk/loaders/mikro-orm-connection-loader.js +12 -0
  196. package/dist/modules-sdk/loaders/mikro-orm-connection-loader.js.map +1 -1
  197. package/dist/modules-sdk/migration-scripts/service-migration-generate.js +1 -1
  198. package/dist/modules-sdk/migration-scripts/service-migration-generate.js.map +1 -1
  199. package/dist/modules-sdk/mikro-orm-cli-config-builder.d.ts.map +1 -1
  200. package/dist/modules-sdk/mikro-orm-cli-config-builder.js +7 -0
  201. package/dist/modules-sdk/mikro-orm-cli-config-builder.js.map +1 -1
  202. package/dist/modules-sdk/module.d.ts +12 -1
  203. package/dist/modules-sdk/module.d.ts.map +1 -1
  204. package/dist/modules-sdk/module.js +18 -0
  205. package/dist/modules-sdk/module.js.map +1 -1
  206. package/dist/modules-sdk/modules-to-container-types.js +1 -1
  207. package/dist/modules-sdk/modules-to-container-types.js.map +1 -1
  208. package/dist/modules-sdk/spatial-query-processor.js +1 -1
  209. package/dist/modules-sdk/types/eto-service.d.ts.map +1 -1
  210. package/dist/outbox/emit.d.ts +12 -0
  211. package/dist/outbox/emit.d.ts.map +1 -0
  212. package/dist/outbox/emit.js +26 -0
  213. package/dist/outbox/emit.js.map +1 -0
  214. package/dist/outbox/index.d.ts +5 -0
  215. package/dist/outbox/index.d.ts.map +1 -0
  216. package/dist/outbox/index.js +21 -0
  217. package/dist/outbox/index.js.map +1 -0
  218. package/dist/outbox/model.d.ts +33 -0
  219. package/dist/outbox/model.d.ts.map +1 -0
  220. package/dist/outbox/model.js +35 -0
  221. package/dist/outbox/model.js.map +1 -0
  222. package/dist/outbox/relay.d.ts +16 -0
  223. package/dist/outbox/relay.d.ts.map +1 -0
  224. package/dist/outbox/relay.js +26 -0
  225. package/dist/outbox/relay.js.map +1 -0
  226. package/dist/outbox/types.d.ts +31 -0
  227. package/dist/outbox/types.d.ts.map +1 -0
  228. package/dist/outbox/types.js +3 -0
  229. package/dist/outbox/types.js.map +1 -0
  230. package/dist/permissions/ability.d.ts +4 -4
  231. package/dist/permissions/ability.d.ts.map +1 -1
  232. package/dist/permissions/ability.js +26 -16
  233. package/dist/permissions/ability.js.map +1 -1
  234. package/dist/permissions/context-builder.d.ts +1 -1
  235. package/dist/permissions/context-builder.d.ts.map +1 -1
  236. package/dist/permissions/context-builder.js +3 -3
  237. package/dist/permissions/context-builder.js.map +1 -1
  238. package/dist/schema/base-property.d.ts +25 -0
  239. package/dist/schema/base-property.d.ts.map +1 -0
  240. package/dist/schema/base-property.js +25 -0
  241. package/dist/schema/base-property.js.map +1 -0
  242. package/dist/schema/index.d.ts +2 -0
  243. package/dist/schema/index.d.ts.map +1 -0
  244. package/dist/schema/index.js +18 -0
  245. package/dist/schema/index.js.map +1 -0
  246. package/dist/search/abstract-search-provider.d.ts +345 -0
  247. package/dist/search/abstract-search-provider.d.ts.map +1 -0
  248. package/dist/search/abstract-search-provider.js +345 -0
  249. package/dist/search/abstract-search-provider.js.map +1 -0
  250. package/dist/search/define-search-index.d.ts +12 -0
  251. package/dist/search/define-search-index.d.ts.map +1 -0
  252. package/dist/search/define-search-index.js +47 -0
  253. package/dist/search/define-search-index.js.map +1 -0
  254. package/dist/search/definition-helpers.d.ts +112 -0
  255. package/dist/search/definition-helpers.d.ts.map +1 -0
  256. package/dist/search/definition-helpers.js +196 -0
  257. package/dist/search/definition-helpers.js.map +1 -0
  258. package/dist/search/document-utils.d.ts +29 -0
  259. package/dist/search/document-utils.d.ts.map +1 -0
  260. package/dist/search/document-utils.js +134 -0
  261. package/dist/search/document-utils.js.map +1 -0
  262. package/dist/search/index.d.ts +6 -4
  263. package/dist/search/index.d.ts.map +1 -1
  264. package/dist/search/index.js +6 -4
  265. package/dist/search/index.js.map +1 -1
  266. package/dist/search/model/index-builder.d.ts +61 -0
  267. package/dist/search/model/index-builder.d.ts.map +1 -0
  268. package/dist/search/model/index-builder.js +84 -0
  269. package/dist/search/model/index-builder.js.map +1 -0
  270. package/dist/search/model/index.d.ts +3 -0
  271. package/dist/search/model/index.d.ts.map +1 -0
  272. package/dist/search/model/index.js +9 -0
  273. package/dist/search/model/index.js.map +1 -0
  274. package/dist/search/model/properties/base.d.ts +52 -0
  275. package/dist/search/model/properties/base.d.ts.map +1 -0
  276. package/dist/search/model/properties/base.js +139 -0
  277. package/dist/search/model/properties/base.js.map +1 -0
  278. package/dist/search/model/properties/boolean.d.ts +8 -0
  279. package/dist/search/model/properties/boolean.d.ts.map +1 -0
  280. package/dist/search/model/properties/boolean.js +14 -0
  281. package/dist/search/model/properties/boolean.js.map +1 -0
  282. package/dist/search/model/properties/date.d.ts +8 -0
  283. package/dist/search/model/properties/date.d.ts.map +1 -0
  284. package/dist/search/model/properties/date.js +16 -0
  285. package/dist/search/model/properties/date.js.map +1 -0
  286. package/dist/search/model/properties/float.d.ts +8 -0
  287. package/dist/search/model/properties/float.d.ts.map +1 -0
  288. package/dist/search/model/properties/float.js +14 -0
  289. package/dist/search/model/properties/float.js.map +1 -0
  290. package/dist/search/model/properties/geo.d.ts +11 -0
  291. package/dist/search/model/properties/geo.d.ts.map +1 -0
  292. package/dist/search/model/properties/geo.js +14 -0
  293. package/dist/search/model/properties/geo.js.map +1 -0
  294. package/dist/search/model/properties/index.d.ts +11 -0
  295. package/dist/search/model/properties/index.d.ts.map +1 -0
  296. package/dist/search/model/properties/index.js +27 -0
  297. package/dist/search/model/properties/index.js.map +1 -0
  298. package/dist/search/model/properties/integer.d.ts +8 -0
  299. package/dist/search/model/properties/integer.d.ts.map +1 -0
  300. package/dist/search/model/properties/integer.js +14 -0
  301. package/dist/search/model/properties/integer.js.map +1 -0
  302. package/dist/search/model/properties/keyword.d.ts +8 -0
  303. package/dist/search/model/properties/keyword.d.ts.map +1 -0
  304. package/dist/search/model/properties/keyword.js +14 -0
  305. package/dist/search/model/properties/keyword.js.map +1 -0
  306. package/dist/search/model/properties/object.d.ts +12 -0
  307. package/dist/search/model/properties/object.d.ts.map +1 -0
  308. package/dist/search/model/properties/object.js +38 -0
  309. package/dist/search/model/properties/object.js.map +1 -0
  310. package/dist/search/model/properties/text.d.ts +8 -0
  311. package/dist/search/model/properties/text.d.ts.map +1 -0
  312. package/dist/search/model/properties/text.js +14 -0
  313. package/dist/search/model/properties/text.js.map +1 -0
  314. package/dist/search/model/properties/vector.d.ts +18 -0
  315. package/dist/search/model/properties/vector.d.ts.map +1 -0
  316. package/dist/search/model/properties/vector.js +51 -0
  317. package/dist/search/model/properties/vector.js.map +1 -0
  318. package/dist/search/model/search-fields-schema.d.ts +22 -0
  319. package/dist/search/model/search-fields-schema.d.ts.map +1 -0
  320. package/dist/search/model/search-fields-schema.js +70 -0
  321. package/dist/search/model/search-fields-schema.js.map +1 -0
  322. package/dist/search/search-scope.d.ts +44 -0
  323. package/dist/search/search-scope.d.ts.map +1 -0
  324. package/dist/search/search-scope.js +111 -0
  325. package/dist/search/search-scope.js.map +1 -0
  326. package/dist/{search → search-legacy}/abstract-service.d.ts +55 -18
  327. package/dist/search-legacy/abstract-service.d.ts.map +1 -0
  328. package/dist/{search → search-legacy}/abstract-service.js +59 -11
  329. package/dist/search-legacy/abstract-service.js.map +1 -0
  330. package/dist/search-legacy/index-types.d.ts.map +1 -0
  331. package/dist/search-legacy/index-types.js.map +1 -0
  332. package/dist/search-legacy/index.d.ts +6 -0
  333. package/dist/search-legacy/index.d.ts.map +1 -0
  334. package/dist/search-legacy/index.js +22 -0
  335. package/dist/search-legacy/index.js.map +1 -0
  336. package/dist/search-legacy/search-relations.d.ts.map +1 -0
  337. package/dist/search-legacy/search-relations.js.map +1 -0
  338. package/dist/search-legacy/types.d.ts +129 -0
  339. package/dist/search-legacy/types.d.ts.map +1 -0
  340. package/dist/search-legacy/types.js +10 -0
  341. package/dist/search-legacy/types.js.map +1 -0
  342. package/dist/search-legacy/variant-keys.d.ts.map +1 -0
  343. package/dist/search-legacy/variant-keys.js.map +1 -0
  344. package/dist/totals/big-number.d.ts.map +1 -1
  345. package/dist/totals/big-number.js +1 -1
  346. package/dist/totals/big-number.js.map +1 -1
  347. package/dist/totals/index.d.ts +1 -0
  348. package/dist/totals/index.d.ts.map +1 -1
  349. package/dist/totals/index.js +1 -0
  350. package/dist/totals/index.js.map +1 -1
  351. package/dist/totals/normalize-big-numbers.d.ts +14 -0
  352. package/dist/totals/normalize-big-numbers.d.ts.map +1 -0
  353. package/dist/totals/normalize-big-numbers.js +71 -0
  354. package/dist/totals/normalize-big-numbers.js.map +1 -0
  355. package/dist/translations/apply-translations-to-tax-lines.d.ts.map +1 -1
  356. package/dist/translations/apply-translations-to-tax-lines.js +1 -1
  357. package/dist/translations/apply-translations-to-tax-lines.js.map +1 -1
  358. package/dist/tsconfig.tsbuildinfo +1 -1
  359. package/package.json +15 -5
  360. package/dist/access-link/case-sensitivity.d.ts +0 -14
  361. package/dist/access-link/case-sensitivity.d.ts.map +0 -1
  362. package/dist/access-link/case-sensitivity.js +0 -57
  363. package/dist/access-link/case-sensitivity.js.map +0 -1
  364. package/dist/access-link/check-if-key-exists.d.ts +0 -7
  365. package/dist/access-link/check-if-key-exists.d.ts.map +0 -1
  366. package/dist/access-link/check-if-key-exists.js +0 -36
  367. package/dist/access-link/check-if-key-exists.js.map +0 -1
  368. package/dist/access-link/index.d.ts +0 -11
  369. package/dist/access-link/index.d.ts.map +0 -1
  370. package/dist/access-link/index.js.map +0 -1
  371. package/dist/access-link/key-checks.d.ts +0 -12
  372. package/dist/access-link/key-checks.d.ts.map +0 -1
  373. package/dist/access-link/key-checks.js +0 -78
  374. package/dist/access-link/key-checks.js.map +0 -1
  375. package/dist/access-link/link-resolution.d.ts +0 -26
  376. package/dist/access-link/link-resolution.d.ts.map +0 -1
  377. package/dist/access-link/link-resolution.js +0 -111
  378. package/dist/access-link/link-resolution.js.map +0 -1
  379. package/dist/access-link/link-utils.d.ts +0 -23
  380. package/dist/access-link/link-utils.d.ts.map +0 -1
  381. package/dist/access-link/link-utils.js +0 -61
  382. package/dist/access-link/link-utils.js.map +0 -1
  383. package/dist/access-link/process-key.d.ts +0 -5
  384. package/dist/access-link/process-key.d.ts.map +0 -1
  385. package/dist/access-link/process-key.js +0 -58
  386. package/dist/access-link/process-key.js.map +0 -1
  387. package/dist/access-link/process-utils.d.ts +0 -19
  388. package/dist/access-link/process-utils.d.ts.map +0 -1
  389. package/dist/access-link/process-utils.js +0 -52
  390. package/dist/access-link/process-utils.js.map +0 -1
  391. package/dist/access-link/transform-link.d.ts +0 -47
  392. package/dist/access-link/transform-link.d.ts.map +0 -1
  393. package/dist/access-link/transform-link.js +0 -25
  394. package/dist/access-link/transform-link.js.map +0 -1
  395. package/dist/access-link/url-detection.d.ts +0 -10
  396. package/dist/access-link/url-detection.d.ts.map +0 -1
  397. package/dist/access-link/url-detection.js +0 -63
  398. package/dist/access-link/url-detection.js.map +0 -1
  399. package/dist/access-link/validation-utils.d.ts +0 -23
  400. package/dist/access-link/validation-utils.d.ts.map +0 -1
  401. package/dist/access-link/validation-utils.js +0 -57
  402. package/dist/access-link/validation-utils.js.map +0 -1
  403. package/dist/analytics/detect-bot.d.ts +0 -2
  404. package/dist/analytics/detect-bot.d.ts.map +0 -1
  405. package/dist/analytics/detect-bot.js +0 -21
  406. package/dist/analytics/detect-bot.js.map +0 -1
  407. package/dist/analytics/detect-qr.d.ts +0 -2
  408. package/dist/analytics/detect-qr.d.ts.map +0 -1
  409. package/dist/analytics/detect-qr.js +0 -10
  410. package/dist/analytics/detect-qr.js.map +0 -1
  411. package/dist/analytics/get-click-event.d.ts +0 -8
  412. package/dist/analytics/get-click-event.d.ts.map +0 -1
  413. package/dist/analytics/get-click-event.js +0 -24
  414. package/dist/analytics/get-click-event.js.map +0 -1
  415. package/dist/analytics/get-geolocation.d.ts +0 -12
  416. package/dist/analytics/get-geolocation.d.ts.map +0 -1
  417. package/dist/analytics/get-geolocation.js +0 -51
  418. package/dist/analytics/get-geolocation.js.map +0 -1
  419. package/dist/analytics/get-grant-event.d.ts +0 -8
  420. package/dist/analytics/get-grant-event.d.ts.map +0 -1
  421. package/dist/analytics/get-grant-event.js +0 -24
  422. package/dist/analytics/get-grant-event.js.map +0 -1
  423. package/dist/analytics/get-import-error-logs.d.ts +0 -25
  424. package/dist/analytics/get-import-error-logs.d.ts.map +0 -1
  425. package/dist/analytics/get-import-error-logs.js +0 -23
  426. package/dist/analytics/get-import-error-logs.js.map +0 -1
  427. package/dist/analytics/get-lead-events.d.ts +0 -53
  428. package/dist/analytics/get-lead-events.d.ts.map +0 -1
  429. package/dist/analytics/get-lead-events.js +0 -17
  430. package/dist/analytics/get-lead-events.js.map +0 -1
  431. package/dist/analytics/get-webhook-events.d.ts +0 -24
  432. package/dist/analytics/get-webhook-events.d.ts.map +0 -1
  433. package/dist/analytics/get-webhook-events.js +0 -22
  434. package/dist/analytics/get-webhook-events.js.map +0 -1
  435. package/dist/analytics/log-conversion-events.d.ts +0 -25
  436. package/dist/analytics/log-conversion-events.d.ts.map +0 -1
  437. package/dist/analytics/log-conversion-events.js +0 -20
  438. package/dist/analytics/log-conversion-events.js.map +0 -1
  439. package/dist/analytics/log-import-error.d.ts +0 -23
  440. package/dist/analytics/log-import-error.d.ts.map +0 -1
  441. package/dist/analytics/log-import-error.js +0 -18
  442. package/dist/analytics/log-import-error.js.map +0 -1
  443. package/dist/analytics/parse-user-agent.d.ts +0 -13
  444. package/dist/analytics/parse-user-agent.d.ts.map +0 -1
  445. package/dist/analytics/parse-user-agent.js +0 -174
  446. package/dist/analytics/parse-user-agent.js.map +0 -1
  447. package/dist/analytics/record-approval.d.ts +0 -94
  448. package/dist/analytics/record-approval.d.ts.map +0 -1
  449. package/dist/analytics/record-approval.js +0 -32
  450. package/dist/analytics/record-approval.js.map +0 -1
  451. package/dist/analytics/record-click.d.ts +0 -32
  452. package/dist/analytics/record-click.d.ts.map +0 -1
  453. package/dist/analytics/record-click.js +0 -136
  454. package/dist/analytics/record-click.js.map +0 -1
  455. package/dist/analytics/record-lead.d.ts +0 -24
  456. package/dist/analytics/record-lead.d.ts.map +0 -1
  457. package/dist/analytics/record-lead.js +0 -72
  458. package/dist/analytics/record-lead.js.map +0 -1
  459. package/dist/analytics/record-link.d.ts +0 -158
  460. package/dist/analytics/record-link.d.ts.map +0 -1
  461. package/dist/analytics/record-link.js +0 -78
  462. package/dist/analytics/record-link.js.map +0 -1
  463. package/dist/analytics/record-sale.d.ts +0 -69
  464. package/dist/analytics/record-sale.d.ts.map +0 -1
  465. package/dist/analytics/record-sale.js +0 -35
  466. package/dist/analytics/record-sale.js.map +0 -1
  467. package/dist/analytics/record-webhook-event.d.ts +0 -44
  468. package/dist/analytics/record-webhook-event.d.ts.map +0 -1
  469. package/dist/analytics/record-webhook-event.js +0 -22
  470. package/dist/analytics/record-webhook-event.js.map +0 -1
  471. package/dist/analytics/schemas.d.ts +0 -257
  472. package/dist/analytics/schemas.d.ts.map +0 -1
  473. package/dist/analytics/schemas.js +0 -99
  474. package/dist/analytics/schemas.js.map +0 -1
  475. package/dist/analytics/tinybird-client.d.ts +0 -6
  476. package/dist/analytics/tinybird-client.d.ts.map +0 -1
  477. package/dist/analytics/tinybird-client.js +0 -11
  478. package/dist/analytics/tinybird-client.js.map +0 -1
  479. package/dist/common/fetch-with-retry.d.ts +0 -6
  480. package/dist/common/fetch-with-retry.d.ts.map +0 -1
  481. package/dist/common/fetch-with-retry.js +0 -63
  482. package/dist/common/fetch-with-retry.js.map +0 -1
  483. package/dist/common/get-identity-hash.d.ts +0 -2
  484. package/dist/common/get-identity-hash.d.ts.map +0 -1
  485. package/dist/common/get-identity-hash.js +0 -19
  486. package/dist/common/get-identity-hash.js.map +0 -1
  487. package/dist/search/abstract-service.d.ts.map +0 -1
  488. package/dist/search/abstract-service.js.map +0 -1
  489. package/dist/search/index-types.d.ts.map +0 -1
  490. package/dist/search/index-types.js.map +0 -1
  491. package/dist/search/search-relations.d.ts.map +0 -1
  492. package/dist/search/search-relations.js.map +0 -1
  493. package/dist/search/variant-keys.d.ts.map +0 -1
  494. package/dist/search/variant-keys.js.map +0 -1
  495. package/dist/zod/schemas/approvals.d.ts +0 -91
  496. package/dist/zod/schemas/approvals.d.ts.map +0 -1
  497. package/dist/zod/schemas/approvals.js +0 -38
  498. package/dist/zod/schemas/approvals.js.map +0 -1
  499. package/dist/zod/schemas/clicks.d.ts +0 -394
  500. package/dist/zod/schemas/clicks.d.ts.map +0 -1
  501. package/dist/zod/schemas/clicks.js +0 -85
  502. package/dist/zod/schemas/clicks.js.map +0 -1
  503. package/dist/zod/schemas/leads.d.ts +0 -423
  504. package/dist/zod/schemas/leads.d.ts.map +0 -1
  505. package/dist/zod/schemas/leads.js +0 -58
  506. package/dist/zod/schemas/leads.js.map +0 -1
  507. /package/dist/{search → search-legacy}/index-types.d.ts +0 -0
  508. /package/dist/{search → search-legacy}/index-types.js +0 -0
  509. /package/dist/{search → search-legacy}/search-relations.d.ts +0 -0
  510. /package/dist/{search → search-legacy}/search-relations.js +0 -0
  511. /package/dist/{search → search-legacy}/variant-keys.d.ts +0 -0
  512. /package/dist/{search → search-legacy}/variant-keys.js +0 -0
@@ -0,0 +1,70 @@
1
+ "use strict";
2
+ var _a;
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.SearchFieldsSchema = void 0;
5
+ const IsSearchFieldsSchema = Symbol.for("isSearchFieldsSchema");
6
+ /**
7
+ * A fields schema produced by `search.define(...)`. Compiles to plain
8
+ * SearchFieldDefinition records for the Search Module.
9
+ */
10
+ class SearchFieldsSchema {
11
+ constructor(schema) {
12
+ this[_a] = true;
13
+ this.schema = schema;
14
+ }
15
+ static isSearchFieldsSchema(value) {
16
+ return !!value?.[IsSearchFieldsSchema];
17
+ }
18
+ /**
19
+ * Compile the DSL schema into plain SearchFieldDefinition records.
20
+ */
21
+ toFields() {
22
+ const fields = {};
23
+ for (const [fieldName, property] of Object.entries(this.schema)) {
24
+ fields[fieldName] = metadataToFieldDefinition(property.parse(fieldName));
25
+ }
26
+ return fields;
27
+ }
28
+ }
29
+ exports.SearchFieldsSchema = SearchFieldsSchema;
30
+ _a = IsSearchFieldsSchema;
31
+ function metadataToFieldDefinition(metadata) {
32
+ const field = {
33
+ type: metadata.dataType.name,
34
+ };
35
+ if (metadata.array !== undefined) {
36
+ field.array = metadata.array;
37
+ }
38
+ if (metadata.searchable !== undefined) {
39
+ field.searchable = metadata.searchable;
40
+ }
41
+ if (metadata.filterable !== undefined) {
42
+ field.filterable = metadata.filterable;
43
+ }
44
+ if (metadata.sortable !== undefined) {
45
+ field.sortable = metadata.sortable;
46
+ }
47
+ if (metadata.facetable !== undefined) {
48
+ field.facetable = metadata.facetable;
49
+ }
50
+ if (metadata.retrievable !== undefined) {
51
+ field.retrievable = metadata.retrievable;
52
+ }
53
+ if (metadata.dimensions !== undefined) {
54
+ field.dimensions = metadata.dimensions;
55
+ }
56
+ if (metadata.embed !== undefined) {
57
+ field.embed = metadata.embed;
58
+ }
59
+ if (metadata.provider_options !== undefined) {
60
+ field.provider_options = metadata.provider_options;
61
+ }
62
+ if (metadata.fields) {
63
+ field.fields = {};
64
+ for (const [name, nested] of Object.entries(metadata.fields)) {
65
+ field.fields[name] = metadataToFieldDefinition(nested);
66
+ }
67
+ }
68
+ return field;
69
+ }
70
+ //# sourceMappingURL=search-fields-schema.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"search-fields-schema.js","sourceRoot":"","sources":["../../../src/search/model/search-fields-schema.ts"],"names":[],"mappings":";;;;AAOA,MAAM,oBAAoB,GAAG,MAAM,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAA;AAE/D;;;GAGG;AACH,MAAa,kBAAkB;IAW7B,YAAY,MAAc;QAR1B,QAAsB,GAAG,IAAI,CAAA;QAS3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED,MAAM,CAAC,oBAAoB,CACzB,KAAc;QAEd,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC,oBAAoB,CAAC,CAAA;IACxC,CAAC;IAED;;OAEG;IACH,QAAQ;QACN,MAAM,MAAM,GAA0C,EAAE,CAAA;QAExD,KAAK,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAChE,MAAM,CAAC,SAAS,CAAC,GAAG,yBAAyB,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAA;QAC1E,CAAC;QAED,OAAO,MAAM,CAAA;IACf,CAAC;CACF;AAjCD,gDAiCC;KA9BE,oBAAoB;AAgCvB,SAAS,yBAAyB,CAChC,QAAgC;IAEhC,MAAM,KAAK,GAA0B;QACnC,IAAI,EAAE,QAAQ,CAAC,QAAQ,CAAC,IAAI;KAC7B,CAAA;IAED,IAAI,QAAQ,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QACjC,KAAK,CAAC,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAA;IAC9B,CAAC;IACD,IAAI,QAAQ,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;QACtC,KAAK,CAAC,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAA;IACxC,CAAC;IACD,IAAI,QAAQ,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;QACtC,KAAK,CAAC,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAA;IACxC,CAAC;IACD,IAAI,QAAQ,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QACpC,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAA;IACpC,CAAC;IACD,IAAI,QAAQ,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;QACrC,KAAK,CAAC,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAA;IACtC,CAAC;IACD,IAAI,QAAQ,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;QACvC,KAAK,CAAC,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAA;IAC1C,CAAC;IACD,IAAI,QAAQ,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;QACtC,KAAK,CAAC,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAA;IACxC,CAAC;IACD,IAAI,QAAQ,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QACjC,KAAK,CAAC,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAA;IAC9B,CAAC;IACD,IAAI,QAAQ,CAAC,gBAAgB,KAAK,SAAS,EAAE,CAAC;QAC5C,KAAK,CAAC,gBAAgB,GAAG,QAAQ,CAAC,gBAAgB,CAAA;IACpD,CAAC;IACD,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;QACpB,KAAK,CAAC,MAAM,GAAG,EAAE,CAAA;QACjB,KAAK,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YAC7D,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,yBAAyB,CAAC,MAAM,CAAC,CAAA;QACxD,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAA;AACd,CAAC"}
@@ -0,0 +1,44 @@
1
+ import { SearchTypes } from "@etohq/types";
2
+ /**
3
+ * What one search request may see, as resolved per request by the index's
4
+ * `scope` resolver in `configureScopedSearch`: the audiences it reads from
5
+ * (a publishable key's sales channels, a member's networks) and the root(s)
6
+ * of their trees.
7
+ */
8
+ export type SearchRequestScope = {
9
+ /** The audiences the request may see. Must not be empty. */
10
+ audience_ids: string[];
11
+ /** The root(s) of the request's audience trees. Must not be empty. */
12
+ root_id: string | string[];
13
+ };
14
+ /**
15
+ * The root of a node in a tree stored as a materialized path, such as a sales
16
+ * channel's or a network's `mpath` (`root.child.grandchild`). A root's path is
17
+ * its own id.
18
+ */
19
+ export declare function treeRootOf(path: string, separator?: string): string;
20
+ /**
21
+ * The distinct roots of several nodes' materialized paths. What an index
22
+ * writes into its `scope.root` field next to the audiences, and what a request
23
+ * resolves for its own audiences.
24
+ */
25
+ export declare function treeRootsOf(paths: string[], separator?: string): string[];
26
+ /**
27
+ * Refuses a `scope` that names a missing field, a field that can't be
28
+ * filtered on, or a field that can be faceted. A facet on a scoping field
29
+ * would count documents outside the request's scope, because disjunctive
30
+ * faceting drops that field's own filter to compute it.
31
+ *
32
+ * Does nothing for an index that declares no `scope`.
33
+ */
34
+ export declare function validateSearchScope(definition: Pick<SearchTypes.SearchIndexDefinition, "name" | "fields" | "scope">): void;
35
+ /**
36
+ * The filters that confine a search to the request's scope: visible, sharing
37
+ * an audience with the request, and under one of its roots. ANDed onto every
38
+ * query, so a client can narrow its results but never widen past them.
39
+ *
40
+ * Throws rather than returning an unscoped filter when the index declares no
41
+ * `scope` or the request resolved no audiences or no root.
42
+ */
43
+ export declare function buildSearchScopeFilters(definition: Pick<SearchTypes.SearchIndexDefinition, "name" | "fields" | "scope">, scope: SearchRequestScope): SearchTypes.SearchFilters;
44
+ //# sourceMappingURL=search-scope.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"search-scope.d.ts","sourceRoot":"","sources":["../../src/search/search-scope.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAG1C;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,4DAA4D;IAC5D,YAAY,EAAE,MAAM,EAAE,CAAA;IAEtB,sEAAsE;IACtE,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CAC3B,CAAA;AAMD;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,SAAM,GAAG,MAAM,CAEhE;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,SAAS,SAAM,GAAG,MAAM,EAAE,CAMtE;AAkBD;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CACjC,UAAU,EAAE,IAAI,CAAC,WAAW,CAAC,qBAAqB,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC,GAC/E,IAAI,CAwCN;AAsBD;;;;;;;GAOG;AACH,wBAAgB,uBAAuB,CACrC,UAAU,EAAE,IAAI,CACd,WAAW,CAAC,qBAAqB,EACjC,MAAM,GAAG,QAAQ,GAAG,OAAO,CAC5B,EACD,KAAK,EAAE,kBAAkB,GACxB,WAAW,CAAC,aAAa,CAuC3B"}
@@ -0,0 +1,111 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.treeRootOf = treeRootOf;
4
+ exports.treeRootsOf = treeRootsOf;
5
+ exports.validateSearchScope = validateSearchScope;
6
+ exports.buildSearchScopeFilters = buildSearchScopeFilters;
7
+ const common_1 = require("../common");
8
+ const SCOPE_ROLES = ["visible", "audiences", "root"];
9
+ /**
10
+ * The root of a node in a tree stored as a materialized path, such as a sales
11
+ * channel's or a network's `mpath` (`root.child.grandchild`). A root's path is
12
+ * its own id.
13
+ */
14
+ function treeRootOf(path, separator = ".") {
15
+ return path.split(separator)[0];
16
+ }
17
+ /**
18
+ * The distinct roots of several nodes' materialized paths. What an index
19
+ * writes into its `scope.root` field next to the audiences, and what a request
20
+ * resolves for its own audiences.
21
+ */
22
+ function treeRootsOf(paths, separator = ".") {
23
+ return [
24
+ ...new Set(paths.filter(Boolean).map((path) => treeRootOf(path, separator))),
25
+ ];
26
+ }
27
+ function findField(fields, path) {
28
+ const [head, ...rest] = path.split(".");
29
+ const field = fields[head];
30
+ if (!field || !rest.length) {
31
+ return field;
32
+ }
33
+ return field.type === "object" && field.fields
34
+ ? findField(field.fields, rest.join("."))
35
+ : undefined;
36
+ }
37
+ /**
38
+ * Refuses a `scope` that names a missing field, a field that can't be
39
+ * filtered on, or a field that can be faceted. A facet on a scoping field
40
+ * would count documents outside the request's scope, because disjunctive
41
+ * faceting drops that field's own filter to compute it.
42
+ *
43
+ * Does nothing for an index that declares no `scope`.
44
+ */
45
+ function validateSearchScope(definition) {
46
+ const scope = definition.scope;
47
+ if (!scope) {
48
+ return;
49
+ }
50
+ for (const role of SCOPE_ROLES) {
51
+ const path = scope[role]?.field;
52
+ if (!path) {
53
+ throw new common_1.EtoError(common_1.EtoError.Types.INVALID_DATA, `Search index "${definition.name}" scope must name its ${role} field`);
54
+ }
55
+ const field = findField(definition.fields, path);
56
+ if (!field) {
57
+ throw new common_1.EtoError(common_1.EtoError.Types.INVALID_DATA, `Search index "${definition.name}" scope ${role} field "${path}" is not a field of the index`);
58
+ }
59
+ if (field.filterable !== true) {
60
+ throw new common_1.EtoError(common_1.EtoError.Types.INVALID_DATA, `Search index "${definition.name}" scope ${role} field "${path}" must be filterable`);
61
+ }
62
+ if (field.facetable) {
63
+ throw new common_1.EtoError(common_1.EtoError.Types.INVALID_DATA, `Search index "${definition.name}" scope ${role} field "${path}" must not be facetable: a facet on it counts documents outside the reader's scope`);
64
+ }
65
+ }
66
+ }
67
+ const toList = (value) => (Array.isArray(value) ? value : [value]).filter((item) => !!item);
68
+ // An array field matches when it shares a value with the request; a scalar
69
+ // one when its value is among the request's. Either way the request's list is
70
+ // never widened.
71
+ function anyOf(definition, path, values) {
72
+ const field = findField(definition.fields ?? {}, path);
73
+ return {
74
+ [path]: field?.array ? { $overlaps: values } : { $in: values },
75
+ };
76
+ }
77
+ /**
78
+ * The filters that confine a search to the request's scope: visible, sharing
79
+ * an audience with the request, and under one of its roots. ANDed onto every
80
+ * query, so a client can narrow its results but never widen past them.
81
+ *
82
+ * Throws rather than returning an unscoped filter when the index declares no
83
+ * `scope` or the request resolved no audiences or no root.
84
+ */
85
+ function buildSearchScopeFilters(definition, scope) {
86
+ const declared = definition.scope;
87
+ if (!declared) {
88
+ throw new common_1.EtoError(common_1.EtoError.Types.INVALID_DATA, `Search index "${definition.name}" declares no scope, so it can't be served outside the back office`);
89
+ }
90
+ const audiences = toList(scope?.audience_ids);
91
+ if (!audiences.length) {
92
+ throw new common_1.EtoError(common_1.EtoError.Types.INVALID_DATA, `Search on "${definition.name}" resolved no audiences (sales channels, networks) for this request`);
93
+ }
94
+ const roots = toList(scope?.root_id);
95
+ if (!roots.length) {
96
+ throw new common_1.EtoError(common_1.EtoError.Types.INVALID_DATA, `Search on "${definition.name}" resolved no root for this request`);
97
+ }
98
+ const visible = declared.visible.value;
99
+ return {
100
+ $and: [
101
+ {
102
+ [declared.visible.field]: Array.isArray(visible)
103
+ ? { $in: visible }
104
+ : { $eq: visible },
105
+ },
106
+ anyOf(definition, declared.audiences.field, audiences),
107
+ anyOf(definition, declared.root.field, roots),
108
+ ],
109
+ };
110
+ }
111
+ //# sourceMappingURL=search-scope.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"search-scope.js","sourceRoot":"","sources":["../../src/search/search-scope.ts"],"names":[],"mappings":";;AA0BA,gCAEC;AAOD,kCAMC;AA0BD,kDA0CC;AA8BD,0DA6CC;AAvLD,sCAAoC;AAkBpC,MAAM,WAAW,GAAgB,CAAC,SAAS,EAAE,WAAW,EAAE,MAAM,CAAC,CAAA;AAEjE;;;;GAIG;AACH,SAAgB,UAAU,CAAC,IAAY,EAAE,SAAS,GAAG,GAAG;IACtD,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAA;AACjC,CAAC;AAED;;;;GAIG;AACH,SAAgB,WAAW,CAAC,KAAe,EAAE,SAAS,GAAG,GAAG;IAC1D,OAAO;QACL,GAAG,IAAI,GAAG,CACR,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CACjE;KACF,CAAA;AACH,CAAC;AAED,SAAS,SAAS,CAChB,MAAyD,EACzD,IAAY;IAEZ,MAAM,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IACvC,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAA;IAE1B,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;QAC3B,OAAO,KAAK,CAAA;IACd,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM;QAC5C,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACzC,CAAC,CAAC,SAAS,CAAA;AACf,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,mBAAmB,CACjC,UAAgF;IAEhF,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAA;IAE9B,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAM;IACR,CAAC;IAED,KAAK,MAAM,IAAI,IAAI,WAAW,EAAE,CAAC;QAC/B,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,CAAA;QAE/B,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,IAAI,iBAAQ,CAChB,iBAAQ,CAAC,KAAK,CAAC,YAAY,EAC3B,iBAAiB,UAAU,CAAC,IAAI,yBAAyB,IAAI,QAAQ,CACtE,CAAA;QACH,CAAC;QAED,MAAM,KAAK,GAAG,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;QAEhD,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,iBAAQ,CAChB,iBAAQ,CAAC,KAAK,CAAC,YAAY,EAC3B,iBAAiB,UAAU,CAAC,IAAI,WAAW,IAAI,WAAW,IAAI,+BAA+B,CAC9F,CAAA;QACH,CAAC;QAED,IAAI,KAAK,CAAC,UAAU,KAAK,IAAI,EAAE,CAAC;YAC9B,MAAM,IAAI,iBAAQ,CAChB,iBAAQ,CAAC,KAAK,CAAC,YAAY,EAC3B,iBAAiB,UAAU,CAAC,IAAI,WAAW,IAAI,WAAW,IAAI,sBAAsB,CACrF,CAAA;QACH,CAAC;QAED,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;YACpB,MAAM,IAAI,iBAAQ,CAChB,iBAAQ,CAAC,KAAK,CAAC,YAAY,EAC3B,iBAAiB,UAAU,CAAC,IAAI,WAAW,IAAI,WAAW,IAAI,oFAAoF,CACnJ,CAAA;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED,MAAM,MAAM,GAAG,CAAC,KAA2C,EAAY,EAAE,CACvE,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAC7C,CAAC,IAAI,EAAkB,EAAE,CAAC,CAAC,CAAC,IAAI,CACjC,CAAA;AAEH,2EAA2E;AAC3E,8EAA8E;AAC9E,iBAAiB;AACjB,SAAS,KAAK,CACZ,UAA6D,EAC7D,IAAY,EACZ,MAAuC;IAEvC,MAAM,KAAK,GAAG,SAAS,CAAC,UAAU,CAAC,MAAM,IAAI,EAAE,EAAE,IAAI,CAAC,CAAA;IAEtD,OAAO;QACL,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE;KAC/D,CAAA;AACH,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,uBAAuB,CACrC,UAGC,EACD,KAAyB;IAEzB,MAAM,QAAQ,GAAG,UAAU,CAAC,KAAK,CAAA;IAEjC,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,iBAAQ,CAChB,iBAAQ,CAAC,KAAK,CAAC,YAAY,EAC3B,iBAAiB,UAAU,CAAC,IAAI,oEAAoE,CACrG,CAAA;IACH,CAAC;IAED,MAAM,SAAS,GAAG,MAAM,CAAC,KAAK,EAAE,YAAY,CAAC,CAAA;IAC7C,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;QACtB,MAAM,IAAI,iBAAQ,CAChB,iBAAQ,CAAC,KAAK,CAAC,YAAY,EAC3B,cAAc,UAAU,CAAC,IAAI,qEAAqE,CACnG,CAAA;IACH,CAAC;IAED,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;IACpC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;QAClB,MAAM,IAAI,iBAAQ,CAChB,iBAAQ,CAAC,KAAK,CAAC,YAAY,EAC3B,cAAc,UAAU,CAAC,IAAI,qCAAqC,CACnE,CAAA;IACH,CAAC;IAED,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAA;IAEtC,OAAO;QACL,IAAI,EAAE;YACJ;gBACE,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC;oBAC9C,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE;oBAClB,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE;aACrB;YACD,KAAK,CAAC,UAAU,EAAE,QAAQ,CAAC,SAAS,CAAC,KAAK,EAAE,SAAS,CAAC;YACtD,KAAK,CAAC,UAAU,EAAE,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC;SAC9C;KACF,CAAA;AACH,CAAC"}
@@ -1,19 +1,20 @@
1
- import { SearchTypes } from "@etohq/types";
1
+ import { SearchLegacyTypes } from "@etohq/types";
2
+ import type { LegacySearchIndexDocument, LegacySearchIndexGroup, LegacySearchQuery, LegacySearchResult } from "./types";
2
3
  /**
3
4
  * ## Overview
4
5
  *
5
- * A search service class is in a TypeScript or JavaScript file created in the `src/services` directory. The class must extend the `AbstractSearchService` class imported
6
+ * A search service class is in a TypeScript or JavaScript file created in the `src/services` directory. The class must extend the `AbstractLegacySearchService` class imported
6
7
  * from the `@etohq/utils` package.
7
8
  *
8
- * Based on services’ naming conventions, the file’s name should be the slug version of the search service’s name without `service`, and the class’s name should be the
9
- * pascal case of the search service’s name following by `Service`.
9
+ * Based on services’ naming conventions, the file’s name should be the slug version of the search service’s name without `service`, and the class’s name should be the
10
+ * pascal case of the search service’s name following by `Service`.
10
11
  *
11
- * For example, create the `MySearchService` class in the file `src/services/my-search.ts`:
12
+ * For example, create the `MySearchService` class in the file `src/services/my-search.ts`:
12
13
  *
13
14
  * ```ts title="src/services/my-search.ts"
14
- * import { AbstractSearchService } from "@etohq/utils"
15
+ * import { AbstractLegacySearchService } from "@etohq/utils"
15
16
  *
16
- * class MySearchService extends AbstractSearchService {
17
+ * class MySearchService extends AbstractLegacySearchService {
17
18
  * isDefault = false
18
19
  *
19
20
  * createIndex(indexName: string, options: Record<string, any>) {
@@ -75,7 +76,7 @@ import { SearchTypes } from "@etohq/types";
75
76
  *
76
77
  * ---
77
78
  */
78
- export declare abstract class AbstractSearchService implements SearchTypes.ISearchService {
79
+ export declare abstract class AbstractLegacySearchService implements SearchLegacyTypes.ILegacySearchService {
79
80
  /**
80
81
  * @ignore
81
82
  */
@@ -116,7 +117,7 @@ export declare abstract class AbstractSearchService implements SearchTypes.ISear
116
117
  * productService: ProductService
117
118
  * }
118
119
  *
119
- * class MySearchService extends AbstractSearchService {
120
+ * class MySearchService extends AbstractLegacySearchService {
120
121
  * // ...
121
122
  * protected readonly productService_: ProductService
122
123
  *
@@ -146,7 +147,7 @@ export declare abstract class AbstractSearchService implements SearchTypes.ISear
146
147
  * An example implementation, assuming `client` would interact with a third-party service:
147
148
  *
148
149
  * ```ts title="src/services/my-search.ts"
149
- * class MySearchService extends AbstractSearchService {
150
+ * class MySearchService extends AbstractLegacySearchService {
150
151
  * // ...
151
152
  * createIndex(indexName: string, options: Record<string, any>) {
152
153
  * return this.client_.initIndex(indexName)
@@ -159,7 +160,7 @@ export declare abstract class AbstractSearchService implements SearchTypes.ISear
159
160
  * `options` parameter:
160
161
  *
161
162
  * ```ts
162
- * class MeiliSearchService extends AbstractSearchService {
163
+ * class MeiliSearchService extends AbstractLegacySearchService {
163
164
  * // ...
164
165
  * async createIndex(
165
166
  * indexName: string,
@@ -179,7 +180,7 @@ export declare abstract class AbstractSearchService implements SearchTypes.ISear
179
180
  * @returns {unknown} No required format of returned data, as it depends on your custom implementation.
180
181
  *
181
182
  * @example
182
- * class MySearchService extends AbstractSearchService {
183
+ * class MySearchService extends AbstractLegacySearchService {
183
184
  * // ...
184
185
  *
185
186
  * getIndex(indexName: string) {
@@ -200,7 +201,7 @@ export declare abstract class AbstractSearchService implements SearchTypes.ISear
200
201
  * @returns {unknown} The response of saving the documents in the search engine, but there’s no required format of the response.
201
202
  *
202
203
  * @example
203
- * class MySearchService extends AbstractSearchService {
204
+ * class MySearchService extends AbstractLegacySearchService {
204
205
  * // ...
205
206
  *
206
207
  * async addDocuments(
@@ -224,7 +225,7 @@ export declare abstract class AbstractSearchService implements SearchTypes.ISear
224
225
  * @returns {unknown} The response of replacing the documents in the search engine, but there’s no required format of the response.
225
226
  *
226
227
  * @example
227
- * class MySearchService extends AbstractSearchService {
228
+ * class MySearchService extends AbstractLegacySearchService {
228
229
  * // ...
229
230
  *
230
231
  * async replaceDocuments(
@@ -251,7 +252,7 @@ export declare abstract class AbstractSearchService implements SearchTypes.ISear
251
252
  * @returns {unknown} The response of deleting the document in the search engine, but there’s no required format of the response.
252
253
  *
253
254
  * @example
254
- * class MySearchService extends AbstractSearchService {
255
+ * class MySearchService extends AbstractLegacySearchService {
255
256
  * // ...
256
257
  *
257
258
  * async deleteDocument(
@@ -271,7 +272,7 @@ export declare abstract class AbstractSearchService implements SearchTypes.ISear
271
272
  * @returns {unknown} The response of deleting the documents of that index in the search engine, but there’s no required format of the response.
272
273
  *
273
274
  * @example
274
- * class MySearchService extends AbstractSearchService {
275
+ * class MySearchService extends AbstractLegacySearchService {
275
276
  * // ...
276
277
  *
277
278
  * async deleteAllDocuments(indexName: string) {
@@ -300,7 +301,7 @@ export declare abstract class AbstractSearchService implements SearchTypes.ISear
300
301
  * @returns {unknown} The list of results. For example, an array of products.
301
302
  *
302
303
  * @example
303
- * class MySearchService extends AbstractSearchService {
304
+ * class MySearchService extends AbstractLegacySearchService {
304
305
  * // ...
305
306
  *
306
307
  * async search(
@@ -328,7 +329,7 @@ export declare abstract class AbstractSearchService implements SearchTypes.ISear
328
329
  * @returns {unknown} The response of updating the index in the search engine, but there’s no required format of the response.
329
330
  *
330
331
  * @example
331
- * class MySearchService extends AbstractSearchService {
332
+ * class MySearchService extends AbstractLegacySearchService {
332
333
  * // ...
333
334
  *
334
335
  * async updateSettings(
@@ -341,5 +342,41 @@ export declare abstract class AbstractSearchService implements SearchTypes.ISear
341
342
  * }
342
343
  */
343
344
  abstract updateSettings(indexName: string, settings: unknown): unknown;
345
+ /**
346
+ * Search engines that natively model a dataset as groups and documents set
347
+ * this to `true` and implement the capability below. Engines that only
348
+ * implement the index-based API can leave it `false`; the group/document
349
+ * methods then reject with a clear error.
350
+ */
351
+ readonly supportsGroups: boolean;
352
+ /**
353
+ * Search engines that index documents (chunks) set this to `true` and
354
+ * implement `upsertDocuments`/`deleteDocuments`/`searchDocuments`. It is
355
+ * independent of `supportsGroups`: an engine may support documents without
356
+ * groups (e.g. a database full-text search).
357
+ */
358
+ readonly supportsDocuments: boolean;
359
+ protected capabilityUnsupported_(method: string, flag: string): Error;
360
+ /**
361
+ * Creates or replaces a group (a top-level bucket of documents).
362
+ */
363
+ upsertGroup(group: LegacySearchIndexGroup): Promise<void>;
364
+ /**
365
+ * Removes a group by its tracking id.
366
+ */
367
+ deleteGroup(trackingId: string): Promise<void>;
368
+ /**
369
+ * Upserts documents (chunks). Implementations must be idempotent by tracking id.
370
+ */
371
+ upsertDocuments(documents: LegacySearchIndexDocument[]): Promise<void>;
372
+ /**
373
+ * Removes documents by their tracking ids.
374
+ */
375
+ deleteDocuments(trackingIds: string[]): Promise<void>;
376
+ /**
377
+ * Searches documents, returning ranked hits. The caller hydrates the ids
378
+ * from the source of truth.
379
+ */
380
+ searchDocuments(query: LegacySearchQuery): Promise<LegacySearchResult>;
344
381
  }
345
382
  //# sourceMappingURL=abstract-service.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"abstract-service.d.ts","sourceRoot":"","sources":["../../src/search-legacy/abstract-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAEhD,OAAO,KAAK,EACV,yBAAyB,EACzB,sBAAsB,EACtB,iBAAiB,EACjB,kBAAkB,EACnB,MAAM,SAAS,CAAA;AAEhB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2EG;AACH,8BAAsB,2BACpB,YAAW,iBAAiB,CAAC,oBAAoB;IAEjD;;OAEG;IACH,MAAM,CAAC,gBAAgB,UAAO;IAE9B;;OAEG;IACH,MAAM,CAAC,eAAe,CAAC,GAAG,KAAA;IAI1B;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,SAAS,MAAA;IAC3B;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAEpD;;OAEG;IACH,IAAI,OAAO,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAErC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,SAAS,aAAa,MAAM,KAAA,EAAE,OAAO,KAAA;IAIrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,QAAQ,CAAC,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO;IAElE;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO;IAE7C;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,QAAQ,CAAC,YAAY,CACnB,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,OAAO,EAClB,IAAI,EAAE,MAAM,GACX,OAAO;IAEV;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,QAAQ,CAAC,gBAAgB,CACvB,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,OAAO,EAClB,IAAI,EAAE,MAAM,GACX,OAAO;IAEV;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,QAAQ,CAAC,cAAc,CACrB,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,GAAG,MAAM,GAC3B,OAAO;IAEV;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,kBAAkB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO;IAEvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,QAAQ,CAAC,MAAM,CACb,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,MAAM,GAAG,IAAI,EACpB,OAAO,EAAE,OAAO,GACf,OAAO;IAEV;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,QAAQ,CAAC,cAAc,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,GAAG,OAAO;IAEtE;;;;;OAKG;IACH,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAQ;IAExC;;;;;OAKG;IACH,QAAQ,CAAC,iBAAiB,EAAE,OAAO,CAAQ;IAE3C,SAAS,CAAC,sBAAsB,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,KAAK;IAMrE;;OAEG;IACG,WAAW,CAAC,KAAK,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAI/D;;OAEG;IACG,WAAW,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIpD;;OAEG;IACG,eAAe,CAAC,SAAS,EAAE,yBAAyB,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAI5E;;OAEG;IACG,eAAe,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAI3D;;;OAGG;IACG,eAAe,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC;CAG7E"}
@@ -1,21 +1,21 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.AbstractSearchService = void 0;
3
+ exports.AbstractLegacySearchService = void 0;
4
4
  /**
5
5
  * ## Overview
6
6
  *
7
- * A search service class is in a TypeScript or JavaScript file created in the `src/services` directory. The class must extend the `AbstractSearchService` class imported
7
+ * A search service class is in a TypeScript or JavaScript file created in the `src/services` directory. The class must extend the `AbstractLegacySearchService` class imported
8
8
  * from the `@etohq/utils` package.
9
9
  *
10
- * Based on services’ naming conventions, the file’s name should be the slug version of the search service’s name without `service`, and the class’s name should be the
11
- * pascal case of the search service’s name following by `Service`.
10
+ * Based on services’ naming conventions, the file’s name should be the slug version of the search service’s name without `service`, and the class’s name should be the
11
+ * pascal case of the search service’s name following by `Service`.
12
12
  *
13
- * For example, create the `MySearchService` class in the file `src/services/my-search.ts`:
13
+ * For example, create the `MySearchService` class in the file `src/services/my-search.ts`:
14
14
  *
15
15
  * ```ts title="src/services/my-search.ts"
16
- * import { AbstractSearchService } from "@etohq/utils"
16
+ * import { AbstractLegacySearchService } from "@etohq/utils"
17
17
  *
18
- * class MySearchService extends AbstractSearchService {
18
+ * class MySearchService extends AbstractLegacySearchService {
19
19
  * isDefault = false
20
20
  *
21
21
  * createIndex(indexName: string, options: Record<string, any>) {
@@ -77,7 +77,7 @@ exports.AbstractSearchService = void 0;
77
77
  *
78
78
  * ---
79
79
  */
80
- class AbstractSearchService {
80
+ class AbstractLegacySearchService {
81
81
  /**
82
82
  * @ignore
83
83
  */
@@ -110,7 +110,7 @@ class AbstractSearchService {
110
110
  * productService: ProductService
111
111
  * }
112
112
  *
113
- * class MySearchService extends AbstractSearchService {
113
+ * class MySearchService extends AbstractLegacySearchService {
114
114
  * // ...
115
115
  * protected readonly productService_: ProductService
116
116
  *
@@ -128,12 +128,60 @@ class AbstractSearchService {
128
128
  * }
129
129
  */
130
130
  constructor(cradle, options) {
131
+ /**
132
+ * Search engines that natively model a dataset as groups and documents set
133
+ * this to `true` and implement the capability below. Engines that only
134
+ * implement the index-based API can leave it `false`; the group/document
135
+ * methods then reject with a clear error.
136
+ */
137
+ this.supportsGroups = false;
138
+ /**
139
+ * Search engines that index documents (chunks) set this to `true` and
140
+ * implement `upsertDocuments`/`deleteDocuments`/`searchDocuments`. It is
141
+ * independent of `supportsGroups`: an engine may support documents without
142
+ * groups (e.g. a database full-text search).
143
+ */
144
+ this.supportsDocuments = false;
131
145
  this.options_ = options;
132
146
  }
147
+ capabilityUnsupported_(method, flag) {
148
+ return new Error(`${this.constructor.name}.${method} requires \`${flag}\` to be true on this search service.`);
149
+ }
150
+ /**
151
+ * Creates or replaces a group (a top-level bucket of documents).
152
+ */
153
+ async upsertGroup(group) {
154
+ throw this.capabilityUnsupported_("upsertGroup", "supportsGroups");
155
+ }
156
+ /**
157
+ * Removes a group by its tracking id.
158
+ */
159
+ async deleteGroup(trackingId) {
160
+ throw this.capabilityUnsupported_("deleteGroup", "supportsGroups");
161
+ }
162
+ /**
163
+ * Upserts documents (chunks). Implementations must be idempotent by tracking id.
164
+ */
165
+ async upsertDocuments(documents) {
166
+ throw this.capabilityUnsupported_("upsertDocuments", "supportsDocuments");
167
+ }
168
+ /**
169
+ * Removes documents by their tracking ids.
170
+ */
171
+ async deleteDocuments(trackingIds) {
172
+ throw this.capabilityUnsupported_("deleteDocuments", "supportsDocuments");
173
+ }
174
+ /**
175
+ * Searches documents, returning ranked hits. The caller hydrates the ids
176
+ * from the source of truth.
177
+ */
178
+ async searchDocuments(query) {
179
+ throw this.capabilityUnsupported_("searchDocuments", "supportsDocuments");
180
+ }
133
181
  }
134
- exports.AbstractSearchService = AbstractSearchService;
182
+ exports.AbstractLegacySearchService = AbstractLegacySearchService;
135
183
  /**
136
184
  * @ignore
137
185
  */
138
- AbstractSearchService._isSearchService = true;
186
+ AbstractLegacySearchService._isSearchService = true;
139
187
  //# sourceMappingURL=abstract-service.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"abstract-service.js","sourceRoot":"","sources":["../../src/search-legacy/abstract-service.ts"],"names":[],"mappings":";;;AASA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2EG;AACH,MAAsB,2BAA2B;IAQ/C;;OAEG;IACH,MAAM,CAAC,eAAe,CAAC,GAAG;QACxB,OAAO,GAAG,EAAE,WAAW,EAAE,gBAAgB,CAAA;IAC3C,CAAC;IAWD;;OAEG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,YAAsB,MAAM,EAAE,OAAO;QA0OrC;;;;;WAKG;QACM,mBAAc,GAAY,KAAK,CAAA;QAExC;;;;;WAKG;QACM,sBAAiB,GAAY,KAAK,CAAA;QAvPzC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAA;IACzB,CAAC;IAwPS,sBAAsB,CAAC,MAAc,EAAE,IAAY;QAC3D,OAAO,IAAI,KAAK,CACd,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,MAAM,eAAe,IAAI,uCAAuC,CAC7F,CAAA;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAW,CAAC,KAA6B;QAC7C,MAAM,IAAI,CAAC,sBAAsB,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAA;IACpE,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAW,CAAC,UAAkB;QAClC,MAAM,IAAI,CAAC,sBAAsB,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAA;IACpE,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,eAAe,CAAC,SAAsC;QAC1D,MAAM,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,EAAE,mBAAmB,CAAC,CAAA;IAC3E,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,eAAe,CAAC,WAAqB;QACzC,MAAM,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,EAAE,mBAAmB,CAAC,CAAA;IAC3E,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,eAAe,CAAC,KAAwB;QAC5C,MAAM,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,EAAE,mBAAmB,CAAC,CAAA;IAC3E,CAAC;;AAtWH,kEAuWC;AApWC;;GAEG;AACI,4CAAgB,GAAG,IAAI,AAAP,CAAO"}
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index-types.d.ts","sourceRoot":"","sources":["../../src/search-legacy/index-types.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,UAAU;;CAEtB,CAAA"}
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index-types.js","sourceRoot":"","sources":["../../src/search-legacy/index-types.ts"],"names":[],"mappings":";;;AAAa,QAAA,UAAU,GAAG;IACxB,QAAQ,EAAE,UAAU;CACrB,CAAA"}
@@ -0,0 +1,6 @@
1
+ export * from "./abstract-service";
2
+ export * from "./search-relations";
3
+ export * from "./index-types";
4
+ export * from "./variant-keys";
5
+ export * from "./types";
6
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/search-legacy/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAA;AAClC,cAAc,oBAAoB,CAAA;AAClC,cAAc,eAAe,CAAA;AAC7B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,SAAS,CAAA"}
@@ -0,0 +1,22 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./abstract-service"), exports);
18
+ __exportStar(require("./search-relations"), exports);
19
+ __exportStar(require("./index-types"), exports);
20
+ __exportStar(require("./variant-keys"), exports);
21
+ __exportStar(require("./types"), exports);
22
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/search-legacy/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,qDAAkC;AAClC,qDAAkC;AAClC,gDAA6B;AAC7B,iDAA8B;AAC9B,0CAAuB"}
@@ -0,0 +1 @@
1
+ {"version":3,"file":"search-relations.d.ts","sourceRoot":"","sources":["../../src/search-legacy/search-relations.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,qCAAqC,UASjD,CAAA"}
@@ -0,0 +1 @@
1
+ {"version":3,"file":"search-relations.js","sourceRoot":"","sources":["../../src/search-legacy/search-relations.ts"],"names":[],"mappings":";;;AAAa,QAAA,qCAAqC,GAAG;IACnD,UAAU;IACV,MAAM;IACN,MAAM;IACN,YAAY;IACZ,iBAAiB;IACjB,QAAQ;IACR,kBAAkB;IAClB,SAAS;CACV,CAAA"}