arocapi 4.0.1 → 5.0.0-beta.10

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 (242) hide show
  1. package/LICENSE.md +1 -1
  2. package/README.md +37 -781
  3. package/dist/app.d.ts +38 -21
  4. package/dist/app.js +63 -45
  5. package/dist/app.js.map +1 -1
  6. package/dist/routes/capabilities.d.ts +7 -0
  7. package/dist/routes/capabilities.js +13 -0
  8. package/dist/routes/capabilities.js.map +1 -0
  9. package/dist/routes/entities.d.ts +5 -2
  10. package/dist/routes/entities.js +38 -58
  11. package/dist/routes/entities.js.map +1 -1
  12. package/dist/routes/entity.d.ts +7 -2
  13. package/dist/routes/entity.js +14 -30
  14. package/dist/routes/entity.js.map +1 -1
  15. package/dist/routes/file.d.ts +8 -2
  16. package/dist/routes/file.js +38 -73
  17. package/dist/routes/file.js.map +1 -1
  18. package/dist/routes/files.d.ts +5 -2
  19. package/dist/routes/files.js +25 -40
  20. package/dist/routes/files.js.map +1 -1
  21. package/dist/routes/metadata.d.ts +15 -0
  22. package/dist/routes/metadata.js +38 -0
  23. package/dist/routes/metadata.js.map +1 -0
  24. package/dist/routes/search.d.ts +8 -7
  25. package/dist/routes/search.js +91 -120
  26. package/dist/routes/search.js.map +1 -1
  27. package/dist/search/advanced.d.ts +8 -0
  28. package/dist/search/advanced.js +198 -0
  29. package/dist/search/advanced.js.map +1 -0
  30. package/dist/search/backend.d.ts +95 -0
  31. package/dist/search/backend.js +5 -0
  32. package/dist/search/backend.js.map +1 -0
  33. package/dist/search/fields.d.ts +63 -0
  34. package/dist/search/fields.js +203 -0
  35. package/dist/search/fields.js.map +1 -0
  36. package/dist/search/opensearch/advanced.d.ts +4 -0
  37. package/dist/search/opensearch/advanced.js +28 -0
  38. package/dist/search/opensearch/advanced.js.map +1 -0
  39. package/dist/search/opensearch/opensearch.d.ts +16 -0
  40. package/dist/search/opensearch/opensearch.js +187 -0
  41. package/dist/search/opensearch/opensearch.js.map +1 -0
  42. package/dist/search/opensearch/visibility.d.ts +3 -0
  43. package/dist/search/opensearch/visibility.js +27 -0
  44. package/dist/search/opensearch/visibility.js.map +1 -0
  45. package/dist/search/postgres/advanced.d.ts +7 -0
  46. package/dist/search/postgres/advanced.js +54 -0
  47. package/dist/search/postgres/advanced.js.map +1 -0
  48. package/dist/search/postgres/facets.d.ts +2 -0
  49. package/dist/search/postgres/facets.js +27 -0
  50. package/dist/search/postgres/facets.js.map +1 -0
  51. package/dist/search/postgres/geo.d.ts +6 -0
  52. package/dist/search/postgres/geo.js +42 -0
  53. package/dist/search/postgres/geo.js.map +1 -0
  54. package/dist/search/postgres/postgres.d.ts +19 -0
  55. package/dist/search/postgres/postgres.js +157 -0
  56. package/dist/search/postgres/postgres.js.map +1 -0
  57. package/dist/search/postgres/values.d.ts +8 -0
  58. package/dist/search/postgres/values.js +20 -0
  59. package/dist/search/postgres/values.js.map +1 -0
  60. package/dist/search/postgres/visibility.d.ts +4 -0
  61. package/dist/search/postgres/visibility.js +38 -0
  62. package/dist/search/postgres/visibility.js.map +1 -0
  63. package/dist/search/requestFilters.d.ts +39 -0
  64. package/dist/search/requestFilters.js +125 -0
  65. package/dist/search/requestFilters.js.map +1 -0
  66. package/dist/search/visibility.d.ts +51 -0
  67. package/dist/search/visibility.js +100 -0
  68. package/dist/search/visibility.js.map +1 -0
  69. package/dist/storage/backend.d.ts +58 -0
  70. package/dist/storage/backend.js +2 -0
  71. package/dist/storage/backend.js.map +1 -0
  72. package/dist/storage/deliver.d.ts +12 -0
  73. package/dist/storage/deliver.js +34 -0
  74. package/dist/storage/deliver.js.map +1 -0
  75. package/dist/storage/directory/directory.d.ts +6 -0
  76. package/dist/storage/directory/directory.js +24 -0
  77. package/dist/storage/directory/directory.js.map +1 -0
  78. package/dist/storage/entity-meta/entity-meta.d.ts +5 -0
  79. package/dist/storage/entity-meta/entity-meta.js +14 -0
  80. package/dist/storage/entity-meta/entity-meta.js.map +1 -0
  81. package/dist/storage/location.d.ts +19 -0
  82. package/dist/storage/location.js +36 -0
  83. package/dist/storage/location.js.map +1 -0
  84. package/dist/storage/ocfl/ocfl.d.ts +6 -0
  85. package/dist/storage/ocfl/ocfl.js +45 -0
  86. package/dist/storage/ocfl/ocfl.js.map +1 -0
  87. package/dist/storage/results.d.ts +7 -0
  88. package/dist/storage/results.js +22 -0
  89. package/dist/storage/results.js.map +1 -0
  90. package/dist/storage/s3/s3.d.ts +10 -0
  91. package/dist/storage/s3/s3.js +47 -0
  92. package/dist/storage/s3/s3.js.map +1 -0
  93. package/dist/transformers/default.d.ts +11 -22
  94. package/dist/transformers/default.js +41 -15
  95. package/dist/transformers/default.js.map +1 -1
  96. package/dist/types/access.d.ts +9 -0
  97. package/dist/types/access.js +2 -0
  98. package/dist/types/access.js.map +1 -0
  99. package/dist/types/context.d.ts +6 -0
  100. package/dist/types/context.js +2 -0
  101. package/dist/types/context.js.map +1 -0
  102. package/dist/types/transformers.d.ts +4 -10
  103. package/dist/types/visibility.d.ts +6 -0
  104. package/dist/types/visibility.js +2 -0
  105. package/dist/types/visibility.js.map +1 -0
  106. package/dist/utils/access.d.ts +17 -0
  107. package/dist/utils/access.js +41 -0
  108. package/dist/utils/access.js.map +1 -0
  109. package/dist/utils/errors.d.ts +19 -10
  110. package/dist/utils/errors.js +44 -8
  111. package/dist/utils/errors.js.map +1 -1
  112. package/dist/utils/headers.d.ts +1 -1
  113. package/dist/utils/headers.js +10 -1
  114. package/dist/utils/headers.js.map +1 -1
  115. package/dist/utils/validation.d.ts +2 -0
  116. package/dist/utils/validation.js +8 -0
  117. package/dist/utils/validation.js.map +1 -0
  118. package/dist/utils/visibility.d.ts +18 -0
  119. package/dist/utils/visibility.js +16 -0
  120. package/dist/utils/visibility.js.map +1 -0
  121. package/package.json +84 -45
  122. package/prisma/models/entity.prisma +9 -8
  123. package/prisma/models/entitySearch.prisma +21 -0
  124. package/prisma/models/file.prisma +3 -3
  125. package/src/app.ts +169 -102
  126. package/src/routes/capabilities.ts +22 -0
  127. package/src/routes/entities.ts +49 -68
  128. package/src/routes/entity.ts +22 -36
  129. package/src/routes/file.ts +54 -104
  130. package/src/routes/files.ts +32 -48
  131. package/src/routes/metadata.ts +67 -0
  132. package/src/routes/search.ts +132 -152
  133. package/src/search/advanced.ts +258 -0
  134. package/src/search/backend.ts +91 -0
  135. package/src/search/fields.ts +320 -0
  136. package/src/search/opensearch/advanced.ts +36 -0
  137. package/src/search/opensearch/opensearch.ts +290 -0
  138. package/src/search/opensearch/visibility.ts +38 -0
  139. package/src/search/postgres/advanced.ts +76 -0
  140. package/src/search/postgres/facets.ts +34 -0
  141. package/src/search/postgres/geo.ts +58 -0
  142. package/src/search/postgres/postgres.ts +232 -0
  143. package/src/search/postgres/values.ts +33 -0
  144. package/src/search/postgres/visibility.ts +54 -0
  145. package/src/search/requestFilters.ts +178 -0
  146. package/src/search/visibility.ts +193 -0
  147. package/src/storage/backend.ts +75 -0
  148. package/src/storage/deliver.ts +65 -0
  149. package/src/storage/directory/directory.ts +39 -0
  150. package/src/storage/entity-meta/entity-meta.ts +25 -0
  151. package/src/storage/location.ts +78 -0
  152. package/src/storage/ocfl/ocfl.ts +71 -0
  153. package/src/storage/results.ts +32 -0
  154. package/src/storage/s3/s3.ts +79 -0
  155. package/src/transformers/default.ts +115 -85
  156. package/src/types/access.ts +25 -0
  157. package/src/types/context.ts +15 -0
  158. package/src/types/transformers.ts +8 -34
  159. package/src/types/visibility.ts +21 -0
  160. package/src/utils/access.ts +80 -0
  161. package/src/utils/errors.ts +68 -11
  162. package/src/utils/headers.ts +22 -2
  163. package/src/utils/validation.ts +11 -0
  164. package/src/utils/visibility.ts +56 -0
  165. package/dist/app.test.d.ts +0 -1
  166. package/dist/app.test.js +0 -89
  167. package/dist/app.test.js.map +0 -1
  168. package/dist/express.d.ts +0 -4
  169. package/dist/express.js +0 -14
  170. package/dist/express.js.map +0 -1
  171. package/dist/index.dev.d.ts +0 -1
  172. package/dist/index.dev.js +0 -156
  173. package/dist/index.dev.js.map +0 -1
  174. package/dist/routes/crate.d.ts +0 -9
  175. package/dist/routes/crate.js +0 -82
  176. package/dist/routes/crate.js.map +0 -1
  177. package/dist/routes/crate.test.d.ts +0 -1
  178. package/dist/routes/crate.test.js +0 -342
  179. package/dist/routes/crate.test.js.map +0 -1
  180. package/dist/routes/entities.test.d.ts +0 -1
  181. package/dist/routes/entities.test.js +0 -273
  182. package/dist/routes/entities.test.js.map +0 -1
  183. package/dist/routes/entity.test.d.ts +0 -1
  184. package/dist/routes/entity.test.js +0 -130
  185. package/dist/routes/entity.test.js.map +0 -1
  186. package/dist/routes/file.test.d.ts +0 -1
  187. package/dist/routes/file.test.js +0 -315
  188. package/dist/routes/file.test.js.map +0 -1
  189. package/dist/routes/files.test.d.ts +0 -1
  190. package/dist/routes/files.test.js +0 -222
  191. package/dist/routes/files.test.js.map +0 -1
  192. package/dist/routes/search.test.d.ts +0 -1
  193. package/dist/routes/search.test.js +0 -780
  194. package/dist/routes/search.test.js.map +0 -1
  195. package/dist/test/helpers/fastify.d.ts +0 -9
  196. package/dist/test/helpers/fastify.js +0 -18
  197. package/dist/test/helpers/fastify.js.map +0 -1
  198. package/dist/test/integration.setup.d.ts +0 -29
  199. package/dist/test/integration.setup.js +0 -188
  200. package/dist/test/integration.setup.js.map +0 -1
  201. package/dist/test/integration.test.d.ts +0 -1
  202. package/dist/test/integration.test.js +0 -396
  203. package/dist/test/integration.test.js.map +0 -1
  204. package/dist/transformers/default.test.d.ts +0 -1
  205. package/dist/transformers/default.test.js +0 -163
  206. package/dist/transformers/default.test.js.map +0 -1
  207. package/dist/transformers/transformer.test.d.ts +0 -1
  208. package/dist/transformers/transformer.test.js +0 -187
  209. package/dist/transformers/transformer.test.js.map +0 -1
  210. package/dist/types/fileHandlers.d.ts +0 -41
  211. package/dist/types/fileHandlers.js +0 -2
  212. package/dist/types/fileHandlers.js.map +0 -1
  213. package/dist/utils/errors.test.d.ts +0 -1
  214. package/dist/utils/errors.test.js +0 -66
  215. package/dist/utils/errors.test.js.map +0 -1
  216. package/dist/utils/queryBuilder.d.ts +0 -35
  217. package/dist/utils/queryBuilder.js +0 -98
  218. package/dist/utils/queryBuilder.js.map +0 -1
  219. package/prisma.config.ts +0 -9
  220. package/src/app.test.ts +0 -119
  221. package/src/express.ts +0 -21
  222. package/src/index.dev.ts +0 -200
  223. package/src/reset.d.ts +0 -1
  224. package/src/routes/__snapshots__/entities.test.ts.snap +0 -96
  225. package/src/routes/__snapshots__/entity.test.ts.snap +0 -74
  226. package/src/routes/__snapshots__/search.test.ts.snap +0 -165
  227. package/src/routes/crate.test.ts +0 -423
  228. package/src/routes/crate.ts +0 -123
  229. package/src/routes/entities.test.ts +0 -320
  230. package/src/routes/entity.test.ts +0 -160
  231. package/src/routes/file.test.ts +0 -395
  232. package/src/routes/files.test.ts +0 -278
  233. package/src/routes/search.test.ts +0 -903
  234. package/src/test/__snapshots__/integration.test.ts.snap +0 -18
  235. package/src/test/helpers/fastify.ts +0 -27
  236. package/src/test/integration.setup.ts +0 -210
  237. package/src/test/integration.test.ts +0 -482
  238. package/src/transformers/default.test.ts +0 -184
  239. package/src/transformers/transformer.test.ts +0 -252
  240. package/src/types/fileHandlers.ts +0 -65
  241. package/src/utils/errors.test.ts +0 -75
  242. package/src/utils/queryBuilder.ts +0 -132
