@vectorx/xhs-cloud-cli 0.6.0 → 1.0.0

package/templates/ai-cloud-functions-example/agent-cloudbase-functions.json

@@ -0,0 +1,83 @@
+{
+  "functionsRoot": "./src",
+  "functions": [
+    {
+      "name": "userProfile",
+      "directory": "./user",
+      "source": "index.js",
+      "triggerPath": "/user/profile"
+    },
+    {
+      "name": "jsonUsersList",
+      "directory": "./json",
+      "source": "index.js",
+      "triggerPath": "/json/users"
+    },
+    {
+      "name": "jsonUsersCreate",
+      "directory": "./json",
+      "source": "index.js",
+      "triggerPath": "/json/users/create"
+    },
+    {
+      "name": "jsonUsersBatch",
+      "directory": "./json",
+      "source": "index.js",
+      "triggerPath": "/json/users/batch"
+    },
+    {
+      "name": "formSubmit",
+      "directory": "./form",
+      "source": "index.js",
+      "triggerPath": "/form/submit"
+    },
+    {
+      "name": "formSubmissions",
+      "directory": "./form",
+      "source": "index.js",
+      "triggerPath": "/form/submissions"
+    },
+    {
+      "name": "multipartUpload",
+      "directory": "./multipart",
+      "source": "index.js",
+      "triggerPath": "/multipart/upload"
+    },
+    {
+      "name": "multipartFiles",
+      "directory": "./multipart",
+      "source": "index.js",
+      "triggerPath": "/multipart/files"
+    },
+    {
+      "name": "binaryUpload",
+      "directory": "./binary",
+      "source": "index.js",
+      "triggerPath": "/binary/upload"
+    },
+    {
+      "name": "binaryFiles",
+      "directory": "./binary",
+      "source": "index.js",
+      "triggerPath": "/binary/files"
+    },
+    {
+      "name": "textSubmit",
+      "directory": "./text",
+      "source": "index.js",
+      "triggerPath": "/text/submit"
+    },
+    {
+      "name": "textLogs",
+      "directory": "./text",
+      "source": "index.js",
+      "triggerPath": "/text/logs"
+    },
+    {
+      "name": "textHtml",
+      "directory": "./text",
+      "source": "index.js",
+      "triggerPath": "/text/html"
+    }
+  ]
+}

package/templates/ai-cloud-functions-example/package.json

@@ -0,0 +1,10 @@
+{
+  "version": "1.0.0",
+  "description": "小红书 - 云开发云函数示例",
+  "scripts": {
+    "dev": "rcb-ff"
+  },
+  "dependencies": {
+    "@vectorx/functions-framework": "latest"
+  }
+}

package/templates/ai-cloud-functions-example/src/binary/index.js

