kysely-sequelize/dist/cjs/index.d.ts

Kysely dialect for Sequelize

import { Dialect, DialectAdapter, Driver, Kysely, DatabaseIntrospector, QueryCompiler, DatabaseConnection, TransactionSettings, CompiledQuery, QueryResult, Generated, GeneratedAlways as GeneratedAlways$1 } from 'kysely';
import { Sequelize } from 'sequelize-typescript';
import { Sequelize as Sequelize$1, Model, InferAttributes, CreationOptional, ForeignKey, NonAttribute } from 'sequelize';

interface KyselySequelizeDialectConfig {
    kyselySubDialect: KyselySubDialect;
    sequelize: Sequelize;
}
type KyselySubDialect = Omit<Dialect, 'createDriver'>;

declare class KyselySequelizeDialect implements Dialect {
    #private;
    constructor(config: KyselySequelizeDialectConfig);
    createAdapter(): DialectAdapter;
    createDriver(): Driver;
    createIntrospector(db: Kysely<any>): DatabaseIntrospector;
    createQueryCompiler(): QueryCompiler;
}

declare class KyselySequelizeConnection implements DatabaseConnection {
    #private;
    constructor(sequelize: Sequelize$1);
    beginTransaction(settings: TransactionSettings): Promise<void>;
    commitTransaction(): Promise<void>;
    release(): void;
    rollbackTransaction(): Promise<void>;
    executeQuery<R>(compiledQuery: CompiledQuery<unknown>): Promise<QueryResult<R>>;
    streamQuery<R>(_compiledQuery: CompiledQuery<unknown>, _chunkSize?: number | undefined): AsyncIterableIterator<QueryResult<R>>;
}

declare class KyselySequelizeDriver implements Driver {
    #private;
    constructor(config: KyselySequelizeDialectConfig);
    acquireConnection(): Promise<DatabaseConnection>;
    beginTransaction(connection: KyselySequelizeConnection, settings: TransactionSettings): Promise<void>;
    commitTransaction(connection: KyselySequelizeConnection): Promise<void>;
    destroy(): Promise<void>;
    init(): Promise<void>;
    releaseConnection(connection: KyselySequelizeConnection): Promise<void>;
    rollbackTransaction(connection: KyselySequelizeConnection): Promise<void>;
}

/**
 * Translates a sequelize `CreationAttributes` type (legacy pre 6.14.0) to a Kysely
 * table schema type.
 *
 * @example
 *
 * ```ts
 * type ToyAttributes {
 *   id: number
 *   name: string
 *   price: number
 *   petId: number
 * }
 *
 * type ToyCreationAttributes = Optional<ToyAttributes, 'id'>
 *
 * \@Table({modelName: 'Toy', tableName: 'toy', timestamps: false, underscored: true})
 * export class ToyModel extends Model<ToyAttributes, ToyCreationAttributes> {
 *   declare id: ToyAttributes['id']
 *
 *   \@Column({allowNull: false, type: DataType.STRING(255)})
 *   name: ToyAttributes['name']
 *
 *   \@Column({allowNull: false, type: DataType.INTEGER})
 *   \@ForeignKey(() => PetModel)
 *   petId: ToyAttributes['petId']
 *
 *   \@Column({allowNull: false, type: DataType.DOUBLE})
 *   price: ToyAttributes['price']
 *
 *   \@BelongsTo(() => PetModel)
 *   pet: PetModel
 * }
 *
 * export type Toy = KyselifyCreationAttributes<ToyCreationAttributes>
 *
 * interface Database {
 *   toy: Toy
 * }
 *
 * export const db = new Kysely<Database>({
 *   // ...
 * })
 * ```
 *
 * @template CA - CreationAttributes
 * @template O - Overrides
 */
