@avantstay/graphql-ts-client 10.5.0

package/README.md

@@ -0,0 +1,78 @@
+# GraphQL TS Client
+
+Generate fully typed Typescript clients for your GraphQL APIs.
+
+## Install
+
+```
+yarn add graphql-ts-client
+```
+
+## Usage
+
+### Generate the client
+
+```typescript
+import { generateTypescriptClient } from 'graphql-ts-client'
+
+generateTypescriptClient({
+  output: './myAwesomeApi.ts',
+  endpoint: 'https://my.awesome-api.com/graphql',
+  verbose: process.env.NODE_ENV === 'development', // when true, log requests to the console
+  headers: {
+    Authorization: 'Bearer 1234567890987654321',
+  },
+})
+```
+
+### Using the generated client
+
+```typescript
+import { myAwesomeApi, AssetType, Granularity, OnBoardingStage } from './myAwesomeApi'
+
+async function somewhereOverTheRainbow() {
+  // Set an specific header if needed
+  myAwesomeApi.setHeader('Authorization', 'Bearer 010101010101')
+  
+  // You can also change the API url
+  myAwesomeApi.setUrl('https://my-runtime-url.com/graphql')
+  
+  // And configure how retrials should work
+  myAwesomeApi.setRetryConfig({
+    max: 3,
+    before: ({ queryName, query, variables, response }) => {
+      // do something before retrying
+    },
+  })
+  
+  // Adding response listeners is also possible
+  myAwesomeApi.addResponseListener(({ queryName, query, variables, response }) => {
+    // do something whenever a request is responded
+  })
+  
+  const response = await myAwesomeApi.queries.globalIndicators({
+    // Optionally you can define an alias for this request
+    __alias: 'myCustomGlobalIndicators',
+    __args: {
+      liveStatus: OnBoardingStage.COMPLETED,
+      assetType: AssetType.LEASED,
+      granularity: Granularity.DAILY,
+    },
+    customerExperience: {
+      avgRating: {
+        __args: {
+          from: '2020-01-01',
+          to: '2020-02-01',
+        },
+      },
+    },
+    lorem: true, // selected field
+    ipsum: true, // selected field
+  })
+
+  console.log(response.customerExperience.avgRating)
+  console.log(response.lorem)
+  console.log(response.ipsum)
+  console.log(response.dolor) // compilation time error
+}
+```

package/dist/endpoint.d.ts

@@ -0,0 +1,13 @@
+import { C as ClientConfig, I as IResponseListener, E as Endpoint } from './types-4ecbabdf.js';
+
+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 };