| 1 | import { TargetSpecificOptions } from "../core";
|
| 2 | export interface AppXOptions extends TargetSpecificOptions {
|
| 3 | /**
|
| 4 | * The application id. Defaults to `identityName`. This string contains alpha-numeric fields separated by periods. Each field must begin with an ASCII alphabetic character.
|
| 5 | */
|
| 6 | readonly applicationId?: string;
|
| 7 | /**
|
| 8 | * The background color of the app tile. See [Visual Elements](https://msdn.microsoft.com/en-us/library/windows/apps/br211471.aspx).
|
| 9 | * @default #464646
|
| 10 | */
|
| 11 | readonly backgroundColor?: string | null;
|
| 12 | /**
|
| 13 | * A friendly name that can be displayed to users. Corresponds to [Properties.DisplayName](https://msdn.microsoft.com/en-us/library/windows/apps/br211432.aspx).
|
| 14 | * Defaults to the application product name.
|
| 15 | */
|
| 16 | readonly displayName?: string | null;
|
| 17 | /**
|
| 18 | * The name. Corresponds to [Identity.Name](https://msdn.microsoft.com/en-us/library/windows/apps/br211441.aspx). Defaults to the [application name](/configuration/configuration#Metadata-name).
|
| 19 | */
|
| 20 | readonly identityName?: string | null;
|
| 21 | /**
|
| 22 | * The Windows Store publisher. Not used if AppX is build for testing. See [AppX Package Code Signing](#appx-package-code-signing) below.
|
| 23 | */
|
| 24 | readonly publisher?: string | null;
|
| 25 | /**
|
| 26 | * A friendly name for the publisher that can be displayed to users. Corresponds to [Properties.PublisherDisplayName](https://msdn.microsoft.com/en-us/library/windows/apps/br211460.aspx).
|
| 27 | * Defaults to company name from the application metadata.
|
| 28 | */
|
| 29 | readonly publisherDisplayName?: string | null;
|
| 30 | /**
|
| 31 | * The list of [supported languages](https://docs.microsoft.com/en-us/windows/uwp/globalizing/manage-language-and-region#specify-the-supported-languages-in-the-apps-manifest) that will be listed in the Windows Store.
|
| 32 | * The first entry (index 0) will be the default language.
|
| 33 | * Defaults to en-US if omitted.
|
| 34 | */
|
| 35 | readonly languages?: Array<string> | string | null;
|
| 36 | /**
|
| 37 | * Whether to add auto launch extension. Defaults to `true` if [electron-winstore-auto-launch](https://github.com/felixrieseberg/electron-winstore-auto-launch) in the dependencies.
|
| 38 | */
|
| 39 | readonly addAutoLaunchExtension?: boolean;
|
| 40 | /**
|
| 41 | * Relative path to custom extensions xml to be included in an `appmanifest.xml`.
|
| 42 | */
|
| 43 | readonly customExtensionsPath?: string;
|
| 44 | /**
|
| 45 | * Whether to overlay the app's name on top of tile images on the Start screen. Defaults to `false`. (https://docs.microsoft.com/en-us/uwp/schemas/appxpackage/uapmanifestschema/element-uap-shownameontiles) in the dependencies.
|
| 46 | * @default false
|
| 47 | */
|
| 48 | readonly showNameOnTiles?: boolean;
|
| 49 | /**
|
| 50 | * @private
|
| 51 | * @default false
|
| 52 | */
|
| 53 | readonly electronUpdaterAware?: boolean;
|
| 54 | /**
|
| 55 | * Whether to set build number. See https://github.com/electron-userland/electron-builder/issues/3875
|
| 56 | * @default false
|
| 57 | */
|
| 58 | readonly setBuildNumber?: boolean;
|
| 59 | /**
|
| 60 | * Set the MinVersion field in the appx manifest.xml
|
| 61 | * @default arch === Arch.arm64 ? "10.0.16299.0" : "10.0.14316.0"
|
| 62 | */
|
| 63 | readonly minVersion?: string | null;
|
| 64 | /**
|
| 65 | * Set the `MaxVersionTested` field in the appx manifest.xml
|
| 66 | * @default arch === Arch.arm64 ? "10.0.16299.0" : "10.0.14316.0"
|
| 67 | */
|
| 68 | readonly maxVersionTested?: string | null;
|
| 69 | /** @private */
|
| 70 | readonly makeappxArgs?: Array<string> | null;
|
| 71 | }
|