@nestjs-redisx/core 1.0.1 → 1.0.3

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Provider, Type, ModuleMetadata, DynamicModule, OnModuleDestroy, Logger, OnModuleInit } from '@nestjs/common';
+import { Type, DynamicModule, ForwardReference, InjectionToken, Provider, ModuleMetadata, OnModuleDestroy, Logger, OnModuleInit } from '@nestjs/common';
 import { ModuleRef } from '@nestjs/core';
 import EventEmitter from 'events';
 import Redis, { Cluster } from 'ioredis';
@@ -139,6 +139,38 @@ interface IRedisDriver$1 {
     pipeline(): unknown;
 }
 
+/**
+ * Async configuration options for plugins.
+ * Allows plugins to receive configuration from NestJS DI (e.g., ConfigService).
+ *
+ * @example
+ * ```typescript
+ * CachePlugin.registerAsync({
+ *   imports: [ConfigModule],
+ *   inject: [ConfigService],
+ *   useFactory: (config: ConfigService) => ({
+ *     l1: { maxSize: config.get('CACHE_L1_MAX_SIZE') },
+ *     swr: { enabled: config.get('CACHE_SWR_ENABLED') },
+ *   }),
+ * })
+ * ```
+ */
+interface IPluginAsyncOptions<T = unknown> {
+    /**
+     * Optional modules to import (e.g., ConfigModule).
+     * Only needed if the injected services are not globally available.
+     */
+    imports?: Array<Type<unknown> | DynamicModule | ForwardReference>;
+    /**
+     * Dependencies to inject into the factory function.
+     */
+    inject?: InjectionToken[];
+    /**
+     * Factory function that returns plugin options.
+     * Receives injected dependencies as arguments.
+     */
+    useFactory: (...args: unknown[]) => T | Promise<T>;
+}
 /**
  * Base interface for all RedisX plugins.
  *
@@ -224,6 +256,11 @@ interface IRedisXPlugin {
      * Typically the main service of the plugin.
      */
     getExports?(): Array<Provider | string | symbol | Type>;
