module-develop-kit 0.3.0 → 0.3.1

package/dist/index.d.ts

@@ -1,3 +1,31 @@
+import { default as default_2 } from 'crypto-js';
+
+/**
+ * 使用AES算法对字符串进行解密。
+ * 该函数接收一个密钥、待解密的字符串或CipherParams对象以及初始化向量（IV），并返回解密后的字符串。
+ * 解密过程使用CBC模式和Pkcs7填充方式。
+ * 待解密的字符串或CipherParams对象将通过CryptoJS库处理。
+ * 初始化向量会被解析为UTF-8格式以确保正确解密。
+ *
+ * @param {string} key - AES解密所需的密钥，作为字符串提供。
+ * @param {string | CryptoJS.lib.CipherParams} str - 待解密的字符串或CipherParams对象。
+ * @param {string} iv - 初始化向量，用于AES解密，作为字符串提供。
+ * @returns {string} 返回解密后的字符串，结果将以UTF-8编码格式呈现。
+ */
+export declare const aesDecryptString: (key: string, str: string | default_2.lib.CipherParams, iv: string) => string;
+
+/**
+ * 使用AES加密算法对字符串或WordArray进行加密。
+ * 该函数基于CryptoJS库实现，采用CBC模式和Pkcs7填充方式。
+ * 加密时需要提供密钥、待加密的数据以及初始化向量（IV）。
+ *
+ * @param {string} key - 用于加密的密钥，必须为字符串类型。
+ * @param {string | CryptoJS.lib.WordArray} str - 待加密的字符串或WordArray对象。
+ * @param {string} iv - 初始化向量，必须为字符串类型，用于增强加密的安全性。
+ * @returns {string} 返回加密后的字符串，结果为Base64编码格式。
+ */
+export declare const aesEncryptString: (key: string, str: string | default_2.lib.WordArray, iv: string) => string;
+
 /**
  * 创建带有签名信息的请求头对象。
  * 该方法根据传入的参数生成时间戳、随机数和签名，并将它们添加到自定义请求头中。
@@ -10,6 +38,15 @@ export declare function createHeaders({ uid, salt, ts, data, ...headers }: ICrea
     "X-Sign-Client": string;
 };
 
+/**
+ * 生成指定长度的随机字符串。
+ * 该函数通过从包含大小写字母和数字的字符集合中随机选取字符，拼接成所需长度的字符串。
+ * 参数 length 必须为正整数，表示生成的随机字符串的长度。
+ * 返回值是一个由大小写字母和数字组成的随机字符串。
+ * 如果传入的 length 小于等于 0，则返回的字符串可能为空。
+ */
+export declare const generateRandomString: (length: number) => string;
+
 /**
  * 安全的解析html内容 防止xss攻击
  * @param input 输入的html内容
@@ -39,6 +76,36 @@ declare interface ICreateHeaders {
     [key: string]: TData;
 }
 
+declare interface ISm4Params {
+    /**
+     * 解密向量
+     */
+    iv: string;
+    /**
+     * 解密密钥
+     */
+    key: string;
+    /**
+     * 解密模式
+     * @default cbc
+     */
+    mode?: "cbc" | "ecb";
+}
+
+/**
+ * SM4解密
+ * @param data 解密数据
+ * @param params 解密参数
+ */
+export declare const sm4Decrypt: (data: string, params: ISm4Params) => string;
+
+/**
+ * SM4加密
+ * @param data 加密数据
+ * @param params 加密参数
+ */
+export declare const sm4Encrypt: (data: string, params: ISm4Params) => string;
+
 declare type TData = _TData | _TData[];
 
 declare type _TData = null | undefined | number | string | Record<string, any>;