@webiny/api-opensearch 6.4.12-beta.5 → 6.5.0-beta.0

package/index.d.ts

@@ -1,15 +1,9 @@
-import type { OpenSearchContext } from "./types.js";
-import { ContextPlugin } from "@webiny/api";
-import type { OpenSearchClientOptions } from "./client.js";
-import { Client } from "./client.js";
-export * from "./indexConfiguration/index.js";
-export * from "./plugins/index.js";
+export { registerOpenSearchCore } from "./registerOpenSearchCore.js";
+export { getCommonMappings, getBaseConfiguration } from "./indexConfiguration/index.js";
 export * from "./sort.js";
-export * from "./indices.js";
 export * from "./where.js";
 export * from "./limit.js";
 export * from "./normalize.js";
-export * from "./operators.js";
 export * from "./cursors.js";
 export { createOpenSearchClient, type Client, type ClientOptions, type OpenSearchClientOptions } from "./client.js";
 export * from "./utils/index.js";
@@ -18,4 +12,3 @@ export * from "./sharedIndex.js";
 export * from "./indexPrefix.js";
 export * from "./db/index.js";
 export * from "./types.js";
-export declare const createOpenSearchContext: (params: OpenSearchClientOptions | Client) => ContextPlugin<OpenSearchContext>;

package/index.js

@@ -1,17 +1,7 @@
-import { ContextPlugin } from "@webiny/api";
-import { Client, createOpenSearchClient } from "./client.js";
-import { getOpenSearchOperators } from "./operators.js";
-import { OpenSearchClientFactoryFeature } from "./features/OpenSearchClientFactory/feature.js";
-import { OpenSearchClientFeature } from "./features/OpenSearchClient/feature.js";
-import { OpenSearchContextFeature } from "./features/OpenSearchContext/feature.js";
-export * from "./indexConfiguration/index.js";
-export * from "./plugins/index.js";
 export * from "./sort.js";
-export * from "./indices.js";
 export * from "./where.js";
 export * from "./limit.js";
 export * from "./normalize.js";
-export * from "./operators.js";
 export * from "./cursors.js";
 export * from "./utils/index.js";
 export * from "./operations/index.js";
@@ -19,20 +9,6 @@ export * from "./sharedIndex.js";
 export * from "./indexPrefix.js";
 export * from "./db/index.js";
 export * from "./types.js";
-const createOpenSearchContext = (params)=>{
-    const plugin = new ContextPlugin((context)=>{
-        if (context.opensearch) throw new Error("OpenSearch context must not be loaded more than once!");
-        const client = params instanceof Client ? params : createOpenSearchClient(params);
-        context.opensearch = client;
-        context.elasticsearch = client;
-        context.plugins.register(getOpenSearchOperators());
-        OpenSearchContextFeature.register(context.container, context);
-        OpenSearchClientFeature.register(context.container);
-        OpenSearchClientFactoryFeature.register(context.container);
-    });
-    plugin.name = "context.opensearch";
-    return plugin;
-};
-export { createOpenSearchClient, createOpenSearchContext };
-
-//# sourceMappingURL=index.js.map
+export { registerOpenSearchCore } from "./registerOpenSearchCore.js";
+export { getBaseConfiguration, getCommonMappings } from "./indexConfiguration/index.js";
+export { createOpenSearchClient } from "./client.js";

package/indices.d.ts

@@ -1,8 +1,2 @@
-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 {};
+import { OpenSearchIndexRegistry } from "./features/OpenSearchIndex/abstractions/OpenSearchIndexRegistry.js";
+export { OpenSearchIndexRegistry };

package/indices.js

