@clairejs/server 3.22.8 → 3.22.10

package/README.md

@@ -1,5 +1,14 @@
 ## Change Log
 
+#### 3.22.10
+
+-   fix aws job scheduler name space job removal issue
+
+#### 3.22.9
+
+-   fix typing issue with job handler function
+-   fix providing transaction to job remove function
+
 #### 3.22.8
 
 -   remove log, aws job scheduler issue fixed

package/dist/common/decorator.d.ts

@@ -4,4 +4,4 @@ import { AbstractHttpController } from "../http/controller/AbstractHttpControlle
 export declare const Controller: (config?: {
     mount?: string;
     permissionGroup?: string;
-}) => <T extends AbstractSocketController | AbstractHttpController>(constructor: Constructor<T>) => void;
+}) => <T extends AbstractHttpController | AbstractSocketController>(constructor: Constructor<T>) => void;

package/dist/http/common/HttpResponse.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 export interface CookieOptions {
     maxAge?: number | undefined;
     expires?: Date | undefined;

package/dist/http/repository/DtoRepository.d.ts

@@ -12,20 +12,20 @@ export interface MappingMetadata<R extends Identifiable, K extends AbstractModel
     rootMapping: (ks?: DeepPartial<K>[]) => DeepPartial<R>;
     nestedMapping?: DtoDissolver<R, K>;
 }
