added MilestoneEntity

Author: ZibanPirate

packages/models/src/milestone/__snapshots__/index.spec.ts.snap

@@ -0,0 +1,112 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`should match snapshot when providing all fields: errors 1`] = `Array []`;
+
+exports[`should match snapshot when providing all fields: output 1`] = `
+MilestoneEntity {
+  "closedAt": "2022-08-30T09:55:46Z",
+  "closedIssuesCount": 2,
+  "createdAt": "2022-08-18T09:55:46Z",
+  "description": "Adding an Arabic version of  dzcode.io",
+  "dueAt": "2022-08-30T09:55:46Z",
+  "id": "8320713",
+  "openIssuesCount": 4,
+  "status": "open",
+  "title": "Localization (web)",
+  "url": "https://github.com/dzcode-io/dzcode.io/milestone/9",
+}
+`;
+
+exports[`should match snapshot when providing required fields only: errors 1`] = `Array []`;
+
+exports[`should match snapshot when providing required fields only: output 1`] = `
+MilestoneEntity {
+  "closedIssuesCount": 2,
+  "createdAt": "2022-08-18T09:55:46Z",
+  "description": "Adding an Arabic version of  dzcode.io",
+  "id": "8320713",
+  "openIssuesCount": 4,
+  "status": "open",
+  "title": "Localization (web)",
+  "url": "https://github.com/dzcode-io/dzcode.io/milestone/9",
+}
+`;
+
+exports[`should show an error that matches snapshot when passing empty object: errors 1`] = `
+Array [
+  ValidationError {
+    "children": Array [],
+    "constraints": Object {
+      "isString": "id must be a string",
+    },
+    "property": "id",
+    "target": MilestoneEntity {},
+    "value": undefined,
+  },
+  ValidationError {
+    "children": Array [],
+    "constraints": Object {
+      "isString": "title must be a string",
+    },
+    "property": "title",
+    "target": MilestoneEntity {},
+    "value": undefined,
+  },
+  ValidationError {
+    "children": Array [],
+    "constraints": Object {
+      "isString": "description must be a string",
+    },
+    "property": "description",
+    "target": MilestoneEntity {},
+    "value": undefined,
+  },
+  ValidationError {
+    "children": Array [],
+    "constraints": Object {
+      "isUrl": "url must be an URL address",
+    },
+    "property": "url",
+    "target": MilestoneEntity {},
+    "value": undefined,
+  },
+  ValidationError {
+    "children": Array [],
+    "constraints": Object {
+      "isNumber": "openIssuesCount must be a number conforming to the specified constraints",
+    },
+    "property": "openIssuesCount",
+    "target": MilestoneEntity {},
+    "value": undefined,
+  },
+  ValidationError {
+    "children": Array [],
+    "constraints": Object {
+      "isNumber": "closedIssuesCount must be a number conforming to the specified constraints",
+    },
+    "property": "closedIssuesCount",
+    "target": MilestoneEntity {},
+    "value": undefined,
+  },
+  ValidationError {
+    "children": Array [],
+    "constraints": Object {
+      "isString": "status must be a string",
+    },
+    "property": "status",
+    "target": MilestoneEntity {},
+    "value": undefined,
+  },
+  ValidationError {
+    "children": Array [],
+    "constraints": Object {
+      "isDateString": "createdAt must be a valid ISO 8601 date string",
+    },
+    "property": "createdAt",
+    "target": MilestoneEntity {},
+    "value": undefined,
+  },
+]
+`;
+
+exports[`should show an error that matches snapshot when passing empty object: output 1`] = `MilestoneEntity {}`;

packages/models/src/milestone/index.spec.ts

@@ -0,0 +1,20 @@
+import { runDTOTestCases } from "../_test";
+import { MilestoneEntity } from ".";
+
+runDTOTestCases(
+  MilestoneEntity,
+  {
+    id: "8320713",
+    title: "Localization (web)",
+    description: "Adding an Arabic version of  dzcode.io",
+    url: "https://github.com/dzcode-io/dzcode.io/milestone/9",
+    status: "open",
+    closedIssuesCount: 2,
+    openIssuesCount: 4,
+    createdAt: "2022-08-18T09:55:46Z",
+  },
+  {
+    closedAt: "2022-08-30T09:55:46Z",
+    dueAt: "2022-08-30T09:55:46Z",
+  },
+);

packages/models/src/milestone/index.ts

@@ -0,0 +1,37 @@
+import { IsDateString, IsNumber, IsOptional, IsString, IsUrl } from "class-validator";
+
+import { BaseEntity } from "../_base";
+
+export class MilestoneEntity extends BaseEntity {
+  @IsString()
+  id!: string;
+
+  @IsString()
+  title!: string;
+
+  @IsString()
+  description!: string;
+
+  @IsUrl()
+  url!: string;
+
+  @IsNumber()
+  openIssuesCount!: number;
+
+  @IsNumber()
+  closedIssuesCount!: number;
+
+  @IsString()
+  status!: "open" | "closed";
+
+  @IsDateString()
+  createdAt!: string;
+
+  @IsDateString()
+  @IsOptional()
+  dueAt?: string;
+
+  @IsDateString()
+  @IsOptional()
+  closedAt?: string;
+}