fix: parse arg typing to any

opengovsg · Nov 21, 2024 · 2d792ff · 2d792ff
1 parent 2ab7449
commit 2d792ff
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 27 deletions.
diff --git a/etc/starter-kitty-validators.api.md b/etc/starter-kitty-validators.api.md
@@ -22,51 +22,51 @@ export const createUrlSchema: (options?: UrlValidatorOptions) => ZodSchema<URL,
 // @public
 export interface EmailValidatorOptions {
     domains?: {
-        domain: string;
-        includeSubdomains?: boolean;
-    }[];
+        domain: string
+        includeSubdomains?: boolean
+    }[]
 }
 
 // @public
 export class OptionsError extends Error {
-    constructor(message: string);
+    constructor(message: string)
 }
 
 // @public
 export interface PathValidatorOptions {
-    basePath: string;
+    basePath: string
 }
 
 // @public
 export class RelUrlValidator extends UrlValidator {
-    constructor(origin: string | URL);
+    constructor(origin: string | URL)
 }
 
 // @public
 export class UrlValidationError extends Error {
-    constructor(message: string);
+    constructor(message: string)
 }
 
 // @public
 export class UrlValidator {
-    constructor(options?: UrlValidatorOptions);
-    parse(url: string, fallbackUrl: string | URL): URL;
+    constructor(options?: UrlValidatorOptions)
+    parse(url: any, fallbackUrl: string | URL): URL
     // (undocumented)
-    parse(url: string): URL;
+    parse(url: any): URL
     // (undocumented)
-    parse(url: string, fallbackUrl: undefined): URL;
-    parsePathname(url: string, fallbackUrl: string | URL): string;
+    parse(url: any, fallbackUrl: undefined): URL
+    parsePathname(url: any, fallbackUrl: string | URL): string
     // (undocumented)
-    parsePathname(url: string): string;
+    parsePathname(url: any): string
     // (undocumented)
-    parsePathname(url: string, fallbackUrl: undefined): string;
+    parsePathname(url: any, fallbackUrl: undefined): string
 }
 
 // @public
 export interface UrlValidatorOptions {
-    baseOrigin?: string;
+    baseOrigin?: string
     // Warning: (ae-forgotten-export) The symbol "UrlValidatorWhitelist" needs to be exported by the entry point index.d.ts
-    whitelist?: UrlValidatorWhitelist;
+    whitelist?: UrlValidatorWhitelist
 }
 
 ```
diff --git a/packages/validators/package.json b/packages/validators/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@opengovsg/starter-kitty-validators",
-  "version": "1.2.9",
+  "version": "1.2.10",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "exports": {

diff --git a/packages/validators/src/__tests__/url.test.ts b/packages/validators/src/__tests__/url.test.ts
@@ -36,6 +36,12 @@ describe('UrlValidator with default options', () => {
     expect(() => validator.parse('javascript&colonalert(/xss/)').protocol).toThrow(UrlValidationError)
     expect(() => validator.parse('javascript:alert(/xss/)')).toThrow(UrlValidationError)
   })
+
+  it('should throw an error when given an invalid type', () => {
+    expect(() => validator.parse(123)).toThrow(UrlValidationError)
+    expect(() => validator.parse(undefined)).toThrow(UrlValidationError)
+    expect(() => validator.parse(['1', '2'])).toThrow(UrlValidationError)
+  })
 })
 
 describe('UrlValidator with custom protocol whitelist', () => {

diff --git a/packages/validators/src/url/index.ts b/packages/validators/src/url/index.ts
@@ -13,6 +13,8 @@ import { toSchema } from '@/url/schema'
  * @public
  */
 export class UrlValidator {
+  /* eslint-disable @typescript-eslint/no-explicit-any */
+  // parse functions perform type coercion, so input can be any
   private schema
 
   /**
@@ -46,8 +48,8 @@ export class UrlValidator {
    *
    * @internal
    */
-  #parse(url: string): URL {
-    const result = this.schema.safeParse(url)
+  #parse(url: any): URL {
+    const result = url instanceof URL ? this.schema.safeParse(url.href) : this.schema.safeParse(url)
     if (result.success) {
       return result.data
     }
@@ -69,10 +71,10 @@ export class UrlValidator {
    *
    * @public
    */
-  parse(url: string, fallbackUrl: string | URL): URL
-  parse(url: string): URL
-  parse(url: string, fallbackUrl: undefined): URL
-  parse(url: string, fallbackUrl?: string | URL): URL {
+  parse(url: any, fallbackUrl: string | URL): URL
+  parse(url: any): URL
+  parse(url: any, fallbackUrl: undefined): URL
+  parse(url: any, fallbackUrl?: string | URL): URL {
     try {
       return this.#parse(url)
     } catch (error) {
@@ -95,10 +97,10 @@ export class UrlValidator {
    *
    * @public
    */
-  parsePathname(url: string, fallbackUrl: string | URL): string
-  parsePathname(url: string): string
-  parsePathname(url: string, fallbackUrl: undefined): string
-  parsePathname(url: string, fallbackUrl?: string | URL): string {
+  parsePathname(url: any, fallbackUrl: string | URL): string
+  parsePathname(url: any): string
+  parsePathname(url: any, fallbackUrl: undefined): string
+  parsePathname(url: any, fallbackUrl?: string | URL): string {
     const parsedUrl = fallbackUrl ? this.parse(url, fallbackUrl) : this.parse(url)
     if (parsedUrl instanceof URL) return parsedUrl.pathname
     return parsedUrl