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

package/CHANGELOG.md

@@ -1,5 +1,40 @@
 # @backstage/plugin-catalog-node
 
+## 1.21.0-next.0
+
+### Minor Changes
+
+- cfd8103: Promoted stable catalog extension points from alpha to main export. The following extension points are now exported from `@backstage/plugin-catalog-node` instead of `@backstage/plugin-catalog-node/alpha`:
+
+  - `catalogLocationsExtensionPoint` and `CatalogLocationsExtensionPoint`
+  - `catalogProcessingExtensionPoint` and `CatalogProcessingExtensionPoint`
+  - `catalogAnalysisExtensionPoint` and `CatalogAnalysisExtensionPoint`
+
+  The old alpha exports for these extension points are now deprecated with `@deprecated` markers pointing to the new stable exports. Please update your imports from `@backstage/plugin-catalog-node/alpha` to `@backstage/plugin-catalog-node`.
+
+  Note: The `catalogModelExtensionPoint`, `catalogPermissionExtensionPoint`, and related types remain in alpha.
+
+### Patch Changes
+
+- 7455dae: Use node prefix on native imports
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.7.0-next.0
+  - @backstage/plugin-permission-common@0.9.5-next.0
+  - @backstage/plugin-permission-node@0.10.9-next.0
+  - @backstage/catalog-client@1.12.1
+  - @backstage/catalog-model@1.7.6
+  - @backstage/errors@1.2.7
+  - @backstage/types@1.2.2
+  - @backstage/plugin-catalog-common@1.1.8-next.0
+
+## 1.20.1
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/plugin-permission-node@0.10.7
+  - @backstage/backend-plugin-api@1.6.0
+
 ## 1.20.1-next.1
 
 ### Patch Changes

package/dist/alpha.cjs.js

@@ -4,6 +4,7 @@ var backendPluginApi = require('@backstage/backend-plugin-api');
 var catalogClient = require('@backstage/catalog-client');
 var alpha = require('@backstage/plugin-catalog-common/alpha');
 var pluginPermissionNode = require('@backstage/plugin-permission-node');
+var pluginCatalogNode = require('@backstage/plugin-catalog-node');
 var extensions = require('./extensions.cjs.js');
 
 const catalogEntityPermissionResourceRef = pluginPermissionNode.createPermissionResourceRef().with({
@@ -22,12 +23,15 @@ const catalogServiceRef = backendPluginApi.createServiceRef({
     }
   })
 });
+const catalogLocationsExtensionPoint = pluginCatalogNode.catalogLocationsExtensionPoint;
+const catalogProcessingExtensionPoint = pluginCatalogNode.catalogProcessingExtensionPoint;
+const catalogAnalysisExtensionPoint = pluginCatalogNode.catalogAnalysisExtensionPoint;
 
-exports.catalogAnalysisExtensionPoint = extensions.catalogAnalysisExtensionPoint;
-exports.catalogLocationsExtensionPoint = extensions.catalogLocationsExtensionPoint;
 exports.catalogModelExtensionPoint = extensions.catalogModelExtensionPoint;
 exports.catalogPermissionExtensionPoint = extensions.catalogPermissionExtensionPoint;
-exports.catalogProcessingExtensionPoint = extensions.catalogProcessingExtensionPoint;
+exports.catalogAnalysisExtensionPoint = catalogAnalysisExtensionPoint;
 exports.catalogEntityPermissionResourceRef = catalogEntityPermissionResourceRef;
+exports.catalogLocationsExtensionPoint = catalogLocationsExtensionPoint;
+exports.catalogProcessingExtensionPoint = catalogProcessingExtensionPoint;
 exports.catalogServiceRef = catalogServiceRef;
 //# sourceMappingURL=alpha.cjs.js.map

package/dist/alpha.cjs.js.map

