feat: improve PersistedQueryProvider types (#1121)

* feat: improve PersistedQueryProvider types * feat: add tests
mercurius-js · Dec 12, 2024 · 8d6c319 · 8d6c319
1 parent b5cfac8
commit 8d6c319
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 1 deletion.
diff --git a/index.d.ts b/index.d.ts
@@ -633,7 +633,7 @@ declare namespace mercurius {
     /**
      *  Return the query for a given hash.
      */
-    getQueryFromHash: (hash: string) => Promise<string>;
+    getQueryFromHash: (hash: string) => Promise<string | undefined>;
     /**
      *  Return the hash for a given query string. Do not provide if you want to skip saving new queries.
      */

diff --git a/test/types/index.ts b/test/types/index.ts
@@ -654,3 +654,36 @@ expectType<typeof mercurius.ErrorWithProps>(ErrorWithProps)
 expectType<typeof mercurius.defaultErrorFormatter>(defaultErrorFormatter)
 expectType<typeof mercurius.persistedQueryDefaults>(persistedQueryDefaults)
 expectType<typeof mercurius.withFilter>(withFilter)
+
+app.register(mercurius, {
+  schema,
+  resolvers,
+  persistedQueryProvider: {
+    ...persistedQueryDefaults.automatic(),
+    getQueryFromHash: () => {
+      return Promise.resolve('foo')
+    },
+  }
+})
+
+app.register(mercurius, {
+  schema,
+  resolvers,
+  persistedQueryProvider: {
+    ...persistedQueryDefaults.automatic(),
+    getQueryFromHash: () => {
+      return Promise.resolve(undefined)
+    },
+  }
+})
+
+expectError(app.register(mercurius, {
+  schema,
+  resolvers,
+  persistedQueryProvider: {
+    ...persistedQueryDefaults.automatic(),
+    getQueryFromHash: () => {
+      return Promise.resolve(false)
+    },
+  }
+}))