@webiny/api-opensearch 0.0.0-unstable.7be00a75a9

package/indexConfiguration/base.js

@@ -0,0 +1,34 @@
+import { getCommonMappings } from "./common.js";
+const config = {
+    mappings: {
+        dynamic_templates: getCommonMappings((mappings)=>mappings.concat([
+                {
+                    strings: {
+                        match_mapping_type: "string",
+                        mapping: {
+                            type: "text",
+                            fields: {
+                                keyword: {
+                                    type: "keyword",
+                                    ignore_above: 256
+                                }
+                            }
+                        }
+                    }
+                }
+            ])),
+        properties: {
+            rawValues: {
+                type: "object",
+                enabled: false
+            }
+        }
+    }
+};
+const getBaseConfiguration = (modifier)=>{
+    if (!modifier) return config;
+    return modifier(config);
+};
+export { getBaseConfiguration };
+
+//# sourceMappingURL=base.js.map

package/indexConfiguration/base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexConfiguration/base.js","sources":["../../src/indexConfiguration/base.ts"],"sourcesContent":["import type { OpenSearchIndexRequestBody } from \"~/types.js\";\nimport { getCommonMappings } from \"./common.js\";\n\nconst config: OpenSearchIndexRequestBody = {\n    mappings: {\n        dynamic_templates: getCommonMappings(mappings => {\n            return mappings.concat([\n                {\n                    strings: {\n                        match_mapping_type: \"string\",\n                        mapping: {\n                            type: \"text\",\n                            fields: {\n                                keyword: {\n                                    type: \"keyword\",\n                                    ignore_above: 256\n                                }\n                            }\n                        }\n                    }\n                }\n            ]);\n        }),\n        properties: {\n            rawValues: {\n                type: \"object\",\n                enabled: false\n            }\n        }\n    }\n};\n\ninterface Modifier {\n    (config: OpenSearchIndexRequestBody): OpenSearchIndexRequestBody;\n}\nexport const getBaseConfiguration = (modifier?: Modifier) => {\n    if (!modifier) {\n        return config;\n    }\n    return modifier(config);\n};\n"],"names":["config","getCommonMappings","mappings","getBaseConfiguration","modifier"],"mappings":";AAGA,MAAMA,SAAqC;IACvC,UAAU;QACN,mBAAmBC,kBAAkBC,CAAAA,WAC1BA,SAAS,MAAM,CAAC;gBACnB;oBACI,SAAS;wBACL,oBAAoB;wBACpB,SAAS;4BACL,MAAM;4BACN,QAAQ;gCACJ,SAAS;oCACL,MAAM;oCACN,cAAc;gCAClB;4BACJ;wBACJ;oBACJ;gBACJ;aACH;QAEL,YAAY;YACR,WAAW;gBACP,MAAM;gBACN,SAAS;YACb;QACJ;IACJ;AACJ;AAKO,MAAMC,uBAAuB,CAACC;IACjC,IAAI,CAACA,UACD,OAAOJ;IAEX,OAAOI,SAASJ;AACpB"}

package/indexConfiguration/common.d.ts

@@ -0,0 +1,9 @@
+import type { OpenSearchIndexRequestBodyMappingsDynamicTemplate } from "../types.js";
+interface Modifier {
+    (mappings: OpenSearchIndexRequestBodyMappingsDynamicTemplate[]): OpenSearchIndexRequestBodyMappingsDynamicTemplate[];
+}
+/**
+ * @internal
+ */
+export declare const getCommonMappings: (cb?: Modifier) => OpenSearchIndexRequestBodyMappingsDynamicTemplate[];
+export {};

package/indexConfiguration/common.js

@@ -0,0 +1,42 @@
+const getDefaultMappings = ()=>[
+        {
+            ids: {
+                match: "^id|entryId$",
+                mapping: {
+                    type: "keyword"
+                }
+            }
+        },
+        {
+            dates: {
+                match: "^createdOn|savedOn|publishedOn$",
+                mapping: {
+                    type: "date"
+                }
+            }
+        },
+        {
+            numbers: {
+                match: "number@*",
+                mapping: {
+                    type: "scaled_float",
+                    scaling_factor: 10000
+                }
+            }
+        },
+        {
+            booleans: {
+                match: "boolean@*",
+                mapping: {
+                    type: "boolean"
+                }
+            }
+        }
+    ];
+const getCommonMappings = (cb)=>{
+    if (!cb) return getDefaultMappings();
+    return cb(getDefaultMappings());
+};
+export { getCommonMappings };
+
+//# sourceMappingURL=common.js.map

package/indexConfiguration/common.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexConfiguration/common.js","sources":["../../src/indexConfiguration/common.ts"],"sourcesContent":["import type { OpenSearchIndexRequestBodyMappingsDynamicTemplate } from \"~/types.js\";\n\nconst getDefaultMappings = (): OpenSearchIndexRequestBodyMappingsDynamicTemplate[] => {\n    return [\n        {\n            ids: {\n                match: \"^id|entryId$\",\n                mapping: {\n                    type: \"keyword\"\n                }\n            }\n        },\n        {\n            /* Update with the correct date fields. */\n            dates: {\n                match: \"^createdOn|savedOn|publishedOn$\",\n                mapping: {\n                    type: \"date\"\n                }\n            }\n        },\n        {\n            numbers: {\n                match: \"number@*\",\n                mapping: {\n                    type: \"scaled_float\",\n                    scaling_factor: 10000\n                }\n            }\n        },\n        {\n            booleans: {\n                match: \"boolean@*\",\n                mapping: {\n                    type: \"boolean\"\n                }\n            }\n        }\n    ];\n};\n\ninterface Modifier {\n    (\n        mappings: OpenSearchIndexRequestBodyMappingsDynamicTemplate[]\n    ): OpenSearchIndexRequestBodyMappingsDynamicTemplate[];\n}\n/**\n * @internal\n */\nexport const getCommonMappings = (\n    cb?: Modifier\n): OpenSearchIndexRequestBodyMappingsDynamicTemplate[] => {\n    if (!cb) {\n        return getDefaultMappings();\n    }\n\n    return cb(getDefaultMappings());\n};\n"],"names":["getDefaultMappings","getCommonMappings","cb"],"mappings":"AAEA,MAAMA,qBAAqB,IAChB;QACH;YACI,KAAK;gBACD,OAAO;gBACP,SAAS;oBACL,MAAM;gBACV;YACJ;QACJ;QACA;YAEI,OAAO;gBACH,OAAO;gBACP,SAAS;oBACL,MAAM;gBACV;YACJ;QACJ;QACA;YACI,SAAS;gBACL,OAAO;gBACP,SAAS;oBACL,MAAM;oBACN,gBAAgB;gBACpB;YACJ;QACJ;QACA;YACI,UAAU;gBACN,OAAO;gBACP,SAAS;oBACL,MAAM;gBACV;YACJ;QACJ;KACH;AAWE,MAAMC,oBAAoB,CAC7BC;IAEA,IAAI,CAACA,IACD,OAAOF;IAGX,OAAOE,GAAGF;AACd"}

