@irsdk-node/native 4.0.2 → 4.1.0

package/README.md

@@ -1,46 +1,46 @@
-# @irsdk-node/native
-
-This is the native bindings package for irsdk-node. This provides near 1:1 bindings to the C++ iRacing SDK, and is consumed as an optional dependency of [irsdk-node](../irsdk-node), which provides a handy little wrapper around the API to make it nicer to use and avoid boilerplating.
-
-While you can use this package directly, it is highly recommended to use the [irsdk-node](../irsdk-node) package instead.
-
-## Why an optional dependency?
-
-The [irsdk-node](../irsdk-node) package was split up in to separate packages to solve the issue that this SDK is windows-only, which means that the package wasn't able to be used in any other environment. For most cases this is fine, however it becomes a big issue if you want to do something as simple as use the types in a webview or in an electron renderer process. As an optional dependency, the types and rest of the SDK can be imported as needed wherever.
-
-## Debugging
-
-- `yarn build-cpp:debug`: Builds the native module in debug mode.
-
-In debug mode, you are going to need to swap to using the `DebugSDK` rather than `NativeSDK`. This uses the debug build rather than the release build, which allows debugging/breakpoints via vscode (you can use the `Debug bridge` run task in vscode to do this). For example:
-
-```diff
-// In `src/irsdk-node.ts`
-+ import { DebugSDK } from '@irsdk-node/native';
-- import { NativeSDK } from '@irsdk-node/native';
-```
-
-## Generating types
-
-This package contains a utility script for generating Typescript types based on the actual Telemetry values present during runtime. To do so you can run `yarn generate-types` while you have iRacing running and connected to a server. This will generate a new .ts types file in the [@irsdk-node/types](../irsdk-node-types) package.
-
-Please refer to the readme in the types package for more info.
-
-## Commands
-
-```sh
-# Build the module.
-$ yarn build
-
-# Build either the release or debug build.
-$ yarn build-cpp:[release|debug]
-
-# Run util script for generating typescript types
-$ yarn generate-types
-
-# Clean the build directories
-$ yarn clean
-
-# Lint package
-$ yarn lint
-```
+# @irsdk-node/native
+
+This is the native bindings package for irsdk-node. This provides near 1:1 bindings to the C++ iRacing SDK, and is consumed as an optional dependency of [irsdk-node](../irsdk-node), which provides a handy little wrapper around the API to make it nicer to use and avoid boilerplating.
+
+While you can use this package directly, it is highly recommended to use the [irsdk-node](../irsdk-node) package instead.
+
+## Why an optional dependency?
+
+The [irsdk-node](../irsdk-node) package was split up in to separate packages to solve the issue that this SDK is windows-only, which means that the package wasn't able to be used in any other environment. For most cases this is fine, however it becomes a big issue if you want to do something as simple as use the types in a webview or in an electron renderer process. As an optional dependency, the types and rest of the SDK can be imported as needed wherever.
+
+## Debugging
+
+- `yarn build-cpp:debug`: Builds the native module in debug mode.
+
+In debug mode, you are going to need to swap to using the `DebugSDK` rather than `NativeSDK`. This uses the debug build rather than the release build, which allows debugging/breakpoints via vscode (you can use the `Debug bridge` run task in vscode to do this). For example:
+
+```diff
+// In `src/irsdk-node.ts`
++ import { DebugSDK } from '@irsdk-node/native';
+- import { NativeSDK } from '@irsdk-node/native';
+```
+
+## Generating types
+
+This package contains a utility script for generating Typescript types based on the actual Telemetry values present during runtime. To do so you can run `yarn generate-types` while you have iRacing running and connected to a server. This will generate a new .ts types file in the [@irsdk-node/types](../irsdk-node-types) package.
+
+Please refer to the readme in the types package for more info.
+
+## Commands
+
+```sh
+# Build the module.
+$ yarn build
+
+# Build either the release or debug build.
+$ yarn build-cpp:[release|debug]
+
+# Run util script for generating typescript types
+$ yarn generate-types
+
+# Clean the build directories
+$ yarn clean
+
+# Lint package
+$ yarn lint
+```

package/binding.gyp

@@ -1,19 +1,28 @@
-{
-  "targets": [
-    {
-      "target_name": "irsdk_node",
-      "sources": [
-        "src/irsdk_node.cc",
-        "lib/irsdk_utils.cpp",
-        "lib/yaml_parser.cpp",
-        "lib/irsdk_defines.h"
-      ],
-      "defines": [
-        "NAPI_DISABLE_CPP_EXCEPTIONS",
-      ],
-      "include_dirs": [
-        "<!(node -p \"require('node-addon-api').include_dir\")",
-      ]
-    }
-  ]
-}
+{
+  "targets": [
+    {
+      "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"]
+        }]
+      ],
+      "defines": [
+        "NAPI_DISABLE_CPP_EXCEPTIONS",
+      ],
+      "include_dirs": [
+        "<!(node -p \"require('node-addon-api').include_dir\")",
+      ]
+    }
+  ]
+}