@@ -0,0 +1,207 @@
+/**
+ * 二进制数据处理示例函数
+ * 
+ * 覆盖场景：
+ * - Content-Type: application/octet-stream
+ * 
+ * 业务场景：处理二进制文件（图片、文档等），模拟保存到数据库或 OSS
+ */
+
+// Mock 二进制文件存储记录
+const BINARY_FILES = [];
+
+/**
+ * POST 请求：上传二进制文件
+ * 
+ * 示例：
+ * - POST /binary/upload
+ * - Content-Type: application/octet-stream
+ * - Body: 二进制数据（Buffer）
+ */
+exports.binaryUpload = async function binaryUpload(event, context) {
+  console.log('[binaryUpload] 函数调用开始', {
+    ctxId: context?.ctxId,
+    eventID: context?.eventID,
+    timestamp: new Date().toISOString(),
+  });
+  
+  // 获取二进制数据
+  let binaryData;
+  let fileName = 'binary_file';
+
+  const params = event?.params;
+
+  console.log('=====> binaryUpload params', params);
+
+  // 对齐抖音云托管：二进制数据从 event.params 中获取（Buffer / base64 string / 包装对象）
+  if (Buffer.isBuffer(params)) {
+    binaryData = params;
+    console.log('[binaryUpload] 数据格式：event.params 是 Buffer');
+  } else if (typeof params === 'string') {
+    // 可能是 base64 编码的字符串
+    binaryData = Buffer.from(params, 'base64');
+    console.log('[binaryUpload] 数据格式：event.params 是 base64 字符串');
+  } else if (params && Buffer.isBuffer(params.data)) {
+    binaryData = params.data;
+    fileName = params.fileName || fileName;
+    console.log('[binaryUpload] 数据格式：event.params.data 是 Buffer');
+  } else {
+    console.log('[binaryUpload] 错误：无法解析二进制数据格式');
+    return {
+      ok: false,
+      code: 400,
+      message: "INVALID_BINARY_DATA",
+      detail: "无法解析二进制数据",
+    };
+  }
+  
+  if (!binaryData || binaryData.length === 0) {
+    console.log('[binaryUpload] 错误：二进制数据为空');
+    return {
+      ok: false,
+      code: 400,
+      message: "EMPTY_BINARY_DATA",
+      detail: "二进制数据为空",
+    };
+  }
+  
+  const fileSize = binaryData.length;
+  
+  console.log('[binaryUpload] 二进制数据信息', {
+    size: fileSize,
+    fileName,
+    header: Array.from(binaryData.slice(0, 4)).map(b => '0x' + b.toString(16).padStart(2, '0')),
+  });
+  
+  // 模拟检测文件类型（通过文件头）
+  let detectedType = 'application/octet-stream';
+  const header = binaryData.slice(0, 4);
+  
+  // 简单的文件类型检测
+  if (header[0] === 0xFF && header[1] === 0xD8) {
+    detectedType = 'image/jpeg';
+    fileName = fileName.endsWith('.jpg') || fileName.endsWith('.jpeg') ? fileName : fileName + '.jpg';
+    console.log('[binaryUpload] 检测到文件类型：JPEG');
+  } else if (header[0] === 0x89 && header[1] === 0x50 && header[2] === 0x4E && header[3] === 0x47) {
+    detectedType = 'image/png';
+    fileName = fileName.endsWith('.png') ? fileName : fileName + '.png';
+    console.log('[binaryUpload] 检测到文件类型：PNG');
+  } else if (header[0] === 0x25 && header[1] === 0x50 && header[2] === 0x44 && header[3] === 0x46) {
+    detectedType = 'application/pdf';
+    fileName = fileName.endsWith('.pdf') ? fileName : fileName + '.pdf';
+    console.log('[binaryUpload] 检测到文件类型：PDF');
+  } else {
+    console.log('[binaryUpload] 未识别的文件类型，使用默认类型：application/octet-stream');
+  }
+  
+  // 模拟保存到 OSS
+  const fileId = `bin_${Date.now()}_${Math.random().toString(36).substr(2, 9)}`;
+  const ossUrl = `https://oss.example.com/binary/${fileId}`;
+  
+  console.log('[binaryUpload] 生成文件 ID 和 OSS URL', { fileId, ossUrl });
+  
+  // 模拟数据库保存文件元数据
+  const fileRecord = {
+    id: fileId,
+    fileName,
+    fileType: detectedType,
+    fileSize,
+    ossUrl,
+    uploadedAt: new Date().toISOString(),
+    // 实际场景中，二进制数据会保存到 OSS，这里只保存元数据
+    // binaryData: binaryData.toString('base64'), // 仅用于测试，实际不存储
+  };
+  BINARY_FILES.push(fileRecord);
+  
+  console.log('[binaryUpload] 二进制文件上传成功', {
+    fileId,
+    fileName,
+    fileType: detectedType,
+    fileSize,
+    ossUrl,
+    totalFiles: BINARY_FILES.length,
+  });
+  
+  return {
+    ok: true,
+    code: 0,
+    message: "BINARY_UPLOAD_OK",
+    data: {
+      fileId,
+      fileName,
+      fileType: detectedType,
+      fileSize,
+      ossUrl,
+      uploadedAt: fileRecord.uploadedAt,
+    },
+    contentType: "application/octet-stream",
+    // 模拟业务逻辑：返回处理结果
+    businessLogic: {
+      detectedType,
+      savedToDatabase: true,
+      uploadedToOSS: true,
+      canAccess: true,
+      // 模拟文件处理：如果是图片，可以生成缩略图等
+      processed: detectedType.startsWith('image/') ? {
+        thumbnailGenerated: true,
+        thumbnailUrl: `${ossUrl}_thumb`,
+      } : null,
+    },
+    meta: {
+      ctxId: context.ctxId,
+      eventID: context.eventID,
+      eventType: context.eventType,
+    },
+  };
+};
+
+/**
+ * GET 请求：查询二进制文件信息
+ * 
+ * 示例：
+ * - GET /binary/files?fileType=image/jpeg
+ */
+exports.binaryFiles = async function binaryFiles(event, context) {
+  console.log('[binaryFiles] 函数调用开始', {
+    ctxId: context?.ctxId,
+    eventID: context?.eventID,
+    timestamp: new Date().toISOString(),
+  });
+  
+  const { fileType } = context.query;
+  
+  console.log('[binaryFiles] 查询参数', { fileType, totalFiles: BINARY_FILES.length });
+  
+  let files = BINARY_FILES;
+  
+  // 模拟数据库查询：按文件类型过滤
+  if (fileType) {
+    files = BINARY_FILES.filter(f => f.fileType === fileType);
+    console.log('[binaryFiles] 按文件类型过滤', { fileType, filteredCount: files.length });
+  }
+  
+  console.log('[binaryFiles] 查询结果', { total: files.length });
+  
+  return {
+    ok: true,
+    code: 0,
+    message: "BINARY_FILES_OK",
+    data: {
+      total: files.length,
+      files: files.map(f => ({
+        id: f.id,
+        fileName: f.fileName,
+        fileType: f.fileType,
+        fileSize: f.fileSize,
+        ossUrl: f.ossUrl,
+        uploadedAt: f.uploadedAt,
+      })),
+    },
+    contentType: "application/octet-stream",
+    meta: {
+      ctxId: context.ctxId,
+      eventID: context.eventID,
+      eventType: context.eventType,
+    },
+  };
+};

