@opra/elastic 1.6.0 → 1.7.1

package/cjs/elastic-collection-service.js

@@ -220,7 +220,7 @@ class ElasticCollectionService extends elastic_entity_service_js_1.ElasticEntity
             };
             const r = await this._findMany(newCommand);
             if (r.hits.hits?.length) {
-                const outputCodec = this._getOutputCodec('find');
+                const outputCodec = this.getOutputCodec('find');
                 return {
                     _id: r.hits.hits[0]._id,
                     ...outputCodec(r.hits.hits[0]._source),
@@ -250,7 +250,7 @@ class ElasticCollectionService extends elastic_entity_service_js_1.ElasticEntity
             };
             const r = await this._findMany(newCommand);
             if (r.hits.hits?.length) {
-                const outputCodec = this._getOutputCodec('find');
+                const outputCodec = this.getOutputCodec('find');
                 return {
                     _id: r.hits.hits[0]._id,
                     ...outputCodec(r.hits.hits[0]._source),
@@ -276,16 +276,19 @@ class ElasticCollectionService extends elastic_entity_service_js_1.ElasticEntity
             const limit = command.options?.limit || this.defaultLimit;
             command.options = { ...command.options, filter, limit };
             const r = await this._findMany(command);
-            if (r.hits.hits?.length) {
-                const outputCodec = this._getOutputCodec('find');
-                return r.hits.hits.map((x) => ({
-                    _id: x._id,
-                    ...outputCodec(x._source),
-                }));
-            }
-            return [];
+            return r.hits?.hits.map((x) => x._source) || [];
         });
     }
+    async searchRaw(request, options) {
+        const command = {
+            crud: 'read',
+            method: 'searchRaw',
+            byId: false,
+            request,
+            options,
+        };
+        return this._executeCommand(command, async () => this._searchRaw(command));
+    }
     /**
      *
      */
