@backstage/plugin-catalog-node 0.0.0-nightly-20260414031820 → 0.0.0-nightly-20260416031834

package/CHANGELOG.md

@@ -1,9 +1,25 @@
 # @backstage/plugin-catalog-node
 
-## 0.0.0-nightly-20260414031820
+## 0.0.0-nightly-20260416031834
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/errors@0.0.0-nightly-20260416031834
+  - @backstage/backend-plugin-api@0.0.0-nightly-20260416031834
+  - @backstage/backend-test-utils@0.0.0-nightly-20260416031834
+  - @backstage/catalog-client@0.0.0-nightly-20260416031834
+  - @backstage/catalog-model@0.0.0-nightly-20260416031834
+  - @backstage/plugin-permission-common@0.0.0-nightly-20260416031834
+  - @backstage/plugin-permission-node@0.0.0-nightly-20260416031834
+  - @backstage/plugin-catalog-common@0.0.0-nightly-20260416031834
+  - @backstage/types@1.2.2
+
+## 2.2.0
 
 ### Minor Changes
 
+- e5fcfcb: Added `provideStaticCatalogModel` that helps provide a static catalog model at startup.
 - 056e18e: **BREAKING ALPHA**: Removed the deprecated `CatalogPermissionRuleInput`, `CatalogPermissionExtensionPoint`, and `catalogPermissionExtensionPoint` exports. Use `coreServices.permissionsRegistry` directly to register catalog entity permission rules and permissions.
 - c384fff: **BREAKING PRODUCERS**: Added `updateLocation` method to `CatalogService` for updating the type and target of an existing location. Any code that implements `CatalogService` must now provide this method.
 - 7a03196: **BREAKING ALPHA**: Removed the following deprecated exports from `@backstage/plugin-catalog-node/alpha`:
@@ -16,15 +32,14 @@
 ### Patch Changes
 
 - Updated dependencies
-  - @backstage/backend-plugin-api@0.0.0-nightly-20260414031820
-  - @backstage/backend-test-utils@0.0.0-nightly-20260414031820
-  - @backstage/errors@0.0.0-nightly-20260414031820
-  - @backstage/catalog-client@0.0.0-nightly-20260414031820
-  - @backstage/plugin-permission-node@0.0.0-nightly-20260414031820
-  - @backstage/catalog-model@0.0.0-nightly-20260414031820
-  - @backstage/plugin-permission-common@0.0.0-nightly-20260414031820
-  - @backstage/types@1.2.2
-  - @backstage/plugin-catalog-common@0.0.0-nightly-20260414031820
+  - @backstage/backend-plugin-api@1.9.0
+  - @backstage/backend-test-utils@1.11.2
+  - @backstage/errors@1.3.0
+  - @backstage/catalog-model@1.8.0
+  - @backstage/catalog-client@1.15.0
+  - @backstage/plugin-permission-node@0.10.12
+  - @backstage/plugin-catalog-common@1.1.9
+  - @backstage/plugin-permission-common@0.9.8
 
 ## 2.2.0-next.2
 

package/dist/alpha.cjs.js

@@ -4,6 +4,7 @@ var alpha = require('@backstage/plugin-catalog-common/alpha');
 var pluginPermissionNode = require('@backstage/plugin-permission-node');
 var extensions = require('./extensions.cjs.js');
 var catalogScmEventsServiceRef = require('./scmEvents/catalogScmEventsServiceRef.cjs.js');
