@punks/backend-entity-manager 0.0.263 → 0.0.265

package/dist/cjs/types/platforms/nest/extensions/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./authentication";
 export * from "./multi-tenancy";
+export * from "./jobs";

package/dist/cjs/types/platforms/nest/extensions/jobs/abstractions/definition.d.ts

@@ -0,0 +1,20 @@
+export declare enum JobConcurrency {
+    Sequential = "sequential",
+    Parallel = "parallel"
+}
+export declare class JobSchedule<TInvocationParams> {
+    uid: string;
+    cron: string;
+    enabled: boolean;
+    invocationOverrides?: TInvocationParams;
+}
+export type JobDefinition<TInfrastructureParams, TInvocationParams> = {
+    id: string;
+    uid: string;
+    name: string;
+    provider: string;
+    infrastructureParams: TInfrastructureParams;
+    invocationParams: TInvocationParams;
+    schedules: JobSchedule<TInvocationParams>[];
+    concurrency: JobConcurrency;
+};

package/dist/cjs/types/platforms/nest/extensions/jobs/abstractions/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./definition";
+export * from "./instance";
+export * from "./provider";
+export * from "./repository";
+export * from "./settings";

package/dist/cjs/types/platforms/nest/extensions/jobs/abstractions/instance.d.ts

@@ -0,0 +1,27 @@
+export declare enum JobStatus {
+    Created = "created",
+    Ready = "ready",
+    Initializing = "initializing",
+    Running = "running",
+    Completed = "completed",
+    Faulted = "faulted",
+    InitializationError = "initializationError"
+}
+export declare enum JobRunType {
+    Scheduled = "scheduled",
+    OnDemand = "onDemand"
+}
+export declare class JobInstance {
+    id: string;
+    scheduleUid: string;
+    jobUid: string;
+    runType: JobRunType;
+    status: JobStatus;
+    insertTime?: Date;
+    startTime?: Date;
+    endTime?: Date;
+    result?: any;
+    error?: any;
+    createdOn?: Date;
+    updatedOn?: Date;
+}

package/dist/cjs/types/platforms/nest/extensions/jobs/abstractions/provider.d.ts

@@ -0,0 +1,6 @@
+export declare enum JobProviderState {
+    Initializing = "initializing",
+    Running = "running",
+    Completed = "completed",
+    CompletedWithErrors = "completedWithErrors"
+}

package/dist/cjs/types/platforms/nest/extensions/jobs/abstractions/repository.d.ts

@@ -0,0 +1,18 @@
+import { JobDefinition } from "./definition";
+import { JobInstance, JobStatus } from "./instance";
+type JobData = Omit<JobDefinition<unknown, unknown>, "id" | "createdOn" | "updatedOn">;
+export interface IJobDefinitionsRepository {
+    all(): Promise<JobDefinition<unknown, unknown>[]>;
+    getByUid(uid: string): Promise<JobDefinition<unknown, unknown> | undefined>;
+    ensure(data: JobData): Promise<JobDefinition<unknown, unknown>>;
+    create(data: JobData): Promise<JobDefinition<unknown, unknown>>;
+    update(uid: string, data: JobData): Promise<JobDefinition<unknown, unknown>>;
+}
+export interface IJobInstancesRepository {
+    get(id: string): Promise<JobInstance>;
+    getByStatus(...status: JobStatus[]): Promise<JobInstance[]>;
+    getLastInstance(jobUid: string, scheduleUid: string): Promise<JobInstance | undefined>;
+    append(job: JobDefinition<unknown, unknown>, data: Pick<JobInstance, "id" | "insertTime" | "scheduleUid" | "runType">): Promise<JobInstance>;
+    update(instanceId: string, data: Pick<JobInstance, "startTime" | "endTime" | "status" | "result" | "error">): Promise<JobInstance>;
+}
+export {};

package/dist/cjs/types/platforms/nest/extensions/jobs/abstractions/runner.d.ts

