@backstage/plugin-search-backend-module-catalog 0.1.7-next.2 → 0.1.7-next.3

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 CHANGED
@@ -1,5 +1,39 @@
1
1
  # @backstage/plugin-search-backend-module-catalog
2
2
 
3
+ ## 0.1.7-next.3
4
+
5
+ ### Patch Changes
6
+
7
+ - 71114ac50e02: The export for the new backend system has been moved to be the `default` export.
8
+
9
+ For example, if you are currently importing the plugin using the following pattern:
10
+
11
+ ```ts
12
+ import { examplePlugin } from '@backstage/plugin-example-backend';
13
+
14
+ backend.add(examplePlugin);
15
+ ```
16
+
17
+ It should be migrated to this:
18
+
19
+ ```ts
20
+ backend.add(import('@backstage/plugin-example-backend'));
21
+ ```
22
+
23
+ - Updated dependencies
24
+ - @backstage/catalog-client@1.4.4-next.2
25
+ - @backstage/catalog-model@1.4.2-next.2
26
+ - @backstage/config@1.1.0-next.2
27
+ - @backstage/errors@1.2.2-next.0
28
+ - @backstage/plugin-catalog-common@1.0.16-next.2
29
+ - @backstage/plugin-permission-common@0.7.8-next.2
30
+ - @backstage/plugin-search-common@1.2.6-next.2
31
+ - @backstage/backend-plugin-api@0.6.3-next.3
32
+ - @backstage/backend-common@0.19.5-next.3
33
+ - @backstage/backend-tasks@0.5.8-next.3
34
+ - @backstage/plugin-catalog-node@1.4.4-next.3
35
+ - @backstage/plugin-search-backend-node@1.2.7-next.3
36
+
3
37
  ## 0.1.7-next.2
4
38
 
5
39
  ### Patch Changes
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-search-backend-module-catalog",
3
- "version": "0.1.7-next.2",
3
+ "version": "0.1.7-next.3",
4
4
  "main": "../dist/alpha.cjs.js",
5
5
  "types": "../dist/alpha.d.ts"
6
6
  }
package/dist/alpha.cjs.js CHANGED
@@ -3,9 +3,9 @@
3
3
  Object.defineProperty(exports, '__esModule', { value: true });
4
4
 
5
5
  var backendPluginApi = require('@backstage/backend-plugin-api');
6
- var alpha$1 = require('@backstage/plugin-catalog-node/alpha');
6
+ var alpha$2 = require('@backstage/plugin-catalog-node/alpha');
7
7
  var pluginSearchBackendModuleCatalog = require('@backstage/plugin-search-backend-module-catalog');
8
- var alpha = require('@backstage/plugin-search-backend-node/alpha');
8
+ var alpha$1 = require('@backstage/plugin-search-backend-node/alpha');
9
9
  var config = require('./cjs/config-6c7298b0.cjs.js');
10
10
  require('@backstage/backend-tasks');
11
11
  require('@backstage/errors');
@@ -13,7 +13,7 @@ require('@backstage/errors');
13
13
  const catalogCollatorExtensionPoint = backendPluginApi.createExtensionPoint({
14
14
  id: "search.catalogCollator.extension"
15
15
  });
