@dittolive/ditto 2.0.7 → 2.1.0-experimental.test.1

package/LICENSE.md

@@ -1,34 +1,34 @@
-Ditto Binary License
-
-Copyright © 2021 DittoLive Incorporated. All rights reserved.
-
-NOTICE: All information contained herein is, and remains the property of
-DittoLive. The intellectual and technical concepts contained herein are
-proprietary to DittoLive and may be covered by U.S. and Foreign Patents,
-patents in process, and are protected by trade secret and copyright law.
-
-Redistribution and use in binary form, with or without modification, is
-permitted provided that the following conditions are met:
-
-1. You agree not to attempt to decompile, disassemble, reverse engineer or
-otherwise discover the source code from which the binary code was derived.
-
-2. Redistributions in binary form must reproduce the above copyright notice,
-this list of conditions and the following disclaimer in the documentation
-and/or other materials provided with the distribution.
-
-3. Neither the name of the copyright holder nor the names of its
-contributors may be used to endorse or promote products derived from this
-software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
-LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-POSSIBILITY OF SUCH DAMAGE.
+Ditto Binary License
+
+Copyright © 2021 DittoLive Incorporated. All rights reserved.
+
+NOTICE: All information contained herein is, and remains the property of
+DittoLive. The intellectual and technical concepts contained herein are
+proprietary to DittoLive and may be covered by U.S. and Foreign Patents,
+patents in process, and are protected by trade secret and copyright law.
+
+Redistribution and use in binary form, with or without modification, is
+permitted provided that the following conditions are met:
+
+1. You agree not to attempt to decompile, disassemble, reverse engineer or
+otherwise discover the source code from which the binary code was derived.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+this list of conditions and the following disclaimer in the documentation
+and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+contributors may be used to endorse or promote products derived from this
+software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -1,89 +1,89 @@
-# Ditto JS SDK
-
-*Ditto is a cross platform SDK that allows mobile, web, and IoT apps to sync
-with and even without connectivity.*
-
-Version: **2.0.7**
-
-Please visit [ditto.live](https://ditto.live) for more info as well as the
-[API Reference](https://software.ditto.live/js/Ditto/2.0.7/api-reference/) for this particular version.
-
---------------------------------------------------------------------------------
-
-## Getting Started
-
-Add the Ditto NPM package to your project:
-
-    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()
-
-      // Create a Ditto context:
-      const identity = { type: 'offlinePlayground', appID: 'live.ditto.playground') }
-      const ditto = new Ditto(identity, 'playground')
-
-      // Get hold of a collection:
-      const cars = ditto.store.collection('cars')
-
-      // Insert an entry:
-      const fordBlack = { _id: "ford-black-123", model: "Ford", color: "black" }
-      await cars.upsert(fordBlack)
-
-      // Find an entry by ID:
-      const foundFordBlack = await cars.findByID('ford-black-123')
-      console.log(foundFordBlack)
-
-      // Remove an entry:
-      await cars.findByID('ford-black-123').remove()
-
-      // Done:
-      console.log("Done, over and out.")
-    })()
-
-**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()`:
-
-    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)
-header if the `.wasm` file is served from a different domain. For production
-environments, make sure to use compression (`gzip`) and proper caching headers.
-
-## 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.
-
-## Copyright
-
-*Ditto JS SDK* is a commercial product. Please consult `LICENSE.md` within this
-package for license details.
-
-Copyright © 2021 DittoLive Incorporated. All rights reserved.
+# Ditto JS SDK
+
+*Ditto is a cross platform SDK that allows mobile, web, and IoT apps to sync
+with and even without connectivity.*
+
+Version: **2.1.0-experimental.test.1**
+
+Please visit [ditto.live](https://ditto.live) for more info as well as the
+[API Reference](https://software.ditto.live/js/Ditto/0.0.0-manual-build.20221111-191305914-d8252906e/api-reference/) for this particular version.
+
+--------------------------------------------------------------------------------
+
+## Getting Started
+
+Add the Ditto NPM package to your project:
+
+    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()
+
+      // Create a Ditto context:
+      const identity = { type: 'offlinePlayground', appID: 'live.ditto.playground') }
+      const ditto = new Ditto(identity, 'playground')
+
+      // Get hold of a collection:
+      const cars = ditto.store.collection('cars')
+
+      // Insert an entry:
+      const fordBlack = { _id: "ford-black-123", model: "Ford", color: "black" }
+      await cars.upsert(fordBlack)
+
+      // Find an entry by ID:
+      const foundFordBlack = await cars.findByID('ford-black-123')
+      console.log(foundFordBlack)
+
+      // Remove an entry:
+      await cars.findByID('ford-black-123').remove()
+
+      // Done:
+      console.log("Done, over and out.")
+    })()
+
+**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()`:
+
+    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)
+header if the `.wasm` file is served from a different domain. For production
+environments, make sure to use compression (`gzip`) and proper caching headers.
+
+## 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.
+
+## Copyright
+
+*Ditto JS SDK* is a commercial product. Please consult `LICENSE.md` within this
+package for license details.
+
+Copyright © 2021 DittoLive Incorporated. All rights reserved.