@ianlucas/remix-auth-steam 2.1.1 → 4.0.0

package/.github/workflows/publish.yml

@@ -0,0 +1,30 @@
+name: Publish Release (npm)
+
+on:
+    release:
+        types: [published]
+
+jobs:
+    publish-npm:
+        runs-on: ubuntu-latest
+        permissions:
+            id-token: write
+        steps:
+            - uses: actions/checkout@v4
+            - uses: actions/setup-node@v4
+              with:
+                  node-version: 22.x
+                  registry-url: "https://registry.npmjs.org"
+                  cache: "npm"
+            - run: npm ci
+            - run: npm version ${TAG_NAME} --git-tag-version=false
+              env:
+                  TAG_NAME: ${{ github.ref_name }}
+            - run: npm publish --provenance --access public --tag next
+              if: "github.event.release.prerelease"
+              env:
+                  NODE_AUTH_TOKEN: ${{ secrets.npm_token }}
+            - run: npm publish --provenance --access public
+              if: "!github.event.release.prerelease"
+              env:
+                  NODE_AUTH_TOKEN: ${{ secrets.npm_token }}

package/dist/index.d.ts

@@ -2,11 +2,15 @@ import { SessionStorage } from "@remix-run/server-runtime";
 import { AuthenticateOptions, Strategy, StrategyVerifyCallback } from "remix-auth";
 import { UserSummary } from "steamapi";
 export interface SteamStrategyOptions {
-    returnURL: string;
-    realm?: string;
     apiKey: string;
+    onError?: (error: unknown) => void;
+    realm?: string;
+    returnURL: string;
 }
-export type SteamStrategyVerifyParams = UserSummary;
+export type SteamStrategyVerifyParams = {
+    request: Request;
+    user: UserSummary;
+};
 export declare class SteamStrategy<User> extends Strategy<User, SteamStrategyVerifyParams> {
     private options;
     name: string;

package/dist/index.js

@@ -40,7 +40,12 @@ export class SteamStrategy extends Strategy {
         this.options = options;
     }
     async authenticate(request, sessionStorage, options) {
-        const { apiKey, returnURL, realm } = typeof this.options === "function" ? await this.options(request) : this.options;
+        const { apiKey, onError, returnURL, realm } = typeof this.options === "function" ? await this.options(request) : this.options;
+        const notifyError = (error) => {
+            if (!(error instanceof Response)) {
+                onError?.(error);
+            }
+        };
         const relyingParty = new OpenID.RelyingParty(returnURL, realm ?? null, true, false, []);
         const steamApi = new SteamAPI(apiKey);
         try {
@@ -50,16 +55,24 @@ export class SteamStrategy extends Strategy {
             try {
                 const userSteamID = result.claimedIdentifier.toString().split("/").at(-1);
                 const steamUserSummary = (await steamApi.getUserSummary(userSteamID));
-                const user = await this.verify(steamUserSummary);
+                const user = await this.verify({ user: steamUserSummary, request });
                 return this.success(user, request, sessionStorage, options);
             }
             catch (error) {
+                notifyError(error);
                 let message = error.message;
                 return this.failure(message, request, sessionStorage, options);
             }
         }
-        catch {
-            throw redirect(await authenticateToSteam(relyingParty));
+        catch (error) {
+            notifyError(error);
+            try {
+                throw redirect(await authenticateToSteam(relyingParty));
+            }
+            catch (error) {
+                notifyError(error);
+                throw error;
+            }
         }
     }
 }

package/package.json

@@ -1,6 +1,5 @@
 {
     "name": "@ianlucas/remix-auth-steam",
-    "version": "2.1.1",
     "description": "Remix authentication strategy for Steam",
     "license": "MIT",
     "author": "Ian Lucas",
@@ -19,29 +18,31 @@
     "scripts": {
         "prepack": "([ -d dist ] && rm -rf dist); tsc",
         "typecheck": "tsc --project tsconfig.json --noEmit",
-        "format": "prettier . --write"
+        "format": "prettier . --write",
+        "upgrade": "npx npm-check-updates@latest --target minor -u"
     },
     "peerDependencies": {
         "@remix-run/server-runtime": "^2.8.1"
     },
     "devDependencies": {
-        "@babel/core": "^7.24.1",
-        "@babel/preset-env": "^7.24.1",
-        "@babel/preset-react": "^7.24.1",
-        "@babel/preset-typescript": "^7.24.1",
-        "@remix-run/node": "^2.8.1",
-        "@remix-run/react": "^2.8.1",
-        "@remix-run/server-runtime": "^2.8.1",
-        "@types/node": "^20.11.30",
+        "@babel/core": "^7.25.2",
+        "@babel/preset-env": "^7.25.4",
+        "@babel/preset-react": "^7.24.7",
+        "@babel/preset-typescript": "^7.24.7",
+        "@remix-run/node": "^2.11.2",
+        "@remix-run/react": "^2.11.2",
+        "@remix-run/server-runtime": "^2.11.2",
+        "@types/node": "^20.16.1",
         "@types/openid": "^2.0.5",
-        "prettier": "^3.2.5",
-        "react": "^18.2.0",
-        "typescript": "^5.4.2"
+        "prettier": "^3.3.3",
+        "react": "^18.3.1",
+        "typescript": "^5.5.4"
     },
     "dependencies": {
         "@types/steamapi": "^2.2.5",
         "openid": "^2.0.12",
-        "remix-auth": "^3.6.0",
-        "steamapi": "^3.0.8"
-    }
+        "remix-auth": "^3.7.0",
+        "steamapi": "^3.0.12"
+    },
+    "version": "4.0.0"
 }