@@ -1,12 +1 @@
-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
+export { OpenSearchIndexRegistry } from "./features/OpenSearchIndex/abstractions/OpenSearchIndexRegistry.js";

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@webiny/api-opensearch",
-	"version": "6.4.12-beta.5",
+	"version": "6.5.0-beta.0",
 	"type": "module",
 	"exports": {
 		".": "./index.js",
@@ -18,19 +18,20 @@
 	"license": "MIT",
 	"dependencies": {
 		"@opensearch-project/opensearch": "3.6.0",
-		"@webiny/api": "6.4.12-beta.5",
-		"@webiny/aws-sdk": "6.4.12-beta.5",
-		"@webiny/db-dynamodb": "6.4.12-beta.5",
-		"@webiny/error": "6.4.12-beta.5",
-		"@webiny/feature": "6.4.12-beta.5",
-		"@webiny/plugins": "6.4.12-beta.5"
+		"@webiny/api": "6.5.0-beta.0",
+		"@webiny/aws-sdk": "6.5.0-beta.0",
+		"@webiny/db-dynamodb": "6.5.0-beta.0",
+		"@webiny/error": "6.5.0-beta.0",
+		"@webiny/feature": "6.5.0-beta.0",
+		"@webiny/handler": "6.5.0-beta.0"
 	},
 	"devDependencies": {
-		"@webiny/build-tools": "6.4.12-beta.5",
-		"@webiny/project-utils": "6.4.12-beta.5",
+		"@webiny/build-tools": "6.5.0-beta.0",
+		"@webiny/di": "1.0.2",
+		"@webiny/project-utils": "6.5.0-beta.0",
 		"rimraf": "6.1.3",
-		"typescript": "6.0.3",
-		"vitest": "5.0.1"
+		"typescript": "7.0.2",
+		"vitest": "4.1.10"
 	},
 	"publishConfig": {
 		"access": "public"

package/registerOpenSearchCore.d.ts

@@ -0,0 +1,3 @@
+import type { OpenSearchClientOptions } from "./client.js";
+import { Client } from "./client.js";
+export declare const registerOpenSearchCore: (params: OpenSearchClientOptions | Client) => import("@webiny/handler").RegisterExtensionPlugin<import("@webiny/handler/types").Context>;

package/registerOpenSearchCore.js

@@ -0,0 +1,20 @@
+import { createRegisterExtensionPlugin } from "@webiny/handler";
+import { OpenSearchClientFeature } from "./features/OpenSearchClient/feature.js";
+import { OpenSearchClientFactoryFeature } from "./features/OpenSearchClientFactory/feature.js";
+import { OpenSearchQueryBuilderOperatorFeature } from "./features/OpenSearchQueryBuilderOperator/feature.js";
+import { OpenSearchFieldFeature } from "./features/OpenSearchField/feature.js";
+import { OpenSearchIndexFeature } from "./features/OpenSearchIndex/feature.js";
+import { Client, createOpenSearchClient } from "./client.js";
+const registerOpenSearchCore = (params)=>createRegisterExtensionPlugin(async (context)=>{
+        if (context.__registeredOpensearch) throw new Error("OpenSearch core must not be loaded more than once!");
+        const client = params instanceof Client ? params : createOpenSearchClient(params);
+        context.__registeredOpensearch = true;
+        OpenSearchClientFeature.register(context.container, client);
+        OpenSearchClientFactoryFeature.register(context.container);
+        OpenSearchQueryBuilderOperatorFeature.register(context.container);
+        OpenSearchFieldFeature.register(context.container);
+        OpenSearchIndexFeature.register(context.container);
+    });
+export { registerOpenSearchCore };
+
+//# sourceMappingURL=registerOpenSearchCore.js.map

package/registerOpenSearchCore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"registerOpenSearchCore.js","sources":["../src/registerOpenSearchCore.ts"],"sourcesContent":["import { createRegisterExtensionPlugin } from \"@webiny/handler\";\nimport { OpenSearchClientFeature } from \"~/features/OpenSearchClient/feature.js\";\nimport { OpenSearchClientFactoryFeature } from \"~/features/OpenSearchClientFactory/feature.js\";\nimport { OpenSearchQueryBuilderOperatorFeature } from \"~/features/OpenSearchQueryBuilderOperator/feature.js\";\nimport { OpenSearchFieldFeature } from \"~/features/OpenSearchField/feature.js\";\nimport { OpenSearchIndexFeature } from \"~/features/OpenSearchIndex/feature.js\";\nimport type { OpenSearchClientOptions } from \"~/client.js\";\nimport { Client, createOpenSearchClient } from \"~/client.js\";\n\nexport const registerOpenSearchCore = (params: OpenSearchClientOptions | Client) => {\n    return createRegisterExtensionPlugin(async context => {\n        // @ts-expect-error\n        if (context.__registeredOpensearch) {\n            throw new Error(\"OpenSearch core must not be loaded more than once!\");\n        }\n        const client = params instanceof Client ? params : createOpenSearchClient(params);\n        // @ts-expect-error\n        context.__registeredOpensearch = true;\n\n        OpenSearchClientFeature.register(context.container, client);\n        OpenSearchClientFactoryFeature.register(context.container);\n        OpenSearchQueryBuilderOperatorFeature.register(context.container);\n        OpenSearchFieldFeature.register(context.container);\n        OpenSearchIndexFeature.register(context.container);\n    });\n};\n"],"names":["registerOpenSearchCore","params","createRegisterExtensionPlugin","context","Error","client","Client","createOpenSearchClient","OpenSearchClientFeature","OpenSearchClientFactoryFeature","OpenSearchQueryBuilderOperatorFeature","OpenSearchFieldFeature","OpenSearchIndexFeature"],"mappings":";;;;;;;AASO,MAAMA,yBAAyB,CAACC,SAC5BC,8BAA8B,OAAMC;QAEvC,IAAIA,QAAQ,sBAAsB,EAC9B,MAAM,IAAIC,MAAM;QAEpB,MAAMC,SAASJ,kBAAkBK,SAASL,SAASM,uBAAuBN;QAE1EE,QAAQ,sBAAsB,GAAG;QAEjCK,wBAAwB,QAAQ,CAACL,QAAQ,SAAS,EAAEE;QACpDI,+BAA+B,QAAQ,CAACN,QAAQ,SAAS;QACzDO,sCAAsC,QAAQ,CAACP,QAAQ,SAAS;QAChEQ,uBAAuB,QAAQ,CAACR,QAAQ,SAAS;QACjDS,uBAAuB,QAAQ,CAACT,QAAQ,SAAS;IACrD"}

package/sort.d.ts

@@ -1,5 +1,5 @@
 import type { SortOrder, SortType } from "./types.js";
-import { OpenSearchFieldPlugin } from "./plugins/index.js";
+import { OpenSearchField } from "./features/OpenSearchField/abstractions/OpenSearchField.js";
 interface CreateSortParams {
     sort: string[];
     defaults?: {
@@ -7,7 +7,7 @@ interface CreateSortParams {
         order?: SortOrder;
         unmappedType?: string;
     };
-    fieldPlugins: Record<string, OpenSearchFieldPlugin>;
+    fieldPlugins: Record<string, OpenSearchField.Interface>;
 }
 export declare const createSort: (params: CreateSortParams) => SortType;
 export {};

package/sort.js

@@ -1,5 +1,5 @@
 import error from "@webiny/error";
-import { OpenSearchFieldPlugin } from "./plugins/index.js";
+import { OpenSearchFieldAll } from "./features/OpenSearchField/abstractions/OpenSearchField.js";
 const sortRegExp = /^((?:values\.)?[a-zA-Z0-9_@-]+)_(ASC|DESC)$/;
 const createSort = (params)=>{
     const { sort, defaults, fieldPlugins } = params;
@@ -18,7 +18,7 @@ const createSort = (params)=>{
         if (!match) throw new error(`Cannot sort by "${value}".`);
         const [, field, initialOrder] = match;
         const order = "asc" === initialOrder.toLowerCase() ? "asc" : "desc";
-        const plugin = fieldPlugins[field] || fieldPlugins[OpenSearchFieldPlugin.ALL];
+        const plugin = fieldPlugins[field] || fieldPlugins[OpenSearchFieldAll];
         if (!plugin) throw new error(`Missing plugin for the field "${field}"`, "PLUGIN_SORT_ERROR", {
             field
         });

package/sort.js.map

@@ -1 +1 @@
-{"version":3,"file":"sort.js","sources":["../src/sort.ts"],"sourcesContent":["import WebinyError from \"@webiny/error\";\nimport type { FieldSortOptions, SortOrder, SortType } from \"~/types.js\";\nimport { OpenSearchFieldPlugin } from \"~/plugins/index.js\";\n\nconst sortRegExp = /^((?:values\\.)?[a-zA-Z0-9_@-]+)_(ASC|DESC)$/;\n\ninterface CreateSortParams {\n    sort: string[];\n    defaults?: {\n        field?: string;\n        order?: SortOrder;\n        unmappedType?: string;\n    };\n    fieldPlugins: Record<string, OpenSearchFieldPlugin>;\n}\n\nexport const createSort = (params: CreateSortParams): SortType => {\n    const { sort, defaults, fieldPlugins } = params;\n    if (!sort || sort.length === 0) {\n        const { field, order, unmappedType } = defaults || {};\n        /**\n         * We say that our system defaults is always id since all records we create have some kind of primary ID.\n         */\n        return {\n            [field || \"id.keyword\"]: {\n                order: order || \"desc\",\n                // TODO: Cast to the proper MappingFieldType once deep opensearch _types/ imports are resolvable under bundler resolution.\n                unmapped_type: (unmappedType || undefined) as any\n            }\n        };\n    }\n    /**\n     * Cast as string because nothing else should be allowed yet.\n     */\n    const result = sort.reduce(\n        (acc, value) => {\n            if (typeof value !== \"string\") {\n                throw new WebinyError(`Sort as object is not supported..`);\n            }\n            const match = value.match(sortRegExp);\n\n            if (!match) {\n                throw new WebinyError(`Cannot sort by \"${value}\".`);\n            }\n\n            const [, field, initialOrder] = match;\n            const order: SortOrder = initialOrder.toLowerCase() === \"asc\" ? \"asc\" : \"desc\";\n\n            const plugin: OpenSearchFieldPlugin =\n                fieldPlugins[field] || fieldPlugins[OpenSearchFieldPlugin.ALL];\n            if (!plugin) {\n                throw new WebinyError(\n                    `Missing plugin for the field \"${field}\"`,\n                    \"PLUGIN_SORT_ERROR\",\n                    {\n                        field\n                    }\n                );\n            }\n            /**\n             * In case field plugin is the global one, change the * with actual field name.\n             * Custom path methods will return their own values anyway so replacing * will not matter.\n             */\n            const path = plugin.getPath(field);\n\n            acc[path] = plugin.getSortOptions(order);\n\n            return acc;\n        },\n        {} as Record<string, FieldSortOptions>\n    );\n    /**\n     * If we do not have id in the sort, we add it as we need a tie_breaker for the OpenSearch to be able to sort consistently.\n     */\n    if (!result[\"id.keyword\"] && !result[\"id\"]) {\n        result[\"id.keyword\"] = {\n            order: \"asc\"\n        };\n    }\n    return result;\n};\n"],"names":["sortRegExp","createSort","params","sort","defaults","fieldPlugins","field","order","unmappedType","undefined","result","acc","value","WebinyError","match","initialOrder","plugin","OpenSearchFieldPlugin","path"],"mappings":";;AAIA,MAAMA,aAAa;AAYZ,MAAMC,aAAa,CAACC;IACvB,MAAM,EAAEC,IAAI,EAAEC,QAAQ,EAAEC,YAAY,EAAE,GAAGH;IACzC,IAAI,CAACC,QAAQA,AAAgB,MAAhBA,KAAK,MAAM,EAAQ;QAC5B,MAAM,EAAEG,KAAK,EAAEC,KAAK,EAAEC,YAAY,EAAE,GAAGJ,YAAY,CAAC;QAIpD,OAAO;YACH,CAACE,SAAS,aAAa,EAAE;gBACrB,OAAOC,SAAS;gBAEhB,eAAgBC,gBAAgBC;YACpC;QACJ;IACJ;IAIA,MAAMC,SAASP,KAAK,MAAM,CACtB,CAACQ,KAAKC;QACF,IAAI,AAAiB,YAAjB,OAAOA,OACP,MAAM,IAAIC,MAAY;QAE1B,MAAMC,QAAQF,MAAM,KAAK,CAACZ;QAE1B,IAAI,CAACc,OACD,MAAM,IAAID,MAAY,CAAC,gBAAgB,EAAED,MAAM,EAAE,CAAC;QAGtD,MAAM,GAAGN,OAAOS,aAAa,GAAGD;QAChC,MAAMP,QAAmBQ,AAA+B,UAA/BA,aAAa,WAAW,KAAe,QAAQ;QAExE,MAAMC,SACFX,YAAY,CAACC,MAAM,IAAID,YAAY,CAACY,sBAAsB,GAAG,CAAC;QAClE,IAAI,CAACD,QACD,MAAM,IAAIH,MACN,CAAC,8BAA8B,EAAEP,MAAM,CAAC,CAAC,EACzC,qBACA;YACIA;QACJ;QAOR,MAAMY,OAAOF,OAAO,OAAO,CAACV;QAE5BK,GAAG,CAACO,KAAK,GAAGF,OAAO,cAAc,CAACT;QAElC,OAAOI;IACX,GACA,CAAC;IAKL,IAAI,CAACD,MAAM,CAAC,aAAa,IAAI,CAACA,MAAM,CAAC,KAAK,EACtCA,MAAM,CAAC,aAAa,GAAG;QACnB,OAAO;IACX;IAEJ,OAAOA;AACX"}
+{"version":3,"file":"sort.js","sources":["../src/sort.ts"],"sourcesContent":["import WebinyError from \"@webiny/error\";\nimport type { FieldSortOptions, SortOrder, SortType } from \"~/types.js\";\nimport {\n    OpenSearchField,\n    OpenSearchFieldAll\n} from \"~/features/OpenSearchField/abstractions/OpenSearchField.js\";\n\nconst sortRegExp = /^((?:values\\.)?[a-zA-Z0-9_@-]+)_(ASC|DESC)$/;\n\ninterface CreateSortParams {\n    sort: string[];\n    defaults?: {\n        field?: string;\n        order?: SortOrder;\n        unmappedType?: string;\n    };\n    fieldPlugins: Record<string, OpenSearchField.Interface>;\n}\n\nexport const createSort = (params: CreateSortParams): SortType => {\n    const { sort, defaults, fieldPlugins } = params;\n    if (!sort || sort.length === 0) {\n        const { field, order, unmappedType } = defaults || {};\n        return {\n            [field || \"id.keyword\"]: {\n                order: order || \"desc\",\n                unmapped_type: (unmappedType || undefined) as any\n            }\n        };\n    }\n    const result = sort.reduce(\n        (acc, value) => {\n            if (typeof value !== \"string\") {\n                throw new WebinyError(`Sort as object is not supported..`);\n            }\n            const match = value.match(sortRegExp);\n\n            if (!match) {\n                throw new WebinyError(`Cannot sort by \"${value}\".`);\n            }\n\n            const [, field, initialOrder] = match;\n            const order: SortOrder = initialOrder.toLowerCase() === \"asc\" ? \"asc\" : \"desc\";\n\n            const plugin: OpenSearchField.Interface =\n                fieldPlugins[field] || fieldPlugins[OpenSearchFieldAll];\n            if (!plugin) {\n                throw new WebinyError(\n                    `Missing plugin for the field \"${field}\"`,\n                    \"PLUGIN_SORT_ERROR\",\n                    {\n                        field\n                    }\n                );\n            }\n            const path = plugin.getPath(field);\n\n            acc[path] = plugin.getSortOptions(order);\n\n            return acc;\n        },\n        {} as Record<string, FieldSortOptions>\n    );\n    if (!result[\"id.keyword\"] && !result[\"id\"]) {\n        result[\"id.keyword\"] = {\n            order: \"asc\"\n        };\n    }\n    return result;\n};\n"],"names":["sortRegExp","createSort","params","sort","defaults","fieldPlugins","field","order","unmappedType","undefined","result","acc","value","WebinyError","match","initialOrder","plugin","OpenSearchFieldAll","path"],"mappings":";;AAOA,MAAMA,aAAa;AAYZ,MAAMC,aAAa,CAACC;IACvB,MAAM,EAAEC,IAAI,EAAEC,QAAQ,EAAEC,YAAY,EAAE,GAAGH;IACzC,IAAI,CAACC,QAAQA,AAAgB,MAAhBA,KAAK,MAAM,EAAQ;QAC5B,MAAM,EAAEG,KAAK,EAAEC,KAAK,EAAEC,YAAY,EAAE,GAAGJ,YAAY,CAAC;QACpD,OAAO;YACH,CAACE,SAAS,aAAa,EAAE;gBACrB,OAAOC,SAAS;gBAChB,eAAgBC,gBAAgBC;YACpC;QACJ;IACJ;IACA,MAAMC,SAASP,KAAK,MAAM,CACtB,CAACQ,KAAKC;QACF,IAAI,AAAiB,YAAjB,OAAOA,OACP,MAAM,IAAIC,MAAY;QAE1B,MAAMC,QAAQF,MAAM,KAAK,CAACZ;QAE1B,IAAI,CAACc,OACD,MAAM,IAAID,MAAY,CAAC,gBAAgB,EAAED,MAAM,EAAE,CAAC;QAGtD,MAAM,GAAGN,OAAOS,aAAa,GAAGD;QAChC,MAAMP,QAAmBQ,AAA+B,UAA/BA,aAAa,WAAW,KAAe,QAAQ;QAExE,MAAMC,SACFX,YAAY,CAACC,MAAM,IAAID,YAAY,CAACY,mBAAmB;QAC3D,IAAI,CAACD,QACD,MAAM,IAAIH,MACN,CAAC,8BAA8B,EAAEP,MAAM,CAAC,CAAC,EACzC,qBACA;YACIA;QACJ;QAGR,MAAMY,OAAOF,OAAO,OAAO,CAACV;QAE5BK,GAAG,CAACO,KAAK,GAAGF,OAAO,cAAc,CAACT;QAElC,OAAOI;IACX,GACA,CAAC;IAEL,IAAI,CAACD,MAAM,CAAC,aAAa,IAAI,CAACA,MAAM,CAAC,KAAK,EACtCA,MAAM,CAAC,aAAa,GAAG;QACnB,OAAO;IACX;IAEJ,OAAOA;AACX"}

package/testing/createBlankQuery.d.ts

@@ -0,0 +1,2 @@
+import type { OpenSearchBoolQueryConfig } from "../types.js";
+export declare const createBlankQuery: () => OpenSearchBoolQueryConfig;

package/testing/createBlankQuery.js

@@ -0,0 +1,9 @@
+const createBlankQuery = ()=>({
+        must_not: [],
+        must: [],
+        filter: [],
+        should: []
+    });
+export { createBlankQuery };
+
+//# sourceMappingURL=createBlankQuery.js.map

package/testing/createBlankQuery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testing/createBlankQuery.js","sources":["../../src/testing/createBlankQuery.ts"],"sourcesContent":["import type { OpenSearchBoolQueryConfig } from \"~/types.js\";\n\nexport const createBlankQuery = (): OpenSearchBoolQueryConfig => ({\n    must_not: [],\n    must: [],\n    filter: [],\n    should: []\n});\n"],"names":["createBlankQuery"],"mappings":"AAEO,MAAMA,mBAAmB,IAAkC;QAC9D,UAAU,EAAE;QACZ,MAAM,EAAE;QACR,QAAQ,EAAE;QACV,QAAQ,EAAE;IACd"}

package/testing/createTestOpenSearchClient.d.ts

@@ -0,0 +1,11 @@
+import { Client } from "@opensearch-project/opensearch";
+import type { ClientOptions } from "@opensearch-project/opensearch";
+export interface TestOpenSearchClient extends Client {
+    indices: Client["indices"] & {
+        deleteAll: () => Promise<void>;
+        refreshAll: (indexes?: string[] | null) => Promise<void>;
+        registerIndex: (names: string[] | string) => void;
+    };
+}
+export declare const createTestOpenSearchClient: (options?: Partial<ClientOptions>) => TestOpenSearchClient;
+export declare const getTestOpenSearchClient: () => TestOpenSearchClient;

package/testing/createTestOpenSearchClient.js

@@ -0,0 +1,162 @@
+import { Client } from "@opensearch-project/opensearch";
+const OPENSEARCH_PORT = process.env.OPENSEARCH_PORT || 9200;
+const getDefaultOptions = ()=>{
+    const endpoint = process.env.OPENSEARCH_ENDPOINT;
+    const username = process.env.OPENSEARCH_USERNAME;
+    const password = process.env.OPENSEARCH_PASSWORD;
+    const options = {
+        node: `http://localhost:${OPENSEARCH_PORT}`,
+        maxRetries: 10,
+        pingTimeout: 500
+    };
+    if (username && password) options.auth = {
+        username,
+        password
+    };
+    if (endpoint) options.node = null === endpoint.match(/^http/) ? `https://${endpoint}` : endpoint;
+    return options;
+};
+const SNAPSHOT_ERROR = "snapshot_in_progress_exception";
+const isSnapshotError = (ex)=>{
+    if (ex.meta?.body?.error?.type === SNAPSHOT_ERROR) return true;
+    const rootCauses = ex.meta?.body?.error?.root_cause;
+    if (!Array.isArray(rootCauses)) return false;
+    return rootCauses.some((rc)=>rc.type === SNAPSHOT_ERROR);
+};
+const wait = (ms)=>new Promise((resolve)=>setTimeout(resolve, ms));
+const createDeleteIndex = (client)=>{
+    const maxRetries = 10;
+    return async (index)=>{
+        for(let attempt = 0; attempt <= maxRetries; attempt++){
+            try {
+                const { body: exists } = await client.indices.exists({
+                    index,
+                    ignore_unavailable: true
+                });
+                if (!exists) return;
+            } catch (ex) {
+                console.log(`Could not determine that index exists: ${index}`);
+                console.log(ex.message);
+                return;
+            }
+            try {
+                await client.indices.delete({
+                    index,
+                    ignore_unavailable: true
+                });
+                return;
+            } catch (ex) {
+                console.log(`Could not delete index: ${index}`);
+                if (!isSnapshotError(ex)) return;
+                console.log("Snapshot in progress, retrying...");
+            }
+            await wait(1000);
+        }
+    };
+};
+const attachTestBehavior = (client)=>{
+    const registeredIndexes = new Set();
+    const dirtyIndexes = new Set();
+    const originalCreate = client.indices.create;
+    const originalExists = client.indices.exists;
+    const deleteIndex = createDeleteIndex(client);
+    const registerIndex = (input)=>{
+        if (!input) return;
+        const names = Array.isArray(input) ? input : [
+            input
+        ];
+        for (const name of names)registeredIndexes.add(name);
+    };
+    const refreshIndex = async (index)=>{
+        try {
+            await client.indices.refresh({
+                index,
+                ignore_unavailable: true
+            });
+        } catch (ex) {
+            console.log(`Could not refresh index "${index}": ${ex.message}`);
+            throw ex;
+        }
+    };
+    const refreshAll = async (indexes = null)=>{
+        const targets = indexes?.length ? indexes : Array.from(registeredIndexes.values());
+        for (const index of targets){
+            await refreshIndex(index);
+            dirtyIndexes.delete(index);
+        }
+    };
+    client.indices.exists = async (params, options = {})=>{
+        registerIndex(params.index);
+        return originalExists.apply(client.indices, [
+            params,
+            options
+        ]);
+    };
+    client.indices.create = async (params, options = {})=>{
+        await deleteIndex(params.index);
+        const response = await originalCreate.apply(client.indices, [
+            params,
+            options
+        ]);
+        registeredIndexes.add(params.index);
+        await client.indices.refresh({
+            index: params.index
+        });
+        return response;
+    };
+    const testClient = client;
+    testClient.indices.deleteAll = async ()=>{
+        const indexes = Array.from(registeredIndexes.values());
+        for (const index of indexes)try {
+            await deleteIndex(index);
+        } catch  {
+            console.log(`Could not delete index "${index}".`);
+        }
+    };
+    testClient.indices.refreshAll = refreshAll;
+    testClient.indices.registerIndex = registerIndex;
+    const originalSearch = client.search;
+    client.search = async (...params)=>{
+        const [param] = params;
+        const index = param?.index;
+        if (index && dirtyIndexes.has(index)) {
+            await refreshIndex(index);
+            dirtyIndexes.delete(index);
+        }
+        return await originalSearch.apply(client, params);
+    };
+    const originalBulk = client.bulk;
+    client.bulk = async (...params)=>{
+        const [param] = params;
+        const { body } = param;
+        const deletedIndexes = new Set();
+        if (Array.isArray(body)) {
+            for (const item of body)if (item.index?._index) {
+                dirtyIndexes.add(item.index._index);
+                registerIndex(item.index._index);
+            } else if (item.delete?._index) {
+                deletedIndexes.add(item.delete._index);
+                registerIndex(item.delete._index);
+            }
+        }
+        const result = await originalBulk.apply(client, params);
+        if (deletedIndexes.size > 0) await refreshAll(Array.from(deletedIndexes));
+        return result;
+    };
+    return testClient;
+};
+const createTestOpenSearchClient = (options = {})=>{
+    const client = new Client({
+        ...getDefaultOptions(),
+        ...options
+    });
+    return attachTestBehavior(client);
+};
+let singletonClient = null;
+const getTestOpenSearchClient = ()=>{
+    if (!singletonClient) singletonClient = createTestOpenSearchClient();
+    return singletonClient;
+};
+export { createTestOpenSearchClient, getTestOpenSearchClient };
+
+//# sourceMappingURL=createTestOpenSearchClient.js.map

package/testing/createTestOpenSearchClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testing/createTestOpenSearchClient.js","sources":["../../src/testing/createTestOpenSearchClient.ts"],"sourcesContent":["import { Client } from \"@opensearch-project/opensearch\";\nimport type { ClientOptions } from \"@opensearch-project/opensearch\";\n\nconst OPENSEARCH_PORT = process.env.OPENSEARCH_PORT || 9200;\n\nconst getDefaultOptions = (): Partial<ClientOptions> => {\n    const endpoint = process.env.OPENSEARCH_ENDPOINT;\n    const username = process.env.OPENSEARCH_USERNAME;\n    const password = process.env.OPENSEARCH_PASSWORD;\n\n    const options: Partial<ClientOptions> = {\n        node: `http://localhost:${OPENSEARCH_PORT}`,\n        maxRetries: 10,\n        pingTimeout: 500\n    };\n\n    if (username && password) {\n        options.auth = { username, password };\n    }\n\n    if (endpoint) {\n        options.node = endpoint.match(/^http/) === null ? `https://${endpoint}` : endpoint;\n    }\n\n    return options;\n};\n\nconst SNAPSHOT_ERROR = \"snapshot_in_progress_exception\";\n\nconst isSnapshotError = (ex: any): boolean => {\n    if (ex.meta?.body?.error?.type === SNAPSHOT_ERROR) {\n        return true;\n    }\n    const rootCauses = ex.meta?.body?.error?.root_cause;\n    if (!Array.isArray(rootCauses)) {\n        return false;\n    }\n    return rootCauses.some((rc: any) => rc.type === SNAPSHOT_ERROR);\n};\n\nconst wait = (ms: number): Promise<void> => {\n    return new Promise(resolve => setTimeout(resolve, ms));\n};\n\nconst createDeleteIndex = (client: Client) => {\n    const maxRetries = 10;\n\n    return async (index: string): Promise<void> => {\n        for (let attempt = 0; attempt <= maxRetries; attempt++) {\n            try {\n                const { body: exists } = await client.indices.exists({\n                    index,\n                    ignore_unavailable: true\n                });\n                if (!exists) {\n                    return;\n                }\n            } catch (ex: any) {\n                console.log(`Could not determine that index exists: ${index}`);\n                console.log(ex.message);\n                return;\n            }\n\n            try {\n                await client.indices.delete({ index, ignore_unavailable: true });\n                return;\n            } catch (ex: any) {\n                console.log(`Could not delete index: ${index}`);\n                if (!isSnapshotError(ex)) {\n                    return;\n                }\n                console.log(\"Snapshot in progress, retrying...\");\n            }\n\n            await wait(1000);\n        }\n    };\n};\n\nexport interface TestOpenSearchClient extends Client {\n    indices: Client[\"indices\"] & {\n        deleteAll: () => Promise<void>;\n        refreshAll: (indexes?: string[] | null) => Promise<void>;\n        registerIndex: (names: string[] | string) => void;\n    };\n}\n\nconst attachTestBehavior = (client: Client): TestOpenSearchClient => {\n    const registeredIndexes = new Set<string>();\n    const dirtyIndexes = new Set<string>();\n    const originalCreate = client.indices.create;\n    const originalExists = client.indices.exists;\n    const deleteIndex = createDeleteIndex(client);\n\n    const registerIndex = (input: string[] | string) => {\n        if (!input) {\n            return;\n        }\n        const names = Array.isArray(input) ? input : [input];\n        for (const name of names) {\n            registeredIndexes.add(name);\n        }\n    };\n\n    const refreshIndex = async (index: string) => {\n        try {\n            await client.indices.refresh({ index, ignore_unavailable: true });\n        } catch (ex: any) {\n            console.log(`Could not refresh index \"${index}\": ${ex.message}`);\n            throw ex;\n        }\n    };\n\n    const refreshAll = async (indexes: string[] | null = null) => {\n        const targets = indexes?.length ? indexes : Array.from(registeredIndexes.values());\n        for (const index of targets) {\n            await refreshIndex(index);\n            dirtyIndexes.delete(index);\n        }\n    };\n\n    // @ts-expect-error\n    client.indices.exists = async (params: any, options: any = {}) => {\n        registerIndex(params.index);\n        // @ts-expect-error\n        return originalExists.apply(client.indices, [params, options]);\n    };\n\n    // @ts-expect-error\n    client.indices.create = async (params: any, options: any = {}) => {\n        await deleteIndex(params.index);\n        // @ts-expect-error\n        const response = await originalCreate.apply(client.indices, [params, options]);\n        registeredIndexes.add(params.index);\n        await client.indices.refresh({ index: params.index });\n        return response;\n    };\n\n    const testClient = client as TestOpenSearchClient;\n\n    testClient.indices.deleteAll = async () => {\n        const indexes = Array.from(registeredIndexes.values());\n        for (const index of indexes) {\n            try {\n                await deleteIndex(index);\n            } catch {\n                console.log(`Could not delete index \"${index}\".`);\n            }\n        }\n    };\n\n    testClient.indices.refreshAll = refreshAll;\n    testClient.indices.registerIndex = registerIndex;\n\n    const originalSearch = client.search;\n    // @ts-expect-error\n    client.search = async (...params: any[]) => {\n        const [param] = params;\n        const index = param?.index;\n        if (index && dirtyIndexes.has(index)) {\n            await refreshIndex(index);\n            dirtyIndexes.delete(index);\n        }\n        // @ts-expect-error\n        return await originalSearch.apply(client, params);\n    };\n\n    const originalBulk = client.bulk;\n    // @ts-expect-error\n    client.bulk = async (...params: any[]) => {\n        const [param] = params;\n        const { body } = param;\n        const deletedIndexes = new Set<string>();\n        if (Array.isArray(body)) {\n            for (const item of body) {\n                if (item.index?._index) {\n                    dirtyIndexes.add(item.index._index);\n                    registerIndex(item.index._index);\n                } else if (item.delete?._index) {\n                    deletedIndexes.add(item.delete._index);\n                    registerIndex(item.delete._index);\n                }\n            }\n        }\n        // @ts-expect-error\n        const result = await originalBulk.apply(client, params);\n        if (deletedIndexes.size > 0) {\n            await refreshAll(Array.from(deletedIndexes));\n        }\n        return result;\n    };\n\n    return testClient;\n};\n\nexport const createTestOpenSearchClient = (\n    options: Partial<ClientOptions> = {}\n): TestOpenSearchClient => {\n    const client = new Client({\n        ...getDefaultOptions(),\n        ...options\n    });\n    return attachTestBehavior(client);\n};\n\nlet singletonClient: TestOpenSearchClient | null = null;\n\nexport const getTestOpenSearchClient = (): TestOpenSearchClient => {\n    if (!singletonClient) {\n        singletonClient = createTestOpenSearchClient();\n    }\n    return singletonClient;\n};\n"],"names":["OPENSEARCH_PORT","process","getDefaultOptions","endpoint","username","password","options","SNAPSHOT_ERROR","isSnapshotError","ex","rootCauses","Array","rc","wait","ms","Promise","resolve","setTimeout","createDeleteIndex","client","maxRetries","index","attempt","exists","console","attachTestBehavior","registeredIndexes","Set","dirtyIndexes","originalCreate","originalExists","deleteIndex","registerIndex","input","names","name","refreshIndex","refreshAll","indexes","targets","params","response","testClient","originalSearch","param","originalBulk","body","deletedIndexes","item","result","createTestOpenSearchClient","Client","singletonClient","getTestOpenSearchClient"],"mappings":";AAGA,MAAMA,kBAAkBC,QAAQ,GAAG,CAAC,eAAe,IAAI;AAEvD,MAAMC,oBAAoB;IACtB,MAAMC,WAAWF,QAAQ,GAAG,CAAC,mBAAmB;IAChD,MAAMG,WAAWH,QAAQ,GAAG,CAAC,mBAAmB;IAChD,MAAMI,WAAWJ,QAAQ,GAAG,CAAC,mBAAmB;IAEhD,MAAMK,UAAkC;QACpC,MAAM,CAAC,iBAAiB,EAAEN,iBAAiB;QAC3C,YAAY;QACZ,aAAa;IACjB;IAEA,IAAII,YAAYC,UACZC,QAAQ,IAAI,GAAG;QAAEF;QAAUC;IAAS;IAGxC,IAAIF,UACAG,QAAQ,IAAI,GAAGH,AAA4B,SAA5BA,SAAS,KAAK,CAAC,WAAoB,CAAC,QAAQ,EAAEA,UAAU,GAAGA;IAG9E,OAAOG;AACX;AAEA,MAAMC,iBAAiB;AAEvB,MAAMC,kBAAkB,CAACC;IACrB,IAAIA,GAAG,IAAI,EAAE,MAAM,OAAO,SAASF,gBAC/B,OAAO;IAEX,MAAMG,aAAaD,GAAG,IAAI,EAAE,MAAM,OAAO;IACzC,IAAI,CAACE,MAAM,OAAO,CAACD,aACf,OAAO;IAEX,OAAOA,WAAW,IAAI,CAAC,CAACE,KAAYA,GAAG,IAAI,KAAKL;AACpD;AAEA,MAAMM,OAAO,CAACC,KACH,IAAIC,QAAQC,CAAAA,UAAWC,WAAWD,SAASF;AAGtD,MAAMI,oBAAoB,CAACC;IACvB,MAAMC,aAAa;IAEnB,OAAO,OAAOC;QACV,IAAK,IAAIC,UAAU,GAAGA,WAAWF,YAAYE,UAAW;YACpD,IAAI;gBACA,MAAM,EAAE,MAAMC,MAAM,EAAE,GAAG,MAAMJ,OAAO,OAAO,CAAC,MAAM,CAAC;oBACjDE;oBACA,oBAAoB;gBACxB;gBACA,IAAI,CAACE,QACD;YAER,EAAE,OAAOd,IAAS;gBACde,QAAQ,GAAG,CAAC,CAAC,uCAAuC,EAAEH,OAAO;gBAC7DG,QAAQ,GAAG,CAACf,GAAG,OAAO;gBACtB;YACJ;YAEA,IAAI;gBACA,MAAMU,OAAO,OAAO,CAAC,MAAM,CAAC;oBAAEE;oBAAO,oBAAoB;gBAAK;gBAC9D;YACJ,EAAE,OAAOZ,IAAS;gBACde,QAAQ,GAAG,CAAC,CAAC,wBAAwB,EAAEH,OAAO;gBAC9C,IAAI,CAACb,gBAAgBC,KACjB;gBAEJe,QAAQ,GAAG,CAAC;YAChB;YAEA,MAAMX,KAAK;QACf;IACJ;AACJ;AAUA,MAAMY,qBAAqB,CAACN;IACxB,MAAMO,oBAAoB,IAAIC;IAC9B,MAAMC,eAAe,IAAID;IACzB,MAAME,iBAAiBV,OAAO,OAAO,CAAC,MAAM;IAC5C,MAAMW,iBAAiBX,OAAO,OAAO,CAAC,MAAM;IAC5C,MAAMY,cAAcb,kBAAkBC;IAEtC,MAAMa,gBAAgB,CAACC;QACnB,IAAI,CAACA,OACD;QAEJ,MAAMC,QAAQvB,MAAM,OAAO,CAACsB,SAASA,QAAQ;YAACA;SAAM;QACpD,KAAK,MAAME,QAAQD,MACfR,kBAAkB,GAAG,CAACS;IAE9B;IAEA,MAAMC,eAAe,OAAOf;QACxB,IAAI;YACA,MAAMF,OAAO,OAAO,CAAC,OAAO,CAAC;gBAAEE;gBAAO,oBAAoB;YAAK;QACnE,EAAE,OAAOZ,IAAS;YACde,QAAQ,GAAG,CAAC,CAAC,yBAAyB,EAAEH,MAAM,GAAG,EAAEZ,GAAG,OAAO,EAAE;YAC/D,MAAMA;QACV;IACJ;IAEA,MAAM4B,aAAa,OAAOC,UAA2B,IAAI;QACrD,MAAMC,UAAUD,SAAS,SAASA,UAAU3B,MAAM,IAAI,CAACe,kBAAkB,MAAM;QAC/E,KAAK,MAAML,SAASkB,QAAS;YACzB,MAAMH,aAAaf;YACnBO,aAAa,MAAM,CAACP;QACxB;IACJ;IAGAF,OAAO,OAAO,CAAC,MAAM,GAAG,OAAOqB,QAAalC,UAAe,CAAC,CAAC;QACzD0B,cAAcQ,OAAO,KAAK;QAE1B,OAAOV,eAAe,KAAK,CAACX,OAAO,OAAO,EAAE;YAACqB;YAAQlC;SAAQ;IACjE;IAGAa,OAAO,OAAO,CAAC,MAAM,GAAG,OAAOqB,QAAalC,UAAe,CAAC,CAAC;QACzD,MAAMyB,YAAYS,OAAO,KAAK;QAE9B,MAAMC,WAAW,MAAMZ,eAAe,KAAK,CAACV,OAAO,OAAO,EAAE;YAACqB;YAAQlC;SAAQ;QAC7EoB,kBAAkB,GAAG,CAACc,OAAO,KAAK;QAClC,MAAMrB,OAAO,OAAO,CAAC,OAAO,CAAC;YAAE,OAAOqB,OAAO,KAAK;QAAC;QACnD,OAAOC;IACX;IAEA,MAAMC,aAAavB;IAEnBuB,WAAW,OAAO,CAAC,SAAS,GAAG;QAC3B,MAAMJ,UAAU3B,MAAM,IAAI,CAACe,kBAAkB,MAAM;QACnD,KAAK,MAAML,SAASiB,QAChB,IAAI;YACA,MAAMP,YAAYV;QACtB,EAAE,OAAM;YACJG,QAAQ,GAAG,CAAC,CAAC,wBAAwB,EAAEH,MAAM,EAAE,CAAC;QACpD;IAER;IAEAqB,WAAW,OAAO,CAAC,UAAU,GAAGL;IAChCK,WAAW,OAAO,CAAC,aAAa,GAAGV;IAEnC,MAAMW,iBAAiBxB,OAAO,MAAM;IAEpCA,OAAO,MAAM,GAAG,OAAO,GAAGqB;QACtB,MAAM,CAACI,MAAM,GAAGJ;QAChB,MAAMnB,QAAQuB,OAAO;QACrB,IAAIvB,SAASO,aAAa,GAAG,CAACP,QAAQ;YAClC,MAAMe,aAAaf;YACnBO,aAAa,MAAM,CAACP;QACxB;QAEA,OAAO,MAAMsB,eAAe,KAAK,CAACxB,QAAQqB;IAC9C;IAEA,MAAMK,eAAe1B,OAAO,IAAI;IAEhCA,OAAO,IAAI,GAAG,OAAO,GAAGqB;QACpB,MAAM,CAACI,MAAM,GAAGJ;QAChB,MAAM,EAAEM,IAAI,EAAE,GAAGF;QACjB,MAAMG,iBAAiB,IAAIpB;QAC3B,IAAIhB,MAAM,OAAO,CAACmC,OACd;YAAA,KAAK,MAAME,QAAQF,KACf,IAAIE,KAAK,KAAK,EAAE,QAAQ;gBACpBpB,aAAa,GAAG,CAACoB,KAAK,KAAK,CAAC,MAAM;gBAClChB,cAAcgB,KAAK,KAAK,CAAC,MAAM;YACnC,OAAO,IAAIA,KAAK,MAAM,EAAE,QAAQ;gBAC5BD,eAAe,GAAG,CAACC,KAAK,MAAM,CAAC,MAAM;gBACrChB,cAAcgB,KAAK,MAAM,CAAC,MAAM;YACpC;QACJ;QAGJ,MAAMC,SAAS,MAAMJ,aAAa,KAAK,CAAC1B,QAAQqB;QAChD,IAAIO,eAAe,IAAI,GAAG,GACtB,MAAMV,WAAW1B,MAAM,IAAI,CAACoC;QAEhC,OAAOE;IACX;IAEA,OAAOP;AACX;AAEO,MAAMQ,6BAA6B,CACtC5C,UAAkC,CAAC,CAAC;IAEpC,MAAMa,SAAS,IAAIgC,OAAO;QACtB,GAAGjD,mBAAmB;QACtB,GAAGI,OAAO;IACd;IACA,OAAOmB,mBAAmBN;AAC9B;AAEA,IAAIiC,kBAA+C;AAE5C,MAAMC,0BAA0B;IACnC,IAAI,CAACD,iBACDA,kBAAkBF;IAEtB,OAAOE;AACX"}

