Merge remote-tracking branch 'origin/v3.4' into dev

interface/src/api/Endpoints.ts

@@ -1,24 +0,0 @@
-import { ENDPOINT_ROOT } from './Env';
-
-export const FEATURES_ENDPOINT = ENDPOINT_ROOT + 'features';
-export const NTP_STATUS_ENDPOINT = ENDPOINT_ROOT + 'ntpStatus';
-export const NTP_SETTINGS_ENDPOINT = ENDPOINT_ROOT + 'ntpSettings';
-export const TIME_ENDPOINT = ENDPOINT_ROOT + 'time';
-export const AP_SETTINGS_ENDPOINT = ENDPOINT_ROOT + 'apSettings';
-export const AP_STATUS_ENDPOINT = ENDPOINT_ROOT + 'apStatus';
-export const SCAN_NETWORKS_ENDPOINT = ENDPOINT_ROOT + 'scanNetworks';
-export const LIST_NETWORKS_ENDPOINT = ENDPOINT_ROOT + 'listNetworks';
-export const NETWORK_SETTINGS_ENDPOINT = ENDPOINT_ROOT + 'networkSettings';
-export const NETWORK_STATUS_ENDPOINT = ENDPOINT_ROOT + 'networkStatus';
-export const OTA_SETTINGS_ENDPOINT = ENDPOINT_ROOT + 'otaSettings';
-export const UPLOAD_FIRMWARE_ENDPOINT = ENDPOINT_ROOT + 'uploadFirmware';
-export const MQTT_SETTINGS_ENDPOINT = ENDPOINT_ROOT + 'mqttSettings';
-export const MQTT_STATUS_ENDPOINT = ENDPOINT_ROOT + 'mqttStatus';
-export const SYSTEM_STATUS_ENDPOINT = ENDPOINT_ROOT + 'systemStatus';
-export const SIGN_IN_ENDPOINT = ENDPOINT_ROOT + 'signIn';
-export const VERIFY_AUTHORIZATION_ENDPOINT =
-  ENDPOINT_ROOT + 'verifyAuthorization';
-export const SECURITY_SETTINGS_ENDPOINT = ENDPOINT_ROOT + 'securitySettings';
-export const GENERATE_TOKEN_ENDPOINT = ENDPOINT_ROOT + 'generateToken';
-export const RESTART_ENDPOINT = ENDPOINT_ROOT + 'restart';
-export const FACTORY_RESET_ENDPOINT = ENDPOINT_ROOT + 'factoryReset';

interface/src/api/Env.ts

@@ -1,26 +0,0 @@
-export const PROJECT_NAME = process.env.REACT_APP_PROJECT_NAME!;
-export const PROJECT_PATH = process.env.REACT_APP_PROJECT_PATH!;
-
-export const ENDPOINT_ROOT = calculateEndpointRoot('/rest/');
-export const WEB_SOCKET_ROOT = calculateWebSocketRoot('/ws/');
-export const EVENT_SOURCE_ROOT = calculateEndpointRoot('/es/');
-export const API_ENDPOINT_ROOT = calculateEndpointRoot('/api/');
-
-function calculateEndpointRoot(endpointPath: string) {
-  const httpRoot = process.env.REACT_APP_HTTP_ROOT;
-  if (httpRoot) {
-    return httpRoot + endpointPath;
-  }
-  const location = window.location;
-  return location.protocol + '//' + location.host + endpointPath;
-}
-
-function calculateWebSocketRoot(webSocketPath: string) {
-  const webSocketRoot = process.env.REACT_APP_WEB_SOCKET_ROOT;
-  if (webSocketRoot) {
-    return webSocketRoot + webSocketPath;
-  }
-  const location = window.location;
-  const webProtocol = location.protocol === 'https:' ? 'wss:' : 'ws:';
-  return webProtocol + '//' + location.host + webSocketPath;
-}

interface/src/api/ap.ts

