fix instance app types

Author: ricardo-devis-agullo

packages/oc-fastify-server-adapter/src/index.ts

@@ -95,7 +95,7 @@ type ExpressMiddleware = (
   next: (err?: unknown) => void
 ) => void;
 
-export type HttpServerAdapter = {
+export type HttpServerAdapter<TNative = unknown> = {
   name: string;
   enableBodyParser(opts: { limit?: number | string }): void;
   enableCookies(): void;
@@ -120,7 +120,7 @@ export type HttpServerAdapter = {
   onServerError(cb: (err: Error) => void): void;
   close(cb: (err?: Error) => void): void;
   isListening(): boolean;
-  native(): unknown;
+  native(): TNative;
   httpServer(): http.Server;
 };
 
@@ -150,22 +150,26 @@ type MutableOcRequest = OcRequest & {
   files?: UploadedFile[] | Record<string, UploadedFile[]>;
 };
 
-type FastifyServerAdapterFactory = {
-  (options?: unknown): HttpServerAdapter;
-  readonly __serverAdapterOptions?:
-    | FastifyServerAdapterOptions
-    | number
-    | string;
+export type HttpServerAdapterFactory<TOptions = unknown, TNative = unknown> = {
+  (options?: unknown): HttpServerAdapter<TNative>;
+  readonly __serverAdapterOptions?: TOptions;
 };
 
-const createFastifyAdapter = ((options?: unknown): HttpServerAdapter =>
+type FastifyServerAdapterFactory = HttpServerAdapterFactory<
+  FastifyServerAdapterOptions | number | string,
+  FastifyInstance
+>;
+
+const createFastifyAdapter = ((
+  options?: unknown
+): HttpServerAdapter<FastifyInstance> =>
   new FastifyHttpServerAdapter(
     toFastifyAdapterOptions(options)
   )) as FastifyServerAdapterFactory;
 
 export default createFastifyAdapter;
 
-class FastifyHttpServerAdapter implements HttpServerAdapter {
+class FastifyHttpServerAdapter implements HttpServerAdapter<FastifyInstance> {
   name = 'fastify';
 
   private app: FastifyInstance;

packages/oc-fastify-server-adapter/test/registry-node.ts

@@ -9,19 +9,22 @@ import {
   stat,
   writeFile
 } from 'node:fs/promises';
+import type http from 'node:http';
 import { createServer } from 'node:net';
 import { tmpdir } from 'node:os';
 import path from 'node:path';
 import { promisify } from 'node:util';
+import type { FastifyInstance } from 'fastify';
 import type { RegistryOptions } from '../../oc/dist/registry';
+import type { HttpServerAdapterFactory } from '../../oc/dist/registry/domain/http-server/types';
 import createFastifyAdapter from '..';
 
 type RegistryFactory = typeof import('../../oc/dist/registry').default;
 type StartedRegistry = ReturnType<RegistryFactory>;
 
 type StartedData = {
-  app: unknown;
-  server: { address(): string | { port: number } | null };
+  app: FastifyInstance;
+  server: http.Server;
 };
 
 const Registry = require(path.resolve(__dirname, '../../../oc/dist/registry'))
@@ -44,7 +47,9 @@ type FileStorageOptions = {
   root: string;
 };
 
-const inferRegistryOptions = <T, U>(options: RegistryOptions<T, U>) => options;
+const inferRegistryOptions = <T, U extends HttpServerAdapterFactory>(
+  options: RegistryOptions<T, U>
+) => options;
 const fastifyRegistryOptions = inferRegistryOptions({
   baseUrl: 'http://localhost:3000/',
   server: {
@@ -199,7 +204,7 @@ const startRegistry = async (
     },
     verbosity: 0,
     ...options
-  } as never);
+  });
 
   const data = await new Promise<StartedData>((resolve, reject) => {
     registry.start((err, startData) => {

packages/oc/src/index.ts

@@ -1,12 +1,15 @@
 export { default as Client } from 'oc-client';
 export { default as cli } from './cli/programmatic-api';
+export type { RegistryType } from './registry';
 export { default as Registry, RegistryOptions } from './registry';
 
 export type {
   CookieOptions,
   ExpressMiddleware,
   HttpServerAdapter,
+  HttpServerAdapterFactory,
   Method,
+  NativeApp,
   OcHandler,
   OcRequest,
   OcResponse,

packages/oc/src/registry/domain/http-server/express-adapter.ts

@@ -42,7 +42,7 @@ function normaliseParams(raw: Record<string, unknown>): Record<string, string> {
 
 export default function createExpressAdapter(
   options?: unknown
-): HttpServerAdapter {
+): HttpServerAdapter<Express> {
   const adapterOptions = options as
     | { port?: number | string }
     | number
@@ -53,7 +53,7 @@ export default function createExpressAdapter(
   );
 }
 
-class ExpressHttpServerAdapter implements HttpServerAdapter {
+class ExpressHttpServerAdapter implements HttpServerAdapter<Express> {
   name = 'express';
 
   private app: Express;

packages/oc/src/registry/domain/http-server/types.ts

@@ -1,5 +1,6 @@
 import type http from 'node:http';
 import type { IncomingHttpHeaders } from 'node:http';
+import type express from 'express';
 import type { Config } from '../../../types';
 
 export interface CookieOptions {
@@ -83,8 +84,8 @@ export type ExpressMiddleware = (
   next: (err?: unknown) => void
 ) => void;
 
-export type HttpServerAdapterFactory<TOptions = unknown> = {
-  (options?: unknown): HttpServerAdapter;
+export type HttpServerAdapterFactory<TOptions = unknown, TNative = unknown> = {
+  (options?: unknown): HttpServerAdapter<TNative>;
   readonly __serverAdapterOptions?: TOptions;
 };
 
@@ -96,7 +97,19 @@ export type HttpServerAdapterOptions<TAdapter> = TAdapter extends {
     ? TOptions
     : unknown;
 
-export interface HttpServerAdapter {
+export type NativeApp<TAdapter> = TAdapter extends (
+  ...args: any[]
+) => HttpServerAdapter<infer TNative>
+  ? unknown extends TNative
+    ? express.Express
+    : TNative
+  : TAdapter extends HttpServerAdapter<infer TNative>
+    ? unknown extends TNative
+      ? express.Express
+      : TNative
+    : express.Express;
+
+export interface HttpServerAdapter<TNative = unknown> {
   name: string;
   enableBodyParser(opts: { limit?: number | string }): void;
   enableCookies(): void;
@@ -121,6 +134,6 @@ export interface HttpServerAdapter {
   onServerError(cb: (err: Error) => void): void;
   close(cb: (err?: Error) => void): void;
   isListening(): boolean;
-  native(): unknown;
+  native(): TNative;
   httpServer(): http.Server;
 }

packages/oc/src/registry/index.ts

@@ -1,11 +1,13 @@
 import type http from 'node:http';
 import colors from 'colors/safe';
-import type express from 'express';
 
 import type { Plugin } from '../types';
 import appStart from './app-start';
 import eventsHandler from './domain/events-handler';
-import type { HttpServerAdapterFactory } from './domain/http-server/types';
+import type {
+  HttpServerAdapterFactory,
+  NativeApp
+} from './domain/http-server/types';
 import sanitiseOptions, { RegistryOptions } from './domain/options-sanitiser';
 import * as pluginsInitialiser from './domain/plugins-initialiser';
 import Repository from './domain/repository';
@@ -16,10 +18,24 @@ import { create as createRouter } from './router';
 
 export { RegistryOptions };
 
+export interface RegistryType<TApp = NativeApp<HttpServerAdapterFactory>> {
+  close: (callback: (err?: Error | undefined | string) => void) => void;
+  on: typeof eventsHandler.on;
+  register: <T = any>(
+    plugin: Plugin<T>,
+    callback?: (...args: any[]) => void
+  ) => void;
+  start: (
+    callback: (err: unknown, data?: { app: TApp; server: http.Server }) => void
+  ) => Promise<void>;
+  app: TApp;
+}
+
 export default function registry<
   T = any,
-  TServerAdapter extends HttpServerAdapterFactory = HttpServerAdapterFactory
->(inputOptions: RegistryOptions<T, TServerAdapter>) {
+  TServerAdapter extends HttpServerAdapterFactory = HttpServerAdapterFactory,
+  TApp = NativeApp<TServerAdapter>
+>(inputOptions: RegistryOptions<T, TServerAdapter>): RegistryType<TApp> {
   const validationResult =
     validator.validateRegistryConfiguration(inputOptions);
   if (!validationResult.isValid) {
@@ -32,7 +48,7 @@ export default function registry<
     getHttpServerAdapter(options.server.adapter, options.server.options),
     options
   );
-  const app = adapter.native() as express.Express;
+  const app = adapter.native() as TApp;
   const repository = Repository(options);
 
   const close = (
@@ -59,10 +75,7 @@ export default function registry<
   };
 
   const start = async (
-    callback: (
-      err: unknown,
-      data?: { app: express.Express; server: http.Server }
-    ) => void
+    callback: (err: unknown, data?: { app: TApp; server: http.Server }) => void
   ) => {
     const ok = (msg: string) => console.log(colors.green(msg));