package/indexConfiguration/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./base.js";
+export * from "./common.js";

package/indexConfiguration/index.js

@@ -0,0 +1,2 @@
+export * from "./base.js";
+export * from "./common.js";

package/indexPrefix.d.ts

@@ -0,0 +1 @@
+export declare const getOpenSearchIndexPrefix: () => string;

package/indexPrefix.js

@@ -0,0 +1,4 @@
+const getOpenSearchIndexPrefix = ()=>process.env.OPENSEARCH_INDEX_PREFIX || process.env.ELASTICSEARCH_INDEX_PREFIX || process.env.WEBINY_OPENSEARCH_INDEX_PREFIX || process.env.WEBINY_ELASTICSEARCH_INDEX_PREFIX || "";
+export { getOpenSearchIndexPrefix };
+
+//# sourceMappingURL=indexPrefix.js.map

package/indexPrefix.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexPrefix.js","sources":["../src/indexPrefix.ts"],"sourcesContent":["export const getOpenSearchIndexPrefix = (): string => {\n    return (\n        process.env.OPENSEARCH_INDEX_PREFIX ||\n        process.env.ELASTICSEARCH_INDEX_PREFIX ||\n        process.env.WEBINY_OPENSEARCH_INDEX_PREFIX ||\n        process.env.WEBINY_ELASTICSEARCH_INDEX_PREFIX ||\n        \"\"\n    );\n};\n"],"names":["getOpenSearchIndexPrefix","process"],"mappings":"AAAO,MAAMA,2BAA2B,IAEhCC,QAAQ,GAAG,CAAC,uBAAuB,IACnCA,QAAQ,GAAG,CAAC,0BAA0B,IACtCA,QAAQ,GAAG,CAAC,8BAA8B,IAC1CA,QAAQ,GAAG,CAAC,iCAAiC,IAC7C"}

package/indices.d.ts

@@ -0,0 +1,8 @@
+import type { OpenSearchIndexPlugin } from "./plugins/definition/OpenSearchIndexPlugin.js";
+import type { PluginsContainer } from "@webiny/plugins";
+interface IndicesPluginsParams {
+    container: PluginsContainer;
+    type: string;
+}
+export declare const getLastAddedIndexPlugin: <T extends OpenSearchIndexPlugin>(params: IndicesPluginsParams) => T;
+export {};

package/indices.js

@@ -0,0 +1,12 @@
+import error from "@webiny/error";
+const listIndicesPlugins = ({ container, type })=>container.byType(type).filter((plugin)=>plugin.canUse());
+const getLastAddedIndexPlugin = (params)=>{
+    const plugins = listIndicesPlugins(params);
+    if (0 === plugins.length) throw new error(`Could not find a single OpenSearchIndexPlugin of type "${params.type}".`, "OPENSEARCH_INDEX_TEMPLATE_ERROR", {
+        type: params.type
+    });
+    return plugins.pop();
+};
+export { getLastAddedIndexPlugin };
+
+//# sourceMappingURL=indices.js.map

package/indices.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"indices.js","sources":["../src/indices.ts"],"sourcesContent":["import type { OpenSearchIndexPlugin } from \"~/plugins/definition/OpenSearchIndexPlugin.js\";\nimport type { PluginsContainer } from \"@webiny/plugins\";\nimport WebinyError from \"@webiny/error\";\n\ninterface IndicesPluginsParams {\n    container: PluginsContainer;\n    type: string;\n}\nconst listIndicesPlugins = <T extends OpenSearchIndexPlugin>({\n    container,\n    type\n}: IndicesPluginsParams): T[] => {\n    return container.byType<T>(type).filter(plugin => {\n        return plugin.canUse();\n    });\n};\n\nexport const getLastAddedIndexPlugin = <T extends OpenSearchIndexPlugin>(\n    params: IndicesPluginsParams\n): T => {\n    const plugins = listIndicesPlugins<T>(params);\n    if (plugins.length === 0) {\n        throw new WebinyError(\n            `Could not find a single OpenSearchIndexPlugin of type \"${params.type}\".`,\n            \"OPENSEARCH_INDEX_TEMPLATE_ERROR\",\n            {\n                type: params.type\n            }\n        );\n    }\n\n    return plugins.pop() as T;\n};\n"],"names":["listIndicesPlugins","container","type","plugin","getLastAddedIndexPlugin","params","plugins","WebinyError"],"mappings":";AAQA,MAAMA,qBAAqB,CAAkC,EACzDC,SAAS,EACTC,IAAI,EACe,GACZD,UAAU,MAAM,CAAIC,MAAM,MAAM,CAACC,CAAAA,SAC7BA,OAAO,MAAM;AAIrB,MAAMC,0BAA0B,CACnCC;IAEA,MAAMC,UAAUN,mBAAsBK;IACtC,IAAIC,AAAmB,MAAnBA,QAAQ,MAAM,EACd,MAAM,IAAIC,MACN,CAAC,uDAAuD,EAAEF,OAAO,IAAI,CAAC,EAAE,CAAC,EACzE,mCACA;QACI,MAAMA,OAAO,IAAI;IACrB;IAIR,OAAOC,QAAQ,GAAG;AACtB"}

package/limit.d.ts

@@ -0,0 +1 @@
+export declare const createLimit: (limit?: number, defaultValue?: number) => number;

package/limit.js

