@backstage/plugin-search-backend-module-catalog 0.2.5 → 0.2.6-next.1

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.
Files changed (5) hide show
  1. package/CHANGELOG.md +33 -0
  2. package/README.md +5 -11
  3. package/dist/module.cjs.js +4 -4
  4. package/dist/module.cjs.js.map +1 -1
  5. package/package.json +13 -13
package/CHANGELOG.md CHANGED
@@ -1,5 +1,38 @@
1
1
  # @backstage/plugin-search-backend-module-catalog
2
2
 
3
+ ## 0.2.6-next.1
4
+
5
+ ### Patch Changes
6
+
7
+ - Updated dependencies
8
+ - @backstage/plugin-catalog-node@1.15.0-next.1
9
+ - @backstage/catalog-client@1.9.0-next.1
10
+ - @backstage/plugin-search-backend-node@1.3.6-next.1
11
+ - @backstage/backend-plugin-api@1.1.0-next.1
12
+ - @backstage/catalog-model@1.7.1
13
+ - @backstage/config@1.3.0
14
+ - @backstage/errors@1.2.5
15
+ - @backstage/plugin-catalog-common@1.1.1
16
+ - @backstage/plugin-permission-common@0.8.2
17
+ - @backstage/plugin-search-common@1.2.15
18
+
19
+ ## 0.2.6-next.0
20
+
21
+ ### Patch Changes
22
+
23
+ - ed0aaec: Update README
24
+ - Updated dependencies
25
+ - @backstage/backend-plugin-api@1.0.3-next.0
26
+ - @backstage/catalog-client@1.8.1-next.0
27
+ - @backstage/catalog-model@1.7.1
28
+ - @backstage/config@1.3.0
29
+ - @backstage/errors@1.2.5
30
+ - @backstage/plugin-catalog-common@1.1.1
31
+ - @backstage/plugin-catalog-node@1.14.1-next.0
32
+ - @backstage/plugin-permission-common@0.8.2
33
+ - @backstage/plugin-search-backend-node@1.3.6-next.0
34
+ - @backstage/plugin-search-common@1.2.15
35
+
3
36
  ## 0.2.5
4
37
 
5
38
  ### Patch Changes
package/README.md CHANGED
@@ -16,12 +16,10 @@ Add the collator to your backend instance, along with the search plugin itself:
16
16
  ```tsx
17
17
  // packages/backend/src/index.ts
18
18
  import { createBackend } from '@backstage/backend-defaults';
19
- import { searchPlugin } from '@backstage/plugin-search-backend/alpha';
20
- import { searchModuleCatalogCollator } from '@backstage/plugin-search-backend-module-catalog/alpha';
21
19
 
22
20
  const backend = createBackend();
23
- backend.add(searchPlugin);
24
- backend.add(searchModuleCatalogCollator);
21
+ backend.add(import('@backstage/plugin-search-backend'));
22
+ backend.add(import('@backstage/plugin-search-backend-module-catalog'));
25
23
  backend.start();
26
24
  ```
27
25
 
@@ -35,12 +33,8 @@ This module also has an extension point, which lets you inject advanced customiz
35
33
  // packages/backend/src/index.ts
36
34
  import { createBackend } from '@backstage/backend-defaults';
37
35
  import { createBackendModule } from '@backstage/backend-plugin-api';
38
- import { searchPlugin } from '@backstage/plugin-search-backend/alpha';
39
36
  import { CatalogCollatorEntityTransformer } from '@backstage/plugin-search-backend-module-catalog';
40
- import {
41
- searchModuleCatalogCollator,
42
- catalogCollatorExtensionPoint,
43
- } from '@backstage/plugin-search-backend-module-catalog/alpha';
37
+ import { catalogCollatorExtensionPoint } from '@backstage/plugin-search-backend-module-catalog/alpha';
44
38
 
