@seayoo-web/finder 1.1.0 → 2.0.0

package/dist/index.js

@@ -0,0 +1,355 @@
+import fs, { writeFileSync, readdirSync, lstatSync, existsSync, readFileSync } from "fs";
+import path, { relative, join, basename, normalize, sep, dirname, resolve, extname } from "path";
+import open from "open";
+import "colors";
+import { zip } from "compressing";
+import os from "os";
+const presetIgnores = ["node_modules/", ".git/", ".vscode/", ".DS_Store"];
+function compressToBuffer(sourceDir, ignoreFiles, debug) {
+  const ignoreFileList = [...presetIgnores, ...ignoreFiles || []];
+  const filesToCompress = getAllFiles(sourceDir, ignoreFileList);
+  const zipStream = new zip.Stream();
+  filesToCompress.forEach((file) => {
+    zipStream.addEntry(file, { relativePath: relative(sourceDir, file) });
+  });
+  if (debug) {
+    console.log({
+      method: "compressToBuffer",
+      sourceDir,
+      ignores: ignoreFileList,
+      filesCount: filesToCompress.length
+    });
+  }
+  const chunks = [];
+  return new Promise(function(resolve2, reject) {
+    zipStream.on("data", (chunk) => chunks.push(chunk)).on("end", () => {
+      const buffer = Buffer.concat(chunks);
+      if (debug) {
+        writeFileSync(join(process.cwd(), "_finder_deploy_buffer.zip"), buffer);
+      }
+      resolve2(buffer);
+    }).on("error", reject);
+  });
+}
+function getAllFiles(dir, ignores = []) {
+  const list = [];
+  readdirSync(dir).forEach((file) => {
+    const filePath = join(dir, file);
+    const stats = lstatSync(filePath);
+    if (stats.isDirectory()) {
+      list.push(...getAllFiles(filePath, ignores));
+    } else if (!isIgnoreFile(filePath, ignores)) {
+      list.push(filePath);
+    }
+  });
+  return list;
+}
+function isIgnoreFile(filePath, ignores) {
+  const filename = basename(filePath);
+  const dirs = normalize(filePath).split(sep);
+  return ignores.some((name) => {
+    if (name.endsWith("/") && name !== "/") {
+      return dirs.includes(name.slice(0, -1));
+    }
+    return filename === name;
+  });
+}
+function pure(url) {
+  return url.replace(/(?:^https?:\/\/|\/*$)/gi, "");
+}
+function getSystemTempDir() {
+  const dir = path.resolve(os.tmpdir(), "webfinder");
+  if (!fs.existsSync(dir)) {
+    fs.mkdirSync(dir, { recursive: true });
+  }
+  return dir;
+}
+async function request({
+  url,
+  method,
+  headers,
+  data
+}) {
+  const hasFileUpload = method === "POST" && data && Object.values(data).some((value) => typeof value === "object" && "buffer" in value);
+  const requestInit = {
+    method,
+    headers: { ...headers }
+  };
+  try {
+    if (data) {
+      if (hasFileUpload) {
+        const formData = new FormData();
+        Object.entries(data).forEach(([key, value]) => {
+          if (typeof value === "object" && "buffer" in value) {
+            const { buffer, filename, contentType: contentType2 } = value;
+            const blob = new Blob([buffer], { type: contentType2 });
+            formData.append(key, blob, filename);
+          } else {
+            formData.append(key, String(value));
+          }
+        });
+        requestInit.body = formData;
+      } else {
+        requestInit.headers = {
+          "Content-Type": "application/json",
+          ...headers
+        };
+        requestInit.body = JSON.stringify(data);
+      }
+    }
+    const response = await fetch(url, requestInit);
+    let responseData;
+    const contentType = response.headers.get("content-type");
+    if (contentType == null ? void 0 : contentType.includes("application/json")) {
+      responseData = await response.json();
+    } else {
+      responseData = await response.text();
+    }
+    return {
+      status: response.status,
+      message: response.statusText,
+      data: responseData
+    };
+  } catch (err) {
+    return {
+      status: 500,
+      message: err instanceof Error ? err.message : String(err),
+      data: null
+    };
+  }
+}
+const FinderServers = {
+  "finder.seayoo.io": [],
+  "finder.seayoo.com": [],
+  "finder.seayoo.internal": [],
+  "finder.dev.seayoo.com": []
+};
+const FinderApiPaths = {
+  deploy: "/service/deploy",
+  inspect: "/inspect/supported/projects",
+  upload: "/service/upload"
+};
+async function deploy(option) {
+  const { debug, target, buffer, user, key, payload } = option;
+  const targetServer = await findTargetServer(target, debug);
+  if (!targetServer) {
+    throw `finder不支持该域名部署，请检查 ${target}`.bgRed;
+  }
+  if (!user || !key) {
+    throw `部署缺少认证信息(user & key)`.bgRed;
+  }
+  const zipMockName = `${Date.now()}${Math.random().toString(16).slice(-3)}.zip`;
+  const { status, message, data } = await request({
+    url: `${getFinderServerFullPath(targetServer)}${FinderApiPaths.deploy}?target=${encodeURIComponent(pure(target))}`,
+    method: "POST",
+    headers: { user, key },
+    data: {
+      path: zipMockName,
+      file: { buffer, filename: zipMockName, contentType: "application/octet-stream" },
+      payload: JSON.stringify(payload || "")
+    }
+  });
+  if (status !== 200) {
+    throw `${`部署接口错误(${status})`.bgRed} ${message || ""}.red`;
+  }
+  if (!data || typeof data !== "object") {
+    throw `部署接口响应错误，请自行检查是否部署成功。`.bgRed + JSON.stringify(data).red;
+  }
+  if ("err" in data || !("data" in data) || typeof data.data !== "string") {
+    throw `部署接口错误。`.bgRed + JSON.stringify(data).red;
+  }
+  const url = data.data;
+  if (debug) {
+    console.log("部署完毕，接口返回内容", data);
+  }
+  return {
+    previewUrl: url.endsWith("/") ? url.replace(/\/*$/, "/") + "index.html?" + Math.random().toString(16).slice(2) : url.startsWith("http") ? url : ""
+  };
+}
+async function upload(option) {
+  const { debug, target, buffer, user, key } = option;
+  const targetServer = await findTargetServer(target, debug);
+  if (!targetServer) {
+    throw `finder不支持该域名部署，请检查 ${target}`.bgRed;
+  }
+  if (!user || !key) {
+    throw `部署缺少认证信息(user & key)`.bgRed;
+  }
+  const filename = basename(target);
+  const deployTarget = dirname(pure(target));
+  const { status, message, data } = await request({
+    url: `${getFinderServerFullPath(targetServer)}${FinderApiPaths.upload}?target=${encodeURIComponent(deployTarget)}`,
+    method: "POST",
+    headers: { user, key },
+    data: {
+      path: filename,
+      file: { buffer, filename, contentType: "application/octet-stream" }
+    }
+  });
+  if (status !== 200) {
+    throw `${`上传接口错误(${status})`.bgRed} ${message || ""}.red`;
+  }
+  if (!data || typeof data !== "object") {
+    throw `上传接口响应错误，请自行检查是否上传成功。`.bgRed + JSON.stringify(data).red;
+  }
+  if ("err" in data || !("data" in data) || typeof data.data !== "string") {
+    throw `上传接口错误。`.bgRed + JSON.stringify(data).red;
+  }
+  return { previewUrl: `https://${pure(target)}` };
+}
+const getFinderServerFullPath = function(domain) {
+  return (domain.endsWith("internal") ? "http://" : "https://") + domain;
+};
+async function findTargetServer(target, debug) {
+  const t = pure(target);
+  await updateSupportedProjects(false, debug);
+  for (const domain in FinderServers) {
+    if (FinderServers[domain].find((url) => t.startsWith(url))) {
+      return domain;
+    }
+  }
+  await updateSupportedProjects(true, debug);
+  for (const domain in FinderServers) {
+    if (FinderServers[domain].find((url) => t.startsWith(url))) {
+      return domain;
+    }
+  }
+  return null;
+}
+async function updateSupportedProjects(force = false, debug) {
+  const domains = Object.keys(FinderServers);
+  for (const domain of domains) {
+    FinderServers[domain] = await getServerSupportedProjects(domain, force, debug) || [];
+  }
+}
+async function getServerSupportedProjects(serverDomain, ignoreCache = false, debug) {
+  const cacheFile = resolve(getSystemTempDir(), `${serverDomain}.json`);
+  if (existsSync(cacheFile) && !ignoreCache) {
+    try {
+      const cache = JSON.parse(readFileSync(cacheFile).toString());
+      if (Array.isArray(cache) && cache.every((d) => typeof d === "string")) {
+        if (debug) {
+          console.log({ method: "getServerSupportedProjects", serverDomain, cache });
+        }
+        return cache;
+      }
+    } catch (e) {
+      console.error("ReadFinderCacheError", e);
+    }
+  }
+  const inspectURL = `${getFinderServerFullPath(serverDomain)}${FinderApiPaths.inspect}`;
+  const { status, message, data } = await request({
+    url: inspectURL,
+    method: "GET",
+    headers: { UserAgent: `web finder agent v2` }
+  });
+  if (status !== 200) {
+    console.error(`服务器 ${inspectURL} 检查接口错误`.bgRed, (message || "").red);
+    return [];
+  }
+  if (!Array.isArray(data) || !data.every((d) => typeof d === "string")) {
+    console.error(`服务器 ${inspectURL} 接口返回内容错误`.bgRed, JSON.stringify(data).red);
+    return [];
+  }
+  if (debug) {
+    console.log({ method: "getServerSupportedProjects", serverDomain, list: data });
+  }
+  const pureList = data.map(pure);
+  writeFileSync(cacheFile, JSON.stringify(pureList));
+  return pureList;
+}
+async function finderDeploy(option) {
+  const { dist, ignoreFiles, deployTo, user, key, debug, preview, commitLogs } = option;
+  if (!dist) {
+    throw "部署参数 dist 缺失".bgRed;
+  }
+  if (!existsSync(resolve(dist)) || !lstatSync(resolve(dist)).isDirectory()) {
+    throw "部署参数错误，dist 需要是一个存在的文件目录".bgRed + " " + dist.red;
+  }
+  const buffer = await compressToBuffer(dist, ignoreFiles || [], debug).catch((e) => {
+    throw "部署预处理之压缩代码失败".bgRed + " " + (e instanceof Error ? e.message : String(e));
+  });
+  const payload = commitLogs ? { 更新内容: commitLogs } : void 0;
+  if (debug) {
+    console.log({
+      method: "finderDeploy",
+      dist,
+      deployTo,
+      ignoreFiles,
+      payload,
+      user,
+      preview
+    });
+  }
+  if (Array.isArray(deployTo)) {
+    const results = await Promise.all(
+      deployTo.map((target) => {
+        return deploy({ debug, target, buffer, user, key, payload });
+      })
+    );
+    const lastDeployResult = results[results.length - 1];
+    if (preview && lastDeployResult && lastDeployResult.previewUrl) {
+      open(lastDeployResult.previewUrl);
+    }
+    return lastDeployResult.previewUrl || "";
+  }
+  const deployResult = await deploy({ debug, target: deployTo, buffer, user, key, payload });
+  if (preview && deployResult && deployResult.previewUrl) {
+    open(deployResult.previewUrl);
+  }
+  return deployResult.previewUrl || "";
+}
+async function finderUpload(option) {
+  const { filePath, deployTo, user, key, preview, debug } = option;
+  if (!filePath) {
+    throw `部署缺少参数 filePath(文件全路径)`.bgRed;
+  }
+  if (filePath && !existsSync(filePath)) {
+    throw `部署文件不存在(请确保传入完整文件路径)`.bgRed + " " + filePath;
+  }
+  if (!deployTo) {
+    throw `部署缺少参数 deployTo(部署目标)`.bgRed;
+  }
+  const fileExtension = extname(filePath);
+  const filename = basename(filePath);
+  const target = !deployTo.endsWith(fileExtension) ? `${pure(deployTo)}/${filename}` : pure(deployTo);
+  const resp = await upload({ debug, target, buffer: Buffer.from(readFileSync(filePath)), user, key });
+  if (preview && resp.previewUrl) {
+    open(resp.previewUrl);
+  }
+}
+function viteDeployPlugin(option) {
+  let distDir = null;
+  return {
+    name: "finerDeployAgent",
+    generateBundle({ dir }) {
+      distDir = process.cwd();
+      if (dir) {
+        distDir = resolve(distDir, dir);
+      }
+    },
+    async closeBundle() {
+      var _a, _b;
+      if (!distDir) {
+        console.error("没有找到部署资源，请尝试检查 build 是否生成了正确的资源".bgRed);
+        return;
+      }
+      const result = await finderDeploy({
+        preview: true,
+        ...option,
+        dist: distDir
+      }).catch(() => null);
+      if (result === null) {
+        (_a = option.onError) == null ? void 0 : _a.call(option);
+      } else {
+        (_b = option.onFinished) == null ? void 0 : _b.call(option);
+        console.log("部署成功".bgGreen, (result || "").green);
+      }
+    }
+  };
+}
+export {
+  finderDeploy,
+  finderUpload,
+  viteDeployPlugin
+};

package/index.ts

@@ -0,0 +1,2 @@
+export * from "./src/core";
+export * from "./src/plugin";

package/package.json

@@ -1,11 +1,27 @@
 {
   "name": "@seayoo-web/finder",
-  "version": "1.1.0",
+  "version": "2.0.0",
   "description": "agent for web finder",
-  "main": "index.js",
+  "type": "module",
+  "source": "index.ts",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./types/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs",
+      "default": "./dist/index.js"
+    }
+  },
   "scripts": {
-    "minify": "node minify",
-    "pubup": "node minify && npm publish"
+    "build": "vite build && tsc --emitDeclarationOnly",
+    "test": "vitest",
+    "pub": "pnpm build && npm publish"
+  },
+  "engines": {
+    "node": ">= 18"
   },
   "author": "web@seayoo.com",
   "license": "MIT",
@@ -13,12 +29,13 @@
     "access": "public"
   },
   "dependencies": {
-    "compressing": "^1.5.1",
-    "needle": "^3.1.0",
     "colors": "^1.4.0",
-    "open": "^8.4.0"
+    "compressing": "^1.10.1",
+    "open": "^10.1.0"
   },
   "devDependencies": {
-    "terser": "^5.12.1"
+    "@seayoo-web/tsconfig": "workspace:^",
+    "@types/node": "^22.13.1",
+    "vitest": "^3.0.5"
   }
 }

package/src/compress.ts

@@ -0,0 +1,67 @@
+import { readdirSync, lstatSync, writeFileSync } from "fs";
+import { join, relative, normalize, basename, sep } from "path";
+
+import { zip } from "compressing";
+
+// 部署代码默认的忽略列表
+const presetIgnores = ["node_modules/", ".git/", ".vscode/", ".DS_Store"];
+
+/** 代码压缩 */
+export function compressToBuffer(sourceDir: string, ignoreFiles?: string[], debug?: boolean): Promise<Buffer> {
+  const ignoreFileList = [...presetIgnores, ...(ignoreFiles || [])];
+  const filesToCompress = getAllFiles(sourceDir, ignoreFileList);
+  const zipStream = new zip.Stream();
+  // 计算文件在压缩包中的相对路径
+  filesToCompress.forEach((file) => {
+    zipStream.addEntry(file, { relativePath: relative(sourceDir, file) });
+  });
+  if (debug) {
+    console.log({
+      method: "compressToBuffer",
+      sourceDir,
+      ignores: ignoreFileList,
+      filesCount: filesToCompress.length,
+    });
+  }
+  // 将压缩流写入buffer
+  const chunks: Buffer[] = [];
+  return new Promise(function (resolve, reject) {
+    zipStream
+      .on("data", (chunk) => chunks.push(chunk as Buffer))
+      .on("end", () => {
+        const buffer = Buffer.concat(chunks);
+        if (debug) {
+          writeFileSync(join(process.cwd(), "_finder_deploy_buffer.zip"), buffer);
+        }
+        resolve(buffer);
+      })
+      .on("error", reject); // 处理错误
+  });
+}
+
+export function getAllFiles(dir: string, ignores: string[] = []) {
+  const list: string[] = [];
+  readdirSync(dir).forEach((file) => {
+    const filePath = join(dir, file);
+    const stats = lstatSync(filePath);
+    if (stats.isDirectory()) {
+      // 如果是文件夹，递归处理
+      list.push(...getAllFiles(filePath, ignores));
+      // 如果是文件，检查是否符合过滤规则
+    } else if (!isIgnoreFile(filePath, ignores)) {
+      list.push(filePath);
+    }
+  });
+  return list;
+}
+
+export function isIgnoreFile(filePath: string, ignores: string[]) {
+  const filename = basename(filePath);
+  const dirs = normalize(filePath).split(sep);
+  return ignores.some((name) => {
+    if (name.endsWith("/") && name !== "/") {
+      return dirs.includes(name.slice(0, -1));
+    }
+    return filename === name;
+  });
+}

package/src/core.ts

@@ -0,0 +1,104 @@
+import { existsSync, lstatSync, readFileSync } from "fs";
+import { basename, extname, resolve } from "path";
+
+import open from "open";
+
+import "colors";
+import { compressToBuffer } from "./compress";
+import { deploy, upload } from "./service";
+import { pure } from "./utils";
+
+/** 部署一个目录 */
+export async function finderDeploy(option: {
+  /** 需要推送的代码目录 */
+  dist: string;
+  /** 忽略部署的文件，如果是目录则需要以 / 结尾。暂不支持模糊匹配 */
+  ignoreFiles?: string[];
+  /** 部署的目标地址 */
+  deployTo: string | string[];
+  /** 部署 user */
+  user: string;
+  /** 部署 key */
+  key: string;
+  /** 是否输出更多调试信息 */
+  debug?: boolean;
+  /** 是否部署完毕后打开目标文件（index.html） */
+  preview?: boolean;
+  /** 代码的 commit log 信息，换行用 \n */
+  commitLogs?: string;
+}): Promise<string> {
+  const { dist, ignoreFiles, deployTo, user, key, debug, preview, commitLogs } = option;
+  if (!dist) {
+    throw "部署参数 dist 缺失".bgRed;
+  }
+  if (!existsSync(resolve(dist)) || !lstatSync(resolve(dist)).isDirectory()) {
+    throw "部署参数错误，dist 需要是一个存在的文件目录".bgRed + " " + dist.red;
+  }
+  // 压缩代码准备上传
+  const buffer = await compressToBuffer(dist, ignoreFiles || [], debug).catch((e) => {
+    throw "部署预处理之压缩代码失败".bgRed + " " + (e instanceof Error ? e.message : String(e));
+  });
+  const payload = commitLogs ? { 更新内容: commitLogs } : undefined;
+  if (debug) {
+    console.log({
+      method: "finderDeploy",
+      dist,
+      deployTo,
+      ignoreFiles,
+      payload,
+      user,
+      preview,
+    });
+  }
+  if (Array.isArray(deployTo)) {
+    // 多次部署
+    const results = await Promise.all(
+      deployTo.map((target) => {
+        return deploy({ debug, target, buffer, user, key, payload });
+      }),
+    );
+    const lastDeployResult = results[results.length - 1];
+    if (preview && lastDeployResult && lastDeployResult.previewUrl) {
+      open(lastDeployResult.previewUrl);
+    }
+    return lastDeployResult.previewUrl || "";
+  }
+  // 单次部署
+  const deployResult = await deploy({ debug, target: deployTo, buffer, user, key, payload });
+  if (preview && deployResult && deployResult.previewUrl) {
+    open(deployResult.previewUrl);
+  }
+  return deployResult.previewUrl || "";
+}
+
+/** 上传一个文件到 finder */
+export async function finderUpload(option: {
+  /** 需要上传的文件全局路 */
+  filePath: string;
+  /** 部署目标全路径，需要包含文件名 */
+  deployTo: string;
+  user: string;
+  key: string;
+  debug?: boolean;
+  preview?: boolean;
+}) {
+  const { filePath, deployTo, user, key, preview, debug } = option;
+
+  if (!filePath) {
+    throw `部署缺少参数 filePath(文件全路径)`.bgRed;
+  }
+  if (filePath && !existsSync(filePath)) {
+    throw `部署文件不存在(请确保传入完整文件路径)`.bgRed + " " + filePath;
+  }
+  if (!deployTo) {
+    throw `部署缺少参数 deployTo(部署目标)`.bgRed;
+  }
+
+  const fileExtension = extname(filePath);
+  const filename = basename(filePath);
+  const target = !deployTo.endsWith(fileExtension) ? `${pure(deployTo)}/${filename}` : pure(deployTo);
+  const resp = await upload({ debug, target, buffer: Buffer.from(readFileSync(filePath)), user, key });
+  if (preview && resp.previewUrl) {
+    open(resp.previewUrl);
+  }
+}

package/src/plugin.ts

@@ -0,0 +1,39 @@
+import { resolve } from "path";
+
+import { finderDeploy } from "./core";
+import "colors";
+
+type FinderDeployVitePluginOption = Omit<Parameters<typeof finderDeploy>[0], "dist"> & {
+  onFinished?: () => unknown;
+  onError?: () => unknown;
+};
+
+export function viteDeployPlugin(option: FinderDeployVitePluginOption) {
+  let distDir: string | null = null;
+  return {
+    name: "finerDeployAgent",
+    generateBundle({ dir }: { dir: string }) {
+      distDir = process.cwd();
+      if (dir) {
+        distDir = resolve(distDir, dir);
+      }
+    },
+    async closeBundle() {
+      if (!distDir) {
+        console.error("没有找到部署资源，请尝试检查 build 是否生成了正确的资源".bgRed);
+        return;
+      }
+      const result = await finderDeploy({
+        preview: true,
+        ...option,
+        dist: distDir,
+      }).catch(() => null);
+      if (result === null) {
+        option.onError?.();
+      } else {
+        option.onFinished?.();
+        console.log("部署成功".bgGreen, (result || "").green);
+      }
+    },
+  };
+}