Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@backstage/plugin-catalog-node

backstage354.4kApache-2.01.16.3TypeScript support: included

The plugin-catalog-node module for @backstage/plugin-catalog-backend

backstage

readme

headline

Backstage

English | 한국어 | 中文版 | Français

License CNCF Status Discord Code style Codecov OpenSSF Best Practices OpenSSF Scorecard

What is Backstage?

Backstage is an open source framework for building developer portals. Powered by a centralized software catalog, Backstage restores order to your microservices and infrastructure and enables your product teams to ship high-quality code quickly without compromising autonomy.

Backstage unifies all your infrastructure tooling, services, and documentation to create a streamlined development environment from end to end.

software-catalog

Out of the box, Backstage includes:

  • Backstage Software Catalog for managing all your software such as microservices, libraries, data pipelines, websites, and ML models
  • Backstage Software Templates for quickly spinning up new projects and standardizing your tooling with your organization’s best practices
  • Backstage TechDocs for making it easy to create, maintain, find, and use technical documentation, using a "docs like code" approach
  • Plus, a growing ecosystem of open source plugins that further expand Backstage’s customizability and functionality

Backstage was created by Spotify but is now hosted by the Cloud Native Computing Foundation (CNCF) as an Incubation level project. For more information, see the announcement.

Project roadmap

For information about the detailed project roadmap including delivered milestones, see the Roadmap.

Getting Started

To start using Backstage, see the Getting Started documentation.

Documentation

The documentation of Backstage includes:

Community

To engage with our community, you can use the following resources:

Governance

See the GOVERNANCE.md document in the backstage/community repository.

License

Copyright 2020-2025 © The Backstage Authors. All rights reserved. The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our Trademark Usage page: https://www.linuxfoundation.org/trademark-usage

Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0

Security

Please report sensitive security issues using Spotify's bug-bounty program rather than GitHub.

For further details, see our complete security release process.

changelog

@backstage/plugin-catalog-node

1.16.3

Patch Changes

1.16.3-next.0

Patch Changes

1.16.1

Patch Changes

1.16.1-next.1

Patch Changes

1.16.1-next.0

Patch Changes

1.16.0

Minor Changes

  • b4183ad: Added new catalogEntityPermissionResourceRef export via the /alpha sub-path.
  • 9b9737c: Added the locationKey option to processingResult.entity(...).

Patch Changes

1.16.0-next.3

Minor Changes

  • b4183ad: Added new catalogEntityPermissionResourceRef export via the /alpha sub-path.

Patch Changes

1.16.0-next.2

Patch Changes

1.16.0-next.1

Minor Changes

  • 9b9737c: Added the locationKey option to processingResult.entity(...).

Patch Changes

1.15.2-next.0

Patch Changes

1.15.1

Patch Changes

1.15.1-next.1

Patch Changes

1.15.1-next.0

Patch Changes

1.15.0

Minor Changes

  • 8edc4cd: Updated the catalogServiceMock return type to match both CatalogService and CatalogApi

Patch Changes

1.15.0-next.2

Patch Changes

1.15.0-next.1

Minor Changes

  • 8edc4cd: Updated the catalogServiceMock return type to match both CatalogService and CatalogApi

Patch Changes

1.14.1-next.0

Patch Changes

1.14.0

Minor Changes

  • bc13b42: The catalogServiceRef now has its own accompanying CatalogService interface that requires Backstage credentials objects to be passed. This new version of the catalogServiceRef has been promoted and is now available via the main @backstage/plugin-catalog-node entry point.

    The old catalogServiceRef with the old CatalogApi type is still available from the /alpha entry point.

Patch Changes

1.14.0-next.2

Patch Changes

1.14.0-next.1

Patch Changes

1.14.0-next.0

Minor Changes

  • bc13b42: The catalogServiceRef now has its own accompanying CatalogService interface that requires Backstage credentials objects to be passed. This new version of the catalogServiceRef has been promoted and is now available via the main @backstage/plugin-catalog-node entry point.

    The old catalogServiceRef with the old CatalogApi type is still available from the /alpha entry point.

Patch Changes

1.13.1

Patch Changes

1.13.1-next.1

Patch Changes

1.13.1-next.0

Patch Changes

1.13.0

Minor Changes

  • bd35cdb: The analyze-location endpoint is now protected by the catalog.location.analyze permission. The validate-entity endpoint is now protected by the catalog.entity.validate permission.
  • 29e57c7: Add catalog service mocks under the /testUtils subpath export.

Patch Changes

1.12.7-next.2

Patch Changes

1.12.7-next.1

Patch Changes

1.12.7-next.0

Patch Changes

1.12.5

Patch Changes

1.12.5-next.3

Patch Changes

