@openapi-typescript-infra/service 4.0.0 → 4.1.1

package/build/types.d.ts

@@ -17,10 +17,15 @@ export type ServiceLogger = pino.BaseLogger & Pick<pino.Logger, 'isLevelEnabled'
 export interface ServiceLocals<Config extends ConfigurationSchema = ConfigurationSchema> {
     service: Service;
     name: string;
+    version: string;
     logger: ServiceLogger;
     config: Config;
     meter: Meter;
     internalApp: Application<InternalLocals<this>>;
+    /**
+     * This is the parsed OpenAPI spec we are hosting (if openapi is enabled)
+     */
+    openApiSpecification?: ReturnType<typeof JSON.parse>;
 }
 export interface RequestLocals {
     rawBody?: Buffer | true;
@@ -49,6 +54,7 @@ export interface Service<SLocals extends AnyServiceLocals = ServiceLocals<Config
 export type ServiceFactory<SLocals extends AnyServiceLocals = ServiceLocals<ConfigurationSchema>, RLocals extends RequestLocals = RequestLocals> = () => Service<SLocals, RLocals>;
 export interface ServiceStartOptions<SLocals extends AnyServiceLocals = ServiceLocals<ConfigurationSchema>, RLocals extends RequestLocals = RequestLocals> {
     name: string;
+    version: string;
     rootDirectory: string;
     codepath?: 'build' | 'src' | 'dist';
     locals?: Partial<SLocals>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openapi-typescript-infra/service",
-  "version": "4.0.0",
+  "version": "4.1.1",
   "description": "An opinionated framework for building configuration driven services - web, api, or  ob. Uses OpenAPI, pino logging, express, confit, Typescript and vitest.",
   "main": "build/index.js",
   "scripts": {

package/src/bootstrap.ts

@@ -25,6 +25,8 @@ interface BootstrapArguments {
   telemetry?: boolean;
   // Don't bind to http port or expose metrics
   nobind?: boolean;
+  // The version of the app, else discovered via read-pkg-up
+  version?: string;
 }
 
 function resolveMain(packageJson: NormalizedPackageJson) {
@@ -39,6 +41,7 @@ async function getServiceDetails(argv: BootstrapArguments = {}) {
     return {
       rootDirectory: argv.root,
       name: argv.name,
+      version: argv.version || '0.0.0',
       main: argv.main || (isDev() && !argv.built ? 'src/index.ts' : 'build/index.js'),
     };
   }
@@ -55,6 +58,7 @@ async function getServiceDetails(argv: BootstrapArguments = {}) {
     main,
     rootDirectory: path.dirname(pkg.path),
     name: parts[parts.length - 1],
+    version: pkg.packageJson.version,
   };
 }
 
@@ -72,7 +76,7 @@ export async function bootstrap<
   SLocals extends AnyServiceLocals = ServiceLocals<ConfigurationSchema>,
   RLocals extends RequestLocals = RequestLocals,
 >(argv?: BootstrapArguments) {
-  const { main, rootDirectory, name } = await getServiceDetails(argv);
+  const { main, rootDirectory, name, version } = await getServiceDetails(argv);
 
   let entrypoint: string;
   let codepath: 'build' | 'dist' | 'src' = 'build';
@@ -107,6 +111,7 @@ export async function bootstrap<
       rootDirectory,
       service: absoluteEntrypoint,
       codepath,
+      version,
     });
   }
 
@@ -115,6 +120,7 @@ export async function bootstrap<
   const impl = require(absoluteEntrypoint);
   const opts: ServiceStartOptions<SLocals, RLocals> = {
     name,
+    version,
     rootDirectory,
     service: impl.default || impl.service,
     codepath,

package/src/express-app/app.ts

@@ -45,7 +45,7 @@ export async function startApp<
   SLocals extends AnyServiceLocals = ServiceLocals<ConfigurationSchema>,
   RLocals extends RequestLocals = RequestLocals,
 >(startOptions: ServiceStartOptions<SLocals, RLocals>): Promise<ServiceExpress<SLocals>> {
-  const { service, rootDirectory, codepath = 'build', name } = startOptions;
+  const { service, rootDirectory, codepath = 'build', name, version } = startOptions;
   const shouldPrettyPrint = isDev() && !process.env.NO_PRETTY_LOGS;
   const destination = pino.destination({
     sync: isSyncLogging(),
@@ -99,11 +99,12 @@ export async function startApp<
     app.disable('etag');
   }
 
-  Object.assign(app.locals, { services: {} }, startOptions.locals, {
+  Object.assign(app.locals, startOptions.locals, {
     service: serviceImpl,
     logger,
     config,
     name,
+    version,
   });
 
   if (serviceImpl.attach) {
@@ -360,6 +361,12 @@ export async function listen<SLocals extends AnyServiceLocals = ServiceLocals<Co
             } else {
               locals.logger.info('No metrics will be exported');
             }
+            if (app.locals.openApiSpecification) {
+              locals.internalApp.get('/api-docs/openapi.json', (req, res) => {
+                res.json(app.locals.openApiSpecification);
+              });
+              locals.logger.info('OpenAPI specification available at /api-docs/openapi.json');
+            }
             accept();
           })
           .catch((error) => {

package/src/openapi.ts

@@ -2,6 +2,7 @@ import path from 'path';
 
 import _ from 'lodash';
 import * as OpenApiValidator from 'express-openapi-validator';
+import { OpenAPIFramework } from 'express-openapi-validator/dist/framework/index';
 import type { Handler } from 'express';
 
 import type { AnyServiceLocals, ServiceExpress, ServiceLocals } from './types';
@@ -64,6 +65,12 @@ export async function openApi<
     {} as Record<string, Record<string, unknown>>,
   );
 
+  app.locals.openApiSpecification = await new OpenAPIFramework({ apiDoc: apiSpec })
+    .initialize({ visitApi() {} })
+    .catch((error) => {
+      app.locals.logger.error(error, 'Failed to parse and load OpenAPI spec');
+    });
+
   const defaultOptions: OAPIOpts = {
     apiSpec,
     ignoreUndocumented: true,

package/src/types.ts

@@ -24,10 +24,15 @@ export type ServiceLogger = pino.BaseLogger & Pick<pino.Logger, 'isLevelEnabled'
 export interface ServiceLocals<Config extends ConfigurationSchema = ConfigurationSchema> {
   service: Service;
   name: string;
+  version: string;
   logger: ServiceLogger;
   config: Config;
   meter: Meter;
   internalApp: Application<InternalLocals<this>>;
+  /**
+   * This is the parsed OpenAPI spec we are hosting (if openapi is enabled)
+   */
+  openApiSpecification?: ReturnType<typeof JSON.parse>;
 }
 
 export interface RequestLocals {
@@ -111,6 +116,7 @@ export interface ServiceStartOptions<
   RLocals extends RequestLocals = RequestLocals,
 > {
   name: string;
+  version: string;
   rootDirectory: string;
 
   // Defaults to "build", but can be set to "src" to run off non-built source