@backstage/core-plugin-api 0.3.0 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +60 -0
- package/dist/index.d.ts +207 -210
- package/dist/index.esm.js +11 -56
- package/dist/index.esm.js.map +1 -1
- package/package.json +6 -8
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,65 @@
|
|
|
1
1
|
# @backstage/core-plugin-api
|
|
2
2
|
|
|
3
|
+
## 0.5.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- 784d8078ab: Removed the deprecated `OldIconComponent` type.
|
|
8
|
+
- e2eb92c109: Removed previously deprecated exports: `PluginHooks`, `PluginOutput`, and `FeatureFlagOutput`.
|
|
9
|
+
|
|
10
|
+
The deprecated `register` method of `PluginConfig` has been removed, as well as the deprecated `output` method of `BackstagePlugin`.
|
|
11
|
+
|
|
12
|
+
### Patch Changes
|
|
13
|
+
|
|
14
|
+
- 784d8078ab: Removed direct and transitive MUI dependencies.
|
|
15
|
+
- Updated dependencies
|
|
16
|
+
- @backstage/config@0.1.12
|
|
17
|
+
|
|
18
|
+
## 0.4.1
|
|
19
|
+
|
|
20
|
+
### Patch Changes
|
|
21
|
+
|
|
22
|
+
- c534ef2242: Deprecated `OldIconComponent`. Existing usage should be replaced with `IconComponent`.
|
|
23
|
+
|
|
24
|
+
## 0.4.0
|
|
25
|
+
|
|
26
|
+
### Minor Changes
|
|
27
|
+
|
|
28
|
+
- a195284c7b: **BREAKING CHANGE** The `StorageApi` has received several updates that fills in gaps for some use-cases and makes it easier to avoid mistakes:
|
|
29
|
+
|
|
30
|
+
- The `StorageValueChange` type has been renamed to `StorageValueSnapshot`, the `newValue` property has been renamed to `value`, the stored value type has been narrowed to `JsonValue`, and it has received a new `presence` property that is `'unknown'`, `'absent'`, or `'present'`.
|
|
31
|
+
- The `get` method has been deprecated in favor of a new `snapshot` method, which returns a `StorageValueSnapshot`.
|
|
32
|
+
- The `observe# @backstage/core-plugin-api method has had its contract changed. It should now emit values when the`presence`of a key changes, this may for example happen when remotely stored values are requested on page load and the presence switches from`'unknown'`to either`'absent'`or`'present'`.
|
|
33
|
+
|
|
34
|
+
The above changes have been made with deprecations in place to maintain much of the backwards compatibility for consumers of the `StorageApi`. The only breaking change is the narrowing of the stored value type, which may in some cases require the addition of an explicit type parameter to the `get` and `observe# @backstage/core-plugin-api methods.
|
|
35
|
+
|
|
36
|
+
- f6722d2458: - Removed deprecated option `description` from `ApiRefConfig`
|
|
37
|
+
- Removed descriptions from all plugin API refs
|
|
38
|
+
- Removed deprecated parameters `path`, `icon`, and `title` in `createRouteRef`
|
|
39
|
+
- Removed deprecated types `Error` and `ErrorContext` from `ErrorApi`
|
|
40
|
+
- 68f8b10ccd: - Removed deprecation configuration option `theme` from `AppTheme` of the `AppThemeApi`
|
|
41
|
+
- Removed reference to `theme` in the `app-defaults` default `AppTheme`
|
|
42
|
+
- Removed logic in `AppThemeProvider` that creates `ThemeProvider` from `appTheme.theme`
|
|
43
|
+
- 6b69b44862: Removed deprecated types `ApiRefType` and `ApiRefsToTypes`
|
|
44
|
+
|
|
45
|
+
### Patch Changes
|
|
46
|
+
|
|
47
|
+
- 7927005152: Add `FetchApi` and related `fetchApiRef` which implement fetch, with an added Backstage token header when available.
|
|
48
|
+
|
|
49
|
+
## 0.3.1
|
|
50
|
+
|
|
51
|
+
### Patch Changes
|
|
52
|
+
|
|
53
|
+
- 18d4f500af: Deprecated the `AnyAnalyticsContext` type and mark the `AnalyticsApi` experimental.
|
|
54
|
+
- 8a7372cfd5: Deprecated `auth0AuthApiRef`, `oauth2ApiRef`, `oidcAuthApiRef`, `samlAuthApiRef`, and marked the rest of the auth `ApiRef`s as experimental. For more information on how to address the deprecations, see https://backstage.io/docs/api/deprecations#generic-auth-api-refs.
|
|
55
|
+
- 760791a642: Renamed `AuthProvider` to `AuthProviderInfo` and add a required 'id' property to match the majority of usage. The `AuthProvider` type without the `id` property still exists but is deprecated, and all usage of it without an `id` is deprecated as well. For example, calling `createAuthRequest` without a `provider.id` is deprecated and it will be required in the future.
|
|
56
|
+
|
|
57
|
+
The following types have been renamed. The old names are still exported but deprecated, and are scheduled for removal in a future release.
|
|
58
|
+
|
|
59
|
+
- Renamed `AuthRequesterOptions` to `OAuthRequesterOptions`
|
|
60
|
+
- Renamed `AuthRequester` to `OAuthRequester`
|
|
61
|
+
- Renamed `PendingAuthRequest` to `PendingOAuthRequest`
|
|
62
|
+
|
|
3
63
|
## 0.3.0
|
|
4
64
|
|
|
5
65
|
### Minor Changes
|