@irsdk-node/native 5.2.2 → 5.3.0

package/lib/irsdk_node.h

@@ -4,103 +4,108 @@
 #include "./logger.h"
 #include <napi.h>
 
+namespace irsdk_node
+{
+
 static const int K_DEFAULT_TIMEOUT_MS = 16;
 
 class iRacingSdkNode : public Napi::ObjectWrap<iRacingSdkNode>
 {
 public:
-	static Napi::Object Init(Napi::Env aEnv, Napi::Object aExports);
-	iRacingSdkNode(const Napi::CallbackInfo &aInfo);
-
-	// Main API ---------------------------------------------------------------
-
-	/// @brief Returns true if the SDK is currently active and connected to a
-	/// session, ie, the data buffer is not null and the SDK returns connected.
-	/// This means that the user is actively in an iRacing session.
-	///
-	/// @return If there is an active connection to the SDK.
-	bool isConnected() const;
-
-	/// @brief Triggers closing the SDK memory file, also resetting any cached
-	/// internal instance data.
-	void shutdown();
-
-	/// @brief Initializes the SDK, attempting to open the memory file containing
-	/// the SDK data. This occurs implicitly during the main data processing loop.
-	///
-	/// @return True if the SDK memory file was opened successfully.
-	bool startup();
-
-	/// @brief Main SDK data fetching loop tick. Will sleep for the given timeout
-	/// if no data is available, then attempt to pull data again.
-	///
-	/// @param aTimeoutMs The amount of time to wait, in MS.
-	/// @return True if data is ready and available, false if not.
-	bool waitForData(int aTimeoutMs = K_DEFAULT_TIMEOUT_MS);
-
-	/// @brief If connected, will return the entire session session string.
-	/// @return The YAML session string, in full.
-	const char *getSessionStr();
-
-	// Helper utils -----------------------------------------------------------
-
-	/// @brief Gets the current session info version number directly from the SDK.
-	/// This value increments every time the session info string changes.
-	///
-	/// (see irsdk_getSessionInfoStrUpdate() in irsdk_defines.h)
-	///
-	/// @return The current session info version.
-	inline int getSessionInfoStrCount();
-
-	/// @brief Checks the current SDK session info string version vs. this
-	/// class instances session info string version.
-	///
-	/// @return True if the session info string versions do not match.
-	inline bool wasSessionStrUpdated();
+    static Napi::Object Init(Napi::Env aEnv, Napi::Object aExports);
+    iRacingSdkNode(const Napi::CallbackInfo& aInfo);
+
+    // Main API ---------------------------------------------------------------
+
+    /// @brief Returns true if the SDK is currently active and connected to a
+    /// session, ie, the data buffer is not null and the SDK returns connected.
+    /// This means that the user is actively in an iRacing session.
+    ///
+    /// @return If there is an active connection to the SDK.
+    bool isConnected() const;
+
+    /// @brief Triggers closing the SDK memory file, also resetting any cached
+    /// internal instance data.
+    void shutdown();
+
+    /// @brief Initializes the SDK, attempting to open the memory file containing
+    /// the SDK data. This occurs implicitly during the main data processing loop.
+    ///
+    /// @return True if the SDK memory file was opened successfully.
+    bool startup();
+
+    /// @brief Main SDK data fetching loop tick. Will sleep for the given timeout
+    /// if no data is available, then attempt to pull data again.
+    ///
+    /// @param aTimeoutMs The amount of time to wait, in MS.
+    /// @return True if data is ready and available, false if not.
+    bool waitForData(int aTimeoutMs = K_DEFAULT_TIMEOUT_MS);
+
+    /// @brief If connected, will return the entire session session string.
+    /// @return The YAML session string, in full.
+    const char* getSessionStr();
+
+    // Helper utils -----------------------------------------------------------
+
+    /// @brief Gets the current session info version number directly from the SDK.
+    /// This value increments every time the session info string changes.
+    ///
+    /// (see irsdk_getSessionInfoStrUpdate() in irsdk_defines.h)
+    ///
+    /// @return The current session info version.
+    inline int getSessionInfoStrCount();
+
+    /// @brief Checks the current SDK session info string version vs. this
+    /// class instances session info string version.
+    ///
+    /// @return True if the session info string versions do not match.
+    inline bool wasSessionStrUpdated();
 
 private:
-	// Properties
-	Napi::Value _napi_prop_getCurrSessionDataVer(const Napi::CallbackInfo &aInfo);
-	/** @deprecated in favor of iRacingSdkNode::_napi_prop_getLogLevel */
-	Napi::Value _napi_prop_getEnableLogging(const Napi::CallbackInfo &aInfo);
-	/** @deprecated in favor of iRacingSdkNode::_napi_prop_setLogLevel */
-	void _napi_prop_setEnableLogging(const Napi::CallbackInfo &aInfo, const Napi::Value &aValue);
-	Napi::Value _napi_prop_getLogLevel(const Napi::CallbackInfo &aInfo);
-	void _napi_prop_setLogLevel(const Napi::CallbackInfo &aInfo, const Napi::Value &aValue);
-	Napi::Value _napi_prop_getIsMocked(const Napi::CallbackInfo &aInfo);
-
-	// Methods
-	// Control
-	Napi::Value _napi_startSdk(const Napi::CallbackInfo &aInfo);
-	Napi::Value _napi_stopSdk(const Napi::CallbackInfo &aInfo);
-	Napi::Value _napi_waitForData(const Napi::CallbackInfo &aInfo);
-	Napi::Value _napi_broadcastMessage(const Napi::CallbackInfo &aInfo);
-	// Getters
-	Napi::Value _napi_isRunning(const Napi::CallbackInfo &aInfo);
-	Napi::Value _napi_getSessionVersionNum(const Napi::CallbackInfo &aInfo);
-	Napi::Value _napi_getSessionConnectionID(const Napi::CallbackInfo &aInfo);
-	Napi::Value _napi_getSessionData(const Napi::CallbackInfo &aInfo);
-	Napi::Value _napi_getTelemetryData(const Napi::CallbackInfo &aInfo);
-	// Helpers
-	Napi::Value _napi_getTelemetryTypes(const Napi::CallbackInfo &aInfo);
-	Napi::Value GetTelemetryVar(const Napi::CallbackInfo &aInfo);
-
-	bool GetTelemetryBool(int entry, int index);
-	int GetTelemetryInt(int entry, int index);
-	float GetTelemetryFloat(int entry, int index);
-	double GetTelemetryDouble(int entry, int index);
-	Napi::Object GetTelemetryVarByIndex(const Napi::Env env, int index);
-	Napi::Object GetTelemetryVar(const Napi::Env env, const char *varName);
-
-	/// @brief Resets the current session data / session data status count.
-	void _resetData();
-
-	char *_data;
-	int _bufLineLen;
-	int _sessionStatusID;
-	int _lastSessionCt;
-	const char *_sessionData;
-	irsdk_node::Logger _logger;
+    // Properties
+    Napi::Value _napi_prop_getCurrSessionDataVer(const Napi::CallbackInfo& aInfo);
+    /** @deprecated in favor of iRacingSdkNode::_napi_prop_getLogLevel */
+    Napi::Value _napi_prop_getEnableLogging(const Napi::CallbackInfo& aInfo);
+    /** @deprecated in favor of iRacingSdkNode::_napi_prop_setLogLevel */
+    void _napi_prop_setEnableLogging(const Napi::CallbackInfo& aInfo, const Napi::Value& aValue);
+    Napi::Value _napi_prop_getLogLevel(const Napi::CallbackInfo& aInfo);
+    void _napi_prop_setLogLevel(const Napi::CallbackInfo& aInfo, const Napi::Value& aValue);
+    Napi::Value _napi_prop_getIsMocked(const Napi::CallbackInfo& aInfo);
+
+    // Methods
+    // Control
+    Napi::Value _napi_startSdk(const Napi::CallbackInfo& aInfo);
+    Napi::Value _napi_stopSdk(const Napi::CallbackInfo& aInfo);
+    Napi::Value _napi_waitForData(const Napi::CallbackInfo& aInfo);
+    Napi::Value _napi_broadcastMessage(const Napi::CallbackInfo& aInfo);
+    // Getters
+    Napi::Value _napi_isRunning(const Napi::CallbackInfo& aInfo);
+    Napi::Value _napi_getSessionVersionNum(const Napi::CallbackInfo& aInfo);
+    Napi::Value _napi_getSessionConnectionID(const Napi::CallbackInfo& aInfo);
+    Napi::Value _napi_getSessionData(const Napi::CallbackInfo& aInfo);
+    Napi::Value _napi_getTelemetryData(const Napi::CallbackInfo& aInfo);
+    Napi::Value _napi_getTelemetryTypes(const Napi::CallbackInfo& aInfo);
+    Napi::Value _napi_getTelemetryVar(const Napi::CallbackInfo& aInfo);
+
+    // Helpers
+    Napi::Object _getTelemetryVarByName(const Napi::Env aEnv, const char* aVarName);
+    Napi::Object _getTelemetryVarByIndex(const Napi::Env aEnv, int aIndex);
+    bool _getTelemetryBool(int aEntry, int aIndex);
+    int _getTelemetryInt(int aEntry, int aIndex);
+    float _getTelemetryFloat(int aEntry, int aIndex);
+    double _getTelemetryDouble(int aEntry, int aIndex);
+
+    /// @brief Resets the current session data / session data status count.
+    void _resetData();
+
+    char* _data;
+    int _bufLineLen;
+    int _sessionStatusID;
+    int _lastSessionCt;
+    const char* _sessionData;
+    Logger _logger;
 };
 
+} // namespace irsdk_node
+
 #endif

