@royalinvest/dto 0.74.0 → 0.74.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +71 -71
- package/dist/billing.d.ts +1 -0
- package/dist/credit-check/creditCheck.d.ts +9 -0
- package/dist/messageProcessContract.d.ts +8 -0
- package/dist/messageProcessContract.js +2 -0
- package/dist/payment.d.ts +1 -0
- package/dist/payment.js +2 -0
- package/dist/signatureInitials.d.ts +5 -0
- package/dist/signatureInitials.js +2 -0
- package/dist/usa/fl/section copy 2.d.ts +0 -0
- package/dist/usa/fl/section copy 2.js +1 -0
- package/dist/usa/fl/section copy 3.d.ts +0 -0
- package/dist/usa/fl/section copy 3.js +1 -0
- package/dist/usa/fl/section copy 4.d.ts +0 -0
- package/dist/usa/fl/section copy 4.js +1 -0
- package/dist/usa/fl/section copy 5.d.ts +0 -0
- package/dist/usa/fl/section copy 5.js +1 -0
- package/package.json +86 -86
- package/dist/enum/uiLanguage.d.ts +0 -1
- /package/dist/{enum/uiLanguage.js → billing.js} +0 -0
package/README.md
CHANGED
|
@@ -1,72 +1,72 @@
|
|
|
1
|
-
# NPM Packages
|
|
2
|
-
|
|
3
|
-
This project contains shared **NPM packages** for RoyalInvest (e.g., DTOs, utilities).
|
|
4
|
-
Packages are written in **TypeScript** and published to the company’s NPM organization.
|
|
5
|
-
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
## Getting Started
|
|
9
|
-
|
|
10
|
-
### 1. Configure NPM registry
|
|
11
|
-
|
|
12
|
-
To authenticate with the NPM registry, configure your `.npmrc` file:
|
|
13
|
-
|
|
14
|
-
```bash
|
|
15
|
-
npm config set //registry.npmjs.org/:_authToken=<your_auth_token>
|
|
16
|
-
```
|
|
17
|
-
|
|
18
|
-
Replace `<your_auth_token>` with a token from [npmjs.com](https://www.npmjs.com/).
|
|
19
|
-
For access to the company’s account, request a token from the administrator.
|
|
20
|
-
|
|
21
|
-
---
|
|
22
|
-
|
|
23
|
-
## Company Packages
|
|
24
|
-
|
|
25
|
-
You can view all published packages here:
|
|
26
|
-
[RoyalInvest NPM Packages](https://www.npmjs.com/settings/royalinvest/packages)
|
|
27
|
-
|
|
28
|
-
---
|
|
29
|
-
|
|
30
|
-
## Creating a New Package
|
|
31
|
-
|
|
32
|
-
1. Create a new directory under `npm-package/`.
|
|
33
|
-
2. Add:
|
|
34
|
-
- `package.json` (copy structure from `dto/package.json`).
|
|
35
|
-
- `tsconfig.json` (same as in existing packages).
|
|
36
|
-
3. Implement your code in `src/`.
|
|
37
|
-
|
|
38
|
-
Each package should follow the same conventions for consistency.
|
|
39
|
-
|
|
40
|
-
---
|
|
41
|
-
|
|
42
|
-
## Building a Package
|
|
43
|
-
|
|
44
|
-
Run the build command inside the package directory:
|
|
45
|
-
|
|
46
|
-
```bash
|
|
47
|
-
npm run build
|
|
48
|
-
```
|
|
49
|
-
|
|
50
|
-
Check the `scripts` section in `dto/package.json` for an example configuration.
|
|
51
|
-
|
|
52
|
-
---
|
|
53
|
-
|
|
54
|
-
## Versioning
|
|
55
|
-
|
|
56
|
-
We follow **Semantic Versioning (SemVer)**:
|
|
57
|
-
|
|
58
|
-
- **MAJOR** – incompatible API changes
|
|
59
|
-
- **MINOR** – add functionality in a backward-compatible manner
|
|
60
|
-
- **PATCH** – backward-compatible bug fixes
|
|
61
|
-
|
|
62
|
-
Update the version number manually in `package.json` before publishing.
|
|
63
|
-
|
|
64
|
-
---
|
|
65
|
-
|
|
66
|
-
## Publishing
|
|
67
|
-
|
|
68
|
-
To publish a package to the NPM registry:
|
|
69
|
-
|
|
70
|
-
```bash
|
|
71
|
-
npm publish --access public
|
|
1
|
+
# NPM Packages
|
|
2
|
+
|
|
3
|
+
This project contains shared **NPM packages** for RoyalInvest (e.g., DTOs, utilities).
|
|
4
|
+
Packages are written in **TypeScript** and published to the company’s NPM organization.
|
|
5
|
+
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## Getting Started
|
|
9
|
+
|
|
10
|
+
### 1. Configure NPM registry
|
|
11
|
+
|
|
12
|
+
To authenticate with the NPM registry, configure your `.npmrc` file:
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
npm config set //registry.npmjs.org/:_authToken=<your_auth_token>
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
Replace `<your_auth_token>` with a token from [npmjs.com](https://www.npmjs.com/).
|
|
19
|
+
For access to the company’s account, request a token from the administrator.
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
## Company Packages
|
|
24
|
+
|
|
25
|
+
You can view all published packages here:
|
|
26
|
+
[RoyalInvest NPM Packages](https://www.npmjs.com/settings/royalinvest/packages)
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
|
|
30
|
+
## Creating a New Package
|
|
31
|
+
|
|
32
|
+
1. Create a new directory under `npm-package/`.
|
|
33
|
+
2. Add:
|
|
34
|
+
- `package.json` (copy structure from `dto/package.json`).
|
|
35
|
+
- `tsconfig.json` (same as in existing packages).
|
|
36
|
+
3. Implement your code in `src/`.
|
|
37
|
+
|
|
38
|
+
Each package should follow the same conventions for consistency.
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
|
|
42
|
+
## Building a Package
|
|
43
|
+
|
|
44
|
+
Run the build command inside the package directory:
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
npm run build
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Check the `scripts` section in `dto/package.json` for an example configuration.
|
|
51
|
+
|
|
52
|
+
---
|
|
53
|
+
|
|
54
|
+
## Versioning
|
|
55
|
+
|
|
56
|
+
We follow **Semantic Versioning (SemVer)**:
|
|
57
|
+
|
|
58
|
+
- **MAJOR** – incompatible API changes
|
|
59
|
+
- **MINOR** – add functionality in a backward-compatible manner
|
|
60
|
+
- **PATCH** – backward-compatible bug fixes
|
|
61
|
+
|
|
62
|
+
Update the version number manually in `package.json` before publishing.
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
|
|
66
|
+
## Publishing
|
|
67
|
+
|
|
68
|
+
To publish a package to the NPM registry:
|
|
69
|
+
|
|
70
|
+
```bash
|
|
71
|
+
npm publish --access public
|
|
72
72
|
```
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export type BillingIntervalType = "month" | "year" | "once";
|
|
@@ -2,6 +2,7 @@ import { IAddress } from "../address";
|
|
|
2
2
|
import { IAnsweredQuestionnaire } from "./screeningQuestionnaireAnswered";
|
|
3
3
|
import { LocaleType } from "../types";
|
|
4
4
|
import { CountryEnum, CurrencyEnum, RentCycleEnum } from "../enum";
|
|
5
|
+
export type TPaymentBy = "landlord" | "tenant";
|
|
5
6
|
export type TBureau = "transunion" | "equifax";
|
|
6
7
|
export type TCreditCheckStatus = "pass" | "fail" | "review" | "not_found";
|
|
7
8
|
export type TCreditScoreTier = "a_plus" | "a" | "b_plus" | "b" | "c_plus" | "c" | "d" | "f";
|
|
@@ -103,6 +104,7 @@ export interface ICreditCheckRequestList {
|
|
|
103
104
|
rent_amount_minor?: string;
|
|
104
105
|
rent_cycle?: RentCycleEnum;
|
|
105
106
|
currency?: CurrencyEnum;
|
|
107
|
+
paid_by?: TPaymentBy;
|
|
106
108
|
}
|
|
107
109
|
export interface ISubjectAddress extends IAddress {
|
|
108
110
|
isCurrent: boolean;
|
|
@@ -123,6 +125,8 @@ export interface ICreditCheckSubjectRequest {
|
|
|
123
125
|
credit_type?: string;
|
|
124
126
|
credit_number?: string;
|
|
125
127
|
addons?: string[];
|
|
128
|
+
paid_by?: TPaymentBy | null;
|
|
129
|
+
credit_bureau?: TBureau | null;
|
|
126
130
|
}
|
|
127
131
|
export interface ICreditCheckConsentRequest {
|
|
128
132
|
credit_check_subject_id: string;
|
|
@@ -159,6 +163,8 @@ export interface ICreditCheckSubjectResponse {
|
|
|
159
163
|
service_type: TScreeningServiceType;
|
|
160
164
|
created_at: Date;
|
|
161
165
|
updated_at: Date;
|
|
166
|
+
paid_by?: TPaymentBy | null;
|
|
167
|
+
credit_bureau?: TBureau | null;
|
|
162
168
|
}
|
|
163
169
|
export interface ICreditCheckResult {
|
|
164
170
|
id: string;
|
|
@@ -269,6 +275,7 @@ export interface ICreditCheckConsentExtendedResponse {
|
|
|
269
275
|
export interface ICreditCheckConsentTenantInfoResponse {
|
|
270
276
|
id: string;
|
|
271
277
|
consent_id: string;
|
|
278
|
+
subject_id: string;
|
|
272
279
|
tenant_first_name: string;
|
|
273
280
|
tenant_last_name: string;
|
|
274
281
|
sender_first_name: string;
|
|
@@ -278,6 +285,8 @@ export interface ICreditCheckConsentTenantInfoResponse {
|
|
|
278
285
|
rental_address: IAddress;
|
|
279
286
|
tenant_email: string;
|
|
280
287
|
user_id?: string;
|
|
288
|
+
paid_by?: TPaymentBy | null;
|
|
289
|
+
credit_bureau?: TBureau | null;
|
|
281
290
|
}
|
|
282
291
|
export interface ICreditCheckReportFileDownload {
|
|
283
292
|
id: string;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export type PaymentIntervalType = "month" | "year";
|
package/dist/payment.js
ADDED
|
File without changes
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
"use strict";
|
|
File without changes
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
"use strict";
|
|
File without changes
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
"use strict";
|
|
File without changes
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
"use strict";
|
package/package.json
CHANGED
|
@@ -1,86 +1,86 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "@royalinvest/dto",
|
|
3
|
-
"version": "0.74.
|
|
4
|
-
"description": "Data Transfer Objects (DTOs) to carry data between frontend and backend processes.",
|
|
5
|
-
"main": "./dist/index.js",
|
|
6
|
-
"types": "./dist/index.d.ts",
|
|
7
|
-
"module": "./dist/index.js",
|
|
8
|
-
"exports": {
|
|
9
|
-
".": {
|
|
10
|
-
"types": "./dist/index.d.ts",
|
|
11
|
-
"require": "./dist/index.js",
|
|
12
|
-
"import": "./dist/index.js"
|
|
13
|
-
},
|
|
14
|
-
"./backend": {
|
|
15
|
-
"types": "./dist/backend.d.ts",
|
|
16
|
-
"require": "./dist/backend.js",
|
|
17
|
-
"import": "./dist/backend.js"
|
|
18
|
-
},
|
|
19
|
-
"./credit-check": {
|
|
20
|
-
"types": "./dist/credit-check/index.d.ts",
|
|
21
|
-
"require": "./dist/credit-check/index.js",
|
|
22
|
-
"import": "./dist/credit-check/index.js"
|
|
23
|
-
},
|
|
24
|
-
"./enum": {
|
|
25
|
-
"types": "./dist/enum/index.d.ts",
|
|
26
|
-
"require": "./dist/enum/index.js",
|
|
27
|
-
"import": "./dist/enum/index.js"
|
|
28
|
-
}
|
|
29
|
-
},
|
|
30
|
-
"repository": {
|
|
31
|
-
"type": "git",
|
|
32
|
-
"url": "git@ssh.dev.azure.com:v3/royalinvest/royalinvest/npm-package"
|
|
33
|
-
},
|
|
34
|
-
"files": [
|
|
35
|
-
"dist"
|
|
36
|
-
],
|
|
37
|
-
"publishConfig": {
|
|
38
|
-
"access": "public"
|
|
39
|
-
},
|
|
40
|
-
"scripts": {
|
|
41
|
-
"build": "npx tsc",
|
|
42
|
-
"lint": "eslint \"src/**/*.{js,jsx,ts,tsx}\"",
|
|
43
|
-
"lint:fix": "eslint --fix \"src/**/*.{js,jsx,ts,tsx}\"",
|
|
44
|
-
"prettier": "prettier --write \"src/**/*.{js,jsx,ts,tsx}\"",
|
|
45
|
-
"prettier:check": "npx prettier --check \"src/**/*.{js,jsx,ts,tsx}\"",
|
|
46
|
-
"clear-all": "rm -rf node_modules .next out dist build",
|
|
47
|
-
"re-start": "rm -rf node_modules .next out dist build && npm install && npm run dev",
|
|
48
|
-
"re-build": "rm -rf node_modules .next out dist build && npm install && npm run build",
|
|
49
|
-
"prepublishOnly": "npm run build",
|
|
50
|
-
"test": "echo \"Not implemented yet\""
|
|
51
|
-
},
|
|
52
|
-
"lint-staged": {
|
|
53
|
-
"src/**/*.{js,jsx,ts,tsx}": [
|
|
54
|
-
"prettier --write",
|
|
55
|
-
"eslint --fix",
|
|
56
|
-
"git add"
|
|
57
|
-
]
|
|
58
|
-
},
|
|
59
|
-
"prettier": {
|
|
60
|
-
"tabWidth": 2,
|
|
61
|
-
"useTabs": false,
|
|
62
|
-
"singleQuote": false,
|
|
63
|
-
"printWidth": 120
|
|
64
|
-
},
|
|
65
|
-
"author": "Samos Technologies Inc.",
|
|
66
|
-
"license": "ISC",
|
|
67
|
-
"devDependencies": {
|
|
68
|
-
"@eslint/js": "^9.11.1",
|
|
69
|
-
"@types/amqplib": "^0.10.6",
|
|
70
|
-
"@types/node": "^24.1.0",
|
|
71
|
-
"eslint": "^9.11.1",
|
|
72
|
-
"eslint-plugin-react": "^7.37.0",
|
|
73
|
-
"globals": "^15.9.0",
|
|
74
|
-
"husky": "^8.0.0",
|
|
75
|
-
"lint-staged": "^15.2.10",
|
|
76
|
-
"prettier": "^3.3.3",
|
|
77
|
-
"typescript-eslint": "^8.7.0"
|
|
78
|
-
},
|
|
79
|
-
"dependencies": {
|
|
80
|
-
"amqplib": "^0.10.3",
|
|
81
|
-
"dayjs": "^1.11.19",
|
|
82
|
-
"pino": "^9.7.0",
|
|
83
|
-
"pino-pretty": "^13.0.0",
|
|
84
|
-
"prom-client": "^15.1.3"
|
|
85
|
-
}
|
|
86
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"name": "@royalinvest/dto",
|
|
3
|
+
"version": "0.74.1",
|
|
4
|
+
"description": "Data Transfer Objects (DTOs) to carry data between frontend and backend processes.",
|
|
5
|
+
"main": "./dist/index.js",
|
|
6
|
+
"types": "./dist/index.d.ts",
|
|
7
|
+
"module": "./dist/index.js",
|
|
8
|
+
"exports": {
|
|
9
|
+
".": {
|
|
10
|
+
"types": "./dist/index.d.ts",
|
|
11
|
+
"require": "./dist/index.js",
|
|
12
|
+
"import": "./dist/index.js"
|
|
13
|
+
},
|
|
14
|
+
"./backend": {
|
|
15
|
+
"types": "./dist/backend.d.ts",
|
|
16
|
+
"require": "./dist/backend.js",
|
|
17
|
+
"import": "./dist/backend.js"
|
|
18
|
+
},
|
|
19
|
+
"./credit-check": {
|
|
20
|
+
"types": "./dist/credit-check/index.d.ts",
|
|
21
|
+
"require": "./dist/credit-check/index.js",
|
|
22
|
+
"import": "./dist/credit-check/index.js"
|
|
23
|
+
},
|
|
24
|
+
"./enum": {
|
|
25
|
+
"types": "./dist/enum/index.d.ts",
|
|
26
|
+
"require": "./dist/enum/index.js",
|
|
27
|
+
"import": "./dist/enum/index.js"
|
|
28
|
+
}
|
|
29
|
+
},
|
|
30
|
+
"repository": {
|
|
31
|
+
"type": "git",
|
|
32
|
+
"url": "git@ssh.dev.azure.com:v3/royalinvest/royalinvest/npm-package"
|
|
33
|
+
},
|
|
34
|
+
"files": [
|
|
35
|
+
"dist"
|
|
36
|
+
],
|
|
37
|
+
"publishConfig": {
|
|
38
|
+
"access": "public"
|
|
39
|
+
},
|
|
40
|
+
"scripts": {
|
|
41
|
+
"build": "npx tsc",
|
|
42
|
+
"lint": "eslint \"src/**/*.{js,jsx,ts,tsx}\"",
|
|
43
|
+
"lint:fix": "eslint --fix \"src/**/*.{js,jsx,ts,tsx}\"",
|
|
44
|
+
"prettier": "prettier --write \"src/**/*.{js,jsx,ts,tsx}\"",
|
|
45
|
+
"prettier:check": "npx prettier --check \"src/**/*.{js,jsx,ts,tsx}\"",
|
|
46
|
+
"clear-all": "rm -rf node_modules .next out dist build",
|
|
47
|
+
"re-start": "rm -rf node_modules .next out dist build && npm install && npm run dev",
|
|
48
|
+
"re-build": "rm -rf node_modules .next out dist build && npm install && npm run build",
|
|
49
|
+
"prepublishOnly": "npm run build",
|
|
50
|
+
"test": "echo \"Not implemented yet\""
|
|
51
|
+
},
|
|
52
|
+
"lint-staged": {
|
|
53
|
+
"src/**/*.{js,jsx,ts,tsx}": [
|
|
54
|
+
"prettier --write",
|
|
55
|
+
"eslint --fix",
|
|
56
|
+
"git add"
|
|
57
|
+
]
|
|
58
|
+
},
|
|
59
|
+
"prettier": {
|
|
60
|
+
"tabWidth": 2,
|
|
61
|
+
"useTabs": false,
|
|
62
|
+
"singleQuote": false,
|
|
63
|
+
"printWidth": 120
|
|
64
|
+
},
|
|
65
|
+
"author": "Samos Technologies Inc.",
|
|
66
|
+
"license": "ISC",
|
|
67
|
+
"devDependencies": {
|
|
68
|
+
"@eslint/js": "^9.11.1",
|
|
69
|
+
"@types/amqplib": "^0.10.6",
|
|
70
|
+
"@types/node": "^24.1.0",
|
|
71
|
+
"eslint": "^9.11.1",
|
|
72
|
+
"eslint-plugin-react": "^7.37.0",
|
|
73
|
+
"globals": "^15.9.0",
|
|
74
|
+
"husky": "^8.0.0",
|
|
75
|
+
"lint-staged": "^15.2.10",
|
|
76
|
+
"prettier": "^3.3.3",
|
|
77
|
+
"typescript-eslint": "^8.7.0"
|
|
78
|
+
},
|
|
79
|
+
"dependencies": {
|
|
80
|
+
"amqplib": "^0.10.3",
|
|
81
|
+
"dayjs": "^1.11.19",
|
|
82
|
+
"pino": "^9.7.0",
|
|
83
|
+
"pino-pretty": "^13.0.0",
|
|
84
|
+
"prom-client": "^15.1.3"
|
|
85
|
+
}
|
|
86
|
+
}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export type UILanguage = "en" | "fr" | "de" | "es" | "nl";
|
|
File without changes
|