@effect-gql/core 1.0.0 → 1.1.0

package/server/index.d.cts

@@ -1,6 +1,6 @@
 import { Config, Layer, Cause, Effect, Stream, Runtime } from 'effect';
-import { j as ComplexityConfig, y as CacheControlConfig, F as FieldComplexityMap, w as CacheHintMap, G as GraphQLExtension, i as GraphQLSchemaBuilder } from '../schema-builder-Cvdq7Kz_.cjs';
-export { J as CacheControlConfigFromEnv, x as CachePolicy, z as CachePolicyAnalysisInfo, q as ComplexityAnalysisError, l as ComplexityAnalysisInfo, n as ComplexityCalculator, u as ComplexityConfigFromEnv, m as ComplexityExceededInfo, p as ComplexityLimitExceededError, k as ComplexityResult, o as FieldComplexity, t as combineCalculators, A as computeCachePolicy, B as computeCachePolicyFromQuery, r as defaultComplexityCalculator, s as depthOnlyCalculator, H as toCacheControlHeader, v as validateComplexity } from '../schema-builder-Cvdq7Kz_.cjs';
+import { j as ComplexityConfig, y as CacheControlConfig, F as FieldComplexityMap, w as CacheHintMap, G as GraphQLExtension, i as GraphQLSchemaBuilder } from '../schema-builder-DKvkzU_M.cjs';
+export { J as CacheControlConfigFromEnv, x as CachePolicy, z as CachePolicyAnalysisInfo, q as ComplexityAnalysisError, l as ComplexityAnalysisInfo, n as ComplexityCalculator, u as ComplexityConfigFromEnv, m as ComplexityExceededInfo, p as ComplexityLimitExceededError, k as ComplexityResult, o as FieldComplexity, t as combineCalculators, A as computeCachePolicy, B as computeCachePolicyFromQuery, r as defaultComplexityCalculator, s as depthOnlyCalculator, H as toCacheControlHeader, v as validateComplexity } from '../schema-builder-DKvkzU_M.cjs';
 import { HttpServerResponse, HttpRouter } from '@effect/platform';
 import { GraphQLSchema, ExecutionResult } from 'graphql';
 import * as effect_Cause from 'effect/Cause';
@@ -15,6 +15,8 @@ interface GraphiQLConfig {
     readonly path: string;
     /** URL where GraphiQL sends requests (default: same as graphql path) */
     readonly endpoint: string;
+    /** WebSocket URL for subscriptions (default: same as endpoint) */
+    readonly subscriptionEndpoint?: string;
 }
 /**
  * Configuration for the GraphQL router
@@ -73,7 +75,7 @@ declare const GraphQLRouterConfigFromEnv: Config.Config<GraphQLRouterConfig>;
 /**
  * Generate HTML for GraphiQL IDE, loading dependencies from CDN
  */