@@ -0,0 +1,32 @@
+import { JobDefinition, JobSchedule } from "./definition";
+export interface JobDispatchInput {
+    definition: JobDefinition<unknown, unknown>;
+    schedule: JobSchedule<unknown>;
+    instanceId: string;
+}
+export declare enum JobProviderState {
+    Initializing = "initializing",
+    Running = "running",
+    Completed = "completed",
+    CompletedWithErrors = "completedWithErrors"
+}
+export interface GetJobStatusInput {
+    definition: JobDefinition<unknown, unknown>;
+    instanceId: string;
+}
+export interface JobStatusResult {
+    state: JobProviderState;
+    error?: string;
+}
+export interface CancelJobStatusInput {
+    instanceId: string;
+}
+export interface UpsertJobDefinitionInput {
+    definition: JobDefinition<unknown, unknown>;
+}
+export interface JobProviderInstance {
+    dispatch(input: JobDispatchInput): Promise<void>;
+    upsertJobDefinition(input: UpsertJobDefinitionInput): Promise<void>;
+    getJobStatus(input: GetJobStatusInput): Promise<JobStatusResult>;
+    cancelJob(input: CancelJobStatusInput): Promise<void>;
+}

package/dist/cjs/types/platforms/nest/extensions/jobs/abstractions/settings.d.ts

@@ -0,0 +1,10 @@
+export type JobsSettings = {
+    scheduler: {
+        enabled: boolean;
+        intervalSeconds: number;
+    };
+    monitor: {
+        enabled: boolean;
+        intervalSeconds: number;
+    };
+};

package/dist/cjs/types/platforms/nest/extensions/jobs/commands/index.d.ts

@@ -0,0 +1,4 @@
+import { JobDispatchHandler } from "./job-dispatch/handler";
+import { JobStatusMonitorHandler } from "./job-status-monitor/handler";
+import { JobDefinitionUpdateHandler } from "./job-update/handler";
+export declare const JobHandlers: (typeof JobDispatchHandler | typeof JobStatusMonitorHandler | typeof JobDefinitionUpdateHandler)[];

package/dist/cjs/types/platforms/nest/extensions/jobs/commands/job-dispatch/command.d.ts

@@ -0,0 +1,10 @@
+import { JobDefinition, JobRunType, JobSchedule } from "../../abstractions";
+export interface JobDispatchCommandInput {
+    job: JobDefinition<unknown, unknown>;
+    schedule: JobSchedule<unknown>;
+    runType: JobRunType;
+}
+export declare class JobDispatchCommand {
+    readonly input: JobDispatchCommandInput;
+    constructor(input: JobDispatchCommandInput);
+}

package/dist/cjs/types/platforms/nest/extensions/jobs/commands/job-dispatch/handler.d.ts

@@ -0,0 +1,14 @@
+import { ICommandHandler } from "@nestjs/cqrs";
+import { JobDispatchCommand } from "./command";
+import { OperationLockService } from "../../../../services";
+import { IJobInstancesRepository } from "../../abstractions/repository";
+import { JobProviderExecutor } from "../../processors/runner";
+export declare class JobDispatchHandler implements ICommandHandler<JobDispatchCommand> {
+    private readonly lock;
+    private readonly executor;
+    private readonly instances;
+    private readonly logger;
+    constructor(lock: OperationLockService, executor: JobProviderExecutor, instances: IJobInstancesRepository);
+    execute(command: JobDispatchCommand): Promise<void>;
+    private dispatchJob;
+}

package/dist/cjs/types/platforms/nest/extensions/jobs/commands/job-status-monitor/command.d.ts

@@ -0,0 +1,9 @@
+import { JobDefinition } from "../../abstractions";
+export interface JobStatusUpdateMonitorInput {
+    job: JobDefinition<unknown, unknown>;
+    instanceId: string;
+}
+export declare class JobStatusMonitorCommand {
+    readonly input: JobStatusUpdateMonitorInput;
+    constructor(input: JobStatusUpdateMonitorInput);
+}

package/dist/cjs/types/platforms/nest/extensions/jobs/commands/job-status-monitor/handler.d.ts

@@ -0,0 +1,14 @@
+import { ICommandHandler } from "@nestjs/cqrs";
+import { JobStatusMonitorCommand } from "./command";
+import { IJobInstancesRepository } from "../../abstractions";
+import { OperationLockService } from "../../../../services";
+import { JobProviderExecutor } from "../../processors/runner";
+export declare class JobStatusMonitorHandler implements ICommandHandler<JobStatusMonitorCommand> {
+    private readonly lock;
+    private readonly executor;
+    private readonly instances;
+    private readonly logger;
+    constructor(lock: OperationLockService, executor: JobProviderExecutor, instances: IJobInstancesRepository);
+    execute(command: JobStatusMonitorCommand): Promise<void>;
+    private watchJob;
+}

package/dist/cjs/types/platforms/nest/extensions/jobs/commands/job-update/command.d.ts

