steamworks-ffi-node 0.6.9 → 0.6.10

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/README.md CHANGED
@@ -139,7 +139,7 @@ function startCallbackPolling(steam: SteamworksSDK, interval: number = 1000) {
139
139
  }
140
140
 
141
141
  // Initialize Steam connection
142
- const steam = new SteamworksSDK();
142
+ const steam = SteamworksSDK.getInstance();
143
143
  const initialized = steam.init({ appId: 480 }); // Your Steam App ID
144
144
 
145
145
  if (initialized) {
@@ -355,9 +355,16 @@ clearInterval(callbackInterval);
355
355
  steam.shutdown();
356
356
  ```
357
357
 
358
- ### JavaScript (CommonJS)
358
+ ### JavaScript
359
359
 
360
360
  ```javascript
361
+ // Option 1: ESM Named import
362
+ import { SteamworksSDK } from 'steamworks-ffi-node';
363
+
364
+ // Option 2: CommonJs named import (recommended - no .default needed)
365
+ const { SteamworksSDK } = require('steamworks-ffi-node');
366
+
367
+ // Option 3: CommonJs default named import (also works)
361
368
  const SteamworksSDK = require('steamworks-ffi-node').default;
362
369
 
363
370
  // Helper to auto-start callback polling
@@ -368,7 +375,7 @@ function startCallbackPolling(steam, interval = 1000) {
368
375
  }
369
376
 
370
377
  async function example() {
371
- const steam = new SteamworksSDK();
378
+ const steam = SteamworksSDK.getInstance();
372
379
 
373
380
  if (steam.init({ appId: 480 })) {
374
381
  // Start callback polling automatically
@@ -422,7 +429,7 @@ This library connects directly to the Steam client and Steamworks SDK:
422
429
 
423
430
  ```javascript
424
431
  // Steamworks API
425
- const steam = new SteamworksSDK();
432
+ const steam = SteamworksSDK.getInstance();
426
433
  steam.init({ appId: 480 }); // Connects to actual Steam
427
434
 
428
435
  // Live achievements from Steam servers
@@ -451,7 +458,7 @@ import { app } from 'electron';
451
458
  import SteamworksSDK from 'steamworks-ffi-node';
452
459
 
453
460
  app.whenReady().then(() => {
454
- const steam = new SteamworksSDK();
461
+ const steam = SteamworksSDK.getInstance();
455
462
 
456
463
  if (steam.init({ appId: YOUR_STEAM_APP_ID })) {
457
464
  console.log('Steam initialized in Electron!');
@@ -462,7 +469,7 @@ app.whenReady().then(() => {
462
469
  });
463
470
 
464
471
  app.on('before-quit', () => {
465
- const steam = new SteamworksSDK();
472
+ const steam = SteamworksSDK.getInstance();
466
473
  steam.shutdown();
467
474
  });
468
475
  ```
package/dist/index.d.ts CHANGED
@@ -9,4 +9,5 @@ export { SteamCloudManager } from './internal/SteamCloudManager';
9
9
  export { SteamWorkshopManager } from './internal/SteamWorkshopManager';
10
10
  export * from './types';
11
11
  export default SteamworksSDK;
12
+ export { SteamworksSDK };
12
13
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,SAAS,CAAC;AAGpC,OAAO,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAC7E,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAC7E,OAAO,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAC;AAC/E,OAAO,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAGvE,cAAc,SAAS,CAAC;AAGxB,eAAe,aAAa,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,SAAS,CAAC;AAGpC,OAAO,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAC7E,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAC7E,OAAO,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAC;AAC/E,OAAO,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAGvE,cAAc,SAAS,CAAC;AAGxB,eAAe,aAAa,CAAC;AAC7B,OAAO,EAAE,aAAa,EAAE,CAAC"}
package/dist/index.js CHANGED
@@ -17,8 +17,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
17
17
  return (mod && mod.__esModule) ? mod : { "default": mod };
18
18
  };
19
19
  Object.defineProperty(exports, "__esModule", { value: true });
20
- exports.SteamWorkshopManager = exports.SteamCloudManager = exports.SteamOverlayManager = exports.SteamRichPresenceManager = exports.SteamFriendsManager = exports.SteamLeaderboardManager = exports.SteamStatsManager = exports.SteamAchievementManager = void 0;
20
+ exports.SteamworksSDK = exports.SteamWorkshopManager = exports.SteamCloudManager = exports.SteamOverlayManager = exports.SteamRichPresenceManager = exports.SteamFriendsManager = exports.SteamLeaderboardManager = exports.SteamStatsManager = exports.SteamAchievementManager = void 0;
21
21
  const steam_1 = __importDefault(require("./steam"));
22
+ exports.SteamworksSDK = steam_1.default;
22
23
  // Export manager classes for advanced usage
23
24
  var SteamAchievementManager_1 = require("./internal/SteamAchievementManager");
24
25
  Object.defineProperty(exports, "SteamAchievementManager", { enumerable: true, get: function () { return SteamAchievementManager_1.SteamAchievementManager; } });
@@ -38,6 +39,6 @@ var SteamWorkshopManager_1 = require("./internal/SteamWorkshopManager");
38
39
  Object.defineProperty(exports, "SteamWorkshopManager", { enumerable: true, get: function () { return SteamWorkshopManager_1.SteamWorkshopManager; } });
39
40
  // Export all types from organized structure
40
41
  __exportStar(require("./types"), exports);
41
- // Export main Steam class
42
+ // Export main Steam class as both default and named export
42
43
  exports.default = steam_1.default;
43
44
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,oDAAoC;AAEpC,4CAA4C;AAC5C,8EAA6E;AAApE,kIAAA,uBAAuB,OAAA;AAChC,kEAAiE;AAAxD,sHAAA,iBAAiB,OAAA;AAC1B,8EAA6E;AAApE,kIAAA,uBAAuB,OAAA;AAChC,sEAAqE;AAA5D,0HAAA,mBAAmB,OAAA;AAC5B,gFAA+E;AAAtE,oIAAA,wBAAwB,OAAA;AACjC,sEAAqE;AAA5D,0HAAA,mBAAmB,OAAA;AAC5B,kEAAiE;AAAxD,sHAAA,iBAAiB,OAAA;AAC1B,wEAAuE;AAA9D,4HAAA,oBAAoB,OAAA;AAE7B,4CAA4C;AAC5C,0CAAwB;AAExB,0BAA0B;AAC1B,kBAAe,eAAa,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,oDAAoC;AAiB3B,wBAjBF,eAAa,CAiBE;AAftB,4CAA4C;AAC5C,8EAA6E;AAApE,kIAAA,uBAAuB,OAAA;AAChC,kEAAiE;AAAxD,sHAAA,iBAAiB,OAAA;AAC1B,8EAA6E;AAApE,kIAAA,uBAAuB,OAAA;AAChC,sEAAqE;AAA5D,0HAAA,mBAAmB,OAAA;AAC5B,gFAA+E;AAAtE,oIAAA,wBAAwB,OAAA;AACjC,sEAAqE;AAA5D,0HAAA,mBAAmB,OAAA;AAC5B,kEAAiE;AAAxD,sHAAA,iBAAiB,OAAA;AAC1B,wEAAuE;AAA9D,4HAAA,oBAAoB,OAAA;AAE7B,4CAA4C;AAC5C,0CAAwB;AAExB,2DAA2D;AAC3D,kBAAe,eAAa,CAAC"}
package/docs/README.md CHANGED
@@ -9,7 +9,7 @@ Steamworks FFI uses a **manager-based architecture** for better organization:
9
9
  ```typescript
10
10
  import SteamworksSDK from 'steamworks-ffi-node';
11
11
 
12
- const steam = new SteamworksSDK();
12
+ const steam = SteamworksSDK.getInstance();
13
13
  steam.init({ appId: 480 });
14
14
 
15
15
  // Access features through specialized managers
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "steamworks-ffi-node",
3
- "version": "0.6.9",
3
+ "version": "0.6.10",
4
4
  "description": "Steamworks SDK wrapper using FFI for Node.js/Electron - Full Steam Integration",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -181,13 +181,13 @@ function testBasicFunctionality() {
181
181
  try {
182
182
  console.log('Attempting to load steamworks-ffi-node...');
183
183
 
184
- // Try to require the package
185
- const SteamworksSDK = require('./dist/index.js').default || require('./dist/index.js');
184
+ // Try to require the package (named export is preferred)
185
+ const { SteamworksSDK } = require('./dist/index.js');
186
186
  console.log('✅ Package loaded successfully');
187
187
 
188
188
  // Try to create instance (this will test SDK loading)
189
189
  console.log('Testing SDK initialization...');
190
- const steam = new SteamworksSDK();
190
+ SteamworksSDK.getInstance();
191
191
  console.log('✅ SteamworksSDK instance created');
192
192
 
193
193
  console.log('');