@royalinvest/dto 0.74.7 → 0.76.1

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

@@ -0,0 +1,63 @@
+import { IContractParty } from "./contractParty";
+import { TBureau } from "./credit-check";
+import { ActivityStatusEnum, ActivityTypeEnum, CurrencyEnum, RentCycleEnum, ServiceTypeEnum } from "./enum";
+export interface ILeaseActivityFeedData {
+    address?: string;
+    amount?: number | null;
+    start_date?: string | null;
+    end_date?: string | null;
+    file_id?: string | null;
+    file_name?: string | null;
+    file_size_in_kb?: number | null;
+    file_page_count?: number | null;
+    parties?: IContractParty[];
+}
+export interface ITenantScreeningActivityFeedData {
+    address?: string;
+    bureau: TBureau;
+    first_name?: string | null;
+    last_name?: string | null;
+    amount?: number | null;
+    currency?: CurrencyEnum | null;
+    rent_cycle?: RentCycleEnum | null;
+    subject_id?: string | null;
+}
+export interface IRentCollectionActivityFeedData {
+    address?: string;
+    first_name?: string | null;
+    last_name?: string | null;
+    amount?: number | null;
+    currency?: CurrencyEnum | null;
+    rent_cycle?: RentCycleEnum | null;
+    start_date?: string | null;
+    end_date?: string | null;
+    payment_date?: string | null;
+    payment_method?: string | null;
+    invoice_id?: string | null;
+    invoice_number?: string | null;
+}
+export type TActivityFeedCategory = ServiceTypeEnum.SCREENING_QUESTIONNAIRE | ServiceTypeEnum.CREDIT_CHECK | ServiceTypeEnum.LEASE_AGREEMENT | ServiceTypeEnum.RENT_COLLECTION;
+export type TActivityFeedData = ILeaseActivityFeedData | ITenantScreeningActivityFeedData | IRentCollectionActivityFeedData;
+export interface IActivityFeedListItem {
+    id: string;
+    category: TActivityFeedCategory;
+    activity_type: ActivityTypeEnum;
+    status: ActivityStatusEnum | null;
+    entity_id: string;
+    data: TActivityFeedData;
+    occurred_at: string;
+}
+export type IActivityFeedCategoryCounts = {
+    all: number;
+} & Record<TActivityFeedCategory, number>;
+export interface IActivityFeedListResponse {
+    items: IActivityFeedListItem[];
+    counts: IActivityFeedCategoryCounts;
+    cursor: string | null;
+    has_more: boolean;
+}
+export interface IActivityFeedQuery {
+    category?: TActivityFeedCategory;
+    cursor?: string;
+    limit?: number;
+}

package/dist/enum/activityFeed.d.ts

@@ -0,0 +1,17 @@
+export declare enum ActivityStatusEnum {
+    PENDING = "pending",
+    PROCESSING = "processing",
+    COMPLETED = "completed",
+    FAILED = "failed",
+    PAUSED = "paused"
+}
+export declare enum ActivityTypeEnum {
+    LEASE_PREPARE = "lease.prepare",
+    LEASE_SIGN = "lease.sign",
+    LEASE_VOIDED = "lease.voided",
+    TENANT_SCREENING_SETUP = "tenant_screening.setup",
+    TENANT_SCREENING_CONSENT = "tenant_screening.consent",
+    TENANT_SCREENING_REPORT = "tenant_screening.report",
+    RENT_PAYMENT_SETUP = "rent_payment.setup",
+    RENT_PAYMENT_RECEIVED = "rent_payment.received"
+}

package/dist/enum/activityFeed.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActivityTypeEnum = exports.ActivityStatusEnum = void 0;
+var ActivityStatusEnum;
+(function (ActivityStatusEnum) {
+    ActivityStatusEnum["PENDING"] = "pending";
+    ActivityStatusEnum["PROCESSING"] = "processing";
+    ActivityStatusEnum["COMPLETED"] = "completed";
+    ActivityStatusEnum["FAILED"] = "failed";
+    ActivityStatusEnum["PAUSED"] = "paused";
+})(ActivityStatusEnum || (exports.ActivityStatusEnum = ActivityStatusEnum = {}));
+var ActivityTypeEnum;
+(function (ActivityTypeEnum) {
+    // Lease
+    ActivityTypeEnum["LEASE_PREPARE"] = "lease.prepare";
+    ActivityTypeEnum["LEASE_SIGN"] = "lease.sign";
+    ActivityTypeEnum["LEASE_VOIDED"] = "lease.voided";
+    // Tenant Screening (credit check and screening questionnaire)
+    ActivityTypeEnum["TENANT_SCREENING_SETUP"] = "tenant_screening.setup";
+    ActivityTypeEnum["TENANT_SCREENING_CONSENT"] = "tenant_screening.consent";
+    ActivityTypeEnum["TENANT_SCREENING_REPORT"] = "tenant_screening.report";
+    // Rent collection
+    ActivityTypeEnum["RENT_PAYMENT_SETUP"] = "rent_payment.setup";
+    ActivityTypeEnum["RENT_PAYMENT_RECEIVED"] = "rent_payment.received";
+})(ActivityTypeEnum || (exports.ActivityTypeEnum = ActivityTypeEnum = {}));

package/dist/enum/index.d.ts

@@ -1,6 +1,8 @@
 export * from "./country";
 export * from "./currency";
 export * from "./cycle";
