@tsed/platform-http 8.11.0 → 8.11.2-rc.1

package/src/common/config/services/PlatformConfiguration.spec.ts

@@ -1,181 +0,0 @@
-import {Env} from "@tsed/core";
-import {ProviderScope, ProviderType} from "@tsed/di";
-
-import {PlatformConfiguration} from "./PlatformConfiguration.js";
-
-describe("PlatformConfiguration", () => {
-  let settings: any;
-
-  describe("Test ENV", () => {
-    beforeAll(() => {
-      settings = new PlatformConfiguration();
-
-      Object.entries({
-        rootDir: process.cwd(),
-        env: (process.env.NODE_ENV as Env) || Env.DEV,
-        port: 8080,
-        httpPort: 8080,
-        httpsPort: 8000,
-        version: "1.0.0",
-        scopes: {
-          [ProviderType.CONTROLLER]: ProviderScope.SINGLETON
-        },
-        logger: {
-          debug: false,
-          level: "info",
-          logRequest: true,
-          jsonIndentation: process.env.NODE_ENV === Env.PROD ? 0 : 2
-        },
-        errors: {
-          headerName: "errors"
-        },
-        mount: {},
-        controllerScope: ProviderScope.SINGLETON
-      }).forEach(([key, value]) => {
-        settings[key] = value;
-      });
-
-      settings.env = Env.TEST;
-
-      settings.set("ownConfig", "test");
-      settings.set({ownConfig2: "test"} as any);
-      settings.version = "1.0.0";
-      settings.httpsOptions = {test: "/rest"} as any;
-      settings.acceptMimes = ["application/json"];
-      settings.statics = {"/": "/public"};
-      settings.routers = {mergeParams: true};
-      settings.exclude = ["./**/*.spec.ts"];
-      settings.debug = true;
-      //settings.jsonMapper = {};
-
-      settings.setHttpPort({address: "address", port: 8081});
-      settings.setHttpsPort({address: "address", port: 8080});
-    });
-
-    it("should return rootDir", () => {
-      expect(settings.rootDir).toEqual(process.cwd());
-    });
-
-    it("should return custom keys", () => {
-      expect(settings.get("ownConfig")).toEqual("test");
-    });
-
-    it("should return env", () => {
-      expect(settings.env).toEqual(Env.TEST);
-    });
-
-    it("should have logging jsonIndentaion set to 2", () => {
-      expect(settings.logger.jsonIndentation).toEqual(2);
-    });
-
-    it("should return httpsPort", () => {
-      expect(settings.httpsPort).toEqual("address:8080");
-    });
-
-    it("should return httpPort", () => {
-      expect(settings.httpPort).toEqual("address:8081");
-    });
-
-    it("should return the best host", () => {
-      const info = settings.getHttpsPort();
-      expect(info).toEqual({
-        protocol: "https",
-        address: "address",
-        port: 8080,
-        toString: info.toString
-      });
-      expect(settings.getBestHost().toString()).toEqual("https://address:8080");
-    });
-
-    it("should return httpPort multiple usecase", () => {
-      const info = settings.getHttpPort();
-      expect(info).toEqual({
-        protocol: "http",
-        address: "address",
-        port: 8081,
-        toString: info.toString
-      });
-      expect(settings.getBestHost().toString()).toEqual("https://address:8080");
-
-      settings.set("httpsPort", false);
-      expect(settings.getBestHost().toString()).toEqual("http://address:8081");
-
-      settings.set("httpPort", false);
-      expect(settings.getBestHost().toString()).toEqual("/");
-    });
-
-    it("should return httpsOptions", () => {
-      expect((settings.httpsOptions as any).test).toEqual("/rest");
-    });
-
-    it("should return acceptMimes", () => {
-      expect(settings.acceptMimes[0]).toEqual("application/json");
-    });
-
-    it("should return statics", () => {
-      expect(settings.statics).toEqual({"/": "/public"});
-    });
-
-    describe("debug", () => {
-      it("should expose debug as initialized", () => {
-        expect(settings.debug).toEqual(true);
-      });
-
-      it("debug should be equal to the last set value", () => {
-        settings.debug = false;
-        expect(settings.debug).toEqual(false);
-      });
-    });
-
-    it("should return additionalProperties", () => {
-      expect(settings.additionalProperties).toEqual(false);
-    });
-
-    it("should return version", () => {
-      expect(settings.version).toEqual("1.0.0");
-    });
-
-    it("should return errors", () => {
-      expect(settings.errors).toEqual({headerName: "errors"});
-    });
-
-    it("should return routers", () => {
-      expect(settings.routers).toEqual({mergeParams: true});
-    });
-
-    it("should return jsonMapper settings", () => {
-      expect(settings.jsonMapper).toEqual({
-        disableUnsecureConstructor: true,
-        additionalProperties: false,
-        strictGroups: false
-      });
-    });
-
-    it("should return controllerScope", () => {
-      expect(settings.controllerScope).toEqual("singleton");
-    });
-
-    it("should return excluded patterns", () => {
-      expect(settings.exclude).toEqual(["./**/*.spec.ts"]);
-    });
-
-    describe("forEach()", () => {
-      it("should loop on items", () => {
-        const result = [];
-        settings.forEach((o: any) => result.push(o));
-        expect(!!result.length).toEqual(true);
-      });
-    });
-
-    describe("port", () => {
-      it("should set port", () => {
-        const settings = new PlatformConfiguration();
-
-        settings.set({port: 8081});
-
-        expect(settings.httpPort).toEqual(8081);
-        expect(settings.port).toEqual(8081);
-      });
-    });
-  });
-});

