Expose NostrDatabase and Events structs

Author: yukibtc

CHANGELOG.md

@@ -43,6 +43,7 @@
 * Expose `UnwrappedGift` ([Yuki Kishimoto])
 * Expose `Client::handle_notifications` ([Yuki Kishimoto])
 * Expose subscribe `Client` methods ([Yuki Kishimoto])
+* Expose `NostrDatabase` and `Events` structs ([Yuki Kishimoto])
 
 ### Fixed
 

lib/nostr_sdk.dart

@@ -19,3 +19,5 @@ export 'src/rust/api/client/builder.dart';
 export 'src/rust/api/client/notification.dart';
 export 'src/rust/api/client/options.dart';
 export 'src/rust/api/client/output.dart';
+export 'src/rust/api/database.dart';
+export 'src/rust/api/database/events.dart';

lib/src/rust/api/client.dart

@@ -7,6 +7,7 @@ import '../frb_generated.dart';
 import 'client/builder.dart';
 import 'client/notification.dart';
 import 'client/output.dart';
+import 'database/events.dart';
 import 'package:flutter_rust_bridge/flutter_rust_bridge_for_generated.dart';
 import 'protocol/event.dart';
 import 'protocol/event/builder.dart';
@@ -74,7 +75,7 @@ abstract class Client implements RustOpaqueInterface {
   ///
   /// If `gossip` is enabled (see [`Options::gossip`]) the events will be requested also to
   /// NIP65 relays (automatically discovered) of public keys included in filters (if any).
-  Future<List<Event>> fetchEvents(
+  Future<Events> fetchEvents(
       {required Filter filter, required Duration timeout});
 
   /// Disconnect and force remove all relays

lib/src/rust/api/database.dart

@@ -0,0 +1,76 @@
+// This file is automatically generated, so please do not edit it.
+// Generated by `flutter_rust_bridge`@ 2.0.0.
+
+// ignore_for_file: invalid_use_of_internal_member, unused_import, unnecessary_import
+
+import '../frb_generated.dart';
+import 'database/events.dart';
+import 'package:flutter_rust_bridge/flutter_rust_bridge_for_generated.dart';
+import 'package:freezed_annotation/freezed_annotation.dart' hide protected;
+import 'protocol/event.dart';
+import 'protocol/event/id.dart';
+import 'protocol/filter.dart';
+part 'database.freezed.dart';
+
+// These function are ignored because they are on traits that is not defined in current crate (put an empty `#[frb]` on it to unignore): `deref`, `from`, `from`, `from`
+
+// Rust type: RustOpaqueMoi<flutter_rust_bridge::for_generated::RustAutoOpaqueInner<_NostrDatabase>>
+abstract class NostrDatabase implements RustOpaqueInterface {
+  Future<BigInt> count({required Filter filter});
+
+  /// Delete all events that match the `Filter`
+  Future<void> delete({required Filter filter});
+
+  /// Get [`Event`] by [`EventId`]
+  Future<Event?> eventById({required EventId eventId});
+
+  /// LMDB backend
+  static NostrDatabase lmdb({required String path}) =>
+      NostrSdk.instance.api.crateApiDatabaseNostrDatabaseLmdb(path: path);
+
+  Future<Events> query({required Filter filter});
+
+  /// Save [`Event`] into store
+  Future<SaveEventStatus> saveEvent({required Event event});
+
+  /// Wipe all data
+  Future<void> wipe();
+}
+
+/// Reason why event wasn't stored into the database
+enum RejectedReason {
+  /// Ephemeral events aren't expected to be stored
+  ephemeral,
+
+  /// The event already exists
+  duplicate,
+
+  /// The event was deleted
+  deleted,
+
+  /// The event is expired
+  expired,
+
+  /// The event was replaced
+  replaced,
+
+  /// Attempt to delete a non-owned event
+  invalidDelete,
+
+  /// Other reason
+  other,
+  ;
+}
+
+@freezed
+sealed class SaveEventStatus with _$SaveEventStatus {
+  const SaveEventStatus._();
+
+  /// The event has been successfully saved
+  const factory SaveEventStatus.success() = SaveEventStatus_Success;
+
+  /// The event has been rejected
+  const factory SaveEventStatus.rejected(
+    RejectedReason field0,
+  ) = SaveEventStatus_Rejected;
+}