twogate / cordova-plugin-sign-in-with-apple

A native-implemented plugin of Sign in with Apple // Thanks to your contribution! // Cordova>=8 iOS>=13

cordova-plugin-sign-in-with-apple

see also: Official Documentation

This plugin only supports iOS >= 13.

Installation

Plugin installation

cordova plugin add cordova-plugin-sign-in-with-apple

or

cordova plugin add https://github.com/twogate/cordova-plugin-sign-in-with-apple.git

Usage

You should enable Sign in with Apple capability in Xcode. (project file -> Capabilities Tab -> Turn on "SignIn With Apple")

window.cordova.plugins.SignInWithApple.signin(
  { requestedScopes: [0, 1] },
  function(succ){
    console.log(succ)
    alert(JSON.stringify(succ))
  },
  function(err){
    console.error(err)
    console.log(JSON.stringify(err))
  }
)

Options Example

• requestedScopes is an array of requested scopes.
  • 0: FullName
  • 1: Email

Success Callback Data Example

Based on ASAuthorizationAppleIDCredential.

• authorizationCode: string "<short-lived token used by your app for proof of authorization when interacting with the app’s server counterpart>"
• email: string "[email protected]"
• fullName: object, based on NSPersonNameComponents
  • familyName: string "Doe"
  • givenName: string "Jane"
  • namePrefix: string ""
  • nameSuffix: string ""
  • nickname: string ""
  • phoneticRepresentation: object, based on NSPersonNameComponents
    • familyName?: string
    • givenName?: string
    • namePrefix?: string
    • nameSuffix?: string
    • nickname?: string
• identityToken: string "<JSON Web Token (JWT) that securely communicates information about the user to your app>"
• state: string "<arbitrary string that your app provided to the request that generated the credential>"
• user: string "<identifier associated with the authenticated user>"

Failure Callback Data Example

• error: string "ASAUTHORIZATION_ERROR"
• code: string 1001
• localizedDescription: string "The operation couldn’t be completed. (com.apple.AuthenticationServices.AuthorizationError error 1001.)"
• localizedFailureReason: string ""

Error Type

• 1000 ASAuthorizationErrorUnknown
  • authorization attempt failed for an unknown reason
• 1001 ASAuthorizationErrorCanceled
  • user cancelled
• 1002 ASAuthorizationErrorInvalidResponse
  • authorization request received an invalid response.
• 1003 ASAuthorizationErrorNotHandled
  • user cancelled

cordova-plugin-sign-in-with-apple's Issues

ionic 5 ios build error

The following build commands failed:
CompileC /var/root/Library/Developer/Xcode/DerivedData/BBM-hbuovfudpynipvdknojfjjeuyrjr/Build/Intermediates.noindex/BBM.build/Release-iphonesimulator/BBM.build/Objects-normal/x86_64/SignInWithApple-17d9bcb48ed83d1ba769b5561ca25b9192ebbf1b16b380e5c6f8ba5f04145324.o /Users/macbookpro/Desktop/bbm-2/platforms/ios/BBM/Plugins/cordova-plugin-sign-in-with-apple/SignInWithApple.m normal x86_64 objective-c com.apple.compilers.llvm.clang.1_0.compiler
(1 failure)
xcodebuild: Command failed with exit code 65

Invalid provider for the NgModule

I have imported SignInWithApple in app.module and it gives me error Invalid provider for the NgModule 'AppModule' - only instances of Provider and Type are allowed, got: [[object Object]]

The user email is shared only once

Hi, Is it normal that the user email is showed only on the first sign up?
...on the following logins it will be just and empty string.
Thanks

CordovaError: Promise rejected with non-error: 'Error code 65 for command: xcodebuild

Hi Guys,

recently we add this plugin with the following configuration:

• cordova 9 or 8 ( tried both )
• cordova-ios: 4.5.4

We satisfied all plugin dependencies. But per each build, we continue to receive the following extended error:

