Skip to content

Commit

Permalink
feat: export Packager sub-classes from main electron-builder types (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
mmaietta committed Mar 26, 2024
1 parent a999da4 commit 8e36be1
Show file tree
Hide file tree
Showing 12 changed files with 1,881 additions and 299 deletions.
7 changes: 7 additions & 0 deletions .changeset/serious-nails-shop.md
@@ -0,0 +1,7 @@
---
"app-builder-lib": minor
"dmg-builder": minor
"electron-builder": minor
---

feat: export Packager sub-classes from main electron-builder types
2,148 changes: 1,858 additions & 290 deletions docs/api/electron-builder.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion packages/app-builder-lib/src/electron/ElectronFramework.ts
Expand Up @@ -7,7 +7,7 @@ import { Configuration } from "../configuration"
import { BeforeCopyExtraFilesOptions, Framework, PrepareApplicationStageDirectoryOptions } from "../Framework"
import { Packager, Platform } from "../index"
import { LinuxPackager } from "../linuxPackager"
import MacPackager from "../macPackager"
import { MacPackager } from "../macPackager"
import { getTemplatePath } from "../util/pathManager"
import { createMacApp } from "./electronMac"
import { computeElectronVersion, getElectronVersionFromInstalled } from "./electronVersion"
Expand Down
2 changes: 1 addition & 1 deletion packages/app-builder-lib/src/electron/electronMac.ts
Expand Up @@ -5,7 +5,7 @@ import { rename, utimes } from "fs/promises"
import * as path from "path"
import { filterCFBundleIdentifier } from "../appInfo"
import { AsarIntegrity } from "../asar/integrity"
import MacPackager from "../macPackager"
import { MacPackager } from "../macPackager"
import { normalizeExt } from "../platformPackager"
import { executeAppBuilderAndWriteJson, executeAppBuilderAsJson } from "../util/appBuilder"
import { createBrandingOpts } from "./ElectronFramework"
Expand Down
2 changes: 1 addition & 1 deletion packages/app-builder-lib/src/frameworks/LibUiFramework.ts
Expand Up @@ -6,7 +6,7 @@ import { AfterPackContext } from "../configuration"
import { Platform } from "../core"
import { Framework, PrepareApplicationStageDirectoryOptions } from "../Framework"
import { LinuxPackager } from "../linuxPackager"
import MacPackager from "../macPackager"
import { MacPackager } from "../macPackager"
import { executeAppBuilderAndWriteJson } from "../util/appBuilder"

export class LibUiFramework implements Framework {
Expand Down
4 changes: 4 additions & 0 deletions packages/app-builder-lib/src/index.ts
Expand Up @@ -39,6 +39,7 @@ export { SnapOptions, PlugDescriptor, SlotDescriptor } from "./options/SnapOptio
export { Metadata, AuthorMetadata, RepositoryInfo } from "./options/metadata"
export { AppInfo } from "./appInfo"
export { SquirrelWindowsOptions } from "./options/SquirrelWindowsOptions"

export { CustomMacSign, CustomMacSignOptions } from "./macPackager"
export {
WindowsSignOptions,
Expand All @@ -54,6 +55,9 @@ export { PublishManager } from "./publish/PublishManager"
export { PlatformPackager } from "./platformPackager"
export { Framework, PrepareApplicationStageDirectoryOptions } from "./Framework"
export { buildForge, ForgeOptions } from "./forge-maker"
export { LinuxPackager } from "./linuxPackager"
export { WinPackager } from "./winPackager"
export { MacPackager } from "./macPackager"

const expectedOptions = new Set(["publish", "targets", "mac", "win", "linux", "projectDir", "platformPackagerFactory", "config", "effectiveOptionComputed", "prepackaged"])

Expand Down
2 changes: 1 addition & 1 deletion packages/app-builder-lib/src/macPackager.ts
Expand Up @@ -31,7 +31,7 @@ import {
export type CustomMacSignOptions = SignOptions
export type CustomMacSign = (configuration: CustomMacSignOptions, packager: MacPackager) => Promise<void>

export default class MacPackager extends PlatformPackager<MacConfiguration> {
export class MacPackager extends PlatformPackager<MacConfiguration> {
readonly codeSigningInfo = new Lazy<CodeSigningInfo>(() => {
const cscLink = this.getCscLink()
if (cscLink == null || process.platform !== "darwin") {
Expand Down
2 changes: 1 addition & 1 deletion packages/app-builder-lib/src/packager.ts
Expand Up @@ -473,7 +473,7 @@ export class Packager {

switch (platform) {
case Platform.MAC: {
const helperClass = (await import("./macPackager")).default
const helperClass = (await import("./macPackager")).MacPackager
return new helperClass(this)
}

Expand Down
2 changes: 1 addition & 1 deletion packages/app-builder-lib/src/targets/pkg.ts
Expand Up @@ -8,7 +8,7 @@ import * as path from "path"
import { filterCFBundleIdentifier } from "../appInfo"
import { findIdentity, Identity } from "../codeSign/macCodeSign"
import { Target } from "../core"
import MacPackager from "../macPackager"
import { MacPackager } from "../macPackager"
import { readdirSync } from "fs"

const certType = "Developer ID Installer"
Expand Down
2 changes: 1 addition & 1 deletion packages/dmg-builder/src/dmg.ts
@@ -1,6 +1,6 @@
import { DmgOptions, Target } from "app-builder-lib"
import { findIdentity, isSignAllowed } from "app-builder-lib/out/codeSign/macCodeSign"
import MacPackager from "app-builder-lib/out/macPackager"
import { MacPackager } from "app-builder-lib/out/macPackager"
import { createBlockmap } from "app-builder-lib/out/targets/differentialUpdateInfoBuilder"
import { executeAppBuilderAsJson } from "app-builder-lib/out/util/appBuilder"
import { sanitizeFileName } from "app-builder-lib/out/util/filename"
Expand Down
5 changes: 4 additions & 1 deletion packages/electron-builder/src/index.ts
@@ -1,4 +1,4 @@
export { getArchSuffix, Arch, archFromString } from "builder-util"
export { getArchSuffix, Arch, archFromString, log } from "builder-util"
export { build, CliOptions, createTargets } from "./builder"
export {
TargetConfiguration,
Expand Down Expand Up @@ -63,6 +63,9 @@ export {
PublishManager,
PublishOptions,
ProgressInfo,
MacPackager,
WinPackager,
LinuxPackager,
} from "app-builder-lib"
export { buildForge, ForgeOptions } from "app-builder-lib"
export { CancellationToken } from "builder-util-runtime"
2 changes: 1 addition & 1 deletion test/src/helpers/CheckingPackager.ts
Expand Up @@ -2,7 +2,7 @@ import { AsyncTaskManager } from "builder-util"
import { Arch, MacConfiguration, Packager, Target } from "electron-builder"
import SquirrelWindowsTarget from "electron-builder-squirrel-windows"
import { Identity } from "app-builder-lib/out/codeSign/macCodeSign"
import MacPackager from "app-builder-lib/out/macPackager"
import { MacPackager } from "app-builder-lib/out/macPackager"
import { DmgTarget } from "dmg-builder"
import { WinPackager } from "app-builder-lib/out/winPackager"
import { SignOptions as MacSignOptions } from "@electron/osx-sign/dist/cjs/types"
Expand Down

0 comments on commit 8e36be1

Please sign in to comment.