@findhotel/sapi 1.14.6-beta.0 → 1.15.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 +25 -1
- package/dist/index.js +1 -1
- package/dist/types/packages/core/src/types/rooms.d.ts +5 -0
- package/package.json +1 -1
- package/dist/index.js.map +0 -1
package/README.md
CHANGED
|
@@ -9,11 +9,13 @@ hotels, hotels\' offers and rooms.
|
|
|
9
9
|
- [Table of contents](#table-of-contents)
|
|
10
10
|
- [Release process](#release-process)
|
|
11
11
|
- [GitHub Token](#github-token)
|
|
12
|
+
- [NPM Registry](#npm-registry)
|
|
12
13
|
- [New release](#new-release)
|
|
13
14
|
- [New release from a development branch](#new-release-from-a-development-branch)
|
|
14
15
|
- [Tutorials](#tutorials)
|
|
15
16
|
- [Getting Started](#getting-started)
|
|
16
17
|
- [React Native](#react-native)
|
|
18
|
+
- [Playground](#playground)
|
|
17
19
|
- [Usage](#usage)
|
|
18
20
|
- [Search](#search)
|
|
19
21
|
- [Get hotel's rooms offers](#get-hotels-rooms-offers)
|
|
@@ -77,6 +79,14 @@ creates a PR before publishing every release, so this allows:
|
|
|
77
79
|
- Edit the automatically generated changelog for clarity &
|
|
78
80
|
readability.
|
|
79
81
|
|
|
82
|
+
## NPM Registry
|
|
83
|
+
|
|
84
|
+
NPM account is required for pre-release (beta) process:
|
|
85
|
+
|
|
86
|
+
- Go to [NPM sign up](https://www.npmjs.com/signup)
|
|
87
|
+
- Create an account and ask SAPI to give you access to organization
|
|
88
|
+
- Activate your Two Factor Authentication using Authenticator/1Password
|
|
89
|
+
|
|
80
90
|
## GitHub Token
|
|
81
91
|
|
|
82
92
|
GitHub token is required for the release process:
|
|
@@ -116,7 +126,6 @@ Sometimes You might want to test your changes on the website for example on the
|
|
|
116
126
|
Pre-release publishes a new version to NPM with a tag other than `latest` (the default tag).
|
|
117
127
|
To publish a pre-release please follow the next steps:
|
|
118
128
|
|
|
119
|
-
- commit your changes to your development branch
|
|
120
129
|
- build SAPI SDK from the root of the project:
|
|
121
130
|
```sh
|
|
122
131
|
make core-build
|
|
@@ -143,6 +152,8 @@ To publish a pre-release please follow the next steps:
|
|
|
143
152
|
npm publish --tag=next
|
|
144
153
|
```
|
|
145
154
|
|
|
155
|
+
During the publish you'll asked to login/enter your OTP (Two Factor Auth Code) which you can access it using Authenticator/1Password app (for more information read [here](#npm-registry))
|
|
156
|
+
|
|
146
157
|
- after the new version is published to npm, install it to your local environment specifying the new version:
|
|
147
158
|
|
|
148
159
|
```sh
|
|
@@ -195,6 +206,19 @@ consumer side. We recommend installing just
|
|
|
195
206
|
`crypto` methods. More information about polyfill can be
|
|
196
207
|
found [here](https://www.npmjs.com/package/react-native-get-random-values)
|
|
197
208
|
|
|
209
|
+
## Playground
|
|
210
|
+
Playground is a local environment for checking your changes and test if the implementations were correct you can access this environment locally (http://localhost:3000) by opening two terminals and running these commands in order
|
|
211
|
+
|
|
212
|
+
```bash
|
|
213
|
+
# watch your changes to core and create a new bundle
|
|
214
|
+
make core-dev
|
|
215
|
+
```
|
|
216
|
+
|
|
217
|
+
```bash
|
|
218
|
+
# runs the playground on http://localhost:3000
|
|
219
|
+
make playground-run
|
|
220
|
+
```
|
|
221
|
+
|
|
198
222
|
## Usage
|
|
199
223
|
|
|
200
224
|
### Search
|