CordovaError: Promise rejected with non-error: 'Error code 65 for command: xcodebuild with args: -xcconfig,/Users/username/Documents/enterprise/mobile/projectSubFolder-wrapper/projectSubFolder/jera.goweb.mobile.projectSubFolder/COMPANY_projectSubFolder_APP/projectSubFolder/appbuilds/compiled/DEVELOPMENT/GOprojectSubFolder.50.50.50/ios/com.project.name.custom.ch20/platforms/ios/cordova/build-debug.xcconfig,-workspace,com.project.name.custom.ch20.xcworkspace,-scheme,com.project.name.custom.ch20,-configuration,Debug,-destination,generic/platform=iOS,-archivePath,com.project.name.custom.ch20.xcarchive,archive,CONFIGURATION_BUILD_DIR=/Users/username/Documents/enterprise/mobile/projectSubFolder-wrapper/projectSubFolder/jera.goweb.mobile.projectSubFolder/COMPANY_projectSubFolder_APP/projectSubFolder/appbuilds/compiled/DEVELOPMENT/GOprojectSubFolder.50.50.50/ios/com.project.name.custom.ch20/platforms/ios/build/device,SHARED_PRECOMPS_DIR=/Users/username/Documents/enterprise/mobile/projectSubFolder-wrapper/projectSubFolder/jera.goweb.mobile.projectSubFolder/COMPANY_projectSubFolder_APP/projectSubFolder/appbuilds/compiled/DEVELOPMENT/GOprojectSubFolder.50.50.50/ios/com.project.name.custom.ch20/platforms/ios/build/sharedpch,-UseModernBuildSystem=0'

---

[exec] ** ARCHIVE FAILED **
[exec]
[exec]
[exec] The following build commands failed:
[exec] CompileC /Users/username/Library/Developer/Xcode/DerivedData/com.project.name.custom.ch20-aqojepblusoqpdhfxyksgwhjbgzt/Build/Intermediates.noindex/ArchiveIntermediates/com.project.name.custom.ch20/IntermediateBuildFilesPath/com.project.name.custom.ch20.build/Debug-iphoneos/com.project.name.custom.ch20.build/Objects-normal/armv7/SignInWithApple-509AF0B801A9C281.o com.project.name.custom.ch20/Plugins/cordova-plugin-sign-in-with-apple/SignInWithApple.m normal armv7 objective-c com.apple.compilers.llvm.clang.1_0.compiler

Has someone the same problem or some suggestions about the environment to use?

EDIT:
If we comment on the plugin inside config.xml, build is successful.

Many thanks

Simon

Need iOS 12 support

iOS 13 is available on iPhone 6s or later (including iPhone SE). That means both iPhone 5S and iPhone 6 don't make the list and are forever stuck with iOS 12.4.1.

iPhone 5S and iPhone 6 devices still exist in the market and lot of users are using it hence we cannot neglect these devices.

IOS 14 login Issue

Hi

I installed the plugin in my simulator IOS 14.2, but appear that while it try to login is stuck with password.

I have checked it in iOS 13.3 and work fine.

fullName Object not full

When selecting to sign in with the email, the object of fullName is empty as well as email, while everything else is full. Using Cordova 5.1.1, IOS 13.4

Double popup on auth

After clicking on the auto-sign icon, the Safari browser opens, and 2 pop-ups for entering a password (or FaceID) pop up there. First opens the correct one, on top of it opens with the application name null. When you enter a password in each of them, the browser remains open. You have to manually go to the application. As a result, authorization error {" code ":" 1000 "," localizedFailureReason ":" "," error ":" ASAUTHORIZATION_ERROR "," localizedDescription ":" The operation couldn't be completed. (Com.apple.AuthenticationServices.AuthorizationError error 1000.) "}
When entering a password only in the required popup, the error is the same

Can you document the result of the signin operation?

It would be great to know what sort of things to expect back in the result object on a successful signin.

Native popup doesn't show up with Ionic 3

Working on ionic 3 project.

cordova -v
9.0.0 (cordova-lib@9.0.1)

First there was an error about not recognizing your code. Same as here.
After changing your code like

export declare class ASAuthorizationAppleIDRequest {
    // static readonly ASAuthorizationScopeFullName = 0;
    // static readonly ASAuthorizationScopeEmail = 1;
    requestedScopes?: number[];
}

and give requestedScopes with numbers like

...signin({requestedScopes: [0, 1]})

that error wasn't there anymore. But also nothing happening. Can not get in your plugins scope. Therefore popup doesnt show up.

Class not found error when attempting login with apple id on android

Hello,

I am using this plugin for a Ionic 3 project and i followed the instructions provided in the readme and everything is working great on IOS.

When attempting to use it on Android, the error callback is called for the signin method with this string error: "Class not found".

Does this plugin only support IOS? If yes, are there any plans to expand to suporting Android as well?
If it also suports Android already, are there any additional steps needed to be taken in order for it to work?

Thanks for your work on the plugin!

NullInjectorError: No provider for Sign in with Apple!

I am facing a problem in Apple login:

NullInjectorError: No provider for Sign in with Apple!

Could someone please help.

Cannot pass nonce and state in signin options

