Migrated to TypeScript

ioBroker · Feb 3, 2025 · 3a4e033 · 3a4e033
1 parent b8e1de5
commit 3a4e033
Show file tree

Hide file tree

Showing 35 changed files with 711 additions and 74 deletions.
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020-2024 bluefox <[email protected]>
+Copyright (c) 2020-2025 bluefox <[email protected]>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -32,8 +32,8 @@ sendTo('cameras.0', 'image', {
 The result is always in `jpg` format.
 
 Supported cameras:
-- Reolink E1 Pro via RTSP (important, without `Pro` it will not work)
-- Eufy via eusec adapter
+- `Reolink E1 Pro` via RTSP (important, without `Pro` it will not work)
+- `Eufy` via eusec adapter
 - [HiKam](https://support.hikam.de/support/solutions/articles/16000070656-zugriff-auf-kameras-der-2-generation-via-onvif-f%C3%BCr-s6-q8-a7-2-generation-) of second and third generation via ONVIF (für S6, Q8, A7 2. Generation), A7 Pro, A9
 - [WIWICam M1 via HiKam adapter](https://www.wiwacam.com/de/mw1-minikamera-kurzanleitung-und-faq/)
 - RTSP Native - if your camera supports RTSP protocol
@@ -47,7 +47,7 @@ This is URL request for image, where all parameters are in URL, but you can prov
 
 ### FFmpeg
 If you want to access snapshots on RTSP cameras, you can use ffmpeg. You need to install ffmpeg on your system:
-- Windows has precompiled ffmpeg and there is no need to download anything. (Windows version is taken from here: https://www.gyan.dev/ffmpeg/builds/ffmpeg-git-essentials.7z) 
+- Windows has precompiled ffmpeg and there is no need to download anything. (Windows version is taken from here: https://www.gyan.dev/ffmpeg/builds/ffmpeg-git-full.7z) 
 - Linux: `sudo apt-get install ffmpeg -y`
 
 Here is an example of how to add Reolink E1:
@@ -56,8 +56,8 @@ Here is an example of how to add Reolink E1:
 
 ## How to add a new camera (For developers)
 To add a new camera, you must create a Pull Request on GitHub with the following changes:
-- Add new file into `cameras` folder. This is a backend to read the single image from the camera. 
-- Add GUI file in the `src/src/Types/` folder. This is the configuration dialog for the camera
+- Add a new file into `cameras` folder. This is a backend to read the single image from the camera. 
+- Add a GUI file in the `src/src/Types/` folder. This is the configuration dialog for the camera
 - Add this dialog in `src/src/Tabs/Cameras.js` file analogical as other cameras are added. Only two lines should be added:
   - Import new configuration dialog like `import RTSPMyCamConfig from '../Types/RTSPMyCam';`
   - Extend `TYPES` structure with the new camera like `mycam: { Config: RTSPMyCamConfig, name: 'MyCam' },`
@@ -140,7 +140,7 @@ To add a new camera, you must create a Pull Request on GitHub with the following
 ## License
 MIT License
 
-Copyright (c) 2020-2024 bluefox <[email protected]>
+Copyright (c) 2020-2025 bluefox <[email protected]>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/admin/assets/index-DSdrsOJ-.js b/admin/assets/index-DSdrsOJ-.js
diff --git a/admin/assets/index-DZVxZX2g.css b/admin/assets/index-DZVxZX2g.css
diff --git a/admin/cameras.png b/admin/cameras.png
diff --git a/admin/favicon.ico b/admin/favicon.ico
diff --git a/admin/index_m.html b/admin/index_m.html
@@ -0,0 +1,30 @@
+<!doctype html>
+<html lang="en">
+    <head>
+        <meta charset="utf-8" />
+        <link
+            rel="shortcut icon"
+            href="favicon.ico"
+        />
+        <meta
+            name="viewport"
+            content="width=device-width, initial-scale=1, shrink-to-fit=no"
+        />
+        <meta
+            name="theme-color"
+            content="#000000"
+        />
+        <link
+            rel="manifest"
+            href="manifest.json"
+        />
+        <script type="text/javascript" onerror="setTimeout(function(){window.location.reload()}, 5000)" src="./lib/js/socket.io.js"></script>
+        <title>ioBroker.cameras</title>
+      <script type="module" crossorigin src="./assets/index-DSdrsOJ-.js"></script>
+      <link rel="stylesheet" crossorigin href="./assets/index-DZVxZX2g.css">
+    </head>
+    <body>
+        <noscript>You need to enable JavaScript to run this app.</noscript>
+        <div id="root"></div>
+    </body>
+</html>
diff --git a/admin/manifest.json b/admin/manifest.json
@@ -0,0 +1,15 @@
+{
+  "short_name": "ioBroker.cameras",
+  "name": "ioBroker.cameras",
+  "icons": [
+    {
+      "src": "favicon.ico",
+      "sizes": "64x64 32x32 24x24 16x16",
+      "type": "image/x-icon"
+    }
+  ],
+  "start_url": ".",
+  "display": "standalone",
+  "theme_color": "#000000",
+  "background_color": "#ffffff"
+}
diff --git a/build/main.js b/build/main.js
diff --git a/build/main.js.map b/build/main.js.map
diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -16,7 +16,9 @@ export default [
     {
         ignores: [
             'src-admin/**/*',
+            'src-widgets/**/*',
             'admin/**/*',
+            'widgets/**/*',
             'node_modules/**/*',
             'test/**/*',
             'build/**/*',

diff --git a/package.json b/package.json
@@ -57,7 +57,7 @@
     "sinon-chai": "^3.7.0",
     "typescript": "^5.7.3"
   },
-  "main": "main.js",
+  "main": "build/main.js",
   "files": [
     "admin/",
     "build/",
@@ -68,7 +68,7 @@
   ],
   "scripts": {
     "test": "mocha --exit",
-    "lint": "eslint",
+    "lint": "eslint -c eslint.config.mjs",
     "prepublishOnly": "node tasks",
     "build": "npm run build-backend && node tasks",
     "build-backend": "tsc -p tsconfig.build.json",

diff --git a/src-admin/src/Types/ConfigGeneric.tsx b/src-admin/src/Types/ConfigGeneric.tsx
@@ -1,6 +1,6 @@
 import { type JSX, Component } from 'react';
 import type { AdminConnection, IobTheme, ThemeType } from '@iobroker/adapter-react-v5';
-import type { CameraAdapterConfig } from '../types';
+import type { CamerasAdapterConfig } from '../types';
 
 export interface ConfigProps<T> {
     onChange: (
@@ -13,7 +13,7 @@ export interface ConfigProps<T> {
         T,
         'name' | 'type' | 'desc' | 'timeout' | 'cacheTimeout' | 'addTime' | 'title' | 'id' | 'enabled' | 'rtsp'
     >;
-    native: CameraAdapterConfig;
+    native: CamerasAdapterConfig;
     decrypt: (text: string, callback: (decrypted: string) => void) => void;
     encrypt: (text: string, callback: (encrypted: string) => void) => void;
     theme: IobTheme;

diff --git a/src-admin/src/Types/RTSPImage.tsx b/src-admin/src/Types/RTSPImage.tsx
@@ -112,7 +112,12 @@ export default class RTSPImageConfig extends ConfigGeneric<CameraConfigRtsp, { u
         });
     }
 
-    buildCommand(options: Omit<CameraConfigRtsp, 'type' | 'name'>): string[] {
+    buildCommand(
+        options: Omit<
+            CameraConfigRtsp,
+            'name' | 'type' | 'desc' | 'timeout' | 'cacheTimeout' | 'addTime' | 'id' | 'title' | 'enabled' | 'rtsp'
+        >,
+    ): string[] {
         const parameters = ['-y'];
         options.prefix && parameters.push(options.prefix);
         parameters.push('-rtsp_transport');

diff --git a/src-admin/src/types.d.ts b/src-admin/src/types.d.ts
@@ -1,16 +1,19 @@
+export type ContentType = string;
 export type CameraType = 'url' | 'urlBasicAuth' | 'rtsp' | 'reolinkE1' | 'eufy' | 'hikam';
 
+export type CameraName = string;
+
 export interface CameraConfig {
-    name: string;
+    name: CameraName;
     type: CameraType;
     id: number;
+    rtsp: boolean;
     desc?: string;
     timeout?: number | string;
     cacheTimeout?: number | string;
     addTime?: boolean;
     title?: string;
     enabled?: boolean;
-    rtsp: boolean;
 }
 
 export interface CameraConfigUrl extends CameraConfig {
@@ -72,7 +75,7 @@ export type CameraConfigAny =
 
 export interface CamerasAdapterConfig {
     bind: string;
-    port: number;
+    port: string | number;
     key: string;
     webInstance: string;
     defaultTimeout: number | string;

diff --git a/src-widgets/package.json b/src-widgets/package.json
@@ -19,7 +19,6 @@
         "eslint-plugin-only-warn": "^1.1.0",
         "eslint-plugin-react": "^7.37.4",
         "eslint-plugin-react-hooks": "^5.1.0",
-        "hls.js": "^1.5.20",
         "moment": "^2.30.1",
         "node-sass": "^9.0.0",
         "prop-types": "^15.8.1",

diff --git a/src/types.d.ts b/src/types.d.ts
@@ -9,13 +9,13 @@ export interface CameraConfig {
     name: CameraName;
     type: CameraType;
     id: number;
+    rtsp: boolean;
     desc?: string;
     timeout?: number | string;
     cacheTimeout?: number | string;
     addTime?: boolean;
     title?: string;
     enabled?: boolean;
-    rtsp?: boolean;
 }
 
 export interface CameraConfigUrl extends CameraConfig {

diff --git a/tasks.js b/tasks.js
@@ -13,7 +13,7 @@ const { deleteFoldersRecursive, buildReact, npmInstall, copyFiles, patchHtmlFile
 const { copyFileSync } = require('node:fs');
 
 async function copyAllFiles() {
-    deleteFoldersRecursive(`${__dirname}/admin`);
+    deleteFoldersRecursive(`${__dirname}/admin`, ['cameras.png', 'cameras.svg']);
     copyFiles(['src-admin/build/**/*', '!src-admin/build/index.html', 'admin-config/*'], 'admin/');
 
     await patchHtmlFile(`${__dirname}/src-admin/build/index.html`);
@@ -69,7 +69,7 @@ if (process.argv.includes('--0-clean')) {
         });
     }
 } else if (process.argv.includes('--2-build')) {
-    buildReact('src-admin', { rootDir: 'src-admin', tsc: true, vite: true }).catch(e => {
+    buildReact(`${__dirname}/src-admin`, { rootDir: `${__dirname}/src-admin`, tsc: true, vite: true }).catch(e => {
         console.error(`Cannot build: ${e}`);
         process.exit(2);
     });
@@ -81,7 +81,7 @@ if (process.argv.includes('--0-clean')) {
 } else if (process.argv.includes('--build-admin')) {
     clean();
     npmInstall('src-admin')
-        .then(() => buildReact('src-admin', { rootDir: 'src-admin', tsc: true, vite: true }))
+        .then(() => buildReact(`${__dirname}/src-admin`, { rootDir: `${__dirname}/src-admin`, tsc: true, vite: true }))
         .then(() => copyAllFiles());
 } else if (process.argv.includes('--widget-0-clean')) {
     widgetsClean();
@@ -114,7 +114,7 @@ if (process.argv.includes('--0-clean')) {
 } else {
     clean();
     npmInstall('src-admin')
-        .then(() => buildReact('src-admin', { rootDir: 'src-admin', tsc: true, vite: true }))
+        .then(() => buildReact(`${__dirname}/src-admin`, { rootDir: `${__dirname}/src-admin`, tsc: true, vite: true }))
         .then(() => copyAllFiles())
         .then(() => widgetsClean())
         .then(() => npmInstall('src-widgets'))

diff --git a/widgets/cameras/customWidgets.js b/widgets/cameras/customWidgets.js
diff --git a/widgets/cameras/customWidgets.js.map b/widgets/cameras/customWidgets.js.map
diff --git a/widgets/cameras/i18n/en.json b/widgets/cameras/i18n/en.json
@@ -8,7 +8,7 @@
   "Camera": "Camera",
   "Close": "Close",
   "videoWidth": "Video width",
-  "tooltip_videoWidth": "Do not set width of video too hight to save broadband. It is for both: small and full videos. If not set, the initial size of widget will be taken.",
+  "tooltip_videoWidth": "Do not set width of video too high to save broadband. It is for both: small and full videos. If not set, the initial size of widget will be taken.",
   "Camera instance %s inactive": "Camera instance %s inactive",
   "disabled": "disabled",
   "pollingInterval": "Polling interval",

diff --git a/widgets/cameras/static/js/main.1b47b6c5.js → widgets/cameras/static/js/main.1d57e13d.js b/widgets/cameras/static/js/main.1b47b6c5.js → widgets/cameras/static/js/main.1d57e13d.js
diff --git a/widgets/cameras/static/js/src_RtspCamera_jsx.db3a0929.chunk.js b/widgets/cameras/static/js/src_RtspCamera_jsx.db3a0929.chunk.js
diff --git a/widgets/cameras/static/js/src_RtspCamera_jsx.db3a0929.chunk.js.LICENSE.txt b/widgets/cameras/static/js/src_RtspCamera_jsx.db3a0929.chunk.js.LICENSE.txt
diff --git a/widgets/cameras/static/js/src_SnapshotCamera_jsx.bac7a9b6.chunk.js b/widgets/cameras/static/js/src_SnapshotCamera_jsx.bac7a9b6.chunk.js
diff --git a/widgets/cameras/static/js/src_SnapshotCamera_jsx.bac7a9b6.chunk.js.LICENSE.txt b/widgets/cameras/static/js/src_SnapshotCamera_jsx.bac7a9b6.chunk.js.LICENSE.txt
diff --git a/...tic/js/src_bootstrap_js.bdd07d8e.chunk.js → ...tic/js/src_bootstrap_js.598de3c9.chunk.js b/...tic/js/src_bootstrap_js.bdd07d8e.chunk.js → ...tic/js/src_bootstrap_js.598de3c9.chunk.js
diff --git a/...ootstrap_js.bdd07d8e.chunk.js.LICENSE.txt → ...ootstrap_js.598de3c9.chunk.js.LICENSE.txt b/...ootstrap_js.bdd07d8e.chunk.js.LICENSE.txt → ...ootstrap_js.598de3c9.chunk.js.LICENSE.txt