@avantstay/graphql-ts-client 10.8.0 → 11.0.0

package/dist/endpoint.d.ts

@@ -1,13 +1,13 @@
-import { C as ClientConfig, I as IResponseListener, E as Endpoint } from './types-85e628f6.js';
+import { C as ClientConfig, I as IResponseListener, E as Endpoint } from './types-4ada662b.js';
 
-declare const getApiEndpointCreator: (apiConfig: {
-    getClient: () => ClientConfig;
-    responseListeners: IResponseListener[];
-    typesTree: any;
-    maxAge: number;
-    verbose: boolean;
-    formatGraphQL: any;
-    errorsParser?: ((errors: any[]) => any) | undefined;
+declare const getApiEndpointCreator: (apiConfig: {
+    getClient: () => ClientConfig;
+    responseListeners: IResponseListener[];
+    typesTree: any;
+    maxAge: number;
+    verbose: boolean;
+    formatGraphQL: any;
+    errorsParser?: ((errors: any[]) => any) | undefined;
 }) => <I = any, O = any, E = any>(kind: 'mutation' | 'query', queryName: string) => Endpoint<I, O, E>;
 
 export { getApiEndpointCreator };

package/dist/index.d.ts

@@ -1,24 +1,24 @@
 import { PathLike } from 'fs';
-export { C as ClientConfig, c as DeepReplace, D as Defined, E as Endpoint, G as GraphQLClientError, I as IResponseListener, J as JsonOutput, L as LogInfo, M as Maybe, P as Projection, d as RawEndpoint, b as Replacement, R as ResponseData, a as ResponseListenerInfo, U as Unpacked } from './types-85e628f6.js';
+export { C as ClientConfig, c as DeepReplace, D as Defined, E as Endpoint, G as GraphQLClientError, I as IResponseListener, J as JsonOutput, L as LogInfo, M as Maybe, P as Projection, d as RawEndpoint, b as Replacement, R as ResponseData, a as ResponseListenerInfo, U as Unpacked } from './types-4ada662b.js';
 
-type IClientOptions = {
-    output?: PathLike;
-    clientName?: string;
-    headers?: {
-        [key: string]: string;
-    };
-    introspectionEndpoint?: string;
-    endpoint: string;
-    verbose?: boolean;
-    formatGraphQL?: boolean;
-    skipCache?: boolean;
-    errorsParser?: (errors: any[]) => any;
-};
-type Client = {
-    typings: string;
-    js: string;
-};
-declare function generateTypescriptClient({ introspectionEndpoint, ...options }: IClientOptions): Promise<Client>;
+type IClientOptions = {
+    output?: PathLike;
+    clientName?: string;
+    headers?: {
+        [key: string]: string;
+    };
+    introspectionEndpoint?: string;
+    endpoint: string;
+    verbose?: boolean;
+    formatGraphQL?: boolean;
+    skipCache?: boolean;
+    errorsParser?: (errors: any[]) => any;
+};
+type Client = {
+    typings: string;
+    js: string;
+};
+declare function generateTypescriptClient({ introspectionEndpoint, ...options }: IClientOptions): Promise<Client>;
 declare function generateTypescriptClientFromSDL(SDL: string, options: IClientOptions): Client;
 
 export { generateTypescriptClient, generateTypescriptClientFromSDL };

package/dist/index.js

@@ -487,7 +487,7 @@ var prettier = __toESM(require("prettier"));
 // package.json
 var package_default = {
     name: "@avantstay/graphql-ts-client",
-    version: "10.8.0",
+    version: "11.0.0",
     description: "GraphQL Typescript Client Generator",
     author: "Wellington Guimaraes",
     license: "MIT",
@@ -683,8 +683,7 @@ function gqlEndpointToCode(kind, endpoint, codeOutputType) {
     var outputType = gqlTypeToTypescript(endpoint.type, {
         required: true
     });
-    var wrappedOutputType = /^(string|number|boolean)$/.test(outputType) ? outputType : "DeepRequired<".concat(outputType, ">");
-    return codeOutputType === "ts" ? "".concat(endpoint.name, ": Endpoint<").concat(inputType, ", ").concat(wrappedOutputType, ", AllEnums>") : "".concat(endpoint.name, ": apiEndpoint('").concat(kind, "', '").concat(endpoint.name, "')");
+    return codeOutputType === "ts" ? "".concat(endpoint.name, ": Endpoint<").concat(inputType, ", ").concat(outputType, ", AllEnums>") : "".concat(endpoint.name, ": apiEndpoint('").concat(kind, "', '").concat(endpoint.name, "')");
 }
 function gqlSchemaToCode(gqlType, param) {
     var _param_selection = param.selection, selection = _param_selection === void 0 ? false : _param_selection, outputType = param.outputType;

package/dist/{types-85e628f6.d.ts → types-4ada662b.d.ts}

@@ -1,69 +1,70 @@
-type Maybe<T> = null | undefined | T;
-type Defined<T> = Exclude<T, undefined>;
-type ResponseData = {
-    data: any;
-    warnings: any;
-    headers: any;
-    status?: number;
-    errors: {
-        message: string;
-    }[];
-};
-type ResponseListenerInfo = {
-    queryName: string;
-    query: string;
-    variables: any;
-    response: ResponseData;
-};
-type IResponseListener = (info: ResponseListenerInfo) => void | Promise<void>;
-type ArrayElement<ArrayType extends readonly unknown[]> = ArrayType extends readonly (infer ElementType)[] ? ElementType : never;
-type Projection<Selection, Base, E = never> = Base extends Array<any> ? ArrayElement<Base> extends Date | string | number | boolean | null | undefined | E ? ArrayElement<Base>[] : Projection<Defined<Selection>, ArrayElement<Base>, E>[] : Base extends Date | string | number | boolean | null | E ? Selection extends undefined ? Base | undefined : Base : {
-    [k in keyof Selection & keyof Base]: Selection[k] extends boolean ? Base[k] : Base[k] extends Array<infer A> ? Projection<Defined<Selection[k]>, A, E>[] : Projection<Defined<Selection[k]>, Base[k], E>;
-};
-type Unpacked<T> = T extends (infer U)[] ? U : T extends (...args: any[]) => infer U ? U : T extends Promise<infer U> ? U : T;
-type Replacement<M extends [any, any], T> = M extends any ? ([T] extends [M[0]] ? M[1] : never) : never;
-type DeepReplace<T, Ignore, M extends [any, any]> = {
-    [P in keyof T]: T[P] extends M[0] ? T[P] extends Ignore ? T[P] extends object ? DeepReplace<T[P], Ignore, M> : T[P] : Replacement<M, T[P]> : T[P] extends object ? DeepReplace<T[P], Ignore, M> : T[P];
-};
-type RawEndpoint<I, O, E> = <S extends I>(jsonQuery?: S) => Promise<{
-    data: Projection<S, O, E>;
-    errors: any[];
-    warnings: any[];
-    headers: any;
-    status: any;
-}>;
-type JsonOutput<O, ToBeIgnored> = DeepReplace<O, ToBeIgnored, [string | Date, string]>;
-type Endpoint<I, O, E> = (<S extends I>(jsonQuery?: S) => Promise<Projection<S, JsonOutput<O, E>, E>>) & {
-    memo: <S extends I>(jsonQuery?: S) => Promise<Projection<S, JsonOutput<O, E>, E>>;
-    memoRaw: RawEndpoint<I, JsonOutput<O, E>, E>;
-    raw: RawEndpoint<I, JsonOutput<O, E>, E>;
-};
-type ClientConfig = {
-    url: string;
-    headers: {
-        [key: string]: string;
-    };
-    retryConfig: {
-        max: number;
-        waitBeforeRetry?: number;
-        before: IResponseListener;
-    };
-};
-type LogInfo = {
-    query: string;
-    variables: any;
-    formatGraphQL: any;
-    kind: string;
-    queryName: string;
-    response?: any;
-    error?: Error;
-    duration: number;
-};
-declare class GraphQLClientError extends Error {
-    responseData: ResponseData;
-    constructor(responseData: ResponseData);
-    get message(): string;
-    get response(): ResponseData;
+type Maybe<T> = null | undefined | T;
+type Defined<T> = Exclude<T, undefined>;
+type ResponseData = {
+    data: any;
+    warnings: any;
+    headers: any;
+    status?: number;
+    errors: {
+        message: string;
+    }[];
+};
+type ResponseListenerInfo = {
+    queryName: string;
+    query: string;
+    variables: any;
+    response: ResponseData;
+};
+type IResponseListener = (info: ResponseListenerInfo) => void | Promise<void>;
+type ArrayElement<ArrayType extends readonly unknown[]> = ArrayType extends readonly (infer ElementType)[] ? ElementType : never;
+type Primitive = Date | string | number | boolean | null | undefined;
+type Projection<Selection, Base, E = never> = Base extends Array<any> ? ArrayElement<Base> extends Primitive | E ? ArrayElement<Base>[] : Projection<Defined<Selection>, ArrayElement<Base>, E>[] : Base extends Primitive | E ? Selection extends undefined ? Base | undefined : Base : {
+    [k in keyof Selection & keyof Base]: Selection[k] extends boolean ? Base[k] : Base[k] extends Array<infer A> ? Projection<Defined<Selection[k]>, A, E>[] : Projection<Defined<Selection[k]>, Base[k], E>;
+};
+type Unpacked<T> = T extends (infer U)[] ? U : T extends (...args: any[]) => infer U ? U : T extends Promise<infer U> ? U : T;
+type Replacement<M extends [any, any], T> = M extends any ? ([T] extends [M[0]] ? M[1] : never) : never;
+type DeepReplace<T, Ignore, M extends [any, any]> = {
+    [P in keyof T]: T[P] extends M[0] ? T[P] extends Ignore ? T[P] extends object ? DeepReplace<T[P], Ignore, M> : T[P] : Replacement<M, T[P]> : T[P] extends object ? DeepReplace<T[P], Ignore, M> : T[P];
+};
+type RawEndpoint<I, O, E> = <S extends I>(jsonQuery?: S) => Promise<{
+    data: Projection<S, O, E>;
+    errors: any[];
+    warnings: any[];
+    headers: any;
+    status: any;
+}>;
+type JsonOutput<O, ToBeIgnored> = DeepReplace<O, ToBeIgnored, [string | Date, string]>;
+type Endpoint<I, O, E> = (<S extends I>(jsonQuery?: S) => Promise<Projection<S, JsonOutput<O, E>, E>>) & {
+    memo: <S extends I>(jsonQuery?: S) => Promise<Projection<S, JsonOutput<O, E>, E>>;
+    memoRaw: RawEndpoint<I, JsonOutput<O, E>, E>;
+    raw: RawEndpoint<I, JsonOutput<O, E>, E>;
+};
+type ClientConfig = {
+    url: string;
+    headers: {
+        [key: string]: string;
+    };
+    retryConfig: {
+        max: number;
+        waitBeforeRetry?: number;
+        before: IResponseListener;
+    };
+};
+type LogInfo = {
+    query: string;
+    variables: any;
+    formatGraphQL: any;
+    kind: string;
+    queryName: string;
+    response?: any;
+    error?: Error;
+    duration: number;
+};
+declare class GraphQLClientError extends Error {
+    responseData: ResponseData;
+    constructor(responseData: ResponseData);
+    get message(): string;
+    get response(): ResponseData;
 }
 
 export { ClientConfig as C, Defined as D, Endpoint as E, GraphQLClientError as G, IResponseListener as I, JsonOutput as J, LogInfo as L, Maybe as M, Projection as P, ResponseData as R, Unpacked as U, ResponseListenerInfo as a, Replacement as b, DeepReplace as c, RawEndpoint as d };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@avantstay/graphql-ts-client",
-  "version": "10.8.0",
+  "version": "11.0.0",
   "description": "GraphQL Typescript Client Generator",
   "author": "Wellington Guimaraes",
   "license": "MIT",

package/src/__testClient.d.ts

@@ -39,6 +39,16 @@ export interface Book {
   author?: string
   type?: BookType
   dateCreated?: ISODate
+  sequence?: BookSequence
+}
+
+/**
+ * @deprecated Avoid directly using this interface. Instead, create a type alias based on the query/mutation return type.
+ */
+
+export interface BookSequence {
+  previousBook?: Book
+  nextBook?: Book
 }
 
 /**
@@ -78,6 +88,12 @@ export interface BookSelection {
   author?: boolean
   type?: boolean
   dateCreated?: boolean
+  sequence?: BookSequenceSelection
+}
+
+export interface BookSequenceSelection {
+  previousBook?: BookSelection
+  nextBook?: BookSelection
 }
 
 export interface BookSearchParamsAllOptionalSelection {
@@ -107,7 +123,6 @@ export declare const myApiClient: {
         __headers?: { [key: string]: string }
         __retry?: boolean
         __alias?: string
-        __url?: string
       } & BookSelection,
       DeepRequired<Book[]>,
       AllEnums
@@ -117,7 +132,6 @@ export declare const myApiClient: {
         __headers?: { [key: string]: string }
         __retry?: boolean
         __alias?: string
-        __url?: string
         __args?: BooksWithOptionalParamsArgs
       } & BookSelection,
       DeepRequired<Book[]>,
@@ -128,7 +142,6 @@ export declare const myApiClient: {
         __headers?: { [key: string]: string }
         __retry?: boolean
         __alias?: string
-        __url?: string
         __args: BooksWithRequiredParamsArgs
       } & BookSelection,
       DeepRequired<Book[]>,
@@ -139,7 +152,6 @@ export declare const myApiClient: {
         __headers?: { [key: string]: string }
         __retry?: boolean
         __alias?: string
-        __url?: string
         __args: FailingQueryArgs
       },
       string,

package/src/__testClient.js

@@ -39,6 +39,7 @@ const typesTree = {
   Query: {
     get booksWithOptionalParams() {
       return {
+        __fields: typesTree.Book,
         __args: {
           params: "BookSearchParamsAllOptional!"
         }
@@ -46,6 +47,7 @@ const typesTree = {
     },
     get booksWithRequiredParams() {
       return {
+        __fields: typesTree.Book,
         __args: {
           params: "BookSearchParamsSomeRequired!"
         }
@@ -58,7 +60,30 @@ const typesTree = {
         }
       };
     },
-    booksWithoutParams: {}
+    get booksWithoutParams() {
+      return {
+        __fields: typesTree.Book
+      };
+    }
+  },
+  Book: {
+    get sequence() {
+      return {
+        __fields: typesTree.BookSequence
+      };
+    }
+  },
+  BookSequence: {
+    get previousBook() {
+      return {
+        __fields: typesTree.Book
+      };
+    },
+    get nextBook() {
+      return {
+        __fields: typesTree.Book
+      };
+    }
   }
 };
 let verbose = false;

package/src/generateTypescriptClient.ts

@@ -153,10 +153,9 @@ function gqlEndpointToCode(kind: 'mutation' | 'query', endpoint: IntrospectionFi
   }${selectionType ? ` & ${selectionType}` : ''}`
 
   const outputType = gqlTypeToTypescript(endpoint.type, { required: true })
-  const wrappedOutputType = /^(string|number|boolean)$/.test(outputType) ? outputType : `DeepRequired<${outputType}>`
 
   return codeOutputType === 'ts'
-    ? `${endpoint.name}: Endpoint<${inputType}, ${wrappedOutputType}, AllEnums>`
+    ? `${endpoint.name}: Endpoint<${inputType}, ${outputType}, AllEnums>`
     : `${endpoint.name}: apiEndpoint('${kind}', '${endpoint.name}')`
 }
 

package/src/types.ts

@@ -21,11 +21,14 @@ export type IResponseListener = (info: ResponseListenerInfo) => void | Promise<v
 
 type ArrayElement<ArrayType extends readonly unknown[]> = ArrayType extends readonly (infer ElementType)[] ? ElementType : never
 
+type Primitive = Date | string | number | boolean | null | undefined
+
+// Projection is the resulting type of Selection (type generated out of a query) applied to Base (generated graphql type)
 export type Projection<Selection, Base, E = never> = Base extends Array<any>
-  ? ArrayElement<Base> extends Date | string | number | boolean | null | undefined | E
+  ? ArrayElement<Base> extends Primitive | E
     ? ArrayElement<Base>[]
     : Projection<Defined<Selection>, ArrayElement<Base>, E>[]
-  : Base extends Date | string | number | boolean | null | E
+  : Base extends Primitive | E
   ? // Is primitive and extends undefined
     Selection extends undefined
     ? Base | undefined