@dittolive/ditto 4.8.1 → 4.8.2

package/react-native/dittoffi/dittoffi.h

@@ -1077,6 +1077,37 @@ int32_t
     int32_t limit,
     uint32_t offset);
 
+/** <No documentation available> */
+typedef struct LegacySubscriptionHandle LegacySubscriptionHandle_t;
+
+/** <No documentation available> */
+typedef struct LegacySubscriptionHandleResult {
+    /** <No documentation available> */
+    int32_t status_code;
+
+    /** <No documentation available> */
+    LegacySubscriptionHandle_t * handle;
+} LegacySubscriptionHandleResult_t;
+
+/** \brief
+ *  Helper function for GC-sensitive SDKs to ensure proper unregistering of the subscription in the
+ *  future.
+ *
+ *  Indeed, the state contained in the `LegacySubscriptionHandle` is otherwise difficult for the
+ *  SDK to keep alive once "finalizing the world" has started: some of this state (such as some of
+ *  the individual items of `order_by`) may have been disposed of already, which makes it impossible
+ *  to then properly call `ditto_remove_subscription()`.
+ */
+LegacySubscriptionHandleResult_t
+/* fn */ ditto_add_subscription_with_easier_unregistering (
+    CDitto_t const * ditto,
+    char const * collection,
+    char const * query,
+    slice_ref_uint8_t query_args_cbor,
+    slice_ref_COrderByParam_t order_bys,
+    int32_t limit,
+    uint32_t offset);
+
 /** \brief
  *  An opaque handle for each installed transport, heap-allocated and owned by
  *  the SDK.
@@ -2486,6 +2517,8 @@ typedef enum Platform {
     /** <No documentation available> */
     PLATFORM_IOS,
     /** <No documentation available> */
+    PLATFORM_TVOS,
+    /** <No documentation available> */
     PLATFORM_ANDROID,
     /** <No documentation available> */
     PLATFORM_LINUX,
@@ -2511,6 +2544,8 @@ typedef enum Language {
     LANGUAGE_UNKNOWN,
     /** <No documentation available> */
     LANGUAGE_RUST,
+    /** <No documentation available> */
+    LANGUAGE_J_V_M_BASED,
 } Language_t;
 
 /** <No documentation available> */
@@ -2734,6 +2769,10 @@ bool
 
 /** \brief
  *  Initializes and registers the global Ditto logger.
+ *
+ *  This function shouldn't *need* to be called because all of the logging-related FFI calls
+ *  *should* start with a call that ensures that the logger is initialized. However, it also
+ *  shouldn't hurt to call this.
  */
 void
 /* fn */ ditto_logger_init (void);
@@ -3278,19 +3317,6 @@ void
     CDitto_t const * ditto,
     uint32_t count);
 