45
39
  const customTransformer: CatalogCollatorEntityTransformer = entity => ({
46
40
  title: entity.metadata.title || entity.metadata.name,
@@ -54,8 +48,8 @@ const customTransformer: CatalogCollatorEntityTransformer = entity => ({
54
48
  });
55
49
 
56
50
  const backend = createBackend();
57
- backend.add(searchPlugin);
58
- backend.add(searchModuleCatalogCollator);
51
+ backend.add(import('@backstage/plugin-search-backend'));
52
+ backend.add(import('@backstage/plugin-search-backend-module-catalog'));
59
53
  backend.add(
60
54
  createBackendModule({
61
55
  pluginId: 'search',
package/dist/module.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 = require('@backstage/plugin-catalog-node/alpha');
6
+ var alpha$1 = require('@backstage/plugin-catalog-node/alpha');
7
7
  var pluginSearchBackendModuleCatalog = require('@backstage/plugin-search-backend-module-catalog');
8
- var alpha$1 = require('@backstage/plugin-search-backend-node/alpha');
8
+ var alpha = require('@backstage/plugin-search-backend-node/alpha');
9
9
  var config = require('./collators/config.cjs.js');
10
10
 
11
11
  const catalogCollatorExtensionPoint = backendPluginApi.createExtensionPoint({
@@ -30,8 +30,8 @@ var feature = backendPluginApi.createBackendModule({
30
30
  config: backendPluginApi.coreServices.rootConfig,
31
31
  discovery: backendPluginApi.coreServices.discovery,
32
32
  scheduler: backendPluginApi.coreServices.scheduler,
33
- indexRegistry: alpha$1.searchIndexRegistryExtensionPoint,
34
- catalog: alpha.catalogServiceRef
33
+ indexRegistry: alpha.searchIndexRegistryExtensionPoint,
34
+ catalog: alpha$1.catalogServiceRef
35
35
  },
36
36
  async init({
37
37
  auth,
package/dist/module.cjs.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"module.cjs.js","sources":["../src/module.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 * @public\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 * @public\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 * @public\n */\nexport default createBackendModule({\n pluginId: 'search',\n moduleId: 'catalog-collator',\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 auth: coreServices.auth,\n config: coreServices.rootConfig,\n discovery: coreServices.discovery,\n scheduler: coreServices.scheduler,\n indexRegistry: searchIndexRegistryExtensionPoint,\n catalog: catalogServiceRef,\n },\n async init({\n auth,\n config,\n discovery,\n scheduler,\n indexRegistry,\n catalog,\n }) {\n indexRegistry.addCollator({\n schedule: scheduler.createScheduledTaskRunner(\n readScheduleConfigOptions(config),\n ),\n factory: DefaultCatalogCollatorFactory.fromConfig(config, {\n auth,\n entityTransformer,\n discovery,\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;AACN,CAAC;AAOH,cAAeC,oCAAoB,CAAA;AAAA,EACjC,QAAU,EAAA,QAAA;AAAA,EACV,QAAU,EAAA,kBAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAI,IAAA,iBAAA;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;AAAA;AAEhE,QAAoB,iBAAA,GAAA,WAAA;AAAA;AACtB,KACD,CAAA;AAED,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,MAAMC,6BAAa,CAAA,IAAA;AAAA,QACnB,QAAQA,6BAAa,CAAA,UAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,aAAe,EAAAC,yCAAA;AAAA,QACf,OAAS,EAAAC;AAAA,OACX;AAAA,MACA,MAAM,IAAK,CAAA;AAAA,QACT,IAAA;AAAA,gBACAC,QAAA;AAAA,QACA,SAAA;AAAA,QACA,SAAA;AAAA,QACA,aAAA;AAAA,QACA;AAAA,OACC,EAAA;AACD,QAAA,aAAA,CAAc,WAAY,CAAA;AAAA,UACxB,UAAU,SAAU,CAAA,yBAAA;AAAA,YAClBC,iCAA0BD,QAAM;AAAA,WAClC;AAAA,UACA,OAAA,EAASE,8DAA8B,CAAA,UAAA,CAAWF,QAAQ,EAAA;AAAA,YACxD,IAAA;AAAA,YACA,iBAAA;AAAA,YACA,SAAA;AAAA,YACA,aAAe,EAAA;AAAA,WAChB;AAAA,SACF,CAAA;AAAA;AACH,KACD,CAAA;AAAA;AAEL,CAAC,CAAA;;;;;"}
1
+ {"version":3,"file":"module.cjs.js","sources":["../src/module.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 * @public\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 * @public\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 * @public\n */\nexport default createBackendModule({\n pluginId: 'search',\n moduleId: 'catalog-collator',\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 auth: coreServices.auth,\n config: coreServices.rootConfig,\n discovery: coreServices.discovery,\n scheduler: coreServices.scheduler,\n indexRegistry: searchIndexRegistryExtensionPoint,\n catalog: catalogServiceRef,\n },\n async init({\n auth,\n config,\n discovery,\n scheduler,\n indexRegistry,\n catalog,\n }) {\n indexRegistry.addCollator({\n schedule: scheduler.createScheduledTaskRunner(\n readScheduleConfigOptions(config),\n ),\n factory: DefaultCatalogCollatorFactory.fromConfig(config, {\n auth,\n entityTransformer,\n discovery,\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;AACN,CAAC;AAOH,cAAeC,oCAAoB,CAAA;AAAA,EACjC,QAAU,EAAA,QAAA;AAAA,EACV,QAAU,EAAA,kBAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAI,IAAA,iBAAA;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;AAAA;AAEhE,QAAoB,iBAAA,GAAA,WAAA;AAAA;AACtB,KACD,CAAA;AAED,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,MAAMC,6BAAa,CAAA,IAAA;AAAA,QACnB,QAAQA,6BAAa,CAAA,UAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,aAAe,EAAAC,uCAAA;AAAA,QACf,OAAS,EAAAC;AAAA,OACX;AAAA,MACA,MAAM,IAAK,CAAA;AAAA,QACT,IAAA;AAAA,gBACAC,QAAA;AAAA,QACA,SAAA;AAAA,QACA,SAAA;AAAA,QACA,aAAA;AAAA,QACA;AAAA,OACC,EAAA;AACD,QAAA,aAAA,CAAc,WAAY,CAAA;AAAA,UACxB,UAAU,SAAU,CAAA,yBAAA;AAAA,YAClBC,iCAA0BD,QAAM;AAAA,WAClC;AAAA,UACA,OAAA,EAASE,8DAA8B,CAAA,UAAA,CAAWF,QAAQ,EAAA;AAAA,YACxD,IAAA;AAAA,YACA,iBAAA;AAAA,YACA,SAAA;AAAA,YACA,aAAe,EAAA;AAAA,WAChB;AAAA,SACF,CAAA;AAAA;AACH,KACD,CAAA;AAAA;AAEL,CAAC,CAAA;;;;;"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-search-backend-module-catalog",
3
- "version": "0.2.5",
3
+ "version": "0.2.6-next.1",
4
4
  "description": "A module for the search backend that exports catalog modules",
5
5
  "backstage": {
6
6
  "role": "backend-plugin-module",
@@ -59,21 +59,21 @@
59
59
  },
60
60
  "dependencies": {
61
61
  "@backstage/backend-common": "^0.25.0",
62
- "@backstage/backend-plugin-api": "^1.0.2",
63
- "@backstage/catalog-client": "^1.8.0",
64
- "@backstage/catalog-model": "^1.7.1",
65
- "@backstage/config": "^1.3.0",
66
- "@backstage/errors": "^1.2.5",
67
- "@backstage/plugin-catalog-common": "^1.1.1",
68
- "@backstage/plugin-catalog-node": "^1.14.0",
69
- "@backstage/plugin-permission-common": "^0.8.2",
70
- "@backstage/plugin-search-backend-node": "^1.3.5",
71
- "@backstage/plugin-search-common": "^1.2.15"
62
+ "@backstage/backend-plugin-api": "1.1.0-next.1",
63
+ "@backstage/catalog-client": "1.9.0-next.1",
64
+ "@backstage/catalog-model": "1.7.1",
65
+ "@backstage/config": "1.3.0",
66
+ "@backstage/errors": "1.2.5",
67
+ "@backstage/plugin-catalog-common": "1.1.1",
68
+ "@backstage/plugin-catalog-node": "1.15.0-next.1",
69
+ "@backstage/plugin-permission-common": "0.8.2",
70
+ "@backstage/plugin-search-backend-node": "1.3.6-next.1",
71
+ "@backstage/plugin-search-common": "1.2.15"
72
72
  },
73
73
  "devDependencies": {
74
74
  "@backstage/backend-common": "^0.25.0",
75
- "@backstage/backend-test-utils": "^1.1.0",
76
- "@backstage/cli": "^0.29.0",
75
+ "@backstage/backend-test-utils": "1.2.0-next.1",
76
+ "@backstage/cli": "0.29.3-next.1",
77
77
  "msw": "^1.0.0"
78
78
  },
79
79
  "configSchema": "config.d.ts"