fix: add onboarding screen to npt flutter

packages/dart/npt_flutter/lib/app.dart

@@ -32,6 +32,8 @@ class App extends StatelessWidget {
       ],
       child: MultiBlocProvider(
           providers: [
+            // TODO this should be called LocalSettingsCubit and move
+            // Localization from the SettingsCubit to this
             BlocProvider<EnableLoggingCubit>(
               create: (_) => EnableLoggingCubit(),
             ),
@@ -42,7 +44,7 @@ class App extends StatelessWidget {
               create: (_) => LogsCubit(),
             ),
 
-            /// A cubit which manages the onboarding status
+            // A bloc which manages the atDirectory state
             BlocProvider<OnboardingCubit>(
               create: (_) => OnboardingCubit(),
             ),

packages/dart/npt_flutter/lib/constants.dart

@@ -1,5 +1,6 @@
+import 'package:flutter/material.dart';
+
 class Constants {
-  static const rootDomain = 'root.atsign.org';
   static String? get namespace => 'noports';
   // TODO: issue & secure API key properly
   static String? get appAPIKey => 'asdf';
@@ -15,5 +16,10 @@ class Constants {
     "@rv_ap": "Singapore",
   };
 
+  static Map<String, String> getRootDomains(BuildContext context) {
+    // TODO localize right hand side of map
+    return {'root.atsign.org': 'Default (Prod)', 'vip.ve.atsign.zone': 'Demo (VE)'};
+  }
+
   static const languages = ['English', 'Spanish', 'Br portuguese', 'Mandarin', 'Cantonese'];
 }

packages/dart/npt_flutter/lib/features/favorite/bloc/favorite_bloc.dart

@@ -15,6 +15,8 @@ class FavoriteBloc extends LoggingBloc<FavoriteEvent, FavoritesState> {
     on<FavoriteRemoveEvent>(_onRemove);
   }
 
+  void clearAll() => emit(const FavoritesInitial());
+
   FutureOr<void> _onLoad(
       FavoriteLoadEvent event, Emitter<FavoritesState> emit) async {
     emit(const FavoritesLoading());

packages/dart/npt_flutter/lib/features/onboarding/cubit/onboarding_cubit.dart

@@ -1,10 +1,49 @@
-import 'package:npt_flutter/features/logging/logging.dart';
-
-part 'onboarding_state.dart';
+import 'package:npt_flutter/features/logging/models/logging_bloc.dart';
+import 'package:npt_flutter/features/onboarding/util/atsign_manager.dart';
 
 class OnboardingCubit extends LoggingCubit<OnboardingState> {
-  OnboardingCubit() : super(const OnboardingInitial());
+  OnboardingCubit()
+      : super(const OnboardingState(atSign: '', status: OnboardingStatus.offboarded, rootDomain: 'root.atsign.org'));
+
+  void setRootDomain(String rootDomain) =>
+      emit(OnboardingState(atSign: state.atSign, status: state.status, rootDomain: rootDomain));
+  String getRootDomain() => (state.rootDomain);
+
+  void setAtSign(String atSign) =>
+      emit(OnboardingState(atSign: atSign, status: state.status, rootDomain: state.rootDomain));
+  String getAtSign() => (state.atSign);
+
+  void setStatus(OnboardingStatus status) =>
+      emit(OnboardingState(atSign: state.atSign, status: status, rootDomain: state.rootDomain));
+  OnboardingStatus getStatus() => (state.status);
+
+  /// If state is passed, all other arguments are ignored
+  /// If individual arguments (atsign, rootDomain, status) are passed
+  /// then they will override the value of the current state
+  /// keeping unspecified values the same
+  void setState({
+    String? atSign,
+    OnboardingStatus? status,
+    String? rootDomain,
+  }) =>
+      emit(OnboardingState(
+        atSign: atSign ?? state.atSign,
+        status: status ?? state.status,
+        rootDomain: rootDomain ?? state.rootDomain,
+      ));
+}
+
+enum OnboardingStatus { onboarded, offboarded }
+
+class OnboardingState extends AtsignInformation {
+  final OnboardingStatus status;
+  const OnboardingState({required this.status, required super.atSign, required super.rootDomain});
+
+  @override
+  List<Object?> get props => [atSign, status, rootDomain];
 
-  void onboard(String atSign) => emit(Onboarded(atSign));
-  void offboard() => emit(const OnboardingInitial());
+  @override
+  String toString() {
+    return 'OnboardingState($atSign, ${status.name}, $rootDomain)';
+  }
 }

packages/dart/npt_flutter/lib/features/onboarding/util/atsign_manager.dart

@@ -0,0 +1,170 @@
+import 'dart:convert';
+import 'dart:io';
+
+import 'package:at_onboarding_flutter/at_onboarding_flutter.dart';
+import 'package:npt_flutter/app.dart';
+import 'package:path/path.dart' as p;
+import 'package:path_provider/path_provider.dart';
+
+class AtsignInformation extends Loggable {
+  final String atSign;
+  final String rootDomain;
+
+  const AtsignInformation({required this.atSign, required this.rootDomain});
+
+  Map<String, String> toJson() => {
+        "atsign": atSign,
+        "root-domain": rootDomain,
+      };
+
+  static AtsignInformation? fromJson(Map json) {
+    if (json["atsign"] is! String || json["root-domain"] is! String) {
+      return null;
+    }
+    return AtsignInformation(
+      atSign: json["atsign"],
+      rootDomain: json["root-domain"],
+    );
+  }
+
+  @override
+  List<Object?> get props => [atSign, rootDomain];
+
+  @override
+  String toString() {
+    return 'AtsignInformation($atSign, $rootDomain)';
+  }
+}
+
+// This will return a map which looks like:
+//
+// {
+//   "@alice": AtsignInformation{ atSign: "@alice", rootDomain: "root.atsign.org" },
+//   "@bob": AtsignInformation{ atSign: "@alice", rootDomain: "vip.ve.atsign.zone" },
+// }
+//
+// Note: AtsignInformation is a class, so usage will look like
+//
+// var atSign = "@alice";
+// var atSignInfo = await getAtsignEntries();
+// var rootDomain = atSignInfo[atSign].rootDomain;
+//
+// Now you have the rootDomain for the existing atSign and can use it to onboard
+// correctly
+
+Future<Map<String, AtsignInformation>> getAtsignEntries() async {
+  var keychainAtSigns = await KeychainUtil.getAtsignList() ?? [];
+  var atSignInfo = <AtsignInformation>[];
+  try {
+    atSignInfo = await _getAtsignInformationFromFile();
+  } catch (e) {
+    App.log(
+      "Failed get Atsign Information, ignoring invalid file: ${e.toString()}".loggable,
+    );
+    return {};
+  }
+  var atSignMap = <String, AtsignInformation>{};
+  for (var item in atSignInfo) {
+    if (keychainAtSigns.contains(item.atSign)) {
+      atSignMap[item.atSign] = item;
+    }
+  }
+  return atSignMap;
+}
+
+// This class will allow you to store atSign information
+// you need to call this after onboarding a NEW atSign
+Future<bool> saveAtsignInformation(AtsignInformation info) async {
+  var f = await _getAtsignInformationFile();
+  final List<AtsignInformation> atSignInfo;
+  try {
+    atSignInfo = await _getAtsignInformationFromFile(f);
+  } catch (e) {
+    // We only end up here if we failed to create, get, or read the file
+    // we don't want to overwrite it in that scenario, so return false
+    //
+    // We won't end up here if it was a json parse error, such as invalid
+    // json, we do want to overwrite that so that the app can recover as best
+    // as possible
+    return false;
+  }
+  if (f == null) return false;
+
+  // Replace the existing entry with the new one if it exists
+  bool found = false;
+  for (int i = 0; i < atSignInfo.length; i++) {
+    if (atSignInfo[i].atSign == info.atSign) {
+      found = true;
+      atSignInfo[i] = info;
+    }
+  }
+  // Otherwise add it as a new entry
+  if (!found) {
+    atSignInfo.add(info);
+  }
+  try {
+    f.writeAsString(
+      jsonEncode(atSignInfo.map((e) => e.toJson()).toList()),
+      mode: FileMode.writeOnly,
+      flush: true,
+    );
+    return true;
+  } catch (e) {
+    App.log(
+      "Failed to write Atsign Information to file: ${e.toString()}".loggable,
+    );
+    return false;
+  }
+}
+
+// Does not throw, returns null if it can't get / create the file
+Future<File?> _getAtsignInformationFile() async {
+  final Directory dir;
+  try {
+    dir = await getApplicationSupportDirectory();
+    dir.create(recursive: true); // This checks if it exists internally
+  } catch (e) {
+    App.log(
+      "Failed to Get Application Support Directory: ${e.toString()}".loggable,
+    );
+    return null;
+  }
+  final f = File(p.join(dir.path, "atsign_information.json"));
+  try {
+    if (!await f.exists()) {
+      f.create(recursive: true);
+    }
+    return f;
+  } catch (e) {
+    App.log(
+      "Failed to Get Atsign Information File : ${e.toString()}".loggable,
+    );
+    return null;
+  }
+}
+
+Future<List<AtsignInformation>> _getAtsignInformationFromFile([File? f]) async {
+  f ??= await _getAtsignInformationFile();
+  if (f == null) throw Exception("Failed to get the Atsign Information File");
+  try {
+    var contents = await f.readAsString();
+    if (contents.trim().isEmpty) return [];
+    var json = jsonDecode(contents);
+    if (json is! Iterable) {
+      return []; // The file format is invalid so return as a non-error and we will overwrite it
+    }
+    var res = <AtsignInformation>[];
+    for (var item in json) {
+      if (item is! Map) continue;
+      var info = AtsignInformation.fromJson(item);
+      if (info == null) continue;
+      res.add(info);
+    }
+    return res;
+  } catch (e) {
+    App.log(
+      "Failed to Parse Atsign Information File : ${e.toString()}".loggable,
+    );
+    rethrow;
+  }
+}

packages/dart/npt_flutter/lib/features/onboarding/util/post_onboard.dart

@@ -2,16 +2,14 @@ import 'package:flutter_bloc/flutter_bloc.dart';
 import 'package:npt_flutter/app.dart';
 import 'package:npt_flutter/features/features.dart';
 
-Future<void> postOnboard(String atSign) async {
-  App.navState.currentContext?.read<OnboardingCubit>().onboard(atSign);
+Future<void> postOnboard(String atSign, String rootDomain) async {
+  App.navState.currentContext?.read<OnboardingCubit>().setState(
+        atSign: atSign,
+        rootDomain: rootDomain,
+        status: OnboardingStatus.onboarded,
+      );
   // Start loading application data in the background as soon as we have an atClient
-  App.navState.currentContext
-      ?.read<ProfileListBloc>()
-      .add(const ProfileListLoadEvent());
-  App.navState.currentContext
-      ?.read<SettingsBloc>()
-      .add(const SettingsLoadEvent());
-  App.navState.currentContext
-      ?.read<FavoriteBloc>()
-      .add(const FavoriteLoadEvent());
+  App.navState.currentContext?.read<ProfileListBloc>().add(const ProfileListLoadEvent());
+  App.navState.currentContext?.read<SettingsBloc>().add(const SettingsLoadEvent());
+  App.navState.currentContext?.read<FavoriteBloc>().add(const FavoriteLoadEvent());
 }

packages/dart/npt_flutter/lib/features/onboarding/util/pre_offboard.dart

@@ -0,0 +1,21 @@
+import 'package:flutter_bloc/flutter_bloc.dart';
+import 'package:npt_flutter/app.dart';
+import 'package:npt_flutter/features/features.dart';
+
+// Hand this method the atSign you wish to offboard
+// Returns: a boolean, true = success, false = failed
+Future<bool> preSignout() async {
+  App.log("Resetting all application state before signout".loggable);
+  // We need to do the following before "signing out"
+  // - Wipe all application state
+  App.navState.currentContext?.read<ProfilesRunningCubit>().stopAllAndClear();
+  App.navState.currentContext?.read<ProfileCacheCubit>().clear();
+  App.navState.currentContext?.read<ProfilesSelectedCubit>().deselectAll();
+  App.navState.currentContext?.read<FavoriteBloc>().clearAll();
+  App.navState.currentContext?.read<ProfileListBloc>().clearAll();
+  App.navState.currentContext?.read<SettingsBloc>().clear();
+  App.navState.currentContext?.read<OnboardingCubit>().setStatus(OnboardingStatus.offboarded);
+  // - Reset the tray icon
+  App.navState.currentContext?.read<TrayCubit>().initialize();
+  return true;
+}