@@ -0,0 +1,8 @@
+import { JobDefinition } from "../../abstractions";
+export interface JobDefinitionUpdateInput {
+    job: JobDefinition<unknown, unknown>;
+}
+export declare class JobDefinitionUpdateCommand {
+    readonly input: JobDefinitionUpdateInput;
+    constructor(input: JobDefinitionUpdateInput);
+}

package/dist/cjs/types/platforms/nest/extensions/jobs/commands/job-update/handler.d.ts

@@ -0,0 +1,14 @@
+import { ICommandHandler } from "@nestjs/cqrs";
+import { JobDefinitionUpdateCommand } from "./command";
+import { OperationLockService } from "../../../../services";
+import { IJobDefinitionsRepository } from "../../abstractions";
+import { JobProviderExecutor } from "../../processors/runner";
+export declare class JobDefinitionUpdateHandler implements ICommandHandler<JobDefinitionUpdateCommand> {
+    private readonly lock;
+    private readonly definitions;
+    private readonly executor;
+    private readonly logger;
+    constructor(lock: OperationLockService, definitions: IJobDefinitionsRepository, executor: JobProviderExecutor);
+    execute(command: JobDefinitionUpdateCommand): Promise<void>;
+    private updateJob;
+}

package/dist/cjs/types/platforms/nest/extensions/jobs/decorators/constants.d.ts

@@ -0,0 +1 @@
+export declare const JOB_PROVIDER: unique symbol;

package/dist/cjs/types/platforms/nest/extensions/jobs/decorators/decorators.d.ts

@@ -0,0 +1,2 @@
+import { JOB_PROVIDER } from "./constants";
+export declare const JobProvider: (provider: string) => import("@nestjs/common").CustomDecorator<typeof JOB_PROVIDER>;

package/dist/cjs/types/platforms/nest/extensions/jobs/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./abstractions";
+export { JobsModule } from "./module";

package/dist/cjs/types/platforms/nest/extensions/jobs/module.d.ts

@@ -0,0 +1,11 @@
+import { DynamicModule, OnModuleInit } from "@nestjs/common";
+import { JobsSettings } from "./abstractions/settings";
+import { JobsScheduler } from "./providers/scheduler";
+import { JobsProviderFactory } from "./resolvers/factory";
+export declare class JobsModule implements OnModuleInit {
+    private readonly jobsScheduler;
+    private readonly jobsProviderFactory;
+    constructor(jobsScheduler: JobsScheduler, jobsProviderFactory: JobsProviderFactory);
+    onModuleInit(): Promise<void>;
+    static forRoot(input: JobsSettings): DynamicModule;
+}

package/dist/cjs/types/platforms/nest/extensions/jobs/processors/index.d.ts

@@ -0,0 +1,2 @@
+import { RunnableJobsProcessor } from "./runnable-jobs";
+export declare const JobProcessors: (typeof RunnableJobsProcessor)[];

package/dist/cjs/types/platforms/nest/extensions/jobs/processors/runnable-jobs/index.d.ts

@@ -0,0 +1,7 @@
+import { IJobInstancesRepository, JobDefinition, JobSchedule } from "../../abstractions";
+export declare class RunnableJobsProcessor {
+    private readonly jobInstances;
+    private readonly logger;
+    constructor(jobInstances: IJobInstancesRepository);
+    shouldRun(job: JobDefinition<unknown, unknown>, schedule: JobSchedule<unknown>): Promise<boolean>;
+}

package/dist/cjs/types/platforms/nest/extensions/jobs/processors/runner/index.d.ts

@@ -0,0 +1,10 @@
+import { GetJobStatusInput, JobDispatchInput, UpsertJobDefinitionInput } from "../../abstractions/runner";
+import { JobsProviderFactory } from "../../resolvers/factory";
+export declare class JobProviderExecutor {
+    private readonly factory;
+    constructor(factory: JobsProviderFactory);
+    dispatch(input: JobDispatchInput): Promise<void>;
+    upsertJobDefinition(input: UpsertJobDefinitionInput): Promise<void>;
+    getStatus(input: GetJobStatusInput): Promise<import("../../abstractions/runner").JobStatusResult>;
+    private getProvider;
+}

package/dist/cjs/types/platforms/nest/extensions/jobs/providers/index.d.ts

@@ -0,0 +1,2 @@
+import { JobsScheduler } from "./scheduler";
+export declare const JobsProviders: (typeof JobsScheduler)[];

package/dist/cjs/types/platforms/nest/extensions/jobs/providers/scheduler/index.d.ts