+var provideStaticCatalogModel = require('./provideStaticCatalogModel.cjs.js');
 
 const catalogEntityPermissionResourceRef = pluginPermissionNode.createPermissionResourceRef().with({
   pluginId: "catalog",
@@ -12,5 +13,6 @@ const catalogEntityPermissionResourceRef = pluginPermissionNode.createPermission
 
 exports.catalogModelExtensionPoint = extensions.catalogModelExtensionPoint;
 exports.catalogScmEventsServiceRef = catalogScmEventsServiceRef.catalogScmEventsServiceRef;
+exports.provideStaticCatalogModel = provideStaticCatalogModel.provideStaticCatalogModel;
 exports.catalogEntityPermissionResourceRef = catalogEntityPermissionResourceRef;
 //# 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 { 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\nexport type { CatalogModelExtensionPoint } from './extensions';\nexport { catalogModelExtensionPoint } from './extensions';\n\nexport * from './scmEvents';\n"],"names":["createPermissionResourceRef","RESOURCE_TYPE_CATALOG_ENTITY"],"mappings":";;;;;;;AAsBO,MAAM,kCAAA,GAAqCA,gDAAA,EAGhD,CAAE,IAAA,CAAK;AAAA,EACP,QAAA,EAAU,SAAA;AAAA,EACV,YAAA,EAAcC;AAChB,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 { 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\nexport type { CatalogModelExtensionPoint } from './extensions';\nexport { catalogModelExtensionPoint } from './extensions';\n\nexport * from './scmEvents';\nexport { provideStaticCatalogModel } from './provideStaticCatalogModel';\n"],"names":["createPermissionResourceRef","RESOURCE_TYPE_CATALOG_ENTITY"],"mappings":";;;;;;;;AAsBO,MAAM,kCAAA,GAAqCA,gDAAA,EAGhD,CAAE,IAAA,CAAK;AAAA,EACP,QAAA,EAAU,SAAA;AAAA,EACV,YAAA,EAAcC;AAChB,CAAC;;;;;;;"}

package/dist/alpha.d.ts

@@ -1,8 +1,9 @@
 import * as _backstage_plugin_permission_node from '@backstage/plugin-permission-node';
 import { Entity } from '@backstage/catalog-model';
 import { EntitiesSearchFilter } from '@backstage/plugin-catalog-node';
-export { f as CatalogModelExtensionPoint, g as catalogModelExtensionPoint } from './types/extensions.d-ojRdpmUf.js';
+export { f as CatalogModelExtensionPoint, g as catalogModelExtensionPoint } from './types/extensions.d-CrQV6ICe.js';
 import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+import { CatalogModelLayer } from '@backstage/catalog-model/alpha';
 
 /**
  * A subscriber of the {@link CatalogScmEventsService}.
@@ -190,8 +191,32 @@ type CatalogScmEvent = {
  */
 declare const catalogScmEventsServiceRef: _backstage_backend_plugin_api.ServiceRef<CatalogScmEventsService, "plugin", "singleton">;
 
+/**
+ * Creates a backend module that registers static catalog model layers.
+ *
+ * @alpha
+ * @remarks
+ *
+ * This is a convenience function for registering catalog model layers
+ * without having to manually create a backend module and interact with
+ * the catalog model extension point. The built-in default catalog entity
+ * model is always included automatically.
+ *
+ * @example
+ * ```ts
+ * backend.add(
+ *   provideStaticCatalogModel({
+ *     layers: [scaffolderCatalogModelLayer],
+ *   }),
+ * );
+ * ```
+ */
+declare function provideStaticCatalogModel(options?: {
+    layers?: CatalogModelLayer[];
+}): _backstage_backend_plugin_api.BackendFeature;
+
 /** @alpha */
 declare const catalogEntityPermissionResourceRef: _backstage_plugin_permission_node.PermissionResourceRef<Entity, EntitiesSearchFilter, "catalog-entity", "catalog">;
 
-export { catalogEntityPermissionResourceRef, catalogScmEventsServiceRef };
+export { catalogEntityPermissionResourceRef, catalogScmEventsServiceRef, provideStaticCatalogModel };
 export type { CatalogScmEvent, CatalogScmEventContext, CatalogScmEventsService, CatalogScmEventsServiceSubscriber };

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  EntityProvider,\n  PlaceholderResolver,\n  LocationAnalyzer,\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   * @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"],"names":["createExtensionPoint"],"mappings":";;;;AAyCO,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;;;;;;;"}
+{"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;;;;;;;"}

package/dist/index.d.ts

@@ -4,7 +4,8 @@ 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, QueryLocationsRequest, QueryLocationsResponse, QueryLocationsInitialRequest, Location, AddLocationRequest, AddLocationResponse, ValidateEntityResponse, StreamEntitiesRequest } from '@backstage/catalog-client';
-export { C as CatalogAnalysisExtensionPoint, a as CatalogLocationsExtensionPoint, b as CatalogProcessingExtensionPoint, c as catalogAnalysisExtensionPoint, d as catalogLocationsExtensionPoint, e as catalogProcessingExtensionPoint } from './types/extensions.d-ojRdpmUf.js';
+export { C as CatalogAnalysisExtensionPoint, a as CatalogLocationsExtensionPoint, b as CatalogProcessingExtensionPoint, c as catalogAnalysisExtensionPoint, d as catalogLocationsExtensionPoint, e as catalogProcessingExtensionPoint } from './types/extensions.d-CrQV6ICe.js';
+import '@backstage/catalog-model/alpha';
 import '@backstage/plugin-catalog-node';
 
 /**

package/dist/provideStaticCatalogModel.cjs.js

@@ -0,0 +1,27 @@
+'use strict';
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var alpha = require('@backstage/catalog-model/alpha');
+var extensions = require('./extensions.cjs.js');
+
+function provideStaticCatalogModel(options) {
+  return backendPluginApi.createBackendModule({
+    pluginId: "catalog",
+    moduleId: "static-catalog-model",
+    register(reg) {
+      reg.registerInit({
+        deps: {
+          model: extensions.catalogModelExtensionPoint
+        },
+        async init({ model }) {
+          model.addModelSource(
+            alpha.CatalogModelSources.static(options?.layers ?? [])
+          );
+        }
+      });
+    }
+  });
+}
+
+exports.provideStaticCatalogModel = provideStaticCatalogModel;
+//# sourceMappingURL=provideStaticCatalogModel.cjs.js.map

package/dist/provideStaticCatalogModel.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"provideStaticCatalogModel.cjs.js","sources":["../src/provideStaticCatalogModel.ts"],"sourcesContent":["/*\n * Copyright 2026 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 { createBackendModule } from '@backstage/backend-plugin-api';\nimport {\n  CatalogModelLayer,\n  CatalogModelSources,\n} from '@backstage/catalog-model/alpha';\nimport { catalogModelExtensionPoint } from './extensions';\n\n/**\n * Creates a backend module that registers static catalog model layers.\n *\n * @alpha\n * @remarks\n *\n * This is a convenience function for registering catalog model layers\n * without having to manually create a backend module and interact with\n * the catalog model extension point. The built-in default catalog entity\n * model is always included automatically.\n *\n * @example\n * ```ts\n * backend.add(\n *   provideStaticCatalogModel({\n *     layers: [scaffolderCatalogModelLayer],\n *   }),\n * );\n * ```\n */\nexport function provideStaticCatalogModel(options?: {\n  layers?: CatalogModelLayer[];\n}) {\n  return createBackendModule({\n    pluginId: 'catalog',\n    moduleId: 'static-catalog-model',\n    register(reg) {\n      reg.registerInit({\n        deps: {\n          model: catalogModelExtensionPoint,\n        },\n        async init({ model }) {\n          model.addModelSource(\n            CatalogModelSources.static(options?.layers ?? []),\n          );\n        },\n      });\n    },\n  });\n}\n"],"names":["createBackendModule","catalogModelExtensionPoint","CatalogModelSources"],"mappings":";;;;;;AA2CO,SAAS,0BAA0B,OAAA,EAEvC;AACD,EAAA,OAAOA,oCAAA,CAAoB;AAAA,IACzB,QAAA,EAAU,SAAA;AAAA,IACV,QAAA,EAAU,sBAAA;AAAA,IACV,SAAS,GAAA,EAAK;AACZ,MAAA,GAAA,CAAI,YAAA,CAAa;AAAA,QACf,IAAA,EAAM;AAAA,UACJ,KAAA,EAAOC;AAAA,SACT;AAAA,QACA,MAAM,IAAA,CAAK,EAAE,KAAA,EAAM,EAAG;AACpB,UAAA,KAAA,CAAM,cAAA;AAAA,YACJC,yBAAA,CAAoB,MAAA,CAAO,OAAA,EAAS,MAAA,IAAU,EAAE;AAAA,WAClD;AAAA,QACF;AAAA,OACD,CAAA;AAAA,IACH;AAAA,GACD,CAAA;AACH;;;;"}

package/dist/types/{extensions.d-ojRdpmUf.d.ts → extensions.d-CrQV6ICe.d.ts}

@@ -1,5 +1,6 @@
 import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
 import { Entity, Validators } from '@backstage/catalog-model';
+import { CatalogModelSource } from '@backstage/catalog-model/alpha';
 import { LocationAnalyzer, ScmLocationAnalyzer, CatalogProcessor, EntityProvider, PlaceholderResolver, CatalogProcessorParser } from '@backstage/plugin-catalog-node';
 
 /**
@@ -64,10 +65,17 @@ interface CatalogModelExtensionPoint {
      */
     setFieldValidators(validators: Partial<Validators>): void;
     /**
-     * Sets the entity data parser which is used to read raw data from locations
+     * 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;
+    /**
+     * Adds a catalog model source to be part of the compiled entity model.
+     *
+     * @param source - The model source to add
+     */
+    addModelSource(source: CatalogModelSource): void;
 }
 /**
  * @public

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-node",
-  "version": "0.0.0-nightly-20260414031820",
+  "version": "0.0.0-nightly-20260416031834",
   "description": "The plugin-catalog-node module for @backstage/plugin-catalog-backend",
   "backstage": {
     "role": "node-library",
@@ -72,25 +72,25 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-plugin-api": "0.0.0-nightly-20260414031820",
-    "@backstage/catalog-client": "0.0.0-nightly-20260414031820",
-    "@backstage/catalog-model": "0.0.0-nightly-20260414031820",
-    "@backstage/errors": "0.0.0-nightly-20260414031820",
-    "@backstage/plugin-catalog-common": "0.0.0-nightly-20260414031820",
-    "@backstage/plugin-permission-common": "0.0.0-nightly-20260414031820",
-    "@backstage/plugin-permission-node": "0.0.0-nightly-20260414031820",
+    "@backstage/backend-plugin-api": "0.0.0-nightly-20260416031834",
+    "@backstage/catalog-client": "0.0.0-nightly-20260416031834",
+    "@backstage/catalog-model": "0.0.0-nightly-20260416031834",
+    "@backstage/errors": "0.0.0-nightly-20260416031834",
+    "@backstage/plugin-catalog-common": "0.0.0-nightly-20260416031834",
+    "@backstage/plugin-permission-common": "0.0.0-nightly-20260416031834",
+    "@backstage/plugin-permission-node": "0.0.0-nightly-20260416031834",
     "@backstage/types": "1.2.2",
     "@opentelemetry/api": "^1.9.0",
     "lodash": "^4.17.21",
     "yaml": "^2.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "0.0.0-nightly-20260414031820",
-    "@backstage/cli": "0.0.0-nightly-20260414031820",
+    "@backstage/backend-test-utils": "0.0.0-nightly-20260416031834",
+    "@backstage/cli": "0.0.0-nightly-20260416031834",
     "msw": "^1.0.0"
   },
   "peerDependencies": {
-    "@backstage/backend-test-utils": "0.0.0-nightly-20260414031820"
+    "@backstage/backend-test-utils": "0.0.0-nightly-20260416031834"
   },
   "peerDependenciesMeta": {
     "@backstage/backend-test-utils": {