@ruhlabs/validators 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ruh Labs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,45 @@
-# Temporary Holding Version
+# @ruhlabs/validators
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Validators and formatters for Maldivian data. No dependencies, works in Node and the browser.
+
+```bash
+npm install @ruhlabs/validators
+```
+
+## Phone numbers
+
+Accepts all common ways of writing a Maldivian number: `7771234`, `777-1234`, `+960 777 1234`, `00960 7771234` and so on.
+
+```ts
+import { parsePhone, isValidPhone, isMobile } from '@ruhlabs/validators';
+
+parsePhone('+960 777 1234');
+// {
+//   national: "7771234",
+//   e164: "+9607771234",          // store this
+//   international: "+960 777-1234", // show this
+//   type: "mobile"
+// }
+
+parsePhone('123'); // null
+isValidPhone('777-1234'); // true
+isMobile('3321234'); // false (landline)
+```
+
+Number types follow current allocations: numbers starting with 7 or 9 are mobile, 3 or 6 are landlines.
+
+## National ID card numbers
+
+```ts
+import { isValidNationalId, normalizeNationalId } from '@ruhlabs/validators';
+
+isValidNationalId('A123456'); // true
+normalizeNationalId(' a 123-456 '); // "A123456"
+normalizeNationalId('B12345'); // null
+```
+
+This checks the **format** only (A + 6 digits). It can't tell whether a card exists or who it belongs to. For real identity verification, use eFaas.
+
+## License
+
+MIT © Ruh Labs

package/dist/index.cjs

