@aigne/afs-explorer 1.1.0 → 1.11.0-beta

package/README.md

@@ -53,7 +53,10 @@ import path from "node:path";
 
 // For production: specify the path to the built frontend
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
-const distPath = path.resolve(__dirname, "node_modules/@aigne/afs-explorer/dist");
+const distPath = path.resolve(
+  __dirname,
+  "node_modules/@aigne/afs-explorer/dist",
+);
 
 const server = new ExplorerServer(afs, {
   port: 8080,
@@ -116,6 +119,7 @@ The explorer provides the following REST API endpoints:
 ### Backend
 
 The backend is built with Express and provides:
+
 - RESTful API for AFS operations
 - Static file serving for the React frontend
 - CORS support for development
@@ -123,6 +127,7 @@ The backend is built with Express and provides:
 ### Frontend
 
 The frontend is a React application built with:
+
 - **React 19** - Modern React with hooks
 - **TypeScript** - Type-safe development
 - **Material-UI (MUI)** - Professional UI components

package/dist/index.cjs

@@ -0,0 +1,126 @@
+//#region rolldown:runtime
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") {
+		for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+			key = keys[i];
+			if (!__hasOwnProp.call(to, key) && key !== except) {
+				__defProp(to, key, {
+					get: ((k) => from[k]).bind(null, key),
+					enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+				});
+			}
+		}
+	}
+	return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+	value: mod,
+	enumerable: true
+}) : target, mod));
+
+//#endregion
+let node_path = require("node:path");
+node_path = __toESM(node_path);
+let cors = require("cors");
+cors = __toESM(cors);
+let express = require("express");
+express = __toESM(express);
+
+//#region src/server.ts
+var ExplorerServer = class {
+	app;
+	server;
+	constructor(afs, options = {}) {
+		this.afs = afs;
+		this.options = options;
+		this.app = (0, express.default)();
+		this.setupMiddleware();
+		this.setupRoutes();
+	}
+	setupMiddleware() {
+		this.app.use((0, cors.default)());
+		this.app.use(express.default.json());
+	}
+	setupRoutes() {
+		this.app.get("/api/list", async (req, res) => {
+			const path = req.query.path || "/";
+			const maxDepth = req.query.maxDepth ? Number.parseInt(req.query.maxDepth, 10) : 1;
+			const result = await this.afs.list(path, { maxDepth });
+			res.json(result);
+		});
+		this.app.get("/api/read", async (req, res) => {
+			const path = req.query.path;
+			if (!path) {
+				res.status(400).json({ error: "Path is required" });
+				return;
+			}
+			const result = await this.afs.read(path);
+			res.json(result);
+		});
+		this.app.get("/api/search", async (req, res) => {
+			const path = req.query.path || "/";
+			const query = req.query.query;
+			if (!query) {
+				res.status(400).json({ error: "Query is required" });
+				return;
+			}
+			const result = await this.afs.search(path, query);
+			res.json(result);
+		});
+		if (this.options.distPath) {
+			const distPath = node_path.default.resolve(this.options.distPath);
+			this.app.use(express.default.static(distPath));
+			this.app.get("/{*splat}", (_req, res) => {
+				res.sendFile("index.html", { root: distPath });
+			});
+		}
+		this.app.use((err, _req, res, _next) => {
+			res.status(500).json({ error: err.message || String(err) });
+		});
+	}
+	async start() {
+		const port = this.options.port || 3e3;
+		const host = this.options.host || "localhost";
+		return new Promise((resolve) => {
+			this.server = this.app.listen(port, host, () => {
+				resolve();
+			});
+		});
+	}
+	async stop() {
+		return new Promise((resolve, reject) => {
+			if (this.server) this.server.close((err) => {
+				if (err && err.code !== "ERR_SERVER_NOT_RUNNING") reject(err);
+				else {
+					this.server = void 0;
+					resolve();
+				}
+			});
+			else resolve();
+		});
+	}
+};
+
+//#endregion
+//#region src/index.ts
+/**
+* Start the AFS Explorer web server
+* @param afs - The AFS instance to explore
+* @param options - Server options
+* @returns The ExplorerServer instance
+*/
+async function startExplorer(afs, options = {}) {
+	const server = new ExplorerServer(afs, options);
+	await server.start();
+	return server;
+}
+
+//#endregion
+exports.ExplorerServer = ExplorerServer;
+exports.startExplorer = startExplorer;

