@theguild/federation-composition 0.1.4 → 0.2.0

package/cjs/graphql/helpers.js

@@ -1,55 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.stripFederationFromSupergraph = exports.isDirectiveDefinition = void 0;
+exports.isDirectiveDefinition = void 0;
 const graphql_1 = require("graphql");
 function isDirectiveDefinition(node) {
     return node.kind === graphql_1.Kind.DIRECTIVE_DEFINITION;
 }
 exports.isDirectiveDefinition = isDirectiveDefinition;
-function stripFederationFromSupergraph(supergraph) {
-    function removeDirective(node) {
-        const directiveName = node.name.value;
-        const isSpecifiedDirective = graphql_1.specifiedDirectives.some(d => d.name === directiveName);
-        if (!isSpecifiedDirective) {
-            const isFederationDirective = directiveName === 'link' ||
-                directiveName === 'inaccessible' ||
-                directiveName === 'tag' ||
-                directiveName === 'join__graph' ||
-                directiveName === 'join__type' ||
-                directiveName === 'join__implements' ||
-                directiveName === 'join__unionMember' ||
-                directiveName === 'join__enumValue' ||
-                directiveName === 'join__field';
-            if (isFederationDirective) {
-                return null;
-            }
-        }
-    }
-    return (0, graphql_1.visit)(supergraph, {
-        DirectiveDefinition: removeDirective,
-        Directive: removeDirective,
-        SchemaDefinition() {
-            return null;
-        },
-        SchemaExtension() {
-            return null;
-        },
-        EnumTypeDefinition: node => {
-            if (node.name.value === 'core__Purpose' ||
-                node.name.value === 'join__Graph' ||
-                node.name.value === 'link__Purpose') {
-                return null;
-            }
-            return node;
-        },
-        ScalarTypeDefinition: node => {
-            if (node.name.value === '_FieldSet' ||
-                node.name.value === 'link__Import' ||
-                node.name.value === 'join__FieldSet') {
-                return null;
-            }
-            return node;
-        },
-    });
-}
-exports.stripFederationFromSupergraph = stripFederationFromSupergraph;

package/cjs/graphql/transform-supergraph-to-public-schema.js

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transformSupergraphToPublicSchema = void 0;
+const graphql_1 = require("graphql");
+const federationScalars = new Set(['_FieldSet', 'link__Import', 'join__FieldSet']);
+const federationEnums = new Set(['core__Purpose', 'join__Graph', 'link__Purpose']);
+const federationDirectives = new Set([
+    'link',
+    'tag',
+    'join__graph',
+    'join__type',
+    'join__implements',
+    'join__unionMember',
+    'join__enumValue',
+    'join__field',
+    'inaccessible',
+]);
+const specifiedDirectives = new Set(graphql_1.specifiedDirectives.map(d => d.name));
+function getAdditionalDirectivesToStrip(documentNode) {
+    const schemaDefinitionNode = documentNode.definitions.find((node) => node.kind === graphql_1.Kind.SCHEMA_DEFINITION);
+    if (!schemaDefinitionNode?.directives?.length) {
+        return null;
+    }
+    const additionalDirectivesToStrip = new Set();
+    for (const directive of schemaDefinitionNode.directives) {
+        if (directive.name.value !== 'link') {
+            continue;
+        }
+        const asArg = directive.arguments?.find(arg => arg.name.value === 'as');
+        if (asArg?.value.kind === graphql_1.Kind.STRING) {
+            additionalDirectivesToStrip.add(asArg.value.value);
+        }
+    }
+    return additionalDirectivesToStrip;
+}
+const federationInaccessibleDirectiveUrlPrefix = 'https://specs.apollo.dev/inaccessible';
+function getInaccessibleDirectiveName(documentNode) {
+    const schemaDefinitionNode = documentNode.definitions.find((node) => node.kind === graphql_1.Kind.SCHEMA_DEFINITION);
+    if (schemaDefinitionNode?.directives?.length) {
+        for (const directive of schemaDefinitionNode.directives) {
+            if (directive.name.value !== 'link') {
+                continue;
+            }
+            const urlArg = directive.arguments?.find(arg => arg.name.value === 'url');
+            const asArg = directive.arguments?.find(arg => arg.name.value === 'as');
+            if (urlArg?.value.kind === graphql_1.Kind.STRING &&
+                urlArg.value.value.startsWith(federationInaccessibleDirectiveUrlPrefix)) {
+                if (asArg?.value.kind === graphql_1.Kind.STRING) {
+                    return asArg.value.value;
+                }
+                break;
+            }
+        }
+    }
+    return 'inaccessible';
+}
+function transformSupergraphToPublicSchema(documentNode) {
+    const additionalFederationDirectives = getAdditionalDirectivesToStrip(documentNode);
+    const inaccessibleDirectiveName = getInaccessibleDirectiveName(documentNode);
+    function removeFederationOrSpecifiedDirectives(node) {
+        if (federationDirectives.has(node.name.value) ||
+            additionalFederationDirectives?.has(node.name.value) ||
+            (node.kind === graphql_1.Kind.DIRECTIVE_DEFINITION && specifiedDirectives.has(node.name.value))) {
+            return null;
+        }
+    }
+    function hasInaccessibleDirective(node) {
+        return node.directives?.some(d => d.name.value === inaccessibleDirectiveName);
+    }
+    function removeInaccessibleNode(node) {
+        if (hasInaccessibleDirective(node)) {
+            return null;
+        }
+    }
+    return (0, graphql_1.visit)(documentNode, {
+        [graphql_1.Kind.DIRECTIVE_DEFINITION]: removeFederationOrSpecifiedDirectives,
+        [graphql_1.Kind.DIRECTIVE]: removeFederationOrSpecifiedDirectives,
+        [graphql_1.Kind.SCHEMA_EXTENSION]: () => null,
+        [graphql_1.Kind.SCHEMA_DEFINITION]: () => null,
+        [graphql_1.Kind.SCALAR_TYPE_DEFINITION](node) {
+            if (federationScalars.has(node.name.value) || hasInaccessibleDirective(node)) {
+                return null;
+            }
+        },
+        [graphql_1.Kind.ENUM_TYPE_DEFINITION](node) {
+            if (federationEnums.has(node.name.value) || hasInaccessibleDirective(node)) {
+                return null;
+            }
+        },
+        [graphql_1.Kind.OBJECT_TYPE_DEFINITION]: removeInaccessibleNode,
+        [graphql_1.Kind.FIELD_DEFINITION]: removeInaccessibleNode,
+        [graphql_1.Kind.INTERFACE_TYPE_DEFINITION]: removeInaccessibleNode,
+        [graphql_1.Kind.UNION_TYPE_DEFINITION]: removeInaccessibleNode,
+        [graphql_1.Kind.INPUT_OBJECT_TYPE_DEFINITION]: removeInaccessibleNode,
+        [graphql_1.Kind.INPUT_VALUE_DEFINITION]: removeInaccessibleNode,
+    });
+}
+exports.transformSupergraphToPublicSchema = transformSupergraphToPublicSchema;

