@irsdk-node/native 5.0.0 → 5.2.0

package/README.md

@@ -113,3 +113,21 @@ $ pnpm clean
 # Lint package
 $ pnpm lint
 ```
+
+#### ⚠️ C++ Build errors from prebuildify/node-gyp
+
+If the C++ build fails with an error similar to:
+
+```
+gyp: /<path>/<to>/common.gypi not found (cwd: /<cwd>/<path>) while reading includes of binding.gyp...
+```
+
+Then try looking for your global node-gyp and prebuildify caches. On Windows, they should be somewhere around:
+
+- Node-gyp:
+  - `C:\Users\<YourUser>\AppData\Local\node-gyp`
+  - `C:\Users\<YourUser>\AppData\Local\.node-gyp`
+- Prebuildify:
+  - `C:\Users\<YourUser>\AppData\Local\Temp\prebuildify`
+
+Once cleared, you can try running `pnpm clean && pnpm build` again. Prebuildify and Node-GYP should then attempt to do a fresh install before attempting to build.

package/binding.gyp

@@ -3,19 +3,11 @@
     {
       "target_name": "irsdk_node",
       "sources": [
-          "lib/yaml_parser.cpp",
-      ],
-      "conditions": [
-        ["OS=='win'", {
-          "sources": [
-            "lib/irsdk_node.cc",
-            "lib/irsdk_utils.cpp",
-            "lib/irsdk_defines.h"
-          ]
-        }],
-        ["OS!='win'", {
-          "sources": ["lib/irsdk_node_mocked.cc"]
-        }]
+        "lib/root.cpp",
+        "lib/logger.cpp",
+        "lib/irsdk_node.cpp",
+        "lib/irsdk_utils.cpp",
+        "lib/irsdk_defines.h"
       ],
       "defines": [
         "NAPI_DISABLE_CPP_EXCEPTIONS",

package/dist/cjs/index.cjs

@@ -9336,6 +9336,7 @@ var require_telemetry = __commonJS({
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
+  LogLevel: () => LogLevel,
   NativeSDK: () => NativeSDK,
   sdkIsMocked: () => sdkIsMocked
 });
@@ -9351,6 +9352,16 @@ var import_node_gyp_build = __toESM(require("node-gyp-build"), 1);
 // src/MockSdk.ts
 var import_node_console = require("node:console");
 
+// src/INativeSDK.ts
+var LogLevel = /* @__PURE__ */ ((LogLevel2) => {
+  LogLevel2[LogLevel2["None"] = 0] = "None";
+  LogLevel2[LogLevel2["Error"] = 1] = "Error";
+  LogLevel2[LogLevel2["Warn"] = 2] = "Warn";
+  LogLevel2[LogLevel2["Info"] = 3] = "Info";
+  LogLevel2[LogLevel2["Debug"] = 4] = "Debug";
+  return LogLevel2;
+})(LogLevel || {});
+
 // src/mock-data/loader.ts
 var import_js_yaml = require("js-yaml");
 var loadMockSessionData = async () => {
@@ -9369,6 +9380,7 @@ var MockSDK = class {
   currDataVersion = 1;
   isMocked = true;
   enableLogging = false;
+  logLevel = 0 /* None */;
   _isRunning = false;
   constructor() {
     this._loadMockData().catch((reason) => {
@@ -9398,14 +9410,21 @@ var MockSDK = class {
     return this._isRunning;
   }
   waitForData(_timeout) {
-    return this._isRunning;
+    const dataNotReady = !mockSession || !mockTelemetry;
+    return this._isRunning && !dataNotReady;
   }
   getSessionData() {
     return mockSession ?? "";
   }
+  getSessionConnectionID() {
+    return mockSession ? 1 : -1;
+  }
+  getSessionVersionNum() {
+    return mockSession ? 1 : -1;
+  }
   getTelemetryData() {
     if (!mockTelemetry) {
-      throw new Error("Attempted accessing mock telemetry before it was loaded.");
+      return {};
     }
     return mockTelemetry;
   }
@@ -9418,8 +9437,9 @@ var MockSDK = class {
     }
     return mockTelemetry[name];
   }
-  broadcast(...args) {
-    (0, import_node_console.log)("Mocking SDK call:", ...args);
+  broadcast(message, ...args) {
+    (0, import_node_console.log)("Mocking SDK call:", message, ...args);
+    return true;
   }
   __getTelemetryTypes() {
     return {};
@@ -9429,16 +9449,11 @@ var MockSDK = class {
 // src/index.ts
 var DIR_NAME = getDirname();
 var sdkBinding;
-var isMocked;
+var isMocked = false;
 try {
   const rootDir = (0, import_node_path.join)(DIR_NAME, "../..");
   const binding = (0, import_node_gyp_build.default)(rootDir);
-  isMocked = binding.mockedSdk;
-  if (isMocked) {
-    sdkBinding = MockSDK;
-  } else {
-    sdkBinding = binding.iRacingSdkNode;
-  }
+  sdkBinding = binding.iRacingSdkNode;
 } catch {
   console.warn("Failed to load native iRacing SDK module. Loading mock SDK instead.");
   isMocked = true;
@@ -9448,6 +9463,7 @@ var NativeSDK = sdkBinding;
 var sdkIsMocked = isMocked;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  LogLevel,
   NativeSDK,
   sdkIsMocked
 });

package/dist/esm/index.js

@@ -9339,6 +9339,16 @@ import importNativeModule from "node-gyp-build";
 // src/MockSdk.ts
 import { error, warn, log } from "node:console";
 
+// src/INativeSDK.ts
+var LogLevel = /* @__PURE__ */ ((LogLevel2) => {
+  LogLevel2[LogLevel2["None"] = 0] = "None";
+  LogLevel2[LogLevel2["Error"] = 1] = "Error";
+  LogLevel2[LogLevel2["Warn"] = 2] = "Warn";
+  LogLevel2[LogLevel2["Info"] = 3] = "Info";
+  LogLevel2[LogLevel2["Debug"] = 4] = "Debug";
+  return LogLevel2;
+})(LogLevel || {});
+
 // src/mock-data/loader.ts
 import { dump } from "js-yaml";
 var loadMockSessionData = async () => {
@@ -9357,6 +9367,7 @@ var MockSDK = class {
   currDataVersion = 1;
   isMocked = true;
   enableLogging = false;
+  logLevel = 0 /* None */;
   _isRunning = false;
   constructor() {
     this._loadMockData().catch((reason) => {
@@ -9386,14 +9397,21 @@ var MockSDK = class {
     return this._isRunning;
   }
   waitForData(_timeout) {
-    return this._isRunning;
+    const dataNotReady = !mockSession || !mockTelemetry;
+    return this._isRunning && !dataNotReady;
   }
   getSessionData() {
     return mockSession ?? "";
   }
+  getSessionConnectionID() {
+    return mockSession ? 1 : -1;
+  }
+  getSessionVersionNum() {
+    return mockSession ? 1 : -1;
+  }
   getTelemetryData() {
     if (!mockTelemetry) {
-      throw new Error("Attempted accessing mock telemetry before it was loaded.");
+      return {};
     }
     return mockTelemetry;
   }
@@ -9406,8 +9424,9 @@ var MockSDK = class {
     }
     return mockTelemetry[name];
   }
-  broadcast(...args) {
-    log("Mocking SDK call:", ...args);
+  broadcast(message, ...args) {
+    log("Mocking SDK call:", message, ...args);
+    return true;
   }
   __getTelemetryTypes() {
     return {};
@@ -9417,16 +9436,11 @@ var MockSDK = class {
 // src/index.ts
 var DIR_NAME = getDirname();
 var sdkBinding;
-var isMocked;
+var isMocked = false;
 try {
   const rootDir = join(DIR_NAME, "../..");
   const binding = importNativeModule(rootDir);
-  isMocked = binding.mockedSdk;
-  if (isMocked) {
-    sdkBinding = MockSDK;
-  } else {
-    sdkBinding = binding.iRacingSdkNode;
-  }
+  sdkBinding = binding.iRacingSdkNode;
 } catch {
   console.warn("Failed to load native iRacing SDK module. Loading mock SDK instead.");
   isMocked = true;
@@ -9435,6 +9449,7 @@ try {
 var NativeSDK = sdkBinding;
 var sdkIsMocked = isMocked;
 export {
+  LogLevel,
   NativeSDK,
   sdkIsMocked
 };

package/dist/types/INativeSDK.d.ts

@@ -1,5 +1,12 @@
-import { BroadcastMessages, CameraState, ChatCommand, FFBCommand, PitCommand, ReloadTexturesCommand, ReplayPositionCommand, ReplaySearchCommand, ReplayStateCommand, TelemetryCommand, TelemetryVariable, TelemetryVarList, VideoCaptureCommand } from '@irsdk-node/types';
+import { BroadcastCommand, BroadcastCommandArgs, TelemetryVariable, TelemetryVarList } from '@irsdk-node/types';
 export type TelemetryTypesDict = Record<string, number>;
+export declare enum LogLevel {
+    None = 0,
+    Error = 1,
+    Warn = 2,
+    Info = 3,
+    Debug = 4
+}
 /**
  * Interface of the iRacing SDK native module.
  *
@@ -9,29 +16,20 @@ export type TelemetryTypesDict = Record<string, number>;
 export interface INativeSDK {
     readonly currDataVersion: number;
     readonly isMocked: boolean;
+    /** @deprecated use .logLevel instead */
     enableLogging: boolean;
+    logLevel: LogLevel;
     startSDK(): boolean;
     stopSDK(): void;
     isRunning(): boolean;
     waitForData(timeout?: number): boolean;
     getSessionData(): string;
     getTelemetryData(): TelemetryVarList;
+    getSessionVersionNum(): number;
+    getSessionConnectionID(): number;
     getTelemetryVariable<T>(index: number): TelemetryVariable<T>;
     getTelemetryVariable<T>(name: string): TelemetryVariable<T>;
     __getTelemetryTypes(): TelemetryTypesDict;
-    broadcast(message: BroadcastMessages.CameraSwitchPos, pos: number, group: number, camera: number): void;
-    broadcast(message: BroadcastMessages.CameraSwitchNum, driver: number, group: number, camera: number): void;
-    broadcast(message: BroadcastMessages.CameraSetState, state: CameraState): void;
-    broadcast(message: BroadcastMessages.ReplaySetPlaySpeed, speed: number, slowMotion: number): void;
-    broadcast(message: BroadcastMessages.ReplaySetPlayPosition, pos: ReplayPositionCommand, frame: number): void;
-    broadcast(message: BroadcastMessages.ReplaySearch, mode: ReplaySearchCommand): void;
-    broadcast(message: BroadcastMessages.ReplaySetState, state: ReplayStateCommand): void;
-    broadcast(message: BroadcastMessages.ReloadTextures, command: ReloadTexturesCommand, carIndex?: number): void;
-    broadcast(message: BroadcastMessages.ChatCommand, command: ChatCommand, macro?: number): void;
-    broadcast(message: BroadcastMessages.PitCommand, command: PitCommand, param?: number): void;
-    broadcast(message: BroadcastMessages.TelemCommand, command: TelemetryCommand): void;
-    broadcast(message: BroadcastMessages.FFBCommand, command: FFBCommand, value: number): void;
-    broadcast(message: BroadcastMessages.ReplaySearchSessionTime, session: number, time: number): void;
-    broadcast(message: BroadcastMessages.VideoCapture, command: VideoCaptureCommand): void;
+    broadcast<Command extends BroadcastCommand = BroadcastCommand>(message: Command, ...args: BroadcastCommandArgs<Command>): boolean;
 }
 export type NativeSDKImpl = new () => INativeSDK;

package/dist/types/MockSdk.d.ts

@@ -1,5 +1,5 @@
-import { BroadcastMessages, CameraState, ChatCommand, FFBCommand, PitCommand, ReloadTexturesCommand, ReplayPositionCommand, ReplaySearchCommand, ReplayStateCommand, TelemetryCommand, TelemetryVariable, TelemetryVarList, VideoCaptureCommand } from '@irsdk-node/types';
-import type { INativeSDK, TelemetryTypesDict } from './INativeSDK.js';
+import { BroadcastCommand, BroadcastCommandArgs, TelemetryVariable, TelemetryVarList } from '@irsdk-node/types';
+import { LogLevel, type INativeSDK, type TelemetryTypesDict } from './INativeSDK.js';
 type TelemetryVarKey = keyof TelemetryVarList;
 type TelemetryResultTypes = boolean | number | string;
 /**
@@ -14,6 +14,7 @@ export declare class MockSDK implements INativeSDK {
     currDataVersion: number;
     isMocked: boolean;
     enableLogging: boolean;
+    logLevel: LogLevel;
     private _isRunning;
     constructor();
     private _loadMockData;
@@ -22,23 +23,12 @@ export declare class MockSDK implements INativeSDK {
     isRunning(): boolean;
     waitForData(_timeout?: number): boolean;
     getSessionData(): string;
+    getSessionConnectionID(): number;
+    getSessionVersionNum(): number;
     getTelemetryData(): TelemetryVarList;
     getTelemetryVariable<T extends TelemetryResultTypes>(index: number): TelemetryVariable<T[]>;
     getTelemetryVariable<T extends TelemetryResultTypes>(name: TelemetryVarKey): TelemetryVariable<T[]>;
-    broadcast(message: BroadcastMessages.CameraSwitchPos, pos: number, group: number, camera: number): void;
-    broadcast(message: BroadcastMessages.CameraSwitchNum, driver: number, group: number, camera: number): void;
-    broadcast(message: BroadcastMessages.CameraSetState, state: CameraState): void;
-    broadcast(message: BroadcastMessages.ReplaySetPlaySpeed, speed: number, slowMotion: number): void;
-    broadcast(message: BroadcastMessages.ReplaySetPlayPosition, pos: ReplayPositionCommand, frame: number): void;
-    broadcast(message: BroadcastMessages.ReplaySearch, mode: ReplaySearchCommand): void;
-    broadcast(message: BroadcastMessages.ReplaySetState, state: ReplayStateCommand): void;
-    broadcast(message: BroadcastMessages.ReloadTextures, command: ReloadTexturesCommand, carIndex?: number): void;
-    broadcast(message: BroadcastMessages.ChatCommand, command: ChatCommand, macro?: number): void;
-    broadcast(message: BroadcastMessages.PitCommand, command: PitCommand, param?: number): void;
-    broadcast(message: BroadcastMessages.TelemCommand, command: TelemetryCommand): void;
-    broadcast(message: BroadcastMessages.FFBCommand, command: FFBCommand, value: number): void;
-    broadcast(message: BroadcastMessages.ReplaySearchSessionTime, session: number, time: number): void;
-    broadcast(message: BroadcastMessages.VideoCapture, command: VideoCaptureCommand): void;
+    broadcast<Command extends BroadcastCommand = BroadcastCommand>(message: Command, ...args: BroadcastCommandArgs<Command>): boolean;
     __getTelemetryTypes(): TelemetryTypesDict;
 }
 export {};

package/dist/types/index.d.ts

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