@planningcenter/chat-react-native 3.21.2-rc.0 → 3.21.2-rc.2

package/src/__tests__/utils/client.ts

@@ -2,7 +2,7 @@ import MockServer from '../../__utils__/server'
 import Client from '../../utils/client/client'
 import DefaultFixtures from '../../__utils__/fixtures/defaults'
 import { BASE_URL } from '../../__utils__/handlers'
-import { ApiError } from '../../types'
+import { FailedResponse } from '../../types'
 
 const APP_BASE_URL = BASE_URL
 let client: Client
@@ -349,7 +349,7 @@ describe('error handling', () => {
     const test401 = async ({ secretWord }: { secretWord: string }) => {
       const url = '/records'
 
-      const expiredTokenResource: Partial<ApiError> = {
+      const expiredTokenResource: Partial<FailedResponse> = {
         errors: [
           {
             detail: `Zoinks, your token is borked ( ${secretWord} )`,

package/src/contexts/chat_context.tsx

@@ -3,7 +3,8 @@ import React, { createContext, useMemo } from 'react'
 import { ColorSchemeName, useColorScheme } from 'react-native'
 import { useQuery } from '@tanstack/react-query'
 import { ApiResource, DeepPartial } from '../types'
-import { Client, ENV, OauthType, PartialToken, ResponseError, Session, Uri } from '../utils'
+import { Client, ENV, OauthType, PartialToken, Session, Uri } from '../utils'
+import { FailedResponse } from '../types'
 import { ChatTheme, defaultTheme, DefaultTheme } from '../utils/theme'
 import { AgeCheckContactInfo } from '../screens/age_check/screen_props'
 import { ProductAnalyticsConfig } from '../types/product_analytics'
@@ -12,7 +13,7 @@ export interface ChatProviderProps {
   env?: ENV
   giphyApiKey?: string
   onAgeDisqualification?: (params: AgeCheckContactInfo) => void
-  onUnauthorizedResponse: (_response: ResponseError) => void
+  onUnauthorizedResponse: (_response: FailedResponse) => void
   token?: PartialToken
   tokenType?: OauthType
   theme: CreateChatThemeProps

package/src/hooks/use_api.ts

@@ -4,7 +4,7 @@ import {
   useInfiniteQuery,
   useQuery,
 } from '@tanstack/react-query'
-import { ApiCollection, ApiError, ApiResource, ResourceObject } from '../types'
+import { ApiCollection, ApiResource, FailedResponse, ResourceObject } from '../types'
 import { GetRequest, RequestData } from '../utils/client'
 import { App, useApiClient } from './use_api_client'
 import { getRequestQueryKey, RequestQueryKey } from './use_suspense_api'
@@ -18,7 +18,7 @@ export const useApiGet = <T extends ResourceObject | ResourceObject[]>(args: Api
   type Resource = ApiResource<T>
   const apiClient = useApiClient()
 
-  const { data, ...query } = useQuery<Resource, ApiError>({
+  const { data, ...query } = useQuery<Resource, FailedResponse>({
     queryKey: getRequestQueryKey(args),
     queryFn: ({ queryKey }) => {
       const [url, d, headers, app = 'chat'] = queryKey as RequestQueryKey
@@ -48,7 +48,7 @@ export const useApiPaginator = <T extends ResourceObject>(
   const apiClient = useApiClient()
   const query = useInfiniteQuery<
     ApiCollection<T>,
-    ApiError,
+    FailedResponse,
     InfiniteData<ApiCollection<T>>,
     any,
     Partial<RequestData> | undefined

package/src/hooks/use_suspense_api.ts

@@ -9,7 +9,7 @@ import { ApiCollection, ApiResource, ResourceObject } from '../types'
 import { GetRequest, RequestData } from '../utils/client'
 import { App, useApiClient } from './use_api_client'
 import { Log } from '../utils'
-import { ApiError } from '../types/api_primitives'
+import { FailedResponse } from '../types/api_primitives'
 import { ResponseError } from '../utils/response_error'
 
 interface SuspenseGetOptions extends GetRequest {
@@ -18,7 +18,7 @@ interface SuspenseGetOptions extends GetRequest {
 }
 
 export type SuspenseGetQueryOptions<T extends ResourceObject | ResourceObject[]> = Omit<
-  UseSuspenseQueryOptions<ApiResource<T>, ApiError>,
+  UseSuspenseQueryOptions<ApiResource<T>, FailedResponse>,
   'queryKey' | 'queryFn'
 >
 
@@ -29,7 +29,7 @@ export const useSuspenseGet = <T extends ResourceObject | ResourceObject[]>(
   type Resource = ApiResource<T>
   const apiClient = useApiClient()
 
-  const { data, ...query } = useSuspenseQuery<Resource, ApiError>({
+  const { data, ...query } = useSuspenseQuery<Resource, FailedResponse>({
     queryKey: getRequestQueryKey(args),
     queryFn: ({ queryKey }) => {
       const [url, d, headers, app = 'chat'] = queryKey as RequestQueryKey
@@ -104,7 +104,7 @@ export const useSuspensePaginator = <T extends ResourceObject>(
 
 const throwResponseError = (error: unknown) => {
   if (error instanceof Response) {
-    throw new ResponseError(error as ApiError)
+    throw new ResponseError(error as FailedResponse)
   }
 
   return Promise.reject(error)

package/src/screens/design_system_screen.tsx

@@ -137,7 +137,7 @@ function ThemeSection({ isLast }: SectionProps) {
             `CreateChatThemeProps`.
           </Text>
           <Text variant="footnote">
-            Example setup: `apps/mobile/src/context/chat_context_provider.tsx`
+            Example setup: `apps/sandbox/src/context/chat_context_provider.tsx`
           </Text>
         </TextRow>
         <TextRow>

package/src/types/api_primitives.ts

@@ -23,7 +23,7 @@ export type ApiCollection<Type = ResourceObject> = {
   meta: CollectionMeta
 }
 
-export interface ApiError extends Response {
+export interface FailedResponse extends Response {
   errors: ErrorObject[]
 }
 

package/src/utils/client/client.ts

@@ -1,4 +1,4 @@
-import { ApiCollection, ApiError, ApiResource } from '../../types'
+import { ApiCollection, ApiResource, FailedResponse } from '../../types'
 import {
   concatRecords,
   ensureNoQueryParamsInDev,
@@ -10,11 +10,7 @@ import {
 
 import { DeleteRequest, GetRequest, PatchRequest, PostRequest, WalkRequest } from './types'
 
-export interface ResponseError extends Response {
-  errors: ApiError['errors']
-}
-
-export type OnUnauthorizedResponse = (_response: ResponseError) => void
+export type OnUnauthorizedResponse = (_response: FailedResponse) => void
 
 type ClientArgs = {
   version: string
@@ -112,19 +108,19 @@ export class Client {
 
   handleNotOk = async (response: Response) => {
     if (response.status === 401) {
-      const { errors } = await this.parseErrorResponse(response)
+      const errorData = await this.parseErrorResponse(response)
       this.onUnauthorizedResponse?.({
         ...response,
-        errors: errors || [],
-      })
+        errors: errorData.errors || [],
+      } as FailedResponse)
     }
 
     return Promise.reject(response)
   }
 
-  parseErrorResponse = async (response: Response): Promise<Partial<ApiError>> => {
+  parseErrorResponse = async (response: Response): Promise<Partial<FailedResponse>> => {
     try {
-      return (await response.clone().json()) as ApiError
+      return (await response.clone().json()) as FailedResponse
     } catch {
       return {}
     }

package/src/utils/response_error.ts

@@ -1,12 +1,12 @@
-import { ApiError } from '../types/api_primitives'
+import { FailedResponse } from '../types/api_primitives'
 
 export class ResponseError extends Error {
   status: number
   statusText: string
-  errors: ApiError['errors']
-  response: ApiError
+  errors: FailedResponse['errors']
+  response: FailedResponse
 
-  constructor(response: ApiError) {
+  constructor(response: FailedResponse) {
     super(`ResponseError: ${response?.status} ${response?.statusText}`)
     this.name = 'ResponseError'
     this.status = response?.status
@@ -18,7 +18,7 @@ export class ResponseError extends Error {
 
 export const throwResponseError = (error: unknown) => {
   if (error instanceof Response) {
-    throw new ResponseError(error as ApiError)
+    throw new ResponseError(error as FailedResponse)
   }
 
   return Promise.reject(error)