@tsed/mongoose 8.0.0-alpha.1 → 8.0.0-alpha.10

package/lib/cjs/utils/schemaOptions.js

@@ -1,60 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.applySchemaOptions = exports.buildPreHook = exports.schemaOptions = void 0;
-const core_1 = require("@tsed/core");
-const constants_js_1 = require("../constants/constants.js");
-/**
- * @ignore
- */
-function schemaOptions(target, options) {
-    const store = core_1.Store.from(target);
-    if (!store.has(constants_js_1.MONGOOSE_SCHEMA_OPTIONS)) {
-        store.set(constants_js_1.MONGOOSE_SCHEMA_OPTIONS, {});
-    }
-    if (options) {
-        store.set(constants_js_1.MONGOOSE_SCHEMA_OPTIONS, (0, core_1.deepMerge)(store.get(constants_js_1.MONGOOSE_SCHEMA_OPTIONS), options));
-    }
-    return store.get(constants_js_1.MONGOOSE_SCHEMA_OPTIONS);
-}
-exports.schemaOptions = schemaOptions;
-function mapHookArgs(hook) {
-    return [hook.method, hook.options || hook.fn, hook.options ? hook.fn : undefined].filter(Boolean);
-}
-/**
- * @ignore
- */
-function buildPreHook(fn) {
-    return fn.length === 1
-        ? function () {
-            return fn(this);
-        }
-        : function (next) {
-            return fn(this, next);
-        };
-}
-exports.buildPreHook = buildPreHook;
-/**
- * @ignore
- */
-function applySchemaOptions(schema, options) {
-    if (options.plugins) {
-        options.plugins.forEach((item) => schema.plugin(item.plugin, item.options));
-    }
-    if (options.indexes) {
-        options.indexes.forEach((item) => schema.index(item.fields, item.options));
-    }
-    if (options.pre) {
-        options.pre.forEach((item) => {
-            item = {
-                ...item,
-                fn: buildPreHook(item.fn)
-            };
-            schema.pre(...mapHookArgs(item));
-        });
-    }
-    if (options.post) {
-        options.post.forEach((item) => schema.post(...mapHookArgs(item)));
-    }
-}
-exports.applySchemaOptions = applySchemaOptions;
-//# sourceMappingURL=schemaOptions.js.map

package/lib/cjs/utils/schemaOptions.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"schemaOptions.js","sourceRoot":"","sources":["../../../src/utils/schemaOptions.ts"],"names":[],"mappings":";;;AAAA,qCAA4C;AAE5C,4DAAkE;AAUlE;;GAEG;AACH,SAAgB,aAAa,CAAC,MAAW,EAAE,OAA+B;IACxE,MAAM,KAAK,GAAG,YAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAEjC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,sCAAuB,CAAC,EAAE;QACvC,KAAK,CAAC,GAAG,CAAC,sCAAuB,EAAE,EAAE,CAAC,CAAC;KACxC;IAED,IAAI,OAAO,EAAE;QACX,KAAK,CAAC,GAAG,CAAC,sCAAuB,EAAE,IAAA,gBAAS,EAAC,KAAK,CAAC,GAAG,CAAC,sCAAuB,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;KAC5F;IAED,OAAO,KAAK,CAAC,GAAG,CAAC,sCAAuB,CAAC,CAAC;AAC5C,CAAC;AAZD,sCAYC;AAED,SAAS,WAAW,CAAC,IAAwC;IAC3D,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,OAAO,CAAQ,CAAC;AAC3G,CAAC;AAED;;GAEG;AACH,SAAgB,YAAY,CAAC,EAAqB;IAChD,OAAO,EAAE,CAAC,MAAM,KAAK,CAAC;QACpB,CAAC,CAAC;YACE,OAAQ,EAA2B,CAAC,IAAI,CAAC,CAAC;QAC5C,CAAC;QACH,CAAC,CAAC,UAAU,IAAoB;YAC5B,OAAO,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACxB,CAAC,CAAC;AACR,CAAC;AARD,oCAQC;AAED;;GAEG;AACH,SAAgB,kBAAkB,CAAC,MAAc,EAAE,OAA8B;IAC/E,IAAI,OAAO,CAAC,OAAO,EAAE;QACnB,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;KAC7E;IAED,IAAI,OAAO,CAAC,OAAO,EAAE;QACnB,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;KAC5E;IAED,IAAI,OAAO,CAAC,GAAG,EAAE;QACf,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YAC3B,IAAI,GAAG;gBACL,GAAG,IAAI;gBACP,EAAE,EAAE,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC;aAC1B,CAAC;YAED,MAAM,CAAC,GAAW,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;KACJ;IAED,IAAI,OAAO,CAAC,IAAI,EAAE;QAChB,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAE,MAAM,CAAC,IAAY,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KAC5E;AACH,CAAC;AAvBD,gDAuBC"}

