Kebechet.Maui.RevenueCat.iOS 5.102.1

Maui.RevenueCat.iOS

• this binding is based on: https://github.com/thisisthekap/Xamarin.RevenueCat.iOS
• it is created for .NET MAUI
• it contains bindings for RevenueCat iOS plugin
  • https://www.revenuecat.com/
  • https://docs.revenuecat.com/docs/ios
  • https://github.com/RevenueCat/purchases-ios

Versioning Scheme

The versioning scheme of Maui.RevenueCat.iOS is derived from the versioning of revenuecat/purchases-ios.

Example:

Binding creation

Porting old xamarin library ios to .NET MAUI

First version of our Maui binding was just changed Xamarin.RevenueCat.iOS binding working for .NET MAUI. It was binding around RevenueCat ios 4.9.0, but this native library contained bitcode which is no longer accepted by AppStore. Porting of binding from Xamarin to Maui required several changes:

• Removed some attributes in ApiDefinitions - commit
• Changed IntPtr → NativeReference in ApiDefinitions - commit
  • reference
• Added NoBindingEmbedding = false - commit

Creating completely new binding consisted of these steps:

Because of a problem with bitcode I have decided to create completely new binding from scratch. Here are steps I have done:

Generating binding files

• On my MAC I have downloaded and installed Objective Sharpie
• I have downloaded RevenueCat.xcframework.zip of purchases-ios v4.19.0
• Extract inner RevenueCat.xcframework/ios-arm64 folder on MAC desktop.
• started terminal, then cd ~/Desktop
• firstly check what versions of xcode SDKs you have installed by sharpie xcode -sdks and use the iphoneosXX.Y version you have
• I used command sharpie bind -framework ios-arm64/RevenueCat.framework -sdk iphoneos18.4 -scope ios-arm64/RevenueCat.framework/Headers
  • this command generated ApiDefinitions.cs and StructsAndEnums.cs files
  • in case it did not and gives you error: RevenueCat: framework requires SDK 'iphoneosXX.Y' which is not installed. You may need a newer Xcode. In my case it was iphoneos16.4
    • if you have older Xcode then update it
    • if you have newest Xcode then you need to install older iOS SDKs
      • go to Apple developer web and download Xcode that contains that SDK. In my case Xcode 14.3.1 contains iphoneos16.4
      • after the download extract .xip file and after extraction right click on extracted Xcode file and Show Package Contents
      • then navigate there into Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs and copy iPhoneOsXX.Y.sdk (if it is just link/alias then copy the iPhoneOs.sdk and rename it to iPhoneOsXX.Y.sdk in my case iPhoneOS16.4.sdk)
      • then go to location of your original Xcode → Show Package Contents → navigate again to: Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs and paste the copied iPhoneOSXX.Y.sdk there
      • restart Xcode
      • to verify you did everything correctly run in terminal: sharpie xcode -sdks and the new SDK you copied should be now there as well
      • then run the sharpie command to generate ApiDefinitions.cs and StructsAndEnums.cs files again

Test Store API key support (BYPASS_SIMULATED_STORE_RELEASE_CHECK)

• The pre-built RevenueCat.xcframework.zip release asset published by RevenueCat/purchases-ios is always Release-configured. Its Sources/Purchasing/Configuration.swift contains the guard #if !DEBUG && !BYPASS_SIMULATED_STORE_RELEASE_CHECK which calls checkForSimulatedStoreAPIKeyInRelease(...) and force-closes any consumer app initialised with a Test Store API key (test_…) — even in DEBUG, because the framework itself was built Release.
• To make Test Store keys usable for development without an App Store setup, the bundled nativelib/RevenueCat.xcframework is built from source by .github/workflows/try-bump-ios.yml with the BYPASS_SIMULATED_STORE_RELEASE_CHECK Swift compilation flag set via Local.xcconfig:

  SWIFT_ACTIVE_COMPILATION_CONDITIONS = $(inherited) BYPASS_SIMULATED_STORE_RELEASE_CHECK
  

