buttplug 3.1.1 → 3.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (71) hide show
  1. package/.eslintrc.js +13 -8
  2. package/CHANGELOG.md +23 -0
  3. package/README.md +24 -25
  4. package/dist/main/src/client/ButtplugBrowserWebsocketClientConnector.d.ts +13 -16
  5. package/dist/main/src/client/ButtplugBrowserWebsocketClientConnector.js +23 -52
  6. package/dist/main/src/client/ButtplugBrowserWebsocketClientConnector.js.map +1 -1
  7. package/dist/main/src/client/ButtplugClientConnectorException.d.ts +11 -11
  8. package/dist/main/src/client/ButtplugClientConnectorException.js +41 -41
  9. package/dist/main/src/client/ButtplugClientDevice.d.ts +67 -67
  10. package/dist/main/src/client/ButtplugClientDevice.js +325 -324
  11. package/dist/main/src/client/ButtplugClientDevice.js.map +1 -1
  12. package/dist/main/src/client/ButtplugNodeWebsocketClientConnector.d.ts +18 -18
  13. package/dist/main/src/client/ButtplugNodeWebsocketClientConnector.js +19 -19
  14. package/dist/main/src/client/Client.d.ts +41 -40
  15. package/dist/main/src/client/Client.js +241 -235
  16. package/dist/main/src/client/Client.js.map +1 -1
  17. package/dist/main/src/client/IButtplugClientConnector.d.ts +16 -16
  18. package/dist/main/src/client/IButtplugClientConnector.js +9 -9
  19. package/dist/main/src/core/Exceptions.d.ts +36 -36
  20. package/dist/main/src/core/Exceptions.js +106 -106
  21. package/dist/main/src/core/Logging.d.ts +112 -112
  22. package/dist/main/src/core/Logging.js +170 -170
  23. package/dist/main/src/core/Logging.js.map +1 -1
  24. package/dist/main/src/core/MessageUtils.d.ts +10 -9
  25. package/dist/main/src/core/MessageUtils.js +64 -58
  26. package/dist/main/src/core/MessageUtils.js.map +1 -1
  27. package/dist/main/src/core/Messages.d.ts +275 -275
  28. package/dist/main/src/core/Messages.js +429 -429
  29. package/dist/main/src/core/Messages.js.map +1 -1
  30. package/dist/main/src/index.d.ts +18 -18
  31. package/dist/main/src/index.js +34 -34
  32. package/dist/main/src/utils/ButtplugBrowserWebsocketConnector.d.ts +22 -22
  33. package/dist/main/src/utils/ButtplugBrowserWebsocketConnector.js +95 -95
  34. package/dist/main/src/utils/ButtplugMessageSorter.d.ts +19 -19
  35. package/dist/main/src/utils/ButtplugMessageSorter.js +81 -81
  36. package/dist/main/src/utils/Utils.d.ts +1 -1
  37. package/dist/main/src/utils/Utils.js +7 -7
  38. package/dist/web/buttplug.js +38 -7126
  39. package/dist/web/buttplug.mjs +2258 -0
  40. package/dist/web/client/ButtplugBrowserWebsocketClientConnector.d.ts +13 -0
  41. package/dist/web/client/ButtplugClientConnectorException.d.ts +11 -0
  42. package/dist/web/client/ButtplugClientDevice.d.ts +67 -0
  43. package/dist/web/client/ButtplugNodeWebsocketClientConnector.d.ts +18 -0
  44. package/dist/web/client/Client.d.ts +41 -0
  45. package/dist/web/client/IButtplugClientConnector.d.ts +16 -0
  46. package/dist/web/core/Exceptions.d.ts +36 -0
  47. package/dist/web/core/Logging.d.ts +112 -0
  48. package/dist/web/core/MessageUtils.d.ts +10 -0
  49. package/dist/web/core/Messages.d.ts +274 -0
  50. package/dist/web/index.d.ts +18 -0
  51. package/dist/web/utils/ButtplugBrowserWebsocketConnector.d.ts +22 -0
  52. package/dist/web/utils/ButtplugMessageSorter.d.ts +19 -0
  53. package/dist/web/utils/Utils.d.ts +1 -0
  54. package/package.json +23 -53
  55. package/src/client/ButtplugBrowserWebsocketClientConnector.ts +2 -24
  56. package/src/client/ButtplugClientDevice.ts +5 -4
  57. package/src/client/Client.ts +17 -10
  58. package/src/client/IButtplugClientConnector.ts +4 -4
  59. package/src/core/MessageUtils.ts +9 -1
  60. package/src/utils/ButtplugBrowserWebsocketConnector.ts +12 -12
  61. package/vite.config.ts +26 -0
  62. package/.github/FUNDING.yml +0 -5
  63. package/.github/ISSUE_TEMPLATE/bug_report.md +0 -17
  64. package/.github/workflows/docs.yaml +0 -29
  65. package/azure-pipelines.yml +0 -19
  66. package/dist/web/buttplug.min.js +0 -3
  67. package/dist/web/buttplug.min.js.LICENSE.txt +0 -31
  68. package/dist/web/buttplug.min.js.map +0 -1
  69. package/jest-puppeteer.config.js +0 -5
  70. package/rollup.config.js +0 -55
  71. package/util/convert_device_config.js +0 -6