@@ -0,0 +1,10 @@
+const ES_LIMIT_MAX = 10000;
+const ES_LIMIT_DEFAULT = 50;
+const createLimit = (limit, defaultValue = ES_LIMIT_DEFAULT)=>{
+    if (!limit || limit < 1) return defaultValue;
+    if (limit < ES_LIMIT_MAX) return limit;
+    return ES_LIMIT_MAX - 1;
+};
+export { createLimit };
+
+//# sourceMappingURL=limit.js.map

package/limit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"limit.js","sources":["../src/limit.ts"],"sourcesContent":["/**\n * This is the max limit of the OpenSearch.\n * Change here if it changes (and if it is necessary).\n */\nconst ES_LIMIT_MAX = 10000;\n/**\n * Our system default limit.\n */\nconst ES_LIMIT_DEFAULT = 50;\n\nexport const createLimit = (limit?: number, defaultValue = ES_LIMIT_DEFAULT): number => {\n    /**\n     * Limit can possibly be null/undefined or less than 1.\n     * In that case return the defaults.\n     */\n    if (!limit || limit < 1) {\n        return defaultValue;\n    }\n    /**\n     * Users input limit cannot be greater than the OpenSearch one.\n     * OpenSearch query breaks because of that.\n     */\n    if (limit < ES_LIMIT_MAX) {\n        return limit;\n    }\n    /**\n     * Always reduce by 1 because we check if there are more items by adding 1 to the limit\n     * and then remove that last one loaded.\n     */\n    return ES_LIMIT_MAX - 1;\n};\n"],"names":["ES_LIMIT_MAX","ES_LIMIT_DEFAULT","createLimit","limit","defaultValue"],"mappings":"AAIA,MAAMA,eAAe;AAIrB,MAAMC,mBAAmB;AAElB,MAAMC,cAAc,CAACC,OAAgBC,eAAeH,gBAAgB;IAKvE,IAAI,CAACE,SAASA,QAAQ,GAClB,OAAOC;IAMX,IAAID,QAAQH,cACR,OAAOG;IAMX,OAAOH,eAAe;AAC1B"}

package/normalize.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Before performing the query, we need to escape all special characters.
+ * @see https://opensearch.org/docs/latest/query-dsl/full-text/query-string/
+ */
+export declare const normalizeValue: (value: string) => string;
+export declare const normalizeValueWithAsterisk: (initial: string) => string;

package/normalize.js

@@ -0,0 +1,55 @@
+const specialCharactersToRemove = [
+    "\\?"
+];
+const specialCharacterToSpace = [
+    "-",
+    "\\\\"
+];
+const specialCharacters = [
+    "\\\\",
+    "\\+",
+    "\\=",
+    "&",
+    "\\|",
+    ">",
+    "<",
+    "!",
+    "\\(",
+    "\\)",
+    "\\{",
+    "\\}",
+    "\\[",
+    "\\]",
+    "\\^",
+    '\\"',
+    "\\~",
+    "\\*",
+    ":",
+    "/",
+    "\\#"
+];
+const normalizeValue = (value)=>{
+    let result = value || "";
+    if (!result) return result;
+    for (const character of specialCharactersToRemove)result = result.replace(new RegExp(character, "g"), "");
+    for (const character of specialCharacterToSpace)result = result.replace(new RegExp(character, "g"), " ");
+    for (const character of specialCharacters)result = result.replace(new RegExp(character, "g"), `\\${character}`);
+    return result || "";
+};
+const hasSpecialChar = (value)=>{
+    if (!value) return null;
+    return null === value.match(/^([0-9a-zA-Z]+)$/i);
+};
+const normalizeValueWithAsterisk = (initial)=>{
+    const value = normalizeValue(initial);
+    const results = value.split(" ");
+    let result = value;
+    const firstWord = results[0];
+    if (false === hasSpecialChar(firstWord)) result = `*${result}`;
+    const lastWord = results[results.length - 1];
+    if (false === hasSpecialChar(lastWord)) result = `${result}*`;
+    return result;
+};
+export { normalizeValue, normalizeValueWithAsterisk };
+
+//# sourceMappingURL=normalize.js.map

package/normalize.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"normalize.js","sources":["../src/normalize.ts"],"sourcesContent":["/**\n * Before performing the query, we need to escape all special characters.\n * @see https://opensearch.org/docs/latest/query-dsl/full-text/query-string/\n */\n\nconst specialCharactersToRemove = [`\\\\?`];\n\nconst specialCharacterToSpace = [\"-\", \"\\\\\\\\\"];\n\nconst specialCharacters = [\n    \"\\\\\\\\\",\n    \"\\\\+\",\n    // \"\\\\-\",\n    \"\\\\=\",\n    `&`,\n    `\\\\|`,\n    \">\",\n    \"<\",\n    `!`,\n    \"\\\\(\",\n    \"\\\\)\",\n    \"\\\\{\",\n    \"\\\\}\",\n    \"\\\\[\",\n    \"\\\\]\",\n    \"\\\\^\",\n    '\\\\\"',\n    \"\\\\~\",\n    \"\\\\*\",\n    `:`,\n    `/`,\n    \"\\\\#\"\n];\n\nexport const normalizeValue = (value: string) => {\n    let result = value || \"\";\n    if (!result) {\n        return result;\n    }\n    for (const character of specialCharactersToRemove) {\n        result = result.replace(new RegExp(character, \"g\"), \"\");\n    }\n    for (const character of specialCharacterToSpace) {\n        result = result.replace(new RegExp(character, \"g\"), \" \");\n    }\n\n    for (const character of specialCharacters) {\n        result = result.replace(new RegExp(character, \"g\"), `\\\\${character}`);\n    }\n\n    return result || \"\";\n};\n\nconst hasSpecialChar = (value: string): boolean | null => {\n    if (!value) {\n        return null;\n    }\n    return value.match(/^([0-9a-zA-Z]+)$/i) === null;\n};\n\nexport const normalizeValueWithAsterisk = (initial: string) => {\n    const value = normalizeValue(initial);\n    const results = value.split(\" \");\n\n    let result = value;\n    /**\n     * If there is a / in the first word, do not put asterisk in front of it.\n     */\n    const firstWord = results[0];\n    if (hasSpecialChar(firstWord) === false) {\n        result = `*${result}`;\n    }\n    /**\n     * If there is a / in the last word, do not put asterisk at the end of it.\n     */\n    const lastWord = results[results.length - 1];\n    if (hasSpecialChar(lastWord) === false) {\n        result = `${result}*`;\n    }\n\n    return result;\n};\n"],"names":["specialCharactersToRemove","specialCharacterToSpace","specialCharacters","normalizeValue","value","result","character","RegExp","hasSpecialChar","normalizeValueWithAsterisk","initial","results","firstWord","lastWord"],"mappings":"AAKA,MAAMA,4BAA4B;IAAC;CAAM;AAEzC,MAAMC,0BAA0B;IAAC;IAAK;CAAO;AAE7C,MAAMC,oBAAoB;IACtB;IACA;IAEA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;CACH;AAEM,MAAMC,iBAAiB,CAACC;IAC3B,IAAIC,SAASD,SAAS;IACtB,IAAI,CAACC,QACD,OAAOA;IAEX,KAAK,MAAMC,aAAaN,0BACpBK,SAASA,OAAO,OAAO,CAAC,IAAIE,OAAOD,WAAW,MAAM;IAExD,KAAK,MAAMA,aAAaL,wBACpBI,SAASA,OAAO,OAAO,CAAC,IAAIE,OAAOD,WAAW,MAAM;IAGxD,KAAK,MAAMA,aAAaJ,kBACpBG,SAASA,OAAO,OAAO,CAAC,IAAIE,OAAOD,WAAW,MAAM,CAAC,EAAE,EAAEA,WAAW;IAGxE,OAAOD,UAAU;AACrB;AAEA,MAAMG,iBAAiB,CAACJ;IACpB,IAAI,CAACA,OACD,OAAO;IAEX,OAAOA,AAAqC,SAArCA,MAAM,KAAK,CAAC;AACvB;AAEO,MAAMK,6BAA6B,CAACC;IACvC,MAAMN,QAAQD,eAAeO;IAC7B,MAAMC,UAAUP,MAAM,KAAK,CAAC;IAE5B,IAAIC,SAASD;IAIb,MAAMQ,YAAYD,OAAO,CAAC,EAAE;IAC5B,IAAIH,AAA8B,UAA9BA,eAAeI,YACfP,SAAS,CAAC,CAAC,EAAEA,QAAQ;IAKzB,MAAMQ,WAAWF,OAAO,CAACA,QAAQ,MAAM,GAAG,EAAE;IAC5C,IAAIH,AAA6B,UAA7BA,eAAeK,WACfR,SAAS,GAAGA,OAAO,CAAC,CAAC;IAGzB,OAAOA;AACX"}

