@dittolive/ditto 4.8.0-rc.1 → 4.8.0

package/README.md

@@ -3,10 +3,10 @@
 _Ditto is a cross-platform SDK that allows mobile, web, and IoT apps to sync
 with and even without connectivity._
 
-Version: **4.8.0-rc.1**
+Version: **4.8.0**
 
 For more information please visit [ditto.live](https://ditto.live), as well as the
-[API Reference](https://software.ditto.live/js/Ditto/4.8.0-rc.1/api-reference/) for this particular version.
+[API Reference](https://software.ditto.live/js/Ditto/4.8.0/api-reference/) for this particular version.
 
 ---
 

package/node/ditto.cjs.js

@@ -2233,7 +2233,7 @@ class AttachmentToken {
 
 // NOTE: this is patched up with the actual build version by Jake task
 // build:package and has to be a valid semantic version as defined here: https://semver.org.
-const fullBuildVersionString = '4.8.0-rc.1';
+const fullBuildVersionString = '4.8.0';
 
 //
 // Copyright © 2021 DittoLive Incorporated. All rights reserved.
@@ -2318,7 +2318,13 @@ class Logger {
         var _a;
         this.setLogFile((_a = url === null || url === void 0 ? void 0 : url.pathname) !== null && _a !== void 0 ? _a : null);
     }
-    /** Whether the logger is currently enabled. */
+    /**
+     * Whether the logger is currently enabled.
+     *
+     * Logs exported through {@link exportToFile | exportToFile()} are not
+     * affected by this setting and will also include logs emitted while
+     * {@link enabled} is `false`.
+     */
     static get enabled() {
         return loggerEnabledGet();
     }
@@ -2345,6 +2351,9 @@ class Logger {
      *
      * For example if this is set to `Warning`, then only logs that are logged
      * with the `Warning` or `Error` log levels will be shown.
+     *
+     * Logs exported through {@link exportToFile | exportToFile()} are not
+     * affected by this setting and include all logs at `Debug` level and above.
      */
     static get minimumLogLevel() {
         return loggerMinimumLogLevelGet();
@@ -2373,10 +2382,14 @@ class Logger {
      * unregister any previous callback and stop reporting log entries through
      * callbacks.
      *
+     * @throws {TypeError} if `callback` is not a function or `undefined`.
      * @throws {Error} if called in a React Native environment.
      */
     static async setCustomLogCallback(callback) {
-        if (callback) {
+        if (callback != null && typeof callback !== 'function') {
+            throw new TypeError(`Expected parameter 'callback' to be a function or undefined, but got ${typeof callback}.`);
+        }
+        if (callback != null) {
             await loggerSetCustomLogCb(callback);
             this._customLogCallback = callback;
         }
@@ -2389,25 +2402,25 @@ class Logger {
      * Exports collected logs to a compressed and JSON-encoded file on the local
      * file system.
      *
-     * Ditto's logger locally collects up to 15 MB of logs when it is enabled,
-     * periodically discarding older logs once that limit is reached. These logs
-     * can be requested and downloaded from any peer that is active in a Ditto
-     * app using the portal's device dashboard. This method provides an alternative
-     * way of accessing those logs by exporting them to the local file system.
+     * Ditto's logger locally collects a limited amount of logs at `Debug` level
+     * and above, periodically discarding older logs. This internal logger is
+     * always enabled and works independently of the {@link Logger.enabled}
+     * setting and the configured {@link Logger.minimumLogLevel}. Its logs can be
+     * requested and downloaded from any peer that is active in a Ditto app using
+     * the portal's device dashboard. This method provides an alternative way of
+     * accessing those logs by exporting them to the local file system.
      *
-     * The logs will be written as a gzip compressed file at the path specified
-     * by the `path` parameter. When uncompressed, the file contains one JSON
-     * value per line with the oldest entry on the first line (JSON lines format).
+     * The logs will be written as a gzip compressed file at the path specified by
+     * the `path` parameter. When uncompressed, the file contains one JSON value
+     * per line with the oldest entry on the first line (JSON lines format).
      *
-     * Collection of logs requires having previously enabled logging at the
-     * desired verbosity level using {@link Logger.enabled} and
-     * {@link Logger.minimumLogLevel}. Ditto limits the amount of logs it retains
-     * on disk to a maximum of 15 MB, so setting a lower verbosity level can
-     * extend the time period covered by the exported logs up to a maximum of
-     * three days.
+     * Ditto limits the amount of logs it retains on disk to 15 MB and a maximum
+     * age of three days. Older logs are periodically discarded once one of these
+     * limits is reached.
      *
      * This method currently only exports logs from the most recently created
-     * Ditto instance, even when multiple instances are running in the same process.
+     * Ditto instance, even when multiple instances are running in the same
+     * process.
      *
      * Not supported in browser environments.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dittolive/ditto",
-  "version": "4.8.0-rc.1",
+  "version": "4.8.0",
   "description": "Ditto is a cross-platform embeddable NoSQL database that can sync with or without an internet connection.",
   "homepage": "https://ditto.live",
   "license": "SEE LICENSE IN LICENSE.md",