@open-pioneer/core 1.0.1 → 1.2.0

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.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # @open-pioneer/core
2
2
 
3
+ ## 1.2.0
4
+
5
+ ### Minor Changes
6
+
7
+ - a18d227: New helper function `rethrowAbortError`.
8
+
9
+ ## 1.1.0
10
+
11
+ ### Minor Changes
12
+
13
+ - 69c0fcd: The Logger interface now supports `unknown` as message argument. Value types other than `string` or `Error` are converted to strings before logging them.
14
+
3
15
  ## 1.0.1
4
16
 
5
17
  ### Patch Changes
package/Logger.d.ts CHANGED
@@ -15,10 +15,12 @@ export interface LogMethod {
15
15
  /**
16
16
  * Logger's log method signature
17
17
  *
18
- * @param message Log message to be logged (attached to the prefix). Can be a string or an Error.
18
+ * @param message
19
+ * Log message to be logged (attached to the prefix). This can be an arbitrary value.
20
+ * Errors will be logged as-is, and other values are formatted as strings.
19
21
  * @param values Arbitrary amount of additional values to be logged (attached to message).
20
22
  */
21
- (message: string | Error, ...values: unknown[]): void;
23
+ (message: string | Error | unknown, ...values: unknown[]): void;
22
24
  }
23
25
  /**
24
26
  * Provides a logger for a standardized application wide logging.
@@ -70,25 +72,25 @@ export declare class LoggerImpl implements Logger {
70
72
  * @param message
71
73
  * @param values
72
74
  */
73
- debug(message: string | Error, ...values: unknown[]): void;
75
+ debug(message: string | Error | unknown, ...values: unknown[]): void;
74
76
  /**
75
77
  * Performs an info log with the given message and values if INFO level is enabled.
76
78
  * @param message
77
79
  * @param values
78
80
  */
79
- info(message: string | Error, ...values: unknown[]): void;
81
+ info(message: string | Error | unknown, ...values: unknown[]): void;
80
82
  /**
81
83
  * Performs a warning log with the given message and values if WARN level is enabled.
82
84
  * @param message
83
85
  * @param values
84
86
  */
85
- warn(message: string | Error, ...values: unknown[]): void;
87
+ warn(message: string | Error | unknown, ...values: unknown[]): void;
86
88
  /**
87
89
  * Performs an error log with the given message and values if ERROR level is enabled.
88
90
  * @param message
89
91
  * @param values
90
92
  */