@@ -1 +1 @@
1
- {"version":3,"file":"search.js","sourceRoot":"","sources":["../../src/routes/search.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAC;AAE3B,OAAO,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,MAAM,4BAA4B,CAAC;AAE5F,OAAO,EAAE,mBAAmB,EAAE,yBAAyB,EAAE,MAAM,oBAAoB,CAAC;AACpF,OAAO,EAAE,sBAAsB,EAA4B,MAAM,0BAA0B,CAAC;AAE5F,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACjC,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC;QACjB,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;QACf,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;KAChB,CAAC;IACF,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC;QACnB,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;QACf,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;KAChB,CAAC;CACH,CAAC,CAAC;AAEH,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IAClC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;IAC1D,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC7D,WAAW,EAAE,iBAAiB,CAAC,QAAQ,EAAE;IACzC,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC5D,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC;IACrD,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;IAC1C,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC;IACxF,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;CAC9C,CAAC,CAAC;AAWH,MAAM,MAAM,GAA2C,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE;IAC7E,MAAM,EACJ,MAAM,EACN,UAAU,EACV,iBAAiB,EACjB,kBAAkB,GAAG,EAAE,EACvB,iBAAiB,GAAG,sBAAsB,EAC1C,mBAAmB,GACpB,GAAG,IAAI,CAAC;IACT,MAAM,YAAY,GAAG,IAAI,iBAAiB,CAAC,mBAAmB,CAAC,CAAC;IAChE,OAAO,CAAC,gBAAgB,EAAmB,CAAC,IAAI,CAC9C,SAAS,EACT;QACE,MAAM,EAAE;YACN,IAAI,EAAE,kBAAkB;SACzB;KACF,EACD,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE;QACvB,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;QAE/G,IAAI,CAAC;YACH,MAAM,eAAe,GAAmB;gBACtC,KAAK,EAAE,UAAU;gBACjB,IAAI,EAAE;oBACJ,KAAK,EAAE,YAAY,CAAC,UAAU,CAAC,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,WAAW,CAAC;oBACvE,IAAI,EAAE,YAAY,CAAC,iBAAiB,CAAC,gBAAgB,EAAE,WAAW,CAAC;oBACnE,SAAS,EAAE;wBACT,MAAM,EAAE;4BACN,IAAI,EAAE,EAAE;4BACR,WAAW,EAAE,EAAE;yBAChB;qBACF;oBACD,IAAI,EAAE,YAAY,CAAC,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC;oBACzC,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,KAAK;iBACZ;aACF,CAAC;YACF,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;YACnC,MAAM,QAAQ,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;YAE1D,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;gBAC/B,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;YAChE,CAAC;YAED,MAAM,SAAS,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,EAAE,EAAwB,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAE9G,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC;gBAC9C,KAAK,EAAE;oBACL,EAAE,EAAE;wBACF,EAAE,EAAE,SAAS;qBACd;iBACF;gBACD,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;aAC5C,CAAC,CAAC;YAEH,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;YAG3E,MAAM,MAAM,GAAG,MAAM,uBAAuB,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;YAEjE,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,CAChC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;gBACxC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,EAAE,CAAC;oBACrB,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;gBAC9C,CAAC;gBAED,MAAM,QAAQ,GAAG,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;gBAC/C,IAAI,CAAC,QAAQ,EAAE,CAAC;oBACd,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,GAAG,CAAC,OAAO,CAAC,EAAE,0CAA0C,CAAC,CAAC;oBAErF,OAAO,IAAI,CAAC;gBACd,CAAC;gBAED,MAAM,IAAI,GAAG,qBAAqB,CAAC,QAAQ,CAAC,CAAC;gBAC7C,MAAM,cAAc,GAAG;oBACrB,GAAG,IAAI;oBACP,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI;oBACpE,cAAc,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI;iBACvF,CAAC;gBACF,MAAM,gBAAgB,GAAG,MAAM,iBAAiB,CAAC,cAAc,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;gBAEvF,IAAI,MAAM,GAAG,gBAAgB,CAAC;gBAC9B,KAAK,MAAM,WAAW,IAAI,kBAAkB,EAAE,CAAC;oBAC7C,MAAM,GAAG,MAAM,WAAW,CAAC,MAAM,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;gBAC3D,CAAC;gBAGD,OAAO;oBACL,GAAI,MAAkC;oBACtC,WAAW,EAAE;wBACX,KAAK,EAAE,GAAG,CAAC,MAAM;wBACjB,SAAS,EAAE,GAAG,CAAC,SAAS;qBACzB;iBACF,CAAC;YACJ,CAAC,CAAC,CACH,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;YAE7C,MAAM,MAAM,GAA2D,EAAE,CAAC;YAC1E,IAAI,QAAQ,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;gBAC/B,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;oBACtD,IAAI,GAAG,KAAK,cAAc,EAAE,CAAC;wBAC3B,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,GAAG,CAA0C,CAAC;wBACvF,IAAI,GAAG,EAAE,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;4BAC/C,MAAM,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;gCACzC,IAAI,EAAE,MAAM,CAAC,GAAG;gCAChB,KAAK,EAAE,MAAM,CAAC,SAAS;6BACxB,CAAC,CAAC,CAAC;wBACN,CAAC;oBACH,CAAC;gBACH,CAAC,CAAC,CAAC;YACL,CAAC;YAED,IAAI,WAA+C,CAAC;YACpD,IAAI,QAAQ,CAAC,IAAI,CAAC,YAAY,EAAE,YAAY,EAAE,CAAC;gBAC7C,MAAM,UAAU,GAAG,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,YAAqD,CAAC;gBACpG,IAAI,UAAU,EAAE,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;oBAC7D,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;wBACpC,WAAW,KAAK,EAAE,CAAC;wBACnB,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC;oBAC7C,CAAC,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;YAGD,MAAM,KAAK,GACT,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,QAAQ;gBAC1C,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK;gBAC1B,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,IAAI,CAAC,CAAC;YAE3C,MAAM,MAAM,GAAG;gBACb,KAAK;gBACL,UAAU,EAAE,QAAQ,CAAC,IAAI,CAAC,IAAI;gBAC9B,QAAQ;gBACR,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;gBAC3D,WAAW;aACZ,CAAC;YAEF,OAAO,MAAM,CAAC;QAChB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,GAAG,GAAG,KAAc,CAAC;YAG3B,IAAI,YAAY,IAAI,GAAG,IAAK,GAA8B,CAAC,UAAU,KAAK,GAAG,EAAE,CAAC;gBAC9E,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,yBAAyB,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;gBAEzD,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;YACtE,CAAC;YAED,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,iBAAiB,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;YAElD,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC,CAAC;QACpE,CAAC;IACH,CAAC,CACF,CAAC;AACJ,CAAC,CAAC;AAEF,eAAe,MAAM,CAAC"}
1
+ {"version":3,"file":"search.js","sourceRoot":"","sources":["../../src/routes/search.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAGL,gBAAgB,GAGjB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,iBAAiB,EACjB,iBAAiB,EACjB,aAAa,EACb,YAAY,GAEb,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAIlF,OAAO,EAAE,WAAW,EAAE,qBAAqB,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAErF,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IAClC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;IAC1D,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,iBAAiB,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;IAC5D,WAAW,EAAE,iBAAiB,CAAC,QAAQ,EAAE;IACzC,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC5D,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC;IACrD,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;IAC1C,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC;IACrC,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;CAC9C,CAAC,CAAC;AAcH,MAAM,YAAY,GAAG,CAAC,WAAoC,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAc,EAAE,EAAE;IAC/F,IAAI,CAAC,WAAW,IAAI,CAAC,QAAQ,IAAI,OAAO,CAAC,EAAE,CAAC;QAC1C,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,MAAM,EAAE,SAAS,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,GAAG,WAAW,CAAC;IAE9C,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;AACzD,CAAC,CAAC;AAEF,MAAM,MAAM,GAA2C,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE;IAC7E,MAAM,EACJ,MAAM,EACN,MAAM,EAAE,OAAO,EACf,MAAM,EACN,kBAAkB,GAAG,EAAE,EACvB,sBAAsB,EACtB,sBAAsB,GACvB,GAAG,IAAI,CAAC;IACT,MAAM,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC;IACjC,MAAM,QAAQ,GAAG,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;IAEhG,MAAM,UAAU,GAAG,CAAC,EAAE,UAAU,EAAE,IAAI,EAAgB,EAAE,EAAE;QACxD,MAAM,KAAK,GAAgB,EAAE,CAAC;QAC9B,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,WAAW,EAAE,UAAU,CAAC,EAAE,CAAC;YACzD,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,aAAa,EAAE,OAAO,EAAE,GAAG,UAAU,yBAAyB,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC;QAC3G,CAAC;QACD,IAAI,IAAI,KAAK,WAAW,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC;YACrE,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,IAAI,wBAAwB,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QACxF,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;IAEF,OAAO,CAAC,gBAAgB,EAAmB,CAAC,IAAI,CAC9C,SAAS,EACT;QACE,MAAM,EAAE;YACN,IAAI,EAAE,kBAAkB;SACzB;KACF,EACD,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE;QACvB,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,GAAG,YAAY,CAAC,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzG,MAAM,QAAQ,GAAG;YACf,GAAG,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC;YAC3B,GAAG,cAAc;YACjB,GAAG,aAAa,CAAC,YAAY,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,CAAC;SACjD,CAAC;QACF,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,oCAAoC,EAAE,QAAQ,CAAC,CAAC,CAAC;QACrG,CAAC;QAED,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,EAAE,WAAW,EAAE,gBAAgB,EAAE,GAAG,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;QAEjG,MAAM,WAAW,GAAG,cAAc,CAAC,UAAU,EAAE,KAAK,EAAE,YAAY,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,IAAI,EAAE,CAAC,CAAC;QACvG,IAAI,SAAS,IAAI,WAAW,EAAE,CAAC;YAC7B,MAAM,EAAE,OAAO,EAAE,GAAG,WAAW,CAAC;YAEhC,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;QACtG,CAAC;QAED,MAAM,OAAO,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;QAErC,MAAM,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC,CAAC;QACzE,eAAe,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QACvC,MAAM,UAAU,GAAG,MAAM,sBAAsB,CAAC,OAAO,CAAC,CAAC;QAEzD,MAAM,aAAa,GAAkB;YACnC,GAAG,WAAW;YACd,OAAO;YACP,GAAG,CAAC,WAAW,IAAI,EAAE,WAAW,EAAE,CAAC;YACnC,GAAG,CAAC,gBAAgB,KAAK,SAAS,IAAI,EAAE,gBAAgB,EAAE,CAAC;YAC3D,GAAG,MAAM;YACT,UAAU;SACX,CAAC;QAEF,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QAChC,IAAI,MAAoB,CAAC;QACzB,IAAI,CAAC;YACH,MAAM,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;QACxD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,eAAe,CAAC,KAAK,CAAC,CAAC,eAAwB,EAAE,EAAE;gBACvD,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,uBAAuB,CAAC,CAAC;gBAC3D,MAAM,eAAe,CAAC;YACxB,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,CAAC,KAAK,YAAY,gBAAgB,CAAC,EAAE,CAAC;gBACzC,MAAM,KAAK,CAAC;YACd,CAAC;YAED,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,yBAAyB,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;YAE3D,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,gBAAgB,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;QACxF,CAAC;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,CAAC;QAEzD,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC;YAC9C,KAAK,EAAE;gBACL,GAAG,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,MAAM,eAAe,CAAC;aAC9E;SACF,CAAC,CAAC;QAEH,MAAM,kBAAkB,GAAG,MAAM,iBAAiB,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QACxF,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAE9G,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,CAChC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE,WAAW,EAAE,EAAE,EAAE;YAC5C,MAAM,KAAK,GAAG,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAChC,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,qEAAqE,CAAC,CAAC;gBAEpG,OAAO,IAAI,CAAC;YACd,CAAC;YAED,MAAM,WAAW,GAAG,MAAM,iBAAiB,CAAC,KAAK,CAAC,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;YAClG,MAAM,KAAK,GAAG,YAAY,CAAC,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YAE7D,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,GAAI,WAAsB,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC;QAChG,CAAC,CAAC,CACH,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC;QAEjE,OAAO;YACL,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,UAAU;YACV,QAAQ;YACR,MAAM,EAAE,EAAE,GAAG,QAAQ,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE;YACzC,GAAG,CAAC,MAAM,CAAC,WAAW,IAAI,EAAE,WAAW,EAAE,MAAM,CAAC,WAAW,EAAE,CAAC;SAC/D,CAAC;IACJ,CAAC,CACF,CAAC;AACJ,CAAC,CAAC;AAEF,eAAe,MAAM,CAAC"}
@@ -0,0 +1,8 @@
1
+ import { type SearchQuery } from './backend.js';
2
+ export declare const normaliseQuery: (searchType: 'basic' | 'advanced', query: string, advancedFields: Record<string, unknown>) => SearchQuery | {
3
+ problem: string;
4
+ };
5
+ export declare const matchedDateSpan: (field: string, value: string) => {
6
+ first: Date;
7
+ last: Date;
8
+ };
@@ -0,0 +1,198 @@
1
+ import { SearchQueryError } from './backend.js';
2
+ import { dateSpan } from './fields.js';
3
+ const MAX_QUERY_LENGTH = 1024;
4
+ const MAX_DEPTH = 10;
5
+ const MAX_CLAUSES = 64;
6
+ class InvalidQueryError extends Error {
7
+ name = 'InvalidQueryError';
8
+ }
9
+ const OPERATORS = ['AND', 'OR', 'NOT'];
10
+ const PUNCTUATION = ['(', ')', ':'];
11
+ const isSpace = (char) => /\s/u.test(char);
12
+ const endsWord = (char) => isSpace(char) || PUNCTUATION.includes(char) || char === '"';
13
+ const tokenise = (chars) => {
14
+ const tokens = [];
15
+ let at = 0;
16
+ while (at < chars.length) {
17
+ const char = chars[at];
18
+ const position = at + 1;
19
+ if (isSpace(char)) {
20
+ at++;
21
+ }
22
+ else if (PUNCTUATION.includes(char)) {
23
+ tokens.push({ kind: char, text: char, position });
24
+ at++;
25
+ }
26
+ else if (char === '"') {
27
+ const close = chars.indexOf('"', at + 1);
28
+ if (close === -1) {
29
+ throw new InvalidQueryError(`Expected a closing " for the phrase at position ${position}, found the end of the query`);
30
+ }
31
+ tokens.push({ kind: 'phrase', text: chars.slice(at + 1, close).join(''), position });
32
+ at = close + 1;
33
+ }
34
+ else {
35
+ const start = at;
36
+ while (at < chars.length && !endsWord(chars[at])) {
37
+ at++;
38
+ }
39
+ const text = chars.slice(start, at).join('');
40
+ tokens.push({ kind: OPERATORS.includes(text) ? text : 'word', text, position });
41
+ }
42
+ }
43
+ tokens.push({ kind: 'end', text: '', position: chars.length + 1 });
44
+ return tokens;
45
+ };
46
+ const describe = ({ kind, text }) => {
47
+ switch (kind) {
48
+ case 'end':
49
+ return 'the end of the query';
50
+ case 'phrase':
51
+ return `the phrase "${text}"`;
52
+ case 'word':
53
+ return `"${text}"`;
54
+ default:
55
+ return kind.length === 1 ? `"${kind}"` : kind;
56
+ }
57
+ };
58
+ const combine = (type, parts) => parts.length === 1
59
+ ? parts[0]
60
+ : { type, clauses: parts.flatMap((part) => (part.type === type ? part.clauses : [part])) };
61
+ const parse = (query, fields) => {
62
+ const tokens = tokenise([...query]);
63
+ let at = 0;
64
+ const peek = (offset = 0) => tokens[at + offset];
65
+ const fail = (expected) => {
66
+ throw new InvalidQueryError(`Expected ${expected} at position ${peek().position}, found ${describe(peek())}`);
67
+ };
68
+ const expect = (kind, expected) => {
69
+ if (peek().kind !== kind) {
70
+ fail(expected);
71
+ }
72
+ at++;
73
+ };
74
+ const parseOr = (field) => {
75
+ const parts = [parseAnd(field)];
76
+ while (peek().kind === 'OR') {
77
+ at++;
78
+ parts.push(parseAnd(field));
79
+ }
80
+ return combine('or', parts);
81
+ };
82
+ const parseAnd = (field) => {
83
+ const parts = [parseUnary(field)];
84
+ while (peek().kind === 'AND') {
85
+ at++;
86
+ parts.push(parseUnary(field));
87
+ }
88
+ return combine('and', parts);
89
+ };
90
+ const parseUnary = (field) => {
91
+ if (peek().kind === 'NOT') {
92
+ at++;
93
+ return { type: 'not', clause: parseUnary(field) };
94
+ }
95
+ return parsePrimary(field);
96
+ };
97
+ const parseBracketed = (field) => {
98
+ at++;
99
+ const clause = parseOr(field);
100
+ expect(')', 'AND, OR or ")"');
101
+ return clause;
102
+ };
103
+ const parsePrimary = (field) => {
104
+ if (peek().kind === '(') {
105
+ return parseBracketed(field);
106
+ }
107
+ if (field !== undefined) {
108
+ return parseValue(field);
109
+ }
110
+ const name = peek();
111
+ if (name.kind !== 'word') {
112
+ fail('a field name');
113
+ }
114
+ at++;
115
+ expect(':', `":" after the field name "${name.text}"`);
116
+ if (!Object.hasOwn(fields, name.text)) {
117
+ throw new InvalidQueryError(`"${name.text}" at position ${name.position} isn't a declared advanced field`);
118
+ }
119
+ return peek().kind === '(' ? parseBracketed(name.text) : parseValue(name.text);
120
+ };
121
+ const startsValueWord = () => peek().kind === 'word' && peek(1).kind !== ':';
122
+ const parseValue = (field) => {
123
+ if (peek().kind === 'phrase') {
124
+ const { text } = peek();
125
+ at++;
126
+ return { type: 'match', field, value: text, phrase: true };
127
+ }
128
+ if (!startsValueWord()) {
129
+ fail(`a value for "${field}"`);
130
+ }
131
+ const words = [];
132
+ while (startsValueWord()) {
133
+ words.push(peek().text);
134
+ at++;
135
+ }
136
+ return { type: 'match', field, value: words.join(' '), phrase: false };
137
+ };
138
+ const tree = parseOr();
139
+ expect('end', 'AND, OR or the end of the query');
140
+ return tree;
141
+ };
142
+ const depthOf = (query) => {
143
+ switch (query.type) {
144
+ case 'and':
145
+ case 'or':
146
+ return 1 + Math.max(...query.clauses.map(depthOf));
147
+ case 'not':
148
+ return 1 + depthOf(query.clause);
149
+ default:
150
+ return 0;
151
+ }
152
+ };
153
+ const clausesIn = (query) => {
154
+ switch (query.type) {
155
+ case 'and':
156
+ case 'or':
157
+ return query.clauses.reduce((sum, clause) => sum + clausesIn(clause), 0);
158
+ case 'not':
159
+ return clausesIn(query.clause);
160
+ default:
161
+ return 1;
162
+ }
163
+ };
164
+ const parseWithinCaps = (query, advancedFields) => {
165
+ const tree = parse(query, advancedFields);
166
+ if (depthOf(tree) > MAX_DEPTH) {
167
+ throw new InvalidQueryError(`The query nests deeper than the limit of ${MAX_DEPTH} levels`);
168
+ }
169
+ if (clausesIn(tree) > MAX_CLAUSES) {
170
+ throw new InvalidQueryError(`The query has more than the limit of ${MAX_CLAUSES} clauses`);
171
+ }
172
+ return tree;
173
+ };
174
+ export const normaliseQuery = (searchType, query, advancedFields) => {
175
+ if ([...query].length > MAX_QUERY_LENGTH) {
176
+ return { problem: `The query is longer than the limit of ${MAX_QUERY_LENGTH} characters` };
177
+ }
178
+ if (searchType === 'basic') {
179
+ return { searchType, query };
180
+ }
181
+ if (query.trim() === '') {
182
+ return { searchType, query: { type: 'all' } };
183
+ }
184
+ try {
185
+ return { searchType, query: parseWithinCaps(query, advancedFields) };
186
+ }
187
+ catch (error) {
188
+ return { problem: error.message };
189
+ }
190
+ };
191
+ export const matchedDateSpan = (field, value) => {
192
+ const span = dateSpan(value);
193
+ if (!span) {
194
+ throw new SearchQueryError(`"${field}" is a date field: "${value}" isn't a date`);
195
+ }
196
+ return span;
197
+ };
198
+ //# sourceMappingURL=advanced.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"advanced.js","sourceRoot":"","sources":["../../src/search/advanced.ts"],"names":[],"mappings":"AAAA,OAAO,EAAwC,gBAAgB,EAAE,MAAM,cAAc,CAAC;AACtF,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAGvC,MAAM,gBAAgB,GAAG,IAAI,CAAC;AAC9B,MAAM,SAAS,GAAG,EAAE,CAAC;AAErB,MAAM,WAAW,GAAG,EAAE,CAAC;AAEvB,MAAM,iBAAkB,SAAQ,KAAK;IAC1B,IAAI,GAAG,mBAAmB,CAAC;CACrC;AASD,MAAM,SAAS,GAAsB,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;AAC1D,MAAM,WAAW,GAAsB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AAEvD,MAAM,OAAO,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACnD,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI,KAAK,GAAG,CAAC;AAE/F,MAAM,QAAQ,GAAG,CAAC,KAAe,EAAE,EAAE;IACnC,MAAM,MAAM,GAAY,EAAE,CAAC;IAC3B,IAAI,EAAE,GAAG,CAAC,CAAC;IAEX,OAAO,EAAE,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;QACzB,MAAM,IAAI,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC;QACvB,MAAM,QAAQ,GAAG,EAAE,GAAG,CAAC,CAAC;QAExB,IAAI,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YAClB,EAAE,EAAE,CAAC;QACP,CAAC;aAAM,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACtC,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAqB,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;YACnE,EAAE,EAAE,CAAC;QACP,CAAC;aAAM,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;YACxB,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,GAAG,CAAC,CAAC,CAAC;YACzC,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;gBACjB,MAAM,IAAI,iBAAiB,CACzB,mDAAmD,QAAQ,8BAA8B,CAC1F,CAAC;YACJ,CAAC;YACD,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;YACrF,EAAE,GAAG,KAAK,GAAG,CAAC,CAAC;QACjB,CAAC;aAAM,CAAC;YACN,MAAM,KAAK,GAAG,EAAE,CAAC;YACjB,OAAO,EAAE,GAAG,KAAK,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;gBACjD,EAAE,EAAE,CAAC;YACP,CAAC;YACD,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YAC7C,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAE,IAAsB,CAAC,CAAC,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;QACrG,CAAC;IACH,CAAC;IAED,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,QAAQ,EAAE,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,CAAC;IAEnE,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAG,CAAC,EAAE,IAAI,EAAE,IAAI,EAAS,EAAE,EAAE;IACzC,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,KAAK;YACR,OAAO,sBAAsB,CAAC;QAChC,KAAK,QAAQ;YACX,OAAO,eAAe,IAAI,GAAG,CAAC;QAChC,KAAK,MAAM;YACT,OAAO,IAAI,IAAI,GAAG,CAAC;QACrB;YACE,OAAO,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC;IAClD,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,OAAO,GAAG,CAAC,IAAkB,EAAE,KAAsB,EAAiB,EAAE,CAC5E,KAAK,CAAC,MAAM,KAAK,CAAC;IAChB,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IACV,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;AAE/F,MAAM,KAAK,GAAG,CAAC,KAAa,EAAE,MAA+B,EAAiB,EAAE;IAC9E,MAAM,MAAM,GAAG,QAAQ,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC;IACpC,IAAI,EAAE,GAAG,CAAC,CAAC;IAEX,MAAM,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,GAAG,MAAM,CAAC,CAAC;IACjD,MAAM,IAAI,GAAG,CAAC,QAAgB,EAAS,EAAE;QACvC,MAAM,IAAI,iBAAiB,CAAC,YAAY,QAAQ,gBAAgB,IAAI,EAAE,CAAC,QAAQ,WAAW,QAAQ,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC;IAChH,CAAC,CAAC;IACF,MAAM,MAAM,GAAG,CAAC,IAAmB,EAAE,QAAgB,EAAE,EAAE;QACvD,IAAI,IAAI,EAAE,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;YACzB,IAAI,CAAC,QAAQ,CAAC,CAAC;QACjB,CAAC;QACD,EAAE,EAAE,CAAC;IACP,CAAC,CAAC;IAGF,MAAM,OAAO,GAAG,CAAC,KAAc,EAAiB,EAAE;QAChD,MAAM,KAAK,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;QAChC,OAAO,IAAI,EAAE,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;YAC5B,EAAE,EAAE,CAAC;YACL,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;QAC9B,CAAC;QAED,OAAO,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC9B,CAAC,CAAC;IAEF,MAAM,QAAQ,GAAG,CAAC,KAAc,EAAiB,EAAE;QACjD,MAAM,KAAK,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;QAClC,OAAO,IAAI,EAAE,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;YAC7B,EAAE,EAAE,CAAC;YACL,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;QAChC,CAAC;QAED,OAAO,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IAC/B,CAAC,CAAC;IAEF,MAAM,UAAU,GAAG,CAAC,KAAc,EAAiB,EAAE;QACnD,IAAI,IAAI,EAAE,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;YAC1B,EAAE,EAAE,CAAC;YAEL,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;QACpD,CAAC;QAED,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC;IAC7B,CAAC,CAAC;IAEF,MAAM,cAAc,GAAG,CAAC,KAAc,EAAE,EAAE;QACxC,EAAE,EAAE,CAAC;QACL,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;QAC9B,MAAM,CAAC,GAAG,EAAE,gBAAgB,CAAC,CAAC;QAE9B,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;IAEF,MAAM,YAAY,GAAG,CAAC,KAAc,EAAiB,EAAE;QACrD,IAAI,IAAI,EAAE,CAAC,IAAI,KAAK,GAAG,EAAE,CAAC;YACxB,OAAO,cAAc,CAAC,KAAK,CAAC,CAAC;QAC/B,CAAC;QACD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,UAAU,CAAC,KAAK,CAAC,CAAC;QAC3B,CAAC;QAED,MAAM,IAAI,GAAG,IAAI,EAAE,CAAC;QACpB,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;YACzB,IAAI,CAAC,cAAc,CAAC,CAAC;QACvB,CAAC;QACD,EAAE,EAAE,CAAC;QACL,MAAM,CAAC,GAAG,EAAE,6BAA6B,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC;QACvD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACtC,MAAM,IAAI,iBAAiB,CAAC,IAAI,IAAI,CAAC,IAAI,iBAAiB,IAAI,CAAC,QAAQ,kCAAkC,CAAC,CAAC;QAC7G,CAAC;QAED,OAAO,IAAI,EAAE,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjF,CAAC,CAAC;IAEF,MAAM,eAAe,GAAG,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,KAAK,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,GAAG,CAAC;IAE7E,MAAM,UAAU,GAAG,CAAC,KAAa,EAAiB,EAAE;QAClD,IAAI,IAAI,EAAE,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,CAAC;YACxB,EAAE,EAAE,CAAC;YAEL,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;QAC7D,CAAC;QAED,IAAI,CAAC,eAAe,EAAE,EAAE,CAAC;YACvB,IAAI,CAAC,gBAAgB,KAAK,GAAG,CAAC,CAAC;QACjC,CAAC;QACD,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,OAAO,eAAe,EAAE,EAAE,CAAC;YACzB,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,CAAC;YACxB,EAAE,EAAE,CAAC;QACP,CAAC;QAED,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;IACzE,CAAC,CAAC;IAEF,MAAM,IAAI,GAAG,OAAO,EAAE,CAAC;IACvB,MAAM,CAAC,KAAK,EAAE,iCAAiC,CAAC,CAAC;IAEjD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF,MAAM,OAAO,GAAG,CAAC,KAAoB,EAAU,EAAE;IAC/C,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,KAAK,KAAK,CAAC;QACX,KAAK,IAAI;YACP,OAAO,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;QACrD,KAAK,KAAK;YACR,OAAO,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACnC;YACE,OAAO,CAAC,CAAC;IACb,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,CAAC,KAAoB,EAAU,EAAE;IACjD,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,KAAK,KAAK,CAAC;QACX,KAAK,IAAI;YACP,OAAO,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,CAAC,GAAG,GAAG,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;QAC3E,KAAK,KAAK;YACR,OAAO,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACjC;YACE,OAAO,CAAC,CAAC;IACb,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,KAAa,EAAE,cAAuC,EAAiB,EAAE;IAChG,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;IAC1C,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,SAAS,EAAE,CAAC;QAC9B,MAAM,IAAI,iBAAiB,CAAC,4CAA4C,SAAS,SAAS,CAAC,CAAC;IAC9F,CAAC;IACD,IAAI,SAAS,CAAC,IAAI,CAAC,GAAG,WAAW,EAAE,CAAC;QAClC,MAAM,IAAI,iBAAiB,CAAC,wCAAwC,WAAW,UAAU,CAAC,CAAC;IAC7F,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAMF,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,UAAgC,EAChC,KAAa,EACb,cAAuC,EACJ,EAAE;IACrC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC,MAAM,GAAG,gBAAgB,EAAE,CAAC;QACzC,OAAO,EAAE,OAAO,EAAE,yCAAyC,gBAAgB,aAAa,EAAE,CAAC;IAC7F,CAAC;IACD,IAAI,UAAU,KAAK,OAAO,EAAE,CAAC;QAC3B,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC;IAC/B,CAAC;IACD,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QACxB,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;IAChD,CAAC;IAED,IAAI,CAAC;QACH,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,eAAe,CAAC,KAAK,EAAE,cAAc,CAAC,EAAE,CAAC;IACvE,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QAEf,OAAO,EAAE,OAAO,EAAG,KAA2B,CAAC,OAAO,EAAE,CAAC;IAC3D,CAAC;AACH,CAAC,CAAC;AAKF,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,KAAa,EAAE,KAAa,EAAE,EAAE;IAC9D,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC7B,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,MAAM,IAAI,gBAAgB,CAAC,IAAI,KAAK,uBAAuB,KAAK,gBAAgB,CAAC,CAAC;IACpF,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC,CAAC"}
@@ -0,0 +1,95 @@
1
+ import type { RequestContext } from '../types/context.js';
2
+ import type { GeoPoint, SearchDocument } from './fields.js';
3
+ import type { SearchVisibilityWhere } from './visibility.js';
4
+ type Labelled = {
5
+ label?: string;
6
+ };
7
+ export type BackendSearchCapability = {
8
+ filters: Record<string, Labelled & {
9
+ type: 'string' | 'date' | 'number' | 'boolean';
10
+ }>;
11
+ facets: Record<string, Labelled>;
12
+ sorts: Record<string, Labelled>;
13
+ searchTypes: {
14
+ basic: Record<string, never>;
15
+ advanced?: {
16
+ fields: Record<string, Labelled>;
17
+ };
18
+ };
19
+ geo: {
20
+ supported: boolean;
21
+ };
22
+ };
23
+ export type AdvancedQuery = {
24
+ type: 'and' | 'or';
25
+ clauses: AdvancedQuery[];
26
+ } | {
27
+ type: 'not';
28
+ clause: AdvancedQuery;
29
+ } | {
30
+ type: 'match';
31
+ field: string;
32
+ value: string;
33
+ phrase: boolean;
34
+ } | {
35
+ type: 'all';
36
+ };
37
+ export type RangeBound = number | Date;
38
+ export type RangeFilter = {
39
+ gte?: RangeBound;
40
+ lte?: RangeBound;
41
+ };
42
+ export type BoundingBox = {
43
+ topRight: GeoPoint;
44
+ bottomLeft: GeoPoint;
45
+ };
46
+ export type SearchQuery = {
47
+ searchType: 'basic';
48
+ query: string;
49
+ } | {
50
+ searchType: 'advanced';
51
+ query: AdvancedQuery;
52
+ };
53
+ export type SearchRequest = SearchQuery & {
54
+ filters: {
55
+ terms: Record<string, string[]>;
56
+ ranges: Record<string, RangeFilter[]>;
57
+ };
58
+ boundingBox?: BoundingBox;
59
+ geohashPrecision?: number;
60
+ limit: number;
61
+ offset: number;
62
+ sort: string;
63
+ order: 'asc' | 'desc';
64
+ visibility: SearchVisibilityWhere;
65
+ };
66
+ export type SearchExtra = {
67
+ score?: number;
68
+ highlight?: Record<string, string[]>;
69
+ };
70
+ export type FacetBucket = {
71
+ name: string;
72
+ count: number;
73
+ };
74
+ export declare const GEOHASH_GRID_CELLS = 10000;
75
+ export type SearchResult = {
76
+ total: number;
77
+ hits: {
78
+ id: string;
79
+ searchExtra?: SearchExtra;
80
+ }[];
81
+ facets?: Record<string, FacetBucket[]>;
82
+ geohashGrid?: Record<string, number>;
83
+ };
84
+ export interface SearchBackend {
85
+ readonly capabilities: BackendSearchCapability;
86
+ search(request: SearchRequest, context: RequestContext): Promise<SearchResult>;
87
+ index(docs: SearchDocument[], options?: {
88
+ tx?: unknown;
89
+ }): Promise<void>;
90
+ remove(ids: string[]): Promise<void>;
91
+ }
92
+ export declare class SearchQueryError extends Error {
93
+ name: string;
94
+ }
95
+ export {};
@@ -0,0 +1,5 @@
1
+ export const GEOHASH_GRID_CELLS = 10_000;
2
+ export class SearchQueryError extends Error {
3
+ name = 'SearchQueryError';
4
+ }
5
+ //# sourceMappingURL=backend.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"backend.js","sourceRoot":"","sources":["../../src/search/backend.ts"],"names":[],"mappings":"AA6DA,MAAM,CAAC,MAAM,kBAAkB,GAAG,MAAM,CAAC;AA2BzC,MAAM,OAAO,gBAAiB,SAAQ,KAAK;IAChC,IAAI,GAAG,kBAAkB,CAAC;CACpC"}
@@ -0,0 +1,63 @@
1
+ import type { BackendSearchCapability } from './backend.js';
2
+ export type FieldType = 'text' | 'keyword' | 'date' | 'number' | 'boolean' | 'geo';
3
+ export type FieldDeclaration = {
4
+ type: FieldType;
5
+ label?: string;
6
+ weight?: number;
7
+ basic?: boolean;
8
+ advanced?: boolean;
9
+ filter?: boolean;
10
+ facet?: boolean | {
11
+ size: number;
12
+ };
13
+ sort?: boolean;
14
+ };
15
+ export type FieldDeclarations = Record<string, FieldDeclaration>;
16
+ export declare const capabilitiesFromFields: (fields: FieldDeclarations) => BackendSearchCapability;
17
+ export declare const isBasic: ({ type, basic }: FieldDeclaration) => boolean;
18
+ export declare const resolveFields: (fields: FieldDeclarations) => {
19
+ basic: {
20
+ name: string;
21
+ type: FieldType;
22
+ weight: number;
23
+ }[];
24
+ facets: {
25
+ name: string;
26
+ type: FieldType;
27
+ size: number;
28
+ }[];
29
+ geoField: string | undefined;
30
+ };
31
+ export declare const withId: (fields: FieldDeclarations) => FieldDeclarations;
32
+ export type GeoPoint = {
33
+ lat: number;
34
+ lng: number;
35
+ };
36
+ type ScalarOf<Type extends FieldType> = Type extends 'number' ? number : Type extends 'boolean' ? boolean : Type extends 'geo' ? GeoPoint : string;
37
+ type ValueOf<Declaration extends FieldDeclaration> = Declaration['type'] extends 'geo' ? GeoPoint : Declaration extends {
38
+ sort: true;
39
+ } ? ScalarOf<Declaration['type']> : ScalarOf<Declaration['type']> | ScalarOf<Declaration['type']>[];
40
+ export type SearchDocument<Fields extends FieldDeclarations = FieldDeclarations> = {
41
+ id: string;
42
+ } & {
43
+ -readonly [Name in keyof Fields]?: ValueOf<Fields[Name]>;
44
+ };
45
+ export type Scalar = string | number | boolean | Date;
46
+ export declare const toWire: (value: Scalar) => string | number | boolean;
47
+ type StoredSearchDocument = {
48
+ id: string;
49
+ values: Record<string, Scalar | Scalar[]>;
50
+ point?: GeoPoint;
51
+ };
52
+ export declare const dateSpan: (value: string) => {
53
+ first: Date;
54
+ last: Date;
55
+ } | undefined;
56
+ export declare const DATE_FORMS = "a YYYY, YYYY-MM, YYYY-MM-DD or RFC 3339 date";
57
+ export declare const storeScalar: (type: FieldType, value: unknown) => {
58
+ value: Scalar | GeoPoint;
59
+ } | {
60
+ problem: string;
61
+ };
62
+ export declare const storeDocuments: (fields: FieldDeclarations, docs: SearchDocument[]) => StoredSearchDocument[];
63
+ export {};
@@ -0,0 +1,203 @@
1
+ const FIELD_NAME = /^[A-Za-z_][A-Za-z0-9_]*$/;
2
+ const RESERVED = ['id', 'AND', 'OR', 'NOT'];
3
+ const FIELD_TYPES = ['text', 'keyword', 'date', 'number', 'boolean', 'geo'];
4
+ const isPositiveInteger = (value) => Number.isInteger(value) && value > 0;
5
+ const checkDeclaration = (name, declaration) => {
6
+ if (!FIELD_NAME.test(name)) {
7
+ return `must match ${FIELD_NAME}`;
8
+ }
9
+ if (RESERVED.includes(name)) {
10
+ return 'is reserved';
11
+ }
12
+ const { type, weight, facet } = declaration;
13
+ if (!FIELD_TYPES.includes(type)) {
14
+ return `has unknown type "${type}"`;
15
+ }
16
+ if (type === 'geo') {
17
+ const role = ['basic', 'advanced', 'filter', 'facet', 'sort'].find((r) => declaration[r]);
18
+ if (role) {
19
+ return `is a geo field, which can't have the ${role} role`;
20
+ }
21
+ }
22
+ if (name === 'relevance' && declaration.sort) {
23
+ return "can't be a sort field, as relevance is always a sort";
24
+ }
25
+ if (weight !== undefined && (type !== 'text' || !isPositiveInteger(weight) || weight > 4)) {
26
+ return 'has a bad weight: only a text field has one, from 1 to 4';
27
+ }
28
+ if (typeof facet === 'object' && !isPositiveInteger(facet.size)) {
29
+ return 'has a bad facet size: it must be a positive integer';
30
+ }
31
+ if (facet && type === 'number') {
32
+ return "is a number field, which can't be a facet";
33
+ }
34
+ if (declaration.basic && type !== 'text' && type !== 'keyword') {
35
+ return `is a ${type} field, which can't be in basic search`;
36
+ }
37
+ return undefined;
38
+ };
39
+ const validateFields = (fields) => {
40
+ let geoField;
41
+ for (const [name, declaration] of Object.entries(fields)) {
42
+ const problem = checkDeclaration(name, declaration);
43
+ if (problem) {
44
+ throw new Error(`Search field "${name}" ${problem}`);
45
+ }
46
+ if (declaration.type === 'geo') {
47
+ if (geoField) {
48
+ throw new Error(`Search field "${name}" is a second geo field, after "${geoField}": only one is allowed`);
49
+ }
50
+ geoField = name;
51
+ }
52
+ }
53
+ };
54
+ export const capabilitiesFromFields = (fields) => {
55
+ validateFields(fields);
56
+ const declared = Object.entries(fields);
57
+ const publish = (hasRole, describe = () => ({})) => Object.fromEntries(declared
58
+ .filter(([, declaration]) => hasRole(declaration))
59
+ .map(([name, declaration]) => [
60
+ name,
61
+ { ...describe(declaration), ...(declaration.label !== undefined && { label: declaration.label }) },
62
+ ]));
63
+ const advanced = publish(({ advanced }) => advanced);
64
+ return {
65
+ filters: publish(({ filter, facet }) => filter || facet, ({ type }) => ({
66
+ type: type === 'text' || type === 'keyword' ? 'string' : type,
67
+ })),
68
+ facets: publish(({ facet }) => facet),
69
+ sorts: publish(({ sort }) => sort),
70
+ searchTypes: { basic: {}, ...(Object.keys(advanced).length > 0 && { advanced: { fields: advanced } }) },
71
+ geo: { supported: declared.some(([, { type }]) => type === 'geo') },
72
+ };
73
+ };
74
+ const DEFAULT_FACET_SIZE = 20;
75
+ export const isBasic = ({ type, basic }) => (type === 'text' ? basic !== false : Boolean(basic));
76
+ export const resolveFields = (fields) => {
77
+ const declared = Object.entries(fields);
78
+ return {
79
+ basic: declared
80
+ .filter(([, declaration]) => isBasic(declaration))
81
+ .map(([name, { type, weight = 1 }]) => ({ name, type, weight })),
82
+ facets: declared
83
+ .filter(([, { facet }]) => facet)
84
+ .map(([name, { type, facet }]) => ({
85
+ name,
86
+ type,
87
+ size: typeof facet === 'object' ? facet.size : DEFAULT_FACET_SIZE,
88
+ })),
89
+ geoField: declared.find(([, { type }]) => type === 'geo')?.[0],
90
+ };
91
+ };
92
+ export const withId = (fields) => ({ ...fields, id: { type: 'keyword' } });
93
+ export const toWire = (value) => (value instanceof Date ? value.toISOString() : value);
94
+ const DATE = /^(\d{4})(?:-(\d{2})(?:-(\d{2})(?:[Tt ](\d{2}):(\d{2}):(\d{2})(?:\.(\d+))?([Zz]|[+-]\d{2}:\d{2})?)?)?)?$/;
95
+ const parseDate = (value) => {
96
+ const match = DATE.exec(value);
97
+ if (!match) {
98
+ return undefined;
99
+ }
100
+ const [, year, month = '01', day = '01', hour = '00', minute = '00', second = '00', fraction = '', offset = 'Z'] = match;
101
+ const parts = [year, month, day, hour, minute, second].map(Number);
102
+ const date = new Date(0);
103
+ date.setUTCFullYear(parts[0], parts[1] - 1, parts[2]);
104
+ date.setUTCHours(parts[3], parts[4], parts[5], Number(fraction.padEnd(3, '0').slice(0, 3)));
105
+ const stored = [
106
+ date.getUTCFullYear(),
107
+ date.getUTCMonth() + 1,
108
+ date.getUTCDate(),
109
+ date.getUTCHours(),
110
+ date.getUTCMinutes(),
111
+ date.getUTCSeconds(),
112
+ ];
113
+ if (stored.some((part, index) => part !== parts[index])) {
114
+ return undefined;
115
+ }
116
+ if (offset.toUpperCase() !== 'Z') {
117
+ const [offsetHours, offsetMinutes] = offset.slice(1).split(':').map(Number);
118
+ if (offsetHours > 23 || offsetMinutes > 59) {
119
+ return undefined;
120
+ }
121
+ const sign = offset.startsWith('-') ? -1 : 1;
122
+ date.setTime(date.getTime() - sign * (offsetHours * 60 + offsetMinutes) * 60_000);
123
+ }
124
+ return date;
125
+ };
126
+ export const dateSpan = (value) => {
127
+ const first = parseDate(value);
128
+ if (!first) {
129
+ return undefined;
130
+ }
131
+ const [, , month, day, hour] = DATE.exec(value);
132
+ if (hour !== undefined) {
133
+ return { first, last: first };
134
+ }
135
+ const next = new Date(first);
136
+ if (day !== undefined) {
137
+ next.setUTCDate(next.getUTCDate() + 1);
138
+ }
139
+ else if (month !== undefined) {
140
+ next.setUTCMonth(next.getUTCMonth() + 1);
141
+ }
142
+ else {
143
+ next.setUTCFullYear(next.getUTCFullYear() + 1);
144
+ }
145
+ return { first, last: new Date(next.getTime() - 1) };
146
+ };
147
+ const isGeoPoint = (value) => {
148
+ if (typeof value !== 'object' || value === null || Object.keys(value).length !== 2) {
149
+ return false;
150
+ }
151
+ const { lat, lng } = value;
152
+ return typeof lat === 'number' && typeof lng === 'number' && Math.abs(lat) <= 90 && Math.abs(lng) <= 180;
153
+ };
154
+ export const DATE_FORMS = 'a YYYY, YYYY-MM, YYYY-MM-DD or RFC 3339 date';
155
+ export const storeScalar = (type, value) => {
156
+ switch (type) {
157
+ case 'text':
158
+ case 'keyword':
159
+ return typeof value === 'string' ? { value } : { problem: 'must be a string' };
160
+ case 'date': {
161
+ const date = typeof value === 'string' ? parseDate(value) : undefined;
162
+ return date ? { value: date } : { problem: `must be ${DATE_FORMS}` };
163
+ }
164
+ case 'number':
165
+ return typeof value === 'number' && Number.isFinite(value) ? { value } : { problem: 'must be a finite number' };
166
+ case 'boolean':
167
+ return typeof value === 'boolean' ? { value } : { problem: 'must be a boolean' };
168
+ case 'geo':
169
+ return isGeoPoint(value)
170
+ ? { value }
171
+ : { problem: 'must be { lat, lng } with lat from -90 to 90 and lng from -180 to 180' };
172
+ }
173
+ };
174
+ export const storeDocuments = (fields, docs) => docs.map(({ id, ...rest }) => {
175
+ if (typeof id !== 'string' || id === '') {
176
+ throw new Error('Search document has no id');
177
+ }
178
+ const fail = (key, problem) => {
179
+ throw new Error(`Search document "${id}": "${key}" ${problem}`);
180
+ };
181
+ const stored = { id, values: {} };
182
+ for (const [key, value] of Object.entries(rest)) {
183
+ const declaration = Object.hasOwn(fields, key) ? fields[key] : undefined;
184
+ if (!declaration) {
185
+ return fail(key, "isn't a declared field");
186
+ }
187
+ if (Array.isArray(value) && (declaration.sort || declaration.type === 'geo')) {
188
+ return fail(key, 'takes a single value, not an array');
189
+ }
190
+ const items = (Array.isArray(value) ? value : [value]).map((item) => {
191
+ const result = storeScalar(declaration.type, item);
192
+ return 'value' in result ? result.value : fail(key, `${result.problem}, not ${JSON.stringify(item)}`);
193
+ });
194
+ if (declaration.type === 'geo') {
195
+ stored.point = items[0];
196
+ }
197
+ else {
198
+ stored.values[key] = Array.isArray(value) ? items : items[0];
199
+ }
200
+ }
201
+ return stored;
202
+ });
203
+ //# sourceMappingURL=fields.js.map