@@ -0,0 +1,17 @@
+import { SchedulerRegistry } from "@nestjs/schedule";
+import { JobsSettings } from "../../abstractions/settings";
+import { JobsSchedulerTask } from "../../task/jobs-scheduler";
+import { JobsMonitorTask } from "../../task/jobs-monitor";
+export declare class JobsScheduler {
+    private readonly jobsSettings;
+    private readonly schedulerRegistry;
+    private readonly schedulerTask;
+    private readonly monitorTask;
+    private readonly logger;
+    constructor(jobsSettings: JobsSettings, schedulerRegistry: SchedulerRegistry, schedulerTask: JobsSchedulerTask, monitorTask: JobsMonitorTask);
+    register(): void;
+    private registerJobsScheduler;
+    private registerJobsMonitor;
+    private batchJobsSchedule;
+    private batchJobsMonitor;
+}

package/dist/cjs/types/platforms/nest/extensions/jobs/resolvers/factory/index.d.ts

@@ -0,0 +1,10 @@
+import { JobProviderInstance } from "../../abstractions/runner";
+import { CustomDiscoveryService } from "../../../../ioc";
+export declare class JobsProviderFactory {
+    private readonly discover;
+    private readonly logger;
+    private providers;
+    constructor(discover: CustomDiscoveryService);
+    initialize(): Promise<void>;
+    getProvider(id: string): JobProviderInstance;
+}

package/dist/cjs/types/platforms/nest/extensions/jobs/resolvers/index.d.ts

@@ -0,0 +1,2 @@
+import { JobsProviderFactory } from "./factory";
+export declare const JobResolverProviders: (typeof JobsProviderFactory)[];

package/dist/cjs/types/platforms/nest/extensions/jobs/services/index.d.ts

@@ -0,0 +1 @@
+export declare const JobsServices: never[];

package/dist/cjs/types/platforms/nest/extensions/jobs/task/jobs-monitor/index.d.ts

@@ -0,0 +1,11 @@
+import { CommandBus } from "@nestjs/cqrs";
+import { IJobDefinitionsRepository, IJobInstancesRepository } from "../../abstractions/repository";
+export declare class JobsMonitorTask {
+    private readonly jobInstances;
+    private readonly jobDefinitions;
+    private readonly commandBus;
+    private readonly logger;
+    constructor(jobInstances: IJobInstancesRepository, jobDefinitions: IJobDefinitionsRepository, commandBus: CommandBus);
+    run(): Promise<void>;
+    private monitorInstance;
+}

package/dist/cjs/types/platforms/nest/extensions/jobs/task/jobs-scheduler/index.d.ts

@@ -0,0 +1,13 @@
+import { CommandBus } from "@nestjs/cqrs";
+import { IJobDefinitionsRepository } from "../../abstractions";
+import { RunnableJobsProcessor } from "../../processors/runnable-jobs";
+export declare class JobsSchedulerTask {
+    private readonly jobDefinitions;
+    private readonly evaluator;
+    private readonly commandBus;
+    private readonly logger;
+    constructor(jobDefinitions: IJobDefinitionsRepository, evaluator: RunnableJobsProcessor, commandBus: CommandBus);
+    run(): Promise<void>;
+    private evaluateJob;
+    private evaluateJobSchedule;
+}

package/dist/cjs/types/platforms/nest/extensions/jobs/utils/cron.d.ts

@@ -0,0 +1,2 @@
+export declare const getCronPrevDate: (cron: string) => Date;
+export declare const getCronNextDate: (cron: string) => Date;

package/dist/cjs/types/platforms/nest/extensions/jobs/utils/status.d.ts

@@ -0,0 +1,5 @@
+import { JobStatus } from "../abstractions";
+export declare const isJobPending: (status: JobStatus) => boolean;
+export declare const isJobRunning: (status: JobStatus) => boolean;
+export declare const isJobStarted: (status: JobStatus) => boolean;
+export declare const isJobEnded: (status: JobStatus) => boolean;

package/dist/cjs/types/platforms/nest/ioc/tokens/index.d.ts

@@ -1,2 +1,2 @@
 export { buildProviderToken } from "./builder";
-export { EntityManagerProviderToken } from "./symbols";
+export { getEntityManagerProviderToken } from "./symbols";

package/dist/cjs/types/platforms/nest/ioc/tokens/symbols.d.ts

@@ -1,4 +1,7 @@
 export declare const EntityManagerProviderToken: {
     OperationsLockRepository: {};
+    JobsModuleSettings: {};
+    JobInstancesRepository: {};
+    JobDefinitionsRepository: {};
 };
 export declare const getEntityManagerProviderToken: (name: keyof typeof EntityManagerProviderToken) => string;

