@effect-gql/federation 0.1.0

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2025 Nick Fisher
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/dist/directives.d.ts

@@ -0,0 +1,136 @@
+import type { FederationDirective, KeyDirective } from "./types";
+/**
+ * Create a @key directive for entity identification
+ *
+ * @example
+ * ```typescript
+ * entity({
+ *   name: "User",
+ *   schema: UserSchema,
+ *   keys: [key({ fields: "id" })],
+ *   resolveReference: (ref) => UserService.findById(ref.id),
+ * })
+ * ```
+ */
+export declare const key: (config: KeyDirective) => FederationDirective;
+/**
+ * Create a @shareable directive
+ * Marks a type or field as resolvable by multiple subgraphs
+ *
+ * @example
+ * ```typescript
+ * entity({
+ *   name: "Product",
+ *   schema: ProductSchema,
+ *   keys: [key({ fields: "id" })],
+ *   directives: [shareable()],
+ * })
+ * ```
+ */
+export declare const shareable: () => FederationDirective;
+/**
+ * Create an @inaccessible directive
+ * Omits the type/field from the public API while keeping it available for federation
+ *
+ * @example
+ * ```typescript
+ * objectType({
+ *   name: "InternalMetadata",
+ *   schema: MetadataSchema,
+ *   directives: [inaccessible()],
+ * })
+ * ```
+ */
+export declare const inaccessible: () => FederationDirective;
+/**
+ * Create an @interfaceObject directive
+ * Indicates this object represents an interface from another subgraph
+ *
+ * @example
+ * ```typescript
+ * objectType({
+ *   name: "Media",
+ *   schema: MediaSchema,
+ *   directives: [interfaceObject()],
+ * })
+ * ```
+ */
+export declare const interfaceObject: () => FederationDirective;
+/**
+ * Create a @tag directive for metadata annotation
+ *
+ * @example
+ * ```typescript
+ * entity({
+ *   name: "Product",
+ *   schema: ProductSchema,
+ *   keys: [key({ fields: "id" })],
+ *   directives: [tag("public"), tag("catalog")],
+ * })
+ * ```
+ */
+export declare const tag: (name: string) => FederationDirective;
+/**
+ * Create an @external directive
+ * Marks a field as defined in another subgraph
+ *
+ * @example
+ * ```typescript
+ * field("User", "externalId", {
+ *   type: S.String,
+ *   directives: [external()],
+ *   resolve: (parent) => parent.externalId,
+ * })
+ * ```
+ */
+export declare const external: () => FederationDirective;
+/**
+ * Create a @requires directive
+ * Specifies fields that must be fetched from other subgraphs before this field can be resolved
+ *
+ * @example
+ * ```typescript
+ * field("Product", "shippingEstimate", {
+ *   type: S.Int,
+ *   directives: [requires({ fields: "weight dimensions { height width }" })],
+ *   resolve: (product) => calculateShipping(product.weight, product.dimensions),
+ * })
+ * ```
+ */
+export declare const requires: (config: {
+    fields: string;
+}) => FederationDirective;
+/**
+ * Create a @provides directive
+ * Router optimization hint - indicates this field provides additional fields on the returned type
+ *
+ * @example
+ * ```typescript
+ * field("Review", "author", {
+ *   type: UserSchema,
+ *   directives: [provides({ fields: "name email" })],
+ *   resolve: (review) => UserService.findById(review.authorId),
+ * })
+ * ```
+ */
+export declare const provides: (config: {
+    fields: string;
+}) => FederationDirective;
+/**
+ * Create an @override directive
+ * Transfers resolution responsibility from another subgraph
+ *
+ * @example
+ * ```typescript
+ * field("Product", "price", {
+ *   type: S.Number,
+ *   directives: [override({ from: "legacy-pricing" })],
+ *   resolve: (product) => PricingService.getPrice(product.id),
+ * })
+ * ```
+ */
+export declare const override: (config: {
+    from: string;
+    label?: string;
+}) => FederationDirective;
+//# sourceMappingURL=directives.d.ts.map

