feat(ios): update for 4.16.1#236
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 6585cee9a8
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| ### Enhancements | ||
|
|
||
| - Clarifies that `IntegrationAttribute.onesignalId` should be set to the OneSignal User ID used by the OneSignal integration. |
There was a problem hiding this comment.
Document the OneSignal ID guidance
This release note is still the only iOS docs mention of OneSignal; content/docs/ios/sdk-reference/setIntegrationAttributes.mdx omits .onesignalId from the IntegrationAttribute types, and a repo-wide search for onesignal|OneSignal in the iOS/shared docs only finds this changelog entry. Because the 4.16.1 upstream change is specifically a customer-facing clarification that the value must be the OneSignal User ID, users looking up how to set integration attributes still will not see the corrected guidance outside the changelog.
Useful? React with 👍 / 👎.
|
|
||
| <SdkLatestVersion | ||
| version="4.15.4" | ||
| version="4.16.1" |
There was a problem hiding this comment.
Document the new attribution event
Bumping the SDK reference to 4.16.1 brings in the 4.16.0 public install-attribution API, but content/docs/ios/sdk-reference/SuperwallEvent.mdx still has no attributionMatch/AttributionMatchInfo entry; a repo-wide search for AttributionMatch|attribution_match only finds the changelog/options note. Users forwarding handleSuperwallEvent(withInfo:) will not know about the new event case or payload shape even though this page now advertises the newer SDK version.
Useful? React with 👍 / 👎.
|
|
||
| ### Fixes | ||
|
|
||
| - Makes sure that the compiler directive is correct for billing plan types so that the SDK builds in Xcode version 26.4. |
There was a problem hiding this comment.
Guard the billing-plan sample for older compilers
The 4.16.1 release note calls out fixing the compiler directive for billing plan types, but the docs sample in content/docs/ios/sdk-reference/PurchaseController.mdx still references StoreKit.Product.SubscriptionInfo.BillingPlanType under only a runtime #available check (lines 159-170). Apps compiling that snippet with a compiler/SDK that does not know the 26.4 StoreKit symbols will fail before the availability check can help; wrap the billing-plan block in the same #if compiler(...) guard used by the SDK or show an older-compiler fallback.
Useful? React with 👍 / 👎.
Deploying with
|
| Status | Name | Latest Commit | Updated (UTC) |
|---|---|---|---|
| ✅ Deployment successful! View logs |
superwall-docs | ed6319d | Jul 01 2026, 07:05 PM |
Summary
4.15.4to4.16.1(previousVersion -> newVersion).<SdkLatestVersion>incontent/docs/ios/index.mdxandcontent/docs/ios/sdk-reference/index.mdx.4.16.1entry tocontent/docs/ios/changelog.mdx, copied verbatim from upstreamCHANGELOG.md, with all existing history preserved.Upstream source
Upstream 4.15.4 → 4.16.1 spans two releases:
EventTrackingBehaviorenum (deprecatesisExternalDataCollectionEnabled), plus crash/eligibility fixes.IntegrationAttribute.onesignalId, and a compiler-directive fix for billing plan types on Xcode 26.4.Checklist of doc updates performed
content/docs/ios/index.mdx—SdkLatestVersion→4.16.1content/docs/ios/sdk-reference/index.mdx—SdkLatestVersion→4.16.1content/docs/ios/changelog.mdx— added4.16.1entry above4.16.0, history preservedcontent/docs/ios/quickstart/install.mdx) use open version ranges (>= 4.0.0,< 5.0.0) and need no changeEventTrackingBehavior,eventTrackingBehavior, MMP attribution) was already documented inSuperwallOptions.mdx/Superwall.mdxin a prior update — no content drift found4.15.4string insetIntegrationAttributes.mdxis a correct "added in version" historical marker, not a stale referencebun test— 65 pass / 0 failKnown gaps / follow-ups
bun run build:cfcould not complete in this sandbox (OOM during full-site Vite build with 3.8Gi RAM / 2 CPUs — unrelated to this change, which only touches 3 content files). Recommend CI re-verifies the full build.Note
Low Risk
Documentation-only changes to changelog, version badges, and integration-attribute guidance; no runtime or API implementation changes in this repo.
Overview
Updates iOS documentation to SuperwallKit 4.16.1:
SdkLatestVersionon the main iOS and SDK reference index pages moves from4.15.4to4.16.1, andchangelog.mdxadds a 4.16.1 section (OneSignalIntegrationAttribute.onesignalIdclarification; Xcode 26.4 billing-plan compiler-directive fix).The
setIntegrationAttributesreference now documents.onesignalIdin the usage example and attribute list, stating it must be the OneSignal User ID (onesignal_id), not the legacy Player ID.Reviewed by Cursor Bugbot for commit ed6319d. Bugbot is set up for automated code reviews on this repo. Configure here.