refactor(api): update types

Signed-off-by: Adam Setch <[email protected]>

Author: setchy

codegen.ts

@@ -22,6 +22,7 @@ const config: CodegenConfig = {
       },
       config: {
         documentMode: 'string',
+        enumsAsTypes: true,
         useTypeImports: true,
       },
     },

src/renderer/components/metrics/MetricGroup.test.tsx

@@ -1,10 +1,7 @@
 import { renderWithAppContext } from '../../__helpers__/test-utils';
 import { mockSettings } from '../../__mocks__/state-mocks';
 import { mockSingleNotification } from '../../utils/api/__mocks__/response-mocks';
-import {
-  type MilestoneFieldsFragment,
-  MilestoneState,
-} from '../../utils/api/graphql/generated/graphql';
+import type { MilestoneFieldsFragment } from '../../utils/api/graphql/generated/graphql';
 import { MetricGroup } from './MetricGroup';
 
 describe('renderer/components/metrics/MetricGroup.tsx', () => {
@@ -106,7 +103,7 @@ describe('renderer/components/metrics/MetricGroup.tsx', () => {
       const mockNotification = mockSingleNotification;
       mockNotification.subject.milestone = {
         title: 'Milestone 1',
-        state: MilestoneState.Open,
+        state: 'OPEN',
       } as MilestoneFieldsFragment;
 
       const props = {
@@ -121,7 +118,7 @@ describe('renderer/components/metrics/MetricGroup.tsx', () => {
       const mockNotification = mockSingleNotification;
       mockNotification.subject.milestone = {
         title: 'Milestone 1',
-        state: MilestoneState.Closed,
+        state: 'CLOSED',
       } as MilestoneFieldsFragment;
 
       const props = {

src/renderer/components/metrics/MetricGroup.tsx

@@ -10,7 +10,6 @@ import {
 import { AppContext } from '../../context/App';
 import { IconColor } from '../../types';
 import type { Notification } from '../../typesGitHub';
-import { MilestoneState } from '../../utils/api/graphql/generated/graphql';
 import { getPullRequestReviewIcon } from '../../utils/icons';
 import { MetricPill } from './MetricPill';
 
@@ -85,7 +84,7 @@ export const MetricGroup: FC<MetricGroupProps> = ({
         {notification.subject.milestone && (
           <MetricPill
             color={
-              notification.subject.milestone.state === MilestoneState.Open
+              notification.subject.milestone.state === 'OPEN'
                 ? IconColor.GREEN
                 : IconColor.RED
             }

src/renderer/typesGitHub.ts

@@ -1,6 +1,7 @@
 import type { Account, Link } from './types';
 import type {
   AuthorFieldsFragment,
+  DiscussionStateReason,
   IssueState,
   IssueStateReason,
   MilestoneFieldsFragment,
@@ -26,13 +27,7 @@ export type Reason =
   | 'team_mention';
 
 // Note: ANSWERED and OPEN are not an official discussion state type in the GitHub API
-export type DiscussionStateType =
-  | 'ANSWERED'
-  | 'DUPLICATE'
-  | 'OPEN'
-  | 'OUTDATED'
-  | 'REOPENED'
-  | 'RESOLVED';
+export type GitifyDiscussionState = DiscussionStateReason | 'OPEN' | 'ANSWERED';
 
 export type SubjectType =
   | 'CheckSuite'
@@ -57,30 +52,30 @@ export type UserType =
  * Note: draft and merged are not official states in the GitHub API.
  * These are derived from the pull request's `merged` and `draft` properties.
  */
-export type PullRequestStateType = 'closed' | 'draft' | 'merged' | 'open';
+export type GitifyPullRequestState = PullRequestState | 'DRAFT';
+
+export type GitifyIssueState = IssueState | IssueStateReason;
 
 export type StateType =
-  | CheckSuiteStatus
-  | DiscussionStateType
-  | PullRequestStateType
-  | IssueState
-  | IssueStateReason
-  | PullRequestState;
+  | GitifyCheckSuiteStatus
+  | GitifyDiscussionState
+  | GitifyIssueState
+  | GitifyPullRequestState;
 
-export type CheckSuiteStatus =
-  | 'action_required'
-  | 'cancelled'
-  | 'completed'
-  | 'failure'
-  | 'in_progress'
-  | 'pending'
-  | 'queued'
-  | 'requested'
-  | 'skipped'
-  | 'stale'
-  | 'success'
-  | 'timed_out'
-  | 'waiting';
+export type GitifyCheckSuiteStatus =
+  | 'ACTION_REQUIRED'
+  | 'CANCELLED'
+  | 'COMPLETED'
+  | 'FAILURE'
+  | 'IN_PROGRESS'
+  | 'PENDING'
+  | 'QUEUED'
+  | 'REQUESTED'
+  | 'SKIPPED'
+  | 'STALE'
+  | 'SUCCESS'
+  | 'TIMED_OUT'
+  | 'WAITING';
 
 // TODO: #828 Add explicit types for GitHub API response vs Gitify Notifications object
 export type Notification = GitHubNotification & GitifyNotification;
@@ -345,20 +340,6 @@ export interface Release {
   published_at: string | null;
 }
 
-export interface CheckSuiteAttributes {
-  workflowName: string;
-  attemptNumber?: number;
-  statusDisplayName: string;
-  status: CheckSuiteStatus | null;
-  branchName: string;
-}
-
-export interface WorkflowRunAttributes {
-  user: string;
-  statusDisplayName: string;
-  status: CheckSuiteStatus | null;
-}
-
 export interface GitHubRESTError {
   message: string;
   documentation_url: Link;

src/renderer/utils/api/__mocks__/response-mocks.ts

@@ -4,10 +4,7 @@ import {
 } from '../../../__mocks__/account-mocks';
 import type { Link } from '../../../types';
 import type { Notification, Repository, User } from '../../../typesGitHub';
-import {
-  type FetchDiscussionByNumberQuery,
-  PullRequestReviewState,
-} from '../graphql/generated/graphql';
+import type { FetchDiscussionByNumberQuery } from '../graphql/generated/graphql';
 
 export const mockNotificationUser: User = {
   login: 'octocat',
@@ -52,7 +49,7 @@ export const mockGitHubNotifications: Notification[] = [
       latest_comment_url:
         'https://api.github.com/repos/gitify-app/notifications-test/issues/comments/302888448' as Link,
       type: 'Issue',
-      state: 'open',
+      state: 'OPEN',
       user: {
         login: 'gitify-app',
         html_url: 'https://github.com/gitify-app' as Link,
@@ -62,15 +59,15 @@ export const mockGitHubNotifications: Notification[] = [
       },
       reviews: [
         {
-          state: PullRequestReviewState.Approved,
+          state: 'APPROVED',
           users: ['octocat'],
         },
         {
-          state: PullRequestReviewState.ChangesRequested,
+          state: 'CHANGES_REQUESTED',
           users: ['gitify-app'],
         },
         {
-          state: PullRequestReviewState.Pending,
+          state: 'PENDING',
           users: ['gitify-user'],
         },
       ],