package/dist/directives.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"directives.d.ts","sourceRoot":"","sources":["../src/directives.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAMhE;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,GAAG,GAAI,QAAQ,YAAY,KAAG,mBAIzC,CAAA;AAEF;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,SAAS,QAAO,mBAE3B,CAAA;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,YAAY,QAAO,mBAE9B,CAAA;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,eAAe,QAAO,mBAEjC,CAAA;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,GAAG,GAAI,MAAM,MAAM,KAAG,mBAGjC,CAAA;AAMF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,QAAQ,QAAO,mBAE1B,CAAA;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,QAAQ,GAAI,QAAQ;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,KAAG,mBAGpD,CAAA;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,QAAQ,GAAI,QAAQ;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,KAAG,mBAGpD,CAAA;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,QAAQ,GAAI,QAAQ;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,KAAG,mBAIlE,CAAA"}

package/dist/directives.js

@@ -0,0 +1,171 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.override = exports.provides = exports.requires = exports.external = exports.tag = exports.interfaceObject = exports.inaccessible = exports.shareable = exports.key = void 0;
+// ============================================================================
+// Type-Level Directive Factories
+// ============================================================================
+/**
+ * Create a @key directive for entity identification
+ *
+ * @example
+ * ```typescript
+ * entity({
+ *   name: "User",
+ *   schema: UserSchema,
+ *   keys: [key({ fields: "id" })],
+ *   resolveReference: (ref) => UserService.findById(ref.id),
+ * })
+ * ```
+ */
+const key = (config) => ({
+    _tag: "key",
+    fields: config.fields,
+    resolvable: config.resolvable,
+});
+exports.key = key;
+/**
+ * Create a @shareable directive
+ * Marks a type or field as resolvable by multiple subgraphs
+ *
+ * @example
+ * ```typescript
+ * entity({
+ *   name: "Product",
+ *   schema: ProductSchema,
+ *   keys: [key({ fields: "id" })],
+ *   directives: [shareable()],
+ * })
+ * ```
+ */
+const shareable = () => ({
+    _tag: "shareable",
+});
+exports.shareable = shareable;
+/**
+ * Create an @inaccessible directive
+ * Omits the type/field from the public API while keeping it available for federation
+ *
+ * @example
+ * ```typescript
+ * objectType({
+ *   name: "InternalMetadata",
+ *   schema: MetadataSchema,
+ *   directives: [inaccessible()],
+ * })
+ * ```
+ */
+const inaccessible = () => ({
+    _tag: "inaccessible",
+});
+exports.inaccessible = inaccessible;
+/**
+ * Create an @interfaceObject directive
+ * Indicates this object represents an interface from another subgraph
+ *
+ * @example
+ * ```typescript
+ * objectType({
+ *   name: "Media",
+ *   schema: MediaSchema,
+ *   directives: [interfaceObject()],
+ * })
+ * ```
+ */
+const interfaceObject = () => ({
+    _tag: "interfaceObject",
+});
+exports.interfaceObject = interfaceObject;
+/**
+ * Create a @tag directive for metadata annotation
+ *
+ * @example
+ * ```typescript
+ * entity({
+ *   name: "Product",
+ *   schema: ProductSchema,
+ *   keys: [key({ fields: "id" })],
+ *   directives: [tag("public"), tag("catalog")],
+ * })
+ * ```
+ */
+const tag = (name) => ({
+    _tag: "tag",
+    name,
+});
+exports.tag = tag;
+// ============================================================================
+// Field-Level Directive Factories
+// ============================================================================
+/**
+ * Create an @external directive
+ * Marks a field as defined in another subgraph
+ *
+ * @example
+ * ```typescript
+ * field("User", "externalId", {
+ *   type: S.String,
+ *   directives: [external()],
+ *   resolve: (parent) => parent.externalId,
+ * })
+ * ```
+ */
+const external = () => ({
+    _tag: "external",
+});
+exports.external = external;
+/**
+ * Create a @requires directive
+ * Specifies fields that must be fetched from other subgraphs before this field can be resolved
+ *
+ * @example
+ * ```typescript
+ * field("Product", "shippingEstimate", {
+ *   type: S.Int,
+ *   directives: [requires({ fields: "weight dimensions { height width }" })],
+ *   resolve: (product) => calculateShipping(product.weight, product.dimensions),
+ * })
+ * ```
+ */
+const requires = (config) => ({
+    _tag: "requires",
+    fields: config.fields,
+});
+exports.requires = requires;
+/**
+ * Create a @provides directive
+ * Router optimization hint - indicates this field provides additional fields on the returned type
+ *
+ * @example
+ * ```typescript
+ * field("Review", "author", {
+ *   type: UserSchema,
+ *   directives: [provides({ fields: "name email" })],
+ *   resolve: (review) => UserService.findById(review.authorId),
+ * })
+ * ```
+ */
+const provides = (config) => ({
+    _tag: "provides",
+    fields: config.fields,
+});
+exports.provides = provides;
+/**
+ * Create an @override directive
+ * Transfers resolution responsibility from another subgraph
+ *
+ * @example
+ * ```typescript
+ * field("Product", "price", {
+ *   type: S.Number,
+ *   directives: [override({ from: "legacy-pricing" })],
+ *   resolve: (product) => PricingService.getPrice(product.id),
+ * })
+ * ```
+ */
+const override = (config) => ({
+    _tag: "override",
+    from: config.from,
+    label: config.label,
+});
+exports.override = override;
+//# sourceMappingURL=directives.js.map

