validation package

Author: alexanbj

README.md

@@ -6,6 +6,7 @@ This a monorepo of OBOS' open source frontend modules.
 ## Packages
 
 * [format](./packages/format)
+* [validation](./packages/validation)
 
 ## Contributing
 

packages/validation/README.md

@@ -0,0 +1,38 @@
+# @obosbbl/validation
+
+[![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.
+
+## Install
+
+```sh
+# npm
+npm install @obosbbl/validation
+
+# pnpm
+pnpm add @obosbbl/validation
+```
+
+## Usage
+
+The package has two entrypoints, one for `no` and one for `se`. That allows you to import for only the locale you need.
+
+
+```js
+// 🇳🇴 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
+```
+
+## Methods
+
+* validatePostalCode

packages/validation/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@obosbbl/validation",
+  "version": "0.0.0",
+  "description": "A collection of validation methods for OBOS",
+  "repository": {
+    "url": "https://github.com/code-obos/public-frontend-modules"
+  },
+  "license": "MIT",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    "./no": {
+      "types": "./dist/no.d.mts",
+      "default": "./dist/no.mjs"
+    },
+    "./se": {
+      "types": "./dist/se.d.mts",
+      "default": "./dist/se.mjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "bunchee"
+  },
+  "dependencies": {}
+}

packages/validation/src/no.ts

@@ -0,0 +1,7 @@
+/**
+ * Validates the input value as a valid Norwegian postal (zip) code.
+ * Valid format is `0000`.
+ */
+export function postalCodeValidator(value: string): boolean {
+  return /^\d{4}$/.test(value);
+}

packages/validation/src/se.ts

@@ -0,0 +1,7 @@
+/**
+ * Validates the input value as a valid Swedish postal (zip) code.
+ * Valid format is either `00 000` or `00000`.
+ */
+export function postalCodeValidator(value: string): boolean {
+  return /^\d{3} ?\d{2}$/.test(value);
+}

packages/validation/src/validation.test.ts

@@ -0,0 +1,30 @@
+import { describe, expect, test } from 'vitest';
+import { postalCodeValidator as postalCodeValidatorNo } from './no';
+import { postalCodeValidator as postalCodeValidatorSe } from './se';
+
+describe('Norwegian', () => {
+  describe('postalCodeValidator()', () => {
+    test('correctly validates postal codes', () => {
+      expect(postalCodeValidatorNo('1067')).toBeTruthy();
+
+      expect(postalCodeValidatorNo('1.67')).toBeFalsy();
+      expect(postalCodeValidatorNo('10677')).toBeFalsy();
+      expect(postalCodeValidatorNo(Number.NaN.toString())).toBeFalsy();
+      expect(postalCodeValidatorNo('not a number')).toBeFalsy();
+    });
+  });
+});
+
+describe('Swedish', () => {
+  describe('postalCodeValidator()', () => {
+    test('correctly validates postal codes', () => {
+      expect(postalCodeValidatorSe('100 26')).toBeTruthy();
+      expect(postalCodeValidatorSe('10026')).toBeTruthy();
+
+      expect(postalCodeValidatorSe('100426')).toBeFalsy();
+      expect(postalCodeValidatorSe('177')).toBeFalsy();
+      expect(postalCodeValidatorSe(Number.NaN.toString())).toBeFalsy();
+      expect(postalCodeValidatorSe('not a number')).toBeFalsy();
+    });
+  });
+});

packages/validation/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig.json",
+  "include": ["./src/*"],
+  "compilerOptions": {
+    "outDir": "dist"
+  }
+}