package/lib/logger.cpp

@@ -7,62 +7,66 @@
 
 using namespace irsdk_node;
 
-static std::string makeFormatStr(LogLevel aLevel, const char *aFormat)
+static std::string makeFormatStr(LogLevel aLevel, const char* aFormat)
 {
-	std::string str;
+    std::string str;
 
-	str += "(irsdk-node)(";
-	str += Logger::GetLabelForLevel(aLevel);
-	str += ") ";
-	str += aFormat;
+    str += "(irsdk-node)(";
+    str += Logger::GetLabelForLevel(aLevel);
+    str += ") ";
+    str += aFormat;
 
-	return str;
+    return str;
 }
 
-void Logger::info(const char *aFormat, ...) const
+void Logger::info(const char* aFormat, ...) const
 {
-	if (logLevel < LogLevel_Info) return;
+    if (logLevel < LogLevel_Info)
+        return;
 
-	auto formatStr = makeFormatStr(LogLevel_Info, aFormat);
+    auto formatStr = makeFormatStr(LogLevel_Info, aFormat);
 
-	va_list args;
-	va_start(args, aFormat);
-	vprintf(formatStr.c_str(), args);
-	va_end(args);
+    va_list args;
+    va_start(args, aFormat);
+    vprintf(formatStr.c_str(), args);
+    va_end(args);
 }
 