package/dist/directives.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"directives.js","sourceRoot":"","sources":["../src/directives.ts"],"names":[],"mappings":";;;AAEA,+EAA+E;AAC/E,iCAAiC;AACjC,+EAA+E;AAE/E;;;;;;;;;;;;GAYG;AACI,MAAM,GAAG,GAAG,CAAC,MAAoB,EAAuB,EAAE,CAAC,CAAC;IACjE,IAAI,EAAE,KAAK;IACX,MAAM,EAAE,MAAM,CAAC,MAAM;IACrB,UAAU,EAAE,MAAM,CAAC,UAAU;CAC9B,CAAC,CAAA;AAJW,QAAA,GAAG,OAId;AAEF;;;;;;;;;;;;;GAaG;AACI,MAAM,SAAS,GAAG,GAAwB,EAAE,CAAC,CAAC;IACnD,IAAI,EAAE,WAAW;CAClB,CAAC,CAAA;AAFW,QAAA,SAAS,aAEpB;AAEF;;;;;;;;;;;;GAYG;AACI,MAAM,YAAY,GAAG,GAAwB,EAAE,CAAC,CAAC;IACtD,IAAI,EAAE,cAAc;CACrB,CAAC,CAAA;AAFW,QAAA,YAAY,gBAEvB;AAEF;;;;;;;;;;;;GAYG;AACI,MAAM,eAAe,GAAG,GAAwB,EAAE,CAAC,CAAC;IACzD,IAAI,EAAE,iBAAiB;CACxB,CAAC,CAAA;AAFW,QAAA,eAAe,mBAE1B;AAEF;;;;;;;;;;;;GAYG;AACI,MAAM,GAAG,GAAG,CAAC,IAAY,EAAuB,EAAE,CAAC,CAAC;IACzD,IAAI,EAAE,KAAK;IACX,IAAI;CACL,CAAC,CAAA;AAHW,QAAA,GAAG,OAGd;AAEF,+EAA+E;AAC/E,kCAAkC;AAClC,+EAA+E;AAE/E;;;;;;;;;;;;GAYG;AACI,MAAM,QAAQ,GAAG,GAAwB,EAAE,CAAC,CAAC;IAClD,IAAI,EAAE,UAAU;CACjB,CAAC,CAAA;AAFW,QAAA,QAAQ,YAEnB;AAEF;;;;;;;;;;;;GAYG;AACI,MAAM,QAAQ,GAAG,CAAC,MAA0B,EAAuB,EAAE,CAAC,CAAC;IAC5E,IAAI,EAAE,UAAU;IAChB,MAAM,EAAE,MAAM,CAAC,MAAM;CACtB,CAAC,CAAA;AAHW,QAAA,QAAQ,YAGnB;AAEF;;;;;;;;;;;;GAYG;AACI,MAAM,QAAQ,GAAG,CAAC,MAA0B,EAAuB,EAAE,CAAC,CAAC;IAC5E,IAAI,EAAE,UAAU;IAChB,MAAM,EAAE,MAAM,CAAC,MAAM;CACtB,CAAC,CAAA;AAHW,QAAA,QAAQ,YAGnB;AAEF;;;;;;;;;;;;GAYG;AACI,MAAM,QAAQ,GAAG,CAAC,MAAwC,EAAuB,EAAE,CAAC,CAAC;IAC1F,IAAI,EAAE,UAAU;IAChB,IAAI,EAAE,MAAM,CAAC,IAAI;IACjB,KAAK,EAAE,MAAM,CAAC,KAAK;CACpB,CAAC,CAAA;AAJW,QAAA,QAAQ,YAInB"}

