senza-sdk 3.19.5 → 3.19.6
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 +0 -128
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,128 +0,0 @@
|
|
|
1
|
-
<p align="center">
|
|
2
|
-
<h1 align="center">Senza - SDK</h1>
|
|
3
|
-
<p align="center">
|
|
4
|
-
|
|
5
|
-
# Installation
|
|
6
|
-
|
|
7
|
-
### Step 1:
|
|
8
|
-
|
|
9
|
-
Create a file called .npmrc / .yarnrc in your project and add the below line.
|
|
10
|
-
|
|
11
|
-
`"@ip-synamedia:registry=https://artifactory01.engit.synamedia.com/artifactory/api/npm/spvss-cloud-ci-npm/"`
|
|
12
|
-
|
|
13
|
-
### Step 2:
|
|
14
|
-
|
|
15
|
-
This library can be installed using npm/yarn with the below commands.
|
|
16
|
-
|
|
17
|
-
- npm: `npm install @ip-synamedia/hs-sdk --save`
|
|
18
|
-
- yarn: `yarn add @ip-synamedia/hs-sdk`
|
|
19
|
-
|
|
20
|
-
# Usage
|
|
21
|
-
|
|
22
|
-
Import and use required logic.
|
|
23
|
-
|
|
24
|
-
# Local Usage and Debugging
|
|
25
|
-
|
|
26
|
-
You can point your importing project to use your local code of this repo by creating an NPM link :
|
|
27
|
-
1. In this root of this project run:
|
|
28
|
-
first install dependencies
|
|
29
|
-
```bash
|
|
30
|
-
npm install OR yarn
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
```bash
|
|
35
|
-
npm link
|
|
36
|
-
```
|
|
37
|
-
OR
|
|
38
|
-
```bash
|
|
39
|
-
yarn link
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
Then in your importing project who uses this repo run:
|
|
43
|
-
```bash
|
|
44
|
-
npm link @ip-synamedia/hs-sdk
|
|
45
|
-
```
|
|
46
|
-
OR
|
|
47
|
-
```bash
|
|
48
|
-
yarn link "@ip-synamedia/hs-sdk"
|
|
49
|
-
```
|
|
50
|
-
It will now use the code on your local machine.
|
|
51
|
-
|
|
52
|
-
```
|
|
53
|
-
import { init } from '@ip-synamedia/hs-sdk/dist/api';
|
|
54
|
-
|
|
55
|
-
init();
|
|
56
|
-
```
|
|
57
|
-
|
|
58
|
-
# Contribute to the Library
|
|
59
|
-
|
|
60
|
-
### Step 1:
|
|
61
|
-
|
|
62
|
-
Navigate to `src/`
|
|
63
|
-
|
|
64
|
-
### Step 2:
|
|
65
|
-
|
|
66
|
-
Contribute your code
|
|
67
|
-
|
|
68
|
-
### Step 3:
|
|
69
|
-
|
|
70
|
-
Navigate to `src/api.js` and export your contribution (if needed)
|
|
71
|
-
|
|
72
|
-
### Step 4:
|
|
73
|
-
|
|
74
|
-
Upgrade version in `package.json` and `package-lock.json`
|
|
75
|
-
|
|
76
|
-
### Step 5:
|
|
77
|
-
|
|
78
|
-
Add the new version to `CHANGELOG.md`. Make sure to follow the existing format (as described in [KeepAChangeLog](https://keepachangelog.com/en/1.0.0/)).
|
|
79
|
-
|
|
80
|
-
# Create docs
|
|
81
|
-
Edit jsdocs in the relevant file and then run the following command for the updated file:
|
|
82
|
-
```bash
|
|
83
|
-
./node_modules/jsdoc-to-markdown/bin/cli.js src/remotePlayer.js
|
|
84
|
-
./node_modules/jsdoc-to-markdown/bin/cli.js src/api.js
|
|
85
|
-
```
|
|
86
|
-
Copy the output of jsdoc-to-markdown (from standard output) and paste it in the relevant page under https://dash.readme.com/project/hyperscale/v1.0/docs/web-app-changes
|
|
87
|
-
(replace the content starting from ## Modules).
|
|
88
|
-
|
|
89
|
-
<p align="center">
|
|
90
|
-
<h1 align="center">SampleApp - DefaultUI</h1>
|
|
91
|
-
<p align="center">
|
|
92
|
-
|
|
93
|
-
It's /samples/remotePlayer-startPlayback App. This App is used as a default UI App for tenant vending through matisse.
|
|
94
|
-
|
|
95
|
-
## Senza Client Library Installation
|
|
96
|
-
|
|
97
|
-
In order to install the Senza Client Library, you first need to generate an access token to github. Follow these steps in order to generate the access token:
|
|
98
|
-
1. Sign in to github.com with your personal account (create one if you don't have one).
|
|
99
|
-
2. Go to your profile settings --> Developer settings
|
|
100
|
-
3. Under 'Personal access tokens' go to 'Tokens (classic)'
|
|
101
|
-
4. Go to 'Generate new token (classic)'
|
|
102
|
-
5. Check 'read:packages'
|
|
103
|
-
6. Generate token
|
|
104
|
-
7. Copy token
|
|
105
|
-
|
|
106
|
-
### Install
|
|
107
|
-
Set registery for synamedia namespace
|
|
108
|
-
```bash
|
|
109
|
-
npm config set @Synamedia:registry https://npm.pkg.github.com
|
|
110
|
-
npm config set -- //npm.pkg.github.com/:_authToken <your access token>
|
|
111
|
-
```
|
|
112
|
-
|
|
113
|
-
Install using npm
|
|
114
|
-
```bash
|
|
115
|
-
npm install @Synamedia/hs-sdk
|
|
116
|
-
```
|
|
117
|
-
|
|
118
|
-
## Build SampleApp - DefaultUI
|
|
119
|
-
After Updating the app you should build remotePlayer-startPlayback app according to samples/README.md
|
|
120
|
-
|
|
121
|
-
## Upload to S3 bucket
|
|
122
|
-
After build, the folder should be uploaded to S3 prod bucket "streaming-sample-webui".
|
|
123
|
-
```bash
|
|
124
|
-
aws s3 cp remotePlayer-startPlayback/synamedia-logo-dark.gif s3://streaming-sample-webui/main/
|
|
125
|
-
aws s3 cp remotePlayer-startPlayback/dist s3://streaming-sample-webui/main/dist/ --recursive
|
|
126
|
-
aws s3 cp remotePlayer-startPlayback/index.html s3://streaming-sample-webui/main/
|
|
127
|
-
```
|
|
128
|
-
|