@ray-js/wechat-mqtt 0.0.12 → 0.0.13-beta-1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ray-js/wechat-mqtt",
-  "version": "0.0.12",
+  "version": "0.0.13-beta-1",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
@@ -19,10 +19,10 @@
   "dependencies": {
     "mqtt": "4.1.0",
     "js-md5": "^0.7.3",
-    "@ray-js/wechat-tycrypto": "^0.0.12",
-    "@ray-js/wechat-event": "^0.0.12",
-    "@ray-js/wechat-request": "^0.0.12",
-    "@ray-js/wechat-helper": "^0.0.12",
+    "@ray-js/wechat-tycrypto": "^0.0.13-beta-1",
+    "@ray-js/wechat-event": "^0.0.13-beta-1",
+    "@ray-js/wechat-request": "^0.0.13-beta-1",
+    "@ray-js/wechat-helper": "^0.0.13-beta-1",
     "js-base64": "^3.7.2"
   },
   "peerDependencies": {}

package/src/lib/connect.d.ts

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

package/src/lib/constant.d.ts

@@ -0,0 +1,53 @@
+/**
+ * 控制报文类型
+ */
+export declare enum PacketType {
+    Reserved = 0,
+    CONNECT = 1,
+    CONNACK = 2,
+    PUBLISH = 3,
+    PUBACK = 4,
+    PUBREC = 5,
+    PUBREL = 6,
+    PUBCOMP = 7,
+    SUBSCRIBE = 8,
+    SUBACK = 9,
+    UNSUBSCRIBE = 10,
+    UNSUBACK = 11,
+    PINGREQ = 12,
+    PINGRESP = 13,
+    DISCONNECT = 14,
+    AUTH = 15
+}
+/**
+ * 属性标记
+ */
+export declare enum PropertySign {
+    sessionExpiryInterval = 17,
+    receiveMaximum = 33,
+    maximumQoS = 36,
+    retainAvailable = 37,
+    maximumPacketSize = 39,
+    topicAliasMaximum = 34,
+    topicAlias = 35,
+    requestResponseInformation = 25,
+    requestProblemInformation = 23,
+    userProperties = 38,
+    authenticationMethod = 21,
+    authenticationData = 22,
+    willDelayInterval = 24,
+    payloadFormatIndicator = 1,
+    messageExpiryInterval = 2,
+    contentType = 3,
+    responseTopic = 8,
+    correlationData = 9,
+    subscriptionIdentifier = 11,
+    reasonString = 31,
+    assignedClientIdentifier = 18,
+    wildcardSubscriptionAvailable = 40,
+    subscriptionIdentifiersAvailable = 41,
+    sharedSubscriptionAvailable = 42,
+    serverKeepAlive = 19,
+    responseInformation = 26,
+    serverReference = 28
+}

package/src/lib/disconnect.d.ts

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

package/src/lib/factory.d.ts

@@ -1,4 +1,4 @@
-import { Adapter } from "./interface";
+import { Adapter, Client, Options } from "./interface";
 declare type Judge = () => boolean;
 declare type Connect = (url: string) => Adapter;
 /**
@@ -13,5 +13,5 @@ export declare const addAdapter: (judge: Judge, creater: Connect, priority?: boo
  * 创建适配器
  * @returns
  */
-export declare const createAdapter: () => null;
+export declare const createClient: (options: Options) => Promise<Client>;
 export {};

package/src/lib/interface.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 export interface Adapter {
     /**
      * 关闭连接
@@ -28,3 +29,164 @@ export interface Adapter {
      */
     onError(cb: (ev: any) => void): void;
 }
