further type refactoring

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

Author: setchy

src/renderer/__mocks__/notifications-mocks.ts

@@ -7,8 +7,8 @@ import type {
   GitifySubject,
   Hostname,
   Link,
+  SubjectType,
 } from '../types';
-import type { SubjectType } from '../typesGitHub';
 import {
   mockEnterpriseNotifications,
   mockGitHubNotifications,

src/renderer/__mocks__/user-mocks.ts

@@ -1,6 +1,5 @@
-import type { GitifyUser, Link } from '../types';
-import type { User } from '../typesGitHub';
-import type { AuthorFieldsFragment } from '../utils/api/graphql/generated/graphql';
+import type { GitifyNotificationUser, GitifyUser, Link } from '../types';
+import type { RawUser } from '../utils/api/types';
 
 export const mockGitifyUser: GitifyUser = {
   login: 'octocat',
@@ -9,18 +8,20 @@ export const mockGitifyUser: GitifyUser = {
   avatar: 'https://avatars.githubusercontent.com/u/583231?v=4' as Link,
 };
 
-export function createPartialMockUser(login: string): User {
-  const mockUser: Partial<User> = {
+export function createPartialMockUser(login: string): RawUser {
+  const mockUser: Partial<RawUser> = {
     login: login,
     html_url: `https://github.com/${login}` as Link,
     avatar_url: 'https://avatars.githubusercontent.com/u/583231?v=4' as Link,
     type: 'User',
   };
 
-  return mockUser as User;
+  return mockUser as RawUser;
 }
 
-export function createMockAuthorFragment(login: string): AuthorFieldsFragment {
+export function createMockAuthorFragment(
+  login: string,
+): GitifyNotificationUser {
   return {
     __typename: 'User',
     login: login,

src/renderer/components/avatars/AvatarWithFallback.tsx

@@ -3,8 +3,7 @@ import { useState } from 'react';
 
 import { Avatar, Stack, Truncate } from '@primer/react';
 
-import { type Link, Size } from '../../types';
-import type { UserType } from '../../typesGitHub';
+import { type Link, Size, type UserType } from '../../types';
 import { getDefaultUserIcon } from '../../utils/icons';
 import { isNonHumanUser } from '../../utils/notifications/filters/userType';
 

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

@@ -1,7 +1,7 @@
 import { renderWithAppContext } from '../../__helpers__/test-utils';
 import { mockSettings } from '../../__mocks__/state-mocks';
+import type { GitifyMilestone } from '../../types';
 import { mockSingleNotification } from '../../utils/api/__mocks__/response-mocks';
-import type { MilestoneFieldsFragment } from '../../utils/api/graphql/generated/graphql';
 import { MetricGroup } from './MetricGroup';
 
 describe('renderer/components/metrics/MetricGroup.tsx', () => {
@@ -104,7 +104,7 @@ describe('renderer/components/metrics/MetricGroup.tsx', () => {
       mockNotification.subject.milestone = {
         title: 'Milestone 1',
         state: 'OPEN',
-      } as MilestoneFieldsFragment;
+      } as GitifyMilestone;
 
       const props = {
         notification: mockNotification,
@@ -119,7 +119,7 @@ describe('renderer/components/metrics/MetricGroup.tsx', () => {
       mockNotification.subject.milestone = {
         title: 'Milestone 1',
         state: 'CLOSED',
-      } as MilestoneFieldsFragment;
+      } as GitifyMilestone;
 
       const props = {
         notification: mockNotification,

src/renderer/components/notifications/NotificationFooter.test.tsx

@@ -3,8 +3,7 @@ import userEvent from '@testing-library/user-event';
 
 import { renderWithAppContext } from '../../__helpers__/test-utils';
 import { mockGitHubCloudAccount } from '../../__mocks__/account-mocks';
-import type { Link } from '../../types';
-import type { UserType } from '../../typesGitHub';
+import type { Link, UserType } from '../../types';
 import { mockSingleNotification } from '../../utils/api/__mocks__/response-mocks';
 import * as comms from '../../utils/comms';
 import { NotificationFooter } from './NotificationFooter';

src/renderer/types.ts

@@ -2,7 +2,6 @@ import type { FC } from 'react';
 
 import type { OcticonProps } from '@primer/octicons-react';
 
-import type { Reason, SubjectType, UserType } from './typesGitHub';
 import type {
   AuthorFieldsFragment,
   DiscussionStateReason,
@@ -261,8 +260,9 @@ export type FilterStateType = 'open' | 'closed' | 'merged' | 'draft' | 'other';
  * Gitify Notification Types
  *
  * These types represent the clean, UI-focused notification structure
- * used throughout the application. Raw GitHub API responses are
- * transformed into these types at the API boundary.
+ * used throughout the application.
+ *
+ * Raw GitHub API responses are transformed into these types at the API boundary.
  *
  **/
 
@@ -297,12 +297,12 @@ export interface GitifySubject {
   title: string;
   /** Subject type (Issue, PullRequest, etc.) */
   type: SubjectType;
-  /** API URL for the subject (used for GraphQL fetching) */
+  /** API URL for the subject */
   url: Link | null;
   /** API URL for the latest comment */
   latestCommentUrl: Link | null;
 
-  // Enriched fields (from GraphQL - all optional)
+  // Enriched fields (from additional GraphQL or REST API calls)
   /** Issue/PR/Discussion number */
   number?: number;
   /** Parsed state from GraphQL */
@@ -318,7 +318,7 @@ export interface GitifySubject {
   /** Label names */
   labels?: string[];
   /** Milestone state/title */
-  milestone?: MilestoneFieldsFragment;
+  milestone?: GitifyMilestone;
   /** Deep link to latest comment */
   htmlUrl?: Link;
 }
@@ -351,6 +351,8 @@ export interface GitifyOwner {
 
 export type GitifyNotificationUser = AuthorFieldsFragment;
 
+export type GitifyMilestone = MilestoneFieldsFragment;
+
 export interface GitifyPullRequestReview {
   state: PullRequestReviewState;
   users: string[];
@@ -382,3 +384,50 @@ export type GitifyCheckSuiteStatus =
   | 'SUCCESS'
   | 'TIMED_OUT'
   | 'WAITING';
+
+/**
+ *
+ * Gitify Type Enhancements
+ *
+ * These types represent the clean, UI-focused notification structure
+ * used throughout the application. Raw GitHub API responses are
+ * transformed into these types at the API boundary.
+ *
+ **/
+
+// Stronger typings for string literal attributes
+export type Reason =
+  | 'approval_requested'
+  | 'assign'
+  | 'author'
+  | 'ci_activity'
+  | 'comment'
+  | 'invitation'
+  | 'manual'
+  | 'member_feature_requested'
+  | 'mention'
+  | 'review_requested'
+  | 'security_advisory_credit'
+  | 'security_alert'
+  | 'state_change'
+  | 'subscribed'
+  | 'team_mention';
+
+export type SubjectType =
+  | 'CheckSuite'
+  | 'Commit'
+  | 'Discussion'
+  | 'Issue'
+  | 'PullRequest'
+  | 'Release'
+  | 'RepositoryDependabotAlertsThread'
+  | 'RepositoryInvitation'
+  | 'RepositoryVulnerabilityAlert'
+  | 'WorkflowRun';
+
+export type UserType =
+  | 'Bot'
+  | 'EnterpriseUserAccount'
+  | 'Mannequin'
+  | 'Organization'
+  | 'User';

src/renderer/typesGitHub.ts

@@ -9,7 +9,7 @@ import type {
   GitifyRepository,
   Link,
 } from '../../../types';
-import type { User } from '../../../typesGitHub';
+import type { RawUser } from '../types';
 
 export const mockNotificationUser = {
   id: 123456789,
@@ -18,7 +18,7 @@ export const mockNotificationUser = {
   url: 'https://api.github.com/users/octocat' as Link,
   html_url: 'https://github.com/octocat' as Link,
   type: 'User',
-} satisfies Partial<User>;
+} satisfies Partial<RawUser>;
 
 // 2 Notifications
 // Hostname : 'github.com'

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

@@ -1,4 +1,3 @@
-import type { components } from '@octokit/openapi-types';
 import type { AxiosPromise } from 'axios';
 import type { ExecutionResult } from 'graphql';
 
@@ -10,15 +9,6 @@ import type {
   SettingsState,
   Token,
 } from '../../types';
-
-type RawGitHubNotification = components['schemas']['thread'];
-
-import type {
-  Commit,
-  CommitComment,
-  NotificationThreadSubscription,
-  Release,
-} from '../../typesGitHub';
 import { isAnsweredDiscussionFeatureSupported } from '../features';
 import { rendererLogError } from '../logger';
 import {
@@ -36,6 +26,13 @@ import {
   type ExecutionResultWithHeaders,
   performGraphQLRequest,
 } from './request';
+import type {
+  NotificationThreadSubscription,
+  RawCommit,
+  RawCommitComment,
+  RawGitHubNotification,
+  RawRelease,
+} from './types';
 import {
   getGitHubAPIBaseUrl,
   getGitHubGraphQLUrl,
@@ -138,7 +135,7 @@ export function ignoreNotificationThreadSubscription(
  *
  * Endpoint documentation: https://docs.github.com/en/rest/commits/commits#get-a-commit
  */
-export function getCommit(url: Link, token: Token): AxiosPromise<Commit> {
+export function getCommit(url: Link, token: Token): AxiosPromise<RawCommit> {
   return apiRequestAuth(url, 'GET', token);
 }
 
@@ -151,7 +148,7 @@ export function getCommit(url: Link, token: Token): AxiosPromise<Commit> {
 export function getCommitComment(
   url: Link,
   token: Token,
-): AxiosPromise<CommitComment> {
+): AxiosPromise<RawCommitComment> {
   return apiRequestAuth(url, 'GET', token);
 }
 
@@ -160,7 +157,7 @@ export function getCommitComment(
  *
  * Endpoint documentation: https://docs.github.com/en/rest/releases/releases#get-a-release
  */
-export function getRelease(url: Link, token: Token): AxiosPromise<Release> {
+export function getRelease(url: Link, token: Token): AxiosPromise<RawRelease> {
   return apiRequestAuth(url, 'GET', token);
 }
 

src/renderer/utils/api/client.ts

@@ -3,9 +3,9 @@ import { AxiosError, type AxiosResponse } from 'axios';
 import { EVENTS } from '../../../shared/events';
 
 import type { Link } from '../../types';
-import type { GitHubRESTError } from '../../typesGitHub';
 import { Errors } from '../errors';
 import { determineFailureType } from './errors';
+import type { GitHubRESTError } from './types';
 
 describe('renderer/utils/api/errors.ts', () => {
   it('network error', async () => {