91
- error(message: string | Error, ...values: unknown[]): void;
93
+ error(message: string | Error | unknown, ...values: unknown[]): void;
92
94
  /**
93
95
  * Internal method for performing the log if the specified level is enabled.
94
96
  * @param level
package/Logger.js CHANGED
@@ -60,8 +60,8 @@ class LoggerImpl {
60
60
  _doLog(level, messageOrError, values) {
61
61
  if (this._isLogLevelEnabled(level)) {
62
62
  let message = `[${level}] ${this.prefix}:`;
63
- if (typeof messageOrError === "string") {
64
- message += " " + messageOrError;
63
+ if (!isError(messageOrError)) {
64
+ message += " " + String(messageOrError);
65
65
  } else {
66
66
  values.unshift(messageOrError);
67
67
  }
@@ -105,6 +105,12 @@ function validateLogLevel(logLevelString) {
105
105
  );
106
106
  }
107
107
  }
108
+ function isError(value) {
109
+ if (value instanceof Error) {
110
+ return true;
111
+ }
112
+ return !!(value && typeof value === "object" && typeof value.name === "string" && typeof value.message === "string");
113
+ }
108
114
 
109
115
  export { LoggerImpl, createLogger };
110
116
  //# sourceMappingURL=Logger.js.map
package/Logger.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"Logger.js","sources":["Logger.ts"],"sourcesContent":["// SPDX-FileCopyrightText: con terra GmbH and contributors\n// SPDX-License-Identifier: Apache-2.0\nconst LOG_LEVEL = validateLogLevel(__LOG_LEVEL__);\n\n/**\n * Creates and returns a new logger instance for an application wide standardized logging.\n * For available log methods see {@link Logger} interface.\n * The log level is globally configured (see vite.config.ts).\n *\n * @param prefix Prefix used to prefix all log messages invoked by the created logger instance.\n */\nexport function createLogger(prefix: string): Logger {\n return new LoggerImpl(prefix, LOG_LEVEL);\n}\n\n/**\n * Allowed log levels.\n * Order: DEBUG < INFO < WARN < ERROR\n */\nexport type LogLevel = \"DEBUG\" | \"INFO\" | \"WARN\" | \"ERROR\";\n\n// internal representation of log levels as numbers for log level comparison.\nconst logLevelNumbers: Record<LogLevel, number> = {\n DEBUG: 0,\n INFO: 1,\n WARN: 2,\n ERROR: 3\n};\n\nexport interface LogMethod {\n /**\n * Logger's log method signature\n *\n * @param message Log message to be logged (attached to the prefix). Can be a string or an Error.\n * @param values Arbitrary amount of additional values to be logged (attached to message).\n */\n (message: string | Error, ...values: unknown[]): void;\n}\n\n/**\n * Provides a logger for a standardized application wide logging.\n *\n * The logger's log level is configured globally.\n *\n * Use the `createLogger` function to receive a new logger instance for logging.\n */\nexport interface Logger {\n /**\n * Prefix prepended to all logging messages\n */\n readonly prefix: string;\n\n /**\n * Returns true if debug log level is enabled.\n */\n isDebug(): boolean;\n\n /**\n * Logging method for debug log level.\n * Follows normal LogMethod structure but logs in debug level.\n */\n debug: LogMethod;\n\n /**\n * Logging method for info log level.\n * Follows normal log method structure but logs in info level.\n */\n info: LogMethod;\n\n /**\n * Logging method for warn log level.\n * Follows normal log method structure but logs in warn level.\n */\n warn: LogMethod;\n\n /**\n * Logging method for debug error level.\n * Follows normal log method structure but logs in error level.\n */\n error: LogMethod;\n}\n\n/**\n * A class implementing a logger with a global log level.\n */\nexport class LoggerImpl implements Logger {\n prefix: string;\n private readonly enabledLogLevelNumber: number;\n\n constructor(prefix: string, logLevel: LogLevel) {\n this.prefix = prefix;\n this.enabledLogLevelNumber = logLevelToLogLevelNumber(logLevel);\n }\n\n isDebug() {\n return this._isLogLevelEnabled(\"DEBUG\");\n }\n\n /**\n * Performs a debug log with the given message and values if DEBUG level is enabled.\n * @param message\n * @param values\n */\n debug(message: string | Error, ...values: unknown[]) {\n this._doLog(\"DEBUG\", message, values);\n }\n\n /**\n * Performs an info log with the given message and values if INFO level is enabled.\n * @param message\n * @param values\n */\n info(message: string | Error, ...values: unknown[]) {\n this._doLog(\"INFO\", message, values);\n }\n\n /**\n * Performs a warning log with the given message and values if WARN level is enabled.\n * @param message\n * @param values\n */\n warn(message: string | Error, ...values: unknown[]) {\n this._doLog(\"WARN\", message, values);\n }\n\n /**\n * Performs an error log with the given message and values if ERROR level is enabled.\n * @param message\n * @param values\n */\n error(message: string | Error, ...values: unknown[]) {\n this._doLog(\"ERROR\", message, values);\n }\n\n /**\n * Internal method for performing the log if the specified level is enabled.\n * @param level\n * @param messageOrError\n * @param values\n * @private\n */\n private _doLog(level: LogLevel, messageOrError: string | Error, values: unknown[]) {\n if (this._isLogLevelEnabled(level)) {\n let message = `[${level}] ${this.prefix}:`;\n if (typeof messageOrError === \"string\") {\n message += \" \" + messageOrError;\n } else {\n values.unshift(messageOrError);\n }\n const consoleMethodName = logLevelToConsoleMethodName(level);\n console[consoleMethodName](message, ...values);\n }\n }\n\n private _isLogLevelEnabled(logLevel: LogLevel) {\n const logLevelNumber = logLevelToLogLevelNumber(logLevel);\n return logLevelNumber >= this.enabledLogLevelNumber;\n }\n}\n\n/**\n * Converts a LogLevel to a browser's debugging console method name.\n * @param logLevel\n */\nfunction logLevelToConsoleMethodName(logLevel: LogLevel): \"debug\" | \"info\" | \"warn\" | \"error\" {\n switch (logLevel) {\n case \"DEBUG\":\n return \"debug\";\n case \"INFO\":\n return \"info\";\n case \"WARN\":\n return \"warn\";\n case \"ERROR\":\n return \"error\";\n }\n}\n\nfunction logLevelToLogLevelNumber(logLevel: LogLevel) {\n return logLevelNumbers[logLevel];\n}\n\nfunction validateLogLevel(logLevelString: string): LogLevel {\n if (!logLevelString) {\n return \"INFO\";\n }\n\n switch (logLevelString) {\n case \"DEBUG\":\n case \"INFO\":\n case \"WARN\":\n case \"ERROR\":\n return logLevelString;\n default:\n throw new Error(\n `invalid log level '${logLevelString}'; allowed levels are: DEBUG, INFO, WARN, ERROR`\n );\n }\n}\n"],"names":[],"mappings":"AAEA,MAAM,SAAA,GAAY,iBAAiB,aAAa,CAAA,CAAA;AASzC,SAAS,aAAa,MAAwB,EAAA;AACjD,EAAO,OAAA,IAAI,UAAW,CAAA,MAAA,EAAQ,SAAS,CAAA,CAAA;AAC3C,CAAA;AASA,MAAM,eAA4C,GAAA;AAAA,EAC9C,KAAO,EAAA,CAAA;AAAA,EACP,IAAM,EAAA,CAAA;AAAA,EACN,IAAM,EAAA,CAAA;AAAA,EACN,KAAO,EAAA,CAAA;AACX,CAAA,CAAA;AA0DO,MAAM,UAA6B,CAAA;AAAA,EACtC,MAAA,CAAA;AAAA,EACiB,qBAAA,CAAA;AAAA,EAEjB,WAAA,CAAY,QAAgB,QAAoB,EAAA;AAC5C,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA,CAAA;AACd,IAAK,IAAA,CAAA,qBAAA,GAAwB,yBAAyB,QAAQ,CAAA,CAAA;AAAA,GAClE;AAAA,EAEA,OAAU,GAAA;AACN,IAAO,OAAA,IAAA,CAAK,mBAAmB,OAAO,CAAA,CAAA;AAAA,GAC1C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,KAAA,CAAM,YAA4B,MAAmB,EAAA;AACjD,IAAK,IAAA,CAAA,MAAA,CAAO,OAAS,EAAA,OAAA,EAAS,MAAM,CAAA,CAAA;AAAA,GACxC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAA,CAAK,YAA4B,MAAmB,EAAA;AAChD,IAAK,IAAA,CAAA,MAAA,CAAO,MAAQ,EAAA,OAAA,EAAS,MAAM,CAAA,CAAA;AAAA,GACvC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAA,CAAK,YAA4B,MAAmB,EAAA;AAChD,IAAK,IAAA,CAAA,MAAA,CAAO,MAAQ,EAAA,OAAA,EAAS,MAAM,CAAA,CAAA;AAAA,GACvC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,KAAA,CAAM,YAA4B,MAAmB,EAAA;AACjD,IAAK,IAAA,CAAA,MAAA,CAAO,OAAS,EAAA,OAAA,EAAS,MAAM,CAAA,CAAA;AAAA,GACxC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASQ,MAAA,CAAO,KAAiB,EAAA,cAAA,EAAgC,MAAmB,EAAA;AAC/E,IAAI,IAAA,IAAA,CAAK,kBAAmB,CAAA,KAAK,CAAG,EAAA;AAChC,MAAI,IAAA,OAAA,GAAU,CAAI,CAAA,EAAA,KAAA,CAAA,EAAA,EAAU,IAAK,CAAA,MAAA,CAAA,CAAA,CAAA,CAAA;AACjC,MAAI,IAAA,OAAO,mBAAmB,QAAU,EAAA;AACpC,QAAA,OAAA,IAAW,GAAM,GAAA,cAAA,CAAA;AAAA,OACd,MAAA;AACH,QAAA,MAAA,CAAO,QAAQ,cAAc,CAAA,CAAA;AAAA,OACjC;AACA,MAAM,MAAA,iBAAA,GAAoB,4BAA4B,KAAK,CAAA,CAAA;AAC3D,MAAA,OAAA,CAAQ,iBAAiB,CAAA,CAAE,OAAS,EAAA,GAAG,MAAM,CAAA,CAAA;AAAA,KACjD;AAAA,GACJ;AAAA,EAEQ,mBAAmB,QAAoB,EAAA;AAC3C,IAAM,MAAA,cAAA,GAAiB,yBAAyB,QAAQ,CAAA,CAAA;AACxD,IAAA,OAAO,kBAAkB,IAAK,CAAA,qBAAA,CAAA;AAAA,GAClC;AACJ,CAAA;AAMA,SAAS,4BAA4B,QAAyD,EAAA;AAC1F,EAAA,QAAQ,QAAU;AAAA,IACd,KAAK,OAAA;AACD,MAAO,OAAA,OAAA,CAAA;AAAA,IACX,KAAK,MAAA;AACD,MAAO,OAAA,MAAA,CAAA;AAAA,IACX,KAAK,MAAA;AACD,MAAO,OAAA,MAAA,CAAA;AAAA,IACX,KAAK,OAAA;AACD,MAAO,OAAA,OAAA,CAAA;AAAA,GACf;AACJ,CAAA;AAEA,SAAS,yBAAyB,QAAoB,EAAA;AAClD,EAAA,OAAO,gBAAgB,QAAQ,CAAA,CAAA;AACnC,CAAA;AAEA,SAAS,iBAAiB,cAAkC,EAAA;AACxD,EAAA,IAAI,CAAC,cAAgB,EAAA;AACjB,IAAO,OAAA,MAAA,CAAA;AAAA,GACX;AAEA,EAAA,QAAQ,cAAgB;AAAA,IACpB,KAAK,OAAA,CAAA;AAAA,IACL,KAAK,MAAA,CAAA;AAAA,IACL,KAAK,MAAA,CAAA;AAAA,IACL,KAAK,OAAA;AACD,MAAO,OAAA,cAAA,CAAA;AAAA,IACX;AACI,MAAA,MAAM,IAAI,KAAA;AAAA,QACN,CAAsB,mBAAA,EAAA,cAAA,CAAA,+CAAA,CAAA;AAAA,OAC1B,CAAA;AAAA,GACR;AACJ;;;;"}
1
+ {"version":3,"file":"Logger.js","sources":["Logger.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nconst LOG_LEVEL = validateLogLevel(__LOG_LEVEL__);\n\n/**\n * Creates and returns a new logger instance for an application wide standardized logging.\n * For available log methods see {@link Logger} interface.\n * The log level is globally configured (see vite.config.ts).\n *\n * @param prefix Prefix used to prefix all log messages invoked by the created logger instance.\n */\nexport function createLogger(prefix: string): Logger {\n return new LoggerImpl(prefix, LOG_LEVEL);\n}\n\n/**\n * Allowed log levels.\n * Order: DEBUG < INFO < WARN < ERROR\n */\nexport type LogLevel = \"DEBUG\" | \"INFO\" | \"WARN\" | \"ERROR\";\n\n// internal representation of log levels as numbers for log level comparison.\nconst logLevelNumbers: Record<LogLevel, number> = {\n DEBUG: 0,\n INFO: 1,\n WARN: 2,\n ERROR: 3\n};\n\nexport interface LogMethod {\n /**\n * Logger's log method signature\n *\n * @param message\n * Log message to be logged (attached to the prefix). This can be an arbitrary value.\n * Errors will be logged as-is, and other values are formatted as strings.\n * @param values Arbitrary amount of additional values to be logged (attached to message).\n */\n (message: string | Error | unknown, ...values: unknown[]): void;\n}\n\n/**\n * Provides a logger for a standardized application wide logging.\n *\n * The logger's log level is configured globally.\n *\n * Use the `createLogger` function to receive a new logger instance for logging.\n */\nexport interface Logger {\n /**\n * Prefix prepended to all logging messages\n */\n readonly prefix: string;\n\n /**\n * Returns true if debug log level is enabled.\n */\n isDebug(): boolean;\n\n /**\n * Logging method for debug log level.\n * Follows normal LogMethod structure but logs in debug level.\n */\n debug: LogMethod;\n\n /**\n * Logging method for info log level.\n * Follows normal log method structure but logs in info level.\n */\n info: LogMethod;\n\n /**\n * Logging method for warn log level.\n * Follows normal log method structure but logs in warn level.\n */\n warn: LogMethod;\n\n /**\n * Logging method for debug error level.\n * Follows normal log method structure but logs in error level.\n */\n error: LogMethod;\n}\n\n/**\n * A class implementing a logger with a global log level.\n */\nexport class LoggerImpl implements Logger {\n prefix: string;\n private readonly enabledLogLevelNumber: number;\n\n constructor(prefix: string, logLevel: LogLevel) {\n this.prefix = prefix;\n this.enabledLogLevelNumber = logLevelToLogLevelNumber(logLevel);\n }\n\n isDebug() {\n return this._isLogLevelEnabled(\"DEBUG\");\n }\n\n /**\n * Performs a debug log with the given message and values if DEBUG level is enabled.\n * @param message\n * @param values\n */\n debug(message: string | Error | unknown, ...values: unknown[]) {\n this._doLog(\"DEBUG\", message, values);\n }\n\n /**\n * Performs an info log with the given message and values if INFO level is enabled.\n * @param message\n * @param values\n */\n info(message: string | Error | unknown, ...values: unknown[]) {\n this._doLog(\"INFO\", message, values);\n }\n\n /**\n * Performs a warning log with the given message and values if WARN level is enabled.\n * @param message\n * @param values\n */\n warn(message: string | Error | unknown, ...values: unknown[]) {\n this._doLog(\"WARN\", message, values);\n }\n\n /**\n * Performs an error log with the given message and values if ERROR level is enabled.\n * @param message\n * @param values\n */\n error(message: string | Error | unknown, ...values: unknown[]) {\n this._doLog(\"ERROR\", message, values);\n }\n\n /**\n * Internal method for performing the log if the specified level is enabled.\n * @param level\n * @param messageOrError\n * @param values\n * @private\n */\n private _doLog(level: LogLevel, messageOrError: string | Error | unknown, values: unknown[]) {\n if (this._isLogLevelEnabled(level)) {\n let message = `[${level}] ${this.prefix}:`;\n if (!isError(messageOrError)) {\n message += \" \" + String(messageOrError);\n } else {\n values.unshift(messageOrError);\n }\n const consoleMethodName = logLevelToConsoleMethodName(level);\n console[consoleMethodName](message, ...values);\n }\n }\n\n private _isLogLevelEnabled(logLevel: LogLevel) {\n const logLevelNumber = logLevelToLogLevelNumber(logLevel);\n return logLevelNumber >= this.enabledLogLevelNumber;\n }\n}\n\n/**\n * Converts a LogLevel to a browser's debugging console method name.\n * @param logLevel\n */\nfunction logLevelToConsoleMethodName(logLevel: LogLevel): \"debug\" | \"info\" | \"warn\" | \"error\" {\n switch (logLevel) {\n case \"DEBUG\":\n return \"debug\";\n case \"INFO\":\n return \"info\";\n case \"WARN\":\n return \"warn\";\n case \"ERROR\":\n return \"error\";\n }\n}\n\nfunction logLevelToLogLevelNumber(logLevel: LogLevel) {\n return logLevelNumbers[logLevel];\n}\n\nfunction validateLogLevel(logLevelString: string): LogLevel {\n if (!logLevelString) {\n return \"INFO\";\n }\n\n switch (logLevelString) {\n case \"DEBUG\":\n case \"INFO\":\n case \"WARN\":\n case \"ERROR\":\n return logLevelString;\n default:\n throw new Error(\n `invalid log level '${logLevelString}'; allowed levels are: DEBUG, INFO, WARN, ERROR`\n );\n }\n}\n\nfunction isError(value: unknown): value is Error {\n if (value instanceof Error) {\n return true;\n }\n return !!(\n value &&\n typeof value === \"object\" &&\n typeof (value as Partial<Error>).name === \"string\" &&\n typeof (value as Partial<Error>).message === \"string\"\n );\n}\n"],"names":[],"mappings":"AAEA,MAAM,SAAA,GAAY,iBAAiB,aAAa,CAAA,CAAA;AASzC,SAAS,aAAa,MAAwB,EAAA;AACjD,EAAO,OAAA,IAAI,UAAW,CAAA,MAAA,EAAQ,SAAS,CAAA,CAAA;AAC3C,CAAA;AASA,MAAM,eAA4C,GAAA;AAAA,EAC9C,KAAO,EAAA,CAAA;AAAA,EACP,IAAM,EAAA,CAAA;AAAA,EACN,IAAM,EAAA,CAAA;AAAA,EACN,KAAO,EAAA,CAAA;AACX,CAAA,CAAA;AA4DO,MAAM,UAA6B,CAAA;AAAA,EACtC,MAAA,CAAA;AAAA,EACiB,qBAAA,CAAA;AAAA,EAEjB,WAAA,CAAY,QAAgB,QAAoB,EAAA;AAC5C,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA,CAAA;AACd,IAAK,IAAA,CAAA,qBAAA,GAAwB,yBAAyB,QAAQ,CAAA,CAAA;AAAA,GAClE;AAAA,EAEA,OAAU,GAAA;AACN,IAAO,OAAA,IAAA,CAAK,mBAAmB,OAAO,CAAA,CAAA;AAAA,GAC1C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,KAAA,CAAM,YAAsC,MAAmB,EAAA;AAC3D,IAAK,IAAA,CAAA,MAAA,CAAO,OAAS,EAAA,OAAA,EAAS,MAAM,CAAA,CAAA;AAAA,GACxC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAA,CAAK,YAAsC,MAAmB,EAAA;AAC1D,IAAK,IAAA,CAAA,MAAA,CAAO,MAAQ,EAAA,OAAA,EAAS,MAAM,CAAA,CAAA;AAAA,GACvC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAA,CAAK,YAAsC,MAAmB,EAAA;AAC1D,IAAK,IAAA,CAAA,MAAA,CAAO,MAAQ,EAAA,OAAA,EAAS,MAAM,CAAA,CAAA;AAAA,GACvC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,KAAA,CAAM,YAAsC,MAAmB,EAAA;AAC3D,IAAK,IAAA,CAAA,MAAA,CAAO,OAAS,EAAA,OAAA,EAAS,MAAM,CAAA,CAAA;AAAA,GACxC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASQ,MAAA,CAAO,KAAiB,EAAA,cAAA,EAA0C,MAAmB,EAAA;AACzF,IAAI,IAAA,IAAA,CAAK,kBAAmB,CAAA,KAAK,CAAG,EAAA;AAChC,MAAA,IAAI,OAAU,GAAA,CAAA,CAAA,EAAI,KAAK,CAAA,EAAA,EAAK,KAAK,MAAM,CAAA,CAAA,CAAA,CAAA;AACvC,MAAI,IAAA,CAAC,OAAQ,CAAA,cAAc,CAAG,EAAA;AAC1B,QAAW,OAAA,IAAA,GAAA,GAAM,OAAO,cAAc,CAAA,CAAA;AAAA,OACnC,MAAA;AACH,QAAA,MAAA,CAAO,QAAQ,cAAc,CAAA,CAAA;AAAA,OACjC;AACA,MAAM,MAAA,iBAAA,GAAoB,4BAA4B,KAAK,CAAA,CAAA;AAC3D,MAAA,OAAA,CAAQ,iBAAiB,CAAA,CAAE,OAAS,EAAA,GAAG,MAAM,CAAA,CAAA;AAAA,KACjD;AAAA,GACJ;AAAA,EAEQ,mBAAmB,QAAoB,EAAA;AAC3C,IAAM,MAAA,cAAA,GAAiB,yBAAyB,QAAQ,CAAA,CAAA;AACxD,IAAA,OAAO,kBAAkB,IAAK,CAAA,qBAAA,CAAA;AAAA,GAClC;AACJ,CAAA;AAMA,SAAS,4BAA4B,QAAyD,EAAA;AAC1F,EAAA,QAAQ,QAAU;AAAA,IACd,KAAK,OAAA;AACD,MAAO,OAAA,OAAA,CAAA;AAAA,IACX,KAAK,MAAA;AACD,MAAO,OAAA,MAAA,CAAA;AAAA,IACX,KAAK,MAAA;AACD,MAAO,OAAA,MAAA,CAAA;AAAA,IACX,KAAK,OAAA;AACD,MAAO,OAAA,OAAA,CAAA;AAAA,GACf;AACJ,CAAA;AAEA,SAAS,yBAAyB,QAAoB,EAAA;AAClD,EAAA,OAAO,gBAAgB,QAAQ,CAAA,CAAA;AACnC,CAAA;AAEA,SAAS,iBAAiB,cAAkC,EAAA;AACxD,EAAA,IAAI,CAAC,cAAgB,EAAA;AACjB,IAAO,OAAA,MAAA,CAAA;AAAA,GACX;AAEA,EAAA,QAAQ,cAAgB;AAAA,IACpB,KAAK,OAAA,CAAA;AAAA,IACL,KAAK,MAAA,CAAA;AAAA,IACL,KAAK,MAAA,CAAA;AAAA,IACL,KAAK,OAAA;AACD,MAAO,OAAA,cAAA,CAAA;AAAA,IACX;AACI,MAAA,MAAM,IAAI,KAAA;AAAA,QACN,sBAAsB,cAAc,CAAA,+CAAA,CAAA;AAAA,OACxC,CAAA;AAAA,GACR;AACJ,CAAA;AAEA,SAAS,QAAQ,KAAgC,EAAA;AAC7C,EAAA,IAAI,iBAAiB,KAAO,EAAA;AACxB,IAAO,OAAA,IAAA,CAAA;AAAA,GACX;AACA,EAAA,OAAO,CAAC,EACJ,KACA,IAAA,OAAO,KAAU,KAAA,QAAA,IACjB,OAAQ,KAAA,CAAyB,IAAS,KAAA,QAAA,IAC1C,OAAQ,KAAA,CAAyB,OAAY,KAAA,QAAA,CAAA,CAAA;AAErD;;;;"}
package/README.md CHANGED
@@ -74,4 +74,4 @@ const LOG = createLogger("example-package");
74
74
 