The signin method is defined as signin(options?: ASAuthorizationAppleIDRequest): Promise<AppleSignInResponse>;

The documentation of ASAuthorizationAppleIDRequest states that a nonce and a state string property can be passed. However the code at SignInWithApple.m does not seem to pass the two properties to the native method.

It would be nice if nonce and state could be passed. Especially supporting nonce would be great since that is included in the JWT.

unable to use in PGB

i get an error on build.
no type or protocol named 'ASAuthorizationScope

SignInWithApple.m:14:12: error: no type or protocol named 'ASAuthorizationScope'

• (NSArray *)convertScopes: (NSArray<NSNumber *> *)scopes
  ^
  /project/MyClub/Plugins/cordova-plugin-sign-in-with-apple/SignInWithApple.m:27:4: error: expected a type
• (ASAuthorizationScope)convertScope: (NSNumber *)scope

can anyone help

Result fullName empty

I am using the simple example...

window.cordova.plugins.SignInWithApple.signin(
{ requestedScopes: [0, 1] },
function(succ){
console.log(succ)
alert(JSON.stringify(succ))
},
function(err){
console.error(err)
console.log(JSON.stringify(err))
}
)

The code above give me just the "authorizationCode" , "identityToken" and "user", but I need the "fullName" and this is empty.

The results of my console log
""

info device
Iphone 11 pro - iOS 15.1

version Cordova 10.0.0
version plugin 0.1.2

Why is the "fullName" empty?
Could anybody help me?

Invalid signature

Hi,

When I use the plugin I correctly get the user id and id token etc. However, when I parse the token here: https://jwt.io, I always get an 'Invalid signature' error, although the claims in the JWT are correct. Any idea what could be wrong?

Support for account deletion.

Starting June 30, 2022, apps submitted to the App Store that support account creation must also let users initiate deletion of their account within the app. ref https://developer.apple.com/support/offering-account-deletion-in-your-app

Incorrect version listed by 'cordova plugin ls'

When requesting a list of installed plugins the wrong version of the plugin is shown.
The version attribute of plugin in plugin.xml should contain the version of the plugin.

passing scope option to the plugin

SignIn after manual revocation does not use scopes

