@royalinvest/dto 0.75.1 → 0.76.1

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/activityFeed.js

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

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/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@royalinvest/dto",
-  "version": "0.75.1",
+  "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",