@constructive-io/graphql-codegen 3.0.4 → 3.1.0

package/core/codegen/orm/client-generator.js

@@ -43,322 +43,61 @@ const utils_1 = require("../utils");
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 /**
- * Generate the main client.ts file (OrmClient class)
- * This is the runtime client that handles GraphQL execution
- */
-function generateOrmClientFile() {
-    // This is runtime code that doesn't change based on schema
-    // We generate it as a static file
-    const content = `/**
- * ORM Client - Runtime GraphQL executor
- * @generated by @constructive-io/graphql-codegen
- * DO NOT EDIT - changes will be overwritten
- */
-
-import type { GraphQLAdapter, GraphQLError, QueryResult } from '@constructive-io/graphql-types';
-
-export type { GraphQLAdapter, GraphQLError, QueryResult } from '@constructive-io/graphql-types';
-
-/**
- * Default adapter that uses fetch for HTTP requests.
- * This is used when no custom adapter is provided.
+ * Find a template file path.
+ * Templates are at ../templates/ relative to this file in both src/ and dist/.
  */
-export class FetchAdapter implements GraphQLAdapter {
-  private headers: Record<string, string>;
-
-  constructor(
-    private endpoint: string,
-    headers?: Record<string, string>
-  ) {
-    this.headers = headers ?? {};
-  }
-
-  async execute<T>(
-    document: string,
-    variables?: Record<string, unknown>
-  ): Promise<QueryResult<T>> {
-    const response = await fetch(this.endpoint, {
-      method: 'POST',
-      headers: {
-        'Content-Type': 'application/json',
-        Accept: 'application/json',
-        ...this.headers,
-      },
-      body: JSON.stringify({
-        query: document,
-        variables: variables ?? {},
-      }),
-    });
-
-    if (!response.ok) {
-      return {
-        ok: false,
-        data: null,
-        errors: [{ message: \`HTTP \${response.status}: \${response.statusText}\` }],
-      };
+function findTemplateFile(templateName) {
+    const templatePath = path.join(__dirname, '../templates', templateName);
+    if (fs.existsSync(templatePath)) {
+        return templatePath;
     }
-
-    const json = (await response.json()) as {
-      data?: T;
-      errors?: GraphQLError[];
-    };
-
-    if (json.errors && json.errors.length > 0) {
-      return {
-        ok: false,
-        data: null,
-        errors: json.errors,
-      };
-    }
-
-    return {
-      ok: true,
-      data: json.data as T,
-      errors: undefined,
-    };
-  }
-
-  setHeaders(headers: Record<string, string>): void {
-    this.headers = { ...this.headers, ...headers };
-  }
-
-  getEndpoint(): string {
-    return this.endpoint;
-  }
+    throw new Error(`Could not find template file: ${templateName}. ` +
+        `Searched in: ${templatePath}`);
 }
-
 /**
- * Configuration for creating an ORM client.
- * Either provide endpoint (and optional headers) for HTTP requests,
- * or provide a custom adapter for alternative execution strategies.
+ * Read a template file and replace the header with generated file header
  */
-export interface OrmClientConfig {
-  /** GraphQL endpoint URL (required if adapter not provided) */
-  endpoint?: string;
-  /** Default headers for HTTP requests (only used with endpoint) */
-  headers?: Record<string, string>;
-  /** Custom adapter for GraphQL execution (overrides endpoint/headers) */
-  adapter?: GraphQLAdapter;
+function readTemplateFile(templateName, description) {
+    const templatePath = findTemplateFile(templateName);
+    let content = fs.readFileSync(templatePath, 'utf-8');
+    // Replace the source file header comment with the generated file header
+    // Match the header pattern used in template files
+    const headerPattern = /\/\*\*[\s\S]*?\* NOTE: This file is read at codegen time and written to output\.[\s\S]*?\*\/\n*/;
+    content = content.replace(headerPattern, (0, utils_1.getGeneratedFileHeader)(description) + '\n');
+    return content;
 }
-
 /**
- * Error thrown when GraphQL request fails
+ * Generate the main client.ts file (OrmClient class)
+ * This is the runtime client that handles GraphQL execution
+ *
+ * Reads from the templates directory for proper type checking.
  */
-export class GraphQLRequestError extends Error {
-  constructor(
-    public readonly errors: GraphQLError[],
-    public readonly data: unknown = null
-  ) {
-    const messages = errors.map(e => e.message).join('; ');
-    super(\`GraphQL Error: \${messages}\`);
-    this.name = 'GraphQLRequestError';
-  }
-}
-
-export class OrmClient {
-  private adapter: GraphQLAdapter;
-
-  constructor(config: OrmClientConfig) {
-    if (config.adapter) {
-      this.adapter = config.adapter;
-    } else if (config.endpoint) {
-      this.adapter = new FetchAdapter(config.endpoint, config.headers);
-    } else {
-      throw new Error('OrmClientConfig requires either an endpoint or a custom adapter');
-    }
-  }
-
-  async execute<T>(
-    document: string,
-    variables?: Record<string, unknown>
-  ): Promise<QueryResult<T>> {
-    return this.adapter.execute<T>(document, variables);
-  }
-
-  /**
-   * Set headers for requests.
-   * Only works if the adapter supports headers.
-   */
-  setHeaders(headers: Record<string, string>): void {
-    if (this.adapter.setHeaders) {
-      this.adapter.setHeaders(headers);
-    }
-  }
-
-  /**
-   * Get the endpoint URL.
-   * Returns empty string if the adapter doesn't have an endpoint.
-   */
-  getEndpoint(): string {
-    return this.adapter.getEndpoint?.() ?? '';
-  }
-}
-`;
+function generateOrmClientFile() {
     return {
         fileName: 'client.ts',
-        content,
+        content: readTemplateFile('orm-client.ts', 'ORM Client - Runtime GraphQL executor'),
     };
 }
 /**
  * Generate the query-builder.ts file (runtime query builder)
  *
- * Reads from the actual TypeScript file in the source directory,
- * which enables proper type checking and testability.
+ * Reads from the templates directory for proper type checking and testability.
  */
 function generateQueryBuilderFile() {
-    // Read the query-builder.ts source file
-    // Handle both development (src/) and production (dist/) scenarios
-    let sourceFilePath = path.join(__dirname, 'query-builder.ts');
-    // If running from dist/, look for the source in src/ instead
-    if (!fs.existsSync(sourceFilePath)) {
-        // Navigate from dist/cli/codegen/orm/ to src/cli/codegen/orm/
-        sourceFilePath = path.resolve(__dirname, '../../../../src/cli/codegen/orm/query-builder.ts');
-    }
-    // If still not found, try relative to package root
-    if (!fs.existsSync(sourceFilePath)) {
-        // For installed packages, the file should be adjacent in the same dir
-        throw new Error(`Could not find query-builder.ts source file. ` +
-            `Searched in: ${path.join(__dirname, 'query-builder.ts')} and ` +
-            `${path.resolve(__dirname, '../../../../src/cli/codegen/orm/query-builder.ts')}`);
-    }
-    let sourceContent = fs.readFileSync(sourceFilePath, 'utf-8');
-    // Replace the source file header comment with the generated file header
-    const headerComment = `/**
- * Query Builder - Builds and executes GraphQL operations
- *
- * This is the RUNTIME code that gets copied to generated output.
- * It uses gql-ast to build GraphQL documents programmatically.
- *
- * NOTE: This file is read at codegen time and written to output.
- * Any changes here will affect all generated ORM clients.
- */`;
-    const generatedHeader = `/**
- * Query Builder - Builds and executes GraphQL operations
- * @generated by @constructive-io/graphql-codegen
- * DO NOT EDIT - changes will be overwritten
- */`;
-    sourceContent = sourceContent.replace(headerComment, generatedHeader);
     return {
         fileName: 'query-builder.ts',
-        content: sourceContent,
+        content: readTemplateFile('query-builder.ts', 'Query Builder - Builds and executes GraphQL operations'),
     };
 }
 /**
  * Generate the select-types.ts file
- */
-function generateSelectTypesFile() {
-    const content = `/**
- * Type utilities for select inference
- * @generated by @constructive-io/graphql-codegen
- * DO NOT EDIT - changes will be overwritten
- */
-
-export interface ConnectionResult<T> {
-  nodes: T[];
-  totalCount: number;
-  pageInfo: PageInfo;
-}
-
-export interface PageInfo {
-  hasNextPage: boolean;
-  hasPreviousPage: boolean;
-  startCursor?: string | null;
-  endCursor?: string | null;
-}
-
-export interface FindManyArgs<TSelect, TWhere, TOrderBy> {
-  select?: TSelect;
-  where?: TWhere;
-  orderBy?: TOrderBy[];
-  first?: number;
-  last?: number;
-  after?: string;
-  before?: string;
-  offset?: number;
-}
-
-export interface FindFirstArgs<TSelect, TWhere> {
-  select?: TSelect;
-  where?: TWhere;
-}
-
-export interface CreateArgs<TSelect, TData> {
-  data: TData;
-  select?: TSelect;
-}
-
-export interface UpdateArgs<TSelect, TWhere, TData> {
-  where: TWhere;
-  data: TData;
-  select?: TSelect;
-}
-
-export interface DeleteArgs<TWhere> {
-  where: TWhere;
-}
-
-/**
- * Recursively validates select objects, rejecting unknown keys.
- *
- * This type ensures that users can only select fields that actually exist
- * in the GraphQL schema. It returns \`never\` if any excess keys are found
- * at any nesting level, causing a TypeScript compile error.
- *
- * Why this is needed:
- * TypeScript's excess property checking has a quirk where it only catches
- * invalid fields when they are the ONLY fields. When mixed with valid fields
- * (e.g., \`{ id: true, invalidField: true }\`), the structural typing allows
- * the excess property through. This type explicitly checks for and rejects
- * such cases.
- *
- * @example
- * // This will cause a type error because 'invalid' doesn't exist:
- * type Result = DeepExact<{ id: true, invalid: true }, { id?: boolean }>;
- * // Result = never (causes assignment error)
  *
- * @example
- * // This works because all fields are valid:
- * type Result = DeepExact<{ id: true }, { id?: boolean; name?: boolean }>;
- * // Result = { id: true }
- */
-export type DeepExact<T, Shape> = T extends Shape
-  ? Exclude<keyof T, keyof Shape> extends never
-    ? {
-        [K in keyof T]: K extends keyof Shape
-          ? T[K] extends { select: infer NS }
-            ? Shape[K] extends { select?: infer ShapeNS }
-              ? { select: DeepExact<NS, NonNullable<ShapeNS>> }
-              : T[K]
-            : T[K]
-          : never;
-      }
-    : never
-  : never;
-
-/**
- * Infer result type from select configuration
+ * Reads from the templates directory for proper type checking.
  */
-export type InferSelectResult<TEntity, TSelect> = TSelect extends undefined
-  ? TEntity
-  : {
-      [K in keyof TSelect as TSelect[K] extends false | undefined ? never : K]: TSelect[K] extends true
-        ? K extends keyof TEntity
-          ? TEntity[K]
-          : never
-        : TSelect[K] extends { select: infer NestedSelect }
-          ? K extends keyof TEntity
-            ? NonNullable<TEntity[K]> extends ConnectionResult<infer NodeType>
-              ? ConnectionResult<InferSelectResult<NodeType, NestedSelect>>
-              : InferSelectResult<NonNullable<TEntity[K]>, NestedSelect> | (null extends TEntity[K] ? null : never)
-            : never
-          : K extends keyof TEntity
-            ? TEntity[K]
-            : never;
-    };
-`;
+function generateSelectTypesFile() {
     return {
         fileName: 'select-types.ts',
-        content,
+        content: readTemplateFile('select-types.ts', 'Type utilities for select inference'),
     };
 }
 function createImportDeclaration(moduleSpecifier, namedImports, typeOnly = false) {

package/core/codegen/templates/client.browser.ts

@@ -0,0 +1,265 @@
+/**
+ * GraphQL client configuration and execution (Browser-compatible)
+ *
+ * This is the RUNTIME code that gets copied to generated output.
+ * Uses native W3C fetch API for browser compatibility.
+ *
+ * NOTE: This file is read at codegen time and written to output.
+ * Any changes here will affect all generated clients.
+ */
+
+// ============================================================================
+// Configuration
+// ============================================================================
+
+export interface GraphQLClientConfig {
+  /** GraphQL endpoint URL */
+  endpoint: string;
+  /** Default headers to include in all requests */
+  headers?: Record<string, string>;
+}
+
+let globalConfig: GraphQLClientConfig | null = null;
+
+/**
+ * Configure the GraphQL client
+ *
+ * @example
+ * ```ts
+ * import { configure } from './generated';
+ *
+ * configure({
+ *   endpoint: 'https://api.example.com/graphql',
+ *   headers: {
+ *     Authorization: 'Bearer <token>',
+ *   },
+ * });
+ * ```
+ */
+export function configure(config: GraphQLClientConfig): void {
+  globalConfig = config;
+}
+
+/**
+ * Get the current configuration
+ * @throws Error if not configured
+ */
+export function getConfig(): GraphQLClientConfig {
+  if (!globalConfig) {
+    throw new Error(
+      'GraphQL client not configured. Call configure() before making requests.'
+    );
+  }
+  return globalConfig;
+}
+
+/**
+ * Set a single header value
+ * Useful for updating Authorization after login
+ *
+ * @example
+ * ```ts
+ * setHeader('Authorization', 'Bearer <new-token>');
+ * ```
+ */
+export function setHeader(key: string, value: string): void {
+  const config = getConfig();
+  globalConfig = {
+    ...config,
+    headers: { ...config.headers, [key]: value },
+  };
+}
+
+/**
+ * Merge multiple headers into the current configuration
+ *
+ * @example
+ * ```ts
+ * setHeaders({ Authorization: 'Bearer <token>', 'X-Custom': 'value' });
+ * ```
+ */
+export function setHeaders(headers: Record<string, string>): void {
+  const config = getConfig();
+  globalConfig = {
+    ...config,
+    headers: { ...config.headers, ...headers },
+  };
+}
+
+// ============================================================================
+// Error handling
+// ============================================================================
+
+export interface GraphQLError {
+  message: string;
+  locations?: Array<{ line: number; column: number }>;
+  path?: Array<string | number>;
+  extensions?: Record<string, unknown>;
+}
+
+export class GraphQLClientError extends Error {
+  constructor(
+    message: string,
+    public errors: GraphQLError[],
+    public response?: Response
+  ) {
+    super(message);
+    this.name = 'GraphQLClientError';
+  }
+}
+
+// ============================================================================
+// Execution
+// ============================================================================
+
+export interface ExecuteOptions {
+  /** Override headers for this request */
+  headers?: Record<string, string>;
+  /** AbortSignal for request cancellation */
+  signal?: AbortSignal;
+}
+
+/**
+ * Execute a GraphQL operation
+ *
+ * @example
+ * ```ts
+ * const result = await execute<CarsQueryResult, CarsQueryVariables>(
+ *   carsQueryDocument,
+ *   { first: 10 }
+ * );
+ * ```
+ */
+export async function execute<
+  TData = unknown,
+  TVariables = Record<string, unknown>,
+>(
+  document: string,
+  variables?: TVariables,
+  options?: ExecuteOptions
+): Promise<TData> {
+  const config = getConfig();
+
+  const response = await fetch(config.endpoint, {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json',
+      ...config.headers,
+      ...options?.headers,
+    },
+    body: JSON.stringify({
+      query: document,
+      variables,
+    }),
+    signal: options?.signal,
+  });
+
+  const json = await response.json();
+
+  if (json.errors && json.errors.length > 0) {
+    throw new GraphQLClientError(
+      json.errors[0].message || 'GraphQL request failed',
+      json.errors,
+      response
+    );
+  }
+
+  return json.data as TData;
+}
+
+/**
+ * Execute a GraphQL operation with full response (data + errors)
+ * Useful when you want to handle partial data with errors
+ */
+export async function executeWithErrors<
+  TData = unknown,
+  TVariables = Record<string, unknown>,
+>(
+  document: string,
+  variables?: TVariables,
+  options?: ExecuteOptions
+): Promise<{ data: TData | null; errors: GraphQLError[] | null }> {
+  const config = getConfig();
+
+  const response = await fetch(config.endpoint, {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json',
+      ...config.headers,
+      ...options?.headers,
+    },
+    body: JSON.stringify({
+      query: document,
+      variables,
+    }),
+    signal: options?.signal,
+  });
+
+  const json = await response.json();
+
+  return {
+    data: json.data ?? null,
+    errors: json.errors ?? null,
+  };
+}
+
+// ============================================================================
+// QueryClient Factory
+// ============================================================================
+
+/**
+ * Default QueryClient configuration optimized for GraphQL
+ *
+ * These defaults provide a good balance between freshness and performance:
+ * - staleTime: 1 minute - data considered fresh, won't refetch
+ * - gcTime: 5 minutes - unused data kept in cache
+ * - refetchOnWindowFocus: false - don't refetch when tab becomes active
+ * - retry: 1 - retry failed requests once
+ */
+export const defaultQueryClientOptions = {
+  defaultOptions: {
+    queries: {
+      staleTime: 1000 * 60, // 1 minute
+      gcTime: 1000 * 60 * 5, // 5 minutes
+      refetchOnWindowFocus: false,
+      retry: 1,
+    },
+  },
+};
+
+/**
+ * QueryClient options type for createQueryClient
+ */
+export interface CreateQueryClientOptions {
+  defaultOptions?: {
+    queries?: {
+      staleTime?: number;
+      gcTime?: number;
+      refetchOnWindowFocus?: boolean;
+      retry?: number | boolean;
+      retryDelay?: number | ((attemptIndex: number) => number);
+    };
+    mutations?: {
+      retry?: number | boolean;
+      retryDelay?: number | ((attemptIndex: number) => number);
+    };
+  };
+}
+
+// Note: createQueryClient is available when using with @tanstack/react-query
+// Import QueryClient from '@tanstack/react-query' and use these options:
+//
+// import { QueryClient } from '@tanstack/react-query';
+// const queryClient = new QueryClient(defaultQueryClientOptions);
+//
+// Or merge with your own options:
+// const queryClient = new QueryClient({
+//   ...defaultQueryClientOptions,
+//   defaultOptions: {
+//     ...defaultQueryClientOptions.defaultOptions,
+//     queries: {
+//       ...defaultQueryClientOptions.defaultOptions.queries,
+//       staleTime: 30000, // Override specific options
+//     },
+//   },
+// });