@ray-js/wechat-mqtt 0.0.14 → 0.0.15-beta-2

package/src/index.d.ts

@@ -1,50 +1,9 @@
-declare enum CONNECT_STATE {
-    CONNECT_BREAK = 0,
-    CONNECTED = 1,
-    CONNECTING = 2
-}
-export interface ConnectOptions {
-    clientId: string;
-    username: string;
-    password: string;
-    subscribeTopics: string;
-    keepalive: number;
-    url: string;
-}
-export interface MessageData {
-    topic: string;
-    payload: {
-        data: {
-            bizCode?: string;
-            devId: string;
-            status?: Record<string, any>;
-            bizData?: Record<string, any>;
-        };
-        protocol: number;
-        pv: string;
-    };
-}
-export declare type MQTTEventType = 'connect' | 'message' | 'packetsend' | 'packetreceive' | 'error' | 'close' | 'offline' | 'disconnect' | 'end';
+import { Options, Client } from './lib/interface';
+import './lib/adapter';
+export * from './lib/interface';
 /**
- * 连接 mqtt
- */
-declare const connect: (needReopen?: boolean) => Promise<void>;
-/**
- * 销毁连接
- * @param client
- */
-declare const destroy: () => void;
-/**
- * 消息监听
- * @param cb
- */
-declare const onMessage: (cb: (data: MessageData) => void) => void;
-declare const offMessage: (cb: (data: MessageData) => void) => void;
-declare const onStateChange: (cb: (data: CONNECT_STATE) => void) => void;
-declare const offStateChange: (cb: (data: CONNECT_STATE) => void) => void;
-/**
- * 获取连接状态
+ * 创建一个MQTT实例
+ * @param options
  * @returns
  */
-declare const getState: () => boolean;
-export { onMessage, offMessage, destroy, connect, getState, onStateChange, offStateChange };
+export declare const createMQTT: (options: Options) => Promise<Client>;

package/src/lib/adapter/index.d.ts

@@ -0,0 +1,2 @@
+import './blowser';
+import './wechat';

package/src/lib/auth.d.ts

@@ -0,0 +1,5 @@
+import { ClientConntroller, AuthOptions } from "./interface";
+/**
+ * 取消订阅
+ */
+export declare const auth: (client: ClientConntroller, options: AuthOptions) => void;

package/src/lib/connect.d.ts

@@ -1,7 +1,7 @@
-import { Client, Options } from "./interface";
+import { ClientConntroller, Options } from "./interface";
 /**
  * mqtt 连接
  * @param client
  * @param options
  */
-export declare const connect: (client: Client, options: Options) => Promise<unknown>;
+export declare const connect: (client: ClientConntroller, options: Options) => Promise<unknown>;

package/src/lib/disconnect.d.ts

@@ -1,7 +1,7 @@
-import { Client, DisconnectOptions } from "./interface";
+import { ClientConntroller, DisconnectOptions } from "./interface";
 /**
  * mqtt 连接
  * @param client
  * @param options
  */
-export declare const disconnect: (client: Client, options: DisconnectOptions) => Promise<void>;
+export declare const disconnect: (client: ClientConntroller, options: DisconnectOptions) => Promise<void>;

package/src/lib/factory.d.ts

@@ -1,6 +1,6 @@
-import { Adapter, Client, Options } from "./interface";
+import { Adapter, ClientConntroller, Options } from "./interface";
 declare type Judge = () => boolean;
-declare type Connect = (url: string) => Adapter;
+declare type Connect = (url: string, version?: number) => Promise<Adapter>;
 /**
  * 添加 Websocket 适配器
  * 用于适配不同平台下 WebSocket
@@ -13,5 +13,5 @@ export declare const addAdapter: (judge: Judge, creater: Connect, priority?: boo
  * 创建适配器
  * @returns
  */
-export declare const createClient: (options: Options) => Promise<Client>;
+export declare const createClient: (options: Options) => Promise<ClientConntroller>;
 export {};

