feat: 支持工具函数Required

Author: HUxiaoAlinNG

jest/toolfn.ts

@@ -3,13 +3,26 @@ interface AAA {
   b: string;
   c: boolean;
 }
-
 interface BBB {
   a: number;
   b?: string;
   c: AAA,
 }
 
+interface CCC {
+  a?: number;
+  b?: string;
+  c?: boolean;
+}
+
+interface DDD {
+  a: number;
+  b?: string;
+  c: CCC,
+}
+
+
+
 type ToolFn_1 = Omit<{ a: number; b: string; c: boolean }, 'b'>;
 
 type ToolFn_2 = Omit<{ a: number; b: string; c: boolean }, 'b' | 'c'>;
@@ -84,3 +97,9 @@ type ToolFn_18 = Partial<AAA>;
 type ToolFn_19 = Partial<BBB>;
 
 type ToolFn_20 = Partial<{ a: string, b: BBB }>;
+
+type ToolFn_21 = Required<CCC>;
+
+type ToolFn_22 = Required<DDD>;
+
+type ToolFn_23 = Required<{ a?: string, b?: DDD }>;

src/__tests__/__snapshots__/toolfn.test.ts.snap

@@ -289,3 +289,120 @@ Object {
   "type": "object",
 }
 `;
+
+exports[`工具函数Required_1 1`] = `
+Object {
+  "additionalProperties": false,
+  "properties": Object {
+    "a": Object {
+      "type": "number",
+    },
+    "b": Object {
+      "type": "string",
+    },
+    "c": Object {
+      "type": "boolean",
+    },
+  },
+  "required": Array [
+    "a",
+    "b",
+    "c",
+  ],
+  "type": "object",
+}
+`;
+
+exports[`工具函数Required_2 1`] = `
+Object {
+  "additionalProperties": false,
+  "definitions": Object {
+    "CCC": Object {
+      "additionalProperties": false,
+      "properties": Object {
+        "a": Object {
+          "type": "number",
+        },
+        "b": Object {
+          "type": "string",
+        },
+        "c": Object {
+          "type": "boolean",
+        },
+      },
+      "type": "object",
+    },
+  },
+  "properties": Object {
+    "a": Object {
+      "type": "number",
+    },
+    "b": Object {
+      "type": "string",
+    },
+    "c": Object {
+      "$ref": "#/definitions/CCC",
+    },
+  },
+  "required": Array [
+    "a",
+    "b",
+    "c",
+  ],
+  "type": "object",
+}
+`;
+
+exports[`工具函数Required_3 1`] = `
+Object {
+  "definitions": Object {
+    "CCC": Object {
+      "additionalProperties": false,
+      "properties": Object {
+        "a": Object {
+          "type": "number",
+        },
+        "b": Object {
+          "type": "string",
+        },
+        "c": Object {
+          "type": "boolean",
+        },
+      },
+      "type": "object",
+    },
+    "DDD": Object {
+      "additionalProperties": false,
+      "properties": Object {
+        "a": Object {
+          "type": "number",
+        },
+        "b": Object {
+          "type": "string",
+        },
+        "c": Object {
+          "$ref": "#/definitions/CCC",
+        },
+      },
+      "required": Array [
+        "a",
+        "c",
+      ],
+      "type": "object",
+    },
+  },
+  "properties": Object {
+    "a": Object {
+      "type": "string",
+    },
+    "b": Object {
+      "$ref": "#/definitions/DDD",
+    },
+  },
+  "required": Array [
+    "a",
+    "b",
+  ],
+  "type": "object",
+}
+`;

src/__tests__/toolfn.test.ts

@@ -101,4 +101,16 @@ test('工具函数Partial_2', () => {
 
 test('工具函数Partial_3', () => {
   expect(getSchema('ToolFn_20')).toMatchSnapshot();
+});
+
+test('工具函数Required_1', () => {
+  expect(getSchema('ToolFn_21')).toMatchSnapshot();
+});
+
+test('工具函数Required_2', () => {
+  expect(getSchema('ToolFn_22')).toMatchSnapshot();
+});
+
+test('工具函数Required_3', () => {
+  expect(getSchema('ToolFn_23')).toMatchSnapshot();
 });

src/get-jsonschema-from-data.ts

@@ -20,7 +20,7 @@ export default class genTypeSchema extends typescriptToFileDatas {
 
   constructor() {
     super();
-    this.tsTollFn = ['Omit', 'Pick', 'Record', 'Partial'];
+    this.tsTollFn = ['Omit', 'Pick', 'Record', 'Partial', 'Required'];
   }
 
   /**
@@ -479,6 +479,13 @@ export default class genTypeSchema extends typescriptToFileDatas {
           delete resType.required;
           return resType;
         }
+        if (key === 'Required') {
+          delete resType.required;
+          if (resType.properties) {
+            resType.required = Object.keys(resType.properties)
+          }
+          return resType;
+        }
       }
     };
 
@@ -550,6 +557,7 @@ export default class genTypeSchema extends typescriptToFileDatas {
         case 'Record':
           return RecordHandle(key, type, extra);
         case 'Partial':
+        case 'Required':
           return PartialRequiredHandle(key, $ref ? { $ref } : items);
         default:
           item.items = items;

src/typescript-to-file-datas.ts

@@ -34,7 +34,7 @@ export default class typescriptToFileDatas {
     this.jsonData = {};
     this.cacheFiles = [];
     this.filterFiles = [];
-    this.filterRefKeywords = ['Omit', 'Pick', 'Record', 'Partial', 'Array', 'Promise'];
+    this.filterRefKeywords = ['Omit', 'Pick', 'Record', 'Partial', 'Required', 'Array', 'Promise'];
   }
 
   /**