@@ -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  createServiceFactory,\n  createServiceRef,\n} from '@backstage/backend-plugin-api';\nimport { catalogServiceRef as _catalogServiceRef } from './catalogService';\nimport { CatalogApi, CatalogClient } from '@backstage/catalog-client';\nimport { RESOURCE_TYPE_CATALOG_ENTITY } from '@backstage/plugin-catalog-common/alpha';\nimport { createPermissionResourceRef } from '@backstage/plugin-permission-node';\nimport { Entity } from '@backstage/catalog-model';\nimport { EntitiesSearchFilter } from '@backstage/plugin-catalog-node';\n\n/** @alpha */\nexport const catalogEntityPermissionResourceRef = createPermissionResourceRef<\n  Entity,\n  EntitiesSearchFilter\n>().with({\n  pluginId: 'catalog',\n  resourceType: RESOURCE_TYPE_CATALOG_ENTITY,\n});\n\n/**\n * @alpha\n * @deprecated Use {@link @backstage/plugin-catalog-node#catalogServiceRef} instead\n */\nexport const catalogServiceRef = createServiceRef<CatalogApi>({\n  id: 'catalog-client-legacy',\n  defaultFactory: async service =>\n    createServiceFactory({\n      service,\n      deps: {\n        discoveryApi: coreServices.discovery,\n      },\n      async factory({ discoveryApi }) {\n        return new CatalogClient({ discoveryApi });\n      },\n    }),\n});\n\nexport type { CatalogLocationsExtensionPoint } from './extensions';\nexport { catalogLocationsExtensionPoint } from './extensions';\nexport type { CatalogProcessingExtensionPoint } from './extensions';\nexport { catalogProcessingExtensionPoint } from './extensions';\nexport type { CatalogAnalysisExtensionPoint } from './extensions';\nexport { catalogAnalysisExtensionPoint } from './extensions';\nexport type { CatalogPermissionRuleInput } from './extensions';\nexport type { CatalogPermissionExtensionPoint } from './extensions';\nexport { catalogPermissionExtensionPoint } from './extensions';\nexport type { CatalogModelExtensionPoint } from './extensions';\nexport { catalogModelExtensionPoint } from './extensions';\n"],"names":["createPermissionResourceRef","RESOURCE_TYPE_CATALOG_ENTITY","createServiceRef","createServiceFactory","coreServices","CatalogClient"],"mappings":";;;;;;;;AA6BO,MAAM,kCAAA,GAAqCA,gDAAA,EAGhD,CAAE,IAAA,CAAK;AAAA,EACP,QAAA,EAAU,SAAA;AAAA,EACV,YAAA,EAAcC;AAChB,CAAC;AAMM,MAAM,oBAAoBC,iCAAA,CAA6B;AAAA,EAC5D,EAAA,EAAI,uBAAA;AAAA,EACJ,cAAA,EAAgB,OAAM,OAAA,KACpBC,qCAAA,CAAqB;AAAA,IACnB,OAAA;AAAA,IACA,IAAA,EAAM;AAAA,MACJ,cAAcC,6BAAA,CAAa;AAAA,KAC7B;AAAA,IACA,MAAM,OAAA,CAAQ,EAAE,YAAA,EAAa,EAAG;AAC9B,MAAA,OAAO,IAAIC,2BAAA,CAAc,EAAE,YAAA,EAAc,CAAA;AAAA,IAC3C;AAAA,GACD;AACL,CAAC;;;;;;;;;;"}
+{"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  createServiceFactory,\n  createServiceRef,\n} from '@backstage/backend-plugin-api';\nimport { catalogServiceRef as _catalogServiceRef } from './catalogService';\nimport { CatalogApi, CatalogClient } from '@backstage/catalog-client';\nimport { RESOURCE_TYPE_CATALOG_ENTITY } from '@backstage/plugin-catalog-common/alpha';\nimport { createPermissionResourceRef } from '@backstage/plugin-permission-node';\nimport { Entity } from '@backstage/catalog-model';\nimport { EntitiesSearchFilter } from '@backstage/plugin-catalog-node';\n\n/** @alpha */\nexport const catalogEntityPermissionResourceRef = createPermissionResourceRef<\n  Entity,\n  EntitiesSearchFilter\n>().with({\n  pluginId: 'catalog',\n  resourceType: RESOURCE_TYPE_CATALOG_ENTITY,\n});\n\n/**\n * @alpha\n * @deprecated Use {@link @backstage/plugin-catalog-node#catalogServiceRef} instead\n */\nexport const catalogServiceRef = createServiceRef<CatalogApi>({\n  id: 'catalog-client-legacy',\n  defaultFactory: async service =>\n    createServiceFactory({\n      service,\n      deps: {\n        discoveryApi: coreServices.discovery,\n      },\n      async factory({ discoveryApi }) {\n        return new CatalogClient({ discoveryApi });\n      },\n    }),\n});\n\nimport {\n  CatalogLocationsExtensionPoint as _CatalogLocationsExtensionPoint,\n  CatalogProcessingExtensionPoint as _CatalogProcessingExtensionPoint,\n  CatalogAnalysisExtensionPoint as _CatalogAnalysisExtensionPoint,\n  catalogLocationsExtensionPoint as _catalogLocationsExtensionPoint,\n  catalogProcessingExtensionPoint as _catalogProcessingExtensionPoint,\n  catalogAnalysisExtensionPoint as _catalogAnalysisExtensionPoint,\n} from '@backstage/plugin-catalog-node';\n\n/**\n * @alpha\n * @deprecated Use {@link @backstage/plugin-catalog-node#CatalogLocationsExtensionPoint} instead\n */\nexport type CatalogLocationsExtensionPoint = _CatalogLocationsExtensionPoint;\n\n/**\n * @alpha\n * @deprecated Use {@link @backstage/plugin-catalog-node#catalogLocationsExtensionPoint} instead\n */\nexport const catalogLocationsExtensionPoint = _catalogLocationsExtensionPoint;\n\n/**\n * @alpha\n * @deprecated Use {@link @backstage/plugin-catalog-node#CatalogProcessingExtensionPoint} instead\n */\nexport type CatalogProcessingExtensionPoint = _CatalogProcessingExtensionPoint;\n\n/**\n * @alpha\n * @deprecated Use {@link @backstage/plugin-catalog-node#catalogProcessingExtensionPoint} instead\n */\nexport const catalogProcessingExtensionPoint = _catalogProcessingExtensionPoint;\n\n/**\n * @alpha\n * @deprecated Use {@link @backstage/plugin-catalog-node#CatalogAnalysisExtensionPoint} instead\n */\nexport type CatalogAnalysisExtensionPoint = _CatalogAnalysisExtensionPoint;\n\n/**\n * @alpha\n * @deprecated Use {@link @backstage/plugin-catalog-node#catalogAnalysisExtensionPoint} instead\n */\nexport const catalogAnalysisExtensionPoint = _catalogAnalysisExtensionPoint;\n\nexport type { CatalogModelExtensionPoint } from './extensions';\nexport { catalogModelExtensionPoint } from './extensions';\nexport type { CatalogPermissionRuleInput } from './extensions';\nexport type { CatalogPermissionExtensionPoint } from './extensions';\nexport { catalogPermissionExtensionPoint } from './extensions';\n"],"names":["createPermissionResourceRef","RESOURCE_TYPE_CATALOG_ENTITY","createServiceRef","createServiceFactory","coreServices","CatalogClient","_catalogLocationsExtensionPoint","_catalogProcessingExtensionPoint","_catalogAnalysisExtensionPoint"],"mappings":";;;;;;;;;AA6BO,MAAM,kCAAA,GAAqCA,gDAAA,EAGhD,CAAE,IAAA,CAAK;AAAA,EACP,QAAA,EAAU,SAAA;AAAA,EACV,YAAA,EAAcC;AAChB,CAAC;AAMM,MAAM,oBAAoBC,iCAAA,CAA6B;AAAA,EAC5D,EAAA,EAAI,uBAAA;AAAA,EACJ,cAAA,EAAgB,OAAM,OAAA,KACpBC,qCAAA,CAAqB;AAAA,IACnB,OAAA;AAAA,IACA,IAAA,EAAM;AAAA,MACJ,cAAcC,6BAAA,CAAa;AAAA,KAC7B;AAAA,IACA,MAAM,OAAA,CAAQ,EAAE,YAAA,EAAa,EAAG;AAC9B,MAAA,OAAO,IAAIC,2BAAA,CAAc,EAAE,YAAA,EAAc,CAAA;AAAA,IAC3C;AAAA,GACD;AACL,CAAC;AAqBM,MAAM,8BAAA,GAAiCC;AAYvC,MAAM,+BAAA,GAAkCC;AAYxC,MAAM,6BAAA,GAAgCC;;;;;;;;;;"}

