jamespot-front-business 1.0.3 → 1.1.3
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/CHANGELOG.md +24 -0
- package/README-internal.md +67 -0
- package/README.md +15 -50
- package/dist/cjs.js +492 -19
- package/dist/cjs.js.map +1 -1
- package/dist/esm.js +486 -17
- package/dist/esm.js.map +1 -1
- package/dist/types.d.ts +357 -28
- package/package.json +50 -49
- package/tsconfig.json +15 -5
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,29 @@
|
|
|
1
1
|
# jamespot-front-business
|
|
2
2
|
|
|
3
|
+
## 1.1.3
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- bump
|
|
8
|
+
|
|
9
|
+
## 1.1.2
|
|
10
|
+
|
|
11
|
+
### Patch Changes
|
|
12
|
+
|
|
13
|
+
- jLand - fix mock
|
|
14
|
+
|
|
15
|
+
## 1.1.1
|
|
16
|
+
|
|
17
|
+
### Patch Changes
|
|
18
|
+
|
|
19
|
+
- jland maps with licenses
|
|
20
|
+
|
|
21
|
+
## 1.1.0
|
|
22
|
+
|
|
23
|
+
### Minor Changes
|
|
24
|
+
|
|
25
|
+
- Public
|
|
26
|
+
|
|
3
27
|
## 1.0.3
|
|
4
28
|
|
|
5
29
|
### Patch Changes
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# Typescript utils for use within the Jamespot ecosystem
|
|
2
|
+
|
|
3
|
+
## Use in another package
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
# install from npm
|
|
7
|
+
npm i --save jamespot-front-business
|
|
8
|
+
|
|
9
|
+
# install from a local folder
|
|
10
|
+
npm i --save ../jamespot-front-business
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Main commands
|
|
14
|
+
|
|
15
|
+
```
|
|
16
|
+
# install
|
|
17
|
+
git clone https://github.com/Jamespot/jamespot-front-business.git
|
|
18
|
+
pnpm i
|
|
19
|
+
|
|
20
|
+
# build
|
|
21
|
+
pnpm run build
|
|
22
|
+
|
|
23
|
+
# format with prettier
|
|
24
|
+
pnpm run format
|
|
25
|
+
|
|
26
|
+
# check linting issues
|
|
27
|
+
pnpm lint
|
|
28
|
+
|
|
29
|
+
# test with jest
|
|
30
|
+
pnpm test
|
|
31
|
+
|
|
32
|
+
# test one file
|
|
33
|
+
pnpm test:one -- <path>
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
# Test and Coverage
|
|
37
|
+
|
|
38
|
+
You can find information in coverage directory and browse file to find uncovered line
|
|
39
|
+
[link](.\coverage\lcov-report\index.html)
|
|
40
|
+
|
|
41
|
+
## versions
|
|
42
|
+
|
|
43
|
+
We use changeset to generate a changelog & bump the version in the package.json
|
|
44
|
+
|
|
45
|
+
```
|
|
46
|
+
# add a changelog entry for a branch / PR / feature
|
|
47
|
+
pnpm changeset
|
|
48
|
+
|
|
49
|
+
# generate the changelog & bump the version
|
|
50
|
+
pnpm changeset version
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
## release
|
|
54
|
+
|
|
55
|
+
To release a new version, execute the following commands:
|
|
56
|
+
|
|
57
|
+
```
|
|
58
|
+
git checkout master
|
|
59
|
+
git pull
|
|
60
|
+
git checkout develop
|
|
61
|
+
git pull
|
|
62
|
+
pnpm changeset version
|
|
63
|
+
pnpm changeset tag
|
|
64
|
+
git add .
|
|
65
|
+
git commit -m "prepare version XYZ"
|
|
66
|
+
git push --follow-tags
|
|
67
|
+
```
|
package/README.md
CHANGED
|
@@ -1,59 +1,24 @@
|
|
|
1
|
-
#
|
|
1
|
+
# JamespotFrontBusiness
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
This project contains features shared across Jamespot Fronts (Mobile/Desktop)
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
# install from npm
|
|
7
|
-
npm i --save jamespot-front-business
|
|
8
|
-
|
|
9
|
-
# install from a local folder
|
|
10
|
-
npm i --save ../jamespot-front-business
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
## Main commands
|
|
5
|
+
You can access all redux-toolkit slice, actions, selectors.
|
|
14
6
|
|
|
15
|
-
|
|
16
|
-
# install
|
|
17
|
-
git clone https://github.com/Jamespot/jamespot-front-business.git
|
|
18
|
-
pnpm i
|
|
19
|
-
|
|
20
|
-
# build
|
|
21
|
-
pnpm run build
|
|
7
|
+
## How to use
|
|
22
8
|
|
|
23
|
-
|
|
24
|
-
|
|
9
|
+
```jsx
|
|
10
|
+
import React, { useEffect } from 'react';
|
|
11
|
+
import { useDispatch, useSelector } from 'react-redux';
|
|
25
12
|
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
# test with jest
|
|
30
|
-
pnpm test
|
|
31
|
-
```
|
|
13
|
+
const component = () => {
|
|
14
|
+
const dispatch = useDispatch();
|
|
15
|
+
const list = useSelector(AssetReservation.selectors.bookableAssetEntities);
|
|
32
16
|
|
|
33
|
-
|
|
17
|
+
useEffect(() => {
|
|
18
|
+
dispatch(AssetReservation.actions.fetchBookableAsset());
|
|
19
|
+
}, [dispatch]);
|
|
34
20
|
|
|
35
|
-
|
|
21
|
+
return <></>;
|
|
22
|
+
}
|
|
36
23
|
|
|
37
24
|
```
|
|
38
|
-
# add a changelog entry for a branch / PR / feature
|
|
39
|
-
pnpm changeset
|
|
40
|
-
|
|
41
|
-
# generate the changelog & bump the version
|
|
42
|
-
pnpm changeset version
|
|
43
|
-
```
|
|
44
|
-
|
|
45
|
-
## release
|
|
46
|
-
|
|
47
|
-
To release a new version, execute the following commands:
|
|
48
|
-
|
|
49
|
-
```
|
|
50
|
-
git checkout master
|
|
51
|
-
git pull
|
|
52
|
-
git checkout develop
|
|
53
|
-
git pull
|
|
54
|
-
pnpm changeset version
|
|
55
|
-
pnpm changeset tag
|
|
56
|
-
git add .
|
|
57
|
-
git commit -m "prepare version XYZ"
|
|
58
|
-
git push --follow-tags
|
|
59
|
-
```
|