fix SchemaPointer type, allow both URLs with headers and local type…

… definitions (#1406)
kamilkisiela · Oct 8, 2023 · 69afec4 · 69afec4
1 parent 90e58ab
commit 69afec4
Show file tree

Hide file tree

Showing 5 changed files with 60 additions and 43 deletions.
diff --git a/.changeset/wicked-pots-clap.md b/.changeset/wicked-pots-clap.md
@@ -0,0 +1,5 @@
+---
+'graphql-config': patch
+---
+
+fix `SchemaPointer` type, allow both URLs with headers and local type definitions
diff --git a/config-schema.json b/config-schema.json
@@ -52,7 +52,7 @@
           "title": "include"
         },
         "schema": {
-          "$ref": "#/definitions/SchemaPointer",
+          "$ref": "#/definitions/WithList<string|{[url:string]:{headers:{[name:string]:string;};};}>",
           "title": "schema"
         }
       },
@@ -112,52 +112,69 @@
       "title": "IGraphQLProjects",
       "type": "object"
     },
-    "SchemaPointer": {
+    "WithList<string>": {
       "anyOf": [
         {
           "items": {
             "type": "string"
           },
           "type": "array"
         },
-        {
-          "items": {
-            "additionalProperties": {
-              "properties": {
-                "headers": {
-                  "additionalProperties": {
-                    "type": "string"
-                  },
-                  "title": "headers",
-                  "type": "object"
-                }
-              },
-              "required": ["headers"],
-              "type": "object"
-            },
-            "type": "object"
-          },
-          "type": "array"
-        },
         {
           "type": "string"
         }
       ],
-      "title": "SchemaPointer"
+      "title": "WithList<string>"
     },
-    "WithList<string>": {
+    "WithList<string|{[url:string]:{headers:{[name:string]:string;};};}>": {
       "anyOf": [
+        {
+          "additionalProperties": {
+            "properties": {
+              "headers": {
+                "additionalProperties": {
+                  "type": "string"
+                },
+                "title": "headers",
+                "type": "object"
+              }
+            },
+            "required": ["headers"],
+            "type": "object"
+          },
+          "type": "object"
+        },
         {
           "items": {
-            "type": "string"
+            "anyOf": [
+              {
+                "additionalProperties": {
+                  "properties": {
+                    "headers": {
+                      "additionalProperties": {
+                        "type": "string"
+                      },
+                      "title": "headers",
+                      "type": "object"
+                    }
+                  },
+                  "required": ["headers"],
+                  "type": "object"
+                },
+                "type": "object"
+              },
+              {
+                "type": "string"
+              }
+            ]
           },
           "type": "array"
         },
         {
           "type": "string"
         }
       ],
-      "title": "WithList<string>"
+      "title": "WithList<string|{[url:string]:{headers:{[name:string]:string;};};}>"
     }
   },
   "description": "Structure of GraphQL Config"

diff --git a/package.json b/package.json
@@ -91,7 +91,7 @@
     "ts-node": "10.9.1",
     "tsx": "3.12.7",
     "typescript": "5.1.6",
-    "typescript-json-schema": "0.59.0",
+    "typescript-json-schema": "0.61.0",
     "vitest": "0.33.0"
   },
   "repository": {

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/types.ts b/src/types.ts
@@ -33,15 +33,16 @@ export interface IGraphQLProjectLegacy {
 
 export declare type WithList<T> = T | T[];
 export declare type ElementOf<TList> = TList extends Array<infer TElement> ? TElement : never;
-export declare type SchemaPointer =
-  | WithList<string>
+export declare type SchemaPointer = WithList<
+  | string
   | {
       [url: string]: {
         headers: {
           [name: string]: string;
         };
       };
-    }[];
+    }
+>;
 export declare type SchemaPointerSingle = ElementOf<SchemaPointer>;
 export declare type DocumentGlobPathPointer = string;
 export declare type DocumentPointer = WithList<DocumentGlobPathPointer>;