@@ -0,0 +1,16 @@
+import { AxiosPromise } from 'axios';
+
+import { APSettings, APStatus } from '../types';
+import { AXIOS } from './endpoints';
+
+export function readAPStatus(): AxiosPromise<APStatus> {
+  return AXIOS.get('/apStatus');
+}
+
+export function readAPSettings(): AxiosPromise<APSettings> {
+  return AXIOS.get('/apSettings');
+}
+
+export function updateAPSettings(apSettings: APSettings): AxiosPromise<APSettings> {
+  return AXIOS.post('/apSettings', apSettings);
+}

interface/src/api/authentication.ts

@@ -0,0 +1,64 @@
+import { AxiosPromise } from 'axios';
+import * as H from 'history';
+import jwtDecode from 'jwt-decode';
+import { Path } from 'react-router-dom';
+
+import { Features, Me, SignInRequest, SignInResponse } from '../types';
+
+import { ACCESS_TOKEN, AXIOS } from './endpoints';
+import { PROJECT_PATH } from './env';
+
+export const SIGN_IN_PATHNAME = 'loginPathname';
+export const SIGN_IN_SEARCH = 'loginSearch';
+
+export const getDefaultRoute = (features: Features) => (features.project ? `/${PROJECT_PATH}` : '/wifi');
+
+export function verifyAuthorization(): AxiosPromise<void> {
+  return AXIOS.get('/verifyAuthorization');
+}
+
+export function signIn(request: SignInRequest): AxiosPromise<SignInResponse> {
+  return AXIOS.post('/signIn', request);
+}
+
+/**
+ * Fallback to sessionStorage if localStorage is absent. WebView may not have local storage enabled.
+ */
+export function getStorage() {
+  return localStorage || sessionStorage;
+}
+
+export function storeLoginRedirect(location?: H.Location) {
+  if (location) {
+    getStorage().setItem(SIGN_IN_PATHNAME, location.pathname);
+    getStorage().setItem(SIGN_IN_SEARCH, location.search);
+  }
+}
+
+export function clearLoginRedirect() {
+  getStorage().removeItem(SIGN_IN_PATHNAME);
+  getStorage().removeItem(SIGN_IN_SEARCH);
+}
+
+export function fetchLoginRedirect(features: Features): Partial<Path> {
+  const signInPathname = getStorage().getItem(SIGN_IN_PATHNAME);
+  const signInSearch = getStorage().getItem(SIGN_IN_SEARCH);
+  clearLoginRedirect();
+  return {
+    pathname: signInPathname || getDefaultRoute(features),
+    search: (signInPathname && signInSearch) || undefined
+  };
+}
+
+export const clearAccessToken = () => localStorage.removeItem(ACCESS_TOKEN);
+export const decodeMeJWT = (accessToken: string): Me => jwtDecode(accessToken) as Me;
+
+export function addAccessTokenParameter(url: string) {
+  const accessToken = getStorage().getItem(ACCESS_TOKEN);
+  if (!accessToken) {
+    return url;
+  }
+  const parsedUrl = new URL(url);
+  parsedUrl.searchParams.set(ACCESS_TOKEN, accessToken);
+  return parsedUrl.toString();
+}

interface/src/api/endpoints.ts

