Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit f19b7e2

Browse files
committedJul 8, 2022
packages: add initial backend app and plugin API packages
Signed-off-by: Patrik Oldsberg <[email protected]>
1 parent 8452913 commit f19b7e2

File tree

8 files changed

+170
-0
lines changed

8 files changed

+170
-0
lines changed
 

‎packages/backend-app-api/.eslintrc.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
module.exports = require('@backstage/cli/config/eslint-factory')(__dirname);

‎packages/backend-app-api/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# @backstage/backend-app-api
2+
3+
This package provides the core API used by Backstage backend apps.
4+
5+
## Installation
6+
7+
Add the library to your backend app package:
8+
9+
```bash
10+
# From your Backstage root directory
11+
yarn add --cwd packages/backend @backstage/backend-app-api
12+
```
13+
14+
## Documentation
15+
16+
- [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md)
17+
- [Backstage Documentation](https://github.com/backstage/backstage/blob/master/docs/README.md)

‎packages/backend-app-api/package.json

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
{
2+
"name": "@backstage/backend-app-api",
3+
"description": "Core API used by Backstage backend apps",
4+
"version": "0.0.0",
5+
"main": "src/index.ts",
6+
"types": "src/index.ts",
7+
"private": false,
8+
"publishConfig": {
9+
"access": "public",
10+
"main": "dist/index.cjs.js",
11+
"types": "dist/index.d.ts",
12+
"alphaTypes": "dist/index.alpha.d.ts"
13+
},
14+
"backstage": {
15+
"role": "node-library"
16+
},
17+
"homepage": "https://backstage.io",
18+
"repository": {
19+
"type": "git",
20+
"url": "https://github.com/backstage/backstage",
21+
"directory": "packages/backend-app-api"
22+
},
23+
"keywords": [
24+
"backstage"
25+
],
26+
"license": "Apache-2.0",
27+
"scripts": {
28+
"build": "backstage-cli package build --experimental-type-build",
29+
"lint": "backstage-cli package lint",
30+
"test": "backstage-cli package test",
31+
"prepack": "backstage-cli package prepack",
32+
"postpack": "backstage-cli package postpack",
33+
"clean": "backstage-cli package clean",
34+
"start": "backstage-cli package start"
35+
},
36+
"dependencies": {},
37+
"devDependencies": {
38+
"@backstage/cli": "^0.17.2-next.0"
39+
},
40+
"files": [
41+
"dist",
42+
"alpha"
43+
]
44+
}

‎packages/backend-app-api/src/index.ts

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
/*
2+
* Copyright 2020 The Backstage Authors
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
/**
18+
* Core API used by Backstage backend apps.
19+
*
20+
* @packageDocumentation
21+
*/
22+
23+
export {};
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
module.exports = require('@backstage/cli/config/eslint-factory')(__dirname);

‎packages/backend-plugin-api/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# @backstage/backend-plugin-api
2+
3+
This package provides the core API used by Backstage backend plugins.
4+
5+
## Installation
6+
7+
Add the library to your backend plugin package:
8+
9+
```bash
10+
# From your Backstage root directory
11+
yarn add --cwd plugin/<plugin>-backend @backstage/backend-plugin-api
12+
```
13+
14+
## Documentation
15+
16+
- [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md)
17+
- [Backstage Documentation](https://github.com/backstage/backstage/blob/master/docs/README.md)
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
{
2+
"name": "@backstage/backend-plugin-api",
3+
"description": "Core API used by Backstage backend plugins",
4+
"version": "0.0.0",
5+
"main": "src/index.ts",
6+
"types": "src/index.ts",
7+
"private": false,
8+
"publishConfig": {
9+
"access": "public",
10+
"main": "dist/index.cjs.js",
11+
"types": "dist/index.d.ts",
12+
"alphaTypes": "dist/index.alpha.d.ts"
13+
},
14+
"backstage": {
15+
"role": "node-library"
16+
},
17+
"homepage": "https://backstage.io",
18+
"repository": {
19+
"type": "git",
20+
"url": "https://github.com/backstage/backstage",
21+
"directory": "packages/backend-plugin-api"
22+
},
23+
"keywords": [
24+
"backstage"
25+
],
26+
"license": "Apache-2.0",
27+
"scripts": {
28+
"build": "backstage-cli package build --experimental-type-build",
29+
"lint": "backstage-cli package lint",
30+
"test": "backstage-cli package test",
31+
"prepack": "backstage-cli package prepack",
32+
"postpack": "backstage-cli package postpack",
33+
"clean": "backstage-cli package clean",
34+
"start": "backstage-cli package start"
35+
},
36+
"dependencies": {},
37+
"devDependencies": {
38+
"@backstage/cli": "^0.17.2-next.0"
39+
},
40+
"files": [
41+
"dist",
42+
"alpha"
43+
]
44+
}
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
/*
2+
* Copyright 2020 The Backstage Authors
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
/**
18+
* Core API used by Backstage backend plugins.
19+
*
20+
* @packageDocumentation
21+
*/
22+
23+
export {};

0 commit comments

Comments
 (0)
Please sign in to comment.