feat: replace parameters with config object [#120] (#134)

* feat: replace parameters with config object [#120]

fix: rename classes to make clearer what's going on [#120]

fix: get readme up to date [#120]

fix: mark auth_config as immutable [#120]

 fix: move oauthredirect back into constants [#120]

fix: override config in clerkauthstate [#120]

fix: move localizations away from dependence on materialapp [#120]

fix: improvements to clerkerrorlistener [#120]

fix: pr changes

fix: move localization finding into clerkauthstate [#120]

Revert "fix: move localization finding into clerkauthstate [#120]"

This reverts commit c0a5d66.

fix: move localization finding into authstate [#120]

fix: rename auth as authstate in remaining places [#120]

* fix: pr changes

---------

Co-authored-by: Simon Lightfoot <[email protected]>

Author: shinyford

packages/clerk_auth/.gitignore

@@ -22,3 +22,6 @@ pubspec.lock
 # Flutter auto-generated files
 .flutter-plugins
 .flutter-plugins-dependencies
+
+# Persistor file
+clerk_sdk.json

packages/clerk_auth/README.md

@@ -32,30 +32,28 @@ import 'package:clerk_auth/clerk_auth.dart';
 
 Future<void> main() async {
   final auth = Auth(
-    publishableKey: '<YOUR-PUBLISHABLE-KEY>',
+    config: const AuthConfig(
+      publishableKey: '<YOUR-PUBLISHABLE-KEY>',
+    ),
     persistor: await DefaultPersistor.create(
       storageDirectory: Directory.current,
     ),
   );
 
-  Client client;
+  await auth.initialize();
 
-  client = await auth.attemptSignIn(
+  await auth.attemptSignIn(
     strategy: Strategy.password,
     identifier: '<USER-EMAIL>',
-  );
-  assert(client.signIn?.status == Status.needsFirstFactor);
-
-  client = await auth.attemptSignIn(
-    strategy: Strategy.password,
     password: '<PASSWORD>',
   );
 
-  assert(client.signIn == null);
-  assert(client.activeSession?.status == Status.active);
-  assert(client.activeSession?.publicUserData.identifier.isNotEmpty == true);
-}
+  print('Signed in as ${auth.user}');
+
+  await auth.signOut();
 
+  auth.terminate();
+}
 ```
 
 For more details see [Clerk Auth object](https://pub.dev/documentation/clerk_auth/latest/clerk_auth/Auth-class.html)

packages/clerk_auth/example/main.dart

@@ -1,29 +1,30 @@
+// ignore_for_file: avoid_print
+
 import 'dart:io';
 
 import 'package:clerk_auth/clerk_auth.dart';
 
 Future<void> main() async {
   final auth = Auth(
-    publishableKey: '<YOUR-PUBLISHABLE-KEY>',
+    config: const AuthConfig(
+      publishableKey: '<YOUR-PUBLISHABLE-KEY>',
+    ),
     persistor: await DefaultPersistor.create(
       storageDirectory: Directory.current,
     ),
   );
 
-  Client client;
+  await auth.initialize();
 
-  client = await auth.attemptSignIn(
+  await auth.attemptSignIn(
     strategy: Strategy.password,
     identifier: '<USER-EMAIL>',
-  );
-  assert(client.signIn?.status == Status.needsFirstFactor);
-
-  client = await auth.attemptSignIn(
-    strategy: Strategy.password,
     password: '<PASSWORD>',
   );
 
-  assert(client.signIn == null);
-  assert(client.activeSession?.status == Status.active);
-  assert(client.activeSession?.publicUserData.identifier.isNotEmpty == true);
+  print('Signed in as ${auth.user}');
+
+  await auth.signOut();
+
+  auth.terminate();
 }

packages/clerk_auth/lib/clerk_auth.dart

@@ -1,9 +1,9 @@
 /// Package that will allow you to authenticate and use Clerk from Dart code.
 library clerk_auth;
 
-export 'src/clerk_api/api.dart' show ClerkLocalesLookup;
 export 'src/clerk_api/telemetry.dart';
 export 'src/clerk_auth/auth.dart';
+export 'src/clerk_auth/auth_config.dart';
 export 'src/clerk_auth/auth_error.dart';
 export 'src/clerk_auth/http_service.dart';
 export 'src/clerk_auth/persistor.dart';

packages/clerk_auth/lib/src/clerk_api/api.dart

@@ -3,6 +3,7 @@ import 'dart:convert';
 import 'dart:io' show File, HttpHeaders, HttpStatus;
 
 import 'package:clerk_auth/src/clerk_api/token_cache.dart';
+import 'package:clerk_auth/src/clerk_auth/auth_config.dart';
 import 'package:clerk_auth/src/clerk_auth/http_service.dart';
 import 'package:clerk_auth/src/clerk_auth/persistor.dart';
 import 'package:clerk_auth/src/clerk_constants.dart';
@@ -15,65 +16,36 @@ import 'package:http/http.dart' as http;
 
 export 'package:clerk_auth/src/models/enums.dart' show SessionTokenPollMode;
 
-/// Used by [Api] to locate the current user locale preference.
-typedef ClerkLocalesLookup = List<String> Function();
-
 /// [Api] manages communication with the Clerk frontend API
 ///
 class Api with Logging {
-  Api._(
-    this._tokenCache,
-    this._domain,
-    this._httpService,
-    this._localesLookup,
-    this._pollMode,
-  );
-
-  /// Create an [Api] object for a given Publishable Key, or return the existing one
-  /// if such already exists for that key. Requires a [publishableKey]
-  /// found in the Clerk dashboard for you account. Additional arguments:
-  ///
-  /// [persistor]: an optional instance of a [Persistor] which will keep track of
-  /// tokens and expiry between app activations
-  ///
-  /// [client]: an optional instance of [HttpService] to manage low-level communications
-  /// with the back end. Injected for e.g. test mocking
-  ///
-  /// [pollMode]: session token poll mode, default [SessionTokenPollMode.lazy],
-  /// manages how to refresh the [sessionToken].
+  /// Create an [Api] object
   ///
-  factory Api({
-    required String publishableKey,
+  Api({
+    required AuthConfig config,
     required Persistor persistor,
     required HttpService httpService,
-    required ClerkLocalesLookup localesLookup,
-    SessionTokenPollMode pollMode = SessionTokenPollMode.lazy,
-  }) =>
-      Api._(
-        TokenCache(
+  })  : _config = config,
+        _tokenCache = TokenCache(
           persistor: persistor,
-          cacheId: publishableKey.hashCode,
+          publishableKey: config.publishableKey,
         ),
-        _deriveDomainFrom(publishableKey),
-        httpService,
-        localesLookup,
-        pollMode,
-      );
+        _httpService = httpService,
+        _domain = _deriveDomainFrom(config.publishableKey),
+        _testMode = config.isTestMode;
 
+  final AuthConfig _config;
   final TokenCache _tokenCache;
-  final String _domain;
   final HttpService _httpService;
-  final ClerkLocalesLookup _localesLookup;
-  final SessionTokenPollMode _pollMode;
-  late final String _nativeDeviceId;
+  final String _domain;
+
+  bool _testMode;
   Timer? _pollTimer;
   bool _multiSessionMode = true;
-  bool _testMode = ClerkConstants.isTestMode;
 
   static const _kClerkAPIVersion = 'clerk-api-version';
   static const _kClerkClientId = 'x-clerk-client-id';
   static const _kClerkJsVersion = '_clerk_js_version';
-  static const _kClerkNativeDeviceId = 'x-native-device-id';
   static const _kClerkSessionId = '_clerk_session_id';
   static const _kClientKey = 'client';
   static const _kErrorsKey = 'errors';
@@ -90,8 +62,7 @@ class Api with Logging {
   /// Initialise the API
   Future<void> initialize() async {
     await _tokenCache.initialize();
-    _nativeDeviceId = 'PENDING'; // TODO get this value
-    if (_pollMode == SessionTokenPollMode.hungry) {
+    if (_config.sessionTokenPollMode == SessionTokenPollMode.hungry) {
       await _pollForSessionToken();
     }
   }
@@ -115,7 +86,7 @@ class Api with Logging {
       final body = json.decode(resp.body) as Map<String, dynamic>;
       final env = Environment.fromJson(body);
 
-      _testMode = env.config.testMode || ClerkConstants.isTestMode;
+      _testMode = env.config.testMode && _config.isTestMode;
       _multiSessionMode = env.config.singleSessionMode == false;
 
       return env;
@@ -492,7 +463,7 @@ class Api with Logging {
 
   /// Update details pertaining to the current [User]
   ///
-  Future<ApiResponse> updateUser(User user, AuthConfig config) async {
+  Future<ApiResponse> updateUser(User user, Config config) async {
     return await _fetchApiResponse(
       '/me',
       method: HttpMethod.patch,
@@ -902,7 +873,7 @@ class Api with Logging {
   }) {
     return {
       HttpHeaders.acceptHeader: 'application/json',
-      HttpHeaders.acceptLanguageHeader: _localesLookup().join(', '),
+      HttpHeaders.acceptLanguageHeader: _config.localesLookup().join(', '),
       HttpHeaders.contentTypeHeader: method.isGet
           ? 'application/json'
           : 'application/x-www-form-urlencoded',
@@ -912,7 +883,6 @@ class Api with Logging {
       _kXFlutterSDKVersion: ClerkConstants.flutterSdkVersion,
       if (_testMode) //
         _kClerkClientId: _tokenCache.clientId,
-      _kClerkNativeDeviceId: _nativeDeviceId,
       _kXMobile: '1',
       ...?headers,
     };

packages/clerk_auth/lib/src/clerk_api/telemetry.dart

@@ -2,71 +2,53 @@ import 'dart:async';
 import 'dart:convert';
 import 'dart:io';
 
-import 'package:clerk_auth/src/clerk_auth/http_service.dart';
-import 'package:clerk_auth/src/clerk_auth/persistor.dart';
-import 'package:clerk_auth/src/clerk_constants.dart';
-import 'package:clerk_auth/src/models/enums.dart';
+import 'package:clerk_auth/clerk_auth.dart';
 import 'package:clerk_auth/src/models/telemetry/telemetric_event.dart';
-import 'package:clerk_auth/src/utils/logging.dart';
 
 /// Telemetry
 ///
 class Telemetry with Logging {
-  Telemetry._(
-    this._publishableKey,
-    this._persistor,
-    this._httpService,
-    this._sendTelemetryData,
-  );
-
   /// Create a [Telemetry] object
-  factory Telemetry({
-    required String publishableKey,
-    required Persistor persistor,
-    required HttpService httpService,
-    required bool sendTelemetryData,
-  }) {
-    return Telemetry._(
-      publishableKey,
-      persistor,
-      httpService,
-      sendTelemetryData,
-    );
-  }
+  Telemetry({
+    required this.config,
+    required this.persistor,
+    required this.httpService,
+  });
+
+  /// The config used to initialise this telemetry instance.
+  final AuthConfig config;
+
+  /// The [Persistor] used for Telemetry to store its event queue.
+  final Persistor persistor;
+
+  /// The [HttpService] used to send the telemetry events.
+  final HttpService httpService;
 
-  final bool _sendTelemetryData;
-  final String _publishableKey;
-  final Persistor _persistor;
-  final HttpService _httpService;
   late final InstanceType _instanceType;
+  late final _telemetryEndpoint = Uri.parse(config.telemetryEndpoint);
   Timer? _timer;
   final _telemetricEventsQueue = <TelemetricEvent>[];
 
   static const _kTelemetricEventQueueKey = 'telemetricEventQueue';
   static const _telemetricEventsQueueMaxLength = 2000;
-  static const _telemetryPeriod =
-      Duration(milliseconds: ClerkConstants.telemetryPeriod);
-  static final _telemetryEndpoint = Uri.parse(ClerkConstants.telemetryEndpoint);
 
   /// Are we telemetricising?
   bool get isEnabled =>
-      _sendTelemetryData &&
-      _instanceType.isDevelopment &&
-      ClerkConstants.isTelemetryEnabled;
+      config.telemetryPeriod.isNotZero && _instanceType.isDevelopment;
 
   /// Initialise telemetry
   Future<void> initialize({required InstanceType instanceType}) async {
     _instanceType = instanceType;
     if (isEnabled) {
-      final data = await _persistor.read<String>(_kTelemetricEventQueueKey);
+      final data = await persistor.read<String>(_kTelemetricEventQueueKey);
       if (data case String data) {
         final jsonList = json.decode(data) as List<dynamic>;
         final eventList = jsonList.map(
           (data) => TelemetricEvent.fromJson(data as Map<String, dynamic>),
         );
         _telemetricEventsQueue.addAll(eventList);
       }
-      _timer = Timer.periodic(_telemetryPeriod, _sendTelemetry);
+      _timer = Timer.periodic(config.telemetryPeriod, _sendTelemetry);
     }
   }
 
@@ -98,7 +80,7 @@ class Telemetry with Logging {
     if (excess > 0) {
       _telemetricEventsQueue.removeRange(0, excess);
     }
-    _persistor.write(
+    persistor.write(
       _kTelemetricEventQueueKey,
       json.encode(_telemetricEventsQueue),
     );
@@ -108,7 +90,7 @@ class Telemetry with Logging {
     return {
       'event': event.event,
       'it': _instanceType.toString(),
-      'pk': _publishableKey,
+      'pk': config.publishableKey,
       'cv': ClerkConstants.clerkApiVersion,
       'sdk': ClerkConstants.sdkName,
       'sdkv': ClerkConstants.flutterSdkVersion,
@@ -123,7 +105,7 @@ class Telemetry with Logging {
     final events = [..._telemetricEventsQueue];
     if (events.isNotEmpty) {
       _telemetricEventsQueue.clear();
-      final resp = await _httpService.send(
+      final resp = await httpService.send(
         HttpMethod.post,
         _telemetryEndpoint,
         body: json.encode({

packages/clerk_auth/lib/src/clerk_api/token_cache.dart

@@ -1,11 +1,7 @@
 import 'dart:convert';
 import 'dart:io';
 
-import 'package:clerk_auth/src/clerk_auth/persistor.dart';
-import 'package:clerk_auth/src/models/client/client.dart';
-import 'package:clerk_auth/src/models/client/organization.dart';
-import 'package:clerk_auth/src/models/client/session.dart';
-import 'package:clerk_auth/src/models/client/session_token.dart';
+import 'package:clerk_auth/clerk_auth.dart';
 import 'package:http/http.dart' as http;
 
 /// A store for authentication tokens and IDs from the
@@ -18,9 +14,10 @@ class TokenCache {
   ///
   TokenCache({
     required Persistor persistor,
-    required int cacheId,
-  })  : _persistor = persistor,
-        _cacheId = cacheId;
+    required String publishableKey,
+  })   //
+  : _persistor = persistor,
+        _cacheId = publishableKey.hashCode;
 
   final Persistor _persistor;
   final int _cacheId;