@@ -0,0 +1,105 @@
+import axios, { AxiosPromise, CancelToken } from 'axios';
+
+import { decode } from '@msgpack/msgpack';
+
+export const WS_BASE_URL = '/ws/';
+export const API_BASE_URL = '/rest/';
+export const ES_BASE_URL = '/es/';
+export const EMSESP_API_BASE_URL = '/api/';
+export const ACCESS_TOKEN = 'access_token';
+export const WEB_SOCKET_ROOT = calculateWebSocketRoot(WS_BASE_URL);
+export const EVENT_SOURCE_ROOT = calculateEventSourceRoot(ES_BASE_URL);
+
+export const AXIOS = axios.create({
+  baseURL: API_BASE_URL,
+  headers: {
+    'Content-Type': 'application/json'
+  },
+  transformRequest: [
+    (data, headers) => {
+      if (headers) {
+        if (localStorage.getItem(ACCESS_TOKEN)) {
+          headers.Authorization = 'Bearer ' + localStorage.getItem(ACCESS_TOKEN);
+        }
+        if (headers['Content-Type'] !== 'application/json') {
+          return data;
+        }
+      }
+      return JSON.stringify(data);
+    }
+  ]
+});
+
+export const AXIOS_API = axios.create({
+  baseURL: EMSESP_API_BASE_URL,
+  headers: {
+    'Content-Type': 'application/json'
+  },
+  transformRequest: [
+    (data, headers) => {
+      if (headers) {
+        if (localStorage.getItem(ACCESS_TOKEN)) {
+          headers.Authorization = 'Bearer ' + localStorage.getItem(ACCESS_TOKEN);
+        }
+        if (headers['Content-Type'] !== 'application/json') {
+          return data;
+        }
+      }
+      return JSON.stringify(data);
+    }
+  ]
+});
+
+export const AXIOS_BIN = axios.create({
+  baseURL: API_BASE_URL,
+  headers: {
+    'Content-Type': 'application/json'
+  },
+  responseType: 'arraybuffer',
+  transformRequest: [
+    (data, headers) => {
+      if (headers) {
+        if (localStorage.getItem(ACCESS_TOKEN)) {
+          headers.Authorization = 'Bearer ' + localStorage.getItem(ACCESS_TOKEN);
+        }
+        if (headers['Content-Type'] !== 'application/json') {
+          return data;
+        }
+      }
+      return JSON.stringify(data);
+    }
+  ],
+  transformResponse: [
+    (data) => {
+      return decode(data);
+    }
+  ]
+});
+
+function calculateWebSocketRoot(webSocketPath: string) {
+  const location = window.location;
+  const webProtocol = location.protocol === 'https:' ? 'wss:' : 'ws:';
+  return webProtocol + '//' + location.host + webSocketPath;
+}
+
+function calculateEventSourceRoot(endpointPath: string) {
+  const location = window.location;
+  return location.protocol + '//' + location.host + endpointPath;
+}
+
+export interface FileUploadConfig {
+  cancelToken?: CancelToken;
+  onUploadProgress?: (progressEvent: ProgressEvent) => void;
+}
+
+export const uploadFile = (url: string, file: File, config?: FileUploadConfig): AxiosPromise<void> => {
+  const formData = new FormData();
+  formData.append('file', file);
+
+  return AXIOS.post(url, formData, {
+    headers: {
+      'Content-Type': 'multipart/form-data'
+    },
+    ...(config || {})
+  });
+};

interface/src/api/env.ts

@@ -0,0 +1,2 @@
+export const PROJECT_NAME = process.env.REACT_APP_PROJECT_NAME || 'EMS-ESP';
+export const PROJECT_PATH = process.env.REACT_APP_PROJECT_PATH || 'project';

interface/src/api/features.ts

@@ -0,0 +1,9 @@
+import { AxiosPromise } from 'axios';
+
+import { Features } from '../types';
+
+import { AXIOS } from './endpoints';
+
+export function readFeatures(): AxiosPromise<Features> {
+  return AXIOS.get('/features');
+}

interface/src/api/index.ts

@@ -1,2 +0,0 @@
-export * from './Env';
-export * from './Endpoints';

interface/src/api/mqtt.ts

@@ -0,0 +1,16 @@
+import { AxiosPromise } from 'axios';
+import { MqttSettings, MqttStatus } from '../types';
+
+import { AXIOS } from './endpoints';
+
+export function readMqttStatus(): AxiosPromise<MqttStatus> {
+  return AXIOS.get('/mqttStatus');
+}
+
+export function readMqttSettings(): AxiosPromise<MqttSettings> {
+  return AXIOS.get('/mqttSettings');
+}
+
+export function updateMqttSettings(ntpSettings: MqttSettings): AxiosPromise<MqttSettings> {
+  return AXIOS.post('/mqttSettings', ntpSettings);
+}

interface/src/api/network.ts

