start react-native-sqlite-plugin-support-dev

with React Native module support

for Android and iOS

based on custom React Native module generated by
reate-react-native-module 0.3.0
(known to be missing some needed components)

including initial demotestapp (missing React Native build artifacts,
dependencies & devDependencies updates needed)

TBD MISSING ReactNativeJson.java module which is needed to deal with
the background SQL batches on Android.

FUTURE TODO: it is desired to find a more efficient way to deal with
the background SQL batch objects, with a nicer abstraction
between Cordova and React Native.

FUTURE TODO: some of these changes should be cleaned up at some point

FUTURE TBD improve the abstraction of differences between
Cordova and React Native

Author: Christopher J. Brody

.gitattributes

@@ -0,0 +1 @@
+*.pbxproj -text

.gitignore

@@ -1,15 +1,51 @@
+# OSX
+#
 .DS_Store
 .metadata/*
 *.swp
 *~
 
-node_modules
+# node.js
+#
+node_modules/
 package-lock.json
+npm-debug.log
 yarn.lock
-
+yarn-error.log
 
 spec/myplugin
 spec/plugins
 spec/platforms
 
-*.xcworkspace
+# Xcode
+#
+build/
+*.pbxuser
+!default.pbxuser
+*.mode1v3
+!default.mode1v3
+*.mode2v3
+!default.mode2v3
+*.perspectivev3
+!default.perspectivev3
+xcuserdata
+*.xccheckout
+*.moved-aside
+DerivedData
+*.hmap
+*.ipa
+*.xcuserstate
+project.xcworkspace
+
+# Android/IntelliJ
+#
+build/
+.idea
+.gradle
+local.properties
+*.iml
+
+# BUCK
+buck-out/
+\.buckd/
+*.keystore

.npmignore

@@ -0,0 +1 @@
+demotestapp

CHANGES.md

@@ -1,5 +1,9 @@
 # Changes
 
+###### react-native-sqlite-plugin-support-dev 0.0.1-dev
+
+- Add React Native module support, based on custom React Native module generated by create-react-native-module 0.3.0 (known to be missing some needed components)
+
 ##### cordova-sqlite-storage-ext-commoncore 1.0.0
 
 - Some CoffeeScript / JavaScript updates

README.md

@@ -1,12 +1,17 @@
-# Cross-platform SQLite storage plugin for Cordova/PhoneGap - cordova-sqlite-storage plugin version
+# Cross-platform SQLite storage plugin for React Native - react-native-sqlite-plugin-support-dev version branch - known to be missing some needed components
 
 Native SQLite component with API based on HTML5/[Web SQL (DRAFT) API](http://www.w3.org/TR/webdatabase/) for the following platforms:
 - Android
 - iOS
+
+Platforms not supported by this version branch:
+
 - macOS ("osx" platform)
 - Windows 10 (UWP) DESKTOP and MOBILE (see below for major limitations)
 
+<!-- FUTURE TBD:
 Browser platform is currently supported with some limitations as described in [browser platform usage notes](#browser-platform-usage-notes) section below, will be supported with more features such as numbered parameters and SQL batch API in the near future.
+- -->
 
 **LICENSE:** MIT (see [LICENSE.md](./LICENSE.md) for details, including third-party components used by this plugin)
 
@@ -16,6 +21,69 @@ __WARNING: Multiple SQLite problem on all platforms__ _with possible corruption
 
 The primary author and maintainer [@brodybits (Chris Brody)](https://github.com/brodybits) is happy to offer free consulting for a limited time period - please see <https://xpbrew.consulting> for more information.
 
+<!-- Installation & usage instructions as generated: -->
+
+# Getting started on React Native
+
+`$ npm install react-native-sqlite-plugin-support-dev --save`
+
+### Mostly automatic installation
+
+`$ react-native link react-native-sqlite-plugin-support-dev`
+
+### Manual installation
+
+NOTE THAT MANUAL INSTALLATION OF THIS REACT NATIVE MODULE IS NOT TESTED AND NOT SUPPORTED.
+
+#### iOS
+
+1. In XCode, in the project navigator, right click `Libraries` ➜ `Add Files to [your project's name]`
+2. Go to `node_modules` ➜ `react-native-sqlite-plugin-support-dev` and add `SQLiteSupport.xcodeproj`
+3. In XCode, in the project navigator, select your project. Add `libSQLiteSupport.a` to your project's `Build Phases` ➜ `Link Binary With Libraries`
+4. Run your project (`Cmd+R`)<
+
+#### Android
+
+1. Open up `android/app/src/main/java/[...]/MainApplication.java`
+  - Add `import io.sqlc.SQLiteSupportPackage;` to the imports at the top of the file
+  - Add `new SQLiteSupportPackage()` to the list returned by the `getPackages()` method
+
+2. Append the following lines to `android/settings.gradle`:
+
+```
+include ':react-native-sqlite-plugin-support-dev'
+project(':react-native-sqlite-plugin-support-dev').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-sqlite-plugin-support-dev/android')
+```
+
+3. Insert the following lines inside the dependencies block in `android/app/build.gradle`:
+
+```
+compile project(':react-native-sqlite-plugin-support-dev')
+```
+
+# Usage
+
+```javascript
+import sqlitePlugin from 'react-native-sqlite-plugin-support-dev';
+
+const db = sqlitePlugin.openDatabase({name:'demo.db', location: 'default'});
+
+db.transaction((tx) => {
+  tx.executeSql('SELECT UPPER(?) as upperText', ['Some ASCII text'], (tx, rs) => {
+    this.setState({
+      ...this.state,
+      upperText: rs.rows.item(0).upperText
+    });
+  });
+});
+```
+
+# Original documentation from Cordova
+
+**IMPORTANT NOTICE:** On React Native the `sqlitePlugin` object must be imported as documented above and used instead of `window.sqlitePlugin`. And there is no `deviceready` event to wait for on React Native.
+
+DOC TODO: UPDATE DOCUMENTATION BELOW TO REFLECT CORRECT IMPORT AND USE OF THE CORRECT API OBJECT AND NO DEVICE READY EVENT
+
 ## NEW MAJOR RELEASE Coming with BREAKING CHANGES
 
 A new major release is planned as discussed in ([xpbrew/cordova-sqlite-storage#773](https://github.com/xpbrew/cordova-sqlite-storage/issues/773)).

SQLitePlugin.coffee.md

@@ -6,9 +6,9 @@
 
 # Top-level SQLite plugin objects
 
-## root window object:
+## imported exec utility object:
 
-    root = @
+    SQLiteSupport = require('./SQLiteSupport.js').default
 
 ## constant(s):
 
@@ -79,7 +79,8 @@
 
     getProxyFunction = (methodName) ->
       (argsArray, successCallback, errorCallback) ->
-        cordova.exec successCallback, errorCallback, 'SQLitePlugin', methodName, argsArray
+        SQLiteSupport[methodName] argsArray, successCallback, errorCallback || -> return
+        return
 
     SQLiteProxy =
       echoStringValue: getProxyFunction 'echoStringValue'
@@ -1043,7 +1044,10 @@
       openDatabase: SQLiteFactory.openDatabase
       deleteDatabase: SQLiteFactory.deleteDatabase
 
-    root.sqlitePlugin = sqlitePlugin
+      # keep for initial testing purposes
+      sampleMethod: SQLiteSupport.sampleMethod
+
+    module.exports = sqlitePlugin
 
 ## vim directives
 

SQLiteSupport.podspec

@@ -0,0 +1,25 @@
+require "json"
+
+package = JSON.parse(File.read(File.join(__dir__, "package.json")))
+
+Pod::Spec.new do |s|
+  s.name         = "SQLiteSupport"
+  s.version      = package["version"]
+  s.summary      = package["description"]
+  s.description  = <<-DESC
+                  SQLiteSupport
+                   DESC
+  s.homepage     = "https://github.com/author/SQLiteSupport"
+  s.license      = "MIT"
+  # s.license    = { :type => "MIT", :file => "FILE_LICENSE" }
+  s.author       = { "author" => "author@domain.cn" }
+  s.platform     = :ios, "7.0"
+  s.source       = { :git => "https://github.com/author/SQLiteSupport.git", :tag => "#{s.version}" }
+
+  s.source_files = "ios/**/*.{h,m}"
+  s.requires_arc = true
+
+  s.dependency "React"
+  #s.dependency "others"
+end
+

