test: rebuild example app, split mainline from other platforms

this way we have one app that stays generally up to date (currently 0.82)
while the other platforms which lag behind still exist but don't hold back
mainline (they are currently 0.79)

Author: mikehardy

.github/workflows/tests_e2e.yml

@@ -110,8 +110,9 @@ jobs:
         with:
           path: |
             example/ios/Pods
-            example/macos/Pods
-          key: ${{ runner.os }}-pods-${{ hashFiles('example/ios/Podfile.lock', 'example/macos/Podfile.lock') }}
+            example-other/macos/Pods
+            example-other/visionos/Pods
+          key: ${{ runner.os }}-pods-${{ hashFiles('example/ios/Podfile.lock', 'example-other/macos/Podfile.lock', 'example-other/visionos/Podfile.lock') }}
 
       # Detox is compiled during yarn install, using Xcode, set up cache first
       - uses: hendrikmuhs/ccache-action@v1
@@ -148,8 +149,10 @@ jobs:
           timeout_minutes: 10
           retry_wait_seconds: 60
           max_attempts: 3
-          command: yarn && yarn example:prepare
+          command: yarn && yarn example:prepare && yarn example:other:prepare
 
       - name: Build iOS App
         run: |
           yarn example:build:ios
+          yarn example:other:build:macos
+          yarn example:other:build:visionos

.gitignore