package/src/common/config/services/PlatformConfiguration.ts

@@ -1,158 +0,0 @@
-import Https from "node:https";
-
-import {getHostInfoFromPort, isBoolean} from "@tsed/core";
-import {DIConfiguration, Injectable, ProviderScope, TokenProvider} from "@tsed/di";
-import {JsonMapperSettings} from "@tsed/json-mapper";
-
-import {PlatformJsonMapperSettings} from "../interfaces/PlatformJsonMapperSettings.js";
-
-const rootDir = process.cwd();
-
-/**
- * `PlatformConfiguration` contains all information about your Server configuration.
- */
-@Injectable({
-  scope: ProviderScope.SINGLETON,
-  global: true
-})
-export class PlatformConfiguration extends DIConfiguration {
-  constructor() {
-    super({rootDir});
-  }
-
-  get port(): string | number | false {
-    return this.httpPort;
-  }
-
-  set port(value: string | number | false) {
-    this.httpPort = value;
-  }
-
-  get httpsOptions(): Https.ServerOptions {
-    return this.getRaw("httpsOptions");
-  }
-
-  set httpsOptions(value: Https.ServerOptions) {
-    this.setRaw("httpsOptions", value);
-  }
-
-  get httpPort(): string | number | false {
-    return this.getRaw("httpPort");
-  }
-
-  set httpPort(value: string | number | false) {
-    this.setRaw("httpPort", value);
-  }
-
-  get httpsPort(): string | number | false {
-    return this.getRaw("httpsPort");
-  }
-
-  set httpsPort(value: string | number | false) {
-    this.setRaw("httpsPort", value);
-  }
-
-  get mount(): Record<string, TokenProvider[]> {
-    return this.get("mount");
-  }
-
-  set mount(value: Record<string, TokenProvider[]>) {
-    this.setRaw("mount", value);
-  }
-
-  get statics(): Record<string, (any | string)[]> {
-    return this.getRaw("statics") || this.getRaw("serveStatic") || {};
-  }
-
-  set statics(value: Record<string, (any | string)[]>) {
-    this.setRaw("statics", value);
-  }
-
-  get acceptMimes(): string[] {
-    return this.getRaw("acceptMimes");
-  }
-
-  set acceptMimes(value: string[]) {
-    this.setRaw("acceptMimes", value || []);
-  }
-
-  get jsonMapper(): Partial<PlatformJsonMapperSettings> {
-    return {
-      ...JsonMapperSettings
-    };
-  }
-
-  set jsonMapper(options: Partial<PlatformJsonMapperSettings>) {
-    JsonMapperSettings.strictGroups = Boolean(options.strictGroups);
-    JsonMapperSettings.disableUnsecureConstructor = Boolean(options.disableUnsecureConstructor);
-    JsonMapperSettings.additionalProperties = Boolean(
-      isBoolean(options.additionalProperties) ? options.additionalProperties : options.additionalProperties === "accept"
-    );
-  }
-
-  get additionalProperties() {
-    return this.get("converter.additionalProperties") === "accept";
-  }
-
-  /**
-   *
-   * @returns {string|number}
-   */
-  getHttpPort(): ReturnType<typeof getHostInfoFromPort> {
-    return getHostInfoFromPort("http", this.getRaw("httpPort"));
-  }
-
-  /**
-   *
-   * @param settings
-   */
-  setHttpPort(settings: {address: string; port: number}) {
-    this.setRaw("httpPort", `${settings.address}:${settings.port}`);
-  }
-
-  /**
-   *
-   * @returns {string|number}
-   */
-  getHttpsPort() {
-    return getHostInfoFromPort("https", this.getRaw("httpsPort"));
-  }
-
-  /**
-   *
-   * @param settings
-   */
-  setHttpsPort(settings: {address: string; port: number}) {
-    this.setRaw("httpsPort", `${settings.address}:${settings.port}`);
-  }
-
-  getBestHost() {
-    const {httpsPort, httpPort} = this;
-
-    if (httpsPort) {
-      return this.getHttpsPort();
-    }
-
-    if (httpPort) {
-      return this.getHttpPort();
-    }
-
-    return {
-      toString() {
-        return "/";
-      }
-    };
-  }
-}
-
-declare global {
-  namespace TsED {
-    // @ts-ignore
-    interface Context {}
-
-    /**
-     * Here to allow extension on DIConfiguration base service
-     */
-    interface DIConfiguration extends PlatformConfiguration {}
-  }
-}

