@openwallet-foundation/askar-react-native 0.3.1 → 0.3.2-alpha-20250205012009

package/README.md

@@ -1,12 +1,12 @@
 # Askar React Native
 
-Wrapper for React Native around Askar
+Wrapper for React Native around Askar.
+
+See the [project README](https://github.com/openwallet-foundation/askar-wrapper-javascript) for version compatability between Askar and this JavaScript Wrapper.
 
 ## Requirements
 
-This module uses the new React Native Turbo Modules. These are faster than the
-previous Native Modules, and can be completely synchronous. A React Native
-version of `>= 0.66.0` is required for this package to work.
+This library requires and has been tested with React Native version `0.75.x` and `0.76.x`. Newer versions might also work, but they have not been tested.
 
 ## Installation
 
@@ -19,20 +19,10 @@ yarn add @openwallet-foundation/askar-react-native
 You can import all types and classes from the `@openwallet-foundation/askar-react-native` library:
 
 ```typescript
-import { Key, KeyAlgs } from '@openwallet-foundation/askar-react-native'
+import { Key, KeyAlgs } from "@openwallet-foundation/askar-react-native";
 
-const seed = Uint8Array.from(Buffer.from('testseed000000000000000000000001'))
-const key = Key.fromSeed({ algorithm: KeyAlgs.Bls12381G1, seed })
+const seed = Uint8Array.from(Buffer.from("testseed000000000000000000000001"));
+const key = Key.fromSeed({ algorithm: KeyAlgs.Bls12381G1, seed });
 ```
 
 > **Note**: If you want to use this library in a cross-platform environment you need to import methods from the `@openwallet-foundation/askar-shared` package instead. This is a platform independent package that allows to register the native bindings. The `@openwallet-foundation/askar-react-native` package uses this package under the hood. See the [Askar Shared README](https://github.com/openwallet-foundation/askar-wrapper-javascript/tree/main/packages/askar-shared/README.md) for documentation on how to use this package.
-
-## Version Compatibility
-
-The JavaScript wrapper is versioned independently from the native bindings. The following table shows the compatibility between the different versions:
-
-| Askar       | JavaScript Wrapper |
-| ----------- | ------------------ |
-| v0.2.9      | v0.1.x             |
-| v0.3.x      | v0.2.x             |
-| v0.4.1      | v0.3.x             |

package/cpp/askar.cpp

@@ -238,10 +238,10 @@ jsi::Value storeRekey(jsi::Runtime &rt, jsi::Object options) {
   State *state = new State(&cb);
   state->rt = &rt;
 
-  ErrorCode code = askar_store_rekey(storeHandle, 
-      keyMethod.length() ? keyMethod.c_str() : nullptr, 
+  ErrorCode code = askar_store_rekey(storeHandle,
+      keyMethod.length() ? keyMethod.c_str() : nullptr,
       passKey.c_str(), callback, CallbackId(state));
-                            
+
   return createReturnValue(rt, code, nullptr);
 }
 
@@ -350,7 +350,7 @@ jsi::Value sessionFetchAll(jsi::Runtime &rt, jsi::Object options) {
   state->rt = &rt;
 
   ErrorCode code = askar_session_fetch_all(
-      sessionHandle, 
+      sessionHandle,
       category.c_str(),
       tagFilter.length() ? tagFilter.c_str() : nullptr,
       limit,
@@ -518,7 +518,7 @@ jsi::Value sessionUpdateKey(jsi::Runtime &rt, jsi::Object options) {
 
 jsi::Value scanStart(jsi::Runtime &rt, jsi::Object options) {
   auto storeHandle = jsiToValue<int64_t>(rt, options, "storeHandle");
-  auto category = jsiToValue<std::string>(rt, options, "category");
+  auto category = jsiToValue<std::string>(rt, options, "category", true);
 
   auto tagFilter = jsiToValue<std::string>(rt, options, "tagFilter", true);
   auto profile = jsiToValue<std::string>(rt, options, "profile", true);
@@ -532,12 +532,12 @@ jsi::Value scanStart(jsi::Runtime &rt, jsi::Object options) {
   state->rt = &rt;
 
   ErrorCode code = askar_scan_start(
-      storeHandle, 
+      storeHandle,
       profile.length() ? profile.c_str() : nullptr,
-      category.c_str(), 
+      category.length() ? category.c_str() : nullptr,
       tagFilter.length() ? tagFilter.c_str() : nullptr,
-      offset, 
-      limit, 
+      offset,
+      limit,
       orderBy.length() ? orderBy.c_str() : nullptr,
       descending,
       callbackWithResponse,
@@ -636,9 +636,9 @@ jsi::Value keyGenerate(jsi::Runtime &rt, jsi::Object options) {
   LocalKeyHandle out;
 
   ErrorCode code = askar_key_generate(
-      algorithm.c_str(), 
-      keyBackend.length() ? keyBackend.c_str() : nullptr, 
-      ephemeral, 
+      algorithm.c_str(),
+      keyBackend.length() ? keyBackend.c_str() : nullptr,
+      ephemeral,
       &out
   );
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openwallet-foundation/askar-react-native",
-  "version": "0.3.1",
+  "version": "0.3.2-alpha-20250205012009",
   "license": "Apache-2.0",
   "description": "React Native wrapper for Askar",
   "main": "build/index",
@@ -28,16 +28,9 @@
     "cpp/**/*.h",
     "askar.podspec"
   ],
-  "scripts": {
-    "types:check": "pnpm compile --noEmit",
-    "build": "pnpm clean && pnpm compile",
-    "clean": "rimraf -rf ./build",
-    "compile": "tsc -p ./tsconfig.build.json",
-    "install": "node-pre-gyp install"
-  },
   "dependencies": {
     "@mapbox/node-pre-gyp": "^1.0.11",
-    "@openwallet-foundation/askar-shared": "0.3.1"
+    "@openwallet-foundation/askar-shared": "0.3.2-alpha-20250205012009"
   },
   "devDependencies": {
     "react": "18.2.0",
@@ -55,5 +48,11 @@
     "host": "https://github.com/openwallet-foundation/askar/releases/download/",
     "package_name": "library-ios-android.tar.gz"
   },
-  "gitHead": "7e626433903c6e138ec6354e3e15447d7056a5f2"
-}
+  "scripts": {
+    "types:check": "pnpm compile --noEmit",
+    "build": "pnpm clean && pnpm compile",
+    "clean": "rimraf -rf ./build",
+    "compile": "tsc -p ./tsconfig.build.json",
+    "install": "node-pre-gyp install"
+  }
+}