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 <[email protected]>

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 [email protected] 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 [email protected] 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

.npmignore

@@ -1,5 +1,15 @@
 {
 	"all": true,
-	"include": ["src/**/*.js"],
+	"include": [
+    "src/**/*.js",
+    "src/**/*.ts"
+  ],
+  "exclude": [
+    "coverage/**",
+    "node_modules/**",
+    "**/*.d.ts",
+    "**/*.test.ts"
+  ],
+  "sourceMap": true,
 	"reporter": ["text", "html", "lcov"]
-}
+}

.nvmrc

@@ -0,0 +1,32 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "pwa-node",
+      "resolveSourceMapLocations": [
+        "${workspaceFolder}/**",
+        "!**/node_modules/**"
+      ],
+      "request": "launch",
+      "name": "Mocha Tests",
+      "program": "${workspaceFolder}/node_modules/mocha/bin/mocha",
+      "args": [
+        "--require",
+        "ts-node/register",
+        "--timeout",
+        "999999",
+        "--colors",
+        "--recursive"
+      ],
+      "internalConsoleOptions": "openOnSessionStart",
+      "env": {
+        "NODE_ENV": "test",
+        "TS_NODE_PROJECT": "tsconfig.test.json"
+      },
+      "outputCapture": "std",
+      "skipFiles": [
+        "<node_internals>/**"
+      ]
+    },
+  ]
+}

.nycrc

@@ -0,0 +1,14 @@
+// Place your settings in this file to overwrite default and user settings.
+{
+  "search.exclude": {
+    "**/node_modules": true,
+    "**/public": true,
+    "**/package-lock.json": true,
+    "**/yarn.lock": true
+  },
+  "workbench.colorCustomizations": {
+    "activityBar.background": "#520064",
+    "titleBar.activeBackground": "#520064",
+    "titleBar.activeForeground": "#FAFBF4"
+  }
+}

.vscode/launch.json

@@ -1,8 +1,18 @@
 # Changelog
 
-## [Unreleased](https://github.com/feathersjs-ecosystem/feathers-authentication-management/tree/HEAD)
+## [v4.0.0-pre.2](https://github.com/feathersjs-ecosystem/feathers-authentication-management/tree/v4.0.0-pre.2) (2022-06-19)
 