package/src/common/constants/routerOptions.ts

@@ -1 +0,0 @@
-export const ROUTER_OPTIONS = Symbol.for("ROUTER_OPTIONS");

package/src/common/decorators/PlatformProvider.ts

@@ -1,14 +0,0 @@
-import {Type} from "@tsed/core";
-
-import {adapter} from "../fn/adapter.js";
-import {PlatformAdapter} from "../services/PlatformAdapter.js";
-
-/**
- * Register a new platform adapter.
- * @decorator
- */
-export function PlatformProvider() {
-  return (klass: Type<PlatformAdapter>) => {
-    adapter(klass);
-  };
-}

package/src/common/decorators/multer/multerFileSize.ts

@@ -1,31 +0,0 @@
-import {MulterFileSize as M} from "@tsed/platform-multer";
-
-/**
- * Define file size limit.
- *
- * ```typescript
- * import {Post} from "@tsed/schema";
- * import {MulterOptions, MultipartFile} from "@tsed/platform-multer";
- * import {Controller} from "@tsed/di";
- * import {Multer} from "@types/multer";
- *
- * type MulterFile = Express.Multer.File;
- *
- * @Controller('/')
- * class MyCtrl {
- *   @Post('/file2')
- *   @MulterFileSize(1024) // (Ko). Applied for all fields
- *   private uploadFile(@MultipartFile("file1") file: MulterFile, @MultipartFile("file2") file2: MulterFile) {
- *
- *   }
- * }
- * ```
- *
- * > See the tutorial on the [multer configuration](/docs/upload-files.md).
- * @param fileSize
- * @returns {(target: any, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor}
- * @decorator
- * @deprecated use MulterFileSize from @tsed/platform-multer
- * @multer
- */
-export const MulterFileSize: typeof M = M;

