Added zipAdapter option to allow custom unzipping

Author: chrisbaume

src/core/baseProcessor.ts

@@ -73,6 +73,7 @@ export interface ProcessorOptions {
   // Defaults to 'en-GB' if not specified
   grid3Locale?: string;
 
+  // Optionally provide your own adapter for unzipping the input
   zipAdapter?: (input: ProcessorInput) => Promise<{ zip: ZipAdapter }>
 }
 

src/processors/gridset/helpers.ts

@@ -12,7 +12,8 @@ import { execSync } from 'child_process';
 import Database from 'better-sqlite3';
 import { dotNetTicksToDate } from '../../utils/dotnetTicks';
 import { getZipEntriesFromAdapter, resolveGridsetPasswordFromEnv } from './password';
-import { openZipFromInput } from '../../utils/zip';
+import { openZipFromInput, type ZipAdapter } from '../../utils/zip';
+import type { ProcessorInput } from '../../utils/io';
 
 function normalizeZipPath(p: string): string {
   const unified = p.replace(/\\/g, '/');
@@ -62,10 +63,13 @@ export function getAllowedImageEntries(tree: AACTree): Set<string> {
 export async function openImage(
   gridsetBuffer: Uint8Array,
   entryPath: string,
-  password = resolveGridsetPasswordFromEnv()
+  password = resolveGridsetPasswordFromEnv(),
+  zipAdapter?: (input: ProcessorInput) => Promise<{ zip: ZipAdapter }>
 ): Promise<Uint8Array | null> {
   try {
-    const { zip } = await openZipFromInput(gridsetBuffer);
+    const { zip } = zipAdapter
+      ? await zipAdapter(gridsetBuffer)
+      : await openZipFromInput(gridsetBuffer);
     const entries = getZipEntriesFromAdapter(zip, password);
     const want = normalizeZipPath(entryPath);
     const entry = entries.find((e) => normalizeZipPath(e.entryName) === want);

src/processors/gridset/imageDebug.ts

@@ -5,11 +5,11 @@
  * correctly in Grid3 gridsets.
  */
 
-import { openZipFromInput } from '../../utils/zip';
+import { openZipFromInput, type ZipAdapter } from '../../utils/zip';
 import { getZipEntriesFromAdapter } from './password';
 import { resolveGridsetPasswordFromEnv } from './password';
 import { XMLParser } from 'fast-xml-parser';
-import { decodeText } from '../../utils/io';
+import { decodeText, type ProcessorInput } from '../../utils/io';
 
 export interface ImageIssue {
   gridName: string;
@@ -45,7 +45,8 @@ export interface ImageAuditResult {
  */
 export async function auditGridsetImages(
   gridsetBuffer: Uint8Array,
-  password = resolveGridsetPasswordFromEnv()
+  password = resolveGridsetPasswordFromEnv(),
+  zipAdapter?: (input: ProcessorInput) => Promise<{ zip: ZipAdapter }>
 ): Promise<ImageAuditResult> {
   const issues: ImageIssue[] = [];
   const availableImages = new Set<string>();
@@ -55,7 +56,10 @@ export async function auditGridsetImages(
   let unresolvedImages = 0;
 
   try {
-    const { zip } = await openZipFromInput(gridsetBuffer);
+    const { zip } = zipAdapter
+      ? await zipAdapter(gridsetBuffer)
+      : await openZipFromInput(gridsetBuffer);
+    
     const entries = getZipEntriesFromAdapter(zip, password);
     const parser = new XMLParser();
 

src/processors/gridset/wordlistHelpers.ts

@@ -11,8 +11,8 @@
 
 import { XMLParser, XMLBuilder } from 'fast-xml-parser';
 import { getZipEntriesFromAdapter, resolveGridsetPasswordFromEnv } from './password';
-import { openZipFromInput } from '../../utils/zip';
-import { getNodeRequire, isNodeRuntime } from '../../utils/io';
+import { openZipFromInput, type ZipAdapter } from '../../utils/zip';
+import { getNodeRequire, isNodeRuntime, type ProcessorInput } from '../../utils/io';
 import { decodeText } from '../../utils/io';
 
 /**
@@ -130,13 +130,16 @@ export function wordlistToXml(wordlist: WordList): string {
  */
 export async function extractWordlists(
   gridsetBuffer: Uint8Array,
-  password = resolveGridsetPasswordFromEnv()
+  password = resolveGridsetPasswordFromEnv(),
+  zipAdapter?: (input: ProcessorInput) => Promise<{ zip: ZipAdapter }>
 ): Promise<Map<string, WordList>> {
   const wordlists = new Map<string, WordList>();
   const parser = new XMLParser();
 
   try {
-    const { zip } = await openZipFromInput(gridsetBuffer);
+    const { zip } = zipAdapter
+      ? await zipAdapter(gridsetBuffer)
+      : await openZipFromInput(gridsetBuffer);
     const entries = getZipEntriesFromAdapter(zip, password);
 
     // Process each grid file

src/processors/gridsetProcessor.ts

@@ -450,7 +450,10 @@ class GridsetProcessor extends BaseProcessor {
 
     let zipResult: Awaited<ReturnType<typeof openZipFromInput>>;
     try {
-      zipResult = await openZipFromInput(readBinaryFromInput(filePathOrBuffer));
+      const zipInput = readBinaryFromInput(filePathOrBuffer)
+      zipResult = this.options.zipAdapter
+        ? await this.options.zipAdapter(zipInput)
+        : await openZipFromInput(zipInput);
     } catch (error: any) {
       throw new Error(`Invalid ZIP file format: ${error.message}`);
     }

src/processors/touchchatProcessor.ts

@@ -153,7 +153,9 @@ class TouchChatProcessor extends BaseProcessor {
 
       // Step 1: Unzip
       const zipInput = readBinaryFromInput(filePathOrBuffer);
-      const { zip } = await openZipFromInput(zipInput);
+      const { zip } = this.options.zipAdapter
+        ? await this.options.zipAdapter(zipInput)
+        : await openZipFromInput(zipInput);
       const vocabEntry = zip.listFiles().find((name) => name.endsWith('.c4v'));
       if (!vocabEntry) {
         throw new Error('No .c4v vocab DB found in TouchChat export');

src/validation/touchChatValidator.ts

@@ -4,8 +4,8 @@
 import * as xml2js from 'xml2js';
 import { BaseValidator } from './baseValidator';
 import { ValidationResult } from './validationTypes';
-import { decodeText, getBasename, getFs, readBinaryFromInput, toUint8Array } from '../utils/io';
-import { openZipFromInput } from '../utils/zip';
+import { decodeText, getBasename, getFs, type ProcessorInput, readBinaryFromInput, toUint8Array } from '../utils/io';
+import { openZipFromInput, type ZipAdapter } from '../utils/zip';
 import { openSqliteDatabase } from '../utils/sqlite';
 
 /**
@@ -31,15 +31,21 @@ export class TouchChatValidator extends BaseValidator {
   /**
    * Check if content is TouchChat format
    */
-  static async identifyFormat(content: any, filename: string): Promise<boolean> {
+  static async identifyFormat(
+    content: any,
+    filename: string,
+    zipAdapter?: (input: ProcessorInput) => Promise<{ zip: ZipAdapter }>
+  ): Promise<boolean> {
     const name = filename.toLowerCase();
     if (name.endsWith('.ce')) {
       return true;
     }
 
     // Try to parse as ZIP and check for .c4v database
     try {
-      const { zip } = await openZipFromInput(content);
+      const { zip } = zipAdapter
+        ? await zipAdapter(content)
+        : await openZipFromInput(content);
       const entries = zip.listFiles();
       if (entries.some((entry) => entry.toLowerCase().endsWith('.c4v'))) {
         return true;