-declare const graphiqlHtml: (endpoint: string) => string;
+declare const graphiqlHtml: (endpoint: string, subscriptionEndpoint?: string) => string;
 
 /**
  * Error handler function type for handling uncaught errors during GraphQL execution.

package/server/index.d.ts

@@ -1,6 +1,6 @@
 import { Config, Layer, Cause, Effect, Stream, Runtime } from 'effect';
-import { j as ComplexityConfig, y as CacheControlConfig, F as FieldComplexityMap, w as CacheHintMap, G as GraphQLExtension, i as GraphQLSchemaBuilder } from '../schema-builder-Cvdq7Kz_.js';
-export { J as CacheControlConfigFromEnv, x as CachePolicy, z as CachePolicyAnalysisInfo, q as ComplexityAnalysisError, l as ComplexityAnalysisInfo, n as ComplexityCalculator, u as ComplexityConfigFromEnv, m as ComplexityExceededInfo, p as ComplexityLimitExceededError, k as ComplexityResult, o as FieldComplexity, t as combineCalculators, A as computeCachePolicy, B as computeCachePolicyFromQuery, r as defaultComplexityCalculator, s as depthOnlyCalculator, H as toCacheControlHeader, v as validateComplexity } from '../schema-builder-Cvdq7Kz_.js';
+import { j as ComplexityConfig, y as CacheControlConfig, F as FieldComplexityMap, w as CacheHintMap, G as GraphQLExtension, i as GraphQLSchemaBuilder } from '../schema-builder-DKvkzU_M.js';
+export { J as CacheControlConfigFromEnv, x as CachePolicy, z as CachePolicyAnalysisInfo, q as ComplexityAnalysisError, l as ComplexityAnalysisInfo, n as ComplexityCalculator, u as ComplexityConfigFromEnv, m as ComplexityExceededInfo, p as ComplexityLimitExceededError, k as ComplexityResult, o as FieldComplexity, t as combineCalculators, A as computeCachePolicy, B as computeCachePolicyFromQuery, r as defaultComplexityCalculator, s as depthOnlyCalculator, H as toCacheControlHeader, v as validateComplexity } from '../schema-builder-DKvkzU_M.js';
 import { HttpServerResponse, HttpRouter } from '@effect/platform';
 import { GraphQLSchema, ExecutionResult } from 'graphql';
 import * as effect_Cause from 'effect/Cause';
@@ -15,6 +15,8 @@ interface GraphiQLConfig {
     readonly path: string;
     /** URL where GraphiQL sends requests (default: same as graphql path) */
     readonly endpoint: string;
+    /** WebSocket URL for subscriptions (default: same as endpoint) */
+    readonly subscriptionEndpoint?: string;
 }
 /**
  * Configuration for the GraphQL router
@@ -73,7 +75,7 @@ declare const GraphQLRouterConfigFromEnv: Config.Config<GraphQLRouterConfig>;
 /**
  * Generate HTML for GraphiQL IDE, loading dependencies from CDN
  */
