@sitecore/sc-contenthub-webclient-sdk 1.2.12 → 1.2.14

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.
Files changed (2) hide show
  1. package/README.md +17 -35
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,49 +1,31 @@
1
1
  # Sitecore Content Hub WebClient JS SDK
2
2
 
3
- Sitecore Content Hub WebClient JS SDK, which is a lightweight JS client for Sitecore Content Hub.
3
+ Lightweight JS client for [Sitecore Content Hub](https://doc.sitecore.com/ch/en/developers/cloud-dev/index-en.html).
4
4
 
5
- ## Internal resources
5
+ Environment
6
6
 
7
- - [Backlog](https://stylelabs.atlassian.net/secure/RapidBoard.jspa?rapidView=347&projectKey=ONSJSSDK&view=planning.nodetail&issueLimit=100)
8
- - Slack: #ch-devex-questions
7
+ - Node.js
9
8
 
10
- ## Release process
9
+ Language level
11
10
 
12
- There are currently three build configurations that are specified in `bitbucket-pipelines.yml`
11
+ - ES6
12
+ - ESNext
13
13
 
14
- - A basic build runs each time a pull request is created or updated. This is to ensure that all unit tests are passing before committing any code to `master`.
15
- - Once a pull request has been completed and the code is merged to `master`, an internal build is triggered automatically.
16
- - Public releases can be created by tagging a commit with the following: `release-<major>.<minor>.<patch>` (e.g `release-1.0.0`). Upon a successful build all artifacts are pushed to the public channels.
14
+ Module system
17
15
 
18
- ### To Release
16
+ - CommonJS
17
+ - ESNext
19
18
 
20
- - Add new release tag, `release-<major>.<minor>.<patch>`.
21
- - Trigger a release build to publish final artifacts to the partners feed.
22
- - Cut the release branch, `release\<major>.<minor>.x`.
23
- - Update the Changelog in Documentation repository.
24
- - Update Content Hub repository with new official released version.
25
- - Bump version for the next release.
19
+ ## Installing
26
20
 
27
- ## Documentation
28
-
29
- [Stylelabs.M.Docs reporitory](https://bitbucket.org/stylelabsdev/stylelabs.m.docs/src/master/docfx-website/content/4.0.x/integrations/javascript-sdk/)
30
-
31
- _NOTE: There are multiple paths for various versions that need to be updated independently._
32
-
33
- ## Dev test configuration
21
+ ```bash
22
+ npm install @sitecore/sc-contenthub-webclient-sdk
23
+ ```
34
24
 
35
- Some tests require an instance of ContentHub and a configuration to run.
25
+ ## Documentation
36
26
 
37
- 1. Create a .env file in project root.
38
- 1. Configure an OAuth client in `<path-to-contenthub>/en-us/admin/oauthclients`.
27
+ - [Sitecore Content Hub](https://doc.sitecore.com/ch/en/developers/cloud-dev/index-en.html)
39
28
 
40
- Example .env config:
29
+ - [Sitecore Content Hub SDKs](https://doc.sitecore.com/ch/en/developers/cloud-dev/javascript-sdk.html)
41
30
 
42
- ```
43
- ENDPOINT=https://localhost:5001
44
- OAUTH_CLIENT_ID=jssdk
45
- OAUTH_CLIENT_SECRET=testsecret
46
- USER_NAME=Administrator
47
- USER_PASSWORD=admin
48
- IGNORE_HTTPS_ERRORS=true
49
- ```
31
+ _NOTE: There are multiple paths for various versions._
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sitecore/sc-contenthub-webclient-sdk",
3
- "version": "1.2.12",
3
+ "version": "1.2.14",
4
4
  "description": "Sitecore Content Hub WebClient SDK.",
5
5
  "scripts": {
6
6
  "build": "npm run clean && npm run test && tsc && npm run lint",