@danqiusheng/nest-nacos 1.1.0 → 1.2.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.2.0 (unreleased)
+
+- Add shared top-level `serverAddr`, `namespace`, `username`, `password`, and
+  `ssl` options so Naming and Config no longer require duplicate connection
+  settings.
+- Add `NacosModule.forRoot('host:8848')` as the smallest setup form.
+- Expand the Chinese and English usage documentation.
+
 ## 1.1.0
 
 - Fix asynchronous server status and health checks.

package/README.en.md

@@ -2,58 +2,196 @@
 
 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
+## Minimal setup
+
+One address enables both Naming and Config clients:
+
+```ts
+NacosModule.forRoot('127.0.0.1:8848');
+```
+
+Authentication and a custom namespace are still configured once:
+
+```ts
+NacosModule.forRoot({
+  serverAddr: '127.0.0.1:8848',
+  namespace: 'production',
+  username: process.env.NACOS_USERNAME,
+  password: process.env.NACOS_PASSWORD,
+});
+```
+
+The public namespace and `DEFAULT_GROUP` are used by default. `serverAddr`
+also accepts an array of server addresses.
+
+## Async setup
+
+```ts
+NacosModule.forRootAsync({
+  inject: [ConfigService],
+  useFactory: (config: ConfigService) => ({
+    serverAddr: config.getOrThrow<string>('NACOS_SERVER_ADDR'),
+    namespace: config.get<string>('NACOS_NAMESPACE') ?? 'public',
+    username: config.get<string>('NACOS_USERNAME'),
+    password: config.get<string>('NACOS_PASSWORD'),
+  }),
+});
+```
+
+`useFactory`, `useClass`, and `useExisting` are supported.
+
+## Automatic registration
+
+```ts
+NacosModule.forRoot({
+  serverAddr: '127.0.0.1:8848',
+  instances: [
+    {
+      serviceName: 'orders',
+      ip: '10.0.0.5',
+      port: 3000,
+      metadata: { environment: 'production' },
+    },
+  ],
+});
+```
+
+Plugin-managed instances are deregistered when the Nest module is destroyed.
+
+## Service discovery
+
+```ts
+constructor(
+  @InjectNacosNaming()
+  private readonly naming: NacosNamingService,
+) {}
+
+const instance = await this.naming.selectInstance('payments', {
+  strategy: 'roundRobin', // random | roundRobin | weighted
+  metadata: { environment: 'production' },
+});
+```
+
+Manual registration and subscriptions are also available:
+
+```ts
+await this.naming.register(instanceOptions);
+await this.naming.deregister(instanceOptions);
+
+this.naming.subscribe('payments', listener);
+this.naming.unSubscribe('payments', listener);
+```
+
+## Configuration center
+
+```ts
+constructor(
+  @InjectNacosConfig()
+  private readonly nacos: NacosConfigService,
+) {}
+
+const raw = await this.nacos.getConfig('application.yaml');
+const parsed = await this.nacos.getParsedConfig<AppConfig>(
+  'application.yaml',
+);
+
+this.nacos.subscribe(
+  'application.yaml',
+  'DEFAULT_GROUP',
+  (content, value) => console.log(value),
+);
+```
+
+JSON, YAML, Properties, and text are supported. Each `dataId + group` uses one
+underlying SDK subscription, regardless of the number of business listeners.
+
+Publish and remove configuration with:
+
+```ts
+await this.nacos.publish('application.json', 'DEFAULT_GROUP', content);
+await this.nacos.remove('application.json', 'DEFAULT_GROUP');
+```
+
+## Preload and fallback cache
 
 ```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 }],
+  serverAddr: '127.0.0.1:8848',
   subscribeConfigs: [
     { dataId: 'application.yaml', format: 'yaml' },
     { dataId: 'database.properties', format: 'properties' },
   ],
   configLoading: {
-    failureMode: 'fallback',
+    failureMode: 'fallback', // throw | fallback | continue
     cacheDir: '.nacos-cache',
     retry: { attempts: 3, delayMs: 300 },
   },
 });
+
+const merged = await this.nacos.getMergedConfig<AppConfig>();
+```
+
+Successful remote loads update cache files atomically. In `fallback` mode the
+cache is used when Nacos is unavailable.
+
+## Advanced client-specific options
+
+Nested options are only needed when Naming and Config use different settings:
+
+```ts
+NacosModule.forRoot({
+  naming: {
+    serverList: 'naming.example:8848',
+    namespace: 'services',
+  },
+  config: {
+    serverAddr: 'config.example:8848',
+    namespace: 'configuration',
+  },
+});
 ```
 
-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.
+Nested fields override shared top-level fields. Supplying only `naming` or
+only `config` enables only that client.
+
+## Health and raw clients
 
 Both health APIs are asynchronous:
 
 ```ts
-await naming.getServerStatus();
-await healthIndicator.isHealthy();
+await this.naming.getServerStatus();
+await this.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.
+Use `@InjectNacosNamingClient()` and `@InjectNacosConfigClient()` only when an
+underlying SDK API is not exposed by the plugin. The module owns and closes
+both clients.
+
+## Compatibility
+
+| Component | Supported |
+|---|---|
+| Node.js | >= 16 |
+| NestJS | 10.x, 11.x |
+| Nacos Node SDK | `nacos` 2.6.x |
+| Nacos Server | 2.x; tested against 2.5.3 |
+| Nacos Server 3.x / gRPC | Not supported |
+
+The underlying SDK implements the HTTP OpenAPI, not the Nacos 3.x gRPC
+protocol. The plugin rejects `transport: 'grpc'` instead of silently falling
+back. Java is required only to run a local Nacos Server, not by the NestJS
+plugin itself.
+
+## Verify
+
+```bash
+npm ci
+npm run build
+npm test
+```

package/README.md

@@ -2,124 +2,471 @@
 
 面向 NestJS 10/11 的 Nacos 2.x 配置中心与服务注册发现模块。
 
-## 兼容性
+## 1. 安装
 
-| 组件 | 支持范围 |
+```bash
+npm install @danqiusheng/nest-nacos nacos
+```
+
+## 2. 最简接入
+
+未开启 Nacos 鉴权时，只需要一个地址：
+
+```ts
+import { Module } from '@nestjs/common';
+import { NacosModule } from '@danqiusheng/nest-nacos';
+
+@Module({
+  imports: [NacosModule.forRoot('127.0.0.1:8848')],
+})
+export class AppModule {}
+```
+
+这会同时启用配置中心和服务注册发现，默认使用：
+
+| 配置 | 默认值 |
 |---|---|
-| NestJS | 10.x、11.x |
-| Node.js | >= 16 |
-| Nacos Node SDK | `nacos` 2.6.x |
-| Nacos Server | 2.x（已对 2.5.3 做真实端到端验证） |
-| Nacos Server 3.x | 不支持 |
-| 传输协议 | Nacos 1.x HTTP OpenAPI；不支持 gRPC |
+| namespace | `public` |
+| group | `DEFAULT_GROUP` |
+| transport | HTTP OpenAPI |
+| 重试次数 | 3 次（包含第一次调用） |
 
-`nacos@2.6.x` 没有实现 Nacos 3.x 所需的 gRPC 协议。插件会明确拒绝
-`transport: 'grpc'`，避免请求返回成功但服务端没有落盘的假成功。
+开启用户名密码鉴权时，也只需要配置一次连接信息：
 
-插件运行不需要 Java。只有在本机启动 Nacos Server 时才需要与对应 Nacos 版本兼容的 Java；远程已有 Nacos Server 时，Nest 应用只需要 Node.js。
+```ts
+NacosModule.forRoot({
+  serverAddr: '127.0.0.1:8848',
+  username: 'nacos',
+  password: 'nacos',
+});
+```
 
-## 安装
+`serverAddr` 支持集群地址数组：
 
-```bash
-npm install @danqiusheng/nest-nacos nacos
+```ts
+NacosModule.forRoot({
+  serverAddr: ['10.0.0.11:8848', '10.0.0.12:8848'],
+  namespace: 'production',
+  username: process.env.NACOS_USERNAME,
+  password: process.env.NACOS_PASSWORD,
+  ssl: false,
+});
 ```
 