75
75
  ## License
76
76
 
77
- [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0)
77
+ Apache-2.0 (see `LICENSE` file)
package/error.d.ts CHANGED
@@ -30,11 +30,15 @@ export declare function getErrorChain(err: globalThis.Error): globalThis.Error[]
30
30
  /**
31
31
  * Returns true if the error represents an abort error.
32
32
  */
33
- export declare function isAbortError(err: unknown): unknown;
33
+ export declare function isAbortError(err: unknown): boolean;
34
34
  /**
35
35
  * Throws an abort error (`.name` === `"AbortError"`).
36
36
  */
37
37
  export declare function throwAbortError(): never;
38
+ /**
39
+ * Throws `err` if it is an abort error. Does nothing otherwise.
40
+ */
41
+ export declare function rethrowAbortError(err: unknown): void;
38
42
  /**
39
43
  * Returns an abort error (`.name` === `"AbortError"`).
40
44
  */
package/error.js CHANGED
@@ -23,7 +23,7 @@ function getErrorChain(err) {
23
23
  return chain;
24
24
  }
25
25
  function isAbortError(err) {
26
- return err && typeof err === "object" && "name" in err && err.name === "AbortError";
26
+ return !!(err && typeof err === "object" && "name" in err && err.name === "AbortError");
27
27
  }
