@theguild/federation-composition 0.4.0 → 0.5.0-alpha-20231213200549-5807b77

package/README.md

@@ -1,6 +1,6 @@
 # Federation Composition
 
-Supports all Federation versions prior to v2.4.0. Drop-in replacement for `@apollo/composition`.
+Supports all Federation versions. Drop-in replacement for `@apollo/composition`.
 
 🚧 Work in progress, so please check [TODOs](#todos).
 

package/cjs/specifications/federation.js

@@ -119,6 +119,76 @@ const federationSpecFactory = {
         ) repeatable on FIELD_DEFINITION | INTERFACE | OBJECT | UNION | ARGUMENT_DEFINITION | SCALAR | ENUM | ENUM_VALUE | INPUT_OBJECT | INPUT_FIELD_DEFINITION
         scalar FieldSet
       `, prefix, imports),
+    'v2.4': (prefix, imports) => createTypeDefinitions(`
+        directive @composeDirective(name: String!) repeatable on SCHEMA
+        directive @extends on OBJECT | INTERFACE
+        directive @external on OBJECT | FIELD_DEFINITION
+        directive @key(
+          fields: FieldSet!
+          resolvable: Boolean = true
+        ) repeatable on OBJECT | INTERFACE
+        directive @inaccessible on FIELD_DEFINITION | OBJECT | INTERFACE | UNION | ENUM | ENUM_VALUE | SCALAR | INPUT_OBJECT | INPUT_FIELD_DEFINITION | ARGUMENT_DEFINITION
+        directive @interfaceObject on OBJECT
+        directive @override(from: String!) on FIELD_DEFINITION
+        directive @provides(fields: FieldSet!) on FIELD_DEFINITION
+        directive @requires(fields: FieldSet!) on FIELD_DEFINITION
+        directive @shareable repeatable on FIELD_DEFINITION | OBJECT
+        directive @tag(
+          name: String!
+        ) repeatable on FIELD_DEFINITION | INTERFACE | OBJECT | UNION | ARGUMENT_DEFINITION | SCALAR | ENUM | ENUM_VALUE | INPUT_OBJECT | INPUT_FIELD_DEFINITION
+        scalar FieldSet
+      `, prefix, imports),
+    'v2.5': (prefix, imports) => createTypeDefinitions(`
+        directive @authenticated on FIELD_DEFINITION | OBJECT | INTERFACE | SCALAR | ENUM
+        directive @requiresScopes(
+          scopes: [[Scope!]!]!
+        ) on FIELD_DEFINITION | OBJECT | INTERFACE | SCALAR | ENUM
+        directive @composeDirective(name: String!) repeatable on SCHEMA
+        directive @extends on OBJECT | INTERFACE
+        directive @external on OBJECT | FIELD_DEFINITION
+        directive @key(
+          fields: FieldSet!
+          resolvable: Boolean = true
+        ) repeatable on OBJECT | INTERFACE
+        directive @inaccessible on FIELD_DEFINITION | OBJECT | INTERFACE | UNION | ENUM | ENUM_VALUE | SCALAR | INPUT_OBJECT | INPUT_FIELD_DEFINITION | ARGUMENT_DEFINITION
+        directive @interfaceObject on OBJECT
+        directive @override(from: String!) on FIELD_DEFINITION
+        directive @provides(fields: FieldSet!) on FIELD_DEFINITION
+        directive @requires(fields: FieldSet!) on FIELD_DEFINITION
+        directive @shareable repeatable on FIELD_DEFINITION | OBJECT
+        directive @tag(
+          name: String!
+        ) repeatable on FIELD_DEFINITION | INTERFACE | OBJECT | UNION | ARGUMENT_DEFINITION | SCALAR | ENUM | ENUM_VALUE | INPUT_OBJECT | INPUT_FIELD_DEFINITION
+        scalar FieldSet
+        scalar Scope
+      `, prefix, imports),
+    'v2.6': (prefix, imports) => createTypeDefinitions(`
+        directive @policy(
+          policies: [[federation__Policy!]!]!
+        ) on FIELD_DEFINITION | OBJECT | INTERFACE | SCALAR | ENUM
+        directive @authenticated on FIELD_DEFINITION | OBJECT | INTERFACE | SCALAR | ENUM
+        directive @requiresScopes(
+          scopes: [[Scope!]!]!
+        ) on FIELD_DEFINITION | OBJECT | INTERFACE | SCALAR | ENUM
+        directive @composeDirective(name: String!) repeatable on SCHEMA
+        directive @extends on OBJECT | INTERFACE
+        directive @external on OBJECT | FIELD_DEFINITION
+        directive @key(
+          fields: FieldSet!
+          resolvable: Boolean = true
+        ) repeatable on OBJECT | INTERFACE
+        directive @inaccessible on FIELD_DEFINITION | OBJECT | INTERFACE | UNION | ENUM | ENUM_VALUE | SCALAR | INPUT_OBJECT | INPUT_FIELD_DEFINITION | ARGUMENT_DEFINITION
+        directive @interfaceObject on OBJECT
+        directive @override(from: String!) on FIELD_DEFINITION
+        directive @provides(fields: FieldSet!) on FIELD_DEFINITION
+        directive @requires(fields: FieldSet!) on FIELD_DEFINITION
+        directive @shareable repeatable on FIELD_DEFINITION | OBJECT
+        directive @tag(
+          name: String!
+        ) repeatable on FIELD_DEFINITION | INTERFACE | OBJECT | UNION | ARGUMENT_DEFINITION | SCALAR | ENUM | ENUM_VALUE | INPUT_OBJECT | INPUT_FIELD_DEFINITION
+        scalar FieldSet
+        scalar Policy
+      `, prefix, imports),
 };
 function createTypeDefinitions(doc, prefix, imports) {
     const shouldFilter = !!imports;

package/cjs/subgraph/validation/rules/elements/authenticated.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuthenticatedRule = void 0;
+const graphql_1 = require("graphql");
+const helpers_js_1 = require("../../../helpers.js");
+function AuthenticatedRule(context) {
+    return {
+        DirectiveDefinition(node) {
+            (0, helpers_js_1.validateDirectiveAgainstOriginal)(node, 'authenticated', context);
+        },
+        Directive(node) {
+            if (!context.isAvailableFederationDirective('authenticated', node)) {
+                return;
+            }
+            context.reportError(new graphql_1.GraphQLError(`@authenticated is not yet supported`, {
+                extensions: { code: 'UNSUPPORTED_FEATURE' },
+            }));
+        },
+    };
+}
+exports.AuthenticatedRule = AuthenticatedRule;

package/cjs/subgraph/validation/rules/elements/policy.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PolicyRule = void 0;
+const graphql_1 = require("graphql");
+const helpers_js_1 = require("../../../helpers.js");
+function PolicyRule(context) {
+    return {
+        DirectiveDefinition(node) {
+            (0, helpers_js_1.validateDirectiveAgainstOriginal)(node, 'policy', context);
+        },
+        Directive(node) {
+            if (!context.isAvailableFederationDirective('policy', node)) {
+                return;
+            }
+            context.reportError(new graphql_1.GraphQLError(`@policy is not yet supported`, {
+                extensions: { code: 'UNSUPPORTED_FEATURE' },
+            }));
+        },
+    };
+}
+exports.PolicyRule = PolicyRule;

package/cjs/subgraph/validation/rules/elements/requires-scopes.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RequiresScopesRule = void 0;
+const graphql_1 = require("graphql");
+const helpers_js_1 = require("../../../helpers.js");
+function RequiresScopesRule(context) {
+    return {
+        DirectiveDefinition(node) {
+            (0, helpers_js_1.validateDirectiveAgainstOriginal)(node, 'requiresScopes', context);
+        },
+        Directive(node) {
+            if (!context.isAvailableFederationDirective('requiresScopes', node)) {
+                return;
+            }
+            context.reportError(new graphql_1.GraphQLError(`@requiresScopes is not yet supported`, {
+                extensions: { code: 'UNSUPPORTED_FEATURE' },
+            }));
+        },
+    };
+}
+exports.RequiresScopesRule = RequiresScopesRule;

package/cjs/subgraph/validation/validate-subgraph.js

@@ -5,6 +5,7 @@ const graphql_1 = require("graphql");
 const type_node_info_js_1 = require("../../graphql/type-node-info.js");
 const federation_js_1 = require("../../specifications/federation.js");
 const link_js_1 = require("../../specifications/link.js");
+const authenticated_js_1 = require("./rules/elements/authenticated.js");
 const compose_directive_js_1 = require("./rules/elements/compose-directive.js");
 const extends_js_1 = require("./rules/elements/extends.js");
 const external_js_1 = require("./rules/elements/external.js");
@@ -13,7 +14,9 @@ const inaccessible_js_1 = require("./rules/elements/inaccessible.js");
 const interface_object_js_1 = require("./rules/elements/interface-object.js");
 const key_js_1 = require("./rules/elements/key.js");
 const override_js_1 = require("./rules/elements/override.js");
+const policy_js_1 = require("./rules/elements/policy.js");
 const provides_js_1 = require("./rules/elements/provides.js");
+const requires_scopes_js_1 = require("./rules/elements/requires-scopes.js");
 const requires_js_1 = require("./rules/elements/requires.js");
 const shareable_js_1 = require("./rules/elements/shareable.js");
 const tag_js_1 = require("./rules/elements/tag.js");
@@ -68,6 +71,9 @@ function validateSubgraph(subgraph, stateBuilder, federation, __internal) {
         field_set_js_1.FieldSetRules,
         inaccessible_js_1.InaccessibleRules,
         interface_object_js_1.InterfaceObjectRules,
+        authenticated_js_1.AuthenticatedRule,
+        policy_js_1.PolicyRule,
+        requires_scopes_js_1.RequiresScopesRule,
         override_js_1.OverrideRules,
         extends_js_1.ExtendsRules,
         query_root_type_inaccessible_rule_js_1.QueryRootTypeInaccessibleRule,

package/esm/specifications/federation.js

@@ -114,6 +114,76 @@ const federationSpecFactory = {
         ) repeatable on FIELD_DEFINITION | INTERFACE | OBJECT | UNION | ARGUMENT_DEFINITION | SCALAR | ENUM | ENUM_VALUE | INPUT_OBJECT | INPUT_FIELD_DEFINITION
         scalar FieldSet
       `, prefix, imports),