package/dist/INativeSDK.d.ts

@@ -0,0 +1,28 @@
+import { BroadcastMessages, CameraState, ChatCommand, FFBCommand, PitCommand, ReloadTexturesCommand, ReplayPositionCommand, ReplaySearchCommand, ReplayStateCommand, TelemetryCommand, TelemetryVariable, TelemetryVarList, VideoCaptureCommand } from '@irsdk-node/types';
+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>;
+    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;
+}

package/dist/INativeSDK.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/MockSdk.d.ts

@@ -0,0 +1,43 @@
+import { BroadcastMessages, CameraState, ChatCommand, FFBCommand, PitCommand, ReloadTexturesCommand, ReplayPositionCommand, ReplaySearchCommand, ReplayStateCommand, TelemetryCommand, TelemetryVariable, TelemetryVarList, VideoCaptureCommand } from '@irsdk-node/types';
+import type { INativeSDK } from './INativeSDK';
+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(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;
+}
+export {};

package/dist/MockSdk.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MockSDK = void 0;
+const loader_1 = require("./mock-data/loader");
+// eslint-disable-next-line @typescript-eslint/naming-convention
+let MOCK_TELEMETRY = null;
+let MOCK_SESSION = null;
+/**
+ * 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.
+ */
+class MockSDK {
+    currDataVersion = 1;
+    isMocked = true;
+    enableLogging = false;
+    _isRunning = false;
+    constructor() {
+        this._loadMockData().catch((reason) => {
+            console.error('Error loading mock data for mock SDK:', reason);
+        });
+        console.warn('Attempting to access iRacing SDK on unsupported platform!', '\nReturning mock SDK for testing purposes. (Only win32 supported)');
+    }
+    async _loadMockData() {
+        const [session, telemetry] = await Promise.all([
+            !MOCK_SESSION ? (0, loader_1.loadMockSessionData)() : Promise.resolve(MOCK_SESSION),
+            !MOCK_TELEMETRY ? (0, loader_1.loadMockTelemetry)() : Promise.resolve(MOCK_TELEMETRY),
+        ]);
+        MOCK_SESSION = session;
+        MOCK_TELEMETRY = telemetry;
+    }
+    startSDK() {
+        this._isRunning = true;
+        return true;
+    }
+    stopSDK() {
+        this._isRunning = false;
+    }
+    isRunning() {
+        return this._isRunning;
+    }
+    waitForData(_timeout) {
+        return this._isRunning;
+    }
+    getSessionData() {
+        return MOCK_SESSION ?? '';
+    }
+    getTelemetryData() {
+        if (!MOCK_TELEMETRY) {
+            throw new Error('Attempted accessing mock telemetry before it was loaded.');
+        }
+        return MOCK_TELEMETRY;
+    }
+    getTelemetryVariable(name) {
+        if (!MOCK_TELEMETRY) {
+            throw new Error('Attempted accessing mock telemetry before it was loaded.');
+        }
+        if (typeof name === 'number') {
+            return Object.values(MOCK_TELEMETRY)[name];
+        }
+        return MOCK_TELEMETRY[name];
+    }
+    broadcast(...args) {
+        console.log('Mocking SDK call:', ...args);
+    }
+}
+exports.MockSDK = MockSDK;

package/dist/mock-data/loader.d.ts

@@ -0,0 +1,3 @@
+import { TelemetryVarList } from '@irsdk-node/types';
+export declare const loadMockSessionData: () => Promise<string>;
+export declare const loadMockTelemetry: () => Promise<TelemetryVarList>;

package/dist/mock-data/loader.js

@@ -0,0 +1,41 @@
+"use strict";
+// eslint-disable @typescript-eslint/no-unsafe-return
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadMockTelemetry = exports.loadMockSessionData = void 0;
+const js_yaml_1 = __importDefault(require("js-yaml"));
+const loadMockSessionData = async () => {
+    const json = await Promise.resolve().then(() => __importStar(require('./session.json')));
+    return js_yaml_1.default.dump(json.default);
+};
+exports.loadMockSessionData = loadMockSessionData;
+const loadMockTelemetry = async () => {
+    const json = await Promise.resolve().then(() => __importStar(require('./telemetry.json')));
+    return json.default;
+};
+exports.loadMockTelemetry = loadMockTelemetry;