@jiangtaste/baiwei-sdk 1.0.0

package/dist/types/device-state.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/index.d.ts

@@ -0,0 +1,8 @@
+/** 对外统一导出的类型入口。 */
+export * from "./device-catalog";
+export * from "./device-state";
+export * from "./messages";
+export * from "./options";
+export * from "./room";
+export * from "./scene";
+export * from "./user";

package/dist/types/index.js

@@ -0,0 +1,24 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/** 对外统一导出的类型入口。 */
+__exportStar(require("./device-catalog"), exports);
+__exportStar(require("./device-state"), exports);
+__exportStar(require("./messages"), exports);
+__exportStar(require("./options"), exports);
+__exportStar(require("./room"), exports);
+__exportStar(require("./scene"), exports);
+__exportStar(require("./user"), exports);

package/dist/types/messages.d.ts

@@ -0,0 +1,53 @@
+/** 协议消息的枚举与基础结构定义。 */
+export declare enum MsgClass {
+    GATEWAY_MGMT = "gateway_mgmt",
+    USER_MGMT = "user_mgmt",
+    CONTROL_MGMT = "control_mgmt",
+    DEVICE_MGMT = "device_mgmt",
+    ROOM_MGMT = "room_mgmt",
+    SCENE_MGMT = "scene_mgmt"
+}
+export declare enum MsgName {
+    ZB_NET_OPEN = "zb_net_open",
+    USER_LOGIN = "user_login",
+    DEVICE_CONTROL = "device_control",
+    DEVICE_STATE_GET = "device_state_get",
+    DEVICE_STATE_REPORT = "device_state_report",
+    DEVICE_QUERY = "device_query",
+    ROOM_QUERY = "room_query",
+    SCENE_LIST = "scene_list",
+    SCENE_CALL = "scene_call"
+}
+export declare enum MsgType {
+    GET = "get",
+    SET = "set",
+    RESPONSE = "response",
+    REPORT = "report"
+}
+export interface BaiweiMessageBase {
+    api_version: string;
+    appId?: string;
+    from: string;
+    to: string;
+    msg_class: MsgClass;
+    msg_name: MsgName;
+    msg_type: MsgType;
+    msg_id: string;
+    token?: string;
+    end?: number;
+    status?: number;
+}
+export type BaiweiMessage<T = Record<string, any>> = BaiweiMessageBase & T;
+export type MessageRequest<TPayload = Record<string, any>> = {
+    msgClass: MsgClass;
+    msgName: MsgName;
+    msgType?: MsgType;
+    payload?: TPayload;
+};
+export type MessageResponse<TPayload = Record<string, any>> = {
+    msgId: string;
+    msgClass: MsgClass;
+    msgName: MsgName;
+    msgType: MsgType;
+    payload: TPayload;
+};

package/dist/types/messages.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MsgType = exports.MsgName = exports.MsgClass = void 0;
+/** 协议消息的枚举与基础结构定义。 */
+var MsgClass;
+(function (MsgClass) {
+    MsgClass["GATEWAY_MGMT"] = "gateway_mgmt";
+    MsgClass["USER_MGMT"] = "user_mgmt";
+    MsgClass["CONTROL_MGMT"] = "control_mgmt";
+    MsgClass["DEVICE_MGMT"] = "device_mgmt";
+    MsgClass["ROOM_MGMT"] = "room_mgmt";
+    MsgClass["SCENE_MGMT"] = "scene_mgmt";
+})(MsgClass || (exports.MsgClass = MsgClass = {}));
+var MsgName;
+(function (MsgName) {
+    MsgName["ZB_NET_OPEN"] = "zb_net_open";
+    MsgName["USER_LOGIN"] = "user_login";
+    MsgName["DEVICE_CONTROL"] = "device_control";
+    MsgName["DEVICE_STATE_GET"] = "device_state_get";
+    MsgName["DEVICE_STATE_REPORT"] = "device_state_report";
+    MsgName["DEVICE_QUERY"] = "device_query";
+    MsgName["ROOM_QUERY"] = "room_query";
+    MsgName["SCENE_LIST"] = "scene_list";
+    MsgName["SCENE_CALL"] = "scene_call";
+})(MsgName || (exports.MsgName = MsgName = {}));
+var MsgType;
+(function (MsgType) {
+    MsgType["GET"] = "get";
+    MsgType["SET"] = "set";
+    MsgType["RESPONSE"] = "response";
+    MsgType["REPORT"] = "report";
+})(MsgType || (exports.MsgType = MsgType = {}));

