@lakutata/orm 0.0.0-stage → 3.0.0-beta.0

package/dist/types/exports/ORM.d.ts

@@ -0,0 +1,193 @@
+import 'reflect-metadata';
+export { type QueryResultCache } from 'typeorm/cache/QueryResultCache.js';
+export { type QueryResultCacheOptions } from 'typeorm/cache/QueryResultCacheOptions.js';
+export { type IsolationLevel } from 'typeorm/driver/types/IsolationLevel.js';
+export * from 'typeorm/globals.js';
+export * from 'typeorm/container.js';
+export * from 'typeorm/common/EntityTarget.js';
+export * from 'typeorm/common/ObjectType.js';
+export * from 'typeorm/common/ObjectLiteral.js';
+export * from 'typeorm/common/MixedList.js';
+export * from 'typeorm/common/DeepPartial.js';
+export * from 'typeorm/common/RelationType.js';
+export * from 'typeorm/error/index.js';
+export * from 'typeorm/decorator/options/ColumnOptions.js';
+export * from 'typeorm/decorator/options/IndexOptions.js';
+export * from 'typeorm/decorator/options/JoinColumnOptions.js';
+export * from 'typeorm/decorator/options/JoinTableOptions.js';
+export * from 'typeorm/decorator/options/RelationOptions.js';
+export * from 'typeorm/decorator/options/EntityOptions.js';
+export * from 'typeorm/decorator/options/ValueTransformer.js';
+export * from 'typeorm/find-options/operator/And.js';
+export * from 'typeorm/find-options/operator/Or.js';
+export * from 'typeorm/find-options/operator/Any.js';
+export * from 'typeorm/find-options/operator/ArrayContainedBy.js';
+export * from 'typeorm/find-options/operator/ArrayContains.js';
+export * from 'typeorm/find-options/operator/ArrayOverlap.js';
+export * from 'typeorm/find-options/operator/Between.js';
+export * from 'typeorm/find-options/operator/Equal.js';
+export * from 'typeorm/find-options/operator/In.js';
+export * from 'typeorm/find-options/operator/IsNull.js';
+export * from 'typeorm/find-options/operator/LessThan.js';
+export * from 'typeorm/find-options/operator/LessThanOrEqual.js';
+export * from 'typeorm/find-options/operator/ILike.js';
+export * from 'typeorm/find-options/operator/Like.js';
+export * from 'typeorm/find-options/operator/MoreThan.js';
+export * from 'typeorm/find-options/operator/MoreThanOrEqual.js';
+export * from 'typeorm/find-options/operator/Not.js';
+export * from 'typeorm/find-options/operator/Raw.js';
+export * from 'typeorm/find-options/operator/JsonContains.js';
+export * from 'typeorm/find-options/EqualOperator.js';
+export * from 'typeorm/find-options/FindManyOptions.js';
+export * from 'typeorm/find-options/FindOneOptions.js';
+export * from 'typeorm/find-options/FindOperator.js';
+export * from 'typeorm/find-options/FindOperatorType.js';
+export * from 'typeorm/find-options/FindOptionsOrder.js';
+export * from 'typeorm/find-options/FindOptionsRelations.js';
+export * from 'typeorm/find-options/FindOptionsSelect.js';
+export * from 'typeorm/find-options/FindOptionsUtils.js';
+export * from 'typeorm/find-options/FindOptionsWhere.js';
+export * from 'typeorm/find-options/FindTreeOptions.js';
+export * from 'typeorm/find-options/JoinOptions.js';
+export * from 'typeorm/find-options/OrderByCondition.js';
+export * from 'typeorm/logger/AbstractLogger.js';
+export * from 'typeorm/logger/Logger.js';
+export * from 'typeorm/logger/LoggerOptions.js';
+export * from 'typeorm/logger/AdvancedConsoleLogger.js';
+export * from 'typeorm/logger/SimpleConsoleLogger.js';
+export * from 'typeorm/logger/FileLogger.js';
+export * from 'typeorm/metadata/EntityMetadata.js';
+export * from 'typeorm/metadata/CheckMetadata.js';
+export * from 'typeorm/metadata/ColumnMetadata.js';
+export * from 'typeorm/metadata/EmbeddedMetadata.js';
+export * from 'typeorm/metadata/EntityListenerMetadata.js';
+export * from 'typeorm/metadata/ExclusionMetadata.js';
+export * from 'typeorm/metadata/ForeignKeyMetadata.js';
+export * from 'typeorm/metadata/IndexMetadata.js';
+export * from 'typeorm/metadata/RelationMetadata.js';
+export * from 'typeorm/metadata/RelationCountMetadata.js';
+export * from 'typeorm/metadata/UniqueMetadata.js';
+export * from 'typeorm/entity-manager/EntityManager.js';
+export * from 'typeorm/repository/AbstractRepository.js';
+export * from 'typeorm/repository/Repository.js';
+export * from 'typeorm/repository/BaseEntity.js';
+export * from 'typeorm/repository/TreeRepository.js';
+export * from 'typeorm/repository/MongoRepository.js';
+export * from 'typeorm/repository/RemoveOptions.js';
+export * from 'typeorm/repository/SaveOptions.js';
+export * from 'typeorm/schema-builder/table/TableCheck.js';
+export * from 'typeorm/schema-builder/table/TableColumn.js';
+export * from 'typeorm/schema-builder/table/TableExclusion.js';
+export * from 'typeorm/schema-builder/table/TableForeignKey.js';
+export * from 'typeorm/schema-builder/table/TableIndex.js';
+export * from 'typeorm/schema-builder/table/TableUnique.js';
+export * from 'typeorm/schema-builder/table/Table.js';
+export * from 'typeorm/schema-builder/options/TableCheckOptions.js';
+export * from 'typeorm/schema-builder/options/TableColumnOptions.js';
+export * from 'typeorm/schema-builder/options/TableExclusionOptions.js';
+export * from 'typeorm/schema-builder/options/TableForeignKeyOptions.js';
+export * from 'typeorm/schema-builder/options/TableIndexOptions.js';
+export * from 'typeorm/schema-builder/options/TableOptions.js';
+export * from 'typeorm/schema-builder/options/TableUniqueOptions.js';
+export * from 'typeorm/schema-builder/options/ViewOptions.js';
+export * from 'typeorm/driver/mongodb/typings.js';
+export * from 'typeorm/driver/types/DatabaseType.js';
+export * from 'typeorm/driver/types/GeoJsonTypes.js';
+export * from 'typeorm/driver/types/ReplicationMode.js';
+export * from 'typeorm/driver/sqlserver/MssqlParameter.js';
+export { ConnectionOptionsReader } from 'typeorm/connection/ConnectionOptionsReader.js';
+export { type DataSourceOptions } from 'typeorm/data-source/DataSourceOptions.js';
+export { type MysqlConnectionOptions } from 'typeorm/driver/mysql/MysqlConnectionOptions.js';
+export { type MysqlConnectionCredentialsOptions } from 'typeorm/driver/mysql/MysqlConnectionCredentialsOptions.js';
+export { type PostgresConnectionOptions } from 'typeorm/driver/postgres/PostgresConnectionOptions.js';
+export { type PostgresConnectionCredentialsOptions } from 'typeorm/driver/postgres/PostgresConnectionCredentialsOptions.js';
+export { type CockroachConnectionOptions } from 'typeorm/driver/cockroachdb/CockroachConnectionOptions.js';
+export { type CockroachConnectionCredentialsOptions } from 'typeorm/driver/cockroachdb/CockroachConnectionCredentialsOptions.js';
+export { type SqliteConnectionOptions } from 'typeorm/driver/sqlite/SqliteConnectionOptions.js';
+export { type SqlServerConnectionOptions } from 'typeorm/driver/sqlserver/SqlServerConnectionOptions.js';
+export { type SqlServerConnectionCredentialsOptions } from 'typeorm/driver/sqlserver/SqlServerConnectionCredentialsOptions.js';
+export { type SapConnectionOptions } from 'typeorm/driver/sap/SapConnectionOptions.js';
+export { type SapConnectionCredentialsOptions } from 'typeorm/driver/sap/SapConnectionCredentialsOptions.js';
+export { type OracleConnectionOptions } from 'typeorm/driver/oracle/OracleConnectionOptions.js';
+export { type OracleConnectionCredentialsOptions } from 'typeorm/driver/oracle/OracleConnectionCredentialsOptions.js';
+export { type CordovaConnectionOptions } from 'typeorm/driver/cordova/CordovaConnectionOptions.js';
+export { type NativescriptConnectionOptions } from 'typeorm/driver/nativescript/NativescriptConnectionOptions.js';
+export { type ReactNativeConnectionOptions } from 'typeorm/driver/react-native/ReactNativeConnectionOptions.js';
+export { type SqljsConnectionOptions } from 'typeorm/driver/sqljs/SqljsConnectionOptions.js';
+export { type MongoConnectionOptions } from 'typeorm/driver/mongodb/MongoConnectionOptions.js';
+export { type AuroraMysqlConnectionOptions } from 'typeorm/driver/aurora-mysql/AuroraMysqlConnectionOptions.js';
+export { type AuroraMysqlConnectionCredentialsOptions } from 'typeorm/driver/aurora-mysql/AuroraMysqlConnectionCredentialsOptions.js';
+export { type AuroraPostgresConnectionOptions } from 'typeorm/driver/aurora-postgres/AuroraPostgresConnectionOptions.js';
+export { type ExpoConnectionOptions } from 'typeorm/driver/expo/ExpoConnectionOptions.js';
+export { type BetterSqlite3ConnectionOptions } from 'typeorm/driver/better-sqlite3/BetterSqlite3ConnectionOptions.js';
+export { type CapacitorConnectionOptions } from 'typeorm/driver/capacitor/CapacitorConnectionOptions.js';
+export { type SpannerConnectionOptions } from 'typeorm/driver/spanner/SpannerConnectionOptions.js';
+export { type SpannerConnectionCredentialsOptions } from 'typeorm/driver/spanner/SpannerConnectionCredentialsOptions.js';
+export { DataSource } from 'typeorm/data-source/DataSource.js';
+export { type QueryRunner } from 'typeorm/query-runner/QueryRunner.js';
+export { type Driver } from 'typeorm/driver/Driver.js';
+export { type NamingStrategyInterface } from 'typeorm/naming-strategy/NamingStrategyInterface.js';
+export { type EntitySubscriberInterface } from 'typeorm/subscriber/EntitySubscriberInterface.js';
+export { QueryBuilder } from 'typeorm/query-builder/QueryBuilder.js';
+export { SelectQueryBuilder } from 'typeorm/query-builder/SelectQueryBuilder.js';
+export { DeleteQueryBuilder } from 'typeorm/query-builder/DeleteQueryBuilder.js';
+export { InsertQueryBuilder } from 'typeorm/query-builder/InsertQueryBuilder.js';
+export { UpdateQueryBuilder } from 'typeorm/query-builder/UpdateQueryBuilder.js';
+export { RelationQueryBuilder } from 'typeorm/query-builder/RelationQueryBuilder.js';
+export { Brackets } from 'typeorm/query-builder/Brackets.js';
+export { NotBrackets } from 'typeorm/query-builder/NotBrackets.js';
+export { InsertResult } from 'typeorm/query-builder/result/InsertResult.js';
+export { UpdateResult } from 'typeorm/query-builder/result/UpdateResult.js';
+export { DeleteResult } from 'typeorm/query-builder/result/DeleteResult.js';
+export { QueryResult } from 'typeorm/query-runner/QueryResult.js';
+export { MongoEntityManager } from 'typeorm/entity-manager/MongoEntityManager.js';
+export { Migration } from 'typeorm/migration/Migration.js';
+export { MigrationExecutor } from 'typeorm/migration/MigrationExecutor.js';
+export { DefaultNamingStrategy } from 'typeorm/naming-strategy/DefaultNamingStrategy.js';
+export { LegacyOracleNamingStrategy } from 'typeorm/naming-strategy/LegacyOracleNamingStrategy.js';
+export { EntitySchema } from 'typeorm/entity-schema/EntitySchema.js';
+export { EntitySchemaEmbeddedColumnOptions } from 'typeorm/entity-schema/EntitySchemaEmbeddedColumnOptions.js';
+export { EntitySchemaOptions } from 'typeorm/entity-schema/EntitySchemaOptions.js';
+export { InstanceChecker } from 'typeorm/util/InstanceChecker.js';
+export { TreeRepositoryUtils } from 'typeorm/util/TreeRepositoryUtils.js';
+export { type WhereExpressionBuilder } from 'typeorm/query-builder/WhereExpressionBuilder.js';
+export { type MigrationInterface } from 'typeorm/migration/MigrationInterface.js';
+export { type InsertEvent } from 'typeorm/subscriber/event/InsertEvent.js';
+export { type LoadEvent } from 'typeorm/subscriber/event/LoadEvent.js';
+export { type UpdateEvent } from 'typeorm/subscriber/event/UpdateEvent.js';
+export { type RemoveEvent } from 'typeorm/subscriber/event/RemoveEvent.js';
+export { type SoftRemoveEvent } from 'typeorm/subscriber/event/SoftRemoveEvent.js';
+export { type RecoverEvent } from 'typeorm/subscriber/event/RecoverEvent.js';
+export { type TransactionCommitEvent } from 'typeorm/subscriber/event/TransactionCommitEvent.js';
+export { type TransactionRollbackEvent } from 'typeorm/subscriber/event/TransactionRollbackEvent.js';
+export { type TransactionStartEvent } from 'typeorm/subscriber/event/TransactionStartEvent.js';
+export { type EntitySchemaColumnOptions } from 'typeorm/entity-schema/EntitySchemaColumnOptions.js';
+export { type EntitySchemaIndexOptions } from 'typeorm/entity-schema/EntitySchemaIndexOptions.js';
+export { type EntitySchemaRelationOptions } from 'typeorm/entity-schema/EntitySchemaRelationOptions.js';
+export { type ColumnType } from 'typeorm/driver/types/ColumnTypes.js';
+export { getMetadataArgsStorage } from 'typeorm/globals.js';
+export { MetadataArgsStorage } from 'typeorm/metadata-args/MetadataArgsStorage.js';
+export { type CheckMetadataArgs } from 'typeorm/metadata-args/CheckMetadataArgs.js';
+export { type ColumnMetadataArgs } from 'typeorm/metadata-args/ColumnMetadataArgs.js';
+export { type DiscriminatorValueMetadataArgs } from 'typeorm/metadata-args/DiscriminatorValueMetadataArgs.js';
+export { type EmbeddedMetadataArgs } from 'typeorm/metadata-args/EmbeddedMetadataArgs.js';
+export { type EntityListenerMetadataArgs } from 'typeorm/metadata-args/EntityListenerMetadataArgs.js';
+export { type EntityRepositoryMetadataArgs } from 'typeorm/metadata-args/EntityRepositoryMetadataArgs.js';
+export { type EntitySubscriberMetadataArgs } from 'typeorm/metadata-args/EntitySubscriberMetadataArgs.js';
+export { type ExclusionMetadataArgs } from 'typeorm/metadata-args/ExclusionMetadataArgs.js';
+export { type ForeignKeyMetadataArgs } from 'typeorm/metadata-args/ForeignKeyMetadataArgs.js';
+export { type GeneratedMetadataArgs } from 'typeorm/metadata-args/GeneratedMetadataArgs.js';
+export { type IndexMetadataArgs } from 'typeorm/metadata-args/IndexMetadataArgs.js';
+export { type InheritanceMetadataArgs } from 'typeorm/metadata-args/InheritanceMetadataArgs.js';
+export { type JoinColumnMetadataArgs } from 'typeorm/metadata-args/JoinColumnMetadataArgs.js';
+export { type JoinTableMetadataArgs } from 'typeorm/metadata-args/JoinTableMetadataArgs.js';
+export { type NamingStrategyMetadataArgs } from 'typeorm/metadata-args/NamingStrategyMetadataArgs.js';
+export { type RelationCountMetadataArgs } from 'typeorm/metadata-args/RelationCountMetadataArgs.js';
+export { type RelationIdMetadataArgs } from 'typeorm/metadata-args/RelationIdMetadataArgs.js';
+export { type RelationMetadataArgs } from 'typeorm/metadata-args/RelationMetadataArgs.js';
+export { type TableMetadataArgs } from 'typeorm/metadata-args/TableMetadataArgs.js';
+export { type TransactionEntityMetadataArgs } from 'typeorm/metadata-args/TransactionEntityMetadataArgs.js';
+export { type TransactionRepositoryMetadataArgs } from 'typeorm/metadata-args/TransactionRepositoryMetadataArgs.js';
+export { type TreeMetadataArgs } from 'typeorm/metadata-args/TreeMetadataArgs.js';
+export { type UniqueMetadataArgs } from 'typeorm/metadata-args/UniqueMetadataArgs.js';
+export { type ColumnMode } from 'typeorm/metadata-args/types/ColumnMode.js';