package/templates/ai-cloud-functions-example/src/context/context-service.js

@@ -0,0 +1,94 @@
+/**
+ * context 能力验证 - 业务逻辑层（与 handler 拆分）
+ * 目标：尽量覆盖 headers/httpMethod/path/url/query/cookies/trigger 以及 set/remove/status/setCookie/clearCookie。
+ */
+
+function pick(obj, keys) {
+  const out = {};
+  for (const k of keys) out[k] = obj?.[k];
+  return out;
+}
+
+exports.buildEcho = function buildEcho(context) {
+  const summary = {
+    httpMethod: context.httpMethod,
+    path: context.path,
+    url: context.url,
+    query: context.query,
+    cookies: context.cookies,
+    trigger: context.trigger,
+    // 只回传少量 header，避免噪音/敏感信息
+    headers: pick(context.headers, ["content-type", "user-agent", "xhs-cloud-trigger", "cookie"]),
+  };
+
+  return {
+    ok: true,
+    code: 0,
+    message: "CTX_ECHO_OK",
+    data: summary,
+  };
+};
+
+exports.applyHeaderOps = function applyHeaderOps(context) {
+  // set/remove 都需要能影响最终 response headers
+  context.set("x-ctx-keep", "1");
+  context.set("x-ctx-drop", "1");
+  context.remove("x-ctx-drop");
+
+  context.status(500)
+  return {
+    ok: true,
+    code: 0,
+    message: "CTX_HEADERS_OK",
+    data: {
+      note: "请检查响应头：应存在 x-ctx-keep，不应存在 x-ctx-drop",
+    },
+  };
+};
+
+exports.applyStatusOps = function applyStatusOps(context, statusCode) {
+  context.status(statusCode);
+  context.set("x-ctx-status", String(statusCode));
+
+  return {
+    ok: true,
+    code: 0,
+    message: "CTX_STATUS_OK",
+    data: { statusCode },
+  };
+};
+
+exports.applyCookieSet = function applyCookieSet(context, name, value) {
+  context.setCookie(name, value, {
+    httpOnly: true,
+    sameSite: "lax",
+    path: "/",
+  });
+
+  return {
+    ok: true,
+    code: 0,
+    message: "CTX_COOKIE_SET_OK",
+    data: {
+      name,
+      value,
+      note: "请检查响应头 Set-Cookie 是否存在",
+    },
+  };
+};
+
+exports.applyCookieClear = function applyCookieClear(context, name) {
+  context.clearCookie(name, { path: "/" });
+
+  return {
+    ok: true,
+    code: 0,
+    message: "CTX_COOKIE_CLEAR_OK",
+    data: {
+      name,
+      note: "请检查响应头 Set-Cookie 是否把 cookie 过期清理",
+    },
+  };
+};
+
+

package/templates/ai-cloud-functions-example/src/context/index.js

@@ -0,0 +1,57 @@
+/**
+ * context 能力验证 - handler 层
+ * 注意：新增函数数量控制在 <= 5 个
+ *
+ * 路由见 agent-cloudbase-functions.json：
+ * - GET  /ctx/echo
+ * - GET  /ctx/headers
+ * - GET  /ctx/status
+ * - GET  /ctx/cookie/set
+ * - GET  /ctx/cookie/clear
+ */
+
+const {
+  buildEcho,
+  applyHeaderOps,
+  applyStatusOps,
+  applyCookieSet,
+  applyCookieClear,
+} = require("./context-service");
+
+// 1) 验证基础字段是否齐全（headers/httpMethod/path/url/query/cookies/trigger）
+exports.ctxEcho = async function ctxEcho(event, context) {
+  return buildEcho(context);
+};
+
+// 2) 验证 context.set / context.remove
+exports.ctxHeaders = async function ctxHeaders(event, context) {
+  return applyHeaderOps(context);
+};
+
+// 3) 验证 context.status
+exports.ctxStatus = async function ctxStatus(event, context) {
+  const query = context.query || {};
+  const raw = query.code ?? "201";
+// 12312321 throw new Error('Invalid statdxus code: ' + raw);
+  const code = Number(raw);
+  const statusCode = Number.isFinite(code) ? code : 201;
+  return applyStatusOps(context, statusCode);
+};
+
+// 4) 验证 context.setCookie
+exports.ctxCookieSet = async function ctxCookieSet(event, context) {
+  const query = context.query || {};
+  console.log('====>', JSON.stringify(event, null, 2), event.params, context.query)
+  const name = query.name || "token";
+  const value = query.value || `v_${Date.now()}`;
+  return applyCookieSet(context, String(name), String(value));
+};
+
+// 5) 验证 context.clearCookie
+exports.ctxCookieClear = async function ctxCookieClear(event, context) {
+  const query = context.query || {};
+  const name = query.name || "token";
+  return applyCookieClear(context, String(name));
+};
+
+