package/operations/OpenSearchCatHealth.d.ts

@@ -0,0 +1,7 @@
+import type { Client } from "../client.js";
+import type { IOpenSearchCatHealthResponse } from "./types.js";
+export declare class OpenSearchCatHealth {
+    private readonly client;
+    constructor(client: Client);
+    getHealth(): Promise<IOpenSearchCatHealthResponse>;
+}

package/operations/OpenSearchCatHealth.js

@@ -0,0 +1,30 @@
+import { WebinyError } from "@webiny/error";
+import { stripConnectionFromException } from "./stripConnectionFromException.js";
+class OpenSearchCatHealth {
+    constructor(client){
+        this.client = client;
+    }
+    async getHealth() {
+        try {
+            const response = await this.client.cat.health({
+                format: "json"
+            });
+            if (!Array.isArray(response.body) || 0 === response.body.length) throw new WebinyError({
+                message: "There is no valid response from cat.health operation.",
+                code: "OPENSEARCH_HEALTH_INVALID_RESPONSE",
+                data: response.body
+            });
+            return {
+                ...response.body[0]
+            };
+        } catch (ex) {
+            console.error(`Could not fetch cluster health information: ${ex.message}`);
+            const error = stripConnectionFromException(ex);
+            console.log(JSON.stringify(error));
+            throw error;
+        }
+    }
+}
+export { OpenSearchCatHealth };
+
+//# sourceMappingURL=OpenSearchCatHealth.js.map

package/operations/OpenSearchCatHealth.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"operations/OpenSearchCatHealth.js","sources":["../../src/operations/OpenSearchCatHealth.ts"],"sourcesContent":["import { WebinyError } from \"@webiny/error\";\nimport type { Client } from \"~/client.js\";\nimport type { IOpenSearchCatHealthResponse } from \"./types.js\";\nimport { stripConnectionFromException } from \"~/operations/stripConnectionFromException.js\";\n\nexport class OpenSearchCatHealth {\n    private readonly client: Client;\n\n    public constructor(client: Client) {\n        this.client = client;\n    }\n\n    public async getHealth(): Promise<IOpenSearchCatHealthResponse> {\n        try {\n            const response = await this.client.cat.health({\n                format: \"json\"\n            });\n\n            if (!Array.isArray(response.body) || response.body.length === 0) {\n                throw new WebinyError({\n                    message: `There is no valid response from cat.health operation.`,\n                    code: \"OPENSEARCH_HEALTH_INVALID_RESPONSE\",\n                    data: response.body\n                });\n            }\n\n            return {\n                ...response.body[0]\n            };\n        } catch (ex) {\n            console.error(`Could not fetch cluster health information: ${ex.message}`);\n            const error = stripConnectionFromException(ex);\n            console.log(JSON.stringify(error));\n            throw error;\n        }\n    }\n}\n"],"names":["OpenSearchCatHealth","client","response","Array","WebinyError","ex","console","error","stripConnectionFromException","JSON"],"mappings":";;AAKO,MAAMA;IAGT,YAAmBC,MAAc,CAAE;QAC/B,IAAI,CAAC,MAAM,GAAGA;IAClB;IAEA,MAAa,YAAmD;QAC5D,IAAI;YACA,MAAMC,WAAW,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC;gBAC1C,QAAQ;YACZ;YAEA,IAAI,CAACC,MAAM,OAAO,CAACD,SAAS,IAAI,KAAKA,AAAyB,MAAzBA,SAAS,IAAI,CAAC,MAAM,EACrD,MAAM,IAAIE,YAAY;gBAClB,SAAS;gBACT,MAAM;gBACN,MAAMF,SAAS,IAAI;YACvB;YAGJ,OAAO;gBACH,GAAGA,SAAS,IAAI,CAAC,EAAE;YACvB;QACJ,EAAE,OAAOG,IAAI;YACTC,QAAQ,KAAK,CAAC,CAAC,4CAA4C,EAAED,GAAG,OAAO,EAAE;YACzE,MAAME,QAAQC,6BAA6BH;YAC3CC,QAAQ,GAAG,CAACG,KAAK,SAAS,CAACF;YAC3B,MAAMA;QACV;IACJ;AACJ"}

