@graphql-hive/gateway-runtime 2.1.1 → 2.1.2-alpha-deebbdd6955e1018f8702ddf86ee8da5c9cca8e7

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @graphql-hive/gateway-runtime
 
+## 2.1.2-alpha-deebbdd6955e1018f8702ddf86ee8da5c9cca8e7
+### Patch Changes
+
+
+
+- [#1474](https://github.com/graphql-hive/gateway/pull/1474) [`537ea70`](https://github.com/graphql-hive/gateway/commit/537ea70dc0ad16e5f48686f7c4b2efaba6f3ab59) Thanks [@ardatan](https://github.com/ardatan)! - In `persistedDocuments` options, `allowArbitraryOperations` flag has been deprecated, and introduced `allowArbitraryDocuments` for both Hive Console and custom store sources
+  
+  ```diff
+  defineConfig({
+  /* .. */
+  persistedDocuments: {
+     /* .. */
+  -   allowArbitraryOperations: true,
+  +   allowArbitraryDocuments: true,
+  },
+  });
+  ```
+- Updated dependencies []:
+  - @graphql-mesh/hmac-upstream-signature@2.0.1
+
 ## 2.1.1
 ### Patch Changes
 

package/dist/index.cjs

@@ -577,7 +577,7 @@ function useHiveConsole({
   });
 }
 
-function getReportingPlugin(config, configContext) {
+function getReportingPlugin(config, configContext, allowArbitraryDocuments = false) {
   if (config.reporting?.type === "hive") {
     const { target, ...reporting } = config.reporting;
     let usage = reporting.usage;
@@ -598,7 +598,8 @@ function getReportingPlugin(config, configContext) {
             endpoint: config.persistedDocuments.endpoint,
             accessToken: config.persistedDocuments.token
           },
-          allowArbitraryDocuments: !!config.persistedDocuments.allowArbitraryDocuments
+          // Trick to satisfy the Hive Console plugin types
+          allowArbitraryDocuments
         }
       } : {}
     });
@@ -1994,9 +1995,16 @@ function createGatewayRuntime(config) {
   let replaceSchema = (newSchema) => {
     unifiedGraph = newSchema;
   };
+  let allowArbitraryDocumentsForPersistedDocuments = false;
+  if (config.persistedDocuments?.allowArbitraryDocuments != null) {
+    allowArbitraryDocumentsForPersistedDocuments = config.persistedDocuments?.allowArbitraryDocuments;
+  } else if (config.persistedDocuments?.allowArbitraryOperations) {
+    allowArbitraryDocumentsForPersistedDocuments = config.persistedDocuments?.allowArbitraryOperations;
+  }
   const reportingWithMaybePersistedDocumentsPlugin = getReportingPlugin(
     config,
-    configContext
+    configContext,
+    allowArbitraryDocumentsForPersistedDocuments
   );
   let persistedDocumentsPlugin = {};
   if (config.reporting?.type !== "hive" && config.persistedDocuments && "type" in config.persistedDocuments && config.persistedDocuments?.type === "hive") {
@@ -2010,14 +2018,16 @@ function createGatewayRuntime(config) {
           endpoint: config.persistedDocuments.endpoint,
           accessToken: config.persistedDocuments.token
         },
-        allowArbitraryDocuments: !!config.persistedDocuments.allowArbitraryDocuments
+        // @ts-expect-error - Hive Console plugin options are not compatible yet
+        allowArbitraryDocuments: allowArbitraryDocumentsForPersistedDocuments
       }
     });
   } else if (config.persistedDocuments && "getPersistedOperation" in config.persistedDocuments) {
     const plugin = pluginPersistedOperations.usePersistedOperations({
       extractPersistedOperationId: defaultExtractPersistedOperationId,
       ...configContext,
-      ...config.persistedDocuments
+      ...config.persistedDocuments,
+      allowArbitraryOperations: allowArbitraryDocumentsForPersistedDocuments
     });
     persistedDocumentsPlugin = plugin;
   }

package/dist/index.d.cts

