@expo/config-types 51.0.1 → 51.0.3

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.
@@ -11,7 +11,7 @@ export interface ExpoConfig {
11
11
  */
12
12
  description?: string;
13
13
  /**
14
- * The friendly URL name for publishing. For example, `myAppName` will refer to the `expo.dev/@project-owner/myAppName` project.
14
+ * A URL-friendly name for your project that is unique across your account.
15
15
  */
16
16
  slug: string;
17
17
  /**
@@ -35,7 +35,7 @@ export interface ExpoConfig {
35
35
  */
36
36
  sdkVersion?: string;
37
37
  /**
38
- * The runtime version associated with this manifest.
38
+ * Property indicating compatibility between a build's native code and an OTA update.
39
39
  */
40
40
  runtimeVersion?: string | {
41
41
  policy: 'nativeVersion' | 'sdkVersion' | 'appVersion' | 'fingerprint';
@@ -167,19 +167,23 @@ export interface ExpoConfig {
167
167
  [k: string]: any;
168
168
  };
169
169
  /**
170
- * Configuration for how and when the app should request OTA JavaScript updates
170
+ * Configuration for the expo-updates library
171
171
  */
172
172
  updates?: {
173
173
  /**
174
- * If set to false, your standalone app will never download any code, and will only use code bundled locally on the device. In that case, all updates to your app must be submitted through app store review. Defaults to true. (Note: This will not work out of the box with ExpoKit projects)
174
+ * Whether the updates system will run. Defaults to true. If set to false, builds will only use code and assets bundled at time of build.
175
175
  */
176
176
  enabled?: boolean;
177
177
  /**
178
- * By default, Expo will check for updates every time the app is loaded. Set this to `ON_ERROR_RECOVERY` to disable automatic checking unless recovering from an error. Set this to `NEVER` to completely disable automatic checking. Must be one of `ON_LOAD` (default value), `ON_ERROR_RECOVERY`, `WIFI_ONLY`, or `NEVER`
178
+ * By default, expo-updates will check for updates every time the app is loaded. Set this to `ON_ERROR_RECOVERY` to disable automatic checking unless recovering from an error. Set this to `NEVER` to disable automatic checking. Valid values: `ON_LOAD` (default value), `ON_ERROR_RECOVERY`, `WIFI_ONLY`, `NEVER`
179
179
  */
180
180
  checkAutomatically?: 'ON_ERROR_RECOVERY' | 'ON_LOAD' | 'WIFI_ONLY' | 'NEVER';
181
181
  /**
182
- * How long (in ms) to allow for fetching OTA updates before falling back to a cached version of the app. Defaults to 0. Must be between 0 and 300000 (5 minutes).
182
+ * Whether to load the embedded update. Defaults to true. If set to false, an update will be fetched at launch. When set to false, ensure that `checkAutomatically` is set to `ON_LOAD` and `fallbackToCacheTimeout` is large enough for the initial remote update to download. This should not be used in production.
183
+ */
184
+ useEmbeddedUpdate?: boolean;
185
+ /**
186
+ * How long (in ms) to wait for the app to check for and fetch a new update upon launch before falling back to the most recent update already present on the device. Defaults to 0. Must be between 0 and 300000 (5 minutes). If the startup update check takes longer than this value, any update downloaded during the check will be applied upon the next app launch.
183
187
  */
184
188
  fallbackToCacheTimeout?: number;
185
189
  /**
@@ -187,7 +191,7 @@ export interface ExpoConfig {
187
191
  */
188
192
  url?: string;
189
193
  /**
190
- * Local path of a PEM-formatted X.509 certificate used for requiring and verifying signed Expo updates
194
+ * Local path of a PEM-formatted X.509 certificate used for verifying codesigned updates. When provided, all updates downloaded by expo-updates must be signed.
191
195
  */
192
196
  codeSigningCertificate?: string;
193
197
  /**
@@ -195,7 +199,7 @@ export interface ExpoConfig {
195
199
  */
196
200
  codeSigningMetadata?: {
197
201
  /**
198
- * Algorithm used to generate manifest code signing signature.
202
+ * Algorithm used to generate manifest code signing signature. Valid values: `rsa-v1_5-sha256`
199
203
  */
200
204
  alg?: 'rsa-v1_5-sha256';
201
205
  /**
@@ -204,7 +208,7 @@ export interface ExpoConfig {
204
208
  keyid?: string;
205
209
  };
206
210
  /**
207
- * Extra HTTP headers to include in HTTP requests made by `expo-updates`. These may override preset headers.
211
+ * Extra HTTP headers to include in HTTP requests made by `expo-updates` when fetching manifests or assets. These may override preset headers.
208
212
  */
209
213
  requestHeaders?: {
210
214
  [k: string]: any;
@@ -498,7 +502,7 @@ export interface IOS {
498
502
  */
499
503
  jsEngine?: 'hermes' | 'jsc';
500
504
  /**
501
- * The runtime version associated with this manifest for the iOS platform. If provided, this will override the top level runtimeVersion key.
505
+ * Property indicating compatibility between an iOS build's native code and an OTA update for the iOS platform. If provided, this will override the value of the top level `runtimeVersion` key on iOS.
502
506
  */
503
507
  runtimeVersion?: string | {
504
508
  policy: 'nativeVersion' | 'sdkVersion' | 'appVersion' | 'fingerprint';
@@ -725,7 +729,7 @@ export interface Android {
725
729
  */
726
730
  jsEngine?: 'hermes' | 'jsc';
727
731
  /**
728
- * The runtime version associated with this manifest for the Android platform. If provided, this will override the top level runtimeVersion key.
732
+ * Property indicating compatibility between a Android build's native code and an OTA update for the Android platform. If provided, this will override the value of top level `runtimeVersion` key on Android.
729
733
  */
730
734
  runtimeVersion?: string | {
731
735
  policy: 'nativeVersion' | 'sdkVersion' | 'appVersion' | 'fingerprint';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@expo/config-types",
3
- "version": "51.0.1",
3
+ "version": "51.0.3",
4
4
  "description": "Types for the Expo config object app.config.ts",
5
5
  "types": "build/ExpoConfig.d.ts",
6
6
  "main": "build/ExpoConfig.js",
@@ -44,5 +44,5 @@
44
44
  "publishConfig": {
45
45
  "access": "public"
46
46
  },
47
- "gitHead": "2893e9cba95261919532de0675468c601b87b017"
47
+ "gitHead": "9c3d135a84823afcb438338923120a0be939ea66"
48
48
  }