@kks-web/player-sdk 1.0.7 → 1.0.8-beta.1
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
CHANGED
|
@@ -3,33 +3,6 @@
|
|
|
3
3
|
The BlendVision Player SDK allows you to create, interact with and control an
|
|
4
4
|
embedded BlendVision Player.
|
|
5
5
|
|
|
6
|
-
## Deploy and Environments
|
|
7
|
-
|
|
8
|
-
Usually, the deploy flow will be: `Development` → `Staging` → `Prod`.
|
|
9
|
-
|
|
10
|
-
| Environment | Command | URL |
|
|
11
|
-
| ----------- | ----------- | --------------------------------------------- |
|
|
12
|
-
| Development | `cibr dev` | https://bv-player-sdk-dev.madmax.kkv-test.com |
|
|
13
|
-
| Staging | `cibr stag` | https://bv-player-sdk-stag.madmax.kkvqa.com |
|
|
14
|
-
| Prod | `cibr prod` | https://bv-player-sdk-prod.live.kkstream.io |
|
|
15
|
-
|
|
16
|
-
> Note: The `cibr <branch-name>` is a git alias, you can add it by checking this [document](https://sites.google.com/kkstream.com.tw/start-a-ottez-web-project/git-cibr).
|
|
17
|
-
|
|
18
|
-
## NPM Publish
|
|
19
|
-
|
|
20
|
-
```
|
|
21
|
-
npm login // login with `webkks` account
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
npm publish --tag beta // publish beta version
|
|
25
|
-
npm install —-save @web-kks/player-sdk@beta. // select and install beta version
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
npm publish --access public // publish prod version
|
|
29
|
-
npm install —-save @web-kks/player-sdk // install latest prod version
|
|
30
|
-
|
|
31
|
-
```
|
|
32
|
-
|
|
33
6
|
## Installation
|
|
34
7
|
|
|
35
8
|
You can install the BlendVision Player SDK through npm:
|
|
@@ -138,11 +111,8 @@ export default App;
|
|
|
138
111
|
These config options are available to use as an object passed to the
|
|
139
112
|
`Player` constructor.
|
|
140
113
|
|
|
141
|
-
| option
|
|
142
|
-
|
|
|
143
|
-
| token
|
|
144
|
-
| playerUrl
|
|
145
|
-
| locale
|
|
146
|
-
| titleSpacing | | Number. Add `{X}`rem spacing in front of title. |
|
|
147
|
-
| disableFullscreen | false | Boolean. Hide/Show fullscreen button. |
|
|
148
|
-
| did | | String. Device ID for concurrent user count and report |
|
|
114
|
+
| option | default | description |
|
|
115
|
+
| --------- | --------------------------------- | ----------------------------------------------------------------------- |
|
|
116
|
+
| token | | **Required.** The accessToken of the event from BlendVision Moment api. |
|
|
117
|
+
| playerUrl | `https://player.live.kkstream.io` | The URL of the Player service. |
|
|
118
|
+
| locale | en | The language of Player. `(en, zh, ja)` |
|
package/package.json
CHANGED
|
@@ -1,78 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kks-web/player-sdk",
|
|
3
|
-
"version": "1.0.
|
|
4
|
-
"main": "
|
|
5
|
-
"module": "
|
|
6
|
-
"types": "
|
|
3
|
+
"version": "1.0.8-beta.1",
|
|
4
|
+
"main": "index.js",
|
|
5
|
+
"module": "index.esm.js",
|
|
6
|
+
"types": "index.d.ts",
|
|
7
7
|
"files": [
|
|
8
|
-
"
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
"@emotion/styled": "^11.6.0",
|
|
13
|
-
"@mui/material": "^5.2.4",
|
|
14
|
-
"@testing-library/jest-dom": "^5.14.1",
|
|
15
|
-
"@testing-library/react": "^12.0.0",
|
|
16
|
-
"@testing-library/user-event": "^13.2.1",
|
|
17
|
-
"@types/jest": "^27.0.1",
|
|
18
|
-
"@types/node": "^16.7.13",
|
|
19
|
-
"@types/react": "^17.0.20",
|
|
20
|
-
"@types/react-dom": "^17.0.9",
|
|
21
|
-
"react": "^17.0.2",
|
|
22
|
-
"react-dom": "^17.0.2",
|
|
23
|
-
"react-scripts": "5.0.0",
|
|
24
|
-
"typescript": "^4.4.2",
|
|
25
|
-
"web-vitals": "^2.1.0"
|
|
26
|
-
},
|
|
27
|
-
"scripts": {
|
|
28
|
-
"clean": "rimraf dist/*",
|
|
29
|
-
"prebuild:dev": "npm run clean -s",
|
|
30
|
-
"build:local": "env-cmd -f .env.local rollup -c rollup/config.js --environment BUILD:dist && npm run postbuild",
|
|
31
|
-
"build:dev": "env-cmd -f .env.dev rollup -c rollup/config.js --environment BUILD:dist && npm run postbuild",
|
|
32
|
-
"prebuild:stag": "npm run clean -s",
|
|
33
|
-
"build:stag": "env-cmd -f .env.stag rollup -c rollup/config.js --environment BUILD:dist && npm run postbuild",
|
|
34
|
-
"build:prod": "npm run build",
|
|
35
|
-
"prebuild": "npm run clean -s",
|
|
36
|
-
"build": "env-cmd -f .env.prod rollup -c rollup/config.js --environment BUILD:dist && npm run postbuild",
|
|
37
|
-
"start": "npm run build:dev && react-app-rewired start",
|
|
38
|
-
"prebuild:demo": "rimraf build/*",
|
|
39
|
-
"build:demo": "react-app-rewired build",
|
|
40
|
-
"postbuild": "cp dist/* npm",
|
|
41
|
-
"release": " cd npm && yarn version --no-git-tag-version && git add package.json && cd .. && yarn version",
|
|
42
|
-
"postversion": "git push --follow-tags --no-verify && echo \"Successfully released version $npm_package_version!\"",
|
|
43
|
-
"eject": "react-scripts eject"
|
|
44
|
-
},
|
|
45
|
-
"browserslist": {
|
|
46
|
-
"production": [
|
|
47
|
-
">0.2%",
|
|
48
|
-
"not dead",
|
|
49
|
-
"not op_mini all"
|
|
50
|
-
],
|
|
51
|
-
"development": [
|
|
52
|
-
"last 1 chrome version",
|
|
53
|
-
"last 1 firefox version",
|
|
54
|
-
"last 1 safari version"
|
|
55
|
-
]
|
|
56
|
-
},
|
|
57
|
-
"devDependencies": {
|
|
58
|
-
"@babel/core": "^7.16.7",
|
|
59
|
-
"@babel/eslint-parser": "^7.16.5",
|
|
60
|
-
"@babel/preset-env": "^7.16.8",
|
|
61
|
-
"@babel/preset-react": "^7.16.7",
|
|
62
|
-
"@babel/preset-typescript": "^7.16.7",
|
|
63
|
-
"@kks-web/eslint-config-kksweb": "^0.2.0",
|
|
64
|
-
"@rollup/plugin-babel": "^5.3.0",
|
|
65
|
-
"@rollup/plugin-commonjs": "^21.0.1",
|
|
66
|
-
"@rollup/plugin-node-resolve": "^13.1.3",
|
|
67
|
-
"@rollup/plugin-typescript": "^8.3.0",
|
|
68
|
-
"env-cmd": "^10.1.0",
|
|
69
|
-
"prettier": "^2.5.1",
|
|
70
|
-
"react-app-rewire-alias": "^1.1.7",
|
|
71
|
-
"react-app-rewired": "^2.1.11",
|
|
72
|
-
"rollup": "^2.64.0",
|
|
73
|
-
"rollup-plugin-delete": "^2.0.0",
|
|
74
|
-
"rollup-plugin-dotenv": "^0.3.0",
|
|
75
|
-
"rollup-plugin-dts": "^4.1.0",
|
|
76
|
-
"rollup-plugin-terser": "^7.0.2"
|
|
77
|
-
}
|
|
8
|
+
"index.js",
|
|
9
|
+
"index.esm.js",
|
|
10
|
+
"index.d.ts"
|
|
11
|
+
]
|
|
78
12
|
}
|
|
File without changes
|
|
File without changes
|
|
File without changes
|