-## 模块配置
+## 3. 使用环境变量
+
+插件不会隐式读取环境变量。推荐使用 Nest `ConfigModule` 明确传入配置：
 
 ```ts
 import { Module } from '@nestjs/common';
+import { ConfigModule, ConfigService } from '@nestjs/config';
 import { NacosModule } from '@danqiusheng/nest-nacos';
 
 @Module({
   imports: [
-    NacosModule.forRoot({
-      config: {
-        serverAddr: '127.0.0.1:8848',
-        namespace: 'public',
-        username: 'nacos',
-        password: 'nacos',
-      },
-      naming: {
-        serverList: '127.0.0.1:8848',
-        namespace: 'public',
-        username: 'nacos',
-        password: 'nacos',
-      },
-      instances: [{
-        serviceName: 'order-service',
-        ip: '192.168.1.20',
-        port: 3000,
-        weight: 1,
-        metadata: { env: 'prod', version: '1.1.0' },
-      }],
-      subscribeConfigs: [
-        { dataId: 'application.yaml', format: 'yaml' },
-        { dataId: 'database.properties', format: 'properties' },
-      ],
-      configLoading: {
-        failureMode: 'fallback',
-        cacheDir: '.nacos-cache',
-        retry: { attempts: 3, delayMs: 300 },
-      },
+    ConfigModule.forRoot({ isGlobal: true }),
+    NacosModule.forRootAsync({
+      inject: [ConfigService],
+      useFactory: (config: ConfigService) => ({
+        serverAddr: config.getOrThrow<string>('NACOS_SERVER_ADDR'),
+        namespace: config.get<string>('NACOS_NAMESPACE') ?? 'public',
+        username: config.get<string>('NACOS_USERNAME'),
+        password: config.get<string>('NACOS_PASSWORD'),
+      }),
     }),
   ],
 })
 export class AppModule {}
 ```
 
-`forRootAsync` 支持 `useFactory`、`useExisting` 和 `useClass`。
+`.env` 示例：
+
+```dotenv
+NACOS_SERVER_ADDR=127.0.0.1:8848
+NACOS_NAMESPACE=public
+NACOS_USERNAME=nacos
+NACOS_PASSWORD=nacos
+```
+
+`forRootAsync` 同时支持 `useFactory`、`useClass` 和 `useExisting`。
+
+## 4. 自动注册当前服务
+
+在模块配置中加入 `instances`，应用启动时自动注册，关闭时自动注销：
+
+```ts
+NacosModule.forRoot({
+  serverAddr: '127.0.0.1:8848',
+  instances: [
+    {
+      serviceName: 'order-service',
+      ip: '192.168.1.20',
+      port: 3000,
+      weight: 1,
+      ephemeral: true,
+      metadata: { env: 'prod', version: '1.2.0' },
+    },
+  ],
+});
+```
+
+如果 IP 或端口来自环境变量，应使用 `forRootAsync` 构造 `instances`。
+
+## 5. 服务注册与发现
 
-## 配置中心
+### 注入服务
 
 ```ts
 import { Injectable } from '@nestjs/common';
-import { InjectNacosConfig, NacosConfigService } from '@danqiusheng/nest-nacos';
+import {
+  InjectNacosNaming,
+  NacosNamingService,
+} from '@danqiusheng/nest-nacos';
+
+@Injectable()
+export class ServiceDiscovery {
+  constructor(
+    @InjectNacosNaming()
+    private readonly naming: NacosNamingService,
+  ) {}
+}
+```
+
+也可以直接使用构造器注入 `NacosNamingService`。
+
+### 手动注册和注销
+
+```ts
+const instance = {
+  serviceName: 'payment-service',
+  ip: '192.168.1.30',
+  port: 3000,
+  metadata: { env: 'prod' },
+};
+
+await this.naming.register(instance);
+await this.naming.deregister(instance);
+```
+
+通过插件注册的实例会被记录，Nest 模块销毁时会自动注销。
+
+### 获取健康实例
+
+```ts
+const instances = await this.naming.selectInstances('payment-service');
+```
+
+只选择一个实例：
+
+```ts
+const instance = await this.naming.selectInstance('payment-service', {
+  strategy: 'roundRobin',
+  metadata: { env: 'prod' },
+});
+```
+
+支持三种策略：
+
+| strategy | 行为 |
+|---|---|
+| `random` | 随机选择，默认值 |
+| `roundRobin` | 按服务轮询 |
+| `weighted` | 按 Nacos 实例权重随机选择 |
+
+找不到满足健康状态和 metadata 条件的实例时，`selectInstance()` 会抛出异常。
+
+### 订阅服务变化
+
+```ts
+const listener = (hosts: unknown[]) => {
+  console.log('payment-service 实例变化', hosts);
+};
+
+this.naming.subscribe('payment-service', listener);
+this.naming.unSubscribe('payment-service', listener);
+
+// 不传 listener：取消该服务的全部本地订阅
+this.naming.unSubscribe('payment-service');
+```
+
+### 更新权重
+
+```ts
+await this.naming.updateWeight(instance, 0.5);
+```
+
+## 6. 配置中心
+
+### 注入服务
+
+```ts
+import { Injectable } from '@nestjs/common';
+import {
+  InjectNacosConfig,
+  NacosConfigService,
+} from '@danqiusheng/nest-nacos';
 
 @Injectable()
 export class SettingsService {
-  constructor(@InjectNacosConfig() private readonly nacos: NacosConfigService) {}
+  constructor(
+    @InjectNacosConfig()
+    private readonly nacos: NacosConfigService,
+  ) {}
+}
+```
 
