pear-mobile 0.0.1 → 0.0.3

package/README.md

@@ -6,63 +6,93 @@ 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
 
 ```js
-import PearRuntime from 'pear-mobile'
-import bundle from './worker.bundle.js'
+const PearRuntime = require('pear-mobile')
+const { version, upgrade } = require('./package.json')
 
-const runtime = new PearRuntime()
-const appStorage = runtime.storage
+const dir = Bare.argv[0] // pass the /Documents storage dir
 
-const IPC = runtime.run('/worker.bundle', bundle, [appStorage])
+const runtime = new PearRuntime({ version, upgrade, dir })
+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}
 
-Create a runtime.
+#### `const runtime = new PearRuntime(opts)`
 
-#### `runtime.storage`
+Create a runtime. `opts` may include:
 
-Absolute path to the runtime app storage directory.
+- **`dir`** (required) – Base directory for runtime data and app storage.
+- **`version`** – Current app version (e.g. from `package.json`); used for update checks.
+- **`upgrade`** – Pear link for OTA updates (e.g. from `package.json` `upgrade` field).
+- **`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.on(event, callback)`
+#### `runtime.storage`
 
-Subscribe to an event. Returns `runtime` for chaining.
+Suggested storage folder for app storage.
 
-#### `runtime.off(event, callback?)`
+#### `await runtime.close()`
 
-Unsubscribe: remove `callback` for `event`, or remove all listeners for `event` if `callback` is omitted. Returns `runtime`.
+Shut it down. You should do this when closing your app for best performance.
 
-#### `runtime.once(event, callback)`
+## Making updates
 
-Subscribe to an event once; listener is removed after the first emit. Returns `runtime`.
+VERY EXPERIMENTAL, MOST DEFINITELY WILL CHANGE.
 
-#### `IPC = runtime.run(filename, bundle, argv)`
+Update listening and apply logic lives in [pear-runtime-updater](https://www.github.com/holepunchto/pear-runtime-updater).
 
-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.
+First allocate a pear link if you haven't using [`pear`](https://github.com/holepunchto/pear):
 
-`Bare.argv` in worker to access `argv`.
+```sh
+pear touch
+```
 
-#### `runtime.ready()`
+Store this link in the `package.json` `upgrade` field of a project. See [example](./example/package.json).
 
-Returns a Promise. No-op on mobile; for API compatibility.
+bundle your JS frontend. Take the distributable (e.g react-native bundle and assets) produced and make a deployment folder with the following structure:
 
-#### `runtime.close()`
+```
+/package.json
+/by-arch
+  /[...platform-arch]
+    /app
+```
 
-Returns a Promise. No-op on mobile; for API compatibility.
+Now go to this folder and stage this onto the link with `pear stage`
 
-#### `runtime.applyUpdate()`
+```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,59 +1,17 @@
-const { Worklet } = require('react-native-bare-kit')
-const RNFS = require('react-native-fs')
-
-module.exports = class PearRuntime {
-  constructor(config = {}) {
-    this._listeners = Object.create(null)
-
-    this.version = config.version || 0
-    this.storage = `${RNFS.DocumentDirectoryPath}/pear-runtime/storage`
-    this.key = config.key
-    this.length = config.length
-    this.fork = config.fork || 0
-    this.link = 'pear://' + this.fork + '.' + this.length + '.' + this.key
-  }
-
-  async ready() {}
-  async close() {}
-
-  on(event, callback) {
-    if (!this._listeners[event]) this._listeners[event] = []
-    this._listeners[event].push(callback)
-    return this
-  }
-
-  off(event, callback) {
-    if (!this._listeners[event]) return this
-    if (callback) {
-      this._listeners[event] = this._listeners[event].filter((fn) => fn !== callback)
-    } else {
-      this._listeners[event] = []
-    }
-    return this
-  }
-
-  once(event, fn) {
-    const wrap = (...args) => {
-      this.off(event, wrap)
-      fn(...args)
+const PearRuntimeUpdater = require('pear-runtime-updater')
+const path = require('bare-path')
+const fs = require('bare-fs')
+
+module.exports = class PearRuntime extends PearRuntimeUpdater {
+  constructor(opts = {}) {
+    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'))
+      opts.version = JSON.parse(manifest).version
     }
-    return this.on(event, wrap)
-  }
-
-  emit(event, ...args) {
-    const list = this._listeners[event]
-    if (!list) return this
-    for (const fn of list) fn(...args)
-    return this
-  }
-
-  run(filename, bundle, argv) {
-    const worklet = new Worklet()
-    worklet.start(filename, bundle, argv)
-    return worklet.IPC
-  }
-
-  async applyUpdate() {
-    console.warn('PearRuntime: applyUpdate() not supported for mobile')
+    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.1",
+  "version": "0.0.3",
   "description": "Embeddable Pear runtime for mobile applications",
   "main": "index.js",
   "exports": {
@@ -13,14 +13,9 @@
   "files": [
     "package.json",
     "index.js",
-    "index.d.ts"
+    "index.d.ts",
+    "index.rn.js"
   ],
-  "devDependencies": {
-    "brittle": "^3.19.0",
-    "lunte": "^1.2.0",
-    "prettier": "^3.6.2",
-    "prettier-config-holepunch": "^2.0.0"
-  },
   "scripts": {
     "format": "prettier . --write",
     "test": "prettier . --check && lunte && brittle-bare test/index.js",
@@ -36,7 +31,15 @@
     "url": "https://github.com/holepunchto/pear-mobile/issues"
   },
   "homepage": "https://github.com/holepunchto/pear-mobile",
+  "devDependencies": {
+    "brittle": "^3.19.0",
+    "lunte": "^1.2.0",
+    "prettier": "^3.6.2",
+    "prettier-config-holepunch": "^2.0.0"
+  },
   "dependencies": {
-    "react-native-fs": "^2.20.0"
+    "bare-fs": "^4.5.4",
+    "bare-path": "^3.0.0",
+    "pear-runtime-updater": "^0.0.10"
   }
 }