@@ -483,12 +483,44 @@ interface GatewayHivePersistedDocumentsOptions {
      * @default false
      */
     allowArbitraryDocuments?: boolean | ((request: Request) => MaybePromise<boolean>);
+    /**
+     * Whether arbitrary documents should be allowed along-side persisted documents.
+     *
+     * Alternatively, you can provide a function that returns a boolean value based on
+     * the request's headers.
+     *
+     * @default false
+     *
+     * @deprecated This option is deprecated and will be removed in the next major version. Use `allowArbitraryDocuments` instead.
+     */
+    allowArbitraryOperations?: boolean | ((request: Request) => MaybePromise<boolean>);
 }
 interface GatewayConfigBase<TContext extends Record<string, any>> {
     /** Usage reporting options. */
     reporting?: GatewayHiveReportingOptions | GatewayGraphOSReportingOptions;
     /** Persisted documents options. */
-    persistedDocuments?: GatewayHivePersistedDocumentsOptions | UsePersistedOperationsOptions<GatewayContext>;
+    persistedDocuments?: GatewayHivePersistedDocumentsOptions | (Omit<UsePersistedOperationsOptions<GatewayContext>, 'allowArbitraryOperations'> & {
+        /**
+         * Whether arbitrary documents should be allowed along-side persisted documents.
+         *
+         * Alternatively, you can provide a function that returns a boolean value based on
+         * the request's headers.
+         *
+         * @default false
+         */
+        allowArbitraryDocuments?: boolean | ((request: Request) => MaybePromise<boolean>);
+        /**
+         * Whether arbitrary documents should be allowed along-side persisted documents.
+         *
+         * Alternatively, you can provide a function that returns a boolean value based on
+         * the request's headers.
+         *
+         * @default false
+         *
+         * @deprecated This option is deprecated and will be removed in the next major version. Use `allowArbitraryDocuments` instead.
+         */
+        allowArbitraryOperations?: boolean | ((request: Request) => MaybePromise<boolean>);
+    });
     /**
      * A map, or factory function, of transport kinds to their implementations.
      *

package/dist/index.d.ts

@@ -483,12 +483,44 @@ interface GatewayHivePersistedDocumentsOptions {
      * @default false
      */
     allowArbitraryDocuments?: boolean | ((request: Request) => MaybePromise<boolean>);
+    /**
+     * Whether arbitrary documents should be allowed along-side persisted documents.
+     *
+     * Alternatively, you can provide a function that returns a boolean value based on
+     * the request's headers.
+     *
+     * @default false
+     *
+     * @deprecated This option is deprecated and will be removed in the next major version. Use `allowArbitraryDocuments` instead.
+     */
+    allowArbitraryOperations?: boolean | ((request: Request) => MaybePromise<boolean>);
 }
 interface GatewayConfigBase<TContext extends Record<string, any>> {
     /** Usage reporting options. */
     reporting?: GatewayHiveReportingOptions | GatewayGraphOSReportingOptions;
     /** Persisted documents options. */
-    persistedDocuments?: GatewayHivePersistedDocumentsOptions | UsePersistedOperationsOptions<GatewayContext>;
+    persistedDocuments?: GatewayHivePersistedDocumentsOptions | (Omit<UsePersistedOperationsOptions<GatewayContext>, 'allowArbitraryOperations'> & {
+        /**
+         * Whether arbitrary documents should be allowed along-side persisted documents.
+         *
+         * Alternatively, you can provide a function that returns a boolean value based on
+         * the request's headers.
+         *
+         * @default false
+         */
+        allowArbitraryDocuments?: boolean | ((request: Request) => MaybePromise<boolean>);
+        /**
+         * Whether arbitrary documents should be allowed along-side persisted documents.
+         *
+         * Alternatively, you can provide a function that returns a boolean value based on
+         * the request's headers.
+         *
+         * @default false
+         *
+         * @deprecated This option is deprecated and will be removed in the next major version. Use `allowArbitraryDocuments` instead.
+         */
+        allowArbitraryOperations?: boolean | ((request: Request) => MaybePromise<boolean>);
+    });
     /**
      * A map, or factory function, of transport kinds to their implementations.
      *

package/dist/index.js

@@ -576,7 +576,7 @@ function useHiveConsole({
   });
 }
 
-function getReportingPlugin(config, configContext) {
+function getReportingPlugin(config, configContext, allowArbitraryDocuments = false) {
   if (config.reporting?.type === "hive") {
     const { target, ...reporting } = config.reporting;
     let usage = reporting.usage;
@@ -597,7 +597,8 @@ function getReportingPlugin(config, configContext) {
             endpoint: config.persistedDocuments.endpoint,
             accessToken: config.persistedDocuments.token
           },
-          allowArbitraryDocuments: !!config.persistedDocuments.allowArbitraryDocuments
+          // Trick to satisfy the Hive Console plugin types
+          allowArbitraryDocuments
         }
       } : {}
     });
@@ -1993,9 +1994,16 @@ function createGatewayRuntime(config) {
   let replaceSchema = (newSchema) => {
     unifiedGraph = newSchema;
   };
+  let allowArbitraryDocumentsForPersistedDocuments = false;
+  if (config.persistedDocuments?.allowArbitraryDocuments != null) {
+    allowArbitraryDocumentsForPersistedDocuments = config.persistedDocuments?.allowArbitraryDocuments;
+  } else if (config.persistedDocuments?.allowArbitraryOperations) {
+    allowArbitraryDocumentsForPersistedDocuments = config.persistedDocuments?.allowArbitraryOperations;
+  }
   const reportingWithMaybePersistedDocumentsPlugin = getReportingPlugin(
     config,
-    configContext
+    configContext,
+    allowArbitraryDocumentsForPersistedDocuments
   );
   let persistedDocumentsPlugin = {};
   if (config.reporting?.type !== "hive" && config.persistedDocuments && "type" in config.persistedDocuments && config.persistedDocuments?.type === "hive") {
@@ -2009,14 +2017,16 @@ function createGatewayRuntime(config) {
           endpoint: config.persistedDocuments.endpoint,
           accessToken: config.persistedDocuments.token
         },
-        allowArbitraryDocuments: !!config.persistedDocuments.allowArbitraryDocuments
+        // @ts-expect-error - Hive Console plugin options are not compatible yet
+        allowArbitraryDocuments: allowArbitraryDocumentsForPersistedDocuments
       }
     });
   } else if (config.persistedDocuments && "getPersistedOperation" in config.persistedDocuments) {
     const plugin = usePersistedOperations({
       extractPersistedOperationId: defaultExtractPersistedOperationId,
       ...configContext,
-      ...config.persistedDocuments
+      ...config.persistedDocuments,
+      allowArbitraryOperations: allowArbitraryDocumentsForPersistedDocuments
     });
     persistedDocumentsPlugin = plugin;
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-hive/gateway-runtime",
-  "version": "2.1.1",
+  "version": "2.1.2-alpha-deebbdd6955e1018f8702ddf86ee8da5c9cca8e7",
   "type": "module",
   "repository": {
     "type": "git",