@avantstay/graphql-ts-client 10.8.0 → 10.9.0

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,57 +1,44 @@
 {
   "name": "@avantstay/graphql-ts-client",
-  "version": "10.8.0",
+  "version": "10.9.0",
   "description": "GraphQL Typescript Client Generator",
-  "author": "Wellington Guimaraes",
-  "license": "MIT",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
-  "scripts": {
-    "build": "tsup src/index.ts src/endpoint.ts --dts",
-    "test": "cross-env GQL_CLIENT_DIST_PATH='.' jest --watch",
-    "prepublishOnly": "yarn build"
-  },
-  "files": [
-    "dist",
-    "src"
-  ],
-  "engines": {
-    "node": ">=12"
-  },
+  "homepage": "https://github.com/avantstay/graphql-ts-client",
   "bugs": {
     "url": "https://github.com/avantstay/graphql-ts-client/issues"
   },
-  "homepage": "https://github.com/avantstay/graphql-ts-client#readme",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/avantstay/graphql-ts-client.git"
   },
-  "peerDependencies": {},
-  "prettier": {
-    "trailingComma": "es5",
-    "tabWidth": 2,
-    "proseWrap": "always",
-    "bracketSpacing": true,
-    "jsxBracketSameLine": false,
-    "semi": false,
-    "singleQuote": true,
-    "arrowParens": "avoid",
-    "endOfLine": "lf",
-    "printWidth": 130,
-    "htmlWhitespaceSensitivity": "ignore",
-    "jsxSingleQuote": false
-  },
-  "module": "dist/graphql-ts-client.esm.js",
-  "size-limit": [
-    {
-      "path": "dist/graphql-ts-client.cjs.production.min.js",
-      "limit": "10 KB"
+  "license": "MIT",
+  "author": "Wellington Guimaraes",
+  "contributors": [
+    "Felipe Pinheiro <felipe.pinheiro.90@hotmail.com>"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
     },
-    {
-      "path": "dist/graphql-ts-client.esm.js",
-      "limit": "10 KB"
+    "./dist/endpoint": {
+      "import": "./dist/endpoint.mjs",
+      "require": "./dist/endpoint.js",
+      "types": "./dist/endpoint.d.ts"
     }
+  },
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "typings": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "src"
   ],
+  "scripts": {
+    "build": "tsup src/index.ts src/endpoint.ts --dts --format cjs,esm",
+    "prepublishOnly": "yarn build",
+    "test": "cross-env GQL_CLIENT_DIST_PATH='.' jest --watch"
+  },
   "dependencies": {
     "@types/md5": "^2.3.2",
     "axios": "^0.24.0",
@@ -87,7 +74,21 @@
     "tsup": "^6.5.0",
     "typescript": "^4.9.4"
   },
+  "peerDependencies": {},
+  "engines": {
+    "node": ">=12"
+  },
   "publishConfig": {
     "@avantstay:registry": "https://registry.npmjs.org/"
-  }
+  },
+  "size-limit": [
+    {
+      "path": "dist/graphql-ts-client.cjs.production.min.js",
+      "limit": "10 KB"
+    },
+    {
+      "path": "dist/graphql-ts-client.esm.js",
+      "limit": "10 KB"
+    }
+  ]
 }

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/endpoint.ts

@@ -2,14 +2,10 @@ import memoize from 'moize'
 import { graphqlRequest } from './graphqlRequest'
 import { jsonToGraphQLQuery } from './jsonToGraphQLQuery'
 import { logRequest } from './logging'
-import {ClientConfig, Endpoint, GraphQLClientError, IResponseListener, Projection, ResponseListenerInfo} from './types'
+import { ClientConfig, Endpoint, GraphQLClientError, IResponseListener, Projection, ResponseListenerInfo } from './types'
 
 const executeListeners = (listeners: IResponseListener[], data: ResponseListenerInfo) =>
-  setTimeout(() =>
-    listeners.forEach(runResponseListener =>
-      runResponseListener(data)
-    )
-  )
+  setTimeout(() => listeners.forEach(runResponseListener => runResponseListener(data)))
 
 export const getApiEndpointCreator =
   (apiConfig: {
@@ -61,11 +57,11 @@ export const getApiEndpointCreator =
           shouldRetry,
           failureMode,
           queryName: alias,
-          client: {...clientConfig, url },
+          client: { ...clientConfig, url },
           requestHeaders,
           query,
           variables,
-          errorsParser: apiConfig.errorsParser
+          errorsParser: apiConfig.errorsParser,
         })
 
         const response = { data, warnings, headers, status, errors }
