catalog-common: migrate to use exports

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2023-01-16 09:59:08 +01:00
parent dac6ddfae8
commit 57d39ea54a
5 changed files with 90 additions and 58 deletions
@@ -0,0 +1,45 @@
## API Report File for "@backstage/plugin-catalog-common"
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { BasicPermission } from '@backstage/plugin-permission-common';
import { ResourcePermission } from '@backstage/plugin-permission-common';
// @alpha
export const catalogEntityCreatePermission: BasicPermission;
// @alpha
export const catalogEntityDeletePermission: ResourcePermission<'catalog-entity'>;
// @alpha
export type CatalogEntityPermission = ResourcePermission<
typeof RESOURCE_TYPE_CATALOG_ENTITY
>;
// @alpha
export const catalogEntityReadPermission: ResourcePermission<'catalog-entity'>;
// @alpha
export const catalogEntityRefreshPermission: ResourcePermission<'catalog-entity'>;
// @alpha
export const catalogLocationCreatePermission: BasicPermission;
// @alpha
export const catalogLocationDeletePermission: BasicPermission;
// @alpha
export const catalogLocationReadPermission: BasicPermission;
// @alpha
export const catalogPermissions: (
| BasicPermission
| ResourcePermission<'catalog-entity'>
)[];
// @alpha
export const RESOURCE_TYPE_CATALOG_ENTITY = 'catalog-entity';
// (No @packageDocumentation comment for this package)
```
-37
View File
@@ -3,10 +3,8 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { BasicPermission } from '@backstage/plugin-permission-common';
import { Entity } from '@backstage/catalog-model';
import { IndexableDocument } from '@backstage/plugin-search-common';
import { ResourcePermission } from '@backstage/plugin-permission-common';
// @public (undocumented)
export type AnalyzeLocationEntityField = {
@@ -44,12 +42,6 @@ export type AnalyzeLocationResponse = {
generateEntities: AnalyzeLocationGenerateEntity[];
};
// @alpha
export const catalogEntityCreatePermission: BasicPermission;
// @alpha
export const catalogEntityDeletePermission: ResourcePermission<'catalog-entity'>;
// @public
export interface CatalogEntityDocument extends IndexableDocument {
// @deprecated (undocumented)
@@ -66,39 +58,10 @@ export interface CatalogEntityDocument extends IndexableDocument {
type: string;
}
// @alpha
export type CatalogEntityPermission = ResourcePermission<
typeof RESOURCE_TYPE_CATALOG_ENTITY
>;
// @alpha
export const catalogEntityReadPermission: ResourcePermission<'catalog-entity'>;
// @alpha
export const catalogEntityRefreshPermission: ResourcePermission<'catalog-entity'>;
// @alpha
export const catalogLocationCreatePermission: BasicPermission;
// @alpha
export const catalogLocationDeletePermission: BasicPermission;
// @alpha
export const catalogLocationReadPermission: BasicPermission;
// @alpha
export const catalogPermissions: (
| BasicPermission
| ResourcePermission<'catalog-entity'>
)[];
// @public
export type LocationSpec = {
type: string;
target: string;
presence?: 'optional' | 'required';
};
// @alpha
export const RESOURCE_TYPE_CATALOG_ENTITY = 'catalog-entity';
```
+17 -8
View File
@@ -6,11 +6,21 @@
"types": "src/index.ts",
"license": "Apache-2.0",
"publishConfig": {
"access": "public",
"main": "dist/index.cjs.js",
"module": "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": "common-library"
@@ -25,7 +35,7 @@
"backstage"
],
"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",
@@ -41,7 +51,6 @@
"@backstage/cli": "workspace:^"
},
"files": [
"dist",
"alpha"
"dist"
]
}
+28
View File
@@ -0,0 +1,28 @@
/*
* 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 {
RESOURCE_TYPE_CATALOG_ENTITY,
catalogEntityReadPermission,
catalogEntityCreatePermission,
catalogEntityDeletePermission,
catalogEntityRefreshPermission,
catalogLocationReadPermission,
catalogLocationCreatePermission,
catalogLocationDeletePermission,
catalogPermissions,
} from './permissions';
export type { CatalogEntityPermission } from './permissions';
-13
View File
@@ -21,19 +21,6 @@
* @packageDocumentation
*/
export {
RESOURCE_TYPE_CATALOG_ENTITY,
catalogEntityReadPermission,
catalogEntityCreatePermission,
catalogEntityDeletePermission,
catalogEntityRefreshPermission,
catalogLocationReadPermission,
catalogLocationCreatePermission,
catalogLocationDeletePermission,
catalogPermissions,
} from './permissions';
export type { CatalogEntityPermission } from './permissions';
export * from './search';
export * from './ingestion';
export type { LocationSpec } from './common';