@@ -311,7 +314,7 @@ class ElasticCollectionService extends elastic_entity_service_js_1.ElasticEntity
             const r = await this._findMany(command);
             const out = {};
             if (r.hits.hits?.length) {
-                const outputCodec = this._getOutputCodec('find');
+                const outputCodec = this.getOutputCodec('find');
                 out.items = r.hits.hits.map((x) => ({
                     _id: x._id,
                     ...outputCodec(x._source),
@@ -343,7 +346,7 @@ class ElasticCollectionService extends elastic_entity_service_js_1.ElasticEntity
      * @param {string} id - The ID of the document to update.
      * @param {PatchDTO<T>} input - The partial input data to update the document with.
      * @param {ElasticEntityService.UpdateOneOptions} [options] - The options for updating the document.
-     * @returns {Promise<elastic.UpdateResponse>} - A promise that resolves to the number of documents modified.
+     * @returns {Promise<estypes.UpdateResponse>} - A promise that resolves to the number of documents modified.
      */
     async update(id, input, options) {
         const command = {

package/cjs/elastic-entity-service.js

@@ -221,7 +221,46 @@ class ElasticEntityService extends elastic_service_js_1.ElasticService {
             query,
         };
         const client = this.getClient();
-        return client.search(request, options?.transport);
+        const r = await client.search(request, options?.transport);
+        if (options?.noDecode)
+            return r;
+        if (r.hits.hits?.length) {
+            const outputCodec = this.getOutputCodec('find');
+            r.hits.hits = r.hits.hits.map((x) => ({
+                ...x,
+                _source: {
+                    _id: x._id,
+                    ...outputCodec(x._source),
+                },
+            }));
+        }
+        return r;
+    }
+    /**
+     * Executes a search operation on the Elasticsearch index using the provided search command.
+     *
+     * @param {ElasticEntityService.SearchCommand} command - The search command containing the request configuration and optional transport settings.
+     * @return {Promise<ElasticEntityService.SearchResponse>} A promise resolving to the search response from Elasticsearch.
+     */
+    async _searchRaw(command) {
+        const { options } = command;
+        const request = {
+            index: this.getIndexName(),
+            ...command.request,
+        };
+        const client = this.getClient();
+        const r = await client.search(request, options?.transport);
+        if (r.hits.hits?.length) {
+            const outputCodec = this.getOutputCodec('find');
+            r.hits.hits = r.hits.hits.map((x) => ({
+                ...x,
+                _source: {
+                    _id: x._id,
+                    ...outputCodec(x._source),
+                },
+            }));
+        }
+        return r;
     }
     /**
      * Updates multiple documents in the collection based on the specified input and options.
@@ -319,7 +358,7 @@ class ElasticEntityService extends elastic_service_js_1.ElasticService {
     /**
      * Retrieves the codec.
      */
-    _getOutputCodec(operation) {
+    getOutputCodec(operation) {
         const cacheKey = operation + (this._dataTypeScope ? ':' + this._dataTypeScope : '');
         let validator = this._outputCodecs[cacheKey];
         if (validator)

package/esm/elastic-collection-service.js

@@ -217,7 +217,7 @@ export class ElasticCollectionService extends ElasticEntityService {
             };
             const r = await this._findMany(newCommand);
             if (r.hits.hits?.length) {
-                const outputCodec = this._getOutputCodec('find');
+                const outputCodec = this.getOutputCodec('find');
                 return {
                     _id: r.hits.hits[0]._id,
                     ...outputCodec(r.hits.hits[0]._source),
@@ -247,7 +247,7 @@ export class ElasticCollectionService extends ElasticEntityService {
             };
             const r = await this._findMany(newCommand);
             if (r.hits.hits?.length) {
-                const outputCodec = this._getOutputCodec('find');
+                const outputCodec = this.getOutputCodec('find');
                 return {
                     _id: r.hits.hits[0]._id,
                     ...outputCodec(r.hits.hits[0]._source),
@@ -273,16 +273,19 @@ export class ElasticCollectionService extends ElasticEntityService {
             const limit = command.options?.limit || this.defaultLimit;
             command.options = { ...command.options, filter, limit };
             const r = await this._findMany(command);
-            if (r.hits.hits?.length) {
-                const outputCodec = this._getOutputCodec('find');
-                return r.hits.hits.map((x) => ({
-                    _id: x._id,
-                    ...outputCodec(x._source),
-                }));
-            }
-            return [];
+            return r.hits?.hits.map((x) => x._source) || [];
         });
     }
+    async searchRaw(request, options) {
+        const command = {
+            crud: 'read',
+            method: 'searchRaw',
+            byId: false,
+            request,
+            options,
+        };
+        return this._executeCommand(command, async () => this._searchRaw(command));
+    }
     /**
      *
      */
@@ -308,7 +311,7 @@ export class ElasticCollectionService extends ElasticEntityService {
             const r = await this._findMany(command);
             const out = {};
             if (r.hits.hits?.length) {
-                const outputCodec = this._getOutputCodec('find');
+                const outputCodec = this.getOutputCodec('find');
                 out.items = r.hits.hits.map((x) => ({
                     _id: x._id,
                     ...outputCodec(x._source),
@@ -340,7 +343,7 @@ export class ElasticCollectionService extends ElasticEntityService {
      * @param {string} id - The ID of the document to update.
      * @param {PatchDTO<T>} input - The partial input data to update the document with.
      * @param {ElasticEntityService.UpdateOneOptions} [options] - The options for updating the document.
-     * @returns {Promise<elastic.UpdateResponse>} - A promise that resolves to the number of documents modified.
+     * @returns {Promise<estypes.UpdateResponse>} - A promise that resolves to the number of documents modified.
      */
     async update(id, input, options) {
         const command = {

package/esm/elastic-entity-service.js

@@ -218,7 +218,46 @@ export class ElasticEntityService extends ElasticService {
             query,
         };
         const client = this.getClient();
-        return client.search(request, options?.transport);
+        const r = await client.search(request, options?.transport);
+        if (options?.noDecode)
+            return r;
+        if (r.hits.hits?.length) {
+            const outputCodec = this.getOutputCodec('find');
+            r.hits.hits = r.hits.hits.map((x) => ({
+                ...x,
+                _source: {
+                    _id: x._id,
+                    ...outputCodec(x._source),
+                },
+            }));
+        }
+        return r;
+    }
+    /**
+     * Executes a search operation on the Elasticsearch index using the provided search command.
+     *
+     * @param {ElasticEntityService.SearchCommand} command - The search command containing the request configuration and optional transport settings.
+     * @return {Promise<ElasticEntityService.SearchResponse>} A promise resolving to the search response from Elasticsearch.
+     */
+    async _searchRaw(command) {
+        const { options } = command;
+        const request = {
+            index: this.getIndexName(),
+            ...command.request,
+        };
+        const client = this.getClient();
+        const r = await client.search(request, options?.transport);
+        if (r.hits.hits?.length) {
+            const outputCodec = this.getOutputCodec('find');
+            r.hits.hits = r.hits.hits.map((x) => ({
+                ...x,
+                _source: {
+                    _id: x._id,
+                    ...outputCodec(x._source),
+                },
+            }));
+        }
+        return r;
     }
     /**
      * Updates multiple documents in the collection based on the specified input and options.
@@ -316,7 +355,7 @@ export class ElasticEntityService extends ElasticService {
     /**
      * Retrieves the codec.
      */
-    _getOutputCodec(operation) {
+    getOutputCodec(operation) {
         const cacheKey = operation + (this._dataTypeScope ? ':' + this._dataTypeScope : '');
         let validator = this._outputCodecs[cacheKey];
         if (validator)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opra/elastic",
-  "version": "1.6.0",
+  "version": "1.7.1",
   "description": "Opra Elastic Search adapter package",
   "author": "Panates",
   "license": "MIT",
@@ -11,8 +11,8 @@
   },
   "peerDependencies": {
     "@elastic/elasticsearch": ">=8.7.0",
-    "@opra/common": "^1.6.0",
-    "@opra/core": "^1.6.0"
+    "@opra/common": "^1.7.1",
+    "@opra/core": "^1.7.1"
   },
   "type": "module",
   "exports": {

package/types/adapter-utils/prepare-filter.d.ts

@@ -1,4 +1,4 @@
 import '@opra/core';
-import type { QueryDslQueryContainer } from '@elastic/elasticsearch/lib/api/types';
+import type { estypes } from '@elastic/elasticsearch';
 import { type ElasticAdapter } from '../elastic-adapter.js';
-export default function prepareFilter(filters: ElasticAdapter.FilterInput | ElasticAdapter.FilterInput[]): QueryDslQueryContainer | undefined;
+export default function prepareFilter(filters: ElasticAdapter.FilterInput | ElasticAdapter.FilterInput[]): estypes.QueryDslQueryContainer | undefined;

package/types/elastic-adapter.d.ts

@@ -1,4 +1,4 @@
-import type { QueryDslQueryContainer } from '@elastic/elasticsearch/lib/api/types.js';
+import type { estypes } from '@elastic/elasticsearch';
 import { OpraFilter } from '@opra/common';
 import type { ExecutionContext } from '@opra/core';
 import _prepareFilter from './adapter-utils/prepare-filter.js';
@@ -6,7 +6,7 @@ import _preparePatch from './adapter-utils/prepare-patch.js';
 import _prepareProjection from './adapter-utils/prepare-projection.js';
 import _prepareSort from './adapter-utils/prepare-sort.js';
 export declare namespace ElasticAdapter {
-    type FilterInput = OpraFilter.Expression | QueryDslQueryContainer | string | undefined;
+    type FilterInput = OpraFilter.Expression | estypes.QueryDslQueryContainer | string | undefined;
     const prepareFilter: typeof _prepareFilter;
     const preparePatch: typeof _preparePatch;
     const prepareProjection: typeof _prepareProjection;

package/types/elastic-collection-service.d.ts

@@ -1,4 +1,4 @@
-import type * as elastic from '@elastic/elasticsearch/lib/api/types';
+import type { estypes } from '@elastic/elasticsearch';
 import { ExecutionContext, ServiceBase } from '@opra/core';
 import type { Nullish, PartialDTO, PatchDTO, RequiredSome, Type } from 'ts-gems';
 import { ElasticAdapter } from './elastic-adapter.js';
@@ -23,7 +23,7 @@ export declare namespace ElasticCollectionService {
     interface FindManyWithCountResult<X> {
         items: X[];
         count: number;
-        relation: elastic.SearchTotalHitsRelation;
+        relation: estypes.SearchTotalHitsRelation;
     }
 }
 /**
@@ -70,7 +70,7 @@ export declare class ElasticCollectionService<T extends object = any> extends El
      * @returns {Promise<PartialDTO<T>>} A promise that resolves to the created document.
      * @throws {Error} if an unknown error occurs while creating the document.
      */
-    create(input: PartialDTO<T>, options?: ElasticEntityService.CreateOptions): Promise<elastic.CreateResponse>;
+    create(input: PartialDTO<T>, options?: ElasticEntityService.CreateOptions): Promise<estypes.CreateResponse>;
     /**
      * Returns the count of documents in the collection based on the provided options.
      *
@@ -85,14 +85,14 @@ export declare class ElasticCollectionService<T extends object = any> extends El
      * @param {ElasticEntityService.DeleteOptions} [options] - Optional delete options.
      * @return {Promise<number>} - A Promise that resolves to the number of documents deleted.
      */
-    delete(id: string, options?: ElasticEntityService.DeleteOptions): Promise<elastic.DeleteByQueryResponse>;
+    delete(id: string, options?: ElasticEntityService.DeleteOptions): Promise<estypes.DeleteByQueryResponse>;
     /**
      * Deletes multiple documents from the collection that meet the specified filter criteria.
      *
      * @param {ElasticEntityService.DeleteManyOptions} options - The options for the delete operation.
      * @return {Promise<number>} - A promise that resolves to the number of documents deleted.
      */
-    deleteMany(options?: ElasticEntityService.DeleteManyOptions): Promise<elastic.DeleteByQueryResponse>;
+    deleteMany(options?: ElasticEntityService.DeleteManyOptions): Promise<estypes.DeleteByQueryResponse>;
     /**
      * Checks if an object with the given id exists.
      *
@@ -152,6 +152,7 @@ export declare class ElasticCollectionService<T extends object = any> extends El
      * @return {Promise<T | undefined>} A Promise that resolves to an array of partial outputs of type T.
      */
     findMany(options?: ElasticEntityService.FindManyOptions): Promise<T[]>;
+    searchRaw(request: estypes.SearchRequest, options?: ElasticEntityService.SearchOptions): Promise<estypes.SearchResponse<PartialDTO<T>>>;
     /**
      * Finds multiple documents in the collection and returns both records (max limit)
      * and total count that matched the given criteria
@@ -194,9 +195,9 @@ export declare class ElasticCollectionService<T extends object = any> extends El
      * @param {string} id - The ID of the document to update.
      * @param {PatchDTO<T>} input - The partial input data to update the document with.
      * @param {ElasticEntityService.UpdateOneOptions} [options] - The options for updating the document.
-     * @returns {Promise<elastic.UpdateResponse>} - A promise that resolves to the number of documents modified.
+     * @returns {Promise<estypes.UpdateResponse>} - A promise that resolves to the number of documents modified.
      */
-    update(id: string, input: PatchDTO<T>, options?: ElasticEntityService.UpdateOneOptions): Promise<elastic.UpdateByQueryResponse>;
+    update(id: string, input: PatchDTO<T>, options?: ElasticEntityService.UpdateOneOptions): Promise<estypes.UpdateByQueryResponse>;
     /**
      * Updates multiple documents in the collection based on the specified input and options.
      *
@@ -204,7 +205,7 @@ export declare class ElasticCollectionService<T extends object = any> extends El
      * @param {ElasticEntityService.UpdateManyOptions} options - The options for updating the documents.
      * @return {Promise<number>} - A promise that resolves to the number of documents matched and modified.
      */
-    updateMany(input: PatchDTO<T>, options?: ElasticEntityService.UpdateManyOptions): Promise<elastic.UpdateByQueryResponse>;
+    updateMany(input: PatchDTO<T>, options?: ElasticEntityService.UpdateManyOptions): Promise<estypes.UpdateByQueryResponse>;
     /**
      * Retrieves the common filter used for querying documents.
      * This method is mostly used for security issues like securing multi-tenant applications.

package/types/elastic-entity-service.d.ts

@@ -1,4 +1,4 @@
-import type * as elastic from '@elastic/elasticsearch/lib/api/types.js';
+import type { estypes } from '@elastic/elasticsearch';
 import type { TransportRequestOptions } from '@elastic/transport';
 import { ComplexType } from '@opra/common';
 import type { PartialDTO, PatchDTO, RequiredSome, StrictOmit, Type } from 'ts-gems';
@@ -30,7 +30,7 @@ export declare namespace ElasticEntityService {
      * @interface
      */
     interface CreateOptions {
-        request?: elastic.CreateRequest;
+        request?: estypes.CreateRequest;
         transport?: TransportRequestOptions;
     }
     /**
@@ -41,7 +41,7 @@ export declare namespace ElasticEntityService {
      */
     interface CountOptions {
         filter?: ElasticAdapter.FilterInput;
-        request?: elastic.CountRequest;
+        request?: estypes.CountRequest;
         transport?: TransportRequestOptions;
     }
     /**
@@ -52,7 +52,7 @@ export declare namespace ElasticEntityService {
      */
     interface DeleteOptions {
         filter?: ElasticAdapter.FilterInput;
-        request?: elastic.DeleteByQueryRequest;
+        request?: estypes.DeleteByQueryRequest;
         transport?: TransportRequestOptions;
     }
     /**
@@ -63,7 +63,7 @@ export declare namespace ElasticEntityService {
      */
     interface DeleteManyOptions {
         filter?: ElasticAdapter.FilterInput;
-        request?: elastic.DeleteByQueryRequest;
+        request?: estypes.DeleteByQueryRequest;
         transport?: TransportRequestOptions;
     }
     /**
@@ -86,8 +86,18 @@ export declare namespace ElasticEntityService {
         sort?: string[];
         limit?: number;
         skip?: number;
-        request?: elastic.SearchRequest;
+        request?: estypes.SearchRequest;
         transport?: TransportRequestOptions;
+        noDecode?: boolean;
+    }
+    /**
+     * Represents options for "search" operation
+     *
+     * @interface
+     */
+    interface SearchOptions {
+        transport?: TransportRequestOptions;
+        noDecode?: boolean;
     }
     /**
      * Represents options for "update" operation
@@ -97,7 +107,7 @@ export declare namespace ElasticEntityService {
      */
     interface UpdateOneOptions {
         filter?: ElasticAdapter.FilterInput;
-        request?: elastic.UpdateByQueryRequest;
+        request?: estypes.UpdateByQueryRequest;
         transport?: TransportRequestOptions;
     }
     /**
@@ -108,7 +118,7 @@ export declare namespace ElasticEntityService {
      */
     interface UpdateManyOptions {
         filter?: ElasticAdapter.FilterInput;
-        request?: elastic.UpdateByQueryRequest;
+        request?: estypes.UpdateByQueryRequest;
         transport?: TransportRequestOptions;
     }
     interface CreateCommand extends StrictOmit<RequiredSome<CommandInfo, 'input'>, 'documentId'> {
@@ -131,11 +141,17 @@ export declare namespace ElasticEntityService {
         crud: 'read';
         options?: FindManyOptions;
     }
+    interface SearchCommand extends StrictOmit<CommandInfo, 'input'> {
+        crud: 'read';
+        request: estypes.SearchRequest;
+        options?: SearchOptions;
+    }
     interface UpdateCommand<T> extends CommandInfo {
         crud: 'update';
         input: PatchDTO<T>;
         options?: UpdateOneOptions;
     }
+    type SearchResponse<T> = estypes.SearchResponse<T>;
 }
 /**
  * @class ElasticEntityService
@@ -203,40 +219,47 @@ export declare class ElasticEntityService<T extends object = any> extends Elasti
      * @param {ElasticEntityService.CreateCommand} command
      * @protected
      */
-    protected _create(command: ElasticEntityService.CreateCommand): Promise<elastic.CreateResponse>;
+    protected _create(command: ElasticEntityService.CreateCommand): Promise<estypes.CreateResponse>;
     /**
      * Returns the count of documents in the collection based on the provided options.
      *
      * @param {ElasticEntityService.CountCommand} command
      * @protected
      */
-    protected _count(command: ElasticEntityService.CountCommand): Promise<elastic.CountResponse>;
+    protected _count(command: ElasticEntityService.CountCommand): Promise<estypes.CountResponse>;
     /**
      * Deletes a document from the collection.
      *
      * @param {ElasticEntityService.DeleteCommand} command
      * @protected
      */
-    protected _delete(command: ElasticEntityService.DeleteCommand): Promise<elastic.DeleteByQueryResponse>;
+    protected _delete(command: ElasticEntityService.DeleteCommand): Promise<estypes.DeleteByQueryResponse>;
     /**
      * Deletes multiple documents from the collection that meet the specified filter criteria.
      *
      * @param {ElasticEntityService.DeleteManyCommand} command
      * @protected
      */
-    protected _deleteMany(command: ElasticEntityService.DeleteManyCommand): Promise<elastic.DeleteByQueryResponse>;
+    protected _deleteMany(command: ElasticEntityService.DeleteManyCommand): Promise<estypes.DeleteByQueryResponse>;
     /**
      * Returns search hits that match the query defined in the request
      *
      * @param {ElasticEntityService.FindManyCommand} command
      */
-    protected _findMany(command: ElasticEntityService.FindManyCommand): Promise<elastic.SearchResponse>;
+    protected _findMany(command: ElasticEntityService.FindManyCommand): Promise<ElasticEntityService.SearchResponse<PartialDTO<T>>>;
+    /**
+     * Executes a search operation on the Elasticsearch index using the provided search command.
+     *
+     * @param {ElasticEntityService.SearchCommand} command - The search command containing the request configuration and optional transport settings.
+     * @return {Promise<ElasticEntityService.SearchResponse>} A promise resolving to the search response from Elasticsearch.
+     */
+    protected _searchRaw(command: ElasticEntityService.SearchCommand): Promise<ElasticEntityService.SearchResponse<PartialDTO<T>>>;
     /**
      * Updates multiple documents in the collection based on the specified input and options.
      *
      * @param {ElasticEntityService.UpdateCommand<T>} command
      */
-    protected _updateMany(command: ElasticEntityService.UpdateCommand<T>): Promise<elastic.UpdateByQueryResponse>;
+    protected _updateMany(command: ElasticEntityService.UpdateCommand<T>): Promise<estypes.UpdateByQueryResponse>;
     /**
      * Generates an ID.
      *
@@ -253,7 +276,7 @@ export declare class ElasticEntityService<T extends object = any> extends Elasti
     /**
      * Retrieves the codec.
      */
-    protected _getOutputCodec(operation: string): IsObject.Validator<T>;
+    getOutputCodec(operation: string): IsObject.Validator<T>;
     protected _executeCommand(command: ElasticEntityService.CommandInfo, commandFn: () => any): Promise<any>;
     protected _beforeCreate(command: ElasticEntityService.CreateCommand): Promise<void>;
     protected _beforeUpdate(command: ElasticEntityService.UpdateCommand<T>): Promise<void>;