-export declare const SingleMap: <R extends Identifiable, K extends AbstractModel>(modelClass: Constructor<K>, forwardOps: (ops?: QueryCondition<R>[] | undefined) => QueryCondition<K>[] | undefined, forwardMapping: (t: DeepPartial<K>) => DeepPartial<K> | undefined, rootMapping: (k?: DeepPartial<K> | undefined) => DeepPartial<R>, nestedMapping?: DtoDissolver<R, K> | undefined) => {
+export declare const SingleMap: <R extends Identifiable, K extends AbstractModel>(modelClass: Constructor<K>, forwardOps: (ops?: QueryCondition<R>[]) => QueryCondition<K>[] | undefined, forwardMapping: (t: DeepPartial<K>) => DeepPartial<K> | undefined, rootMapping: (k?: DeepPartial<K>) => DeepPartial<R>, nestedMapping?: DtoDissolver<R, K>) => {
     multiple: boolean;
     modelClass: Constructor<K>;
-    forwardOps: (ops?: QueryCondition<R>[] | undefined) => QueryCondition<K>[] | undefined;
+    forwardOps: (ops?: QueryCondition<R>[]) => QueryCondition<K>[] | undefined;
     forwardMapping: (t: DeepPartial<K>[]) => DeepPartial<K>[] | undefined;
-    rootMapping: (ks?: DeepPartial<K>[] | undefined) => DeepPartial<R>;
+    rootMapping: (ks?: DeepPartial<K>[]) => DeepPartial<R>;
     nestedMapping: DtoDissolver<R, K> | undefined;
 };
-export declare const MultipleMap: <R extends Identifiable, K extends AbstractModel>(modelClass: Constructor<K>, forwardOps: (ops?: QueryCondition<R>[] | undefined) => QueryCondition<K>[] | undefined, forwardMapping: (t: DeepPartial<K>[]) => DeepPartial<K>[] | undefined, rootMapping: (ks?: DeepPartial<K>[] | undefined) => DeepPartial<R>, nestedMapping?: DtoDissolver<R, K> | undefined) => {
+export declare const MultipleMap: <R extends Identifiable, K extends AbstractModel>(modelClass: Constructor<K>, forwardOps: (ops?: QueryCondition<R>[]) => QueryCondition<K>[] | undefined, forwardMapping: (t: DeepPartial<K>[]) => DeepPartial<K>[] | undefined, rootMapping: (ks?: DeepPartial<K>[]) => DeepPartial<R>, nestedMapping?: DtoDissolver<R, K>) => {
     multiple: boolean;
     modelClass: Constructor<K>;
-    forwardOps: (ops?: QueryCondition<R>[] | undefined) => QueryCondition<K>[] | undefined;
+    forwardOps: (ops?: QueryCondition<R>[]) => QueryCondition<K>[] | undefined;
     forwardMapping: (t: DeepPartial<K>[]) => DeepPartial<K>[] | undefined;
-    rootMapping: (ks?: DeepPartial<K>[] | undefined) => DeepPartial<R>;
+    rootMapping: (ks?: DeepPartial<K>[]) => DeepPartial<R>;
     nestedMapping: DtoDissolver<R, K> | undefined;
 };
 export declare class DtoRepository<T extends Identifiable> extends AbstractRepository<T> implements ICrudRepository<T> {

package/dist/http/repository/ModelRepository.d.ts

@@ -27,7 +27,7 @@ export declare class ModelRepository<T extends AbstractModel> extends AbstractRe
         tx: ITransaction;
         logger?: AbstractLogger;
     }): Promise<UpdateManyResponse<T>>;
-    getMany({ queries, ops, tx, logger, }: {
+    getMany({ queries, ops, tx, logger: _logger, }: {
         queries?: GetManyQueries<T>;
         ops?: QueryCondition<T>[];
         tx?: ITransaction;

package/dist/job/AbstractJobScheduler.d.ts

@@ -1,8 +1,9 @@
 import { AbstractLogger } from "@clairejs/core";
 import { ITransaction, ITransactionFactory } from "@clairejs/orm";
 import { CustomJobInfo, JobInfo, JobInfoMetadata, ScheduledJob } from "./interfaces";
+export type JobHandlerFn = (job: ScheduledJob, tx: ITransaction) => Promise<ScheduledJob | void>;
 interface JobHandlerMetadata extends JobInfoMetadata {
-    handlerFn: (job: ScheduledJob, tx: ITransaction) => Promise<ScheduledJob | undefined>;
+    handlerFn: JobHandlerFn;
 }
 export declare abstract class AbstractJobScheduler {
     protected readonly logger: AbstractLogger;
@@ -31,7 +32,7 @@ export declare abstract class AbstractJobScheduler {
      * Remove the scheduled job and prevent if from running in the future
      * @param id The job id returned from scheduleJobAt function
      */
-    abstract removeJob(id: string): Promise<void>;
+    abstract removeJob(id: string, tx?: ITransaction): Promise<void>;
     /**
      * Execute the scheduled job
      * @param job The schedled job info to execute

package/dist/job/AbstractJobScheduler.js

@@ -35,25 +35,26 @@ export class AbstractJobScheduler {
         //-- run job
         const allJobs = await this.getAvailableJobInfo();
         const jobHandler = allJobs.find((j) => j.jobName === job.jobName);
-        if (!jobHandler) {
-            //-- remove job
-            this.logger.info(`Remove job with id: ${job.id} as handler is not found`);
-            await this.removeJob(job.id);
-            return;
-        }
         const tx = await this.db.createTransaction();
         try {
-            const newJob = await jobHandler.handlerFn({ ...job }, tx);
-            if (job.at) {
-                if (!newJob) {
-                    await this.removeJob(job.id);
-                    this.logger.info(`Remove one-time job ${job.jobName} at timestamp ${job.at}`);
-                }
-                else {
-                    await this.afterJob(newJob, tx);
+            if (!jobHandler) {
+                //-- remove job
+                this.logger.info(`Remove job with id: ${job.id} as handler is not found`);
+                await this.removeJob(job.id, tx);
+            }
+            else {
+                const newJob = await jobHandler.handlerFn({ ...job }, tx);
+                if (job.at) {
+                    if (!newJob) {
+                        await this.removeJob(job.id, tx);
+                        this.logger.info(`Remove one-time job ${job.jobName} at timestamp ${job.at}`);
+                    }
+                    else {
+                        await this.afterJob(newJob, tx);
+                    }
                 }
+                this.logger.debug("Job tx commiting");
             }
-            this.logger.debug("Job tx commiting");
             await tx.commit();
             this.logger.debug("Job tx committed");
         }
@@ -61,6 +62,5 @@ export class AbstractJobScheduler {
             this.logger.error("Error handling job", err);
             await tx.rollback();
         }
-        return;
     }
 }

package/dist/job/AwsJobScheduler.d.ts

@@ -12,10 +12,10 @@ export declare class AwsJobScheduler extends AbstractJobScheduler {
     protected readonly db: AbstractDbAdapter;
     protected readonly uniqueJobIdFactory: () => string;
     protected readonly apiLambdaFunctionArn: string;
+    protected readonly jobNamespace: string;
     protected readonly eventBusName: string;
-    protected readonly jobNamePrefix: string;
     protected readonly eventbridge: aws.EventBridge;
-    constructor(logger: AbstractLogger, db: AbstractDbAdapter, uniqueJobIdFactory: () => string, apiLambdaFunctionArn: string, eventBusName?: string, jobNamePrefix?: string);
+    constructor(logger: AbstractLogger, db: AbstractDbAdapter, uniqueJobIdFactory: () => string, apiLambdaFunctionArn: string, jobNamespace: string, eventBusName?: string);
     handleCron(jobInfo: ScheduledJob): Promise<void>;
     protected afterJob(_job: ScheduledJob, _tx: ITransaction): Promise<void>;
     private generateCronFromTimestamp;

package/dist/job/AwsJobScheduler.js

@@ -21,17 +21,17 @@ let AwsJobScheduler = class AwsJobScheduler extends AbstractJobScheduler {
     db;
     uniqueJobIdFactory;
     apiLambdaFunctionArn;
+    jobNamespace;
     eventBusName;
-    jobNamePrefix;
     eventbridge = new aws.EventBridge();
-    constructor(logger, db, uniqueJobIdFactory, apiLambdaFunctionArn, eventBusName = "default", jobNamePrefix = "claire-aws-job-") {
+    constructor(logger, db, uniqueJobIdFactory, apiLambdaFunctionArn, jobNamespace, eventBusName = "default") {
         super(logger, db);
         this.logger = logger;
         this.db = db;
         this.uniqueJobIdFactory = uniqueJobIdFactory;
         this.apiLambdaFunctionArn = apiLambdaFunctionArn;
+        this.jobNamespace = jobNamespace;
         this.eventBusName = eventBusName;
-        this.jobNamePrefix = jobNamePrefix;
     }
     async handleCron(jobInfo) {
         this.logger.debug(`Handle cron`, jobInfo);
@@ -59,7 +59,7 @@ let AwsJobScheduler = class AwsJobScheduler extends AbstractJobScheduler {
         const allRules = await this.eventbridge
             .listRules({
             EventBusName: this.eventBusName,
-            NamePrefix: this.jobNamePrefix,
+            NamePrefix: this.jobNamespace,
         })
             .promise();
         const allJobs = await Promise.all((allRules.Rules || []).map(async (rule) => {
@@ -83,7 +83,7 @@ let AwsJobScheduler = class AwsJobScheduler extends AbstractJobScheduler {
     async scheduleJob(jobInfo) {
         this.logger.debug("Scheduling job: ", jobInfo);
         if (jobInfo.cron || jobInfo.at) {
-            const jobId = `${this.jobNamePrefix}${this.uniqueJobIdFactory()}`;
+            const jobId = `${this.jobNamespace}${this.uniqueJobIdFactory()}`;
             let cronExpression;
             if (jobInfo.at) {
                 cronExpression = this.generateCronFromTimestamp(jobInfo.at);
@@ -139,8 +139,10 @@ let AwsJobScheduler = class AwsJobScheduler extends AbstractJobScheduler {
         //-- remove job that no more exist
         const nomoreExistJobs = scheduledJobs.filter((job) => !allJobs.find((j) => j.jobName === job.jobName));
         for (const job of nomoreExistJobs) {
-            this.logger.info(`Removing stale job: ${job.jobName} of id: ${job.id}`);
-            await this.removeJob(job.id);
+            if (job.id) {
+                this.logger.info(`Removing stale job: ${job.jobName} of id: ${job.id}`);
+                await this.removeJob(job.id);
+            }
         }
         if (nomoreExistJobs.length) {
             this.logger.info(`Cleaned up: ${nomoreExistJobs.length} stale jobs`);
@@ -184,6 +186,6 @@ let AwsJobScheduler = class AwsJobScheduler extends AbstractJobScheduler {
 AwsJobScheduler = __decorate([
     LogContext(),
     __metadata("design:paramtypes", [AbstractLogger,
-        AbstractDbAdapter, Function, String, Object, Object])
+        AbstractDbAdapter, Function, String, String, Object])
 ], AwsJobScheduler);
 export { AwsJobScheduler };

package/dist/job/LocalJobScheduler.d.ts

@@ -65,6 +65,6 @@ export declare class LocalJobScheduler extends AbstractJobScheduler implements I
     protected isActiveScheduler(): boolean;
     getAllScheduledJobs(): Promise<ScheduledJob[]>;
     syncJobs(): Promise<void>;
-    protected scheduleJob(jobInfo: JobInfo): Promise<string>;
-    removeJob(id: string): Promise<void>;
+    protected scheduleJob(jobInfo: JobInfo, tx?: ITransaction): Promise<string>;
+    removeJob(id: string, tx?: ITransaction): Promise<void>;
 }

package/dist/job/LocalJobScheduler.js

@@ -195,7 +195,7 @@ let LocalJobScheduler = class LocalJobScheduler extends AbstractJobScheduler {
         }
         return;
     }
-    async scheduleJob(jobInfo) {
+    async scheduleJob(jobInfo, tx) {
         if (this.isActive) {
             //-- case each job type
             if (jobInfo.at) {
@@ -205,7 +205,7 @@ let LocalJobScheduler = class LocalJobScheduler extends AbstractJobScheduler {
                         jobName: jobInfo.jobName,
                         params: jobInfo.params,
                         at: jobInfo.at,
-                    }));
+                    }, tx));
                 //-- use the lib
                 const scheduledJob = { ...jobInfo, id };
                 const timeout = setTimeout(() => {
@@ -237,7 +237,7 @@ let LocalJobScheduler = class LocalJobScheduler extends AbstractJobScheduler {
             });
         }
     }
-    async removeJob(id) {
+    async removeJob(id, tx) {
         if (this.isActive) {
             //-- remove from holder
             const job = this.jobHolder[id];
@@ -246,7 +246,7 @@ let LocalJobScheduler = class LocalJobScheduler extends AbstractJobScheduler {
                 this.jobHolder[id] = undefined;
             }
             //-- remove from persistence
-            await this.jobRepo.removeJobById(id);
+            await this.jobRepo.removeJobById(id, tx);
         }
         else {
             //-- get unique message id

package/dist/job/decorators.d.ts

@@ -1,3 +1,6 @@
 import { AbstractJobController } from "./AbstractJobController";
-export declare const CronJob: (jobName: string, cron: string) => <T extends AbstractJobController>(prototype: T, propertyKey: keyof T) => void;
-export declare const CustomJob: (jobName: string) => <T extends AbstractJobController>(prototype: T, propertyKey: keyof T) => void;
+import { JobHandlerFn } from "./AbstractJobScheduler";
+type Descriptor<T> = Omit<TypedPropertyDescriptor<T>, "set">;
+export declare const CronJob: (jobName: string, cron: string) => <T extends AbstractJobController>(prototype: T, propertyKey: keyof T, _descriptor: Descriptor<JobHandlerFn>) => void;
+export declare const CustomJob: (jobName: string) => <T extends AbstractJobController>(prototype: T, propertyKey: keyof T, _descriptor: Descriptor<JobHandlerFn>) => void;
+export {};

package/dist/job/decorators.js

@@ -7,7 +7,7 @@ jobName,
 /**
  * Cron expression
  */
-cron) => (prototype, propertyKey) => {
+cron) => (prototype, propertyKey, _descriptor) => {
     const metadata = initObjectMetadata(prototype);
     if (!metadata.jobs) {
         metadata.jobs = [];
@@ -26,7 +26,7 @@ export const CustomJob = (
 /**
  * Unique name of job
  */
-jobName) => (prototype, propertyKey) => {
+jobName) => (prototype, propertyKey, _descriptor) => {
     const metadata = initObjectMetadata(prototype);
     if (!metadata.jobs) {
         metadata.jobs = [];

package/dist/logging/FileLogMedium.js

@@ -11,7 +11,8 @@ var FileLogMedium_1;
 import fs from "fs";
 import path from "path";
 import { LogLevel, Initable } from "@clairejs/core";
-let FileLogMedium = FileLogMedium_1 = class FileLogMedium {
+let FileLogMedium = class FileLogMedium {
+    static { FileLogMedium_1 = this; }
     static levels = Object.values(LogLevel);
     destination;
     separated;

package/dist/services/AbstractFileService.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { FileOperation } from "../common/FileOperation";
 import { GetUploadUrlResponseBody } from "../controllers/dto/upload";
 export declare abstract class AbstractFileService {

package/dist/services/implementations/LocalFileService.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { FileOperation } from "../../common/FileOperation";
 import { AbstractFileService } from "../AbstractFileService";
 export declare class LocalFileService extends AbstractFileService {

package/dist/services/implementations/S3FileService.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { AbstractLogger } from "@clairejs/core";
 import { FileOperation } from "../../common/FileOperation";
 import { AbstractFileService } from "../AbstractFileService";

package/dist/socket/LocalSocketManager.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { AbstractLogger, IInit } from "@clairejs/core";
 import WebSocket from "ws";
 import { Server } from "http";

package/dist/system/locale/decorators.d.ts

@@ -1,2 +1,2 @@
 import { AbstractModel } from "@clairejs/core";
-export declare const LocaleOf: <T>(referenceColumn: keyof T) => <K extends string>(prototype: T & AbstractModel & { [k in K]?: Record<string, string> | undefined; }, propertyKey: K) => void;
+export declare const LocaleOf: <T>(referenceColumn: keyof T) => <K extends string>(prototype: T & AbstractModel & { [k in K]?: Record<string, string>; }, propertyKey: K) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@clairejs/server",
-    "version": "3.22.8",
+    "version": "3.22.10",
     "description": "Claire server NodeJs framework written in Typescript.",
     "types": "dist/index.d.ts",
     "main": "dist/index.js",
@@ -52,7 +52,7 @@
         "id-sdk": "^1.5.16",
         "mocha": "^10.2.0",
         "ts-node": "^10.9.1",
-        "typescript": "^5.0.4",
+        "typescript": "^5.5.4",
         "uuid": "^9.0.0"
     }
 }