package/dist/index.d.cts

@@ -0,0 +1,35 @@
+import { AFS } from "@aigne/afs";
+
+//#region src/server.d.ts
+interface ExplorerServerOptions {
+  port?: number;
+  host?: string;
+  /**
+       * Path to the dist directory containing the built frontend.
+       * If not provided, static file serving will be disabled.
+       */
+  distPath?: string;
+}
+declare class ExplorerServer {
+  private afs;
+  private options;
+  private app;
+  private server?;
+  constructor(afs: AFS, options?: ExplorerServerOptions);
+  private setupMiddleware;
+  private setupRoutes;
+  start(): Promise<void>;
+  stop(): Promise<void>;
+}
+//#endregion
+//#region src/index.d.ts
+/**
+ * Start the AFS Explorer web server
+ * @param afs - The AFS instance to explore
+ * @param options - Server options
+ * @returns The ExplorerServer instance
+ */
+declare function startExplorer(afs: AFS, options?: ExplorerServerOptions): Promise<ExplorerServer>;
+//#endregion
+export { ExplorerServer, type ExplorerServerOptions, startExplorer };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/server.ts","../src/index.ts"],"mappings":";;;UAKiB,qBAAA;EAAA,IAAA;EAAA,IAAA;EAAA;AAUjB;;;EAViB,QAAA;AAAA;AAAA,cAUJ,cAAA;EAAA,QAAA,GAAA;EAAA,QAAA,OAAA;EAAA,QAAA,GAAA;EAAA,QAAA,MAAA;EAAA,YAAA,GAAA,EAKI,GAAA,EAAA,OAAA,GACI,qBAAA;EAAA,QAAA,eAAA;EAAA,QAAA,WAAA;EAAA,MAAA,GA2DJ,OAAA;EAAA,KAAA,GAWD,OAAA;AAAA;;;;AChFhB;;;;;iBAAsB,aAAA,CAAA,GAAA,EACf,GAAA,EAAA,OAAA,GACI,qBAAA,GACR,OAAA,CAAQ,cAAA"}

package/dist/index.d.mts

@@ -0,0 +1,35 @@
+import { AFS } from "@aigne/afs";
+
+//#region src/server.d.ts
+interface ExplorerServerOptions {
+  port?: number;
+  host?: string;
+  /**
+       * Path to the dist directory containing the built frontend.
+       * If not provided, static file serving will be disabled.
+       */
+  distPath?: string;
+}
+declare class ExplorerServer {
+  private afs;
+  private options;
+  private app;
+  private server?;
+  constructor(afs: AFS, options?: ExplorerServerOptions);
+  private setupMiddleware;
+  private setupRoutes;
+  start(): Promise<void>;
+  stop(): Promise<void>;
+}
+//#endregion
+//#region src/index.d.ts
+/**
+ * Start the AFS Explorer web server
+ * @param afs - The AFS instance to explore
+ * @param options - Server options
+ * @returns The ExplorerServer instance
+ */
+declare function startExplorer(afs: AFS, options?: ExplorerServerOptions): Promise<ExplorerServer>;
+//#endregion
+export { ExplorerServer, type ExplorerServerOptions, startExplorer };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/server.ts","../src/index.ts"],"mappings":";;;UAKiB,qBAAA;EAAA,IAAA;EAAA,IAAA;EAAA;AAUjB;;;EAViB,QAAA;AAAA;AAAA,cAUJ,cAAA;EAAA,QAAA,GAAA;EAAA,QAAA,OAAA;EAAA,QAAA,GAAA;EAAA,QAAA,MAAA;EAAA,YAAA,GAAA,EAKI,GAAA,EAAA,OAAA,GACI,qBAAA;EAAA,QAAA,eAAA;EAAA,QAAA,WAAA;EAAA,MAAA,GA2DJ,OAAA;EAAA,KAAA,GAWD,OAAA;AAAA;;;;AChFhB;;;;;iBAAsB,aAAA,CAAA,GAAA,EACf,GAAA,EAAA,OAAA,GACI,qBAAA,GACR,OAAA,CAAQ,cAAA"}

