@kittycad/web-view 1.2.13 → 1.2.15
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 +9 -0
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -2,6 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
Various helpers to get a Zoo KittyCAD WebRTC stream onto a web page!
|
|
4
4
|
|
|
5
|
+
An example of this component in action can be found at https://viewer.zoo.dev
|
|
6
|
+
|
|
5
7
|
## Features
|
|
6
8
|
|
|
7
9
|
* Each instance runs on a Web Worker, preventing main worker blocking.
|
|
@@ -20,6 +22,12 @@ npm install @kittycad/web-view @kittycad/lib
|
|
|
20
22
|
You will need to copy `node_modules/@kittycad/kcl-wasm-lib/kcl_wasm_lib_bg.wasm`
|
|
21
23
|
to the root of a directory that will be served by your web server.
|
|
22
24
|
|
|
25
|
+
## IMPORTANT NOTE ON AUTHENTICATION
|
|
26
|
+
|
|
27
|
+
For local development, [use an API token](https://zoo.dev/account/developer).
|
|
28
|
+
OAuth authentication is locked to Zoo's domains currently. If you're an external
|
|
29
|
+
user to Zoo, use an API token for production as well.
|
|
30
|
+
|
|
23
31
|
## Quick demo
|
|
24
32
|
|
|
25
33
|
```sh
|
|
@@ -41,6 +49,7 @@ import { ZooWebView } from '@kittycad/web-view'
|
|
|
41
49
|
document.addEventListener('DOMContentLoaded', () => {
|
|
42
50
|
const token = 'api-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
|
|
43
51
|
|
|
52
|
+
// If no token is passed, then OAuth will trigger, so watch out!
|
|
44
53
|
const zooClient = new zoo.Client({
|
|
45
54
|
token,
|
|
46
55
|
baseUrl: 'wss://api.zoo.dev',
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kittycad/web-view",
|
|
3
|
-
"version": "1.2.
|
|
3
|
+
"version": "1.2.15",
|
|
4
4
|
"main": "index.js",
|
|
5
5
|
"types": "index.d.ts",
|
|
6
6
|
"homepage": "https://github.com/KittyCAD/web-view",
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"license": "ISC",
|
|
18
18
|
"description": "",
|
|
19
19
|
"dependencies": {
|
|
20
|
-
"@kittycad/lib": "^4.5.
|
|
20
|
+
"@kittycad/lib": "^4.5.13",
|
|
21
21
|
"typescript": "^5.9.3"
|
|
22
22
|
},
|
|
23
23
|
"devDependencies": {
|