capacitor-secure-storage-plugin 0.8.0 → 0.9.0

package/README.md

@@ -4,33 +4,45 @@ Capacitor plugin for storing string values securly on iOS and Android.
 
 ## How to install
 
-For Capacitor v3
+For Capacitor v5
 
-```
+```bash
 npm install capacitor-secure-storage-plugin
 ```
 
-For Capacitor v2 - install with fixed version 0.5.1
+For Capacitor v4 - install with fixed version 0.8.1
+
+```bash
+npm install capacitor-secure-storage-plugin@0.8.1
+```
+
+For Capacitor v3 - install with fixed version 0.7.1
 
+```bash
+npm install capacitor-secure-storage-plugin@0.7.1
 ```
+
+For Capacitor v2 - install with fixed version 0.5.1
+
+```bash
 npm install capacitor-secure-storage-plugin@0.5.1
 ```
 
 ## Usage
 
-For Capacitor v3
+### For Capacitor v3 & v4
 
 In a component where you want to use this plugin add to or modify imports:
 
-```
+```jsx
 import { SecureStoragePlugin } from 'capacitor-secure-storage-plugin';
 ```
 
-For Capacitor v2
+### For Capacitor v2
 
 In a component where you want to use this plugin add to or modify imports:
 
-```
+```jsx
 import 'capacitor-secure-storage-plugin';
 import { Plugins } from '@capacitor/core';
 
@@ -39,13 +51,13 @@ const { SecureStoragePlugin } = Plugins;
 
 First line is needed because of web part of the plugin (current behavior of Capacitor, this may change in future releases).
 
-### Android
+#### Capacitor V2 - Android
 
 In Android with Capacitor v2 you have to register plugins manually in MainActivity class of your app.
 