-  async load() {
-    const yaml = await this.nacos.getParsedConfig('application.yaml');
-    const merged = await this.nacos.getMergedConfig();
-    return { yaml, merged };
-  }
+### 读取配置
+
+```ts
+const raw = await this.nacos.getConfig('application.yaml');
 
-  watch() {
-    this.nacos.subscribe('application.yaml', 'DEFAULT_GROUP', (raw, parsed) => {
-      // 每次服务端变更只回调一次；parsed 是按 dataId/format 解析后的值。
-    });
+const config = await this.nacos.getParsedConfig<{
+  server: { port: number };
+}>('application.yaml');
+```
+
+格式默认根据 `dataId` 后缀自动识别：
+
+| 后缀/format | 返回值 |
+|---|---|
+| `.json` / `json` | JSON 对象或数组 |
+| `.yaml`、`.yml` / `yaml` | YAML 解析结果 |
+| `.properties` / `properties` | 键值对象 |
+| 其他 / `txt` | 原始字符串 |
+
+强制按 JSON 解析：
+
+```ts
+const config = await this.nacos.getConfigAsJson<AppConfig>(
+  'application.json',
+);
+```
+
+### 发布和删除配置
+
+```ts
+const published = await this.nacos.publish(
+  'application.json',
+  'DEFAULT_GROUP',
+  JSON.stringify({ featureEnabled: true }),
+);
+
+const removed = await this.nacos.remove(
+  'application.json',
+  'DEFAULT_GROUP',
+);
+```
+
+返回值为 Nacos SDK 的最终布尔结果。public namespace 删除已处理 `tenant=public` 导致的假成功问题。
+
+### 订阅热更新
+
+```ts
+const listener = (raw: string, parsed?: unknown) => {
+  console.log('配置已更新', parsed);
+};
+
+this.nacos.subscribe(
+  'application.yaml',
+  'DEFAULT_GROUP',
+  listener,
+);
+
+this.nacos.unSubscribe(
+  'application.yaml',
+  'DEFAULT_GROUP',
+  listener,
+);
+```
+
+同一个 `dataId + group` 只建立一个底层 SDK 订阅，多个业务 listener 不会导致重复回调。
+
+## 7. 启动时预加载配置
+
+```ts
+NacosModule.forRoot({
+  serverAddr: '127.0.0.1:8848',
+  subscribeConfigs: [
+    { dataId: 'application.yaml', format: 'yaml' },
+    { dataId: 'database.properties', format: 'properties' },
+    {
+      dataId: 'optional.json',
+      required: false,
+      subscribe: false,
+    },
+  ],
+});
+```
+
+默认行为：
+
+- group 为 `DEFAULT_GROUP`。
+- format 为 `auto`。
+- `subscribe: true`，预加载后继续监听热更新。
+- `required: true`，读取失败会按启动失败策略处理。
+
+合并所有已声明配置：
+
+```ts
+const merged = await this.nacos.getMergedConfig<AppConfig>();
+```
+
+对象会按声明顺序深度合并，后面的配置覆盖前面的同名字段。
+
+## 8. 本地缓存和启动失败策略
+
+```ts
+NacosModule.forRoot({
+  serverAddr: '127.0.0.1:8848',
+  subscribeConfigs: [{ dataId: 'application.yaml' }],
+  configLoading: {
+    failureMode: 'fallback',
+    cacheDir: '.nacos-cache',
+    retry: {
+      attempts: 3,
+      delayMs: 300,
+      backoffFactor: 2,
+      maxDelayMs: 3000,
+    },
+  },
+});
+```
+
+| failureMode | 行为 |
+|---|---|
+| `throw` | 读取必需配置失败时阻止应用启动，默认值 |
+| `fallback` | 优先读取本地缓存；无缓存且配置必需时阻止启动 |
+| `continue` | 记录警告并继续启动 |
+
+成功从 Nacos 读取配置后，插件会原子更新缓存文件。缓存目录应加入部署持久化目录，不建议提交到 Git。
+
+## 9. 健康检查
+
+`getServerStatus()` 和 `isHealthy()` 都是异步方法：
+
+```ts
+const status = await this.naming.getServerStatus(); // UP | DOWN
+```
+
+可直接提供 Nest HTTP 健康接口：
+
+```ts
+import { Controller, Get } from '@nestjs/common';
+import { NacosHealthIndicator } from '@danqiusheng/nest-nacos';
+
+@Controller('health/nacos')
+export class NacosHealthController {
+  constructor(private readonly health: NacosHealthIndicator) {}
+
+  @Get()
+  check() {
+    return this.health.isHealthy();
   }
 }
 ```
 
-支持 JSON、YAML、Properties、TXT 自动解析，多配置深度合并，热更新内存缓存，本地文件回退，以及 `throw` / `fallback` / `continue` 三种启动失败策略。每个 `dataId + group` 只建立一个底层 SDK 订阅。
+返回：
+
+```json
+{ "status": "up" }
+```
+
+## 10. 高级连接配置
 
-## 服务注册与发现
+绝大多数项目只需要顶层共享配置。只有 Naming 和 Config 使用不同地址、命名空间或云鉴权参数时，才使用嵌套配置：
 
 ```ts
-const instance = await naming.selectInstance('payment-service', {
-  strategy: 'roundRobin', // random | roundRobin | weighted
-  metadata: { env: 'prod' },
+NacosModule.forRoot({
+  serverAddr: 'shared-nacos:8848',
+  username: 'shared-user',
+  password: 'shared-password',
+
+  naming: {
+    serverList: 'naming-nacos:8848',
+    namespace: 'service-space',
+    appName: 'order-service',
+  },
+  config: {
+    serverAddr: 'config-nacos:8848',
+    namespace: 'config-space',
+    accessKey: process.env.NACOS_ACCESS_KEY,
+    secretKey: process.env.NACOS_SECRET_KEY,
+  },
 });
+```
 
