chore(build): update dependencies and documentation

Author: ThorstenSuckow

.gitignore

@@ -1,4 +1,3 @@
-/docs
 /build
 /.idea
 /node_modules

README.md

@@ -1,7 +1,8 @@
 ## @conjoon/extjs-dev-webmailsim ![MIT](https://img.shields.io/npm/l/@conjoon/extjs-dev-webmailsim) [![npm version](https://badge.fury.io/js/@conjoon%2Fextjs-dev-webmailsim.svg)](https://badge.fury.io/js/@conjoon%2Fextjs-dev-webmailsim)
 
-This Sencha ExtJS NPM package contains mock data for development of [conjoon/extjs-app-webmail](https://github.com/conjoon/extjs-app-webmail).
-When using this package, all backend requests of `extjs-app-webmail` will be replaced with mocks.
+This Sencha Ext JS NPM package contains mock data for development of [conjoon/extjs-app-webmail](https://github.com/conjoon/extjs-app-webmail).
+When using this package, configured urls will be intercepted and static data is returned in
+the responses.
 
 ## Installation
 ```bash
@@ -18,11 +19,9 @@ Testing environment will then be available via
 $ npm test
 ```
 
-For using the package as an external dependency in an application, use
-```bash
-$ npm install --save-prod @conjoon/extjs-dev-webmailsim
-```
-In your `app.json`, add this package as a requirement, and make sure your ExtJS `workspace.json`
+For using the package as an external dependency in an application:
+<br>
+In your `app.json`, add this package as a requirement, and make sure your Ext JS `workspace.json`
 is properly configured to look up local repositories in the `node_modules`-directory.
 
 Example (`workspace.json`) :
@@ -34,58 +33,32 @@ Example (`workspace.json`) :
   }
 }
 ```
-
-## Configuration options
-
-In order to properly intercept outgoing requests to the services as described in [rest-api-mail](https://github.com/conjoon/rest-api-description),,
-the package needs to be configured with a regular expression representing the urls to catch.
-The package is pre-configured so that it catches urls in the form of `https://php-ms-imapuser.ddev.site/rest-api-email/api/v0/*`.
-
-If this package is used in your development or production environment, intercepting urls can be enabled/disabled by changing 
-the property `enabled` of each url to either `true` or `false`. 
-<br>Network latency for the mocked requests can be mimicked with the `delay`-option (in milliseconds).
-
-
-- `attachment.url`
-- `attachment.enabled`
-- `attachment.delay`
-  <br><br>  
-- `messageItem.url`
-- `messageItem.enabled`
-- `messageItem.delay`
-  <br><br>
-- `mailFolder.url`
-- `mailFolder.enabled`
-- `mailFolder.delay`
-  <br><br>
-- `mailAccount.url`
-- `mailAccount.enabled`
-- `mailAccount.delay`
-  <br><br>
-- `sendMessage.url`
-- `sendMessage.enabled`
-- `sendMessage.delay`
-
-## Usage
-Simply update the app.json of the **conjoon**-application
-by specifying this package in the `uses`-property in either the `development` and/or `prodution` section:
+Update the `app.json` of the application by specifying this package in the `uses`-property in
+either the `development` and/or `prodution` section:
 
 *Example:*
 ```json
 {
     "development": {
         "uses": [
-            "extjs-app-webmail",
+            "extjs-dev-imapusersim",
             "extjs-app-imapuser",
-            "extjs-dev-webmailsim",
-            "extjs-dev-imapusersim"
+            "extjs-app-webmail",
+            "extjs-dev-webmailsim"
         ]
     },
     "production": {
         "uses": [
-            "extjs-app-webmail",
-            "extjs-app-imapuser"
+            "extjs-app-imapuser",
+            "extjs-app-webmail"
         ]
     }
 }
 ```
