docs(core): autogenerate nx devkit api (#5827)

Co-authored-by: Isaac Mann <isaacplmann+git@gmail.com>

docs/angular/api-nx-devkit/ngcli_adapter.md

@@ -0,0 +1,98 @@
+# Module: ngcli-adapter
+
+## Table of contents
+
+### Classes
+
+- [NxScopedHost](../../angular/nx-devkit/ngcli_adapter#nxscopedhost)
+
+### Functions
+
+- [mockSchematicsForTesting](../../angular/nx-devkit/ngcli_adapter#mockschematicsfortesting)
+- [overrideCollectionResolutionForTesting](../../angular/nx-devkit/ngcli_adapter#overridecollectionresolutionfortesting)
+- [wrapAngularDevkitSchematic](../../angular/nx-devkit/ngcli_adapter#wrapangulardevkitschematic)
+
+## Classes
+
+### NxScopedHost
+
+• **NxScopedHost**: _object_
+
+## Functions
+
+### mockSchematicsForTesting
+
+▸ **mockSchematicsForTesting**(`schematics`: { [name: string]: (`host`: [_Tree_](../../angular/nx-devkit/index#tree), `generatorOptions`: { [k: string]: _any_; }) => _Promise_<void\>; }): _void_
+
+If you have an Nx Devkit generator invoking the wrapped Angular Devkit schematic,
+and you don't want the Angular Devkit schematic to run, you can mock it up using this function.
+
+Unfortunately, there are some edge cases in the Nx-Angular devkit integration that
+can be seen in the unit tests context. This function is useful for handling that as well.
+
+In this case, you can mock it up.
+
+Example:
+
+```
+  mockSchematicsForTesting({
+    'mycollection:myschematic': (tree, params) => {
+       tree.write('README.md');
+    }
+  });
+
+```
+
+#### Parameters
+
+| Name         | Type     |
+| :----------- | :------- |
+| `schematics` | _object_ |
+
+**Returns:** _void_
+
+---
+
+### overrideCollectionResolutionForTesting
+
+▸ **overrideCollectionResolutionForTesting**(`collections`: { [name: string]: _string_; }): _void_
+
+By default, Angular Devkit schematic collections will be resolved using the Node resolution.
+This doesn't work if you are testing schematics that refer to other schematics in the
+same repo.
+
+This function can can be used to override the resolution behaviour.
+
+Example:
+
+```
+  overrideCollectionResolutionForTesting({
+    '@nrwl/workspace': path.join(__dirname, '../../../../workspace/collection.json'),
+    '@nrwl/angular': path.join(__dirname, '../../../../angular/collection.json'),
+    '@nrwl/linter': path.join(__dirname, '../../../../linter/collection.json')
+  });
+
+```
+
+#### Parameters
+
+| Name          | Type     |
+| :------------ | :------- |
+| `collections` | _object_ |
+
+**Returns:** _void_
+
+---
+
+### wrapAngularDevkitSchematic
+
+▸ **wrapAngularDevkitSchematic**(`collectionName`: _string_, `generatorName`: _string_): _function_
+
+#### Parameters
+
+| Name             | Type     |
+| :--------------- | :------- |
+| `collectionName` | _string_ |
+| `generatorName`  | _string_ |
+
+**Returns:** (`host`: [_Tree_](../../angular/nx-devkit/index#tree), `generatorOptions`: { [k: string]: _any_; }) => _Promise_<any\>

docs/map.json

@@ -890,6 +890,24 @@
           }
         ]
       },
+      {
+        "name": "Nx Devkit",
+        "id": "nx-devkit",
+        "itemList": [
+          {
+            "id": "index",
+            "name": "index",
+            "searchResultsName": "Nx Devkit",
+            "file": "angular/api-nx-devkit/index"
+          },
+          {
+            "id": "ngcli_adapter",
+            "name": "ngcli_adapter",
+            "searchResultsName": "Ng CLI Adapter",
+            "file": "angular/api-nx-devkit/ngcli_adapter"
+          }
+        ]
+      },
       {
         "name": "Executors / Builders",
         "id": "executors",
@@ -1978,6 +1996,24 @@
           }
         ]
       },
+      {
+        "name": "Nx Devkit",
+        "id": "nx-devkit",
+        "itemList": [
+          {
+            "id": "index",
+            "name": "index",
+            "searchResultsName": "Nx Devkit",
+            "file": "react/api-nx-devkit/index"
+          },
+          {
+            "id": "ngcli_adapter",
+            "name": "ngcli_adapter",
+            "searchResultsName": "Ng CLI Adapter",
+            "file": "react/api-nx-devkit/ngcli_adapter"
+          }
+        ]
+      },
       {
         "name": "Executors / Builders",
         "id": "executors",
@@ -3012,6 +3048,24 @@
           }
         ]
       },
+      {
+        "name": "Nx Devkit",
+        "id": "nx-devkit",
+        "itemList": [
+          {
+            "id": "index",
+            "name": "index",
+            "searchResultsName": "Nx Devkit",
+            "file": "node/api-nx-devkit/index"
+          },
+          {
+            "id": "ngcli_adapter",
+            "name": "ngcli_adapter",
+            "searchResultsName": "Ng CLI Adapter",
+            "file": "node/api-nx-devkit/ngcli_adapter"
+          }
+        ]
+      },
       {
         "name": "Executors / Builders",
         "id": "executors",

docs/node/api-nx-devkit/ngcli_adapter.md

@@ -0,0 +1,98 @@
+# Module: ngcli-adapter
+
+## Table of contents
+
+### Classes
+
+- [NxScopedHost](../../node/nx-devkit/ngcli_adapter#nxscopedhost)
+
+### Functions
+
+- [mockSchematicsForTesting](../../node/nx-devkit/ngcli_adapter#mockschematicsfortesting)
+- [overrideCollectionResolutionForTesting](../../node/nx-devkit/ngcli_adapter#overridecollectionresolutionfortesting)
+- [wrapAngularDevkitSchematic](../../node/nx-devkit/ngcli_adapter#wrapangulardevkitschematic)
+
+## Classes
+
+### NxScopedHost
+
+• **NxScopedHost**: _object_
+
+## Functions
+
+### mockSchematicsForTesting
+
+▸ **mockSchematicsForTesting**(`schematics`: { [name: string]: (`host`: [_Tree_](../../node/nx-devkit/index#tree), `generatorOptions`: { [k: string]: _any_; }) => _Promise_<void\>; }): _void_
+
+If you have an Nx Devkit generator invoking the wrapped Angular Devkit schematic,
+and you don't want the Angular Devkit schematic to run, you can mock it up using this function.
+
+Unfortunately, there are some edge cases in the Nx-Angular devkit integration that
+can be seen in the unit tests context. This function is useful for handling that as well.
+
+In this case, you can mock it up.
+
+Example:
+
+```
+  mockSchematicsForTesting({
+    'mycollection:myschematic': (tree, params) => {
+       tree.write('README.md');
+    }
+  });
+
+```
+
+#### Parameters
+
+| Name         | Type     |
+| :----------- | :------- |
+| `schematics` | _object_ |
+
+**Returns:** _void_
+
+---
+
+### overrideCollectionResolutionForTesting
+
+▸ **overrideCollectionResolutionForTesting**(`collections`: { [name: string]: _string_; }): _void_
+
+By default, Angular Devkit schematic collections will be resolved using the Node resolution.
+This doesn't work if you are testing schematics that refer to other schematics in the
+same repo.
+
+This function can can be used to override the resolution behaviour.
+
+Example:
+
+```
+  overrideCollectionResolutionForTesting({
+    '@nrwl/workspace': path.join(__dirname, '../../../../workspace/collection.json'),
+    '@nrwl/angular': path.join(__dirname, '../../../../angular/collection.json'),
+    '@nrwl/linter': path.join(__dirname, '../../../../linter/collection.json')
+  });
+
+```
+
+#### Parameters
+
+| Name          | Type     |
+| :------------ | :------- |
+| `collections` | _object_ |
+
+**Returns:** _void_
+
+---
+
+### wrapAngularDevkitSchematic
+
+▸ **wrapAngularDevkitSchematic**(`collectionName`: _string_, `generatorName`: _string_): _function_
+
+#### Parameters
+
+| Name             | Type     |
+| :--------------- | :------- |
+| `collectionName` | _string_ |
+| `generatorName`  | _string_ |
+
+**Returns:** (`host`: [_Tree_](../../node/nx-devkit/index#tree), `generatorOptions`: { [k: string]: _any_; }) => _Promise_<any\>

docs/react/api-nx-devkit/ngcli_adapter.md

@@ -0,0 +1,98 @@
+# Module: ngcli-adapter
+
+## Table of contents
+
+### Classes
+
+- [NxScopedHost](../../react/nx-devkit/ngcli_adapter#nxscopedhost)
+
+### Functions
+
+- [mockSchematicsForTesting](../../react/nx-devkit/ngcli_adapter#mockschematicsfortesting)
+- [overrideCollectionResolutionForTesting](../../react/nx-devkit/ngcli_adapter#overridecollectionresolutionfortesting)
+- [wrapAngularDevkitSchematic](../../react/nx-devkit/ngcli_adapter#wrapangulardevkitschematic)
+
+## Classes
+
+### NxScopedHost
+
+• **NxScopedHost**: _object_
+
+## Functions
+
+### mockSchematicsForTesting
+
+▸ **mockSchematicsForTesting**(`schematics`: { [name: string]: (`host`: [_Tree_](../../react/nx-devkit/index#tree), `generatorOptions`: { [k: string]: _any_; }) => _Promise_<void\>; }): _void_
+
+If you have an Nx Devkit generator invoking the wrapped Angular Devkit schematic,
+and you don't want the Angular Devkit schematic to run, you can mock it up using this function.
+
+Unfortunately, there are some edge cases in the Nx-Angular devkit integration that
+can be seen in the unit tests context. This function is useful for handling that as well.
+
+In this case, you can mock it up.
+
+Example:
+
+```
+  mockSchematicsForTesting({
+    'mycollection:myschematic': (tree, params) => {
+       tree.write('README.md');
+    }
+  });
+
+```
+
+#### Parameters
+
+| Name         | Type     |
+| :----------- | :------- |
+| `schematics` | _object_ |
+
+**Returns:** _void_
+
+---
+
+### overrideCollectionResolutionForTesting
+
+▸ **overrideCollectionResolutionForTesting**(`collections`: { [name: string]: _string_; }): _void_
+
+By default, Angular Devkit schematic collections will be resolved using the Node resolution.
+This doesn't work if you are testing schematics that refer to other schematics in the
+same repo.
+
+This function can can be used to override the resolution behaviour.
+
+Example:
+
+```
+  overrideCollectionResolutionForTesting({
+    '@nrwl/workspace': path.join(__dirname, '../../../../workspace/collection.json'),
+    '@nrwl/angular': path.join(__dirname, '../../../../angular/collection.json'),
+    '@nrwl/linter': path.join(__dirname, '../../../../linter/collection.json')
+  });
+
+```
+
+#### Parameters
+
+| Name          | Type     |
+| :------------ | :------- |
+| `collections` | _object_ |
+
+**Returns:** _void_
+
+---
+
+### wrapAngularDevkitSchematic
+
+▸ **wrapAngularDevkitSchematic**(`collectionName`: _string_, `generatorName`: _string_): _function_
+
+#### Parameters
+
+| Name             | Type     |
+| :--------------- | :------- |
+| `collectionName` | _string_ |
+| `generatorName`  | _string_ |
+
+**Returns:** (`host`: [_Tree_](../../react/nx-devkit/index#tree), `generatorOptions`: { [k: string]: _any_; }) => _Promise_<any\>

jest.config.js

@@ -27,5 +27,6 @@ module.exports = {
     '<rootDir>/nx-dev/data-access-menu',
     '<rootDir>/nx-dev/feature-search',
     '<rootDir>/nx-dev/feature-analytics',
+    '<rootDir>/typedoc-theme',
   ],
 };

nx-dev/data-access-documents/src/lib/menu.utils.ts

@@ -92,6 +92,7 @@ export function getApiSection(items: MenuItem[]): MenuSection {
         m.id === 'next' ||
         m.id === 'gatsby' ||
         m.id === 'nx-plugin' ||
+        m.id === 'nx-devkit' ||
         m.id === 'cli'
     ),
   };

nx.json

@@ -150,6 +150,9 @@
     },
     "nx-dev-feature-analytics": {
       "tags": ["scope:nx-dev", "type:feature"]
+    },
+    "typedoc-theme": {
+      "tags": []
     }
   }
 }

package.json

@@ -227,6 +227,8 @@
     "tslib": "^2.0.0",
     "tslint": "6.1.3",
     "tslint-to-eslint-config": "^2.4.0",
+    "typedoc": "^0.20.36",
+    "typedoc-plugin-markdown": "^3.8.2",
     "typescript": "4.2.4",
     "url-loader": "^3.0.0",
     "verdaccio": "^5.0.4",

scripts/documentation/documentation.ts

@@ -1,5 +1,6 @@
 import * as chalk from 'chalk';
-import { execSync } from 'child_process';
+import { execSync, exec } from 'child_process';
+import { Frameworks } from './frameworks';
 
 import { generateCLIDocumentation } from './generate-cli-data';
 import { generateExecutorsDocumentation } from './generate-executors-data';
@@ -8,6 +9,16 @@ import { generateGeneratorsDocumentation } from './generate-generators-data';
 async function generate() {
   console.log(`${chalk.blue('i')} Generating Documentation`);
 
+  execSync('nx build typedoc-theme');
+  Frameworks.forEach((framework) => {
+    execSync(
+      `rm -rf docs/${framework}/api-nx-devkit && npx typedoc packages/devkit/index.ts packages/devkit/ngcli-adapter.ts --tsconfig packages/devkit/tsconfig.lib.json --out ./docs/${framework}/api-nx-devkit --hideBreadcrumbs true --disableSources --publicPath ../../${framework}/nx-devkit/ --theme dist/typedoc-theme/src/lib`
+    );
+    execSync(
+      `rm -rf docs/${framework}/api-nx-devkit/modules.md docs/${framework}/api-nx-devkit/README.md`
+    );
+    execSync(`nx format`);
+  });
   await generateGeneratorsDocumentation();
   await generateExecutorsDocumentation();
   await generateCLIDocumentation();

tsconfig.base.json

@@ -55,7 +55,8 @@
       "@nrwl/nx-dev/feature-search": ["./nx-dev/feature-search/src/index.ts"],
       "@nrwl/nx-dev/feature-analytics": [
         "./nx-dev/feature-analytics/src/index.ts"
-      ]
+      ],
+      "@nrwl/typedoc-theme": ["/typedoc-theme/src/index.ts"]
     }
   }
 }

typedoc-theme/.babelrc

@@ -0,0 +1,3 @@
+{
+  "presets": [["@nrwl/web/babel", { "useBuiltIns": "usage" }]]
+}

typedoc-theme/.eslintrc.json

@@ -0,0 +1,21 @@
+{
+  "extends": ["../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "parserOptions": {
+        "project": ["./typedoc-theme/tsconfig.*?.json"]
+      },
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    }
+  ]
+}

typedoc-theme/README.md

@@ -0,0 +1,7 @@
+# typedoc-theme
+
+This library was generated with [Nx](https://nx.dev).
+
+## Running unit tests
+
+Run `nx test typedoc-theme` to execute the unit tests via [Jest](https://jestjs.io).

typedoc-theme/jest.config.js

@@ -0,0 +1,15 @@
+module.exports = {
+  displayName: 'typedoc-theme',
+  preset: '../jest.preset.js',
+  globals: {
+    'ts-jest': {
+      tsconfig: '<rootDir>/tsconfig.spec.json',
+    },
+  },
+  transform: {
+    '^.+\\.[tj]sx?$': 'ts-jest',
+  },
+  resolver: '../scripts/patched-jest-resolver.js',
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx'],
+  coverageDirectory: '../coverage/typedoc-theme',
+};

typedoc-theme/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "@nrwl/typedoc-theme",
+  "version": "0.0.1"
+}

typedoc-theme/src/index.ts

@@ -0,0 +1,4 @@
+import NrwlMarkdownTheme from './lib/theme';
+
+export * from './lib/theme';
+export default NrwlMarkdownTheme;

typedoc-theme/src/lib/theme.ts

@@ -0,0 +1,43 @@
+import MarkdownTheme from 'typedoc-plugin-markdown/dist/theme';
+import { ReflectionKind } from 'typedoc/dist/lib/models';
+
+/**
+ * The MarkdownTheme is based on TypeDoc's DefaultTheme @see https://github.com/TypeStrong/typedoc/blob/master/src/lib/output/themes/DefaultTheme.ts.
+ * - html specific components are removed from the renderer
+ * - markdown specefic components have been added
+ */
+
+export default class NrwlMarkdownTheme extends MarkdownTheme {
+  constructor(renderer, basePath) {
+    super(renderer, basePath);
+
+    const relativeURL = MarkdownTheme.HANDLEBARS.helpers.relativeURL;
+    NrwlMarkdownTheme.HANDLEBARS.helpers.relativeURL = function (url: string) {
+      return relativeURL(url.replace('.md', ''));
+    };
+  }
+
+  get mappings() {
+    return [
+      {
+        kind: [ReflectionKind.Module],
+        isLeaf: true,
+        directory: '.',
+        template: 'reflection.hbs',
+      },
+    ];
+  }
+
+  /**
+   * Returns the full url of a given mapping and reflection
+   * @param mapping
+   * @param reflection
+   */
+  toUrl(mapping, reflection) {
+    return (
+      (mapping.directory === '.' ? '' : mapping.directory + '/') +
+      this.getUrl(reflection) +
+      '.md'
+    );
+  }
+}

typedoc-theme/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "extends": "../tsconfig.base.json",
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    },
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ]
+}

typedoc-theme/tsconfig.lib.json

@@ -0,0 +1,13 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "target": "es2018",
+    "lib": ["es2018", "dom"],
+    "module": "commonjs",
+    "outDir": "../dist/out-tsc",
+    "declaration": true,
+    "types": []
+  },
+  "include": ["**/*.ts"],
+  "exclude": ["**/*.spec.ts"]
+}

typedoc-theme/tsconfig.spec.json

@@ -0,0 +1,15 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../dist/out-tsc",
+    "module": "commonjs",
+    "types": ["jest", "node"]
+  },
+  "include": [
+    "**/*.spec.ts",
+    "**/*.spec.tsx",
+    "**/*.spec.js",
+    "**/*.spec.jsx",
+    "**/*.d.ts"
+  ]
+}

workspace.json

@@ -2413,6 +2413,47 @@
           }
         }
       }
+    },
+    "typedoc-theme": {
+      "root": "typedoc-theme",
+      "sourceRoot": "typedoc-theme/src",
+      "projectType": "library",
+      "targets": {
+        "build-base": {
+          "executor": "@nrwl/workspace:tsc",
+          "outputs": ["{options.outputPath}"],
+          "options": {
+            "outputPath": "dist/typedoc-theme",
+            "main": "typedoc-theme/src/index.ts",
+            "tsConfig": "typedoc-theme/tsconfig.lib.json",
+            "assets": ["typedoc-theme/*.md"]
+          }
+        },
+        "build": {
+          "executor": "@nrwl/workspace:tsc",
+          "outputs": ["{options.outputPath}"],
+          "options": {
+            "outputPath": "dist/typedoc-theme",
+            "main": "typedoc-theme/src/index.ts",
+            "tsConfig": "typedoc-theme/tsconfig.lib.json",
+            "assets": ["typedoc-theme/*.md"]
+          }
+        },
+        "lint": {
+          "executor": "@nrwl/linter:eslint",
+          "options": {
+            "lintFilePatterns": ["typedoc-theme/**/*.ts"]
+          }
+        },
+        "test": {
+          "executor": "@nrwl/jest:jest",
+          "outputs": ["coverage/typedoc-theme"],
+          "options": {
+            "jestConfig": "typedoc-theme/jest.config.js",
+            "passWithNoTests": true
+          }
+        }
+      }
     }
   }
 }

yarn.lock

@@ -13019,7 +13019,7 @@ handle-thing@^2.0.0:
   resolved "https://registry.yarnpkg.com/handle-thing/-/handle-thing-2.0.1.tgz#857f79ce359580c340d43081cc648970d0bb234e"
   integrity sha512-9Qn4yBxelxoh2Ow62nP+Ka/kMnOXRi8BXnRaUwezLNhqelnN49xKz4F/dPP8OYLxLxq6JDtZb2i9XznUQbNPTg==
 
-handlebars@4.7.7, handlebars@^4.7.6:
+handlebars@4.7.7, handlebars@^4.7.6, handlebars@^4.7.7:
   version "4.7.7"
   resolved "https://registry.yarnpkg.com/handlebars/-/handlebars-4.7.7.tgz#9ce33416aad02dbd6c8fafa8240d5d98004945a1"
   integrity sha512-aAcXm5OAfE/8IXkcZvCepKU3VzW1/39Fb5ZuqMtgI/hT8X2YgoMvBY5dLhq/cpOvw7Lk1nK/UF71aLG/ZnVYRA==
@@ -16241,7 +16241,7 @@ lunr-mutable-indexes@2.3.2:
   dependencies:
     lunr ">= 2.3.0 < 2.4.0"
 
-"lunr@>= 2.3.0 < 2.4.0":
+"lunr@>= 2.3.0 < 2.4.0", 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==
@@ -16387,10 +16387,10 @@ markdown-to-jsx@^7.1.0:
   resolved "https://registry.yarnpkg.com/markdown-to-jsx/-/markdown-to-jsx-7.1.2.tgz#19d3da4cd8864045cdd13a0d179147fbd6a088d4"
   integrity sha512-O8DMCl32V34RrD+ZHxcAPc2+kYytuDIoQYjY36RVdsLK7uHjgNVvFec4yv0X6LgB4YEZgSvK5QtFi5YVqEpoMA==
 
-marked@2.0.1, marked@^2.0.1:
+marked@^2.0.3:
-  version "2.0.1"
+  version "2.0.6"
-  resolved "https://registry.yarnpkg.com/marked/-/marked-2.0.1.tgz#5e7ed7009bfa5c95182e4eb696f85e948cefcee3"
+  resolved "https://registry.yarnpkg.com/marked/-/marked-2.0.6.tgz#c3ab1403b9b70f26acd92590fc272eb1718e778c"
-  integrity sha512-5+/fKgMv2hARmMW7DOpykr2iLhl0NgjyELk5yn92iE7z8Se1IS9n3UsFm86hFXIkvMBmVxki8+ckcpjBeyo/hw==
+  integrity sha512-S2mYj0FzTQa0dLddssqwRVW4EOJOVJ355Xm2Vcbm+LU7GQRGWvwbO5K87OaPSOux2AwTSgtPPaXmc8sDPrhn2A==
 
 matcher@^4.0.0:
   version "4.0.0"
@@ -16905,7 +16905,7 @@ minimalistic-crypto-utils@^1.0.1:
   resolved "https://registry.yarnpkg.com/minimalistic-crypto-utils/-/minimalistic-crypto-utils-1.0.1.tgz#f6c00c1c0b082246e5c4d99dfb8c7c083b2b582a"
   integrity sha1-9sAMHAsIIkblxNmd+4x8CDsrWCo=
 
-"minimatch@2 || 3", minimatch@3.0.4, minimatch@^3.0.2, minimatch@^3.0.3, minimatch@^3.0.4:
+"minimatch@2 || 3", minimatch@3.0.4, minimatch@^3.0.0, minimatch@^3.0.2, minimatch@^3.0.3, minimatch@^3.0.4:
   version "3.0.4"
   resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-3.0.4.tgz#5166e286457f03306064be5497e8dbb0c3d32083"
   integrity sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==
@@ -17897,10 +17897,17 @@ onetime@^5.1.0:
   dependencies:
     mimic-fn "^2.1.0"
 
-open@8.0.2:
+onigasm@^2.2.5:
-  version "8.0.2"
+  version "2.2.5"
-  resolved "https://registry.yarnpkg.com/open/-/open-8.0.2.tgz#8c3e95cce93ba2fc8d99968ee8bfefecdb50b84f"
+  resolved "https://registry.yarnpkg.com/onigasm/-/onigasm-2.2.5.tgz#cc4d2a79a0fa0b64caec1f4c7ea367585a676892"
-  integrity sha512-NV5QmWJrTaNBLHABJyrb+nd5dXI5zfea/suWawBhkHzAbVhLLiJdrqMgxMypGK9Eznp2Ltoh7SAVkQ3XAucX7Q==
+  integrity sha512-F+th54mPc0l1lp1ZcFMyL/jTs2Tlq4SqIHKIXGZOR/VkHkF9A7Fr5rRr5+ZG/lWeRsyrClLYRq7s/yFQ/XhWCA==
+  dependencies:
+    lru-cache "^5.1.1"
+
+open@8.0.7:
+  version "8.0.7"
+  resolved "https://registry.yarnpkg.com/open/-/open-8.0.7.tgz#5597eeff14b440f6ff78fb7ced9ede9f69b2122d"
+  integrity sha512-qoyG0kpdaWVoL5MiwTRQWujSdivwBOgfLadVEdpsZNHOK1+kBvmVtLYdgWr8G4cgBpG9zaxezn6jz6PPdQW5xg==
   dependencies:
     define-lazy-prop "^2.0.0"
     is-docker "^2.1.1"
@@ -19912,7 +19919,7 @@ process@0.11.10, process@^0.11.10:
   resolved "https://registry.yarnpkg.com/process/-/process-0.11.10.tgz#7332300e840161bda3e69a1d1d91a7d4bc16f182"
   integrity sha1-czIwDoQBYb2j5podHZGn1LwW8YI=
 
-progress@^2.0.0:
+progress@^2.0.0, 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==
@@ -22047,6 +22054,14 @@ shellwords@^0.1.1:
   resolved "https://registry.yarnpkg.com/shellwords/-/shellwords-0.1.1.tgz#d6b9181c1a48d397324c84871efbcfc73fc0654b"
   integrity sha512-vFwSUfQvqybiICwZY5+DAWIPLKsWO31Q91JSKl3UYv+K5c2QRPzn0qzec6QPu1Qc9eHYItiP3NdJqNVqetYAww==
 
+shiki@^0.9.3:
+  version "0.9.3"
+  resolved "https://registry.yarnpkg.com/shiki/-/shiki-0.9.3.tgz#7bf7bcf3ed50ca525ec89cc09254abce4264d5ca"
+  integrity sha512-NEjg1mVbAUrzRv2eIcUt3TG7X9svX7l3n3F5/3OdFq+/BxUdmBOeKGiH4icZJBLHy354Shnj6sfBTemea2e7XA==
+  dependencies:
+    onigasm "^2.2.5"
+    vscode-textmate "^5.2.0"
+
 side-channel@^1.0.4:
   version "1.0.4"
   resolved "https://registry.yarnpkg.com/side-channel/-/side-channel-1.0.4.tgz#efce5c8fdc104ee751b25c58d4290011fa5ea2cf"
@@ -23940,6 +23955,35 @@ typedarray@^0.0.6:
   resolved "https://registry.yarnpkg.com/typedarray/-/typedarray-0.0.6.tgz#867ac74e3864187b1d3d47d996a78ec5c8830777"
   integrity sha1-hnrHTjhkGHsdPUfZlqeOxciDB3c=
 
+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-plugin-markdown@^3.8.2:
+  version "3.8.2"
+  resolved "https://registry.yarnpkg.com/typedoc-plugin-markdown/-/typedoc-plugin-markdown-3.8.2.tgz#47bb85d93e1f61e6a543d5acc9505e2b2f1b3d0b"
+  integrity sha512-Ci2dy1mILbDFqO09/C1i/BQiGxbIURLhNwBFHWPqhYvLuDK557ofwEhJmkgTXc6NQ6f1XrXtIWfBQtmmAmQNew==
+  dependencies:
+    handlebars "^4.7.7"
+
+typedoc@^0.20.36:
+  version "0.20.36"
+  resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.20.36.tgz#ee5523c32f566ad8283fc732aa8ea322d1a45f6a"
+  integrity sha512-qFU+DWMV/hifQ9ZAlTjdFO9wbUIHuUBpNXzv68ZyURAP9pInjZiO4+jCPeAzHVcaBCHER9WL/+YzzTt6ZlN/Nw==
+  dependencies:
+    colors "^1.4.0"
+    fs-extra "^9.1.0"
+    handlebars "^4.7.7"
+    lodash "^4.17.21"
+    lunr "^2.3.9"
+    marked "^2.0.3"
+    minimatch "^3.0.0"
+    progress "^2.0.3"
+    shelljs "^0.8.4"
+    shiki "^0.9.3"
+    typedoc-default-themes "^0.12.10"
+
 typescript@4.2.4:
   version "4.2.4"
   resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.2.4.tgz#8610b59747de028fda898a8aef0e103f156d0961"
@@ -24537,6 +24581,11 @@ void-elements@^2.0.0:
   resolved "https://registry.yarnpkg.com/void-elements/-/void-elements-2.0.1.tgz#c066afb582bb1cb4128d60ea92392e94d5e9dbec"
   integrity sha1-wGavtYK7HLQSjWDqkjkulNXp2+w=
 
+vscode-textmate@^5.2.0:
+  version "5.4.0"
+  resolved "https://registry.yarnpkg.com/vscode-textmate/-/vscode-textmate-5.4.0.tgz#4b25ffc1f14ac3a90faf9a388c67a01d24257cd7"
+  integrity sha512-c0Q4zYZkcLizeYJ3hNyaVUM2AA8KDhNCA3JvXY8CeZSJuBdAy3bAvSbv46RClC4P3dSO9BdwhnKEx2zOo6vP/w==
+
 w3c-hr-time@^1.0.1, w3c-hr-time@^1.0.2:
   version "1.0.2"
   resolved "https://registry.yarnpkg.com/w3c-hr-time/-/w3c-hr-time-1.0.2.tgz#0a89cdf5cc15822df9c360543676963e0cc308cd"