package/dist/types/options.d.ts

@@ -0,0 +1,27 @@
+import { Logger } from "../utils/logger";
+/** SDK 运行参数与默认值定义。 */
+export declare const DEFAULT_APP_ID = "010";
+export declare const DEFAULT_CLIENT_ID = "baiwei-sdk";
+export declare const DEFAULT_TIMEOUT_MS = 5000;
+export interface BaiweiClientOptions {
+    host: string;
+    port: number;
+    gatewaySN: string;
+    clientId?: string;
+    timeoutMs?: number;
+    logger?: Logger;
+    debug?: boolean;
+}
+export interface BaiweiSessionOptions extends BaiweiClientOptions {
+    clientId: string;
+    timeoutMs: number;
+}
+export interface BaiweiTcpOptions extends BaiweiSessionOptions {
+    autoReconnect?: boolean;
+    reconnectInterval?: number;
+    maxPacketSize?: number;
+    maxCacheSize?: number;
+    keepAlive?: boolean;
+    keepAliveInitialDelay?: number;
+    noDelay?: boolean;
+}

package/dist/types/options.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_TIMEOUT_MS = exports.DEFAULT_CLIENT_ID = exports.DEFAULT_APP_ID = void 0;
+/** SDK 运行参数与默认值定义。 */
+exports.DEFAULT_APP_ID = "010";
+exports.DEFAULT_CLIENT_ID = "baiwei-sdk";
+exports.DEFAULT_TIMEOUT_MS = 5_000;

package/dist/types/room.d.ts

@@ -0,0 +1,9 @@
+/** 房间相关的数据结构。 */
+export interface Room {
+    id: number;
+    name: string;
+    create_time?: string;
+}
+export interface RoomList {
+    room_list?: Room[];
+}

package/dist/types/room.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/scene.d.ts

@@ -0,0 +1,22 @@
+import { BaiweiDeviceState } from "./device-state";
+/** 场景相关的数据结构。 */
+export interface SceneList {
+    scene_list: Scene[];
+}
+export interface Scene {
+    id: number;
+    name: string;
+    room_id: number;
+    delay: number;
+    type: number;
+    device_id: number;
+    picture_id: number;
+    status: number;
+    create_time: string;
+    instruct_list: SceneInstructList<any>[];
+}
+export interface SceneInstructList<T> extends BaiweiDeviceState<T> {
+    id: number;
+    type: number;
+    delay: number;
+}

package/dist/types/scene.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/user.d.ts

@@ -0,0 +1,17 @@
+/** 登录接口返回的用户信息。 */
+export interface AdminLoginOptions {
+    userPwd?: string;
+}
+export interface UserPasswordLoginOptions {
+    userName: string;
+    userPwd: string;
+}
+export type UserLoginOptions = AdminLoginOptions | UserPasswordLoginOptions;
+/** 登录接口返回的用户信息。 */
+export interface UserResponse {
+    user: {
+        type: number;
+        need_sync_time: number;
+        token: string;
+    };
+}

package/dist/types/user.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types.d.ts