package/dist/alpha.d.ts

@@ -1,137 +1,49 @@
 import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
 import * as _backstage_plugin_permission_node from '@backstage/plugin-permission-node';
-import { PermissionRule } from '@backstage/plugin-permission-node';
 import { CatalogApi } from '@backstage/catalog-client';
-import { Entity, Validators } from '@backstage/catalog-model';
-import { CatalogProcessor, EntityProvider, PlaceholderResolver, LocationAnalyzer, ScmLocationAnalyzer, EntitiesSearchFilter, CatalogProcessorParser } from '@backstage/plugin-catalog-node';
-import { PermissionRuleParams, Permission } from '@backstage/plugin-permission-common';
+import { Entity } from '@backstage/catalog-model';
+import { EntitiesSearchFilter, CatalogLocationsExtensionPoint as CatalogLocationsExtensionPoint$1, CatalogProcessingExtensionPoint as CatalogProcessingExtensionPoint$1, CatalogAnalysisExtensionPoint as CatalogAnalysisExtensionPoint$1 } from '@backstage/plugin-catalog-node';
+export { f as CatalogModelExtensionPoint, i as CatalogPermissionExtensionPoint, h as CatalogPermissionRuleInput, g as catalogModelExtensionPoint, j as catalogPermissionExtensionPoint } from './types/extensions.d-Cvnx6_V0.js';
+import '@backstage/plugin-permission-common';
 
-/**
- * @alpha
- */
-interface CatalogLocationsExtensionPoint {
-    /**
-     * Allows setting custom location types, such as showcased in: https://backstage.io/docs/features/software-catalog/external-integrations/#creating-a-catalog-data-reader-processor
-     * @param locationTypes - List of location types to allow, default is "url" and "file"
-     */
-    setAllowedLocationTypes(locationTypes: Array<string>): void;
-}
-/**
- * @alpha
- */
-declare const catalogLocationsExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<CatalogLocationsExtensionPoint>;
-/**
- * @alpha
- */
-interface CatalogProcessingExtensionPoint {
-    /**
-     * Adds entity processors. These are responsible for reading, parsing, and
-     * processing entities before they are persisted in the catalog.
-     *
-     * This function also can replace a Default processor if the provided processor
-     * matches the processor name.
-     *
-     * @param processors - One or more processors
-     */
-    addProcessor(...processors: Array<CatalogProcessor | Array<CatalogProcessor>>): void;
-    /**
-     * Adds or replaces entity providers. These are responsible for bootstrapping
-     * the list of entities out of original data sources. For example, there is
-     * one entity source for the config locations, and one for the database
-     * stored locations. If you ingest entities out of a third party system, you
-     * may want to implement that in terms of an entity provider as well.
-     *
-     * @param providers - One or more entity providers
-     */
-    addEntityProvider(...providers: Array<EntityProvider | Array<EntityProvider>>): void;
-    /**
-     * Adds, or overwrites, a handler for placeholders (e.g. $file) in entity
-     * definition files.
-     *
-     * @param key - The key that identifies the placeholder, e.g. "file"
-     * @param resolver - The resolver that gets values for this placeholder
-     */
-    addPlaceholderResolver(key: string, resolver: PlaceholderResolver): void;
-    setOnProcessingErrorHandler(handler: (event: {
-        unprocessedEntity: Entity;
-        errors: Error[];
-    }) => Promise<void> | void): void;
-}
 /** @alpha */
-interface CatalogModelExtensionPoint {
-    /**
-     * Sets the validator function to use for one or more special fields of an
-     * entity. This is useful if the default rules for formatting of fields are
-     * not sufficient.
-     *
-     * @param validators - The (subset of) validators to set
-     */
-    setFieldValidators(validators: Partial<Validators>): void;
-    /**
-     * Sets the entity data parser which is used to read raw data from locations
-     * @param parser - Parser which will used to extract entities from raw data
-     */
-    setEntityDataParser(parser: CatalogProcessorParser): void;
-}
+declare const catalogEntityPermissionResourceRef: _backstage_plugin_permission_node.PermissionResourceRef<Entity, EntitiesSearchFilter, "catalog-entity", "catalog">;
 /**
  * @alpha
+ * @deprecated Use {@link @backstage/plugin-catalog-node#catalogServiceRef} instead
  */
-declare const catalogProcessingExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<CatalogProcessingExtensionPoint>;
+declare const catalogServiceRef: _backstage_backend_plugin_api.ServiceRef<CatalogApi, "plugin", "singleton">;
+
 /**
  * @alpha
+ * @deprecated Use {@link @backstage/plugin-catalog-node#CatalogLocationsExtensionPoint} instead
  */
-interface CatalogAnalysisExtensionPoint {
-    /**
-     * Replaces the entire location analyzer with a new one.
-     *
-     * @remarks
-     *
-     * By providing a factory function you can access all the SCM analyzers that
-     * have been added through `addScmLocationAnalyzer`. If you provide a
-     * `LocationAnalyzer` directly, the SCM analyzers will be ignored.
-     */
-    setLocationAnalyzer(analyzerOrFactory: LocationAnalyzer | ((options: {
-        scmLocationAnalyzers: ScmLocationAnalyzer[];
-    }) => Promise<{
-        locationAnalyzer: LocationAnalyzer;
-    }>)): void;
-    /**
-     * Adds an analyzer for a specific SCM type to the default location analyzer.
-     */
-    addScmLocationAnalyzer(analyzer: ScmLocationAnalyzer): void;
-}
+type CatalogLocationsExtensionPoint = CatalogLocationsExtensionPoint$1;
 /**
  * @alpha
+ * @deprecated Use {@link @backstage/plugin-catalog-node#catalogLocationsExtensionPoint} instead
  */
