fix(typedoc): documentation & API completeness fixes

.gitignore

@@ -27,7 +27,6 @@ packages/plugin/webpack/spec/fixtures/apps/native-modules/package-lock.json
 packages/plugin/fuses/spec/fixture/out
 .links
 reports
-packages/**/typedoc.json
 .vscode/settings.json
 .pnp.*
 .yarn/*

packages/maker/deb/src/MakerDeb.ts

@@ -61,3 +61,4 @@ export default class MakerDeb extends MakerBase<MakerDebConfig> {
 }
 
 export { MakerDeb, MakerDebConfig };
+export type { MakerDebConfigOptions } from './Config.ts';

packages/maker/dmg/src/Config.ts

@@ -1,6 +1,8 @@
 import type { ElectronInstallerDMGOptions } from 'electron-installer-dmg';
 
-export type MakerDMGConfig = Omit<
+export interface MakerDMGConfig extends Omit<
   ElectronInstallerDMGOptions,
   'name' | 'appPath' | 'out'
-> & { name?: string };
+> {
+  name?: string;
+}

packages/maker/flatpak/src/Config.ts

@@ -1,4 +1,4 @@
-export interface MakerFlatpakOptionsConfig {
+export interface MakerFlatpakConfigOptions {
   /**
    * App id of the flatpak, used in the id field of a flatpak-builder manifest.
    *
@@ -122,5 +122,5 @@ export interface MakerFlatpakOptionsConfig {
 }
 
 export interface MakerFlatpakConfig {
-  options?: MakerFlatpakOptionsConfig;
+  options?: MakerFlatpakConfigOptions;
 }

packages/maker/flatpak/src/MakerFlatpak.ts

@@ -59,3 +59,4 @@ export default class MakerFlatpak extends MakerBase<MakerFlatpakConfig> {
 }
 
 export { MakerFlatpak, MakerFlatpakConfig };
+export type { MakerFlatpakConfigOptions } from './Config.ts';

packages/maker/msix/src/Config.ts

@@ -3,6 +3,7 @@ import {
   PackagingOptions as MSIXPackagingOptions,
 } from 'electron-windows-msix';
 
+/** @inline */
 type SemiPartial<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
 
 /**
@@ -15,10 +16,10 @@ type SemiPartial<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
  *
  * @see https://github.com/bitdisaster/electron-windows-msix/blob/master/src/types.ts
  */
-export type MakerMSIXConfig = Omit<
+export interface MakerMSIXConfig extends Omit<
   MSIXPackagingOptions,
   'outputDir' | 'appDir' | 'manifestVariables'
-> & {
+> {
   manifestVariables?: SemiPartial<
     ManifestGenerationVariables,
     | 'packageDescription'
@@ -42,4 +43,4 @@ export type MakerMSIXConfig = Omit<
    * `my-app-win32-x64-1.2.3`
    */
   outputFileName?: string | (() => string | Promise<string>);
-};
+}

packages/maker/rpm/src/MakerRpm.ts

@@ -64,3 +64,4 @@ export default class MakerRpm extends MakerBase<MakerRpmConfig> {
 }
 
 export { MakerRpm, MakerRpmConfig };
+export type { MakerRpmConfigOptions } from './Config.ts';

packages/plugin/vite/src/VitePlugin.ts

@@ -537,4 +537,8 @@ function getServerURLs(urls: vite.ResolvedServerUrls) {
   return output;
 }
 
-export { VitePlugin };
+export { VitePlugin, VitePluginConfig };
+export type {
+  VitePluginBuildConfig,
+  VitePluginRendererConfig,
+} from './Config.ts';

packages/publisher/base-static/src/PublisherStatic.ts

@@ -46,3 +46,4 @@ export default abstract class PublisherStatic<
 }
 
 export { PublisherStatic, StaticPublisherConfig, PublisherOptions };
+export type { StaticArtifact };

packages/publisher/bitbucket/src/PublisherBitbucket.ts

@@ -98,3 +98,4 @@ export default class PublisherBitbucket extends PublisherBase<PublisherBitbucket
 }
 
 export { PublisherBitbucket, PublisherBitbucketConfig };
+export type { BitbucketAuth, BitbucketRepository } from './Config.ts';

packages/publisher/github/src/PublisherGitHub.ts

@@ -250,3 +250,4 @@ export default class PublisherGitHub extends PublisherBase<PublisherGitHubConfig
 }
 
 export { PublisherGitHub, PublisherGitHubConfig };
+export type { GitHubRepository } from './Config.ts';

typedoc.jsonc

@@ -0,0 +1,30 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPointStrategy": "packages",
+  "entryPoints": [
+    "packages/api/core",
+    "packages/maker/*",
+    "packages/plugin/*",
+    "packages/publisher/*",
+    "packages/utils/types"
+  ],
+  "externalSymbolLinkMappings": {
+    "listr2": {
+      // ListrTask is referenced by @electron-forge/shared-types
+      "ListrTask": "https://listr2.kilic.dev/api/listr2/interfaces/ListrTask.html"
+    }
+  },
+  // Replaces previous *.base.json concept: it is
+  // a per-package default documentation. It can still
+  // be overwritten if needed with a per-package config.
+  "packageOptions": {
+    "excludeInternal": true,
+    // Usually, we want to use "externalSymbolLinkMappings"
+    // to point out symbols that are in external packages,
+    // while allow for exceptions if Typedoc docs offer
+    // better quality of documentation or upstream docs
+    // are manually maintained and in risk of being
+    // out-of-date.
+    "excludeExternals": true
+  }
+}