1.12.5-next.2

Patch Changes

1.12.5-next.1

Patch Changes

1.12.5-next.0

Patch Changes

1.12.4

Patch Changes

1.12.4-next.1

Patch Changes

1.12.3-next.0

Patch Changes

1.12.1

Patch Changes

1.12.1-next.2

Patch Changes

1.12.1-next.1

Patch Changes

1.12.1-next.0

Patch Changes

1.12.0

Minor Changes

  • f2a2a83: Added LocationAnalyzer type, moved from @backstage/plugin-catalog-backend.
  • f2a2a83: Breaking change to /alpha API where the catalogAnalysisExtensionPoint has been reworked. The addLocationAnalyzer method has been renamed to addScmLocationAnalyzer, and a new setLocationAnalyzer method has been added which allows the full LocationAnalyzer implementation to be overridden.

Patch Changes

1.12.0-next.2

Minor Changes

  • f2a2a83: Added LocationAnalyzer type, moved from @backstage/plugin-catalog-backend.
  • f2a2a83: Breaking change to /alpha API where the catalogAnalysisExtensionPoint has been reworked. The addLocationAnalyzer method has been renamed to addScmLocationAnalyzer, and a new setLocationAnalyzer method has been added which allows the full LocationAnalyzer implementation to be overridden.

1.11.2-next.1

Patch Changes

1.11.2-next.0

Patch Changes

1.11.1

Patch Changes

1.11.1-next.1

Patch Changes

1.11.1-next.0

Patch Changes

1.11.0

Minor Changes

  • f3e2e86: Added the ability to inject custom permissions from modules, on CatalogBuilder and CatalogPermissionExtensionPoint

Patch Changes

1.10.0

Minor Changes

  • f3e2e86: Added the ability to inject custom permissions from modules, on CatalogBuilder and CatalogPermissionExtensionPoint

Patch Changes

1.9.0

Minor Changes

  • 9c7fb30: Added the ability to inject custom permissions from modules, on CatalogBuilder and CatalogPermissionExtensionPoint

1.8.0

Minor Changes

  • df12231: Allow setting EntityDataParser using CatalogModelExtensionPoint

Patch Changes

1.8.0-next.2

Patch Changes

1.8.0-next.1

Patch Changes

1.8.0-next.0

Minor Changes

  • df12231: Allow setting EntityDataParser using CatalogModelExtensionPoint

Patch Changes

1.7.0

Minor Changes

  • d8a54d0: Adds support for supplying field validators to the new backend's catalog plugin. If you're using entity policies, you should use the new transformLegacyPolicyToProcessor function to install them as processors instead.

    import {
  catalogProcessingExtensionPoint,
  catalogModelExtensionPoint,
} from '@backstage/plugin-catalog-node/alpha';
import {myPolicy} from './my-policy';

export const catalogModulePolicyProvider = createBackendModule({
  pluginId: 'catalog',
  moduleId: 'internal-policy-provider',
  register(reg) {
    reg.registerInit({
      deps: {
        modelExtensions: catalogModelExtensionPoint,
        processingExtensions: catalogProcessingExtensionPoint,
      },
      async init({ modelExtensions, processingExtensions }) {
        modelExtensions.setFieldValidators({
          ...
        });
        processingExtensions.addProcessors(transformLegacyPolicyToProcessor(myPolicy))
      },
    });
  },
});

Patch Changes

1.6.2-next.3

Patch Changes

1.6.2-next.2

Patch Changes

1.6.2-next.1

Patch Changes

1.6.2-next.0

Patch Changes

1.6.1

Patch Changes

1.6.1-next.2

Patch Changes

1.6.1-next.1

Patch Changes

1.6.1-next.0

Patch Changes

1.6.0

Minor Changes

  • a168507: Added EntitiesSearchFilter and EntityFilter from @backstage/plugin-catalog-backend, for reuse
  • 7804597: Permission rules can now be added for the Catalog plugin through the CatalogPermissionExtensionPoint interface.

Patch Changes

1.6.0-next.3

Patch Changes

1.6.0-next.2

Minor Changes

  • a168507: Added EntitiesSearchFilter and EntityFilter from @backstage/plugin-catalog-backend, for reuse
  • 7804597: Permission rules can now be added for the Catalog plugin through the CatalogPermissionExtensionPoint interface.

Patch Changes

1.5.1-next.1

Patch Changes

1.5.1-next.0

Patch Changes

1.5.0

Minor Changes

  • e5bf3749ad: Support adding location analyzers in new catalog analysis extension point and move AnalyzeOptions and ScmLocationAnalyzer types to @backstage/plugin-catalog-node

Patch Changes

1.5.0-next.2

Patch Changes