package/src/lib/interface.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 export interface Adapter {
     /**
      * 关闭连接
@@ -17,7 +16,9 @@ export interface Adapter {
     /**
      * 接收到消息监听
      */
-    onMessage(cb: (data: ArrayBuffer) => void): void;
+    onMessage(cb: (res: {
+        data: ArrayBuffer;
+    }) => void): void;
     /**
      * 网络连接成功
      * @param cb
@@ -29,9 +30,47 @@ export interface Adapter {
      */
     onError(cb: (ev: any) => void): void;
 }
-export interface Client extends Adapter {
+export interface MQTTMessage {
+    topic: string;
+    payload: Uint8Array;
+}
+export interface ClientConntroller {
+    /**
+     * 配置
+     */
+    options: Options;
+    /**
+     * 协议版本
+     */
     protocolVersion: number;
+    /**
+     * 服务端是否保存了会话
+     * 值为0|1
+     */
+    sessionPresent: number;
+    connect(isReconnect?: boolean): Promise<any>;
     isClose(): boolean;
+    isOnline(): boolean;
+    getStatus(): 0 | 1 | 2;
+    /**
+    * 关闭连接
+    */
+    close: () => void;
+    /**
+     * 监听连接关闭
+     * @param cb
+     */
+    onClose(cb: (ev: any) => void): void;
+    /**
+     * 发送消息
+     * @param data
+     */
+    send(data: ArrayBuffer | ArrayBufferView): void;
+    /**
+     * 连接出错
+     * @param cb
+     */
+    onError(cb: (ev: any) => void): void;
     /**
      * 接收到消息监听
      */
@@ -39,6 +78,34 @@ export interface Client extends Adapter {
     offMessage(cb: (data: Uint8Array) => void): void;
     offClose(cb: (ev: any) => void): void;
     offError(cb: (ev: any) => void): void;
+    emitError(data: any): void;
+    /**
+     * mqtt 收到消息触发
+     * @param cb
+     */
+    emitMqttMessage(data: MQTTMessage): void;
+    /**
+     * 注册 mqtt 收到消息事件
+     * @param cb
+     */
+    onMqttMessage(cb: (data: MQTTMessage) => void): void;
+    /**
+    * 移除 mqtt 收到消息事件
+    * @param cb
+    */
+    offMqttMessage(cb: (data: MQTTMessage) => void): void;
+    /**
+     * topic 别名处理
+     */
+    applyTopic: (topicAlias: number, topicName: string) => void;
+    /**
+     * 通过别名获取 Topic
+     */
+    getTopic: (topicAlias: number) => string;
+    /**
+     * 验证主题正确性
+     */
+    checkTopic: (topicName: string) => boolean;
 }
 export declare type QoS = 0 | 1 | 2;
 export declare type UserProperties = Record<string, string | string[]>;
@@ -70,7 +137,7 @@ export interface Options {
     /**
      * 待订阅主题
      */
-    subscribeTopics?: string | string[];
+    subscribeTopics: string | string[];
     /**
      * 是否为新会话
      */
@@ -101,7 +168,7 @@ export interface Options {
             sessionExpiryInterval?: number;
             contentType?: string;
             responseTopic?: string;
-            correlationData?: Buffer;
+            correlationData?: Uint8Array;
             userProperties?: UserProperties;
         };
     };
@@ -117,23 +184,50 @@ export interface Options {
         requestProblemInformation?: boolean;
         userProperties?: UserProperties;
         authenticationMethod?: string;
-        authenticationData?: Buffer;
+        authenticationData?: Uint8Array;
     };
     /**
      *
      * 连接超时时间
      * 单位秒，默认 10 秒
      */
-    connectTimeout: number;
+    connectTimeout?: number;
+    /**
+     * 认证处理方法
+     * 在收到auth报文时触发
+     */
+    onAuth?: (options: AuthOptions) => AuthOptions;
+    /**
+     * 当接收到消息且 qos 为 1 时的处理函数
+     * 如果不定义，则默认返回原因码 0
+     */
+    onPuback?: (options: Message) => PuplishResponse;
+    /**
+      * 在收到 Pubrec 报文时用于返回 Pubrel 的处理函数，
+      * 如果不定义，则默认返回原因码 0
+      *
+      */
+    onPubrel?: (options: PuplishResponse) => PuplishResponse;
+    /**
+      * 在收到 publish 报文时触发，用于返回 Pubrec 的处理函数
+      * 如果不定义，则默认返回原因码 0
+      */
+    onPubrec?: (options: Message) => PuplishResponse;
+    /**
+      * 在接收到Pubrel时，用于处理 Pubcomp 返回
+      * 如果不定义，则默认返回原因码 0
+      */
+    onPubcomp?: (options: PuplishResponse) => PuplishResponse;
 }
+export declare type QOS = 0 | 1 | 2;
 export interface Message {
     /**
      * 消息标识
      * qos > 0时必填
      */
     id?: number;
-    dup: boolean;
-    qos: 0 | 1 | 2;
+    dup?: boolean;
+    qos?: QOS;
     /**
      * 主题名
      */
@@ -153,27 +247,19 @@ export interface Message {
     };
     payload: Uint8Array;
 }
-export interface SubscribeOptions {
-    id: number;
-    properties?: {
-        subscriptionIdentifier: number;
-        userProperties?: UserProperties;
-    };
-    payload: {
-        topic: string;
-        qos: number;
-        nl?: 0 | 1;
-        rap?: 0 | 1;
-        rh?: number;
-    }[];
-}
-export interface UnSubscribeOptions {
-    id: number;
+export interface MessageOption {
+    dup?: boolean;
+    qos?: QOS;
     properties?: {
-        subscriptionIdentifier: number;
+        payloadFormatIndicator?: boolean;
+        messageExpiryInterval?: number;
+        topicAlias?: number;
+        responseTopic?: string;
+        correlationData?: string;
         userProperties?: UserProperties;
+        subscriptionIdentifier?: number;
+        contentType?: string;
     };
-    topics: string[];
 }
 export interface DisconnectOptions {
     /**
@@ -190,3 +276,91 @@ export interface DisconnectOptions {
         serverReference?: string;
     };
 }
+export interface AuthOptions {
+    /**
+     * 原因码
+     */
+    reasonCode: number;
+    /**
+     * 属性，协议版本5支持
+     */
+    properties?: {
+        authenticationMethod: string;
+        authenticationData: string;
+        reasonString?: string;
+        userProperties?: UserProperties;
+    };
+}
+export interface PuplishResponse {
+    id: number;
+    /**
+     * 原因码
+     */
+    reasonCode?: number;
+    /**
+     * 属性，协议版本5支持
+     */
+    properties?: {
+        reasonString?: string;
+        userProperties?: UserProperties;
+    };
+}
+export interface Client {
+    getStatus(): 0 | 1 | 2;
+    /**
+     * 接收消息
+     */
+    onMessage(cb: (data: MQTTMessage) => void): void;
+    offMessage(cb: (data: MQTTMessage) => void): void;
+    /**
+     * 发送消息
+     */
+    publish(topic: string, message: string | Uint8Array, option?: MessageOption): void;
+    /**
+     * 重新认证
+     */
+    reAuth(option: AuthOptions): void;
+    /**
+     * 断开连接
+     */
+    disconnect(option?: DisconnectOptions): void;
+    /**
+     * 关闭事件
+     * @param cb
+     */
+    onClose(cb: () => void): void;
+    /**
+     * 错误监听
+     * @param cb
+     */
+    onError(cb: (e: any) => void): void;
+    /**
+     * 订阅
+     */
+    subscribe: (topic: string, options?: SubscribeOption) => Promise<{
+        reasonCode: Uint8Array;
+        properties?: any;
+    }>;
+    /**
+     * 取消订阅
+     */
+    unsubscribe: (topic: string, options?: UnsubscribeOption) => Promise<{
+        reasonCode: Uint8Array;
+        properties?: any;
+    }>;
+}
+export interface SubscribeOption {
+    qos: number;
+    nl?: 0 | 1;
+    rap?: 0 | 1;
+    rh?: number;
+    properties?: {
+        subscriptionIdentifier: number;
+        userProperties?: UserProperties;
+    };
+}
+export interface UnsubscribeOption {
+    properties?: {
+        userProperties?: UserProperties;
+    };
+}

package/src/lib/packet.d.ts

@@ -53,5 +53,5 @@ export declare const writeProperty: {
  * @param properies
  * @param write
  */
-export declare const packetProperties: (properies: Record<string, any>, write: WriteData) => void;
+export declare const packetProperties: (properies: any, write: WriteData) => void;
 export {};

package/src/lib/parse.d.ts

@@ -1,3 +1,4 @@
+import { AuthOptions, ClientConntroller, Message, PuplishResponse } from "./interface";
 /**
  * 属性值类型
  */
@@ -26,3 +27,15 @@ export declare const parseProperty: {
  * @returns
  */
 export declare const parseProperties: (data: Uint8Array) => Record<string, any>;
+/**
+ * 解析认证授权数据
+ * @param data
+ * @returns
+ */
+export declare const parseAuth: (data: Uint8Array) => AuthOptions;
+/**
+ * 解析消息数据
+ * @param data
+ */
+export declare const parsePublish: (data: Uint8Array, client: ClientConntroller) => Message;
+export declare const parsePublishResponse: (data: Uint8Array, client: ClientConntroller) => PuplishResponse;

package/src/lib/ping.d.ts

@@ -1,5 +1,5 @@
-import { Client } from "./interface";
+import { ClientConntroller } from "./interface";
 /**
  * 取消订阅
  */
-export declare const ping: (client: Client) => Promise<true>;
+export declare const ping: (client: ClientConntroller) => Promise<true>;

package/src/lib/publish.d.ts

@@ -1,7 +1,11 @@
-import { Client, Message } from "./interface";
+import { ClientConntroller, Message, PuplishResponse } from "./interface";
 /**
  * 发布消息
  * @param client
  * @param data
  */
-export declare const publish: (client: Client, message: Message) => Promise<unknown>;
+export declare const publish: (client: ClientConntroller, message: Message) => Promise<void>;
+export declare const puback: (client: ClientConntroller, message: PuplishResponse) => Promise<void>;
+export declare const pubrel: (client: ClientConntroller, message: PuplishResponse) => Promise<void>;
+export declare const pubrec: (client: ClientConntroller, message: PuplishResponse) => Promise<void>;
+export declare const pubcomp: (client: ClientConntroller, message: PuplishResponse) => Promise<void>;

package/src/lib/response.d.ts

@@ -0,0 +1,2 @@
+import { ClientConntroller } from "./interface";
+export declare const handleResponse: (data: Uint8Array, client: ClientConntroller) => void;

package/src/lib/subscribe.d.ts

@@ -1,17 +1,39 @@
-import { Client, SubscribeOptions, UnSubscribeOptions } from "./interface";
+import { ClientConntroller, UserProperties } from "./interface";
+interface SubscribeOptions {
+    id: number;
+    properties?: {
+        subscriptionIdentifier: number;
+        userProperties?: UserProperties;
+    };
+    payload: {
+        topic: string;
+        qos?: number;
+        nl?: 0 | 1;
+        rap?: 0 | 1;
+        rh?: number;
+    }[];
+}
+interface UnSubscribeOptions {
+    id: number;
+    properties?: {
+        userProperties?: UserProperties;
+    };
+    topics: string[];
+}
 /**
  * 订阅消息
  * @param client
  * @param options
  */
-export declare const subscribe: (client: Client, subscribe: SubscribeOptions) => Promise<{
-    qos: number;
+export declare const subscribe: (client: ClientConntroller, options: SubscribeOptions) => Promise<{
+    reasonCode: Uint8Array;
     properties?: any;
 }>;
 /**
  * 取消订阅
  */
-export declare const unsubscribe: (client: Client, subscribe: UnSubscribeOptions) => Promise<{
-    qos: number;
+export declare const unsubscribe: (client: ClientConntroller, subscribe: UnSubscribeOptions) => Promise<{
+    reasonCode: Uint8Array;
     properties?: any;
 }>;
+export {};

package/src/new.d.ts

@@ -1,2 +0,0 @@
-import { Options } from './lib/interface';
-export declare const connectMqtt: (options: Options) => Promise<void>;