@royalinvest/dto 0.61.3 → 0.63.0

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/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/rabbitmq/messageBrokerEvent.d.ts

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

package/dist/rabbitmq/messageBrokerEvent.js

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

package/dist/rabbitmq/messageGenerate.d.ts

@@ -0,0 +1,54 @@
+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;
+    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 {
+    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 {
+    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/rabbitmq/messageGenerate.js

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

package/dist/rabbitmq/messageNotification.d.ts

@@ -0,0 +1,42 @@
+import { IPhysicalFileDetails } from "../physicalFileDetails";
+import { IPlaceholderCollection } from "../placeholderCollection";
+import { ISignaturePartyBasic } from "../signaturePartyBasic";
+export interface IGeneratedNotification {
+    contract_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 {
+    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 {
+    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/rabbitmq/messageNotification.js

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

package/dist/signature-confirmation.d.ts

@@ -1,4 +1,5 @@
 import { PartyTypeEnum } from "./enum";
+import { SignatureMethodType } from "./signature-party";
 export interface ISignConfirmation {
     code: string;
     signatureId: string;
@@ -11,4 +12,5 @@ export interface ISignConfirmation {
     party_email: string;
     party_role: PartyTypeEnum;
     user_id?: string;
+    signatureMethod?: SignatureMethodType;
 }

package/dist/signature-party/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./signaturePartyChangeRequest";
 export * from "./signaturePartySignView";
+export * from "./signatureMethodType";

package/dist/signature-party/index.js

@@ -16,3 +16,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./signaturePartyChangeRequest"), exports);
 __exportStar(require("./signaturePartySignView"), exports);
+__exportStar(require("./signatureMethodType"), exports);

package/dist/signature-party/signatureMethodType.d.ts

@@ -0,0 +1 @@
+export type SignatureMethodType = "drawn" | "system-generated" | "uploaded";

package/dist/signature-party/signatureMethodType.js

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

package/package.json

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