oro-sdk 2.3.0 → 2.5.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/LICENSE +21 -0
- package/README.md +26 -0
- package/package.json +1 -1
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2021 ORO Health Inc.
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -11,6 +11,7 @@ ORO SDK package is intended to be run in browser only. It contains everything ne
|
|
|
11
11
|
## Local development
|
|
12
12
|
|
|
13
13
|
> If you cannot see Jest types try opening this folder in a seperate VSCode window.
|
|
14
|
+
|
|
14
15
|
### Set up project
|
|
15
16
|
|
|
16
17
|
```bash
|
|
@@ -29,6 +30,7 @@ npm build # build
|
|
|
29
30
|
#### First you need to publish locally the `oro-sdk`
|
|
30
31
|
|
|
31
32
|
Two cases are possible:
|
|
33
|
+
|
|
32
34
|
1. You are updating `oro-apis/sdk/ts`:
|
|
33
35
|
|
|
34
36
|
In **`oro-apis/sdk/ts`**:
|
|
@@ -37,6 +39,7 @@ Two cases are possible:
|
|
|
37
39
|
npm install
|
|
38
40
|
npm run link:watch
|
|
39
41
|
```
|
|
42
|
+
|
|
40
43
|
2. You are updating `oro-apis/sdk/apis`:
|
|
41
44
|
|
|
42
45
|
In **`oro-apis/sdk/apis`**:
|
|
@@ -62,3 +65,26 @@ In **`oro-apps/web`**:
|
|
|
62
65
|
npm uninstall oro-sdk # optional
|
|
63
66
|
npm run dev:link
|
|
64
67
|
```
|
|
68
|
+
|
|
69
|
+
### Publishing package
|
|
70
|
+
|
|
71
|
+
1. (Only first time) Locally run `npm login` and use the creds in 1password (tech-team-oro) . This will create ~/.npmrc . You will require a OTP but it's sent on tech@orohealth.me so you should all have it.
|
|
72
|
+
2. Run `docker-compose up --build sdk-publisher`
|
|
73
|
+
|
|
74
|
+
#### Versioning of `oro-sdk` and `oro-sdk-apis`
|
|
75
|
+
|
|
76
|
+
As `oro-sdk-apis` is a dependency of `oro-sdk`, if you do some changes on `oro-sdk-apis` you will need to update `oro-sdk` and web app as well.
|
|
77
|
+
|
|
78
|
+
The versionning should be the same for `oro-sdk-apis` and `oro-sdk`. In other words, as we are using semantic versioning if we update patch/minor/major version of `oro-sdk-apis` we must update the same on `oro-sdk`.
|
|
79
|
+
|
|
80
|
+
>Example:
|
|
81
|
+
>
|
|
82
|
+
>I want to update the minor version of `oro-sdk-apis`: 1.2.5 -> 1.3.0
|
|
83
|
+
>
|
|
84
|
+
>Then I also need to update `package.json` of `oro-sdk` with the dependency `oro-sdk-apis@1.3.0` and I update the minor version of `oro-sdk`: 2.3.2 -> 2.4.0
|
|
85
|
+
|
|
86
|
+
You then need to publish packages in following order: `oro-sdk-apis`, `oro-sdk`:
|
|
87
|
+
|
|
88
|
+
Then, you update web app dependencies with `oro-sdk@2.4.0`
|
|
89
|
+
|
|
90
|
+
Done.
|
package/package.json
CHANGED