+export interface Client extends Adapter {
+    protocolVersion: number;
+    isClose(): boolean;
+    /**
+     * 接收到消息监听
+     */
+    onMessage(cb: (data: Uint8Array) => void): void;
+    offMessage(cb: (data: Uint8Array) => void): void;
+    offClose(cb: (ev: any) => void): void;
+    offError(cb: (ev: any) => void): void;
+}
+export declare type QoS = 0 | 1 | 2;
+export declare type UserProperties = Record<string, string | string[]>;
+export interface Options {
+    /**
+     * mqtt 连接地址
+     */
+    url: string;
+    /**
+     * 账号
+     */
+    username?: string;
+    /**
+     * 账号密码
+     */
+    password?: string;
+    /**
+     * 客户端id
+     */
+    clientId: string;
+    /**
+     * 协议版本
+     */
+    protocolVersion?: number;
+    /**
+     * 心跳间隔时间
+     */
+    keepalive?: number;
+    /**
+     * 待订阅主题
+     */
+    subscribeTopics?: string | string[];
+    /**
+     * 是否为新会话
+     */
+    clean?: boolean;
+    /**
+     * 遗嘱消息配置
+     */
+    will?: {
+        /**
+         * 遗嘱主题
+         */
+        topic: string;
+        /**
+         * 遗嘱数据
+         */
+        payload: Uint8Array | string;
+        /**
+         * the QoS
+         */
+        qos: QoS;
+        /**
+         * the retain flag
+         */
+        retain: boolean;
+        properties?: {
+            willDelayInterval?: number;
+            payloadFormatIndicator?: boolean;
+            sessionExpiryInterval?: number;
+            contentType?: string;
+            responseTopic?: string;
+            correlationData?: Buffer;
+            userProperties?: UserProperties;
+        };
+    };
+    /**
+     * 协议版本 5 properties
+     */
+    properties?: {
+        sessionExpiryInterval?: number;
+        receiveMaximum?: number;
+        maximumPacketSize?: number;
+        topicAliasMaximum?: number;
+        requestResponseInformation?: boolean;
+        requestProblemInformation?: boolean;
+        userProperties?: UserProperties;
+        authenticationMethod?: string;
+        authenticationData?: Buffer;
+    };
+    /**
+     *
+     * 连接超时时间
+     * 单位秒，默认 10 秒
+     */
+    connectTimeout: number;
+}
+export interface Message {
+    /**
+     * 消息标识
+     * qos > 0时必填
+     */
+    id?: number;
+    dup: boolean;
+    qos: 0 | 1 | 2;
+    /**
+     * 主题名
+     */
+    topicName: string;
+    /**
+     * 协议5版本需要此值
+     */
+    properties?: {
+        payloadFormatIndicator?: boolean;
+        messageExpiryInterval?: number;
+        topicAlias?: number;
+        responseTopic?: string;
+        correlationData?: string;
+        userProperties?: UserProperties;
+        subscriptionIdentifier?: number;
+        contentType?: string;
+    };
+    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;
+    properties?: {
+        subscriptionIdentifier: number;
+        userProperties?: UserProperties;
+    };
+    topics: string[];
+}
+export interface DisconnectOptions {
+    /**
+     * 原因码，默认为0
+     */
+    reasonCode?: number;
+    /**
+     * 属性，协议版本5支持
+     */
+    properties?: {
+        sessionExpiryInterval?: number;
+        reasonString?: string;
+        userProperties?: UserProperties;
+        serverReference?: string;
+    };
+}

package/src/lib/packet.d.ts

@@ -0,0 +1,57 @@
+import { PropertySign } from "./constant";
+declare type WriteData = (data: string | number | number[] | Uint8Array) => void;
+/**
+ * 创建数据包
+ * @param cmd 控制报文
+ * @param fixHeader 固定报文中，4个低字节位数值
+ * @returns
+ */
+export declare const createPacket: (cmd: number, fixHeader?: number) => {
+    header: (data: number | number[] | Uint8Array, needLen?: boolean, isVariable?: boolean) => void;
+    payload: (data: string | number | number[] | Uint8Array, needLen?: boolean, isVariable?: boolean) => void;
+    cleanCache(): void;
+    /**
+     *
+     * @param data
+     */
+    cache: (data: string | number | number[] | Uint8Array, needLen?: boolean, isVariable?: boolean) => void;
+    putHeader(): void;
+    putPayload(): void;
+    getCache(): Uint8Array;
+    /**
+     * 获取 packet 数据
+     * @returns
+     */
+    getPacket: () => Uint8Array;
+};
+export declare const writeString: (sign: PropertySign) => (v: string, write: WriteData) => void;
+export declare const writePair: (sign: PropertySign) => (properies: Record<string, string | string[]>, write: WriteData) => void;
+/**
+ * 属性值类型
+ */
+export declare const writeProperty: {
+    sessionExpiryInterval: (value: number, write: WriteData) => void;
+    receiveMaximum: (value: number, write: WriteData) => void;
+    maximumPacketSize: (value: number, write: WriteData) => void;
+    topicAliasMaximum: (value: number, write: WriteData) => void;
+    topicAlias: (value: number, write: WriteData) => void;
+    requestResponseInformation: (value: boolean, write: WriteData) => void;
+    requestProblemInformation: (value: boolean, write: WriteData) => void;
+    userProperties: (properies: Record<string, string | string[]>, write: WriteData) => void;
+    authenticationMethod: (v: string, write: WriteData) => void;
+    authenticationData: (value: Uint8Array, write: WriteData) => void;
+    willDelayInterval: (value: number, write: WriteData) => void;
+    payloadFormatIndicator: (value: boolean, write: WriteData) => void;
+    messageExpiryInterval: (value: number, write: WriteData) => void;
+    contentType: (v: string, write: WriteData) => void;
+    responseTopic: (v: string, write: WriteData) => void;
+    correlationData: (value: Uint8Array, write: WriteData) => void;
+    subscriptionIdentifier: (value: number, write: WriteData) => void;
+};
+/**
+ * 转化 properties 的数据
+ * @param properies
+ * @param write
+ */
+export declare const packetProperties: (properies: Record<string, any>, write: WriteData) => void;
+export {};

