doc: typedoc for v1 (#608)

* doc: typedoc

* chore: add a github action

Author: chentsulin

Diff for: .github/workflows/gh-page-docs.yml

@@ -0,0 +1,35 @@
+# This workflow will do a clean install of node dependencies, build the source code and 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: GitHub Page Docs
+
+on:
+  push:
+    branches:
+      - master
+
+env:
+  CI: true
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/[email protected] # If you're using actions/checkout@v2 you must set persist-credentials to false in most cases for the deployment to work correctly.
+        with:
+          persist-credentials: false
+
+      - name: Install npm dependencies
+        run: yarn --frozen-lockfile
+
+      - name: Build doc files
+        run: npm run typedoc
+
+      - name: Deploy 🚀
+        uses: JamesIves/[email protected]
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          BRANCH: gh-pages # The branch the action should deploy to.
+          FOLDER: docs # The folder the action should deploy.
+          TARGET_FOLDER: latest

Diff for: .gitignore

@@ -23,3 +23,6 @@ node_modules/
 
 # Mac OS
 .DS_Store
+
+# Typedoc
+docs

Diff for: package.json

@@ -25,6 +25,7 @@
     "testonly": "jest",
     "testonly:cov": "jest --coverage",
     "testonly:watch": "jest --watch",
+    "typedoc": "typedoc ./packages",
     "watch": "tsc --build tsconfig.build.json --watch"
   },
   "devDependencies": {
@@ -52,6 +53,8 @@
     "prettier-package-json": "^2.1.3",
     "rimraf": "^3.0.2",
     "ts-jest": "^26.1.1",
+    "typedoc": "0.17.0",
+    "typedoc-plugin-lerna-packages": "^0.3.0",
     "typescript": "^3.9.5"
   },
   "engines": {

Diff for: packages/messaging-api-line/package.json

@@ -9,11 +9,6 @@
   "version": "1.0.0-beta.33",
   "main": "dist/index.js",
   "browser": "lib/browser.js",
-  "scripts": {
-    "typedoc": "yarn typedoc:html && yarn typedoc:json",
-    "typedoc:html": "typedoc --out docs --exclude \"src/__tests__/**/*.ts\" src",
-    "typedoc:json": "typedoc --json docs/index.json --exclude \"src/__tests__/**/*.ts\" src"
-  },
   "types": "dist/index.d.ts",
   "dependencies": {
     "@types/warning": "^3.0.0",
@@ -25,9 +20,6 @@
     "type-fest": "^0.15.1",
     "warning": "^4.0.3"
   },
-  "devDependencies": {
-    "typedoc": "^0.16.11"
-  },
   "keywords": [
     "bot",
     "chatbot",

Diff for: typedoc.js

@@ -0,0 +1,16 @@
+module.exports = {
+  mode: 'modules',
+  out: 'docs',
+  exclude: [
+    '**/node_modules/**',
+    '**/dist/**',
+    '**/*.spec.ts',
+    '**/__tests__/**/*.ts',
+  ],
+  name: 'messaging-apis',
+  excludePrivate: true,
+  excludeNotExported: true,
+  excludeExternals: true,
+  esModuleInterop: true,
+  includeVersion: true,
+};

Diff for: yarn.lock

@@ -1538,7 +1538,7 @@
   resolved "https://registry.yarnpkg.com/@types/lodash/-/lodash-4.14.156.tgz#cbe30909c89a1feeb7c60803e785344ea0ec82d1"
   integrity sha512-l2AgHXcKUwx2DsvP19wtRPqZ4NkONjmorOdq4sMcxIjqdIuuV/ULo2ftuv4NUpevwfW7Ju/UKLqo0ZXuEt/8lQ==
 
-"@types/minimatch@*", "@types/[email protected]":
+"@types/minimatch@*":
   version "3.0.3"
   resolved "https://registry.yarnpkg.com/@types/minimatch/-/minimatch-3.0.3.tgz#3dca0e3f33b200fc7d1139c0cd96c1268cadfd9d"
   integrity sha512-tHq6qdbT9U1IRSGf14CL0pUlULksvY9OZ+5eEgl1N7t+OA3tGvNpxJCzuKQlsNgCVwbAs670L1vcVQi8j9HjnA==
@@ -5622,17 +5622,17 @@ merge2@^1.2.3:
     url-join "^4.0.1"
 
 "messaging-api-messenger@file:packages/messaging-api-messenger":
-  version "1.0.0-beta.31"
+  version "1.0.0-beta.33"
   dependencies:
     "@types/append-query" "^2.0.0"
     "@types/lodash" "^4.14.156"
     "@types/warning" "^3.0.0"
     append-query "^2.1.0"
     axios "^0.19.2"
-    axios-error "file:packages/axios-error"
+    axios-error "file:../../../Library/Caches/Yarn/v6/npm-messaging-api-messenger-1.0.0-beta.33-9de3a731-3bff-4378-a4b5-f417467a98aa-1597225384196/node_modules/axios-error"
     form-data "^3.0.0"
     lodash "^4.17.15"
-    messaging-api-common "file:packages/messaging-api-common"
+    messaging-api-common "file:../../../Library/Caches/Yarn/v6/npm-messaging-api-messenger-1.0.0-beta.33-9de3a731-3bff-4378-a4b5-f417467a98aa-1597225384196/node_modules/messaging-api-common"
     ts-invariant "^0.4.4"
     warning "^4.0.3"
 
@@ -8028,22 +8028,26 @@ typedarray@^0.0.6:
   resolved "https://registry.yarnpkg.com/typedarray/-/typedarray-0.0.6.tgz#867ac74e3864187b1d3d47d996a78ec5c8830777"
   integrity sha1-hnrHTjhkGHsdPUfZlqeOxciDB3c=
 
-typedoc-default-themes@^0.7.2:
-  version "0.7.2"
-  resolved "https://registry.yarnpkg.com/typedoc-default-themes/-/typedoc-default-themes-0.7.2.tgz#1e9896f920b58e6da0bba9d7e643738d02405a5a"
-  integrity sha512-fiFKlFO6VTqjcno8w6WpTsbCgXmfPHVjnLfYkmByZE7moaz+E2DSpAT+oHtDHv7E0BM5kAhPrHJELP2J2Y2T9A==
+typedoc-default-themes@^0.8.0:
+  version "0.8.0"
+  resolved "https://registry.yarnpkg.com/typedoc-default-themes/-/typedoc-default-themes-0.8.0.tgz#991d6121d492e662eb371f30edc982440fe04a63"
+  integrity sha512-0bzAjVEX6ClhE3jLRdU7vR8Fsfbt4ZcPa+gkqyAVgTlQ1fLo/7AkCbTP+hC5XAiByDfRfsAGqj9y6FNjJh0p4A==
   dependencies:
     backbone "^1.4.0"
     jquery "^3.4.1"
     lunr "^2.3.8"
-    underscore "^1.9.1"
+    underscore "^1.9.2"
 
-typedoc@^0.16.11:
-  version "0.16.11"
-  resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.16.11.tgz#95f862c6eba78533edc9af7096d2295b718eddc1"
-  integrity sha512-YEa5i0/n0yYmLJISJ5+po6seYfJQJ5lQYcHCPF9ffTF92DB/TAZO/QrazX5skPHNPtmlIht5FdTXCM2kC7jQFQ==
+typedoc-plugin-lerna-packages@^0.3.0:
+  version "0.3.0"
+  resolved "https://registry.yarnpkg.com/typedoc-plugin-lerna-packages/-/typedoc-plugin-lerna-packages-0.3.0.tgz#c0b13fa6cf5b9a495e4f7cb7d8fa8844d8967412"
+  integrity sha512-Ek6yaJczfSIxfUkHNx7yL+JoJ86KifHecrmbFxtkSlYxGwDrQTqlTQncChslJO2EmQyOn9PUQVyBDnYyrOBB2w==
+
+[email protected]:
+  version "0.17.0"
+  resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.17.0.tgz#25dcd68d51e7bdb04af3cd1a3fd591d23d9886df"
+  integrity sha512-HviZ/SLDPAgJdYqaCor+7rmJnM80Ra2oI0Nj+L/sOIBvh9pY1aCzDtSg3p3n4cgqCmvGu6O90fvMQyjEvlqM+g==
   dependencies:
-    "@types/minimatch" "3.0.3"
     fs-extra "^8.1.0"
     handlebars "^4.7.2"
     highlight.js "^9.17.1"
@@ -8052,13 +8056,7 @@ typedoc@^0.16.11:
     minimatch "^3.0.0"
     progress "^2.0.3"
     shelljs "^0.8.3"
-    typedoc-default-themes "^0.7.2"
-    typescript "3.7.x"
-
-[email protected]:
-  version "3.7.5"
-  resolved "https://registry.yarnpkg.com/typescript/-/typescript-3.7.5.tgz#0692e21f65fd4108b9330238aac11dd2e177a1ae"
-  integrity sha512-/P5lkRXkWHNAbcJIiHPfRoKqyd7bsyCma1hZNUGfn20qm64T6ZBlrzprymeu918H+mB/0rIg2gGK/BXkhhYgBw==
+    typedoc-default-themes "^0.8.0"
 
 typescript@^3.9.5:
   version "3.9.5"
@@ -8083,7 +8081,7 @@ umask@^1.1.0:
   resolved "https://registry.yarnpkg.com/umask/-/umask-1.1.0.tgz#f29cebf01df517912bb58ff9c4e50fde8e33320d"
   integrity sha1-8pzr8B31F5ErtY/5xOUP3o4zMg0=
 
-underscore@>=1.8.3, underscore@^1.9.1:
+underscore@>=1.8.3, underscore@^1.9.2:
   version "1.10.2"
   resolved "https://registry.yarnpkg.com/underscore/-/underscore-1.10.2.tgz#73d6aa3668f3188e4adb0f1943bd12cfd7efaaaf"
   integrity sha512-N4P+Q/BuyuEKFJ43B9gYuOj4TQUHXX+j2FqguVOpjkssLUUrnJofCcBccJSCoeturDoZU6GorDTHSvUDlSQbTg==