paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 47 Packages Projects Releases Wiki Activity
Files
37f9216a7cd353f4ce9489330f9cb668159ea3b4
backstage/packages/frontend-app-api/CHANGELOG.md
T
github-actions[bot] 911bbe0d92 Version Packages (next)
2024-08-27 11:41:57 +00:00

36 KiB
Raw Blame History

@backstage/frontend-app-api

0.9.0-next.0

Minor Changes

  • 62cce6c: Removed deprecated icons property passing to createApp and createSpecializedApp. Use IconBundleBlueprint.make to create extensions instead and include them in the app.

Patch Changes

  • fec8b57: Updated exports to use the new type parameters for extensions and extension blueprints.

  • 2bb9517: Introduce the @backstage/plugin-app package to hold all of the built-in extensions for easy consumption and overriding.

  • f3a2b91: Moved several implementations of built-in APIs from being hardcoded in the app to instead be provided as API extensions. This moves all API-related inputs from the app extension to the respective API extensions. For example, extensions created with ThemeBlueprint are now attached to the themes input of api:app-theme rather than the app extension.

  • 5446061: Internal refactor following removal of v1 extension support. The app implementation itself still supports v1 extensions at runtime.

  • 98850de: Added support for defining replaces in createExtensionInput which will allow extensions to redirect missing attachTo points to an input of the created extension.

    export const AppThemeApi = ApiBlueprint.makeWithOverrides({
  name: 'app-theme',
  inputs: {
    themes: createExtensionInput([ThemeBlueprint.dataRefs.theme], {
      // attachTo: { id: 'app', input: 'themes'} will be redirected to this input instead
      replaces: [{ id: 'app', input: 'themes' }],
    }),
  },
  factory: () {
    ...
  }
});

  • 4a66456: Added the root extension the replace the app extension as the root of the app.

  • Updated dependencies

    • @backstage/frontend-plugin-api@0.8.0-next.0
    • @backstage/plugin-app@0.1.0-next.0
    • @backstage/config@1.2.0
    • @backstage/core-app-api@1.14.2
    • @backstage/core-components@0.14.10
    • @backstage/core-plugin-api@1.9.3
    • @backstage/errors@1.2.4
    • @backstage/theme@0.5.6
    • @backstage/types@1.1.1
    • @backstage/version-bridge@1.0.8

0.8.0

Minor Changes

  • fc24d9e: Stop using @backstage/backend-tasks as it will be deleted in near future.

Patch Changes

  • 7777b5f: Support icon overriding with the new IconBundleBlueprint API.
  • 72754db: Updated usage of useRouteRef, which can now always return undefined.
  • 3be9aeb: Added support for v2 extensions, which declare their inputs and outputs without using a data map.
  • fe1fbb2: Migrating usages of the deprecated createExtension v1 format to the newer v2 format, and old create*Extension extension creators to blueprints.
  • 6349099: Added config input type to the extensions
  • Updated dependencies

0.7.5-next.3

Patch Changes

0.7.5-next.2

Patch Changes

  • 72754db: Updated usage of useRouteRef, which can now always return undefined.
  • Updated dependencies

0.7.5-next.1

Patch Changes

  • 3be9aeb: Added support for v2 extensions, which declare their inputs and outputs without using a data map.
  • 6349099: Added config input type to the extensions
  • Updated dependencies

0.7.4-next.0

Patch Changes

  • 7777b5f: Support icon overriding with the new IconBundleBlueprint API.
  • Updated dependencies

0.7.3

Patch Changes

  • d3c39fc: Allow for the disabling of external routes through config, which was rendered impossible after the introduction of default targets.

    app:
  routes:
    bindings:
      # This has the effect of removing the button for registering new
      # catalog entities in the scaffolder template list view
      scaffolder.registerComponent: false

  • Updated dependencies

0.7.3-next.2

Patch Changes

0.7.3-next.1

Patch Changes

  • Updated dependencies

0.7.2-next.0

Patch Changes

  • d3c39fc: Allow for the disabling of external routes through config, which was rendered impossible after the introduction of default targets.

    app:
  routes:
    bindings:
      # This has the effect of removing the button for registering new
      # catalog entities in the scaffolder template list view
      scaffolder.registerComponent: false

  • Updated dependencies

