@devticon-os/graphql-codegen-axios 0.0.4 → 0.1.1

package/README.md

@@ -0,0 +1,79 @@
+### graphql-codegen-axios
+A code generation tool that generates an Axios SDK based on your GraphQL queries. This tool makes it easy to consume GraphQL APIs in your Axios projects by automatically generating code for querying your GraphQL API and mapping the results to JavaScript objects.
+
+### Features
+- Generates TypeScript code for querying GraphQL APIs with Axios.
+- Supports the @first, @firstOrFail, and @nonNullable directives.
+
+### Usage
+To use graphql-codegen-axios, you need to have Node.js installed on your system.
+
+Installation
+You can install graphql-codegen-axios using npm:
+
+```sh
+npm install graphql-codegen-axios --save-dev
+yarn add graphql-codegen-axios -D
+pnpm add graphql-codegen-axios -D
+```
+### Configuration
+In your project's codegen.yml configuration file, add the following configuration:
+
+```yml
+overwrite: true
+schema: https://your-graphql-api.com/graphql
+documents: src/**/*.graphql
+generates:
+src/generated/graphql.ts:
+plugins:
+- typescript
+- typescript-operations
+- graphql-codegen-axios
+```
+You can customize the output file path and other settings as per your requirements.
+
+### Directives
+graphql-codegen-axios supports the following directives:
+
+- `@first`: Returns only the first object from a collection.
+- `@firstOrFail`: Returns the first object from a collection or throws an error if the collection is empty.
+- `@nonNullable`: Throws an error if the query returns null.
+To use a directive, add it to your GraphQL query like this:
+
+```graphql
+query GetFirstUser {
+    users(first: 1) @first {
+      id
+      name
+    }
+}
+```
+```graphql
+query GetFirstUser {
+    users(first: 1) @firstOrFail {
+      id
+      name
+    }
+}
+```
+```graphql
+query GetFirstUser {
+    user(id: "1") @nonNullable {
+      id
+      name
+    }
+}
+```
+### Generating Code
+You can generate the Axios SDK by running the following command:
+
+```sh
+npx graphql-codegen
+```
+This will generate the TypeScript code in the specified output file path.
+
+### Contributing
+Contributions are welcome! Please see the contributing guidelines for more information.
+
+### License
+This project is licensed under the MIT License. See the LICENSE file for details.

package/package.json