28
28
  function throwAbortError() {
29
29
  throw createAbortError();
package/error.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"error.js","sources":["error.ts"],"sourcesContent":["// SPDX-FileCopyrightText: con terra GmbH and contributors\n// SPDX-License-Identifier: Apache-2.0\nconst GlobalError = globalThis.Error;\n\n/**\n * A custom error class that enforces the use of error ids.\n *\n * An error must be constructed from a (computer-readable) id and a human readable informational text.\n * An optional `cause` option can be passed to indicate the nested reason for an error.\n *\n * # Conventions\n *\n * Error ids should be scoped to a package to avoid conflicts.\n * Each package should pick a sensible namespace prefix.\n *\n * An example for a good error id is `runtime:dependency-cycle`.\n */\nexport class Error extends GlobalError {\n /** Unique error id */\n public readonly id: string;\n\n /** Human readable error message */\n public readonly text: string;\n\n constructor(id: string, text: string, options?: { cause?: unknown }) {\n super(`${id}: ${text}`, options);\n this.id = id;\n this.text = text;\n }\n}\n\n/**\n * Returns the error chain for the given `err`, starting with this error.\n * The error chain contains the error itself and all its causes.\n * The first entry is `err` itself.\n */\nexport function getErrorChain(err: globalThis.Error): globalThis.Error[] {\n const chain: globalThis.Error[] = [];\n do {\n chain.push(err);\n\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n const cause = (err as any).cause as unknown;\n if (!(cause instanceof GlobalError)) {\n break;\n }\n err = cause;\n } while (1); // eslint-disable-line no-constant-condition\n return chain;\n}\n\n/**\n * Returns true if the error represents an abort error.\n */\nexport function isAbortError(err: unknown) {\n return err && typeof err === \"object\" && \"name\" in err && err.name === \"AbortError\";\n}\n\n/**\n * Throws an abort error (`.name` === `\"AbortError\"`).\n */\nexport function throwAbortError(): never {\n throw createAbortError();\n}\n\n/**\n * Returns an abort error (`.name` === `\"AbortError\"`).\n */\nexport function createAbortError(): globalThis.Error {\n const err = new globalThis.Error(\"Aborted\");\n err.name = \"AbortError\";\n return err;\n}\n"],"names":[],"mappings":"AAEA,MAAM,cAAc,UAAW,CAAA,KAAA,CAAA;AAexB,MAAM,cAAc,WAAY,CAAA;AAAA;AAAA,EAEnB,EAAA,CAAA;AAAA;AAAA,EAGA,IAAA,CAAA;AAAA,EAEhB,WAAA,CAAY,EAAY,EAAA,IAAA,EAAc,OAA+B,EAAA;AACjE,IAAM,KAAA,CAAA,CAAA,EAAG,EAAO,CAAA,EAAA,EAAA,IAAA,CAAA,CAAA,EAAQ,OAAO,CAAA,CAAA;AAC/B,IAAA,IAAA,CAAK,EAAK,GAAA,EAAA,CAAA;AACV,IAAA,IAAA,CAAK,IAAO,GAAA,IAAA,CAAA;AAAA,GAChB;AACJ,CAAA;AAOO,SAAS,cAAc,GAA2C,EAAA;AACrE,EAAA,MAAM,QAA4B,EAAC,CAAA;AACnC,EAAG,GAAA;AACC,IAAA,KAAA,CAAM,KAAK,GAAG,CAAA,CAAA;AAGd,IAAA,MAAM,QAAS,GAAY,CAAA,KAAA,CAAA;AAC3B,IAAI,IAAA,EAAE,iBAAiB,WAAc,CAAA,EAAA;AACjC,MAAA,MAAA;AAAA,KACJ;AACA,IAAM,GAAA,GAAA,KAAA,CAAA;AAAA,GACD,QAAA,CAAA,EAAA;AACT,EAAO,OAAA,KAAA,CAAA;AACX,CAAA;AAKO,SAAS,aAAa,GAAc,EAAA;AACvC,EAAA,OAAO,OAAO,OAAO,GAAA,KAAQ,YAAY,MAAU,IAAA,GAAA,IAAO,IAAI,IAAS,KAAA,YAAA,CAAA;AAC3E,CAAA;AAKO,SAAS,eAAyB,GAAA;AACrC,EAAA,MAAM,gBAAiB,EAAA,CAAA;AAC3B,CAAA;AAKO,SAAS,gBAAqC,GAAA;AACjD,EAAA,MAAM,GAAM,GAAA,IAAI,UAAW,CAAA,KAAA,CAAM,SAAS,CAAA,CAAA;AAC1C,EAAA,GAAA,CAAI,IAAO,GAAA,YAAA,CAAA;AACX,EAAO,OAAA,GAAA,CAAA;AACX;;;;"}
1
+ {"version":3,"file":"error.js","sources":["error.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nconst GlobalError = globalThis.Error;\n\n/**\n * A custom error class that enforces the use of error ids.\n *\n * An error must be constructed from a (computer-readable) id and a human readable informational text.\n * An optional `cause` option can be passed to indicate the nested reason for an error.\n *\n * # Conventions\n *\n * Error ids should be scoped to a package to avoid conflicts.\n * Each package should pick a sensible namespace prefix.\n *\n * An example for a good error id is `runtime:dependency-cycle`.\n */\nexport class Error extends GlobalError {\n /** Unique error id */\n public readonly id: string;\n\n /** Human readable error message */\n public readonly text: string;\n\n constructor(id: string, text: string, options?: { cause?: unknown }) {\n super(`${id}: ${text}`, options);\n this.id = id;\n this.text = text;\n }\n}\n\n/**\n * Returns the error chain for the given `err`, starting with this error.\n * The error chain contains the error itself and all its causes.\n * The first entry is `err` itself.\n */\nexport function getErrorChain(err: globalThis.Error): globalThis.Error[] {\n const chain: globalThis.Error[] = [];\n do {\n chain.push(err);\n\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n const cause = (err as any).cause as unknown;\n if (!(cause instanceof GlobalError)) {\n break;\n }\n err = cause;\n } while (1); // eslint-disable-line no-constant-condition\n return chain;\n}\n\n/**\n * Returns true if the error represents an abort error.\n */\nexport function isAbortError(err: unknown): boolean {\n return !!(err && typeof err === \"object\" && \"name\" in err && err.name === \"AbortError\");\n}\n\n/**\n * Throws an abort error (`.name` === `\"AbortError\"`).\n */\nexport function throwAbortError(): never {\n throw createAbortError();\n}\n\n/**\n * Throws `err` if it is an abort error. Does nothing otherwise.\n */\nexport function rethrowAbortError(err: unknown): void {\n if (isAbortError(err)) {\n throw err;\n }\n}\n\n/**\n * Returns an abort error (`.name` === `\"AbortError\"`).\n */\nexport function createAbortError(): globalThis.Error {\n const err = new globalThis.Error(\"Aborted\");\n err.name = \"AbortError\";\n return err;\n}\n"],"names":[],"mappings":"AAEA,MAAM,cAAc,UAAW,CAAA,KAAA,CAAA;AAexB,MAAM,cAAc,WAAY,CAAA;AAAA;AAAA,EAEnB,EAAA,CAAA;AAAA;AAAA,EAGA,IAAA,CAAA;AAAA,EAEhB,WAAA,CAAY,EAAY,EAAA,IAAA,EAAc,OAA+B,EAAA;AACjE,IAAA,KAAA,CAAM,CAAG,EAAA,EAAE,CAAK,EAAA,EAAA,IAAI,IAAI,OAAO,CAAA,CAAA;AAC/B,IAAA,IAAA,CAAK,EAAK,GAAA,EAAA,CAAA;AACV,IAAA,IAAA,CAAK,IAAO,GAAA,IAAA,CAAA;AAAA,GAChB;AACJ,CAAA;AAOO,SAAS,cAAc,GAA2C,EAAA;AACrE,EAAA,MAAM,QAA4B,EAAC,CAAA;AACnC,EAAG,GAAA;AACC,IAAA,KAAA,CAAM,KAAK,GAAG,CAAA,CAAA;AAGd,IAAA,MAAM,QAAS,GAAY,CAAA,KAAA,CAAA;AAC3B,IAAI,IAAA,EAAE,iBAAiB,WAAc,CAAA,EAAA;AACjC,MAAA,MAAA;AAAA,KACJ;AACA,IAAM,GAAA,GAAA,KAAA,CAAA;AAAA,GACD,QAAA,CAAA,EAAA;AACT,EAAO,OAAA,KAAA,CAAA;AACX,CAAA;AAKO,SAAS,aAAa,GAAuB,EAAA;AAChD,EAAO,OAAA,CAAC,EAAE,GAAO,IAAA,OAAO,QAAQ,QAAY,IAAA,MAAA,IAAU,GAAO,IAAA,GAAA,CAAI,IAAS,KAAA,YAAA,CAAA,CAAA;AAC9E,CAAA;AAKO,SAAS,eAAyB,GAAA;AACrC,EAAA,MAAM,gBAAiB,EAAA,CAAA;AAC3B,CAAA;AAcO,SAAS,gBAAqC,GAAA;AACjD,EAAA,MAAM,GAAM,GAAA,IAAI,UAAW,CAAA,KAAA,CAAM,SAAS,CAAA,CAAA;AAC1C,EAAA,GAAA,CAAI,IAAO,GAAA,YAAA,CAAA;AACX,EAAO,OAAA,GAAA,CAAA;AACX;;;;"}
package/events.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"events.js","sources":["events.ts"],"sourcesContent":["// SPDX-FileCopyrightText: con terra GmbH and contributors\n// SPDX-License-Identifier: Apache-2.0\nimport { Resource } from \"./resources\";\n\nconst state = Symbol(\"EventEmitterState\");\n\nexport type EventNames<Events extends {}> = keyof Events & string;\n\ntype ArgType<T> = [T] extends [void] ? [] : [event: T];\n\ntype EventType<Events extends {}, Name extends keyof Events> = ArgType<Events[Name]>;\n\n/**\n * A support class that implements emitting and listening for events.\n *\n * This class supports inheritance or direct use:\n *\n * ```js\n * const emitter = new EventEmitter();\n * class MyClass extends EventEmitter {};\n * ```\n *\n * When using this class from TypeScript, declare your supported event\n * types using an interface first:\n *\n * ```ts\n * interface Events {\n * // key: event name, value: event type\n * \"mouse-clicked\": MouseEvent;\n * }\n *\n * const emitter = new EventEmitter<Events>();\n * emitter.on(\"mouse-clicked\", (event) => {\n * // event is a MouseEvent\n * });\n * emitter.emit(\"mouse-clicked\", new MouseEvent(...));\n * ```\n */\nexport class EventEmitter<Events extends {}> {\n private [state] = new EventEmitterState();\n\n /**\n * Registers the given listener function as an event handler for `eventName`.\n *\n * The listener function should be unregistered by destroying the returned {@link Resource}\n * when it is no longer needed.\n */\n on<Name extends EventNames<Events>>(\n eventName: Name,\n listener: (...args: EventType<Events, Name>) => void\n ): Resource {\n return this[state].on(eventName, {\n listener: listener as InternalListener\n });\n }\n\n /**\n * Registers the given listener function to listen for `eventName` events _once_.\n * The listener function will automatically be unregistered after it has been called.\n *\n * The listener function should be unregistered by destroying the returned {@link Resource}.\n */\n once<Name extends EventNames<Events>>(\n eventName: Name,\n listener: (...args: EventType<Events, Name>) => void\n ): Resource {\n return this[state].on(eventName, {\n listener: listener as InternalListener,\n once: true\n });\n }\n\n /**\n * Emits an event of the given name and calls the registered event handlers.\n *\n * _Note:_ event handlers run synchronously.\n * After `emit()` has completed, all listeners will already have been invoked.\n */\n emit<Name extends EventNames<Events>>(eventName: Name, ...args: EventType<Events, Name>): void {\n this[state].emit(eventName, args[0]);\n }\n}\n\n/**\n * Read-only version of the {@link EventEmitter} interface that only allows listening for events.\n */\nexport type EventSource<Events extends {}> = Pick<EventEmitter<Events>, \"on\" | \"once\">;\n\ntype InternalListener = (event: unknown) => void;\n\ninterface EventHandler {\n once?: boolean;\n removed?: boolean;\n listener: InternalListener;\n}\n\nclass EventEmitterState {\n private handlers = new Map<string, Set<EventHandler>>();\n\n on(name: string, handler: EventHandler): Resource {\n let handlers = this.handlers.get(name);\n if (!handlers) {\n handlers = new Set();\n this.handlers.set(name, handlers);\n }\n handlers.add(handler);\n return {\n destroy() {\n handler.removed = true;\n handlers?.delete(handler);\n handlers = undefined;\n }\n };\n }\n\n emit(name: string, event: unknown) {\n const handlers = this.handlers.get(name);\n if (!handlers) {\n return;\n }\n\n // Copy to allow (de-) registration of handlers during emit.\n // This is convenient for correctness but may been further optimization\n // if events are emitted frequently.\n const copy = [...handlers];\n for (const handler of copy) {\n if (handler.removed) {\n continue;\n }\n\n if (handler.once) {\n handler.removed = true;\n handlers.delete(handler);\n }\n handler.listener(event);\n }\n }\n}\n"],"names":[],"mappings":"AAIA,MAAM,KAAA,GAAQ,OAAO,mBAAmB,CAAA,CAAA;AAkCjC,MAAM,YAAgC,CAAA;AAAA,EACzC,CAAS,KAAK,IAAI,IAAI,iBAAkB,EAAA,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQxC,EAAA,CACI,WACA,QACQ,EAAA;AACR,IAAA,OAAO,IAAK,CAAA,KAAK,CAAE,CAAA,EAAA,CAAG,SAAW,EAAA;AAAA,MAC7B,QAAA;AAAA,KACH,CAAA,CAAA;AAAA,GACL;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,IAAA,CACI,WACA,QACQ,EAAA;AACR,IAAA,OAAO,IAAK,CAAA,KAAK,CAAE,CAAA,EAAA,CAAG,SAAW,EAAA;AAAA,MAC7B,QAAA;AAAA,MACA,IAAM,EAAA,IAAA;AAAA,KACT,CAAA,CAAA;AAAA,GACL;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,IAAA,CAAsC,cAAoB,IAAqC,EAAA;AAC3F,IAAA,IAAA,CAAK,KAAK,CAAE,CAAA,IAAA,CAAK,SAAW,EAAA,IAAA,CAAK,CAAC,CAAC,CAAA,CAAA;AAAA,GACvC;AACJ,CAAA;AAeA,MAAM,iBAAkB,CAAA;AAAA,EACZ,QAAA,uBAAe,GAA+B,EAAA,CAAA;AAAA,EAEtD,EAAA,CAAG,MAAc,OAAiC,EAAA;AAC9C,IAAA,IAAI,QAAW,GAAA,IAAA,CAAK,QAAS,CAAA,GAAA,CAAI,IAAI,CAAA,CAAA;AACrC,IAAA,IAAI,CAAC,QAAU,EAAA;AACX,MAAA,QAAA,uBAAe,GAAI,EAAA,CAAA;AACnB,MAAK,IAAA,CAAA,QAAA,CAAS,GAAI,CAAA,IAAA,EAAM,QAAQ,CAAA,CAAA;AAAA,KACpC;AACA,IAAA,QAAA,CAAS,IAAI,OAAO,CAAA,CAAA;AACpB,IAAO,OAAA;AAAA,MACH,OAAU,GAAA;AACN,QAAA,OAAA,CAAQ,OAAU,GAAA,IAAA,CAAA;AAClB,QAAA,QAAA,EAAU,OAAO,OAAO,CAAA,CAAA;AACxB,QAAW,QAAA,GAAA,KAAA,CAAA,CAAA;AAAA,OACf;AAAA,KACJ,CAAA;AAAA,GACJ;AAAA,EAEA,IAAA,CAAK,MAAc,KAAgB,EAAA;AAC/B,IAAA,MAAM,QAAW,GAAA,IAAA,CAAK,QAAS,CAAA,GAAA,CAAI,IAAI,CAAA,CAAA;AACvC,IAAA,IAAI,CAAC,QAAU,EAAA;AACX,MAAA,OAAA;AAAA,KACJ;AAKA,IAAM,MAAA,IAAA,GAAO,CAAC,GAAG,QAAQ,CAAA,CAAA;AACzB,IAAA,KAAA,MAAW,WAAW,IAAM,EAAA;AACxB,MAAA,IAAI,QAAQ,OAAS,EAAA;AACjB,QAAA,SAAA;AAAA,OACJ;AAEA,MAAA,IAAI,QAAQ,IAAM,EAAA;AACd,QAAA,OAAA,CAAQ,OAAU,GAAA,IAAA,CAAA;AAClB,QAAA,QAAA,CAAS,OAAO,OAAO,CAAA,CAAA;AAAA,OAC3B;AACA,MAAA,OAAA,CAAQ,SAAS,KAAK,CAAA,CAAA;AAAA,KAC1B;AAAA,GACJ;AACJ;;;;"}
1
+ {"version":3,"file":"events.js","sources":["events.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport { Resource } from \"./resources\";\n\nconst state = Symbol(\"EventEmitterState\");\n\nexport type EventNames<Events extends {}> = keyof Events & string;\n\ntype ArgType<T> = [T] extends [void] ? [] : [event: T];\n\ntype EventType<Events extends {}, Name extends keyof Events> = ArgType<Events[Name]>;\n\n/**\n * A support class that implements emitting and listening for events.\n *\n * This class supports inheritance or direct use:\n *\n * ```js\n * const emitter = new EventEmitter();\n * class MyClass extends EventEmitter {};\n * ```\n *\n * When using this class from TypeScript, declare your supported event\n * types using an interface first:\n *\n * ```ts\n * interface Events {\n * // key: event name, value: event type\n * \"mouse-clicked\": MouseEvent;\n * }\n *\n * const emitter = new EventEmitter<Events>();\n * emitter.on(\"mouse-clicked\", (event) => {\n * // event is a MouseEvent\n * });\n * emitter.emit(\"mouse-clicked\", new MouseEvent(...));\n * ```\n */\nexport class EventEmitter<Events extends {}> {\n private [state] = new EventEmitterState();\n\n /**\n * Registers the given listener function as an event handler for `eventName`.\n *\n * The listener function should be unregistered by destroying the returned {@link Resource}\n * when it is no longer needed.\n */\n on<Name extends EventNames<Events>>(\n eventName: Name,\n listener: (...args: EventType<Events, Name>) => void\n ): Resource {\n return this[state].on(eventName, {\n listener: listener as InternalListener\n });\n }\n\n /**\n * Registers the given listener function to listen for `eventName` events _once_.\n * The listener function will automatically be unregistered after it has been called.\n *\n * The listener function should be unregistered by destroying the returned {@link Resource}.\n */\n once<Name extends EventNames<Events>>(\n eventName: Name,\n listener: (...args: EventType<Events, Name>) => void\n ): Resource {\n return this[state].on(eventName, {\n listener: listener as InternalListener,\n once: true\n });\n }\n\n /**\n * Emits an event of the given name and calls the registered event handlers.\n *\n * _Note:_ event handlers run synchronously.\n * After `emit()` has completed, all listeners will already have been invoked.\n */\n emit<Name extends EventNames<Events>>(eventName: Name, ...args: EventType<Events, Name>): void {\n this[state].emit(eventName, args[0]);\n }\n}\n\n/**\n * Read-only version of the {@link EventEmitter} interface that only allows listening for events.\n */\nexport type EventSource<Events extends {}> = Pick<EventEmitter<Events>, \"on\" | \"once\">;\n\ntype InternalListener = (event: unknown) => void;\n\ninterface EventHandler {\n once?: boolean;\n removed?: boolean;\n listener: InternalListener;\n}\n\nclass EventEmitterState {\n private handlers = new Map<string, Set<EventHandler>>();\n\n on(name: string, handler: EventHandler): Resource {\n let handlers = this.handlers.get(name);\n if (!handlers) {\n handlers = new Set();\n this.handlers.set(name, handlers);\n }\n handlers.add(handler);\n return {\n destroy() {\n handler.removed = true;\n handlers?.delete(handler);\n handlers = undefined;\n }\n };\n }\n\n emit(name: string, event: unknown) {\n const handlers = this.handlers.get(name);\n if (!handlers) {\n return;\n }\n\n // Copy to allow (de-) registration of handlers during emit.\n // This is convenient for correctness but may been further optimization\n // if events are emitted frequently.\n const copy = [...handlers];\n for (const handler of copy) {\n if (handler.removed) {\n continue;\n }\n\n if (handler.once) {\n handler.removed = true;\n handlers.delete(handler);\n }\n handler.listener(event);\n }\n }\n}\n"],"names":[],"mappings":"AAIA,MAAM,KAAA,GAAQ,OAAO,mBAAmB,CAAA,CAAA;AAkCjC,MAAM,YAAgC,CAAA;AAAA,EACzC,CAAS,KAAK,IAAI,IAAI,iBAAkB,EAAA,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQxC,EAAA,CACI,WACA,QACQ,EAAA;AACR,IAAA,OAAO,IAAK,CAAA,KAAK,CAAE,CAAA,EAAA,CAAG,SAAW,EAAA;AAAA,MAC7B,QAAA;AAAA,KACH,CAAA,CAAA;AAAA,GACL;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,IAAA,CACI,WACA,QACQ,EAAA;AACR,IAAA,OAAO,IAAK,CAAA,KAAK,CAAE,CAAA,EAAA,CAAG,SAAW,EAAA;AAAA,MAC7B,QAAA;AAAA,MACA,IAAM,EAAA,IAAA;AAAA,KACT,CAAA,CAAA;AAAA,GACL;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,IAAA,CAAsC,cAAoB,IAAqC,EAAA;AAC3F,IAAA,IAAA,CAAK,KAAK,CAAE,CAAA,IAAA,CAAK,SAAW,EAAA,IAAA,CAAK,CAAC,CAAC,CAAA,CAAA;AAAA,GACvC;AACJ,CAAA;AAeA,MAAM,iBAAkB,CAAA;AAAA,EACZ,QAAA,uBAAe,GAA+B,EAAA,CAAA;AAAA,EAEtD,EAAA,CAAG,MAAc,OAAiC,EAAA;AAC9C,IAAA,IAAI,QAAW,GAAA,IAAA,CAAK,QAAS,CAAA,GAAA,CAAI,IAAI,CAAA,CAAA;AACrC,IAAA,IAAI,CAAC,QAAU,EAAA;AACX,MAAA,QAAA,uBAAe,GAAI,EAAA,CAAA;AACnB,MAAK,IAAA,CAAA,QAAA,CAAS,GAAI,CAAA,IAAA,EAAM,QAAQ,CAAA,CAAA;AAAA,KACpC;AACA,IAAA,QAAA,CAAS,IAAI,OAAO,CAAA,CAAA;AACpB,IAAO,OAAA;AAAA,MACH,OAAU,GAAA;AACN,QAAA,OAAA,CAAQ,OAAU,GAAA,IAAA,CAAA;AAClB,QAAA,QAAA,EAAU,OAAO,OAAO,CAAA,CAAA;AACxB,QAAW,QAAA,GAAA,KAAA,CAAA,CAAA;AAAA,OACf;AAAA,KACJ,CAAA;AAAA,GACJ;AAAA,EAEA,IAAA,CAAK,MAAc,KAAgB,EAAA;AAC/B,IAAA,MAAM,QAAW,GAAA,IAAA,CAAK,QAAS,CAAA,GAAA,CAAI,IAAI,CAAA,CAAA;AACvC,IAAA,IAAI,CAAC,QAAU,EAAA;AACX,MAAA,OAAA;AAAA,KACJ;AAKA,IAAM,MAAA,IAAA,GAAO,CAAC,GAAG,QAAQ,CAAA,CAAA;AACzB,IAAA,KAAA,MAAW,WAAW,IAAM,EAAA;AACxB,MAAA,IAAI,QAAQ,OAAS,EAAA;AACjB,QAAA,SAAA;AAAA,OACJ;AAEA,MAAA,IAAI,QAAQ,IAAM,EAAA;AACd,QAAA,OAAA,CAAQ,OAAU,GAAA,IAAA,CAAA;AAClB,QAAA,QAAA,CAAS,OAAO,OAAO,CAAA,CAAA;AAAA,OAC3B;AACA,MAAA,OAAA,CAAQ,SAAS,KAAK,CAAA,CAAA;AAAA,KAC1B;AAAA,GACJ;AACJ;;;;"}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "type": "module",
3
3
  "name": "@open-pioneer/core",
