graphql-server-test 0.3.0 → 0.4.0

package/README.md

@@ -157,14 +157,73 @@ it('matches snapshot', async () => {
 
 ### GetConnectionsInput
 
-| Option | Type | Description |
-|--------|------|-------------|
-| `schemas` | `string[]` | PostgreSQL schemas to expose in GraphQL |
-| `authRole` | `string` | Default role for anonymous requests |
-| `useRoot` | `boolean` | Use root/superuser for queries (bypasses RLS) |
-| `graphile` | `GraphileOptions` | Graphile/PostGraphile configuration |
-| `server.port` | `number` | Port to run the server on (default: random) |
-| `server.host` | `string` | Host to bind the server to (default: localhost) |
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `schemas` | `string[]` | required | PostgreSQL schemas to expose in GraphQL |
+| `authRole` | `string` | - | Default role for anonymous requests |
+| `useRoot` | `boolean` | `false` | Use root/superuser for queries (bypasses RLS) |
+| `graphile` | `GraphileOptions` | - | Graphile/PostGraphile configuration |
+| `server` | `ServerOptions` | - | Server configuration (port, host, and API options) |
+
+### ServerOptions
+
+All server configuration lives under the `server` key:
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `server.port` | `number` | random | Port to run the server on |
+| `server.host` | `string` | `localhost` | Host to bind the server to |
+| `server.api` | `Partial<ApiOptions>` | - | API configuration options (see below) |
+
+### API Options
+
+The `server.api` option provides full control over the GraphQL server configuration. It accepts a partial `ApiOptions` object from `@constructive-io/graphql-types`:
+
+| Property | Type | Default | Description |
+|----------|------|---------|-------------|
+| `enableServicesApi` | `boolean` | package default | Enable domain/subdomain routing via services_public |
+| `exposedSchemas` | `string[]` | from `schemas` | Database schemas to expose (overridden by `schemas`) |
+| `anonRole` | `string` | from `authRole` | Anonymous role name (overridden by `authRole`) |
+| `roleName` | `string` | from `authRole` | Default role name (overridden by `authRole`) |
+| `defaultDatabaseId` | `string` | package default | Default database identifier |
+| `isPublic` | `boolean` | package default | Whether the API is publicly accessible |
+| `metaSchemas` | `string[]` | package default | Schemas containing metadata tables |
+
+The convenience properties (`schemas`, `authRole`) take precedence over corresponding values in `server.api`.
+
+```typescript
+// Basic usage with convenience properties
+const { query } = await getConnections({
+  schemas: ['app_public'],
+  authRole: 'anonymous'
+});
+
+// Disabling Services API for testing (bypasses domain routing)
+const { query } = await getConnections({
+  schemas: ['app_public'],
+  server: {
+    api: {
+      enableServicesApi: false
+    }
+  }
+});
+
+// Full server configuration
+const { query } = await getConnections({
+  schemas: ['app_public'],
+  authRole: 'authenticated',
+  server: {
+    port: 5555,
+    host: 'localhost',
+    api: {
+      enableServicesApi: false,
+      isPublic: false,
+      defaultDatabaseId: 'my-test-db',
+      metaSchemas: ['services_public', 'metaschema_public']
+    }
+  }
+});
+```
 
 ## Comparison with Other Test Packages
 

package/esm/get-connections.js

@@ -35,13 +35,15 @@ export const getConnections = async (input, seedAdapters) => {
     // Get database connections using pgsql-test
     const conn = await getPgConnections(input, seedAdapters);
     const { pg, db, teardown: dbTeardown } = conn;
-    // Build options for the HTTP server with enableServicesApi: false
+    // Build options for the HTTP server
+    // Merge user-provided server.api options with convenience properties (schemas, authRole)
     const serverOpts = getEnvOptions({
         pg: pg.config,
         api: {
-            enableServicesApi: false,
+            // Start with user-provided api options from server.api
+            ...input.server?.api,
+            // Apply convenience properties (these take precedence)
             exposedSchemas: input.schemas,
-            defaultDatabaseId: 'test-database',
             ...(input.authRole && { anonRole: input.authRole, roleName: input.authRole })
         },
         graphile: input.graphile

package/get-connections.js

@@ -38,13 +38,15 @@ const getConnections = async (input, seedAdapters) => {
     // Get database connections using pgsql-test
     const conn = await (0, pgsql_test_1.getConnections)(input, seedAdapters);
     const { pg, db, teardown: dbTeardown } = conn;
-    // Build options for the HTTP server with enableServicesApi: false
+    // Build options for the HTTP server
+    // Merge user-provided server.api options with convenience properties (schemas, authRole)
     const serverOpts = (0, graphql_env_1.getEnvOptions)({
         pg: pg.config,
         api: {
-            enableServicesApi: false,
+            // Start with user-provided api options from server.api
+            ...input.server?.api,
+            // Apply convenience properties (these take precedence)
             exposedSchemas: input.schemas,
-            defaultDatabaseId: 'test-database',
             ...(input.authRole && { anonRole: input.authRole, roleName: input.authRole })
         },
         graphile: input.graphile

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graphql-server-test",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "author": "Constructive <developers@constructive.io>",
   "description": "Constructive GraphQL Server Testing with SuperTest HTTP requests",
   "main": "index.js",
@@ -57,5 +57,5 @@
     "e2e",
     "server"
   ],
-  "gitHead": "03a70081e7a3d761c43432866726ddf641e05531"
+  "gitHead": "2c23de7fdbb836104fc02610d32f7e46c3a87048"
 }

package/types.d.ts

@@ -1,7 +1,7 @@
 import type { Server } from 'http';
 import type { DocumentNode, GraphQLError } from 'graphql';
 import type { PgTestClient } from 'pgsql-test/test-client';
-import type { GraphileOptions } from '@constructive-io/graphql-types';
+import type { GraphileOptions, ApiOptions } from '@constructive-io/graphql-types';
 import type supertest from 'supertest';
 /**
  * Options for creating a test server
@@ -11,6 +11,26 @@ export interface ServerOptions {
     port?: number;
     /** Host to bind the server to (defaults to localhost) */
     host?: string;
+    /**
+     * API configuration options for the GraphQL server.
+     * These options control how the server handles requests and which features are enabled.
+     *
+     * @example
+     * ```typescript
+     * const { query } = await getConnections({
+     *   schemas: ['app_public'],
+     *   server: {
+     *     port: 5555,
+     *     api: {
+     *       enableServicesApi: false,
+     *       isPublic: false,
+     *       defaultDatabaseId: 'my-database'
+     *     }
+     *   }
+     * });
+     * ```
+     */
+    api?: Partial<ApiOptions>;
 }
 /**
  * Server information returned by createTestServer
@@ -41,7 +61,7 @@ export interface GetConnectionsInput {
     authRole?: string;
     /** Graphile/PostGraphile configuration options */
     graphile?: GraphileOptions;
-    /** Server configuration options */
+    /** Server configuration options (port, host, and API configuration) */
     server?: ServerOptions;
 }
 /**