0.7.1

Patch Changes

0.7.1-next.2

Patch Changes

  • Updated dependencies
    • @backstage/core-components@0.14.8-next.2
    • @backstage/frontend-plugin-api@0.6.6-next.2
    • @backstage/config@1.2.0
    • @backstage/core-app-api@1.12.6-next.0
    • @backstage/core-plugin-api@1.9.3-next.0
    • @backstage/errors@1.2.4
    • @backstage/theme@0.5.6-next.0
    • @backstage/types@1.1.1
    • @backstage/version-bridge@1.0.8

0.7.1-next.1

Patch Changes

  • Updated dependencies
    • @backstage/core-components@0.14.8-next.1
    • @backstage/core-plugin-api@1.9.3-next.0
    • @backstage/core-app-api@1.12.6-next.0
    • @backstage/frontend-plugin-api@0.6.6-next.1
    • @backstage/config@1.2.0
    • @backstage/errors@1.2.4
    • @backstage/theme@0.5.6-next.0
    • @backstage/types@1.1.1
    • @backstage/version-bridge@1.0.8

0.7.1-next.0

Patch Changes

  • Updated dependencies

0.7.0

Minor Changes

  • ddddecb: Extensions in app-config now always affect ordering. Previously, only when enabling disabled extensions did they rise to the top.

Patch Changes

0.7.0-next.2

Minor Changes

  • ddddecb: Extensions in app-config now always affect ordering. Previously, only when enabling disabled extensions did they rise to the top.

Patch Changes

0.6.5-next.1

Patch Changes

0.6.5-next.0

Patch Changes

  • Updated dependencies

0.6.4

Patch Changes

  • 83f24f6: add @backstage/no-top-level-material-ui-4-imports lint rule
  • c884b9a: The app is now aware of if it is being served from the app-backend with a separate public and protected bundles. When in protected mode the app will now continuously refresh the session cookie, as well as clear the cookie if the user signs out.
  • 7ef7cc8: Fix duplicated subpath on routes resolved by the useRouteRef hook.
  • abfbcfc: Updated dependency @testing-library/react to ^15.0.0.
  • Updated dependencies

0.6.4-next.1

Patch Changes

  • c884b9a: The app is now aware of if it is being served from the app-backend with a separate public and protected bundles. When in protected mode the app will now continuously refresh the session cookie, as well as clear the cookie if the user signs out.
  • Updated dependencies

0.6.4-next.0

Patch Changes

  • Updated dependencies

0.6.3

Patch Changes

0.6.2

Patch Changes

0.6.1

Patch Changes

  • 48d6628: Add loadingComponent parameter to createApp()
  • Updated dependencies

0.6.1-next.2

Patch Changes

  • Updated dependencies
    • @backstage/core-components@0.14.1-next.2
    • @backstage/frontend-plugin-api@0.6.1-next.2
    • @backstage/config@1.2.0-next.1
    • @backstage/core-app-api@1.12.1-next.1
    • @backstage/core-plugin-api@1.9.1-next.1
    • @backstage/errors@1.2.4-next.0
    • @backstage/theme@0.5.2-next.0
    • @backstage/types@1.1.1
    • @backstage/version-bridge@1.0.7

0.6.1-next.1

Patch Changes

  • Updated dependencies
    • @backstage/config@1.2.0-next.1
    • @backstage/core-components@0.14.1-next.1
    • @backstage/core-app-api@1.12.1-next.1
    • @backstage/core-plugin-api@1.9.1-next.1
    • @backstage/frontend-plugin-api@0.6.1-next.1
    • @backstage/errors@1.2.4-next.0
    • @backstage/theme@0.5.2-next.0
    • @backstage/types@1.1.1
    • @backstage/version-bridge@1.0.7

0.6.1-next.0

Patch Changes

  • Updated dependencies
    • @backstage/errors@1.2.4-next.0
    • @backstage/theme@0.5.2-next.0
    • @backstage/core-components@0.14.1-next.0
    • @backstage/config@1.1.2-next.0
    • @backstage/core-plugin-api@1.9.1-next.0
    • @backstage/frontend-plugin-api@0.6.1-next.0
    • @backstage/core-app-api@1.12.1-next.0
    • @backstage/types@1.1.1
    • @backstage/version-bridge@1.0.7

