@tsed/schema 8.0.0 → 8.0.2

package/src/decorators/common/multipleOf.spec.ts

@@ -0,0 +1,33 @@
+import {getJsonSchema} from "../../utils/getJsonSchema.js";
+import {MultipleOf} from "./multipleOf.js";
+
+describe("MultipleOf", () => {
+  it("should declare minimum value", () => {
+    // WHEN
+    class Model {
+      @MultipleOf(2)
+      num: number;
+    }
+
+    // THEN
+    expect(getJsonSchema(Model)).toEqual({
+      properties: {
+        num: {
+          multipleOf: 2,
+          type: "number"
+        }
+      },
+      type: "object"
+    });
+  });
+
+  it("should throw an error when the given parameters is as negative integer", () => {
+    let actualError: any;
+    try {
+      MultipleOf(-1);
+    } catch (er) {
+      actualError = er;
+    }
+    expect(actualError.message).toBe("The value of multipleOf MUST be a number, strictly greater than 0.");
+  });
+});

package/src/decorators/common/multipleOf.ts

@@ -0,0 +1,80 @@
+import {withErrorMsg} from "../../utils/withErrorMsg.js";
+import {JsonEntityFn} from "./jsonEntityFn.js";
+
+/**
+ * A numeric instance is valid only if division by this keyword's value results in an integer.
+ *
+ * ::: warning
+ * The value of `multipleOf` MUST be a number, strictly greater than 0.
+ * :::
+ *
+ * ::: warning
+ * For v6 user, use @@MultipleOf@@ from @tsed/schema instead of @tsed/platform-http.
+ * :::
+ *
+ * ## Example
+ * ### With primitive type
+ *
+ * ```typescript
+ * class Model {
+ *    @MultipleOf(2)
+ *    property: Number;
+ * }
+ * ```
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "number",
+ *       "multipleOf": 2
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * ### With array type
+ *
+ * ```typescript
+ * class Model {
+ *    @CollectionOf(number)
+ *    @MultipleOf(2)
+ *    property: number[];
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "array",
+ *       "items": {
+ *          "type": "number",
+ *          "multipleOf": 2
+ *       }
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @param {number} multipleOf The multiple value allowed
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ * @ajv-errors
+ */
+export const MultipleOf = withErrorMsg("multipleOf", (multipleOf: number) => {
+  if (multipleOf <= 0) {
+    throw new Error("The value of multipleOf MUST be a number, strictly greater than 0.");
+  }
+
+  return JsonEntityFn((store) => {
+    store.itemSchema.multipleOf(multipleOf);
+  });
+});

package/src/decorators/common/name.spec.ts

@@ -0,0 +1,56 @@
+import {Consumes, getSpec, OperationPath, Path} from "../../index.js";
+import {getJsonSchema} from "../../utils/getJsonSchema.js";
+import {Name} from "./name.js";
+
+describe("@Name", () => {
+  it("should declare name as alias (props)", () => {
+    // WHEN
+    class Model {
+      @Name("num2")
+      num: number;
+    }
+
+    // THEN
+    expect(getJsonSchema(Model)).toEqual({
+      properties: {
+        num2: {
+          type: "number"
+        }
+      },
+      type: "object"
+    });
+  });
+  it("should declare name on class", () => {
+    // WHEN
+    @Path("/")
+    @Name("AwesomeController")
+    class MyController {
+      @OperationPath("POST", "/")
+      @Consumes("text/json")
+      get() {}
+    }
+
+    // THEN
+    expect(getSpec(MyController)).toEqual({
+      paths: {
+        "/": {
+          post: {
+            operationId: "awesomeControllerGet",
+            parameters: [],
+            responses: {
+              "200": {
+                description: "Success"
+              }
+            },
+            tags: ["AwesomeController"]
+          }
+        }
+      },
+      tags: [
+        {
+          name: "AwesomeController"
+        }
+      ]
+    });
+  });
+});

package/src/decorators/common/name.ts

@@ -0,0 +1,50 @@
+import {DecoratorParameters, decoratorTypeOf, DecoratorTypes} from "@tsed/core";
+
+import {JsonEntityStore} from "../../domain/JsonEntityStore.js";
+import {JsonEntityFn} from "../common/jsonEntityFn.js";
+
+/**
+ * Add a name metadata on the decorated element.
+ *
+ * ## Examples
+ * ### On parameters
+ *
+ * ```typescript
+ * async myMethod(@Name("nameOf") @PathParams("id") id: string): Promise<Model>  {
+ *
+ * }
+ * ```
+ *
+ * ### On parameters
+ *
+ * ```typescript
+ * @Name("AliasName")
+ * @Controller("/")
+ * class ModelCtrl {
+ *
+ * }
+ * ```
+ *
+ * @param name
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ * @classDecorator
+ * @operation
+ */
+export function Name(name: any) {
+  return JsonEntityFn((store: JsonEntityStore, args: DecoratorParameters) => {
+    switch (decoratorTypeOf(args)) {
+      case DecoratorTypes.CLASS:
+        store.schema.name(name);
+        break;
+      case DecoratorTypes.PARAM:
+        store.parameter!.name(name);
+        break;
+      default:
+        store.parent.schema.addAlias(args[1], name);
+    }
+  });
+}