I am having an issue (testing with iOS 16 on a Simulator, I don't know about other versions).

• I do a SignIn with email & name scopes [0, 1] and ask to use anonymous email.
• I validate the SignIn in the server side with https://appleid.apple.com/auth/token
• Then I sign out from my App and do a manual revocation: Settings->Apple Id Profile->Password & Security->Apps Using Apple ID->Stop using Apple ID
• Then I try to SignIn again using the same procedure (scopes [0, 1]) but this second time the dialog only asks about starting a new session and does not show options about Name or Email.
• In the success callback I don't get email, name or anything else.

I'm doing manual token revocation as a first step before implementing programatic revocations (https://appleid.apple.com/auth/revoke). I'm not sure yet whether programatic revocations may fix the issue. I don't think it will but I will give it a try.

After a few hours something is reset and then it works again. So this may be some problem with Apple?

I've read about similar problems here: capacitor-community/apple-sign-in#44 and here invertase/react-native-apple-authentication#282 (comment)

Cannot get email & name while scopes requested on IOS14

it works fine previously where users get to give permission to plugin for email and fullname,
this.signInWithApple.signin({ requestedScopes: [ ASAuthorizationAppleIDRequest.ASAuthorizationScopeFullName, ASAuthorizationAppleIDRequest.ASAuthorizationScopeEmail ] })
but now, when sign in using apple, the request permission page is gone, and it just sign in using a masked email

Please, close this issue.

Please, close this issue.

Cordova 8.1.2

Is there a way to install or modify this plugin under 8.1.2?
Cordova 9 has a lot of bugs and I can't work with it yet.

Authorization failed

I have new issue i haven't before. When I try to "sign in with apple" i catch error [core] Authorization failed: Error Domain=AKAuthenticationError Code=-7034 "(null)" UserInfo={AKClientBundleID=xxxxx}. Before all worked great with the same settings (capability "sign in with apple" included). I test this issue on real and simulator devices. I can't find anything about "7034" error code.

Infinite Loading with Ios Emulator

Hi, I don't have a physical ios device so I always use emulator with xcode to debug my code.
I've turn on "SignIn With Apple" inside capabilities in Xcode and I write the demo code in my app:

window.cordova.plugins.SignInWithApple.signin(
  { requestedScopes: [0, 1] },
  function(succ){
    console.log(succ)
    alert(JSON.stringify(succ))
  },
  function(err){
    console.error(err)
    console.log(JSON.stringify(err))
  }
)

If I tried to login with Apple Account the first two steps works good, but the third one after I insert the password remain in infinite loop loading. I don't find anything in the documentation. What could be the problem?

Apple login passcode screen UI Issue

I have integrated apple login, it was working fine till last week. Now I got error design of passcode in iphone XR. The passcode design is not visible, so we are not able to enter passcode. Kindly refer below screen. Anyone help me how to resolve this issue?

Huge number of errors while builing

After I add the plugin and run in emulator, I get all these errors and the build fails.

utilities is not defined in after_prepare

Hi,
there is an error during cordova compilation due a reference error in after_prepare.js

   While preparing Cordova project for platform iOS:
   ReferenceError: utilities is not defined
   at module.exports
/XXXX/cordova-build/plugins/cordova-plugin-sign-in-with-apple/scripts/after_prepare.js:12:42

It seems that utilities is undefined.

Login don't work on simulator iOS14

Hello! I've noticed that my app login stopped working since the iOS14 update on every simulator on my mac.
I put my password and it just (looks like) loading but nothing happens. On an physical iPhone it works flawlessly.

I've tried removing both account and device in the dev panel and double checked the permssions. Another think I've noticed is if I insert a wrong password I get a classic error so the server is doing something.
Could it be something apple side?

Apple rejects app

Hello Apple just rejected the app because I ask the user after login to enter date of birth and gender. I need these data in the very first step. Is there any way to pick gender and d.o.b. from apple login? the plugin doesn't seem to have thia capability. Thank you

login success? but no info, no email or user name, just token

Installed the plugin with no errors and configured the backend, certificates etc. After sign in with Apple, I am getting an object with these properties: email, state, identityToken, fullName, user. However the email, state and fullName properties are empty. Only an identity token is provided.

Shouldn't there be some email address - whether one from apple or the user's , and some name?

email: ""
fullName: {nickname: "", phoneticRepresentation: {}, familyName: "", namePrefix: "", givenName: "", …}
identityToken: "eyJraWQiOiJBSURPUEsxIiwiYWxnIjoiUlMyNTYifQ.eyJpc3MiOiJodHRwczovL2FwcGxlaWQuYXBwbGUuY29tIiwiYXVkIjoiY29tLnBldHRpbmdjbHViLmFwcCIsImV4cCI6MTU3M…"

Plugin not loading on Phonegap Build

I have added the plugin to my config.xml

<plugin name="cordova-plugin-sign-in-with-apple" source="npm"/>

and I'm using PhoneGap version cli-9.0.0

<preference name="phonegap-version" value="cli-9.0.0" />

Whenever I call the plugin code window.cordova.plugins.SignInWithApple.signin(...) I get Uncaught TypeError: Cannot read property 'signin' of undefined

I tried to delete the project and recreating it on Phonegap build, and I get the same error
Note: I'm debugging it on iPhone 13.x.x

Make the plugin automatically add the capability

"You should enable Sign in with Apple capability in Xcode"

No, I should expect a fully configured product when I run cordova build --release. Why would you make people go into Xcode every time they want a build?

I've spent hours figuring out why sign in didn't work on TestFlight, and am logging this issue in great frustration.

Requested scope doesn't seem to do anything

I'm testing an app on iOS 13, and I've set the requested scope to [0, 1]. It doesn't seem to do anything. Apple sign in does not offer an option to provide the email, and the email is therefore never obtained.

Stuck on verify password modal

I have type the correct password but it still loading when i press continue. Then, i've got nothing, the screen stuck on verify password screen with continue button enabled. Please help me 😭

Different identityToken for every login

Each time you logout - then login using same apple account, it returns different identityToken, which is a very big issue because it resulted in multiple creation of accounts in the backend

TypeError: Object(...) is not a function at SignInWithAppleOriginal.signin

When i try to log in with apple, i get that error.
My code:

async loginWithApple(): Promise<void> {
    
    try {
      const appleCredential: AppleSignInResponse = await SignInWithApple.signin({
        requestedScopes: [
          ASAuthorizationAppleIDRequest.ASAuthorizationScopeFullName,
          ASAuthorizationAppleIDRequest.ASAuthorizationScopeEmail
        ]
      });

      console.log({ appleCredential });

      alert(JSON.stringify(appleCredential))


    } catch (error) {
      console.log(error);
    }
    
  }

Authorization failed - Error 1000

When I try to use the login I get an error 1000. I have configured the sign in with apple capability, do you have any idea that another action could generate this problem?

Support iOS >=12.0

Is possible to support iOS 12.0 with this plugin?