feat: add support for type URL (string with format "uri") (#1480)

vega · Nov 22, 2022 · 2ba0135 · 2ba0135
1 parent 2ed8ab1
commit 2ba0135
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -252,7 +252,7 @@ fs.writeFile(output_path, schemaString, (err) => {
 -   `interface` types
 -   `enum` types
 -   `union`, `tuple`, `type[]` types
--   `Date`, `RegExp` types
+-   `Date`, `RegExp`, `URL` types
 -   `string`, `boolean`, `number` types
 -   `"value"`, `123`, `true`, `false`, `null`, `undefined` literals
 -   type aliases

diff --git a/src/NodeParser/TypeReferenceNodeParser.ts b/src/NodeParser/TypeReferenceNodeParser.ts
@@ -60,6 +60,10 @@ export class TypeReferenceNodeParser implements SubNodeParser {
             return new AnnotatedType(new StringType(), { format: "regex" }, false);
         }
 
+        if (typeSymbol.name === "URL") {
+            return new AnnotatedType(new StringType(), { format: "uri" }, false);
+        }
+
         return this.childNodeParser.createType(
             typeSymbol.declarations!.filter((n: ts.Declaration) => !invalidTypes[n.kind])[0],
             this.createSubContext(node, context)

diff --git a/test/valid-data-type.test.ts b/test/valid-data-type.test.ts
@@ -34,6 +34,7 @@ describe("valid-data-type", () => {
     it("type-date", assertValidSchema("type-date", "MyObject"));
     it("type-date-annotation", assertValidSchema("type-date-annotation", "MyObject", "basic"));
     it("type-regexp", assertValidSchema("type-regexp", "MyObject"));
+    it("type-uri", assertValidSchema("type-uri", "MyObject"));
     it("type-union", assertValidSchema("type-union", "TypeUnion"));
     it("type-union-tagged", assertValidSchema("type-union-tagged", "Shape"));
     it("type-intersection", assertValidSchema("type-intersection", "MyObject"));

diff --git a/test/valid-data/type-uri/main.ts b/test/valid-data/type-uri/main.ts
@@ -0,0 +1,6 @@
+type MyURL = URL
+
+export interface MyObject {
+    url: URL;
+    urlAlias: MyURL;
+}
diff --git a/test/valid-data/type-uri/schema.json b/test/valid-data/type-uri/schema.json
@@ -0,0 +1,24 @@
+{
+  "$ref": "#/definitions/MyObject",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "definitions": {
+    "MyObject": {
+      "additionalProperties": false,
+      "properties": {
+        "url": {
+          "format": "uri",
+          "type": "string"
+        },
+        "urlAlias": {
+          "format": "uri",
+          "type": "string"
+        }
+      },
+      "required": [
+        "url",
+        "urlAlias"
+      ],
+      "type": "object"
+    }
+  }
+}