@pnt-team/pnt-component-frontend 0.0.91 → 0.0.95

package/lib/cjs/components/PntCosUploader/index.d.ts

@@ -0,0 +1,135 @@
+import { type CosScene, type GetCosCredentialParams, type NormalizeCredential, type NormalizedCosCredential } from "../../api/cos";
+import { usePntConfig } from "../../config";
+import type { AxiosInstance } from 'axios';
+/**
+ * 文件名生成策略
+ * @description 内置三种策略；如需自定义可传函数
+ * - uuid: UUID v4 + 原扩展名（默认，最简单）
+ * - md5: 文件内容 MD5 + 原扩展名（与 pnt-tools CosApi 原策略一致）
+ * - timestamp: 时间戳(36进制)+自增计数器 + 原扩展名（与 SDK 定制场景原策略一致）
+ */
+export type FileNameStrategy = 'uuid' | 'md5' | 'timestamp' | ((file: File) => string | Promise<string>);
+/**
+ * COS 上传配置
+ */
+export interface PntCosUploadOptions {
+    /**
+     * 业务场景，决定走哪个凭证接口
+     * @description 内置 4 个 scene，消费方可传 string 自定义并配合 getCredential 使用
+     */
+    scene: CosScene;
+    /**
+     * 业务类型路径 key
+     * @description 通用场景透传给后端 path map 选取对应业务路径；
+     * sdk_customize 场景作为受控目录（filePath）下的子目录继续拼接
+     */
+    pathKey?: string;
+    /**
+     * 业务上下文参数（gameId/env/updType 等）
+     * @description 按 scene 不同传递给后端；default/default_download 下 gameId 自动映射到 x-service-type 请求头
+     */
+    context?: Record<string, string | number>;
+    /**
+     * 网关 audience
+     * @default '/player-network'
+     * @description 账号管理等子系统需覆盖为对应 audience（如 '/laas-pnt'）
+     */
+    audience?: string;
+    /**
+     * 文件名生成策略
+     * @default 'uuid'
+     */
+    fileNameStrategy?: FileNameStrategy;
+    /**
+     * 是否走 CDN 域名拼接
+     * @description true 且凭证返回 cosHost 时用 cosHost + cosKey；否则用 COS putObject 返回的 Location
+     * @default true
+     */
+    useCdn?: boolean;
+    /**
+     * 自定义凭证获取函数（覆盖内置 scene 路由）
+     * @description 后端接口非内置 scene 时使用；返回归一化后的凭证
+     */
+    getCredential?: (http: ReturnType<typeof usePntConfig>['http'], params: GetCosCredentialParams) => Promise<NormalizedCosCredential>;
+    /**
+     * 自定义凭证响应归一化
+     * @description 后端字段不标准时使用；入参为内置 scene 接口返回的原始 data，需返回归一化凭证
+     */
+    normalizeCredential?: NormalizeCredential;
+}
+/**
+ * COS 上传结果
+ */
+export interface PntCosUploadResult {
+    /** 上传后的可访问 URL */
+    fileUrl: string;
+    /** COS 对象 Key */
+    cosKey: string;
+    /** 原始文件名 */
+    fileName: string;
+}
+/**
+ * 单次请求覆盖参数
+ * @description 上传/下载入口的 gameId/task_id/pathKey 常来自表单或表格行数据，
+ * 可通过该参数在单次调用覆盖 hook 初始化时的配置
+ */
+export interface PntCosRequestOverrides {
+    /** 覆盖业务上下文（与初始化 context 浅合并，如行级 gameId/task_id） */
+    context?: Record<string, string | number>;
+    /** 覆盖网关 audience */
+    audience?: string;
+    /** 覆盖凭证场景 */
+    scene?: CosScene;
+    /** 覆盖业务路径 key */
+    pathKey?: string;
+}
+/**
+ * COS 上传器实例
+ */
+export interface PntCosUploader {
+    /**
+     * 上传文件到 COS
+     * @param file 原始文件
+     * @param onProgress 上传进度回调（0~100）
+     * @param overrides 单次调用覆盖配置（表单/行级 gameId 等）
+     */
+    upload: (file: File, onProgress?: (percent: number) => void, overrides?: PntCosRequestOverrides) => Promise<PntCosUploadResult>;
+    /**
+     * 获取文件预签名下载 URL（临时）
+     * @param cosKey COS 对象 Key，或完整 URL（自动剥离域名）
+     * @param overrides 单次调用覆盖配置（行级 gameId/task_id 等）
+     */
+    getDownloadUrl: (cosKey: string, overrides?: PntCosRequestOverrides) => Promise<string>;
+}
+export type { CosScene, GetCosCredentialParams, NormalizeCredential, NormalizedCosCredential, };
+export { normalizeSnakeCredential } from "../../api/cos";
+/**
+ * 创建 COS 直传器实例（不依赖 React）
+ * @description 与 usePntCosUploader 共用同一套核心逻辑，适用于 class 兼容层、
+ * 工具函数、非 React 入口等场景；React 组件请优先使用 usePntCosUploader
+ *
+ * @param http 消费方 axios 实例（约定响应拦截器已解包 response.data）
+ * @param options 上传配置（固定值），或返回配置的 getter（需要动态配置时使用）
+ *
+ * @example
+ * ```ts
+ * const uploader = createPntCosUploader(http, { scene: 'default', pathKey: 'marketing_icon' });
+ * const { fileUrl } = await uploader.upload(file);
+ * ```
+ */
+export declare const createPntCosUploader: (http: AxiosInstance, options: PntCosUploadOptions | (() => PntCosUploadOptions)) => PntCosUploader;
+/**
+ * COS 直传 Service Hook
+ * @description 内置凭证获取 + COS SDK 初始化 + 文件名策略 + URL 拼接，
+ * 收敛各项目重复的 4 份自实现；http 实例由 PntProvider 注入
+ *
+ * @param options 上传配置
+ *
+ * @example
+ * ```ts
+ * const uploader = usePntCosUploader({ scene: 'default', pathKey: 'marketing_icon' });
+ * const { fileUrl, cosKey } = await uploader.upload(file, (p) => setProgress(p));
+ * ```
+ */
+export declare const usePntCosUploader: (options: PntCosUploadOptions) => PntCosUploader;
+export default usePntCosUploader;