-void Logger::warn(const char *aFormat, ...) const
+void Logger::warn(const char* aFormat, ...) const
 {
-	if (logLevel < LogLevel_Warn) return;
+    if (logLevel < LogLevel_Warn)
+        return;
 
-	auto formatStr = makeFormatStr(LogLevel_Warn, aFormat);
+    auto formatStr = makeFormatStr(LogLevel_Warn, aFormat);
 
-	va_list args;
-	va_start(args, aFormat);
-	vprintf(formatStr.c_str(), args);
-	va_end(args);
+    va_list args;
+    va_start(args, aFormat);
+    vprintf(formatStr.c_str(), args);
+    va_end(args);
 }
 
-void Logger::error(const char *aFormat, ...) const
+void Logger::error(const char* aFormat, ...) const
 {
-	if (logLevel < LogLevel_Error) return;
+    if (logLevel < LogLevel_Error)
+        return;
 
-	auto formatStr = makeFormatStr(LogLevel_Error, aFormat);
+    auto formatStr = makeFormatStr(LogLevel_Error, aFormat);
 
-	va_list args;
-	va_start(args, aFormat);
-	vprintf(formatStr.c_str(), args);
-	va_end(args);
+    va_list args;
+    va_start(args, aFormat);
+    vprintf(formatStr.c_str(), args);
+    va_end(args);
 }
 
-void Logger::debug(const char *aFormat, ...) const
+void Logger::debug(const char* aFormat, ...) const
 {
-	if (logLevel < LogLevel_Debug) return;
+    if (logLevel < LogLevel_Debug)
+        return;
 
-	auto formatStr = makeFormatStr(LogLevel_Debug, aFormat);
+    auto formatStr = makeFormatStr(LogLevel_Debug, aFormat);
 
-	va_list args;
-	va_start(args, aFormat);
-	vprintf(formatStr.c_str(), args);
-	va_end(args);
+    va_list args;
+    va_start(args, aFormat);
+    vprintf(formatStr.c_str(), args);
+    va_end(args);
 }

package/lib/logger.h

