@spinajs/orm 2.0.180 → 2.0.182

package/lib/mjs/decorators.d.ts

@@ -1,153 +1,153 @@
-import { Constructor, IContainer } from '@spinajs/di';
-import { IModelDescriptor, IRelationDescriptor, IDiscriminationEntry } from './interfaces.js';
-import 'reflect-metadata';
-import { ModelBase } from './model.js';
-import { Relation } from './relation-objects.js';
-export declare const MODEL_DESCTRIPTION_SYMBOL: unique symbol;
-export declare const MIGRATION_DESCRIPTION_SYMBOL: unique symbol;
-/**
- * Helper func to create model metadata
- */
-export declare function extractDecoratorDescriptor(callback: (model: IModelDescriptor, target: any, propertyKey: symbol | string, indexOrDescriptor: number | PropertyDescriptor) => void, base?: boolean): any;
-/**
- * Sets migration option
- *
- * @param connection - connection name, must exists in configuration file
- */
-export declare function Migration(connection: string): (target: any) => void;
-/**
- * Connection model decorator, assigns connection to model
- *
- * @param name - connection name, must be avaible in db config
- */
-export declare function Connection(name: string): any;
-/**
- * TableName model decorator, assigns table from database to model
- *
- * @param name - table name in database that is referred by this model
- */
-export declare function Model(tableName: string): any;
-/**
- * Set create timestamps feature to model. Proper columns must be avaible in database table.
- * It allow to track creation times & changes to model
- */
-export declare function CreatedAt(): any;
-/**
- * Set update timestamps feature to model. Proper columns must be avaible in database table.
- * It allow to track creation times & changes to model
- */
-export declare function UpdatedAt(): any;
-/**
- * Sets soft delete feature to model. Soft delete dont delete model, but sets deletion date and hides from
- * select result by default.
- */
-export declare function SoftDelete(): any;
-/**
- * Enable archive mode for model. If enabled all changes creates new instance in DB and old have set archived field
- * and gets attached to new model. It enabled to track changes to model in DB and also preserve data in relations.
- *
- */
-export declare function Archived(): any;
-/**
- * Makrs field as primary key
- */
-export declare function Primary(): any;
-/**
- * Marks columns as UUID. Column will be generated ad creation
- */
-export declare function Ignore(): any;
-/**
- * Marks columns as UUID. Column will be generated ad creation
- */
-export declare function Uuid(): any;
-export declare function JunctionTable(): any;
-/**
- *
- * Marks model to have discrimination map.
- *
- * @param fieldName - db field name to look for
- * @param discriminationMap - field - model mapping
- */
-export declare function DiscriminationMap(fieldName: string, discriminationMap: IDiscriminationEntry[]): any;
-/**
- * Marks relation as recursive. When relation is populated it loads all to the top
- *
- */
-export declare function Recursive(): any;
-export interface IForwardReference<T = any> {
-    forwardRef: T;
-}
-export declare const forwardRef: (fn: () => any) => IForwardReference;
-/**
- * Creates one to one relation with target model.
- *
- * @param foreignKey - foreign key name in db, defaults to lowercase property name with _id suffix eg. owner_id
- * @param primaryKey - primary key in related model, defaults to primary key taken from db
- */
-export declare function BelongsTo(targetModel: Constructor<ModelBase> | string, foreignKey?: string, primaryKey?: string): any;
-/**
- * Creates one to one relation with target model.
- *
- * @param foreignKey - foreign key name in db, defaults to lowercase property name with _id suffix eg. owner_id
- * @param primaryKey - primary key in related model, defaults to primary key taken from db
- */
-export declare function ForwardBelongsTo(forwardRef: IForwardReference, foreignKey?: string, primaryKey?: string): any;
-export interface IHasManyDecoratorOptions {
-    foreignKey?: string;
-    primaryKey?: string;
-    /**
-     * Relation factory, sometimes we dont want to create standard relation object.
-     * When creating object and specific relation is created via this factory
-     */
-    factory?: (owner: ModelBase, relation: IRelationDescriptor, container: IContainer) => Relation<ModelBase<unknown>, ModelBase<unknown>>;
-    /**
-     *  sometimes we dont want to create standard relation object, so we create type
-     *  that is passed in this property
-     */
-    type?: Constructor<Relation<ModelBase<unknown>, ModelBase<unknown>>>;
-}
-/**
- * Creates one to many relation with target model.
- *
- * @param targetModel - due to limitations of metadata reflection api in typescript target model mus be set explicitly
- * @param foreignKey - foreign key name in db, defaults to lowercase property name with _id suffix eg. owner_id
- * @param primaryKey - primary key in source table defaults to lowercase property name with _id suffix eg. owner_id
- *
- */
-export declare function HasMany(targetModel: Constructor<ModelBase> | string, options?: IHasManyDecoratorOptions): any;
-export declare function Historical(targetModel: Constructor<ModelBase>): any;
-/**
- * Creates many to many relation with separate join table
- *
- * @param junctionModel - model for junction table
- * @param targetModel - model for related data
- * @param targetModelPKey - target model primary key name
- * @param sourceModelPKey - source model primary key name
- * @param junctionModelTargetPk - junction table target primary key name ( foreign key for target model )
- * @param junctionModelSourcePk - junction table source primary key name ( foreign key for source model )
- */
-export declare function HasManyToMany(junctionModel: Constructor<ModelBase>, targetModel: Constructor<ModelBase> | string, targetModelPKey?: string, sourceModelPKey?: string, junctionModelTargetPk?: string, junctionModelSourcePk?: string): any;
-/**
- * Mark field as datetime type. It will ensure that conversion to & from DB is valid, eg. sqlite DB
- * saves datetime as TEXT and ISO8601 strings
- */
-export declare function DateTime(): any;
-/**
- * Converts data in db to json object. Column type in DB should be STRING.
- * DO not use this decorator for use of native DB JSON implementation.
- * ORM will detect automatically if field is native JSON DB type.
- */
-export declare function Json(): any;
-/**
- *
- * Universal converter that guess whitch type to return. Usefull in tables that holds as text different values
- * eg. metadata table
- *
- * @param typeColumn - type column that defines final type of value
- */
-export declare function UniversalConverter(typeColumn: string): any;
-/**
- * Mark field as SET type. It will ensure that conversion to & from DB is valid, eg. to emulate field type SET in sqlite
- */
-export declare function Set(): any;
+import { Constructor, IContainer } from '@spinajs/di';
+import { IModelDescriptor, IRelationDescriptor, IDiscriminationEntry } from './interfaces.js';
+import 'reflect-metadata';
+import { ModelBase } from './model.js';
+import { Relation } from './relation-objects.js';
+export declare const MODEL_DESCTRIPTION_SYMBOL: unique symbol;
+export declare const MIGRATION_DESCRIPTION_SYMBOL: unique symbol;
+/**
+ * Helper func to create model metadata
+ */
+export declare function extractDecoratorDescriptor(callback: (model: IModelDescriptor, target: any, propertyKey: symbol | string, indexOrDescriptor: number | PropertyDescriptor) => void, base?: boolean): any;
+/**
+ * Sets migration option
+ *
+ * @param connection - connection name, must exists in configuration file
+ */
+export declare function Migration(connection: string): (target: any) => void;
+/**
+ * Connection model decorator, assigns connection to model
+ *
+ * @param name - connection name, must be avaible in db config
+ */
+export declare function Connection(name: string): any;
+/**
+ * TableName model decorator, assigns table from database to model
+ *
+ * @param name - table name in database that is referred by this model
+ */
+export declare function Model(tableName: string): any;
+/**
+ * Set create timestamps feature to model. Proper columns must be avaible in database table.
+ * It allow to track creation times & changes to model
+ */
+export declare function CreatedAt(): any;
+/**
+ * Set update timestamps feature to model. Proper columns must be avaible in database table.
+ * It allow to track creation times & changes to model
+ */
+export declare function UpdatedAt(): any;
+/**
+ * Sets soft delete feature to model. Soft delete dont delete model, but sets deletion date and hides from
+ * select result by default.
+ */
+export declare function SoftDelete(): any;
+/**
+ * Enable archive mode for model. If enabled all changes creates new instance in DB and old have set archived field
+ * and gets attached to new model. It enabled to track changes to model in DB and also preserve data in relations.
+ *
+ */
+export declare function Archived(): any;
+/**
+ * Makrs field as primary key
+ */
+export declare function Primary(): any;
+/**
+ * Marks columns as UUID. Column will be generated ad creation
+ */
+export declare function Ignore(): any;
+/**
+ * Marks columns as UUID. Column will be generated ad creation
+ */
+export declare function Uuid(): any;
+export declare function JunctionTable(): any;
+/**
+ *
+ * Marks model to have discrimination map.
+ *
+ * @param fieldName - db field name to look for
+ * @param discriminationMap - field - model mapping
+ */
+export declare function DiscriminationMap(fieldName: string, discriminationMap: IDiscriminationEntry[]): any;
+/**
+ * Marks relation as recursive. When relation is populated it loads all to the top
+ *
+ */
+export declare function Recursive(): any;
+export interface IForwardReference<T = any> {
+    forwardRef: T;
+}
+export declare const forwardRef: (fn: () => any) => IForwardReference;
+/**
+ * Creates one to one relation with target model.
+ *
+ * @param foreignKey - foreign key name in db, defaults to lowercase property name with _id suffix eg. owner_id
+ * @param primaryKey - primary key in related model, defaults to primary key taken from db
+ */
+export declare function BelongsTo(targetModel: Constructor<ModelBase> | string, foreignKey?: string, primaryKey?: string): any;
+/**
+ * Creates one to one relation with target model.
+ *
+ * @param foreignKey - foreign key name in db, defaults to lowercase property name with _id suffix eg. owner_id
+ * @param primaryKey - primary key in related model, defaults to primary key taken from db
+ */
+export declare function ForwardBelongsTo(forwardRef: IForwardReference, foreignKey?: string, primaryKey?: string): any;
+export interface IHasManyDecoratorOptions {
+    foreignKey?: string;
+    primaryKey?: string;
+    /**
+     * Relation factory, sometimes we dont want to create standard relation object.
+     * When creating object and specific relation is created via this factory
+     */
+    factory?: (owner: ModelBase, relation: IRelationDescriptor, container: IContainer) => Relation<ModelBase<unknown>, ModelBase<unknown>>;
+    /**
+     *  sometimes we dont want to create standard relation object, so we create type
+     *  that is passed in this property
+     */
+    type?: Constructor<Relation<ModelBase<unknown>, ModelBase<unknown>>>;
+}
+/**
+ * Creates one to many relation with target model.
+ *
+ * @param targetModel - due to limitations of metadata reflection api in typescript target model mus be set explicitly
+ * @param foreignKey - foreign key name in db, defaults to lowercase property name with _id suffix eg. owner_id
+ * @param primaryKey - primary key in source table defaults to lowercase property name with _id suffix eg. owner_id
+ *
+ */
+export declare function HasMany(targetModel: Constructor<ModelBase> | string, options?: IHasManyDecoratorOptions): any;
+export declare function Historical(targetModel: Constructor<ModelBase>): any;
+/**
+ * Creates many to many relation with separate join table
+ *
+ * @param junctionModel - model for junction table
+ * @param targetModel - model for related data
+ * @param targetModelPKey - target model primary key name
+ * @param sourceModelPKey - source model primary key name
+ * @param junctionModelTargetPk - junction table target primary key name ( foreign key for target model )
+ * @param junctionModelSourcePk - junction table source primary key name ( foreign key for source model )
+ */
+export declare function HasManyToMany(junctionModel: Constructor<ModelBase>, targetModel: Constructor<ModelBase> | string, targetModelPKey?: string, sourceModelPKey?: string, junctionModelTargetPk?: string, junctionModelSourcePk?: string): any;
+/**
+ * Mark field as datetime type. It will ensure that conversion to & from DB is valid, eg. sqlite DB
+ * saves datetime as TEXT and ISO8601 strings
+ */
+export declare function DateTime(): any;
+/**
+ * Converts data in db to json object. Column type in DB should be STRING.
+ * DO not use this decorator for use of native DB JSON implementation.
+ * ORM will detect automatically if field is native JSON DB type.
+ */
+export declare function Json(): any;
+/**
+ *
+ * Universal converter that guess whitch type to return. Usefull in tables that holds as text different values
+ * eg. metadata table
+ *
+ * @param typeColumn - type column that defines final type of value
+ */
+export declare function UniversalConverter(typeColumn: string): any;
+/**
+ * Mark field as SET type. It will ensure that conversion to & from DB is valid, eg. to emulate field type SET in sqlite
+ */
+export declare function Set(): any;
 //# sourceMappingURL=decorators.d.ts.map