Merge pull request #217 from HubSpot/convert/ts-5

chore: Refactor types for fetching GitHub content
HubSpot · Dec 5, 2024 · 3593bb9 · 3593bb9
2 parents 893572c + 02f193d
commit 3593bb9
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 6 deletions.
diff --git a/api/github.ts b/api/github.ts
@@ -56,12 +56,12 @@ export function fetchRepoAsZip(zipUrl: string): HubSpotPromise<Buffer> {
 }
 
 // Returns the raw file contents via the raw.githubusercontent endpoint
-export function fetchRepoFile(
+export function fetchRepoFile<T = Buffer>(
   repoPath: RepoPath,
   filePath: string,
   ref: string
-): HubSpotPromise<Buffer> {
-  return axios.get<Buffer>(
+): HubSpotPromise<T> {
+  return axios.get<T>(
     `${GITHUB_RAW_CONTENT_API_PATH}/${repoPath}/${ref}/${filePath}`,
     {
       headers: {

diff --git a/lib/github.ts b/lib/github.ts
@@ -22,19 +22,19 @@ import { isHubSpotHttpError, isSystemError } from '../errors';
 
 const i18nKey = 'lib.github';
 
-export async function fetchFileFromRepository(
+export async function fetchFileFromRepository<T = Buffer>(
   repoPath: RepoPath,
   filePath: string,
   ref: string
-): Promise<Buffer> {
+): Promise<T> {
   try {
     logger.debug(
       i18n(`${i18nKey}.fetchFileFromRepository.fetching`, {
         path: `${repoPath}/${ref}/${filePath}`,
       })
     );
 
-    const { data } = await fetchRepoFile(repoPath, filePath, ref);
+    const { data } = await fetchRepoFile<T>(repoPath, filePath, ref);
     return data;
   } catch (err) {
     throw new Error(

diff --git a/types/developerTestAccounts.ts b/types/developerTestAccounts.ts
@@ -5,6 +5,7 @@ export type DeveloperTestAccount = {
   createdAt: string;
   updatedAt: string;
   status: string;
+  id: number;
 };
 
 export type FetchDeveloperTestAccountsResponse = {