AppFlowy/frontend/appflowy_flutter/lib/user/application/auth/auth_service.dart

import 'package:appflowy_backend/protobuf/flowy-error/errors.pb.dart';
import 'package:appflowy_backend/protobuf/flowy-user/auth.pb.dart';
import 'package:appflowy_backend/protobuf/flowy-user/user_profile.pbserver.dart';
import 'package:dartz/dartz.dart';

class AuthServiceMapKeys {
  const AuthServiceMapKeys._();

  // for supabase auth use only.
  static const String uuid = 'uuid';
  static const String email = 'email';
  static const String deviceId = 'device_id';
}

abstract class AuthService {
  /// Returns [UserProfilePB] if the user is authenticated, otherwise returns [FlowyError].
  Future<Either<FlowyError, UserProfilePB>> signIn({
    required String email,
    required String password,
    AuthTypePB authType,
    Map<String, String> params,
  });

  /// Returns [UserProfilePB] if the user is authenticated, otherwise returns [FlowyError].
  Future<Either<FlowyError, UserProfilePB>> signUp({
    required String name,
    required String email,
    required String password,
    AuthTypePB authType,
    Map<String, String> params,
  });

  ///
  Future<Either<FlowyError, UserProfilePB>> signUpWithOAuth({
    required String platform,
    AuthTypePB authType,
    Map<String, String> params,
  });

  /// Returns a default [UserProfilePB]
  Future<Either<FlowyError, UserProfilePB>> signUpAsGuest({
    AuthTypePB authType,
    Map<String, String> params,
  });

  Future<Either<FlowyError, UserProfilePB>> signInWithMagicLink({
    required String email,
    Map<String, String> params,
  });

  ///
  Future<void> signOut();

  /// Returns [UserProfilePB] if the user has sign in, otherwise returns null.
  Future<Either<FlowyError, UserProfilePB>> getUser();
}