fix(graphql-server): restore ApiOptions type for api middleware

Author: pyramation

graphql/server/src/middleware/api.ts

@@ -1,15 +1,14 @@
 import { getNodeEnv } from '@pgpmjs/env';
 import { Logger } from '@pgpmjs/logger';
 import { svcCache } from '@pgpmjs/server-utils';
-import type { ConstructiveOptions } from '@constructive-io/graphql-types';
 import { parseUrl } from '@constructive-io/url-domains';
 import { NextFunction, Request, Response } from 'express';
 import { Pool } from 'pg';
 import { getPgPool } from 'pg-cache';
 
 import errorPage50x from '../errors/50x';
 import errorPage404Message from '../errors/404-message';
-import { ApiConfigResult, ApiError, ApiStructure, RlsModule } from '../types';
+import { ApiConfigResult, ApiError, ApiOptions, ApiStructure, RlsModule } from '../types';
 import './types';
 
 const log = new Logger('api');
@@ -123,7 +122,7 @@ interface ApiListRow {
 }
 
 interface ResolveContext {
-  opts: ConstructiveOptions;
+  opts: ApiOptions;
   pool: Pool;
   domain: string;
   subdomain: string | null;
@@ -167,7 +166,7 @@ export const getSubdomain = (subdomains: string[]): string | null => {
   return filtered.length ? filtered.join('.') : null;
 };
 
-export const getSvcKey = (opts: ConstructiveOptions, req: Request): string => {
+export const getSvcKey = (opts: ApiOptions, req: Request): string => {
   const { domain, subdomains } = getUrlDomains(req);
   const baseKey = subdomains.filter((n) => n !== 'www').concat(domain).join('.');
 
@@ -196,7 +195,7 @@ const toRlsModule = (row: RlsModuleRow | null): RlsModule | undefined => {
   };
 };
 
-const toApiStructure = (row: ApiRow, opts: ConstructiveOptions, rlsModuleRow?: RlsModuleRow | null): ApiStructure => ({
+const toApiStructure = (row: ApiRow, opts: ApiOptions, rlsModuleRow?: RlsModuleRow | null): ApiStructure => ({
   apiId: row.api_id,
   dbname: row.dbname || opts.pg?.database || '',
   anonRole: row.anon_role || 'anon',
@@ -210,7 +209,7 @@ const toApiStructure = (row: ApiRow, opts: ConstructiveOptions, rlsModuleRow?: R
 });
 
 const createAdminStructure = (
-  opts: ConstructiveOptions,
+  opts: ApiOptions,
   schemas: string[],
   databaseId?: string
 ): ApiStructure => ({
@@ -409,7 +408,7 @@ const buildDevFallbackError = async (
 // =============================================================================
 
 export const getApiConfig = async (
-  opts: ConstructiveOptions,
+  opts: ApiOptions,
   req: Request
 ): Promise<ApiConfigResult> => {
   const pool = getPgPool(opts.pg);
@@ -501,7 +500,7 @@ export const getApiConfig = async (
 // Express Middleware
 // =============================================================================
 
-export const createApiMiddleware = (opts: ConstructiveOptions) => {
+export const createApiMiddleware = (opts: ApiOptions) => {
   return async (req: Request, res: Response, next: NextFunction): Promise<void> => {
     log.debug(`[api-middleware] ${req.method} ${req.path}`);
 

graphql/server/src/types.ts

@@ -1,3 +1,6 @@
+import type { PgpmOptions } from '@pgpmjs/types';
+import type { ApiOptions as ApiConfig } from '@constructive-io/graphql-types';
+
 export interface CorsModuleData {
   urls: string[];
 }
@@ -43,3 +46,5 @@ export interface ApiStructure {
 
 export type ApiError = { errorHtml: string };
 export type ApiConfigResult = ApiStructure | ApiError | null;
+
+export type ApiOptions = PgpmOptions & { api?: ApiConfig };