@drenso/homey-log 3.0.0-beta.0 → 8.36.0

package/README.md

@@ -1,12 +1,12 @@
 # Homey Log
 
-[![npm](https://img.shields.io/npm/v/homey-log)](https://www.npmjs.com/package/homey-log) [![Lint](https://github.com/athombv/node-homey-log/actions/workflows/lint.yml/badge.svg?branch=master)](https://github.com/athombv/node-homey-log/actions/workflows/lint.yml) [![NPM](https://github.com/athombv/node-homey-log/actions/workflows/deploy.yml/badge.svg)](https://github.com/athombv/node-homey-log/actions/workflows/deploy.yml) [![Deploy Documentation To GitHub Pages](https://github.com/athombv/node-homey-log/actions/workflows/docs.yml/badge.svg?branch=master)](https://github.com/athombv/node-homey-log/actions/workflows/docs.yml)
+[![npm](https://img.shields.io/npm/v/@drenso/homey-log)](https://www.npmjs.com/package/@drenso/homey-log) [![NPM](https://github.com/Drenso/node-homey-log/actions/workflows/deploy.yml/badge.svg)](https://github.com/Drenso/node-homey-log/actions/workflows/deploy.yml) [![pages-build-deployment](https://github.com/Drenso/homey-log/actions/workflows/pages/pages-build-deployment/badge.svg?branch=master)](https://github.com/Drenso/homey-log/actions/workflows/pages/pages-build-deployment)
 
 This module can be used in a Homey App to send events to [Sentry](http://sentry.io/).
 
 ## Documentation
 
-Documentation is available at [https://athombv.github.io/node-homey-log/](https://athombv.github.io/node-homey-log/).
+Documentation is available at [https://drenso.github.io/homey-log](https://drenso.github.io/homey-log).
 
 ## Related Modules
 
@@ -18,7 +18,7 @@ Documentation is available at [https://athombv.github.io/node-homey-log/](https:
 ## Installation
 
 ```bash
-npm install --save homey-log
+npm install --save @drenso/homey-log
 ```
 
 ## Getting started
@@ -50,6 +50,18 @@ class MyApp extends Homey.App {
 * When running your app with `homey app run` events will not be sent to Sentry.
 
 ## Changelog
+
 ### 2.0.0
 
 This version is only SDK version 3 compatible. It now requires a different way of setting up the `Log` instance, see _Getting Started_.
+
+### 3.0.0
+
+This version has replaced the raven SDK with [@sentry/node](https://docs.sentry.io/platforms/javascript/guides/node/) version 8. If you were using the basic configuration, nothing has changed.
+
+  - If you were passing custom options, you will need to review them.
+  - `setExtra` is deprecated by Sentry and has been removed.
+
+### 8.*
+
+This package will now follow the Sentry version included.

package/build/index.d.ts

@@ -0,0 +1,86 @@
+export class Log {
+    /**
+     * Mimic SDK log method.
+     * @private
+     */
+    private static _log;
+    /**
+     * Mimic SDK error method.
+     * @private
+     */
+    private static _error;
+    /**
+     * Mimic SDK timestamp.
+     * @returns {string}
+     * @private
+     */
+    private static _logTime;
+    /**
+     * Whether logging is forced.
+     * @returns {boolean}
+     * @private
+     */
+    private static _isLogForced;
+    /**
+     * Construct a new Log instance.
+     * @param {object} args
+     * @param {import('homey').default} args.homey - `this.homey` instance in
+     * your app (e.g. `App#homey`/`Driver#homey`/`Device#homey`).
+     *
+     * @param {object} [args.options] - Additional options for Sentry
+     *
+     * @example
+     * class MyApp extends Homey.App {
+     *   onInit() {
+     *     this.homeyLog = new Log({ homey: this.homey });
+     *   }
+     * }
+     */
+    constructor({ homey, options }: {
+        homey: import('homey').default;
+        options?: object;
+    });
+    _capturedMessages: any[];
+    _capturedExceptions: any[];
+    _manifest: any;
+    _homeyVersion: any;
+    _managerCloud: any;
+    _homeyPlatform: any;
+    _homeyPlatformVersion: any;
+    /**
+     * Init Sentry.
+     * @param {string} dsn The Sentry DSN
+     * @param {object} opts Options to be passed to the Sentry init
+     * @returns {Log}
+     * @private
+     */
+    private init;
+    /**
+     * Set `tags` that will be sent as context with every message or error. See the Sentry Node.js
+     * documentation: https://docs.sentry.io/platforms/javascript/guides/node/enriching-events/tags/
+     * @param {object} tags
+     * @returns {Log}
+     */
+    setTags(tags: object): Log;
+    /**
+     * Set `user` that will be sent as context with every message or error. See the Sentry Node.js
+     * documentation: https://docs.sentry.io/platforms/javascript/guides/node/enriching-events/identify-user/.
+     * @param {object} user
+     * @returns {Log}
+     */
+    setUser(user: object): Log;
+    /**
+     * Create and send message event to Sentry. See the Sentry Node.js documentation:
+     * https://docs.sentry.io/platforms/javascript/guides/node/usage/
+     * @param {string} message - Message to be sent
+     * @returns {Promise<string>|undefined}
+     */
+    captureMessage(message: string): Promise<string> | undefined;
+    /**
+     * Create and send exception event to Sentry. See the sentry Node.js documentation:
+     * https://docs.sentry.io/platforms/javascript/guides/node/usage/
+     * @param {Error} err - Error instance to be sent
+     * @returns {Promise<string>|undefined}
+     */
+    captureException(err: Error): Promise<string> | undefined;
+}