package/src/common/decorators/multer/multerOptions.ts

@@ -1,45 +0,0 @@
-import {MulterOptions as M} from "@tsed/platform-multer";
-
-/**
- * Define multer option for all MultipartFile
- *
- * ```typescript
- * import {PlatformMulterFile, MultipartFile, MulterOptions} from "@tsed/platform-multer";
- * import {Controller} from "@tsed/di";
- * import {Post} from "@tsed/schema";
- *
- * @Controller('/')
- * class MyCtrl {
- *   @Post('/file')
- *   private uploadFile(@MultipartFile("file1") file: PlatformMulterFile) {
- *
- *   }
- *
- *   @Post('/file')
- *   @MulterOptions({dest: "/other-dir"})
- *   private uploadFile(@MultipartFile("file1") file: PlatformMulterFile) {
- *
- *   }
- *
- *   @Post('/file2')
- *   @MulterOptions({dest: "/other-dir"})
- *   private uploadFile(@MultipartFile("file1") file: PlatformMulterFile, @MultipartFile("file2") file2: PlatformMulterFile) {
- *
- *   }
- *
- *   @Post('/files')
- *   private uploadFile(@MultipartFile("file1") files: PlatformMulterFile[]) {
- *
- *   }
- * }
- * ```
- *
- * See the tutorial on the [multer configuration](/docs/upload-files.md).
- *
- * @param {multer.Options} options
- * @returns {(target: any, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor}
- * @decorator
- * @multer
- * @deprecated use MulterOptions from @tsed/platform-multer
- */
-export const MulterOptions: typeof M = M;

package/src/common/decorators/multer/multipartFile.ts

@@ -1,51 +0,0 @@
-import type {MultipartFile as MType} from "@tsed/platform-multer";
-import {MultipartFile as M} from "@tsed/platform-multer";
-
-/**
- * Define a parameter as Multipart file.
- *
- * ```typescript
- * import {Post} from "@tsed/schema";
- * import {Controller, MulterOptions, MultipartFile} from "@tsed/platform-multer";
- * import {Controller} from "@tsed/di";
- * import {Multer} from "@types/multer";
- *
- * type MulterFile = Express.Multer.File;
- *
- * @Controller('/')
- * class MyCtrl {
- *   @Post('/file')
- *   private uploadFile(@MultipartFile("file1") file: MulterFile) {
- *
- *   }
- *
- *   @Post('/file')
- *   @MulterOptions({dest: "/other-dir"})
- *   private uploadFile(@MultipartFile("file1") file: MulterFile) {
- *
- *   }
- *
- *   @Post('/file2')
- *   @MulterOptions({dest: "/other-dir"})
- *   private uploadFile(@MultipartFile("file1") file: MulterFile, @MultipartFile("file2") file2: MulterFile) {
- *
- *   }
- *
- *   @Post('/files')
- *   private uploadFile(@MultipartFile("file1") files: MulterFile[]) {
- *
- *   }
- * }
- * ```
- *
- * > See the tutorial on the [multer configuration](/docs/upload-files.md).
- *
- * @param name
- * @param maxCount
- * @returns Function
- * @decorator
- * @input
- * @deprecated use MultipartFile from @tsed/platform-multer
- */
-export const MultipartFile: typeof M = M;
-export type MultipartFile = MType;

package/src/common/decorators/params/error.spec.ts

@@ -1,15 +0,0 @@
-import {ParamTypes} from "@tsed/platform-params";
-import {JsonParameterStore} from "@tsed/schema";
-
-import {Err} from "./error.js";
-
-describe("@Err", () => {
-  it("should register a new parameter instance with the correct property", () => {
-    class Ctrl {
-      test(@Err() arg: unknown) {}
-    }
-
-    const param = JsonParameterStore.get(Ctrl, "test", 0);
-    expect(param.paramType).toEqual(ParamTypes.ERR);
-  });
-});