-declare const catalogAnalysisExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<CatalogAnalysisExtensionPoint>;
-/** @alpha */
-declare const catalogModelExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<CatalogModelExtensionPoint>;
+declare const catalogLocationsExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<CatalogLocationsExtensionPoint$1>;
 /**
  * @alpha
- * @deprecated Use the `coreServices.permissionsRegistry` instead.
+ * @deprecated Use {@link @backstage/plugin-catalog-node#CatalogProcessingExtensionPoint} instead
  */
-type CatalogPermissionRuleInput<TParams extends PermissionRuleParams = PermissionRuleParams> = PermissionRule<Entity, EntitiesSearchFilter, 'catalog-entity', TParams>;
+type CatalogProcessingExtensionPoint = CatalogProcessingExtensionPoint$1;
 /**
  * @alpha
- * @deprecated Use the `coreServices.permissionsRegistry` instead.
+ * @deprecated Use {@link @backstage/plugin-catalog-node#catalogProcessingExtensionPoint} instead
  */
-interface CatalogPermissionExtensionPoint {
-    addPermissions(...permissions: Array<Permission | Array<Permission>>): void;
-    addPermissionRules(...rules: Array<CatalogPermissionRuleInput | Array<CatalogPermissionRuleInput>>): void;
-}
+declare const catalogProcessingExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<CatalogProcessingExtensionPoint$1>;
 /**
  * @alpha
- * @deprecated Use the `coreServices.permissionsRegistry` instead.
+ * @deprecated Use {@link @backstage/plugin-catalog-node#CatalogAnalysisExtensionPoint} instead
  */
-declare const catalogPermissionExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<CatalogPermissionExtensionPoint>;
-
-/** @alpha */
-declare const catalogEntityPermissionResourceRef: _backstage_plugin_permission_node.PermissionResourceRef<Entity, EntitiesSearchFilter, "catalog-entity", "catalog">;
+type CatalogAnalysisExtensionPoint = CatalogAnalysisExtensionPoint$1;
 /**
  * @alpha
- * @deprecated Use {@link @backstage/plugin-catalog-node#catalogServiceRef} instead
+ * @deprecated Use {@link @backstage/plugin-catalog-node#catalogAnalysisExtensionPoint} instead
  */
-declare const catalogServiceRef: _backstage_backend_plugin_api.ServiceRef<CatalogApi, "plugin", "singleton">;
+declare const catalogAnalysisExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<CatalogAnalysisExtensionPoint$1>;
 
-export { catalogAnalysisExtensionPoint, catalogEntityPermissionResourceRef, catalogLocationsExtensionPoint, catalogModelExtensionPoint, catalogPermissionExtensionPoint, catalogProcessingExtensionPoint, catalogServiceRef };
-export type { CatalogAnalysisExtensionPoint, CatalogLocationsExtensionPoint, CatalogModelExtensionPoint, CatalogPermissionExtensionPoint, CatalogPermissionRuleInput, CatalogProcessingExtensionPoint };
+export { catalogAnalysisExtensionPoint, catalogEntityPermissionResourceRef, catalogLocationsExtensionPoint, catalogProcessingExtensionPoint, catalogServiceRef };
+export type { CatalogAnalysisExtensionPoint, CatalogLocationsExtensionPoint, CatalogProcessingExtensionPoint };

package/dist/conversion.cjs.js

@@ -1,10 +1,10 @@
 'use strict';
 
 var catalogModel = require('@backstage/catalog-model');
