Add Sync class with static factory methods to construct SyncClient

Author: Shubham

objectbox/c.py

@@ -1232,3 +1232,30 @@ def c_array_pointer(py_list: Union[List[Any], np.ndarray], c_type):
 # OBX_C_API obx_err obx_sync_outgoing_message_count(OBX_sync* sync, uint64_t limit, uint64_t* out_count);
 obx_sync_outgoing_message_count = c_fn_rc('obx_sync_outgoing_message_count',
                                           [OBX_sync_p, ctypes.c_uint64, ctypes.POINTER(ctypes.c_uint64)])
+
+OBXFeature = ctypes.c_int
+
+
+class Feature(IntEnum):
+    ResultArray = 1
+    TimeSeries = 2
+    Sync = 3
+    DebugLog = 4
+    Admin = 5
+    Tree = 6
+    SyncServer = 7
+    WebSockets = 8
+    Cluster = 9
+    HttpServer = 10
+    GraphQL = 11
+    Backup = 12
+    Lmdb = 13
+    VectorSearch = 14
+    Wal = 15
+    SyncMongoDb = 16
+    Auth = 17
+    Trial = 18
+    SyncFilters = 19
+
+
+obx_has_feature = c_fn('obx_has_feature', ctypes.c_bool, [OBXFeature])

objectbox/sync.py

@@ -311,3 +311,58 @@ def get_outgoing_message_count(self, limit: int = 0) -> int:
         outgoing_message_count = ctypes.c_uint64(0)
         c.obx_sync_outgoing_message_count(self.__c_sync_client_ptr, limit, ctypes.byref(outgoing_message_count))
         return outgoing_message_count.value
+
+
+class Sync:
+    __sync_clients: dict[Store, SyncClient] = {}
+
+    @staticmethod
+    def is_available() -> bool:
+        return c.obx_has_feature(c.Feature.Sync)
+
+    @staticmethod
+    def client(
+            store: Store,
+            server_url: str,
+            credential: SyncCredentials,
+            filter_variables: dict[str, str] | None = None
+    ) -> SyncClient:
+        client = SyncClient(store, [server_url], filter_variables)
+        client.set_credentials(credential)
+        return client
+
+    @staticmethod
+    def client_multi_creds(
+            store: Store,
+            server_url: str,
+            credentials_list: list[SyncCredentials],
+            filter_variables: dict[str, str] | None = None
+    ) -> SyncClient:
+        client = SyncClient(store, [server_url], filter_variables)
+        client.set_multiple_credentials(credentials_list)
+        return client
+
+    @staticmethod
+    def client_multi_urls(
+            store: Store,
+            server_urls: list[str],
+            credential: SyncCredentials,
+            filter_variables: dict[str, str] | None = None
+    ) -> SyncClient:
+        client = SyncClient(store, server_urls, filter_variables)
+        client.set_credentials(credential)
+        return client
+
+    @staticmethod
+    def client_multi_creds_multi_urls(
+            store: Store,
+            server_urls: list[str],
+            credentials_list: list[SyncCredentials],
+            filter_variables: dict[str, str] | None = None
+    ) -> SyncClient:
+        if store in Sync.__sync_clients:
+            raise ValueError('Only one sync client can be active for a store')
+        client = SyncClient(store, server_urls, filter_variables)
+        client.set_multiple_credentials(credentials_list)
+        Sync.__sync_clients[store] = client
+        return client