diff --git a/.gitignore b/.gitignore index 0909c9a73..09aaa949d 100644 --- a/.gitignore +++ b/.gitignore @@ -50,6 +50,8 @@ jspm_packages # opensearch repo or binary files opensearch* +!opensearch_dashboards* +!opensearchDashboards* test/benchmarks/macro/fixtures/* diff --git a/.npmignore b/.npmignore index 54ae7742a..6b2e0368a 100644 --- a/.npmignore +++ b/.npmignore @@ -49,6 +49,8 @@ package-lock.json # opensearch repo or binary files opensearch* +!opensearch_dashboards* +!opensearchDashboards* # Generated typings, we don't commit them # because we should copy them in the main .d.ts file @@ -72,5 +74,4 @@ CODE_OF_CONDUCT.md CONTRIBUTING.md # CANARY-PACKAGE -api/opensearch_dashboards.d.ts -# /CANARY-PACKAGE + diff --git a/api/opensearch_dashboards.d.ts b/api/opensearch_dashboards.d.ts new file mode 100644 index 000000000..613541b27 --- /dev/null +++ b/api/opensearch_dashboards.d.ts @@ -0,0 +1,272 @@ +/* + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + * Modifications Copyright OpenSearch Contributors. See + * GitHub history for details. + */ + +/* + * 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. + */ + +/// + +import { + ClientOptions, + ConnectionPool, + Serializer, + Transport, + errors, + RequestEvent, + ResurrectEvent, + ApiError + } from '../index' + import Helpers from '../lib/Helpers' + import { + ApiResponse, + TransportRequestPromise, + TransportRequestParams, + TransportRequestOptions + } from '../lib/Transport' + import * as T from './types' + + /** + * We are still working on this type, it will arrive soon. + * If it's critical for you, please open an issue. + * https://github.com/opensearch-project/opensearch-js/issues + */ + type TODO = Record + + // Extend API + interface ClientExtendsCallbackOptions { + ConfigurationError: errors.ConfigurationError, + makeRequest(params: TransportRequestParams, options?: TransportRequestOptions): Promise | void; + result: { + body: null, + statusCode: null, + headers: null, + warnings: null + } + } + declare type extendsCallback = (options: ClientExtendsCallbackOptions) => any; + // /Extend API + + interface OpenSearchDashboardsClient { + connectionPool: ConnectionPool + transport: Transport + serializer: Serializer + extend(method: string, fn: extendsCallback): void + extend(method: string, opts: { force: boolean }, fn: extendsCallback): void; + helpers: Helpers + child(opts?: ClientOptions): OpenSearchDashboardsClient + close(): Promise; + emit(event: string | symbol, ...args: any[]): boolean; + on(event: 'request', listener: (err: ApiError, meta: RequestEvent) => void): this; + on(event: 'response', listener: (err: ApiError, meta: RequestEvent) => void): this; + on(event: 'sniff', listener: (err: ApiError, meta: RequestEvent) => void): this; + on(event: 'resurrect', listener: (err: null, meta: ResurrectEvent) => void): this; + once(event: 'request', listener: (err: ApiError, meta: RequestEvent) => void): this; + once(event: 'response', listener: (err: ApiError, meta: RequestEvent) => void): this; + once(event: 'sniff', listener: (err: ApiError, meta: RequestEvent) => void): this; + once(event: 'resurrect', listener: (err: null, meta: ResurrectEvent) => void): this; + off(event: string | symbol, listener: (...args: any[]) => void): this; + bulk(params: T.BulkRequest, options?: TransportRequestOptions): TransportRequestPromise> + cat: { + aliases(params?: T.CatAliasesRequest, options?: TransportRequestOptions): TransportRequestPromise> + allocation(params?: T.CatAllocationRequest, options?: TransportRequestOptions): TransportRequestPromise> + count(params?: T.CatCountRequest, options?: TransportRequestOptions): TransportRequestPromise> + fielddata(params?: T.CatFielddataRequest, options?: TransportRequestOptions): TransportRequestPromise> + health(params?: T.CatHealthRequest, options?: TransportRequestOptions): TransportRequestPromise> + help(params?: T.CatHelpRequest, options?: TransportRequestOptions): TransportRequestPromise> + indices(params?: T.CatIndicesRequest, options?: TransportRequestOptions): TransportRequestPromise> + master(params?: T.CatMasterRequest, options?: TransportRequestOptions): TransportRequestPromise> + nodeattrs(params?: T.CatNodeAttributesRequest, options?: TransportRequestOptions): TransportRequestPromise> + nodes(params?: T.CatNodesRequest, options?: TransportRequestOptions): TransportRequestPromise> + pendingTasks(params?: T.CatPendingTasksRequest, options?: TransportRequestOptions): TransportRequestPromise> + plugins(params?: T.CatPluginsRequest, options?: TransportRequestOptions): TransportRequestPromise> + recovery(params?: T.CatRecoveryRequest, options?: TransportRequestOptions): TransportRequestPromise> + repositories(params?: T.CatRepositoriesRequest, options?: TransportRequestOptions): TransportRequestPromise> + segments(params?: T.CatSegmentsRequest, options?: TransportRequestOptions): TransportRequestPromise> + shards(params?: T.CatShardsRequest, options?: TransportRequestOptions): TransportRequestPromise> + snapshots(params?: T.CatSnapshotsRequest, options?: TransportRequestOptions): TransportRequestPromise> + tasks(params?: T.CatTasksRequest, options?: TransportRequestOptions): TransportRequestPromise> + templates(params?: T.CatTemplatesRequest, options?: TransportRequestOptions): TransportRequestPromise> + threadPool(params?: T.CatThreadPoolRequest, options?: TransportRequestOptions): TransportRequestPromise> + } + clearScroll(params?: T.ClearScrollRequest, options?: TransportRequestOptions): TransportRequestPromise> + cluster: { + allocationExplain(params?: T.ClusterAllocationExplainRequest, options?: TransportRequestOptions): TransportRequestPromise> + deleteComponentTemplate(params: T.ClusterDeleteComponentTemplateRequest, options?: TransportRequestOptions): TransportRequestPromise> + deleteVotingConfigExclusions(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise> + existsComponentTemplate(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise> + getComponentTemplate(params?: T.ClusterGetComponentTemplateRequest, options?: TransportRequestOptions): TransportRequestPromise> + getSettings(params?: T.ClusterGetSettingsRequest, options?: TransportRequestOptions): TransportRequestPromise> + health(params?: T.ClusterHealthRequest, options?: TransportRequestOptions): TransportRequestPromise> + pendingTasks(params?: T.ClusterPendingTasksRequest, options?: TransportRequestOptions): TransportRequestPromise> + postVotingConfigExclusions(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise> + putComponentTemplate(params: T.ClusterPutComponentTemplateRequest, options?: TransportRequestOptions): TransportRequestPromise> + putSettings(params?: T.ClusterPutSettingsRequest, options?: TransportRequestOptions): TransportRequestPromise> + remoteInfo(params?: T.ClusterRemoteInfoRequest, options?: TransportRequestOptions): TransportRequestPromise> + reroute(params?: T.ClusterRerouteRequest, options?: TransportRequestOptions): TransportRequestPromise> + state(params?: T.ClusterStateRequest, options?: TransportRequestOptions): TransportRequestPromise> + stats(params?: T.ClusterStatsRequest, options?: TransportRequestOptions): TransportRequestPromise> + } + count(params?: T.CountRequest, options?: TransportRequestOptions): TransportRequestPromise> + create(params: T.CreateRequest, options?: TransportRequestOptions): TransportRequestPromise> + danglingIndices: { + deleteDanglingIndex(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise> + importDanglingIndex(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise> + listDanglingIndices(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise> + } + delete(params: T.DeleteRequest, options?: TransportRequestOptions): TransportRequestPromise> + deleteByQuery(params: T.DeleteByQueryRequest, options?: TransportRequestOptions): TransportRequestPromise> + deleteByQueryRethrottle(params: T.DeleteByQueryRethrottleRequest, options?: TransportRequestOptions): TransportRequestPromise> + deleteScript(params: T.DeleteScriptRequest, options?: TransportRequestOptions): TransportRequestPromise> + exists(params: T.ExistsRequest, options?: TransportRequestOptions): TransportRequestPromise> + existsSource(params: T.ExistsSourceRequest, options?: TransportRequestOptions): TransportRequestPromise> + explain(params: T.ExplainRequest, options?: TransportRequestOptions): TransportRequestPromise, TContext>> + features: { + getFeatures(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise> + resetFeatures(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise> + } + fieldCaps(params?: T.FieldCapsRequest, options?: TransportRequestOptions): TransportRequestPromise> + get(params: T.GetRequest, options?: TransportRequestOptions): TransportRequestPromise, TContext>> + getScript(params: T.GetScriptRequest, options?: TransportRequestOptions): TransportRequestPromise> + getScriptContext(params?: T.GetScriptContextRequest, options?: TransportRequestOptions): TransportRequestPromise> + getScriptLanguages(params?: T.GetScriptLanguagesRequest, options?: TransportRequestOptions): TransportRequestPromise> + getSource(params?: T.GetSourceRequest, options?: TransportRequestOptions): TransportRequestPromise, TContext>> + index(params: T.IndexRequest, options?: TransportRequestOptions): TransportRequestPromise> + indices: { + addBlock(params: T.IndicesAddBlockRequest, options?: TransportRequestOptions): TransportRequestPromise> + analyze(params?: T.IndicesAnalyzeRequest, options?: TransportRequestOptions): TransportRequestPromise> + clearCache(params?: T.IndicesClearCacheRequest, options?: TransportRequestOptions): TransportRequestPromise> + clone(params: T.IndicesCloneRequest, options?: TransportRequestOptions): TransportRequestPromise> + close(params: T.IndicesCloseRequest, options?: TransportRequestOptions): TransportRequestPromise> + create(params: T.IndicesCreateRequest, options?: TransportRequestOptions): TransportRequestPromise> + delete(params: T.IndicesDeleteRequest, options?: TransportRequestOptions): TransportRequestPromise> + deleteAlias(params: T.IndicesDeleteAliasRequest, options?: TransportRequestOptions): TransportRequestPromise> + deleteIndexTemplate(params: T.IndicesDeleteIndexTemplateRequest, options?: TransportRequestOptions): TransportRequestPromise> + deleteTemplate(params: T.IndicesDeleteTemplateRequest, options?: TransportRequestOptions): TransportRequestPromise> + diskUsage(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise> + exists(params: T.IndicesExistsRequest, options?: TransportRequestOptions): TransportRequestPromise> + existsAlias(params: T.IndicesExistsAliasRequest, options?: TransportRequestOptions): TransportRequestPromise> + existsIndexTemplate(params: T.IndicesExistsIndexTemplateRequest, options?: TransportRequestOptions): TransportRequestPromise> + existsTemplate(params: T.IndicesExistsTemplateRequest, options?: TransportRequestOptions): TransportRequestPromise> + existsType(params: T.IndicesExistsTypeRequest, options?: TransportRequestOptions): TransportRequestPromise> + fieldUsageStats(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise> + flush(params?: T.IndicesFlushRequest, options?: TransportRequestOptions): TransportRequestPromise> + flushSynced(params?: T.IndicesFlushSyncedRequest, options?: TransportRequestOptions): TransportRequestPromise> + forcemerge(params?: T.IndicesForcemergeRequest, options?: TransportRequestOptions): TransportRequestPromise> + get(params: T.IndicesGetRequest, options?: TransportRequestOptions): TransportRequestPromise> + getAlias(params?: T.IndicesGetAliasRequest, options?: TransportRequestOptions): TransportRequestPromise> + getFieldMapping(params: T.IndicesGetFieldMappingRequest, options?: TransportRequestOptions): TransportRequestPromise> + getIndexTemplate(params?: T.IndicesGetIndexTemplateRequest, options?: TransportRequestOptions): TransportRequestPromise> + getMapping(params?: T.IndicesGetMappingRequest, options?: TransportRequestOptions): TransportRequestPromise> + getSettings(params?: T.IndicesGetSettingsRequest, options?: TransportRequestOptions): TransportRequestPromise> + getTemplate(params?: T.IndicesGetTemplateRequest, options?: TransportRequestOptions): TransportRequestPromise> + getUpgrade(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise> + open(params: T.IndicesOpenRequest, options?: TransportRequestOptions): TransportRequestPromise> + putAlias(params: T.IndicesPutAliasRequest, options?: TransportRequestOptions): TransportRequestPromise> + putIndexTemplate(params: T.IndicesPutIndexTemplateRequest, options?: TransportRequestOptions): TransportRequestPromise> + putMapping(params?: T.IndicesPutMappingRequest, options?: TransportRequestOptions): TransportRequestPromise> + putSettings(params?: T.IndicesPutSettingsRequest, options?: TransportRequestOptions): TransportRequestPromise> + putTemplate(params: T.IndicesPutTemplateRequest, options?: TransportRequestOptions): TransportRequestPromise> + recovery(params?: T.IndicesRecoveryRequest, options?: TransportRequestOptions): TransportRequestPromise> + refresh(params?: T.IndicesRefreshRequest, options?: TransportRequestOptions): TransportRequestPromise> + resolveIndex(params: T.IndicesResolveIndexRequest, options?: TransportRequestOptions): TransportRequestPromise> + rollover(params: T.IndicesRolloverRequest, options?: TransportRequestOptions): TransportRequestPromise> + segments(params?: T.IndicesSegmentsRequest, options?: TransportRequestOptions): TransportRequestPromise> + shardStores(params?: T.IndicesShardStoresRequest, options?: TransportRequestOptions): TransportRequestPromise> + shrink(params: T.IndicesShrinkRequest, options?: TransportRequestOptions): TransportRequestPromise> + simulateIndexTemplate(params?: T.IndicesSimulateIndexTemplateRequest, options?: TransportRequestOptions): TransportRequestPromise> + simulateTemplate(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise> + split(params: T.IndicesSplitRequest, options?: TransportRequestOptions): TransportRequestPromise> + stats(params?: T.IndicesStatsRequest, options?: TransportRequestOptions): TransportRequestPromise> + updateAliases(params?: T.IndicesUpdateAliasesRequest, options?: TransportRequestOptions): TransportRequestPromise> + upgrade(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise> + validateQuery(params?: T.IndicesValidateQueryRequest, options?: TransportRequestOptions): TransportRequestPromise> + } + info(params?: T.InfoRequest, options?: TransportRequestOptions): TransportRequestPromise> + ingest: { + deletePipeline(params: T.IngestDeletePipelineRequest, options?: TransportRequestOptions): TransportRequestPromise> + geoIpStats(params?: T.IngestGeoIpStatsRequest, options?: TransportRequestOptions): TransportRequestPromise> + getPipeline(params?: T.IngestGetPipelineRequest, options?: TransportRequestOptions): TransportRequestPromise> + processorGrok(params?: T.IngestProcessorGrokRequest, options?: TransportRequestOptions): TransportRequestPromise> + putPipeline(params: T.IngestPutPipelineRequest, options?: TransportRequestOptions): TransportRequestPromise> + simulate(params?: T.IngestSimulatePipelineRequest, options?: TransportRequestOptions): TransportRequestPromise> + } + mget(params?: T.MgetRequest, options?: TransportRequestOptions): TransportRequestPromise, TContext>> + msearch(params?: T.MsearchRequest, options?: TransportRequestOptions): TransportRequestPromise, TContext>> + msearchTemplate(params?: T.MsearchTemplateRequest, options?: TransportRequestOptions): TransportRequestPromise, TContext>> + mtermvectors(params?: T.MtermvectorsRequest, options?: TransportRequestOptions): TransportRequestPromise> + nodes: { + clearMeteringArchive(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise> + getMeteringInfo(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise> + hotThreads(params?: T.NodesHotThreadsRequest, options?: TransportRequestOptions): TransportRequestPromise> + info(params?: T.NodesInfoRequest, options?: TransportRequestOptions): TransportRequestPromise> + reloadSecureSettings(params?: T.NodesReloadSecureSettingsRequest, options?: TransportRequestOptions): TransportRequestPromise> + stats(params?: T.NodesStatsRequest, options?: TransportRequestOptions): TransportRequestPromise> + usage(params?: T.NodesUsageRequest, options?: TransportRequestOptions): TransportRequestPromise> + } + ping(params?: T.PingRequest, options?: TransportRequestOptions): TransportRequestPromise> + putScript(params: T.PutScriptRequest, options?: TransportRequestOptions): TransportRequestPromise> + rankEval(params: T.RankEvalRequest, options?: TransportRequestOptions): TransportRequestPromise> + reindex(params?: T.ReindexRequest, options?: TransportRequestOptions): TransportRequestPromise> + reindexRethrottle(params: T.ReindexRethrottleRequest, options?: TransportRequestOptions): TransportRequestPromise> + renderSearchTemplate(params?: T.RenderSearchTemplateRequest, options?: TransportRequestOptions): TransportRequestPromise> + scriptsPainlessExecute(params?: T.ScriptsPainlessExecuteRequest, options?: TransportRequestOptions): TransportRequestPromise, TContext>> + scroll(params?: T.ScrollRequest, options?: TransportRequestOptions): TransportRequestPromise, TContext>> + search(params?: T.SearchRequest, options?: TransportRequestOptions): TransportRequestPromise, TContext>> + searchShards(params?: T.SearchShardsRequest, options?: TransportRequestOptions): TransportRequestPromise> + searchTemplate(params?: T.SearchTemplateRequest, options?: TransportRequestOptions): TransportRequestPromise, TContext>> + shutdown: { + deleteNode(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise> + getNode(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise> + putNode(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise> + } + snapshot: { + cleanupRepository(params: T.SnapshotCleanupRepositoryRequest, options?: TransportRequestOptions): TransportRequestPromise> + clone(params: T.SnapshotCloneRequest, options?: TransportRequestOptions): TransportRequestPromise> + create(params: T.SnapshotCreateRequest, options?: TransportRequestOptions): TransportRequestPromise> + createRepository(params: T.SnapshotCreateRepositoryRequest, options?: TransportRequestOptions): TransportRequestPromise> + delete(params: T.SnapshotDeleteRequest, options?: TransportRequestOptions): TransportRequestPromise> + deleteRepository(params: T.SnapshotDeleteRepositoryRequest, options?: TransportRequestOptions): TransportRequestPromise> + get(params: T.SnapshotGetRequest, options?: TransportRequestOptions): TransportRequestPromise> + getRepository(params?: T.SnapshotGetRepositoryRequest, options?: TransportRequestOptions): TransportRequestPromise> + repositoryAnalyze(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise> + restore(params: T.SnapshotRestoreRequest, options?: TransportRequestOptions): TransportRequestPromise> + status(params?: T.SnapshotStatusRequest, options?: TransportRequestOptions): TransportRequestPromise> + verifyRepository(params: T.SnapshotVerifyRepositoryRequest, options?: TransportRequestOptions): TransportRequestPromise> + } + tasks: { + cancel(params?: T.TaskCancelRequest, options?: TransportRequestOptions): TransportRequestPromise> + get(params: T.TaskGetRequest, options?: TransportRequestOptions): TransportRequestPromise> + list(params?: T.TaskListRequest, options?: TransportRequestOptions): TransportRequestPromise> + } + termsEnum(params: T.TermsEnumRequest, options?: TransportRequestOptions): TransportRequestPromise> + termvectors(params: T.TermvectorsRequest, options?: TransportRequestOptions): TransportRequestPromise> + update(params: T.UpdateRequest, options?: TransportRequestOptions): TransportRequestPromise, TContext>> + updateByQuery(params: T.UpdateByQueryRequest, options?: TransportRequestOptions): TransportRequestPromise> + updateByQueryRethrottle(params: T.UpdateByQueryRethrottleRequest, options?: TransportRequestOptions): TransportRequestPromise> + } + + export { OpenSearchDashboardsClient } \ No newline at end of file