@etohq/utils 2.0.4 → 2.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (149) hide show
  1. package/dist/bundles.d.ts +1 -0
  2. package/dist/bundles.d.ts.map +1 -1
  3. package/dist/bundles.js +2 -1
  4. package/dist/bundles.js.map +1 -1
  5. package/dist/dal/mikro-orm/mikro-orm-create-connection.d.ts.map +1 -1
  6. package/dist/dal/mikro-orm/mikro-orm-create-connection.js +7 -0
  7. package/dist/dal/mikro-orm/mikro-orm-create-connection.js.map +1 -1
  8. package/dist/dml/errors.d.ts +12 -0
  9. package/dist/dml/errors.d.ts.map +1 -1
  10. package/dist/dml/errors.js +21 -1
  11. package/dist/dml/errors.js.map +1 -1
  12. package/dist/dml/helpers/create-mikro-orm-entity.d.ts.map +1 -1
  13. package/dist/dml/helpers/create-mikro-orm-entity.js +25 -5
  14. package/dist/dml/helpers/create-mikro-orm-entity.js.map +1 -1
  15. package/dist/index.d.ts +2 -0
  16. package/dist/index.d.ts.map +1 -1
  17. package/dist/index.js +2 -0
  18. package/dist/index.js.map +1 -1
  19. package/dist/migrations/index.d.ts.map +1 -1
  20. package/dist/migrations/index.js +5 -2
  21. package/dist/migrations/index.js.map +1 -1
  22. package/dist/modules-sdk/definition.d.ts +5 -0
  23. package/dist/modules-sdk/definition.d.ts.map +1 -1
  24. package/dist/modules-sdk/definition.js +3 -0
  25. package/dist/modules-sdk/definition.js.map +1 -1
  26. package/dist/schema/base-property.d.ts +25 -0
  27. package/dist/schema/base-property.d.ts.map +1 -0
  28. package/dist/schema/base-property.js +25 -0
  29. package/dist/schema/base-property.js.map +1 -0
  30. package/dist/schema/index.d.ts +2 -0
  31. package/dist/schema/index.d.ts.map +1 -0
  32. package/dist/schema/index.js +18 -0
  33. package/dist/schema/index.js.map +1 -0
  34. package/dist/search/abstract-search-provider.d.ts +345 -0
  35. package/dist/search/abstract-search-provider.d.ts.map +1 -0
  36. package/dist/search/abstract-search-provider.js +345 -0
  37. package/dist/search/abstract-search-provider.js.map +1 -0
  38. package/dist/search/define-search-index.d.ts +12 -0
  39. package/dist/search/define-search-index.d.ts.map +1 -0
  40. package/dist/search/define-search-index.js +47 -0
  41. package/dist/search/define-search-index.js.map +1 -0
  42. package/dist/search/definition-helpers.d.ts +112 -0
  43. package/dist/search/definition-helpers.d.ts.map +1 -0
  44. package/dist/search/definition-helpers.js +196 -0
  45. package/dist/search/definition-helpers.js.map +1 -0
  46. package/dist/search/document-utils.d.ts +29 -0
  47. package/dist/search/document-utils.d.ts.map +1 -0
  48. package/dist/search/document-utils.js +134 -0
  49. package/dist/search/document-utils.js.map +1 -0
  50. package/dist/search/index.d.ts +6 -5
  51. package/dist/search/index.d.ts.map +1 -1
  52. package/dist/search/index.js +6 -5
  53. package/dist/search/index.js.map +1 -1
  54. package/dist/search/model/index-builder.d.ts +61 -0
  55. package/dist/search/model/index-builder.d.ts.map +1 -0
  56. package/dist/search/model/index-builder.js +84 -0
  57. package/dist/search/model/index-builder.js.map +1 -0
  58. package/dist/search/model/index.d.ts +3 -0
  59. package/dist/search/model/index.d.ts.map +1 -0
  60. package/dist/search/model/index.js +9 -0
  61. package/dist/search/model/index.js.map +1 -0
  62. package/dist/search/model/properties/base.d.ts +52 -0
  63. package/dist/search/model/properties/base.d.ts.map +1 -0
  64. package/dist/search/model/properties/base.js +139 -0
  65. package/dist/search/model/properties/base.js.map +1 -0
  66. package/dist/search/model/properties/boolean.d.ts +8 -0
  67. package/dist/search/model/properties/boolean.d.ts.map +1 -0
  68. package/dist/search/model/properties/boolean.js +14 -0
  69. package/dist/search/model/properties/boolean.js.map +1 -0
  70. package/dist/search/model/properties/date.d.ts +8 -0
  71. package/dist/search/model/properties/date.d.ts.map +1 -0
  72. package/dist/search/model/properties/date.js +16 -0
  73. package/dist/search/model/properties/date.js.map +1 -0
  74. package/dist/search/model/properties/float.d.ts +8 -0
  75. package/dist/search/model/properties/float.d.ts.map +1 -0
  76. package/dist/search/model/properties/float.js +14 -0
  77. package/dist/search/model/properties/float.js.map +1 -0
  78. package/dist/search/model/properties/geo.d.ts +11 -0
  79. package/dist/search/model/properties/geo.d.ts.map +1 -0
  80. package/dist/search/model/properties/geo.js +14 -0
  81. package/dist/search/model/properties/geo.js.map +1 -0
  82. package/dist/search/model/properties/index.d.ts +11 -0
  83. package/dist/search/model/properties/index.d.ts.map +1 -0
  84. package/dist/search/model/properties/index.js +27 -0
  85. package/dist/search/model/properties/index.js.map +1 -0
  86. package/dist/search/model/properties/integer.d.ts +8 -0
  87. package/dist/search/model/properties/integer.d.ts.map +1 -0
  88. package/dist/search/model/properties/integer.js +14 -0
  89. package/dist/search/model/properties/integer.js.map +1 -0
  90. package/dist/search/model/properties/keyword.d.ts +8 -0
  91. package/dist/search/model/properties/keyword.d.ts.map +1 -0
  92. package/dist/search/model/properties/keyword.js +14 -0
  93. package/dist/search/model/properties/keyword.js.map +1 -0
  94. package/dist/search/model/properties/object.d.ts +12 -0
  95. package/dist/search/model/properties/object.d.ts.map +1 -0
  96. package/dist/search/model/properties/object.js +38 -0
  97. package/dist/search/model/properties/object.js.map +1 -0
  98. package/dist/search/model/properties/text.d.ts +8 -0
  99. package/dist/search/model/properties/text.d.ts.map +1 -0
  100. package/dist/search/model/properties/text.js +14 -0
  101. package/dist/search/model/properties/text.js.map +1 -0
  102. package/dist/search/model/properties/vector.d.ts +18 -0
  103. package/dist/search/model/properties/vector.d.ts.map +1 -0
  104. package/dist/search/model/properties/vector.js +51 -0
  105. package/dist/search/model/properties/vector.js.map +1 -0
  106. package/dist/search/model/search-fields-schema.d.ts +22 -0
  107. package/dist/search/model/search-fields-schema.d.ts.map +1 -0
  108. package/dist/search/model/search-fields-schema.js +70 -0
  109. package/dist/search/model/search-fields-schema.js.map +1 -0
  110. package/dist/search/search-scope.d.ts +44 -0
  111. package/dist/search/search-scope.d.ts.map +1 -0
  112. package/dist/search/search-scope.js +111 -0
  113. package/dist/search/search-scope.js.map +1 -0
  114. package/dist/{search → search-legacy}/abstract-service.d.ts +19 -19
  115. package/dist/search-legacy/abstract-service.d.ts.map +1 -0
  116. package/dist/{search → search-legacy}/abstract-service.js +8 -8
  117. package/dist/search-legacy/abstract-service.js.map +1 -0
  118. package/dist/search-legacy/index-types.d.ts.map +1 -0
  119. package/dist/search-legacy/index-types.js.map +1 -0
  120. package/dist/search-legacy/index.d.ts +6 -0
  121. package/dist/search-legacy/index.d.ts.map +1 -0
  122. package/dist/search-legacy/index.js +22 -0
  123. package/dist/search-legacy/index.js.map +1 -0
  124. package/dist/search-legacy/search-relations.d.ts.map +1 -0
  125. package/dist/search-legacy/search-relations.js.map +1 -0
  126. package/dist/{search → search-legacy}/types.d.ts +29 -29
  127. package/dist/search-legacy/types.d.ts.map +1 -0
  128. package/dist/{search → search-legacy}/types.js +1 -1
  129. package/dist/search-legacy/types.js.map +1 -0
  130. package/dist/search-legacy/variant-keys.d.ts.map +1 -0
  131. package/dist/search-legacy/variant-keys.js.map +1 -0
  132. package/dist/tsconfig.tsbuildinfo +1 -1
  133. package/package.json +2 -2
  134. package/dist/search/abstract-service.d.ts.map +0 -1
  135. package/dist/search/abstract-service.js.map +0 -1
  136. package/dist/search/index-types.d.ts.map +0 -1
  137. package/dist/search/index-types.js.map +0 -1
  138. package/dist/search/search-relations.d.ts.map +0 -1
  139. package/dist/search/search-relations.js.map +0 -1
  140. package/dist/search/types.d.ts.map +0 -1
  141. package/dist/search/types.js.map +0 -1
  142. package/dist/search/variant-keys.d.ts.map +0 -1
  143. package/dist/search/variant-keys.js.map +0 -1
  144. /package/dist/{search → search-legacy}/index-types.d.ts +0 -0
  145. /package/dist/{search → search-legacy}/index-types.js +0 -0
  146. /package/dist/{search → search-legacy}/search-relations.d.ts +0 -0
  147. /package/dist/{search → search-legacy}/search-relations.js +0 -0
  148. /package/dist/{search → search-legacy}/variant-keys.d.ts +0 -0
  149. /package/dist/{search → search-legacy}/variant-keys.js +0 -0
