fix typedoc generation

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

.gitignore

@@ -5,3 +5,4 @@ yarn-error.log
 coverage/
 tmp/
 site/
+docs/extensions/api/

docs/extensions/typedoc-readme.md.tpl

@@ -1,7 +1,11 @@
 # Extension API Reference
 
+```
+npm install --save-dev @k8slens/extensions
+```
+
 ## APIs
 
-- [Common](modules/Common.md)
+- [Common](modules/core_src_common_library.extensionApi.md)
-- [Main](modules/Main.md)
+- [Main](modules/core_src_main_library.extensionApi.md)
-- [Renderer](modules/Renderer.md)
+- [Renderer](modules/core_src_renderer_library.extensionApi.md)

packages/core/src/common/user-store/preferences-helpers.ts

@@ -23,7 +23,7 @@ export const defaultTerminalConfig: TerminalConfig = {
   fontFamily: defaultTerminalFontFamily,
 };
 
-interface BaseEditorConfiguration extends Required<Pick<editor.IStandaloneEditorConstructionOptions, "minimap" | "tabSize" | "fontSize" | "fontFamily">> {
+export interface BaseEditorConfiguration extends Required<Pick<editor.IStandaloneEditorConstructionOptions, "minimap" | "tabSize" | "fontSize" | "fontFamily">> {
   lineNumbers: NonNullable<Exclude<editor.IStandaloneEditorConstructionOptions["lineNumbers"], Function>>;
 }
 

packages/core/src/extensions/common-api/index.ts

@@ -14,6 +14,9 @@ import * as Proxy from "./proxy";
 
 import logger from "../../common/logger";
 
+/**
+ * @module Common
+ */
 export {
   App,
   EventBus,

packages/core/src/features/application-update/child-features/application-update-using-top-bar/renderer/update-application-top-bar-item/update-button/update-button.tsx

@@ -17,7 +17,7 @@ import type { IComputedValue } from "mobx";
 import restartAndInstallUpdateInjectable from "../../../../../renderer/restart-and-install-update.injectable";
 import updateWarningLevelInjectable from "../update-warning-level.injectable";
 
-interface UpdateButtonProps extends HTMLAttributes<HTMLButtonElement> {}
+export interface UpdateButtonProps extends HTMLAttributes<HTMLButtonElement> {}
 
 interface Dependencies {
   warningLevel: IComputedValue<"light" | "medium" | "high" | "">;

packages/core/src/renderer/components/+workloads-overview/workload-overview-details/workload-overview-detail-injection-token.ts

@@ -6,7 +6,7 @@ import { getInjectionToken } from "@ogre-tools/injectable";
 import type { IComputedValue } from "mobx";
 import type React from "react";
 
-interface WorkloadOverviewDetail {
+export interface WorkloadOverviewDetail {
   orderNumber: number;
   Component: React.ElementType<{}>;
   enabled: IComputedValue<boolean>;

packages/core/tsconfig.json

@@ -1,6 +1,8 @@
 {
   "extends": "../../tsconfig.json",
   "compilerOptions": {
+    "composite": true,
+    "outDir": "static/build/library/",
     "paths": {
       "*": [
         "node_modules/*",
@@ -17,6 +19,8 @@
     ]
   },
   "include": [
+    "package.json",
+    "webpack/vars.ts",
     "src/**/*",
     "types/*.d.ts",
   ],

packages/extensions/package.json

@@ -17,7 +17,7 @@
   },
   "scripts": {
     "build": "yarn run webpack --config webpack/extensions.ts",
-    "build-docs": "yarn run typedoc src/extension-api.ts",
+    "build-docs": "yarn run typedoc",
     "clean": "rm -rf dist/"
   },
   "dependencies": {

packages/extensions/tsconfig.json

@@ -23,5 +23,10 @@
   "exclude": [
     "node_modules",
     "../core/src/"
+  ],
+  "references": [
+    {
+      "path": "../core"
+    }
   ]
 }

packages/extensions/typedoc.json

@@ -1,11 +1,15 @@
 {
-  "readme": "docs/extensions/typedoc-readme.md.tpl",
+  "readme": "../../docs/extensions/typedoc-readme.md.tpl",
   "name": "@k8slens/extensions",
   "out": "../../docs/extensions/api",
   "excludePrivate": true,
-  "includes": [
+  "entryPointStrategy": "expand",
-    "src/"
+  "entryPoints": [
+    "src/extension-api.ts",
+    "../core/src/common/library.ts",
+    "../core/src/main/library.ts",
+    "../core/src/renderer/library.ts"
   ],
   "hideBreadcrumbs": true,
-  "disableSources": true
+  "disableSources": true,
 }