-/** <No documentation available> */
-uint32_t
-/* fn */ ditto_set_priority_for_query_overlap_group (
-    CDitto_t const * ditto,
-    uint8_t prio,
-    uint8_t query_overlap_group);
-
-/** <No documentation available> */
-uint32_t
-/* fn */ ditto_set_query_overlap_group (
-    CDitto_t const * ditto,
-    uint8_t query_overlap_group);
-
 /** <No documentation available> */
 void
 /* fn */ ditto_set_static_tcp_clients (
@@ -3341,9 +3367,7 @@ void
  *  peers (including the big peer). This is controlled by [`SyncScope`]s. For
  *  the FFI function to get the current sync scope, see
  *  [`ditto_small_peer_info_get_sync_scope`]. By default, the small peer info
- *  document will not sync to any other peers. To sync this document with the
- *  big peer for dashboard and debugging purposes, set a sync scope of
- *  `BigPeerOnly`.
+ *  document will sync to the big peer.
  *
  *  [`SyncScope`]: DittoSmallPeerInfoSyncScope
  */
@@ -3379,15 +3403,14 @@ char *
  *
  *  The syncing behavior is dictated by internal [`SyncScope`]s.
  *
- *  By default, the small peer info does not sync to other peers as dictated by
- *  the default `LocalPeerOnly` scope. To enable syncing small peer info to the
- *  big peer, set the `BigPeerOnly` scope.
+ *  By default, the small peer info will sync with the big peer, as dictated by
+ *  the default `BigPeerOnly` scope.
  *
- *  NOTE: Currently SDKs can only set [`BigPeerOnly`] or [`LocalPeerOnly`]
- *  sync scopes. [`AllPeers`] and [`SmallPeersOnly`] sync scopes are currently
- *  unsupported. Support for `AllPeers` and `SmallPeersOnly` will be added in the
- *  future, but for that we will need an API for users to subscribe to the small
- *  peer info of other peers.
+ *  NOTE: Currently SDKs can only set [`BigPeerOnly`] or [`LocalPeerOnly`] sync
+ *  scopes. [`AllPeers`] and [`SmallPeersOnly`] sync scopes are currently
+ *  unsupported. Support for `AllPeers` and `SmallPeersOnly` will be added in
+ *  the future, but for that we will need an API for users to subscribe to the
+ *  small peer info of other peers.
  *
  *  [`SyncScope`]: ::ditto_store::sync_scope::SyncScope
  *  [`BigPeerOnly`]: ::ditto_store::sync_scope::SyncScope::BigPeerOnly
@@ -3439,9 +3462,7 @@ DittoSmallPeerInfoSyncScope_t
  *  peers (including the big peer). This is controlled by [`SyncScope`]s. For
  *  the FFI function to set sync scopes, see
  *  [`ditto_small_peer_info_set_sync_scope`]. By default, the small peer info
- *  document will not sync to any other peers. To sync this document with the
- *  big peer for dashboard and debugging purposes, set a sync scope of
- *  `BigPeerOnly`.
+ *  document will sync to the big peer.
  *
  *  [`SyncScope`]: DittoSmallPeerInfoSyncScope
  */
@@ -3579,6 +3600,14 @@ char *
 /* fn */ ditto_transports_diagnostics (
     CDitto_t const * ditto);
 
+/** \brief
+ *  The whole point
+ */
+int32_t
+/* fn */ ditto_unregister_and_free_legacy_subscription (
+    CDitto_t const * ditto,
+    LegacySubscriptionHandle_t * handle);
+
 /** <No documentation available> */
 void
 /* fn */ ditto_unregister_local_auth_server (
@@ -4180,7 +4209,7 @@ typedef struct BoxDynFnMut1_void_dittoffi_result_uint64 {
  *  - [`FfiError::IoPermissionDenied`]
  *  - [`FfiError::IoAlreadyExists`]
  *  - [`FfiError::IoOperationFailed`]
- *  - [`FfiError::LoggingLogsUnsupported`]
+ *  - [`FfiError::Unsupported`]
  *  - [`FfiError::Unknown`]
  */
 void
@@ -4791,6 +4820,13 @@ void
 /* fn */ mdns_server_free_handle (
     TransportHandle_MdnsServerPlatformEvent_t * handle);
 
+/** \brief
+ *  The platform advises Rust that the TCP listener will need to be restarted.
+ */
+void
+/* fn */ mdns_server_invalidate_listener (
+    TransportHandle_MdnsServerPlatformEvent_t const * handle);
+
 /** \brief
  *  The platform advises Rust that we failed to resolve a peer's hostname and
  *  port
@@ -4814,140 +4850,6 @@ void
 Vec_char_ptr_t *
 /* fn */ new_c_string_vec (void);
 
-/** \brief
- *  An FFI-safe `Poll<()>`.
- */
-/** \remark Has the same ABI as `int8_t` **/
-#ifdef DOXYGEN
-typedef
-#endif
-enum PollFuture {
-    /** <No documentation available> */
-    POLL_FUTURE_COMPLETED = 0,
-    /** <No documentation available> */
-    POLL_FUTURE_PENDING = -1,
-}
-#ifndef DOXYGEN
-; typedef int8_t
-#endif
-PollFuture_t;
-
-/** \brief
- *  The layout of `core::task::wake::Context` is opaque/subject to changes.
- */
-typedef struct Opaque_Context Opaque_Context_t;
-
-/** <No documentation available> */
-typedef struct FfiFutureVTable {
-    /** <No documentation available> */
-    void (*release_vptr)(Erased_t *);
-
-    /** <No documentation available> */
-    PollFuture_t (*dyn_poll)(Erased_t *, Opaque_Context_t *);
-} FfiFutureVTable_t;
-
-/** <No documentation available> */
-typedef struct VirtualPtr__Erased_ptr_FfiFutureVTable {
-    /** <No documentation available> */
-    Erased_t * ptr;
-
-    /** <No documentation available> */
-    FfiFutureVTable_t vtable;
-} VirtualPtr__Erased_ptr_FfiFutureVTable_t;
-
-/** \brief
- *  `Box<dyn 'static + Send + FnMut() -> Ret>`
- */
-typedef struct BoxDynFnMut0_void {
-    /** <No documentation available> */
-    void * env_ptr;
-
-    /** <No documentation available> */
-    void (*call)(void *);
-
-    /** <No documentation available> */
-    void (*free)(void *);
-} BoxDynFnMut0_void_t;
-
-/** <No documentation available> */
-typedef struct DropGlueVTable {
-    /** <No documentation available> */
-    void (*release_vptr)(Erased_t *);
-} DropGlueVTable_t;
-
-/** <No documentation available> */
-typedef struct VirtualPtr__Erased_ptr_DropGlueVTable {
-    /** <No documentation available> */
-    Erased_t * ptr;
-
-    /** <No documentation available> */
-    DropGlueVTable_t vtable;
-} VirtualPtr__Erased_ptr_DropGlueVTable_t;
-
-/** <No documentation available> */
-typedef struct FfiFutureExecutorVTable {
-    /** <No documentation available> */
-    void (*release_vptr)(Erased_t *);
-
-    /** <No documentation available> */
-    Erased_t * (*retain_vptr)(Erased_t const *);
-
-    /** <No documentation available> */
-    VirtualPtr__Erased_ptr_FfiFutureVTable_t (*dyn_spawn)(Erased_t const *, VirtualPtr__Erased_ptr_FfiFutureVTable_t);
-
-    /** <No documentation available> */
-    VirtualPtr__Erased_ptr_FfiFutureVTable_t (*dyn_spawn_blocking)(Erased_t const *, BoxDynFnMut0_void_t);
-
-    /** <No documentation available> */
-    void (*dyn_block_on)(Erased_t const *, VirtualPtr__Erased_ptr_FfiFutureVTable_t);
-
-    /** <No documentation available> */
-    VirtualPtr__Erased_ptr_DropGlueVTable_t (*dyn_enter)(Erased_t const *);
-} FfiFutureExecutorVTable_t;
-
-/** <No documentation available> */
-typedef struct VirtualPtr__Erased_ptr_FfiFutureExecutorVTable {
-    /** <No documentation available> */
-    Erased_t * ptr;
-
-    /** <No documentation available> */
-    FfiFutureExecutorVTable_t vtable;
-} VirtualPtr__Erased_ptr_FfiFutureExecutorVTable_t;
-
-/** <No documentation available> */
-typedef struct FfiFnMutVTable {
-    /** <No documentation available> */
-    void (*release_vptr)(Erased_t *);
-
-    /** <No documentation available> */
-    void (*call)(Erased_t *);
-} FfiFnMutVTable_t;
-
-/** <No documentation available> */
-typedef struct VirtualPtr__Erased_ptr_FfiFnMutVTable {
-    /** <No documentation available> */
-    Erased_t * ptr;
-
-    /** <No documentation available> */
-    FfiFnMutVTable_t vtable;
-} VirtualPtr__Erased_ptr_FfiFnMutVTable_t;
-
-/** \brief
- *  Keep in sync with `/rust/dittolive-ditto/dittoffi.rs`
- */
-typedef struct ExecutorFunctions {
-    /** <No documentation available> */
-    VirtualPtr__Erased_ptr_FfiFutureExecutorVTable_t (*get_current_handle)(void);
-
-    /** <No documentation available> */
-    void (*block_in_place)(VirtualPtr__Erased_ptr_FfiFnMutVTable_t);
-} ExecutorFunctions_t;
-
-/** <No documentation available> */
-void
-/* fn */ register_executor_functions (
-    ExecutorFunctions_t fns);
-
 /** \brief
  *  The SDK requests to drop its handle to this TCP Client transport
  */

package/types/ditto.d.ts

@@ -821,6 +821,14 @@ declare class MutableDocumentPath {
  * The types of an {@link UpdateResult}.
  */
 type UpdateResultType = 'set' | 'incremented' | 'removed';
+/**
+ * Provides information about a successful update operation on a document.
+ *
+ * The update result can be one of the following types:
+ *   - `set`
+ *   - `removed`
+ *   - `incremented`
+ */
 declare class UpdateResult {
     /** The update result's type. */
     readonly type: UpdateResultType;