Make schemaConfig extensible

Author: bloodyowl

bin/generate-schema-config

@@ -37,9 +37,11 @@ introspection.then((introspection) => {
     });
   });
 
-  const json = Object.fromEntries(
-    [...interfaceToTypes.entries()].map(([key, value]) => [key, [...value]]),
-  );
+  const json = {
+    interfaceToTypes: Object.fromEntries(
+      [...interfaceToTypes.entries()].map(([key, value]) => [key, [...value]]),
+    ),
+  };
 
   console.log(JSON.stringify(json, null, 2));
 

example/gql-config.json

@@ -1,10 +1,12 @@
 {
-  "Node": [
-    "Film",
-    "Species",
-    "Planet",
-    "Person",
-    "Starship",
-    "Vehicle"
-  ]
+  "interfaceToTypes": {
+    "Node": [
+      "Film",
+      "Species",
+      "Planet",
+      "Person",
+      "Starship",
+      "Vehicle"
+    ]
+  }
 }

src/cache/cache.ts

@@ -28,6 +28,10 @@ export const getCacheKeyFromJson = (json: unknown): Option<symbol> => {
     .otherwise(() => Option.None());
 };
 
+export type SchemaConfig = {
+  interfaceToTypes: Record<string, string[]>;
+};
+
 export const getCacheKeyFromOperationNode = (
   operationNode: OperationDefinitionNode,
 ): Option<symbol> => {
@@ -48,9 +52,12 @@ export class ClientCache {
 
   schemaConfig: Record<string, Set<string>>;
 
-  constructor(schemaConfig: Record<string, string[]>) {
+  constructor(schemaConfig: SchemaConfig) {
     this.schemaConfig = Object.fromEntries(
-      Object.entries(schemaConfig).map(([key, value]) => [key, new Set(value)]),
+      Object.entries(schemaConfig.interfaceToTypes).map(([key, value]) => [
+        key,
+        new Set(value),
+      ]),
     );
   }
 

src/client.ts

@@ -2,7 +2,7 @@ import { DocumentNode, GraphQLError } from "@0no-co/graphql.web";
 import { Future, Option, Result } from "@swan-io/boxed";
 import { Request, badStatusToError, emptyToError } from "@swan-io/request";
 import { P, match } from "ts-pattern";
-import { ClientCache } from "./cache/cache";
+import { ClientCache, SchemaConfig } from "./cache/cache";
 import { optimizeQuery, readOperationFromCache } from "./cache/read";
 import { writeOperationToCache } from "./cache/write";
 import {
@@ -35,7 +35,7 @@ export type ClientConfig = {
   url: string;
   headers?: Record<string, string>;
   makeRequest?: MakeRequest;
-  schemaConfig: Record<string, string[]>;
+  schemaConfig: SchemaConfig;
 };
 
 const defaultMakeRequest: MakeRequest = ({

src/react/ClientContext.ts

@@ -2,5 +2,5 @@ import { createContext } from "react";
 import { Client } from "../client";
 
 export const ClientContext = createContext(
-  new Client({ url: "/graphql", schemaConfig: {} }),
+  new Client({ url: "/graphql", schemaConfig: { interfaceToTypes: {} } }),
 );

test/cache.test.ts

@@ -24,7 +24,7 @@ import {
 } from "./data";
 
 test("Write & read in cache", () => {
-  const cache = new ClientCache({});
+  const cache = new ClientCache({ interfaceToTypes: {} });
 
   const preparedAppQuery = inlineFragments(addTypenames(appQuery));
 
@@ -185,7 +185,7 @@ test("Write & read in cache", () => {
       .getWithDefault("no delta"),
   ).toMatchSnapshot();
 
-  const cache2 = new ClientCache({});
+  const cache2 = new ClientCache({ interfaceToTypes: {} });
 
   writeOperationToCache(
     cache2,
@@ -206,7 +206,7 @@ test("Write & read in cache", () => {
     }),
   ).toMatchObject(Option.Some(Result.Ok(onboardingInfoResponse)));
 
-  const cache3 = new ClientCache({});
+  const cache3 = new ClientCache({ interfaceToTypes: {} });
 
   writeOperationToCache(
     cache3,
@@ -358,7 +358,9 @@ test("Write & read in cache", () => {
   const preparedBrandingQuery = inlineFragments(addTypenames(brandingQuery));
 
   const cache4 = new ClientCache({
-    ProjectSettings: ["LiveProjectSettings", "SandboxProjectSettings"],
+    interfaceToTypes: {
+      ProjectSettings: ["LiveProjectSettings", "SandboxProjectSettings"],
+    },
   });
 
   writeOperationToCache(cache4, preparedBrandingQuery, brandingResponse, {