readdle/app-store-server-api

IMPROVEMENTS:

• ResponseBodyV2::createFromSignedPayload() introduced — decodes a signedPayload JWT directly instead of requiring it to be wrapped into a fake raw notification JSON first; NotificationHistoryResponseItem now uses it internally
• Makefile: lint-74 .. lint-85 targets added (lint against PHP 7.4 through 8.5), plus composer, stan, and test shortcuts

BUGFIX:

• AppStoreServerAPIInterface was missing the getTransactionHistoryV2() and setAppAccountToken() declarations even though AppStoreServerAPI already implemented both — interface updated to match
• setAppAccountToken(): parameter (and underlying request URL placeholder) renamed from $transactionId to $originalTransactionId to match what the endpoint actually expects (breaking change if you call this method using a named argument)
• JWT::verifyX509Chain(): throws a proper exception when the x5c certificate chain doesn't contain exactly 3 certificates, instead of triggering an Undefined array key warning (which could previously surface as an uncaught TypeError further down)
• JWTCreationException::__construct(): implicit nullable parameter deprecation fixed (Throwable $previous = null → ?Throwable $previous = null)

IMPROVEMENTS:

• Added DecodedRealtimeRequestBody
• Added RealtimeResponseBody
  FIXES:
• Deleted composer.lock and added to gitignore
• Fixed phpunit version so it is compatible with PHP version

BUGFIX:

• composer.json: autoload-dev PSR-4 namespace fixed
• AbstractRequestQueryParams::getQueryString() integer values handling fixed
• Unit tests added for GetTransactionHistoryQueryParams::getQueryString()

IMPROVEMENTS:

• setAppAccountToken() support added to AppStoreServerAPI
• New request classes for the endpoint: SetAppAccountTokenRequest, UpdateAppAccountTokenRequestBody

IMPROVEMENTS:

• Proper handling of failed HTTP requests added

• StoreKit2Transaction and StoreKit2AppTransaction introduced

IMPROVEMENTS:

• Introduced new field to TransactionInfo: offerPeriod

IMPROVEMENTS:

• New notificationType = ONE_TIME_CHARGE in ResponseBodyV2

BUGFIX:

• TransactionInfo::getAppTransactionId() make it public (silly bug)

IMPROVEMENTS:

• Introduced new field to TransactionInfo: appTransactionId
• Introduced new fields to RenewalInfo: appAccountToken, appTransactionId, currency, eligibleWinBackOfferIds, offerDiscountType, offerPeriod, renewalPrice
• App Store Server API version compatibility: 1.15 - 2025/02/21

BUGFIX:

• Calling sendConsumptionInformation() w/o passing optional parameter refundPreference results in fatal error

IMPROVEMENTS:

• Insignificant refactoring of AbstractRequestParamsBag class

BUGFIX:

• AbstractRequestParamsBag::isValueMatchingPropValues() fixed (double negation if value is an array)
• AbstractRequestQueryParams::getQueryString() fixed (bool values are now explicitly converted to strings)

IMPROVEMENTS:

• New field consumptionRequestReason added to AppMetadata
• New field refundPreference (and corresponding constants) added to ConsumptionRequestBody (kudos to @sedlak477)

IMPROVEMENTS:

• In-app purchase history V2 support added (kudos to @anegve)

BUGFIX:

• Default TTL for payload introduced and set to 5 min. Previous value of 1 hour (which is the maximum) seems to be the cause of failed responses in some cases.
• Makefile introduced just to have a shortcut 'make shell' for running Docker container using PHP image and having project directory mounted

IMPROVEMENTS:

• Nullable properties now are NOT converted to empty int/bool/float/string in AppMetadata, RenewalInfo, ResponseBodyV2, TransactionInfo, kudos to @dbrkv for pointing this out
• ArrayTypeCastGenerator moved to the separate class
• PHPUnit tests introduced (just the first one for ArrayTypeCastGenerator atm)
• Examples reworked a bit (RenewalInfo/TransactionInfo printing moved to the separate helper function)

IMPROVEMENTS:

• Now the response content of the HTTP response is available in HTTPRequestFailed exception using getResponseText() method, kudos to @soxft for pointing this out

BUGFIX:

• Handle empty response headers in case if HTTP request to the API fails (and it fails regularly, kudos to Apple)

BUGFIX:

• If the certificate string already has a prefix, there is no need to add it

BUGFIX:

• Treat "202 Accepted" as successful response (App Store returns it on "Send consumption information" request), kudos to @teanooki for pointing this out

IMPROVEMENTS:

New fields implemented

• TransactionInfo: price, currency, and offerDiscountType from App Store Server API version 1.10

BUGFIX:

• Logic issue in PageableResponse, after fixing syntax issue in 3.5.1

BUGFIX:

• Syntax issue in PageableResponse for PHP 7.4, kudos to @JamieSTV

IMPROVEMENTS:

Missing endpoints added:

• Send Consumption Information
• Extend a Subscription Renewal Date
• Extend Subscription Renewal Dates for All Active Subscribers
• Get Status of Subscription Renewal Date Extensions

BUGFIX:

• TransactionInfo: storefront, storefrontId, and transactionReason are now nullable and null by default, in order to be compatible with old notifications
• RenewalInfo: renewalDate is now null by default, in order to be compatible with old notifications
• Response\NotificationHistoryResponse: paginationToken presence in response is now optional

IMPROVEMENTS:

• New notificationType/subtype in ResponseBodyV2

BUGFIX:

• ASN1SequenceOfInteger: multiple 00 bytes in the beginning of integer numbers handled when parsing HEX signature representation

BUGFIX:

• AppMetadata: bundleId, bundleVersion, renewalInfo, transactionInfo and status now are NULL by default (to prevent Typed property ... must not be accessed before initialization error)

IMPROVEMENTS:

• New field implemented
  • AppMetadata: status

IMPROVEMENTS:

• New fields implemented
  • RenewalInfo: renewalDate
  • TransactionInfo: storefront, storefrontId, transactionReason

BUGFIX:

• ResponseBodyV2: createFromRawNotification() fix, now it checks incoming notification to be not only a valid JSON, but also to be an array

BUGFIX:

• ASN1SequenceOfInteger: math fixes
• StatusResponse: data array initialization with []

IMPROVEMENTS:

• HTTPRequest: PUT method added; HTTP method and URL added to HTTPRequestFailed exception message
• JWT: additional information in exception message

BUGFIX:

• Math bug fixed in ASN1SequenceOfInteger. In rare cases signature was calculated in a wrong way which led to Wrong signature exception in JWT::verifySignature

BREAKING CHANGES:

• Main classes renamed:
  • APIClient -> AppStoreServerAPI
  • APIClientInterface -> AppStoreServerAPIInterface
  • Notification\ResponseBodyV2 -> ResponseBodyV2
  • JWT -> Util\JWT
  • Request\GetTransactionHistory -> Request\GetTransactionHistoryRequest
  • Request\RequestTestNotification -> Request\RequestTestNotificationRequest
  • Request\GetTransactionHistoryQueryParams -> RequestQueryParams\GetTransactionHistoryQueryParams
• Environment consts moved out from all classes to the separate class Environment
• getTransactionHistory() method signature changed: it no longer expects for QueryParams instance as a second arguments, now it expects array instead
• AppStoreServerAPI (previously APIClient) constructor signature changed:
  • $environment argument type changed from int to string
  • $keyId and $key arguments swapped

IMPROVEMENTS:

• PHP 7.4 support out of the box ;)
• A lot of new endpoints (see README)
• Examples for all implemented endpoints (and notification listener)