docusaurus-plugin-typedoc 1.0.0-next.3 → 1.0.0-next.30

package/README.md

@@ -1,298 +1,15 @@
 # docusaurus-plugin-typedoc
 
-A [Docusaurus v2](https://v2.docusaurus.io/) plugin to build documentation with [TypeDoc](https://github.com/TypeStrong/typedoc).
+![npm](https://img.shields.io/npm/v/docusaurus-plugin-typedoc%2Fnext?&logo=npm) [![Build Status](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.yml/badge.svg?branch=next)](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.yml)
 
-[![npm](https://img.shields.io/npm/v/docusaurus-plugin-typedoc.svg)](https://www.npmjs.com/package/docusaurus-plugin-typedoc)
-![CI](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.yml/badge.svg?branch=master)
-
-## What it does?
-
-Generates static TypeDoc pages in Markdown with frontmatter as part of the Docusaurus build.
+A Docusaurus plugin to integrate TypeDoc ( + typedoc-plugin-markdown ) into a Docusaurus project.
 
 ## Installation
 
-> Install [Docusaurus](https://v2.docusaurus.io/docs/installation) in the root of your project and install the plugin dependencies in the same location as the Docusaurus website directory.
-
 ```shell
-npm install typedoc typedoc-plugin-markdown docusaurus-plugin-typedoc --save-dev
-```
-
-## Usage
-
-### Config
-
-Add the plugin to `docusaurus.config.js` and specify the required options (see [options](#options)).
-
-```js
-module.exports = {
-  plugins: [
-    [
-      'docusaurus-plugin-typedoc',
-
-      // Plugin / TypeDoc options
-      {
-        entryPoints: ['../src/index.ts'],
-        tsconfig: '../tsconfig.json',
-      },
-    ],
-  ],
-};
-```
-
-TypeDoc will be bootstraped with the Docusaurus `start` and `build` [cli commands](https://v2.docusaurus.io/docs/cli):
-
-```javascript
-"start": "docusaurus start",
-"build": "docusaurus build",
-```
-
-Once built the docs will be available at `/docs/api` (or equivalent out directory).
-
-### Directory structure
-
-```
-├── docusauruss-website
-    ├── build/ (static site dir)
-    ├── docs/
-    │   ├── api/ (compiled typedoc markdown)
-    ├── docusaurus.config.js
-    ├── package.json
-    ├── sidebars.js
-├──package.json
-├──src (typescript source files)
-├──tsconfig.json
-```
-
-## Options
-
-### TypeDoc options
-
-To configure TypeDoc, pass any relevant [TypeDoc options](https://typedoc.org/guides/options/) to the config.
-
-At a minimum the `entryPoints` and `tsconfig` options will need to be set.
-
-```js
-entryPoints: ['../src/index.ts'],
-tsconfig: '../tsconfig.json'
-```
-
-Additional TypeDoc plugins will need to be explicitly set:
-
-```js
-plugin: ['typedoc-plugin-xyz'];
-```
-
-#### Other config options
-
-TypeDoc options can also be declared:
-
-- Using a `typedoc.json` file.
-- Under the `typedocOptions` key in `tsconfig.json`.
-
-> Note: Options declared in this manner will take priority and overwrite options declared in `docusaurus.config.js`.
-
-### Plugin options
-
-Options specific to the plugin should also be declared in the same object.
-
-| Name                    | Default | Description                                              |
-| :---------------------- | :------ | :------------------------------------------------------- |
-| `out`                   | `"api"` | Output dir relative to docs dir (use `.` for no subdir). |
-| `sidebar.categoryLabel` | `API`   | The sidebar parent category label.                       |
-| `sidebar.fullNames`     | `false` | Display full names with module path.                     |
-| `sidebar.position`      | `auto`  | The position of the sidebar in the tree.                 |
-
-### An example configuration
-
-```js
-module.exports = {
-  plugins: [
-    [
-      'docusaurus-plugin-typedoc',
-      {
-        // TypeDoc options
-        entryPoints: ['../src/index.ts'],
-        tsconfig: '../tsconfig.json',
-        plugin: ['typedoc-plugin-xyz'],
-
-        // Plugin options
-        out: 'api-xyz',
-        sidebar: {
-          categoryLabel: 'API XYZ',
-          position: 0,
-          fullNames: true,
-        },
-      },
-    ],
-  ],
-};
-```
-
-## Recipes
-
-### Sidebar and Navbar
-
-#### Sidebar
-
-`sidebars.js` can be configured in following ways:
-
-1. Generate the entire sidebar from file structure of your docs folder (default behaviour):
-
-```js
-module.exports = {
-  sidebar: [
-    {
-      type: 'autogenerated',
-      dirName: '.', // '.' means the docs folder
-    },
-  ],
-};
-```
-
-2. Alternatively, if you wish to manually control other parts of your sidebar you can use a slice for the TypeDoc sidebar.
-
-> note: `sidebar.categoryLabel` and `sidebar.position` options are ignored with this implementation)
-
-```js
-module.exports = {
-  sidebar: {
-    'Category 1': ['doc1', 'doc2', 'doc3'],
-    API: [
-      {
-        type: 'autogenerated',
-        dirName: 'api', // 'api' is the 'out' directory
-      },
-    ],
-  },
-};
-```
-
-Please see https://docusaurus.io/docs/sidebar for sidebar documentation.
-
-#### Navbar
-
-A navbar item can be configured in `themeConfig` options in `docusaurus.config.js`:
-
-```js
- themeConfig: {
-    navbar: {
-      items: [
-        {
-        to: 'docs/api/',  // 'api' is the 'out' directory
-        activeBasePath: 'docs',
-        label: 'API',
-        position: 'left',
-      },
-    ],
-  },
-},
-```
-
-Please see https://docusaurus.io/docs/api/themes/configuration#navbar-items for navbar documentation.
-
-### Frontmatter
-
-By default the plugin will configure minimal required [Frontmatter](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs#markdown-front-matter) configuration.
-Additionally required global Frontmatter options can be passed in using the `frontmatterGlobals` options object
-
-`docusaurus.config.js`:
-
-```js
-plugins: [
-    [
-      'docusaurus-plugin-typedoc',
-      {
-      // .... other plugin option
-      frontmatterGlobals: {
-        pagination_prev: null,
-        pagination_next: null
-      }
-    ]
-]
-```
-
-### Multi instance
-
-It is possible to build multi TypeDoc instances by passing in multiple configs with unique ids:
-
-`docusaurus.config.js`
-
-```js
-module.exports = {
-  plugins: [
-    [
-      'docusaurus-plugin-typedoc',
-      {
-        id: 'api-1',
-        entryPoints: ['../api-1/src/index.ts'],
-        tsconfig: '../api-1/tsconfig.json',
-        out: 'api-1',
-      },
-    ],
-    [
-      'docusaurus-plugin-typedoc',
-      {
-        id: 'api-2',
-        entryPoints: ['../api-2/src/index.ts'],
-        tsconfig: '../api-2/tsconfig.json',
-        out: 'api-2',
-      },
-    ],
-  ],
-};
-```
-
-### Watch mode
-
-Watching files is supported by passing in the `watch: true` option see [https://typedoc.org/guides/options/#watch](https://typedoc.org/guides/options/#watch).
-
-Targetting the option in development mode only can be achieved using Node.js Environment Variables:
-
-`package.json`
-
-```json
-"start": "TYPEDOC_WATCH=true docusaurus start",
-"build": "TYPEDOC_WATCH=false docusaurus build",
-```
-
-`docusaurus.config.js`
-
-```js
-module.exports = {
-  plugins: [
-    [
-      'docusaurus-plugin-typedoc',
-      {
-        entryPoints: ['../src/index.ts'],
-        tsconfig: '../tsconfig.json',
-        watch: process.env.TYPEDOC_WATCH,
-      },
-    ],
-  ],
-};
-```
-
-### Monorepo setup
-
-`docusaurus.config.js`
-
-```js
-module.exports = {
-  plugins: [
-    [
-      'docusaurus-plugin-typedoc',
-      {
-        entryPoints: ['../packages/package-a', '../packages/package-b'],
-        entryPointStrategy: 'packages',
-        sidebar: {
-          fullNames: true,
-        },
-      },
-    ],
-  ],
-};
-```
+  npm install docusaurus-plugin-typedoc --save-dev
+  ```
 
-## License
+## Documentation
 
-[MIT](https://github.com/tgreyuk/typedoc-plugin-markdown/blob/master/packages/docusaurus-plugin-typedoc/LICENSE)
+Please visit [typedoc-plugin-markdown.org](https://typedoc-plugin-markdown.org/plugins/docusaurus) for comprehensive documentation, including options and usage guides.

package/dist/index.d.ts

@@ -1 +1,2 @@
+export { PluginOptions } from './models';
 export { default } from './plugin';

package/dist/models.d.ts

@@ -0,0 +1,5 @@
+import { PluginOptions as TypedocPluginMarkdownOptions } from 'typedoc-plugin-markdown';
+import { PluginOptions as DocusaurusOptions } from './options/option-types';
+export interface PluginOptions extends TypedocPluginMarkdownOptions, DocusaurusOptions {
+    id: string;
+}

package/dist/options/declarations.d.ts

@@ -0,0 +1,21 @@
+import { ParameterType } from 'typedoc';
+/**
+ * **sidebar.autoConfiguration**
+ *
+ * Set to `false` to disable sidebar generation. Defaults to `true`.
+ *
+ * **sidebar.pretty**
+ *
+ * Pretty format the sidebar JSON.
+ *
+ * Please see the [sidebar guide](/plugins/docusaurus/guide/sidebar) for additional information on sidebar setup.
+ *
+ */
+export declare const sidebar: {
+    help: string;
+    type: ParameterType;
+    defaultValue: {
+        autoConfiguration: boolean;
+        pretty: boolean;
+    };
+};

package/dist/options/declarations.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sidebar = void 0;
+const typedoc_1 = require("typedoc");
+const options_1 = require("../options");
+/**
+ * **sidebar.autoConfiguration**
+ *
+ * Set to `false` to disable sidebar generation. Defaults to `true`.
+ *
+ * **sidebar.pretty**
+ *
+ * Pretty format the sidebar JSON.
+ *
+ * Please see the [sidebar guide](/plugins/docusaurus/guide/sidebar) for additional information on sidebar setup.
+ *
+ */
+exports.sidebar = {
+    help: 'Configures the autogenerated Docusaurus sidebar.',
+    type: typedoc_1.ParameterType.Mixed,
+    defaultValue: options_1.DEFAULT_SIDEBAR_OPTIONS,
+};

package/dist/options/option-types.d.ts

@@ -0,0 +1,26 @@
+import { ManuallyValidatedOption } from 'typedoc';
+declare module 'typedoc' {
+    interface TypeDocOptionMap {
+        sidebar: ManuallyValidatedOption<Sidebar>;
+    }
+}
+/**
+ * Describes the options declared by the plugin.
+ *
+ * @category Options
+ */
+export interface PluginOptions {
+    /**
+     * Configures the autogenerated Docusaurus sidebar.
+     */
+    sidebar: Sidebar;
+}
+/**
+ *
+ *
+ * @category Options
+ */
+export interface Sidebar {
+    autoConfiguration: boolean;
+    pretty: boolean;
+}

package/dist/options/option-types.js

@@ -0,0 +1,3 @@
+"use strict";
+// THIS FILE IS AUTO GENERATED FROM THE OPTIONS CONFIG. DO NOT EDIT DIRECTLY.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/options/presets.d.ts

@@ -0,0 +1,8 @@
+declare const _default: {
+    out: string;
+    hideBreadcrumbs: boolean;
+    hidePageHeader: boolean;
+    entryFileName: string;
+    plugin: string[];
+};
+export default _default;

package/dist/options/presets.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = {
+    out: './docs/api',
+    hideBreadcrumbs: true,
+    hidePageHeader: true,
+    entryFileName: 'index.md',
+    plugin: ['typedoc-plugin-markdown'],
+};

package/dist/options.d.ts

@@ -1,2 +1,5 @@
-import { PluginOptions } from './types';
-export declare const getPluginOptions: (opts: Partial<PluginOptions>) => PluginOptions;
+export declare const DEFAULT_SIDEBAR_OPTIONS: {
+    autoConfiguration: boolean;
+    pretty: boolean;
+};
+export declare function getPluginOptions(opts: Record<string, any>): Record<string, any>;

package/dist/options.js

@@ -1,29 +1,22 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getPluginOptions = void 0;
+exports.getPluginOptions = exports.DEFAULT_SIDEBAR_OPTIONS = void 0;
+const presets_1 = __importDefault(require("./options/presets"));
+exports.DEFAULT_SIDEBAR_OPTIONS = {
+    autoConfiguration: true,
+    pretty: false,
+};
 const DEFAULT_PLUGIN_OPTIONS = {
+    ...presets_1.default,
     id: 'default',
-    docsRoot: 'docs',
-    out: 'api',
-    cleanOutputDir: true,
     sidebar: {
-        fullNames: false,
-        categoryLabel: 'API',
-        collapsed: true,
-        indexLabel: 'Overview',
-        position: null,
-        autoConfiguration: true,
+        ...exports.DEFAULT_SIDEBAR_OPTIONS,
     },
-    hideInPageTOC: true,
-    hideBreadcrumbs: true,
-    hidePageTitle: false,
-    entryDocument: 'index.md',
-    plugin: ['none'],
-    watch: false,
-    theme: 'docusaurus',
-    enableFrontmatter: true,
 };
-const getPluginOptions = (opts) => {
+function getPluginOptions(opts) {
     const options = {
         ...DEFAULT_PLUGIN_OPTIONS,
         ...opts,
@@ -31,7 +24,10 @@ const getPluginOptions = (opts) => {
             ...DEFAULT_PLUGIN_OPTIONS.sidebar,
             ...opts.sidebar,
         },
+        plugin: [
+            ...new Set([...DEFAULT_PLUGIN_OPTIONS.plugin, ...(opts.plugin || [])]),
+        ],
     };
     return options;
-};
+}
 exports.getPluginOptions = getPluginOptions;

package/dist/plugin.d.ts

@@ -1,6 +1,5 @@
-import { PluginOptions } from './types';
-export default function pluginDocusaurus(context: any, opts: Partial<PluginOptions>): {
+import { PluginOptions } from '.';
+export default function pluginDocusaurus(context: any, opts: Partial<PluginOptions>): Promise<{
     name: string;
-    loadContent(): Promise<void>;
     extendCli(cli: any): void;
-};
+}>;

package/dist/plugin.js

@@ -23,29 +23,29 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const typedoc_1 = require("typedoc");
-const typedoc_plugin_markdown_1 = require("typedoc-plugin-markdown");
 const options_1 = require("./options");
-const render_1 = require("./render");
-const theme_1 = require("./theme");
+const options = __importStar(require("./options/declarations"));
+const sidebar_1 = require("./sidebar");
+// store list of plugin ids when running multiple instances
 const apps = [];
-function pluginDocusaurus(context, opts) {
+async function pluginDocusaurus(context, opts) {
+    const PLUGIN_NAME = 'docusaurus-plugin-typedoc';
+    if (opts.id && !apps.includes(opts.id)) {
+        apps.push(opts.id);
+        await generateTypedoc(context, opts);
+    }
     return {
-        name: 'docusaurus-plugin-typedoc',
-        async loadContent() {
-            if (opts.id && !apps.includes(opts.id)) {
-                apps.push(opts.id);
-                generateTypedoc(context, opts);
-            }
-        },
+        name: PLUGIN_NAME,
         extendCli(cli) {
             cli
                 .command('generate-typedoc')
-                .description('(docusaurus-plugin-typedoc) Generate TypeDoc docs independently of the Docusaurus build process.')
+                .description(`[${PLUGIN_NAME}] Generate TypeDoc docs independently of the Docusaurus build process.`)
                 .action(async () => {
-                var _a;
-                (_a = context.siteConfig) === null || _a === void 0 ? void 0 : _a.plugins.forEach((pluginConfig) => {
+                context.siteConfig?.plugins.forEach((pluginConfig) => {
+                    // Check PluginConfig is typed to [string, PluginOptions]
                     if (pluginConfig && typeof pluginConfig[1] === 'object') {
                         generateTypedoc(context, pluginConfig[1]);
                     }
@@ -55,22 +55,49 @@ function pluginDocusaurus(context, opts) {
     };
 }
 exports.default = pluginDocusaurus;
+/**
+ * Initiates a new typedoc Application bootstrapped with plugin options
+ */
 async function generateTypedoc(context, opts) {
     const { siteDir } = context;
-    const options = (0, options_1.getPluginOptions)(opts);
-    const outputDir = path.resolve(siteDir, options.docsRoot, options.out);
-    if (opts.cleanOutputDir) {
-        (0, render_1.removeDir)(outputDir);
+    const pluginOptions = (0, options_1.getPluginOptions)(opts);
+    const { id, sidebar, ...optionsPassedToTypeDoc } = pluginOptions;
+    const app = await typedoc_1.Application.bootstrapWithPlugins(optionsPassedToTypeDoc);
+    Object.entries(options).forEach(([name, option]) => {
+        app.options.addDeclaration({
+            name,
+            ...option,
+        });
+    });
+    const outputDir = app.options.getValue('out');
+    if (sidebar?.autoConfiguration) {
+        const docsPreset = context.siteConfig?.presets?.find((preset) => Boolean(preset[1]?.docs));
+        app.renderer.postRenderAsyncJobs.push(async (output) => {
+            if (output.navigation) {
+                const sidebarPath = path.resolve(outputDir, 'typedoc-sidebar.cjs');
+                const baseDir = path
+                    .relative(siteDir, outputDir)
+                    .split(path.sep)
+                    .slice(1)
+                    .join(path.sep);
+                const sidebarJson = (0, sidebar_1.getSidebar)(output.navigation, baseDir, docsPreset ? docsPreset[1]?.docs?.numberPrefixParser : null);
+                fs.writeFileSync(sidebarPath, `// @ts-check
+/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
+const typedocSidebar = { items: ${JSON.stringify(sidebarJson, null, sidebar.pretty ? 2 : 0)}};
+module.exports = typedocSidebar.items;`);
+            }
+        });
     }
-    const app = new typedoc_1.Application();
-    app.renderer.defineTheme('docusaurus', theme_1.DocusaurusTheme);
-    (0, typedoc_plugin_markdown_1.load)(app);
-    (0, render_1.bootstrap)(app, options);
-    const project = app.convert();
+    const project = await app.convert();
+    // if project is undefined typedoc has a problem - error logging will be supplied by typedoc.
     if (!project) {
-        return;
+        if (app.options.getValue('skipErrorChecking')) {
+            return;
+        }
+        console.error('[docusaurus-plugin-typedoc] TypeDoc exited with an error. Use the "skipErrorChecking" option to disable TypeDoc error checking.');
+        process.exit(1);
     }
-    if (options.watch) {
+    if (app.options.getValue('watch')) {
         app.convertAndWatch(async (project) => {
             await app.generateDocs(project, outputDir);
         });

package/dist/sidebar.d.ts

@@ -0,0 +1,2 @@
+import { NavigationItem } from 'typedoc-plugin-markdown';
+export declare function getSidebar(navigation: NavigationItem[], basePath: string, numberPrefixParser?: any): any;

package/dist/sidebar.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSidebar = void 0;
+function getSidebar(navigation, basePath, numberPrefixParser) {
+    return navigation
+        .map((navigationItem) => getNavigationItem(navigationItem, basePath, numberPrefixParser))
+        .filter((navItem) => Boolean(navItem));
+}
+exports.getSidebar = getSidebar;
+function getNavigationItem(navigationItem, basePath, numberPrefixParser) {
+    const parsedUrl = numberPrefixParser === false
+        ? navigationItem.path
+        : navigationItem.path?.replace(/\d+\-/g, '');
+    const getId = () => {
+        const idParts = [];
+        if (basePath.length > 0) {
+            idParts.push(basePath);
+        }
+        if (parsedUrl) {
+            idParts.push(parsedUrl.replace(/\\/g, '/'));
+        }
+        if (navigationItem.path) {
+            return idParts.join('/').replace(/(.*)\.\w+$/, '$1');
+        }
+        return null;
+    };
+    const id = getId();
+    if (navigationItem.children?.length) {
+        return {
+            type: 'category',
+            label: `${navigationItem.title}`,
+            items: getSidebar(navigationItem.children, basePath, numberPrefixParser),
+            ...(id && {
+                link: {
+                    type: 'doc',
+                    id,
+                },
+            }),
+        };
+    }
+    return id
+        ? {
+            type: 'doc',
+            id,
+            label: `${navigationItem.title}`,
+        }
+        : null;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-typedoc",
-  "version": "1.0.0-next.3",
-  "description": "A Docusaurus v2 plugin to build API documentation with TypeDoc.",
+  "version": "1.0.0-next.30",
+  "description": "A Docusaurus plugin to integrate TypeDoc ( + typedoc-plugin-markdown ) into a Docusaurus project.",
   "main": "dist/index.js",
   "files": [
     "dist/"
@@ -16,15 +16,16 @@
   },
   "homepage": "https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/docusaurus-plugin-typedoc",
   "peerDependencies": {
-    "typedoc": ">=0.23.0",
-    "typedoc-plugin-markdown": ">=4.0.0-next.4"
+    "typedoc-plugin-markdown": ">=4.0.0-next.45"
   },
   "scripts": {
     "lint": "eslint ./src --ext .ts",
-    "prepublishOnly": "npm run lint && npm run build && npm run test",
-    "build": "rm -rf ./dist && tsc",
-    "build-and-test": "npm run build && npm run test",
-    "test": "jest --colors"
+    "prebuild": "rm -rf dist && prebuild-options",
+    "prepublishOnly": "npm run lint && npm run build",
+    "build": "tsc",
+    "pretest": "rm -rf ./test/out && docusaurus generate-typedoc",
+    "test": "jest",
+    "test:update": "npm run build && npm test -- -u"
   },
   "author": "Thomas Grey",
   "license": "MIT",
@@ -35,5 +36,9 @@
     "markdown",
     "typescript",
     "api"
-  ]
+  ],
+  "devDependencies": {
+    "@docusaurus/core": "^3.2.1",
+    "@docusaurus/types": "^3.2.1"
+  }
 }

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2016 Thomas Grey
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/dist/navigation.d.ts

@@ -1,13 +0,0 @@
-import { ReflectionKind } from 'typedoc';
-export declare const CATEGORY_POSITION: {
-    2: number;
-    4: number;
-    8: number;
-    128: number;
-    256: number;
-    4194304: number;
-    32: number;
-    64: number;
-    2097152: number;
-};
-export declare function getKindPlural(kind: ReflectionKind): string;

package/dist/navigation.js

@@ -1,36 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getKindPlural = exports.CATEGORY_POSITION = void 0;
-const typedoc_1 = require("typedoc");
-const PLURALS = {
-    [typedoc_1.ReflectionKind.Class]: 'Classes',
-    [typedoc_1.ReflectionKind.Property]: 'Properties',
-    [typedoc_1.ReflectionKind.Enum]: 'Enumerations',
-    [typedoc_1.ReflectionKind.EnumMember]: 'Enumeration members',
-    [typedoc_1.ReflectionKind.TypeAlias]: 'Type aliases',
-};
-exports.CATEGORY_POSITION = {
-    [typedoc_1.ReflectionKind.Module]: 1,
-    [typedoc_1.ReflectionKind.Namespace]: 1,
-    [typedoc_1.ReflectionKind.Enum]: 2,
-    [typedoc_1.ReflectionKind.Class]: 3,
-    [typedoc_1.ReflectionKind.Interface]: 4,
-    [typedoc_1.ReflectionKind.TypeAlias]: 5,
-    [typedoc_1.ReflectionKind.Variable]: 6,
-    [typedoc_1.ReflectionKind.Function]: 7,
-    [typedoc_1.ReflectionKind.ObjectLiteral]: 8,
-};
-function getKindPlural(kind) {
-    if (kind in PLURALS) {
-        return PLURALS[kind];
-    }
-    else {
-        return getKindString(kind) + 's';
-    }
-}
-exports.getKindPlural = getKindPlural;
-function getKindString(kind) {
-    let str = typedoc_1.ReflectionKind[kind];
-    str = str.replace(/(.)([A-Z])/g, (_m, a, b) => a + ' ' + b.toLowerCase());
-    return str;
-}

package/dist/render.d.ts

@@ -1,5 +0,0 @@
-import { Application, ProjectReflection } from 'typedoc';
-import { PluginOptions } from './types';
-export declare const bootstrap: (app: Application, options: PluginOptions) => void;
-export declare function render(project: ProjectReflection, outputDirectory: string): Promise<void>;
-export declare function removeDir(path: string): void;

package/dist/render.js

@@ -1,81 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.removeDir = exports.render = exports.bootstrap = void 0;
-const fs = __importStar(require("fs"));
-const typedoc_1 = require("typedoc");
-const bootstrap = (app, options) => {
-    addTypedocReaders(app);
-    addTypedocDeclarations(app);
-    app.renderer.render = render;
-    app.bootstrap(options);
-};
-exports.bootstrap = bootstrap;
-async function render(project, outputDirectory) {
-    var _a;
-    if (!this.prepareTheme()) {
-        return;
-    }
-    const output = new typedoc_1.RendererEvent(typedoc_1.RendererEvent.BEGIN, outputDirectory, project);
-    output.urls = this.theme.getUrls(project);
-    this.trigger(output);
-    await Promise.all(this.preRenderAsyncJobs.map((job) => job(output)));
-    this.preRenderAsyncJobs = [];
-    if (!output.isDefaultPrevented) {
-        (_a = output.urls) === null || _a === void 0 ? void 0 : _a.forEach((mapping) => {
-            this.renderDocument(...output.createPageEvent(mapping));
-        });
-        await Promise.all(this.postRenderAsyncJobs.map((job) => job(output)));
-        this.postRenderAsyncJobs = [];
-        this.trigger(typedoc_1.RendererEvent.END, output);
-    }
-}
-exports.render = render;
-const addTypedocReaders = (app) => {
-    app.options.addReader(new typedoc_1.TypeDocReader());
-    app.options.addReader(new typedoc_1.TSConfigReader());
-};
-const addTypedocDeclarations = (app) => {
-    app.options.addDeclaration({
-        name: 'id',
-    });
-    app.options.addDeclaration({
-        name: 'docsRoot',
-    });
-    app.options.addDeclaration({
-        name: 'siteDir',
-    });
-    app.options.addDeclaration({
-        name: 'globalsTitle',
-    });
-    app.options.addDeclaration({
-        name: 'sidebar',
-        type: typedoc_1.ParameterType.Mixed,
-    });
-};
-function removeDir(path) {
-    fs.rmSync(path, { recursive: true, force: true });
-}
-exports.removeDir = removeDir;

package/dist/theme-context.d.ts

@@ -1,11 +0,0 @@
-import { DeclarationReflection, PageEvent, Reflection } from 'typedoc';
-import { MarkdownThemeRenderContext } from 'typedoc-plugin-markdown';
-export declare class DocusaurusThemeRenderContext extends MarkdownThemeRenderContext {
-    baseFrontmatterVars: (page: PageEvent<Reflection>) => {
-        sidebar_position?: number | undefined;
-        sidebar_label?: string | undefined;
-        title: string;
-    };
-    getSidebarLabel(page: PageEvent<DeclarationReflection>): string | null | undefined;
-    getSidebarPosition(page: PageEvent<DeclarationReflection>): "0.5" | "0" | null;
-}

package/dist/theme-context.js

@@ -1,43 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DocusaurusThemeRenderContext = void 0;
-const typedoc_plugin_markdown_1 = require("typedoc-plugin-markdown");
-class DocusaurusThemeRenderContext extends typedoc_plugin_markdown_1.MarkdownThemeRenderContext {
-    constructor() {
-        super(...arguments);
-        this.baseFrontmatterVars = (page) => {
-            const sidebarPosition = parseFloat(this.getSidebarPosition(page));
-            const sidebarLabel = this.getSidebarLabel(page);
-            return {
-                ...this.getBaseFrontmatterVars(page),
-                ...(this.options.getValue('sidebar').autoConfiguration
-                    ? {
-                        ...(sidebarLabel && { sidebar_label: sidebarLabel }),
-                        ...(sidebarPosition && {
-                            sidebar_position: sidebarPosition,
-                        }),
-                    }
-                    : {}),
-            };
-        };
-    }
-    getSidebarLabel(page) {
-        if (page.url === this.options.getValue('entryDocument')) {
-            return this.options.getValue('sidebar').indexLabel;
-        }
-        return null;
-    }
-    getSidebarPosition(page) {
-        if (page.url === this.options.getValue('entryDocument')) {
-            return page.url === page.project.url ? '0.5' : '0';
-        }
-        if (page.url === this.globalsFile) {
-            return '0.5';
-        }
-        if (page.model.getFullName().split('.').length === 1) {
-            return '0';
-        }
-        return null;
-    }
-}
-exports.DocusaurusThemeRenderContext = DocusaurusThemeRenderContext;

package/dist/theme.d.ts

@@ -1,13 +0,0 @@
-import { DeclarationReflection, PageEvent, Renderer, RendererEvent } from 'typedoc';
-import { MarkdownTheme } from 'typedoc-plugin-markdown';
-import { SidebarOptions } from './types';
-export declare class DocusaurusTheme extends MarkdownTheme {
-    sidebar: SidebarOptions;
-    private _contextCache?;
-    constructor(renderer: Renderer);
-    getRenderContext(): any;
-    onPageEnd(page: PageEvent<DeclarationReflection>): void;
-    onRendererEnd(renderer: RendererEvent): void;
-    loopAndWriteCategories(path: string): void;
-    writeCategoryYaml: (categoryPath: string, label: string, position: number | null, collapsed: boolean) => void;
-}

package/dist/theme.js

@@ -1,97 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DocusaurusTheme = void 0;
-const fs = __importStar(require("fs"));
-const typedoc_1 = require("typedoc");
-const typedoc_plugin_markdown_1 = require("typedoc-plugin-markdown");
-const navigation_1 = require("./navigation");
-const theme_context_1 = require("./theme-context");
-class DocusaurusTheme extends typedoc_plugin_markdown_1.MarkdownTheme {
-    constructor(renderer) {
-        super(renderer);
-        this.writeCategoryYaml = (categoryPath, label, position, collapsed) => {
-            const yaml = [`label: "${label}"`];
-            if (position !== null) {
-                yaml.push(`position: ${position}`);
-            }
-            if (!collapsed) {
-                yaml.push(`collapsed: false`);
-            }
-            if (fs.existsSync(categoryPath)) {
-                fs.writeFileSync(categoryPath + '/_category_.yml', yaml.join('\n'));
-            }
-        };
-        this.listenTo(this.application.renderer, {
-            [typedoc_1.PageEvent.END]: this.onPageEnd,
-            [typedoc_1.RendererEvent.END]: this.onRendererEnd,
-        });
-    }
-    getRenderContext() {
-        this._contextCache || (this._contextCache = new theme_context_1.DocusaurusThemeRenderContext(this, this.application.options));
-        return this._contextCache;
-    }
-    onPageEnd(page) {
-        if (page.contents) {
-            page.contents = page.contents.replace(/\\</g, '<');
-        }
-    }
-    onRendererEnd(renderer) {
-        if (this.sidebar.autoConfiguration) {
-            this.writeCategoryYaml(renderer.outputDirectory, this.sidebar.categoryLabel, this.sidebar.position, this.sidebar.collapsed);
-            this.loopAndWriteCategories(renderer.outputDirectory);
-        }
-    }
-    loopAndWriteCategories(path) {
-        const directory = fs.readdirSync(path);
-        directory.forEach((segment) => {
-            const fullPath = `${path}/${segment}`;
-            const isDirectory = fs.lstatSync(fullPath).isDirectory();
-            if (isDirectory) {
-                const mapping = Object.entries(this.mappings)
-                    .filter((entry) => {
-                    return entry[1].directory === segment;
-                })
-                    .map((entry) => entry[1])[0];
-                const subdirectory = fs.readdirSync(fullPath);
-                const containsDir = subdirectory.some((item) => fs.lstatSync(`${fullPath}/${item}`).isDirectory());
-                if (mapping && !containsDir) {
-                    this.writeCategoryYaml(fullPath, (0, navigation_1.getKindPlural)(mapping.kind), navigation_1.CATEGORY_POSITION[mapping.kind], true);
-                }
-                this.loopAndWriteCategories(fullPath);
-            }
-        });
-    }
-}
-__decorate([
-    (0, typedoc_1.BindOption)('sidebar')
-], DocusaurusTheme.prototype, "sidebar", void 0);
-exports.DocusaurusTheme = DocusaurusTheme;

package/dist/types.d.ts

@@ -1,36 +0,0 @@
-export interface PluginOptions {
-    id: string;
-    docsRoot: string;
-    out: string;
-    sidebar: SidebarOptions;
-    readmeTitle?: string;
-    globalsTitle?: string;
-    plugin: string[];
-    readme?: string;
-    disableOutputCheck?: boolean;
-    cleanOutputDir?: boolean;
-    entryPoints?: string[];
-    watch: boolean;
-    hideInPageTOC: boolean;
-    hideBreadcrumbs: boolean;
-    hidePageTitle: boolean;
-    entryDocument: string;
-    includeExtension?: boolean;
-    theme?: string;
-    enableFrontmatter: boolean;
-}
-export type FrontMatter = Record<string, string | boolean | number | null> | undefined;
-export interface SidebarOptions {
-    fullNames?: boolean;
-    categoryLabel: string;
-    collapsed: boolean;
-    indexLabel?: string;
-    position: number | null;
-    autoConfiguration: boolean;
-}
-export interface SidebarCategory {
-    type: string;
-    label: string;
-    items: SidebarItem[];
-}
-export type SidebarItem = SidebarCategory | string;