@backstage/plugin-search-backend-module-elasticsearch 0.0.9 → 0.0.10

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @backstage/plugin-search-backend-module-elasticsearch
 
+## 0.0.10
+
+### Patch Changes
+
+- Fix for the previous release with missing type declarations.
+- Updated dependencies
+  - @backstage/config@0.1.15
+  - @backstage/search-common@0.2.4
+
 ## 0.0.9
 
 ### Patch Changes

package/dist/index.d.ts

@@ -0,0 +1,138 @@
+/// <reference types="node" />
+import { Config } from '@backstage/config';
+import { SearchEngine, SearchQuery, IndexableDocument, SearchResultSet } from '@backstage/search-common';
+import { Logger } from 'winston';
+import { ConnectionOptions } from 'tls';
+
+/**
+ * Options used to configure the `@elastic/elasticsearch` client and
+ * are what will be passed as an argument to the
+ * {@link ElasticSearchEngine.newClient} method
+ *
+ * They are drawn from the `ClientOptions` class of `@elastic/elasticsearch`,
+ * but are maintained separately so that this interface is not coupled to
+ */
+interface ElasticSearchClientOptions {
+    provider?: 'aws' | 'elastic';
+    node?: string | string[] | ElasticSearchNodeOptions | ElasticSearchNodeOptions[];
+    nodes?: string | string[] | ElasticSearchNodeOptions | ElasticSearchNodeOptions[];
+    Transport?: ElasticSearchTransportConstructor;
+    Connection?: ElasticSearchConnectionConstructor;
+    maxRetries?: number;
+    requestTimeout?: number;
+    pingTimeout?: number;
+    sniffInterval?: number | boolean;
+    sniffOnStart?: boolean;
+    sniffEndpoint?: string;
+    sniffOnConnectionFault?: boolean;
+    resurrectStrategy?: 'ping' | 'optimistic' | 'none';
+    suggestCompression?: boolean;
+    compression?: 'gzip';
+    ssl?: ConnectionOptions;
+    agent?: ElasticSearchAgentOptions | ((opts?: any) => unknown) | false;
+    nodeFilter?: (connection: any) => boolean;
+    nodeSelector?: ((connections: any[]) => any) | string;
+    headers?: Record<string, any>;
+    opaqueIdPrefix?: string;
+    name?: string | symbol;
+    auth?: ElasticSearchAuth;
+    proxy?: string | URL;
+    enableMetaHeader?: boolean;
+    cloud?: {
+        id: string;
+        username?: string;
+        password?: string;
+    };
+    disablePrototypePoisoningProtection?: boolean | 'proto' | 'constructor';
+}
+declare type ElasticSearchAuth = {
+    username: string;
+    password: string;
+} | {
+    apiKey: string | {
+        id: string;
+        api_key: string;
+    };
+};
+interface ElasticSearchNodeOptions {
+    url: URL;
+    id?: string;
+    agent?: ElasticSearchAgentOptions;
+    ssl?: ConnectionOptions;
+    headers?: Record<string, any>;
+    roles?: {
+        master: boolean;
+        data: boolean;
+        ingest: boolean;
+        ml: boolean;
+    };
+}
+interface ElasticSearchAgentOptions {
+    keepAlive?: boolean;
+    keepAliveMsecs?: number;
+    maxSockets?: number;
+    maxFreeSockets?: number;
+}
+interface ElasticSearchConnectionConstructor {
+    new (opts?: any): any;
+    statuses: {
+        ALIVE: string;
+        DEAD: string;
+    };
+    roles: {
+        MASTER: string;
+        DATA: string;
+        INGEST: string;
+        ML: string;
+    };
+}
+interface ElasticSearchTransportConstructor {
+    new (opts?: any): any;
+    sniffReasons: {
+        SNIFF_ON_START: string;
+        SNIFF_INTERVAL: string;
+        SNIFF_ON_CONNECTION_FAULT: string;
+        DEFAULT: string;
+    };
+}
+
+declare type ConcreteElasticSearchQuery = {
+    documentTypes?: string[];
+    elasticSearchQuery: Object;
+    pageSize: number;
+};
+declare type ElasticSearchQueryTranslator = (query: SearchQuery) => ConcreteElasticSearchQuery;
+declare type ElasticSearchOptions = {
+    logger: Logger;
+    config: Config;
+    aliasPostfix?: string;
+    indexPrefix?: string;
+};
+/**
+ * @public
+ */
+declare class ElasticSearchSearchEngine implements SearchEngine {
+    private readonly elasticSearchClientOptions;
+    private readonly aliasPostfix;
+    private readonly indexPrefix;
+    private readonly logger;
+    private readonly elasticSearchClient;
+    constructor(elasticSearchClientOptions: ElasticSearchClientOptions, aliasPostfix: string, indexPrefix: string, logger: Logger);
+    static fromConfig({ logger, config, aliasPostfix, indexPrefix, }: ElasticSearchOptions): Promise<ElasticSearchSearchEngine>;
+    /**
+     * Create a custom search client from the derived elastic search
+     * configuration. This need not be the same client that the engine uses
+     * internally.
+     */
+    newClient<T>(create: (options: ElasticSearchClientOptions) => T): T;
+    protected translator(query: SearchQuery): ConcreteElasticSearchQuery;
+    setTranslator(translator: ElasticSearchQueryTranslator): void;
+    index(type: string, documents: IndexableDocument[]): Promise<void>;
+    query(query: SearchQuery): Promise<SearchResultSet>;
+    private readonly indexSeparator;
+    private constructIndexName;
+    private getTypeFromIndex;
+    private constructSearchAlias;
+}
+
+export { ElasticSearchClientOptions, ElasticSearchSearchEngine };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/plugin-search-backend-module-elasticsearch",
   "description": "A module for the search backend that implements search using ElasticSearch",
-  "version": "0.0.9",
+  "version": "0.0.10",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -24,8 +24,8 @@
   },
   "dependencies": {
     "@acuris/aws-es-connection": "^2.2.0",
-    "@backstage/config": "^0.1.14",
-    "@backstage/search-common": "^0.2.3",
+    "@backstage/config": "^0.1.15",
+    "@backstage/search-common": "^0.2.4",
     "@elastic/elasticsearch": "7.13.0",
     "aws-sdk": "^2.948.0",
     "elastic-builder": "^2.16.0",
@@ -33,7 +33,7 @@
     "winston": "^3.2.1"
   },
   "devDependencies": {
-    "@backstage/backend-common": "^0.10.8",
+    "@backstage/backend-common": "^0.10.9",
     "@backstage/cli": "^0.14.0",
     "@elastic/elasticsearch-mock": "^1.0.0"
   },
@@ -45,5 +45,5 @@
     "testEnvironment": "node"
   },
   "configSchema": "config.d.ts",
-  "gitHead": "4805c3d13ce9bfc369e53c271b1b95e722b3b4dc"
+  "gitHead": "e244b348c473700e7d5e5fbcef38bd9f9fd1d0ba"
 }