add orgnumbervalidator

Author: alexanbj

packages/validation/src/no.ts

@@ -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.
+A collection of validation utilities for both 🇳🇴 and 🇸🇪 with zero dependencies. Integrates neatly with [Zod](https://github.com/colinhacks/zod).
 
 ## Install
 
@@ -36,3 +36,5 @@ postalCodeValidator('000 000') // => false
 ## Methods
 
 * validatePostalCode
+* validatePhoneNumber
+* validateOrganizationNumber

packages/validation/src/se.ts

@@ -1,5 +1,5 @@
 {
-  "name": "@obosbbl/validation",
+  "name": "@obosbbl/validator",
   "version": "0.0.0",
   "description": "A collection of validation methods for OBOS",
   "repository": {
@@ -24,5 +24,7 @@
   "scripts": {
     "build": "bunchee"
   },
-  "dependencies": {}
+  "devDependencies": {
+    "zod": "^3.24.1"
+  }
 }

packages/validation/src/validation.test.ts

@@ -0,0 +1,68 @@
+import { mod11, stripFormatting } from './utils';
+
+type PostalCodeOptions = {
+  /**
+   * Disallow formatting characters
+   * @default false
+   */
+  strict?: boolean;
+};
+
+/**
+ * Validates the input value as a valid Norwegian postal (zip) code.
+ * Valid format is `0000`.
+ */
+export function validatePostalCode(
+  value: string,
+  options: PostalCodeOptions = {},
+): boolean {
+  if (!options.strict) {
+    value = stripFormatting(value);
+  }
+
+  return /^\d{4}$/.test(value);
+}
+
+type PhoneNumberOptions = {
+  /**
+   * Whether it should be a mobile number
+   * @default false
+   */
+  mobileOnly?: boolean;
+  /**
+   * Disallow formatting characters
+   * @default false
+   */
+  strict?: boolean;
+};
+
+export function validatePhoneNumber(
+  value: string,
+  options: PhoneNumberOptions = {},
+): boolean {
+  if (!options.strict) {
+    value = stripFormatting(value);
+  }
+
+  const isPhoneNumber = /^\d{8}$/.test(value);
+
+  if (options.mobileOnly) {
+    // Norwegian mobile phone numbers start with 4 or 9
+    // See https://nkom.no/telefoni-og-telefonnummer/telefonnummer-og-den-norske-nummerplan/alle-nummerserier-for-norske-telefonnumre
+    return isPhoneNumber && ['4', '9'].includes(value.charAt(0));
+  }
+
+  return isPhoneNumber;
+}
+
+/**
+ * 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`.
+ */
+export function validateOrganizationNumber(value: string): boolean {
+  /** References:
+   * https://www.brreg.no/om-oss/registrene-vare/om-enhetsregisteret/organisasjonsnummeret/
+   * https://no.wikipedia.org/wiki/Organisasjonsnummer
+   */
+  return mod11(value, [3, 2, 7, 6, 5, 4, 3, 2]);
+}

packages/validation/README.md renamed to packages/validator/README.md

@@ -0,0 +1,58 @@
+import { stripFormatting } from './utils';
+
+type PostalCodeOptions = {
+  /**
+   * Disallow formatting characters
+   * @default false
+   */
+  strict?: boolean;
+};
+
+/**
+ * Validates the input value as a valid Swedish postal (zip) code.
+ * Valid format is either `00 000` or `00000`.
+ */
+export function validatePostalCode(
+  value: string,
+  options: PostalCodeOptions = {},
+): boolean {
+  if (!options.strict) {
+    value = stripFormatting(value);
+  }
+
+  return /^\d{3} ?\d{2}$/.test(value);
+}
+
+type PhoneNumberOptions = {
+  mobileOnly?: boolean;
+  strict?: boolean;
+};
+
+export function validatePhoneNumber(
+  value: string,
+  options: PhoneNumberOptions = {},
+): boolean {
+  if (!options.strict) {
+    value = stripFormatting(value);
+  }
+
+  if (options.mobileOnly) {
+    const isMobileNumber = /^07\d{8}$/.test(value);
+    return isMobileNumber;
+  }
+
+  const isPhoneNumber = /^0\d{7,9}$/.test(value);
+
+  return isPhoneNumber;
+}
+
+export function validateOrganizationNumber(
+  value: string,
+  options: PhoneNumberOptions = {},
+): boolean {
+  if (!options.strict) {
+    value = stripFormatting(value);
+  }
+
+  return /^\d{10}$/.test(value);
+}

packages/validation/package.json renamed to packages/validator/package.json

@@ -0,0 +1,28 @@
+/** Strip all formatting, leaving only numbers and letters */
+export function stripFormatting(value: string): string {
+  return value.replace(/[^a-zA-Z0-9]/g, '');
+}
+
+/**
+ * Used to validate Norwegian bank account numbers, organization numbers and national identity numbers.
+ * See https://no.wikipedia.org/wiki/MOD11
+ */
+export function mod11(value: string, weights: number[]): boolean {
+  // Since the control digit is a single value, the lengths should be equal
+  if (weights.length + 1 !== value.length) {
+    return false;
+  }
+
+  let sum = 0;
+  weights.forEach((weight, index) => {
+    sum += weight * Number(value[index]);
+  });
+
+  let controlNumber = 11 - (sum % 11);
+
+  if (controlNumber === 11) {
+    controlNumber = 0;
+  }
+
+  return controlNumber === Number(value[value.length - 1]);
+}