@terascope/opensearch-client 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,17 @@
+<!-- THIS FILE IS AUTO-GENERATED, EDIT docs/packages/opensearch-client/overview.md -->
+
+# Opensearch Client
+
+> A Node.js facade client for opensearch & elasticsearch.
+
+This is a package within the [Teraslice](https://github.com/terascope/teraslice) monorepo. See our [documentation](https://terascope.github.io/teraslice/docs/packages/opensearch-client/overview) for more information or the [issues](https://github.com/terascope/teraslice/issues?q=is%3Aopen+is%3Aissue+label%3Apkg%2Fopensearch-client) associated with this package
+
+## Contributing
+
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+
+Please make sure to update tests as appropriate.
+
+## License
+
+[MIT](./LICENSE) licensed.

package/dist/src/client/client.d.ts

@@ -0,0 +1,233 @@
+import { ClientParams, ClientResponse, ClientMetadata } from '@terascope/types';
+export declare class Client {
+    private client;
+    private distributionMeta;
+    constructor(client: any, distributionMeta: ClientMetadata);
+    get __meta(): ClientMetadata;
+    bulk(params: ClientParams.BulkParams): Promise<ClientResponse.BulkResponse>;
+    /**
+     * creates a new record, can throw if record already exists
+     * @param CountParams
+    */
+    create(params: ClientParams.CreateParams): Promise<ClientResponse.CreateResponse>;
+    /**
+     * indexes a new record
+     * @param CountParams
+    */
+    index(params: ClientParams.IndexParams): Promise<ClientResponse.IndexResponse>;
+    /**
+     * updates a record, or can upsert a record
+     * @param CountParams
+    */
+    update(params: ClientParams.UpdateParams): Promise<ClientResponse.UpdateResponse>;
+    /**
+     * Gets the number of matches for a search query or
+     * if no query provided the count for docs in an index
+     * @param CountParams
+    */
+    count(params: ClientParams.CountParams): Promise<ClientResponse.CountResponse>;
+    get cluster(): {
+        getSettings(params?: ClientParams.ClusterGetSettingsParams): Promise<ClientResponse.ClusterGetSettingsResponse>;
+        health(params?: ClientParams.ClusterHealthParams): Promise<ClientResponse.ClusterHealthResponse>;
+    };
+    get cat(): {
+        indices(params?: ClientParams.CatIndicesParams): Promise<ClientResponse.CatIndicesResponse>;
+    };
+    get nodes(): {
+        stats(params?: ClientParams.NodesStatsParams): Promise<ClientResponse.NodesStatsResponse>;
+        info(params?: ClientParams.NodesInfoParams): Promise<ClientResponse.NodesInfoResponse>;
+    };
+    /**
+     * Deletes a specific record, requires an index and id.
+     * @param RequestParams.delete
+    */
+    delete(params: ClientParams.DeleteParams): Promise<ClientResponse.DeleteResponse>;
+    /**
+     * Deletes documents that match the specified query.
+     * @param RequestParams.DeleteByQuery
+     * @returns count or Elasticsearch task_id
+    */
+    deleteByQuery(params: ClientParams.DeleteByQueryParams): Promise<ClientResponse.DeleteByQueryResponse>;
+    /**
+     * Check that the document id exists in the specified index.
+     * @param ExistsParams
+     * @returns boolean
+    */
+    exists(params: ClientParams.ExistsParams): Promise<ClientResponse.ExistsResponse>;
+    /**
+     * Retrieves the specified JSON document from an index or an empty doc if no doc id is found
+     * @param ClientParams.GetParams
+     * @returns Object
+    */
+    get<T = Record<string, unknown>>(params: ClientParams.GetParams): Promise<ClientResponse.GetResponse<T>>;
+    /**
+     * Returns info about the cluster the client is connected to
+     * @returns object with cluster info
+    */
+    info(): Promise<ClientResponse.InfoResponse>;
+    /**
+     * Returns true or false based on whether the cluster is running.
+     * @returns Boolean
+    */
+    ping(): Promise<boolean>;
+    /**
+     * Returns search hits that match the query defined in the request.
+     * @param SearchParams
+     * @returns {Record<string,any>[]}
+    */
+    search<T = Record<string, unknown>>(params: ClientParams.SearchParams): Promise<ClientResponse.SearchResponse<T>>;
+    /**
+     * The multi search execution of several searches within the same API request
+     * @param MSearchParams
+     * @returns {Record<string,any>[]}
+    */
+    msearch(params: ClientParams.MSearchParams): Promise<ClientResponse.MSearchResponse>;
+    /**
+     * The multi get execution of multiple-get searches from a single API request
+     * @param MGetParams
+     * @returns {Record<string,any>[]}
+    */
+    mget(params: ClientParams.MGetParams): Promise<ClientResponse.MGetResponse>;
+    /**
+     * Re-Index data to a new index
+     * @param ReIndexParams
+     * @returns Report of re-indexing task or task id if wait_for_completion is false
+    */
+    reindex(params: ClientParams.ReindexParams): Promise<ClientResponse.ReindexResponse>;
+    get indices(): {
+        /**
+         * Creates a new index.
+         * @param IndicesCreateParams
+         * @returns IndicesCreateResponse
+         */
+        create(params: ClientParams.IndicesCreateParams): Promise<ClientResponse.IndicesCreateResponse>;
+        /**
+         * Deletes one or more indices.
+         * @param IndicesDeleteParams
+         * @returns
+         */
+        delete(params: ClientParams.IndicesDeleteParams): Promise<ClientResponse.IndicesDeleteResponse>;
+        /**
+         * Checks if a data stream, index, or alias exists.
+         * @param IndicesExistsParams
+         * @returns boolean
+         */
+        exists(params: ClientParams.IndicesExistsParams): Promise<ClientResponse.IndicesExistsResponse>;
+        /**
+         * Returns information about one or more indices
+         * @param IndicesGetParams
+         * @returns
+        */
+        get(params: ClientParams.IndicesGetParams): Promise<ClientResponse.IndicesGetResponse>;
+        /**
+         * Uploads index mapping template
+         * @param IndicesPutTemplateParams
+         * @returns IndicesPutTemplateResponse
+        */
+        putTemplate(params: ClientParams.IndicesPutTemplateParams): Promise<ClientResponse.IndicesPutTemplateResponse>;
+        /**
+         * Deletes index templates
+         * @param IndicesDeleteTemplateParams
+         * @returns IndicesDeleteTemplateResponse
+        */
+        deleteTemplate(params: ClientParams.IndicesDeleteTemplateParams): Promise<ClientResponse.IndicesDeleteTemplateResponse>;
+        /**
+         * Returns true if template exists
+         * @param IndicesExistsTemplateParams
+         * @returns boolean
+         */
+        existsTemplate(params: ClientParams.IndicesExistsTemplateParams): Promise<ClientResponse.IndicesExistsTemplateResponse>;
+        /**
+         * Returns template
+         * @param IndicesGetTemplateParams
+         * @returns template
+        */
+        getTemplate(params: ClientParams.IndicesGetTemplateParams): Promise<ClientResponse.IndicesGetTemplateResponse>;
+        /**
+         * Returns index template
+         * @param IndicesGetIndexTemplateParams
+         * @returns IndicesGetIndexTemplateResponse
+         * not supported by elasticsearch version 6
+         * same params as IndicesGetTemplateParams
+        */
+        getIndexTemplate(params: ClientParams.IndicesGetIndexTemplateParams): Promise<ClientResponse.IndicesGetIndexTemplateResponse>;
+        /**
+         * Retrieves mapping definitions for one or more indices
+         * @param IndicesGetMappingParams
+         * @returns IndicesGetMappingResponse
+        */
+        getMapping(params: ClientParams.IndicesGetMappingParams): Promise<ClientResponse.IndicesGetMappingResponse>;
+        /**
+         * Adds new fields to an existing index or edit the search settings of existing fields.
+         * @param IndicesPutMappingParams
+         * @returns IndicesPutMappingResponse
+        */
+        putMapping(params: ClientParams.IndicesPutMappingParams): Promise<ClientResponse.IndicesPutMappingResponse>;
+        /**
+         * Retrieves mapping definitions for one or more fields.
+         * @param IndicesGetFieldMappingParams
+         * @response IndicesGetFieldMappingResponse
+        */
+        getFieldMapping(params: ClientParams.IndicesGetFieldMappingParams): Promise<ClientResponse.IndicesGetFieldMappingResponse>;
+        /**
+         * Returns setting information for one or more indices
+         * @param IndicesGetSettingsParams
+         * @returns IndicesGetSettingsResponse
+         */
+        getSettings(params?: ClientParams.IndicesGetSettingsParams): Promise<ClientResponse.IndicesGetSettingsResponse>;
+        /**
+         * Changes a dynamic index setting in real time.
+         * @param IndicesPutSettingsParams
+         * @returns IndicesPutSettingsResponse
+        */
+        putSettings(params: ClientParams.IndicesPutSettingsParams): Promise<ClientResponse.IndicesPutSettingsResponse>;
+        /**
+         * Makes a recent operation performed on one or more indices available for search.
+         * @param IndicesRefreshParams
+         * @returns IndicesRefreshResponse
+         * can be an empty query
+        */
+        refresh(params?: ClientParams.IndicesRefreshParams): Promise<ClientResponse.IndicesRefreshResponse>;
+        /**
+         * Returns information about shard recoveries for one or more indices
+         * @param IndicesRecoveryParams
+         * @returns IndicesRecoveryResponse
+         * can be an empty query
+        */
+        recovery(params?: ClientParams.IndicesRecoveryParams): Promise<ClientResponse.IndicesRecoveryResponse>;
+        /**
+         * Validates a query without executing it.
+         * @param IndicesValidateQueryParams
+         * @returns IndicesValidateQueryResponse
+        */
+        validateQuery(params: ClientParams.IndicesValidateQueryParams): Promise<ClientResponse.IndicesValidateQueryResponse>;
+        /**
+         * Returns statistics for one or more indices
+         * @param IndicesStatsParams
+         * @returns IndicesStatsResponse
+        */
+        stats(params: ClientParams.IndicesStats): Promise<ClientResponse.IndicesStatsResponse>;
+    };
+    get tasks(): {
+        /**
+         * Cancels a currently running task
+         * @param TasksCancelParams
+         * @returns TasksCancelResponse
+        */
+        cancel(params: ClientParams.TasksCancelParams): Promise<ClientResponse.TasksCancelResponse>;
+        /**
+         * Gets information about a running task
+         * @param TasksGetParams
+         * @returns TasksGetResponse
+        */
+        get(params: ClientParams.TasksGetParams): Promise<ClientResponse.TasksGetResponse>;
+        /**
+         * Returns information about the tasks currently executing in the cluster.
+         * @param TasksListParams
+         * @returns TasksListResponse
+        */
+        list(params: ClientParams.TasksListParams): Promise<ClientResponse.TasksListResponse>;
+    };
+    private _removeBody;
+}
+//# sourceMappingURL=client.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/client/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAGhF,qBAAa,MAAM;IACf,OAAO,CAAC,MAAM,CAAM;IACpB,OAAO,CAAC,gBAAgB,CAAiB;gBAGrC,MAAM,EAAE,GAAG,EACX,gBAAgB,EAAE,cAAc;IAMpC,IAAI,MAAM,mBAET;IAEK,IAAI,CACN,MAAM,EAAE,YAAY,CAAC,UAAU,GAChC,OAAO,CAAC,cAAc,CAAC,YAAY,CAAC;IAWvC;;;MAGE;IACI,MAAM,CACR,MAAM,EAAE,YAAY,CAAC,YAAY,GAClC,OAAO,CAAC,cAAc,CAAC,cAAc,CAAC;IAWzC;;;MAGE;IACI,KAAK,CACP,MAAM,EAAE,YAAY,CAAC,WAAW,GACjC,OAAO,CAAC,cAAc,CAAC,aAAa,CAAC;IAWxC;;;MAGE;IACI,MAAM,CACR,MAAM,EAAE,YAAY,CAAC,YAAY,GAClC,OAAO,CAAC,cAAc,CAAC,cAAc,CAAC;IAWzC;;;;MAIE;IAEI,KAAK,CACP,MAAM,EAAE,YAAY,CAAC,WAAW,GACjC,OAAO,CAAC,cAAc,CAAC,aAAa,CAAC;IAWxC,IAAI,OAAO;6BASS,YAAY,CAAC,wBAAwB,GAC9C,OAAO,CAAC,cAAc,CAAC,0BAA0B,CAAC;wBAWzC,YAAY,CAAC,mBAAmB,GACzC,OAAO,CAAC,cAAc,CAAC,qBAAqB,CAAC;MAUvD;IAED,IAAI,GAAG;yBASa,YAAY,CAAC,gBAAgB,GACtC,OAAO,CAAC,cAAc,CAAC,kBAAkB,CAAC;MAWpD;IAED,IAAI,KAAK;uBASW,YAAY,CAAC,gBAAgB,GACtC,OAAO,CAAC,cAAc,CAAC,kBAAkB,CAAC;sBAWjC,YAAY,CAAC,eAAe,GACrC,OAAO,CAAC,cAAc,CAAC,iBAAiB,CAAC;MAWnD;IAED;;;MAGE;IACI,MAAM,CACR,MAAM,EAAE,YAAY,CAAC,YAAY,GAClC,OAAO,CAAC,cAAc,CAAC,cAAc,CAAC;IAWzC;;;;MAIE;IACI,aAAa,CACf,MAAM,EAAE,YAAY,CAAC,mBAAmB,GACzC,OAAO,CAAC,cAAc,CAAC,qBAAqB,CAAC;IAWhD;;;;MAIE;IACI,MAAM,CACR,MAAM,EAAE,YAAY,CAAC,YAAY,GAClC,OAAO,CAAC,cAAc,CAAC,cAAc,CAAC;IAWzC;;;;MAIE;IACI,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACjC,MAAM,EAAE,YAAY,CAAC,SAAS,GAC/B,OAAO,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;IAWzC;;;MAGE;IACI,IAAI,IAAI,OAAO,CAAC,cAAc,CAAC,YAAY,CAAC;IAQlD;;;MAGE;IACI,IAAI,IAAI,OAAO,CAAC,OAAO,CAAC;IAQ9B;;;;MAIE;IACI,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACpC,MAAM,EAAE,YAAY,CAAC,YAAY,GAClC,OAAO,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;IAW5C;;;;MAIE;IACI,OAAO,CACT,MAAM,EAAE,YAAY,CAAC,aAAa,GACnC,OAAO,CAAC,cAAc,CAAC,eAAe,CAAC;IAW1C;;;;MAIE;IACI,IAAI,CACN,MAAM,EAAE,YAAY,CAAC,UAAU,GAChC,OAAO,CAAC,cAAc,CAAC,YAAY,CAAC;IAWvC;;;;MAIE;IACI,OAAO,CACT,MAAM,EAAE,YAAY,CAAC,aAAa,GACnC,OAAO,CAAC,cAAc,CAAC,eAAe,CAAC;IAW1C,IAAI,OAAO;QAQH;;;;WAIG;uBACkB,YAAY,CAAC,mBAAmB,GACrD,OAAO,CAAC,cAAc,CAAC,qBAAqB,CAAC;QAS7C;;;;WAIG;uBACkB,YAAY,CAAC,mBAAmB,GACrD,OAAO,CAAC,cAAc,CAAC,qBAAqB,CAAC;QAU7C;;;;WAIG;uBAES,YAAY,CAAC,mBAAmB,GACzC,OAAO,CAAC,cAAc,CAAC,qBAAqB,CAAC;QAUhD;;;;UAIE;oBAEU,YAAY,CAAC,gBAAgB,GACtC,OAAO,CAAC,cAAc,CAAC,kBAAkB,CAAC;QAU7C;;;;UAIE;4BAEU,YAAY,CAAC,wBAAwB,GAC9C,OAAO,CAAC,cAAc,CAAC,0BAA0B,CAAC;QAUrD;;;;UAIE;+BAEU,YAAY,CAAC,2BAA2B,GACjD,OAAO,CAAC,cAAc,CAAC,6BAA6B,CAAC;QAUxD;;;;WAIG;+BAES,YAAY,CAAC,2BAA2B,GACjD,OAAO,CAAC,cAAc,CAAC,6BAA6B,CAAC;QAUxD;;;;UAIE;4BAEU,YAAY,CAAC,wBAAwB,GAC9C,OAAO,CAAC,cAAc,CAAC,0BAA0B,CAAC;QAUrD;;;;;;UAME;iCAEU,YAAY,CAAC,6BAA6B,GACnD,OAAO,CAAC,cAAc,CAAC,+BAA+B,CAAC;QAW1D;;;;UAIE;2BAEU,YAAY,CAAC,uBAAuB,GAC7C,OAAO,CAAC,cAAc,CAAC,yBAAyB,CAAC;QAWpD;;;;UAIE;2BAEU,YAAY,CAAC,uBAAuB,GAC7C,OAAO,CAAC,cAAc,CAAC,yBAAyB,CAAC;QAWpD;;;;UAIE;gCAEU,YAAY,CAAC,4BAA4B,GAClD,OAAO,CAAC,cAAc,CAAC,8BAA8B,CAAC;QAWzD;;;;WAIG;6BAES,YAAY,CAAC,wBAAwB,GAC9C,OAAO,CAAC,cAAc,CAAC,0BAA0B,CAAC;QAWrD;;;;UAIE;4BAEU,YAAY,CAAC,wBAAwB,GAC9C,OAAO,CAAC,cAAc,CAAC,0BAA0B,CAAC;QAWrD;;;;;UAKE;yBAEU,YAAY,CAAC,oBAAoB,GAC1C,OAAO,CAAC,cAAc,CAAC,sBAAsB,CAAC;QAWjD;;;;;UAKE;0BAEU,YAAY,CAAC,qBAAqB,GAC3C,OAAO,CAAC,cAAc,CAAC,uBAAuB,CAAC;QAWlD;;;;UAIE;8BAEU,YAAY,CAAC,0BAA0B,GAChD,OAAO,CAAC,cAAc,CAAC,4BAA4B,CAAC;QAWvD;;;;UAIE;sBAEU,YAAY,CAAC,YAAY,GAClC,OAAO,CAAC,cAAc,CAAC,oBAAoB,CAAC;MAUtD;IAED,IAAI,KAAK;QASD;;;;UAIE;uBAEU,YAAY,CAAC,iBAAiB,GACvC,OAAO,CAAC,cAAc,CAAC,mBAAmB,CAAC;QAU9C;;;;UAIE;oBAEU,YAAY,CAAC,cAAc,GACpC,OAAO,CAAC,cAAc,CAAC,gBAAgB,CAAC;QAU3C;;;;UAIE;qBAEU,YAAY,CAAC,eAAe,GACrC,OAAO,CAAC,cAAc,CAAC,iBAAiB,CAAC;MAWnD;IAED,OAAO,CAAC,WAAW;CAItB"}