@@ -0,0 +1,212 @@
+import { Logger } from "./utils/logger";
+export interface BaiweiClientOptions {
+    host: string;
+    port: number;
+    gatewaySN: string;
+    clientId?: string;
+    timeoutMs?: number;
+    logger?: Logger;
+    debug?: boolean;
+}
+export interface BaiweiSessionOptions extends BaiweiClientOptions {
+    clientId: string;
+}
+export interface BaiweiTcpOptions extends BaiweiSessionOptions {
+    /** Auto reconnect after unexpected close/error (default: true) */
+    autoReconnect?: boolean;
+    /** Reconnect interval in ms (default: 5000) */
+    reconnectInterval?: number;
+    /** Max allowed packet size in bytes (default: 65535, protocol hard limit) */
+    maxPacketSize?: number;
+    /** Max allowed cache size in bytes (default: 4x packet size) */
+    maxCacheSize?: number;
+    /** Enable TCP keep-alive (default: true) */
+    keepAlive?: boolean;
+    /** Initial delay for keep-alive probes in ms (default: 15000) */
+    keepAliveInitialDelay?: number;
+    /** Disable Nagle (default: true) */
+    noDelay?: boolean;
+}
+export interface BaiweiMessageBase {
+    api_version: string;
+    appId?: string;
+    from: string;
+    to: string;
+    msg_class: MsgClass;
+    msg_name: MsgName;
+    msg_type: MsgType;
+    msg_id: string;
+    token?: string;
+    end?: number;
+    status?: number;
+}
+export type BaiweiMessage<T = Record<string, any>> = BaiweiMessageBase & T;
+export declare enum BaiweiProductType {
+    ON_OFF_LIGHT = "On/Off Light",
+    ON_OFF_SWITCH = "On/Off Switch",
+    WINDOW_COVER = "Window Covering Device",
+    IAS_ZONE = "IAS Zone",
+    AIR_BOX = "Air Box",
+    SCENE_SELECTOR = "Scene Selector",
+    AC_GATEWAY = "AC gateway",
+    NEW_WIND = "New wind controller",
+    FLOOR_HEAT = "Floor heat controller"
+}
+export interface DeviceQuery {
+    type_list: DeviceTypeList[];
+}
+export interface DeviceTypeList {
+    product_type: BaiweiProductType;
+    device_list: BaiweiDevice[];
+}
+export interface BaiweiDevice {
+    device_id: string;
+    product_id: number;
+    device_attr: string;
+    device_name: string;
+    room_id: number;
+    network_type: number;
+    create_time: string;
+    acoutside_id: number;
+    acgateway_id: number;
+    product_type: string;
+    product_name: string;
+    node_id: number;
+    endpoint: number;
+    address: number;
+    sn: string;
+    mac: string;
+    com: string;
+    node_type: string;
+    soft_ver: string;
+    hard_ver: string;
+    model: string;
+}
+export interface DeviceStateList<T> {
+    device_list: BaiweiDeviceState<T>[];
+}
+export interface BaiweiDeviceState<T = any> {
+    device_id: string;
+    device_status: T;
+}
+export interface BaiweiDeviceStateReport<T = any> {
+    device: BaiweiDeviceState<T>;
+}
+export interface ACStatus {
+    state: string;
+    acoutside_id: number;
+    acgateway_id: number;
+    sys_mode: string;
+    coolpoint: number;
+    heatpoint: number;
+    wind_level: string;
+    curr_temp: number;
+    err_code: number;
+}
+export interface FloorHeatStatus {
+    state: string;
+    sys_mode: string;
+    work_mode: string;
+    lock_mode: string;
+    temp: number;
+    coolpoint: number;
+    heatpoint: number;
+}
+export interface IASZoneStatus {
+    state: string;
+    status: string;
+}
+export interface NewWindStatus {
+    state: string;
+    sys_mode: string;
+    work_mode: string;
+    lock_mode: string;
+    temp: number;
+    coolpoint: number;
+    heatpoint: number;
+}
+export interface LightState {
+    state: string;
+}
+export interface SceneStatus {
+    sceneId: number;
+    status: number;
+    state: string;
+}
+export interface WindowCoverStatus {
+    state: string;
+    level: number;
+}
+export interface SceneList {
+    scene_list: Scene[];
+}
+export interface Scene {
+    id: number;
+    name: string;
+    room_id: number;
+    delay: number;
+    type: number;
+    device_id: number;
+    picture_id: number;
+    status: number;
+    create_time: string;
+    instruct_list: SceneInstructList<any>[];
+}
+export interface SceneInstructList<T> extends BaiweiDeviceState<T> {
+    id: number;
+    type: number;
+    delay: number;
+}
+export interface Room {
+    id: number;
+    name: string;
+    create_time?: string;
+}
+export interface RoomList {
+    room_list?: Room[];
+}
+export interface UserResponse {
+    user: {
+        type: number;
+        need_sync_time: number;
+        token: string;
+    };
+}
+export declare enum MsgClass {
+    GATEWAY_MGMT = "gateway_mgmt",
+    USER_MGMT = "user_mgmt",
+    CONTROL_MGMT = "control_mgmt",
+    DEVICE_MGMT = "device_mgmt",
+    ROOM_MGMT = "room_mgmt",
+    SCENE_MGMT = "scene_mgmt"
+}
+export declare enum MsgName {
+    ZB_NET_OPEN = "zb_net_open",
+    USER_LOGIN = "user_login",
+    DEVICE_CONTROL = "device_control",
+    DEVICE_STATE_GET = "device_state_get",
+    DEVICE_STATE_REPORT = "device_state_report",
+    DEVICE_QUERY = "device_query",
+    ROOM_QUERY = "room_query",
+    SCENE_LIST = "scene_list",
+    SCENE_CALL = "scene_call"
+}
+export declare enum MsgType {
+    GET = "get",
+    SET = "set",
+    RESPONSE = "response",
+    REPORT = "report"
+}
+export type MessageRequest<TPayload = Record<string, any>> = {
+    msgClass: MsgClass;
+    msgName: MsgName;
+    msgType?: MsgType;
+    payload?: TPayload;
+};
+export type MessageResponse<TPayload = Record<string, any>> = {
+    msgId: string;
+    msgClass: MsgClass;
+    msgName: MsgName;
+    msgType: MsgType;
+    payload: TPayload;
+};