package/testing/index.d.ts

@@ -0,0 +1,4 @@
+export { createTestOpenSearchClient, getTestOpenSearchClient, type TestOpenSearchClient } from "./createTestOpenSearchClient.js";
+export { registerOpenSearchCoreForTests } from "./registerOpenSearchCoreForTests.js";
+export { setupTestIndexManager } from "./setupTestIndexManager.js";
+export { createBlankQuery } from "./createBlankQuery.js";

package/testing/index.js

@@ -0,0 +1,4 @@
+export { createTestOpenSearchClient, getTestOpenSearchClient } from "./createTestOpenSearchClient.js";
+export { registerOpenSearchCoreForTests } from "./registerOpenSearchCoreForTests.js";
+export { setupTestIndexManager } from "./setupTestIndexManager.js";
+export { createBlankQuery } from "./createBlankQuery.js";

package/testing/registerOpenSearchCoreForTests.d.ts

@@ -0,0 +1 @@
+export declare const registerOpenSearchCoreForTests: () => import("@webiny/handler/index.js").RegisterExtensionPlugin<import("@webiny/handler/types.js").Context>;

package/testing/registerOpenSearchCoreForTests.js

@@ -0,0 +1,9 @@
+import { registerOpenSearchCore } from "../registerOpenSearchCore.js";
+import { getTestOpenSearchClient } from "./createTestOpenSearchClient.js";
+const registerOpenSearchCoreForTests = ()=>{
+    const client = getTestOpenSearchClient();
+    return registerOpenSearchCore(client);
+};
+export { registerOpenSearchCoreForTests };
+
+//# sourceMappingURL=registerOpenSearchCoreForTests.js.map

