@gqloom/core 0.2.0 → 0.2.1

package/README.md

@@ -17,8 +17,7 @@ GQLoom is inspired by [tRPC](https://trpc.io/), [TypeGraphQL](https://typegraphq
 ## Hello, World!
 
 ```ts
-import { weave } from "@gqloom/core"
-import { resolver, query } from "@gqloom/valibot"
+import { resolver, query, weave } from "@gqloom/valibot"
 import * as v from "valibot"
 
 const HelloResolver = resolver({

package/dist/index.d.cts

@@ -205,9 +205,13 @@ declare function getSubscriptionOptions(subscribeOrOptions: (() => any) | Subscr
 declare function getFieldOptions({ description, deprecationReason, extensions, }: GraphQLFieldOptions): GraphQLFieldOptions;
 
 interface MiddlewarePayload<TField extends GenericFieldOrOperation = FieldOrOperation<any, any, any, any>> {
+    /** The Output Silk of the field */
     outputSilk: InferSilkO<InferFieldOutput<TField>>;
+    /** The previous object, which for a field on the root Query type is often not used. */
     parent: TField extends FieldOrOperation<infer TParent, any, any, any> ? TParent extends undefined ? undefined : InferSilkO<NonNullable<TParent>> : never;
+    /** A function to parse the input of the field */
     parseInput: TField extends FieldOrOperation<any, any, infer TInput, any> ? CallableInputParser<TInput> : undefined;
+    /** The type of the field: `query`, `mutation`, `subscription` or `field` */
     type: FieldOrOperationType;
 }
 type Middleware<TField extends GenericFieldOrOperation = FieldOrOperation<any, any, any, any>> = (next: () => MayPromise<InferSilkO<InferFieldOutput<TField>>>, payload: MiddlewarePayload<TField>) => MayPromise<InferSilkO<InferFieldOutput<TField>>>;
@@ -223,7 +227,7 @@ interface ResolverPayload<TContext extends object = object, TField extends Field
      */
     readonly root: any;
     /**
-     * The payload provided to the field in the GraphQL query.
+     * The arguments provided to the field in the GraphQL query.
      */
     readonly args: Record<string, any>;
     /**
@@ -231,7 +235,7 @@ interface ResolverPayload<TContext extends object = object, TField extends Field
      */
     readonly context: TContext;
     /**
-     * The source object that contains the field in the parent type.
+     * A custom object each resolver can read from/write to.
      */
     readonly info: GraphQLResolveInfo;
     /**
@@ -557,7 +561,7 @@ declare function inputToArgs(input: InputSchema<GraphQLSilk>): GraphQLFieldConfi
 declare function ensureInputType(silkOrType: GraphQLType | GraphQLSilk): GraphQLInputType;
 declare function ensureInputObjectType(object: GraphQLObjectType | GraphQLInterfaceType | GraphQLInputObjectType): GraphQLInputObjectType;
 
-declare function ensureInterfaceType(gqlType: GraphQLOutputType, interfaceConfig?: GraphQLInterfaceTypeConfig<any, any>): GraphQLInterfaceType;
+declare function ensureInterfaceType(gqlType: GraphQLOutputType, interfaceConfig?: Partial<GraphQLInterfaceTypeConfig<any, any>>): GraphQLInterfaceType;
 
 interface GQLoomExtensions {
     defaultValue?: any;

package/dist/index.d.ts

@@ -205,9 +205,13 @@ declare function getSubscriptionOptions(subscribeOrOptions: (() => any) | Subscr
 declare function getFieldOptions({ description, deprecationReason, extensions, }: GraphQLFieldOptions): GraphQLFieldOptions;
 
 interface MiddlewarePayload<TField extends GenericFieldOrOperation = FieldOrOperation<any, any, any, any>> {
+    /** The Output Silk of the field */
     outputSilk: InferSilkO<InferFieldOutput<TField>>;
+    /** The previous object, which for a field on the root Query type is often not used. */
     parent: TField extends FieldOrOperation<infer TParent, any, any, any> ? TParent extends undefined ? undefined : InferSilkO<NonNullable<TParent>> : never;
+    /** A function to parse the input of the field */
     parseInput: TField extends FieldOrOperation<any, any, infer TInput, any> ? CallableInputParser<TInput> : undefined;
+    /** The type of the field: `query`, `mutation`, `subscription` or `field` */
     type: FieldOrOperationType;
 }
 type Middleware<TField extends GenericFieldOrOperation = FieldOrOperation<any, any, any, any>> = (next: () => MayPromise<InferSilkO<InferFieldOutput<TField>>>, payload: MiddlewarePayload<TField>) => MayPromise<InferSilkO<InferFieldOutput<TField>>>;
@@ -223,7 +227,7 @@ interface ResolverPayload<TContext extends object = object, TField extends Field
      */
     readonly root: any;
     /**
-     * The payload provided to the field in the GraphQL query.
+     * The arguments provided to the field in the GraphQL query.
      */
     readonly args: Record<string, any>;
     /**
@@ -231,7 +235,7 @@ interface ResolverPayload<TContext extends object = object, TField extends Field
      */
     readonly context: TContext;
     /**
-     * The source object that contains the field in the parent type.
+     * A custom object each resolver can read from/write to.
      */
     readonly info: GraphQLResolveInfo;
     /**
@@ -557,7 +561,7 @@ declare function inputToArgs(input: InputSchema<GraphQLSilk>): GraphQLFieldConfi
 declare function ensureInputType(silkOrType: GraphQLType | GraphQLSilk): GraphQLInputType;
 declare function ensureInputObjectType(object: GraphQLObjectType | GraphQLInterfaceType | GraphQLInputObjectType): GraphQLInputObjectType;
 
-declare function ensureInterfaceType(gqlType: GraphQLOutputType, interfaceConfig?: GraphQLInterfaceTypeConfig<any, any>): GraphQLInterfaceType;
+declare function ensureInterfaceType(gqlType: GraphQLOutputType, interfaceConfig?: Partial<GraphQLInterfaceTypeConfig<any, any>>): GraphQLInterfaceType;
 
 interface GQLoomExtensions {
     defaultValue?: any;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gqloom/core",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Create GraphQL schema and resolvers with TypeScript.",
   "type": "module",
   "main": "./dist/index.js",