@@ -0,0 +1,79 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  isMobile: () => isMobile,
+  isValidNationalId: () => isValidNationalId,
+  isValidPhone: () => isValidPhone,
+  normalizeNationalId: () => normalizeNationalId,
+  parsePhone: () => parsePhone
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/phone.ts
+var COUNTRY_CODE = "960";
+var TYPES = {
+  "7": "mobile",
+  "9": "mobile",
+  "3": "landline",
+  "6": "landline"
+};
+function parsePhone(input) {
+  let digits = input.trim();
+  if (!/^\+?[\d\s\-().]+$/.test(digits)) return null;
+  digits = digits.replace(/\D/g, "");
+  if (digits.length === 12 && digits.startsWith("00" + COUNTRY_CODE)) digits = digits.slice(5);
+  else if (digits.length === 10 && digits.startsWith(COUNTRY_CODE)) digits = digits.slice(3);
+  if (!/^\d{7}$/.test(digits)) return null;
+  const type = TYPES[digits[0]];
+  if (!type) return null;
+  return {
+    national: digits,
+    e164: `+${COUNTRY_CODE}${digits}`,
+    international: `+${COUNTRY_CODE} ${digits.slice(0, 3)}-${digits.slice(3)}`,
+    type
+  };
+}
+function isValidPhone(input) {
+  return parsePhone(input) !== null;
+}
+function isMobile(input) {
+  return parsePhone(input)?.type === "mobile";
+}
+
+// src/national-id.ts
+var NATIONAL_ID = /^A\d{6}$/;
+function normalizeNationalId(input) {
+  const value = input.trim().replace(/[\s-]/g, "").toUpperCase();
+  return NATIONAL_ID.test(value) ? value : null;
+}
+function isValidNationalId(input) {
+  return normalizeNationalId(input) !== null;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  isMobile,
+  isValidNationalId,
+  isValidPhone,
+  normalizeNationalId,
+  parsePhone
+});
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/phone.ts","../src/national-id.ts"],"sourcesContent":["export { parsePhone, isValidPhone, isMobile, type ParsedPhone, type PhoneType } from './phone.js';\nexport { normalizeNationalId, isValidNationalId } from './national-id.js';\n","export type PhoneType = 'mobile' | 'landline';\n\nexport interface ParsedPhone {\n\t/** 7-digit national number, e.g. \"7771234\" */\n\tnational: string;\n\t/** E.164 format, e.g. \"+9607771234\" */\n\te164: string;\n\t/** Human-readable format, e.g. \"+960 777-1234\" */\n\tinternational: string;\n\ttype: PhoneType;\n}\n\nconst COUNTRY_CODE = '960';\n\n/**\n * Leading digit → number type. Based on current Maldivian allocations:\n * 7xx/9xx mobile, 3xx/6xx fixed lines.\n */\nconst TYPES: Readonly<Record<string, PhoneType>> = {\n\t'7': 'mobile',\n\t'9': 'mobile',\n\t'3': 'landline',\n\t'6': 'landline'\n};\n\n/**\n * Parse a Maldivian phone number written in any common style:\n * \"7771234\", \"777 1234\", \"777-1234\", \"+960 777 1234\", \"00960 7771234\", \"960-777-1234\".\n *\n * Returns `null` if it isn't a valid Maldivian number.\n */\nexport function parsePhone(input: string): ParsedPhone | null {\n\tlet digits = input.trim();\n\tif (!/^\\+?[\\d\\s\\-().]+$/.test(digits)) return null;\n\n\tdigits = digits.replace(/\\D/g, '');\n\tif (digits.length === 12 && digits.startsWith('00' + COUNTRY_CODE)) digits = digits.slice(5);\n\telse if (digits.length === 10 && digits.startsWith(COUNTRY_CODE)) digits = digits.slice(3);\n\n\tif (!/^\\d{7}$/.test(digits)) return null;\n\tconst type = TYPES[digits[0]!];\n\tif (!type) return null;\n\n\treturn {\n\t\tnational: digits,\n\t\te164: `+${COUNTRY_CODE}${digits}`,\n\t\tinternational: `+${COUNTRY_CODE} ${digits.slice(0, 3)}-${digits.slice(3)}`,\n\t\ttype\n\t};\n}\n\n/** True if the input is a valid Maldivian phone number. */\nexport function isValidPhone(input: string): boolean {\n\treturn parsePhone(input) !== null;\n}\n\n/** True if the input is a valid Maldivian mobile number. */\nexport function isMobile(input: string): boolean {\n\treturn parsePhone(input)?.type === 'mobile';\n}\n","const NATIONAL_ID = /^A\\d{6}$/;\n\n/**\n * Normalise a Maldivian national ID card number: trims, removes spaces and\n * dashes, and uppercases the letter. \"a 123-456\" → \"A123456\".\n *\n * Returns `null` if the result isn't in the A + 6 digits format.\n */\nexport function normalizeNationalId(input: string): string | null {\n\tconst value = input.trim().replace(/[\\s-]/g, '').toUpperCase();\n\treturn NATIONAL_ID.test(value) ? value : null;\n}\n\n/**\n * True if the input has the format of a Maldivian national ID card number\n * (A followed by 6 digits).\n *\n * This only checks the format. It can't tell whether the card exists or who\n * it belongs to; for real identity verification use eFaas.\n */\nexport function isValidNationalId(input: string): boolean {\n\treturn normalizeNationalId(input) !== null;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACYA,IAAM,eAAe;AAMrB,IAAM,QAA6C;AAAA,EAClD,KAAK;AAAA,EACL,KAAK;AAAA,EACL,KAAK;AAAA,EACL,KAAK;AACN;AAQO,SAAS,WAAW,OAAmC;AAC7D,MAAI,SAAS,MAAM,KAAK;AACxB,MAAI,CAAC,oBAAoB,KAAK,MAAM,EAAG,QAAO;AAE9C,WAAS,OAAO,QAAQ,OAAO,EAAE;AACjC,MAAI,OAAO,WAAW,MAAM,OAAO,WAAW,OAAO,YAAY,EAAG,UAAS,OAAO,MAAM,CAAC;AAAA,WAClF,OAAO,WAAW,MAAM,OAAO,WAAW,YAAY,EAAG,UAAS,OAAO,MAAM,CAAC;AAEzF,MAAI,CAAC,UAAU,KAAK,MAAM,EAAG,QAAO;AACpC,QAAM,OAAO,MAAM,OAAO,CAAC,CAAE;AAC7B,MAAI,CAAC,KAAM,QAAO;AAElB,SAAO;AAAA,IACN,UAAU;AAAA,IACV,MAAM,IAAI,YAAY,GAAG,MAAM;AAAA,IAC/B,eAAe,IAAI,YAAY,IAAI,OAAO,MAAM,GAAG,CAAC,CAAC,IAAI,OAAO,MAAM,CAAC,CAAC;AAAA,IACxE;AAAA,EACD;AACD;AAGO,SAAS,aAAa,OAAwB;AACpD,SAAO,WAAW,KAAK,MAAM;AAC9B;AAGO,SAAS,SAAS,OAAwB;AAChD,SAAO,WAAW,KAAK,GAAG,SAAS;AACpC;;;AC3DA,IAAM,cAAc;AAQb,SAAS,oBAAoB,OAA8B;AACjE,QAAM,QAAQ,MAAM,KAAK,EAAE,QAAQ,UAAU,EAAE,EAAE,YAAY;AAC7D,SAAO,YAAY,KAAK,KAAK,IAAI,QAAQ;AAC1C;AASO,SAAS,kBAAkB,OAAwB;AACzD,SAAO,oBAAoB,KAAK,MAAM;AACvC;","names":[]}

package/dist/index.d.cts

@@ -0,0 +1,40 @@
+type PhoneType = 'mobile' | 'landline';
+interface ParsedPhone {
+    /** 7-digit national number, e.g. "7771234" */
+    national: string;
+    /** E.164 format, e.g. "+9607771234" */
+    e164: string;
+    /** Human-readable format, e.g. "+960 777-1234" */
+    international: string;
+    type: PhoneType;
+}
+/**
+ * Parse a Maldivian phone number written in any common style:
+ * "7771234", "777 1234", "777-1234", "+960 777 1234", "00960 7771234", "960-777-1234".
+ *
+ * Returns `null` if it isn't a valid Maldivian number.
+ */
+declare function parsePhone(input: string): ParsedPhone | null;
+/** True if the input is a valid Maldivian phone number. */
+declare function isValidPhone(input: string): boolean;
+/** True if the input is a valid Maldivian mobile number. */
+declare function isMobile(input: string): boolean;
+
+/**
+ * Normalise a Maldivian national ID card number: trims, removes spaces and
+ * dashes, and uppercases the letter. "a 123-456" → "A123456".
+ *
+ * Returns `null` if the result isn't in the A + 6 digits format.
+ */
+declare function normalizeNationalId(input: string): string | null;
+/**
+ * True if the input has the format of a Maldivian national ID card number
+ * (A followed by 6 digits).
+ *
+ * This only checks the format. It can't tell whether the card exists or who
+ * it belongs to; for real identity verification use eFaas.
+ */
+declare function isValidNationalId(input: string): boolean;
+
+export { isMobile, isValidNationalId, isValidPhone, normalizeNationalId, parsePhone };
+export type { ParsedPhone, PhoneType };

package/dist/index.d.ts

@@ -0,0 +1,40 @@
+type PhoneType = 'mobile' | 'landline';
+interface ParsedPhone {
+    /** 7-digit national number, e.g. "7771234" */
+    national: string;
+    /** E.164 format, e.g. "+9607771234" */
+    e164: string;
+    /** Human-readable format, e.g. "+960 777-1234" */
+    international: string;
+    type: PhoneType;
+}
+/**
+ * Parse a Maldivian phone number written in any common style:
+ * "7771234", "777 1234", "777-1234", "+960 777 1234", "00960 7771234", "960-777-1234".
+ *
+ * Returns `null` if it isn't a valid Maldivian number.
+ */
+declare function parsePhone(input: string): ParsedPhone | null;
+/** True if the input is a valid Maldivian phone number. */
+declare function isValidPhone(input: string): boolean;
+/** True if the input is a valid Maldivian mobile number. */
+declare function isMobile(input: string): boolean;
+
+/**
+ * Normalise a Maldivian national ID card number: trims, removes spaces and
+ * dashes, and uppercases the letter. "a 123-456" → "A123456".
+ *
+ * Returns `null` if the result isn't in the A + 6 digits format.
+ */
+declare function normalizeNationalId(input: string): string | null;
+/**
+ * True if the input has the format of a Maldivian national ID card number
+ * (A followed by 6 digits).
+ *
+ * This only checks the format. It can't tell whether the card exists or who
+ * it belongs to; for real identity verification use eFaas.
+ */
+declare function isValidNationalId(input: string): boolean;
+
+export { isMobile, isValidNationalId, isValidPhone, normalizeNationalId, parsePhone };
+export type { ParsedPhone, PhoneType };

package/dist/index.js

@@ -0,0 +1,48 @@
+// src/phone.ts
+var COUNTRY_CODE = "960";
+var TYPES = {
+  "7": "mobile",
+  "9": "mobile",
+  "3": "landline",
+  "6": "landline"
+};
+function parsePhone(input) {
+  let digits = input.trim();
+  if (!/^\+?[\d\s\-().]+$/.test(digits)) return null;
+  digits = digits.replace(/\D/g, "");
+  if (digits.length === 12 && digits.startsWith("00" + COUNTRY_CODE)) digits = digits.slice(5);
+  else if (digits.length === 10 && digits.startsWith(COUNTRY_CODE)) digits = digits.slice(3);
+  if (!/^\d{7}$/.test(digits)) return null;
+  const type = TYPES[digits[0]];
+  if (!type) return null;
+  return {
+    national: digits,
+    e164: `+${COUNTRY_CODE}${digits}`,
+    international: `+${COUNTRY_CODE} ${digits.slice(0, 3)}-${digits.slice(3)}`,
+    type
+  };
+}
+function isValidPhone(input) {
+  return parsePhone(input) !== null;
+}
+function isMobile(input) {
+  return parsePhone(input)?.type === "mobile";
+}
+
+// src/national-id.ts
+var NATIONAL_ID = /^A\d{6}$/;
+function normalizeNationalId(input) {
+  const value = input.trim().replace(/[\s-]/g, "").toUpperCase();
+  return NATIONAL_ID.test(value) ? value : null;
+}
+function isValidNationalId(input) {
+  return normalizeNationalId(input) !== null;
+}
+export {
+  isMobile,
+  isValidNationalId,
+  isValidPhone,
+  normalizeNationalId,
+  parsePhone
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/phone.ts","../src/national-id.ts"],"sourcesContent":["export type PhoneType = 'mobile' | 'landline';\n\nexport interface ParsedPhone {\n\t/** 7-digit national number, e.g. \"7771234\" */\n\tnational: string;\n\t/** E.164 format, e.g. \"+9607771234\" */\n\te164: string;\n\t/** Human-readable format, e.g. \"+960 777-1234\" */\n\tinternational: string;\n\ttype: PhoneType;\n}\n\nconst COUNTRY_CODE = '960';\n\n/**\n * Leading digit → number type. Based on current Maldivian allocations:\n * 7xx/9xx mobile, 3xx/6xx fixed lines.\n */\nconst TYPES: Readonly<Record<string, PhoneType>> = {\n\t'7': 'mobile',\n\t'9': 'mobile',\n\t'3': 'landline',\n\t'6': 'landline'\n};\n\n/**\n * Parse a Maldivian phone number written in any common style:\n * \"7771234\", \"777 1234\", \"777-1234\", \"+960 777 1234\", \"00960 7771234\", \"960-777-1234\".\n *\n * Returns `null` if it isn't a valid Maldivian number.\n */\nexport function parsePhone(input: string): ParsedPhone | null {\n\tlet digits = input.trim();\n\tif (!/^\\+?[\\d\\s\\-().]+$/.test(digits)) return null;\n\n\tdigits = digits.replace(/\\D/g, '');\n\tif (digits.length === 12 && digits.startsWith('00' + COUNTRY_CODE)) digits = digits.slice(5);\n\telse if (digits.length === 10 && digits.startsWith(COUNTRY_CODE)) digits = digits.slice(3);\n\n\tif (!/^\\d{7}$/.test(digits)) return null;\n\tconst type = TYPES[digits[0]!];\n\tif (!type) return null;\n\n\treturn {\n\t\tnational: digits,\n\t\te164: `+${COUNTRY_CODE}${digits}`,\n\t\tinternational: `+${COUNTRY_CODE} ${digits.slice(0, 3)}-${digits.slice(3)}`,\n\t\ttype\n\t};\n}\n\n/** True if the input is a valid Maldivian phone number. */\nexport function isValidPhone(input: string): boolean {\n\treturn parsePhone(input) !== null;\n}\n\n/** True if the input is a valid Maldivian mobile number. */\nexport function isMobile(input: string): boolean {\n\treturn parsePhone(input)?.type === 'mobile';\n}\n","const NATIONAL_ID = /^A\\d{6}$/;\n\n/**\n * Normalise a Maldivian national ID card number: trims, removes spaces and\n * dashes, and uppercases the letter. \"a 123-456\" → \"A123456\".\n *\n * Returns `null` if the result isn't in the A + 6 digits format.\n */\nexport function normalizeNationalId(input: string): string | null {\n\tconst value = input.trim().replace(/[\\s-]/g, '').toUpperCase();\n\treturn NATIONAL_ID.test(value) ? value : null;\n}\n\n/**\n * True if the input has the format of a Maldivian national ID card number\n * (A followed by 6 digits).\n *\n * This only checks the format. It can't tell whether the card exists or who\n * it belongs to; for real identity verification use eFaas.\n */\nexport function isValidNationalId(input: string): boolean {\n\treturn normalizeNationalId(input) !== null;\n}\n"],"mappings":";AAYA,IAAM,eAAe;AAMrB,IAAM,QAA6C;AAAA,EAClD,KAAK;AAAA,EACL,KAAK;AAAA,EACL,KAAK;AAAA,EACL,KAAK;AACN;AAQO,SAAS,WAAW,OAAmC;AAC7D,MAAI,SAAS,MAAM,KAAK;AACxB,MAAI,CAAC,oBAAoB,KAAK,MAAM,EAAG,QAAO;AAE9C,WAAS,OAAO,QAAQ,OAAO,EAAE;AACjC,MAAI,OAAO,WAAW,MAAM,OAAO,WAAW,OAAO,YAAY,EAAG,UAAS,OAAO,MAAM,CAAC;AAAA,WAClF,OAAO,WAAW,MAAM,OAAO,WAAW,YAAY,EAAG,UAAS,OAAO,MAAM,CAAC;AAEzF,MAAI,CAAC,UAAU,KAAK,MAAM,EAAG,QAAO;AACpC,QAAM,OAAO,MAAM,OAAO,CAAC,CAAE;AAC7B,MAAI,CAAC,KAAM,QAAO;AAElB,SAAO;AAAA,IACN,UAAU;AAAA,IACV,MAAM,IAAI,YAAY,GAAG,MAAM;AAAA,IAC/B,eAAe,IAAI,YAAY,IAAI,OAAO,MAAM,GAAG,CAAC,CAAC,IAAI,OAAO,MAAM,CAAC,CAAC;AAAA,IACxE;AAAA,EACD;AACD;AAGO,SAAS,aAAa,OAAwB;AACpD,SAAO,WAAW,KAAK,MAAM;AAC9B;AAGO,SAAS,SAAS,OAAwB;AAChD,SAAO,WAAW,KAAK,GAAG,SAAS;AACpC;;;AC3DA,IAAM,cAAc;AAQb,SAAS,oBAAoB,OAA8B;AACjE,QAAM,QAAQ,MAAM,KAAK,EAAE,QAAQ,UAAU,EAAE,EAAE,YAAY;AAC7D,SAAO,YAAY,KAAK,KAAK,IAAI,QAAQ;AAC1C;AASO,SAAS,kBAAkB,OAAwB;AACzD,SAAO,oBAAoB,KAAK,MAAM;AACvC;","names":[]}

package/package.json

@@ -1,6 +1,47 @@
 {
   "name": "@ruhlabs/validators",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.0",
+  "description": "Validators and formatters for Maldivian phone numbers and national ID card numbers",
+  "license": "MIT",
+  "author": "Ruh Labs",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ruhlabs/devtools.git",
+    "directory": "packages/validators"
+  },
+  "keywords": [
+    "maldives",
+    "validation",
+    "phone",
+    "national-id",
+    "ruhlabs"
+  ],
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "sideEffects": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit"
+  }
 }