npm - @aigne/afs-explorer - Versions diffs - 1.0.0 - Mend

@aigne/afs-explorer 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (18) hide show

package/CHANGELOG.md +22 -0
package/LICENSE.md +93 -0
package/README.md +133 -0
package/dist/assets/index-viceiJOt.js +271 -0
package/dist/index.html +13 -0
package/lib/cjs/index.d.ts +10 -0
package/lib/cjs/index.js +17 -0
package/lib/cjs/package.json +3 -0
package/lib/cjs/server.d.ts +21 -0
package/lib/cjs/server.js +107 -0
package/lib/dts/index.d.ts +10 -0
package/lib/dts/server.d.ts +21 -0
package/lib/esm/index.d.ts +10 -0
package/lib/esm/index.js +13 -0
package/lib/esm/package.json +3 -0
package/lib/esm/server.d.ts +21 -0
package/lib/esm/server.js +100 -0
package/package.json +102 -0

package/dist/index.html ADDED Viewed

@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>AFS Explorer</title>
+    <script type="module" crossorigin src="/assets/index-viceiJOt.js"></script>
+  </head>
+  <body>
+    <div id="root"></div>
+  </body>
+</html>

package/lib/cjs/index.d.ts ADDED Viewed

@@ -0,0 +1,10 @@
+import type { AFS } from "@aigne/afs";
+import { ExplorerServer, type ExplorerServerOptions } from "./server.js";
+export { ExplorerServer, type ExplorerServerOptions };
+/**
+ * Start the AFS Explorer web server
+ * @param afs - The AFS instance to explore
+ * @param options - Server options
+ * @returns The ExplorerServer instance
+ */
+export declare function startExplorer(afs: AFS, options?: ExplorerServerOptions): Promise<ExplorerServer>;

package/lib/cjs/index.js ADDED Viewed

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExplorerServer = void 0;
+exports.startExplorer = startExplorer;
+const server_js_1 = require("./server.js");
+Object.defineProperty(exports, "ExplorerServer", { enumerable: true, get: function () { return server_js_1.ExplorerServer; } });
+/**
+ * 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 server_js_1.ExplorerServer(afs, options);
+    await server.start();
+    return server;
+}

package/lib/cjs/package.json ADDED Viewed

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/lib/cjs/server.d.ts ADDED Viewed

@@ -0,0 +1,21 @@
+import type { AFS } from "@aigne/afs";
+export 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;
+}
+export 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>;
+}

package/lib/cjs/server.js ADDED Viewed

@@ -0,0 +1,107 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExplorerServer = void 0;
+const node_path_1 = __importDefault(require("node:path"));
+const cors_1 = __importDefault(require("cors"));
+const express_1 = __importDefault(require("express"));
+class ExplorerServer {
+    afs;
+    options;
+    app;
+    server;
+    constructor(afs, options = {}) {
+        this.afs = afs;
+        this.options = options;
+        this.app = (0, express_1.default)();
+        this.setupMiddleware();
+        this.setupRoutes();
+    }
+    setupMiddleware() {
+        this.app.use((0, cors_1.default)());
+        this.app.use(express_1.default.json());
+    }
+    setupRoutes() {
+        // API Routes
+        this.app.get("/api/list", async (req, res) => {
+            try {
+                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);
+            }
+            catch (error) {
+                res.status(500).json({ error: String(error) });
+            }
+        });
+        this.app.get("/api/read", async (req, res) => {
+            try {
+                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);
+            }
+            catch (error) {
+                res.status(500).json({ error: String(error) });
+            }
+        });
+        this.app.get("/api/search", async (req, res) => {
+            try {
+                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);
+            }
+            catch (error) {
+                res.status(500).json({ error: String(error) });
+            }
+        });
+        // Serve static files from the dist directory (if provided)
+        if (this.options.distPath) {
+            const distPath = node_path_1.default.resolve(this.options.distPath);
+            this.app.use(express_1.default.static(distPath));
+            // Serve index.html for all other routes (SPA fallback)
+            this.app.use((_req, res) => {
+                res.sendFile(node_path_1.default.join(distPath, "index.html"));
+            });
+        }
+    }
+    async start() {
+        const port = this.options.port || 3000;
+        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) => {
+                    // Ignore ERR_SERVER_NOT_RUNNING error
+                    if (err && err.code !== "ERR_SERVER_NOT_RUNNING") {
+                        reject(err);
+                    }
+                    else {
+                        this.server = undefined;
+                        resolve();
+                    }
+                });
+            }
+            else {
+                resolve();
+            }
+        });
+    }
+}
+exports.ExplorerServer = ExplorerServer;

package/lib/dts/index.d.ts ADDED Viewed

@@ -0,0 +1,10 @@
+import type { AFS } from "@aigne/afs";
+import { ExplorerServer, type ExplorerServerOptions } from "./server.js";
+export { ExplorerServer, type ExplorerServerOptions };
+/**
+ * Start the AFS Explorer web server
+ * @param afs - The AFS instance to explore
+ * @param options - Server options
+ * @returns The ExplorerServer instance
+ */
+export declare function startExplorer(afs: AFS, options?: ExplorerServerOptions): Promise<ExplorerServer>;