16
- const searchModuleCatalogCollator = backendPluginApi.createBackendModule({
16
+ var alpha = backendPluginApi.createBackendModule({
17
17
  moduleId: "catalogCollator",
18
18
  pluginId: "search",
19
19
  register(env) {
@@ -32,8 +32,8 @@ const searchModuleCatalogCollator = backendPluginApi.createBackendModule({
32
32
  discovery: backendPluginApi.coreServices.discovery,
33
33
  tokenManager: backendPluginApi.coreServices.tokenManager,
34
34
  scheduler: backendPluginApi.coreServices.scheduler,
35
- indexRegistry: alpha.searchIndexRegistryExtensionPoint,
36
- catalog: alpha$1.catalogServiceRef
35
+ indexRegistry: alpha$1.searchIndexRegistryExtensionPoint,
36
+ catalog: alpha$2.catalogServiceRef
37
37
  },
38
38
  async init({
39
39
  config: config$1,
@@ -60,5 +60,5 @@ const searchModuleCatalogCollator = backendPluginApi.createBackendModule({
60
60
  });
61
61
 
62
62
  exports.catalogCollatorExtensionPoint = catalogCollatorExtensionPoint;
63
- exports.searchModuleCatalogCollator = searchModuleCatalogCollator;
63
+ exports["default"] = alpha;
64
64
  //# sourceMappingURL=alpha.cjs.js.map
@@ -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\n/**\n * @packageDocumentation\n * A module for the search backend that exports Catalog modules.\n */\n\nimport {\n coreServices,\n createBackendModule,\n createExtensionPoint,\n} from '@backstage/backend-plugin-api';\nimport { catalogServiceRef } from '@backstage/plugin-catalog-node/alpha';\nimport {\n CatalogCollatorEntityTransformer,\n DefaultCatalogCollatorFactory,\n} from '@backstage/plugin-search-backend-module-catalog';\nimport { searchIndexRegistryExtensionPoint } from '@backstage/plugin-search-backend-node/alpha';\nimport { readScheduleConfigOptions } from './collators/config';\n\n/**\n * Options for {@link catalogCollatorExtensionPoint}.\n *\n * @alpha\n */\nexport type CatalogCollatorExtensionPoint = {\n /**\n * Allows you to customize how entities are shaped into documents.\n */\n setEntityTransformer(transformer: CatalogCollatorEntityTransformer): void;\n};\n\n/**\n * Extension point for customizing how catalog entities are shaped into\n * documents for the search backend, when using\n * {@link searchModuleCatalogCollator}.\n *\n * @alpha\n */\nexport const catalogCollatorExtensionPoint =\n createExtensionPoint<CatalogCollatorExtensionPoint>({\n id: 'search.catalogCollator.extension',\n });\n\n/**\n * Search backend module for the Catalog index.\n *\n * @alpha\n */\nexport const searchModuleCatalogCollator = createBackendModule({\n moduleId: 'catalogCollator',\n pluginId: 'search',\n register(env) {\n let entityTransformer: CatalogCollatorEntityTransformer | undefined;\n\n env.registerExtensionPoint(catalogCollatorExtensionPoint, {\n setEntityTransformer(transformer) {\n if (entityTransformer) {\n throw new Error('setEntityTransformer can only be called once');\n }\n entityTransformer = transformer;\n },\n });\n\n env.registerInit({\n deps: {\n config: coreServices.rootConfig,\n discovery: coreServices.discovery,\n tokenManager: coreServices.tokenManager,\n scheduler: coreServices.scheduler,\n indexRegistry: searchIndexRegistryExtensionPoint,\n catalog: catalogServiceRef,\n },\n async init({\n config,\n discovery,\n tokenManager,\n scheduler,\n indexRegistry,\n catalog,\n }) {\n indexRegistry.addCollator({\n schedule: scheduler.createScheduledTaskRunner(\n readScheduleConfigOptions(config),\n ),\n factory: DefaultCatalogCollatorFactory.fromConfig(config, {\n entityTransformer,\n discovery,\n tokenManager,\n catalogClient: catalog,\n }),\n });\n },\n });\n },\n});\n"],"names":["createExtensionPoint","createBackendModule","coreServices","searchIndexRegistryExtensionPoint","catalogServiceRef","config","readScheduleConfigOptions","DefaultCatalogCollatorFactory"],"mappings":";;;;;;;;;;;;AAqDO,MAAM,gCACXA,qCAAoD,CAAA;AAAA,EAClD,EAAI,EAAA,kCAAA;AACN,CAAC,EAAA;AAOI,MAAM,8BAA8BC,oCAAoB,CAAA;AAAA,EAC7D,QAAU,EAAA,iBAAA;AAAA,EACV,QAAU,EAAA,QAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAI,IAAA,iBAAA,CAAA;AAEJ,IAAA,GAAA,CAAI,uBAAuB,6BAA+B,EAAA;AAAA,MACxD,qBAAqB,WAAa,EAAA;AAChC,QAAA,IAAI,iBAAmB,EAAA;AACrB,UAAM,MAAA,IAAI,MAAM,8CAA8C,CAAA,CAAA;AAAA,SAChE;AACA,QAAoB,iBAAA,GAAA,WAAA,CAAA;AAAA,OACtB;AAAA,KACD,CAAA,CAAA;AAED,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,QAAQC,6BAAa,CAAA,UAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,cAAcA,6BAAa,CAAA,YAAA;AAAA,QAC3B,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,aAAe,EAAAC,uCAAA;AAAA,QACf,OAAS,EAAAC,yBAAA;AAAA,OACX;AAAA,MACA,MAAM,IAAK,CAAA;AAAA,gBACTC,QAAA;AAAA,QACA,SAAA;AAAA,QACA,YAAA;AAAA,QACA,SAAA;AAAA,QACA,aAAA;AAAA,QACA,OAAA;AAAA,OACC,EAAA;AACD,QAAA,aAAA,CAAc,WAAY,CAAA;AAAA,UACxB,UAAU,SAAU,CAAA,yBAAA;AAAA,YAClBC,iCAA0BD,QAAM,CAAA;AAAA,WAClC;AAAA,UACA,OAAA,EAASE,8DAA8B,CAAA,UAAA,CAAWF,QAAQ,EAAA;AAAA,YACxD,iBAAA;AAAA,YACA,SAAA;AAAA,YACA,YAAA;AAAA,YACA,aAAe,EAAA,OAAA;AAAA,WAChB,CAAA;AAAA,SACF,CAAA,CAAA;AAAA,OACH;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;"}
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\n/**\n * @packageDocumentation\n * A module for the search backend that exports Catalog modules.\n */\n\nimport {\n coreServices,\n createBackendModule,\n createExtensionPoint,\n} from '@backstage/backend-plugin-api';\nimport { catalogServiceRef } from '@backstage/plugin-catalog-node/alpha';\nimport {\n CatalogCollatorEntityTransformer,\n DefaultCatalogCollatorFactory,\n} from '@backstage/plugin-search-backend-module-catalog';\nimport { searchIndexRegistryExtensionPoint } from '@backstage/plugin-search-backend-node/alpha';\nimport { readScheduleConfigOptions } from './collators/config';\n\n/**\n * Options for {@link catalogCollatorExtensionPoint}.\n *\n * @alpha\n */\nexport type CatalogCollatorExtensionPoint = {\n /**\n * Allows you to customize how entities are shaped into documents.\n */\n setEntityTransformer(transformer: CatalogCollatorEntityTransformer): void;\n};\n\n/**\n * Extension point for customizing how catalog entities are shaped into\n * documents for the search backend.\n *\n * @alpha\n */\nexport const catalogCollatorExtensionPoint =\n createExtensionPoint<CatalogCollatorExtensionPoint>({\n id: 'search.catalogCollator.extension',\n });\n\n/**\n * Search backend module for the Catalog index.\n *\n * @alpha\n */\nexport default createBackendModule({\n moduleId: 'catalogCollator',\n pluginId: 'search',\n register(env) {\n let entityTransformer: CatalogCollatorEntityTransformer | undefined;\n\n env.registerExtensionPoint(catalogCollatorExtensionPoint, {\n setEntityTransformer(transformer) {\n if (entityTransformer) {\n throw new Error('setEntityTransformer can only be called once');\n }\n entityTransformer = transformer;\n },\n });\n\n env.registerInit({\n deps: {\n config: coreServices.rootConfig,\n discovery: coreServices.discovery,\n tokenManager: coreServices.tokenManager,\n scheduler: coreServices.scheduler,\n indexRegistry: searchIndexRegistryExtensionPoint,\n catalog: catalogServiceRef,\n },\n async init({\n config,\n discovery,\n tokenManager,\n scheduler,\n indexRegistry,\n catalog,\n }) {\n indexRegistry.addCollator({\n schedule: scheduler.createScheduledTaskRunner(\n readScheduleConfigOptions(config),\n ),\n factory: DefaultCatalogCollatorFactory.fromConfig(config, {\n entityTransformer,\n discovery,\n tokenManager,\n catalogClient: catalog,\n }),\n });\n },\n });\n },\n});\n"],"names":["createExtensionPoint","createBackendModule","coreServices","searchIndexRegistryExtensionPoint","catalogServiceRef","config","readScheduleConfigOptions","DefaultCatalogCollatorFactory"],"mappings":";;;;;;;;;;;;AAoDO,MAAM,gCACXA,qCAAoD,CAAA;AAAA,EAClD,EAAI,EAAA,kCAAA;AACN,CAAC,EAAA;AAOH,YAAeC,oCAAoB,CAAA;AAAA,EACjC,QAAU,EAAA,iBAAA;AAAA,EACV,QAAU,EAAA,QAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAI,IAAA,iBAAA,CAAA;AAEJ,IAAA,GAAA,CAAI,uBAAuB,6BAA+B,EAAA;AAAA,MACxD,qBAAqB,WAAa,EAAA;AAChC,QAAA,IAAI,iBAAmB,EAAA;AACrB,UAAM,MAAA,IAAI,MAAM,8CAA8C,CAAA,CAAA;AAAA,SAChE;AACA,QAAoB,iBAAA,GAAA,WAAA,CAAA;AAAA,OACtB;AAAA,KACD,CAAA,CAAA;AAED,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,QAAQC,6BAAa,CAAA,UAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,cAAcA,6BAAa,CAAA,YAAA;AAAA,QAC3B,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,aAAe,EAAAC,yCAAA;AAAA,QACf,OAAS,EAAAC,yBAAA;AAAA,OACX;AAAA,MACA,MAAM,IAAK,CAAA;AAAA,gBACTC,QAAA;AAAA,QACA,SAAA;AAAA,QACA,YAAA;AAAA,QACA,SAAA;AAAA,QACA,aAAA;AAAA,QACA,OAAA;AAAA,OACC,EAAA;AACD,QAAA,aAAA,CAAc,WAAY,CAAA;AAAA,UACxB,UAAU,SAAU,CAAA,yBAAA;AAAA,YAClBC,iCAA0BD,QAAM,CAAA;AAAA,WAClC;AAAA,UACA,OAAA,EAASE,8DAA8B,CAAA,UAAA,CAAWF,QAAQ,EAAA;AAAA,YACxD,iBAAA;AAAA,YACA,SAAA;AAAA,YACA,YAAA;AAAA,YACA,aAAe,EAAA,OAAA;AAAA,WAChB,CAAA;AAAA,SACF,CAAA,CAAA;AAAA,OACH;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC,CAAA;;;;;"}
package/dist/alpha.d.ts CHANGED
@@ -14,8 +14,7 @@ type CatalogCollatorExtensionPoint = {
14
14
  };
15
15
  /**
16
16
  * Extension point for customizing how catalog entities are shaped into
17
- * documents for the search backend, when using
18
- * {@link searchModuleCatalogCollator}.
17
+ * documents for the search backend.
19
18
  *
20
19
  * @alpha
21
20
  */
@@ -25,6 +24,6 @@ declare const catalogCollatorExtensionPoint: _backstage_backend_plugin_api.Exten
25
24
  *
26
25
  * @alpha
27
26
  */
28
- declare const searchModuleCatalogCollator: () => _backstage_backend_plugin_api.BackendFeature;
27
+ declare const _default: () => _backstage_backend_plugin_api.BackendFeature;
29
28
 
30
- export { CatalogCollatorExtensionPoint, catalogCollatorExtensionPoint, searchModuleCatalogCollator };
29
+ export { CatalogCollatorExtensionPoint, catalogCollatorExtensionPoint, _default as default };
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@backstage/plugin-search-backend-module-catalog",
3
3
  "description": "A module for the search backend that exports catalog modules",
4
- "version": "0.1.7-next.2",
4
+ "version": "0.1.7-next.3",
5
5
  "main": "./dist/index.cjs.js",
6
6
  "types": "./dist/index.d.ts",
7
7
  "license": "Apache-2.0",
@@ -40,23 +40,23 @@
40
40
  "clean": "backstage-cli package clean"
41
41
  },
42
42
  "dependencies": {
43
- "@backstage/backend-common": "^0.19.5-next.2",
44
- "@backstage/backend-plugin-api": "^0.6.3-next.2",
45
- "@backstage/backend-tasks": "^0.5.8-next.2",
46
- "@backstage/catalog-client": "^1.4.4-next.1",
47
- "@backstage/catalog-model": "^1.4.2-next.1",
48
- "@backstage/config": "^1.1.0-next.1",
49
- "@backstage/errors": "^1.2.1",
50
- "@backstage/plugin-catalog-common": "^1.0.16-next.1",
51
- "@backstage/plugin-catalog-node": "^1.4.4-next.2",
52
- "@backstage/plugin-permission-common": "^0.7.8-next.1",
53
- "@backstage/plugin-search-backend-node": "^1.2.7-next.2",
54
- "@backstage/plugin-search-common": "^1.2.6-next.1"
43
+ "@backstage/backend-common": "^0.19.5-next.3",
44
+ "@backstage/backend-plugin-api": "^0.6.3-next.3",
45
+ "@backstage/backend-tasks": "^0.5.8-next.3",
46
+ "@backstage/catalog-client": "^1.4.4-next.2",
47
+ "@backstage/catalog-model": "^1.4.2-next.2",
48
+ "@backstage/config": "^1.1.0-next.2",
49
+ "@backstage/errors": "^1.2.2-next.0",
50
+ "@backstage/plugin-catalog-common": "^1.0.16-next.2",
51
+ "@backstage/plugin-catalog-node": "^1.4.4-next.3",
52
+ "@backstage/plugin-permission-common": "^0.7.8-next.2",
53
+ "@backstage/plugin-search-backend-node": "^1.2.7-next.3",
54
+ "@backstage/plugin-search-common": "^1.2.6-next.2"
55
55
  },
56
56
  "devDependencies": {
57
- "@backstage/backend-common": "^0.19.5-next.2",
58
- "@backstage/backend-test-utils": "^0.2.3-next.2",
59
- "@backstage/cli": "^0.22.13-next.2",
57
+ "@backstage/backend-common": "^0.19.5-next.3",
58
+ "@backstage/backend-test-utils": "^0.2.3-next.3",
59
+ "@backstage/cli": "^0.22.13-next.3",
60
60
  "msw": "^1.0.0"
61
61
  },
62
62
  "files": [