type KyselifyCreationAttributes<CA, O = {}> = {
    [K in keyof CA]-?: K extends keyof O ? O[K] : undefined extends CA[K] ? Generated<Exclude<CA[K], undefined>> : CA[K];
};
/**
 * Similar to Kysely's `GeneratedAlways` type, but is compatible with sequelize's
 * branded types (e.g. `CreationOptional`).
 *
 * @example
 *
 * ```ts
 * declare id: GeneratedAlways<CreationOptional<number>>
 * ```
 *
 * @template T - a column defined as `CreationOptional`.
 */
type GeneratedAlways<T> = T & {
    readonly __kysely__generated__always__?: unique symbol;
};
/**
 * Translates a sequelize model (>= 6.14.0) to a Kysely table schema type.
 *
 * @example
 *
 * \@Table({modelName: 'KitchenSink', tableName: 'kitchen_sink', underscored: true})
 * export class KitchenSinkModel extends Model<
 *   InferAttributes<KitchenSinkModel>,
 *   InferCreationAttributes<KitchenSinkModel>
 * > {
 *   declare id: GeneratedAlways<CreationOptional<number>>
 *
 *   \@Column({allowNull: false, type: DataType.STRING(255)})
 *   name: string
 *
 *   \@Column(DataType.STRING(255))
 *   preferredName: string | null
 *
 *   declare createdAt: CreationOptional<Date>
 *   declare updatedAt: CreationOptional<Date>
 *
 *   declare getProjects: HasManyGetAssociationsMixin<any>
 *   declare addProject: HasManyAddAssociationMixin<any, number>
 *   declare addProjects: HasManyAddAssociationsMixin<any, number>
 *   declare setProjects: HasManySetAssociationsMixin<any, number>
 *   declare removeProject: HasManyRemoveAssociationMixin<any, number>
 *   declare removeProjects: HasManyRemoveAssociationsMixin<any, number>
 *   declare hasProject: HasManyHasAssociationMixin<any, number>
 *   declare hasProjects: HasManyHasAssociationsMixin<any, number>
 *   declare countProjects: HasManyCountAssociationsMixin
 *   declare createProject: HasManyCreateAssociationMixin<any, 'ownerId'>
 *
 *   \@HasMany(() => ProjectModel, 'kitchenSinkId')
 *   projects: NonAttribute<ProjectModel[]>
 *
 *   \@HasOne(() => KitchenModel, 'kitchenId')
 *   kitchen: NonAttribute<KitchenModel>
 *
 *   declare kitchenId: ForeignKey<number | null>
 *
 *   get fullName(): NonAttribute<string> {
 *     return this.name
 *   }
 *
 *   declare static associations: {
 *     projects: Association<KitchenSinkModel, ProjectModel>
 *   }
 * }
 *
 * type KitchenSink = KyselifyModel<KitchenSinkModel>
 *
 * interface Database {
 *   kitchenSink: KitchenSink
 * }
 *
 * export const db = new Kysely<Database>({
 *   // ...
 * })
 *
 * @template M - Model
 * @template O - Overrides
 */
type KyselifyModel<M extends Model<any, any>, O = {}> = {
    [K in keyof InferAttributes<M> as NonAttribute<any> extends M[K] ? never : K]-?: K extends keyof O ? O[K] : '__kysely__generated__always__' extends keyof M[K] ? M[K] extends GeneratedAlways<infer T> ? keyof CreationOptional<{}> extends keyof T ? T extends CreationOptional<infer U> ? GeneratedAlways$1<U> : never : never : never : keyof CreationOptional<{}> extends keyof M[K] ? M[K] extends CreationOptional<infer T> ? Generated<T> : never : M[K] extends ForeignKey<infer T> ? undefined extends T ? Exclude<T, undefined> | null : T : undefined extends M[K] ? Exclude<M[K], undefined> | null : M[K];
};

export { GeneratedAlways, KyselifyCreationAttributes, KyselifyModel, KyselySequelizeDialect, KyselySequelizeDialectConfig, KyselySequelizeDriver, KyselySubDialect };