@irsdk-node/native 4.1.1 → 5.1.0

package/dist/types/INativeSDK.d.ts

@@ -0,0 +1,24 @@
+import { BroadcastCommand, BroadcastCommandArgs, TelemetryVariable, TelemetryVarList } from '@irsdk-node/types';
+export type TelemetryTypesDict = Record<string, number>;
+/**
+ * Interface of the iRacing SDK native module.
+ *
+ * This should map 1:1 to the API implemented within the C++ addon, and anything
+ * added, changed, or removed from the C++ addon API will be documented here.
+ */
+export interface INativeSDK {
+    readonly currDataVersion: number;
+    readonly isMocked: boolean;
+    enableLogging: boolean;
+    startSDK(): boolean;
+    stopSDK(): void;
+    isRunning(): boolean;
+    waitForData(timeout?: number): boolean;
+    getSessionData(): string;
+    getTelemetryData(): TelemetryVarList;
+    getTelemetryVariable<T>(index: number): TelemetryVariable<T>;
+    getTelemetryVariable<T>(name: string): TelemetryVariable<T>;
+    __getTelemetryTypes(): TelemetryTypesDict;
+    broadcast<Command extends BroadcastCommand = BroadcastCommand>(message: Command, ...args: BroadcastCommandArgs<Command>): boolean;
+}
+export type NativeSDKImpl = new () => INativeSDK;

package/dist/types/MockSdk.d.ts

@@ -0,0 +1,31 @@
+import { BroadcastCommand, BroadcastCommandArgs, TelemetryVariable, TelemetryVarList } from '@irsdk-node/types';
+import type { INativeSDK, TelemetryTypesDict } from './INativeSDK.js';
+type TelemetryVarKey = keyof TelemetryVarList;
+type TelemetryResultTypes = boolean | number | string;
+/**
+ * Mock SDK class intended for use on non-win32 platforms for development.
+ * Implements the native sdk interface supplemented with mock data suitable for
+ * iterating on projects with.
+ *
+ * @todo - This should really be handled differently, for example via a wrapper
+ *         class around the native class that gets exposed.
+ */
+export declare class MockSDK implements INativeSDK {
+    currDataVersion: number;
+    isMocked: boolean;
+    enableLogging: boolean;
+    private _isRunning;
+    constructor();
+    private _loadMockData;
+    startSDK(): boolean;
+    stopSDK(): void;
+    isRunning(): boolean;
+    waitForData(_timeout?: number): boolean;
+    getSessionData(): string;
+    getTelemetryData(): TelemetryVarList;
+    getTelemetryVariable<T extends TelemetryResultTypes>(index: number): TelemetryVariable<T[]>;
+    getTelemetryVariable<T extends TelemetryResultTypes>(name: TelemetryVarKey): TelemetryVariable<T[]>;
+    broadcast<Command extends BroadcastCommand = BroadcastCommand>(message: Command, ...args: BroadcastCommandArgs<Command>): boolean;
+    __getTelemetryTypes(): TelemetryTypesDict;
+}
+export {};

package/dist/types/index.d.ts

@@ -0,0 +1,4 @@
+import { NativeSDKImpl } from './INativeSDK.js';
+export declare const NativeSDK: NativeSDKImpl;
+export declare const sdkIsMocked: boolean;
+export type { INativeSDK, TelemetryTypesDict } from './INativeSDK.js';

package/lib/irsdk_client.cpp