package/dist/types/exports/ORMDecorators.d.ts

@@ -0,0 +1,43 @@
+import 'reflect-metadata';
+export { AfterRecover } from '../decorators/orm/AfterRecover.js';
+export { AfterRemove } from '../decorators/orm/AfterRemove.js';
+export { AfterInsert } from '../decorators/orm/AfterInsert.js';
+export { AfterLoad } from '../decorators/orm/AfterLoad.js';
+export { AfterSoftRemove } from '../decorators/orm/AfterSoftRemove.js';
+export { AfterUpdate } from '../decorators/orm/AfterUpdate.js';
+export { BeforeInsert } from '../decorators/orm/BeforeInsert.js';
+export { BeforeRecover } from '../decorators/orm/BeforeRecover.js';
+export { BeforeRemove } from '../decorators/orm/BeforeRemove.js';
+export { BeforeSoftRemove } from '../decorators/orm/BeforeSoftRemove.js';
+export { BeforeUpdate } from '../decorators/orm/BeforeUpdate.js';
+export { Check } from '../decorators/orm/Check.js';
+export { ChildEntity } from '../decorators/orm/ChildEntity.js';
+export { Column } from '../decorators/orm/Column.js';
+export { CreateDateColumn } from '../decorators/orm/CreateDateColumn.js';
+export { DeleteDateColumn } from '../decorators/orm/DeleteDateColumn.js';
+export { Entity } from '../decorators/orm/Entity.js';
+export { EventSubscriber } from '../decorators/orm/EventSubscriber.js';
+export { Exclusion } from '../decorators/orm/Exclusion.js';
+export { Generated } from '../decorators/orm/Generated.js';
+export { Index } from '../decorators/orm/Index.js';
+export { JoinColumn } from '../decorators/orm/JoinColumn.js';
+export { JoinTable } from '../decorators/orm/JoinTable.js';
+export { ManyToMany } from '../decorators/orm/ManyToMany.js';
+export { ManyToOne } from '../decorators/orm/ManyToOne.js';
+export { ObjectIdColumn } from '../decorators/orm/ObjectIdColumn.js';
+export { OneToMany } from '../decorators/orm/OneToMany.js';
+export { OneToOne } from '../decorators/orm/OneToOne.js';
+export { PrimaryColumn } from '../decorators/orm/PrimaryColumn.js';
+export { PrimaryGeneratedColumn } from '../decorators/orm/PrimaryGeneratedColumn.js';
+export { RelationId } from '../decorators/orm/RelationId.js';
+export { TableInheritance } from '../decorators/orm/TableInheritance.js';
+export { Tree } from '../decorators/orm/Tree.js';
+export { TreeChildren } from '../decorators/orm/TreeChildren.js';
+export { TreeLevelColumn } from '../decorators/orm/TreeLevelColumn.js';
+export { TreeParent } from '../decorators/orm/TreeParent.js';
+export { Unique } from '../decorators/orm/Unique.js';
+export { UpdateDateColumn } from '../decorators/orm/UpdateDateColumn.js';
+export { VersionColumn } from '../decorators/orm/VersionColumn.js';
+export { ViewColumn } from '../decorators/orm/ViewColumn.js';
+export { ViewEntity } from '../decorators/orm/ViewEntity.js';
+export { VirtualColumn } from '../decorators/orm/VirtualColumn.js';