package/dist/entities.d.ts

@@ -0,0 +1,31 @@
+import { Runtime } from "effect";
+import { GraphQLObjectType, GraphQLUnionType } from "@effect-gql/core";
+import type { EntityRegistration, EntityRepresentation } from "./types";
+/**
+ * Create the _Entity union type from registered entities
+ */
+export declare function createEntityUnion(entities: Map<string, EntityRegistration<any, any>>, typeRegistry: Map<string, GraphQLObjectType>): GraphQLUnionType;
+/**
+ * Create the _entities resolver
+ *
+ * This resolver receives an array of representations (objects with __typename and key fields)
+ * and returns the corresponding entities by calling each entity's resolveReference function.
+ *
+ * Uses Effect.all with unbounded concurrency to resolve all entities in parallel.
+ */
+export declare function createEntitiesResolver<R>(entities: Map<string, EntityRegistration<any, R>>): (_parent: any, args: {
+    representations: readonly EntityRepresentation[];
+}, context: {
+    runtime: Runtime.Runtime<R>;
+}) => Promise<(any | null)[]>;
+/**
+ * Create the _Service type for SDL introspection
+ */
+export declare function createServiceType(): GraphQLObjectType;
+/**
+ * Create the _service resolver
+ */
+export declare function createServiceResolver(sdl: string): () => {
+    sdl: string;
+};
+//# sourceMappingURL=entities.d.ts.map

package/dist/entities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../src/entities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,OAAO,EAAE,MAAM,QAAQ,CAAA;AACxC,OAAO,EAAE,iBAAiB,EAAE,gBAAgB,EAAiB,MAAM,kBAAkB,CAAA;AACrF,OAAO,KAAK,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAEvE;;GAEG;AACH,wBAAgB,iBAAiB,CAC/B,QAAQ,EAAE,GAAG,CAAC,MAAM,EAAE,kBAAkB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,EACnD,YAAY,EAAE,GAAG,CAAC,MAAM,EAAE,iBAAiB,CAAC,GAC3C,gBAAgB,CAelB;AAED;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,EAAE,QAAQ,EAAE,GAAG,CAAC,MAAM,EAAE,kBAAkB,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,IAEvF,SAAS,GAAG,EACZ,MAAM;IAAE,eAAe,EAAE,SAAS,oBAAoB,EAAE,CAAA;CAAE,EAC1D,SAAS;IAAE,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;CAAE,KACvC,OAAO,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,EAAE,CAAC,CA0B3B;AAED;;GAEG;AACH,wBAAgB,iBAAiB,IAAI,iBAAiB,CAWrD;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,MAAM;;EAEhD"}

package/dist/entities.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createEntityUnion = createEntityUnion;
+exports.createEntitiesResolver = createEntitiesResolver;
+exports.createServiceType = createServiceType;
+exports.createServiceResolver = createServiceResolver;
+const effect_1 = require("effect");
+const core_1 = require("@effect-gql/core");
+/**
+ * Create the _Entity union type from registered entities
+ */
+function createEntityUnion(entities, typeRegistry) {
+    const types = Array.from(entities.keys())
+        .map((name) => typeRegistry.get(name))
+        .filter(Boolean);
+    if (types.length === 0) {
+        throw new Error("At least one entity must be registered to create _Entity union");
+    }
+    return new core_1.GraphQLUnionType({
+        name: "_Entity",
+        description: "Union of all types that have @key directives",
+        types: () => types,
+        resolveType: (value) => value.__typename,
+    });
+}
+/**
+ * Create the _entities resolver
+ *
+ * This resolver receives an array of representations (objects with __typename and key fields)
+ * and returns the corresponding entities by calling each entity's resolveReference function.
+ *
+ * Uses Effect.all with unbounded concurrency to resolve all entities in parallel.
+ */
+function createEntitiesResolver(entities) {
+    return async (_parent, args, context) => {
+        const effects = args.representations.map((representation) => {
+            const entityName = representation.__typename;
+            const entity = entities.get(entityName);
+            if (!entity) {
+                return effect_1.Effect.fail(new Error(`Unknown entity type: ${entityName}`));
+            }
+            return entity.resolveReference(representation).pipe(effect_1.Effect.map((result) => {
+                // Add __typename to the result for union type resolution
+                if (result !== null && typeof result === "object") {
+                    return { ...result, __typename: entityName };
+                }
+                return result;
+            }), 
+            // Catch individual entity resolution errors and return null
+            effect_1.Effect.catchAll((error) => effect_1.Effect.logError(`Failed to resolve entity ${entityName}`, error).pipe(effect_1.Effect.as(null))));
+        });
+        return effect_1.Runtime.runPromise(context.runtime)(effect_1.Effect.all(effects, { concurrency: "unbounded" }));
+    };
+}
+/**
+ * Create the _Service type for SDL introspection
+ */
+function createServiceType() {
+    return new core_1.GraphQLObjectType({
+        name: "_Service",
+        description: "Provides SDL for the subgraph schema",
+        fields: {
+            sdl: {
+                type: core_1.GraphQLString,
+                description: "The SDL representing the subgraph schema",
+            },
+        },
+    });
+}
+/**
+ * Create the _service resolver
+ */
+function createServiceResolver(sdl) {
+    return () => ({ sdl });
+}
+//# sourceMappingURL=entities.js.map

