module-develop-kit 0.3.3 → 0.4.0

package/dist/index.d.ts

@@ -1,4 +1,6 @@
 import { default as default_2 } from 'crypto-js';
+import { Plugin as Plugin_2 } from 'vite';
+import { Ref } from 'vue';
 
 /**
  * 使用AES算法对字符串进行解密。
@@ -26,6 +28,15 @@ export declare const aesDecryptString: (key: string, str: string | default_2.lib
  */
 export declare const aesEncryptString: (key: string, str: string | default_2.lib.WordArray, iv: string) => string;
 
+/**
+ * 用于格式化输出会话过程中的日志信息
+ */
+export declare const CallLogger: {
+    log(message: any, ...args: any[]): void;
+    warn(message: any, ...args: any[]): void;
+    error(message: any, ...args: any[]): void;
+};
+
 /**
  * 创建带有签名信息的请求头对象。
  * 该方法根据传入的参数生成时间戳、随机数和签名，并将它们添加到自定义请求头中。
@@ -38,6 +49,41 @@ export declare function createHeaders({ uid, salt, ts, data, ...headers }: ICrea
     "X-Sign-Client": string;
 };
 
+export declare enum ECallStatus {
+    /**
+     * 正在接听中
+     */
+    PENDING = "pending",
+    /**
+     * 已接听
+     */
+    ANSWERED = "answered",
+    /**
+     * 呼叫失败
+     */
+    FAILED = "failed",
+    /**
+     * 结束通话
+     */
+    ENDED = "ended",
+    /**
+     * 初始状态
+     */
+    INITIAL = "initial",
+    /**
+     * 用户取消通话
+     */
+    CANCELLED = "cancelled",
+    /**
+     * 说明ws链接失败，需要重新连接，会重新初始化状态
+     */
+    RECONNECT = "reconnect"
+}
+
+export declare const EMIT_EVENT_NAME: {
+    UPDATE_STATUS: string;
+};
+
 /**
  * 生成指定长度的随机字符串。
  * 该函数通过从包含大小写字母和数字的字符集合中随机选取字符，拼接成所需长度的字符串。
@@ -53,6 +99,51 @@ export declare const generateRandomString: (length: number) => string;
  */
 export declare function htmlSanitize(input: string): string;
 
+/**
+ * jssip、音频播放相关配置信息
+ */
+declare interface ICallConfig extends SipAccount {
+    /**
+     *  WebSocket安全协议地址
+     */
+    wssUrl: string;
+    /**
+     *  SIP服务器IP地址
+     */
+    sipIp: string;
+    /**
+     * 音频播放器DOM元素ID
+     */
+    playAudioId: string;
+    /**
+     * 播放提示音的链接。默认为 https://store.zxfqf.com/file/uMgvB0wt9f.mp3
+     */
+    tipAudioUrl?: string;
+    /**
+     * ice地址
+     */
+    iceService: string;
+    /**
+     * 是否开发环境
+     */
+    isDev?: boolean;
+    /**
+     * 用与加在请求头上的参数
+     */
+    callId: string;
+    /**
+     * realm
+     */
+    realm: string;
+}
+
+/**
+ * 用于拨打电话的相关信息
+ */
+declare interface ICallOptions {
+    call: string;
+}
+
 declare interface ICreateHeaders {
     /**
      * 用户唯一标识符，用于参与签名的生成
@@ -92,6 +183,61 @@ declare interface ISm4Params {
     mode?: "cbc" | "ecb";
 }
 
+/**
+ * sip code对应的的状态，优先处理 code 对应的提示文案，如果不存在则按照 causes 状态去处理
+ */
+export declare const SIP_CODE_MESSAGE: {
+    /**
+     * 黑名单或者不存在
+     */
+    "404": string;
+    /**
+     * 拒接
+     */
+    "500": string;
+    /**
+     * 拒接
+     */
+    "607": string;
+};
+
+/**
+ * jssip 中的 causes 对应的错误信息（只有部分需要提示的code）
+ */
+export declare const SIP_ERROR_CAUSES: {
+    "Authentication Error": string;
+    "Connection Error": string;
+    "Request Timeout": string;
+    "SIP Failure Code": string;
+    "WebRTC Error": string;
+    Busy: string;
+    Rejected: string;
+    Redirected: string;
+    Unavailable: string;
+    "Not Found": string;
+    "Incompatible SDP": string;
+    "Missing SDP": string;
+    Canceled: string;
+    "No Answer": string;
+    Expires: string;
+    "User Denied Media Access": string;
+    "RTP Timeout": string;
+};
+
+/**
+ * sip 账号相关信息
+ */
+declare interface SipAccount {
+    /**
+     *  分机号码（支持字符串形式的数字编号）
+     */
+    extension: string;
+    /**
+     *  SIP认证密码
+     */
+    password: string;
+}
+
 /**
  * SM4解密
  * @param data 解密数据
@@ -134,4 +280,21 @@ export declare function transmissionDataEncryption(key: string, _data?: TData, t
     };
 };
 
+/**
+ * 打电话
+ * FIXME： callBack 为什么存在？zyy 中通过 useCall 拿到的变量无法实现响应式，所以通过 callback 的方式更新外部依赖。
+ * @param callBack
+ */
+export declare const useCall: (callBack?: (status: ECallStatus, callStatusText: string, cause: string) => void) => {
+    call: (options: ICallOptions, config: ICallConfig) => void;
+    hangUp: () => void;
+    callStatus: Ref<ECallStatus, ECallStatus>;
+    callStatusText: Ref<string, string>;
+    destroy: () => void;
+    extension: Ref<string, string>;
+    getErrorMessage: () => any;
+};
+
+export declare const vitePluginCompatibilityDetection: () => Plugin_2;
+
 export { }