package/dist/types/providers/Database.d.ts

@@ -0,0 +1,326 @@
+import { type DataSourceOptions } from 'typeorm/data-source/DataSourceOptions.js';
+import { DataSource } from 'typeorm/data-source/DataSource.js';
+import { Driver } from 'typeorm/driver/Driver.js';
+import { EntityManager } from 'typeorm/entity-manager/EntityManager.js';
+import { NamingStrategyInterface } from 'typeorm/naming-strategy/NamingStrategyInterface.js';
+import { EntitySubscriberInterface } from 'typeorm/subscriber/EntitySubscriberInterface.js';
+import { EntityMetadata } from 'typeorm/metadata/EntityMetadata.js';
+import { EntityTarget } from 'typeorm/common/EntityTarget.js';
+import { Migration } from 'typeorm/migration/Migration.js';
+import { ObjectLiteral } from 'typeorm/common/ObjectLiteral.js';
+import { TreeRepository } from 'typeorm/repository/TreeRepository.js';
+import { Repository } from 'typeorm/repository/Repository.js';
+import { MongoRepository } from 'typeorm/repository/MongoRepository.js';
+import { QueryRunner } from 'typeorm/query-runner/QueryRunner.js';
+import { SelectQueryBuilder } from 'typeorm/query-builder/SelectQueryBuilder.js';
+import { ReplicationMode } from 'typeorm/driver/types/ReplicationMode.js';
+import { QueryResultCache } from 'typeorm/cache/QueryResultCache.js';
+import { IsolationLevel } from 'typeorm/driver/types/IsolationLevel.js';
+import { Provider } from '@lakutata/core';
+import { EntitySchema, type MixedList } from 'typeorm';
+import { type MigrationRunOptions } from '../types/MigrationRunOptions.js';
+/**
+ * Build the registration of a {@link Database} provider, for the `providers` of the application options: the provider
+ * class with its TypeORM connection options. Its `entities` option, added to the entities of the connection options,
+ * is set by spreading the registration: `{...buildDatabaseOptions(options), entities: [User]}`.
+ * @param options The TypeORM connection options (`DataSourceOptions`): the driver `type`, the connection settings, the
+ * `entities`, the `migrations`, `synchronize`, `migrationsRun`, `logging`… Passed to TypeORM as they are.
+ * @returns The registration `{class: Database, options}`.
+ * @example
+ * ```typescript
+ * import {Application} from 'lakutata'
+ * import {buildDatabaseOptions} from 'lakutata/provider/database'
+ * import {Column, Entity, PrimaryGeneratedColumn} from 'lakutata/decorator/orm'
+ *
+ * @Entity()
+ * class Report {
+ *     @PrimaryGeneratedColumn()
+ *     public id: number
+ *
+ *     @Column('text')
+ *     public content: string
+ * }
+ *
+ * Application.run(() => ({
+ *     id: 'com.example.reports',
+ *     name: 'Reports',
+ *     providers: {
+ *         //A new PostgreSQL connection each time reports is resolved, closed with its owner
+ *         reports: {
+ *             ...buildDatabaseOptions({type: 'postgres', url: 'postgres://postgres:secret@localhost:5432/reports'}),
+ *             entities: [Report]
+ *         }
+ *     }
+ * }))
+ * ```
+ */
+export declare const buildDatabaseOptions: (options: DataSourceOptions) => {
+    class: typeof Database;
+    options: DataSourceOptions;
+};
+/**
+ * A database connection of its own: a transient provider wrapping a TypeORM `DataSource`, with the API of the
+ * `Database` component of `lakutata/com/database`.
+ *
+ * Register it in the `providers` of the application options with {@link buildDatabaseOptions}. Each resolution
+ * (`@Inject('reports')`, `getObject('reports')`) creates a new instance, even within one scope: it opens its own
+ * connection (its own pool) while it is created, and closes it when it is destroyed with the object or the container
+ * which created it. It suits a short use (a job, a script, a tenant database); the requests of a busy application
+ * share the `Database` component instead. A connection failure rejects its creation with the driver error.
+ *
+ * The entities of its `entities` option are added to the entities of its connection options.
+ * @example
+ * ```typescript
+ * import {Application} from 'lakutata'
+ * import {buildDatabaseOptions, Database} from 'lakutata/provider/database'
+ * import {Column, Entity, PrimaryGeneratedColumn} from 'lakutata/decorator/orm'
+ *
+ * @Entity()
+ * class Report {
+ *     @PrimaryGeneratedColumn()
+ *     public id: number
+ *
+ *     @Column('text')
+ *     public content: string
+ * }
+ *
+ * Application
+ *     .run(() => ({
+ *         id: 'com.example.reports',
+ *         name: 'Reports',
+ *         providers: {
+ *             reports: {
+ *                 ...buildDatabaseOptions({type: 'postgres', url: 'postgres://postgres:secret@localhost:5432/reports', synchronize: true}),
+ *                 entities: [Report]
+ *             }
+ *         }
+ *     }))
+ *     .onLaunched(async (app: Application): Promise<void> => {
+ *         //A connection opened for this use, closed with the application
+ *         const database: Database = await app.getObject('reports')
+ *         await database.transaction(async (manager): Promise<void> => {
+ *             await manager.save(Report, {content: 'Daily report'})
+ *         })
+ *         console.log(await database.getRepository(Report).count())
+ *     })
+ * ```
+ */
+export declare class Database extends Provider {
+    #private;
+    /**
+     * Load the provider generating the migrations of the database. The application calls it when it is started with
+     * `MIGRATION_GENERATE`: the applications do not call it.
+     * @returns The migration generator provider class.
+     */
+    static migrationGenerator: () => Promise<typeof Provider>;
+    /**
+     * Load the provider running, reverting or showing the migrations of the database. The application calls it when it
+     * is started with `MIGRATION_RUN`, `MIGRATION_REVERT` or `MIGRATION_SHOW`: the applications do not call it.
+     * @returns The migration executor provider class.
+     */
+    static migrationExecutor: () => Promise<typeof Provider>;
+    /**
+     * The TypeORM connection options, given by the registration (see {@link buildDatabaseOptions}). Not validated by
+     * lakutata: TypeORM checks them while connecting.
+     */
+    protected readonly options: DataSourceOptions;
+    /**
+     * The entities added to the `entities` of the connection options: classes, `EntitySchema`s or glob paths of their
+     * files. The migration commands of the application (`MIGRATION_GENERATE`…) read the connection options only, not
+     * this option.
+     * @default []
+     */
+    protected readonly entities: MixedList<Function | string | EntitySchema>;
+    /**
+     * The TypeORM `DataSource` of the connection, for the subclasses needing what this class does not expose.
+     */
+    protected get datasource(): DataSource;
+    /**
+     * The TypeORM driver of the connection (PostgreSQL, MySQL, SQLite…).
+     */
+    get driver(): Driver;
+    /**
+     * The entity manager of the connection: the TypeORM operations on any entity (`find`, `save`, `delete`…) outside a
+     * transaction.
+     */
+    get manager(): EntityManager;
+    /**
+     * Replace the naming strategy of the connection, which names the tables, the columns and the constraints of the
+     * entities. Set it before the metadata is used: the names already built are not renamed.
+     * @param instance The naming strategy.
+     */
+    set namingStrategy(instance: NamingStrategyInterface);
+    /**
+     * The naming strategy of the connection, which names the tables, the columns and the constraints of the entities.
+     * @default TypeORM's `DefaultNamingStrategy`, unless the options set `namingStrategy`
+     */
+    get namingStrategy(): NamingStrategyInterface;
+    /**
+     * The entity subscribers registered on the connection (the `subscribers` of the options).
+     */
+    get subscribers(): EntitySubscriberInterface<any>[];
+    /**
+     * The metadata of every entity registered on the connection.
+     */
+    get entityMetadatas(): EntityMetadata[];
+    /**
+     * The metadata of every entity registered on the connection, by entity target (class, name or schema): the same as
+     * {@link Database.entityMetadatas}, for fast lookups.
+     */
+    get entityMetadatasMap(): Map<EntityTarget<any>, EntityMetadata>;
+    /**
+     * The query result cache of the connection, `undefined` unless the options enable `cache`.
+     */
+    get queryResultCache(): QueryResultCache | undefined;
+    /**
+     * Connect to the database with the options, their entities and the ones of the `entities` option.
+     * @protected
+     */
+    protected init(): Promise<void>;
+    /**
+     * Disconnect from the database.
+     * @protected
+     */
+    protected destroy(): Promise<void>;
+    /**
+     * Create or update the database schema from the registered entities (the tables, columns, indices and foreign
+     * keys). Meant for development: the migrations change the schema of a production database.
+     * @param dropBeforeSync Drop every table of the database schema, with its data (also the tables of no entity),
+     * before creating the schema. Defaults to `false`.
+     * @returns Resolves once the schema is built.
+     * @throws {CannotExecuteNotConnectedError} When the connection is closed.
+     */
+    synchronize(dropBeforeSync?: boolean): Promise<void>;
+    /**
+     * Run the pending migrations (the `migrations` of the options not yet recorded in the migrations table), in their
+     * timestamp order.
+     * @param options The transactions of the migrations, and whether they are only recorded (`fake`).
+     * @returns The migrations run, an empty array when none is pending.
+     * @throws {CannotExecuteNotConnectedError} When the connection is closed.
+     * @throws {Error} The error of a failed migration, once its transaction (`'all'` or `'each'`) is rolled back.
+     */
+    runMigrations(options?: MigrationRunOptions): Promise<Migration[]>;
+    /**
+     * Revert the last migration run (its `down()`), and remove it from the migrations table. Does nothing when no
+     * migration was run.
+     * @param options The transaction of the migration (`'all'` by default, `migrationsTransactionMode` not applying),
+     * and whether it is only removed from the migrations table (`fake`).
+     * @returns Resolves once the migration is reverted.
+     * @throws {CannotExecuteNotConnectedError} When the connection is closed.
+     */
+    undoLastMigration(options?: MigrationRunOptions): Promise<void>;
+    /**
+     * Log each migration of the options with whether it was run (`[X]`) or not (`[ ]`), through the logger of the
+     * connection (shown when its `logging` includes `schema`).
+     * @returns Whether a migration is pending.
+     */
+    showMigrations(): Promise<boolean>;
+    /**
+     * Whether an entity is registered on the connection.
+     * @param target The entity class, its name, or its table name.
+     * @returns `true` when the connection has its metadata.
+     */
+    hasMetadata(target: EntityTarget<any>): boolean;
+    /**
+     * The metadata of a registered entity: its table, columns, relations…
+     * @param target The entity class, its name, or its table name.
+     * @returns The metadata of the entity.
+     * @throws {EntityMetadataNotFoundError} When the entity is not registered on the connection.
+     */
+    getMetadata(target: EntityTarget<any>): EntityMetadata;
+    /**
+     * The repository of an entity, created once per entity: its `find`, `save`, `delete`… operations outside a
+     * transaction (in a transaction, use the entity manager given to the callback).
+     * @param target The entity class, its name, or its `EntitySchema`.
+     * @returns The repository of the entity (a `MongoRepository` on a MongoDB connection).
+     * @throws {EntityMetadataNotFoundError} From the repository operations, when the entity is not registered.
+     */
+    getRepository<Entity extends ObjectLiteral>(target: EntityTarget<Entity>): Repository<Entity>;
+    /**
+     * The tree repository of an entity decorated with `@Tree()`: the operations on its ancestors and descendants
+     * (`findTrees`, `findDescendants`…).
+     * @param target The tree entity class, or its name.
+     * @returns The tree repository of the entity.
+     * @throws {TreeRepositoryNotSupportedError} On a driver without tree support (MongoDB).
+     */
+    getTreeRepository<Entity extends ObjectLiteral>(target: EntityTarget<Entity>): TreeRepository<Entity>;
+    /**
+     * The MongoDB repository of an entity: the repository operations plus the MongoDB ones (`aggregate`, `bulkWrite`…).
+     * @param target The entity class, or its name.
+     * @returns The MongoDB repository of the entity.
+     * @throws {TypeORMError} When the connection is not a MongoDB one.
+     */
+    getMongoRepository<Entity extends ObjectLiteral>(target: EntityTarget<Entity>): MongoRepository<Entity>;
+    /**
+     * Run a function in a transaction, on one connection of the pool: committed when the function resolves, rolled
+     * back when it rejects (its error rethrown). Every operation of the transaction goes through the entity manager given
+     * to the function: the ones made through {@link Database.manager} or the repositories of this object run outside of
+     * it.
+     * @param runInTransaction The function, given the entity manager of the transaction.
+     * @returns What the function resolves.
+     * @throws {Error} The error of the function, or of the database, after the rollback.
+     */
+    transaction<T>(runInTransaction: (entityManager: EntityManager) => Promise<T>): Promise<T>;
+    /**
+     * Run a function in a transaction with an isolation level, on one connection of the pool: committed when the
+     * function resolves, rolled back when it rejects (its error rethrown). Every operation of the transaction goes
+     * through the entity manager given to the function.
+     * @param isolationLevel The isolation level: `'READ UNCOMMITTED'`, `'READ COMMITTED'`, `'REPEATABLE READ'` or
+     * `'SERIALIZABLE'` (the levels the driver supports).
+     * @param runInTransaction The function, given the entity manager of the transaction.
+     * @returns What the function resolves.
+     * @throws {Error} The error of the function, or of the database, after the rollback.
+     */
+    transaction<T>(isolationLevel: IsolationLevel, runInTransaction: (entityManager: EntityManager) => Promise<T>): Promise<T>;
+    /**
+     * Run a raw SQL query.
+     * @param query The SQL, its parameters as placeholders: `$1`, `$2`… for PostgreSQL, `?` for MySQL and SQLite.
+     * @param parameters The values of the placeholders, escaped by the driver.
+     * @param queryRunner The query runner to run it on (a transaction of {@link Database.createQueryRunner}), a
+     * connection of the pool otherwise.
+     * @returns The raw result of the driver: the rows of a `SELECT` (an array of objects).
+     * @throws {QueryFailedError} When the database rejects the query.
+     */
+    query<T = any>(query: string, parameters?: any[], queryRunner?: QueryRunner): Promise<T>;
+    /**
+     * Create a query builder selecting an entity.
+     * @param entityClass The entity class, its name, or its `EntitySchema`.
+     * @param alias The alias of the entity in the query (`'user'` in `user.name`).
+     * @param queryRunner The query runner to run the query on, a connection of the pool otherwise.
+     * @returns The query builder, selecting the entity from its table.
+     * @throws {EntityMetadataNotFoundError} When the entity is not registered.
+     * @throws {TypeORMError} On a MongoDB connection, which has no query builder.
+     */
+    createQueryBuilder<Entity extends ObjectLiteral>(entityClass: EntityTarget<Entity>, alias: string, queryRunner?: QueryRunner): SelectQueryBuilder<Entity>;
+    /**
+     * Create an empty query builder, its selection and source set by its `select()` and `from()`.
+     * @param queryRunner The query runner to run the query on, a connection of the pool otherwise.
+     * @returns The query builder.
+     * @throws {TypeORMError} On a MongoDB connection, which has no query builder.
+     */
+    createQueryBuilder(queryRunner?: QueryRunner): SelectQueryBuilder<any>;
+    /**
+     * Create a query runner: one connection taken from the pool, to run several queries on the same connection and
+     * control its transaction by hand (`connect()`, `startTransaction()`, `commitTransaction()`,
+     * `rollbackTransaction()`). The caller must `release()` it, or the connection stays taken.
+     * @param mode With replication, `'master'` (the default) for the writes, `'slave'` for the reads on a replica.
+     * @returns The query runner, not connected until its first query or `connect()`.
+     */
+    createQueryRunner(mode?: ReplicationMode): QueryRunner;
+    /**
+     * The metadata of the junction table of a many-to-many relation.
+     * @param entityTarget The entity owning the relation.
+     * @param relationPropertyPath The property of the relation (`'tags'`, or a path such as `'profile.tags'`).
+     * @returns The metadata of the junction table.
+     * @throws {EntityMetadataNotFoundError} When the entity is not registered.
+     * @throws {TypeORMError} When the entity has no such relation, or the relation is not a many-to-many one.
+     */
+    getManyToManyMetadata(entityTarget: EntityTarget<any>, relationPropertyPath: string): EntityMetadata | undefined;
+    /**
+     * Create an entity manager on the connection, bound to a query runner when given (its operations then run on the
+     * runner's connection and transaction).
+     * @param queryRunner The query runner the manager uses, a connection of the pool per operation otherwise.
+     * @returns The entity manager.
+     */
+    createEntityManager(queryRunner?: QueryRunner): EntityManager;
+}

