@open-pioneer/core 4.1.0-dev.20250707115222 → 4.1.0-dev.20250818125237

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,6 +1,10 @@
1
1
  # @open-pioneer/core
2
2
 
3
- ## 4.1.0-dev.20250707115222
3
+ ## 4.1.0-dev.20250818125237
4
+
5
+ ### Minor Changes
6
+
7
+ - 2da02e7: Implement a helper for printing deprecation messages.
4
8
 
5
9
  ### Patch Changes
6
10
 
package/Logger.js CHANGED
@@ -1,4 +1,4 @@
1
- const LOG_LEVEL = validateLogLevel(__LOG_LEVEL__);
1
+ const LOG_LEVEL = typeof __LOG_LEVEL__ !== "undefined" ? validateLogLevel(__LOG_LEVEL__) : "INFO";
2
2
  function createLogger(prefix) {
3
3
  return new LoggerImpl(prefix, LOG_LEVEL);
4
4
  }
package/Logger.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"Logger.js","sources":["Logger.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023-2025 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;AASzC,SAAS,aAAa,MAAwB,EAAA;AACjD,EAAO,OAAA,IAAI,UAAW,CAAA,MAAA,EAAQ,SAAS,CAAA;AAC3C;AASA,MAAM,eAA4C,GAAA;AAAA,EAC9C,KAAO,EAAA,CAAA;AAAA,EACP,IAAM,EAAA,CAAA;AAAA,EACN,IAAM,EAAA,CAAA;AAAA,EACN,KAAO,EAAA;AACX,CAAA;AA4DO,MAAM,UAA6B,CAAA;AAAA,EACtC,MAAA;AAAA,EACiB,qBAAA;AAAA,EAEjB,WAAA,CAAY,QAAgB,QAAoB,EAAA;AAC5C,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA;AACd,IAAK,IAAA,CAAA,qBAAA,GAAwB,yBAAyB,QAAQ,CAAA;AAAA;AAClE,EAEA,OAAU,GAAA;AACN,IAAO,OAAA,IAAA,CAAK,mBAAmB,OAAO,CAAA;AAAA;AAC1C;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,KAAA,CAAM,YAAsC,MAAmB,EAAA;AAC3D,IAAK,IAAA,CAAA,MAAA,CAAO,OAAS,EAAA,OAAA,EAAS,MAAM,CAAA;AAAA;AACxC;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAA,CAAK,YAAsC,MAAmB,EAAA;AAC1D,IAAK,IAAA,CAAA,MAAA,CAAO,MAAQ,EAAA,OAAA,EAAS,MAAM,CAAA;AAAA;AACvC;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAA,CAAK,YAAsC,MAAmB,EAAA;AAC1D,IAAK,IAAA,CAAA,MAAA,CAAO,MAAQ,EAAA,OAAA,EAAS,MAAM,CAAA;AAAA;AACvC;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,KAAA,CAAM,YAAsC,MAAmB,EAAA;AAC3D,IAAK,IAAA,CAAA,MAAA,CAAO,OAAS,EAAA,OAAA,EAAS,MAAM,CAAA;AAAA;AACxC;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;AACvC,MAAI,IAAA,CAAC,OAAQ,CAAA,cAAc,CAAG,EAAA;AAC1B,QAAW,OAAA,IAAA,GAAA,GAAM,OAAO,cAAc,CAAA;AAAA,OACnC,MAAA;AACH,QAAA,MAAA,CAAO,QAAQ,cAAc,CAAA;AAAA;AAEjC,MAAM,MAAA,iBAAA,GAAoB,4BAA4B,KAAK,CAAA;AAC3D,MAAA,OAAA,CAAQ,iBAAiB,CAAA,CAAE,OAAS,EAAA,GAAG,MAAM,CAAA;AAAA;AACjD;AACJ,EAEQ,mBAAmB,QAAoB,EAAA;AAC3C,IAAM,MAAA,cAAA,GAAiB,yBAAyB,QAAQ,CAAA;AACxD,IAAA,OAAO,kBAAkB,IAAK,CAAA,qBAAA;AAAA;AAEtC;AAMA,SAAS,4BAA4B,QAAyD,EAAA;AAC1F,EAAA,QAAQ,QAAU;AAAA,IACd,KAAK,OAAA;AACD,MAAO,OAAA,OAAA;AAAA,IACX,KAAK,MAAA;AACD,MAAO,OAAA,MAAA;AAAA,IACX,KAAK,MAAA;AACD,MAAO,OAAA,MAAA;AAAA,IACX,KAAK,OAAA;AACD,MAAO,OAAA,OAAA;AAAA;AAEnB;AAEA,SAAS,yBAAyB,QAAoB,EAAA;AAClD,EAAA,OAAO,gBAAgB,QAAQ,CAAA;AACnC;AAEA,SAAS,iBAAiB,cAAkC,EAAA;AACxD,EAAA,IAAI,CAAC,cAAgB,EAAA;AACjB,IAAO,OAAA,MAAA;AAAA;AAGX,EAAA,QAAQ,cAAgB;AAAA,IACpB,KAAK,OAAA;AAAA,IACL,KAAK,MAAA;AAAA,IACL,KAAK,MAAA;AAAA,IACL,KAAK,OAAA;AACD,MAAO,OAAA,cAAA;AAAA,IACX;AACI,MAAA,MAAM,IAAI,KAAA;AAAA,QACN,sBAAsB,cAAc,CAAA,+CAAA;AAAA,OACxC;AAAA;AAEZ;AAEA,SAAS,QAAQ,KAAgC,EAAA;AAC7C,EAAA,IAAI,iBAAiB,KAAO,EAAA;AACxB,IAAO,OAAA,IAAA;AAAA;AAEX,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;AAErD;;;;"}
1
+ {"version":3,"file":"Logger.js","sources":["Logger.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023-2025 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nconst LOG_LEVEL = typeof __LOG_LEVEL__ !== \"undefined\" ? validateLogLevel(__LOG_LEVEL__) : \"INFO\";\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,YAAY,OAAO,aAAA,KAAkB,WAAA,GAAc,gBAAA,CAAiB,aAAa,CAAA,GAAI,MAAA;AASpF,SAAS,aAAa,MAAA,EAAwB;AACjD,EAAA,OAAO,IAAI,UAAA,CAAW,MAAA,EAAQ,SAAS,CAAA;AAC3C;AASA,MAAM,eAAA,GAA4C;AAAA,EAC9C,KAAA,EAAO,CAAA;AAAA,EACP,IAAA,EAAM,CAAA;AAAA,EACN,IAAA,EAAM,CAAA;AAAA,EACN,KAAA,EAAO;AACX,CAAA;AA4DO,MAAM,UAAA,CAA6B;AAAA,EACtC,MAAA;AAAA,EACiB,qBAAA;AAAA,EAEjB,WAAA,CAAY,QAAgB,QAAA,EAAoB;AAC5C,IAAA,IAAA,CAAK,MAAA,GAAS,MAAA;AACd,IAAA,IAAA,CAAK,qBAAA,GAAwB,yBAAyB,QAAQ,CAAA;AAAA,EAClE;AAAA,EAEA,OAAA,GAAU;AACN,IAAA,OAAO,IAAA,CAAK,mBAAmB,OAAO,CAAA;AAAA,EAC1C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,KAAA,CAAM,YAAsC,MAAA,EAAmB;AAC3D,IAAA,IAAA,CAAK,MAAA,CAAO,OAAA,EAAS,OAAA,EAAS,MAAM,CAAA;AAAA,EACxC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAA,CAAK,YAAsC,MAAA,EAAmB;AAC1D,IAAA,IAAA,CAAK,MAAA,CAAO,MAAA,EAAQ,OAAA,EAAS,MAAM,CAAA;AAAA,EACvC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAA,CAAK,YAAsC,MAAA,EAAmB;AAC1D,IAAA,IAAA,CAAK,MAAA,CAAO,MAAA,EAAQ,OAAA,EAAS,MAAM,CAAA;AAAA,EACvC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,KAAA,CAAM,YAAsC,MAAA,EAAmB;AAC3D,IAAA,IAAA,CAAK,MAAA,CAAO,OAAA,EAAS,OAAA,EAAS,MAAM,CAAA;AAAA,EACxC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASQ,MAAA,CAAO,KAAA,EAAiB,cAAA,EAA0C,MAAA,EAAmB;AACzF,IAAA,IAAI,IAAA,CAAK,kBAAA,CAAmB,KAAK,CAAA,EAAG;AAChC,MAAA,IAAI,OAAA,GAAU,CAAA,CAAA,EAAI,KAAK,CAAA,EAAA,EAAK,KAAK,MAAM,CAAA,CAAA,CAAA;AACvC,MAAA,IAAI,CAAC,OAAA,CAAQ,cAAc,CAAA,EAAG;AAC1B,QAAA,OAAA,IAAW,GAAA,GAAM,OAAO,cAAc,CAAA;AAAA,MAC1C,CAAA,MAAO;AACH,QAAA,MAAA,CAAO,QAAQ,cAAc,CAAA;AAAA,MACjC;AACA,MAAA,MAAM,iBAAA,GAAoB,4BAA4B,KAAK,CAAA;AAC3D,MAAA,OAAA,CAAQ,iBAAiB,CAAA,CAAE,OAAA,EAAS,GAAG,MAAM,CAAA;AAAA,IACjD;AAAA,EACJ;AAAA,EAEQ,mBAAmB,QAAA,EAAoB;AAC3C,IAAA,MAAM,cAAA,GAAiB,yBAAyB,QAAQ,CAAA;AACxD,IAAA,OAAO,kBAAkB,IAAA,CAAK,qBAAA;AAAA,EAClC;AACJ;AAMA,SAAS,4BAA4B,QAAA,EAAyD;AAC1F,EAAA,QAAQ,QAAA;AAAU,IACd,KAAK,OAAA;AACD,MAAA,OAAO,OAAA;AAAA,IACX,KAAK,MAAA;AACD,MAAA,OAAO,MAAA;AAAA,IACX,KAAK,MAAA;AACD,MAAA,OAAO,MAAA;AAAA,IACX,KAAK,OAAA;AACD,MAAA,OAAO,OAAA;AAAA;AAEnB;AAEA,SAAS,yBAAyB,QAAA,EAAoB;AAClD,EAAA,OAAO,gBAAgB,QAAQ,CAAA;AACnC;AAEA,SAAS,iBAAiB,cAAA,EAAkC;AACxD,EAAA,IAAI,CAAC,cAAA,EAAgB;AACjB,IAAA,OAAO,MAAA;AAAA,EACX;AAEA,EAAA,QAAQ,cAAA;AAAgB,IACpB,KAAK,OAAA;AAAA,IACL,KAAK,MAAA;AAAA,IACL,KAAK,MAAA;AAAA,IACL,KAAK,OAAA;AACD,MAAA,OAAO,cAAA;AAAA,IACX;AACI,MAAA,MAAM,IAAI,KAAA;AAAA,QACN,sBAAsB,cAAc,CAAA,+CAAA;AAAA,OACxC;AAAA;AAEZ;AAEA,SAAS,QAAQ,KAAA,EAAgC;AAC7C,EAAA,IAAI,iBAAiB,KAAA,EAAO;AACxB,IAAA,OAAO,IAAA;AAAA,EACX;AACA,EAAA,OAAO,CAAC,EACJ,KAAA,IACA,OAAO,KAAA,KAAU,QAAA,IACjB,OAAQ,KAAA,CAAyB,IAAA,KAAS,QAAA,IAC1C,OAAQ,KAAA,CAAyB,OAAA,KAAY,QAAA,CAAA;AAErD;;;;"}
@@ -1 +1 @@
1
- {"version":3,"file":"NumberParser.js","sources":["NumberParser.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023-2025 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\n\n/**\n * This class allows to parse numbers from strings according to the given locale.\n * Currently, in JavaScript there is no built-in way to parse numbers according to the current locale.\n * Only arabic numerals are supported.\n */\nexport class NumberParser {\n private readonly decimalRegexPattern: RegExp;\n private readonly groupingRegexPattern: RegExp;\n\n constructor(locales: Intl.LocalesArgument) {\n const numberFormatOptions: Intl.NumberFormatOptions = {\n useGrouping: true\n };\n const formattedParts = new Intl.NumberFormat(locales, numberFormatOptions).formatToParts(\n 12345.6\n );\n\n const decimalSeparator = formattedParts.find((part) => part.type === \"decimal\")?.value;\n if (!decimalSeparator) {\n throw new Error(\"Could not determine decimal separator.\");\n }\n\n const groupingSeparator = formattedParts.find((part) => part.type === \"group\")?.value;\n if (!groupingSeparator) {\n throw new Error(\"Could not determine grouping separator.\");\n }\n\n this.decimalRegexPattern = new RegExp(`${this.escapeRegExp(decimalSeparator)}`, \"g\");\n if (groupingSeparator.trim() === \"\") {\n // if a language uses a whitespace as grouping separator, remove all whitespaces (as numbers may not contain whitespaces)\n this.groupingRegexPattern = /\\s/g;\n } else {\n this.groupingRegexPattern = new RegExp(`${this.escapeRegExp(groupingSeparator)}`, \"g\");\n }\n }\n\n /**\n * Parses a number from a string considering the locale.\n */\n parse(numberString: string): number {\n numberString = numberString.trim();\n\n const parsedNumberString = numberString\n .replace(this.groupingRegexPattern, \"\")\n .replace(this.decimalRegexPattern, \".\");\n return !parsedNumberString ? NaN : +parsedNumberString;\n }\n\n // see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_expressions#escaping\n private escapeRegExp(string: string) {\n return string.replace(/[.*+?^${}()|[\\]\\\\]/g, \"\\\\$&\"); // $& means the whole matched string\n }\n}\n"],"names":[],"mappings":"AAQO,MAAM,YAAa,CAAA;AAAA,EACL,mBAAA;AAAA,EACA,oBAAA;AAAA,EAEjB,YAAY,OAA+B,EAAA;AACvC,IAAA,MAAM,mBAAgD,GAAA;AAAA,MAClD,WAAa,EAAA;AAAA,KACjB;AACA,IAAA,MAAM,iBAAiB,IAAI,IAAA,CAAK,YAAa,CAAA,OAAA,EAAS,mBAAmB,CAAE,CAAA,aAAA;AAAA,MACvE;AAAA,KACJ;AAEA,IAAM,MAAA,gBAAA,GAAmB,eAAe,IAAK,CAAA,CAAC,SAAS,IAAK,CAAA,IAAA,KAAS,SAAS,CAAG,EAAA,KAAA;AACjF,IAAA,IAAI,CAAC,gBAAkB,EAAA;AACnB,MAAM,MAAA,IAAI,MAAM,wCAAwC,CAAA;AAAA;AAG5D,IAAM,MAAA,iBAAA,GAAoB,eAAe,IAAK,CAAA,CAAC,SAAS,IAAK,CAAA,IAAA,KAAS,OAAO,CAAG,EAAA,KAAA;AAChF,IAAA,IAAI,CAAC,iBAAmB,EAAA;AACpB,MAAM,MAAA,IAAI,MAAM,yCAAyC,CAAA;AAAA;AAG7D,IAAK,IAAA,CAAA,mBAAA,GAAsB,IAAI,MAAO,CAAA,CAAA,EAAG,KAAK,YAAa,CAAA,gBAAgB,CAAC,CAAA,CAAA,EAAI,GAAG,CAAA;AACnF,IAAI,IAAA,iBAAA,CAAkB,IAAK,EAAA,KAAM,EAAI,EAAA;AAEjC,MAAA,IAAA,CAAK,oBAAuB,GAAA,KAAA;AAAA,KACzB,MAAA;AACH,MAAK,IAAA,CAAA,oBAAA,GAAuB,IAAI,MAAO,CAAA,CAAA,EAAG,KAAK,YAAa,CAAA,iBAAiB,CAAC,CAAA,CAAA,EAAI,GAAG,CAAA;AAAA;AACzF;AACJ;AAAA;AAAA;AAAA,EAKA,MAAM,YAA8B,EAAA;AAChC,IAAA,YAAA,GAAe,aAAa,IAAK,EAAA;AAEjC,IAAM,MAAA,kBAAA,GAAqB,YACtB,CAAA,OAAA,CAAQ,IAAK,CAAA,oBAAA,EAAsB,EAAE,CACrC,CAAA,OAAA,CAAQ,IAAK,CAAA,mBAAA,EAAqB,GAAG,CAAA;AAC1C,IAAO,OAAA,CAAC,kBAAqB,GAAA,GAAA,GAAM,CAAC,kBAAA;AAAA;AACxC;AAAA,EAGQ,aAAa,MAAgB,EAAA;AACjC,IAAO,OAAA,MAAA,CAAO,OAAQ,CAAA,qBAAA,EAAuB,MAAM,CAAA;AAAA;AAE3D;;;;"}
1
+ {"version":3,"file":"NumberParser.js","sources":["NumberParser.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023-2025 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\n\n/**\n * This class allows to parse numbers from strings according to the given locale.\n * Currently, in JavaScript there is no built-in way to parse numbers according to the current locale.\n * Only arabic numerals are supported.\n */\nexport class NumberParser {\n private readonly decimalRegexPattern: RegExp;\n private readonly groupingRegexPattern: RegExp;\n\n constructor(locales: Intl.LocalesArgument) {\n const numberFormatOptions: Intl.NumberFormatOptions = {\n useGrouping: true\n };\n const formattedParts = new Intl.NumberFormat(locales, numberFormatOptions).formatToParts(\n 12345.6\n );\n\n const decimalSeparator = formattedParts.find((part) => part.type === \"decimal\")?.value;\n if (!decimalSeparator) {\n throw new Error(\"Could not determine decimal separator.\");\n }\n\n const groupingSeparator = formattedParts.find((part) => part.type === \"group\")?.value;\n if (!groupingSeparator) {\n throw new Error(\"Could not determine grouping separator.\");\n }\n\n this.decimalRegexPattern = new RegExp(`${this.escapeRegExp(decimalSeparator)}`, \"g\");\n if (groupingSeparator.trim() === \"\") {\n // if a language uses a whitespace as grouping separator, remove all whitespaces (as numbers may not contain whitespaces)\n this.groupingRegexPattern = /\\s/g;\n } else {\n this.groupingRegexPattern = new RegExp(`${this.escapeRegExp(groupingSeparator)}`, \"g\");\n }\n }\n\n /**\n * Parses a number from a string considering the locale.\n */\n parse(numberString: string): number {\n numberString = numberString.trim();\n\n const parsedNumberString = numberString\n .replace(this.groupingRegexPattern, \"\")\n .replace(this.decimalRegexPattern, \".\");\n return !parsedNumberString ? NaN : +parsedNumberString;\n }\n\n // see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_expressions#escaping\n private escapeRegExp(string: string) {\n return string.replace(/[.*+?^${}()|[\\]\\\\]/g, \"\\\\$&\"); // $& means the whole matched string\n }\n}\n"],"names":[],"mappings":"AAQO,MAAM,YAAA,CAAa;AAAA,EACL,mBAAA;AAAA,EACA,oBAAA;AAAA,EAEjB,YAAY,OAAA,EAA+B;AACvC,IAAA,MAAM,mBAAA,GAAgD;AAAA,MAClD,WAAA,EAAa;AAAA,KACjB;AACA,IAAA,MAAM,iBAAiB,IAAI,IAAA,CAAK,YAAA,CAAa,OAAA,EAAS,mBAAmB,CAAA,CAAE,aAAA;AAAA,MACvE;AAAA,KACJ;AAEA,IAAA,MAAM,gBAAA,GAAmB,eAAe,IAAA,CAAK,CAAC,SAAS,IAAA,CAAK,IAAA,KAAS,SAAS,CAAA,EAAG,KAAA;AACjF,IAAA,IAAI,CAAC,gBAAA,EAAkB;AACnB,MAAA,MAAM,IAAI,MAAM,wCAAwC,CAAA;AAAA,IAC5D;AAEA,IAAA,MAAM,iBAAA,GAAoB,eAAe,IAAA,CAAK,CAAC,SAAS,IAAA,CAAK,IAAA,KAAS,OAAO,CAAA,EAAG,KAAA;AAChF,IAAA,IAAI,CAAC,iBAAA,EAAmB;AACpB,MAAA,MAAM,IAAI,MAAM,yCAAyC,CAAA;AAAA,IAC7D;AAEA,IAAA,IAAA,CAAK,mBAAA,GAAsB,IAAI,MAAA,CAAO,CAAA,EAAG,KAAK,YAAA,CAAa,gBAAgB,CAAC,CAAA,CAAA,EAAI,GAAG,CAAA;AACnF,IAAA,IAAI,iBAAA,CAAkB,IAAA,EAAK,KAAM,EAAA,EAAI;AAEjC,MAAA,IAAA,CAAK,oBAAA,GAAuB,KAAA;AAAA,IAChC,CAAA,MAAO;AACH,MAAA,IAAA,CAAK,oBAAA,GAAuB,IAAI,MAAA,CAAO,CAAA,EAAG,KAAK,YAAA,CAAa,iBAAiB,CAAC,CAAA,CAAA,EAAI,GAAG,CAAA;AAAA,IACzF;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,YAAA,EAA8B;AAChC,IAAA,YAAA,GAAe,aAAa,IAAA,EAAK;AAEjC,IAAA,MAAM,kBAAA,GAAqB,YAAA,CACtB,OAAA,CAAQ,IAAA,CAAK,oBAAA,EAAsB,EAAE,CAAA,CACrC,OAAA,CAAQ,IAAA,CAAK,mBAAA,EAAqB,GAAG,CAAA;AAC1C,IAAA,OAAO,CAAC,kBAAA,GAAqB,GAAA,GAAM,CAAC,kBAAA;AAAA,EACxC;AAAA;AAAA,EAGQ,aAAa,MAAA,EAAgB;AACjC,IAAA,OAAO,MAAA,CAAO,OAAA,CAAQ,qBAAA,EAAuB,MAAM,CAAA;AAAA,EACvD;AACJ;;;;"}
package/README.md CHANGED
@@ -41,8 +41,9 @@ All object needing some cleanup action to be called should use the `destroy` met
41
41
 
42
42
  ### Logger
43
43
 
44
- The 'Logger' class provides a logger for standardized application wide logging.
45
- The log level is configured globally in the file `vite.config.js`.
44
+ The `Logger` class provides a logger for standardized application wide logging.
45
+ The log level is configured globally in the file `vite.config.ts`: to change the application's log level,
46
+ define the `__LOG_LEVEL__` constant to a custom value.
46
47
 
47
48
  To create a logger instance, call the `createLogger` method.
48
49
  It takes a prefix (string) to prepend to each message.
@@ -74,6 +75,29 @@ import { createLogger } from "@open-pioneer/core";
74
75
  const LOG = createLogger("example-package");
75
76
  ```
76
77
 
78
+ ### Deprecations
79
+
80
+ The `deprecated` function can be used to print warnings when a deprecated entity is used.
81
+ Deprecations are printed (once) during development, and not at all in production.
82
+ You can disable deprecations via the global configuration in `vite.config.ts`: set `__PRINT_DEPRECATIONS__` to `false` to hide deprecation messages even during development.
83
+
84
+ To emit a deprecation warning, create a helper function through the `deprecated` function.
85
+ Then, when the deprecated functionality is being used, simply call that helper function:
86
+
87
+ ```ts
88
+ const printDeprecation = deprecated({
89
+ name: "someFunctionName",
90
+ packageName: "some-package",
91
+ since: "v1.2.3"
92
+ });
93
+
94
+ // Later, when the deprecated function is actually being used:
95
+ function someFunctionName() {
96
+ printDeprecation(); // prints warning on first call
97
+ // ...
98
+ }
99
+ ```
100
+
77
101
  ## License
78
102
 
79
103
  Apache-2.0 (see `LICENSE` file)
@@ -0,0 +1,46 @@
1
+ /**
2
+ * Options supported by {@link deprecated}.
3
+ */
4
+ export interface DeprecatedOptions {
5
+ /**
6
+ * The package that contains the deprecated entity.
7
+ */
8
+ packageName?: string;
9
+ /**
10
+ * The entity name (class name, function name, option, ...) that was deprecated.
11
+ */
12
+ name: string;
13
+ /**
14
+ * The version or date in which the entity was deprecated.
15
+ */
16
+ since: string;
17
+ }
18
+ /**
19
+ * Creates a deprecation helper for a deprecated entity.
20
+ *
21
+ * This helper is used to print a deprecation warning to the browser console
22
+ * when the deprecated functionality is being used.
23
+ *
24
+ * Returns a _function_ that should be called when the deprecated entity is being used.
25
+ * The function will print a deprecation warning when usage is detected for the first time.
26
+ * Any further calls will have no effect to prevent spamming the console.
27
+ *
28
+ * > NOTE: Deprecation warnings are only printed in development builds.
29
+ *
30
+ * Example:
31
+ *
32
+ * ```js
33
+ * const printDeprecation = deprecated({
34
+ * name: "someFunctionName",
35
+ * packageName: "some-package",
36
+ * since: "v1.2.3"
37
+ * });
38
+ *
39
+ * // Later, when the deprecated function is actually being used:
40
+ * function someFunctionName() {
41
+ * printDeprecation();
42
+ * // ...
43
+ * } *
44
+ * ```
45
+ */
46
+ export declare function deprecated(options: DeprecatedOptions): () => void;
package/deprecated.js ADDED
@@ -0,0 +1,24 @@
1
+ const PRINT_DEPRECATIONS = typeof __PRINT_DEPRECATIONS__ !== "undefined" ? __PRINT_DEPRECATIONS__ : true;
2
+ function deprecated(options) {
3
+ if (!PRINT_DEPRECATIONS || !import.meta.env.DEV) {
4
+ return () => {
5
+ };
6
+ }
7
+ let called = false;
8
+ return function deprecationHelper() {
9
+ if (called) {
10
+ return;
11
+ }
12
+ called = true;
13
+ console.warn(buildDeprecationWarning(options));
14
+ };
15
+ }
16
+ function buildDeprecationWarning(options) {
17
+ const { packageName, name, since } = options;
18
+ const packageInfo = packageName ? ` in ${packageName}` : "";
19
+ const message = `\u26A0\uFE0F DEPRECATED: ${name}${packageInfo} (since ${since}) - Please update your code as this may be removed in future versions.`;
20
+ return message;
21
+ }
22
+
23
+ export { deprecated };
24
+ //# sourceMappingURL=deprecated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"deprecated.js","sources":["deprecated.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023-2025 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nconst PRINT_DEPRECATIONS =\n typeof __PRINT_DEPRECATIONS__ !== \"undefined\" ? __PRINT_DEPRECATIONS__ : true;\n\n/**\n * Options supported by {@link deprecated}.\n */\nexport interface DeprecatedOptions {\n /**\n * The package that contains the deprecated entity.\n */\n packageName?: string;\n\n /**\n * The entity name (class name, function name, option, ...) that was deprecated.\n */\n name: string;\n\n /**\n * The version or date in which the entity was deprecated.\n */\n since: string;\n}\n\n/**\n * Creates a deprecation helper for a deprecated entity.\n *\n * This helper is used to print a deprecation warning to the browser console\n * when the deprecated functionality is being used.\n *\n * Returns a _function_ that should be called when the deprecated entity is being used.\n * The function will print a deprecation warning when usage is detected for the first time.\n * Any further calls will have no effect to prevent spamming the console.\n *\n * > NOTE: Deprecation warnings are only printed in development builds.\n *\n * Example:\n *\n * ```js\n * const printDeprecation = deprecated({\n * name: \"someFunctionName\",\n * packageName: \"some-package\",\n * since: \"v1.2.3\"\n * });\n *\n * // Later, when the deprecated function is actually being used:\n * function someFunctionName() {\n * printDeprecation();\n * // ...\n * } *\n * ```\n */\nexport function deprecated(options: DeprecatedOptions): () => void {\n if (!PRINT_DEPRECATIONS || !import.meta.env.DEV) {\n return () => {}; // do nothing\n }\n\n let called = false;\n return function deprecationHelper() {\n if (called) {\n return;\n }\n\n called = true;\n console.warn(buildDeprecationWarning(options));\n };\n}\n\nfunction buildDeprecationWarning(options: DeprecatedOptions): string {\n const { packageName, name, since } = options;\n const packageInfo = packageName ? ` in ${packageName}` : \"\";\n const message = `⚠️ DEPRECATED: ${name}${packageInfo} (since ${since}) - Please update your code as this may be removed in future versions.`;\n return message;\n}\n"],"names":[],"mappings":"AAEA,MAAM,kBAAA,GACF,OAAO,sBAAA,KAA2B,WAAA,GAAc,sBAAA,GAAyB,IAAA;AAkDtE,SAAS,WAAW,OAAA,EAAwC;AAC/D,EAAA,IAAI,CAAC,kBAAA,IAAsB,CAAC,MAAA,CAAA,IAAA,CAAY,IAAI,GAAA,EAAK;AAC7C,IAAA,OAAO,MAAM;AAAA,IAAC,CAAA;AAAA,EAClB;AAEA,EAAA,IAAI,MAAA,GAAS,KAAA;AACb,EAAA,OAAO,SAAS,iBAAA,GAAoB;AAChC,IAAA,IAAI,MAAA,EAAQ;AACR,MAAA;AAAA,IACJ;AAEA,IAAA,MAAA,GAAS,IAAA;AACT,IAAA,OAAA,CAAQ,IAAA,CAAK,uBAAA,CAAwB,OAAO,CAAC,CAAA;AAAA,EACjD,CAAA;AACJ;AAEA,SAAS,wBAAwB,OAAA,EAAoC;AACjE,EAAA,MAAM,EAAE,WAAA,EAAa,IAAA,EAAM,KAAA,EAAM,GAAI,OAAA;AACrC,EAAA,MAAM,WAAA,GAAc,WAAA,GAAc,CAAA,IAAA,EAAO,WAAW,CAAA,CAAA,GAAK,EAAA;AACzD,EAAA,MAAM,UAAU,CAAA,yBAAA,EAAkB,IAAI,CAAA,EAAG,WAAW,WAAW,KAAK,CAAA,sEAAA,CAAA;AACpE,EAAA,OAAO,OAAA;AACX;;;;"}
package/error.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"error.js","sources":["error.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023-2025 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;AAexB,MAAM,cAAc,WAAY,CAAA;AAAA;AAAA,EAEnB,EAAA;AAAA;AAAA,EAGA,IAAA;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;AAC/B,IAAA,IAAA,CAAK,EAAK,GAAA,EAAA;AACV,IAAA,IAAA,CAAK,IAAO,GAAA,IAAA;AAAA;AAEpB;AAOO,SAAS,cAAc,GAA2C,EAAA;AACrE,EAAA,MAAM,QAA4B,EAAC;AACnC,EAAG,GAAA;AACC,IAAA,KAAA,CAAM,KAAK,GAAG,CAAA;AAGd,IAAA,MAAM,QAAS,GAAY,CAAA,KAAA;AAC3B,IAAI,IAAA,EAAE,iBAAiB,WAAc,CAAA,EAAA;AACjC,MAAA;AAAA;AAEJ,IAAM,GAAA,GAAA,KAAA;AAAA,GACD,QAAA,CAAA;AACT,EAAO,OAAA,KAAA;AACX;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;AAC9E;AAKO,SAAS,eAAyB,GAAA;AACrC,EAAA,MAAM,gBAAiB,EAAA;AAC3B;AAKO,SAAS,kBAAkB,GAAoB,EAAA;AAClD,EAAI,IAAA,YAAA,CAAa,GAAG,CAAG,EAAA;AACnB,IAAM,MAAA,GAAA;AAAA;AAEd;AAKO,SAAS,gBAAqC,GAAA;AACjD,EAAA,MAAM,GAAM,GAAA,IAAI,UAAW,CAAA,KAAA,CAAM,SAAS,CAAA;AAC1C,EAAA,GAAA,CAAI,IAAO,GAAA,YAAA;AACX,EAAO,OAAA,GAAA;AACX;;;;"}
1
+ {"version":3,"file":"error.js","sources":["error.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023-2025 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,UAAA,CAAW,KAAA;AAexB,MAAM,cAAc,WAAA,CAAY;AAAA;AAAA,EAEnB,EAAA;AAAA;AAAA,EAGA,IAAA;AAAA,EAEhB,WAAA,CAAY,EAAA,EAAY,IAAA,EAAc,OAAA,EAA+B;AACjE,IAAA,KAAA,CAAM,CAAA,EAAG,EAAE,CAAA,EAAA,EAAK,IAAI,IAAI,OAAO,CAAA;AAC/B,IAAA,IAAA,CAAK,EAAA,GAAK,EAAA;AACV,IAAA,IAAA,CAAK,IAAA,GAAO,IAAA;AAAA,EAChB;AACJ;AAOO,SAAS,cAAc,GAAA,EAA2C;AACrE,EAAA,MAAM,QAA4B,EAAC;AACnC,EAAA,GAAG;AACC,IAAA,KAAA,CAAM,KAAK,GAAG,CAAA;AAGd,IAAA,MAAM,QAAS,GAAA,CAAY,KAAA;AAC3B,IAAA,IAAI,EAAE,iBAAiB,WAAA,CAAA,EAAc;AACjC,MAAA;AAAA,IACJ;AACA,IAAA,GAAA,GAAM,KAAA;AAAA,EACV,CAAA,QAAS,CAAA;AACT,EAAA,OAAO,KAAA;AACX;AAKO,SAAS,aAAa,GAAA,EAAuB;AAChD,EAAA,OAAO,CAAC,EAAE,GAAA,IAAO,OAAO,QAAQ,QAAA,IAAY,MAAA,IAAU,GAAA,IAAO,GAAA,CAAI,IAAA,KAAS,YAAA,CAAA;AAC9E;AAKO,SAAS,eAAA,GAAyB;AACrC,EAAA,MAAM,gBAAA,EAAiB;AAC3B;AAKO,SAAS,kBAAkB,GAAA,EAAoB;AAClD,EAAA,IAAI,YAAA,CAAa,GAAG,CAAA,EAAG;AACnB,IAAA,MAAM,GAAA;AAAA,EACV;AACJ;AAKO,SAAS,gBAAA,GAAqC;AACjD,EAAA,MAAM,GAAA,GAAM,IAAI,UAAA,CAAW,KAAA,CAAM,SAAS,CAAA;AAC1C,EAAA,GAAA,CAAI,IAAA,GAAO,YAAA;AACX,EAAA,OAAO,GAAA;AACX;;;;"}
package/events.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"events.js","sources":["events.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023-2025 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;AAkCjC,MAAM,YAAgC,CAAA;AAAA,EACzC,CAAS,KAAK,IAAI,IAAI,iBAAkB,EAAA;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;AAAA,KACH,CAAA;AAAA;AACL;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;AAAA,KACT,CAAA;AAAA;AACL;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;AAAA;AAE3C;AAeA,MAAM,iBAAkB,CAAA;AAAA,EACZ,QAAA,uBAAe,GAA+B,EAAA;AAAA,EAEtD,EAAA,CAAG,MAAc,OAAiC,EAAA;AAC9C,IAAA,IAAI,QAAW,GAAA,IAAA,CAAK,QAAS,CAAA,GAAA,CAAI,IAAI,CAAA;AACrC,IAAA,IAAI,CAAC,QAAU,EAAA;AACX,MAAA,QAAA,uBAAe,GAAI,EAAA;AACnB,MAAK,IAAA,CAAA,QAAA,CAAS,GAAI,CAAA,IAAA,EAAM,QAAQ,CAAA;AAAA;AAEpC,IAAA,QAAA,CAAS,IAAI,OAAO,CAAA;AACpB,IAAO,OAAA;AAAA,MACH,OAAU,GAAA;AACN,QAAA,OAAA,CAAQ,OAAU,GAAA,IAAA;AAClB,QAAA,QAAA,EAAU,OAAO,OAAO,CAAA;AACxB,QAAW,QAAA,GAAA,MAAA;AAAA;AACf,KACJ;AAAA;AACJ,EAEA,IAAA,CAAK,MAAc,KAAgB,EAAA;AAC/B,IAAA,MAAM,QAAW,GAAA,IAAA,CAAK,QAAS,CAAA,GAAA,CAAI,IAAI,CAAA;AACvC,IAAA,IAAI,CAAC,QAAU,EAAA;AACX,MAAA;AAAA;AAMJ,IAAM,MAAA,IAAA,GAAO,CAAC,GAAG,QAAQ,CAAA;AACzB,IAAA,KAAA,MAAW,WAAW,IAAM,EAAA;AACxB,MAAA,IAAI,QAAQ,OAAS,EAAA;AACjB,QAAA;AAAA;AAGJ,MAAA,IAAI,QAAQ,IAAM,EAAA;AACd,QAAA,OAAA,CAAQ,OAAU,GAAA,IAAA;AAClB,QAAA,QAAA,CAAS,OAAO,OAAO,CAAA;AAAA;AAE3B,MAAA,OAAA,CAAQ,SAAS,KAAK,CAAA;AAAA;AAC1B;AAER;;;;"}
1
+ {"version":3,"file":"events.js","sources":["events.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023-2025 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;AAkCjC,MAAM,YAAA,CAAgC;AAAA,EACzC,CAAS,KAAK,IAAI,IAAI,iBAAA,EAAkB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQxC,EAAA,CACI,WACA,QAAA,EACQ;AACR,IAAA,OAAO,IAAA,CAAK,KAAK,CAAA,CAAE,EAAA,CAAG,SAAA,EAAW;AAAA,MAC7B;AAAA,KACH,CAAA;AAAA,EACL;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,IAAA,CACI,WACA,QAAA,EACQ;AACR,IAAA,OAAO,IAAA,CAAK,KAAK,CAAA,CAAE,EAAA,CAAG,SAAA,EAAW;AAAA,MAC7B,QAAA;AAAA,MACA,IAAA,EAAM;AAAA,KACT,CAAA;AAAA,EACL;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,IAAA,CAAsC,cAAoB,IAAA,EAAqC;AAC3F,IAAA,IAAA,CAAK,KAAK,CAAA,CAAE,IAAA,CAAK,SAAA,EAAW,IAAA,CAAK,CAAC,CAAC,CAAA;AAAA,EACvC;AACJ;AAeA,MAAM,iBAAA,CAAkB;AAAA,EACZ,QAAA,uBAAe,GAAA,EAA+B;AAAA,EAEtD,EAAA,CAAG,MAAc,OAAA,EAAiC;AAC9C,IAAA,IAAI,QAAA,GAAW,IAAA,CAAK,QAAA,CAAS,GAAA,CAAI,IAAI,CAAA;AACrC,IAAA,IAAI,CAAC,QAAA,EAAU;AACX,MAAA,QAAA,uBAAe,GAAA,EAAI;AACnB,MAAA,IAAA,CAAK,QAAA,CAAS,GAAA,CAAI,IAAA,EAAM,QAAQ,CAAA;AAAA,IACpC;AACA,IAAA,QAAA,CAAS,IAAI,OAAO,CAAA;AACpB,IAAA,OAAO;AAAA,MACH,OAAA,GAAU;AACN,QAAA,OAAA,CAAQ,OAAA,GAAU,IAAA;AAClB,QAAA,QAAA,EAAU,OAAO,OAAO,CAAA;AACxB,QAAA,QAAA,GAAW,MAAA;AAAA,MACf;AAAA,KACJ;AAAA,EACJ;AAAA,EAEA,IAAA,CAAK,MAAc,KAAA,EAAgB;AAC/B,IAAA,MAAM,QAAA,GAAW,IAAA,CAAK,QAAA,CAAS,GAAA,CAAI,IAAI,CAAA;AACvC,IAAA,IAAI,CAAC,QAAA,EAAU;AACX,MAAA;AAAA,IACJ;AAKA,IAAA,MAAM,IAAA,GAAO,CAAC,GAAG,QAAQ,CAAA;AACzB,IAAA,KAAA,MAAW,WAAW,IAAA,EAAM;AACxB,MAAA,IAAI,QAAQ,OAAA,EAAS;AACjB,QAAA;AAAA,MACJ;AAEA,MAAA,IAAI,QAAQ,IAAA,EAAM;AACd,QAAA,OAAA,CAAQ,OAAA,GAAU,IAAA;AAClB,QAAA,QAAA,CAAS,OAAO,OAAO,CAAA;AAAA,MAC3B;AACA,MAAA,OAAA,CAAQ,SAAS,KAAK,CAAA;AAAA,IAC1B;AAAA,EACJ;AACJ;;;;"}
package/index.d.ts CHANGED
@@ -1,6 +1,7 @@
1
- export { Error, getErrorChain, isAbortError, throwAbortError, createAbortError, rethrowAbortError } from "./error";
2
- export { EventEmitter, type EventSource, type EventNames } from "./events";
3
- export { destroyResource, destroyResources, type Resource } from "./resources";
1
+ export { deprecated, type DeprecatedOptions } from "./deprecated";
2
+ export { createAbortError, Error, getErrorChain, isAbortError, rethrowAbortError, throwAbortError } from "./error";
3
+ export { EventEmitter, type EventNames, type EventSource } from "./events";
4
4
  export { createLogger, type Logger, type LogLevel, type LogMethod } from "./Logger";
5
- export { createManualPromise, type ManualPromise } from "./utils";
6
5
  export { NumberParser } from "./NumberParser";
6
+ export { destroyResource, destroyResources, type Resource } from "./resources";
7
+ export { createManualPromise, type ManualPromise } from "./utils";
package/index.js CHANGED
@@ -1,7 +1,8 @@
1
+ export { deprecated } from './deprecated.js';
1
2
  export { Error, createAbortError, getErrorChain, isAbortError, rethrowAbortError, throwAbortError } from './error.js';
2
3
  export { EventEmitter } from './events.js';
3
- export { destroyResource, destroyResources } from './resources.js';
4
4
  export { createLogger } from './Logger.js';
5
- export { createManualPromise } from './utils.js';
6
5
  export { NumberParser } from './NumberParser.js';
6
+ export { destroyResource, destroyResources } from './resources.js';
7
+ export { createManualPromise } from './utils.js';
7
8
  //# sourceMappingURL=index.js.map
package/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;"}
1
+ {"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;"}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "type": "module",
3
3
  "name": "@open-pioneer/core",
4
- "version": "4.1.0-dev.20250707115222",
4
+ "version": "4.1.0-dev.20250818125237",
5
5
  "description": "Contains basic utility functions and classes used by the @open-pioneer project.",
6
6
  "keywords": [
7
7
  "open-pioneer-trails"
package/resources.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"resources.js","sources":["resources.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023-2025 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\n/**\n * A helper function that invokes `destroy()` on each resource in the given array.\n *\n * This function destroys the resources in reverse order (starting from the last element).\n * This is done to reverse the order of construction.\n *\n * The array will be cleared by this function.\n */\nexport function destroyResources<R extends Resource>(resources: R[]): void {\n // `destroy()` might call us in a cycle, so we modify the array in place.\n let resource: Resource | undefined;\n while ((resource = resources.pop())) {\n resource.destroy();\n }\n}\n"],"names":[],"mappings":"AAyBO,SAAS,gBAAoC,QAAoC,EAAA;AACpF,EAAA,QAAA,EAAU,OAAQ,EAAA;AAClB,EAAO,OAAA,MAAA;AACX;AAUO,SAAS,iBAAqC,SAAsB,EAAA;AAEvE,EAAI,IAAA,QAAA;AACJ,EAAQ,OAAA,QAAA,GAAW,SAAU,CAAA,GAAA,EAAQ,EAAA;AACjC,IAAA,QAAA,CAAS,OAAQ,EAAA;AAAA;AAEzB;;;;"}
1
+ {"version":3,"file":"resources.js","sources":["resources.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023-2025 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\n/**\n * A helper function that invokes `destroy()` on each resource in the given array.\n *\n * This function destroys the resources in reverse order (starting from the last element).\n * This is done to reverse the order of construction.\n *\n * The array will be cleared by this function.\n */\nexport function destroyResources<R extends Resource>(resources: R[]): void {\n // `destroy()` might call us in a cycle, so we modify the array in place.\n let resource: Resource | undefined;\n while ((resource = resources.pop())) {\n resource.destroy();\n }\n}\n"],"names":[],"mappings":"AAyBO,SAAS,gBAAoC,QAAA,EAAoC;AACpF,EAAA,QAAA,EAAU,OAAA,EAAQ;AAClB,EAAA,OAAO,MAAA;AACX;AAUO,SAAS,iBAAqC,SAAA,EAAsB;AAEvE,EAAA,IAAI,QAAA;AACJ,EAAA,OAAQ,QAAA,GAAW,SAAA,CAAU,GAAA,EAAI,EAAI;AACjC,IAAA,QAAA,CAAS,OAAA,EAAQ;AAAA,EACrB;AACJ;;;;"}
package/utils.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"utils.js","sources":["utils.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023-2025 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;AACJ,EAAI,IAAA,MAAA;AACJ,EAAA,MAAM,OAAU,GAAA,IAAI,OAAW,CAAA,CAAC,KAAK,GAAQ,KAAA;AACzC,IAAU,OAAA,GAAA,GAAA;AACV,IAAS,MAAA,GAAA,GAAA;AAAA,GACZ,CAAA;AACD,EAAO,OAAA;AAAA,IACH,OAAA;AAAA,IACA,OAAA;AAAA,IACA;AAAA,GACJ;AACJ;;;;"}
1
+ {"version":3,"file":"utils.js","sources":["utils.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023-2025 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,mBAAA,GAA2C;AACvD,EAAA,IAAI,OAAA;AACJ,EAAA,IAAI,MAAA;AACJ,EAAA,MAAM,OAAA,GAAU,IAAI,OAAA,CAAW,CAAC,KAAK,GAAA,KAAQ;AACzC,IAAA,OAAA,GAAU,GAAA;AACV,IAAA,MAAA,GAAS,GAAA;AAAA,EACb,CAAC,CAAA;AACD,EAAA,OAAO;AAAA,IACH,OAAA;AAAA,IACA,OAAA;AAAA,IACA;AAAA,GACJ;AACJ;;;;"}