@constructive-io/graphql-codegen 2.28.4 → 2.29.0

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

@@ -55,11 +55,6 @@ function generateOrmClientFile() {
  * DO NOT EDIT - changes will be overwritten
  */
 
-export interface OrmClientConfig {
-  endpoint: string;
-  headers?: Record<string, string>;
-}
-
 export interface GraphQLError {
   message: string;
   locations?: { line: number; column: number }[];
@@ -67,20 +62,6 @@ export interface GraphQLError {
   extensions?: Record<string, unknown>;
 }
 
-/**
- * Error thrown when GraphQL request fails
- */
-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';
-  }
-}
-
 /**
  * Discriminated union for query results
  * Use .ok to check success, or use .unwrap() to get data or throw
@@ -90,21 +71,36 @@ export type QueryResult<T> =
   | { ok: false; data: null; errors: GraphQLError[] };
 
 /**
- * Legacy QueryResult type for backwards compatibility
- * @deprecated Use QueryResult discriminated union instead
+ * Pluggable adapter interface for GraphQL execution.
+ * Implement this interface to provide custom execution logic (e.g., for testing).
  */
-export interface LegacyQueryResult<T> {
-  data: T | null;
-  errors?: GraphQLError[];
+export interface GraphQLAdapter {
+  /**
+   * Execute a GraphQL operation and return the result.
+   */
+  execute<T>(document: string, variables?: Record<string, unknown>): Promise<QueryResult<T>>;
+  /**
+   * Set headers for requests (optional - only implement if adapter supports headers).
+   */
+  setHeaders?(headers: Record<string, string>): void;
+  /**
+   * Get the endpoint URL (optional - only implement if adapter has an endpoint).
+   */
+  getEndpoint?(): string;
 }
 
-export class OrmClient {
-  private endpoint: string;
+/**
+ * Default adapter that uses fetch for HTTP requests.
+ * This is used when no custom adapter is provided.
+ */
+export class FetchAdapter implements GraphQLAdapter {
   private headers: Record<string, string>;
 
-  constructor(config: OrmClientConfig) {
-    this.endpoint = config.endpoint;
-    this.headers = config.headers ?? {};
+  constructor(
+    private endpoint: string,
+    headers?: Record<string, string>
+  ) {
+    this.headers = headers ?? {};
   }
 
   async execute<T>(
@@ -137,7 +133,6 @@ export class OrmClient {
       errors?: GraphQLError[];
     };
 
-    // Return discriminated union based on presence of errors
     if (json.errors && json.errors.length > 0) {
       return {
         ok: false,
@@ -161,6 +156,73 @@ export class OrmClient {
     return this.endpoint;
   }
 }
+
+/**
+ * Configuration for creating an ORM client.
+ * Either provide endpoint (and optional headers) for HTTP requests,
+ * or provide a custom adapter for alternative execution strategies.
+ */
+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;
+}
+
+/**
+ * Error thrown when GraphQL request fails
+ */
+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?.() ?? '';
+  }
+}
 `;
     return {
         fileName: 'client.ts',
@@ -359,11 +421,12 @@ function generateCreateClientFile(tables, hasCustomQueries, hasCustomMutations)
         statements.push(createImportDeclaration('./mutation', ['createMutationOperations']));
     }
     // Re-export types and classes
-    // export type { OrmClientConfig, QueryResult, GraphQLError } from './client';
+    // export type { OrmClientConfig, QueryResult, GraphQLError, GraphQLAdapter } from './client';
     const typeExportDecl = t.exportNamedDeclaration(null, [
         t.exportSpecifier(t.identifier('OrmClientConfig'), t.identifier('OrmClientConfig')),
         t.exportSpecifier(t.identifier('QueryResult'), t.identifier('QueryResult')),
         t.exportSpecifier(t.identifier('GraphQLError'), t.identifier('GraphQLError')),
+        t.exportSpecifier(t.identifier('GraphQLAdapter'), t.identifier('GraphQLAdapter')),
     ], t.stringLiteral('./client'));
     typeExportDecl.exportKind = 'type';
     statements.push(typeExportDecl);
@@ -377,6 +440,20 @@ function generateCreateClientFile(tables, hasCustomQueries, hasCustomMutations)
     ], t.stringLiteral('./query-builder')));
     // export * from './select-types';
     statements.push(t.exportAllDeclaration(t.stringLiteral('./select-types')));
+    // Re-export all models for backwards compatibility
+    // export * from './models';
+    statements.push(t.exportAllDeclaration(t.stringLiteral('./models')));
+    // Re-export custom operations for backwards compatibility
+    if (hasCustomQueries) {
+        statements.push(t.exportNamedDeclaration(null, [
+            t.exportSpecifier(t.identifier('createQueryOperations'), t.identifier('createQueryOperations')),
+        ], t.stringLiteral('./query')));
+    }
+    if (hasCustomMutations) {
+        statements.push(t.exportNamedDeclaration(null, [
+            t.exportSpecifier(t.identifier('createMutationOperations'), t.identifier('createMutationOperations')),
+        ], t.stringLiteral('./mutation')));
+    }
     // Build the return object properties
     const returnProperties = [];
     for (const table of tables) {

package/cli/codegen/orm/client.d.ts

@@ -7,10 +7,6 @@
  *
  * @internal This file is NOT part of the generated output
  */
-export interface OrmClientConfig {
-    endpoint: string;
-    headers?: Record<string, string>;
-}
 export interface GraphQLError {
     message: string;
     locations?: {
@@ -20,11 +16,6 @@ export interface GraphQLError {
     path?: (string | number)[];
     extensions?: Record<string, unknown>;
 }
-export declare class GraphQLRequestError extends Error {
-    readonly errors: GraphQLError[];
-    readonly data: unknown;
-    constructor(errors: GraphQLError[], data?: unknown);
-}
 export type QueryResult<T> = {
     ok: true;
     data: T;
@@ -34,9 +25,44 @@ export type QueryResult<T> = {
     data: null;
     errors: GraphQLError[];
 };
-export declare class OrmClient {
+/**
+ * Pluggable adapter interface for GraphQL execution.
+ * Implement this interface to provide custom execution logic (e.g., for testing).
+ */
+export interface GraphQLAdapter {
+    execute<T>(document: string, variables?: Record<string, unknown>): Promise<QueryResult<T>>;
+    setHeaders?(headers: Record<string, string>): void;
+    getEndpoint?(): string;
+}
+/**
+ * Default adapter that uses fetch for HTTP requests.
+ */
+export declare class FetchAdapter implements GraphQLAdapter {
     private endpoint;
     private headers;
+    constructor(endpoint: string, headers?: Record<string, string>);
+    execute<T>(document: string, variables?: Record<string, unknown>): Promise<QueryResult<T>>;
+    setHeaders(headers: Record<string, string>): void;
+    getEndpoint(): string;
+}
+/**
+ * Configuration for creating an ORM client.
+ */
+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;
+}
+export declare class GraphQLRequestError extends Error {
+    readonly errors: GraphQLError[];
+    readonly data: unknown;
+    constructor(errors: GraphQLError[], data?: unknown);
+}
+export declare class OrmClient {
+    private adapter;
     constructor(config: OrmClientConfig);
     execute<T>(document: string, variables?: Record<string, unknown>): Promise<QueryResult<T>>;
     setHeaders(headers: Record<string, string>): void;

package/cli/codegen/orm/client.js

@@ -9,25 +9,16 @@
  * @internal This file is NOT part of the generated output
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OrmClient = exports.GraphQLRequestError = void 0;
-class GraphQLRequestError extends Error {
-    errors;
-    data;
-    constructor(errors, data = null) {
-        const messages = errors.map((e) => e.message).join('; ');
-        super(`GraphQL Error: ${messages}`);
-        this.errors = errors;
-        this.data = data;
-        this.name = 'GraphQLRequestError';
-    }
-}
-exports.GraphQLRequestError = GraphQLRequestError;
-class OrmClient {
+exports.OrmClient = exports.GraphQLRequestError = exports.FetchAdapter = void 0;
+/**
+ * Default adapter that uses fetch for HTTP requests.
+ */
+class FetchAdapter {
     endpoint;
     headers;
-    constructor(config) {
-        this.endpoint = config.endpoint;
-        this.headers = config.headers ?? {};
+    constructor(endpoint, headers) {
+        this.endpoint = endpoint;
+        this.headers = headers ?? {};
     }
     async execute(document, variables) {
         const response = await fetch(this.endpoint, {
@@ -70,4 +61,42 @@ class OrmClient {
         return this.endpoint;
     }
 }
+exports.FetchAdapter = FetchAdapter;
+class GraphQLRequestError extends Error {
+    errors;
+    data;
+    constructor(errors, data = null) {
+        const messages = errors.map((e) => e.message).join('; ');
+        super(`GraphQL Error: ${messages}`);
+        this.errors = errors;
+        this.data = data;
+        this.name = 'GraphQLRequestError';
+    }
+}
+exports.GraphQLRequestError = GraphQLRequestError;
+class OrmClient {
+    adapter;
+    constructor(config) {
+        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(document, variables) {
+        return this.adapter.execute(document, variables);
+    }
+    setHeaders(headers) {
+        if (this.adapter.setHeaders) {
+            this.adapter.setHeaders(headers);
+        }
+    }
+    getEndpoint() {
+        return this.adapter.getEndpoint?.() ?? '';
+    }
+}
 exports.OrmClient = OrmClient;

package/esm/cli/codegen/orm/client-generator.js

@@ -16,11 +16,6 @@ export function generateOrmClientFile() {
  * DO NOT EDIT - changes will be overwritten
  */
 
-export interface OrmClientConfig {
-  endpoint: string;
-  headers?: Record<string, string>;
-}
-
 export interface GraphQLError {
   message: string;
   locations?: { line: number; column: number }[];
@@ -28,20 +23,6 @@ export interface GraphQLError {
   extensions?: Record<string, unknown>;
 }
 
-/**
- * Error thrown when GraphQL request fails
- */
-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';
-  }
-}
-
 /**
  * Discriminated union for query results
  * Use .ok to check success, or use .unwrap() to get data or throw
@@ -51,21 +32,36 @@ export type QueryResult<T> =
   | { ok: false; data: null; errors: GraphQLError[] };
 
 /**
- * Legacy QueryResult type for backwards compatibility
- * @deprecated Use QueryResult discriminated union instead
+ * Pluggable adapter interface for GraphQL execution.
+ * Implement this interface to provide custom execution logic (e.g., for testing).
  */
-export interface LegacyQueryResult<T> {
-  data: T | null;
-  errors?: GraphQLError[];
+export interface GraphQLAdapter {
+  /**
+   * Execute a GraphQL operation and return the result.
+   */
+  execute<T>(document: string, variables?: Record<string, unknown>): Promise<QueryResult<T>>;
+  /**
+   * Set headers for requests (optional - only implement if adapter supports headers).
+   */
+  setHeaders?(headers: Record<string, string>): void;
+  /**
+   * Get the endpoint URL (optional - only implement if adapter has an endpoint).
+   */
+  getEndpoint?(): string;
 }
 
-export class OrmClient {
-  private endpoint: string;
+/**
+ * Default adapter that uses fetch for HTTP requests.
+ * This is used when no custom adapter is provided.
+ */
+export class FetchAdapter implements GraphQLAdapter {
   private headers: Record<string, string>;
 
-  constructor(config: OrmClientConfig) {
-    this.endpoint = config.endpoint;
-    this.headers = config.headers ?? {};
+  constructor(
+    private endpoint: string,
+    headers?: Record<string, string>
+  ) {
+    this.headers = headers ?? {};
   }
 
   async execute<T>(
@@ -98,7 +94,6 @@ export class OrmClient {
       errors?: GraphQLError[];
     };
 
-    // Return discriminated union based on presence of errors
     if (json.errors && json.errors.length > 0) {
       return {
         ok: false,
@@ -122,6 +117,73 @@ export class OrmClient {
     return this.endpoint;
   }
 }
+
+/**
+ * Configuration for creating an ORM client.
+ * Either provide endpoint (and optional headers) for HTTP requests,
+ * or provide a custom adapter for alternative execution strategies.
+ */
+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;
+}
+
+/**
+ * Error thrown when GraphQL request fails
+ */
+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?.() ?? '';
+  }
+}
 `;
     return {
         fileName: 'client.ts',
@@ -320,11 +382,12 @@ export function generateCreateClientFile(tables, hasCustomQueries, hasCustomMuta
         statements.push(createImportDeclaration('./mutation', ['createMutationOperations']));
     }
     // Re-export types and classes
-    // export type { OrmClientConfig, QueryResult, GraphQLError } from './client';
+    // export type { OrmClientConfig, QueryResult, GraphQLError, GraphQLAdapter } from './client';
     const typeExportDecl = t.exportNamedDeclaration(null, [
         t.exportSpecifier(t.identifier('OrmClientConfig'), t.identifier('OrmClientConfig')),
         t.exportSpecifier(t.identifier('QueryResult'), t.identifier('QueryResult')),
         t.exportSpecifier(t.identifier('GraphQLError'), t.identifier('GraphQLError')),
+        t.exportSpecifier(t.identifier('GraphQLAdapter'), t.identifier('GraphQLAdapter')),
     ], t.stringLiteral('./client'));
     typeExportDecl.exportKind = 'type';
     statements.push(typeExportDecl);
@@ -338,6 +401,20 @@ export function generateCreateClientFile(tables, hasCustomQueries, hasCustomMuta
     ], t.stringLiteral('./query-builder')));
     // export * from './select-types';
     statements.push(t.exportAllDeclaration(t.stringLiteral('./select-types')));
+    // Re-export all models for backwards compatibility
+    // export * from './models';
+    statements.push(t.exportAllDeclaration(t.stringLiteral('./models')));
+    // Re-export custom operations for backwards compatibility
+    if (hasCustomQueries) {
+        statements.push(t.exportNamedDeclaration(null, [
+            t.exportSpecifier(t.identifier('createQueryOperations'), t.identifier('createQueryOperations')),
+        ], t.stringLiteral('./query')));
+    }
+    if (hasCustomMutations) {
+        statements.push(t.exportNamedDeclaration(null, [
+            t.exportSpecifier(t.identifier('createMutationOperations'), t.identifier('createMutationOperations')),
+        ], t.stringLiteral('./mutation')));
+    }
     // Build the return object properties
     const returnProperties = [];
     for (const table of tables) {

package/esm/cli/codegen/orm/client.d.ts

@@ -7,10 +7,6 @@
  *
  * @internal This file is NOT part of the generated output
  */
-export interface OrmClientConfig {
-    endpoint: string;
-    headers?: Record<string, string>;
-}
 export interface GraphQLError {
     message: string;
     locations?: {
@@ -20,11 +16,6 @@ export interface GraphQLError {
     path?: (string | number)[];
     extensions?: Record<string, unknown>;
 }
-export declare class GraphQLRequestError extends Error {
-    readonly errors: GraphQLError[];
-    readonly data: unknown;
-    constructor(errors: GraphQLError[], data?: unknown);
-}
 export type QueryResult<T> = {
     ok: true;
     data: T;
@@ -34,9 +25,44 @@ export type QueryResult<T> = {
     data: null;
     errors: GraphQLError[];
 };
-export declare class OrmClient {
+/**
+ * Pluggable adapter interface for GraphQL execution.
+ * Implement this interface to provide custom execution logic (e.g., for testing).
+ */
+export interface GraphQLAdapter {
+    execute<T>(document: string, variables?: Record<string, unknown>): Promise<QueryResult<T>>;
+    setHeaders?(headers: Record<string, string>): void;
+    getEndpoint?(): string;
+}
+/**
+ * Default adapter that uses fetch for HTTP requests.
+ */
+export declare class FetchAdapter implements GraphQLAdapter {
     private endpoint;
     private headers;
+    constructor(endpoint: string, headers?: Record<string, string>);
+    execute<T>(document: string, variables?: Record<string, unknown>): Promise<QueryResult<T>>;
+    setHeaders(headers: Record<string, string>): void;
+    getEndpoint(): string;
+}
+/**
+ * Configuration for creating an ORM client.
+ */
+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;
+}
+export declare class GraphQLRequestError extends Error {
+    readonly errors: GraphQLError[];
+    readonly data: unknown;
+    constructor(errors: GraphQLError[], data?: unknown);
+}
+export declare class OrmClient {
+    private adapter;
     constructor(config: OrmClientConfig);
     execute<T>(document: string, variables?: Record<string, unknown>): Promise<QueryResult<T>>;
     setHeaders(headers: Record<string, string>): void;

package/esm/cli/codegen/orm/client.js

@@ -7,23 +7,15 @@
  *
  * @internal This file is NOT part of the generated output
  */
-export class GraphQLRequestError extends Error {
-    errors;
-    data;
-    constructor(errors, data = null) {
-        const messages = errors.map((e) => e.message).join('; ');
-        super(`GraphQL Error: ${messages}`);
-        this.errors = errors;
-        this.data = data;
-        this.name = 'GraphQLRequestError';
-    }
-}
-export class OrmClient {
+/**
+ * Default adapter that uses fetch for HTTP requests.
+ */
+export class FetchAdapter {
     endpoint;
     headers;
-    constructor(config) {
-        this.endpoint = config.endpoint;
-        this.headers = config.headers ?? {};
+    constructor(endpoint, headers) {
+        this.endpoint = endpoint;
+        this.headers = headers ?? {};
     }
     async execute(document, variables) {
         const response = await fetch(this.endpoint, {
@@ -66,3 +58,39 @@ export class OrmClient {
         return this.endpoint;
     }
 }
+export class GraphQLRequestError extends Error {
+    errors;
+    data;
+    constructor(errors, data = null) {
+        const messages = errors.map((e) => e.message).join('; ');
+        super(`GraphQL Error: ${messages}`);
+        this.errors = errors;
+        this.data = data;
+        this.name = 'GraphQLRequestError';
+    }
+}
+export class OrmClient {
+    adapter;
+    constructor(config) {
+        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(document, variables) {
+        return this.adapter.execute(document, variables);
+    }
+    setHeaders(headers) {
+        if (this.adapter.setHeaders) {
+            this.adapter.setHeaders(headers);
+        }
+    }
+    getEndpoint() {
+        return this.adapter.getEndpoint?.() ?? '';
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructive-io/graphql-codegen",
-  "version": "2.28.4",
+  "version": "2.29.0",
   "description": "CLI-based GraphQL SDK generator for PostGraphile endpoints with React Query hooks",
   "keywords": [
     "graphql",
@@ -89,5 +89,5 @@
     "tsx": "^4.21.0",
     "typescript": "^5.9.3"
   },
-  "gitHead": "13c6cd90521b5521a7219ce270e1b4dd979652cf"
+  "gitHead": "17c82525efb87a39529a02bf24c096bf75597fae"
 }