Merge pull request #26 from sonicbaume/async-file-adapter

Change file adapter functions to async

Author: willwade

src/cli/index.ts

@@ -11,14 +11,18 @@ import {
 import { ComparisonAnalyzer, MetricsCalculator } from '../utilities/analytics';
 import { CellScanningOrder, ScanningSelectionMethod } from '../types/aac';
 import { defaultFileAdapter, extname } from '../utils/io';
+import { readFileSync } from 'node:fs';
 
-const { pathExists, isDirectory, join, readTextFromInput, basename, writeTextToPath } =
-  defaultFileAdapter;
+const { pathExists, isDirectory, join, basename, writeTextToPath } = defaultFileAdapter;
 
 // Helper function to detect format from file/folder path
-function detectFormat(filePath: string): string {
+async function detectFormat(filePath: string): Promise<string> {
   // Check if it's a folder ending with .ascconfig
-  if (pathExists(filePath) && isDirectory(filePath) && filePath.endsWith('.ascconfig')) {
+  if (
+    (await pathExists(filePath)) &&
+    (await isDirectory(filePath)) &&
+    filePath.endsWith('.ascconfig')
+  ) {
     return 'ascconfig';
   }
 
@@ -84,7 +88,7 @@ function parseFilteringOptions(options: {
 }
 
 // Set version from package.json
-const packageJson = JSON.parse(readTextFromInput(join(__dirname, '../../package.json'))) as {
+const packageJson = JSON.parse(readFileSync(join(__dirname, '../../package.json'), 'utf8')) as {
   version: string;
 };
 program.version(packageJson.version);
@@ -116,7 +120,7 @@ program
         const filteringOptions = parseFilteringOptions(options);
 
         // Auto-detect format if not specified
-        const format = options.format || detectFormat(file);
+        const format = options.format || (await detectFormat(file));
         const processor = getProcessor(format, filteringOptions);
         const tree = await processor.loadIntoTree(file);
 
@@ -170,7 +174,7 @@ program
         const filteringOptions = parseFilteringOptions(options);
 
         // Auto-detect format if not specified
-        const format = options.format || detectFormat(file);
+        const format = options.format || (await detectFormat(file));
         const processor = getProcessor(format, filteringOptions);
         const texts = await processor.extractTexts(file);
 
@@ -237,7 +241,7 @@ program
         const filteringOptions = parseFilteringOptions(options);
 
         // Auto-detect input format
-        const inputFormat = detectFormat(input);
+        const inputFormat = await detectFormat(input);
         const inputProcessor = getProcessor(inputFormat, filteringOptions);
 
         // Load the tree (handle both files and folders)
@@ -293,7 +297,7 @@ program
     ) => {
       try {
         // Auto-detect format if not specified
-        const format = options.format || detectFormat(file);
+        const format = options.format || (await detectFormat(file));
 
         // Get processor with gridset password if provided
         const processorOptions: ProcessorOptions = {};
@@ -388,7 +392,7 @@ program
   .option('--encryption <mode>', 'Encryption label for baton export', 'none')
   .option('--version <version>', 'Baton export version', '1.0')
   .action(
-    (
+    async (
       input: string,
       options: {
         format?: string;
@@ -401,7 +405,7 @@ program
       }
     ) => {
       try {
-        if (!pathExists(input)) {
+        if (!(await pathExists(input))) {
           throw new Error(`File not found: ${input}`);
         }
 
@@ -412,9 +416,9 @@ program
 
         let entries;
         if (normalizedSource === 'grid3' || (normalizedSource === 'auto' && isGrid3Db)) {
-          entries = readGrid3History(input);
+          entries = await readGrid3History(input);
         } else if (normalizedSource === 'snap' || (normalizedSource === 'auto' && isSnap)) {
-          entries = readSnapUsage(input);
+          entries = await readSnapUsage(input);
         } else {
           throw new Error('Unable to detect history source. Use --source grid3 or --source snap.');
         }
@@ -435,7 +439,7 @@ program
 
         const output = JSON.stringify(payload, null, 2);
         if (options.out) {
-          writeTextToPath(options.out, output);
+          await writeTextToPath(options.out, output);
         } else {
           console.log(output);
         }
@@ -493,7 +497,7 @@ program
     ) => {
       try {
         const filteringOptions = parseFilteringOptions(options);
-        const format = options.format || detectFormat(file);
+        const format = options.format || (await detectFormat(file));
         const processor = getProcessor(format, filteringOptions);
         const tree = await processor.loadIntoTree(file);
 
@@ -575,7 +579,7 @@ program
 
         const output = options.pretty ? JSON.stringify(result, null, 2) : JSON.stringify(result);
         if (options.out) {
-          writeTextToPath(options.out, output);
+          await writeTextToPath(options.out, output);
         } else {
           console.log(output);
         }

src/core/baseProcessor.ts

@@ -77,7 +77,7 @@ export interface ProcessorConfig {
   fileAdapter: FileAdapter;
 
   // Adapter for handling encoding/decoding zip files
-  zipAdapter: (input?: ProcessorInput) => Promise<ZipAdapter>;
+  zipAdapter: (input?: ProcessorInput, fileAdapter?: FileAdapter) => Promise<ZipAdapter>;
 }
 export type ProcessorOptions = Partial<ProcessorConfig>;
 

src/processors/applePanelsProcessor.ts

@@ -220,7 +220,7 @@ class ApplePanelsProcessor extends BaseProcessor {
   async loadIntoTree(filePathOrBuffer: ProcessorInput): Promise<AACTree> {
     const { readBinaryFromInput, readTextFromInput, pathExists, getFileSize, join } =
       this.options.fileAdapter;
-    await Promise.resolve();
+
     const filename =
       typeof filePathOrBuffer === 'string' ? getBasename(filePathOrBuffer) : 'upload.plist';
     let buffer: Uint8Array;
@@ -234,8 +234,8 @@ class ApplePanelsProcessor extends BaseProcessor {
             'Resources',
             'PanelDefinitions.plist'
           );
-          if (pathExists(panelDefsPath)) {
-            buffer = readBinaryFromInput(panelDefsPath);
+          if (await pathExists(panelDefsPath)) {
+            buffer = await readBinaryFromInput(panelDefsPath);
           } else {
             const validation = buildValidationResultFromMessage({
               filename,
@@ -248,13 +248,13 @@ class ApplePanelsProcessor extends BaseProcessor {
             throw new ValidationFailureError('Apple Panels file not found', validation);
           }
         } else {
-          buffer = readBinaryFromInput(filePathOrBuffer);
+          buffer = await readBinaryFromInput(filePathOrBuffer);
         }
       } else {
-        buffer = readBinaryFromInput(filePathOrBuffer);
+        buffer = await readBinaryFromInput(filePathOrBuffer);
       }
 
-      const content = readTextFromInput(buffer);
+      const content = await readTextFromInput(buffer);
       const parsedData = plist.parse(content) as ApplePanelsParsedDocument;
 
       let panelsData: ApplePanelsPanel[] = [];
@@ -393,10 +393,12 @@ class ApplePanelsProcessor extends BaseProcessor {
         filename,
         filesize:
           typeof filePathOrBuffer === 'string'
-            ? (() => {
-                return pathExists(filePathOrBuffer) ? getFileSize(filePathOrBuffer) : 0;
+            ? await (async () => {
+                return (await pathExists(filePathOrBuffer))
+                  ? await getFileSize(filePathOrBuffer)
+                  : 0;
               })()
-            : readBinaryFromInput(filePathOrBuffer).byteLength,
+            : (await readBinaryFromInput(filePathOrBuffer)).byteLength,
         format: 'applepanels',
         message: err?.message || 'Failed to parse Apple Panels file',
         type: 'parse',
@@ -466,16 +468,16 @@ class ApplePanelsProcessor extends BaseProcessor {
     await this.saveFromTree(tree, outputPath);
 
     if (outputPath.endsWith('.plist')) {
-      return readBinaryFromInput(outputPath);
+      return await readBinaryFromInput(outputPath);
     }
     const configPath = outputPath.endsWith('.ascconfig') ? outputPath : `${outputPath}.ascconfig`;
     const panelDefsPath = join(configPath, 'Contents', 'Resources', 'PanelDefinitions.plist');
-    return readBinaryFromInput(panelDefsPath);
+    return await readBinaryFromInput(panelDefsPath);
   }
 
   async saveFromTree(tree: AACTree, outputPath: string): Promise<void> {
     const { writeTextToPath, pathExists, mkDir, join, dirname } = this.options.fileAdapter;
-    await Promise.resolve();
+
     // Support two output modes:
     // 1) Single-file .plist (PanelDefinitions.plist content written directly)
     // 2) Apple Panels bundle folder (*.ascconfig) with Contents/Resources structure
@@ -490,9 +492,9 @@ class ApplePanelsProcessor extends BaseProcessor {
       contentsPath = join(configPath, 'Contents');
       resourcesPath = join(contentsPath, 'Resources');
 
-      if (!pathExists(configPath)) mkDir(configPath, { recursive: true });
-      if (!pathExists(contentsPath)) mkDir(contentsPath, { recursive: true });
-      if (!pathExists(resourcesPath)) mkDir(resourcesPath, { recursive: true });
+      if (!(await pathExists(configPath))) await mkDir(configPath, { recursive: true });
+      if (!(await pathExists(contentsPath))) await mkDir(contentsPath, { recursive: true });
+      if (!(await pathExists(resourcesPath))) await mkDir(resourcesPath, { recursive: true });
 
       // Create Info.plist (bundle mode only)
       const infoPlist = {
@@ -510,11 +512,11 @@ class ApplePanelsProcessor extends BaseProcessor {
           `Generated by AAC Processors${tree.metadata?.author ? ` - Author: ${tree.metadata.author}` : ''}`,
       };
       const infoPlistContent = plist.build(infoPlist);
-      writeTextToPath(join(contentsPath, 'Info.plist'), infoPlistContent);
+      await writeTextToPath(join(contentsPath, 'Info.plist'), infoPlistContent);
 
       // Create AssetIndex.plist (empty)
       const assetIndexContent = plist.build({});
-      writeTextToPath(join(resourcesPath, 'AssetIndex.plist'), assetIndexContent);
+      await writeTextToPath(join(resourcesPath, 'AssetIndex.plist'), assetIndexContent);
     }
 
     // Build PanelDefinitions content from tree
@@ -656,11 +658,11 @@ class ApplePanelsProcessor extends BaseProcessor {
     if (isSinglePlist) {
       // Write single PanelDefinitions.plist file directly
       const dir = dirname(outputPath);
-      if (!pathExists(dir)) mkDir(dir, { recursive: true });
-      writeTextToPath(outputPath, panelDefsContent);
+      if (!(await pathExists(dir))) await mkDir(dir, { recursive: true });
+      await writeTextToPath(outputPath, panelDefsContent);
     } else {
       // Write into bundle structure
-      writeTextToPath(join(resourcesPath, 'PanelDefinitions.plist'), panelDefsContent);
+      await writeTextToPath(join(resourcesPath, 'PanelDefinitions.plist'), panelDefsContent);
     }
   }