package/operations/OpenSearchCatNodes.d.ts

@@ -0,0 +1,7 @@
+import type { IOpenSearchCatNodesResponse } from "./types.js";
+import type { Client } from "../client.js";
+export declare class OpenSearchCatNodes {
+    private readonly client;
+    constructor(client: Client);
+    getNodes(): Promise<IOpenSearchCatNodesResponse>;
+}

package/operations/OpenSearchCatNodes.js

@@ -0,0 +1,28 @@
+import { WebinyError } from "@webiny/error";
+import { stripConnectionFromException } from "./stripConnectionFromException.js";
+class OpenSearchCatNodes {
+    constructor(client){
+        this.client = client;
+    }
+    async getNodes() {
+        try {
+            const response = await this.client.cat.nodes({
+                format: "json"
+            });
+            if (!Array.isArray(response.body) || 0 === response.body.length) throw new WebinyError({
+                message: "There is no valid response from cat.nodes operation.",
+                code: "OPENSEARCH_NODES_INVALID_RESPONSE",
+                data: response.body
+            });
+            return response.body;
+        } catch (ex) {
+            console.error(`Could not fetch cluster nodes information: ${ex.message}`);
+            const error = stripConnectionFromException(ex);
+            console.log(JSON.stringify(error));
+            throw error;
+        }
+    }
+}
+export { OpenSearchCatNodes };
+
+//# sourceMappingURL=OpenSearchCatNodes.js.map

package/operations/OpenSearchCatNodes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"operations/OpenSearchCatNodes.js","sources":["../../src/operations/OpenSearchCatNodes.ts"],"sourcesContent":["import type { IOpenSearchCatNodesResponse } from \"./types.js\";\nimport type { Client } from \"~/client.js\";\nimport { WebinyError } from \"@webiny/error\";\nimport { stripConnectionFromException } from \"~/operations/stripConnectionFromException.js\";\n\nexport class OpenSearchCatNodes {\n    private readonly client: Client;\n\n    public constructor(client: Client) {\n        this.client = client;\n    }\n\n    public async getNodes(): Promise<IOpenSearchCatNodesResponse> {\n        try {\n            const response = await this.client.cat.nodes({\n                format: \"json\"\n            });\n            if (!Array.isArray(response.body) || response.body.length === 0) {\n                throw new WebinyError({\n                    message: `There is no valid response from cat.nodes operation.`,\n                    code: \"OPENSEARCH_NODES_INVALID_RESPONSE\",\n                    data: response.body\n                });\n            }\n            return response.body;\n        } catch (ex) {\n            console.error(`Could not fetch cluster nodes information: ${ex.message}`);\n            const error = stripConnectionFromException(ex);\n            console.log(JSON.stringify(error));\n            throw error;\n        }\n    }\n}\n"],"names":["OpenSearchCatNodes","client","response","Array","WebinyError","ex","console","error","stripConnectionFromException","JSON"],"mappings":";;AAKO,MAAMA;IAGT,YAAmBC,MAAc,CAAE;QAC/B,IAAI,CAAC,MAAM,GAAGA;IAClB;IAEA,MAAa,WAAiD;QAC1D,IAAI;YACA,MAAMC,WAAW,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC;gBACzC,QAAQ;YACZ;YACA,IAAI,CAACC,MAAM,OAAO,CAACD,SAAS,IAAI,KAAKA,AAAyB,MAAzBA,SAAS,IAAI,CAAC,MAAM,EACrD,MAAM,IAAIE,YAAY;gBAClB,SAAS;gBACT,MAAM;gBACN,MAAMF,SAAS,IAAI;YACvB;YAEJ,OAAOA,SAAS,IAAI;QACxB,EAAE,OAAOG,IAAI;YACTC,QAAQ,KAAK,CAAC,CAAC,2CAA2C,EAAED,GAAG,OAAO,EAAE;YACxE,MAAME,QAAQC,6BAA6BH;YAC3CC,QAAQ,GAAG,CAACG,KAAK,SAAS,CAACF;YAC3B,MAAMA;QACV;IACJ;AACJ"}

package/operations/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./OpenSearchCatHealth.js";
+export * from "./OpenSearchCatNodes.js";
+export * from "./types.js";

package/operations/index.js

@@ -0,0 +1,3 @@
+export * from "./OpenSearchCatHealth.js";
+export * from "./OpenSearchCatNodes.js";
+export * from "./types.js";

package/operations/stripConnectionFromException.d.ts

@@ -0,0 +1 @@
+export declare const stripConnectionFromException: (ex: any) => any;

package/operations/stripConnectionFromException.js

@@ -0,0 +1,14 @@
+const stripConnectionFromException = (ex)=>{
+    if ("object" != typeof ex) return ex;
+    if (!ex?.meta?.meta?.connection) return ex;
+    return {
+        ...ex.meta,
+        meta: {
+            ...ex.meta.meta,
+            connection: null
+        }
+    };
+};
+export { stripConnectionFromException };
+
+//# sourceMappingURL=stripConnectionFromException.js.map

package/operations/stripConnectionFromException.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"operations/stripConnectionFromException.js","sources":["../../src/operations/stripConnectionFromException.ts"],"sourcesContent":["export const stripConnectionFromException = (ex: any): any => {\n    if (typeof ex !== \"object\") {\n        return ex;\n    }\n    if (!ex?.meta?.meta?.connection) {\n        return ex;\n    }\n    return {\n        ...ex.meta,\n        meta: {\n            ...ex.meta.meta,\n            connection: null\n        }\n    };\n};\n"],"names":["stripConnectionFromException","ex"],"mappings":"AAAO,MAAMA,+BAA+B,CAACC;IACzC,IAAI,AAAc,YAAd,OAAOA,IACP,OAAOA;IAEX,IAAI,CAACA,IAAI,MAAM,MAAM,YACjB,OAAOA;IAEX,OAAO;QACH,GAAGA,GAAG,IAAI;QACV,MAAM;YACF,GAAGA,GAAG,IAAI,CAAC,IAAI;YACf,YAAY;QAChB;IACJ;AACJ"}