package/dist/entities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entities.js","sourceRoot":"","sources":["../src/entities.ts"],"names":[],"mappings":";;AAOA,8CAkBC;AAUD,wDA+BC;AAKD,8CAWC;AAKD,sDAEC;AAzFD,mCAAwC;AACxC,2CAAqF;AAGrF;;GAEG;AACH,SAAgB,iBAAiB,CAC/B,QAAmD,EACnD,YAA4C;IAE5C,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;SACtC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAE,CAAC;SACtC,MAAM,CAAC,OAAO,CAAC,CAAA;IAElB,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAA;IACnF,CAAC;IAED,OAAO,IAAI,uBAAgB,CAAC;QAC1B,IAAI,EAAE,SAAS;QACf,WAAW,EAAE,8CAA8C;QAC3D,KAAK,EAAE,GAAG,EAAE,CAAC,KAAK;QAClB,WAAW,EAAE,CAAC,KAAU,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU;KAC9C,CAAC,CAAA;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,sBAAsB,CAAI,QAAiD;IACzF,OAAO,KAAK,EACV,OAAY,EACZ,IAA0D,EAC1D,OAAwC,EACf,EAAE;QAC3B,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,cAAc,EAAE,EAAE;YAC1D,MAAM,UAAU,GAAG,cAAc,CAAC,UAAU,CAAA;YAC5C,MAAM,MAAM,GAAG,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;YAEvC,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,OAAO,eAAM,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,wBAAwB,UAAU,EAAE,CAAC,CAAC,CAAA;YACrE,CAAC;YAED,OAAO,MAAM,CAAC,gBAAgB,CAAC,cAAqB,CAAC,CAAC,IAAI,CACxD,eAAM,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;gBACpB,yDAAyD;gBACzD,IAAI,MAAM,KAAK,IAAI,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;oBAClD,OAAO,EAAE,GAAG,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,CAAA;gBAC9C,CAAC;gBACD,OAAO,MAAM,CAAA;YACf,CAAC,CAAC;YACF,4DAA4D;YAC5D,eAAM,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,EAAE,CACxB,eAAM,CAAC,QAAQ,CAAC,4BAA4B,UAAU,EAAE,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,eAAM,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CACvF,CACF,CAAA;QACH,CAAC,CAAC,CAAA;QAEF,OAAO,gBAAO,CAAC,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,eAAM,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,WAAW,EAAE,WAAW,EAAE,CAAC,CAAC,CAAA;IAC/F,CAAC,CAAA;AACH,CAAC;AAED;;GAEG;AACH,SAAgB,iBAAiB;IAC/B,OAAO,IAAI,wBAAiB,CAAC;QAC3B,IAAI,EAAE,UAAU;QAChB,WAAW,EAAE,sCAAsC;QACnD,MAAM,EAAE;YACN,GAAG,EAAE;gBACH,IAAI,EAAE,oBAAa;gBACnB,WAAW,EAAE,0CAA0C;aACxD;SACF;KACF,CAAC,CAAA;AACJ,CAAC;AAED;;GAEG;AACH,SAAgB,qBAAqB,CAAC,GAAW;IAC/C,OAAO,GAAG,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAA;AACxB,CAAC"}

