Skip to content
Open
Show file tree
Hide file tree
Changes from 6 commits
Commits
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
12 changes: 11 additions & 1 deletion services/data/src/engine/types/Query.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,19 @@ export interface ResolvedResourceQuery extends ResourceQuery {
params?: QueryParameters
}

export type Query = Record<string, ResourceQuery>
export type Query<TQueryResult extends QueryResult = QueryResult> = Record<
keyof TQueryResult,
ResourceQuery
>
export type QueryResult = JsonMap

export type QueryResultData<
TQuery extends Query<TQueryResultData>,
TQueryResultData extends QueryResult = QueryResult
Comment thread
Birkbjo marked this conversation as resolved.
Outdated
> = {
[K in keyof TQuery]: TQueryResultData
}

export interface QueryOptions {
variables?: QueryVariables
onComplete?: (data: QueryResult) => void
Expand Down
18 changes: 13 additions & 5 deletions services/data/src/react/hooks/useDataQuery.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
import { useState, useRef, useCallback, useDebugValue } from 'react'
import { useQuery, setLogger } from 'react-query'
import type { Query, QueryOptions, QueryVariables } from '../../engine'
import type {
Query,
QueryOptions,
QueryVariables,
QueryResultData
} from '../../engine'
import type { FetchError } from '../../engine/types/FetchError'
import type { QueryRenderInput, QueryRefetchFunction } from '../../types'
import type { DataQueryResult, QueryRefetchFunction } from '../../types'
import { mergeAndCompareVariables } from './mergeAndCompareVariables'
import { useDataEngine } from './useDataEngine'
import { useStaticInput } from './useStaticInput'
Expand All @@ -28,15 +33,18 @@ type QueryState = {
refetchCallback?: (data: any) => void
}

export const useDataQuery = (
query: Query,
export const useDataQuery = <
TQueryResultData extends QueryResultData<TQuery>,
TQuery extends Query<TQueryResultData> = Query<TQueryResultData>
Comment thread
Birkbjo marked this conversation as resolved.
Outdated
>(
query: TQuery,
{
onComplete: userOnSuccess,
onError: userOnError,
variables: initialVariables = {},
lazy: initialLazy = false,
}: QueryOptions = {}
): QueryRenderInput => {
): DataQueryResult<TQueryResultData> => {
const [staticQuery] = useStaticInput<Query>(query, {
warn: true,
name: 'query',
Expand Down
9 changes: 6 additions & 3 deletions services/data/src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,19 +40,22 @@ export interface ExecuteHookResult<ReturnType> {
data?: ReturnType
}

export interface QueryState {
export interface QueryState<TQueryResult> {
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would prefer to rename this to QueryResultData

called: boolean
loading: boolean
fetching: boolean
error?: FetchError
data?: QueryResult
data?: TQueryResult
}

export interface QueryRenderInput extends QueryState {
export interface QueryRenderInput<TQueryResult = QueryResult>
extends QueryState<TQueryResult> {
engine: DataEngine
refetch: QueryRefetchFunction
}

export type DataQueryResult<TQueryResult> = QueryRenderInput<TQueryResult>

export interface MutationState {
engine: DataEngine
called: boolean
Expand Down