-await naming.updateWeight({
-  serviceName: 'order-service',
-  ip: '192.168.1.20',
-  port: 3000,
-}, 0.5);
+嵌套配置优先于顶层共享配置。只配置 `naming` 或只配置 `config`，可以只启用对应能力。
+
+## 11. 原始 SDK 客户端
+
+只有插件服务未覆盖 SDK 能力时才建议使用：
+
+```ts
+import {
+  InjectNacosConfigClient,
+  InjectNacosNamingClient,
+} from '@danqiusheng/nest-nacos';
+import type {
+  NacosConfigClient,
+  NacosNamingClient,
+} from 'nacos';
+
+constructor(
+  @InjectNacosNamingClient()
+  private readonly namingClient: NacosNamingClient,
+  @InjectNacosConfigClient()
+  private readonly configClient: NacosConfigClient,
+) {}
+```
+
+原始客户端由模块统一关闭，不要在业务代码中重复调用 `close()`。
+
+## 12. 兼容性
+
+| 组件 | 支持范围 |
+|---|---|
+| NestJS | 10.x、11.x |
+| Node.js | >= 16 |
+| Nacos Node SDK | `nacos` 2.6.x |
+| Nacos Server | 2.x（已对 2.5.3 做真实端到端验证） |
+| Nacos Server 3.x | 不支持 |
+| 传输协议 | Nacos HTTP OpenAPI；不支持 gRPC |
+
+`nacos@2.6.x` 没有实现 Nacos 3.x 所需的 gRPC 协议。配置 `transport: 'grpc'` 时插件会立即抛出错误，不会静默回退造成假成功。
+
+插件本身不需要 Java。只有在本机运行 Nacos Server 时才需要 Java；NestJS 应用连接远程 Nacos 时只需要 Node.js。
+
+## 13. 常见问题
+
+### `getServerStatus()` 类型是 Promise
+
+必须使用 `await`：
+
+```ts
+const status = await this.naming.getServerStatus();
 ```
 
-模块销毁时会注销由插件注册的实例，并关闭 Naming/Config 客户端。`getServerStatus()` 和 `NacosHealthIndicator.isHealthy()` 均为异步方法：
+### 鉴权后 Naming 正常但 Config 失败
+
+使用顶层 `username/password` 可以同时传给两个客户端，避免重复配置遗漏：
 
 ```ts
-const status = await naming.getServerStatus();
-const health = await healthIndicator.isHealthy();
+NacosModule.forRoot({ serverAddr, username, password });
 ```
 
-高级用法可使用 `@InjectNacosNamingClient()` 和 `@InjectNacosConfigClient()` 注入原始 SDK 客户端。
+### public namespace 应该怎么写
+
+省略 `namespace` 或设置为 `public` 都可以。插件会按 Naming 和 Config SDK 的不同要求正确归一化。
+
+### 应用无法退出
+
+请通过 Nest 的 `app.close()` 或正常进程信号关闭。模块销毁时会注销实例、取消订阅并关闭两个 SDK 客户端。
+
+### Nacos 3.x 为什么不能连接
+
+当前 Node SDK 没有 Nacos 3.x gRPC 实现。需要 Nacos 3.x 时不能通过修改 `transport` 参数解决，应等待或替换真正支持该协议的 SDK。
 
-## 验证
+## 14. 验证
 
 ```bash
 npm ci
@@ -127,4 +474,4 @@ npm run build
 npm test
 ```
 
-发布前还应针对真实 Nacos 2.x 执行端到端测试，并从服务端接口反查注册、发布和删除结果。
+发布前还应针对真实 Nacos 2.x 执行端到端测试，并从服务端接口反查注册、配置发布和删除结果。

package/dist/nacos.interfaces.d.ts

