saudi-utils 0.1.0 → 0.2.0

package/dist/combined.js

@@ -0,0 +1,81 @@
+import { normalizeShortAddressInput } from "./address.js";
+import { normalizeIbanInput } from "./banking.js";
+import { validateLandlineNumberDetailed, validateMobileNumberDetailed, validateSaudiIbanDetailed, validateShortAddressDetailed, validateTollFreeNumberDetailed, } from "./detailed.js";
+import { normalizePhoneNumberInput } from "./telecom.js";
+function unsupportedInput(value, label) {
+    let code;
+    let reason;
+    if (value === undefined || value === null || value === "") {
+        code = "REQUIRED";
+        reason = "is required.";
+    }
+    else if (typeof value !== "string") {
+        code = "INVALID_TYPE";
+        reason = "has an invalid type.";
+    }
+    else {
+        code = "INVALID_FORMAT";
+        reason = "uses an unsupported representation.";
+    }
+    return { valid: false, code, message: `${label} ${reason}` };
+}
+function withCandidate(result, candidate) {
+    if (result.valid) {
+        return result;
+    }
+    return candidate.length > 0 && candidate.length <= 64
+        ? { ...result, normalizedValue: candidate }
+        : result;
+}
+/**
+ * Normalizes and validates a Saudi IBAN using the same rules as normalizeIban and validateSaudiIbanDetailed.
+ * @param value - Primitive string; ASCII spaces are removed and ASCII letters are uppercased.
+ * @returns The validated uppercase IBAN, or a code and message. A safe candidate is included on validation failure.
+ * @example
+ * normalizeAndValidateIban("sa03 8000 0000 6080 1016 7519"); // { valid: true, value: "SA0380000000608010167519" }
+ */
+export function normalizeAndValidateIban(value) {
+    const candidate = normalizeIbanInput(value);
+    return candidate === null
+        ? unsupportedInput(value, "Saudi IBAN")
+        : withCandidate(validateSaudiIbanDetailed(candidate), candidate);
+}
+/**
+ * Normalizes and validates a Saudi Short Address using the same rules as normalizeShortAddress and validateShortAddressDetailed.
+ * @param value - Primitive string with four ASCII letters, optional one ASCII space, then ASCII digits.
+ * @returns The validated uppercase eight-character address, or a code and message with a safe candidate when available.
+ */
+export function normalizeAndValidateShortAddress(value) {
+    const candidate = normalizeShortAddressInput(value);
+    return candidate === null
+        ? unsupportedInput(value, "Short Address")
+        : withCandidate(validateShortAddressDetailed(candidate), candidate);
+}
+/**
+ * Normalizes and validates a Saudi mobile, landline, or toll-free number.
+ * @param value - Primitive string in a supported unseparated national or country-code form.
+ * @returns A kind-tagged canonical phone value, or a code and message with a safe candidate when available.
+ * Mobile and landline values use +966 form; toll-free values use national 800 form.
+ */
+export function normalizeAndValidatePhoneNumber(value) {
+    const candidate = normalizePhoneNumberInput(value);
+    if (candidate === null) {
+        return unsupportedInput(value, "Phone number");
+    }
+    if (candidate.startsWith("800")) {
+        const result = validateTollFreeNumberDetailed(candidate);
+        return result.valid
+            ? { valid: true, value: { kind: "toll-free", value: `800${result.value.slice(3)}` } }
+            : withCandidate(result, candidate);
+    }
+    const result = candidate.startsWith("+9661")
+        ? validateLandlineNumberDetailed(candidate)
+        : validateMobileNumberDetailed(candidate);
+    if (!result.valid) {
+        return withCandidate(result, candidate);
+    }
+    return candidate.startsWith("+9661")
+        ? { valid: true, value: { kind: "landline", value: `+966${result.value.slice(4)}` } }
+        : { valid: true, value: { kind: "mobile", value: `+966${result.value.slice(4)}` } };
+}
+//# sourceMappingURL=combined.js.map

package/dist/combined.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"combined.js","sourceRoot":"","sources":["../src/combined.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,cAAc,CAAC;AAC1D,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAClD,OAAO,EACL,8BAA8B,EAC9B,4BAA4B,EAC5B,yBAAyB,EACzB,4BAA4B,EAC5B,8BAA8B,GAC/B,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,yBAAyB,EAAE,MAAM,cAAc,CAAC;AAOzD,SAAS,gBAAgB,CAAC,KAAc,EAAE,KAAa;IACrD,IAAI,IAAyB,CAAC;IAC9B,IAAI,MAAc,CAAC;IAEnB,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;QAC1D,IAAI,GAAG,UAAU,CAAC;QAClB,MAAM,GAAG,cAAc,CAAC;IAC1B,CAAC;SAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACrC,IAAI,GAAG,cAAc,CAAC;QACtB,MAAM,GAAG,sBAAsB,CAAC;IAClC,CAAC;SAAM,CAAC;QACN,IAAI,GAAG,gBAAgB,CAAC;QACxB,MAAM,GAAG,qCAAqC,CAAC;IACjD,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,KAAK,IAAI,MAAM,EAAE,EAAE,CAAC;AAC/D,CAAC;AAED,SAAS,aAAa,CACpB,MAAmC,EACnC,SAAiB;IAEjB,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,OAAO,SAAS,CAAC,MAAM,GAAG,CAAC,IAAI,SAAS,CAAC,MAAM,IAAI,EAAE;QACnD,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,eAAe,EAAE,SAAS,EAAE;QAC3C,CAAC,CAAC,MAAM,CAAC;AACb,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,wBAAwB,CAAC,KAAc;IACrD,MAAM,SAAS,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;IAC5C,OAAO,SAAS,KAAK,IAAI;QACvB,CAAC,CAAC,gBAAgB,CAAC,KAAK,EAAE,YAAY,CAAC;QACvC,CAAC,CAAC,aAAa,CAAC,yBAAyB,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC,CAAC;AACrE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,gCAAgC,CAAC,KAAc;IAC7D,MAAM,SAAS,GAAG,0BAA0B,CAAC,KAAK,CAAC,CAAC;IACpD,OAAO,SAAS,KAAK,IAAI;QACvB,CAAC,CAAC,gBAAgB,CAAC,KAAK,EAAE,eAAe,CAAC;QAC1C,CAAC,CAAC,aAAa,CAAC,4BAA4B,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC,CAAC;AACxE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,+BAA+B,CAC7C,KAAc;IAEd,MAAM,SAAS,GAAG,yBAAyB,CAAC,KAAK,CAAC,CAAC;IAEnD,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;QACvB,OAAO,gBAAgB,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;IACjD,CAAC;IAED,IAAI,SAAS,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;QAChC,MAAM,MAAM,GAAG,8BAA8B,CAAC,SAAS,CAAC,CAAC;QACzD,OAAO,MAAM,CAAC,KAAK;YACjB,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE;YACrF,CAAC,CAAC,aAAa,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACvC,CAAC;IAED,MAAM,MAAM,GAAG,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC;QAC1C,CAAC,CAAC,8BAA8B,CAAC,SAAS,CAAC;QAC3C,CAAC,CAAC,4BAA4B,CAAC,SAAS,CAAC,CAAC;IAE5C,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;QAClB,OAAO,aAAa,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAC1C,CAAC;IAED,OAAO,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC;QAClC,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE;QACrF,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC;AACxF,CAAC"}

package/dist/detailed.d.ts

@@ -0,0 +1,104 @@
+import type { DetailedValidationResult, NationalAddress } from "./types.js";
+/**
+ * Validates a national ID and explains the first failure without changing the canonical input.
+ * @param value - Input to check; only the documented canonical representation is accepted.
+ * @returns The unchanged validated value, or a code and message for the first failure.
+ */
+export declare function validateNationalIdDetailed(value: unknown): DetailedValidationResult<string>;
+/**
+ * Validates an Iqama and explains the first failure without changing the canonical input.
+ * @param value - Input to check; only the documented canonical representation is accepted.
+ * @returns The unchanged validated value, or a code and message for the first failure.
+ */
+export declare function validateIqamaDetailed(value: unknown): DetailedValidationResult<string>;
+/**
+ * Validates a Saudi person ID and explains the first failure without changing the canonical input.
+ * @param value - Input to check; only the documented canonical representation is accepted.
+ * @returns The unchanged validated value, or a code and message for the first failure.
+ */
+export declare function validateSaudiIdDetailed(value: unknown): DetailedValidationResult<string>;
+/**
+ * Validates a Border ID and explains the first failure without changing the canonical input.
+ * @param value - Input to check; only the documented canonical representation is accepted.
+ * @returns The unchanged validated value, or a code and message for the first failure.
+ */
+export declare function validateBorderIdDetailed(value: unknown): DetailedValidationResult<string>;
+/**
+ * Validates a Saudi IBAN and explains the first failure without changing the canonical input.
+ * @param value - Input to check; only the documented canonical representation is accepted.
+ * @returns The unchanged validated value, or a code and message for the first failure.
+ */
+export declare function validateSaudiIbanDetailed(value: unknown): DetailedValidationResult<string>;
+/**
+ * Validates a VAT number and explains the first failure without changing the canonical input.
+ * @param value - Input to check; only the documented canonical representation is accepted.
+ * @returns The unchanged validated value, or a code and message for the first failure.
+ */
+export declare function validateVatNumberDetailed(value: unknown): DetailedValidationResult<string>;
+/**
+ * Validates a TIN and explains the first failure without changing the canonical input.
+ * @param value - Input to check; only the documented canonical representation is accepted.
+ * @returns The unchanged validated value, or a code and message for the first failure.
+ */
+export declare function validateTinDetailed(value: unknown): DetailedValidationResult<string>;
+/**
+ * Validates a Unified National Number and explains the first failure without changing the canonical input.
+ * @param value - Input to check; only the documented canonical representation is accepted.
+ * @returns The unchanged validated value, or a code and message for the first failure.
+ */
+export declare function validateUnifiedNationalNumberDetailed(value: unknown): DetailedValidationResult<string>;
+/**
+ * Validates a legacy Commercial Registration number and explains the first failure without changing the canonical input.
+ * @param value - Input to check; only the documented canonical representation is accepted.
+ * @returns The unchanged validated value, or a code and message for the first failure.
+ */
+export declare function validateCommercialRegistrationDetailed(value: unknown): DetailedValidationResult<string>;
+/**
+ * Validates a mobile number and explains the first failure without changing the canonical input.
+ * @param value - Input to check; only the documented canonical representation is accepted.
+ * @returns The unchanged validated value, or a code and message for the first failure.
+ */
+export declare function validateMobileNumberDetailed(value: unknown): DetailedValidationResult<string>;
+/**
+ * Validates a landline number and explains the first failure without changing the canonical input.
+ * @param value - Input to check; only the documented canonical representation is accepted.
+ * @returns The unchanged validated value, or a code and message for the first failure.
+ */
+export declare function validateLandlineNumberDetailed(value: unknown): DetailedValidationResult<string>;
+/**
+ * Validates a toll-free number and explains the first failure without changing the canonical input.
+ * @param value - Input to check; only the documented canonical representation is accepted.
+ * @returns The unchanged validated value, or a code and message for the first failure.
+ */
+export declare function validateTollFreeNumberDetailed(value: unknown): DetailedValidationResult<string>;
+/**
+ * Validates a postal code and explains the first failure without changing the canonical input.
+ * @param value - Input to check; only the documented canonical representation is accepted.
+ * @returns The unchanged validated value, or a code and message for the first failure.
+ */
+export declare function validatePostalCodeDetailed(value: unknown): DetailedValidationResult<string>;
+/**
+ * Validates a building number and explains the first failure without changing the canonical input.
+ * @param value - Input to check; only the documented canonical representation is accepted.
+ * @returns The unchanged validated value, or a code and message for the first failure.
+ */
+export declare function validateBuildingNumberDetailed(value: unknown): DetailedValidationResult<string>;
+/**
+ * Validates an additional number and explains the first failure without changing the canonical input.
+ * @param value - Input to check; only the documented canonical representation is accepted.
+ * @returns The unchanged validated value, or a code and message for the first failure.
+ */
+export declare function validateAdditionalNumberDetailed(value: unknown): DetailedValidationResult<string>;
+/**
+ * Validates a Short Address and explains the first failure without changing the canonical input.
+ * @param value - Input to check; only the documented canonical representation is accepted.
+ * @returns The unchanged validated value, or a code and message for the first failure.
+ */
+export declare function validateShortAddressDetailed(value: unknown): DetailedValidationResult<string>;
+/**
+ * Validates a National Address and explains the first failure without changing the canonical input.
+ * @param value - Input to check; only the documented canonical representation is accepted.
+ * @returns The unchanged validated value, or a code and message for the first failure.
+ */
+export declare function validateNationalAddressDetailed(value: unknown): DetailedValidationResult<NationalAddress>;
+//# sourceMappingURL=detailed.d.ts.map

package/dist/detailed.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"detailed.d.ts","sourceRoot":"","sources":["../src/detailed.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,eAAe,EAAuB,MAAM,YAAY,CAAC;AA0CjG;;;;GAIG;AACH,wBAAgB,0BAA0B,CAAC,KAAK,EAAE,OAAO,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAE3F;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,OAAO,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAEtF;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,OAAO,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAExF;AAED;;;;GAIG;AACH,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,OAAO,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAEzF;AAED;;;;GAIG;AACH,wBAAgB,yBAAyB,CAAC,KAAK,EAAE,OAAO,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAE1F;AAED;;;;GAIG;AACH,wBAAgB,yBAAyB,CAAC,KAAK,EAAE,OAAO,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAE1F;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,OAAO,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAEpF;AAED;;;;GAIG;AACH,wBAAgB,qCAAqC,CACnD,KAAK,EAAE,OAAO,GACb,wBAAwB,CAAC,MAAM,CAAC,CAElC;AAED;;;;GAIG;AACH,wBAAgB,sCAAsC,CACpD,KAAK,EAAE,OAAO,GACb,wBAAwB,CAAC,MAAM,CAAC,CAElC;AAED;;;;GAIG;AACH,wBAAgB,4BAA4B,CAAC,KAAK,EAAE,OAAO,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAE7F;AAED;;;;GAIG;AACH,wBAAgB,8BAA8B,CAAC,KAAK,EAAE,OAAO,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAE/F;AAED;;;;GAIG;AACH,wBAAgB,8BAA8B,CAAC,KAAK,EAAE,OAAO,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAE/F;AAED;;;;GAIG;AACH,wBAAgB,0BAA0B,CAAC,KAAK,EAAE,OAAO,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAE3F;AAED;;;;GAIG;AACH,wBAAgB,8BAA8B,CAAC,KAAK,EAAE,OAAO,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAE/F;AAED;;;;GAIG;AACH,wBAAgB,gCAAgC,CAAC,KAAK,EAAE,OAAO,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAEjG;AAED;;;;GAIG;AACH,wBAAgB,4BAA4B,CAAC,KAAK,EAAE,OAAO,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAE7F;AAED;;;;GAIG;AACH,wBAAgB,+BAA+B,CAC7C,KAAK,EAAE,OAAO,GACb,wBAAwB,CAAC,eAAe,CAAC,CAE3C"}

package/dist/detailed.js

@@ -0,0 +1,156 @@
+import { validateNationalId, validateIqama, validateSaudiId, validateBorderId, } from "./identity.js";
+import { validateSaudiIban } from "./banking.js";
+import { validateVatNumber, validateTin, validateUnifiedNationalNumber, validateCommercialRegistration, } from "./business.js";
+import { validateMobileNumber, validateLandlineNumber, validateTollFreeNumber } from "./telecom.js";
+import { validatePostalCode, validateBuildingNumber, validateAdditionalNumber, validateShortAddress, validateNationalAddress, } from "./address.js";
+const REASONS = {
+    REQUIRED: "is required.",
+    INVALID_TYPE: "has an invalid type.",
+    INVALID_LENGTH: "has an invalid length.",
+    INVALID_FORMAT: "has an invalid format.",
+    INVALID_PREFIX: "has an invalid prefix.",
+    INVALID_CHECKSUM: "has an invalid checksum.",
+};
+function explain(result, label) {
+    if (result.valid) {
+        return { valid: true, value: result.value };
+    }
+    return { valid: false, code: result.code, message: `${label} ${REASONS[result.code]}` };
+}
+/**
+ * Validates a national ID and explains the first failure without changing the canonical input.
+ * @param value - Input to check; only the documented canonical representation is accepted.
+ * @returns The unchanged validated value, or a code and message for the first failure.
+ */
+export function validateNationalIdDetailed(value) {
+    return explain(validateNationalId(value), "National ID");
+}
+/**
+ * Validates an Iqama and explains the first failure without changing the canonical input.
+ * @param value - Input to check; only the documented canonical representation is accepted.
+ * @returns The unchanged validated value, or a code and message for the first failure.
+ */
+export function validateIqamaDetailed(value) {
+    return explain(validateIqama(value), "Iqama");
+}
+/**
+ * Validates a Saudi person ID and explains the first failure without changing the canonical input.
+ * @param value - Input to check; only the documented canonical representation is accepted.
+ * @returns The unchanged validated value, or a code and message for the first failure.
+ */
+export function validateSaudiIdDetailed(value) {
+    return explain(validateSaudiId(value), "Saudi person ID");
+}
+/**
+ * Validates a Border ID and explains the first failure without changing the canonical input.
+ * @param value - Input to check; only the documented canonical representation is accepted.
+ * @returns The unchanged validated value, or a code and message for the first failure.
+ */
+export function validateBorderIdDetailed(value) {
+    return explain(validateBorderId(value), "Border ID");
+}
+/**
+ * Validates a Saudi IBAN and explains the first failure without changing the canonical input.
+ * @param value - Input to check; only the documented canonical representation is accepted.
+ * @returns The unchanged validated value, or a code and message for the first failure.
+ */
+export function validateSaudiIbanDetailed(value) {
+    return explain(validateSaudiIban(value), "Saudi IBAN");
+}
+/**
+ * Validates a VAT number and explains the first failure without changing the canonical input.
+ * @param value - Input to check; only the documented canonical representation is accepted.
+ * @returns The unchanged validated value, or a code and message for the first failure.
+ */
+export function validateVatNumberDetailed(value) {
+    return explain(validateVatNumber(value), "VAT number");
+}
+/**
+ * Validates a TIN and explains the first failure without changing the canonical input.
+ * @param value - Input to check; only the documented canonical representation is accepted.
+ * @returns The unchanged validated value, or a code and message for the first failure.
+ */
+export function validateTinDetailed(value) {
+    return explain(validateTin(value), "TIN");
+}
+/**
+ * Validates a Unified National Number and explains the first failure without changing the canonical input.
+ * @param value - Input to check; only the documented canonical representation is accepted.
+ * @returns The unchanged validated value, or a code and message for the first failure.
+ */
+export function validateUnifiedNationalNumberDetailed(value) {
+    return explain(validateUnifiedNationalNumber(value), "Unified National Number");
+}
+/**
+ * Validates a legacy Commercial Registration number and explains the first failure without changing the canonical input.
+ * @param value - Input to check; only the documented canonical representation is accepted.
+ * @returns The unchanged validated value, or a code and message for the first failure.
+ */
+export function validateCommercialRegistrationDetailed(value) {
+    return explain(validateCommercialRegistration(value), "Legacy Commercial Registration number");
+}
+/**
+ * Validates a mobile number and explains the first failure without changing the canonical input.
+ * @param value - Input to check; only the documented canonical representation is accepted.
+ * @returns The unchanged validated value, or a code and message for the first failure.
+ */
+export function validateMobileNumberDetailed(value) {
+    return explain(validateMobileNumber(value), "Mobile number");
+}
+/**
+ * Validates a landline number and explains the first failure without changing the canonical input.
+ * @param value - Input to check; only the documented canonical representation is accepted.
+ * @returns The unchanged validated value, or a code and message for the first failure.
+ */
+export function validateLandlineNumberDetailed(value) {
+    return explain(validateLandlineNumber(value), "Landline number");
+}
+/**
+ * Validates a toll-free number and explains the first failure without changing the canonical input.
+ * @param value - Input to check; only the documented canonical representation is accepted.
+ * @returns The unchanged validated value, or a code and message for the first failure.
+ */
+export function validateTollFreeNumberDetailed(value) {
+    return explain(validateTollFreeNumber(value), "Toll-free number");
+}
+/**
+ * Validates a postal code and explains the first failure without changing the canonical input.
+ * @param value - Input to check; only the documented canonical representation is accepted.
+ * @returns The unchanged validated value, or a code and message for the first failure.
+ */
+export function validatePostalCodeDetailed(value) {
+    return explain(validatePostalCode(value), "Postal code");
+}
+/**
+ * Validates a building number and explains the first failure without changing the canonical input.
+ * @param value - Input to check; only the documented canonical representation is accepted.
+ * @returns The unchanged validated value, or a code and message for the first failure.
+ */
+export function validateBuildingNumberDetailed(value) {
+    return explain(validateBuildingNumber(value), "Building number");
+}
+/**
+ * Validates an additional number and explains the first failure without changing the canonical input.
+ * @param value - Input to check; only the documented canonical representation is accepted.
+ * @returns The unchanged validated value, or a code and message for the first failure.
+ */
+export function validateAdditionalNumberDetailed(value) {
+    return explain(validateAdditionalNumber(value), "Additional number");
+}
+/**
+ * Validates a Short Address and explains the first failure without changing the canonical input.
+ * @param value - Input to check; only the documented canonical representation is accepted.
+ * @returns The unchanged validated value, or a code and message for the first failure.
+ */
+export function validateShortAddressDetailed(value) {
+    return explain(validateShortAddress(value), "Short Address");
+}
+/**
+ * Validates a National Address and explains the first failure without changing the canonical input.
+ * @param value - Input to check; only the documented canonical representation is accepted.
+ * @returns The unchanged validated value, or a code and message for the first failure.
+ */
+export function validateNationalAddressDetailed(value) {
+    return explain(validateNationalAddress(value), "National Address");
+}
+//# sourceMappingURL=detailed.js.map

package/dist/detailed.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"detailed.js","sourceRoot":"","sources":["../src/detailed.ts"],"names":[],"mappings":"AACA,OAAO,EACL,kBAAkB,EAClB,aAAa,EACb,eAAe,EACf,gBAAgB,GACjB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACjD,OAAO,EACL,iBAAiB,EACjB,WAAW,EACX,6BAA6B,EAC7B,8BAA8B,GAC/B,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,oBAAoB,EAAE,sBAAsB,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAC;AACpG,OAAO,EACL,kBAAkB,EAClB,sBAAsB,EACtB,wBAAwB,EACxB,oBAAoB,EACpB,uBAAuB,GACxB,MAAM,cAAc,CAAC;AAEtB,MAAM,OAAO,GAAwC;IACnD,QAAQ,EAAE,cAAc;IACxB,YAAY,EAAE,sBAAsB;IACpC,cAAc,EAAE,wBAAwB;IACxC,cAAc,EAAE,wBAAwB;IACxC,cAAc,EAAE,wBAAwB;IACxC,gBAAgB,EAAE,0BAA0B;CAC7C,CAAC;AAEF,SAAS,OAAO,CACd,MAA+E,EAC/E,KAAa;IAEb,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC;IAC9C,CAAC;IACD,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,OAAO,EAAE,GAAG,KAAK,IAAI,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;AAC1F,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,0BAA0B,CAAC,KAAc;IACvD,OAAO,OAAO,CAAC,kBAAkB,CAAC,KAAK,CAAC,EAAE,aAAa,CAAC,CAAC;AAC3D,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,qBAAqB,CAAC,KAAc;IAClD,OAAO,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,CAAC;AAChD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CAAC,KAAc;IACpD,OAAO,OAAO,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE,iBAAiB,CAAC,CAAC;AAC5D,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,wBAAwB,CAAC,KAAc;IACrD,OAAO,OAAO,CAAC,gBAAgB,CAAC,KAAK,CAAC,EAAE,WAAW,CAAC,CAAC;AACvD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,yBAAyB,CAAC,KAAc;IACtD,OAAO,OAAO,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE,YAAY,CAAC,CAAC;AACzD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,yBAAyB,CAAC,KAAc;IACtD,OAAO,OAAO,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE,YAAY,CAAC,CAAC;AACzD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CAAC,KAAc;IAChD,OAAO,OAAO,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC;AAC5C,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,qCAAqC,CACnD,KAAc;IAEd,OAAO,OAAO,CAAC,6BAA6B,CAAC,KAAK,CAAC,EAAE,yBAAyB,CAAC,CAAC;AAClF,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,sCAAsC,CACpD,KAAc;IAEd,OAAO,OAAO,CAAC,8BAA8B,CAAC,KAAK,CAAC,EAAE,uCAAuC,CAAC,CAAC;AACjG,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,4BAA4B,CAAC,KAAc;IACzD,OAAO,OAAO,CAAC,oBAAoB,CAAC,KAAK,CAAC,EAAE,eAAe,CAAC,CAAC;AAC/D,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,8BAA8B,CAAC,KAAc;IAC3D,OAAO,OAAO,CAAC,sBAAsB,CAAC,KAAK,CAAC,EAAE,iBAAiB,CAAC,CAAC;AACnE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,8BAA8B,CAAC,KAAc;IAC3D,OAAO,OAAO,CAAC,sBAAsB,CAAC,KAAK,CAAC,EAAE,kBAAkB,CAAC,CAAC;AACpE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,0BAA0B,CAAC,KAAc;IACvD,OAAO,OAAO,CAAC,kBAAkB,CAAC,KAAK,CAAC,EAAE,aAAa,CAAC,CAAC;AAC3D,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,8BAA8B,CAAC,KAAc;IAC3D,OAAO,OAAO,CAAC,sBAAsB,CAAC,KAAK,CAAC,EAAE,iBAAiB,CAAC,CAAC;AACnE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,gCAAgC,CAAC,KAAc;IAC7D,OAAO,OAAO,CAAC,wBAAwB,CAAC,KAAK,CAAC,EAAE,mBAAmB,CAAC,CAAC;AACvE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,4BAA4B,CAAC,KAAc;IACzD,OAAO,OAAO,CAAC,oBAAoB,CAAC,KAAK,CAAC,EAAE,eAAe,CAAC,CAAC;AAC/D,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,+BAA+B,CAC7C,KAAc;IAEd,OAAO,OAAO,CAAC,uBAAuB,CAAC,KAAK,CAAC,EAAE,kBAAkB,CAAC,CAAC;AACrE,CAAC"}

package/dist/identity.d.ts

@@ -1,11 +1,73 @@
 import type { ValidationResult } from "./types.js";
+/**
+ * Validates a Saudi national ID: 10 ASCII digits starting with 1 and a valid check digit.
+ *
+ * Does not establish issuance, holder identity, or current status.
+ *
+ * @param value - Unknown input; only a primitive string in the stated canonical format is accepted.
+ * @returns A result containing the unchanged string when valid, or the first applicable error code.
+ */
 export declare function validateNationalId(value: unknown): ValidationResult;
+/**
+ * Checks a Saudi national ID using the same structural and checksum rules as validateNationalId.
+ *
+ * @param value - Unknown input; only a primitive string in the stated canonical format is accepted.
+ * @returns True when the input satisfies the stated offline rules; false otherwise.
+ */
 export declare function isNationalId(value: unknown): boolean;
+/**
+ * Validates an Iqama: 10 ASCII digits starting with 2 and a valid check digit.
+ *
+ * Does not establish issuance, residency, or current status.
+ *
+ * @param value - Unknown input; only a primitive string in the stated canonical format is accepted.
+ * @returns A result containing the unchanged string when valid, or the first applicable error code.
+ */
 export declare function validateIqama(value: unknown): ValidationResult;
+/**
+ * Checks an Iqama using the same structural and checksum rules as validateIqama.
+ *
+ * @param value - Unknown input; only a primitive string in the stated canonical format is accepted.
+ * @returns True when the input satisfies the stated offline rules; false otherwise.
+ */
 export declare function isIqama(value: unknown): boolean;
+/**
+ * Validates either a Saudi national ID or Iqama, including its check digit.
+ *
+ * Accepts only 10 ASCII digits starting with 1 or 2.
+ *
+ * @param value - Unknown input; only a primitive string in the stated canonical format is accepted.
+ * @returns A result containing the unchanged string when valid, or the first applicable error code.
+ */
 export declare function validateSaudiId(value: unknown): ValidationResult;
+/**
+ * Checks whether a value is a valid national ID or Iqama.
+ *
+ * @param value - Unknown input; only a primitive string in the stated canonical format is accepted.
+ * @returns True when the input satisfies the stated offline rules; false otherwise.
+ */
 export declare function isSaudiId(value: unknown): boolean;
+/**
+ * Identifies a valid Saudi national ID or Iqama.
+ *
+ * @param value - Unknown input; only a primitive string in the stated canonical format is accepted.
+ * @returns "national-id" or "iqama" for a valid value; null otherwise.
+ */
 export declare function getSaudiIdType(value: unknown): "national-id" | "iqama" | null;
+/**
+ * Checks the provisional Border ID structure: 10 ASCII digits starting with 3 or 4.
+ *
+ * No checksum, issuance, or status is verified.
+ *
+ * @param value - Unknown input; only a primitive string in the stated canonical format is accepted.
+ * @returns A result containing the unchanged string when valid, or the first applicable error code.
+ */
 export declare function validateBorderId(value: unknown): ValidationResult;
+/**
+ * Checks the provisional Border ID structure without claiming issuance or status.
+ *
+ * @param value - Unknown input; only a primitive string in the stated canonical format is accepted.
+ * @returns True when the input satisfies the stated offline rules; false otherwise.
+ */
 export declare function isBorderId(value: unknown): boolean;
 //# sourceMappingURL=identity.d.ts.map