package/cjs/index.js

@@ -14,9 +14,9 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.stripFederationFromSupergraph = void 0;
+exports.transformSupergraphToPublicSchema = void 0;
 __exportStar(require("./compose.js"), exports);
 __exportStar(require("./types.js"), exports);
 __exportStar(require("./validate.js"), exports);
-var helpers_js_1 = require("./graphql/helpers.js");
-Object.defineProperty(exports, "stripFederationFromSupergraph", { enumerable: true, get: function () { return helpers_js_1.stripFederationFromSupergraph; } });
+var transform_supergraph_to_public_schema_js_1 = require("./graphql/transform-supergraph-to-public-schema.js");
+Object.defineProperty(exports, "transformSupergraphToPublicSchema", { enumerable: true, get: function () { return transform_supergraph_to_public_schema_js_1.transformSupergraphToPublicSchema; } });

package/esm/graphql/helpers.js

@@ -1,50 +1,4 @@
-import { Kind, specifiedDirectives, visit, } from 'graphql';
+import { Kind } from 'graphql';
 export function isDirectiveDefinition(node) {
     return node.kind === Kind.DIRECTIVE_DEFINITION;
 }
-export function stripFederationFromSupergraph(supergraph) {
-    function removeDirective(node) {
-        const directiveName = node.name.value;
-        const isSpecifiedDirective = specifiedDirectives.some(d => d.name === directiveName);
-        if (!isSpecifiedDirective) {
-            const isFederationDirective = directiveName === 'link' ||
-                directiveName === 'inaccessible' ||
-                directiveName === 'tag' ||
-                directiveName === 'join__graph' ||
-                directiveName === 'join__type' ||
-                directiveName === 'join__implements' ||
-                directiveName === 'join__unionMember' ||
-                directiveName === 'join__enumValue' ||
-                directiveName === 'join__field';
-            if (isFederationDirective) {
-                return null;
-            }
-        }
-    }
-    return visit(supergraph, {
-        DirectiveDefinition: removeDirective,
-        Directive: removeDirective,
-        SchemaDefinition() {
-            return null;
-        },
-        SchemaExtension() {
-            return null;
-        },
-        EnumTypeDefinition: node => {
-            if (node.name.value === 'core__Purpose' ||
-                node.name.value === 'join__Graph' ||
-                node.name.value === 'link__Purpose') {
-                return null;
-            }
-            return node;
-        },
-        ScalarTypeDefinition: node => {
-            if (node.name.value === '_FieldSet' ||
-                node.name.value === 'link__Import' ||
-                node.name.value === 'join__FieldSet') {
-                return null;
-            }
-            return node;
-        },
-    });
-}

