From 663fd697f188b4cfe21789ea152833fb6a0a23b7 Mon Sep 17 00:00:00 2001 From: Paul Cowan Date: Fri, 7 Oct 2022 13:06:08 +0100 Subject: [PATCH] prefix IssuesFilters and IssuesOrdering with Github Signed-off-by: Paul Cowan --- plugins/github-issues/src/api/gitHubIssuesApi.ts | 14 ++++++++------ .../src/components/GitHubIssues/GitHubIssues.tsx | 9 ++++++--- plugins/github-issues/src/index.ts | 4 ++-- 3 files changed, 16 insertions(+), 11 deletions(-) diff --git a/plugins/github-issues/src/api/gitHubIssuesApi.ts b/plugins/github-issues/src/api/gitHubIssuesApi.ts index c813e35be5..d80ec3bce8 100644 --- a/plugins/github-issues/src/api/gitHubIssuesApi.ts +++ b/plugins/github-issues/src/api/gitHubIssuesApi.ts @@ -76,7 +76,7 @@ export type GitHubIssuesApi = ReturnType; /** * @public */ -export interface IssuesFilters { +export interface GithubIssuesFilters { assignee?: string; createdBy?: string; labels?: string[]; @@ -88,7 +88,7 @@ export interface IssuesFilters { /** * @public */ -export interface IssuesOrdering { +export interface GithubIssuesOrdering { field: 'CREATED_AT' | 'UPDATED_AT' | 'COMMENTS'; direction?: 'ASC' | 'DESC'; } @@ -97,8 +97,8 @@ export interface IssuesOrdering { * @public */ export interface IssuesByRepoOptions { - filterBy?: IssuesFilters; - orderBy?: IssuesOrdering; + filterBy?: GithubIssuesFilters; + orderBy?: GithubIssuesOrdering; } /** @internal */ @@ -189,7 +189,9 @@ export const gitHubIssuesApi = ( return { fetchIssuesByRepoFromGitHub }; }; -function formatFilterValue(value: IssuesFilters[keyof IssuesFilters]): string { +function formatFilterValue( + value: GithubIssuesFilters[keyof GithubIssuesFilters], +): string { if (Array.isArray(value)) { return `[ ${value.map(formatFilterValue).join(', ')}]`; } @@ -197,7 +199,7 @@ function formatFilterValue(value: IssuesFilters[keyof IssuesFilters]): string { return typeof value === 'string' ? `\"${value}\"` : `${value}`; } -function createFilterByClause(filterBy?: IssuesFilters): string { +function createFilterByClause(filterBy?: GithubIssuesFilters): string { if (!filterBy) { return ''; } diff --git a/plugins/github-issues/src/components/GitHubIssues/GitHubIssues.tsx b/plugins/github-issues/src/components/GitHubIssues/GitHubIssues.tsx index a8a192dece..cb6639c83c 100644 --- a/plugins/github-issues/src/components/GitHubIssues/GitHubIssues.tsx +++ b/plugins/github-issues/src/components/GitHubIssues/GitHubIssues.tsx @@ -24,7 +24,10 @@ import { useGetIssuesByRepoFromGitHub } from '../../hooks/useGetIssuesByRepoFrom import { IssuesList } from './IssuesList'; import { NoRepositoriesInfo } from './NoRepositoriesInfo'; -import type { IssuesFilters, IssuesOrdering } from '../../api/gitHubIssuesApi'; +import type { + GithubIssuesFilters, + GithubIssuesOrdering, +} from '../../api/gitHubIssuesApi'; /** * @public @@ -32,8 +35,8 @@ import type { IssuesFilters, IssuesOrdering } from '../../api/gitHubIssuesApi'; export type GitHubIssuesProps = { itemsPerPage?: number; itemsPerRepo?: number; - filterBy?: IssuesFilters; - orderBy?: IssuesOrdering; + filterBy?: GithubIssuesFilters; + orderBy?: GithubIssuesOrdering; }; export const GitHubIssues = (props: GitHubIssuesProps) => { diff --git a/plugins/github-issues/src/index.ts b/plugins/github-issues/src/index.ts index f17cc1e2e6..e6447a69c7 100644 --- a/plugins/github-issues/src/index.ts +++ b/plugins/github-issues/src/index.ts @@ -21,7 +21,7 @@ export { export type { GitHubIssuesProps } from './components/GitHubIssues'; export type { - IssuesFilters, - IssuesOrdering, + GithubIssuesFilters, + GithubIssuesOrdering, IssuesByRepoOptions, } from './api/gitHubIssuesApi';