@royalinvest/dto 0.22.14 → 0.23.0
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 +41 -0
- package/dist/auth.d.ts +4 -0
- package/dist/enum/index.js +10 -10
- package/dist/lease-details.d.ts +2 -0
- package/dist/leaseSaveTypeEnum.js +1 -1
- package/dist/notification.d.ts +0 -2
- package/package.json +32 -4
- package/dist/quebec-lease-dwelling/addendum.d.ts +0 -3
- package/dist/quebec-lease-dwelling/addendum.js +0 -2
- package/readMe.md +0 -1
package/README.md
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# How to Contribute to NPM Packages
|
|
2
|
+
|
|
3
|
+
## Configuring the Remote URL
|
|
4
|
+
|
|
5
|
+
To configure the remote NPM registry URL, use the following command:
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
Replace `<your_auth_token>` with the token generated from the NPM website.
|
|
9
|
+
|
|
10
|
+
## Access Token
|
|
11
|
+
|
|
12
|
+
You can generate the `_authToken` by visiting [npmjs.com](https://www.npmjs.com/).
|
|
13
|
+
For access to the company's NPM account, contact the administrator to either request a token or obtain access to generate a new one.
|
|
14
|
+
|
|
15
|
+
## NPM Packages
|
|
16
|
+
|
|
17
|
+
You can view the company's public NPM packages here:
|
|
18
|
+
[Company NPM Packages](https://www.npmjs.com/settings/royalinvest/packages)
|
|
19
|
+
|
|
20
|
+
## Creating a New Package
|
|
21
|
+
|
|
22
|
+
To create a new NPM package:
|
|
23
|
+
- Add a new directory.
|
|
24
|
+
- Ensure that it includes the same `tsconfig.json` and `package.json` configuration as found in the `dto` package.
|
|
25
|
+
|
|
26
|
+
## Building the NPM Package
|
|
27
|
+
|
|
28
|
+
To build the NPM package, run the following command. Refer to `dto/package.json` for configuration details:
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
## Versioning a Package
|
|
32
|
+
|
|
33
|
+
Follow Semantic Versioning (SemVer) standards for package versioning.
|
|
34
|
+
Versioning should be updated manually by modifying the version number in the `package.json` file.
|
|
35
|
+
|
|
36
|
+
## Publishing a Package
|
|
37
|
+
|
|
38
|
+
Use the following command to publish a new package:
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
The current scope is set to `public` by default in the `package.json` file, making all packages publicly accessible.
|
package/dist/auth.d.ts
CHANGED
package/dist/enum/index.js
CHANGED
|
@@ -8,13 +8,13 @@ var PartyTypeEnum;
|
|
|
8
8
|
PartyTypeEnum["lessee"] = "lessee";
|
|
9
9
|
PartyTypeEnum["coSigner"] = "coSigner";
|
|
10
10
|
PartyTypeEnum["spouse"] = "spouse";
|
|
11
|
-
})(PartyTypeEnum
|
|
11
|
+
})(PartyTypeEnum || (exports.PartyTypeEnum = PartyTypeEnum = {}));
|
|
12
12
|
var RentTypeEnum;
|
|
13
13
|
(function (RentTypeEnum) {
|
|
14
14
|
RentTypeEnum["default"] = "";
|
|
15
15
|
RentTypeEnum["fixed"] = "fixed";
|
|
16
16
|
RentTypeEnum["indeterminate"] = "indeterminate";
|
|
17
|
-
})(RentTypeEnum
|
|
17
|
+
})(RentTypeEnum || (exports.RentTypeEnum = RentTypeEnum = {}));
|
|
18
18
|
var LeaseStatusEnum;
|
|
19
19
|
(function (LeaseStatusEnum) {
|
|
20
20
|
LeaseStatusEnum["Default"] = "";
|
|
@@ -25,12 +25,12 @@ var LeaseStatusEnum;
|
|
|
25
25
|
LeaseStatusEnum["Signed"] = "signed";
|
|
26
26
|
LeaseStatusEnum["PendingSignature"] = "pendingSignature";
|
|
27
27
|
LeaseStatusEnum["Cancelled"] = "cancelled";
|
|
28
|
-
})(LeaseStatusEnum
|
|
28
|
+
})(LeaseStatusEnum || (exports.LeaseStatusEnum = LeaseStatusEnum = {}));
|
|
29
29
|
var SignatureType;
|
|
30
30
|
(function (SignatureType) {
|
|
31
31
|
SignatureType["initials"] = "initials";
|
|
32
32
|
SignatureType["signature"] = "signature";
|
|
33
|
-
})(SignatureType
|
|
33
|
+
})(SignatureType || (exports.SignatureType = SignatureType = {}));
|
|
34
34
|
var SignStatusEnum;
|
|
35
35
|
(function (SignStatusEnum) {
|
|
36
36
|
SignStatusEnum["notSigned"] = "notSigned";
|
|
@@ -38,31 +38,31 @@ var SignStatusEnum;
|
|
|
38
38
|
SignStatusEnum["signed"] = "signed";
|
|
39
39
|
SignStatusEnum["cancelled"] = "cancelled";
|
|
40
40
|
SignStatusEnum["signaturePending"] = "signaturePending";
|
|
41
|
-
})(SignStatusEnum
|
|
41
|
+
})(SignStatusEnum || (exports.SignStatusEnum = SignStatusEnum = {}));
|
|
42
42
|
var NotificationTypeEnum;
|
|
43
43
|
(function (NotificationTypeEnum) {
|
|
44
44
|
NotificationTypeEnum["documentReady"] = "document_ready";
|
|
45
45
|
NotificationTypeEnum["documentSigned"] = "document_signed";
|
|
46
|
-
})(NotificationTypeEnum
|
|
46
|
+
})(NotificationTypeEnum || (exports.NotificationTypeEnum = NotificationTypeEnum = {}));
|
|
47
47
|
var SignActionEnum;
|
|
48
48
|
(function (SignActionEnum) {
|
|
49
49
|
SignActionEnum["viewed"] = "viewed";
|
|
50
50
|
SignActionEnum["cancelled"] = "cancelled";
|
|
51
51
|
SignActionEnum["sentInvitation"] = "sentInvitation";
|
|
52
52
|
SignActionEnum["signed"] = "signed";
|
|
53
|
-
})(SignActionEnum
|
|
53
|
+
})(SignActionEnum || (exports.SignActionEnum = SignActionEnum = {}));
|
|
54
54
|
var SignatureDateTypeEnum;
|
|
55
55
|
(function (SignatureDateTypeEnum) {
|
|
56
56
|
SignatureDateTypeEnum["equalDayMonthYearBoxes"] = "equalDayMonthYearBoxes";
|
|
57
|
-
})(SignatureDateTypeEnum
|
|
57
|
+
})(SignatureDateTypeEnum || (exports.SignatureDateTypeEnum = SignatureDateTypeEnum = {}));
|
|
58
58
|
var LeaseNoticeTypeEnum;
|
|
59
59
|
(function (LeaseNoticeTypeEnum) {
|
|
60
60
|
LeaseNoticeTypeEnum["Modification"] = "modification";
|
|
61
61
|
LeaseNoticeTypeEnum["Repossessing"] = "repossessing";
|
|
62
62
|
LeaseNoticeTypeEnum["Eviction"] = "eviction";
|
|
63
|
-
})(LeaseNoticeTypeEnum
|
|
63
|
+
})(LeaseNoticeTypeEnum || (exports.LeaseNoticeTypeEnum = LeaseNoticeTypeEnum = {}));
|
|
64
64
|
var LeaseTypeEnum;
|
|
65
65
|
(function (LeaseTypeEnum) {
|
|
66
66
|
LeaseTypeEnum["LeaseOfDwelling"] = "LeaseOfDwelling";
|
|
67
67
|
LeaseTypeEnum["LeaseOfDwellingNotice"] = "LeaseOfDwellingNotice";
|
|
68
|
-
})(LeaseTypeEnum
|
|
68
|
+
})(LeaseTypeEnum || (exports.LeaseTypeEnum = LeaseTypeEnum = {}));
|
package/dist/lease-details.d.ts
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { LeaseTypeEnum } from "./enum";
|
|
1
2
|
import { IFile } from "./file";
|
|
2
3
|
import { IParty } from "./party";
|
|
3
4
|
export interface ILeaseDetails {
|
|
@@ -10,4 +11,5 @@ export interface ILeaseDetails {
|
|
|
10
11
|
status: string;
|
|
11
12
|
files: IFile[];
|
|
12
13
|
parties: IParty[];
|
|
14
|
+
lease_type: LeaseTypeEnum;
|
|
13
15
|
}
|
|
@@ -7,4 +7,4 @@ var LeaseSaveTypeEnum;
|
|
|
7
7
|
LeaseSaveTypeEnum["SaveAsDraft"] = "SaveAsDraft";
|
|
8
8
|
LeaseSaveTypeEnum["SaveAndPublish"] = "SaveAndPublish";
|
|
9
9
|
LeaseSaveTypeEnum["UpdateAndPublish"] = "UpdateAndPublish";
|
|
10
|
-
})(LeaseSaveTypeEnum
|
|
10
|
+
})(LeaseSaveTypeEnum || (exports.LeaseSaveTypeEnum = LeaseSaveTypeEnum = {}));
|
package/dist/notification.d.ts
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@royalinvest/dto",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.23.0",
|
|
4
4
|
"description": "Data Transfer Objects (DTOs) to carry data between frontend and backend processes.",
|
|
5
5
|
"main": "./src/index.ts",
|
|
6
6
|
"types": "./dist/index.d.ts",
|
|
@@ -23,10 +23,38 @@
|
|
|
23
23
|
},
|
|
24
24
|
"scripts": {
|
|
25
25
|
"build": "npx tsc",
|
|
26
|
-
"
|
|
27
|
-
"
|
|
26
|
+
"lint": "eslint \"src/**/*.{js,jsx,ts,tsx}\"",
|
|
27
|
+
"lint:fix": "eslint --fix \"src/**/*.{js,jsx,ts,tsx}\"",
|
|
28
|
+
"prettier": "prettier --write \"src/**/*.{js,jsx,ts,tsx}\"",
|
|
29
|
+
"prettier:check": "npx prettier --check \"src/**/*.{js,jsx,ts,tsx}\"",
|
|
30
|
+
"clear-all": "rm -rf node_modules .next out dist build",
|
|
31
|
+
"re-start": "rm -rf node_modules .next out dist build && npm install && npm run dev",
|
|
32
|
+
"re-build": "rm -rf node_modules .next out dist build && npm install && npm run build",
|
|
33
|
+
"test": "echo \"Not implemented yet\""
|
|
34
|
+
},
|
|
35
|
+
"lint-staged": {
|
|
36
|
+
"src/**/*.{js,jsx,ts,tsx}": [
|
|
37
|
+
"prettier --write",
|
|
38
|
+
"eslint --fix",
|
|
39
|
+
"git add"
|
|
40
|
+
]
|
|
41
|
+
},
|
|
42
|
+
"prettier": {
|
|
43
|
+
"tabWidth": 2,
|
|
44
|
+
"useTabs": false,
|
|
45
|
+
"singleQuote": false,
|
|
46
|
+
"printWidth": 120
|
|
28
47
|
},
|
|
29
48
|
"author": "Samos Technologies Inc.",
|
|
30
49
|
"license": "ISC",
|
|
31
|
-
"
|
|
50
|
+
"devDependencies": {
|
|
51
|
+
"@eslint/js": "^9.11.1",
|
|
52
|
+
"eslint": "^9.11.1",
|
|
53
|
+
"eslint-plugin-react": "^7.37.0",
|
|
54
|
+
"globals": "^15.9.0",
|
|
55
|
+
"husky": "^8.0.0",
|
|
56
|
+
"lint-staged": "^15.2.10",
|
|
57
|
+
"prettier": "^3.3.3",
|
|
58
|
+
"typescript-eslint": "^8.7.0"
|
|
59
|
+
}
|
|
32
60
|
}
|
package/readMe.md
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
# This is Royal Invest DTO package to share data between frontend and backend processes.
|