package/testing/registerOpenSearchCoreForTests.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testing/registerOpenSearchCoreForTests.js","sources":["../../src/testing/registerOpenSearchCoreForTests.ts"],"sourcesContent":["import { registerOpenSearchCore } from \"~/registerOpenSearchCore.js\";\nimport { getTestOpenSearchClient } from \"./createTestOpenSearchClient.js\";\n\nexport const registerOpenSearchCoreForTests = () => {\n    const client = getTestOpenSearchClient();\n    return registerOpenSearchCore(client);\n};\n"],"names":["registerOpenSearchCoreForTests","client","getTestOpenSearchClient","registerOpenSearchCore"],"mappings":";;AAGO,MAAMA,iCAAiC;IAC1C,MAAMC,SAASC;IACf,OAAOC,uBAAuBF;AAClC"}

package/testing/setupTestIndexManager.d.ts

@@ -0,0 +1,13 @@
+type LifecycleHook = () => Promise<void>;
+interface TestGlobal {
+    __beforeEach: LifecycleHook;
+    __afterEach: LifecycleHook;
+    __beforeAll: LifecycleHook;
+    __afterAll: LifecycleHook;
+}
+interface SetupTestIndexManagerParams {
+    global: typeof globalThis & Partial<TestGlobal>;
+    onBeforeEach?: () => Promise<void> | void;
+}
+export declare const setupTestIndexManager: (params: SetupTestIndexManagerParams) => void;
+export {};

