Doc update and fix the test build (#585)

* migrate docs to vitepress

* fix: unit tests

Author: tngan

.github/workflows/deploy-docs.yml

@@ -0,0 +1,56 @@
+name: Deploy VitePress Docs
+
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - 'docs/**'
+      - '.github/workflows/deploy-docs.yml'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          cache: 'yarn'
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: Build VitePress
+        run: yarn docs:build
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/.vitepress/dist
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
+

.gitignore

@@ -33,4 +33,6 @@ types/
 
 *.tgz
 
-package-lock.json
+package-lock.json
+
+*.vitepress

docs/_coverpage.md

@@ -0,0 +1,90 @@
+---
+layout: home
+
+hero:
+  name: samlify
+  text: Node.js SAML2 API
+  tagline: Nodejs library for Single Sign On with SAML 2.0
+  image:
+    src: /_media/padlock.png
+    alt: samlify
+  actions:
+    - theme: brand
+      text: Get Started
+      link: /prerequistite
+    - theme: alt
+      text: View on GitHub
+      link: https://github.com/tngan/samlify
+
+features:
+  - title: Simple and Active Maintenance
+    details: Easy to use API with active community support and regular updates
+  - title: Identity and Service Provider
+    details: Includes both Identity Provider and Service Provider implementations
+  - title: Highly Configurable
+    details: Flexible configuration options to fit your specific use case
+---
+
+## Installation
+
+To install the stable version
+
+```bash
+npm install samlify
+```
+
+or
+
+```bash
+yarn add samlify
+```
+
+## Use cases
+
+- IdP-initiated Single Sign On
+- IdP-initiated Single Log-out
+- SP-initiated Single Sign On
+- SP-initiated Single Log-out (in development)
+
+Simple solution of Identity Provider is provided in this module for test and educational use. Work with other 3rd party Identity Provider is also supported.
+
+## Glimpse of code
+
+::: warning API Changes
+**API is changed since v2. All file attributes like metadata and keyFile, it's expected to be normalized as string. It allows easy integration with database storage and import from local file system.**
+
+**The constructor of entity is also modified to accept a single configuration object instead of putting metadata and advanced configurations in separate arguments.**
+:::
+
+```javascript
+const saml = require('samlify');
+// configure a service provider
+const sp = saml.ServiceProvider({
+  metadata: fs.readFileSync('./metadata_sp.xml')
+});
+// configure the corresponding identity provider
+const idp = saml.IdentityProvider({
+  metadata: fs.readFileSync('./metadata_idp.xml')
+});
+// parse when receive a SAML Response from IdP
+router.post('/acs', (req, res) => {
+  sp.parseLoginResponse(idp, 'post', req)
+  .then(parseResult => {
+    // Write your own validation and render function here
+  })
+  .catch(console.error);
+});
+```
+
+Our default validation is to validate signature and the issuer name of Identity Provider. The code base is self explained. More use cases are provided in this documentation to fit in the real world application.
+
+## License
+
+MIT
+
+---
+
+<div style="font-size: 0.9em; color: #666;">
+<a href="https://www.flaticon.com/free-icons/password" title="password icons">Password icons created by Pixel perfect - Flaticon</a>
+</div>
+

docs/_media/favicon.ico

@@ -13,12 +13,15 @@
   "typings": "types/index.d.ts",
   "scripts": {
     "build": "yarn audit;make rebuild",
-    "docs": "docsify serve -o docs",
+    "docs:dev": "vitepress dev docs",
+    "docs:build": "vitepress build docs",
+    "docs:preview": "vitepress preview docs",
     "lint": "tslint -p .",
     "lint:fix": "tslint -p . --fix",
     "pretest": "make pretest",
-    "test": "NODE_ENV=test nyc ava",
-    "coverage": "nyc report --reporter=text-lcov | coveralls",
+    "test": "NODE_ENV=test vitest run",
+    "test:watch": "NODE_ENV=test vitest",
+    "coverage": "vitest run --coverage",
     "hooks:postinstall": "ln -sf $PWD/.pre-commit.sh $PWD/.git/hooks/pre-commit"
   },
   "contributors": [
@@ -45,30 +48,17 @@
   },
   "devDependencies": {
     "@authenio/samlify-xsd-schema-validator": "^1.0.5",
-    "@ava/typescript": "^1.1.1",
     "@types/node": "^11.11.3",
     "@types/node-forge": "^1.0.1",
     "@types/node-rsa": "^1.1.1",
     "@types/pako": "^1.0.1",
     "@types/uuid": "^8.3.4",
     "@types/xmldom": "^0.1.31",
-    "ava": "^4.1.0",
-    "coveralls": "^3.1.1",
-    "nyc": "^15.1.0",
     "timekeeper": "^2.2.0",
     "ts-node": "^10.7.0",
     "tslint": "^6.1.3",
-    "typescript": "^4.4.2"
-  },
-  "ava": {
-    "extensions": [
-      "ts"
-    ],
-    "require": [
-      "ts-node/register"
-    ],
-    "files": [
-      "!**/*.d.ts"
-    ]
+    "typescript": "^4.4.2",
+    "vitepress": "^1.0.0",
+    "vitest": "^1.0.0"
   }
 }