refactor: path exports

.gitignore

@@ -28,6 +28,7 @@ build
 dist
 cache
 temp/
+tsdoc-metadata.json
 
 # Debug
 npm-debug.log*

apps/docs/examples/validators.md

@@ -9,7 +9,7 @@ npm i --save @opengovsg/starter-kitty-validators
 ## Path Validation
 
 ```javascript
-import { createPathSchema } from '@opengovsg/starter-kitty-validators'
+import { createPathSchema } from '@opengovsg/starter-kitty-validators/path'
 
 const pathSchema = createPathSchema({
   basePath: '/app/content',
@@ -21,15 +21,15 @@ const contentSubmissionSchema = z.object({
   content: z.string(),
 })
 
-type ContentSubmission = z.infer<typeof contentSchema>
+type ContentSubmission = z.infer<typeof contentSubmissionSchema>
 ```
 
 `fullPermalink`, when resolved relative to the working directory of the Node process, must lie within `/app/content`.
 
 ## Email Validation
 
 ```javascript
-import { createEmailSchema } from '@opengovsg/starter-kitty-validators'
+import { createEmailSchema } from '@opengovsg/starter-kitty-validators/email'
 
 const emailSchema = createEmailSchema({
   domains: [{ domain: 'gov.sg', includeSubdomains: true }],
@@ -47,8 +47,10 @@ type FormValues = z.infer<typeof formSchema>
 
 ## URL Validation
 
+Validating a post-login redirect URL provided in a query parameter:
+
 ```javascript
-import { UrlValidator } from '@opengovsg/starter-kitty-validators'
+import { UrlValidator } from '@opengovsg/starter-kitty-validators/url'
 
 const validator = new UrlValidator({
   whitelist: {
@@ -58,8 +60,6 @@ const validator = new UrlValidator({
 })
 ```
 
-Validating a post-login redirect URL provided in a query parameter:
-
 ```javascript
 try {
   router.push(validator.parse(redirectUrl))
@@ -68,33 +68,25 @@ try {
 }
 ```
 
-Consider using the validator as part of a Zod schema to validate the URL and fall back to a default URL if the URL is invalid.
+Using the validator as part of a Zod schema to validate the URL and fall back to a default URL if the URL is invalid:
 
 ```javascript
-const baseUrl = getBaseUrl()
+import { createUrlSchema } from '@opengovsg/starter-kitty-validators/url'
 
-const validator = new UrlValidator({
-  baseOrigin: new URL(baseUrl).origin,
-  whitelist: {
-    protocols: ['http', 'https'],
-    hosts: [new URL(baseUrl).host],
-  },
-})
+const baseUrl = new URL(getBaseUrl())
 
 export const callbackUrlSchema = z
   .string()
   .optional()
   .default(HOME)
-  .transform((url, ctx) => {
-    try {
-      return validator.parse(url)
-    } catch (error) {
-      ctx.addIssue({
-        code: z.ZodIssueCode.custom,
-        message: (error as Error).message,
-      })
-      return z.NEVER
-    }
-  })
-  .catch(new URL(HOME, baseUrl))
+  .pipe(
+    createUrlSchema({
+      baseOrigin: baseUrl.origin,
+      whitelist: {
+        protocols: ['http', 'https'],
+        hosts: [baseUrl.host],
+      },
+    }),
+  )
+  .catch(new URL(HOME, baseUrl.origin))
 ```

packages/validators/package.json

@@ -1,11 +1,35 @@
 {
   "name": "@opengovsg/starter-kitty-validators",
-  "version": "1.2.4",
+  "version": "1.2.5",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
+  "exports": {
+    "./url": {
+      "types": "./dist/url/index.d.ts",
+      "default": "./dist/url/index.js"
+    },
+    "./path": {
+      "types": "./dist/path/index.d.ts",
+      "default": "./dist/path/index.js"
+    },
+    "./email": {
+      "types": "./dist/email/index.d.ts",
+      "default": "./dist/email/index.js"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      "url": [
+        "./dist/url/index.d.ts"
+      ],
+      "path": [
+        "./dist/path/index.d.ts"
+      ],
+      "email": [
+        "./dist/email/index.d.ts"
+      ]
+    }
+  },
   "scripts": {
     "build": "tsc && tsc-alias",
     "build:report": "api-extractor run --local --verbose",

packages/validators/src/email/index.ts

@@ -21,3 +21,5 @@ export const createEmailSchema = (options: EmailValidatorOptions = {}): ZodSchem
   }
   throw new OptionsError(fromError(result.error).toString())
 }
+
+export type { EmailValidatorOptions } from '@/email/options'

packages/validators/src/index.ts

@@ -6,9 +6,5 @@
 
 export type * from '@/common/errors'
 export * from '@/email'
-export type { EmailValidatorOptions } from '@/email/options'
 export * from '@/path'
-export type { PathValidatorOptions } from '@/path/options'
 export * from '@/url'
-export type * from '@/url/errors'
-export type { UrlValidatorOptions } from '@/url/options'

packages/validators/src/path/index.ts

@@ -21,3 +21,5 @@ export const createPathSchema = (options: PathValidatorOptions): ZodSchema<strin
   }
   throw new OptionsError(fromError(result.error).toString())
 }
+
+export type { PathValidatorOptions } from '@/path/options'

packages/validators/src/url/index.ts

@@ -81,3 +81,6 @@ export const createUrlSchema = (options: UrlValidatorOptions = defaultOptions):
   }
   throw new OptionsError(fromError(result.error).toString())
 }
+
+export type * from '@/url/errors'
+export type { UrlValidatorOptions } from '@/url/options'