@@ -0,0 +1 @@
1
+ {"version":3,"file":"abstract-search-provider.js","sourceRoot":"","sources":["../../src/search/abstract-search-provider.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyEG;AACH,MAAa,6BAA6B;IAiBxC;;OAEG;IACH,IAAI,UAAU;QACZ,OAAQ,IAAI,CAAC,WAAmB,CAAC,UAAU,CAAA;IAC7C,CAAC;IAED;;OAEG;IACH,aAAa;QACX,OAAQ,IAAI,CAAC,WAAmB,CAAC,UAAU,CAAA;IAC7C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,KAAK,CAAC,MAAM,CACV,MAAuC;QAEvC,MAAM,KAAK,CAAC,8CAA8C,CAAC,CAAA;IAC7D,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,KAAK,CAAC,UAAU,CACd,MAAyC;QAEzC,OAAO,MAAM,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IACrE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,KAAK,CAAC,WAAW,CAAC,MAEjB;QACC,MAAM,KAAK,CAAC,mDAAmD,CAAC,CAAA;IAClE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,WAAW,CAAC,MAEjB;QACC,MAAM,KAAK,CAAC,mDAAmD,CAAC,CAAA;IAClE,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,WAAW;QACf,MAAM,KAAK,CAAC,mDAAmD,CAAC,CAAA;IAClE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,KAAK,CAAC,eAAe,CAAC,MAIrB;QACC,MAAM,KAAK,CAAC,uDAAuD,CAAC,CAAA;IACtE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,KAAK,CAAC,eAAe,CACnB,MAA8C;QAE9C,MAAM,KAAK,CAAC,uDAAuD,CAAC,CAAA;IACtE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,UAAU,CAAC,MAAyB;QACxC,MAAM,KAAK,CAAC,kDAAkD,CAAC,CAAA;IACjE,CAAC;CACF;AAhTD,sEAgTC"}
@@ -0,0 +1,12 @@
1
+ import { SearchTypes } from "@etohq/types";
2
+ /**
3
+ * Declares a search index. Like `defineLink`, the file registers itself on
4
+ * import: the application loads every file under `search/` and hands what was
5
+ * registered to the Search Module as its `indexes` option, so the module has one
6
+ * input rather than a registry and an option that can disagree.
7
+ *
8
+ * `fields` must be a schema from `search.define({ ... })`. The documents
9
+ * `seed` yields are type-checked against the declared fields.
10
+ */
11
+ export declare function defineSearchIndex<Fields extends SearchTypes.SearchIndexFieldsInput>(definition: SearchTypes.SearchIndexDefinitionInput<Fields>): SearchTypes.SearchIndexDefinition;
12
+ //# sourceMappingURL=define-search-index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"define-search-index.d.ts","sourceRoot":"","sources":["../../src/search/define-search-index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAQ1C;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAC/B,MAAM,SAAS,WAAW,CAAC,sBAAsB,EAEjD,UAAU,EAAE,WAAW,CAAC,0BAA0B,CAAC,MAAM,CAAC,GACzD,WAAW,CAAC,qBAAqB,CAmBnC"}
@@ -0,0 +1,47 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.defineSearchIndex = defineSearchIndex;
4
+ const common_1 = require("../common");
5
+ const search_scope_1 = require("./search-scope");
6
+ /**
7
+ * Declares a search index. Like `defineLink`, the file registers itself on
8
+ * import: the application loads every file under `search/` and hands what was
9
+ * registered to the Search Module as its `indexes` option, so the module has one
10
+ * input rather than a registry and an option that can disagree.
11
+ *
12
+ * `fields` must be a schema from `search.define({ ... })`. The documents
13
+ * `seed` yields are type-checked against the declared fields.
14
+ */
15
+ function defineSearchIndex(definition) {
16
+ const callerFilePath = (0, common_1.getCallerFilePath)();
17
+ if ((0, common_1.isFileDisabled)(callerFilePath ?? "")) {
18
+ return { [common_1.ETO_SKIP_FILE]: true };
19
+ }
20
+ const normalized = {
21
+ ...definition,
22
+ fields: normalizeFields(definition.fields),
23
+ };
24
+ // Refused here, at the declaration, as well as when the module resolves its
25
+ // indexes, so a leaky scope never gets as far as booting.
26
+ (0, search_scope_1.validateSearchScope)(normalized);
27
+ global.EtoModule.setSearchIndex(normalized, callerFilePath ?? undefined);
28
+ return normalized;
29
+ }
30
+ /**
31
+ * Compiles a `search.define(...)` schema into plain SearchFieldDefinition
32
+ * records. Normalization happens here, at the declaration boundary, so the
33
+ * Search Module only ever sees plain definitions and nothing user-facing
34
+ * calls `toFields()`.
35
+ *
36
+ * The input type advertises `toFields()` structurally, so normalization
37
+ * duck-types on it rather than checking for our own class — a schema built by
38
+ * a duplicated copy of @etohq/utils, or any object honoring the contract,
39
+ * still normalizes.
40
+ */
41
+ function normalizeFields(fields) {
42
+ if (typeof fields?.toFields !== "function") {
43
+ throw new Error("`defineSearchIndex` fields must come from `search.define({ ... })`");
44
+ }
45
+ return fields.toFields();
46
+ }
47
+ //# sourceMappingURL=define-search-index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"define-search-index.js","sourceRoot":"","sources":["../../src/search/define-search-index.ts"],"names":[],"mappings":";;AAiBA,8CAuBC;AAvCD,sCAIkB;AAClB,iDAAoD;AAEpD;;;;;;;;GAQG;AACH,SAAgB,iBAAiB,CAG/B,UAA0D;IAE1D,MAAM,cAAc,GAAG,IAAA,0BAAiB,GAAE,CAAA;IAE1C,IAAI,IAAA,uBAAc,EAAC,cAAc,IAAI,EAAE,CAAC,EAAE,CAAC;QACzC,OAAO,EAAE,CAAC,sBAAa,CAAC,EAAE,IAAI,EAAS,CAAA;IACzC,CAAC;IAED,MAAM,UAAU,GAAsC;QACpD,GAAG,UAAU;QACb,MAAM,EAAE,eAAe,CAAC,UAAU,CAAC,MAAM,CAAC;KAC3C,CAAA;IAED,4EAA4E;IAC5E,0DAA0D;IAC1D,IAAA,kCAAmB,EAAC,UAAU,CAAC,CAAA;IAE/B,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,UAAU,EAAE,cAAc,IAAI,SAAS,CAAC,CAAA;IAExE,OAAO,UAAU,CAAA;AACnB,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAS,eAAe,CACtB,MAA0C;IAE1C,IAAI,OAAO,MAAM,EAAE,QAAQ,KAAK,UAAU,EAAE,CAAC;QAC3C,MAAM,IAAI,KAAK,CACb,oEAAoE,CACrE,CAAA;IACH,CAAC;IAED,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAA;AAC1B,CAAC"}
@@ -0,0 +1,112 @@
1
+ import { QueryContextType, SearchTypes } from "@etohq/types";
2
+ /**
3
+ * `seed` and `consume` implementations backed by `query.graph`.
4
+ *
5
+ * Nearly every index is a projection of an entity that already lives behind
6
+ * `query.graph`, so the helpers simplify catchup, soft-deletes and similar,
7
+ * which should be enough for most use cases.
8
+ */
9
+ type GraphRow = Record<string, any>;
10
+ export type SearchConsumeEvent = Parameters<NonNullable<SearchTypes.SearchIndexDefinition["consume"]>>[0];
11
+ export type SearchGraphQueryContext = QueryContextType | ((context: SearchTypes.SearchIngestionContext) => QueryContextType);
12
+ export interface SearchGraphSourceOptions<Fields extends SearchTypes.SearchIndexFieldsInput, TRow extends GraphRow = GraphRow> {
13
+ /**
14
+ * The `query.graph` entrypoint to read from. Defaults to the index
15
+ * definition's `entity`.
16
+ */
17
+ entity?: string;
18
+ /**
19
+ * The fields to select from `query.graph`. Without a `transform` the row is
20
+ * indexed as-is, so this should then select exactly what the index declares.
21
+ */
22
+ fields: string[];
23
+ /**
24
+ * The query context `query.graph` reads the rows with, e.g. the pricing
25
+ * context `variants.calculated_price` needs. Applied to seed, catch-up and
26
+ * `consume` alike.
27
+ */
28
+ context?: SearchGraphQueryContext;
29
+ /**
30
+ * Maps a page of rows to the documents to index, e.g. `rows.map(toDocument)`.
31
+ * Async, and handed the whole page, so reads `query.graph` cannot make in
32
+ * one pass — prices in several currencies, say — cost a fixed number of
33
+ * queries per page. Every document must carry the row's primary key value
34
+ * as `id`; a row with no document is excluded, which `consume` and the
35
+ * catch-up pass turn into a delete so it leaves the index rather than
36
+ * going stale in it.
37
+ *
38
+ * Defaults to indexing the rows as-is.
39
+ */
40
+ transform?: (rows: TRow[], context: SearchTypes.SearchIngestionContext) => SearchTypes.InferSearchDocumentType<Fields>[] | Promise<SearchTypes.InferSearchDocumentType<Fields>[]>;
41
+ }
42
+ export interface SearchGraphSeedOptions<Fields extends SearchTypes.SearchIndexFieldsInput, TRow extends GraphRow = GraphRow> extends SearchGraphSourceOptions<Fields, TRow> {
43
+ /**
44
+ * The number of rows read from `query.graph` per page.
45
+ *
46
+ * @default 200
47
+ */
48
+ batch_size?: number;
49
+ }
50
+ export interface SearchGraphConsumeOptions<Fields extends SearchTypes.SearchIndexFieldsInput, TRow extends GraphRow = GraphRow> extends SearchGraphSourceOptions<Fields, TRow> {
51
+ /**
52
+ * The IDs of the documents the event affects, which are read back through
53
+ * `query.graph` and written to the index. May be async, e.g. to map an
54
+ * event about a variant or a category to the products it belongs to.
55
+ *
56
+ * Defaults to `event.data.id`, as a single ID or an array of them.
57
+ */
58
+ resolve_ids?: (event: SearchConsumeEvent, context: SearchTypes.SearchIngestionContext) => string[] | string | undefined | Promise<string[] | string | undefined>;
59
+ /**
60
+ * Whether the event removes its documents from the index rather than
61
+ * updating them. A deleted row can't be read back, so it's deleted by ID
62
+ * without going to `query.graph`.
63
+ *
64
+ * @default an event whose name ends in `.deleted`
65
+ */
66
+ is_delete?: (event: SearchConsumeEvent) => boolean;
67
+ }
68
+ /**
69
+ * Builds an index definition's `seed` from a `query.graph` query.
70
+ *
71
+ * The seed pages the entity in ascending order of the index' primary key, so
72
+ * the next page starts after the last row and a run interrupted halfway
73
+ * resumes from the context's `last_key` rather than restarting. The catch-up
74
+ * pass that follows a full seed reads the rows touched since it started with
75
+ * soft-deleted ones included, and turns those — along with any row the
76
+ * `transform` rejects — into deletes.
77
+ *
78
+ * @example
79
+ * const productFields = search.define({
80
+ * id: search.keyword().filterable(),
81
+ * title: search.text().searchable(),
82
+ * })
83
+ *
84
+ * export default defineSearchIndex({
85
+ * name: "product",
86
+ * entity: "product",
87
+ * fields: productFields,
88
+ * seed: graphSeed({ fields: ["id", "title"] }),
89
+ * })
90
+ */
91
+ export declare function graphSeed<Fields extends SearchTypes.SearchIndexFieldsInput, TRow extends GraphRow = GraphRow>(options: SearchGraphSeedOptions<Fields, TRow>): NonNullable<SearchTypes.SearchIndexDefinitionInput<Fields>["seed"]>;
92
+ /**
93
+ * Builds an index definition's `consume` from a `query.graph` query.
94
+ *
95
+ * The event's IDs are read back through `query.graph` and upserted. An ID the
96
+ * read doesn't return, or whose row the `transform` rejects, is deleted
97
+ * instead — which is what keeps a row that was removed, unpublished, or
98
+ * filtered out of the index from lingering in it.
99
+ *
100
+ * @example
101
+ * export default defineSearchIndex({
102
+ * name: "product",
103
+ * entity: "product",
104
+ * fields: productFields,
105
+ * events: ["product.created", "product.updated", "product.deleted"],
106
+ * consume: graphConsume({ fields: ["id", "title"] }),
107
+ * seed: graphSeed({ fields: ["id", "title"] }),
108
+ * })
109
+ */
110
+ export declare function graphConsume<Fields extends SearchTypes.SearchIndexFieldsInput, TRow extends GraphRow = GraphRow>(options: SearchGraphConsumeOptions<Fields, TRow>): NonNullable<SearchTypes.SearchIndexDefinitionInput<Fields>["consume"]>;
111
+ export {};
112
+ //# sourceMappingURL=definition-helpers.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"definition-helpers.d.ts","sourceRoot":"","sources":["../../src/search/definition-helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAE5D;;;;;;GAMG;AAEH,KAAK,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;AAMnC,MAAM,MAAM,kBAAkB,GAAG,UAAU,CACzC,WAAW,CAAC,WAAW,CAAC,qBAAqB,CAAC,SAAS,CAAC,CAAC,CAC1D,CAAC,CAAC,CAAC,CAAA;AAEJ,MAAM,MAAM,uBAAuB,GAC/B,gBAAgB,GAChB,CAAC,CAAC,OAAO,EAAE,WAAW,CAAC,sBAAsB,KAAK,gBAAgB,CAAC,CAAA;AAEvE,MAAM,WAAW,wBAAwB,CACvC,MAAM,SAAS,WAAW,CAAC,sBAAsB,EACjD,IAAI,SAAS,QAAQ,GAAG,QAAQ;IAEhC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;;OAGG;IACH,MAAM,EAAE,MAAM,EAAE,CAAA;IAEhB;;;;OAIG;IACH,OAAO,CAAC,EAAE,uBAAuB,CAAA;IAEjC;;;;;;;;;;OAUG;IACH,SAAS,CAAC,EAAE,CACV,IAAI,EAAE,IAAI,EAAE,EACZ,OAAO,EAAE,WAAW,CAAC,sBAAsB,KAEzC,WAAW,CAAC,uBAAuB,CAAC,MAAM,CAAC,EAAE,GAC7C,OAAO,CAAC,WAAW,CAAC,uBAAuB,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;CAC3D;AAED,MAAM,WAAW,sBAAsB,CACrC,MAAM,SAAS,WAAW,CAAC,sBAAsB,EACjD,IAAI,SAAS,QAAQ,GAAG,QAAQ,CAChC,SAAQ,wBAAwB,CAAC,MAAM,EAAE,IAAI,CAAC;IAC9C;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,yBAAyB,CACxC,MAAM,SAAS,WAAW,CAAC,sBAAsB,EACjD,IAAI,SAAS,QAAQ,GAAG,QAAQ,CAChC,SAAQ,wBAAwB,CAAC,MAAM,EAAE,IAAI,CAAC;IAC9C;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,CACZ,KAAK,EAAE,kBAAkB,EACzB,OAAO,EAAE,WAAW,CAAC,sBAAsB,KACxC,MAAM,EAAE,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,MAAM,EAAE,GAAG,MAAM,GAAG,SAAS,CAAC,CAAA;IAE3E;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,kBAAkB,KAAK,OAAO,CAAA;CACnD;AAuFD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,SAAS,CACvB,MAAM,SAAS,WAAW,CAAC,sBAAsB,EACjD,IAAI,SAAS,QAAQ,GAAG,QAAQ,EAEhC,OAAO,EAAE,sBAAsB,CAAC,MAAM,EAAE,IAAI,CAAC,GAC5C,WAAW,CAAC,WAAW,CAAC,0BAA0B,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAoErE;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,YAAY,CAC1B,MAAM,SAAS,WAAW,CAAC,sBAAsB,EACjD,IAAI,SAAS,QAAQ,GAAG,QAAQ,EAEhC,OAAO,EAAE,yBAAyB,CAAC,MAAM,EAAE,IAAI,CAAC,GAC/C,WAAW,CAAC,WAAW,CAAC,0BAA0B,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,CAAC,CAiDxE"}
@@ -0,0 +1,196 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.graphSeed = graphSeed;
4
+ exports.graphConsume = graphConsume;
5
+ // The timestamps every Eto entity carries, which the catch-up pass reads.
6
+ const UPDATED_AT_FIELD = "updated_at";
7
+ const DELETED_AT_FIELD = "deleted_at";
8
+ function toArray(value) {
9
+ if (value === null || value === undefined) {
10
+ return [];
11
+ }
12
+ return (Array.isArray(value) ? value : [value]).map((entry) => String(entry));
13
+ }
14
+ /**
15
+ * The reindex filters, narrowed by the catch-up window and the paging cursor.
16
+ *
17
+ * Those two go under `$and` rather than beside the caller's filters: they are
18
+ * keyed on `updated_at` and on the primary key, so overwriting would quietly
19
+ * widen a `reindex({ filters: { id: [...] } })` into a full scan from the
20
+ * cursor once it pages.
21
+ */
22
+ function seedFilters(filters, constraints) {
23
+ if (!constraints.length) {
24
+ return filters ?? {};
25
+ }
26
+ if (!filters || !Object.keys(filters).length) {
27
+ return Object.assign({}, ...constraints);
28
+ }
29
+ const existing = Array.isArray(filters.$and) ? filters.$and : [];
30
+ return { ...filters, $and: [...existing, ...constraints] };
31
+ }
32
+ function withFields(fields, ...extra) {
33
+ const missing = extra.filter((field) => !fields.includes(field));
34
+ return missing.length ? [...fields, ...missing] : fields;
35
+ }
36
+ /**
37
+ * The documents for a page of rows, and the keys they were produced for. A
38
+ * key with no document is what the callers delete.
39
+ */
40
+ async function toDocuments(rows, options, context) {
41
+ if (!options.transform) {
42
+ const documents = rows;
43
+ return {
44
+ documents,
45
+ produced: new Set(rows.map((row) => String(row[context.index.primary_key]))),
46
+ };
47
+ }
48
+ const documents = await options.transform(rows, context);
49
+ const produced = new Set();
50
+ for (const document of documents) {
51
+ if (document.id === undefined || document.id === null) {
52
+ throw new Error(`Search index "${context.index.name}": transform returned a document without an "id"`);
53
+ }
54
+ produced.add(String(document.id));
55
+ }
56
+ return { documents, produced };
57
+ }
58
+ function queryContext(option, context) {
59
+ const resolved = typeof option === "function" ? option(context) : option;
60
+ return resolved ? { context: resolved } : {};
61
+ }
62
+ /**
63
+ * Builds an index definition's `seed` from a `query.graph` query.
64
+ *
65
+ * The seed pages the entity in ascending order of the index' primary key, so
66
+ * the next page starts after the last row and a run interrupted halfway
67
+ * resumes from the context's `last_key` rather than restarting. The catch-up
68
+ * pass that follows a full seed reads the rows touched since it started with
69
+ * soft-deleted ones included, and turns those — along with any row the
70
+ * `transform` rejects — into deletes.
71
+ *
72
+ * @example
73
+ * const productFields = search.define({
74
+ * id: search.keyword().filterable(),
75
+ * title: search.text().searchable(),
76
+ * })
77
+ *
78
+ * export default defineSearchIndex({
79
+ * name: "product",
80
+ * entity: "product",
81
+ * fields: productFields,
82
+ * seed: graphSeed({ fields: ["id", "title"] }),
83
+ * })
84
+ */
85
+ function graphSeed(options) {
86
+ const { fields, batch_size: batchSize = 200 } = options;
87
+ return async function* graphSeedGenerator(context) {
88
+ const { container, index, catchup, last_key: lastKey } = context;
89
+ const entity = options.entity ?? index.entity;
90
+ const primaryKey = index.primary_key;
91
+ // The key pages the rows and identifies them in a delete, and the
92
+ // soft-delete marker decides which is which — both have to be readable off
93
+ // the rows, whether or not the index itself holds them.
94
+ const selection = catchup
95
+ ? withFields(fields, primaryKey, DELETED_AT_FIELD)
96
+ : withFields(fields, primaryKey);
97
+ let cursor = lastKey;
98
+ while (true) {
99
+ const { data } = (await container.query.graph({
100
+ entity,
101
+ fields: selection,
102
+ filters: seedFilters(context.filters, [
103
+ ...(catchup ? [{ [UPDATED_AT_FIELD]: { $gte: catchup.since } }] : []),
104
+ ...(cursor !== undefined ? [{ [primaryKey]: { $gt: cursor } }] : []),
105
+ ]),
106
+ pagination: { take: batchSize, order: { [primaryKey]: "ASC" } },
107
+ withDeleted: !!catchup,
108
+ ...queryContext(options.context, context),
109
+ }));
110
+ if (!data.length) {
111
+ return;
112
+ }
113
+ // Only the catch-up pass can observe a row leaving the index — a full
114
+ // seed builds the index from nothing, so absence is enough there.
115
+ const rows = catchup ? data.filter((row) => !row[DELETED_AT_FIELD]) : data;
116
+ const { documents, produced } = await toDocuments(rows, options, context);
117
+ const deletedIds = catchup
118
+ ? data
119
+ .map((row) => String(row[primaryKey]))
120
+ .filter((id) => !produced.has(id))
121
+ : [];
122
+ const mutations = [];
123
+ if (documents.length) {
124
+ mutations.push({ action: "upsert", documents });
125
+ }
126
+ if (deletedIds.length) {
127
+ mutations.push({
128
+ action: "delete",
129
+ filters: { [primaryKey]: deletedIds },
130
+ });
131
+ }
132
+ if (mutations.length) {
133
+ yield mutations;
134
+ }
135
+ if (data.length < batchSize) {
136
+ return;
137
+ }
138
+ cursor = String(data[data.length - 1][primaryKey]);
139
+ }
140
+ };
141
+ }
142
+ /**
143
+ * Builds an index definition's `consume` from a `query.graph` query.
144
+ *
145
+ * The event's IDs are read back through `query.graph` and upserted. An ID the
146
+ * read doesn't return, or whose row the `transform` rejects, is deleted
147
+ * instead — which is what keeps a row that was removed, unpublished, or
148
+ * filtered out of the index from lingering in it.
149
+ *
150
+ * @example
151
+ * export default defineSearchIndex({
152
+ * name: "product",
153
+ * entity: "product",
154
+ * fields: productFields,
155
+ * events: ["product.created", "product.updated", "product.deleted"],
156
+ * consume: graphConsume({ fields: ["id", "title"] }),
157
+ * seed: graphSeed({ fields: ["id", "title"] }),
158
+ * })
159
+ */
160
+ function graphConsume(options) {
161
+ const { fields, resolve_ids: resolveIds = (event) => event.data?.id, is_delete: isDelete = (event) => event.name.endsWith(".deleted"), } = options;
162
+ return async function graphConsumer(event, context) {
163
+ const { container, index } = context;
164
+ const entity = options.entity ?? index.entity;
165
+ const primaryKey = index.primary_key;
166
+ const ids = toArray(await resolveIds(event, context));
167
+ if (!ids.length) {
168
+ return [];
169
+ }
170
+ if (isDelete(event)) {
171
+ return [{ action: "delete", filters: { [primaryKey]: ids } }];
172
+ }
173
+ const { data } = (await container.query.graph({
174
+ entity,
175
+ fields: withFields(fields, primaryKey),
176
+ filters: { [primaryKey]: ids },
177
+ ...queryContext(options.context, context),
178
+ }));
179
+ const { documents, produced } = await toDocuments(data, options, context);
180
+ const mutations = [];
181
+ if (documents.length) {
182
+ mutations.push({ action: "upsert", documents });
183
+ }
184
+ // Gone, or rejected by the transform — either way it has no business being
185
+ // in the index anymore.
186
+ const removedIds = ids.filter((id) => !produced.has(id));
187
+ if (removedIds.length) {
188
+ mutations.push({
189
+ action: "delete",
190
+ filters: { [primaryKey]: removedIds },
191
+ });
192
+ }
193
+ return mutations;
194
+ };
195
+ }
196
+ //# sourceMappingURL=definition-helpers.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"definition-helpers.js","sourceRoot":"","sources":["../../src/search/definition-helpers.ts"],"names":[],"mappings":";;AAoNA,8BAyEC;AAoBD,oCAsDC;AA3VD,0EAA0E;AAC1E,MAAM,gBAAgB,GAAG,YAAY,CAAA;AACrC,MAAM,gBAAgB,GAAG,YAAY,CAAA;AA0FrC,SAAS,OAAO,CAAC,KAAc;IAC7B,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QAC1C,OAAO,EAAE,CAAA;IACX,CAAC;IACD,OAAO,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,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;AAC/E,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,WAAW,CAClB,OAAwC,EACxC,WAAkC;IAElC,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;QACxB,OAAO,OAAO,IAAI,EAAE,CAAA;IACtB,CAAC;IAED,IAAI,CAAC,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,CAAC;QAC7C,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,GAAG,WAAW,CAAC,CAAA;IAC1C,CAAC;IAED,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAA;IAChE,OAAO,EAAE,GAAG,OAAO,EAAE,IAAI,EAAE,CAAC,GAAG,QAAQ,EAAE,GAAG,WAAW,CAAC,EAAE,CAAA;AAC5D,CAAC;AAED,SAAS,UAAU,CAAC,MAAgB,EAAE,GAAG,KAAe;IACtD,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAA;IAChE,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAA;AAC1D,CAAC;AAED;;;GAGG;AACH,KAAK,UAAU,WAAW,CAIxB,IAAY,EACZ,OAA+C,EAC/C,OAA2C;IAK3C,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;QACvB,MAAM,SAAS,GACb,IAAgE,CAAA;QAClE,OAAO;YACL,SAAS;YACT,QAAQ,EAAE,IAAI,GAAG,CACf,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAC1D;SACF,CAAA;IACH,CAAC;IAED,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;IACxD,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAA;IAElC,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;QACjC,IAAI,QAAQ,CAAC,EAAE,KAAK,SAAS,IAAI,QAAQ,CAAC,EAAE,KAAK,IAAI,EAAE,CAAC;YACtD,MAAM,IAAI,KAAK,CACb,iBAAiB,OAAO,CAAC,KAAK,CAAC,IAAI,kDAAkD,CACtF,CAAA;QACH,CAAC;QACD,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAA;IACnC,CAAC;IAED,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAA;AAChC,CAAC;AAED,SAAS,YAAY,CACnB,MAA2C,EAC3C,OAA2C;IAE3C,MAAM,QAAQ,GAAG,OAAO,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAA;IACxE,OAAO,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAA;AAC9C,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,SAAgB,SAAS,CAIvB,OAA6C;IAE7C,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,GAAG,GAAG,EAAE,GAAG,OAAO,CAAA;IAEvD,OAAO,KAAK,SAAS,CAAC,CAAC,kBAAkB,CAAC,OAAO;QAC/C,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,CAAA;QAEhE,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,KAAK,CAAC,MAAM,CAAA;QAC7C,MAAM,UAAU,GAAG,KAAK,CAAC,WAAW,CAAA;QAEpC,kEAAkE;QAClE,2EAA2E;QAC3E,wDAAwD;QACxD,MAAM,SAAS,GAAG,OAAO;YACvB,CAAC,CAAC,UAAU,CAAC,MAAM,EAAE,UAAU,EAAE,gBAAgB,CAAC;YAClD,CAAC,CAAC,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;QAElC,IAAI,MAAM,GAAuB,OAAO,CAAA;QAExC,OAAO,IAAI,EAAE,CAAC;YACZ,MAAM,EAAE,IAAI,EAAE,GAAG,CAAC,MAAM,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC;gBAC5C,MAAM;gBACN,MAAM,EAAE,SAAS;gBACjB,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC,OAAO,EAAE;oBACpC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,gBAAgB,CAAC,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;oBACrE,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;iBACrE,CAAC;gBACF,UAAU,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,EAAE;gBAC/D,WAAW,EAAE,CAAC,CAAC,OAAO;gBACtB,GAAG,YAAY,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC;aAC1C,CAAC,CAAqB,CAAA;YAEvB,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;gBACjB,OAAM;YACR,CAAC;YAED,sEAAsE;YACtE,kEAAkE;YAClE,MAAM,IAAI,GAAG,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;YAC1E,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,MAAM,WAAW,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,CAAA;YACzE,MAAM,UAAU,GAAG,OAAO;gBACxB,CAAC,CAAC,IAAI;qBACD,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC;qBACrC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;gBACtC,CAAC,CAAC,EAAE,CAAA;YAEN,MAAM,SAAS,GAAkD,EAAE,CAAA;YACnE,IAAI,SAAS,CAAC,MAAM,EAAE,CAAC;gBACrB,SAAS,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAA;YACjD,CAAC;YAED,IAAI,UAAU,CAAC,MAAM,EAAE,CAAC;gBACtB,SAAS,CAAC,IAAI,CAAC;oBACb,MAAM,EAAE,QAAQ;oBAChB,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,EAAE,UAAU,EAAE;iBACtC,CAAC,CAAA;YACJ,CAAC;YAED,IAAI,SAAS,CAAC,MAAM,EAAE,CAAC;gBACrB,MAAM,SAAS,CAAA;YACjB,CAAC;YAED,IAAI,IAAI,CAAC,MAAM,GAAG,SAAS,EAAE,CAAC;gBAC5B,OAAM;YACR,CAAC;YAED,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAA;QACpD,CAAC;IACH,CAAC,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,YAAY,CAI1B,OAAgD;IAEhD,MAAM,EACJ,MAAM,EACN,WAAW,EAAE,UAAU,GAAG,CAAC,KAAK,EAAE,EAAE,CAAE,KAAK,CAAC,IAAY,EAAE,EAAE,EAC5D,SAAS,EAAE,QAAQ,GAAG,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,GACjE,GAAG,OAAO,CAAA;IAEX,OAAO,KAAK,UAAU,aAAa,CAAC,KAAK,EAAE,OAAO;QAChD,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,OAAO,CAAA;QAEpC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,KAAK,CAAC,MAAM,CAAA;QAC7C,MAAM,UAAU,GAAG,KAAK,CAAC,WAAW,CAAA;QACpC,MAAM,GAAG,GAAG,OAAO,CAAC,MAAM,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAA;QAErD,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;YAChB,OAAO,EAAE,CAAA;QACX,CAAC;QAED,IAAI,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACpB,OAAO,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,EAAE,GAAG,EAAE,EAAE,CAAC,CAAA;QAC/D,CAAC;QAED,MAAM,EAAE,IAAI,EAAE,GAAG,CAAC,MAAM,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC;YAC5C,MAAM;YACN,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC;YACtC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,EAAE,GAAG,EAAE;YAC9B,GAAG,YAAY,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC;SAC1C,CAAC,CAAqB,CAAA;QAEvB,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,MAAM,WAAW,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,CAAA;QAEzE,MAAM,SAAS,GAAkD,EAAE,CAAA;QAEnE,IAAI,SAAS,CAAC,MAAM,EAAE,CAAC;YACrB,SAAS,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAA;QACjD,CAAC;QAED,2EAA2E;QAC3E,wBAAwB;QACxB,MAAM,UAAU,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAA;QACxD,IAAI,UAAU,CAAC,MAAM,EAAE,CAAC;YACtB,SAAS,CAAC,IAAI,CAAC;gBACb,MAAM,EAAE,QAAQ;gBAChB,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,EAAE,UAAU,EAAE;aACtC,CAAC,CAAA;QACJ,CAAC;QAED,OAAO,SAAS,CAAA;IAClB,CAAC,CAAA;AACH,CAAC"}
@@ -0,0 +1,29 @@
1
+ import { SearchTypes } from "@etohq/types";
2
+ /**
3
+ * Document projection helpers shared by search providers, so that path
4
+ * flattening, value coercion and primary-key handling behave identically no
5
+ * matter which engine an index definition runs on.
6
+ */
7
+ /**
8
+ * Walks a dotted path, flattening through arrays encountered on the way —
9
+ * arrays of objects collapse to per-leaf arrays, which keeps index
10
+ * definitions portable across providers.
11
+ */
12
+ export declare function readDocumentPath(source: unknown, segments: string[]): unknown[];
13
+ /** Writes a value at a dotted path, creating intermediate objects. */
14
+ export declare function setDocumentPath(target: Record<string, any>, path: string, value: unknown): void;
15
+ export declare function searchValueToNumber(value: unknown, isDate: boolean): number | undefined;
16
+ export declare function searchValueToBoolean(value: unknown): boolean;
17
+ /**
18
+ * Narrows a source document to the requested dotted paths, keeping the shape
19
+ * of intermediate objects and arrays.
20
+ */
21
+ export declare function projectDocument(source: Record<string, unknown>, paths: string[]): Record<string, unknown>;
22
+ /**
23
+ * Recognises a filter that is nothing but primary-key membership, so a delete
24
+ * can go straight to the id lookup instead of compiling the filter tree.
25
+ */
26
+ export declare function extractPrimaryKeyFilter(filters: SearchTypes.SearchFilters, plan: {
27
+ primary_key: string;
28
+ }): string[] | undefined;
29
+ //# sourceMappingURL=document-utils.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"document-utils.d.ts","sourceRoot":"","sources":["../../src/search/document-utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAE1C;;;;GAIG;AAEH;;;;GAIG;AACH,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,OAAO,EACf,QAAQ,EAAE,MAAM,EAAE,GACjB,OAAO,EAAE,CA6BX;AAED,sEAAsE;AACtE,wBAAgB,eAAe,CAC7B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC3B,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,OAAO,GACb,IAAI,CAUN;AAED,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,OAAO,GACd,MAAM,GAAG,SAAS,CAUpB;AAED,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAS5D;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,KAAK,EAAE,MAAM,EAAE,GACd,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAmCzB;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CACrC,OAAO,EAAE,WAAW,CAAC,aAAa,EAClC,IAAI,EAAE;IAAE,WAAW,EAAE,MAAM,CAAA;CAAE,GAC5B,MAAM,EAAE,GAAG,SAAS,CAmCtB"}
@@ -0,0 +1,134 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.readDocumentPath = readDocumentPath;
4
+ exports.setDocumentPath = setDocumentPath;
5
+ exports.searchValueToNumber = searchValueToNumber;
6
+ exports.searchValueToBoolean = searchValueToBoolean;
7
+ exports.projectDocument = projectDocument;
8
+ exports.extractPrimaryKeyFilter = extractPrimaryKeyFilter;
9
+ /**
10
+ * Document projection helpers shared by search providers, so that path
11
+ * flattening, value coercion and primary-key handling behave identically no
12
+ * matter which engine an index definition runs on.
13
+ */
14
+ /**
15
+ * Walks a dotted path, flattening through arrays encountered on the way —
16
+ * arrays of objects collapse to per-leaf arrays, which keeps index
17
+ * definitions portable across providers.
18
+ */
19
+ function readDocumentPath(source, segments) {
20
+ let current = [source];
21
+ for (const segment of segments) {
22
+ const next = [];
23
+ for (const value of current) {
24
+ if (value === null || value === undefined) {
25
+ continue;
26
+ }
27
+ if (Array.isArray(value)) {
28
+ for (const entry of value) {
29
+ const resolved = entry?.[segment];
30
+ if (resolved !== undefined) {
31
+ next.push(resolved);
32
+ }
33
+ }
34
+ continue;
35
+ }
36
+ const resolved = value?.[segment];
37
+ if (resolved !== undefined) {
38
+ next.push(resolved);
39
+ }
40
+ }
41
+ current = next;
42
+ }
43
+ return current.flat(Infinity).filter((v) => v !== null && v !== undefined);
44
+ }
45
+ /** Writes a value at a dotted path, creating intermediate objects. */
46
+ function setDocumentPath(target, path, value) {
47
+ const segments = path.split(".");
48
+ let cursor = target;
49
+ for (const segment of segments.slice(0, -1)) {
50
+ cursor[segment] ??= {};
51
+ cursor = cursor[segment];
52
+ }
53
+ cursor[segments[segments.length - 1]] = value;
54
+ }
55
+ function searchValueToNumber(value, isDate) {
56
+ const num = isDate
57
+ ? value instanceof Date
58
+ ? value.getTime()
59
+ : Date.parse(String(value))
60
+ : typeof value === "number"
61
+ ? value
62
+ : Number(value);
63
+ return Number.isNaN(num) ? undefined : num;
64
+ }
65
+ function searchValueToBoolean(value) {
66
+ if (typeof value === "boolean") {
67
+ return value;
68
+ }
69
+ // `Boolean("false")` is `true`, so string forms are read by content.
70
+ if (value === "true" || value === "false") {
71
+ return value === "true";
72
+ }
73
+ return Boolean(value);
74
+ }
75
+ /**
76
+ * Narrows a source document to the requested dotted paths, keeping the shape
77
+ * of intermediate objects and arrays.
78
+ */
79
+ function projectDocument(source, paths) {
80
+ const picked = {};
81
+ for (const path of paths) {
82
+ const segments = path.split(".");
83
+ const [head, ...rest] = segments;
84
+ const value = source?.[head];
85
+ if (value === undefined) {
86
+ continue;
87
+ }
88
+ if (!rest.length) {
89
+ picked[head] = value;
90
+ continue;
91
+ }
92
+ // Recurse so that `variants.title` keeps the shape of `variants`.
93
+ if (Array.isArray(value)) {
94
+ const existing = Array.isArray(picked[head]) ? picked[head] : [];
95
+ picked[head] = value.map((entry, i) => Object.assign(existing[i] ?? {}, projectDocument(entry, [rest.join(".")])));
96
+ }
97
+ else if (value && typeof value === "object") {
98
+ picked[head] = Object.assign(picked[head] ?? {}, projectDocument(value, [rest.join(".")]));
99
+ }
100
+ }
101
+ return picked;
102
+ }
103
+ /**
104
+ * Recognises a filter that is nothing but primary-key membership, so a delete
105
+ * can go straight to the id lookup instead of compiling the filter tree.
106
+ */
107
+ function extractPrimaryKeyFilter(filters, plan) {
108
+ const keys = Object.keys(filters);
109
+ if (keys.length !== 1 || keys[0] !== plan.primary_key) {
110
+ return undefined;
111
+ }
112
+ const predicate = filters[plan.primary_key];
113
+ const asIds = (value) => {
114
+ const values = Array.isArray(value) ? value : [value];
115
+ return values.every((v) => typeof v === "string")
116
+ ? values
117
+ : undefined;
118
+ };
119
+ if (predicate === null || typeof predicate !== "object") {
120
+ return asIds(predicate);
121
+ }
122
+ if (Array.isArray(predicate)) {
123
+ return asIds(predicate);
124
+ }
125
+ const operators = Object.keys(predicate);
126
+ if (operators.length !== 1) {
127
+ return undefined;
128
+ }
129
+ if (operators[0] === "$eq" || operators[0] === "$in") {
130
+ return asIds(predicate[operators[0]]);
131
+ }
132
+ return undefined;
133
+ }
134
+ //# sourceMappingURL=document-utils.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"document-utils.js","sourceRoot":"","sources":["../../src/search/document-utils.ts"],"names":[],"mappings":";;AAaA,4CAgCC;AAGD,0CAcC;AAED,kDAaC;AAED,oDASC;AAMD,0CAsCC;AAMD,0DAsCC;AA9KD;;;;GAIG;AAEH;;;;GAIG;AACH,SAAgB,gBAAgB,CAC9B,MAAe,EACf,QAAkB;IAElB,IAAI,OAAO,GAAc,CAAC,MAAM,CAAC,CAAA;IAEjC,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,MAAM,IAAI,GAAc,EAAE,CAAA;QAE1B,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;YAC5B,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBAC1C,SAAQ;YACV,CAAC;YACD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzB,KAAK,MAAM,KAAK,IAAI,KAAK,EAAE,CAAC;oBAC1B,MAAM,QAAQ,GAAI,KAAiC,EAAE,CAAC,OAAO,CAAC,CAAA;oBAC9D,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;wBAC3B,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;oBACrB,CAAC;gBACH,CAAC;gBACD,SAAQ;YACV,CAAC;YACD,MAAM,QAAQ,GAAI,KAAiC,EAAE,CAAC,OAAO,CAAC,CAAA;YAC9D,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;gBAC3B,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;YACrB,CAAC;QACH,CAAC;QAED,OAAO,GAAG,IAAI,CAAA;IAChB,CAAC;IAED,OAAO,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,SAAS,CAAC,CAAA;AAC5E,CAAC;AAED,sEAAsE;AACtE,SAAgB,eAAe,CAC7B,MAA2B,EAC3B,IAAY,EACZ,KAAc;IAEd,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAChC,IAAI,MAAM,GAAG,MAAM,CAAA;IAEnB,KAAK,MAAM,OAAO,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5C,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,CAAA;QACtB,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,CAAA;IAC1B,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,GAAG,KAAK,CAAA;AAC/C,CAAC;AAED,SAAgB,mBAAmB,CACjC,KAAc,EACd,MAAe;IAEf,MAAM,GAAG,GAAG,MAAM;QAChB,CAAC,CAAC,KAAK,YAAY,IAAI;YACrB,CAAC,CAAC,KAAK,CAAC,OAAO,EAAE;YACjB,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC7B,CAAC,CAAC,OAAO,KAAK,KAAK,QAAQ;YAC3B,CAAC,CAAC,KAAK;YACP,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;IAEjB,OAAO,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAA;AAC5C,CAAC;AAED,SAAgB,oBAAoB,CAAC,KAAc;IACjD,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE,CAAC;QAC/B,OAAO,KAAK,CAAA;IACd,CAAC;IACD,qEAAqE;IACrE,IAAI,KAAK,KAAK,MAAM,IAAI,KAAK,KAAK,OAAO,EAAE,CAAC;QAC1C,OAAO,KAAK,KAAK,MAAM,CAAA;IACzB,CAAC;IACD,OAAO,OAAO,CAAC,KAAK,CAAC,CAAA;AACvB,CAAC;AAED;;;GAGG;AACH,SAAgB,eAAe,CAC7B,MAA+B,EAC/B,KAAe;IAEf,MAAM,MAAM,GAAwB,EAAE,CAAA;IAEtC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QAChC,MAAM,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,GAAG,QAAQ,CAAA;QAChC,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,CAAA;QAE5B,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,SAAQ;QACV,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAA;YACpB,SAAQ;QACV,CAAC;QAED,kEAAkE;QAClE,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;YAChE,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CACpC,MAAM,CAAC,MAAM,CACX,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,EACjB,eAAe,CAAC,KAAgC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CACpE,CACF,CAAA;QACH,CAAC;aAAM,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9C,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM,CAC1B,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,EAClB,eAAe,CAAC,KAAgC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CACpE,CAAA;QACH,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AAED;;;GAGG;AACH,SAAgB,uBAAuB,CACrC,OAAkC,EAClC,IAA6B;IAE7B,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IAEjC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,WAAW,EAAE,CAAC;QACtD,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,MAAM,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;IAE3C,MAAM,KAAK,GAAG,CAAC,KAAc,EAAwB,EAAE;QACrD,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;QACrD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC;YAC/C,CAAC,CAAE,MAAmB;YACtB,CAAC,CAAC,SAAS,CAAA;IACf,CAAC,CAAA;IAED,IAAI,SAAS,KAAK,IAAI,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;QACxD,OAAO,KAAK,CAAC,SAAS,CAAC,CAAA;IACzB,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;QAC7B,OAAO,KAAK,CAAC,SAAS,CAAC,CAAA;IACzB,CAAC;IAED,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;IAExC,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC3B,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,IAAI,SAAS,CAAC,CAAC,CAAC,KAAK,KAAK,IAAI,SAAS,CAAC,CAAC,CAAC,KAAK,KAAK,EAAE,CAAC;QACrD,OAAO,KAAK,CAAE,SAAqC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IACpE,CAAC;IAED,OAAO,SAAS,CAAA;AAClB,CAAC"}
@@ -1,6 +1,7 @@
1
- export * from "./abstract-service";
2
- export * from "./search-relations";
3
- export * from "./index-types";
4
- export * from "./variant-keys";
5
- export * from "./types";
1
+ export * from "./abstract-search-provider";
2
+ export * from "./define-search-index";
3
+ export * from "./definition-helpers";
4
+ export * from "./model";
5
+ export * from "./document-utils";
6
+ export * from "./search-scope";
6
7
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/search/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAA;AAClC,cAAc,oBAAoB,CAAA;AAClC,cAAc,eAAe,CAAA;AAC7B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,SAAS,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/search/index.ts"],"names":[],"mappings":"AAAA,cAAc,4BAA4B,CAAA;AAC1C,cAAc,uBAAuB,CAAA;AACrC,cAAc,sBAAsB,CAAA;AACpC,cAAc,SAAS,CAAA;AACvB,cAAc,kBAAkB,CAAA;AAChC,cAAc,gBAAgB,CAAA"}
@@ -14,9 +14,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
14
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
- __exportStar(require("./abstract-service"), exports);
18
- __exportStar(require("./search-relations"), exports);
19
- __exportStar(require("./index-types"), exports);
20
- __exportStar(require("./variant-keys"), exports);
21
- __exportStar(require("./types"), exports);
17
+ __exportStar(require("./abstract-search-provider"), exports);
18
+ __exportStar(require("./define-search-index"), exports);
19
+ __exportStar(require("./definition-helpers"), exports);
20
+ __exportStar(require("./model"), exports);
21
+ __exportStar(require("./document-utils"), exports);
22
+ __exportStar(require("./search-scope"), exports);
22
23
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/search/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,qDAAkC;AAClC,qDAAkC;AAClC,gDAA6B;AAC7B,iDAA8B;AAC9B,0CAAuB"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/search/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6DAA0C;AAC1C,wDAAqC;AACrC,uDAAoC;AACpC,0CAAuB;AACvB,mDAAgC;AAChC,iDAA8B"}