Functions

loadConfig

Signature:

loadConfig(): AppConfig

Returns:

AppConfig -

createServer

Signature:

createServer(options?: ServerOptions): express.Express

Parameters:

Returns:

express.Express -

authMiddleware

Creates authentication middleware that supports two modes:

1. JWT Validation Mode (trustProxyAuth: false):

   • Validates JWT token from Authorization header
   • Extracts user claims from the token
   • Use when service is exposed directly without a gateway

2. Proxy Trust Mode (trustProxyAuth: true):

   • Trusts that an upstream proxy (like Kong) has already validated the JWT
   • Reads user info from headers set by the proxy:
     • x-workspace-id: The user's workspace ID
     • x-user-id: The user's subject/ID
   • Use when behind Kong or similar API gateway that handles JWT validation

Signature:

authMiddleware(options: AuthMiddlewareOptions): (req: Request, res: Response, next: NextFunction) => Response<any, Record<string, any>> | undefined

Parameters:

Returns:

(req: Request, res: Response, next: NextFunction) => Response<any, Record<string, any>> \| undefined -

createDocumentsRouter

Signature:

createDocumentsRouter(options: DocumentsRouterOptions): Router

Parameters:

Returns:

Router -

createGitWatcherRoutes

Create git watcher routes

Signature:

createGitWatcherRoutes(manager: WatcherManager, authOptions: AuthMiddlewareOptions): Router

Parameters:

Returns:

Router -