Merge pull request #2921 from MichMich/develop

Release 2.21.0

.editorconfig

@@ -0,0 +1,15 @@
+# editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+max_line_length = 250
+trim_trailing_whitespace = true
+
+[*.{js,json}]
+indent_size = 4
+indent_style = tab

.eslintignore

@@ -1,6 +1 @@
-vendor/*
-!/vendor/vendor.js
-!/modules/default/**
-!/modules/node_helper
-!/modules/node_helper/**
-!/modules/default/defaultmodules.js
+modules/default/calendar/vendor/*

.eslintrc.json

@@ -1,22 +1,31 @@
 {
-	"rules": {
-		"indent": ["error", "tab"],
-		"quotes": ["error", "double"],
-		"max-len": ["error", 250],
-		"curly": "error",
-		"camelcase": ["error", {"properties": "never"}],
-		"no-trailing-spaces": ["error", {"ignoreComments": false }],
-		"no-irregular-whitespace": ["error"]
-	},
+	"extends": ["eslint:recommended", "plugin:prettier/recommended", "plugin:jsdoc/recommended"],
+	"plugins": ["prettier", "jsdoc", "jest"],
 	"env": {
 		"browser": true,
-		"node": true,
-		"es6": true
+		"es6": true,
+		"jest/globals": true,
+		"node": true
+	},
+	"globals": {
+		"config": true,
+		"Log": true,
+		"MM": true,
+		"Module": true,
+		"moment": true
 	},
 	"parserOptions": {
 		"sourceType": "module",
+		"ecmaVersion": 2020,
 		"ecmaFeatures": {
 			"globalReturn": true
 		}
-    }
+	},
+	"rules": {
+		"prettier/prettier": "error",
+		"eqeqeq": "error",
+		"no-prototype-builtins": "off",
+		"no-unused-vars": "off",
+		"no-useless-return": "error"
+	}
 }

.github/CONTRIBUTING.md

@@ -1,40 +1,50 @@
-Contribution Policy for MagicMirror²
-====================================
+# Contribution Policy for MagicMirror²
 
 Thanks for contributing to MagicMirror²!
 
 We hold our code to standard, and these standards are documented below.
 
-If you wish to run both linters, use `grunt` without any arguments.
+## Linters
+
+If you wish to run our linters, use `npm run lint` without any arguments.
 
 ### JavaScript: Run ESLint
 
-We use [ESLint](http://eslint.org) on our JavaScript files.
+We use [ESLint](https://eslint.org) on our JavaScript files.
 
-Our ESLint configuration is in our .eslintrc.json and .eslintignore files.
+Our ESLint configuration is in our `.eslintrc.json` and `.eslintignore` files.
 
-To run ESLint, use `grunt eslint`.
+To run ESLint, use `npm run lint:js`.
 
 ### CSS: Run StyleLint
 
-We use [StyleLint](http://stylelint.io) to lint our CSS. Our configuration is in our .stylelintrc file.
+We use [StyleLint](https://stylelint.io) to lint our CSS. Our configuration is in our .stylelintrc file.
 
-To run StyleLint, use `grunt stylelint`.
+To run StyleLint, use `npm run lint:css`.
 
-### Submitting Issues
+## Testing
+
+We use [Jest](https://jestjs.io) for JavaScript testing.
+
+To run all tests, use `npm run test`.
+
+The specific test commands are defined in `package.json`. So you can also run the specific tests with other commands, e.g. `npm run test:unit` or `npx jest tests/e2e/env_spec.js`.
+
+## Submitting Issues
 
 Please only submit reproducible issues.
 
 If you're not sure if it's a real bug or if it's just you, please open a topic on the forum: [https://forum.magicmirror.builders/category/15/bug-hunt](https://forum.magicmirror.builders/category/15/bug-hunt)
+
 Problems installing or configuring your MagicMirror? Check out: [https://forum.magicmirror.builders/category/10/troubleshooting](https://forum.magicmirror.builders/category/10/troubleshooting)
 
 When submitting a new issue, please supply the following information:
 
-**Platform**: Place your platform here... give us your web browser/Electron version *and* your hardware (Raspberry Pi 2/3, Windows, Mac, Linux, System V UNIX).
+**Platform**: Place your platform here... give us your web browser/Electron version _and_ your hardware (Raspberry Pi 2/3/4, Windows, Mac, Linux, System V UNIX).
 
-**Node Version**: Make sure it's version 0.12.13 or later.
+**Node Version**: Make sure it's version 14 or later (recommended is 16).
 
-**MagicMirror Version**: Now that the versions have split, tell us if you are using the PHP version (v1) or the newer JavaScript version (v2).
+**MagicMirror² Version**: Please let us know which version of MagicMirror² you are running. It can be found in the `package.json` file.
 
 **Description**: Provide a detailed description about the issue and include specific details to help us understand the problem. Adding screenshots will help describing the problem.
 

.github/FUNDING.yaml

@@ -0,0 +1,2 @@
+github: MichMich
+custom: ["https://magicmirror.builders/#donate"]

.github/ISSUE_TEMPLATE.md

@@ -1,15 +1,39 @@
-Please only submit reproducible issues. 
+Hello and thank you for opening an issue.
+
+**Please make sure that you have read the following lines before submitting your Issue:**
+
+## I'm not sure if this is a bug
 
 If you're not sure if it's a real bug or if it's just you, please open a topic on the forum: [https://forum.magicmirror.builders/category/15/bug-hunt](https://forum.magicmirror.builders/category/15/bug-hunt)
+
+## I'm having troubles installing or configuring MagicMirror
+
 Problems installing or configuring your MagicMirror? Check out: [https://forum.magicmirror.builders/category/10/troubleshooting](https://forum.magicmirror.builders/category/10/troubleshooting)
 
+A common problem is that your config file could be invalid. Please run in your MagicMirror² directory: `npm run config:check` and see if it reports an error.
+
+## I found a bug in the MagicMirror² installer
+
+If you are facing an issue or found a bug while trying to install MagicMirror² via the installer please report it in the respective GitHub repository:
+[https://github.com/sdetweil/MagicMirror_scripts](https://github.com/sdetweil/MagicMirror_scripts)
+
+## I found a bug in the MagicMirror² Docker image
+
+If you are facing an issue or found a bug while running MagicMirror² inside a Docker container please create an issue in the corresponding repository:
+[https://gitlab.com/khassel/magicmirror](https://gitlab.com/khassel/magicmirror)
+
+---
+
+## I found a bug in MagicMirror
+
+Please make sure to only submit reproducible issues. You can safely remove everything above the dividing line.
 When submitting a new issue, please supply the following information:
 
-**Platform**: Place your platform here... give us your web browser/Electron version *and* your hardware (Raspberry Pi 2/3, Windows, Mac, Linux, System V UNIX).
+**Platform**: Place your platform here... give us your web browser/Electron version _and_ your hardware (Raspberry Pi 2/3/4, Windows, Mac, Linux, System V UNIX).
 
-**Node Version**: Make sure it's version 0.12.13 or later.
+**Node Version**: Make sure it's version 14 or later (recommended is 16).
 
-**MagicMirror Version**: Now that the versions have split, tell us if you are using the PHP version (v1) or the newer JavaScript version (v2).
+**MagicMirror² Version**: Please let us know which version of MagicMirror² you are running. It can be found in the `package.json` file.
 
 **Description**: Provide a detailed description about the issue and include specific details to help us understand the problem. Adding screenshots will help describing the problem.
 

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,14 +1,25 @@
-> Please send your pull requests the develop branch.
-> Don't forget to add the change to CHANGELOG.md.
+Hello and thank you for wanting to contribute to the MagicMirror² project
+
+**Please make sure that you have followed these 4 rules before submitting your Pull Request:**
+
+> 1. Base your pull requests against the `develop` branch.
+>
+> 2. Include these infos in the description:
+>
+> - Does the pull request solve a **related** issue?
+> - If so, can you reference the issue like this `Fixes #<issue_number>`?
+> - What does the pull request accomplish? Use a list if needed.
+> - If it includes major visual changes please add screenshots.
+>
+> 3. Please run `npm run lint:prettier` before submitting so that
+>    style issues are fixed.
+>
+> 4. Don't forget to add an entry about your changes to
+>    the CHANGELOG.md file.
 
 **Note**: Sometimes the development moves very fast. It is highly
 recommended that you update your branch of `develop` before creating a
 pull request to send us your changes. This makes everyone's lives
 easier (including yours) and helps us out on the development team.
-Thanks!
 
-
-* Does the pull request solve a **related** issue?
-* If so, can you reference the issue?
-* What does the pull request accomplish? Use a list if needed.
-* If it includes major visual changes please add screenshots.
+Thanks again and have a nice day!

.github/codecov.yaml

@@ -0,0 +1,6 @@
+coverage:
+  status:
+    project:
+      default:
+        # advanced settings
+        informational: true

.github/dependabot.yaml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/stale.yaml

@@ -0,0 +1,19 @@
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 60
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 7
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - pinned
+  - security
+  - under investigation
+  - pr welcome
+# Label to use when marking an issue as stale
+staleLabel: wontfix
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: false

.github/workflows/automated-tests.yaml

@@ -0,0 +1,39 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: "Run Automated Tests"
+
+on:
+  push:
+    branches: [master, develop]
+  pull_request:
+    branches: [master, develop]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    strategy:
+      matrix:
+        node-version: [14.x, 16.x, 18.x]
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: "npm"
+      - name: Install dependencies and run tests
+        run: |
+          Xvfb :99 -screen 0 1024x768x16 &
+          export DISPLAY=:99
+          npm run install-mm:dev
+          touch css/custom.css
+          npm run test:prettier
+          npm run test:js
+          npm run test:css
+          npm run test

.github/workflows/codecov-test-suites.yaml

@@ -0,0 +1,33 @@
+# This workflow runs the automated test and uploads the coverage results to codecov.io
+# For more information see: https://github.com/codecov/codecov-action
+
+name: "Run Codecov Tests"
+
+on:
+  push:
+    branches: [master, develop]
+  pull_request:
+    branches: [master, develop]
+
+permissions:
+  contents: read
+
+jobs:
+  run-and-upload-coverage-report:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Install dependencies and run coverage
+        run: |
+          Xvfb :99 -screen 0 1024x768x16 &
+          export DISPLAY=:99
+          npm ci
+          touch css/custom.css
+          npm run test:coverage
+      - name: Upload coverage results to codecov
+        uses: codecov/codecov-action@v3
+        with:
+          files: ./coverage/lcov.info
+          fail_ci_if_error: true

.github/workflows/enforce-changelog.yaml

@@ -0,0 +1,19 @@
+# This workflow enforces the update of a changelog file on every pull request
+# For more information see: https://github.com/dangoslen/changelog-enforcer
+
+name: "Enforce Changelog"
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review, labeled, unlabeled]
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - name: Enforce changelog️
+        uses: dangoslen/changelog-enforcer@v3
+        with:
+          changeLogPath: "CHANGELOG.md"
+          skipLabels: "Skip Changelog"

.gitignore

@@ -1,5 +1,4 @@
 # Various Node ignoramuses.
-
 logs
 *.log
 npm-debug.log*
@@ -8,13 +7,16 @@ pids
 *.seed
 lib-cov
 coverage
-.grunt
 .lock-wscript
 build/Release
-node_modules
+/node_modules/**/*
+fonts/node_modules/**/*
+vendor/node_modules/**/*
+!/tests/node_modules/**/*
 jspm_modules
 .npm
 .node_repl_history
+.nyc_output/
 
 # Visual Studio Code ignoramuses.
 .vscode/
@@ -52,17 +54,10 @@ Temporary Items
 .apdisk
 
 # Various Linux ignoramuses.
-
 .fuse_hidden*
 .directory
 .Trash-*
 
-# Various Magic Mirror ignoramuses and anti-ignoramuses.
-
-# Don't ignore the node_helper core module.
-!/modules/node_helper
-!/modules/node_helper/**
-
 # Ignore all modules except the default modules.
 /modules/**
 !/modules/default
@@ -72,6 +67,10 @@ Temporary Items
 # Ignore changes to the custom css files.
 /css/custom.css
 
+# Ignore users config file but keep the sample.
+/config/*
+!/config/config.js.sample
+
 # Vim
 ## swap
 [._]*.s[a-w][a-z]

.husky/pre-commit

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+[ -f "$(dirname "$0")/_/husky.sh" ] && . "$(dirname "$0")/_/husky.sh"
+
+if command -v npm &> /dev/null; then
+  npm run lint:staged
+fi

.prettierignore

@@ -0,0 +1,4 @@
+/config
+/coverage
+.nyc_output
+package-lock.json

.prettierrc.json

@@ -0,0 +1,3 @@
+{
+	"trailingComma": "none"
+}

.snyk

@@ -1,14 +0,0 @@
-version: v1.5.2
-ignore: {}
-patch:
-  'npm:minimatch:20160620':
-    - snyk > recursive-readdir > minimatch:
-        patched: '2016-07-30T14:02:31.280Z'
-  'npm:negotiator:20160616':
-    - socket.io > engine.io > accepts > negotiator:
-        patched: '2016-07-30T14:02:31.280Z'
-  'npm:ws:20160624':
-    - socket.io > engine.io > ws:
-        patched: '2016-07-30T14:02:31.280Z'
-    - socket.io > socket.io-client > engine.io-client > ws:
-        patched: '2016-07-30T14:02:31.280Z'

.stylelintrc

@@ -1,5 +0,0 @@
-{
-	"extends": "stylelint-config-standard",
-	"font-family-name-quotes": "double-where-recommended",
-	"block-no-empty": false
-}

.stylelintrc.json

@@ -0,0 +1,7 @@
+{
+	"extends": ["stylelint-prettier/recommended"],
+	"plugins": ["stylelint-prettier"],
+	"rules": {
+		"prettier/prettier": true
+	}
+}

.travis.yml

@@ -1,18 +0,0 @@
-language: node_js
-node_js:
- - "7"
-before_script:
- - yarn danger ci
- - npm install grunt-cli -g
- - "export DISPLAY=:99.0"
- - "sh -e /etc/init.d/xvfb start"
- - sleep 5
-script:
-- grunt
-- npm run test:unit
-- npm run test:e2e
-after_script:
- - npm list
-cache:
- directories:
-  - node_modules

Gruntfile.js

@@ -1,104 +0,0 @@
-module.exports = function(grunt) {
-	require("time-grunt")(grunt);
-	grunt.initConfig({
-		pkg: grunt.file.readJSON("package.json"),
-		eslint: {
-			options: {
-				configFile: ".eslintrc.json"
-			},
-			target: [
-				"js/*.js",
-				"modules/default/*.js",
-				"modules/default/*/*.js",
-				"serveronly/*.js",
-				"clientonly/*.js",
-				"*.js",
-				"tests/**/*.js",
-				"!modules/default/alert/notificationFx.js",
-				"!modules/default/alert/modernizr.custom.js",
-				"!modules/default/alert/classie.js",
-				"config/*",
-				"translations/translations.js",
-				"vendor/vendor.js",
-				"modules/node_modules/node_helper/index.js"
-			]
-		},
-		stylelint: {
-			simple: {
-				options: {
-					configFile: ".stylelintrc"
-				},
-				src: [
-					"css/main.css",
-					"modules/default/calendar/calendar.css",
-					"modules/default/clock/clock_styles.css",
-					"modules/default/currentweather/currentweather.css",
-					"modules/default/weatherforcast/weatherforcast.css"
-				]
-			}
-		},
-		jsonlint: {
-			main: {
-				src: [
-					"package.json",
-					".eslintrc.json",
-					".stylelintrc",
-					"translations/*.json",
-					"modules/default/*/translations/*.json",
-					"installers/pm2_MagicMirror.json",
-					"vendor/package.js"
-				],
-				options: {
-					reporter: "jshint"
-				}
-			}
-		},
-		markdownlint: {
-			all: {
-				options: {
-					config: {
-						"default": true,
-						"line-length": false,
-						"blanks-around-headers": false,
-						"no-duplicate-header": false,
-						"no-inline-html": false,
-						"MD010": false,
-						"MD001": false,
-						"MD031": false,
-						"MD040": false,
-						"MD002": false,
-						"MD029": false,
-						"MD041": false,
-						"MD032": false,
-						"MD036": false,
-						"MD037": false,
-						"MD009": false,
-						"MD018": false,
-						"MD012": false,
-						"MD026": false,
-						"MD038": false
-					}
-				},
-				src: [
-					"README.md",
-					"CHANGELOG.md",
-					"LICENSE.md",
-					"modules/README.md",
-					"modules/default/**/*.md",
-					"!modules/default/calendar/vendor/ical.js/readme.md"
-				]
-			}
-		},
-		yamllint: {
-			all: [
-				".travis.yml"
-			]
-		}
-	});
-	grunt.loadNpmTasks("grunt-eslint");
-	grunt.loadNpmTasks("grunt-stylelint");
-	grunt.loadNpmTasks("grunt-jsonlint");
-	grunt.loadNpmTasks("grunt-yamllint");
-	grunt.loadNpmTasks("grunt-markdownlint");
-	grunt.registerTask("default", ["eslint", "stylelint", "jsonlint", "markdownlint", "yamllint"]);
-};

LICENSE.md

@@ -1,7 +1,6 @@
-The MIT License (MIT)
-=====================
+# The MIT License (MIT)
 
-Copyright © 2016-2017 Michael Teeuw
+Copyright © 2016-2022 Michael Teeuw
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

README.md

@@ -1,219 +1,56 @@
 ![MagicMirror²: The open source modular smart mirror platform. ](.github/header.png)
 
-<p align="center">
-	<a href="https://david-dm.org/MichMich/MagicMirror"><img src="https://david-dm.org/MichMich/MagicMirror.svg" alt="Dependency Status"></a>
-	<a href="https://david-dm.org/MichMich/MagicMirror#info=devDependencies"><img src="https://david-dm.org/MichMich/MagicMirror/dev-status.svg" alt="devDependency Status"></a>
-	<a href="https://bestpractices.coreinfrastructure.org/projects/347"><img src="https://bestpractices.coreinfrastructure.org/projects/347/badge"></a>
-	<a href="http://choosealicense.com/licenses/mit"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License"></a>
-	<a href="https://travis-ci.org/MichMich/MagicMirror"><img src="https://travis-ci.org/MichMich/MagicMirror.svg" alt="Travis"></a>
-	<a href="https://snyk.io/test/github/MichMich/MagicMirror"><img src="https://snyk.io/test/github/MichMich/MagicMirror/badge.svg" alt="Known Vulnerabilities" data-canonical-src="https://snyk.io/test/github/MichMich/MagicMirror" style="max-width:100%;"></a>
-	<a href="http://slack.magicmirror.builders"><img src="http://slack.magicmirror.builders:3000/badge.svg" alt="Slack Status"></a>
+<p style="text-align: center">
+  <a href="https://choosealicense.com/licenses/mit">
+		<img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License">
+	</a>
+	<img src="https://img.shields.io/github/workflow/status/michmich/magicmirror/Run%20Automated%20Tests" alt="GitHub Actions">
+	<img src="https://img.shields.io/github/checks-status/michmich/magicmirror/master" alt="Build Status">
+	<a href="https://codecov.io/gh/MichMich/MagicMirror">
+		<img src="https://codecov.io/gh/MichMich/MagicMirror/branch/master/graph/badge.svg?token=LEG1KitZR6" alt="CodeCov Status"/>
+	</a>
+	<a href="https://github.com/MichMich/MagicMirror">
+		<img src="https://img.shields.io/github/stars/michmich/magicmirror?style=social">
+	</a>
 </p>
 
-**MagicMirror²** is an open source modular smart mirror platform. With a growing list of installable modules, the **MagicMirror²** allows you to convert your hallway or bathroom mirror into your personal assistant. **MagicMirror²** is built by the creator of [the original MagicMirror](http://michaelteeuw.nl/tagged/magicmirror) with the incredible help of a [growing community of contributors](https://github.com/MichMich/MagicMirror/graphs/contributors).
+**MagicMirror²** is an open source modular smart mirror platform. With a growing list of installable modules, the **MagicMirror²** allows you to convert your hallway or bathroom mirror into your personal assistant. **MagicMirror²** is built by the creator of [the original MagicMirror](https://michaelteeuw.nl/tagged/magicmirror) with the incredible help of a [growing community of contributors](https://github.com/MichMich/MagicMirror/graphs/contributors).
 
-MagicMirror² focuses on a modular plugin system and uses [Electron](http://electron.atom.io/) as an application wrapper. So no more web server or browser installs necessary!
+MagicMirror² focuses on a modular plugin system and uses [Electron](https://www.electronjs.org/) as an application wrapper. So no more web server or browser installs necessary!
 
-## Table Of Contents
+## Documentation
 
-- [Installation](#installation)
-  - [Raspberry Pi](#raspberry-pi)
-  - [General](#general)
-  - [Server Only](#server-only)
-  - [Client Only](#client-only)
-  - [Docker](#docker)
-- [Configuration](#configuration)
-- [Modules](#modules)
-- [Updating](#updating)
-- [Known Issues](#known-issues)
-- [Community](#community)
-- [Contributing Guidelines](#contributing-guidelines)
-- [Manifesto](#manifesto)
+For the full documentation including **[installation instructions](https://docs.magicmirror.builders/getting-started/installation.html)**, please visit our dedicated documentation website: [https://docs.magicmirror.builders](https://docs.magicmirror.builders).
 
-## Installation
+## Links
 
-### Raspberry Pi
-
-#### Automatic Installation (Raspberry Pi only!)
-
-*Electron*, the app wrapper around MagicMirror², only supports the Raspberry Pi 2/3. The Raspberry Pi 0/1 is currently **not** supported. If you want to run this on a Raspberry Pi 1, use the [server only](#server-only) feature and setup a fullscreen browser yourself. (Yes, people have managed to run MM² also on a Pi0, so if you insist, search in the forums.)
-
-Note that you will need to install the lastest full version of Raspbian, **don't use the Lite version**.
-
-Execute the following command on your Raspberry Pi to install MagicMirror²:
-
-```bash
-bash -c "$(curl -sL https://raw.githubusercontent.com/MichMich/MagicMirror/master/installers/raspberry.sh)"
-```
-
-#### Manual Installation
-
-1. Download and install the latest *Node.js* version.
-2. Clone the repository and check out the master branch: `git clone https://github.com/MichMich/MagicMirror`
-3. Enter the repository: `cd MagicMirror/`
-4. Install and run the app with: `npm install && npm start` \
-   For **Server Only** use: `npm install && node serveronly` .
-
-
-**:warning: Important!**
-
-- **The installation step for `npm install` will take a very long time**, often with little or no terminal response! \
-  For the RPi3 this is **~10** minutes and for the Rpi2 **~25** minutes. \
-  Do not interrupt or you risk getting a :broken_heart: by Raspberry Jam.
-
-
-Also note that:
-
-- `npm start` does **not** work via SSH. But you can use `DISPLAY=:0 nohup npm start &` instead. \
-  This starts the mirror on the remote display.
-- If you want to debug on Raspberry Pi you can use `npm start dev` which will start MM with *Dev Tools* enabled.
-- To access toolbar menu when in mirror mode, hit `ALT` key.
-- To toggle the (web) `Developer Tools` from mirror mode, use `CTRL-SHIFT-I` or `ALT` and select `View`.
-
-
-### Server Only
-
-In some cases, you want to start the application without an actual app window. In this case, you can start MagicMirror² in server only mode by manually running `node serveronly` or using Docker. This will start the server, after which you can open the application in your browser of choice. Detailed description below.
-
-**Important:** Make sure that you whitelist the interface/ip (`ipWhitelist`) in the server config where you want the client to connect to, otherwise it will not be allowed to connect to the server. You also need to set the local host `address` field to `0.0.0.0` in order for the RPi to listen on all interfaces and not only `localhost` (default).
-
-```javascript
-var config = {
-	address: "0.0.0.0",	// default is "localhost"
-	port: 8080,		// default
-	ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1", "::ffff:172.17.0.1"], // default -- need to add your IP here
-	...
-};
-```
-
-
-### Client Only
-
-This is when you already have a server running remotely and want your RPi to connect as a standalone client to this instance, to show the MM from the server. Then from your RPi, you run it with: `node clientonly --address 192.168.1.5 --port 8080`. (Specify the ip address and port number of the server)
-
-
-### Docker
-
-MagicMirror² in server only mode can be deployed using [Docker](https://docker.com). After a successful [Docker installation](https://docs.docker.com/engine/installation/) you just need to execute the following command in the shell:
-
-```bash
-docker run  -d \
-	--publish 80:8080 \
-	--restart always \
-	--volume ~/magic_mirror/config:/opt/magic_mirror/config \
-	--volume ~/magic_mirror/modules:/opt/magic_mirror/modules \
-	--name magic_mirror \
-	bastilimbach/docker-magicmirror
-```
-To get more information about the available Dockerfile versions and configurations head over to the respective [GitHub repository](https://github.com/bastilimbach/docker-MagicMirror).
-
-
-## Configuration
-
-### Raspberry Specific
-
-The following wiki links are helpful for the initial configuration of your MagicMirror² operating system:
-- [Configuring the Raspberry Pi](https://github.com/MichMich/MagicMirror/wiki/Configuring-the-Raspberry-Pi)
-- [Auto Starting MagicMirror](https://github.com/MichMich/MagicMirror/wiki/Auto-Starting-MagicMirror)
-
-
-### General
-
-1. Copy `/home/pi/MagicMirror/config/config.js.sample` to `/home/pi/MagicMirror/config/config.js`. \
-   **Note:** If you used the installer script. This step is already done for you.
-
-2. Modify your required settings. \
-   Note: You'll can check your configuration running `npm run config:check` in `/home/pi/MagicMirror`.
-
-
-The following properties can be configured:
-
-| **Option** | **Description** |
-| --- | --- |
-| `port` | The port on which the MagicMirror² server will run on. The default value is `8080`. |
-| `address` | The *interface* ip address on which to accept connections. The default is `localhost`, which would prevent exposing the built-in webserver to machines on the local network. To expose it to other machines, use: `0.0.0.0`. |
-| `ipWhitelist` | The list of IPs from which you are allowed to access the MagicMirror². The default value is `["127.0.0.1", "::ffff:127.0.0.1", "::1"]`, which is from `localhost` only. Add your IP when needed. You can also specify IP ranges with subnet masks (`["127.0.0.1", "127.0.0.1/24"]`) or directly with (`["127.0.0.1", ["192.168.0.1", "192.168.0.100"]]`). Set `[]` to allow all IP addresses. For more information see: [follow post ipWhitelist HowTo](https://forum.magicmirror.builders/topic/1326/ipwhitelist-howto) |
-| `zoom` | This allows to scale the mirror contents with a given zoom factor. The default value is `1.0`|
-| `language` | The language of the interface. (Note: Not all elements will be localized.) Possible values are `en`, `nl`, `ru`, `fr`, etc., but the default value is `en`. |
-| `timeFormat` | The form of time notation that will be used. Possible values are `12` or `24`. The default is `24`. |
-| `units` | The units that will be used in the default weather modules. Possible values are `metric` or `imperial`. The default is `metric`. |
-| `modules` | An array of active modules. **The array must contain objects. See the next table below for more information.** |
-| `electronOptions` | An optional array of Electron (browser) options. This allows configuration of e.g. the browser screen size and position (example: `electronOptions: { fullscreen: false, width: 800, height: 600 }`). Kiosk mode can be enabled by setting `kiosk = true`, `autoHideMenuBar = false` and `fullscreen = false`. More options can be found [here](https://github.com/electron/electron/blob/master/docs/api/browser-window.md). |
-| `customCss` | The path of the `custom.css` stylesheet. The default is `css/custom.css`. |
-
-Module configuration:
-
-| **Option** | **Description** |
-| --- | --- |
-| `module` | The name of the module. This can also contain the subfolder. Valid examples include `clock`, `default/calendar` and `custommodules/mymodule`. |
-| `position` | The location of the module in which the module will be loaded. Possible values are `top_bar`, `top_left`, `top_center`, `top_right`, `upper_third`, `middle_center`, `lower_third`, `bottom_left`, `bottom_center`, `bottom_right`, `bottom_bar`, `fullscreen_above`, and `fullscreen_below`. This field is optional but most modules require this field to set. Check the documentation of the module for more information. Multiple modules with the same position will be ordered based on the order in the configuration file. |
-| `classes` | Additional classes which are passed to the module. The field is optional. |
-| `header` | To display a header text above the module, add the header property. This field is optional. |
-| `disabled` | Set disabled to `true` to skip creating the module. This field is optional. |
-| `config` | An object with the module configuration properties. Check the documentation of the module for more information. This field is optional, unless the module requires extra configuration. |
-
-## Modules
-
-The following modules are installed by default.
-
-- [**Clock**](modules/default/clock)
-- [**Calendar**](modules/default/calendar)
-- [**Current Weather**](modules/default/currentweather)
-- [**Weather Forecast**](modules/default/weatherforecast)
-- [**News Feed**](modules/default/newsfeed)
-- [**Compliments**](modules/default/compliments)
-- [**Hello World**](modules/default/helloworld)
-- [**Alert**](modules/default/alert)
-
-For more available modules, check out out the wiki page [MagicMirror² 3rd Party Modules](https://github.com/MichMich/MagicMirror/wiki/3rd-party-modules). If you want to build your own modules, check out the [MagicMirror² Module Development Documentation](modules) and don't forget to add it to the wiki and the [forum](https://forum.magicmirror.builders/category/7/showcase)!
-
-
-## Updating
-
-If you want to update your MagicMirror² to the latest version, use your terminal to go to your Magic Mirror folder and type the following command:
-
-```bash
-git pull && npm install
-```
-
-If you changed nothing more than the config or the modules, this should work without any problems.
-Type `git status` to see your changes, if there are any, you can reset them with `git reset --hard`. After that, git pull should be possible.
-
-
-## Community
-
-The community around the MagicMirror² is constantly growing. We even have a [forum](https://forum.magicmirror.builders) now where you can share your ideas, ask questions, help others and get inspired by other builders. We would love to see you there!
+- Website: [https://magicmirror.builders](https://magicmirror.builders)
+- Documentation: [https://docs.magicmirror.builders](https://docs.magicmirror.builders)
+- Forum: [https://forum.magicmirror.builders](https://forum.magicmirror.builders)
+  - Technical discussions: https://forum.magicmirror.builders/category/11/core-system
+- Discord: [https://discord.gg/J5BAtvx](https://discord.gg/J5BAtvx)
+- Blog: [https://michaelteeuw.nl/tagged/magicmirror](https://michaelteeuw.nl/tagged/magicmirror)
+- Donations: [https://magicmirror.builders/#donate](https://magicmirror.builders/#donate)
 
 ## Contributing Guidelines
 
-Contributions of all kinds are welcome, not only in the form of code but also with regards bug reports and documentation.
+Contributions of all kinds are welcome, not only in the form of code but also with regards to
 
-Please keep the following in mind:
+- bug reports
+- documentation
+- translations
 
-- **Bug Reports**:  Make sure you're running the latest version. If the issue(s) still persist: please open a clearly documented issue with a clear title.
-- **Minor Bug Fixes**: Please send a pull request with a clear explanation of the issue or a link to the issue it solves.
-- **Major Bug Fixes**: please discuss your approach in an GitHub issue before you start to alter a big part of the code.
-- **New Features**: please please discuss in a GitHub issue before you start to alter a big part of the code. Without discussion upfront, the pull request will not be accepted / merged.
+For the full contribution guidelines, check out: [https://docs.magicmirror.builders/about/contributing.html](https://docs.magicmirror.builders/about/contributing.html)
 
-Thanks for your help in making MagicMirror² better!
+## Enjoying MagicMirror? Consider a donation!
 
-## Manifesto
+MagicMirror² is opensource and free. That doesn't mean we don't need any money.
 
-A real Manifesto is still to be written. Till then, Michael's response on [one of the repository issues](https://github.com/MichMich/MagicMirror/issues/1174) gives a great summary:
+Please consider a donation to help us cover the ongoing costs like webservers and email services.
+If we receive enough donations we might even be able to free up some working hours and spend some extra time improving the MagicMirror² core.
 
-> "... I started this project as an ultimate starter project for Raspberry Pi enthusiasts. As a matter of fact, for most of the contributors, the MagicMirror project is the first open source project they ever contributed to. This is one of the reasons why the MagicMirror project is featured in several RasPi magazines.
->
->The project has a lot of opportunities for improvement. We could use a powerful framework like Vue to ramp up the development speed. We could use SASS for better/easier css implementations. We could make it an NPM installable package. And as you say, we could bundle it up. The big downside of of of these changes is that it over complicates things: a user no longer will be able to open just one file and make a small modification and see how it works out.
->
->Of course, a bundled version can be complimentary to the regular un-bundled version. And I'm sure a lot of (new) users will opt for the bundled version. But this means those users won't be motivated to take a peek under the hood. They will just remain 'users'. They won't become contributors, and worse: they won't be motivated to take their first steps in software development.
->
->And to be honest: motivating curious users to step out of their comfort zone and take those first steps is what drives me in this project. Therefor my ultimate goal is this project is to keep it as accessible as possible."
->
-> ~ Michael Teeuw
+To donate, please follow [this](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=G5D8E9MR5DTD2&source=url) link.
 
-
-
-<p align="center">
-<br>
+<p style="text-align: center">
 	<a href="https://forum.magicmirror.builders/topic/728/magicmirror-is-voted-number-1-in-the-magpi-top-50"><img src="https://magicmirror.builders/img/magpi-best-watermark-custom.png" width="150" alt="MagPi Top 50"></a>
 </p>

clientonly/index.js

@@ -1,56 +1,77 @@
-/* jshint esversion: 6 */
-
 "use strict";
 
-// Use seperate scope to prevent global scope pollution
+// Use separate scope to prevent global scope pollution
 (function () {
-	var config = {};
+	const config = {};
 
-	// Helper function to get server address/hostname from either the commandline or env
+	/**
+	 * Helper function to get server address/hostname from either the commandline or env
+	 */
 	function getServerAddress() {
-		// Helper function to get command line parameters
-		// Assumes that a cmdline parameter is defined with `--key [value]`
+		/**
+		 * Get command line parameters
+		 * Assumes that a cmdline parameter is defined with `--key [value]`
+		 *
+		 * @param {string} key key to look for at the command line
+		 * @param {string} defaultValue value if no key is given at the command line
+		 * @returns {string} the value of the parameter
+		 */
 		function getCommandLineParameter(key, defaultValue = undefined) {
-			var index = process.argv.indexOf(`--${key}`);
-			var value = index > -1 ? process.argv[index + 1] : undefined;
+			const index = process.argv.indexOf(`--${key}`);
+			const value = index > -1 ? process.argv[index + 1] : undefined;
 			return value !== undefined ? String(value) : defaultValue;
 		}
 
 		// Prefer command line arguments over environment variables
 		["address", "port"].forEach((key) => {
 			config[key] = getCommandLineParameter(key, process.env[key.toUpperCase()]);
-		})
+		});
+
+		// determine if "--use-tls"-flag was provided
+		config["tls"] = process.argv.indexOf("--use-tls") > 0;
 	}
 
+	/**
+	 * Gets the config from the specified server url
+	 *
+	 * @param {string} url location where the server is running.
+	 * @returns {Promise} the config
+	 */
 	function getServerConfig(url) {
 		// Return new pending promise
 		return new Promise((resolve, reject) => {
-			// Select http or https module, depending on reqested url
+			// Select http or https module, depending on requested url
 			const lib = url.startsWith("https") ? require("https") : require("http");
 			const request = lib.get(url, (response) => {
-				var configData = "";
+				let configData = "";
 
-				// Gather incomming data
-				response.on("data", function(chunk) {
+				// Gather incoming data
+				response.on("data", function (chunk) {
 					configData += chunk;
 				});
 				// Resolve promise at the end of the HTTP/HTTPS stream
-				response.on("end", function() {
+				response.on("end", function () {
 					resolve(JSON.parse(configData));
 				});
 			});
 
-			request.on("error", function(error) {
+			request.on("error", function (error) {
 				reject(new Error(`Unable to read config from server (${url} (${error.message}`));
 			});
-		})
-	};
+		});
+	}
 
+	/**
+	 * Print a message to the console in case of errors
+	 *
+	 * @param {string} message error message to print
+	 * @param {number} code error code for the exit call
+	 */
 	function fail(message, code = 1) {
 		if (message !== undefined && typeof message === "string") {
 			console.log(message);
 		} else {
-			console.log("Usage: 'node clientonly --address 192.168.1.10 --port 8080'");
+			console.log("Usage: 'node clientonly --address 192.168.1.10 --port 8080 [--use-tls]'");
 		}
 		process.exit(code);
 	}
@@ -58,17 +79,19 @@
 	getServerAddress();
 
 	(config.address && config.port) || fail();
+	const prefix = config.tls ? "https://" : "http://";
 
 	// Only start the client if a non-local server was provided
 	if (["localhost", "127.0.0.1", "::1", "::ffff:127.0.0.1", undefined].indexOf(config.address) === -1) {
-		getServerConfig(`http://${config.address}:${config.port}/config/`)
-			.then(function (config) {
+		getServerConfig(`${prefix}${config.address}:${config.port}/config/`)
+			.then(function (configReturn) {
 				// Pass along the server config via an environment variable
-				var env = Object.create(process.env);
-				var options = { env: env };
-				config.address = config.address;
-				config.port = config.port;
-				env.config = JSON.stringify(config);
+				const env = Object.create(process.env);
+				const options = { env: env };
+				configReturn.address = config.address;
+				configReturn.port = config.port;
+				configReturn.tls = config.tls;
+				env.config = JSON.stringify(configReturn);
 
 				// Spawn electron application
 				const electron = require("electron");
@@ -89,11 +112,10 @@
 				});
 
 				child.on("close", (code) => {
-					if (code != 0) {
+					if (code !== 0) {
 						console.log(`There something wrong. The clientonly is not running code ${code}`);
 					}
 				});
-
 			})
 			.catch(function (reason) {
 				fail(`Unable to connect to server: (${reason})`);
@@ -101,4 +123,4 @@
 	} else {
 		fail();
 	}
-}());
+})();

config/.gitignore

@@ -1,2 +0,0 @@
-*
-!config.js.sample

config/config.js.sample

@@ -1,29 +1,41 @@
-/* Magic Mirror Config Sample
+/* MagicMirror² Config Sample
  *
- * By Michael Teeuw http://michaelteeuw.nl
+ * By Michael Teeuw https://michaelteeuw.nl
  * MIT Licensed.
  *
- * For more information how you can configurate this file
- * See https://github.com/MichMich/MagicMirror#configuration
- *
+ * For more information on how you can configure this file
+ * see https://docs.magicmirror.builders/configuration/introduction.html
+ * and https://docs.magicmirror.builders/modules/configuration.html
  */
-
-var config = {
-	address: "localhost", // Address to listen on, can be:
-	                      // - "localhost", "127.0.0.1", "::1" to listen on loopback interface
-	                      // - another specific IPv4/6 to listen on a specific interface
-	                      // - "", "0.0.0.0", "::" to listen on any interface
-	                      // Default, when address config is left out, is "localhost"
+let config = {
+	address: "localhost", 	// Address to listen on, can be:
+							// - "localhost", "127.0.0.1", "::1" to listen on loopback interface
+							// - another specific IPv4/6 to listen on a specific interface
+							// - "0.0.0.0", "::" to listen on any interface
+							// Default, when address config is left out or empty, is "localhost"
 	port: 8080,
-	ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1"], // Set [] to allow all IP addresses
-	                                                       // or add a specific IPv4 of 192.168.1.5 :
-	                                                       // ["127.0.0.1", "::ffff:127.0.0.1", "::1", "::ffff:192.168.1.5"],
-	                                                       // or IPv4 range of 192.168.3.0 --> 192.168.3.15 use CIDR format :
-	                                                       // ["127.0.0.1", "::ffff:127.0.0.1", "::1", "::ffff:192.168.3.0/28"],
+	basePath: "/", 	// The URL path where MagicMirror² is hosted. If you are using a Reverse proxy
+					// you must set the sub path here. basePath must end with a /
+	ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1"], 	// Set [] to allow all IP addresses
+															// or add a specific IPv4 of 192.168.1.5 :
+															// ["127.0.0.1", "::ffff:127.0.0.1", "::1", "::ffff:192.168.1.5"],
+															// or IPv4 range of 192.168.3.0 --> 192.168.3.15 use CIDR format :
+															// ["127.0.0.1", "::ffff:127.0.0.1", "::1", "::ffff:192.168.3.0/28"],
+
+	useHttps: false, 		// Support HTTPS or not, default "false" will use HTTP
+	httpsPrivateKey: "", 	// HTTPS private key path, only require when useHttps is true
+	httpsCertificate: "", 	// HTTPS Certificate path, only require when useHttps is true
 
 	language: "en",
+	locale: "en-US",
+	logLevel: ["INFO", "LOG", "WARN", "ERROR"], // Add "DEBUG" for even more logging
 	timeFormat: 24,
 	units: "metric",
+	// serverOnly:  true/false/"local" ,
+	// local for armv6l processors, default
+	//   starts serveronly and then starts chrome browser
+	// false, default for all NON-armv6l devices
+	// true, force serveronly mode, because you want to.. no UI on this device
 
 	modules: [
 		{
@@ -44,8 +56,8 @@ var config = {
 			config: {
 				calendars: [
 					{
-						symbol: "calendar-check-o ",
-						url: "webcal://www.calendarlabs.com/templates/ical/US-Holidays.ics"
+						symbol: "calendar-check",
+						url: "webcal://www.calendarlabs.com/ical-calendar/ics/76/US_Holidays.ics"
 					}
 				]
 			}
@@ -55,22 +67,26 @@ var config = {
 			position: "lower_third"
 		},
 		{
-			module: "currentweather",
+			module: "weather",
 			position: "top_right",
 			config: {
+				weatherProvider: "openweathermap",
+				type: "current",
 				location: "New York",
-				locationID: "",  //ID from http://www.openweathermap.org/help/city_list.txt
-				appid: "YOUR_OPENWEATHER_API_KEY"
+				locationID: "5128581", //ID from http://bulk.openweathermap.org/sample/city.list.json.gz; unzip the gz file and find your city
+				apiKey: "YOUR_OPENWEATHER_API_KEY"
 			}
 		},
 		{
-			module: "weatherforecast",
+			module: "weather",
 			position: "top_right",
 			header: "Weather Forecast",
 			config: {
+				weatherProvider: "openweathermap",
+				type: "forecast",
 				location: "New York",
-				locationID: "5128581",  //ID from http://www.openweathermap.org/help/city_list.txt
-				appid: "YOUR_OPENWEATHER_API_KEY"
+				locationID: "5128581", //ID from http://bulk.openweathermap.org/sample/city.list.json.gz; unzip the gz file and find your city
+				apiKey: "YOUR_OPENWEATHER_API_KEY"
 			}
 		},
 		{
@@ -80,15 +96,16 @@ var config = {
 				feeds: [
 					{
 						title: "New York Times",
-						url: "http://www.nytimes.com/services/xml/rss/nyt/HomePage.xml"
+						url: "https://rss.nytimes.com/services/xml/rss/nyt/HomePage.xml"
 					}
 				],
 				showSourceTitle: true,
-				showPublishDate: true
+				showPublishDate: true,
+				broadcastNewsFeeds: true,
+				broadcastNewsUpdates: true
 			}
 		},
 	]
-
 };
 
 /*************** DO NOT EDIT THE LINE BELOW ***************/

css/custom.css

@@ -1,14 +0,0 @@
-/*****************************************************
- * Magic Mirror                                      *
- * Custom CSS                                        *
- *                                                   *
- * By Michael Teeuw http://michaelteeuw.nl           *
- * MIT Licensed.                                     *
- *                                                   *
- * Add any custom CSS below.                         *
- * Changes to this files will be ignored by GIT. *
- *****************************************************/
-
- body {
- 	
- }

css/custom.css.sample

@@ -0,0 +1,31 @@
+/* MagicMirror² Custom CSS Sample
+ *
+ * Change color and fonts here.
+ *
+ * Beware that properties cannot be unitless, so for example write '--gap-body: 0px;' instead of just '--gap-body: 0;'
+ *
+ * MIT Licensed.
+ */
+
+/* Uncomment and adjust accordingly if you want to import another font from the google-fonts-api: */
+/* @import url('https://fonts.googleapis.com/css2?family=Poppins:wght@100;300;400;700&display=swap'); */
+
+:root {
+  --color-text: #999;
+  --color-text-dimmed: #666;
+  --color-text-bright: #fff;
+  --color-background: black;
+
+  --font-primary: "Roboto Condensed";
+  --font-secondary: "Roboto";
+  
+  --font-size: 20px;
+  --font-size-small: 0.75rem;
+
+  --gap-body-top: 60px;
+  --gap-body-right: 60px;
+  --gap-body-bottom: 60px;
+  --gap-body-left: 60px;
+  
+  --gap-modules: 30px;
+}

css/main.css

@@ -1,7 +1,33 @@
+:root {
+  --color-text: #999;
+  --color-text-dimmed: #666;
+  --color-text-bright: #fff;
+  --color-background: #000;
+
+  --font-primary: "Roboto Condensed";
+  --font-secondary: "Roboto";
+
+  --font-size: 20px;
+  --font-size-xsmall: 0.75rem;
+  --font-size-small: 1rem;
+  --font-size-medium: 1.5rem;
+  --font-size-large: 3.25rem;
+  --font-size-xlarge: 3.75rem;
+
+  --gap-body-top: 60px;
+  --gap-body-right: 60px;
+  --gap-body-bottom: 60px;
+  --gap-body-left: 60px;
+
+  --gap-modules: 30px;
+}
+
 html {
   cursor: none;
   overflow: hidden;
-  background: #000;
+  background: var(--color-background);
+  user-select: none;
+  font-size: var(--font-size);
 }
 
 ::-webkit-scrollbar {
@@ -9,16 +35,15 @@ html {
 }
 
 body {
-  margin: 60px;
+  margin: var(--gap-body-top) var(--gap-body-right) var(--gap-body-bottom) var(--gap-body-left);
   position: absolute;
-  height: calc(100% - 120px);
-  width: calc(100% - 120px);
-  background: #000;
-  color: #aaa;
-  font-family: "Roboto Condensed", sans-serif;
+  height: calc(100% - var(--gap-body-top) - var(--gap-body-bottom));
+  width: calc(100% - var(--gap-body-right) - var(--gap-body-left));
+  background: var(--color-background);
+  color: var(--color-text);
+  font-family: var(--font-primary), sans-serif;
   font-weight: 400;
-  font-size: 2em;
-  line-height: 1.5em;
+  line-height: 1.5;
   -webkit-font-smoothing: antialiased;
 }
 
@@ -27,60 +52,60 @@ body {
  */
 
 .dimmed {
-  color: #666;
+  color: var(--color-text-dimmed);
 }
 
 .normal {
-  color: #999;
+  color: var(--color-text);
 }
 
 .bright {
-  color: #fff;
+  color: var(--color-text-bright);
 }
 
 .xsmall {
-  font-size: 15px;
-  line-height: 20px;
+  font-size: var(--font-size-xsmall);
+  line-height: 1.275;
 }
 
 .small {
-  font-size: 20px;
-  line-height: 25px;
+  font-size: var(--font-size-small);
+  line-height: 1.25;
 }
 
 .medium {
-  font-size: 30px;
-  line-height: 35px;
+  font-size: var(--font-size-medium);
+  line-height: 1.225;
 }
 
 .large {
-  font-size: 65px;
-  line-height: 65px;
+  font-size: var(--font-size-large);
+  line-height: 1;
 }
 
 .xlarge {
-  font-size: 75px;
-  line-height: 75px;
+  font-size: var(--font-size-xlarge);
+  line-height: 1;
   letter-spacing: -3px;
 }
 
 .thin {
-  font-family: Roboto, sans-serif;
+  font-family: var(--font-secondary), sans-serif;
   font-weight: 100;
 }
 
 .light {
-  font-family: "Roboto Condensed", sans-serif;
+  font-family: var(--font-primary), sans-serif;
   font-weight: 300;
 }
 
 .regular {
-  font-family: "Roboto Condensed", sans-serif;
+  font-family: var(--font-primary), sans-serif;
   font-weight: 400;
 }
 
 .bold {
-  font-family: "Roboto Condensed", sans-serif;
+  font-family: var(--font-primary), sans-serif;
   font-weight: 700;
 }
 
@@ -94,14 +119,14 @@ body {
 
 header {
   text-transform: uppercase;
-  font-size: 15px;
-  font-family: "Roboto Condensed", Arial, Helvetica, sans-serif;
+  font-size: var(--font-size-xsmall);
+  font-family: var(--font-primary), Arial, Helvetica, sans-serif;
   font-weight: 400;
-  border-bottom: 1px solid #666;
+  border-bottom: 1px solid var(--color-text-dimmed);
   line-height: 15px;
   padding-bottom: 5px;
   margin-bottom: 10px;
-  color: #999;
+  color: var(--color-text);
 }
 
 sup {
@@ -114,11 +139,19 @@ sup {
  */
 
 .module {
-  margin-bottom: 30px;
+  margin-bottom: var(--gap-modules);
+}
+
+.module.hidden {
+  pointer-events: none;
+}
+
+.module:not(.hidden) {
+  pointer-events: auto;
 }
 
 .region.bottom .module {
-  margin-top: 30px;
+  margin-top: var(--gap-modules);
   margin-bottom: 0;
 }
 
@@ -128,6 +161,10 @@ sup {
   text-overflow: ellipsis;
 }
 
+.pre-line {
+  white-space: pre-line;
+}
+
 /**
  * Region Definitions.
  */
@@ -138,17 +175,13 @@ sup {
 
 .region.fullscreen {
   position: absolute;
-  top: -60px;
-  left: -60px;
-  right: -60px;
-  bottom: -60px;
+  top: calc(-1 * var(--gap-body-top));
+  left: calc(-1 * var(--gap-body-left));
+  right: calc(-1 * var(--gap-body-right));
+  bottom: calc(-1 * var(--gap-body-bottom));
   pointer-events: none;
 }
 
-.region.fullscreen * {
-  pointer-events: auto;
-}
-
 .region.right {
   right: 0;
   text-align: right;
@@ -158,25 +191,9 @@ sup {
   top: 0;
 }
 
-.region.top .container {
-  margin-bottom: 25px;
-}
-
-.region.bottom .container {
-  margin-top: 25px;
-}
-
-.region.top .container:empty {
-  margin-bottom: 0;
-}
-
 .region.top.center,
 .region.bottom.center {
   left: 50%;
-  -moz-transform: translateX(-50%);
-  -o-transform: translateX(-50%);
-  -webkit-transform: translateX(-50%);
-  -ms-transform: translateX(-50%);
   transform: translateX(-50%);
 }
 
@@ -190,10 +207,6 @@ sup {
   bottom: 0;
 }
 
-.region.bottom .container:empty {
-  margin-top: 0;
-}
-
 .region.bottom.right,
 .region.bottom.center,
 .region.bottom.left {
@@ -209,10 +222,6 @@ sup {
 .region.middle.center {
   width: 100%;
   text-align: center;
-  -moz-transform: translateY(-50%);
-  -o-transform: translateY(-50%);
-  -webkit-transform: translateY(-50%);
-  -ms-transform: translateY(-50%);
   transform: translateY(-50%);
 }
 

dangerfile.js

@@ -1,17 +0,0 @@
-import { danger, fail, warn } from "danger"
-
-// Check if the CHANGELOG.md file has been edited
-// Fail the build and post a comment reminding submitters to do so if it wasn't changed
-if (!danger.git.modified_files.includes("CHANGELOG.md")) {
-	warn("Please include an updated `CHANGELOG.md` file.<br>This way we can keep track of all the contributions.")
-}
-
-// Check if the PR request is send to the master branch.
-// This should only be done by MichMich.
-if (danger.github.pr.base.ref === "master" && danger.github.pr.user.login !== "MichMich") {
-	// Check if the PR body or title includes the text: #accepted.
-	// If not, the PR will fail.
-	if ((danger.github.pr.body + danger.github.pr.title).includes("#accepted")) {
-		fail("Please send all your pull requests to the `develop` branch.<br>Pull requests on the `master` branch will not be accepted.")
-	}
-}

fonts/package-lock.json

@@ -1,12 +1,37 @@
 {
-  "name": "magicmirror-fonts",
-  "requires": true,
-  "lockfileVersion": 1,
-  "dependencies": {
-    "roboto-fontface": {
-      "version": "0.8.0",
-      "resolved": "https://registry.npmjs.org/roboto-fontface/-/roboto-fontface-0.8.0.tgz",
-      "integrity": "sha512-ZYzRkETgBrdEGzL5JSKimvjI2CX7ioyZCkX2BpcfyjqI+079W0wHAyj5W4rIZMcDSOHgLZtgz1IdDi/vU77KEQ=="
-    }
-  }
+	"name": "magicmirror-fonts",
+	"lockfileVersion": 2,
+	"requires": true,
+	"packages": {
+		"": {
+			"name": "magicmirror-fonts",
+			"license": "MIT",
+			"dependencies": {
+				"@fontsource/roboto": "^4.5.8",
+				"@fontsource/roboto-condensed": "^4.5.9"
+			}
+		},
+		"node_modules/@fontsource/roboto": {
+			"version": "4.5.8",
+			"resolved": "https://registry.npmjs.org/@fontsource/roboto/-/roboto-4.5.8.tgz",
+			"integrity": "sha512-CnD7zLItIzt86q4Sj3kZUiLcBk1dSk81qcqgMGaZe7SQ1P8hFNxhMl5AZthK1zrDM5m74VVhaOpuMGIL4gagaA=="
+		},
+		"node_modules/@fontsource/roboto-condensed": {
+			"version": "4.5.9",
+			"resolved": "https://registry.npmjs.org/@fontsource/roboto-condensed/-/roboto-condensed-4.5.9.tgz",
+			"integrity": "sha512-ql4sQq+h8puBVildZ5ssjYf8DWDONYDe3PD3Bu/p1ZW9GnRETRNPPcCTs/q62HIl3QimwwkiKWynn6wZhQaetg=="
+		}
+	},
+	"dependencies": {
+		"@fontsource/roboto": {
+			"version": "4.5.8",
+			"resolved": "https://registry.npmjs.org/@fontsource/roboto/-/roboto-4.5.8.tgz",
+			"integrity": "sha512-CnD7zLItIzt86q4Sj3kZUiLcBk1dSk81qcqgMGaZe7SQ1P8hFNxhMl5AZthK1zrDM5m74VVhaOpuMGIL4gagaA=="
+		},
+		"@fontsource/roboto-condensed": {
+			"version": "4.5.9",
+			"resolved": "https://registry.npmjs.org/@fontsource/roboto-condensed/-/roboto-condensed-4.5.9.tgz",
+			"integrity": "sha512-ql4sQq+h8puBVildZ5ssjYf8DWDONYDe3PD3Bu/p1ZW9GnRETRNPPcCTs/q62HIl3QimwwkiKWynn6wZhQaetg=="
+		}
+	}
 }

fonts/package.json

@@ -1,15 +1,16 @@
 {
-  "name": "magicmirror-fonts",
-  "description": "Package for fonts use by MagicMirror Core.",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/MichMich/MagicMirror.git"
-  },
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/MichMich/MagicMirror/issues"
-  },
-  "dependencies": {
-    "roboto-fontface": "^0.8.0"
-  }
+	"name": "magicmirror-fonts",
+	"description": "Package for fonts use by MagicMirror² Core.",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/MichMich/MagicMirror.git"
+	},
+	"license": "MIT",
+	"bugs": {
+		"url": "https://github.com/MichMich/MagicMirror/issues"
+	},
+	"dependencies": {
+		"@fontsource/roboto": "^4.5.8",
+		"@fontsource/roboto-condensed": "^4.5.9"
+	}
 }

fonts/roboto.css

@@ -2,94 +2,54 @@
   font-family: Roboto;
   font-style: normal;
   font-weight: 100;
-  src:
-    local("Roboto Thin"),
-    local("Roboto-Thin"),
-    url("node_modules/roboto-fontface/fonts/roboto/Roboto-Thin.woff2") format("woff2"),
-    url("node_modules/roboto-fontface/fonts/roboto/Roboto-Thin.woff") format("woff"),
-    url("node_modules/roboto-fontface/fonts/roboto/Roboto-Thin.ttf") format("truetype");
+  src: local("Roboto Thin"), local("Roboto-Thin"), url("node_modules/@fontsource/roboto/files/roboto-all-100-normal.woff") format("woff");
 }
 
 @font-face {
   font-family: "Roboto Condensed";
   font-style: normal;
   font-weight: 300;
-  src:
-    local("Roboto Condensed Light"),
-    local("RobotoCondensed-Light"),
-    url("node_modules/roboto-fontface/fonts/roboto-condensed/Roboto-Condensed-Light.woff2") format("woff2"),
-    url("node_modules/roboto-fontface/fonts/roboto-condensed/Roboto-Condensed-Light.woff") format("woff"),
-    url("node_modules/roboto-fontface/fonts/roboto-condensed/Roboto-Condensed-Light.ttf") format("truetype");
+  src: local("Roboto Condensed Light"), local("RobotoCondensed-Light"), url("node_modules/@fontsource/roboto-condensed/files/roboto-condensed-all-300-normal.woff") format("woff");
 }
 
 @font-face {
   font-family: "Roboto Condensed";
   font-style: normal;
   font-weight: 400;
-  src:
-    local("Roboto Condensed"),
-    local("RobotoCondensed-Regular"),
-    url("node_modules/roboto-fontface/fonts/roboto-condensed/Roboto-Condensed-Regular.woff2") format("woff2"),
-    url("node_modules/roboto-fontface/fonts/roboto-condensed/Roboto-Condensed-Regular.woff") format("woff"),
-    url("node_modules/roboto-fontface/fonts/roboto-condensed/Roboto-Condensed-Regular.ttf") format("truetype");
+  src: local("Roboto Condensed"), local("RobotoCondensed-Regular"), url("node_modules/@fontsource/roboto-condensed/files/roboto-condensed-all-400-normal.woff") format("woff");
 }
 
 @font-face {
   font-family: "Roboto Condensed";
   font-style: normal;
   font-weight: 700;
-  src:
-    local("Roboto Condensed Bold"),
-    local("RobotoCondensed-Bold"),
-    url("node_modules/roboto-fontface/fonts/roboto-condensed/Roboto-Condensed-Bold.woff2") format("woff2"),
-    url("node_modules/roboto-fontface/fonts/roboto-condensed/Roboto-Condensed-Bold.woff") format("woff"),
-    url("node_modules/roboto-fontface/fonts/roboto-condensed/Roboto-Condensed-Bold.ttf") format("truetype");
+  src: local("Roboto Condensed Bold"), local("RobotoCondensed-Bold"), url("node_modules/@fontsource/roboto-condensed/files/roboto-condensed-all-700-normal.woff") format("woff");
 }
 
 @font-face {
   font-family: Roboto;
   font-style: normal;
   font-weight: 400;
-  src:
-    local("Roboto"),
-    local("Roboto-Regular"),
-    url("node_modules/roboto-fontface/fonts/roboto/Roboto-Regular.woff2") format("woff2"),
-    url("node_modules/roboto-fontface/fonts/roboto/Roboto-Regular.woff") format("woff"),
-    url("node_modules/roboto-fontface/fonts/roboto/Roboto-Regular.ttf") format("truetype");
+  src: local("Roboto"), local("Roboto-Regular"), url("node_modules/@fontsource/roboto/files/roboto-all-400-normal.woff") format("woff");
 }
 
 @font-face {
   font-family: Roboto;
   font-style: normal;
   font-weight: 500;
-  src:
-    local("Roboto Medium"),
-    local("Roboto-Medium"),
-    url("node_modules/roboto-fontface/fonts/roboto/Roboto-Medium.woff2") format("woff2"),
-    url("node_modules/roboto-fontface/fonts/roboto/Roboto-Medium.woff") format("woff"),
-    url("node_modules/roboto-fontface/fonts/roboto/Roboto-Medium.ttf") format("truetype");
+  src: local("Roboto Medium"), local("Roboto-Medium"), url("node_modules/@fontsource/roboto/files/roboto-all-500-normal.woff") format("woff");
 }
 
 @font-face {
   font-family: Roboto;
   font-style: normal;
   font-weight: 700;
-  src:
-    local("Roboto Bold"),
-    local("Roboto-Bold"),
-    url("node_modules/roboto-fontface/fonts/roboto/Roboto-Bold.woff2") format("woff2"),
-    url("node_modules/roboto-fontface/fonts/roboto/Roboto-Bold.woff") format("woff"),
-    url("node_modules/roboto-fontface/fonts/roboto/Roboto-Bold.ttf") format("truetype");
+  src: local("Roboto Bold"), local("Roboto-Bold"), url("node_modules/@fontsource/roboto/files/roboto-all-700-normal.woff") format("woff");
 }
 
 @font-face {
   font-family: Roboto;
   font-style: normal;
   font-weight: 300;
-  src:
-    local("Roboto Light"),
-    local("Roboto-Light"),
-    url("node_modules/roboto-fontface/fonts/roboto/Roboto-Light.woff2") format("woff2"),
-    url("node_modules/roboto-fontface/fonts/roboto/Roboto-Light.woff") format("woff"),
-    url("node_modules/roboto-fontface/fonts/roboto/Roboto-Light.ttf") format("truetype");
+  src: local("Roboto Light"), local("Roboto-Light"), url("node_modules/@fontsource/roboto/files/roboto-all-300-normal.woff") format("woff");
 }

fonts/yarn.lock

@@ -1,7 +0,0 @@
-# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
-# yarn lockfile v1
-
-
-roboto-fontface@^0.8.0:
-  version "0.8.0"
-  resolved "https://registry.yarnpkg.com/roboto-fontface/-/roboto-fontface-0.8.0.tgz#031a83c8f79932801a57d83bf743f37250163499"

index.html

@@ -1,55 +1,57 @@
 <!DOCTYPE html>
 <html>
-<head>
-	<title>MagicMirror²</title>
-	<meta name="google" content="notranslate" />
-	<meta http-equiv="Content-type" content="text/html; charset=utf-8" />
+  <head>
+    <title>MagicMirror²</title>
+    <meta name="google" content="notranslate" />
+    <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
 
-	<meta name="apple-mobile-web-app-capable" content="yes">
-	<meta name="apple-mobile-web-app-status-bar-style" content="black">
-	<meta name="format-detection" content="telephone=no">
-	<meta name="mobile-web-app-capable" content="yes">
+    <meta name="apple-mobile-web-app-capable" content="yes" />
+    <meta name="apple-mobile-web-app-status-bar-style" content="black" />
+    <meta name="format-detection" content="telephone=no" />
+    <meta name="mobile-web-app-capable" content="yes" />
 
-	<link rel="icon" href="data:;base64,iVBORw0KGgo=">
-	<link rel="stylesheet" type="text/css" href="css/main.css">
-	<link rel="stylesheet" type="text/css" href="fonts/roboto.css">
-	<!-- custom.css is loaded by the loader.js to make sure it's loaded after the module css files. -->
+    <link rel="icon" href="data:;base64,iVBORw0KGgo=" />
+    <link rel="stylesheet" type="text/css" href="css/main.css" />
+    <link rel="stylesheet" type="text/css" href="fonts/roboto.css" />
+    <!-- custom.css is loaded by the loader.js to make sure it's loaded after the module css files. -->
 
-	<script type="text/javascript">
-		var version = "#VERSION#";
-	</script>
-</head>
-<body>
-	<div class="region fullscreen below"><div class="container"></div></div>
-	<div class="region top bar">
-		<div class="container"></div>
-		<div class="region top left"><div class="container"></div></div>
-		<div class="region top center"><div class="container"></div></div>
-		<div class="region top right"><div class="container"></div></div>
-	</div>
-	<div class="region upper third"><div class="container"></div></div>
-	<div class="region middle center"><div class="container"></div></div>
-	<div class="region lower third"><div class="container"><br/></div></div>
-	<div class="region bottom bar">
-		<div class="container"></div>
-		<div class="region bottom left"><div class="container"></div></div>
-		<div class="region bottom center"><div class="container"></div></div>
-		<div class="region bottom right"><div class="container"></div></div>
-	</div>
-	<div class="region fullscreen above"><div class="container"></div></div>
-	<script type="text/javascript" src="/socket.io/socket.io.js"></script>
-	<script type="text/javascript" src="vendor/node_modules/nunjucks/browser/nunjucks.min.js"></script>
-	<script type="text/javascript" src="js/defaults.js"></script>
-	<script type="text/javascript" src="#CONFIG_FILE#"></script>
-	<script type="text/javascript" src="vendor/vendor.js"></script>
-	<script type="text/javascript" src="modules/default/defaultmodules.js"></script>
-	<script type="text/javascript" src="js/logger.js"></script>
-	<script type="text/javascript" src="translations/translations.js"></script>
-	<script type="text/javascript" src="js/translator.js"></script>
-	<script type="text/javascript" src="js/class.js"></script>
-	<script type="text/javascript" src="js/module.js"></script>
-	<script type="text/javascript" src="js/loader.js"></script>
-	<script type="text/javascript" src="js/socketclient.js"></script>
-	<script type="text/javascript" src="js/main.js"></script>
-</body>
+    <script type="text/javascript">
+      window.mmVersion = "#VERSION#";
+    </script>
+  </head>
+  <body>
+    <div class="region fullscreen below"><div class="container"></div></div>
+    <div class="region top bar">
+      <div class="container"></div>
+      <div class="region top left"><div class="container"></div></div>
+      <div class="region top center"><div class="container"></div></div>
+      <div class="region top right"><div class="container"></div></div>
+    </div>
+    <div class="region upper third"><div class="container"></div></div>
+    <div class="region middle center"><div class="container"></div></div>
+    <div class="region lower third">
+      <div class="container"><br /></div>
+    </div>
+    <div class="region bottom bar">
+      <div class="container"></div>
+      <div class="region bottom left"><div class="container"></div></div>
+      <div class="region bottom center"><div class="container"></div></div>
+      <div class="region bottom right"><div class="container"></div></div>
+    </div>
+    <div class="region fullscreen above"><div class="container"></div></div>
+    <script type="text/javascript" src="socket.io/socket.io.js"></script>
+    <script type="text/javascript" src="vendor/node_modules/nunjucks/browser/nunjucks.min.js"></script>
+    <script type="text/javascript" src="js/defaults.js"></script>
+    <script type="text/javascript" src="#CONFIG_FILE#"></script>
+    <script type="text/javascript" src="vendor/vendor.js"></script>
+    <script type="text/javascript" src="modules/default/defaultmodules.js"></script>
+    <script type="text/javascript" src="js/logger.js"></script>
+    <script type="text/javascript" src="translations/translations.js"></script>
+    <script type="text/javascript" src="js/translator.js"></script>
+    <script type="text/javascript" src="js/class.js"></script>
+    <script type="text/javascript" src="js/module.js"></script>
+    <script type="text/javascript" src="js/loader.js"></script>
+    <script type="text/javascript" src="js/socketclient.js"></script>
+    <script type="text/javascript" src="js/main.js"></script>
+  </body>
 </html>

installers/mm.sh

@@ -1,2 +1,4 @@
+#!/bin/bash
+# This file is still here to keep PM2 working on older installations.
 cd ~/MagicMirror
 DISPLAY=:0 npm start

installers/pm2_MagicMirror.json

@@ -1,7 +0,0 @@
-{
-  "apps" : [{
-    "name"        : "MagicMirror",
-    "script"      : "/home/pi/MagicMirror/installers/mm.sh",
-    "watch"       : ["/home/pi/MagicMirror/config/config.js"]
-  }]
-}

installers/postinstall/postinstall.sh

@@ -1,2 +0,0 @@
-echo "\033[32mMagicMirror installation successful!"
-exit 0

installers/raspberry.sh

@@ -1,163 +0,0 @@
-#!/usr/bin/env bash
-
-# This is an installer script for MagicMirror2. It works well enough
-# that it can detect if you have Node installed, run a binary script
-# and then download and run MagicMirror2.
-
-echo -e "\e[0m"
-echo '$$\      $$\                     $$\           $$\      $$\ $$\                                          $$$$$$\'
-echo '$$$\    $$$ |                    \__|          $$$\    $$$ |\__|                                        $$  __$$\'
-echo '$$$$\  $$$$ | $$$$$$\   $$$$$$\  $$\  $$$$$$$\ $$$$\  $$$$ |$$\  $$$$$$\   $$$$$$\   $$$$$$\   $$$$$$\  \__/  $$ |'
-echo '$$\$$\$$ $$ | \____$$\ $$  __$$\ $$ |$$  _____|$$\$$\$$ $$ |$$ |$$  __$$\ $$  __$$\ $$  __$$\ $$  __$$\  $$$$$$  |'
-echo '$$ \$$$  $$ | $$$$$$$ |$$ /  $$ |$$ |$$ /      $$ \$$$  $$ |$$ |$$ |  \__|$$ |  \__|$$ /  $$ |$$ |  \__|$$  ____/'
-echo '$$ |\$  /$$ |$$  __$$ |$$ |  $$ |$$ |$$ |      $$ |\$  /$$ |$$ |$$ |      $$ |      $$ |  $$ |$$ |      $$ |'
-echo '$$ | \_/ $$ |\$$$$$$$ |\$$$$$$$ |$$ |\$$$$$$$\ $$ | \_/ $$ |$$ |$$ |      $$ |      \$$$$$$  |$$ |      $$$$$$$$\'
-echo '\__|     \__| \_______| \____$$ |\__| \_______|\__|     \__|\__|\__|      \__|       \______/ \__|      \________|'
-echo '                       $$\   $$ |'
-echo '                       \$$$$$$  |'
-echo '                        \______/'
-echo -e "\e[0m"
-
-# Define the tested version of Node.js.
-NODE_TESTED="v5.1.0"
-
-# Determine which Pi is running.
-ARM=$(uname -m) 
-
-# Check the Raspberry Pi version.
-if [ "$ARM" != "armv7l" ]; then
-	echo -e "\e[91mSorry, your Raspberry Pi is not supported."
-	echo -e "\e[91mPlease run MagicMirror on a Raspberry Pi 2 or 3."
-	echo -e "\e[91mIf this is a Pi Zero, you are in the same boat as the original Raspberry Pi. You must run in server only mode."
-	exit;
-fi
-
-# Define helper methods.
-function version_gt() { test "$(echo "$@" | tr " " "\n" | sort -V | head -n 1)" != "$1"; }
-function command_exists () { type "$1" &> /dev/null ;}
-
-# Update before first apt-get
-echo -e "\e[96mUpdating packages ...\e[90m"
-sudo apt-get update || echo -e "\e[91mUpdate failed, carrying on installation ...\e[90m"
-
-# Installing helper tools
-echo -e "\e[96mInstalling helper tools ...\e[90m"
-sudo apt-get --assume-yes install curl wget git build-essential unzip || exit
-
-# Check if we need to install or upgrade Node.js.
-echo -e "\e[96mCheck current Node installation ...\e[0m"
-NODE_INSTALL=false
-if command_exists node; then
-	echo -e "\e[0mNode currently installed. Checking version number.";
-	NODE_CURRENT=$(node -v)
-	echo -e "\e[0mMinimum Node version: \e[1m$NODE_TESTED\e[0m"
-	echo -e "\e[0mInstalled Node version: \e[1m$NODE_CURRENT\e[0m"
-	if version_gt $NODE_TESTED $NODE_CURRENT; then
-		echo -e "\e[96mNode should be upgraded.\e[0m"
-		NODE_INSTALL=true
-
-		# Check if a node process is currenlty running.
-		# If so abort installation.
-		if pgrep "node" > /dev/null; then
-			echo -e "\e[91mA Node process is currently running. Can't upgrade."
-			echo "Please quit all Node processes and restart the installer."
-			exit;
-		fi
-
-	else
-		echo -e "\e[92mNo Node.js upgrade necessary.\e[0m"
-	fi
-
-else
-	echo -e "\e[93mNode.js is not installed.\e[0m";
-	NODE_INSTALL=true
-fi
-
-# Install or upgrade node if necessary.
-if $NODE_INSTALL; then
-	
-	echo -e "\e[96mInstalling Node.js ...\e[90m"
-
-	# Fetch the latest version of Node.js from the selected branch
-	# The NODE_STABLE_BRANCH variable will need to be manually adjusted when a new branch is released. (e.g. 7.x)
-	# Only tested (stable) versions are recommended as newer versions could break MagicMirror.
-	
-	NODE_STABLE_BRANCH="9.x"
-	curl -sL https://deb.nodesource.com/setup_$NODE_STABLE_BRANCH | sudo -E bash -
-	sudo apt-get install -y nodejs
-	echo -e "\e[92mNode.js installation Done!\e[0m"
-fi
-
-# Install MagicMirror
-cd ~
-if [ -d "$HOME/MagicMirror" ] ; then
-	echo -e "\e[93mIt seems like MagicMirror is already installed."
-	echo -e "To prevent overwriting, the installer will be aborted."
-	echo -e "Please rename the \e[1m~/MagicMirror\e[0m\e[93m folder and try again.\e[0m"
-	echo ""
-	echo -e "If you want to upgrade your installation run \e[1m\e[97mgit pull\e[0m from the ~/MagicMirror directory."
-	echo ""
-	exit;
-fi
-
-echo -e "\e[96mCloning MagicMirror ...\e[90m"
-if git clone --depth=1 https://github.com/MichMich/MagicMirror.git; then 
-	echo -e "\e[92mCloning MagicMirror Done!\e[0m"
-else
-	echo -e "\e[91mUnable to clone MagicMirror."
-	exit;
-fi
-
-cd ~/MagicMirror  || exit
-echo -e "\e[96mInstalling dependencies ...\e[90m"
-if npm install; then 
-	echo -e "\e[92mDependencies installation Done!\e[0m"
-else
-	echo -e "\e[91mUnable to install dependencies!"
-	exit;
-fi
-
-# Use sample config for start MagicMirror
-cp config/config.js.sample config/config.js
-
-# Check if plymouth is installed (default with PIXEL desktop environment), then install custom splashscreen.
-echo -e "\e[96mCheck plymouth installation ...\e[0m"
-if command_exists plymouth; then
-	THEME_DIR="/usr/share/plymouth/themes"
-	echo -e "\e[90mSplashscreen: Checking themes directory.\e[0m"
-	if [ -d $THEME_DIR ]; then
-		echo -e "\e[90mSplashscreen: Create theme directory if not exists.\e[0m"
-		if [ ! -d $THEME_DIR/MagicMirror ]; then
-			sudo mkdir $THEME_DIR/MagicMirror
-		fi
-
-		if sudo cp ~/MagicMirror/splashscreen/splash.png $THEME_DIR/MagicMirror/splash.png && sudo cp ~/MagicMirror/splashscreen/MagicMirror.plymouth $THEME_DIR/MagicMirror/MagicMirror.plymouth && sudo cp ~/MagicMirror/splashscreen/MagicMirror.script $THEME_DIR/MagicMirror/MagicMirror.script; then
-			echo -e "\e[90mSplashscreen: Theme copied successfully.\e[0m"
-			if sudo plymouth-set-default-theme -R MagicMirror; then
-				echo -e "\e[92mSplashscreen: Changed theme to MagicMirror successfully.\e[0m"
-			else
-				echo -e "\e[91mSplashscreen: Couldn't change theme to MagicMirror!\e[0m"
-			fi
-		else
-			echo -e "\e[91mSplashscreen: Copying theme failed!\e[0m"
-		fi
-	else
-		echo -e "\e[91mSplashscreen: Themes folder doesn't exist!\e[0m"
-	fi
-else
-	echo -e "\e[93mplymouth is not installed.\e[0m";
-fi
-
-# Use pm2 control like a service MagicMirror
-read -p "Do you want use pm2 for auto starting of your MagicMirror (y/N)?" choice
-if [[ $choice =~ ^[Yy]$ ]]; then
-    sudo npm install -g pm2
-    sudo su -c "env PATH=$PATH:/usr/bin pm2 startup linux -u pi --hp /home/pi"
-    pm2 start ~/MagicMirror/installers/pm2_MagicMirror.json
-    pm2 save
-fi
-
-echo " "
-echo -e "\e[92mWe're ready! Run \e[1m\e[97mDISPLAY=:0 npm start\e[0m\e[92m from the ~/MagicMirror directory to start your MagicMirror.\e[0m"
-echo " "
-echo " "

js/app.js

@@ -1,22 +1,26 @@
-/* Magic Mirror
+/* MagicMirror²
  * The Core App (Server)
  *
- * By Michael Teeuw http://michaelteeuw.nl
+ * By Michael Teeuw https://michaelteeuw.nl
  * MIT Licensed.
  */
 
-var fs = require("fs");
-var Server = require(__dirname + "/server.js");
-var Utils = require(__dirname + "/utils.js");
-var defaultModules = require(__dirname + "/../modules/default/defaultmodules.js");
-var path = require("path");
+// Alias modules mentioned in package.js under _moduleAliases.
+require("module-alias/register");
+
+const fs = require("fs");
+const path = require("path");
+const Log = require("logger");
+const Server = require(`${__dirname}/server`);
+const Utils = require(`${__dirname}/utils`);
+const defaultModules = require(`${__dirname}/../modules/default/defaultmodules`);
 
 // Get version number.
-global.version = JSON.parse(fs.readFileSync("package.json", "utf8")).version;
-console.log("Starting MagicMirror: v" + global.version);
+global.version = require(`${__dirname}/../package.json`).version;
+Log.log("Starting MagicMirror: v" + global.version);
 
 // global absolute root path
-global.root_path = path.resolve(__dirname + "/../");
+global.root_path = path.resolve(`${__dirname}/../`);
 
 if (process.env.MM_CONFIG_FILE) {
 	global.configuration_file = process.env.MM_CONFIG_FILE;
@@ -31,108 +35,104 @@ if (process.env.MM_PORT) {
 // The next part is here to prevent a major exception when there
 // is no internet connection. This could probable be solved better.
 process.on("uncaughtException", function (err) {
-	console.log("Whoops! There was an uncaught exception...");
-	console.error(err);
-	console.log("MagicMirror will not quit, but it might be a good idea to check why this happened. Maybe no internet connection?");
-	console.log("If you think this really is an issue, please open an issue on GitHub: https://github.com/MichMich/MagicMirror/issues");
+	Log.error("Whoops! There was an uncaught exception...");
+	Log.error(err);
+	Log.error("MagicMirror² will not quit, but it might be a good idea to check why this happened. Maybe no internet connection?");
+	Log.error("If you think this really is an issue, please open an issue on GitHub: https://github.com/MichMich/MagicMirror/issues");
 });
 
-/* App - The core app.
+/**
+ * The core app.
+ *
+ * @class
  */
-var App = function() {
-	var nodeHelpers = [];
+function App() {
+	let nodeHelpers = [];
+	let httpServer;
 
-	/* loadConfig(callback)
-	 * Loads the config file. combines it with the defaults,
-	 * and runs the callback with the found config as argument.
+	/**
+	 * Loads the config file. Combines it with the defaults, and runs the
+	 * callback with the found config as argument.
 	 *
-	 * argument callback function - The callback function.
+	 * @param {Function} callback Function to be called after loading the config
 	 */
-
-	var loadConfig = function(callback) {
-		console.log("Loading config ...");
-		var defaults = require(__dirname + "/defaults.js");
+	function loadConfig(callback) {
+		Log.log("Loading config ...");
+		const defaults = require(`${__dirname}/defaults`);
 
 		// For this check proposed to TestSuite
 		// https://forum.magicmirror.builders/topic/1456/test-suite-for-magicmirror/8
-		var configFilename = path.resolve(global.root_path + "/config/config.js");
-		if (typeof(global.configuration_file) !== "undefined") {
-		    configFilename = path.resolve(global.configuration_file);
-		}
+		const configFilename = path.resolve(global.configuration_file || `${global.root_path}/config/config.js`);
 
 		try {
 			fs.accessSync(configFilename, fs.F_OK);
-			var c = require(configFilename);
+			const c = require(configFilename);
 			checkDeprecatedOptions(c);
-			var config = Object.assign(defaults, c);
+			const config = Object.assign(defaults, c);
 			callback(config);
 		} catch (e) {
-			if (e.code == "ENOENT") {
-				console.error(Utils.colors.error("WARNING! Could not find config file. Please create one. Starting with default configuration."));
+			if (e.code === "ENOENT") {
+				Log.error(Utils.colors.error("WARNING! Could not find config file. Please create one. Starting with default configuration."));
 			} else if (e instanceof ReferenceError || e instanceof SyntaxError) {
-				console.error(Utils.colors.error("WARNING! Could not validate config file. Please correct syntax errors. Starting with default configuration."));
+				Log.error(Utils.colors.error(`WARNING! Could not validate config file. Starting with default configuration. Please correct syntax errors at or above this line: ${e.stack}`));
 			} else {
-				console.error(Utils.colors.error("WARNING! Could not load config file. Starting with default configuration. Error found: " + e));
+				Log.error(Utils.colors.error(`WARNING! Could not load config file. Starting with default configuration. Error found: ${e}`));
 			}
 			callback(defaults);
 		}
-	};
+	}
 
-	var checkDeprecatedOptions = function(userConfig) {
-		var deprecated = require(global.root_path + "/js/deprecated.js");
-		var deprecatedOptions = deprecated.configs;
+	/**
+	 * Checks the config for deprecated options and throws a warning in the logs
+	 * if it encounters one option from the deprecated.js list
+	 *
+	 * @param {object} userConfig The user config
+	 */
+	function checkDeprecatedOptions(userConfig) {
+		const deprecated = require(`${global.root_path}/js/deprecated`);
+		const deprecatedOptions = deprecated.configs;
 
-		var usedDeprecated = [];
-
-		deprecatedOptions.forEach(function(option) {
-			if (userConfig.hasOwnProperty(option)) {
-				usedDeprecated.push(option);
-			}
-		});
+		const usedDeprecated = deprecatedOptions.filter((option) => userConfig.hasOwnProperty(option));
 		if (usedDeprecated.length > 0) {
-			console.warn(Utils.colors.warn(
-				"WARNING! Your config is using deprecated options: " +
-				usedDeprecated.join(", ") +
-				". Check README and CHANGELOG for more up-to-date ways of getting the same functionality.")
-			);
+			Log.warn(Utils.colors.warn(`WARNING! Your config is using deprecated options: ${usedDeprecated.join(", ")}. Check README and CHANGELOG for more up-to-date ways of getting the same functionality.`));
 		}
 	}
 
-	/* loadModule(module)
+	/**
 	 * Loads a specific module.
 	 *
-	 * argument module string - The name of the module (including subpath).
+	 * @param {string} module The name of the module (including subpath).
+	 * @param {Function} callback Function to be called after loading
 	 */
-	var loadModule = function(module, callback) {
+	function loadModule(module, callback) {
+		const elements = module.split("/");
+		const moduleName = elements[elements.length - 1];
+		let moduleFolder = `${__dirname}/../modules/${module}`;
 
-		var elements = module.split("/");
-		var moduleName = elements[elements.length - 1];
-		var moduleFolder =  __dirname + "/../modules/" + module;
-
-		if (defaultModules.indexOf(moduleName) !== -1) {
-			moduleFolder =  __dirname + "/../modules/default/" + module;
+		if (defaultModules.includes(moduleName)) {
+			moduleFolder = `${__dirname}/../modules/default/${module}`;
 		}
 
-		var helperPath = moduleFolder + "/node_helper.js";
+		const helperPath = `${moduleFolder}/node_helper.js`;
 
-		var loadModule = true;
+		let loadHelper = true;
 		try {
 			fs.accessSync(helperPath, fs.R_OK);
 		} catch (e) {
-			loadModule = false;
-			console.log("No helper found for module: " + moduleName + ".");
+			loadHelper = false;
+			Log.log(`No helper found for module: ${moduleName}.`);
 		}
 
-		if (loadModule) {
-			var Module = require(helperPath);
-			var m = new Module();
+		if (loadHelper) {
+			const Module = require(helperPath);
+			let m = new Module();
 
 			if (m.requiresVersion) {
-				console.log("Check MagicMirror version for node helper '" + moduleName + "' - Minimum version:  " + m.requiresVersion + " - Current version: " + global.version);
+				Log.log(`Check MagicMirror² version for node helper '${moduleName}' - Minimum version: ${m.requiresVersion} - Current version: ${global.version}`);
 				if (cmpVersions(global.version, m.requiresVersion) >= 0) {
-					console.log("Version is ok!");
+					Log.log("Version is ok!");
 				} else {
-					console.log("Version is incorrect. Skip module: '" + moduleName + "'");
+					Log.warn(`Version is incorrect. Skip module: '${moduleName}'`);
 					return;
 				}
 			}
@@ -145,45 +145,51 @@ var App = function() {
 		} else {
 			callback();
 		}
-	};
+	}
 
-	/* loadModules(modules)
+	/**
 	 * Loads all modules.
 	 *
-	 * argument module string - The name of the module (including subpath).
+	 * @param {Module[]} modules All modules to be loaded
+	 * @param {Function} callback Function to be called after loading
 	 */
-	var loadModules = function(modules, callback) {
-		console.log("Loading module helpers ...");
+	function loadModules(modules, callback) {
+		Log.log("Loading module helpers ...");
 
-		var loadNextModule = function() {
+		/**
+		 *
+		 */
+		function loadNextModule() {
 			if (modules.length > 0) {
-				var nextModule = modules[0];
-				loadModule(nextModule, function() {
+				const nextModule = modules[0];
+				loadModule(nextModule, function () {
 					modules = modules.slice(1);
 					loadNextModule();
 				});
 			} else {
 				// All modules are loaded
-				console.log("All module helpers loaded.");
+				Log.log("All module helpers loaded.");
 				callback();
 			}
-		};
+		}
 
 		loadNextModule();
-	};
+	}
 
-	/* cmpVersions(a,b)
-	 * Compare two symantic version numbers and return the difference.
+	/**
+	 * Compare two semantic version numbers and return the difference.
 	 *
-	 * argument a string - Version number a.
-	 * argument a string - Version number b.
+	 * @param {string} a Version number a.
+	 * @param {string} b Version number b.
+	 * @returns {number} A positive number if a is larger than b, a negative
+	 * number if a is smaller and 0 if they are the same
 	 */
 	function cmpVersions(a, b) {
-		var i, diff;
-		var regExStrip0 = /(\.0+)+$/;
-		var segmentsA = a.replace(regExStrip0, "").split(".");
-		var segmentsB = b.replace(regExStrip0, "").split(".");
-		var l = Math.min(segmentsA.length, segmentsB.length);
+		let i, diff;
+		const regExStrip0 = /(\.0+)+$/;
+		const segmentsA = a.replace(regExStrip0, "").split(".");
+		const segmentsB = b.replace(regExStrip0, "").split(".");
+		const l = Math.min(segmentsA.length, segmentsB.length);
 
 		for (i = 0; i < l; i++) {
 			diff = parseInt(segmentsA[i], 10) - parseInt(segmentsB[i], 10);
@@ -194,75 +200,91 @@ var App = function() {
 		return segmentsA.length - segmentsB.length;
 	}
 
-	/* start(callback)
-	 * This methods starts the core app.
-	 * It loads the config, then it loads all modules.
-	 * When it"s done it executs the callback with the config as argument.
+	/**
+	 * Start the core app.
 	 *
-	 * argument callback function - The callback function.
+	 * It loads the config, then it loads all modules. When it's done it
+	 * executes the callback with the config as argument.
+	 *
+	 * @param {Function} callback Function to be called after start
 	 */
-	this.start = function(callback) {
-
-		loadConfig(function(c) {
+	this.start = function (callback) {
+		loadConfig(function (c) {
 			config = c;
 
-			var modules = [];
+			Log.setLogLevel(config.logLevel);
 
-			for (var m in config.modules) {
-				var module = config.modules[m];
-				if (modules.indexOf(module.module) === -1 && !module.disabled) {
+			let modules = [];
+
+			for (const module of config.modules) {
+				if (!modules.includes(module.module) && !module.disabled) {
 					modules.push(module.module);
 				}
 			}
 
-			loadModules(modules, function() {
-				var server = new Server(config, function(app, io) {
-					console.log("Server started ...");
+			loadModules(modules, function () {
+				httpServer = new Server(config, function (app, io) {
+					Log.log("Server started ...");
 
-					for (var h in nodeHelpers) {
-						var nodeHelper = nodeHelpers[h];
+					for (let nodeHelper of nodeHelpers) {
 						nodeHelper.setExpressApp(app);
 						nodeHelper.setSocketIO(io);
 						nodeHelper.start();
 					}
 
-					console.log("Sockets connected & modules started ...");
+					Log.log("Sockets connected & modules started ...");
 
 					if (typeof callback === "function") {
 						callback(config);
 					}
-
 				});
 			});
 		});
 	};
 
-	/* stop()
-	 * This methods stops the core app.
-	 * This calls each node_helper's STOP() function, if it exists.
+	/**
+	 * Stops the core app. This calls each node_helper's STOP() function, if it
+	 * exists.
+	 *
 	 * Added to fix #1056
 	 */
-	this.stop = function() {
-		for (var h in nodeHelpers) {
-			var nodeHelper = nodeHelpers[h];
+	this.stop = function () {
+		for (const nodeHelper of nodeHelpers) {
 			if (typeof nodeHelper.stop === "function") {
 				nodeHelper.stop();
 			}
 		}
+		httpServer.close();
 	};
 
-	/* Listen for SIGINT signal and call stop() function.
+	/**
+	 * Listen for SIGINT signal and call stop() function.
 	 *
 	 * Added to fix #1056
 	 * Note: this is only used if running `server-only`. Otherwise
 	 * this.stop() is called by app.on("before-quit"... in `electron.js`
 	 */
 	process.on("SIGINT", () => {
-		console.log("[SIGINT] Received. Shutting down server...");
-		setTimeout(() => { process.exit(0); }, 3000);  // Force quit after 3 seconds
+		Log.log("[SIGINT] Received. Shutting down server...");
+		setTimeout(() => {
+			process.exit(0);
+		}, 3000); // Force quit after 3 seconds
 		this.stop();
 		process.exit(0);
 	});
-};
+
+	/**
+	 * Listen to SIGTERM signals so we can stop everything when we
+	 * are asked to stop by the OS.
+	 */
+	process.on("SIGTERM", () => {
+		Log.log("[SIGTERM] Received. Shutting down server...");
+		setTimeout(() => {
+			process.exit(0);
+		}, 3000); // Force quit after 3 seconds
+		this.stop();
+		process.exit(0);
+	});
+}
 
 module.exports = new App();

js/check_config.js

@@ -0,0 +1,73 @@
+/* MagicMirror²
+ *
+ * Check the configuration file for errors
+ *
+ * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com
+ * MIT Licensed.
+ */
+const Linter = require("eslint").Linter;
+const linter = new Linter();
+
+const path = require("path");
+const fs = require("fs");
+
+const rootPath = path.resolve(`${__dirname}/../`);
+const Log = require(`${rootPath}/js/logger.js`);
+const Utils = require(`${rootPath}/js/utils.js`);
+
+/**
+ * Returns a string with path of configuration file.
+ * Check if set by environment variable MM_CONFIG_FILE
+ *
+ * @returns {string} path and filename of the config file
+ */
+function getConfigFile() {
+	// FIXME: This function should be in core. Do you want refactor me ;) ?, be good!
+	return path.resolve(process.env.MM_CONFIG_FILE || `${rootPath}/config/config.js`);
+}
+
+/**
+ * Checks the config file using eslint.
+ */
+function checkConfigFile() {
+	const configFileName = getConfigFile();
+
+	// Check if file is present
+	if (fs.existsSync(configFileName) === false) {
+		Log.error(Utils.colors.error("File not found: "), configFileName);
+		throw new Error("No config file present!");
+	}
+
+	// Check permission
+	try {
+		fs.accessSync(configFileName, fs.F_OK);
+	} catch (e) {
+		Log.error(Utils.colors.error(e));
+		throw new Error("No permission to access config file!");
+	}
+
+	// Validate syntax of the configuration file.
+	Log.info(Utils.colors.info("Checking file... "), configFileName);
+
+	// I'm not sure if all ever is utf-8
+	const configFile = fs.readFileSync(configFileName, "utf-8");
+
+	// Explicitly tell linter that he might encounter es6 syntax ("let config = {...}")
+	const errors = linter.verify(configFile, {
+		env: {
+			es6: true
+		}
+	});
+
+	if (errors.length === 0) {
+		Log.info(Utils.colors.pass("Your configuration file doesn't contain syntax errors :)"));
+	} else {
+		Log.error(Utils.colors.error("Your configuration file contains syntax errors :("));
+
+		for (const error of errors) {
+			Log.error(`Line ${error.line} column ${error.column}: ${error.message}`);
+		}
+	}
+}
+
+checkConfigFile();

js/class.js

@@ -1,55 +1,65 @@
+/* global Class, xyz */
+
 /* Simple JavaScript Inheritance
- * By John Resig http://ejohn.org/
+ * By John Resig https://johnresig.com/
+ *
+ * Inspired by base2 and Prototype
+ *
  * MIT Licensed.
  */
-
-// Inspired by base2 and Prototype
 (function () {
-	var initializing = false;
-	var fnTest = /xyz/.test(function () { xyz; }) ? /\b_super\b/ : /.*/;
+	let initializing = false;
+	const fnTest = /xyz/.test(function () {
+		xyz;
+	})
+		? /\b_super\b/
+		: /.*/;
 
 	// The base Class implementation (does nothing)
-	this.Class = function () { };
+	this.Class = function () {};
 
 	// Create a new Class that inherits from this class
 	Class.extend = function (prop) {
-		var _super = this.prototype;
+		let _super = this.prototype;
 
 		// Instantiate a base class (but only create the instance,
 		// don't run the init constructor)
 		initializing = true;
-		var prototype = new this();
+		const prototype = new this();
 		initializing = false;
 
-		// Make a copy of all prototype properies, to prevent reference issues.
-		for (var name in prototype) {
-			prototype[name] = cloneObject(prototype[name]);
+		// Make a copy of all prototype properties, to prevent reference issues.
+		for (const p in prototype) {
+			prototype[p] = cloneObject(prototype[p]);
 		}
 
 		// Copy the properties over onto the new prototype
-		for (var name in prop) {
+		for (const name in prop) {
 			// Check if we're overwriting an existing function
-			prototype[name] = typeof prop[name] == "function" &&
-				typeof _super[name] == "function" && fnTest.test(prop[name]) ? (function (name, fn) {
-					return function () {
-						var tmp = this._super;
+			prototype[name] =
+				typeof prop[name] === "function" && typeof _super[name] === "function" && fnTest.test(prop[name])
+					? (function (name, fn) {
+							return function () {
+								const tmp = this._super;
 
-						// Add a new ._super() method that is the same method
-						// but on the super-class
-						this._super = _super[name];
+								// Add a new ._super() method that is the same method
+								// but on the super-class
+								this._super = _super[name];
 
-						// The method only need to be bound temporarily, so we
-						// remove it when we're done executing
-						var ret = fn.apply(this, arguments);
-						this._super = tmp;
+								// The method only need to be bound temporarily, so we
+								// remove it when we're done executing
+								const ret = fn.apply(this, arguments);
+								this._super = tmp;
 
-
-						return ret;
-					};
-				})(name, prop[name]) : prop[name];
+								return ret;
+							};
+					  })(name, prop[name])
+					: prop[name];
 		}
 
-		// The dummy class constructor
+		/**
+		 * The dummy class constructor
+		 */
 		function Class() {
 			// All construction is actually done in the init method
 			if (!initializing && this.init) {
@@ -70,15 +80,19 @@
 	};
 })();
 
-//Define the clone method for later use.
-//Helper Method
+/**
+ * Define the clone method for later use. Helper Method.
+ *
+ * @param {object} obj Object to be cloned
+ * @returns {object} the cloned object
+ */
 function cloneObject(obj) {
 	if (obj === null || typeof obj !== "object") {
 		return obj;
 	}
 
-	var temp = obj.constructor(); // give temp the original obj's constructor
-	for (var key in obj) {
+	const temp = obj.constructor(); // give temp the original obj's constructor
+	for (const key in obj) {
 		temp[key] = cloneObject(obj[key]);
 
 		if (key === "lockStrings") {

js/defaults.js

@@ -1,29 +1,33 @@
-/* exported defaults */
+/* global mmPort */
 
-/* Magic Mirror
- * Config Defauls
+/* MagicMirror²
+ * Config Defaults
  *
- * By Michael Teeuw http://michaelteeuw.nl
+ * By Michael Teeuw https://michaelteeuw.nl
  * MIT Licensed.
  */
-
-var port = 8080;
-var address = "localhost";
-if (typeof(mmPort) !== "undefined") {
+const address = "localhost";
+let port = 8080;
+if (typeof mmPort !== "undefined") {
 	port = mmPort;
 }
-var defaults = {
+const defaults = {
 	address: address,
 	port: port,
+	basePath: "/",
 	kioskmode: false,
 	electronOptions: {},
 	ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1"],
 
 	language: "en",
+	logLevel: ["INFO", "LOG", "WARN", "ERROR"],
 	timeFormat: 24,
 	units: "metric",
 	zoom: 1,
 	customCss: "css/custom.css",
+	// httpHeaders used by helmet, see https://helmetjs.github.io/. You can add other/more object values by overriding this in config.js,
+	// e.g. you need to add `frameguard: false` for embedding MagicMirror in another website, see https://github.com/MichMich/MagicMirror/issues/2847
+	httpHeaders: { contentSecurityPolicy: false, crossOriginOpenerPolicy: false, crossOriginEmbedderPolicy: false, crossOriginResourcePolicy: false, originAgentCluster: false },
 
 	modules: [
 		{
@@ -35,14 +39,14 @@ var defaults = {
 			position: "upper_third",
 			classes: "large thin",
 			config: {
-				text: "Magic Mirror<sup>2</sup>"
+				text: "MagicMirror²"
 			}
 		},
 		{
 			module: "helloworld",
 			position: "middle_center",
 			config: {
-				text: "Please create a config file."
+				text: "Please create a config file or check the existing one for errors."
 			}
 		},
 		{
@@ -58,7 +62,7 @@ var defaults = {
 			position: "middle_center",
 			classes: "xsmall",
 			config: {
-				text: "If you get this message while your config file is already<br>created, your config file probably contains an error.<br>Use a JavaScript linter to validate your file."
+				text: "If you get this message while your config file is already created,<br>" + "it probably contains an error. To validate your config file run in your MagicMirror² directory<br>" + "<pre>npm run config:check</pre>"
 			}
 		},
 		{
@@ -68,14 +72,16 @@ var defaults = {
 			config: {
 				text: "www.michaelteeuw.nl"
 			}
-		},
+		}
 	],
 
 	paths: {
 		modules: "modules",
 		vendor: "vendor"
-	},
+	}
 };
 
 /*************** DO NOT EDIT THE LINE BELOW ***************/
-if (typeof module !== "undefined") {module.exports = defaults;}
+if (typeof module !== "undefined") {
+	module.exports = defaults;
+}

js/deprecated.js

@@ -1,14 +1,11 @@
-/* Magic Mirror Deprecated Config Options List
+/* MagicMirror² Deprecated Config Options List
  *
- * By Michael Teeuw http://michaelteeuw.nl
+ * By Michael Teeuw https://michaelteeuw.nl
  * MIT Licensed.
  *
  * Olex S. original idea this deprecated option
  */
 
-var deprecated = {
-	configs: ["kioskmode"],
+module.exports = {
+	configs: ["kioskmode"]
 };
-
-/*************** DO NOT EDIT THE LINE BELOW ***************/
-if (typeof module !== "undefined") {module.exports = deprecated;}

js/electron.js

@@ -1,14 +1,19 @@
-/* jshint esversion: 6 */
-
 "use strict";
 
 const electron = require("electron");
-const core = require(__dirname + "/app.js");
+const core = require("./app.js");
+const Log = require("logger");
 
 // Config
-var config = process.env.config ? JSON.parse(process.env.config) : {};
+let config = process.env.config ? JSON.parse(process.env.config) : {};
 // Module to control application life.
 const app = electron.app;
+// If ELECTRON_DISABLE_GPU is set electron is started with --disable-gpu flag.
+// See https://www.electronjs.org/docs/latest/tutorial/offscreen-rendering for more info.
+if (process.env.ELECTRON_DISABLE_GPU !== undefined) {
+	app.disableHardwareAcceleration();
+}
+
 // Module to create native browser window.
 const BrowserWindow = electron.BrowserWindow;
 
@@ -16,14 +21,20 @@ const BrowserWindow = electron.BrowserWindow;
 // be closed automatically when the JavaScript object is garbage collected.
 let mainWindow;
 
+/**
+ *
+ */
 function createWindow() {
-	var electronOptionsDefaults = {
+	let electronSwitchesDefaults = ["autoplay-policy", "no-user-gesture-required"];
+	app.commandLine.appendSwitch(...new Set(electronSwitchesDefaults, config.electronSwitches));
+	let electronOptionsDefaults = {
 		width: 800,
 		height: 600,
 		x: 0,
 		y: 0,
 		darkTheme: true,
 		webPreferences: {
+			contextIsolation: true,
 			nodeIntegration: false,
 			zoomFactor: config.zoom
 		},
@@ -39,37 +50,55 @@ function createWindow() {
 		electronOptionsDefaults.autoHideMenuBar = true;
 	}
 
-	var electronOptions = Object.assign({}, electronOptionsDefaults, config.electronOptions);
+	const electronOptions = Object.assign({}, electronOptionsDefaults, config.electronOptions);
 
 	// Create the browser window.
 	mainWindow = new BrowserWindow(electronOptions);
 
 	// and load the index.html of the app.
 	// If config.address is not defined or is an empty string (listening on all interfaces), connect to localhost
-	var address = (config.address === void 0) | (config.address === "") ? (config.address = "localhost") : config.address;
-	mainWindow.loadURL(`http://${address}:${config.port}`);
+
+	let prefix;
+	if ((config["tls"] !== null && config["tls"]) || config.useHttps) {
+		prefix = "https://";
+	} else {
+		prefix = "http://";
+	}
+
+	let address = (config.address === void 0) | (config.address === "") ? (config.address = "localhost") : config.address;
+	mainWindow.loadURL(`${prefix}${address}:${config.port}`);
 
 	// Open the DevTools if run with "npm start dev"
 	if (process.argv.includes("dev")) {
+		if (process.env.JEST_WORKER_ID !== undefined) {
+			// if we are running with jest
+			const devtools = new BrowserWindow(electronOptions);
+			mainWindow.webContents.setDevToolsWebContents(devtools.webContents);
+		}
 		mainWindow.webContents.openDevTools();
 	}
 
+	// simulate mouse move to hide black cursor on start
+	mainWindow.webContents.on("dom-ready", (event) => {
+		mainWindow.webContents.sendInputEvent({ type: "mouseMove", x: 0, y: 0 });
+	});
+
 	// Set responders for window events.
-	mainWindow.on("closed", function() {
+	mainWindow.on("closed", function () {
 		mainWindow = null;
 	});
 
 	if (config.kioskmode) {
-		mainWindow.on("blur", function() {
+		mainWindow.on("blur", function () {
 			mainWindow.focus();
 		});
 
-		mainWindow.on("leave-full-screen", function() {
+		mainWindow.on("leave-full-screen", function () {
 			mainWindow.setFullScreen(true);
 		});
 
-		mainWindow.on("resize", function() {
-			setTimeout(function() {
+		mainWindow.on("resize", function () {
+			setTimeout(function () {
 				mainWindow.reload();
 			}, 1000);
 		});
@@ -78,17 +107,22 @@ function createWindow() {
 
 // This method will be called when Electron has finished
 // initialization and is ready to create browser windows.
-app.on("ready", function() {
-	console.log("Launching application.");
+app.on("ready", function () {
+	Log.log("Launching application.");
 	createWindow();
 });
 
 // Quit when all windows are closed.
-app.on("window-all-closed", function() {
-	createWindow();
+app.on("window-all-closed", function () {
+	if (process.env.JEST_WORKER_ID !== undefined) {
+		// if we are running with jest
+		app.quit();
+	} else {
+		createWindow();
+	}
 });
 
-app.on("activate", function() {
+app.on("activate", function () {
 	// On OS X it's common to re-create a window in the app when the
 	// dock icon is clicked and there are no other windows open.
 	if (mainWindow === null) {
@@ -103,17 +137,26 @@ app.on("activate", function() {
  * core.stop() is called by process.on("SIGINT"... in `app.js`
  */
 app.on("before-quit", (event) => {
-	console.log("Shutting down server...");
+	Log.log("Shutting down server...");
 	event.preventDefault();
-	setTimeout(() => { process.exit(0); }, 3000); // Force-quit after 3 seconds.
+	setTimeout(() => {
+		process.exit(0);
+	}, 3000); // Force-quit after 3 seconds.
 	core.stop();
 	process.exit(0);
 });
 
+/* handle errors from self signed certificates */
+
+app.on("certificate-error", (event, webContents, url, error, certificate, callback) => {
+	event.preventDefault();
+	callback(true);
+});
+
 // Start the core application if server is run on localhost
 // This starts all node helpers and starts the webserver.
-if (["localhost", "127.0.0.1", "::1", "::ffff:127.0.0.1", undefined].indexOf(config.address) > -1) {
-	core.start(function(c) {
+if (["localhost", "127.0.0.1", "::1", "::ffff:127.0.0.1", undefined].includes(config.address)) {
+	core.start(function (c) {
 		config = c;
 	});
 }

js/fetch.js

@@ -0,0 +1,20 @@
+/**
+ * fetch
+ *
+ * @param {string} url to be fetched
+ * @param {object} options object e.g. for headers
+ * @class
+ */
+async function fetch(url, options) {
+	const nodeVersion = process.version.match(/^v(\d+)\.*/)[1];
+	if (nodeVersion >= 18) {
+		// node version >= 18
+		return global.fetch(url, options);
+	} else {
+		// node version < 18
+		const nodefetch = require("node-fetch");
+		return nodefetch(url, options);
+	}
+}
+
+module.exports = fetch;

js/loader.js

@@ -1,32 +1,30 @@
-/* global config, vendor, MM, Log, Module */
-/* Magic Mirror
+/* global defaultModules, vendor */
+
+/* MagicMirror²
  * Module and File loaders.
  *
- * By Michael Teeuw http://michaelteeuw.nl
+ * By Michael Teeuw https://michaelteeuw.nl
  * MIT Licensed.
  */
+const Loader = (function () {
+	/* Create helper variables */
 
-var Loader = (function() {
-
-	/* Create helper valiables */
-
-	var loadedModuleFiles = [];
-	var loadedFiles = [];
-	var moduleObjects = [];
+	const loadedModuleFiles = [];
+	const loadedFiles = [];
+	const moduleObjects = [];
 
 	/* Private Methods */
 
-	/* loadModules()
+	/**
 	 * Loops thru all modules and requests load for every module.
 	 */
-	var loadModules = function() {
+	const loadModules = function () {
+		let moduleData = getModuleData();
 
-		var moduleData = getModuleData();
-
-		var loadNextModule = function() {
+		const loadNextModule = function () {
 			if (moduleData.length > 0) {
-				var nextModule = moduleData[0];
-				loadModule(nextModule, function() {
+				const nextModule = moduleData[0];
+				loadModule(nextModule, function () {
 					moduleData = moduleData.slice(1);
 					loadNextModule();
 				});
@@ -35,94 +33,100 @@ var Loader = (function() {
 				// This is done after all the modules so we can
 				// overwrite all the defined styles.
 
-				loadFile(config.customCss, function() {
+				loadFile(config.customCss, function () {
 					// custom.css loaded. Start all modules.
 					startModules();
 				});
-
 			}
 		};
 
 		loadNextModule();
 	};
 
-	/* startModules()
+	/**
 	 * Loops thru all modules and requests start for every module.
 	 */
-	var startModules = function() {
-		for (var m in moduleObjects) {
-			var module = moduleObjects[m];
+	const startModules = function () {
+		for (const module of moduleObjects) {
 			module.start();
 		}
 
-		// Notifiy core of loded modules.
+		// Notify core of loaded modules.
 		MM.modulesStarted(moduleObjects);
+
+		// Starting modules also hides any modules that have requested to be initially hidden
+		for (const thisModule of moduleObjects) {
+			if (thisModule.data.hiddenOnStartup) {
+				Log.info("Initially hiding " + thisModule.name);
+				thisModule.hide();
+			}
+		}
 	};
 
-	/* getAllModules()
+	/**
 	 * Retrieve list of all modules.
 	 *
-	 * return array - module data as configured in config
+	 * @returns {object[]} module data as configured in config
 	 */
-	var getAllModules = function() {
+	const getAllModules = function () {
 		return config.modules;
 	};
 
-	/* getModuleData()
+	/**
 	 * Generate array with module information including module paths.
 	 *
-	 * return array - Module information.
+	 * @returns {object[]} Module information.
 	 */
-	var getModuleData = function() {
-		var modules = getAllModules();
-		var moduleFiles = [];
+	const getModuleData = function () {
+		const modules = getAllModules();
+		const moduleFiles = [];
 
-		for (var m in modules) {
-			var moduleData = modules[m];
-			var module = moduleData.module;
+		modules.forEach(function (moduleData, index) {
+			const module = moduleData.module;
 
-			var elements = module.split("/");
-			var moduleName = elements[elements.length - 1];
-			var moduleFolder =  config.paths.modules + "/" + module;
+			const elements = module.split("/");
+			const moduleName = elements[elements.length - 1];
+			let moduleFolder = config.paths.modules + "/" + module;
 
 			if (defaultModules.indexOf(moduleName) !== -1) {
-				moduleFolder =  config.paths.modules + "/default/" + module;
+				moduleFolder = config.paths.modules + "/default/" + module;
 			}
 
 			if (moduleData.disabled === true) {
-				continue;
+				return;
 			}
 
 			moduleFiles.push({
-				index: m,
-				identifier: "module_" + m + "_" + module,
+				index: index,
+				identifier: "module_" + index + "_" + module,
 				name: moduleName,
-				path: moduleFolder + "/" ,
+				path: moduleFolder + "/",
 				file: moduleName + ".js",
 				position: moduleData.position,
+				hiddenOnStartup: moduleData.hiddenOnStartup,
 				header: moduleData.header,
+				configDeepMerge: typeof moduleData.configDeepMerge === "boolean" ? moduleData.configDeepMerge : false,
 				config: moduleData.config,
-				classes: (typeof moduleData.classes !== "undefined") ? moduleData.classes + " " + module : module
+				classes: typeof moduleData.classes !== "undefined" ? moduleData.classes + " " + module : module
 			});
-
-		}
+		});
 
 		return moduleFiles;
 	};
 
-	/* loadModule(module)
-	 * Load modules via ajax request and create module objects.
+	/**
+	 * Load modules via ajax request and create module objects.s
 	 *
-	 * argument callback function - Function called when done.
-	 * argument module object - Information about the module we want to load.
+	 * @param {object} module Information about the module we want to load.
+	 * @param {Function} callback Function called when done.
 	 */
-	var loadModule = function(module, callback) {
-		var url = module.path + "/" + module.file;
+	const loadModule = function (module, callback) {
+		const url = module.path + module.file;
 
-		var afterLoad = function() {
-			var moduleObject = Module.create(module.name);
+		const afterLoad = function () {
+			const moduleObject = Module.create(module.name);
 			if (moduleObject) {
-				bootstrapModule(module, moduleObject, function() {
+				bootstrapModule(module, moduleObject, function () {
 					callback();
 				});
 			} else {
@@ -133,106 +137,109 @@ var Loader = (function() {
 		if (loadedModuleFiles.indexOf(url) !== -1) {
 			afterLoad();
 		} else {
-			loadFile(url, function() {
+			loadFile(url, function () {
 				loadedModuleFiles.push(url);
 				afterLoad();
 			});
 		}
-
 	};
 
-	/* bootstrapModule(module, mObj)
+	/**
 	 * Bootstrap modules by setting the module data and loading the scripts & styles.
 	 *
-	 * argument module object - Information about the module we want to load.
-	 * argument mObj object - Modules instance.
-	 * argument callback function - Function called when done.
+	 * @param {object} module Information about the module we want to load.
+	 * @param {Module} mObj Modules instance.
+	 * @param {Function} callback Function called when done.
 	 */
-	var bootstrapModule = function(module, mObj, callback) {
+	const bootstrapModule = function (module, mObj, callback) {
 		Log.info("Bootstrapping module: " + module.name);
 
 		mObj.setData(module);
 
-		mObj.loadScripts(function() {
+		mObj.loadScripts(function () {
 			Log.log("Scripts loaded for: " + module.name);
-			mObj.loadStyles(function() {
+			mObj.loadStyles(function () {
 				Log.log("Styles loaded for: " + module.name);
-				mObj.loadTranslations(function() {
+				mObj.loadTranslations(function () {
 					Log.log("Translations loaded for: " + module.name);
 					moduleObjects.push(mObj);
 					callback();
 				});
 			});
 		});
-
 	};
 
-	/* loadFile(fileName)
+	/**
 	 * Load a script or stylesheet by adding it to the dom.
 	 *
-	 * argument fileName string - Path of the file we want to load.
-	 * argument callback function - Function called when done.
+	 * @param {string} fileName Path of the file we want to load.
+	 * @param {Function} callback Function called when done.
 	 */
-	var loadFile = function(fileName, callback) {
-
-		var extension =  fileName.slice((Math.max(0, fileName.lastIndexOf(".")) || Infinity) + 1);
+	const loadFile = function (fileName, callback) {
+		const extension = fileName.slice((Math.max(0, fileName.lastIndexOf(".")) || Infinity) + 1);
+		let script, stylesheet;
 
 		switch (extension.toLowerCase()) {
-		case "js":
-			Log.log("Load script: " + fileName);
-			var script = document.createElement("script");
-			script.type = "text/javascript";
-			script.src = fileName;
-			script.onload = function() {
-				if (typeof callback === "function") {callback();}
-			};
-			script.onerror = function() {
-				console.error("Error on loading script:", fileName);
-				if (typeof callback === "function") {callback();}
-			};
+			case "js":
+				Log.log("Load script: " + fileName);
+				script = document.createElement("script");
+				script.type = "text/javascript";
+				script.src = fileName;
+				script.onload = function () {
+					if (typeof callback === "function") {
+						callback();
+					}
+				};
+				script.onerror = function () {
+					Log.error("Error on loading script:", fileName);
+					if (typeof callback === "function") {
+						callback();
+					}
+				};
 
-			document.getElementsByTagName("body")[0].appendChild(script);
-			break;
-		case "css":
-			Log.log("Load stylesheet: " + fileName);
-			var stylesheet = document.createElement("link");
-			stylesheet.rel = "stylesheet";
-			stylesheet.type = "text/css";
-			stylesheet.href = fileName;
-			stylesheet.onload = function() {
-				if (typeof callback === "function") {callback();}
-			};
-			stylesheet.onerror = function() {
-				console.error("Error on loading stylesheet:", fileName);
-				if (typeof callback === "function") {callback();}
-			};
+				document.getElementsByTagName("body")[0].appendChild(script);
+				break;
+			case "css":
+				Log.log("Load stylesheet: " + fileName);
+				stylesheet = document.createElement("link");
+				stylesheet.rel = "stylesheet";
+				stylesheet.type = "text/css";
+				stylesheet.href = fileName;
+				stylesheet.onload = function () {
+					if (typeof callback === "function") {
+						callback();
+					}
+				};
+				stylesheet.onerror = function () {
+					Log.error("Error on loading stylesheet:", fileName);
+					if (typeof callback === "function") {
+						callback();
+					}
+				};
 
-			document.getElementsByTagName("head")[0].appendChild(stylesheet);
-			break;
+				document.getElementsByTagName("head")[0].appendChild(stylesheet);
+				break;
 		}
-
 	};
 
 	/* Public Methods */
 	return {
-
-		/* loadModules()
+		/**
 		 * Load all modules as defined in the config.
 		 */
-		loadModules: function() {
+		loadModules: function () {
 			loadModules();
 		},
 
-		/* loadFile()
+		/**
 		 * Load a file (script or stylesheet).
 		 * Prevent double loading and search for files in the vendor folder.
 		 *
-		 * argument fileName string - Path of the file we want to load.
-		 * argument module Module Object - the module that calls the loadFile function.
-		 * argument callback function - Function called when done.
+		 * @param {string} fileName Path of the file we want to load.
+		 * @param {Module} module The module that calls the loadFile function.
+		 * @param {Function} callback Function called when done.
 		 */
-		loadFile: function(fileName, module, callback) {
-
+		loadFile: function (fileName, module, callback) {
 			if (loadedFiles.indexOf(fileName.toLowerCase()) !== -1) {
 				Log.log("File already loaded: " + fileName);
 				callback();
@@ -261,5 +268,4 @@ var Loader = (function() {
 			loadFile(module.file(fileName), callback);
 		}
 	};
-
 })();

js/logger.js

@@ -1,27 +1,79 @@
-/* global console */
-/* exported Log */
-
-/* Magic Mirror
- * Logger
+/* MagicMirror²
+ * Log
  *
- * By Michael Teeuw http://michaelteeuw.nl
+ * This logger is very simple, but needs to be extended.
+ * This system can eventually be used to push the log messages to an external target.
+ *
+ * By Michael Teeuw https://michaelteeuw.nl
  * MIT Licensed.
  */
+(function (root, factory) {
+	if (typeof exports === "object") {
+		if (process.env.JEST_WORKER_ID === undefined) {
+			// add timestamps in front of log messages
+			require("console-stamp")(console, {
+				pattern: "yyyy-mm-dd HH:MM:ss.l",
+				include: ["debug", "log", "info", "warn", "error"]
+			});
+		}
+		// Node, CommonJS-like
+		module.exports = factory(root.config);
+	} else {
+		// Browser globals (root is window)
+		root.Log = factory(root.config);
+	}
+})(this, function (config) {
+	let logLevel;
+	let enableLog;
+	if (typeof exports === "object") {
+		// in nodejs and not running with jest
+		enableLog = process.env.JEST_WORKER_ID === undefined;
+	} else {
+		// in browser and not running with jsdom
+		enableLog = typeof window === "object" && window.name !== "jsdom";
+	}
 
-// This logger is very simple, but needs to be extended.
-// This system can eventually be used to push the log messages to an external target.
+	if (enableLog) {
+		logLevel = {
+			debug: Function.prototype.bind.call(console.debug, console),
+			log: Function.prototype.bind.call(console.log, console),
+			info: Function.prototype.bind.call(console.info, console),
+			warn: Function.prototype.bind.call(console.warn, console),
+			error: Function.prototype.bind.call(console.error, console),
+			group: Function.prototype.bind.call(console.group, console),
+			groupCollapsed: Function.prototype.bind.call(console.groupCollapsed, console),
+			groupEnd: Function.prototype.bind.call(console.groupEnd, console),
+			time: Function.prototype.bind.call(console.time, console),
+			timeEnd: Function.prototype.bind.call(console.timeEnd, console),
+			timeStamp: Function.prototype.bind.call(console.timeStamp, console)
+		};
 
-var Log = (function() {
-	return {
-		info: Function.prototype.bind.call(console.info, console),
-		log:  Function.prototype.bind.call(console.log, console),
-		error: Function.prototype.bind.call(console.error, console),
-		warn: Function.prototype.bind.call(console.warn, console),
-		group: Function.prototype.bind.call(console.group, console),
-		groupCollapsed: Function.prototype.bind.call(console.groupCollapsed, console),
-		groupEnd: Function.prototype.bind.call(console.groupEnd, console),
-		time: Function.prototype.bind.call(console.time, console),
-		timeEnd: Function.prototype.bind.call(console.timeEnd, console),
-		timeStamp: Function.prototype.bind.call(console.timeStamp, console)
-	};
-})();
+		logLevel.setLogLevel = function (newLevel) {
+			if (newLevel) {
+				Object.keys(logLevel).forEach(function (key, index) {
+					if (!newLevel.includes(key.toLocaleUpperCase())) {
+						logLevel[key] = function () {};
+					}
+				});
+			}
+		};
+	} else {
+		logLevel = {
+			debug: function () {},
+			log: function () {},
+			info: function () {},
+			warn: function () {},
+			error: function () {},
+			group: function () {},
+			groupCollapsed: function () {},
+			groupEnd: function () {},
+			time: function () {},
+			timeEnd: function () {},
+			timeStamp: function () {}
+		};
+
+		logLevel.setLogLevel = function () {};
+	}
+
+	return logLevel;
+});

js/main.js

@@ -1,34 +1,30 @@
-/* global  Log, Loader, Module, config, defaults */
-/* jshint -W020, esversion: 6 */
+/* global Loader, defaults, Translator */
 
-/* Magic Mirror
+/* MagicMirror²
  * Main System
  *
- * By Michael Teeuw http://michaelteeuw.nl
+ * By Michael Teeuw https://michaelteeuw.nl
  * MIT Licensed.
  */
-
-var MM = (function() {
-
-	var modules = [];
+const MM = (function () {
+	let modules = [];
 
 	/* Private Methods */
 
-	/* createDomObjects()
-	 * Create dom objects for all modules that
-	 * are configured for a specific position.
+	/**
+	 * Create dom objects for all modules that are configured for a specific position.
 	 */
-	var createDomObjects = function() {
-		var domCreationPromises = [];
+	const createDomObjects = function () {
+		const domCreationPromises = [];
 
-		modules.forEach(function(module) {
+		modules.forEach(function (module) {
 			if (typeof module.data.position !== "string") {
 				return;
 			}
 
-			var wrapper = selectWrapper(module.data.position);
+			const wrapper = selectWrapper(module.data.position);
 
-			var dom = document.createElement("div");
+			const dom = document.createElement("div");
 			dom.id = module.identifier;
 			dom.className = module.name;
 
@@ -39,102 +35,109 @@ var MM = (function() {
 			dom.opacity = 0;
 			wrapper.appendChild(dom);
 
-			if (typeof module.data.header !== "undefined" && module.data.header !== "") {
-				var moduleHeader = document.createElement("header");
-				moduleHeader.innerHTML = module.data.header;
-				moduleHeader.className = "module-header";
-				dom.appendChild(moduleHeader);
+			const moduleHeader = document.createElement("header");
+			moduleHeader.innerHTML = module.getHeader();
+			moduleHeader.className = "module-header";
+			dom.appendChild(moduleHeader);
+
+			if (typeof module.getHeader() === "undefined" || module.getHeader() !== "") {
+				moduleHeader.style.display = "none;";
+			} else {
+				moduleHeader.style.display = "block;";
 			}
 
-			var moduleContent = document.createElement("div");
+			const moduleContent = document.createElement("div");
 			moduleContent.className = "module-content";
 			dom.appendChild(moduleContent);
 
-			var domCreationPromise = updateDom(module, 0);
+			const domCreationPromise = updateDom(module, 0);
 			domCreationPromises.push(domCreationPromise);
-			domCreationPromise.then(function() {
-				sendNotification("MODULE_DOM_CREATED", null, null, module);
-			}).catch(Log.error);
+			domCreationPromise
+				.then(function () {
+					sendNotification("MODULE_DOM_CREATED", null, null, module);
+				})
+				.catch(Log.error);
 		});
 
 		updateWrapperStates();
 
-		Promise.all(domCreationPromises).then(function() {
+		Promise.all(domCreationPromises).then(function () {
 			sendNotification("DOM_OBJECTS_CREATED");
 		});
 	};
 
-	/* selectWrapper(position)
+	/**
 	 * Select the wrapper dom object for a specific position.
 	 *
-	 * argument position string - The name of the position.
+	 * @param {string} position The name of the position.
+	 * @returns {HTMLElement} the wrapper element
 	 */
-	var selectWrapper = function(position) {
-		var classes = position.replace("_"," ");
-		var parentWrapper = document.getElementsByClassName(classes);
+	const selectWrapper = function (position) {
+		const classes = position.replace("_", " ");
+		const parentWrapper = document.getElementsByClassName(classes);
 		if (parentWrapper.length > 0) {
-			var wrapper = parentWrapper[0].getElementsByClassName("container");
+			const wrapper = parentWrapper[0].getElementsByClassName("container");
 			if (wrapper.length > 0) {
 				return wrapper[0];
 			}
 		}
 	};
 
-	/* sendNotification(notification, payload, sender)
+	/**
 	 * Send a notification to all modules.
 	 *
-	 * argument notification string - The identifier of the notification.
-	 * argument payload mixed - The payload of the notification.
-	 * argument sender Module - The module that sent the notification.
-	 * argument sendTo Module - The module to send the notification to. (optional)
+	 * @param {string} notification The identifier of the notification.
+	 * @param {*} payload The payload of the notification.
+	 * @param {Module} sender The module that sent the notification.
+	 * @param {Module} [sendTo] The (optional) module to send the notification to.
 	 */
-	var sendNotification = function(notification, payload, sender, sendTo) {
-		for (var m in modules) {
-			var module = modules[m];
+	const sendNotification = function (notification, payload, sender, sendTo) {
+		for (const m in modules) {
+			const module = modules[m];
 			if (module !== sender && (!sendTo || module === sendTo)) {
 				module.notificationReceived(notification, payload, sender);
 			}
 		}
 	};
 
-	/* updateDom(module, speed)
+	/**
 	 * Update the dom for a specific module.
 	 *
-	 * argument module Module - The module that needs an update.
-	 * argument speed Number - The number of microseconds for the animation. (optional)
-	 *
-	 * return Promise - Resolved when the dom is fully updated.
+	 * @param {Module} module The module that needs an update.
+	 * @param {number} [speed] The (optional) number of microseconds for the animation.
+	 * @returns {Promise} Resolved when the dom is fully updated.
 	 */
-	var updateDom = function(module, speed) {
-		return new Promise(function(resolve) {
-			var newContentPromise = module.getDom();
-			var newHeader = module.getHeader();
+	const updateDom = function (module, speed) {
+		return new Promise(function (resolve) {
+			const newHeader = module.getHeader();
+			let newContentPromise = module.getDom();
 
 			if (!(newContentPromise instanceof Promise)) {
 				// convert to a promise if not already one to avoid if/else's everywhere
 				newContentPromise = Promise.resolve(newContentPromise);
 			}
 
-			newContentPromise.then(function(newContent) {
-				var updatePromise = updateDomWithContent(module, speed, newHeader, newContent);
+			newContentPromise
+				.then(function (newContent) {
+					const updatePromise = updateDomWithContent(module, speed, newHeader, newContent);
 
-				updatePromise.then(resolve).catch(Log.error);
-			}).catch(Log.error);
+					updatePromise.then(resolve).catch(Log.error);
+				})
+				.catch(Log.error);
 		});
 	};
 
-	/* updateDomWithContent(module, speed, newHeader, newContent)
+	/**
 	 * Update the dom with the specified content
 	 *
-	 * argument module Module - The module that needs an update.
-	 * argument speed Number - The number of microseconds for the animation. (optional)
-	 * argument newHeader String - The new header that is generated.
-	 * argument newContent Domobject - The new content that is generated.
-	 *
-	 * return Promise - Resolved when the module dom has been updated.
+	 * @param {Module} module The module that needs an update.
+	 * @param {number} [speed] The (optional) number of microseconds for the animation.
+	 * @param {string} newHeader The new header that is generated.
+	 * @param {HTMLElement} newContent The new content that is generated.
+	 * @returns {Promise} Resolved when the module dom has been updated.
 	 */
-	var updateDomWithContent = function(module, speed, newHeader, newContent) {
-		return new Promise(function(resolve) {
+	const updateDomWithContent = function (module, speed, newHeader, newContent) {
+		return new Promise(function (resolve) {
 			if (module.hidden || !speed) {
 				updateModuleContent(module, newHeader, newContent);
 				resolve();
@@ -152,7 +155,7 @@ var MM = (function() {
 				return;
 			}
 
-			hideModule(module, speed / 2, function() {
+			hideModule(module, speed / 2, function () {
 				updateModuleContent(module, newHeader, newContent);
 				if (!module.hidden) {
 					showModule(module, speed / 2);
@@ -162,62 +165,72 @@ var MM = (function() {
 		});
 	};
 
-	/* moduleNeedsUpdate(module, newContent)
+	/**
 	 * Check if the content has changed.
 	 *
-	 * argument module Module - The module to check.
-	 * argument newHeader String - The new header that is generated.
-	 * argument newContent Domobject - The new content that is generated.
-	 *
-	 * return bool - Does the module need an update?
+	 * @param {Module} module The module to check.
+	 * @param {string} newHeader The new header that is generated.
+	 * @param {HTMLElement} newContent The new content that is generated.
+	 * @returns {boolean} True if the module need an update, false otherwise
 	 */
-	var moduleNeedsUpdate = function(module, newHeader, newContent) {
-		var moduleWrapper = document.getElementById(module.identifier);
-		var contentWrapper = moduleWrapper.getElementsByClassName("module-content");
-		var headerWrapper = moduleWrapper.getElementsByClassName("module-header");
+	const moduleNeedsUpdate = function (module, newHeader, newContent) {
+		const moduleWrapper = document.getElementById(module.identifier);
+		if (moduleWrapper === null) {
+			return false;
+		}
 
-		var headerNeedsUpdate = false;
-		var contentNeedsUpdate = false;
+		const contentWrapper = moduleWrapper.getElementsByClassName("module-content");
+		const headerWrapper = moduleWrapper.getElementsByClassName("module-header");
+
+		let headerNeedsUpdate = false;
+		let contentNeedsUpdate;
 
 		if (headerWrapper.length > 0) {
 			headerNeedsUpdate = newHeader !== headerWrapper[0].innerHTML;
 		}
 
-		var tempContentWrapper = document.createElement("div");
+		const tempContentWrapper = document.createElement("div");
 		tempContentWrapper.appendChild(newContent);
 		contentNeedsUpdate = tempContentWrapper.innerHTML !== contentWrapper[0].innerHTML;
 
 		return headerNeedsUpdate || contentNeedsUpdate;
 	};
 
-	/* moduleNeedsUpdate(module, newContent)
+	/**
 	 * Update the content of a module on screen.
 	 *
-	 * argument module Module - The module to check.
-	 * argument newHeader String - The new header that is generated.
-	 * argument newContent Domobject - The new content that is generated.
+	 * @param {Module} module The module to check.
+	 * @param {string} newHeader The new header that is generated.
+	 * @param {HTMLElement} newContent The new content that is generated.
 	 */
-	var updateModuleContent = function(module, newHeader, newContent) {
-		var moduleWrapper = document.getElementById(module.identifier);
-		var headerWrapper = moduleWrapper.getElementsByClassName("module-header");
-		var contentWrapper = moduleWrapper.getElementsByClassName("module-content");
+	const updateModuleContent = function (module, newHeader, newContent) {
+		const moduleWrapper = document.getElementById(module.identifier);
+		if (moduleWrapper === null) {
+			return;
+		}
+		const headerWrapper = moduleWrapper.getElementsByClassName("module-header");
+		const contentWrapper = moduleWrapper.getElementsByClassName("module-content");
 
 		contentWrapper[0].innerHTML = "";
 		contentWrapper[0].appendChild(newContent);
 
-		if( headerWrapper.length > 0 && newHeader) {
-			headerWrapper[0].innerHTML = newHeader;
+		headerWrapper[0].innerHTML = newHeader;
+		if (headerWrapper.length > 0 && newHeader) {
+			headerWrapper[0].style.display = "block";
+		} else {
+			headerWrapper[0].style.display = "none";
 		}
 	};
 
-	/* hideModule(module, speed, callback)
+	/**
 	 * Hide the module.
 	 *
-	 * argument module Module - The module to hide.
-	 * argument speed Number - The speed of the hide animation.
-	 * argument callback function - Called when the animation is done.
+	 * @param {Module} module The module to hide.
+	 * @param {number} speed The speed of the hide animation.
+	 * @param {Function} callback Called when the animation is done.
+	 * @param {object} [options] Optional settings for the hide method.
 	 */
-	var hideModule = function(module, speed, callback, options) {
+	const hideModule = function (module, speed, callback, options) {
 		options = options || {};
 
 		// set lockString if set in options.
@@ -228,13 +241,14 @@ var MM = (function() {
 			}
 		}
 
-		var moduleWrapper = document.getElementById(module.identifier);
+		const moduleWrapper = document.getElementById(module.identifier);
 		if (moduleWrapper !== null) {
 			moduleWrapper.style.transition = "opacity " + speed / 1000 + "s";
 			moduleWrapper.style.opacity = 0;
+			moduleWrapper.classList.add("hidden");
 
 			clearTimeout(module.showHideTimer);
-			module.showHideTimer = setTimeout(function() {
+			module.showHideTimer = setTimeout(function () {
 				// To not take up any space, we just make the position absolute.
 				// since it's fade out anyway, we can see it lay above or
 				// below other modules. This works way better than adjusting
@@ -243,28 +257,33 @@ var MM = (function() {
 
 				updateWrapperStates();
 
-				if (typeof callback === "function") { callback(); }
+				if (typeof callback === "function") {
+					callback();
+				}
 			}, speed);
 		} else {
 			// invoke callback even if no content, issue 1308
-			if (typeof callback === "function") { callback(); }
+			if (typeof callback === "function") {
+				callback();
+			}
 		}
 	};
 
-	/* showModule(module, speed, callback)
+	/**
 	 * Show the module.
 	 *
-	 * argument module Module - The module to show.
-	 * argument speed Number - The speed of the show animation.
-	 * argument callback function - Called when the animation is done.
+	 * @param {Module} module The module to show.
+	 * @param {number} speed The speed of the show animation.
+	 * @param {Function} callback Called when the animation is done.
+	 * @param {object} [options] Optional settings for the show method.
 	 */
-	var showModule = function(module, speed, callback, options) {
+	const showModule = function (module, speed, callback, options) {
 		options = options || {};
 
 		// remove lockString if set in options.
 		if (options.lockString) {
-			var index = module.lockStrings.indexOf(options.lockString);
-			if ( index !== -1) {
+			const index = module.lockStrings.indexOf(options.lockString);
+			if (index !== -1) {
 				module.lockStrings.splice(index, 1);
 			}
 		}
@@ -273,6 +292,9 @@ var MM = (function() {
 		// Otherwise cancel show action.
 		if (module.lockStrings.length !== 0 && options.force !== true) {
 			Log.log("Will not show " + module.name + ". LockStrings active: " + module.lockStrings.join(","));
+			if (typeof options.onError === "function") {
+				options.onError(new Error("LOCK_STRING_ACTIVE"));
+			}
 			return;
 		}
 
@@ -284,30 +306,37 @@ var MM = (function() {
 			module.lockStrings = [];
 		}
 
-		var moduleWrapper = document.getElementById(module.identifier);
+		const moduleWrapper = document.getElementById(module.identifier);
 		if (moduleWrapper !== null) {
 			moduleWrapper.style.transition = "opacity " + speed / 1000 + "s";
-			// Restore the postition. See hideModule() for more info.
+			// Restore the position. See hideModule() for more info.
 			moduleWrapper.style.position = "static";
+			moduleWrapper.classList.remove("hidden");
 
 			updateWrapperStates();
 
 			// Waiting for DOM-changes done in updateWrapperStates before we can start the animation.
-			var dummy = moduleWrapper.parentElement.parentElement.offsetHeight;
+			const dummy = moduleWrapper.parentElement.parentElement.offsetHeight;
 			moduleWrapper.style.opacity = 1;
 
 			clearTimeout(module.showHideTimer);
-			module.showHideTimer = setTimeout(function() {
-				if (typeof callback === "function") { callback(); }
+			module.showHideTimer = setTimeout(function () {
+				if (typeof callback === "function") {
+					callback();
+				}
 			}, speed);
-
+		} else {
+			// invoke callback
+			if (typeof callback === "function") {
+				callback();
+			}
 		}
 	};
 
-	/* updateWrapperStates()
+	/**
 	 * Checks for all positions if it has visible content.
 	 * If not, if will hide the position to prevent unwanted margins.
-	 * This method schould be called by the show and hide methods.
+	 * This method should be called by the show and hide methods.
 	 *
 	 * Example:
 	 * If the top_bar only contains the update notification. And no update is available,
@@ -315,17 +344,16 @@ var MM = (function() {
 	 * an ugly top margin. By using this function, the top bar will be hidden if the
 	 * update notification is not visible.
 	 */
+	const updateWrapperStates = function () {
+		const positions = ["top_bar", "top_left", "top_center", "top_right", "upper_third", "middle_center", "lower_third", "bottom_left", "bottom_center", "bottom_right", "bottom_bar", "fullscreen_above", "fullscreen_below"];
 
-	var updateWrapperStates = function() {
-		var positions = ["top_bar", "top_left", "top_center", "top_right", "upper_third", "middle_center", "lower_third", "bottom_left", "bottom_center", "bottom_right", "bottom_bar", "fullscreen_above", "fullscreen_below"];
+		positions.forEach(function (position) {
+			const wrapper = selectWrapper(position);
+			const moduleWrappers = wrapper.getElementsByClassName("module");
 
-		positions.forEach(function(position) {
-			var wrapper = selectWrapper(position);
-			var moduleWrappers = wrapper.getElementsByClassName("module");
-
-			var showWrapper = false;
-			Array.prototype.forEach.call(moduleWrappers, function(moduleWrapper) {
-				if (moduleWrapper.style.position == "" || moduleWrapper.style.position == "static") {
+			let showWrapper = false;
+			Array.prototype.forEach.call(moduleWrappers, function (moduleWrapper) {
+				if (moduleWrapper.style.position === "" || moduleWrapper.style.position === "static") {
 					showWrapper = true;
 				}
 			});
@@ -334,10 +362,12 @@ var MM = (function() {
 		});
 	};
 
-	/* loadConfig()
-	 * Loads the core config and combines it with de system defaults.
+	/**
+	 * Loads the core config and combines it with the system defaults.
 	 */
-	var loadConfig = function() {
+	const loadConfig = function () {
+		// FIXME: Think about how to pass config around without breaking tests
+		/* eslint-disable */
 		if (typeof config === "undefined") {
 			config = defaults;
 			Log.error("Config file is missing! Please create a config file.");
@@ -345,56 +375,52 @@ var MM = (function() {
 		}
 
 		config = Object.assign({}, defaults, config);
+		/* eslint-enable */
 	};
 
-	/* setSelectionMethodsForModules()
+	/**
 	 * Adds special selectors on a collection of modules.
 	 *
-	 * argument modules array - Array of modules.
+	 * @param {Module[]} modules Array of modules.
 	 */
-	var setSelectionMethodsForModules = function(modules) {
-
-		/* withClass(className)
-		 * calls modulesByClass to filter modules with the specified classes.
+	const setSelectionMethodsForModules = function (modules) {
+		/**
+		 * Filter modules with the specified classes.
 		 *
-		 * argument className string/array - one or multiple classnames. (array or space divided)
-		 *
-		 * return array - Filtered collection of modules.
+		 * @param {string|string[]} className one or multiple classnames (array or space divided).
+		 * @returns {Module[]} Filtered collection of modules.
 		 */
-		var withClass = function(className) {
+		const withClass = function (className) {
 			return modulesByClass(className, true);
 		};
 
-		/* exceptWithClass(className)
-		 * calls modulesByClass to filter modules without the specified classes.
+		/**
+		 * Filter modules without the specified classes.
 		 *
-		 * argument className string/array - one or multiple classnames. (array or space divided)
-		 *
-		 * return array - Filtered collection of modules.
+		 * @param {string|string[]} className one or multiple classnames (array or space divided).
+		 * @returns {Module[]} Filtered collection of modules.
 		 */
-		var exceptWithClass  = function(className) {
+		const exceptWithClass = function (className) {
 			return modulesByClass(className, false);
 		};
 
-		/* modulesByClass(className, include)
-		 * filters a collection of modules based on classname(s).
+		/**
+		 * Filters a collection of modules based on classname(s).
 		 *
-		 * argument className string/array - one or multiple classnames. (array or space divided)
-		 * argument include boolean - if the filter should include or exclude the modules with the specific classes.
-		 *
-		 * return array - Filtered collection of modules.
+		 * @param {string|string[]} className one or multiple classnames (array or space divided).
+		 * @param {boolean} include if the filter should include or exclude the modules with the specific classes.
+		 * @returns {Module[]} Filtered collection of modules.
 		 */
-		var modulesByClass = function(className, include) {
-			var searchClasses = className;
+		const modulesByClass = function (className, include) {
+			let searchClasses = className;
 			if (typeof className === "string") {
 				searchClasses = className.split(" ");
 			}
 
-			var newModules = modules.filter(function(module) {
-				var classes = module.data.classes.toLowerCase().split(" ");
+			const newModules = modules.filter(function (module) {
+				const classes = module.data.classes.toLowerCase().split(" ");
 
-				for (var c in searchClasses) {
-					var searchClass = searchClasses[c];
+				for (const searchClass of searchClasses) {
 					if (classes.indexOf(searchClass.toLowerCase()) !== -1) {
 						return include;
 					}
@@ -407,15 +433,14 @@ var MM = (function() {
 			return newModules;
 		};
 
-		/* exceptModule(module)
+		/**
 		 * Removes a module instance from the collection.
 		 *
-		 * argument module Module object - The module instance to remove from the collection.
-		 *
-		 * return array - Filtered collection of modules.
+		 * @param {object} module The module instance to remove from the collection.
+		 * @returns {Module[]} Filtered collection of modules.
 		 */
-		var exceptModule = function(module) {
-			var newModules = modules.filter(function(mod) {
+		const exceptModule = function (module) {
+			const newModules = modules.filter(function (mod) {
 				return mod.identifier !== module.identifier;
 			});
 
@@ -423,47 +448,55 @@ var MM = (function() {
 			return newModules;
 		};
 
-		/* enumerate(callback)
+		/**
 		 * Walks thru a collection of modules and executes the callback with the module as an argument.
 		 *
-		 * argument callback function - The function to execute with the module as an argument.
+		 * @param {Function} callback The function to execute with the module as an argument.
 		 */
-		var enumerate = function(callback) {
-			modules.map(function(module) {
+		const enumerate = function (callback) {
+			modules.map(function (module) {
 				callback(module);
 			});
 		};
 
-		if (typeof modules.withClass === "undefined") { Object.defineProperty(modules, "withClass",  {value: withClass, enumerable: false}); }
-		if (typeof modules.exceptWithClass === "undefined") { Object.defineProperty(modules, "exceptWithClass",  {value: exceptWithClass, enumerable: false}); }
-		if (typeof modules.exceptModule === "undefined") { Object.defineProperty(modules, "exceptModule",  {value: exceptModule, enumerable: false}); }
-		if (typeof modules.enumerate === "undefined") { Object.defineProperty(modules, "enumerate",  {value: enumerate, enumerable: false}); }
+		if (typeof modules.withClass === "undefined") {
+			Object.defineProperty(modules, "withClass", { value: withClass, enumerable: false });
+		}
+		if (typeof modules.exceptWithClass === "undefined") {
+			Object.defineProperty(modules, "exceptWithClass", { value: exceptWithClass, enumerable: false });
+		}
+		if (typeof modules.exceptModule === "undefined") {
+			Object.defineProperty(modules, "exceptModule", { value: exceptModule, enumerable: false });
+		}
+		if (typeof modules.enumerate === "undefined") {
+			Object.defineProperty(modules, "enumerate", { value: enumerate, enumerable: false });
+		}
 	};
 
 	return {
 		/* Public Methods */
 
-		/* init()
+		/**
 		 * Main init method.
 		 */
-		init: function() {
-			Log.info("Initializing MagicMirror.");
+		init: function () {
+			Log.info("Initializing MagicMirror².");
 			loadConfig();
+
+			Log.setLogLevel(config.logLevel);
+
 			Translator.loadCoreTranslations(config.language);
 			Loader.loadModules();
 		},
 
-		/* modulesStarted(moduleObjects)
+		/**
 		 * Gets called when all modules are started.
 		 *
-		 * argument moduleObjects array<Module> - All module instances.
+		 * @param {Module[]} moduleObjects All module instances.
 		 */
-		modulesStarted: function(moduleObjects) {
+		modulesStarted: function (moduleObjects) {
 			modules = [];
-			for (var m in moduleObjects) {
-				var module = moduleObjects[m];
-				modules[module.data.index] = module;
-			}
+			moduleObjects.forEach((module) => modules.push(module));
 
 			Log.info("All modules started!");
 			sendNotification("ALL_MODULES_STARTED");
@@ -471,14 +504,14 @@ var MM = (function() {
 			createDomObjects();
 		},
 
-		/* sendNotification(notification, payload, sender)
+		/**
 		 * Send a notification to all modules.
 		 *
-		 * argument notification string - The identifier of the noitication.
-		 * argument payload mixed - The payload of the notification.
-		 * argument sender Module - The module that sent the notification.
+		 * @param {string} notification The identifier of the notification.
+		 * @param {*} payload The payload of the notification.
+		 * @param {Module} sender The module that sent the notification.
 		 */
-		sendNotification: function(notification, payload, sender) {
+		sendNotification: function (notification, payload, sender) {
 			if (arguments.length < 3) {
 				Log.error("sendNotification: Missing arguments.");
 				return;
@@ -498,74 +531,78 @@ var MM = (function() {
 			sendNotification(notification, payload, sender);
 		},
 
-		/* updateDom(module, speed)
+		/**
 		 * Update the dom for a specific module.
 		 *
-		 * argument module Module - The module that needs an update.
-		 * argument speed Number - The number of microseconds for the animation. (optional)
+		 * @param {Module} module The module that needs an update.
+		 * @param {number} [speed] The number of microseconds for the animation.
 		 */
-		updateDom: function(module, speed) {
+		updateDom: function (module, speed) {
 			if (!(module instanceof Module)) {
 				Log.error("updateDom: Sender should be a module.");
 				return;
 			}
 
+			if (!module.data.position) {
+				Log.warn("module tries to update the DOM without being displayed.");
+				return;
+			}
+
 			// Further implementation is done in the private method.
 			updateDom(module, speed);
 		},
 
-		/* getModules(module, speed)
+		/**
 		 * Returns a collection of all modules currently active.
 		 *
-		 * return array - A collection of all modules currently active.
+		 * @returns {Module[]} A collection of all modules currently active.
 		 */
-		getModules: function() {
+		getModules: function () {
 			setSelectionMethodsForModules(modules);
 			return modules;
 		},
 
-		/* hideModule(module, speed, callback)
+		/**
 		 * Hide the module.
 		 *
-		 * argument module Module - The module hide.
-		 * argument speed Number - The speed of the hide animation.
-		 * argument callback function - Called when the animation is done.
-		 * argument options object - Optional settings for the hide method.
+		 * @param {Module} module The module to hide.
+		 * @param {number} speed The speed of the hide animation.
+		 * @param {Function} callback Called when the animation is done.
+		 * @param {object} [options] Optional settings for the hide method.
 		 */
-		hideModule: function(module, speed, callback, options) {
+		hideModule: function (module, speed, callback, options) {
 			module.hidden = true;
 			hideModule(module, speed, callback, options);
 		},
 
-		/* showModule(module, speed, callback)
+		/**
 		 * Show the module.
 		 *
-		 * argument module Module - The module show.
-		 * argument speed Number - The speed of the show animation.
-		 * argument callback function - Called when the animation is done.
-		 * argument options object - Optional settings for the hide method.
+		 * @param {Module} module The module to show.
+		 * @param {number} speed The speed of the show animation.
+		 * @param {Function} callback Called when the animation is done.
+		 * @param {object} [options] Optional settings for the show method.
 		 */
-		showModule: function(module, speed, callback, options) {
+		showModule: function (module, speed, callback, options) {
 			// do not change module.hidden yet, only if we really show it later
 			showModule(module, speed, callback, options);
 		}
 	};
-
 })();
 
 // Add polyfill for Object.assign.
-if (typeof Object.assign != "function") {
-	(function() {
-		Object.assign = function(target) {
+if (typeof Object.assign !== "function") {
+	(function () {
+		Object.assign = function (target) {
 			"use strict";
 			if (target === undefined || target === null) {
 				throw new TypeError("Cannot convert undefined or null to object");
 			}
-			var output = Object(target);
-			for (var index = 1; index < arguments.length; index++) {
-				var source = arguments[index];
+			const output = Object(target);
+			for (let index = 1; index < arguments.length; index++) {
+				const source = arguments[index];
 				if (source !== undefined && source !== null) {
-					for (var nextKey in source) {
+					for (const nextKey in source) {
 						if (source.hasOwnProperty(nextKey)) {
 							output[nextKey] = source[nextKey];
 						}

js/module.js

@@ -1,20 +1,18 @@
-/* global Log, Class, Loader, Class , MM */
-/* exported Module */
+/* global Class, cloneObject, Loader, MMSocket, nunjucks, Translator */
 
-/* Magic Mirror
+/* MagicMirror²
  * Module Blueprint.
+ * @typedef {Object} Module
  *
- * By Michael Teeuw http://michaelteeuw.nl
+ * By Michael Teeuw https://michaelteeuw.nl
  * MIT Licensed.
  */
-
-var Module = Class.extend({
-
+const Module = Class.extend({
 	/*********************************************************
 	 * All methods (and properties) below can be subclassed. *
 	 *********************************************************/
 
-	// Set the minimum MagicMirror module version for this module.
+	// Set the minimum MagicMirror² module version for this module.
 	requiresVersion: "2.0.0",
 
 	// Module config defaults.
@@ -32,67 +30,68 @@ var Module = Class.extend({
 	// Use the nunjucksEnvironment() to get it.
 	_nunjucksEnvironment: null,
 
-	/* init()
-	 * Is called when the module is instantiated.
+	/**
+	 * Called when the module is instantiated.
 	 */
 	init: function () {
 		//Log.log(this.defaults);
 	},
 
-	/* start()
-	 * Is called when the module is started.
+	/**
+	 * Called when the module is started.
 	 */
 	start: function () {
 		Log.info("Starting module: " + this.name);
 	},
 
-	/* getScripts()
+	/**
 	 * Returns a list of scripts the module requires to be loaded.
 	 *
-	 * return Array<String> - An array with filenames.
+	 * @returns {string[]} An array with filenames.
 	 */
 	getScripts: function () {
 		return [];
 	},
 
-	/* getStyles()
+	/**
 	 * Returns a list of stylesheets the module requires to be loaded.
 	 *
-	 * return Array<String> - An array with filenames.
+	 * @returns {string[]} An array with filenames.
 	 */
 	getStyles: function () {
 		return [];
 	},
 
-	/* getTranslations()
+	/**
 	 * Returns a map of translation files the module requires to be loaded.
 	 *
-	 * return Map<String, String> - A map with langKeys and filenames.
+	 * return Map<String, String> -
+	 *
+	 * @returns {*} A map with langKeys and filenames.
 	 */
 	getTranslations: function () {
 		return false;
 	},
 
-	/* getDom()
-	 * This method generates the dom which needs to be displayed. This method is called by the Magic Mirror core.
+	/**
+	 * Generates the dom which needs to be displayed. This method is called by the MagicMirror² core.
 	 * This method can to be subclassed if the module wants to display info on the mirror.
-	 * Alternatively, the getTemplete method could be subclassed.
+	 * Alternatively, the getTemplate method could be subclassed.
 	 *
-	 * return DomObject | Promise - The dom or a promise with the dom to display.
+	 * @returns {HTMLElement|Promise} The dom or a promise with the dom to display.
 	 */
 	getDom: function () {
-		var self = this;
-		return new Promise(function(resolve) {
-			var div = document.createElement("div");
-			var template = self.getTemplate();
-			var templateData = self.getTemplateData();
+		return new Promise((resolve) => {
+			const div = document.createElement("div");
+			const template = this.getTemplate();
+			const templateData = this.getTemplateData();
 
 			// Check to see if we need to render a template string or a file.
 			if (/^.*((\.html)|(\.njk))$/.test(template)) {
 				// the template is a filename
-				self.nunjucksEnvironment().render(template, templateData, function (err, res) {
+				this.nunjucksEnvironment().render(template, templateData, function (err, res) {
 					if (err) {
-						Log.error(err)
+						Log.error(err);
 					}
 
 					div.innerHTML = res;
@@ -101,105 +100,103 @@ var Module = Class.extend({
 				});
 			} else {
 				// the template is a template string.
-				div.innerHTML = self.nunjucksEnvironment().renderString(template, templateData);
+				div.innerHTML = this.nunjucksEnvironment().renderString(template, templateData);
 
 				resolve(div);
 			}
 		});
 	},
 
-	/* getHeader()
-	 * This method generates the header string which needs to be displayed if a user has a header configured for this module.
-	 * This method is called by the Magic Mirror core, but only if the user has configured a default header for the module.
+	/**
+	 * Generates the header string which needs to be displayed if a user has a header configured for this module.
+	 * This method is called by the MagicMirror² core, but only if the user has configured a default header for the module.
 	 * This method needs to be subclassed if the module wants to display modified headers on the mirror.
 	 *
-	 * return string - The header to display above the header.
+	 * @returns {string} The header to display above the header.
 	 */
 	getHeader: function () {
 		return this.data.header;
 	},
 
-	/* getTemplate()
-	 * This method returns the template for the module which is used by the default getDom implementation.
-	 * This method needs to be subclassed if the module wants to use a tempate.
+	/**
+	 * Returns the template for the module which is used by the default getDom implementation.
+	 * This method needs to be subclassed if the module wants to use a template.
 	 * It can either return a template sting, or a template filename.
 	 * If the string ends with '.html' it's considered a file from within the module's folder.
 	 *
-	 * return string - The template string of filename.
+	 * @returns {string} The template string of filename.
 	 */
 	getTemplate: function () {
-		return "<div class=\"normal\">" + this.name + "</div><div class=\"small dimmed\">" + this.identifier + "</div>";
+		return '<div class="normal">' + this.name + '</div><div class="small dimmed">' + this.identifier + "</div>";
 	},
 
-	/* getTemplateData()
-	 * This method returns the data to be used in the template.
+	/**
+	 * Returns the data to be used in the template.
 	 * This method needs to be subclassed if the module wants to use a custom data.
 	 *
-	 * return Object
+	 * @returns {object} The data for the template
 	 */
 	getTemplateData: function () {
-		return {}
+		return {};
 	},
 
-	/* notificationReceived(notification, payload, sender)
-	 * This method is called when a notification arrives.
-	 * This method is called by the Magic Mirror core.
+	/**
+	 * Called by the MagicMirror² core when a notification arrives.
 	 *
-	 * argument notification string - The identifier of the notification.
-	 * argument payload mixed - The payload of the notification.
-	 * argument sender Module - The module that sent the notification.
+	 * @param {string} notification The identifier of the notification.
+	 * @param {*} payload The payload of the notification.
+	 * @param {Module} sender The module that sent the notification.
 	 */
 	notificationReceived: function (notification, payload, sender) {
 		if (sender) {
-			Log.log(this.name + " received a module notification: " + notification + " from sender: " + sender.name);
+			// Log.log(this.name + " received a module notification: " + notification + " from sender: " + sender.name);
 		} else {
-			Log.log(this.name + " received a system notification: " + notification);
+			// Log.log(this.name + " received a system notification: " + notification);
 		}
 	},
 
-	/** nunjucksEnvironment()
+	/**
 	 * Returns the nunjucks environment for the current module.
 	 * The environment is checked in the _nunjucksEnvironment instance variable.
-
-	 * @returns Nunjucks Environment
+	 *
+	 * @returns {object} The Nunjucks Environment
 	 */
-	nunjucksEnvironment: function() {
-		if (this._nunjucksEnvironment != null) {
+	nunjucksEnvironment: function () {
+		if (this._nunjucksEnvironment !== null) {
 			return this._nunjucksEnvironment;
 		}
 
-		var self = this;
-
-		this._nunjucksEnvironment = new nunjucks.Environment(new nunjucks.WebLoader(this.file(""), {async: true}), {
+		this._nunjucksEnvironment = new nunjucks.Environment(new nunjucks.WebLoader(this.file(""), { async: true }), {
 			trimBlocks: true,
 			lstripBlocks: true
 		});
-		this._nunjucksEnvironment.addFilter("translate", function(str) {
-			return self.translate(str)
+
+		this._nunjucksEnvironment.addFilter("translate", (str, variables) => {
+			return nunjucks.runtime.markSafe(this.translate(str, variables));
 		});
 
 		return this._nunjucksEnvironment;
 	},
 
-	/* socketNotificationReceived(notification, payload)
-	 * This method is called when a socket notification arrives.
+	/**
+	 * Called when a socket notification arrives.
 	 *
-	 * argument notification string - The identifier of the notification.
-	 * argument payload mixed - The payload of the notification.
+	 * @param {string} notification The identifier of the notification.
+	 * @param {*} payload The payload of the notification.
 	 */
 	socketNotificationReceived: function (notification, payload) {
 		Log.log(this.name + " received a socket notification: " + notification + " - Payload: " + payload);
 	},
 
-	/* suspend()
-	 * This method is called when a module is hidden.
+	/**
+	 * Called when the module is hidden.
 	 */
 	suspend: function () {
 		Log.log(this.name + " is suspended.");
 	},
 
-	/* resume()
-	 * This method is called when a module is shown.
+	/**
+	 * Called when the module is shown.
 	 */
 	resume: function () {
 		Log.log(this.name + " is resumed.");
@@ -209,10 +206,10 @@ var Module = Class.extend({
 	 * The methods below don"t need subclassing. *
 	 *********************************************/
 
-	/* setData(data)
+	/**
 	 * Set the module data.
 	 *
-	 * argument data obejct - Module data.
+	 * @param {object} data The module data
 	 */
 	setData: function (data) {
 		this.data = data;
@@ -220,78 +217,78 @@ var Module = Class.extend({
 		this.identifier = data.identifier;
 		this.hidden = false;
 
-		this.setConfig(data.config);
+		this.setConfig(data.config, data.configDeepMerge);
 	},
 
-	/* setConfig(config)
+	/**
 	 * Set the module config and combine it with the module defaults.
 	 *
-	 * argument config obejct - Module config.
+	 * @param {object} config The combined module config.
+	 * @param {boolean} deep Merge module config in deep.
 	 */
-	setConfig: function (config) {
-		this.config = Object.assign({}, this.defaults, config);
+	setConfig: function (config, deep) {
+		this.config = deep ? configMerge({}, this.defaults, config) : Object.assign({}, this.defaults, config);
 	},
 
-	/* socket()
-	 * Returns a socket object. If it doesn"t exist, it"s created.
+	/**
+	 * Returns a socket object. If it doesn't exist, it's created.
 	 * It also registers the notification callback.
+	 *
+	 * @returns {MMSocket} a socket object
 	 */
 	socket: function () {
 		if (typeof this._socket === "undefined") {
-			this._socket = this._socket = new MMSocket(this.name);
+			this._socket = new MMSocket(this.name);
 		}
 
-		var self = this;
-		this._socket.setNotificationCallback(function (notification, payload) {
-			self.socketNotificationReceived(notification, payload);
+		this._socket.setNotificationCallback((notification, payload) => {
+			this.socketNotificationReceived(notification, payload);
 		});
 
 		return this._socket;
 	},
 
-	/* file(file)
+	/**
 	 * Retrieve the path to a module file.
 	 *
-	 * argument file string - Filename.
-	 *
-	 * return string - File path.
+	 * @param {string} file Filename
+	 * @returns {string} the file path
 	 */
 	file: function (file) {
 		return (this.data.path + "/" + file).replace("//", "/");
 	},
 
-	/* loadStyles()
+	/**
 	 * Load all required stylesheets by requesting the MM object to load the files.
 	 *
-	 * argument callback function - Function called when done.
+	 * @param {Function} callback Function called when done.
 	 */
 	loadStyles: function (callback) {
 		this.loadDependencies("getStyles", callback);
 	},
 
-	/* loadScripts()
+	/**
 	 * Load all required scripts by requesting the MM object to load the files.
 	 *
-	 * argument callback function - Function called when done.
+	 * @param {Function} callback Function called when done.
 	 */
 	loadScripts: function (callback) {
 		this.loadDependencies("getScripts", callback);
 	},
 
-	/* loadDependencies(funcName, callback)
+	/**
 	 * Helper method to load all dependencies.
 	 *
-	 * argument funcName string - Function name to call to get scripts or styles.
-	 * argument callback function - Function called when done.
+	 * @param {string} funcName Function name to call to get scripts or styles.
+	 * @param {Function} callback Function called when done.
 	 */
 	loadDependencies: function (funcName, callback) {
-		var self = this;
-		var dependencies = this[funcName]();
+		let dependencies = this[funcName]();
 
-		var loadNextDependency = function () {
+		const loadNextDependency = () => {
 			if (dependencies.length > 0) {
-				var nextDependency = dependencies[0];
-				Loader.loadFile(nextDependency, self, function () {
+				const nextDependency = dependencies[0];
+				Loader.loadFile(nextDependency, this, () => {
 					dependencies = dependencies.slice(1);
 					loadNextDependency();
 				});
@@ -303,177 +300,237 @@ var Module = Class.extend({
 		loadNextDependency();
 	},
 
-	/* loadScripts()
-	 * Load all required scripts by requesting the MM object to load the files.
+	/**
+	 * Load all translations.
 	 *
-	 * argument callback function - Function called when done.
+	 * @param {Function} callback Function called when done.
 	 */
-	loadTranslations: function (callback) {
-		var self = this;
-		var translations = this.getTranslations();
-		var lang = config.language.toLowerCase();
+	loadTranslations(callback) {
+		const translations = this.getTranslations() || {};
+		const language = config.language.toLowerCase();
 
-		// The variable `first` will contain the first
-		// defined translation after the following line.
-		for (var first in translations) { break; }
+		const languages = Object.keys(translations);
+		const fallbackLanguage = languages[0];
 
-		if (translations) {
-			var translationFile = translations[lang] || undefined;
-			var translationsFallbackFile = translations[first];
-
-			// If a translation file is set, load it and then also load the fallback translation file.
-			// Otherwise only load the fallback translation file.
-			if (translationFile !== undefined && translationFile !== translationsFallbackFile) {
-				Translator.load(self, translationFile, false, function () {
-					Translator.load(self, translationsFallbackFile, true, callback);
-				});
-			} else {
-				Translator.load(self, translationsFallbackFile, true, callback);
-			}
-		} else {
+		if (languages.length === 0) {
 			callback();
+			return;
 		}
+
+		const translationFile = translations[language];
+		const translationsFallbackFile = translations[fallbackLanguage];
+
+		if (!translationFile) {
+			Translator.load(this, translationsFallbackFile, true, callback);
+			return;
+		}
+
+		Translator.load(this, translationFile, false, () => {
+			if (translationFile !== translationsFallbackFile) {
+				Translator.load(this, translationsFallbackFile, true, callback);
+			} else {
+				callback();
+			}
+		});
 	},
 
-	/* translate(key, defaultValueOrVariables, defaultValue)
+	/**
 	 * Request the translation for a given key with optional variables and default value.
 	 *
-	 * argument key string - The key of the string to translate
-     * argument defaultValueOrVariables string/object - The default value or variables for translating. (Optional)
-     * argument defaultValue string - The default value with variables. (Optional)
+	 * @param {string} key The key of the string to translate
+	 * @param {string|object} [defaultValueOrVariables] The default value or variables for translating.
+	 * @param {string} [defaultValue] The default value with variables.
+	 * @returns {string} the translated key
 	 */
 	translate: function (key, defaultValueOrVariables, defaultValue) {
-		if(typeof defaultValueOrVariables === "object") {
+		if (typeof defaultValueOrVariables === "object") {
 			return Translator.translate(this, key, defaultValueOrVariables) || defaultValue || "";
 		}
 		return Translator.translate(this, key) || defaultValueOrVariables || "";
 	},
 
-	/* updateDom(speed)
+	/**
 	 * Request an (animated) update of the module.
 	 *
-	 * argument speed Number - The speed of the animation. (Optional)
+	 * @param {number} [speed] The speed of the animation.
 	 */
 	updateDom: function (speed) {
 		MM.updateDom(this, speed);
 	},
 
-	/* sendNotification(notification, payload)
+	/**
 	 * Send a notification to all modules.
 	 *
-	 * argument notification string - The identifier of the notification.
-	 * argument payload mixed - The payload of the notification.
+	 * @param {string} notification The identifier of the notification.
+	 * @param {*} payload The payload of the notification.
 	 */
 	sendNotification: function (notification, payload) {
 		MM.sendNotification(notification, payload, this);
 	},
 
-	/* sendSocketNotification(notification, payload)
+	/**
 	 * Send a socket notification to the node helper.
 	 *
-	 * argument notification string - The identifier of the notification.
-	 * argument payload mixed - The payload of the notification.
+	 * @param {string} notification The identifier of the notification.
+	 * @param {*} payload The payload of the notification.
 	 */
 	sendSocketNotification: function (notification, payload) {
 		this.socket().sendNotification(notification, payload);
 	},
 
-	/* hideModule(module, speed, callback)
+	/**
 	 * Hide this module.
 	 *
-	 * argument speed Number - The speed of the hide animation.
-	 * argument callback function - Called when the animation is done.
-	 * argument options object - Optional settings for the hide method.
+	 * @param {number} speed The speed of the hide animation.
+	 * @param {Function} callback Called when the animation is done.
+	 * @param {object} [options] Optional settings for the hide method.
 	 */
 	hide: function (speed, callback, options) {
 		if (typeof callback === "object") {
 			options = callback;
-			callback = function () { };
+			callback = function () {};
 		}
 
-		callback = callback || function () { };
+		callback = callback || function () {};
 		options = options || {};
 
-		var self = this;
-		MM.hideModule(self, speed, function () {
-			self.suspend();
-			callback();
-		}, options);
+		MM.hideModule(
+			this,
+			speed,
+			() => {
+				this.suspend();
+				callback();
+			},
+			options
+		);
 	},
 
-	/* showModule(module, speed, callback)
+	/**
 	 * Show this module.
 	 *
-	 * argument speed Number - The speed of the show animation.
-	 * argument callback function - Called when the animation is done.
-	 * argument options object - Optional settings for the hide method.
+	 * @param {number} speed The speed of the show animation.
+	 * @param {Function} callback Called when the animation is done.
+	 * @param {object} [options] Optional settings for the show method.
 	 */
 	show: function (speed, callback, options) {
 		if (typeof callback === "object") {
 			options = callback;
-			callback = function () { };
+			callback = function () {};
 		}
 
-		callback = callback || function () { };
+		callback = callback || function () {};
 		options = options || {};
 
-		this.resume();
-		MM.showModule(this, speed, callback, options);
+		MM.showModule(
+			this,
+			speed,
+			() => {
+				this.resume();
+				callback();
+			},
+			options
+		);
 	}
 });
 
+/**
+ * Merging MagicMirror² (or other) default/config script by @bugsounet
+ * Merge 2 objects or/with array
+ *
+ * Usage:
+ * -------
+ * this.config = configMerge({}, this.defaults, this.config)
+ * -------
+ * arg1: initial object
+ * arg2: config model
+ * arg3: config to merge
+ * -------
+ * why using it ?
+ * Object.assign() function don't to all job
+ * it don't merge all thing in deep
+ * -> object in object and array is not merging
+ * -------
+ *
+ * Todo: idea of Mich determinate what do you want to merge or not
+ *
+ * @param {object} result the initial object
+ * @returns {object} the merged config
+ */
+function configMerge(result) {
+	const stack = Array.prototype.slice.call(arguments, 1);
+	let item, key;
+
+	while (stack.length) {
+		item = stack.shift();
+		for (key in item) {
+			if (item.hasOwnProperty(key)) {
+				if (typeof result[key] === "object" && result[key] && Object.prototype.toString.call(result[key]) !== "[object Array]") {
+					if (typeof item[key] === "object" && item[key] !== null) {
+						result[key] = configMerge({}, result[key], item[key]);
+					} else {
+						result[key] = item[key];
+					}
+				} else {
+					result[key] = item[key];
+				}
+			}
+		}
+	}
+	return result;
+}
+
 Module.definitions = {};
 
 Module.create = function (name) {
-
 	// Make sure module definition is available.
 	if (!Module.definitions[name]) {
 		return;
 	}
 
-	var moduleDefinition = Module.definitions[name];
-	var clonedDefinition = cloneObject(moduleDefinition);
+	const moduleDefinition = Module.definitions[name];
+	const clonedDefinition = cloneObject(moduleDefinition);
 
 	// Note that we clone the definition. Otherwise the objects are shared, which gives problems.
-	var ModuleClass = Module.extend(clonedDefinition);
+	const ModuleClass = Module.extend(clonedDefinition);
 
 	return new ModuleClass();
-
 };
 
-/* cmpVersions(a,b)
-* Compare two symantic version numbers and return the difference.
-*
-* argument a string - Version number a.
-* argument a string - Version number b.
-*/
-function cmpVersions(a, b) {
-	var i, diff;
-	var regExStrip0 = /(\.0+)+$/;
-	var segmentsA = a.replace(regExStrip0, "").split(".");
-	var segmentsB = b.replace(regExStrip0, "").split(".");
-	var l = Math.min(segmentsA.length, segmentsB.length);
-
-	for (i = 0; i < l; i++) {
-		diff = parseInt(segmentsA[i], 10) - parseInt(segmentsB[i], 10);
-		if (diff) {
-			return diff;
-		}
-	}
-	return segmentsA.length - segmentsB.length;
-}
-
 Module.register = function (name, moduleDefinition) {
-
 	if (moduleDefinition.requiresVersion) {
-		Log.log("Check MagicMirror version for module '" + name + "' - Minimum version:  " + moduleDefinition.requiresVersion + " - Current version: " + version);
-		if (cmpVersions(version, moduleDefinition.requiresVersion) >= 0) {
+		Log.log("Check MagicMirror² version for module '" + name + "' - Minimum version:  " + moduleDefinition.requiresVersion + " - Current version: " + window.mmVersion);
+		if (cmpVersions(window.mmVersion, moduleDefinition.requiresVersion) >= 0) {
 			Log.log("Version is ok!");
 		} else {
-			Log.log("Version is incorrect. Skip module: '" + name + "'");
+			Log.warn("Version is incorrect. Skip module: '" + name + "'");
 			return;
 		}
 	}
 	Log.log("Module registered: " + name);
 	Module.definitions[name] = moduleDefinition;
 };
+
+window.Module = Module;
+
+/**
+ * Compare two semantic version numbers and return the difference.
+ *
+ * @param {string} a Version number a.
+ * @param {string} b Version number b.
+ * @returns {number} A positive number if a is larger than b, a negative
+ * number if a is smaller and 0 if they are the same
+ */
+function cmpVersions(a, b) {
+	const regExStrip0 = /(\.0+)+$/;
+	const segmentsA = a.replace(regExStrip0, "").split(".");
+	const segmentsB = b.replace(regExStrip0, "").split(".");
+	const l = Math.min(segmentsA.length, segmentsB.length);
+
+	for (let i = 0; i < l; i++) {
+		let diff = parseInt(segmentsA[i], 10) - parseInt(segmentsB[i], 10);
+		if (diff) {
+			return diff;
+		}
+	}
+	return segmentsA.length - segmentsB.length;
+}

js/node_helper.js

@@ -0,0 +1,145 @@
+/* MagicMirror²
+ * Node Helper Superclass
+ *
+ * By Michael Teeuw https://michaelteeuw.nl
+ * MIT Licensed.
+ */
+const Class = require("./class.js");
+const Log = require("logger");
+const express = require("express");
+
+const NodeHelper = Class.extend({
+	init() {
+		Log.log("Initializing new module helper ...");
+	},
+
+	loaded(callback) {
+		Log.log(`Module helper loaded: ${this.name}`);
+		callback();
+	},
+
+	start() {
+		Log.log(`Starting module helper: ${this.name}`);
+	},
+
+	/**
+	 * Called when the MagicMirror² server receives a `SIGINT`
+	 * Close any open connections, stop any sub-processes and
+	 * gracefully exit the module.
+	 */
+	stop() {
+		Log.log(`Stopping module helper: ${this.name}`);
+	},
+
+	/**
+	 * This method is called when a socket notification arrives.
+	 *
+	 * @param {string} notification The identifier of the notification.
+	 * @param {*}  payload The payload of the notification.
+	 */
+	socketNotificationReceived(notification, payload) {
+		Log.log(`${this.name} received a socket notification: ${notification} - Payload: ${payload}`);
+	},
+
+	/**
+	 * Set the module name.
+	 *
+	 * @param {string} name Module name.
+	 */
+	setName(name) {
+		this.name = name;
+	},
+
+	/**
+	 * Set the module path.
+	 *
+	 * @param {string} path Module path.
+	 */
+	setPath(path) {
+		this.path = path;
+	},
+
+	/* sendSocketNotification(notification, payload)
+	 * Send a socket notification to the node helper.
+	 *
+	 * argument notification string - The identifier of the notification.
+	 * argument payload mixed - The payload of the notification.
+	 */
+	sendSocketNotification(notification, payload) {
+		this.io.of(this.name).emit(notification, payload);
+	},
+
+	/* setExpressApp(app)
+	 * Sets the express app object for this module.
+	 * This allows you to host files from the created webserver.
+	 *
+	 * argument app Express app - The Express app object.
+	 */
+	setExpressApp(app) {
+		this.expressApp = app;
+
+		app.use(`/${this.name}`, express.static(`${this.path}/public`));
+	},
+
+	/* setSocketIO(io)
+	 * Sets the socket io object for this module.
+	 * Binds message receiver.
+	 *
+	 * argument io Socket.io - The Socket io object.
+	 */
+	setSocketIO(io) {
+		this.io = io;
+
+		Log.log(`Connecting socket for: ${this.name}`);
+
+		io.of(this.name).on("connection", (socket) => {
+			// add a catch all event.
+			const onevent = socket.onevent;
+			socket.onevent = function (packet) {
+				const args = packet.data || [];
+				onevent.call(this, packet); // original call
+				packet.data = ["*"].concat(args);
+				onevent.call(this, packet); // additional call to catch-all
+			};
+
+			// register catch all.
+			socket.on("*", (notification, payload) => {
+				if (notification !== "*") {
+					this.socketNotificationReceived(notification, payload);
+				}
+			});
+		});
+	}
+});
+
+NodeHelper.checkFetchStatus = function (response) {
+	// response.status >= 200 && response.status < 300
+	if (response.ok) {
+		return response;
+	} else {
+		throw Error(response.statusText);
+	}
+};
+
+/**
+ * Look at the specified error and return an appropriate error type, that
+ * can be translated to a detailed error message
+ *
+ * @param {Error} error the error from fetching something
+ * @returns {string} the string of the detailed error message in the translations
+ */
+NodeHelper.checkFetchError = function (error) {
+	let error_type = "MODULE_ERROR_UNSPECIFIED";
+	if (error.code === "EAI_AGAIN") {
+		error_type = "MODULE_ERROR_NO_CONNECTION";
+	} else if (error.message === "Unauthorized") {
+		error_type = "MODULE_ERROR_UNAUTHORIZED";
+	}
+	return error_type;
+};
+
+NodeHelper.create = function (moduleDefinition) {
+	return NodeHelper.extend(moduleDefinition);
+};
+
+module.exports = NodeHelper;

js/server.js

@@ -1,69 +1,125 @@
-/* Magic Mirror
+/* MagicMirror²
  * Server
  *
- * By Michael Teeuw http://michaelteeuw.nl
+ * By Michael Teeuw https://michaelteeuw.nl
  * MIT Licensed.
  */
+const express = require("express");
+const app = require("express")();
+const path = require("path");
+const ipfilter = require("express-ipfilter").IpFilter;
+const fs = require("fs");
+const helmet = require("helmet");
+const fetch = require("fetch");
 
-var express = require("express");
-var app = require("express")();
-var server = require("http").Server(app);
-var io = require("socket.io")(server);
-var path = require("path");
-var ipfilter = require("express-ipfilter").IpFilter;
-var fs = require("fs");
-var helmet = require("helmet");
-var Utils = require(__dirname + "/utils.js");
+const Log = require("logger");
+const Utils = require("./utils.js");
 
-var Server = function(config, callback) {
+/**
+ * Server
+ *
+ * @param {object} config The MM config
+ * @param {Function} callback Function called when done.
+ * @class
+ */
+function Server(config, callback) {
+	const port = process.env.MM_PORT || config.port;
+	const serverSockets = new Set();
 
-	var port = config.port;
-	if (process.env.MM_PORT) {
-		port = process.env.MM_PORT;
+	let server = null;
+	if (config.useHttps) {
+		const options = {
+			key: fs.readFileSync(config.httpsPrivateKey),
+			cert: fs.readFileSync(config.httpsCertificate)
+		};
+		server = require("https").Server(options, app);
+	} else {
+		server = require("http").Server(app);
+	}
+	const io = require("socket.io")(server, {
+		cors: {
+			origin: /.*$/,
+			credentials: true
+		},
+		allowEIO3: true
+	});
+
+	server.on("connection", (socket) => {
+		serverSockets.add(socket);
+		socket.on("close", () => {
+			serverSockets.delete(socket);
+		});
+	});
+
+	Log.log(`Starting server on port ${port} ... `);
+
+	server.listen(port, config.address || "localhost");
+
+	if (config.ipWhitelist instanceof Array && config.ipWhitelist.length === 0) {
+		Log.warn(Utils.colors.warn("You're using a full whitelist configuration to allow for all IPs"));
 	}
 
-	console.log("Starting server on port " + port + " ... ");
-
-	server.listen(port, config.address ? config.address : null);
-
-	if (config.ipWhitelist instanceof Array && config.ipWhitelist.length == 0) {
-		console.info(Utils.colors.warn("You're using a full whitelist configuration to allow for all IPs"))
-	}
-
-	app.use(function(req, res, next) {
-		var result = ipfilter(config.ipWhitelist, {mode: config.ipWhitelist.length === 0 ? "deny" : "allow", log: false})(req, res, function(err) {
+	app.use(function (req, res, next) {
+		ipfilter(config.ipWhitelist, { mode: config.ipWhitelist.length === 0 ? "deny" : "allow", log: false })(req, res, function (err) {
 			if (err === undefined) {
+				res.header("Access-Control-Allow-Origin", "*");
 				return next();
 			}
-			console.log(err.message);
+			Log.log(err.message);
 			res.status(403).send("This device is not allowed to access your mirror. <br> Please check your config.js or config.js.sample to change this.");
 		});
 	});
-	app.use(helmet());
+	app.use(helmet(config.httpHeaders));
 
 	app.use("/js", express.static(__dirname));
-	var directories = ["/config", "/css", "/fonts", "/modules", "/vendor", "/translations", "/tests/configs"];
-	var directory;
-	for (var i in directories) {
-		directory = directories[i];
+
+	const directories = ["/config", "/css", "/fonts", "/modules", "/vendor", "/translations", "/tests/configs"];
+	for (const directory of directories) {
 		app.use(directory, express.static(path.resolve(global.root_path + directory)));
 	}
 
-	app.get("/version", function(req,res) {
+	app.get("/cors", async function (req, res) {
+		// example: http://localhost:8080/cors?url=https://google.de
+
+		try {
+			const reg = "^/cors.+url=(.*)";
+			let url = "";
+
+			let match = new RegExp(reg, "g").exec(req.url);
+			if (!match) {
+				url = "invalid url: " + req.url;
+				Log.error(url);
+				res.send(url);
+			} else {
+				url = match[1];
+				Log.log("cors url: " + url);
+				const response = await fetch(url, { headers: { "User-Agent": "Mozilla/5.0 MagicMirror/" + global.version } });
+				const header = response.headers.get("Content-Type");
+				const data = await response.text();
+				if (header) res.set("Content-Type", header);
+				res.send(data);
+			}
+		} catch (error) {
+			Log.error(error);
+			res.send(error);
+		}
+	});
+
+	app.get("/version", function (req, res) {
 		res.send(global.version);
 	});
 
-	app.get("/config", function(req,res) {
+	app.get("/config", function (req, res) {
 		res.send(config);
 	});
 
-	app.get("/", function(req, res) {
-		var html = fs.readFileSync(path.resolve(global.root_path + "/index.html"), {encoding: "utf8"});
+	app.get("/", function (req, res) {
+		let html = fs.readFileSync(path.resolve(`${global.root_path}/index.html`), { encoding: "utf8" });
 		html = html.replace("#VERSION#", global.version);
 
-		configFile = "config/config.js";
-		if (typeof(global.configuration_file) !== "undefined") {
-		    configFile = global.configuration_file;
+		let configFile = "config/config.js";
+		if (typeof global.configuration_file !== "undefined") {
+			configFile = global.configuration_file;
 		}
 		html = html.replace("#CONFIG_FILE#", configFile);
 
@@ -73,6 +129,13 @@ var Server = function(config, callback) {
 	if (typeof callback === "function") {
 		callback(app, io);
 	}
-};
+
+	this.close = function () {
+		for (const socket of serverSockets.values()) {
+			socket.destroy();
+		}
+		server.close();
+	};
+}
 
 module.exports = Server;

js/socket.js

@@ -1,35 +0,0 @@
-/* exported Log */
-
-/* Magic Mirror
- * Socket Connection
- *
- * By Michael Teeuw http://michaelteeuw.nl
- * MIT Licensed.
- */
-
-var MMSocket = function(moduleName) {
-
-	var self = this;
-
-	if (typeof moduleName !== "string") {
-		throw new Error("Please set the module name for the MMSocket.");
-	}
-
-	self.moduleName = moduleName;
-
-	self.socket = io("http://localhost:8080");
-	self.socket.on("notification", function(data) {
-		MM.sendNotification(data.notification, data.payload, Socket);
-	});
-
-	return {
-		sendMessage: function(notification, payload, sender) {
-			Log.log("Send socket message: " + notification);
-			self.socket.emit("notification", {
-				notification: notification,
-				sender: sender,
-				payload: payload
-			});
-		}
-	};
-};

js/socketclient.js

@@ -1,40 +1,53 @@
-var MMSocket = function(moduleName) {
-	var self = this;
+/* global io */
 
+/* MagicMirror²
+ * TODO add description
+ *
+ * By Michael Teeuw https://michaelteeuw.nl
+ * MIT Licensed.
+ */
+const MMSocket = function (moduleName) {
 	if (typeof moduleName !== "string") {
 		throw new Error("Please set the module name for the MMSocket.");
 	}
 
-	self.moduleName = moduleName;
+	this.moduleName = moduleName;
 
 	// Private Methods
-	self.socket = io("/" + self.moduleName);
-	var notificationCallback = function() {};
+	let base = "/";
+	if (typeof config !== "undefined" && typeof config.basePath !== "undefined") {
+		base = config.basePath;
+	}
+	this.socket = io("/" + this.moduleName, {
+		path: base + "socket.io"
+	});
 
-	var onevent = self.socket.onevent;
-	self.socket.onevent = function(packet) {
-		var args = packet.data || [];
-		onevent.call(this, packet);    // original call
+	let notificationCallback = function () {};
+
+	const onevent = this.socket.onevent;
+	this.socket.onevent = (packet) => {
+		const args = packet.data || [];
+		onevent.call(this.socket, packet); // original call
 		packet.data = ["*"].concat(args);
-		onevent.call(this, packet);      // additional call to catch-all
+		onevent.call(this.socket, packet); // additional call to catch-all
 	};
 
 	// register catch all.
-	self.socket.on("*", function(notification, payload) {
+	this.socket.on("*", (notification, payload) => {
 		if (notification !== "*") {
 			notificationCallback(notification, payload);
 		}
 	});
 
 	// Public Methods
-	this.setNotificationCallback = function(callback) {
+	this.setNotificationCallback = (callback) => {
 		notificationCallback = callback;
 	};
 
-	this.sendNotification = function(notification, payload) {
+	this.sendNotification = (notification, payload) => {
 		if (typeof payload === "undefined") {
 			payload = {};
 		}
-		self.socket.emit(notification, payload);
+		this.socket.emit(notification, payload);
 	};
 };

js/translator.js

@@ -1,143 +1,78 @@
-/* exported Translator */
-/* Magic Mirror
+/* global translations */
+
+/* MagicMirror²
  * Translator (l10n)
  *
- * By Christopher Fenner http://github.com/CFenner
+ * By Christopher Fenner https://github.com/CFenner
  * MIT Licensed.
  */
-var Translator = (function() {
-
-	/* loadJSON(file, callback)
+const Translator = (function () {
+	/**
 	 * Load a JSON file via XHR.
 	 *
-	 * argument file string - Path of the file we want to load.
-	 * argument callback function - Function called when done.
+	 * @param {string} file Path of the file we want to load.
+	 * @param {Function} callback Function called when done.
 	 */
 	function loadJSON(file, callback) {
-		var xhr = new XMLHttpRequest();
+		const xhr = new XMLHttpRequest();
 		xhr.overrideMimeType("application/json");
 		xhr.open("GET", file, true);
 		xhr.onreadystatechange = function () {
-			if (xhr.readyState == 4 && xhr.status == "200") {
-				callback(JSON.parse(stripComments(xhr.responseText)));
+			if (xhr.readyState === 4 && xhr.status === 200) {
+				// needs error handler try/catch at least
+				let fileinfo = null;
+				try {
+					fileinfo = JSON.parse(xhr.responseText);
+				} catch (exception) {
+					// nothing here, but don't die
+					Log.error(" loading json file =" + file + " failed");
+				}
+				callback(fileinfo);
 			}
 		};
 		xhr.send(null);
 	}
 
-	/* loadJSON(str, options)
-	 * Remove any commenting from a json file so it can be parsed.
-	 *
-	 * argument str string - The string that contains json with comments.
-	 * argument opts function - Strip options.
-	 *
-	 * return the stripped string.
-	 */
-	function stripComments(str, opts) {
-		// strip comments copied from: https://github.com/sindresorhus/strip-json-comments
-
-		var singleComment = 1;
-		var multiComment = 2;
-
-		function stripWithoutWhitespace() {
-			return "";
-		}
-
-		function stripWithWhitespace(str, start, end) {
-			return str.slice(start, end).replace(/\S/g, " ");
-		}
-
-		opts = opts || {};
-
-		var currentChar;
-		var nextChar;
-		var insideString = false;
-		var insideComment = false;
-		var offset = 0;
-		var ret = "";
-		var strip = opts.whitespace === false ? stripWithoutWhitespace : stripWithWhitespace;
-
-		for (var i = 0; i < str.length; i++) {
-			currentChar = str[i];
-			nextChar = str[i + 1];
-
-			if (!insideComment && currentChar === "\"") {
-				var escaped = str[i - 1] === "\\" && str[i - 2] !== "\\";
-				if (!escaped) {
-					insideString = !insideString;
-				}
-			}
-
-			if (insideString) {
-				continue;
-			}
-
-			if (!insideComment && currentChar + nextChar === "//") {
-				ret += str.slice(offset, i);
-				offset = i;
-				insideComment = singleComment;
-				i++;
-			} else if (insideComment === singleComment && currentChar + nextChar === "\r\n") {
-				i++;
-				insideComment = false;
-				ret += strip(str, offset, i);
-				offset = i;
-				continue;
-			} else if (insideComment === singleComment && currentChar === "\n") {
-				insideComment = false;
-				ret += strip(str, offset, i);
-				offset = i;
-			} else if (!insideComment && currentChar + nextChar === "/*") {
-				ret += str.slice(offset, i);
-				offset = i;
-				insideComment = multiComment;
-				i++;
-				continue;
-			} else if (insideComment === multiComment && currentChar + nextChar === "*/") {
-				i++;
-				insideComment = false;
-				ret += strip(str, offset, i + 1);
-				offset = i + 1;
-				continue;
-			}
-		}
-
-		return ret + (insideComment ? strip(str.substr(offset)) : str.substr(offset));
-	}
-
 	return {
 		coreTranslations: {},
 		coreTranslationsFallback: {},
 		translations: {},
 		translationsFallback: {},
 
-		/* translate(module, key, variables)
+		/**
 		 * Load a translation for a given key for a given module.
 		 *
-		 * argument module Module - The module to load the translation for.
-		 * argument key string - The key of the text to translate.
-		 * argument variables - The variables to use within the translation template (optional)
+		 * @param {Module} module The module to load the translation for.
+		 * @param {string} key The key of the text to translate.
+		 * @param {object} variables The variables to use within the translation template (optional)
+		 * @returns {string} the translated key
 		 */
-		translate: function(module, key, variables) {
+		translate: function (module, key, variables) {
 			variables = variables || {}; //Empty object by default
 
-			// Combines template and variables like:
-			// template: "Please wait for {timeToWait} before continuing with {work}."
-			// variables: {timeToWait: "2 hours", work: "painting"}
-			// to: "Please wait for 2 hours before continuing with painting."
+			/**
+			 * Combines template and variables like:
+			 * template: "Please wait for {timeToWait} before continuing with {work}."
+			 * variables: {timeToWait: "2 hours", work: "painting"}
+			 * to: "Please wait for 2 hours before continuing with painting."
+			 *
+			 * @param {string} template Text with placeholder
+			 * @param {object} variables Variables for the placeholder
+			 * @returns {string} the template filled with the variables
+			 */
 			function createStringFromTemplate(template, variables) {
-				if(Object.prototype.toString.call(template) !== "[object String]") {
+				if (Object.prototype.toString.call(template) !== "[object String]") {
 					return template;
 				}
-				if(variables.fallback && !template.match(new RegExp("\{.+\}"))) {
+				if (variables.fallback && !template.match(new RegExp("{.+}"))) {
 					template = variables.fallback;
 				}
-				return template.replace(new RegExp("\{([^\}]+)\}", "g"), function(_unused, varName){
-					return variables[varName] || "{"+varName+"}";
+				return template.replace(new RegExp("{([^}]+)}", "g"), function (_unused, varName) {
+					return varName in variables ? variables[varName] : "{" + varName + "}";
 				});
 			}
 
-			if(this.translations[module.name] && key in this.translations[module.name]) {
+			if (this.translations[module.name] && key in this.translations[module.name]) {
 				// Log.log("Got translation for " + key + " from module translation: ");
 				return createStringFromTemplate(this.translations[module.name][key], variables);
 			}
@@ -159,73 +94,62 @@ var Translator = (function() {
 
 			return key;
 		},
-		/* load(module, file, isFallback, callback)
+
+		/**
 		 * Load a translation file (json) and remember the data.
 		 *
-		 * argument module Module - The module to load the translation file for.
-		 * argument file string - Path of the file we want to load.
-		 * argument isFallback boolean - Flag to indicate fallback translations.
-		 * argument callback function - Function called when done.
+		 * @param {Module} module The module to load the translation file for.
+		 * @param {string} file Path of the file we want to load.
+		 * @param {boolean} isFallback Flag to indicate fallback translations.
+		 * @param {Function} callback Function called when done.
 		 */
-		load: function(module, file, isFallback, callback) {
-			if (!isFallback) {
-				Log.log(module.name + " - Load translation: " + file);
-			} else {
-				Log.log(module.name + " - Load translation fallback: " + file);
+		load(module, file, isFallback, callback) {
+			Log.log(`${module.name} - Load translation${isFallback ? " fallback" : ""}: ${file}`);
+
+			if (this.translationsFallback[module.name]) {
+				callback();
+				return;
 			}
 
-			var self = this;
-			if(!this.translationsFallback[module.name]) {
-				loadJSON(module.file(file), function(json) {
-					if (!isFallback) {
-						self.translations[module.name] = json;
-					} else {
-						self.translationsFallback[module.name] = json;
-					}
-					callback();
-				});
-			} else {
+			loadJSON(module.file(file), (json) => {
+				const property = isFallback ? "translationsFallback" : "translations";
+				this[property][module.name] = json;
 				callback();
-			}
+			});
 		},
 
-		/* loadCoreTranslations(lang)
+		/**
 		 * Load the core translations.
 		 *
-		 * argument lang String - The language identifier of the core language.
+		 * @param {string} lang The language identifier of the core language.
 		 */
-		loadCoreTranslations: function(lang) {
-			var self = this;
-
+		loadCoreTranslations: function (lang) {
 			if (lang in translations) {
 				Log.log("Loading core translation file: " + translations[lang]);
-				loadJSON(translations[lang], function(translations) {
-					self.coreTranslations = translations;
+				loadJSON(translations[lang], (translations) => {
+					this.coreTranslations = translations;
 				});
 			} else {
 				Log.log("Configured language not found in core translations.");
 			}
 
-			self.loadCoreTranslationsFallback();
+			this.loadCoreTranslationsFallback();
 		},
 
-		/* loadCoreTranslationsFallback()
+		/**
 		 * Load the core translations fallback.
 		 * The first language defined in translations.js will be used.
 		 */
-		loadCoreTranslationsFallback: function() {
-			var self = this;
-
-			// The variable `first` will contain the first
-			// defined translation after the following line.
-			for (var first in translations) {break;}
-
+		loadCoreTranslationsFallback: function () {
+			let first = Object.keys(translations)[0];
 			if (first) {
 				Log.log("Loading core translation fallback file: " + translations[first]);
-				loadJSON(translations[first], function(translations) {
-					self.coreTranslationsFallback = translations;
+				loadJSON(translations[first], (translations) => {
+					this.coreTranslationsFallback = translations;
 				});
 			}
-		},
+		}
 	};
 })();
+
+window.Translator = Translator;

js/utils.js

@@ -1,19 +1,16 @@
-/* exported Utils */
-/* Magic Mirror
+/* MagicMirror²
  * Utils
  *
  * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com
  * MIT Licensed.
  */
+const colors = require("colors/safe");
 
-var colors = require("colors/safe");
-
-var Utils = {
+module.exports = {
 	colors: {
 		warn: colors.yellow,
 		error: colors.red,
-		info: colors.blue
+		info: colors.blue,
+		pass: colors.green
 	}
 };
-
-if (typeof module !== "undefined") {module.exports = Utils;}

jsconfig.json

@@ -6,8 +6,5 @@
 		"module": "commonjs",
 		"allowSyntheticDefaultImports": true
 	},
-	"exclude": [
-		"modules",
-		"node_modules"
-	]
+	"exclude": ["modules", "node_modules"]
 }

module-types.ts

@@ -1,16 +1,16 @@
 type ModuleProperties = {
-  defaults?: object,
-  start?(): void,
-  getHeader?(): string,
-  getTemplate?(): string,
-  getTemplateData?(): object,
-  notificationReceived?(notification: string, payload: any, sender: object): void,
-  socketNotificationReceived?(notification: string, payload: any): void,
-  suspend?(): void,
-  resume?(): void,
-  getDom?(): HTMLElement,
-  getStyles?(): string[],
-  [key: string]: any,
+  defaults?: object;
+  start?(): void;
+  getHeader?(): string;
+  getTemplate?(): string;
+  getTemplateData?(): object;
+  notificationReceived?(notification: string, payload: any, sender: object): void;
+  socketNotificationReceived?(notification: string, payload: any): void;
+  suspend?(): void;
+  resume?(): void;
+  getDom?(): HTMLElement;
+  getStyles?(): string[];
+  [key: string]: any;
 };
 
 export declare const Module: {
@@ -18,14 +18,14 @@ export declare const Module: {
 };
 
 export declare const Log: {
-  info(message?: any, ...optionalParams: any[]): void,
-  log(message?: any, ...optionalParams: any[]): void,
-  error(message?: any, ...optionalParams: any[]): void,
-  warn(message?: any, ...optionalParams: any[]): void,
-  group(groupTitle?: string, ...optionalParams: any[]): void,
-  groupCollapsed(groupTitle?: string, ...optionalParams: any[]): void,
-  groupEnd(): void,
-  time(timerName?: string): void,
-  timeEnd(timerName?: string): void,
-  timeStamp(timerName?: string): void,
-};
+  info(message?: any, ...optionalParams: any[]): void;
+  log(message?: any, ...optionalParams: any[]): void;
+  error(message?: any, ...optionalParams: any[]): void;
+  warn(message?: any, ...optionalParams: any[]): void;
+  group(groupTitle?: string, ...optionalParams: any[]): void;
+  groupCollapsed(groupTitle?: string, ...optionalParams: any[]): void;
+  groupEnd(): void;
+  time(timerName?: string): void;
+  timeEnd(timerName?: string): void;
+  timeStamp(timerName?: string): void;
+};

modules/README.md

@@ -1,721 +0,0 @@
-# MagicMirror² Module Development Documentation
-
-This document describes the way to develop your own MagicMirror² modules.
-
-Table of Contents:
-
-- Module structure
-  - Files
-
-- The Core module file: modulename.js
-  - Available module instance properties
-  - Subclassable module methods
-  - Module instance methods
-  - Visibility locking
-
-- The Node Helper: node_helper.js
-  - Available module instance properties
-  - Subclassable module methods
-  - Module instance methods
-  
-- MagicMirror Helper Methods
-  - Module Selection
-
-- MagicMirror Logger
-
----
-
-
-## General Advice
-
-As MagicMirror has gained huge popularity, so has the number of available modules. For new users and developers alike, it is very time consuming to navigate around the various repositories in order to find out what exactly a certain modules does, how it looks and what it depends on. Unfortunately, this information is rarely available, nor easily obtained without having to install it first. 
-Therefore **we highly recommend you to include the following information in your README file.**
-
-- A high quality screenshot of your working module
-- A short, one sentence, clear description what it does (duh!)
-- What external API's it depend on, including web links to those
-- Wheteher the API/request require a key and the user limitations of those. (Is it free?)
-
-Surely this also help you get better recognition and feedback for your work. 
-
-## Module structure
-
-All modules are loaded in the `modules` folder. The default modules are grouped together in the `modules/default` folder. Your module should be placed in a subfolder of `modules`. Note that any file or folder your create in the `modules` folder will be ignored by git, allowing you to upgrade the MagicMirror² without the loss of your files.
-
-A module can be placed in one single folder. Or multiple modules can be grouped in a subfolder. Note that name of the module must be unique. Even when a module with a similar name is placed in a different folder, they can't be loaded at the same time.
-
-### Files
-- **modulename/modulename.js** - This is your core module script.
-- **modulename/node_helper.js** - This is an optional helper that will be loaded by the node script. The node helper and module script can communicate with each other using an intergrated socket system.
-- **modulename/public** - Any files in this folder can be accesed via the browser on `/modulename/filename.ext`.
-- **modulename/anyfileorfolder** Any other file or folder in the module folder can be used by the core module script. For example: *modulename/css/modulename.css* would be a good path for your additional module styles.
-
-## The Core module file: modulename.js
-This is the script in which the module will be defined. This script is required in order for the module to be used. In it's most simple form, the core module file must contain:
-````javascript
-Module.register("modulename",{});
-````
-Of course, the above module would not do anything fancy, so it's good to look at one of the simplest modules: **helloworld**:
-
-````javascript
-//helloworld.js:
-
-Module.register("helloworld",{
-	// Default module config.
-	defaults: {
-		text: "Hello World!"
-	},
-
-	// Override dom generator.
-	getDom: function() {
-		var wrapper = document.createElement("div");
-		wrapper.innerHTML = this.config.text;
-		return wrapper;
-	}
-});
-````
-
-As you can see, the `Module.register()` method takes two arguments: the name of the module and an object with the module properties.
-
-### Available module instance properties
-After the module is initialized, the module instance has a few available module properties:
-
-| Instance Property | Type | Description |
-|:----------------- |:---- |:----------- |
-| `this.name` | String | The name of the module. |
-| `this.identifier` | String | This is a unique identifier for the module instance. |
-| `this.hidden` | Boolean | This represents if the module is currently hidden (faded away). |
-| `this.config` | Boolean | The configuration of the module instance as set in the user's `config.js` file. This config will also contain the module's defaults if these properties are not over-written by the user config. |
-| `this.data` | Object | The data object contain additional metadata about the module instance. (See below) |
-
-
-The `this.data` data object contain the follwoing metadata:
-- `data.classes` - The classes which are added to the module dom wrapper.
-- `data.file` - The filename of the core module file.
-- `data.path` - The path of the module folder.
-- `data.header` - The header added to the module.
-- `data.position` - The position in which the instance will be shown.
-
-
-#### `defaults: {}`
-Any properties defined in the defaults object, will be merged with the module config as defined in the user's config.js file. This is the best place to set your modules's configuration defaults. Any of the module configuration properties can be accessed using `this.config.propertyName`, but more about that later.
-
-#### `requiresVersion:`
-
-*Introduced in version: 2.1.0.*
-
-A string that defines the minimum version of the MagicMirror framework. If it is set, the system compares the required version with the users version. If the version of the user is out of date, it won't run the module. Make sure to also set this value in the Node helper.
-
-**Note:** Since this check is introduced in version 2.1.0, this check will not be run in older versions. Keep this in mind if you get issue reports on your module.
-
-Example:
-````javascript
-requiresVersion: "2.1.0",
-````
-
-### Subclassable module methods
-
-#### `init()`
-This method is called when a module gets instantiated. In most cases you do not need to subclass this method.
-
-#### `loaded(callback)`
-
-*Introduced in version: 2.1.1.*
-
-This method is called when a module is loaded. Subsequent modules in the config are not yet loaded. The `callback` function MUST be called when the module is done loading. In most cases you do not need to subclass this method.
-
-**Example:**
-````javascript
-loaded: function(callback) {
-	this.finishLoading();
-	Log.log(this.name + ' is loaded!');
-	callback();
-}
-````
-
-#### `start()`
-This method is called when all modules are loaded an the system is ready to boot up. Keep in mind that the dom object for the module is not yet created. The start method is a perfect place to define any additional module properties:
-
-**Example:**
-````javascript
-start: function() {
-	this.mySpecialProperty = "So much wow!";
-	Log.log(this.name + ' is started!');
-}
-````
-
-#### `getScripts()`
-**Should return: Array**
-
-The getScripts method is called to request any additional scripts that need to be loaded. This method should therefore return an array with strings. If you want to return a full path to a file in the module folder, use the `this.file('filename.js')` method. In all cases the loader will only load a file once. It even checks if the file is available in the default vendor folder.
-
-**Example:**
-````javascript
-getScripts: function() {
-	return [
-		'script.js', // will try to load it from the vendor folder, otherwise it will load is from the module folder.
-		'moment.js', // this file is available in the vendor folder, so it doesn't need to be available in the module folder.
-		this.file('anotherfile.js'), // this file will be loaded straight from the module folder.
-		'https://code.jquery.com/jquery-2.2.3.min.js',  // this file will be loaded from the jquery servers.
-	]
-}
-
-````
-**Note:** If a file can not be loaded, the boot up of the mirror will stall. Therefore it's advised not to use any external urls.
-
-
-#### `getStyles()`
-**Should return: Array**
-
-The getStyles method is called to request any additional stylesheets that need to be loaded. This method should therefore return an array with strings. If you want to return a full path to a file in the module folder, use the `this.file('filename.css')` method. In all cases the loader will only load a file once. It even checks if the file is available in the default vendor folder.
-
-**Example:**
-````javascript
-getStyles: function() {
-	return [
-		'script.css', // will try to load it from the vendor folder, otherwise it will load is from the module folder.
-		'font-awesome.css', // this file is available in the vendor folder, so it doesn't need to be avialable in the module folder.
-		this.file('anotherfile.css'), // this file will be loaded straight from the module folder.
-		'https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css',  // this file will be loaded from the bootstrapcdn servers.
-	]
-}
-
-````
-**Note:** If a file can not be loaded, the boot up of the mirror will stall. Therefore it's advised not to use any external urls.
-
-#### `getTranslations()`
-**Should return: Dictionary**
-
-The getTranslations method is called to request translation files that need to be loaded. This method should therefore return a dictionary with the files to load, identified by the country's short name.
-
-If the module does not have any module specific translations, the function can just be omitted or return `false`.
-
-**Example:**
-````javascript
-getTranslations: function() {
-	return {
-			en: "translations/en.json",
-			de: "translations/de.json"
-	}
-}
-
-````
-
-#### `getDom()`
-**Should return:** Dom Object
-
-Whenever the MagicMirror needs to update the information on screen (because it starts, or because your module asked a refresh using `this.updateDom()`), the system calls the getDom method. This method should therefore return a dom object.
-
-**Example:**
-````javascript
-getDom: function() {
-	var wrapper = document.createElement("div");
-	wrapper.innerHTML = 'Hello world!';
-	return wrapper;
-}
-
-````
-
-#### `getHeader()`
-**Should return:** String
-
-Whenever the MagicMirror needs to update the information on screen (because it starts, or because your module asked a refresh using `this.updateDom()`), the system calls the getHeader method to retrieve the module's header. This method should therefor return a string. If this method is not subclassed, this function will return the user's configured header.
-
-If you want to use the original user's configured header, reference `this.data.header`.
-
-**NOTE:** If the user did not configure a default header, no header will be displayed and thus this method will not be called.
-
-**Example:**
-````javascript
-getHeader: function() {
-	return this.data.header + ' Foo Bar';
-}
-
-````
-
-#### `notificationReceived(notification, payload, sender)`
-
-That MagicMirror core has the ability to send notifications to modules. Or even better: the modules have the possibility to send notifications to other modules. When this module is called, it has 3 arguments:
-
-- `notification` - String - The notification identifier.
-- `payload` - AnyType - The payload of a notification.
-- `sender` - Module - The sender of the notification. If this argument is `undefined`, the sender of the notififiction is the core system.
-
-**Example:**
-````javascript
-notificationReceived: function(notification, payload, sender) {
-	if (sender) {
-		Log.log(this.name + " received a module notification: " + notification + " from sender: " + sender.name);
-	} else {
-		Log.log(this.name + " received a system notification: " + notification);
-	}
-}
-````
-
-**Note:** the system sends three notifications when starting up. These notifications could come in handy!
-
-
-- `ALL_MODULES_STARTED` - All modules are started. You can now send notifications to other modules.
-- `DOM_OBJECTS_CREATED` - All dom objects are created. The system is now ready to perform visual changes.
-- `MODULE_DOM_CREATED` - This module's dom has been fully loaded. You can now access your module's dom objects.
-
-
-#### `socketNotificationReceived: function(notification, payload)`
-When using a node_helper, the node helper can send your module notifications. When this module is called, it has 2 arguments:
-
-- `notification` - String - The notification identifier.
-- `payload` - AnyType - The payload of a notification.
-
-**Note 1:** When a node helper sends a notification, all modules of that module type receive the same notifications. <br>
-**Note 2:** The socket connection is established as soon as the module sends its first message using [sendSocketNotification](thissendsocketnotificationnotification-payload).
-
-**Example:**
-````javascript
-socketNotificationReceived: function(notification, payload) {
-	Log.log(this.name + " received a socket notification: " + notification + " - Payload: " + payload);
-},
-````
-
-#### `suspend()`
-When a module is hidden (using the `module.hide()` method), the `suspend()` method will be called. By subclassing this method you can perform tasks like halting the update timers.
-
-#### `resume()`
-When a module is requested to be shown (using the `module.show()` method), the `resume()` method will be called. By subclassing this method you can perform tasks restarting the update timers.
-
-
-### Module instance methods
-
-Each module instance has some handy methods which can be helpful building your module.
-
-
-#### `this.file(filename)`
-***filename* String** - The name of the file you want to create the path for.<br>
-**Returns String**
-
-If you want to create a path to a file in your module folder, use the `file()` method. It returns the path to the filename given as the attribute. Is method comes in handy when configuring the [getScripts](#getscripts) and [getStyles](#getstyles) methods.
-
-#### `this.updateDom(speed)`
-***speed* Number** - Optional. Animation speed in milliseconds.<br>
-
-Whenever your module need to be updated, call the `updateDom(speed)` method. It requests the MagicMirror core to update its dom object. If you define the speed, the content update will be animated, but only if the content will really change.
-
-As an example: the clock modules calls this method every second:
-
-````javascript
-...
-start: function() {
-	var self = this;
-	setInterval(function() {
-		self.updateDom(); // no speed defined, so it updates instantly.
-	}, 1000); //perform every 1000 milliseconds.
-},
-...
-````
-
-#### `this.sendNotification(notification, payload)`
-***notification* String** - The notification identifier.<br>
-***payload* AnyType** - Optional. A notification payload.<br>
-
-If you want to send a notification to all other modules, use the `sendNotification(notification, payload)`. All other modules will receive the message via the [notificationReceived](#notificationreceivednotification-payload-sender) method. In that case, the sender is automatically set to the instance calling the sendNotification method.
-
-**Example:**
-````javascript
-this.sendNotification('MYMODULE_READY_FOR_ACTION', {foo:bar});
-````
-
-#### `this.sendSocketNotification(notification, payload)`
-***notification* String** - The notification identifier.<br>
-***payload* AnyType** - Optional. A notification payload.<br>
-
-If you want to send a notification to the node_helper, use the `sendSocketNotification(notification, payload)`. Only the node_helper of this module will receive the socket notification.
-
-**Example:**
-````javascript
-this.sendSocketNotification('SET_CONFIG', this.config);
-````
-
-#### `this.hide(speed, callback, options)`
-***speed* Number** - Optional (Required when setting callback or options), The speed of the hide animation in milliseconds.
-***callback* Function** - Optional, The callback after the hide animation is finished.
-***options* Function** - Optional, Object with additional options for the hide action (see below). (*Introduced in version: 2.1.0.*)
-
-To hide a module, you can call the `hide(speed, callback)` method. You can call the hide method on the module instance itself using `this.hide()`, but of course you can also hide another module using `anOtherModule.hide()`.
-
-Possible configurable options:
-
-- `lockString` - String - When setting lock string, the module can not be shown without passing the correct lockstring. This way (multiple) modules can prevent a module from showing. It's considered best practice to use your modules identifier as the locksString: `this.identifier`. See *visibility locking* below.
-
-
-**Note 1:** If the hide animation is canceled, for instance because the show method is called before the hide animation was finished, the callback will not be called.<br>
-**Note 2:** If the hide animation is hijacked (an other method calls hide on the same module), the callback will not be called.<br>
-**Note 3:** If the dom is not yet created, the hide method won't work. Wait for the `DOM_OBJECTS_CREATED` [notification](#notificationreceivednotification-payload-sender).
-
-
-#### `this.show(speed, callback, options)`
-***speed* Number** - Optional (Required when setting callback or options), The speed of the show animation in milliseconds.
-***callback* Function** - Optional, The callback after the show animation is finished.
-***options* Function** - Optional, Object with additional options for the show action (see below). (*Introduced in version: 2.1.0.*)
-
-To show a module, you can call the `show(speed, callback)` method. You can call the show method on the module instance itself using `this.show()`, but of course you can also show another module using `anOtherModule.show()`.
-
-Possible configurable options:
-
-- `lockString` - String - When setting lock string, the module can not be shown without passing the correct lockstring. This way (multiple) modules can prevent a module from showing. See *visibility locking* below.
-- `force` - Boolean - When setting the force tag to `true`, the locking mechanism will be overwritten. Use this option with caution. It's considered best practice to let the usage of the force option be use- configurable. See *visibility locking* below.
-
-**Note 1:** If the show animation is canceled, for instance because the hide method is called before the show animation was finished, the callback will not be called.<br>
-**Note 2:** If the show animation is hijacked (an other method calls show on the same module), the callback will not be called.<br>
-**Note 3:** If the dom is not yet created, the show method won't work. Wait for the `DOM_OBJECTS_CREATED` [notification](#notificationreceivednotification-payload-sender).
-
-#### Visibility locking
-
-(*Introduced in version: 2.1.0.*)
-
-Visiblity locking helps the module system to prevent unwanted hide/show actions. The following scenario explains the concept:
-
-**Module B asks module A to hide:**
-````javascript
-moduleA.hide(0, {lockString: "module_b_identifier"});
-````
-Module A is now hidden, and has an lock array with the following strings:
-````javascript
-moduleA.lockStrings == ["module_b_identifier"]
-moduleA.hidden == true
-````
-**Module C asks module A to hide:**
-````javascript
-moduleA.hide(0, {lockString: "module_c_identifier"});
-````
-Module A is now hidden, and has an lock array with the following strings:
-````javascript
-moduleA.lockStrings == ["module_b_identifier", "module_c_identifier"]
-moduleA.hidden == true
-````
-**Module B asks module A to show:**
-````javascript
-moduleA.show(0, {lockString: "module_b_identifier"});
-````
-The lockString will be removed from moduleA’s locks array, but since there still is an other lock string available, the module remains hidden:
-````javascript
-moduleA.lockStrings == ["module_c_identifier"]
-moduleA.hidden == true
-````
-**Module C asks module A to show:**
-````javascript
-moduleA.show(0, {lockString: "module_c_identifier"});
-````
-The lockString will be removed from moduleA’s locks array, and since this will result in an empty lock array, the module will be visible:
-````javascript
-moduleA.lockStrings == []
-moduleA.hidden == false
-````
-
-**Note:** The locking mechanism can be overwritten by using the force tag:
-````javascript
-moduleA.show(0, {force: true});
-````
-This will reset the lockstring array, and will show the module.
-````javascript
-moduleA.lockStrings == []
-moduleA.hidden == false
-````
-
-Use this `force` method with caution. See `show()` method for more information.
-
-
-
-#### `this.translate(identifier)`
-***identifier* String** - Identifier of the string that should be translated.
-
-The Magic Mirror contains a convenience wrapper for `l18n`. You can use this to automatically serve different translations for your modules based on the user's `language` configuration.
-
-If no translation is found, a fallback will be used. The fallback sequence is as follows:
-- 1. Translation as defined in module translation file of the user's preferred language.
-- 2. Translation as defined in core translation file of the user's preferred language.
-- 3. Translation as defined in module translation file of the fallback language (the first defined module translation file).
-- 4. Translation as defined in core translation file of the fallback language (the first defined core translation file).
-- 5. The key (identifier) of the translation.
-
-When adding translations to your module, it's a good idea to see if an apropriate translation is already available in the [core translation files](https://github.com/MichMich/MagicMirror/tree/master/translations). This way, your module can benefit from the existing translations.
-
-**Example:**
-````javascript
-this.translate("INFO") //Will return a translated string for the identifier INFO
-````
-
-**Example json file:**
-````javascript
-{
-  "INFO": "Really important information!"
-}
-````
-
-**Note:** although comments are officially not supported in JSON files, MagicMirror allows it by stripping the comments before parsing the JSON file. Comments in translation files could help other translators.
-
-##### `this.translate(identifier, variables)`
-***identifier* String** - Identifier of the string that should be translated.
-***variables* Object** - Object of variables to be used in translation.
-
-This improved and backwards compatible way to handle translations behaves like the normal translation function and follows the rules described above. It's recommended to use this new format for translating everywhere. It allows translator to change the word order in the sentence to be translated.
-
-
-**Example:**
-````javascript
-var timeUntilEnd = moment(event.endDate, "x").fromNow(true);
-this.translate("RUNNING", { "timeUntilEnd": timeUntilEnd) }); // Will return a translated string for the identifier RUNNING, replacing `{timeUntilEnd}` with the contents of the variable `timeUntilEnd` in the order that translator intended.
-````
-
-**Example English .json file:**
-````javascript
-{
-	"RUNNING": "Ends in {timeUntilEnd}",
-}
-````
-
-**Example Finnish .json file:**
-````javascript
-{
-	"RUNNING": "Päättyy {timeUntilEnd} päästä",
-}
-````
-
-**Note:** The *variables* Object has an special case called `fallback`. It's used to support old translations in translation files that do not have the variables in them. If you are upgrading an old module that had translations that did not support the word order, it is recommended to have the fallback layout.
-
-**Example:**
-````javascript
-var timeUntilEnd = moment(event.endDate, "x").fromNow(true);
-this.translate("RUNNING", {
-	"fallback": this.translate("RUNNING") + " {timeUntilEnd}"
-	"timeUntilEnd": timeUntilEnd
-)}); // Will return a translated string for the identifier RUNNING, replacing `{timeUntilEnd}` with the contents of the variable `timeUntilEnd` in the order that translator intended. (has a fallback)
-````
-
-**Example swedish .json file that does not have the variable in it:**
-````javascript
-{
-	"RUNNING": "Slutar",
-}
-````
-In this case the `translate`-function will not find any variables in the translation, will look for `fallback` variable and use that if possible to create the translation.
-
-## The Node Helper: node_helper.js
-
-The node helper is a Node.js script that is able to do some backend task to support your module. For every module type, only one node helper instance will be created. For example: if your MagicMirror uses two calendar modules, there will be only one calendar node helper instantiated.
-
-**Note:** Because there is only one node helper per module type, there is no default config available within your module. It's your task to send the desired config from your module to your node helper.
-
-In it's most simple form, the node_helper.js file must contain:
-
-````javascript
-var NodeHelper = require("node_helper");
-module.exports = NodeHelper.create({});
-````
-
-Of course, the above helper would not do anything useful. So with the information above, you should be able to make it a bit more sophisticated.
-
-### Available module instance properties
-
-#### `this.name`
-**String**
-
-The name of the module
-
-#### `this.path`
-**String**
-
-The path of the module
-
-#### `this.expressApp`
-**Express App Instance**
-
-This is a link to the express instance. It will allow you to define extra routes.
-
-**Example:**
-````javascript
-start: function() {
-	this.expressApp.get('/foobar', function (req, res) {
-		res.send('GET request to /foobar');
-	});
-}
-````
-
-**Note:** By default, a public path to your module's public folder will be created:
-````javascript
-this.expressApp.use("/" + this.name, express.static(this.path + "/public"));
-````
-
-#### `this.io`
-**Socket IO Instance**
-
-This is a link to the IO instance. It will allow you to do some Socket.IO magic. In most cases you won't need this, since the Node Helper has a few convenience methods to make this simple.
-
-
-#### `requiresVersion:`
-*Introduced in version: 2.1.0.*
-
-A string that defines the minimum version of the MagicMirror framework. If it is set, the system compares the required version with the users version. If the version of the user is out of date, it won't run the module.
-
-**Note:** Since this check is introduced in version 2.1.0, this check will not be run in older versions. Keep this in mind if you get issue reports on your module.
-
-Example:
-````javascript
-requiresVersion: "2.1.0",
-````
-
-### Subclassable module methods
-
-#### `init()`
-This method is called when a node helper gets instantiated. In most cases you do not need to subclass this method.
-
-#### `start()`
-This method is called when all node helpers are loaded and the system is ready to boot up. The start method is a perfect place to define any additional module properties:
-
-**Example:**
-````javascript
-start: function() {
-	this.mySpecialProperty = "So much wow!";
-	Log.log(this.name + ' is started!');
-}
-````
-
-#### `stop()`
-This method is called when the MagicMirror server receives a `SIGINT` command and is shutting down. This method should include any commands needed to close any open connections, stop any sub-processes and gracefully exit the module.
-
-**Example:**
-````javascript
-stop: function() {
-	console.log("Shutting down MyModule");
-	this.connection.close();
-}
-````
-
-#### `socketNotificationReceived: function(notification, payload)`
-With this method, your node helper can receive notifications from your modules. When this method is called, it has 2 arguments:
-
-- `notification` - String - The notification identifier.
-- `payload` - AnyType - The payload of a notification.
-
-**Note:** The socket connection is established as soon as the module sends its first message using [sendSocketNotification](thissendsocketnotificationnotification-payload).
-
-**Example:**
-````javascript
-socketNotificationReceived: function(notification, payload) {
-	Log.log(this.name + " received a socket notification: " + notification + " - Payload: " + payload);
-},
-````
-
-### Module instance methods
-
-Each node helper has some handy methods which can be helpful building your module.
-
-#### `this.sendSocketNotification(notification, payload)`
-***notification* String** - The notification identifier.<br>
-***payload* AnyType** - Optional. A notification payload.<br>
-
-If you want to send a notification to all your modules, use the `sendSocketNotification(notification, payload)`. Only the module of your module type will receive the socket notification.
-
-**Note:** Since all instances of your module will receive the notifications, it's your task to make sure the right module responds to your messages.
-
-**Example:**
-````javascript
-this.sendSocketNotification('SET_CONFIG', this.config);
-````
-
-## MagicMirror Helper Methods
-
-The core Magic Mirror object: `MM` has some handy method that will help you in controlling your and other modules. Most of the `MM` methods are available via convenience methods on the Module instance.
-
-### Module selection
-The only additional method available for your module, is the feature to retrieve references to other modules. This can be used to hide and show other modules.
-
-#### `MM.getModules()`
-**Returns Array** - An array with module instances.<br>
-
-To make a selection of all currently loaded module instances, run the `MM.getModules()` method. It will return an array with all currently loaded module instances. The returned array has a lot of filtering methods. See below for more info.
-
-**Note:** This method returns an empty array if not all modules are started yet. Wait for the `ALL_MODULES_STARTED` [notification](#notificationreceivednotification-payload-sender).
-
-
-##### `.withClass(classnames)`
-***classnames* String or Array** - The class names on which you want to filter.
-**Returns Array** - An array with module instances.<br>
-
-If you want to make a selection based on one or more class names, use the withClass method on a result of the `MM.getModules()` method. The argument of the `withClass(classname)` method can be an array, or space separated string.
-
-**Examples:**
-````javascript
-var modules = MM.getModules().withClass('classname');
-var modules = MM.getModules().withClass('classname1 classname2');
-var modules = MM.getModules().withClass(['classname1','classname2']);
-````
-
-##### `.exceptWithClass(classnames)`
-***classnames* String or Array** - The class names of the modules you want to remove from the results.
-**Returns Array** - An array with module instances.<br>
-
-If you to remove some modules from a selection based on a classname, use the exceptWithClass method on a result of the `MM.getModules()` method. The argument of the `exceptWithClass(classname)` method can be an array, or space separated string.
-
-**Examples:**
-````javascript
-var modules = MM.getModules().exceptWithClass('classname');
-var modules = MM.getModules().exceptWithClass('classname1 classname2');
-var modules = MM.getModules().exceptWithClass(['classname1','classname2']);
-````
-
-##### `.exceptModule(module)`
-***module* Module Object** - The reference to a module you want to remove from the results.
-**Returns Array** - An array with module instances.<br>
-
-If you to remove a specific module instance from a selection based on a classname, use the exceptWithClass method on a result of the `MM.getModules()` method. This can be helpful if you want to select all module instances except the instance of your module.
-
-**Examples:**
-````javascript
-var modules = MM.getModules().exceptModule(this);
-````
-
-Of course, you can combine all of the above filters:
-
-**Example:**
-````javascript
-var modules = MM.getModules().withClass('classname1').exceptwithClass('classname2').exceptModule(aModule);
-````
-
-##### `.enumerate(callback)`
-***callback* Function(module)** - The callback run on every instance.
-
-If you want to perform an action on all selected modules, you can use the `enumerate` function:
-
-````javascript
-MM.getModules().enumerate(function(module) {
-    Log.log(module.name);
-});
-````
-
-**Example:**
-To hide all modules except the your module instance, you could write something like:
-````javascript
-Module.register("modulename",{
-	//...
-	notificationReceived: function(notification, payload, sender) {
-		if (notification === 'DOM_OBJECTS_CREATED') {
-			MM.getModules().exceptModule(this).enumerate(function(module) {
-				module.hide(1000, function() {
-					//Module hidden.
-				});
-			});
-		}
-	},
-	//...
-});
-````
-
-## MagicMirror Logger
-
-The Magic Mirror contains a convenience wrapper for logging. Currently, this logger is a simple proxy to the original `console.log` methods. But it might get additional features in the future. The Loggers is currently only available in the core module file (not in the node_helper).
-
-**Examples:**
-````javascript
-Log.info('error');
-Log.log('log');
-Log.error('info');
-````

modules/default/alert/README.md

@@ -1,64 +1,5 @@
 # Module: Alert
-The alert module is one of the default modules of the MagicMirror. This module displays notifications from other modules.
 
-## Usage
-To use this module, add it to the modules array in the config/config.js file:
+The alert module is one of the default modules of the MagicMirror². This module displays notifications from other modules.
 
-```
-modules: [
-	{
-		module: "alert",
-		config: {
-			// The config property is optional.
-			// See 'Configuration options' for more information.
-		}
-	}
-]
-```
-
-## Configuration options
-
-The following properties can be configured:
-
-
-| Option            | Description
-| ----------------- | -----------
-| `effect`          | The animation effect to use for notifications. <br><br> **Possible values:** `scale` `slide` `genie` `jelly` `flip` `exploader` `bouncyflip` <br> **Default value:** `slide`
-| `alert_effect`    | The animation effect to use for alerts. <br><br> **Possible values:** `scale` `slide` `genie` `jelly` `flip` `exploader` `bouncyflip` <br> **Default value:** `jelly`
-| `display_time`    | Time a notification is displayed in milliseconds. <br><br> **Possible values:** `int` <br> **Default value:** `3500`
-| `position`        | Position where the notifications should be displayed. <br><br> **Possible values:** `left` `center` `right` <br> **Default value:** `center`
-| `welcome_message` | Message shown at startup. <br><br> **Possible values:** `string` `false` <br> **Default value:** `false` (no message at startup)
-
-
-## Developer notes
-For notifications use:
-
-```
-self.sendNotification("SHOW_ALERT", {type: "notification"});
-```
-For alerts use:
-
-```
-self.sendNotification("SHOW_ALERT", {});
-```
-
-### Notification params
-| Option    | Description
-| --------- | -----------
-| `title`   | The title of the notification. <br><br> **Possible values:** `text` or `html`
-| `message`	| The message of the notification. <br><br> **Possible values:** `text` or `html`
-
-
-### Alert params
-| Option                                          | Description
-| ----------------------------------------------- | -----------
-| `title`                                         | The title of the alert. <br><br> **Possible values:** `text` or `html`
-| `message`                                       | The message of the alert. <br><br> **Possible values:** `text` or `html`
-| `imageUrl` (optional)                           | Image to show in the alert <br><br> **Possible values:** `url` `path` <br> **Default value:** `none`
-| `imageFA` (optional)                            | Font Awesome icon to show in the alert <br><br> **Possible values:** See [Font Awsome](http://fontawesome.io/icons/) website. <br> **Default value:** `none`
-| `imageHeight` (optional even with imageUrl set) | Height of the image <br><br> **Possible values:** `intpx` <br> **Default value:** `80px`
-| `timer` (optional)                              | How long the alert should stay visible in ms. <br> **Important:** If you do not use the `timer`, it is your duty to hide the alert by using `self.sendNotification("HIDE_ALERT");`! <br><br>**Possible values:** `int` `float` <br> **Default value:** `none`
-
-## Open Source Licenses
-### [NotificationStyles](https://github.com/codrops/NotificationStyles)
-See [ympanus.net](http://tympanus.net/codrops/licensing/) for license.
+For configuration options, please check the [MagicMirror² documentation](https://docs.magicmirror.builders/modules/alert.html).

modules/default/alert/alert.js

@@ -1,156 +1,146 @@
-/* global Module */
+/* global NotificationFx */
 
-/* Magic Mirror
+/* MagicMirror²
  * Module: alert
  *
- * By Paul-Vincent Roll http://paulvincentroll.com
+ * By Paul-Vincent Roll https://paulvincentroll.com/
  * MIT Licensed.
  */
+Module.register("alert", {
+	alerts: {},
 
-Module.register("alert",{
 	defaults: {
-		// scale|slide|genie|jelly|flip|bouncyflip|exploader
-		effect: "slide",
-		// scale|slide|genie|jelly|flip|bouncyflip|exploader
-		alert_effect: "jelly",
-		//time a notification is displayed in seconds
-		display_time: 3500,
-		//Position
+		effect: "slide", // scale|slide|genie|jelly|flip|bouncyflip|exploader
+		alert_effect: "jelly", // scale|slide|genie|jelly|flip|bouncyflip|exploader
+		display_time: 3500, // time a notification is displayed in seconds
 		position: "center",
-		//shown at startup
-		welcome_message: false,
+		welcome_message: false // shown at startup
 	},
-	getScripts: function() {
-		return ["classie.js", "modernizr.custom.js", "notificationFx.js"];
+
+	getScripts() {
+		return ["notificationFx.js"];
 	},
-	getStyles: function() {
-		return ["ns-default.css"];
+
+	getStyles() {
+		return ["font-awesome.css", this.file(`./styles/notificationFx.css`), this.file(`./styles/${this.config.position}.css`)];
 	},
-	// Define required translations.
-	getTranslations: function() {
+
+	getTranslations() {
 		return {
-			en: "translations/en.json",
+			bg: "translations/bg.json",
+			da: "translations/da.json",
 			de: "translations/de.json",
+			en: "translations/en.json",
+			es: "translations/es.json",
+			fr: "translations/fr.json",
+			hu: "translations/hu.json",
 			nl: "translations/nl.json",
+			ru: "translations/ru.json"
 		};
 	},
-	show_notification: function(message) {
-		if (this.config.effect == "slide") {this.config.effect = this.config.effect + "-" + this.config.position;}
-		msg = "";
-		if (message.title) {
-			msg += "<span class='thin' style='line-height: 35px; font-size:24px' color='#4A4A4A'>" + message.title + "</span>";
-		}
-		if (message.message){
-			if (msg != ""){
-				msg+= "<br />";
-			}
-			msg += "<span class='light' style='font-size:28px;line-height: 30px;'>" + message.message + "</span>";
-		}
 
-		new NotificationFx({
-			message: msg,
-			layout: "growl",
-			effect: this.config.effect,
-			ttl: this.config.display_time
-		}).show();
+	getTemplate(type) {
+		return `templates/${type}.njk`;
 	},
-	show_alert: function(params, sender) {
-		var self = this;
-		//Set standard params if not provided by module
-		if (typeof params.timer === "undefined") { params.timer = null; }
-		if (typeof params.imageHeight === "undefined") { params.imageHeight = "80px"; }
-		if (typeof params.imageUrl === "undefined" && typeof params.imageFA === "undefined") {
-			params.imageUrl = null;
-			image = "";
-		} else if (typeof params.imageFA === "undefined"){
-			image = "<img src='" + (params.imageUrl).toString() + "' height=" + (params.imageHeight).toString() + " style='margin-bottom: 10px;'/><br />";
-		} else if (typeof params.imageUrl === "undefined"){
-			image = "<span class='" + "fa fa-" + params.imageFA + "' style='margin-bottom: 10px;color: #fff;font-size:" + (params.imageHeight).toString() + ";'/></span><br />";
-		}
-		//Create overlay
-		var overlay = document.createElement("div");
-		overlay.id = "overlay";
-		overlay.innerHTML += "<div class=\"black_overlay\"></div>";
-		document.body.insertBefore(overlay, document.body.firstChild);
 
-		//If module already has an open alert close it
-		if (this.alerts[sender.name]) {
-			this.hide_alert(sender);
+	start() {
+		Log.info(`Starting module: ${this.name}`);
+
+		if (this.config.effect === "slide") {
+			this.config.effect = `${this.config.effect}-${this.config.position}`;
 		}
 
-		//Display title and message only if they are provided in notification parameters
-		message ="";
-		if (params.title) {
-			message += "<span class='light' style='line-height: 35px; font-size:30px' color='#4A4A4A'>" + params.title + "</span>"
-		}
-		if (params.message) {
-			if (message != ""){
-				message += "<br />";
-			}
-
-			message += "<span class='thin' style='font-size:22px;line-height: 30px;'>" + params.message + "</span>";
-		}
-
-		//Store alert in this.alerts
-		this.alerts[sender.name] = new NotificationFx({
-			message: image + message,
-			effect: this.config.alert_effect,
-			ttl: params.timer,
-			al_no: "ns-alert"
-		});
-		//Show alert
-		this.alerts[sender.name].show();
-		//Add timer to dismiss alert and overlay
-		if (params.timer) {
-			setTimeout(function() {
-				self.hide_alert(sender);
-			}, params.timer);
-		}
-
-	},
-	hide_alert: function(sender) {
-		//Dismiss alert and remove from this.alerts
-		if (this.alerts[sender.name]) {
-			this.alerts[sender.name].dismiss();
-			this.alerts[sender.name] = null;
-			//Remove overlay
-			var overlay = document.getElementById("overlay");
-			overlay.parentNode.removeChild(overlay);
+		if (this.config.welcome_message) {
+			const message = this.config.welcome_message === true ? this.translate("welcome") : this.config.welcome_message;
+			this.showNotification({ title: this.translate("sysTitle"), message });
 		}
 	},
-	setPosition: function(pos) {
-		//Add css to body depending on the set position for notifications
-		var sheet = document.createElement("style");
-		if (pos == "center") {sheet.innerHTML = ".ns-box {margin-left: auto; margin-right: auto;text-align: center;}";}
-		if (pos == "right") {sheet.innerHTML = ".ns-box {margin-left: auto;text-align: right;}";}
-		if (pos == "left") {sheet.innerHTML = ".ns-box {margin-right: auto;text-align: left;}";}
-		document.body.appendChild(sheet);
 
-	},
-	notificationReceived: function(notification, payload, sender) {
+	notificationReceived(notification, payload, sender) {
 		if (notification === "SHOW_ALERT") {
-			if (typeof payload.type === "undefined") { payload.type = "alert"; }
-			if (payload.type == "alert") {
-				this.show_alert(payload, sender);
-			} else if (payload.type = "notification") {
-				this.show_notification(payload);
+			if (payload.type === "notification") {
+				this.showNotification(payload);
+			} else {
+				this.showAlert(payload, sender);
 			}
 		} else if (notification === "HIDE_ALERT") {
-			this.hide_alert(sender);
+			this.hideAlert(sender);
 		}
 	},
-	start: function() {
-		this.alerts = {};
-		this.setPosition(this.config.position);
-		if (this.config.welcome_message) {
-			if (this.config.welcome_message == true){
-				this.show_notification({title: this.translate("sysTitle"), message: this.translate("welcome")});
-			}
-			else{
-				this.show_notification({title: this.translate("sysTitle"), message: this.config.welcome_message});
+
+	async showNotification(notification) {
+		const message = await this.renderMessage("notification", notification);
+
+		new NotificationFx({
+			message,
+			layout: "growl",
+			effect: this.config.effect,
+			ttl: notification.timer || this.config.display_time
+		}).show();
+	},
+
+	async showAlert(alert, sender) {
+		// If module already has an open alert close it
+		if (this.alerts[sender.name]) {
+			this.hideAlert(sender, false);
+		}
+
+		// Add overlay
+		if (!Object.keys(this.alerts).length) {
+			this.toggleBlur(true);
+		}
+
+		const message = await this.renderMessage("alert", alert);
+
+		// Store alert in this.alerts
+		this.alerts[sender.name] = new NotificationFx({
+			message,
+			effect: this.config.alert_effect,
+			ttl: alert.timer,
+			onClose: () => this.hideAlert(sender),
+			al_no: "ns-alert"
+		});
+
+		// Show alert
+		this.alerts[sender.name].show();
+
+		// Add timer to dismiss alert and overlay
+		if (alert.timer) {
+			setTimeout(() => {
+				this.hideAlert(sender);
+			}, alert.timer);
+		}
+	},
+
+	hideAlert(sender, close = true) {
+		// Dismiss alert and remove from this.alerts
+		if (this.alerts[sender.name]) {
+			this.alerts[sender.name].dismiss(close);
+			delete this.alerts[sender.name];
+			// Remove overlay
+			if (!Object.keys(this.alerts).length) {
+				this.toggleBlur(false);
 			}
 		}
-		Log.info("Starting module: " + this.name);
-	}
+	},
 
+	renderMessage(type, data) {
+		return new Promise((resolve) => {
+			this.nunjucksEnvironment().render(this.getTemplate(type), data, function (err, res) {
+				if (err) {
+					Log.error("Failed to render alert", err);
+				}
+
+				resolve(res);
+			});
+		});
+	},
+
+	toggleBlur(add = false) {
+		const method = add ? "add" : "remove";
+		const modules = document.querySelectorAll(".module");
+		for (const module of modules) {
+			module.classList[method]("alert-blur");
+		}
+	}
 });

modules/default/alert/classie.js

@@ -1,79 +0,0 @@
-/*!
- * classie - class helper functions
- * from bonzo https://github.com/ded/bonzo
- *
- * classie.has( elem, 'my-class' ) -> true/false
- * classie.add( elem, 'my-new-class' )
- * classie.remove( elem, 'my-unwanted-class' )
- * classie.toggle( elem, 'my-class' )
- */
-// jscs:disable
-/*jshint browser: true, strict: true, undef: true */
-/*global define: false */
-
-(function(window) {
-
-"use strict";
-
-// class helper functions from bonzo https://github.com/ded/bonzo
-
-function classReg(className) {
-	return new RegExp("(^|\\s+)" + className + "(\\s+|$)");
-}
-
-// classList support for class management
-// altho to be fair, the api sucks because it won't accept multiple classes at once
-var hasClass, addClass, removeClass;
-
-if ("classList" in document.documentElement) {
-	hasClass = function(elem, c) {
-		return elem.classList.contains(c);
-	};
-	addClass = function(elem, c) {
-		elem.classList.add(c);
-	};
-	removeClass = function(elem, c) {
-		elem.classList.remove(c);
-	};
-} else {
-	hasClass = function(elem, c) {
-		return classReg(c).test(elem.className);
-	};
-	addClass = function(elem, c) {
-		if (!hasClass(elem, c)) {
-			elem.className = elem.className + " " + c;
-		}
-	};
-	removeClass = function(elem, c) {
-		elem.className = elem.className.replace(classReg(c), " ");
-	};
-}
-
-function toggleClass(elem, c) {
-	var fn = hasClass(elem, c) ? removeClass : addClass;
-	fn(elem, c);
-}
-
-var classie = {
-	// full names
-	hasClass: hasClass,
-	addClass: addClass,
-	removeClass: removeClass,
-	toggleClass: toggleClass,
-	// short names
-	has: hasClass,
-	add: addClass,
-	remove: removeClass,
-	toggle: toggleClass
-};
-
-// transport
-if (typeof define === "function" && define.amd) {
-	// AMD
-	define(classie);
-} else {
-	// browser global
-	window.classie = classie;
-}
-
-})(window);

modules/default/alert/notificationFx.js

@@ -1,34 +1,27 @@
 /**
+ * Based on work by
+ *
  * notificationFx.js v1.0.0
- * http://www.codrops.com
+ * https://tympanus.net/codrops/
  *
  * Licensed under the MIT license.
- * http://www.opensource.org/licenses/mit-license.php
+ * https://opensource.org/licenses/mit-license.php
  *
  * Copyright 2014, Codrops
- * http://www.codrops.com
+ * https://tympanus.net/codrops/
+ *
+ * @param {object} window The window object
  */
-// jscs:disable
-;(function(window) {
-
-	"use strict";
-
-	var docElem = window.document.documentElement,
-		support = {animations: Modernizr.cssanimations},
-		animEndEventNames = {
-			"WebkitAnimation": "webkitAnimationEnd",
-			"OAnimation": "oAnimationEnd",
-			"msAnimation": "MSAnimationEnd",
-			"animation": "animationend"
-		},
-		// animation end event name
-		animEndEventName = animEndEventNames[ Modernizr.prefixed("animation") ];
-
+(function (window) {
 	/**
-	 * extend obj function
+	 * Extend one object with another one
+	 *
+	 * @param {object} a The object to extend
+	 * @param {object} b The object which extends the other, overwrites existing keys
+	 * @returns {object} The merged object
 	 */
 	function extend(a, b) {
-		for (var key in b) {
+		for (let key in b) {
 			if (b.hasOwnProperty(key)) {
 				a[key] = b[key];
 			}
@@ -37,7 +30,10 @@
 	}
 
 	/**
-	 * NotificationFx function
+	 * NotificationFx constructor
+	 *
+	 * @param {object} options The configuration options
+	 * @class
 	 */
 	function NotificationFx(options) {
 		this.options = extend({}, this.options);
@@ -70,19 +66,22 @@
 		ttl: 6000,
 		al_no: "ns-box",
 		// callbacks
-		onClose: function() { return false; },
-		onOpen: function() { return false; }
+		onClose: function () {
+			return false;
+		},
+		onOpen: function () {
+			return false;
+		}
 	};
 
 	/**
-	 * init function
-	 * initialize and cache some vars
+	 * Initialize and cache some vars
 	 */
-	NotificationFx.prototype._init = function() {
+	NotificationFx.prototype._init = function () {
 		// create HTML structure
 		this.ntf = document.createElement("div");
-		this.ntf.className = this.options.al_no +  " ns-" + this.options.layout + " ns-effect-" + this.options.effect + " ns-type-" + this.options.type;
-		var strinner = "<div class=\"ns-box-inner\">";
+		this.ntf.className = this.options.al_no + " ns-" + this.options.layout + " ns-effect-" + this.options.effect + " ns-type-" + this.options.type;
+		let strinner = '<div class="ns-box-inner">';
 		strinner += this.options.message;
 		strinner += "</div>";
 		this.ntf.innerHTML = strinner;
@@ -91,13 +90,12 @@
 		this.options.wrapper.insertBefore(this.ntf, this.options.wrapper.nextSibling);
 
 		// dismiss after [options.ttl]ms
-		var self = this;
 		if (this.options.ttl) {
-			this.dismissttl = setTimeout(function() {
-			if (self.active) {
-				self.dismiss();
-			}
-		}, this.options.ttl);
+			this.dismissttl = setTimeout(() => {
+				if (this.active) {
+					this.dismiss();
+				}
+			}, this.options.ttl);
 		}
 
 		// init events
@@ -105,61 +103,58 @@
 	};
 
 	/**
-	 * init events
+	 * Init events
 	 */
-	NotificationFx.prototype._initEvents = function() {
-		var self = this;
+	NotificationFx.prototype._initEvents = function () {
 		// dismiss notification by tapping on it if someone has a touchscreen
-		this.ntf.querySelector(".ns-box-inner").addEventListener("click", function() { self.dismiss(); });
+		this.ntf.querySelector(".ns-box-inner").addEventListener("click", () => {
+			this.dismiss();
+		});
 	};
 
 	/**
-	 * show the notification
+	 * Show the notification
 	 */
-	NotificationFx.prototype.show = function() {
+	NotificationFx.prototype.show = function () {
 		this.active = true;
-		classie.remove(this.ntf, "ns-hide");
-		classie.add(this.ntf, "ns-show");
+		this.ntf.classList.remove("ns-hide");
+		this.ntf.classList.add("ns-show");
 		this.options.onOpen();
 	};
 
 	/**
-	 * dismiss the notification
+	 * Dismiss the notification
+	 *
+	 * @param {boolean} [close] call the onClose callback at the end
 	 */
-	NotificationFx.prototype.dismiss = function() {
-		var self = this;
+	NotificationFx.prototype.dismiss = function (close = true) {
 		this.active = false;
 		clearTimeout(this.dismissttl);
-		classie.remove(this.ntf, "ns-show");
-		setTimeout(function() {
-			classie.add(self.ntf, "ns-hide");
+		this.ntf.classList.remove("ns-show");
+		setTimeout(() => {
+			this.ntf.classList.add("ns-hide");
 
 			// callback
-			self.options.onClose();
+			if (close) this.options.onClose();
 		}, 25);
 
 		// after animation ends remove ntf from the DOM
-		var onEndAnimationFn = function(ev) {
-			if (support.animations) {
-				if (ev.target !== self.ntf) return false;
-				this.removeEventListener(animEndEventName, onEndAnimationFn);
+		const onEndAnimationFn = (ev) => {
+			if (ev.target !== this.ntf) {
+				return false;
 			}
+			this.ntf.removeEventListener("animationend", onEndAnimationFn);
 
-			if (this.parentNode === self.options.wrapper) {
-				self.options.wrapper.removeChild(this);
+			if (ev.target.parentNode === this.options.wrapper) {
+				this.options.wrapper.removeChild(this.ntf);
 			}
 		};
 
-		if (support.animations) {
-			this.ntf.addEventListener(animEndEventName, onEndAnimationFn);
-		} else {
-			onEndAnimationFn();
-		}
+		this.ntf.addEventListener("animationend", onEndAnimationFn);
 	};
 
 	/**
-	 * add to global namespace
+	 * Add to global namespace
 	 */
 	window.NotificationFx = NotificationFx;
-
 })(window);

modules/default/alert/styles/center.css

@@ -0,0 +1,5 @@
+.ns-box {
+  margin-left: auto;
+  margin-right: auto;
+  text-align: center;
+}

modules/default/alert/styles/left.css

@@ -0,0 +1,4 @@
+.ns-box {
+  margin-right: auto;
+  text-align: left;
+}

modules/default/alert/styles/notificationFx.css

@@ -0,0 +1,928 @@
+/* Based on work by https://tympanus.net/codrops/licensing/ */
+
+.ns-box {
+  background-color: rgba(0, 0, 0, 0.93);
+  padding: 17px;
+  line-height: 1.4;
+  margin-bottom: 10px;
+  z-index: 1;
+  font-size: 70%;
+  position: relative;
+  display: table;
+  word-wrap: break-word;
+  max-width: 100%;
+  border-width: 1px;
+  border-radius: 5px;
+  border-style: solid;
+  border-color: var(--color-text-dimmed);
+}
+
+.ns-alert {
+  border-style: solid;
+  border-color: var(--color-text-bright);
+  padding: 17px;
+  line-height: 1.4;
+  margin-bottom: 10px;
+  z-index: 3;
+  color: var(--color-text-bright);
+  font-size: 70%;
+  position: fixed;
+  text-align: center;
+  right: 0;
+  left: 0;
+  margin-right: auto;
+  margin-left: auto;
+  top: 40%;
+  width: 40%;
+  height: auto;
+  word-wrap: break-word;
+  border-radius: 20px;
+}
+
+.alert-blur {
+  filter: blur(2px) brightness(50%);
+}
+
+[class^="ns-effect-"].ns-growl.ns-hide,
+[class*=" ns-effect-"].ns-growl.ns-hide {
+  animation-direction: reverse;
+}
+
+.ns-effect-flip {
+  transform-origin: 50% 100%;
+  backface-visibility: hidden;
+}
+
+.ns-effect-flip.ns-show,
+.ns-effect-flip.ns-hide {
+  animation-name: animFlipFront;
+  animation-duration: 0.3s;
+}
+
+.ns-effect-flip.ns-hide {
+  animation-name: animFlipBack;
+}
+
+@keyframes animFlipFront {
+  0% {
+    transform: perspective(1000px) rotate3d(1, 0, 0, -90deg);
+  }
+
+  100% {
+    transform: perspective(1000px);
+  }
+}
+
+@keyframes animFlipBack {
+  0% {
+    transform: perspective(1000px) rotate3d(1, 0, 0, 90deg);
+  }
+
+  100% {
+    transform: perspective(1000px);
+  }
+}
+
+.ns-effect-bouncyflip.ns-show,
+.ns-effect-bouncyflip.ns-hide {
+  animation-name: flipInX;
+  animation-duration: 0.8s;
+}
+
+@keyframes flipInX {
+  0% {
+    transform: perspective(400px) rotate3d(1, 0, 0, -90deg);
+    transition-timing-function: ease-in;
+  }
+
+  40% {
+    transform: perspective(400px) rotate3d(1, 0, 0, 20deg);
+    transition-timing-function: ease-out;
+  }
+
+  60% {
+    transform: perspective(400px) rotate3d(1, 0, 0, -10deg);
+    transition-timing-function: ease-in;
+    opacity: 1;
+  }
+
+  80% {
+    transform: perspective(400px) rotate3d(1, 0, 0, 5deg);
+    transition-timing-function: ease-out;
+  }
+
+  100% {
+    transform: perspective(400px);
+  }
+}
+
+.ns-effect-bouncyflip.ns-hide {
+  animation-name: flipInXSimple;
+  animation-duration: 0.3s;
+}
+
+@keyframes flipInXSimple {
+  0% {
+    transform: perspective(400px) rotate3d(1, 0, 0, -90deg);
+    transition-timing-function: ease-in;
+  }
+
+  100% {
+    transform: perspective(400px);
+  }
+}
+
+.ns-effect-exploader {
+  transform-origin: 0 0;
+}
+
+.ns-effect-exploader p {
+  padding: 0.25em 2em 0.25em 3em;
+}
+
+.ns-effect-exploader.ns-show {
+  animation-name: animLoad;
+  animation-duration: 1s;
+}
+
+@keyframes animLoad {
+  0% {
+    opacity: 1;
+    transform: scale3d(0, 0.3, 1);
+  }
+
+  100% {
+    opacity: 1;
+    transform: scale3d(1, 1, 1);
+  }
+}
+
+.ns-effect-exploader.ns-hide {
+  animation-name: animFade;
+  animation-duration: 0.3s;
+}
+
+.ns-effect-exploader.ns-show .ns-box-inner,
+.ns-effect-exploader.ns-show .ns-close {
+  animation-fill-mode: both;
+  animation-duration: 0.3s;
+  animation-delay: 0.6s;
+}
+
+.ns-effect-exploader.ns-show .ns-close {
+  animation-name: animFade;
+}
+
+.ns-effect-exploader.ns-show .ns-box-inner {
+  animation-name: animFadeMove;
+  animation-timing-function: ease-out;
+}
+
+@keyframes animFadeMove {
+  0% {
+    opacity: 0;
+    transform: translate3d(0, 10px, 0);
+  }
+
+  100% {
+    opacity: 1;
+    transform: translate3d(0, 0, 0);
+  }
+}
+
+@keyframes animFade {
+  0% {
+    opacity: 0;
+  }
+
+  100% {
+    opacity: 1;
+  }
+}
+
+.ns-effect-scale.ns-show,
+.ns-effect-scale.ns-hide {
+  animation-name: animScale;
+  animation-duration: 0.25s;
+}
+
+@keyframes animScale {
+  0% {
+    opacity: 0;
+    transform: translate3d(0, 40px, 0) scale3d(0.1, 0.6, 1);
+  }
+
+  100% {
+    opacity: 1;
+    transform: translate3d(0, 0, 0) scale3d(1, 1, 1);
+  }
+}
+
+.ns-effect-jelly.ns-show {
+  animation-name: animJelly;
+  animation-duration: 1s;
+  animation-timing-function: linear;
+}
+
+.ns-effect-jelly.ns-hide {
+  animation-name: animFade;
+  animation-duration: 0.3s;
+}
+
+@keyframes animFade {
+  0% {
+    opacity: 0;
+  }
+  100% {
+    opacity: 1;
+  }
+}
+
+@keyframes animJelly {
+  0% {
+    transform: matrix3d(0.7, 0, 0, 0, 0, 0.7, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  2.083333% {
+    transform: matrix3d(0.75266, 0, 0, 0, 0, 0.76342, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  4.166667% {
+    transform: matrix3d(0.81071, 0, 0, 0, 0, 0.84545, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  6.25% {
+    transform: matrix3d(0.86808, 0, 0, 0, 0, 0.9286, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  8.333333% {
+    transform: matrix3d(0.92038, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  10.416667% {
+    transform: matrix3d(0.96482, 0, 0, 0, 0, 1.05202, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  12.5% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1.08204, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  14.583333% {
+    transform: matrix3d(1.02563, 0, 0, 0, 0, 1.09149, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  16.666667% {
+    transform: matrix3d(1.04227, 0, 0, 0, 0, 1.08453, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  18.75% {
+    transform: matrix3d(1.05102, 0, 0, 0, 0, 1.06666, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  20.833333% {
+    transform: matrix3d(1.05334, 0, 0, 0, 0, 1.04355, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  22.916667% {
+    transform: matrix3d(1.05078, 0, 0, 0, 0, 1.02012, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  25% {
+    transform: matrix3d(1.04487, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  27.083333% {
+    transform: matrix3d(1.03699, 0, 0, 0, 0, 0.98534, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  29.166667% {
+    transform: matrix3d(1.02831, 0, 0, 0, 0, 0.97688, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  31.25% {
+    transform: matrix3d(1.01973, 0, 0, 0, 0, 0.97422, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  33.333333% {
+    transform: matrix3d(1.01191, 0, 0, 0, 0, 0.97618, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  35.416667% {
+    transform: matrix3d(1.00526, 0, 0, 0, 0, 0.98122, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  37.5% {
+    transform: matrix3d(1, 0, 0, 0, 0, 0.98773, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  39.583333% {
+    transform: matrix3d(0.99617, 0, 0, 0, 0, 0.99433, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  41.666667% {
+    transform: matrix3d(0.99368, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  43.75% {
+    transform: matrix3d(0.99237, 0, 0, 0, 0, 1.00413, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  45.833333% {
+    transform: matrix3d(0.99202, 0, 0, 0, 0, 1.00651, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  47.916667% {
+    transform: matrix3d(0.99241, 0, 0, 0, 0, 1.00726, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  50% {
+    transform: matrix3d(0.99329, 0, 0, 0, 0, 1.00671, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  52.083333% {
+    transform: matrix3d(0.99447, 0, 0, 0, 0, 1.00529, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  54.166667% {
+    transform: matrix3d(0.99577, 0, 0, 0, 0, 1.00346, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  56.25% {
+    transform: matrix3d(0.99705, 0, 0, 0, 0, 1.0016, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  58.333333% {
+    transform: matrix3d(0.99822, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  60.416667% {
+    transform: matrix3d(0.99921, 0, 0, 0, 0, 0.99884, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  62.5% {
+    transform: matrix3d(1, 0, 0, 0, 0, 0.99816, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  64.583333% {
+    transform: matrix3d(1.00057, 0, 0, 0, 0, 0.99795, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  66.666667% {
+    transform: matrix3d(1.00095, 0, 0, 0, 0, 0.99811, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  68.75% {
+    transform: matrix3d(1.00114, 0, 0, 0, 0, 0.99851, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  70.833333% {
+    transform: matrix3d(1.00119, 0, 0, 0, 0, 0.99903, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  72.916667% {
+    transform: matrix3d(1.00114, 0, 0, 0, 0, 0.99955, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  75% {
+    transform: matrix3d(1.001, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  77.083333% {
+    transform: matrix3d(1.00083, 0, 0, 0, 0, 1.00033, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  79.166667% {
+    transform: matrix3d(1.00063, 0, 0, 0, 0, 1.00052, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  81.25% {
+    transform: matrix3d(1.00044, 0, 0, 0, 0, 1.00058, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  83.333333% {
+    transform: matrix3d(1.00027, 0, 0, 0, 0, 1.00053, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  85.416667% {
+    transform: matrix3d(1.00012, 0, 0, 0, 0, 1.00042, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  87.5% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1.00027, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  89.583333% {
+    transform: matrix3d(0.99991, 0, 0, 0, 0, 1.00013, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  91.666667% {
+    transform: matrix3d(0.99986, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  93.75% {
+    transform: matrix3d(0.99983, 0, 0, 0, 0, 0.99991, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  95.833333% {
+    transform: matrix3d(0.99982, 0, 0, 0, 0, 0.99985, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  97.916667% {
+    transform: matrix3d(0.99983, 0, 0, 0, 0, 0.99984, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  100% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+}
+
+.ns-effect-slide-left.ns-show {
+  animation-name: animSlideElasticLeft;
+  animation-duration: 1s;
+  animation-timing-function: linear;
+}
+
+@keyframes animSlideElasticLeft {
+  0% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, -1000, 0, 0, 1);
+  }
+
+  1.666667% {
+    transform: matrix3d(1.92933, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, -739.26805, 0, 0, 1);
+  }
+
+  3.333333% {
+    transform: matrix3d(1.96989, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, -521.82545, 0, 0, 1);
+  }
+
+  5% {
+    transform: matrix3d(1.70901, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, -349.26115, 0, 0, 1);
+  }
+
+  6.666667% {
+    transform: matrix3d(1.4235, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, -218.3238, 0, 0, 1);
+  }
+
+  8.333333% {
+    transform: matrix3d(1.21065, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, -123.29848, 0, 0, 1);
+  }
+
+  10% {
+    transform: matrix3d(1.08167, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, -57.59273, 0, 0, 1);
+  }
+
+  11.666667% {
+    transform: matrix3d(1.0165, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, -14.72371, 0, 0, 1);
+  }
+
+  13.333333% {
+    transform: matrix3d(0.99057, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 11.12794, 0, 0, 1);
+  }
+
+  15% {
+    transform: matrix3d(0.98478, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 24.86339, 0, 0, 1);
+  }
+
+  16.666667% {
+    transform: matrix3d(0.98719, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 30.40503, 0, 0, 1);
+  }
+
+  18.333333% {
+    transform: matrix3d(0.9916, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 30.75275, 0, 0, 1);
+  }
+
+  20% {
+    transform: matrix3d(0.99541, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 28.10141, 0, 0, 1);
+  }
+
+  21.666667% {
+    transform: matrix3d(0.99795, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 23.98271, 0, 0, 1);
+  }
+
+  23.333333% {
+    transform: matrix3d(0.99936, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 19.40752, 0, 0, 1);
+  }
+
+  25% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 14.99558, 0, 0, 1);
+  }
+
+  26.666667% {
+    transform: matrix3d(1.00021, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 11.08575, 0, 0, 1);
+  }
+
+  28.333333% {
+    transform: matrix3d(1.00022, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 7.82507, 0, 0, 1);
+  }
+
+  30% {
+    transform: matrix3d(1.00016, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 5.23737, 0, 0, 1);
+  }
+
+  31.666667% {
+    transform: matrix3d(1.0001, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 3.27389, 0, 0, 1);
+  }
+
+  33.333333% {
+    transform: matrix3d(1.00005, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 1.84893, 0, 0, 1);
+  }
+
+  35% {
+    transform: matrix3d(1.00002, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0.86364, 0, 0, 1);
+  }
+
+  36.666667% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0.22079, 0, 0, 1);
+  }
+
+  38.333333% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, -0.16687, 0, 0, 1);
+  }
+
+  40% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, -0.37284, 0, 0, 1);
+  }
+
+  41.666667% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, -0.45594, 0, 0, 1);
+  }
+
+  43.333333% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, -0.46116, 0, 0, 1);
+  }
+
+  45% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, -0.4214, 0, 0, 1);
+  }
+
+  46.666667% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, -0.35963, 0, 0, 1);
+  }
+
+  48.333333% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, -0.29103, 0, 0, 1);
+  }
+
+  50% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, -0.22487, 0, 0, 1);
+  }
+
+  51.666667% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, -0.16624, 0, 0, 1);
+  }
+
+  53.333333% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, -0.11734, 0, 0, 1);
+  }
+
+  55% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, -0.07854, 0, 0, 1);
+  }
+
+  56.666667% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, -0.04909, 0, 0, 1);
+  }
+
+  58.333333% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, -0.02773, 0, 0, 1);
+  }
+
+  60% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, -0.01295, 0, 0, 1);
+  }
+
+  61.666667% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, -0.00331, 0, 0, 1);
+  }
+
+  63.333333% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0.0025, 0, 0, 1);
+  }
+
+  65% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0.00559, 0, 0, 1);
+  }
+
+  66.666667% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0.00684, 0, 0, 1);
+  }
+
+  68.333333% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0.00692, 0, 0, 1);
+  }
+
+  70% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0.00632, 0, 0, 1);
+  }
+
+  71.666667% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0.00539, 0, 0, 1);
+  }
+
+  73.333333% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0.00436, 0, 0, 1);
+  }
+
+  75% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0.00337, 0, 0, 1);
+  }
+
+  76.666667% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0.00249, 0, 0, 1);
+  }
+
+  78.333333% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0.00176, 0, 0, 1);
+  }
+
+  80% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0.00118, 0, 0, 1);
+  }
+
+  81.666667% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0.00074, 0, 0, 1);
+  }
+
+  83.333333% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0.00042, 0, 0, 1);
+  }
+
+  85% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0.00019, 0, 0, 1);
+  }
+
+  86.666667% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0.00005, 0, 0, 1);
+  }
+
+  88.333333% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, -0.00004, 0, 0, 1);
+  }
+
+  90% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, -0.00008, 0, 0, 1);
+  }
+
+  91.666667% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, -0.0001, 0, 0, 1);
+  }
+
+  93.333333% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, -0.0001, 0, 0, 1);
+  }
+
+  95% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, -0.00009, 0, 0, 1);
+  }
+
+  96.666667% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, -0.00008, 0, 0, 1);
+  }
+
+  98.333333% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, -0.00007, 0, 0, 1);
+  }
+
+  100% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+}
+
+.ns-effect-slide-left.ns-hide {
+  animation-name: animSlideLeft;
+  animation-duration: 0.25s;
+}
+
+@keyframes animSlideLeft {
+  0% {
+    transform: translate3d(-30px, 0, 0) translate3d(-100%, 0, 0);
+  }
+
+  100% {
+    transform: translate3d(0, 0, 0);
+  }
+}
+
+.ns-effect-slide-right.ns-show {
+  animation: animSlideElasticRight 2000ms linear both;
+}
+
+@keyframes animSlideElasticRight {
+  0% {
+    transform: matrix3d(2, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 1000, 0, 0, 1);
+  }
+
+  2.15% {
+    transform: matrix3d(1.486, 0, 0, 0, 0, 0.514, 0, 0, 0, 0, 1, 0, 664.594, 0, 0, 1);
+  }
+
+  4.1% {
+    transform: matrix3d(1.147, 0, 0, 0, 0, 0.853, 0, 0, 0, 0, 1, 0, 419.708, 0, 0, 1);
+  }
+
+  4.3% {
+    transform: matrix3d(1.121, 0, 0, 0, 0, 0.879, 0, 0, 0, 0, 1, 0, 398.136, 0, 0, 1);
+  }
+
+  6.46% {
+    transform: matrix3d(0.948, 0, 0, 0, 0, 1.052, 0, 0, 0, 0, 1, 0, 206.714, 0, 0, 1);
+  }
+
+  8.11% {
+    transform: matrix3d(0.908, 0, 0, 0, 0, 1.092, 0, 0, 0, 0, 1, 0, 105.491, 0, 0, 1);
+  }
+
+  8.61% {
+    transform: matrix3d(0.907, 0, 0, 0, 0, 1.093, 0, 0, 0, 0, 1, 0, 81.572, 0, 0, 1);
+  }
+
+  12.11% {
+    transform: matrix3d(0.95, 0, 0, 0, 0, 1.05, 0, 0, 0, 0, 1, 0, -18.434, 0, 0, 1);
+  }
+
+  14.16% {
+    transform: matrix3d(0.979, 0, 0, 0, 0, 1.021, 0, 0, 0, 0, 1, 0, -38.734, 0, 0, 1);
+  }
+
+  16.12% {
+    transform: matrix3d(0.997, 0, 0, 0, 0, 1.003, 0, 0, 0, 0, 1, 0, -43.356, 0, 0, 1);
+  }
+
+  19.72% {
+    transform: matrix3d(1.006, 0, 0, 0, 0, 0.994, 0, 0, 0, 0, 1, 0, -34.155, 0, 0, 1);
+  }
+
+  27.23% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, -7.839, 0, 0, 1);
+  }
+
+  30.83% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, -1.951, 0, 0, 1);
+  }
+
+  38.34% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 1.037, 0, 0, 1);
+  }
+
+  41.99% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0.812, 0, 0, 1);
+  }
+
+  50% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0.159, 0, 0, 1);
+  }
+
+  60.56% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, -0.025, 0, 0, 1);
+  }
+
+  82.78% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0.001, 0, 0, 1);
+  }
+
+  100% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+}
+
+.ns-effect-slide-right.ns-hide {
+  animation-name: animSlideRight;
+  animation-duration: 0.25s;
+}
+
+@keyframes animSlideRight {
+  0% {
+    transform: translate3d(30px, 0, 0) translate3d(100%, 0, 0);
+  }
+
+  100% {
+    transform: translate3d(0, 0, 0);
+  }
+}
+
+.ns-effect-slide-center.ns-show {
+  animation: animSlideElasticCenter 2000ms linear both;
+}
+
+@keyframes animSlideElasticCenter {
+  0% {
+    transform: matrix3d(1, 0, 0, 0, 0, 3, 0, 0, 0, 0, 1, 0, 0, -300, 0, 1);
+  }
+
+  2.15% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1.971, 0, 0, 0, 0, 1, 0, 0, -199.378, 0, 1);
+  }
+
+  4.1% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1.294, 0, 0, 0, 0, 1, 0, 0, -125.912, 0, 1);
+  }
+
+  4.3% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1.243, 0, 0, 0, 0, 1, 0, 0, -119.441, 0, 1);
+  }
+
+  6.46% {
+    transform: matrix3d(1, 0, 0, 0, 0, 0.895, 0, 0, 0, 0, 1, 0, 0, -62.014, 0, 1);
+  }
+
+  8.11% {
+    transform: matrix3d(1, 0, 0, 0, 0, 0.817, 0, 0, 0, 0, 1, 0, 0, -31.647, 0, 1);
+  }
+
+  8.61% {
+    transform: matrix3d(1, 0, 0, 0, 0, 0.813, 0, 0, 0, 0, 1, 0, 0, -24.472, 0, 1);
+  }
+
+  12.11% {
+    transform: matrix3d(1, 0, 0, 0, 0, 0.9, 0, 0, 0, 0, 1, 0, 0, 5.53, 0, 1);
+  }
+
+  14.16% {
+    transform: matrix3d(1, 0, 0, 0, 0, 0.959, 0, 0, 0, 0, 1, 0, 0, 11.62, 0, 1);
+  }
+
+  16.12% {
+    transform: matrix3d(1, 0, 0, 0, 0, 0.994, 0, 0, 0, 0, 1, 0, 0, 13.007, 0, 1);
+  }
+
+  19.72% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1.012, 0, 0, 0, 0, 1, 0, 0, 10.247, 0, 1);
+  }
+
+  27.23% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 2.352, 0, 1);
+  }
+
+  30.83% {
+    transform: matrix3d(1, 0, 0, 0, 0, 0.999, 0, 0, 0, 0, 1, 0, 0, 0.585, 0, 1);
+  }
+
+  38.34% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, -0.311, 0, 1);
+  }
+
+  41.99% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, -0.244, 0, 1);
+  }
+
+  50% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, -0.048, 0, 1);
+  }
+
+  60.56% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0.007, 0, 1);
+  }
+
+  82.78% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+
+  100% {
+    transform: matrix3d(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1);
+  }
+}
+
+.ns-effect-slide-center.ns-hide {
+  animation-name: animSlideCenter;
+  animation-duration: 0.25s;
+}
+
+@keyframes animSlideCenter {
+  0% {
+    transform: translate3d(0, -30px, 0) translate3d(0, -100%, 0);
+  }
+
+  100% {
+    transform: translate3d(0, 0, 0);
+  }
+}
+
+.ns-effect-genie.ns-show,
+.ns-effect-genie.ns-hide {
+  animation-name: animGenie;
+  animation-duration: 0.4s;
+}
+
+@keyframes animGenie {
+  0% {
+    opacity: 0;
+    transform: translate3d(0, calc(200% + 30px), 0) scale3d(0, 1, 1);
+    animation-timing-function: ease-in;
+  }
+
+  40% {
+    opacity: 0.5;
+    transform: translate3d(0, 0, 0) scale3d(0.02, 1.1, 1);
+    animation-timing-function: ease-out;
+  }
+
+  70% {
+    opacity: 0.6;
+    transform: translate3d(0, -40px, 0) scale3d(0.8, 1.1, 1);
+  }
+
+  100% {
+    opacity: 1;
+    transform: translate3d(0, 0, 0) scale3d(1, 1, 1);
+  }
+}

modules/default/alert/styles/right.css

@@ -0,0 +1,4 @@
+.ns-box {
+  margin-left: auto;
+  text-align: right;
+}

modules/default/alert/templates/alert.njk

@@ -0,0 +1,18 @@
+{% if imageUrl or imageFA %}
+  {% set imageHeight = imageHeight if imageHeight else "80px" %}
+  {% if imageUrl %}
+    <img src="{{ imageUrl }}" height="{{ imageHeight }}" style="margin-bottom: 10px;"/>
+  {% else %}
+    <span class="bright fas fa-{{ imageFA }}" style='margin-bottom: 10px; font-size: {{ imageHeight }};'/></span>
+  {% endif %}
+  <br/>
+{% endif %}
+{% if title %}
+  <span class="thin dimmed medium">{{ title }}</span>
+{% endif %}
+{% if message %}
+  {% if title %}
+    <br/>
+  {% endif %}
+  <span class="light bright small">{{ message }}</span>
+{% endif %}

modules/default/alert/templates/notification.njk

@@ -0,0 +1,9 @@
+{% if title %}
+  <span class="thin dimmed medium">{{ title }}</span>
+{% endif %}
+{% if message %}
+  {% if title %}
+    <br/>
+  {% endif %}
+  <span class="light bright small">{{ message }}</span>
+{% endif %}

modules/default/alert/translations/bg.json

@@ -1,4 +1,4 @@
 {
-  "sysTitle": "MagicMirror нотификация",
-  "welcome": "Добре дошли, стартирането беше успешно"
+	"sysTitle": "MagicMirror² нотификация",
+	"welcome": "Добре дошли, стартирането беше успешно"
 }

modules/default/alert/translations/da.json

@@ -1,4 +1,4 @@
 {
-  "sysTitle": "MagicMirror Notifikation",
-  "welcome": "Velkommen, modulet er succesfuldt startet!"
+	"sysTitle": "MagicMirror² Notifikation",
+	"welcome": "Velkommen, modulet er succesfuldt startet!"
 }

modules/default/alert/translations/de.json

@@ -1,4 +1,4 @@
 {
-  "sysTitle": "MagicMirror Benachrichtigung",
-  "welcome": "Willkommen, Start war erfolgreich!"
+	"sysTitle": "MagicMirror² Benachrichtigung",
+	"welcome": "Willkommen, Start war erfolgreich!"
 }

modules/default/alert/translations/en.json

@@ -1,4 +1,4 @@
 {
-  "sysTitle": "MagicMirror Notification",
-  "welcome": "Welcome, start was successful!"
+	"sysTitle": "MagicMirror² Notification",
+	"welcome": "Welcome, start was successful!"
 }

modules/default/alert/translations/es.json

@@ -1,4 +1,4 @@
 {
-  "sysTitle": "MagicMirror Notificaciones",
-  "welcome": "Bienvenido, ¡se iniciado correctamente!"
+	"sysTitle": "MagicMirror² Notificaciones",
+	"welcome": "Bienvenido, ¡se iniciado correctamente!"
 }

modules/default/alert/translations/fr.json

@@ -0,0 +1,4 @@
+{
+	"sysTitle": "MagicMirror² Notification",
+	"welcome": "Bienvenue, le démarrage a été un succès!"
+}

modules/default/alert/translations/hu.json

@@ -1,4 +1,4 @@
 {
-  "sysTitle": "MagicMirror értesítés",
-  "welcome": "Üdvözöljük, indulás sikeres!"
+	"sysTitle": "MagicMirror² értesítés",
+	"welcome": "Üdvözöljük, indulás sikeres!"
 }

modules/default/alert/translations/nl.json

@@ -1,4 +1,4 @@
 {
-  "sysTitle": "MagicMirror Notificatie",
-  "welcome": "Welkom, Succesvol gestart!"
+	"sysTitle": "MagicMirror² Notificatie",
+	"welcome": "Welkom, Succesvol gestart!"
 }

modules/default/alert/translations/ru.json

@@ -1,4 +1,4 @@
 {
-  "sysTitle": "MagicMirror Уведомление",
-  "welcome": "Добро пожаловать, старт был успешным!"
+	"sysTitle": "MagicMirror² Уведомление",
+	"welcome": "Добро пожаловать, старт был успешным!"
 }

modules/default/calendar/README.md

@@ -1,96 +1,6 @@
 # Module: Calendar
-The `calendar` module is one of the default modules of the MagicMirror.
+
+The `calendar` module is one of the default modules of the MagicMirror².
 This module displays events from a public .ical calendar. It can combine multiple calendars.
-Note that calendars may not contain any entry before 1st January 1970, otherwise the calendar won't be displayed and the module will crash.
 
-## Using the module
-
-To use this module, add it to the modules array in the `config/config.js` file:
-````javascript
-modules: [
-	{
-		module: "calendar",
-		position: "top_left",	// This can be any of the regions. Best results in left or right regions.
-		config: {
-			// The config property is optional.
-			// If no config is set, an example calendar is shown.
-			// See 'Configuration options' for more information.
-		}
-	}
-]
-````
-
-## Configuration options
-
-The following properties can be configured:
-
-
-| Option                       | Description
-| ---------------------------- | -----------
-| `maximumEntries`             | The maximum number of events shown. / **Possible values:** `0` - `100` <br> **Default value:** `10`
-| `maximumNumberOfDays`        | The maximum number of days in the future. <br><br> **Default value:** `365`
-| `displaySymbol`              | Display a symbol in front of an entry. <br><br> **Possible values:** `true` or `false` <br> **Default value:** `true`
-| `defaultSymbol`              | The default symbol. <br><br> **Possible values:** See [Font Awsome](http://fontawesome.io/icons/) website. <br> **Default value:** `calendar`
-| `maxTitleLength`             | The maximum title length. <br><br> **Possible values:** `10` - `50` <br> **Default value:** `25`
-| `wrapEvents`                 | Wrap event titles to multiple lines. Breaks lines at the length defined by `maxTitleLength`. <br><br> **Possible values:** `true` or `false` <br> **Default value:** `false`
-| `fetchInterval`              | How often does the content needs to be fetched? (Milliseconds) <br><br> **Possible values:** `1000` - `86400000` <br> **Default value:** `300000` (5 minutes)
-| `animationSpeed`             | Speed of the update animation. (Milliseconds) <br><br> **Possible values:** `0` - `5000` <br> **Default value:** `2000` (2 seconds)
-| `fade`                       | Fade the future events to black. (Gradient) <br><br> **Possible values:** `true` or `false` <br> **Default value:** `true`
-| `fadePoint`                  | Where to start fade? <br><br> **Possible values:** `0` (top of the list) - `1` (bottom of list) <br> **Default value:** `0.25`
-| `tableClass`                  | Name of the classes issued from `main.css`. <br><br> **Possible values:** xsmall, small, medium, large, xlarge. <br> **Default value:** _small._
-| `calendars`                  | The list of calendars. <br><br> **Possible values:** An array, see _calendar configuration_ below. <br> **Default value:** _An example calendar._
-| `titleReplace`               | An object of textual replacements applied to the tile of the event. This allow to remove or replace certains words in the title. <br><br> **Example:** `{'Birthday of ' : '', 'foo':'bar'}` <br> **Default value:** `{	"De verjaardag van ": "", "'s birthday": ""	}`
-| `displayRepeatingCountTitle` | Show count title for yearly repeating events (e.g. "X. Birthday", "X. Anniversary") <br><br> **Possible values:** `true` or `false` <br> **Default value:** `false`
-| `dateFormat`                 | Format to use for the date of events (when using absolute dates) <br><br> **Possible values:** See [Moment.js formats](http://momentjs.com/docs/#/parsing/string-format/) <br> **Default value:** `MMM Do` (e.g. Jan 18th)
-| `fullDayEventDateFormat`     | Format to use for the date of full day events (when using absolute dates) <br><br> **Possible values:** See [Moment.js formats](http://momentjs.com/docs/#/parsing/string-format/) <br> **Default value:** `MMM Do` (e.g. Jan 18th)
-| `timeFormat`                 | Display event times as absolute dates, or relative time, or using absolute date headers with times for each event next to it <br><br> **Possible values:** `absolute` or `relative` or `dateheaders` <br> **Default value:** `relative`
-| `getRelative`                | How much time (in hours) should be left until calendar events start getting relative? <br><br> **Possible values:** `0` (events stay absolute) - `48` (48 hours before the event starts) <br> **Default value:** `6`
-| `urgency`                    | When using a timeFormat of `absolute`, the `urgency` setting allows you to display events within a specific time frame as `relative`. This allows events within a certain time frame to be displayed as relative (in xx days) while others are displayed as absolute dates <br><br> **Possible values:** a positive integer representing the number of days for which you want a relative date, for example `7` (for 7 days) <br><br> **Default value:** `7`
-| `broadcastEvents`            | If this property is set to true, the calendar will broadcast all the events to all other modules with the notification message: `CALENDAR_EVENTS`. The event objects are stored in an array and contain the following fields: `title`, `startDate`, `endDate`, `fullDayEvent`, `location` and `geo`. <br><br> **Possible values:** `true`, `false` <br><br> **Default value:** `true`
-| `hidePrivate`                | Hides private calendar events. <br><br> **Possible values:** `true` or `false` <br> **Default value:** `false`
-| `hideOngoing`                | Hides calendar events that have already started. <br><br> **Possible values:** `true` or `false` <br> **Default value:** `false`
-| `excludedEvents`             | An array of words / phrases from event titles that will be excluded from being shown. <br><br>Additionally advanced filter objects can be passed in. Below is the configuration for the advance filtering object.<br>**Required**<br>`filterBy` - string used to determine if filter is applied.<br>**Optional**<br>`until` - Time before an event to display it  Ex: [`'3 days'`, `'2 months'`, `'1 week'`]<br>`caseSensitive` - By default, excludedEvents are case insensitive, set this to true to enforce case sensitivity<br>`regex` - set to `true` if filterBy is a regex. For those not familiar with regex it is used for pattern matching, please see [here](https://regexr.com/) for more info.<br><br> **Example:** `['Birthday', 'Hide This Event', {filterBy: 'Payment', until: '6 days', caseSensitive: true}, {filterBy: '^[0-9]{1,}.*', regex: true}]` <br> **Default value:** `[]`
-
-### Calendar configuration
-
-The `calendars` property contains an array of the configured calendars.
-The `colored` property gives the option for an individual color for each calendar.
-The `coloredSymbolOnly` property will apply color to the symbol only, not the whole line. This is only applicable when `colored` is also enabled.
-
-#### Default value:
-````javascript
-config: {
-	colored: false,
-	coloredSymbolOnly: false,
-	calendars: [
-		{
-			url: 'http://www.calendarlabs.com/templates/ical/US-Holidays.ics',
-			symbol: 'calendar',
-			auth: {
-			    user: 'username',
-			    pass: 'superstrongpassword',
-			    method: 'basic'
-			}
-		},
-	],
-}
-````
-
-#### Calendar configuration options:
-| Option                | Description
-| --------------------- | -----------
-| `url`	                | The url of the calendar .ical. This property is required. <br><br> **Possible values:** Any public accessble .ical calendar.
-| `symbol`              | The symbol to show in front of an event. This property is optional. <br><br> **Possible values:** See [Font Awesome](http://fontawesome.io/icons/) website. To have multiple symbols you can define them in an array e.g. `["calendar", "plane"]`
-| `color`              | The font color of an event from this calendar. This property should be set if the config is set to colored: true. <br><br> **Possible values:** HEX, RGB or RGBA values (#efefef, rgb(242,242,242), rgba(242,242,242,0.5)).
-| `repeatingCountTitle`	| The count title for yearly repating events in this calendar.  <br><br> **Example:** `'Birthday'`
-| `maximumEntries`      | The maximum number of events shown.  Overrides global setting. **Possible values:** `0` - `100`
-| `maximumNumberOfDays` | The maximum number of days in the future.  Overrides global setting
-| `auth`                | The object containing options for authentication against the calendar.
-
-
-#### Calendar authentication options:
-| Option                | Description
-| --------------------- | -----------
-| `user`                | The username for HTTP authentication.
-| `pass`                | The password for HTTP authentication. (If you use Bearer authentication, this should be your BearerToken.)
-| `method`              | Which authentication method should be used. HTTP Basic, Digest and Bearer authentication methods are supported. Basic authentication is used by default if this option is omitted. **Possible values:** `digest`, `basic`, `bearer` **Default value:** `basic`
+For configuration options, please check the [MagicMirror² documentation](https://docs.magicmirror.builders/modules/calendar.html).

modules/default/calendar/calendar.css

@@ -1,15 +1,14 @@
 .calendar .symbol {
+  display: flex;
+  flex-direction: row;
+  justify-content: flex-end;
   padding-left: 0;
   padding-right: 10px;
-  font-size: 80%;
-  vertical-align: top;
+  font-size: var(--font-size-small);
 }
 
 .calendar .symbol span {
-  display: inline-block;
-  -ms-transform: translate(0, 2px); /* IE 9 */
-  -webkit-transform: translate(0, 2px); /* Safari */
-  transform: translate(0, 2px);
+  padding-top: 4px;
 }
 
 .calendar .title {

modules/default/calendar/calendarfetcher.js

@@ -1,379 +1,158 @@
-/* Magic Mirror
+/* MagicMirror²
  * Node Helper: Calendar - CalendarFetcher
  *
- * By Michael Teeuw http://michaelteeuw.nl
+ * By Michael Teeuw https://michaelteeuw.nl
  * MIT Licensed.
  */
+const CalendarUtils = require("./calendarutils");
+const Log = require("logger");
+const NodeHelper = require("node_helper");
+const ical = require("node-ical");
+const fetch = require("fetch");
+const digest = require("digest-fetch");
+const https = require("https");
 
-var ical = require("./vendor/ical.js");
-var moment = require("moment");
+/**
+ *
+ * @param {string} url The url of the calendar to fetch
+ * @param {number} reloadInterval Time in ms the calendar is fetched again
+ * @param {string[]} excludedEvents An array of words / phrases from event titles that will be excluded from being shown.
+ * @param {number} maximumEntries The maximum number of events fetched.
+ * @param {number} maximumNumberOfDays The maximum number of days an event should be in the future.
+ * @param {object} auth The object containing options for authentication against the calendar.
+ * @param {boolean} includePastEvents If true events from the past maximumNumberOfDays will be fetched too
+ * @param {boolean} selfSignedCert If true, the server certificate is not verified against the list of supplied CAs.
+ * @class
+ */
+const CalendarFetcher = function (url, reloadInterval, excludedEvents, maximumEntries, maximumNumberOfDays, auth, includePastEvents, selfSignedCert) {
+	let reloadTimer = null;
+	let events = [];
 
-var CalendarFetcher = function(url, reloadInterval, excludedEvents, maximumEntries, maximumNumberOfDays, auth) {
-	var self = this;
+	let fetchFailedCallback = function () {};
+	let eventsReceivedCallback = function () {};
 
-	var reloadTimer = null;
-	var events = [];
-
-	var fetchFailedCallback = function() {};
-	var eventsReceivedCallback = function() {};
-
-	/* fetchCalendar()
+	/**
 	 * Initiates calendar fetch.
 	 */
-	var fetchCalendar = function() {
-
+	const fetchCalendar = () => {
 		clearTimeout(reloadTimer);
 		reloadTimer = null;
-
-		nodeVersion = Number(process.version.match(/^v(\d+\.\d+)/)[1]);
-		var opts = {
-			headers: {
-				"User-Agent": "Mozilla/5.0 (Node.js "+ nodeVersion + ") MagicMirror/"  + global.version +  " (https://github.com/MichMich/MagicMirror/)"
-			}
+		const nodeVersion = Number(process.version.match(/^v(\d+\.\d+)/)[1]);
+		let fetcher = null;
+		let httpsAgent = null;
+		let headers = {
+			"User-Agent": "Mozilla/5.0 (Node.js " + nodeVersion + ") MagicMirror/" + global.version
 		};
 
+		if (selfSignedCert) {
+			httpsAgent = new https.Agent({
+				rejectUnauthorized: false
+			});
+		}
 		if (auth) {
-			if(auth.method === "bearer"){
-				opts.auth = {
-					bearer: auth.pass
-				}
-
-			}else{
-				opts.auth = {
-					user: auth.user,
-					pass: auth.pass
-				};
-
-				if(auth.method === "digest"){
-					opts.auth.sendImmediately = false;
-				}else{
-					opts.auth.sendImmediately = true;
-				}
+			if (auth.method === "bearer") {
+				headers.Authorization = "Bearer " + auth.pass;
+			} else if (auth.method === "digest") {
+				fetcher = new digest(auth.user, auth.pass).fetch(url, { headers: headers, agent: httpsAgent });
+			} else {
+				headers.Authorization = "Basic " + Buffer.from(auth.user + ":" + auth.pass).toString("base64");
 			}
 		}
+		if (fetcher === null) {
+			fetcher = fetch(url, { headers: headers, agent: httpsAgent });
+		}
 
-		ical.fromURL(url, opts, function(err, data) {
-			if (err) {
-				fetchFailedCallback(self, err);
+		fetcher
+			.then(NodeHelper.checkFetchStatus)
+			.then((response) => response.text())
+			.then((responseData) => {
+				let data = [];
+
+				try {
+					data = ical.parseICS(responseData);
+					Log.debug("parsed data=" + JSON.stringify(data));
+					events = CalendarUtils.filterEvents(data, {
+						excludedEvents,
+						includePastEvents,
+						maximumEntries,
+						maximumNumberOfDays
+					});
+				} catch (error) {
+					fetchFailedCallback(this, error);
+					scheduleTimer();
+					return;
+				}
+				this.broadcastEvents();
+				scheduleTimer();
+			})
+			.catch((error) => {
+				fetchFailedCallback(this, error);
 				scheduleTimer();
-				return;
-			}
-
-			// console.log(data);
-			newEvents = [];
-
-			var limitFunction = function(date, i) {return i < maximumEntries;};
-
-			var eventDate = function(event, time) {
-				return (event[time].length === 8) ? moment(event[time], "YYYYMMDD") : moment(new Date(event[time]));
-			};
-
-			for (var e in data) {
-				var event = data[e];
-				var now = new Date();
-				var today = moment().startOf("day").toDate();
-				var future = moment().startOf("day").add(maximumNumberOfDays, "days").subtract(1,"seconds").toDate(); // Subtract 1 second so that events that start on the middle of the night will not repeat.
-
-				// FIXME:
-				// Ugly fix to solve the facebook birthday issue.
-				// Otherwise, the recurring events only show the birthday for next year.
-				var isFacebookBirthday = false;
-				if (typeof event.uid !== "undefined") {
-					if (event.uid.indexOf("@facebook.com") !== -1) {
-						isFacebookBirthday = true;
-					}
-				}
-
-				if (event.type === "VEVENT") {
-
-					var startDate = eventDate(event, "start");
-					var endDate;
-					if (typeof event.end !== "undefined") {
-						endDate = eventDate(event, "end");
-					} else {
-						if (!isFacebookBirthday) {
-							endDate = startDate;
-						} else {
-							endDate = moment(startDate).add(1, "days");
-						}
-					}
-
-
-					// calculate the duration f the event for use with recurring events.
-					var duration = parseInt(endDate.format("x")) - parseInt(startDate.format("x"));
-
-					if (event.start.length === 8) {
-						startDate = startDate.startOf("day");
-					}
-
-					var title = "Event";
-					if (event.summary) {
-						title = (typeof event.summary.val !== "undefined") ? event.summary.val : event.summary;
-					} else if(event.description) {
-						title = event.description;
-					}
-
-					var excluded = false,
-						dateFilter = null;
-
-					for (var f in excludedEvents) {
-						var filter = excludedEvents[f],
-							testTitle = title.toLowerCase(),
-							until = null,
-							useRegex = false,
-							regexFlags = "g";
-
-						if (filter instanceof Object) {
-							if (typeof filter.until !== "undefined") {
-								until = filter.until;
-							}
-
-							if (typeof filter.regex !== "undefined") {
-								useRegex = filter.regex;
-							}
-
-							// If additional advanced filtering is added in, this section
-							// must remain last as we overwrite the filter object with the
-							// filterBy string
-							if (filter.caseSensitive) {
-								filter = filter.filterBy;
-								testTitle = title;
-							} else if (useRegex) {
-								filter = filter.filterBy;
-								testTitle = title;
-								regexFlags += "i";
-							} else {
-								filter = filter.filterBy.toLowerCase();
-							}
-						} else {
-							filter = filter.toLowerCase();
-						}
-
-						if (testTitleByFilter(testTitle, filter, useRegex, regexFlags)) {
-							if (until) {
-								dateFilter = until;
-							} else {
-								excluded = true;
-							}
-							break;
-						}
-					}
-
-					if (excluded) {
-						continue;
-					}
-
-					var location = event.location || false;
-					var geo = event.geo || false;
-					var description = event.description || false;
-
-					if (typeof event.rrule != "undefined" && !isFacebookBirthday) {
-						var rule = event.rrule;
-						var dates = rule.between(today, future, true, limitFunction);
-
-						for (var d in dates) {
-							startDate = moment(new Date(dates[d]));
-							endDate  = moment(parseInt(startDate.format("x")) + duration, "x");
-
-							if (timeFilterApplies(now, endDate, dateFilter)) {
-								continue;
-							}
-
-							if (endDate.format("x") > now) {
-								newEvents.push({
-									title: title,
-									startDate: startDate.format("x"),
-									endDate: endDate.format("x"),
-									fullDayEvent: isFullDayEvent(event),
-									class: event.class,
-									firstYear: event.start.getFullYear(),
-									location: location,
-									geo: geo,
-									description: description
-								});
-							}
-						}
-					} else {
-						// console.log("Single event ...");
-						// Single event.
-						var fullDayEvent = (isFacebookBirthday) ? true : isFullDayEvent(event);
-
-						if (!fullDayEvent && endDate < new Date()) {
-							//console.log("It's not a fullday event, and it is in the past. So skip: " + title);
-							continue;
-						}
-
-						if (fullDayEvent && endDate <= today) {
-							//console.log("It's a fullday event, and it is before today. So skip: " + title);
-							continue;
-						}
-
-						if (startDate > future) {
-							//console.log("It exceeds the maximumNumberOfDays limit. So skip: " + title);
-							continue;
-						}
-
-						if (timeFilterApplies(now, endDate, dateFilter)) {
-							continue;
-						}
-
-						// Every thing is good. Add it to the list.
-
-						newEvents.push({
-							title: title,
-							startDate: startDate.format("x"),
-							endDate: endDate.format("x"),
-							fullDayEvent: fullDayEvent,
-							class: event.class,
-							location: location,
-							geo: geo,
-							description: description
-						});
-
-					}
-				}
-			}
-
-			newEvents.sort(function(a, b) {
-				return a.startDate - b.startDate;
 			});
-
-			//console.log(newEvents);
-
-			events = newEvents.slice(0, maximumEntries);
-
-			self.broadcastEvents();
-			scheduleTimer();
-		});
 	};
 
-	/* scheduleTimer()
+	/**
 	 * Schedule the timer for the next update.
 	 */
-	var scheduleTimer = function() {
-		//console.log('Schedule update timer.');
+	const scheduleTimer = function () {
 		clearTimeout(reloadTimer);
-		reloadTimer = setTimeout(function() {
+		reloadTimer = setTimeout(function () {
 			fetchCalendar();
 		}, reloadInterval);
 	};
 
-	/* isFullDayEvent(event)
-	 * Checks if an event is a fullday event.
-	 *
-	 * argument event obejct - The event object to check.
-	 *
-	 * return bool - The event is a fullday event.
-	 */
-	var isFullDayEvent = function(event) {
-		if (event.start.length === 8) {
-			return true;
-		}
-
-		var start = event.start || 0;
-		var startDate = new Date(start);
-		var end = event.end || 0;
-
-		if (end - start === 24 * 60 * 60 * 1000 && startDate.getHours() === 0 && startDate.getMinutes() === 0) {
-			// Is 24 hours, and starts on the middle of the night.
-			return true;
-		}
-
-		return false;
-	};
-
-	/* timeFilterApplies()
-	 * Determines if the user defined time filter should apply
-	 *
-	 * argument now Date - Date object using previously created object for consistency
-	 * argument endDate Moment - Moment object representing the event end date
-	 * argument filter string - The time to subtract from the end date to determine if an event should be shown
-	 *
-	 * return bool - The event should be filtered out
-	 */
-	var timeFilterApplies = function(now, endDate, filter) {
-		if (filter) {
-			var until = filter.split(" "),
-				value = parseInt(until[0]),
-				increment = until[1].slice("-1") === "s" ? until[1] : until[1] + "s", // Massage the data for moment js
-				filterUntil = moment(endDate.format()).subtract(value, increment);
-
-			return now < filterUntil.format("x");
-		}
-
-		return false;
-	};
-
-	var testTitleByFilter = function (title, filter, useRegex, regexFlags) {
-		if (useRegex) {
-			// Assume if leading slash, there is also trailing slash
-			if (filter[0] === "/") {
-				// Strip leading and trailing slashes
-				filter = filter.substr(1).slice(0, -1);
-			}
-
-			filter = new RegExp(filter, regexFlags);
-
-			return filter.test(title);
-		} else {
-			return title.includes(filter);
-		}
-	}
-
 	/* public methods */
 
-	/* startFetch()
+	/**
 	 * Initiate fetchCalendar();
 	 */
-	this.startFetch = function() {
+	this.startFetch = function () {
 		fetchCalendar();
 	};
 
-	/* broadcastItems()
+	/**
 	 * Broadcast the existing events.
 	 */
-	this.broadcastEvents = function() {
-		//console.log('Broadcasting ' + events.length + ' events.');
-		eventsReceivedCallback(self);
+	this.broadcastEvents = function () {
+		Log.info("Calendar-Fetcher: Broadcasting " + events.length + " events.");
+		eventsReceivedCallback(this);
 	};
 
-	/* onReceive(callback)
+	/**
 	 * Sets the on success callback
 	 *
-	 * argument callback function - The on success callback.
+	 * @param {Function} callback The on success callback.
 	 */
-	this.onReceive = function(callback) {
+	this.onReceive = function (callback) {
 		eventsReceivedCallback = callback;
 	};
 
-	/* onError(callback)
+	/**
 	 * Sets the on error callback
 	 *
-	 * argument callback function - The on error callback.
+	 * @param {Function} callback The on error callback.
 	 */
-	this.onError = function(callback) {
+	this.onError = function (callback) {
 		fetchFailedCallback = callback;
 	};
 
-	/* url()
+	/**
 	 * Returns the url of this fetcher.
 	 *
-	 * return string - The url of this fetcher.
+	 * @returns {string} The url of this fetcher.
 	 */
-	this.url = function() {
+	this.url = function () {
 		return url;
 	};
 
-	/* events()
+	/**
 	 * Returns current available events for this fetcher.
 	 *
-	 * return array - The current available events for this fetcher.
+	 * @returns {object[]} The current available events for this fetcher.
 	 */
-	this.events = function() {
+	this.events = function () {
 		return events;
 	};
-
 };
 
-
 module.exports = CalendarFetcher;

modules/default/calendar/calendarutils.js

@@ -0,0 +1,613 @@
+/* MagicMirror²
+ * Calendar Util Methods
+ *
+ * By Michael Teeuw https://michaelteeuw.nl
+ * MIT Licensed.
+ */
+
+/**
+ * @external Moment
+ */
+const moment = require("moment");
+const path = require("path");
+const zoneTable = require(path.join(__dirname, "windowsZones.json"));
+const Log = require("../../../js/logger.js");
+
+const CalendarUtils = {
+	/**
+	 * Calculate the time correction, either dst/std or full day in cases where
+	 * utc time is day before plus offset
+	 *
+	 * @param {object} event the event which needs adjustement
+	 * @param {Date} date the date on which this event happens
+	 * @returns {number} the necessary adjustment in hours
+	 */
+	calculateTimezoneAdjustment: function (event, date) {
+		let adjustHours = 0;
+		// if a timezone was specified
+		if (!event.start.tz) {
+			Log.debug(" if no tz, guess based on now");
+			event.start.tz = moment.tz.guess();
+		}
+		Log.debug("initial tz=" + event.start.tz);
+
+		// if there is a start date specified
+		if (event.start.tz) {
+			// if this is a windows timezone
+			if (event.start.tz.includes(" ")) {
+				// use the lookup table to get theIANA name as moment and date don't know MS timezones
+				let tz = CalendarUtils.getIanaTZFromMS(event.start.tz);
+				Log.debug("corrected TZ=" + tz);
+				// watch out for unregistered windows timezone names
+				// if we had a successful lookup
+				if (tz) {
+					// change the timezone to the IANA name
+					event.start.tz = tz;
+					// Log.debug("corrected timezone="+event.start.tz)
+				}
+			}
+			Log.debug("corrected tz=" + event.start.tz);
+			let current_offset = 0; // offset  from TZ string or calculated
+			let mm = 0; // date with tz or offset
+			let start_offset = 0; // utc offset of created with tz
+			// if there is still an offset, lookup failed, use it
+			if (event.start.tz.startsWith("(")) {
+				const regex = /[+|-]\d*:\d*/;
+				const start_offsetString = event.start.tz.match(regex).toString().split(":");
+				let start_offset = parseInt(start_offsetString[0]);
+				start_offset *= event.start.tz[1] === "-" ? -1 : 1;
+				adjustHours = start_offset;
+				Log.debug("defined offset=" + start_offset + " hours");
+				current_offset = start_offset;
+				event.start.tz = "";
+				Log.debug("ical offset=" + current_offset + " date=" + date);
+				mm = moment(date);
+				let x = parseInt(moment(new Date()).utcOffset());
+				Log.debug("net mins=" + (current_offset * 60 - x));
+
+				mm = mm.add(x - current_offset * 60, "minutes");
+				adjustHours = (current_offset * 60 - x) / 60;
+				event.start = mm.toDate();
+				Log.debug("adjusted date=" + event.start);
+			} else {
+				// get the start time in that timezone
+				let es = moment(event.start);
+				// check for start date prior to start of daylight changing date
+				if (es.format("YYYY") < 2007) {
+					es.set("year", 2013); // if so, use a closer date
+				}
+				Log.debug("start date/time=" + es.toDate());
+				start_offset = moment.tz(es, event.start.tz).utcOffset();
+				Log.debug("start offset=" + start_offset);
+
+				Log.debug("start date/time w tz =" + moment.tz(moment(event.start), event.start.tz).toDate());
+
+				// get the specified date in that timezone
+				mm = moment.tz(moment(date), event.start.tz);
+				Log.debug("event date=" + mm.toDate());
+				current_offset = mm.utcOffset();
+			}
+			Log.debug("event offset=" + current_offset + " hour=" + mm.format("H") + " event date=" + mm.toDate());
+
+			// if the offset is greater than 0, east of london
+			if (current_offset !== start_offset) {
+				// big offset
+				Log.debug("offset");
+				let h = parseInt(mm.format("H"));
+				// check if the event time is less than the offset
+				if (h > 0 && h < Math.abs(current_offset) / 60) {
+					// if so, rrule created a wrong date (utc day, oops, with utc yesterday adjusted time)
+					// we need to fix that
+					//adjustHours = 24;
+					// Log.debug("adjusting date")
+				}
+				//-300 > -240
+				//if (Math.abs(current_offset) > Math.abs(start_offset)){
+				if (current_offset > start_offset) {
+					adjustHours -= 1;
+					Log.debug("adjust down 1 hour dst change");
+					//} else if (Math.abs(current_offset) < Math.abs(start_offset)) {
+				} else if (current_offset < start_offset) {
+					adjustHours += 1;
+					Log.debug("adjust up 1 hour dst change");
+				}
+			}
+		}
+		Log.debug("adjustHours=" + adjustHours);
+		return adjustHours;
+	},
+
+	/**
+	 * Filter the events from ical according to the given config
+	 *
+	 * @param {object} data the calendar data from ical
+	 * @param {object} config The configuration object
+	 * @returns {string[]} the filtered events
+	 */
+	filterEvents: function (data, config) {
+		const newEvents = [];
+
+		// limitFunction doesn't do much limiting, see comment re: the dates
+		// array in rrule section below as to why we need to do the filtering
+		// ourselves
+		const limitFunction = function (date, i) {
+			return true;
+		};
+
+		const eventDate = function (event, time) {
+			return CalendarUtils.isFullDayEvent(event) ? moment(event[time], "YYYYMMDD") : moment(new Date(event[time]));
+		};
+
+		Log.debug("There are " + Object.entries(data).length + " calendar entries.");
+		Object.entries(data).forEach(([key, event]) => {
+			Log.debug("Processing entry...");
+			const now = new Date();
+			const today = moment().startOf("day").toDate();
+			const future = moment().startOf("day").add(config.maximumNumberOfDays, "days").subtract(1, "seconds").toDate(); // Subtract 1 second so that events that start on the middle of the night will not repeat.
+			let past = today;
+
+			if (config.includePastEvents) {
+				past = moment().startOf("day").subtract(config.maximumNumberOfDays, "days").toDate();
+			}
+
+			// FIXME: Ugly fix to solve the facebook birthday issue.
+			// Otherwise, the recurring events only show the birthday for next year.
+			let isFacebookBirthday = false;
+			if (typeof event.uid !== "undefined") {
+				if (event.uid.indexOf("@facebook.com") !== -1) {
+					isFacebookBirthday = true;
+				}
+			}
+
+			if (event.type === "VEVENT") {
+				Log.debug("Event:\n" + JSON.stringify(event));
+				let startDate = eventDate(event, "start");
+				let endDate;
+
+				if (typeof event.end !== "undefined") {
+					endDate = eventDate(event, "end");
+				} else if (typeof event.duration !== "undefined") {
+					endDate = startDate.clone().add(moment.duration(event.duration));
+				} else {
+					if (!isFacebookBirthday) {
+						// make copy of start date, separate storage area
+						endDate = moment(startDate.format("x"), "x");
+					} else {
+						endDate = moment(startDate).add(1, "days");
+					}
+				}
+
+				Log.debug("start: " + startDate.toDate());
+				Log.debug("end:: " + endDate.toDate());
+
+				// Calculate the duration of the event for use with recurring events.
+				let duration = parseInt(endDate.format("x")) - parseInt(startDate.format("x"));
+				Log.debug("duration: " + duration);
+
+				// FIXME: Since the parsed json object from node-ical comes with time information
+				// this check could be removed (?)
+				if (event.start.length === 8) {
+					startDate = startDate.startOf("day");
+				}
+
+				const title = CalendarUtils.getTitleFromEvent(event);
+				Log.debug("title: " + title);
+
+				let excluded = false,
+					dateFilter = null;
+
+				for (let f in config.excludedEvents) {
+					let filter = config.excludedEvents[f],
+						testTitle = title.toLowerCase(),
+						until = null,
+						useRegex = false,
+						regexFlags = "g";
+
+					if (filter instanceof Object) {
+						if (typeof filter.until !== "undefined") {
+							until = filter.until;
+						}
+
+						if (typeof filter.regex !== "undefined") {
+							useRegex = filter.regex;
+						}
+
+						// If additional advanced filtering is added in, this section
+						// must remain last as we overwrite the filter object with the
+						// filterBy string
+						if (filter.caseSensitive) {
+							filter = filter.filterBy;
+							testTitle = title;
+						} else if (useRegex) {
+							filter = filter.filterBy;
+							testTitle = title;
+							regexFlags += "i";
+						} else {
+							filter = filter.filterBy.toLowerCase();
+						}
+					} else {
+						filter = filter.toLowerCase();
+					}
+
+					if (CalendarUtils.titleFilterApplies(testTitle, filter, useRegex, regexFlags)) {
+						if (until) {
+							dateFilter = until;
+						} else {
+							excluded = true;
+						}
+						break;
+					}
+				}
+
+				if (excluded) {
+					return;
+				}
+
+				const location = event.location || false;
+				const geo = event.geo || false;
+				const description = event.description || false;
+
+				if (typeof event.rrule !== "undefined" && event.rrule !== null && !isFacebookBirthday) {
+					const rule = event.rrule;
+					let addedEvents = 0;
+
+					const pastMoment = moment(past);
+					const futureMoment = moment(future);
+
+					// can cause problems with e.g. birthdays before 1900
+					if ((rule.options && rule.origOptions && rule.origOptions.dtstart && rule.origOptions.dtstart.getFullYear() < 1900) || (rule.options && rule.options.dtstart && rule.options.dtstart.getFullYear() < 1900)) {
+						rule.origOptions.dtstart.setYear(1900);
+						rule.options.dtstart.setYear(1900);
+					}
+
+					// For recurring events, get the set of start dates that fall within the range
+					// of dates we're looking for.
+					// kblankenship1989 - to fix issue #1798, converting all dates to locale time first, then converting back to UTC time
+					let pastLocal = 0;
+					let futureLocal = 0;
+					if (CalendarUtils.isFullDayEvent(event)) {
+						Log.debug("fullday");
+						// if full day event, only use the date part of the ranges
+						pastLocal = pastMoment.toDate();
+						futureLocal = futureMoment.toDate();
+
+						Log.debug("pastLocal: " + pastLocal);
+						Log.debug("futureLocal: " + futureLocal);
+					} else {
+						// if we want past events
+						if (config.includePastEvents) {
+							// use the calculated past time for the between from
+							pastLocal = pastMoment.toDate();
+						} else {
+							// otherwise use NOW.. cause we shouldn't use any before now
+							pastLocal = moment().toDate(); //now
+						}
+						futureLocal = futureMoment.toDate(); // future
+					}
+					Log.debug("Search for recurring events between: " + pastLocal + " and " + futureLocal);
+					const dates = rule.between(pastLocal, futureLocal, true, limitFunction);
+					Log.debug("Title: " + event.summary + ", with dates: " + JSON.stringify(dates));
+					// The "dates" array contains the set of dates within our desired date range range that are valid
+					// for the recurrence rule. *However*, it's possible for us to have a specific recurrence that
+					// had its date changed from outside the range to inside the range.  For the time being,
+					// we'll handle this by adding *all* recurrence entries into the set of dates that we check,
+					// because the logic below will filter out any recurrences that don't actually belong within
+					// our display range.
+					// Would be great if there was a better way to handle this.
+					Log.debug("event.recurrences: " + event.recurrences);
+					if (event.recurrences !== undefined) {
+						for (let r in event.recurrences) {
+							// Only add dates that weren't already in the range we added from the rrule so that
+							// we don"t double-add those events.
+							if (moment(new Date(r)).isBetween(pastMoment, futureMoment) !== true) {
+								dates.push(new Date(r));
+							}
+						}
+					}
+					// Loop through the set of date entries to see which recurrences should be added to our event list.
+					for (let d in dates) {
+						let date = dates[d];
+						// Remove the time information of each date by using its substring, using the following method:
+						// .toISOString().substring(0,10).
+						// since the date is given as ISOString with YYYY-MM-DDTHH:MM:SS.SSSZ
+						// (see https://momentjs.com/docs/#/displaying/as-iso-string/).
+						const dateKey = date.toISOString().substring(0, 10);
+						let curEvent = event;
+						let showRecurrence = true;
+
+						// Get the offset of today where we are processing
+						// This will be the correction, we need to apply.
+						let nowOffset = new Date().getTimezoneOffset();
+						// For full day events, the time might be off from RRULE/Luxon problem
+						// Get time zone offset of the rule calculated event
+						let dateoffset = date.getTimezoneOffset();
+
+						// Reduce the time by the following offset.
+						Log.debug(" recurring date is " + date + " offset is " + dateoffset);
+
+						let dh = moment(date).format("HH");
+						Log.debug(" recurring date is " + date + " offset is " + dateoffset / 60 + " Hour is " + dh);
+
+						if (CalendarUtils.isFullDayEvent(event)) {
+							Log.debug("Fullday");
+							// If the offset is negative (east of GMT), where the problem is
+							if (dateoffset < 0) {
+								if (dh < Math.abs(dateoffset / 60)) {
+									// if the rrule byweekday WAS explicitly set , correct it
+									// reduce the time by the offset
+									if (curEvent.rrule.origOptions.byweekday !== undefined) {
+										// Apply the correction to the date/time to get it UTC relative
+										date = new Date(date.getTime() - Math.abs(24 * 60) * 60000);
+									}
+									// the duration was calculated way back at the top before we could correct the start time..
+									// fix it for this event entry
+									//duration = 24 * 60 * 60 * 1000;
+									Log.debug("new recurring date1 fulldate is " + date);
+								}
+							} else {
+								// if the timezones are the same, correct date if needed
+								//if (event.start.tz === moment.tz.guess()) {
+								// if the date hour is less than the offset
+								if (24 - dh <= Math.abs(dateoffset / 60)) {
+									// if the rrule byweekday WAS explicitly set , correct it
+									if (curEvent.rrule.origOptions.byweekday !== undefined) {
+										// apply the correction to the date/time back to right day
+										date = new Date(date.getTime() + Math.abs(24 * 60) * 60000);
+									}
+									// the duration was calculated way back at the top before we could correct the start time..
+									// fix it for this event entry
+									//duration = 24 * 60 * 60 * 1000;
+									Log.debug("new recurring date2 fulldate is " + date);
+								}
+								//}
+							}
+						} else {
+							// not full day, but luxon can still screw up the date on the rule processing
+							// we need to correct the date to get back to the right event for
+							if (dateoffset < 0) {
+								// if the date hour is less than the offset
+								if (dh <= Math.abs(dateoffset / 60)) {
+									// if the rrule byweekday WAS explicitly set , correct it
+									if (curEvent.rrule.origOptions.byweekday !== undefined) {
+										// Reduce the time by t:
+										// Apply the correction to the date/time to get it UTC relative
+										date = new Date(date.getTime() - Math.abs(24 * 60) * 60000);
+									}
+									// the duration was calculated way back at the top before we could correct the start time..
+									// fix it for this event entry
+									//duration = 24 * 60 * 60 * 1000;
+									Log.debug("new recurring date1 is " + date);
+								}
+							} else {
+								// if the timezones are the same, correct date if needed
+								//if (event.start.tz === moment.tz.guess()) {
+								// if the date hour is less than the offset
+								if (24 - dh <= Math.abs(dateoffset / 60)) {
+									// if the rrule byweekday WAS explicitly set , correct it
+									if (curEvent.rrule.origOptions.byweekday !== undefined) {
+										// apply the correction to the date/time back to right day
+										date = new Date(date.getTime() + Math.abs(24 * 60) * 60000);
+									}
+									// the duration was calculated way back at the top before we could correct the start time..
+									// fix it for this event entry
+									//duration = 24 * 60 * 60 * 1000;
+									Log.debug("new recurring date2 is " + date);
+								}
+								//}
+							}
+						}
+						startDate = moment(date);
+						Log.debug("Corrected startDate: " + startDate.toDate());
+
+						let adjustDays = CalendarUtils.calculateTimezoneAdjustment(event, date);
+
+						// For each date that we're checking, it's possible that there is a recurrence override for that one day.
+						if (curEvent.recurrences !== undefined && curEvent.recurrences[dateKey] !== undefined) {
+							// We found an override, so for this recurrence, use a potentially different title, start date, and duration.
+							curEvent = curEvent.recurrences[dateKey];
+							startDate = moment(curEvent.start);
+							duration = parseInt(moment(curEvent.end).format("x")) - parseInt(startDate.format("x"));
+						}
+						// If there's no recurrence override, check for an exception date.  Exception dates represent exceptions to the rule.
+						else if (curEvent.exdate !== undefined && curEvent.exdate[dateKey] !== undefined) {
+							// This date is an exception date, which means we should skip it in the recurrence pattern.
+							showRecurrence = false;
+						}
+						Log.debug("duration: " + duration);
+
+						endDate = moment(parseInt(startDate.format("x")) + duration, "x");
+						if (startDate.format("x") === endDate.format("x")) {
+							endDate = endDate.endOf("day");
+						}
+
+						const recurrenceTitle = CalendarUtils.getTitleFromEvent(curEvent);
+
+						// If this recurrence ends before the start of the date range, or starts after the end of the date range, don"t add
+						// it to the event list.
+						if (endDate.isBefore(past) || startDate.isAfter(future)) {
+							showRecurrence = false;
+						}
+
+						if (CalendarUtils.timeFilterApplies(now, endDate, dateFilter)) {
+							showRecurrence = false;
+						}
+
+						if (showRecurrence === true) {
+							Log.debug("saving event: " + description);
+							addedEvents++;
+							newEvents.push({
+								title: recurrenceTitle,
+								startDate: (adjustDays ? (adjustDays > 0 ? startDate.add(adjustDays, "hours") : startDate.subtract(Math.abs(adjustDays), "hours")) : startDate).format("x"),
+								endDate: (adjustDays ? (adjustDays > 0 ? endDate.add(adjustDays, "hours") : endDate.subtract(Math.abs(adjustDays), "hours")) : endDate).format("x"),
+								fullDayEvent: CalendarUtils.isFullDayEvent(event),
+								recurringEvent: true,
+								class: event.class,
+								firstYear: event.start.getFullYear(),
+								location: location,
+								geo: geo,
+								description: description
+							});
+						}
+					}
+					// End recurring event parsing.
+				} else {
+					// Single event.
+					const fullDayEvent = isFacebookBirthday ? true : CalendarUtils.isFullDayEvent(event);
+					// Log.debug("full day event")
+
+					if (config.includePastEvents) {
+						// Past event is too far in the past, so skip.
+						if (endDate < past) {
+							return;
+						}
+					} else {
+						// It's not a fullday event, and it is in the past, so skip.
+						if (!fullDayEvent && endDate < new Date()) {
+							return;
+						}
+
+						// It's a fullday event, and it is before today, So skip.
+						if (fullDayEvent && endDate <= today) {
+							return;
+						}
+					}
+
+					// It exceeds the maximumNumberOfDays limit, so skip.
+					if (startDate > future) {
+						return;
+					}
+
+					if (CalendarUtils.timeFilterApplies(now, endDate, dateFilter)) {
+						return;
+					}
+
+					// if the start and end are the same, then make end the 'end of day' value (start is at 00:00:00)
+					if (fullDayEvent && startDate.format("x") === endDate.format("x")) {
+						endDate = endDate.endOf("day");
+					}
+					// get correction for date saving and dst change between now and then
+					let adjustDays = CalendarUtils.calculateTimezoneAdjustment(event, startDate.toDate());
+					// Every thing is good. Add it to the list.
+					newEvents.push({
+						title: title,
+						startDate: (adjustDays ? (adjustDays > 0 ? startDate.add(adjustDays, "hours") : startDate.subtract(Math.abs(adjustDays), "hours")) : startDate).format("x"),
+						endDate: (adjustDays ? (adjustDays > 0 ? endDate.add(adjustDays, "hours") : endDate.subtract(Math.abs(adjustDays), "hours")) : endDate).format("x"),
+						fullDayEvent: fullDayEvent,
+						class: event.class,
+						location: location,
+						geo: geo,
+						description: description
+					});
+				}
+			}
+		});
+
+		newEvents.sort(function (a, b) {
+			return a.startDate - b.startDate;
+		});
+
+		return newEvents;
+	},
+
+	/**
+	 * Lookup iana tz from windows
+	 *
+	 * @param {string} msTZName the timezone name to lookup
+	 * @returns {string|null} the iana name or null of none is found
+	 */
+	getIanaTZFromMS: function (msTZName) {
+		// Get hash entry
+		const he = zoneTable[msTZName];
+		// If found return iana name, else null
+		return he ? he.iana[0] : null;
+	},
+
+	/**
+	 * Gets the title from the event.
+	 *
+	 * @param {object} event The event object to check.
+	 * @returns {string} The title of the event, or "Event" if no title is found.
+	 */
+	getTitleFromEvent: function (event) {
+		let title = "Event";
+		if (event.summary) {
+			title = typeof event.summary.val !== "undefined" ? event.summary.val : event.summary;
+		} else if (event.description) {
+			title = event.description;
+		}
+
+		return title;
+	},
+
+	/**
+	 * Checks if an event is a fullday event.
+	 *
+	 * @param {object} event The event object to check.
+	 * @returns {boolean} True if the event is a fullday event, false otherwise
+	 */
+	isFullDayEvent: function (event) {
+		if (event.start.length === 8 || event.start.dateOnly || event.datetype === "date") {
+			return true;
+		}
+
+		const start = event.start || 0;
+		const startDate = new Date(start);
+		const end = event.end || 0;
+		if ((end - start) % (24 * 60 * 60 * 1000) === 0 && startDate.getHours() === 0 && startDate.getMinutes() === 0) {
+			// Is 24 hours, and starts on the middle of the night.
+			return true;
+		}
+
+		return false;
+	},
+
+	/**
+	 * Determines if the user defined time filter should apply
+	 *
+	 * @param {Date} now Date object using previously created object for consistency
+	 * @param {Moment} endDate Moment object representing the event end date
+	 * @param {string} filter The time to subtract from the end date to determine if an event should be shown
+	 * @returns {boolean} True if the event should be filtered out, false otherwise
+	 */
+	timeFilterApplies: function (now, endDate, filter) {
+		if (filter) {
+			const until = filter.split(" "),
+				value = parseInt(until[0]),
+				increment = until[1].slice(-1) === "s" ? until[1] : until[1] + "s", // Massage the data for moment js
+				filterUntil = moment(endDate.format()).subtract(value, increment);
+
+			return now < filterUntil.format("x");
+		}
+
+		return false;
+	},
+
+	/**
+	 * Determines if the user defined title filter should apply
+	 *
+	 * @param {string} title the title of the event
+	 * @param {string} filter the string to look for, can be a regex also
+	 * @param {boolean} useRegex true if a regex should be used, otherwise it just looks for the filter as a string
+	 * @param {string} regexFlags flags that should be applied to the regex
+	 * @returns {boolean} True if the title should be filtered out, false otherwise
+	 */
+	titleFilterApplies: function (title, filter, useRegex, regexFlags) {
+		if (useRegex) {
+			// Assume if leading slash, there is also trailing slash
+			if (filter[0] === "/") {
+				// Strip leading and trailing slashes
+				filter = filter.substr(1).slice(0, -1);
+			}
+
+			filter = new RegExp(filter, regexFlags);
+
+			return filter.test(title);
+		} else {
+			return title.includes(filter);
+		}
+	}
+};
+
+if (typeof module !== "undefined") {
+	module.exports = CalendarUtils;
+}

modules/default/calendar/debug.js

@@ -1,40 +1,43 @@
 /* CalendarFetcher Tester
  * use this script with `node debug.js` to test the fetcher without the need
- * of starting the MagicMirror core. Adjust the values below to your desire.
+ * of starting the MagicMirror² core. Adjust the values below to your desire.
  *
- * By Michael Teeuw http://michaelteeuw.nl
+ * By Michael Teeuw https://michaelteeuw.nl
  * MIT Licensed.
  */
+// Alias modules mentioned in package.js under _moduleAliases.
+require("module-alias/register");
 
-var CalendarFetcher = require("./calendarfetcher.js");
+const CalendarFetcher = require("./calendarfetcher.js");
 
-var url = "https://calendar.google.com/calendar/ical/pkm1t2uedjbp0uvq1o7oj1jouo%40group.calendar.google.com/private-08ba559f89eec70dd74bbd887d0a3598/basic.ics";  // Standard test URL
-// var url = "https://www.googleapis.com/calendar/v3/calendars/primary/events/"; // URL for Bearer auth (must be configured  in Google OAuth2 first)
-var fetchInterval = 60 * 60 * 1000;
-var maximumEntries = 10;
-var maximumNumberOfDays = 365;
-var user = "magicmirror";
-var pass = "MyStrongPass";
-
-var auth = {
+const url = "https://calendar.google.com/calendar/ical/pkm1t2uedjbp0uvq1o7oj1jouo%40group.calendar.google.com/private-08ba559f89eec70dd74bbd887d0a3598/basic.ics"; // Standard test URL
+//const url = "https://www.googleapis.com/calendar/v3/calendars/primary/events/"; // URL for Bearer auth (must be configured  in Google OAuth2 first)
+const fetchInterval = 60 * 60 * 1000;
+const maximumEntries = 10;
+const maximumNumberOfDays = 365;
+const user = "magicmirror";
+const pass = "MyStrongPass";
+const auth = {
 	user: user,
 	pass: pass
 };
 
 console.log("Create fetcher ...");
 
-fetcher = new CalendarFetcher(url, fetchInterval, maximumEntries, maximumNumberOfDays, auth);
+const fetcher = new CalendarFetcher(url, fetchInterval, [], maximumEntries, maximumNumberOfDays, auth);
 
-fetcher.onReceive(function(fetcher) {
+fetcher.onReceive(function (fetcher) {
 	console.log(fetcher.events());
 	console.log("------------------------------------------------------------");
+	process.exit(0);
 });
 
-fetcher.onError(function(fetcher, error) {
+fetcher.onError(function (fetcher, error) {
 	console.log("Fetcher error:");
 	console.log(error);
+	process.exit(1);
 });
 
 fetcher.startFetch();
 
-console.log("Create fetcher done! ");
+console.log("Create fetcher done! ");

modules/default/calendar/node_helper.js

@@ -1,78 +1,96 @@
-/* Magic Mirror
+/* MagicMirror²
  * Node Helper: Calendar
  *
- * By Michael Teeuw http://michaelteeuw.nl
+ * By Michael Teeuw https://michaelteeuw.nl
  * MIT Licensed.
  */
-
-var NodeHelper = require("node_helper");
-var validUrl = require("valid-url");
-var CalendarFetcher = require("./calendarfetcher.js");
+const NodeHelper = require("node_helper");
+const CalendarFetcher = require("./calendarfetcher.js");
+const Log = require("logger");
 
 module.exports = NodeHelper.create({
 	// Override start method.
-	start: function() {
-		var events = [];
-
+	start: function () {
+		Log.log("Starting node helper for: " + this.name);
 		this.fetchers = [];
-
-		console.log("Starting node helper for: " + this.name);
-
 	},
 
 	// Override socketNotificationReceived method.
-	socketNotificationReceived: function(notification, payload) {
+	socketNotificationReceived: function (notification, payload) {
 		if (notification === "ADD_CALENDAR") {
-			//console.log('ADD_CALENDAR: ');
-			this.createFetcher(payload.url, payload.fetchInterval, payload.excludedEvents, payload.maximumEntries, payload.maximumNumberOfDays, payload.auth);
+			this.createFetcher(payload.url, payload.fetchInterval, payload.excludedEvents, payload.maximumEntries, payload.maximumNumberOfDays, payload.auth, payload.broadcastPastEvents, payload.selfSignedCert, payload.id);
+		} else if (notification === "FETCH_CALENDAR") {
+			const key = payload.id + payload.url;
+			if (typeof this.fetchers[key] === "undefined") {
+				Log.error("Calendar Error. No fetcher exists with key: ", key);
+				this.sendSocketNotification("CALENDAR_ERROR", { error_type: "MODULE_ERROR_UNSPECIFIED" });
+				return;
+			}
+			this.fetchers[key].startFetch();
 		}
 	},
 
-	/* createFetcher(url, reloadInterval)
+	/**
 	 * Creates a fetcher for a new url if it doesn't exist yet.
 	 * Otherwise it reuses the existing one.
 	 *
-	 * attribute url string - URL of the news feed.
-	 * attribute reloadInterval number - Reload interval in milliseconds.
+	 * @param {string} url The url of the calendar
+	 * @param {number} fetchInterval How often does the calendar needs to be fetched in ms
+	 * @param {string[]} excludedEvents An array of words / phrases from event titles that will be excluded from being shown.
+	 * @param {number} maximumEntries The maximum number of events fetched.
+	 * @param {number} maximumNumberOfDays The maximum number of days an event should be in the future.
+	 * @param {object} auth The object containing options for authentication against the calendar.
+	 * @param {boolean} broadcastPastEvents If true events from the past maximumNumberOfDays will be included in event broadcasts
+	 * @param {boolean} selfSignedCert If true, the server certificate is not verified against the list of supplied CAs.
+	 * @param {string} identifier ID of the module
 	 */
-
-	createFetcher: function(url, fetchInterval, excludedEvents, maximumEntries, maximumNumberOfDays, auth) {
-		var self = this;
-
-		if (!validUrl.isUri(url)) {
-			self.sendSocketNotification("INCORRECT_URL", {url: url});
+	createFetcher: function (url, fetchInterval, excludedEvents, maximumEntries, maximumNumberOfDays, auth, broadcastPastEvents, selfSignedCert, identifier) {
+		try {
+			new URL(url);
+		} catch (error) {
+			Log.error("Calendar Error. Malformed calendar url: ", url, error);
+			this.sendSocketNotification("CALENDAR_ERROR", { error_type: "MODULE_ERROR_MALFORMED_URL" });
 			return;
 		}
 
-		var fetcher;
-		if (typeof self.fetchers[url] === "undefined") {
-			console.log("Create new calendar fetcher for url: " + url + " - Interval: " + fetchInterval);
-			fetcher = new CalendarFetcher(url, fetchInterval, excludedEvents, maximumEntries, maximumNumberOfDays, auth);
+		let fetcher;
+		if (typeof this.fetchers[identifier + url] === "undefined") {
+			Log.log("Create new calendarfetcher for url: " + url + " - Interval: " + fetchInterval);
+			fetcher = new CalendarFetcher(url, fetchInterval, excludedEvents, maximumEntries, maximumNumberOfDays, auth, broadcastPastEvents, selfSignedCert);
 
-			fetcher.onReceive(function(fetcher) {
-				//console.log('Broadcast events.');
-				//console.log(fetcher.events());
+			fetcher.onReceive((fetcher) => {
+				this.broadcastEvents(fetcher, identifier);
+			});
 
-				self.sendSocketNotification("CALENDAR_EVENTS", {
-					url: fetcher.url(),
-					events: fetcher.events()
+			fetcher.onError((fetcher, error) => {
+				Log.error("Calendar Error. Could not fetch calendar: ", fetcher.url(), error);
+				let error_type = NodeHelper.checkFetchError(error);
+				this.sendSocketNotification("CALENDAR_ERROR", {
+					id: identifier,
+					error_type
 				});
 			});
 
-			fetcher.onError(function(fetcher, error) {
-				self.sendSocketNotification("FETCH_ERROR", {
-					url: fetcher.url(),
-					error: error
-				});
-			});
-
-			self.fetchers[url] = fetcher;
+			this.fetchers[identifier + url] = fetcher;
 		} else {
-			//console.log('Use existing news fetcher for url: ' + url);
-			fetcher = self.fetchers[url];
+			Log.log("Use existing calendarfetcher for url: " + url);
+			fetcher = this.fetchers[identifier + url];
 			fetcher.broadcastEvents();
 		}
 
 		fetcher.startFetch();
+	},
+
+	/**
+	 *
+	 * @param {object} fetcher the fetcher associated with the calendar
+	 * @param {string} identifier the identifier of the calendar
+	 */
+	broadcastEvents: function (fetcher, identifier) {
+		this.sendSocketNotification("CALENDAR_EVENTS", {
+			id: identifier,
+			url: fetcher.url(),
+			events: fetcher.events()
+		});
 	}
 });

modules/default/calendar/vendor/ical.js/.travis.yml

@@ -1,6 +0,0 @@
-language: node_js
-node_js:
-    - "0.10"
-    - "0.12"
-    - "4.2"
-install: npm install 

modules/default/calendar/vendor/ical.js/LICENSE

@@ -1,178 +0,0 @@
-
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-

modules/default/calendar/vendor/ical.js/NOTICE

@@ -1,13 +0,0 @@
-Copyright 2012 Peter Braden
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.

modules/default/calendar/vendor/ical.js/example.js

@@ -1,13 +0,0 @@
-var ical = require('ical')
-  , months = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
-
-
-ical.fromURL('http://lanyrd.com/topics/nodejs/nodejs.ics', {}, function(err, data){
-  for (var k in data){
-    if (data.hasOwnProperty(k)){
-      var ev = data[k]
-      console.log("Conference", ev.summary, 'is in',  ev.location, 'on the', ev.start.getDate(), 'of', months[ev.start.getMonth()] );
-    }
-  }
-})
-

modules/default/calendar/vendor/ical.js/ical.js

@@ -1,319 +0,0 @@
-(function(name, definition) {
-
-/****************
- *  A tolerant, minimal icalendar parser
- *  (http://tools.ietf.org/html/rfc5545)
- *
- *  <peterbraden@peterbraden.co.uk>
- * **************/
-
-  if (typeof module !== 'undefined') {
-    module.exports = definition();
-  } else if (typeof define === 'function' && typeof define.amd === 'object'){
-    define(definition);
-  } else {
-    this[name] = definition();
-  }
-
-}('ical', function(){
-
-   // Unescape Text re RFC 4.3.11
-  var text = function(t){
-    t = t || "";
-    return (t
-      .replace(/\\\,/g, ',')
-      .replace(/\\\;/g, ';')
-      .replace(/\\[nN]/g, '\n')
-      .replace(/\\\\/g, '\\')
-    )
-  }
-
-  var parseParams = function(p){
-    var out = {}
-    for (var i = 0; i<p.length; i++){
-      if (p[i].indexOf('=') > -1){
-        var segs = p[i].split('=');
-        
-        out[segs[0]] = parseValue(segs.slice(1).join('='));
-        
-      }
-    }
-    return out || sp
-  }
-
-  var parseValue = function(val){
-    if ('TRUE' === val)
-      return true;
-    
-    if ('FALSE' === val)
-      return false;
-
-    var number = Number(val);
-    if (!isNaN(number))
-      return number;
-
-    return val;
-  }
-
-  var storeParam = function(name){
-    return function(val, params, curr){
-      var data;
-      if (params && params.length && !(params.length==1 && params[0]==='CHARSET=utf-8')){
-        data = {params:parseParams(params), val:text(val)}
-      }
-      else
-        data = text(val)
-
-      var current = curr[name];
-      if (Array.isArray(current)){
-        current.push(data);
-        return curr;
-      }
-
-      if (current != null){
-        curr[name] = [current, data];
-        return curr;
-      }
-
-      curr[name] = data;
-      return curr
-    }
-  }
-
-  var addTZ = function(dt, name, params){
-    var p = parseParams(params);
-
-    if (params && p){
-      dt[name].tz = p.TZID
-    }
-
-    return dt
-  }
-
-  var dateParam = function(name){
-    return function(val, params, curr){
-
-      // Store as string - worst case scenario
-      storeParam(name)(val, undefined, curr)
-
-      if (params && params[0] === "VALUE=DATE") {
-        // Just Date
-
-        var comps = /^(\d{4})(\d{2})(\d{2})$/.exec(val);
-        if (comps !== null) {
-          // No TZ info - assume same timezone as this computer
-          curr[name] = new Date(
-            comps[1],
-            parseInt(comps[2], 10)-1,
-            comps[3]
-          );
-
-          return addTZ(curr, name, params);
-        }
-      }
-
-
-      //typical RFC date-time format
-      var comps = /^(\d{4})(\d{2})(\d{2})T(\d{2})(\d{2})(\d{2})(Z)?$/.exec(val);
-      if (comps !== null) {
-        if (comps[7] == 'Z'){ // GMT
-          curr[name] = new Date(Date.UTC(
-            parseInt(comps[1], 10),
-            parseInt(comps[2], 10)-1,
-            parseInt(comps[3], 10),
-            parseInt(comps[4], 10),
-            parseInt(comps[5], 10),
-            parseInt(comps[6], 10 )
-          ));
-          // TODO add tz
-        } else {
-          curr[name] = new Date(
-            parseInt(comps[1], 10),
-            parseInt(comps[2], 10)-1,
-            parseInt(comps[3], 10),
-            parseInt(comps[4], 10),
-            parseInt(comps[5], 10),
-            parseInt(comps[6], 10)
-          );
-        }
-      }
-
-      return addTZ(curr, name, params)
-    }
-  }
-
-  var exdateParam = function(name){
-    return function(val, params, curr){
-      var date = dateParam(name)(val, params, curr);
-      if (date.exdates === undefined) {
-        date.exdates = [];
-      }
-      date.exdates.push(date.exdate);
-      return date;
-    }
-  }
-
-  var geoParam = function(name){
-    return function(val, params, curr){
-      storeParam(val, params, curr)
-      var parts = val.split(';');
-      curr[name] = {lat:Number(parts[0]), lon:Number(parts[1])};
-      return curr
-    }
-  }
-
-  var categoriesParam = function (name) {
-    var separatorPattern = /\s*,\s*/g;
-    return function (val, params, curr) {
-      storeParam(val, params, curr)
-      if (curr[name] === undefined)
-        curr[name] = val ? val.split(separatorPattern) : []
-      else
-        if (val)
-          curr[name] = curr[name].concat(val.split(separatorPattern))
-      return curr
-    }
-  }
-
-  var addFBType = function(fb, params){
-    var p = parseParams(params);
-
-    if (params && p){
-      fb.type = p.FBTYPE || "BUSY"
-    }
-
-    return fb;
-  }
-
-  var freebusyParam = function (name) {
-    return function(val, params, curr){
-      var fb = addFBType({}, params);
-      curr[name] = curr[name] || []
-      curr[name].push(fb);
-
-      storeParam(val, params, fb);
-
-      var parts = val.split('/');
-
-      ['start', 'end'].forEach(function (name, index) {
-        dateParam(name)(parts[index], params, fb);
-      });
-
-      return curr;
-    }
-  }
-
-  return {
-
-
-    objectHandlers : {
-      'BEGIN' : function(component, params, curr, stack){
-          stack.push(curr)
-
-          return {type:component, params:params}
-        }
-
-      , 'END' : function(component, params, curr, stack){
-        // prevents the need to search the root of the tree for the VCALENDAR object
-        if (component === "VCALENDAR") {
-            //scan all high level object in curr and drop all strings
-            var key,
-                obj;
-            
-            for (key in curr) {
-                if(curr.hasOwnProperty(key)) {
-                   obj = curr[key];
-                   if (typeof obj === 'string') {
-                       delete curr[key];
-                   }
-                }
-            }
-            
-            return curr
-        }
-        
-        var par = stack.pop()
-
-        if (curr.uid)
-          par[curr.uid] = curr
-        else
-          par[Math.random()*100000] = curr  // Randomly assign ID : TODO - use true GUID
-
-        return par
-      }
-
-      , 'SUMMARY' : storeParam('summary')
-      , 'DESCRIPTION' : storeParam('description')
-      , 'URL' : storeParam('url')
-      , 'UID' : storeParam('uid')
-      , 'LOCATION' : storeParam('location')
-      , 'DTSTART' : dateParam('start')
-      , 'DTEND' : dateParam('end')
-      , 'EXDATE' : exdateParam('exdate')
-      ,' CLASS' : storeParam('class')
-      , 'TRANSP' : storeParam('transparency')
-      , 'GEO' : geoParam('geo')
-      , 'PERCENT-COMPLETE': storeParam('completion')
-      , 'COMPLETED': dateParam('completed')
-      , 'CATEGORIES': categoriesParam('categories')
-      , 'FREEBUSY': freebusyParam('freebusy')
-    },
-
-
-    handleObject : function(name, val, params, ctx, stack, line){
-      var self = this
-
-      if(self.objectHandlers[name])
-        return self.objectHandlers[name](val, params, ctx, stack, line)
-
-      //handling custom properties
-      if(name.match(/X\-[\w\-]+/) && stack.length > 0) {
-          //trimming the leading and perform storeParam
-          name = name.substring(2);
-          return (storeParam(name))(val, params, ctx, stack, line);
-      }
-      
-      return storeParam(name.toLowerCase())(val, params, ctx);
-    },
-
-
-    parseICS : function(str){
-      var self = this
-      var lines = str.split(/\r?\n/)
-      var ctx = {}
-      var stack = []
-
-      for (var i = 0, ii = lines.length, l = lines[0]; i<ii; i++, l=lines[i]){
-        //Unfold : RFC#3.1
-        while (lines[i+1] && /[ \t]/.test(lines[i+1][0])) {
-          l += lines[i+1].slice(1)
-          i += 1
-        }
-
-        var kv = l.split(":")
-
-        if (kv.length < 2){
-          // Invalid line - must have k&v
-          continue;
-        }
-
-        // Although the spec says that vals with colons should be quote wrapped
-        // in practise nobody does, so we assume further colons are part of the
-        // val
-        var value = kv.slice(1).join(":")
-          , kp = kv[0].split(";")
-          , name = kp[0]
-          , params = kp.slice(1)
-
-        ctx = self.handleObject(name, value, params, ctx, stack, l) || {}
-      }
-
-       // type and params are added to the list of items, get rid of them.
-       delete ctx.type
-       delete ctx.params
-
-       return ctx
-    }
-
-  }
-}))

modules/default/calendar/vendor/ical.js/index.js

@@ -1,8 +0,0 @@
-module.exports = require('./ical')
-
-var node = require('./node-ical')
-
-// Copy node functions across to exports
-for (var i in node){
-  module.exports[i] = node[i]
-}  

modules/default/calendar/vendor/ical.js/node-ical.js

@@ -1,50 +0,0 @@
-var ical = require('./ical')
-  , request = require('request')
-  , fs = require('fs')
-
-exports.fromURL = function(url, opts, cb){
-  if (!cb)
-    return;
-  request(url, opts, function(err, r, data){
-    if (err)
-      return cb(err, null);
-    cb(undefined, ical.parseICS(data));
-  })
-}
-
-exports.parseFile = function(filename){
-  return ical.parseICS(fs.readFileSync(filename, 'utf8'))
-}
-
-
-var rrule = require('rrule-alt').RRule
-var rrulestr = rrule.rrulestr
-
-ical.objectHandlers['RRULE'] = function(val, params, curr, stack, line){
-  curr.rrule = line;
-  return curr
-}
-var originalEnd = ical.objectHandlers['END'];
-ical.objectHandlers['END'] = function(val, params, curr, stack){
-  if (curr.rrule) {
-    var rule = curr.rrule;
-    if (rule.indexOf('DTSTART') === -1) {
-
-      if (curr.start.length === 8) {
-        var comps = /^(\d{4})(\d{2})(\d{2})$/.exec(curr.start);
-        if (comps) {
-         curr.start = new Date (comps[1], comps[2] - 1, comps[3]);
-        }
-      }
-
-      rule += ' DTSTART:' + curr.start.toISOString().replace(/[-:]/g, '');
-      rule = rule.replace(/\.[0-9]{3}/, '');
-    }
-    for (var i in curr.exdates) {
-      rule += ' EXDATE:' + curr.exdates[i].toISOString().replace(/[-:]/g, '');
-      rule = rule.replace(/\.[0-9]{3}/, '');
-    }
-    curr.rrule = rrulestr(rule);
-  }
-  return originalEnd.call(this, val, params, curr, stack);
-}

modules/default/calendar/vendor/ical.js/package.json

@@ -1,28 +0,0 @@
-{
-  "name": "ical",
-  "version": "0.5.0",
-  "main": "index.js",
-  "description": "A tolerant, minimal icalendar parser",
-  "keywords": [
-    "ical",
-    "ics",
-    "calendar"
-  ],
-  "homepage": "https://github.com/peterbraden/ical.js",
-  "author": "Peter Braden <peterbraden@peterbraden.co.uk> (peterbraden.co.uk)",
-  "repository": {
-    "type": "git",
-    "url": "git://github.com/peterbraden/ical.js.git"
-  },
-  "dependencies": {
-    "request": "2.68.0",
-    "rrule": "2.0.0"
-  },
-  "devDependencies": {
-    "vows": "0.7.0",
-    "underscore": "1.3.0"
-  },
-  "scripts": {
-    "test": "./node_modules/vows/bin/vows ./test/test.js"
-  }
-}

modules/default/calendar/vendor/ical.js/readme.md

@@ -1,51 +0,0 @@
-# ical.js #
-(Formerly node-ical)
-
-[![Build Status](https://travis-ci.org/peterbraden/ical.js.png)](https://travis-ci.org/peterbraden/ical.js)
-
-A tolerant, minimal icalendar parser for javascript/node
-(http://tools.ietf.org/html/rfc5545)
-
-
-## Install - Node.js ##
-
-ical.js is availble on npm:
-
-    npm install ical
-
-
-
-## API ##
-
-    ical.parseICS(str)
-
-Parses a string with an ICS File
-
-    var data = ical.parseFile(filename)
-    
-Reads in the specified iCal file, parses it and returns the parsed data
-
-    ical.fromURL(url, options, function(err, data) {} )
-
-Use the request library to fetch the specified URL (```opts``` gets passed on to the ```request()``` call), and call the function with the result (either an error or the data).
-
-
-
-## Example 1 - Print list of upcoming node conferences (see example.js)
-```javascript
-    var ical = require('ical')
-  , months = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
-
-    ical.fromURL('http://lanyrd.com/topics/nodejs/nodejs.ics', {}, function(err, data) {
-      for (var k in data){
-        if (data.hasOwnProperty(k)) {
-          var ev = data[k]
-          console.log("Conference",
-            ev.summary,
-            'is in',
-            ev.location,
-            'on the', ev.start.getDate(), 'of', months[ev.start.getMonth()]);
-        }
-      }
-    });
-```

modules/default/calendar/vendor/ical.js/test/test.js

@@ -1,393 +0,0 @@
-/****
- * Tests
- *
- *
- ***/
-process.env.TZ = 'America/San_Francisco';
-var ical = require('../index')
-
-var vows = require('vows')
-  , assert = require('assert')
-  , _ = require('underscore')
-
-vows.describe('node-ical').addBatch({
-  'when parsing test1.ics (node conferences schedule from lanyrd.com, modified)': {
-        topic: function () {
-      return ical.parseFile('./test/test1.ics')
-    }
-
-    ,'we get 9 events': function (topic) {
-      var events = _.select(_.values(topic), function(x){ return x.type==='VEVENT'})
-            assert.equal (events.length, 9);
-        }
-
-    ,'event 47f6e' : {
-      topic: function(events){
-        return _.select(_.values(events),
-          function(x){
-            return x.uid ==='47f6ea3f28af2986a2192fa39a91fa7d60d26b76'})[0]
-      }
-      ,'is in fort lauderdale' : function(topic){
-        assert.equal(topic.location, "Fort Lauderdale, United States")
-      }
-      ,'starts Tue, 29 Nov 2011' : function(topic){
-        assert.equal(topic.start.toDateString(), new Date(2011,10,29).toDateString())
-      }
-    }
-    , 'event 480a' : {
-      topic: function(events){
-        return _.select(_.values(events),
-          function(x){
-            return x.uid ==='480a3ad48af5ed8965241f14920f90524f533c18'})[0]
-      }
-      , 'has a summary (invalid colon handling tolerance)' : function(topic){
-        assert.equal(topic.summary, '[Async]: Everything Express')
-      }
-    }
-    , 'event d4c8' :{
-      topic : function(events){
-        return _.select(_.values(events),
-            function(x){
-              return x.uid === 'd4c826dfb701f611416d69b4df81caf9ff80b03a'})[0]
-      }
-      , 'has a start datetime' : function(topic){
-        assert.equal(topic.start.toDateString(), new Date(Date.UTC(2011, 2, 12, 20, 0, 0)).toDateString())
-      }
-    }
-
-    , 'event sdfkf09fsd0 (Invalid Date)' :{
-      topic : function(events){
-        return _.select(_.values(events),
-            function(x){
-              return x.uid === 'sdfkf09fsd0'})[0]
-      }
-       , 'has a start datetime' : function(topic){
-          assert.equal(topic.start, "Next Year")
-        }
-    }
-  }
-  , 'with test2.ics (testing ical features)' : {
-    topic: function () {
-      return ical.parseFile('./test/test2.ics')
-    }
-    , 'todo item uid4@host1.com' : {
-      topic : function(items){
-        return items['uid4@host1.com']
-      }
-      , 'is a VTODO' : function(topic){
-        assert.equal(topic.type, 'VTODO')
-      }
-    }
-    , 'vfreebusy' : {
-      topic: function(events) {
-        return _.select(_.values(events), function(x) {
-          return x.type === 'VFREEBUSY';
-        })[0];
-      }
-      , 'has a URL' : function(topic) {
-        assert.equal(topic.url, 'http://www.host.com/calendar/busytime/jsmith.ifb');
-      }
-    }
-    , 'vfreebusy first freebusy' : {
-      topic: function(events) {
-        return _.select(_.values(events), function(x) {
-          return x.type === 'VFREEBUSY';
-        })[0].freebusy[0];
-      }
-      , 'has undefined type defaulting to busy' : function(topic) {
-        assert.equal(topic.type, "BUSY");
-      }
-      , 'has an start datetime' : function(topic) {
-        assert.equal(topic.start.getFullYear(), 1998);
-        assert.equal(topic.start.getUTCMonth(), 2);
-        assert.equal(topic.start.getUTCDate(), 14);
-        assert.equal(topic.start.getUTCHours(), 23);
-        assert.equal(topic.start.getUTCMinutes(), 30);
-      }
-      , 'has an end datetime' : function(topic) {
-        assert.equal(topic.end.getFullYear(), 1998);
-        assert.equal(topic.end.getUTCMonth(), 2);
-        assert.equal(topic.end.getUTCDate(), 15);
-        assert.equal(topic.end.getUTCHours(), 0);
-        assert.equal(topic.end.getUTCMinutes(), 30);
-      }
-    }
-  }
-  , 'with test3.ics (testing tvcountdown.com)' : {
-    topic: function() {
-      return ical.parseFile('./test/test3.ics');
-    }
-    , 'event -83' : {
-      topic: function(events) {
-        return _.select(_.values(events), function(x) {
-          return x.uid === '20110505T220000Z-83@tvcountdown.com';
-        })[0];
-      }
-      , 'has a start datetime' : function(topic) {
-        assert.equal(topic.start.getFullYear(), 2011);
-        assert.equal(topic.start.getMonth(), 4);
-      }
-      , 'has an end datetime' : function(topic) {
-        assert.equal(topic.end.getFullYear(), 2011);
-        assert.equal(topic.end.getMonth(), 4);
-      }
-    }
-  }
-
-  , 'with test4.ics (testing tripit.com)' : {
-    topic: function() {
-      return ical.parseFile('./test/test4.ics');
-    }
-    , 'event c32a5...' : {
-      topic: function(events) {
-        return _.select(_.values(events), function(x) {
-          return x.uid === 'c32a5eaba2354bb29e012ec18da827db90550a3b@tripit.com';
-        })[0];
-      }
-      , 'has a start datetime' : function(topic) {
-        assert.equal(topic.start.getFullYear(), 2011);
-        assert.equal(topic.start.getMonth(), 9);
-        assert.equal(topic.start.getDate(), 11);
-      }
-
-      , 'has a summary' : function(topic){
-        // escaped commas and semicolons should be replaced
-        assert.equal(topic.summary, 'South San Francisco, CA, October 2011;')
-
-      }
-
-      , 'has a description' : function(topic){
-        var desired = 'John Doe is in South San Francisco, CA from Oct 11 ' +
-         'to Oct 13, 2011\nView and/or edit details in TripIt : http://www.tripit.c' +
-         'om/trip/show/id/23710889\nTripIt - organize your travel at http://www.trip' +
-         'it.com\n'
-        assert.equal(topic.description, desired)
-
-      }
-
-      , 'has a geolocation' : function(topic){
-        assert.ok(topic.geo, 'no geo param')
-        assert.equal(topic.geo.lat, 37.654656)
-        assert.equal(topic.geo.lon, -122.40775)
-      }
-
-      , 'has transparency' : function(topic){
-        assert.equal(topic.transparency, 'TRANSPARENT')
-      }
-
-    }
-  }
-
-
-
-  , 'with test5.ics (testing meetup.com)' : {
-     topic: function () {
-        return ical.parseFile('./test/test5.ics')
-      }
-    , 'event nsmxnyppbfc@meetup.com' : {
-      topic: function(events) {
-        return _.select(_.values(events), function(x) {
-          return x.uid === 'event_nsmxnyppbfc@meetup.com';
-        })[0];
-      }
-      , 'has a start' : function(topic){
-        assert.equal(topic.start.tz, 'America/Phoenix')
-        assert.equal(topic.start.toISOString(), new Date(2011, 10, 9, 19, 0,0).toISOString())
-      }
-    }
-  }
-
-  , 'with test6.ics (testing assembly.org)' : {
-     topic: function () {
-        return ical.parseFile('./test/test6.ics')
-      }
-    , 'event with no ID' : {
-      topic: function(events) {
-        return _.select(_.values(events), function(x) {
-          return x.summary === 'foobar Summer 2011 starts!';
-        })[0];
-      }
-      , 'has a start' : function(topic){
-        assert.equal(topic.start.toISOString(), new Date(2011, 7, 4, 12, 0,0).toISOString())
-      }
-    }
-  , 'event with rrule' :{
-      topic: function(events){
-        return _.select(_.values(events), function(x){
-          return x.summary == "foobarTV broadcast starts"
-        })[0];
-      }
-      , "Has an RRULE": function(topic){
-        assert.notEqual(topic.rrule, undefined);
-      }
-      , "RRule text": function(topic){
-        assert.equal(topic.rrule.toText(), "every 5 weeks on Monday, Friday until January 30, 2013")
-      }
-    }
-  }
-   , 'with test7.ics (testing dtstart of rrule)' :{
-    topic: function() {
-        return ical.parseFile('./test/test7.ics');
-    },
-    'recurring yearly event (14 july)': {
-        topic: function(events){
-            var ev = _.values(events)[0];
-            return ev.rrule.between(new Date(2013, 0, 1), new Date(2014, 0, 1));
-        },
-        'dt start well set': function(topic) {
-            assert.equal(topic[0].toDateString(), new Date(2013, 6, 14).toDateString());
-        }
-    }
-  }
-  , "with test 8.ics (VTODO completion)": {
-    topic: function() {
-        return ical.parseFile('./test/test8.ics');
-    },
-    'grabbing VTODO task': {
-        topic: function(topic) {
-            return _.values(topic)[0];
-        },
-        'task completed': function(task){
-            assert.equal(task.completion, 100);
-            assert.equal(task.completed.toISOString(), new Date(2013, 6, 16, 10, 57, 45).toISOString());
-        }
-    }
-  }
-  , "with test 9.ics (VEVENT with VALARM)": {
-    topic: function() {
-        return ical.parseFile('./test/test9.ics');
-    },
-    'grabbing VEVENT task': {
-        topic: function(topic) {
-            return _.values(topic)[0];
-        },
-        'task completed': function(task){
-            assert.equal(task.summary, "Event with an alarm");
-        }
-    }
-  }
-  , 'with test 11.ics (VEVENT with custom properties)': {
-      topic: function() {
-          return ical.parseFile('./test10.ics');
-      },
-      'grabbing custom properties': {
-          topic: function(topic) {
-              
-          }
-      }
-  },
-
-  'with test10.ics': {
-    topic: function () {
-      return ical.parseFile('./test/test10.ics');
-    },
-
-    'when categories present': {
-      topic: function (t) {return _.values(t)[0]},
-
-      'should be a list': function (e) {
-        assert(e.categories instanceof [].constructor);
-      },
-
-      'should contain individual category values': function (e) {
-        assert.deepEqual(e.categories, ['cat1', 'cat2', 'cat3']);
-      }
-    },
-
-    'when categories present with trailing whitespace': {
-      topic: function (t) {return _.values(t)[1]},
-
-      'should contain individual category values without whitespace': function (e) {
-        assert.deepEqual(e.categories, ['cat1', 'cat2', 'cat3']);
-      }
-    },
-
-    'when categories present but empty': {
-      topic: function (t) {return _.values(t)[2]},
-
-      'should be an empty list': function (e) {
-        assert.deepEqual(e.categories, []);
-      }
-    },
-
-    'when categories present but singular': {
-      topic: function (t) {return _.values(t)[3]},
-
-      'should be a list of single item': function (e) {
-        assert.deepEqual(e.categories, ['lonely-cat']);
-      }
-    },
-
-    'when categories present on multiple lines': {
-      topic: function (t) {return _.values(t)[4]},
-
-      'should contain the category values in an array': function (e) {
-        assert.deepEqual(e.categories, ['cat1', 'cat2', 'cat3']);
-      }
-    }
-  },
-
-  'with test11.ics (testing zimbra freebusy)': {
-    topic: function () {
-      return ical.parseFile('./test/test11.ics');
-    },
-
-    'freebusy params' : {
-      topic: function(events) {
-        return _.values(events)[0];
-      }
-      , 'has a URL' : function(topic) {
-        assert.equal(topic.url, 'http://mail.example.com/yvr-2a@example.com/20140416');
-      }
-      , 'has an ORGANIZER' : function(topic) {
-        assert.equal(topic.organizer, 'mailto:yvr-2a@example.com');
-      }
-      , 'has an start datetime' : function(topic) {
-        assert.equal(topic.start.getFullYear(), 2014);
-        assert.equal(topic.start.getMonth(), 3);
-      }
-      , 'has an end datetime' : function(topic) {
-        assert.equal(topic.end.getFullYear(), 2014);
-        assert.equal(topic.end.getMonth(), 6);
-      }
-    }
-    , 'freebusy busy events' : {
-      topic: function(events) {
-        return _.select(_.values(events)[0].freebusy, function(x) {
-          return x.type === 'BUSY';
-        })[0];
-      }
-      , 'has an start datetime' : function(topic) {
-        assert.equal(topic.start.getFullYear(), 2014);
-        assert.equal(topic.start.getMonth(), 3);
-        assert.equal(topic.start.getUTCHours(), 15);
-        assert.equal(topic.start.getUTCMinutes(), 15);
-      }
-      , 'has an end datetime' : function(topic) {
-        assert.equal(topic.end.getFullYear(), 2014);
-        assert.equal(topic.end.getMonth(), 3);
-        assert.equal(topic.end.getUTCHours(), 19);
-        assert.equal(topic.end.getUTCMinutes(), 0);
-      }
-    }
-  },
-
-  'url request errors' : {
-    topic : function () {
-      ical.fromURL('http://not.exist/', {}, this.callback);
-    }
-    , 'are passed back to the callback' : function (err, result) {
-      assert.instanceOf(err, Error);
-      if (!err){
-        console.log(">E:", err, result)
-      }
-    }
-  }
-}).export(module)
-
-
-//ical.fromURL('http://lanyrd.com/topics/nodejs/nodejs.ics',
-//  {},
-//  function(err, data){
-//    console.log("OUT:", data)
-//  })