@zucker-framework/network 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/network
+
+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,351 @@
+import { OnModuleDestroy, Provider, DynamicModule } from '@nestjs/common';
+
+/**
+ * 网络组件类型标识。
+ *
+ * 对应 jetlinks NetworkType — 用于区分 TCP / HTTP / MQTT / WebSocket 等
+ * 不同网络组件，以字符串 id 作为唯一键。
+ *
+ * 与 jetlinks 的差异：去掉了 Java 枚举字典依赖，改用纯接口 + 工厂函数。
+ */
+interface NetworkType {
+    /** 类型唯一标识，如 'TCP_SERVER'、'HTTP_CLIENT' */
+    readonly id: string;
+    /** 可读名称（可选，默认等于 id） */
+    readonly name: string;
+}
+/**
+ * 用 id 创建一个 NetworkType（等价 jetlinks `NetworkType.of(id)`）。
+ */
+declare function networkType(id: string, name?: string): NetworkType;
+/**
+ * 内置网络类型常量，对应 jetlinks DefaultNetworkType 的通用子集。
+ * IoT 专用类型（CoAP 等）不迁移。
+ */
+declare const NetworkTypes: {
+    readonly TCP_CLIENT: NetworkType;
+    readonly TCP_SERVER: NetworkType;
+    readonly HTTP_CLIENT: NetworkType;
+    readonly HTTP_SERVER: NetworkType;
+    readonly MQTT_CLIENT: NetworkType;
+    readonly MQTT_SERVER: NetworkType;
+    readonly WEB_SOCKET_CLIENT: NetworkType;
+    readonly WEB_SOCKET_SERVER: NetworkType;
+    readonly UDP: NetworkType;
+};
+/**
+ * 动态类型注册表 — 对齐 jetlinks NetworkTypes 的 register/lookup 模式。
+ *
+ * 允许运行时注册自定义网络类型（如 CoAP、自定义协议等），
+ * 与 jetlinks 中 NetworkTypes.register() 语义一致。
+ */
+declare class NetworkTypeRegistry {
+    private readonly types;
+    constructor();
+    /** 注册网络类型 — 对齐 jetlinks NetworkTypes.register() */
+    register(type: NetworkType): void;
+    /** 批量注册 */
+    registerAll(types: NetworkType[]): void;
+    /** 根据 ID 查找网络类型 — 对齐 jetlinks NetworkTypes.lookup() */
+    lookup(id: string): NetworkType | undefined;
+    /** 获取所有已注册的网络类型 — 对齐 jetlinks NetworkTypes.get() */
+    getAll(): NetworkType[];
+}
+/** 全局网络类型注册表单例 */
+declare const networkTypeRegistry: NetworkTypeRegistry;
+
+/**
+ * 传输协议抽象。
+ *
+ * 对应 jetlinks NetworkTransport（TCP / UDP）以及 NetworkConfig.schema
+ * （http / mqtt / ws 等应用层协议）。
+ *
+ * 在 zucker 中将两层合并为一个 Transport 枚举 + schema 字段，
+ * 使消费方只需关心一个类型。
+ */
+/** 底层传输协议 */
+type TransportProtocol = 'TCP' | 'UDP';
+/**
+ * 传输描述 — 包含底层协议 + 应用层 schema。
+ *
+ * 例如 MQTT over TCP: `{ protocol: 'TCP', schema: 'mqtt' }`
+ */
+interface Transport {
+    /** 底层协议：TCP 或 UDP */
+    readonly protocol: TransportProtocol;
+    /** 应用层 schema，如 http / mqtt / ws */
+    readonly schema: string;
+}
+declare function createTransport(protocol: TransportProtocol, schema: string): Transport;
+/** 常见传输常量 */
+declare const Transports: {
+    readonly TCP: Transport;
+    readonly UDP: Transport;
+    readonly HTTP: Transport;
+    readonly HTTPS: Transport;
+    readonly MQTT: Transport;
+    readonly MQTTS: Transport;
+    readonly WS: Transport;
+    readonly WSS: Transport;
+};
+
+/**
+ * 网络组件根接口。
+ *
+ * 对应 jetlinks `Network` — 所有具体网络实现（TCP Server、MQTT Client 等）
+ * 的统一抽象。提供生命周期管理（shutdown / isAlive / isAutoReload）。
+ */
+interface Network {
+    /** 网络组件实例唯一标识 */
+    readonly id: string;
+    /** 网络类型 */
+    readonly type: NetworkType;
+    /** 关闭网络组件，释放底层资源 */
+    shutdown(): Promise<void> | void;
+    /** 组件是否存活 */
+    isAlive(): boolean;
+    /**
+     * 当 isAlive() 返回 false 时，是否由 NetworkManager 自动重新加载。
+     * 默认 false。
+     */
+    isAutoReload(): boolean;
+}
+/**
+ * 服务端网络组件，额外暴露绑定地址。
+ *
+ * 对应 jetlinks `ServerNetwork`。
+ */
+interface ServerNetwork extends Network {
+    /** 绑定的 host:port；如未绑定返回 undefined */
+    getBindAddress(): {
+        host: string;
+        port: number;
+    } | undefined;
+}
+
+/**
+ * 网络组件配置基础接口。
+ *
+ * 对应 jetlinks `NetworkConfig` — 抽象出所有网络组件共有的配置属性。
+ */
+interface NetworkConfig {
+    /** 配置唯一标识 */
+    readonly id: string;
+    /** 传输协议 */
+    readonly transport: Transport;
+    /** 是否启用 TLS/DTLS 安全加密 */
+    readonly secure: boolean;
+    /** 安全证书标识（secure 为 true 时必须） */
+    readonly certId?: string;
+}
+/**
+ * 服务端网络配置。
+ *
+ * 对应 jetlinks `ServerNetworkConfig`。
+ */
+interface ServerNetworkConfig extends NetworkConfig {
+    /** 监听地址 */
+    readonly host: string;
+    /** 监听端口 */
+    readonly port: number;
+}
+/**
+ * 客户端网络配置。
+ *
+ * 对应 jetlinks `ClientNetworkConfig`。
+ */
+interface ClientNetworkConfig extends NetworkConfig {
+    /** 远端地址 */
+    readonly remoteHost: string;
+    /** 远端端口 */
+    readonly remotePort: number;
+}
+/**
+ * 通用可序列化的网络属性，对应 jetlinks `NetworkProperties`。
+ *
+ * 与 jetlinks 完全对齐：type + configurations map 的组合
+ * 让 NetworkProvider 可以按需反序列化成具体 Config。
+ */
+interface NetworkProperties {
+    /** 配置 ID */
+    id: string;
+    /** 网络类型标识 */
+    type: string;
+    /** 配置名称 */
+    name: string;
+    /** 是否启用 */
+    enabled: boolean;
+    /** 自由 KV 配置 — 不同网络类型内容不同 */
+    configurations: Record<string, unknown>;
+}
+
+/**
+ * 网络组件提供商 SPI。
+ *
+ * 对应 jetlinks `NetworkProvider<P>` — 每种网络类型注册一个 Provider，
+ * 负责根据配置创建/重载网络实例。
+ *
+ * 泛型 P 为具体的配置类型（如 TcpServerConfig、MqttClientConfig）。
+ *
+ * 与 jetlinks 的差异：
+ * - 去掉 Reactor Mono，使用 async/Promise
+ * - 去掉 ConfigMetadata（Java UI 元数据，在 TS 中用 JSON Schema 替代）
+ */
+interface NetworkProvider<P = unknown> {
+    /** 该 Provider 支持的网络类型 */
+    readonly type: NetworkType;
+    /** 根据具体配置创建网络组件 */
+    createNetwork(config: P): Promise<Network>;
+    /** 重载已有网络组件（热更新配置） */
+    reload(network: Network, config: P): Promise<Network>;
+    /**
+     * 将通用 NetworkProperties 转换为具体配置对象 P。
+     * 对应 jetlinks `NetworkProvider.createConfig(NetworkProperties)`。
+     */
+    createConfig(properties: NetworkProperties): Promise<P>;
+    /**
+     * 网络组件是否可被多个消费者复用。
+     *
+     * 例如 TCP Server 通常不可复用（一个端口只能被一个网关占用），
+     * 而 HTTP Client 可复用。
+     * 默认 false。
+     */
+    isReusable(): boolean;
+}
+
+/**
+ * 网络组件配置管理接口 — 用于从持久层获取 NetworkProperties。
+ *
+ * 对应 jetlinks `NetworkConfigManager`。
+ * 具体实现由应用层提供（数据库、文件等）。
+ */
+interface NetworkConfigManager {
+    getConfig(type: NetworkType, id: string): Promise<NetworkProperties | undefined>;
+}
+/**
+ * 网络管理器接口。
+ *
+ * 对应 jetlinks `NetworkManager` — 统一管理多种类型的网络组件实例，
+ * 提供按类型+ID 获取、重载、关闭、销毁等操作。
+ */
+interface INetworkManager {
+    /** 按类型和 ID 获取网络组件（懒创建） */
+    getNetwork<T extends Network = Network>(type: NetworkType, id: string): Promise<T>;
+    /** 获取所有已创建的网络组件 */
+    getNetworks(): Network[];
+    /** 获取所有已注册的 Provider */
+    getProviders(): NetworkProvider[];
+    /** 按类型 ID 获取 Provider */
+    getProvider(typeId: string): NetworkProvider | undefined;
+    /** 重载指定网络组件 */
+    reload(type: NetworkType, id: string): Promise<void>;
+    /** 关闭指定网络组件（不移除缓存） */
+    shutdown(type: NetworkType, id: string): Promise<void>;
+    /** 销毁指定网络组件（关闭并移除缓存） */
+    destroy(type: NetworkType, id: string): Promise<void>;
+}
+/**
+ * 默认网络管理器实现。
+ *
+ * 对应 jetlinks `DefaultNetworkManager` — 通过 Provider SPI 按需创建
+ * 网络组件实例，内部按 type + id 缓存。
+ *
+ * 与 jetlinks 的差异：
+ * - 去掉了 Spring BeanPostProcessor 自动发现，改为手动 registerProvider
+ * - 去掉了 EventBus 集群同步（zucker 已有 @zucker-framework/cluster）
+ * - 健康检查用 setInterval 而非 Flux.interval
+ */
+declare class DefaultNetworkManager implements INetworkManager, OnModuleDestroy {
+    private readonly configManager;
+    private readonly logger;
+    /** type-id -> Provider */
+    private readonly providers;
+    /** type-id -> (network-id -> Network) */
+    private readonly store;
+    private checkTimer;
+    constructor(configManager: NetworkConfigManager);
+    registerProvider(provider: NetworkProvider<unknown>): void;
+    getNetwork<T extends Network = Network>(type: NetworkType, id: string): Promise<T>;
+    getNetworks(): Network[];
+    getProviders(): NetworkProvider[];
+    getProvider(typeId: string): NetworkProvider | undefined;
+    reload(type: NetworkType, id: string): Promise<void>;
+    shutdown(type: NetworkType, id: string): Promise<void>;
+    destroy(type: NetworkType, id: string): Promise<void>;
+    onModuleDestroy(): Promise<void>;
+    private getNetworkStore;
+    private requireProvider;
+    private createFromConfig;
+    /**
+     * 定期检查网络组件存活状态 — 与 jetlinks checkNetwork() 逻辑对齐。
+     */
+    private checkNetworks;
+}
+
+/**
+ * 消息编解码器抽象。
+ *
+ * 对应 jetlinks `DeviceMessageCodec` 的通用子集 — 去掉了 IoT 设备
+ * 消息特定部分，保留通用的 encode / decode / transport 关联。
+ *
+ * 在 zucker 中，Codec 用于任意协议的消息序列化/反序列化，
+ * 例如 MQTT payload 解析、TCP 帧编解码等。
+ */
+
+/**
+ * 编解码上下文 — 携带编解码时可能需要的环境信息。
+ */
+interface CodecContext {
+    /** 当前网络组件 ID */
+    readonly networkId?: string;
+    /** 额外上下文 KV */
+    readonly attributes: Record<string, unknown>;
+}
+/**
+ * 消息编解码器。
+ *
+ * 泛型参数：
+ * - TEncoded  : 编码后的格式（如 Buffer、string）
+ * - TDecoded  : 解码后的业务对象
+ */
+interface Codec<TEncoded = Buffer, TDecoded = unknown> {
+    /** 编解码器标识 */
+    readonly id: string;
+    /** 该编解码器绑定的传输协议 */
+    readonly transport: Transport;
+    /** 将业务对象编码为传输格式 */
+    encode(message: TDecoded, context?: CodecContext): Promise<TEncoded> | TEncoded;
+    /** 将传输格式解码为业务对象 */
+    decode(payload: TEncoded, context?: CodecContext): Promise<TDecoded> | TDecoded;
+}
+/**
+ * JSON 编解码器 — 最常见的实现，将对象序列化为 JSON Buffer。
+ */
+declare class JsonCodec<T = unknown> implements Codec<Buffer, T> {
+    readonly id: string;
+    readonly transport: Transport;
+    constructor(id: string, transport: Transport);
+    encode(message: T): Buffer;
+    decode(payload: Buffer): T;
+}
+
+declare const NETWORK_MANAGER: unique symbol;
+declare const NETWORK_CONFIG_MANAGER: unique symbol;
+/**
+ * Zucker 网络模块。
+ *
+ * 使用 `forRoot` 注册时，需提供 `NetworkConfigManager` 实现。
+ *
+ * ```ts
+ * ZuckerNetworkModule.forRoot({
+ *   configManager: MyNetworkConfigManager,
+ * })
+ * ```
+ */
+declare class ZuckerNetworkModule {
+    static forRoot(options: {
+        configManager: Provider;
+    }): DynamicModule;
+}
+
+export { type ClientNetworkConfig, type Codec, type CodecContext, DefaultNetworkManager, type INetworkManager, JsonCodec, NETWORK_CONFIG_MANAGER, NETWORK_MANAGER, type Network, type NetworkConfig, type NetworkConfigManager, type NetworkProperties, type NetworkProvider, type NetworkType, NetworkTypes, type ServerNetwork, type ServerNetworkConfig, type Transport, type TransportProtocol, Transports, ZuckerNetworkModule, createTransport, networkType, networkTypeRegistry };