format package

Author: alexanbj

packages/format/README.md

@@ -1,8 +1,9 @@
 # @obosbbl/format
 
-[![npm canary version](https://img.shields.io/npm/v/@obosbbl%2Fformat/canary.svg)](https://www.npmjs.com/package/@obosbbl/format)
+[![NPM Version](https://img.shields.io/npm/v/%40obosbbl%2Fformat)](https://www.npmjs.com/package/@obosbbl/format)
 
-Formatting functions for both 🇳🇴 and 🇸🇪 with zero dependencies.
+
+A collection of formatting functions for both 🇳🇴 and 🇸🇪 with zero dependencies.
 
 ## Install
 
@@ -14,7 +15,25 @@ npm install @obosbbl/format
 pnpm add @obosbbl/format
 ```
 
+## Usage
+
+The package has two entrypoints, one for `no` and one for `se`. That allows you to import for only the locale you need.
+
+Note that the methods are very lenient when attempting to format the input. It will strip all characters that aren't digits or letters before it applies the formatting.
+That way any existing format of the input won't affect the formatted output
+
+If unable to format the input, the method will return the (cleaned) input as is.
+
+```js
+// 🇳🇴 example
+import { formatOrganizationNumber } from '@obosbbl/format/no';
+formatOrganizationNumber('000000000') // => '000 000 000'
+
+// 🇸🇪 example
+import { formatOrganizationNumber } from '@obosbbl/format/se';
+formatOrganizationNumber('0000000000') // => '000000-0000'
+```
+
 ## Methods
 
-* organizationNumberFormatter
-* obosMembershipNumberFormatter
+* formatOrganizationNumber

packages/format/src/format.test.ts

@@ -1,34 +1,27 @@
 import { describe, expect, test } from 'vitest';
-import { formatOrganizationNumber, formatPhoneNumber } from '.';
+import { formatOrganizationNumber as formatOrganizationNumberNo } from './no';
+import { formatOrganizationNumber as formatOrganizationNumberSe } from './se';
 
 describe('no', () => {
   test.each([
-    ['22865500', '22 86 55 00'],
-    ['80000000', '800 00 000'],
-  ])('formatPhoneNumber(%s) -> %s', (input, expected) => {
-    expect(formatPhoneNumber(input, 'no')).toBe(expected);
+    ['000000000', '000 000 000'],
+    ['000 000 000', '000 000 000'],
+    ['000-000-000', '000 000 000'],
+    ['abc', 'abc'],
+  ])('formatOrganizationNumber(%s) -> %s', (input, expected) => {
+    expect(formatOrganizationNumberNo(input)).toBe(expected);
   });
-
-  test.each([['000000000', '000 000 000']])(
-    'formatOrganizationNumber(%s) -> %s',
-    (input, expected) => {
-      expect(formatOrganizationNumber(input, 'no')).toBe(expected);
-    },
-  );
 });
 
 describe('se', () => {
-  test.each([['0701234567', '070-123 45 67']])(
-    'formatPhoneNumber(%s) -> %s',
-    (input, expected) => {
-      expect(formatPhoneNumber(input, 'se')).toBe(expected);
-    },
-  );
-
-  test.each([['0000000000', '000000-0000']])(
-    'formatOrganizationNumber(%s) -> %s',
-    (input, expected) => {
-      expect(formatOrganizationNumber(input, 'se')).toBe(expected);
-    },
-  );
+  test.each([
+    ['0000000000', '000000-0000'],
+    ['000000-0000', '000000-0000'],
+    ['000000 0000', '000000-0000'],
+    [' 000000 0000 ', '000000-0000'],
+    ['000', '000'],
+    ['abc', 'abc'],
+  ])('formatOrganizationNumber(%s) -> %s', (input, expected) => {
+    expect(formatOrganizationNumberSe(input)).toBe(expected);
+  });
 });

packages/format/src/no.ts

@@ -1,3 +1,5 @@
+import { replaceIfMatch } from './utils';
+
 const ORG_NUMBER_FORMAT = /^(\d{3})(\d{3})(\d{3})$/;
 
 /**
@@ -7,19 +9,6 @@ const ORG_NUMBER_FORMAT = /^(\d{3})(\d{3})(\d{3})$/;
  * formatOrganizationNumber('000000000') // => '000 000 000'
  * ```
  */
-export function formatOrganizationNumber(number: string): string {
-  return number.replace(ORG_NUMBER_FORMAT, '$1 $2 $3');
-}
-
-const OBOS_MEMBERSHIP_NUMBER_FORMAT = /^(\d{3})(\d{2})(\d{2})$/;
-
-/**
- * Format an OBOS membership number
- * @example
- * ```
- * formatObosMembershipNumber('0000000') // => '000 00 00'
- * ```
- */
-export function formatObosMembershipNumber(number: string): string {
-  return number.replace(OBOS_MEMBERSHIP_NUMBER_FORMAT, '$1 $2 $3');
+export function formatOrganizationNumber(input: string): string {
+  return replaceIfMatch(input, ORG_NUMBER_FORMAT, '$1 $2 $3');
 }

packages/format/src/se.ts

@@ -1,14 +1,14 @@
-// Ensures feature parity with the Norwegian format module
-export { formatObosMembershipNumber } from './no';
+import { replaceIfMatch } from './utils';
 
 const ORG_NUMBER_FORMAT = /^(\d{6})(\d{4})$/;
+
 /**
  * Format an organization number
  * @example
  * ```
  * formatOrganizationNumber('0000000000') // => '000000-0000'
  * ```
  */
-export function formatOrganizationNumber(number: string): string {
-  return number.replace(ORG_NUMBER_FORMAT, '$1-$2');
+export function formatOrganizationNumber(input: string): string {
+  return replaceIfMatch(input, ORG_NUMBER_FORMAT, '$1-$2');
 }

packages/format/src/utils.ts

@@ -0,0 +1,12 @@
+export function replaceIfMatch(
+  input: string,
+  regex: RegExp,
+  replacerPattern: string,
+): string {
+  // We're extremely lenient when attemtping to format the input.
+  // We remove everything that isn't a letter or a number, that way we can get rid of any
+  // formatting that might already be present in the input, eg spaces, hyphens or dots
+  const cleaned = input.replace(/[^a-zA-Z0-9]/g, '');
+
+  return cleaned.replace(regex, replacerPattern);
+}