ts-prorm-orm 2.0.0 → 2.1.0

package/dist/models/decorators.d.ts

@@ -215,55 +215,55 @@ export declare function AllowNull(allowNull?: boolean): PropertyDecorator;
  * Mark attribute as primary key
  *
  * @example
- * @Attribute(DataTypes.INTEGER)
- * @PrimaryKey
+ * `@Attribute`(DataTypes.INTEGER)
+ * `@PrimaryKey`
  */
 export declare function PrimaryKey(): PropertyDecorator;
 /**
  * Enable auto-increment on attribute
  *
  * @example
- * @Attribute(DataTypes.INTEGER)
- * @AutoIncrement
+ * `@Attribute`(DataTypes.INTEGER)
+ * `@AutoIncrement`
  */
 export declare function AutoIncrement(): PropertyDecorator;
 /**
  * Add NOT NULL constraint
  *
  * @example
- * @Attribute(DataTypes.STRING)
- * @NotNull
+ * `@Attribute`(DataTypes.STRING)
+ * `@NotNull`
  */
 export declare function NotNull(): PropertyDecorator;
 /**
  * Set default value
  *
  * @example
- * @Default('value')
- * @Default(DataTypes.NOW)
- * @Default(() => Math.random())
+ * `@Default`('value')
+ * `@Default`(DataTypes.NOW)
+ * `@Default`(() => Math.random())
  */
 export declare function Default(value: any): PropertyDecorator;
 /**
  * Add UNIQUE constraint
  *
  * @example
- * @Unique
- * @Unique('unique_name')
+ * `@Unique`
+ * `@Unique`('unique_name')
  */
 export declare function Unique(nameOrOptions?: string | boolean): PropertyDecorator;
 /**
  * Add comment to column
  *
  * @example
- * @Comment('User email address')
+ * `@Comment`('User email address')
  */
 export declare function Comment(text: string): PropertyDecorator;
 /**
  * Define a hasOne association
  *
  * @example
- * @HasOne(() => Profile)
+ * `@HasOne`(() => Profile)
  * declare profile: HasOne<Profile>;
  */
 export declare function HasOne(targetFn: () => any, options?: HasOneOptions): PropertyDecorator;
@@ -271,7 +271,7 @@ export declare function HasOne(targetFn: () => any, options?: HasOneOptions): Pr
  * Define a hasMany association
  *
  * @example
- * @HasMany(() => Post)
+ * `@HasMany`(() => Post)
  * declare posts: HasMany<Post>;
  */
 export declare function HasMany(targetFn: () => any, options?: HasManyOptions): PropertyDecorator;
@@ -279,7 +279,7 @@ export declare function HasMany(targetFn: () => any, options?: HasManyOptions):
  * Define a belongsTo association
  *
  * @example
- * @BelongsTo(() => User)
+ * `@BelongsTo`(() => User)
  * declare user: BelongsTo<User>;
  */
 export declare function BelongsTo(targetFn: () => any, options?: BelongsToOptions): PropertyDecorator;
