Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[ts] POC type expansion for withCell #2222

Closed
wants to merge 1 commit into from
Closed

[ts] POC type expansion for withCell #2222

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 33 additions & 21 deletions packages/web/src/components/withCellHOC.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,18 +22,26 @@ export type CellLoadingEmptyStateComponent = Omit<
OperationResult,
'error' | 'loading' | 'data'
>
export type CellSuccessStateComponent =
| Omit<OperationResult, 'error' | 'loading' | 'data'>
export type CellSuccessStateComponent<TData = any> =
| Omit<OperationResult<TData>, 'error' | 'loading' | 'data'>
| DataObject

export interface WithCellProps {
beforeQuery?: <TProps>(props: TProps) => { variables: TProps }
QUERY: DocumentNode | ((variables: Record<string, unknown>) => DocumentNode)
afterQuery?: (data: DataObject) => DataObject
Loading?: React.FC<CellLoadingEmptyStateComponent>
export interface WithCellProps<
TData,
TVariables extends Record<string, unknown>,
TInitialData = TData,
TProps extends { variables: TVariables } & Record<string, unknown> = {
variables: TVariables
},
TProcessedProps = TProps
> {
beforeQuery?: (props: TProps) => TProcessedProps
QUERY: DocumentNode | ((variables: TProcessedProps) => DocumentNode)
afterQuery?: (data: TInitialData) => TData
Loading?: React.FC<CellLoadingEmptyStateComponent & TProps>
Failure?: React.FC<CellFailureStateComponent>
Empty?: React.FC<CellLoadingEmptyStateComponent>
Success: React.FC<CellSuccessStateComponent>
Success: React.FC<CellSuccessStateComponent<TData>>
}

/**
Expand Down Expand Up @@ -89,36 +97,40 @@ const isEmpty = (data: DataObject) => {
return isDataNull(data) || isDataEmptyArray(data)
}

export const withCell = ({
export function withCell<
TData = any,
TVariables extends Record<string, unknown> = any
>({
beforeQuery = (props) => ({
variables: props,
fetchPolicy: 'cache-and-network',
nextFetchPolicy: 'cache-first',
}),
QUERY,
afterQuery = (data) => ({ ...data }),
afterQuery = (data: TData) => data,
Loading = () => <>Loading...</>,
Failure,
Empty,
Success,
}: WithCellProps) => {
}: WithCellProps<TData, TVariables>) {
type TProps = Parameters<typeof beforeQuery>[0]

// If its prerendering, render the Cell's Loading component
if (global.__REDWOOD__PRERENDERING) {
return (props: Record<string, unknown>) => <Loading {...props} />
return (props: TProps) => <Loading {...props} />
}

return (props: Record<string, unknown>) => {
const {
children, // eslint-disable-line @typescript-eslint/no-unused-vars
...variables
} = props
return (props: TProps) => {
if ('children' in props) {
throw Error(
'Cells should not have any children, or any props named children.'
)
}

return (
<Query
query={
typeof QUERY === 'function' ? QUERY(beforeQuery(variables)) : QUERY
}
{...beforeQuery(variables)}
query={typeof QUERY === 'function' ? QUERY(beforeQuery(props)) : QUERY}
{...beforeQuery(props)}
>
{({ error, loading, data, ...queryRest }) => {
if (error) {
Expand Down