feat: allow parsing readonly arrays

Author: targos

src/parse/checkLines.ts

@@ -1,4 +1,6 @@
-export function checkLines(lines: string | string[]) {
+export function checkLines(
+  lines: string | readonly string[],
+): readonly string[] {
   if (typeof lines === 'string') {
     lines = lines.split(/[\r\n]+/);
   }

src/parse/createFieldParser.ts

@@ -30,8 +30,11 @@ export interface FieldOptions {
 }
 
 export interface CreateFieldParserResult {
-  parser: (lines: string[], autocorrect: Autocorrect[]) => Details;
-  autocorrector: (lines: string[]) => {
+  parser: (
+    lines: readonly string[],
+    autocorrect: readonly Autocorrect[],
+  ) => Details;
+  autocorrector: (lines: readonly string[]) => {
     autocorrect: Autocorrect[];
     correctedText: string;
     range: Range;
@@ -66,8 +69,8 @@ export default function createFieldParser(
     }
   }
   const parser: CreateFieldParserResult['parser'] = (
-    lines: string[],
-    autocorrect: Autocorrect[],
+    lines: readonly string[],
+    autocorrect: readonly Autocorrect[],
   ) => {
     const source = getText(lines, fieldOptions);
     const related = fieldOptions.related || [];
@@ -122,7 +125,7 @@ export default function createFieldParser(
   };
 
   const autocorrector: CreateFieldParserResult['autocorrector'] = (
-    lines: string[],
+    lines: readonly string[],
   ) => {
     const originalText = getText(lines, fieldOptions);
     return {
@@ -134,7 +137,7 @@ export default function createFieldParser(
   return { parser, autocorrector };
 }
 
-function getText(lines: string | string[], options: Range) {
+function getText(lines: readonly string[], options: Range) {
   const line = lines[options.line];
   return line.slice(options.start, options.end);
 }

src/parse/frenchDrivingLicence.ts

@@ -6,7 +6,7 @@ import type { ParseMRZOptions } from './parse.ts';
 
 const FRENCH_DRIVING_LICENSE = formats.FRENCH_DRIVING_LICENSE;
 export default function parseFrenchDrivingLicense(
-  lines: string[],
+  lines: readonly string[],
   options: ParseMRZOptions,
 ) {
   if (lines.length !== 1) {

src/parse/frenchNationalId.ts

@@ -6,7 +6,7 @@ import type { ParseMRZOptions } from './parse.ts';
 
 const FRENCH_NATIONAL_ID = formats.FRENCH_NATIONAL_ID;
 export default function parseFrenchNationalId(
-  lines: string[],
+  lines: readonly string[],
   options: ParseMRZOptions,
 ) {
   if (lines.length !== 2) {

src/parse/getResult.ts

@@ -37,8 +37,8 @@ function getFields(details: Details[]) {
 }
 
 function getCorrection(
-  lines: string[],
-  fieldParsers: CreateFieldParserResult[],
+  lines: readonly string[],
+  fieldParsers: readonly CreateFieldParserResult[],
   autocorrect: boolean,
 ) {
   const corrected = lines.slice();
@@ -60,7 +60,7 @@ function getCorrection(
 
 export function getResult(
   format: FormatType,
-  lines: string[],
+  lines: readonly string[],
   fieldParsers: CreateFieldParserResult[],
   options: ParseMRZOptions,
 ): ParseResult {

src/parse/parse.ts

@@ -8,7 +8,7 @@ export interface ParseMRZOptions {
 }
 
 function parseMRZ(
-  inputLines: string | string[],
+  inputLines: string | readonly string[],
   options: ParseMRZOptions = {},
 ): ParseResult {
   const lines = checkLines(inputLines);

src/parse/swissDrivingLicense.ts

@@ -6,7 +6,7 @@ import swissDrivingLicenseFields from './swissDrivingLicenseFields.ts';
 
 const SWISS_DRIVING_LICENSE = formats.SWISS_DRIVING_LICENSE;
 export default function parseSwissDrivingLicense(
-  lines: string[],
+  lines: readonly string[],
   options: ParseMRZOptions,
 ) {
   if (lines.length !== 3) {

src/parse/td1.ts

@@ -5,7 +5,10 @@ import type { ParseMRZOptions } from './parse.ts';
 import TD1Fields from './td1Fields.ts';
 
 const TD1 = formats.TD1;
-export default function parseTD1(lines: string[], options: ParseMRZOptions) {
+export default function parseTD1(
+  lines: readonly string[],
+  options: ParseMRZOptions,
+) {
   if (lines.length !== 3) {
     throw new Error(
       `invalid number of lines: ${lines.length}: Must be 3 for ${TD1}`,

src/parse/td2.ts

@@ -5,7 +5,10 @@ import type { ParseMRZOptions } from './parse.ts';
 import TD2Fields from './td2Fields.ts';
 
 const TD2 = formats.TD2;
-export default function parseTD2(lines: string[], options: ParseMRZOptions) {
+export default function parseTD2(
+  lines: readonly string[],
+  options: ParseMRZOptions,
+) {
   if (lines.length !== 2) {
     throw new Error(
       `invalid number of lines: ${lines.length}: Must be 2 for ${TD2}`,

src/parse/td3.ts

@@ -5,7 +5,10 @@ import type { ParseMRZOptions } from './parse.ts';
 import TD3Fields from './td3Fields.ts';
 
 const TD3 = formats.TD3;
-export default function parseTD3(lines: string[], options: ParseMRZOptions) {
+export default function parseTD3(
+  lines: readonly string[],
+  options: ParseMRZOptions,
+) {
   if (lines.length !== 2) {
     throw new Error(
       `invalid number of lines: ${lines.length}: Must be 2 for ${TD3}`,