@graphql-tools/utils 13.0.1 → 13.0.2

package/cjs/index.js

@@ -56,4 +56,5 @@ tslib_1.__exportStar(require("./directives.js"), exports);
 tslib_1.__exportStar(require("./mergeIncrementalResult.js"), exports);
 tslib_1.__exportStar(require("./getDirectiveExtensions.js"), exports);
 tslib_1.__exportStar(require("./getDirectiveValues.js"), exports);
+tslib_1.__exportStar(require("./variableValues.js"), exports);
 tslib_1.__exportStar(require("./memoize.js"), exports);

package/cjs/variableValues.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.asGetArgumentValuesVariables = asGetArgumentValuesVariables;
+exports.coerceGetVariableValuesResult = coerceGetVariableValuesResult;
+const graphql_1 = require("graphql");
+function emptySources() {
+    return Object.create(null);
+}
+/**
+ * GraphQL 17 `getArgumentValues` expects `{ coerced, sources }`; GraphQL 16 accepts a flat map.
+ * Pass execution `variableValues` (often a flat record) through this helper before calling
+ * `getArgumentValues`.
+ */
+function asGetArgumentValuesVariables(variableValues) {
+    if (variableValues == null) {
+        return undefined;
+    }
+    if (graphql_1.versionInfo.major >= 17 && !('coerced' in variableValues)) {
+        return {
+            coerced: variableValues,
+            sources: emptySources(),
+        };
+    }
+    return variableValues;
+}
+/**
+ * Normalize `getVariableValues` success/error shapes across GraphQL 16 (`{ coerced }`) and
+ * GraphQL 17 (`{ variableValues: { coerced, sources } }`) for helpers like `shouldIncludeNode`.
+ */
+function coerceGetVariableValuesResult(result) {
+    if (result.errors != null && result.errors.length > 0) {
+        return { errors: result.errors };
+    }
+    if (result.variableValues != null) {
+        return { variableValues: result.variableValues };
+    }
+    if (result.coerced != null) {
+        return {
+            variableValues: {
+                coerced: result.coerced,
+                sources: emptySources(),
+            },
+        };
+    }
+    return {
+        variableValues: {
+            coerced: Object.create(null),
+            sources: emptySources(),
+        },
+    };
+}

package/esm/index.js

@@ -51,4 +51,5 @@ export * from './directives.js';
 export * from './mergeIncrementalResult.js';
 export * from './getDirectiveExtensions.js';
 export * from './getDirectiveValues.js';
+export * from './variableValues.js';
 export * from './memoize.js';

package/esm/variableValues.js

@@ -0,0 +1,47 @@
+import { versionInfo } from 'graphql';
+function emptySources() {
+    return Object.create(null);
+}
+/**
+ * GraphQL 17 `getArgumentValues` expects `{ coerced, sources }`; GraphQL 16 accepts a flat map.
+ * Pass execution `variableValues` (often a flat record) through this helper before calling
+ * `getArgumentValues`.
+ */
+export function asGetArgumentValuesVariables(variableValues) {
+    if (variableValues == null) {
+        return undefined;
+    }
+    if (versionInfo.major >= 17 && !('coerced' in variableValues)) {
+        return {
+            coerced: variableValues,
+            sources: emptySources(),
+        };
+    }
+    return variableValues;
+}
+/**
+ * Normalize `getVariableValues` success/error shapes across GraphQL 16 (`{ coerced }`) and
+ * GraphQL 17 (`{ variableValues: { coerced, sources } }`) for helpers like `shouldIncludeNode`.
+ */
+export function coerceGetVariableValuesResult(result) {
+    if (result.errors != null && result.errors.length > 0) {
+        return { errors: result.errors };
+    }
+    if (result.variableValues != null) {
+        return { variableValues: result.variableValues };
+    }
+    if (result.coerced != null) {
+        return {
+            variableValues: {
+                coerced: result.coerced,
+                sources: emptySources(),
+            },
+        };
+    }
+    return {
+        variableValues: {
+            coerced: Object.create(null),
+            sources: emptySources(),
+        },
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-tools/utils",
-  "version": "13.0.1",
+  "version": "13.0.2",
   "description": "Common package containing utils and types for GraphQL tools",
   "sideEffects": false,
   "peerDependencies": {

package/typings/index.d.cts

@@ -51,4 +51,5 @@ export * from './directives.cjs';
 export * from './mergeIncrementalResult.cjs';
 export * from './getDirectiveExtensions.cjs';
 export * from './getDirectiveValues.cjs';
+export * from './variableValues.cjs';
 export * from './memoize.cjs';

package/typings/index.d.ts

@@ -51,4 +51,5 @@ export * from './directives.js';
 export * from './mergeIncrementalResult.js';
 export * from './getDirectiveExtensions.js';
 export * from './getDirectiveValues.js';
+export * from './variableValues.js';
 export * from './memoize.js';

package/typings/variableValues.d.cts

@@ -0,0 +1,26 @@
+import type { GraphQLError } from 'graphql';
+import { getArgumentValues } from 'graphql';
+import type { VariableValues } from './types.cjs';
+type FlatVariableMap = {
+    readonly [variable: string]: unknown;
+};
+/**
+ * GraphQL 17 `getArgumentValues` expects `{ coerced, sources }`; GraphQL 16 accepts a flat map.
+ * Pass execution `variableValues` (often a flat record) through this helper before calling
+ * `getArgumentValues`.
+ */
+export declare function asGetArgumentValuesVariables(variableValues: FlatVariableMap | null | undefined): Parameters<typeof getArgumentValues>[2];
+/**
+ * Normalize `getVariableValues` success/error shapes across GraphQL 16 (`{ coerced }`) and
+ * GraphQL 17 (`{ variableValues: { coerced, sources } }`) for helpers like `shouldIncludeNode`.
+ */
+export declare function coerceGetVariableValuesResult(result: {
+    errors?: ReadonlyArray<GraphQLError>;
+    variableValues?: VariableValues;
+    coerced?: FlatVariableMap;
+}): {
+    readonly errors: ReadonlyArray<GraphQLError>;
+} | {
+    readonly variableValues: VariableValues;
+};
+export {};

package/typings/variableValues.d.ts

@@ -0,0 +1,26 @@
+import type { GraphQLError } from 'graphql';
+import { getArgumentValues } from 'graphql';
+import type { VariableValues } from './types.js';
+type FlatVariableMap = {
+    readonly [variable: string]: unknown;
+};
+/**
+ * GraphQL 17 `getArgumentValues` expects `{ coerced, sources }`; GraphQL 16 accepts a flat map.
+ * Pass execution `variableValues` (often a flat record) through this helper before calling
+ * `getArgumentValues`.
+ */
+export declare function asGetArgumentValuesVariables(variableValues: FlatVariableMap | null | undefined): Parameters<typeof getArgumentValues>[2];
+/**
+ * Normalize `getVariableValues` success/error shapes across GraphQL 16 (`{ coerced }`) and
+ * GraphQL 17 (`{ variableValues: { coerced, sources } }`) for helpers like `shouldIncludeNode`.
+ */
+export declare function coerceGetVariableValuesResult(result: {
+    errors?: ReadonlyArray<GraphQLError>;
+    variableValues?: VariableValues;
+    coerced?: FlatVariableMap;
+}): {
+    readonly errors: ReadonlyArray<GraphQLError>;
+} | {
+    readonly variableValues: VariableValues;
+};
+export {};