-[Full Changelog](https://github.com/feathersjs-ecosystem/feathers-authentication-management/compare/v3.2.0...HEAD)
+[Full Changelog](https://github.com/feathersjs-ecosystem/feathers-authentication-management/compare/v3.2.0...v4.0.0-pre.2)
+
+## [v3.2.0](https://github.com/feathersjs-ecosystem/feathers-authentication-management/tree/v3.2.0) (2022-05-16)
+
+[Full Changelog](https://github.com/feathersjs-ecosystem/feathers-authentication-management/compare/v4.0.0-pre.1...v3.2.0)
+
+**Closed issues:**
+
+- 4.0.0-pre.1 has un declared passport-local dependency [\#173](https://github.com/feathersjs-ecosystem/feathers-authentication-management/issues/173)
+- skipIsVerifiedCheck  doesn't call custom notifier. [\#172](https://github.com/feathersjs-ecosystem/feathers-authentication-management/issues/172)
+- identityChange doesn't verify the user's password [\#171](https://github.com/feathersjs-ecosystem/feathers-authentication-management/issues/171)
 
 **Merged pull requests:**
 
@@ -15,16 +25,6 @@
 - Bump y18n from 4.0.0 to 4.0.1 [\#161](https://github.com/feathersjs-ecosystem/feathers-authentication-management/pull/161) ([dependabot[bot]](https://github.com/apps/dependabot))
 - Update docs.md [\#160](https://github.com/feathersjs-ecosystem/feathers-authentication-management/pull/160) ([re1ro](https://github.com/re1ro))
 
-## [v3.2.0](https://github.com/feathersjs-ecosystem/feathers-authentication-management/tree/v3.2.0) (2022-05-16)
-
-[Full Changelog](https://github.com/feathersjs-ecosystem/feathers-authentication-management/compare/v4.0.0-pre.1...v3.2.0)
-
-**Closed issues:**
-
-- 4.0.0-pre.1 has un declared passport-local dependency [\#173](https://github.com/feathersjs-ecosystem/feathers-authentication-management/issues/173)
-- skipIsVerifiedCheck  doesn't call custom notifier. [\#172](https://github.com/feathersjs-ecosystem/feathers-authentication-management/issues/172)
-- identityChange doesn't verify the user's password [\#171](https://github.com/feathersjs-ecosystem/feathers-authentication-management/issues/171)
-
 ## [v4.0.0-pre.1](https://github.com/feathersjs-ecosystem/feathers-authentication-management/tree/v4.0.0-pre.1) (2022-01-08)
 
 [Full Changelog](https://github.com/feathersjs-ecosystem/feathers-authentication-management/compare/v4.0.0-pre.0...v4.0.0-pre.1)

.vscode/settings.json

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Feathers
+Copyright (c) 2022 Feathers
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

CHANGELOG.md

@@ -1,30 +1,32 @@
 **This module is looking for maintainers, please contact us on the [Feathers Slack group](http://slack.feathersjs.com/)** (more details in [#124](https://github.com/feathersjs-ecosystem/feathers-authentication-management/issues/124))
 
-## feathers-authentication-management
-
-[![Build Status](https://travis-ci.org/feathersjs-ecosystem/feathers-authentication-management.png?branch=master)](https://travis-ci.org/feathersjs-ecosystem/feathers-authentication-management)
-[![Code Climate](https://codeclimate.com/github/feathersjs-ecosystem/feathers-authentication-management/badges/gpa.svg)](https://codeclimate.com/github/feathersjs-ecosystem/feathers-authentication-management)
-[![Test Coverage](https://codeclimate.com/github/feathersjs-ecosystem/feathers-authentication-management/badges/coverage.svg)](https://codeclimate.com/github/feathersjs-ecosystem/feathers-authentication-management/coverage)
-[![Dependency Status](https://img.shields.io/david/feathersjs-ecosystem/feathers-authentication-management.svg?style=flat-square)](https://david-dm.org/feathersjs-ecosystem/feathers-authentication-management)
-[![Download Status](https://img.shields.io/npm/dm/feathers-authentication-management.svg?style=flat-square)](https://www.npmjs.com/package/feathers-authentication-management)
-
+# feathers-authentication-management
 **Sign up verification, forgotten password reset, and other capabilities for local authentication.**
 
-## Documentation
+<p align="center">
+  <a href="https://feathers-a-m.netlify.app/"><img src="https://feathers-a-m.netlify.app/logo.svg" width="200"></a>
+</p>
 
-The [`master`](https://github.com/feathersjs-ecosystem/feathers-authentication-management) branch and versions >= 3.x are expected to work with [Feathers v4](https://docs.feathersjs.com/) (a.k.a. Crow).
+> **Please note:** You're currently looking at the `pre`-release of `feathers-authentication-management`. This is a typescript rewrite with a few changes. If you're looking for the 'old' version, please checkout the `master` branch or version `^3.1.0`.
 
-Versions >= 1.x are expected to work with [Feathers v3](https://buzzard.docs.feathersjs.com/) (a.k.a. Buzzard)
+[![Build Status](https://img.shields.io/github/workflow/status/feathersjs-ecosystem/feathers-authentication-management/Node.js%20CI)](https://github.com/feathersjs-ecosystem/feathers-authentication-management/actions/workflows/node.js.yml?query=branch%3Amaster)
+[![Code Climate](https://codeclimate.com/github/feathersjs-ecosystem/feathers-authentication-management/badges/gpa.svg)](https://codeclimate.com/github/feathersjs-ecosystem/feathers-authentication-management)
+[![Test Coverage](https://codeclimate.com/github/feathersjs-ecosystem/feathers-authentication-management/badges/coverage.svg)](https://codeclimate.com/github/feathersjs-ecosystem/feathers-authentication-management/coverage)
+[![Dependency Status](https://img.shields.io/librariesio/release/npm/feathers-authentication-management)](https://libraries.io/npm/feathers-authentication-management)
+[![Download Status](https://img.shields.io/npm/dm/feathers-authentication-management.svg?style=flat-square)](https://www.npmjs.com/package/feathers-authentication-management)
+[![GitHub license](https://img.shields.io/github/license/feathersjs-ecosystem/feathers-authentication-management)](https://github.com/feathersjs-ecosystem/feathers-authentication-management/blob/master/LICENSE)
 
-### Developers
+```bash
+npm i feathers-authentication-management@pre
+```
 
-Refer to [Documentation](./docs.md).
+## ⭐️⭐️⭐️ Documentation 
 
-Read a [step-by-step guide](https://hackernoon.com/setting-up-email-verification-in-feathersjs-ce764907e4f2) created by Imre Gelens
+You need more information? Please have a look at our new docs at [feathers-a-m.netlify.app](https://feathers-a-m.netlify.app/).
 
 ### Maintainers
 
-Refer to our [guidelines](./development.md).
+Refer to our [guidelines](./development).
 
 ## License