@danqiusheng/nest-nacos 1.0.0 → 1.1.0

package/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+## 1.1.0
+
+- Fix asynchronous server status and health checks.
+- Fix duplicate Config callbacks and SDK listener identity during unsubscribe.
+- Fix Naming unsubscribe-all behavior.
+- Close both SDK clients during module shutdown.
+- Fix `forRootAsync({ useClass })` and export raw client tokens.
+- Normalize the public Config namespace to the empty namespace ID.
+- Add JSON, YAML, Properties and TXT parsing, preload merge, hot-update state,
+  local fallback cache, startup failure modes and retries.
+- Add random, round-robin and weighted discovery with metadata filtering.
+- Remove false Nacos 3.x and gRPC compatibility claims.

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2026 丹丘生
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2026 丹丘生
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.en.md

@@ -0,0 +1,59 @@
+# @danqiusheng/nest-nacos
+
+Nacos 2.x configuration and service-discovery integration for NestJS 10/11.
+
+## Compatibility
+
+| Component | Supported |
+|---|---|
+| Node.js | >= 16 |
+| NestJS | 10.x, 11.x |
+| Nacos Node SDK | `nacos` 2.6.x |
+| Nacos Server | 2.x; end-to-end tested against 2.5.3 |
+| Nacos Server 3.x / gRPC | Not supported |
+
+The underlying SDK only implements the legacy HTTP OpenAPI. The plugin rejects
+`transport: 'grpc'` instead of silently claiming a transport it does not use.
+The Nest application does not require Java. Java is only needed when running a
+Nacos Server locally.
+
+## Install
+
+```bash
+npm install @danqiusheng/nest-nacos nacos
+```
+
+## Usage
+
+```ts
+NacosModule.forRoot({
+  config: { serverAddr: '127.0.0.1:8848', namespace: 'public' },
+  naming: { serverList: '127.0.0.1:8848', namespace: 'public' },
+  instances: [{ serviceName: 'api', ip: '10.0.0.5', port: 3000 }],
+  subscribeConfigs: [
+    { dataId: 'application.yaml', format: 'yaml' },
+    { dataId: 'database.properties', format: 'properties' },
+  ],
+  configLoading: {
+    failureMode: 'fallback',
+    cacheDir: '.nacos-cache',
+    retry: { attempts: 3, delayMs: 300 },
+  },
+});
+```
+
+Configuration features include JSON, YAML, Properties and text parsing, deep
+merge, hot updates, one SDK subscription per key, local fallback files and
+configurable startup behavior. Naming supports random, round-robin and weighted
+selection with metadata filters.
+
+Both health APIs are asynchronous:
+
+```ts
+await naming.getServerStatus();
+await healthIndicator.isHealthy();
+```
+
+Run `npm run build && npm test` for deterministic regressions. Release validation
+must additionally use a real Nacos 2.x server and verify writes through the
+server API.