Merge pull request feathersjs-ecosystem#481 from NickBolles/njb/fix-fgraphql-types

update names and fix the options property

Author: eddyystop

types/index.d.ts

@@ -2,7 +2,7 @@
 
 import { Hook, HookContext, Params, Query, Paginated, Application } from '@feathersjs/feathers';
 import * as ajv from 'ajv';
-import { GraphQLSchema, parse } from 'graphql';
+import { GraphQLSchema, parse, GraphQLFieldResolver } from 'graphql';
 import * as libphonenumberjs from 'libphonenumber-js';
 
 export type HookType = 'before' | 'after' | 'error';
@@ -212,28 +212,32 @@ export interface ResolverMap<T> {
  */
 export function fastJoin(resolvers: ResolverMap<any> | SyncContextFunction<ResolverMap<any>>, query?: Query | SyncContextFunction<Query>): Hook;
 
-export type ResolversFunction = (app: Application, runtime: any) => ResolversObject;
+export type FGraphQLResolverMapFactory = (app: Application, runtime: any) => FGraphQLResolverMap;
 
-export interface ResolversObject {
+export interface FGraphQLResolverMap {
     [i: string]: {
-        [i: string]: (parent: any, args: any, content: any, ast: any) => any;
+        [i: string]: GraphQLFieldResolver<any, any>
     };
     Query: {
-        [i: string]: (parent: any, args: any, content: any, ast: any) => any;
+        [i: string]: GraphQLFieldResolver<any, any>
     };
 }
 
-export interface FGraphqlOptions {
-    recordType: string;
-    schema: string;
-    resolvers: ResolversObject | ResolversFunction;
-    query: Query | SyncContextFunction<Query>;
+export interface FGraphQLOptions {
     skipHookWhen?: SyncContextFunction<boolean>;
     inclAllFieldsServer?: boolean;
     inclAllFieldsClient?: boolean;
     inclAllFields?: boolean;
     inclJoinedNames?: boolean;
     extraAuthProps?: string[];
+}
+
+export interface FGraphQLHookOptions {
+    recordType: string;
+    schema: string;
+    resolvers: FGraphQLResolverMap | FGraphQLResolverMapFactory;
+    query: Query | SyncContextFunction<Query>;
+    options?: FGraphQLOptions;
     runTime: any;
     parse: typeof parse;
 }
@@ -242,7 +246,7 @@ export interface FGraphqlOptions {
  * Generate Graphql Resolvers for services
  * {@link https://medium.com/@eddyystop/38faee75dd1}
  */
-export function fgraphql(options?: FGraphqlOptions): Hook;
+export function fgraphql(options?: FGraphQLHookOptions): Hook;
 
 /**
  * Return a property value from an object using dot notation, e.g. address.city. (Utility function.)

types/tests.ts

@@ -63,7 +63,7 @@ import {
     validate,
     validateSchema,
     when,
-    FGraphqlOptions,
+    FGraphQLHookOptions,
 } from 'feathers-hooks-common';
 import ajv = require('ajv');
 import { parse } from 'graphql';
@@ -219,7 +219,7 @@ fastJoin(ctx => postResolvers);
 fastJoin(postResolvers);
 
 // used from https://github.com/feathers-plus/hooks-graphql-example
-const fgraphqlOptions: FGraphqlOptions = {
+const fgraphqlOptions: FGraphQLHookOptions = {
     parse,
     runTime: null,
     schema: ``,
@@ -242,7 +242,7 @@ const fgraphqlOptions: FGraphqlOptions = {
 // $ExpectType Hook
 fgraphql(fgraphqlOptions);
 
-const fgraphqlOptions2: FGraphqlOptions = {
+const fgraphqlOptions2: FGraphQLHookOptions = {
     ...fgraphqlOptions,
     query: (context: HookContext) => ({
         posts: {},
@@ -257,6 +257,14 @@ const fgraphqlOptions2: FGraphqlOptions = {
             likes: () => ({}),
         },
         Query: {}
+    },
+    options: {
+        extraAuthProps:  ['asdf' ],
+        inclAllFields: false,
+        inclJoinedNames: false,
+        inclAllFieldsClient: true,
+        inclAllFieldsServer: true,
+        skipHookWhen: (context) => { context.data; return false; }
     }
 };
 // $ExpectType Hook