package/dist/types.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MsgType = exports.MsgName = exports.MsgClass = exports.BaiweiProductType = void 0;
+var BaiweiProductType;
+(function (BaiweiProductType) {
+    BaiweiProductType["ON_OFF_LIGHT"] = "On/Off Light";
+    BaiweiProductType["ON_OFF_SWITCH"] = "On/Off Switch";
+    BaiweiProductType["WINDOW_COVER"] = "Window Covering Device";
+    BaiweiProductType["IAS_ZONE"] = "IAS Zone";
+    BaiweiProductType["AIR_BOX"] = "Air Box";
+    BaiweiProductType["SCENE_SELECTOR"] = "Scene Selector";
+    BaiweiProductType["AC_GATEWAY"] = "AC gateway";
+    BaiweiProductType["NEW_WIND"] = "New wind controller";
+    BaiweiProductType["FLOOR_HEAT"] = "Floor heat controller";
+    // BW_CAT_EYE = "BW Cateye",
+})(BaiweiProductType || (exports.BaiweiProductType = BaiweiProductType = {}));
+var MsgClass;
+(function (MsgClass) {
+    MsgClass["GATEWAY_MGMT"] = "gateway_mgmt";
+    MsgClass["USER_MGMT"] = "user_mgmt";
+    MsgClass["CONTROL_MGMT"] = "control_mgmt";
+    MsgClass["DEVICE_MGMT"] = "device_mgmt";
+    MsgClass["ROOM_MGMT"] = "room_mgmt";
+    MsgClass["SCENE_MGMT"] = "scene_mgmt";
+})(MsgClass || (exports.MsgClass = MsgClass = {}));
+var MsgName;
+(function (MsgName) {
+    // gateway
+    MsgName["ZB_NET_OPEN"] = "zb_net_open";
+    // user
+    MsgName["USER_LOGIN"] = "user_login";
+    // control
+    MsgName["DEVICE_CONTROL"] = "device_control";
+    MsgName["DEVICE_STATE_GET"] = "device_state_get";
+    MsgName["DEVICE_STATE_REPORT"] = "device_state_report";
+    // device
+    MsgName["DEVICE_QUERY"] = "device_query";
+    // room
+    MsgName["ROOM_QUERY"] = "room_query";
+    // scene
+    MsgName["SCENE_LIST"] = "scene_list";
+    MsgName["SCENE_CALL"] = "scene_call";
+})(MsgName || (exports.MsgName = MsgName = {}));
+var MsgType;
+(function (MsgType) {
+    MsgType["GET"] = "get";
+    MsgType["SET"] = "set";
+    MsgType["RESPONSE"] = "response";
+    MsgType["REPORT"] = "report";
+})(MsgType || (exports.MsgType = MsgType = {}));

package/dist/utils/IdGenerator.d.ts