-declare const graphiqlHtml: (endpoint: string) => string;
+declare const graphiqlHtml: (endpoint: string, subscriptionEndpoint?: string) => string;
 
 /**
  * Error handler function type for handling uncaught errors during GraphQL execution.

package/server/index.js

@@ -1,5 +1,5 @@
-import { Config, Option, Data, Context, Effect, Queue, Deferred, Stream, Ref, Runtime, Fiber } from 'effect';
-import { HttpServerResponse, HttpServerRequest, HttpRouter } from '@effect/platform';
+import { Config, Option, Data, Context, Schema, Effect, Queue, Deferred, Stream, Ref, Runtime, Fiber } from 'effect';
+import { HttpIncomingMessage, HttpServerResponse, HttpServerRequest, HttpRouter } from '@effect/platform';
 import { Kind, GraphQLObjectType, parse, specifiedRules, NoSchemaIntrospectionCustomRule, validate, subscribe, GraphQLError, GraphQLNonNull, GraphQLList, GraphQLSchema, GraphQLScalarType, GraphQLEnumType, execute } from 'graphql';
 import { makeServer } from 'graphql-ws';
 
@@ -96,7 +96,7 @@ var GraphQLRouterConfigFromEnv = 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" />
@@ -124,6 +124,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 })
@@ -848,19 +849,32 @@ var defaultErrorHandler = (cause) => (process.env.NODE_ENV !== "production" ? Ef
     ).pipe(Effect.orDie)
   )
 );
-var parseGraphQLQuery = (query, extensionsService) => Effect.gen(function* () {
+var GraphQLRequestBodySchema = Schema.Struct({
+  query: Schema.String,
+  variables: Schema.optionalWith(Schema.Record({ key: Schema.String, value: Schema.Unknown }), {
+    as: "Option"
+  }),
+  operationName: Schema.optionalWith(Schema.String, { as: "Option" })
+});
+var decodeRequestBody = HttpIncomingMessage.schemaBodyJson(GraphQLRequestBodySchema);
+var parseGraphQLQuery = (query, extensionsService) => {
   try {
     const document = parse(query);
-    return { ok: true, document };
+    return Effect.succeed({ ok: true, document });
   } catch (parseError) {
-    const extensionData = yield* extensionsService.get();
-    const response = yield* HttpServerResponse.json({
-      errors: [{ message: String(parseError) }],
-      extensions: Object.keys(extensionData).length > 0 ? extensionData : void 0
-    }).pipe(Effect.orDie);
-    return { ok: false, response };
+    return extensionsService.get().pipe(
+      Effect.flatMap(
+        (extensionData) => HttpServerResponse.json({
+          errors: [{ message: String(parseError) }],
+          extensions: Object.keys(extensionData).length > 0 ? extensionData : void 0
+        }).pipe(
+          Effect.orDie,
+          Effect.map((response) => ({ ok: false, response }))
+        )
+      )
+    );
   }
-});
+};
 var runComplexityValidation = (body, schema, fieldComplexities, complexityConfig) => {
   if (!complexityConfig) {
     return Effect.void;
@@ -880,8 +894,9 @@ var runComplexityValidation = (body, schema, fieldComplexities, complexityConfig
     )
   );
 };
-var executeGraphQLQuery = (schema, document, variables, operationName, runtime) => Effect.gen(function* () {
-  const executeResult = yield* 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.try({
     try: () => execute({
       schema,
       document,
@@ -891,33 +906,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.promise(
-      () => executeResult
-    );
-  }
-  return executeResult;
-});
-var computeCacheControlHeader = (document, operationName, schema, cacheHints, cacheControlConfig) => Effect.gen(function* () {
+  return tryExecute.pipe(
+    Effect.flatMap((executeResult) => {
+      if (isPromiseLike(executeResult)) {
+        return Effect.promise(() => executeResult);
+      }
+      return Effect.succeed(executeResult);
+    })
+  );
+};
+var computeCacheControlHeader = (document, operationName, schema, cacheHints, cacheControlConfig) => {
   if (cacheControlConfig?.enabled === false || cacheControlConfig?.calculateHttpHeaders === false) {
-    return void 0;
+    return Effect.succeed(void 0);
   }
   const operations = document.definitions.filter(
     (d) => d.kind === 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.succeed(void 0);
   }
-  const cachePolicy = yield* computeCachePolicy({
+  return computeCachePolicy({
     document,
     operation,
     schema,
     cacheHints,
     config: cacheControlConfig ?? {}
-  });
-  return toCacheControlHeader(cachePolicy);
-});
+  }).pipe(Effect.map(toCacheControlHeader));
+};
 var buildGraphQLResponse = (result, extensionData, cacheControlHeader) => {
   const finalResult = Object.keys(extensionData).length > 0 ? {
     ...result,
@@ -955,7 +971,12 @@ var makeGraphQLRouter = (schema, layer, options = {}) => {
     const extensionsService = yield* makeExtensionsService();
     const runtime = yield* Effect.runtime();
     const request = yield* 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;
@@ -964,7 +985,7 @@ var makeGraphQLRouter = (schema, layer, options = {}) => {
     yield* runParseHooks(extensions, body.query, document).pipe(
       Effect.provideService(ExtensionsService, extensionsService)
     );
-    const validationRules = resolvedConfig.introspection ? void 0 : [...specifiedRules, NoSchemaIntrospectionCustomRule];
+    const validationRules = resolvedConfig.introspection ? void 0 : specifiedRules.concat(NoSchemaIntrospectionCustomRule);
     const validationErrors = validate(schema, document, validationRules);
     yield* runValidateHooks(extensions, document, validationErrors).pipe(
       Effect.provideService(ExtensionsService, extensionsService)
@@ -1025,9 +1046,12 @@ var makeGraphQLRouter = (schema, layer, options = {}) => {
     HttpRouter.post(resolvedConfig.path, graphqlHandler)
   );
   if (resolvedConfig.graphiql) {
-    const { path, endpoint } = resolvedConfig.graphiql;
+    const { path, endpoint, subscriptionEndpoint } = resolvedConfig.graphiql;
     router = router.pipe(
-      HttpRouter.get(path, HttpServerResponse.html(graphiqlHtml(endpoint)))
+      HttpRouter.get(
+        path,
+        HttpServerResponse.html(graphiqlHtml(endpoint, subscriptionEndpoint))
+      )
     );
   }
   return router;