@sebspark/opensearch 0.1.2 → 0.2.1

package/dist/index.d.mts

@@ -20,6 +20,7 @@ type WithId = {
 };
 type ExcludeId<T> = Omit<T, 'id'>;
 type SubstringOf<T extends string> = T extends `${infer Prefix}${infer _Rest}` ? Prefix | SubstringOf<Exclude<T, Prefix>> : never;
+type NotUndefined<T> = T extends undefined ? never : T;
 
 type FieldName<T> = NestedStringPaths<ExcludeId<T>> | '*' | (string & {});
 type FieldObject<T> = {
@@ -76,14 +77,14 @@ type Regexp<T> = {
 type StandardAnalyzer = 'standard' | 'simple' | 'whitespace' | 'stop' | 'keyword' | 'pattern' | 'fingerprint';
 type LanguageAnalyzer = 'arabic' | 'armenian' | 'basque' | 'bengali' | 'brazilian' | 'bulgarian' | 'catalan' | 'czech' | 'danish' | 'dutch' | 'english' | 'estonian' | 'finnish' | 'french' | 'galician' | 'german' | 'greek' | 'hindi' | 'hungarian' | 'indonesian' | 'irish' | 'italian' | 'latvian' | 'lithuanian' | 'norwegian' | 'persian' | 'portuguese' | 'romanian' | 'russian' | 'sorani' | 'spanish' | 'swedish' | 'turkish' | 'thai';
 type Analyzer = StandardAnalyzer | LanguageAnalyzer;
-type Match<T> = {
+type Match<T> = Partial<{
     [P in NestedStringPaths<T>]: string | {
         query: string;
         operator?: 'and' | 'or';
         minimum_should_match?: number;
         analyzer?: Analyzer;
     };
-};
+}>;
 type MultiMatchParam<T extends string> = T | `${T}^${number}` | `${SubstringOf<T>}*`;
 type MultiMatch<T> = {
     query: string;
@@ -202,6 +203,9 @@ type OpenSearchQueryBody<T extends {
         fields?: OpenSearchFields<K>;
         filter?: OpenSearchFilter<T>;
         match?: Match<T>;
+        match_all?: {
+            boost?: number;
+        };
         multi_match?: MultiMatch<T>;
         from?: number;
         size?: number;
@@ -237,11 +241,18 @@ type OpenSearchQuery<T extends {
     from?: number;
     size?: number;
 } : never;
-type BasicOpenSearchFieldTypes = 'text' | 'keyword' | 'long' | 'integer' | 'short' | 'byte' | 'double' | 'float' | 'date' | 'boolean' | 'binary';
+type BasicOpenSearchFieldTypes = 'text' | 'keyword' | 'long' | 'integer' | 'short' | 'byte' | 'double' | 'float' | 'date' | 'boolean' | 'binary' | 'nested';
 type ElementType<T> = T extends Array<infer U> ? U : T;
 type OpenSearchFieldType<T> = ElementType<T> extends string ? 'text' | 'keyword' : ElementType<T> extends number ? 'long' | 'integer' | 'short' | 'byte' | 'double' | 'float' : ElementType<T> extends boolean ? 'boolean' : ElementType<T> extends Date ? 'date' : BasicOpenSearchFieldTypes;
 type FieldOptions<T> = {
-    type: OpenSearchFieldType<T>;
+    type: OpenSearchFieldType<NotUndefined<T>>;
+};
+type NestedFieldOptions<T> = {
+    type: 'nested';
+    properties: IndexProperties<T>;
+};
+type IndexProperties<T> = {
+    [K in keyof Partial<T>]: T[K] extends Date ? FieldOptions<T[K]> : NotUndefined<T[K]> extends object ? NotUndefined<T[K]> extends Array<infer U> ? U extends object ? NestedFieldOptions<U> : FieldOptions<T[K]> : IndexProperties<T[K]> : FieldOptions<T[K]>;
 };
 type IndexOptions<T extends WithId> = {
     settings?: {
@@ -255,9 +266,6 @@ type IndexOptions<T extends WithId> = {
     };
     aliases?: Record<string, Record<string, never>>;
 };
-type IndexProperties<T> = {
-    [K in keyof Partial<T>]: T[K] extends Date ? FieldOptions<T[K]> : T[K] extends object ? T[K] extends Array<infer U> ? FieldOptions<T[K]> : IndexProperties<T[K]> : FieldOptions<T[K]>;
-};
 
 interface OpenSearchHelper extends Client {
     typedSearch: <DataType extends WithId, ReturnType = DataType>(query: OpenSearchQuery<DataType, ReturnType>) => Promise<{

package/dist/index.d.ts

@@ -20,6 +20,7 @@ type WithId = {
 };
 type ExcludeId<T> = Omit<T, 'id'>;
 type SubstringOf<T extends string> = T extends `${infer Prefix}${infer _Rest}` ? Prefix | SubstringOf<Exclude<T, Prefix>> : never;
+type NotUndefined<T> = T extends undefined ? never : T;
 
 type FieldName<T> = NestedStringPaths<ExcludeId<T>> | '*' | (string & {});
 type FieldObject<T> = {
@@ -76,14 +77,14 @@ type Regexp<T> = {
 type StandardAnalyzer = 'standard' | 'simple' | 'whitespace' | 'stop' | 'keyword' | 'pattern' | 'fingerprint';
 type LanguageAnalyzer = 'arabic' | 'armenian' | 'basque' | 'bengali' | 'brazilian' | 'bulgarian' | 'catalan' | 'czech' | 'danish' | 'dutch' | 'english' | 'estonian' | 'finnish' | 'french' | 'galician' | 'german' | 'greek' | 'hindi' | 'hungarian' | 'indonesian' | 'irish' | 'italian' | 'latvian' | 'lithuanian' | 'norwegian' | 'persian' | 'portuguese' | 'romanian' | 'russian' | 'sorani' | 'spanish' | 'swedish' | 'turkish' | 'thai';
 type Analyzer = StandardAnalyzer | LanguageAnalyzer;
-type Match<T> = {
+type Match<T> = Partial<{
     [P in NestedStringPaths<T>]: string | {
         query: string;
         operator?: 'and' | 'or';
         minimum_should_match?: number;
         analyzer?: Analyzer;
     };
-};
+}>;
 type MultiMatchParam<T extends string> = T | `${T}^${number}` | `${SubstringOf<T>}*`;
 type MultiMatch<T> = {
     query: string;
@@ -202,6 +203,9 @@ type OpenSearchQueryBody<T extends {
         fields?: OpenSearchFields<K>;
         filter?: OpenSearchFilter<T>;
         match?: Match<T>;
+        match_all?: {
+            boost?: number;
+        };
         multi_match?: MultiMatch<T>;
         from?: number;
         size?: number;
@@ -237,11 +241,18 @@ type OpenSearchQuery<T extends {
     from?: number;
     size?: number;
 } : never;
-type BasicOpenSearchFieldTypes = 'text' | 'keyword' | 'long' | 'integer' | 'short' | 'byte' | 'double' | 'float' | 'date' | 'boolean' | 'binary';
+type BasicOpenSearchFieldTypes = 'text' | 'keyword' | 'long' | 'integer' | 'short' | 'byte' | 'double' | 'float' | 'date' | 'boolean' | 'binary' | 'nested';
 type ElementType<T> = T extends Array<infer U> ? U : T;
 type OpenSearchFieldType<T> = ElementType<T> extends string ? 'text' | 'keyword' : ElementType<T> extends number ? 'long' | 'integer' | 'short' | 'byte' | 'double' | 'float' : ElementType<T> extends boolean ? 'boolean' : ElementType<T> extends Date ? 'date' : BasicOpenSearchFieldTypes;
 type FieldOptions<T> = {
-    type: OpenSearchFieldType<T>;
+    type: OpenSearchFieldType<NotUndefined<T>>;
+};
+type NestedFieldOptions<T> = {
+    type: 'nested';
+    properties: IndexProperties<T>;
+};
+type IndexProperties<T> = {
+    [K in keyof Partial<T>]: T[K] extends Date ? FieldOptions<T[K]> : NotUndefined<T[K]> extends object ? NotUndefined<T[K]> extends Array<infer U> ? U extends object ? NestedFieldOptions<U> : FieldOptions<T[K]> : IndexProperties<T[K]> : FieldOptions<T[K]>;
 };
 type IndexOptions<T extends WithId> = {
     settings?: {
@@ -255,9 +266,6 @@ type IndexOptions<T extends WithId> = {
     };
     aliases?: Record<string, Record<string, never>>;
 };
-type IndexProperties<T> = {
-    [K in keyof Partial<T>]: T[K] extends Date ? FieldOptions<T[K]> : T[K] extends object ? T[K] extends Array<infer U> ? FieldOptions<T[K]> : IndexProperties<T[K]> : FieldOptions<T[K]>;
-};
 
 interface OpenSearchHelper extends Client {
     typedSearch: <DataType extends WithId, ReturnType = DataType>(query: OpenSearchQuery<DataType, ReturnType>) => Promise<{

package/dist/index.js

@@ -1,7 +1,9 @@
 "use strict";
+var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __export = (target, all) => {
   for (var name in all)
@@ -15,6 +17,14 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
@@ -24,10 +34,94 @@ __export(src_exports, {
 });
 module.exports = __toCommonJS(src_exports);
 
+// src/openSearchHelper.ts
+var import_assert = __toESM(require("assert"));
+
+// src/fixIds.ts
+var import_omit = __toESM(require("omit"));
+var omitId = (0, import_omit.default)("id");
+var fixIds = (searchQuery) => {
+  const q = searchQuery.body.query;
+  const body = {
+    query: {
+      bool: q.bool ? fixBool(q.bool) : void 0,
+      match: q.match ? fixId(q.match) : void 0,
+      collapse: q.collapse,
+      exists: q.exists ? fixExists(q.exists) : void 0,
+      fields: q.fields,
+      filter: q.filter ? fixFilter(q.filter) : void 0,
+      from: q.from,
+      fuzzy: q.fuzzy ? fixId(q.fuzzy) : void 0,
+      highlight: q.highlight,
+      match_all: q.match_all,
+      match_phrase: q.match_phrase ? fixId(q.match_phrase) : void 0,
+      match_phrase_prefix: q.match_phrase_prefix ? fixId(q.match_phrase_prefix) : void 0,
+      more_like_this: q.more_like_this ? fixWithFields(q.more_like_this) : void 0,
+      multi_match: q.multi_match ? fixId(q.multi_match) : void 0,
+      prefix: q.prefix ? fixId(q.prefix) : void 0,
+      range: q.range ? fixId(q.range) : void 0,
+      regexp: q.regexp ? fixId(q.regexp) : void 0,
+      script_score: q.script_score,
+      size: q.size,
+      term: q.term ? fixId(q.term) : void 0,
+      terms: q.terms ? fixId(q.terms) : void 0,
+      wildcard: q.wildcard ? fixId(q.wildcard) : void 0
+    }
+  };
+  return {
+    ...searchQuery,
+    body: {
+      ...clean(body)
+    }
+  };
+};
+var fixBool = (bool) => ({
+  ...bool,
+  filter: bool.filter ? Array.isArray(bool.filter) ? bool.filter.map(fixFilter) : fixFilter(bool.filter) : void 0,
+  boost: bool.boost,
+  minimum_should_match: bool.minimum_should_match,
+  must: bool.must ? Array.isArray(bool.must) ? bool.must.map(fixFilter) : fixFilter(bool.must) : void 0,
+  must_not: bool.must_not ? Array.isArray(bool.must_not) ? bool.must_not.map(fixFilter) : fixFilter(bool.must_not) : void 0,
+  should: bool.should ? Array.isArray(bool.should) ? bool.should.map(fixFilter) : fixFilter(bool.should) : void 0
+});
+var fixFilter = (filter) => clean({
+  bool: filter.bool ? fixBool(filter.bool) : void 0,
+  exists: filter.exists ? fixExists(filter.exists) : void 0,
+  fuzzy: filter.fuzzy ? fixId(filter.fuzzy) : void 0,
+  match: filter.match ? fixId(filter.match) : void 0,
+  match_phrase: filter.match_phrase ? fixId(filter.match_phrase) : void 0,
+  multi_match: filter.multi_match ? fixId(filter.multi_match) : void 0,
+  match_phrase_prefix: filter.match_phrase_prefix ? fixId(filter.match_phrase_prefix) : void 0,
+  prefix: filter.prefix ? fixId(filter.prefix) : void 0,
+  query_string: filter.query_string ? fixWithFields(filter.query_string) : void 0,
+  range: filter.range ? fixId(filter.range) : void 0,
+  regexp: filter.regexp ? fixId(filter.regexp) : void 0,
+  simple_query_string: filter.simple_query_string ? fixWithFields(filter.simple_query_string) : void 0,
+  term: filter.term ? fixId(filter.term) : void 0,
+  terms: filter.terms ? fixId(filter.terms) : void 0,
+  wildcard: filter.wildcard ? fixId(filter.wildcard) : void 0
+});
+var fixWithFields = (old) => ({
+  ...old,
+  fields: old.fields ? old.fields.map(fixIdValue) : void 0
+});
+var fixExists = (exists) => ({
+  ...exists,
+  field: fixIdValue(exists.field)
+});
+var fixId = (old) => {
+  const fixed = omitId(old);
+  if (old.id)
+    fixed._id = old.id;
+  return fixed;
+};
+var fixIdValue = (val) => val === "id" ? "_id" : val;
+var clean = (obj) => Object.entries(obj).filter(([, val]) => val !== void 0).reduce((m, [prop, val]) => ({ ...m, [prop]: val }), {});
+
 // src/openSearchHelper.ts
 var typedSearch = async (client, searchQuery) => {
   const response = await client.search(
-    searchQuery
+    fixIds(searchQuery)
   );
   const results = response.body.hits.hits.map(
     // biome-ignore lint/suspicious/noExplicitAny: <explanation>
@@ -73,10 +167,18 @@ var typedBulkUpsert = async (client, index, items) => {
   return response;
 };
 var isLeafNode = (obj) => {
+  if (Object.values(obj).some((value) => value === "nested"))
+    return true;
   return !Object.values(obj).some(
     (value) => typeof value === "object" && value !== null && !Array.isArray(value)
   );
 };
+(0, import_assert.default)(
+  isLeafNode({
+    type: "nested",
+    properties: { name: { type: "keyword" }, type: { type: "keyword" } }
+  })
+);
 var flattenObject = (obj, parentKey = "", result = {}) => {
   for (const [key, value] of Object.entries(obj)) {
     const newKey = parentKey ? `${parentKey}.${key}` : key;

package/dist/index.mjs

@@ -1,7 +1,91 @@
+// src/openSearchHelper.ts
+import assert from "assert";
+
+// src/fixIds.ts
+import omit from "omit";
+var omitId = omit("id");
+var fixIds = (searchQuery) => {
+  const q = searchQuery.body.query;
+  const body = {
+    query: {
+      bool: q.bool ? fixBool(q.bool) : void 0,
+      match: q.match ? fixId(q.match) : void 0,
+      collapse: q.collapse,
+      exists: q.exists ? fixExists(q.exists) : void 0,
+      fields: q.fields,
+      filter: q.filter ? fixFilter(q.filter) : void 0,
+      from: q.from,
+      fuzzy: q.fuzzy ? fixId(q.fuzzy) : void 0,
+      highlight: q.highlight,
+      match_all: q.match_all,
+      match_phrase: q.match_phrase ? fixId(q.match_phrase) : void 0,
+      match_phrase_prefix: q.match_phrase_prefix ? fixId(q.match_phrase_prefix) : void 0,
+      more_like_this: q.more_like_this ? fixWithFields(q.more_like_this) : void 0,
+      multi_match: q.multi_match ? fixId(q.multi_match) : void 0,
+      prefix: q.prefix ? fixId(q.prefix) : void 0,
+      range: q.range ? fixId(q.range) : void 0,
+      regexp: q.regexp ? fixId(q.regexp) : void 0,
+      script_score: q.script_score,
+      size: q.size,
+      term: q.term ? fixId(q.term) : void 0,
+      terms: q.terms ? fixId(q.terms) : void 0,
+      wildcard: q.wildcard ? fixId(q.wildcard) : void 0
+    }
+  };
+  return {
+    ...searchQuery,
+    body: {
+      ...clean(body)
+    }
+  };
+};
+var fixBool = (bool) => ({
+  ...bool,
+  filter: bool.filter ? Array.isArray(bool.filter) ? bool.filter.map(fixFilter) : fixFilter(bool.filter) : void 0,
+  boost: bool.boost,
+  minimum_should_match: bool.minimum_should_match,
+  must: bool.must ? Array.isArray(bool.must) ? bool.must.map(fixFilter) : fixFilter(bool.must) : void 0,
+  must_not: bool.must_not ? Array.isArray(bool.must_not) ? bool.must_not.map(fixFilter) : fixFilter(bool.must_not) : void 0,
+  should: bool.should ? Array.isArray(bool.should) ? bool.should.map(fixFilter) : fixFilter(bool.should) : void 0
+});
+var fixFilter = (filter) => clean({
+  bool: filter.bool ? fixBool(filter.bool) : void 0,
+  exists: filter.exists ? fixExists(filter.exists) : void 0,
+  fuzzy: filter.fuzzy ? fixId(filter.fuzzy) : void 0,
+  match: filter.match ? fixId(filter.match) : void 0,
+  match_phrase: filter.match_phrase ? fixId(filter.match_phrase) : void 0,
+  multi_match: filter.multi_match ? fixId(filter.multi_match) : void 0,
+  match_phrase_prefix: filter.match_phrase_prefix ? fixId(filter.match_phrase_prefix) : void 0,
+  prefix: filter.prefix ? fixId(filter.prefix) : void 0,
+  query_string: filter.query_string ? fixWithFields(filter.query_string) : void 0,
+  range: filter.range ? fixId(filter.range) : void 0,
+  regexp: filter.regexp ? fixId(filter.regexp) : void 0,
+  simple_query_string: filter.simple_query_string ? fixWithFields(filter.simple_query_string) : void 0,
+  term: filter.term ? fixId(filter.term) : void 0,
+  terms: filter.terms ? fixId(filter.terms) : void 0,
+  wildcard: filter.wildcard ? fixId(filter.wildcard) : void 0
+});
+var fixWithFields = (old) => ({
+  ...old,
+  fields: old.fields ? old.fields.map(fixIdValue) : void 0
+});
+var fixExists = (exists) => ({
+  ...exists,
+  field: fixIdValue(exists.field)
+});
+var fixId = (old) => {
+  const fixed = omitId(old);
+  if (old.id)
+    fixed._id = old.id;
+  return fixed;
+};
+var fixIdValue = (val) => val === "id" ? "_id" : val;
+var clean = (obj) => Object.entries(obj).filter(([, val]) => val !== void 0).reduce((m, [prop, val]) => ({ ...m, [prop]: val }), {});
+
 // src/openSearchHelper.ts
 var typedSearch = async (client, searchQuery) => {
   const response = await client.search(
-    searchQuery
+    fixIds(searchQuery)
   );
   const results = response.body.hits.hits.map(
     // biome-ignore lint/suspicious/noExplicitAny: <explanation>
@@ -47,10 +131,18 @@ var typedBulkUpsert = async (client, index, items) => {
   return response;
 };
 var isLeafNode = (obj) => {
+  if (Object.values(obj).some((value) => value === "nested"))
+    return true;
   return !Object.values(obj).some(
     (value) => typeof value === "object" && value !== null && !Array.isArray(value)
   );
 };
+assert(
+  isLeafNode({
+    type: "nested",
+    properties: { name: { type: "keyword" }, type: { type: "keyword" } }
+  })
+);
 var flattenObject = (obj, parentKey = "", result = {}) => {
   for (const [key, value] of Object.entries(obj)) {
     const newKey = parentKey ? `${parentKey}.${key}` : key;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sebspark/opensearch",
-  "version": "0.1.2",
+  "version": "0.2.1",
   "license": "Apache-2.0",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -16,9 +16,11 @@
     "typecheck": "vitest --typecheck.only --passWithNoTests"
   },
   "devDependencies": {
+    "@types/omit": "1.0.3",
     "tsconfig": "*"
   },
   "dependencies": {
-    "@opensearch-project/opensearch": "2.4.0"
+    "@opensearch-project/opensearch": "2.5.0",
+    "omit": "1.0.1"
   }
 }