@dittolive/ditto 4.12.0 → 5.0.0-experimental.js-cocoapods-publishing.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dittolive/ditto",
-  "version": "4.12.0",
+  "version": "5.0.0-experimental.js-cocoapods-publishing.3",
   "description": "Ditto is a cross-platform SDK that allows apps to sync with and even without internet connectivity.",
   "homepage": "https://ditto.com",
   "license": "SEE LICENSE IN LICENSE.md",

package/react-native/android/dittoffi/src/ditto_c_string.i

@@ -0,0 +1,33 @@
+// Here we use a typemap to say that for functions that return `char *` and are
+// marked with the `%newobject` directive we have custom behaviour for freeing
+// the returned value. This ensures all strings get cleaned up.
+%typemap(newfree) char * {
+if ($1 != NULL) {
+    ditto_c_string_free($1);
+}
+}
+
+%newobject ditto_auth_client_get_app_id;
+%newobject ditto_auth_client_user_id;
+%newobject ditto_document_id_query_compatible;
+%newobject ditto_error_message;
+%newobject ditto_error_message_peek;
+%newobject ditto_get_complete_attachment_path;
+%newobject ditto_get_sdk_version;
+%newobject ditto_presence_v1;
+%newobject ditto_presence_v2;
+%newobject ditto_presence_v3;
+%newobject ditto_sdk_transports_android_missing_permissions;
+%newobject ditto_set_device_name;
+%newobject ditto_small_peer_info_get_metadata;
+%newobject ditto_transports_diagnostics;
+%newobject dittoffi_authentication_status_user_id;
+%newobject dittoffi_base64_encode;
+%newobject dittoffi_crypto_generate_secure_random_token;
+%newobject dittoffi_ditto_capture_stack_trace_string_internal;
+%newobject dittoffi_error_description;
+%newobject dittoffi_get_sdk_semver;
+%newobject dittoffi_panic_message;
+%newobject dittoffi_panic_stack_trace_string;
+%newobject dittoffi_query_result_item_json;
+%newobject dittoffi_sync_subscription_query_string;

package/react-native/android/dittoffi/src/dittoffi.h

@@ -1027,20 +1027,6 @@ void
 /* fn */ ditto_clear_presence_callback (
     CDitto_t const * ditto);
 
-/** \brief
- *  Deregister v1 presence callback, releasing the receiver on the SDK side.
- */
-void
-/* fn */ ditto_clear_presence_v1_callback (
-    CDitto_t const * ditto);
-
-/** \brief
- *  Deregister v2 presence callback, releasing the receiver on the SDK side.
- */
-void
-/* fn */ ditto_clear_presence_v2_callback (
-    CDitto_t const * ditto);
-
 /** \brief
  *  Deregister v3 presence callback, releasing the receiver on the SDK side.
  */
@@ -2253,20 +2239,6 @@ uint32_t
     AttachmentFileOperation_t file_operation,
     CAttachment_t * out_attachment);
 
-/** \brief
- *  Request data showing who we are connected to in a user-friendly way.
- */
-char *
-/* fn */ ditto_presence_v1 (
-    CDitto_t const * ditto);
-
-/** \brief
- *  Request data showing who we are connected to in a user-friendly way.
- */
-char *
-/* fn */ ditto_presence_v2 (
-    CDitto_t const * ditto);
-
 /** \brief
  *  Request data showing who we are connected to in a user-friendly way.
  */
@@ -2382,32 +2354,6 @@ void
     void (*release)(void *),
     void (*c_cb)(void *, char *));
 
-/** \brief
- *  Register a function that will be called every time the connection state
- *  of remote peers changes.
- *  REMOVE THIS IN V4
- */
-void
-/* fn */ ditto_register_presence_v1_callback (
-    CDitto_t const * ditto,
-    void * ctx,
-    void (*retain)(void *),
-    void (*release)(void *),
-    void (*c_cb)(void *, char const *));
-
-/** \brief
- *  Register a function that will be called every time the connection state
- *  of remote peers changes.
- *  REMOVE THIS IN V4
- */
-void
-/* fn */ ditto_register_presence_v2_callback (
-    CDitto_t const * ditto,
-    void * ctx,
-    void (*retain)(void *),
-    void (*release)(void *),
-    void (*c_cb)(void *, char const *));
-
 /** \brief
  *  User-friendly categories describing where condition events arose
  */
@@ -4257,27 +4203,6 @@ void
 /* fn */ dittoffi_store_observer_free (
     dittoffi_store_observer_t * _observer);
 
-/** \brief
- *  Same as [`Vec<T>`][`rust::Vec`], but with guaranteed `#[repr(C)]` layout
- */
-typedef struct Vec_dittoffi_store_observer_ptr {
-    /** <No documentation available> */
-    dittoffi_store_observer_t * * ptr;
-
-    /** <No documentation available> */
-    size_t len;
-
-    /** <No documentation available> */
-    size_t cap;
-} Vec_dittoffi_store_observer_ptr_t;
-
-/** \brief
- *  Free a Vec of [`FfiStoreObserver`]
- */
-void
-/* fn */ dittoffi_store_observer_free_sparse (
-    Vec_dittoffi_store_observer_ptr_t _vec);
-
 /** \brief
  *  Returns the inner ID of the given observer.
  *
@@ -4295,12 +4220,26 @@ bool
     dittoffi_store_observer_t const * observer);
 
 /** \brief
- *  Returns the DQL query arguments of the given observer, if any were given.
+ *  Returns the CBOR-serialized DQL query arguments of the given observer, if any were given.
  */
 slice_boxed_uint8_t
 /* fn */ dittoffi_store_observer_query_arguments (
     dittoffi_store_observer_t const * observer);
 