@@ -547,4 +547,5 @@ Pods/*
 
 .yarn/cache
 .yarn/install-state.gz
-example/.yarn
+example/.yarn
+example-other/.yarn

README.md

@@ -32,6 +32,7 @@ The `@invertase/react-native-apple-authentication` library will not work if you
 - **Once you're sure you've met the above, please follow our [Initial development environment setup](docs/INITIAL_SETUP.md) guide.**
 
 ## Version 2.0.0 breaking changes
+
 Version 2 added Android support and introduced a few breaking changes with how methods are accessed. Please see the [Migration Guide](docs/MIGRATION.md).
 
 ## Installation
@@ -47,6 +48,7 @@ You will not have to manually link this module as it supports React Native auto-
 ### Expo usage
 
 To enable the Sign In with Apple capability in your app, set the ios.usesAppleSignIn property to true in your project's app config:
+
 ```json
 {
   "expo": {
@@ -70,7 +72,6 @@ Below are simple steps to help you get up and running. The implementation differ
 - If you're authenticating users via `React Native Firebase`; see our [Firebase guide](docs/FIREBASE.md)
 - For Android support, a couple extra steps are required on your Apple developer account. Checkout [our guide](docs/ANDROID_EXTRA.md) for more info.
 
-
 ### iOS
 
 #### 1. Initial set-up
@@ -106,6 +107,7 @@ function App() {
 ```
 
 #### 2. Implement the login process
+
 ```js
 // App.js
 
@@ -166,7 +168,9 @@ So it is recommended when logging out to just clear all data you have from a use
 ### Android
 
 #### 1. Initial set-up
+
 Make sure to correctly configure your Apple developer account to allow for proper authentication on Android. You can checkout [our guide](docs/ANDROID_EXTRA.md) for more info.
+
 ```js
 // App.js
 
@@ -194,6 +198,7 @@ function App() {
 ```
 
 #### 2. Implement the login process
+
 ```js
 // App.js
 
@@ -235,19 +240,19 @@ async function onAppleButtonPress() {
 }
 ```
 
-
 ### MacOS
 
 This library works on MacOS 10.15+ if using in conjunction with [react-native-macos](https://github.com/microsoft/react-native-macos).
 
-
 ### Web (not react-native-web, but that may come as a follow-on, this is pure web at the moment)
 
 #### 1. Initial set-up
+
 - Ensure you follow the android steps above.
 - Install the [web counterpart](https://github.com/A-Tokyo/react-apple-signin-auth) `yarn add react-apple-signin-auth` in your web project.
 
 #### 2. Implement the login process on web
+
 ```js
 import AppleSignin from 'react-apple-signin-auth';
 
@@ -289,6 +294,7 @@ export default MyAppleSigninButton;
 ```
 
 #### 3. Verify serverside
+
 - Send the apple response to your server.
 - See [Serverside Verification](#serverside-verification)
 - Ensure that you pass the clientID as the web service ID, not the native app bundle. Since the project utilizes the service ID for authenticating web and android.
@@ -299,10 +305,13 @@ export default MyAppleSigninButton;
 
 - Based on the [Firebase implementation guidelines](https://firebase.google.com/docs/auth/ios/apple#sign_in_with_apple_and_authenticate_with_firebase) the nonce provided to `appleAuth.performRequest` (iOS) and `appleAuthAndroid.configure` (Android) is automatically SHA256-hashed.
 - To verify the nonce serverside you first need to hash the nonce value, ie:
+
   ```js
   crypto.createHash('sha256').update(nonce).digest('hex');
   ```
+
 - The nonce can then be easily compared serverside for extra security verification, ie:
+
   ```js
   import crypto from 'crypto';
   import appleSigninAuth from 'apple-signin-auth';
@@ -322,28 +331,35 @@ All API documentation is generated by typedoc, and [is available in the `typedoc
 1. Why does `full name` and `email` return `null`?
    - Apple only returns the `full name` and `email` on the first login, it will return `null` on the succeeding login so you need to save those data.
    - Apple APIs [appear to be sensitive to the order you place the scopes in the auth request](https://github.com/invertase/react-native-apple-authentication/issues/293). Place first name *first*, like this:
+
    ```javascript
     const appleAuthRequestResponse = await appleAuth.performRequest({
       requestedOperation: appleAuth.Operation.LOGIN,
       requestedScopes: [appleAuth.Scope.FULL_NAME, appleAuth.Scope.EMAIL],
     });
    ```
+
    - For testing purposes, to be receive these again, go to your device settings; `Settings > Apple ID, iCloud, iTunes & App Store > Password & Security > Apps Using Your Apple ID`, tap on your app and tap `Stop Using Apple ID`. You can now sign-in again and you'll receive the `full name` and `email.
    - Keep in mind you can always access the `email` property server-side by inspecting the `id_token` returned from Apple when verifying the user.
 
 2. How to change button language? (iOS)
     - Native Apple Button component reads language value from CFBundleDevelopmentRegion at Info.plist file. By changing CFBundleDevelopmentRegion value you can change default language for component.
+
     ```XML
     <key>CFBundleDevelopmentRegion</key>
     <string>en</string>
     ```
+
     - For supporting multi language, you can add CFBundleAllowMixedLocalizations key to Info.plist.
+
     ```XML
     <key>CFBundleAllowMixedLocalizations</key>
     <string>true</string>
     ```
+
 3. How do I get the email after the first login?
     - You can get the email address by parsing the JWT token that's returned from any authentication, like so:
+
     ```js
     import { appleAuth } from '@invertase/react-native-apple-authentication';
     import { jwtDecode } from 'jwt-decode';
@@ -362,16 +378,19 @@ All API documentation is generated by typedoc, and [is available in the `typedoc
 The operation couldn’t be completed. (com.apple.AuthenticationServices.AuthorizationError error 1000.)
 ```
 
-###### Case 1:
+###### Case 1
+
 Check that the connection settings have been made correctly.
 The setup can be found here: [Initial Setup](https://github.com/invertase/react-native-apple-authentication/blob/main/docs/INITIAL_SETUP.md)
 
-###### Case 2:
+###### Case 2
+
 If you are using the function `getCredentialStateForUser` on a simulator, this error will always be triggered, for the reason that this function verifies the authenticity of the device.
 
 You must test your code on a real device.
 
-###### Case 3:
+###### Case 3
+
 If you are using a simulator, go to [Manage Apple Account](https://appleid.apple.com/account/manage).
 
 Search for "Devices", select "Simulator" and press "Remove from Account".
@@ -385,21 +404,53 @@ It should work fine.
 ```
 "invalid_client" in Android webview
 ```
+
 Make sure to read the Android [services setup docs](docs/ANDROID_EXTRA.md).
 
-###### Case 1:
+###### Case 1
+
 The `clientId` you passed to `appleAuthAndroid.configure` doesn't match the Service ID you setup in your Apple developer console.
 
-###### Case 2:
+###### Case 2
+
 Your Service ID is attached to the wrong Primary App ID, and therefore uses the incorrect Sign In with Apple key.
 
-###### Case 3:
+###### Case 3
+
 The `redirectUri` you passed to `appleAuthAndroid.configure` doesn't match one of the return URLs or domains/subdomains you added in your Apple developer console. The URL must match *exactly*, and cannot contain a query string.
 
 ## License
 
 - See [LICENSE](/LICENSE)
 
+## Example app construction
+
+This section is intended for people maintaining the module.
+
+`react-native-test-app` is used for the example, to refresh it this is the general path:
+
+- use yarn to update the react-native-test-app package in the package.json
+- move the existing example app(s) to a side space (e.g., example-OLD)
+- create the main test app (for android and ios, which are current)
+- `yarn init-test-app`
+  - name the app `RNAppleAuthExample`
+  - choose ios and android only as the platforms (the others lag in versions)
+  - create the new project in `example` directory
+  - `touch example/yarn.lock` so that yarn will consider it to be separate
+  - copy old example files to new example:
+    - the old app.json (it sets up single-app mode and the apple entitlements)
+    - the old index.*and app.* images and ios/example.entitlements files
+    - remove the App.tsx file
+  - add our package as a dependency '"@invertase/react-native-apple-auth": "portal:../"'
+  - other packages `yarn add react-native-get-random-values base-64 jwt-decode`
+  - add the `path` require and our package dir to watch folders in metro.config.js as
+    it was in the old example
+
+- Now make a second one, but for the platforms which lag behind mainline react-native:
+  - `yarn init-test-app --version 0.79`, name RNAppleAuthExample, example-other
+  - now do the same steps as above
+  - the index.ios.js and app.ios.js files need to be copied to *.macos.*
+
 ---
 
 <p align="center">

example-other/.bundle/config

@@ -0,0 +1,2 @@
+BUNDLE_PATH: ".bundle"
+BUNDLE_FORCE_RUBY_PLATFORM: 1

example-other/.gitignore

@@ -0,0 +1,18 @@
+*.binlog
+*.hprof
+*.xcworkspace/
+*.zip
+.DS_Store
+.bundle/*
+!.bundle/config
+.gradle/
+.idea/
+.vs/
+.xcode.env
+Pods/
+build/
+dist/*
+!dist/.gitignore
+local.properties
+msbuild.binlog
+node_modules/

example-other/.watchmanconfig

@@ -0,0 +1 @@
+{}

example-other/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+# You may use http://rbenv.org/ or https://rvm.io/ to install and use this version
+ruby ">= 2.6.10"
+
+# Exclude problematic versions of cocoapods and activesupport that causes build failures.
+gem 'cocoapods', '>= 1.13', '!= 1.15.0', '!= 1.15.1'
+gem 'activesupport', '>= 6.1.7.5', '!= 7.1.0'
+gem 'xcodeproj', '< 1.26.0'
+gem 'concurrent-ruby', '< 1.3.4'
+
+# Ruby 3.4.0 has removed some libraries from the standard library.
+gem 'bigdecimal'
+gem 'logger'
+gem 'benchmark'
+gem 'mutex_m'