@platformatic/gateway 3.45.0 → 3.47.0

package/config.d.ts

@@ -253,6 +253,7 @@ export interface PlatformaticGatewayConfig {
             upstream?: string;
             prefix?: string;
             rewritePrefix?: string;
+            rewriteLocationHeader?: boolean;
             hostname?: string;
             custom?: {
               path: string;

package/index.d.ts

@@ -3,13 +3,22 @@ import { Configuration, ConfigurationOptions } from '@platformatic/foundation'
 import {
   ServiceCapability,
   Generator as ServiceGenerator,
-  PlatformaticServiceConfig,
   ServerInstance as ServiceServerInstance
 } from '@platformatic/service'
 import { JSONSchemaType } from 'ajv'
 import { FastifyError, FastifyInstance } from 'fastify'
 import type { PlatformaticGatewayConfig } from './config.d.ts'
 
+export interface GatewayCommand {
+  usage: string
+  description: string
+}
+
+export interface GatewayCommandDefinition {
+  commands: Record<string, (...args: unknown[]) => Promise<void> | void>
+  help: Record<string, GatewayCommand>
+}
+
 export type { PlatformaticServiceConfig } from '@platformatic/service'
 export type { PlatformaticGatewayConfig } from './config.d.ts'
 
@@ -20,19 +29,21 @@ export type ServerInstance = ServiceServerInstance<PlatformaticGatewayConfig>
 type GatewayConfiguration = Configuration<PlatformaticGatewayConfig>
 
 export declare function loadConfiguration (
-  root: string | PlatformaticServiceConfig,
-  source?: string | PlatformaticServiceConfig,
+  root: string | PlatformaticGatewayConfig,
+  source?: string | PlatformaticGatewayConfig,
   context?: ConfigurationOptions
 ): Promise<GatewayConfiguration>
 
 export function create (
-  root: string,
+  root: string | PlatformaticGatewayConfig,
   source?: string | PlatformaticGatewayConfig,
   context?: ConfigurationOptions
 ): Promise<GatewayCapability>
 
 export declare function platformaticGateway (app: FastifyInstance, capability: BaseCapability): Promise<void>
 
+export declare function createCommands (id: string): GatewayCommandDefinition
+
 export class Generator extends ServiceGenerator {}
 
 export declare const packageJson: Record<string, unknown>
@@ -44,15 +55,19 @@ export declare const schemaComponents: {
   entityResolver: JSONSchemaType<object>
   entities: JSONSchemaType<object>
   graphqlApplication: JSONSchemaType<object>
-  graphqlGatewayOptions: JSONSchemaType<object>
+  graphqlComposerOptions: JSONSchemaType<object>
   gateway: JSONSchemaType<object>
   types: JSONSchemaType<object>
 }
 
+export declare const skipTelemetryHooks: boolean
+
 export declare const version: string
 
-export function FastifyInstanceIsAlreadyListeningError (): FastifyError
-export function FailedToFetchOpenAPISchemaError (): FastifyError
-export function ValidationErrors (): FastifyError
-export function PathAlreadyExistsError (): FastifyError
-export function CouldNotReadOpenAPIConfigError (): FastifyError
+export namespace errors {
+  export const FastifyInstanceIsAlreadyListeningError: () => FastifyError
+  export const FailedToFetchOpenAPISchemaError: () => FastifyError
+  export const ValidationErrors: () => FastifyError
+  export const PathAlreadyExistsError: () => FastifyError
+  export const CouldNotReadOpenAPIConfigError: () => FastifyError
+}

package/lib/capability.js

@@ -41,8 +41,13 @@ export class GatewayCapability extends ServiceCapability {
 
     const url = await super.start()
 
-    this.#runtimeEventHandler = this.#handleRuntimeEvent.bind(this)
-    globalThis[kITC]?.on('runtime:event', this.#runtimeEventHandler)
+    // Only register the runtime event handler once. start() can be called
+    // multiple times (first with listen:false, then listen:true) so guard
+    // against duplicate registrations.
+    if (!this.#runtimeEventHandler) {
+      this.#runtimeEventHandler = this.#handleRuntimeEvent.bind(this)
+      globalThis[kITC]?.on('runtime:event', this.#runtimeEventHandler)
+    }
 
     return url
   }

package/lib/proxy.js

@@ -50,6 +50,10 @@ async function resolveApplicationProxyParameters (application, root) {
     }
   }
 
+  if (typeof application.proxy?.rewriteLocationHeader === 'boolean') {
+    internalRewriteLocationHeader = application.proxy.rewriteLocationHeader
+  }
+
   const require = createRequire(import.meta.filename)
 
   if (application.proxy?.custom) {

package/lib/schema.js

@@ -150,6 +150,7 @@ export const gateway = {
                   upstream: { type: 'string' },
                   prefix: { type: 'string' },
                   rewritePrefix: { type: 'string' },
+                  rewriteLocationHeader: { type: 'boolean' },
                   hostname: { type: 'string' },
                   custom: {
                     type: 'object',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/gateway",
-  "version": "3.45.0",
+  "version": "3.47.0",
   "description": "",
   "main": "index.js",
   "types": "index.d.ts",
@@ -22,6 +22,7 @@
     "dedent": "^1.5.1",
     "eslint": "9",
     "json-schema-to-typescript": "^15.0.0",
+    "tstyche": "^6.2.0",
     "neostandard": "^0.12.0",
     "openapi-schema-validator": "^12.1.3",
     "pino-test": "^1.0.1",
@@ -32,7 +33,7 @@
     "typescript": "^5.5.4",
     "why-is-node-running": "2",
     "ws": "^8.16.0",
-    "@platformatic/db": "3.45.0"
+    "@platformatic/db": "3.47.0"
   },
   "dependencies": {
     "@fastify/error": "^4.0.0",
@@ -63,17 +64,18 @@
     "rfdc": "^1.3.1",
     "semgrator": "^0.3.0",
     "undici": "^7.0.0",
-    "@platformatic/basic": "3.45.0",
-    "@platformatic/foundation": "^3.45.0",
-    "@platformatic/scalar-theme": "3.45.0",
-    "@platformatic/service": "3.45.0",
-    "@platformatic/telemetry": "3.45.0"
+    "@platformatic/basic": "3.47.0",
+    "@platformatic/foundation": "^3.47.0",
+    "@platformatic/service": "3.47.0",
+    "@platformatic/telemetry": "3.47.0",
+    "@platformatic/scalar-theme": "3.47.0"
   },
   "engines": {
     "node": ">=22.19.0"
   },
   "scripts": {
-    "test": "node --test --test-reporter=cleaner-spec-reporter --test-concurrency=1 --test-timeout=2000000 test/*.test.js test/**/*.test.js",
+    "test": "npm run test:types && node --test --test-reporter=cleaner-spec-reporter --test-concurrency=1 --test-timeout=2000000 test/*.test.js test/**/*.test.js",
+    "test:types": "tstyche",
     "gen-schema": "node lib/schema.js > schema.json",
     "gen-types": "json2ts > config.d.ts < schema.json",
     "build": "npm run gen-schema && npm run gen-types",

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/gateway/3.45.0.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/gateway/3.47.0.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "Platformatic Gateway Config",
   "type": "object",
@@ -840,6 +840,9 @@
                       "rewritePrefix": {
                         "type": "string"
                       },
+                      "rewriteLocationHeader": {
+                        "type": "boolean"
+                      },
                       "hostname": {
                         "type": "string"
                       },