@@ -1,36 +1,36 @@
1
- /*!
2
- * Buttplug JS Source Code File - Visit https://buttplug.io for more info about
3
- * the project. Licensed under the BSD 3-Clause license. See LICENSE file in the
4
- * project root for full license information.
5
- *
6
- * @copyright Copyright (c) Nonpolynomial Labs LLC. All rights reserved.
7
- */
8
- import * as Messages from './Messages';
9
- import { ButtplugLogger } from './Logging';
10
- export declare class ButtplugError extends Error {
11
- get ErrorClass(): Messages.ErrorClass;
12
- get InnerError(): Error | undefined;
13
- get Id(): number | undefined;
14
- get ErrorMessage(): Messages.ButtplugMessage;
15
- static LogAndError<T extends ButtplugError>(constructor: new (str: string, num: number) => T, logger: ButtplugLogger, message: string, id?: number): T;
16
- static FromError(error: Messages.Error): ButtplugDeviceError | ButtplugInitError | ButtplugUnknownError | ButtplugPingError | ButtplugMessageError;
17
- errorClass: Messages.ErrorClass;
18
- innerError: Error | undefined;
19
- messageId: number | undefined;
20
- protected constructor(message: string, errorClass: Messages.ErrorClass, id?: number, inner?: Error);
21
- }
22
- export declare class ButtplugInitError extends ButtplugError {
23
- constructor(message: string, id?: number);
24
- }
25
- export declare class ButtplugDeviceError extends ButtplugError {
26
- constructor(message: string, id?: number);
27
- }
28
- export declare class ButtplugMessageError extends ButtplugError {
29
- constructor(message: string, id?: number);
30
- }
31
- export declare class ButtplugPingError extends ButtplugError {
32
- constructor(message: string, id?: number);
33
- }
34
- export declare class ButtplugUnknownError extends ButtplugError {
35
- constructor(message: string, id?: number);
36
- }
1
+ /*!
2
+ * Buttplug JS Source Code File - Visit https://buttplug.io for more info about
3
+ * the project. Licensed under the BSD 3-Clause license. See LICENSE file in the
4
+ * project root for full license information.
5
+ *
6
+ * @copyright Copyright (c) Nonpolynomial Labs LLC. All rights reserved.
7
+ */
8
+ import * as Messages from './Messages';
9
+ import { ButtplugLogger } from './Logging';
10
+ export declare class ButtplugError extends Error {
11
+ get ErrorClass(): Messages.ErrorClass;
12
+ get InnerError(): Error | undefined;
13
+ get Id(): number | undefined;
14
+ get ErrorMessage(): Messages.ButtplugMessage;
15
+ static LogAndError<T extends ButtplugError>(constructor: new (str: string, num: number) => T, logger: ButtplugLogger, message: string, id?: number): T;
16
+ static FromError(error: Messages.Error): ButtplugDeviceError | ButtplugInitError | ButtplugUnknownError | ButtplugPingError | ButtplugMessageError;
17
+ errorClass: Messages.ErrorClass;
18
+ innerError: Error | undefined;
19
+ messageId: number | undefined;
20
+ protected constructor(message: string, errorClass: Messages.ErrorClass, id?: number, inner?: Error);
21
+ }
22
+ export declare class ButtplugInitError extends ButtplugError {
23
+ constructor(message: string, id?: number);
24
+ }
25
+ export declare class ButtplugDeviceError extends ButtplugError {
26
+ constructor(message: string, id?: number);
27
+ }
28
+ export declare class ButtplugMessageError extends ButtplugError {
29
+ constructor(message: string, id?: number);
30
+ }
31
+ export declare class ButtplugPingError extends ButtplugError {
32
+ constructor(message: string, id?: number);
33
+ }
34
+ export declare class ButtplugUnknownError extends ButtplugError {
35
+ constructor(message: string, id?: number);
36
+ }
@@ -1,107 +1,107 @@
1
- "use strict";
2
- /*!
3
- * Buttplug JS Source Code File - Visit https://buttplug.io for more info about
4
- * the project. Licensed under the BSD 3-Clause license. See LICENSE file in the
5
- * project root for full license information.
6
- *
7
- * @copyright Copyright (c) Nonpolynomial Labs LLC. All rights reserved.
8
- */
9
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- var desc = Object.getOwnPropertyDescriptor(m, k);
12
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
13
- desc = { enumerable: true, get: function() { return m[k]; } };
14
- }
15
- Object.defineProperty(o, k2, desc);
16
- }) : (function(o, m, k, k2) {
17
- if (k2 === undefined) k2 = k;
18
- o[k2] = m[k];
19
- }));
20
- var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
21
- Object.defineProperty(o, "default", { enumerable: true, value: v });
22
- }) : function(o, v) {
23
- o["default"] = v;
24
- });
25
- var __importStar = (this && this.__importStar) || function (mod) {
26
- if (mod && mod.__esModule) return mod;
27
- var result = {};
28
- if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
29
- __setModuleDefault(result, mod);
30
- return result;
31
- };
32
- Object.defineProperty(exports, "__esModule", { value: true });
33
- exports.ButtplugUnknownError = exports.ButtplugPingError = exports.ButtplugMessageError = exports.ButtplugDeviceError = exports.ButtplugInitError = exports.ButtplugError = void 0;
34
- const Messages = __importStar(require("./Messages"));
35
- class ButtplugError extends Error {
36
- get ErrorClass() {
37
- return this.errorClass;
38
- }
39
- get InnerError() {
40
- return this.innerError;
41
- }
42
- get Id() {
43
- return this.messageId;
44
- }
45
- get ErrorMessage() {
46
- return new Messages.Error(this.message, this.ErrorClass, this.Id);
47
- }
48
- static LogAndError(constructor, logger, message, id = Messages.SYSTEM_MESSAGE_ID) {
49
- logger.Error(message);
50
- return new constructor(message, id);
51
- }
52
- static FromError(error) {
53
- switch (error.ErrorCode) {
54
- case Messages.ErrorClass.ERROR_DEVICE:
55
- return new ButtplugDeviceError(error.ErrorMessage, error.Id);
56
- case Messages.ErrorClass.ERROR_INIT:
57
- return new ButtplugInitError(error.ErrorMessage, error.Id);
58
- case Messages.ErrorClass.ERROR_UNKNOWN:
59
- return new ButtplugUnknownError(error.ErrorMessage, error.Id);
60
- case Messages.ErrorClass.ERROR_PING:
61
- return new ButtplugPingError(error.ErrorMessage, error.Id);
62
- case Messages.ErrorClass.ERROR_MSG:
63
- return new ButtplugMessageError(error.ErrorMessage, error.Id);
64
- default:
65
- throw new Error(`Message type ${error.ErrorCode} not handled`);
66
- }
67
- }
68
- constructor(message, errorClass, id = Messages.SYSTEM_MESSAGE_ID, inner) {
69
- super(message);
70
- this.errorClass = Messages.ErrorClass.ERROR_UNKNOWN;
71
- this.errorClass = errorClass;
72
- this.innerError = inner;
73
- this.messageId = id;
74
- }
75
- }
76
- exports.ButtplugError = ButtplugError;
77
- class ButtplugInitError extends ButtplugError {
78
- constructor(message, id = Messages.SYSTEM_MESSAGE_ID) {
79
- super(message, Messages.ErrorClass.ERROR_INIT, id);
80
- }
81
- }
82
- exports.ButtplugInitError = ButtplugInitError;
83
- class ButtplugDeviceError extends ButtplugError {
84
- constructor(message, id = Messages.SYSTEM_MESSAGE_ID) {
85
- super(message, Messages.ErrorClass.ERROR_DEVICE, id);
86
- }
87
- }
88
- exports.ButtplugDeviceError = ButtplugDeviceError;
89
- class ButtplugMessageError extends ButtplugError {
90
- constructor(message, id = Messages.SYSTEM_MESSAGE_ID) {
91
- super(message, Messages.ErrorClass.ERROR_MSG, id);
92
- }
93
- }
94
- exports.ButtplugMessageError = ButtplugMessageError;
95
- class ButtplugPingError extends ButtplugError {
96
- constructor(message, id = Messages.SYSTEM_MESSAGE_ID) {
97
- super(message, Messages.ErrorClass.ERROR_PING, id);
98
- }
99
- }
100
- exports.ButtplugPingError = ButtplugPingError;
101
- class ButtplugUnknownError extends ButtplugError {
102
- constructor(message, id = Messages.SYSTEM_MESSAGE_ID) {
103
- super(message, Messages.ErrorClass.ERROR_UNKNOWN, id);
104
- }
105
- }
106
- exports.ButtplugUnknownError = ButtplugUnknownError;
1
+ "use strict";
2
+ /*!
3
+ * Buttplug JS Source Code File - Visit https://buttplug.io for more info about
4
+ * the project. Licensed under the BSD 3-Clause license. See LICENSE file in the
5
+ * project root for full license information.
6
+ *
7
+ * @copyright Copyright (c) Nonpolynomial Labs LLC. All rights reserved.
8
+ */
9
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ var desc = Object.getOwnPropertyDescriptor(m, k);
12
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
13
+ desc = { enumerable: true, get: function() { return m[k]; } };
14
+ }
15
+ Object.defineProperty(o, k2, desc);
16
+ }) : (function(o, m, k, k2) {
17
+ if (k2 === undefined) k2 = k;
18
+ o[k2] = m[k];
19
+ }));
20
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
21
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
22
+ }) : function(o, v) {
23
+ o["default"] = v;
24
+ });
25
+ var __importStar = (this && this.__importStar) || function (mod) {
26
+ if (mod && mod.__esModule) return mod;
27
+ var result = {};
28
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
29
+ __setModuleDefault(result, mod);
30
+ return result;
31
+ };
32
+ Object.defineProperty(exports, "__esModule", { value: true });
33
+ exports.ButtplugUnknownError = exports.ButtplugPingError = exports.ButtplugMessageError = exports.ButtplugDeviceError = exports.ButtplugInitError = exports.ButtplugError = void 0;
34
+ const Messages = __importStar(require("./Messages"));
35
+ class ButtplugError extends Error {
36
+ get ErrorClass() {
37
+ return this.errorClass;
38
+ }
39
+ get InnerError() {
40
+ return this.innerError;
41
+ }
42
+ get Id() {
43
+ return this.messageId;
44
+ }
45
+ get ErrorMessage() {
46
+ return new Messages.Error(this.message, this.ErrorClass, this.Id);
47
+ }
48
+ static LogAndError(constructor, logger, message, id = Messages.SYSTEM_MESSAGE_ID) {
49
+ logger.Error(message);
50
+ return new constructor(message, id);
51
+ }
52
+ static FromError(error) {
53
+ switch (error.ErrorCode) {
54
+ case Messages.ErrorClass.ERROR_DEVICE:
55
+ return new ButtplugDeviceError(error.ErrorMessage, error.Id);
56
+ case Messages.ErrorClass.ERROR_INIT:
57
+ return new ButtplugInitError(error.ErrorMessage, error.Id);
58
+ case Messages.ErrorClass.ERROR_UNKNOWN:
59
+ return new ButtplugUnknownError(error.ErrorMessage, error.Id);
60
+ case Messages.ErrorClass.ERROR_PING:
61
+ return new ButtplugPingError(error.ErrorMessage, error.Id);
62
+ case Messages.ErrorClass.ERROR_MSG:
63
+ return new ButtplugMessageError(error.ErrorMessage, error.Id);
64
+ default:
65
+ throw new Error(`Message type ${error.ErrorCode} not handled`);
66
+ }
67
+ }
68
+ constructor(message, errorClass, id = Messages.SYSTEM_MESSAGE_ID, inner) {
69
+ super(message);
70
+ this.errorClass = Messages.ErrorClass.ERROR_UNKNOWN;
71
+ this.errorClass = errorClass;
72
+ this.innerError = inner;
73
+ this.messageId = id;
74
+ }
75
+ }
76
+ exports.ButtplugError = ButtplugError;
77
+ class ButtplugInitError extends ButtplugError {
78
+ constructor(message, id = Messages.SYSTEM_MESSAGE_ID) {
79
+ super(message, Messages.ErrorClass.ERROR_INIT, id);
80
+ }
81
+ }
82
+ exports.ButtplugInitError = ButtplugInitError;
83
+ class ButtplugDeviceError extends ButtplugError {
84
+ constructor(message, id = Messages.SYSTEM_MESSAGE_ID) {
85
+ super(message, Messages.ErrorClass.ERROR_DEVICE, id);
86
+ }
87
+ }
88
+ exports.ButtplugDeviceError = ButtplugDeviceError;
89
+ class ButtplugMessageError extends ButtplugError {
90
+ constructor(message, id = Messages.SYSTEM_MESSAGE_ID) {
91
+ super(message, Messages.ErrorClass.ERROR_MSG, id);
92
+ }
93
+ }
94
+ exports.ButtplugMessageError = ButtplugMessageError;
95
+ class ButtplugPingError extends ButtplugError {
96
+ constructor(message, id = Messages.SYSTEM_MESSAGE_ID) {
97
+ super(message, Messages.ErrorClass.ERROR_PING, id);
98
+ }
99
+ }
100
+ exports.ButtplugPingError = ButtplugPingError;
101
+ class ButtplugUnknownError extends ButtplugError {
102
+ constructor(message, id = Messages.SYSTEM_MESSAGE_ID) {
103
+ super(message, Messages.ErrorClass.ERROR_UNKNOWN, id);
104
+ }
105
+ }
106
+ exports.ButtplugUnknownError = ButtplugUnknownError;
107
107
  //# sourceMappingURL=Exceptions.js.map
