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
@@ -0,0 +1,157 @@
1
+ import { join, sqltag as sql } from '@prisma/client/runtime/client';
2
+ import { SearchQueryError } from '../backend.js';
3
+ import { capabilitiesFromFields, resolveFields, storeDocuments, toWire, } from '../fields.js';
4
+ import { filtersCondition } from '../requestFilters.js';
5
+ import { checkSearchVisibility } from '../visibility.js';
6
+ import { advancedQueryFor } from './advanced.js';
7
+ import { valueBuckets, yearBuckets } from './facets.js';
8
+ import { boundingBoxCondition, geohash, geohashGrid } from './geo.js';
9
+ import { TEXT_SEARCH_CONFIG, typed } from './values.js';
10
+ import { visibilityCondition } from './visibility.js';
11
+ const WEIGHT_LABELS = ['D', 'C', 'B', 'A'];
12
+ export const PostgresBackend = ({ prisma, fields, }) => {
13
+ const capabilities = capabilitiesFromFields(fields);
14
+ const { basic, facets } = resolveFields(fields);
15
+ const textFields = Object.keys(fields).filter((name) => fields[name].type === 'text');
16
+ const basicVectors = basic.map(({ name, weight }) => sql `coalesce(setweight(to_tsvector(${TEXT_SEARCH_CONFIG}, docs."values" -> ${name}), ${WEIGHT_LABELS[weight - 1]}::"char"), '')`);
17
+ const basicVector = basicVectors.length > 0 ? join(basicVectors, ' || ') : sql `''::tsvector`;
18
+ const textVector = sql `(
19
+ SELECT coalesce(string_agg(
20
+ '''' || replace(replace(field || '.' || lexeme, '\\', '\\\\'), '''', '''''') || ''':' || array_to_string(positions, ','),
21
+ ' '
22
+ ), '')::tsvector
23
+ FROM unnest(${textFields}::text[]) AS field, unnest(to_tsvector(${TEXT_SEARCH_CONFIG}, docs."values" -> field))
24
+ )`;
25
+ const facetBuckets = facets.map(({ name, type, size }) => sql `jsonb_build_object(${name}::text, ${type === 'date' ? yearBuckets(name) : valueBuckets(name, size)})`);
26
+ const queryFor = (request) => {
27
+ if (request.searchType === 'advanced') {
28
+ return advancedQueryFor(request.query, fields);
29
+ }
30
+ if (request.query.trim() === '') {
31
+ return { condition: sql `TRUE`, rank: sql `0` };
32
+ }
33
+ const tsquery = sql `websearch_to_tsquery(${TEXT_SEARCH_CONFIG}, ${request.query}::text)`;
34
+ return {
35
+ condition: sql `(numnode(${tsquery}) = 0 OR search.basic @@ ${tsquery})`,
36
+ rank: sql `ts_rank(search.basic, ${tsquery})`,
37
+ };
38
+ };
39
+ return {
40
+ capabilities,
41
+ search: async (request) => {
42
+ const { condition: matches, rank } = queryFor(request);
43
+ const conditions = [
44
+ matches,
45
+ visibilityCondition(filtersCondition(request.filters), fields),
46
+ ...(request.boundingBox ? [boundingBoxCondition(request.boundingBox)] : []),
47
+ visibilityCondition(checkSearchVisibility(fields, request.visibility), fields),
48
+ ];
49
+ const { sort, order, geohashPrecision } = request;
50
+ const [key, direction] = sort === 'relevance'
51
+ ? [rank, sql `DESC`]
52
+ : [
53
+ typed(fields[sort].type, sql `search."values" ->> ${sort}::text`),
54
+ order === 'asc' ? sql `ASC NULLS LAST` : sql `DESC NULLS LAST`,
55
+ ];
56
+ const [result] = await asQueryErrors(prisma.$queryRaw(sql `
57
+ WITH matched AS (
58
+ SELECT search.id, search."values", search.geohash, ${key} AS key
59
+ FROM entity_search AS search
60
+ WHERE ${join(conditions, ' AND ')}
61
+ )
62
+ SELECT
63
+ (SELECT count(*)::int FROM matched) AS total,
64
+ (
65
+ SELECT coalesce(jsonb_agg(page.id ORDER BY page.key ${direction}, page.id COLLATE "C"), '[]')
66
+ FROM (
67
+ SELECT search.id, search.key
68
+ FROM matched AS search
69
+ ORDER BY search.key ${direction}, search.id COLLATE "C"
70
+ LIMIT ${request.limit}::int OFFSET ${request.offset}::int
71
+ ) AS page
72
+ ) AS hits,
73
+ ${join([sql `'{}'::jsonb`, ...facetBuckets], ' || ')} AS facets,
74
+ ${geohashPrecision === undefined ? sql `NULL` : geohashGrid(geohashPrecision)} AS "geohashGrid"
75
+ `));
76
+ return {
77
+ total: result.total,
78
+ hits: result.hits.map((id) => ({ id })),
79
+ facets: result.facets,
80
+ ...(result.geohashGrid && { geohashGrid: result.geohashGrid }),
81
+ };
82
+ },
83
+ index: async (docs, { tx } = {}) => {
84
+ const stored = storeDocuments(fields, docs);
85
+ const rows = [...new Map(stored.map((doc) => [doc.id, doc])).values()].map(({ id, values, point }) => ({
86
+ id,
87
+ values: Object.fromEntries(Object.entries(values).map(([name, value]) => [
88
+ name,
89
+ Array.isArray(value) ? value.map(toWire) : toWire(value),
90
+ ])),
91
+ ...(point && { ...point, geohash: geohash(point) }),
92
+ }));
93
+ const ids = rows.map(({ id }) => id);
94
+ const upsert = (tx ?? prisma).$queryRaw(sql `
95
+ WITH docs AS (
96
+ SELECT * FROM jsonb_to_recordset(${JSON.stringify(rows)}::jsonb)
97
+ AS docs(id text, "values" jsonb, lat float8, lng float8, geohash text)
98
+ ),
99
+ missing AS (
100
+ SELECT docs.id FROM docs WHERE NOT EXISTS (SELECT FROM entity WHERE entity.id = docs.id)
101
+ ),
102
+ upserted AS (
103
+ INSERT INTO entity_search (id, "values", basic, text, point, geohash)
104
+ SELECT docs.id, docs."values", ${basicVector}, ${textVector}, point(docs.lng, docs.lat), docs.geohash
105
+ FROM docs
106
+ WHERE NOT EXISTS (SELECT FROM missing)
107
+ ON CONFLICT (id) DO UPDATE SET
108
+ "values" = excluded."values",
109
+ basic = excluded.basic,
110
+ text = excluded.text,
111
+ point = excluded.point,
112
+ geohash = excluded.geohash
113
+ )
114
+ SELECT id FROM missing ORDER BY id
115
+ `);
116
+ let missing;
117
+ try {
118
+ missing = await upsert;
119
+ }
120
+ catch (error) {
121
+ if (driverErrorOf(error)?.originalCode !== FOREIGN_KEY_VIOLATION) {
122
+ throw error;
123
+ }
124
+ missing = await prisma.$queryRaw(sql `
125
+ SELECT doc.id FROM unnest(${ids}::text[]) AS doc(id)
126
+ WHERE NOT EXISTS (SELECT FROM entity WHERE entity.id = doc.id)
127
+ ORDER BY doc.id
128
+ `);
129
+ if (missing.length === 0) {
130
+ throw error;
131
+ }
132
+ }
133
+ if (missing.length > 0) {
134
+ throw new Error(`Search documents reference entities that don't exist: ${missing.map(({ id }) => JSON.stringify(id)).join(', ')}`);
135
+ }
136
+ },
137
+ remove: async (ids) => {
138
+ await prisma.$executeRaw(sql `DELETE FROM entity_search WHERE id = ANY(${ids}::text[])`);
139
+ },
140
+ };
141
+ };
142
+ const driverErrorOf = (error) => error.meta?.driverAdapterError?.cause;
143
+ const FOREIGN_KEY_VIOLATION = '23503';
144
+ const QUERY_ERROR_CLASSES = ['22', '54'];
145
+ const asQueryErrors = async (query) => {
146
+ try {
147
+ return await query;
148
+ }
149
+ catch (error) {
150
+ const cause = driverErrorOf(error);
151
+ if (cause && QUERY_ERROR_CLASSES.some((errorClass) => cause.originalCode?.startsWith(errorClass))) {
152
+ throw new SearchQueryError(cause.originalMessage);
153
+ }
154
+ throw error;
155
+ }
156
+ };
157
+ //# sourceMappingURL=postgres.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"postgres.js","sourceRoot":"","sources":["../../../src/search/postgres/postgres.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAY,MAAM,IAAI,GAAG,EAAE,MAAM,+BAA+B,CAAC;AAC9E,OAAO,EAAE,gBAAgB,EAAyC,MAAM,eAAe,CAAC;AACxF,OAAO,EACL,sBAAsB,EAEtB,aAAa,EAEb,cAAc,EACd,MAAM,GACP,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AACzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AACxD,OAAO,EAAE,oBAAoB,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACtE,OAAO,EAAE,kBAAkB,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACxD,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAgBtD,MAAM,aAAa,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AAK3C,MAAM,CAAC,MAAM,eAAe,GAAG,CAAyC,EACtE,MAAM,EACN,MAAM,GACyB,EAAE,EAAE;IACnC,MAAM,YAAY,GAAG,sBAAsB,CAAC,MAAM,CAAC,CAAC;IACpD,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;IAChD,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC;IAEtF,MAAM,YAAY,GAAG,KAAK,CAAC,GAAG,CAC5B,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,CACnB,GAAG,CAAA,kCAAkC,kBAAkB,sBAAsB,IAAI,MAAM,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,gBAAgB,CACnI,CAAC;IACF,MAAM,WAAW,GAAG,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAA,cAAc,CAAC;IAG7F,MAAM,UAAU,GAAG,GAAG,CAAA;;;;;kBAKN,UAAU,0CAA0C,kBAAkB;IACpF,CAAC;IAEH,MAAM,YAAY,GAAG,MAAM,CAAC,GAAG,CAC7B,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,CACvB,GAAG,CAAA,sBAAsB,IAAI,WAAW,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAC5G,CAAC;IAEF,MAAM,QAAQ,GAAG,CAAC,OAAsB,EAAE,EAAE;QAC1C,IAAI,OAAO,CAAC,UAAU,KAAK,UAAU,EAAE,CAAC;YACtC,OAAO,gBAAgB,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACjD,CAAC;QACD,IAAI,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YAChC,OAAO,EAAE,SAAS,EAAE,GAAG,CAAA,MAAM,EAAE,IAAI,EAAE,GAAG,CAAA,GAAG,EAAE,CAAC;QAChD,CAAC;QACD,MAAM,OAAO,GAAG,GAAG,CAAA,wBAAwB,kBAAkB,KAAK,OAAO,CAAC,KAAK,SAAS,CAAC;QAGzF,OAAO;YACL,SAAS,EAAE,GAAG,CAAA,YAAY,OAAO,4BAA4B,OAAO,GAAG;YACvE,IAAI,EAAE,GAAG,CAAA,yBAAyB,OAAO,GAAG;SAC7C,CAAC;IACJ,CAAC,CAAC;IAEF,OAAO;QACL,YAAY;QAEZ,MAAM,EAAE,KAAK,EAAE,OAAsB,EAAyB,EAAE;YAC9D,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC;YACvD,MAAM,UAAU,GAAG;gBACjB,OAAO;gBACP,mBAAmB,CAAC,gBAAgB,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;gBAC9D,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC3E,mBAAmB,CAAC,qBAAqB,CAAC,MAAM,EAAE,OAAO,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;aAC/E,CAAC;YAEF,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,gBAAgB,EAAE,GAAG,OAAO,CAAC;YAClD,MAAM,CAAC,GAAG,EAAE,SAAS,CAAC,GACpB,IAAI,KAAK,WAAW;gBAClB,CAAC,CAAC,CAAC,IAAI,EAAE,GAAG,CAAA,MAAM,CAAC;gBACnB,CAAC,CAAC;oBACE,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,GAAG,CAAA,uBAAuB,IAAI,QAAQ,CAAC;oBAChE,KAAK,KAAK,KAAK,CAAC,CAAC,CAAC,GAAG,CAAA,gBAAgB,CAAC,CAAC,CAAC,GAAG,CAAA,iBAAiB;iBAC7D,CAAC;YACR,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,aAAa,CAClC,MAAM,CAAC,SAAS,CAAkF,GAAG,CAAA;;+DAE9C,GAAG;;kBAEhD,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC;;;;;kEAKuB,SAAS;;;;oCAIvC,SAAS;sBACvB,OAAO,CAAC,KAAK,gBAAgB,OAAO,CAAC,MAAM;;;YAGrD,IAAI,CAAC,CAAC,GAAG,CAAA,aAAa,EAAE,GAAG,YAAY,CAAC,EAAE,MAAM,CAAC;YACjD,gBAAgB,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,CAAA,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,gBAAgB,CAAC;OAC/E,CAAC,CACD,CAAC;YAEF,OAAO;gBACL,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;gBACvC,MAAM,EAAE,MAAM,CAAC,MAAM;gBACrB,GAAG,CAAC,MAAM,CAAC,WAAW,IAAI,EAAE,WAAW,EAAE,MAAM,CAAC,WAAW,EAAE,CAAC;aAC/D,CAAC;QACJ,CAAC;QAMD,KAAK,EAAE,KAAK,EAAE,IAA8B,EAAE,EAAE,EAAE,EAAE,GAA4B,EAAE,EAAE,EAAE;YACpF,MAAM,MAAM,GAAG,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YAE5C,MAAM,IAAI,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;gBACrG,EAAE;gBACF,MAAM,EAAE,MAAM,CAAC,WAAW,CACxB,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC;oBAC5C,IAAI;oBACJ,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;iBACzD,CAAC,CACH;gBACD,GAAG,CAAC,KAAK,IAAI,EAAE,GAAG,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;aACpD,CAAC,CAAC,CAAC;YAEJ,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;YACrC,MAAM,MAAM,GAAG,CAAC,EAAE,IAAI,MAAM,CAAC,CAAC,SAAS,CAAmB,GAAG,CAAA;;6CAEtB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;;;;;;;;2CAQtB,WAAW,KAAK,UAAU;;;;;;;;;;;OAW9D,CAAC,CAAC;YAEH,IAAI,OAAyB,CAAC;YAC9B,IAAI,CAAC;gBACH,OAAO,GAAG,MAAM,MAAM,CAAC;YACzB,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,aAAa,CAAC,KAAK,CAAC,EAAE,YAAY,KAAK,qBAAqB,EAAE,CAAC;oBACjE,MAAM,KAAK,CAAC;gBACd,CAAC;gBAGD,OAAO,GAAG,MAAM,MAAM,CAAC,SAAS,CAAmB,GAAG,CAAA;sCACxB,GAAG;;;SAGhC,CAAC,CAAC;gBACH,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBACzB,MAAM,KAAK,CAAC;gBACd,CAAC;YACH,CAAC;YAED,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACvB,MAAM,IAAI,KAAK,CACb,yDAAyD,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAClH,CAAC;YACJ,CAAC;QACH,CAAC;QAKD,MAAM,EAAE,KAAK,EAAE,GAAa,EAAE,EAAE;YAC9B,MAAM,MAAM,CAAC,WAAW,CAAC,GAAG,CAAA,4CAA4C,GAAG,WAAW,CAAC,CAAC;QAC1F,CAAC;KACF,CAAC;AACJ,CAAC,CAAC;AAMF,MAAM,aAAa,GAAG,CAAC,KAAc,EAAE,EAAE,CAAE,KAA4B,CAAC,IAAI,EAAE,kBAAkB,EAAE,KAAK,CAAC;AAExG,MAAM,qBAAqB,GAAG,OAAO,CAAC;AAGtC,MAAM,mBAAmB,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;AAEzC,MAAM,aAAa,GAAG,KAAK,EAAK,KAAqB,EAAE,EAAE;IACvD,IAAI,CAAC;QACH,OAAO,MAAM,KAAK,CAAC;IACrB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;QACnC,IAAI,KAAK,IAAI,mBAAmB,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,KAAK,CAAC,YAAY,EAAE,UAAU,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC;YAClG,MAAM,IAAI,gBAAgB,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QACpD,CAAC;QAED,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC,CAAC"}
@@ -0,0 +1,8 @@
1
+ import { type Sql } from '@prisma/client/runtime/client';
2
+ import { type FieldType, type Scalar } from '../fields.js';
3
+ export declare const TEXT_SEARCH_CONFIG: Sql;
4
+ export declare const valuesPath: (field: string) => string;
5
+ export declare const valuesOf: (field: string) => Sql;
6
+ export declare const typed: (type: FieldType, text: Sql) => Sql;
7
+ export declare const fieldValue: (type: FieldType) => Sql;
8
+ export declare const parameter: (type: FieldType, value: Scalar) => Sql;
@@ -0,0 +1,20 @@
1
+ import { sqltag as sql } from '@prisma/client/runtime/client';
2
+ import { toWire } from '../fields.js';
3
+ export const TEXT_SEARCH_CONFIG = sql `'simple'::regconfig`;
4
+ export const valuesPath = (field) => `$."${field}"[*]`;
5
+ export const valuesOf = (field) => sql `LATERAL (SELECT jsonb_path_query(search."values", ${valuesPath(field)}::jsonpath) #>> '{}' AS value) AS field`;
6
+ export const typed = (type, text) => {
7
+ switch (type) {
8
+ case 'number':
9
+ return sql `(${text})::float8`;
10
+ case 'date':
11
+ return sql `(${text})::timestamptz`;
12
+ case 'boolean':
13
+ return sql `(${text})::boolean`;
14
+ default:
15
+ return sql `(${text}) COLLATE "C"`;
16
+ }
17
+ };
18
+ export const fieldValue = (type) => typed(type, sql `field.value`);
19
+ export const parameter = (type, value) => typed(type, sql `${String(toWire(value))}::text`);
20
+ //# sourceMappingURL=values.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"values.js","sourceRoot":"","sources":["../../../src/search/postgres/values.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,MAAM,IAAI,GAAG,EAAE,MAAM,+BAA+B,CAAC;AACxE,OAAO,EAA+B,MAAM,EAAE,MAAM,cAAc,CAAC;AAEnE,MAAM,CAAC,MAAM,kBAAkB,GAAG,GAAG,CAAA,qBAAqB,CAAC;AAG3D,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,KAAa,EAAE,EAAE,CAAC,MAAM,KAAK,MAAM,CAAC;AAK/D,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,KAAa,EAAE,EAAE,CACxC,GAAG,CAAA,qDAAqD,UAAU,CAAC,KAAK,CAAC,yCAAyC,CAAC;AAKrH,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,IAAe,EAAE,IAAS,EAAE,EAAE;IAClD,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,QAAQ;YACX,OAAO,GAAG,CAAA,IAAI,IAAI,WAAW,CAAC;QAChC,KAAK,MAAM;YACT,OAAO,GAAG,CAAA,IAAI,IAAI,gBAAgB,CAAC;QACrC,KAAK,SAAS;YACZ,OAAO,GAAG,CAAA,IAAI,IAAI,YAAY,CAAC;QACjC;YACE,OAAO,GAAG,CAAA,IAAI,IAAI,eAAe,CAAC;IACtC,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,IAAe,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,GAAG,CAAA,aAAa,CAAC,CAAC;AAE7E,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,IAAe,EAAE,KAAa,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,GAAG,CAAA,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC"}
@@ -0,0 +1,4 @@
1
+ import { type Sql } from '@prisma/client/runtime/client';
2
+ import { type FieldDeclarations } from '../fields.js';
3
+ import type { VisibilityCondition } from '../visibility.js';
4
+ export declare const visibilityCondition: (condition: VisibilityCondition, fields: FieldDeclarations) => Sql;
@@ -0,0 +1,38 @@
1
+ import { join, sqltag as sql } from '@prisma/client/runtime/client';
2
+ import { toWire } from '../fields.js';
3
+ import { fieldValue, parameter, valuesOf, valuesPath } from './values.js';
4
+ const OPERATORS = { lt: sql `<`, lte: sql `<=`, gt: sql `>`, gte: sql `>=` };
5
+ const literal = (type, value) => JSON.stringify(type === 'boolean' && (value === 'true' || value === 'false') ? value === 'true' : toWire(value));
6
+ export const visibilityCondition = (condition, fields) => {
7
+ const translate = (node) => {
8
+ switch (node.type) {
9
+ case 'and':
10
+ return sql `(${join([sql `TRUE`, ...node.clauses.map(translate)], ' AND ')})`;
11
+ case 'or':
12
+ return sql `(${join([sql `FALSE`, ...node.clauses.map(translate)], ' OR ')})`;
13
+ case 'not':
14
+ return sql `NOT ${translate(node.clause)}`;
15
+ case 'present':
16
+ return node.field === 'id' ? sql `TRUE` : sql `search."values" @? ${valuesPath(node.field)}::jsonpath`;
17
+ case 'in': {
18
+ const { field, values } = node;
19
+ if (field === 'id') {
20
+ return sql `search.id = ANY(${values.map(String)}::text[])`;
21
+ }
22
+ if (values.length === 0) {
23
+ return sql `FALSE`;
24
+ }
25
+ const { type } = fields[field];
26
+ const equals = values.map((value) => `@ == ${literal(type, value)}`).join(' || ');
27
+ return sql `search."values" @? ${`${valuesPath(field)} ? (${equals})`}::jsonpath`;
28
+ }
29
+ case 'range': {
30
+ const { type } = fields[node.field];
31
+ const bounds = Object.entries(node.bounds).map(([bound, value]) => sql `${fieldValue(type)} ${OPERATORS[bound]} ${parameter(type, value)}`);
32
+ return sql `EXISTS (SELECT FROM ${valuesOf(node.field)} WHERE ${join(bounds, ' AND ')})`;
33
+ }
34
+ }
35
+ };
36
+ return translate(condition);
37
+ };
38
+ //# sourceMappingURL=visibility.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"visibility.js","sourceRoot":"","sources":["../../../src/search/postgres/visibility.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAY,MAAM,IAAI,GAAG,EAAE,MAAM,+BAA+B,CAAC;AAC9E,OAAO,EAAuD,MAAM,EAAE,MAAM,cAAc,CAAC;AAE3F,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAE1E,MAAM,SAAS,GAAG,EAAE,EAAE,EAAE,GAAG,CAAA,GAAG,EAAE,GAAG,EAAE,GAAG,CAAA,IAAI,EAAE,EAAE,EAAE,GAAG,CAAA,GAAG,EAAE,GAAG,EAAE,GAAG,CAAA,IAAI,EAAE,CAAC;AAGzE,MAAM,OAAO,GAAG,CAAC,IAAe,EAAE,KAAa,EAAE,EAAE,CACjD,IAAI,CAAC,SAAS,CAAC,IAAI,KAAK,SAAS,IAAI,CAAC,KAAK,KAAK,MAAM,IAAI,KAAK,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;AAMnH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,SAA8B,EAAE,MAAyB,EAAO,EAAE;IACpG,MAAM,SAAS,GAAG,CAAC,IAAyB,EAAO,EAAE;QACnD,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YAClB,KAAK,KAAK;gBACR,OAAO,GAAG,CAAA,IAAI,IAAI,CAAC,CAAC,GAAG,CAAA,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC;YAC9E,KAAK,IAAI;gBACP,OAAO,GAAG,CAAA,IAAI,IAAI,CAAC,CAAC,GAAG,CAAA,OAAO,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC;YAC9E,KAAK,KAAK;gBACR,OAAO,GAAG,CAAA,OAAO,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAC5C,KAAK,SAAS;gBACZ,OAAO,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,GAAG,CAAA,MAAM,CAAC,CAAC,CAAC,GAAG,CAAA,sBAAsB,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC;YACvG,KAAK,IAAI,EAAE,CAAC;gBACV,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;gBAC/B,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;oBACnB,OAAO,GAAG,CAAA,mBAAmB,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC;gBAC7D,CAAC;gBACD,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBACxB,OAAO,GAAG,CAAA,OAAO,CAAC;gBACpB,CAAC;gBAED,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;gBAC/B,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,QAAQ,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAElF,OAAO,GAAG,CAAA,sBAAsB,GAAG,UAAU,CAAC,KAAK,CAAC,OAAO,MAAM,GAAG,YAAY,CAAC;YACnF,CAAC;YACD,KAAK,OAAO,EAAE,CAAC;gBACb,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACpC,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,CAC5C,CAAC,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,EAAE,CACjB,GAAG,CAAA,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC,KAA+B,CAAC,IAAI,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,CACnG,CAAC;gBAEF,OAAO,GAAG,CAAA,uBAAuB,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC;YAC1F,CAAC;QACH,CAAC;IACH,CAAC,CAAC;IAEF,OAAO,SAAS,CAAC,SAAS,CAAC,CAAC;AAC9B,CAAC,CAAC"}
@@ -0,0 +1,39 @@
1
+ import { z } from 'zod';
2
+ import type { BackendSearchCapability, BoundingBox, RangeFilter, SearchRequest } from './backend.js';
3
+ import type { VisibilityCondition } from './visibility.js';
4
+ export declare const filterValueSchema: z.ZodUnion<readonly [z.ZodArray<z.ZodString>, z.ZodObject<{
5
+ gte: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
6
+ lte: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
7
+ }, z.core.$strict>, z.ZodArray<z.ZodObject<{
8
+ gte: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
9
+ lte: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
10
+ }, z.core.$strict>>]>;
11
+ export declare const boundingBoxSchema: z.ZodObject<{
12
+ topRight: z.ZodObject<{
13
+ lat: z.ZodNumber;
14
+ lng: z.ZodNumber;
15
+ }, z.core.$strip>;
16
+ bottomLeft: z.ZodObject<{
17
+ lat: z.ZodNumber;
18
+ lng: z.ZodNumber;
19
+ }, z.core.$strip>;
20
+ }, z.core.$strip>;
21
+ type FilterValue = z.infer<typeof filterValueSchema>;
22
+ export type Violation = {
23
+ field: string;
24
+ message: string;
25
+ value?: unknown;
26
+ };
27
+ export declare const splitFilters: (declared: BackendSearchCapability['filters'], filters: Record<string, FilterValue>) => {
28
+ filters: {
29
+ terms: Record<string, string[]>;
30
+ ranges: Record<string, RangeFilter[]>;
31
+ };
32
+ violations: Violation[];
33
+ };
34
+ export declare const filtersCondition: ({ terms, ranges }: SearchRequest['filters']) => VisibilityCondition;
35
+ export declare const geoViolations: (geo: BackendSearchCapability['geo'], { boundingBox, geohashPrecision }: {
36
+ boundingBox?: BoundingBox;
37
+ geohashPrecision?: number;
38
+ }) => Violation[];
39
+ export {};
@@ -0,0 +1,125 @@
1
+ import { z } from 'zod';
2
+ import { dateSpan } from './fields.js';
3
+ const boundSchema = z.union([z.string(), z.number()]);
4
+ const rangeSchema = z
5
+ .strictObject({ gte: boundSchema.optional(), lte: boundSchema.optional() })
6
+ .refine(({ gte, lte }) => gte !== undefined || lte !== undefined, 'A range needs gte, lte or both');
7
+ export const filterValueSchema = z.union([z.array(z.string()), rangeSchema, z.array(rangeSchema).min(1)]);
8
+ const pointSchema = z.object({ lat: z.number().min(-90).max(90), lng: z.number().min(-180).max(180) });
9
+ export const boundingBoxSchema = z.object({ topRight: pointSchema, bottomLeft: pointSchema });
10
+ const FILTER_DATE = /^\d{4}-\d{2}-\d{2}(?:[Tt ]|$)/;
11
+ const DATE_FORMS = 'a YYYY-MM-DD date or an RFC 3339 date-time';
12
+ const filterDateSpan = (value) => (FILTER_DATE.test(value) ? dateSpan(value) : undefined);
13
+ const toBound = (type, side, value) => {
14
+ if (type === 'number') {
15
+ return typeof value === 'number' ? value : undefined;
16
+ }
17
+ const span = typeof value === 'string' ? filterDateSpan(value) : undefined;
18
+ return span && (side === 'gte' ? span.first : span.last);
19
+ };
20
+ const normaliseRange = (type, range) => {
21
+ const normalised = {};
22
+ for (const side of ['gte', 'lte']) {
23
+ const value = range[side];
24
+ if (value === undefined) {
25
+ continue;
26
+ }
27
+ const bound = toBound(type, side, value);
28
+ if (bound === undefined) {
29
+ return { problem: `${side} must be ${type === 'date' ? DATE_FORMS : 'a number'}` };
30
+ }
31
+ normalised[side] = bound;
32
+ }
33
+ const { gte, lte } = normalised;
34
+ if (gte !== undefined && lte !== undefined && Number(gte) > Number(lte)) {
35
+ return { problem: 'has gte above lte' };
36
+ }
37
+ return { range: normalised };
38
+ };
39
+ const exactRange = (type, value) => {
40
+ if (type === 'number') {
41
+ const number = Number(value);
42
+ return value.trim() !== '' && Number.isFinite(number)
43
+ ? { range: { gte: number, lte: number } }
44
+ : { problem: `values must be numbers, not ${JSON.stringify(value)}` };
45
+ }
46
+ const span = filterDateSpan(value);
47
+ return span
48
+ ? { range: { gte: span.first, lte: span.last } }
49
+ : { problem: `values must be ${DATE_FORMS}, not ${JSON.stringify(value)}` };
50
+ };
51
+ const isExact = (value) => Array.isArray(value) && value.every((item) => typeof item === 'string');
52
+ const normalise = (type, value) => {
53
+ if (type !== 'date' && type !== 'number') {
54
+ return { problem: `is a ${type} filter, which takes exact values, not ranges` };
55
+ }
56
+ const normalised = isExact(value)
57
+ ? value.map((item) => exactRange(type, item))
58
+ : (Array.isArray(value) ? value : [value]).map((range) => normaliseRange(type, range));
59
+ const failed = normalised.find((item) => 'problem' in item);
60
+ return failed ?? { range: normalised.map((item) => item.range) };
61
+ };
62
+ export const splitFilters = (declared, filters) => {
63
+ const split = { terms: {}, ranges: {} };
64
+ const violations = [];
65
+ for (const [key, value] of Object.entries(filters)) {
66
+ if (!Object.hasOwn(declared, key)) {
67
+ violations.push({ field: `/filters/${key}`, message: `${key} isn't a declared filter`, value });
68
+ continue;
69
+ }
70
+ const { type } = declared[key];
71
+ if ((type === 'string' || type === 'boolean') && isExact(value)) {
72
+ const notBoolean = type === 'boolean' ? value.find((item) => item !== 'true' && item !== 'false') : undefined;
73
+ if (notBoolean === undefined) {
74
+ split.terms[key] = value;
75
+ }
76
+ else {
77
+ violations.push({
78
+ field: `/filters/${key}`,
79
+ message: `${key} values must be true or false, not ${JSON.stringify(notBoolean)}`,
80
+ value,
81
+ });
82
+ }
83
+ continue;
84
+ }
85
+ const result = normalise(type, value);
86
+ if ('problem' in result) {
87
+ violations.push({ field: `/filters/${key}`, message: `${key} ${result.problem}`, value });
88
+ }
89
+ else {
90
+ split.ranges[key] = result.range;
91
+ }
92
+ }
93
+ return { filters: split, violations };
94
+ };
95
+ export const filtersCondition = ({ terms, ranges }) => ({
96
+ type: 'and',
97
+ clauses: [
98
+ ...Object.entries(terms).map(([field, values]) => ({ type: 'in', field, values })),
99
+ ...Object.entries(ranges).map(([field, filters]) => ({
100
+ type: 'or',
101
+ clauses: filters.map((bounds) => ({ type: 'range', field, bounds })),
102
+ })),
103
+ ],
104
+ });
105
+ export const geoViolations = (geo, { boundingBox, geohashPrecision }) => {
106
+ const violations = [];
107
+ if (!geo.supported) {
108
+ const message = "Geo search isn't supported";
109
+ if (boundingBox) {
110
+ violations.push({ field: '/boundingBox', message });
111
+ }
112
+ if (geohashPrecision !== undefined) {
113
+ violations.push({ field: '/geohashPrecision', message });
114
+ }
115
+ return violations;
116
+ }
117
+ if (geohashPrecision !== undefined && !boundingBox) {
118
+ violations.push({ field: '/geohashPrecision', message: 'geohashPrecision needs a boundingBox' });
119
+ }
120
+ if (boundingBox && boundingBox.bottomLeft.lat > boundingBox.topRight.lat) {
121
+ violations.push({ field: '/boundingBox', message: 'bottomLeft.lat is north of topRight.lat' });
122
+ }
123
+ return violations;
124
+ };
125
+ //# sourceMappingURL=requestFilters.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"requestFilters.js","sourceRoot":"","sources":["../../src/search/requestFilters.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAGvC,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;AACtD,MAAM,WAAW,GAAG,CAAC;KAClB,YAAY,CAAC,EAAE,GAAG,EAAE,WAAW,CAAC,QAAQ,EAAE,EAAE,GAAG,EAAE,WAAW,CAAC,QAAQ,EAAE,EAAE,CAAC;KAC1E,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,SAAS,EAAE,gCAAgC,CAAC,CAAC;AAGtG,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAE1G,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;AAEvG,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,WAAW,EAAE,UAAU,EAAE,WAAW,EAAE,CAAC,CAAC;AAQ9F,MAAM,WAAW,GAAG,+BAA+B,CAAC;AACpD,MAAM,UAAU,GAAG,4CAA4C,CAAC;AAGhE,MAAM,cAAc,GAAG,CAAC,KAAa,EAAE,EAAE,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;AAElG,MAAM,OAAO,GAAG,CAAC,IAAuB,EAAE,IAAmB,EAAE,KAAsB,EAA0B,EAAE;IAC/G,IAAI,IAAI,KAAK,QAAQ,EAAE,CAAC;QACtB,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;IACvD,CAAC;IAED,MAAM,IAAI,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAE3E,OAAO,IAAI,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC3D,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,IAAuB,EAAE,KAAgB,EAAc,EAAE;IAC/E,MAAM,UAAU,GAAgB,EAAE,CAAC;IACnC,KAAK,MAAM,IAAI,IAAI,CAAC,KAAK,EAAE,KAAK,CAAU,EAAE,CAAC;QAC3C,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;QAC1B,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,SAAS;QACX,CAAC;QAED,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;QACzC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,EAAE,OAAO,EAAE,GAAG,IAAI,YAAY,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC;QACrF,CAAC;QACD,UAAU,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;IAC3B,CAAC;IAED,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,UAAU,CAAC;IAChC,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,SAAS,IAAI,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;QACxE,OAAO,EAAE,OAAO,EAAE,mBAAmB,EAAE,CAAC;IAC1C,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC;AAC/B,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,IAAuB,EAAE,KAAa,EAAc,EAAE;IACxE,IAAI,IAAI,KAAK,QAAQ,EAAE,CAAC;QACtB,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;QAE7B,OAAO,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC;YACnD,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE;YACzC,CAAC,CAAC,EAAE,OAAO,EAAE,+BAA+B,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC;IAC1E,CAAC;IAED,MAAM,IAAI,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC;IAEnC,OAAO,IAAI;QACT,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE,EAAE;QAChD,CAAC,CAAC,EAAE,OAAO,EAAE,kBAAkB,UAAU,SAAS,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC;AAChF,CAAC,CAAC;AAEF,MAAM,OAAO,GAAG,CAAC,KAAkB,EAAqB,EAAE,CACxD,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC;AAE1E,MAAM,SAAS,GAAG,CAAC,IAAgB,EAAE,KAAkB,EAAkD,EAAE;IACzG,IAAI,IAAI,KAAK,MAAM,IAAI,IAAI,KAAK,QAAQ,EAAE,CAAC;QACzC,OAAO,EAAE,OAAO,EAAE,QAAQ,IAAI,+CAA+C,EAAE,CAAC;IAClF,CAAC;IAED,MAAM,UAAU,GAAG,OAAO,CAAC,KAAK,CAAC;QAC/B,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;IACzF,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,IAAI,IAAI,CAAC,CAAC;IAE5D,OAAO,MAAM,IAAI,EAAE,KAAK,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAE,IAA+B,CAAC,KAAK,CAAC,EAAE,CAAC;AAC/F,CAAC,CAAC;AAKF,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,QAA4C,EAAE,OAAoC,EAAE,EAAE;IACjH,MAAM,KAAK,GAA6B,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;IAClE,MAAM,UAAU,GAAgB,EAAE,CAAC;IAEnC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QACnD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,GAAG,CAAC,EAAE,CAAC;YAClC,UAAU,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,YAAY,GAAG,EAAE,EAAE,OAAO,EAAE,GAAG,GAAG,0BAA0B,EAAE,KAAK,EAAE,CAAC,CAAC;YAChG,SAAS;QACX,CAAC;QAED,MAAM,EAAE,IAAI,EAAE,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,CAAC,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,SAAS,CAAC,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAChE,MAAM,UAAU,GAAG,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,MAAM,IAAI,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9G,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;gBAC7B,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;YAC3B,CAAC;iBAAM,CAAC;gBACN,UAAU,CAAC,IAAI,CAAC;oBACd,KAAK,EAAE,YAAY,GAAG,EAAE;oBACxB,OAAO,EAAE,GAAG,GAAG,sCAAsC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE;oBACjF,KAAK;iBACN,CAAC,CAAC;YACL,CAAC;YACD,SAAS;QACX,CAAC;QAED,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACtC,IAAI,SAAS,IAAI,MAAM,EAAE,CAAC;YACxB,UAAU,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,YAAY,GAAG,EAAE,EAAE,OAAO,EAAE,GAAG,GAAG,IAAI,MAAM,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAC5F,CAAC;aAAM,CAAC;YACN,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC;QACnC,CAAC;IACH,CAAC;IAED,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC;AACxC,CAAC,CAAC;AAKF,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,EAAE,KAAK,EAAE,MAAM,EAA4B,EAAuB,EAAE,CAAC,CAAC;IACrG,IAAI,EAAE,KAAK;IACX,OAAO,EAAE;QACP,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,EAAuB,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;QACvG,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAC3B,CAAC,CAAC,KAAK,EAAE,OAAO,CAAC,EAAuB,EAAE,CAAC,CAAC;YAC1C,IAAI,EAAE,IAAI;YACV,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;SACrE,CAAC,CACH;KACF;CACF,CAAC,CAAC;AAKH,MAAM,CAAC,MAAM,aAAa,GAAG,CAC3B,GAAmC,EACnC,EAAE,WAAW,EAAE,gBAAgB,EAA4D,EAC9E,EAAE;IACf,MAAM,UAAU,GAAgB,EAAE,CAAC;IACnC,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC;QACnB,MAAM,OAAO,GAAG,4BAA4B,CAAC;QAC7C,IAAI,WAAW,EAAE,CAAC;YAChB,UAAU,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,cAAc,EAAE,OAAO,EAAE,CAAC,CAAC;QACtD,CAAC;QACD,IAAI,gBAAgB,KAAK,SAAS,EAAE,CAAC;YACnC,UAAU,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,mBAAmB,EAAE,OAAO,EAAE,CAAC,CAAC;QAC3D,CAAC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,IAAI,gBAAgB,KAAK,SAAS,IAAI,CAAC,WAAW,EAAE,CAAC;QACnD,UAAU,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,mBAAmB,EAAE,OAAO,EAAE,sCAAsC,EAAE,CAAC,CAAC;IACnG,CAAC;IACD,IAAI,WAAW,IAAI,WAAW,CAAC,UAAU,CAAC,GAAG,GAAG,WAAW,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;QACzE,UAAU,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,cAAc,EAAE,OAAO,EAAE,yCAAyC,EAAE,CAAC,CAAC;IACjG,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC,CAAC"}
@@ -0,0 +1,51 @@
1
+ import { type FieldDeclarations, type FieldType, type Scalar } from './fields.js';
2
+ type ValueOf<Type extends FieldType> = Type extends 'number' ? number : Type extends 'boolean' ? boolean : Type extends 'date' ? string | Date : string;
3
+ type Equality<Value> = {
4
+ equals?: Value | null;
5
+ not?: Value | null;
6
+ in?: Value[];
7
+ notIn?: Value[];
8
+ };
9
+ type Ordered<Value> = {
10
+ lt?: Value;
11
+ lte?: Value;
12
+ gt?: Value;
13
+ gte?: Value;
14
+ };
15
+ type ConditionOf<Type extends FieldType> = Type extends 'date' | 'number' ? ValueOf<Type> | null | (Equality<ValueOf<Type>> & Ordered<ValueOf<Type>>) : ValueOf<Type> | null | Equality<ValueOf<Type>>;
16
+ type AnyCondition = ConditionOf<Exclude<FieldType, 'geo'>>;
17
+ type TypedWhere<Fields extends FieldDeclarations> = {
18
+ AND?: TypedWhere<Fields>[];
19
+ OR?: TypedWhere<Fields>[];
20
+ NOT?: TypedWhere<Fields>[];
21
+ id?: ConditionOf<'keyword'>;
22
+ } & {
23
+ -readonly [Name in keyof Fields as Fields[Name]['type'] extends 'geo' ? never : Name]?: ConditionOf<Fields[Name]['type']>;
24
+ };
25
+ type UntypedWhere = {
26
+ AND?: UntypedWhere[];
27
+ OR?: UntypedWhere[];
28
+ NOT?: UntypedWhere[];
29
+ [name: string]: AnyCondition | UntypedWhere[] | undefined;
30
+ };
31
+ export type SearchVisibilityWhere<Fields extends FieldDeclarations = FieldDeclarations> = string extends keyof Fields ? UntypedWhere : TypedWhere<Fields>;
32
+ export type VisibilityCondition = {
33
+ type: 'and' | 'or';
34
+ clauses: VisibilityCondition[];
35
+ } | {
36
+ type: 'not';
37
+ clause: VisibilityCondition;
38
+ } | {
39
+ type: 'in';
40
+ field: string;
41
+ values: Scalar[];
42
+ } | {
43
+ type: 'present';
44
+ field: string;
45
+ } | {
46
+ type: 'range';
47
+ field: string;
48
+ bounds: Partial<Record<'lt' | 'lte' | 'gt' | 'gte', number | Date>>;
49
+ };
50
+ export declare const checkSearchVisibility: (fields: FieldDeclarations, where: unknown) => VisibilityCondition;
51
+ export {};
@@ -0,0 +1,100 @@
1
+ import { DATE_FORMS, storeScalar, withId, } from './fields.js';
2
+ const COMBINATORS = ['AND', 'OR', 'NOT'];
3
+ const EQUALITY = ['equals', 'not', 'in', 'notIn'];
4
+ const RANGE = ['lt', 'lte', 'gt', 'gte'];
5
+ const isPlainObject = (value) => {
6
+ if (typeof value !== 'object' || value === null) {
7
+ return false;
8
+ }
9
+ const prototype = Object.getPrototypeOf(value);
10
+ return prototype === Object.prototype || prototype === null;
11
+ };
12
+ export const checkSearchVisibility = (fields, where) => {
13
+ const declarations = withId(fields);
14
+ const fail = (key, problem) => {
15
+ throw new Error(`Search visibility filter: "${key}" ${problem}`);
16
+ };
17
+ const scalar = (field, type, value) => {
18
+ if (type === 'date' && value instanceof Date && !Number.isNaN(value.getTime())) {
19
+ return value;
20
+ }
21
+ const stored = storeScalar(type, value);
22
+ if ('problem' in stored) {
23
+ const problem = type === 'date' ? `must be a Date or ${DATE_FORMS}` : stored.problem;
24
+ return fail(field, `${problem}, not ${JSON.stringify(value)}`);
25
+ }
26
+ return stored.value;
27
+ };
28
+ const equals = (field, type, value) => value === null
29
+ ? { type: 'not', clause: { type: 'present', field } }
30
+ : { type: 'in', field, values: [scalar(field, type, value)] };
31
+ const list = (field, type, operator, value) => {
32
+ if (!Array.isArray(value)) {
33
+ return fail(field, `takes an array for ${operator}`);
34
+ }
35
+ return { type: 'in', field, values: value.map((item) => scalar(field, type, item)) };
36
+ };
37
+ const condition = (field, declaration, value) => {
38
+ const { type } = declaration;
39
+ if (type === 'geo') {
40
+ return fail(field, "is a geo field, which a search visibility filter can't use");
41
+ }
42
+ if (!isPlainObject(value)) {
43
+ return equals(field, type, value);
44
+ }
45
+ const ordered = type === 'date' || type === 'number';
46
+ const clauses = [];
47
+ const bounds = {};
48
+ for (const [operator, operand] of Object.entries(value)) {
49
+ if (operand === undefined) {
50
+ continue;
51
+ }
52
+ if (ordered && RANGE.includes(operator)) {
53
+ bounds[operator] = scalar(field, type, operand);
54
+ continue;
55
+ }
56
+ if (!EQUALITY.includes(operator)) {
57
+ return fail(field, `is a ${type} field, which can't take ${operator}`);
58
+ }
59
+ const positive = operator === 'equals' || operator === 'not'
60
+ ? equals(field, type, operand)
61
+ : list(field, type, operator, operand);
62
+ clauses.push(operator === 'not' || operator === 'notIn' ? { type: 'not', clause: positive } : positive);
63
+ }
64
+ if (Object.keys(bounds).length > 0) {
65
+ clauses.push({ type: 'range', field, bounds });
66
+ }
67
+ return clauses.length === 1 ? clauses[0] : { type: 'and', clauses };
68
+ };
69
+ const check = (node, path) => {
70
+ if (!isPlainObject(node)) {
71
+ return fail(path, 'must be an object of field conditions');
72
+ }
73
+ const clauses = [];
74
+ for (const [key, value] of Object.entries(node)) {
75
+ if (value === undefined) {
76
+ continue;
77
+ }
78
+ if (COMBINATORS.includes(key)) {
79
+ if (!Array.isArray(value)) {
80
+ return fail(key, 'takes an array of filters');
81
+ }
82
+ const nested = value.map((item, index) => check(item, `${key}[${index}]`));
83
+ clauses.push(key === 'AND'
84
+ ? { type: 'and', clauses: nested }
85
+ : key === 'OR'
86
+ ? { type: 'or', clauses: nested }
87
+ : { type: 'not', clause: { type: 'or', clauses: nested } });
88
+ continue;
89
+ }
90
+ const declaration = Object.hasOwn(declarations, key) ? declarations[key] : undefined;
91
+ if (!declaration) {
92
+ return fail(key, "isn't a declared field");
93
+ }
94
+ clauses.push(condition(key, declaration, value));
95
+ }
96
+ return clauses.length === 1 ? clauses[0] : { type: 'and', clauses };
97
+ };
98
+ return check(where, 'filter');
99
+ };
100
+ //# sourceMappingURL=visibility.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"visibility.js","sourceRoot":"","sources":["../../src/search/visibility.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EAKV,WAAW,EACX,MAAM,GACP,MAAM,aAAa,CAAC;AA4DrB,MAAM,WAAW,GAAG,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAU,CAAC;AAClD,MAAM,QAAQ,GAAG,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;AAClD,MAAM,KAAK,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,CAAU,CAAC;AAElD,MAAM,aAAa,GAAG,CAAC,KAAc,EAAoC,EAAE;IACzE,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QAChD,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,SAAS,GAAG,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IAE/C,OAAO,SAAS,KAAK,MAAM,CAAC,SAAS,IAAI,SAAS,KAAK,IAAI,CAAC;AAC9D,CAAC,CAAC;AAKF,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,MAAyB,EAAE,KAAc,EAAuB,EAAE;IACtG,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;IACpC,MAAM,IAAI,GAAG,CAAC,GAAW,EAAE,OAAe,EAAS,EAAE;QACnD,MAAM,IAAI,KAAK,CAAC,8BAA8B,GAAG,KAAK,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC,CAAC;IAEF,MAAM,MAAM,GAAG,CAAC,KAAa,EAAE,IAAe,EAAE,KAAc,EAAU,EAAE;QACxE,IAAI,IAAI,KAAK,MAAM,IAAI,KAAK,YAAY,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC;YAC/E,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACxC,IAAI,SAAS,IAAI,MAAM,EAAE,CAAC;YACxB,MAAM,OAAO,GAAG,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,qBAAqB,UAAU,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC;YAErF,OAAO,IAAI,CAAC,KAAK,EAAE,GAAG,OAAO,SAAS,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACjE,CAAC;QAED,OAAO,MAAM,CAAC,KAAe,CAAC;IAChC,CAAC,CAAC;IAEF,MAAM,MAAM,GAAG,CAAC,KAAa,EAAE,IAAe,EAAE,KAAc,EAAuB,EAAE,CACrF,KAAK,KAAK,IAAI;QACZ,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE;QACrD,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC;IAElE,MAAM,IAAI,GAAG,CAAC,KAAa,EAAE,IAAe,EAAE,QAAgB,EAAE,KAAc,EAAuB,EAAE;QACrG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1B,OAAO,IAAI,CAAC,KAAK,EAAE,sBAAsB,QAAQ,EAAE,CAAC,CAAC;QACvD,CAAC;QAED,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC;IACvF,CAAC,CAAC;IAEF,MAAM,SAAS,GAAG,CAAC,KAAa,EAAE,WAA6B,EAAE,KAAc,EAAuB,EAAE;QACtG,MAAM,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC;QAC7B,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;YACnB,OAAO,IAAI,CAAC,KAAK,EAAE,4DAA4D,CAAC,CAAC;QACnF,CAAC;QACD,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1B,OAAO,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;QACpC,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,KAAK,MAAM,IAAI,IAAI,KAAK,QAAQ,CAAC;QACrD,MAAM,OAAO,GAA0B,EAAE,CAAC;QAC1C,MAAM,MAAM,GAA8D,EAAE,CAAC;QAC7E,KAAK,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACxD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;gBAC1B,SAAS;YACX,CAAC;YACD,IAAI,OAAO,IAAK,KAA2B,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC/D,MAAM,CAAC,QAAkC,CAAC,GAAG,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,CAAkB,CAAC;gBAC3F,SAAS;YACX,CAAC;YACD,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACjC,OAAO,IAAI,CAAC,KAAK,EAAE,QAAQ,IAAI,4BAA4B,QAAQ,EAAE,CAAC,CAAC;YACzE,CAAC;YAED,MAAM,QAAQ,GACZ,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,KAAK;gBACzC,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,CAAC;gBAC9B,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;YAC3C,OAAO,CAAC,IAAI,CAAC,QAAQ,KAAK,KAAK,IAAI,QAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;QAC1G,CAAC;QACD,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACnC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;QACjD,CAAC;QAED,OAAO,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;IACtE,CAAC,CAAC;IAEF,MAAM,KAAK,GAAG,CAAC,IAAa,EAAE,IAAY,EAAuB,EAAE;QACjE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,OAAO,IAAI,CAAC,IAAI,EAAE,uCAAuC,CAAC,CAAC;QAC7D,CAAC;QAED,MAAM,OAAO,GAA0B,EAAE,CAAC;QAC1C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YAChD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACxB,SAAS;YACX,CAAC;YAED,IAAK,WAAiC,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBACrD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC1B,OAAO,IAAI,CAAC,GAAG,EAAE,2BAA2B,CAAC,CAAC;gBAChD,CAAC;gBACD,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC;gBAC3E,OAAO,CAAC,IAAI,CACV,GAAG,KAAK,KAAK;oBACX,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE;oBAClC,CAAC,CAAC,GAAG,KAAK,IAAI;wBACZ,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE;wBACjC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,CAC/D,CAAC;gBACF,SAAS;YACX,CAAC;YAED,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YACrF,IAAI,CAAC,WAAW,EAAE,CAAC;gBACjB,OAAO,IAAI,CAAC,GAAG,EAAE,wBAAwB,CAAC,CAAC;YAC7C,CAAC;YACD,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,WAAW,EAAE,KAAK,CAAC,CAAC,CAAC;QACnD,CAAC;QAED,OAAO,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;IACtE,CAAC,CAAC;IAEF,OAAO,KAAK,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;AAChC,CAAC,CAAC"}