@royalinvest/dto 0.74.1 → 0.74.2

package/README.md

@@ -1,72 +1,72 @@
-# NPM Packages
-
-This project contains shared **NPM packages** for RoyalInvest (e.g., DTOs, utilities).  
-Packages are written in **TypeScript** and published to the company’s NPM organization.
-
----
-
-## Getting Started
-
-### 1. Configure NPM registry
-
-To authenticate with the NPM registry, configure your `.npmrc` file:
-
-```bash
-npm config set //registry.npmjs.org/:_authToken=<your_auth_token>
-```
-
-Replace `<your_auth_token>` with a token from [npmjs.com](https://www.npmjs.com/).  
-For access to the company’s account, request a token from the administrator.
-
----
-
-## Company Packages
-
-You can view all published packages here:  
-[RoyalInvest NPM Packages](https://www.npmjs.com/settings/royalinvest/packages)
-
----
-
-## Creating a New Package
-
-1. Create a new directory under `npm-package/`.
-2. Add:
-   - `package.json` (copy structure from `dto/package.json`).
-   - `tsconfig.json` (same as in existing packages).
-3. Implement your code in `src/`.
-
-Each package should follow the same conventions for consistency.
-
----
-
-## Building a Package
-
-Run the build command inside the package directory:
-
-```bash
-npm run build
-```
-
-Check the `scripts` section in `dto/package.json` for an example configuration.
-
----
-
-## Versioning
-
-We follow **Semantic Versioning (SemVer)**:
-
-- **MAJOR** – incompatible API changes  
-- **MINOR** – add functionality in a backward-compatible manner  
-- **PATCH** – backward-compatible bug fixes  
-
-Update the version number manually in `package.json` before publishing.
-
----
-
-## Publishing
-
-To publish a package to the NPM registry:
-
-```bash
-npm publish --access public
+# NPM Packages
+
+This project contains shared **NPM packages** for RoyalInvest (e.g., DTOs, utilities).  
+Packages are written in **TypeScript** and published to the company’s NPM organization.
+
+---
+
+## Getting Started
+
+### 1. Configure NPM registry
+
+To authenticate with the NPM registry, configure your `.npmrc` file:
+
+```bash
+npm config set //registry.npmjs.org/:_authToken=<your_auth_token>
+```
+
+Replace `<your_auth_token>` with a token from [npmjs.com](https://www.npmjs.com/).  
+For access to the company’s account, request a token from the administrator.
+
+---
+
+## Company Packages
+
+You can view all published packages here:  
+[RoyalInvest NPM Packages](https://www.npmjs.com/settings/royalinvest/packages)
+
+---
+
+## Creating a New Package
+
+1. Create a new directory under `npm-package/`.
+2. Add:
+   - `package.json` (copy structure from `dto/package.json`).
+   - `tsconfig.json` (same as in existing packages).
+3. Implement your code in `src/`.
+
+Each package should follow the same conventions for consistency.
+
+---
+
+## Building a Package
+
+Run the build command inside the package directory:
+
+```bash
+npm run build
+```
+
+Check the `scripts` section in `dto/package.json` for an example configuration.
+
+---
+
+## Versioning
+
+We follow **Semantic Versioning (SemVer)**:
+
+- **MAJOR** – incompatible API changes  
+- **MINOR** – add functionality in a backward-compatible manner  
+- **PATCH** – backward-compatible bug fixes  
+
+Update the version number manually in `package.json` before publishing.
+
+---
+
+## Publishing
+
+To publish a package to the NPM registry:
+
+```bash
+npm publish --access public
 ```

package/dist/logger/errorSerializer.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Uses pino's default error serializer for Error typed data.
+ *
+ * Also handles untyped third-party library errors and errors escaped
+ * ESLint "@typescript-eslint/prefer-promise-reject-errors" rule
+ * by ensuring consistent error object structure.
+ * This is necessary for log processing tools to properly index the error.
+ */
+export declare const errorSerializer: (error: unknown) => import("pino-std-serializers").SerializedError | {
+    message: unknown;
+    details: string;
+    is_native_error: boolean;
+} | {
+    message: string;
+    is_native_error: boolean;
+    details?: undefined;
+};

package/dist/logger/errorSerializer.js

@@ -0,0 +1,52 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.errorSerializer = void 0;
+const pino_1 = __importDefault(require("pino"));
+const MAX_DETAILS_LENGTH = 1000;
+/**
+ * Uses pino's default error serializer for Error typed data.
+ *
+ * Also handles untyped third-party library errors and errors escaped
+ * ESLint "@typescript-eslint/prefer-promise-reject-errors" rule
+ * by ensuring consistent error object structure.
+ * This is necessary for log processing tools to properly index the error.
+ */
+const errorSerializer = (error) => {
+    if (error instanceof Error) {
+        return pino_1.default.stdSerializers.err(error);
+    }
+    // Adds is_native_error flag to differentiate native errors from others
+    if (error && typeof error === "object") {
+        let details;
+        try {
+            details = JSON.stringify(error);
+        }
+        catch {
+            details = "[Unserializable Object]";
+        }
+        if (details.length > MAX_DETAILS_LENGTH) {
+            details = details.substring(0, MAX_DETAILS_LENGTH) + "...";
+        }
+        let message;
+        if ("message" in error)
+            message = error.message;
+        else if ("msg" in error)
+            message = error.msg;
+        if (!message || typeof message !== "string") {
+            message = "Error with unknown type";
+        }
+        return {
+            message,
+            details,
+            is_native_error: false,
+        };
+    }
+    return {
+        message: String(error),
+        is_native_error: false,
+    };
+};
+exports.errorSerializer = errorSerializer;

package/dist/logger/index.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.baseLogger = void 0;
 exports.createScopedLogger = createScopedLogger;
 const pino_1 = __importDefault(require("pino"));
+const errorSerializer_1 = require("./errorSerializer");
 const isDev = process.env.NODE_ENV === "development";
 const LOG_LEVEL = process.env.LOG_LEVEL || "info";
 exports.baseLogger = (0, pino_1.default)({
@@ -26,6 +27,12 @@ exports.baseLogger = (0, pino_1.default)({
             },
         }
         : undefined,
+    serializers: {
+        // Includes "error" in error serializing
+        // Uses custom serializer to handle more error types
+        err: errorSerializer_1.errorSerializer,
+        error: errorSerializer_1.errorSerializer,
+    }
 });
 function createScopedLogger(context) {
     return exports.baseLogger.child(context);

package/package.json

@@ -1,86 +1,88 @@
-{
-  "name": "@royalinvest/dto",
-  "version": "0.74.1",
-  "description": "Data Transfer Objects (DTOs) to carry data between frontend and backend processes.",
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "module": "./dist/index.js",
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "require": "./dist/index.js",
-      "import": "./dist/index.js"
-    },
-    "./backend": {
-      "types": "./dist/backend.d.ts",
-      "require": "./dist/backend.js",
-      "import": "./dist/backend.js"
-    },
-    "./credit-check": {
-      "types": "./dist/credit-check/index.d.ts",
-      "require": "./dist/credit-check/index.js",
-      "import": "./dist/credit-check/index.js"
-    },
-    "./enum": {
-      "types": "./dist/enum/index.d.ts",
-      "require": "./dist/enum/index.js",
-      "import": "./dist/enum/index.js"
-    }
-  },
-  "repository": {
-    "type": "git",
-    "url": "git@ssh.dev.azure.com:v3/royalinvest/royalinvest/npm-package"
-  },
-  "files": [
-    "dist"
-  ],
-  "publishConfig": {
-    "access": "public"
-  },
-  "scripts": {
-    "build": "npx tsc",
-    "lint": "eslint \"src/**/*.{js,jsx,ts,tsx}\"",
-    "lint:fix": "eslint --fix \"src/**/*.{js,jsx,ts,tsx}\"",
-    "prettier": "prettier --write \"src/**/*.{js,jsx,ts,tsx}\"",
-    "prettier:check": "npx prettier --check \"src/**/*.{js,jsx,ts,tsx}\"",
-    "clear-all": "rm -rf node_modules .next out dist build",
-    "re-start": "rm -rf node_modules .next out dist build && npm install && npm run dev",
-    "re-build": "rm -rf node_modules .next out dist build && npm install && npm run build",
-    "prepublishOnly": "npm run build",
-    "test": "echo \"Not implemented yet\""
-  },
-  "lint-staged": {
-    "src/**/*.{js,jsx,ts,tsx}": [
-      "prettier --write",
-      "eslint --fix",
-      "git add"
-    ]
-  },
-  "prettier": {
-    "tabWidth": 2,
-    "useTabs": false,
-    "singleQuote": false,
-    "printWidth": 120
-  },
-  "author": "Samos Technologies Inc.",
-  "license": "ISC",
-  "devDependencies": {
-    "@eslint/js": "^9.11.1",
-    "@types/amqplib": "^0.10.6",
-    "@types/node": "^24.1.0",
-    "eslint": "^9.11.1",
-    "eslint-plugin-react": "^7.37.0",
-    "globals": "^15.9.0",
-    "husky": "^8.0.0",
-    "lint-staged": "^15.2.10",
-    "prettier": "^3.3.3",
-    "typescript-eslint": "^8.7.0"
-  },
-  "dependencies": {
-    "amqplib": "^0.10.3",
-    "dayjs": "^1.11.19",
-    "pino": "^9.7.0",
-    "pino-pretty": "^13.0.0",
-    "prom-client": "^15.1.3"
-  }
-}
+{
+  "name": "@royalinvest/dto",
+  "version": "0.74.2",
+  "description": "Data Transfer Objects (DTOs) to carry data between frontend and backend processes.",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "module": "./dist/index.js",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "import": "./dist/index.js"
+    },
+    "./backend": {
+      "types": "./dist/backend.d.ts",
+      "require": "./dist/backend.js",
+      "import": "./dist/backend.js"
+    },
+    "./credit-check": {
+      "types": "./dist/credit-check/index.d.ts",
+      "require": "./dist/credit-check/index.js",
+      "import": "./dist/credit-check/index.js"
+    },
+    "./enum": {
+      "types": "./dist/enum/index.d.ts",
+      "require": "./dist/enum/index.js",
+      "import": "./dist/enum/index.js"
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "git@ssh.dev.azure.com:v3/royalinvest/royalinvest/npm-package"
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "npx tsc",
+    "lint": "eslint \"src/**/*.{js,jsx,ts,tsx}\"",
+    "lint:fix": "eslint --fix \"src/**/*.{js,jsx,ts,tsx}\"",
+    "prettier": "prettier --write \"src/**/*.{js,jsx,ts,tsx}\"",
+    "prettier:check": "npx prettier --check \"src/**/*.{js,jsx,ts,tsx}\"",
+    "clear-all": "rm -rf node_modules .next out dist build",
+    "re-start": "rm -rf node_modules .next out dist build && npm install && npm run dev",
+    "re-build": "rm -rf node_modules .next out dist build && npm install && npm run build",
+    "prepublishOnly": "npm run build",
+    "test": "echo \"Not implemented yet\""
+  },
+  "lint-staged": {
+    "src/**/*.{js,jsx,ts,tsx}": [
+      "prettier --write",
+      "eslint --fix",
+      "git add"
+    ]
+  },
+  "prettier": {
+    "tabWidth": 2,
+    "useTabs": false,
+    "singleQuote": false,
+    "printWidth": 120
+  },
+  "author": "Samos Technologies Inc.",
+  "license": "ISC",
+  "devDependencies": {
+    "@eslint/js": "^9.11.1",
+    "@types/amqplib": "^0.10.6",
+    "@types/node": "^24.1.0",
+    "eslint": "^9.11.1",
+    "eslint-plugin-react": "^7.37.0",
+    "globals": "^15.9.0",
+    "husky": "^8.0.0",
+    "lint-staged": "^15.2.10",
+    "prettier": "^3.3.3",
+    "typescript-eslint": "^8.7.0"
+  },
+  "dependencies": {
+    "amqplib": "^0.10.3",
+    "dayjs": "^1.11.19",
+    "prom-client": "^15.1.3"
+  },
+  "peerDependencies": {
+    "pino": "^9.7.0",
+    "pino-pretty": "^13.0.0"
+  }
+}

package/dist/billing.d.ts

@@ -1 +0,0 @@
-export type BillingIntervalType = "month" | "year" | "once";

package/dist/billing.js

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

package/dist/messageBrokerEvent.d.ts

@@ -1,5 +0,0 @@
-export interface IMessageBrokerEvent<TPayload> {
-    http_request_id: string;
-    user_id: string;
-    payload: TPayload;
-}

package/dist/messageBrokerEvent.js

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

package/dist/messageGenerate.d.ts

@@ -1,57 +0,0 @@
-import { LeaseTypeEnum } from "./enum";
-import { ICertificateFormData } from "./certificateFormData";
-import { IContractParty } from "./contractParty";
-import { IDocumentDrawingInstructions } from "./documentDrawingInstructions";
-import { IFileMetadata } from "./fileMetadata";
-import { ISignaturePartySigned } from "./signaturePartySigned";
-import { IInvoiceRenderData } from "./invoiceRenderData";
-import { ICreditCheckReportData } from "./creditCheckReport";
-export interface IMessageGenerate {
-    contract_id: string;
-    details: JSON;
-    user_id: string;
-    template_variant_file_name: string;
-    template_variant_name: string;
-    template_variant_language: string;
-    template_variant_mime_type: string;
-    template_variant_id: string;
-    template_name: LeaseTypeEnum;
-    file_id?: string;
-    isEdit?: boolean;
-    contract_parties?: IContractParty[];
-    drawing_instructions?: IDocumentDrawingInstructions;
-    metadata?: IFileMetadata;
-}
-export interface IMessageGenerateSigned {
-    party: ISignaturePartySigned;
-    generate_hash?: boolean;
-}
-export interface IMessageGenerateVoided {
-    user_id: string;
-    contract_id: string;
-    file_id: string;
-    file_name: string;
-    notify_party_email: boolean;
-    generate_hash?: boolean;
-}
-export interface IMessageGenerateCertificate {
-    file_id: string;
-    blob_path: string;
-    form_data: ICertificateFormData;
-    form_instructions: JSON;
-    language: string;
-}
-export interface IMessageGenerateInvoice {
-    user_id: string;
-    billing_id: string;
-    blob_path: string;
-    invoice_number: string;
-    language: string;
-    data: IInvoiceRenderData;
-}
-export interface IMessageGenerateCreditCheckReport {
-    report_data: ICreditCheckReportData;
-    subject_id: string;
-    blob_path: string;
-    language: string;
-}

package/dist/messageGenerate.js

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

package/dist/messageNotification.d.ts

@@ -1,45 +0,0 @@
-import { IPhysicalFileDetails } from "./physicalFileDetails";
-import { IPlaceholderCollection } from "./placeholderCollection";
-import { ISignaturePartyBasic } from "./signaturePartyBasic";
-export interface IGeneratedNotification {
-    contract_id: string;
-    user_id: string;
-    file_name: string;
-    file_language: string;
-    mime_type: string;
-    template_name: string;
-    template_variant_id: string;
-    file_id?: string;
-    isEdit?: boolean;
-    generated_placeholders?: IPlaceholderCollection;
-    generated_file_details?: IPhysicalFileDetails;
-}
-export interface ISignedNotification {
-    file_id: string;
-    party: ISignaturePartyBasic;
-    generated_file_details?: IPhysicalFileDetails;
-}
-export interface IVoidedNotification {
-    user_id: string;
-    file_id: string;
-    contract_id: string;
-    notify_party_email: boolean;
-    generated_file_details?: IPhysicalFileDetails;
-}
-export interface IGeneratedCertificateNotification {
-    file_id: string;
-    blob_path: string;
-}
-export interface IGeneratedInvoiceNotification {
-    user_id: string;
-    billing_id: string;
-    blob_path: string;
-    invoice_number: string;
-    language: string;
-}
-export interface IGeneratedCreditCheckReportNotification {
-    subject_id: string;
-    blob_path: string;
-    hash: string;
-    language: string;
-}

package/dist/messageNotification.js

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

package/dist/messageProcessContract.d.ts

@@ -1,8 +0,0 @@
-import { IContractParty } from "./contractParty";
-import { IProperty } from "./property";
-export interface IProcessContractNotification {
-    user_id: string;
-    contract_id: string;
-    parties?: IContractParty[];
-    property?: IProperty;
-}

package/dist/messageProcessContract.js

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

package/dist/payment.d.ts

@@ -1 +0,0 @@
-export type PaymentIntervalType = "month" | "year";

package/dist/payment.js

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

package/dist/signatureInitials.d.ts

@@ -1,5 +0,0 @@
-export interface ISignatureInitials {
-    initials: string;
-    signature: string;
-    timestamp: string;
-}

package/dist/signatureInitials.js

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

package/dist/usa/fl/section copy 2.js

@@ -1 +0,0 @@
-"use strict";

package/dist/usa/fl/section copy 3.js

@@ -1 +0,0 @@
-"use strict";

package/dist/usa/fl/section copy 4.js

@@ -1 +0,0 @@
-"use strict";

package/dist/usa/fl/section copy 5.js

@@ -1 +0,0 @@
-"use strict";