package/lib/cjs/components/PntCosUploader/index.js

@@ -0,0 +1,209 @@
+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 __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/components/PntCosUploader/index.ts
+var PntCosUploader_exports = {};
+__export(PntCosUploader_exports, {
+  createPntCosUploader: () => createPntCosUploader,
+  default: () => PntCosUploader_default,
+  normalizeSnakeCredential: () => import_cos2.normalizeSnakeCredential,
+  usePntCosUploader: () => usePntCosUploader
+});
+module.exports = __toCommonJS(PntCosUploader_exports);
+var import_cos = require("../../api/cos");
+var import_config = require("../../config");
+var import_cos_js_sdk_v5 = __toESM(require("cos-js-sdk-v5"));
+var import_crypto_js = __toESM(require("crypto-js"));
+var import_react = require("react");
+var import_uuid = require("uuid");
+var import_cos2 = require("../../api/cos");
+var trimSlash = (seg, leading = true) => seg.replace(/\/$/, "").replace(leading ? /^\// : "", "");
+var getFileExt = (filename) => {
+  const idx = filename.lastIndexOf(".");
+  return idx > -1 ? filename.slice(idx) : "";
+};
+var _timestampCounter = 0;
+var generateTimestampName = () => `${Date.now().toString(36)}${(_timestampCounter++).toString(36)}`;
+var computeFileMd5 = async (file) => {
+  const buffer = await file.arrayBuffer();
+  return import_crypto_js.default.MD5(import_crypto_js.default.lib.WordArray.create(buffer)).toString();
+};
+var generateFileName = async (file, strategy) => {
+  if (typeof strategy === "function") {
+    return strategy(file);
+  }
+  const ext = getFileExt(file.name);
+  switch (strategy) {
+    case "md5": {
+      const md5 = await computeFileMd5(file);
+      return `${md5}${ext}`;
+    }
+    case "timestamp":
+      return `${generateTimestampName()}${ext}`;
+    case "uuid":
+    default:
+      return `${(0, import_uuid.v4)()}${ext}`;
+  }
+};
+var resolveBasePath = (cred, pathKey) => {
+  if (cred.filePath) {
+    const prefix = cred.filePath.replace(/\/$/, "");
+    return pathKey ? `${prefix}/${trimSlash(pathKey)}` : prefix;
+  }
+  if (pathKey && cred.path) {
+    return cred.path[pathKey] || "";
+  }
+  return "";
+};
+var stripHost = (key) => key.replace(/^https?:\/\/[^/]+/, "");
+var createCosClient = (cred) => new import_cos_js_sdk_v5.default({
+  getAuthorization: (_, callback) => {
+    callback({
+      TmpSecretId: cred.secretId,
+      TmpSecretKey: cred.secretKey,
+      SecurityToken: cred.sessionToken,
+      StartTime: cred.startTime,
+      ExpiredTime: cred.expiredTime
+    });
+  },
+  Protocol: "https:",
+  FileParallelLimit: 3,
+  ChunkParallelLimit: 3,
+  ChunkSize: 1024 * 1024,
+  ProgressInterval: 1
+});
+var createPntCosUploader = (http, options) => {
+  const getOptions = () => typeof options === "function" ? options() : options;
+  const upload = async (file, onProgress, overrides) => {
+    var _a, _b, _c;
+    const opts = getOptions();
+    const {
+      scene,
+      pathKey,
+      context,
+      audience,
+      fileNameStrategy = "uuid",
+      useCdn = true,
+      getCredential,
+      normalizeCredential
+    } = opts;
+    const mergedContext = { ...context, ...overrides == null ? void 0 : overrides.context };
+    const mergedScene = (_a = overrides == null ? void 0 : overrides.scene) != null ? _a : scene;
+    const mergedAudience = (_b = overrides == null ? void 0 : overrides.audience) != null ? _b : audience;
+    const mergedPathKey = (_c = overrides == null ? void 0 : overrides.pathKey) != null ? _c : pathKey;
+    const credParams = {
+      scene: mergedScene,
+      pathKey: mergedPathKey,
+      context: mergedContext,
+      audience: mergedAudience,
+      contentLength: file.size
+    };
+    const cred = getCredential ? await getCredential(http, credParams) : await (0, import_cos.fetchCosCredential)(http, credParams, normalizeCredential);
+    const basePath = resolveBasePath(cred, mergedPathKey);
+    const fileName = await generateFileName(file, fileNameStrategy);
+    const cosKey = basePath ? `${basePath.replace(/\/$/, "")}/${fileName}` : fileName;
+    const cos = createCosClient(cred);
+    return new Promise((resolve, reject) => {
+      cos.putObject(
+        {
+          Bucket: cred.bucket,
+          Region: cred.region,
+          Key: cosKey,
+          Body: file,
+          onProgress: onProgress ? (progressData) => {
+            onProgress(Math.round(progressData.percent * 100));
+          } : void 0
+        },
+        (err, data) => {
+          if (err) {
+            reject(err);
+            return;
+          }
+          const fileUrl = useCdn && cred.cosHost ? `${cred.cosHost.replace(/\/$/, "")}/${cosKey}` : `https://${data.Location}`;
+          resolve({
+            fileUrl,
+            cosKey,
+            fileName: file.name
+          });
+        }
+      );
+    });
+  };
+  const getDownloadUrl = async (cosKey, overrides) => {
+    var _a, _b, _c;
+    const opts = getOptions();
+    const { scene, pathKey, context, audience, getCredential } = opts;
+    const mergedContext = { ...context, ...overrides == null ? void 0 : overrides.context };
+    const mergedScene = (_a = overrides == null ? void 0 : overrides.scene) != null ? _a : scene;
+    const mergedAudience = (_b = overrides == null ? void 0 : overrides.audience) != null ? _b : audience;
+    const mergedPathKey = (_c = overrides == null ? void 0 : overrides.pathKey) != null ? _c : pathKey;
+    const credParams = {
+      scene: getCredential ? mergedScene : mergedScene === "sdk_customize" ? mergedScene : "default_download",
+      pathKey: mergedPathKey,
+      context: mergedContext,
+      audience: mergedAudience,
+      fileUrl: cosKey
+    };
+    const cred = getCredential ? await getCredential(http, credParams) : await (0, import_cos.fetchCosCredential)(http, credParams);
+    const cos = createCosClient(cred);
+    return new Promise((resolve, reject) => {
+      cos.getObjectUrl(
+        {
+          Bucket: cred.bucket,
+          Region: cred.region,
+          Key: stripHost(cosKey),
+          Sign: true
+        },
+        (err, data) => {
+          if (err) {
+            reject(err);
+            return;
+          }
+          resolve(data.Url);
+        }
+      );
+    });
+  };
+  return { upload, getDownloadUrl };
+};
+var usePntCosUploader = (options) => {
+  const { http } = (0, import_config.usePntConfig)();
+  const optionsRef = (0, import_react.useRef)(options);
+  optionsRef.current = options;
+  return (0, import_react.useMemo)(
+    () => createPntCosUploader(http, () => optionsRef.current),
+    [http]
+  );
+};
+var PntCosUploader_default = usePntCosUploader;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createPntCosUploader,
+  normalizeSnakeCredential,
+  usePntCosUploader
+});

