lemon-core 3.1.0 → 3.1.1

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

@@ -0,0 +1,273 @@
+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`
+ * - basic CRUD service for Elastic Search 6
+ */
+export declare class Elastic6Service<T extends Elastic6Item = any> {
+    static readonly DECOMPOSED_FIELD = "_decomposed";
+    static readonly QWERTY_FIELD = "_qwerty";
+    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
+     */
+    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<{
+        status: any;
+        index: string;
+        acknowledged: any;
+    }>;
+    /**
+     * destroy search index
+     */
+    destroyIndex(): Promise<{
+        status: any;
+        index: string;
+        acknowledged: any;
+    }>;
+    /**
+     * refresh search index - refresh index to make all items searchable
+     */
+    refreshIndex(): Promise<any>;
+    /**
+     * flush search index - force store changes into search index immediately
+     */
+    flushIndex(): Promise<any>;
+    /**
+     * describe `settings` and `mappings` of index.
+     */
+    describe(): Promise<{
+        settings: any;
+        mappings: any;
+    }>;
+    /**
+     * save single item
+     *
+     * @param id    id
+     * @param item  item to save
+     * @param type  document type (default: doc-type given at construction time)
+     */
+    saveItem(id: string, item: T, type?: string): Promise<T>;
+    /**
+     * push item for time-series data.
+     *
+     * @param item  item to push
+     */
+    pushItem(item: T, type?: string): Promise<T>;
+    /**
+     * read item with projections
+     *
+     * @param id        item-id
+     * @param views     projections
+     */
+    readItem(id: string, views?: string[] | object): Promise<T>;
+    /**
+     * delete item with projections
+     *
+     * @param id        item-id
+     */
+    deleteItem(id: string): Promise<T>;
+    /**
+     * update item
+     *
+     * @param id        item-id
+     * @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.
+     *
+     * @param docType       document type name
+     * @param idName        id-name
+     * @param shards        number of shards (default 4)
+     * @param replicas      number of replicas (default 1)
+     * @param timeSeries    flag of TIMESERIES (default false)
+     */
+    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 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: {
+    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
+ ** ****************************************************************************************************************/
+/**
+ * class: `DummyElastic6Service`
+ * - service in-memory dummy data
+ */
+export declare class DummyElastic6Service<T extends GeneralItem> extends Elastic6Service<T> {
+    constructor(dataFile: string, options: Elastic6Option);
+    private buffer;
+    load(data: T[]): void;
+    /**
+     * say hello()
+     */
+    hello: () => string;
+    readItem(id: string): Promise<T>;
+    saveItem(id: string, item: T): Promise<T>;
+    deleteItem(id: string, sort?: string | number): Promise<T>;
+    updateItem(id: string, updates: T, increments?: Incrementable): Promise<T>;
+}
+export {};