package/dist/types/providers/migration/ExecuteMigration.d.ts

@@ -0,0 +1,40 @@
+import { Provider } from '@lakutata/core';
+import { type DataSourceOptions } from 'typeorm/data-source/DataSourceOptions.js';
+import { DataSource } from 'typeorm/data-source/DataSource.js';
+/**
+ * The actions on the migrations of a database
+ */
+export type MigrationAction = 'run' | 'revert' | 'show';
+/**
+ * Run, revert or show the migrations of a database of the application, with its options (MIGRATION_RUN, MIGRATION_REVERT,
+ * MIGRATION_SHOW): the database is connected without synchronizing its schema nor running its migrations, the action
+ * done, then the application exits (with the code 1 when the action fails)
+ */
+export declare class ExecuteMigration extends Provider {
+    protected readonly action: MigrationAction;
+    protected readonly dataSourceName: string;
+    protected readonly dataSource: DataSourceOptions;
+    protected readonly transaction?: 'all' | 'none' | 'each';
+    /**
+     * The transactions of the migrations: MIGRATION_TRANSACTION, else the migrationsTransactionMode of the database, else
+     * one for all
+     */
+    protected get transactionMode(): 'all' | 'none' | 'each';
+    protected readonly fake: boolean;
+    protected readonly exitProcess: boolean;
+    /**
+     * The prefix of the messages: the name of the database
+     */
+    protected get prefix(): string;
+    /**
+     * Initializer
+     * @protected
+     */
+    protected init(): Promise<void>;
+    /**
+     * Do the action on the database
+     * @param dataSource
+     * @protected
+     */
+    protected handle(dataSource: DataSource): Promise<void>;
+}