@stackoverflow/backstage-plugin-stack-overflow-teams 1.6.0 → 1.6.2
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/README.md +6 -6
- package/config.d.ts +6 -6
- package/package.json +4 -6
- package/src/index.ts +5 -0
package/README.md
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
# Stack
|
|
1
|
+
# Stack Internal Frontend Plugin
|
|
2
2
|
|
|
3
3
|
This package is the frontend counterpart of the `stack-overflow-teams` plugin for Backstage.
|
|
4
4
|
|
|
5
5
|
## Areas of Responsibility
|
|
6
6
|
|
|
7
|
-
It provides the UI and interacts with the [backend service](https://github.com/EstoesMoises/backstage-stackoverflow/tree/main/plugins/stack-overflow-teams-backend) to fetch data from your Stack
|
|
7
|
+
It provides the UI and interacts with the [backend service](https://github.com/EstoesMoises/backstage-stackoverflow/tree/main/plugins/stack-overflow-teams-backend) to fetch data from your Stack Internal Enterprise instance.
|
|
8
8
|
|
|
9
9
|
### Backend Dependency
|
|
10
10
|
|
|
@@ -16,7 +16,7 @@ To fully utilize this plugin, you must also install and configure the correspond
|
|
|
16
16
|
|
|
17
17
|
This component is a modified version of the [community plugin.](https://github.com/backstage/community-plugins/tree/main/workspaces/stack-overflow/plugins/stack-overflow/src/search/StackOverflowSearchResultListItem)
|
|
18
18
|
|
|
19
|
-
It adds a more Stack Overflow-like interface, including additional information such as the questions' score, user role, user reputation, and timestamp.
|
|
19
|
+
It adds a more Stack Overflow Internal-like interface, including additional information such as the questions' score, user role, user reputation, and timestamp.
|
|
20
20
|
|
|
21
21
|
---
|
|
22
22
|
|
|
@@ -28,7 +28,7 @@ It adds a more Stack Overflow-like interface, including additional information s
|
|
|
28
28
|
|
|
29
29
|
- **`<StackOverflowPostQuestionModal />`**
|
|
30
30
|
|
|
31
|
-
Provides a form for users to create a new Stack Overflow question. Once submitted, an API request is executed to create the question.
|
|
31
|
+
Provides a form for users to create a new Stack Overflow Internal question. Once submitted, an API request is executed to create the question.
|
|
32
32
|
|
|
33
33
|
This form listens to the `'openAskQuestionModal'` event. You can utilize this anywhere in your Backstage UI. To invoke the form, add the component to your UI along with a button that dispatches the event. Example:
|
|
34
34
|
|
|
@@ -70,7 +70,7 @@ It adds a more Stack Overflow-like interface, including additional information s
|
|
|
70
70
|
|
|
71
71
|
- **`<StackAuthCallback />`**
|
|
72
72
|
|
|
73
|
-
Receives the code and state from your Stack
|
|
73
|
+
Receives the code and state from your Stack Internal Enterprise instance as part of the OAuth process and initiates **`/callback`** in the backend.
|
|
74
74
|
|
|
75
75
|
- **`<StackAuthSuccess />`**
|
|
76
76
|
|
|
@@ -88,4 +88,4 @@ It adds a more Stack Overflow-like interface, including additional information s
|
|
|
88
88
|
|
|
89
89
|
### API Requests
|
|
90
90
|
|
|
91
|
-
The frontend plugin creates an API Ref for Stack
|
|
91
|
+
The frontend plugin creates an API Ref for Stack Internal, which can be found under the `/api` folder. **All API requests from the frontend are directed to Backstage's backend**.
|
package/config.d.ts
CHANGED
|
@@ -16,34 +16,34 @@
|
|
|
16
16
|
|
|
17
17
|
export interface Config {
|
|
18
18
|
/**
|
|
19
|
-
* Configuration options for the
|
|
19
|
+
* Configuration options for the Stack Internal frontend plugin.
|
|
20
20
|
*
|
|
21
21
|
* This configuration is shared with the @stackoverflow/backstage-plugin-stack-overflow-teams-backend and @stackoverflow/backstage-stack-overflow-teams-collator
|
|
22
22
|
*/
|
|
23
23
|
stackoverflow?: {
|
|
24
24
|
/**
|
|
25
|
-
* The base url of the Stack Overflow API used for the plugin
|
|
25
|
+
* The base url of the Stack Overflow Internal API used for the plugin
|
|
26
26
|
*/
|
|
27
27
|
baseUrl: string;
|
|
28
28
|
|
|
29
29
|
/**
|
|
30
|
-
* The API Access Token to authenticate to Stack Overflow API Version 3
|
|
30
|
+
* The API Access Token to authenticate to Stack Overflow Internal API Version 3
|
|
31
31
|
* @visibility secret
|
|
32
32
|
*/
|
|
33
33
|
apiAccessToken: string;
|
|
34
34
|
|
|
35
35
|
/**
|
|
36
|
-
* The name of the team for a Stack
|
|
36
|
+
* The name of the team for a Stack Internal account
|
|
37
37
|
*/
|
|
38
38
|
teamName?: string;
|
|
39
39
|
|
|
40
40
|
/**
|
|
41
|
-
* Client Id for the OAuth Application, required to use the Stack
|
|
41
|
+
* Client Id for the OAuth Application, required to use the Stack Internal Hub and write actions.
|
|
42
42
|
*/
|
|
43
43
|
clientId: number;
|
|
44
44
|
|
|
45
45
|
/**
|
|
46
|
-
* RedirectUri for the OAuth Application, required to use the Stack
|
|
46
|
+
* RedirectUri for the OAuth Application, required to use the Stack Internal Hub and write actions.
|
|
47
47
|
*
|
|
48
48
|
* This should be your Backstage application domain ending in the plugin's <StackOverflowTeamsPage /> route
|
|
49
49
|
*/
|
package/package.json
CHANGED
|
@@ -1,13 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stackoverflow/backstage-plugin-stack-overflow-teams",
|
|
3
|
-
"version": "1.6.
|
|
4
|
-
"main": "
|
|
5
|
-
"types": "
|
|
3
|
+
"version": "1.6.2",
|
|
4
|
+
"main": "src/index.ts",
|
|
5
|
+
"types": "src/index.ts",
|
|
6
6
|
"license": "Apache-2.0",
|
|
7
7
|
"publishConfig": {
|
|
8
|
-
"access": "public"
|
|
9
|
-
"main": "dist/index.esm.js",
|
|
10
|
-
"types": "dist/index.d.ts"
|
|
8
|
+
"access": "public"
|
|
11
9
|
},
|
|
12
10
|
"backstage": {
|
|
13
11
|
"role": "frontend-plugin",
|