package/testing/setupTestIndexManager.js

@@ -0,0 +1,26 @@
+import { getTestOpenSearchClient } from "./createTestOpenSearchClient.js";
+const setupTestIndexManager = (params)=>{
+    const { global, onBeforeEach } = params;
+    const client = getTestOpenSearchClient();
+    const clearIndices = async ()=>{
+        try {
+            await client.indices.deleteAll();
+        } catch  {}
+    };
+    global.__beforeEach = async ()=>{
+        await clearIndices();
+        if (onBeforeEach) await onBeforeEach();
+    };
+    global.__afterEach = async ()=>{
+        await clearIndices();
+    };
+    global.__beforeAll = async ()=>{
+        await clearIndices();
+    };
+    global.__afterAll = async ()=>{
+        await clearIndices();
+    };
+};
+export { setupTestIndexManager };
+
+//# sourceMappingURL=setupTestIndexManager.js.map

package/testing/setupTestIndexManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testing/setupTestIndexManager.js","sources":["../../src/testing/setupTestIndexManager.ts"],"sourcesContent":["import { getTestOpenSearchClient } from \"./createTestOpenSearchClient.js\";\n\ntype LifecycleHook = () => Promise<void>;\n\ninterface TestGlobal {\n    __beforeEach: LifecycleHook;\n    __afterEach: LifecycleHook;\n    __beforeAll: LifecycleHook;\n    __afterAll: LifecycleHook;\n}\n\ninterface SetupTestIndexManagerParams {\n    global: typeof globalThis & Partial<TestGlobal>;\n    onBeforeEach?: () => Promise<void> | void;\n}\n\nexport const setupTestIndexManager = (params: SetupTestIndexManagerParams) => {\n    const { global, onBeforeEach } = params;\n    const client = getTestOpenSearchClient();\n\n    const clearIndices = async () => {\n        try {\n            await client.indices.deleteAll();\n        } catch {\n            /* Intentionally swallowed. */\n        }\n    };\n\n    global.__beforeEach = async () => {\n        await clearIndices();\n        if (onBeforeEach) {\n            await onBeforeEach();\n        }\n    };\n\n    global.__afterEach = async () => {\n        await clearIndices();\n    };\n\n    global.__beforeAll = async () => {\n        await clearIndices();\n    };\n\n    global.__afterAll = async () => {\n        await clearIndices();\n    };\n};\n"],"names":["setupTestIndexManager","params","global","onBeforeEach","client","getTestOpenSearchClient","clearIndices"],"mappings":";AAgBO,MAAMA,wBAAwB,CAACC;IAClC,MAAM,EAAEC,MAAM,EAAEC,YAAY,EAAE,GAAGF;IACjC,MAAMG,SAASC;IAEf,MAAMC,eAAe;QACjB,IAAI;YACA,MAAMF,OAAO,OAAO,CAAC,SAAS;QAClC,EAAE,OAAM,CAER;IACJ;IAEAF,OAAO,YAAY,GAAG;QAClB,MAAMI;QACN,IAAIH,cACA,MAAMA;IAEd;IAEAD,OAAO,WAAW,GAAG;QACjB,MAAMI;IACV;IAEAJ,OAAO,WAAW,GAAG;QACjB,MAAMI;IACV;IAEAJ,OAAO,UAAU,GAAG;QAChB,MAAMI;IACV;AACJ"}

