@medusajs/types 2.20.0 → 2.20.1

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.
@@ -71,15 +71,6 @@ export interface SearchFieldDefinition {
71
71
  * The fields of a nested object, only used when `type` is `object`.
72
72
  */
73
73
  fields?: Record<string, SearchFieldDefinition>;
74
- /**
75
- * Only meaningful on an array of objects. When `true`, filters on the object's
76
- * sub-fields must all match within a *single* element — `variants.color = "red"
77
- * AND variants.size = "XL"` matches a product with a red XL variant, not one
78
- * with a red S and a blue XL. Off by default because most engines flatten
79
- * arrays and cannot express it; a provider that cannot rejects it from
80
- * `upsertIndex`, so this fails at boot rather than over-matching later.
81
- */
82
- correlated?: boolean;
83
74
  /**
84
75
  * The dimensionality of the embedding stored in a `type: "vector"` field.
85
76
  * Required for vector fields; meaningless on any other type. When `embed` is
@@ -1 +1 @@
1
- {"version":3,"file":"field.d.ts","sourceRoot":"","sources":["../../src/search/field.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,MAAM,MAAM,eAAe,GACvB,SAAS,GACT,MAAM,GACN,SAAS,GACT,OAAO,GACP,SAAS,GACT,MAAM,GACN,KAAK,GACL,QAAQ,GACR,QAAQ,CAAA;AAEZ;;;;;;GAMG;AACH,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,CAAA;AAEzD;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,eAAe,CAAA;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;IAEf;;;;;OAKG;IACH,UAAU,CAAC,EAAE,OAAO,GAAG;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IAE1C;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG;QAAE,KAAK,CAAC,EAAE,eAAe,EAAE,CAAA;KAAE,CAAA;IAEnD;;;;;;;;;;OAUG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAA;IAE9C;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IAEpB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;;;OAIG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;IAEf;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;CAC3D"}
1
+ {"version":3,"file":"field.d.ts","sourceRoot":"","sources":["../../src/search/field.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,MAAM,MAAM,eAAe,GACvB,SAAS,GACT,MAAM,GACN,SAAS,GACT,OAAO,GACP,SAAS,GACT,MAAM,GACN,KAAK,GACL,QAAQ,GACR,QAAQ,CAAA;AAEZ;;;;;;GAMG;AACH,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,CAAA;AAEzD;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,eAAe,CAAA;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;IAEf;;;;;OAKG;IACH,UAAU,CAAC,EAAE,OAAO,GAAG;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IAE1C;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG;QAAE,KAAK,CAAC,EAAE,eAAe,EAAE,CAAA;KAAE,CAAA;IAEnD;;;;;;;;;;OAUG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAA;IAE9C;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;;;OAIG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;IAEf;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;CAC3D"}
@@ -73,9 +73,9 @@ export interface ISearchProvider {
73
73
  * keep serving reads, and never during a partial rebuild.
74
74
  *
75
75
  * Throw if the definition asks for something your engine can't hold, such as a
76
- * `correlated` field or a facet type it doesn't support. Since migrations run
77
- * before the application serves requests, the error surfaces at startup rather
78
- * than as wrong results later.
76
+ * facet type it doesn't support. Since migrations run before the application
77
+ * serves requests, the error surfaces at startup rather than as wrong results
78
+ * later.
79
79
  *
80
80
  * @param {object} input - The index to create or update.
81
81
  * @param {ResolvedSearchIndexDefinition} input.index - The definition,
@@ -29,7 +29,6 @@ export type SearchPropertyMetadata<T = any> = SchemaPropertyMetadata<T> & {
29
29
  };
30
30
  retrievable?: boolean;
31
31
  array?: boolean;
32
- correlated?: boolean;
33
32
  dimensions?: number;
34
33
  embed?: boolean;
35
34
  provider_options?: Record<string, Record<string, unknown>>;
@@ -72,8 +71,8 @@ export type InferSearchObjectValue<Schema extends SearchSchema> = {
72
71
  [K in keyof Schema]?: InferSearchPropertyValue<Schema[K]>;
73
72
  } & Record<string, unknown>;
74
73
  /**
75
- * The document type an index accepts, inferred from its fields input. Plain
76
- * JSON fields carry no type information, so they fall back to SearchDocument.
74
+ * The document type an index accepts, inferred from its `search.define(...)`
75
+ * fields schema.
77
76
  */
78
77
  export type InferSearchDocumentType<Fields extends SearchIndexFieldsInput> = Fields extends {
79
78
  schema: infer Schema extends SearchSchema;
@@ -88,14 +87,13 @@ export interface SearchFieldsSchemaLike {
88
87
  toFields(): Record<string, SearchFieldDefinition>;
89
88
  }
90
89
  /**
91
- * Input accepted by `defineSearchIndex` for the `fields` property —
92
- * plain JSON or a DSL fields schema.
90
+ * Input accepted by `defineSearchIndex` for the `fields` property — a
91
+ * schema from `search.define({ ... })`.
93
92
  */
94
- export type SearchIndexFieldsInput = Record<string, SearchFieldDefinition> | SearchFieldsSchemaLike;
93
+ export type SearchIndexFieldsInput = SearchFieldsSchemaLike;
95
94
  /**
96
95
  * Definition accepted by `defineSearchIndex` before fields are normalized.
97
- * When `fields` comes from the DSL, `seed` is type-checked against the
98
- * declared schema.
96
+ * `seed` is type-checked against the declared `search.define(...)` schema.
99
97
  */
100
98
  export type SearchIndexDefinitionInput<Fields extends SearchIndexFieldsInput = SearchIndexFieldsInput> = Omit<SearchIndexDefinition, "fields" | "seed"> & {
101
99
  fields: Fields;
@@ -1 +1 @@
1
- {"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../src/search/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAA;AACtE,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AACzC,OAAO,EACL,eAAe,EACf,qBAAqB,EACrB,eAAe,EAChB,MAAM,SAAS,CAAA;AAChB,OAAO,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AAE7E;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAA;AAElE;;;;;GAKG;AACH,MAAM,MAAM,sBAAsB,CAAC,CAAC,GAAG,GAAG,IAAI,sBAAsB,CAAC,CAAC,CAAC,GAAG;IACxE,QAAQ,EAAE;QACR,IAAI,EAAE,eAAe,CAAA;QACrB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;KAC9B,CAAA;IACD,UAAU,CAAC,EAAE,OAAO,GAAG;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IAC1C,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,SAAS,CAAC,EAAE,OAAO,GAAG;QAAE,KAAK,CAAC,EAAE,eAAe,EAAE,CAAA;KAAE,CAAA;IACnD,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;IAC1D,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAA;CAChD,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,CAAC,CAAC,IAAI;IAClC,SAAS,EAAE,CAAC,CAAA;IACZ,KAAK,CAAC,SAAS,EAAE,MAAM,GAAG,sBAAsB,CAAC,CAAC,CAAC,CAAA;CACpD,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAAA;AAEzB;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,IAAI,CAAA;CACf;AAED;;;;;;GAMG;AACH,MAAM,MAAM,wBAAwB,CAAC,CAAC,SAAS,kBAAkB,CAAC,GAAG,CAAC,IAClE,CAAC,CAAC,SAAS,iBAAiB,GAAG,CAAC,CAAC,WAAW,CAAC,EAAE,GAAG,CAAC,CAAC,WAAW,CAAC,CAAC,GACjE,IAAI,CAAA;AAER;;;;;;GAMG;AACH,MAAM,MAAM,sBAAsB,CAAC,MAAM,SAAS,YAAY,IAAI;KAC/D,CAAC,IAAI,MAAM,MAAM,CAAC,CAAC,EAAE,wBAAwB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;CAC1D,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAE3B;;;GAGG;AACH,MAAM,MAAM,uBAAuB,CAAC,MAAM,SAAS,sBAAsB,IACvE,MAAM,SAAS;IAAE,MAAM,EAAE,MAAM,MAAM,SAAS,YAAY,CAAA;CAAE,GACxD,sBAAsB,CAAC,MAAM,CAAC,GAAG;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,GAC/C,cAAc,CAAA;AAEpB;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,QAAQ,IAAI,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAA;CAClD;AAED;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAC9B,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,GACrC,sBAAsB,CAAA;AAE1B;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,CACpC,MAAM,SAAS,sBAAsB,GAAG,sBAAsB,IAC5D,IAAI,CAAC,qBAAqB,EAAE,QAAQ,GAAG,MAAM,CAAC,GAAG;IACnD,MAAM,EAAE,MAAM,CAAA;IAEd,IAAI,EAAE,CACJ,OAAO,EAAE,iBAAiB,KACvB,aAAa,CAAC,uBAAuB,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;CACtD,CAAA"}
1
+ {"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../src/search/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAA;AACtE,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AACzC,OAAO,EACL,eAAe,EACf,qBAAqB,EACrB,eAAe,EAChB,MAAM,SAAS,CAAA;AAChB,OAAO,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AAE7E;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAA;AAElE;;;;;GAKG;AACH,MAAM,MAAM,sBAAsB,CAAC,CAAC,GAAG,GAAG,IAAI,sBAAsB,CAAC,CAAC,CAAC,GAAG;IACxE,QAAQ,EAAE;QACR,IAAI,EAAE,eAAe,CAAA;QACrB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;KAC9B,CAAA;IACD,UAAU,CAAC,EAAE,OAAO,GAAG;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IAC1C,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,SAAS,CAAC,EAAE,OAAO,GAAG;QAAE,KAAK,CAAC,EAAE,eAAe,EAAE,CAAA;KAAE,CAAA;IACnD,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;IAC1D,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAA;CAChD,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,CAAC,CAAC,IAAI;IAClC,SAAS,EAAE,CAAC,CAAA;IACZ,KAAK,CAAC,SAAS,EAAE,MAAM,GAAG,sBAAsB,CAAC,CAAC,CAAC,CAAA;CACpD,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAAA;AAEzB;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,IAAI,CAAA;CACf;AAED;;;;;;GAMG;AACH,MAAM,MAAM,wBAAwB,CAAC,CAAC,SAAS,kBAAkB,CAAC,GAAG,CAAC,IAClE,CAAC,CAAC,SAAS,iBAAiB,GAAG,CAAC,CAAC,WAAW,CAAC,EAAE,GAAG,CAAC,CAAC,WAAW,CAAC,CAAC,GACjE,IAAI,CAAA;AAER;;;;;;GAMG;AACH,MAAM,MAAM,sBAAsB,CAAC,MAAM,SAAS,YAAY,IAAI;KAC/D,CAAC,IAAI,MAAM,MAAM,CAAC,CAAC,EAAE,wBAAwB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;CAC1D,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAE3B;;;GAGG;AACH,MAAM,MAAM,uBAAuB,CAAC,MAAM,SAAS,sBAAsB,IACvE,MAAM,SAAS;IAAE,MAAM,EAAE,MAAM,MAAM,SAAS,YAAY,CAAA;CAAE,GACxD,sBAAsB,CAAC,MAAM,CAAC,GAAG;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,GAC/C,cAAc,CAAA;AAEpB;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,QAAQ,IAAI,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAA;CAClD;AAED;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,sBAAsB,CAAA;AAE3D;;;GAGG;AACH,MAAM,MAAM,0BAA0B,CACpC,MAAM,SAAS,sBAAsB,GAAG,sBAAsB,IAC5D,IAAI,CAAC,qBAAqB,EAAE,QAAQ,GAAG,MAAM,CAAC,GAAG;IACnD,MAAM,EAAE,MAAM,CAAA;IAEd,IAAI,EAAE,CACJ,OAAO,EAAE,iBAAiB,KACvB,aAAa,CAAC,uBAAuB,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;CACtD,CAAA"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@medusajs/types",
3
- "version": "2.20.0",
3
+ "version": "2.20.1",
4
4
  "description": "Medusa Types definition",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -38,7 +38,7 @@
38
38
  "bignumber.js": "^9.1.2"
39
39
  },
40
40
  "devDependencies": {
41
- "@medusajs/deps": "2.20.0"
41
+ "@medusajs/deps": "2.20.1"
42
42
  },
43
43
  "peerDependencies": {
44
44
  "ioredis": "^5.4.1",