@orion-js/migrations 4.0.0-alpha.2 → 4.0.0-alpha.3

package/dist/index.d.ts

@@ -3,110 +3,11 @@
 import * as MongoDB from 'mongodb';
 import { Db, MongoClient } from 'mongodb';
 
-export interface Options {
-	lockTime?: number;
-	omitJob?: boolean;
-}
-export declare function loadMigrations(migrationServices: any[], options?: Options): MigrationExecutable[];
-export type Blackbox = {
-	[name: string]: any;
-};
-export type LogFunction = (message: string, metadata?: any) => void;
-export interface OrionLogger {
-	debug: LogFunction;
-	info: LogFunction;
-	warn: LogFunction;
-	error: LogFunction;
-	addContext: (module: NodeJS.Module) => OrionLogger;
-	addMetadata: (metadata: any) => OrionLogger;
-}
-export interface JobToRun {
-	jobId: string;
-	executionId: string;
-	name: string;
-	type: "event" | "recurrent";
-	params: Blackbox;
-	tries: number;
-	lockTime: number;
-	priority: number;
-	uniqueIdentifier?: string;
-}
-export interface ExecutionContext {
-	record: JobToRun;
-	definition: JobDefinition;
-	tries: number;
-	logger: OrionLogger;
-	extendLockTime: (extraTime: number) => Promise<void>;
-	clearStaleTimeout: () => void;
-}
-export interface JobRetryResultBase {
-	action: "retry" | "dismiss";
-}
-export type JobRetryResultRunIn = JobRetryResultBase & {
-	runIn: number;
-};
-export type JobRetryResultRunAt = JobRetryResultBase & {
-	runAt: Date;
-};
-export type JobRetryResult = JobRetryResultRunIn | JobRetryResultRunAt | JobRetryResultBase;
-export interface BaseJobDefinition {
-	/**
-	 * The function to execute when the job is executed.
-	 */
-	resolve: (params: Blackbox, context: ExecutionContext) => Promise<Blackbox | void>;
-	/**
-	 * Called if the job fails.
-	 */
-	onError?: (error: Error, params: Blackbox, context: ExecutionContext) => Promise<JobRetryResult>;
-	/**
-	 * Called if the job locktime is expired. The job will be executed again.
-	 */
-	onStale?: (params: Blackbox, context: ExecutionContext) => Promise<void>;
-	/**
-	 * Save the executions of the job time in milliseconds. Default is 1 week. Set to 0 to disable.
-	 */
-	saveExecutionsFor?: number;
-}
-export interface RecurrentJobDefinition extends BaseJobDefinition {
-	/**
-	 * Type of the job.
-	 */
-	type: "recurrent";
-	/**
-	 * A function executed after each execution that returns the date of the next run.
-	 */
-	getNextRun?: () => Date;
-	/**
-	 * Run every x milliseconds. This will be ignored if getNextRun is defined.
-	 */
-	runEvery?: number;
-	/**
-	 * The priority of the job. Higher is more priority. Default is 100.
-	 */
-	priority?: number;
-}
-export interface EventJobDefinition extends BaseJobDefinition {
-	/**
-	 * Type of the job.
-	 */
-	type: "event";
-}
-export type JobDefinition = RecurrentJobDefinition | EventJobDefinition;
-export interface MigrationServiceOptions {
+export type MigrationId = `scnmg-${string}`;
+export declare class MigrationSchema {
+	_id: MigrationId;
 	name: string;
-	useMongoTransactions: false;
-}
-export declare function MigrationService(options: MigrationServiceOptions): ClassDecorator;
-export type MigrationExecutable = {
-	runMigration(context: ExecutionContext): Promise<void>;
-} & MigrationServiceOptions;
-export declare function getMigrationsFromServices(services: any[]): MigrationExecutable[];
-export declare class MigrationsService {
-	private migrationsRepo;
-	getNextMigration(migrationsList: MigrationExecutable[]): Promise<MigrationExecutable>;
-	runMigrations(migrationsList: MigrationExecutable[], context: ExecutionContext): Promise<void>;
-	runMigration(func: (context: ExecutionContext) => Promise<void>, context: ExecutionContext): Promise<void>;
-	runAsTransaction(func: (context: ExecutionContext) => Promise<void>, context: ExecutionContext): Promise<void>;
+	completedAt: Date;
 }
 // Generated by dts-bundle-generator v9.5.1
 // Generated by dts-bundle-generator v9.5.1
@@ -136,7 +37,7 @@ export interface OrionCache {
 	 */
 	invalidate(key: string): Promise<void> | void;
 }
-type Blackbox$1 = {
+export type Blackbox = {
 	[name: string]: any;
 };
 export type ModelResolverResolve = (item: any, params: any, viewer: any, info?: any) => Promise<any>;
@@ -145,7 +46,7 @@ export type ModelCheckPermissions = (parent: any, params: any, viewer: any, info
 export type GlobalGetCacheKey = (params: any, viewer: any, info: any) => Promise<any>;
 export type ModelGetCacheKey = (parent: any, params: any, viewer: any, info: any) => Promise<any>;
 export interface ExecuteOptions {
-	params: Blackbox$1;
+	params: Blackbox;
 	viewer: any;
 	parent?: any;
 	info?: any;
@@ -584,7 +485,7 @@ export type UpdateMany<ModelClass extends ModelClassBase> = (selector: ModelToMo
 export type Upsert<ModelClass extends ModelClassBase> = (selector: ModelToMongoSelector<ModelClass>, modifier: ModelToUpdateFilter<ModelClass>, options?: UpdateOptions) => Promise<MongoDB.UpdateResult>;
 export type EstimatedDocumentCount<ModelClass extends ModelClassBase> = (options?: MongoDB.EstimatedDocumentCountOptions) => Promise<number>;
 export type CountDocuments<ModelClass extends ModelClassBase> = (selector: ModelToMongoSelector<ModelClass>, options?: MongoDB.CountDocumentsOptions) => Promise<number>;
-export interface Collection<ModelClass extends ModelClassBase = ModelClassBase> {
+declare class Collection<ModelClass extends ModelClassBase = ModelClassBase> {
 	name: string;
 	connectionName?: string;
 	schema?: Schema$1;
@@ -632,16 +533,115 @@ export interface Collection<ModelClass extends ModelClassBase = ModelClassBase>
 	createIndexesPromise: Promise<string[]>;
 	connectionPromise: Promise<MongoDB.MongoClient>;
 }
-export type MigrationId = `scnmg-${string}`;
-export declare class MigrationSchema {
-	_id: MigrationId;
-	name: string;
-	completedAt: Date;
-}
 export declare class MigrationsRepo {
 	collection: Collection<MigrationSchema>;
 	getCompletedMigrationNames(): Promise<string[]>;
 	saveCompletedMigration(name: string): Promise<void>;
 }
+export interface Options {
+	lockTime?: number;
+	omitJob?: boolean;
+}
+export declare function loadMigrations(migrationServices: any[], options?: Options): MigrationExecutable[];
+type Blackbox$1 = {
+	[name: string]: any;
+};
+export type LogFunction = (message: string, metadata?: any) => void;
+export interface OrionLogger {
+	debug: LogFunction;
+	info: LogFunction;
+	warn: LogFunction;
+	error: LogFunction;
+	addContext: (module: NodeJS.Module) => OrionLogger;
+	addMetadata: (metadata: any) => OrionLogger;
+}
+export interface JobToRun {
+	jobId: string;
+	executionId: string;
+	name: string;
+	type: "event" | "recurrent";
+	params: Blackbox$1;
+	tries: number;
+	lockTime: number;
+	priority: number;
+	uniqueIdentifier?: string;
+}
+export interface ExecutionContext {
+	record: JobToRun;
+	definition: JobDefinition;
+	tries: number;
+	logger: OrionLogger;
+	extendLockTime: (extraTime: number) => Promise<void>;
+	clearStaleTimeout: () => void;
+}
+export interface JobRetryResultBase {
+	action: "retry" | "dismiss";
+}
+export type JobRetryResultRunIn = JobRetryResultBase & {
+	runIn: number;
+};
+export type JobRetryResultRunAt = JobRetryResultBase & {
+	runAt: Date;
+};
+export type JobRetryResult = JobRetryResultRunIn | JobRetryResultRunAt | JobRetryResultBase;
+export interface BaseJobDefinition {
+	/**
+	 * The function to execute when the job is executed.
+	 */
+	resolve: (params: Blackbox$1, context: ExecutionContext) => Promise<Blackbox$1 | void>;
+	/**
+	 * Called if the job fails.
+	 */
+	onError?: (error: Error, params: Blackbox$1, context: ExecutionContext) => Promise<JobRetryResult>;
+	/**
+	 * Called if the job locktime is expired. The job will be executed again.
+	 */
+	onStale?: (params: Blackbox$1, context: ExecutionContext) => Promise<void>;
+	/**
+	 * Save the executions of the job time in milliseconds. Default is 1 week. Set to 0 to disable.
+	 */
+	saveExecutionsFor?: number;
+}
+export interface RecurrentJobDefinition extends BaseJobDefinition {
+	/**
+	 * Type of the job.
+	 */
+	type: "recurrent";
+	/**
+	 * A function executed after each execution that returns the date of the next run.
+	 */
+	getNextRun?: () => Date;
+	/**
+	 * Run every x milliseconds. This will be ignored if getNextRun is defined.
+	 */
+	runEvery?: number;
+	/**
+	 * The priority of the job. Higher is more priority. Default is 100.
+	 */
+	priority?: number;
+}
+export interface EventJobDefinition extends BaseJobDefinition {
+	/**
+	 * Type of the job.
+	 */
+	type: "event";
+}
+export type JobDefinition = RecurrentJobDefinition | EventJobDefinition;
+export interface MigrationServiceOptions {
+	name: string;
+	useMongoTransactions: false;
+}
+export declare function MigrationService(options: MigrationServiceOptions): ClassDecorator;
+export type MigrationExecutable = {
+	runMigration(context: ExecutionContext): Promise<void>;
+} & MigrationServiceOptions;
+export declare function getMigrationsFromServices(services: any[]): MigrationExecutable[];
+export declare class MigrationsService {
+	private migrationsRepo;
+	getNextMigration(migrationsList: MigrationExecutable[]): Promise<MigrationExecutable>;
+	runMigrations(migrationsList: MigrationExecutable[], context: ExecutionContext): Promise<void>;
+	runMigration(func: (context: ExecutionContext) => Promise<void>, context: ExecutionContext): Promise<void>;
+	runAsTransaction(func: (context: ExecutionContext) => Promise<void>, context: ExecutionContext): Promise<void>;
+}
 
 export {};