Merge pull request #6724 from marmelab/fix-graphql-simple-types

Fix Graphql Providers Types
marmelab · Oct 25, 2021 · 85406f6 · 85406f6
2 parents 4b0530d + 4602bcc
commit 85406f6
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 26 deletions.
diff --git a/examples/demo/src/dataProvider/graphql.ts b/examples/demo/src/dataProvider/graphql.ts
@@ -2,14 +2,10 @@ import { ApolloQueryResult } from '@apollo/client';
 import buildApolloClient, {
     buildQuery as buildQueryFactory,
 } from 'ra-data-graphql-simple';
-import { BuildQuery } from 'ra-data-graphql';
+import { BuildQueryFactory } from 'ra-data-graphql';
 import { DataProvider, DELETE } from 'react-admin';
 import gql from 'graphql-tag';
-import {
-    IntrospectionField,
-    IntrospectionSchema,
-    IntrospectionType,
-} from 'graphql';
+import { IntrospectionType } from 'graphql';
 
 const getGqlResource = (resource: string) => {
     switch (resource) {
@@ -36,20 +32,7 @@ const getGqlResource = (resource: string) => {
     }
 };
 
-type IntrospectionResource = IntrospectionType & {
-    [key: string]: IntrospectionField;
-};
-
-interface IntrospectionResults {
-    types: IntrospectionType[];
-    queries: IntrospectionField[];
-    resources: IntrospectionResource[];
-    schema: IntrospectionSchema;
-}
-
-const customBuildQuery = (
-    introspectionResults: IntrospectionResults
-): BuildQuery => {
+const customBuildQuery: BuildQueryFactory = introspectionResults => {
     const buildQuery = buildQueryFactory(introspectionResults);
 
     return (type, resource, params) => {

diff --git a/examples/demo/src/ra-data-graphql-simple.d.ts b/examples/demo/src/ra-data-graphql-simple.d.ts
diff --git a/packages/ra-data-graphql-simple/package.json b/packages/ra-data-graphql-simple/package.json
@@ -4,6 +4,7 @@
     "description": "A GraphQL simple data provider for react-admin",
     "main": "lib/index.js",
     "module": "esm/index.js",
+    "types": "esm/index.d.ts",
     "sideEffects": false,
     "repository": {
         "type": "git",

diff --git a/packages/ra-data-graphql-simple/src/index.ts b/packages/ra-data-graphql-simple/src/index.ts
@@ -1,5 +1,5 @@
 import merge from 'lodash/merge';
-import buildDataProvider, { Options } from 'ra-data-graphql';
+import buildDataProvider, { BuildQueryFactory, Options } from 'ra-data-graphql';
 import { DataProvider, Identifier } from 'ra-core';
 
 import defaultBuildQuery from './buildQuery';
@@ -9,7 +9,9 @@ const defaultOptions = {
 
 export const buildQuery = defaultBuildQuery;
 
-export default (options: Options): Promise<DataProvider> => {
+export default (
+    options: Omit<Options, 'buildQuery'> & { buildQuery?: BuildQueryFactory }
+): Promise<DataProvider> => {
     return buildDataProvider(merge({}, defaultOptions, options)).then(
         defaultDataProvider => {
             return {

diff --git a/packages/ra-data-graphql/src/buildApolloClient.ts b/packages/ra-data-graphql/src/buildApolloClient.ts
@@ -5,7 +5,7 @@ import {
     InMemoryCache,
 } from '@apollo/client';
 
-export default (options: ApolloClientOptions<unknown>) => {
+export default (options: Partial<ApolloClientOptions<unknown>>) => {
     if (!options) {
         return new ApolloClient({
             cache: new InMemoryCache().restore({}),

diff --git a/packages/ra-data-graphql/src/index.ts b/packages/ra-data-graphql/src/index.ts
@@ -92,7 +92,8 @@ export type BuildQuery = (
     resource: string,
     params: any
 ) => BuildQueryResult;
-type BuildQueryFactory = (
+
+export type BuildQueryFactory = (
     introspectionResults: IntrospectionResult
 ) => BuildQuery;
 
@@ -113,7 +114,7 @@ export type GetWatchQueryOptions = (
 
 export type Options = {
     client?: ApolloClient<unknown>;
-    clientOptions?: ApolloClientOptions<unknown>;
+    clientOptions?: Partial<ApolloClientOptions<unknown>>;
     introspection?: false | IntrospectionOptions;
     override?: {
         [key: string]: (params: any) => BuildQueryResult;