1.5.0-next.1

Minor Changes

  • e5bf3749ad: Support adding location analyzers in new catalog analysis extension point and move AnalyzeOptions and ScmLocationAnalyzer types to @backstage/plugin-catalog-node

Patch Changes

1.4.8-next.0

Patch Changes

1.4.7

Patch Changes

1.4.7-next.2

Patch Changes

1.4.6-next.1

Patch Changes

1.4.6-next.0

Patch Changes

1.4.4

Patch Changes

1.4.4-next.3

Patch Changes

1.4.4-next.2

Patch Changes

1.4.4-next.1

Patch Changes

1.4.3-next.0

Patch Changes

1.4.1

Patch Changes

1.4.1-next.2

Patch Changes

1.4.1-next.1

Patch Changes

1.4.1-next.0

Patch Changes

1.4.0

Minor Changes

  • f06f0e46ba88: Support placeholder resolvers in the CatalogPlugin, also moves PlaceholderResolver and related types from @backstage/plugin-catalog-backend to @backstage/plugin-catalog-node.

Patch Changes

1.4.0-next.0

Minor Changes

  • f06f0e46ba88: Support placeholder resolvers in the CatalogPlugin, also moves PlaceholderResolver and related types from @backstage/plugin-catalog-backend to @backstage/plugin-catalog-node.

Patch Changes

1.3.7

Patch Changes

1.3.7-next.2

Patch Changes

1.3.7-next.1

Patch Changes

1.3.7-next.0

Patch Changes

1.3.6

Patch Changes

1.3.6-next.1

Patch Changes

1.3.6-next.0

Patch Changes

1.3.5

Patch Changes

1.3.5-next.3

Patch Changes

1.3.5-next.2

Patch Changes

1.3.5-next.1

Patch Changes

1.3.5-next.0

Patch Changes

1.3.4

Patch Changes

1.3.4-next.2

Patch Changes

1.3.4-next.1

Patch Changes

1.3.4-next.0

Patch Changes

1.3.3

Patch Changes

1.3.3-next.2

Patch Changes

1.3.3-next.1

Patch Changes

1.3.3-next.0

Patch Changes

1.3.1

Patch Changes

1.3.1-next.2

Patch Changes

1.3.1-next.1

Patch Changes

1.3.1-next.0

Patch Changes

1.3.0

Minor Changes

  • eacc8e2b55: Make it possible for entity providers to supply only entity refs, instead of full entities, in delta mutation deletions.

Patch Changes

1.3.0-next.3

Patch Changes

1.3.0-next.2

Minor Changes

  • eacc8e2b55: Make it possible for entity providers to supply only entity refs, instead of full entities, in delta mutation deletions.

Patch Changes

1.2.2-next.1

Patch Changes

1.2.2-next.0

Patch Changes

1.2.1

Patch Changes

1.2.1-next.1

Patch Changes

1.2.1-next.0

Patch Changes

1.2.0

Minor Changes

  • 404366c853: Deprecated the LocationSpec type. It got moved from this package to the @backstage/plugin-catalog-common so make sure imports are updated.

Patch Changes

1.2.0-next.2

Minor Changes

  • 404366c853: Deprecated the LocationSpec type. It got moved from this package to the @backstage/plugin-catalog-common so make sure imports are updated.

Patch Changes

1.1.1-next.1

Patch Changes

1.1.1-next.0

Patch Changes

1.1.0

Minor Changes

  • 9743bc788c: Added refresh function to the EntityProviderConnection to be able to schedule refreshes from entity providers.

Patch Changes

1.1.0-next.2

Minor Changes

  • 9743bc788c: Added refresh function to the EntityProviderConnection to be able to schedule refreshes from entity providers.

Patch Changes

1.0.2-next.1

Patch Changes

1.0.2-next.0

Patch Changes

1.0.1

Patch Changes

  • 0599732ec0: Refactored experimental backend system with new type names.
  • 56e1b4b89c: Fixed typos in alpha types.
  • Updated dependencies

1.0.1-next.0

Patch Changes

1.0.0

Major Changes

  • 9a6aba1d85: This package houses stable types from the @backstage/plugin-catalog-backend package and is intended for creation of catalog modules. Prefer importing from this package over the @backstage/plugin-catalog-backend package.

Minor Changes

  • 91c1d12123: Added alpha exports for the new experimental backend system.

Patch Changes

1.0.0-next.0

Major Changes

  • 9a6aba1d85: This package houses stable types from the @backstage/plugin-catalog-backend package and is intended for creation of catalog modules. Prefer importing from this package over the @backstage/plugin-catalog-backend package.

Minor Changes

  • 91c1d12123: Added alpha exports for the new experimental backend system.

Patch Changes