package/types.d.ts

@@ -1,6 +1,5 @@
 import type { Client } from "@opensearch-project/opensearch";
 import type { Search_RequestBody as SearchRequestBody, Search_Response, Indices_Create_RequestBody } from "@opensearch-project/opensearch/api/index.js";
-import type { Context } from "@webiny/api/types.js";
 type QueryDslQueryContainer = NonNullable<SearchRequestBody["query"]>;
 type QueryDslBoolQuery = NonNullable<QueryDslQueryContainer["bool"]>;
 type SearchSort = NonNullable<SearchRequestBody["sort"]>;
@@ -29,13 +28,6 @@ export type SortType = Record<string, FieldSortOptions>;
 export type SearchBody = Omit<SearchRequestBody, "search_after"> & {
     search_after?: PrimitiveValue[];
 };
-export interface OpenSearchContext extends Context {
-    /**
-     * @deprecated Use `context.opensearch` instead.
-     */
-    elasticsearch: Client;
-    opensearch: Client;
-}
 export interface OpenSearchBoolQueryConfig extends QueryDslBoolQuery {
     must: QueryDslQueryContainer[];
     filter: QueryDslQueryContainer[];

package/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sources":["../src/types.ts"],"sourcesContent":["import type { Client } from \"@opensearch-project/opensearch\";\nimport type {\n    Search_RequestBody as SearchRequestBody,\n    Search_Response,\n    Indices_Create_RequestBody\n} from \"@opensearch-project/opensearch/api/index.js\";\nimport type { Context } from \"@webiny/api/types.js\";\n\n// ---------------------------------------------------------------------------\n// Types inferred from the accessible API surface.\n// The `_types/` directory in the opensearch package only ships `.d.ts` files\n// (no `.js` runtime modules), so deep imports are unresolvable under\n// `moduleResolution: \"bundler\"`.  We infer what we can from the public\n// barrel (`api/index.js`) and use `string` where structural extraction\n// is not possible.\n// ---------------------------------------------------------------------------\n\ntype QueryDslQueryContainer = NonNullable<SearchRequestBody[\"query\"]>;\ntype QueryDslBoolQuery = NonNullable<QueryDslQueryContainer[\"bool\"]>;\ntype SearchSort = NonNullable<SearchRequestBody[\"sort\"]>;\ntype SearchSortOrder = \"asc\" | \"desc\";\n\n// Distribute over the SortOptions union and extract only the Record<string, FieldSort> variant.\ntype _ExtractRecordValue<T> = T extends Record<string, infer V> ? V : never;\ntype _SortMember =\n    NonNullable<SearchRequestBody[\"sort\"]> extends (infer U)[] | (infer U) ? U : never;\ntype SearchFieldSort = _ExtractRecordValue<Exclude<_SortMember, string>>;\n\ntype DynamicTemplate = NonNullable<\n    NonNullable<Indices_Create_RequestBody[\"mappings\"]>[\"dynamic_templates\"]\n>[number][string];\n\nexport type { ApiResponse } from \"@opensearch-project/opensearch\";\n\nexport type { Client };\n\n// ---------------------------------------------------------------------------\n// Local type aliases replacing elastic-ts\n// ---------------------------------------------------------------------------\n\n/** Replaces elastic-ts PrimitiveValue. Aligns with opensearch FieldValue. */\nexport type PrimitiveValue = boolean | undefined | number | string;\n\n/** Replaces elastic-ts Query */\nexport type { QueryDslQueryContainer };\n\n/** Replaces elastic-ts BoolQueryConfig */\nexport type { QueryDslBoolQuery };\n\n/** Replaces elastic-ts FieldSortOptions */\nexport type FieldSortOptions = SearchFieldSort;\n\n/** Replaces elastic-ts SortOrder. Narrowed to \"asc\" | \"desc\" (excludes \"_doc\"). */\nexport type SortOrder = \"asc\" | \"desc\";\n\n/** Replaces elastic-ts Sort */\nexport type { SearchSort as Sort };\n\n/** Single sort entry as an object map. Replaces elastic-ts SortType. */\nexport type SortType = Record<string, FieldSortOptions>;\n\n/** Replaces elastic-ts SearchBody. Overrides search_after to allow PrimitiveValue[] (null | boolean | string | number). */\nexport type SearchBody = Omit<SearchRequestBody, \"search_after\"> & {\n    search_after?: PrimitiveValue[];\n};\n\n// ---------------------------------------------------------------------------\n// Context\n// ---------------------------------------------------------------------------\n\nexport interface OpenSearchContext extends Context {\n    /**\n     * @deprecated Use `context.opensearch` instead.\n     */\n    elasticsearch: Client;\n    opensearch: Client;\n}\n\n// ---------------------------------------------------------------------------\n// Bool query with required arrays (our convention)\n// ---------------------------------------------------------------------------\n\nexport interface OpenSearchBoolQueryConfig extends QueryDslBoolQuery {\n    must: QueryDslQueryContainer[];\n    filter: QueryDslQueryContainer[];\n    should: QueryDslQueryContainer[];\n    must_not: QueryDslQueryContainer[];\n}\n\n// ---------------------------------------------------------------------------\n// Operator plugin types\n// ---------------------------------------------------------------------------\n\nexport type OpenSearchQueryOperator =\n    | \"eq\"\n    | \"not\"\n    | \"in\"\n    | \"not_in\"\n    | \"contains\"\n    | \"not_contains\"\n    | \"between\"\n    | \"not_between\"\n    | \"gt\"\n    | \"gte\"\n    | \"lt\"\n    | \"lte\"\n    | string;\n\nexport interface OpenSearchQueryBuilderArgsPlugin {\n    name: string;\n    path: string;\n    basePath: string;\n    value: any;\n    keyword: boolean;\n}\n\n// ---------------------------------------------------------------------------\n// Search response shapes (aligned with @opensearch-project/opensearch v3)\n// ---------------------------------------------------------------------------\n\nexport type OpenSearchSearchResponseHit = Search_Response[\"body\"][\"hits\"][\"hits\"][number];\n\nexport interface OpenSearchSearchResponseAggregationBucket {\n    key: PrimitiveValue;\n    doc_count: number;\n}\n\nexport type OpenSearchSearchResponseBodyHits = Search_Response[\"body\"][\"hits\"];\n\nexport type OpenSearchSearchResponseBody = Search_Response[\"body\"];\n\nexport type OpenSearchSearchResponse = Search_Response;\n\n/**\n * Extract the total count from an opensearch hits response.\n * Handles both `TotalHits` (object with `value`) and plain `number` formats.\n */\nexport const getTotalCount = (total: OpenSearchSearchResponseBodyHits[\"total\"]): number => {\n    if (total === undefined || total === null) {\n        return 0;\n    }\n    if (typeof total === \"number\") {\n        return total;\n    }\n    return total.value;\n};\n\n// ---------------------------------------------------------------------------\n// Index request body shapes (re-exported from opensearch package)\n// ---------------------------------------------------------------------------\n\nexport type OpenSearchIndexRequestBodyMappingsDynamicTemplate = Record<string, DynamicTemplate>;\n\nexport type OpenSearchIndexRequestBody = Indices_Create_RequestBody;\n\n// Re-export SearchSortOrder for consumers that need it (including \"_doc\")\nexport type { SearchSortOrder };\n"],"names":["getTotalCount","total"],"mappings":"AAyIO,MAAMA,gBAAgB,CAACC;IAC1B,IAAIA,QAAAA,OACA,OAAO;IAEX,IAAI,AAAiB,YAAjB,OAAOA,OACP,OAAOA;IAEX,OAAOA,MAAM,KAAK;AACtB"}
+{"version":3,"file":"types.js","sources":["../src/types.ts"],"sourcesContent":["import type { Client } from \"@opensearch-project/opensearch\";\nimport type {\n    Search_RequestBody as SearchRequestBody,\n    Search_Response,\n    Indices_Create_RequestBody\n} from \"@opensearch-project/opensearch/api/index.js\";\n\n// ---------------------------------------------------------------------------\n// Types inferred from the accessible API surface.\n// The `_types/` directory in the opensearch package only ships `.d.ts` files\n// (no `.js` runtime modules), so deep imports are unresolvable under\n// `moduleResolution: \"bundler\"`.  We infer what we can from the public\n// barrel (`api/index.js`) and use `string` where structural extraction\n// is not possible.\n// ---------------------------------------------------------------------------\n\ntype QueryDslQueryContainer = NonNullable<SearchRequestBody[\"query\"]>;\ntype QueryDslBoolQuery = NonNullable<QueryDslQueryContainer[\"bool\"]>;\ntype SearchSort = NonNullable<SearchRequestBody[\"sort\"]>;\ntype SearchSortOrder = \"asc\" | \"desc\";\n\n// Distribute over the SortOptions union and extract only the Record<string, FieldSort> variant.\ntype _ExtractRecordValue<T> = T extends Record<string, infer V> ? V : never;\ntype _SortMember =\n    NonNullable<SearchRequestBody[\"sort\"]> extends (infer U)[] | (infer U) ? U : never;\ntype SearchFieldSort = _ExtractRecordValue<Exclude<_SortMember, string>>;\n\ntype DynamicTemplate = NonNullable<\n    NonNullable<Indices_Create_RequestBody[\"mappings\"]>[\"dynamic_templates\"]\n>[number][string];\n\nexport type { ApiResponse } from \"@opensearch-project/opensearch\";\n\nexport type { Client };\n\n// ---------------------------------------------------------------------------\n// Local type aliases replacing elastic-ts\n// ---------------------------------------------------------------------------\n\n/** Replaces elastic-ts PrimitiveValue. Aligns with opensearch FieldValue. */\nexport type PrimitiveValue = boolean | undefined | number | string;\n\n/** Replaces elastic-ts Query */\nexport type { QueryDslQueryContainer };\n\n/** Replaces elastic-ts BoolQueryConfig */\nexport type { QueryDslBoolQuery };\n\n/** Replaces elastic-ts FieldSortOptions */\nexport type FieldSortOptions = SearchFieldSort;\n\n/** Replaces elastic-ts SortOrder. Narrowed to \"asc\" | \"desc\" (excludes \"_doc\"). */\nexport type SortOrder = \"asc\" | \"desc\";\n\n/** Replaces elastic-ts Sort */\nexport type { SearchSort as Sort };\n\n/** Single sort entry as an object map. Replaces elastic-ts SortType. */\nexport type SortType = Record<string, FieldSortOptions>;\n\n/** Replaces elastic-ts SearchBody. Overrides search_after to allow PrimitiveValue[] (null | boolean | string | number). */\nexport type SearchBody = Omit<SearchRequestBody, \"search_after\"> & {\n    search_after?: PrimitiveValue[];\n};\n\n// ---------------------------------------------------------------------------\n// Bool query with required arrays (our convention)\n// ---------------------------------------------------------------------------\n\nexport interface OpenSearchBoolQueryConfig extends QueryDslBoolQuery {\n    must: QueryDslQueryContainer[];\n    filter: QueryDslQueryContainer[];\n    should: QueryDslQueryContainer[];\n    must_not: QueryDslQueryContainer[];\n}\n\n// ---------------------------------------------------------------------------\n// Operator plugin types\n// ---------------------------------------------------------------------------\n\nexport type OpenSearchQueryOperator =\n    | \"eq\"\n    | \"not\"\n    | \"in\"\n    | \"not_in\"\n    | \"contains\"\n    | \"not_contains\"\n    | \"between\"\n    | \"not_between\"\n    | \"gt\"\n    | \"gte\"\n    | \"lt\"\n    | \"lte\"\n    | string;\n\nexport interface OpenSearchQueryBuilderArgsPlugin {\n    name: string;\n    path: string;\n    basePath: string;\n    value: any;\n    keyword: boolean;\n}\n\n// ---------------------------------------------------------------------------\n// Search response shapes (aligned with @opensearch-project/opensearch v3)\n// ---------------------------------------------------------------------------\n\nexport type OpenSearchSearchResponseHit = Search_Response[\"body\"][\"hits\"][\"hits\"][number];\n\nexport interface OpenSearchSearchResponseAggregationBucket {\n    key: PrimitiveValue;\n    doc_count: number;\n}\n\nexport type OpenSearchSearchResponseBodyHits = Search_Response[\"body\"][\"hits\"];\n\nexport type OpenSearchSearchResponseBody = Search_Response[\"body\"];\n\nexport type OpenSearchSearchResponse = Search_Response;\n\n/**\n * Extract the total count from an opensearch hits response.\n * Handles both `TotalHits` (object with `value`) and plain `number` formats.\n */\nexport const getTotalCount = (total: OpenSearchSearchResponseBodyHits[\"total\"]): number => {\n    if (total === undefined || total === null) {\n        return 0;\n    }\n    if (typeof total === \"number\") {\n        return total;\n    }\n    return total.value;\n};\n\n// ---------------------------------------------------------------------------\n// Index request body shapes (re-exported from opensearch package)\n// ---------------------------------------------------------------------------\n\nexport type OpenSearchIndexRequestBodyMappingsDynamicTemplate = Record<string, DynamicTemplate>;\n\nexport type OpenSearchIndexRequestBody = Indices_Create_RequestBody;\n\n// Re-export SearchSortOrder for consumers that need it (including \"_doc\")\nexport type { SearchSortOrder };\n"],"names":["getTotalCount","total"],"mappings":"AA4HO,MAAMA,gBAAgB,CAACC;IAC1B,IAAIA,QAAAA,OACA,OAAO;IAEX,IAAI,AAAiB,YAAjB,OAAOA,OACP,OAAOA;IAEX,OAAOA,MAAM,KAAK;AACtB"}

