Merge branch 'main' into renovate/pnpm-10.x

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
 

package.json

@@ -16,7 +16,7 @@
     "@arethetypeswrong/cli": "0.17.3",
     "@biomejs/biome": "1.9.4",
     "@changesets/cli": "2.27.12",
-    "bunchee": "6.3.2",
+    "bunchee": "6.4.0",
     "typescript": "5.7.3",
     "vitest": "3.0.5"
   },

packages/format/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @obosbbl/format
 
+## 0.3.1
+
+### Patch Changes
+
+- 3a52b13: allow country code for phone number input in `formatPhoneNumber()`.
+
+  Previously it was unable to format phone numbers with country codes (+47, +46), now it can.
+  Note that the country code will _not_ be part of the formatted output.
+
+  ```js
+  // 🇳🇴 example
+  formatPhoneNumber("+4700000000"); // => '00 00 00 00'
+
+  // 🇸🇪 example
+  formatPhoneNumber("+46303123456"); // => '0303-12 34 56'
+  ```
+
 ## 0.3.0
 
 ### Minor Changes

packages/format/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@obosbbl/format",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "A collection of formatting methods for OBOS",
   "repository": {
     "url": "https://github.com/code-obos/public-frontend-modules"

packages/format/src/format.test.ts

@@ -16,6 +16,8 @@ describe('no', () => {
   test.each([
     ['22865500', '22 86 55 00'],
     ['80000000', '800 00 000'],
+    // with country code
+    ['+4722865500', '22 86 55 00'],
   ])('formatPhoneNumber(%s) -> %s', (input, expected) => {
     expect(formatPhoneNumberNo(input)).toBe(expected);
   });
@@ -57,6 +59,8 @@ describe('se', () => {
     ['0303123456', '0303-12 34 56'],
     ['03031234567', '0303-123 45 67'],
     ['030312345678', '0303-123 456 78'],
+    // with country code
+    ['+46303123456', '0303-12 34 56'],
     // invalid, too long a number
     ['0303123456789', '0303123456789'],
   ])('formatPhoneNumber(%s) -> %s', (input, expected) => {

packages/format/src/index.ts

@@ -17,11 +17,15 @@ type Options = {
 };
 
 /**
- * Format a phone number
+ * Format a phone number.
+ *
+ * Country code can be present in the input, but it will be removed in the formatted output.
+ *
  * @example
  * ```
  * formatPhoneNumber('00000000', { locale: 'no' }) // => '00 00 00 00'
  * formatPhoneNumber('07012345678', { locale: 'se' }) // => '070-123 45 678'
+ * formatPhoneNumber('+4700000000', { locale: 'no' }) // => '00 00 00 00'
  * ```
  */
 export function formatPhoneNumber(input: string, options: Options): string {

packages/format/src/no.ts

@@ -7,14 +7,22 @@ const REGULAR_PHONE_NUMBER_FORMAT = /^(\d{2})(\d{2})(\d{2})(\d{2})$/;
 const EIGHT_HUNDRED_SERIES_PHONE_NUMBER_FORMAT = /^(\d{3})(\d{2})(\d{3})$/;
 
 /**
- * Format a phone number
+ * Format a phone number.
+ *
+ * Country code can be present in the input, but it will be removed in the formatted output.
+ *
  * @example
  * ```
  * formatPhoneNumber('00000000') // => '00 00 00 00'
  * formatPhoneNumber('80000000') // => '800 00 000'
+ * formatPhoneNumber('+4700000000') // => '00 00 00 00'
  * ```
  */
 export function formatPhoneNumber(input: string): string {
+  // remove country code
+  // biome-ignore lint/style/noParameterAssign:
+  input = input.replace(/^\+47/, '');
+
   const number = replaceIfMatch(
     input,
     REGULAR_PHONE_NUMBER_FORMAT,

packages/format/src/se.ts

@@ -14,16 +14,23 @@ const THREE_DIGIT_AREA_CODE =
   /^0(11|13|16|18|19|21|23|26|31|33|35|36|40|42|44|46|54|60|63|90)/;
 
 /**
- * Format a phone number
+ * Format a phone number.
+ *
+ * Country code can be present in the input, but it will be removed in the formatted output.
+ *
  * @example
  * ```
  * formatPhoneNumber('07012345678') // => '070-123 45 678'
  * formatPhoneNumber('0812345') // => '08-123 45'
  * formatPhoneNumber('0311234567') // => '031-123 45 67'
  * formatPhoneNumber('0303123456') // => '0303-12 34 56'
+ * formatPhoneNumber('+46303123456') // => '0303-12 34 56'
  * ```
  */
 export function formatPhoneNumber(input: string): string {
+  // biome-ignore lint/style/noParameterAssign:
+  input = input.replace(/^\+46/, '0');
+
   const normalizedInput = cleanInput(input);
 
   if (MOBILE_PHONE_NUMBER_FORMAT.test(normalizedInput)) {

packages/validation/CHANGELOG.md

@@ -0,0 +1,13 @@
+# @obosbbl/validation
+
+## 0.2.0
+
+### Minor Changes
+
+- b444dd8: feat: add method `validateObosMembershipNumber()` to validate if the input value is a valid OBOS membership number.
+
+## 0.1.0
+
+### Minor Changes
+
+- 66676fe: initial release

packages/validation/README.md

@@ -0,0 +1,97 @@
+# @obosbbl/validation
+
+[![NPM Version](https://img.shields.io/npm/v/%40obosbbl%2Fvalidation)](https://www.npmjs.com/package/@obosbbl/validation)
+
+
+A collection of validation methods 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 { validateOrganizationNumber } from '@obosbbl/validation/no';
+validateOrganizationNumber('937052766') // => true
+
+validateOrganizationNumber('000') // => false
+
+// 🇸🇪 example
+import { validateOrganizationNumber } from '@obosbbl/validation/se';
+validateOrganizationNumber('5592221054') // => true
+
+validateOrganizationNumber('000') // => false
+```
+
+## Strictness and formatting characters
+
+The methods are "strict" by default, meaning no formatting characters in the input is allowed.
+This is preferrable, for instance when doing server-side validation, where the input is often expected to be a "clean" value.
+
+If you want to allow formatting characters in the input, you can pass `allowFormatting: true` in the options object to the method.
+Note that this currently allows any formatting characters, not just the just the "expected" ones for the input type.
+
+
+```js
+import { validateOrganizationNumber } from '@obosbbl/validation/no';
+
+validateOrganizationNumber('937052766') // true
+
+// formatting characters disallowed by default
+validateOrganizationNumber('937 052 766') // false;
+
+// allow formatting characters
+validateOrganizationNumber('937 052 766', { allowFormatting: true }) // true;
+```
+
+## Methods
+
+* validatePostalCode
+* validatePhoneNumber
+  * supports mobileOnly option
+* validateOrganizationNumber
+  * Check digit verification is currently only implemented for Norwegian organization numbers. For Swedish organiation numbers, we only check the length of the input. PRs are welcome to fix this.
+* validateObosMembershipNumber
+
+
+## Example usage with Zod
+
+```js
+import { z } from 'zod';
+import { validatePhoneNumber } from '@obosbbl/validation/no';
+
+const mobileOnlySchema = z.object({
+  name: z.string(),
+  phoneNumber: z
+    .string()
+    .refine(
+      (val) => validatePhoneNumber(val, { mobileOnly: true }),
+      'Telefonnummeret er ikke et gyldig mobilnummer',
+    ),
+});
+
+const validData = {
+  name: 'Kari Nordmann',
+  phoneNumber: '92345678',
+};
+
+mobileOnlySchema.parse(validData); // => { name: 'Kari Nordmann', phoneNumber: '92345678' }
+
+const invalidData = {
+  name: 'Ola Nordmann',
+  phoneNumber: '22865500',
+}
+
+mobileOnlySchema.parse(invalidData); // => throws ZodError
+```