arocapi 5.0.0-beta.5 → 5.0.0-beta.7
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.
- package/LICENSE.md +1 -1
- package/README.md +2 -2
- package/dist/app.d.ts +22 -17
- package/dist/app.js +22 -16
- package/dist/app.js.map +1 -1
- package/dist/routes/capabilities.d.ts +2 -2
- package/dist/routes/capabilities.js +2 -2
- package/dist/routes/capabilities.js.map +1 -1
- package/dist/routes/entities.js +8 -9
- package/dist/routes/entities.js.map +1 -1
- package/dist/routes/file.d.ts +2 -2
- package/dist/routes/file.js +25 -72
- package/dist/routes/file.js.map +1 -1
- package/dist/routes/metadata.d.ts +5 -5
- package/dist/routes/metadata.js +22 -61
- package/dist/routes/metadata.js.map +1 -1
- package/dist/routes/search.d.ts +2 -4
- package/dist/routes/search.js +75 -97
- package/dist/routes/search.js.map +1 -1
- package/dist/search/advanced.d.ts +8 -0
- package/dist/search/advanced.js +198 -0
- package/dist/search/advanced.js.map +1 -0
- package/dist/search/backend.d.ts +95 -0
- package/dist/search/backend.js +5 -0
- package/dist/search/backend.js.map +1 -0
- package/dist/search/fields.d.ts +63 -0
- package/dist/search/fields.js +203 -0
- package/dist/search/fields.js.map +1 -0
- package/dist/search/opensearch/advanced.d.ts +4 -0
- package/dist/search/opensearch/advanced.js +28 -0
- package/dist/search/opensearch/advanced.js.map +1 -0
- package/dist/search/opensearch/opensearch.d.ts +16 -0
- package/dist/search/opensearch/opensearch.js +187 -0
- package/dist/search/opensearch/opensearch.js.map +1 -0
- package/dist/search/opensearch/visibility.d.ts +3 -0
- package/dist/search/opensearch/visibility.js +27 -0
- package/dist/search/opensearch/visibility.js.map +1 -0
- package/dist/search/postgres/advanced.d.ts +7 -0
- package/dist/search/postgres/advanced.js +54 -0
- package/dist/search/postgres/advanced.js.map +1 -0
- package/dist/search/postgres/facets.d.ts +2 -0
- package/dist/search/postgres/facets.js +27 -0
- package/dist/search/postgres/facets.js.map +1 -0
- package/dist/search/postgres/geo.d.ts +6 -0
- package/dist/search/postgres/geo.js +42 -0
- package/dist/search/postgres/geo.js.map +1 -0
- package/dist/search/postgres/postgres.d.ts +19 -0
- package/dist/search/postgres/postgres.js +157 -0
- package/dist/search/postgres/postgres.js.map +1 -0
- package/dist/search/postgres/values.d.ts +8 -0
- package/dist/search/postgres/values.js +20 -0
- package/dist/search/postgres/values.js.map +1 -0
- package/dist/search/postgres/visibility.d.ts +4 -0
- package/dist/search/postgres/visibility.js +38 -0
- package/dist/search/postgres/visibility.js.map +1 -0
- package/dist/search/requestFilters.d.ts +39 -0
- package/dist/search/requestFilters.js +125 -0
- package/dist/search/requestFilters.js.map +1 -0
- package/dist/search/visibility.d.ts +51 -0
- package/dist/search/visibility.js +100 -0
- package/dist/search/visibility.js.map +1 -0
- package/dist/storage/backend.d.ts +58 -0
- package/dist/storage/backend.js +2 -0
- package/dist/storage/backend.js.map +1 -0
- package/dist/storage/deliver.d.ts +12 -0
- package/dist/storage/deliver.js +34 -0
- package/dist/storage/deliver.js.map +1 -0
- package/dist/storage/directory/directory.d.ts +6 -0
- package/dist/storage/directory/directory.js +24 -0
- package/dist/storage/directory/directory.js.map +1 -0
- package/dist/storage/entity-meta/entity-meta.d.ts +5 -0
- package/dist/storage/entity-meta/entity-meta.js +14 -0
- package/dist/storage/entity-meta/entity-meta.js.map +1 -0
- package/dist/storage/location.d.ts +20 -0
- package/dist/storage/location.js +40 -0
- package/dist/storage/location.js.map +1 -0
- package/dist/storage/ocfl/ocfl.d.ts +7 -0
- package/dist/storage/ocfl/ocfl.js +79 -0
- package/dist/storage/ocfl/ocfl.js.map +1 -0
- package/dist/storage/ocfl/ocflFs.d.ts +7 -0
- package/dist/storage/ocfl/ocflFs.js +33 -0
- package/dist/storage/ocfl/ocflFs.js.map +1 -0
- package/dist/storage/results.d.ts +7 -0
- package/dist/storage/results.js +22 -0
- package/dist/storage/results.js.map +1 -0
- package/dist/storage/s3/s3.d.ts +10 -0
- package/dist/storage/s3/s3.js +47 -0
- package/dist/storage/s3/s3.js.map +1 -0
- package/dist/types/visibility.d.ts +3 -2
- package/dist/utils/visibility.js +1 -1
- package/dist/utils/visibility.js.map +1 -1
- package/package.json +66 -26
- package/prisma/models/entity.prisma +9 -8
- package/prisma/models/entitySearch.prisma +21 -0
- package/prisma/models/file.prisma +3 -3
- package/src/app.ts +85 -48
- package/src/routes/capabilities.ts +4 -4
- package/src/routes/entities.ts +10 -9
- package/src/routes/file.ts +23 -99
- package/src/routes/metadata.ts +24 -86
- package/src/routes/search.ts +104 -118
- package/src/search/advanced.ts +258 -0
- package/src/search/backend.ts +91 -0
- package/src/search/fields.ts +320 -0
- package/src/search/opensearch/advanced.ts +36 -0
- package/src/search/opensearch/opensearch.ts +290 -0
- package/src/search/opensearch/visibility.ts +38 -0
- package/src/search/postgres/advanced.ts +76 -0
- package/src/search/postgres/facets.ts +34 -0
- package/src/search/postgres/geo.ts +58 -0
- package/src/search/postgres/postgres.ts +232 -0
- package/src/search/postgres/values.ts +33 -0
- package/src/search/postgres/visibility.ts +54 -0
- package/src/search/requestFilters.ts +178 -0
- package/src/search/visibility.ts +193 -0
- package/src/storage/backend.ts +75 -0
- package/src/storage/deliver.ts +65 -0
- package/src/storage/directory/directory.ts +39 -0
- package/src/storage/entity-meta/entity-meta.ts +25 -0
- package/src/storage/location.ts +85 -0
- package/src/storage/ocfl/ocfl.ts +129 -0
- package/src/storage/ocfl/ocflFs.ts +67 -0
- package/src/storage/results.ts +32 -0
- package/src/storage/s3/s3.ts +79 -0
- package/src/types/visibility.ts +6 -3
- package/src/utils/visibility.ts +1 -1
- package/dist/app.test.d.ts +0 -1
- package/dist/app.test.js +0 -67
- package/dist/app.test.js.map +0 -1
- package/dist/errorHandling.test.d.ts +0 -1
- package/dist/errorHandling.test.js +0 -222
- package/dist/errorHandling.test.js.map +0 -1
- package/dist/index.dev.d.ts +0 -1
- package/dist/index.dev.js +0 -157
- package/dist/index.dev.js.map +0 -1
- package/dist/routes/capabilities.test.d.ts +0 -1
- package/dist/routes/capabilities.test.js +0 -81
- package/dist/routes/capabilities.test.js.map +0 -1
- package/dist/routes/crate.test.d.ts +0 -1
- package/dist/routes/crate.test.js +0 -390
- package/dist/routes/crate.test.js.map +0 -1
- package/dist/routes/entities.test.d.ts +0 -1
- package/dist/routes/entities.test.js +0 -277
- package/dist/routes/entities.test.js.map +0 -1
- package/dist/routes/entity.test.d.ts +0 -1
- package/dist/routes/entity.test.js +0 -136
- package/dist/routes/entity.test.js.map +0 -1
- package/dist/routes/file.test.d.ts +0 -1
- package/dist/routes/file.test.js +0 -435
- package/dist/routes/file.test.js.map +0 -1
- package/dist/routes/files.test.d.ts +0 -1
- package/dist/routes/files.test.js +0 -245
- package/dist/routes/files.test.js.map +0 -1
- package/dist/routes/search.test.d.ts +0 -1
- package/dist/routes/search.test.js +0 -833
- package/dist/routes/search.test.js.map +0 -1
- package/dist/test/helpers/fastify.d.ts +0 -9
- package/dist/test/helpers/fastify.js +0 -17
- package/dist/test/helpers/fastify.js.map +0 -1
- package/dist/test/integration.setup.d.ts +0 -47
- package/dist/test/integration.setup.js +0 -195
- package/dist/test/integration.setup.js.map +0 -1
- package/dist/test/integration.test.d.ts +0 -1
- package/dist/test/integration.test.js +0 -762
- package/dist/test/integration.test.js.map +0 -1
- package/dist/transformers/default.test.d.ts +0 -1
- package/dist/transformers/default.test.js +0 -225
- package/dist/transformers/default.test.js.map +0 -1
- package/dist/transformers/transformer.test.d.ts +0 -1
- package/dist/transformers/transformer.test.js +0 -165
- package/dist/transformers/transformer.test.js.map +0 -1
- package/dist/types/fileHandlers.d.ts +0 -37
- package/dist/types/fileHandlers.js +0 -2
- package/dist/types/fileHandlers.js.map +0 -1
- package/dist/utils/errors.test.d.ts +0 -1
- package/dist/utils/errors.test.js +0 -79
- package/dist/utils/errors.test.js.map +0 -1
- package/dist/utils/queryBuilder.d.ts +0 -47
- package/dist/utils/queryBuilder.js +0 -107
- package/dist/utils/queryBuilder.js.map +0 -1
- package/prisma.config.ts +0 -9
- package/src/app.test.ts +0 -91
- package/src/errorHandling.test.ts +0 -288
- package/src/index.dev.ts +0 -202
- package/src/reset.d.ts +0 -1
- package/src/routes/__snapshots__/capabilities.test.ts.snap +0 -34
- package/src/routes/__snapshots__/entities.test.ts.snap +0 -96
- package/src/routes/__snapshots__/entity.test.ts.snap +0 -74
- package/src/routes/__snapshots__/search.test.ts.snap +0 -165
- package/src/routes/capabilities.test.ts +0 -102
- package/src/routes/crate.test.ts +0 -484
- package/src/routes/entities.test.ts +0 -324
- package/src/routes/entity.test.ts +0 -166
- package/src/routes/file.test.ts +0 -538
- package/src/routes/files.test.ts +0 -304
- package/src/routes/search.test.ts +0 -959
- package/src/test/__snapshots__/integration.test.ts.snap +0 -18
- package/src/test/helpers/fastify.ts +0 -26
- package/src/test/integration.setup.ts +0 -220
- package/src/test/integration.test.ts +0 -953
- package/src/transformers/default.test.ts +0 -276
- package/src/transformers/transformer.test.ts +0 -226
- package/src/types/fileHandlers.ts +0 -57
- package/src/utils/errors.test.ts +0 -90
- package/src/utils/queryBuilder.ts +0 -157
package/dist/routes/search.js
CHANGED
|
@@ -1,137 +1,115 @@
|
|
|
1
1
|
import { z } from 'zod';
|
|
2
|
+
import { normaliseQuery } from '../search/advanced.js';
|
|
3
|
+
import { SearchQueryError, } from '../search/backend.js';
|
|
4
|
+
import { boundingBoxSchema, filterValueSchema, geoViolations, splitFilters, } from '../search/requestFilters.js';
|
|
2
5
|
import { applyTransformers, authoriseEntities } from '../transformers/default.js';
|
|
3
|
-
import { createError, ERROR_CODES } from '../utils/errors.js';
|
|
4
|
-
const boundingBoxSchema = z.object({
|
|
5
|
-
topRight: z.object({
|
|
6
|
-
lat: z.number(),
|
|
7
|
-
lng: z.number(),
|
|
8
|
-
}),
|
|
9
|
-
bottomLeft: z.object({
|
|
10
|
-
lat: z.number(),
|
|
11
|
-
lng: z.number(),
|
|
12
|
-
}),
|
|
13
|
-
});
|
|
6
|
+
import { createError, createValidationError, ERROR_CODES } from '../utils/errors.js';
|
|
14
7
|
const searchParamsSchema = z.object({
|
|
15
8
|
searchType: z.enum(['basic', 'advanced']).default('basic'),
|
|
16
9
|
query: z.string(),
|
|
17
|
-
filters: z.record(z.string(),
|
|
10
|
+
filters: z.record(z.string(), filterValueSchema).default({}),
|
|
18
11
|
boundingBox: boundingBoxSchema.optional(),
|
|
19
12
|
geohashPrecision: z.number().int().min(1).max(12).optional(),
|
|
20
13
|
limit: z.number().int().min(1).max(1000).default(100),
|
|
21
14
|
offset: z.number().int().min(0).default(0),
|
|
22
|
-
sort: z.
|
|
15
|
+
sort: z.string().default('relevance'),
|
|
23
16
|
order: z.enum(['asc', 'desc']).default('asc'),
|
|
24
17
|
});
|
|
18
|
+
const visibleExtra = (searchExtra, { metadata, content }) => {
|
|
19
|
+
if (!searchExtra || (metadata && content)) {
|
|
20
|
+
return searchExtra;
|
|
21
|
+
}
|
|
22
|
+
const { highlight: _, ...rest } = searchExtra;
|
|
23
|
+
return Object.keys(rest).length > 0 ? rest : undefined;
|
|
24
|
+
};
|
|
25
25
|
const search = async (fastify, opts) => {
|
|
26
|
-
const { prisma,
|
|
26
|
+
const { prisma, search: backend, access, entityTransformers = [], entityVisibilityFilter, searchVisibilityFilter, } = opts;
|
|
27
|
+
const { capabilities } = backend;
|
|
28
|
+
const noFacets = Object.fromEntries(Object.keys(capabilities.facets).map((name) => [name, []]));
|
|
29
|
+
const violations = ({ searchType, sort }) => {
|
|
30
|
+
const found = [];
|
|
31
|
+
if (!Object.hasOwn(capabilities.searchTypes, searchType)) {
|
|
32
|
+
found.push({ field: '/searchType', message: `${searchType} search isn't supported`, value: searchType });
|
|
33
|
+
}
|
|
34
|
+
if (sort !== 'relevance' && !Object.hasOwn(capabilities.sorts, sort)) {
|
|
35
|
+
found.push({ field: '/sort', message: `${sort} isn't a declared sort`, value: sort });
|
|
36
|
+
}
|
|
37
|
+
return found;
|
|
38
|
+
};
|
|
27
39
|
fastify.withTypeProvider().post('/search', {
|
|
28
40
|
schema: {
|
|
29
41
|
body: searchParamsSchema,
|
|
30
42
|
},
|
|
31
43
|
}, async (request, reply) => {
|
|
32
|
-
const {
|
|
44
|
+
const { filters, violations: filterProblems } = splitFilters(capabilities.filters, request.body.filters);
|
|
45
|
+
const problems = [
|
|
46
|
+
...violations(request.body),
|
|
47
|
+
...filterProblems,
|
|
48
|
+
...geoViolations(capabilities.geo, request.body),
|
|
49
|
+
];
|
|
50
|
+
if (problems.length > 0) {
|
|
51
|
+
return reply.code(400).send(createValidationError('The request parameters are invalid', problems));
|
|
52
|
+
}
|
|
53
|
+
const { searchType, query, filters: _, boundingBox, geohashPrecision, ...paging } = request.body;
|
|
54
|
+
const searchQuery = normaliseQuery(searchType, query, capabilities.searchTypes.advanced?.fields ?? {});
|
|
55
|
+
if ('problem' in searchQuery) {
|
|
56
|
+
const { problem } = searchQuery;
|
|
57
|
+
return reply.code(422).send(createValidationError(problem, [{ field: 'query', message: problem }]));
|
|
58
|
+
}
|
|
33
59
|
const context = { request, fastify };
|
|
34
|
-
const
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
filter: [visibilityQuery],
|
|
45
|
-
},
|
|
46
|
-
},
|
|
47
|
-
aggs: queryBuilder.buildAggregations(geohashPrecision, boundingBox),
|
|
48
|
-
highlight: {
|
|
49
|
-
fields: {
|
|
50
|
-
name: {},
|
|
51
|
-
description: {},
|
|
52
|
-
},
|
|
53
|
-
},
|
|
54
|
-
sort: queryBuilder.buildSort(sort, order),
|
|
55
|
-
from: offset,
|
|
56
|
-
size: limit,
|
|
57
|
-
},
|
|
60
|
+
const visibilityWhere = Promise.resolve(entityVisibilityFilter(context));
|
|
61
|
+
visibilityWhere.catch(() => undefined);
|
|
62
|
+
const visibility = await searchVisibilityFilter(context);
|
|
63
|
+
const searchRequest = {
|
|
64
|
+
...searchQuery,
|
|
65
|
+
filters,
|
|
66
|
+
...(boundingBox && { boundingBox }),
|
|
67
|
+
...(geohashPrecision !== undefined && { geohashPrecision }),
|
|
68
|
+
...paging,
|
|
69
|
+
visibility,
|
|
58
70
|
};
|
|
59
|
-
|
|
60
|
-
let
|
|
71
|
+
const start = performance.now();
|
|
72
|
+
let result;
|
|
61
73
|
try {
|
|
62
|
-
|
|
74
|
+
result = await backend.search(searchRequest, context);
|
|
63
75
|
}
|
|
64
76
|
catch (error) {
|
|
65
|
-
|
|
66
|
-
|
|
77
|
+
await visibilityWhere.catch((visibilityError) => {
|
|
78
|
+
fastify.log.error({ err: error }, 'Search backend failed');
|
|
79
|
+
throw visibilityError;
|
|
80
|
+
});
|
|
81
|
+
if (!(error instanceof SearchQueryError)) {
|
|
67
82
|
throw error;
|
|
68
83
|
}
|
|
69
|
-
fastify.log.warn(`Invalid search query: ${message}`);
|
|
70
|
-
return reply.code(422).send(createError(ERROR_CODES.VALIDATION_ERROR, message));
|
|
71
|
-
}
|
|
72
|
-
if (!response.body?.hits?.hits) {
|
|
73
|
-
throw new Error('Invalid search response: missing hits data');
|
|
84
|
+
fastify.log.warn(`Invalid search query: ${error.message}`);
|
|
85
|
+
return reply.code(422).send(createError(ERROR_CODES.VALIDATION_ERROR, error.message));
|
|
74
86
|
}
|
|
75
|
-
const
|
|
87
|
+
const searchTime = Math.round(performance.now() - start);
|
|
76
88
|
const dbEntities = await prisma.entity.findMany({
|
|
77
89
|
where: {
|
|
78
|
-
AND: [{ id: { in:
|
|
90
|
+
AND: [{ id: { in: result.hits.map(({ id }) => id) } }, await visibilityWhere],
|
|
79
91
|
},
|
|
80
92
|
include: { file: { select: { id: true } } },
|
|
81
93
|
});
|
|
82
94
|
const authorisedEntities = await authoriseEntities(dbEntities, prisma, access, context);
|
|
83
95
|
const entityMap = new Map(authorisedEntities.map((entity) => [entity.id, entity]));
|
|
84
|
-
const entities = await Promise.all(
|
|
85
|
-
|
|
86
|
-
throw new Error('Missing id in search hit');
|
|
87
|
-
}
|
|
88
|
-
const authorisedEntity = entityMap.get(hit._source.id);
|
|
96
|
+
const entities = await Promise.all(result.hits.map(async ({ id, searchExtra }) => {
|
|
97
|
+
const authorisedEntity = entityMap.get(id);
|
|
89
98
|
if (!authorisedEntity) {
|
|
90
|
-
fastify.log.warn(`Entity ${
|
|
99
|
+
fastify.log.warn(`Entity ${id} found by the search backend but missing or not visible in database`);
|
|
91
100
|
return null;
|
|
92
101
|
}
|
|
93
|
-
const
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
};
|
|
101
|
-
})).then((results) => results.filter(Boolean));
|
|
102
|
-
const facets = {};
|
|
103
|
-
if (response.body.aggregations) {
|
|
104
|
-
Object.keys(response.body.aggregations).forEach((key) => {
|
|
105
|
-
if (key !== 'geohash_grid') {
|
|
106
|
-
const agg = response.body.aggregations?.[key];
|
|
107
|
-
if (agg?.buckets && Array.isArray(agg.buckets)) {
|
|
108
|
-
facets[key] = agg.buckets.map((bucket) => ({
|
|
109
|
-
name: bucket.key,
|
|
110
|
-
count: bucket.doc_count,
|
|
111
|
-
}));
|
|
112
|
-
}
|
|
113
|
-
}
|
|
114
|
-
});
|
|
115
|
-
}
|
|
116
|
-
let geohashGrid;
|
|
117
|
-
if (response.body.aggregations?.geohash_grid) {
|
|
118
|
-
const geohashAgg = response.body.aggregations.geohash_grid;
|
|
119
|
-
if (geohashAgg?.buckets && Array.isArray(geohashAgg.buckets)) {
|
|
120
|
-
geohashAgg.buckets.forEach((bucket) => {
|
|
121
|
-
geohashGrid ||= {};
|
|
122
|
-
geohashGrid[bucket.key] = bucket.doc_count;
|
|
123
|
-
});
|
|
124
|
-
}
|
|
125
|
-
}
|
|
126
|
-
const total = typeof response.body.hits.total === 'number' ? response.body.hits.total : response.body.hits.total?.value || 0;
|
|
127
|
-
const result = {
|
|
128
|
-
total,
|
|
129
|
-
searchTime: response.body.took,
|
|
102
|
+
const transformed = await applyTransformers(authorisedEntity, entityTransformers, context);
|
|
103
|
+
const extra = visibleExtra(searchExtra, authorisedEntity.access);
|
|
104
|
+
return extra === undefined ? transformed : { ...transformed, searchExtra: extra };
|
|
105
|
+
})).then((results) => results.filter((entity) => entity !== null));
|
|
106
|
+
return {
|
|
107
|
+
total: result.total,
|
|
108
|
+
searchTime,
|
|
130
109
|
entities,
|
|
131
|
-
facets:
|
|
132
|
-
geohashGrid,
|
|
110
|
+
facets: { ...noFacets, ...result.facets },
|
|
111
|
+
...(result.geohashGrid && { geohashGrid: result.geohashGrid }),
|
|
133
112
|
};
|
|
134
|
-
return result;
|
|
135
113
|
});
|
|
136
114
|
};
|
|
137
115
|
export default search;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"search.js","sourceRoot":"","sources":["../../src/routes/search.ts"],"names":[],"mappings":"
|
|
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;YACD,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;SAC5C,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,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;QAEnF,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,gBAAgB,GAAG,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAC3C,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBACtB,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,qEAAqE,CAAC,CAAC;gBAEpG,OAAO,IAAI,CAAC;YACd,CAAC;YAED,MAAM,WAAW,GAAG,MAAM,iBAAiB,CAAC,gBAAgB,EAAE,kBAAkB,EAAE,OAAO,CAAC,CAAC;YAC3F,MAAM,KAAK,GAAG,YAAY,CAAC,WAAW,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAC;YAEjE,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 @@
|
|
|
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 {};
|