fix!: GraphtonSettings now uses static properties instead of a floating const

Author: Roboroads

.github/workflows/release.yml

@@ -3,15 +3,15 @@ on:
   workflow_dispatch:
     inputs:
       forceVersionType:
-        description: 'Force specific versioning type'
-        default: '-'
+        description: "Force specific versioning type"
+        default: "-"
         type: choice
         required: false
         options:
-          - '-'
-          - 'major'
-          - 'minor'
-          - 'patch'
+          - "-"
+          - "major"
+          - "minor"
+          - "patch"
 
 jobs:
   release:

CHANGELOG.md

@@ -6,40 +6,34 @@ All notable changes to this project will be documented in this file. See [standa
 
 ### [0.6.9](https://github.com/GraphtonLib/Graphton/compare/v0.6.8...v0.6.9) (2022-07-09)
 
-
 ### Bug Fixes
 
-* Export GraphtonBaseQuery ([e0507e4](https://github.com/GraphtonLib/Graphton/commit/e0507e45ce14c306265be9658d41447841f6336c))
+- Export GraphtonBaseQuery ([e0507e4](https://github.com/GraphtonLib/Graphton/commit/e0507e45ce14c306265be9658d41447841f6336c))
 
 ### [0.6.8](https://github.com/GraphtonLib/Graphton/compare/v0.6.7...v0.6.8) (2022-07-09)
 
-
 ### Bug Fixes
 
-* Scalar Properties rendering full type definition instead of just the name ([50bd7e5](https://github.com/GraphtonLib/Graphton/commit/50bd7e598bd0cb478e21ae435d0d5747df8f45c5))
-* **security:** Force minimist ^1.2.6 ([049bdc6](https://github.com/GraphtonLib/Graphton/commit/049bdc6e8e689bc967acb3c1423bbcb30645491a))
-* **security:** Force minimist ^1.2.6 ([0308b50](https://github.com/GraphtonLib/Graphton/commit/0308b503a53b613c20b2890ae687b1726736be85))
+- Scalar Properties rendering full type definition instead of just the name ([50bd7e5](https://github.com/GraphtonLib/Graphton/commit/50bd7e598bd0cb478e21ae435d0d5747df8f45c5))
+- **security:** Force minimist ^1.2.6 ([0308b50](https://github.com/GraphtonLib/Graphton/commit/0308b503a53b613c20b2890ae687b1726736be85))
 
 ### [0.6.7](https://github.com/GraphtonLib/Graphton/compare/v0.6.6...v0.6.7) (2022-07-09)
 
-
 ### Bug Fixes
 
-* Bug where enum was ignored in return type builders ([31507e2](https://github.com/GraphtonLib/Graphton/commit/31507e2b98f15a35a9abfabacb4e12cd7aaade79))
+- Bug where enum was ignored in return type builders ([31507e2](https://github.com/GraphtonLib/Graphton/commit/31507e2b98f15a35a9abfabacb4e12cd7aaade79))
 
 ### [0.6.6](https://github.com/GraphtonLib/Graphton/compare/v0.6.5...v0.6.6) (2022-05-01)
 
 ### [0.6.5](https://github.com/GraphtonLib/Graphton/compare/v0.6.4...v0.6.5) (2022-05-01)
 
-
 ### Features
 
-* Adds (alias) types for scalars and customization of custom scalar types ([ea75f69](https://github.com/GraphtonLib/Graphton/commit/ea75f69e767b5329bfe494a34877fa79e3fd00e2))
-
+- Adds (alias) types for scalars and customization of custom scalar types ([ea75f69](https://github.com/GraphtonLib/Graphton/commit/ea75f69e767b5329bfe494a34877fa79e3fd00e2))
 
 ### Bug Fixes
 
-* Add stacktrace to argify error ([c947e4b](https://github.com/GraphtonLib/Graphton/commit/c947e4bb11659602ffeeeb821a4593b4d93bc217))
+- Add stacktrace to argify error ([c947e4b](https://github.com/GraphtonLib/Graphton/commit/c947e4bb11659602ffeeeb821a4593b4d93bc217))
 
 ### [0.6.4](https://github.com/GraphtonLib/Graphton/compare/v0.6.3...v0.6.4) (2022-01-23)
 

README.md

@@ -388,21 +388,27 @@ Gives you a list of possible enums
 
 ### GraphtonSettings
 
-Use this to change the global settings used by Graphton on the fly!
+Graphton uses the static properties of this class, so you can customize these.
 
-#### setDefaultHeaders
+#### headers
 
-> static setDefaultHeaders(headers: Record<string, string>): void
+> public static headers = { };
 
 Set the headers for each following request to the server.
 
-#### setDefaultUrl
+```typescript
+GraphtonSettings.headers = { Authorization: "Bearer 123abc" };
+```
+
+#### graphqlEndpoint
 
-> static setDefaultUrl(defaultUrl: string): void
+> public static graphqlEndpoint: string = '<URL of retrospection>';
 
-Set the URL to the GraphQL server.
+Set the URL to the GraphQL endpoint, defaults to the URL used when generating the file.
 
-> NOTE: If you generated the Graphton file from a URL, this will also be the URL that's set if you havn't called this function yet. Use this if your GraphQL server differs from the one you introspected from.
+```typescript
+GraphtonSettings.graphqlEndpoint = "https://mycoolexample.app/graphql";
+```
 
 ## Links
 

example/graphtonGeneratedJavascript.js

@@ -4,17 +4,9 @@
  * @see https://github.com/GraphtonLib/Graphton
  **/
 // REGION: Base classes
-const settings = {
-  defaultHeaders: {},
-  defaultUrl: "",
-};
 export class GraphtonSettings {
-  static setDefaultHeaders(headers) {
-    settings.defaultHeaders = headers;
-  }
-  static setDefaultUrl(defaultUrl) {
-    settings.defaultUrl = defaultUrl;
-  }
+  static headers = {};
+  static graphqlEndpoint = "";
 }
 import axios from "axios";
 export class GraphtonBaseQuery {
@@ -55,12 +47,12 @@ export class GraphtonBaseQuery {
    */
   async execute(requestOptions = {}) {
     const response = await axios.post(
-      requestOptions?.url || settings.defaultUrl,
+      requestOptions?.url || GraphtonSettings.graphqlEndpoint,
       { query: this.toQuery() },
       {
         headers: {
           "Content-Type": "application/json",
-          ...settings.defaultHeaders,
+          ...GraphtonSettings.headers,
           ...requestOptions?.headers,
         },
       }

example/graphtonGeneratedTypescript.ts

@@ -5,19 +5,9 @@
  **/
 
 // REGION: Base classes
-const settings = {
-  defaultHeaders: {},
-  defaultUrl: "",
-};
-
 export class GraphtonSettings {
-  public static setDefaultHeaders(headers: Record<string, string>): void {
-    settings.defaultHeaders = headers;
-  }
-
-  public static setDefaultUrl(defaultUrl: string): void {
-    settings.defaultUrl = defaultUrl;
-  }
+  public static headers: Record<string, string> = {};
+  public static graphqlEndpoint: string = "";
 }
 
 import type { AxiosResponse } from "axios";
@@ -102,12 +92,12 @@ export abstract class GraphtonBaseQuery<T> {
    */
   protected async execute(requestOptions: RequestOptions = {}): Promise<QueryResponse> {
     const response = await axios.post(
-      requestOptions?.url || settings.defaultUrl,
+      requestOptions?.url || GraphtonSettings.graphqlEndpoint,
       { query: this.toQuery() },
       {
         headers: {
           "Content-Type": "application/json",
-          ...settings.defaultHeaders,
+          ...GraphtonSettings.headers,
           ...requestOptions?.headers,
         },
       }

src/commands/GenerateCommand.d.ts

@@ -1,13 +1,13 @@
 import { GenerateCommandOptions } from "../types/Generator";
 export default class GenerateCommand {
-    private gqlSchema;
-    generate(schemaUri: string, options: GenerateCommandOptions): Promise<void>;
-    private generateScalarTypeAliases;
-    private generateObjectTypes;
-    private generateReturnTypeBuilders;
-    private generateEnumTypes;
-    private generateQueryFactory;
-    private argsToMethodParameters;
-    private toTypeAppend;
-    private returnTypeInfo;
+  private gqlSchema;
+  generate(schemaUri: string, options: GenerateCommandOptions): Promise<void>;
+  private generateScalarTypeAliases;
+  private generateObjectTypes;
+  private generateReturnTypeBuilders;
+  private generateEnumTypes;
+  private generateQueryFactory;
+  private argsToMethodParameters;
+  private toTypeAppend;
+  private returnTypeInfo;
 }