pear-mobile 0.0.2 → 0.0.4

package/README.md

@@ -6,76 +6,117 @@ Embeddable Pear runtime for mobile applications. Provides storage path and bare
 npm install pear-mobile
 ```
 
-```sh
-npm install react-native-bare-kit --save
-```
+This module integrates Pear into React-Native-based Mobile applications.
 
-Requires `react-native-bare-kit` to be listed in project dependencies.
+See [pear-runtime](https://github.com/holepunchto/pear-runtime) for Pear's embeddable runtime module for Desktop Devices.
 
-## Usage
+## MVP - EXPERIMENTAL
 
-```js
-/* React Native */
-import PearRuntime from 'pear-mobile'
-import bundle from './worker.bundle.js'
-import { version, upgrade } from './package.json'
+This boilerplate is MVP and Experimental.
 
-const runtime = new PearRuntime()
-const IPC = runtime.run('/worker.bundle', bundle, [runtime.dir])
+## Usage
 
-/* Bare Worklet */
-const PearRuntime = require('pear-runtime')
+```js
+const PearRuntime = require('pear-mobile')
 const { version, upgrade } = require('./package.json')
 
-const dir = Bare.argv[0]
+const dir = Bare.argv[0] // pass the /Documents storage dir
 
 const runtime = new PearRuntime({ version, upgrade, dir })
-runtime.on('updated', () => {
-  runtime.applyUpdate()
+runtime.on('updated', async () => {
+  await runtime.applyUpdate()
   conosle.log('restart for update')
 })
 ```
 
+## Quick Starts
+
+### Expo
+
+```sh
+git clone https://github.com/holepunchto/hello-pear-react-native
+```
+
+For end-to-end instructions from building to deploying with [Pear](https://docs.pears.com) see [hello-pear-react-native](https://github.com/holepunchto/hello-pear-react-native) `README.md`.
+
+## Features
+
+- Peer-to-Peer Over-the-Air (P2P OTA) updates (via [pear-runtime-updater](https://www.github.com/holepunchto/pear-runtime-updater))
+- Application storage management
+
 ## API
 
-#### `const runtime = new PearRuntime(...)`
+Inherits from [pear-runtime-updater]{https://www.github.com/holepunchto/pear-runtime-updater}
+
+#### `const runtime = new PearRuntime(opts)`
 
-Create a runtime.
+Create a runtime. `opts` may include:
+
+- **`dir`** (required) Directory to store data (e.g. app data dir).
+- **`upgrade`** – (required) Pear link for OTA updates (e.g. from `package.json` `upgrade` field).
+- **`version`** – Current app version (e.g. from `package.json`); used for update checks.
+- **`app`** – Path to the native boot bundle override; required for `applyUpdate()` to swap in the new build. Defaults to `path/to/Documents/pear-runtime/upgrades`
+- **`updates`** – Set to `false` to disable P2P OTA updates.
+- **`storage`** – Saves the app storage path.
 
 #### `runtime.storage`
 
-Absolute path to the runtime app storage directory.
+Suggested storage folder for app storage.
+
+#### `pear.storage`
+
+Suggested storage folder for app storage.
+
+#### `pear.on('updating')`
 
-#### `runtime.on(event, callback)`
+Emitted when an update is in progress
 
-Subscribe to an event. Returns `runtime` for chaining.
+#### `updater.on('updating-delta', data)`
 
-#### `runtime.off(event, callback?)`
+Emitted with progress data while mirroring the update.
 
-Unsubscribe: remove `callback` for `event`, or remove all listeners for `event` if `callback` is omitted. Returns `runtime`.
+#### `pear.on('updated')`
 
-#### `runtime.once(event, callback)`
+Emitted when an update is done
 
-Subscribe to an event once; listener is removed after the first emit. Returns `runtime`.
+#### `await pear.applyUpdate()`
 
-#### `const IPC <stream.Duplex> = runtime.run(filename, bundle, argv)`
+Apply the update. Only valid post `updated`. On next app restart the new update is in effect.
 
-Start a bare worker (worklet). Returns an IPC duplex stream. `filename` is a virtual path, `bundle` is the worklet bundle, `argv` is an array of string arguments.
+#### `await pear.close()`
 
-`Bare.argv` in worker to access `argv`.
-`Bare.IPC` in worker to access stream.
+Shut it down. You should do this when closing your app for best performance.
 
-#### `runtime.ready()`
+## Making updates
 
-Returns a Promise. No-op on mobile; for API compatibility.
+VERY EXPERIMENTAL, MOST DEFINITELY WILL CHANGE.
 
-#### `runtime.close()`
+Update listening and apply logic lives in [pear-runtime-updater](https://www.github.com/holepunchto/pear-runtime-updater).
+
+First allocate a pear link if you haven't using [`pear`](https://github.com/holepunchto/pear):
+
+```sh
+pear touch
+```
 
-Returns a Promise. No-op on mobile; for API compatibility.
+Store this link in the `package.json` `upgrade` field of a project.
 
-#### `runtime.applyUpdate()`
+bundle your JS frontend. Take the distributable (e.g react-native bundle and assets) produced and make a deployment folder with the following structure:
+
+```
+/package.json
+/by-arch
+  /[...platform-arch]
+    /app
+```
+
+Now go to this folder and stage this onto the link with `pear stage`
+
+```sh
+pear stage {link-from-touch}
+```
 
-Returns a Promise. On mobile this is not supported and only logs a warning; for API compatibility.
+Now seed it. Any build out there on a lower version will trigger the update flow.
 
 ## LICENSE
 

package/index.js

@@ -1,10 +1,12 @@
 const PearRuntimeUpdater = require('pear-runtime-updater')
 const path = require('bare-path')
 const fs = require('bare-fs')
+const dir = require('bare-storage')
 
 module.exports = class PearRuntime extends PearRuntimeUpdater {
   constructor(opts = {}) {
-    const appPath = opts.app || path.join(opts.dir, 'pear-runtime/upgrade')
+    if (!opts.dir) opts.dir = dir.persistent()
+    const appPath = opts.app || path.join(opts.dir, 'pear-runtime', 'upgrade')
     if (!fs.existsSync(appPath)) fs.mkdirSync(appPath, { recursive: true, force: true })
     if (fs.existsSync(path.join(appPath, 'package.json'))) {
       const manifest = fs.readFileSync(path.join(appPath, 'package.json'))
@@ -12,5 +14,6 @@ module.exports = class PearRuntime extends PearRuntimeUpdater {
     }
     opts = { app: appPath, ...opts }
     super(opts)
+    this.storage = opts.storage || path.join(this.dir, 'app-storage')
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pear-mobile",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "Embeddable Pear runtime for mobile applications",
   "main": "index.js",
   "exports": {
@@ -40,6 +40,7 @@
   "dependencies": {
     "bare-fs": "^4.5.4",
     "bare-path": "^3.0.0",
-    "pear-runtime-updater": "^0.0.10"
+    "bare-storage": "^1.0.1",
+    "pear-runtime-updater": "^0.0.11"
   }
 }