+
+
+## Configuration and Usage
+For more information on how to configure and use the package, refer to the [documentation](./docs/README.md).
+
+## Tests
+Tests are written with [Siesta](https://bryntum.com/siesta). Documentation can be found [here](./tests/README.md).

docs/README.md

@@ -0,0 +1,94 @@
+# @conjoon/extjs-dev-webmailsim Documentation
+
+**extjs-dev-webmailsim** is a **coon.js** package and is tagged as such in the
+`package.json`:
+
+```json
+{
+  "coon-js": {
+    "package": {
+      "autoLoad":  {
+        "registerController": true
+      },
+      "config" : "${package.resourcePath}/extjs-dev-webmailsim.conf.json"
+    }
+  }
+}
+```
+
+By default, this package's configuration can be found in this package's `resources` folder
+in a file named `extjs-dev-webmailsim.conf.json`.
+
+## What goes into a `extjs-dev-webmailsim` configuration?
+
+The package intercepts outgoing network requests to all urls matching a specific
+url-pattern. Additionally, you can configure whether the package's url intercepting should
+be enabled or disabled - this makes it easier to use this package in environments where
+you have to test for fully functional network behavior with real HTTP-requests and live- and mock-data should be used side-by-side.
+
+The configuration file for this package has various entries representing entities and their endpoints:
+`mailAccount`, `mailFolder`, `messageItem` and `attachment`:
+
+```json
+{
+  "attachment": {
+    "url": "https://ddev-ms-email.ddev.site/rest-api-email/api/v.*?/MailAccounts/(.+)/MailFolders/(.+)/MessageItems/(.+)/Attachments(/.*)?",
+    "enabled": true,
+    "delay": 250
+  },
+  "messageItem": {
+    "url": "https://ddev-ms-email.ddev.site/rest-api-email/api/v.*?/MailAccounts/(.+)/MailFolders/(.+)/MessageItems(/.*)?",
+    "enabled": true,
+    "delay": 250
+  },
+  "mailFolder": {
+    "url": "https://ddev-ms-email.ddev.site/rest-api-email/api/v.*?/MailAccounts/(.+)/MailFolders(/.*)?",
+    "enabled": true,
+    "delay": 250
+  },
+  "mailAccount": {
+    "url": "https://ddev-ms-email.ddev.site/rest-api-email/api/v.*?/MailAccounts(/d+)?",
+    "enabled": true,
+    "delay": 250
+  }
+}
+```
+Each entry in the configuration can be configured with 
+
+- `url` - In order to properly intercept outgoing requests to the services as described in
+  [rest-api-mail](https://github.com/conjoon/rest-api-description), the package needs 
+  to be configured with various regular expressions representing urls to catch.
+  The package is pre-configured. For example, HTTP-requests to the following URLs are intercepted by this package:
+   - `https://dev-ms-email.ddev.site/rest-api-email/api/v0/MailAccounts`
+   - `https://dev-ms-email.ddev.site/rest-api-email/api/v1/MailAccounts/dev/MailFolders/INBOX.Sent/MessageItems/123`
+
+- `enabled` - If this package is used with your development or production environment, intercepting urls can be enabled/disabled by changing the property `enabled`
+  to either `true` or `false`.
+- `delay` - the delay in milliseconds to mimic network latency
+
+### Order of matching URLs
+The Simmanager will consider url-matching in the order the urls are configured.
+Make sure more specific regular expressions are defined first, followed by more common ones.
+
+For example, the url `https://dev-ms-email.ddev.site/rest-api-email/api/v1/MailAccounts/dev/MailFolders/INBOX.Sent/MessageItems/123`
+would be intercepted by the regular expression defined with `mailFolder` (because it is defined _at first_), although it should be intercepted by `messageItem`:
+
+```json
+{
+  "mailFolder": {
+    "url": "https://ddev-ms-email.ddev.site/rest-api-email/api/v.*?/MailAccounts/(.+)/MailFolders(/.*)?",
+    "enabled": true,
+    "delay": 250
+  },
+  "messageItem": {
+    "url": "https://ddev-ms-email.ddev.site/rest-api-email/api/v.*?/MailAccounts/(.+)/MailFolders/(.+)/MessageItems(/.*)?",
+    "enabled": true,
+    "delay": 250
+  }
+}  
+```
+
+## Response Data
+If a request was intercepted, static data is returned to mimic responses of backends
+implementing the [REST API](https://github.com/conjoon/rest-api-description). The data returned
+can be edited in this package's `src/data/table/MessageTable.js` and `src/data/table/AttachmentTable.js`.