package/operations/types.d.ts

@@ -0,0 +1,12 @@
+import type { Cat_Health_ResponseBody, Cat_Nodes_ResponseBody } from "@opensearch-project/opensearch/api/index.js";
+export declare enum OpenSearchCatClusterHealthStatus {
+    Green = "green",
+    Yellow = "yellow",
+    Red = "red"
+}
+type HealthRecord = Cat_Health_ResponseBody[number];
+type NodesRecord = Cat_Nodes_ResponseBody[number];
+export type IOpenSearchCatHealthResponse = HealthRecord;
+export type IOpenSearchCatNodeResponse = NodesRecord;
+export type IOpenSearchCatNodesResponse = IOpenSearchCatNodeResponse[];
+export {};

package/operations/types.js

@@ -0,0 +1,9 @@
+var types_OpenSearchCatClusterHealthStatus = /*#__PURE__*/ function(OpenSearchCatClusterHealthStatus) {
+    OpenSearchCatClusterHealthStatus["Green"] = "green";
+    OpenSearchCatClusterHealthStatus["Yellow"] = "yellow";
+    OpenSearchCatClusterHealthStatus["Red"] = "red";
+    return OpenSearchCatClusterHealthStatus;
+}({});
+export { types_OpenSearchCatClusterHealthStatus as OpenSearchCatClusterHealthStatus };
+
+//# sourceMappingURL=types.js.map

package/operations/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"operations/types.js","sources":["../../src/operations/types.ts"],"sourcesContent":["import type {\n    Cat_Health_ResponseBody,\n    Cat_Nodes_ResponseBody\n} from \"@opensearch-project/opensearch/api/index.js\";\n\nexport enum OpenSearchCatClusterHealthStatus {\n    Green = \"green\",\n    Yellow = \"yellow\",\n    Red = \"red\"\n}\n\ntype HealthRecord = Cat_Health_ResponseBody[number];\n\ntype NodesRecord = Cat_Nodes_ResponseBody[number];\n\nexport type IOpenSearchCatHealthResponse = HealthRecord;\n\nexport type IOpenSearchCatNodeResponse = NodesRecord;\n\nexport type IOpenSearchCatNodesResponse = IOpenSearchCatNodeResponse[];\n"],"names":["OpenSearchCatClusterHealthStatus"],"mappings":"AAKO,IAAKA,yCAAgCA,WAAAA,GAAAA,SAAhCA,gCAAgC;;;;WAAhCA"}

package/operators.d.ts

@@ -0,0 +1,6 @@
+import { OpenSearchQueryBuilderOperatorBetweenPlugin, OpenSearchQueryBuilderOperatorAndInPlugin, OpenSearchQueryBuilderOperatorGreaterThanOrEqualToPlugin, OpenSearchQueryBuilderOperatorGreaterThanPlugin, OpenSearchQueryBuilderOperatorContainsPlugin, OpenSearchQueryBuilderOperatorLesserThanOrEqualToPlugin, OpenSearchQueryBuilderOperatorInPlugin, OpenSearchQueryBuilderOperatorLesserThanPlugin, OpenSearchQueryBuilderOperatorNotBetweenPlugin, OpenSearchQueryBuilderOperatorNotContainsPlugin, OpenSearchQueryBuilderOperatorNotPlugin, OpenSearchQueryBuilderOperatorNotInPlugin, OpenSearchQueryBuilderOperatorEqualPlugin, OpenSearchQueryBuilderOperatorStartsWithPlugin, OpenSearchQueryBuilderOperatorNotStartsWithPlugin } from "./plugins/operator/index.js";
+/**
+ * We export as a function because there might be something to be sent to the operators at some point.
+ * This way, we make it easier to upgrade.
+ */
+export declare const getOpenSearchOperators: () => (OpenSearchQueryBuilderOperatorBetweenPlugin | OpenSearchQueryBuilderOperatorContainsPlugin | OpenSearchQueryBuilderOperatorEqualPlugin | OpenSearchQueryBuilderOperatorGreaterThanPlugin | OpenSearchQueryBuilderOperatorGreaterThanOrEqualToPlugin | OpenSearchQueryBuilderOperatorAndInPlugin | OpenSearchQueryBuilderOperatorInPlugin | OpenSearchQueryBuilderOperatorLesserThanPlugin | OpenSearchQueryBuilderOperatorLesserThanOrEqualToPlugin | OpenSearchQueryBuilderOperatorNotPlugin | OpenSearchQueryBuilderOperatorNotBetweenPlugin | OpenSearchQueryBuilderOperatorNotContainsPlugin | OpenSearchQueryBuilderOperatorNotInPlugin | OpenSearchQueryBuilderOperatorStartsWithPlugin | OpenSearchQueryBuilderOperatorNotStartsWithPlugin)[];

package/operators.js

@@ -0,0 +1,22 @@
+import { OpenSearchQueryBuilderOperatorAndInPlugin, OpenSearchQueryBuilderOperatorBetweenPlugin, OpenSearchQueryBuilderOperatorContainsPlugin, OpenSearchQueryBuilderOperatorEqualPlugin, OpenSearchQueryBuilderOperatorGreaterThanOrEqualToPlugin, OpenSearchQueryBuilderOperatorGreaterThanPlugin, OpenSearchQueryBuilderOperatorInPlugin, OpenSearchQueryBuilderOperatorLesserThanOrEqualToPlugin, OpenSearchQueryBuilderOperatorLesserThanPlugin, OpenSearchQueryBuilderOperatorNotBetweenPlugin, OpenSearchQueryBuilderOperatorNotContainsPlugin, OpenSearchQueryBuilderOperatorNotInPlugin, OpenSearchQueryBuilderOperatorNotPlugin, OpenSearchQueryBuilderOperatorNotStartsWithPlugin, OpenSearchQueryBuilderOperatorStartsWithPlugin } from "./plugins/operator/index.js";
+const operators = [
+    new OpenSearchQueryBuilderOperatorBetweenPlugin(),
+    new OpenSearchQueryBuilderOperatorNotBetweenPlugin(),
+    new OpenSearchQueryBuilderOperatorContainsPlugin(),
+    new OpenSearchQueryBuilderOperatorNotContainsPlugin(),
+    new OpenSearchQueryBuilderOperatorEqualPlugin(),
+    new OpenSearchQueryBuilderOperatorNotPlugin(),
+    new OpenSearchQueryBuilderOperatorGreaterThanPlugin(),
+    new OpenSearchQueryBuilderOperatorGreaterThanOrEqualToPlugin(),
+    new OpenSearchQueryBuilderOperatorLesserThanPlugin(),
+    new OpenSearchQueryBuilderOperatorLesserThanOrEqualToPlugin(),
+    new OpenSearchQueryBuilderOperatorInPlugin(),
+    new OpenSearchQueryBuilderOperatorAndInPlugin(),
+    new OpenSearchQueryBuilderOperatorNotInPlugin(),
+    new OpenSearchQueryBuilderOperatorStartsWithPlugin(),
+    new OpenSearchQueryBuilderOperatorNotStartsWithPlugin()
+];
+const getOpenSearchOperators = ()=>operators;
+export { getOpenSearchOperators };
+
+//# sourceMappingURL=operators.js.map

