core-plugin-api: migrate to use exports

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2023-01-16 10:54:24 +01:00
parent 76a21aad7e
commit 7b76628a6a
5 changed files with 61 additions and 24 deletions
@@ -0,0 +1,27 @@
## API Report File for "@backstage/core-plugin-api"
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { ReactNode } from 'react';
// @alpha
export interface PluginOptionsProviderProps {
// (undocumented)
children: ReactNode;
// Warning: (ae-forgotten-export) The symbol "BackstagePlugin" needs to be exported by the entry point alpha.d.ts
//
// (undocumented)
plugin?: BackstagePlugin;
}
// @alpha
export const PluginProvider: (props: PluginOptionsProviderProps) => JSX.Element;
// @alpha
export function usePluginOptions<
TPluginOptions extends {} = {},
>(): TPluginOptions;
// (No @packageDocumentation comment for this package)
```
-16
View File
@@ -649,17 +649,6 @@ export type PluginFeatureFlagConfig = {
name: string;
};
// @alpha
export interface PluginOptionsProviderProps {
// (undocumented)
children: ReactNode;
// (undocumented)
plugin?: BackstagePlugin;
}
// @alpha
export const PluginProvider: (props: PluginOptionsProviderProps) => JSX.Element;
// @public
export type ProfileInfo = {
email?: string;
@@ -760,11 +749,6 @@ export function useElementFilter<T>(
dependencies?: any[],
): T;
// @alpha
export function usePluginOptions<
TPluginOptions extends {} = {},
>(): TPluginOptions;
// @public
export function useRouteRef<Optional extends boolean, Params extends AnyParams>(
routeRef: ExternalRouteRef<Params, Optional>,
+17 -7
View File
@@ -3,10 +3,21 @@
"description": "Core API used by Backstage plugins",
"version": "1.4.0",
"publishConfig": {
"access": "public",
"main": "dist/index.esm.js",
"types": "dist/index.d.ts",
"alphaTypes": "dist/index.alpha.d.ts"
"access": "public"
},
"exports": {
".": "./src/index.ts",
"./alpha": "./src/alpha.ts"
},
"typesVersions": {
"*": {
"*": [
"src/index.ts"
],
"alpha": [
"src/alpha.ts"
]
}
},
"backstage": {
"role": "web-library"
@@ -24,7 +35,7 @@
"main": "src/index.ts",
"types": "src/index.ts",
"scripts": {
"build": "backstage-cli package build --experimental-type-build",
"build": "backstage-cli package build",
"lint": "backstage-cli package lint",
"test": "backstage-cli package test",
"prepack": "backstage-cli package prepack",
@@ -60,7 +71,6 @@
"msw": "^0.49.0"
},
"files": [
"dist",
"alpha"
"dist"
]
}
+17
View File
@@ -0,0 +1,17 @@
/*
* Copyright 2023 The Backstage Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export * from './plugin-options';
-1
View File
@@ -22,7 +22,6 @@
export * from './analytics';
export * from './apis';
export * from './plugin-options';
export * from './app';
export * from './extensions';
export * from './icons';