+    'v2.4': (prefix, imports) => createTypeDefinitions(`
+        directive @composeDirective(name: String!) repeatable on SCHEMA
+        directive @extends on OBJECT | INTERFACE
+        directive @external on OBJECT | FIELD_DEFINITION
+        directive @key(
+          fields: FieldSet!
+          resolvable: Boolean = true
+        ) repeatable on OBJECT | INTERFACE
+        directive @inaccessible on FIELD_DEFINITION | OBJECT | INTERFACE | UNION | ENUM | ENUM_VALUE | SCALAR | INPUT_OBJECT | INPUT_FIELD_DEFINITION | ARGUMENT_DEFINITION
+        directive @interfaceObject on OBJECT
+        directive @override(from: String!) on FIELD_DEFINITION
+        directive @provides(fields: FieldSet!) on FIELD_DEFINITION
+        directive @requires(fields: FieldSet!) on FIELD_DEFINITION
+        directive @shareable repeatable on FIELD_DEFINITION | OBJECT
+        directive @tag(
+          name: String!
+        ) repeatable on FIELD_DEFINITION | INTERFACE | OBJECT | UNION | ARGUMENT_DEFINITION | SCALAR | ENUM | ENUM_VALUE | INPUT_OBJECT | INPUT_FIELD_DEFINITION
+        scalar FieldSet
+      `, prefix, imports),
+    'v2.5': (prefix, imports) => createTypeDefinitions(`
+        directive @authenticated on FIELD_DEFINITION | OBJECT | INTERFACE | SCALAR | ENUM
+        directive @requiresScopes(
+          scopes: [[Scope!]!]!
+        ) on FIELD_DEFINITION | OBJECT | INTERFACE | SCALAR | ENUM
+        directive @composeDirective(name: String!) repeatable on SCHEMA
+        directive @extends on OBJECT | INTERFACE
+        directive @external on OBJECT | FIELD_DEFINITION
+        directive @key(
+          fields: FieldSet!
+          resolvable: Boolean = true
+        ) repeatable on OBJECT | INTERFACE
+        directive @inaccessible on FIELD_DEFINITION | OBJECT | INTERFACE | UNION | ENUM | ENUM_VALUE | SCALAR | INPUT_OBJECT | INPUT_FIELD_DEFINITION | ARGUMENT_DEFINITION
+        directive @interfaceObject on OBJECT
+        directive @override(from: String!) on FIELD_DEFINITION
+        directive @provides(fields: FieldSet!) on FIELD_DEFINITION
+        directive @requires(fields: FieldSet!) on FIELD_DEFINITION
+        directive @shareable repeatable on FIELD_DEFINITION | OBJECT
+        directive @tag(
+          name: String!
+        ) repeatable on FIELD_DEFINITION | INTERFACE | OBJECT | UNION | ARGUMENT_DEFINITION | SCALAR | ENUM | ENUM_VALUE | INPUT_OBJECT | INPUT_FIELD_DEFINITION
+        scalar FieldSet
+        scalar Scope
+      `, prefix, imports),
+    'v2.6': (prefix, imports) => createTypeDefinitions(`
+        directive @policy(
+          policies: [[federation__Policy!]!]!
+        ) on FIELD_DEFINITION | OBJECT | INTERFACE | SCALAR | ENUM
+        directive @authenticated on FIELD_DEFINITION | OBJECT | INTERFACE | SCALAR | ENUM
+        directive @requiresScopes(
+          scopes: [[Scope!]!]!
+        ) on FIELD_DEFINITION | OBJECT | INTERFACE | SCALAR | ENUM
+        directive @composeDirective(name: String!) repeatable on SCHEMA
+        directive @extends on OBJECT | INTERFACE
+        directive @external on OBJECT | FIELD_DEFINITION
+        directive @key(
+          fields: FieldSet!
+          resolvable: Boolean = true
+        ) repeatable on OBJECT | INTERFACE
+        directive @inaccessible on FIELD_DEFINITION | OBJECT | INTERFACE | UNION | ENUM | ENUM_VALUE | SCALAR | INPUT_OBJECT | INPUT_FIELD_DEFINITION | ARGUMENT_DEFINITION
+        directive @interfaceObject on OBJECT
+        directive @override(from: String!) on FIELD_DEFINITION
+        directive @provides(fields: FieldSet!) on FIELD_DEFINITION
+        directive @requires(fields: FieldSet!) on FIELD_DEFINITION
+        directive @shareable repeatable on FIELD_DEFINITION | OBJECT
+        directive @tag(
+          name: String!
+        ) repeatable on FIELD_DEFINITION | INTERFACE | OBJECT | UNION | ARGUMENT_DEFINITION | SCALAR | ENUM | ENUM_VALUE | INPUT_OBJECT | INPUT_FIELD_DEFINITION
+        scalar FieldSet
+        scalar Policy
+      `, prefix, imports),
 };
 function createTypeDefinitions(doc, prefix, imports) {
     const shouldFilter = !!imports;

package/esm/subgraph/validation/rules/elements/authenticated.js

@@ -0,0 +1,17 @@
+import { GraphQLError } from 'graphql';
+import { validateDirectiveAgainstOriginal } from '../../../helpers.js';
+export function AuthenticatedRule(context) {
+    return {
+        DirectiveDefinition(node) {
+            validateDirectiveAgainstOriginal(node, 'authenticated', context);
+        },
+        Directive(node) {
+            if (!context.isAvailableFederationDirective('authenticated', node)) {
+                return;
+            }
+            context.reportError(new GraphQLError(`@authenticated is not yet supported`, {
+                extensions: { code: 'UNSUPPORTED_FEATURE' },
+            }));
+        },
+    };
+}

package/esm/subgraph/validation/rules/elements/policy.js

@@ -0,0 +1,17 @@
+import { GraphQLError } from 'graphql';
+import { validateDirectiveAgainstOriginal } from '../../../helpers.js';
+export function PolicyRule(context) {
+    return {
+        DirectiveDefinition(node) {
+            validateDirectiveAgainstOriginal(node, 'policy', context);
+        },
+        Directive(node) {
+            if (!context.isAvailableFederationDirective('policy', node)) {
+                return;
+            }
+            context.reportError(new GraphQLError(`@policy is not yet supported`, {
+                extensions: { code: 'UNSUPPORTED_FEATURE' },
+            }));
+        },
+    };
+}

package/esm/subgraph/validation/rules/elements/requires-scopes.js

@@ -0,0 +1,17 @@
+import { GraphQLError } from 'graphql';
+import { validateDirectiveAgainstOriginal } from '../../../helpers.js';
+export function RequiresScopesRule(context) {
+    return {
+        DirectiveDefinition(node) {
+            validateDirectiveAgainstOriginal(node, 'requiresScopes', context);
+        },
+        Directive(node) {
+            if (!context.isAvailableFederationDirective('requiresScopes', node)) {
+                return;
+            }
+            context.reportError(new GraphQLError(`@requiresScopes is not yet supported`, {
+                extensions: { code: 'UNSUPPORTED_FEATURE' },
+            }));
+        },
+    };
+}

package/esm/subgraph/validation/validate-subgraph.js

@@ -2,6 +2,7 @@ import { concatAST, GraphQLError, Kind, parse, visit, visitInParallel, } from 'g
 import { TypeNodeInfo, visitWithTypeNodeInfo } from '../../graphql/type-node-info.js';
 import { createSpecSchema } from '../../specifications/federation.js';
 import { parseLinkDirective } from '../../specifications/link.js';
+import { AuthenticatedRule } from './rules/elements/authenticated.js';
 import { ComposeDirectiveRules } from './rules/elements/compose-directive.js';
 import { ExtendsRules } from './rules/elements/extends.js';
 import { ExternalRules } from './rules/elements/external.js';
@@ -10,7 +11,9 @@ import { InaccessibleRules } from './rules/elements/inaccessible.js';
 import { InterfaceObjectRules } from './rules/elements/interface-object.js';
 import { KeyRules } from './rules/elements/key.js';
 import { OverrideRules } from './rules/elements/override.js';
+import { PolicyRule } from './rules/elements/policy.js';
 import { ProvidesRules } from './rules/elements/provides.js';
+import { RequiresScopesRule } from './rules/elements/requires-scopes.js';
 import { RequiresRules } from './rules/elements/requires.js';
 import { ShareableRules } from './rules/elements/shareable.js';
 import { TagRules } from './rules/elements/tag.js';
@@ -63,6 +66,9 @@ export function validateSubgraph(subgraph, stateBuilder, federation, __internal)
         FieldSetRules,
         InaccessibleRules,
         InterfaceObjectRules,
+        AuthenticatedRule,
+        PolicyRule,
+        RequiresScopesRule,
         OverrideRules,
         ExtendsRules,
         QueryRootTypeInaccessibleRule,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theguild/federation-composition",
-  "version": "0.4.0",
+  "version": "0.5.0-alpha-20231213200549-5807b77",
   "description": "Open Source Composition library for Apollo Federation",
   "peerDependencies": {
     "graphql": "^16.0.0"

package/typings/specifications/federation.d.cts

@@ -27,10 +27,22 @@ declare const federationSpecFactory: {
         directives: DirectiveDefinitionNode[];
         types: TypeDefinitionNode[];
     };
+    'v2.4': (prefix: string, imports?: readonly LinkImport[]) => {
+        directives: DirectiveDefinitionNode[];
+        types: TypeDefinitionNode[];
+    };
+    'v2.5': (prefix: string, imports?: readonly LinkImport[]) => {
+        directives: DirectiveDefinitionNode[];
+        types: TypeDefinitionNode[];
+    };
+    'v2.6': (prefix: string, imports?: readonly LinkImport[]) => {
+        directives: DirectiveDefinitionNode[];
+        types: TypeDefinitionNode[];
+    };
 };
 export declare function isFederationLink(link: Link): boolean;
 export declare function detectFederationVersion(typeDefs: DocumentNode): {
-    version: "v1.0" | "v2.0" | "v2.1" | "v2.2" | "v2.3";
+    version: "v1.0" | "v2.0" | "v2.1" | "v2.2" | "v2.3" | "v2.4" | "v2.5" | "v2.6";
     imports: ({
         readonly kind: "type" | "directive";
         readonly name: string;

package/typings/specifications/federation.d.ts

@@ -27,10 +27,22 @@ declare const federationSpecFactory: {
         directives: DirectiveDefinitionNode[];
         types: TypeDefinitionNode[];
     };
+    'v2.4': (prefix: string, imports?: readonly LinkImport[]) => {
+        directives: DirectiveDefinitionNode[];
+        types: TypeDefinitionNode[];
+    };
+    'v2.5': (prefix: string, imports?: readonly LinkImport[]) => {
+        directives: DirectiveDefinitionNode[];
+        types: TypeDefinitionNode[];
+    };
+    'v2.6': (prefix: string, imports?: readonly LinkImport[]) => {
+        directives: DirectiveDefinitionNode[];
+        types: TypeDefinitionNode[];
+    };
 };
 export declare function isFederationLink(link: Link): boolean;
 export declare function detectFederationVersion(typeDefs: DocumentNode): {
-    version: "v1.0" | "v2.0" | "v2.1" | "v2.2" | "v2.3";
+    version: "v1.0" | "v2.0" | "v2.1" | "v2.2" | "v2.3" | "v2.4" | "v2.5" | "v2.6";
     imports: ({
         readonly kind: "type" | "directive";
         readonly name: string;

package/typings/subgraph/validation/rules/elements/authenticated.d.cts

@@ -0,0 +1,4 @@
+import { ASTVisitor } from 'graphql';
+import type { SubgraphValidationContext } from '../../validation-context.cjs';
+export declare function AuthenticatedRule(context: SubgraphValidationContext): ASTVisitor;
+//# sourceMappingURL=authenticated.d.ts.map

package/typings/subgraph/validation/rules/elements/authenticated.d.ts

@@ -0,0 +1,4 @@
+import { ASTVisitor } from 'graphql';
+import type { SubgraphValidationContext } from '../../validation-context.js';
+export declare function AuthenticatedRule(context: SubgraphValidationContext): ASTVisitor;
+//# sourceMappingURL=authenticated.d.ts.map

package/typings/subgraph/validation/rules/elements/policy.d.cts

@@ -0,0 +1,4 @@
+import { ASTVisitor } from 'graphql';
+import type { SubgraphValidationContext } from '../../validation-context.cjs';
+export declare function PolicyRule(context: SubgraphValidationContext): ASTVisitor;
+//# sourceMappingURL=policy.d.ts.map

package/typings/subgraph/validation/rules/elements/policy.d.ts

@@ -0,0 +1,4 @@
+import { ASTVisitor } from 'graphql';
+import type { SubgraphValidationContext } from '../../validation-context.js';
+export declare function PolicyRule(context: SubgraphValidationContext): ASTVisitor;
+//# sourceMappingURL=policy.d.ts.map

package/typings/subgraph/validation/rules/elements/requires-scopes.d.cts

@@ -0,0 +1,4 @@
+import { ASTVisitor } from 'graphql';
+import type { SubgraphValidationContext } from '../../validation-context.cjs';
+export declare function RequiresScopesRule(context: SubgraphValidationContext): ASTVisitor;
+//# sourceMappingURL=requires-scopes.d.ts.map

package/typings/subgraph/validation/rules/elements/requires-scopes.d.ts

@@ -0,0 +1,4 @@
+import { ASTVisitor } from 'graphql';
+import type { SubgraphValidationContext } from '../../validation-context.js';
+export declare function RequiresScopesRule(context: SubgraphValidationContext): ASTVisitor;
+//# sourceMappingURL=requires-scopes.d.ts.map