module-develop-kit 0.1.1 → 0.2.0

package/dist/index.d.ts

@@ -1,33 +1,65 @@
+/**
+ * 创建带有签名信息的请求头对象。
+ * 该方法根据传入的参数生成时间戳、随机数和签名，并将它们添加到自定义请求头中。
+ *
+ * @return  包含签名信息和自定义请求头的完整请求头对象。
+ */
+export declare function createHeaders({ uid, salt, ts, data, ...headers }: ICreateHeaders): {
+    "X-Sign-Timestamp": string;
+    "X-Sign-Nonce": string;
+    "X-Sign-Client": string;
+};
+
 /**
  * 安全的解析html内容 防止xss攻击
  * @param input 输入的html内容
  */
 export declare function htmlSanitize(input: string): string;
 
+declare interface ICreateHeaders {
+    /**
+     * 用户唯一标识符，用于参与签名的生成
+     */
+    uid: string;
+    /**
+     * 加密盐值，用于增强签名的安全性
+     */
+    salt: string;
+    /**
+     * 时间戳偏移量，用于调整当前时间戳的值
+     */
+    ts: number;
+    /**
+     * 待传输的数据对象，非必填
+     */
+    data?: TData;
+    /**
+     * 其他header的内容
+     */
+    [key: string]: TData;
+}
+
 declare type TData = _TData | _TData[];
 
 declare type _TData = null | undefined | number | string | Record<string, any>;
 
 /**
- * 对传输数据进行加密处理并生成相应的签名信息。
+ * 对传输数据进行加密处理，生成包含加密数据和相关头部信息的对象。
+ * 该方法使用AES加密算法对数据进行加密，并生成随机初始化向量（IV）。
  *
- * @param uid 用户唯一标识符，用于参与签名的生成。
- * @param salt 加密盐值，用于增强签名的安全性。
- * @param _ts 时间戳偏移量，用于调整当前时间戳的值。
- * @param data 待传输的数据对象，默认为空对象。
- *
- * @return 包含签名信息的对象，包括时间戳、随机数和客户端签名，用于请求头设置。
+ * @param key 加密所需的密钥字符串，用于AES加密算法。
+ * @param data 待加密的数据，可以是任意类型，若未提供则默认为空对象。
+ * @return 返回一个对象，包含加密后的数据和相关的HTTP头部信息。
+ *         其中，headers包含初始化向量（iv）和内容类型（Content-Type），
+ *         data包含加密后的数据主体。
  */
-export declare function transmissionDataEncryption({ uid, salt, ts, data, }: {
-    uid: string;
-    salt: string;
-    ts: number;
-    data: TData;
-}): {
+export declare function transmissionDataEncryption(key: string, data?: TData): {
     headers: {
-        "X-Sign-Timestamp": string;
-        "X-Sign-Nonce": string;
-        "X-Sign-Client": string;
+        iv: string;
+        "Content-Type": string;
+    };
+    data: {
+        body: string;
     };
 };