package/src/common/decorators/params/error.ts

@@ -1,16 +0,0 @@
-import {ParamTypes, UseParam} from "@tsed/platform-params";
-
-/**
- * @returns {Function}
- * @decorator
- * @operation
- * @input
- */
-export function Err(): Function {
-  return UseParam({
-    paramType: ParamTypes.ERR,
-    dataPath: "$ctx.error",
-    useValidation: false,
-    useMapper: false
-  });
-}

package/src/common/decorators/params/next.spec.ts

@@ -1,15 +0,0 @@
-import {ParamTypes} from "@tsed/platform-params";
-import {JsonParameterStore} from "@tsed/schema";
-
-import {Next} from "./next.js";
-
-describe("@Next", () => {
-  it("should register a new parameter instance with the correct property", () => {
-    class Ctrl {
-      test(@Next() arg: any) {}
-    }
-
-    const param = JsonParameterStore.get(Ctrl, "test", 0);
-    expect(param.paramType).toEqual(ParamTypes.NEXT_FN);
-  });
-});

package/src/common/decorators/params/next.ts

@@ -1,31 +0,0 @@
-import {ParamTypes, UseParam} from "@tsed/platform-params";
-
-/**
- * Get the Next function (for express application and middleware).
- *
- * @decorator
- * @operation
- * @input
- */
-export function Next(): ParameterDecorator {
-  return UseParam({
-    paramType: ParamTypes.NEXT_FN,
-    dataPath: "next",
-    useMapper: false,
-    useValidation: false
-  });
-}
-
-declare global {
-  namespace TsED {
-    export interface NextFunction extends Function {}
-  }
-}
-/**
- * Get the Next function (for express application and middleware).
- *
- * @decorator
- * @operation
- * @input
- */
-export type Next = TsED.NextFunction;

package/src/common/decorators/params/request.spec.ts

@@ -1,50 +0,0 @@
-import {IncomingMessage} from "node:http";
-
-import {ParamTypes} from "@tsed/platform-params";
-import {JsonParameterStore} from "@tsed/schema";
-
-import {PlatformRequest} from "../../services/PlatformRequest.js";
-import {Req, Request} from "./request.js";
-
-describe("@Req", () => {
-  it("should register a new parameter instance with the correct property (RawRequest)", () => {
-    class Ctrl {
-      test(@Request() arg: Req) {}
-    }
-
-    const param = JsonParameterStore.get(Ctrl, "test", 0);
-    expect(param.paramType).toEqual(ParamTypes.REQUEST);
-    expect(param.type).toEqual(Req);
-  });
-
-  it("should register a new parameter instance with the correct property (RawRequest with expression)", () => {
-    class Ctrl {
-      test(@Req("user") arg: Req) {}
-    }
-
-    const param = JsonParameterStore.get(Ctrl, "test", 0);
-    expect(param.paramType).toEqual(ParamTypes.REQUEST);
-    expect(param.expression).toEqual("user");
-    expect(param.type).toEqual(Req);
-  });
-
-  it("should register a new parameter instance with the correct property (PlatformRequest)", () => {
-    class Ctrl {
-      test(@Req() arg: PlatformRequest) {}
-    }
-
-    const param = JsonParameterStore.get(Ctrl, "test", 0);
-    expect(param.paramType).toEqual(ParamTypes.PLATFORM_REQUEST);
-    expect(param.type).toEqual(PlatformRequest);
-  });
-
-  it("should register a new parameter instance with the correct property (IncomingMessage)", () => {
-    class Ctrl {
-      test(@Req() arg: IncomingMessage) {}
-    }
-
-    const param = JsonParameterStore.get(Ctrl, "test", 0);
-    expect(param.paramType).toEqual(ParamTypes.NODE_REQUEST);
-    expect(param.type).toEqual(IncomingMessage);
-  });
-});