@elastic/elasticsearch 7.15.0 → 8.0.0-beta.1

package/{index.mjs → lib/api/typesWithBodyKey.js}

@@ -1,3 +1,4 @@
+"use strict";
 /*
  * Licensed to Elasticsearch B.V. under one or more contributor
  * license agreements. See the NOTICE file distributed with
@@ -16,14 +17,5 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-
-import mod from './index.js'
-
-export default mod
-export const Client = mod.Client
-export const Transport = mod.Transport
-export const ConnectionPool = mod.ConnectionPool
-export const Connection = mod.Connection
-export const Serializer = mod.Serializer
-export const events = mod.events
-export const errors = mod.errors
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=typesWithBodyKey.js.map

package/lib/api/typesWithBodyKey.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typesWithBodyKey.js","sourceRoot":"","sources":["../../src/api/typesWithBodyKey.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;GAiBG"}

package/lib/client.d.ts

@@ -0,0 +1,69 @@
+/// <reference types="node" />
+import { ConnectionOptions as TlsConnectionOptions } from 'tls';
+import { URL } from 'url';
+import { Transport, Serializer, Diagnostic, BaseConnectionPool } from '@elastic/transport';
+import { HttpAgentOptions, UndiciAgentOptions, agentFn, nodeFilterFn, nodeSelectorFn, generateRequestIdFn, BasicAuth, ApiKeyAuth, BearerAuth, Context } from '@elastic/transport/lib/types';
+import BaseConnection from '@elastic/transport/lib/connection/BaseConnection';
+import SniffingTransport from './sniffingTransport';
+import Helpers from './helpers';
+import API from './api';
+export interface NodeOptions {
+    url: URL;
+    id?: string;
+    agent?: HttpAgentOptions | UndiciAgentOptions;
+    ssl?: TlsConnectionOptions;
+    headers?: Record<string, any>;
+    roles?: {
+        master: boolean;
+        data: boolean;
+        ingest: boolean;
+        ml: boolean;
+    };
+}
+export interface ClientOptions {
+    node?: string | string[] | NodeOptions | NodeOptions[];
+    nodes?: string | string[] | NodeOptions | NodeOptions[];
+    Connection?: typeof BaseConnection;
+    ConnectionPool?: typeof BaseConnectionPool;
+    Transport?: typeof Transport;
+    Serializer?: typeof Serializer;
+    maxRetries?: number;
+    requestTimeout?: number;
+    pingTimeout?: number;
+    sniffInterval?: number | boolean;
+    sniffOnStart?: boolean;
+    sniffEndpoint?: string;
+    sniffOnConnectionFault?: boolean;
+    resurrectStrategy?: 'ping' | 'optimistic' | 'none';
+    compression?: boolean;
+    tls?: TlsConnectionOptions;
+    agent?: HttpAgentOptions | UndiciAgentOptions | agentFn | false;
+    nodeFilter?: nodeFilterFn;
+    nodeSelector?: nodeSelectorFn;
+    headers?: Record<string, any>;
+    opaqueIdPrefix?: string;
+    generateRequestId?: generateRequestIdFn;
+    name?: string | symbol;
+    auth?: BasicAuth | ApiKeyAuth | BearerAuth;
+    context?: Context;
+    proxy?: string | URL;
+    enableMetaHeader?: boolean;
+    cloud?: {
+        id: string;
+    };
+    disablePrototypePoisoningProtection?: boolean | 'proto' | 'constructor';
+    caFingerprint?: string;
+    maxResponseSize?: number;
+    maxCompressedResponseSize?: number;
+}
+export default class Client extends API {
+    diagnostic: Diagnostic;
+    name: string | symbol;
+    connectionPool: BaseConnectionPool;
+    transport: SniffingTransport;
+    serializer: Serializer;
+    helpers: Helpers;
+    constructor(opts: ClientOptions);
+    child(opts: ClientOptions): Client;
+    close(): Promise<void>;
+}

package/lib/client.js

@@ -0,0 +1,282 @@
+"use strict";
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License") you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const url_1 = require("url");
+const buffer_1 = (0, tslib_1.__importDefault)(require("buffer"));
+const transport_1 = require("@elastic/transport");
+const BaseConnection_1 = require("@elastic/transport/lib/connection/BaseConnection");
+const sniffingTransport_1 = (0, tslib_1.__importDefault)(require("./sniffingTransport"));
+const helpers_1 = (0, tslib_1.__importDefault)(require("./helpers"));
+const api_1 = (0, tslib_1.__importDefault)(require("./api"));
+const kChild = Symbol('elasticsearchjs-child');
+const kInitialOptions = Symbol('elasticsearchjs-initial-options');
+let clientVersion = require('../package.json').version; // eslint-disable-line
+/* istanbul ignore next */
+if (clientVersion.includes('-')) {
+    // clean prerelease
+    clientVersion = clientVersion.slice(0, clientVersion.indexOf('-')) + 'p';
+}
+let transportVersion = require('@elastic/transport/package.json').version; // eslint-disable-line
+/* istanbul ignore next */
+if (transportVersion.includes('-')) {
+    // clean prerelease
+    transportVersion = transportVersion.slice(0, transportVersion.indexOf('-')) + 'p';
+}
+const nodeVersion = process.versions.node;
+class Client extends api_1.default {
+    constructor(opts) {
+        var _a, _b, _c, _d;
+        super();
+        Object.defineProperty(this, "diagnostic", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "name", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "connectionPool", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "transport", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "serializer", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "helpers", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        // @ts-expect-error kChild symbol is for internal use only
+        if ((opts.cloud != null) && opts[kChild] === undefined) {
+            const { id } = opts.cloud;
+            // the cloud id is `cluster-name:base64encodedurl`
+            // the url is a string divided by two '$', the first is the cloud url
+            // the second the elasticsearch instance, the third the kibana instance
+            const cloudUrls = Buffer.from(id.split(':')[1], 'base64').toString().split('$');
+            opts.node = `https://${cloudUrls[1]}.${cloudUrls[0]}`;
+            // Cloud has better performances with compression enabled
+            // see https://github.com/elastic/elasticsearch-py/pull/704.
+            // So unless the user specifies otherwise, we enable compression.
+            if (opts.compression == null)
+                opts.compression = true;
+            if (opts.tls == null ||
+                (opts.tls != null && opts.tls.secureProtocol == null)) {
+                opts.tls = (_a = opts.tls) !== null && _a !== void 0 ? _a : {};
+                opts.tls.secureProtocol = 'TLSv1_2_method';
+            }
+        }
+        if (opts.node == null && opts.nodes == null) {
+            throw new transport_1.errors.ConfigurationError('Missing node(s) option');
+        }
+        // @ts-expect-error kChild symbol is for internal use only
+        if (opts[kChild] === undefined) {
+            const checkAuth = getAuth((_b = opts.node) !== null && _b !== void 0 ? _b : opts.nodes);
+            if ((checkAuth != null) && checkAuth.username !== '' && checkAuth.password !== '') {
+                opts.auth = Object.assign({}, opts.auth, { username: checkAuth.username, password: checkAuth.password });
+            }
+        }
+        const options = Object.assign({}, {
+            Connection: transport_1.UndiciConnection,
+            Transport: sniffingTransport_1.default,
+            Serializer: transport_1.Serializer,
+            ConnectionPool: (opts.cloud != null) ? transport_1.CloudConnectionPool : transport_1.WeightedConnectionPool,
+            maxRetries: 3,
+            requestTimeout: 30000,
+            pingTimeout: 3000,
+            sniffInterval: false,
+            sniffOnStart: false,
+            sniffEndpoint: '_nodes/_all/http',
+            sniffOnConnectionFault: false,
+            resurrectStrategy: 'ping',
+            compression: false,
+            tls: null,
+            caFingerprint: null,
+            agent: null,
+            headers: {},
+            nodeFilter: null,
+            generateRequestId: null,
+            name: 'elasticsearch-js',
+            auth: null,
+            opaqueIdPrefix: null,
+            context: null,
+            proxy: null,
+            enableMetaHeader: true,
+            maxResponseSize: null,
+            maxCompressedResponseSize: null
+        }, opts);
+        if (options.caFingerprint !== null && isHttpConnection((_c = opts.node) !== null && _c !== void 0 ? _c : opts.nodes)) {
+            throw new transport_1.errors.ConfigurationError('You can\'t configure the caFingerprint with a http connection');
+        }
+        if (options.maxResponseSize !== null && options.maxResponseSize > buffer_1.default.constants.MAX_STRING_LENGTH) {
+            throw new transport_1.errors.ConfigurationError(`The maxResponseSize cannot be bigger than ${buffer_1.default.constants.MAX_STRING_LENGTH}`);
+        }
+        if (options.maxCompressedResponseSize !== null && options.maxCompressedResponseSize > buffer_1.default.constants.MAX_LENGTH) {
+            throw new transport_1.errors.ConfigurationError(`The maxCompressedResponseSize cannot be bigger than ${buffer_1.default.constants.MAX_LENGTH}`);
+        }
+        if (options.enableMetaHeader) {
+            options.headers['x-elastic-client-meta'] = `es=${clientVersion},js=${nodeVersion},t=${transportVersion},hc=${nodeVersion}`;
+        }
+        this.name = options.name;
+        // @ts-expect-error kInitialOptions symbol is for internal use only
+        this[kInitialOptions] = options;
+        // @ts-expect-error kChild symbol is for internal use only
+        if (opts[kChild] !== undefined) {
+            // @ts-expect-error kChild symbol is for internal use only
+            this.serializer = opts[kChild].serializer;
+            // @ts-expect-error kChild symbol is for internal use only
+            this.connectionPool = opts[kChild].connectionPool;
+            // @ts-expect-error kChild symbol is for internal use only
+            this.diagnostic = opts[kChild].diagnostic;
+        }
+        else {
+            this.diagnostic = new transport_1.Diagnostic();
+            this.serializer = new options.Serializer();
+            this.connectionPool = new options.ConnectionPool({
+                pingTimeout: options.pingTimeout,
+                resurrectStrategy: options.resurrectStrategy,
+                tls: options.tls,
+                agent: options.agent,
+                proxy: options.proxy,
+                Connection: options.Connection,
+                auth: options.auth,
+                diagnostic: this.diagnostic,
+                caFingerprint: options.caFingerprint
+            });
+            this.connectionPool.addConnection((_d = options.node) !== null && _d !== void 0 ? _d : options.nodes);
+        }
+        this.transport = new options.Transport({
+            diagnostic: this.diagnostic,
+            connectionPool: this.connectionPool,
+            serializer: this.serializer,
+            maxRetries: options.maxRetries,
+            requestTimeout: options.requestTimeout,
+            sniffInterval: options.sniffInterval,
+            sniffOnStart: options.sniffOnStart,
+            sniffOnConnectionFault: options.sniffOnConnectionFault,
+            sniffEndpoint: options.sniffEndpoint,
+            compression: options.compression,
+            headers: options.headers,
+            nodeFilter: options.nodeFilter,
+            nodeSelector: options.nodeSelector,
+            generateRequestId: options.generateRequestId,
+            name: options.name,
+            opaqueIdPrefix: options.opaqueIdPrefix,
+            context: options.context,
+            productCheck: 'Elasticsearch',
+            maxResponseSize: options.maxResponseSize,
+            maxCompressedResponseSize: options.maxCompressedResponseSize
+        });
+        this.helpers = new helpers_1.default({
+            client: this,
+            metaHeader: options.enableMetaHeader
+                ? `es=${clientVersion},js=${nodeVersion},t=${transportVersion},hc=${nodeVersion}`
+                : null,
+            maxRetries: options.maxRetries
+        });
+    }
+    child(opts) {
+        // Merge the new options with the initial ones
+        // @ts-expect-error kChild symbol is for internal use only
+        const options = Object.assign({}, this[kInitialOptions], opts);
+        // Pass to the child client the parent instances that cannot be overriden
+        // @ts-expect-error kInitialOptions symbol is for internal use only
+        options[kChild] = {
+            connectionPool: this.connectionPool,
+            serializer: this.serializer,
+            diagnostic: this.diagnostic,
+            initialOptions: options
+        };
+        /* istanbul ignore else */
+        if (options.auth !== undefined) {
+            options.headers = (0, BaseConnection_1.prepareHeaders)(options.headers, options.auth);
+        }
+        return new Client(options);
+    }
+    async close() {
+        return await this.connectionPool.empty();
+    }
+}
+exports.default = Client;
+function isHttpConnection(node) {
+    if (Array.isArray(node)) {
+        return node.some((n) => (typeof n === 'string' ? new url_1.URL(n).protocol : n.url.protocol) === 'http:');
+    }
+    else {
+        if (node == null)
+            return false;
+        return (typeof node === 'string' ? new url_1.URL(node).protocol : node.url.protocol) === 'http:';
+    }
+}
+function getAuth(node) {
+    if (Array.isArray(node)) {
+        for (const url of node) {
+            const auth = getUsernameAndPassword(url);
+            if (auth != null && auth.username !== '' && auth.password !== '') {
+                return auth;
+            }
+        }
+        return null;
+    }
+    else {
+        const auth = getUsernameAndPassword(node);
+        if (auth != null && auth.username !== '' && auth.password !== '') {
+            return auth;
+        }
+        return null;
+    }
+    function getUsernameAndPassword(node) {
+        /* istanbul ignore else */
+        if (typeof node === 'string') {
+            const { username, password } = new url_1.URL(node);
+            return {
+                username: decodeURIComponent(username),
+                password: decodeURIComponent(password)
+            };
+        }
+        else if (node != null && node.url instanceof url_1.URL) {
+            return {
+                username: decodeURIComponent(node.url.username),
+                password: decodeURIComponent(node.url.password)
+            };
+        }
+        else {
+            return null;
+        }
+    }
+}
+//# sourceMappingURL=client.js.map

package/lib/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;GAiBG;;;AAGH,6BAAyB;AACzB,iEAA2B;AAC3B,kDAS2B;AAa3B,qFAAiG;AACjG,yFAAmD;AACnD,qEAA+B;AAC/B,6DAAuB;AAEvB,MAAM,MAAM,GAAG,MAAM,CAAC,uBAAuB,CAAC,CAAA;AAC9C,MAAM,eAAe,GAAG,MAAM,CAAC,iCAAiC,CAAC,CAAA;AACjE,IAAI,aAAa,GAAW,OAAO,CAAC,iBAAiB,CAAC,CAAC,OAAO,CAAA,CAAC,sBAAsB;AACrF,0BAA0B;AAC1B,IAAI,aAAa,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;IAC/B,mBAAmB;IACnB,aAAa,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC,EAAE,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,GAAG,CAAA;CACzE;AACD,IAAI,gBAAgB,GAAW,OAAO,CAAC,iCAAiC,CAAC,CAAC,OAAO,CAAA,CAAC,sBAAsB;AACxG,0BAA0B;AAC1B,IAAI,gBAAgB,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;IAClC,mBAAmB;IACnB,gBAAgB,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC,EAAE,gBAAgB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,GAAG,CAAA;CAClF;AACD,MAAM,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAA;AAqDzC,MAAqB,MAAO,SAAQ,aAAG;IAOrC,YAAa,IAAmB;;QAC9B,KAAK,EAAE,CAAA;QAPT;;;;;WAAsB;QACtB;;;;;WAAqB;QACrB;;;;;WAAkC;QAClC;;;;;WAA4B;QAC5B;;;;;WAAsB;QACtB;;;;;WAAgB;QAGd,0DAA0D;QAC1D,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,SAAS,EAAE;YACtD,MAAM,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,KAAK,CAAA;YACzB,kDAAkD;YAClD,qEAAqE;YACrE,uEAAuE;YACvE,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YAE/E,IAAI,CAAC,IAAI,GAAG,WAAW,SAAS,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,EAAE,CAAA;YAErD,yDAAyD;YACzD,4DAA4D;YAC5D,iEAAiE;YACjE,IAAI,IAAI,CAAC,WAAW,IAAI,IAAI;gBAAE,IAAI,CAAC,WAAW,GAAG,IAAI,CAAA;YACrD,IAAI,IAAI,CAAC,GAAG,IAAI,IAAI;gBACjB,CAAC,IAAI,CAAC,GAAG,IAAI,IAAI,IAAI,IAAI,CAAC,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,EAAE;gBACxD,IAAI,CAAC,GAAG,GAAG,MAAA,IAAI,CAAC,GAAG,mCAAI,EAAE,CAAA;gBACzB,IAAI,CAAC,GAAG,CAAC,cAAc,GAAG,gBAAgB,CAAA;aAC3C;SACF;QAED,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,EAAE;YAC3C,MAAM,IAAI,kBAAM,CAAC,kBAAkB,CAAC,wBAAwB,CAAC,CAAA;SAC9D;QAED,0DAA0D;QAC1D,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,SAAS,EAAE;YAC9B,MAAM,SAAS,GAAG,OAAO,CAAC,MAAA,IAAI,CAAC,IAAI,mCAAI,IAAI,CAAC,KAAK,CAAC,CAAA;YAClD,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,IAAI,SAAS,CAAC,QAAQ,KAAK,EAAE,IAAI,SAAS,CAAC,QAAQ,KAAK,EAAE,EAAE;gBACjF,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,SAAS,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAA;aACzG;SACF;QAED,MAAM,OAAO,GAA4B,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE;YACzD,UAAU,EAAE,4BAAgB;YAC5B,SAAS,EAAE,2BAAiB;YAC5B,UAAU,EAAV,sBAAU;YACV,cAAc,EAAE,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,+BAAmB,CAAC,CAAC,CAAC,kCAAsB;YACnF,UAAU,EAAE,CAAC;YACb,cAAc,EAAE,KAAK;YACrB,WAAW,EAAE,IAAI;YACjB,aAAa,EAAE,KAAK;YACpB,YAAY,EAAE,KAAK;YACnB,aAAa,EAAE,kBAAkB;YACjC,sBAAsB,EAAE,KAAK;YAC7B,iBAAiB,EAAE,MAAM;YACzB,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,IAAI;YACT,aAAa,EAAE,IAAI;YACnB,KAAK,EAAE,IAAI;YACX,OAAO,EAAE,EAAE;YACX,UAAU,EAAE,IAAI;YAChB,iBAAiB,EAAE,IAAI;YACvB,IAAI,EAAE,kBAAkB;YACxB,IAAI,EAAE,IAAI;YACV,cAAc,EAAE,IAAI;YACpB,OAAO,EAAE,IAAI;YACb,KAAK,EAAE,IAAI;YACX,gBAAgB,EAAE,IAAI;YACtB,eAAe,EAAE,IAAI;YACrB,yBAAyB,EAAE,IAAI;SAChC,EAAE,IAAI,CAAC,CAAA;QAER,IAAI,OAAO,CAAC,aAAa,KAAK,IAAI,IAAI,gBAAgB,CAAC,MAAA,IAAI,CAAC,IAAI,mCAAI,IAAI,CAAC,KAAK,CAAC,EAAE;YAC/E,MAAM,IAAI,kBAAM,CAAC,kBAAkB,CAAC,+DAA+D,CAAC,CAAA;SACrG;QAED,IAAI,OAAO,CAAC,eAAe,KAAK,IAAI,IAAI,OAAO,CAAC,eAAe,GAAG,gBAAM,CAAC,SAAS,CAAC,iBAAiB,EAAE;YACpG,MAAM,IAAI,kBAAM,CAAC,kBAAkB,CAAC,6CAA6C,gBAAM,CAAC,SAAS,CAAC,iBAAiB,EAAE,CAAC,CAAA;SACvH;QAED,IAAI,OAAO,CAAC,yBAAyB,KAAK,IAAI,IAAI,OAAO,CAAC,yBAAyB,GAAG,gBAAM,CAAC,SAAS,CAAC,UAAU,EAAE;YACjH,MAAM,IAAI,kBAAM,CAAC,kBAAkB,CAAC,uDAAuD,gBAAM,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC,CAAA;SAC1H;QAED,IAAI,OAAO,CAAC,gBAAgB,EAAE;YAC5B,OAAO,CAAC,OAAO,CAAC,uBAAuB,CAAC,GAAG,MAAM,aAAa,OAAO,WAAW,MAAM,gBAAgB,OAAO,WAAW,EAAE,CAAA;SAC3H;QAED,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAA;QACxB,mEAAmE;QACnE,IAAI,CAAC,eAAe,CAAC,GAAG,OAAO,CAAA;QAE/B,0DAA0D;QAC1D,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,SAAS,EAAE;YAC9B,0DAA0D;YAC1D,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,UAAU,CAAA;YACzC,0DAA0D;YAC1D,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,cAAc,CAAA;YACjD,0DAA0D;YAC1D,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,UAAU,CAAA;SAC1C;aAAM;YACL,IAAI,CAAC,UAAU,GAAG,IAAI,sBAAU,EAAE,CAAA;YAClC,IAAI,CAAC,UAAU,GAAG,IAAI,OAAO,CAAC,UAAU,EAAE,CAAA;YAC1C,IAAI,CAAC,cAAc,GAAG,IAAI,OAAO,CAAC,cAAc,CAAC;gBAC/C,WAAW,EAAE,OAAO,CAAC,WAAW;gBAChC,iBAAiB,EAAE,OAAO,CAAC,iBAAiB;gBAC5C,GAAG,EAAE,OAAO,CAAC,GAAG;gBAChB,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,UAAU,EAAE,OAAO,CAAC,UAAU;gBAC9B,IAAI,EAAE,OAAO,CAAC,IAAI;gBAClB,UAAU,EAAE,IAAI,CAAC,UAAU;gBAC3B,aAAa,EAAE,OAAO,CAAC,aAAa;aACrC,CAAC,CAAA;YACF,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,MAAA,OAAO,CAAC,IAAI,mCAAI,OAAO,CAAC,KAAK,CAAC,CAAA;SACjE;QAED,IAAI,CAAC,SAAS,GAAG,IAAI,OAAO,CAAC,SAAS,CAAC;YACrC,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,cAAc,EAAE,OAAO,CAAC,cAAc;YACtC,aAAa,EAAE,OAAO,CAAC,aAAa;YACpC,YAAY,EAAE,OAAO,CAAC,YAAY;YAClC,sBAAsB,EAAE,OAAO,CAAC,sBAAsB;YACtD,aAAa,EAAE,OAAO,CAAC,aAAa;YACpC,WAAW,EAAE,OAAO,CAAC,WAAW;YAChC,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,YAAY,EAAE,OAAO,CAAC,YAAY;YAClC,iBAAiB,EAAE,OAAO,CAAC,iBAAiB;YAC5C,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,cAAc,EAAE,OAAO,CAAC,cAAc;YACtC,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,YAAY,EAAE,eAAe;YAC7B,eAAe,EAAE,OAAO,CAAC,eAAe;YACxC,yBAAyB,EAAE,OAAO,CAAC,yBAAyB;SAC7D,CAAC,CAAA;QAEF,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAO,CAAC;YACzB,MAAM,EAAE,IAAI;YACZ,UAAU,EAAE,OAAO,CAAC,gBAAgB;gBAClC,CAAC,CAAC,MAAM,aAAa,OAAO,WAAW,MAAM,gBAAgB,OAAO,WAAW,EAAE;gBACjF,CAAC,CAAC,IAAI;YACR,UAAU,EAAE,OAAO,CAAC,UAAU;SAC/B,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAE,IAAmB;QACxB,8CAA8C;QAC9C,0DAA0D;QAC1D,MAAM,OAAO,GAAkB,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,eAAe,CAAC,EAAE,IAAI,CAAC,CAAA;QAC7E,yEAAyE;QACzE,mEAAmE;QACnE,OAAO,CAAC,MAAM,CAAC,GAAG;YAChB,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,cAAc,EAAE,OAAO;SACxB,CAAA;QAED,0BAA0B;QAC1B,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE;YAC9B,OAAO,CAAC,OAAO,GAAG,IAAA,+BAAc,EAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,CAAA;SAChE;QAED,OAAO,IAAI,MAAM,CAAC,OAAO,CAAC,CAAA;IAC5B,CAAC;IAED,KAAK,CAAC,KAAK;QACT,OAAO,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAA;IAC1C,CAAC;CACF;AA7KD,yBA6KC;AAED,SAAS,gBAAgB,CAAE,IAAsD;IAC/E,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QACvB,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,SAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,OAAO,CAAC,CAAA;KACpG;SAAM;QACL,IAAI,IAAI,IAAI,IAAI;YAAE,OAAO,KAAK,CAAA;QAC9B,OAAO,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,SAAG,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,OAAO,CAAA;KAC3F;AACH,CAAC;AAED,SAAS,OAAO,CAAE,IAAsD;IACtE,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QACvB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;YACtB,MAAM,IAAI,GAAG,sBAAsB,CAAC,GAAG,CAAC,CAAA;YACxC,IAAI,IAAI,IAAI,IAAI,IAAI,IAAI,CAAC,QAAQ,KAAK,EAAE,IAAI,IAAI,CAAC,QAAQ,KAAK,EAAE,EAAE;gBAChE,OAAO,IAAI,CAAA;aACZ;SACF;QAED,OAAO,IAAI,CAAA;KACZ;SAAM;QACL,MAAM,IAAI,GAAG,sBAAsB,CAAC,IAAI,CAAC,CAAA;QACzC,IAAI,IAAI,IAAI,IAAI,IAAI,IAAI,CAAC,QAAQ,KAAK,EAAE,IAAI,IAAI,CAAC,QAAQ,KAAK,EAAE,EAAE;YAChE,OAAO,IAAI,CAAA;SACZ;QAED,OAAO,IAAI,CAAA;KACZ;IAED,SAAS,sBAAsB,CAAE,IAA2B;QAC1D,0BAA0B;QAC1B,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;YAC5B,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,IAAI,SAAG,CAAC,IAAI,CAAC,CAAA;YAC5C,OAAO;gBACL,QAAQ,EAAE,kBAAkB,CAAC,QAAQ,CAAC;gBACtC,QAAQ,EAAE,kBAAkB,CAAC,QAAQ,CAAC;aACvC,CAAA;SACF;aAAM,IAAI,IAAI,IAAI,IAAI,IAAI,IAAI,CAAC,GAAG,YAAY,SAAG,EAAE;YAClD,OAAO;gBACL,QAAQ,EAAE,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC;gBAC/C,QAAQ,EAAE,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC;aAChD,CAAA;SACF;aAAM;YACL,OAAO,IAAI,CAAA;SACZ;IACH,CAAC;AACH,CAAC"}

package/lib/helpers.d.ts

@@ -0,0 +1,148 @@
+/// <reference types="node" />
+import { Readable } from 'stream';
+import { TransportResult, TransportRequestOptions } from '@elastic/transport';
+import Client from './client';
+import * as T from './api/types';
+export interface HelpersOptions {
+    client: Client;
+    metaHeader: string | null;
+    maxRetries: number;
+}
+export interface ScrollSearchOptions extends TransportRequestOptions {
+    wait?: number;
+}
+export interface ScrollSearchResponse<TDocument> extends TransportResult<T.SearchResponse<TDocument>, unknown> {
+    clear: () => Promise<void>;
+    documents: TDocument[];
+}
+export interface MsearchHelperOptions extends T.MsearchRequest {
+    operations?: number;
+    flushInterval?: number;
+    concurrency?: number;
+    retries?: number;
+    wait?: number;
+}
+export interface MsearchHelper extends Promise<void> {
+    stop: (error?: Error | null) => void;
+    search: <TDocument = unknown>(header: T.MsearchHeader, body: T.MsearchBody) => Promise<MsearchHelperResponse<TDocument>>;
+}
+export interface MsearchHelperResponse<TDocument> {
+    body: T.SearchResponse<TDocument>;
+    documents: TDocument[];
+    status: number;
+    responses: T.MsearchResponse;
+}
+export interface BulkStats {
+    total: number;
+    failed: number;
+    retry: number;
+    successful: number;
+    noop: number;
+    time: number;
+    bytes: number;
+    aborted: boolean;
+}
+interface IndexAction {
+    index: T.BulkIndexOperation;
+}
+interface CreateAction {
+    create: T.BulkCreateOperation;
+}
+interface UpdateActionOperation {
+    update: T.BulkUpdateOperation;
+}
+interface DeleteAction {
+    delete: T.BulkDeleteOperation;
+}
+declare type UpdateAction = [UpdateActionOperation, Record<string, any>];
+declare type Action = IndexAction | CreateAction | UpdateAction | DeleteAction;
+export interface OnDropDocument<TDocument = unknown> {
+    status: number;
+    operation: Action;
+    error: T.ErrorCause | null;
+    document: TDocument;
+    retried: boolean;
+}
+export interface BulkHelperOptions<TDocument = unknown> extends T.BulkRequest {
+    datasource: TDocument[] | Buffer | Readable | AsyncIterator<TDocument>;
+    onDocument: (doc: TDocument) => Action;
+    flushBytes?: number;
+    flushInterval?: number;
+    concurrency?: number;
+    retries?: number;
+    wait?: number;
+    onDrop?: (doc: OnDropDocument<TDocument>) => void;
+    refreshOnCompletion?: boolean | string;
+}
+export interface BulkHelper<T> extends Promise<BulkStats> {
+    abort: () => BulkHelper<T>;
+    readonly stats: BulkStats;
+}
+declare const kClient: unique symbol;
+declare const kMetaHeader: unique symbol;
+declare const kMaxRetries: unique symbol;
+export default class Helpers {
+    [kClient]: Client;
+    [kMetaHeader]: string | null;
+    [kMaxRetries]: number;
+    constructor(opts: HelpersOptions);
+    /**
+     * Runs a search operation. The only difference between client.search and this utility,
+     * is that we are only returning the hits to the user and not the full ES response.
+     * This helper automatically adds `filter_path=hits.hits._source` to the querystring,
+     * as it will only need the documents source.
+     * @param {object} params - The Elasticsearch's search parameters.
+     * @param {object} options - The client optional configuration for this request.
+     * @return {array} The documents that matched the request.
+     */
+    search<TDocument = unknown>(params: T.SearchRequest, options?: TransportRequestOptions): Promise<TDocument[]>;
+    /**
+     * Runs a scroll search operation. This function returns an async iterator, allowing
+     * the user to use a for await loop to get all the results of a given search.
+     * ```js
+     * for await (const result of client.helpers.scrollSearch({ params })) {
+     *   console.log(result)
+     * }
+     * ```
+     * Each result represents the entire body of a single scroll search request,
+     * if you just need to scroll the results, use scrollDocuments.
+     * This function handles automatically retries on 429 status code.
+     * @param {object} params - The Elasticsearch's search parameters.
+     * @param {object} options - The client optional configuration for this request.
+     * @return {iterator} the async iterator
+     */
+    scrollSearch<TDocument = unknown>(params: T.SearchRequest, options?: ScrollSearchOptions): AsyncIterable<ScrollSearchResponse<TDocument>>;
+    /**
+     * Runs a scroll search operation. This function returns an async iterator, allowing
+     * the user to use a for await loop to get all the documents of a given search.
+     * ```js
+     * for await (const document of client.helpers.scrollSearch({ params })) {
+     *   console.log(document)
+     * }
+     * ```
+     * Each document is what you will find by running a scrollSearch and iterating on the hits array.
+     * This helper automatically adds `filter_path=hits.hits._source` to the querystring,
+     * as it will only need the documents source.
+     * @param {object} params - The Elasticsearch's search parameters.
+     * @param {object} options - The client optional configuration for this request.
+     * @return {iterator} the async iterator
+     */
+    scrollDocuments<TDocument = unknown>(params: T.SearchRequest, options?: ScrollSearchOptions): AsyncIterable<TDocument>;
+    /**
+     * Creates a msearch helper instance. Once you configure it, you can use the provided
+     * `search` method to add new searches in the queue.
+     * @param {object} options - The configuration of the msearch operations.
+     * @param {object} reqOptions - The client optional configuration for this request.
+     * @return {object} The possible operations to run.
+     */
+    msearch(options?: MsearchHelperOptions, reqOptions?: TransportRequestOptions): MsearchHelper;
+    /**
+     * Creates a bulk helper instance. Once you configure it, you can pick which operation
+     * to execute with the given dataset, index, create, update, and delete.
+     * @param {object} options - The configuration of the bulk operation.
+     * @param {object} reqOptions - The client optional configuration for this request.
+     * @return {object} The possible operations to run with the datasource.
+     */
+    bulk<TDocument = unknown>(options: BulkHelperOptions, reqOptions?: TransportRequestOptions): BulkHelper<TDocument>;
+}
+export {};