@avantstay/graphql-ts-client 10.6.0 → 11.0.0-beta.1

package/dist/endpoint.d.ts

@@ -1,4 +1,4 @@
-import { C as ClientConfig, I as IResponseListener, E as Endpoint } from './types-4ecbabdf.js';
+import { C as ClientConfig, I as IResponseListener, E as Endpoint } from './types-4ada662b.js';
 
 declare const getApiEndpointCreator: (apiConfig: {
     getClient: () => ClientConfig;

package/dist/endpoint.js

@@ -610,12 +610,22 @@ function jsonToGraphQLQuery(param) {
         variables: variablesData,
         parentType: kind === "query" ? typesTree.Query : typesTree.Mutation
     });
-    var variablesQuery = Object.keys(variablesData).length ? "(".concat(entries(variablesData).map(function(param) {
+    var variableItems = Object.values(variablesData).reduce(function(variablesObj, variables2) {
+        variables2.forEach(function(variable, index) {
+            var name = variable.update(variables2.length > 1 ? index : void 0);
+            variablesObj[name] = {
+                type: variable.type,
+                value: variable.value
+            };
+        });
+        return variablesObj;
+    }, {});
+    var variablesQuery = Object.keys(variableItems).length ? "(".concat(entries(variableItems).map(function(param) {
         var _param = _slicedToArray(param, 2), queryName2 = _param[0], type = _param[1].type;
         return "$".concat(queryName2, ": ").concat(type);
     }).join(", "), ")") : "";
     var query = "".concat(kind, " ").concat(alias || queryName).concat(variablesQuery, " { ").concat(alias ? "".concat(alias, ":") : "").concat(queryName).concat(toGraphql(newJsonQuery), " }");
-    var variables = fromEntries(entries(variablesData).map(function(param) {
+    var variables = fromEntries(entries(variableItems).map(function(param) {
         var _param = _slicedToArray(param, 2), k = _param[0], v = _param[1];
         return [
             k,
@@ -633,14 +643,22 @@ function extractVariables(param) {
     if (jsonQuery.__args) {
         Object.keys(jsonQuery.__args).forEach(function(k) {
             if (typeof jsonQuery.__args[k] === "string" && jsonQuery.__args[k].startsWith(VAR_PREFIX)) return;
-            var variableName = "".concat(k, "_").concat(Math.random().toString(36).substr(2, 4));
-            if (jsonQuery.__args[k] !== void 0) {
-                variables[variableName] = {
-                    type: parentType.__args[k],
-                    value: jsonQuery.__args[k]
-                };
-                jsonQuery.__args[k] = "".concat(VAR_PREFIX, "$").concat(variableName);
+            if (jsonQuery.__args[k] === void 0) return;
+            var variableName = k;
+            if (!variables[variableName]) {
+                variables[variableName] = [];
             }
+            variables[variableName].push({
+                name: variableName,
+                type: parentType.__args[k],
+                value: jsonQuery.__args[k],
+                update: function(index) {
+                    var name = "".concat(variableName).concat(index !== void 0 ? "_".concat(index) : "");
+                    jsonQuery.__args[k] = "".concat(VAR_PREFIX, "$").concat(name);
+                    return name;
+                }
+            });
+            jsonQuery.__args[k] = VAR_PREFIX;
         });
     }
     Object.keys(jsonQuery).filter(function(k) {

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 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-4ecbabdf.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;

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.6.0",
+    version: "11.0.0-beta.1",
     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-4ada662b.d.ts

@@ -0,0 +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 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.6.0",
+  "version": "11.0.0-beta.1",
   "description": "GraphQL Typescript Client Generator",
   "author": "Wellington Guimaraes",
   "license": "MIT",
@@ -8,8 +8,8 @@
   "typings": "dist/index.d.ts",
   "scripts": {
     "build": "tsup src/index.ts src/endpoint.ts --dts",
-    "test": "cross-env GQL_CLIENT_DIST_PATH='.' jest --watch"
-
+    "test": "cross-env GQL_CLIENT_DIST_PATH='.' jest --watch",
+    "prepublishOnly": "yarn build"
   },
   "files": [
     "dist",

package/src/__testClient.d.ts

@@ -1,6 +1,6 @@
 // noinspection TypeScriptUnresolvedVariable, ES6UnusedImports, JSUnusedLocalSymbols, TypeScriptCheckImport
 import { DeepRequired } from "ts-essentials"
-import { Maybe, IResponseListener, Endpoint } from "../dist"
+import { Maybe, IResponseListener, Endpoint } from "."
 
 // Scalars
 export type IDate = string | Date
@@ -30,6 +30,15 @@ export interface FailingQueryArgs {
 
 // Input/Output Types
 
+/**
+ * @deprecated Avoid directly using this interface. Instead, create a type alias based on the query/mutation return type.
+ */
+
+export interface Image {
+  url?: string
+  alt?: string
+}
+
 /**
  * @deprecated Avoid directly using this interface. Instead, create a type alias based on the query/mutation return type.
  */
@@ -39,6 +48,7 @@ export interface Book {
   author?: string
   type?: BookType
   dateCreated?: ISODate
+  images?: Image[]
 }
 
 /**
@@ -73,11 +83,17 @@ export interface Query {
 
 // Selection Types
 
+export interface ImageSelection {
+  url?: boolean
+  alt?: boolean
+}
+
 export interface BookSelection {
   title?: boolean
   author?: boolean
   type?: boolean
   dateCreated?: boolean
+  images?: ImageSelection
 }
 
 export interface BookSearchParamsAllOptionalSelection {
@@ -108,7 +124,7 @@ export declare const myApiClient: {
         __retry?: boolean
         __alias?: string
       } & BookSelection,
-      DeepRequired<Book[]>,
+      Book[],
       AllEnums
     >
     booksWithOptionalParams: Endpoint<
@@ -118,7 +134,7 @@ export declare const myApiClient: {
         __alias?: string
         __args?: BooksWithOptionalParamsArgs
       } & BookSelection,
-      DeepRequired<Book[]>,
+      Book[],
       AllEnums
     >
     booksWithRequiredParams: Endpoint<
@@ -128,7 +144,7 @@ export declare const myApiClient: {
         __alias?: string
         __args: BooksWithRequiredParamsArgs
       } & BookSelection,
-      DeepRequired<Book[]>,
+      Book[],
       AllEnums
     >
     failingQuery: Endpoint<

package/src/__testClient.js

@@ -26,7 +26,7 @@ __export(exports, {
   default: () => stdin_default,
   myApiClient: () => myApiClient
 });
-var import_endpoint = __toModule(require("../dist/endpoint"));
+var import_endpoint = __toModule(require("./endpoint"));
 var import_standalone = __toModule(require("prettier/standalone"));
 var import_parser_graphql = __toModule(require("prettier/parser-graphql"));
 const formatGraphQL = (query) => (0, import_standalone.format)(query, { parser: "graphql", plugins: [import_parser_graphql.default] });
@@ -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,14 @@ const typesTree = {
         }
       };
     },
-    booksWithoutParams: {}
+    get booksWithoutParams() {
+      return {
+        __fields: typesTree.Book
+      };
+    }
+  },
+  Book: {
+    images: {}
   }
 };
 let verbose = false;

package/src/generateTypescriptClient.ts

@@ -152,10 +152,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/jsonToGraphQLQuery.test.ts

@@ -38,8 +38,14 @@ describe('jsonToGraphQLQuery', () => {
       __args: {
         foo: 'Bar',
       },
-
       something: true,
+      another: {
+        __args: {
+          foo: 'Lorem ipsum',
+          bar: 'Dolor sit amet',
+        },
+        zeta: true,
+      },
     }
 
     const response = jsonToGraphQLQuery({
@@ -53,14 +59,24 @@ describe('jsonToGraphQLQuery', () => {
               __args: {
                 foo: 'UUID!',
               },
+              something: 'Boolean!',
+              another: {
+                __args: {
+                  foo: 'String!',
+                  bar: 'String!',
+                },
+                zeta: 'Int!',
+              },
             }
           },
         },
       },
     })
 
-    Object.keys(response.variables).forEach(varName => {
-      expect(response.query.split(varName).length - 1).toBeGreaterThanOrEqual(2) //every variable name should be present at least 2 times
+    expect(response.variables).toEqual({
+      foo_0: 'Bar',
+      foo_1: 'Lorem ipsum',
+      bar: 'Dolor sit amet',
     })
   })
 })

package/src/jsonToGraphQLQuery.ts

@@ -7,6 +7,9 @@ const fromEntries: (arr: [string, any][]) => { [key: string]: any } = require('l
 const entries: (obj: { [key: string]: any }) => [string, any][] = require('lodash/toPairs')
 const cloneDeep = require('lodash/cloneDeep')
 
+type ExtractedVariables = Record<string, (Variable & { name: string; update: (index?: number) => string })[]>
+type Variable = { type: any; value: any }
+
 export function jsonToGraphQLQuery({
   kind,
   queryName,
@@ -18,7 +21,7 @@ export function jsonToGraphQLQuery({
   jsonQuery: any
   typesTree: any
 }) {
-  const variablesData = {} as any
+  const variablesData = {} as ExtractedVariables
   const alias = jsonQuery.__alias
   const newJsonQuery = cloneDeep(omit(jsonQuery, ['__alias', '__headers']))
 
@@ -28,8 +31,17 @@ export function jsonToGraphQLQuery({
     parentType: kind === 'query' ? typesTree.Query : typesTree.Mutation,
   })
 
-  const variablesQuery = Object.keys(variablesData).length
-    ? `(${entries(variablesData)
+  const variableItems = Object.values(variablesData).reduce((variablesObj, variables) => {
+    variables.forEach((variable, index) => {
+      const name = variable.update(variables.length > 1 ? index : undefined)
+      variablesObj[name] = { type: variable.type, value: variable.value }
+    })
+
+    return variablesObj
+  }, {} as Record<string, Variable>)
+
+  const variablesQuery = Object.keys(variableItems).length
+    ? `(${entries(variableItems)
         .map(([queryName, { type }]: any) => `$${queryName}: ${type}`)
         .join(', ')})`
     : ''
@@ -37,7 +49,7 @@ export function jsonToGraphQLQuery({
   const query = `${kind} ${alias || queryName}${variablesQuery} { ${alias ? `${alias}:` : ''}${queryName}${toGraphql(
     newJsonQuery
   )} }`
-  const variables = fromEntries(entries(variablesData).map(([k, v]: any) => [k, v.value]))
+  const variables = fromEntries(entries(variableItems).map(([k, v]: any) => [k, v.value]))
 
   return {
     query,
@@ -45,22 +57,41 @@ export function jsonToGraphQLQuery({
   }
 }
 
-function extractVariables({ jsonQuery, variables, parentType }: { jsonQuery: any; variables: any; parentType: any }) {
+function extractVariables({
+  jsonQuery,
+  variables,
+  parentType,
+}: {
+  jsonQuery: any
+  variables: ExtractedVariables
+  parentType: any
+}) {
   if (!parentType) return
 
   if (jsonQuery.__args) {
     Object.keys(jsonQuery.__args).forEach(k => {
       if (typeof jsonQuery.__args[k] === 'string' && jsonQuery.__args[k].startsWith(VAR_PREFIX)) return
+      if (jsonQuery.__args[k] === undefined) return
 
-      const variableName = `${k}_${Math.random().toString(36).substr(2, 4)}`
+      const variableName = k
 
-      if (jsonQuery.__args[k] !== undefined) {
-        variables[variableName] = {
-          type: parentType.__args[k],
-          value: jsonQuery.__args[k],
-        }
-        jsonQuery.__args[k] = `${VAR_PREFIX}$${variableName}`
+      if (!variables[variableName]) {
+        variables[variableName] = []
       }
+
+      variables[variableName].push({
+        name: variableName,
+        type: parentType.__args[k],
+        value: jsonQuery.__args[k],
+        update: (index?: number) => {
+          const name = `${variableName}${index !== undefined ? `_${index}` : ''}`
+          jsonQuery.__args[k] = `${VAR_PREFIX}$${name}`
+
+          return name
+        },
+      })
+
+      jsonQuery.__args[k] = VAR_PREFIX
     })
   }
 

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