-var crypto = require('crypto');
+var node_crypto = require('node:crypto');
 
 function locationSpecToMetadataName(location) {
-  const hash = crypto.createHash("sha1").update(`${location.type}:${location.target}`).digest("hex");
+  const hash = node_crypto.createHash("sha1").update(`${location.type}:${location.target}`).digest("hex");
   return `generated-${hash}`;
 }
 function locationSpecToLocationEntity(opts) {

package/dist/conversion.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"conversion.cjs.js","sources":["../src/conversion.ts"],"sourcesContent":["/*\n * Copyright 2021 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  Entity,\n  LocationEntityV1alpha1,\n  ANNOTATION_LOCATION,\n  ANNOTATION_ORIGIN_LOCATION,\n  stringifyEntityRef,\n  stringifyLocationRef,\n} from '@backstage/catalog-model';\nimport { createHash } from 'crypto';\nimport { LocationSpec } from '@backstage/plugin-catalog-common';\n\n/**\n * A standard way of producing a machine generated name for a location.\n *\n * @public\n */\nexport function locationSpecToMetadataName(location: LocationSpec) {\n  const hash = createHash('sha1')\n    .update(`${location.type}:${location.target}`)\n    .digest('hex');\n  return `generated-${hash}`;\n}\n\n/**\n * A standard way of producing a machine generated Location kind entity for a\n * location.\n *\n * @public\n */\nexport function locationSpecToLocationEntity(opts: {\n  location: LocationSpec;\n  parentEntity?: Entity;\n}): LocationEntityV1alpha1 {\n  const location = opts.location;\n  const parentEntity = opts.parentEntity;\n\n  let ownLocation: string;\n  let originLocation: string;\n  if (parentEntity) {\n    const maybeOwnLocation =\n      parentEntity.metadata.annotations?.[ANNOTATION_LOCATION];\n    if (!maybeOwnLocation) {\n      throw new Error(\n        `Parent entity '${stringifyEntityRef(\n          parentEntity,\n        )}' of location '${stringifyLocationRef(\n          location,\n        )}' does not have a location annotation`,\n      );\n    }\n    ownLocation = maybeOwnLocation;\n    const maybeOriginLocation =\n      parentEntity.metadata.annotations?.[ANNOTATION_ORIGIN_LOCATION];\n    if (!maybeOriginLocation) {\n      throw new Error(\n        `Parent entity '${stringifyEntityRef(\n          parentEntity,\n        )}' of location '${stringifyLocationRef(\n          location,\n        )}' does not have an origin location annotation`,\n      );\n    }\n    originLocation = maybeOriginLocation;\n  } else {\n    ownLocation = stringifyLocationRef(location);\n    originLocation = ownLocation;\n  }\n\n  const result: LocationEntityV1alpha1 = {\n    apiVersion: 'backstage.io/v1alpha1',\n    kind: 'Location',\n    metadata: {\n      name: locationSpecToMetadataName(location),\n      annotations: {\n        [ANNOTATION_LOCATION]: ownLocation,\n        [ANNOTATION_ORIGIN_LOCATION]: originLocation,\n      },\n    },\n    spec: {\n      type: location.type,\n      target: location.target,\n      presence: location.presence,\n    },\n  };\n\n  return result;\n}\n"],"names":["createHash","ANNOTATION_LOCATION","stringifyEntityRef","stringifyLocationRef","ANNOTATION_ORIGIN_LOCATION"],"mappings":";;;;;AAgCO,SAAS,2BAA2B,QAAA,EAAwB;AACjE,EAAA,MAAM,IAAA,GAAOA,iBAAA,CAAW,MAAM,CAAA,CAC3B,OAAO,CAAA,EAAG,QAAA,CAAS,IAAI,CAAA,CAAA,EAAI,QAAA,CAAS,MAAM,CAAA,CAAE,CAAA,CAC5C,OAAO,KAAK,CAAA;AACf,EAAA,OAAO,aAAa,IAAI,CAAA,CAAA;AAC1B;AAQO,SAAS,6BAA6B,IAAA,EAGlB;AACzB,EAAA,MAAM,WAAW,IAAA,CAAK,QAAA;AACtB,EAAA,MAAM,eAAe,IAAA,CAAK,YAAA;AAE1B,EAAA,IAAI,WAAA;AACJ,EAAA,IAAI,cAAA;AACJ,EAAA,IAAI,YAAA,EAAc;AAChB,IAAA,MAAM,gBAAA,GACJ,YAAA,CAAa,QAAA,CAAS,WAAA,GAAcC,gCAAmB,CAAA;AACzD,IAAA,IAAI,CAAC,gBAAA,EAAkB;AACrB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,eAAA,EAAkBC,+BAAA;AAAA,UAChB;AAAA,SACD,CAAA,eAAA,EAAkBC,iCAAA;AAAA,UACjB;AAAA,SACD,CAAA,qCAAA;AAAA,OACH;AAAA,IACF;AACA,IAAA,WAAA,GAAc,gBAAA;AACd,IAAA,MAAM,mBAAA,GACJ,YAAA,CAAa,QAAA,CAAS,WAAA,GAAcC,uCAA0B,CAAA;AAChE,IAAA,IAAI,CAAC,mBAAA,EAAqB;AACxB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,eAAA,EAAkBF,+BAAA;AAAA,UAChB;AAAA,SACD,CAAA,eAAA,EAAkBC,iCAAA;AAAA,UACjB;AAAA,SACD,CAAA,6CAAA;AAAA,OACH;AAAA,IACF;AACA,IAAA,cAAA,GAAiB,mBAAA;AAAA,EACnB,CAAA,MAAO;AACL,IAAA,WAAA,GAAcA,kCAAqB,QAAQ,CAAA;AAC3C,IAAA,cAAA,GAAiB,WAAA;AAAA,EACnB;AAEA,EAAA,MAAM,MAAA,GAAiC;AAAA,IACrC,UAAA,EAAY,uBAAA;AAAA,IACZ,IAAA,EAAM,UAAA;AAAA,IACN,QAAA,EAAU;AAAA,MACR,IAAA,EAAM,2BAA2B,QAAQ,CAAA;AAAA,MACzC,WAAA,EAAa;AAAA,QACX,CAACF,gCAAmB,GAAG,WAAA;AAAA,QACvB,CAACG,uCAA0B,GAAG;AAAA;AAChC,KACF;AAAA,IACA,IAAA,EAAM;AAAA,MACJ,MAAM,QAAA,CAAS,IAAA;AAAA,MACf,QAAQ,QAAA,CAAS,MAAA;AAAA,MACjB,UAAU,QAAA,CAAS;AAAA;AACrB,GACF;AAEA,EAAA,OAAO,MAAA;AACT;;;;;"}
+{"version":3,"file":"conversion.cjs.js","sources":["../src/conversion.ts"],"sourcesContent":["/*\n * Copyright 2021 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  Entity,\n  LocationEntityV1alpha1,\n  ANNOTATION_LOCATION,\n  ANNOTATION_ORIGIN_LOCATION,\n  stringifyEntityRef,\n  stringifyLocationRef,\n} from '@backstage/catalog-model';\nimport { createHash } from 'node:crypto';\nimport { LocationSpec } from '@backstage/plugin-catalog-common';\n\n/**\n * A standard way of producing a machine generated name for a location.\n *\n * @public\n */\nexport function locationSpecToMetadataName(location: LocationSpec) {\n  const hash = createHash('sha1')\n    .update(`${location.type}:${location.target}`)\n    .digest('hex');\n  return `generated-${hash}`;\n}\n\n/**\n * A standard way of producing a machine generated Location kind entity for a\n * location.\n *\n * @public\n */\nexport function locationSpecToLocationEntity(opts: {\n  location: LocationSpec;\n  parentEntity?: Entity;\n}): LocationEntityV1alpha1 {\n  const location = opts.location;\n  const parentEntity = opts.parentEntity;\n\n  let ownLocation: string;\n  let originLocation: string;\n  if (parentEntity) {\n    const maybeOwnLocation =\n      parentEntity.metadata.annotations?.[ANNOTATION_LOCATION];\n    if (!maybeOwnLocation) {\n      throw new Error(\n        `Parent entity '${stringifyEntityRef(\n          parentEntity,\n        )}' of location '${stringifyLocationRef(\n          location,\n        )}' does not have a location annotation`,\n      );\n    }\n    ownLocation = maybeOwnLocation;\n    const maybeOriginLocation =\n      parentEntity.metadata.annotations?.[ANNOTATION_ORIGIN_LOCATION];\n    if (!maybeOriginLocation) {\n      throw new Error(\n        `Parent entity '${stringifyEntityRef(\n          parentEntity,\n        )}' of location '${stringifyLocationRef(\n          location,\n        )}' does not have an origin location annotation`,\n      );\n    }\n    originLocation = maybeOriginLocation;\n  } else {\n    ownLocation = stringifyLocationRef(location);\n    originLocation = ownLocation;\n  }\n\n  const result: LocationEntityV1alpha1 = {\n    apiVersion: 'backstage.io/v1alpha1',\n    kind: 'Location',\n    metadata: {\n      name: locationSpecToMetadataName(location),\n      annotations: {\n        [ANNOTATION_LOCATION]: ownLocation,\n        [ANNOTATION_ORIGIN_LOCATION]: originLocation,\n      },\n    },\n    spec: {\n      type: location.type,\n      target: location.target,\n      presence: location.presence,\n    },\n  };\n\n  return result;\n}\n"],"names":["createHash","ANNOTATION_LOCATION","stringifyEntityRef","stringifyLocationRef","ANNOTATION_ORIGIN_LOCATION"],"mappings":";;;;;AAgCO,SAAS,2BAA2B,QAAA,EAAwB;AACjE,EAAA,MAAM,IAAA,GAAOA,sBAAA,CAAW,MAAM,CAAA,CAC3B,OAAO,CAAA,EAAG,QAAA,CAAS,IAAI,CAAA,CAAA,EAAI,QAAA,CAAS,MAAM,CAAA,CAAE,CAAA,CAC5C,OAAO,KAAK,CAAA;AACf,EAAA,OAAO,aAAa,IAAI,CAAA,CAAA;AAC1B;AAQO,SAAS,6BAA6B,IAAA,EAGlB;AACzB,EAAA,MAAM,WAAW,IAAA,CAAK,QAAA;AACtB,EAAA,MAAM,eAAe,IAAA,CAAK,YAAA;AAE1B,EAAA,IAAI,WAAA;AACJ,EAAA,IAAI,cAAA;AACJ,EAAA,IAAI,YAAA,EAAc;AAChB,IAAA,MAAM,gBAAA,GACJ,YAAA,CAAa,QAAA,CAAS,WAAA,GAAcC,gCAAmB,CAAA;AACzD,IAAA,IAAI,CAAC,gBAAA,EAAkB;AACrB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,eAAA,EAAkBC,+BAAA;AAAA,UAChB;AAAA,SACD,CAAA,eAAA,EAAkBC,iCAAA;AAAA,UACjB;AAAA,SACD,CAAA,qCAAA;AAAA,OACH;AAAA,IACF;AACA,IAAA,WAAA,GAAc,gBAAA;AACd,IAAA,MAAM,mBAAA,GACJ,YAAA,CAAa,QAAA,CAAS,WAAA,GAAcC,uCAA0B,CAAA;AAChE,IAAA,IAAI,CAAC,mBAAA,EAAqB;AACxB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,eAAA,EAAkBF,+BAAA;AAAA,UAChB;AAAA,SACD,CAAA,eAAA,EAAkBC,iCAAA;AAAA,UACjB;AAAA,SACD,CAAA,6CAAA;AAAA,OACH;AAAA,IACF;AACA,IAAA,cAAA,GAAiB,mBAAA;AAAA,EACnB,CAAA,MAAO;AACL,IAAA,WAAA,GAAcA,kCAAqB,QAAQ,CAAA;AAC3C,IAAA,cAAA,GAAiB,WAAA;AAAA,EACnB;AAEA,EAAA,MAAM,MAAA,GAAiC;AAAA,IACrC,UAAA,EAAY,uBAAA;AAAA,IACZ,IAAA,EAAM,UAAA;AAAA,IACN,QAAA,EAAU;AAAA,MACR,IAAA,EAAM,2BAA2B,QAAQ,CAAA;AAAA,MACzC,WAAA,EAAa;AAAA,QACX,CAACF,gCAAmB,GAAG,WAAA;AAAA,QACvB,CAACG,uCAA0B,GAAG;AAAA;AAChC,KACF;AAAA,IACA,IAAA,EAAM;AAAA,MACJ,MAAM,QAAA,CAAS,IAAA;AAAA,MACf,QAAQ,QAAA,CAAS,MAAA;AAAA,MACjB,UAAU,QAAA,CAAS;AAAA;AACrB,GACF;AAEA,EAAA,OAAO,MAAA;AACT;;;;;"}

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 {\n  CatalogProcessor,\n  CatalogProcessorParser,\n  EntitiesSearchFilter,\n  EntityProvider,\n  PlaceholderResolver,\n  LocationAnalyzer,\n  ScmLocationAnalyzer,\n} from '@backstage/plugin-catalog-node';\nimport {\n  Permission,\n  PermissionRuleParams,\n} from '@backstage/plugin-permission-common';\nimport { PermissionRule } from '@backstage/plugin-permission-node';\n\n/**\n * @alpha\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 * @alpha\n */\nexport const catalogLocationsExtensionPoint =\n  createExtensionPoint<CatalogLocationsExtensionPoint>({\n    id: 'catalog.locations',\n  });\n\n/**\n * @alpha\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   * @param parser - Parser which will used to extract entities from raw data\n   */\n  setEntityDataParser(parser: CatalogProcessorParser): void;\n}\n\n/**\n * @alpha\n */\nexport const catalogProcessingExtensionPoint =\n  createExtensionPoint<CatalogProcessingExtensionPoint>({\n    id: 'catalog.processing',\n  });\n\n/**\n * @alpha\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 * @alpha\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\n/**\n * @alpha\n * @deprecated Use the `coreServices.permissionsRegistry` instead.\n */\nexport type CatalogPermissionRuleInput<\n  TParams extends PermissionRuleParams = PermissionRuleParams,\n> = PermissionRule<Entity, EntitiesSearchFilter, 'catalog-entity', TParams>;\n\n/**\n * @alpha\n * @deprecated Use the `coreServices.permissionsRegistry` instead.\n */\nexport interface CatalogPermissionExtensionPoint {\n  addPermissions(...permissions: Array<Permission | Array<Permission>>): void;\n  addPermissionRules(\n    ...rules: Array<\n      CatalogPermissionRuleInput | Array<CatalogPermissionRuleInput>\n    >\n  ): void;\n}\n\n/**\n * @alpha\n * @deprecated Use the `coreServices.permissionsRegistry` instead.\n */\nexport const catalogPermissionExtensionPoint =\n  createExtensionPoint<CatalogPermissionExtensionPoint>({\n    id: 'catalog.permission',\n  });\n"],"names":["createExtensionPoint"],"mappings":";;;;AA+CO,MAAM,iCACXA,qCAAA,CAAqD;AAAA,EACnD,EAAA,EAAI;AACN,CAAC;AAsEI,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;AA2BI,MAAM,kCACXA,qCAAA,CAAsD;AAAA,EACpD,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 {\n  CatalogProcessor,\n  CatalogProcessorParser,\n  EntitiesSearchFilter,\n  EntityProvider,\n  PlaceholderResolver,\n  LocationAnalyzer,\n  ScmLocationAnalyzer,\n} from '@backstage/plugin-catalog-node';\nimport {\n  Permission,\n  PermissionRuleParams,\n} from '@backstage/plugin-permission-common';\nimport { PermissionRule } from '@backstage/plugin-permission-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   * @param parser - Parser which will used to extract entities from raw data\n   */\n  setEntityDataParser(parser: CatalogProcessorParser): 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\n/**\n * @alpha\n * @deprecated Use the `coreServices.permissionsRegistry` instead.\n */\nexport type CatalogPermissionRuleInput<\n  TParams extends PermissionRuleParams = PermissionRuleParams,\n> = PermissionRule<Entity, EntitiesSearchFilter, 'catalog-entity', TParams>;\n\n/**\n * @alpha\n * @deprecated Use the `coreServices.permissionsRegistry` instead.\n */\nexport interface CatalogPermissionExtensionPoint {\n  addPermissions(...permissions: Array<Permission | Array<Permission>>): void;\n  addPermissionRules(\n    ...rules: Array<\n      CatalogPermissionRuleInput | Array<CatalogPermissionRuleInput>\n    >\n  ): void;\n}\n\n/**\n * @alpha\n * @deprecated Use the `coreServices.permissionsRegistry` instead.\n */\nexport const catalogPermissionExtensionPoint =\n  createExtensionPoint<CatalogPermissionExtensionPoint>({\n    id: 'catalog.permission',\n  });\n"],"names":["createExtensionPoint"],"mappings":";;;;AA+CO,MAAM,iCACXA,qCAAA,CAAqD;AAAA,EACnD,EAAA,EAAI;AACN,CAAC;AAsEI,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;AA2BI,MAAM,kCACXA,qCAAA,CAAsD;AAAA,EACpD,EAAA,EAAI;AACN,CAAC;;;;;;;;"}

