@royalinvest/dto 0.61.2 → 0.62.1

package/README.md

@@ -1,41 +1,72 @@
-# How to Contribute to NPM Packages
+# NPM Packages
 
-## Configuring the Remote URL
+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.
 
-To configure the remote NPM registry URL, use the following command:
+---
 
+## Getting Started
 
-Replace `<your_auth_token>` with the token generated from the NPM website.
+### 1. Configure NPM registry
 
-## Access Token
+To authenticate with the NPM registry, configure your `.npmrc` file:
 
-You can generate the `_authToken` by visiting [npmjs.com](https://www.npmjs.com/).  
-For access to the company's NPM account, contact the administrator to either request a token or obtain access to generate a new one.
+```bash
+npm config set //registry.npmjs.org/:_authToken=<your_auth_token>
+```
 
-## NPM Packages
+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.
 
-You can view the company's public NPM packages here:  
-[Company NPM Packages](https://www.npmjs.com/settings/royalinvest/packages)
+---
+
+## Company Packages
+
+You can view all published packages here:  
+[RoyalInvest NPM Packages](https://www.npmjs.com/settings/royalinvest/packages)
+
+---
 
 ## Creating a New Package
 
-To create a new NPM package:
-- Add a new directory.
-- Ensure that it includes the same `tsconfig.json` and `package.json` configuration as found in the `dto` 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.
 
-## Building the NPM Package
+---
 
-To build the NPM package, run the following command. Refer to `dto/package.json` for configuration details:
+## Versioning
 
+We follow **Semantic Versioning (SemVer)**:
 
-## Versioning a Package
+- **MAJOR** – incompatible API changes  
+- **MINOR** – add functionality in a backward-compatible manner  
+- **PATCH** – backward-compatible bug fixes  
 
-Follow Semantic Versioning (SemVer) standards for package versioning.  
-Versioning should be updated manually by modifying the version number in the `package.json` file.
+Update the version number manually in `package.json` before publishing.
 
-## Publishing a Package
+---
 
-Use the following command to publish a new package:
+## Publishing
 
+To publish a package to the NPM registry:
 
-The current scope is set to `public` by default in the `package.json` file, making all packages publicly accessible.
+```bash
+npm publish --access public
+```

package/dist/credit-check/index.d.ts

@@ -159,6 +159,7 @@ export interface ICreditCheckResult {
     trades: number;
     flags: string[];
     created_at: Date;
+    reason_codes?: TReason[];
 }
 export interface ICreditCheckReportFile {
     id: string;

package/dist/index.d.ts

@@ -36,9 +36,6 @@ export * from "./lease";
 export * from "./leaseNoticeRule";
 export * from "./leaseSaveTypeEnum";
 export * from "./list-response";
-export * from "./messageBrokerEvent";
-export * from "./messageGenerate";
-export * from "./messageNotification";
 export * from "./noticeRule";
 export * from "./notification";
 export * from "./party";

package/dist/index.js

@@ -52,9 +52,6 @@ __exportStar(require("./lease"), exports);
 __exportStar(require("./leaseNoticeRule"), exports);
 __exportStar(require("./leaseSaveTypeEnum"), exports);
 __exportStar(require("./list-response"), exports);
-__exportStar(require("./messageBrokerEvent"), exports);
-__exportStar(require("./messageGenerate"), exports);
-__exportStar(require("./messageNotification"), exports);
 __exportStar(require("./noticeRule"), exports);
 __exportStar(require("./notification"), exports);
 __exportStar(require("./party"), exports);

package/dist/rabbitmq/index.d.ts

@@ -1,3 +1,6 @@
 export * from "./producer";
 export * from "./consumer";
 export * from "./constants";
+export * from "./messageBrokerEvent";
+export * from "./messageGenerate";
+export * from "./messageNotification";

package/dist/rabbitmq/index.js

@@ -17,3 +17,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./producer"), exports);
 __exportStar(require("./consumer"), exports);
 __exportStar(require("./constants"), exports);
+__exportStar(require("./messageBrokerEvent"), exports);
+__exportStar(require("./messageGenerate"), exports);
+__exportStar(require("./messageNotification"), exports);

package/dist/{messageGenerate.d.ts → rabbitmq/messageGenerate.d.ts}

@@ -1,15 +1,14 @@
-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";
+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;
@@ -27,7 +26,6 @@ export interface IMessageGenerateSigned {
     generate_hash?: boolean;
 }
 export interface IMessageGenerateVoided {
-    user_id: string;
     contract_id: string;
     file_id: string;
     file_name: string;
@@ -42,7 +40,6 @@ export interface IMessageGenerateCertificate {
     language: string;
 }
 export interface IMessageGenerateInvoice {
-    user_id: string;
     billing_id: string;
     blob_path: string;
     invoice_number: string;

package/dist/{messageNotification.d.ts → rabbitmq/messageNotification.d.ts}

@@ -1,9 +1,8 @@
-import { IPhysicalFileDetails } from "./physicalFileDetails";
-import { IPlaceholderCollection } from "./placeholderCollection";
-import { ISignaturePartyBasic } from "./signaturePartyBasic";
+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;
@@ -20,7 +19,6 @@ export interface ISignedNotification {
     generated_file_details?: IPhysicalFileDetails;
 }
 export interface IVoidedNotification {
-    user_id: string;
     file_id: string;
     contract_id: string;
     notify_party_email: boolean;
@@ -31,7 +29,6 @@ export interface IGeneratedCertificateNotification {
     blob_path: string;
 }
 export interface IGeneratedInvoiceNotification {
-    user_id: string;
     billing_id: string;
     blob_path: string;
     invoice_number: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@royalinvest/dto",
-  "version": "0.61.2",
+  "version": "0.62.1",
   "description": "Data Transfer Objects (DTOs) to carry data between frontend and backend processes.",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",