-https://capacitorjs.com/docs/v2/plugins/android#export-to-capacitor
+[How to register plugins for Capacitor V2](https://capacitorjs.com/docs/v2/plugins/android#export-to-capacitor)
 
-```
+```ts
 import com.whitestein.securestorage.SecureStoragePlugin;
 
 ...
@@ -67,31 +79,75 @@ public class MainActivity extends BridgeActivity {
 
 ## Methods
 
-- **get**(options: { key: string }): Promise<{ value: string }>
-  - if item with specified key does not exist, throws an Error
+```ts
 
-* **keys**(): Promise<{ value: string[] }>
-* **set**(options: { key: string; value: string }): Promise<{ value: boolean }>
-  - return true in case of success otherwise throws an error
-* **remove**(options: { key: string }): Promise<{ value: boolean }>
-  - return true in case of success otherwise throws an error
-* **clear**(): Promise<{ value: boolean }>
-  - return true in case of success otherwise throws an error
+get(options: { key: string }): Promise<{ value: string }>
 
-- **getPlatform**(): Promise<{ value: string }>
-  - returns which implementation is used - one of 'web', 'ios' or 'android'
+```
 
-## Example
+> **Note**
+> if item with specified key does not exist, throws an Error
+
+---
+
+```ts
+
+set(options: { key: string; value: string }): Promise<{ value: boolean }>
+
+```
+
+> **Note**
+> return true in case of success otherwise throws an error
+
+---
+
+```ts
+
+remove(options: { key: string }): Promise<{ value: boolean }>
 
 ```
+
+> **Note**
+> return true in case of success otherwise throws an error
+
+---
+
+```ts
+keys(): Promise<{ value: string[] }>
+```
+
+---
+
+```ts
+
+  clear(): Promise<{ value: boolean }>
+
+```
+
+> **Note**
+> return true in case of success otherwise throws an error
+
+---
+
+```ts
+
+getPlatform(): Promise<{ value: string }>
+
+```
+
+> **Note**
+> return returns which implementation is used - one of 'web', 'ios' or 'android'
+
+## Example
+
+```ts
 const key = 'username';
 const value = 'hellokitty2';
 
-SecureStoragePlugin.set({ key, value })
-  .then(success => console.log(success))
+SecureStoragePlugin.set({ key, value }).then(success => console.log(success));
 ```
 
-```
+```ts
 const key = 'username';
 SecureStoragePlugin.get({ key })
   .then(value => {
@@ -102,7 +158,7 @@ SecureStoragePlugin.get({ key })
   });
 ```
 
-```
+```ts
 async getUsername(key: string) {
   return await SecureStoragePlugin.get({ key });
 }
@@ -114,17 +170,15 @@ async getUsername(key: string) {
 
 This plugin uses SwiftKeychainWrapper under the hood for iOS.
 
-##### Warning
-
-Up to version v0.4.0 there was standard keychain used. Since v0.5.0 there is separate keychain wrapper, so keys() method returns only keys set in v0.5.0 or higher version.
+> **Warning**
+> Up to version v0.4.0 there was standard keychain used. Since v0.5.0 there is separate keychain wrapper, so keys() method returns only keys set in v0.5.0 or higher version.
 
 ### Android
 
 On Android it is implemented by AndroidKeyStore and SharedPreferences. Source: [Apriorit](https://www.apriorit.com/dev-blog/432-using-androidkeystore)
 
-##### Warning
-
-For Android API < 18 values are stored as simple base64 encoded strings.
+> **Warning**
+> For Android API < 18 values are stored as simple base64 encoded strings.
 
 ### Web
 

package/android/build.gradle

@@ -1,8 +1,8 @@
 ext {
     junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.2'
-    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.4.2'
-    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.1.3'
-    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.4.0'
+    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.6.1'
+    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.1.5'
+    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.5.1'
 }
 
 buildscript {
@@ -11,17 +11,18 @@ buildscript {
         mavenCentral()
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:7.2.1'
+        classpath 'com.android.tools.build:gradle:8.0.0'
     }
 }
 
 apply plugin: 'com.android.library'
 
 android {
-    compileSdkVersion project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 32
+    namespace "com.whitestein.securestorage"
+    compileSdkVersion project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 33
     defaultConfig {
         minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 22
-        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 32
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 33
         versionCode 1
         versionName "1.0"
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
@@ -36,8 +37,8 @@ android {
         abortOnError false
     }
     compileOptions {
-        sourceCompatibility JavaVersion.VERSION_11
-        targetCompatibility JavaVersion.VERSION_11
+        sourceCompatibility JavaVersion.VERSION_17
+        targetCompatibility JavaVersion.VERSION_17
     }
 }
 

package/android/src/main/AndroidManifest.xml

@@ -1,3 +1,3 @@
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
-    package="com.whitestein.securestorage">
+    >
 </manifest>

package/ios/Plugin/SecureStoragePluginPlugin.swift

@@ -84,24 +84,32 @@ public class SecureStoragePlugin: CAPPlugin {
     @objc func clear(_ call: CAPPluginCall) {
         let keys = keychainwrapper.allKeys();
         // cleanup standard keychain wrapper keys
-        for key in keys {
-            let hasValueStandard = KeychainWrapper.standard.hasValue(forKey: key)
-            if (hasValueStandard) {
-                let removeStandardSuccessful = KeychainWrapper.standard.removeObject(forKey: key)
-                if (!removeStandardSuccessful) {
-                    call.reject("error")
-                }
-            }
-        }
         
-        let clearSuccessful: Bool = keychainwrapper.removeAllKeys()
-        if(clearSuccessful) {
+        if(keys.count == 0) {
             call.resolve([
-                "value": clearSuccessful
+                "value": true
             ])
         }
-        else {
-            call.reject("error")
+        else {            
+            for key in keys {
+                let hasValueStandard = KeychainWrapper.standard.hasValue(forKey: key)
+                if (hasValueStandard) {
+                    let removeStandardSuccessful = KeychainWrapper.standard.removeObject(forKey: key)
+                    if (!removeStandardSuccessful) {
+                        call.reject("error")
+                    }
+                }
+            }
+            
+            let clearSuccessful: Bool = keychainwrapper.removeAllKeys()
+            if(clearSuccessful) {
+                call.resolve([
+                    "value": clearSuccessful
+                ])
+            }
+            else {
+                call.reject("error")
+            }
         }
     }
     

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "capacitor-secure-storage-plugin",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "description": "Securely store secrets such as usernames, passwords, tokens, certificates or other sensitive information (strings) on iOS & Android",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
@@ -44,10 +44,11 @@
     "prepublishOnly": "npm run build"
   },
   "devDependencies": {
-    "@capacitor/android": "^4.0.0",
-    "@capacitor/core": "^4.0.0",
+    "@capacitor/android": "^5.0.0",
+    "@capacitor/cli": "^5.0.0",
+    "@capacitor/core": "^5.0.0",
     "@capacitor/docgen": "^0.2.0",
-    "@capacitor/ios": "^4.0.0",
+    "@capacitor/ios": "^5.0.0",
     "@ionic/eslint-config": "^0.3.0",
     "@ionic/prettier-config": "^1.0.1",
     "@ionic/swiftlint-config": "^1.1.2",
@@ -60,7 +61,7 @@
     "typescript": "~4.0.3"
   },
   "peerDependencies": {
-    "@capacitor/core": "^4.0.0"
+    "@capacitor/core": "^5.0.0"
   },
   "prettier": "@ionic/prettier-config",
   "swiftlint": "@ionic/swiftlint-config",