package/dist/index.cjs.js

@@ -4,6 +4,7 @@ var processingResult = require('./api/processingResult.cjs.js');
 var conversion = require('./conversion.cjs.js');
 var parse = require('./processing/parse.cjs.js');
 var catalogService = require('./catalogService.cjs.js');
+var extensions = require('./extensions.cjs.js');
 
 
 
@@ -12,4 +13,7 @@ exports.locationSpecToLocationEntity = conversion.locationSpecToLocationEntity;
 exports.locationSpecToMetadataName = conversion.locationSpecToMetadataName;
 exports.parseEntityYaml = parse.parseEntityYaml;
 exports.catalogServiceRef = catalogService.catalogServiceRef;
+exports.catalogAnalysisExtensionPoint = extensions.catalogAnalysisExtensionPoint;
+exports.catalogLocationsExtensionPoint = extensions.catalogLocationsExtensionPoint;
+exports.catalogProcessingExtensionPoint = extensions.catalogProcessingExtensionPoint;
 //# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;"}
+{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;"}

package/dist/index.d.ts

@@ -4,6 +4,10 @@ import { LocationSpec as LocationSpec$1, AnalyzeLocationRequest, AnalyzeLocation
 import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
 import { BackstageCredentials } from '@backstage/backend-plugin-api';
 import { GetEntitiesRequest, GetEntitiesResponse, GetEntitiesByRefsRequest, GetEntitiesByRefsResponse, QueryEntitiesRequest, QueryEntitiesResponse, GetEntityAncestorsRequest, GetEntityAncestorsResponse, GetEntityFacetsRequest, GetEntityFacetsResponse, GetLocationsResponse, Location, AddLocationRequest, AddLocationResponse, ValidateEntityResponse, StreamEntitiesRequest } from '@backstage/catalog-client';
+export { b as CatalogAnalysisExtensionPoint, C as CatalogLocationsExtensionPoint, a as CatalogProcessingExtensionPoint, e as catalogAnalysisExtensionPoint, c as catalogLocationsExtensionPoint, d as catalogProcessingExtensionPoint } from './types/extensions.d-Cvnx6_V0.js';
+import '@backstage/plugin-catalog-node';
+import '@backstage/plugin-permission-common';
+import '@backstage/plugin-permission-node';
 
 /**
  * Holds the entity location information.

package/dist/types/extensions.d-Cvnx6_V0.d.ts

@@ -0,0 +1,127 @@
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+import { Entity, Validators } from '@backstage/catalog-model';
+import { CatalogProcessor, EntityProvider, PlaceholderResolver, LocationAnalyzer, ScmLocationAnalyzer, CatalogProcessorParser, EntitiesSearchFilter } from '@backstage/plugin-catalog-node';
+import { PermissionRuleParams, Permission } from '@backstage/plugin-permission-common';
+import { PermissionRule } from '@backstage/plugin-permission-node';
+
+/**
+ * @public
+ */
+interface CatalogLocationsExtensionPoint {
+    /**
+     * Allows setting custom location types, such as showcased in: https://backstage.io/docs/features/software-catalog/external-integrations/#creating-a-catalog-data-reader-processor
+     * @param locationTypes - List of location types to allow, default is "url" and "file"
+     */
+    setAllowedLocationTypes(locationTypes: Array<string>): void;
+}
+/**
+ * @public
+ */
+declare const catalogLocationsExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<CatalogLocationsExtensionPoint>;
+/**
+ * @public
+ */
+interface CatalogProcessingExtensionPoint {
+    /**
+     * Adds entity processors. These are responsible for reading, parsing, and
+     * processing entities before they are persisted in the catalog.
+     *
+     * This function also can replace a Default processor if the provided processor
+     * matches the processor name.
+     *
+     * @param processors - One or more processors
+     */
+    addProcessor(...processors: Array<CatalogProcessor | Array<CatalogProcessor>>): void;
+    /**
+     * Adds or replaces entity providers. These are responsible for bootstrapping
+     * the list of entities out of original data sources. For example, there is
+     * one entity source for the config locations, and one for the database
+     * stored locations. If you ingest entities out of a third party system, you
+     * may want to implement that in terms of an entity provider as well.
+     *
+     * @param providers - One or more entity providers
+     */
+    addEntityProvider(...providers: Array<EntityProvider | Array<EntityProvider>>): void;
+    /**
+     * Adds, or overwrites, a handler for placeholders (e.g. $file) in entity
+     * definition files.
+     *
+     * @param key - The key that identifies the placeholder, e.g. "file"
+     * @param resolver - The resolver that gets values for this placeholder
+     */
+    addPlaceholderResolver(key: string, resolver: PlaceholderResolver): void;
+    setOnProcessingErrorHandler(handler: (event: {
+        unprocessedEntity: Entity;
+        errors: Error[];
+    }) => Promise<void> | void): void;
+}
+/** @alpha */
+interface CatalogModelExtensionPoint {
+    /**
+     * Sets the validator function to use for one or more special fields of an
+     * entity. This is useful if the default rules for formatting of fields are
+     * not sufficient.
+     *
+     * @param validators - The (subset of) validators to set
+     */
+    setFieldValidators(validators: Partial<Validators>): void;
+    /**
+     * Sets the entity data parser which is used to read raw data from locations
+     * @param parser - Parser which will used to extract entities from raw data
+     */
+    setEntityDataParser(parser: CatalogProcessorParser): void;
+}
+/**
+ * @public
+ */
+declare const catalogProcessingExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<CatalogProcessingExtensionPoint>;
+/**
+ * @public
+ */
+interface CatalogAnalysisExtensionPoint {
+    /**
+     * Replaces the entire location analyzer with a new one.
+     *
+     * @remarks
+     *
+     * By providing a factory function you can access all the SCM analyzers that
+     * have been added through `addScmLocationAnalyzer`. If you provide a
+     * `LocationAnalyzer` directly, the SCM analyzers will be ignored.
+     */
+    setLocationAnalyzer(analyzerOrFactory: LocationAnalyzer | ((options: {
+        scmLocationAnalyzers: ScmLocationAnalyzer[];
+    }) => Promise<{
+        locationAnalyzer: LocationAnalyzer;
+    }>)): void;
+    /**
+     * Adds an analyzer for a specific SCM type to the default location analyzer.
+     */
+    addScmLocationAnalyzer(analyzer: ScmLocationAnalyzer): void;
+}
+/**
+ * @public
+ */
+declare const catalogAnalysisExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<CatalogAnalysisExtensionPoint>;
+/** @alpha */
+declare const catalogModelExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<CatalogModelExtensionPoint>;
+/**
+ * @alpha
+ * @deprecated Use the `coreServices.permissionsRegistry` instead.
+ */
+type CatalogPermissionRuleInput<TParams extends PermissionRuleParams = PermissionRuleParams> = PermissionRule<Entity, EntitiesSearchFilter, 'catalog-entity', TParams>;
+/**
+ * @alpha
+ * @deprecated Use the `coreServices.permissionsRegistry` instead.
+ */
+interface CatalogPermissionExtensionPoint {
+    addPermissions(...permissions: Array<Permission | Array<Permission>>): void;
+    addPermissionRules(...rules: Array<CatalogPermissionRuleInput | Array<CatalogPermissionRuleInput>>): void;
+}
+/**
+ * @alpha
+ * @deprecated Use the `coreServices.permissionsRegistry` instead.
+ */
+declare const catalogPermissionExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<CatalogPermissionExtensionPoint>;
+
+export { catalogLocationsExtensionPoint as c, catalogProcessingExtensionPoint as d, catalogAnalysisExtensionPoint as e, catalogModelExtensionPoint as g, catalogPermissionExtensionPoint as j };
+export type { CatalogLocationsExtensionPoint as C, CatalogProcessingExtensionPoint as a, CatalogAnalysisExtensionPoint as b, CatalogModelExtensionPoint as f, CatalogPermissionRuleInput as h, CatalogPermissionExtensionPoint as i };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-node",
-  "version": "1.20.1-next.1",
+  "version": "1.21.0-next.0",
   "description": "The plugin-catalog-node module for @backstage/plugin-catalog-backend",
   "backstage": {
     "role": "node-library",
@@ -72,20 +72,20 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-plugin-api": "1.6.0-next.1",
+    "@backstage/backend-plugin-api": "1.7.0-next.0",
     "@backstage/catalog-client": "1.12.1",
     "@backstage/catalog-model": "1.7.6",
     "@backstage/errors": "1.2.7",
-    "@backstage/plugin-catalog-common": "1.1.7",
-    "@backstage/plugin-permission-common": "0.9.3",
-    "@backstage/plugin-permission-node": "0.10.7-next.1",
+    "@backstage/plugin-catalog-common": "1.1.8-next.0",
+    "@backstage/plugin-permission-common": "0.9.5-next.0",
+    "@backstage/plugin-permission-node": "0.10.9-next.0",
     "@backstage/types": "1.2.2",
     "lodash": "^4.17.21",
     "yaml": "^2.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "1.10.2-next.1",
-    "@backstage/cli": "0.35.0-next.2",
+    "@backstage/backend-test-utils": "1.10.4-next.0",
+    "@backstage/cli": "0.35.3-next.0",
     "msw": "^1.0.0"
   }
 }