hoffmation-base 3.2.25 → 3.2.26

package/lib/interfaces/settings/iRestSettings.d.ts

@@ -1,3 +1,4 @@
+import { iRestUser } from './iRestUser';
 /**
  * Interface for the REST settings.
  * This is primarily used to configure the REST service within Hoffmation-Express.
@@ -7,8 +8,16 @@ export interface iRestSettings {
      * Whether the REST service should be active.
      */
     active: boolean;
+    /**
+     * Whether the Web UI should be active.
+     */
+    webUi: boolean;
     /**
      * The port the REST service should listen on.
      */
     port?: number;
+    /**
+     * The allowed users for the REST service.
+     */
+    user?: iRestUser[];
 }

package/lib/interfaces/settings/iRestUser.d.ts

@@ -0,0 +1,21 @@
+/**
+ *
+ */
+export interface iRestUser {
+    /**
+     *
+     */
+    username: string;
+    /**
+     *
+     */
+    passwordHash: string;
+    /**
+     *
+     */
+    publicKey: string;
+    /**
+     *
+     */
+    permissions: string[];
+}

package/lib/interfaces/settings/iRestUser.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/interfaces/settings/index.d.ts

@@ -30,4 +30,5 @@ export { iLedSettings } from './iLedSettings';
 export { iSceneSettings } from './iSceneSettings';
 export { iSettingsProvider } from './iSettingsProvider';
 export { iWledSettings } from './iWledSettings';
+export { iRestUser } from './iRestUser';
 export { iGlobalHeaterSettings } from './iGlobalHeaterSettings';

package/lib/server/config/exampleConfig.js

@@ -18,6 +18,7 @@ exports.ExampleConfig = {
     },
     restServer: {
         active: true,
+        webUi: true,
         expressPort: 4444,
     },
     roomDefault: {