+/** \brief
+ *  Returns the CBOR-serialized DQL query arguments of the given observer, if any were given.
+ */
+slice_boxed_uint8_t
+/* fn */ dittoffi_store_observer_query_arguments_cbor (
+    dittoffi_store_observer_t const * observer);
+
+/** \brief
+ *  Returns the JSON-serialized DQL query arguments of the given observer, if any were given.
+ */
+slice_boxed_uint8_t
+/* fn */ dittoffi_store_observer_query_arguments_json (
+    dittoffi_store_observer_t const * observer);
+
 /** \brief
  *  Returns the DQL query string of the given observer.
  */
@@ -4308,6 +4247,20 @@ char *
 /* fn */ dittoffi_store_observer_query_string (
     dittoffi_store_observer_t const * observer);
 
+/** \brief
+ *  Same as [`Vec<T>`][`rust::Vec`], but with guaranteed `#[repr(C)]` layout
+ */
+typedef struct Vec_dittoffi_store_observer_ptr {
+    /** <No documentation available> */
+    dittoffi_store_observer_t * * ptr;
+
+    /** <No documentation available> */
+    size_t len;
+
+    /** <No documentation available> */
+    size_t cap;
+} Vec_dittoffi_store_observer_ptr_t;
+
 /** \brief
  *  Returns a list of all registered observers.
  */
@@ -4315,6 +4268,22 @@ Vec_dittoffi_store_observer_ptr_t
 /* fn */ dittoffi_store_observers (
     CDitto_t const * ditto);
 
+/** \brief
+ *  Free a Vec of [`FfiStoreObserver`]s.
+ *
+ *  # IMPORTANT
+ *
+ *  This freeing function ignores the given `.len` and treats it as if `.len = 0` (to avoid
+ *  double-freeing).
+ *
+ *  SDK callers should have taken ownership of each individual `FfiStoreObserver` (either by having
+ *  freed each, or by having wrapped them in some SDK class that eventually will), in order to avoid
+ *  memory leaks.
+ */
+void
+/* fn */ dittoffi_store_observers_free_sparse (
+    Vec_dittoffi_store_observer_ptr_t vec);
+
 /** \brief
  *  `Arc<dyn Send + Sync + Fn() -> Ret>`
  */
@@ -4346,6 +4315,16 @@ typedef struct BoxDynFnMut2_void_dittoffi_query_result_ptr_ArcDynFn0_void {
     void (*free)(void *);
 } BoxDynFnMut2_void_dittoffi_query_result_ptr_ArcDynFn0_void_t;
 
+/** \brief
+ *  Ffi-compatible callback wrapper for store observers.
+ *
+ *  # Notes
+ *
+ *  - SDK clients construct this callback and we call it sequentially (non-overlapping), hence
+ *  `FnMut`.
+ */
+typedef BoxDynFnMut2_void_dittoffi_query_result_ptr_ArcDynFn0_void_t dittoffi_store_observation_handler_with_signal_next_t;
+
 /** <No documentation available> */
 typedef struct dittoffi_result_dittoffi_store_observer_ptr {
     /** \brief
@@ -4371,7 +4350,7 @@ dittoffi_result_dittoffi_store_observer_ptr_t
     CDitto_t const * ditto,
     char const * query,
     slice_ref_uint8_t query_args_cbor,
-    BoxDynFnMut2_void_dittoffi_query_result_ptr_ArcDynFn0_void_t callback);
+    dittoffi_store_observation_handler_with_signal_next_t handler);
 
 /** \brief
  *  Returns all transactions currently in flight.
@@ -4442,10 +4421,19 @@ bool
     dittoffi_sync_subscription_t const * sync_subscription);
 
 /** \brief
- *  Returns the DQL arguments object associated with the given sync subscription, if one exists.
+ *  Returns the CBOR-serialized DQL arguments object associated with the given sync subscription, if
+ *  one exists.
+ */
+slice_boxed_uint8_t
+/* fn */ dittoffi_sync_subscription_query_arguments_cbor (
+    dittoffi_sync_subscription_t const * sync_subscription);
+
+/** \brief
+ *  Returns the JSON-serialized DQL arguments object associated with the given sync subscription, if
+ *  one exists.
  */
 slice_boxed_uint8_t
-/* fn */ dittoffi_sync_subscription_query_arguments (
+/* fn */ dittoffi_sync_subscription_query_arguments_json (
     dittoffi_sync_subscription_t const * sync_subscription);
 
 /** \brief
@@ -4490,7 +4478,7 @@ Vec_dittoffi_sync_subscription_ptr_t
  */
 void
 /* fn */ dittoffi_sync_subscriptions_free_sparse (
-    Vec_dittoffi_sync_subscription_ptr_t v);
+    Vec_dittoffi_sync_subscription_ptr_t vec);
 
 /** \brief
  *  The action to take when completing a transaction.