@backstage/plugin-search-backend-node 1.2.21 → 1.2.22-next.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +14 -0
- package/alpha/package.json +1 -1
- package/dist/alpha.cjs.js +9 -1
- package/dist/alpha.cjs.js.map +1 -1
- package/dist/alpha.d.ts +4 -0
- package/dist/index.cjs.js +1 -1
- package/package.json +6 -6
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
1
|
# @backstage/plugin-search-backend-node
|
|
2
2
|
|
|
3
|
+
## 1.2.22-next.0
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- c6cb568: Add lifecycle monitoring for the search index registry
|
|
8
|
+
- Updated dependencies
|
|
9
|
+
- @backstage/backend-common@0.21.8-next.0
|
|
10
|
+
- @backstage/backend-plugin-api@0.6.18-next.0
|
|
11
|
+
- @backstage/backend-tasks@0.5.23-next.0
|
|
12
|
+
- @backstage/config@1.2.0
|
|
13
|
+
- @backstage/errors@1.2.4
|
|
14
|
+
- @backstage/plugin-permission-common@0.7.13
|
|
15
|
+
- @backstage/plugin-search-common@1.2.11
|
|
16
|
+
|
|
3
17
|
## 1.2.21
|
|
4
18
|
|
|
5
19
|
### Patch Changes
|
package/alpha/package.json
CHANGED
package/dist/alpha.cjs.js
CHANGED
|
@@ -13,6 +13,7 @@ class DefaultSearchIndexService {
|
|
|
13
13
|
constructor(options) {
|
|
14
14
|
__publicField(this, "logger");
|
|
15
15
|
__publicField(this, "indexBuilder", null);
|
|
16
|
+
__publicField(this, "scheduler", null);
|
|
16
17
|
this.logger = options.logger;
|
|
17
18
|
}
|
|
18
19
|
static fromConfig(options) {
|
|
@@ -37,7 +38,14 @@ class DefaultSearchIndexService {
|
|
|
37
38
|
}
|
|
38
39
|
);
|
|
39
40
|
const { scheduler } = await ((_a = this.indexBuilder) == null ? void 0 : _a.build());
|
|
40
|
-
scheduler
|
|
41
|
+
this.scheduler = scheduler;
|
|
42
|
+
this.scheduler.start();
|
|
43
|
+
}
|
|
44
|
+
async stop() {
|
|
45
|
+
if (this.scheduler) {
|
|
46
|
+
this.scheduler.stop();
|
|
47
|
+
this.scheduler = null;
|
|
48
|
+
}
|
|
41
49
|
}
|
|
42
50
|
getDocumentTypes() {
|
|
43
51
|
var _a, _b;
|
package/dist/alpha.cjs.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"alpha.cjs.js","sources":["../src/alpha.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n coreServices,\n createExtensionPoint,\n createServiceFactory,\n createServiceRef,\n LoggerService,\n} from '@backstage/backend-plugin-api';\nimport { DocumentTypeInfo } from '@backstage/plugin-search-common';\
|
|
1
|
+
{"version":3,"file":"alpha.cjs.js","sources":["../src/alpha.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n coreServices,\n createExtensionPoint,\n createServiceFactory,\n createServiceRef,\n LoggerService,\n} from '@backstage/backend-plugin-api';\nimport { DocumentTypeInfo } from '@backstage/plugin-search-common';\nimport {\n IndexBuilder,\n RegisterCollatorParameters,\n RegisterDecoratorParameters,\n Scheduler,\n SearchEngine,\n} from '@backstage/plugin-search-backend-node';\n\n/**\n * @alpha\n * Options for build method on {@link SearchIndexService}.\n */\nexport type SearchIndexServiceStartOptions = {\n searchEngine: SearchEngine;\n collators: RegisterCollatorParameters[];\n decorators: RegisterDecoratorParameters[];\n};\n\n/**\n * @alpha\n * Interface for implementation of index service.\n */\nexport interface SearchIndexService {\n /**\n * Starts indexing process\n */\n start(options: SearchIndexServiceStartOptions): Promise<void>;\n\n /**\n * Stops indexing process\n */\n stop(): Promise<void>;\n /**\n * Returns an index types list.\n */\n getDocumentTypes(): Record<string, DocumentTypeInfo>;\n}\n\n/**\n * @alpha\n * Interface for search index registry extension point.\n */\nexport interface SearchIndexRegistryExtensionPoint {\n addCollator(options: RegisterCollatorParameters): void;\n addDecorator(options: RegisterDecoratorParameters): void;\n}\n\n/**\n * @alpha\n * Interface for search engine registry extension point.\n */\nexport interface SearchEngineRegistryExtensionPoint {\n setSearchEngine(searchEngine: SearchEngine): void;\n}\n\ntype DefaultSearchIndexServiceOptions = {\n logger: LoggerService;\n};\n\n/**\n * @alpha\n * Reponsible for register the indexing task and start the schedule.\n */\nclass DefaultSearchIndexService implements SearchIndexService {\n private readonly logger: LoggerService;\n private indexBuilder: IndexBuilder | null = null;\n private scheduler: Scheduler | null = null;\n\n private constructor(options: DefaultSearchIndexServiceOptions) {\n this.logger = options.logger;\n }\n\n static fromConfig(options: DefaultSearchIndexServiceOptions) {\n return new DefaultSearchIndexService(options);\n }\n\n async start(options: SearchIndexServiceStartOptions): Promise<void> {\n this.indexBuilder = new IndexBuilder({\n logger: this.logger,\n searchEngine: options.searchEngine,\n });\n\n options.collators.forEach(collator =>\n this.indexBuilder?.addCollator(collator),\n );\n\n options.decorators.forEach(decorator =>\n this.indexBuilder?.addDecorator(decorator),\n );\n\n const { scheduler } = await this.indexBuilder?.build();\n this.scheduler = scheduler;\n this.scheduler!.start();\n }\n\n async stop(): Promise<void> {\n if (this.scheduler) {\n this.scheduler.stop();\n this.scheduler = null;\n }\n }\n\n getDocumentTypes(): Record<string, DocumentTypeInfo> {\n return this.indexBuilder?.getDocumentTypes() ?? {};\n }\n}\n\n/**\n * @alpha\n * Service that builds a search index.\n */\nexport const searchIndexServiceRef = createServiceRef<SearchIndexService>({\n id: 'search.index.service',\n defaultFactory: async service =>\n createServiceFactory({\n service,\n deps: {\n logger: coreServices.logger,\n },\n factory({ logger }) {\n return DefaultSearchIndexService.fromConfig({\n logger,\n });\n },\n }),\n});\n\n/**\n * @alpha\n * Extension point for register a search engine.\n */\nexport const searchEngineRegistryExtensionPoint =\n createExtensionPoint<SearchEngineRegistryExtensionPoint>({\n id: 'search.engine.registry',\n });\n\n/**\n * @alpha\n * Extension point for registering collators and decorators\n */\nexport const searchIndexRegistryExtensionPoint =\n createExtensionPoint<SearchIndexRegistryExtensionPoint>({\n id: 'search.index.registry',\n });\n"],"names":["IndexBuilder","_a","createServiceRef","createServiceFactory","coreServices","createExtensionPoint"],"mappings":";;;;;;;;;;;AAuFA,MAAM,yBAAwD,CAAA;AAAA,EAKpD,YAAY,OAA2C,EAAA;AAJ/D,IAAiB,aAAA,CAAA,IAAA,EAAA,QAAA,CAAA,CAAA;AACjB,IAAA,aAAA,CAAA,IAAA,EAAQ,cAAoC,EAAA,IAAA,CAAA,CAAA;AAC5C,IAAA,aAAA,CAAA,IAAA,EAAQ,WAA8B,EAAA,IAAA,CAAA,CAAA;AAGpC,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA,CAAA;AAAA,GACxB;AAAA,EAEA,OAAO,WAAW,OAA2C,EAAA;AAC3D,IAAO,OAAA,IAAI,0BAA0B,OAAO,CAAA,CAAA;AAAA,GAC9C;AAAA,EAEA,MAAM,MAAM,OAAwD,EAAA;AApGtE,IAAA,IAAA,EAAA,CAAA;AAqGI,IAAK,IAAA,CAAA,YAAA,GAAe,IAAIA,oCAAa,CAAA;AAAA,MACnC,QAAQ,IAAK,CAAA,MAAA;AAAA,MACb,cAAc,OAAQ,CAAA,YAAA;AAAA,KACvB,CAAA,CAAA;AAED,IAAA,OAAA,CAAQ,SAAU,CAAA,OAAA;AAAA,MAAQ,CAAS,QAAA,KAAA;AA1GvC,QAAAC,IAAAA,GAAAA,CAAAA;AA2GM,QAAA,OAAA,CAAAA,GAAA,GAAA,IAAA,CAAK,YAAL,KAAA,IAAA,GAAA,KAAA,CAAA,GAAAA,IAAmB,WAAY,CAAA,QAAA,CAAA,CAAA;AAAA,OAAA;AAAA,KACjC,CAAA;AAEA,IAAA,OAAA,CAAQ,UAAW,CAAA,OAAA;AAAA,MAAQ,CAAU,SAAA,KAAA;AA9GzC,QAAAA,IAAAA,GAAAA,CAAAA;AA+GM,QAAA,OAAA,CAAAA,GAAA,GAAA,IAAA,CAAK,YAAL,KAAA,IAAA,GAAA,KAAA,CAAA,GAAAA,IAAmB,YAAa,CAAA,SAAA,CAAA,CAAA;AAAA,OAAA;AAAA,KAClC,CAAA;AAEA,IAAA,MAAM,EAAE,SAAU,EAAA,GAAI,OAAM,CAAA,EAAA,GAAA,IAAA,CAAK,iBAAL,IAAmB,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,KAAA,EAAA,CAAA,CAAA;AAC/C,IAAA,IAAA,CAAK,SAAY,GAAA,SAAA,CAAA;AACjB,IAAA,IAAA,CAAK,UAAW,KAAM,EAAA,CAAA;AAAA,GACxB;AAAA,EAEA,MAAM,IAAsB,GAAA;AAC1B,IAAA,IAAI,KAAK,SAAW,EAAA;AAClB,MAAA,IAAA,CAAK,UAAU,IAAK,EAAA,CAAA;AACpB,MAAA,IAAA,CAAK,SAAY,GAAA,IAAA,CAAA;AAAA,KACnB;AAAA,GACF;AAAA,EAEA,gBAAqD,GAAA;AA9HvD,IAAA,IAAA,EAAA,EAAA,EAAA,CAAA;AA+HI,IAAA,OAAA,CAAO,EAAK,GAAA,CAAA,EAAA,GAAA,IAAA,CAAA,YAAA,KAAL,IAAmB,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,gBAAA,EAAA,KAAnB,YAAyC,EAAC,CAAA;AAAA,GACnD;AACF,CAAA;AAMO,MAAM,wBAAwBC,iCAAqC,CAAA;AAAA,EACxE,EAAI,EAAA,sBAAA;AAAA,EACJ,cAAA,EAAgB,OAAM,OAAA,KACpBC,qCAAqB,CAAA;AAAA,IACnB,OAAA;AAAA,IACA,IAAM,EAAA;AAAA,MACJ,QAAQC,6BAAa,CAAA,MAAA;AAAA,KACvB;AAAA,IACA,OAAA,CAAQ,EAAE,MAAA,EAAU,EAAA;AAClB,MAAA,OAAO,0BAA0B,UAAW,CAAA;AAAA,QAC1C,MAAA;AAAA,OACD,CAAA,CAAA;AAAA,KACH;AAAA,GACD,CAAA;AACL,CAAC,EAAA;AAMM,MAAM,qCACXC,qCAAyD,CAAA;AAAA,EACvD,EAAI,EAAA,wBAAA;AACN,CAAC,EAAA;AAMI,MAAM,oCACXA,qCAAwD,CAAA;AAAA,EACtD,EAAI,EAAA,uBAAA;AACN,CAAC;;;;;;"}
|
package/dist/alpha.d.ts
CHANGED
package/dist/index.cjs.js
CHANGED
|
@@ -261,7 +261,7 @@ class NewlineDelimitedJsonCollatorFactory {
|
|
|
261
261
|
var __defProp$4 = Object.defineProperty;
|
|
262
262
|
var __defNormalProp$4 = (obj, key, value) => key in obj ? __defProp$4(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
|
|
263
263
|
var __publicField$4 = (obj, key, value) => {
|
|
264
|
-
__defNormalProp$4(obj,
|
|
264
|
+
__defNormalProp$4(obj, key + "" , value);
|
|
265
265
|
return value;
|
|
266
266
|
};
|
|
267
267
|
class MissingIndexError extends Error {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-search-backend-node",
|
|
3
|
-
"version": "1.2.
|
|
3
|
+
"version": "1.2.22-next.0",
|
|
4
4
|
"description": "A library for Backstage backend plugins that want to interact with the search backend plugin",
|
|
5
5
|
"backstage": {
|
|
6
6
|
"role": "node-library"
|
|
@@ -44,9 +44,9 @@
|
|
|
44
44
|
"test": "backstage-cli package test"
|
|
45
45
|
},
|
|
46
46
|
"dependencies": {
|
|
47
|
-
"@backstage/backend-common": "^0.21.
|
|
48
|
-
"@backstage/backend-plugin-api": "^0.6.
|
|
49
|
-
"@backstage/backend-tasks": "^0.5.
|
|
47
|
+
"@backstage/backend-common": "^0.21.8-next.0",
|
|
48
|
+
"@backstage/backend-plugin-api": "^0.6.18-next.0",
|
|
49
|
+
"@backstage/backend-tasks": "^0.5.23-next.0",
|
|
50
50
|
"@backstage/config": "^1.2.0",
|
|
51
51
|
"@backstage/errors": "^1.2.4",
|
|
52
52
|
"@backstage/plugin-permission-common": "^0.7.13",
|
|
@@ -58,8 +58,8 @@
|
|
|
58
58
|
"uuid": "^9.0.0"
|
|
59
59
|
},
|
|
60
60
|
"devDependencies": {
|
|
61
|
-
"@backstage/backend-common": "^0.21.
|
|
62
|
-
"@backstage/cli": "^0.26.
|
|
61
|
+
"@backstage/backend-common": "^0.21.8-next.0",
|
|
62
|
+
"@backstage/cli": "^0.26.5-next.0",
|
|
63
63
|
"@types/ndjson": "^2.0.1"
|
|
64
64
|
}
|
|
65
65
|
}
|