@constructive-io/graphql-types 2.13.0 → 2.14.0

package/adapter.d.ts

@@ -0,0 +1,69 @@
+/**
+ * GraphQL Adapter Types
+ *
+ * These types define the interface for GraphQL execution adapters,
+ * allowing different execution strategies (HTTP fetch, direct query, etc.)
+ * to be used with the generated ORM client.
+ */
+/**
+ * GraphQL error structure
+ */
+export interface GraphQLError {
+    message: string;
+    locations?: Array<{
+        line: number;
+        column: number;
+    }>;
+    path?: Array<string | number>;
+    extensions?: Record<string, unknown>;
+}
+/**
+ * Discriminated union result type for GraphQL operations.
+ * Either succeeds with data or fails with errors.
+ */
+export type QueryResult<T> = {
+    ok: true;
+    data: T;
+    errors: undefined;
+} | {
+    ok: false;
+    data: null;
+    errors: GraphQLError[];
+};
+/**
+ * Interface for GraphQL execution adapters.
+ * Implement this interface to create custom execution strategies.
+ *
+ * @example
+ * ```typescript
+ * // HTTP adapter (default)
+ * class FetchAdapter implements GraphQLAdapter {
+ *   async execute<T>(document: string, variables?: Record<string, unknown>): Promise<QueryResult<T>> {
+ *     const response = await fetch(this.endpoint, { ... });
+ *     // ...
+ *   }
+ * }
+ *
+ * // Test adapter
+ * class TestAdapter implements GraphQLAdapter {
+ *   async execute<T>(document: string, variables?: Record<string, unknown>): Promise<QueryResult<T>> {
+ *     const result = await this.queryFn(document, variables);
+ *     // ...
+ *   }
+ * }
+ * ```
+ */
+export interface GraphQLAdapter {
+    /**
+     * Execute a GraphQL operation
+     */
+    execute<T>(document: string, variables?: Record<string, unknown>): Promise<QueryResult<T>>;
+    /**
+     * Set headers for the adapter (optional, primarily for HTTP adapters)
+     */
+    setHeaders?(headers: Record<string, string>): void;
+    /**
+     * Get the endpoint URL (optional, primarily for HTTP adapters)
+     */
+    getEndpoint?(): string;
+}

package/adapter.js

@@ -0,0 +1,9 @@
+"use strict";
+/**
+ * GraphQL Adapter Types
+ *
+ * These types define the interface for GraphQL execution adapters,
+ * allowing different execution strategies (HTTP fetch, direct query, etc.)
+ * to be used with the generated ORM client.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/esm/adapter.js

@@ -0,0 +1,8 @@
+/**
+ * GraphQL Adapter Types
+ *
+ * These types define the interface for GraphQL execution adapters,
+ * allowing different execution strategies (HTTP fetch, direct query, etc.)
+ * to be used with the generated ORM client.
+ */
+export {};

package/index.d.ts

@@ -1,3 +1,4 @@
 export * from '@pgpmjs/types';
 export { GraphileOptions, GraphileFeatureOptions, ApiOptions, graphileDefaults, graphileFeatureDefaults, apiDefaults } from './graphile';
 export { ConstructiveGraphQLOptions, ConstructiveOptions, constructiveGraphqlDefaults, constructiveDefaults } from './constructive';
+export { GraphQLAdapter, GraphQLError, QueryResult } from './adapter';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructive-io/graphql-types",
-  "version": "2.13.0",
+  "version": "2.14.0",
   "author": "Constructive <developers@constructive.io>",
   "description": "Constructive GraphQL/Graphile types for PostGraphile integration",
   "main": "index.js",
@@ -46,5 +46,5 @@
   "devDependencies": {
     "makage": "^0.1.10"
   },
-  "gitHead": "481b3a50b4eec2da6b376c4cd1868065e1e28edb"
+  "gitHead": "0f129a3a6f3e939d2c8c0597a9f3a689442b3dcc"
 }