package/dist/identity.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"identity.d.ts","sourceRoot":"","sources":["../src/identity.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAEnD,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,gBAAgB,CAwBnE;AAED,wBAAgB,YAAY,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAEpD;AAED,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,gBAAgB,CAwB9D;AAED,wBAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAE/C;AAED,wBAAgB,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,gBAAgB,CAQhE;AAED,wBAAgB,SAAS,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAEjD;AAED,wBAAgB,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,aAAa,GAAG,OAAO,GAAG,IAAI,CAQ7E;AAED,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,gBAAgB,CAoBjE;AAED,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAElD"}
+{"version":3,"file":"identity.d.ts","sourceRoot":"","sources":["../src/identity.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAEnD;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,gBAAgB,CAwBnE;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAEpD;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,gBAAgB,CAwB9D;AAED;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAE/C;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,gBAAgB,CAQhE;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAEjD;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,aAAa,GAAG,OAAO,GAAG,IAAI,CAQ7E;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,gBAAgB,CAoBjE;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAElD"}

package/dist/identity.js

@@ -1,6 +1,14 @@
 import { isAsciiDigits } from "./internal/ascii.js";
 import { hasValidSaudiIdentityChecksum } from "./internal/identity-checksum.js";
 import { checkStringInput } from "./internal/input.js";
+/**
+ * Validates a Saudi national ID: 10 ASCII digits starting with 1 and a valid check digit.
+ *
+ * Does not establish issuance, holder identity, or current status.
+ *
+ * @param value - Unknown input; only a primitive string in the stated canonical format is accepted.
+ * @returns A result containing the unchanged string when valid, or the first applicable error code.
+ */
 export function validateNationalId(value) {
     const input = checkStringInput(value);
     if (!input.valid) {
@@ -20,9 +28,23 @@ export function validateNationalId(value) {
     }
     return { valid: true, value: input.value };
 }
+/**
+ * Checks a Saudi national ID using the same structural and checksum rules as validateNationalId.
+ *
+ * @param value - Unknown input; only a primitive string in the stated canonical format is accepted.
+ * @returns True when the input satisfies the stated offline rules; false otherwise.
+ */
 export function isNationalId(value) {
     return validateNationalId(value).valid;
 }
+/**
+ * Validates an Iqama: 10 ASCII digits starting with 2 and a valid check digit.
+ *
+ * Does not establish issuance, residency, or current status.
+ *
+ * @param value - Unknown input; only a primitive string in the stated canonical format is accepted.
+ * @returns A result containing the unchanged string when valid, or the first applicable error code.
+ */
 export function validateIqama(value) {
     const input = checkStringInput(value);
     if (!input.valid) {
@@ -42,9 +64,23 @@ export function validateIqama(value) {
     }
     return { valid: true, value: input.value };
 }
+/**
+ * Checks an Iqama using the same structural and checksum rules as validateIqama.
+ *
+ * @param value - Unknown input; only a primitive string in the stated canonical format is accepted.
+ * @returns True when the input satisfies the stated offline rules; false otherwise.
+ */
 export function isIqama(value) {
     return validateIqama(value).valid;
 }
+/**
+ * Validates either a Saudi national ID or Iqama, including its check digit.
+ *
+ * Accepts only 10 ASCII digits starting with 1 or 2.
+ *
+ * @param value - Unknown input; only a primitive string in the stated canonical format is accepted.
+ * @returns A result containing the unchanged string when valid, or the first applicable error code.
+ */
 export function validateSaudiId(value) {
     const nationalId = validateNationalId(value);
     if (nationalId.valid || nationalId.code !== "INVALID_PREFIX") {
@@ -52,9 +88,21 @@ export function validateSaudiId(value) {
     }
     return validateIqama(value);
 }
+/**
+ * Checks whether a value is a valid national ID or Iqama.
+ *
+ * @param value - Unknown input; only a primitive string in the stated canonical format is accepted.
+ * @returns True when the input satisfies the stated offline rules; false otherwise.
+ */
 export function isSaudiId(value) {
     return validateSaudiId(value).valid;
 }
+/**
+ * Identifies a valid Saudi national ID or Iqama.
+ *
+ * @param value - Unknown input; only a primitive string in the stated canonical format is accepted.
+ * @returns "national-id" or "iqama" for a valid value; null otherwise.
+ */
 export function getSaudiIdType(value) {
     const result = validateSaudiId(value);
     if (!result.valid) {
@@ -62,6 +110,14 @@ export function getSaudiIdType(value) {
     }
     return result.value.startsWith("1") ? "national-id" : "iqama";
 }
+/**
+ * Checks the provisional Border ID structure: 10 ASCII digits starting with 3 or 4.
+ *
+ * No checksum, issuance, or status is verified.
+ *
+ * @param value - Unknown input; only a primitive string in the stated canonical format is accepted.
+ * @returns A result containing the unchanged string when valid, or the first applicable error code.
+ */
 export function validateBorderId(value) {
     const input = checkStringInput(value);
     if (!input.valid) {
@@ -78,6 +134,12 @@ export function validateBorderId(value) {
     }
     return { valid: true, value: input.value };
 }
+/**
+ * Checks the provisional Border ID structure without claiming issuance or status.
+ *
+ * @param value - Unknown input; only a primitive string in the stated canonical format is accepted.
+ * @returns True when the input satisfies the stated offline rules; false otherwise.
+ */
 export function isBorderId(value) {
     return validateBorderId(value).valid;
 }

package/dist/identity.js.map

@@ -1 +1 @@
-{"version":3,"file":"identity.js","sourceRoot":"","sources":["../src/identity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAChF,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAGvD,MAAM,UAAU,kBAAkB,CAAC,KAAc;IAC/C,MAAM,KAAK,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC;IAEtC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QACjB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;QAC9B,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;IAClD,CAAC;IAED,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;QAChC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;IAClD,CAAC;IAED,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QACjC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;IAClD,CAAC;IAED,IAAI,CAAC,6BAA6B,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;QAChD,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,kBAAkB,EAAE,CAAC;IACpD,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC;AAC7C,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,KAAc;IACzC,OAAO,kBAAkB,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC;AACzC,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,KAAc;IAC1C,MAAM,KAAK,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC;IAEtC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QACjB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;QAC9B,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;IAClD,CAAC;IAED,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;QAChC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;IAClD,CAAC;IAED,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QACjC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;IAClD,CAAC;IAED,IAAI,CAAC,6BAA6B,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;QAChD,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,kBAAkB,EAAE,CAAC;IACpD,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC;AAC7C,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,KAAc;IACpC,OAAO,aAAa,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,KAAc;IAC5C,MAAM,UAAU,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;IAE7C,IAAI,UAAU,CAAC,KAAK,IAAI,UAAU,CAAC,IAAI,KAAK,gBAAgB,EAAE,CAAC;QAC7D,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,OAAO,aAAa,CAAC,KAAK,CAAC,CAAC;AAC9B,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,KAAc;IACtC,OAAO,eAAe,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC;AACtC,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,KAAc;IAC3C,MAAM,MAAM,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;IAEtC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;QAClB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC;AAChE,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,KAAc;IAC7C,MAAM,KAAK,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC;IAEtC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QACjB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;QAC9B,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;IAClD,CAAC;IAED,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;QAChC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;IAClD,CAAC;IAED,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QACjE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;IAClD,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC;AAC7C,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,KAAc;IACvC,OAAO,gBAAgB,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC;AACvC,CAAC"}
+{"version":3,"file":"identity.js","sourceRoot":"","sources":["../src/identity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAChF,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAGvD;;;;;;;GAOG;AACH,MAAM,UAAU,kBAAkB,CAAC,KAAc;IAC/C,MAAM,KAAK,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC;IAEtC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QACjB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;QAC9B,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;IAClD,CAAC;IAED,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;QAChC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;IAClD,CAAC;IAED,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QACjC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;IAClD,CAAC;IAED,IAAI,CAAC,6BAA6B,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;QAChD,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,kBAAkB,EAAE,CAAC;IACpD,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC;AAC7C,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAAC,KAAc;IACzC,OAAO,kBAAkB,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC;AACzC,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,aAAa,CAAC,KAAc;IAC1C,MAAM,KAAK,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC;IAEtC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QACjB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;QAC9B,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;IAClD,CAAC;IAED,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;QAChC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;IAClD,CAAC;IAED,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QACjC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;IAClD,CAAC;IAED,IAAI,CAAC,6BAA6B,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;QAChD,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,kBAAkB,EAAE,CAAC;IACpD,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC;AAC7C,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,OAAO,CAAC,KAAc;IACpC,OAAO,aAAa,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC;AACpC,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,eAAe,CAAC,KAAc;IAC5C,MAAM,UAAU,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;IAE7C,IAAI,UAAU,CAAC,KAAK,IAAI,UAAU,CAAC,IAAI,KAAK,gBAAgB,EAAE,CAAC;QAC7D,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,OAAO,aAAa,CAAC,KAAK,CAAC,CAAC;AAC9B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,SAAS,CAAC,KAAc;IACtC,OAAO,eAAe,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC;AACtC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,KAAc;IAC3C,MAAM,MAAM,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;IAEtC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;QAClB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC;AAChE,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAc;IAC7C,MAAM,KAAK,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC;IAEtC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QACjB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;QAC9B,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;IAClD,CAAC;IAED,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;QAChC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;IAClD,CAAC;IAED,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QACjE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;IAClD,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC;AAC7C,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,UAAU,CAAC,KAAc;IACvC,OAAO,gBAAgB,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC;AACvC,CAAC"}

package/dist/index.d.ts

@@ -4,4 +4,7 @@ export { isCommercialRegistration, isTin, isUnifiedNationalNumber, isVatNumber,
 export { getSaudiIdType, isBorderId, isIqama, isNationalId, isSaudiId, validateBorderId, validateIqama, validateNationalId, validateSaudiId, } from "./identity.js";
 export { isLandlineNumber, isMobileNumber, isTollFreeNumber, normalizePhoneNumber, validateLandlineNumber, validateMobileNumber, validateTollFreeNumber, } from "./telecom.js";
 export type { NationalAddress, NationalAddressValidationResult, NormalizedSaudiPhone, ValidationErrorCode, ValidationEvidence, ValidationResult, } from "./types.js";
+export { validateNationalIdDetailed, validateIqamaDetailed, validateSaudiIdDetailed, validateBorderIdDetailed, validateSaudiIbanDetailed, validateVatNumberDetailed, validateTinDetailed, validateUnifiedNationalNumberDetailed, validateCommercialRegistrationDetailed, validateMobileNumberDetailed, validateLandlineNumberDetailed, validateTollFreeNumberDetailed, validatePostalCodeDetailed, validateBuildingNumberDetailed, validateAdditionalNumberDetailed, validateShortAddressDetailed, validateNationalAddressDetailed, } from "./detailed.js";
+export type { DetailedValidationResult } from "./types.js";
+export { normalizeAndValidateIban, normalizeAndValidatePhoneNumber, normalizeAndValidateShortAddress, } from "./combined.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAEzF,OAAO,EACL,kBAAkB,EAClB,gBAAgB,EAChB,YAAY,EACZ,cAAc,EACd,qBAAqB,EACrB,wBAAwB,EACxB,sBAAsB,EACtB,uBAAuB,EACvB,kBAAkB,EAClB,oBAAoB,GACrB,MAAM,cAAc,CAAC;AAEtB,OAAO,EACL,wBAAwB,EACxB,KAAK,EACL,uBAAuB,EACvB,WAAW,EACX,8BAA8B,EAC9B,WAAW,EACX,6BAA6B,EAC7B,iBAAiB,GAClB,MAAM,eAAe,CAAC;AAEvB,OAAO,EACL,cAAc,EACd,UAAU,EACV,OAAO,EACP,YAAY,EACZ,SAAS,EACT,gBAAgB,EAChB,aAAa,EACb,kBAAkB,EAClB,eAAe,GAChB,MAAM,eAAe,CAAC;AAEvB,OAAO,EACL,gBAAgB,EAChB,cAAc,EACd,gBAAgB,EAChB,oBAAoB,EACpB,sBAAsB,EACtB,oBAAoB,EACpB,sBAAsB,GACvB,MAAM,cAAc,CAAC;AAEtB,YAAY,EACV,eAAe,EACf,+BAA+B,EAC/B,oBAAoB,EACpB,mBAAmB,EACnB,kBAAkB,EAClB,gBAAgB,GACjB,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAEzF,OAAO,EACL,kBAAkB,EAClB,gBAAgB,EAChB,YAAY,EACZ,cAAc,EACd,qBAAqB,EACrB,wBAAwB,EACxB,sBAAsB,EACtB,uBAAuB,EACvB,kBAAkB,EAClB,oBAAoB,GACrB,MAAM,cAAc,CAAC;AAEtB,OAAO,EACL,wBAAwB,EACxB,KAAK,EACL,uBAAuB,EACvB,WAAW,EACX,8BAA8B,EAC9B,WAAW,EACX,6BAA6B,EAC7B,iBAAiB,GAClB,MAAM,eAAe,CAAC;AAEvB,OAAO,EACL,cAAc,EACd,UAAU,EACV,OAAO,EACP,YAAY,EACZ,SAAS,EACT,gBAAgB,EAChB,aAAa,EACb,kBAAkB,EAClB,eAAe,GAChB,MAAM,eAAe,CAAC;AAEvB,OAAO,EACL,gBAAgB,EAChB,cAAc,EACd,gBAAgB,EAChB,oBAAoB,EACpB,sBAAsB,EACtB,oBAAoB,EACpB,sBAAsB,GACvB,MAAM,cAAc,CAAC;AAEtB,YAAY,EACV,eAAe,EACf,+BAA+B,EAC/B,oBAAoB,EACpB,mBAAmB,EACnB,kBAAkB,EAClB,gBAAgB,GACjB,MAAM,YAAY,CAAC;AAEpB,OAAO,EACL,0BAA0B,EAC1B,qBAAqB,EACrB,uBAAuB,EACvB,wBAAwB,EACxB,yBAAyB,EACzB,yBAAyB,EACzB,mBAAmB,EACnB,qCAAqC,EACrC,sCAAsC,EACtC,4BAA4B,EAC5B,8BAA8B,EAC9B,8BAA8B,EAC9B,0BAA0B,EAC1B,8BAA8B,EAC9B,gCAAgC,EAChC,4BAA4B,EAC5B,+BAA+B,GAChC,MAAM,eAAe,CAAC;AAEvB,YAAY,EAAE,wBAAwB,EAAE,MAAM,YAAY,CAAC;AAE3D,OAAO,EACL,wBAAwB,EACxB,+BAA+B,EAC/B,gCAAgC,GACjC,MAAM,eAAe,CAAC"}

package/dist/index.js

@@ -3,4 +3,6 @@ export { isAdditionalNumber, isBuildingNumber, isPostalCode, isShortAddress, nor
 export { isCommercialRegistration, isTin, isUnifiedNationalNumber, isVatNumber, validateCommercialRegistration, validateTin, validateUnifiedNationalNumber, validateVatNumber, } from "./business.js";
 export { getSaudiIdType, isBorderId, isIqama, isNationalId, isSaudiId, validateBorderId, validateIqama, validateNationalId, validateSaudiId, } from "./identity.js";
 export { isLandlineNumber, isMobileNumber, isTollFreeNumber, normalizePhoneNumber, validateLandlineNumber, validateMobileNumber, validateTollFreeNumber, } from "./telecom.js";
+export { validateNationalIdDetailed, validateIqamaDetailed, validateSaudiIdDetailed, validateBorderIdDetailed, validateSaudiIbanDetailed, validateVatNumberDetailed, validateTinDetailed, validateUnifiedNationalNumberDetailed, validateCommercialRegistrationDetailed, validateMobileNumberDetailed, validateLandlineNumberDetailed, validateTollFreeNumberDetailed, validatePostalCodeDetailed, validateBuildingNumberDetailed, validateAdditionalNumberDetailed, validateShortAddressDetailed, validateNationalAddressDetailed, } from "./detailed.js";
+export { normalizeAndValidateIban, normalizeAndValidatePhoneNumber, normalizeAndValidateShortAddress, } from "./combined.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAEzF,OAAO,EACL,kBAAkB,EAClB,gBAAgB,EAChB,YAAY,EACZ,cAAc,EACd,qBAAqB,EACrB,wBAAwB,EACxB,sBAAsB,EACtB,uBAAuB,EACvB,kBAAkB,EAClB,oBAAoB,GACrB,MAAM,cAAc,CAAC;AAEtB,OAAO,EACL,wBAAwB,EACxB,KAAK,EACL,uBAAuB,EACvB,WAAW,EACX,8BAA8B,EAC9B,WAAW,EACX,6BAA6B,EAC7B,iBAAiB,GAClB,MAAM,eAAe,CAAC;AAEvB,OAAO,EACL,cAAc,EACd,UAAU,EACV,OAAO,EACP,YAAY,EACZ,SAAS,EACT,gBAAgB,EAChB,aAAa,EACb,kBAAkB,EAClB,eAAe,GAChB,MAAM,eAAe,CAAC;AAEvB,OAAO,EACL,gBAAgB,EAChB,cAAc,EACd,gBAAgB,EAChB,oBAAoB,EACpB,sBAAsB,EACtB,oBAAoB,EACpB,sBAAsB,GACvB,MAAM,cAAc,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAEzF,OAAO,EACL,kBAAkB,EAClB,gBAAgB,EAChB,YAAY,EACZ,cAAc,EACd,qBAAqB,EACrB,wBAAwB,EACxB,sBAAsB,EACtB,uBAAuB,EACvB,kBAAkB,EAClB,oBAAoB,GACrB,MAAM,cAAc,CAAC;AAEtB,OAAO,EACL,wBAAwB,EACxB,KAAK,EACL,uBAAuB,EACvB,WAAW,EACX,8BAA8B,EAC9B,WAAW,EACX,6BAA6B,EAC7B,iBAAiB,GAClB,MAAM,eAAe,CAAC;AAEvB,OAAO,EACL,cAAc,EACd,UAAU,EACV,OAAO,EACP,YAAY,EACZ,SAAS,EACT,gBAAgB,EAChB,aAAa,EACb,kBAAkB,EAClB,eAAe,GAChB,MAAM,eAAe,CAAC;AAEvB,OAAO,EACL,gBAAgB,EAChB,cAAc,EACd,gBAAgB,EAChB,oBAAoB,EACpB,sBAAsB,EACtB,oBAAoB,EACpB,sBAAsB,GACvB,MAAM,cAAc,CAAC;AAWtB,OAAO,EACL,0BAA0B,EAC1B,qBAAqB,EACrB,uBAAuB,EACvB,wBAAwB,EACxB,yBAAyB,EACzB,yBAAyB,EACzB,mBAAmB,EACnB,qCAAqC,EACrC,sCAAsC,EACtC,4BAA4B,EAC5B,8BAA8B,EAC9B,8BAA8B,EAC9B,0BAA0B,EAC1B,8BAA8B,EAC9B,gCAAgC,EAChC,4BAA4B,EAC5B,+BAA+B,GAChC,MAAM,eAAe,CAAC;AAIvB,OAAO,EACL,wBAAwB,EACxB,+BAA+B,EAC/B,gCAAgC,GACjC,MAAM,eAAe,CAAC"}