@tsed/schema/src/decorators/operations/inFile.spec.ts

JsonSchema module for Ts.ED Framework

import {generateSpec, getSpec, OperationPath, Path, SpecTypes} from "../../index.js";
import {InFile} from "./inFile.js";

describe("@File()", () => {
  describe("one file", () => {
    @Path("/")
    class TestController {
      @OperationPath("POST", "/")
      test(@InFile("file1") file: any) {}
    }

    it("should set endpoint metadata - OS2", async () => {
      expect(await generateSpec({tokens: [{token: TestController}], specType: SpecTypes.SWAGGER})).toEqual({
        consumes: ["application/json"],
        info: {
          title: "Api documentation",
          version: "1.0.0"
        },
        paths: {
          "/": {
            post: {
              consumes: ["multipart/form-data"],
              operationId: "testControllerTest",
              parameters: [
                {
                  format: "binary",
                  in: "formData",
                  name: "file1",
                  type: "string"
                }
              ],
              produces: ["application/octet-stream"],
              responses: {
                "400": {
                  description:
                    "<File too long | Too many parts | Too many files | Field name too long | Field value too long | Too many fields | Unexpected field>  [fieldName] Example: File too long file1",
                  schema: {
                    type: "object"
                  }
                }
              },
              tags: ["TestController"]
            }
          }
        },
        produces: ["application/json"],
        swagger: "2.0",
        tags: [
          {
            name: "TestController"
          }
        ]
      });
    });

    it("should set endpoint metadata - OS3", () => {
      expect(getSpec(TestController, {specType: SpecTypes.OPENAPI})).toEqual({
        paths: {
          "/": {
            post: {
              operationId: "testControllerTest",
              parameters: [],
              requestBody: {
                content: {
                  "multipart/form-data": {
                    schema: {
                      properties: {
                        file1: {
                          format: "binary",
                          type: "string"
                        }
                      },
                      type: "object"
                    }
                  }
                },
                required: false
              },
              responses: {
                "400": {
                  content: {
                    "*/*": {
                      schema: {
                        type: "object"
                      }
                    }
                  },
                  description:
                    "<File too long | Too many parts | Too many files | Field name too long | Field value too long | Too many fields | Unexpected field>  [fieldName] Example: File too long file1"
                }
              },
              tags: ["TestController"]
            }
          }
        },
        tags: [
          {
            name: "TestController"
          }
        ]
      });
    });
  });
  describe("many files", () => {
    @Path("/")
    class TestController {
      @OperationPath("POST", "/")
      test(@InFile("file1") file: any[]) {}
    }

    it("should set endpoint metadata - OS2", async () => {
      expect(await generateSpec({tokens: [{token: TestController}], specType: SpecTypes.SWAGGER})).toEqual({
        consumes: ["application/json"],
        info: {
          title: "Api documentation",
          version: "1.0.0"
        },
        paths: {
          "/": {
            post: {
              consumes: ["multipart/form-data"],
              operationId: "testControllerTest",
              parameters: [
                {
                  collectionFormat: "csv",
                  in: "formData",
                  items: {
                    format: "binary",
                    type: "string"
                  },
                  name: "file1",
                  type: "array"
                }
              ],
              produces: ["application/octet-stream"],
              responses: {
                "400": {
                  description:
                    "<File too long | Too many parts | Too many files | Field name too long | Field value too long | Too many fields | Unexpected field>  [fieldName] Example: File too long file1",
                  schema: {
                    type: "object"
                  }
                }
              },
              tags: ["TestController"]
            }
          }
        },
        produces: ["application/json"],
        swagger: "2.0",
        tags: [
          {
            name: "TestController"
          }
        ]
      });
    });
    it("should set endpoint metadata - OS3", () => {
      expect(getSpec(TestController, {specType: SpecTypes.OPENAPI})).toEqual({
        paths: {
          "/": {
            post: {
              operationId: "testControllerTest",
              parameters: [],
              requestBody: {
                content: {
                  "multipart/form-data": {
                    schema: {
                      properties: {
                        file1: {
                          items: {
                            format: "binary",
                            type: "string"
                          },
                          type: "array"
                        }
                      },
                      type: "object"
                    }
                  }
                },
                required: false
              },
              responses: {
                "400": {
                  content: {
                    "*/*": {
                      schema: {
                        type: "object"
                      }
                    }
                  },
                  description:
                    "<File too long | Too many parts | Too many files | Field name too long | Field value too long | Too many fields | Unexpected field>  [fieldName] Example: File too long file1"
                }
              },
              tags: ["TestController"]
            }
          }
        },
        tags: [
          {
            name: "TestController"
          }
        ]
      });
    });
  });
});