refactor!: Typescript refactoring, separate services, custom methods and vitepress docs (#164)

* refactor: typescript minimum valuable product

* refactor: move to typescript
- complete typing
- update dependencies
- semistandard -> eslint-typescript
- start converting tests to typescript
- ref #144

* test: add typings to tests and fix some bugs
- identityChange had no 'field' property
- tests fixes

* refactor: start seperate services
- add passwordField to options
- propper typing

* test: make nyc report working again

* refactor: move to seperate services
- call seperate services from main service

* docs: add description to service calls

* refactor: add better IDE-support
- destructure create-data for better IDE support
- move AuthenticationManagementService to seperate file

* docs: init vuepress

* refactor: remove `field` parameter
- completely move `passwordField` to options

* feat: separate services
- Base class with publish-prevention
- `useSeparateServicePaths` option
-  use internal service.options instead of create({ action: 'options' })
- add tests for publish
- add tests for `useSeparateServicePaths`
- more typings

* modify client authenticate

* docs: add hooks docs

* small changes
- export defaultOptions -> addVerification - path
- rearrange useSeparateServices

* several improvements
- divide Service & configure functions
- ensure options per Service
- types: better types
- chore: update dependencies
- tests: add tests for separate services
- tests: increase about-time to 600

* small changes
- better typing (abstract _create with type)
- sort actions alphabetically

* docs: improvements
- overview page
- started services page

* docs: add example

* chore: rename folder "service" to "services"

* docs: continue docs

* feat: prepare for custom methods from feathers^5

* chore: expose services at root

* docs(chore): move vuepress to vitepress

* refactor: move methods to seperate folder

* docs: align with PR from rma4ok

* refactor: add custom methods without '_'
- refactor: add import type where necessary
- refactor: add newlines for function params
- refactor: destructure imports

* port #167 to typescript

* test: fix basicSpy 'this' on function

* chore: update dependencies

* chore: major update dependencies & remove unnecessary packages

* refactor: move defaultOptions to own file
- refactor: rename configureAuth to setupAuth

* refactor(methods): Promise.all tokens

* types: add GetUserDataCheckProps

* perf(addVerification): move promise down

* perf(checkUnique): add pagination

* refactor(methods): add $limit: 2 to find

* test: chore - rename titles '.js' to '.ts'

* chore: isDateAfterNow helper to helpers/index

* test: add tests for helpers

* refactor(test): reorganize test-files
- move to test/hooks
- move to test/methods
- rename test/helpers to test/test-helpers

* fix: typo identityChange

* tests: test authMgmt/create, /[method], separate service
- refactor: remove chai
- refactor: move many try-catch
- refactor: users
- refactor: use [idType]

* chore: min-version node@10
- remove chai
- npm update

* test: chore - rename tests & move idType

* re-structures docs and adds new Getting Started

* adds new overview and configuration chapters

* addschapters process flows and service calls

* after docs text review

* !feat: remove 'useSeparateServices'

* refactor: rename 'configure' to 'setup'

* test: add custom path test to 'add-verification'

* chore: move npmignore to package.files
- remove babel
- update badges in readme
- update license year

* chore: npm update

* !refactor: app as first argument for constructor
- BREAKING CHANGE

* fix: NotifierOptions type

* extended regarding feedback

* refactor: remove swagger docs from constructor

* docs: vuepress@next, improve service calls
- move from vitepress to vuepress@next for <CodeGroup>
- add logo
- remove note about 'docs' of swagger
- remove 'prefferedComm' because it's not used anywhere
- improve `multi:true` on users-hooks

* test: ensure exported members

* docs: remove old stuff

* chore: lint --fix

* docs: add note to pre-release

* !refactor: remove 'value' from custom methods & separate services
- BREAKING CHANGE

* fix: VerifyChanges

* 4.0.0-pre.0

* Updating changelog

* docs: add pre tag to install script

* docs: add feathers-mailer to install script

* docs: fix typo

* docs: add options to service calls

* docs: fix getting-started

* feat: add multi support for 'add-verification' hook

* docs: add vue example to example folder

* fix(client): improve client and export in entry file

* refactor: rename and export helpers

* docs: add descriptions to type options

* docs: center images

* docs: comment out stuff in service calls

* chore: increase codeclimate thresholds

* chore: eslintignore examples

* 4.0.0-pre.1

* Updating changelog

* docs: init migration guide

* docs: migration guide add channels note

* docs: update notifier example

* docs: add search

* docs: add note to 'isVerified' about authenticate before

* docs: fix preventChanges first param

* chore: shrink helpers-folder

* chore: clean test setup

* refactor: more declarative methods, $limit: 2 & passwordField
- rename user1, user2, user3 to declarative names
- use $limit: 2 everywhere
- use [passwordField] consequently

* chore: update dependencies & import/order

* chore: remove eslint-config-standard

* ci: update coverage action to v3

* chore: update dependencies

* chore: change feathers contributors as author

* 4.0.0-pre.2

* Updating changelog

* docs: move to vitepress

* docs: move to Tabs and dismiss CodeGroup

* docs: fix primary color

* ci: add node v18 to matrix

Co-authored-by: Onno Gabriel <contact@datacodedesign.de>

Author: fratzinger

.babelrc

@@ -4,7 +4,7 @@ plugins:
 checks:
   argument-count:
     config:
-      threshold: 4
+      threshold: 5
   complex-logic:
     config:
       threshold: 4
@@ -19,7 +19,7 @@ checks:
       threshold: 20
   method-lines:
     config:
-      threshold: 50
+      threshold: 100
   nested-control-flow:
     config:
       threshold: 4
@@ -30,3 +30,7 @@ checks:
     enabled: false
   identical-code:
     enabled: false
+
+exclude_patterns:
+- "examples"
+- "test"

.codeclimate.yml

@@ -0,0 +1,9 @@
+# don't ever lint node_modules
+node_modules
+# don't lint build output (make sure it's set to your correct build folder name)
+dist
+# don't lint nyc coverage output
+coverage
+
+test/
+examples/

.eslintignore

@@ -0,0 +1,38 @@
+{
+  "root": true,
+  "env": {
+    "node": true,
+    "mocha": true
+  },
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "project": "./tsconfig.json"
+  },
+  "plugins": [
+    "@typescript-eslint"
+  ],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:import/recommended",
+    "plugin:import/typescript"
+  ],
+  "rules": {
+    "semi": ["warn", "always"],
+    "@typescript-eslint/semi": ["warn", "always"],
+    "@typescript-eslint/strict-boolean-expressions": ["off"],
+    "spaced-comment": ["off"],
+    "@typescript-eslint/consistent-type-imports": ["warn", { "prefer": "type-imports" }],
+    // import
+    "import/order": ["warn", { "groups": ["builtin", "external", "internal", "parent", "sibling", "index", "object", "type"] }],
+    "import/no-duplicates": ["warn"]
+  },
+  "overrides": [
+    {
+      "files": ["test/**/*.ts"],
+      "rules": {
+        "@typescript-eslint/ban-ts-comment": ["off"]
+      }
+    }
+  ]
+}

