@dittolive/ditto 4.4.5 → 4.5.0

package/DittoReactNative.podspec

@@ -0,0 +1,27 @@
+# Podspec *must* be located at package root level or it will not be find for React
+# Native's autolinking.
+require "json"
+require_relative 'react-native/scripts/ruby/include_local_boost.rb'
+
+package = JSON.parse(File.read(File.join(__dir__, "package.json")))
+
+Pod::Spec.new do |s|
+  s.name         = "DittoReactNative"
+  s.version      = package["version"]
+  s.summary      = package["description"]
+  s.homepage     = package["homepage"]
+  s.license      = package["license"]
+  s.authors      = package["author"]
+
+  s.platforms    = { :ios => "14.0" }
+
+  s.source = { :http => 'https://software.ditto.live/react-native/ditto/4.5.0/ios/DittoReactNative.xcframework.tar.gz' }
+  s.vendored_frameworks = "DittoReactNative.xcframework"
+
+  include_local_boost(s)
+
+  s.source_files = "react-native/ios/**/*.{h,m,mm}", "react-native/cpp/**/*.{h,cpp,hpp}"
+  s.public_header_files = 'react-native/dittoffi/dittoffi.h', 'react-native/dittoffi/ifaddrs.h'
+
+  s.dependency "React-Core"
+end

package/README.md

@@ -1,89 +1,106 @@
 # Ditto JS SDK
 
-*Ditto is a cross platform SDK that allows mobile, web, and IoT apps to sync
-with and even without connectivity.*
+_Ditto is a cross-platform SDK that allows mobile, web, and IoT apps to sync
+with and even without connectivity._
 
-Version: **4.4.5**
+Version: **4.5.0**
 
-Please visit [ditto.live](https://ditto.live) for more info as well as the
-[API Reference](https://software.ditto.live/js/Ditto/4.4.5/api-reference/) for this particular version.
+For more information please visit [ditto.live](https://ditto.live), as well as the
+[API Reference](https://software.ditto.live/js/Ditto/4.5.0/api-reference/) for this particular version.
 
---------------------------------------------------------------------------------
+---
 
 ## Getting Started
 
 Add the Ditto NPM package to your project:
 
-    npm install --save @dittolive/ditto
+```bash
+npm install --save @dittolive/ditto
+```
 
 Import `@dittolive/ditto` in your source and start using it:
 
-    import { init, Ditto } from '@dittolive/ditto'
 
-    (async () => {
-      // Initialize the Ditto module
-      await init()
+```javascript
+import { init, Ditto } from '@dittolive/ditto'
 
-      // Create a Ditto context:
-      const identity = { type: 'offlinePlayground', appID: 'live.ditto.playground') }
-      const ditto = new Ditto(identity, 'playground')
+(async () => {
+  // Initialize the Ditto module
+  await init()
 
-      // Get hold of a collection:
-      const cars = ditto.store.collection('cars')
+  // Create a Ditto context:
+  const identity = { type: 'offlinePlayground', appID: 'live.ditto.playground' }
+  const ditto = new Ditto(identity, 'playground')
 
-      // Insert an entry:
-      const fordBlack = { _id: "ford-black-123", model: "Ford", color: "black" }
-      await cars.upsert(fordBlack)
+  // Get hold of a collection:
+  const cars = ditto.store.collection('cars')
 
-      // Find an entry by ID:
-      const foundFordBlack = await cars.findByID('ford-black-123')
-      console.log(foundFordBlack)
+  // Insert an entry:
+  const fordBlack = { _id: 'ford-black-123', model: 'Ford', color: 'black' }
+  await cars.upsert(fordBlack)
 
-      // Remove an entry:
-      await cars.findByID('ford-black-123').remove()
+  // Find an entry by ID:
+  const foundFordBlack = await cars.findByID('ford-black-123')
+  console.log(foundFordBlack)
 
-      // Done:
-      console.log("Done, over and out.")
-    })()
+  // Remove an entry:
+  await cars.findByID('ford-black-123').remove()
 
-**NOTE**: Ditto is powered by a
-[WebAssembly](https://developer.mozilla.org/en-US/docs/WebAssembly) and native
-Node core written in Rust under the hood. By default, when running in the
-browser, Ditto will fetch the corresponding WebAssembly file from the web. That
-same file is contained within the NPM package under `web/ditto.wasm` so you can
-serve it yourself. Simply make the file accessible somewhere on your server and
-pass the URL to `init()`:
+  // Done:
+  console.log('Done, over and out.')
+})()
+```
 
-    import { init, Ditto } from '@dittolive/ditto'
+### Browser Environments
 
-    (async () => {
-      // Pass the URL to the ditto.wasm file:
-      await init({ webAssemblyModule: 'https://my-app/assets/ditto.wasm' })
+When running in the browser and other web environments, Ditto is powered by a
+[WebAssembly](https://developer.mozilla.org/en-US/docs/WebAssembly) core written
+in Rust. By default, Ditto will fetch the corresponding WebAssembly file from
+the web. That same file is contained within the NPM package under
+`web/ditto.wasm` so you can serve it yourself. Simply make the file accessible
+somewhere on your server and pass the URL to `init()`:
 
-      // Then use Ditto as you normally would:
-      const identity = { type: 'offlinePlayground', appID: 'live.ditto.playground' }
-      const ditto = new Ditto(identity, 'playground')
+```javascript
+import { init, Ditto } from '@dittolive/ditto'
 
-      // ...
-    })
+(async () => {
+  // Pass the URL to the ditto.wasm file:
+  await init({ webAssemblyModule: 'https://my-app/assets/ditto.wasm' })
+
+  // Then use Ditto as you normally would:
+  const identity = { type: 'offlinePlayground', appID: 'live.ditto.playground' }
+  const ditto = new Ditto(identity, 'playground')
+
+  // ...
+})()
+```
 
 This may be useful for development or production environments without a reliable
-internet connection. Make sure to properly configure the server to return
-the correct MIME type (`application/wasm`) and the [`Access-Control-Allow-Origin`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin)
+internet connection. Make sure to properly configure the server to return the
+correct MIME type (`application/wasm`) and the
+[`Access-Control-Allow-Origin`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin)
 header if the `.wasm` file is served from a different domain. For production
 environments, make sure to use compression (`gzip`) and proper caching headers.
 
+### React Native Environments
+
+Using Ditto in React Native requires configuration of the native iOS and Android
+projects to request network and location access permissions and to ensure
+compatibility with the target environment. Please refer to our guide for
+[getting started with React
+Native](https://docs.ditto.live/javascript/react-native-quickstart) for more
+information.
+
 ## Playground
 
 The NPM package has a built-in bare minimum playground web page (`index.html`)
-as well as a Node REPL ('playground.cjs') allowing you to start playing with
-the Ditto SDK right away. Simply `cd` into the package directory, run
-`npm run play:web` or `npm run play:node` and follow the on-screen
-instructions.
+as well as a Node REPL ('playground.cjs') allowing you to start playing with the
+Ditto SDK right away. Simply `cd` into the package directory, run `npm run
+play:web` or `npm run play:node` and follow the on-screen instructions.
 
 ## Copyright
 
-*Ditto JS SDK* is a commercial product. Please consult `LICENSE.md` within this
+_Ditto JS SDK_ is a commercial product. Please consult `LICENSE.md` within this
 package for license details.
 
-Copyright © 2021 DittoLive Incorporated. All rights reserved.
+Copyright © 2023 DittoLive Incorporated. All rights reserved.