@openwallet-foundation/askar-shared 0.3.1 → 0.3.2-alpha-20250205012009

package/README.md

@@ -1,6 +1,8 @@
 # Askar Shared
 
-This package does not contain any functionality, just the classes and types that wrap around the native NodeJS / React Native functionality
+This package does not contain any functionality, just the classes and types that wrap around the native NodeJS / React Native functionality.
+
+See the [project README](https://github.com/openwallet-foundation/askar-wrapper-javascript) for version compatability between Askar and this JavaScript Wrapper.
 
 ## Platform independent setup
 
@@ -10,35 +12,26 @@ Before calling any methods you then need to make sure you register the platform
 
 ```typescript
 // register.ts
-import '@openwallet-foundation/askar-nodejs'
+import "@openwallet-foundation/askar-nodejs";
 ```
 
 ```typescript
 // register.native.ts
-import '@openwallet-foundation/askar-react-native'
+import "@openwallet-foundation/askar-react-native";
 ```
 
 An alterative approach is to first try to require the Node.JS package, and otherwise require the React Native package:
 
 ```typescript
 try {
-  require('@openwallet-foundation/askar-nodejs')
+  require("@openwallet-foundation/askar-nodejs");
 } catch (error) {
   try {
-    require('@openwallet-foundation/askar-react-native')
+    require("@openwallet-foundation/askar-react-native");
   } catch (error) {
-    throw new Error('Could not load Askar bindings')
+    throw new Error("Could not load Askar bindings");
   }
 }
 ```
 
 How you approach it is up to you, as long as the native binding are called before any actions are performed on the Askar library.
-
-## 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.0, v0.1.1     |
-| v0.3.1      | v0.2.0             |

package/build/askar/Askar.d.ts

@@ -210,7 +210,7 @@ export type ScanNextOptions = {
 };
 export type ScanStartOptions = {
     storeHandle: StoreHandle;
-    category: string;
+    category?: string;
     profile?: string;
     tagFilter?: Record<string, unknown>;
     offset?: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openwallet-foundation/askar-shared",
-  "version": "0.3.1",
+  "version": "0.3.2-alpha-20250205012009",
   "license": "Apache-2.0",
   "description": "Shared library for using Askar with NodeJS and React Native",
   "main": "build/index",
@@ -17,20 +17,18 @@
     "access": "public"
   },
   "files": [
-    "build",
-    "../../LICENSE"
+    "build"
   ],
-  "scripts": {
-    "types:check": "pnpm compile --noEmit",
-    "build": "pnpm clean && pnpm compile",
-    "clean": "rimraf -rf ./build",
-    "compile": "tsc -p ./tsconfig.build.json"
-  },
   "dependencies": {
     "buffer": "^6.0.3"
   },
   "devDependencies": {
     "typescript": "~5.4.5"
   },
-  "gitHead": "7e626433903c6e138ec6354e3e15447d7056a5f2"
-}
+  "scripts": {
+    "types:check": "pnpm compile --noEmit",
+    "build": "pnpm clean && pnpm compile",
+    "clean": "rimraf -rf ./build",
+    "compile": "tsc -p ./tsconfig.build.json"
+  }
+}