.eslintrc

@@ -10,13 +10,13 @@ Before creating an issue please make sure you have checked out the docs, specifi
 
 If you haven't found your answer please feel free to join our [slack channel](http://slack.feathersjs.com), create an issue on Github, or post on [Stackoverflow](http://stackoverflow.com) using the `feathers` or `feathersjs` tag. We try our best to monitor Stackoverflow but you're likely to get more immediate responses in Slack and Github.
 
-Issues can be reported in the [issue tracker](https://github.com/feathersjs/feathers/issues).  Since feathers combines many modules it can be hard for us to assess the root cause without knowing which modules are being used and what your configuration looks like, so **it helps us immensely if you can link to a simple example that reproduces your issue**.
+Issues can be reported in the [issue tracker](https://github.com/feathersjs/feathers/issues). Since feathers combines many modules it can be hard for us to assess the root cause without knowing which modules are being used and what your configuration looks like, so **it helps us immensely if you can link to a simple example that reproduces your issue**.
 
 ## Report a Security Concern
 
 We take security very seriously at Feathers. We welcome any peer review of our 100% open source code to ensure nobody's Feathers app is ever compromised or hacked. As a web application developer you are responsible for any security breaches. We do our very best to make sure Feathers is as secure as possible by default.
 
-In order to give the community time to respond and upgrade we strongly urge you report all security issues to us. Send one of the core team members a PM in [Slack](http://slack.feathersjs.com) or email us at hello@feathersjs.com with details and we will respond ASAP.
+In order to give the community time to respond and upgrade we strongly urge you report all security issues to us. Send one of the core team members a PM in [Slack](http://slack.feathersjs.com) or e-mail us at hello@feathersjs.com with details and we will respond ASAP.
 
 For full details refer to our [Security docs](https://docs.feathersjs.com/SECURITY.html).
 
@@ -34,14 +34,6 @@ Although we generally accept many PRs they can be rejected for many reasons. We
 
 Before running the tests from the `test/` folder `npm test` will run ESlint. You can check your code changes individually by running `npm run lint`.
 
-### ES6 compilation
-
-Feathers uses [Babel](https://babeljs.io/) to leverage the latest developments of the JavaScript language. All code and samples are currently written in ES2015. To transpile the code in this repository run
-
-> npm run compile
-
-__Note:__ `npm test` will run the compilation automatically before the tests.
-
 ### Tests
 
 [Mocha](http://mochajs.org/) tests are located in the `test/` folder and can be run using the `npm run mocha` or `npm test` (with ESLint and code coverage) command.

.github/contributing.md

@@ -3,19 +3,14 @@
 
 name: Node.js CI
 
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
+on: [push, pull_request]
 
 jobs:
   test:
     runs-on: ubuntu-latest
-
     strategy:
       matrix:
-        node-version: [12.x, 14.x]
+        node-version: [12.x, 14.x, 16.x, 18.x]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:
@@ -26,6 +21,7 @@ jobs:
         node-version: ${{ matrix.node-version }}
     - run: npm ci
     - run: npm test
+
   coverage:
     needs: [ test ]
     name: coverage
@@ -34,10 +30,10 @@ jobs:
     - uses: actions/checkout@master
     - uses: actions/setup-node@master
       with:
-        node-version: '12'
-    - run: npm i
-    - uses: paambaati/codeclimate-action@v2.7.5
+        node-version: '14'
+    - run: npm ci
+    - uses: paambaati/codeclimate-action@v3.0.0
       env:
         CC_TEST_REPORTER_ID: ac461a4a35fe5e70a011b20969f4298ad55da3498f1efbe0019d2bc3b99cf885
       with:
-        coverageCommand: npm run test
+        coverageCommand: npm run coverage

.github/workflows/node.js.yml

@@ -32,10 +32,13 @@ node_modules
 .lock-wscript
 
 # The compiled/babelified modules
-lib/
+dist/
 
 ## editor
 .idea/
 
-.vscode/
-.prettierrc
+#.vscode/
+.prettierrc
+
+docs/.vuepress/.cache
+docs/.vuepress/.temp

.gitignore

@@ -0,0 +1,12 @@
+'use strict';
+const path = require("path");
+
+module.exports = {
+  extension: ["ts", "js"],
+  package: path.join(__dirname, "./package.json"),
+  ui: "bdd",
+  spec: [
+    "./test/**/*.test.*",
+  ],
+  exit: true
+};

.mocharc.js

@@ -0,0 +1 @@
+v16.15.1