Merge branch 'master' into beta

Author: hasezoey

.gitignore

@@ -44,3 +44,4 @@ coverage
 .nyc_output
 package-lock.json
 build
+typedoc_out

CHANGELOG.md

@@ -199,6 +199,13 @@ also "disable" has been removed
 * **typescript:** upgrade to version 5.0.4 ([d531dde](https://github.com/nodkz/mongodb-memory-server/commit/d531ddea767cef2c038e228597812507e0590c2a))
 * **uuid:** remove package ([41b2551](https://github.com/nodkz/mongodb-memory-server/commit/41b2551a89df0eb806511efb85d5bd5f6419664c))
 
+## [8.16.0](https://github.com/nodkz/mongodb-memory-server/compare/v8.15.1...v8.16.0) (2023-10-05)
+
+
+### Dependencies
+
+* **typedoc:** add dev-dependency ([f8c671c](https://github.com/nodkz/mongodb-memory-server/commit/f8c671c2663d3c2a67314392d5f18cb08933ebfb))
+
 ## [8.15.1](https://github.com/nodkz/mongodb-memory-server/compare/v8.15.0...v8.15.1) (2023-08-17)
 
 

package.json

@@ -31,7 +31,8 @@
     "semantic-release": "^19.0.5",
     "semantic-release-replace-plugin": "1.2.0",
     "ts-jest": "29.1.1",
-    "typescript": "5.0.4"
+    "typescript": "5.0.4",
+    "typedoc": "^0.21.x"
   },
   "workspaces": {
     "packages": [
@@ -54,6 +55,7 @@
     "semantic-release": "semantic-release",
     "readme:toc": "doctoc ./README.md",
     "postinstall": "husky install",
-    "website": "yarn --cwd website/ run start"
+    "website": "yarn --cwd website/ run start",
+    "typedoc": "typedoc packages/mongodb-memory-server-core/src/index.ts --out typedoc_out --tsconfig packages/mongodb-memory-server-core/tsconfig.build.json"
   }
 }

scripts/ghPagesDeploy.js

@@ -7,7 +7,7 @@ const path = require('node:path');
 /* Constants / Config */
 
 /** keep ".git", ".github", "website" and "scripts" */
-const keepRegex = /^(?:\.git|website|scripts|versions)/;
+const keepRegex = /^(?:\.git|website|scripts|versions|typedoc_out)/;
 /** Regex to filter and get versions output from git ls-tree */
 const versionsFilter = /^versions\/(\d+\.x|beta)\/?$/;
 /** Which branch to deploy to */
@@ -42,6 +42,11 @@ function main() {
   execSync(`git config user.name "${commiterInfo.name}"`, { stdio: 'inherit' });
   execSync(`git config user.email "${commiterInfo.email}"`, { stdio: 'inherit' });
 
+  console.log('\nInstall of root\n');
+
+  // make sure everything is correctly installed
+  execSync('yarn install', { stdio: 'inherit' });
+
   console.log('\nInstall & Build of website\n');
 
   // make sure everything is correctly installed
@@ -50,6 +55,9 @@ function main() {
   // build the website
   execSync('yarn --cwd ./website build', { stdio: 'inherit' });
 
+  // build the typedoc website
+  execSync('yarn run typedoc', { stdio: 'inherit' });
+
   console.log('\nSwitching Branches\n');
 
   // ensure there is nothing blocking from changing branches
@@ -93,6 +101,14 @@ function main() {
     fs.renameSync(from, to);
   }
 
+  // move typedoc to "deployAs"
+  {
+    const from = 'typedoc_out';
+    const to = path.join(deployInfo.deployPath, 'typedoc');
+    console.log('rename', from, '->', to); // always log what is renamed
+    fs.renameSync(from, to);
+  }
+
   // remove website
   fs.rmSync('website', { recursive: true });
 

website/docusaurus.config.js

@@ -59,6 +59,13 @@ module.exports = {
           label: 'API',
           position: 'right',
         },
+        {
+          type: 'custom-link',
+          href: 'typedoc/index.html',
+          prependBaseUrlToHref: true,
+          label: 'Typedoc',
+          position: 'right',
+        },
         {
           href: 'https://github.com/nodkz/mongodb-memory-server/blob/master/CHANGELOG.md',
           label: 'Changelog',

website/src/components/NavbarExternalLink.js

@@ -0,0 +1,15 @@
+import React from 'react';
+import useBaseUrl from '@docusaurus/useBaseUrl';
+
+// this is a workaround, because without this non-absolute links will be seen as routable links by react
+// see https://github.com/facebook/docusaurus/discussions/9376
+
+export default function NavbarLinkNoReact({ href, label }) {
+  const normalizedHref = useBaseUrl(href, { forcePrependBaseUrl: true });
+
+  return (
+    <a href={normalizedHref} class="navbar__item navbar__link">
+      {label}
+    </a>
+  );
+}

website/src/theme/NavbarItem/ComponentTypes.js

@@ -1,10 +1,12 @@
 import OriginalComponentTypes from '@theme-original/NavbarItem/ComponentTypes';
 import NavbarVersionsSelector from '../../components/NavbarVersionsSelector';
 import NavbarBetaNotice from '../../components/NavbarBetaNotice';
+import NavbarLinkNoReact from '../../components/NavbarExternalLink';
 
 const ComponentTypes = {
   ...OriginalComponentTypes,
   'custom-versions-selector': NavbarVersionsSelector,
   'custom-beta-notice': NavbarBetaNotice,
+  'custom-link': NavbarLinkNoReact,
 };
 export default ComponentTypes;

yarn.lock

@@ -3258,7 +3258,7 @@ glob@^10.2.2, glob@^10.3.7:
     minipass "^5.0.0 || ^6.0.2 || ^7.0.0"
     path-scurry "^1.10.1"
 
-glob@^7.1.3, glob@^7.1.4, glob@^7.2.0:
+glob@^7.1.3, glob@^7.1.4, glob@^7.1.7, glob@^7.2.0:
   version "7.2.3"
   resolved "https://registry.yarnpkg.com/glob/-/glob-7.2.3.tgz#b8df0fb802bbfa8e89bd1d938b4e16578ed44f2b"
   integrity sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==
@@ -4263,6 +4263,11 @@ json5@^2.2.3:
   resolved "https://registry.yarnpkg.com/json5/-/json5-2.2.3.tgz#78cd6f1a19bdc12b73db5ad0c61efd66c1e29283"
   integrity sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg==
 
+jsonc-parser@^3.0.0:
+  version "3.2.0"
+  resolved "https://registry.yarnpkg.com/jsonc-parser/-/jsonc-parser-3.2.0.tgz#31ff3f4c2b9793f89c67212627c51c6394f88e76"
+  integrity sha512-gfFQZrcTc8CnKXp6Y4/CBT3fTc0OVuDofpre4aEeEpSBPV5X5v4+Vmx+8snU7RLPrNHPKSgLxGo9YuQzz20o+w==
+
 jsonfile@^6.0.1:
   version "6.1.0"
   resolved "https://registry.yarnpkg.com/jsonfile/-/jsonfile-6.1.0.tgz#bc55b2634793c679ec6403094eb13698a6ec0aae"
@@ -4629,6 +4634,11 @@ lru-cache@^7.4.4, lru-cache@^7.5.1, lru-cache@^7.7.1:
   resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-10.0.1.tgz#0a3be479df549cca0e5d693ac402ff19537a6b7a"
   integrity sha512-IJ4uwUTi2qCccrioU6g9g/5rvvVl13bsdczUUcqbciD9iLr095yj8DQKdObriEvuNSx325N1rV1O0sJFszx75g==
 
+lunr@^2.3.9:
+  version "2.3.9"
+  resolved "https://registry.yarnpkg.com/lunr/-/lunr-2.3.9.tgz#18b123142832337dd6e964df1a5a7707b25d35e1"
+  integrity sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==
+
 make-dir@^3.0.2:
   version "3.1.0"
   resolved "https://registry.yarnpkg.com/make-dir/-/make-dir-3.1.0.tgz#415e967046b3a7f1d185277d84aa58203726a13f"
@@ -4953,7 +4963,7 @@ min-indent@^1.0.0:
   resolved "https://registry.yarnpkg.com/min-indent/-/min-indent-1.0.1.tgz#a63f681673b30571fbe8bc25686ae746eefa9869"
   integrity sha512-I9jwMn07Sy/IwOj3zVkVik2JTvgpaykDZEigL6Rx6N9LbMywwUSMtxET+7lVoDLLd3O3IXwJwvuuns8UB/HeAg==
 
-minimatch@^3.0.4, minimatch@^3.0.5, minimatch@^3.1.1, minimatch@^3.1.2:
+minimatch@^3.0.0, minimatch@^3.0.4, minimatch@^3.0.5, minimatch@^3.1.1, minimatch@^3.1.2:
   version "3.1.2"
   resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-3.1.2.tgz#19cd194bfd3e428f049a70817c038d89ab4be35b"
   integrity sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==
@@ -5795,6 +5805,11 @@ process-nextick-args@~2.0.0:
   resolved "https://registry.yarnpkg.com/process-nextick-args/-/process-nextick-args-2.0.1.tgz#7820d9b16120cc55ca9ae7792680ae7dba6d7fe2"
   integrity sha512-3ouUOpQhtgrbOa17J7+uxOTpITYWaGP7/AhoR3+A+/1e9skrzelGi/dXzEYyvbxubEF6Wn2ypscTKiKJFFn1ag==
 
+progress@^2.0.3:
+  version "2.0.3"
+  resolved "https://registry.yarnpkg.com/progress/-/progress-2.0.3.tgz#7e8cf8d8f5b8f239c1bc68beb4eb78567d572ef8"
+  integrity sha512-7PiHtLll5LdnKIMw100I+8xJXR5gW2QwWYkT6iJva0bXitZKa/XMrSbdmg3r2Xnaidz9Qumd0VPaMrZlF9V9sA==
+
 promise-all-reject-late@^1.0.0:
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/promise-all-reject-late/-/promise-all-reject-late-1.0.1.tgz#f8ebf13483e5ca91ad809ccc2fcf25f26f8643c2"
@@ -6258,6 +6273,15 @@ shebang-regex@^3.0.0:
   resolved "https://registry.yarnpkg.com/shebang-regex/-/shebang-regex-3.0.0.tgz#ae16f1644d873ecad843b0307b143362d4c42172"
   integrity sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==
 
+shiki@^0.9.8:
+  version "0.9.15"
+  resolved "https://registry.yarnpkg.com/shiki/-/shiki-0.9.15.tgz#2481b46155364f236651319d2c18e329ead6fa44"
+  integrity sha512-/Y0z9IzhJ8nD9nbceORCqu6NgT9X6I8Fk8c3SICHI5NbZRLdZYFaB233gwct9sU0vvSypyaL/qaKvzyQGJBZSw==
+  dependencies:
+    jsonc-parser "^3.0.0"
+    vscode-oniguruma "^1.6.1"
+    vscode-textmate "5.2.0"
+
 signal-exit@^3.0.2, signal-exit@^3.0.3, signal-exit@^3.0.7:
   version "3.0.7"
   resolved "https://registry.yarnpkg.com/signal-exit/-/signal-exit-3.0.7.tgz#a9a1767f8af84155114eaabd73f99273c8f59ad9"
@@ -6819,6 +6843,25 @@ type-fest@^3.0.0:
   resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-3.13.1.tgz#bb744c1f0678bea7543a2d1ec24e83e68e8c8706"
   integrity sha512-tLq3bSNx+xSpwvAJnzrK0Ep5CLNWjvFTOp71URMaAEWBfRb9nnJiBoUe0tF8bI4ZFO3omgBR6NvnbzVUT3Ly4g==
 
+typedoc-default-themes@^0.12.10:
+  version "0.12.10"
+  resolved "https://registry.yarnpkg.com/typedoc-default-themes/-/typedoc-default-themes-0.12.10.tgz#614c4222fe642657f37693ea62cad4dafeddf843"
+  integrity sha512-fIS001cAYHkyQPidWXmHuhs8usjP5XVJjWB8oZGqkTowZaz3v7g3KDZeeqE82FBrmkAnIBOY3jgy7lnPnqATbA==
+
+typedoc@^0.21.x:
+  version "0.21.10"
+  resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.21.10.tgz#1abfcc1b0be2be9608461572d4a4153e2658c8bf"
+  integrity sha512-Y0wYIehkjkPfsp3pv86fp3WPHUcOf8pnQUDLwG1PqSccUSqdsv7Pz1Gd5WrTJvXQB2wO1mKlZ8qW8qMiopKyjA==
+  dependencies:
+    glob "^7.1.7"
+    handlebars "^4.7.7"
+    lunr "^2.3.9"
+    marked "^4.0.10"
+    minimatch "^3.0.0"
+    progress "^2.0.3"
+    shiki "^0.9.8"
+    typedoc-default-themes "^0.12.10"
+
 [email protected]:
   version "5.0.4"
   resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.0.4.tgz#b217fd20119bd61a94d4011274e0ab369058da3b"
@@ -6998,6 +7041,16 @@ vfile@^4.0.0:
     unist-util-stringify-position "^2.0.0"
     vfile-message "^2.0.0"
 
+vscode-oniguruma@^1.6.1:
+  version "1.7.0"
+  resolved "https://registry.yarnpkg.com/vscode-oniguruma/-/vscode-oniguruma-1.7.0.tgz#439bfad8fe71abd7798338d1cd3dc53a8beea94b"
+  integrity sha512-L9WMGRfrjOhgHSdOYgCt/yRMsXzLDJSL7BPrOZt73gU0iWO4mpqzqQzOz5srxqTvMBaR0XZTSrVWo4j55Rc6cA==
+
+[email protected]:
+  version "5.2.0"
+  resolved "https://registry.yarnpkg.com/vscode-textmate/-/vscode-textmate-5.2.0.tgz#01f01760a391e8222fe4f33fbccbd1ad71aed74e"
+  integrity sha512-Uw5ooOQxRASHgu6C7GVvUxisKXfSgW4oFlO+aa+PAkgmH89O3CXxEEzNRNtHSqtXFTl0nAC1uYj0GMSH27uwtQ==
+
 walk-up-path@^1.0.0:
   version "1.0.0"
   resolved "https://registry.yarnpkg.com/walk-up-path/-/walk-up-path-1.0.0.tgz#d4745e893dd5fd0dbb58dd0a4c6a33d9c9fec53e"