package/lib/dts/server.d.ts ADDED Viewed

@@ -0,0 +1,21 @@
+import type { AFS } from "@aigne/afs";
+export 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;
+}
+export 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>;
+}

package/lib/esm/index.d.ts ADDED Viewed

@@ -0,0 +1,10 @@
+import type { AFS } from "@aigne/afs";
+import { ExplorerServer, type ExplorerServerOptions } from "./server.js";
+export { ExplorerServer, type ExplorerServerOptions };
+/**
+ * Start the AFS Explorer web server
+ * @param afs - The AFS instance to explore
+ * @param options - Server options
+ * @returns The ExplorerServer instance
+ */
+export declare function startExplorer(afs: AFS, options?: ExplorerServerOptions): Promise<ExplorerServer>;

package/lib/esm/index.js ADDED Viewed

@@ -0,0 +1,13 @@
+import { ExplorerServer } from "./server.js";
+export { ExplorerServer };
+/**
+ * Start the AFS Explorer web server
+ * @param afs - The AFS instance to explore
+ * @param options - Server options
+ * @returns The ExplorerServer instance
+ */
+export async function startExplorer(afs, options = {}) {
+    const server = new ExplorerServer(afs, options);
+    await server.start();
+    return server;
+}

package/lib/esm/package.json ADDED Viewed

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/lib/esm/server.d.ts ADDED Viewed

@@ -0,0 +1,21 @@
+import type { AFS } from "@aigne/afs";
+export 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;
+}
+export 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>;
+}

package/lib/esm/server.js ADDED Viewed

@@ -0,0 +1,100 @@
+import path from "node:path";
+import cors from "cors";
+import express from "express";
+export class ExplorerServer {
+    afs;
+    options;
+    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() {
+        // API Routes
+        this.app.get("/api/list", async (req, res) => {
+            try {
+                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);
+            }
+            catch (error) {
+                res.status(500).json({ error: String(error) });
+            }
+        });
+        this.app.get("/api/read", async (req, res) => {
+            try {
+                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);
+            }
+            catch (error) {
+                res.status(500).json({ error: String(error) });
+            }
+        });
+        this.app.get("/api/search", async (req, res) => {
+            try {
+                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);
+            }
+            catch (error) {
+                res.status(500).json({ error: String(error) });
+            }
+        });
+        // Serve static files from the dist directory (if provided)
+        if (this.options.distPath) {
+            const distPath = path.resolve(this.options.distPath);
+            this.app.use(express.static(distPath));
+            // Serve index.html for all other routes (SPA fallback)
+            this.app.use((_req, res) => {
+                res.sendFile(path.join(distPath, "index.html"));
+            });
+        }
+    }
+    async start() {
+        const port = this.options.port || 3000;
+        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) => {
+                    // Ignore ERR_SERVER_NOT_RUNNING error
+                    if (err && err.code !== "ERR_SERVER_NOT_RUNNING") {
+                        reject(err);
+                    }
+                    else {
+                        this.server = undefined;
+                        resolve();
+                    }
+                });
+            }
+            else {
+                resolve();
+            }
+        });
+    }
+}

