paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 19 Packages Projects Releases Wiki Activity

feat: make plugin api internal

Browse Source 
Signed-off-by: Kamil Wolny <mrwolny@gmail.com>
This commit is contained in:
Kamil Wolny
2022-08-10 17:14:21 +01:00
parent eb23e4b362
commit 07096fa843
2 changed files with 9 additions and 83 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/github-issues/api-report.md
-74
View File
@@ -5,49 +5,9 @@
```ts
/// <reference types="react" />
import { ApiRef } from '@backstage/core-plugin-api';
import { BackstagePlugin } from '@backstage/core-plugin-api';
import { ConfigApi } from '@backstage/core-plugin-api';
import { ErrorApi } from '@backstage/core-plugin-api';
import { OAuthApi } from '@backstage/core-plugin-api';
import { RouteRef } from '@backstage/core-plugin-api';
// @public (undocumented)
export type Assignee = {
avatarUrl: string;
login: string;
};
// @public (undocumented)
export type EdgesWithNodes<T> = {
edges: Array<{
node: T;
}>;
};
// @public (undocumented)
export type GitHubIssuesApi = ReturnType<typeof gitHubIssuesApi>;
// @public (undocumented)
export const gitHubIssuesApi: (
githubAuthApi: OAuthApi,
configApi: ConfigApi,
errorApi: ErrorApi,
) => {
fetchIssuesByRepoFromGitHub: (
repos: Array<string>,
itemsPerRepo: number,
) => Promise<IssuesByRepo>;
};
// @public (undocumented)
export const gitHubIssuesApiRef: ApiRef<{
fetchIssuesByRepoFromGitHub: (
repos: Array<string>,
itemsPerRepo: number,
) => Promise<IssuesByRepo>;
}>;
// @public (undocumented)
export const GitHubIssuesCard: (props: GitHubIssuesProps) => JSX.Element;
@@ -69,39 +29,5 @@ export type GitHubIssuesProps = {
itemsPerRepo?: number;
};
// @public (undocumented)
export type Issue = {
assignees: EdgesWithNodes<Assignee>;
author: IssueAuthor;
repository: {
nameWithOwner: string;
};
title: string;
url: string;
participants: {
totalCount: number;
};
createdAt: string;
updatedAt: string;
comments: {
totalCount: number;
};
};
// @public (undocumented)
export type IssueAuthor = {
login: string;
};
// @public (undocumented)
export type IssuesByRepo = Record<string, RepoIssues>;
// @public (undocumented)
export type RepoIssues = {
issues: {
totalCount: number;
} & EdgesWithNodes<Issue>;
};
// (No @packageDocumentation comment for this package)
```
plugins/github-issues/src/api/gitHubIssuesApi.ts
+9 -9
View File
@@ -23,25 +23,25 @@ import {
import { readGitHubIntegrationConfigs } from '@backstage/integration';
import { ForwardedError } from '@backstage/errors';
/** @public */
/** @internal */
export type Assignee = {
avatarUrl: string;
login: string;
};
/** @public */
/** @internal */
export type EdgesWithNodes<T> = {
edges: Array<{
node: T;
}>;
};
/** @public */
/** @internal */
export type IssueAuthor = {
login: string;
};
/** @public */
/** @internal */
export type Issue = {
assignees: EdgesWithNodes<Assignee>;
author: IssueAuthor;
@@ -60,25 +60,25 @@ export type Issue = {
};
};
/** @public */
/** @internal */
export type RepoIssues = {
issues: {
totalCount: number;
} & EdgesWithNodes<Issue>;
};
/** @public */
/** @internal */
export type IssuesByRepo = Record<string, RepoIssues>;
/** @public */
/** @internal */
export type GitHubIssuesApi = ReturnType<typeof gitHubIssuesApi>;
/** @public */
/** @internal */
export const gitHubIssuesApiRef = createApiRef<GitHubIssuesApi>({
id: 'plugin.githubissues.service',
});
/** @public */
/** @internal */
export const gitHubIssuesApi = (
githubAuthApi: OAuthApi,
configApi: ConfigApi,