• This mirrors the approach used by RevenueCat/purchases-kmp in its kn-core/build.gradle.kts (swiftSettings { define("BYPASS_SIMULATED_STORE_RELEASE_CHECK") }).
• Global.xcconfig at the purchases-ios repo root does #include? "Local.xcconfig" and is read by RevenueCat.xcodeproj, so writing Local.xcconfig is enough for the flag to reach the build.
• The workflow verifies the bypass is active by asserting BYPASS_SIMULATED_STORE_RELEASE_CHECK is present in the RevenueCat target's resolved SWIFT_ACTIVE_COMPILATION_CONDITIONS (xcodebuild -showBuildSettings) before building — a direct, positive check rather than relying on the absence of an internal symbol that may never be externally visible regardless of the flag.
• See issue #116 for context.

Adjusting generated files

• then I placed new framework file into repo
  • framework file - commit
  • generated files - commit
• firstly commented but later completely removed Verify attributes - commit
• then removed all device-specific attributes - commit
  • TIP: You can find all attributes by searching for iOS (. Because all of them contain this string
  • at the same time commented out (AutoGeneratedName = true)
• added namespaces - commit
• comment out text that was not commented out - commit
• then I merged interfaces with the same names e.g. RCAttribution and RCAttribution_RevenueCat_Swift_3714 I put together - commit
  • I have also removed obsolete & deprecated interfaces/methods
• removed default using there were useless - commit
• removed constants interface - commit
  • because I didnt know how to bind byte[] 😅
  • (optional) If you would like to bind the RevenueCatVersionNumber use this for interface name: [BaseType(typeof(NSObject))] [DisableDefaultCtor] interface RCConstants and above the variable put [Static] attribute
• removed interfaces without methods/properties - commit
• remove Protocols that were used for inheritance - commit
• removed delegate that was not used anywhere - commit
• added INativeObject inheritance for interfaces that were used in dictionaries and was of type NSObject - commit
  • error example: cannot be used as type parameter 'TValue' in the generic type or method 'NSDictionary<TKey, TValue>'
• replaced NSUrlRequest for NSMutableUrlRequest - commit
• created delegates for Purchases - commit
  • when delegates are not replaced then error Trampolines.g.cs(433,25,433,26): error CS1026: ) expected
• removed inherited NSObject methods - commit
  • isEqual and Description
  • also removed DebugDescription - commit
• removed inherited NSOperation methods - commit
• I have created aliases for methods named the same - commit
  • ⚠️ I dont know if this is correct or even necessary, maybe I could delete them as well
  • The post-processor does this for methods: the second LogIn (string, Action<…>) becomes LogInCompletionHandler, named after the last part of its selector.
  • 🛑 Never rename a Constructor this way. bgen treats only a member named Constructor as an initializer, so a renamed one (ConstructorCustomEntitlementComputation) is a plain method that sends init… to an object that already exists.
    • Two initializers can share a C# signature: 5.102.1 added initWithAutoSyncPurchases:forceAllowTestStoreInReleaseBuilds: next to initWithAutoSyncPurchases:customEntitlementComputation:, both (bool, bool).
    • Keep Constructor on the selector the published binding already binds, otherwise new RCDangerousSettings(bool, bool) still compiles for every consumer and quietly sets the other option.
    • Bind the other one [Internal], the way dotnet/macios binds VNVector's initWithR:theta: (VNVector.cs):

      [Export ("initWithAutoSyncPurchases:forceAllowTestStoreInReleaseBuilds:")]
      [Internal]
      NativeHandle _InitWithAutoSyncPurchasesForceAllowTestStoreInReleaseBuilds (bool autoSyncPurchases, bool forceAllowTestStoreInReleaseBuilds);
      

    • The post-processor does all of this itself: the bump workflow passes the committed ApiDefinitions.cs as --published, and the manual-review report lists every initializer it bound [Internal].
    • To make such an initializer public, add a factory in a partial class in a regular .cs file of the binding project (not ApiDefinitions.cs):

      public partial class RCDangerousSettings
      {
          public static RCDangerousSettings CreateWithForceAllowTestStoreInReleaseBuilds(bool autoSyncPurchases, bool forceAllowTestStoreInReleaseBuilds)
          {
              var dangerousSettings = new RCDangerousSettings(NSObjectFlag.Empty);
              dangerousSettings.InitializeHandle(dangerousSettings._InitWithAutoSyncPurchasesForceAllowTestStoreInReleaseBuilds(autoSyncPurchases, forceAllowTestStoreInReleaseBuilds));
              return dangerousSettings;
          }
      }
      

    • The bump PR's API report lists a member under 🛑 when its C# signature stayed but its selector changed, and the PR opens as an api-rebound draft.