0.6.0

Minor Changes

  • bdf4a8e: BREAKING: Removed the experimental createExtensionTree API.

  • 86346c2: BREAKING: The app.routes.bindings app-config mapping has been simplified. You now only need to specify the plugin ID and route ID on both sides of the mapping.

    Old form:

    app:
  routes:
    bindings:
      plugin.catalog.externalRoutes.viewTechDoc: plugin.techdocs.routes.docRoot
      plugin.catalog.externalRoutes.createComponent: plugin.catalog-import.routes.importPage

    New form:

    app:
  routes:
    bindings:
      catalog.viewTechDoc: techdocs.docRoot
      catalog.createComponent: catalog-import.importPage

Patch Changes

  • 42ebf27: Added IconsApi implementation and the ability to configure icons through the icons option for createApp and createSpecializedApp. This is not a long-term solution as icons should be installable via extensions instead. This is just a stop-gap to make sure there is feature parity with the existing frontend system.
  • bc621aa: Updates to use the new RouteResolutionsApi.
  • e586f79: Wrap the root element with the analytics context to ensure it always exists for all extensions.
  • 8fe56a8: Widen @types/react dependency range to include version 18.
  • 8472188: Added or fixed the repository field in package.json.
  • e0a4dd1: Improved the error message when data input/output shapes do not match
  • fb9b5e7: The default ComponentsApi implementation now uses the ComponentRef ID as the component key, rather than the reference instance. This fixes a bug where duplicate installations of @backstage/frontend-plugin-api would break the app.
  • 46b63de: Allow external route refs in the new system to have a defaultTarget pointing to a route that it'll resolve to by default if no explicit bindings were made by the adopter.
  • Updated dependencies

0.6.0-next.3

Patch Changes

  • 8472188: Added or fixed the repository field in package.json.
  • Updated dependencies
    • @backstage/theme@0.5.1-next.1
    • @backstage/core-components@0.14.0-next.2
    • @backstage/config@1.1.1
    • @backstage/core-app-api@1.12.0-next.1
    • @backstage/core-plugin-api@1.9.0-next.1
    • @backstage/errors@1.2.3
    • @backstage/frontend-plugin-api@0.6.0-next.3
    • @backstage/types@1.1.1
    • @backstage/version-bridge@1.0.7

0.6.0-next.2

Patch Changes

  • 8fe56a8: Widen @types/react dependency range to include version 18.
  • Updated dependencies
    • @backstage/core-components@0.14.0-next.1
    • @backstage/core-app-api@1.12.0-next.1
    • @backstage/core-plugin-api@1.9.0-next.1
    • @backstage/frontend-plugin-api@0.6.0-next.2
    • @backstage/theme@0.5.1-next.0
    • @backstage/config@1.1.1
    • @backstage/errors@1.2.3
    • @backstage/types@1.1.1
    • @backstage/version-bridge@1.0.7

0.6.0-next.1

Minor Changes

  • bdf4a8e: BREAKING: Removed the experimental createExtensionTree API.

Patch Changes

  • bc621aa: Updates to use the new RouteResolutionsApi.
  • e586f79: Wrap the root element with the analytics context to ensure it always exists for all extensions.
  • fb9b5e7: The default ComponentsApi implementation now uses the ComponentRef ID as the component key, rather than the reference instance. This fixes a bug where duplicate installations of @backstage/frontend-plugin-api would break the app.
  • 46b63de: Allow external route refs in the new system to have a defaultTarget pointing to a route that it'll resolve to by default if no explicit bindings were made by the adopter.
  • Updated dependencies
    • @backstage/frontend-plugin-api@0.6.0-next.1
    • @backstage/core-components@0.14.0-next.0
    • @backstage/core-plugin-api@1.8.3-next.0
    • @backstage/core-app-api@1.11.4-next.0
    • @backstage/config@1.1.1
    • @backstage/errors@1.2.3
    • @backstage/theme@0.5.0
    • @backstage/types@1.1.1
    • @backstage/version-bridge@1.0.7

0.6.0-next.0

Minor Changes

  • 86346c2: BREAKING: The app.routes.bindings app-config mapping has been simplified. You now only need to specify the plugin ID and route ID on both sides of the mapping.

    Old form:

    app:
  routes:
    bindings:
      plugin.catalog.externalRoutes.viewTechDoc: plugin.techdocs.routes.docRoot
      plugin.catalog.externalRoutes.createComponent: plugin.catalog-import.routes.importPage

    New form:

    app:
  routes:
    bindings:
      catalog.viewTechDoc: techdocs.docRoot
      catalog.createComponent: catalog-import.importPage

Patch Changes

  • 42ebf27: Added IconsApi implementation and the ability to configure icons through the icons option for createApp and createSpecializedApp. This is not a long-term solution as icons should be installable via extensions instead. This is just a stop-gap to make sure there is feature parity with the existing frontend system.
  • e0a4dd1: Improved the error message when data input/output shapes do not match
  • Updated dependencies

0.5.0

Minor Changes

  • d4149bf: BREAKING: Renamed the app/router extension to app/root.
  • 074dfe3: Attaching extensions to an input that does not exist is now a warning rather than an error.

Patch Changes

  • 7d63b32: Accepts sub route refs on the new createPlugin routes map.
  • 516fd3e: Updated README to reflect release status
  • c97fa1c: Added elements, wrappers, and router inputs to app/root, that let you add things to the root of the React tree above the layout. You can use the createAppRootElementExtension, createAppRootWrapperExtension, and createRouterExtension extension creator, respectively, to conveniently create such extensions. These are all optional, and if you do not supply a router a default one will be used (BrowserRouter in regular runs, MemoryRouter in tests/CI).
  • 5fe6600: add oauth dialog and alert display to the root elements
  • Updated dependencies

0.4.1-next.2

Patch Changes

  • 516fd3e: Updated README to reflect release status
  • Updated dependencies
    • @backstage/frontend-plugin-api@0.4.1-next.2

0.4.1-next.1

Patch Changes

0.4.1-next.0

Patch Changes

0.4.0

Minor Changes

  • e539735: Updated core extension structure to make space for the sign-in page by adding core.router.
  • 44735df: Removed featureLoader from createApp, features instead accepts both FrontendFeature and CreateAppFeatureLoader
  • af7bc3e: Switched all core extensions to instead use the namespace 'app'.
  • ea06590: The app no longer provides the AppContext from @backstage/core-plugin-api. Components that require this context to be available should use the compatWrapper helper from @backstage/core-compat-api.

Patch Changes

  • 5eb6b8a: Added the nav logo extension for customization of sidebar logo
  • aeb8008: Add support for translation extensions.
  • 1f12fb7: Create a core components extension that allows adopters to override core app components such as Progress, BootErrorPage, NotFoundErrorPage and ErrorBoundaryFallback.
  • a379243: Leverage the new FrontendFeature type to simplify interfaces
  • 60d6eb5: Removed @backstage/plugin-graphiql dependency.
  • b7adf24: Use the new plugin type for error boundary components.
  • 5970928: Collect and register feature flags from plugins and extension overrides.
  • 9ad4039: Bringing over apis from core-plugin-api
  • 8f5d6c1: Updates to match the new extension input wrapping.
  • c35036b: A configLoader passed to createApp now returns an object, to make room for future expansion
  • f27ee7d: Migrate analytics route tracker component.
  • b8cb780: Added createSpecializedApp, which is a synchronous version of createApp where config and features already need to be loaded.
  • c36e0b9: Renamed AppRouteBinder to CreateAppRouteBinder
  • cb4197a: Forward node`` instead of extensionId` to resolved extension inputs.
  • 8837a96: Updates to match the introduction of ExtensionDefinition and new extension ID naming patterns.
  • a5a0473: Updates to provide node to extension factories instead of id and source.
  • 5cdf2b3: Updated usage of Extension and ExtensionDefinition as they are now opaque.
  • f9ef632: Updates to match the new coreExtensionData structure.
  • f1183b7: Renamed the component option of createComponentExtension to loader.
  • Updated dependencies

0.4.0-next.3

Patch Changes

  • Updated dependencies

0.4.0-next.2

Minor Changes

  • ea06590: The app no longer provides the AppContext from @backstage/core-plugin-api. Components that require this context to be available should use the compatWrapper helper from @backstage/core-compat-api.

Patch Changes

  • aeb8008: Add support for translation extensions.
  • b7adf24: Use the new plugin type for error boundary components.
  • 8f5d6c1: Updates to match the new extension input wrapping.
  • cb4197a: Forward node`` instead of extensionId` to resolved extension inputs.
  • 8837a96: Updates to match the introduction of ExtensionDefinition and new extension ID naming patterns.
  • Updated dependencies