package/dist/federated-builder.d.ts

@@ -0,0 +1,182 @@
+import { Effect, Pipeable } from "effect";
+import * as S from "effect/Schema";
+import { GraphQLSchemaBuilder, GraphQLSchema, type DirectiveApplication } from "@effect-gql/core";
+import type { EntityRegistration, FederatedSchemaConfig, FederatedSchemaResult } from "./types";
+/**
+ * Federation-aware schema builder that extends the core GraphQLSchemaBuilder
+ * with Apollo Federation 2.x support.
+ *
+ * @example
+ * ```typescript
+ * const schema = FederatedSchemaBuilder.empty
+ *   .pipe(
+ *     entity({
+ *       name: "User",
+ *       schema: UserSchema,
+ *       keys: [key({ fields: "id" })],
+ *       resolveReference: (ref) => UserService.findById(ref.id),
+ *     }),
+ *     query("me", {
+ *       type: UserSchema,
+ *       resolve: () => UserService.getCurrentUser(),
+ *     }),
+ *   )
+ *   .buildFederatedSchema()
+ * ```
+ */
+export declare class FederatedSchemaBuilder<R = never> implements Pipeable.Pipeable {
+    private readonly state;
+    private constructor();
+    /**
+     * Pipeable interface implementation
+     */
+    pipe<A>(this: A): A;
+    pipe<A, B>(this: A, ab: (a: A) => B): B;
+    pipe<A, B, C>(this: A, ab: (a: A) => B, bc: (b: B) => C): C;
+    pipe<A, B, C, D>(this: A, ab: (a: A) => B, bc: (b: B) => C, cd: (c: C) => D): D;
+    pipe<A, B, C, D, E>(this: A, ab: (a: A) => B, bc: (b: B) => C, cd: (c: C) => D, de: (d: D) => E): E;
+    pipe<A, B, C, D, E, F>(this: A, ab: (a: A) => B, bc: (b: B) => C, cd: (c: C) => D, de: (d: D) => E, ef: (e: E) => F): F;
+    /**
+     * Create an empty federated schema builder
+     */
+    static empty: FederatedSchemaBuilder<never>;
+    /**
+     * Create a builder with custom configuration
+     */
+    static create(config?: FederatedSchemaConfig): FederatedSchemaBuilder<never>;
+    /**
+     * Create a new builder with updated state
+     */
+    private with;
+    /**
+     * Get the underlying core builder for advanced usage
+     */
+    get coreBuilder(): GraphQLSchemaBuilder<R>;
+    /**
+     * Register an entity type with @key directive(s) and reference resolver.
+     *
+     * Entities are the core building block of Apollo Federation. They represent
+     * types that can be resolved across subgraph boundaries using their key fields.
+     *
+     * @example
+     * ```typescript
+     * builder.entity({
+     *   name: "User",
+     *   schema: UserSchema,
+     *   keys: [key({ fields: "id" })],
+     *   resolveReference: (ref) => UserService.findById(ref.id),
+     * })
+     * ```
+     */
+    entity<A, R2>(config: EntityRegistration<A, R2>): FederatedSchemaBuilder<R | R2>;
+    /**
+     * Add a query field
+     */
+    query<A, E, R2, Args = void>(name: string, config: {
+        type: S.Schema<A, any, any>;
+        args?: S.Schema<Args, any, any>;
+        description?: string;
+        directives?: readonly DirectiveApplication[];
+        resolve: (args: Args) => Effect.Effect<A, E, R2>;
+    }): FederatedSchemaBuilder<R | R2>;
+    /**
+     * Add a mutation field
+     */
+    mutation<A, E, R2, Args = void>(name: string, config: {
+        type: S.Schema<A, any, any>;
+        args?: S.Schema<Args, any, any>;
+        description?: string;
+        directives?: readonly DirectiveApplication[];
+        resolve: (args: Args) => Effect.Effect<A, E, R2>;
+    }): FederatedSchemaBuilder<R | R2>;
+    /**
+     * Add a subscription field
+     */
+    subscription<A, E, R2, Args = void>(name: string, config: {
+        type: S.Schema<A, any, any>;
+        args?: S.Schema<Args, any, any>;
+        description?: string;
+        directives?: readonly DirectiveApplication[];
+        subscribe: (args: Args) => Effect.Effect<import("effect").Stream.Stream<A, E, R2>, E, R2>;
+        resolve?: (value: A, args: Args) => Effect.Effect<A, E, R2>;
+    }): FederatedSchemaBuilder<R | R2>;
+    /**
+     * Register an object type (non-entity)
+     */
+    objectType<A, R2 = never>(config: {
+        name?: string;
+        schema: S.Schema<A, any, any>;
+        implements?: readonly string[];
+        directives?: readonly DirectiveApplication[];
+    }): FederatedSchemaBuilder<R | R2>;
+    /**
+     * Register an interface type
+     */
+    interfaceType(config: {
+        name?: string;
+        schema: S.Schema<any, any, any>;
+        resolveType?: (value: any) => string;
+        directives?: readonly DirectiveApplication[];
+    }): FederatedSchemaBuilder<R>;
+    /**
+     * Register an enum type
+     */
+    enumType(config: {
+        name: string;
+        values: readonly string[];
+        description?: string;
+        directives?: readonly DirectiveApplication[];
+    }): FederatedSchemaBuilder<R>;
+    /**
+     * Register a union type
+     */
+    unionType(config: {
+        name: string;
+        types: readonly string[];
+        resolveType?: (value: any) => string;
+        directives?: readonly DirectiveApplication[];
+    }): FederatedSchemaBuilder<R>;
+    /**
+     * Register an input type
+     */
+    inputType(config: {
+        name?: string;
+        schema: S.Schema<any, any, any>;
+        description?: string;
+        directives?: readonly DirectiveApplication[];
+    }): FederatedSchemaBuilder<R>;
+    /**
+     * Add a computed/relational field to an object type
+     */
+    field<Parent, A, E, R2, Args = void>(typeName: string, fieldName: string, config: {
+        type: S.Schema<A, any, any>;
+        args?: S.Schema<Args, any, any>;
+        description?: string;
+        directives?: readonly DirectiveApplication[];
+        resolve: (parent: Parent, args: Args) => Effect.Effect<A, E, R2>;
+    }): FederatedSchemaBuilder<R | R2>;
+    /**
+     * Build the federated GraphQL schema with _entities and _service queries.
+     *
+     * Returns both the executable schema and the Federation-compliant SDL.
+     */
+    buildFederatedSchema(): FederatedSchemaResult;
+    /**
+     * Check if the core builder has any query fields registered
+     */
+    private hasQueryFields;
+    /**
+     * Build a standard (non-federated) schema.
+     * Useful for testing or running without a gateway.
+     */
+    buildSchema(): GraphQLSchema;
+    /**
+     * Generate Federation-compliant SDL with directive annotations.
+     */
+    private generateFederatedSDL;
+    /**
+     * Annotate SDL types with their federation directives from extensions.
+     */
+    private annotateSDLWithDirectives;
+}
+//# sourceMappingURL=federated-builder.d.ts.map

