@backstage/plugin-search-backend-node 0.4.6 → 0.4.7

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @backstage/plugin-search-backend-node
 
+## 0.4.7
+
+### Patch Changes
+
+- Fix for the previous release with missing type declarations.
+- Updated dependencies
+  - @backstage/search-common@0.2.4
+
 ## 0.4.6
 
 ### Patch Changes

package/dist/index.d.ts

@@ -0,0 +1,107 @@
+import { DocumentCollator, DocumentDecorator, SearchEngine, DocumentTypeInfo, IndexableDocument, QueryTranslator, SearchQuery, SearchResultSet } from '@backstage/search-common';
+export { SearchEngine } from '@backstage/search-common';
+import { Logger } from 'winston';
+import lunr from 'lunr';
+
+/**
+ * Parameters required to register a collator.
+ */
+interface RegisterCollatorParameters {
+    /**
+     * The default interval (in seconds) that the provided collator will be called (can be overridden in config).
+     */
+    defaultRefreshIntervalSeconds: number;
+    /**
+     * The collator class responsible for returning all documents of the given type.
+     */
+    collator: DocumentCollator;
+}
+/**
+ * Parameters required to register a decorator
+ */
+interface RegisterDecoratorParameters {
+    /**
+     * The decorator class responsible for appending or modifying documents of the given type(s).
+     */
+    decorator: DocumentDecorator;
+}
+
+declare type IndexBuilderOptions = {
+    searchEngine: SearchEngine;
+    logger: Logger;
+};
+declare class IndexBuilder {
+    private collators;
+    private decorators;
+    private documentTypes;
+    private searchEngine;
+    private logger;
+    constructor({ logger, searchEngine }: IndexBuilderOptions);
+    getSearchEngine(): SearchEngine;
+    getDocumentTypes(): Record<string, DocumentTypeInfo>;
+    /**
+     * Makes the index builder aware of a collator that should be executed at the
+     * given refresh interval.
+     */
+    addCollator({ collator, defaultRefreshIntervalSeconds, }: RegisterCollatorParameters): void;
+    /**
+     * Makes the index builder aware of a decorator. If no types are provided on
+     * the decorator, it will be applied to documents from all known collators,
+     * otherwise it will only be applied to documents of the given types.
+     */
+    addDecorator({ decorator }: RegisterDecoratorParameters): void;
+    /**
+     * Compiles collators and decorators into tasks, which are added to a
+     * scheduler returned to the caller.
+     */
+    build(): Promise<{
+        scheduler: Scheduler;
+    }>;
+}
+
+/**
+ * TODO: coordination, error handling
+ */
+declare class Scheduler {
+    private logger;
+    private schedule;
+    private runningTasks;
+    constructor({ logger }: {
+        logger: Logger;
+    });
+    /**
+     * Adds each task and interval to the schedule.
+     * When running the tasks, the scheduler waits at least for the time specified
+     * in the interval once the task was completed, before running it again.
+     */
+    addToSchedule(task: Function, interval: number): void;
+    /**
+     * Starts the scheduling process for each task
+     */
+    start(): void;
+    /**
+     * Stop all scheduled tasks.
+     */
+    stop(): void;
+}
+
+declare type ConcreteLunrQuery = {
+    lunrQueryBuilder: lunr.Index.QueryBuilder;
+    documentTypes?: string[];
+    pageSize: number;
+};
+declare type LunrQueryTranslator = (query: SearchQuery) => ConcreteLunrQuery;
+declare class LunrSearchEngine implements SearchEngine {
+    protected lunrIndices: Record<string, lunr.Index>;
+    protected docStore: Record<string, IndexableDocument>;
+    protected logger: Logger;
+    constructor({ logger }: {
+        logger: Logger;
+    });
+    protected translator: QueryTranslator;
+    setTranslator(translator: LunrQueryTranslator): void;
+    index(type: string, documents: IndexableDocument[]): Promise<void>;
+    query(query: SearchQuery): Promise<SearchResultSet>;
+}
+
+export { IndexBuilder, LunrSearchEngine, Scheduler };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/plugin-search-backend-node",
   "description": "A library for Backstage backend plugins that want to interact with the search backend plugin",
-  "version": "0.4.6",
+  "version": "0.4.7",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -23,17 +23,17 @@
     "clean": "backstage-cli package clean"
   },
   "dependencies": {
-    "@backstage/search-common": "^0.2.3",
+    "@backstage/search-common": "^0.2.4",
     "@types/lunr": "^2.3.3",
     "lunr": "^2.3.9",
     "winston": "^3.2.1"
   },
   "devDependencies": {
-    "@backstage/backend-common": "^0.10.8",
+    "@backstage/backend-common": "^0.10.9",
     "@backstage/cli": "^0.14.0"
   },
   "files": [
     "dist"
   ],
-  "gitHead": "4805c3d13ce9bfc369e53c271b1b95e722b3b4dc"
+  "gitHead": "e244b348c473700e7d5e5fbcef38bd9f9fd1d0ba"
 }