National ID

import { verifyIranianNationalId } from "@persian-tools/persian-tools";

verifyIranianNationalId("0499370899"); // true
verifyIranianNationalId("1234567890"); // false (checksum fails)
verifyIranianNationalId(undefined); // undefined (falsy input)

// Opt in to the extra city-prefix check
verifyIranianNationalId("0499370899", { checkPrefix: true });

interface VerifyIranianNationalIdOptions {
	checkPrefix: boolean; // required once you pass an options object
}

import {
	createIranianNationalId,
	createIranianNationalIdDetailed,
	createIranianRoundNationalId,
	validateNationalIdChecksum,
	isValidNationalIdFormat,
} from "@persian-tools/persian-tools";

createIranianNationalId(); // random valid ID
createIranianNationalId({ preventRepeatedDigits: true }); // forbids all-same-digit results
createIranianNationalId({ randomGenerator: () => 0.5 }); // deterministic seed for tests

const detailed = createIranianNationalIdDetailed({ preventRepeatedDigits: true, maxRetries: 50 });
// {
//   nationalId: "1234567890",
//   checkDigit: 0,
//   attempts: 1,
//   hasRepeatedDigits: false,
//   digits: [1, 2, 3, 4, 5, 6, 7, 8, 9, 0],
// }

validateNationalIdChecksum(detailed.nationalId); // true
isValidNationalIdFormat("0499370899"); // true (just shape)

interface NationalIdGenerationOptions {
	preventRepeatedDigits?: boolean;
	maxRetries?: number;
	randomGenerator?: () => number;
}
interface NationalIdGenerationResult {
	nationalId: string;
	checkDigit: number;
	attempts: number;
	hasRepeatedDigits: boolean;
	digits: number[];
}