@@ -0,0 +1,19 @@
+export declare class IdGenerator {
+    private readonly prefix;
+    private counter;
+    constructor(prefix?: string);
+    /**
+     * 获取下一个 msg_id
+     * 格式：prefix-001 / prefix-002 / ... / prefix-999
+     * 超过 999 自动从 001 重置
+     */
+    next(): string;
+    /**
+     * 获取当前前缀（用于调试/测试）
+     */
+    getPrefix(): string;
+    /**
+     * 手动重置计数器（可选）
+     */
+    resetCounter(start?: number): void;
+}

package/dist/utils/IdGenerator.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IdGenerator = void 0;
+/**
+ * 生成 5 位随机前缀（A-Z + 0-9）
+ */
+function randomPrefix(length = 5) {
+    const chars = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
+    let prefix = "";
+    for (let i = 0; i < length; i++) {
+        prefix += chars.charAt(Math.floor(Math.random() * chars.length));
+    }
+    return prefix;
+}
+class IdGenerator {
+    prefix;
+    counter;
+    constructor(prefix) {
+        // prefix 未指定则自动生成 5 位随机前缀
+        this.prefix = prefix ?? randomPrefix(5);
+        this.counter = 1;
+    }
+    /**
+     * 获取下一个 msg_id
+     * 格式：prefix-001 / prefix-002 / ... / prefix-999
+     * 超过 999 自动从 001 重置
+     */
+    next() {
+        if (this.counter > 999) {
+            this.counter = 1;
+        }
+        const suffix = this.counter.toString().padStart(3, "0");
+        this.counter++;
+        return `${this.prefix}-${suffix}`;
+    }
+    /**
+     * 获取当前前缀（用于调试/测试）
+     */
+    getPrefix() {
+        return this.prefix;
+    }
+    /**
+     * 手动重置计数器（可选）
+     */
+    resetCounter(start = 1) {
+        this.counter = start;
+    }
+}
+exports.IdGenerator = IdGenerator;

package/dist/utils/MessageIdGenerator.d.ts

@@ -0,0 +1,4 @@
+/** 生成协议请求使用的随机消息 ID。 */
+export declare class MessageIdGenerator {
+    next(): string;
+}

package/dist/utils/MessageIdGenerator.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MessageIdGenerator = void 0;
+const BASE = 10_000_000_000;
+const RANGE = 90_000_000_000;
+/** 生成协议请求使用的随机消息 ID。 */
+class MessageIdGenerator {
+    next() {
+        return String(Math.floor(BASE + Math.random() * RANGE));
+    }
+}
+exports.MessageIdGenerator = MessageIdGenerator;

package/dist/utils/logger.d.ts

@@ -0,0 +1,33 @@
+export type LogLever = "debug" | "info" | "warn" | "error";
+export interface Logger {
+    debug: (...args: any[]) => void;
+    info: (...args: any[]) => void;
+    warn: (...args: any[]) => void;
+    error: (...args: any[]) => void;
+}
+/**
+ * 对日志中的敏感字段做浅/深层脱敏。
+ * 兼容普通对象和 JSON 字符串两种输入。
+ */
+export declare function maskSensitive(value: unknown, keys?: readonly string[]): unknown;
+type WrapLoggerOptions = {
+    /** debug 级别是否脱敏：默认 false（即不脱敏） */
+    maskDebug?: boolean;
+    /** 自定义敏感 key 规则 */
+    maskKeys?: string[];
+    /** 当未传入 logger 时，默认会加时间戳；可显式开关 */
+    withTimestamp?: boolean;
+    /** 日志前缀（例如 SDK 名称、模块名） */
+    prefix?: string;
+    /** 自定义时间格式化：默认 new Date().toISOString() */
+    formatTime?: (d: Date) => string;
+};
+/**
+ * 统一拿到一个可用的 logger：
+ * - 默认使用 console
+ * - 返回的 logger 保证 debug/info/warn/error 都是函数
+ * - 默认：debug 不脱敏，info/warn/error 脱敏
+ * - 当不传入 logger 时：会在日志前自动加时间戳与可选前缀
+ */
+export declare function createLogger(input?: Logger, opts?: WrapLoggerOptions): Required<Logger>;
+export {};