package/lib/esm/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "module"
-}

package/lib/types-esm/MongooseModule.d.ts

@@ -1,13 +0,0 @@
-import { Configuration, OnInit } from "@tsed/di";
-import { OnDestroy } from "@tsed/di";
-import { MongooseService } from "./services/MongooseService.js";
-/**
- * @ignore
- */
-export declare class MongooseModule implements OnDestroy, OnInit {
-    private mongooseService;
-    private settings;
-    constructor(mongooseService: MongooseService, settings: Configuration);
-    $onInit(): void | Promise<any>;
-    $onDestroy(): Promise<any> | void;
-}

package/lib/types-esm/constants/constants.d.ts

@@ -1,20 +0,0 @@
-/**
- *
- * @type {string}
- */
-export declare const MONGOOSE_SCHEMA = "tsed:mongoose:schema";
-/**
- *
- * @type {string}
- */
-export declare const MONGOOSE_SCHEMA_OPTIONS = "tsed:mongoose:schema:options";
-/**
- *
- * @type {string}
- */
-export declare const MONGOOSE_MODEL = "tsed:mongoose:model";
-/**
- *
- * @type {string}
- */
-export declare const MONGOOSE_MODEL_NAME = "tsed:mongoose:model:name";

package/lib/types-esm/decorators/auto.d.ts

@@ -1,20 +0,0 @@
-/**
- * If true, uses Mongoose's default _id settings. Only allowed for ObjectIds
- *
- * ### Example
- *
- * ```typescript
- * @Model()
- * export class EventModel {
- *   @ExcludeIndexes()
- *   field: string;
- * }
- * ```
- *
- * @param {boolean} auto
- * @returns {Function}
- * @decorator
- * @mongoose
- * @property
- */
-export declare function Auto(auto?: boolean): PropertyDecorator;

package/lib/types-esm/decorators/discriminatorKey.d.ts

@@ -1 +0,0 @@
-export { DiscriminatorKey } from "@tsed/schema";

package/lib/types-esm/decorators/dynamicRef.d.ts

@@ -1,35 +0,0 @@
-import { Type } from "@tsed/core";
-/**
- * Define a property as mongoose reference to other Model (decorated with @Model).
- *
- * ### Example
- *
- * ```typescript
- * @Model()
- * class FooModel {
- *
- *    @DynamicRef('type')
- *    field: DynamicRef<OtherFooModel | OtherModel>
- *
- *    @Enum(['OtherFooModel', 'OtherModel'])
- *    type: string
- * }
- *
- * @Model()
- * class OtherFooModel {
- * }
- *
- * @Model()
- * class OtherModel {
- * }
- * ```
- *
- * @param refPath {String} the path to apply the correct model
- * @param types {Type} the classes to generate the correct json schema
- * @returns {Function}
- * @decorator
- * @mongoose
- * @property
- */
-export declare function DynamicRef(refPath: string, ...types: Type<any>[]): PropertyDecorator;
-export type DynamicRef<T> = T | string;

package/lib/types-esm/decorators/excludeIndexes.d.ts

@@ -1,20 +0,0 @@
-/**
- * If true, Mongoose will skip gathering indexes on subpaths. Only allowed for subdocuments and subdocument arrays.
- *
- * ### Example
- *
- * ```typescript
- * @Model()
- * export class EventModel {
- *   @ExcludeIndexes()
- *   field: string;
- * }
- * ```
- *
- * @param {boolean} excludeIndexes
- * @returns {Function}
- * @decorator
- * @mongoose
- * @property
- */
-export declare function ExcludeIndexes(excludeIndexes?: boolean): PropertyDecorator;

package/lib/types-esm/decorators/expires.d.ts

@@ -1,20 +0,0 @@
-/**
- * Defines a TTL index on this path. Only allowed for dates.
- *
- * ### Example
- *
- * ```typescript
- * @Model()
- * export class EventModel {
- *   @Expires('5d')
- *   field: string;
- * }
- * ```
- *
- * @param {boolean | any} expires
- * @returns {Function}
- * @decorator
- * @mongoose
- * @property
- */
-export declare function Expires(expires: number | string | Date): PropertyDecorator;

package/lib/types-esm/decorators/immutable.d.ts

