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/*

.oxfmtrc.json

@@ -14,7 +14,6 @@
     "packages/*/*/index.ts",
     "packages/*/*/README.md",
     "packages/*/*/tsconfig.json",
-    "packages/*/*/typedoc.json",
     "packages/api/core/spec/fixture/api-tester/package.json",
     "packages/api/core/spec/fixture/bad_external_forge_config/bad.js",
     "packages/plugin/webpack/spec/**/.webpack",

packages/api/core/README.md

@@ -12,7 +12,7 @@ import { api } from '@electron-forge/core';
 api.package(import.meta.dirname);
 ```
 
-The named export `api` has it's methods documented over at [ForgeAPI](https://js.electronforge.io/classes/_electron_forge_core.ForgeAPI.html).
+The named export `api` has it's methods documented over at [ForgeAPI](https://js.electronforge.io/classes/_electron-forge_core.ForgeAPI.html).
 All the methods are async and expose the core forge methods, please note that all
 user-side configuration is still done through your forge config file or the "config.forge"
 section of your package.json. This API simply let's you call the methods in

packages/api/core/src/api/make.ts

@@ -33,6 +33,7 @@ type MakerImpl = {
   new (...args: any[]): MakerBase<any>;
 };
 
+/** @inline */
 type MakeTargets = ForgeConfigMaker[] | string[];
 
 function generateTargets(

packages/api/core/src/util/forge-config.ts

@@ -106,11 +106,14 @@ export function unregisterForgeConfigForDirectory(dir: string): void {
   registeredForgeConfigs.delete(path.resolve(dir));
 }
 
-export type BuildIdentifierMap<T> = Record<string, T | undefined>;
-export type BuildIdentifierConfig<T> = {
+/** @inline */
+export interface BuildIdentifierMap<T> extends Record<string, T | undefined> {}
+/** @inline */
+export interface BuildIdentifierConfig<T> {
   map: BuildIdentifierMap<T>;
+  /** @internal */
   __isMagicBuildIdentifierMap: true;
-};
+}
 
 export function fromBuildIdentifier<T>(
   map: BuildIdentifierMap<T>,

packages/maker/appx/README.md

@@ -4,7 +4,7 @@
 
 You can only build the AppX target on Windows machines with the Windows 10 SDK installed.
 
-Configuration options are documented in [`MakerAppXConfig`](https://js.electronforge.io/interfaces/_electron_forge_maker_appx.MakerAppXConfig.html).
+Configuration options are documented in [`MakerAppXConfig`](https://js.electronforge.io/interfaces/_electron-forge_maker-appx.MakerAppXConfig.html).
 
 ```javascript
 {

packages/maker/deb/README.md

@@ -2,7 +2,7 @@
 
 `@electron-forge/maker-deb` builds .deb packages, which are the standard package format for Debian-based Linux distributions such as Ubuntu. You can only build the deb target on Linux or macOS machines with the fakeroot and dpkg packages installed.
 
-Configuration options are documented in [`MakerDebConfigOptions`](https://js.electronforge.io/interfaces/_electron_forge_maker_deb.InternalOptions.MakerDebConfigOptions.html).
+Configuration options are documented in [`MakerDebConfigOptions`](https://js.electronforge.io/interfaces/_electron-forge_maker-dmg.MakerDMGConfig.html).
 
 ```javascript
 {

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/README.md

@@ -2,7 +2,7 @@
 
 `@electron-forge/maker-dmg` builds `.dmg` files, which are the standard format for sharing macOS apps. You can only build the DMG target on macOS machines.
 
-Configuration options are documented in [`MakerDMGConfig`](https://js.electronforge.io/interfaces/_electron_forge_maker_dmg.MakerDMGConfig.html).
+Configuration options are documented in [`MakerDMGConfig`](https://js.electronforge.io/interfaces/_electron-forge_maker-dmg.MakerDMGConfig.html).
 
 ```javascript
 {

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;
+}

typedoc.base.json → packages/maker/dmg/typedoc.jsonc

@@ -1,4 +1,4 @@
 {
   "$schema": "https://typedoc.org/schema.json",
-  "excludeInternal": true
+  "excludeExternals": false,
 }

packages/maker/flatpak/README.md

@@ -4,7 +4,7 @@
 
 You can only build the Flatpak target if you have `flatpak`, `flatpak-builder`, and `eu-strip` _\(usually part of the `elfutils` package\)_ installed on your system.
 
-Configuration options are documented in [`MakerFlatpakOptionsConfig`](https://js.electronforge.io/interfaces/_electron_forge_maker_flatpak.InternalOptions.MakerFlatpakOptionsConfig.html).
+Configuration options are documented in [`MakerFlatpakOptionsConfig`](https://js.electronforge.io/interfaces/_electron-forge_maker-flatpak.MakerFlatpakConfigOptions.html).
 
 ```javascript
 {

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/README.md

@@ -8,7 +8,7 @@
 
 You can only build the MSIX target on Windows machines with the Windows 10 SDK installed.
 
-Configuration options are documented in [`MakerMSIXConfig`](https://js.electronforge.io/interfaces/_electron_forge_maker_msix.MakerMSIXConfig.html).
+Configuration options are documented in [`MakerMSIXConfig`](https://js.electronforge.io/interfaces/_electron-forge_maker-msix.MakerMSIXConfig.html).
 
 maker-msix utilizes @electron/windows-sign via the `windowsSignOptions` property. See the [windows-sign documentation](https://github.com/electron/windows-sign/blob/main/README.md) for details.
 

packages/maker/msix/src/Config.ts

@@ -5,6 +5,16 @@ import {
 
 type SemiPartial<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
 
+export interface MakerMSIXConfigManifestVariables extends SemiPartial<
+  ManifestGenerationVariables,
+  | 'packageDescription'
+  | 'appExecutable'
+  | 'packageVersion'
+  | 'publisher'
+  | 'packageIdentity'
+  | 'targetArch'
+> {}
+
 /**
  * The configuration object for the MSIX maker.
  * The `outputDir` and `appDir` parameters are preconfigured by Forge so that the
@@ -15,19 +25,11 @@ 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'
-    | 'appExecutable'
-    | 'packageVersion'
-    | 'publisher'
-    | 'packageIdentity'
-    | 'targetArch'
-  >;
+> {
+  manifestVariables?: MakerMSIXConfigManifestVariables;
   /**
    * The base name of the generated `.msix` file, without the `.msix`
    * extension (the maker always appends `.msix`). This only overrides the
@@ -42,4 +44,4 @@ export type MakerMSIXConfig = Omit<
    * `my-app-win32-x64-1.2.3`
    */
   outputFileName?: string | (() => string | Promise<string>);
-};
+}

packages/maker/msix/src/MakerMSIX.ts

@@ -73,3 +73,4 @@ export default class MakerMSIX extends MakerBase<MakerMSIXConfig> {
 }
 
 export { MakerMSIX, MakerMSIXConfig };
+export type { MakerMSIXConfigManifestVariables } from './Config.ts';

packages/maker/msix/typedoc.jsonc

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "excludeExternals": false,
+}

packages/maker/pkg/README.md

@@ -2,7 +2,7 @@
 
 `@electron-forge/maker-pkg` builds `.pkg` files for macOS. These are used to upload your application to the Mac App Store or just as an alternate distribution method for macOS users.  You can only build the Pkg target on macOS machines while targeting the `darwin`  or `mas` platforms.
 
-Configuration options are documented in [`MakerPkgConfig`](https://js.electronforge.io/interfaces/_electron_forge_maker_pkg.MakerPKGConfig.html).
+Configuration options are documented in [`MakerPkgConfig`](https://js.electronforge.io/interfaces/_electron-forge_maker-pkg.MakerPKGConfig.html).
 
 ```javascript
 {

packages/maker/rpm/README.md

@@ -4,7 +4,7 @@
 
 You can only build the RPM target on Linux machines with the `rpm` or `rpm-build` packages installed.
 
-Configuration options are documented in [`MakerRpmConfigOptions`](https://js.electronforge.io/interfaces/_electron_forge_maker_rpm.InternalOptions.MakerRpmConfigOptions.html).
+Configuration options are documented in [`MakerRpmConfigOptions`](https://js.electronforge.io/interfaces/_electron-forge_maker-rpm.MakerRpmConfigOptions.html).
 
 ```javascript
 {

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/maker/snap/README.md

@@ -4,6 +4,8 @@
 
 You can only build the Snapcraft target on Linux systems with the `snapcraft` package installed.
 
+Configuration options are documented in [`MakerSnapConfig`](https://js.electronforge.io/interfaces/_electron-forge_maker-snap.MakerSnapConfig.html).
+
 ```javascript
 {
   name: '@electron-forge/maker-snap',

packages/maker/snap/src/Config.ts

@@ -1,4 +1,4 @@
 import { Options, SnapcraftConfig } from 'electron-installer-snap';
 
-export type MakerSnapConfig = Omit<Options, 'arch' | 'dest' | 'src'> &
-  SnapcraftConfig;
+export interface MakerSnapConfig
+  extends Omit<Options, 'arch' | 'dest' | 'src'>, SnapcraftConfig {}

packages/maker/snap/typedoc.jsonc

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "excludeExternals": false,
+}

packages/maker/squirrel/README.md

@@ -7,7 +7,7 @@ Pre-requisites:
 * Windows machine
 * Linux machine with `mono` and `wine` installed.
 
-Configuration options are documented in [`MakerSquirrelConfigOptions`](https://js.electronforge.io/interfaces/_electron_forge_maker_squirrel.InternalOptions.Options.html).
+Configuration options are documented in [`MakerSquirrelConfig`](https://js.electronforge.io/interfaces/_electron-forge_maker-squirrel.MakerSquirrelConfig.html).
 
 ```javascript
 {

packages/maker/squirrel/src/MakerSquirrel.ts

@@ -11,10 +11,10 @@ import {
   Options as ElectronWinstallerOptions,
 } from 'electron-winstaller';
 
-export type MakerSquirrelConfig = Omit<
+export interface MakerSquirrelConfig extends Omit<
   ElectronWinstallerOptions,
   'appDirectory' | 'outputDirectory'
->;
+> {}
 
 export default class MakerSquirrel extends MakerBase<MakerSquirrelConfig> {
   name = 'squirrel';

packages/maker/squirrel/typedoc.jsonc

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "excludeExternals": false,
+}

packages/maker/wix/README.md

@@ -7,7 +7,7 @@ Pre-requisites:
 
 * `light` and `candle` installed from [the WiX toolkit](https://github.com/felixrieseberg/electron-wix-msi#prerequisites).
 
-Configuration options are documented in [`MakerWixConfig`](https://js.electronforge.io/interfaces/_electron_forge_maker_wix.MakerWixConfig.html).
+Configuration options are documented in [`MakerWixConfig`](https://js.electronforge.io/interfaces/_electron-forge_maker-wix.MakerWixConfig.html).
 
 ```javascript
 {

packages/maker/wix/src/Config.ts

@@ -1,6 +1,6 @@
 import { MSICreator, type MSICreatorOptions } from 'electron-wix-msi';
 
-export type MakerWixConfig = Omit<
+export interface MakerWixConfig extends Omit<
   MSICreatorOptions,
   | 'appDirectory'
   | 'outputDirectory'
@@ -9,7 +9,7 @@ export type MakerWixConfig = Omit<
   | 'version'
   | 'manufacturer'
   | 'exe'
-> & {
+> {
   /**
    * The app's description
    *
@@ -44,4 +44,4 @@ export type MakerWixConfig = Omit<
    * Allows for the modification of the MSICreator before create is called.
    */
   beforeCreate?: (creator: MSICreator) => Promise<void> | void;
-};
+}

packages/maker/wix/src/MakerWix.ts

@@ -4,7 +4,7 @@ import { styleText } from 'node:util';
 import { getNameFromAuthor } from '@electron-forge/core-utils';
 import { MakerBase, type MakerOptions } from '@electron-forge/maker-base';
 import { ForgePlatform } from '@electron-forge/shared-types';
-import { MSICreator, type MSICreatorOptions } from 'electron-wix-msi';
+import { MSICreator } from 'electron-wix-msi';
 import semver from 'semver';
 
 import { MakerWixConfig } from './Config.js';
@@ -74,4 +74,4 @@ export default class MakerWix extends MakerBase<MakerWixConfig> {
   }
 }
 
-export { MakerWix, MakerWixConfig, MSICreatorOptions };
+export { MakerWix, MakerWixConfig };

packages/maker/wix/typedoc.jsonc

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "excludeExternals": false,
+}

packages/maker/zip/README.md

@@ -2,7 +2,7 @@
 
 `@electron-forge/maker-zip` builds basic `.zip` files containing your packaged application. There are no platform specific dependencies for using this maker and it will run on any platform.
 
-Note: There are no configuration options for this target.
+Configuration options are documented in [`MakerZIPConfig`](https://js.electronforge.io/interfaces/_electron-forge_maker-zip.MakerZIPConfig.html).
 
 ```javascript
 {

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/plugin/webpack/src/Config.ts

@@ -65,6 +65,7 @@ export interface WebpackPluginEntryPointNoWindow extends WebpackPluginEntryPoint
   js: string;
 }
 
+/** @inline */
 export type WebpackPluginEntryPoint =
   | WebpackPluginEntryPointLocalWindow
   | WebpackPluginEntryPointNoWindow
@@ -188,6 +189,7 @@ export interface WebpackPluginConfig {
   >;
 }
 
+/** @inline */
 export type WebpackConfiguration =
   | RawWebpackConfiguration
   | WebpackConfigurationFactory;

packages/plugin/webpack/src/WebpackConfig.ts

@@ -31,6 +31,7 @@ type WebpackMode = 'production' | 'development';
 
 const d = debug('electron-forge:plugin:webpack:webpackconfig');
 
+/** @inline */
 export type ConfigurationFactory = (
   env: string | Record<string, string | boolean | number> | unknown,
   args: Record<string, unknown>,

packages/plugin/webpack/src/WebpackPlugin.ts

@@ -817,3 +817,10 @@ the generated files). Instead, it is ${JSON.stringify(pj.main)}`);
 }
 
 export { WebpackPlugin, WebpackPluginConfig };
+export type {
+  WebpackPluginRendererConfig,
+  WebpackPluginEntryPointLocalWindow,
+  WebpackPluginEntryPointNoWindow,
+  WebpackPluginEntryPointPreloadOnly,
+  WebpackPreloadEntryPoint,
+} from './Config.ts';

packages/plugin/webpack/typedoc.jsonc

@@ -0,0 +1,9 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "intentionallyNotExported": [
+    // This requires exposure of entire class / logic
+    // of WebpackConfig, and I am not even sure if
+    // this is even intended to be in public API
+    "src/WebpackConfig.ts:default"
+  ]
+}

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/README.md

@@ -4,7 +4,7 @@
 
 This publish target is for Bitbucket Cloud only and will not work with self hosted Bitbucket Server instances.
 
-Configuration options are documented in [`PublisherBitbucketConfig`](https://js.electronforge.io/interfaces/_electron_forge_publisher_bitbucket.PublisherBitbucketConfig.html).
+Configuration options are documented in [`PublisherBitbucketConfig`](https://js.electronforge.io/interfaces/_electron-forge_publisher-bitbucket.PublisherBitbucketConfig.html).
 
 ```javascript title=forge.config.js
 module.exports = {

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';