0.4.0-next.1

Minor Changes

  • e539735435: Updated core extension structure to make space for the sign-in page by adding core.router.

Patch Changes

  • 5eb6b8a7bc: Added the nav logo extension for customization of sidebar logo
  • 1f12fb762c: Create a core components extension that allows adopters to override core app components such as Progress, BootErrorPage, NotFoundErrorPage and ErrorBoundaryFallback.
  • 59709286b3: Collect and register feature flags from plugins and extension overrides.
  • f27ee7d937: Migrate analytics route tracker component.
  • a5a04739e1: Updates to provide node to extension factories instead of id and source.
  • Updated dependencies

0.3.1-next.0

Patch Changes

  • 60d6eb544e: Removed @backstage/plugin-graphiql dependency.
  • 9ad4039efa: Bringing over apis from core-plugin-api
  • b8cb7804c8: Added createSpecializedApp, which is a synchronous version of createApp where config and features already need to be loaded.
  • Updated dependencies

0.3.0

Minor Changes

  • 68fc9dc60e: Added the ability to configure bound routes through app.routes.bindings. The routing system used by createApp has been replaced by one that only supports route refs of the new format from @backstage/frontend-plugin-api. The requirement for route refs to have the same ID as their associated extension has been removed.

Patch Changes

  • e28d379e32: Refactor internal extension instance system into an app graph.
  • fdc348d5d3: The options parameter of createApp is now optional.
  • 6c2b872153: Add official support for React 18.
  • dc613f9bcf: Updated app.extensions configuration schema.
  • 733bd95746: Implement new AppTreeApi
  • 685a4c8901: Installed features are now deduplicated both by reference and ID when available. Features passed to createApp now override both discovered and loaded features.
  • fa28d4e6df: No longer throw error on invalid input if the child is disabled.
  • bb98953cb9: Register default implementation for the Translation API on the new createApp.
  • fe6d09953d: Fix for app node output IDs not being serialized correctly.
  • 77f009b35d: Internal updates to match changes in the experimental @backstage/frontend-plugin-api.
  • 4d6fa921db: Internal refactor to rename the app graph to app tree
  • Updated dependencies

0.3.0-next.2

Patch Changes

0.3.0-next.1

Patch Changes

  • fe6d09953d: Fix for app node output IDs not being serialized correctly.
  • 77f009b35d: Internal updates to match changes in the experimental @backstage/frontend-plugin-api.
  • 4d6fa921db: Internal refactor to rename the app graph to app tree
  • Updated dependencies
    • @backstage/frontend-plugin-api@0.3.0-next.1
    • @backstage/plugin-graphiql@0.3.0-next.1
    • @backstage/core-components@0.13.8-next.1
    • @backstage/config@1.1.1
    • @backstage/core-app-api@1.11.1-next.0
    • @backstage/core-plugin-api@1.8.0-next.0
    • @backstage/theme@0.4.4-next.0
    • @backstage/types@1.1.1
    • @backstage/version-bridge@1.0.7-next.0

0.3.0-next.0

Minor Changes

  • 68fc9dc60e: Added the ability to configure bound routes through app.routes.bindings. The routing system used by createApp has been replaced by one that only supports route refs of the new format from @backstage/frontend-plugin-api. The requirement for route refs to have the same ID as their associated extension has been removed.

Patch Changes

  • e28d379e32: Refactor internal extension instance system into an app graph.
  • 6c2b872153: Add official support for React 18.
  • dc613f9bcf: Updated app.extensions configuration schema.
  • 685a4c8901: Installed features are now deduplicated both by reference and ID when available. Features passed to createApp now override both discovered and loaded features.
  • bb98953cb9: Register default implementation for the Translation API on the new createApp.
  • Updated dependencies
    • @backstage/core-components@0.13.7-next.0
    • @backstage/frontend-plugin-api@0.3.0-next.0
    • @backstage/plugin-graphiql@0.3.0-next.0
    • @backstage/core-plugin-api@1.8.0-next.0
    • @backstage/version-bridge@1.0.7-next.0
    • @backstage/core-app-api@1.11.1-next.0
    • @backstage/theme@0.4.4-next.0
    • @backstage/config@1.1.1
    • @backstage/types@1.1.1