4
- "version": "1.0.1",
4
+ "version": "1.2.0",
5
5
  "license": "Apache-2.0",
6
6
  "exports": {
7
7
  "./package.json": "./package.json",
package/resources.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"resources.js","sources":["resources.ts"],"sourcesContent":["// SPDX-FileCopyrightText: con terra GmbH and contributors\n// SPDX-License-Identifier: Apache-2.0\n/**\n * An object that has some cleanup code associated with it.\n */\nexport interface Resource {\n /** A function that releases any state held by the resource. */\n destroy(): void;\n}\n\n/**\n * A helper function that invokes `destroy()` on the given resource and returns undefined.\n *\n * Example:\n *\n * ```js\n * class Holder {\n * private myResource: Resource | undefined;\n *\n * destroy() {\n * this.myResource = destroyResource(this.myResource);\n * }\n * }\n * ```\n */\nexport function destroyResource<R extends Resource>(resource: R | undefined): undefined {\n resource?.destroy();\n return undefined;\n}\n"],"names":[],"mappings":"AAyBO,SAAS,gBAAoC,QAAoC,EAAA;AACpF,EAAA,QAAA,EAAU,OAAQ,EAAA,CAAA;AAClB,EAAO,OAAA,KAAA,CAAA,CAAA;AACX;;;;"}
1
+ {"version":3,"file":"resources.js","sources":["resources.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\n/**\n * An object that has some cleanup code associated with it.\n */\nexport interface Resource {\n /** A function that releases any state held by the resource. */\n destroy(): void;\n}\n\n/**\n * A helper function that invokes `destroy()` on the given resource and returns undefined.\n *\n * Example:\n *\n * ```js\n * class Holder {\n * private myResource: Resource | undefined;\n *\n * destroy() {\n * this.myResource = destroyResource(this.myResource);\n * }\n * }\n * ```\n */\nexport function destroyResource<R extends Resource>(resource: R | undefined): undefined {\n resource?.destroy();\n return undefined;\n}\n"],"names":[],"mappings":"AAyBO,SAAS,gBAAoC,QAAoC,EAAA;AACpF,EAAA,QAAA,EAAU,OAAQ,EAAA,CAAA;AAClB,EAAO,OAAA,KAAA,CAAA,CAAA;AACX;;;;"}
package/utils.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"utils.js","sources":["utils.ts"],"sourcesContent":["// SPDX-FileCopyrightText: con terra GmbH and contributors\n// SPDX-License-Identifier: Apache-2.0\n\n/**\n * A manual promise that also exposes its `resolve` and `reject` functions.\n *\n * The user must take care to always call either `resolve` or `reject` at least once,\n * otherwise clients waiting for the `promise` may wait forever.\n */\nexport interface ManualPromise<T> {\n promise: Promise<T>;\n resolve(value: T): void;\n reject(error: unknown): void;\n}\n\nexport function createManualPromise<T>(): ManualPromise<T> {\n let resolve!: (value: T) => void;\n let reject!: (error: unknown) => void;\n const promise = new Promise<T>((res, rej) => {\n resolve = res;\n reject = rej;\n });\n return {\n promise,\n resolve,\n reject\n };\n}\n"],"names":[],"mappings":"AAeO,SAAS,mBAA2C,GAAA;AACvD,EAAI,IAAA,OAAA,CAAA;AACJ,EAAI,IAAA,MAAA,CAAA;AACJ,EAAA,MAAM,OAAU,GAAA,IAAI,OAAW,CAAA,CAAC,KAAK,GAAQ,KAAA;AACzC,IAAU,OAAA,GAAA,GAAA,CAAA;AACV,IAAS,MAAA,GAAA,GAAA,CAAA;AAAA,GACZ,CAAA,CAAA;AACD,EAAO,OAAA;AAAA,IACH,OAAA;AAAA,IACA,OAAA;AAAA,IACA,MAAA;AAAA,GACJ,CAAA;AACJ;;;;"}
1
+ {"version":3,"file":"utils.js","sources":["utils.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\n\n/**\n * A manual promise that also exposes its `resolve` and `reject` functions.\n *\n * The user must take care to always call either `resolve` or `reject` at least once,\n * otherwise clients waiting for the `promise` may wait forever.\n */\nexport interface ManualPromise<T> {\n promise: Promise<T>;\n resolve(value: T): void;\n reject(error: unknown): void;\n}\n\nexport function createManualPromise<T>(): ManualPromise<T> {\n let resolve!: (value: T) => void;\n let reject!: (error: unknown) => void;\n const promise = new Promise<T>((res, rej) => {\n resolve = res;\n reject = rej;\n });\n return {\n promise,\n resolve,\n reject\n };\n}\n"],"names":[],"mappings":"AAeO,SAAS,mBAA2C,GAAA;AACvD,EAAI,IAAA,OAAA,CAAA;AACJ,EAAI,IAAA,MAAA,CAAA;AACJ,EAAA,MAAM,OAAU,GAAA,IAAI,OAAW,CAAA,CAAC,KAAK,GAAQ,KAAA;AACzC,IAAU,OAAA,GAAA,GAAA,CAAA;AACV,IAAS,MAAA,GAAA,GAAA,CAAA;AAAA,GACZ,CAAA,CAAA;AACD,EAAO,OAAA;AAAA,IACH,OAAA;AAAA,IACA,OAAA;AAAA,IACA,MAAA;AAAA,GACJ,CAAA;AACJ;;;;"}