package/dist/index.mjs

@@ -0,0 +1,96 @@
+import path from "node:path";
+import cors from "cors";
+import express from "express";
+
+//#region src/server.ts
+var ExplorerServer = class {
+	app;
+	server;
+	constructor(afs, options = {}) {
+		this.afs = afs;
+		this.options = options;
+		this.app = express();
+		this.setupMiddleware();
+		this.setupRoutes();
+	}
+	setupMiddleware() {
+		this.app.use(cors());
+		this.app.use(express.json());
+	}
+	setupRoutes() {
+		this.app.get("/api/list", async (req, res) => {
+			const path$1 = req.query.path || "/";
+			const maxDepth = req.query.maxDepth ? Number.parseInt(req.query.maxDepth, 10) : 1;
+			const result = await this.afs.list(path$1, { maxDepth });
+			res.json(result);
+		});
+		this.app.get("/api/read", async (req, res) => {
+			const path$1 = req.query.path;
+			if (!path$1) {
+				res.status(400).json({ error: "Path is required" });
+				return;
+			}
+			const result = await this.afs.read(path$1);
+			res.json(result);
+		});
+		this.app.get("/api/search", async (req, res) => {
+			const path$1 = req.query.path || "/";
+			const query = req.query.query;
+			if (!query) {
+				res.status(400).json({ error: "Query is required" });
+				return;
+			}
+			const result = await this.afs.search(path$1, query);
+			res.json(result);
+		});
+		if (this.options.distPath) {
+			const distPath = path.resolve(this.options.distPath);
+			this.app.use(express.static(distPath));
+			this.app.get("/{*splat}", (_req, res) => {
+				res.sendFile("index.html", { root: distPath });
+			});
+		}
+		this.app.use((err, _req, res, _next) => {
+			res.status(500).json({ error: err.message || String(err) });
+		});
+	}
+	async start() {
+		const port = this.options.port || 3e3;
+		const host = this.options.host || "localhost";
+		return new Promise((resolve) => {
+			this.server = this.app.listen(port, host, () => {
+				resolve();
+			});
+		});
+	}
+	async stop() {
+		return new Promise((resolve, reject) => {
+			if (this.server) this.server.close((err) => {
+				if (err && err.code !== "ERR_SERVER_NOT_RUNNING") reject(err);
+				else {
+					this.server = void 0;
+					resolve();
+				}
+			});
+			else resolve();
+		});
+	}
+};
+
+//#endregion
+//#region src/index.ts
+/**
+* Start the AFS Explorer web server
+* @param afs - The AFS instance to explore
+* @param options - Server options
+* @returns The ExplorerServer instance
+*/
+async function startExplorer(afs, options = {}) {
+	const server = new ExplorerServer(afs, options);
+	await server.start();
+	return server;
+}
+
+//#endregion
+export { ExplorerServer, startExplorer };
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":["path"],"sources":["../src/server.ts","../src/index.ts"],"sourcesContent":["import path from \"node:path\";\nimport type { AFS } from \"@aigne/afs\";\nimport cors from \"cors\";\nimport express from \"express\";\n\nexport interface ExplorerServerOptions {\n  port?: number;\n  host?: string;\n  /**\n   * Path to the dist directory containing the built frontend.\n   * If not provided, static file serving will be disabled.\n   */\n  distPath?: string;\n}\n\nexport class ExplorerServer {\n  private app: express.Application;\n  private server?: ReturnType<typeof this.app.listen>;\n\n  constructor(\n    private afs: AFS,\n    private options: ExplorerServerOptions = {},\n  ) {\n    this.app = express();\n    this.setupMiddleware();\n    this.setupRoutes();\n  }\n\n  private setupMiddleware() {\n    this.app.use(cors());\n    this.app.use(express.json());\n  }\n\n  private setupRoutes() {\n    // API Routes\n    this.app.get(\"/api/list\", async (req, res) => {\n      const path = (req.query.path as string) || \"/\";\n      const maxDepth = req.query.maxDepth ? Number.parseInt(req.query.maxDepth as string, 10) : 1;\n      const result = await this.afs.list(path, { maxDepth });\n      res.json(result);\n    });\n\n    this.app.get(\"/api/read\", async (req, res) => {\n      const path = req.query.path as string;\n      if (!path) {\n        res.status(400).json({ error: \"Path is required\" });\n        return;\n      }\n      const result = await this.afs.read(path);\n      res.json(result);\n    });\n\n    this.app.get(\"/api/search\", async (req, res) => {\n      const path = (req.query.path as string) || \"/\";\n      const query = req.query.query as string;\n      if (!query) {\n        res.status(400).json({ error: \"Query is required\" });\n        return;\n      }\n      const result = await this.afs.search(path, query);\n      res.json(result);\n    });\n\n    // Serve static files from the dist directory (if provided)\n    if (this.options.distPath) {\n      const distPath = path.resolve(this.options.distPath);\n      this.app.use(express.static(distPath));\n      this.app.get(\"/{*splat}\", (_req, res) => {\n        res.sendFile(\"index.html\", { root: distPath });\n      });\n    }\n\n    // Global error handler\n    this.app.use(\n      (err: Error, _req: express.Request, res: express.Response, _next: express.NextFunction) => {\n        res.status(500).json({ error: err.message || String(err) });\n      },\n    );\n  }\n\n  async start(): Promise<void> {\n    const port = this.options.port || 3000;\n    const host = this.options.host || \"localhost\";\n\n    return new Promise((resolve) => {\n      this.server = this.app.listen(port, host, () => {\n        resolve();\n      });\n    });\n  }\n\n  async stop(): Promise<void> {\n    return new Promise((resolve, reject) => {\n      if (this.server) {\n        this.server.close((err) => {\n          // Ignore ERR_SERVER_NOT_RUNNING error\n          if (err && (err as NodeJS.ErrnoException).code !== \"ERR_SERVER_NOT_RUNNING\") {\n            reject(err);\n          } else {\n            this.server = undefined;\n            resolve();\n          }\n        });\n      } else {\n        resolve();\n      }\n    });\n  }\n}\n","import type { AFS } from \"@aigne/afs\";\nimport { ExplorerServer, type ExplorerServerOptions } from \"./server.js\";\n\nexport { ExplorerServer, type ExplorerServerOptions };\n\n/**\n * Start the AFS Explorer web server\n * @param afs - The AFS instance to explore\n * @param options - Server options\n * @returns The ExplorerServer instance\n */\nexport async function startExplorer(\n  afs: AFS,\n  options: ExplorerServerOptions = {},\n): Promise<ExplorerServer> {\n  const server = new ExplorerServer(afs, options);\n  await server.start();\n  return server;\n}\n"],"mappings":";;;;;AAeA,IAAa,iBAAb,MAA4B;CAC1B,AAAQ;CACR,AAAQ;CAER,YACE,AAAQ,KACR,AAAQ,UAAiC,EAAE,EAC3C;EAFQ;EACA;AAER,OAAK,MAAM,SAAS;AACpB,OAAK,iBAAiB;AACtB,OAAK,aAAa;;CAGpB,AAAQ,kBAAkB;AACxB,OAAK,IAAI,IAAI,MAAM,CAAC;AACpB,OAAK,IAAI,IAAI,QAAQ,MAAM,CAAC;;CAG9B,AAAQ,cAAc;AAEpB,OAAK,IAAI,IAAI,aAAa,OAAO,KAAK,QAAQ;GAC5C,MAAMA,SAAQ,IAAI,MAAM,QAAmB;GAC3C,MAAM,WAAW,IAAI,MAAM,WAAW,OAAO,SAAS,IAAI,MAAM,UAAoB,GAAG,GAAG;GAC1F,MAAM,SAAS,MAAM,KAAK,IAAI,KAAKA,QAAM,EAAE,UAAU,CAAC;AACtD,OAAI,KAAK,OAAO;IAChB;AAEF,OAAK,IAAI,IAAI,aAAa,OAAO,KAAK,QAAQ;GAC5C,MAAMA,SAAO,IAAI,MAAM;AACvB,OAAI,CAACA,QAAM;AACT,QAAI,OAAO,IAAI,CAAC,KAAK,EAAE,OAAO,oBAAoB,CAAC;AACnD;;GAEF,MAAM,SAAS,MAAM,KAAK,IAAI,KAAKA,OAAK;AACxC,OAAI,KAAK,OAAO;IAChB;AAEF,OAAK,IAAI,IAAI,eAAe,OAAO,KAAK,QAAQ;GAC9C,MAAMA,SAAQ,IAAI,MAAM,QAAmB;GAC3C,MAAM,QAAQ,IAAI,MAAM;AACxB,OAAI,CAAC,OAAO;AACV,QAAI,OAAO,IAAI,CAAC,KAAK,EAAE,OAAO,qBAAqB,CAAC;AACpD;;GAEF,MAAM,SAAS,MAAM,KAAK,IAAI,OAAOA,QAAM,MAAM;AACjD,OAAI,KAAK,OAAO;IAChB;AAGF,MAAI,KAAK,QAAQ,UAAU;GACzB,MAAM,WAAW,KAAK,QAAQ,KAAK,QAAQ,SAAS;AACpD,QAAK,IAAI,IAAI,QAAQ,OAAO,SAAS,CAAC;AACtC,QAAK,IAAI,IAAI,cAAc,MAAM,QAAQ;AACvC,QAAI,SAAS,cAAc,EAAE,MAAM,UAAU,CAAC;KAC9C;;AAIJ,OAAK,IAAI,KACN,KAAY,MAAuB,KAAuB,UAAgC;AACzF,OAAI,OAAO,IAAI,CAAC,KAAK,EAAE,OAAO,IAAI,WAAW,OAAO,IAAI,EAAE,CAAC;IAE9D;;CAGH,MAAM,QAAuB;EAC3B,MAAM,OAAO,KAAK,QAAQ,QAAQ;EAClC,MAAM,OAAO,KAAK,QAAQ,QAAQ;AAElC,SAAO,IAAI,SAAS,YAAY;AAC9B,QAAK,SAAS,KAAK,IAAI,OAAO,MAAM,YAAY;AAC9C,aAAS;KACT;IACF;;CAGJ,MAAM,OAAsB;AAC1B,SAAO,IAAI,SAAS,SAAS,WAAW;AACtC,OAAI,KAAK,OACP,MAAK,OAAO,OAAO,QAAQ;AAEzB,QAAI,OAAQ,IAA8B,SAAS,yBACjD,QAAO,IAAI;SACN;AACL,UAAK,SAAS;AACd,cAAS;;KAEX;OAEF,UAAS;IAEX;;;;;;;;;;;;AC/FN,eAAsB,cACpB,KACA,UAAiC,EAAE,EACV;CACzB,MAAM,SAAS,IAAI,eAAe,KAAK,QAAQ;AAC/C,OAAM,OAAO,OAAO;AACpB,QAAO"}