@effect-gql/core 1.0.0 → 1.1.1

package/README.md

@@ -11,7 +11,33 @@ A GraphQL framework for Effect-TS that brings full type safety, composability, a
 - **Immutable Builder** - Fluent, pipe-able API for composing schemas from reusable parts
 - **Service Integration** - Use Effect's Layer system for dependency injection
 
-## Installation
+## Getting Started
+
+The easiest way to get started is with the CLI:
+
+```bash
+# Create a new project
+npx @effect-gql/cli create my-api --server-type node
+
+# Start the dev server
+cd my-api
+npm run dev
+```
+
+Your GraphQL server will be running at http://localhost:4000/graphql with a GraphiQL playground at http://localhost:4000/graphiql.
+
+### Server Types
+
+The CLI supports multiple server runtimes:
+
+| Type | Command | Best For |
+|------|---------|----------|
+| Node.js | `--server-type node` | General Node.js deployments |
+| Bun | `--server-type bun` | Bun runtime with native WebSocket support |
+| Express | `--server-type express` | Integrating into existing Express apps |
+| Web | `--server-type web` | Cloudflare Workers, Deno, edge runtimes |
+
+## Manual Installation
 
 ```bash
 npm install @effect-gql/core effect graphql

package/builder/index.cjs

@@ -800,7 +800,14 @@ var GraphQLSchemaBuilder = class _GraphQLSchemaBuilder {
    * Register an object type from a schema
    */
   objectType(config) {
-    const { schema, implements: implementsInterfaces, directives, cacheControl, fields } = config;
+    const {
+      schema,
+      description,
+      implements: implementsInterfaces,
+      directives,
+      cacheControl,
+      fields
+    } = config;
     const name = config.name ?? getSchemaName(schema);
     if (!name) {
       throw new Error(
@@ -808,7 +815,14 @@ var GraphQLSchemaBuilder = class _GraphQLSchemaBuilder {
       );
     }
     const newTypes = new Map(this.state.types);
-    newTypes.set(name, { name, schema, implements: implementsInterfaces, directives, cacheControl });
+    newTypes.set(name, {
+      name,
+      schema,
+      description,
+      implements: implementsInterfaces,
+      directives,
+      cacheControl
+    });
     let newObjectFields = this.state.objectFields;
     if (fields) {
       newObjectFields = new Map(this.state.objectFields);
@@ -1177,6 +1191,7 @@ var GraphQLSchemaBuilder = class _GraphQLSchemaBuilder {
       const implementedInterfaces = typeReg.implements?.map((name) => interfaceRegistry.get(name)).filter(Boolean) ?? [];
       const graphqlType = new graphql.GraphQLObjectType({
         name: typeName,
+        description: typeReg.description,
         fields: () => {
           const baseFields = schemaToFields(typeReg.schema, sharedCtx);
           const additionalFields = this.state.objectFields.get(typeName);