Draft: typescript refactoring

.eslintignore

@@ -0,0 +1,8 @@
+# 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/

.eslintrc.js

@@ -0,0 +1,33 @@
+module.exports = {
+  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',
+    'standard-with-typescript'
+  ],
+  rules: {
+    semi: ['warn', 'always'],
+    '@typescript-eslint/semi': ['warn', 'always'],
+    '@typescript-eslint/strict-boolean-expressions': ['off'],
+    'spaced-comment': ['off']
+  },
+  overrides: [
+    {
+      files: ['test/**/*.ts'],
+      rules: {
+        '@typescript-eslint/ban-ts-comment': ['off']
+      }
+    }
+  ]
+};

.github/workflows/node.js.yml

@@ -0,0 +1,29 @@
+# This workflow will do a clean install of node dependencies, 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: Node.js CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [10.x, 12.x, 14.x, 15.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: npm ci
+    - run: npm test

.gitignore

@@ -33,9 +33,10 @@ node_modules
 
 # The compiled/babelified modules
 lib/
+dist/
 
 ## editor
 .idea/
 
-.vscode/
-.prettierrc
+#.vscode/
+.prettierrc

.mocharc.js

@@ -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
+};

.nycrc

@@ -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"]
-}
+}

.vscode/launch.json

@@ -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>/**"
+      ]
+    },
+  ]
+}

.vscode/settings.json

@@ -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"
+  }
+}

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Feathers
+Copyright (c) 2021 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

docs.md

@@ -82,23 +82,31 @@ Leaving it a pure API server, lets it be used with both native and browser clien
 
 ## Contents
 
-- [The Service](#service)
-- [Client](#client)
-  - [Using Feathers' method calls](#using-feathers-method-calls)
-  - [Provided service wrappers](#provided-service-wrappers)
-  - [HTTP fetch](#http-fetch)
-  - [React's redux](#react-redux)
-    - [Dispatching services](#dispatching-services)
-    - [Dispatching authentication](#dispatching-authentication)
-  - [Vue 2.0 (docs to do)](#vue)
-- [Hooks](#hooks)
-- [Multiple services](#multiple-services)
-- [Database](#database)
-- [Routing](#routing)
-- [Security](#security)
-- [Docs](#docs)
-- [Configurable](#configurable)
-- [Tests](#tests)
+- [feathers-authentication-management](#feathers-authentication-management)
+    - [Multiple communication channels:](#multiple-communication-channels)
+    - [Capabilities:](#capabilities)
+    - [User notifications may be sent for:](#user-notifications-may-be-sent-for)
+    - [May be used with](#may-be-used-with)
+  - [Contents](#contents)
+  - [Service](#service)
+  - [Client](#client)
+    - [Using Feathers method calls](#using-feathers-method-calls)
+    - [Provided service wrappers](#provided-service-wrappers)
+    - [HTTP fetch](#http-fetch)
+    - [React Redux](#react-redux)
+      - [Dispatching services](#dispatching-services)
+      - [Dispatching authentication](#dispatching-authentication)
+    - [Vue](#vue)
+  - [Hooks](#hooks)
+    - [`verifyHooks.addVerification( path = 'authManagement' )`](#verifyhooksaddverification-path--authmanagement-)
+    - [`verifyHooks.isVerified()`](#verifyhooksisverified)
+  - [Multiple services](#multiple-services)
+  - [Database](#database)
+  - [Routing](#routing)
+  - [Security](#security)
+  - [Docs](#docs)
+  - [Configurable](#configurable)
+  - [Tests](#tests)
 
 ## Service
 
@@ -497,7 +505,7 @@ You should add them to your user model if your database uses models.
   resetToken: { type: String },
   resetShortToken: { type: String },
   resetExpires: { type: Date }, // or a long integer
-  resetAttempts: { type: Number },
+  resetAttempts: { type: Number }
 }
 ```
 

docs/.vitepress/config.js

@@ -0,0 +1,23 @@
+module.exports = {
+  title: 'feathers-authentication-management',
+  description: 'Sign up verification, forgotten password reset, and other capabilities for local authentication',
+  themeConfig: {
+    repo: 'feathersjs-ecosystem/feathers-authentication-management',
+    editLinks: true,
+    editLinkText: 'Edit this page on GitHub',
+    lastUpdated: 'Last Updated',
+    sidebarDepth: 1,
+    displayAllHeaders: true,
+    sidebar: {
+      '/': [
+        { text: 'Overview', link: '/overview' },
+        { text: 'Getting Started', link: '/getting-started' },
+        { text: 'Basic Usage', link: '/basic' },
+        { text: 'Services', link: '/services' },
+        { text: 'Hooks', link: "/hooks" },
+        { text: "Client", link: "/client" },
+        { text: "Advanced Usage", link: "/advanced" }
+      ]
+    },
+  }
+}

docs/.vitepress/style.styl

@@ -0,0 +1,20 @@
+// colors
+$accentColor = #520064
+$textColor = #2c3e50
+$borderColor = #eaecef
+$codeBgColor = #282c34
+$arrowBgColor = #ccc
+$badgeTipColor = #520064
+$badgeWarningColor = darken(#ffe564, 35%)
+$badgeErrorColor = #DA5961
+
+// layout
+$navbarHeight = 3.6rem
+$sidebarWidth = 20rem
+$contentWidth = 960px
+$homePageWidth = 960px
+
+// responsive breakpoints
+$MQNarrow = 959px
+$MQMobile = 719px
+$MQMobileNarrow = 419px