@spikard/node 0.11.0 → 0.12.0

package/dist/index.d.mts

@@ -117,6 +117,12 @@ interface OpenApiConfig {
     servers?: ServerInfo[];
     securitySchemes?: Record<string, SecuritySchemeInfo>;
 }
+interface JsonRpcConfig {
+    enabled?: boolean;
+    endpointPath?: string;
+    enableBatch?: boolean;
+    maxBatchSize?: number;
+}
 interface StaticFilesConfig {
     directory: string;
     routePrefix: string;
@@ -138,6 +144,7 @@ interface ServerConfig {
     gracefulShutdown?: boolean;
     shutdownTimeout?: number;
     openapi?: OpenApiConfig | null;
+    jsonrpc?: JsonRpcConfig | null;
 }
 
 interface ServerOptions {
@@ -292,6 +299,13 @@ interface WebSocketTestConnection {
     close(): Promise<void>;
 }
 type TestResponse = NativeTestResponse;
+interface GraphQLSubscriptionResult {
+    operationId: string;
+    acknowledged: boolean;
+    event: unknown | null;
+    errors: unknown[];
+    completeReceived: boolean;
+}
 interface MultipartFile {
     name: string;
     filename?: string;
@@ -330,6 +344,7 @@ declare class TestClient {
         headers: string;
         bodyText: string;
     }>;
+    graphqlSubscription(query: string, variables?: Record<string, unknown> | null, operationName?: string | null, path?: string): Promise<GraphQLSubscriptionResult>;
     cleanup(): Promise<void>;
 }
 
@@ -397,4 +412,4 @@ interface SpikardApp {
     dependencies?: Record<string, unknown>;
 }
 
-export { type ApiKeyConfig, type Base64EncodedBody, type Body, type CompressionConfig, type ContactInfo, type CorsConfig, type DependencyFactory, type DependencyOptions, type DependencyValue, type FileParam, GrpcError, type GrpcHandler, type GrpcMetadata, type GrpcRequest, type GrpcResponse, type GrpcServiceConfig, GrpcStatusCode, type HandlerFunction, type HandlerResult, type JsonPrimitive, type JsonRecord, type JsonSchema, type JsonValue, type JwtConfig, type LicenseInfo, type LifecycleHookFunction, type LifecycleHooks, type MaybePromise, type NativeHandlerFunction, type OpenApiConfig, type Path, type Query, QueryDefault, type RateLimitConfig, type Request, type RouteMetadata, type RouteOptions, type SecuritySchemeInfo, type ServerConfig, type ServerInfo, type ServerOptions, Spikard, type SpikardApp, type StaticFilesConfig, StreamingResponse, type StreamingResponseInit, type StructuredHandlerResponse, TestClient, type TestResponse, UploadFile, type WebSocketHandler, type WebSocketOptions, background, createServiceHandler, createUnaryHandler, del, get, patch, post, put, route, runServer, wrapBodyHandler, wrapHandler };
+export { type ApiKeyConfig, type Base64EncodedBody, type Body, type CompressionConfig, type ContactInfo, type CorsConfig, type DependencyFactory, type DependencyOptions, type DependencyValue, type FileParam, GrpcError, type GrpcHandler, type GrpcMetadata, type GrpcRequest, type GrpcResponse, type GrpcServiceConfig, GrpcStatusCode, type HandlerFunction, type HandlerResult, type JsonPrimitive, type JsonRecord, type JsonRpcConfig, type JsonSchema, type JsonValue, type JwtConfig, type LicenseInfo, type LifecycleHookFunction, type LifecycleHooks, type MaybePromise, type NativeHandlerFunction, type OpenApiConfig, type Path, type Query, QueryDefault, type RateLimitConfig, type Request, type RouteMetadata, type RouteOptions, type SecuritySchemeInfo, type ServerConfig, type ServerInfo, type ServerOptions, Spikard, type SpikardApp, type StaticFilesConfig, StreamingResponse, type StreamingResponseInit, type StructuredHandlerResponse, TestClient, type TestResponse, UploadFile, type WebSocketHandler, type WebSocketOptions, background, createServiceHandler, createUnaryHandler, del, get, patch, post, put, route, runServer, wrapBodyHandler, wrapHandler };

package/dist/index.d.ts

@@ -117,6 +117,12 @@ interface OpenApiConfig {
     servers?: ServerInfo[];
     securitySchemes?: Record<string, SecuritySchemeInfo>;
 }
+interface JsonRpcConfig {
+    enabled?: boolean;
+    endpointPath?: string;
+    enableBatch?: boolean;
+    maxBatchSize?: number;
+}
 interface StaticFilesConfig {
     directory: string;
     routePrefix: string;
@@ -138,6 +144,7 @@ interface ServerConfig {
     gracefulShutdown?: boolean;
     shutdownTimeout?: number;
     openapi?: OpenApiConfig | null;
+    jsonrpc?: JsonRpcConfig | null;
 }
 
 interface ServerOptions {
@@ -292,6 +299,13 @@ interface WebSocketTestConnection {
     close(): Promise<void>;
 }
 type TestResponse = NativeTestResponse;
+interface GraphQLSubscriptionResult {
+    operationId: string;
+    acknowledged: boolean;
+    event: unknown | null;
+    errors: unknown[];
+    completeReceived: boolean;
+}
 interface MultipartFile {
     name: string;
     filename?: string;
@@ -330,6 +344,7 @@ declare class TestClient {
         headers: string;
         bodyText: string;
     }>;
+    graphqlSubscription(query: string, variables?: Record<string, unknown> | null, operationName?: string | null, path?: string): Promise<GraphQLSubscriptionResult>;
     cleanup(): Promise<void>;
 }
 
@@ -397,4 +412,4 @@ interface SpikardApp {
     dependencies?: Record<string, unknown>;
 }
 
-export { type ApiKeyConfig, type Base64EncodedBody, type Body, type CompressionConfig, type ContactInfo, type CorsConfig, type DependencyFactory, type DependencyOptions, type DependencyValue, type FileParam, GrpcError, type GrpcHandler, type GrpcMetadata, type GrpcRequest, type GrpcResponse, type GrpcServiceConfig, GrpcStatusCode, type HandlerFunction, type HandlerResult, type JsonPrimitive, type JsonRecord, type JsonSchema, type JsonValue, type JwtConfig, type LicenseInfo, type LifecycleHookFunction, type LifecycleHooks, type MaybePromise, type NativeHandlerFunction, type OpenApiConfig, type Path, type Query, QueryDefault, type RateLimitConfig, type Request, type RouteMetadata, type RouteOptions, type SecuritySchemeInfo, type ServerConfig, type ServerInfo, type ServerOptions, Spikard, type SpikardApp, type StaticFilesConfig, StreamingResponse, type StreamingResponseInit, type StructuredHandlerResponse, TestClient, type TestResponse, UploadFile, type WebSocketHandler, type WebSocketOptions, background, createServiceHandler, createUnaryHandler, del, get, patch, post, put, route, runServer, wrapBodyHandler, wrapHandler };
+export { type ApiKeyConfig, type Base64EncodedBody, type Body, type CompressionConfig, type ContactInfo, type CorsConfig, type DependencyFactory, type DependencyOptions, type DependencyValue, type FileParam, GrpcError, type GrpcHandler, type GrpcMetadata, type GrpcRequest, type GrpcResponse, type GrpcServiceConfig, GrpcStatusCode, type HandlerFunction, type HandlerResult, type JsonPrimitive, type JsonRecord, type JsonRpcConfig, type JsonSchema, type JsonValue, type JwtConfig, type LicenseInfo, type LifecycleHookFunction, type LifecycleHooks, type MaybePromise, type NativeHandlerFunction, type OpenApiConfig, type Path, type Query, QueryDefault, type RateLimitConfig, type Request, type RouteMetadata, type RouteOptions, type SecuritySchemeInfo, type ServerConfig, type ServerInfo, type ServerOptions, Spikard, type SpikardApp, type StaticFilesConfig, StreamingResponse, type StreamingResponseInit, type StructuredHandlerResponse, TestClient, type TestResponse, UploadFile, type WebSocketHandler, type WebSocketOptions, background, createServiceHandler, createUnaryHandler, del, get, patch, post, put, route, runServer, wrapBodyHandler, wrapHandler };

package/dist/index.js

@@ -954,6 +954,36 @@ var import_promises = __toESM(require("fs/promises"));
 var import_node_module3 = require("module");
 var import_node_path = __toESM(require("path"));
 var import_node_zlib = require("zlib");
+var GRAPHQL_WS_TIMEOUT_MS = 2e3;
+var GRAPHQL_WS_MAX_CONTROL_MESSAGES = 32;
+var withTimeout = async (promise, timeoutMs, context) => {
+  let timer;
+  try {
+    return await Promise.race([
+      promise,
+      new Promise((_resolve, reject) => {
+        timer = setTimeout(() => reject(new Error(`Timed out waiting for ${context}`)), timeoutMs);
+      })
+    ]);
+  } finally {
+    if (timer) {
+      clearTimeout(timer);
+    }
+  }
+};
+var decodeGraphqlWsMessage = (value) => {
+  if (typeof value === "string") {
+    const parsed = JSON.parse(value);
+    if (parsed && typeof parsed === "object" && !Array.isArray(parsed)) {
+      return parsed;
+    }
+    throw new Error("Expected GraphQL WebSocket JSON object message");
+  }
+  if (value && typeof value === "object" && !Array.isArray(value)) {
+    return value;
+  }
+  throw new Error("Expected GraphQL WebSocket message object");
+};
 var MockWebSocketConnection = class {
   handler;
   queue = [];
@@ -1667,6 +1697,107 @@ var TestClient = class {
       bodyText: response.text()
     };
   }
+  /**
+   * Send a GraphQL subscription over WebSocket and return the first event payload.
+   */
+  async graphqlSubscription(query, variables, operationName, path2 = "/graphql") {
+    const operationId = "spikard-subscription-1";
+    const subscriptionPayload = { query };
+    if (variables !== null && variables !== void 0) {
+      subscriptionPayload.variables = variables;
+    }
+    if (operationName !== null && operationName !== void 0) {
+      subscriptionPayload.operationName = operationName;
+    }
+    const ws = await this.websocketConnect(path2);
+    try {
+      await ws.sendJson({ type: "connection_init" });
+      let acknowledged = false;
+      for (let i = 0; i < GRAPHQL_WS_MAX_CONTROL_MESSAGES; i++) {
+        const message = decodeGraphqlWsMessage(
+          await withTimeout(ws.receiveJson(), GRAPHQL_WS_TIMEOUT_MS, "GraphQL connection_ack")
+        );
+        const messageType = typeof message.type === "string" ? message.type : "";
+        if (messageType === "connection_ack") {
+          acknowledged = true;
+          break;
+        }
+        if (messageType === "ping") {
+          const pong = { type: "pong" };
+          if ("payload" in message) {
+            pong.payload = message.payload;
+          }
+          await ws.sendJson(pong);
+          continue;
+        }
+        if (messageType === "connection_error" || messageType === "error") {
+          throw new Error(`GraphQL subscription rejected during init: ${JSON.stringify(message)}`);
+        }
+      }
+      if (!acknowledged) {
+        throw new Error("No GraphQL connection_ack received");
+      }
+      await ws.sendJson({
+        id: operationId,
+        type: "subscribe",
+        payload: subscriptionPayload
+      });
+      let event = null;
+      const errors = [];
+      let completeReceived = false;
+      for (let i = 0; i < GRAPHQL_WS_MAX_CONTROL_MESSAGES; i++) {
+        const message = decodeGraphqlWsMessage(
+          await withTimeout(ws.receiveJson(), GRAPHQL_WS_TIMEOUT_MS, "GraphQL subscription message")
+        );
+        const messageType = typeof message.type === "string" ? message.type : "";
+        const messageId = typeof message.id === "string" ? message.id : void 0;
+        const idMatches = messageId === void 0 || messageId === operationId;
+        if (messageType === "next" && idMatches) {
+          event = "payload" in message ? message.payload : null;
+          await ws.sendJson({ id: operationId, type: "complete" });
+          try {
+            const maybeComplete = decodeGraphqlWsMessage(
+              await withTimeout(ws.receiveJson(), GRAPHQL_WS_TIMEOUT_MS, "GraphQL complete message")
+            );
+            const completeType = typeof maybeComplete.type === "string" ? maybeComplete.type : "";
+            const completeId = typeof maybeComplete.id === "string" ? maybeComplete.id : void 0;
+            if (completeType === "complete" && (completeId === void 0 || completeId === operationId)) {
+              completeReceived = true;
+            }
+          } catch {
+          }
+          break;
+        }
+        if (messageType === "error") {
+          errors.push("payload" in message ? message.payload : message);
+          break;
+        }
+        if (messageType === "complete" && idMatches) {
+          completeReceived = true;
+          break;
+        }
+        if (messageType === "ping") {
+          const pong = { type: "pong" };
+          if ("payload" in message) {
+            pong.payload = message.payload;
+          }
+          await ws.sendJson(pong);
+        }
+      }
+      if (event === null && errors.length === 0 && !completeReceived) {
+        throw new Error("No GraphQL subscription event received before timeout");
+      }
+      return {
+        operationId,
+        acknowledged,
+        event,
+        errors,
+        completeReceived
+      };
+    } finally {
+      await ws.close();
+    }
+  }
   /**
    * Cleanup resources when test client is done
    */