package/esm/graphql/transform-supergraph-to-public-schema.js

@@ -0,0 +1,94 @@
+import { Kind, specifiedDirectives as specifiedDirectivesArray, visit, } from 'graphql';
+const federationScalars = new Set(['_FieldSet', 'link__Import', 'join__FieldSet']);
+const federationEnums = new Set(['core__Purpose', 'join__Graph', 'link__Purpose']);
+const federationDirectives = new Set([
+    'link',
+    'tag',
+    'join__graph',
+    'join__type',
+    'join__implements',
+    'join__unionMember',
+    'join__enumValue',
+    'join__field',
+    'inaccessible',
+]);
+const specifiedDirectives = new Set(specifiedDirectivesArray.map(d => d.name));
+function getAdditionalDirectivesToStrip(documentNode) {
+    const schemaDefinitionNode = documentNode.definitions.find((node) => node.kind === Kind.SCHEMA_DEFINITION);
+    if (!schemaDefinitionNode?.directives?.length) {
+        return null;
+    }
+    const additionalDirectivesToStrip = new Set();
+    for (const directive of schemaDefinitionNode.directives) {
+        if (directive.name.value !== 'link') {
+            continue;
+        }
+        const asArg = directive.arguments?.find(arg => arg.name.value === 'as');
+        if (asArg?.value.kind === Kind.STRING) {
+            additionalDirectivesToStrip.add(asArg.value.value);
+        }
+    }
+    return additionalDirectivesToStrip;
+}
+const federationInaccessibleDirectiveUrlPrefix = 'https://specs.apollo.dev/inaccessible';
+function getInaccessibleDirectiveName(documentNode) {
+    const schemaDefinitionNode = documentNode.definitions.find((node) => node.kind === Kind.SCHEMA_DEFINITION);
+    if (schemaDefinitionNode?.directives?.length) {
+        for (const directive of schemaDefinitionNode.directives) {
+            if (directive.name.value !== 'link') {
+                continue;
+            }
+            const urlArg = directive.arguments?.find(arg => arg.name.value === 'url');
+            const asArg = directive.arguments?.find(arg => arg.name.value === 'as');
+            if (urlArg?.value.kind === Kind.STRING &&
+                urlArg.value.value.startsWith(federationInaccessibleDirectiveUrlPrefix)) {
+                if (asArg?.value.kind === Kind.STRING) {
+                    return asArg.value.value;
+                }
+                break;
+            }
+        }
+    }
+    return 'inaccessible';
+}
+export function transformSupergraphToPublicSchema(documentNode) {
+    const additionalFederationDirectives = getAdditionalDirectivesToStrip(documentNode);
+    const inaccessibleDirectiveName = getInaccessibleDirectiveName(documentNode);
+    function removeFederationOrSpecifiedDirectives(node) {
+        if (federationDirectives.has(node.name.value) ||
+            additionalFederationDirectives?.has(node.name.value) ||
+            (node.kind === Kind.DIRECTIVE_DEFINITION && specifiedDirectives.has(node.name.value))) {
+            return null;
+        }
+    }
+    function hasInaccessibleDirective(node) {
+        return node.directives?.some(d => d.name.value === inaccessibleDirectiveName);
+    }
+    function removeInaccessibleNode(node) {
+        if (hasInaccessibleDirective(node)) {
+            return null;
+        }
+    }
+    return visit(documentNode, {
+        [Kind.DIRECTIVE_DEFINITION]: removeFederationOrSpecifiedDirectives,
+        [Kind.DIRECTIVE]: removeFederationOrSpecifiedDirectives,
+        [Kind.SCHEMA_EXTENSION]: () => null,
+        [Kind.SCHEMA_DEFINITION]: () => null,
+        [Kind.SCALAR_TYPE_DEFINITION](node) {
+            if (federationScalars.has(node.name.value) || hasInaccessibleDirective(node)) {
+                return null;
+            }
+        },
+        [Kind.ENUM_TYPE_DEFINITION](node) {
+            if (federationEnums.has(node.name.value) || hasInaccessibleDirective(node)) {
+                return null;
+            }
+        },
+        [Kind.OBJECT_TYPE_DEFINITION]: removeInaccessibleNode,
+        [Kind.FIELD_DEFINITION]: removeInaccessibleNode,
+        [Kind.INTERFACE_TYPE_DEFINITION]: removeInaccessibleNode,
+        [Kind.UNION_TYPE_DEFINITION]: removeInaccessibleNode,
+        [Kind.INPUT_OBJECT_TYPE_DEFINITION]: removeInaccessibleNode,
+        [Kind.INPUT_VALUE_DEFINITION]: removeInaccessibleNode,
+    });
+}

