@alpha018/nestjs-redisom 1.0.1 → 1.1.0

package/README.md

@@ -18,20 +18,23 @@
   <a href="https://github.com/Alpha018/nestjs-redisom">
     <img src="https://img.shields.io/github/stars/Alpha018/nestjs-redisom?style=social" alt="GitHub stars">
   </a>
+  <a href="https://www.buymeacoffee.com/alpha018" target="_blank">
+    <img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" height="20px">
+  </a>
 </div>
 
-
 ## Description
 
 This library seamlessly integrates [RedisOM](https://redis.io/docs/latest/integrate/redisom-for-node-js/) into NestJS, offering:
--   **Decorator-based Schema Definition**: Define your entities using `@Schema` and `@Prop`.
--   **Repository Injection**: Inject repositories directly into your services using `@InjectRepository`.
--   **Seamless Connection**: Configure your Redis connection globally with `forRoot` or `forRootAsync`.
+
+- **Decorator-based Schema Definition**: Define your entities using `@Schema` and `@Prop`.
+- **Repository Injection**: Inject repositories directly into your services using `@InjectRepository`.
+- **Seamless Connection**: Configure your Redis connection globally with `forRoot` or `forRootAsync`.
 
 ## Installation
 
 ```bash
-$ npm install nestjs-redisom redis-om redis
+npm install @alpha018/nestjs-redisom redis-om redis
 ```
 
 ## Quick Start
@@ -55,6 +58,8 @@ export class CatEntity extends BaseEntity {
 }
 ```
 
+> **Note**: For all available property decorators, indexing options, and schema definitions, see the [Wiki: Defining Structures](https://github.com/Alpha018/nestjs-redisom/wiki/Defining-Structures).
+
 ### 2. Import the Module
 
 Register `RedisOmModule` in your root `AppModule` and register your entities with `forFeature`.
@@ -75,6 +80,8 @@ import { CatEntity } from './cat.entity';
 export class AppModule {}
 ```
 
+> **Note**: For advanced connection setups, environmental validation, and asynchronous options, see the [Wiki: Configuration](https://github.com/Alpha018/nestjs-redisom/wiki/Configuration).
+
 ### 3. Usage in a Service
 
 Inject the repository to save and search for entities.
@@ -104,6 +111,8 @@ export class CatsService {
 }
 ```
 
+> **Note**: To learn about all search capabilities and query building, see the [Wiki: Searching](https://github.com/Alpha018/nestjs-redisom/wiki/Searching).
+
 ## Advanced Usage
 
 ### 1. Nested Typed Objects
@@ -150,6 +159,8 @@ const results = await this.personRepo.search()
   .return.all();
 ```
 
+> **Note**: Discover more about embedded objects and array structures in the [Wiki: Defining Structures](https://github.com/Alpha018/nestjs-redisom/wiki/Defining-Structures).
+
 ### 2. Custom IDs
 
 You can explicitly set the ID when saving an entity if you don't want to use the auto-generated ULID. This is useful for using existing IDs (like UUIDs, emails, or external system IDs).
@@ -164,6 +175,8 @@ await this.catRepo.save(id, entity);
 await this.catRepo.save('unique-custom-id', entity);
 ```
 
+> **Note**: Read more about identifier strategies in the [Wiki: Defining Structures](https://github.com/Alpha018/nestjs-redisom/wiki/Defining-Structures).
+
 ### 3. TTL (Time To Live)
 
 You can set an expiration time (in seconds) for an entity. The key will automatically be deleted from Redis after the specified time.
@@ -176,6 +189,8 @@ await this.catRepo.save(id, sessionEntity);
 await this.catRepo.expire(id, 60);
 ```
 
+> **Note**: See entity expiration patterns in the [Wiki: Defining Structures](https://github.com/Alpha018/nestjs-redisom/wiki/Defining-Structures).
+
 ### 4. TLS Connection (Production / Cloud)
 
 For secure connections (e.g., AWS ElastiCache, Redis Cloud), use the `rediss://` protocol and provide TLS options in the `socket` configuration.
@@ -211,19 +226,43 @@ RedisOmModule.forRootAsync({
 })
 ```
 
+> **Note**: Find more cloud connection examples in the [Wiki: Configuration](https://github.com/Alpha018/nestjs-redisom/wiki/Configuration).
+
+### 5. Redis Cluster (Cluster Mode Enabled)
+
+`nestjs-redisom` natively supports connecting to a Redis Cluster using the underlying `createCluster` functionality of Node-Redis.
+
+Instead of providing a single `url`, you provide an array of `rootNodes`:
+
+```typescript
+RedisOmModule.forRoot({
+  rootNodes: [
+    { url: 'redis://redis-cluster-node-1:7000' },
+    { url: 'redis://redis-cluster-node-2:7000' }
+  ],
+  defaults: {
+    password: 'your-cluster-password'
+  }
+})
+```
+
+> **Note**: For full details on how the Node-Redis client uses these initial nodes for cluster auto-discovery (`CLUSTER SLOTS`), please refer to the [Configuration Wiki](https://github.com/Alpha018/nestjs-redisom/wiki/Configuration).
+
 ## Features
 
--   **Schema Factory**: Automatically generates RedisOM schemas from your class metadata.
--   **Nested Objects**: Support for typed nested objects with automatic schema flattening.
--   **Async Configuration**: Supports `useFactory`, `useClass`, and `useExisting` for configuration.
--   **Validation**: Compatible with `class-validator` (standard NestJS practice).
+- **Schema Factory**: Automatically generates RedisOM schemas from your class metadata.
+- **Nested Objects**: Support for typed nested objects with automatic schema flattening.
+- **Async Configuration**: Supports `useFactory`, `useClass`, and `useExisting` for configuration.
+- **Validation**: Compatible with `class-validator` (standard NestJS practice).
 
 ## Performance & Search Mechanics
 
 This library leverages **RediSearch** (module of Redis Stack), meaning searches are **efficient and non-blocking**.
 
 ### 1. How Search Works
+
 When you use `@Prop({ indexed: true })`, Redis OM creates an **Inverted Index**.
+
 - **Search**: `repo.search()...` queries this index directly. It does **NOT** perform a linear scan (SCAN command) over the keyspace.
 - **Complexity**: Searches are typically **O(K)** (where K is the number of results) or **O(log N)** for range queries. Retrieving by ID is **O(1)**.
 
@@ -238,6 +277,7 @@ When you use `@Prop({ indexed: true })`, Redis OM creates an **Inverted Index**.
 | **Geo** | Radius / Polygon | **O(K + log N)** | Geospacial indexing. |
 
 ### 2. Resource Usage
+
 - **Memory (RAM)**: Indexes consume additional memory. **Best Practice:** Only index fields that you intend to filter by.
 - **CPU**: Search operations are highly optimized. Initial indexing of a large existing dataset may temporarily consume CPU, but incremental updates (`save`) are lightweight.
 
@@ -245,8 +285,8 @@ When you use `@Prop({ indexed: true })`, Redis OM creates an **Inverted Index**.
 
 Check out a few resources that may come in handy when working with NestJS:
 
--   Visit the [NestJS Documentation](https://docs.nestjs.com) to learn more about the framework.
--   Visualize your application graph and interact with the NestJS application in real-time using [NestJS Devtools](https://devtools.nestjs.com).
+- Visit the [NestJS Documentation](https://docs.nestjs.com) to learn more about the framework.
+- Visualize your application graph and interact with the NestJS application in real-time using [NestJS Devtools](https://devtools.nestjs.com).
 
 ## Support
 
@@ -254,7 +294,7 @@ Nest is an MIT-licensed open source project. It can grow thanks to the sponsors
 
 ## Stay in touch
 
--   Author - [Tomás Alegre](https://github.com/Alpha018)
+- Author - [Tomás Alegre](https://github.com/Alpha018)
 
 ## License
 

package/dist/index.d.ts

@@ -5,3 +5,4 @@ export * from './redis-om/redis-om-core.module';
 export * from './redis-om/common/base.entity';
 export * from './redis-om/redis-om.module';
 export * from './redis-om/interfaces';
+export * from './redis-om/errors';

package/dist/index.js

@@ -21,4 +21,5 @@ __exportStar(require("./redis-om/redis-om-core.module"), exports);
 __exportStar(require("./redis-om/common/base.entity"), exports);
 __exportStar(require("./redis-om/redis-om.module"), exports);
 __exportStar(require("./redis-om/interfaces"), exports);
+__exportStar(require("./redis-om/errors"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oFAAkE;AAClE,yEAAuD;AACvD,uEAAqD;AACrD,kEAAgD;AAChD,gEAA8C;AAC9C,6DAA2C;AAC3C,wDAAsC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oFAAkE;AAClE,yEAAuD;AACvD,uEAAqD;AACrD,kEAAgD;AAChD,gEAA8C;AAC9C,6DAA2C;AAC3C,wDAAsC;AACtC,oDAAkC"}

package/dist/redis-om/errors/index.d.ts

@@ -0,0 +1,3 @@
+export { RedisOmIndexCreationFailedException, RedisOmIndexAlreadyExistsException, RedisOmUnsupportedCommandException, RedisOmConnectionFailedException, RedisOmUnexpectedException, } from './redis-om.exceptions';
+export { RedisOmErrorCode } from './redis-om-error.code';
+export { RedisOmException } from './redis-om.exception';

package/dist/redis-om/errors/index.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedisOmException = exports.RedisOmErrorCode = exports.RedisOmUnexpectedException = exports.RedisOmConnectionFailedException = exports.RedisOmUnsupportedCommandException = exports.RedisOmIndexAlreadyExistsException = exports.RedisOmIndexCreationFailedException = void 0;
+var redis_om_exceptions_1 = require("./redis-om.exceptions");
+Object.defineProperty(exports, "RedisOmIndexCreationFailedException", { enumerable: true, get: function () { return redis_om_exceptions_1.RedisOmIndexCreationFailedException; } });
+Object.defineProperty(exports, "RedisOmIndexAlreadyExistsException", { enumerable: true, get: function () { return redis_om_exceptions_1.RedisOmIndexAlreadyExistsException; } });
+Object.defineProperty(exports, "RedisOmUnsupportedCommandException", { enumerable: true, get: function () { return redis_om_exceptions_1.RedisOmUnsupportedCommandException; } });
+Object.defineProperty(exports, "RedisOmConnectionFailedException", { enumerable: true, get: function () { return redis_om_exceptions_1.RedisOmConnectionFailedException; } });
+Object.defineProperty(exports, "RedisOmUnexpectedException", { enumerable: true, get: function () { return redis_om_exceptions_1.RedisOmUnexpectedException; } });
+var redis_om_error_code_1 = require("./redis-om-error.code");
+Object.defineProperty(exports, "RedisOmErrorCode", { enumerable: true, get: function () { return redis_om_error_code_1.RedisOmErrorCode; } });
+var redis_om_exception_1 = require("./redis-om.exception");
+Object.defineProperty(exports, "RedisOmException", { enumerable: true, get: function () { return redis_om_exception_1.RedisOmException; } });
+//# sourceMappingURL=index.js.map

package/dist/redis-om/errors/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/redis-om/errors/index.ts"],"names":[],"mappings":";;;AAAA,6DAM+B;AAL7B,0IAAA,mCAAmC,OAAA;AACnC,yIAAA,kCAAkC,OAAA;AAClC,yIAAA,kCAAkC,OAAA;AAClC,uIAAA,gCAAgC,OAAA;AAChC,iIAAA,0BAA0B,OAAA;AAE5B,6DAAyD;AAAhD,uHAAA,gBAAgB,OAAA;AACzB,2DAAwD;AAA/C,sHAAA,gBAAgB,OAAA"}

package/dist/redis-om/errors/redis-om-error.code.d.ts

@@ -0,0 +1,7 @@
+export declare enum RedisOmErrorCode {
+    INDEX_CREATION_FAILED = "REDIS_OM_INDEX_CREATION_FAILED",
+    INDEX_ALREADY_EXISTS = "REDIS_OM_INDEX_ALREADY_EXISTS",
+    UNSUPPORTED_COMMAND = "REDIS_OM_UNSUPPORTED_COMMAND",
+    CONNECTION_FAILED = "REDIS_OM_CONNECTION_FAILED",
+    UNEXPECTED_ERROR = "REDIS_OM_UNEXPECTED_ERROR"
+}

package/dist/redis-om/errors/redis-om-error.code.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedisOmErrorCode = void 0;
+var RedisOmErrorCode;
+(function (RedisOmErrorCode) {
+    RedisOmErrorCode["INDEX_CREATION_FAILED"] = "REDIS_OM_INDEX_CREATION_FAILED";
+    RedisOmErrorCode["INDEX_ALREADY_EXISTS"] = "REDIS_OM_INDEX_ALREADY_EXISTS";
+    RedisOmErrorCode["UNSUPPORTED_COMMAND"] = "REDIS_OM_UNSUPPORTED_COMMAND";
+    RedisOmErrorCode["CONNECTION_FAILED"] = "REDIS_OM_CONNECTION_FAILED";
+    RedisOmErrorCode["UNEXPECTED_ERROR"] = "REDIS_OM_UNEXPECTED_ERROR";
+})(RedisOmErrorCode || (exports.RedisOmErrorCode = RedisOmErrorCode = {}));
+//# sourceMappingURL=redis-om-error.code.js.map

package/dist/redis-om/errors/redis-om-error.code.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"redis-om-error.code.js","sourceRoot":"","sources":["../../../src/redis-om/errors/redis-om-error.code.ts"],"names":[],"mappings":";;;AAKA,IAAY,gBAMX;AAND,WAAY,gBAAgB;IAC1B,4EAAwD,CAAA;IACxD,0EAAsD,CAAA;IACtD,wEAAoD,CAAA;IACpD,oEAAgD,CAAA;IAChD,kEAA8C,CAAA;AAChD,CAAC,EANW,gBAAgB,gCAAhB,gBAAgB,QAM3B"}

package/dist/redis-om/errors/redis-om.exception.d.ts

@@ -0,0 +1,9 @@
+import { RedisOmErrorCode } from './redis-om-error.code';
+export declare abstract class RedisOmException extends Error {
+    static readonly code: RedisOmErrorCode;
+    static readonly pattern?: RegExp;
+    static readonly message: string;
+    readonly code: RedisOmErrorCode;
+    constructor(cause?: unknown);
+    static matches(msg: string): boolean;
+}

package/dist/redis-om/errors/redis-om.exception.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedisOmException = void 0;
+class RedisOmException extends Error {
+    static code;
+    static pattern;
+    static message;
+    code;
+    constructor(cause) {
+        const { message, code } = new.target;
+        super(message, cause !== undefined ? { cause } : undefined);
+        this.name = this.constructor.name;
+        this.code = code;
+    }
+    static matches(msg) {
+        return this.pattern?.test(msg) ?? false;
+    }
+}
+exports.RedisOmException = RedisOmException;
+//# sourceMappingURL=redis-om.exception.js.map

package/dist/redis-om/errors/redis-om.exception.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"redis-om.exception.js","sourceRoot":"","sources":["../../../src/redis-om/errors/redis-om.exception.ts"],"names":[],"mappings":";;;AAmBA,MAAsB,gBAAiB,SAAQ,KAAK;IAClD,MAAM,CAAU,IAAI,CAAmB;IAEvC,MAAM,CAAU,OAAO,CAAU;IACjC,MAAM,CAAU,OAAO,CAAS;IAEvB,IAAI,CAAmB;IAEhC,YAAY,KAAe;QACzB,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,GAAG,CAAC,MAAiC,CAAC;QAChE,KAAK,CAAC,OAAO,EAAE,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QAC5D,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;QAClC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAGD,MAAM,CAAC,OAAO,CAAC,GAAW;QACxB,OAAO,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC;IAC1C,CAAC;CACF;AAnBD,4CAmBC"}

package/dist/redis-om/errors/redis-om.exceptions.d.ts

@@ -0,0 +1,24 @@
+import { RedisOmErrorCode } from './redis-om-error.code';
+import { RedisOmException } from './redis-om.exception';
+export declare class RedisOmUnsupportedCommandException extends RedisOmException {
+    static readonly message = "Redis does not support this command \u2014 Redis Stack modules may not be loaded";
+    static readonly code = RedisOmErrorCode.UNSUPPORTED_COMMAND;
+    static readonly pattern: RegExp;
+}
+export declare class RedisOmIndexAlreadyExistsException extends RedisOmException {
+    static readonly message = "Redis OM index already exists and will be reused";
+    static readonly code = RedisOmErrorCode.INDEX_ALREADY_EXISTS;
+    static readonly pattern: RegExp;
+}
+export declare class RedisOmIndexCreationFailedException extends RedisOmException {
+    static readonly code = RedisOmErrorCode.INDEX_CREATION_FAILED;
+    static readonly message = "Failed to create Redis OM index";
+}
+export declare class RedisOmUnexpectedException extends RedisOmException {
+    static readonly message = "An unexpected Redis OM error occurred";
+    static readonly code = RedisOmErrorCode.UNEXPECTED_ERROR;
+}
+export declare class RedisOmConnectionFailedException extends RedisOmException {
+    static readonly code = RedisOmErrorCode.CONNECTION_FAILED;
+    static readonly message = "Failed to connect to Redis";
+}

package/dist/redis-om/errors/redis-om.exceptions.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedisOmConnectionFailedException = exports.RedisOmUnexpectedException = exports.RedisOmIndexCreationFailedException = exports.RedisOmIndexAlreadyExistsException = exports.RedisOmUnsupportedCommandException = void 0;
+const redis_om_error_code_1 = require("./redis-om-error.code");
+const redis_om_exception_1 = require("./redis-om.exception");
+class RedisOmUnsupportedCommandException extends redis_om_exception_1.RedisOmException {
+    static message = 'Redis does not support this command — Redis Stack modules may not be loaded';
+    static code = redis_om_error_code_1.RedisOmErrorCode.UNSUPPORTED_COMMAND;
+    static pattern = /unknown command/i;
+}
+exports.RedisOmUnsupportedCommandException = RedisOmUnsupportedCommandException;
+class RedisOmIndexAlreadyExistsException extends redis_om_exception_1.RedisOmException {
+    static message = 'Redis OM index already exists and will be reused';
+    static code = redis_om_error_code_1.RedisOmErrorCode.INDEX_ALREADY_EXISTS;
+    static pattern = /^Index already exists$/;
+}
+exports.RedisOmIndexAlreadyExistsException = RedisOmIndexAlreadyExistsException;
+class RedisOmIndexCreationFailedException extends redis_om_exception_1.RedisOmException {
+    static code = redis_om_error_code_1.RedisOmErrorCode.INDEX_CREATION_FAILED;
+    static message = 'Failed to create Redis OM index';
+}
+exports.RedisOmIndexCreationFailedException = RedisOmIndexCreationFailedException;
+class RedisOmUnexpectedException extends redis_om_exception_1.RedisOmException {
+    static message = 'An unexpected Redis OM error occurred';
+    static code = redis_om_error_code_1.RedisOmErrorCode.UNEXPECTED_ERROR;
+}
+exports.RedisOmUnexpectedException = RedisOmUnexpectedException;
+class RedisOmConnectionFailedException extends redis_om_exception_1.RedisOmException {
+    static code = redis_om_error_code_1.RedisOmErrorCode.CONNECTION_FAILED;
+    static message = 'Failed to connect to Redis';
+}
+exports.RedisOmConnectionFailedException = RedisOmConnectionFailedException;
+//# sourceMappingURL=redis-om.exceptions.js.map

package/dist/redis-om/errors/redis-om.exceptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"redis-om.exceptions.js","sourceRoot":"","sources":["../../../src/redis-om/errors/redis-om.exceptions.ts"],"names":[],"mappings":";;;AAAA,+DAAyD;AACzD,6DAAwD;AAOxD,MAAa,kCAAmC,SAAQ,qCAAgB;IACtE,MAAM,CAAmB,OAAO,GAC9B,6EAA6E,CAAC;IAChF,MAAM,CAAmB,IAAI,GAAG,sCAAgB,CAAC,mBAAmB,CAAC;IACrE,MAAM,CAAmB,OAAO,GAAG,kBAAkB,CAAC;;AAJxD,gFAKC;AAMD,MAAa,kCAAmC,SAAQ,qCAAgB;IACtE,MAAM,CAAmB,OAAO,GAC9B,kDAAkD,CAAC;IACrD,MAAM,CAAmB,IAAI,GAAG,sCAAgB,CAAC,oBAAoB,CAAC;IACtE,MAAM,CAAmB,OAAO,GAAG,wBAAwB,CAAC;;AAJ9D,gFAKC;AAMD,MAAa,mCAAoC,SAAQ,qCAAgB;IACvE,MAAM,CAAmB,IAAI,GAAG,sCAAgB,CAAC,qBAAqB,CAAC;IACvE,MAAM,CAAmB,OAAO,GAAG,iCAAiC,CAAC;;AAFvE,kFAGC;AAKD,MAAa,0BAA2B,SAAQ,qCAAgB;IAC9D,MAAM,CAAmB,OAAO,GAAG,uCAAuC,CAAC;IAC3E,MAAM,CAAmB,IAAI,GAAG,sCAAgB,CAAC,gBAAgB,CAAC;;AAFpE,gEAGC;AAKD,MAAa,gCAAiC,SAAQ,qCAAgB;IACpE,MAAM,CAAmB,IAAI,GAAG,sCAAgB,CAAC,iBAAiB,CAAC;IACnE,MAAM,CAAmB,OAAO,GAAG,4BAA4B,CAAC;;AAFlE,4EAGC"}

package/dist/redis-om/interfaces/index.d.ts

@@ -1,5 +1,5 @@
+import { RedisClusterOptions, RedisClientOptions } from 'redis';
 import { ModuleMetadata, Type } from '@nestjs/common';
-import { RedisClientOptions } from 'redis';
 export interface RedisOmModuleAsyncOptions extends Pick<ModuleMetadata, 'imports'> {
     useFactory?: (...args: any[]) => Promise<RedisOmModuleOptions> | RedisOmModuleOptions;
     useExisting?: Type<RedisOmOptionsFactory>;
@@ -13,4 +13,4 @@ export interface RedisOmModelDefinition {
 export interface RedisOmOptionsFactory {
     createRedisOmOptions(): Promise<RedisOmModuleOptions> | RedisOmModuleOptions;
 }
-export type RedisOmModuleOptions = RedisClientOptions;
+export type RedisOmModuleOptions = RedisClusterOptions | RedisClientOptions;

package/dist/redis-om/redis-om-core.module.d.ts

@@ -1,6 +1,9 @@
 import { OnApplicationShutdown, DynamicModule } from '@nestjs/common';
+import { RedisClusterType, RedisClientType } from 'redis';
 import { RedisOmModuleAsyncOptions, RedisOmModuleOptions } from './interfaces';
 export declare class RedisOmCoreModule implements OnApplicationShutdown {
+    private readonly redisClient;
+    constructor(redisClient: RedisClusterType | RedisClientType);
     static forRootAsync(options: RedisOmModuleAsyncOptions): DynamicModule;
     static forRoot(options: RedisOmModuleOptions): DynamicModule;
     private static createAsyncProviders;

package/dist/redis-om/redis-om-core.module.js

@@ -5,6 +5,12 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
 var RedisOmCoreModule_1;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RedisOmCoreModule = void 0;
@@ -13,6 +19,10 @@ const redis_1 = require("redis");
 const redis_om_constants_1 = require("./redis-om.constants");
 const redis_om_utils_1 = require("./common/redis-om.utils");
 let RedisOmCoreModule = RedisOmCoreModule_1 = class RedisOmCoreModule {
+    redisClient;
+    constructor(redisClient) {
+        this.redisClient = redisClient;
+    }
     static forRootAsync(options) {
         const asyncProviders = this.createAsyncProviders(options);
         return {
@@ -20,8 +30,9 @@ let RedisOmCoreModule = RedisOmCoreModule_1 = class RedisOmCoreModule {
                 ...asyncProviders,
                 {
                     useFactory: async (opt) => {
-                        const redisInfo = opt.url ? { ...opt } : opt;
-                        const redisClient = (0, redis_1.createClient)(redisInfo);
+                        const redisClient = opt.rootNodes
+                            ? (0, redis_1.createCluster)(opt)
+                            : (0, redis_1.createClient)(opt);
                         await redisClient.connect();
                         return redisClient;
                     },
@@ -37,8 +48,9 @@ let RedisOmCoreModule = RedisOmCoreModule_1 = class RedisOmCoreModule {
     static forRoot(options) {
         const redisOmConnectionProvider = {
             useFactory: async () => {
-                const redisInfo = options.url ? { ...options } : options;
-                const redisClient = (0, redis_1.createClient)(redisInfo);
+                const redisClient = options.rootNodes
+                    ? (0, redis_1.createCluster)(options)
+                    : (0, redis_1.createClient)(options);
                 await redisClient.connect();
                 return redisClient;
             },
@@ -62,11 +74,25 @@ let RedisOmCoreModule = RedisOmCoreModule_1 = class RedisOmCoreModule {
         }
         return [];
     }
-    async onApplicationShutdown() { }
+    async onApplicationShutdown() {
+        try {
+            const isOpen = this.redisClient?.isOpen;
+            const isReady = 'isReady' in this.redisClient
+                ? this.redisClient.isReady
+                : false;
+            if (isOpen || isReady) {
+                await this.redisClient.quit();
+            }
+        }
+        catch {
+        }
+    }
 };
 exports.RedisOmCoreModule = RedisOmCoreModule;
 exports.RedisOmCoreModule = RedisOmCoreModule = RedisOmCoreModule_1 = __decorate([
     (0, common_1.Module)({}),
-    (0, common_1.Global)()
+    (0, common_1.Global)(),
+    __param(0, (0, common_1.Inject)((0, redis_om_utils_1.getConnectionToken)())),
+    __metadata("design:paramtypes", [Object])
 ], RedisOmCoreModule);
 //# sourceMappingURL=redis-om-core.module.js.map

package/dist/redis-om/redis-om-core.module.js.map

@@ -1 +1 @@
-{"version":3,"file":"redis-om-core.module.js","sourceRoot":"","sources":["../../src/redis-om/redis-om-core.module.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,2CAMwB;AACxB,iCAAqC;AAGrC,6DAA+D;AAC/D,4DAA6D;AAUtD,IAAM,iBAAiB,yBAAvB,MAAM,iBAAiB;IAU5B,MAAM,CAAC,YAAY,CAAC,OAAkC;QACpD,MAAM,cAAc,GAAG,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;QAE1D,OAAO;YACL,SAAS,EAAE;gBACT,GAAG,cAAc;gBACjB;oBACE,UAAU,EAAE,KAAK,EAAE,GAAyB,EAAE,EAAE;wBAC9C,MAAM,SAAS,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;wBAC7C,MAAM,WAAW,GAAG,IAAA,oBAAY,EAAC,SAAS,CAAC,CAAC;wBAC5C,MAAM,WAAW,CAAC,OAAO,EAAE,CAAC;wBAE5B,OAAO,WAAW,CAAC;oBACrB,CAAC;oBACD,MAAM,EAAE,CAAC,4CAAuB,CAAC;oBACjC,OAAO,EAAE,IAAA,mCAAkB,GAAE;iBAC9B;aACF;YACD,OAAO,EAAE,CAAC,IAAA,mCAAkB,GAAE,CAAC;YAC/B,MAAM,EAAE,mBAAiB;YACzB,OAAO,EAAE,OAAO,CAAC,OAAO;SACzB,CAAC;IACJ,CAAC;IAWD,MAAM,CAAC,OAAO,CAAC,OAA6B;QAC1C,MAAM,yBAAyB,GAAa;YAC1C,UAAU,EAAE,KAAK,IAAI,EAAE;gBACrB,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;gBACzD,MAAM,WAAW,GAAG,IAAA,oBAAY,EAAC,SAAS,CAAC,CAAC;gBAC5C,MAAM,WAAW,CAAC,OAAO,EAAE,CAAC;gBAE5B,OAAO,WAAW,CAAC;YACrB,CAAC;YACD,OAAO,EAAE,IAAA,mCAAkB,GAAE;SAC9B,CAAC;QAEF,OAAO;YACL,SAAS,EAAE,CAAC,yBAAyB,CAAC;YACtC,OAAO,EAAE,CAAC,yBAAyB,CAAC;YACpC,MAAM,EAAE,mBAAiB;SAC1B,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,oBAAoB,CACjC,OAAkC;QAElC,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;YACvB,OAAO;gBACL;oBACE,OAAO,EAAE,4CAAuB;oBAChC,UAAU,EAAE,OAAO,CAAC,UAAU;oBAC9B,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,EAAE;iBAC7B;aACF,CAAC;QACJ,CAAC;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,KAAK,CAAC,qBAAqB,KAAI,CAAC;CACjC,CAAA;AA9EY,8CAAiB;4BAAjB,iBAAiB;IAF7B,IAAA,eAAM,EAAC,EAAE,CAAC;IACV,IAAA,eAAM,GAAE;GACI,iBAAiB,CA8E7B"}
+{"version":3,"file":"redis-om-core.module.js","sourceRoot":"","sources":["../../src/redis-om/redis-om-core.module.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAOwB;AACxB,iCAKe;AAGf,6DAA+D;AAC/D,4DAA6D;AAUtD,IAAM,iBAAiB,yBAAvB,MAAM,iBAAiB;IAGT;IAFnB,YAEmB,WAA+C;QAA/C,gBAAW,GAAX,WAAW,CAAoC;IAC/D,CAAC;IAWJ,MAAM,CAAC,YAAY,CAAC,OAAkC;QACpD,MAAM,cAAc,GAAG,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;QAE1D,OAAO;YACL,SAAS,EAAE;gBACT,GAAG,cAAc;gBACjB;oBACE,UAAU,EAAE,KAAK,EAAE,GAAyB,EAAE,EAAE;wBAC9C,MAAM,WAAW,GAAI,GAAW,CAAC,SAAS;4BACxC,CAAC,CAAC,IAAA,qBAAa,EAAC,GAAU,CAAC;4BAC3B,CAAC,CAAC,IAAA,oBAAY,EAAC,GAAU,CAAC,CAAC;wBAC7B,MAAM,WAAW,CAAC,OAAO,EAAE,CAAC;wBAC5B,OAAO,WAAW,CAAC;oBACrB,CAAC;oBACD,MAAM,EAAE,CAAC,4CAAuB,CAAC;oBACjC,OAAO,EAAE,IAAA,mCAAkB,GAAE;iBAC9B;aACF;YACD,OAAO,EAAE,CAAC,IAAA,mCAAkB,GAAE,CAAC;YAC/B,MAAM,EAAE,mBAAiB;YACzB,OAAO,EAAE,OAAO,CAAC,OAAO;SACzB,CAAC;IACJ,CAAC;IAWD,MAAM,CAAC,OAAO,CAAC,OAA6B;QAC1C,MAAM,yBAAyB,GAAa;YAC1C,UAAU,EAAE,KAAK,IAAI,EAAE;gBACrB,MAAM,WAAW,GAAI,OAAe,CAAC,SAAS;oBAC5C,CAAC,CAAC,IAAA,qBAAa,EAAC,OAAc,CAAC;oBAC/B,CAAC,CAAC,IAAA,oBAAY,EAAC,OAAc,CAAC,CAAC;gBACjC,MAAM,WAAW,CAAC,OAAO,EAAE,CAAC;gBAC5B,OAAO,WAAW,CAAC;YACrB,CAAC;YACD,OAAO,EAAE,IAAA,mCAAkB,GAAE;SAC9B,CAAC;QAEF,OAAO;YACL,SAAS,EAAE,CAAC,yBAAyB,CAAC;YACtC,OAAO,EAAE,CAAC,yBAAyB,CAAC;YACpC,MAAM,EAAE,mBAAiB;SAC1B,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,oBAAoB,CACjC,OAAkC;QAElC,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;YACvB,OAAO;gBACL;oBACE,OAAO,EAAE,4CAAuB;oBAChC,UAAU,EAAE,OAAO,CAAC,UAAU;oBAC9B,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,EAAE;iBAC7B;aACF,CAAC;QACJ,CAAC;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,KAAK,CAAC,qBAAqB;QACzB,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC;YACxC,MAAM,OAAO,GACX,SAAS,IAAI,IAAI,CAAC,WAAW;gBAC3B,CAAC,CAAE,IAAI,CAAC,WAAmB,CAAC,OAAO;gBACnC,CAAC,CAAC,KAAK,CAAC;YACZ,IAAI,MAAM,IAAI,OAAO,EAAE,CAAC;gBACtB,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;YAChC,CAAC;QACH,CAAC;QAAC,MAAM,CAAC;QAET,CAAC;IACH,CAAC;CACF,CAAA;AAhGY,8CAAiB;4BAAjB,iBAAiB;IAF7B,IAAA,eAAM,EAAC,EAAE,CAAC;IACV,IAAA,eAAM,GAAE;IAGJ,WAAA,IAAA,eAAM,EAAC,IAAA,mCAAkB,GAAE,CAAC,CAAA;;GAFpB,iBAAiB,CAgG7B"}

package/dist/redis-om/redis-om.module.d.ts

@@ -1,5 +1,4 @@
-import { DynamicModule } from '@nestjs/common';
-import { Type } from '@nestjs/common';
+import { DynamicModule, Type } from '@nestjs/common';
 import { RedisOmModuleAsyncOptions, RedisOmModuleOptions } from './interfaces';
 export declare class RedisOmModule {
     static forFeature(models: Type<any>[]): DynamicModule;

package/dist/redis-om/redis-om.module.js

@@ -39,16 +39,34 @@ exports.RedisOmModule = RedisOmModule = RedisOmModule_1 = __decorate([
     (0, common_1.Module)({})
 ], RedisOmModule);
 const redis_om_1 = require("redis-om");
+const errors_1 = require("./errors");
+const IGNORABLE_INDEX_ERRORS = [
+    errors_1.RedisOmIndexAlreadyExistsException,
+    errors_1.RedisOmUnsupportedCommandException,
+];
 function createRedisOmProvider(model) {
     return {
         useFactory: async (client) => {
             const schema = schema_factory_1.SchemaFactory.createForClass(model);
             const repository = new redis_om_1.Repository(schema, client);
-            await repository.createIndex();
+            try {
+                await repository.createIndex();
+            }
+            catch (error) {
+                const known = classifyIndexError(error);
+                if (known === null) {
+                    throw new errors_1.RedisOmIndexCreationFailedException(error);
+                }
+            }
             return repository;
         },
         provide: (0, redis_om_utils_1.getRepositoryToken)(model),
         inject: [(0, redis_om_utils_1.getConnectionToken)()],
     };
 }
+function classifyIndexError(error) {
+    const msg = error instanceof Error ? error.message : String(error);
+    const Match = IGNORABLE_INDEX_ERRORS.find((E) => E.matches(msg));
+    return Match ? new Match(error) : null;
+}
 //# sourceMappingURL=redis-om.module.js.map

package/dist/redis-om/redis-om.module.js.map

@@ -1 +1 @@
-{"version":3,"file":"redis-om.module.js","sourceRoot":"","sources":["../../src/redis-om/redis-om.module.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,2CAAiE;AAGjE,4DAGiC;AAEjC,iEAA2D;AAC3D,+DAA2D;AAUpD,IAAM,aAAa,qBAAnB,MAAM,aAAa;IAmBxB,MAAM,CAAC,UAAU,CAAC,MAAmB;QACnC,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAC;QACtE,OAAO;YACL,MAAM,EAAE,eAAa;YACrB,SAAS,EAAE,SAAS;YACpB,OAAO,EAAE,SAAS;SACnB,CAAC;IACJ,CAAC;IAsBD,MAAM,CAAC,YAAY,CAAC,OAAkC;QACpD,OAAO;YACL,OAAO,EAAE,CAAC,wCAAiB,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;YAClD,MAAM,EAAE,eAAa;SACtB,CAAC;IACJ,CAAC;IAkBD,MAAM,CAAC,OAAO,CAAC,OAA6B;QAC1C,OAAO;YACL,OAAO,EAAE,CAAC,wCAAiB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAC7C,MAAM,EAAE,eAAa;SACtB,CAAC;IACJ,CAAC;CACF,CAAA;AA7EY,sCAAa;wBAAb,aAAa;IADzB,IAAA,eAAM,EAAC,EAAE,CAAC;GACE,aAAa,CA6EzB;AAED,uCAAsC;AAEtC,SAAS,qBAAqB,CAAC,KAAgB;IAC7C,OAAO;QACL,UAAU,EAAE,KAAK,EAAE,MAAW,EAAE,EAAE;YAChC,MAAM,MAAM,GAAG,8BAAa,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YACnD,MAAM,UAAU,GAAG,IAAI,qBAAU,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YAClD,MAAM,UAAU,CAAC,WAAW,EAAE,CAAC;YAC/B,OAAO,UAAU,CAAC;QACpB,CAAC;QACD,OAAO,EAAE,IAAA,mCAAkB,EAAC,KAAK,CAAC;QAClC,MAAM,EAAE,CAAC,IAAA,mCAAkB,GAAE,CAAC;KAC/B,CAAC;AACJ,CAAC"}
+{"version":3,"file":"redis-om.module.js","sourceRoot":"","sources":["../../src/redis-om/redis-om.module.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,2CAAuE;AAGvE,4DAGiC;AAEjC,iEAA2D;AAC3D,+DAA2D;AAUpD,IAAM,aAAa,qBAAnB,MAAM,aAAa;IAmBxB,MAAM,CAAC,UAAU,CAAC,MAAmB;QACnC,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAC;QACtE,OAAO;YACL,MAAM,EAAE,eAAa;YACrB,SAAS,EAAE,SAAS;YACpB,OAAO,EAAE,SAAS;SACnB,CAAC;IACJ,CAAC;IAsBD,MAAM,CAAC,YAAY,CAAC,OAAkC;QACpD,OAAO;YACL,OAAO,EAAE,CAAC,wCAAiB,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;YAClD,MAAM,EAAE,eAAa;SACtB,CAAC;IACJ,CAAC;IAkBD,MAAM,CAAC,OAAO,CAAC,OAA6B;QAC1C,OAAO;YACL,OAAO,EAAE,CAAC,wCAAiB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAC7C,MAAM,EAAE,eAAa;SACtB,CAAC;IACJ,CAAC;CACF,CAAA;AA7EY,sCAAa;wBAAb,aAAa;IADzB,IAAA,eAAM,EAAC,EAAE,CAAC;GACE,aAAa,CA6EzB;AAED,uCAAuD;AAEvD,qCAKkB;AAMlB,MAAM,sBAAsB,GAAG;IAC7B,2CAAkC;IAClC,2CAAkC;CAC1B,CAAC;AAEX,SAAS,qBAAqB,CAAC,KAAgB;IAC7C,OAAO;QACL,UAAU,EAAE,KAAK,EAAE,MAA0C,EAAE,EAAE;YAC/D,MAAM,MAAM,GAAG,8BAAa,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YACnD,MAAM,UAAU,GAAG,IAAI,qBAAU,CAC/B,MAAM,EACN,MAAoC,CACrC,CAAC;YAEF,IAAI,CAAC;gBACH,MAAM,UAAU,CAAC,WAAW,EAAE,CAAC;YACjC,CAAC;YAAC,OAAO,KAAc,EAAE,CAAC;gBACxB,MAAM,KAAK,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;gBACxC,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;oBAEnB,MAAM,IAAI,4CAAmC,CAAC,KAAK,CAAC,CAAC;gBACvD,CAAC;YAIH,CAAC;YAED,OAAO,UAAU,CAAC;QACpB,CAAC;QACD,OAAO,EAAE,IAAA,mCAAkB,EAAC,KAAK,CAAC;QAClC,MAAM,EAAE,CAAC,IAAA,mCAAkB,GAAE,CAAC;KAC/B,CAAC;AACJ,CAAC;AAOD,SAAS,kBAAkB,CAAC,KAAc;IACxC,MAAM,GAAG,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACnE,MAAM,KAAK,GAAG,sBAAsB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;IACjE,OAAO,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AACzC,CAAC"}