android/README.md

@@ -0,0 +1,14 @@
+README
+======
+
+If you want to publish the lib as a maven dependency, follow these steps before publishing a new version to npm:
+
+1. Be sure to have the Android [SDK](https://developer.android.com/studio/index.html) and [NDK](https://developer.android.com/ndk/guides/index.html) installed
+2. Be sure to have a `local.properties` file in this folder that points to the Android SDK and NDK
+```
+ndk.dir=/Users/{username}/Library/Android/sdk/ndk-bundle
+sdk.dir=/Users/{username}/Library/Android/sdk
+```
+3. Delete the `maven` folder
+4. Run `sudo ./gradlew installArchives`
+5. Verify that latest set of generated files is in the maven folder with the correct version number

android/build.gradle

@@ -0,0 +1,129 @@
+buildscript {
+    repositories {
+        google()
+        jcenter()
+    }
+
+    dependencies {
+        // Matches the RN Hello World template
+        // https://github.com/facebook/react-native/blob/1e8f3b11027fe0a7514b4fc97d0798d3c64bc895/local-cli/templates/HelloWorld/android/build.gradle#L8
+        classpath 'com.android.tools.build:gradle:3.2.1'
+    }
+}
+
+apply plugin: 'com.android.library'
+apply plugin: 'maven'
+
+def safeExtGet(prop, fallback) {
+    rootProject.ext.has(prop) ? rootProject.ext.get(prop) : fallback
+}
+
+def DEFAULT_COMPILE_SDK_VERSION = 28
+def DEFAULT_BUILD_TOOLS_VERSION = "28.0.2"
+def DEFAULT_MIN_SDK_VERSION = 16
+def DEFAULT_TARGET_SDK_VERSION = 27
+
+android {
+  compileSdkVersion safeExtGet('compileSdkVersion', DEFAULT_COMPILE_SDK_VERSION)
+  buildToolsVersion safeExtGet('buildToolsVersion', DEFAULT_BUILD_TOOLS_VERSION)
+
+  defaultConfig {
+    minSdkVersion safeExtGet('minSdkVersion', DEFAULT_MIN_SDK_VERSION)
+    targetSdkVersion safeExtGet('targetSdkVersion', DEFAULT_TARGET_SDK_VERSION)
+    versionCode 1
+    versionName "1.0"
+  }
+  lintOptions {
+    abortOnError false
+  }
+}
+
+repositories {
+    maven {
+        // All of React Native (JS, Obj-C sources, Android binaries) is installed from npm
+        // Matches the RN Hello World template
+        // https://github.com/facebook/react-native/blob/1e8f3b11027fe0a7514b4fc97d0798d3c64bc895/local-cli/templates/HelloWorld/android/build.gradle#L21
+        url "$projectDir/../node_modules/react-native/android"
+    }
+    mavenCentral()
+}
+
+dependencies {
+    compile 'com.facebook.react:react-native:+'
+
+    // THANKS to @andpor (Andrzej Porebski)
+    // https://github.com/andpor
+    compile files('../../cordova-sqlite-storage-dependencies/libs/sqlite-connector.jar')
+    compile files('../../cordova-sqlite-storage-dependencies/libs/sqlite-native-driver.jar')
+}
+
+def configureReactNativePom(def pom) {
+    def packageJson = new groovy.json.JsonSlurper().parseText(file('../package.json').text)
+
+    pom.project {
+        name packageJson.title
+        artifactId packageJson.name
+        version = packageJson.version
+        group = "io.sqlc"
+        description packageJson.description
+        url packageJson.repository.baseUrl
+
+        licenses {
+            license {
+                name packageJson.license
+                url packageJson.repository.baseUrl + '/blob/master/' + packageJson.licenseFilename
+                distribution 'repo'
+            }
+        }
+
+        developers {
+            developer {
+                id packageJson.author.username
+                name packageJson.author.name
+            }
+        }
+    }
+}
+
+afterEvaluate { project ->
+
+    task androidJavadoc(type: Javadoc) {
+        source = android.sourceSets.main.java.srcDirs
+        classpath += files(android.bootClasspath)
+        classpath += files(project.getConfigurations().getByName('compile').asList())
+        include '**/*.java'
+    }
+
+    task androidJavadocJar(type: Jar, dependsOn: androidJavadoc) {
+        classifier = 'javadoc'
+        from androidJavadoc.destinationDir
+    }
+
+    task androidSourcesJar(type: Jar) {
+        classifier = 'sources'
+        from android.sourceSets.main.java.srcDirs
+        include '**/*.java'
+    }
+
+    android.libraryVariants.all { variant ->
+        def name = variant.name.capitalize()
+        task "jar${name}"(type: Jar, dependsOn: variant.javaCompile) {
+            from variant.javaCompile.destinationDir
+        }
+    }
+
+    artifacts {
+        archives androidSourcesJar
+        archives androidJavadocJar
+    }
+
+    task installArchives(type: Upload) {
+        configuration = configurations.archives
+        repositories.mavenDeployer {
+            // Deploy to react-native-event-bridge/maven, ready to publish to npm
+            repository url: "file://${projectDir}/../android/maven"
+
+            configureReactNativePom pom
+        }
+    }
+}

android/src/main/AndroidManifest.xml

@@ -0,0 +1,4 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+          package="io.sqlc">
+
+</manifest>