Himanshu-Mishr / react-native-webkit-localstorage-reader

A react-native wrapper for reading existing localstorage created by apps built with cordova/phonegap.

react-native-webkit-localstorage-reader

A react-native wrapper for reading existing localstorage created by apps built with cordova/phonegap. This is useful if you built an app in cordova/phonegap (a webkit app) and now want access the localstorage from previous versions of the app in react native.

BREAKING CHANGES:

Version 2.0 added Android support and the returned value is not a string, but an object. This is the same object you would get when using localStorage from a web browser.

How it works

This module reads the localstorage file stored in Library/WebKit/LocalStorage/file__0.localstorage for iOS and app_webview/Local Storage/file__0.localstorage for Android. It cycles through all the entries and compiles the keys and values into a json object.

{
  "key1": "value1",
  "key2": "value2",
  "key3": "value3",
  "key4": "value4",
  ...
}

Installation

iOS

1. Run npm install react-native-webkit-localstorage-reader --save.

2. Open your project in XCode, right click on Libraries, click Add Files to "Your Project Name" and add WebkitLocalStorageReader.xcodeproj. (situated in node_modules/react-native-webkit-localstorage-reader) (This then this, just with WebkitLocalStorageReader).

3. Link libWebkitLocalStorageReader.a and libsqlite3.tbd with your Libraries. To do that, click on your project folder, select Build Phases in the top bar, scroll to Link Binary with Libraries, press the + at the very bottom and add libWebkitLocalStorageReader.a from the node_modules/react-native-webkit-localstorage-reader/WebkitLocalStorageReader folder then libsqlite3.tbd (tip: search for sql and make sure you add libsqlite3.tbd and NOT libsqlite3.0.tbd). (Screenshot).

4. Whenever you want to use it within React code now you just have to do: var WebkitLocalStorageReader = require('NativeModules').WebkitLocalStorageReader;

Android

• Add the following lines to android/settings.gradle:

include ':react-native-webkit-localstorage-reader'
project(':react-native-webkit-localstorage-reader').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-webkit-localstorage-reader/android')

• Update your dependencies in android/app/build.gradle with:

dependencies {
  ...
  compile project(':react-native-webkit-localstorage-reader')
}

• Be sure to have new WebkitLocalStorageReaderPackage() in your MainApplication.java

import io.github.wootwoot1234.WebkitLocalStorageReaderPackage;
...
@Override
     protected List<ReactPackage> getPackages() {
         return Arrays.<ReactPackage>asList(
                 new MainReactPackage(),
                 new WebkitLocalStorageReaderPackage()
         );
     }

API

Read Localstorage

// you have session => { SESSION } in your localstorage
import { WebkitLocalStorageReader } from 'NativeModules';

const localStorage = await WebkitLocalStorageReader.get();

Testing

To test make sure you install the new version of the app on top of an existing version (make sure the Bundle Identifiers match). There will be no localstorage file if you try to run this code in a brand new app or an app that wasn't previously opened as a cordova/phonegap app.

Notes

• Please feel free to fork and add features or fix bugs and send me a pull request. Thanks!