0.2.0

Minor Changes

  • 4461d87d5a: Removed support for the new useRouteRef.
  • 9d03dfe5e3: The createApp config option has been replaced by a new configLoader option. There is now also a pluginLoader option that can be used to dynamically load plugins into the app.
  • d7c5d80c57: The hidden 'root' extension has been removed and has instead been made an input of the 'core' extension. The checks for rejecting configuration of the 'root' extension to rejects configuration of the 'core' extension instead.
  • d920b8c343: Added support for installing ExtensionOverrides via createApp options. As part of this change the plugins option has been renamed to features, and the pluginLoader has been renamed to featureLoader.

Patch Changes

  • 322bbcae24: Internal update for removal of experimental plugin configuration API.
  • f78ac58f88: Filters for discovered packages are now also applied at runtime. This makes it possible to disable packages through the app.experimental.packages config at runtime.
  • 68ffb9e67d: The app will now reject any extensions that attach to nonexistent inputs.
  • 5072824817: Implement toString() and toJSON() for extension instances.
  • 1e60a9c3a5: Fixed an issue preventing the routing system to match subroutes
  • 52366db5b3: Make themes configurable through extensions, and switched default themes to use extensions instead.
  • 2ecd33618a: Added the bindRoutes option to createApp.
  • e5a2956dd2: Register default api implementations when creating declarative integrated apps.
  • 9a1fce352e: Updated dependency @testing-library/jest-dom to ^6.0.0.
  • 06432f900c: Updates for at -> attachTo refactor.
  • 1718ec75b7: Added support for the existing routing system.
  • 66d51a4827: Prevents root extension override and duplicated plugin extensions.
  • Updated dependencies

0.2.0-next.2

Minor Changes

  • 4461d87d5a: Removed support for the new useRouteRef.

Patch Changes

  • 5072824817: Implement toString() and toJSON() for extension instances.
  • 06432f900c: Updates for at -> attachTo refactor.
  • 1718ec75b7: Added support for the existing routing system.
  • Updated dependencies
    • @backstage/frontend-plugin-api@0.2.0-next.2
    • @backstage/core-app-api@1.11.0-next.2
    • @backstage/core-components@0.13.6-next.2
    • @backstage/core-plugin-api@1.7.0-next.1
    • @backstage/plugin-graphiql@0.2.55-next.2
    • @backstage/theme@0.4.3-next.0
    • @backstage/config@1.1.1-next.0
    • @backstage/types@1.1.1
    • @backstage/version-bridge@1.0.5

0.2.0-next.1

Patch Changes

  • 52366db5b3: Make themes configurable through extensions, and switched default themes to use extensions instead.
  • e5a2956dd2: Register default api implementations when creating declarative integrated apps.
  • Updated dependencies

0.2.0-next.0

Minor Changes

  • 9d03dfe5e3: The createApp config option has been replaced by a new configLoader option. There is now also a pluginLoader option that can be used to dynamically load plugins into the app.

Patch Changes

  • 322bbcae24: Internal update for removal of experimental plugin configuration API.
  • 66d51a4827: Prevents root extension override and duplicated plugin extensions.
  • Updated dependencies

0.1.0

Minor Changes

Patch Changes

0.1.0-next.0

Minor Changes

Patch Changes

  • Updated dependencies

0.0.1-next.1

Patch Changes

  • Updated dependencies
    • @backstage/core-plugin-api@1.6.0-next.2
    • @backstage/plugin-graphiql@0.2.54-next.2
    • @backstage/config@1.1.0-next.1
    • @backstage/frontend-plugin-api@0.0.1-next.0
    • @backstage/types@1.1.0

0.0.1-next.0

Patch Changes

  • Updated dependencies
    • @backstage/config@1.1.0-next.0
    • @backstage/plugin-graphiql@0.2.54-next.1
    • @backstage/frontend-plugin-api@0.0.0
    • @backstage/types@1.1.0
Reference in New Issue View Git Blame Copy Permalink