@@ -1,112 +1,112 @@
1
- /*!
2
- * Buttplug JS Source Code File - Visit https://buttplug.io for more info about
3
- * the project. Licensed under the BSD 3-Clause license. See LICENSE file in the
4
- * project root for full license information.
5
- *
6
- * @copyright Copyright (c) Nonpolynomial Labs LLC. All rights reserved.
7
- */
8
- import { EventEmitter } from 'eventemitter3';
9
- export declare enum ButtplugLogLevel {
10
- Off = 0,
11
- Error = 1,
12
- Warn = 2,
13
- Info = 3,
14
- Debug = 4,
15
- Trace = 5
16
- }
17
- /**
18
- * Representation of log messages for the internal logging utility.
19
- */
20
- export declare class LogMessage {
21
- /** Timestamp for the log message */
22
- private timestamp;
23
- /** Log Message */
24
- private logMessage;
25
- /** Log Level */
26
- private logLevel;
27
- /**
28
- * @param logMessage Log message.
29
- * @param logLevel: Log severity level.
30
- */
31
- constructor(logMessage: string, logLevel: ButtplugLogLevel);
32
- /**
33
- * Returns the log message.
34
- */
35
- get Message(): string;
36
- /**
37
- * Returns the log message level.
38
- */
39
- get LogLevel(): ButtplugLogLevel;
40
- /**
41
- * Returns the log message timestamp.
42
- */
43
- get Timestamp(): string;
44
- /**
45
- * Returns a formatted string with timestamp, level, and message.
46
- */
47
- get FormattedMessage(): string;
48
- }
49
- /**
50
- * Simple, global logging utility for the Buttplug client and server. Keeps an
51
- * internal static reference to an instance of itself (singleton pattern,
52
- * basically), and allows message logging throughout the module.
53
- */
54
- export declare class ButtplugLogger extends EventEmitter {
55
- /** Singleton instance for the logger */
56
- protected static sLogger: ButtplugLogger | undefined;
57
- /** Sets maximum log level to log to console */
58
- protected maximumConsoleLogLevel: ButtplugLogLevel;
59
- /** Sets maximum log level for all log messages */
60
- protected maximumEventLogLevel: ButtplugLogLevel;
61
- /**
62
- * Returns the stored static instance of the logger, creating one if it
63
- * doesn't currently exist.
64
- */
65
- static get Logger(): ButtplugLogger;
66
- /**
67
- * Constructor. Can only be called internally since we regulate ButtplugLogger
68
- * ownership.
69
- */
70
- protected constructor();
71
- /**
72
- * Set the maximum log level to output to console.
73
- */
74
- get MaximumConsoleLogLevel(): ButtplugLogLevel;
75
- /**
76
- * Get the maximum log level to output to console.
77
- */
78
- set MaximumConsoleLogLevel(buttplugLogLevel: ButtplugLogLevel);
79
- /**
80
- * Set the global maximum log level
81
- */
82
- get MaximumEventLogLevel(): ButtplugLogLevel;
83
- /**
84
- * Get the global maximum log level
85
- */
86
- set MaximumEventLogLevel(logLevel: ButtplugLogLevel);
87
- /**
88
- * Log new message at Error level.
89
- */
90
- Error(msg: string): void;
91
- /**
92
- * Log new message at Warn level.
93
- */
94
- Warn(msg: string): void;
95
- /**
96
- * Log new message at Info level.
97
- */
98
- Info(msg: string): void;
99
- /**
100
- * Log new message at Debug level.
101
- */
102
- Debug(msg: string): void;
103
- /**
104
- * Log new message at Trace level.
105
- */
106
- Trace(msg: string): void;
107
- /**
108
- * Checks to see if message should be logged, and if so, adds message to the
109
- * log buffer. May also print message and emit event.
110
- */
111
- protected AddLogMessage(msg: string, level: ButtplugLogLevel): void;
112
- }
1
+ /*!
2
+ * Buttplug JS Source Code File - Visit https://buttplug.io for more info about
3
+ * the project. Licensed under the BSD 3-Clause license. See LICENSE file in the
4
+ * project root for full license information.
5
+ *
6
+ * @copyright Copyright (c) Nonpolynomial Labs LLC. All rights reserved.
7
+ */
8
+ import { EventEmitter } from 'eventemitter3';
9
+ export declare enum ButtplugLogLevel {
10
+ Off = 0,
11
+ Error = 1,
12
+ Warn = 2,
13
+ Info = 3,
14
+ Debug = 4,
15
+ Trace = 5
16
+ }
17
+ /**
18
+ * Representation of log messages for the internal logging utility.
19
+ */
20
+ export declare class LogMessage {
21
+ /** Timestamp for the log message */
22
+ private timestamp;
23
+ /** Log Message */
24
+ private logMessage;
25
+ /** Log Level */
26
+ private logLevel;
27
+ /**
28
+ * @param logMessage Log message.
29
+ * @param logLevel: Log severity level.
30
+ */
31
+ constructor(logMessage: string, logLevel: ButtplugLogLevel);
32
+ /**
33
+ * Returns the log message.
34
+ */
35
+ get Message(): string;
36
+ /**
37
+ * Returns the log message level.
38
+ */
39
+ get LogLevel(): ButtplugLogLevel;
40
+ /**
41
+ * Returns the log message timestamp.
42
+ */
43
+ get Timestamp(): string;
44
+ /**
45
+ * Returns a formatted string with timestamp, level, and message.
46
+ */
47
+ get FormattedMessage(): string;
48
+ }
49
+ /**
50
+ * Simple, global logging utility for the Buttplug client and server. Keeps an
51
+ * internal static reference to an instance of itself (singleton pattern,
52
+ * basically), and allows message logging throughout the module.
53
+ */
54
+ export declare class ButtplugLogger extends EventEmitter {
55
+ /** Singleton instance for the logger */
56
+ protected static sLogger: ButtplugLogger | undefined;
57
+ /** Sets maximum log level to log to console */
58
+ protected maximumConsoleLogLevel: ButtplugLogLevel;
59
+ /** Sets maximum log level for all log messages */
60
+ protected maximumEventLogLevel: ButtplugLogLevel;
61
+ /**
62
+ * Returns the stored static instance of the logger, creating one if it
63
+ * doesn't currently exist.
64
+ */
65
+ static get Logger(): ButtplugLogger;
66
+ /**
67
+ * Constructor. Can only be called internally since we regulate ButtplugLogger
68
+ * ownership.
69
+ */
70
+ protected constructor();
71
+ /**
72
+ * Set the maximum log level to output to console.
73
+ */
74
+ get MaximumConsoleLogLevel(): ButtplugLogLevel;
75
+ /**
76
+ * Get the maximum log level to output to console.
77
+ */
78
+ set MaximumConsoleLogLevel(buttplugLogLevel: ButtplugLogLevel);
79
+ /**
80
+ * Set the global maximum log level
81
+ */
82
+ get MaximumEventLogLevel(): ButtplugLogLevel;
83
+ /**
84
+ * Get the global maximum log level
85
+ */
86
+ set MaximumEventLogLevel(logLevel: ButtplugLogLevel);
87
+ /**
88
+ * Log new message at Error level.
89
+ */
90
+ Error(msg: string): void;
91
+ /**
92
+ * Log new message at Warn level.
93
+ */
94
+ Warn(msg: string): void;
95
+ /**
96
+ * Log new message at Info level.
97
+ */
98
+ Info(msg: string): void;
99
+ /**
100
+ * Log new message at Debug level.
101
+ */
102
+ Debug(msg: string): void;
103
+ /**
104
+ * Log new message at Trace level.
105
+ */
106
+ Trace(msg: string): void;
107
+ /**
108
+ * Checks to see if message should be logged, and if so, adds message to the
109
+ * log buffer. May also print message and emit event.
110
+ */
111
+ protected AddLogMessage(msg: string, level: ButtplugLogLevel): void;
112
+ }