package/esm/index.js

@@ -1,4 +1,4 @@
 export * from './compose.js';
 export * from './types.js';
 export * from './validate.js';
-export { stripFederationFromSupergraph } from './graphql/helpers.js';
+export { transformSupergraphToPublicSchema } from './graphql/transform-supergraph-to-public-schema.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theguild/federation-composition",
-  "version": "0.1.4",
+  "version": "0.2.0",
   "description": "Open Source Composition library for Apollo Federation",
   "peerDependencies": {
     "graphql": "^16.0.0"

package/typings/graphql/helpers.d.cts

@@ -1,4 +1,3 @@
-import { DefinitionNode, DirectiveDefinitionNode, DocumentNode } from 'graphql';
+import { type DefinitionNode, type DirectiveDefinitionNode } from 'graphql';
 export declare function isDirectiveDefinition(node: DefinitionNode): node is DirectiveDefinitionNode;
-export declare function stripFederationFromSupergraph(supergraph: DocumentNode): DocumentNode;
 //# sourceMappingURL=helpers.d.ts.map

package/typings/graphql/helpers.d.ts

@@ -1,4 +1,3 @@
-import { DefinitionNode, DirectiveDefinitionNode, DocumentNode } from 'graphql';
+import { type DefinitionNode, type DirectiveDefinitionNode } from 'graphql';
 export declare function isDirectiveDefinition(node: DefinitionNode): node is DirectiveDefinitionNode;
-export declare function stripFederationFromSupergraph(supergraph: DocumentNode): DocumentNode;
 //# sourceMappingURL=helpers.d.ts.map

package/typings/graphql/transform-supergraph-to-public-schema.d.cts

@@ -0,0 +1,3 @@
+import { type DocumentNode } from 'graphql';
+export declare function transformSupergraphToPublicSchema(documentNode: DocumentNode): DocumentNode;
+//# sourceMappingURL=transform-supergraph-to-public-schema.d.ts.map

package/typings/graphql/transform-supergraph-to-public-schema.d.ts

@@ -0,0 +1,3 @@
+import { type DocumentNode } from 'graphql';
+export declare function transformSupergraphToPublicSchema(documentNode: DocumentNode): DocumentNode;
+//# sourceMappingURL=transform-supergraph-to-public-schema.d.ts.map

package/typings/index.d.cts

@@ -1,5 +1,5 @@
 export * from './compose.cjs';
 export * from './types.cjs';
 export * from './validate.cjs';
-export { stripFederationFromSupergraph } from './graphql/helpers.cjs';
+export { transformSupergraphToPublicSchema } from './graphql/transform-supergraph-to-public-schema.cjs';
 //# sourceMappingURL=index.d.ts.map

package/typings/index.d.ts

@@ -1,5 +1,5 @@
 export * from './compose.js';
 export * from './types.js';
 export * from './validate.js';
-export { stripFederationFromSupergraph } from './graphql/helpers.js';
+export { transformSupergraphToPublicSchema } from './graphql/transform-supergraph-to-public-schema.js';
 //# sourceMappingURL=index.d.ts.map

package/typings/subgraph/validation/validation-context.d.cts

@@ -150,7 +150,7 @@ export declare function createSubgraphValidationContext(subgraph: {
         };
         composedDirectives: Set<string>;
         state: import("../state.js").SubgraphState;
-        markSpecAsUsed(specName: "link" | "inaccessible" | "tag"): void;
+        markSpecAsUsed(specName: "link" | "tag" | "inaccessible"): void;
         visitor(typeNodeInfo: TypeNodeInfo): import("graphql").ASTVisitor;
     };
     isAvailableFederationType(name: string): boolean;

package/typings/subgraph/validation/validation-context.d.ts

@@ -150,7 +150,7 @@ export declare function createSubgraphValidationContext(subgraph: {
         };
         composedDirectives: Set<string>;
         state: import("../state.js").SubgraphState;
-        markSpecAsUsed(specName: "link" | "inaccessible" | "tag"): void;
+        markSpecAsUsed(specName: "link" | "tag" | "inaccessible"): void;
         visitor(typeNodeInfo: TypeNodeInfo): import("graphql").ASTVisitor;
     };
     isAvailableFederationType(name: string): boolean;