pkgOptions.d.ts
6.27 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
import { TargetSpecificOptions } from "../core";
export declare type BackgroundAlignment = "center" | "left" | "right" | "top" | "bottom" | "topleft" | "topright" | "bottomleft" | "bottomright";
export declare type BackgroundScaling = "tofit" | "none" | "proportional";
/**
* macOS product archive options.
*/
export interface PkgOptions extends TargetSpecificOptions {
/**
* The scripts directory, relative to `build` (build resources directory).
* The scripts can be in any language so long as the files are marked executable and have the appropriate shebang indicating the path to the interpreter.
* Scripts are required to be executable (`chmod +x file`).
* @default build/pkg-scripts
* @see [Scripting in installer packages](http://macinstallers.blogspot.de/2012/07/scripting-in-installer-packages.html).
*/
readonly scripts?: string | null;
/**
* should be not documented, only to experiment
* @private
*/
readonly productbuild?: Array<string> | null;
/**
* The install location. [Do not use it](https://stackoverflow.com/questions/12863944/how-do-you-specify-a-default-install-location-to-home-with-pkgbuild) to create per-user package.
* Mostly never you will need to change this option. `/Applications` would install it as expected into `/Applications` if the local system domain is chosen, or into `$HOME/Applications` if the home installation is chosen.
* @default /Applications
*/
readonly installLocation?: string | null;
/**
* Whether can be installed at the root of any volume, including non-system volumes. Otherwise, it cannot be installed at the root of a volume.
*
* Corresponds to [enable_anywhere](https://developer.apple.com/library/content/documentation/DeveloperTools/Reference/DistributionDefinitionRef/Chapters/Distribution_XML_Ref.html#//apple_ref/doc/uid/TP40005370-CH100-SW70).
* @default true
*/
readonly allowAnywhere?: boolean | null;
/**
* Whether can be installed into the current user’s home directory.
* A home directory installation is done as the current user (not as root), and it cannot write outside of the home directory.
* If the product cannot be installed in the user’s home directory and be not completely functional from user’s home directory.
*
* Corresponds to [enable_currentUserHome](https://developer.apple.com/library/content/documentation/DeveloperTools/Reference/DistributionDefinitionRef/Chapters/Distribution_XML_Ref.html#//apple_ref/doc/uid/TP40005370-CH100-SW70).
* @default true
*/
readonly allowCurrentUserHome?: boolean | null;
/**
* Whether can be installed into the root directory. Should usually be `true` unless the product can be installed only to the user’s home directory.
*
* Corresponds to [enable_localSystem](https://developer.apple.com/library/content/documentation/DeveloperTools/Reference/DistributionDefinitionRef/Chapters/Distribution_XML_Ref.html#//apple_ref/doc/uid/TP40005370-CH100-SW70).
* @default true
*/
readonly allowRootDirectory?: boolean | null;
/**
* The name of certificate to use when signing. Consider using environment variables [CSC_LINK or CSC_NAME](/code-signing) instead of specifying this option.
*/
readonly identity?: string | null;
/**
* The path to EULA license file. Defaults to `license.txt` or `eula.txt` (or uppercase variants). In addition to `txt, `rtf` and `html` supported (don't forget to use `target="_blank"` for links).
*/
readonly license?: string | null;
/**
* Options for the background image for the installer.
*/
readonly background?: PkgBackgroundOptions | null;
/**
* The path to the welcome file. This may be used to customize the text on the Introduction page of the installer.
*/
readonly welcome?: string | null;
/**
* Identifies applications that must be closed before the package is installed.\n\nCorresponds to [must-close](https://developer.apple.com/library/archive/documentation/DeveloperTools/Reference/DistributionDefinitionRef/Chapters/Distribution_XML_Ref.html#//apple_ref/doc/uid/TP40005370-CH100-SW77)
*/
readonly mustClose?: Array<string> | null;
/**
* The path to the conclusion file. This may be used to customize the text on the final "Summary" page of the installer.
*/
readonly conclusion?: string | null;
/**
* Install bundle over previous version if moved by user?
* @default true
*/
readonly isRelocatable?: boolean | null;
/**
* Don't install bundle if newer version on disk?
* @default true
*/
readonly isVersionChecked?: boolean | null;
/**
* Require identical bundle identifiers at install path?
* @default true
*/
readonly hasStrictIdentifier?: boolean | null;
/**
* Specifies how an existing version of the bundle on disk should be handled when the version in
* the package is installed.
*
* If you specify upgrade, the bundle in the package atomi-cally replaces any version on disk;
* this has the effect of deleting old paths that no longer exist in the new version of
* the bundle.
*
* If you specify update, the bundle in the package overwrites the version on disk, and any files
* not contained in the package will be left intact; this is appropriate when you are delivering
* an update-only package.
*
* Another effect of update is that the package bundle will not be installed at all if there is
* not already a version on disk; this allows a package to deliver an update for an app that
* the user might have deleted.
*
* @default upgrade
*/
readonly overwriteAction?: "upgrade" | "update" | null;
}
/**
* Options for the background image in a PKG installer
*/
export interface PkgBackgroundOptions {
/**
* Path to the image to use as an installer background.
*/
file?: string;
/**
* Alignment of the background image.
* Options are: center, left, right, top, bottom, topleft, topright, bottomleft, bottomright
* @default center
*/
alignment?: BackgroundAlignment | null;
/**
* Scaling of the background image.
* Options are: tofit, none, proportional
* @default tofit
*/
scaling?: BackgroundScaling | null;
}