@backstage/plugin-catalog-node 2.2.1-next.0 → 2.2.1-next.1

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @backstage/plugin-catalog-node
 
+## 2.2.1-next.1
+
+### Patch Changes
+
+- ab1cdbb: Removed a handful of internal imports that referenced the package by its own name. Value imports were switched to relative paths, and type-only imports to `import type`. These self-referential imports could trigger circular initialization errors in bundled ESM and when the package was loaded via `jest.requireActual` — most visibly `Cannot access '_AppRootElementBlueprintesm' before initialization` from `@backstage/frontend-plugin-api`. There are no user-facing API changes.
+- Updated dependencies
+  - @backstage/catalog-model@1.8.1-next.1
+  - @backstage/backend-test-utils@1.11.3-next.1
+  - @backstage/plugin-permission-common@0.9.9-next.1
+
 ## 2.2.1-next.0
 
 ### Patch Changes

package/dist/extensions.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"extensions.cjs.js","sources":["../src/extensions.ts"],"sourcesContent":["/*\n * Copyright 2022 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 { createExtensionPoint } from '@backstage/backend-plugin-api';\nimport { Entity, Validators } from '@backstage/catalog-model';\nimport { CatalogModelSource } from '@backstage/catalog-model/alpha';\nimport {\n  CatalogProcessor,\n  CatalogProcessorParser,\n  EntityProvider,\n  LocationAnalyzer,\n  PlaceholderResolver,\n  ScmLocationAnalyzer,\n} from '@backstage/plugin-catalog-node';\n\n/**\n * @public\n */\nexport interface CatalogLocationsExtensionPoint {\n  /**\n   * Allows setting custom location types, such as showcased in: https://backstage.io/docs/features/software-catalog/external-integrations/#creating-a-catalog-data-reader-processor\n   * @param locationTypes - List of location types to allow, default is \"url\" and \"file\"\n   */\n  setAllowedLocationTypes(locationTypes: Array<string>): void;\n}\n\n/**\n * @public\n */\nexport const catalogLocationsExtensionPoint =\n  createExtensionPoint<CatalogLocationsExtensionPoint>({\n    id: 'catalog.locations',\n  });\n\n/**\n * @public\n */\nexport interface CatalogProcessingExtensionPoint {\n  /**\n   * Adds entity processors. These are responsible for reading, parsing, and\n   * processing entities before they are persisted in the catalog.\n   *\n   * This function also can replace a Default processor if the provided processor\n   * matches the processor name.\n   *\n   * @param processors - One or more processors\n   */\n  addProcessor(\n    ...processors: Array<CatalogProcessor | Array<CatalogProcessor>>\n  ): void;\n\n  /**\n   * Adds or replaces entity providers. These are responsible for bootstrapping\n   * the list of entities out of original data sources. For example, there is\n   * one entity source for the config locations, and one for the database\n   * stored locations. If you ingest entities out of a third party system, you\n   * may want to implement that in terms of an entity provider as well.\n   *\n   * @param providers - One or more entity providers\n   */\n  addEntityProvider(\n    ...providers: Array<EntityProvider | Array<EntityProvider>>\n  ): void;\n\n  /**\n   * Adds, or overwrites, a handler for placeholders (e.g. $file) in entity\n   * definition files.\n   *\n   * @param key - The key that identifies the placeholder, e.g. \"file\"\n   * @param resolver - The resolver that gets values for this placeholder\n   */\n  addPlaceholderResolver(key: string, resolver: PlaceholderResolver): void;\n\n  setOnProcessingErrorHandler(\n    handler: (event: {\n      unprocessedEntity: Entity;\n      errors: Error[];\n    }) => Promise<void> | void,\n  ): void;\n}\n\n/** @alpha */\nexport interface CatalogModelExtensionPoint {\n  /**\n   * Sets the validator function to use for one or more special fields of an\n   * entity. This is useful if the default rules for formatting of fields are\n   * not sufficient.\n   *\n   * @param validators - The (subset of) validators to set\n   */\n  setFieldValidators(validators: Partial<Validators>): void;\n\n  /**\n   * Sets the entity data parser which is used to read raw data from locations.\n   *\n   * @param parser - Parser which will used to extract entities from raw data\n   */\n  setEntityDataParser(parser: CatalogProcessorParser): void;\n\n  /**\n   * Adds a catalog model source to be part of the compiled entity model.\n   *\n   * @param source - The model source to add\n   */\n  addModelSource(source: CatalogModelSource): void;\n}\n\n/**\n * @public\n */\nexport const catalogProcessingExtensionPoint =\n  createExtensionPoint<CatalogProcessingExtensionPoint>({\n    id: 'catalog.processing',\n  });\n\n/**\n * @public\n */\nexport interface CatalogAnalysisExtensionPoint {\n  /**\n   * Replaces the entire location analyzer with a new one.\n   *\n   * @remarks\n   *\n   * By providing a factory function you can access all the SCM analyzers that\n   * have been added through `addScmLocationAnalyzer`. If you provide a\n   * `LocationAnalyzer` directly, the SCM analyzers will be ignored.\n   */\n  setLocationAnalyzer(\n    analyzerOrFactory:\n      | LocationAnalyzer\n      | ((options: {\n          scmLocationAnalyzers: ScmLocationAnalyzer[];\n        }) => Promise<{ locationAnalyzer: LocationAnalyzer }>),\n  ): void;\n\n  /**\n   * Adds an analyzer for a specific SCM type to the default location analyzer.\n   */\n  addScmLocationAnalyzer(analyzer: ScmLocationAnalyzer): void;\n}\n\n/**\n * @public\n */\nexport const catalogAnalysisExtensionPoint =\n  createExtensionPoint<CatalogAnalysisExtensionPoint>({\n    id: 'catalog.analysis',\n  });\n\n/** @alpha */\nexport const catalogModelExtensionPoint =\n  createExtensionPoint<CatalogModelExtensionPoint>({\n    id: 'catalog.model',\n  });\n"],"names":["createExtensionPoint"],"mappings":";;;;AA0CO,MAAM,iCACXA,qCAAA,CAAqD;AAAA,EACnD,EAAA,EAAI;AACN,CAAC;AA8EI,MAAM,kCACXA,qCAAA,CAAsD;AAAA,EACpD,EAAA,EAAI;AACN,CAAC;AAgCI,MAAM,gCACXA,qCAAA,CAAoD;AAAA,EAClD,EAAA,EAAI;AACN,CAAC;AAGI,MAAM,6BACXA,qCAAA,CAAiD;AAAA,EAC/C,EAAA,EAAI;AACN,CAAC;;;;;;;"}
+{"version":3,"file":"extensions.cjs.js","sources":["../src/extensions.ts"],"sourcesContent":["/*\n * Copyright 2022 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 { createExtensionPoint } from '@backstage/backend-plugin-api';\nimport { Entity, Validators } from '@backstage/catalog-model';\nimport { CatalogModelSource } from '@backstage/catalog-model/alpha';\nimport type {\n  CatalogProcessor,\n  CatalogProcessorParser,\n  EntityProvider,\n  LocationAnalyzer,\n  PlaceholderResolver,\n  ScmLocationAnalyzer,\n} from '@backstage/plugin-catalog-node';\n\n/**\n * @public\n */\nexport interface CatalogLocationsExtensionPoint {\n  /**\n   * Allows setting custom location types, such as showcased in: https://backstage.io/docs/features/software-catalog/external-integrations/#creating-a-catalog-data-reader-processor\n   * @param locationTypes - List of location types to allow, default is \"url\" and \"file\"\n   */\n  setAllowedLocationTypes(locationTypes: Array<string>): void;\n}\n\n/**\n * @public\n */\nexport const catalogLocationsExtensionPoint =\n  createExtensionPoint<CatalogLocationsExtensionPoint>({\n    id: 'catalog.locations',\n  });\n\n/**\n * @public\n */\nexport interface CatalogProcessingExtensionPoint {\n  /**\n   * Adds entity processors. These are responsible for reading, parsing, and\n   * processing entities before they are persisted in the catalog.\n   *\n   * This function also can replace a Default processor if the provided processor\n   * matches the processor name.\n   *\n   * @param processors - One or more processors\n   */\n  addProcessor(\n    ...processors: Array<CatalogProcessor | Array<CatalogProcessor>>\n  ): void;\n\n  /**\n   * Adds or replaces entity providers. These are responsible for bootstrapping\n   * the list of entities out of original data sources. For example, there is\n   * one entity source for the config locations, and one for the database\n   * stored locations. If you ingest entities out of a third party system, you\n   * may want to implement that in terms of an entity provider as well.\n   *\n   * @param providers - One or more entity providers\n   */\n  addEntityProvider(\n    ...providers: Array<EntityProvider | Array<EntityProvider>>\n  ): void;\n\n  /**\n   * Adds, or overwrites, a handler for placeholders (e.g. $file) in entity\n   * definition files.\n   *\n   * @param key - The key that identifies the placeholder, e.g. \"file\"\n   * @param resolver - The resolver that gets values for this placeholder\n   */\n  addPlaceholderResolver(key: string, resolver: PlaceholderResolver): void;\n\n  setOnProcessingErrorHandler(\n    handler: (event: {\n      unprocessedEntity: Entity;\n      errors: Error[];\n    }) => Promise<void> | void,\n  ): void;\n}\n\n/** @alpha */\nexport interface CatalogModelExtensionPoint {\n  /**\n   * Sets the validator function to use for one or more special fields of an\n   * entity. This is useful if the default rules for formatting of fields are\n   * not sufficient.\n   *\n   * @param validators - The (subset of) validators to set\n   */\n  setFieldValidators(validators: Partial<Validators>): void;\n\n  /**\n   * Sets the entity data parser which is used to read raw data from locations.\n   *\n   * @param parser - Parser which will used to extract entities from raw data\n   */\n  setEntityDataParser(parser: CatalogProcessorParser): void;\n\n  /**\n   * Adds a catalog model source to be part of the compiled entity model.\n   *\n   * @param source - The model source to add\n   */\n  addModelSource(source: CatalogModelSource): void;\n}\n\n/**\n * @public\n */\nexport const catalogProcessingExtensionPoint =\n  createExtensionPoint<CatalogProcessingExtensionPoint>({\n    id: 'catalog.processing',\n  });\n\n/**\n * @public\n */\nexport interface CatalogAnalysisExtensionPoint {\n  /**\n   * Replaces the entire location analyzer with a new one.\n   *\n   * @remarks\n   *\n   * By providing a factory function you can access all the SCM analyzers that\n   * have been added through `addScmLocationAnalyzer`. If you provide a\n   * `LocationAnalyzer` directly, the SCM analyzers will be ignored.\n   */\n  setLocationAnalyzer(\n    analyzerOrFactory:\n      | LocationAnalyzer\n      | ((options: {\n          scmLocationAnalyzers: ScmLocationAnalyzer[];\n        }) => Promise<{ locationAnalyzer: LocationAnalyzer }>),\n  ): void;\n\n  /**\n   * Adds an analyzer for a specific SCM type to the default location analyzer.\n   */\n  addScmLocationAnalyzer(analyzer: ScmLocationAnalyzer): void;\n}\n\n/**\n * @public\n */\nexport const catalogAnalysisExtensionPoint =\n  createExtensionPoint<CatalogAnalysisExtensionPoint>({\n    id: 'catalog.analysis',\n  });\n\n/** @alpha */\nexport const catalogModelExtensionPoint =\n  createExtensionPoint<CatalogModelExtensionPoint>({\n    id: 'catalog.model',\n  });\n"],"names":["createExtensionPoint"],"mappings":";;;;AA0CO,MAAM,iCACXA,qCAAA,CAAqD;AAAA,EACnD,EAAA,EAAI;AACN,CAAC;AA8EI,MAAM,kCACXA,qCAAA,CAAsD;AAAA,EACpD,EAAA,EAAI;AACN,CAAC;AAgCI,MAAM,gCACXA,qCAAA,CAAoD;AAAA,EAClD,EAAA,EAAI;AACN,CAAC;AAGI,MAAM,6BACXA,qCAAA,CAAiD;AAAA,EAC/C,EAAA,EAAI;AACN,CAAC;;;;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-node",
-  "version": "2.2.1-next.0",
+  "version": "2.2.1-next.1",
   "description": "The plugin-catalog-node module for @backstage/plugin-catalog-backend",
   "backstage": {
     "role": "node-library",
@@ -74,10 +74,10 @@
   "dependencies": {
     "@backstage/backend-plugin-api": "1.9.1-next.0",
     "@backstage/catalog-client": "1.15.1-next.0",
-    "@backstage/catalog-model": "1.8.1-next.0",
+    "@backstage/catalog-model": "1.8.1-next.1",
     "@backstage/errors": "1.3.1-next.0",
     "@backstage/plugin-catalog-common": "1.1.10-next.0",
-    "@backstage/plugin-permission-common": "0.9.9-next.0",
+    "@backstage/plugin-permission-common": "0.9.9-next.1",
     "@backstage/plugin-permission-node": "0.10.13-next.0",
     "@backstage/types": "1.2.2",
     "@opentelemetry/api": "^1.9.0",
@@ -85,12 +85,12 @@
     "yaml": "^2.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "1.11.3-next.0",
-    "@backstage/cli": "0.36.2-next.0",
+    "@backstage/backend-test-utils": "1.11.3-next.1",
+    "@backstage/cli": "0.36.2-next.1",
     "msw": "^1.0.0"
   },
   "peerDependencies": {
-    "@backstage/backend-test-utils": "1.11.3-next.0"
+    "@backstage/backend-test-utils": "1.11.3-next.1"
   },
   "peerDependenciesMeta": {
     "@backstage/backend-test-utils": {