@@ -66,6 +66,19 @@ export interface NacosConfigLoadingOptions {
     retry?: NacosRetryOptions;
 }
 export interface NacosModuleOptions {
+    /**
+     * Shared Nacos address for both Naming and Config clients.
+     * Use the nested client options only when their addresses differ.
+     */
+    serverAddr?: string | string[];
+    /** Shared namespace. Defaults to the public namespace. */
+    namespace?: string;
+    /** Shared username for both clients. */
+    username?: string;
+    /** Shared password for both clients. */
+    password?: string;
+    /** Shared TLS switch for both clients. */
+    ssl?: boolean;
     naming?: NacosNamingOptions;
     config?: NacosConfigOptions;
     instances?: NacosInstanceOptions[];
@@ -73,12 +86,14 @@ export interface NacosModuleOptions {
     configLoading?: NacosConfigLoadingOptions;
     retry?: NacosRetryOptions;
 }
+/** A server address string is shorthand for `{ serverAddr }`. */
+export type NacosModuleOptionsInput = NacosModuleOptions | string;
 export interface NacosOptionsFactory {
-    createNacosOptions(): Promise<NacosModuleOptions> | NacosModuleOptions;
+    createNacosOptions(): Promise<NacosModuleOptionsInput> | NacosModuleOptionsInput;
 }
 export interface NacosModuleAsyncOptions extends Pick<ModuleMetadata, 'imports'> {
     name?: string;
-    useFactory?: (...args: any[]) => Promise<NacosModuleOptions> | NacosModuleOptions;
+    useFactory?: (...args: any[]) => Promise<NacosModuleOptionsInput> | NacosModuleOptionsInput;
     inject?: any[];
     useClass?: Type<NacosOptionsFactory>;
     useExisting?: Type<NacosOptionsFactory> | string | symbol;

package/dist/nacos.interfaces.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"nacos.interfaces.d.ts","sourceRoot":"","sources":["../src/nacos.interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAEtD,mFAAmF;AACnF,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,MAAM,CAAC;AAC7C,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,YAAY,GAAG,KAAK,CAAC;AAChF,MAAM,MAAM,uBAAuB,GAAG,OAAO,GAAG,UAAU,GAAG,UAAU,CAAC;AACxE,MAAM,MAAM,0BAA0B,GAAG,QAAQ,GAAG,YAAY,GAAG,UAAU,CAAC;AAE9E,MAAM,WAAW,iBAAiB;IAChC,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,0DAA0D;IAC1D,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,uCAAuC;IACvC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,0DAA0D;IAC1D,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,kBAAkB;IACjC,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oEAAoE;IACpE,SAAS,CAAC,EAAE,cAAc,CAAC;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,kBAAkB;IACjC,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC9B,iDAAiD;IACjD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oEAAoE;IACpE,SAAS,CAAC,EAAE,cAAc,CAAC;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,MAAM,CAAC;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAC3B,0DAA0D;IAC1D,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,yFAAyF;IACzF,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,oCAAoC;IACpC,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,uBAAuB,CAAC;IACtC,KAAK,CAAC,EAAE,iBAAiB,CAAC;CAC3B;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,CAAC,EAAE,kBAAkB,CAAC;IAC5B,MAAM,CAAC,EAAE,kBAAkB,CAAC;IAC5B,SAAS,CAAC,EAAE,oBAAoB,EAAE,CAAC;IACnC,gBAAgB,CAAC,EAAE,qBAAqB,EAAE,CAAC;IAC3C,aAAa,CAAC,EAAE,yBAAyB,CAAC;IAC1C,KAAK,CAAC,EAAE,iBAAiB,CAAC;CAC3B;AAED,MAAM,WAAW,mBAAmB;IAClC,kBAAkB,IAAI,OAAO,CAAC,kBAAkB,CAAC,GAAG,kBAAkB,CAAC;CACxE;AAED,MAAM,WAAW,uBACf,SAAQ,IAAI,CAAC,cAAc,EAAE,SAAS,CAAC;IACvC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,kBAAkB,CAAC,GAAG,kBAAkB,CAAC;IAClF,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC;IACf,QAAQ,CAAC,EAAE,IAAI,CAAC,mBAAmB,CAAC,CAAC;IACrC,WAAW,CAAC,EAAE,IAAI,CAAC,mBAAmB,CAAC,GAAG,MAAM,GAAG,MAAM,CAAC;CAC3D;AAED,MAAM,WAAW,oBAAoB;IACnC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,6BAA6B;IAC5C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,QAAQ,CAAC,EAAE,0BAA0B,CAAC;IACtC,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,iBAAiB,CAAC;IAC1B,MAAM,EAAE,OAAO,GAAG,UAAU,CAAC;IAC7B,SAAS,EAAE,MAAM,CAAC;CACnB"}
+{"version":3,"file":"nacos.interfaces.d.ts","sourceRoot":"","sources":["../src/nacos.interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAEtD,mFAAmF;AACnF,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,MAAM,CAAC;AAC7C,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,YAAY,GAAG,KAAK,CAAC;AAChF,MAAM,MAAM,uBAAuB,GAAG,OAAO,GAAG,UAAU,GAAG,UAAU,CAAC;AACxE,MAAM,MAAM,0BAA0B,GAAG,QAAQ,GAAG,YAAY,GAAG,UAAU,CAAC;AAE9E,MAAM,WAAW,iBAAiB;IAChC,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,0DAA0D;IAC1D,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,uCAAuC;IACvC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,0DAA0D;IAC1D,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,kBAAkB;IACjC,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oEAAoE;IACpE,SAAS,CAAC,EAAE,cAAc,CAAC;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,kBAAkB;IACjC,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC9B,iDAAiD;IACjD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oEAAoE;IACpE,SAAS,CAAC,EAAE,cAAc,CAAC;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,MAAM,CAAC;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAC3B,0DAA0D;IAC1D,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,yFAAyF;IACzF,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,oCAAoC;IACpC,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,uBAAuB,CAAC;IACtC,KAAK,CAAC,EAAE,iBAAiB,CAAC;CAC3B;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC/B,0DAA0D;IAC1D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,wCAAwC;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,wCAAwC;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,0CAA0C;IAC1C,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,MAAM,CAAC,EAAE,kBAAkB,CAAC;IAC5B,MAAM,CAAC,EAAE,kBAAkB,CAAC;IAC5B,SAAS,CAAC,EAAE,oBAAoB,EAAE,CAAC;IACnC,gBAAgB,CAAC,EAAE,qBAAqB,EAAE,CAAC;IAC3C,aAAa,CAAC,EAAE,yBAAyB,CAAC;IAC1C,KAAK,CAAC,EAAE,iBAAiB,CAAC;CAC3B;AAED,iEAAiE;AACjE,MAAM,MAAM,uBAAuB,GAAG,kBAAkB,GAAG,MAAM,CAAC;AAElE,MAAM,WAAW,mBAAmB;IAClC,kBAAkB,IAAI,OAAO,CAAC,uBAAuB,CAAC,GAAG,uBAAuB,CAAC;CAClF;AAED,MAAM,WAAW,uBACf,SAAQ,IAAI,CAAC,cAAc,EAAE,SAAS,CAAC;IACvC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,uBAAuB,CAAC,GAAG,uBAAuB,CAAC;IAC5F,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC;IACf,QAAQ,CAAC,EAAE,IAAI,CAAC,mBAAmB,CAAC,CAAC;IACrC,WAAW,CAAC,EAAE,IAAI,CAAC,mBAAmB,CAAC,GAAG,MAAM,GAAG,MAAM,CAAC;CAC3D;AAED,MAAM,WAAW,oBAAoB;IACnC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,6BAA6B;IAC5C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,QAAQ,CAAC,EAAE,0BAA0B,CAAC;IACtC,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,iBAAiB,CAAC;IAC1B,MAAM,EAAE,OAAO,GAAG,UAAU,CAAC;IAC7B,SAAS,EAAE,MAAM,CAAC;CACnB"}

package/dist/nacos.module.d.ts

@@ -1,7 +1,7 @@
 import { DynamicModule } from '@nestjs/common';
-import { NacosModuleAsyncOptions, NacosModuleOptions } from './nacos.interfaces';
+import { NacosModuleAsyncOptions, NacosModuleOptionsInput } from './nacos.interfaces';
 export declare class NacosModule {
-    static forRoot(options: NacosModuleOptions): DynamicModule;
+    static forRoot(options: NacosModuleOptionsInput): DynamicModule;
     static forRootAsync(options: NacosModuleAsyncOptions): DynamicModule;
     private static createAsyncOptionsProvider;
 }

package/dist/nacos.module.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"nacos.module.d.ts","sourceRoot":"","sources":["../src/nacos.module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAoB,MAAM,gBAAgB,CAAC;AAEjE,OAAO,EAAE,uBAAuB,EAAE,kBAAkB,EAAuB,MAAM,oBAAoB,CAAC;AActG,qBACa,WAAW;IACtB,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,kBAAkB,GAAG,aAAa;IAe1D,MAAM,CAAC,YAAY,CAAC,OAAO,EAAE,uBAAuB,GAAG,aAAa;IAoBpE,OAAO,CAAC,MAAM,CAAC,0BAA0B;CAkB1C"}
+{"version":3,"file":"nacos.module.d.ts","sourceRoot":"","sources":["../src/nacos.module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAoB,MAAM,gBAAgB,CAAC;AAEjE,OAAO,EACL,uBAAuB,EACvB,uBAAuB,EAExB,MAAM,oBAAoB,CAAC;AAc5B,qBACa,WAAW;IACtB,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,uBAAuB,GAAG,aAAa;IAe/D,MAAM,CAAC,YAAY,CAAC,OAAO,EAAE,uBAAuB,GAAG,aAAa;IAoBpE,OAAO,CAAC,MAAM,CAAC,0BAA0B;CAoB1C"}

package/dist/nacos.module.js

@@ -27,7 +27,7 @@ let NacosModule = NacosModule_1 = class NacosModule {
             module: NacosModule_1,
             global: true,
             providers: [
-                { provide: nacos_constants_1.NACOS_OPTIONS, useValue: options },
+                { provide: nacos_constants_1.NACOS_OPTIONS, useValue: (0, nacos_providers_1.normalizeNacosOptions)(options) },
                 ...nacos_providers_1.nacosClientProviders,
                 nacos_naming_service_1.NacosNamingService,
                 nacos_config_service_1.NacosConfigService,
@@ -59,7 +59,7 @@ let NacosModule = NacosModule_1 = class NacosModule {
         if (options.useFactory) {
             return {
                 provide: nacos_constants_1.NACOS_OPTIONS,
-                useFactory: options.useFactory,
+                useFactory: async (...args) => (0, nacos_providers_1.normalizeNacosOptions)(await options.useFactory(...args)),
                 inject: options.inject ?? [],
             };
         }
@@ -69,7 +69,7 @@ let NacosModule = NacosModule_1 = class NacosModule {
         }
         return {
             provide: nacos_constants_1.NACOS_OPTIONS,
-            useFactory: (factory) => factory.createNacosOptions(),
+            useFactory: async (factory) => (0, nacos_providers_1.normalizeNacosOptions)(await factory.createNacosOptions()),
             inject: [factoryToken],
         };
     }

package/dist/nacos.module.js.map

@@ -1 +1 @@
-{"version":3,"file":"nacos.module.js","sourceRoot":"","sources":["../src/nacos.module.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,2CAAiE;AACjE,uDAA4F;AAE5F,uDAAyD;AACzD,iEAA4D;AAC5D,iEAA4D;AAC5D,iDAAsD;AAEtD,MAAM,iBAAiB,GAAG;IACxB,qCAAmB;IACnB,qCAAmB;IACnB,yCAAkB;IAClB,yCAAkB;IAClB,mCAAoB;CACrB,CAAC;AAGK,IAAM,WAAW,mBAAjB,MAAM,WAAW;IACtB,MAAM,CAAC,OAAO,CAAC,OAA2B;QACxC,OAAO;YACL,MAAM,EAAE,aAAW;YACnB,MAAM,EAAE,IAAI;YACZ,SAAS,EAAE;gBACT,EAAE,OAAO,EAAE,+BAAa,EAAE,QAAQ,EAAE,OAAO,EAAE;gBAC7C,GAAG,sCAAoB;gBACvB,yCAAkB;gBAClB,yCAAkB;gBAClB,mCAAoB;aACrB;YACD,OAAO,EAAE,iBAAiB;SAC3B,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,YAAY,CAAC,OAAgC;QAClD,MAAM,cAAc,GAAe,OAAO,CAAC,QAAQ;YACjD,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC;YAC7D,CAAC,CAAC,EAAE,CAAC;QACP,OAAO;YACL,MAAM,EAAE,aAAW;YACnB,MAAM,EAAE,IAAI;YACZ,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,SAAS,EAAE;gBACT,GAAG,cAAc;gBACjB,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC;gBACxC,GAAG,sCAAoB;gBACvB,yCAAkB;gBAClB,yCAAkB;gBAClB,mCAAoB;aACrB;YACD,OAAO,EAAE,iBAAiB;SAC3B,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,0BAA0B,CAAC,OAAgC;QACxE,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;YACvB,OAAO;gBACL,OAAO,EAAE,+BAAa;gBACtB,UAAU,EAAE,OAAO,CAAC,UAAU;gBAC9B,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,EAAE;aAC7B,CAAC;QACJ,CAAC;QACD,MAAM,YAAY,GAAG,OAAO,CAAC,WAAW,IAAI,OAAO,CAAC,QAAQ,CAAC;QAC7D,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;QAChF,CAAC;QACD,OAAO;YACL,OAAO,EAAE,+BAAa;YACtB,UAAU,EAAE,CAAC,OAA4B,EAAE,EAAE,CAAC,OAAO,CAAC,kBAAkB,EAAE;YAC1E,MAAM,EAAE,CAAC,YAAY,CAAC;SACvB,CAAC;IACJ,CAAC;CACF,CAAA;AAtDY,kCAAW;sBAAX,WAAW;IADvB,IAAA,eAAM,EAAC,EAAE,CAAC;GACE,WAAW,CAsDvB"}
+{"version":3,"file":"nacos.module.js","sourceRoot":"","sources":["../src/nacos.module.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,2CAAiE;AACjE,uDAA4F;AAM5F,uDAAgF;AAChF,iEAA4D;AAC5D,iEAA4D;AAC5D,iDAAsD;AAEtD,MAAM,iBAAiB,GAAG;IACxB,qCAAmB;IACnB,qCAAmB;IACnB,yCAAkB;IAClB,yCAAkB;IAClB,mCAAoB;CACrB,CAAC;AAGK,IAAM,WAAW,mBAAjB,MAAM,WAAW;IACtB,MAAM,CAAC,OAAO,CAAC,OAAgC;QAC7C,OAAO;YACL,MAAM,EAAE,aAAW;YACnB,MAAM,EAAE,IAAI;YACZ,SAAS,EAAE;gBACT,EAAE,OAAO,EAAE,+BAAa,EAAE,QAAQ,EAAE,IAAA,uCAAqB,EAAC,OAAO,CAAC,EAAE;gBACpE,GAAG,sCAAoB;gBACvB,yCAAkB;gBAClB,yCAAkB;gBAClB,mCAAoB;aACrB;YACD,OAAO,EAAE,iBAAiB;SAC3B,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,YAAY,CAAC,OAAgC;QAClD,MAAM,cAAc,GAAe,OAAO,CAAC,QAAQ;YACjD,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC;YAC7D,CAAC,CAAC,EAAE,CAAC;QACP,OAAO;YACL,MAAM,EAAE,aAAW;YACnB,MAAM,EAAE,IAAI;YACZ,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,SAAS,EAAE;gBACT,GAAG,cAAc;gBACjB,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC;gBACxC,GAAG,sCAAoB;gBACvB,yCAAkB;gBAClB,yCAAkB;gBAClB,mCAAoB;aACrB;YACD,OAAO,EAAE,iBAAiB;SAC3B,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,0BAA0B,CAAC,OAAgC;QACxE,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;YACvB,OAAO;gBACL,OAAO,EAAE,+BAAa;gBACtB,UAAU,EAAE,KAAK,EAAE,GAAG,IAAW,EAAE,EAAE,CACnC,IAAA,uCAAqB,EAAC,MAAM,OAAO,CAAC,UAAW,CAAC,GAAG,IAAI,CAAC,CAAC;gBAC3D,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,EAAE;aAC7B,CAAC;QACJ,CAAC;QACD,MAAM,YAAY,GAAG,OAAO,CAAC,WAAW,IAAI,OAAO,CAAC,QAAQ,CAAC;QAC7D,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;QAChF,CAAC;QACD,OAAO;YACL,OAAO,EAAE,+BAAa;YACtB,UAAU,EAAE,KAAK,EAAE,OAA4B,EAAE,EAAE,CACjD,IAAA,uCAAqB,EAAC,MAAM,OAAO,CAAC,kBAAkB,EAAE,CAAC;YAC3D,MAAM,EAAE,CAAC,YAAY,CAAC;SACvB,CAAC;IACJ,CAAC;CACF,CAAA;AAxDY,kCAAW;sBAAX,WAAW;IADvB,IAAA,eAAM,EAAC,EAAE,CAAC;GACE,WAAW,CAwDvB"}

package/dist/nacos.providers.d.ts

@@ -1,7 +1,9 @@
 import { Provider } from '@nestjs/common';
 import { NacosConfigClient, NacosNamingClient } from 'nacos';
-import { NacosModuleOptions } from './nacos.interfaces';
+import { NacosModuleOptions, NacosModuleOptionsInput } from './nacos.interfaces';
 export declare function createNamingClient(options: NacosModuleOptions['naming']): NacosNamingClient | null;
 export declare function createConfigClient(options: NacosModuleOptions['config']): NacosConfigClient | null;
+/** Expands the simple shared connection fields into SDK-specific options. */
+export declare function normalizeNacosOptions(input: NacosModuleOptionsInput): NacosModuleOptions;
 export declare const nacosClientProviders: Provider[];
 //# sourceMappingURL=nacos.providers.d.ts.map

package/dist/nacos.providers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"nacos.providers.d.ts","sourceRoot":"","sources":["../src/nacos.providers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,OAAO,CAAC;AAE7D,OAAO,EAAE,kBAAkB,EAAkB,MAAM,oBAAoB,CAAC;AAWxE,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,kBAAkB,CAAC,QAAQ,CAAC,GAAG,iBAAiB,GAAG,IAAI,CAclG;AAED,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,kBAAkB,CAAC,QAAQ,CAAC,GAAG,iBAAiB,GAAG,IAAI,CAelG;AAUD,eAAO,MAAM,oBAAoB,EAAE,QAAQ,EAW1C,CAAC"}
+{"version":3,"file":"nacos.providers.d.ts","sourceRoot":"","sources":["../src/nacos.providers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,OAAO,CAAC;AAE7D,OAAO,EACL,kBAAkB,EAClB,uBAAuB,EAExB,MAAM,oBAAoB,CAAC;AAW5B,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,kBAAkB,CAAC,QAAQ,CAAC,GAAG,iBAAiB,GAAG,IAAI,CAclG;AAED,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,kBAAkB,CAAC,QAAQ,CAAC,GAAG,iBAAiB,GAAG,IAAI,CAelG;AAED,6EAA6E;AAC7E,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,uBAAuB,GAAG,kBAAkB,CAwBxF;AAUD,eAAO,MAAM,oBAAoB,EAAE,QAAQ,EAW1C,CAAC"}

package/dist/nacos.providers.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.nacosClientProviders = void 0;
 exports.createNamingClient = createNamingClient;
 exports.createConfigClient = createConfigClient;
+exports.normalizeNacosOptions = normalizeNacosOptions;
 const common_1 = require("@nestjs/common");
 const nacos_1 = require("nacos");
 const nacos_constants_1 = require("./nacos.constants");
@@ -47,6 +48,30 @@ function createConfigClient(options) {
         signatureRegionId: options.signatureRegionId,
     });
 }
+/** Expands the simple shared connection fields into SDK-specific options. */
+function normalizeNacosOptions(input) {
+    const options = typeof input === 'string'
+        ? { serverAddr: input }
+        : input;
+    const sharedAddress = options.serverAddr;
+    const shared = {
+        namespace: options.namespace,
+        username: options.username,
+        password: options.password,
+        ssl: options.ssl,
+    };
+    const naming = options.naming
+        ? { ...shared, ...options.naming }
+        : sharedAddress
+            ? { ...shared, serverList: sharedAddress }
+            : undefined;
+    const config = options.config
+        ? { ...shared, ...options.config }
+        : sharedAddress
+            ? { ...shared, serverAddr: sharedAddress }
+            : undefined;
+    return { ...options, naming, config };
+}
 function assertSupportedTransport(transport) {
     if (transport === 'grpc') {
         throw new Error('transport "grpc" is not supported: nacos@2.6.x only implements the Nacos HTTP OpenAPI');

package/dist/nacos.providers.js.map

@@ -1 +1 @@
-{"version":3,"file":"nacos.providers.js","sourceRoot":"","sources":["../src/nacos.providers.ts"],"names":[],"mappings":";;;AAcA,gDAcC;AAED,gDAeC;AA7CD,2CAAkD;AAClD,iCAA6D;AAC7D,uDAA4F;AAG5F,MAAM,UAAU,GAAG,IAAI,eAAM,CAAC,OAAO,CAAC,CAAC;AACvC,MAAM,WAAW,GAAG;IAClB,IAAI,EAAE,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACxD,IAAI,EAAE,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACzD,KAAK,EAAE,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC3D,KAAK,EAAE,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC3D,GAAG,EAAE,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;CACxD,CAAC;AAEF,SAAgB,kBAAkB,CAAC,OAAqC;IACtE,IAAI,CAAC,OAAO;QAAE,OAAO,IAAI,CAAC;IAC1B,wBAAwB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAC5C,OAAO,IAAI,yBAAiB,CAAC;QAC3B,MAAM,EAAE,WAAW;QACnB,UAAU,EAAE,OAAO,CAAC,UAAU;QAC9B,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,QAAQ;QACxC,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,GAAG,EAAE,OAAO,CAAC,GAAG;QAChB,EAAE,EAAE,OAAO,CAAC,EAAE;QACd,EAAE,EAAE,OAAO,CAAC,EAAE;QACd,OAAO,EAAE,OAAO,CAAC,OAAO;KAClB,CAAC,CAAC;AACZ,CAAC;AAED,SAAgB,kBAAkB,CAAC,OAAqC;IACtE,IAAI,CAAC,OAAO;QAAE,OAAO,IAAI,CAAC;IAC1B,wBAAwB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAC5C,OAAO,IAAI,yBAAiB,CAAC;QAC3B,UAAU,EAAE,OAAO,CAAC,UAAU;QAC9B,sEAAsE;QACtE,2EAA2E;QAC3E,SAAS,EAAE,CAAC,OAAO,CAAC,SAAS,IAAI,OAAO,CAAC,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS;QAC/F,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,GAAG,EAAE,OAAO,CAAC,GAAG;QAChB,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,iBAAiB,EAAE,OAAO,CAAC,iBAAiB;KACtC,CAAC,CAAC;AACZ,CAAC;AAED,SAAS,wBAAwB,CAAC,SAA0B;IAC1D,IAAI,SAAS,KAAK,MAAM,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CACb,uFAAuF,CACxF,CAAC;IACJ,CAAC;AACH,CAAC;AAEY,QAAA,oBAAoB,GAAe;IAC9C;QACE,OAAO,EAAE,qCAAmB;QAC5B,UAAU,EAAE,CAAC,OAA2B,EAAE,EAAE,CAAC,kBAAkB,CAAC,OAAO,EAAE,MAAM,CAAC;QAChF,MAAM,EAAE,CAAC,+BAAa,CAAC;KACxB;IACD;QACE,OAAO,EAAE,qCAAmB;QAC5B,UAAU,EAAE,CAAC,OAA2B,EAAE,EAAE,CAAC,kBAAkB,CAAC,OAAO,EAAE,MAAM,CAAC;QAChF,MAAM,EAAE,CAAC,+BAAa,CAAC;KACxB;CACF,CAAC"}
+{"version":3,"file":"nacos.providers.js","sourceRoot":"","sources":["../src/nacos.providers.ts"],"names":[],"mappings":";;;AAkBA,gDAcC;AAED,gDAeC;AAGD,sDAwBC;AA5ED,2CAAkD;AAClD,iCAA6D;AAC7D,uDAA4F;AAO5F,MAAM,UAAU,GAAG,IAAI,eAAM,CAAC,OAAO,CAAC,CAAC;AACvC,MAAM,WAAW,GAAG;IAClB,IAAI,EAAE,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACxD,IAAI,EAAE,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACzD,KAAK,EAAE,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC3D,KAAK,EAAE,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC3D,GAAG,EAAE,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;CACxD,CAAC;AAEF,SAAgB,kBAAkB,CAAC,OAAqC;IACtE,IAAI,CAAC,OAAO;QAAE,OAAO,IAAI,CAAC;IAC1B,wBAAwB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAC5C,OAAO,IAAI,yBAAiB,CAAC;QAC3B,MAAM,EAAE,WAAW;QACnB,UAAU,EAAE,OAAO,CAAC,UAAU;QAC9B,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,QAAQ;QACxC,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,GAAG,EAAE,OAAO,CAAC,GAAG;QAChB,EAAE,EAAE,OAAO,CAAC,EAAE;QACd,EAAE,EAAE,OAAO,CAAC,EAAE;QACd,OAAO,EAAE,OAAO,CAAC,OAAO;KAClB,CAAC,CAAC;AACZ,CAAC;AAED,SAAgB,kBAAkB,CAAC,OAAqC;IACtE,IAAI,CAAC,OAAO;QAAE,OAAO,IAAI,CAAC;IAC1B,wBAAwB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAC5C,OAAO,IAAI,yBAAiB,CAAC;QAC3B,UAAU,EAAE,OAAO,CAAC,UAAU;QAC9B,sEAAsE;QACtE,2EAA2E;QAC3E,SAAS,EAAE,CAAC,OAAO,CAAC,SAAS,IAAI,OAAO,CAAC,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS;QAC/F,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,GAAG,EAAE,OAAO,CAAC,GAAG;QAChB,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,iBAAiB,EAAE,OAAO,CAAC,iBAAiB;KACtC,CAAC,CAAC;AACZ,CAAC;AAED,6EAA6E;AAC7E,SAAgB,qBAAqB,CAAC,KAA8B;IAClE,MAAM,OAAO,GAAuB,OAAO,KAAK,KAAK,QAAQ;QAC3D,CAAC,CAAC,EAAE,UAAU,EAAE,KAAK,EAAE;QACvB,CAAC,CAAC,KAAK,CAAC;IACV,MAAM,aAAa,GAAG,OAAO,CAAC,UAAU,CAAC;IACzC,MAAM,MAAM,GAAG;QACb,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,GAAG,EAAE,OAAO,CAAC,GAAG;KACjB,CAAC;IAEF,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM;QAC3B,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE;QAClC,CAAC,CAAC,aAAa;YACb,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,UAAU,EAAE,aAAa,EAAE;YAC1C,CAAC,CAAC,SAAS,CAAC;IAChB,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM;QAC3B,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE;QAClC,CAAC,CAAC,aAAa;YACb,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,UAAU,EAAE,aAAa,EAAE;YAC1C,CAAC,CAAC,SAAS,CAAC;IAEhB,OAAO,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;AACxC,CAAC;AAED,SAAS,wBAAwB,CAAC,SAA0B;IAC1D,IAAI,SAAS,KAAK,MAAM,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CACb,uFAAuF,CACxF,CAAC;IACJ,CAAC;AACH,CAAC;AAEY,QAAA,oBAAoB,GAAe;IAC9C;QACE,OAAO,EAAE,qCAAmB;QAC5B,UAAU,EAAE,CAAC,OAA2B,EAAE,EAAE,CAAC,kBAAkB,CAAC,OAAO,EAAE,MAAM,CAAC;QAChF,MAAM,EAAE,CAAC,+BAAa,CAAC;KACxB;IACD;QACE,OAAO,EAAE,qCAAmB;QAC5B,UAAU,EAAE,CAAC,OAA2B,EAAE,EAAE,CAAC,kBAAkB,CAAC,OAAO,EAAE,MAAM,CAAC;QAChF,MAAM,EAAE,CAAC,+BAAa,CAAC;KACxB;CACF,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@danqiusheng/nest-nacos",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "NestJS Nacos 2.x configuration and service-discovery integration",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -15,8 +15,10 @@
     "build": "rimraf dist && tsc",
     "test": "npm run test:unit",
     "test:unit": "ts-node test/unit.ts",
+    "test:simple-e2e": "ts-node test/simple-options.e2e.ts",
+    "typecheck:example": "tsc --project tsconfig.example.json --noEmit",
     "start:example": "ts-node example/app.module.ts",
-    "prepublishOnly": "npm run build && npm test"
+    "prepublishOnly": "npm run build && npm test && npm run typecheck:example"
   },
   "dependencies": {
     "js-yaml": "^4.3.0",