@@ -0,0 +1,25 @@
+import { AxiosPromise } from 'axios';
+
+import { WiFiNetworkList, NetworkSettings, NetworkStatus } from '../types';
+
+import { AXIOS } from './endpoints';
+
+export function readNetworkStatus(): AxiosPromise<NetworkStatus> {
+  return AXIOS.get('/networkStatus');
+}
+
+export function scanNetworks(): AxiosPromise<void> {
+  return AXIOS.get('/scanNetworks');
+}
+
+export function listNetworks(): AxiosPromise<WiFiNetworkList> {
+  return AXIOS.get('/listNetworks');
+}
+
+export function readNetworkSettings(): AxiosPromise<NetworkSettings> {
+  return AXIOS.get('/networkSettings');
+}
+
+export function updateNetworkSettings(wifiSettings: NetworkSettings): AxiosPromise<NetworkSettings> {
+  return AXIOS.post('/networkSettings', wifiSettings);
+}

interface/src/api/ntp.ts

@@ -0,0 +1,20 @@
+import { AxiosPromise } from 'axios';
+import { NTPSettings, NTPStatus, Time } from '../types';
+
+import { AXIOS } from './endpoints';
+
+export function readNTPStatus(): AxiosPromise<NTPStatus> {
+  return AXIOS.get('/ntpStatus');
+}
+
+export function readNTPSettings(): AxiosPromise<NTPSettings> {
+  return AXIOS.get('/ntpSettings');
+}
+
+export function updateNTPSettings(ntpSettings: NTPSettings): AxiosPromise<NTPSettings> {
+  return AXIOS.post('/ntpSettings', ntpSettings);
+}
+
+export function updateTime(time: Time): AxiosPromise<Time> {
+  return AXIOS.post('/time', time);
+}

interface/src/api/security.ts

@@ -0,0 +1,17 @@
+import { AxiosPromise } from 'axios';
+
+import { SecuritySettings, Token } from '../types';
+
+import { AXIOS } from './endpoints';
+
+export function readSecuritySettings(): AxiosPromise<SecuritySettings> {
+  return AXIOS.get('/securitySettings');
+}
+
+export function updateSecuritySettings(securitySettings: SecuritySettings): AxiosPromise<SecuritySettings> {
+  return AXIOS.post('/securitySettings', securitySettings);
+}
+
+export function generateToken(username?: string): AxiosPromise<Token> {
+  return AXIOS.get('/generateToken', { params: { username } });
+}

interface/src/api/system.ts

@@ -0,0 +1,40 @@
+import { AxiosPromise } from 'axios';
+
+import { OTASettings, SystemStatus, LogSettings, LogEntries } from '../types';
+
+import { AXIOS, AXIOS_BIN, FileUploadConfig, uploadFile } from './endpoints';
+
+export function readSystemStatus(timeout?: number): AxiosPromise<SystemStatus> {
+  return AXIOS.get('/systemStatus', { timeout });
+}
+
+export function restart(): AxiosPromise<void> {
+  return AXIOS.post('/restart');
+}
+
+export function factoryReset(): AxiosPromise<void> {
+  return AXIOS.post('/factoryReset');
+}
+
+export function readOTASettings(): AxiosPromise<OTASettings> {
+  return AXIOS.get('/otaSettings');
+}
+
+export function updateOTASettings(otaSettings: OTASettings): AxiosPromise<OTASettings> {
+  return AXIOS.post('/otaSettings', otaSettings);
+}
+
+export const uploadFirmware = (file: File, config?: FileUploadConfig): AxiosPromise<void> =>
+  uploadFile('/uploadFirmware', file, config);
+
+export function readLogSettings(): AxiosPromise<LogSettings> {
+  return AXIOS.get('/logSettings');
+}
+
+export function updateLogSettings(logSettings: LogSettings): AxiosPromise<LogSettings> {
+  return AXIOS.post('/logSettings', logSettings);
+}
+
+export function readLogEntries(): AxiosPromise<LogEntries> {
+  return AXIOS_BIN.get('/fetchLog');
+}