lemon-core 2.2.17 → 3.0.0

package/dist/cores/elastic6-service.d.ts

@@ -1,22 +1,49 @@
-/** ****************************************************************************************************************
- *  Service Main
- ** ****************************************************************************************************************/
-import { GeneralItem, Incrementable } from './core-types';
-import elasticsearch from 'elasticsearch';
+import { GeneralItem, Incrementable, SearchBody } from './core-types';
+import elasticsearch from '@elastic/elasticsearch';
+export declare type SearchType = 'query_then_fetch' | 'dfs_query_then_fetch';
+export declare type SearchResponse = any;
 /**
  * options for construction.
  */
 export interface Elastic6Option {
+    /**
+     * endpoint url of ES6
+     */
     endpoint: string;
+    /**
+     * index-name
+     */
     indexName: string;
+    /**
+     * document type (default as `_doc` in ES6)
+     * - it must be `_doc` since ES6.x
+     */
     docType?: string;
+    /**
+     * id-name (optional if time-seriese)
+     */
     idName?: string;
+    /**
+     * is TIMESERIES data?
+     */
     timeSeries?: boolean;
+    /**
+     * (optional) version of engine.
+     * - (default) 6.8
+     */
+    version?: string;
+    /**
+     * fields to provide autocomplete(Search-as-You-Type) feature
+     */
     autocompleteFields?: string[];
 }
+/**
+ * common type of item
+ */
 export interface Elastic6Item extends GeneralItem {
     _id?: string;
     _version?: number;
+    _score?: number;
 }
 /**
  * class: `Elastic6Service`
@@ -25,14 +52,15 @@ export interface Elastic6Item extends GeneralItem {
 export declare class Elastic6Service<T extends Elastic6Item = any> {
     static readonly DECOMPOSED_FIELD = "_decomposed";
     static readonly QWERTY_FIELD = "_qwerty";
-    protected options: Elastic6Option;
-    constructor(options: Elastic6Option);
-    /**
-     * say hello of identity.
-     */
-    hello: () => string;
+    protected _options: Elastic6Option;
+    readonly _client: elasticsearch.Client;
     /**
      * simple instance maker.
+     *
+     * ```js
+     * const { client } = Elastic6Service.instance(endpoint);
+     * ```
+     *
      * @param endpoint  service-url
      * @param version   Elasticsearch version (default: '6.8')
      * @see https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/16.x/configuration.html
@@ -40,16 +68,74 @@ export declare class Elastic6Service<T extends Elastic6Item = any> {
     static instance(endpoint: string): {
         client: elasticsearch.Client;
     };
+    /**
+     * default constuctor w/ options.
+     * @param options { endpoint, indexName } is required.
+     */
+    constructor(options: Elastic6Option);
+    /**
+     * say hello of identity.
+     */
+    hello: () => string;
+    /**
+     * get the client instance.
+     */
+    get client(): elasticsearch.Client;
+    /**
+     * get the current options.
+     */
+    get options(): Elastic6Option;
+    get version(): number;
+    /**
+     * list of index
+     */
+    listIndices(): Promise<{
+        list: {
+            pri: number;
+            rep: number;
+            docsCount: number;
+            docsDeleted: number;
+            health: string;
+            index: string;
+            status: string;
+            uuid: string;
+            priStoreSize: string;
+            storeSize: string;
+        }[];
+    }>;
+    /**
+     * find the index by name
+     */
+    findIndex(indexName?: string): Promise<{
+        pri: number;
+        rep: number;
+        docsCount: number;
+        docsDeleted: number;
+        health: string;
+        index: string;
+        status: string;
+        uuid: string;
+        priStoreSize: string;
+        storeSize: string;
+    }>;
     /**
      * create index by name
      *
      * @param settings      creating settings
      */
-    createIndex(settings?: any): Promise<any>;
+    createIndex(settings?: any): Promise<{
+        status: any;
+        index: string;
+        acknowledged: any;
+    }>;
     /**
      * destroy search index
      */
-    destroyIndex(): Promise<any>;
+    destroyIndex(): Promise<{
+        status: any;
+        index: string;
+        acknowledged: any;
+    }>;
     /**
      * refresh search index - refresh index to make all items searchable
      */
@@ -99,6 +185,19 @@ export declare class Elastic6Service<T extends Elastic6Item = any> {
      * @param item      item to update
      */
     updateItem(id: string, item: T, increments?: Incrementable): Promise<T>;
+    /**
+     * run search and get the raw response.
+     */
+    searchRaw(body: SearchBody, searchType?: SearchType): Promise<SearchResponse>;
+    /**
+     * run search, and get the formatmted response.
+     */
+    search(body: SearchBody, searchType?: SearchType): Promise<{
+        total: any;
+        list: any;
+        last: any;
+        aggregations: any;
+    }>;
     /**
      * prepare default setting
      * - migrated from engine-v2.
@@ -109,60 +208,47 @@ export declare class Elastic6Service<T extends Elastic6Item = any> {
      * @param replicas      number of replicas (default 1)
      * @param timeSeries    flag of TIMESERIES (default false)
      */
-    static prepareSettings(docType: string, idName: string, timeSeries?: boolean, shards?: number, replicas?: number): any;
+    static prepareSettings(params: {
+        docType: string;
+        idName: string;
+        version?: string;
+        timeSeries?: boolean;
+        shards?: number;
+        replicas?: number;
+    }): any;
     /**
      * generate autocomplete fields into the item body to be indexed
      * @param body  item body to be saved into ES6 index
      * @private
      */
-    private prepareAutocompleteFields;
+    private popullateAutocompleteFields;
+}
+interface ErrorReasonDetail {
+    status: number;
+    type: string;
+    reason?: string;
+    cause?: any;
+}
+interface ErrorReason {
+    status: number;
+    message: string;
+    reason: ErrorReasonDetail;
 }
 /**
  * error samples
  */
 export declare const $ERROR: {
-    handler: (name: string, cb?: (e: Error) => any) => (e: any) => any;
-    index_not_found_exception: {
-        msg: string;
-        path: string;
-        query: {};
-        statusCode: number;
-        response: string;
-    };
-    resource_already_exists_exception: {
-        msg: string;
-        path: string;
-        query: {};
-        body: string;
-        statusCode: number;
-        response: string;
-    };
-    not_found: {
-        msg: string;
-        path: string;
-        query: {};
-        statusCode: number;
-        response: string;
-    };
-    action_request_validation_exception: {
-        msg: string;
-        path: string;
-        query: {};
-        statusCode: number;
-        response: string;
-    };
-    remote_transport_exception: {
-        msg: string;
-        path: string;
-        query: {};
-        body: string;
-        statusCode: number;
-        response: string;
-    };
-    version_conflict_engine_exception: {
-        '!': string;
-        msg: string;
-    };
+    asJson: (e: any) => any;
+    throwAsJson: (e: any) => never;
+    parseMeta: <T extends {
+        [key: string]: any;
+        type?: string;
+        value?: any;
+        error?: string;
+        list?: any[];
+    }>(meta: any) => T;
+    asError: (e: any) => ErrorReason;
+    handler: (name: string, cb?: (e: Error, E?: ErrorReason) => any) => (e: any) => any;
 };
 /** ****************************************************************************************************************
  *  Dummy Elastic6 Service
@@ -184,3 +270,4 @@ export declare class DummyElastic6Service<T extends GeneralItem> extends Elastic
     deleteItem(id: string, sort?: string | number): Promise<T>;
     updateItem(id: string, updates: T, increments?: Incrementable): Promise<T>;
 }
+export {};