@@ -4,14 +4,14 @@ All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
-    * Redistributions of source code must retain the above copyright
-      notice, this list of conditions and the following disclaimer.
-    * Redistributions in binary form must reproduce the above copyright
-      notice, this list of conditions and the following disclaimer in the
-      documentation and/or other materials provided with the distribution.
-    * Neither the name of iRacing.com Motorsport Simulations nor the
-      names of its contributors may be used to endorse or promote products
-      derived from this software without specific prior written permission.
+	* Redistributions of source code must retain the above copyright
+	  notice, this list of conditions and the following disclaimer.
+	* Redistributions in binary form must reproduce the above copyright
+	  notice, this list of conditions and the following disclaimer in the
+	  documentation and/or other materials provided with the distribution.
+	* Neither the name of iRacing.com Motorsport Simulations nor the
+	  names of its contributors may be used to endorse or promote products
+	  derived from this software without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
@@ -44,13 +44,13 @@ irsdkClient& irsdkClient::instance()
 bool irsdkClient::waitForData(int timeoutMS)
 {
 	// wait for start of session or new data
-	if(irsdk_waitForDataReady(timeoutMS, m_data) && irsdk_getHeader())
+	if (irsdk_waitForDataReady(timeoutMS, m_data) && irsdk_getHeader())
 	{
 		// if new connection, or data changed lenght then init
-		if(!m_data || m_nData != irsdk_getHeader()->bufLen)
+		if (!m_data || m_nData != irsdk_getHeader()->bufLen)
 		{
 			// allocate memory to hold incoming data from sim
-			if(m_data) delete [] m_data;
+			if (m_data) delete[] m_data;
 			m_nData = irsdk_getHeader()->bufLen;
 			m_data = new char[m_nData];
 
@@ -61,19 +61,19 @@ bool irsdkClient::waitForData(int timeoutMS)
 			m_lastSessionCt = -1;
 
 			// and try to fill in the data
-			if(irsdk_getNewData(m_data))
+			if (irsdk_getNewData(m_data))
 				return true;
 		}
-		else if(m_data)
+		else if (m_data)
 		{
 			// else we are allready initialized, and data is ready for processing
 			return true;
 		}
 	}
-	else if(!isConnected())
+	else if (!isConnected())
 	{
 		// else session ended
-		if(m_data)
+		if (m_data)
 			delete[] m_data;
 		m_data = NULL;
 
@@ -87,7 +87,7 @@ bool irsdkClient::waitForData(int timeoutMS)
 void irsdkClient::shutdown()
 {
 	irsdk_shutdown();
-	if(m_data)
+	if (m_data)
 		delete[] m_data;
 	m_data = NULL;
 
@@ -100,9 +100,9 @@ bool irsdkClient::isConnected()
 	return m_data != NULL && irsdk_isConnected();
 }
 
-int irsdkClient::getVarIdx(const char*name)
+int irsdkClient::getVarIdx(const char* name)
 {
-	if(isConnected())
+	if (isConnected())
 	{
 		return irsdk_varNameToIndex(name);
 	}
@@ -112,10 +112,10 @@ int irsdkClient::getVarIdx(const char*name)
 
 int /*irsdk_VarType*/ irsdkClient::getVarType(int idx)
 {
-	if(isConnected())
+	if (isConnected())
 	{
-		const irsdk_varHeader *vh = irsdk_getVarHeaderEntry(idx);
-		if(vh)
+		const irsdk_varHeader* vh = irsdk_getVarHeaderEntry(idx);
+		if (vh)
 		{
 			return vh->type;
 		}
@@ -131,10 +131,10 @@ int /*irsdk_VarType*/ irsdkClient::getVarType(int idx)
 
 int irsdkClient::getVarCount(int idx)
 {
-	if(isConnected())
+	if (isConnected())
 	{
-		const irsdk_varHeader *vh = irsdk_getVarHeaderEntry(idx);
-		if(vh)
+		const irsdk_varHeader* vh = irsdk_getVarHeaderEntry(idx);
+		if (vh)
 		{
 			return vh->count;
 		}
@@ -150,36 +150,36 @@ int irsdkClient::getVarCount(int idx)
 
 bool irsdkClient::getVarBool(int idx, int entry)
 {
-	if(isConnected())
+	if (isConnected())
 	{
-		const irsdk_varHeader *vh = irsdk_getVarHeaderEntry(idx);
-		if(vh)
+		const irsdk_varHeader* vh = irsdk_getVarHeaderEntry(idx);
+		if (vh)
 		{
-			if(entry >= 0 && entry < vh->count)
+			if (entry >= 0 && entry < vh->count)
 			{
-				const char * data = m_data + vh->offset;
-				switch(vh->type)
+				const char* data = m_data + vh->offset;
+				switch (vh->type)
 				{
-				// 1 byte
+					// 1 byte
 				case irsdk_char:
 				case irsdk_bool:
 					return (((const char*)data)[entry]) != 0;
 					break;
 
-				// 4 bytes
+					// 4 bytes
 				case irsdk_int:
 				case irsdk_bitField:
 					return (((const int*)data)[entry]) != 0;
 					break;
-					
-				// test float/double for greater than 1.0 so that
-				// we have a chance of this being usefull
-				// technically there is no right conversion...
+
+					// test float/double for greater than 1.0 so that
+					// we have a chance of this being usefull
+					// technically there is no right conversion...
 				case irsdk_float:
 					return (((const float*)data)[entry]) >= 1.0f;
 					break;
 
-				// 8 bytes
+					// 8 bytes
 				case irsdk_double:
 					return (((const double*)data)[entry]) >= 1.0;
 					break;
@@ -203,33 +203,33 @@ bool irsdkClient::getVarBool(int idx, int entry)
 
 int irsdkClient::getVarInt(int idx, int entry)
 {
-	if(isConnected())
+	if (isConnected())
 	{
-		const irsdk_varHeader *vh = irsdk_getVarHeaderEntry(idx);
-		if(vh)
+		const irsdk_varHeader* vh = irsdk_getVarHeaderEntry(idx);
+		if (vh)
 		{
-			if(entry >= 0 && entry < vh->count)
+			if (entry >= 0 && entry < vh->count)
 			{
-				const char * data = m_data + vh->offset;
-				switch(vh->type)
+				const char* data = m_data + vh->offset;
+				switch (vh->type)
 				{
-				// 1 byte
+					// 1 byte
 				case irsdk_char:
 				case irsdk_bool:
 					return (int)(((const char*)data)[entry]);
 					break;
 
-				// 4 bytes
+					// 4 bytes
 				case irsdk_int:
 				case irsdk_bitField:
 					return (int)(((const int*)data)[entry]);
 					break;
-					
+
 				case irsdk_float:
 					return (int)(((const float*)data)[entry]);
 					break;
 
-				// 8 bytes
+					// 8 bytes
 				case irsdk_double:
 					return (int)(((const double*)data)[entry]);
 					break;
@@ -253,33 +253,33 @@ int irsdkClient::getVarInt(int idx, int entry)
 
 float irsdkClient::getVarFloat(int idx, int entry)
 {
-	if(isConnected())
+	if (isConnected())
 	{
-		const irsdk_varHeader *vh = irsdk_getVarHeaderEntry(idx);
-		if(vh)
+		const irsdk_varHeader* vh = irsdk_getVarHeaderEntry(idx);
+		if (vh)
 		{
-			if(entry >= 0 && entry < vh->count)
+			if (entry >= 0 && entry < vh->count)
 			{
-				const char * data = m_data + vh->offset;
-				switch(vh->type)
+				const char* data = m_data + vh->offset;
+				switch (vh->type)
 				{
-				// 1 byte
+					// 1 byte
 				case irsdk_char:
 				case irsdk_bool:
 					return (float)(((const char*)data)[entry]);
 					break;
 
-				// 4 bytes
+					// 4 bytes
 				case irsdk_int:
 				case irsdk_bitField:
 					return (float)(((const int*)data)[entry]);
 					break;
-					
+
 				case irsdk_float:
 					return (float)(((const float*)data)[entry]);
 					break;
 
-				// 8 bytes
+					// 8 bytes
 				case irsdk_double:
 					return (float)(((const double*)data)[entry]);
 					break;
@@ -303,33 +303,33 @@ float irsdkClient::getVarFloat(int idx, int entry)
 
 double irsdkClient::getVarDouble(int idx, int entry)
 {
-	if(isConnected())
+	if (isConnected())
 	{
-		const irsdk_varHeader *vh = irsdk_getVarHeaderEntry(idx);
-		if(vh)
+		const irsdk_varHeader* vh = irsdk_getVarHeaderEntry(idx);
+		if (vh)
 		{
-			if(entry >= 0 && entry < vh->count)
+			if (entry >= 0 && entry < vh->count)
 			{
-				const char * data = m_data + vh->offset;
-				switch(vh->type)
+				const char* data = m_data + vh->offset;
+				switch (vh->type)
 				{
-				// 1 byte
+					// 1 byte
 				case irsdk_char:
 				case irsdk_bool:
 					return (double)(((const char*)data)[entry]);
 					break;
 
-				// 4 bytes
+					// 4 bytes
 				case irsdk_int:
 				case irsdk_bitField:
 					return (double)(((const int*)data)[entry]);
 					break;
-					
+
 				case irsdk_float:
 					return (double)(((const float*)data)[entry]);
 					break;
 
-				// 8 bytes
+					// 8 bytes
 				case irsdk_double:
 					return (double)(((const double*)data)[entry]);
 					break;
@@ -352,31 +352,31 @@ double irsdkClient::getVarDouble(int idx, int entry)
 }
 
 //path is in the form of "DriverInfo:Drivers:CarIdx:{%d}UserName:"
-int irsdkClient::getSessionStrVal(const char *path, char *val, int valLen)
+int irsdkClient::getSessionStrVal(const char* path, char* val, int valLen)
 {
-	if(isConnected() && path && val && valLen > 0)
+	if (isConnected() && path && val && valLen > 0)
 	{
 		// track changes in string
-		m_lastSessionCt = getSessionCt(); 
+		m_lastSessionCt = getSessionCt();
 
-		const char *tVal = NULL;
+		const char* tVal = NULL;
 		int tValLen = 0;
-		if(parseYaml(irsdk_getSessionInfoStr(), path, &tVal, &tValLen))
+		if (parseYaml(irsdk_getSessionInfoStr(), path, &tVal, &tValLen))
 		{
 			// dont overflow out buffer
 			int len = tValLen;
-			if(len > valLen)
-				len = valLen;
+			if (len > (valLen - 1)) // reserve space for null termination
+				len = (valLen - 1);
 
 			// copy what we can, even if buffer too small
 			memcpy(val, tVal, len);
 			val[len] = '\0'; // origional string has no null termination...
 
 			// if buffer was big enough, return success
-			if(valLen >= tValLen)
+			if ((valLen - 1) >= tValLen)
 				return 1;
 			else // return size of buffer needed
-				return -tValLen;
+				return -(tValLen + 1);
 		}
 	}
 
@@ -384,12 +384,12 @@ int irsdkClient::getSessionStrVal(const char *path, char *val, int valLen)
 }
 
 // get the whole string
-const char* irsdkClient::getSessionStr() 
-{ 
-	if(isConnected())
+const char* irsdkClient::getSessionStr()
+{
+	if (isConnected())
 	{
-		m_lastSessionCt = getSessionCt(); 
-		return irsdk_getSessionInfoStr(); 
+		m_lastSessionCt = getSessionCt();
+		return irsdk_getSessionInfoStr();
 	}
 
 	return NULL;
@@ -405,23 +405,23 @@ irsdkCVar::irsdkCVar()
 	m_name[0] = '\0';
 }
 
-irsdkCVar::irsdkCVar(const char *name)
+irsdkCVar::irsdkCVar(const char* name)
 {
 	m_name[0] = '\0';
 	setVarName(name);
 }
 
-void irsdkCVar::setVarName(const char *name)
+void irsdkCVar::setVarName(const char* name)
 {
-	if(!name || 0 != strncmp(name, m_name, sizeof(m_name)))
+	if (!name || 0 != strncmp(name, m_name, sizeof(m_name)))
 	{
 		m_idx = -1;
 		m_statusID = -1;
 
-		if(name)
+		if (name)
 		{
 			strncpy(m_name, name, max_string);
-			m_name[max_string-1] = '\0';
+			m_name[max_string - 1] = '\0';
 		}
 		else
 			m_name[0] = '\0';
@@ -430,9 +430,9 @@ void irsdkCVar::setVarName(const char *name)
 
 bool irsdkCVar::checkIdx()
 {
-	if(irsdkClient::instance().isConnected())
+	if (irsdkClient::instance().isConnected())
 	{
-		if(m_statusID != irsdkClient::instance().getStatusID())
+		if (m_statusID != irsdkClient::instance().getStatusID())
 		{
 			m_statusID = irsdkClient::instance().getStatusID();
 			m_idx = irsdkClient::instance().getVarIdx(m_name);
@@ -446,14 +446,14 @@ bool irsdkCVar::checkIdx()
 
 int /*irsdk_VarType*/ irsdkCVar::getType()
 {
-	if(checkIdx())
+	if (checkIdx())
 		return irsdkClient::instance().getVarType(m_idx);
 	return 0;
 }
 
 int irsdkCVar::getCount()
 {
-	if(checkIdx())
+	if (checkIdx())
 		return irsdkClient::instance().getVarCount(m_idx);
 	return 0;
 }
@@ -467,28 +467,28 @@ bool irsdkCVar::isValid()
 
 bool irsdkCVar::getBool(int entry)
 {
-	if(checkIdx())
+	if (checkIdx())
 		return irsdkClient::instance().getVarBool(m_idx, entry);
 	return false;
 }
 
 int irsdkCVar::getInt(int entry)
 {
-	if(checkIdx())
+	if (checkIdx())
 		return irsdkClient::instance().getVarInt(m_idx, entry);
 	return 0;
 }
 
 float irsdkCVar::getFloat(int entry)
 {
-	if(checkIdx())
+	if (checkIdx())
 		return irsdkClient::instance().getVarFloat(m_idx, entry);
 	return 0.0f;
 }
 
 double irsdkCVar::getDouble(int entry)
 {
-	if(checkIdx())
+	if (checkIdx())
 		return irsdkClient::instance().getVarDouble(m_idx, entry);
 	return 0.0;
 }

package/lib/irsdk_client.h

@@ -4,14 +4,14 @@ All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
-    * Redistributions of source code must retain the above copyright
-      notice, this list of conditions and the following disclaimer.
-    * Redistributions in binary form must reproduce the above copyright
-      notice, this list of conditions and the following disclaimer in the
-      documentation and/or other materials provided with the distribution.
-    * Neither the name of iRacing.com Motorsport Simulations nor the
-      names of its contributors may be used to endorse or promote products
-      derived from this software without specific prior written permission.
+	* Redistributions of source code must retain the above copyright
+	  notice, this list of conditions and the following disclaimer.
+	* Redistributions in binary form must reproduce the above copyright
+	  notice, this list of conditions and the following disclaimer in the
+	  documentation and/or other materials provided with the distribution.
+	* Neither the name of iRacing.com Motorsport Simulations nor the
+	  names of its contributors may be used to endorse or promote products
+	  derived from this software without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
@@ -43,30 +43,30 @@ public:
 	bool isConnected();
 	int getStatusID() { return m_statusID; }
 
-	int getVarIdx(const char*name);
+	int getVarIdx(const char* name);
 
 	// what is the base type of the data
 	// returns irsdk_VarType as int so we don't depend on irsdk_defines.h
 	int getVarType(int idx);
-	int getVarType(const char *name) { return getVarType(getVarIdx(name)); }
+	int getVarType(const char* name) { return getVarType(getVarIdx(name)); }
 
 	// how many elements in array, or 1 if not an array
 	int getVarCount(int idx);
-	int getVarCount(const char *name) { return getVarCount(getVarIdx(name)); }
+	int getVarCount(const char* name) { return getVarCount(getVarIdx(name)); }
 
 	// idx is the variables index, entry is the array offset, or 0 if not an array element
 	// will convert data to requested type
 	bool getVarBool(int idx, int entry = 0);
-	bool getVarBool(const char *name, int entry = 0) { return getVarBool(getVarIdx(name), entry); }
+	bool getVarBool(const char* name, int entry = 0) { return getVarBool(getVarIdx(name), entry); }
 
 	int getVarInt(int idx, int entry = 0);
-	int getVarInt(const char *name, int entry = 0) { return getVarInt(getVarIdx(name), entry); }
-	
+	int getVarInt(const char* name, int entry = 0) { return getVarInt(getVarIdx(name), entry); }
+
 	float getVarFloat(int idx, int entry = 0);
-	float getVarFloat(const char *name, int entry = 0) { return getVarFloat(getVarIdx(name), entry); }
+	float getVarFloat(const char* name, int entry = 0) { return getVarFloat(getVarIdx(name), entry); }
 
 	double getVarDouble(int idx, int entry = 0);
-	double getVarDouble(const char *name, int entry = 0) { return getVarDouble(getVarIdx(name), entry); }
+	double getVarDouble(const char* name, int entry = 0) { return getVarDouble(getVarIdx(name), entry); }
 
 	//---
 
@@ -74,14 +74,14 @@ public:
 	int getSessionCt() { return irsdk_getSessionInfoStrUpdate(); }
 
 	// has string changed since we last read any values from it
-	bool wasSessionStrUpdated() { return m_lastSessionCt != getSessionCt(); } 
+	bool wasSessionStrUpdated() { return m_lastSessionCt != getSessionCt(); }
 
 	// pars string for individual value, 1 success, 0 failure, -n minimum buffer size
 	//****Note, this is a linear parser, so it is slow!
-	int getSessionStrVal(const char *path, char *val, int valLen);
+	int getSessionStrVal(const char* path, char* val, int valLen);
 
 	// get the whole string
-	const char *getSessionStr();
+	const char* getSessionStr();
 
 protected:
 
@@ -96,13 +96,13 @@ protected:
 
 	void shutdown();
 
-	char *m_data;
+	char* m_data;
 	int m_nData;
 	int m_statusID;
 
 	int m_lastSessionCt;
 
-	static irsdkClient *m_instance;
+	static irsdkClient* m_instance;
 };
 
 
@@ -112,9 +112,9 @@ class irsdkCVar
 {
 public:
 	irsdkCVar();
-	irsdkCVar(const char *name);
+	irsdkCVar(const char* name);
 
-	void setVarName(const char *name);
+	void setVarName(const char* name);
 
 	// returns irsdk_VarType as int so we don't depend on irsdk_defines.h
 	int getType();