@ctil/gql 1.0.3 → 1.0.5

package/README.md

@@ -5,7 +5,7 @@
 - **核心能力**：基于 `graphql-request` 的统一请求管道
 - **安全与体验**：内置登录信息存取与无感刷新（refresh token）
 - **稳健**：内置防抖/速率限制与可选查询结果缓存
-- **易用 API**：`auth`、`query`、`mutation`、`sms`、`gql` 五大模块开箱即用
+- **易用 API**：`auth`、`query`、`mutation`、`sms`、`gql`、`oss` 六大模块开箱即用
 
 ---
 
@@ -28,7 +28,7 @@ yarn add @ctil/gql
 
 ### 1) 初始化客户端
 ```ts
-import { initGraphQLClient, useInterceptor } from '@cc/request';
+import { initGraphQLClient, useInterceptor } from '@ctil/gql';
 
 initGraphQLClient({
   endpoint: 'https://your-graphql-endpoint/graphql',
@@ -55,7 +55,7 @@ useInterceptor({
 
 ### 2) Query 查询
 ```ts
-import { query } from '@cc/request';
+import { query } from '@ctil/gql';
 
 // 列表查询（带可选缓存）
 const list = await query.list({
@@ -92,7 +92,7 @@ const agg = await query.aggregate({
 
 ### 3) Mutation 变更
 ```ts
-import { mutation } from '@cc/request';
+import { mutation } from '@ctil/gql';
 
 // 插入单条
 await mutation.insertOne({
@@ -127,7 +127,7 @@ await mutation.delete({
 
 ### 4) Auth 鉴权
 ```ts
-import { auth, setToken, removeToken, getLoginInfo } from '@cc/request';
+import { auth, setToken, removeToken, getLoginInfo } from '@ctil/gql';
 
 // 登录（会自动持久化登录信息，并覆盖 Bearer Token）
 const loginRes = await auth.login({
@@ -151,7 +151,7 @@ await auth.logoutDevice('device-id-xxx');
 
 ### 5) 短信模块
 ```ts
-import { sms } from '@cc/request';
+import { sms } from '@ctil/gql';
 
 await sms.send({ phone: '18800000000' });
 await sms.verify({ phone: '18800000000', code: '123456' });
@@ -159,7 +159,7 @@ await sms.verify({ phone: '18800000000', code: '123456' });
 
 ### 6) 原生 GQL 执行
 ```ts
-import { gql } from '@cc/request';
+import { gql } from '@ctil/gql';
 
 const data = await gql.execute(`
   query user_by_pk($id: Long!) {
@@ -168,6 +168,26 @@ const data = await gql.execute(`
 `, { id: 1000000000 });
 ```
 
+### 7) 对象存储 执行
+```ts
+import { oss } from '@ctil/gql';
+
+// 本地文件上传
+const file = new File();
+const rs= await oss.uploadFile({
+  file: file
+})
+
+// 网络资源上传
+const rs= await oss.uploadFromUrl({
+  url: "网络url",
+})
+
+// 根据资源ID获取文件
+const rs= await oss.getFilePreview("1000000043")
+
+```
+
 ---
 
 ## Token 与登录信息管理
@@ -216,6 +236,7 @@ UserToken 结构包含：`userId`、`loginAccount`、`token`、`refreshToken`、
 - 变更：`mutation.insertOne`、`mutation.batchInsert`、`mutation.update`、`mutation.batchUpdate`、`mutation.updateByPk`、`mutation.delete`、`mutation.deleteById`
 - 短信：`sms.send`、`sms.verify`
 - 原生：`gql.execute(query, variables?)`
+- 对象存储：`oss.upload`、`oss.uploadFromUrl`、`oss.getFilePreview`
 
 所有模块均具备良好的 TypeScript 类型提示与默认返回范型：`<T = requestResult<any>>`。
 
@@ -245,4 +266,4 @@ UserToken 结构包含：`userId`、`loginAccount`、`token`、`refreshToken`、
 
 ## 许可证
 
-MIT © CaiCai
+MIT © CaiCai@3104591385@qq.com

package/dist/index.cjs

@@ -2752,6 +2752,7 @@ __export(index_exports, {
   gql: () => gql,
   initGraphQLClient: () => initGraphQLClient,
   mutation: () => mutation,
+  oss: () => oss,
   query: () => query,
   removeHeader: () => removeHeader,
   removeToken: () => removeToken,
@@ -3214,14 +3215,14 @@ function visit(root, visitor, visitorKeys = QueryDocumentKeys) {
   let node = root;
   let key = void 0;
   let parent = void 0;
-  const path2 = [];
+  const path3 = [];
   const ancestors = [];
   do {
     index2++;
     const isLeaving = index2 === keys.length;
     const isEdited = isLeaving && edits.length !== 0;
     if (isLeaving) {
-      key = ancestors.length === 0 ? void 0 : path2[path2.length - 1];
+      key = ancestors.length === 0 ? void 0 : path3[path3.length - 1];
       node = parent;
       parent = ancestors.pop();
       if (isEdited) {
@@ -3255,20 +3256,20 @@ function visit(root, visitor, visitorKeys = QueryDocumentKeys) {
       if (node === null || node === void 0) {
         continue;
       }
-      path2.push(key);
+      path3.push(key);
     }
     let result;
     if (!Array.isArray(node)) {
       var _enterLeaveMap$get, _enterLeaveMap$get2;
       isNode(node) || devAssert(false, `Invalid AST Node: ${inspect(node)}.`);
       const visitFn = isLeaving ? (_enterLeaveMap$get = enterLeaveMap.get(node.kind)) === null || _enterLeaveMap$get === void 0 ? void 0 : _enterLeaveMap$get.leave : (_enterLeaveMap$get2 = enterLeaveMap.get(node.kind)) === null || _enterLeaveMap$get2 === void 0 ? void 0 : _enterLeaveMap$get2.enter;
-      result = visitFn === null || visitFn === void 0 ? void 0 : visitFn.call(visitor, node, key, parent, path2, ancestors);
+      result = visitFn === null || visitFn === void 0 ? void 0 : visitFn.call(visitor, node, key, parent, path3, ancestors);
       if (result === BREAK) {
         break;
       }
       if (result === false) {
         if (!isLeaving) {
-          path2.pop();
+          path3.pop();
           continue;
         }
       } else if (result !== void 0) {
@@ -3277,7 +3278,7 @@ function visit(root, visitor, visitorKeys = QueryDocumentKeys) {
           if (isNode(result)) {
             node = result;
           } else {
-            path2.pop();
+            path3.pop();
             continue;
           }
         }
@@ -3287,7 +3288,7 @@ function visit(root, visitor, visitorKeys = QueryDocumentKeys) {
       edits.push([key, node]);
     }
     if (isLeaving) {
-      path2.pop();
+      path3.pop();
     } else {
       var _node$kind;
       stack = {
@@ -4112,6 +4113,63 @@ function buildGraphQLMutationRefreshToken(input) {
   return { query: query2, variables: finalVariables };
 }
 
+// src/builders/oss.ts
+function buildGraphQLUploadPresignedUrl(input) {
+  const fields = [
+    "uploadUrl",
+    "downloadUrl",
+    "objectKey",
+    "expireAt",
+    "contentType",
+    "originalFileName",
+    "resourceId",
+    `uploadHeaders {
+        contentMD5
+        contentType
+        x_oss_object_acl
+        date
+      }`
+  ];
+  const finalVariables = { ...input };
+  const varDefsArr = [];
+  varDefsArr.push("$fileMd5Base64: String!");
+  varDefsArr.push("$fileSuffix: String!");
+  varDefsArr.push("$originalFileName: String!");
+  varDefsArr.push("$fileSize: Long!");
+  if (input.acl) varDefsArr.push("$acl: String");
+  if (input.folder) varDefsArr.push("$folder: String!");
+  const varDefs = varDefsArr.join(", ");
+  const query2 = `mutation uploadPresignedUrl${varDefs ? `(${varDefs})` : ""} {
+      uploadPresignedUrl(
+        fileMd5Base64: $fileMd5Base64,
+        fileSuffix: $fileSuffix,
+        originalFileName: $originalFileName,
+        ${input.folder ? ", folder: $folder" : ""}
+        fileSize: $fileSize
+        ${input.acl ? ", acl: $acl" : ""}
+      ) {
+        ${buildFields(fields)}
+      }
+    }`;
+  return { query: query2, variables: finalVariables };
+}
+function buildGraphQLGetFilePreview(resourceId) {
+  const fields = [
+    "id",
+    "originalFileName",
+    "contentType",
+    "fileSize",
+    "url"
+  ];
+  const finalVariables = { resourceId: Number(resourceId) };
+  const query2 = `query getFilePreview($resourceId: Long!) {
+      getFilePreview(resourceId: $resourceId) {
+        ${buildFields(fields)}
+      }
+    }`;
+  return { query: query2, variables: finalVariables };
+}
+
 // src/rateLimit/rateLimitConfig.ts
 var rateLimitConfig = {
   defaultRules: {
@@ -4618,6 +4676,153 @@ var gql = {
     return execute({ query: query2, variables });
   }
 };
+
+// src/core/api/oss.ts
+var import_crypto = __toESM(require("crypto"), 1);
+var import_fs2 = __toESM(require("fs"), 1);
+var import_path2 = __toESM(require("path"), 1);
+async function computeFileMd5Base64(file) {
+  if (typeof window === "undefined") {
+    let buffer;
+    if (typeof file === "string") {
+      buffer = import_fs2.default.readFileSync(import_path2.default.resolve(file));
+    } else {
+      buffer = Buffer.from(await file.arrayBuffer());
+    }
+    return import_crypto.default.createHash("md5").update(buffer).digest("base64");
+  } else {
+    const arrayBuffer = await file.arrayBuffer();
+    const SparkMD5 = (await import("spark-md5")).default;
+    return SparkMD5.ArrayBuffer.hash(arrayBuffer, true);
+  }
+}
+function parseFileNameAndSuffix(url) {
+  try {
+    const urlObj = new URL(url);
+    const pathname = urlObj.pathname;
+    const decodedName = decodeURIComponent(pathname.split("/").pop() || "file");
+    const suffix = decodedName.includes(".") ? decodedName.split(".").pop() : "";
+    return { fileName: decodedName, fileSuffix: suffix };
+  } catch (e) {
+    const decodedName = decodeURIComponent(url.split("/").pop() || "file");
+    const suffix = decodedName.includes(".") ? decodedName.split(".").pop() : "";
+    return { fileName: decodedName, fileSuffix: suffix };
+  }
+}
+var oss = {
+  /**
+   * 上传文件到 OSS（封装预签名 + fetch 上传 + 返回 FilePreview）
+   * @param params.file 必传
+   * @param params.folder 可选，可为空
+   * @param params.acl 可选，默认 'private'
+   */
+  async uploadFile(params) {
+    const { file, folder, acl = "private" } = params;
+    const md5Base64 = await computeFileMd5Base64(file);
+    const presignedInput = {
+      fileMd5Base64: md5Base64,
+      fileSuffix: file.name.split(".").pop() || "",
+      originalFileName: file.name,
+      fileSize: file.size,
+      acl
+    };
+    if (folder) presignedInput.folder = folder;
+    const presignedResult = await rateLimit("uploadPresignedUrl", "mutation", async () => {
+      const { query: query2, variables } = buildGraphQLUploadPresignedUrl(presignedInput);
+      const result = await execute({ query: query2, variables });
+      return result;
+    }, rateLimitConfig);
+    console.log("presignedResult====>", presignedResult);
+    if (!presignedResult.uploadPresignedUrl) throw new Error("\u83B7\u53D6\u9884\u7B7E\u540D URL \u5931\u8D25");
+    const { uploadUrl, uploadHeaders, downloadUrl, resourceId, contentType, originalFileName } = presignedResult.uploadPresignedUrl;
+    const headers = {};
+    if (uploadHeaders) {
+      if (uploadHeaders.contentMD5) headers["Content-MD5"] = uploadHeaders.contentMD5;
+      if (uploadHeaders.contentType) headers["Content-Type"] = uploadHeaders.contentType;
+      if (uploadHeaders.date) headers["Date"] = uploadHeaders.date;
+    }
+    const res = await fetch(uploadUrl, {
+      method: "PUT",
+      body: file,
+      headers
+    });
+    if (!res.ok) {
+      throw new Error(`\u4E0A\u4F20\u5931\u8D25: ${res.status} ${res.statusText}`);
+    }
+    return {
+      id: resourceId,
+      // 非空断言，确保 TS 类型通过
+      originalFileName: originalFileName ?? file.name,
+      contentType: contentType ?? file.type,
+      fileSize: file.size,
+      url: downloadUrl ?? uploadUrl
+      // downloadUrl 可能为 undefined，fallback 使用 uploadUrl
+    };
+  },
+  /**
+   * 从网络 URL 上传文件到 OSS
+   * @param url 必传 网络文件 URL
+   * @param params.folder 可选
+   * @param params.acl 可选
+   */
+  async uploadFromUrl(params) {
+    const { url, folder, acl = "private" } = params;
+    const res = await fetch(url);
+    if (!res.ok) throw new Error(`\u4E0B\u8F7D\u7F51\u7EDC\u6587\u4EF6\u5931\u8D25: ${res.status} ${res.statusText}`);
+    const arrayBuffer = await res.arrayBuffer();
+    const { fileName, fileSuffix } = parseFileNameAndSuffix(url);
+    const fileSize = arrayBuffer.byteLength;
+    const fileType = res.headers.get("Content-Type") || "application/octet-stream";
+    let md5Base64;
+    if (typeof window === "undefined") {
+      md5Base64 = import_crypto.default.createHash("md5").update(Buffer.from(arrayBuffer)).digest("base64");
+    } else {
+      const SparkMD5 = (await import("spark-md5")).default;
+      md5Base64 = SparkMD5.ArrayBuffer.hash(arrayBuffer, true);
+    }
+    const presignedInput = {
+      fileMd5Base64: md5Base64,
+      fileSuffix,
+      originalFileName: fileName,
+      fileSize,
+      acl
+    };
+    if (folder) presignedInput.folder = folder;
+    const presignedResult = await rateLimit("uploadPresignedUrl", "mutation", async () => {
+      const { query: query2, variables } = buildGraphQLUploadPresignedUrl(presignedInput);
+      const result = await execute({ query: query2, variables });
+      return result;
+    }, rateLimitConfig);
+    if (!presignedResult.uploadPresignedUrl) throw new Error("\u83B7\u53D6\u9884\u7B7E\u540D URL \u5931\u8D25");
+    const { uploadUrl, uploadHeaders, downloadUrl, resourceId, contentType, originalFileName } = presignedResult.uploadPresignedUrl;
+    const headers = {};
+    if (uploadHeaders) {
+      if (uploadHeaders.contentMD5) headers["Content-MD5"] = uploadHeaders.contentMD5;
+      if (uploadHeaders.contentType) headers["Content-Type"] = uploadHeaders.contentType;
+      if (uploadHeaders.date) headers["Date"] = uploadHeaders.date;
+    }
+    const uploadBody = typeof window === "undefined" ? Buffer.from(arrayBuffer) : new Blob([arrayBuffer]);
+    const uploadRes = await fetch(uploadUrl, { method: "PUT", body: uploadBody, headers });
+    if (!uploadRes.ok) throw new Error(`\u4E0A\u4F20\u5931\u8D25: ${uploadRes.status} ${uploadRes.statusText}`);
+    return {
+      id: resourceId,
+      originalFileName: originalFileName ?? fileName,
+      contentType: contentType ?? fileType,
+      fileSize,
+      url: downloadUrl ?? uploadUrl
+    };
+  },
+  /**
+   * 获取文件预览信息
+   */
+  async getFilePreview(resourceId) {
+    return rateLimit("getFilePreview", "query", async () => {
+      const { query: query2, variables } = buildGraphQLGetFilePreview(resourceId);
+      const result = await execute({ query: query2, variables });
+      return result;
+    }, rateLimitConfig);
+  }
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   auth,
@@ -4628,6 +4833,7 @@ var gql = {
   gql,
   initGraphQLClient,
   mutation,
+  oss,
   query,
   removeHeader,
   removeToken,