Skip to content

feat(ios): update for 4.16.1#236

Merged
dcrawbuck merged 2 commits into
mainfrom
update-ios-sdk-4.16.1
Jul 1, 2026
Merged

feat(ios): update for 4.16.1#236
dcrawbuck merged 2 commits into
mainfrom
update-ios-sdk-4.16.1

Conversation

@dcrawbuck

@dcrawbuck dcrawbuck commented Jul 1, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Bumps documented iOS SDK version from 4.15.4 to 4.16.1 (previousVersion -> newVersion).
  • Updates <SdkLatestVersion> in content/docs/ios/index.mdx and content/docs/ios/sdk-reference/index.mdx.
  • Adds the 4.16.1 entry to content/docs/ios/changelog.mdx, copied verbatim from upstream CHANGELOG.md, with all existing history preserved.

Upstream source

Upstream 4.15.4 → 4.16.1 spans two releases:

  • 4.16.0: install attribution (MMP) matching, billed-monthly annual subscriptions, new EventTrackingBehavior enum (deprecates isExternalDataCollectionEnabled), plus crash/eligibility fixes.
  • 4.16.1: doc clarification for IntegrationAttribute.onesignalId, and a compiler-directive fix for billing plan types on Xcode 26.4.

Checklist of doc updates performed

  • content/docs/ios/index.mdxSdkLatestVersion4.16.1
  • content/docs/ios/sdk-reference/index.mdxSdkLatestVersion4.16.1
  • content/docs/ios/changelog.mdx — added 4.16.1 entry above 4.16.0, history preserved
  • Verified SPM/CocoaPods install snippets (content/docs/ios/quickstart/install.mdx) use open version ranges (>= 4.0.0, < 5.0.0) and need no change
  • Verified 4.16.0 API surface (EventTrackingBehavior, eventTrackingBehavior, MMP attribution) was already documented in SuperwallOptions.mdx / Superwall.mdx in a prior update — no content drift found
  • Confirmed remaining 4.15.4 string in setIntegrationAttributes.mdx is a correct "added in version" historical marker, not a stale reference
  • bun test — 65 pass / 0 fail

Known gaps / follow-ups

  • bun run build:cf could 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: SdkLatestVersion on the main iOS and SDK reference index pages moves from 4.15.4 to 4.16.1, and changelog.mdx adds a 4.16.1 section (OneSignal IntegrationAttribute.onesignalId clarification; Xcode 26.4 billing-plan compiler-directive fix).

The setIntegrationAttributes reference now documents .onesignalId in 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.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge 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"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge 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.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge 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 👍 / 👎.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jul 1, 2026

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Updated (UTC)
✅ Deployment successful!
View logs
superwall-docs ed6319d Jul 01 2026, 07:05 PM

@dcrawbuck dcrawbuck merged commit a9890ab into main Jul 1, 2026
2 of 3 checks passed
@dcrawbuck dcrawbuck deleted the update-ios-sdk-4.16.1 branch July 1, 2026 18:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant