-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: create contentful graphql client
- Loading branch information
1 parent
16c9c76
commit 2e1b108
Showing
1 changed file
with
157 additions
and
0 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,157 @@ | ||
/* eslint-disable @typescript-eslint/no-explicit-any */ | ||
/* eslint-disable @typescript-eslint/consistent-type-assertions */ | ||
|
||
import { DefinitionNode, DocumentNode, Kind, OperationDefinitionNode, parse, print } from 'graphql'; | ||
|
||
function isOperationDefinitionNode(node: DefinitionNode): node is OperationDefinitionNode { | ||
return node.kind === Kind.OPERATION_DEFINITION; | ||
} | ||
|
||
function getOperationInfo(document: string) { | ||
const documentNode = parse(document); | ||
|
||
const operationInfo = documentNode.definitions.filter(isOperationDefinitionNode).map((def) => { | ||
return { | ||
name: def.name?.value, | ||
type: def.operation, | ||
}; | ||
})[0]; | ||
|
||
return operationInfo; | ||
} | ||
|
||
interface DocumentDecoration<Result = Record<string, any>, Variables = Record<string, any>> { | ||
__apiType?: (variables: Variables) => Result; | ||
__ensureTypesOfVariablesAndResultMatching?: (variables: Variables) => Result; | ||
} | ||
|
||
interface GraphQLResponse<T> { | ||
data: T; | ||
} | ||
|
||
function normalizeQuery(query: string | DocumentNode | DocumentDecoration<any, any>) { | ||
if (typeof query === 'string') { | ||
return query; | ||
} | ||
|
||
if (query instanceof String) { | ||
return query.toString(); | ||
} | ||
|
||
if ('kind' in query) { | ||
return print(query); | ||
} | ||
|
||
throw new Error('Invalid query type'); | ||
} | ||
|
||
const contentfulGraphqlApiDomain = | ||
process.env.CONTENTFUL_GRAPHQL_API_DOMAIN ?? 'graphql.contentful.com'; | ||
const contentfulEnvironment = process.env.CONTENTFUL_ENVIRONMENT ?? 'master'; | ||
|
||
const getContentfulSpaceId = () => { | ||
const spaceId = process.env.CONTENTFUL_SPACE_ID; | ||
|
||
if (!spaceId) { | ||
throw new Error('Missing Contentful space ID'); | ||
} | ||
|
||
return spaceId; | ||
}; | ||
|
||
const getContentfulAccessToken = () => { | ||
const accessToken = process.env.CONTENTFUL_ACCESS_TOKEN; | ||
|
||
if (!accessToken) { | ||
throw new Error('Missing Contentful access token'); | ||
} | ||
|
||
return accessToken; | ||
}; | ||
|
||
const getContentfulEndpoint = () => { | ||
const spaceId = getContentfulSpaceId(); | ||
|
||
return `https://${contentfulGraphqlApiDomain}/content/v1/spaces/${spaceId}/environments/${contentfulEnvironment}`; | ||
}; | ||
|
||
function requestLogger(document: string) { | ||
if ( | ||
!( | ||
(process.env.NODE_ENV !== 'production' && process.env.CLIENT_LOGGER !== 'false') || | ||
process.env.CLIENT_LOGGER === 'true' | ||
) | ||
) { | ||
return () => { | ||
// noop | ||
}; | ||
} | ||
|
||
// @ts-expect-error - testing logging | ||
const { name, type } = getOperationInfo(document); | ||
|
||
const timeStart = Date.now(); | ||
|
||
return (response: Response) => { | ||
const timeEnd = Date.now(); | ||
const duration = timeEnd - timeStart; | ||
|
||
const complexity = response.headers.get('x-query-complexity'); | ||
|
||
// eslint-disable-next-line no-console | ||
console.log( | ||
`[Contentful] ${type} ${name ?? 'anonymous'} - ${duration}ms - complexity ${complexity ?? 'unknown'}`, | ||
); | ||
}; | ||
} | ||
|
||
// Overload for documents that require variables | ||
export async function contentfulFetch<TResult, TVariables extends Record<string, unknown>>(config: { | ||
document: DocumentDecoration<TResult, TVariables>; | ||
variables: TVariables; | ||
fetchOptions?: RequestInit; | ||
}): Promise<GraphQLResponse<TResult>>; | ||
|
||
// Overload for documents that do not require variables | ||
export async function contentfulFetch<TResult>(config: { | ||
document: DocumentDecoration<TResult, Record<string, never>>; | ||
variables?: undefined; | ||
fetchOptions?: RequestInit; | ||
}): Promise<GraphQLResponse<TResult>>; | ||
|
||
export async function contentfulFetch<TResult, TVariables>({ | ||
document, | ||
variables, | ||
fetchOptions = {} as RequestInit, | ||
}: { | ||
document: DocumentDecoration<TResult, TVariables>; | ||
variables?: TVariables; | ||
fetchOptions?: RequestInit; | ||
}): Promise<GraphQLResponse<TResult>> { | ||
const { cache, headers = {}, ...rest } = fetchOptions; | ||
const query = normalizeQuery(document); | ||
const log = requestLogger(query); | ||
|
||
const response = await fetch(getContentfulEndpoint(), { | ||
method: 'POST', | ||
headers: { | ||
'Content-Type': 'application/json', | ||
Authorization: `Bearer ${getContentfulAccessToken()}`, | ||
...headers, | ||
}, | ||
body: JSON.stringify({ | ||
query, | ||
...(variables && { variables }), | ||
}), | ||
...(cache && { cache }), | ||
...rest, | ||
}); | ||
|
||
if (!response.ok) { | ||
throw new Error(`Failed to fetch data: ${response.statusText}`); | ||
} | ||
|
||
log(response); | ||
|
||
return response.json() as Promise<GraphQLResponse<TResult>>; | ||
} |