validation package

Author: alexanbj

packages/validator/README.md

@@ -3,7 +3,7 @@
 [![NPM Version](https://img.shields.io/npm/v/%40obosbbl%2Fvalidation)](https://www.npmjs.com/package/@obosbbl/validation)
 
 
-A collection of validation utilities for both 🇳🇴 and 🇸🇪 with zero dependencies. Integrates neatly with [Zod](https://github.com/colinhacks/zod).
+A collection of validation methods for both 🇳🇴 and 🇸🇪 with zero dependencies. Integrates neatly with [Zod](https://github.com/colinhacks/zod).
 
 ## Install
 
@@ -24,17 +24,35 @@ The package has two entrypoints, one for `no` and one for `se`. That allows you
 // 🇳🇴 example
 import { postalCodeValidator } from '@obosbbl/validation/no';
 postalCodeValidator('0000') // => true
+
 postalCodeValidator('00000') // => false
 
 // 🇸🇪 example
 import { postalCodeValidator } from '@obosbbl/validation/no';
 postalCodeValidator('00000') // => true
 postalCodeValidator('00 000') // => true
+
 postalCodeValidator('000 000') // => false
 ```
 
+## Strictness
+
+By default, the methods allows formatting characters when validating. If you need strict validation, you can pass the `strict` option to the method.
+
+```js
+import { validateOrganizationNumber } from '@obosbbl/validation/no';
+
+validateOrganizationNumber('937 052 766') // true;
+
+validateOrganizationNumber('937052766', { strict: true }) // true;
+validateOrganizationNumber('937 052 766', { strict: true }) // false;
+```
+
+```js
+
 ## Methods
 
 * validatePostalCode
 * validatePhoneNumber
+   * supports mobileOnly option
 * validateOrganizationNumber

packages/validator/src/no.ts

@@ -1,46 +1,49 @@
+import type { ValidatorOptions } from './types';
 import { mod11, stripFormatting } from './utils';
 
-type PostalCodeOptions = {
-  /**
-   * Disallow formatting characters
-   * @default false
-   */
-  strict?: boolean;
-};
+type PostalCodeOptions = ValidatorOptions;
 
 /**
- * Validates the input value as a valid Norwegian postal (zip) code.
- * Valid format is `0000`.
+ * Validates that the input value is a Norwegian postal (zip) code.
+ * @example
+ * ```
+ * validatePostalCode('0000') // => true
+ * ```
  */
 export function validatePostalCode(
   value: string,
   options: PostalCodeOptions = {},
 ): boolean {
-  if (!options.strict) {
+  if (options.allowFormatting) {
     value = stripFormatting(value);
   }
 
   return /^\d{4}$/.test(value);
 }
 
-type PhoneNumberOptions = {
+type PhoneNumberOptions = ValidatorOptions & {
   /**
    * Whether it should be a mobile number
    * @default false
    */
   mobileOnly?: boolean;
-  /**
-   * Disallow formatting characters
-   * @default false
-   */
-  strict?: boolean;
 };
 
+/**
+ * Validates that the input value is a Norwegian phone number.
+ *
+ * Supports mobile only validation.
+ * @example
+ * ```
+ * validatePhoneNumber('00000000') // => true
+ * validatePhoneNumber('90000000', { mobileOnly: true }) // => true
+ * ```
+ */
 export function validatePhoneNumber(
   value: string,
   options: PhoneNumberOptions = {},
 ): boolean {
-  if (!options.strict) {
+  if (options.allowFormatting) {
     value = stripFormatting(value);
   }
 
@@ -55,11 +58,23 @@ export function validatePhoneNumber(
   return isPhoneNumber;
 }
 
+type OrganizationNumberOptions = ValidatorOptions;
+
 /**
- * Validates the input value as a valid {@link https://www.brreg.no/om-oss/registrene-vare/om-enhetsregisteret/organisasjonsnummeret/ Norwegian organization number}.
- * Valid format is 9 digits, spaces allowed, eg `000000000` or `000 000 000`.
+ * Validates that the input value is a {@link https://www.brreg.no/om-oss/registrene-vare/om-enhetsregisteret/organisasjonsnummeret/ Norwegian organization number}.
+ * @example
+ * ```
+ * validateOrganizationNumber('000000000') // => true
+ * ```
  */
-export function validateOrganizationNumber(value: string): boolean {
+export function validateOrganizationNumber(
+  value: string,
+  options: PhoneNumberOptions = {},
+): boolean {
+  if (options.allowFormatting) {
+    value = stripFormatting(value);
+  }
+
   /** References:
    * https://www.brreg.no/om-oss/registrene-vare/om-enhetsregisteret/organisasjonsnummeret/
    * https://no.wikipedia.org/wiki/Organisasjonsnummer

packages/validator/src/se.ts

@@ -1,38 +1,51 @@
+import type { ValidatorOptions } from './types';
 import { stripFormatting } from './utils';
 
-type PostalCodeOptions = {
-  /**
-   * Disallow formatting characters
-   * @default false
-   */
-  strict?: boolean;
-};
+type PostalCodeOptions = ValidatorOptions;
 
 /**
- * Validates the input value as a valid Swedish postal (zip) code.
- * Valid format is either `00 000` or `00000`.
+ * Validates that the input value is a Swedish postal (zip) code.
+ * @example
+ * ```
+ * validatePostalCode('00000') // => true
+ * ```
  */
 export function validatePostalCode(
   value: string,
   options: PostalCodeOptions = {},
 ): boolean {
-  if (!options.strict) {
+  if (options.allowFormatting) {
     value = stripFormatting(value);
   }
 
   return /^\d{3} ?\d{2}$/.test(value);
 }
 
-type PhoneNumberOptions = {
+type PhoneNumberOptions = ValidatorOptions & {
+  /**
+   * Whether it should be a mobile number
+   * @default false
+   */
   mobileOnly?: boolean;
-  strict?: boolean;
 };
 
+/**
+ * Validates that the input value is a Swedish phone number.
+ *
+ * Supports mobile only validation.
+ * @example
+ * ```
+ * validatePhoneNumber('00000000') // => true
+ * validatePhoneNumber('000000000') // => true
+ * validatePhoneNumber('0000000000') // => true
+ * validatePhoneNumber('0700000000', { mobileOnly: true }) // => true
+ * ```
+ */
 export function validatePhoneNumber(
   value: string,
   options: PhoneNumberOptions = {},
 ): boolean {
-  if (!options.strict) {
+  if (options.allowFormatting) {
     value = stripFormatting(value);
   }
 
@@ -46,11 +59,21 @@ export function validatePhoneNumber(
   return isPhoneNumber;
 }
 
+type OrganizationNumberOptions = ValidatorOptions;
+
+/**
+ * Validates that the input value is a {@link https://www.skatteverket.se/foretagochorganisationer/foretagare/startaochregistrera/organisationsnummer.4.361dc8c15312eff6fd235d1.html Swedish organization number}.
+ * @example
+ * ```
+ * validateOrganizationNumber('000000000') // => true
+ * ```
+ */
 export function validateOrganizationNumber(
   value: string,
-  options: PhoneNumberOptions = {},
+  options: OrganizationNumberOptions = {},
 ): boolean {
-  if (!options.strict) {
+  // TODO: Implement proper validation
+  if (options.allowFormatting) {
     value = stripFormatting(value);
   }
 

packages/validator/src/types.ts

@@ -0,0 +1,7 @@
+export type ValidatorOptions = {
+  /**
+   * Allow formatting characters
+   * @default false
+   */
+  allowFormatting?: boolean;
+};