fix(appx): utilize applicationId verbatim when provided

.changeset/orange-radios-tie.md

@@ -0,0 +1,5 @@
+---
+"app-builder-lib": patch
+---
+
+fix: force using `applicationId` if provided before falling back to identityName or app name

packages/app-builder-lib/scheme.json

@@ -6596,7 +6596,6 @@
       "type": "object"
     }
   },
-  "description": "Configuration Options",
   "properties": {
     "afterAllArtifactBuild": {
       "anyOf": [

packages/app-builder-lib/src/configuration.ts

@@ -21,7 +21,7 @@ import { NsisOptions, NsisWebOptions, PortableOptions } from "./targets/nsis/nsi
 /**
  * Configuration Options
  */
-export interface Configuration extends PlatformSpecificBuildOptions, Hooks {
+export interface CommonConfiguration {
   /**
    * The application id. Used as [CFBundleIdentifier](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102070) for MacOS and as
    * [Application User Model ID](https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx) for Windows (NSIS target only, Squirrel.Windows not supported). It is strongly recommended that an explicit ID is set.
@@ -107,12 +107,6 @@ export interface Configuration extends PlatformSpecificBuildOptions, Hooks {
   readonly p5p?: LinuxTargetSpecificOptions | null
   readonly apk?: LinuxTargetSpecificOptions | null
 
-  /**
-   * Whether to include *all* of the submodules node_modules directories
-   * @default false
-   */
-  includeSubNodeModules?: boolean
-
   /**
    * Whether to build the application native dependencies from source.
    * @default false
@@ -157,6 +151,44 @@ export interface Configuration extends PlatformSpecificBuildOptions, Hooks {
    */
   readonly downloadAlternateFFmpeg?: boolean
 
+  /**
+   * Inject properties to `package.json`.
+   */
+  readonly extraMetadata?: any
+
+  /**
+   * Whether to fail if the application is not signed (to prevent unsigned app if code signing configuration is not correct).
+   * @default false
+   */
+  readonly forceCodeSigning?: boolean
+
+  /**
+   * Whether to include PDB files.
+   * @default false
+   */
+  readonly includePdb?: boolean
+
+  /**
+   * Whether to remove `scripts` field from `package.json` files.
+   *
+   * @default true
+   */
+  readonly removePackageScripts?: boolean
+
+  /**
+   * Whether to remove `keywords` field from `package.json` files.
+   *
+   * @default true
+   */
+  readonly removePackageKeywords?: boolean
+}
+export interface Configuration extends CommonConfiguration, PlatformSpecificBuildOptions, Hooks {
+  /**
+   * Whether to include *all* of the submodules node_modules directories
+   * @default false
+   */
+  includeSubNodeModules?: boolean
+
   /**
    * Whether to use [electron-compile](http://github.com/electron/electron-compile) to compile app. Defaults to `true` if `electron-compile` in the dependencies. And `false` if in the `devDependencies` or doesn't specified.
    */
@@ -191,17 +223,6 @@ export interface Configuration extends PlatformSpecificBuildOptions, Hooks {
    */
   extends?: Array<string> | string | null
 
-  /**
-   * Inject properties to `package.json`.
-   */
-  readonly extraMetadata?: any
-
-  /**
-   * Whether to fail if the application is not signed (to prevent unsigned app if code signing configuration is not correct).
-   * @default false
-   */
-  readonly forceCodeSigning?: boolean
-
   /**
    * *libui-based frameworks only* The version of NodeJS you are packaging for.
    * You can set it to `current` to set the Node.js version that you use to run.
@@ -218,26 +239,6 @@ export interface Configuration extends PlatformSpecificBuildOptions, Hooks {
    */
   readonly framework?: string | null
 
-  /**
-   * Whether to include PDB files.
-   * @default false
-   */
-  readonly includePdb?: boolean
-
-  /**
-   * Whether to remove `scripts` field from `package.json` files.
-   *
-   * @default true
-   */
-  readonly removePackageScripts?: boolean
-
-  /**
-   * Whether to remove `keywords` field from `package.json` files.
-   *
-   * @default true
-   */
-  readonly removePackageKeywords?: boolean
-
   /**
    * Whether to disable sanity check asar package (useful for custom electron forks that implement their own encrypted integrity validation)
    * @default false

packages/app-builder-lib/src/index.ts

@@ -22,6 +22,7 @@ export {
 } from "./core"
 export { getArchSuffix, Arch, archFromString } from "builder-util"
 export {
+  CommonConfiguration,
   Configuration,
   AfterPackContext,
   MetadataDirectories,

packages/app-builder-lib/src/targets/AppxTarget.ts

@@ -228,7 +228,9 @@ export default class AppXTarget extends Target {
           const validCharactersRegex = /^([A-Za-z][A-Za-z0-9]*)(\.[A-Za-z][A-Za-z0-9]*)*$/
           const identitynumber = parseInt(options.identityName as string, 10) || NaN
           let result: string
-          if (!isNaN(identitynumber) && options.identityName !== null && options.identityName !== undefined) {
+          if (options.applicationId) {
+            result = options.applicationId
+          } else if (!isNaN(identitynumber) && options.identityName !== null && options.identityName !== undefined) {
             if (options.identityName[0] === "0") {
               log.warn(`Remove the 0${identitynumber}`)
               result = options.identityName.replace("0" + identitynumber.toString(), "")
@@ -237,7 +239,7 @@ export default class AppXTarget extends Target {
               result = options.identityName.replace(identitynumber.toString(), "")
             }
           } else {
-            result = options.applicationId || options.identityName || appInfo.name
+            result = options.identityName || appInfo.name
           }
 
           if (result.length < 1 || result.length > 64) {

pages/configuration.md

@@ -34,9 +34,9 @@ Env file `electron-builder.env` in the current dir ([example](https://github.com
 * Name of optional property is normal, **required** is bold.
 * Type is specified after property name: `Array<String> | String`. Union like this means that you can specify or string (`**/*`), or array of strings (`["**/*", "!foo.js"]`).
 
-### Configuration
+### Common Configuration
 
-{!./app-builder-lib.Interface.Configuration.md!}
+{!./app-builder-lib.Interface.CommonConfiguration.md!}
 
 ---