A set of utils for faster development of GraphQL tools
A fully open-source MIT-licensed GraphQL API gateway that can act as a GraphQL federation Gateway or a Proxy Gateway for any GraphQL services.
It can be run as a standalone binary, a Docker Image, or as a JavaScript package (e.g. within Node.js, Bun, Deno, Google Cloud Functions, Azure Functions or Cloudflare Workers)
graphql-hive0512be3]:#532 4e33933 Thanks @EmrysMyrddin! - dependencies updates:
@whatwg-node/promise-helpers@^1.3.0 ↗︎ (from ^1.2.5, in dependencies)Updated dependencies [4e33933]:
#862 278618a Thanks @ardatan! - dependencies updates:
@whatwg-node/promise-helpers@^1.2.5 ↗︎ (from ^1.0.0, in dependencies)Updated dependencies [278618a]:
#726 6334b2e Thanks @ardatan! - dependencies updates:
@whatwg-node/promise-helpers@^1.0.0 ↗︎ (to dependencies)Updated dependencies [6334b2e, 2a54e85]:
2318393]:#620 d72209a Thanks @renovate! - dependencies updates:
@graphql-tools/utils@^10.8.1 ↗︎ (from ^10.7.0, in dependencies)Updated dependencies [d72209a]:
9144222]:#472 e9f78cd Thanks @ardatan! - RenameObjectFieldArguments should transform the passed args in delegationContext.
When a subschema's a root field argument is renamed, the passed arguments should be also transformed;
type Query {
# This is the original field
book(book_id: ID): [Book]
}
type Book {
id: ID
title: String
}
When the subschema above is transformed to;
type Query {
# This is the transformed field
book(bookId: ID): [Book]
}
type Book {
id: ID
title: String
}
The following call should be transformed;
delegateToSchema({
schema: {
schema,
transforms: [
new RenameObjectFieldArguments((typeName, fieldName, argName) => {
if (
typeName === 'Query' &&
fieldName === 'book' &&
argName === 'book_id'
) {
return 'bookId';
}
return argName;
}),
],
},
operation: 'query',
fieldName: 'book',
args: {
bookId: '1',
},
});
To this query;
{
book(book_id: "1") {
# ...
}
}
Updated dependencies [18682e6]:
#373 e606975 Thanks @ardatan! - dependencies updates:
@graphql-tools/utils@^10.7.0 ↗︎ (from ^10.6.2, in dependencies)Updated dependencies [e606975]:
23b8987]:#291 34d1224 Thanks @ardatan! - dependencies updates:
tslib@^2.8.1 ↗︎ (from ^2.4.0, in dependencies)Updated dependencies [34d1224]:
#269 cdca511 Thanks @ardatan! - dependencies updates:
@graphql-tools/schema@^10.0.11 ↗︎ (from ^10.0.7, in dependencies)@graphql-tools/utils@^10.6.2 ↗︎ (from ^10.6.0, in dependencies)Updated dependencies [7df2215, cdca511]:
9ce705c]:7ca0ff3]:2e0add3]:#164 310613d Thanks @ardatan! - dependencies updates:
@graphql-tools/utils@^10.6.0 ↗︎ (from ^10.5.6, in dependencies)#185 f0b6921 Thanks @ardatan! - dependencies updates:
value-or-promise@^1.0.12 ↗︎ (from dependencies)#188 f71366d Thanks @ardatan! - dependencies updates:
value-or-promise@^1.0.12 ↗︎ (from dependencies)Updated dependencies [310613d]:
f32cb2a]:19bc6a4 Thanks @enisdenjo! - onError and onEnd callbacks when mapping async iterators are invoked only once regardless of how many times throw/return was called on the iterator
Updated dependencies [73c621d]:
342e044]:e9906eb]:da1de08]:f470f49]:180f3f0]:8effad4]:8a16b01]:4cdb462]:7e2938d]:cf2ce5e]:#5963
8199416
Thanks @EmrysMyrddin! - Fix missing __typename field when it
is already present but aliased.
Updated dependencies
[baf3c28]:
83c0af0
Thanks @enisdenjo! - dependencies updates:@graphql-tools/schema@^10.0.2 ↗︎
(from ^10.0.0, in dependencies)@graphql-tools/utils@^10.0.13 ↗︎
(from ^10.0.0, in dependencies)83c0af0,
83c0af0,
83c0af0]:#5572
aadb591f
Thanks @ardatan! - Fix for wrapping subscription types
Updated dependencies
[aadb591f]:
#5274
944a68e8
Thanks @ardatan! - Drop Node 14 support. Require Node.js >= 16
#5274
944a68e8
Thanks @ardatan! - introspectSchema has been removed, use
schemaFromExecutor instead
8fba6cc1,
944a68e8,
944a68e8]:1c95368a
Thanks @ardatan! - Use ranged versions for dependencies
Updated dependencies
[1c95368a]:
Updated dependencies []:
f26392a6]:492220cb]:30bd4d0c]:#5023
85659bca
Thanks @SimenB! - Only warn about deprecated introspectSchema once
Updated dependencies
[b09ea282,
b5c8f640]:
a94217e9,
62d074be]:772b948a]:499365aa
Thanks @ardatan! - Deprecate `introspectSchema` in favor of the
new `schemaFromExecutor`a4d36fcc
Thanks @renovate! - dependencies updates:value-or-promise@1.0.12 ↗︎ (from
1.0.11, in dependencies)a4d36fcc,
a4d36fcc,
e3ec35ed]:13177794]:#4890
eb6cd8b6
Thanks @ardatan! - Transform provided argument values properly
#4890
eb6cd8b6
Thanks @ardatan! - Handle argument definitions correctly during
delegation and transformations
Updated dependencies
[eb6cd8b6,
eb6cd8b6]:
904fe770,
904fe770]:13c24883,
b5e6459f]:7411a5e7]:#4825
1270b75a
Thanks @NullScope! - Fixed __typename being added more than once
in TransformCompositeFields
Updated dependencies
[c0639dd0]:
a58cd6d3
Thanks @ardatan! - Fix the bug when an optional argument's value is
not provided with MapLeafValues transformd83b1960]:80836fa7,
8f6d3efc,
80836fa7,
80836fa7,
80836fa7]:c1d01f3d
Thanks @ardatan! - Do not transform request if there is no value
transformed during the schema transformation
Updated dependencies
[f7daf777]:
df5848b8,
df5848b8,
df5848b8,
df5848b8]:0402894d]:00c4a1a4]:43c736bd
Thanks @ardatan! - RenameTypes: do not rename type if the new name
already exists in the schema43c736bd]:71cb4fae,
403ed450]:#4673
4fe3d9c0
Thanks @thgreasi! - Fix typings for TypeScript 4.8
#4676
4e4fac0a
Thanks @NullScope! - Fix transforming/renaming Wrapped GraphQL
Arguments
Updated dependencies
[4fe3d9c0]:
#4640
27bdc237
Thanks @ardatan! - dependencies updates:
@graphql-tools/delegate@9.0.3 ↗︎
(was 9.0.2, in dependencies)Updated dependencies
[0555a972]:
#4648
29ee7542
Thanks @ardatan! - Do not call Transform.transformSchema more than
once
Updated dependencies
[29ee7542]:
2609d71f]:#4566
d8dc67aa
Thanks @ardatan! - ## Breaking changes
Schema generation optimization by removing transfomedSchema parameter
Previously we were applying the transforms multiple times. We needed to introduced some breaking changes to improve the initial wrapped/stitched schema generation performance;
Transform.transformSchema no longer accepts transformedSchema which can easily be created
with applySchemaTransforms(schema, subschemaConfig) instead.createProxyingResolver to
SubschemaConfig no longer takes transformedSchema which can easily be created with
applySchemaTransforms(schema, subschemaConfig) instead.stitchSchemas doesn't take nested arrays of subschemas
stitchSchemas no longer accepts an array of arrays of subschema configuration objects. Instead,
it accepts an array of subschema configuration objects or schema objects directly.
stitchSchemas no longer prunes the schema with pruningOptions
You can use pruneSchema from @graphql-tools/utils to prune the schema instead.
stitchSchemas no longer respect "@computed" directive if stitchingDirectivesTransformer isn't
applied
Also @graphql-tools/stitch no longer exports computedDirectiveTransformer and
defaultSubschemaConfigTransforms. Instead, use @graphql-tools/stitching-directives package for
@computed directive.
Learn more about setting it up
computedFields has been removed from the merged type configuration
MergeTypeConfig.computedFields setting has been removed in favor of new computed field
configuration written as:
merge: {
MyType: {
fields: {
myComputedField: {
selectionSet: '{ weight }',
computed: true,
}
}
}
}
A field-level selectionSet specifies field dependencies while the computed setting structures
the field in a way that assures it is always selected with this data provided. The selectionSet
is intentionally generic to support possible future uses. This new pattern organizes all
field-level configuration (including canonical) into a single structure.
#4624
e3167edc
Thanks @n1ru4l! - Fix CommonJS TypeScript resolution with
moduleResolution node16 or nodenext
Updated dependencies
[8cc8721f,
e3167edc,
d8dc67aa]:
0bbb1769: Refine generic typings using extends X when appropriate
Typescript 4.7 has stricter requirements around generics which is explained well in the related PR: https://github.com/microsoft/TypeScript/pull/48366
These changes resolve the errors that these packages will face when attempting to upgrade to TS 4.7 (still in beta at the time of writing this). Landing these changes now will allow other TS libraries which depend on these packages to experiment with TS 4.7 in the meantime.
Updated dependencies [0bbb1769]
makeRemoteExecutableSchema has been removed.wrapSchema insteaddae6dc7b: refactor: ExecutionParams type replaced by Request type
rootValue property is now a part of the Request type.
When delegating with delegateToSchema, rootValue can be set multiple ways:
When using wrapSchema/stitchSchemas, a subschemaConfig can specify the createProxyingResolver function which can pass whatever rootValue it wants to delegateToSchema as above.
c42e811d: BREAKING CHANGES;
Request to ExecutionRequestoperationType: OperationTypeNode field in ExecutionRequestcontext in createRequest and createRequestInfo instead of delegateToSchemaIt doesn't rely on info.operation.operationType to allow the user to call an operation from different root type. And it doesn't call getOperationAST again and again to get operation type from the document/operation because we have it in Request and ExecutionParams https://github.com/ardatan/graphql-tools/pull/3166/files#diff-d4824895ea613dcc1f710c3ac82e952fe0ca12391b671f70d9f2d90d5656fdceR38
Improvements;
defaultExecutor for a single GraphQLSchema so allow getBatchingExecutor to memoize
batchingExecutor correctly.defaultExecutor is created for subscription and other operation
types. Only one executor is used.Batch executor is memoized by
executorreference butcreateDefaultExecutordidn't memoize the default executor so this memoization wasn't working correctly onbatch-executeside. https://github.com/ardatan/graphql-tools/blob/remove-info-executor/packages/batch-execute/src/getBatchingExecutor.ts#L9
7d3e3006: BREAKING CHANGE
AggregateError
implementation. The major difference is the individual errors are kept under errors property
instead of the object itself with Symbol.iterator.// From;
for (const error of aggregateError)
// To;
for (const error of aggregateError.errors)
introspectSchemaSync, introspectSchema already handles sync execution74581cf3: fix(getDirectives): preserve order around repeatable directives
BREAKING CHANGE: getDirectives now always return an array of individual DirectiveAnnotation
objects consisting of name and args properties.
New useful function getDirective returns an array of objects representing any args for each use
of a single directive (returning the empty object {} when a directive is used without
arguments).
Note: The getDirective function returns an array even when the specified directive is
non-repeatable. This is because one use of this function is to throw an error if more than one
directive annotation is used for a non repeatable directive!
When specifying directives in extensions, one can use either the old or new format.
c0ca3190: BREAKING CHANGE
Executor can receive AsyncIterable and subscriptions will also be handled by
Executor. This is a future-proof change for defer, stream and live queries9f60cad6: fix(transforms): don't add __typename to subscriptions
see: https://github.com/ardatan/graphql-tools/issues/2282 https://github.com/graphql/graphql-js/pull/2861 https://github.com/graphql/graphql-spec/pull/776
Updated dependencies [1b730f80]
be1a1575: ## Breaking Changes:
@graphql-tools/schema)Resolver validation options should now be set to error, warn or ignore rather than true
or false. In previous versions, some of the validators caused errors to be thrown, while some
issued warnings. This changes brings consistency to validator behavior.
The allowResolversNotInSchema has been renamed to requireResolversToMatchSchema, to
harmonize the naming convention of all the validators. The default setting of
requireResolversToMatchSchema is error, matching the previous behavior.
delegateToSchema & @graphql-tools/delegate)The delegateToSchema return value has matured and been formalized as an ExternalObject, in
which all errors are integrated into the GraphQL response, preserving their initial path. Those
advanced users accessing the result directly will note the change in error handling. This also
allows for the deprecation of unnecessary helper functions including slicedError, getErrors,
getErrorsByPathSegment functions. Only external errors with missing or invalid paths must
still be preserved by annotating the remote object with special properties. The new
getUnpathedErrors function is therefore necessary for retrieving only these errors. Note also
the new annotateExternalObject and mergeExternalObjects functions, as well as the renaming
of handleResult to resolveExternalValue.
Transform types and the applySchemaTransforms are now relocated to the delegate package;
applyRequestTransforms/applyResultTransforms functions have been deprecated, however, as
this functionality has been replaced since v6 by the Transformer abstraction.
The transformRequest/transformResult methods are now provided additional delegationContext
and transformationContext arguments -- these were introduced in v6, but previously optional.
The transformSchema method may wish to create additional delegating resolvers and so it is now
provided the subschemaConfig and final (non-executable) transformedSchema parameters. As in
v6, the transformSchema is kicked off once to produce the non-executable version, and then, if
a wrapping schema is being generated, proxying resolvers are created with access to the
(non-executable) initial result. In v7, the individual transformSchema methods also get access
to the result of the first run, if necessary, they can create additional wrapping schema
proxying resolvers.
applySchemaTransforms parameters have been updated to match and support the transformSchema
parameters above.
wrapSchema, makeRemoteExecutableSchema, and @graphql-tools/wrap)wrapSchema and generateProxyingResolvers now only take a single options argument with named
properties of type SubschemaConfig. The previously possible shorthand version with first
argument consisting of a GraphQLSchema and second argument representing the transforms should
be reworked as a SubschemaConfig object.
Similarly, the ICreateProxyingResolverOptions interface that provides the options for the
createProxyingResolver property of SubschemaConfig options has been adjusted. The schema
property previously could be set to a GraphQLSchema or a SubschemaConfig object. This
property has been removed in favor of a subschemaConfig property that will always be a
SubschemaConfig object. The transforms property has been removed; transforms should be
included within the SubschemaConfig object.`
The format of the wrapping schema has solidified. All non-root fields are expected to use
identical resolvers, either defaultMergedResolver or a custom equivalent, with root fields
doing the hard work of proxying. Support for custom merged resolvers throught
createMergedResolver has been deprecated, as custom merging resolvers conflicts when using
stitching's type merging, where resolvers are expected to be identical across subschemas.
The WrapFields transform's wrappingResolver option has been removed, as this complicates
multiple wrapping layers, as well as planned functionality to wrap subscription root fields in
potentially multiple layers, as the wrapping resolvers may be different in different layers.
Modifying resolvers can still be performed by use of an additional transform such as
TransformRootFields or TransformObjectFields.
The ExtendSchema transform has been removed, as it is conceptually simpler just to use
stitchSchemas with one subschema.
The ReplaceFieldsWithFragment, AddFragmentsByField, AddSelectionSetsByField, and
AddMergedTypeSelectionSets transforms has been removed, as they are superseded by the
AddSelectionSets and VisitSelectionSets transforms. The AddSelectionSets purposely takes
parsed SDL rather than strings, to nudge end users to parse these strings at build time (when
possible), rather than at runtime. Parsing of selection set strings can be performed using the
parseSelectionSet function from @graphql-tools/utils.
stitchSchemas & @graphql-tools/stitch)stitchSchemas's mergeTypes option is now true by default! This causes the onTypeConflict
option to be ignored by default. To use onTypeConflict to select a specific type instead of
simply merging, simply set mergeTypes to false.
schemas argument has been deprecated, use subschemas, typeDefs, or types, depending on
what you are stitching.
When using batch delegation in type merging, the argsFromKeys function is now set only via the
argsFromKeys property. Previously, if argsFromKeys was absent, it could be read from args.
Support for fragment hints has been removed in favor of selection set hints.
stitchSchemas now processes all GraphQLSchema and SubschemaConfig subschema input into new
Subschema objects, handling schema config directives such aso@computed as well as generating
the final transformed schema, stored as the transformedSchema property, if transforms are
used. Signatures of the onTypeConflict, fieldConfigMerger, and inputFieldConfigMerger have
been updated to include metadata related to the original and transformed subschemas. Note the
property name change for onTypeConflict from schema to subschema.
addMocksToSchema and @graphql-tools/mock)args, context, and info
with parent available as this rather than as the first argument.@graphql-tools/utils)filterSchema's fieldFilter will now filter all fields across Object, Interface, and Input
types. For the previous Object-only behavior, switch to the objectFieldFilter option.fieldNodes utility functions have been removed.typeContainsSelectionSet function has been removed, and typesContainSelectionSet has
been moved to the stitch package.Operation type has been removed in favor of OperationTypeNode from upstream
graphql-js.applySchemaTransforms/applyRequestTransforms/applyResultTransforms have been
removed from the utils package, as they are implemented elsewhere or no longer necessary.