package/src/lib/parse.d.ts

@@ -0,0 +1,28 @@
+/**
+ * 属性值类型
+ */
+export declare const parseProperty: {
+    sessionExpiryInterval: (data: Uint8Array, offset: number) => number[];
+    receiveMaximum: (data: Uint8Array, offset: number) => number[];
+    maximumPacketSize: (data: Uint8Array, offset: number) => number[];
+    topicAliasMaximum: (data: Uint8Array, offset: number) => number[];
+    topicAlias: (data: Uint8Array, offset: number) => number[];
+    requestResponseInformation: (data: Uint8Array, offset: number) => (number | boolean)[];
+    requestProblemInformation: (data: Uint8Array, offset: number) => (number | boolean)[];
+    userProperties: (data: Uint8Array, offset: number) => [Array<string>, number];
+    authenticationMethod: (data: Uint8Array, offset: number) => [string, number];
+    authenticationData: (data: Uint8Array, offset: number) => [Uint8Array, number];
+    willDelayInterval: (data: Uint8Array, offset: number) => number[];
+    payloadFormatIndicator: (data: Uint8Array, offset: number) => (number | boolean)[];
+    messageExpiryInterval: (data: Uint8Array, offset: number) => number[];
+    contentType: (data: Uint8Array, offset: number) => [string, number];
+    responseTopic: (data: Uint8Array, offset: number) => [string, number];
+    correlationData: (data: Uint8Array, offset: number) => [Uint8Array, number];
+    subscriptionIdentifier: (data: Uint8Array, offset: number) => number[];
+};
+/**
+ * 解析 properties
+ * @param data
+ * @returns
+ */
+export declare const parseProperties: (data: Uint8Array) => Record<string, any>;

package/src/lib/ping.d.ts

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

package/src/lib/publish.d.ts

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

package/src/lib/subscribe.d.ts

@@ -0,0 +1,17 @@
+import { Client, SubscribeOptions, UnSubscribeOptions } from "./interface";
+/**
+ * 订阅消息
+ * @param client
+ * @param options
+ */
+export declare const subscribe: (client: Client, subscribe: SubscribeOptions) => Promise<{
+    qos: number;
+    properties?: any;
+}>;
+/**
+ * 取消订阅
+ */
+export declare const unsubscribe: (client: Client, subscribe: UnSubscribeOptions) => Promise<{
+    qos: number;
+    properties?: any;
+}>;

package/src/new.d.ts

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

package/src/lib/contant.d.ts

@@ -1,21 +0,0 @@
-/**
- * 控制报文类型
- */
-export declare enum PacketType {
-    Reserved = 0,
-    CONNECT = 1,
-    CONNACK = 2,
-    PUBLISH = 3,
-    PUBACK = 4,
-    PUBREC = 5,
-    PUBREL = 6,
-    PUBCOMP = 7,
-    SUBSCRIBE = 8,
-    SUBACK = 9,
-    UNSUBSCRIBE = 10,
-    UNSUBACK = 11,
-    PINGREQ = 12,
-    PINGRESP = 13,
-    DISCONNECT = 14,
-    AUTH = 15
-}