+    /**
+     * Returns NestJS modules to import.
+     * Used by registerAsync() to make injected services available.
+     */
+    getImports?(): Array<Type<unknown> | DynamicModule | ForwardReference>;
     /**
      * Returns NestJS controllers this plugin contributes.
      * Controllers handle HTTP endpoints.
@@ -4914,4 +4951,4 @@ type DeepRequired<T> = {
     [P in keyof T]-?: T[P] extends object ? DeepRequired<T[P]> : T[P];
 };
 
-export { type AsyncFunction, BaseRedisDriver, CLIENT_MANAGER, CommandError, type ConnectionConfig, ConnectionError, ConnectionStatus, DEFAULT_CLIENT_NAME, DEFAULT_COMMAND_TIMEOUT, DEFAULT_CONNECTION_TIMEOUT, DEFAULT_DRIVER_TYPE, DEFAULT_GRACEFUL_SHUTDOWN_TIMEOUT, DEFAULT_HEALTH_CHECK_INTERVAL, type DeepPartial, type DeepRequired, DriverError, DriverEvent, type DriverEventHandler, DriverFactory, type DriverType, ErrorCode, type GeoUnit, type IBaseConnectionConfig, type IClientHealthStatus, type IClientManager, type IClientMetadata, type IClientStats, type IClusterConnectionConfig, type IConnectionStats, type ICopyOptions, type IDriverFactoryOptions, type IErrorJSON, type IGeoSearchOptions, type IGeoSearchResult, type IGlobalConfig, type IHealthCheckResult, type IHealthStatus, type ILposOptions, type IManagerEventData, type IMulti, type IPipeline, type IPluginContext, type IReconnectionOptions, type IRedisClient, type IRedisClientOptions, type IRedisDriver, type IRedisDriverManager, type IRedisModuleAsyncOptions, type IRedisModuleOptions, type IRedisModuleOptionsFactory, type IRedisXPlugin, type IRestoreOptions, type IScanOptions, type ISentinelConnectionConfig, type ISetOptions, type ISingleConnectionConfig, type IStreamAddOptions, type IStreamEntry, type IStreamInfo, type IStreamPendingEntry, type IStreamPendingInfo, type IStreamReadGroupOptions, type IStreamReadOptions, type ITlsConfig, type IZRangeByScoreOptions, type IZStoreOptions, InjectRedis, IoRedisAdapter, MODULE_NAME, ManagerEvent, type ManagerEventHandler, NodeRedisAdapter, type Nullable, type Optional, PLUGIN_REGISTRY, PluginRegistryService, REDISX_CONFIG, REDISX_LOGGER, REDIS_CLIENT, REDIS_CLIENTS_INITIALIZATION, REDIS_CLIENTS_MAP, REDIS_DRIVER, REDIS_MODULE_OPTIONS, REGISTERED_PLUGINS, RedisAuthError, RedisClientManager, RedisClusterError, RedisConfigError, RedisConnectionError, RedisInvalidArgsError, RedisKeyNotFoundError, RedisMaxRetriesError, RedisModule, RedisNotConnectedError, RedisNotSupportedError, RedisOperationError, RedisOutOfMemoryError, RedisPipelineError, RedisPoolExhaustedError, RedisReadOnlyError, RedisScriptError, RedisSentinelError, RedisService, RedisTLSError, RedisTimeoutError, RedisTransactionError, RedisTypeMismatchError, RedisValidationError, RedisXError, type StreamReadResult, TimeoutError, ValidationErrorCollector, createDriver, createDrivers, detectAvailableDriver, getClientToken, getDriverToken, getErrorDomain, getRecommendedDriver, hasClass, hasExisting, hasFactory, isClusterConnection, isErrorCode, isErrorDomain, isSentinelConnection, isSingleConnection };
+export { type AsyncFunction, BaseRedisDriver, CLIENT_MANAGER, CommandError, type ConnectionConfig, ConnectionError, ConnectionStatus, DEFAULT_CLIENT_NAME, DEFAULT_COMMAND_TIMEOUT, DEFAULT_CONNECTION_TIMEOUT, DEFAULT_DRIVER_TYPE, DEFAULT_GRACEFUL_SHUTDOWN_TIMEOUT, DEFAULT_HEALTH_CHECK_INTERVAL, type DeepPartial, type DeepRequired, DriverError, DriverEvent, type DriverEventHandler, DriverFactory, type DriverType, ErrorCode, type GeoUnit, type IBaseConnectionConfig, type IClientHealthStatus, type IClientManager, type IClientMetadata, type IClientStats, type IClusterConnectionConfig, type IConnectionStats, type ICopyOptions, type IDriverFactoryOptions, type IErrorJSON, type IGeoSearchOptions, type IGeoSearchResult, type IGlobalConfig, type IHealthCheckResult, type IHealthStatus, type ILposOptions, type IManagerEventData, type IMulti, type IPipeline, type IPluginAsyncOptions, type IPluginContext, type IReconnectionOptions, type IRedisClient, type IRedisClientOptions, type IRedisDriver, type IRedisDriverManager, type IRedisModuleAsyncOptions, type IRedisModuleOptions, type IRedisModuleOptionsFactory, type IRedisXPlugin, type IRestoreOptions, type IScanOptions, type ISentinelConnectionConfig, type ISetOptions, type ISingleConnectionConfig, type IStreamAddOptions, type IStreamEntry, type IStreamInfo, type IStreamPendingEntry, type IStreamPendingInfo, type IStreamReadGroupOptions, type IStreamReadOptions, type ITlsConfig, type IZRangeByScoreOptions, type IZStoreOptions, InjectRedis, IoRedisAdapter, MODULE_NAME, ManagerEvent, type ManagerEventHandler, NodeRedisAdapter, type Nullable, type Optional, PLUGIN_REGISTRY, PluginRegistryService, REDISX_CONFIG, REDISX_LOGGER, REDIS_CLIENT, REDIS_CLIENTS_INITIALIZATION, REDIS_CLIENTS_MAP, REDIS_DRIVER, REDIS_MODULE_OPTIONS, REGISTERED_PLUGINS, RedisAuthError, RedisClientManager, RedisClusterError, RedisConfigError, RedisConnectionError, RedisInvalidArgsError, RedisKeyNotFoundError, RedisMaxRetriesError, RedisModule, RedisNotConnectedError, RedisNotSupportedError, RedisOperationError, RedisOutOfMemoryError, RedisPipelineError, RedisPoolExhaustedError, RedisReadOnlyError, RedisScriptError, RedisSentinelError, RedisService, RedisTLSError, RedisTimeoutError, RedisTransactionError, RedisTypeMismatchError, RedisValidationError, RedisXError, type StreamReadResult, TimeoutError, ValidationErrorCollector, createDriver, createDrivers, detectAvailableDriver, getClientToken, getDriverToken, getErrorDomain, getRecommendedDriver, hasClass, hasExisting, hasFactory, isClusterConnection, isErrorCode, isErrorDomain, isSentinelConnection, isSingleConnection };

package/dist/index.js

@@ -4718,6 +4718,7 @@ var RedisModule = class {
     const pluginProviders = [];
     const pluginExports = [];
     const pluginControllers = [];
+    const pluginImports = [];
     if (options.plugins && options.plugins.length > 0) {
       options.plugins.forEach((plugin) => {
         if (plugin.getProviders) {
@@ -4732,6 +4733,12 @@ var RedisModule = class {
             pluginExports.push(...exports2);
           }
         }
+        if (plugin.getImports) {
+          const imports = plugin.getImports();
+          if (Array.isArray(imports)) {
+            pluginImports.push(...imports);
+          }
+        }
         if (plugin.getControllers) {
           const controllers = plugin.getControllers();
           if (Array.isArray(controllers)) {
@@ -4744,7 +4751,7 @@ var RedisModule = class {
     return {
       module: RedisModule,
       global: true,
-      imports: [import_core.DiscoveryModule],
+      imports: [import_core.DiscoveryModule, ...pluginImports],
       // Required for plugins that scan providers (e.g., CachePlugin)
       providers: [...providers, ...pluginProviders, { provide: REGISTERED_PLUGINS, useValue: plugins }, PluginRegistryService, RedisService],
       controllers: pluginControllers,
@@ -4805,6 +4812,7 @@ var RedisModule = class {
     const pluginProviders = [];
     const pluginExports = [];
     const pluginControllers = [];
+    const pluginImports = [];
     if (plugins.length > 0) {
       plugins.forEach((plugin) => {
         if (plugin.getProviders) {
@@ -4819,6 +4827,12 @@ var RedisModule = class {
             pluginExports.push(...exports2);
           }
         }
+        if (plugin.getImports) {
+          const pluginModules = plugin.getImports();
+          if (Array.isArray(pluginModules)) {
+            pluginImports.push(...pluginModules);
+          }
+        }
         if (plugin.getControllers) {
           const controllers = plugin.getControllers();
           if (Array.isArray(controllers)) {
@@ -4830,7 +4844,7 @@ var RedisModule = class {
     return {
       module: RedisModule,
       global: true,
-      imports: [import_core.DiscoveryModule, ...imports],
+      imports: [import_core.DiscoveryModule, ...imports, ...pluginImports],
       // DiscoveryModule required for plugins
       providers: [...baseProviders, ...pluginProviders, { provide: REGISTERED_PLUGINS, useValue: plugins }, PluginRegistryService, RedisService],
       controllers: pluginControllers,