Compare commits

...
13 Commits
Author SHA1 Message Date
Kirby Cofino 3610eee2b5 v0.53.1 2022-06-07 12:00:02 -07:00
Kirby Cofino 54ae94f532 upgrade eas-cli-local-build-plugin to 0.0.85 2022-06-07 11:59:37 -07:00
kirb c68bf3e26f [eas-cli] lower page limit for UpdateQueries (#1119)
* [eas-cli] lower page limit for UpdateQueries

- lower page limit from 10_000 to 300 to avoid timeouts on branches with many updates.
  we do not fetch the full history of updates anymore for `--republish`, etc.
2022-06-07 11:41:33 -07:00
Cedric van Putten 940e3f6d40 [eas-cli] Add metadata root actions and error handling (#1135)
* [eas-cli] Add metadata root actions and error handling

* [eas-cli] Update download and upload metadata methods to new ctx
2022-06-04 16:22:26 +02:00
Cedric van PuttenandEvan Bacon 4c6226b90b [eas-cli] Add metadata app store task runner (#1133)
* [eas-cli] Add metadata app store task runner

* [eas-cli] Use expect error over ignore

Co-authored-by: Evan Bacon <[email protected]>

* [eas-cli] Remove unused ts directive

* [eas-cli] Add download task tests

Co-authored-by: Evan Bacon <[email protected]>
2022-06-02 17:04:59 -07:00
Cedric van Putten 1341bb18d1 [eas-cli] Add metadata telemetry increase visibility on potential issues (#1132) 2022-06-02 13:59:34 -07:00
Cedric van Putten beac65ce53 [eas-cli] Add metadata config validation using json schema (#1131)
* [eas-cli] Add metadata config validation using json schema

* [eas-cli] Fix typo in privacy choices validation

* [eas-cli] Fix typo in fixture test
2022-06-02 13:58:51 -07:00
Cedric van Putten a8cc54d409 [eas-cli] Add metadata context based on submission contexts (#1134)
* [eas-cli] Add metadata context based on submission contexts

* [eas-json] Add submission meta property to config

* [eas-cli] Make exp optional in the metdata context

* [eas-cli] Fix misleading docblock on metadata context

* [eas-cli] Fix pass through exp config in metadata context

* [eas-cli] Import ios submission profile type through entrypoint

* [eas-cli] Rename metadata file to filename in context

* [eas-cli] Move credential context outside metadata context

* [eas-cli] Rename meta to metadataPath in profile config

* [eas-cli] Drop nonInteractive from metadata because of AppStoreApi limitations

* [eas-cli] Use singular store in bundle identifier doc
2022-06-02 17:06:04 +02:00
Cedric van PuttenandEvan Bacon 6a639bd556 [eas-cli] Add metadata store config serializers (#1130)
* [eas-cli] Add metadata store config serializers

* [eas-cli] Add version reader doc to avoid ambiguity

Co-authored-by: Evan Bacon <[email protected]>

* [eas-cli] Add tests for date precision utility

Co-authored-by: Evan Bacon <[email protected]>
2022-06-02 05:31:56 -07:00
Dominik Sokal dde9685b38 add common error code - fastlane timeout (#1129)
* add common error code - fastlane timeout

* address PR feedback

* update CHANGELOG.md
2022-06-01 11:55:53 +02:00
Dominik Sokal 5b3a76a5b5 [ENG-5022] print learn more link before uploading archive to S3 (#1127)
* print learn more link before uploading archive to S3

* update CHANGELOG.md
2022-05-31 09:54:25 +02:00
Dominik Sokal 513e09157b Update CHANGELOG.md 2022-05-30 12:28:49 +02:00
Expo CI 69a939c635 update CHANGELOG.md 2022-05-30 10:22:18 +00:00
60 changed files with 3962 additions and 55 deletions

No files matched your search

+14
View File
@@ -10,7 +10,21 @@ This is the log of notable changes to EAS CLI and related packages.
### 🐛 Bug fixes
### 🧹 Chores
- Display project archive docs before compressing/uploading to EAS Build. ([#1127](https://github.com/expo/eas-cli/pull/1127) by [@dsokal](https://github.com/dsokal))
- Add new common error code for submits. ([#1129](https://github.com/expo/eas-cli/pull/1129) by [@dsokal](https://github.com/dsokal))
## [0.53.0](https://github.com/expo/eas-cli/releases/tag/v0.53.0) - 2022-05-30
### 🛠 Breaking changes
- Drop support for Node < 14. ([#1098](https://github.com/expo/eas-cli/pull/1098) by [@dsokal](https://github.com/dsokal))
### 🐛 Bug fixes
- Match bundle identifier capabilities more accurately. ([#1112](https://github.com/expo/eas-cli/pull/1112) by [@EvanBacon](https://github.com/EvanBacon))
- No longer timeout on publishing updates for branches with many updates. ([#1119](https://github.com/expo/eas-cli/pull/1119)) by [@kgc00](https://github.com/kgc00/)
### 🧹 Chores
+1 -1
View File
@@ -1,5 +1,5 @@
{
"npmClient": "yarn",
"useWorkspaces": true,
"version": "0.53.0"
"version": "0.53.1"
}
+42 -42
View File
@@ -98,7 +98,7 @@ ALIASES
$ eas login
```
_See code: [src/commands/account/login.ts](https://github.com/expo/eas-cli/blob/v0.53.0/packages/eas-cli/src/commands/account/login.ts)_
_See code: [src/commands/account/login.ts](https://github.com/expo/eas-cli/blob/v0.53.1/packages/eas-cli/src/commands/account/login.ts)_
## `eas account:logout`
@@ -115,7 +115,7 @@ ALIASES
$ eas logout
```
_See code: [src/commands/account/logout.ts](https://github.com/expo/eas-cli/blob/v0.53.0/packages/eas-cli/src/commands/account/logout.ts)_
_See code: [src/commands/account/logout.ts](https://github.com/expo/eas-cli/blob/v0.53.1/packages/eas-cli/src/commands/account/logout.ts)_
## `eas account:view`
@@ -132,7 +132,7 @@ ALIASES
$ eas whoami
```
_See code: [src/commands/account/view.ts](https://github.com/expo/eas-cli/blob/v0.53.0/packages/eas-cli/src/commands/account/view.ts)_
_See code: [src/commands/account/view.ts](https://github.com/expo/eas-cli/blob/v0.53.1/packages/eas-cli/src/commands/account/view.ts)_
## `eas analytics [STATUS]`
@@ -146,7 +146,7 @@ DESCRIPTION
display or change analytics settings
```
_See code: [src/commands/analytics.ts](https://github.com/expo/eas-cli/blob/v0.53.0/packages/eas-cli/src/commands/analytics.ts)_
_See code: [src/commands/analytics.ts](https://github.com/expo/eas-cli/blob/v0.53.1/packages/eas-cli/src/commands/analytics.ts)_
## `eas autocomplete [SHELL]`
@@ -195,7 +195,7 @@ DESCRIPTION
create a branch
```
_See code: [src/commands/branch/create.ts](https://github.com/expo/eas-cli/blob/v0.53.0/packages/eas-cli/src/commands/branch/create.ts)_
_See code: [src/commands/branch/create.ts](https://github.com/expo/eas-cli/blob/v0.53.1/packages/eas-cli/src/commands/branch/create.ts)_
## `eas branch:delete [NAME]`
@@ -215,7 +215,7 @@ DESCRIPTION
delete a branch
```
_See code: [src/commands/branch/delete.ts](https://github.com/expo/eas-cli/blob/v0.53.0/packages/eas-cli/src/commands/branch/delete.ts)_
_See code: [src/commands/branch/delete.ts](https://github.com/expo/eas-cli/blob/v0.53.1/packages/eas-cli/src/commands/branch/delete.ts)_
## `eas branch:list`
@@ -232,7 +232,7 @@ DESCRIPTION
list all branches
```
_See code: [src/commands/branch/list.ts](https://github.com/expo/eas-cli/blob/v0.53.0/packages/eas-cli/src/commands/branch/list.ts)_
_See code: [src/commands/branch/list.ts](https://github.com/expo/eas-cli/blob/v0.53.1/packages/eas-cli/src/commands/branch/list.ts)_
## `eas branch:rename`
@@ -251,7 +251,7 @@ DESCRIPTION
rename a branch
```
_See code: [src/commands/branch/rename.ts](https://github.com/expo/eas-cli/blob/v0.53.0/packages/eas-cli/src/commands/branch/rename.ts)_
_See code: [src/commands/branch/rename.ts](https://github.com/expo/eas-cli/blob/v0.53.1/packages/eas-cli/src/commands/branch/rename.ts)_
## `eas branch:view [NAME]`
@@ -271,7 +271,7 @@ DESCRIPTION
view a branch
```
_See code: [src/commands/branch/view.ts](https://github.com/expo/eas-cli/blob/v0.53.0/packages/eas-cli/src/commands/branch/view.ts)_
_See code: [src/commands/branch/view.ts](https://github.com/expo/eas-cli/blob/v0.53.1/packages/eas-cli/src/commands/branch/view.ts)_
## `eas build`
@@ -300,7 +300,7 @@ DESCRIPTION
start a build
```
_See code: [src/commands/build/index.ts](https://github.com/expo/eas-cli/blob/v0.53.0/packages/eas-cli/src/commands/build/index.ts)_
_See code: [src/commands/build/index.ts](https://github.com/expo/eas-cli/blob/v0.53.1/packages/eas-cli/src/commands/build/index.ts)_
## `eas build:cancel [BUILD_ID]`
@@ -314,7 +314,7 @@ DESCRIPTION
cancel a build
```
_See code: [src/commands/build/cancel.ts](https://github.com/expo/eas-cli/blob/v0.53.0/packages/eas-cli/src/commands/build/cancel.ts)_
_See code: [src/commands/build/cancel.ts](https://github.com/expo/eas-cli/blob/v0.53.1/packages/eas-cli/src/commands/build/cancel.ts)_
## `eas build:configure`
@@ -331,7 +331,7 @@ DESCRIPTION
configure the project to support EAS Build
```
_See code: [src/commands/build/configure.ts](https://github.com/expo/eas-cli/blob/v0.53.0/packages/eas-cli/src/commands/build/configure.ts)_
_See code: [src/commands/build/configure.ts](https://github.com/expo/eas-cli/blob/v0.53.1/packages/eas-cli/src/commands/build/configure.ts)_
## `eas build:inspect`
@@ -366,7 +366,7 @@ DESCRIPTION
inspect the state of the project at specific build stages, useful for troubleshooting
```
_See code: [src/commands/build/inspect.ts](https://github.com/expo/eas-cli/blob/v0.53.0/packages/eas-cli/src/commands/build/inspect.ts)_
_See code: [src/commands/build/inspect.ts](https://github.com/expo/eas-cli/blob/v0.53.1/packages/eas-cli/src/commands/build/inspect.ts)_
## `eas build:list`
@@ -399,7 +399,7 @@ DESCRIPTION
list all builds for your project
```
_See code: [src/commands/build/list.ts](https://github.com/expo/eas-cli/blob/v0.53.0/packages/eas-cli/src/commands/build/list.ts)_
_See code: [src/commands/build/list.ts](https://github.com/expo/eas-cli/blob/v0.53.1/packages/eas-cli/src/commands/build/list.ts)_
## `eas build:submit`
@@ -444,7 +444,7 @@ DESCRIPTION
view a build for your project
```
_See code: [src/commands/build/view.ts](https://github.com/expo/eas-cli/blob/v0.53.0/packages/eas-cli/src/commands/build/view.ts)_
_See code: [src/commands/build/view.ts](https://github.com/expo/eas-cli/blob/v0.53.1/packages/eas-cli/src/commands/build/view.ts)_
## `eas channel:create [NAME]`
@@ -464,7 +464,7 @@ DESCRIPTION
create a channel
```
_See code: [src/commands/channel/create.ts](https://github.com/expo/eas-cli/blob/v0.53.0/packages/eas-cli/src/commands/channel/create.ts)_
_See code: [src/commands/channel/create.ts](https://github.com/expo/eas-cli/blob/v0.53.1/packages/eas-cli/src/commands/channel/create.ts)_
## `eas channel:edit [NAME]`
@@ -485,7 +485,7 @@ DESCRIPTION
point a channel at a new branch
```
_See code: [src/commands/channel/edit.ts](https://github.com/expo/eas-cli/blob/v0.53.0/packages/eas-cli/src/commands/channel/edit.ts)_
_See code: [src/commands/channel/edit.ts](https://github.com/expo/eas-cli/blob/v0.53.1/packages/eas-cli/src/commands/channel/edit.ts)_
## `eas channel:list`
@@ -502,7 +502,7 @@ DESCRIPTION
list all channels
```
_See code: [src/commands/channel/list.ts](https://github.com/expo/eas-cli/blob/v0.53.0/packages/eas-cli/src/commands/channel/list.ts)_
_See code: [src/commands/channel/list.ts](https://github.com/expo/eas-cli/blob/v0.53.1/packages/eas-cli/src/commands/channel/list.ts)_
## `eas channel:view [NAME]`
@@ -522,7 +522,7 @@ DESCRIPTION
view a channel
```
_See code: [src/commands/channel/view.ts](https://github.com/expo/eas-cli/blob/v0.53.0/packages/eas-cli/src/commands/channel/view.ts)_
_See code: [src/commands/channel/view.ts](https://github.com/expo/eas-cli/blob/v0.53.1/packages/eas-cli/src/commands/channel/view.ts)_
## `eas config`
@@ -540,7 +540,7 @@ DESCRIPTION
display project configuration (app.json + eas.json)
```
_See code: [src/commands/config.ts](https://github.com/expo/eas-cli/blob/v0.53.0/packages/eas-cli/src/commands/config.ts)_
_See code: [src/commands/config.ts](https://github.com/expo/eas-cli/blob/v0.53.1/packages/eas-cli/src/commands/config.ts)_
## `eas credentials`
@@ -554,7 +554,7 @@ DESCRIPTION
manage credentials
```
_See code: [src/commands/credentials.ts](https://github.com/expo/eas-cli/blob/v0.53.0/packages/eas-cli/src/commands/credentials.ts)_
_See code: [src/commands/credentials.ts](https://github.com/expo/eas-cli/blob/v0.53.1/packages/eas-cli/src/commands/credentials.ts)_
## `eas device:create`
@@ -568,7 +568,7 @@ DESCRIPTION
register new Apple Devices to use for internal distribution
```
_See code: [src/commands/device/create.ts](https://github.com/expo/eas-cli/blob/v0.53.0/packages/eas-cli/src/commands/device/create.ts)_
_See code: [src/commands/device/create.ts](https://github.com/expo/eas-cli/blob/v0.53.1/packages/eas-cli/src/commands/device/create.ts)_
## `eas device:delete`
@@ -586,7 +586,7 @@ DESCRIPTION
remove a registered device from your account
```
_See code: [src/commands/device/delete.ts](https://github.com/expo/eas-cli/blob/v0.53.0/packages/eas-cli/src/commands/device/delete.ts)_
_See code: [src/commands/device/delete.ts](https://github.com/expo/eas-cli/blob/v0.53.1/packages/eas-cli/src/commands/device/delete.ts)_
## `eas device:list`
@@ -603,7 +603,7 @@ DESCRIPTION
list all registered devices for your account
```
_See code: [src/commands/device/list.ts](https://github.com/expo/eas-cli/blob/v0.53.0/packages/eas-cli/src/commands/device/list.ts)_
_See code: [src/commands/device/list.ts](https://github.com/expo/eas-cli/blob/v0.53.1/packages/eas-cli/src/commands/device/list.ts)_
## `eas device:view [UDID]`
@@ -617,7 +617,7 @@ DESCRIPTION
view a device for your project
```
_See code: [src/commands/device/view.ts](https://github.com/expo/eas-cli/blob/v0.53.0/packages/eas-cli/src/commands/device/view.ts)_
_See code: [src/commands/device/view.ts](https://github.com/expo/eas-cli/blob/v0.53.1/packages/eas-cli/src/commands/device/view.ts)_
## `eas diagnostics`
@@ -631,7 +631,7 @@ DESCRIPTION
display environment info
```
_See code: [src/commands/diagnostics.ts](https://github.com/expo/eas-cli/blob/v0.53.0/packages/eas-cli/src/commands/diagnostics.ts)_
_See code: [src/commands/diagnostics.ts](https://github.com/expo/eas-cli/blob/v0.53.1/packages/eas-cli/src/commands/diagnostics.ts)_
## `eas help [COMMAND]`
@@ -710,7 +710,7 @@ DESCRIPTION
information about the current project
```
_See code: [src/commands/project/info.ts](https://github.com/expo/eas-cli/blob/v0.53.0/packages/eas-cli/src/commands/project/info.ts)_
_See code: [src/commands/project/info.ts](https://github.com/expo/eas-cli/blob/v0.53.1/packages/eas-cli/src/commands/project/info.ts)_
## `eas project:init`
@@ -727,7 +727,7 @@ ALIASES
$ eas init
```
_See code: [src/commands/project/init.ts](https://github.com/expo/eas-cli/blob/v0.53.0/packages/eas-cli/src/commands/project/init.ts)_
_See code: [src/commands/project/init.ts](https://github.com/expo/eas-cli/blob/v0.53.1/packages/eas-cli/src/commands/project/init.ts)_
## `eas secret:create`
@@ -747,7 +747,7 @@ DESCRIPTION
create an environment secret on the current project or owner account
```
_See code: [src/commands/secret/create.ts](https://github.com/expo/eas-cli/blob/v0.53.0/packages/eas-cli/src/commands/secret/create.ts)_
_See code: [src/commands/secret/create.ts](https://github.com/expo/eas-cli/blob/v0.53.1/packages/eas-cli/src/commands/secret/create.ts)_
## `eas secret:delete`
@@ -764,7 +764,7 @@ DESCRIPTION
delete an environment secret by ID
```
_See code: [src/commands/secret/delete.ts](https://github.com/expo/eas-cli/blob/v0.53.0/packages/eas-cli/src/commands/secret/delete.ts)_
_See code: [src/commands/secret/delete.ts](https://github.com/expo/eas-cli/blob/v0.53.1/packages/eas-cli/src/commands/secret/delete.ts)_
## `eas secret:list`
@@ -778,7 +778,7 @@ DESCRIPTION
list environment secrets available for your current app
```
_See code: [src/commands/secret/list.ts](https://github.com/expo/eas-cli/blob/v0.53.0/packages/eas-cli/src/commands/secret/list.ts)_
_See code: [src/commands/secret/list.ts](https://github.com/expo/eas-cli/blob/v0.53.1/packages/eas-cli/src/commands/secret/list.ts)_
## `eas submit`
@@ -808,7 +808,7 @@ ALIASES
$ eas build:submit
```
_See code: [src/commands/submit.ts](https://github.com/expo/eas-cli/blob/v0.53.0/packages/eas-cli/src/commands/submit.ts)_
_See code: [src/commands/submit.ts](https://github.com/expo/eas-cli/blob/v0.53.1/packages/eas-cli/src/commands/submit.ts)_
## `eas update`
@@ -838,7 +838,7 @@ DESCRIPTION
publish an update group
```
_See code: [src/commands/update/index.ts](https://github.com/expo/eas-cli/blob/v0.53.0/packages/eas-cli/src/commands/update/index.ts)_
_See code: [src/commands/update/index.ts](https://github.com/expo/eas-cli/blob/v0.53.1/packages/eas-cli/src/commands/update/index.ts)_
## `eas update:configure`
@@ -855,7 +855,7 @@ DESCRIPTION
configure the project to support EAS Update
```
_See code: [src/commands/update/configure.ts](https://github.com/expo/eas-cli/blob/v0.53.0/packages/eas-cli/src/commands/update/configure.ts)_
_See code: [src/commands/update/configure.ts](https://github.com/expo/eas-cli/blob/v0.53.1/packages/eas-cli/src/commands/update/configure.ts)_
## `eas update:delete GROUPID`
@@ -875,7 +875,7 @@ DESCRIPTION
delete all the updates in an update group
```
_See code: [src/commands/update/delete.ts](https://github.com/expo/eas-cli/blob/v0.53.0/packages/eas-cli/src/commands/update/delete.ts)_
_See code: [src/commands/update/delete.ts](https://github.com/expo/eas-cli/blob/v0.53.1/packages/eas-cli/src/commands/update/delete.ts)_
## `eas update:list`
@@ -894,7 +894,7 @@ DESCRIPTION
view the recent updates for a branch
```
_See code: [src/commands/update/list.ts](https://github.com/expo/eas-cli/blob/v0.53.0/packages/eas-cli/src/commands/update/list.ts)_
_See code: [src/commands/update/list.ts](https://github.com/expo/eas-cli/blob/v0.53.1/packages/eas-cli/src/commands/update/list.ts)_
## `eas update:view GROUPID`
@@ -914,7 +914,7 @@ DESCRIPTION
update group details
```
_See code: [src/commands/update/view.ts](https://github.com/expo/eas-cli/blob/v0.53.0/packages/eas-cli/src/commands/update/view.ts)_
_See code: [src/commands/update/view.ts](https://github.com/expo/eas-cli/blob/v0.53.1/packages/eas-cli/src/commands/update/view.ts)_
## `eas webhook:create`
@@ -934,7 +934,7 @@ DESCRIPTION
create a webhook
```
_See code: [src/commands/webhook/create.ts](https://github.com/expo/eas-cli/blob/v0.53.0/packages/eas-cli/src/commands/webhook/create.ts)_
_See code: [src/commands/webhook/create.ts](https://github.com/expo/eas-cli/blob/v0.53.1/packages/eas-cli/src/commands/webhook/create.ts)_
## `eas webhook:delete [ID]`
@@ -951,7 +951,7 @@ DESCRIPTION
delete a webhook
```
_See code: [src/commands/webhook/delete.ts](https://github.com/expo/eas-cli/blob/v0.53.0/packages/eas-cli/src/commands/webhook/delete.ts)_
_See code: [src/commands/webhook/delete.ts](https://github.com/expo/eas-cli/blob/v0.53.1/packages/eas-cli/src/commands/webhook/delete.ts)_
## `eas webhook:list`
@@ -968,7 +968,7 @@ DESCRIPTION
list webhooks
```
_See code: [src/commands/webhook/list.ts](https://github.com/expo/eas-cli/blob/v0.53.0/packages/eas-cli/src/commands/webhook/list.ts)_
_See code: [src/commands/webhook/list.ts](https://github.com/expo/eas-cli/blob/v0.53.1/packages/eas-cli/src/commands/webhook/list.ts)_
## `eas webhook:update`
@@ -989,7 +989,7 @@ DESCRIPTION
update a webhook
```
_See code: [src/commands/webhook/update.ts](https://github.com/expo/eas-cli/blob/v0.53.0/packages/eas-cli/src/commands/webhook/update.ts)_
_See code: [src/commands/webhook/update.ts](https://github.com/expo/eas-cli/blob/v0.53.1/packages/eas-cli/src/commands/webhook/update.ts)_
## `eas webhook:view ID`
@@ -1006,7 +1006,7 @@ DESCRIPTION
view a webhook
```
_See code: [src/commands/webhook/view.ts](https://github.com/expo/eas-cli/blob/v0.53.0/packages/eas-cli/src/commands/webhook/view.ts)_
_See code: [src/commands/webhook/view.ts](https://github.com/expo/eas-cli/blob/v0.53.1/packages/eas-cli/src/commands/webhook/view.ts)_
## `eas whoami`
+3 -2
View File
@@ -1,7 +1,7 @@
{
"name": "eas-cli",
"description": "EAS command line tool",
"version": "0.53.0",
"version": "0.53.1",
"author": "Expo <[email protected]>",
"bin": {
"eas": "./bin/run"
@@ -14,7 +14,7 @@
"@expo/config-plugins": "4.1.4",
"@expo/config-types": "45.0.0",
"@expo/eas-build-job": "0.2.72",
"@expo/eas-json": "0.53.0",
"@expo/eas-json": "0.53.1",
"@expo/json-file": "8.2.36",
"@expo/multipart-body-parser": "1.1.0",
"@expo/pkcs12": "0.0.8",
@@ -30,6 +30,7 @@
"@oclif/core": "1.9.0",
"@urql/core": "2.4.4",
"@urql/exchange-retry": "0.3.3",
"ajv": "^6.12.6",
"chalk": "4.1.2",
"cli-progress": "3.11.0",
"cli-table3": "0.6.2",
+928
View File
@@ -0,0 +1,928 @@
{
"$schema": "http://json-schema.org/draft-06/schema",
"type": "object",
"definitions": {
"apple": {
"AppleLocalizedPreviewFolder": {
"anyOf": [
{
"description": "Path to folder containing preview files",
"type": "string"
},
{
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
}
]
},
"AppleKidsAge": {
"enum": ["FIVE_AND_UNDER", "SIX_TO_EIGHT", "NINE_TO_ELEVEN"]
},
"AppleRating": {
"enum": ["NONE", "INFREQUENT_OR_MILD", "FREQUENT_OR_INTENSE"]
},
"AppleCategory": {
"enum": [
"FOOD_AND_DRINK",
"BUSINESS",
"EDUCATION",
"SOCIAL_NETWORKING",
"BOOKS",
"SPORTS",
"FINANCE",
"REFERENCE",
"GRAPHICS_AND_DESIGN",
"DEVELOPER_TOOLS",
"HEALTH_AND_FITNESS",
"MUSIC",
"WEATHER",
"TRAVEL",
"ENTERTAINMENT",
"STICKERS",
"GAMES",
"LIFESTYLE",
"MEDICAL",
"MAGAZINES_AND_NEWSPAPERS",
"UTILITIES",
"SHOPPING",
"PRODUCTIVITY",
"NEWS",
"PHOTO_AND_VIDEO",
"NAVIGATION"
]
},
"AppleSubcategory": {
"enum": [
"STICKERS_PLACES_AND_OBJECTS",
"STICKERS_EMOJI_AND_EXPRESSIONS",
"STICKERS_CELEBRATIONS",
"STICKERS_CELEBRITIES",
"STICKERS_MOVIES_AND_TV",
"STICKERS_SPORTS_AND_ACTIVITIES",
"STICKERS_EATING_AND_DRINKING",
"STICKERS_CHARACTERS",
"STICKERS_ANIMALS",
"STICKERS_FASHION",
"STICKERS_ART",
"STICKERS_GAMING",
"STICKERS_KIDS_AND_FAMILY",
"STICKERS_PEOPLE",
"STICKERS_MUSIC",
"GAMES_SPORTS",
"GAMES_WORD",
"GAMES_MUSIC",
"GAMES_ADVENTURE",
"GAMES_ACTION",
"GAMES_ROLE_PLAYING",
"GAMES_CASUAL",
"GAMES_BOARD",
"GAMES_TRIVIA",
"GAMES_CARD",
"GAMES_PUZZLE",
"GAMES_CASINO",
"GAMES_STRATEGY",
"GAMES_SIMULATION",
"GAMES_RACING",
"GAMES_FAMILY"
]
},
"AppleIdfa": {
"description": "Identifier for Advertisers",
"type": "object",
"additionalProperties": false,
"defaultSnippets": [
{
"body": {
"servesAds": false,
"attributesAppInstallationToPreviousAd": false,
"attributesActionWithPreviousAd": false,
"honorsLimitedAdTracking": false
}
}
],
"properties": {
"servesAds": {
"type": "boolean"
},
"attributesAppInstallationToPreviousAd": {
"type": "boolean"
},
"attributesActionWithPreviousAd": {
"type": "boolean"
},
"honorsLimitedAdTracking": {
"type": "boolean"
}
}
},
"AppleInfo": {
"type": "object",
"additionalProperties": false,
"required": [
"title",
"subtitle",
"description",
"keywords",
"marketingUrl",
"supportUrl",
"privacyPolicyUrl"
],
"defaultSnippets": [
{
"label": "Basic",
"body": {
}
},
{
"label": "Interactive",
"description": "Creates localized app info",
"body": {
"title": "$1",
"subtitle": "$2",
"description": "$3",
"keywords": [],
"marketingUrl": "",
"supportUrl": "",
"privacyPolicyUrl": ""
}
}
],
"properties": {
"title": {
"description": "Name of the app in the store. This should be similar to the installed app name.",
"type": "string",
"maxLength": 30,
"meta": {
"storeInfo": "The name will be reviewed before it is made available on the App Store."
}
},
"subtitle": {
"description": "Subtext for the app. Example: 'A Fun Game For Friends'",
"type": "string",
"maxLength": 30,
"meta": {
"storeInfo": "The subtitle will be reviewed before it is made available on the App Store."
}
},
"description": {
"meta": {
"versioned": true,
"liveEdits": true
},
"maxLength": 4000,
"description": "Main description of what the app does",
"type": "string"
},
"promoText": {
"meta": {
"versioned": true,
"liveEdits": true,
"aso": false
},
"maxLength": 170,
"description": "Short tagline for the app",
"type": "string"
},
"keywords": {
"meta": {
"versioned": true
},
"description": "List of keywords to help users find the app in the App Store",
"type": "array",
"uniqueItems": true,
"items": {
"maxLength": 100,
"type": "string"
}
},
"privacyPolicyText": {
"type": "string",
"description": "Privacy policy for Apple TV"
},
"whatsNew": {
"meta": {
"versioned": true,
"liveEdits": true
},
"maxLength": 4000,
"description": "Changes since the last public version",
"type": "string"
},
"marketingUrl": {
"meta": {
"versioned": true,
"liveEdits": true
},
"description": "URL to the app marketing page",
"type": "string"
},
"supportUrl": {
"meta": {
"versioned": true,
"liveEdits": true
},
"description": "URL to the app support page",
"type": "string"
},
"privacyPolicyUrl": {
"meta": {
"versioned": true,
"liveEdits": true
},
"maxLength": 255,
"description": "A URL that links to your privacy policy. A privacy policy is required for all apps.",
"type": "string"
},
"privacyChoicesUrl": {
"meta": {
"versioned": true,
"liveEdits": true,
"optional": true
},
"maxLength": 255,
"description": "A URL where users can modify and delete the data collected from the app, or decide how their data is used and shared.",
"type": "string"
}
}
},
"AppleAdvisory": {
"type": "object",
"additionalProperties": false,
"defaultSnippets": [
{
"label": "Minimum",
"description": "The bare minimum rating, your app does nothing",
"body": {
"alcoholTobaccoOrDrugUseOrReferences": "NONE",
"contests": "NONE",
"gamblingSimulated": "NONE",
"medicalOrTreatmentInformation": "NONE",
"profanityOrCrudeHumor": "NONE",
"sexualContentGraphicAndNudity": "NONE",
"sexualContentOrNudity": "NONE",
"horrorOrFearThemes": "NONE",
"matureOrSuggestiveThemes": "NONE",
"violenceCartoonOrFantasy": "NONE",
"violenceRealisticProlongedGraphicOrSadistic": "NONE",
"violenceRealistic": "NONE",
"gamblingAndContests":false,
"gambling": false,
"kidsAgeBand": null,
"seventeenPlus": false,
"unrestrictedWebAccess": false
}
},
{
"label": "Interactive",
"description": "Step through options",
"body": {
"alcoholTobaccoOrDrugUseOrReferences": "${1|NONE,INFREQUENT_OR_MILD,FREQUENT_OR_INTENSE|}",
"contests": "${2|NONE,INFREQUENT_OR_MILD,FREQUENT_OR_INTENSE|}",
"gamblingSimulated": "${3|NONE,INFREQUENT_OR_MILD,FREQUENT_OR_INTENSE|}",
"medicalOrTreatmentInformation": "${4|NONE,INFREQUENT_OR_MILD,FREQUENT_OR_INTENSE|}",
"profanityOrCrudeHumor": "${5|NONE,INFREQUENT_OR_MILD,FREQUENT_OR_INTENSE|}",
"sexualContentGraphicAndNudity": "${6|NONE,INFREQUENT_OR_MILD,FREQUENT_OR_INTENSE|}",
"sexualContentOrNudity": "${7|NONE,INFREQUENT_OR_MILD,FREQUENT_OR_INTENSE|}",
"horrorOrFearThemes": "${8|NONE,INFREQUENT_OR_MILD,FREQUENT_OR_INTENSE|}",
"matureOrSuggestiveThemes": "${9|NONE,INFREQUENT_OR_MILD,FREQUENT_OR_INTENSE|}",
"violenceCartoonOrFantasy": "${10|NONE,INFREQUENT_OR_MILD,FREQUENT_OR_INTENSE|}",
"violenceRealisticProlongedGraphicOrSadistic": "${11|NONE,INFREQUENT_OR_MILD,FREQUENT_OR_INTENSE|}",
"violenceRealistic": "${12|NONE,INFREQUENT_OR_MILD,FREQUENT_OR_INTENSE|}",
"gamblingAndContests":false,
"gambling": false,
"kidsAgeBand": null,
"seventeenPlus": false,
"unrestrictedWebAccess": false
}
}
],
"properties": {
"alcoholTobaccoOrDrugUseOrReferences": {
"$ref": "#/definitions/apple/AppleRating"
},
"contests": {
"$ref": "#/definitions/apple/AppleRating"
},
"gamblingAndContests": {
"type": "boolean"
},
"gambling": {
"type": "boolean"
},
"gamblingSimulated": {
"$ref": "#/definitions/apple/AppleRating"
},
"kidsAgeBand": {
"anyOf": [
{
"$ref": "#/definitions/apple/AppleKidsAge"
},
{
"type": "null"
}
]
},
"medicalOrTreatmentInformation": {
"$ref": "#/definitions/apple/AppleRating"
},
"profanityOrCrudeHumor": {
"$ref": "#/definitions/apple/AppleRating"
},
"sexualContentGraphicAndNudity": {
"$ref": "#/definitions/apple/AppleRating"
},
"sexualContentOrNudity": {
"$ref": "#/definitions/apple/AppleRating"
},
"seventeenPlus": {
"type": "boolean"
},
"horrorOrFearThemes": {
"$ref": "#/definitions/apple/AppleRating"
},
"matureOrSuggestiveThemes": {
"$ref": "#/definitions/apple/AppleRating"
},
"unrestrictedWebAccess": {
"type": "boolean"
},
"violenceCartoonOrFantasy": {
"$ref": "#/definitions/apple/AppleRating"
},
"violenceRealisticProlongedGraphicOrSadistic": {
"$ref": "#/definitions/apple/AppleRating"
},
"violenceRealistic": {
"$ref": "#/definitions/apple/AppleRating"
}
}
},
"AppleRelease": {
"type": "object",
"additionalProperties": false,
"defaultSnippets": [
{
"body": {
"automaticRelease": true,
"usesThirdPartyContent": false,
"usesNonExemptEncryption": false
}
}
],
"properties": {
"autoReleaseDate": {
"description": "ISO Date to release the app automatically. Leave undefined to manually release the app to the public.",
"defaultSnippets": [
{
"body": "$CURRENT_YEAR-${1:$CURRENT_MONTH}-${2:$CURRENT_DATE}"
}
],
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "string",
"format": "date"
},
{
"type": "number"
}
]
},
"isPhasedReleaseEnabled": {
"type": "boolean",
"description": "Release update over 7-day period instead of instantly.",
"meta": {
"storeInfo": "Phased release for automatic updates lets you gradually release this update over a 7-day period to users who have turned on automatic updates. Keep in mind that this version will still be available to all users as a manual update from the App Store. You can pause the phased release for up to 30 days or release this update to all users at any time. [Learn More](https://help.apple.com/app-store-connect/#/dev3d65fcee1)."
}
},
"shouldResetRatings": {
"description": "Should App Store ratings be reset for this version of the app.",
"type": "boolean",
"meta": {
"storeInfo": "You can reset your app’s summary rating for all countries or regions when you release this version. Keep in mind that once this version is released, you won’t be able to restore the rating. Your app’s existing customer reviews will still appear on the App Store."
}
},
"usesThirdPartyContent": {
"type": "boolean"
},
"automaticRelease": {
"description": "Should the app automatically be released when approved by App Store review.",
"type": "boolean"
},
"usesNonExemptEncryption": {
"description": "Alternative to setting `ITSAppUsesNonExemptEncryption` in the binary's `Info.plist`.",
"type": "boolean"
}
}
},
"AppleReview": {
"type": "object",
"description": "Info provided to the App Store review team to help them understand how to use your app.",
"required": ["firstName", "lastName"],
"defaultSnippets": [
{
"body": {
"firstName": "$1",
"lastName": "$2"
}
}
],
"properties": {
"demoUsername": {
"description": "Optional username for testing the app.",
"type": "string"
},
"demoPassword": {
"description": "Optional password for testing the app.",
"type": "string"
},
"attachment": {
"description": "Local file path to upload to the review team.",
"type": "string"
},
"firstName": {
"description": "Developer first name for the reviewer to contact.",
"type": "string"
},
"lastName": {
"description": "Developer last name (surname) for the reviewer to contact.",
"type": "string"
},
"phone": {
"description": "Developer phone number for the reviewer to contact.",
"type": "string"
},
"email": {
"description": "Developer email address for the reviewer to contact.",
"type": "string",
"format": "email"
},
"notes": {
"description": "Any additional notes for the App Store reviewer.",
"type": "string"
}
}
}
},
"AppleConfig": {
"description": "Configuration that is specific to the Apple App Store.",
"type": "object",
"additionalProperties": false,
"properties": {
"advisory": {
"$ref": "#/definitions/apple/AppleAdvisory"
},
"categories": {
"type": "array",
"maxItems": 2,
"description": "App Store categories for the app. Can add up to two categories. STICKERS and GAMES categories can add an additional subcategory.",
"items": {
"anyOf": [
{
"$ref": "#/definitions/apple/AppleCategory"
},
{
"type": "array",
"maxItems": 2,
"items": [
{
"enum": ["GAMES"]
},
{
"enum": [
"GAMES_SPORTS",
"GAMES_WORD",
"GAMES_MUSIC",
"GAMES_ADVENTURE",
"GAMES_ACTION",
"GAMES_ROLE_PLAYING",
"GAMES_CASUAL",
"GAMES_BOARD",
"GAMES_TRIVIA",
"GAMES_CARD",
"GAMES_PUZZLE",
"GAMES_CASINO",
"GAMES_STRATEGY",
"GAMES_SIMULATION",
"GAMES_RACING",
"GAMES_FAMILY"
]
}
],
"additionalItems": false
},
{
"type": "array",
"maxItems": 2,
"items": [
{
"enum": ["STICKERS"]
},
{
"enum": [
"STICKERS_PLACES_AND_OBJECTS",
"STICKERS_EMOJI_AND_EXPRESSIONS",
"STICKERS_CELEBRATIONS",
"STICKERS_CELEBRITIES",
"STICKERS_MOVIES_AND_TV",
"STICKERS_SPORTS_AND_ACTIVITIES",
"STICKERS_EATING_AND_DRINKING",
"STICKERS_CHARACTERS",
"STICKERS_ANIMALS",
"STICKERS_FASHION",
"STICKERS_ART",
"STICKERS_GAMING",
"STICKERS_KIDS_AND_FAMILY",
"STICKERS_PEOPLE",
"STICKERS_MUSIC"
]
}
],
"additionalItems": false
}
]
}
},
"copyright": {
"defaultSnippets": [
{
"body": "$CURRENT_YEAR ${1:name}"
}
],
"meta": {
"versioned": true,
"liveEdits": true,
"storeInfo": "The name of the person or entity that owns the exclusive rights to your app, preceded by the year the rights were obtained (for example, \"2008 Acme Inc.\"). Do not provide a URL."
},
"description": "The updated company copyright. Example: 2021 Evan Bacon",
"type": "string"
},
"idfa": {
"$ref": "#/definitions/apple/AppleIdfa"
},
"info": {
"description": "Localized core app info",
"type": "object",
"additionalProperties": false,
"properties": {
"ar-SA": {
"$ref": "#/definitions/apple/AppleInfo",
"description": "Arabic"
},
"ca": {
"$ref": "#/definitions/apple/AppleInfo",
"description": "Catalan"
},
"zh-Hans": {
"$ref": "#/definitions/apple/AppleInfo",
"description": "Chinese (Simplified)"
},
"zh-Hant": {
"$ref": "#/definitions/apple/AppleInfo",
"description": "Chinese (Traditional)"
},
"hr": {
"$ref": "#/definitions/apple/AppleInfo",
"description": "Croatian"
},
"cs": {
"$ref": "#/definitions/apple/AppleInfo",
"description": "Czech"
},
"da": {
"$ref": "#/definitions/apple/AppleInfo",
"description": "Danish"
},
"nl-NL": {
"$ref": "#/definitions/apple/AppleInfo",
"description": "Dutch"
},
"en-AU": {
"$ref": "#/definitions/apple/AppleInfo",
"description": "English (Australia)"
},
"en-CA": {
"$ref": "#/definitions/apple/AppleInfo",
"description": "English (Canada)"
},
"en-GB": {
"$ref": "#/definitions/apple/AppleInfo",
"description": "English (U.K.)"
},
"en-US": {
"$ref": "#/definitions/apple/AppleInfo",
"description": "English (U.S.)"
},
"fi": {
"$ref": "#/definitions/apple/AppleInfo",
"description": "Finnish"
},
"fr-FR": {
"$ref": "#/definitions/apple/AppleInfo",
"description": "French"
},
"fr-CA": {
"$ref": "#/definitions/apple/AppleInfo",
"description": "French (Canada)"
},
"de-DE": {
"$ref": "#/definitions/apple/AppleInfo",
"description": "German"
},
"el": {
"$ref": "#/definitions/apple/AppleInfo",
"description": "Greek"
},
"he": {
"$ref": "#/definitions/apple/AppleInfo",
"description": "Hebrew"
},
"hi": {
"$ref": "#/definitions/apple/AppleInfo",
"description": "Hindi"
},
"hu": {
"$ref": "#/definitions/apple/AppleInfo",
"description": "Hungarian"
},
"id": {
"$ref": "#/definitions/apple/AppleInfo",
"description": "Indonesian"
},
"it": {
"$ref": "#/definitions/apple/AppleInfo",
"description": "Italian"
},
"ja": {
"$ref": "#/definitions/apple/AppleInfo",
"description": "Japanese"
},
"ko": {
"$ref": "#/definitions/apple/AppleInfo",
"description": "Korean"
},
"ms": {
"$ref": "#/definitions/apple/AppleInfo",
"description": "Malay"
},
"no": {
"$ref": "#/definitions/apple/AppleInfo",
"description": "Norwegian"
},
"pl": {
"$ref": "#/definitions/apple/AppleInfo",
"description": "Polish"
},
"pt-BR": {
"$ref": "#/definitions/apple/AppleInfo",
"description": "Portuguese (Brazil)"
},
"pt-PT": {
"$ref": "#/definitions/apple/AppleInfo",
"description": "Portuguese (Portugal)"
},
"ro": {
"$ref": "#/definitions/apple/AppleInfo",
"description": "Romanian"
},
"ru": {
"$ref": "#/definitions/apple/AppleInfo",
"description": "Russian"
},
"sk": {
"$ref": "#/definitions/apple/AppleInfo",
"description": "Slovak"
},
"es-MX": {
"$ref": "#/definitions/apple/AppleInfo",
"description": "Spanish (Mexico)"
},
"es-ES": {
"$ref": "#/definitions/apple/AppleInfo",
"description": "Spanish (Spain)"
},
"sv": {
"$ref": "#/definitions/apple/AppleInfo",
"description": "Swedish"
},
"th": {
"$ref": "#/definitions/apple/AppleInfo",
"description": "Thai"
},
"tr": {
"$ref": "#/definitions/apple/AppleInfo",
"description": "Turkish"
},
"uk": {
"$ref": "#/definitions/apple/AppleInfo",
"description": "Ukrainian"
},
"vi": {
"$ref": "#/definitions/apple/AppleInfo",
"description": "Vietnamese"
}
}
},
"preview": {
"anyOf": [
{
"description": "Path to localized folders containing preview files",
"type": "string"
},
{
"description": "Localized previews object. Ex: `\"en-US\": [\"image.png\"]`",
"type": "object",
"additionalProperties": false,
"properties": {
"ar-SA": {
"$ref": "#/definitions/apple/AppleLocalizedPreviewFolder",
"description": "Arabic"
},
"ca": {
"$ref": "#/definitions/apple/AppleLocalizedPreviewFolder",
"description": "Catalan"
},
"zh-Hans": {
"$ref": "#/definitions/apple/AppleLocalizedPreviewFolder",
"description": "Chinese (Simplified)"
},
"zh-Hant": {
"$ref": "#/definitions/apple/AppleLocalizedPreviewFolder",
"description": "Chinese (Traditional)"
},
"hr": {
"$ref": "#/definitions/apple/AppleLocalizedPreviewFolder",
"description": "Croatian"
},
"cs": {
"$ref": "#/definitions/apple/AppleLocalizedPreviewFolder",
"description": "Czech"
},
"da": {
"$ref": "#/definitions/apple/AppleLocalizedPreviewFolder",
"description": "Danish"
},
"nl-NL": {
"$ref": "#/definitions/apple/AppleLocalizedPreviewFolder",
"description": "Dutch"
},
"en-AU": {
"$ref": "#/definitions/apple/AppleLocalizedPreviewFolder",
"description": "English (Australia)"
},
"en-CA": {
"$ref": "#/definitions/apple/AppleLocalizedPreviewFolder",
"description": "English (Canada)"
},
"en-GB": {
"$ref": "#/definitions/apple/AppleLocalizedPreviewFolder",
"description": "English (U.K.)"
},
"en-US": {
"$ref": "#/definitions/apple/AppleLocalizedPreviewFolder",
"description": "English (U.S.)"
},
"fi": {
"$ref": "#/definitions/apple/AppleLocalizedPreviewFolder",
"description": "Finnish"
},
"fr-FR": {
"$ref": "#/definitions/apple/AppleLocalizedPreviewFolder",
"description": "French"
},
"fr-CA": {
"$ref": "#/definitions/apple/AppleLocalizedPreviewFolder",
"description": "French (Canada)"
},
"de-DE": {
"$ref": "#/definitions/apple/AppleLocalizedPreviewFolder",
"description": "German"
},
"el": {
"$ref": "#/definitions/apple/AppleLocalizedPreviewFolder",
"description": "Greek"
},
"he": {
"$ref": "#/definitions/apple/AppleLocalizedPreviewFolder",
"description": "Hebrew"
},
"hi": {
"$ref": "#/definitions/apple/AppleLocalizedPreviewFolder",
"description": "Hindi"
},
"hu": {
"$ref": "#/definitions/apple/AppleLocalizedPreviewFolder",
"description": "Hungarian"
},
"id": {
"$ref": "#/definitions/apple/AppleLocalizedPreviewFolder",
"description": "Indonesian"
},
"it": {
"$ref": "#/definitions/apple/AppleLocalizedPreviewFolder",
"description": "Italian"
},
"ja": {
"$ref": "#/definitions/apple/AppleLocalizedPreviewFolder",
"description": "Japanese"
},
"ko": {
"$ref": "#/definitions/apple/AppleLocalizedPreviewFolder",
"description": "Korean"
},
"ms": {
"$ref": "#/definitions/apple/AppleLocalizedPreviewFolder",
"description": "Malay"
},
"no": {
"$ref": "#/definitions/apple/AppleLocalizedPreviewFolder",
"description": "Norwegian"
},
"pl": {
"$ref": "#/definitions/apple/AppleLocalizedPreviewFolder",
"description": "Polish"
},
"pt-BR": {
"$ref": "#/definitions/apple/AppleLocalizedPreviewFolder",
"description": "Portuguese (Brazil)"
},
"pt-PT": {
"$ref": "#/definitions/apple/AppleLocalizedPreviewFolder",
"description": "Portuguese (Portugal)"
},
"ro": {
"$ref": "#/definitions/apple/AppleLocalizedPreviewFolder",
"description": "Romanian"
},
"ru": {
"$ref": "#/definitions/apple/AppleLocalizedPreviewFolder",
"description": "Russian"
},
"sk": {
"$ref": "#/definitions/apple/AppleLocalizedPreviewFolder",
"description": "Slovak"
},
"es-MX": {
"$ref": "#/definitions/apple/AppleLocalizedPreviewFolder",
"description": "Spanish (Mexico)"
},
"es-ES": {
"$ref": "#/definitions/apple/AppleLocalizedPreviewFolder",
"description": "Spanish (Spain)"
},
"sv": {
"$ref": "#/definitions/apple/AppleLocalizedPreviewFolder",
"description": "Swedish"
},
"th": {
"$ref": "#/definitions/apple/AppleLocalizedPreviewFolder",
"description": "Thai"
},
"tr": {
"$ref": "#/definitions/apple/AppleLocalizedPreviewFolder",
"description": "Turkish"
},
"uk": {
"$ref": "#/definitions/apple/AppleLocalizedPreviewFolder",
"description": "Ukrainian"
},
"vi": {
"$ref": "#/definitions/apple/AppleLocalizedPreviewFolder",
"description": "Vietnamese"
}
}
}
]
},
"release": {
"description": "Release strategy",
"$ref": "#/definitions/apple/AppleRelease"
},
"review": {
"description": "Info for the App Store reviewer",
"$ref": "#/definitions/apple/AppleReview"
},
"priceTier": {
"description": "App price tier. 0 is Free.",
"type": "number"
}
}
}
},
"properties": {
"configVersion": {
"const": 0
},
"apple": {
"$ref": "#/definitions/AppleConfig"
}
},
"additionalProperties": false,
"required": ["configVersion", "apple"]
}
+6 -1
View File
@@ -1,5 +1,5 @@
import { logEvent } from './rudderstackClient';
export type Event = BuildEvent | SubmissionEvent;
export type Event = BuildEvent | SubmissionEvent | MetadataEvent;
export enum SubmissionEvent {
SUBMIT_COMMAND = 'submit cli submit command',
@@ -45,6 +45,11 @@ export enum BuildEvent {
ANDROID_KEYSTORE_CREATE = 'build cli credentials keystore create',
}
export enum MetadataEvent {
APPLE_METADATA_DOWNLOAD = 'metadata cli download apple response',
APPLE_METADATA_UPLOAD = 'metadata cli upload apple response',
}
export class Analytics {
static logEvent(name: Event, properties: Record<string, any>): void {
logEvent(name, properties);
+7 -4
View File
@@ -157,6 +157,12 @@ async function uploadProjectAsync<TPlatform extends Platform>(
try {
return await withAnalyticsAsync(
async () => {
Log.newLine();
Log.log(
`Compressing project files and uploading to EAS Build. ${learnMore(
'https://expo.fyi/eas-build-archive'
)}`
);
const projectTarball = await makeProjectTarballAsync();
projectTarballPath = projectTarball.path;
@@ -169,10 +175,7 @@ async function uploadProjectAsync<TPlatform extends Platform>(
`Uploading to EAS Build (${formatBytes(projectTarball.size * ratio)} / ${formatBytes(
projectTarball.size
)})`,
completedMessage: (duration: string) =>
`Uploaded to EAS ${chalk.dim(duration)} ${learnMore(
'https://expo.fyi/eas-build-archive'
)}`,
completedMessage: (duration: string) => `Uploaded to EAS ${chalk.dim(duration)}`,
})
);
return bucketKey;
+1 -1
View File
@@ -6,7 +6,7 @@ import semver from 'semver';
import { ora } from '../ora';
const PLUGIN_PACKAGE_NAME = 'eas-cli-local-build-plugin';
const PLUGIN_PACKAGE_VERSION = '0.0.82';
const PLUGIN_PACKAGE_VERSION = '0.0.85';
export interface LocalBuildOptions {
enable: boolean;
@@ -8,7 +8,7 @@ import {
ViewBranchUpdatesQueryVariables,
} from '../generated';
const PAGE_LIMIT = 10_000;
const PAGE_LIMIT = 300;
export const UpdateQuery = {
async viewAllAsync({ appId }: { appId: string }): Promise<ViewAllUpdatesQuery> {
@@ -0,0 +1,23 @@
import { AgeRatingDeclaration, KidsAge } from '@expo/apple-utils';
import { AttributesOf } from '../../../../utils/asc';
export const kidsSixToEightAdvisory: AttributesOf<AgeRatingDeclaration> = {
alcoholTobaccoOrDrugUseOrReferences: null,
gamblingSimulated: null,
gambling: null,
contests: null,
medicalOrTreatmentInformation: null,
profanityOrCrudeHumor: null,
sexualContentGraphicAndNudity: null,
sexualContentOrNudity: null,
horrorOrFearThemes: null,
matureOrSuggestiveThemes: null,
violenceCartoonOrFantasy: null,
violenceRealisticProlongedGraphicOrSadistic: null,
violenceRealistic: null,
unrestrictedWebAccess: false,
seventeenPlus: false,
kidsAgeBand: KidsAge.SIX_TO_EIGHT,
gamblingAndContests: false,
};
@@ -0,0 +1,23 @@
import { AppCategory, AppInfo, BundleIdPlatform } from '@expo/apple-utils';
import { AttributesOf } from '../../../../utils/asc';
export const primaryOnlyCategory: Pick<AttributesOf<AppInfo>, 'primaryCategory'> = {
primaryCategory: new AppCategory({} as any, 'ENTERTAINMENT', {
platforms: [BundleIdPlatform.IOS, BundleIdPlatform.MAC_OS],
}),
};
export const secondaryOnlyCategory: Pick<AttributesOf<AppInfo>, 'secondaryCategory'> = {
secondaryCategory: new AppCategory({} as any, 'GAMES', {
platforms: [BundleIdPlatform.IOS, BundleIdPlatform.MAC_OS],
}),
};
export const primaryAndSecondaryCategory: Pick<
AttributesOf<AppInfo>,
'primaryCategory' | 'secondaryCategory'
> = {
...primaryOnlyCategory,
...secondaryOnlyCategory,
};
@@ -0,0 +1,21 @@
import { AppInfoLocalization } from '@expo/apple-utils';
import { AttributesOf } from '../../../../utils/asc';
export const englishInfo: AttributesOf<AppInfoLocalization> = {
locale: 'en-US',
name: 'Awesome test app',
subtitle: 'This is just a test',
privacyPolicyUrl: 'https://example.com/en/privacy-policy',
privacyChoicesUrl: 'https://exmaple.com/en/privacy-choices',
privacyPolicyText: 'This is some privacy policy text',
};
export const dutchInfo: AttributesOf<AppInfoLocalization> = {
locale: 'nl-NL',
name: 'Geweldige test app',
subtitle: 'Dit is maar een test',
privacyPolicyUrl: 'https://example.com/nl/privacy-policy',
privacyChoicesUrl: 'https://example.com/nl/privacy-choices',
privacyPolicyText: 'Dit is wat privacy policy tekst',
};
@@ -0,0 +1,48 @@
import { AppStoreState, AppStoreVersion, Platform, ReleaseType } from '@expo/apple-utils';
import { AttributesOf } from '../../../../utils/asc';
export const manualRelease: AttributesOf<AppStoreVersion> = {
platform: Platform.IOS,
versionString: '1.0.0',
appStoreState: AppStoreState.WAITING_FOR_REVIEW,
storeIcon: null,
watchStoreIcon: null,
copyright: '2022 - ACME',
releaseType: ReleaseType.MANUAL,
earliestReleaseDate: null,
usesIdfa: null,
isWatchOnly: false,
downloadable: false,
createdDate: '2022-05-23T00:00:00.000Z',
};
export const automaticRelease: AttributesOf<AppStoreVersion> = {
platform: Platform.IOS,
versionString: '2.0.0',
appStoreState: AppStoreState.WAITING_FOR_REVIEW,
storeIcon: null,
watchStoreIcon: null,
copyright: '2022 - ACME',
releaseType: ReleaseType.AFTER_APPROVAL,
earliestReleaseDate: null,
usesIdfa: null,
isWatchOnly: false,
downloadable: false,
createdDate: '2022-05-23T00:00:00.000Z',
};
export const scheduledRelease: AttributesOf<AppStoreVersion> = {
platform: Platform.IOS,
versionString: '3.0.0',
appStoreState: AppStoreState.READY_FOR_SALE,
storeIcon: null,
watchStoreIcon: null,
copyright: '2022 - ACME',
releaseType: ReleaseType.SCHEDULED,
earliestReleaseDate: '2022-05-29T00:00:00.000Z',
usesIdfa: null,
isWatchOnly: false,
downloadable: false,
createdDate: '2022-05-23T00:00:00.000Z',
};
@@ -0,0 +1,23 @@
import { AppStoreVersionLocalization } from '@expo/apple-utils';
import { AttributesOf } from '../../../../utils/asc';
export const englishVersion: AttributesOf<AppStoreVersionLocalization> = {
locale: 'en-US',
description: 'This is a description of this version',
keywords: 'some, description',
marketingUrl: 'https://example.com/en/marketing',
promotionalText: 'This is some promotional text',
supportUrl: 'https://example.com/en/support',
whatsNew: 'Bugfixes and improvements',
};
export const dutchVersion: AttributesOf<AppStoreVersionLocalization> = {
locale: 'nl-NL',
description: 'Dit is een beschrijving van deze versie',
keywords: 'een, beschrijving',
marketingUrl: 'https://example.com/nl/marketing',
promotionalText: 'Dit is wat promotie tekst',
supportUrl: 'https://example.com/nl/support',
whatsNew: 'Beestreparaties en verbeteringen',
};
@@ -0,0 +1,151 @@
import { AppleConfigWriter } from '../writer';
import { kidsSixToEightAdvisory } from './fixtures/ageRatingDeclaration';
import { primaryAndSecondaryCategory, secondaryOnlyCategory } from './fixtures/appInfo';
import { dutchInfo, englishInfo } from './fixtures/appInfoLocalization';
import { automaticRelease, manualRelease, scheduledRelease } from './fixtures/appStoreVersion';
import { dutchVersion, englishVersion } from './fixtures/appStoreVersionLocalization';
describe('toSchema', () => {
it('returns object with apple schema', () => {
const writer = new AppleConfigWriter();
expect(writer.toSchema()).toMatchObject({
configVersion: 0,
apple: expect.any(Object),
});
});
});
describe('setAgeRating', () => {
it('modifies the advisory', () => {
const writer = new AppleConfigWriter();
writer.setAgeRating(kidsSixToEightAdvisory);
expect(writer.schema.advisory).toMatchObject(kidsSixToEightAdvisory);
});
});
describe('setInfoLocale', () => {
it('creates and modifies the locale', () => {
const writer = new AppleConfigWriter();
writer.setInfoLocale(englishInfo);
expect(writer.schema.info?.[englishInfo.locale]).toMatchObject({
title: englishInfo.name,
subtitle: englishInfo.subtitle,
privacyPolicyUrl: englishInfo.privacyPolicyUrl,
privacyPolicyText: englishInfo.privacyPolicyText,
privacyChoicesUrl: englishInfo.privacyChoicesUrl,
});
});
it('modifies existing locales', () => {
const writer = new AppleConfigWriter();
writer.setInfoLocale(englishInfo);
writer.setInfoLocale(dutchInfo);
writer.setInfoLocale({
...englishInfo,
name: 'This is now different',
privacyPolicyText: null,
});
expect(writer.schema.info?.[dutchInfo.locale]).toHaveProperty('title', dutchInfo.name);
expect(writer.schema.info?.[englishInfo.locale]).toMatchObject({
title: 'This is now different',
privacyPolicyText: undefined,
});
});
});
describe('setCategories', () => {
it('modifies the categories', () => {
const writer = new AppleConfigWriter();
writer.setCategories(primaryAndSecondaryCategory as any);
expect(writer.schema.categories).toHaveLength(2);
expect((writer.schema.categories as any)[0]).toBe(
primaryAndSecondaryCategory.primaryCategory?.id
);
expect((writer.schema.categories as any)[1]).toBe(
primaryAndSecondaryCategory.secondaryCategory?.id
);
});
it('skips secondary category without primary category', () => {
const writer = new AppleConfigWriter();
writer.setCategories(secondaryOnlyCategory as any);
expect(writer.schema.categories).toHaveLength(0);
});
});
describe('setVersion', () => {
it('modifies the copyright', () => {
const writer = new AppleConfigWriter();
writer.setVersion(manualRelease);
expect(writer.schema.copyright).toBe(manualRelease.copyright);
});
});
describe('setVersionRelease', () => {
it('modifies scheduled release', () => {
const writer = new AppleConfigWriter();
writer.setVersionRelease(scheduledRelease);
expect(writer.schema.release).toMatchObject({
autoReleaseDate: scheduledRelease.earliestReleaseDate,
});
});
it('modifies automatic release', () => {
const writer = new AppleConfigWriter();
writer.setVersionRelease(automaticRelease);
expect(writer.schema.release).toMatchObject({
automaticRelease: true,
});
});
it('modifies manual release', () => {
const writer = new AppleConfigWriter();
writer.setVersionRelease(manualRelease);
expect(writer.schema.release).toMatchObject({
automaticRelease: false,
});
});
it('overwrites all release fields', () => {
const writer = new AppleConfigWriter();
writer.setVersionRelease(scheduledRelease);
writer.setVersionRelease(manualRelease);
expect(writer.schema.release).not.toHaveProperty('autoReleaseDate');
});
});
describe('setVersionLocale', () => {
it('creates and modifies the locale', () => {
const writer = new AppleConfigWriter();
writer.setVersionLocale(englishVersion);
expect(writer.schema.info?.[englishVersion.locale]).toMatchObject({
description: englishVersion.description,
keywords: englishVersion.keywords?.split(', '),
releaseNotes: englishVersion.whatsNew,
marketingUrl: englishVersion.marketingUrl,
promoText: englishVersion.promotionalText,
supportUrl: englishVersion.supportUrl,
});
});
it('modifies existing locales', () => {
const writer = new AppleConfigWriter();
writer.setVersionLocale(englishVersion);
writer.setVersionLocale(dutchVersion);
writer.setVersionLocale({
...englishVersion,
description: 'This is now different',
whatsNew: null,
});
expect(writer.schema.info?.[dutchVersion.locale]).toHaveProperty(
'description',
dutchVersion.description
);
expect(writer.schema.info?.[englishVersion.locale]).toMatchObject({
description: 'This is now different',
releaseNotes: undefined,
});
});
});
@@ -0,0 +1,122 @@
import {
AgeRatingDeclaration,
AppInfoLocalization,
AppStoreVersion,
AppStoreVersionLocalization,
CategoryIds,
ReleaseType,
} from '@expo/apple-utils';
import { unique } from '../../utils/array';
import { AttributesOf } from '../../utils/asc';
import { removeDatePrecision } from '../../utils/date';
import { AppleMetadata } from '../types';
type PartialExcept<T, K extends keyof T> = Pick<T, K> & Partial<Omit<T, K>>;
// TODO: find out if we can move this to default JSON schema normalization
export const DEFAULT_WHATSNEW = 'Bug fixes and improved stability';
/**
* Deserializes the metadata config schema into attributes for different models.
* This uses version 0 of the config schema.
*/
export class AppleConfigReader {
constructor(public readonly schema: AppleMetadata) {}
getAgeRating(): Partial<AttributesOf<AgeRatingDeclaration>> | null {
return this.schema.advisory || null;
}
getLocales(): string[] {
// TODO: filter "default" locales, add option to add non-localized info to the config
return unique(Object.keys(this.schema.info || {}));
}
getInfoLocale(
locale: string
): PartialExcept<AttributesOf<AppInfoLocalization>, 'locale' | 'name'> | null {
const info = this.schema.info?.[locale];
if (!info) {
return null;
}
return {
locale,
name: info.title || 'no name provided',
subtitle: info.subtitle,
privacyChoicesUrl: info.privacyChoicesUrl,
privacyPolicyText: info.privacyPolicyText,
privacyPolicyUrl: info.privacyPolicyUrl,
};
}
getCategories(): CategoryIds | null {
if (Array.isArray(this.schema.categories) && this.schema.categories.length > 0) {
return {
primaryCategory: this.schema.categories[0],
secondaryCategory: this.schema.categories[1],
};
}
return null;
}
/** Get the `AppStoreVersion` object. */
getVersion(): Partial<
Omit<AttributesOf<AppStoreVersion>, 'releaseType' | 'earliestReleaseDate'>
> | null {
return this.schema.copyright ? { copyright: this.schema.copyright } : null;
}
getVersionRelease(): Partial<
Pick<AttributesOf<AppStoreVersion>, 'releaseType' | 'earliestReleaseDate'>
> | null {
const { release } = this.schema;
if (release?.autoReleaseDate) {
return {
releaseType: ReleaseType.SCHEDULED,
// Convert time format to 2020-06-17T12:00:00-07:00
earliestReleaseDate: removeDatePrecision(release.autoReleaseDate)?.toISOString() ?? null,
};
}
if (release?.automaticRelease === true) {
return {
releaseType: ReleaseType.AFTER_APPROVAL,
earliestReleaseDate: null,
};
}
if (release?.automaticRelease === false) {
return {
releaseType: ReleaseType.MANUAL,
earliestReleaseDate: null,
};
}
return null;
}
getVersionLocale(
locale: string,
context: { versionIsFirst: boolean }
): Partial<AttributesOf<AppStoreVersionLocalization>> | null {
const info = this.schema.info?.[locale];
if (!info) {
return null;
}
return {
locale,
description: info.description,
keywords: info.keywords?.join(', '),
// TODO: maybe move this to task logic, it's more an exception than data handling
whatsNew: context.versionIsFirst ? undefined : info.releaseNotes || DEFAULT_WHATSNEW,
marketingUrl: info.marketingUrl,
promotionalText: info.promoText,
supportUrl: info.supportUrl,
};
}
}
@@ -0,0 +1,107 @@
import {
AgeRatingDeclaration,
AppInfo,
AppInfoLocalization,
AppStoreVersion,
AppStoreVersionLocalization,
ReleaseType,
} from '@expo/apple-utils';
import { AttributesOf } from '../../utils/asc';
import { AppleMetadata } from '../types';
/**
* Serializes the Apple ASC entities into the metadata configuration schema.
* This uses version 0 of the config schema.
*/
export class AppleConfigWriter {
constructor(public readonly schema: Partial<AppleMetadata> = {}) {}
/** Get the schema result to write it to the config file */
toSchema(): { configVersion: number; apple: Partial<AppleMetadata> } {
return {
configVersion: 0,
apple: this.schema,
};
}
setAgeRating(attributes: AttributesOf<AgeRatingDeclaration>): void {
this.schema.advisory = attributes;
}
setInfoLocale(attributes: AttributesOf<AppInfoLocalization>): void {
this.schema.info = this.schema.info ?? {};
const existing = this.schema.info[attributes.locale] ?? {};
this.schema.info[attributes.locale] = {
...existing,
title: attributes.name ?? 'no name provided',
subtitle: optional(attributes.subtitle),
privacyPolicyUrl: optional(attributes.privacyPolicyUrl),
privacyPolicyText: optional(attributes.privacyPolicyText),
privacyChoicesUrl: optional(attributes.privacyChoicesUrl),
};
}
setCategories({ primaryCategory, secondaryCategory }: AttributesOf<AppInfo>): void {
this.schema.categories = [];
// TODO: see why these types are conflicting
if (primaryCategory) {
this.schema.categories.push(primaryCategory.id as any);
if (secondaryCategory) {
this.schema.categories.push(secondaryCategory.id as any);
}
}
}
setVersion(
attributes: Omit<AttributesOf<AppStoreVersion>, 'releaseType' | 'earliestReleaseDate'>
): void {
this.schema.copyright = optional(attributes.copyright);
}
setVersionRelease(
attributes: Pick<AttributesOf<AppStoreVersion>, 'releaseType' | 'earliestReleaseDate'>
): void {
if (attributes.releaseType === ReleaseType.SCHEDULED) {
this.schema.release = {
autoReleaseDate: optional(attributes.earliestReleaseDate),
};
}
if (attributes.releaseType === ReleaseType.AFTER_APPROVAL) {
this.schema.release = {
automaticRelease: true,
};
}
if (attributes.releaseType === ReleaseType.MANUAL) {
this.schema.release = {
automaticRelease: false,
};
}
}
setVersionLocale(attributes: AttributesOf<AppStoreVersionLocalization>): void {
this.schema.info = this.schema.info ?? {};
const existing = this.schema.info[attributes.locale] ?? {};
this.schema.info[attributes.locale] = {
...existing,
description: optional(attributes.description),
keywords: optional(attributes.keywords)
?.split(',')
.map(keyword => keyword.trim()),
releaseNotes: optional(attributes.whatsNew),
marketingUrl: optional(attributes.marketingUrl),
promoText: optional(attributes.promotionalText),
supportUrl: optional(attributes.supportUrl),
};
}
}
/** Helper function to convert `T | null` to `T | undefined`, required for the entity properties */
function optional<T>(value: T | null): T | undefined {
return value ?? undefined;
}
@@ -0,0 +1,18 @@
import type { App } from '@expo/apple-utils';
import type { AgeRatingData } from './tasks/age-rating';
import type { AppInfoData } from './tasks/app-info';
import type { AppVersionData } from './tasks/app-version';
/**
* The fully prepared apple data, used within the `downloadAsync` or `uploadAsync` tasks.
* It contains references to each individual models, to either upload or download App Store data.
*/
export type AppleData = { app: App } & AppInfoData & AppVersionData & AgeRatingData;
/**
* The unprepared partial apple data, used within the `prepareAsync` tasks.
* It contains a reference to the app, each task should populate the necessary data.
* If an entity fails to prepare the data, individual tasks should raise errors about the missing data.
*/
export type PartialAppleData = { app: App } & Partial<Omit<AppleData, 'app'>>;
@@ -0,0 +1,31 @@
import { AppleConfigReader } from './config/reader';
import { AppleConfigWriter } from './config/writer';
import { AppleData, PartialAppleData } from './data';
export abstract class AppleTask {
/** Get a description from the task to use as section headings in the log */
abstract name(): string;
/** Prepare the data from the App Store to start syncing with the store configuration */
abstract prepareAsync(options: TaskPrepareOptions): Promise<void>;
/** Download all information from the App Store to generate the store configuration */
abstract downloadAsync(options: TaskDownloadOptions): Promise<void>;
/** Upload all information from the store configuration to the App Store */
abstract uploadAsync(options: TaskUploadOptions): Promise<void>;
}
export type TaskPrepareOptions = {
context: PartialAppleData;
};
export type TaskDownloadOptions = {
config: AppleConfigWriter;
context: AppleData;
};
export type TaskUploadOptions = {
config: AppleConfigReader;
context: AppleData;
};
@@ -0,0 +1,8 @@
import { getRequestClient } from '@expo/apple-utils';
export { default } from 'nock';
// Axios from apple-utils needs to be patched when we use Nock.
// Instead of the default adapter, we need to use `axios/lib/adapters/http`
// see: https://github.com/nock/nock#axios
getRequestClient().defaults.adapter = require('axios/lib/adapters/http');
@@ -0,0 +1,111 @@
import { AgeRatingDeclaration, AppStoreVersion, Rating } from '@expo/apple-utils';
import nock from 'nock';
import { AppleConfigReader } from '../../config/reader';
import { AppleConfigWriter } from '../../config/writer';
import { AppleData } from '../../data';
import { AgeRatingTask } from '../age-rating';
import { requestContext } from './fixtures/requestContext';
jest.mock('../../../../ora');
jest.mock('../../config/writer');
describe(AgeRatingTask, () => {
describe('prepareAsync', () => {
it('aborts when version is not loaded', async () => {
const promise = new AgeRatingTask().prepareAsync({ context: {} as any });
await expect(promise).rejects.toThrow('not prepared');
});
it('loads age rating from app version', async () => {
const scope = nock('https://api.appstoreconnect.apple.com')
.get(`/v1/${AppStoreVersion.type}/stub-id/ageRatingDeclaration`)
.reply(200, require('./fixtures/appStoreVersions/get-ageRatingDeclaration-200.json'));
const context: any = {
version: new AppStoreVersion(requestContext, 'stub-id', {} as any),
};
await new AgeRatingTask().prepareAsync({ context });
expect(context.ageRating).toBeInstanceOf(AgeRatingDeclaration);
expect(scope.isDone()).toBeTruthy();
});
});
describe('downloadAsync', () => {
it('skips age rating when not prepared', async () => {
const writer = jest.mocked(new AppleConfigWriter());
await new AgeRatingTask().downloadAsync({
config: writer,
context: { ageRating: undefined } as any,
});
expect(writer.setAgeRating).not.toBeCalled();
});
it('sets age rating when prepared', async () => {
const writer = jest.mocked(new AppleConfigWriter());
const ageRating = new AgeRatingDeclaration(requestContext, 'stub-id', {} as any);
await new AgeRatingTask().downloadAsync({
config: writer,
context: { ageRating } as any,
});
expect(writer.setAgeRating).toBeCalledWith(ageRating.attributes);
});
});
describe('uploadAsync', () => {
it('aborts when age rating is not loaded', async () => {
const promise = new AgeRatingTask().uploadAsync({
config: new AppleConfigReader({}),
context: { ageRating: undefined } as any,
});
await expect(promise).rejects.toThrow('rating not initialized');
});
it('skips updating age rating when not configured', async () => {
const scope = nock('https://api.appstoreconnect.apple.com')
.patch(`/v1/${AgeRatingDeclaration.type}/stub-id`)
.reply(200, require('./fixtures/ageRatingDeclarations/patch-200.json'));
await new AgeRatingTask().uploadAsync({
config: new AppleConfigReader({ advisory: undefined }),
context: {
ageRating: new AgeRatingDeclaration(requestContext, 'stub-id', {} as any),
} as AppleData,
});
expect(scope.isDone()).toBeFalsy();
nock.cleanAll();
});
it('updates age rating from config when configured', async () => {
const scope = nock('https://api.appstoreconnect.apple.com')
.patch(`/v1/${AgeRatingDeclaration.type}/stub-id`)
.reply(200, require('./fixtures/ageRatingDeclarations/patch-200.json'));
const context = {
ageRating: new AgeRatingDeclaration(requestContext, 'stub-id', {} as any),
};
await new AgeRatingTask().uploadAsync({
config: new AppleConfigReader({
advisory: {
// See fixture value for horrorOrFearThemes
horrorOrFearThemes: Rating.INFREQUENT_OR_MILD,
},
}),
context: context as AppleData,
});
expect(context.ageRating.id).not.toMatch('stub-id');
expect(scope.isDone()).toBeTruthy();
});
});
});
@@ -0,0 +1,173 @@
import { App, AppCategoryId, AppInfo, AppInfoLocalization } from '@expo/apple-utils';
import nock from 'nock';
import { AppleConfigReader } from '../../config/reader';
import { AppleConfigWriter } from '../../config/writer';
import { AppleData, PartialAppleData } from '../../data';
import { AppInfoTask } from '../app-info';
import { requestContext } from './fixtures/requestContext';
jest.mock('../../../../ora');
jest.mock('../../config/writer');
describe(AppInfoTask, () => {
describe('prepareAsync', () => {
it('loads editable app info and locales from app instance', async () => {
const scopeInfo = nock('https://api.appstoreconnect.apple.com')
.get(uri => uri.startsWith(`/v1/${App.type}/stub-id/${AppInfo.type}`)) // allow any query params
.reply(200, require('./fixtures/apps/get-appInfos-200.json'));
const scopeLocales = nock('https://api.appstoreconnect.apple.com')
.get(/\/v1\/appInfos\/.*\/appInfoLocalizations/) // allow any id from fixture
.reply(200, require('./fixtures/appInfos/get-appInfoLocalizations-200.json'));
const context: PartialAppleData = {
app: new App(requestContext, 'stub-id', {} as any),
};
await new AppInfoTask().prepareAsync({ context });
expect(context.info).toBeInstanceOf(AppInfo);
expect(context.infoLocales).toBeInstanceOf(Array);
expect(scopeInfo.isDone()).toBeTruthy();
expect(scopeLocales.isDone()).toBeTruthy();
});
});
describe('downloadAsync', () => {
it('aborts when app info is not loaded', async () => {
const writer = jest.mocked(new AppleConfigWriter());
const promise = new AppInfoTask().downloadAsync({
config: writer,
context: { info: undefined, infoLocales: [] } as any,
});
await expect(promise).rejects.toThrow('info not initialized');
});
it('sets categories when info is loaded', async () => {
const writer = jest.mocked(new AppleConfigWriter());
const info = new AppInfo(requestContext, 'stub-id', {} as any);
await new AppInfoTask().downloadAsync({
config: writer,
context: { info, infoLocales: [] } as any,
});
expect(writer.setCategories).toBeCalledWith(info.attributes);
});
it('skips when no locales are loaded', async () => {
const writer = jest.mocked(new AppleConfigWriter());
await new AppInfoTask().downloadAsync({
config: writer,
context: {
info: new AppInfo(requestContext, 'stub-id', {} as any),
infoLocales: [],
} as any,
});
expect(writer.setInfoLocale).not.toBeCalled();
});
it('sets locales when loaded', async () => {
const writer = jest.mocked(new AppleConfigWriter());
const infoLocales = [
new AppInfoLocalization(requestContext, 'stub-id-1', {} as any),
new AppInfoLocalization(requestContext, 'stub-id-2', {} as any),
];
await new AppInfoTask().downloadAsync({
config: writer,
context: {
info: new AppInfo(requestContext, 'stub-id', {} as any),
infoLocales,
} as any,
});
expect(writer.setInfoLocale).toBeCalledWith(infoLocales[0].attributes);
expect(writer.setInfoLocale).toBeCalledWith(infoLocales[1].attributes);
});
});
describe('uploadAsync', () => {
it('aborts when app info is not loaded', async () => {
const promise = new AppInfoTask().uploadAsync({
config: new AppleConfigReader({}),
context: { info: undefined } as any,
});
await expect(promise).rejects.toThrow('info not initialized');
});
it('skips updating categories when not configured', async () => {
const scope = nock('https://api.appstoreconnect.apple.com')
.patch(`/v1/${AppInfo.type}/stub-id`)
.reply(200, require('./fixtures/appInfos/patch-200.json'));
await new AppInfoTask().uploadAsync({
config: new AppleConfigReader({ categories: undefined }),
context: {
info: new AppInfo(requestContext, 'stub-id', {} as any),
} as AppleData,
});
expect(scope.isDone()).toBeFalsy();
nock.cleanAll();
});
it('skips updating localized info when not configured', async () => {
const scope = nock('https://api.appstoreconnect.apple.com')
.patch(`/v1/${AppInfoLocalization.type}/stub-id`)
.reply(200, require('./fixtures/appInfos/patch-200.json'));
await new AppInfoTask().uploadAsync({
config: new AppleConfigReader({ info: undefined }),
context: {
info: new AppInfo(requestContext, 'stub-id', {} as any),
} as AppleData,
});
expect(scope.isDone()).toBeFalsy();
nock.cleanAll();
});
it('updates categories and localized info', async () => {
const updateCategoryScope = nock('https://api.appstoreconnect.apple.com')
.patch(`/v1/${AppInfo.type}/stub-id`)
.reply(200, require('./fixtures/appInfos/patch-200.json'));
const updateENInfoScope = nock('https://api.appstoreconnect.apple.com')
.patch(`/v1/${AppInfoLocalization.type}/APP_INFO_LOCALE_1`) // see fixture ID
.reply(200, require('./fixtures/appInfoLocalizations/patch-200.json'));
const updateNLInfoScope = nock('https://api.appstoreconnect.apple.com')
.patch(`/v1/${AppInfoLocalization.type}/APP_INFO_LOCALE_2`) // see fixture ID
.reply(200, require('./fixtures/appInfoLocalizations/patch-200.json'));
const fetchLocalizedInfoScope = nock('https://api.appstoreconnect.apple.com')
.get(`/v1/${AppInfo.type}/APP_INFO_1/${AppInfoLocalization.type}`) // see fixture ID
.twice()
.reply(200, require('./fixtures/appInfos/get-appInfoLocalizations-200.json'));
await new AppInfoTask().uploadAsync({
config: new AppleConfigReader({
categories: [AppCategoryId.ENTERTAINMENT],
info: {
'en-US': { title: 'Hello' },
'nl-NL': { title: 'Hallo' },
},
}),
context: {
info: new AppInfo(requestContext, 'stub-id', {} as any),
} as AppleData,
});
expect(updateCategoryScope.isDone()).toBeTruthy();
expect(fetchLocalizedInfoScope.isDone()).toBeTruthy();
expect(updateENInfoScope.isDone()).toBeTruthy();
expect(updateNLInfoScope.isDone()).toBeTruthy();
});
});
});
@@ -0,0 +1,246 @@
import {
App,
AppStoreState,
AppStoreVersion,
AppStoreVersionLocalization,
} from '@expo/apple-utils';
import nock from 'nock';
import { AppleConfigReader } from '../../config/reader';
import { AppleConfigWriter } from '../../config/writer';
import { AppleData, PartialAppleData } from '../../data';
import { AppVersionTask } from '../app-version';
import { requestContext } from './fixtures/requestContext';
jest.mock('../../../../ora');
jest.mock('../../config/writer');
describe(AppVersionTask, () => {
describe('prepareAsync', () => {
it('loads live version', async () => {
const scope = nock('https://api.appstoreconnect.apple.com')
// Respond to app.getLiveAppStoreVersionAsync
.get(`/v1/${App.type}/stub-id/${AppStoreVersion.type}`)
.query((params: any) => params['filter[appStoreState]'] === AppStoreState.READY_FOR_SALE)
.reply(200, require('./fixtures/apps/get-appStoreVersions-200.json'))
// Respond to app.getAppStoreVersionsAsync
.get(`/v1/${App.type}/stub-id/${AppStoreVersion.type}`)
.query((params: any) => params['filter[appStoreState]'] !== AppStoreState.READY_FOR_SALE)
.reply(200, require('./fixtures/apps/get-appStoreVersions-count-200.json'))
// Respond to version.getLocalizationsAsync
.get(`/v1/${AppStoreVersion.type}/APP_STORE_VERSION_1/${AppStoreVersionLocalization.type}`)
.reply(
200,
require('./fixtures/appStoreVersions/get-appStoreVersionLocalizations-200.json')
);
const context: PartialAppleData = {
app: new App(requestContext, 'stub-id', {} as any),
};
await new AppVersionTask({ editLive: true }).prepareAsync({ context });
expect(context.version).toBeInstanceOf(AppStoreVersion);
expect(context.versionIsLive).toBeTruthy();
expect(context.versionIsFirst).toBeTruthy();
expect(scope.isDone()).toBeTruthy();
});
it('falls back to editable version if live version is not found', async () => {
const scope = nock('https://api.appstoreconnect.apple.com')
// Respond to app.getLiveAppStoreVersionAsync, failing with 404
.get(`/v1/${App.type}/stub-id/${AppStoreVersion.type}`)
.query((params: any) => params['filter[appStoreState]'] === AppStoreState.READY_FOR_SALE)
.reply(404, {})
// Respond to app.getEditAppStoreVersionAsync
.get(`/v1/${App.type}/stub-id/${AppStoreVersion.type}`)
.query((params: any) => params['filter[appStoreState]'] !== AppStoreState.READY_FOR_SALE)
.reply(200, require('./fixtures/apps/get-appStoreVersions-count-200.json'))
// Respond to app.getAppStoreVersionsAsync
.get(`/v1/${App.type}/stub-id/${AppStoreVersion.type}`)
.query(true)
.reply(200, require('./fixtures/apps/get-appStoreVersions-count-200.json'))
// Respond to version.getLocalizationsAsync
.get(`/v1/${AppStoreVersion.type}/APP_STORE_VERSION_1/${AppStoreVersionLocalization.type}`)
.reply(
200,
require('./fixtures/appStoreVersions/get-appStoreVersionLocalizations-200.json')
);
const context: PartialAppleData = {
app: new App(requestContext, 'stub-id', {} as any),
};
await new AppVersionTask({ editLive: true }).prepareAsync({ context });
expect(context.version).toBeInstanceOf(AppStoreVersion);
expect(context.versionIsLive).toBeFalsy();
expect(context.versionIsFirst).toBeTruthy();
expect(scope.isDone()).toBeTruthy();
});
it('loads last editable version', async () => {
const scope = nock('https://api.appstoreconnect.apple.com')
// Respond to app.getEditAppStoreVersionAsync
.get(`/v1/${App.type}/stub-id/${AppStoreVersion.type}`)
.query((params: any) => params['filter[appStoreState]'] !== AppStoreState.READY_FOR_SALE)
.reply(200, require('./fixtures/apps/get-appStoreVersions-200.json'))
// Respond to app.getAppStoreVersionsAsync
.get(`/v1/${App.type}/stub-id/${AppStoreVersion.type}`)
.query((params: any) => params['filter[appStoreState]'] !== AppStoreState.READY_FOR_SALE)
.reply(200, require('./fixtures/apps/get-appStoreVersions-count-200.json'))
// Respond to version.getLocalizationsAsync
.get(`/v1/${AppStoreVersion.type}/APP_STORE_VERSION_1/${AppStoreVersionLocalization.type}`)
.reply(
200,
require('./fixtures/appStoreVersions/get-appStoreVersionLocalizations-200.json')
);
const context: PartialAppleData = {
app: new App(requestContext, 'stub-id', {} as any),
};
await new AppVersionTask().prepareAsync({ context });
expect(context.version).toBeInstanceOf(AppStoreVersion);
expect(context.versionIsLive).toBeFalsy();
expect(context.versionIsFirst).toBeTruthy();
expect(scope.isDone()).toBeTruthy();
});
it('sets first version property for multiple versions', async () => {
const scope = nock('https://api.appstoreconnect.apple.com')
// Respond to app.getEditAppStoreVersionAsync
.get(`/v1/${App.type}/stub-id/${AppStoreVersion.type}`)
.query((params: any) => params['filter[appStoreState]'] !== AppStoreState.READY_FOR_SALE)
.reply(200, require('./fixtures/apps/get-appStoreVersions-200.json'))
// Respond to app.getAppStoreVersionsAsync
.get(`/v1/${App.type}/stub-id/${AppStoreVersion.type}`)
.query((params: any) => params['filter[appStoreState]'] !== AppStoreState.READY_FOR_SALE)
.reply(200, require('./fixtures/apps/get-appStoreVersions-count-multiple-200.json'))
// Respond to version.getLocalizationsAsync
.get(`/v1/${AppStoreVersion.type}/APP_STORE_VERSION_1/${AppStoreVersionLocalization.type}`)
.reply(
200,
require('./fixtures/appStoreVersions/get-appStoreVersionLocalizations-200.json')
);
const context: PartialAppleData = {
app: new App(requestContext, 'stub-id', {} as any),
};
await new AppVersionTask().prepareAsync({ context });
expect(context.versionIsFirst).toBeFalsy();
expect(scope.isDone()).toBeTruthy();
});
});
describe('downloadAsync', () => {
it('aborts when version is not loaded', async () => {
const promise = new AppVersionTask().downloadAsync({
config: new AppleConfigWriter(),
context: { version: undefined } as any,
});
await expect(promise).rejects.toThrow('not initialized');
});
it('sets version when loaded', async () => {
const writer = new AppleConfigWriter();
const version = new AppStoreVersion(requestContext, 'stub-id', {} as any);
await new AppVersionTask().downloadAsync({
config: writer,
context: { version, versionLocales: [] } as any,
});
expect(writer.setVersion).toBeCalledWith(version.attributes);
});
it('sets version release when loaded', async () => {
const writer = new AppleConfigWriter();
const version = new AppStoreVersion(requestContext, 'stub-id', {} as any);
await new AppVersionTask().downloadAsync({
config: writer,
context: { version, versionLocales: [] } as any,
});
expect(writer.setVersionRelease).toBeCalledWith(version.attributes);
});
it('skips when no locales are loaded', async () => {
const writer = jest.mocked(new AppleConfigWriter());
await new AppVersionTask().downloadAsync({
config: writer,
context: {
version: new AppStoreVersion(requestContext, 'stub-id', {} as any),
versionLocales: [],
} as any,
});
expect(writer.setInfoLocale).not.toBeCalled();
});
it('sets locales when loaded', async () => {
const writer = jest.mocked(new AppleConfigWriter());
const versionLocales = [
new AppStoreVersionLocalization(requestContext, 'stub-id-1', {} as any),
new AppStoreVersionLocalization(requestContext, 'stub-id-2', {} as any),
];
await new AppVersionTask().downloadAsync({
config: writer,
context: {
version: new AppStoreVersion(requestContext, 'stub-id', {} as any),
versionLocales,
} as any,
});
expect(writer.setVersionLocale).toBeCalledWith(versionLocales[0].attributes);
expect(writer.setVersionLocale).toBeCalledWith(versionLocales[1].attributes);
});
});
describe('uploadAsync', () => {
it('aborts when version is not loaded', async () => {
const promise = new AppVersionTask().uploadAsync({
context: {} as any,
config: new AppleConfigReader({}),
});
await expect(promise).rejects.toThrow('not initialized');
});
it('updates version and release from config', async () => {
const config = new AppleConfigReader({
copyright: '2022 ACME',
release: { automaticRelease: true },
});
const attributes = { ...config.getVersion(), ...config.getVersionRelease() };
const scope = nock('https://api.appstoreconnect.apple.com')
// Respond to version.updateAsync
.patch(`/v1/${AppStoreVersion.type}/APP_STORE_VERSION_1`)
.reply(200, {
data: {
id: 'APP_STORE_VERSION_1',
type: AppStoreVersion.type,
attributes,
},
});
const context: PartialAppleData = {
app: new App(requestContext, 'stub-id', {} as any),
version: new AppStoreVersion(requestContext, 'APP_STORE_VERSION_1', {} as any),
};
await new AppVersionTask().uploadAsync({ context: context as AppleData, config });
expect(context.version?.attributes).toMatchObject(attributes);
expect(scope.isDone()).toBeTruthy();
});
});
});
@@ -0,0 +1,31 @@
{
"data": {
"type": "ageRatingDeclarations",
"id": "AGE_RATING_1",
"attributes": {
"alcoholTobaccoOrDrugUseOrReferences": "NONE",
"contests": "NONE",
"gamblingAndContests": false,
"gambling": false,
"gamblingSimulated": "NONE",
"kidsAgeBand": null,
"medicalOrTreatmentInformation": "NONE",
"profanityOrCrudeHumor": "NONE",
"sexualContentGraphicAndNudity": "NONE",
"sexualContentOrNudity": "NONE",
"seventeenPlus": false,
"horrorOrFearThemes": "INFREQUENT_OR_MILD",
"matureOrSuggestiveThemes": "NONE",
"unrestrictedWebAccess": false,
"violenceCartoonOrFantasy": "NONE",
"violenceRealisticProlongedGraphicOrSadistic": "NONE",
"violenceRealistic": "NONE"
},
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/ageRatingDeclarations/AGE_RATING_1"
}
},
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/ageRatingDeclarations/AGE_RATING_1"
}
}
@@ -0,0 +1,20 @@
{
"data": {
"type": "appInfoLocalizations",
"id": "APP_INFO_LOCALE_1",
"attributes": {
"locale": "en-US",
"name": "Rexpo Square App",
"subtitle": "144 fps red squares",
"privacyPolicyUrl": "https://github.com/bycedric/red-square-app",
"privacyChoicesUrl": null,
"privacyPolicyText": null
},
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appInfoLocalizations/APP_INFO_LOCALE_1"
}
},
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appInfoLocalizations/APP_INFO_LOCALE_1"
}
}
@@ -0,0 +1,43 @@
{
"data": [
{
"type": "appInfoLocalizations",
"id": "APP_INFO_LOCALE_1",
"attributes": {
"locale": "en-US",
"name": "Rexpo Square App",
"subtitle": "144 fps red squares",
"privacyPolicyUrl": "https://github.com/bycedric/red-square-app",
"privacyChoicesUrl": null,
"privacyPolicyText": null
},
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appInfoLocalizations/APP_INFO_LOCALE_1"
}
},
{
"type": "appInfoLocalizations",
"id": "APP_INFO_LOCALE_2",
"attributes": {
"locale": "nl-NL",
"name": "Rexpo Vierkant App",
"subtitle": "144 fps red vierkant",
"privacyPolicyUrl": "https://github.com/bycedric/red-square-app",
"privacyChoicesUrl": null,
"privacyPolicyText": null
},
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appInfoLocalizations/APP_INFO_LOCALE_2"
}
}
],
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appInfos/a9c2ad6a-182f-4021-9456-6b609ebc5eab/appInfoLocalizations"
},
"meta": {
"paging": {
"total": 2,
"limit": 50
}
}
}
@@ -0,0 +1,68 @@
{
"data": {
"type": "appInfos",
"id": "APP_INFO_1",
"attributes": {
"appStoreState": "PREPARE_FOR_SUBMISSION",
"appStoreAgeRating": "NINE_PLUS",
"brazilAgeRating": "TEN",
"kidsAgeBand": null
},
"relationships": {
"ageRatingDeclaration": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appInfos/APP_INFO_1/relationships/ageRatingDeclaration",
"related": "https://appstoreconnect.apple.com/iris/v1/appInfos/APP_INFO_1/ageRatingDeclaration"
}
},
"appInfoLocalizations": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appInfos/APP_INFO_1/relationships/appInfoLocalizations",
"related": "https://appstoreconnect.apple.com/iris/v1/appInfos/APP_INFO_1/appInfoLocalizations"
}
},
"primaryCategory": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appInfos/APP_INFO_1/relationships/primaryCategory",
"related": "https://appstoreconnect.apple.com/iris/v1/appInfos/APP_INFO_1/primaryCategory"
}
},
"primarySubcategoryOne": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appInfos/APP_INFO_1/relationships/primarySubcategoryOne",
"related": "https://appstoreconnect.apple.com/iris/v1/appInfos/APP_INFO_1/primarySubcategoryOne"
}
},
"primarySubcategoryTwo": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appInfos/APP_INFO_1/relationships/primarySubcategoryTwo",
"related": "https://appstoreconnect.apple.com/iris/v1/appInfos/APP_INFO_1/primarySubcategoryTwo"
}
},
"secondaryCategory": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appInfos/APP_INFO_1/relationships/secondaryCategory",
"related": "https://appstoreconnect.apple.com/iris/v1/appInfos/APP_INFO_1/secondaryCategory"
}
},
"secondarySubcategoryOne": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appInfos/APP_INFO_1/relationships/secondarySubcategoryOne",
"related": "https://appstoreconnect.apple.com/iris/v1/appInfos/APP_INFO_1/secondarySubcategoryOne"
}
},
"secondarySubcategoryTwo": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appInfos/APP_INFO_1/relationships/secondarySubcategoryTwo",
"related": "https://appstoreconnect.apple.com/iris/v1/appInfos/APP_INFO_1/secondarySubcategoryTwo"
}
}
},
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appInfos/APP_INFO_1"
}
},
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appInfos/APP_INFO_1"
}
}
@@ -0,0 +1,31 @@
{
"data": {
"type": "ageRatingDeclarations",
"id": "a9c2ad6a-182f-4021-9456-6b609ebc5eab",
"attributes": {
"alcoholTobaccoOrDrugUseOrReferences": "NONE",
"contests": "NONE",
"gamblingAndContests": false,
"gambling": false,
"gamblingSimulated": "NONE",
"kidsAgeBand": null,
"medicalOrTreatmentInformation": "NONE",
"profanityOrCrudeHumor": "NONE",
"sexualContentGraphicAndNudity": "NONE",
"sexualContentOrNudity": "NONE",
"seventeenPlus": false,
"horrorOrFearThemes": "NONE",
"matureOrSuggestiveThemes": "NONE",
"unrestrictedWebAccess": false,
"violenceCartoonOrFantasy": "NONE",
"violenceRealisticProlongedGraphicOrSadistic": "NONE",
"violenceRealistic": "NONE"
},
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/ageRatingDeclarations/a9c2ad6a-182f-4021-9456-6b609ebc5eab"
}
},
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/949768f6-58e5-46b4-b046-23861f61831a/ageRatingDeclaration"
}
}
@@ -0,0 +1,11 @@
{
"errors": [
{
"id": "9901eeb2-81e7-4562-9beb-c5f72010ab71",
"status": "404",
"code": "NOT_FOUND",
"title": "The specified resource does not exist",
"detail": "There is no resource of type 'appStoreVersions' with id 'non-existing'"
}
]
}
@@ -0,0 +1,70 @@
{
"data": [{
"type": "appStoreVersionLocalizations",
"id": "4bad54bc-3810-401a-a7f4-b02ef8206c41",
"attributes": {
"description": "Some of the best apps",
"locale": "nl-NL",
"keywords": "meme, red, square, x2",
"marketingUrl": "https://github.com/bycedric/red-square-app",
"promotionalText": null,
"supportUrl": "https://github.com/bycedric/red-square-app/issues",
"whatsNew": null
},
"relationships": {
"appScreenshotSets": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersionLocalizations/4bad54bc-3810-401a-a7f4-b02ef8206c41/relationships/appScreenshotSets",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersionLocalizations/4bad54bc-3810-401a-a7f4-b02ef8206c41/appScreenshotSets"
}
},
"appPreviewSets": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersionLocalizations/4bad54bc-3810-401a-a7f4-b02ef8206c41/relationships/appPreviewSets",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersionLocalizations/4bad54bc-3810-401a-a7f4-b02ef8206c41/appPreviewSets"
}
}
},
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersionLocalizations/4bad54bc-3810-401a-a7f4-b02ef8206c41"
}
}, {
"type": "appStoreVersionLocalizations",
"id": "61153520-c5df-40a1-bb2b-e09cbfc33fe9",
"attributes": {
"description": "Some of the best apps",
"locale": "en-US",
"keywords": "meme, red, square, x2",
"marketingUrl": "https://github.com/bycedric/red-square-app",
"promotionalText": null,
"supportUrl": "https://github.com/bycedric/red-square-app/issues",
"whatsNew": null
},
"relationships": {
"appScreenshotSets": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersionLocalizations/61153520-c5df-40a1-bb2b-e09cbfc33fe9/relationships/appScreenshotSets",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersionLocalizations/61153520-c5df-40a1-bb2b-e09cbfc33fe9/appScreenshotSets"
}
},
"appPreviewSets": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersionLocalizations/61153520-c5df-40a1-bb2b-e09cbfc33fe9/relationships/appPreviewSets",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersionLocalizations/61153520-c5df-40a1-bb2b-e09cbfc33fe9/appPreviewSets"
}
}
},
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersionLocalizations/61153520-c5df-40a1-bb2b-e09cbfc33fe9"
}
}],
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/949768f6-58e5-46b4-b046-23861f61831a/appStoreVersionLocalizations"
},
"meta": {
"paging": {
"total": 2,
"limit": 50
}
}
}
@@ -0,0 +1,115 @@
{
"data": [
{
"type": "appInfos",
"id": "APP_INFO_1",
"attributes": {
"appStoreState": "PREPARE_FOR_SUBMISSION",
"appStoreAgeRating": "NINE_PLUS",
"brazilAgeRating": "TEN",
"kidsAgeBand": null
},
"relationships": {
"ageRatingDeclaration": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appInfos/APP_INFO_1/relationships/ageRatingDeclaration",
"related": "https://appstoreconnect.apple.com/iris/v1/appInfos/APP_INFO_1/ageRatingDeclaration"
}
},
"appInfoLocalizations": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appInfos/APP_INFO_1/relationships/appInfoLocalizations",
"related": "https://appstoreconnect.apple.com/iris/v1/appInfos/APP_INFO_1/appInfoLocalizations"
}
},
"primaryCategory": {
"data": {
"type": "appCategories",
"id": "ENTERTAINMENT"
},
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appInfos/APP_INFO_1/relationships/primaryCategory",
"related": "https://appstoreconnect.apple.com/iris/v1/appInfos/APP_INFO_1/primaryCategory"
}
},
"primarySubcategoryOne": {
"data": null,
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appInfos/APP_INFO_1/relationships/primarySubcategoryOne",
"related": "https://appstoreconnect.apple.com/iris/v1/appInfos/APP_INFO_1/primarySubcategoryOne"
}
},
"primarySubcategoryTwo": {
"data": null,
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appInfos/APP_INFO_1/relationships/primarySubcategoryTwo",
"related": "https://appstoreconnect.apple.com/iris/v1/appInfos/APP_INFO_1/primarySubcategoryTwo"
}
},
"secondaryCategory": {
"data": null,
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appInfos/APP_INFO_1/relationships/secondaryCategory",
"related": "https://appstoreconnect.apple.com/iris/v1/appInfos/APP_INFO_1/secondaryCategory"
}
},
"secondarySubcategoryOne": {
"data": null,
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appInfos/APP_INFO_1/relationships/secondarySubcategoryOne",
"related": "https://appstoreconnect.apple.com/iris/v1/appInfos/APP_INFO_1/secondarySubcategoryOne"
}
},
"secondarySubcategoryTwo": {
"data": null,
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appInfos/APP_INFO_1/relationships/secondarySubcategoryTwo",
"related": "https://appstoreconnect.apple.com/iris/v1/appInfos/APP_INFO_1/secondarySubcategoryTwo"
}
}
},
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appInfos/APP_INFO_1"
}
}
],
"included": [
{
"type": "appCategories",
"id": "ENTERTAINMENT",
"attributes": {
"platforms": [
"IOS",
"MAC_OS",
"TV_OS"
]
},
"relationships": {
"subcategories": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appCategories/ENTERTAINMENT/relationships/subcategories",
"related": "https://appstoreconnect.apple.com/iris/v1/appCategories/ENTERTAINMENT/subcategories"
}
},
"parent": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appCategories/ENTERTAINMENT/relationships/parent",
"related": "https://appstoreconnect.apple.com/iris/v1/appCategories/ENTERTAINMENT/parent"
}
}
},
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appCategories/ENTERTAINMENT"
}
}
],
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/apps/1611050397/appInfos?include=secondaryCategory%2CprimaryCategory%2CsecondarySubcategoryOne%2CprimarySubcategoryTwo%2CsecondarySubcategoryTwo%2CprimarySubcategoryOne"
},
"meta": {
"paging": {
"total": 1,
"limit": 50
}
}
}
@@ -0,0 +1,11 @@
{
"errors": [
{
"id": "APP_INFO_0",
"status": "404",
"code": "NOT_FOUND",
"title": "The specified resource does not exist",
"detail": "There is no resource of type 'appInfo' with id 'non-existing'"
}
]
}
@@ -0,0 +1,116 @@
{
"data": [
{
"type": "appStoreVersions",
"id": "APP_STORE_VERSION_1",
"attributes": {
"platform": "IOS",
"versionString": "1.0",
"appStoreState": "PREPARE_FOR_SUBMISSION",
"storeIcon": null,
"watchStoreIcon": null,
"copyright": "2022 name",
"releaseType": "SCHEDULED",
"earliestReleaseDate": "2022-03-14T17:00:00-07:00",
"usesIdfa": null,
"isWatchOnly": false,
"downloadable": true,
"createdDate": "2022-02-21T09:26:24-08:00",
"promotedDate": null
},
"relationships": {
"ageRatingDeclaration": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/relationships/ageRatingDeclaration",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/ageRatingDeclaration"
}
},
"appStoreVersionLocalizations": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/relationships/appStoreVersionLocalizations",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/appStoreVersionLocalizations"
}
},
"build": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/relationships/build",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/build"
}
},
"appStoreVersionPhasedRelease": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/relationships/appStoreVersionPhasedRelease",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/appStoreVersionPhasedRelease"
}
},
"gameCenterConfiguration": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/relationships/gameCenterConfiguration",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/gameCenterConfiguration"
}
},
"routingAppCoverage": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/relationships/routingAppCoverage",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/routingAppCoverage"
}
},
"appStoreReviewDetail": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/relationships/appStoreReviewDetail",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/appStoreReviewDetail"
}
},
"appStoreVersionSubmission": {
"data": null,
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/relationships/appStoreVersionSubmission",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/appStoreVersionSubmission"
}
},
"resetRatingsRequest": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/relationships/resetRatingsRequest",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/resetRatingsRequest"
}
},
"idfaDeclaration": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/relationships/idfaDeclaration",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/idfaDeclaration"
}
},
"appClipDefaultExperience": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/relationships/appClipDefaultExperience",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/appClipDefaultExperience"
}
},
"appStoreVersionStateChanges": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/relationships/appStoreVersionStateChanges",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/appStoreVersionStateChanges"
}
},
"appStoreVersionExperiments": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/relationships/appStoreVersionExperiments",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/appStoreVersionExperiments"
}
}
},
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1"
}
}
],
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/apps/1611050397/appStoreVersions?include=appStoreVersionSubmission&filter%5Bplatform%5D=IOS&filter%5BappStoreState%5D=DEVELOPER_REJECTED%2CINVALID_BINARY%2CMETADATA_REJECTED%2CPREPARE_FOR_SUBMISSION%2CREJECTED%2CWAITING_FOR_REVIEW"
},
"meta": {
"paging": {
"total": 1,
"limit": 50
}
}
}
@@ -0,0 +1,116 @@
{
"data": [
{
"type": "appStoreVersions",
"id": "APP_STORE_VERSION_1",
"attributes": {
"platform": "IOS",
"versionString": "1.0",
"appStoreState": "PREPARE_FOR_SUBMISSION",
"storeIcon": null,
"watchStoreIcon": null,
"copyright": "2022 name",
"releaseType": "SCHEDULED",
"earliestReleaseDate": "2022-03-14T17:00:00-07:00",
"usesIdfa": null,
"isWatchOnly": false,
"downloadable": true,
"createdDate": "2022-02-21T09:26:24-08:00",
"promotedDate": null
},
"relationships": {
"ageRatingDeclaration": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/relationships/ageRatingDeclaration",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/ageRatingDeclaration"
}
},
"appStoreVersionLocalizations": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/relationships/appStoreVersionLocalizations",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/appStoreVersionLocalizations"
}
},
"build": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/relationships/build",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/build"
}
},
"appStoreVersionPhasedRelease": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/relationships/appStoreVersionPhasedRelease",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/appStoreVersionPhasedRelease"
}
},
"gameCenterConfiguration": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/relationships/gameCenterConfiguration",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/gameCenterConfiguration"
}
},
"routingAppCoverage": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/relationships/routingAppCoverage",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/routingAppCoverage"
}
},
"appStoreReviewDetail": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/relationships/appStoreReviewDetail",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/appStoreReviewDetail"
}
},
"appStoreVersionSubmission": {
"data": null,
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/relationships/appStoreVersionSubmission",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/appStoreVersionSubmission"
}
},
"resetRatingsRequest": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/relationships/resetRatingsRequest",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/resetRatingsRequest"
}
},
"idfaDeclaration": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/relationships/idfaDeclaration",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/idfaDeclaration"
}
},
"appClipDefaultExperience": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/relationships/appClipDefaultExperience",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/appClipDefaultExperience"
}
},
"appStoreVersionStateChanges": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/relationships/appStoreVersionStateChanges",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/appStoreVersionStateChanges"
}
},
"appStoreVersionExperiments": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/relationships/appStoreVersionExperiments",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/appStoreVersionExperiments"
}
}
},
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1"
}
}
],
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/apps/1611050397/appStoreVersions?include=appStoreVersionSubmission&filter%5Bplatform%5D=IOS&limit=2"
},
"meta": {
"paging": {
"total": 1,
"limit": 2
}
}
}
@@ -0,0 +1,219 @@
{
"data": [
{
"type": "appStoreVersions",
"id": "APP_STORE_VERSION_1",
"attributes": {
"platform": "IOS",
"versionString": "1.0",
"appStoreState": "PREPARE_FOR_SUBMISSION",
"storeIcon": null,
"watchStoreIcon": null,
"copyright": "2022 name",
"releaseType": "SCHEDULED",
"earliestReleaseDate": "2022-03-14T17:00:00-07:00",
"usesIdfa": null,
"isWatchOnly": false,
"downloadable": true,
"createdDate": "2022-02-21T09:26:24-08:00",
"promotedDate": null
},
"relationships": {
"ageRatingDeclaration": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/relationships/ageRatingDeclaration",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/ageRatingDeclaration"
}
},
"appStoreVersionLocalizations": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/relationships/appStoreVersionLocalizations",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/appStoreVersionLocalizations"
}
},
"build": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/relationships/build",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/build"
}
},
"appStoreVersionPhasedRelease": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/relationships/appStoreVersionPhasedRelease",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/appStoreVersionPhasedRelease"
}
},
"gameCenterConfiguration": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/relationships/gameCenterConfiguration",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/gameCenterConfiguration"
}
},
"routingAppCoverage": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/relationships/routingAppCoverage",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/routingAppCoverage"
}
},
"appStoreReviewDetail": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/relationships/appStoreReviewDetail",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/appStoreReviewDetail"
}
},
"appStoreVersionSubmission": {
"data": null,
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/relationships/appStoreVersionSubmission",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/appStoreVersionSubmission"
}
},
"resetRatingsRequest": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/relationships/resetRatingsRequest",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/resetRatingsRequest"
}
},
"idfaDeclaration": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/relationships/idfaDeclaration",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/idfaDeclaration"
}
},
"appClipDefaultExperience": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/relationships/appClipDefaultExperience",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/appClipDefaultExperience"
}
},
"appStoreVersionStateChanges": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/relationships/appStoreVersionStateChanges",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/appStoreVersionStateChanges"
}
},
"appStoreVersionExperiments": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/relationships/appStoreVersionExperiments",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/appStoreVersionExperiments"
}
}
},
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1"
}
},
{
"type": "appStoreVersions",
"id": "APP-STORE-VERSION-2",
"attributes": {
"platform": "IOS",
"versionString": "1.1",
"appStoreState": "PREPARE_FOR_SUBMISSION",
"storeIcon": null,
"watchStoreIcon": null,
"copyright": "2022 name",
"releaseType": "SCHEDULED",
"earliestReleaseDate": "2022-03-14T17:00:00-07:00",
"usesIdfa": null,
"isWatchOnly": false,
"downloadable": true,
"createdDate": "2022-02-21T09:26:24-08:00",
"promotedDate": null
},
"relationships": {
"ageRatingDeclaration": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP-STORE-VERSION-2/relationships/ageRatingDeclaration",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP-STORE-VERSION-2/ageRatingDeclaration"
}
},
"appStoreVersionLocalizations": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP-STORE-VERSION-2/relationships/appStoreVersionLocalizations",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP-STORE-VERSION-2/appStoreVersionLocalizations"
}
},
"build": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP-STORE-VERSION-2/relationships/build",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP-STORE-VERSION-2/build"
}
},
"appStoreVersionPhasedRelease": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP-STORE-VERSION-2/relationships/appStoreVersionPhasedRelease",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP-STORE-VERSION-2/appStoreVersionPhasedRelease"
}
},
"gameCenterConfiguration": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP-STORE-VERSION-2/relationships/gameCenterConfiguration",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP-STORE-VERSION-2/gameCenterConfiguration"
}
},
"routingAppCoverage": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP-STORE-VERSION-2/relationships/routingAppCoverage",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP-STORE-VERSION-2/routingAppCoverage"
}
},
"appStoreReviewDetail": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP-STORE-VERSION-2/relationships/appStoreReviewDetail",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP-STORE-VERSION-2/appStoreReviewDetail"
}
},
"appStoreVersionSubmission": {
"data": null,
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP-STORE-VERSION-2/relationships/appStoreVersionSubmission",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP-STORE-VERSION-2/appStoreVersionSubmission"
}
},
"resetRatingsRequest": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP-STORE-VERSION-2/relationships/resetRatingsRequest",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP-STORE-VERSION-2/resetRatingsRequest"
}
},
"idfaDeclaration": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP-STORE-VERSION-2/relationships/idfaDeclaration",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP-STORE-VERSION-2/idfaDeclaration"
}
},
"appClipDefaultExperience": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP-STORE-VERSION-2/relationships/appClipDefaultExperience",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP-STORE-VERSION-2/appClipDefaultExperience"
}
},
"appStoreVersionStateChanges": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP-STORE-VERSION-2/relationships/appStoreVersionStateChanges",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP-STORE-VERSION-2/appStoreVersionStateChanges"
}
},
"appStoreVersionExperiments": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP-STORE-VERSION-2/relationships/appStoreVersionExperiments",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP-STORE-VERSION-2/appStoreVersionExperiments"
}
}
},
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP-STORE-VERSION-2"
}
}
],
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/apps/1611050397/appStoreVersions?include=appStoreVersionSubmission&filter%5Bplatform%5D=IOS&limit=2"
},
"meta": {
"paging": {
"total": 1,
"limit": 2
}
}
}
@@ -0,0 +1,6 @@
/** A stubbed request context for the ASC API library */
export const requestContext = {
providerId: 1337,
teamId: 'test-team-id',
token: 'test-token',
};
@@ -0,0 +1,42 @@
import { AgeRatingDeclaration } from '@expo/apple-utils';
import assert from 'assert';
import chalk from 'chalk';
import Log from '../../../log';
import { logAsync } from '../../utils/log';
import { AppleTask, TaskDownloadOptions, TaskPrepareOptions, TaskUploadOptions } from '../task';
export type AgeRatingData = {
/** The app age rating declaration for the app version */
ageRating: AgeRatingDeclaration;
};
export class AgeRatingTask extends AppleTask {
name = (): string => 'age rating declarations';
async prepareAsync({ context }: TaskPrepareOptions): Promise<void> {
assert(context.version, `App version information is not prepared, can't update age rating`);
context.ageRating = (await context.version.getAgeRatingDeclarationAsync()) || undefined;
}
async downloadAsync({ config, context }: TaskDownloadOptions): Promise<void> {
if (context.ageRating) {
config.setAgeRating(context.ageRating.attributes);
}
}
async uploadAsync({ config, context }: TaskUploadOptions): Promise<void> {
assert(context.ageRating, `Age rating not initialized, can't update age rating`);
const ageRating = config.getAgeRating();
if (!ageRating) {
Log.log(chalk`{dim - Skipped age rating update, no advisory configured}`);
} else {
context.ageRating = await logAsync(() => context.ageRating.updateAsync(ageRating), {
pending: 'Updating age rating declaration...',
success: 'Updated age rating declaration',
failure: 'Failed to update age rating declaration',
});
}
}
}
@@ -0,0 +1,86 @@
import { AppInfo, AppInfoLocalization } from '@expo/apple-utils';
import assert from 'assert';
import chalk from 'chalk';
import Log from '../../../log';
import { logAsync } from '../../utils/log';
import { retryIfNullAsync } from '../../utils/retry';
import { AppleTask, TaskDownloadOptions, TaskPrepareOptions, TaskUploadOptions } from '../task';
export type AppInfoData = {
/** The current app info that should be edited */
info: AppInfo;
/** All info locales that are enabled */
infoLocales: AppInfoLocalization[];
};
export class AppInfoTask extends AppleTask {
name = (): string => 'app information';
async prepareAsync({ context }: TaskPrepareOptions): Promise<void> {
const info = await retryIfNullAsync(() => context.app.getEditAppInfoAsync());
assert(info, 'Could not resolve the editable app info to update');
context.info = info;
context.infoLocales = await info.getLocalizationsAsync();
}
async downloadAsync({ config, context }: TaskDownloadOptions): Promise<void> {
assert(context.info, `App info not initialized, can't download info`);
config.setCategories(context.info.attributes);
for (const locale of context.infoLocales) {
config.setInfoLocale(locale.attributes);
}
}
async uploadAsync({ config, context }: TaskUploadOptions): Promise<void> {
assert(context.info, `App info not initialized, can't update info`);
const categories = config.getCategories();
if (!categories) {
Log.log(chalk`{dim - Skipped app category update, not configured}`);
} else {
context.info = await logAsync(() => context.info.updateCategoriesAsync(categories), {
pending: 'Updating app categories...',
success: 'Updated app categories',
failure: 'Failed updating app categories',
});
}
const locales = config.getLocales();
if (locales.length <= 0) {
Log.log(chalk`{dim - Skipped localized info update, no locales configured}`);
} else {
// BUG: new issue introduced in ASC 1.8.0, when creating version locales, info locales are also generated
context.infoLocales = await logAsync(() => context.info.getLocalizationsAsync(), {
pending: 'Reloading localized info...',
success: 'Reloaded localized info',
failure: 'Failed reloading localized info',
});
for (const locale of locales) {
const attributes = config.getInfoLocale(locale);
if (!attributes) {
continue;
}
const model = context.infoLocales.find(model => model.attributes.locale === locale);
await logAsync(
() =>
model
? model.updateAsync(attributes)
: context.info.createLocalizationAsync({ ...attributes, locale }),
{
pending: `${model ? 'Updating' : 'Creating'} localized info for ${locale}...`,
success: `${model ? 'Updated' : 'Created'} localized info for ${locale}`,
failure: `Failed ${model ? 'updating' : 'creating'} localized info for ${locale}`,
}
);
}
context.infoLocales = await context.info.getLocalizationsAsync();
}
}
}
@@ -0,0 +1,150 @@
import { App, AppStoreVersion, AppStoreVersionLocalization, Platform } from '@expo/apple-utils';
import assert from 'assert';
import chalk from 'chalk';
import Log from '../../../log';
import { logAsync } from '../../utils/log';
import { retryIfNullAsync } from '../../utils/retry';
import { AppleTask, TaskDownloadOptions, TaskPrepareOptions, TaskUploadOptions } from '../task';
export type AppVersionOptions = {
/** If we should use the live version of the app (if available - defaults to false) */
editLive: boolean;
/** The platform to use (defaults to IOS) */
platform: Platform;
};
export type AppVersionData = {
/** The current selected app store version to update */
version: AppStoreVersion;
/** If the current selected version is a live version, where not all properties are editable */
versionIsLive: boolean;
/** If the current selected version is the first version to be created */
versionIsFirst: boolean;
/** All version locales that should be, or are enabled */
versionLocales: AppStoreVersionLocalization[];
};
export class AppVersionTask extends AppleTask {
private options: AppVersionOptions;
constructor(options: Partial<AppVersionOptions> = {}) {
super();
this.options = {
platform: options.platform || Platform.IOS,
editLive: options.editLive || false,
};
}
name = (): string => (this.options.editLive ? 'live app version' : 'editable app version');
async prepareAsync({ context }: TaskPrepareOptions): Promise<void> {
const { version, versionIsFirst, versionIsLive } = await resolveVersionAsync(
context.app,
this.options
);
assert(version, 'Could not resolve a live or editable app version');
context.version = version;
context.versionIsFirst = versionIsFirst;
context.versionIsLive = versionIsLive;
context.versionLocales = await version.getLocalizationsAsync();
}
async downloadAsync({ config, context }: TaskDownloadOptions): Promise<void> {
assert(context.version, `App version not initialized, can't download version`);
config.setVersion(context.version.attributes);
config.setVersionRelease(context.version.attributes);
for (const locale of context.versionLocales) {
config.setVersionLocale(locale.attributes);
}
}
async uploadAsync({ config, context }: TaskUploadOptions): Promise<void> {
assert(context.version, `App version not initialized, can't update version`);
const version = config.getVersion();
const release = config.getVersionRelease();
if (!version && !release) {
Log.log(chalk`{dim - Skipped version and release update, not configured}`);
} else {
const description = [version && 'version info', release && 'release info']
.filter(Boolean)
.join(' and ');
context.version = await logAsync(
() => context.version.updateAsync({ ...version, ...release }),
{
pending: `Updating ${description}...`,
success: `Updated ${description}`,
failure: `Failed updating ${description}`,
}
);
}
const locales = config.getLocales();
if (locales.length <= 0) {
Log.log(chalk`{dim - Skipped localized version update, no locales configured}`);
} else {
for (const locale of locales) {
const attributes = config.getVersionLocale(locale, context);
if (!attributes) {
continue;
}
const oldModel = context.versionLocales.find(model => model.attributes.locale === locale);
await logAsync(
() =>
oldModel
? oldModel.updateAsync(attributes)
: context.version.createLocalizationAsync({ ...attributes, locale }),
{
pending: `${oldModel ? 'Updating' : 'Creating'} localized version for ${locale}...`,
success: `${oldModel ? 'Updated' : 'Created'} localized version for ${locale}`,
failure: `Failed ${oldModel ? 'updating' : 'creating'} localized version for ${locale}`,
}
);
}
context.versionLocales = await context.version.getLocalizationsAsync();
}
}
}
/**
* Resolve the AppStoreVersion instance, either from live or editable version.
* This also checks if this is the first version, which disallow release notes.
*/
async function resolveVersionAsync(
app: App,
{ editLive, platform }: AppVersionOptions
): Promise<{
version: AppStoreVersion | null;
versionIsLive: boolean;
versionIsFirst: boolean;
}> {
let version: AppStoreVersion | null = null;
let versionIsLive = false;
if (editLive) {
version = await app.getLiveAppStoreVersionAsync({ platform });
versionIsLive = !!version;
}
if (!version) {
version = await retryIfNullAsync(() => app.getEditAppStoreVersionAsync({ platform }));
}
const versions = await app.getAppStoreVersionsAsync({
query: { limit: 2, filter: { platform } },
});
return {
version,
versionIsLive,
versionIsFirst: versions.length === 1,
};
}
@@ -0,0 +1,12 @@
import { MetadataContext } from '../../context';
import { AppleTask } from '../task';
import { AgeRatingTask } from './age-rating';
import { AppInfoTask } from './app-info';
import { AppVersionTask } from './app-version';
/**
* List of all eligible tasks to sync local store configuration to the App store.
*/
export function createAppleTasks(_ctx: MetadataContext): AppleTask[] {
return [new AppVersionTask(), new AppInfoTask(), new AgeRatingTask()];
}
@@ -0,0 +1,56 @@
import type { AgeRatingDeclarationProps, AppCategoryId, AppSubcategoryId } from '@expo/apple-utils';
export type AppleLocale = string;
export interface AppleMetadata {
copyright?: string;
info?: Record<AppleLocale, AppleInfo>;
categories?: AppCategoryId[] | AppleCategory;
release?: AppleRelease;
advisory?: AppleAdvisory;
preview?: Record<string, string[]>;
review?: AppleReview;
}
export type AppleAdvisory = Partial<AgeRatingDeclarationProps>;
export interface AppleCategory {
category: AppCategoryId;
subcategory?: AppSubcategoryId[];
}
export interface AppleRelease {
isPhasedReleaseEnabled?: boolean;
shouldResetRatings?: boolean;
autoReleaseDate?: number | string;
automaticRelease?: boolean;
usesThirdPartyContent?: boolean;
/** Alternative to setting `ITSAppUsesNonExemptEncryption` in the binary's `Info.plist`. */
usesNonExemptEncryption?: boolean;
}
export interface AppleInfo {
title: string;
subtitle?: string;
/** Does not effect ASO https://developer.apple.com/app-store/product-page/ */
promoText?: string;
description?: string;
keywords?: string[];
releaseNotes?: string;
marketingUrl?: string;
privacyPolicyUrl?: string;
privacyPolicyText?: string;
privacyChoicesUrl?: string;
supportUrl?: string;
}
export interface AppleReview {
firstName?: string;
lastName?: string;
phone?: string;
email?: string;
demoUsername?: string;
demoPassword?: string;
notes?: string;
attachment?: string;
}
+42
View File
@@ -0,0 +1,42 @@
import Ajv from 'ajv';
import assert from 'assert';
import { AppleConfigReader } from './apple/config/reader';
import { AppleConfigWriter } from './apple/config/writer';
import { AppleMetadata } from './apple/types';
export interface MetadataConfig {
/** The store configuration version */
configVersion: number;
/** All App Store related configuration */
apple?: AppleMetadata;
}
/**
* Run the JSON Schema validation to normalize defaults and flag early config errors.
* This includes validating the known store limitations for every configurable property.
*/
export function validateConfig(config: unknown): {
valid: boolean;
errors: Ajv.ErrorObject[];
} {
const validator = new Ajv({ allErrors: true, useDefaults: true })
.addMetaSchema(require('ajv/lib/refs/json-schema-draft-06.json'))
.compile(require('../../schema/metadata-0.json'));
const valid = validator(config) as boolean;
return { valid, errors: validator.errors || [] };
}
/** Create a versioned deserializer to fetch App Store data from the store configuration. */
export function createAppleReader(config: MetadataConfig): AppleConfigReader {
assert(config.configVersion === 0, 'Unsupported store configuration version');
assert(config.apple, 'No apple configuration found');
return new AppleConfigReader(config.apple);
}
/** Create the serializer to write the App Store to the store configuration. */
export function createAppleWriter(): AppleConfigWriter {
return new AppleConfigWriter();
}
+97
View File
@@ -0,0 +1,97 @@
import { App, Session } from '@expo/apple-utils';
import { ExpoConfig } from '@expo/config';
import { Platform } from '@expo/eas-build-job';
import { SubmitProfile } from '@expo/eas-json';
import assert from 'assert';
import { CredentialsContext } from '../credentials/context';
import { getRequestContext } from '../credentials/ios/appstore/authenticate';
import { getExpoConfig } from '../project/expoConfig';
import { getBundleIdentifierAsync } from '../project/ios/bundleIdentifier';
import { Actor } from '../user/User';
import { ensureLoggedInAsync } from '../user/actions';
import { getProfilesAsync } from '../utils/profiles';
export type MetadataContext = {
/** Submission profile platform to use */
platform: Platform.IOS;
/** Resolved submission profile configuration */
profile: SubmitProfile<Platform.IOS>;
/** Configured store config path, relative from projectDir (defaults to store.config.json) */
metadataPath: string;
/** Authenticated Expo account */
user: Actor;
/** The store credentials manager */
credentialsCtx: CredentialsContext;
/** The app bundle identifier to use for the store */
bundleIdentifier: string;
/** Root of the Expo project directory */
projectDir: string;
/** Resolved Expo app configuration */
exp: ExpoConfig;
};
export type MetadataAppStoreAuthentication = {
/** The root entity of the App store */
app: App;
/** The authentication state we used to fetch the root entity */
auth: Partial<Session.AuthState>;
};
/**
* Metadata uses the submission profile to find the configured metadata filename.
* Note, only iOS is supported for metadata right now.
*/
export async function createMetadataContextAsync(params: {
projectDir: string;
credentialsCtx: CredentialsContext;
exp?: ExpoConfig;
profileName?: string;
}): Promise<MetadataContext> {
const submissionProfiles = await getProfilesAsync({
type: 'submit',
platforms: [Platform.IOS],
projectDir: params.projectDir,
profileName: params.profileName,
});
const submissionProfile = submissionProfiles.find(profile => profile.platform === Platform.IOS);
assert(
submissionProfile,
'Could not resolve the iOS submission profile, only iOS is supported for metadata'
);
const iosSubmissionProfile = submissionProfile.profile as SubmitProfile<Platform.IOS>;
const exp = params.exp ?? getExpoConfig(params.projectDir);
const user = await ensureLoggedInAsync();
const bundleIdentifier = await getBundleIdentifierAsync(params.projectDir, exp);
return {
platform: Platform.IOS,
profile: iosSubmissionProfile,
metadataPath: iosSubmissionProfile.metadataPath ?? 'store.config.json',
user,
credentialsCtx: params.credentialsCtx,
bundleIdentifier,
projectDir: params.projectDir,
exp,
};
}
/**
* To start syncing ASC entities, we need access to the apple utils App instance.
* This ensures we are authenticated and have the app instance ready to use.
*/
export async function ensureMetadataAppStoreAuthenticatedAsync({
credentialsCtx,
bundleIdentifier,
}: MetadataContext): Promise<MetadataAppStoreAuthentication> {
const authCtx = await credentialsCtx.appStore.ensureAuthenticatedAsync();
assert(authCtx.authState, 'Failed to authenticate with App Store Connect');
// TODO: improve error handling by mentioning possible configuration errors
const app = await App.findAsync(getRequestContext(authCtx), { bundleId: bundleIdentifier });
assert(app, `Failed to load app "${bundleIdentifier}" from App Store Connect`);
return { app, auth: authCtx.authState };
}
+65
View File
@@ -0,0 +1,65 @@
import fs from 'fs-extra';
import path from 'path';
import { MetadataEvent } from '../analytics/events';
import { confirmAsync } from '../prompts';
import { AppleData } from './apple/data';
import { createAppleTasks } from './apple/tasks';
import { createAppleWriter } from './config';
import { MetadataContext, ensureMetadataAppStoreAuthenticatedAsync } from './context';
import { MetadataDownloadError, MetadataValidationError } from './errors';
import { subscribeTelemetry } from './utils/telemetry';
/**
* Generate a local store configuration from the stores.
* Note, only App Store is supported at this time.
*/
export async function downloadMetadataAsync(metadataCtx: MetadataContext): Promise<string> {
const filePath = path.resolve(metadataCtx.projectDir, metadataCtx.metadataPath);
const fileExists = await fs.pathExists(filePath);
if (fileExists) {
const overwrite = await confirmAsync({
message: `Do you want to overwrite the existing store configuration "${metadataCtx.metadataPath}"?`,
});
if (!overwrite) {
throw new MetadataValidationError(`Store configuration already exists at "${filePath}"`);
}
}
const { app, auth } = await ensureMetadataAppStoreAuthenticatedAsync(metadataCtx);
const { unsubscribeTelemetry, executionId } = subscribeTelemetry(
MetadataEvent.APPLE_METADATA_DOWNLOAD,
{ app, auth }
);
const errors: Error[] = [];
const config = createAppleWriter();
const tasks = createAppleTasks(metadataCtx);
const taskCtx = { app };
for (const task of tasks) {
try {
await task.prepareAsync({ context: taskCtx });
} catch (error: any) {
errors.push(error);
}
}
for (const task of tasks) {
try {
await task.downloadAsync({ config, context: taskCtx as AppleData });
} catch (error: any) {
errors.push(error);
}
}
await fs.writeJson(filePath, config.toSchema(), { spaces: 2 });
unsubscribeTelemetry();
if (errors.length > 0) {
throw new MetadataDownloadError(errors, executionId);
}
return filePath;
}
+69
View File
@@ -0,0 +1,69 @@
import type { ErrorObject } from 'ajv';
import Log, { link } from '../log';
/**
* Before syncing data to the ASC API, we need to validate the metadata config.
* This error represents unrecoverable issues before syncing that data,
* and should contain useful information for the user to solve before trying again.
*/
export class MetadataValidationError extends Error {
constructor(message?: string, public readonly errors?: ErrorObject[]) {
super(message ?? 'Store configuration validation failed');
}
}
/**
* If a single entity failed to update, we don't block the other entities from uploading.
* We still attempt to update the data in the stores as much as possible.
* Because of that, we keep track of any errors encountered and throw this generic error.
* It contains that list of encountered errors to present to the user.
*/
export class MetadataUploadError extends Error {
constructor(public readonly errors: Error[], public readonly executionId: string) {
super(
`Store configuration upload encountered ${
errors.length === 1 ? 'an error' : `${errors.length} errors`
}.`
);
}
}
/**
* If a single entity failed to download, we don't block the other entities from downloading.
* We sill attempt to pull in the data from the stores as much as possible.
* Because of that, we keep track of any errors envountered and throw this generic error.
* It contains that list of encountered errors to present to the user.
*/
export class MetadataDownloadError extends Error {
constructor(public readonly errors: Error[], public readonly executionId: string) {
super(
`Store configuration download encountered ${
errors.length === 1 ? 'an error' : `${errors.length} errors`
}.`
);
}
}
/**
* Handle a thrown metadata error by informing the user what went wrong.
* If a normal error is thrown, this method will re-throw that error to avoid consuming it.
*/
export function handleMetadataError(error: Error): void {
if (error instanceof MetadataValidationError) {
Log.error(error.message);
Log.log(error.errors?.map(err => ` - ${err.dataPath} ${err.message}`).join('\n'));
return;
}
if (error instanceof MetadataDownloadError || error instanceof MetadataUploadError) {
Log.error(error.message);
Log.log('Please check the logs for any configuration issues.');
Log.log('If this issue persists, please open a new issue at:');
// TODO: add execution ID to the issue template link
Log.log(link('https://github.com/expo/eas-cli'));
return;
}
throw error;
}
+60
View File
@@ -0,0 +1,60 @@
import fs from 'fs-extra';
import path from 'path';
import { MetadataEvent } from '../analytics/events';
import { AppleData } from './apple/data';
import { createAppleTasks } from './apple/tasks';
import { createAppleReader, validateConfig } from './config';
import { MetadataContext, ensureMetadataAppStoreAuthenticatedAsync } from './context';
import { MetadataUploadError, MetadataValidationError } from './errors';
import { subscribeTelemetry } from './utils/telemetry';
/**
* Sync a local store configuration with the stores.
* Note, only App Store is supported at this time.
*/
export async function uploadMetadataAsync(metadataCtx: MetadataContext): Promise<void> {
const filePath = path.resolve(metadataCtx.projectDir, metadataCtx.metadataPath);
if (!(await fs.pathExists(filePath))) {
throw new MetadataValidationError(`Store configuration file not found "${filePath}"`);
}
const { app, auth } = await ensureMetadataAppStoreAuthenticatedAsync(metadataCtx);
const { unsubscribeTelemetry, executionId } = subscribeTelemetry(
MetadataEvent.APPLE_METADATA_UPLOAD,
{ app, auth }
);
const fileData = await fs.readJson(filePath);
const { valid, errors: validationErrors } = validateConfig(fileData);
if (!valid) {
throw new MetadataValidationError(`Store configuration errors found`, validationErrors);
}
const errors: Error[] = [];
const config = createAppleReader(fileData);
const tasks = createAppleTasks(metadataCtx);
const taskCtx = { app };
for (const task of tasks) {
try {
await task.prepareAsync({ context: taskCtx });
} catch (error: any) {
errors.push(error);
}
}
for (const task of tasks) {
try {
await task.uploadAsync({ config, context: taskCtx as AppleData });
} catch (error: any) {
errors.push(error);
}
}
unsubscribeTelemetry();
if (errors.length > 0) {
throw new MetadataUploadError(errors, executionId);
}
}
@@ -0,0 +1,25 @@
import { removeDatePrecision } from '../date';
describe(removeDatePrecision, () => {
it('returns null for falsy values', () => {
expect(removeDatePrecision(null)).toBeNull();
expect(removeDatePrecision(undefined)).toBeNull();
expect(removeDatePrecision(false)).toBeNull();
});
it('returns null for invalid dates', () => {
expect(removeDatePrecision('invalid-date')).toBeNull();
});
it('returns date from date instance without time precision', () => {
const input = new Date('2022-06-01T11:46:29.850Z');
const output = new Date('2022-06-01T11:00:00.000Z');
expect(removeDatePrecision(input)?.toISOString()).toBe(output.toISOString());
});
it('returns date from string instance without time precision', () => {
const input = '2022-06-01T11:46:29.850Z';
const output = '2022-06-01T11:00:00.000Z';
expect(removeDatePrecision(input)?.toISOString()).toBe(output);
});
});
@@ -0,0 +1,79 @@
import { App } from '@expo/apple-utils';
import { TelemetryContext, makeDataScrubber } from '../telemetry';
describe(makeDataScrubber, () => {
const stub: TelemetryContext = {
// Only the App ID is considered to be sensitive
app: new App({} as any, 'SECRET_APP_ID', {} as any),
// Only the token properties and user credentials are considered to be sensitive
auth: {
username: 'SECRET_USERNAME',
password: 'SECRET_PASSWORD',
context: {
token: 'SECRET_TOKEN',
teamId: 'SECRET_TEAM_ID',
providerId: 1337,
},
} as any,
};
it('scrubs the app.id', () => {
expect(makeDataScrubber(stub)('some text SECRET_APP_ID')).toBe('some text {APPLE_APP_ID}');
});
it('scrubs the auth.username', () => {
expect(makeDataScrubber(stub)('some text SECRET_USERNAME')).toBe('some text {APPLE_USERNAME}');
});
it('scrubs the auth.password', () => {
expect(makeDataScrubber(stub)('SECRET_PASSWORD')).toBe('{APPLE_PASSWORD}');
});
it('scrubs the auth.context.token', () => {
expect(makeDataScrubber(stub)('some text SECRET_TOKEN')).toBe('some text {APPLE_TOKEN}');
});
it('scrubs the auth.context.token when using token instances', () => {
const token = { getToken: () => 'SECRET_TOKEN_INSTANCE' } as any;
const scrubber = makeDataScrubber({
...stub,
auth: {
...stub.auth,
context: {
...stub.auth.context,
token,
},
},
});
expect(scrubber('some text SECRET_TOKEN_INSTANCE')).toBe('some text {APPLE_TOKEN}');
});
it('scrubs the auth.context.teamId', () => {
expect(makeDataScrubber(stub)('SECRET_TEAM_ID')).toBe('{APPLE_TEAM_ID}');
});
it('scrubs the auth.context.teamId', () => {
expect(makeDataScrubber(stub)('some provider 1337')).toBe('some provider {APPLE_PROVIDER_ID}');
});
it('scrubber returns string representation of falsy values', () => {
const scrubber = makeDataScrubber(stub);
expect(scrubber(null)).toBe('null');
expect(scrubber(undefined)).toBe('undefined');
expect(scrubber(false)).toBe('false');
});
it('scrubs multiple sensitive values at once', () => {
expect(makeDataScrubber(stub)('SECRET_TOKEN SECRET_USERNAME SECRET_PASSWORD')).toBe(
'{APPLE_TOKEN} {APPLE_USERNAME} {APPLE_PASSWORD}'
);
});
it('scrubs json and transforms it to string', () => {
const scrubber = makeDataScrubber(stub);
expect(scrubber({ foo: 'bar' })).toBe('{"foo":"bar"}');
expect(scrubber({ value: 'SECRET_APP_ID' })).toBe('{"value":"{APPLE_APP_ID}"}');
});
});
@@ -0,0 +1,4 @@
export function unique<T = any>(items: T[]): T[] {
const set = new Set(items);
return [...set];
}
@@ -0,0 +1,4 @@
import { ConnectModel } from '@expo/apple-utils';
/** Get the properties of a single App Store Connect entity */
export type AttributesOf<T extends ConnectModel> = T['attributes'];
@@ -0,0 +1,26 @@
/**
* Remove time precision from a date to avoid potential errors with the App Store.
*
* "status": "409",
* "code": "ENTITY_ERROR.ATTRIBUTE.INVALID",
* "title": "An attribute value is invalid.",
* "detail": "The attribute 'earliestReleaseDate' only allows hour precision",
* "source": {
* "pointer": "/data/attributes/earliestReleaseDate"
* }
*/
export function removeDatePrecision(date: any): null | Date {
if (date) {
try {
const result = new Date(date);
result.setMinutes(0);
result.setSeconds(0);
result.setMilliseconds(0);
if (!isNaN(result.getTime())) {
return result;
}
} catch {}
}
return null;
}
@@ -0,0 +1,34 @@
import { Ora, ora } from '../../ora';
type LogAsyncOptions = {
/** If the spinner representing the async action should be hidden, e.g. for JSON output */
hidden?: boolean;
/** The message to display when the action is pending */
pending: string;
/** The message to display when the action succeeded */
success: string;
/** The message to display when the action failed */
failure: string;
};
/**
* Log an asynchronous action using a spinner.
*/
export async function logAsync<T>(
action: (spinner?: Ora) => Promise<T>,
{ hidden, ...message }: LogAsyncOptions
): Promise<T> {
if (hidden) {
return action();
}
const spinner = ora(message.pending).start();
try {
const result = await action(spinner);
spinner.succeed(message.success);
return result;
} catch (error) {
spinner.fail(message.failure);
throw error;
}
}
@@ -0,0 +1,28 @@
export async function waitAsync(duration: number): Promise<void> {
return new Promise(resolve => setTimeout(resolve, duration));
}
type WithRetryOptions = {
tries?: number;
delay?: number;
onRetry?: (triesLeft: number) => void;
};
export async function retryIfNullAsync<T>(
method: () => Promise<T | null>,
options: WithRetryOptions = {}
): Promise<T | null> {
let { tries = 5, delay = 1000 } = options;
while (tries > 0) {
const value = await method();
if (value !== null) {
return value;
}
tries--;
options.onRetry?.(tries);
await waitAsync(delay);
}
return null;
}
@@ -0,0 +1,110 @@
import { App, Session, getRequestClient } from '@expo/apple-utils';
import type { AxiosError } from 'axios';
import { v4 as uuidv4 } from 'uuid';
import { Analytics, MetadataEvent } from '../../analytics/events';
export type TelemetryContext = {
app: App;
auth: Partial<Session.AuthState>;
};
/**
* Subscribe the telemetry to the ongoing metadata requests and responses.
* When providing the app and auth info, we can scrub that data from the telemetry.
* Returns an execution ID to group all events of a single run together, and a unsubscribe function.
*/
export function subscribeTelemetry(
event: MetadataEvent,
options: TelemetryContext
): {
/** Unsubscribe the telemetry from all apple-utils events */
unsubscribeTelemetry: () => void;
/** The unique id added to all telemetry events from a single execution */
executionId: string;
} {
const executionId = uuidv4();
const scrubber = makeDataScrubber(options);
const { interceptors } = getRequestClient();
const responseInterceptorId = interceptors.response.use(
response => {
Analytics.logEvent(event, {
executionId,
type: 'response',
phase: 'resolved',
method: response.request.method.toUpperCase(),
url: scrubber(response.request.path),
status: String(response.status),
statusText: scrubber(response.statusText),
});
return response;
},
(error: AxiosError) => {
Analytics.logEvent(event, {
executionId,
type: 'response',
phase: 'rejected',
method: error.request.method.toUpperCase(),
url: scrubber(error.config.url),
error: scrubber(error.message),
status: String(error.response?.status),
statusText: scrubber(error.response?.statusText),
input: scrubber(error.config.data),
output: scrubber(error.response?.data),
});
throw error;
}
);
function unsubscribeTelemetry(): void {
interceptors.response.eject(responseInterceptorId);
}
return { unsubscribeTelemetry, executionId };
}
/** Exposed for testing */
export function makeDataScrubber({ app, auth }: TelemetryContext): <T>(data: T) => string {
const token = getAuthTokenString(auth);
const patterns: Record<string, RegExp | null> = {
APPLE_APP_ID: new RegExp(app.id, 'gi'),
APPLE_USERNAME: auth.username ? new RegExp(auth.username, 'gi') : null,
APPLE_PASSWORD: auth.password ? new RegExp(auth.password, 'gi') : null,
APPLE_TOKEN: token ? new RegExp(token, 'gi') : null,
APPLE_TEAM_ID: auth.context?.teamId ? new RegExp(auth.context.teamId, 'gi') : null,
APPLE_PROVIDER_ID: auth.context?.providerId
? new RegExp(String(auth.context.providerId), 'gi')
: null,
};
const iterator = Object.entries(patterns);
return function scrubber(data) {
if (!data) {
return String(data);
}
let value = typeof data === 'object' ? JSON.stringify(data) : String(data);
for (const [replacement, pattern] of iterator) {
if (pattern) {
value = value.replace(pattern, `{${replacement}}`);
}
}
return value;
};
}
function getAuthTokenString(auth: TelemetryContext['auth']): string | null {
if (!auth.context?.token) {
return null;
}
if (typeof auth.context.token === 'object') {
return auth.context.token.getToken();
}
return auth.context.token;
}
+1 -1
View File
@@ -78,7 +78,7 @@ function printInstructionsForIosSubmission(submission: SubmissionFragment): void
'- It usually takes about 5-10 minutes depending on how busy Apple servers are.',
// ascAppIdentifier should be always available for ios submissions but check it anyway
submission.iosConfig?.ascAppIdentifier &&
`- When it’s done, you can see your build here: ${link(
`- When it's done, you can see your build here: ${link(
`https://appstoreconnect.apple.com/apps/${submission.iosConfig?.ascAppIdentifier}/appstore/ios`
)}`,
].join('\n');
@@ -6,6 +6,7 @@ enum SubmissionErrorCode {
ARCHIVE_DOWNLOAD_FORBIDDEN_ERROR = 'SUBMISSION_SERVICE_COMMON_ARCHIVE_DOWNLOAD_FORBIDDEN_ERROR',
ARCHIVE_EXTRACT_NO_FILES_FOUND_ERROR = 'SUBMISSION_SERVICE_COMMON_ARCHIVE_EXTRACT_NO_FILES_FOUND_ERROR',
ARCHIVE_EXTRACT_CORRUPT_ARCHIVE_ERROR = 'SUBMISSION_SERVICE_COMMON_ARCHIVE_EXTRACT_CORRUPT_ARCHIVE_ERROR',
UPLOAD_TAKING_TOO_LONG_ERROR = 'SUBMISSION_SERVICE_COMMON_UPLOAD_TAKING_TOO_LONG_ERROR',
ANDROID_UNKNOWN_ERROR = 'SUBMISSION_SERVICE_ANDROID_UNKNOWN_ERROR',
ANDROID_FIRST_UPLOAD_ERROR = 'SUBMISSION_SERVICE_ANDROID_FIRST_UPLOAD_ERROR',
ANDROID_OLD_VERSION_CODE_ERROR = 'SUBMISSION_SERVICE_ANDROID_OLD_VERSION_CODE_ERROR',
@@ -70,6 +71,8 @@ const SubmissionErrorMessages: Record<SubmissionErrorCode, string> = {
'Invalid Provisioning Profile Signature (ITMS-90165)\n' +
"Some of Apple's certificates have expired.\n" +
'Please delete your Provisioning Profile from your account. Then rebuild the app interactively to generate a new one, and try submitting it to the App Store again.',
[SubmissionErrorCode.UPLOAD_TAKING_TOO_LONG_ERROR]:
'Submission has reached the timeout limit. Please try again.',
};
export function printSubmissionError(error: SubmissionError): boolean {
+1 -1
View File
@@ -1,7 +1,7 @@
{
"name": "@expo/eas-json",
"description": "A library for interacting with eas.json",
"version": "0.53.0",
"version": "0.53.1",
"author": "Expo <[email protected]>",
"bugs": "https://github.com/expo/eas-cli/issues",
"dependencies": {
+1
View File
@@ -26,6 +26,7 @@ export const IosSubmitProfileSchema = Joi.object({
companyName: Joi.string(),
appName: Joi.string(),
bundleIdentifier: Joi.string(),
metadataPath: Joi.string(),
});
export const SubmitProfileSchema = Joi.object({
+1
View File
@@ -38,6 +38,7 @@ export interface IosSubmitProfile {
companyName?: string;
appName?: string;
bundleIdentifier?: string;
metadataPath?: string;
}
export const IosSubmitProfileFieldsToEvaluate: (keyof IosSubmitProfile)[] = [
Generated
+1 -1
View File
@@ -4004,7 +4004,7 @@ aggregate-error@^3.0.0:
clean-stack "^2.0.0"
indent-string "^4.0.0"
ajv@^6.10.0, ajv@^6.12.3, ajv@^6.12.4:
ajv@^6.10.0, ajv@^6.12.3, ajv@^6.12.4, ajv@^6.12.6:
version "6.12.6"
resolved "https://registry.yarnpkg.com/ajv/-/ajv-6.12.6.tgz#baf5a62e802b07d977034586f8c3baf5adf26df4"
integrity sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==