@@ -78,7 +74,7 @@ export const getApiEndpointCreator =
           })
         }
 
-        executeListeners(apiConfig.responseListeners,{
+        executeListeners(apiConfig.responseListeners, {
           ...responseListenerData,
           response,
         })

package/src/generateTypescriptClient.test.ts

@@ -125,12 +125,12 @@ describe('Generated Client', () => {
     expect(responseData?.response.errors.length).toBeGreaterThan(0)
   })
 
-  it('should generate proper code from SDL', ()=>{
+  it('should generate proper code from SDL', () => {
     const sdlString = `
   type Query {
     hello: String
   }
-`;
-    expect(generateTypescriptClientFromSDL(sdlString, {endpoint: 'https://sample.endpoint.com/graphl'})).toMatchSnapshot()
+`
+    expect(generateTypescriptClientFromSDL(sdlString, { endpoint: 'https://sample.endpoint.com/graphl' })).toMatchSnapshot()
   })
 })

package/src/generateTypescriptClient.ts

@@ -6,8 +6,8 @@ import * as fs from 'fs'
 import { PathLike } from 'fs'
 import {
   buildSchema,
-  graphqlSync,
   getIntrospectionQuery,
+  graphqlSync,
   IntrospectionEnumType,
   IntrospectionField,
   IntrospectionInputObjectType,
@@ -25,6 +25,7 @@ import os from 'os'
 import path from 'path'
 import * as prettier from 'prettier'
 import pkg from '../package.json'
+import { TypescriptClientOutput } from './types'
 
 const tempDir = fs.realpathSync(os.tmpdir())
 
@@ -153,10 +154,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}')`
 }
 
@@ -315,7 +315,7 @@ type IClientOptions = {
   errorsParser?: (errors: any[]) => any
 }
 
-type FetchIntrospectionOptions = Omit< IClientOptions, 'output' | 'introspectionEndpoint'>
+type FetchIntrospectionOptions = Omit<IClientOptions, 'output' | 'introspectionEndpoint'>
 
 function generateClientCode(types: ReadonlyArray<IntrospectionType>, options: Omit<IClientOptions, 'output'>) {
   const typesHash = md5(`${JSON.stringify(options)}__${JSON.stringify(types)}`)
@@ -323,7 +323,11 @@ function generateClientCode(types: ReadonlyArray<IntrospectionType>, options: Om
   const clientCacheFilePath = path.resolve(tempDir, clientCacheFileName)
 
   if (!options.skipCache && fs.existsSync(clientCacheFilePath)) {
-    return JSON.parse(fs.readFileSync(clientCacheFilePath, { encoding: 'utf8' }))
+    const output: Partial<TypescriptClientOutput> = JSON.parse(fs.readFileSync(clientCacheFilePath, { encoding: 'utf8' }))
+
+    if (output.js && output.mjs && output.typings) {
+      return output as TypescriptClientOutput
+    }
   }
 
   const queries = (<IntrospectionObjectType>types.find(it => it.name === 'Query'))?.fields || []
@@ -473,8 +477,9 @@ function generateClientCode(types: ReadonlyArray<IntrospectionType>, options: Om
 
     export default ${clientName}`
 
-  const output = {
+  const output: TypescriptClientOutput = {
     js: esbuild.transformSync(jsCode, { format: 'cjs', loader: 'js' }).code,
+    mjs: esbuild.transformSync(jsCode, { format: 'esm', loader: 'js' }).code,
     typings: prettier.format(typingsCode, { semi: false, parser: 'typescript' }),
   }
 
@@ -501,7 +506,7 @@ async function fetchIntrospection({ endpoint, headers }: FetchIntrospectionOptio
         },
       }
     )
-    .catch((e) => {
+    .catch(e => {
       const errorMessage = `The GraphQL introspection request failed (${endpoint})`
       if (fs.existsSync(introspectionCacheFilePath)) {
         const cachedSchema = JSON.parse(fs.readFileSync(introspectionCacheFilePath, { encoding: 'utf8' }))
@@ -527,10 +532,11 @@ async function fetchIntrospection({ endpoint, headers }: FetchIntrospectionOptio
   return types
 }
 
-type Client = { typings: string; js: string }
-
-function generateClient(introspectionTypes: ReadonlyArray<IntrospectionType>, {output,...restOptions}: IClientOptions): Client {
-  const { js, typings } = generateClientCode(introspectionTypes, restOptions)
+function generateClient(
+  introspectionTypes: ReadonlyArray<IntrospectionType>,
+  { output, ...restOptions }: IClientOptions
+): TypescriptClientOutput {
+  const { js, mjs, typings } = generateClientCode(introspectionTypes, restOptions)
 
   if (output && typeof output === 'string') {
     const outputDir = path.dirname(output)
@@ -541,12 +547,16 @@ function generateClient(introspectionTypes: ReadonlyArray<IntrospectionType>, {o
 
     fs.writeFileSync(output.replace(/(\.(ts|js))?$/, '.d.ts'), typings, { encoding: 'utf8' })
     fs.writeFileSync(output.replace(/(\.(ts|js))?$/, '.js'), js, { encoding: 'utf8' })
+    fs.writeFileSync(output.replace(/(\.(ts|js))?$/, '.mjs'), mjs, { encoding: 'utf8' })
   }
 
-  return { js, typings }
+  return { js, mjs, typings }
 }
 
-export async function generateTypescriptClient({ introspectionEndpoint, ...options }: IClientOptions): Promise<Client> {
+export async function generateTypescriptClient({
+  introspectionEndpoint,
+  ...options
+}: IClientOptions): Promise<TypescriptClientOutput> {
   console.log(`Generating TypeScript client (name: ${options.clientName ?? 'n/a'})`)
 
   axiosRetry(axios, { retries: 5, retryDelay: retryCount => 1000 * 2 ** retryCount })
@@ -557,14 +567,14 @@ export async function generateTypescriptClient({ introspectionEndpoint, ...optio
   })
 
   return generateClient(introspectionTypes, options)
-
 }
 
-export function generateTypescriptClientFromSDL(SDL: string, options: IClientOptions): Client {
-  console.log(`Generating TypeScript client from SDL (name: ${options.clientName ?? 'n/a'})`);
+export function generateTypescriptClientFromSDL(SDL: string, options: IClientOptions): TypescriptClientOutput {
+  console.log(`Generating TypeScript client from SDL (name: ${options.clientName ?? 'n/a'})`)
 
-  const graphqlSchemaObj = buildSchema(SDL);
-  const introspectionTypes = graphqlSync(graphqlSchemaObj, new Source(getIntrospectionQuery())).data?.__schema.types as IntrospectionType[]
+  const graphqlSchemaObj = buildSchema(SDL)
+  const introspectionTypes = graphqlSync(graphqlSchemaObj, new Source(getIntrospectionQuery())).data?.__schema
+    .types as IntrospectionType[]
 
   return generateClient(introspectionTypes, options)
 }

package/src/graphqlRequest.test.ts

@@ -2,10 +2,10 @@ import { graphqlRequest } from './graphqlRequest'
 
 describe('GraphQLRequest', () => {
   it('Should request have proper structure', async () => {
-    let request: any;
+    let request: any
 
     const mockedAxios = {
-      post: function() {
+      post: function () {
         request = arguments
         return {
           status: 200,
@@ -19,7 +19,7 @@ describe('GraphQLRequest', () => {
       axios: mockedAxios,
       queryName: 'sampleQueryName',
       query: 'sampleQuery',
-      variables: {foo:'bar',bar:'foo'},
+      variables: { foo: 'bar', bar: 'foo' },
       client: {
         url: 'https://whatever.com',
         headers: {},
@@ -51,7 +51,6 @@ describe('GraphQLRequest', () => {
     } as any
 
     const result = await graphqlRequest({
-
       failureMode: 'loud',
       axios: mockedAxios,
       queryName: 'whatever',

package/src/jsonToGraphQLQuery.ts

@@ -31,14 +31,17 @@ export function jsonToGraphQLQuery({
     parentType: kind === 'query' ? typesTree.Query : typesTree.Mutation,
   })
 
-  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 }
-    })
+  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>)
+      return variablesObj
+    },
+    {} as Record<string, Variable>
+  )
 
   const variablesQuery = Object.keys(variableItems).length
     ? `(${entries(variableItems)