@ms-cloudpack/common-types 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -0
- package/lib/BundleContext.d.ts +6 -0
- package/lib/BundleContext.d.ts.map +1 -0
- package/lib/BundleContext.js +2 -0
- package/lib/BundleContext.js.map +1 -0
- package/lib/BundleMessage.d.ts +10 -0
- package/lib/BundleMessage.d.ts.map +1 -0
- package/lib/BundleMessage.js +2 -0
- package/lib/BundleMessage.js.map +1 -0
- package/lib/BundleMessageLocation.d.ts +12 -0
- package/lib/BundleMessageLocation.d.ts.map +1 -0
- package/lib/BundleMessageLocation.js +2 -0
- package/lib/BundleMessageLocation.js.map +1 -0
- package/lib/BundleMessageNote.d.ts +6 -0
- package/lib/BundleMessageNote.d.ts.map +1 -0
- package/lib/BundleMessageNote.js +2 -0
- package/lib/BundleMessageNote.js.map +1 -0
- package/lib/BundleOptions.d.ts +57 -0
- package/lib/BundleOptions.d.ts.map +1 -0
- package/lib/BundleOptions.js +2 -0
- package/lib/BundleOptions.js.map +1 -0
- package/lib/BundleOutputFile.d.ts +17 -0
- package/lib/BundleOutputFile.d.ts.map +1 -0
- package/lib/BundleOutputFile.js +2 -0
- package/lib/BundleOutputFile.js.map +1 -0
- package/lib/BundleResult.d.ts +23 -0
- package/lib/BundleResult.d.ts.map +1 -0
- package/lib/BundleResult.js +2 -0
- package/lib/BundleResult.js.map +1 -0
- package/lib/BundlerPlugin.d.ts +8 -0
- package/lib/BundlerPlugin.d.ts.map +1 -0
- package/lib/BundlerPlugin.js +2 -0
- package/lib/BundlerPlugin.js.map +1 -0
- package/lib/BundlerPluginResult.d.ts +43 -0
- package/lib/BundlerPluginResult.d.ts.map +1 -0
- package/lib/BundlerPluginResult.js +2 -0
- package/lib/BundlerPluginResult.js.map +1 -0
- package/lib/CloudpackConfig.d.ts +9 -0
- package/lib/CloudpackConfig.d.ts.map +1 -0
- package/lib/CloudpackConfig.js +2 -0
- package/lib/CloudpackConfig.js.map +1 -0
- package/lib/DevServer.d.ts +44 -0
- package/lib/DevServer.d.ts.map +1 -0
- package/lib/DevServer.js +2 -0
- package/lib/DevServer.js.map +1 -0
- package/lib/Feature.d.ts +4 -0
- package/lib/Feature.d.ts.map +1 -0
- package/lib/Feature.js +2 -0
- package/lib/Feature.js.map +1 -0
- package/lib/Features.d.ts +8 -0
- package/lib/Features.d.ts.map +1 -0
- package/lib/Features.js +2 -0
- package/lib/Features.js.map +1 -0
- package/lib/GeneratedConfig.d.ts +17 -0
- package/lib/GeneratedConfig.d.ts.map +1 -0
- package/lib/GeneratedConfig.js +2 -0
- package/lib/GeneratedConfig.js.map +1 -0
- package/lib/HttpsConfig.d.ts +9 -0
- package/lib/HttpsConfig.d.ts.map +1 -0
- package/lib/HttpsConfig.js +2 -0
- package/lib/HttpsConfig.js.map +1 -0
- package/lib/PackageDefinitionsCache.d.ts +51 -0
- package/lib/PackageDefinitionsCache.d.ts.map +1 -0
- package/lib/PackageDefinitionsCache.js +2 -0
- package/lib/PackageDefinitionsCache.js.map +1 -0
- package/lib/PackageJson.d.ts +134 -0
- package/lib/PackageJson.d.ts.map +1 -0
- package/lib/PackageJson.js +2 -0
- package/lib/PackageJson.js.map +1 -0
- package/lib/PackageOverride.d.ts +8 -0
- package/lib/PackageOverride.d.ts.map +1 -0
- package/lib/PackageOverride.js +2 -0
- package/lib/PackageOverride.js.map +1 -0
- package/lib/PackageSettings.d.ts +56 -0
- package/lib/PackageSettings.d.ts.map +1 -0
- package/lib/PackageSettings.js +2 -0
- package/lib/PackageSettings.js.map +1 -0
- package/lib/Route.d.ts +23 -0
- package/lib/Route.d.ts.map +1 -0
- package/lib/Route.js +2 -0
- package/lib/Route.js.map +1 -0
- package/lib/TelemetryConfig.d.ts +7 -0
- package/lib/TelemetryConfig.d.ts.map +1 -0
- package/lib/TelemetryConfig.js +2 -0
- package/lib/TelemetryConfig.js.map +1 -0
- package/lib/UserConfig.d.ts +73 -0
- package/lib/UserConfig.d.ts.map +1 -0
- package/lib/UserConfig.js +2 -0
- package/lib/UserConfig.js.map +1 -0
- package/lib/allFeatures.d.ts +15 -0
- package/lib/allFeatures.d.ts.map +1 -0
- package/lib/allFeatures.js +16 -0
- package/lib/allFeatures.js.map +1 -0
- package/lib/index.d.ts +24 -0
- package/lib/index.d.ts.map +1 -0
- package/lib/index.js +2 -0
- package/lib/index.js.map +1 -0
- package/lib/tsdoc-metadata.json +11 -0
- package/package.json +32 -0
- package/schema/GeneratedConfig.json +622 -0
- package/schema/UserConfig.json +655 -0
|
@@ -0,0 +1,655 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
+
"type": "object",
|
|
4
|
+
"properties": {
|
|
5
|
+
"extends": {
|
|
6
|
+
"anyOf": [
|
|
7
|
+
{
|
|
8
|
+
"type": "string"
|
|
9
|
+
},
|
|
10
|
+
{
|
|
11
|
+
"type": "array",
|
|
12
|
+
"items": {
|
|
13
|
+
"type": "string"
|
|
14
|
+
}
|
|
15
|
+
}
|
|
16
|
+
],
|
|
17
|
+
"description": "Extend the configuration from another file: either an import path or a relative path (resolved from the config file's location).\n\nIf an array, later files will take precedence when merging. (The user config always takes precedence over any extended config.)\n\nConfig merging approach:\n- Objects will be deeply merged.\n- Primitive values will be overwritten.\n- Arrays will be overwritten, EXCEPT for `packageSettings`, which will be concatenated."
|
|
18
|
+
},
|
|
19
|
+
"devServer": {
|
|
20
|
+
"$ref": "#/definitions/DevServer",
|
|
21
|
+
"description": "A set of options for configuring how the dev server works."
|
|
22
|
+
},
|
|
23
|
+
"telemetry": {
|
|
24
|
+
"$ref": "#/definitions/TelemetryConfig",
|
|
25
|
+
"description": "A set of options for configuring telemetry"
|
|
26
|
+
},
|
|
27
|
+
"features": {
|
|
28
|
+
"$ref": "#/definitions/Features",
|
|
29
|
+
"description": "A set of options for configuring the experience. Features can be set to true to change the default behavior."
|
|
30
|
+
},
|
|
31
|
+
"helpMessage": {
|
|
32
|
+
"type": "string",
|
|
33
|
+
"description": "Help message to display when Cloudpack starts up."
|
|
34
|
+
},
|
|
35
|
+
"packageSettings": {
|
|
36
|
+
"type": "array",
|
|
37
|
+
"items": {
|
|
38
|
+
"$ref": "#/definitions/PackageSettings"
|
|
39
|
+
},
|
|
40
|
+
"description": "An array of PackageSettings objects, used to provide settings for how we bundle packages."
|
|
41
|
+
},
|
|
42
|
+
"dependsOn": {
|
|
43
|
+
"type": "array",
|
|
44
|
+
"items": {
|
|
45
|
+
"type": "array",
|
|
46
|
+
"minItems": 2,
|
|
47
|
+
"items": [
|
|
48
|
+
{
|
|
49
|
+
"type": "string"
|
|
50
|
+
},
|
|
51
|
+
{
|
|
52
|
+
"type": "array",
|
|
53
|
+
"items": {
|
|
54
|
+
"type": "string"
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
],
|
|
58
|
+
"maxItems": 2
|
|
59
|
+
},
|
|
60
|
+
"description": "An optional list of commands (followed by a string array of args for that command) to be executed prior to Cloudpack bundle"
|
|
61
|
+
},
|
|
62
|
+
"patchFilesGlobPattern": {
|
|
63
|
+
"type": "string",
|
|
64
|
+
"description": "Glob pattern to match `patch-package` patch files, relative to the project root (usually the same as the repository root).",
|
|
65
|
+
"default": "patches/*.patch"
|
|
66
|
+
},
|
|
67
|
+
"remoteCache": {
|
|
68
|
+
"type": "object",
|
|
69
|
+
"properties": {
|
|
70
|
+
"storageAccount": {
|
|
71
|
+
"type": "string",
|
|
72
|
+
"description": "The name of the Azure Blob Storage account."
|
|
73
|
+
},
|
|
74
|
+
"container": {
|
|
75
|
+
"type": "string",
|
|
76
|
+
"description": "The name of the container to use for the remote cache. Container must already exist."
|
|
77
|
+
}
|
|
78
|
+
},
|
|
79
|
+
"required": [
|
|
80
|
+
"storageAccount",
|
|
81
|
+
"container"
|
|
82
|
+
],
|
|
83
|
+
"additionalProperties": false,
|
|
84
|
+
"description": "Azure Blob Storage configuration for remote cache - uploading and downloading packages. If this is not provided, the remote cache will not be used."
|
|
85
|
+
},
|
|
86
|
+
"neverExcludeDependencies": {
|
|
87
|
+
"type": "array",
|
|
88
|
+
"items": {
|
|
89
|
+
"type": "string"
|
|
90
|
+
},
|
|
91
|
+
"description": "A list of package names that should never be excluded or included from the bundle."
|
|
92
|
+
},
|
|
93
|
+
"$schema": {
|
|
94
|
+
"type": "string"
|
|
95
|
+
}
|
|
96
|
+
},
|
|
97
|
+
"additionalProperties": false,
|
|
98
|
+
"description": "Per-application user-provided configuration for Cloudpack.",
|
|
99
|
+
"definitions": {
|
|
100
|
+
"DevServer": {
|
|
101
|
+
"type": "object",
|
|
102
|
+
"properties": {
|
|
103
|
+
"domain": {
|
|
104
|
+
"type": "string",
|
|
105
|
+
"description": "The domain name of the server."
|
|
106
|
+
},
|
|
107
|
+
"requestHeaders": {
|
|
108
|
+
"type": "object",
|
|
109
|
+
"additionalProperties": {
|
|
110
|
+
"type": "string"
|
|
111
|
+
},
|
|
112
|
+
"description": "An optional dictionary of header key/value pairs to be use with the server. NOTE: The following header values from Cloudpack will \"win\" against by a user's config: 'Cache-Control': 'no-cache' 'Access-Control-Allow-Origin': '*'"
|
|
113
|
+
},
|
|
114
|
+
"port": {
|
|
115
|
+
"anyOf": [
|
|
116
|
+
{
|
|
117
|
+
"type": "number"
|
|
118
|
+
},
|
|
119
|
+
{
|
|
120
|
+
"type": "array",
|
|
121
|
+
"items": {
|
|
122
|
+
"type": "number"
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
],
|
|
126
|
+
"description": "The ports to be used by the server. It can be a number or an array of numbers. If ports are provided, an error will be thrown if none are available. If no ports are provided, the server will attempt to find an available port."
|
|
127
|
+
},
|
|
128
|
+
"defaultPath": {
|
|
129
|
+
"type": "string",
|
|
130
|
+
"description": "The default path to use when opening the browser."
|
|
131
|
+
},
|
|
132
|
+
"https": {
|
|
133
|
+
"$ref": "#/definitions/HttpsConfig",
|
|
134
|
+
"description": "The config settings for the https server. Paths to files are accepted for 'ca', 'cert', 'key', and 'pfx' settings. Everything else is passed directly to the https.createServer() method. If not provided, the server will use http."
|
|
135
|
+
},
|
|
136
|
+
"publicPath": {
|
|
137
|
+
"type": "string",
|
|
138
|
+
"description": "If provided, will override where the publicDir is located, relative to the app package folder. Defaults to `./public`. The same thing can be achieved with `routes`, using route: '*' and staticPath: './public', so the `publicPath` setting may be removed in the future."
|
|
139
|
+
},
|
|
140
|
+
"routes": {
|
|
141
|
+
"type": "array",
|
|
142
|
+
"items": {
|
|
143
|
+
"$ref": "#/definitions/Route"
|
|
144
|
+
},
|
|
145
|
+
"description": "If provided, will register routes with the dev server to host various pages."
|
|
146
|
+
}
|
|
147
|
+
},
|
|
148
|
+
"additionalProperties": false
|
|
149
|
+
},
|
|
150
|
+
"HttpsConfig": {
|
|
151
|
+
"type": "object",
|
|
152
|
+
"properties": {
|
|
153
|
+
"ca": {
|
|
154
|
+
"anyOf": [
|
|
155
|
+
{
|
|
156
|
+
"type": "string"
|
|
157
|
+
},
|
|
158
|
+
{
|
|
159
|
+
"type": "array",
|
|
160
|
+
"items": {
|
|
161
|
+
"type": "string"
|
|
162
|
+
}
|
|
163
|
+
}
|
|
164
|
+
],
|
|
165
|
+
"description": "Optionally override the trusted CA certificates. Default is to trust the well-known CAs curated by Mozilla. Mozilla's CAs are completely replaced when CAs are explicitly specified using this option."
|
|
166
|
+
},
|
|
167
|
+
"cert": {
|
|
168
|
+
"anyOf": [
|
|
169
|
+
{
|
|
170
|
+
"type": "string"
|
|
171
|
+
},
|
|
172
|
+
{
|
|
173
|
+
"type": "array",
|
|
174
|
+
"items": {
|
|
175
|
+
"type": "string"
|
|
176
|
+
}
|
|
177
|
+
}
|
|
178
|
+
],
|
|
179
|
+
"description": "Cert chains in PEM format. One cert chain should be provided per private key. Each cert chain should consist of the PEM formatted certificate for a provided private key, followed by the PEM formatted intermediate certificates (if any), in order, and not including the root CA (the root CA must be pre-known to the peer, see ca). When providing multiple cert chains, they do not have to be in the same order as their private keys in key. If the intermediate certificates are not provided, the peer will not be able to validate the certificate, and the handshake will fail."
|
|
180
|
+
},
|
|
181
|
+
"sigalgs": {
|
|
182
|
+
"type": "string",
|
|
183
|
+
"description": "Colon-separated list of supported signature algorithms. The list can contain digest algorithms (SHA256, MD5 etc.), public key algorithms (RSA-PSS, ECDSA etc.), combination of both (e.g 'RSA+SHA384') or TLS v1.3 scheme names (e.g. rsa_pss_pss_sha512)."
|
|
184
|
+
},
|
|
185
|
+
"ciphers": {
|
|
186
|
+
"type": "string",
|
|
187
|
+
"description": "Cipher suite specification, replacing the default. For more information, see modifying the default cipher suite. Permitted ciphers can be obtained via tls.getCiphers(). Cipher names must be uppercased in order for OpenSSL to accept them."
|
|
188
|
+
},
|
|
189
|
+
"clientCertEngine": {
|
|
190
|
+
"type": "string",
|
|
191
|
+
"description": "Name of an OpenSSL engine which can provide the client certificate."
|
|
192
|
+
},
|
|
193
|
+
"crl": {
|
|
194
|
+
"anyOf": [
|
|
195
|
+
{
|
|
196
|
+
"type": "string"
|
|
197
|
+
},
|
|
198
|
+
{
|
|
199
|
+
"type": "array",
|
|
200
|
+
"items": {
|
|
201
|
+
"type": "string"
|
|
202
|
+
}
|
|
203
|
+
}
|
|
204
|
+
],
|
|
205
|
+
"description": "PEM formatted CRLs (Certificate Revocation Lists)."
|
|
206
|
+
},
|
|
207
|
+
"dhparam": {
|
|
208
|
+
"type": "string",
|
|
209
|
+
"description": "Diffie Hellman parameters, required for Perfect Forward Secrecy. Use openssl dhparam to create the parameters. The key length must be greater than or equal to 1024 bits or else an error will be thrown. Although 1024 bits is permissible, use 2048 bits or larger for stronger security. If omitted or invalid, the parameters are silently discarded and DHE ciphers will not be available."
|
|
210
|
+
},
|
|
211
|
+
"ecdhCurve": {
|
|
212
|
+
"type": "string",
|
|
213
|
+
"description": "A string describing a named curve or a colon separated list of curve NIDs or names, for example P-521:P-384:P-256, to use for ECDH key agreement. Set to auto to select the curve automatically. Use crypto.getCurves() to obtain a list of available curve names. On recent releases, openssl ecparam -list_curves will also display the name and description of each available elliptic curve. Default: tls.DEFAULT_ECDH_CURVE."
|
|
214
|
+
},
|
|
215
|
+
"honorCipherOrder": {
|
|
216
|
+
"type": "boolean",
|
|
217
|
+
"description": "Attempt to use the server's cipher suite preferences instead of the client's. When true, causes SSL_OP_CIPHER_SERVER_PREFERENCE to be set in secureOptions"
|
|
218
|
+
},
|
|
219
|
+
"key": {
|
|
220
|
+
"anyOf": [
|
|
221
|
+
{
|
|
222
|
+
"type": "string"
|
|
223
|
+
},
|
|
224
|
+
{
|
|
225
|
+
"type": "array",
|
|
226
|
+
"items": {
|
|
227
|
+
"$ref": "#/definitions/KeyObject"
|
|
228
|
+
}
|
|
229
|
+
}
|
|
230
|
+
],
|
|
231
|
+
"description": "Private keys in PEM format. PEM allows the option of private keys being encrypted. Encrypted keys will be decrypted with options.passphrase. Multiple keys using different algorithms can be provided either as an array of unencrypted key strings or buffers, or an array of objects in the form {pem: <string|buffer>[, passphrase: <string>]}. The object form can only occur in an array. object.passphrase is optional. Encrypted keys will be decrypted with object.passphrase if provided, or options.passphrase if it is not."
|
|
232
|
+
},
|
|
233
|
+
"privateKeyEngine": {
|
|
234
|
+
"type": "string",
|
|
235
|
+
"description": "Name of an OpenSSL engine to get private key from. Should be used together with privateKeyIdentifier."
|
|
236
|
+
},
|
|
237
|
+
"privateKeyIdentifier": {
|
|
238
|
+
"type": "string",
|
|
239
|
+
"description": "Identifier of a private key managed by an OpenSSL engine. Should be used together with privateKeyEngine. Should not be set together with key, because both options define a private key in different ways."
|
|
240
|
+
},
|
|
241
|
+
"maxVersion": {
|
|
242
|
+
"$ref": "#/definitions/SecureVersion",
|
|
243
|
+
"description": "Optionally set the maximum TLS version to allow. One of `'TLSv1.3'`, `'TLSv1.2'`, `'TLSv1.1'`, or `'TLSv1'`. Cannot be specified along with the `secureProtocol` option, use one or the other.\n**Default:** `'TLSv1.3'`, unless changed using CLI options. Using `--tls-max-v1.2` sets the default to `'TLSv1.2'`. Using `--tls-max-v1.3` sets the default to `'TLSv1.3'`. If multiple of the options are provided, the highest maximum is used."
|
|
244
|
+
},
|
|
245
|
+
"minVersion": {
|
|
246
|
+
"$ref": "#/definitions/SecureVersion",
|
|
247
|
+
"description": "Optionally set the minimum TLS version to allow. One of `'TLSv1.3'`, `'TLSv1.2'`, `'TLSv1.1'`, or `'TLSv1'`. Cannot be specified along with the `secureProtocol` option, use one or the other. It is not recommended to use less than TLSv1.2, but it may be required for interoperability.\n**Default:** `'TLSv1.2'`, unless changed using CLI options. Using `--tls-v1.0` sets the default to `'TLSv1'`. Using `--tls-v1.1` sets the default to `'TLSv1.1'`. Using `--tls-min-v1.3` sets the default to 'TLSv1.3'. If multiple of the options are provided, the lowest minimum is used."
|
|
248
|
+
},
|
|
249
|
+
"passphrase": {
|
|
250
|
+
"type": "string",
|
|
251
|
+
"description": "Shared passphrase used for a single private key and/or a PFX."
|
|
252
|
+
},
|
|
253
|
+
"pfx": {
|
|
254
|
+
"anyOf": [
|
|
255
|
+
{
|
|
256
|
+
"type": "string"
|
|
257
|
+
},
|
|
258
|
+
{
|
|
259
|
+
"type": "array",
|
|
260
|
+
"items": {
|
|
261
|
+
"anyOf": [
|
|
262
|
+
{
|
|
263
|
+
"type": "string"
|
|
264
|
+
},
|
|
265
|
+
{
|
|
266
|
+
"$ref": "#/definitions/PxfObject"
|
|
267
|
+
}
|
|
268
|
+
]
|
|
269
|
+
}
|
|
270
|
+
}
|
|
271
|
+
],
|
|
272
|
+
"description": "PFX or PKCS12 encoded private key and certificate chain. pfx is an alternative to providing key and cert individually. PFX is usually encrypted, if it is, passphrase will be used to decrypt it. Multiple PFX can be provided either as an array of unencrypted PFX buffers, or an array of objects in the form {buf: <string|buffer>[, passphrase: <string>]}. The object form can only occur in an array. object.passphrase is optional. Encrypted PFX will be decrypted with object.passphrase if provided, or options.passphrase if it is not."
|
|
273
|
+
},
|
|
274
|
+
"secureOptions": {
|
|
275
|
+
"type": "number",
|
|
276
|
+
"description": "Optionally affect the OpenSSL protocol behavior, which is not usually necessary. This should be used carefully if at all! Value is a numeric bitmask of the SSL_OP_* options from OpenSSL Options"
|
|
277
|
+
},
|
|
278
|
+
"secureProtocol": {
|
|
279
|
+
"type": "string",
|
|
280
|
+
"description": "Legacy mechanism to select the TLS protocol version to use, it does not support independent control of the minimum and maximum version, and does not support limiting the protocol to TLSv1.3. Use minVersion and maxVersion instead. The possible values are listed as SSL_METHODS, use the function names as strings. For example, use 'TLSv1_1_method' to force TLS version 1.1, or 'TLS_method' to allow any TLS protocol version up to TLSv1.3. It is not recommended to use TLS versions less than 1.2, but it may be required for interoperability. Default: none, see minVersion."
|
|
281
|
+
},
|
|
282
|
+
"sessionIdContext": {
|
|
283
|
+
"type": "string",
|
|
284
|
+
"description": "Opaque identifier used by servers to ensure session state is not shared between applications. Unused by clients."
|
|
285
|
+
},
|
|
286
|
+
"ticketKeys": {
|
|
287
|
+
"not": {},
|
|
288
|
+
"description": "48-bytes of cryptographically strong pseudo-random data. See Session Resumption for more information."
|
|
289
|
+
},
|
|
290
|
+
"sessionTimeout": {
|
|
291
|
+
"type": "number",
|
|
292
|
+
"description": "The number of seconds after which a TLS session created by the server will no longer be resumable. See Session Resumption for more information. Default: 300."
|
|
293
|
+
},
|
|
294
|
+
"handshakeTimeout": {
|
|
295
|
+
"type": "number",
|
|
296
|
+
"description": "Abort the connection if the SSL/TLS handshake does not finish in the specified number of milliseconds. A 'tlsClientError' is emitted on the tls.Server object whenever a handshake times out. Default: 120000 (120 seconds)."
|
|
297
|
+
},
|
|
298
|
+
"pskIdentityHint": {
|
|
299
|
+
"type": "string",
|
|
300
|
+
"description": "hint to send to a client to help with selecting the identity during TLS-PSK negotiation. Will be ignored in TLS 1.3. Upon failing to set pskIdentityHint `tlsClientError` will be emitted with `ERR_TLS_PSK_SET_IDENTIY_HINT_FAILED` code."
|
|
301
|
+
},
|
|
302
|
+
"secureContext": {
|
|
303
|
+
"$ref": "#/definitions/SecureContext",
|
|
304
|
+
"description": "An optional TLS context object from tls.createSecureContext()"
|
|
305
|
+
},
|
|
306
|
+
"enableTrace": {
|
|
307
|
+
"type": "boolean",
|
|
308
|
+
"description": "When enabled, TLS packet trace information is written to `stderr`. This can be used to debug TLS connection problems.",
|
|
309
|
+
"default": false
|
|
310
|
+
},
|
|
311
|
+
"requestCert": {
|
|
312
|
+
"type": "boolean",
|
|
313
|
+
"description": "If true the server will request a certificate from clients that connect and attempt to verify that certificate. Defaults to false."
|
|
314
|
+
},
|
|
315
|
+
"ALPNProtocols": {
|
|
316
|
+
"anyOf": [
|
|
317
|
+
{
|
|
318
|
+
"type": "array",
|
|
319
|
+
"items": {
|
|
320
|
+
"type": "string"
|
|
321
|
+
}
|
|
322
|
+
},
|
|
323
|
+
{
|
|
324
|
+
"type": "array",
|
|
325
|
+
"items": {
|
|
326
|
+
"not": {}
|
|
327
|
+
}
|
|
328
|
+
}
|
|
329
|
+
],
|
|
330
|
+
"description": "An array of strings or a Buffer naming possible ALPN protocols. (Protocols should be ordered by their priority.)"
|
|
331
|
+
},
|
|
332
|
+
"SNICallback": {
|
|
333
|
+
"not": {},
|
|
334
|
+
"description": "SNICallback(servername, cb) <Function> A function that will be called if the client supports SNI TLS extension. Two arguments will be passed when called: servername and cb. SNICallback should invoke cb(null, ctx), where ctx is a SecureContext instance. (tls.createSecureContext(...) can be used to get a proper SecureContext.) If SNICallback wasn't provided the default callback with high-level API will be used (see below)."
|
|
335
|
+
},
|
|
336
|
+
"rejectUnauthorized": {
|
|
337
|
+
"type": "boolean",
|
|
338
|
+
"description": "If true the server will reject any connection which is not authorized with the list of supplied CAs. This option only has an effect if requestCert is true.",
|
|
339
|
+
"default": true
|
|
340
|
+
},
|
|
341
|
+
"allowHalfOpen": {
|
|
342
|
+
"type": "boolean",
|
|
343
|
+
"description": "Indicates whether half-opened TCP connections are allowed.",
|
|
344
|
+
"default": false
|
|
345
|
+
},
|
|
346
|
+
"pauseOnConnect": {
|
|
347
|
+
"type": "boolean",
|
|
348
|
+
"description": "Indicates whether the socket should be paused on incoming connections.",
|
|
349
|
+
"default": false
|
|
350
|
+
},
|
|
351
|
+
"noDelay": {
|
|
352
|
+
"type": "boolean",
|
|
353
|
+
"description": "If set to `true`, it disables the use of Nagle's algorithm immediately after a new incoming connection is received.",
|
|
354
|
+
"default": false
|
|
355
|
+
},
|
|
356
|
+
"keepAlive": {
|
|
357
|
+
"type": "boolean",
|
|
358
|
+
"description": "If set to `true`, it enables keep-alive functionality on the socket immediately after a new incoming connection is received, similarly on what is done in `socket.setKeepAlive([enable][, initialDelay])`.",
|
|
359
|
+
"default": false
|
|
360
|
+
},
|
|
361
|
+
"keepAliveInitialDelay": {
|
|
362
|
+
"type": "number",
|
|
363
|
+
"description": "If set to a positive number, it sets the initial delay before the first keepalive probe is sent on an idle socket.",
|
|
364
|
+
"default": 0
|
|
365
|
+
},
|
|
366
|
+
"maxHeaderSize": {
|
|
367
|
+
"type": "number",
|
|
368
|
+
"description": "Optionally overrides the value of `--max-http-header-size` for requests received by this server, i.e. the maximum length of request headers in bytes.",
|
|
369
|
+
"default": 8192
|
|
370
|
+
},
|
|
371
|
+
"insecureHTTPParser": {
|
|
372
|
+
"type": "boolean",
|
|
373
|
+
"description": "Use an insecure HTTP parser that accepts invalid HTTP headers when true. Using the insecure parser should be avoided. See --insecure-http-parser for more information.",
|
|
374
|
+
"default": false
|
|
375
|
+
}
|
|
376
|
+
},
|
|
377
|
+
"additionalProperties": false,
|
|
378
|
+
"description": "HTTPS server configuration settings."
|
|
379
|
+
},
|
|
380
|
+
"KeyObject": {
|
|
381
|
+
"type": "object",
|
|
382
|
+
"properties": {
|
|
383
|
+
"pem": {
|
|
384
|
+
"type": "string",
|
|
385
|
+
"description": "Private keys in PEM format."
|
|
386
|
+
},
|
|
387
|
+
"passphrase": {
|
|
388
|
+
"type": "string",
|
|
389
|
+
"description": "Optional passphrase."
|
|
390
|
+
}
|
|
391
|
+
},
|
|
392
|
+
"required": [
|
|
393
|
+
"pem"
|
|
394
|
+
],
|
|
395
|
+
"additionalProperties": false
|
|
396
|
+
},
|
|
397
|
+
"SecureVersion": {
|
|
398
|
+
"type": "string",
|
|
399
|
+
"enum": [
|
|
400
|
+
"TLSv1.3",
|
|
401
|
+
"TLSv1.2",
|
|
402
|
+
"TLSv1.1",
|
|
403
|
+
"TLSv1"
|
|
404
|
+
]
|
|
405
|
+
},
|
|
406
|
+
"PxfObject": {
|
|
407
|
+
"type": "object",
|
|
408
|
+
"properties": {
|
|
409
|
+
"buf": {
|
|
410
|
+
"type": "string",
|
|
411
|
+
"description": "PFX or PKCS12 encoded private key and certificate chain."
|
|
412
|
+
},
|
|
413
|
+
"passphrase": {
|
|
414
|
+
"type": "string",
|
|
415
|
+
"description": "Optional passphrase."
|
|
416
|
+
}
|
|
417
|
+
},
|
|
418
|
+
"required": [
|
|
419
|
+
"buf"
|
|
420
|
+
],
|
|
421
|
+
"additionalProperties": false
|
|
422
|
+
},
|
|
423
|
+
"SecureContext": {
|
|
424
|
+
"type": "object",
|
|
425
|
+
"properties": {
|
|
426
|
+
"context": {}
|
|
427
|
+
},
|
|
428
|
+
"required": [
|
|
429
|
+
"context"
|
|
430
|
+
],
|
|
431
|
+
"additionalProperties": false
|
|
432
|
+
},
|
|
433
|
+
"Route": {
|
|
434
|
+
"type": "object",
|
|
435
|
+
"properties": {
|
|
436
|
+
"match": {
|
|
437
|
+
"type": "string",
|
|
438
|
+
"description": "The url path part to match. Start paths with a leading slash, e.g. `'/my-route'`. You can also use wildcards (`*`), e.g. `'/my-route/*'` to match all paths starting with `'/my-route'`."
|
|
439
|
+
},
|
|
440
|
+
"staticPath": {
|
|
441
|
+
"type": "string",
|
|
442
|
+
"description": "The path relative to the app root to static assets. If this is provided, renderScript/exportEntry will be ignored."
|
|
443
|
+
},
|
|
444
|
+
"renderScript": {
|
|
445
|
+
"type": "string",
|
|
446
|
+
"description": "Path to a .js or .html file used for rendering the route. If a script is provided, it must export a default function implementing `CreateHtmlFunction` defined in `@ms-cloudpack/cli`."
|
|
447
|
+
},
|
|
448
|
+
"exportEntry": {
|
|
449
|
+
"type": "string",
|
|
450
|
+
"description": "The key in the exports map which represents the entry point app script for this route. Default is '.', meaning the main package export key."
|
|
451
|
+
}
|
|
452
|
+
},
|
|
453
|
+
"required": [
|
|
454
|
+
"match"
|
|
455
|
+
],
|
|
456
|
+
"additionalProperties": false
|
|
457
|
+
},
|
|
458
|
+
"TelemetryConfig": {
|
|
459
|
+
"type": "object",
|
|
460
|
+
"properties": {
|
|
461
|
+
"connectionString": {
|
|
462
|
+
"type": "string",
|
|
463
|
+
"description": "Application Insights connection string."
|
|
464
|
+
}
|
|
465
|
+
},
|
|
466
|
+
"required": [
|
|
467
|
+
"connectionString"
|
|
468
|
+
],
|
|
469
|
+
"additionalProperties": false
|
|
470
|
+
},
|
|
471
|
+
"Features": {
|
|
472
|
+
"type": "object",
|
|
473
|
+
"properties": {
|
|
474
|
+
"disableSourceMaps": {
|
|
475
|
+
"type": "boolean"
|
|
476
|
+
},
|
|
477
|
+
"enqueueDependencies": {
|
|
478
|
+
"type": "boolean"
|
|
479
|
+
},
|
|
480
|
+
"enableLage": {
|
|
481
|
+
"type": "boolean"
|
|
482
|
+
},
|
|
483
|
+
"resolveWebExtensions": {
|
|
484
|
+
"type": "boolean"
|
|
485
|
+
},
|
|
486
|
+
"optimizeDependencies": {
|
|
487
|
+
"type": "boolean"
|
|
488
|
+
},
|
|
489
|
+
"verifyExports": {
|
|
490
|
+
"type": "boolean"
|
|
491
|
+
},
|
|
492
|
+
"syncBundles": {
|
|
493
|
+
"type": "boolean"
|
|
494
|
+
}
|
|
495
|
+
},
|
|
496
|
+
"additionalProperties": false,
|
|
497
|
+
"description": "Represents all features that can be enabled or disabled for Cloudpack."
|
|
498
|
+
},
|
|
499
|
+
"PackageSettings": {
|
|
500
|
+
"type": "object",
|
|
501
|
+
"properties": {
|
|
502
|
+
"match": {
|
|
503
|
+
"anyOf": [
|
|
504
|
+
{
|
|
505
|
+
"type": "object",
|
|
506
|
+
"properties": {
|
|
507
|
+
"name": {
|
|
508
|
+
"type": "string",
|
|
509
|
+
"description": "Name of the package. Can use a trailing wildcard (e.g. \"\\@scope/*\")."
|
|
510
|
+
},
|
|
511
|
+
"version": {
|
|
512
|
+
"type": "string",
|
|
513
|
+
"description": "Version of the package. Unspecified matches any version."
|
|
514
|
+
}
|
|
515
|
+
},
|
|
516
|
+
"required": [
|
|
517
|
+
"name"
|
|
518
|
+
],
|
|
519
|
+
"additionalProperties": false
|
|
520
|
+
},
|
|
521
|
+
{
|
|
522
|
+
"type": "string"
|
|
523
|
+
}
|
|
524
|
+
],
|
|
525
|
+
"description": "A match to indicate the target for the settings to be applied to."
|
|
526
|
+
},
|
|
527
|
+
"includedDependencies": {
|
|
528
|
+
"type": "array",
|
|
529
|
+
"items": {
|
|
530
|
+
"type": "string"
|
|
531
|
+
},
|
|
532
|
+
"description": "The dependencies which should be included when computing the import map. This is primarily used when devDependencies are needed by the app. This often happens when a library has a demo app which relies on devDependencies."
|
|
533
|
+
},
|
|
534
|
+
"excludedDependencies": {
|
|
535
|
+
"type": "array",
|
|
536
|
+
"items": {
|
|
537
|
+
"type": "string"
|
|
538
|
+
},
|
|
539
|
+
"description": "The dependencies which should be ignored by Cloudpack verbs. For example, if \"react-native\" is a dependency which should not be included in the import map or evaluated during `init`, it can be listed here to ignore it."
|
|
540
|
+
},
|
|
541
|
+
"inlinedDependencies": {
|
|
542
|
+
"type": "array",
|
|
543
|
+
"items": {
|
|
544
|
+
"type": "string"
|
|
545
|
+
},
|
|
546
|
+
"description": "Dependencies which should be inlined in the library bundled by Cloudpack. This is useful for libraries which are small and don't need to be loaded separately, or ones which have issues being resolved by the browser."
|
|
547
|
+
},
|
|
548
|
+
"exports": {
|
|
549
|
+
"$ref": "#/definitions/PackageJsonExports",
|
|
550
|
+
"description": "The exports map that should be used for this package, ignoring entries which are defined in the original package.json. This is useful for libraries which have a missing or broken exports map, or when we want to trim the exports to reduce the api surface we expose to the inner loop experience."
|
|
551
|
+
},
|
|
552
|
+
"bundlerType": {
|
|
553
|
+
"type": "string",
|
|
554
|
+
"description": "Forces the package to be bundled using a specific bundler."
|
|
555
|
+
},
|
|
556
|
+
"bundlerOptions": {
|
|
557
|
+
"type": "object",
|
|
558
|
+
"additionalProperties": {},
|
|
559
|
+
"description": "Options to pass to the bundler."
|
|
560
|
+
},
|
|
561
|
+
"inputPaths": {
|
|
562
|
+
"type": "array",
|
|
563
|
+
"items": {
|
|
564
|
+
"type": "string"
|
|
565
|
+
},
|
|
566
|
+
"description": "Paths used for file monitoring and input hashing. Supports glob matching. Defaults to `[/src/**, *.json]` and excludes node_modules. Use `...` to include the default paths."
|
|
567
|
+
}
|
|
568
|
+
},
|
|
569
|
+
"required": [
|
|
570
|
+
"match"
|
|
571
|
+
],
|
|
572
|
+
"additionalProperties": false,
|
|
573
|
+
"description": "Settings which apply to a single package (app or library) as it pertains to the Cloudpack start experience."
|
|
574
|
+
},
|
|
575
|
+
"PackageJsonExports": {
|
|
576
|
+
"anyOf": [
|
|
577
|
+
{
|
|
578
|
+
"$ref": "#/definitions/PackageJsonExportsValue"
|
|
579
|
+
},
|
|
580
|
+
{
|
|
581
|
+
"$ref": "#/definitions/PackageJsonExportsObject"
|
|
582
|
+
},
|
|
583
|
+
{
|
|
584
|
+
"type": "array",
|
|
585
|
+
"items": {
|
|
586
|
+
"$ref": "#/definitions/PackageJsonExports"
|
|
587
|
+
}
|
|
588
|
+
}
|
|
589
|
+
],
|
|
590
|
+
"description": "Entry points of a package, optionally with conditions and subpath exports. Used as `PackageJson.exports`."
|
|
591
|
+
},
|
|
592
|
+
"PackageJsonExportsValue": {
|
|
593
|
+
"anyOf": [
|
|
594
|
+
{
|
|
595
|
+
"type": "null"
|
|
596
|
+
},
|
|
597
|
+
{
|
|
598
|
+
"type": "string"
|
|
599
|
+
},
|
|
600
|
+
{
|
|
601
|
+
"type": "object",
|
|
602
|
+
"properties": {
|
|
603
|
+
"browser": {
|
|
604
|
+
"$ref": "#/definitions/PackageJsonExportsValue"
|
|
605
|
+
},
|
|
606
|
+
"default": {
|
|
607
|
+
"$ref": "#/definitions/PackageJsonExportsValue"
|
|
608
|
+
},
|
|
609
|
+
"deno": {
|
|
610
|
+
"$ref": "#/definitions/PackageJsonExportsValue"
|
|
611
|
+
},
|
|
612
|
+
"electron": {
|
|
613
|
+
"$ref": "#/definitions/PackageJsonExportsValue"
|
|
614
|
+
},
|
|
615
|
+
"import": {
|
|
616
|
+
"$ref": "#/definitions/PackageJsonExportsValue"
|
|
617
|
+
},
|
|
618
|
+
"module": {
|
|
619
|
+
"$ref": "#/definitions/PackageJsonExportsValue"
|
|
620
|
+
},
|
|
621
|
+
"node-addons": {
|
|
622
|
+
"$ref": "#/definitions/PackageJsonExportsValue"
|
|
623
|
+
},
|
|
624
|
+
"node": {
|
|
625
|
+
"$ref": "#/definitions/PackageJsonExportsValue"
|
|
626
|
+
},
|
|
627
|
+
"react-native": {
|
|
628
|
+
"$ref": "#/definitions/PackageJsonExportsValue"
|
|
629
|
+
},
|
|
630
|
+
"require": {
|
|
631
|
+
"$ref": "#/definitions/PackageJsonExportsValue"
|
|
632
|
+
}
|
|
633
|
+
},
|
|
634
|
+
"additionalProperties": {
|
|
635
|
+
"$ref": "#/definitions/PackageJsonExportsValue"
|
|
636
|
+
}
|
|
637
|
+
},
|
|
638
|
+
{
|
|
639
|
+
"type": "array",
|
|
640
|
+
"items": {
|
|
641
|
+
"$ref": "#/definitions/PackageJsonExportsValue"
|
|
642
|
+
}
|
|
643
|
+
}
|
|
644
|
+
],
|
|
645
|
+
"description": "The value of an `PackageJson.exports` object key. Note at the root of the object, keys can be represented either by a condition, or a `string` to provide import paths (such as \"./foo\"). At subsequent levels within the object, only conditions (string which don't start with \".\") can be used as keys."
|
|
646
|
+
},
|
|
647
|
+
"PackageJsonExportsObject": {
|
|
648
|
+
"type": "object",
|
|
649
|
+
"additionalProperties": {
|
|
650
|
+
"$ref": "#/definitions/PackageJsonExportsValue"
|
|
651
|
+
},
|
|
652
|
+
"description": "Definition of the root exports object. Keys can be either conditions or import paths."
|
|
653
|
+
}
|
|
654
|
+
}
|
|
655
|
+
}
|