email/password provider - register email

CHANGELOG.md

@@ -17,6 +17,7 @@ x.x.x Release notes (yyyy-MM-dd)
 * Support should realm compact on open callback `Configuration.shouldCompactCallback` as option when configuring a Realm to determine if it should be compacted before being returned.  ([#466](https://github.com/realm/realm-dart/pull/466/))
 * Support ObjectId type. ([#468](https://github.com/realm/realm-dart/pull/468))
 * Support Uuid type. ([#470](https://github.com/realm/realm-dart/pull/470))
+* Support user registration with EmailPassword authentication provider. ([#452](https://github.com/realm/realm-dart/pull/452))
 
 ### Fixed
 * Fixed an issue that would result in the wrong transaction being rolled back if you start a write transaction inside a write transaction. ([#442](https://github.com/realm/realm-dart/issues/442))

flutter/realm_flutter/tests/test_driver/realm_test.dart

@@ -13,6 +13,7 @@ import '../test/list_test.dart' as list_tests;
 import '../test/results_test.dart' as results_tests;
 import '../test/credentials_test.dart' as credentials_tests;
 import '../test/application_test.dart' as application_tests;
+import '../test/email_password_provider_test.dart' as email_password_provider_test;
 
 Future<String> main(List<String> args) async {
   final Completer<String> completer = Completer<String>();
@@ -25,6 +26,7 @@ Future<String> main(List<String> args) async {
   await results_tests.main(args);
   await credentials_tests.main(args);
   await application_tests.main(args);
+  await email_password_provider_test.main(args);
 
   tearDown(() {
     if (Invoker.current?.liveTest.state.result == test_api.Result.error || Invoker.current?.liveTest.state.result == test_api.Result.failure) {

lib/src/application.dart

@@ -22,6 +22,7 @@ import 'native/realm_core.dart';
 import 'configuration.dart';
 
 /// Specify if and how to persists user objects.
+/// {@category Application}
 enum MetadataPersistenceMode {
   /// Persist [User] objects, but do not encrypt them.
   plaintext,
@@ -36,6 +37,7 @@ enum MetadataPersistenceMode {
 @immutable
 
 /// A class exposing configuration options for an [Application]
+/// {@category Application}
 class ApplicationConfiguration {
   /// The [appId] is the unique id that identifies the Realm application.
   final String appId;
@@ -108,6 +110,7 @@ class ApplicationConfiguration {
 /// The [Application]] can be used to
 /// * Register uses and perform various user-related operations through authentication providers
 /// * Synchronize data between the local device and a remote Realm App with Synchronized Realms
+/// {@category Application}
 class Application {
   final AppHandle _handle;
   final ApplicationConfiguration configuration;

lib/src/credentials.dart

@@ -15,16 +15,18 @@
 // limitations under the License.
 //
 ////////////////////////////////////////////////////////////////////////////////
+
 import 'native/realm_core.dart';
+import 'application.dart';
 
 /// An enum containing all authentication providers. These have to be enabled manually for the application before they can be used.
 /// [Authentication Providers Docs](https://docs.mongodb.com/realm/authentication/providers/)
 /// {@category Application}
-enum AuthProvider {
-  /// Mechanism for authenticating without credentials.
+enum AuthProviderType {
+  /// For authenticating without credentials.
   anonymous,
 
-  /// Mechanism for authenticating with an email and a password.
+  /// For authenticating with an email and a password.
   emailPassword,
 }
 
@@ -33,24 +35,44 @@ enum AuthProvider {
 class Credentials {
   late final RealmAppCredentialsHandle _handle;
 
-  final AuthProvider provider;
+  final AuthProviderType providerType;
 
   /// Returns a [Credentials] object that can be used to authenticate an anonymous user.
   /// [Anonymous Authentication Docs](https://docs.mongodb.com/realm/authentication/anonymous)
   Credentials.anonymous()
       : _handle = realmCore.createAppCredentialsAnonymous(),
-        provider = AuthProvider.anonymous;
+        providerType = AuthProviderType.anonymous;
 
   /// Returns a [Credentials] object that can be used to authenticate a user with their email and password.
   /// A user can login with email and password only after they have registered their account and verified their
   /// email.
   /// [Email/Password Authentication Docs](https://docs.mongodb.com/realm/authentication/email-password)
   Credentials.emailPassword(String email, String password)
       : _handle = realmCore.createAppCredentialsEmailPassword(email, password),
-        provider = AuthProvider.emailPassword;
+        providerType = AuthProviderType.emailPassword;
 }
 
 /// @nodoc
 extension CredentialsInternal on Credentials {
   RealmAppCredentialsHandle get handle => _handle;
 }
+
+/// A class, encapsulating functionality for users, logged in with [Credentials.emailPassword()].
+/// It is always scoped to a particular app.
+/// {@category Application}
+class EmailPasswordAuthProvider {
+  final Application application;
+
+  /// Create a new EmailPasswordAuthProvider for the [application]
+  EmailPasswordAuthProvider(this.application);
+
+  /// Registers a new user with the given email and password.
+  /// The [email] to register with. This will be the user's username and, if user confirmation is enabled, this will be the address for
+  /// the confirmation email.
+  /// The [password] to associate with the email. The password must be between 6 and 128 characters long.
+  ///
+  /// Successful completion indicates that the user has been created on the server and can now be logged in with [Credentials.emailPassword()].
+  Future<void> registerUser(String email, String password) async {
+    return realmCore.appEmailPasswordRegisterUser(application, email, password);
+  }
+}

lib/src/native/realm_core.dart

@@ -850,6 +850,36 @@ class _RealmCore {
     final realm_app = _realmLib.invokeGetPointer(() => _realmLib.realm_app_get(appConfig._pointer, syncClientConfig._pointer));
     return AppHandle._(realm_app);
   }
+
+  static void void_completion_callback(Pointer<Void> userdata, Pointer<realm_app_error> error) {
+    final Completer<void>? completer = userdata.toObject();
+    if (completer == null) {
+      return;
+    }
+
+    if (error != nullptr) {
+      final message = error.ref.message.cast<Utf8>().toDartString();
+      completer.completeError(RealmException(message));
+      return;
+    }
+
+    completer.complete();
+  }
+
+  Future<void> appEmailPasswordRegisterUser(Application application, String email, String password) {
+    final completer = Completer<void>();
+    using((arena) {
+      _realmLib.invokeGetBool(() => _realmLib.realm_app_email_password_provider_client_register_email(
+            application.handle._pointer,
+            email.toUtf8Ptr(arena),
+            password.toRealmString(arena).ref,
+            Pointer.fromFunction(void_completion_callback),
+            completer.toGCHandle(),
+            nullptr,
+          ));
+    });
+    return completer.future;
+  }
 }
 
 class LastError {

lib/src/realm_class.dart

@@ -50,7 +50,7 @@ export 'list.dart' show RealmList, RealmListOfObject, RealmListChanges;
 export 'realm_object.dart' show RealmEntity, RealmException, RealmObject, RealmObjectChanges;
 export 'realm_property.dart';
 export 'results.dart' show RealmResults, RealmResultsChanges;
-export 'credentials.dart' show Credentials, AuthProvider;
+export 'credentials.dart' show Credentials, AuthProvider, EmailPasswordAuthProvider;
 
 /// A [Realm] instance represents a `Realm` database.
 ///

test/email_password_provider_test.dart

@@ -0,0 +1,28 @@
+////////////////////////////////////////////////////////////////////////////////
+//
+// Copyright 2022 Realm Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+////////////////////////////////////////////////////////////////////////////////
+
+import 'dart:io';
+import '../lib/realm.dart';
+import 'test.dart';
+
+Future<void> main([List<String>? args]) async {
+  print("Current PID $pid");
+
+  await setupTests(args);
+
+}