@tsed/mongoose 7.83.3 → 8.0.0-alpha.10

package/lib/types-esm/decorators/sparse.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 {
- *   @Sparse()
- *   field: string;
- * }
- * ```
- *
- * @param {boolean | number} sparse
- * @returns {Function}
- * @decorator
- * @mongoose
- * @property
- */
-export declare function Sparse(sparse?: boolean | number): PropertyDecorator;

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

@@ -1,21 +0,0 @@
-/**
- * If [truthy](https://masteringjs.io/tutorials/fundamentals/truthy), Mongoose
- * will build a text index on this path.
- *
- * ### Example
- *
- * ```typescript
- * @Model()
- * export class EventModel {
- *   @Text()
- *   field: string;
- * }
- * ```
- *
- * @param {boolean | number | any} text
- * @returns {Function}
- * @decorator
- * @mongoose
- * @property
- */
-export declare function Text(text?: boolean | number | any): PropertyDecorator;

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

@@ -1,19 +0,0 @@
-/**
- * Tell Mongoose to make the property trimmable.
- *
- * ### Example
- *
- * ```typescript
- * @Model()
- * export class EventModel {
- *   @Trim()
- *   name: string;
- * }
- * ```
- *
- * @returns {Function}
- * @decorator
- * @mongoose
- * @property
- */
-export declare function Trim(): Function;

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

@@ -1,19 +0,0 @@
-/**
- * Tell Mongoose to ensure a unique index is created for this path.
- *
- * ### Example
- *
- * ```typescript
- * @Model()
- * export class EventModel {
- *   @Unique()
- *   index: string;
- * }
- * ```
- *
- * @param {boolean | any} unique
- * @returns {Function}
- * @decorator
- * @mongoose
- */
-export declare function Unique(unique?: boolean | any): Function;

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

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

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

@@ -1 +0,0 @@
-export declare function VersionKey(): PropertyDecorator;

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

@@ -1,26 +0,0 @@
-import { MongooseVirtualRefOptions } from "../interfaces/MongooseVirtualRefOptions.js";
-/**
- * Define a property as mongoose virtual reference to other Model (decorated with @Model).
- *
- * ::: warning
- * To avoid circular dependencies, do not use the virtual reference model in
- * anything except a type declaration. Using the virtual reference model will prevent
- * typescript transpiler from stripping away the import statement and cause a circular
- * import in node.
- * :::
- *
- * @param ref
- * @param foreignField
- * @returns {Function}
- * @decorator
- * @mongoose
- * @property
- */
-export declare function VirtualRef(ref: string, foreignField: string): Function;
-export declare function VirtualRef(options: MongooseVirtualRefOptions): Function;
-export declare function VirtualRef(options: string | MongooseVirtualRefOptions, foreignField?: string): Function;
-export type VirtualRef<T> = T | null;
-/**
- * @deprecated Use T[] instead
- */
-export type VirtualRefs<T> = T[];

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

@@ -1,47 +0,0 @@
-/**
- * @file Automatically generated by @tsed/barrels.
- */
-export * from "./constants/constants.js";
-export * from "./decorators/auto.js";
-export * from "./decorators/discriminatorKey.js";
-export * from "./decorators/dynamicRef.js";
-export * from "./decorators/excludeIndexes.js";
-export * from "./decorators/expires.js";
-export * from "./decorators/immutable.js";
-export * from "./decorators/indexed.js";
-export * from "./decorators/lowercase.js";
-export * from "./decorators/model.js";
-export * from "./decorators/mongooseIndex.js";
-export * from "./decorators/mongooseIndexes.js";
-export * from "./decorators/mongoosePlugin.js";
-export * from "./decorators/numberDecimal.js";
-export * from "./decorators/objectID.js";
-export * from "./decorators/postHook.js";
-export * from "./decorators/preHook.js";
-export * from "./decorators/ref.js";
-export * from "./decorators/schema.js";
-export * from "./decorators/schemaIgnore.js";
-export * from "./decorators/select.js";
-export * from "./decorators/sparse.js";
-export * from "./decorators/text.js";
-export * from "./decorators/trim.js";
-export * from "./decorators/unique.js";
-export * from "./decorators/uppercase.js";
-export * from "./decorators/versionKey.js";
-export * from "./decorators/virtualRef.js";
-export * from "./interfaces/interfaces.js";
-export * from "./interfaces/MongooseConnectionOptions.js";
-export * from "./interfaces/MongooseDocument.js";
-export * from "./interfaces/MongooseModel.js";
-export * from "./interfaces/MongooseModelOptions.js";
-export * from "./interfaces/MongooseSchemaOptions.js";
-export * from "./interfaces/MongooseSchemaTypes.js";
-export * from "./interfaces/MongooseVirtualRefOptions.js";
-export * from "./MongooseModule.js";
-export * from "./registries/MongooseModels.js";
-export * from "./services/MongooseConnections.js";
-export * from "./services/MongooseService.js";
-export * from "./utils/createModel.js";
-export * from "./utils/createSchema.js";
-export * from "./utils/resolveRefType.js";
-export * from "./utils/schemaOptions.js";

package/lib/types-esm/interfaces/MongooseConnectionOptions.d.ts

@@ -1,9 +0,0 @@
-import { ConnectOptions } from "mongoose";
-export interface MongooseConnectionOptions {
-    url: string;
-    /**
-     * The connection ID
-     */
-    id: string;
-    connectionOptions?: ConnectOptions;
-}

package/lib/types-esm/interfaces/MongooseDocument.d.ts

@@ -1,2 +0,0 @@
-import { Document } from "mongoose";
-export type MongooseDocument<T> = T & Document;

package/lib/types-esm/interfaces/MongooseModel.d.ts

@@ -1,8 +0,0 @@
-import { Document, Model } from "mongoose";
-export type MongooseMergedDocument<T> = {
-    [K in keyof T]: T[K];
-};
-export interface MongooseDocumentMethods<T> {
-    toClass(): T;
-}
-export type MongooseModel<T> = Model<MongooseMergedDocument<Document & T & MongooseDocumentMethods<T>>>;

package/lib/types-esm/interfaces/MongooseModelOptions.d.ts

@@ -1,11 +0,0 @@
-import { MongooseSchemaOptions } from "./MongooseSchemaOptions.js";
-export interface MongooseModelOptions extends MongooseSchemaOptions {
-    name?: string;
-    connection?: string;
-    collection?: string;
-    overwriteModels?: boolean;
-    /**
-     * @deprecated Since 2022-11-30. Use @DiscriminatorValue instead
-     */
-    discriminatorValue?: string;
-}

package/lib/types-esm/interfaces/MongooseSchemaOptions.d.ts

@@ -1,36 +0,0 @@
-import { type IndexOptions, Schema, SchemaOptions } from "mongoose";
-import { MongooseDocument } from "./MongooseDocument.js";
-export type MongooseNextCB = (err?: Error) => void;
-export interface MongooseHookOptions {
-    document?: boolean;
-    query?: boolean;
-    parallel?: boolean;
-}
-export type MongooseHookPromised<T = any> = (doc: T | MongooseDocument<T>) => Promise<void> | void;
-export type MongoosePreHookCB<T = any> = ((doc: T | MongooseDocument<T>, next: MongooseNextCB) => void) | MongooseHookPromised;
-export type MongoosePostHookCB<T = any> = ((doc: T | MongooseDocument<T>, error: Error, next: MongooseNextCB) => void) | ((doc: T | MongooseDocument<T>, error: Error) => Promise<void> | void) | ((doc: T | MongooseDocument<T>, next: MongooseNextCB) => void) | MongooseHookPromised;
-export interface MongoosePreHook<T = any> {
-    method: string | RegExp;
-    fn: MongoosePreHookCB<T>;
-    options?: MongooseHookOptions;
-}
-export interface MongoosePostHook<T = any> {
-    method: string | RegExp;
-    fn: MongoosePostHookCB<T>;
-    options?: MongooseHookOptions;
-}
-export interface MongoosePluginOptions {
-    plugin: (schema: Schema, options?: any) => void;
-    options?: Record<string, unknown>;
-}
-export interface MongooseIndexOptions {
-    fields: Record<any, any>;
-    options?: IndexOptions;
-}
-export interface MongooseSchemaOptions {
-    schemaOptions?: SchemaOptions;
-    plugins?: MongoosePluginOptions[];
-    indexes?: MongooseIndexOptions[];
-    pre?: MongoosePreHook[];
-    post?: MongoosePostHook[];
-}

package/lib/types-esm/interfaces/MongooseSchemaTypes.d.ts

@@ -1,5 +0,0 @@
-export declare enum MongooseSchemaTypes {
-    OBJECT_ID = "ObjectId",
-    STRING = "String",
-    NUMBER = "Number"
-}

package/lib/types-esm/interfaces/MongooseVirtualRefOptions.d.ts

@@ -1,9 +0,0 @@
-import { Type } from "@tsed/core";
-export interface MongooseVirtualRefOptions {
-    ref?: string | Type<any> | (() => Type<any>);
-    foreignField?: string;
-    localField?: string;
-    justOne?: boolean;
-    count?: boolean;
-    options?: object;
-}

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

@@ -1,8 +0,0 @@
-import { MongooseConnectionOptions } from "./MongooseConnectionOptions.js";
-declare global {
-    namespace TsED {
-        interface Configuration {
-            mongoose: Omit<MongooseConnectionOptions, "id"> | MongooseConnectionOptions[];
-        }
-    }
-}

package/lib/types-esm/registries/MongooseModels.d.ts

@@ -1,2 +0,0 @@
-import { Type } from "@tsed/core";
-export declare const MongooseModels: Map<string, Type>;

package/lib/types-esm/services/MongooseConnections.d.ts

@@ -1,9 +0,0 @@
-import { MongooseService } from "../services/MongooseService.js";
-/**
- * @ignore
- */
-export declare const MONGOOSE_CONNECTIONS: unique symbol;
-/**
- * @ignore
- */
-export type MONGOOSE_CONNECTIONS = MongooseService;

package/lib/types-esm/services/MongooseService.d.ts

@@ -1,25 +0,0 @@
-import { Logger } from "@tsed/logger";
-import Mongoose from "mongoose";
-import { ConnectOptions } from "mongoose";
-export declare class MongooseService {
-    readonly connections: Map<string, Mongoose.Connection>;
-    private defaultConnection;
-    logger: Logger;
-    /**
-     *
-     * @returns {Promise<"mongoose".Connection>}
-     */
-    connect(id: string, url: string, connectionOptions: ConnectOptions, isDefault?: boolean): Promise<any>;
-    /**
-     *
-     * @returns {"mongoose".Connection}
-     */
-    get(id?: string): Mongoose.Connection | undefined;
-    /**
-     *
-     * @param {string} id
-     * @returns {boolean}
-     */
-    has(id?: string): boolean;
-    closeConnections(): Promise<void>;
-}

package/lib/types-esm/utils/createModel.d.ts

@@ -1,18 +0,0 @@
-import { Type } from "@tsed/core";
-import mongoose, { Connection } from "mongoose";
-export declare function getModelToken(target: Type<any>, options: any): {
-    token: symbol;
-    collectionName: any;
-};
-/**
- * Create an instance of mongoose.model from a class.
- *
- * @param {Type<any>} target Class attached to the schema and model.
- * @param {"mongoose".Schema} schema Schema that will be attached to the model.
- * @param name model name
- * @param collection (optional, induced from model name)
- * @param overwriteModels
- * @param connection
- * @returns {Model<T extends Document>}
- */
-export declare function createModel<T>(target: any, schema: mongoose.Schema, name?: string, collection?: string, overwriteModels?: boolean, connection?: Connection): any;

package/lib/types-esm/utils/createSchema.d.ts

@@ -1,28 +0,0 @@
-import { Type } from "@tsed/core";
-import { JsonEntityStore } from "@tsed/schema";
-import mongoose, { Schema, SchemaDefinition, SchemaTypeOptions } from "mongoose";
-import { MongooseSchemaOptions } from "../interfaces/MongooseSchemaOptions.js";
-import { MongooseVirtualRefOptions } from "../interfaces/MongooseVirtualRefOptions.js";
-export interface MongooseSchemaMetadata {
-    schema: SchemaDefinition;
-    virtuals: Map<string, MongooseVirtualRefOptions>;
-}
-export declare function createSchema(target: Type<any>, options?: MongooseSchemaOptions): mongoose.Schema;
-/**
- * Get a schema already created. If the schema doesn't exists in registry, it'll be created.
- * @param target
- * @param options
- */
-export declare function getSchema(target: Type<any>, options?: MongooseSchemaOptions): Schema;
-export declare function getSchemaToken(target: Type<any>, options?: any): {
-    token: symbol;
-    collectionName: any;
-};
-/**
- * @ignore
- */
-export declare function buildMongooseSchema(target: any): MongooseSchemaMetadata;
-/**
- * @ignore
- */
-export declare function createSchemaTypeOptions<T = any>(propEntity: JsonEntityStore): SchemaTypeOptions<T> | SchemaTypeOptions<T>[];

package/lib/types-esm/utils/resolveRefType.d.ts

@@ -1,5 +0,0 @@
-import { Type } from "@tsed/core";
-/**
- * @ignore
- */
-export declare function resolveRefType(type: string | (() => Type<any>) | Type<any>): string;

package/lib/types-esm/utils/schemaOptions.d.ts

@@ -1,14 +0,0 @@
-import { Schema } from "mongoose";
-import { MongooseNextCB, MongoosePreHookCB, MongooseSchemaOptions } from "../interfaces/MongooseSchemaOptions.js";
-/**
- * @ignore
- */
-export declare function schemaOptions(target: any, options?: MongooseSchemaOptions): any;
-/**
- * @ignore
- */
-export declare function buildPreHook(fn: MongoosePreHookCB): (next: MongooseNextCB) => void | Promise<void>;
-/**
- * @ignore
- */
-export declare function applySchemaOptions(schema: Schema, options: MongooseSchemaOptions): void;