@zucker-framework/gateway 1.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,22 @@
+Zucker Framework
+Copyright 2026 Lind and Zucker Framework contributors
+
+Licensed under the Apache License, Version 2.0. See LICENSE.
+
+The framework includes TypeScript adaptations and enhancements of concepts and
+implementations from hsweb-framework and jetlinks-community, both distributed
+under the Apache License, Version 2.0. Individual packages use different subsets
+of the framework. The TypeScript adaptations and Node.js integrations were
+modified for Zucker Framework; they are not the original upstream distribution.
+
+hsweb-framework
+https://github.com/hs-web/hsweb-framework
+Copyright 2020 http://hsweb.me
+
+jetlinks-community
+https://github.com/jetlinks/jetlinks-community
+
+See THIRD_PARTY_NOTICES for license texts and attribution for bundled dependencies
+and reference implementations relevant to this package. External dependencies
+remain subject to their own licenses. This NOTICE is informational and does not
+modify any license or grant rights to upstream trademarks.

package/THIRD_PARTY_NOTICES

@@ -0,0 +1,4 @@
+@zucker-framework/gateway
+
+No separately recorded third-party implementation is bundled in this package.
+External dependencies retain their own licenses; see NOTICE for framework attribution.

package/dist/index.d.mts

@@ -0,0 +1,304 @@
+import { Transport } from '@zucker-framework/network';
+import { UpstreamMessage, DownstreamMessage, ThingManager, ThingsDataService } from '@zucker-framework/things';
+import { Logger } from '@nestjs/common';
+
+/**
+ * 设备会话 — 对应 jetlinks DeviceSession
+ *
+ * 代表一个已连接设备的网络会话，负责消息的收发与状态跟踪。
+ */
+
+/**
+ * 设备会话状态
+ */
+declare enum SessionState {
+    /** 会话正常，设备在线 */
+    CONNECTED = "connected",
+    /** 会话已关闭 */
+    CLOSED = "closed",
+    /** 会话空闲（超时告警） */
+    IDLE = "idle"
+}
+/**
+ * 设备会话接口 — 对应 jetlinks DeviceSession
+ */
+interface DeviceSession {
+    /** 会话唯一 ID */
+    readonly sessionId: string;
+    /** 关联的设备（物）ID */
+    readonly thingId: string;
+    /** 所属网关 ID */
+    readonly gatewayId: string;
+    /** 传输协议 */
+    readonly transport: Transport;
+    /** 会话创建时间 */
+    readonly connectTime: number;
+    /** 最后活跃时间 */
+    lastPingTime: number;
+    /** 当前状态 */
+    state: SessionState;
+    /**
+     * 发送下行消息（原始字节/对象）到设备
+     * 对应 jetlinks DeviceSession.send()
+     */
+    send(payload: unknown): Promise<void>;
+    /**
+     * 关闭会话
+     * 对应 jetlinks DeviceSession.close()
+     */
+    close(): Promise<void>;
+    /**
+     * 更新心跳
+     * 对应 jetlinks DeviceSession.ping()
+     */
+    ping(): void;
+    /**
+     * 是否存活
+     * 对应 jetlinks DeviceSession.isAlive()
+     */
+    isAlive(): boolean;
+}
+/**
+ * 子设备会话 — 对应 jetlinks ChildDeviceSession
+ *
+ * 通过父设备（如网关设备）代理的子设备会话。
+ */
+interface ChildDeviceSession extends DeviceSession {
+    /** 父设备 ID */
+    readonly parentThingId: string;
+}
+
+/**
+ * 消息编解码器 — 对应 jetlinks ProtocolSupport / MessageCodec
+ *
+ * 负责原始协议消息 ↔ ThingMessage 的互转。
+ * 不同协议（MQTT/HTTP/TCP）提供不同的 Codec 实现。
+ */
+
+/**
+ * 上行消息解码上下文 — 对应 jetlinks MessageDecodeContext
+ */
+interface DecodeContext {
+    /** 接收到的原始消息 */
+    payload: unknown;
+    /** 原始主题/路径/端点（MQTT topic、HTTP path 等） */
+    topic?: string;
+    /** 请求头/消息头 */
+    headers?: Record<string, string>;
+    /** 关联的设备会话 */
+    session: DeviceSession;
+}
+/**
+ * 下行消息编码上下文 — 对应 jetlinks MessageEncodeContext
+ */
+interface EncodeContext {
+    /** 要发送的平台消息 */
+    message: DownstreamMessage;
+    /** 关联的设备会话 */
+    session: DeviceSession;
+}
+/**
+ * 编码结果
+ */
+interface EncodedMessage {
+    /** 编码后的载荷 */
+    payload: unknown;
+    /** 目标主题/路径 */
+    topic?: string;
+    /** 附加头信息 */
+    headers?: Record<string, string>;
+}
+/**
+ * 消息编解码器接口 — 对应 jetlinks DeviceMessageCodec / ProtocolSupport
+ */
+interface MessageCodec {
+    /**
+     * 解码上行消息（原始 → ThingMessage[]）
+     * 对应 jetlinks DeviceMessageCodec.decode()
+     * 一条原始消息可能解析出多条逻辑消息（如批量属性上报）
+     */
+    decode(context: DecodeContext): Promise<UpstreamMessage[]>;
+    /**
+     * 编码下行消息（ThingMessage → 原始）
+     * 对应 jetlinks DeviceMessageCodec.encode()
+     */
+    encode(context: EncodeContext): Promise<EncodedMessage>;
+}
+/**
+ * 协议支持描述 — 对应 jetlinks ProtocolSupport
+ */
+interface ProtocolSupport {
+    /** 协议唯一 ID */
+    readonly id: string;
+    /** 协议名称 */
+    readonly name: string;
+    /** 支持的传输协议 schema 列表，如 ['mqtt', 'http', 'tcp'] */
+    readonly transports: string[];
+    /** 获取对应传输协议的编解码器 */
+    getCodec(transport: string): MessageCodec | undefined;
+}
+/**
+ * 协议注册表 — 对应 jetlinks ProtocolSupportManager
+ */
+declare class ProtocolRegistry {
+    private readonly protocols;
+    register(protocol: ProtocolSupport): void;
+    unregister(id: string): void;
+    get(id: string): ProtocolSupport | undefined;
+    getAll(): ProtocolSupport[];
+}
+
+/**
+ * 设备网关接口 — 对应 jetlinks DeviceGateway
+ *
+ * 网关是协议层（network）与业务层（things）的桥接器：
+ *   - 接收设备连接，建立 DeviceSession
+ *   - 调用 MessageCodec 解码上行消息，发布到消息总线
+ *   - 接收下行消息，编码后通过 DeviceSession 发送给设备
+ */
+
+/**
+ * 网关状态
+ */
+declare enum GatewayState {
+    STARTING = "starting",
+    RUNNING = "running",
+    PAUSED = "paused",
+    STOPPED = "stopped"
+}
+/**
+ * 网关配置
+ */
+interface DeviceGatewayConfig {
+    id: string;
+    name: string;
+    /** 关联的 network 配置 ID */
+    networkId: string;
+    /** 使用的协议 ID */
+    protocolId: string;
+    /** 传输 schema（与 protocol.getCodec(schema) 对应）*/
+    transport: string;
+}
+/**
+ * 设备网关接口 — 对应 jetlinks DeviceGateway
+ */
+interface DeviceGateway {
+    readonly config: DeviceGatewayConfig;
+    readonly state: GatewayState;
+    /** 启动网关 */
+    start(): Promise<void>;
+    /** 暂停（不再接受新连接，已有连接保持）*/
+    pause(): Promise<void>;
+    /** 停止网关并关闭所有连接 */
+    shutdown(): Promise<void>;
+    /** 获取活跃会话数量 */
+    getSessionCount(): number;
+    /** 获取指定设备的会话 */
+    getSession(thingId: string): DeviceSession | undefined;
+    /** 发送下行消息到指定设备 */
+    sendDownstream(thingId: string, payload: unknown): Promise<void>;
+}
+/**
+ * 抽象网关基类 — 提供会话管理 + 消息路由公共逻辑
+ * 子类只需实现协议特定的 start/pause/shutdown
+ *
+ * 对应 jetlinks AbstractDeviceGateway
+ */
+declare abstract class AbstractDeviceGateway implements DeviceGateway {
+    readonly config: DeviceGatewayConfig;
+    protected readonly protocol: ProtocolSupport;
+    protected readonly thingManager: ThingManager;
+    protected readonly dataService: ThingsDataService;
+    protected readonly logger: Logger;
+    protected readonly sessions: Map<string, DeviceSession>;
+    state: GatewayState;
+    constructor(config: DeviceGatewayConfig, protocol: ProtocolSupport, thingManager: ThingManager, dataService: ThingsDataService);
+    abstract start(): Promise<void>;
+    abstract pause(): Promise<void>;
+    abstract shutdown(): Promise<void>;
+    getSessionCount(): number;
+    getSession(thingId: string): DeviceSession | undefined;
+    sendDownstream(thingId: string, payload: unknown): Promise<void>;
+    /**
+     * 处理设备连接 — 注册会话并触发上线
+     */
+    protected onSessionConnected(session: DeviceSession): Promise<void>;
+    /**
+     * 处理设备断开 — 移除会话并触发离线
+     */
+    protected onSessionClosed(session: DeviceSession): Promise<void>;
+    /**
+     * 处理上行原始消息 — 解码后路由到对应处理器
+     * 对应 jetlinks AbstractDeviceGateway.doMessage()
+     */
+    protected handleIncoming(context: DecodeContext): Promise<void>;
+    /**
+     * 将解码后的消息路由到业务处理 — 对应 jetlinks DeviceMessageBus.publish()
+     */
+    private routeMessage;
+    /**
+     * 关闭所有会话
+     */
+    protected closeAllSessions(): Promise<void>;
+}
+
+/**
+ * HTTP 网关实现
+ *
+ * 用法：
+ * ```typescript
+ * const gateway = new HttpDeviceGateway(config, protocol, thingManager, dataService);
+ * await gateway.start();
+ *
+ * // 当收到 HTTP 请求时：
+ * await gateway.handleRequest('device-001', requestBody);
+ * ```
+ */
+declare class HttpDeviceGateway extends AbstractDeviceGateway {
+    constructor(config: DeviceGatewayConfig, protocol: ProtocolSupport, thingManager: ThingManager, dataService: ThingsDataService);
+    start(): Promise<void>;
+    pause(): Promise<void>;
+    shutdown(): Promise<void>;
+    /**
+     * 处理来自设备的 HTTP 请求
+     * 由 NestJS Controller 调用
+     *
+     * @param thingId 设备 ID（从路径参数或认证信息中提取）
+     * @param body 请求体
+     */
+    handleRequest(thingId: string, body: unknown): Promise<void>;
+}
+
+declare class GatewayManager {
+    readonly protocolRegistry: ProtocolRegistry;
+    private readonly logger;
+    private readonly gateways;
+    constructor(protocolRegistry: ProtocolRegistry);
+    register(gateway: DeviceGateway): void;
+    unregister(gatewayId: string): void;
+    get(gatewayId: string): DeviceGateway | undefined;
+    getAll(): DeviceGateway[];
+    /** 启动所有已注册的网关 */
+    startAll(): Promise<void>;
+    /** 停止所有网关 */
+    shutdownAll(): Promise<void>;
+    /** 汇总统计 */
+    getSummary(): {
+        total: number;
+        running: number;
+        stopped: number;
+        totalSessions: number;
+    };
+}
+
+/**
+ * GatewayModule — 协议网关 NestJS 模块
+ *
+ * 提供：
+ *   - ProtocolRegistry（协议注册表）
+ *   - GatewayManager（网关生命周期管理）
+ */
+declare class GatewayModule {
+}
+
+export { AbstractDeviceGateway, type ChildDeviceSession, type DecodeContext, type DeviceGateway, type DeviceGatewayConfig, type DeviceSession, type EncodeContext, type EncodedMessage, GatewayManager, GatewayModule, GatewayState, HttpDeviceGateway, type MessageCodec, ProtocolRegistry, type ProtocolSupport, SessionState };