@webiny/api-graphql 0.0.0-unstable.5387e5f7c8 → 0.0.0-unstable.d0f34a8194

package/graphql/abstractions.public.d.ts

@@ -7,16 +7,30 @@ export interface IGraphQLSchema {
 }
 /** Define custom GraphQL schema extensions. */
 export interface IGraphQLSchemaFactory {
+    /**
+     * Resolvers added here end up in a schema that is cached across requests. They must get
+     * request-scoped services through `addResolver({ dependencies })`, never from `this`.
+     */
     execute(builder: GraphQLSchemaBuilder.Interface): Promise<GraphQLSchemaBuilder.Interface>;
     /**
      * Returns what this factory's type definitions and resolver paths depend on: the same key must
      * always mean the same output. When every factory has one, the GraphQL engine runs the factories
      * only if no schema is cached under the combined key yet. Leave it out and the factories run on
-     * every request. Use `staticSchemaKey()` for a factory whose output never changes.
+     * every request, but a schema with the same output is still served from the cache, with the
+     * resolvers of the request that first built it. Use `staticSchemaKey()` for a factory whose
+     * output never changes.
      */
     getSchemaKey?(): string | Promise<string>;
 }
-/** Define custom GraphQL schema extensions. */
+/**
+ * Define custom GraphQL schema extensions.
+ *
+ * The built schema is cached across requests. Constructor dependencies are injected only for the
+ * request that builds it, so a resolver must never read them (`this.identityContext` and similar):
+ * every later request served from the cache would run with that request's identity, tenant and
+ * use cases. Declare what a resolver needs in `builder.addResolver({ dependencies })`, which
+ * resolves it from the current request, and register the factory with `dependencies: []`.
+ */
 export declare const GraphQLSchemaFactory: import("@webiny/di").Abstraction<IGraphQLSchemaFactory>;
 export declare namespace GraphQLSchemaFactory {
     type Interface = IGraphQLSchemaFactory;

package/graphql/abstractions.public.js.map

@@ -1 +1 @@
-{"version":3,"file":"graphql/abstractions.public.js","sources":["../../src/graphql/abstractions.public.ts"],"sourcesContent":["/**\n * This file contains abstraction for use by third party developers.\n */\nimport { createAbstraction } from \"@webiny/feature/api\";\nimport type {\n    Resolvers as IResolvers,\n    TypeDefs as ITypeDefs,\n    ResolverDecorators as IResolverDecorators\n} from \"~/types.js\";\nimport type { GraphQLSchemaBuilder } from \"~/features/GraphQLSchemaBuilder/abstractions.js\";\n\nexport interface IGraphQLSchema {\n    typeDefs?: ITypeDefs;\n    resolvers?: IResolvers<any>;\n    resolverDecorators?: IResolverDecorators;\n}\n\n/** Define custom GraphQL schema extensions. */\nexport interface IGraphQLSchemaFactory {\n    execute(builder: GraphQLSchemaBuilder.Interface): Promise<GraphQLSchemaBuilder.Interface>;\n    /**\n     * Returns what this factory's type definitions and resolver paths depend on: the same key must\n     * always mean the same output. When every factory has one, the GraphQL engine runs the factories\n     * only if no schema is cached under the combined key yet. Leave it out and the factories run on\n     * every request. Use `staticSchemaKey()` for a factory whose output never changes.\n     */\n    getSchemaKey?(): string | Promise<string>;\n}\n\n/** Define custom GraphQL schema extensions. */\nexport const GraphQLSchemaFactory =\n    createAbstraction<IGraphQLSchemaFactory>(\"GraphQLSchemaFactory\");\n\nexport namespace GraphQLSchemaFactory {\n    export type Interface = IGraphQLSchemaFactory;\n    export type SchemaBuilder = GraphQLSchemaBuilder.Interface;\n    export type Return = Promise<GraphQLSchemaBuilder.Interface>;\n}\n"],"names":["GraphQLSchemaFactory","createAbstraction"],"mappings":";AA8BO,MAAMA,uBACTC,kBAAyC"}
+{"version":3,"file":"graphql/abstractions.public.js","sources":["../../src/graphql/abstractions.public.ts"],"sourcesContent":["/**\n * This file contains abstraction for use by third party developers.\n */\nimport { createAbstraction } from \"@webiny/feature/api\";\nimport type {\n    Resolvers as IResolvers,\n    TypeDefs as ITypeDefs,\n    ResolverDecorators as IResolverDecorators\n} from \"~/types.js\";\nimport type { GraphQLSchemaBuilder } from \"~/features/GraphQLSchemaBuilder/abstractions.js\";\n\nexport interface IGraphQLSchema {\n    typeDefs?: ITypeDefs;\n    resolvers?: IResolvers<any>;\n    resolverDecorators?: IResolverDecorators;\n}\n\n/** Define custom GraphQL schema extensions. */\nexport interface IGraphQLSchemaFactory {\n    /**\n     * Resolvers added here end up in a schema that is cached across requests. They must get\n     * request-scoped services through `addResolver({ dependencies })`, never from `this`.\n     */\n    execute(builder: GraphQLSchemaBuilder.Interface): Promise<GraphQLSchemaBuilder.Interface>;\n    /**\n     * Returns what this factory's type definitions and resolver paths depend on: the same key must\n     * always mean the same output. When every factory has one, the GraphQL engine runs the factories\n     * only if no schema is cached under the combined key yet. Leave it out and the factories run on\n     * every request, but a schema with the same output is still served from the cache, with the\n     * resolvers of the request that first built it. Use `staticSchemaKey()` for a factory whose\n     * output never changes.\n     */\n    getSchemaKey?(): string | Promise<string>;\n}\n\n/**\n * Define custom GraphQL schema extensions.\n *\n * The built schema is cached across requests. Constructor dependencies are injected only for the\n * request that builds it, so a resolver must never read them (`this.identityContext` and similar):\n * every later request served from the cache would run with that request's identity, tenant and\n * use cases. Declare what a resolver needs in `builder.addResolver({ dependencies })`, which\n * resolves it from the current request, and register the factory with `dependencies: []`.\n */\nexport const GraphQLSchemaFactory =\n    createAbstraction<IGraphQLSchemaFactory>(\"GraphQLSchemaFactory\");\n\nexport namespace GraphQLSchemaFactory {\n    export type Interface = IGraphQLSchemaFactory;\n    export type SchemaBuilder = GraphQLSchemaBuilder.Interface;\n    export type Return = Promise<GraphQLSchemaBuilder.Interface>;\n}\n"],"names":["GraphQLSchemaFactory","createAbstraction"],"mappings":";AA4CO,MAAMA,uBACTC,kBAAyC"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@webiny/api-graphql",
-	"version": "0.0.0-unstable.5387e5f7c8",
+	"version": "0.0.0-unstable.d0f34a8194",
 	"type": "module",
 	"exports": {
 		".": "./index.js",
@@ -22,19 +22,19 @@
 		"@graphql-tools/resolvers-composition": "7.0.36",
 		"@graphql-tools/schema": "10.1.0",
 		"@graphql-tools/utils": "12.0.0",
-		"@webiny/api": "0.0.0-unstable.5387e5f7c8",
+		"@webiny/api": "0.0.0-unstable.d0f34a8194",
 		"@webiny/di": "2.0.0",
-		"@webiny/error": "0.0.0-unstable.5387e5f7c8",
-		"@webiny/event-handler-core": "0.0.0-unstable.5387e5f7c8",
-		"@webiny/feature": "0.0.0-unstable.5387e5f7c8",
-		"@webiny/plugins": "0.0.0-unstable.5387e5f7c8",
-		"@webiny/utils": "0.0.0-unstable.5387e5f7c8",
+		"@webiny/error": "0.0.0-unstable.d0f34a8194",
+		"@webiny/event-handler-core": "0.0.0-unstable.d0f34a8194",
+		"@webiny/feature": "0.0.0-unstable.d0f34a8194",
+		"@webiny/plugins": "0.0.0-unstable.d0f34a8194",
+		"@webiny/utils": "0.0.0-unstable.d0f34a8194",
 		"graphql": "16.14.2",
 		"graphql-scalars": "2.0.0",
 		"zod": "4.4.3"
 	},
 	"devDependencies": {
-		"@webiny/build-tools": "0.0.0-unstable.5387e5f7c8",
+		"@webiny/build-tools": "0.0.0-unstable.d0f34a8194",
 		"rimraf": "6.1.3",
 		"typescript": "7.0.2",
 		"vitest": "4.1.11"