fix(pocket): update request types in future pocket

Author: collectedmind

common/state/page-home/server.ts

@@ -66,7 +66,7 @@ const getHomeQuery = gql`
 export async function getHomeSlates(locale: string): Promise<HomeQueryResponse | ResponseError> {
   try {
     const localeToUse = SUPPORTED_LOCALES.includes(locale) ? locale : 'en'
-    const response = await pocketRequest<{ homeSlateLineup: CorpusSlateLineup }>({
+    const response = await pocketRequest<{ homeSlateLineup: CorpusSlateLineup }, null>({
       query: getHomeQuery,
       variables: { locale: localeToUse }
     })

common/state/page-saves/server.ts

@@ -88,7 +88,7 @@ export async function getUserSaves(
 
     if (!isAuthenticated) throw new PageSavesError('User not authenticated')
 
-    const response = await pocketRequest<{ user: Pick<User, 'savedItems'> }>(
+    const response = await pocketRequest<{ user: Pick<User, 'savedItems'> }, UserSavesArguments>(
       {
         query: getUserSavesQuery,
         variables

common/state/user-info/server.ts

@@ -40,7 +40,7 @@ export async function getUser(): Promise<UserDisplayData | ResponseError> {
     const { token, isAuthenticated } = await verifySession()
     if (!isAuthenticated) throw new UserRequestError('User not authenticated')
 
-    const response = await pocketRequest<{ user: User }>({ query: getUserQuery }, token)
+    const response = await pocketRequest<{ user: User }, null>({ query: getUserQuery }, token)
     const user: User = response?.user
 
     if (!user) throw new UserRequestError('User response was not valid')

common/utilities/request/index.ts

@@ -4,9 +4,9 @@
  * Define the structure of a GraphQL request body
  * `variables` are optional and can be any shape you need.
  */
-interface GraphQLRequestBody {
+interface GraphQLRequestBody<RequestData> {
   query: string
-  variables?: Record<string, unknown>
+  variables?: RequestData | Record<string, unknown>
 }
 
 /**
@@ -42,9 +42,9 @@ export const gql = String.raw
  * It accepts a request body, an optional auth token, and extra headers.
  * The function then returns the typed data (T).
  */
-export async function gqlRequest<T>(
+export async function gqlRequest<T, RequestData>(
   client: string,
-  data: GraphQLRequestBody,
+  data: GraphQLRequestBody<RequestData>,
   token?: string
 ): Promise<T> {
   // Build headers. If an auth token is provided, set the Authorization header.
@@ -87,15 +87,21 @@ export async function gqlRequest<T>(
 /**
  * Convenience function that sets web-client as the client,
  */
-export async function pocketRequest<T>(body: GraphQLRequestBody, token?: string): Promise<T> {
-  return gqlRequest<T>('web-client', body, token)
+export async function pocketRequest<T, RequestData>(
+  body: GraphQLRequestBody<RequestData>,
+  token?: string
+): Promise<T> {
+  return gqlRequest<T, RequestData>('web-client', body, token)
 }
 
 /**
  * Convenience function that sets web-client as the client,
  */
-export async function extensionRequest<T>(body: GraphQLRequestBody, token?: string): Promise<T> {
-  return gqlRequest<T>('web-extension', body, token)
+export async function extensionRequest<T, RequestData>(
+  body: GraphQLRequestBody<RequestData>,
+  token?: string
+): Promise<T> {
+  return gqlRequest<T, RequestData>('web-extension', body, token)
 }
 
 class GraphQLRequestError extends Error {