+export * from "./activityFeed";
+export * from "./serviceType";
 export declare enum PartyTypeEnum {
     default = "",
     lessor = "lessor",

package/dist/enum/index.js

@@ -18,6 +18,8 @@ exports.UnitMeasurementEnum = exports.BulkPurchaseSourceTypeEnum = exports.TextA
 __exportStar(require("./country"), exports);
 __exportStar(require("./currency"), exports);
 __exportStar(require("./cycle"), exports);
+__exportStar(require("./activityFeed"), exports);
+__exportStar(require("./serviceType"), exports);
 var PartyTypeEnum;
 (function (PartyTypeEnum) {
     PartyTypeEnum["default"] = "";

package/dist/enum/serviceType.d.ts

@@ -0,0 +1,7 @@
+export declare enum ServiceTypeEnum {
+    LEASE_AGREEMENT = "lease_agreement",
+    CREDIT_CHECK = "credit_check",
+    RENT_COLLECTION = "rent_collection",
+    STORAGE = "storage",
+    SCREENING_QUESTIONNAIRE = "screening_questionnaire"
+}

package/dist/enum/serviceType.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServiceTypeEnum = void 0;
+var ServiceTypeEnum;
+(function (ServiceTypeEnum) {
+    ServiceTypeEnum["LEASE_AGREEMENT"] = "lease_agreement";
+    ServiceTypeEnum["CREDIT_CHECK"] = "credit_check";
+    ServiceTypeEnum["RENT_COLLECTION"] = "rent_collection";
+    ServiceTypeEnum["STORAGE"] = "storage";
+    ServiceTypeEnum["SCREENING_QUESTIONNAIRE"] = "screening_questionnaire";
+})(ServiceTypeEnum || (exports.ServiceTypeEnum = ServiceTypeEnum = {}));

package/dist/enum/uiLanguage.d.ts

@@ -0,0 +1 @@
+export type UILanguage = "en" | "fr" | "de" | "es" | "nl";

package/dist/index.d.ts

@@ -80,3 +80,4 @@ export * from "./usa";
 export * from "./user";
 export * from "./utils";
 export * from "./yes-no";
+export * from "./activityFeed";

package/dist/index.js

@@ -96,3 +96,4 @@ __exportStar(require("./usa"), exports);
 __exportStar(require("./user"), exports);
 __exportStar(require("./utils"), exports);
 __exportStar(require("./yes-no"), exports);
+__exportStar(require("./activityFeed"), exports);

package/dist/metrics/business.d.ts

@@ -1,5 +1,5 @@
 import client from "prom-client";
 export declare const leaseAgreementsCreated: client.Counter<string>;
 export declare const documentsSigned: client.Counter<string>;
-export declare const creditChecksPerformed: client.Counter<"status" | "bureau">;
-export declare const creditCheckProcessingDuration: client.Histogram<"queue" | "bureau">;
+export declare const creditChecksPerformed: client.Counter<"bureau" | "status">;
+export declare const creditCheckProcessingDuration: client.Histogram<"bureau" | "queue">;

package/dist/metrics/core.d.ts

@@ -2,8 +2,8 @@ import client from "prom-client";
 export declare const register: client.Registry<"text/plain; version=0.0.4; charset=utf-8">;
 export declare const apiRequests: client.Counter<"method" | "route" | "status">;
 export declare const apiRequestDuration: client.Histogram<"method" | "route" | "status">;
-export declare const messagesReceived: client.Counter<"queue" | "routingKey" | "bureau">;
-export declare const messagesProcessed: client.Counter<"queue" | "routingKey" | "bureau">;
-export declare const messagesFailed: client.Counter<"queue" | "routingKey" | "bureau" | "exchange">;
-export declare const messageRetries: client.Counter<"queue" | "routingKey" | "bureau" | "exchange">;
-export declare const messagesPublished: client.Counter<"routingKey" | "bureau" | "exchange">;
+export declare const messagesReceived: client.Counter<"bureau" | "queue" | "routingKey">;
+export declare const messagesProcessed: client.Counter<"bureau" | "queue" | "routingKey">;
+export declare const messagesFailed: client.Counter<"bureau" | "queue" | "routingKey" | "exchange">;
+export declare const messageRetries: client.Counter<"bureau" | "queue" | "routingKey" | "exchange">;
+export declare const messagesPublished: client.Counter<"bureau" | "routingKey" | "exchange">;

package/dist/rabbitmq/constants.d.ts

@@ -131,4 +131,13 @@ export declare const RABBITMQ_EXCHANGES: {
             readonly email_automation: "email_automation";
         };
     };
+    readonly activity_feed: {
+        readonly name: "ACTIVITY_FEED_EXCHANGE";
+        readonly keys: {
+            readonly upsert: "activity_feed.upsert";
+        };
+        readonly queues: {
+            readonly activity_feed: "activity_feed_queue";
+        };
+    };
 };

package/dist/rabbitmq/constants.js

@@ -135,4 +135,13 @@ exports.RABBITMQ_EXCHANGES = {
             email_automation: "email_automation",
         },
     },
+    activity_feed: {
+        name: "ACTIVITY_FEED_EXCHANGE",
+        keys: {
+            upsert: "activity_feed.upsert",
+        },
+        queues: {
+            activity_feed: "activity_feed_queue",
+        },
+    },
 };

package/package.json

@@ -1,88 +1,88 @@
-{
-  "name": "@royalinvest/dto",
-  "version": "0.74.7",
-  "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"
-  }
-}
+{
+  "name": "@royalinvest/dto",
+  "version": "0.76.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",
+    "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/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/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";