@eratu/common 1.0.16 → 1.0.17

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eratu/common",
-  "version": "1.0.16",
+  "version": "1.0.17",
   "description": "A package for shared code across microservices",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",
@@ -10,14 +10,20 @@
   "scripts": {
     "clean": "del-cli ./build/*",
     "build": "npm run clean && tsc",
-    "pub": "git add . && git commit -m \"Updates\" && npm version patch && npm publish"
+    "pub": "git add . && git commit -m \"Updates\" && npm version patch && npm publish",
+    "test": "jest --forceExit --detectOpenHandles",
+    "test:cov": "jest --coverage --forceExit --detectOpenHandles"
   },
   "keywords": [],
   "author": "",
   "license": "ISC",
   "type": "commonjs",
   "devDependencies": {
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.13.1",
     "del-cli": "^6.0.0",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.2.5",
     "typescript": "^5.7.3"
   },
   "dependencies": {

package/build/enum/roles.d.ts

@@ -1,6 +0,0 @@
-export declare enum UserRoles {
-    superAdmin = 1,
-    admin = 2,
-    author = 3,
-    reader = 4
-}

package/build/enum/roles.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UserRoles = void 0;
-var UserRoles;
-(function (UserRoles) {
-    UserRoles[UserRoles["superAdmin"] = 1] = "superAdmin";
-    UserRoles[UserRoles["admin"] = 2] = "admin";
-    UserRoles[UserRoles["author"] = 3] = "author";
-    UserRoles[UserRoles["reader"] = 4] = "reader";
-})(UserRoles || (exports.UserRoles = UserRoles = {}));

package/build/errors/bad-request-error.d.ts

@@ -1,9 +0,0 @@
-import { CustomError } from './custom-error';
-export declare class BadRequestError extends CustomError {
-    message: string;
-    statusCode: number;
-    constructor(message: string);
-    serializeErrors(): {
-        message: string;
-    }[];
-}

package/build/errors/bad-request-error.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BadRequestError = void 0;
-const custom_error_1 = require("./custom-error");
-class BadRequestError extends custom_error_1.CustomError {
-    constructor(message) {
-        super(message);
-        this.message = message;
-        this.statusCode = 400;
-        Object.setPrototypeOf(this, BadRequestError.prototype);
-    }
-    serializeErrors() {
-        return [{ message: this.message }];
-    }
-}
-exports.BadRequestError = BadRequestError;

package/build/errors/custom-error.d.ts

@@ -1,8 +0,0 @@
-export declare abstract class CustomError extends Error {
-    abstract statusCode: number;
-    constructor(message: string);
-    abstract serializeErrors(): {
-        message: string;
-        field?: string;
-    }[];
-}

package/build/errors/custom-error.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CustomError = void 0;
-class CustomError extends Error {
-    constructor(message) {
-        super(message);
-        Object.setPrototypeOf(this, CustomError.prototype);
-    }
-}
-exports.CustomError = CustomError;

package/build/errors/database-connection-error.d.ts

@@ -1,9 +0,0 @@
-import { CustomError } from './custom-error';
-export declare class DatabaseConnectionError extends CustomError {
-    statusCode: number;
-    reason: string;
-    constructor();
-    serializeErrors(): {
-        message: string;
-    }[];
-}

package/build/errors/database-connection-error.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DatabaseConnectionError = void 0;
-const custom_error_1 = require("./custom-error");
-class DatabaseConnectionError extends custom_error_1.CustomError {
-    constructor() {
-        super('Error connecting to db');
-        this.statusCode = 500;
-        this.reason = 'Error connecting to database';
-        Object.setPrototypeOf(this, DatabaseConnectionError.prototype);
-    }
-    serializeErrors() {
-        return [{ message: this.reason }];
-    }
-}
-exports.DatabaseConnectionError = DatabaseConnectionError;

package/build/errors/forbidden-error.d.ts

@@ -1,9 +0,0 @@
-import { CustomError } from "./custom-error";
-export declare class ForbiddenError extends CustomError {
-    message: string;
-    statusCode: number;
-    constructor(message?: string);
-    serializeErrors(): {
-        message: string;
-    }[];
-}

package/build/errors/forbidden-error.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ForbiddenError = void 0;
-const custom_error_1 = require("./custom-error");
-class ForbiddenError extends custom_error_1.CustomError {
-    constructor(message = "Forbidden") {
-        super(message);
-        this.message = message;
-        this.statusCode = 403;
-        Object.setPrototypeOf(this, ForbiddenError.prototype);
-    }
-    serializeErrors() {
-        return [{ message: this.message }];
-    }
-}
-exports.ForbiddenError = ForbiddenError;

package/build/errors/not-authorized-error.d.ts

@@ -1,8 +0,0 @@
-import { CustomError } from "./custom-error";
-export declare class NotAuthorizedError extends CustomError {
-    statusCode: number;
-    constructor(message?: string);
-    serializeErrors(): {
-        message: string;
-    }[];
-}

package/build/errors/not-authorized-error.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.NotAuthorizedError = void 0;
-const custom_error_1 = require("./custom-error");
-class NotAuthorizedError extends custom_error_1.CustomError {
-    constructor(message = "Not Authorized") {
-        super(message);
-        this.statusCode = 401;
-        Object.setPrototypeOf(this, NotAuthorizedError.prototype);
-    }
-    serializeErrors() {
-        return [{ message: this.message }];
-    }
-}
-exports.NotAuthorizedError = NotAuthorizedError;

package/build/errors/not-found-error.d.ts

@@ -1,9 +0,0 @@
-import { CustomError } from "./custom-error";
-export declare class NotFoundError extends CustomError {
-    message: string;
-    statusCode: number;
-    constructor(message?: string);
-    serializeErrors(): {
-        message: string;
-    }[];
-}

package/build/errors/not-found-error.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.NotFoundError = void 0;
-const custom_error_1 = require("./custom-error");
-class NotFoundError extends custom_error_1.CustomError {
-    constructor(message = "Not Found") {
-        super("Route not found");
-        this.message = message;
-        this.statusCode = 404;
-        Object.setPrototypeOf(this, NotFoundError.prototype);
-    }
-    serializeErrors() {
-        return [{ message: this.message }];
-    }
-}
-exports.NotFoundError = NotFoundError;

package/build/errors/request-validation-error.d.ts

@@ -1,14 +0,0 @@
-import { ValidationError } from 'express-validator';
-import { CustomError } from './custom-error';
-export declare class RequestValidationError extends CustomError {
-    errors: ValidationError[];
-    statusCode: number;
-    constructor(errors: ValidationError[]);
-    serializeErrors(): ({
-        message: any;
-        field: string;
-    } | {
-        message: any;
-        field?: undefined;
-    })[];
-}

package/build/errors/request-validation-error.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RequestValidationError = void 0;
-const custom_error_1 = require("./custom-error");
-class RequestValidationError extends custom_error_1.CustomError {
-    constructor(errors) {
-        super('Invalid request parameters');
-        this.errors = errors;
-        this.statusCode = 400;
-        // Only because we are extending a built in class
-        Object.setPrototypeOf(this, RequestValidationError.prototype);
-    }
-    serializeErrors() {
-        return this.errors.map((err) => {
-            if (err.type === 'field') {
-                return { message: err.msg, field: err.path };
-            }
-            return { message: err.msg };
-        });
-    }
-}
-exports.RequestValidationError = RequestValidationError;

package/build/events/event-types/auth/author-deleted-event.d.ts

@@ -1,11 +0,0 @@
-import { Streams } from "../../streams";
-import { Subjects } from "../../subjects";
-export interface AuthorDeletedEvent {
-    subject: Subjects.AuthorDeleted;
-    stream: Streams.AuthServiceStream;
-    data: {
-        id: string;
-        version: number;
-        authorVersion: number;
-    };
-}

package/build/events/event-types/auth/author-deleted-event.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/events/event-types/auth/author-signed-in-event.d.ts

@@ -1,12 +0,0 @@
-import { Streams } from "../../streams";
-import { Subjects } from "../../subjects";
-export interface AuthorSignedInEvent {
-    subject: Subjects.AuthorSignedIn;
-    stream: Streams.AuthServiceStream;
-    data: {
-        userId: string;
-        email: string;
-        version: number;
-        authorVersion: number;
-    };
-}

package/build/events/event-types/auth/author-signed-in-event.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/events/event-types/auth/author-signed-out-event.d.ts

@@ -1,11 +0,0 @@
-import { Streams } from "../../streams";
-import { Subjects } from "../../subjects";
-export interface AuthorSignedOutEvent {
-    subject: Subjects.AuthorSignedOut;
-    stream: Streams.AuthServiceStream;
-    data: {
-        userId: string;
-        sessionId: string;
-        signedOutAt: string;
-    };
-}

package/build/events/event-types/auth/author-signed-out-event.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/events/event-types/auth/author-signed-up-event.d.ts

@@ -1,13 +0,0 @@
-import { Streams } from "../../streams";
-import { Subjects } from "../../subjects";
-export interface AuthorSignedUpEvent {
-    subject: Subjects.AuthorSignedUp;
-    stream: Streams.AuthServiceStream;
-    data: {
-        id: string;
-        email: string;
-        firstName: string;
-        lastName: string;
-        createdAt: string;
-    };
-}

package/build/events/event-types/auth/author-signed-up-event.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/events/event-types/auth/author-updated-event.d.ts

@@ -1,14 +0,0 @@
-import { Streams } from "../../streams";
-import { Subjects } from "../../subjects";
-export interface AuthorUpdatedEvent {
-    subject: Subjects.AuthorUpdated;
-    stream: Streams.AuthServiceStream;
-    data: {
-        id: string;
-        firstName: string;
-        lastName: string;
-        email: string;
-        version: number;
-        authorVersion: number;
-    };
-}

package/build/events/event-types/auth/author-updated-event.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/events/event-types/auth/author-verified-event.d.ts

@@ -1,14 +0,0 @@
-import { Streams } from "../../streams";
-import { Subjects } from "../../subjects";
-export interface AuthorVerifiedEvent {
-    subject: Subjects.AuthorVerified;
-    stream: Streams.AuthServiceStream;
-    data: {
-        id: string;
-        firstName: string;
-        lastName: string;
-        email: string;
-        version: number;
-        authorVersion: number;
-    };
-}

package/build/events/event-types/auth/author-verified-event.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/events/event-types/auth/reader-deleted-event.d.ts

@@ -1,11 +0,0 @@
-import { Streams } from "../../streams";
-import { Subjects } from "../../subjects";
-export interface ReaderDeletedEvent {
-    subject: Subjects.ReaderDeleted;
-    stream: Streams.AuthServiceStream;
-    data: {
-        id: string;
-        version: number;
-        readerVersion: number;
-    };
-}

package/build/events/event-types/auth/reader-deleted-event.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/events/event-types/auth/reader-signed-in-event.d.ts

@@ -1,13 +0,0 @@
-import { Streams } from "../../streams";
-import { Subjects } from "../../subjects";
-export interface ReaderSignedInEvent {
-    subject: Subjects.ReaderSignedIn;
-    stream: Streams.AuthServiceStream;
-    data: {
-        userId: string;
-        email: string;
-        signedInAt: string;
-        version: number;
-        readerVersion: number;
-    };
-}

package/build/events/event-types/auth/reader-signed-in-event.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/events/event-types/auth/reader-signed-out-event.d.ts

@@ -1,11 +0,0 @@
-import { Streams } from "../../streams";
-import { Subjects } from "../../subjects";
-export interface ReaderSignedOutEvent {
-    subject: Subjects.ReaderSignedOut;
-    stream: Streams.AuthServiceStream;
-    data: {
-        userId: string;
-        sessionId: string;
-        signedOutAt: string;
-    };
-}

package/build/events/event-types/auth/reader-signed-out-event.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/events/event-types/auth/reader-signed-up-event.d.ts

@@ -1,13 +0,0 @@
-import { Streams } from "../../streams";
-import { Subjects } from "../../subjects";
-export interface ReaderSignedUpEvent {
-    subject: Subjects.ReaderSignedUp;
-    stream: Streams.AuthServiceStream;
-    data: {
-        id: string;
-        email: string;
-        firstName: string;
-        lastName: string;
-        createdAt: string;
-    };
-}

package/build/events/event-types/auth/reader-signed-up-event.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/events/event-types/auth/reader-updated-event.d.ts

@@ -1,14 +0,0 @@
-import { Streams } from "../../streams";
-import { Subjects } from "../../subjects";
-export interface ReaderUpdatedEvent {
-    subject: Subjects.ReaderUpdated;
-    stream: Streams.AuthServiceStream;
-    data: {
-        id: string;
-        firstName: string;
-        lastName: string;
-        email: string;
-        version: number;
-        readerVersion: number;
-    };
-}

package/build/events/event-types/auth/reader-updated-event.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/events/event-types/auth/reader-verified-event.d.ts

@@ -1,14 +0,0 @@
-import { Streams } from "../../streams";
-import { Subjects } from "../../subjects";
-export interface ReaderVerifiedEvent {
-    subject: Subjects.ReaderVerified;
-    stream: Streams.AuthServiceStream;
-    data: {
-        id: string;
-        firstName: string;
-        lastName: string;
-        email: string;
-        version: number;
-        readerVersion: number;
-    };
-}

package/build/events/event-types/auth/reader-verified-event.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/events/event-types/books/book-created-event.d.ts

@@ -1,11 +0,0 @@
-import { Streams } from "../../streams";
-import { Subjects } from "../../subjects";
-export interface BookCreatedEvent {
-    subject: Subjects.BookCreated;
-    stream: Streams.BookServiceStream;
-    data: {
-        id: string;
-        version: number;
-        title: string;
-    };
-}

package/build/events/event-types/books/book-created-event.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/events/event-types/books/book-deleted-event.d.ts

@@ -1,10 +0,0 @@
-import { Streams } from "../../streams";
-import { Subjects } from "../../subjects";
-export interface BookDeletedEvent {
-    subject: Subjects.BookDeleted;
-    stream: Streams.BookServiceStream;
-    data: {
-        id: string;
-        version: number;
-    };
-}

package/build/events/event-types/books/book-deleted-event.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/events/event-types/books/book-updated-event.d.ts

@@ -1,11 +0,0 @@
-import { Streams } from "../../streams";
-import { Subjects } from "../../subjects";
-export interface BookUpdatedEvent {
-    subject: Subjects.BookUpdated;
-    stream: Streams.BookServiceStream;
-    data: {
-        id: string;
-        version: number;
-        title: string;
-    };
-}

package/build/events/event-types/books/book-updated-event.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/events/event-types/orders/order-created-event.d.ts

@@ -1,12 +0,0 @@
-import { Streams } from "../../streams";
-import { Subjects } from "../../subjects";
-export interface OrderCreatedEvent {
-    subject: Subjects.OrderCreated;
-    stream: Streams.OrderServiceStream;
-    data: {
-        id: string;
-        version: number;
-        userId: string;
-        expiresAt: string;
-    };
-}

package/build/events/event-types/orders/order-created-event.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/events/listeners/base-listener.d.ts

@@ -1,23 +0,0 @@
-import { JetStreamManager, JsMsg, Consumer, JetStreamClient } from "nats";
-interface Event {
-    subject: string;
-    stream: string;
-    data: any;
-}
-export declare abstract class Listener<T extends Event> {
-    abstract subject: T["subject"];
-    abstract stream: T["stream"];
-    abstract durableName: string;
-    abstract onMessage(data: T["data"], msg: JsMsg): void;
-    protected jsm: JetStreamManager;
-    protected js: JetStreamClient;
-    protected consumer: Consumer;
-    protected ackWait: number;
-    protected codec: import("nats").Codec<unknown>;
-    constructor(js: JetStreamClient, jsm: JetStreamManager);
-    private waitForStream;
-    private createConsumerIfNotExists;
-    listen(): Promise<void>;
-    private parseMessage;
-}
-export {};