@@ -1,8 +1,13 @@
 {
   "name": "@devticon-os/graphql-codegen-axios",
-  "version": "0.0.4",
+  "version": "0.1.1",
   "license": "MIT",
   "main": "src/index.js",
+  "repository": "https://github.com/devticon/graphql-codegen-axios",
+  "author": {
+    "name": "krs",
+    "email": "k.kamasa@gmail.com"
+  },
   "files": [
     "src"
   ],

package/src/helpers.ts

@@ -1,45 +1,64 @@
-import { AxiosResponse, AxiosInstance, AxiosRequestConfig } from 'axios';
-import { GraphQLError } from 'graphql';
+import { AxiosResponse, AxiosInstance, AxiosRequestConfig } from "axios";
+import { GraphQLError } from "graphql";
 
 type GraphqlResponse<T> = {
   data: T;
   errors?: GraphQLError[];
 };
 
+type GraphqlRequestParams = {
+  query: string;
+  variables: any;
+};
 const first = <T>(data: T[]) => data[0];
 
-const firstOrFail = <T>(data: T[]) => {
-  const row = data[0];
-  if (!row) {
-    throw new Error('Not found');
-  }
-  return row;
-};
+const firstOrFail =
+  <T>(reqParams: GraphqlRequestParams) =>
+    (data: T[]) => {
+      const row = data[0];
+      if (!row) {
+        throw new QueryNoResultsError(reqParams);
+      }
+      return row;
+    };
 
-const nonNullable = <T>(data: T) => {
-  const row = data;
-  if (!row) {
-    throw new Error('Not found');
-  }
-  return row;
-};
+const nonNullable =
+  <T>(reqParams: GraphqlRequestParams) =>
+    (data: T) => {
+      const row = data;
+      if (!row) {
+        throw new QueryNoResultsError(reqParams);
+      }
+      return row;
+    };
 
-export const handleResponse = <T>({ data }: AxiosResponse<GraphqlResponse<T>>) => {
+export const handleResponse = <T>({
+                                    data,
+                                  }: AxiosResponse<GraphqlResponse<T>>) => {
   const errors = data.errors;
   if (errors && errors.length > 0) {
-    throw new GraphqlError('Request failed', errors);
+    throw new GraphqlError("Request failed", errors);
   }
   return data.data;
 };
-
 export const unpackSingleResults =
   <T extends Object, K extends keyof T>(key: K) =>
-  (data: T) =>
-    data[key];
+    (data: T) =>
+      data[key];
 
 export class GraphqlError extends Error {
   constructor(message: string, public gqlErrors: GraphQLError[]) {
-    const msg = `${message} ${gqlErrors.map(e => e.message).join('\n')}`;
+    const msg = `${message} ${gqlErrors.map((e) => e.message).join("\n")}`;
     super(msg);
   }
 }
+
+export class QueryNoResultsError extends Error {
+  query: string;
+  variables: any;
+  constructor(params: GraphqlRequestParams) {
+    super(`Query has no results`);
+    this.query = params.query;
+    this.variables = params.variables;
+  }
+}

package/src/index.js

@@ -1,31 +1,32 @@
-const fs = require('fs');
-const path = require('path');
-const { print } = require('graphql');
+const fs = require("fs");
+const path = require("path");
+const { print } = require("graphql");
 
 const getType = (name, operationType, type) => {
   name = name.charAt(0).toUpperCase() + name.slice(1);
-  operationType = operationType.charAt(0).toUpperCase() + operationType.slice(1);
+  operationType =
+    operationType.charAt(0).toUpperCase() + operationType.slice(1);
   switch (type) {
-    case 'variables':
+    case "variables":
       return `${name}${operationType}Variables`;
-    case 'results':
+    case "results":
       return `${name}${operationType}`;
   }
 };
 
-const functionsToString = functions => {
-  let str = '{';
+const functionsToString = (functions) => {
+  let str = "{";
   for (let [name, body] of Object.entries(functions)) {
     str += `${name}: ${body},\n`;
   }
-  str += '}';
+  str += "}";
   return str;
 };
 
 const getUsedFragments = (raw, allFragments, results = []) => {
   const fragments = [...raw.matchAll(/\.\.\.(\w*)$/gm)]
     .map(([_, name]) => name)
-    .map(name => allFragments.find(d => d.name.value === name));
+    .map((name) => allFragments.find((d) => d.name.value === name));
 
   for (let fragment of fragments) {
     getUsedFragments(print(fragment), allFragments, results);
@@ -33,19 +34,22 @@ const getUsedFragments = (raw, allFragments, results = []) => {
   results.push(...fragments);
   return results;
 };
-
 const printOperation = (ast, allFragments) => {
-  ast.directives = ast.directives.filter(d => !['first', 'firstOrFail'].includes(d.name.value));
-  const raw = print(ast).replace('@firstOrFail', '').replace('@first', '').replace('@nonNullable', '');
+  ast.directives = ast.directives.filter(
+    (d) => !["first", "firstOrFail"].includes(d.name.value)
+  );
+  const raw = print(ast)
+    .replace("@firstOrFail", "")
+    .replace("@first", "")
+    .replace("@nonNullable", "");
 
   let fragments = getUsedFragments(raw, allFragments);
-  fragments = [...new Set(fragments)].map(f => print(f));
+  fragments = [...new Set(fragments)].map((f) => print(f));
 
-  return fragments.join('\n') + '\n' + raw;
+  return fragments.join("\n") + "\n" + raw;
 };
 
-const helpers = fs.readFileSync(path.join(__dirname, 'helpers.ts'), 'utf-8');
-
+const helpers = fs.readFileSync(path.join(__dirname, "helpers.ts"), "utf-8");
 module.exports = {
   plugin(schema, documents, config) {
     const functions = {};
@@ -54,7 +58,7 @@ module.exports = {
 
     for (let { document } of documents) {
       for (const definition of document.definitions) {
-        if (definition.kind === 'FragmentDefinition') {
+        if (definition.kind === "FragmentDefinition") {
           fragments.push(definition);
         }
       }
@@ -64,33 +68,44 @@ module.exports = {
       for (const definition of document.definitions) {
         const name = definition.name.value;
 
-        if (definition.kind !== 'OperationDefinition') {
+        if (definition.kind !== "OperationDefinition") {
           continue;
         }
-        const variablesType = getType(name, definition.operation, 'variables');
-        const resultsType = getType(name, definition.operation, 'results');
+        const variablesType = getType(name, definition.operation, "variables");
+        const resultsType = getType(name, definition.operation, "results");
 
-        queries.push(`const ${name}RawQuery = \`${printOperation(definition, fragments)}\`;`);
+        queries.push(
+          `const ${name}RawQuery = \`${printOperation(
+            definition,
+            fragments
+          )}\`;`
+        );
         let func = `(variables: ${variablesType}, config?: AxiosRequestConfig) => client.post<GraphqlResponse<${resultsType}>>("", {variables, query: ${name}RawQuery}, config).then(handleResponse)`;
 
         if (definition.selectionSet.selections.length === 1) {
-          if (!['query', 'mutation'].includes(definition.operation)) {
+          if (!["query", "mutation"].includes(definition.operation)) {
             continue;
           }
           const selection = definition.selectionSet.selections[0];
-          const directives = selection.directives.map(d => d.name.value);
+          const directives = selection.directives.map((d) => d.name.value);
           const propertyName = selection.name.value;
           func += `.then(unpackSingleResults("${propertyName}"))\n`;
           for (let directive of directives) {
-            func += `.then(${directive})\n`;
+            if (directive === "nonNullable" || directive === "firstOrFail") {
+              func += `.then(${directive}({variables, query: ${name}RawQuery}))\n`;
+            } else {
+              func += `.then(${directive})\n`;
+            }
           }
         }
         functions[name] = func;
       }
     }
 
-    const sdk = `export const getSdk = (client: AxiosInstance) => (${functionsToString(functions)})`;
-    return [...queries, helpers, sdk].join('\n');
+    const sdk = `export const getSdk = (client: AxiosInstance) => (${functionsToString(
+      functions
+    )})`;
+    return [...queries, helpers, sdk].join("\n");
   },
   addToSchema: /* GraphQL */ `
     directive @first on OBJECT