@terascope/elasticsearch-api 4.12.2 → 4.13.0

package/dist/src/index.d.ts

@@ -0,0 +1,70 @@
+import { DataEntity, Logger } from '@terascope/utils';
+import { Client as OpenClient } from '@terascope/opensearch-client';
+import { ClientParams, ClientResponse } from '@terascope/types';
+export interface Config {
+    index?: string;
+    full_response?: boolean;
+    connection?: string;
+    _dead_letter_action?: string;
+}
+/**
+     * This is used for improved bulk sending function
+    */
+export interface BulkRecord {
+    action: AnyBulkAction;
+    data?: Record<string, any> | DataEntity;
+}
+/**
+     * This is used for improved bulk sending function
+    */
+export interface AnyBulkAction {
+    update?: Partial<BulkActionMetadata>;
+    index?: Partial<BulkActionMetadata>;
+    create?: Partial<BulkActionMetadata>;
+    delete?: Partial<BulkActionMetadata>;
+}
+/**
+     * This is used for improved bulk sending function
+    */
+export interface BulkActionMetadata {
+    _index: string;
+    _type: string;
+    _id: string | number;
+    retry_on_conflict?: number;
+}
+export default function elasticsearchApi(client: OpenClient, logger: Logger, _opConfig?: Config | undefined): {
+    search: (query: ClientParams.SearchParams) => Promise<ClientResponse.SearchResponse | any[]>;
+    count: (query: ClientParams.CountParams) => Promise<number>;
+    get: (query: ClientParams.GetParams, fullResponse?: boolean) => Promise<any>;
+    mget: (query: ClientParams.MGetParams, fullResponse?: boolean) => Promise<any>;
+    index: (query: ClientParams.IndexParams) => Promise<unknown>;
+    indexWithId: (query: ClientParams.IndexParams) => Promise<unknown>;
+    isAvailable: (index: string, recordType?: string) => Promise<unknown>;
+    create: (query: ClientParams.CreateParams) => Promise<unknown>;
+    update: (query: ClientParams.UpdateParams) => Promise<any>;
+    remove: (query: ClientParams.DeleteParams) => Promise<ClientResponse.DeleteResponse>;
+    version: () => Promise<boolean | void>;
+    putTemplate: (template: Record<string, any>, name: string) => Promise<any>;
+    bulkSend: (data: BulkRecord[] | Record<string, any>[]) => Promise<number>;
+    nodeInfo: () => Promise<ClientResponse.NodesInfoResponse>;
+    nodeStats: () => Promise<ClientResponse.NodesStatsResponse>;
+    buildQuery: (opConfig: Record<string, any>, msg: Record<string, any>) => ClientParams.SearchParams;
+    indexExists: (query: ClientParams.IndicesExistsParams) => Promise<boolean>;
+    indexCreate: (query: ClientParams.IndicesCreateParams) => Promise<any>;
+    indexRefresh: (query: ClientParams.IndicesRefreshParams) => Promise<any>;
+    indexRecovery: (query: ClientParams.IndicesRefreshParams) => Promise<any>;
+    indexSetup: (clusterName: string, newIndex: string, migrantIndexName: string, mapping: Record<string, any>, recordType: string, clientName: string, _time?: number) => Promise<boolean>;
+    verifyClient: () => boolean;
+    validateGeoParameters: (opConfig: Record<string, any>) => void;
+    getClientMetadata: () => import("@terascope/types").ClientMetadata;
+    isElasticsearch6: () => boolean;
+    isElasticsearch8: () => boolean;
+    index_exists: (query: ClientParams.IndicesExistsParams) => Promise<boolean>;
+    index_create: (query: ClientParams.IndicesCreateParams) => Promise<any>;
+    index_refresh: (query: ClientParams.IndicesRefreshParams) => Promise<any>;
+    index_recovery: (query: ClientParams.IndicesRefreshParams) => Promise<any>;
+    getESVersion: () => number;
+    isErrorRetryable: (err: Error) => boolean;
+};
+export type Client = ReturnType<typeof elasticsearchApi>;
+//# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAKsB,UAAU,EACH,MAAM,EACzC,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,MAAM,IAAI,UAAU,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,EACsC,YAAY,EACrD,cAAc,EACjB,MAAM,kBAAkB,CAAC;AAQ1B,MAAM,WAAW,MAAM;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED;;MAEM;AACN,MAAM,WAAW,UAAU;IACvB,MAAM,EAAE,aAAa,CAAC;IAEtB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,UAAU,CAAC;CAC3C;AAED;;MAEM;AACN,MAAM,WAAW,aAAa;IAC1B,MAAM,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACrC,KAAK,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACpC,MAAM,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACrC,MAAM,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC;CACxC;AAED;;MAEM;AACN,MAAM,WAAW,kBAAkB;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;IACrB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAID,MAAM,CAAC,OAAO,UAAU,gBAAgB,CACpC,MAAM,EAAE,UAAU,EAClB,MAAM,EAAE,MAAM,EACd,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS;oBAwDnB,YAAY,CAAC,YAAY,KACjC,OAAO,CAAC,cAAc,CAAC,cAAc,GAAG,GAAG,EAAE,CAAC;mBArCrB,YAAY,CAAC,WAAW;iBAgHxB,YAAY,CAAC,SAAS,6BAAyB,OAAO,CAAC,GAAG,CAAC;kBAT5D,YAAY,CAAC,UAAU;mBAkBpB,YAAY,CAAC,WAAW;yBAIpB,YAAY,CAAC,WAAW;yBAmuBxB,MAAM,eAAe,MAAM;oBA/tBhC,YAAY,CAAC,YAAY;oBAIzB,YAAY,CAAC,YAAY,KAAG,OAAO,CAAC,GAAG,CAAC;oBAQ1D,YAAY,CAAC,YAAY,KACjC,OAAO,CAAC,cAAc,CAAC,cAAc,CAAC;;4BAwGJ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,QAAQ,MAAM,KAAG,OAAO,CAAC,GAAG,CAAC;qBAiKvD,UAAU,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE;;;2BAgOpD,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,OACxB,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KACzB,YAAY,CAAC,YAAY;yBAteM,YAAY,CAAC,mBAAmB,KAAG,OAAO,CAAC,OAAO,CAAC;yBAInD,YAAY,CAAC,mBAAmB,KAAG,OAAO,CAAC,GAAG,CAAC;0BAK9C,YAAY,CAAC,oBAAoB,KAAG,OAAO,CAAC,GAAG,CAAC;2BAI/C,YAAY,CAAC,oBAAoB,KAAG,OAAO,CAAC,GAAG,CAAC;8BAyiCnE,MAAM,YACT,MAAM,oBACE,MAAM,WACf,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,cAChB,MAAM,cACN,MAAM,UACV,MAAM,KACf,OAAO,CAAC,OAAO,CAAC;;sCAlyBsB,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;;;;0BA3R1B,YAAY,CAAC,mBAAmB,KAAG,OAAO,CAAC,OAAO,CAAC;0BAInD,YAAY,CAAC,mBAAmB,KAAG,OAAO,CAAC,GAAG,CAAC;2BAK9C,YAAY,CAAC,oBAAoB,KAAG,OAAO,CAAC,GAAG,CAAC;4BAI/C,YAAY,CAAC,oBAAoB,KAAG,OAAO,CAAC,GAAG,CAAC;;4BAqpBrD,KAAK;EA4gBvC;AAED,MAAM,MAAM,MAAM,GAAG,UAAU,CAAC,OAAO,gBAAgB,CAAC,CAAC"}