@effect-gql/core 1.0.0 → 1.1.1

package/index.cjs

@@ -6,7 +6,6 @@ var S2 = require('effect/Schema');
 var AST = require('effect/SchemaAST');
 var DataLoader = require('dataloader');
 var platform = require('@effect/platform');
-var graphqlWs = require('graphql-ws');
 
 function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
 
@@ -837,7 +836,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(
@@ -845,7 +851,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);
@@ -1214,6 +1227,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);
@@ -1489,7 +1503,8 @@ var LoaderRegistry = class {
       this.Service,
       effect.Effect.gen(function* () {
         const instances = {};
-        for (const [name, def] of Object.entries(self.definitions)) {
+        for (const name of Object.keys(self.definitions)) {
+          const def = self.definitions[name];
           instances[name] = yield* createDataLoader(def);
         }
         return instances;
@@ -1509,6 +1524,9 @@ var LoaderRegistry = class {
   /**
    * Load a single value by key.
    * This is the most common operation in resolvers.
+   *
+   * @internal The internal cast is safe because LoaderInstances<Defs> guarantees
+   * that loaders[name] is a DataLoader with the correct key/value types.
    */
   load(name, key) {
     const self = this;
@@ -1521,6 +1539,9 @@ var LoaderRegistry = class {
   /**
    * Load multiple values by keys.
    * All keys are batched into a single request.
+   *
+   * @internal The internal cast is safe because LoaderInstances<Defs> guarantees
+   * that loaders[name] is a DataLoader with the correct key/value types.
    */
   loadMany(name, keys) {
     const self = this;
@@ -1537,35 +1558,39 @@ var LoaderRegistry = class {
     });
   }
 };
+function createSingleDataLoader(def, context) {
+  return new DataLoader__default.default(async (keys) => {
+    const items = await effect.Effect.runPromise(def.batch(keys).pipe(effect.Effect.provide(context)));
+    return keys.map((key) => {
+      const item = items.find((i) => def.key(i) === key);
+      if (!item) return new Error(`Not found: ${key}`);
+      return item;
+    });
+  });
+}
+function createGroupedDataLoader(def, context) {
+  return new DataLoader__default.default(async (keys) => {
+    const items = await effect.Effect.runPromise(def.batch(keys).pipe(effect.Effect.provide(context)));
+    const map = /* @__PURE__ */ new Map();
+    for (const item of items) {
+      const key = def.groupBy(item);
+      let arr = map.get(key);
+      if (!arr) {
+        arr = [];
+        map.set(key, arr);
+      }
+      arr.push(item);
+    }
+    return keys.map((key) => map.get(key) ?? []);
+  });
+}
 function createDataLoader(def) {
   return effect.Effect.gen(function* () {
     const context = yield* effect.Effect.context();
     if (def._tag === "single") {
-      const loader = new DataLoader__default.default(async (keys) => {
-        const items = await effect.Effect.runPromise(def.batch(keys).pipe(effect.Effect.provide(context)));
-        return keys.map((key) => {
-          const item = items.find((i) => def.key(i) === key);
-          if (!item) return new Error(`Not found: ${key}`);
-          return item;
-        });
-      });
-      return loader;
+      return createSingleDataLoader(def, context);
     } else {
-      const loader = new DataLoader__default.default(async (keys) => {
-        const items = await effect.Effect.runPromise(def.batch(keys).pipe(effect.Effect.provide(context)));
-        const map = /* @__PURE__ */ new Map();
-        for (const item of items) {
-          const key = def.groupBy(item);
-          let arr = map.get(key);
-          if (!arr) {
-            arr = [];
-            map.set(key, arr);
-          }
-          arr.push(item);
-        }
-        return keys.map((key) => map.get(key) ?? []);
-      });
-      return loader;
+      return createGroupedDataLoader(def, context);
     }
   });
 }
@@ -1789,7 +1814,7 @@ var GraphQLRouterConfigFromEnv = effect.Config.all({
 );
 
 // src/server/graphiql.ts
-var graphiqlHtml = (endpoint) => `<!DOCTYPE html>
+var graphiqlHtml = (endpoint, subscriptionEndpoint) => `<!DOCTYPE html>
 <html lang="en">
   <head>
     <meta charset="utf-8" />
@@ -1817,6 +1842,7 @@ var graphiqlHtml = (endpoint) => `<!DOCTYPE html>
     <script>
       const fetcher = GraphiQL.createFetcher({
         url: ${JSON.stringify(endpoint)},
+        subscriptionUrl: ${JSON.stringify(subscriptionEndpoint ?? endpoint)},
       });
       ReactDOM.createRoot(document.getElementById('graphiql')).render(
         React.createElement(GraphiQL, { fetcher })
@@ -2492,19 +2518,32 @@ var defaultErrorHandler = (cause) => (process.env.NODE_ENV !== "production" ? ef
     ).pipe(effect.Effect.orDie)
   )
 );
-var parseGraphQLQuery = (query2, extensionsService) => effect.Effect.gen(function* () {
+var GraphQLRequestBodySchema = effect.Schema.Struct({
+  query: effect.Schema.String,
+  variables: effect.Schema.optionalWith(effect.Schema.Record({ key: effect.Schema.String, value: effect.Schema.Unknown }), {
+    as: "Option"
+  }),
+  operationName: effect.Schema.optionalWith(effect.Schema.String, { as: "Option" })
+});
+var decodeRequestBody = platform.HttpIncomingMessage.schemaBodyJson(GraphQLRequestBodySchema);
+var parseGraphQLQuery = (query2, extensionsService) => {
   try {
     const document = graphql.parse(query2);
-    return { ok: true, document };
+    return effect.Effect.succeed({ ok: true, document });
   } catch (parseError) {
-    const extensionData = yield* extensionsService.get();
-    const response = yield* platform.HttpServerResponse.json({
-      errors: [{ message: String(parseError) }],
-      extensions: Object.keys(extensionData).length > 0 ? extensionData : void 0
-    }).pipe(effect.Effect.orDie);
-    return { ok: false, response };
+    return extensionsService.get().pipe(
+      effect.Effect.flatMap(
+        (extensionData) => platform.HttpServerResponse.json({
+          errors: [{ message: String(parseError) }],
+          extensions: Object.keys(extensionData).length > 0 ? extensionData : void 0
+        }).pipe(
+          effect.Effect.orDie,
+          effect.Effect.map((response) => ({ ok: false, response }))
+        )
+      )
+    );
   }
-});
+};
 var runComplexityValidation = (body, schema, fieldComplexities, complexityConfig) => {
   if (!complexityConfig) {
     return effect.Effect.void;
@@ -2524,8 +2563,9 @@ var runComplexityValidation = (body, schema, fieldComplexities, complexityConfig
     )
   );
 };
-var executeGraphQLQuery = (schema, document, variables, operationName, runtime) => effect.Effect.gen(function* () {
-  const executeResult = yield* effect.Effect.try({
+var isPromiseLike = (value) => value !== null && typeof value === "object" && "then" in value && typeof value.then === "function";
+var executeGraphQLQuery = (schema, document, variables, operationName, runtime) => {
+  const tryExecute = effect.Effect.try({
     try: () => graphql.execute({
       schema,
       document,
@@ -2535,33 +2575,34 @@ var executeGraphQLQuery = (schema, document, variables, operationName, runtime)
     }),
     catch: (error) => new Error(String(error))
   });
-  if (executeResult && typeof executeResult === "object" && "then" in executeResult) {
-    return yield* effect.Effect.promise(
-      () => executeResult
-    );
-  }
-  return executeResult;
-});
-var computeCacheControlHeader = (document, operationName, schema, cacheHints, cacheControlConfig) => effect.Effect.gen(function* () {
+  return tryExecute.pipe(
+    effect.Effect.flatMap((executeResult) => {
+      if (isPromiseLike(executeResult)) {
+        return effect.Effect.promise(() => executeResult);
+      }
+      return effect.Effect.succeed(executeResult);
+    })
+  );
+};
+var computeCacheControlHeader = (document, operationName, schema, cacheHints, cacheControlConfig) => {
   if (cacheControlConfig?.enabled === false || cacheControlConfig?.calculateHttpHeaders === false) {
-    return void 0;
+    return effect.Effect.succeed(void 0);
   }
   const operations = document.definitions.filter(
     (d) => d.kind === graphql.Kind.OPERATION_DEFINITION
   );
   const operation = operationName ? operations.find((o) => o.name?.value === operationName) : operations[0];
   if (!operation || operation.operation === "mutation") {
-    return void 0;
+    return effect.Effect.succeed(void 0);
   }
-  const cachePolicy = yield* computeCachePolicy({
+  return computeCachePolicy({
     document,
     operation,
     schema,
     cacheHints,
     config: cacheControlConfig ?? {}
-  });
-  return toCacheControlHeader(cachePolicy);
-});
+  }).pipe(effect.Effect.map(toCacheControlHeader));
+};
 var buildGraphQLResponse = (result, extensionData, cacheControlHeader) => {
   const finalResult = Object.keys(extensionData).length > 0 ? {
     ...result,
@@ -2599,7 +2640,12 @@ var makeGraphQLRouter = (schema, layer, options = {}) => {
     const extensionsService = yield* makeExtensionsService();
     const runtime = yield* effect.Effect.runtime();
     const request = yield* platform.HttpServerRequest.HttpServerRequest;
-    const body = yield* request.json;
+    const parsedBody = yield* decodeRequestBody(request);
+    const body = {
+      query: parsedBody.query,
+      variables: parsedBody.variables._tag === "Some" ? parsedBody.variables.value : void 0,
+      operationName: parsedBody.operationName._tag === "Some" ? parsedBody.operationName.value : void 0
+    };
     const parseResult = yield* parseGraphQLQuery(body.query, extensionsService);
     if (!parseResult.ok) {
       return parseResult.response;
@@ -2608,7 +2654,7 @@ var makeGraphQLRouter = (schema, layer, options = {}) => {
     yield* runParseHooks(extensions, body.query, document).pipe(
       effect.Effect.provideService(ExtensionsService, extensionsService)
     );
-    const validationRules = resolvedConfig.introspection ? void 0 : [...graphql.specifiedRules, graphql.NoSchemaIntrospectionCustomRule];
+    const validationRules = resolvedConfig.introspection ? void 0 : graphql.specifiedRules.concat(graphql.NoSchemaIntrospectionCustomRule);
     const validationErrors = graphql.validate(schema, document, validationRules);
     yield* runValidateHooks(extensions, document, validationErrors).pipe(
       effect.Effect.provideService(ExtensionsService, extensionsService)
@@ -2669,9 +2715,12 @@ var makeGraphQLRouter = (schema, layer, options = {}) => {
     platform.HttpRouter.post(resolvedConfig.path, graphqlHandler)
   );
   if (resolvedConfig.graphiql) {
-    const { path, endpoint } = resolvedConfig.graphiql;
+    const { path, endpoint, subscriptionEndpoint } = resolvedConfig.graphiql;
     router = router.pipe(
-      platform.HttpRouter.get(path, platform.HttpServerResponse.html(graphiqlHtml(endpoint)))
+      platform.HttpRouter.get(
+        path,
+        platform.HttpServerResponse.html(graphiqlHtml(endpoint, subscriptionEndpoint))
+      )
     );
   }
   return router;
@@ -2846,27 +2895,45 @@ var runConnectionLifecycle = (socket, wsServer, extra) => effect.Effect.gen(func
   effect.Effect.catchAllCause(() => effect.Effect.void),
   effect.Effect.scoped
 );
+var importGraphqlWs = effect.Effect.tryPromise({
+  try: () => import('graphql-ws'),
+  catch: () => new Error(
+    "graphql-ws is required for WebSocket subscriptions. Install it with: npm install graphql-ws"
+  )
+});
 var makeGraphQLWSHandler = (schema, layer, options) => {
   const complexityConfig = options?.complexity;
   const fieldComplexities = options?.fieldComplexities ?? /* @__PURE__ */ new Map();
-  const serverOptions = {
-    schema,
-    context: async (ctx) => {
-      const extra = ctx.extra;
-      return {
-        runtime: extra.runtime,
-        ...extra.connectionParams
-      };
-    },
-    subscribe: async (args) => graphql.subscribe(args),
-    onConnect: makeOnConnectHandler(options),
-    onDisconnect: makeOnDisconnectHandler(options),
-    onSubscribe: makeOnSubscribeHandler(options, schema, complexityConfig, fieldComplexities),
-    onComplete: makeOnCompleteHandler(options),
-    onError: makeOnErrorHandler(options)
+  let wsServerPromise = null;
+  const getOrCreateServer = async () => {
+    if (!wsServerPromise) {
+      wsServerPromise = effect.Effect.runPromise(importGraphqlWs).then(({ makeServer }) => {
+        const serverOptions = {
+          schema,
+          context: async (ctx) => {
+            const extra = ctx.extra;
+            return {
+              runtime: extra.runtime,
+              ...extra.connectionParams
+            };
+          },
+          subscribe: async (args) => graphql.subscribe(args),
+          onConnect: makeOnConnectHandler(options),
+          onDisconnect: makeOnDisconnectHandler(options),
+          onSubscribe: makeOnSubscribeHandler(options, schema, complexityConfig, fieldComplexities),
+          onComplete: makeOnCompleteHandler(options),
+          onError: makeOnErrorHandler(options)
+        };
+        return makeServer(serverOptions);
+      });
+    }
+    return wsServerPromise;
   };
-  const wsServer = graphqlWs.makeServer(serverOptions);
   return (socket) => effect.Effect.gen(function* () {
+    const wsServer = yield* effect.Effect.tryPromise({
+      try: () => getOrCreateServer(),
+      catch: (error) => error
+    });
     const runtime = yield* effect.Effect.provide(effect.Effect.runtime(), layer);
     const extra = {
       socket,