passport-steam-openid 1.1.0 → 1.1.2

package/.github/workflows/pull-request.yml

@@ -13,7 +13,7 @@ jobs:
 
       - uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 20
         name: Setup Node.JS
 
       - run: npm ci

package/.github/workflows/release.yml

@@ -12,7 +12,7 @@ jobs:
 
       - uses: actions/setup-node@v3
         with:
-          node-version: '18'
+          node-version: 20
         name: Setup Node.JS
 
       - name: Install packages

package/README.md

@@ -5,6 +5,56 @@ This package only relies on [passport](https://www.passportjs.org/) and [axios](
 
 Library is fully covered with tests, both unit and integration tests to make sure everything runs correctly.
 
+## API
+
+Instantiate the `SteamOpenIdStrategy` as following:
+```ts
+new SteamOpenIdStrategy(options, verify)
+```
+
+Options object has the following properties:
+- `returnURL` - URL to which steam will redirect user after authentication
+- `profile` - If set to true, it will fetch user profile from steam api, otherwise only steamid will be returned
+- `apiKey` - Steam api key, required if `options.profile` is set to true
+- `maxNonceTimeDelay` - Optional, in seconds, time between creation and verification of nonce date, if not set no verification occurs.
+
+Second parameter of `SteamOpenIdStrategy` is a callback function used for verifying logged in user, with the following parameters:
+- `req` - Express request object
+- `steamid` - Steam id of the authenticated user
+- `profile` - Full profile from GetPlayerSummaries api, if `options.profile` is set to true, otherwise only steamid
+- `done` - Passport callback function
+
+Profile if `options.profile` is set to true:
+```ts
+export type SteamOpenIdUserProfile = {
+  steamid: string;
+  communityvisibilitystate: number;
+  profilestate: number;
+  personaname: string;
+  commentpermission: number;
+  profileurl: string;
+  avatar: string;
+  avatarmedium: string;
+  avatarfull: string;
+  avatarhash: string;
+  lastlogoff: number;
+  personastate: number;
+  realname: string;
+  primaryclanid: string;
+  timecreated: number;
+  personastateflags: number;
+  loccountrycode: string;
+  locstatecode: string;
+};
+```
+
+Other it is just:
+```ts
+export type SteamOpenIdUser = {
+  steamid: string;
+};
+```
+
 ## Usage
 ```ts
 import { SteamOpenIdStrategy } from 'passport-steam-openid';
@@ -13,11 +63,12 @@ passport.use(
     new SteamOpenIdStrategy({
         returnURL: 'http://localhost:3000/auth/steam',
         profile: true,
-        apiKey: '<insert steam api key>'
+        apiKey: '<insert steam api key>', // No need for api key, if profile is set to false
+        maxNonceTimeDelay: 30 // Optional, in seconds, time between creation and verification of nonce date
     }, (
         req: Request, 
         identifier: string, 
-        profile: SteamOpenIdUserProfile, 
+        profile: SteamOpenIdUserProfile, // if profile is false, then it's only { steamid }, otherwise full profile from GetPlayerSummaries api
         done: VerifyCallback
     ) => {
         // Optional callback called only when successful authentication occurs
@@ -44,6 +95,8 @@ app.use(
             // Steam rejected this authentication request
         case SteamOpenIdErrorType.InvalidSteamId:
             // Steam profile doesn't exist
+        case SteamOpenIdErrorType.NonceExpired:
+            // Nonce has expired, only if `options.maxNonceTimeDelay` is set
       }
     }
     // ...
@@ -59,6 +112,7 @@ Install using npm:
 ```
 npm install passport-steam-openid
 ```
+
 Library's API has been unchanged and stable for some time now. It will not change unless a breaking change is issued by steam (very unlikely).
 
 ## License

package/dist/strategy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"strategy.d.ts","sourceRoot":"","sources":["../src/strategy.ts"],"names":[],"mappings":";AAAA,OAAW,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AACjD,OAAc,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAUpC,OAAO,EACL,sBAAsB,EACtB,eAAe,EACf,gBAAgB,EAGhB,qCAAqC,EACrC,wCAAwC,EACxC,cAAc,EACf,MAAM,QAAQ,CAAC;AAEhB;;;;;;;GAOG;AACH,qBAAa,mBAAmB,CAC9B,QAAQ,SACJ,qCAAqC,GACrC,wCAAwC,EAC5C,KAAK,SACD,eAAe,GACf,sBAAsB,GAAG,QAAQ,SAAS,qCAAqC,GAC/E,sBAAsB,GACtB,eAAe,CACnB,SAAQ,QAAQ;IAChB;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC;IAExC;;;;OAIG;IACH,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAErC;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAEpC;;OAEG;IACH,SAAS,CAAC,MAAM,CAAC,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC;IAEzC;;;;;OAKG;IACH,SAAS,CAAC,iBAAiB,EAAE,MAAM,GAAG,SAAS,CAAC;IAEhD;;;;;;;;;;OAUG;gBACS,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE,cAAc,CAAC,KAAK,CAAC;IAY7D;;;;OAIG;IACmB,YAAY,CAAC,GAAG,EAAE,GAAG;IA+B3C;;;;;;;;;;;;;OAaG;IACU,aAAa,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,KAAK,CAAC;IAmCpD;;;;;;OAMG;IACH,SAAS,CAAC,eAAe,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO;IAW3D;;;;;;;;OAQG;IACH,SAAS,CAAC,gBAAgB,CAAC,GAAG,EAAE,OAAO;IAOvC;;;;;;OAMG;IACH,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG,GAAG,cAAc;IAQ5C;;;;;;OAMG;IACH,SAAS,CAAC,YAAY,CAAC,KAAK,EAAE,cAAc;IAI5C;;;;OAIG;IACI,gBAAgB;IAYvB;;;;;;;OAOG;IACH,SAAS,CAAC,YAAY,CAAC,KAAK,EAAE,cAAc,GAAG,KAAK,IAAI,gBAAgB;IAcxE;;;;;;OAMG;IACH,SAAS,CAAC,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IASpD;;;;;;OAMG;IACH,SAAS,CAAC,oBAAoB,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC;IAoBzE;;;;OAIG;IACH,SAAS,CAAC,8BAA8B,CAAC,KAAK,EAAE,gBAAgB;IAMhE;;;;;;OAMG;IACH,SAAS,CAAC,oBAAoB,CAAC,QAAQ,EAAE,GAAG;IAQ5C;;;;;OAKG;IACH,SAAS,CAAC,UAAU,CAAC,KAAK,EAAE,gBAAgB;IAM5C;;;;;;;;OAQG;cACa,OAAO,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IASxD;;;;;;;;;;OAUG;cACa,kBAAkB,CAChC,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,sBAAsB,CAAC;CAiCnC"}
+{"version":3,"file":"strategy.d.ts","sourceRoot":"","sources":["../src/strategy.ts"],"names":[],"mappings":";AAAA,OAAW,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AACjD,OAAc,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAUpC,OAAO,EACL,sBAAsB,EACtB,eAAe,EACf,gBAAgB,EAGhB,qCAAqC,EACrC,wCAAwC,EACxC,cAAc,EACf,MAAM,QAAQ,CAAC;AAEhB;;;;;;;GAOG;AACH,qBAAa,mBAAmB,CAC9B,QAAQ,SACJ,qCAAqC,GACrC,wCAAwC,EAC5C,KAAK,SACD,eAAe,GACf,sBAAsB,GAAG,QAAQ,SAAS,qCAAqC,GAC/E,sBAAsB,GACtB,eAAe,CACnB,SAAQ,QAAQ;IAChB;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC;IAExC;;;;OAIG;IACH,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAErC;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAEpC;;OAEG;IACH,SAAS,CAAC,MAAM,CAAC,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC;IAEzC;;;;;OAKG;IACH,SAAS,CAAC,iBAAiB,EAAE,MAAM,GAAG,SAAS,CAAC;IAEhD;;;;;;;;;;OAUG;gBACS,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE,cAAc,CAAC,KAAK,CAAC;IAY7D;;;;OAIG;IACmB,YAAY,CAAC,GAAG,EAAE,GAAG;IA+B3C;;;;;;;;;;;;;OAaG;IACU,aAAa,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,KAAK,CAAC;IAmCpD;;;;;;OAMG;IACH,SAAS,CAAC,eAAe,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO;IAW3D;;;;;;;;OAQG;IACH,SAAS,CAAC,gBAAgB,CAAC,GAAG,EAAE,OAAO;IAOvC;;;;;;OAMG;IACH,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG,GAAG,cAAc;IAQ5C;;;;;;OAMG;IACH,SAAS,CAAC,YAAY,CAAC,KAAK,EAAE,cAAc;IAI5C;;;;OAIG;IACI,gBAAgB;IAYvB;;;;;;;OAOG;IACH,SAAS,CAAC,YAAY,CAAC,KAAK,EAAE,cAAc,GAAG,KAAK,IAAI,gBAAgB;IAcxE;;;;;;OAMG;IACH,SAAS,CAAC,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IASpD;;;;;;OAMG;IACH,SAAS,CAAC,oBAAoB,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC;IAoBzE;;;;OAIG;IACH,SAAS,CAAC,8BAA8B,CAAC,KAAK,EAAE,gBAAgB;IAMhE;;;;;;OAMG;IACH,SAAS,CAAC,oBAAoB,CAAC,QAAQ,EAAE,GAAG;IAQ5C;;;;;OAKG;IACH,SAAS,CAAC,UAAU,CAAC,KAAK,EAAE,gBAAgB;IAM5C;;;;;;;;OAQG;cACa,OAAO,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IASxD;;;;;;;;;;OAUG;cACa,kBAAkB,CAChC,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,sBAAsB,CAAC;CA+BnC"}

package/dist/strategy.js

@@ -303,27 +303,24 @@ class SteamOpenIdStrategy extends passport_1.Strategy {
      * @throws {SteamOpenIdError} if profile was not found
      */
     fetchPlayerSummary(steamId) {
+        var _a;
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const summaryQuery = {
                 steamids: steamId,
                 key: this.apiKey,
             };
-            return this.axios
-                .get(`${constant_1.PLAYER_SUMMARY_URL}/?${querystring_1.default.stringify(summaryQuery)}`)
-                .then(({ data }) => {
-                var _a;
-                if (!Array.isArray((_a = data === null || data === void 0 ? void 0 : data.response) === null || _a === void 0 ? void 0 : _a.players)) {
-                    throw new Error('Malformed response from steam.');
-                }
-                const user = data.response.players[0];
-                if (!user) {
-                    throw new error_1.SteamOpenIdError('Profile was not found on steam.', type_1.SteamOpenIdErrorType.InvalidSteamId);
-                }
-                if (user.steamid != steamId) {
-                    throw new error_1.SteamOpenIdError('API returned invalid user.', type_1.SteamOpenIdErrorType.InvalidSteamId);
-                }
-                return user;
-            });
+            const { data } = yield this.axios.get(`${constant_1.PLAYER_SUMMARY_URL}/?${querystring_1.default.stringify(summaryQuery)}`);
+            if (!Array.isArray((_a = data === null || data === void 0 ? void 0 : data.response) === null || _a === void 0 ? void 0 : _a.players)) {
+                throw new Error('Malformed response from steam.');
+            }
+            const user = data.response.players[0];
+            if (!user) {
+                throw new error_1.SteamOpenIdError('Profile was not found on steam.', type_1.SteamOpenIdErrorType.InvalidSteamId);
+            }
+            if (user.steamid != steamId) {
+                throw new error_1.SteamOpenIdError('API returned invalid user.', type_1.SteamOpenIdErrorType.InvalidSteamId);
+            }
+            return user;
         });
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "passport-steam-openid",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "description": "Passport strategy for authenticating with steam openid without the use of 3rd party openid packages.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -51,7 +51,7 @@
     "nock": "^13.3.2",
     "nyc": "^15.1.0",
     "prettier": "^2.8.8",
-    "semantic-release": "^21.0.5",
+    "semantic-release": "^24.0.0",
     "sinon": "^15.2.0",
     "ts-node": "^10.9.1",
     "typescript": "^5.1.3"

package/sample/package-lock.json

@@ -744,12 +744,12 @@
       }
     },
     "node_modules/braces": {
-      "version": "3.0.2",
-      "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz",
-      "integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==",
+      "version": "3.0.3",
+      "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz",
+      "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==",
       "dev": true,
       "dependencies": {
-        "fill-range": "^7.0.1"
+        "fill-range": "^7.1.1"
       },
       "engines": {
         "node": ">=8"
@@ -1426,9 +1426,9 @@
       }
     },
     "node_modules/fill-range": {
-      "version": "7.0.1",
-      "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz",
-      "integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==",
+      "version": "7.1.1",
+      "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz",
+      "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==",
       "dev": true,
       "dependencies": {
         "to-regex-range": "^5.0.1"

package/src/strategy.ts

@@ -399,31 +399,29 @@ export class SteamOpenIdStrategy<
       key: this.apiKey,
     };
 
-    return this.axios
-      .get<SteamPlayerSummaryResponse>(
-        `${PLAYER_SUMMARY_URL}/?${qs.stringify(summaryQuery)}`,
-      )
-      .then(({ data }) => {
-        if (!Array.isArray(data?.response?.players)) {
-          throw new Error('Malformed response from steam.');
-        }
+    const { data } = await this.axios.get<SteamPlayerSummaryResponse>(
+      `${PLAYER_SUMMARY_URL}/?${qs.stringify(summaryQuery)}`,
+    );
 
-        const user = data.response.players[0];
-        if (!user) {
-          throw new SteamOpenIdError(
-            'Profile was not found on steam.',
-            SteamOpenIdErrorType.InvalidSteamId,
-          );
-        }
+    if (!Array.isArray(data?.response?.players)) {
+      throw new Error('Malformed response from steam.');
+    }
 
-        if (user.steamid != steamId) {
-          throw new SteamOpenIdError(
-            'API returned invalid user.',
-            SteamOpenIdErrorType.InvalidSteamId,
-          );
-        }
+    const user = data.response.players[0];
+    if (!user) {
+      throw new SteamOpenIdError(
+        'Profile was not found on steam.',
+        SteamOpenIdErrorType.InvalidSteamId,
+      );
+    }
 
-        return user;
-      });
+    if (user.steamid != steamId) {
+      throw new SteamOpenIdError(
+        'API returned invalid user.',
+        SteamOpenIdErrorType.InvalidSteamId,
+      );
+    }
+
+    return user;
   }
 }