@@ -2,56 +2,53 @@
 
 namespace irsdk_node
 {
-	static const char *K_LOGLEVEL_LABEL_INFO = "INFO";
-	static const char *K_LOGLEVEL_LABEL_WARN = "WARN";
-	static const char *K_LOGLEVEL_LABEL_ERROR = "ERROR";
-	static const char *K_LOGLEVEL_LABEL_DEBUG = "DEBUG";
-	static const char *K_LOGLEVEL_LABEL_NONE = "";
-
-	enum LogLevel
-	{
-		LogLevel_None = 0,
-		LogLevel_Error,
-		LogLevel_Warn,
-		LogLevel_Info,
-		LogLevel_Debug,
-	};
-
-	class Logger
-	{
-	public:
-		inline Logger(LogLevel aLogLevel) : logLevel(aLogLevel)
-		{}
-
-		LogLevel logLevel;
-
-		void info(const char *aFormat, ...) const;
-		void warn(const char *aFormat, ...) const;
-		void error(const char *aFormat, ...) const;
-		void debug(const char *aFormat, ...) const;
-
-		inline static const char *GetLabelForLevel(LogLevel aLevel)
-		{
-			switch (aLevel)
-			{
-			case LogLevel_Error:
-				return K_LOGLEVEL_LABEL_ERROR;
-
-			case LogLevel_Warn:
-				return K_LOGLEVEL_LABEL_WARN;
-
-			case LogLevel_Info:
-				return K_LOGLEVEL_LABEL_INFO;
-
-			case LogLevel_Debug:
-				return K_LOGLEVEL_LABEL_DEBUG;
-
-			default:
-				return K_LOGLEVEL_LABEL_NONE;
-			}
-
-			return K_LOGLEVEL_LABEL_NONE;
-		}
-	};
-
-}
+
+static const char* K_LOGLEVEL_LABEL_INFO = "INFO";
+static const char* K_LOGLEVEL_LABEL_WARN = "WARN";
+static const char* K_LOGLEVEL_LABEL_ERROR = "ERROR";
+static const char* K_LOGLEVEL_LABEL_DEBUG = "DEBUG";
+static const char* K_LOGLEVEL_LABEL_NONE = "";
+
+enum LogLevel
+{
+    LogLevel_None = 0,
+    LogLevel_Error,
+    LogLevel_Warn,
+    LogLevel_Info,
+    LogLevel_Debug,
+};
+
+class Logger
+{
+public:
+    inline Logger(LogLevel aLogLevel)
+        : logLevel(aLogLevel)
+    { }
+
+    LogLevel logLevel;
+
+    void info(const char* aFormat, ...) const;
+    void warn(const char* aFormat, ...) const;
+    void error(const char* aFormat, ...) const;
+    void debug(const char* aFormat, ...) const;
+
+    inline static const char* GetLabelForLevel(LogLevel aLevel)
+    {
+        switch (aLevel) {
+        case LogLevel_Error:
+            return K_LOGLEVEL_LABEL_ERROR;
+        case LogLevel_Warn:
+            return K_LOGLEVEL_LABEL_WARN;
+        case LogLevel_Info:
+            return K_LOGLEVEL_LABEL_INFO;
+        case LogLevel_Debug:
+            return K_LOGLEVEL_LABEL_DEBUG;
+        default:
+            return K_LOGLEVEL_LABEL_NONE;
+        }
+
+        return K_LOGLEVEL_LABEL_NONE;
+    }
+};
+
+} // namespace irsdk_node

package/lib/root.cpp

@@ -3,9 +3,9 @@
 
 Napi::Object registerBindings(Napi::Env aEnv, Napi::Object aExports)
 {
-	iRacingSdkNode::Init(aEnv, aExports);
+    irsdk_node::iRacingSdkNode::Init(aEnv, aExports);
 
-	return aExports;
+    return aExports;
 }
 
 NODE_API_MODULE(NODE_GYP_MODULE_NAME, registerBindings);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@irsdk-node/native",
-  "version": "5.2.2",
+  "version": "5.3.0",
   "author": "Matt Bengston <bengsfort@gmail.com> (https://bengsfort.dev/)",
   "bugs": {
     "email": "bengsfort@gmail.com",
@@ -17,7 +17,8 @@
     "./prebuilds",
     "./scripts",
     "./binding.gyp",
-    "./README.md"
+    "./README.md",
+    "./LICENSE"
   ],
   "type": "module",
   "main": "./dist/cjs/index.cjs",
@@ -63,6 +64,7 @@
     "watch:ts": "node esbuild.js --watch",
     "watch:types": "tsc --watch --emitDeclarationOnly",
     "lint": "eslint",
-    "check-types": "tsc --noEmit"
+    "check-types": "tsc --noEmit",
+    "format:cpp": "clang-format --sort-includes -i --style=file:.clang-format --verbose lib/*.cpp lib/*.h"
   }
 }

package/LICENSE.md

@@ -1,9 +0,0 @@
-MIT License
-
-Copyright (c) 2021 Matthew Bengston
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.