camstreamerlib 4.0.32-d499827 → 4.0.33

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 +9 -0
  2. package/package.json +106 -106
package/README.md CHANGED
@@ -39,6 +39,15 @@ npm install camstreamerlib
39
39
 
40
40
  </br>
41
41
 
42
+ # Examples
43
+
44
+ | Example | Description | Open in browser |
45
+ | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
46
+ | [CamSwitcherEvents](examples/camswitcher-events.html) ([source](https://github.com/CamStreamer/CamStreamerLib/blob/master/examples/camswitcher-events.html)) | Logs every CamSwitcher event. `DeviceConnectClient` (HTTP) backs [CamSwitcherAPI](doc/CamSwitcherAPI.md) to obtain the websocket authorization token, `DeviceConnectWsClient` (websocket) backs [CamSwitcherEvents](doc/ws/CamSwitcherEvents.md), which validates and dispatches the events. Connection state is taken from the `authorization` event. | [open](https://camstreamer.github.io/CamStreamerLib/examples/camswitcher-events.html) |
47
+ | [PlaneTrackerEvents](examples/planetracker-events.html) ([source](https://github.com/CamStreamer/CamStreamerLib/blob/master/examples/planetracker-events.html)) | Logs every PlaneTracker event. PlaneTracker needs no authorization token — [PlaneTrackerEvents](doc/ws/PlaneTrackerEvents.md) announces the connecting user (`userId` / `userName` / `userPriority`, editable in the form) as the init message instead, so only the websocket client is needed. The continuous `CAMERA_POSITION` and `FLIGHT_LIST` events only update the summary line unless the checkbox is ticked. | [open](https://camstreamer.github.io/CamStreamerLib/examples/planetracker-events.html) |
48
+
49
+ </br>
50
+
42
51
  # Breaking Changes
43
52
 
44
53
  <details open>
package/package.json CHANGED
@@ -1,113 +1,113 @@
1
1
  {
2
- "name": "camstreamerlib",
3
- "version": "4.0.32-d499827",
4
- "description": "Helper library for CamStreamer ACAP applications.",
5
- "prettier": "@camstreamer/prettier-config",
6
- "engine": {
7
- "node": ">=18.0.0"
8
- },
9
- "dependencies": {
10
- "adm-zip": "^0.6.0",
11
- "eventemitter2": "^5.0.1",
12
- "fast-xml-parser": "^5.3.6",
13
- "type-fest": "^4.41.0",
14
- "undici": "^6.28.0",
15
- "ws": "^8.18.0",
16
- "zod": "^3.25.76"
17
- },
18
- "devDependencies": {
19
- "@camstreamer/eslint-config": "^1.0.2",
20
- "@camstreamer/prettier-config": "^2.0.4",
21
- "@types/adm-zip": "^0.5.5",
22
- "@types/jest": "^28.0.0",
23
- "@types/node": "^18.19.127",
24
- "@types/ws": "^8.5.10",
25
- "@typescript-eslint/eslint-plugin": "^6.8.0",
26
- "@typescript-eslint/parser": "^6.8.0",
27
- "esbuild": "^0.28.2",
28
- "eslint": "^8.51.0",
29
- "eslint-plugin-deprecation": "^2.0.0",
30
- "eslint-plugin-unused-imports": "^3.0.0",
31
- "jest": "^28.1.3",
32
- "npm-run-all": "^4.1.5",
33
- "prettier": "^2.7.1",
34
- "ts-jest": "^28.0.0",
35
- "ts-node": "^10.7.0",
36
- "typescript": "5.3.3"
37
- },
38
- "overrides": {
39
- "js-yaml": "^4.2.0"
40
- },
41
- "scripts": {
42
- "clean": "rimraf dist/*",
43
- "build": "npm-run-all clean build:cjs build:esm copyPackage",
44
- "build:cjs": "tsc --project tsconfig.cjs.json",
45
- "build:esm": "tsc --project tsconfig.esm.json",
46
- "build:browser": "esbuild src/browser.index.ts --bundle --format=esm --platform=browser --target=es2022 --outfile=examples/camstreamerlib.js",
47
- "copyPackage": "cp -f LICENSE dist/ && cp -f README.md dist/ && cp -f package.json dist/ && cp -r -f examples dist/",
48
- "publishPackage": "./publish.sh",
49
- "lint": "eslint \"src/**/*.ts\"",
50
- "lint:fix": "eslint \"src/**/*.ts\" --fix",
51
- "pretty": "prettier --write \"./{{src,doc}/**/*.{ts,tsx,md},README.md}\"",
52
- "pretty:check": "prettier --check \"./{{src,doc}/**/*.{ts,tsx,md},README.md}\"",
53
- "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
54
- "audit": "npm audit --audit-level=high"
55
- },
56
- "files": [
57
- "/**/*.js",
58
- "/**/*.ts",
59
- "/examples/**/*"
60
- ],
61
- "main": "./cjs/index.js",
62
- "module": "./esm/index.js",
63
- "types": "types/index.d.ts",
64
- "exports": {
65
- ".": {
66
- "import": "./esm/index.js",
67
- "require": "./cjs/index.js",
68
- "types": "./types/index.d.ts"
2
+ "name": "camstreamerlib",
3
+ "version": "4.0.33",
4
+ "description": "Helper library for CamStreamer ACAP applications.",
5
+ "prettier": "@camstreamer/prettier-config",
6
+ "engine": {
7
+ "node": ">=18.0.0"
69
8
  },
70
- "./web": {
71
- "import": "./esm/web/index.js",
72
- "require": "./cjs/web/index.js",
73
- "types": "./types/web/index.d.ts"
9
+ "dependencies": {
10
+ "adm-zip": "^0.6.0",
11
+ "eventemitter2": "^5.0.1",
12
+ "fast-xml-parser": "^5.3.6",
13
+ "type-fest": "^4.41.0",
14
+ "undici": "^6.28.0",
15
+ "ws": "^8.18.0",
16
+ "zod": "^3.25.76"
74
17
  },
75
- "./node": {
76
- "import": "./esm/node/index.js",
77
- "require": "./cjs/node/index.js",
78
- "types": "./types/node/index.d.ts"
18
+ "devDependencies": {
19
+ "@camstreamer/eslint-config": "^1.0.2",
20
+ "@camstreamer/prettier-config": "^2.0.4",
21
+ "@types/adm-zip": "^0.5.5",
22
+ "@types/jest": "^28.0.0",
23
+ "@types/node": "^18.19.127",
24
+ "@types/ws": "^8.5.10",
25
+ "@typescript-eslint/eslint-plugin": "^6.8.0",
26
+ "@typescript-eslint/parser": "^6.8.0",
27
+ "esbuild": "^0.28.2",
28
+ "eslint": "^8.51.0",
29
+ "eslint-plugin-deprecation": "^2.0.0",
30
+ "eslint-plugin-unused-imports": "^3.0.0",
31
+ "jest": "^28.1.3",
32
+ "npm-run-all": "^4.1.5",
33
+ "prettier": "^2.7.1",
34
+ "ts-jest": "^28.0.0",
35
+ "ts-node": "^10.7.0",
36
+ "typescript": "5.3.3"
79
37
  },
80
- "./cjs/index": {
81
- "import": "./esm/index.js",
82
- "require": "./cjs/index.js",
83
- "types": "./types/index.d.ts"
38
+ "overrides": {
39
+ "js-yaml": "^4.2.0"
84
40
  },
85
- "./cjs/node": {
86
- "import": "./esm/node/index.js",
87
- "require": "./cjs/node/index.js",
88
- "types": "./types/node/index.js"
41
+ "scripts": {
42
+ "clean": "rimraf dist/*",
43
+ "build": "npm-run-all clean build:cjs build:esm copyPackage",
44
+ "build:cjs": "tsc --project tsconfig.cjs.json",
45
+ "build:esm": "tsc --project tsconfig.esm.json",
46
+ "build:browser": "esbuild src/browser.index.ts --bundle --format=esm --platform=browser --target=es2022 --outfile=examples/camstreamerlib.js",
47
+ "copyPackage": "cp -f LICENSE dist/ && cp -f README.md dist/ && cp -f package.json dist/ && cp -r -f examples dist/",
48
+ "publishPackage": "./publish.sh",
49
+ "lint": "eslint \"src/**/*.ts\"",
50
+ "lint:fix": "eslint \"src/**/*.ts\" --fix",
51
+ "pretty": "prettier --write \"./{{src,doc}/**/*.{ts,tsx,md},README.md}\"",
52
+ "pretty:check": "prettier --check \"./{{src,doc}/**/*.{ts,tsx,md},README.md}\"",
53
+ "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
54
+ "audit": "npm audit --audit-level=high"
89
55
  },
90
- "./cjs/node/index": {
91
- "import": "./esm/node/index.js",
92
- "require": "./cjs/node/index.js",
93
- "types": "./types/node/index.js"
94
- }
95
- },
96
- "repository": {
97
- "type": "git",
98
- "url": "git+https://github.com/CamStreamer/CamStreamerLib.git"
99
- },
100
- "keywords": [
101
- "CamStreamer",
102
- "CamOverlay",
103
- "CamScripter",
104
- "Camera",
105
- "Axis"
106
- ],
107
- "author": "CamStreamer s.r.o",
108
- "license": "ISC",
109
- "bugs": {
110
- "url": "https://github.com/CamStreamer/CamStreamerLib/issues"
111
- },
112
- "homepage": "https://github.com/CamStreamer/CamStreamerLib#readme"
56
+ "files": [
57
+ "/**/*.js",
58
+ "/**/*.ts",
59
+ "/examples/**/*"
60
+ ],
61
+ "main": "./cjs/index.js",
62
+ "module": "./esm/index.js",
63
+ "types": "types/index.d.ts",
64
+ "exports": {
65
+ ".": {
66
+ "import": "./esm/index.js",
67
+ "require": "./cjs/index.js",
68
+ "types": "./types/index.d.ts"
69
+ },
70
+ "./web": {
71
+ "import": "./esm/web/index.js",
72
+ "require": "./cjs/web/index.js",
73
+ "types": "./types/web/index.d.ts"
74
+ },
75
+ "./node": {
76
+ "import": "./esm/node/index.js",
77
+ "require": "./cjs/node/index.js",
78
+ "types": "./types/node/index.d.ts"
79
+ },
80
+ "./cjs/index": {
81
+ "import": "./esm/index.js",
82
+ "require": "./cjs/index.js",
83
+ "types": "./types/index.d.ts"
84
+ },
85
+ "./cjs/node": {
86
+ "import": "./esm/node/index.js",
87
+ "require": "./cjs/node/index.js",
88
+ "types": "./types/node/index.js"
89
+ },
90
+ "./cjs/node/index": {
91
+ "import": "./esm/node/index.js",
92
+ "require": "./cjs/node/index.js",
93
+ "types": "./types/node/index.js"
94
+ }
95
+ },
96
+ "repository": {
97
+ "type": "git",
98
+ "url": "git+https://github.com/CamStreamer/CamStreamerLib.git"
99
+ },
100
+ "keywords": [
101
+ "CamStreamer",
102
+ "CamOverlay",
103
+ "CamScripter",
104
+ "Camera",
105
+ "Axis"
106
+ ],
107
+ "author": "CamStreamer s.r.o",
108
+ "license": "ISC",
109
+ "bugs": {
110
+ "url": "https://github.com/CamStreamer/CamStreamerLib/issues"
111
+ },
112
+ "homepage": "https://github.com/CamStreamer/CamStreamerLib#readme"
113
113
  }