package/utils/createIndex.d.ts

@@ -1,5 +1,5 @@
 import type { Client } from "../client.js";
-import type { PluginsContainer } from "@webiny/plugins";
+import type { OpenSearchIndex } from "../features/OpenSearchIndex/abstractions/OpenSearchIndex.js";
 interface OnExists {
     (): void;
 }
@@ -8,7 +8,7 @@ interface OnError {
 }
 interface CreateIndexParams {
     client: Client;
-    plugins: PluginsContainer;
+    plugin: OpenSearchIndex.Interface;
     type: string;
     tenant: string;
     index: string;

package/utils/createIndex.js

@@ -1,7 +1,6 @@
-import { getLastAddedIndexPlugin } from "../indices.js";
 import _webiny_error from "@webiny/error";
 const indexExists = async (params)=>{
-    const { client, index, onExists } = params;
+    const { client, index } = params;
     try {
         const response = await client.indices.exists({
             index,
@@ -12,7 +11,6 @@ const indexExists = async (params)=>{
             local: false
         });
         if (!response.body) return false;
-        if (onExists) onExists();
         return true;
     } catch  {
         console.error(`Could not determine if the index "${index}" exists.`);
@@ -46,11 +44,7 @@ const indexCreate = async (params)=>{
     }
 };
 const createIndex = async (params)=>{
-    const { plugins, type, onExists } = params;
-    const plugin = getLastAddedIndexPlugin({
-        container: plugins,
-        type
-    });
+    const { plugin, onExists } = params;
     const exists = await indexExists(params);
     if (exists) {
         if (onExists) onExists();