fix: refactor status to extendible class [#114] (#133)

* fix: refactor status to extendible class [#114]

* fix: add in missing catch all clause in switch [#114]

Author: shinyford

packages/clerk_auth/lib/src/models/client/field.dart

@@ -1,30 +1,29 @@
+import 'package:json_annotation/json_annotation.dart';
 import 'package:meta/meta.dart';
 
 /// Pseudo-enum representing fields
 ///
 @immutable
+@JsonSerializable()
 class Field {
-  const Field._({required this.name});
+  const Field._(this.name);
 
   /// Create a [Field]
   factory Field({required String name}) {
-    return _values[name] ??= Field._(name: name);
+    return _values[name] ??= Field._(name);
   }
 
-  /// For a given [name] return the [Field] it identifies.
-  /// Create one if necessary and possible
-  ///
-  static Field? named(dynamic name) =>
-      name is String ? Field(name: name) : null;
+  /// fromJson factory for JsonSerializable
+  factory Field.fromJson(String name) => Field(name: name);
 
   /// phone number
-  static const phoneNumber = Field._(name: 'phone_number');
+  static const phoneNumber = Field._('phone_number');
 
   /// email address
-  static const emailAddress = Field._(name: 'email_address');
+  static const emailAddress = Field._('email_address');
 
   /// username
-  static const username = Field._(name: 'username');
+  static const username = Field._('username');
 
   static final _values = <String, Field>{
     phoneNumber.name: phoneNumber,

packages/clerk_auth/lib/src/models/client/session.dart

@@ -1,7 +1,7 @@
 import 'package:clerk_auth/src/models/client/session_token.dart';
 import 'package:clerk_auth/src/models/client/user.dart';
 import 'package:clerk_auth/src/models/client/user_public.dart';
-import 'package:clerk_auth/src/models/enums.dart';
+import 'package:clerk_auth/src/models/status.dart';
 import 'package:clerk_auth/src/utils/json_serialization_helpers.dart';
 import 'package:json_annotation/json_annotation.dart';
 import 'package:meta/meta.dart';

packages/clerk_auth/lib/src/models/client/session.g.dart

@@ -4,6 +4,7 @@ import 'package:clerk_auth/src/models/client/strategy.dart';
 import 'package:clerk_auth/src/models/client/user_public.dart';
 import 'package:clerk_auth/src/models/client/verification.dart';
 import 'package:clerk_auth/src/models/enums.dart';
+import 'package:clerk_auth/src/models/status.dart';
 import 'package:clerk_auth/src/utils/json_serialization_helpers.dart';
 import 'package:json_annotation/json_annotation.dart';
 import 'package:meta/meta.dart';

packages/clerk_auth/lib/src/models/client/sign_in.dart

@@ -1,6 +1,6 @@
 import 'package:clerk_auth/src/models/client/field.dart';
 import 'package:clerk_auth/src/models/client/verification.dart';
-import 'package:clerk_auth/src/models/enums.dart';
+import 'package:clerk_auth/src/models/status.dart';
 import 'package:clerk_auth/src/utils/json_serialization_helpers.dart';
 import 'package:json_annotation/json_annotation.dart';
 import 'package:meta/meta.dart';
@@ -43,19 +43,15 @@ class SignUp {
   final Status status;
 
   /// required fields
-  @JsonKey(fromJson: toFieldList)
   final List<Field> requiredFields;
 
   /// optional fields
-  @JsonKey(fromJson: toFieldList)
   final List<Field> optionalFields;
 
   /// missing fields
-  @JsonKey(fromJson: toFieldList)
   final List<Field> missingFields;
 
   /// unverified fields
-  @JsonKey(fromJson: toFieldList)
   final List<Field> unverifiedFields;
 
   /// username

packages/clerk_auth/lib/src/models/client/sign_in.g.dart

@@ -1,4 +1,5 @@
 import 'package:clerk_auth/src/clerk_auth/auth_error.dart';
+import 'package:json_annotation/json_annotation.dart';
 import 'package:meta/meta.dart';
 
 /// [Strategy] Clerk object
@@ -7,6 +8,7 @@ import 'package:meta/meta.dart';
 /// 'oauth_token' and 'oauth_custom') also have a [provider]
 ///
 @immutable
+@JsonSerializable()
 class Strategy {
   /// Constructor for [Strategy]
   const Strategy({required this.name, this.provider});

packages/clerk_auth/lib/src/models/client/sign_up.dart

@@ -1,5 +1,6 @@
 import 'package:clerk_auth/src/models/client/verification.dart';
 import 'package:clerk_auth/src/models/enums.dart';
+import 'package:clerk_auth/src/models/status.dart';
 
 export 'package:clerk_auth/src/models/client/verification.dart';
 

packages/clerk_auth/lib/src/models/client/sign_up.g.dart

@@ -1,5 +1,5 @@
 import 'package:clerk_auth/src/models/client/strategy.dart';
-import 'package:clerk_auth/src/models/enums.dart';
+import 'package:clerk_auth/src/models/status.dart';
 import 'package:clerk_auth/src/utils/json_serialization_helpers.dart';
 import 'package:json_annotation/json_annotation.dart';
 import 'package:meta/meta.dart';

packages/clerk_auth/lib/src/models/client/strategy.dart

@@ -1,6 +1,7 @@
 import 'package:clerk_auth/src/clerk_auth/auth_error.dart';
 import 'package:clerk_auth/src/models/client/field.dart';
 import 'package:clerk_auth/src/models/client/strategy.dart';
+import 'package:clerk_auth/src/models/status.dart';
 import 'package:collection/collection.dart';
 import 'package:json_annotation/json_annotation.dart';
 
@@ -26,61 +27,6 @@ enum EnrollmentMode {
   String toString() => _$EnrollmentModeEnumMap[this]!;
 }
 
-/// [Status] Clerk object
-@JsonEnum(fieldRename: FieldRename.snake, alwaysCreate: true)
-enum Status {
-  /// abandoned
-  abandoned,
-
-  /// active
-  active,
-
-  /// missing requirements
-  missingRequirements,
-
-  /// needs identifier
-  needsIdentifier,
-
-  /// needs first factor
-  needsFirstFactor,
-
-  /// needs second factor
-  needsSecondFactor,
-
-  /// transferable
-  transferable,
-
-  /// unverified
-  unverified,
-
-  /// verified
-  verified,
-
-  /// complete
-  complete,
-
-  /// expired
-  expired,
-
-  /// failed
-  failed;
-
-  /// is active?
-  bool get isActive => this == active;
-
-  /// is verified?
-  bool get isVerified => this == verified;
-
-  /// is expired?
-  bool get isExpired => this == expired;
-
-  /// needs factor?
-  bool get needsFactor => this == needsFirstFactor || this == needsSecondFactor;
-
-  @override
-  String toString() => _$StatusEnumMap[this]!;
-}
-
 /// [IdentificationStrategy] Clerk object
 @JsonEnum(fieldRename: FieldRename.snake, alwaysCreate: true)
 enum IdentificationStrategy {

packages/clerk_auth/lib/src/models/client/user_identifying_data.dart

@@ -48,19 +48,15 @@ class AuthConfig {
   final bool urlBasedSessionSyncing;
 
   /// identification strategies
-  @JsonKey(fromJson: toStrategyList)
   final List<Strategy> identificationStrategies;
 
   /// first factors
-  @JsonKey(fromJson: toStrategyList)
   final List<Strategy> firstFactors;
 
   /// second factors
-  @JsonKey(fromJson: toStrategyList)
   final List<Strategy> secondFactors;
 
   /// email address verification strategy
-  @JsonKey(fromJson: toStrategyList)
   final List<Strategy> emailAddressVerificationStrategies;
 
   /// allows first name?