@alpha018/nestjs-redisom 1.0.0

package/CONTRIBUTING.md

@@ -0,0 +1,34 @@
+# Contributing to nestjs-redisom
+
+Thank you for your interest in contributing to nestjs-redisom! We appreciate your contributions and want to make the process as smooth as possible. Please follow these guidelines to ensure your contributions are integrated seamlessly into the project.
+
+## How to Contribute
+
+1. **Open an Issue:** Before starting work on a new feature or bug fix, we recommend opening an issue to discuss your ideas with the development team. This will help us ensure that your changes align with the project's vision and avoid duplicated efforts.
+
+2. **Fork the Repository:** Fork the main repository to your GitHub account. This will allow you to work on your changes independently.
+
+3. **Create a Branch:** Create a new branch in your fork for your changes. Use a descriptive name for the branch that reflects the changes you are making (e.g., `feature/new-feature` or `fix/bug-fix`).
+
+4. **Make Your Changes:** Make your changes in the new branch. Be sure to follow the project's coding conventions and write unit tests for your changes.
+
+5. **Submit a Pull Request:** Once you have finished your changes, submit a pull request from your branch to the main repository. Include a clear description of your changes and any relevant information.
+
+6. **Review and Merge:** The development team will review your pull request and provide feedback. Once your changes have been approved, they will be merged into the main repository.
+
+## Contribution Guidelines
+
+- **Unit Tests:** Write unit tests for all your changes. This will help us ensure code quality and prevent regressions in the future.
+- **Documentation:** Make sure to document your changes appropriately. Update existing documentation or create new documentation if necessary.
+- **Coding Conventions:** Follow the project's coding conventions. Use a linter to ensure your code adheres to the established rules.
+- **Commit Messages:** Write clear and descriptive commit messages that explain the changes you have made, remember you need follow the commit lint rules.
+
+## License
+
+By contributing to this project, you agree that your contributions will be licensed under the same license as the project, which is the MIT License.
+
+## Contact
+
+If you have any questions or need help, please feel free to contact us by opening an issue on GitHub.
+
+Thank you again for your interest in contributing to nestjs-redisom! We look forward to seeing your contributions soon.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Tomás Alegre Sepúlveda
+
+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.md