• removed attributes containing Name - commit
  • this was because on my windows machine I was getting errors that platform doesnt have symbols specified for this methods containing the name
  • later I completely removed those methods because the error was still there - commit
• From [Obsoleted] remove all new line characters \n
• from .xcframework remove all *.swiftmodule directories
• ✅ - Done
  • I have tested this new binding in the simulator as well as on real device through TestFlight and it works as expected

Additional fix:

• if you experience build error: lang++ exited with code 1: error : Undefined symbols for architecture arm64
  • I experienced this problem while debugging on Remote device (iphone connected directly to MAC and that MAC connected to Windows)

"_OBJC_CLASS_$_FakeASIdManager", referenced from:
  objc-class-ref in registrar.o
"_OBJC_CLASS_$_FakeAfficheClient", referenced from:
  objc-class-ref in registrar.o
"_OBJC_CLASS_$_FakeTrackingManager", referenced from:
  objc-class-ref in registrar.o
"_OBJC_CLASS_$_NetworkOperation", referenced from:
  objc-class-ref in registrar.o
"_OBJC_CLASS_$_PaymentQueueWrapper", referenced from:
  objc-class-ref in registrar.o
"_OBJC_CLASS_$_ProductsFetcherSK1", referenced from:
  objc-class-ref in registrar.o
"_OBJC_CLASS_$_PurchasesReceiptParser", referenced from:
  objc-class-ref in registrar.o
"_OBJC_CLASS_$_StoreKit1Wrapper", referenced from:
  objc-class-ref in registrar.o
"_OBJC_CLASS_$_StoreKitRequestFetcher", referenced from:
  objc-class-ref in registrar.o
"_OBJC_CLASS_$_TrackingManagerProxy", referenced from:
  objc-class-ref in registrar.o

• then remove those types e.g. FakeASIdManager from ApiDefinitions.cs file - commit

Xcode

• When latest Xcode version is out it doesn't mean MAUI/Xamarin can immediately it.
  • You can find here what Xcode is currently supported. Even though Xcode version is on the list make sure to check open github issues in the xamarin-macios repo
  • In case you want to upgrade/downgrade to specific Xcode version then:
    • uninstall your current version
    • download version you want: https://developer.apple.com/download/all/
    • extract .xip file and move it's content to /Applications folder
    • after extraction open Xcode and it will ask you to install additional components (e.g. iOS) so install it
• In case you get error The connection cannot continue because the remote iOS SDK was not found or is corrupted.
  • go to your MAC and in terminal do: rm -rf ~/Library/Caches/Xamarin/XMA/SDKs/dotnet/

⚠️Warning

• in .NET 7 and with VS2022 v17.7 IT IS NOT POSSIBLE TO BUILD THE PACKAGE WITH EMBEDDED NATIVE LIBRARY (even with connected MAC).
  • You need to build this package on MAC with VS for MAC. Only that way it will link native library to the package.
  • https://github.com/dotnet/maui/issues/14982
• in VS2022 v17.8.4 with latest MAUI it works correctly

License

This repository is licensed with the MIT license.