package/operators.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"operators.js","sources":["../src/operators.ts"],"sourcesContent":["import {\n    OpenSearchQueryBuilderOperatorBetweenPlugin,\n    OpenSearchQueryBuilderOperatorAndInPlugin,\n    OpenSearchQueryBuilderOperatorGreaterThanOrEqualToPlugin,\n    OpenSearchQueryBuilderOperatorGreaterThanPlugin,\n    OpenSearchQueryBuilderOperatorContainsPlugin,\n    OpenSearchQueryBuilderOperatorLesserThanOrEqualToPlugin,\n    OpenSearchQueryBuilderOperatorInPlugin,\n    OpenSearchQueryBuilderOperatorLesserThanPlugin,\n    OpenSearchQueryBuilderOperatorNotBetweenPlugin,\n    OpenSearchQueryBuilderOperatorNotContainsPlugin,\n    OpenSearchQueryBuilderOperatorNotPlugin,\n    OpenSearchQueryBuilderOperatorNotInPlugin,\n    OpenSearchQueryBuilderOperatorEqualPlugin,\n    OpenSearchQueryBuilderOperatorStartsWithPlugin,\n    OpenSearchQueryBuilderOperatorNotStartsWithPlugin\n} from \"~/plugins/operator/index.js\";\n\nconst operators = [\n    new OpenSearchQueryBuilderOperatorBetweenPlugin(),\n    new OpenSearchQueryBuilderOperatorNotBetweenPlugin(),\n    new OpenSearchQueryBuilderOperatorContainsPlugin(),\n    new OpenSearchQueryBuilderOperatorNotContainsPlugin(),\n    new OpenSearchQueryBuilderOperatorEqualPlugin(),\n    new OpenSearchQueryBuilderOperatorNotPlugin(),\n    new OpenSearchQueryBuilderOperatorGreaterThanPlugin(),\n    new OpenSearchQueryBuilderOperatorGreaterThanOrEqualToPlugin(),\n    new OpenSearchQueryBuilderOperatorLesserThanPlugin(),\n    new OpenSearchQueryBuilderOperatorLesserThanOrEqualToPlugin(),\n    new OpenSearchQueryBuilderOperatorInPlugin(),\n    new OpenSearchQueryBuilderOperatorAndInPlugin(),\n    new OpenSearchQueryBuilderOperatorNotInPlugin(),\n    new OpenSearchQueryBuilderOperatorStartsWithPlugin(),\n    new OpenSearchQueryBuilderOperatorNotStartsWithPlugin()\n];\n/**\n * We export as a function because there might be something to be sent to the operators at some point.\n * This way, we make it easier to upgrade.\n */\nexport const getOpenSearchOperators = () => operators;\n"],"names":["operators","OpenSearchQueryBuilderOperatorBetweenPlugin","OpenSearchQueryBuilderOperatorNotBetweenPlugin","OpenSearchQueryBuilderOperatorContainsPlugin","OpenSearchQueryBuilderOperatorNotContainsPlugin","OpenSearchQueryBuilderOperatorEqualPlugin","OpenSearchQueryBuilderOperatorNotPlugin","OpenSearchQueryBuilderOperatorGreaterThanPlugin","OpenSearchQueryBuilderOperatorGreaterThanOrEqualToPlugin","OpenSearchQueryBuilderOperatorLesserThanPlugin","OpenSearchQueryBuilderOperatorLesserThanOrEqualToPlugin","OpenSearchQueryBuilderOperatorInPlugin","OpenSearchQueryBuilderOperatorAndInPlugin","OpenSearchQueryBuilderOperatorNotInPlugin","OpenSearchQueryBuilderOperatorStartsWithPlugin","OpenSearchQueryBuilderOperatorNotStartsWithPlugin","getOpenSearchOperators"],"mappings":";AAkBA,MAAMA,YAAY;IACd,IAAIC;IACJ,IAAIC;IACJ,IAAIC;IACJ,IAAIC;IACJ,IAAIC;IACJ,IAAIC;IACJ,IAAIC;IACJ,IAAIC;IACJ,IAAIC;IACJ,IAAIC;IACJ,IAAIC;IACJ,IAAIC;IACJ,IAAIC;IACJ,IAAIC;IACJ,IAAIC;CACP;AAKM,MAAMC,yBAAyB,IAAMhB"}

package/package.json

@@ -0,0 +1,41 @@
+{
+	"name": "@webiny/api-opensearch",
+	"version": "0.0.0-unstable.7be00a75a9",
+	"type": "module",
+	"exports": {
+		".": "./index.js",
+		"./*": "./*"
+	},
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/webiny/webiny-js.git",
+		"directory": "packages/api-opensearch"
+	},
+	"description": "A set of plugins to work with OpenSearch.",
+	"contributors": [
+		"Pavel Denisjuk <pavel@webiny.com>"
+	],
+	"license": "MIT",
+	"dependencies": {
+		"@opensearch-project/opensearch": "3.6.0",
+		"@webiny/api": "0.0.0-unstable.7be00a75a9",
+		"@webiny/aws-sdk": "0.0.0-unstable.7be00a75a9",
+		"@webiny/db-dynamodb": "0.0.0-unstable.7be00a75a9",
+		"@webiny/error": "0.0.0-unstable.7be00a75a9",
+		"@webiny/feature": "0.0.0-unstable.7be00a75a9",
+		"@webiny/plugins": "0.0.0-unstable.7be00a75a9"
+	},
+	"devDependencies": {
+		"@webiny/build-tools": "0.0.0-unstable.7be00a75a9",
+		"@webiny/project-utils": "0.0.0-unstable.7be00a75a9",
+		"rimraf": "6.1.3",
+		"typescript": "6.0.3",
+		"vitest": "4.1.7"
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"webiny": {
+		"publishFrom": "dist"
+	}
+}

package/plugins/definition/OpenSearchBodyModifierPlugin.d.ts

@@ -0,0 +1,13 @@
+import { Plugin } from "@webiny/plugins";
+import type { SearchBody } from "../../types.js";
+export interface ModifyBodyParams {
+    body: SearchBody;
+}
+export interface ModifyBodyCallable<T extends ModifyBodyParams> {
+    (params: T): void;
+}
+export declare abstract class OpenSearchBodyModifierPlugin<T extends ModifyBodyParams = ModifyBodyParams> extends Plugin {
+    private readonly callable?;
+    constructor(callable?: ModifyBodyCallable<T>);
+    modifyBody(params: T): void;
+}

package/plugins/definition/OpenSearchBodyModifierPlugin.js

@@ -0,0 +1,17 @@
+import error from "@webiny/error";
+import { Plugin } from "@webiny/plugins";
+class OpenSearchBodyModifierPlugin extends Plugin {
+    constructor(callable){
+        super();
+        this.callable = callable;
+    }
+    modifyBody(params) {
+        if ("function" != typeof this.callable) throw new error("Missing modification for the body.", "BODY_MODIFICATION_MISSING", {
+            params
+        });
+        this.callable(params);
+    }
+}
+export { OpenSearchBodyModifierPlugin };
+
+//# sourceMappingURL=OpenSearchBodyModifierPlugin.js.map

package/plugins/definition/OpenSearchBodyModifierPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugins/definition/OpenSearchBodyModifierPlugin.js","sources":["../../../src/plugins/definition/OpenSearchBodyModifierPlugin.ts"],"sourcesContent":["import WebinyError from \"@webiny/error\";\nimport { Plugin } from \"@webiny/plugins\";\nimport type { SearchBody } from \"~/types.js\";\n\nexport interface ModifyBodyParams {\n    body: SearchBody;\n}\n\nexport interface ModifyBodyCallable<T extends ModifyBodyParams> {\n    (params: T): void;\n}\n\nexport abstract class OpenSearchBodyModifierPlugin<\n    T extends ModifyBodyParams = ModifyBodyParams\n> extends Plugin {\n    private readonly callable?: ModifyBodyCallable<T>;\n\n    public constructor(callable?: ModifyBodyCallable<T>) {\n        super();\n        this.callable = callable;\n    }\n\n    public modifyBody(params: T): void {\n        if (typeof this.callable !== \"function\") {\n            throw new WebinyError(\n                `Missing modification for the body.`,\n                \"BODY_MODIFICATION_MISSING\",\n                {\n                    params\n                }\n            );\n        }\n        this.callable(params);\n    }\n}\n"],"names":["OpenSearchBodyModifierPlugin","Plugin","callable","params","WebinyError"],"mappings":";;AAYO,MAAeA,qCAEZC;IAGN,YAAmBC,QAAgC,CAAE;QACjD,KAAK;QACL,IAAI,CAAC,QAAQ,GAAGA;IACpB;IAEO,WAAWC,MAAS,EAAQ;QAC/B,IAAI,AAAyB,cAAzB,OAAO,IAAI,CAAC,QAAQ,EACpB,MAAM,IAAIC,MACN,sCACA,6BACA;YACID;QACJ;QAGR,IAAI,CAAC,QAAQ,CAACA;IAClB;AACJ"}

package/plugins/definition/OpenSearchFieldPlugin.d.ts

@@ -0,0 +1,81 @@
+import { Plugin } from "@webiny/plugins";
+import type { FieldSortOptions, SortOrder } from "../../types.js";
+export type UnmappedTypes = "date" | "long" | string;
+export interface ToSearchValueParams {
+    /**
+     * The value to transform.
+     */
+    value: any;
+    /**
+     * When using toSearchValue() in our code we send a field.getPath() value here.
+     */
+    path: string;
+    /**
+     * When using toSearchValue() in our code we send a field.getBasePath() value here.
+     */
+    basePath: string;
+}
+export interface OpenSearchFieldPluginParams {
+    /**
+     * Which field is this plugin for.
+     */
+    field: string;
+    /**
+     * Some specific path of a field?
+     * Example: createdBy is createdBy.id
+     */
+    path?: string;
+    /**
+     * Add a .keyword at the end of the field path?
+     */
+    keyword?: boolean;
+    /**
+     * Is the field of a specific type, but possibly not mapped?
+     * Happens when inserting a date in string format.
+     * You need to cast it as date when running the search/sort to work correctly.
+     */
+    unmappedType?: UnmappedTypes;
+    /**
+     * Is the field sortable?
+     */
+    sortable?: boolean;
+    /**
+     * Is the field searchable?
+     */
+    searchable?: boolean;
+    /**
+     * Used to transform the input value for the search.
+     */
+    toSearchValue?: (params: ToSearchValueParams) => any;
+}
+export declare class OpenSearchFieldPlugin extends Plugin {
+    static readonly type: string;
+    static readonly ALL: string;
+    readonly field: string;
+    readonly path: string;
+    readonly keyword: boolean;
+    readonly unmappedType?: string;
+    readonly sortable: boolean;
+    readonly searchable: boolean;
+    constructor(params: OpenSearchFieldPluginParams);
+    /**
+     * The default sort options. Extend in your own plugin if you want to add more options.
+     */
+    getSortOptions(order: SortOrder): FieldSortOptions;
+    /**
+     * The default path generator. Extend in your own plugin if you want to add more options.
+     * Field parameter is here because there is a possibility that this is the ALL field plugin, so we need to know which field are we working on.
+     */
+    getPath(field: string): string;
+    /**
+     * @see getPath
+     *
+     * This is the default base path generator. Basically it replaces ALL with given field name.
+     */
+    getBasePath(field: string): string;
+    /**
+     * The default transformer. Just returns the value by default.
+     * Override to implement what ever is required.
+     */
+    toSearchValue(params: ToSearchValueParams): any;
+}