@@ -1,22 +0,0 @@
-/**
- * If [truthy](https://masteringjs.io/tutorials/fundamentals/truthy), Mongoose will
- * disallow changes to this path once the document is saved to the database for the first time. Read more
- * about [immutability in Mongoose here](http://thecodebarbarian.com/whats-new-in-mongoose-5-6-immutable-properties.html).
- *
- * ### Example
- *
- * ```typescript
- * @Model()
- * export class EventModel {
- *   @Immutable()
- *   field: string;
- * }
- * ```
- *
- * @param {boolean | any} immutable
- * @returns {Function}
- * @decorator
- * @mongoose
- * @property
- */
-export declare function Immutable(immutable?: boolean | ((this: any, doc: any) => boolean)): PropertyDecorator;

package/lib/types-esm/decorators/indexed.d.ts

@@ -1,19 +0,0 @@
-import { IndexOptions } from "mongoose";
-/**
- * Tell Mongoose whether to define an index for the property.
- * ### Example
- *
- * ```typescript
- * @Model()
- * export class EventModel {
- *   @Indexed()
- *   field: string;
- * }
- * ```
- *
- * @returns {Function}
- * @decorator
- * @mongoose
- * @property
- */
-export declare function Indexed(index?: IndexOptions | boolean | string): PropertyDecorator;

package/lib/types-esm/decorators/lowercase.d.ts

@@ -1,20 +0,0 @@
-/**
- * If truthy, Mongoose will add a custom setter that lowercases this string using JavaScript's built-in String#toLowerCase().
- *
- * ### Example
- *
- * ```typescript
- * @Model()
- * export class EventModel {
- *   @Lowercase()
- *   field: string;
- * }
- * ```
- *
- * @param {boolean} lowercase
- * @returns {Function}
- * @decorator
- * @mongoose
- * @property
- */
-export declare function Lowercase(lowercase?: boolean): PropertyDecorator;

package/lib/types-esm/decorators/model.d.ts

@@ -1,39 +0,0 @@
-import { MongooseModelOptions } from "../interfaces/MongooseModelOptions.js";
-/**
- * Define a class as a Mongoose Model. The model can be injected to the Service, Controller, Middleware, Converters or Filter with
- * `@Inject` annotation.
- *
- * ### Example
- *
- * ```typescript
- * @Model()
- * export class EventModel {
- *   @Property()
- *   field: string;
- * }
- * ```
- *
- * Then inject the model into a service:
- *
- * ```typescript
- * class MyService {
- *    constructor(@Inject(EventModel) eventModel: MongooseModel<EventModel>) {
- *        eventModel.findById().exec();
- *    }
- * }
- * ```
- *
- * ### Options
- *
- * - `schemaOptions` (mongoose.SchemaOptions): Option to configure the schema behavior.
- * - `name` (String): model name.
- * - `collection` (String): collection (optional, induced from model name).
- * - `skipInit` (Boolean): skipInit whether to skip initialization (defaults to false).
- *
- * @param {MongooseModelOptions} options
- * @returns {(target: any) => void}
- * @decorator
- * @mongoose
- * @class
- */
-export declare function Model(options?: MongooseModelOptions): any;

package/lib/types-esm/decorators/mongooseIndex.d.ts

@@ -1,27 +0,0 @@
-/**
- * Calls schema.index() to define an index (most likely compound) for the schema.
- *
- * ### Example
- *
- * ```typescript
- * @Model()
- * @MongooseIndex({first: 1, second: 1}, {unique: 1})
- * export class EventModel {
- *
- *   @Property()
- *   first: string;
- *
- *   @Property()
- *   second: string;
- *
- * }
- * ```
- *
- * @param fields
- * @param options
- * @returns {Function}
- * @decorator
- * @mongoose
- * @class
- */
-export declare function MongooseIndex(fields: object, options?: any): Function;

package/lib/types-esm/decorators/mongooseIndexes.d.ts

@@ -1,32 +0,0 @@
-/**
- * Calls schema.index() to define multiple indexes (most likely compound) for the schema.
- *
- * ### Example
- *
- * ```typescript
- * @Model()
- * @MongooseIndexes([{fields: {first: 1, second: 1}, options:{unique: 1}}, {fields: {first: 1, third: 1}, options:{unique: 1}}])
- * export class EventModel {
- *
- *   @Property()
- *   first: string;
- *
- *   @Property()
- *   second: string;
- *
- *   @Property()
- *   third: string;
- *
- * }
- * ```
- *
- * @param indexes - define multiple mongoose indexes
- * @returns {Function}
- * @decorator
- * @mongoose
- * @class
- */
-export declare function MongooseIndexes(indexes: Array<{
-    fields: object;
-    options?: any;
-}>): Function;

