even-pf 0.2.3 → 0.2.4

package/README.md

@@ -22,3 +22,12 @@ bun link
 Make sure you have a config file in your home or current directory. Alternatively, you can set environment variable `EPF_CONFIG_URL`.
 
 This project was created using `bun init` in bun v1.3.2. [Bun](https://bun.com) is a fast all-in-one JavaScript runtime.
+
+## Specs
+### File-viewer Frontend
+In consideration of the tool might be running at a remote server, for easily viewing the Markdown files, we will use a simple file-viewer frontend.
+Data being sent to the frontend will be as encoded as an URL, using the following format:
+```
+https://yourfrontend.com/#name=...&comp=gzip&data=...
+```
+The `data` field is base64-encoded using compression algorithm specified in `comp` field. The frontend will decode the data and display it as a Markdown file.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "even-pf",
-  "version": "0.2.3",
+  "version": "0.2.4",
   "module": "src/index.ts",
   "type": "module",
   "license": "UNLICENSED",

package/src/index.ts

@@ -6,6 +6,7 @@ import {CONFIG} from "./util/config.ts";
 import {executeTestingWorkflow} from "./workflow/testing-workflow.ts";
 import {executeAnalysisWorkflow} from "./workflow/analysis-workflow.ts";
 import type {WorkflowDependencies} from "./workflow";
+import {OutputViewer} from "./util/output-viewer.ts";
 
 
 console.log("EPF index.ts");
@@ -14,7 +15,8 @@ const workflowDependencies: WorkflowDependencies = {
     seed: Math.floor(Date.now() / 1000),
     openRouter: new OpenRouter({
         apiKey: CONFIG.vendors.openrouter.api_key,
-    })
+    }),
+    outputViewer: new OutputViewer(),
 }
 
 // Parallelize workflows with Promise.allSettled
@@ -52,4 +54,6 @@ if (failedIndices.length > 0) {
     });
 }
 
+workflowDependencies.outputViewer.display();
+
 console.log("index.ts done");

package/src/util/output-viewer.ts

@@ -1,3 +1,5 @@
+import chalk from "chalk";
+
 type FileRecord = {
     type: "markdown" | "text";
     content: string;
@@ -11,7 +13,7 @@ export class OutputViewer {
         this.filesRecords[filename] = _;
     }
     
-    display(): void {
+    private serve(): void {
         let files = Object.entries(this.filesRecords).sort((a, b) => a[0].localeCompare(b[0]));
         
         let server = Bun.serve({
@@ -29,4 +31,24 @@ export class OutputViewer {
         });
         console.log(server.url);
     }
+    
+    display() {
+        if (Object.keys(this.filesRecords).length === 0) {
+            console.warn("No files to display");
+            return;
+        }
+        
+        console.log("Click the following links to view the outputs in your browser:");
+        
+        const FRONTEND_URL = "https://ta-tools-dashboard.vercel.app/tools/md-viewer"; //TODO: not hardcode this
+        let files = Object.entries(this.filesRecords).sort((a, b) => a[0].localeCompare(b[0]));
+        for (const [filename, fileRecord] of files) {
+            let params = new URLSearchParams();
+            params.set("name", filename);
+            params.set("comp", "gzip");
+            params.set("data", Bun.gzipSync(fileRecord.content).toBase64());
+            let url = `${FRONTEND_URL}#${params.toString()}`;
+            console.log(`${chalk.cyan(filename)}: ${url}`);
+        }
+    }
 }

package/src/workflow/analysis-workflow.ts

@@ -56,4 +56,5 @@ export async function executeAnalysisWorkflow(workflow: typeof CONFIG.analysis_w
         .replaceAll("[run]", runNum.toString());
     await Bun.write(outputFileName, completion.text);
     log(`Completion written to ${outputFileName}`);
+    deps.outputViewer.addFile(outputFileName, {type: "markdown", content: completion.text});
 }

package/src/workflow/index.ts

@@ -1,6 +1,9 @@
 import type {OpenRouter} from "@openrouter/sdk";
 
+import type {OutputViewer} from "../util/output-viewer.ts";
+
 export type WorkflowDependencies = {
     seed: number,
     openRouter: OpenRouter,
+    outputViewer: OutputViewer,
 }