Redux toolkit (#115)

* add @redux/toolkit * bump react version to allow for hooks * add remote-redux devtools to help track extension state * add remote-redux server to allow for remote state viewing * setup react-redux for current user * setup watch mode for running redux remote dev watch to options * move screenshots
2021-01-22 16:37:59 -08:00
parent 0c39fbbc79
commit 8ade367b3f
20 changed files with 1859 additions and 22 deletions
--- a/src/config/config.test.ts
+++ b/src/config/config.test.ts
@@ -0,0 +1,51 @@
+import config from './config';
+
+describe('wakatime config', () => {
+  it('snapshot of config', () => {
+    expect(config).toMatchInlineSnapshot(`
+      Object {
+        "alert": Object {
+          "failure": Object {
+            "text": "There was an error while saving the options!",
+            "type": "danger",
+          },
+          "success": Object {
+            "text": "Options have been saved!",
+            "type": "success",
+          },
+        },
+        "colors": Object {
+          "allGood": "",
+          "lightTheme": "white",
+          "notLogging": "gray",
+          "notSignedIn": "red",
+        },
+        "currentUserApiUrl": "https://wakatime.com/api/v1/users/current",
+        "detectionIntervalInSeconds": 60,
+        "heartbeatApiUrl": "https://wakatime.com/api/v1/users/current/heartbeats",
+        "loggingEnabled": true,
+        "loggingStyle": "blacklist",
+        "loggingType": "domain",
+        "logoutUserUrl": "https://wakatime.com/logout",
+        "name": "WakaTime",
+        "states": Array [
+          "allGood",
+          "notLogging",
+          "notSignedIn",
+          "blacklisted",
+          "whitelisted",
+        ],
+        "summariesApiUrl": "https://wakatime.com/api/v1/users/current/summaries",
+        "theme": "light",
+        "tooltips": Object {
+          "allGood": "",
+          "blacklisted": "This URL is blacklisted",
+          "notLogging": "Not logging",
+          "notSignedIn": "Not signed In",
+          "whitelisted": "This URL is not on your whitelist",
+        },
+        "version": "test-version",
+      }
+    `);
+  });
+});
--- a/src/config/config.ts
+++ b/src/config/config.ts
@@ -0,0 +1,150 @@
+/**
+ * Logging
+ */
+export type ApiStates = 'allGood' | 'notLogging' | 'notSignedIn' | 'blacklisted' | 'whitelisted';
+/**
+ * Supported logging style
+ */
+export type LoggingStyle = 'whitelist' | 'blacklist';
+/**
+ * Logging type
+ */
+export type LoggingType = 'domain' | 'url';
+export type SuccessOrFailType = 'success' | 'danger';
+/**
+ * Predefined alert type and text for success and failure.
+ */
+interface Alert {
+  failure: SuccessOrFailAlert;
+  success: SuccessOrFailAlert;
+}
+/**
+ * Define what a sucess or failure shape looks like
+ */
+interface SuccessOrFailAlert {
+  text: string;
+  type: SuccessOrFailType;
+}
+/**
+ *  Different colors for different states of the extension
+ */
+interface Colors {
+  allGood: '';
+  lightTheme: 'white';
+  notLogging: 'gray';
+  notSignedIn: 'red';
+}
+/**
+ * Tooltip messages
+ */
+interface Tooltips {
+  allGood: string;
+  blacklisted: string;
+  notLogging: string;
+  notSignedIn: string;
+  whitelisted: string;
+}
+
+export interface Config {
+  alert: Alert;
+  colors: Colors;
+  /**
+   * Url from which to detect if the user is logged in
+   */
+  currentUserApiUrl: string;
+  /**
+   * Time for idle state of the browser
+   * The user is considered idle if there was
+   * no activity in the browser for x second
+   */
+  detectionIntervalInSeconds: number;
+  /**
+   * Url to which to send the heartbeat
+   */
+  heartbeatApiUrl: string;
+  /**
+   * Is logging enabled
+   */
+  loggingEnabled: boolean;
+  loggingStyle: LoggingStyle;
+  loggingType: LoggingType;
+  /**
+   * Url to logout out of wakatime
+   */
+  logoutUserUrl: string;
+  /**
+   * Extension name
+   */
+  name: string;
+  states: ApiStates[];
+  /**
+   * Get stats from the wakatime api
+   */
+  summariesApiUrl: string;
+  /**
+   * Options for theme
+   */
+  theme: 'light';
+  tooltips: Tooltips;
+  /**
+   * Version of the extension
+   */
+  version: string;
+}
+
+const config: Config = {
+  alert: {
+    failure: {
+      text: 'There was an error while saving the options!',
+      type: 'danger',
+    },
+    success: {
+      text: 'Options have been saved!',
+      type: 'success',
+    },
+  },
+
+  colors: {
+    allGood: '',
+    lightTheme: 'white',
+    notLogging: 'gray',
+    notSignedIn: 'red',
+  },
+
+  currentUserApiUrl:
+    process.env.CURRENT_USER_API_URL ?? 'https://wakatime.com/api/v1/users/current',
+
+  detectionIntervalInSeconds: 60,
+
+  heartbeatApiUrl:
+    process.env.HEART_BEAT_API_URL ?? 'https://wakatime.com/api/v1/users/current/heartbeats',
+
+  loggingEnabled: true,
+
+  loggingStyle: 'blacklist',
+
+  loggingType: 'domain',
+
+  logoutUserUrl: process.env.LOGOUT_USER_URL ?? 'https://wakatime.com/logout',
+
+  name: 'WakaTime',
+
+  states: ['allGood', 'notLogging', 'notSignedIn', 'blacklisted', 'whitelisted'],
+
+  summariesApiUrl:
+    process.env.SUMMARIES_API_URL ?? 'https://wakatime.com/api/v1/users/current/summaries',
+
+  theme: 'light',
+
+  tooltips: {
+    allGood: '',
+    blacklisted: 'This URL is blacklisted',
+    notLogging: 'Not logging',
+    notSignedIn: 'Not signed In',
+    whitelisted: 'This URL is not on your whitelist',
+  },
+
+  version: browser.runtime.getManifest().version,
+};
+
+export default config;