package/lib/types-esm/decorators/mongoosePlugin.d.ts

@@ -1,11 +0,0 @@
-import mongoose from "mongoose";
-/**
- *
- * @param {(schema: "mongoose".Schema, options?: any) => void} plugin
- * @param options
- * @returns {Function}
- * @decorator
- * @mongoose
- * @class
- */
-export declare function MongoosePlugin(plugin: (schema: mongoose.Schema, options?: any) => void, options?: any): Function;

package/lib/types-esm/decorators/numberDecimal.d.ts

@@ -1,32 +0,0 @@
-import { FormatsMethods } from "@tsed/ajv";
-import { Types } from "mongoose";
-export declare class DecimalFormat implements FormatsMethods<string | number> {
-    validate(num: string | number): boolean;
-}
-/**
- * Tell Mongoose whether to define an Decimal128 property.
- * Will be serialized as `number` with format as `decimal`.
- * ### Example
- *
- * ```typescript
- * @Model()
- * export class PriceModel {
- *   @NumberDecimal()
- *   price: Decimal128;
- * }
- * ```
- * Optionally using custom decimal type, such as `Big` from big.js
- * ```typescript
- * @Model()
- * export class PriceModel {
- *   @NumberDecimal(Big)
- *   price: Big;
- * }
- * ```
- * @param type Optional decimal type constructor
- * @decorator
- * @mongoose
- * @schema
- */
-export declare function NumberDecimal(type?: any): any;
-export type Decimal128 = Types.Decimal128;

package/lib/types-esm/decorators/objectID.d.ts

@@ -1,19 +0,0 @@
-import { Types } from "mongoose";
-/**
- * Tell Mongoose whether to define an ObjectId property.
- * ### Example
- *
- * ```typescript
- * @Model()
- * export class EventModel {
- *   @ObjectId('id')
- *   _id: string;
- * }
- * ```
- * @param name
- * @decorator
- * @mongoose
- * @schema
- */
-export declare function ObjectID(name?: string): any;
-export type ObjectID = Types.ObjectId;

package/lib/types-esm/decorators/postHook.d.ts

@@ -1,48 +0,0 @@
-import { StaticMethodDecorator } from "@tsed/core";
-import { MongooseHookOptions, MongoosePostHookCB } from "../interfaces/MongooseSchemaOptions.js";
-/**
- * We can simply attach a `@PostHook` decorator to your model class and
- * define the hook function like you normally would in Mongoose.
- *
- * ```typescript
- * import {Ignore, Required} from "@tsed/common";
- * import {PostHook, Model} from "@tsed/mongoose";
- *
- * @Model()
- * @PostHook("save", (car: CarModel) => {
- *    if (car.topSpeedInKmH > 300) {
- *        console.log(car.model, 'is fast!');
- *    }
- * })
- * export class CarModel {
- *    @Ignore()
- *    _id: string;
- *
- *    @Required()
- *    model: string;
- *
- *    @Required()
- *    isFast: boolean;
- *
- *    // or Prehook on static method
- *    @PostHook("save")
- *    static postSave(car: CarModel) {
- *       if (car.topSpeedInKmH > 300) {
- *           console.log(car.model, 'is fast!');
- *       }
- *    }
- * }
- * ```
- *
- * This will execute the post-save hook each time a `CarModel` document is saved.
- *
- * @param {string} method
- * @param fn
- * @returns {Function}
- * @decorator
- * @mongoose
- * @class
- */
-export declare function PostHook<T = any>(method: string, fn: MongoosePostHookCB<T>): ClassDecorator;
-export declare function PostHook<T = any>(method: string, fn: MongoosePostHookCB<T>, options: MongooseHookOptions): ClassDecorator;
-export declare function PostHook<T = any>(method: string, options: MongooseHookOptions): StaticMethodDecorator;

package/lib/types-esm/decorators/preHook.d.ts