@@ -287,7 +287,7 @@ export declare function BelongsTo(targetFn: () => any, options?: BelongsToOption
  * Define a belongsToMany association
  *
  * @example
- * @BelongsToMany(() => Role, { through: UserRole })
+ * `@BelongsToMany`(() => Role, { through: UserRole })
  * declare roles: BelongsToMany<Role>;
  */
 export declare function BelongsToMany(targetFn: () => any, options: BelongsToManyOptions): PropertyDecorator;

package/dist/models/decorators.js

@@ -71,7 +71,7 @@ const associationMetadata = new Map();
  * Define model options (use on model class)
  *
  * @example
- * @Table({ tableName: 'users', timestamps: true })
+ * `@Table`({ tableName: 'users', timestamps: true })
  */
 /** Classes marked with `@AbstractModel`, by constructor name. */
 const abstractModels = new Set();
@@ -181,8 +181,8 @@ function Table(options = {}) {
  * Define a model attribute/column
  *
  * @example
- * @Attribute(DataTypes.STRING)
- * @Attribute(DataTypes.INTEGER)
+ * `@Attribute`(DataTypes.STRING)
+ * `@Attribute`(DataTypes.INTEGER)
  */
 /**
  * Get (creating if needed) the attribute entry for a decorated property.
@@ -193,10 +193,12 @@ function Table(options = {}) {
  * yet, and `@Column` then replaced whatever they had set - so the documented
  * ordering
  *
+ * ```ts
  *     @Column(DataTypes.INTEGER())
  *     @PrimaryKey()
  *     @AutoIncrement()
  *     declare id: number;
+ * ```
  *
  * produced a plain nullable INTEGER with no primary key and no auto-increment.
  * Every decorator now goes through this helper and merges, making the stack
@@ -249,8 +251,8 @@ function AllowNull(allowNull = true) {
  * Mark attribute as primary key
  *
  * @example
- * @Attribute(DataTypes.INTEGER)
- * @PrimaryKey
+ * `@Attribute`(DataTypes.INTEGER)
+ * `@PrimaryKey`
  */
 function PrimaryKey() {
     return function (target, propertyKey) {
@@ -265,8 +267,8 @@ function PrimaryKey() {
  * Enable auto-increment on attribute
  *
  * @example
- * @Attribute(DataTypes.INTEGER)
- * @AutoIncrement
+ * `@Attribute`(DataTypes.INTEGER)
+ * `@AutoIncrement`
  */
 function AutoIncrement() {
     return function (target, propertyKey) {
@@ -279,8 +281,8 @@ function AutoIncrement() {
  * Add NOT NULL constraint
  *
  * @example
- * @Attribute(DataTypes.STRING)
- * @NotNull
+ * `@Attribute`(DataTypes.STRING)
+ * `@NotNull`
  */
 function NotNull() {
     return function (target, propertyKey) {
@@ -298,9 +300,9 @@ function NotNull() {
  * Set default value
  *
  * @example
- * @Default('value')
- * @Default(DataTypes.NOW)
- * @Default(() => Math.random())
+ * `@Default`('value')
+ * `@Default`(DataTypes.NOW)
+ * `@Default`(() => Math.random())
  */
 function Default(value) {
     return function (target, propertyKey) {
@@ -314,8 +316,8 @@ function Default(value) {
  * Add UNIQUE constraint
  *
  * @example
- * @Unique
- * @Unique('unique_name')
+ * `@Unique`
+ * `@Unique`('unique_name')
  */
 function Unique(nameOrOptions) {
     return function (target, propertyKey) {
@@ -329,7 +331,7 @@ function Unique(nameOrOptions) {
  * Add comment to column
  *
  * @example
- * @Comment('User email address')
+ * `@Comment`('User email address')
  */
 function Comment(text) {
     return function (target, propertyKey) {
@@ -344,7 +346,7 @@ function Comment(text) {
  * Define a hasOne association
  *
  * @example
- * @HasOne(() => Profile)
+ * `@HasOne`(() => Profile)
  * declare profile: HasOne<Profile>;
  */
 function HasOne(targetFn, options = {}) {
@@ -373,7 +375,7 @@ function HasOne(targetFn, options = {}) {
  * Define a hasMany association
  *
  * @example
- * @HasMany(() => Post)
+ * `@HasMany`(() => Post)
  * declare posts: HasMany<Post>;
  */
 function HasMany(targetFn, options = {}) {
@@ -402,7 +404,7 @@ function HasMany(targetFn, options = {}) {
  * Define a belongsTo association
  *
  * @example
- * @BelongsTo(() => User)
+ * `@BelongsTo`(() => User)
  * declare user: BelongsTo<User>;
  */
 function BelongsTo(targetFn, options = {}) {
@@ -431,7 +433,7 @@ function BelongsTo(targetFn, options = {}) {
  * Define a belongsToMany association
  *
  * @example
- * @BelongsToMany(() => Role, { through: UserRole })
+ * `@BelongsToMany`(() => Role, { through: UserRole })
  * declare roles: BelongsToMany<Role>;
  */
 function BelongsToMany(targetFn, options) {

package/dist/schema-objects.d.ts

@@ -16,6 +16,9 @@ export type SqlDialectName = 'mysql' | 'mariadb' | 'postgres' | 'cockroachdb' |
 export declare class UnsupportedSchemaObjectError extends Error {
     constructor(object: string, dialect: string, hint?: string);
 }
+/**
+ * A named sequence: its start, increment, bounds and caching.
+ */
 export interface SequenceOptions {
     /** Value the sequence starts at (default 1) */
     start?: number;
@@ -32,8 +35,18 @@ export interface SequenceOptions {
     /** Emit IF NOT EXISTS where supported */
     ifNotExists?: boolean;
 }
+/**
+ * Builds `CREATE SEQUENCE` for the dialect.
+ */
 export declare function buildCreateSequenceSQL(name: string, options: SequenceOptions, dialect: SqlDialectName, quoteId: (id: string) => string): string;
+/**
+ * Builds `DROP SEQUENCE` for the dialect.
+ */
 export declare function buildDropSequenceSQL(name: string, dialect: SqlDialectName, quoteId: (id: string) => string, ifExists?: boolean): string;
+/**
+ * A row-level security policy: who it applies to, which command, and the
+ * expressions that decide visibility (`using`) and writability (`withCheck`).
+ */
 export interface PolicyOptions {
     /** Table the policy applies to */
     table: string;
@@ -48,9 +61,23 @@ export interface PolicyOptions {
     /** Roles the policy applies to */
     to?: string[];
 }
+/**
+ * Builds the statement that turns row-level security on for a table. Until
+ * this runs, policies are defined but not enforced.
+ */
 export declare function buildEnableRowLevelSecuritySQL(table: string, dialect: SqlDialectName, quoteTable: (t: string) => string, enable?: boolean): string;
+/**
+ * Builds `CREATE POLICY` for a row-level security rule.
+ */
 export declare function buildCreatePolicySQL(options: PolicyOptions, dialect: SqlDialectName, quoteId: (id: string) => string, quoteTable: (t: string) => string): string;
+/**
+ * Builds `DROP POLICY`.
+ */
 export declare function buildDropPolicySQL(name: string, table: string, dialect: SqlDialectName, quoteId: (id: string) => string, quoteTable: (t: string) => string, ifExists?: boolean): string;
+/**
+ * A full-text index: the columns it covers, the language configuration, and
+ * any per-column weighting the engine supports.
+ */
 export interface FullTextIndexOptions {
     /** Index name */
     name: string;
@@ -61,7 +88,14 @@ export interface FullTextIndexOptions {
     /** Text search configuration (PostgreSQL), e.g. 'english' */
     language?: string;
 }
+/**
+ * Builds the engine's full-text index statement — a GIN index over a tsvector
+ * on PostgreSQL, `FULLTEXT` on MySQL, an FTS5 virtual table on SQLite.
+ */
 export declare function buildCreateFullTextIndexSQL(options: FullTextIndexOptions, dialect: SqlDialectName, quoteId: (id: string) => string, quoteTable: (t: string) => string): string;
+/**
+ * A trigger: when it fires, on which events, and the body it runs.
+ */
 export interface TriggerDefinition {
     name: string;
     table: string;
@@ -74,5 +108,13 @@ export interface TriggerDefinition {
     /** Condition guarding the trigger */
     when?: string;
 }
+/**
+ * Builds the statements a trigger needs. Some engines want a separate
+ * function or procedure before the trigger itself, so this returns a list
+ * rather than one statement.
+ */
 export declare function buildCreateTriggerStatements(trigger: TriggerDefinition, dialect: SqlDialectName, quoteId: (id: string) => string, quoteTable: (t: string) => string): string[];
+/**
+ * Builds `DROP TRIGGER`.
+ */
 export declare function buildDropTriggerSQL(name: string, table: string, dialect: SqlDialectName, quoteId: (id: string) => string, quoteTable: (t: string) => string, ifExists?: boolean): string;

package/dist/schema-objects.js

@@ -54,6 +54,9 @@ class UnsupportedSchemaObjectError extends Error {
     }
 }
 exports.UnsupportedSchemaObjectError = UnsupportedSchemaObjectError;
+/**
+ * Builds `CREATE SEQUENCE` for the dialect.
+ */
 function buildCreateSequenceSQL(name, options, dialect, quoteId) {
     if (isSqliteFamily(dialect)) {
         throw new UnsupportedSchemaObjectError('CREATE SEQUENCE', dialect, 'SQLite has no sequences - use an INTEGER PRIMARY KEY AUTOINCREMENT column instead.');
@@ -83,6 +86,9 @@ function buildCreateSequenceSQL(name, options, dialect, quoteId) {
         parts.push('CYCLE');
     return parts.join(' ');
 }
+/**
+ * Builds `DROP SEQUENCE` for the dialect.
+ */
 function buildDropSequenceSQL(name, dialect, quoteId, ifExists = true) {
     if (isSqliteFamily(dialect) || dialect === 'mysql') {
         throw new UnsupportedSchemaObjectError('DROP SEQUENCE', dialect);
@@ -91,6 +97,10 @@ function buildDropSequenceSQL(name, dialect, quoteId, ifExists = true) {
     const guard = ifExists && dialect !== 'oracle' ? 'IF EXISTS ' : '';
     return `DROP SEQUENCE ${guard}${quoteId(name)}`;
 }
+/**
+ * Builds the statement that turns row-level security on for a table. Until
+ * this runs, policies are defined but not enforced.
+ */
 function buildEnableRowLevelSecuritySQL(table, dialect, quoteTable, enable = true) {
     if (!isPostgresFamily(dialect)) {
         throw new UnsupportedSchemaObjectError('Row-level security', dialect, dialect === 'mssql'
@@ -99,6 +109,9 @@ function buildEnableRowLevelSecuritySQL(table, dialect, quoteTable, enable = tru
     }
     return `ALTER TABLE ${quoteTable(table)} ${enable ? 'ENABLE' : 'DISABLE'} ROW LEVEL SECURITY`;
 }
+/**
+ * Builds `CREATE POLICY` for a row-level security rule.
+ */
 function buildCreatePolicySQL(options, dialect, quoteId, quoteTable) {
     if (!isPostgresFamily(dialect)) {
         throw new UnsupportedSchemaObjectError('CREATE POLICY', dialect);
@@ -114,12 +127,19 @@ function buildCreatePolicySQL(options, dialect, quoteId, quoteTable) {
         sql += ` WITH CHECK (${options.withCheck})`;
     return sql;
 }
+/**
+ * Builds `DROP POLICY`.
+ */
 function buildDropPolicySQL(name, table, dialect, quoteId, quoteTable, ifExists = true) {
     if (!isPostgresFamily(dialect)) {
         throw new UnsupportedSchemaObjectError('DROP POLICY', dialect);
     }
     return `DROP POLICY ${ifExists ? 'IF EXISTS ' : ''}${quoteId(name)} ON ${quoteTable(table)}`;
 }
+/**
+ * Builds the engine's full-text index statement — a GIN index over a tsvector
+ * on PostgreSQL, `FULLTEXT` on MySQL, an FTS5 virtual table on SQLite.
+ */
 function buildCreateFullTextIndexSQL(options, dialect, quoteId, quoteTable) {
     const { name, table, columns, language = 'english' } = options;
     if (!columns.length) {
@@ -145,6 +165,11 @@ function buildCreateFullTextIndexSQL(options, dialect, quoteId, quoteTable) {
     }
     throw new UnsupportedSchemaObjectError('Full-text index', dialect);
 }
+/**
+ * Builds the statements a trigger needs. Some engines want a separate
+ * function or procedure before the trigger itself, so this returns a list
+ * rather than one statement.
+ */
 function buildCreateTriggerStatements(trigger, dialect, quoteId, quoteTable) {
     const { name, table, timing, event, body, forEach = 'ROW', when } = trigger;
     if (isPostgresFamily(dialect)) {
@@ -188,6 +213,9 @@ function buildCreateTriggerStatements(trigger, dialect, quoteId, quoteTable) {
     }
     throw new UnsupportedSchemaObjectError('CREATE TRIGGER', dialect);
 }
+/**
+ * Builds `DROP TRIGGER`.
+ */
 function buildDropTriggerSQL(name, table, dialect, quoteId, quoteTable, ifExists = true) {
     const guard = ifExists ? 'IF EXISTS ' : '';
     if (isMysqlFamily(dialect) || isSqliteFamily(dialect)) {