@baeta/federation 0.0.0 → 2.0.0-next.13

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @baeta/federation
+
+## 2.0.0-next.13
+
+### Patch Changes
+
+- [#389](https://github.com/andreisergiu98/baeta/pull/389) [`3e7a4d7`](https://github.com/andreisergiu98/baeta/commit/3e7a4d71a59543b8a506938f788aec8b5d907776) Thanks [@andreisergiu98](https://github.com/andreisergiu98)! - Add support for Apollo Federation

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Pampu Andrei
+
+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/README.md

@@ -0,0 +1,164 @@
+<p align="center">
+  <img src="https://raw.githubusercontent.com/andreisergiu98/baeta/refs/heads/main/website/static/img/logo-baeta.svg" alt="Baeta Logo" width="150"/>
+</p>
+
+<div align="center">
+  <h1>Baeta</h1>
+  <a href="https://www.npmjs.com/package/@baeta/cli"><img src="https://img.shields.io/npm/v/@baeta/cli.svg?style=flat" /></a>
+   <a href="https://github.com/andreisergiu98/baeta/actions/workflows/checks.yml"><img src="https://img.shields.io/github/actions/workflow/status/andreisergiu98/baeta/checks.yml" /></a>
+  <a href="https://github.com/andreisergiu98/baeta/pulls"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" /></a>
+  <a href="https://github.com/andreisergiu98/baeta/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue" /></a>
+  <br />
+  <br />
+  <a href="https://baeta.io/docs/getting-started/installation">Getting Started</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://www.baeta.io/">Website</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://baeta.io/docs/intro">Docs</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://github.com/andreisergiu98/baeta/tree/main/examples">Examples</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://discord.gg/BHFXHvyj">Discord</a>
+  <br />
+  <hr />
+</div>
+
+# What is Baeta?
+
+Building GraphQL APIs shouldn't be complicated. **Baeta** is a modern, modular, open-source GraphQL framework designed with flexibility in mind. It follows a granular approach where you only add what you need, helping developers focus on what matters most - creating powerful, scalable APIs without the boilerplate.
+
+### Key Features
+
+- **Modular Architecture**: Organize your API into manageable modules
+- **Schema-First Development**: Define your API contract upfront
+- **Type Safety**: Automatic code generation for type-safe development
+- **Middleware & Directives**: Easy integration of custom behaviors
+- **High Performance**: Built for scalability and efficiency
+
+#### And optional extensions and plugins
+
+- **@baeta/extension-auth**: Add powerful scope-based authorization
+- **@baeta/extension-cache**: Implement automatic caching with simple update patterns
+- ... and more!
+
+## Why use Baeta?
+
+Baeta makes it easy to build better GraphQL APIs while staying flexible. Here's how:
+
+**Granular and Progressive:** Start small and add features as you need them. Whether you're building a simple API or a complex system, Baeta scales with your needs.
+
+**Modular architecture:** Baeta's modular design allows you to organize your GraphQL API into smaller, more manageable modules that can be added or removed as needed. This makes it easier to maintain and scale your API over time.
+
+**Schema-first approach:** With Baeta, you define your schema first, and then logic and resolvers. This approach ensures a consistent and well-defined API for your clients and reduces boilerplate code.
+
+## How it Works
+
+#### 1. Define your schema
+
+```graphql
+type User {
+  id: ID!
+  name: String!
+  email: String!
+  age: Int
+}
+
+input UserWhereUnique {
+  id: ID
+  email: String
+}
+
+type Query {
+  user(where: UserWhereUnique!): User!
+  users: [User!]!
+}
+```
+
+#### 2. Implement your resolvers
+
+```typescript
+import { UserModule } from "./typedef.ts";
+
+const { Query } = UserModule;
+
+const userQuery = Query.user.resolve(({ args }) => {
+  return dataSource.user.find(args.where);
+});
+
+const usersQuery = Query.users.resolve(() => {
+  return dataSource.user.findMany();
+});
+
+Query.$fields({
+  user: userQuery,
+  users: usersQuery,
+});
+```
+
+#### 3. Add authorization
+
+```typescript
+import { UserModule } from "./typedef.ts";
+
+const { Query } = UserModule;
+
+const userQuery = Query.user
+  .$auth({
+    $or: {
+      isPublic: true,
+      isLoggedIn: true,
+    },
+  })
+  .resolve(async ({ args }) => {
+    // ...
+  });
+```
+
+#### 4. Add caching
+
+```typescript
+const { Query, Mutation, User } = UserModule;
+
+export const userCache = User.$createCache();
+
+const userQuery = Query.user
+  .$auth({
+    // ...
+  })
+  .$useCache(userCache)
+  .resolve(async ({ args }) => {
+    // ...
+  });
+
+const updateUserMutation = Mutation.updateUser
+  .$use(async (next) => {
+    const user = await next();
+    await userCache.save(user);
+    return user;
+  })
+  .resolve(async ({ args }) => {
+    // ...
+  });
+```
+
+## Compatibility
+
+Baeta is compatible with all GraphQL servers, which makes it easy to integrate with your existing stack. It works seamlessly with popular GraphQL server libraries such as **Graphql Yoga** and **Apollo Server**, as well as other popular tools like **Prisma**, **Drizzle** and **Kysely**.
+
+Baeta's development tools are built for Node.js, but the runtime code is environment-agnostic. This means your Baeta applications can run anywhere JavaScript runs, including:
+
+- Deno
+- Cloudflare Workers
+- AWS Lambda
+- Vercel Edge Functions
+- Bun
+- Node.js
+- Any other JavaScript runtime
+
+## Credits
+
+Baeta was inspired by several amazing projects and people in the GraphQL ecosystem. Check out our [Credits page](https://baeta.io/docs/credits) to learn more about the individuals and projects that influenced Baeta's development.
+
+## License
+
+Baeta is licensed under the [MIT License](./LICENSE).

package/dist/index.d.ts

@@ -0,0 +1,14 @@
+import * as _$graphql from "graphql";
+
+//#region lib/create-scalar.d.ts
+declare function createFederationScalar<T extends 'string' | 'json'>(type: T, name: string, description?: string): _$graphql.GraphQLScalarType<any, unknown>;
+//#endregion
+//#region lib/resolve-entities.d.ts
+type EntityRepresentation<T extends string, R extends Record<string, unknown>> = {
+  __typename: T;
+} & R;
+type EntityHandlerMap<T extends string, Ctx, Info> = Record<T, (representation: EntityRepresentation<T, any>, ctx: Ctx, info: Info) => any>;
+declare function resolveEntities<T extends string, R extends Record<string, unknown>, Ctx, Info>(representations: Array<EntityRepresentation<T, R>>, entityHandlerMap: EntityHandlerMap<T, Ctx, Info>, ctx: Ctx, info: Info): Promise<any[]>;
+//#endregion
+export { createFederationScalar, resolveEntities };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,81 @@
+import { GraphQLError, GraphQLScalarType, Kind, print } from "graphql";
+//#region lib/scalar-json.ts
+/**
+* Based on graphql-scalars JSON scalar implementation
+* Sources:
+*  - https://github.com/graphql-hive/graphql-scalars/blob/master/src/scalars/json/JSON.ts
+*  - https://github.com/graphql-hive/graphql-scalars/blob/master/src/scalars/json/utils.ts
+* Copyright (c) 2020-present The Guild
+* Modified by Baeta developers
+*/
+const specifiedByURL = "http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf";
+function createJSONScalar(name, description) {
+	return new GraphQLScalarType({
+		name,
+		description,
+		serialize: identity,
+		parseValue: identity,
+		parseLiteral,
+		specifiedByURL
+	});
+}
+function identity(value) {
+	return value;
+}
+function parseObject(ast, variables) {
+	if (ast.kind !== Kind.OBJECT) throw new GraphQLError(`JSONObject cannot represent non-object value: ${print(ast)}`, { nodes: ast });
+	return Object.fromEntries(ast.fields.map((field) => [field.name.value, parseLiteral(field.value, variables)]));
+}
+function parseLiteral(ast, variables) {
+	switch (ast.kind) {
+		case Kind.STRING:
+		case Kind.BOOLEAN: return ast.value;
+		case Kind.INT:
+		case Kind.FLOAT: return Number.parseFloat(ast.value);
+		case Kind.OBJECT: return parseObject(ast, variables);
+		case Kind.LIST: return ast.values.map((n) => parseLiteral(n, variables));
+		case Kind.NULL: return null;
+		case Kind.VARIABLE: {
+			const name = ast.name.value;
+			return variables ? variables[name] : void 0;
+		}
+	}
+}
+//#endregion
+//#region lib/scalar-string.ts
+function createStringScalar(name, description) {
+	return new GraphQLScalarType({
+		name,
+		description,
+		serialize: validateValue,
+		parseValue: validateValue,
+		parseLiteral: (ast) => {
+			if (ast.kind !== Kind.STRING) throw new GraphQLError(`Can only parse strings but got a: ${ast.kind}`, { nodes: ast });
+			return validateValue(ast.value, ast);
+		}
+	});
+}
+function validateValue(value, ast) {
+	if (typeof value !== "string") throw new GraphQLError(`Value is not a string: ${value}`, { nodes: ast });
+	return value;
+}
+//#endregion
+//#region lib/create-scalar.ts
+function createFederationScalar(type, name, description) {
+	if (type === "string") return createStringScalar(name, description);
+	if (type === "json") return createJSONScalar(name, description);
+	return type;
+}
+//#endregion
+//#region lib/resolve-entities.ts
+async function resolveEntities(representations, entityHandlerMap, ctx, info) {
+	const promises = representations.map(async (representation) => {
+		const handler = entityHandlerMap[representation.__typename];
+		return await handler(representation, ctx, info);
+	});
+	return await Promise.all(promises);
+}
+//#endregion
+export { createFederationScalar, resolveEntities };
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../lib/scalar-json.ts","../lib/scalar-string.ts","../lib/create-scalar.ts","../lib/resolve-entities.ts"],"sourcesContent":["/**\n * Based on graphql-scalars JSON scalar implementation\n * Sources:\n *  - https://github.com/graphql-hive/graphql-scalars/blob/master/src/scalars/json/JSON.ts\n *  - https://github.com/graphql-hive/graphql-scalars/blob/master/src/scalars/json/utils.ts\n * Copyright (c) 2020-present The Guild\n * Modified by Baeta developers\n */\n\nimport { GraphQLError, GraphQLScalarType, Kind, print, type ValueNode } from 'graphql';\n\nconst specifiedByURL = 'http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf';\n\nexport function createJSONScalar(name: string, description?: string) {\n\treturn new GraphQLScalarType({\n\t\tname,\n\t\tdescription,\n\t\tserialize: identity,\n\t\tparseValue: identity,\n\t\tparseLiteral,\n\t\tspecifiedByURL,\n\t});\n}\n\nfunction identity<T>(value: T): T {\n\treturn value;\n}\n\nfunction parseObject(ast: ValueNode, variables: any): any {\n\tif (ast.kind !== Kind.OBJECT) {\n\t\tthrow new GraphQLError(`JSONObject cannot represent non-object value: ${print(ast)}`, {\n\t\t\tnodes: ast,\n\t\t});\n\t}\n\treturn Object.fromEntries(\n\t\tast.fields.map((field) => [field.name.value, parseLiteral(field.value, variables)]),\n\t);\n}\n\nfunction parseLiteral(ast: ValueNode, variables: any): any {\n\tswitch (ast.kind) {\n\t\tcase Kind.STRING:\n\t\tcase Kind.BOOLEAN:\n\t\t\treturn ast.value;\n\t\tcase Kind.INT:\n\t\tcase Kind.FLOAT:\n\t\t\treturn Number.parseFloat(ast.value);\n\t\tcase Kind.OBJECT:\n\t\t\treturn parseObject(ast, variables);\n\t\tcase Kind.LIST:\n\t\t\treturn ast.values.map((n) => parseLiteral(n, variables));\n\t\tcase Kind.NULL:\n\t\t\treturn null;\n\t\tcase Kind.VARIABLE: {\n\t\t\tconst name = ast.name.value;\n\t\t\treturn variables ? variables[name] : undefined;\n\t\t}\n\t}\n}\n","import { GraphQLError, GraphQLScalarType, Kind, type ValueNode } from 'graphql';\n\nexport function createStringScalar(name: string, description?: string) {\n\treturn new GraphQLScalarType<string, string>({\n\t\tname,\n\t\tdescription,\n\t\tserialize: validateValue,\n\t\tparseValue: validateValue,\n\t\tparseLiteral: (ast: ValueNode) => {\n\t\t\tif (ast.kind !== Kind.STRING) {\n\t\t\t\tthrow new GraphQLError(`Can only parse strings but got a: ${ast.kind}`, {\n\t\t\t\t\tnodes: ast,\n\t\t\t\t});\n\t\t\t}\n\t\t\treturn validateValue(ast.value, ast);\n\t\t},\n\t});\n}\n\nfunction validateValue(value: unknown, ast?: ValueNode): string {\n\tif (typeof value !== 'string') {\n\t\tthrow new GraphQLError(`Value is not a string: ${value}`, {\n\t\t\tnodes: ast,\n\t\t});\n\t}\n\treturn value;\n}\n","import { createJSONScalar } from './scalar-json.ts';\nimport { createStringScalar } from './scalar-string.ts';\n\nexport function createFederationScalar<T extends 'string' | 'json'>(\n\ttype: T,\n\tname: string,\n\tdescription?: string,\n) {\n\tif (type === 'string') {\n\t\treturn createStringScalar(name, description);\n\t}\n\tif (type === 'json') {\n\t\treturn createJSONScalar(name, description);\n\t}\n\treturn type satisfies never;\n}\n","type EntityRepresentation<T extends string, R extends Record<string, unknown>> = {\n\t__typename: T;\n} & R;\n\ntype EntityHandlerMap<T extends string, Ctx, Info> = Record<\n\tT,\n\t(representation: EntityRepresentation<T, any>, ctx: Ctx, info: Info) => any\n>;\n\nexport async function resolveEntities<\n\tT extends string,\n\tR extends Record<string, unknown>,\n\tCtx,\n\tInfo,\n>(\n\trepresentations: Array<EntityRepresentation<T, R>>,\n\tentityHandlerMap: EntityHandlerMap<T, Ctx, Info>,\n\tctx: Ctx,\n\tinfo: Info,\n) {\n\tconst promises = representations.map(async (representation) => {\n\t\tconst handler = entityHandlerMap[representation.__typename];\n\t\treturn await handler(representation, ctx, info);\n\t});\n\treturn await Promise.all(promises);\n}\n"],"mappings":";;;;;;;;;;AAWA,MAAM,iBAAiB;AAEvB,SAAgB,iBAAiB,MAAc,aAAsB;AACpE,QAAO,IAAI,kBAAkB;EAC5B;EACA;EACA,WAAW;EACX,YAAY;EACZ;EACA;EACA,CAAC;;AAGH,SAAS,SAAY,OAAa;AACjC,QAAO;;AAGR,SAAS,YAAY,KAAgB,WAAqB;AACzD,KAAI,IAAI,SAAS,KAAK,OACrB,OAAM,IAAI,aAAa,iDAAiD,MAAM,IAAI,IAAI,EACrF,OAAO,KACP,CAAC;AAEH,QAAO,OAAO,YACb,IAAI,OAAO,KAAK,UAAU,CAAC,MAAM,KAAK,OAAO,aAAa,MAAM,OAAO,UAAU,CAAC,CAAC,CACnF;;AAGF,SAAS,aAAa,KAAgB,WAAqB;AAC1D,SAAQ,IAAI,MAAZ;EACC,KAAK,KAAK;EACV,KAAK,KAAK,QACT,QAAO,IAAI;EACZ,KAAK,KAAK;EACV,KAAK,KAAK,MACT,QAAO,OAAO,WAAW,IAAI,MAAM;EACpC,KAAK,KAAK,OACT,QAAO,YAAY,KAAK,UAAU;EACnC,KAAK,KAAK,KACT,QAAO,IAAI,OAAO,KAAK,MAAM,aAAa,GAAG,UAAU,CAAC;EACzD,KAAK,KAAK,KACT,QAAO;EACR,KAAK,KAAK,UAAU;GACnB,MAAM,OAAO,IAAI,KAAK;AACtB,UAAO,YAAY,UAAU,QAAQ,KAAA;;;;;;ACrDxC,SAAgB,mBAAmB,MAAc,aAAsB;AACtE,QAAO,IAAI,kBAAkC;EAC5C;EACA;EACA,WAAW;EACX,YAAY;EACZ,eAAe,QAAmB;AACjC,OAAI,IAAI,SAAS,KAAK,OACrB,OAAM,IAAI,aAAa,qCAAqC,IAAI,QAAQ,EACvE,OAAO,KACP,CAAC;AAEH,UAAO,cAAc,IAAI,OAAO,IAAI;;EAErC,CAAC;;AAGH,SAAS,cAAc,OAAgB,KAAyB;AAC/D,KAAI,OAAO,UAAU,SACpB,OAAM,IAAI,aAAa,0BAA0B,SAAS,EACzD,OAAO,KACP,CAAC;AAEH,QAAO;;;;ACtBR,SAAgB,uBACf,MACA,MACA,aACC;AACD,KAAI,SAAS,SACZ,QAAO,mBAAmB,MAAM,YAAY;AAE7C,KAAI,SAAS,OACZ,QAAO,iBAAiB,MAAM,YAAY;AAE3C,QAAO;;;;ACLR,eAAsB,gBAMrB,iBACA,kBACA,KACA,MACC;CACD,MAAM,WAAW,gBAAgB,IAAI,OAAO,mBAAmB;EAC9D,MAAM,UAAU,iBAAiB,eAAe;AAChD,SAAO,MAAM,QAAQ,gBAAgB,KAAK,KAAK;GAC9C;AACF,QAAO,MAAM,QAAQ,IAAI,SAAS"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@baeta/federation",
-  "version": "0.0.0",
+  "version": "2.0.0-next.13",
   "keywords": [
     "baeta",
     "graphql",
@@ -25,10 +25,64 @@
     "url": "https://github.com/andreisergiu98"
   },
   "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "types": "dist/index.d.ts",
   "files": [
+    "dist",
     "package.json"
   ],
+  "scripts": {
+    "build": "builder build",
+    "check:deps": "builder check-deps",
+    "prepack": "builder prepare",
+    "postpack": "builder prepare --restore",
+    "test": "builder test",
+    "test:circular": "builder test-circular",
+    "types": "tsc --noEmit"
+  },
+  "ava": {
+    "extensions": [
+      "ts"
+    ]
+  },
+  "devDependencies": {
+    "@baeta/builder": "^0.0.0",
+    "@baeta/testing": "^0.0.0",
+    "@baeta/tsconfig": "^0.0.0",
+    "graphql": "^16.6.0",
+    "typescript": "^6.0.0"
+  },
+  "peerDependencies": {
+    "graphql": "^16.6.0"
+  },
+  "engines": {
+    "node": ">=22.20.0"
+  },
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "exports": {
+      ".": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    }
+  },
+  "typedocOptions": {
+    "entryPoints": [
+      "./index.ts"
+    ],
+    "readme": "none",
+    "tsconfig": "./tsconfig.json",
+    "sort": [
+      "kind",
+      "instance-first",
+      "required-first",
+      "alphabetical-ignoring-documents"
+    ]
   }
-}
+}