graphql-service.ts

// Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license.

/**
 * IGraphQLService - GraphQL Service Contract
 *
 * Defines the interface for GraphQL schema and query execution in ObjectStack.
 * Concrete implementations (Apollo, Yoga, Mercurius, etc.)
 * should implement this interface.
 *
 * Follows Dependency Inversion Principle - plugins depend on this interface,
 * not on concrete GraphQL server implementations.
 *
 * Aligned with CoreServiceName 'graphql' in core-services.zod.ts.
 */

/**
 * A GraphQL execution request
 */
export interface GraphQLRequest {
    /** GraphQL query or mutation string */
    query: string;
    /** Operation name (when document contains multiple operations) */
    operationName?: string;
    /** Variables for the operation */
    variables?: Record<string, unknown>;
}

/**
 * A GraphQL execution response
 */
export interface GraphQLResponse {
    /** Query result data */
    data?: Record<string, unknown> | null;
    /** Errors encountered during execution */
    errors?: Array<{
        message: string;
        locations?: Array<{ line: number; column: number }>;
        path?: Array<string | number>;
        extensions?: Record<string, unknown>;
    }>;
}

export interface IGraphQLService {
    /**
     * Execute a GraphQL query or mutation
     * @param request - The GraphQL request
     * @param context - Optional execution context (e.g. auth user)
     * @returns GraphQL response with data and/or errors
     */
    execute(request: GraphQLRequest, context?: Record<string, unknown>): Promise<GraphQLResponse>;

    /**
     * Handle an incoming HTTP request for GraphQL
     * @param request - Standard Request object
     * @returns Standard Response object
     */
    handleRequest?(request: Request): Promise<Response>;

    /**
     * Get the current GraphQL schema as SDL string
     * @returns SDL schema string
     */
    getSchema?(): string;
}