package/lib/cjs/components/PntImage/index.d.ts

@@ -28,9 +28,15 @@ export interface PntImageProps {
      * @description src 为空时展示的占位图；不传则使用内置的 uploadImg
      */
     defaultImg?: string;
+    /**
+     * 快捷尺寸（正方形）
+     * @description 预设尺寸：`small`=36px、`medium`=60px、`large`=136px；默认 `large`
+     * 若 `style` 中显式指定了 width/height，则以 style 为准；非正方形场景请使用 `style`
+     */
+    size?: 'small' | 'medium' | 'large';
     /**
      * 自定义样式
-     * @description 一般用于控制图片宽高
+     * @description 一般用于控制图片宽高；其中 width/height 优先级高于 size
      */
     style?: React.CSSProperties;
     /**
@@ -69,14 +75,14 @@ export interface PntImageProps {
  *   loading={loading}
  *   defaultImg={defaultImg}
  *   onRemove={handleRemove}
- *   style={{ width: 136, height: 136 }}
+ *   size="large"
  * />
  *
  * // 纯预览模式
  * <PntImage
  *   src={url}
  *   alt="avatar"
- *   style={{ width: 60, height: 60 }}
+ *   size="medium"
  *   container={container}
  * />
  * ```

package/lib/cjs/components/PntImage/index.js

@@ -46,6 +46,7 @@ var PntImage = ({
   src,
   alt = "",
   defaultImg,
+  size,
   style,
   loading = false,
   onRemove,
@@ -54,6 +55,13 @@ var PntImage = ({
 }) => {
   const isUploadMode = typeof onRemove === "function";
   const finalSrc = (src == null ? void 0 : src.length) ? src : defaultImg || import_uploadImg.default;
+  const SIZE_MAP = { small: 36, medium: 60, large: 136 };
+  const sizeValue = SIZE_MAP[size != null ? size : "large"];
+  const sizeStyle = {
+    width: `${sizeValue}px`,
+    height: `${sizeValue}px`
+  };
+  const mergedStyle = { ...sizeStyle, ...style };
   const attach = container ? typeof container === "function" ? container : () => container : void 0;
   const finalTexts = { ...DEFAULT_TEXTS, ...texts };
   const UploadLoadingContent = (isImageLoading) => /* @__PURE__ */ (0, import_jsx_runtime.jsx)(
@@ -125,7 +133,7 @@ var PntImage = ({
                 overlayTrigger: "hover",
                 fit: "contain",
                 className: "pnt-image",
-                style
+                style: mergedStyle
               }
             );
           }

package/lib/cjs/components/PntSecureBox/index.js

@@ -28,12 +28,15 @@ var import_index = require("./index.scss");
 var import_jsx_runtime = require("react/jsx-runtime");
 var PntSecureBox = (prop) => {
   const { dataKey, dataValue, env, gameId, renderDom, viewText, pageId } = prop;
-  const { securityData, requestSecurityData } = (0, import_useHighSecurity.useHighSecurity)();
+  const { securityData, isUnlocked, requestSecurityData } = (0, import_useHighSecurity.useHighSecurity)({
+    gameId,
+    env
+  });
+  const isSecurity = (0, import_utils.isSecurityData)(dataValue);
+  const unlocked = isSecurity && isUnlocked(dataKey);
   return /* @__PURE__ */ (0, import_jsx_runtime.jsx)("div", { className: "pnt-secure-box", children: /* @__PURE__ */ (0, import_jsx_runtime.jsxs)(import_jsx_runtime.Fragment, { children: [
-    renderDom(
-      (0, import_utils.isSecurityData)(dataValue) ? securityData[dataKey] || "******" : dataValue
-    ),
-    (0, import_utils.isSecurityData)(dataValue) && !securityData.hasOwnProperty(dataKey) && /* @__PURE__ */ (0, import_jsx_runtime.jsx)(
+    renderDom(unlocked ? securityData[dataKey] || "******" : isSecurity ? "******" : dataValue),
+    isSecurity && !isUnlocked(dataKey) && /* @__PURE__ */ (0, import_jsx_runtime.jsx)(
       "span",
       {
         className: "view-icon",

package/lib/cjs/components/PntUpload/index.d.ts

@@ -0,0 +1,149 @@
+import type { CosScene } from "../../api/cos";
+import type { FileNameStrategy, PntCosUploadOptions } from "../PntCosUploader";
+import React, { FC } from 'react';
+import './index.scss';
+/**
+ * PntUpload 文案集合
+ * @description 所有内部展示文案均可通过 texts prop 自定义，用于多语言场景
+ */
+export interface PntUploadTexts {
+    /** 上传中文案 */
+    uploading?: string;
+    /** 上传失败文案 */
+    uploadFailed?: string;
+    /** 文件大小超出限制文案 */
+    sizeInvalid?: string;
+    /** 文件类型不支持文案 */
+    typeInvalid?: string;
+    /** 选择文件文案（无文件时） */
+    selectFile?: string;
+    /** 重新选择文案（已有文件时，非图片模式） */
+    reselect?: string;
+}
+/**
+ * 校验/上传失败阶段
+ */
+export type PntUploadErrorPhase = 'validate' | 'upload';
+export interface PntUploadProps {
+    /**
+     * 当前已上传文件 URL（受控）
+     */
+    value?: string;
+    /**
+     * 上传成功回调
+     * @param fileUrl 上传后的可访问 URL
+     * @param cosKey COS 对象 Key
+     * @param file 原始文件
+     */
+    onChange?: (fileUrl: string, cosKey: string, file: File) => void;
+    /**
+     * 删除回调
+     * @description 由消费方清空 value
+     */
+    onRemove?: () => void;
+    /**
+     * 异常回调（校验失败 / 上传失败）
+     * @param err 错误对象（校验失败时 message 为对应文案）
+     * @param phase 失败阶段：validate=本地校验，upload=凭证获取或 COS 上传
+     * @param file 原始文件
+     */
+    onError?: (err: Error, phase: PntUploadErrorPhase, file: File) => void;
+    /**
+     * 业务场景（透传给 PntCosUploader）
+     */
+    scene: CosScene;
+    /**
+     * 业务类型路径 key（透传给 PntCosUploader）
+     */
+    pathKey?: string;
+    /**
+     * 业务上下文（透传给 PntCosUploader）
+     */
+    context?: Record<string, string | number>;
+    /**
+     * 网关 audience（透传给 PntCosUploader）
+     * @default '/player-network'
+     */
+    audience?: string;
+    /**
+     * 文件类型限制
+     * @description 支持 MIME（'image/png'）、通配（'image/*'）、扩展名（'.zip'），可传数组
+     */
+    accept?: string | string[];
+    /**
+     * 文件大小限制（字节）
+     */
+    sizeLimit?: number;
+    /**
+     * 是否为图片预览模式
+     * @description true 使用 PntImage 预览；false 使用文件名 + 选择区域
+     * @default true
+     */
+    imagePreview?: boolean;
+    /**
+     * 图片预览区样式（imagePreview=true 生效，一般控制宽高）
+     */
+    previewStyle?: React.CSSProperties;
+    /**
+     * 默认占位图（imagePreview=true 生效）
+     */
+    defaultImg?: string;
+    /**
+     * 文件名生成策略（透传给 PntCosUploader）
+     * @default 'uuid'
+     */
+    fileNameStrategy?: FileNameStrategy;
+    /**
+     * 是否走 CDN 域名拼接（透传给 PntCosUploader）
+     * @default true
+     */
+    useCdn?: boolean;
+    /**
+     * 自定义凭证获取函数（透传给 PntCosUploader）
+     */
+    getCredential?: PntCosUploadOptions['getCredential'];
+    /**
+     * 自定义凭证响应归一化（透传给 PntCosUploader）
+     */
+    normalizeCredential?: PntCosUploadOptions['normalizeCredential'];
+    /**
+     * 多语言文案
+     * @description 传入即覆盖默认中文文案；仅对应字段会覆盖，未传字段仍用默认值
+     */
+    texts?: PntUploadTexts;
+    /**
+     * 禁用上传与删除
+     * @default false
+     */
+    disabled?: boolean;
+    /**
+     * 自定义样式
+     */
+    style?: React.CSSProperties;
+    /**
+     * 自定义类名
+     */
+    className?: string;
+}
+/**
+ * PntUpload 业务上传组件
+ * @description 基于 TDesign Upload + PntImage + usePntCosUploader，
+ * 内置 COS 凭证获取、直传、进度、校验、错误处理；支持图片预览 / 文件两种模式
+ *
+ * @example
+ * ```tsx
+ * <PntUpload
+ *   scene="default"
+ *   pathKey="marketing_icon"
+ *   context={{ gameId }}
+ *   accept="image/png"
+ *   sizeLimit={500 * 1024}
+ *   imagePreview
+ *   value={iconUrl}
+ *   onChange={(url) => setIconUrl(url)}
+ *   onRemove={() => setIconUrl('')}
+ * />
+ * ```
+ */
+declare const PntUpload: FC<PntUploadProps>;
+export default PntUpload;