package/package.json ADDED Viewed

@@ -0,0 +1,102 @@
+{
+  "name": "@aigne/afs-explorer",
+  "version": "1.0.0",
+  "description": "Explore and manage AFS file systems",
+  "publishConfig": {
+    "access": "public"
+  },
+  "author": "Arcblock <blocklet@arcblock.io> https://github.com/blocklet",
+  "homepage": "https://www.aigne.io/framework",
+  "license": "Elastic-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/AIGNE-io/aigne-framework"
+  },
+  "bugs": {
+    "url": "https://github.com/AIGNE-io/aigne-framework/issues"
+  },
+  "files": [
+    "lib/cjs",
+    "lib/dts",
+    "lib/esm",
+    "dist",
+    "LICENSE",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "type": "module",
+  "main": "./lib/cjs/index.js",
+  "module": "./lib/esm/index.js",
+  "types": "./lib/dts/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/dts/index.d.ts",
+      "import": "./lib/esm/index.js",
+      "require": "./lib/cjs/index.js"
+    },
+    "./index.html": "./dist/index.html",
+    "./*": {
+      "types": "./lib/dts/*",
+      "import": "./lib/esm/*",
+      "require": "./lib/cjs/*"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      ".": [
+        "./lib/dts/index.d.ts"
+      ]
+    }
+  },
+  "dependencies": {
+    "cors": "^2.8.5",
+    "express": "^5.1.0",
+    "yaml": "^2.8.1",
+    "zod": "^3.25.67",
+    "@aigne/afs": "^1.4.0-beta.10",
+    "@aigne/core": "^1.72.0-beta.24"
+  },
+  "devDependencies": {
+    "@emotion/react": "^11.14.0",
+    "@emotion/styled": "^11.14.0",
+    "@mui/icons-material": "^7.3.2",
+    "@mui/material": "^7.3.2",
+    "@mui/x-data-grid": "^8.11.3",
+    "@mui/x-tree-view": "^8.25.0",
+    "@types/bun": "^1.2.22",
+    "@types/cors": "^2.8.18",
+    "@types/express": "^5.0.0",
+    "@types/react": "^19.0.6",
+    "@types/react-dom": "^19.0.3",
+    "@types/react-router-dom": "^5.3.3",
+    "@types/react-syntax-highlighter": "^15.5.13",
+    "@vitejs/plugin-react": "^4.3.4",
+    "npm-run-all": "^4.1.5",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "react-markdown": "^10.1.0",
+    "react-router-dom": "^7.9.1",
+    "react-syntax-highlighter": "^16.1.0",
+    "remark-gfm": "^4.0.1",
+    "rimraf": "^6.0.1",
+    "typescript": "^5.9.2",
+    "vite": "^7.1.5",
+    "vite-plugin-svgr": "^4.3.0",
+    "@aigne/afs-git": "^1.0.0",
+    "@aigne/afs-history": "^1.2.0-beta.11",
+    "@aigne/afs-json": "^1.0.0",
+    "@aigne/afs-local-fs": "^1.4.0-beta.25",
+    "@aigne/test-utils": "^0.5.69-beta.24"
+  },
+  "scripts": {
+    "lint": "tsc --noEmit",
+    "build": "run-s build:web build:lib",
+    "build:lib": "tsc --build scripts/tsconfig.build.json",
+    "build:web": "vite build",
+    "dev": "vite",
+    "clean": "rimraf lib test/coverage dist",
+    "test": "bun test",
+    "test:coverage": "bun test --coverage --coverage-reporter=lcov --coverage-reporter=text",
+    "postbuild": "node ../../scripts/post-build-lib.mjs"
+  }
+}