@@ -1,49 +0,0 @@
-import { MongooseHookOptions, MongoosePreHookCB } from "../interfaces/MongooseSchemaOptions.js";
-/**
- *
- * We can simply attach a `@PreHook` decorator to your model class and
- * define the hook function like you normally would in Mongoose.
- *
- * ```typescript
- * import {Ignore, Required} from "@tsed/common";
- * import {PreHook, Model} from "@tsed/mongoose";
- *
- * @Model()
- * @PreHook("save", (car: CarModel, next) => {
- *    if (car.model === 'Tesla') {
- *        car.isFast = true;
- *      }
- *      next();
- *})
- * export class CarModel {
- *
- *    @Ignore()
- *    _id: string;
- *
- *    @Required()
- *    model: string;
- *
- *    @Required()
- *    isFast: boolean;
- *
- *    // or Prehook on static method
- *    @PreHook("save")
- *    static preSave(car: CarModel, next) {
- *       if (car.model === 'Tesla') {
- *           car.isFast = true;
- *       }
- *       next();
- *    }
- * }
- * ```
- *
- * This will execute the pre-save hook each time a `CarModel` document is saved.
- *
- * @param {string} method
- * @param fn
- * @param options
- * @returns {Function}
- * @decorator
- * @class
- */
-export declare function PreHook<T = any>(method: string, fn?: MongoosePreHookCB<T> | MongooseHookOptions, options?: MongooseHookOptions): Function;

package/lib/types-esm/decorators/ref.d.ts

@@ -1,38 +0,0 @@
-import { Type } from "@tsed/core";
-import { MongooseSchemaTypes } from "../interfaces/MongooseSchemaTypes.js";
-interface RefOptions {
-    type?: MongooseSchemaTypes;
-    populatedGroups?: string[];
-}
-/**
- * Define a property as mongoose reference to other Model (decorated with @Model).
- *
- * ### Example
- *
- * ```typescript
- *
- * @Model()
- * class FooModel {
- *
- *    @Ref(Foo2Model)
- *    field: Ref<Foo2Model>
- *
- *    @Ref(Foo2Model)
- *    list: Ref<Foo2Model>[]
- * }
- *
- * @Model()
- * class Foo2Model {
- * }
- * ```
- *
- * @param model
- * @param options
- * @returns {Function}
- * @decorator
- * @mongoose
- * @property
- */
-export declare function Ref(model: string | (() => Type) | any, options?: RefOptions | MongooseSchemaTypes): PropertyDecorator;
-export type Ref<T> = T | string;
-export {};

package/lib/types-esm/decorators/schema.d.ts

@@ -1,54 +0,0 @@
-import { SchemaTypeOptions } from "mongoose";
-import { MongooseSchemaOptions } from "../interfaces/MongooseSchemaOptions.js";
-/**
- * Define a class as a Mongoose Schema ready to be used to compose other schemes and models.
- *
- * ### Example
- *
- * ```typescript
- * @MongooseSchema()
- * export class EventSchema {
- *   @Property()
- *   field: string;
- * }
- * ```
- *
- * ### Options
- *
- * - `schemaOptions` (mongoose.SchemaOptions): Option to configure the schema behavior.
- *
- * @param {MongooseSchemaOptions | undefined} options
- * @returns {(target: any) => void}
- * @decorator
- * @mongoose
- * @property
- * @class
- */
-export declare function Schema(options?: MongooseSchemaOptions): (target: any) => void;
-export declare function Schema(definition: SchemaTypeOptions<any>): Function;
-/**
- * Define a class as a Mongoose Schema ready to be used to compose other schemes and models.
- *
- * ### Example
- *
- * ```typescript
- * @MongooseSchema()
- * export class EventSchema {
- *   @Property()
- *   field: string;
- * }
- * ```
- *
- * ### Options
- *
- * - `schemaOptions` (mongoose.SchemaOptions): Option to configure the schema behavior.
- *
- * @param {MongooseSchemaOptions | undefined} options
- * @returns {(target: any) => void}
- * @decorator
- * @mongoose
- * @property
- * @class
- */
-export declare function MongooseSchema(options?: MongooseSchemaOptions): (target: any) => void;
-export declare function MongooseSchema(definition: SchemaTypeOptions<any>): Function;

package/lib/types-esm/decorators/schemaIgnore.d.ts

@@ -1,19 +0,0 @@
-/**
- * Do not apply this property to schema (create virtual property)
- *
- * ### Example
- *
- * ```typescript
- * @Model()
- * @SchemaIgnore()
- * @Property()
- * kind: string;
- *
- * ```
- *
- * @returns {Function}
- * @decorator
- * @mongoose
- * @class
- */
-export declare function SchemaIgnore(): Function;

package/lib/types-esm/decorators/select.d.ts

@@ -1,20 +0,0 @@
-/**
- * Tell Mongoose to set default select() behavior for this path.
- *
- * ### Example
- *
- * ```typescript
- * @Model()
- * export class EventModel {
- *   @Select()
- *   field: string;
- * }
- * ```
- *
- * @param {boolean | any} select
- * @returns {Function}
- * @decorator
- * @mongoose
- * @property
- */
-export declare function Select(select?: boolean | any): Function;