@@ -0,0 +1,216 @@
+# NestJS RedisOM
+
+<div align="center">
+  <a href="http://nestjs.com/" target="_blank">
+    <img src="https://nestjs.com/img/logo_text.svg" width="150" alt="Nest Logo" />
+  </a>
+</div>
+
+<h3 align="center">A NestJS module for RedisOM, providing a structured way to use Redis Stack JSON/Search features.</h3>
+
+<div align="center">
+  <a href="https://nestjs.com" target="_blank">
+    <img src="https://img.shields.io/badge/built%20with-NestJs-red.svg" alt="Built with NestJS">
+  </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`.
+
+## Installation
+
+```bash
+$ npm install nestjs-redisom redis-om redis
+```
+
+## Quick Start
+
+### 1. Define an Entity
+
+Use the `@Schema()` decorator to define your entity and `@Prop()` for properties. Extends `BaseEntity` to easily access the auto-generated ID.
+
+```typescript
+import { Schema } from 'nestjs-redisom';
+import { Prop } from 'nestjs-redisom';
+import { BaseEntity } from 'nestjs-redisom';
+
+@Schema()
+export class CatEntity extends BaseEntity {
+  @Prop()
+  name: string;
+
+  @Prop()
+  age: number;
+}
+```
+
+### 2. Import the Module
+
+Register `RedisOmModule` in your root `AppModule` and register your entities with `forFeature`.
+
+```typescript
+import { Module } from '@nestjs/common';
+import { RedisOmModule } from 'nestjs-redisom';
+import { CatEntity } from './cat.entity';
+
+@Module({
+  imports: [
+    RedisOmModule.forRoot({
+        url: 'redis://localhost:6379'
+    }),
+    RedisOmModule.forFeature([CatEntity]),
+  ],
+})
+export class AppModule {}
+```
+
+### 3. Usage in a Service
+
+Inject the repository to save and search for entities.
+
+```typescript
+import { Injectable } from '@nestjs/common';
+import { InjectRepository } from 'nestjs-redisom';
+import { Repository } from 'redis-om';
+import { CatEntity } from './cat.entity';
+
+@Injectable()
+export class CatsService {
+  constructor(
+    @InjectRepository(CatEntity) private readonly catRepo: Repository<CatEntity>,
+  ) {}
+
+  async create(name: string, age: number) {
+    const entity = new CatEntity();
+    entity.name = name;
+    entity.age = age;
+    return await this.catRepo.save(entity);
+  }
+
+  async findAll() {
+    return await this.catRepo.search().return.all();
+  }
+}
+```
+
+## Advanced Usage
+
+### 1. Nested Typed Objects
+
+You can define nested objects using classes and the `@Prop({ type: () => Class })` syntax. This allows Redis OM to automatically generate the correct schema fields (flattened) for your nested data.
+
+**Define the Embedded Class:**
+
+```typescript
+export class Address {
+  @Prop({ indexed: true })
+  city: string;
+
+  @Prop()
+  zip: string;
+}
+```
+
+**Use in Parent Entity:**
+
+```typescript
+@Schema({ dataStructure: 'JSON' })
+export class Person extends BaseEntity {
+  @Prop()
+  name: string;
+
+  @Prop({ type: () => Address })
+  address: Address;
+}
+```
+
+**Search using flattened/nested fields:**
+
+The schema generator creates flattened fields like `address_city`.
+
+```typescript
+// Search for persons living in 'New York'
+const results = await this.personRepo.search()
+  .where('address_city' as any).eq('New York')
+  .return.all();
+```
+
+### 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).
+
+```typescript
+// Using a UUID
+import { v4 as uuidv4 } from 'uuid';
+const id = uuidv4();
+await this.catRepo.save(id, entity);
+
+// Using a custom string
+await this.catRepo.save('unique-custom-id', entity);
+```
+
+### 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.
+
+```typescript
+const id = 'temp-session-123';
+await this.catRepo.save(id, sessionEntity);
+
+// Expire after 60 seconds
+await this.catRepo.expire(id, 60);
+```
+
+## 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).
+
+## 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)**.
+
+#### Search Complexity by Type
+
+| Data Type | Operation | Complexity | Notes |
+| :--- | :--- | :--- | :--- |
+| **ID** | Retrieve (`fetch`) | **O(1)** | Direct key access (fastest). |
+| **Tag / String** | Exact Match (`eq`) | **O(K)** | `K` = number of results returned. |
+| **Numeric / Date** | Range (`gt`, `lt`, `between`) | **O(log N + K)** | Uses sorted sets/trees. efficient for ranges. |
+| **Text** | Full-Text (`matches`) | **O(M + K)** | `M` = number of terms/words being searched. |
+| **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.
+
+## Resources
+
+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).
+
+## Support
+
+Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
+
+## Stay in touch
+
+-   Author - [Tomás Alegre](https://github.com/Alpha018)
+
+## License
+
+NestJS RedisOM is [MIT licensed](LICENSE).

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export * from './redis-om/decorators/inject-repository.decorator';
+export * from './redis-om/decorators/schema.decorator';
+export * from './redis-om/decorators/prop.decorator';
+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';

package/dist/index.js

@@ -0,0 +1,24 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./redis-om/decorators/inject-repository.decorator"), exports);
+__exportStar(require("./redis-om/decorators/schema.decorator"), exports);
+__exportStar(require("./redis-om/decorators/prop.decorator"), exports);
+__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);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +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"}

package/dist/redis-om/common/base.entity.d.ts

@@ -0,0 +1,7 @@
+import { EntityId } from 'redis-om';
+export interface EntityWithId {
+    [EntityId]?: string;
+}
+export declare class BaseEntity {
+    static getId(entity: EntityWithId | object): undefined | string;
+}

package/dist/redis-om/common/base.entity.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseEntity = void 0;
+const redis_om_1 = require("redis-om");
+class BaseEntity {
+    static getId(entity) {
+        if (!entity)
+            return undefined;
+        return entity[redis_om_1.EntityId];
+    }
+}
+exports.BaseEntity = BaseEntity;
+//# sourceMappingURL=base.entity.js.map

package/dist/redis-om/common/base.entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.entity.js","sourceRoot":"","sources":["../../../src/redis-om/common/base.entity.ts"],"names":[],"mappings":";;;AAAA,uCAAoC;AAMpC,MAAa,UAAU;IACrB,MAAM,CAAC,KAAK,CAAC,MAA6B;QACxC,IAAI,CAAC,MAAM;YAAE,OAAO,SAAS,CAAC;QAC9B,OAAQ,MAAuB,CAAC,mBAAQ,CAAC,CAAC;IAC5C,CAAC;CACF;AALD,gCAKC"}

package/dist/redis-om/common/redis-om.utils.d.ts

@@ -0,0 +1,3 @@
+import { Type } from '@nestjs/common';
+export declare function getRepositoryToken(entity: Type<any> | string): string;
+export declare function getConnectionToken(name?: string): string;

package/dist/redis-om/common/redis-om.utils.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRepositoryToken = getRepositoryToken;
+exports.getConnectionToken = getConnectionToken;
+function getRepositoryToken(entity) {
+    if (entity === null || entity === undefined) {
+        throw new Error('Entity cannot be null or undefined');
+    }
+    const name = typeof entity === 'string' ? entity : entity.name;
+    return `${name}Repository`;
+}
+function getConnectionToken(name) {
+    return name && name !== 'default'
+        ? `REDIS_OM_CONNECTION_${name}`
+        : 'REDIS_OM_CONNECTION';
+}
+//# sourceMappingURL=redis-om.utils.js.map

package/dist/redis-om/common/redis-om.utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"redis-om.utils.js","sourceRoot":"","sources":["../../../src/redis-om/common/redis-om.utils.ts"],"names":[],"mappings":";;AAEA,gDAMC;AAED,gDAIC;AAZD,SAAgB,kBAAkB,CAAC,MAA0B;IAC3D,IAAI,MAAM,KAAK,IAAI,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QAC5C,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;IACxD,CAAC;IACD,MAAM,IAAI,GAAG,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;IAC/D,OAAO,GAAG,IAAI,YAAY,CAAC;AAC7B,CAAC;AAED,SAAgB,kBAAkB,CAAC,IAAa;IAC9C,OAAO,IAAI,IAAI,IAAI,KAAK,SAAS;QAC/B,CAAC,CAAC,uBAAuB,IAAI,EAAE;QAC/B,CAAC,CAAC,qBAAqB,CAAC;AAC5B,CAAC"}

package/dist/redis-om/decorators/inject-repository.decorator.d.ts

@@ -0,0 +1,2 @@
+import { Type } from '@nestjs/common';
+export declare const InjectRepository: (entity: Type<any>) => PropertyDecorator & ParameterDecorator;

package/dist/redis-om/decorators/inject-repository.decorator.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InjectRepository = void 0;
+const common_1 = require("@nestjs/common");
+const redis_om_utils_1 = require("../common/redis-om.utils");
+const InjectRepository = (entity) => {
+    return (0, common_1.Inject)((0, redis_om_utils_1.getRepositoryToken)(entity));
+};
+exports.InjectRepository = InjectRepository;
+//# sourceMappingURL=inject-repository.decorator.js.map

package/dist/redis-om/decorators/inject-repository.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"inject-repository.decorator.js","sourceRoot":"","sources":["../../../src/redis-om/decorators/inject-repository.decorator.ts"],"names":[],"mappings":";;;AAAA,2CAAwC;AAGxC,6DAA8D;AAEvD,MAAM,gBAAgB,GAAG,CAAC,MAAiB,EAAE,EAAE;IACpD,OAAO,IAAA,eAAM,EAAC,IAAA,mCAAkB,EAAC,MAAM,CAAC,CAAC,CAAC;AAC5C,CAAC,CAAC;AAFW,QAAA,gBAAgB,oBAE3B"}

package/dist/redis-om/decorators/prop.decorator.d.ts

@@ -0,0 +1,22 @@
+export interface PropOptions {
+    type?: RedisOmFieldType;
+    caseSensitive?: boolean;
+    textSearch?: boolean;
+    normalized?: boolean;
+    sortable?: boolean;
+    separator?: string;
+    stemming?: boolean;
+    indexed?: boolean;
+    matcher?: string;
+    weight?: number;
+    field?: string;
+    path?: string;
+}
+export type RedisOmFieldType = {
+    (): {
+        new (...args: any[]): any;
+    };
+} | {
+    new (...args: any[]): any;
+} | 'string[]' | 'number[]' | 'boolean' | 'string' | 'number' | 'point' | 'date' | 'text';
+export declare function Prop(options?: PropOptions): PropertyDecorator;

package/dist/redis-om/decorators/prop.decorator.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Prop = Prop;
+const redis_om_constants_1 = require("../redis-om.constants");
+function Prop(options = {}) {
+    return (target, propertyKey) => {
+        const existingProps = Reflect.getMetadata(redis_om_constants_1.REDIS_OM_PROP_METADATA, target.constructor) || [];
+        existingProps.push({ propertyKey, options });
+        Reflect.defineMetadata(redis_om_constants_1.REDIS_OM_PROP_METADATA, existingProps, target.constructor);
+    };
+}
+//# sourceMappingURL=prop.decorator.js.map

package/dist/redis-om/decorators/prop.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prop.decorator.js","sourceRoot":"","sources":["../../../src/redis-om/decorators/prop.decorator.ts"],"names":[],"mappings":";;AA6BA,oBAWC;AAxCD,8DAA+D;AA6B/D,SAAgB,IAAI,CAAC,UAAuB,EAAE;IAC5C,OAAO,CAAC,MAAc,EAAE,WAA4B,EAAE,EAAE;QACtD,MAAM,aAAa,GACjB,OAAO,CAAC,WAAW,CAAC,2CAAsB,EAAE,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;QACxE,aAAa,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;QAC7C,OAAO,CAAC,cAAc,CACpB,2CAAsB,EACtB,aAAa,EACb,MAAM,CAAC,WAAW,CACnB,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC"}

package/dist/redis-om/decorators/schema.decorator.d.ts

@@ -0,0 +1,6 @@
+export interface SchemaOptions {
+    dataStructure?: 'JSON' | 'HASH';
+    indexName?: string;
+    name?: string;
+}
+export declare function Schema(options?: SchemaOptions): ClassDecorator;

package/dist/redis-om/decorators/schema.decorator.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Schema = Schema;
+const redis_om_constants_1 = require("../redis-om.constants");
+function Schema(options = {}) {
+    return (target) => {
+        Reflect.defineMetadata(redis_om_constants_1.REDIS_OM_SCHEMA_METADATA, options, target);
+    };
+}
+//# sourceMappingURL=schema.decorator.js.map

package/dist/redis-om/decorators/schema.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.decorator.js","sourceRoot":"","sources":["../../../src/redis-om/decorators/schema.decorator.ts"],"names":[],"mappings":";;AAQA,wBAIC;AAZD,8DAAiE;AAQjE,SAAgB,MAAM,CAAC,UAAyB,EAAE;IAChD,OAAO,CAAC,MAAc,EAAE,EAAE;QACxB,OAAO,CAAC,cAAc,CAAC,6CAAwB,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IACpE,CAAC,CAAC;AACJ,CAAC"}

package/dist/redis-om/factories/schema.factory.d.ts

@@ -0,0 +1,10 @@
+import { Type } from '@nestjs/common';
+import { Schema } from 'redis-om';
+export declare class SchemaFactory {
+    static createForClass(target: Type<any>): Schema;
+    private static processStandardField;
+    private static processNestedClass;
+    private static processProperty;
+    private static buildSchemaProperties;
+    private static isNestedClass;
+}

package/dist/redis-om/factories/schema.factory.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SchemaFactory = void 0;
+const redis_om_1 = require("redis-om");
+const redis_om_constants_1 = require("../redis-om.constants");
+class SchemaFactory {
+    static createForClass(target) {
+        const schemaOptions = Reflect.getMetadata(redis_om_constants_1.REDIS_OM_SCHEMA_METADATA, target);
+        if (!schemaOptions) {
+            throw new Error(`Class ${target.name} is not decorated with @Schema decorator`);
+        }
+        const schemaDefinition = {};
+        this.buildSchemaProperties(target, schemaDefinition);
+        return new redis_om_1.Schema(schemaOptions.name || target.name, schemaDefinition, {
+            ...schemaOptions,
+        });
+    }
+    static processStandardField(propertyKey, options, schemaDefinition, pathPrefix, keyPrefix) {
+        const fieldDefinition = { type: options.type || 'string' };
+        if (options.indexed) {
+            fieldDefinition.sortable = options.sortable;
+        }
+        Object.assign(fieldDefinition, options);
+        if (!fieldDefinition.path && pathPrefix !== '$') {
+            fieldDefinition.path = `${pathPrefix}.${propertyKey}`;
+        }
+        const fieldKey = keyPrefix ? `${keyPrefix}_${propertyKey}` : propertyKey;
+        schemaDefinition[fieldKey] = fieldDefinition;
+    }
+    static processNestedClass(type, propertyKey, schemaDefinition, pathPrefix, keyPrefix) {
+        const nestedPathPrefix = `${pathPrefix}.${propertyKey}`;
+        const nestedKeyPrefix = keyPrefix
+            ? `${keyPrefix}_${propertyKey}`
+            : propertyKey;
+        const nestedTarget = type.prototype instanceof Object ? type : type();
+        this.buildSchemaProperties(nestedTarget, schemaDefinition, nestedPathPrefix, nestedKeyPrefix);
+    }
+    static processProperty(prop, schemaDefinition, pathPrefix, keyPrefix) {
+        const { propertyKey, options } = prop;
+        const type = options.type;
+        if (this.isNestedClass(type)) {
+            this.processNestedClass(type, propertyKey, schemaDefinition, pathPrefix, keyPrefix);
+        }
+        else {
+            this.processStandardField(propertyKey, options, schemaDefinition, pathPrefix, keyPrefix);
+        }
+    }
+    static buildSchemaProperties(target, schemaDefinition, pathPrefix = '$', keyPrefix = '') {
+        const propMetadata = Reflect.getMetadata(redis_om_constants_1.REDIS_OM_PROP_METADATA, target) || [];
+        propMetadata.forEach((prop) => {
+            this.processProperty(prop, schemaDefinition, pathPrefix, keyPrefix);
+        });
+    }
+    static isNestedClass(type) {
+        return (typeof type === 'function' &&
+            ![Boolean, String, Number, Date].includes(type));
+    }
+}
+exports.SchemaFactory = SchemaFactory;
+//# sourceMappingURL=schema.factory.js.map

package/dist/redis-om/factories/schema.factory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.factory.js","sourceRoot":"","sources":["../../../src/redis-om/factories/schema.factory.ts"],"names":[],"mappings":";;;AACA,uCAAkC;AAElC,8DAG+B;AAE/B,MAAa,aAAa;IACxB,MAAM,CAAC,cAAc,CAAC,MAAiB;QACrC,MAAM,aAAa,GAAG,OAAO,CAAC,WAAW,CAAC,6CAAwB,EAAE,MAAM,CAAC,CAAC;QAE5E,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CACb,SAAS,MAAM,CAAC,IAAI,0CAA0C,CAC/D,CAAC;QACJ,CAAC;QAED,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QACjD,IAAI,CAAC,qBAAqB,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;QAErD,OAAO,IAAI,iBAAM,CAAC,aAAa,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE;YACrE,GAAG,aAAa;SACjB,CAAC,CAAC;IACL,CAAC;IAEO,MAAM,CAAC,oBAAoB,CACjC,WAAmB,EACnB,OAAY,EACZ,gBAAqC,EACrC,UAAkB,EAClB,SAAiB;QAEjB,MAAM,eAAe,GAAQ,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,QAAQ,EAAE,CAAC;QAEhE,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;YACpB,eAAe,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QAC9C,CAAC;QAED,MAAM,CAAC,MAAM,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;QAExC,IAAI,CAAC,eAAe,CAAC,IAAI,IAAI,UAAU,KAAK,GAAG,EAAE,CAAC;YAChD,eAAe,CAAC,IAAI,GAAG,GAAG,UAAU,IAAI,WAAW,EAAE,CAAC;QACxD,CAAC;QAED,MAAM,QAAQ,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,IAAI,WAAW,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC;QAEzE,gBAAgB,CAAC,QAAQ,CAAC,GAAG,eAAe,CAAC;IAC/C,CAAC;IAEO,MAAM,CAAC,kBAAkB,CAC/B,IAAS,EACT,WAAmB,EACnB,gBAAqC,EACrC,UAAkB,EAClB,SAAiB;QAEjB,MAAM,gBAAgB,GAAG,GAAG,UAAU,IAAI,WAAW,EAAE,CAAC;QACxD,MAAM,eAAe,GAAG,SAAS;YAC/B,CAAC,CAAC,GAAG,SAAS,IAAI,WAAW,EAAE;YAC/B,CAAC,CAAC,WAAW,CAAC;QAGhB,MAAM,YAAY,GAChB,IAAI,CAAC,SAAS,YAAY,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAE,IAAY,EAAE,CAAC;QAE5D,IAAI,CAAC,qBAAqB,CACxB,YAAY,EACZ,gBAAgB,EAChB,gBAAgB,EAChB,eAAe,CAChB,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,eAAe,CAC5B,IAAS,EACT,gBAAqC,EACrC,UAAkB,EAClB,SAAiB;QAEjB,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QACtC,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QAE1B,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7B,IAAI,CAAC,kBAAkB,CACrB,IAAI,EACJ,WAAW,EACX,gBAAgB,EAChB,UAAU,EACV,SAAS,CACV,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,oBAAoB,CACvB,WAAW,EACX,OAAO,EACP,gBAAgB,EAChB,UAAU,EACV,SAAS,CACV,CAAC;QACJ,CAAC;IACH,CAAC;IAEO,MAAM,CAAC,qBAAqB,CAClC,MAAqC,EACrC,gBAAqC,EACrC,UAAU,GAAG,GAAG,EAChB,SAAS,GAAG,EAAE;QAEd,MAAM,YAAY,GAChB,OAAO,CAAC,WAAW,CAAC,2CAAsB,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC;QAE5D,YAAY,CAAC,OAAO,CAAC,CAAC,IAAS,EAAE,EAAE;YACjC,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,gBAAgB,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC;QACtE,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,IAAS;QACpC,OAAO,CACL,OAAO,IAAI,KAAK,UAAU;YAC1B,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAChD,CAAC;IACJ,CAAC;CACF;AAlHD,sCAkHC"}

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

@@ -0,0 +1,16 @@
+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>;
+    useClass?: Type<RedisOmOptionsFactory>;
+    inject?: any[];
+}
+export interface RedisOmModelDefinition {
+    name?: string;
+    schema: any;
+}
+export interface RedisOmOptionsFactory {
+    createRedisOmOptions(): Promise<RedisOmModuleOptions> | RedisOmModuleOptions;
+}
+export type RedisOmModuleOptions = RedisClientOptions;

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

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/redis-om/interfaces/index.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,8 @@
+import { OnApplicationShutdown, DynamicModule } from '@nestjs/common';
+import { RedisOmModuleAsyncOptions, RedisOmModuleOptions } from './interfaces';
+export declare class RedisOmCoreModule implements OnApplicationShutdown {
+    static forRootAsync(options: RedisOmModuleAsyncOptions): DynamicModule;
+    static forRoot(options: RedisOmModuleOptions): DynamicModule;
+    private static createAsyncProviders;
+    onApplicationShutdown(): Promise<void>;
+}

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

@@ -0,0 +1,72 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    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 RedisOmCoreModule_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedisOmCoreModule = void 0;
+const common_1 = require("@nestjs/common");
+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 {
+    static forRootAsync(options) {
+        const asyncProviders = this.createAsyncProviders(options);
+        return {
+            providers: [
+                ...asyncProviders,
+                {
+                    useFactory: async (opt) => {
+                        const redisInfo = opt.url ? { ...opt } : opt;
+                        const redisClient = (0, redis_1.createClient)(redisInfo);
+                        await redisClient.connect();
+                        return redisClient;
+                    },
+                    inject: [redis_om_constants_1.REDIS_OM_MODULE_OPTIONS],
+                    provide: (0, redis_om_utils_1.getConnectionToken)(),
+                },
+            ],
+            exports: [(0, redis_om_utils_1.getConnectionToken)()],
+            module: RedisOmCoreModule_1,
+            imports: options.imports,
+        };
+    }
+    static forRoot(options) {
+        const redisOmConnectionProvider = {
+            useFactory: async () => {
+                const redisInfo = options.url ? { ...options } : options;
+                const redisClient = (0, redis_1.createClient)(redisInfo);
+                await redisClient.connect();
+                return redisClient;
+            },
+            provide: (0, redis_om_utils_1.getConnectionToken)(),
+        };
+        return {
+            providers: [redisOmConnectionProvider],
+            exports: [redisOmConnectionProvider],
+            module: RedisOmCoreModule_1,
+        };
+    }
+    static createAsyncProviders(options) {
+        if (options.useFactory) {
+            return [
+                {
+                    provide: redis_om_constants_1.REDIS_OM_MODULE_OPTIONS,
+                    useFactory: options.useFactory,
+                    inject: options.inject || [],
+                },
+            ];
+        }
+        return [];
+    }
+    async onApplicationShutdown() { }
+};
+exports.RedisOmCoreModule = RedisOmCoreModule;
+exports.RedisOmCoreModule = RedisOmCoreModule = RedisOmCoreModule_1 = __decorate([
+    (0, common_1.Module)({}),
+    (0, common_1.Global)()
+], RedisOmCoreModule);
+//# sourceMappingURL=redis-om-core.module.js.map

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

@@ -0,0 +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;AAItD,IAAM,iBAAiB,yBAAvB,MAAM,iBAAiB;IAC5B,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;IAED,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;AA5DY,8CAAiB;4BAAjB,iBAAiB;IAF7B,IAAA,eAAM,EAAC,EAAE,CAAC;IACV,IAAA,eAAM,GAAE;GACI,iBAAiB,CA4D7B"}

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

@@ -0,0 +1,3 @@
+export declare const REDIS_OM_SCHEMA_METADATA = "redis_om:schema_metadata";
+export declare const REDIS_OM_PROP_METADATA = "redis_om:prop_metadata";
+export declare const REDIS_OM_MODULE_OPTIONS = "redis_om:module_options";