package/dist/federated-builder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"federated-builder.d.ts","sourceRoot":"","sources":["../src/federated-builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAA;AACzC,OAAO,KAAK,CAAC,MAAM,eAAe,CAAA;AAClC,OAAO,EACL,oBAAoB,EACpB,aAAa,EAKb,KAAK,oBAAoB,EAC1B,MAAM,kBAAkB,CAAA;AAQzB,OAAO,KAAK,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAA;AAe/F;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,sBAAsB,CAAC,CAAC,GAAG,KAAK,CAAE,YAAW,QAAQ,CAAC,QAAQ;IACrD,OAAO,CAAC,QAAQ,CAAC,KAAK;IAA1C,OAAO;IAEP;;OAEG;IACH,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC;IACnB,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC;IACvC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC;IAC3D,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC;IAC/E,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAChB,IAAI,EAAE,CAAC,EACP,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EACf,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EACf,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EACf,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GACd,CAAC;IACJ,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EACnB,IAAI,EAAE,CAAC,EACP,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EACf,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EACf,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EACf,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EACf,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GACd,CAAC;IAKJ;;OAEG;IACH,MAAM,CAAC,KAAK,gCAIV;IAEF;;OAEG;IACH,MAAM,CAAC,MAAM,CAAC,MAAM,GAAE,qBAA0B;IAQhD;;OAEG;IACH,OAAO,CAAC,IAAI;IAOZ;;OAEG;IACH,IAAI,WAAW,IAAI,oBAAoB,CAAC,CAAC,CAAC,CAEzC;IAMD;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,kBAAkB,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,sBAAsB,CAAC,CAAC,GAAG,EAAE,CAAC;IAwChF;;OAEG;IACH,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,GAAG,IAAI,EACzB,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE;QACN,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,CAAA;QAC3B,IAAI,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,CAAA;QAC/B,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,UAAU,CAAC,EAAE,SAAS,oBAAoB,EAAE,CAAA;QAC5C,OAAO,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAA;KACjD,GACA,sBAAsB,CAAC,CAAC,GAAG,EAAE,CAAC;IAMjC;;OAEG;IACH,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,GAAG,IAAI,EAC5B,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE;QACN,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,CAAA;QAC3B,IAAI,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,CAAA;QAC/B,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,UAAU,CAAC,EAAE,SAAS,oBAAoB,EAAE,CAAA;QAC5C,OAAO,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAA;KACjD,GACA,sBAAsB,CAAC,CAAC,GAAG,EAAE,CAAC;IAMjC;;OAEG;IACH,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,GAAG,IAAI,EAChC,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE;QACN,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,CAAA;QAC3B,IAAI,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,CAAA;QAC/B,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,UAAU,CAAC,EAAE,SAAS,oBAAoB,EAAE,CAAA;QAC5C,SAAS,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,MAAM,CAAC,MAAM,CAAC,OAAO,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAA;QACzF,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAA;KAC5D,GACA,sBAAsB,CAAC,CAAC,GAAG,EAAE,CAAC;IAMjC;;OAEG;IACH,UAAU,CAAC,CAAC,EAAE,EAAE,GAAG,KAAK,EAAE,MAAM,EAAE;QAChC,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,CAAA;QAC7B,UAAU,CAAC,EAAE,SAAS,MAAM,EAAE,CAAA;QAC9B,UAAU,CAAC,EAAE,SAAS,oBAAoB,EAAE,CAAA;KAC7C,GAAG,sBAAsB,CAAC,CAAC,GAAG,EAAE,CAAC;IAMlC;;OAEG;IACH,aAAa,CAAC,MAAM,EAAE;QACpB,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAA;QAC/B,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,MAAM,CAAA;QACpC,UAAU,CAAC,EAAE,SAAS,oBAAoB,EAAE,CAAA;KAC7C,GAAG,sBAAsB,CAAC,CAAC,CAAC;IAM7B;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE;QACf,IAAI,EAAE,MAAM,CAAA;QACZ,MAAM,EAAE,SAAS,MAAM,EAAE,CAAA;QACzB,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,UAAU,CAAC,EAAE,SAAS,oBAAoB,EAAE,CAAA;KAC7C,GAAG,sBAAsB,CAAC,CAAC,CAAC;IAM7B;;OAEG;IACH,SAAS,CAAC,MAAM,EAAE;QAChB,IAAI,EAAE,MAAM,CAAA;QACZ,KAAK,EAAE,SAAS,MAAM,EAAE,CAAA;QACxB,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,MAAM,CAAA;QACpC,UAAU,CAAC,EAAE,SAAS,oBAAoB,EAAE,CAAA;KAC7C,GAAG,sBAAsB,CAAC,CAAC,CAAC;IAM7B;;OAEG;IACH,SAAS,CAAC,MAAM,EAAE;QAChB,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAA;QAC/B,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,UAAU,CAAC,EAAE,SAAS,oBAAoB,EAAE,CAAA;KAC7C,GAAG,sBAAsB,CAAC,CAAC,CAAC;IAM7B;;OAEG;IACH,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,GAAG,IAAI,EACjC,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE;QACN,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,CAAA;QAC3B,IAAI,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,CAAA;QAC/B,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,UAAU,CAAC,EAAE,SAAS,oBAAoB,EAAE,CAAA;QAC5C,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAA;KACjE,GACA,sBAAsB,CAAC,CAAC,GAAG,EAAE,CAAC;IAcjC;;;;OAIG;IACH,oBAAoB,IAAI,qBAAqB;IAyH7C;;OAEG;IACH,OAAO,CAAC,cAAc;IAYtB;;;OAGG;IACH,WAAW,IAAI,aAAa;IAQ5B;;OAEG;IACH,OAAO,CAAC,oBAAoB;IAuB5B;;OAEG;IACH,OAAO,CAAC,yBAAyB;CAyDlC"}