package/dist/cjs/types/platforms/nest/plugins/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./buckets";
 export * from "./email";
+export * from "./jobs";
 export * from "./media";
 export * from "./secrets";

package/dist/cjs/types/platforms/nest/plugins/jobs/aws-batch/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./models";
+export * from "./settings";
+export { AwsJobsModule } from "./module";

package/dist/cjs/types/platforms/nest/plugins/jobs/aws-batch/manager/index.d.ts

@@ -0,0 +1,19 @@
+import { BathJobDefinition, GetBatchJobStatusInput, SubmitBatchJobInput } from "./types";
+import { AwsBatchSettings } from "../settings";
+export declare class AwsBatchService {
+    private readonly awsSettings;
+    private readonly logger;
+    constructor(awsSettings: AwsBatchSettings);
+    cancelJobInput(): Promise<void>;
+    getJobInstance(input: GetBatchJobStatusInput): Promise<import("@aws-sdk/client-batch").JobSummary | undefined>;
+    submitJob(input: SubmitBatchJobInput): Promise<void>;
+    ensureJobDefinition(definition: BathJobDefinition): Promise<import("@aws-sdk/client-batch").JobDefinition>;
+    private unregisterJobDefinition;
+    private registerJobDefinition;
+    private getLatestJobDefinition;
+    private getActiveJobDefinitions;
+    private ensureQueue;
+    private createQueue;
+    private getQueue;
+    private client;
+}

package/dist/cjs/types/platforms/nest/plugins/jobs/aws-batch/manager/types.d.ts

@@ -0,0 +1,19 @@
+export type BathJobDefinition = {
+    jobUid: string;
+    image: string;
+    memory: number;
+    vcpu: number;
+    defaultCommand: string[];
+};
+export type BatchJobOverrides = {
+    command?: string[];
+};
+export type SubmitBatchJobInput = {
+    overrides?: BatchJobOverrides;
+    jobUid: string;
+    instanceId: string;
+};
+export type GetBatchJobStatusInput = {
+    jobUid: string;
+    instanceId: string;
+};

package/dist/cjs/types/platforms/nest/plugins/jobs/aws-batch/models/index.d.ts

@@ -0,0 +1,10 @@
+import { JobDefinition } from "../../../../extensions/jobs/abstractions/definition";
+export type AwsBatchInfrastructureParams = {
+    vcpu: number;
+    memory: number;
+    dockerImage: string;
+};
+export type AwsBatchInvocationParams = {
+    startCommand: string[];
+};
+export type AwsJobDefinition = JobDefinition<AwsBatchInfrastructureParams, AwsBatchInvocationParams>;

package/dist/cjs/types/platforms/nest/plugins/jobs/aws-batch/module.d.ts

@@ -0,0 +1,5 @@
+import { DynamicModule } from "@nestjs/common";
+import { AwsBatchSettings } from "./settings";
+export declare class AwsJobsModule {
+    static forRoot(input: AwsBatchSettings): DynamicModule;
+}

package/dist/cjs/types/platforms/nest/plugins/jobs/aws-batch/provider/index.d.ts

@@ -0,0 +1,10 @@
+import { CancelJobStatusInput, GetJobStatusInput, JobDispatchInput, JobProviderInstance, JobStatusResult, UpsertJobDefinitionInput } from "../../../../extensions/jobs/abstractions/runner";
+import { AwsBatchService } from "../manager";
+export declare class AwsJobsProvider implements JobProviderInstance {
+    private readonly awsBatchService;
+    constructor(awsBatchService: AwsBatchService);
+    dispatch(input: JobDispatchInput): Promise<void>;
+    upsertJobDefinition(input: UpsertJobDefinitionInput): Promise<void>;
+    getJobStatus(input: GetJobStatusInput): Promise<JobStatusResult>;
+    cancelJob(input: CancelJobStatusInput): Promise<void>;
+}

package/dist/cjs/types/platforms/nest/plugins/jobs/aws-batch/settings/index.d.ts

@@ -0,0 +1,8 @@
+export type AwsBatchSettings = {
+    accessKeyId?: string;
+    secretAccessKey?: string;
+    region?: string;
+    defaultQueueName: string;
+    batchComputeEnvironment: string;
+    batchExecutionRole: string;
+};

package/dist/cjs/types/platforms/nest/plugins/jobs/index.d.ts

@@ -0,0 +1 @@
+export * from "./aws-batch";