-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
e0b676d
commit 37c710b
Showing
10 changed files
with
75 additions
and
63 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
/* | ||
* This Source Code Form is subject to the terms of the Mozilla Public | ||
* License, v. 2.0. If a copy of the MPL was not distributed with this | ||
* file, you can obtain one at https://mozilla.org/MPL/2.0/. | ||
* | ||
* Copyright Oxide Computer Company | ||
*/ | ||
import { QueryClient } from '@tanstack/react-query' | ||
|
||
import { Api } from './__generated__/Api' | ||
import { | ||
getUseApiMutation, | ||
getUseApiQueries, | ||
getUseApiQuery, | ||
getUseApiQueryClient, | ||
getUseApiQueryErrorsAllowed, | ||
getUsePrefetchedApiQuery, | ||
wrapQueryClient, | ||
} from './hooks' | ||
|
||
export const api = new Api({ | ||
// unit tests run in Node, whose fetch implementation requires a full URL | ||
host: process.env.NODE_ENV === 'test' ? 'http://testhost' : '', | ||
}) | ||
|
||
// add the API client to window for use from the browser JS console. requests | ||
// will use the session cookie, same as normal API calls | ||
if (typeof window !== 'undefined') { | ||
// @ts-expect-error | ||
window.oxide = api.methods | ||
} | ||
|
||
export type ApiMethods = typeof api.methods | ||
|
||
export const useApiQuery = getUseApiQuery(api.methods) | ||
export const useApiQueries = getUseApiQueries(api.methods) | ||
/** | ||
* Same as `useApiQuery`, except we use `invariant(data)` to ensure the data is | ||
* already there in the cache at request time, which means it has been | ||
* prefetched in a loader. Whenever this hook is used, there should be an e2e | ||
* test loading the page to exercise the invariant in CI. | ||
*/ | ||
export const usePrefetchedApiQuery = getUsePrefetchedApiQuery(api.methods) | ||
export const useApiQueryErrorsAllowed = getUseApiQueryErrorsAllowed(api.methods) | ||
export const useApiMutation = getUseApiMutation(api.methods) | ||
|
||
// Needs to be defined here instead of in app so we can use it to define | ||
// `apiQueryClient`, which provides API-typed versions of QueryClient methods | ||
export const queryClient = new QueryClient({ | ||
defaultOptions: { | ||
queries: { | ||
retry: false, | ||
staleTime: 10000, | ||
refetchOnWindowFocus: false, | ||
}, | ||
}, | ||
}) | ||
|
||
// to be used in loaders, which are outside the component tree and therefore | ||
// don't have access to context | ||
export const apiQueryClient = wrapQueryClient(api.methods, queryClient) | ||
|
||
// to be used to retrieve the typed query client in components | ||
export const useApiQueryClient = getUseApiQueryClient(api.methods) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters