Remove context.executeGraphQL (#5467)

* Remove context.executeGraphQL * Update .changeset/cyan-rules-smoke.md Co-authored-by: Mitchell Hamilton <mitchell@hamil.town>
keystonejs · Apr 15, 2021 · 7498fca · 7498fca · vercel · Apr 15, 2021
1 parent ac78b2a
commit 7498fca
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 8 deletions.
diff --git a/.changeset/cyan-rules-smoke.md b/.changeset/cyan-rules-smoke.md
@@ -0,0 +1,7 @@
+---
+'@keystone-next/keystone': major
+'@keystone-next/types': major
+'@keystone-next/website': patch
+---
+
+Removed the deprecated `context.executeGraphQL`. Identical functionality is available via `context.graphql.raw`.
diff --git a/docs-next/pages/apis/context.mdx b/docs-next/pages/apis/context.mdx
@@ -50,7 +50,6 @@ context = {
 
   // Deprecated
   gqlNames,
-  executeGraphQL,
   keystone,
 };
 ```
@@ -130,8 +129,6 @@ They will be removed in future releases.
 
 `gqlNames`: A function which takes a `listKey` and returns an object containing the GraphQL query, mutation and type names related to that list.
 
-`executeGraphQL`: This function is identical to `context.graphql.raw`, which is the preferred API to use.
-
 `keystone`: An object representing the internal state of the system.
 
 export default ({ children }) => <Markdown>{children}</Markdown>;
diff --git a/packages-next/keystone/src/lib/createContext.ts b/packages-next/keystone/src/lib/createContext.ts
@@ -78,9 +78,8 @@ export function makeCreateContext({
         }),
       req,
       ...sessionContext,
-      // Note: These two fields let us use the server-side-graphql-client library.
-      // We may want to remove them once the updated itemAPI w/ query is available.
-      executeGraphQL: rawGraphQL,
+      // Note: This field lets us use the server-side-graphql-client library.
+      // We may want to remove it once the updated itemAPI w/ query is available.
       gqlNames: (listKey: string) => keystone.lists[listKey].gqlNames,
     };
     const getArgsByList = schemaName === 'public' ? publicGetArgsByList : internalGetArgsByList;

diff --git a/packages-next/types/src/context.ts b/packages-next/types/src/context.ts
@@ -16,8 +16,6 @@ export type KeystoneContext = {
   /** @deprecated */
   gqlNames: (listKey: string) => Record<string, string>; // TODO: actual keys
   /** @deprecated */
-  executeGraphQL: any; // TODO: type this
-  /** @deprecated */
   keystone: BaseKeystone;
 } & AccessControlContext &
   Partial<SessionContext<any>> &