v9.1.2: fixed web complation (acts as no-op) (#165)

Author: JaffaKetchup

CHANGELOG.md

@@ -18,6 +18,11 @@ Many thanks to my sponsors, no matter how much or how little they donated. Spons
 
 # Changelog
 
+## [9.1.2] - 2024/08/07
+
+* Fixed compilation on web platforms: FMTC now internally overrides the `FMTCObjectBoxBackend` and becomes a no-op
+* Minor documentation improvements
+
 ## [9.1.1] - 2024/07/16
 
 * Fixed bug where errors within the import functionality would not be catchable by the original invoker

example/lib/screens/configure_download/components/numerical_input_row.dart

@@ -89,7 +89,7 @@ class _NumericalInputRowState extends State<NumericalInputRow> {
                     FilteringTextInputFormatter.digitsOnly,
                     _NumericalRangeFormatter(
                       min: widget.min,
-                      max: widget.max ?? 9223372036854775807,
+                      max: widget.max ?? double.maxFinite.toInt(),
                     ),
                   ],
                   onChanged: (newVal) => widget.onChanged(

example/pubspec.yaml

@@ -3,7 +3,7 @@ description: The example application for 'flutter_map_tile_caching', showcasing
   it's functionality and use-cases.
 publish_to: "none"
 
-version: 9.1.1
+version: 9.1.2
 
 environment:
   sdk: ">=3.3.0 <4.0.0"

lib/src/backend/export_external.dart

@@ -2,7 +2,8 @@
 // A full license can be found at .\LICENSE
 
 export 'errors/errors.dart';
-export 'impls/objectbox/backend/backend.dart';
+export 'impls/web_noop/backend.dart'
+    if (dart.library.ffi) 'impls/objectbox/backend/backend.dart';
 export 'interfaces/backend/backend.dart';
 export 'interfaces/backend/internal.dart';
 export 'interfaces/backend/internal_thread_safe.dart';

lib/src/backend/impls/objectbox/backend/backend.dart

@@ -31,10 +31,18 @@ part 'internal_workers/thread_safe.dart';
 part 'errors.dart';
 part 'internal.dart';
 
+/// {@template fmtc.backend.objectbox}
 /// Implementation of [FMTCBackend] that uses ObjectBox as the storage database
+///
+/// On web, this redirects to a no-op implementation that throws
+/// [UnsupportedError]s when attempting to use [initialise] or [uninitialise],
+/// and [RootUnavailable] when trying to use any other method.
+/// {@endtemplate}
 final class FMTCObjectBoxBackend implements FMTCBackend {
   /// {@macro fmtc.backend.initialise}
   ///
+  /// {@template fmtc.backend.objectbox.initialise}
+  ///
   /// ---
   ///
   /// [maxDatabaseSize] is the maximum size the database file can grow
@@ -50,6 +58,7 @@ final class FMTCObjectBoxBackend implements FMTCBackend {
   /// thread.
   ///
   /// Avoid using [useInMemoryDatabase] outside of testing purposes.
+  /// {@endtemplate}
   @override
   Future<void> initialise({
     String? rootDirectory,
@@ -68,11 +77,14 @@ final class FMTCObjectBoxBackend implements FMTCBackend {
 
   /// {@macro fmtc.backend.uninitialise}
   ///
+  /// {@template fmtc.backend.objectbox.uninitialise}
+  ///
   /// If [immediate] is `true`, any operations currently underway will be lost,
   /// as the worker will be killed as quickly as possible (not necessarily
   /// instantly).
   /// If `false`, all operations currently underway will be allowed to complete,
   /// but any operations started after this method call will be lost.
+  /// {@endtemplate}
   @override
   Future<void> uninitialise({
     bool deleteRoot = false,

lib/src/backend/impls/objectbox/models/generated/objectbox.g.dart

@@ -0,0 +1,36 @@
+// Copyright © Luka S (JaffaKetchup) under GPL-v3
+// A full license can be found at .\LICENSE
+
+import 'package:flutter/services.dart';
+import 'package:meta/meta.dart';
+
+import '../../../../flutter_map_tile_caching.dart';
+
+/// {@macro fmtc.backend.objectbox}
+final class FMTCObjectBoxBackend implements FMTCBackend {
+  static const _noopMessage =
+      'FMTC is not supported on non-FFI platforms by default';
+
+  /// {@macro fmtc.backend.initialise}
+  ///
+  /// {@macro fmtc.backend.objectbox.initialise}
+  @override
+  Future<void> initialise({
+    String? rootDirectory,
+    int maxDatabaseSize = 10000000,
+    String? macosApplicationGroup,
+    RootIsolateToken? rootIsolateToken,
+    @visibleForTesting bool useInMemoryDatabase = false,
+  }) =>
+      throw UnsupportedError(_noopMessage);
+
+  /// {@macro fmtc.backend.uninitialise}
+  ///
+  /// {@macro fmtc.backend.objectbox.uninitialise}
+  @override
+  Future<void> uninitialise({
+    bool deleteRoot = false,
+    bool immediate = false,
+  }) =>
+      throw UnsupportedError(_noopMessage);
+}

lib/src/backend/impls/web_noop/backend.dart

@@ -5,8 +5,8 @@ import 'package:meta/meta.dart';
 
 /// Largest fully representable integer in Dart
 @internal
-const largestInt = 9223372036854775807;
+final largestInt = double.maxFinite.toInt();
 
 /// Smallest fully representable integer in Dart
 @internal
-const smallestInt = -9223372036854775808;
+final smallestInt = -double.maxFinite.toInt();

lib/src/misc/int_extremes.dart

@@ -1,7 +1,7 @@
 name: flutter_map_tile_caching
 description: Plugin for 'flutter_map' providing advanced caching functionality,
   with ability to download map regions for offline use.
-version: 9.1.1
+version: 9.1.2
 
 repository: https://github.com/JaffaKetchup/flutter_map_tile_caching
 issue_tracker: https://github.com/JaffaKetchup/flutter_map_tile_caching/issues
@@ -40,7 +40,7 @@ dependencies:
   objectbox: ^4.0.1
   objectbox_flutter_libs: ^4.0.1
   path: ^1.9.0
-  path_provider: ^2.1.3
+  path_provider: ^2.1.4
 
 dev_dependencies:
   build_runner: ^2.4.11

pubspec.yaml

@@ -1,7 +1,7 @@
 ; Script generated by the Inno Setup Script Wizard
 
 #define MyAppName "FMTC Demo"
-#define MyAppVersion "for 9.1.1"
+#define MyAppVersion "for 9.1.2"
 #define MyAppPublisher "JaffaKetchup Development"
 #define MyAppURL "https://github.com/JaffaKetchup/flutter_map_tile_caching"
 #define MyAppSupportURL "https://github.com/JaffaKetchup/flutter_map_tile_caching/issues"