@redmix/auth-auth0-web 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Redmix
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,148 @@
+# Authentication
+
+## Contributing
+
+If you want to contribute a new auth provider integration we recommend you
+start by implementing it as a custom auth provider in a Redwood App first. When
+that works you can package it up as an npm package and publish it on your own.
+You can then create a PR on this repo with support for your new auth provider
+in our `yarn rw setup auth` cli command. The easiest option is probably to just
+look at one of the existing auth providers in
+`packages/cli/src/commands/setup/auth/providers` and the corresponding
+templates in `../templates`.
+
+If you need help setting up a custom auth provider you can read the auth docs
+on the web.
+
+### Contributing to the base auth implementation
+
+If you want to contribute to our auth implementation, the interface towards
+both auth service providers and RW apps we recommend you start looking in
+`authFactory.ts` and then continue to `AuthProvider.tsx`. `AuthProvider.tsx`
+has most of our implementation together with all the custom hooks it uses.
+Another file to be accustomed with is `AuthContext.ts`. The interface in there
+has pretty good code comments, and is what will be exposed to RW apps.
+
+## getCurrentUser
+
+`getCurrentUser` returns the user information together with
+an optional collection of roles used by requireAuth() to check if the user is authenticated or has role-based access.
+
+Use in conjunction with `requireAuth` in your services to check that a user is logged in, whether or not they are assigned a role, and optionally raise an error if they're not.
+
+```js
+@param decoded - The decoded access token containing user info and JWT claims like `sub`
+@param { token, SupportedAuthTypes type } - The access token itself as well as the auth provider type
+@param { APIGatewayEvent event, Context context } - An object which contains information from the invoker
+such as headers and cookies, and the context information about the invocation such as IP Address
+```
+
+### Examples
+
+#### Checks if currentUser is authenticated
+
+This example is the standard use of `getCurrentUser`.
+
+```js
+export const getCurrentUser = async (
+  decoded,
+  { _token, _type },
+  { _event, _context },
+) => {
+  return { ...decoded, roles: parseJWT({ decoded }).roles }
+}
+```
+
+#### User details fetched via database query
+
+```js
+export const getCurrentUser = async (decoded) => {
+  return await db.user.findUnique({ where: { decoded.email } })
+}
+```
+
+#### User info is decoded from the access token
+
+```js
+export const getCurrentUser = async (decoded) => {
+  return { ...decoded }
+}
+```
+
+#### User info is contained in the decoded token and roles extracted
+
+```js
+export const getCurrentUser = async (decoded) => {
+  return { ...decoded, roles: parseJWT({ decoded }).roles }
+}
+```
+
+#### User record query by email with namespaced app_metadata roles as Auth0 requires custom JWT claims to be namespaced
+
+```js
+export const getCurrentUser = async (decoded) => {
+  const currentUser = await db.user.findUnique({
+    where: { email: decoded.email },
+  })
+
+  return {
+    ...currentUser,
+    roles: parseJWT({ decoded: decoded, namespace: NAMESPACE }).roles,
+  }
+}
+```
+
+#### User record query by an identity with app_metadata roles
+
+```js
+const getCurrentUser = async (decoded) => {
+  const currentUser = await db.user.findUnique({
+    where: { userIdentity: decoded.sub },
+  })
+  return {
+    ...currentUser,
+    roles: parseJWT({ decoded: decoded }).roles,
+  }
+}
+```
+
+#### Cookies and other request information are available in the req parameter, just in case
+
+```js
+const getCurrentUser = async (_decoded, _raw, { event, _context }) => {
+  const cookies = cookie(event.headers.cookies)
+  const session = cookies['my.cookie.name']
+  const currentUser = await db.sessions.findUnique({ where: { id: session } })
+  return currentUser
+}
+```
+
+## requireAuth
+
+Use `requireAuth` in your services to check that a user is logged in, whether or not they are assigned a role, and optionally raise an error if they're not.
+
+```js
+@param {string=} roles - An optional role or list of roles
+@param {string[]=} roles - An optional list of roles
+
+@returns {boolean} - If the currentUser is authenticated (and assigned one of the given roles)
+
+@throws {AuthenticationError} - If the currentUser is not authenticated
+@throws {ForbiddenError} If the currentUser is not allowed due to role permissions
+```
+
+### Examples
+
+#### Checks if currentUser is authenticated
+
+```js
+requireAuth()
+```
+
+#### Checks if currentUser is authenticated and assigned one of the given roles
+
+```js
+requireAuth({ role: 'admin' })
+requireAuth({ role: ['editor', 'author'] })
+requireAuth({ role: ['publisher'] })
+```

package/dist/auth0.d.ts

@@ -0,0 +1,13 @@
+import type { Auth0Client, LogoutOptions, RedirectLoginOptions } from '@auth0/auth0-spa-js';
+import type { CurrentUser } from '@redmix/auth';
+export interface Auth0User {
+}
+export declare function createAuth(auth0Client: Auth0Client, customProviderHooks?: {
+    useCurrentUser?: () => Promise<CurrentUser>;
+    useHasRole?: (currentUser: CurrentUser | null) => (rolesToCheck: string | string[]) => boolean;
+}): {
+    AuthContext: import("react").Context<import("@redmix/auth").AuthContextInterface<import("@auth0/auth0-spa-js").User, RedirectLoginOptions<any>, void, LogoutOptions, void, RedirectLoginOptions<any>, void, unknown, unknown, unknown, unknown, Auth0Client> | undefined>;
+    AuthProvider: ({ children }: import("@redmix/auth").AuthProviderProps) => import("react").JSX.Element;
+    useAuth: () => import("@redmix/auth").AuthContextInterface<import("@auth0/auth0-spa-js").User, RedirectLoginOptions<any>, void, LogoutOptions, void, RedirectLoginOptions<any>, void, unknown, unknown, unknown, unknown, Auth0Client>;
+};
+//# sourceMappingURL=auth0.d.ts.map

package/dist/auth0.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth0.d.ts","sourceRoot":"","sources":["../src/auth0.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,WAAW,EACX,aAAa,EACb,oBAAoB,EACrB,MAAM,qBAAqB,CAAA;AAE5B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAK/C,MAAM,WAAW,SAAS;CAAG;AAE7B,wBAAgB,UAAU,CACxB,WAAW,EAAE,WAAW,EACxB,mBAAmB,CAAC,EAAE;IACpB,cAAc,CAAC,EAAE,MAAM,OAAO,CAAC,WAAW,CAAC,CAAA;IAC3C,UAAU,CAAC,EAAE,CACX,WAAW,EAAE,WAAW,GAAG,IAAI,KAC5B,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,OAAO,CAAA;CAClD;;wCAqBG,cAEU,+BAA+B,OAC9C;;EAnBA"}

package/dist/auth0.js

@@ -0,0 +1,35 @@
+import { createAuthentication } from "@redmix/auth";
+function createAuth(auth0Client, customProviderHooks) {
+  const authImplementation = createAuthImplementation(auth0Client);
+  return createAuthentication(authImplementation, customProviderHooks);
+}
+function createAuthImplementation(auth0Client) {
+  return {
+    type: "auth0",
+    client: auth0Client,
+    restoreAuthState: async () => {
+      if (globalThis?.location?.search?.includes("code=") && globalThis?.location?.search?.includes("state=")) {
+        const { appState } = await auth0Client.handleRedirectCallback();
+        const url = appState?.targetUrl ? appState.targetUrl : window.location.pathname;
+        globalThis?.location?.assign(url);
+      }
+    },
+    login: async (options) => auth0Client.loginWithRedirect(options),
+    logout: async (options) => auth0Client.logout(options),
+    signup: async (options) => auth0Client.loginWithRedirect({
+      ...options,
+      authorizationParams: {
+        screen_hint: "signup",
+        prompt: "login"
+      }
+    }),
+    getToken: () => auth0Client.getTokenSilently(),
+    getUserMetadata: async () => {
+      const user = await auth0Client.getUser();
+      return user || null;
+    }
+  };
+}
+export {
+  createAuth
+};

package/dist/cjs/auth0.d.ts

@@ -0,0 +1,13 @@
+import type { Auth0Client, LogoutOptions, RedirectLoginOptions } from '@auth0/auth0-spa-js';
+import type { CurrentUser } from '@redmix/auth';
+export interface Auth0User {
+}
+export declare function createAuth(auth0Client: Auth0Client, customProviderHooks?: {
+    useCurrentUser?: () => Promise<CurrentUser>;
+    useHasRole?: (currentUser: CurrentUser | null) => (rolesToCheck: string | string[]) => boolean;
+}): {
+    AuthContext: import("react").Context<import("@redmix/auth").AuthContextInterface<import("@auth0/auth0-spa-js").User, RedirectLoginOptions<any>, void, LogoutOptions, void, RedirectLoginOptions<any>, void, unknown, unknown, unknown, unknown, Auth0Client> | undefined>;
+    AuthProvider: ({ children }: import("@redmix/auth").AuthProviderProps) => import("react").JSX.Element;
+    useAuth: () => import("@redmix/auth").AuthContextInterface<import("@auth0/auth0-spa-js").User, RedirectLoginOptions<any>, void, LogoutOptions, void, RedirectLoginOptions<any>, void, unknown, unknown, unknown, unknown, Auth0Client>;
+};
+//# sourceMappingURL=auth0.d.ts.map

package/dist/cjs/auth0.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth0.d.ts","sourceRoot":"","sources":["../../src/auth0.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,WAAW,EACX,aAAa,EACb,oBAAoB,EACrB,MAAM,qBAAqB,CAAA;AAE5B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAK/C,MAAM,WAAW,SAAS;CAAG;AAE7B,wBAAgB,UAAU,CACxB,WAAW,EAAE,WAAW,EACxB,mBAAmB,CAAC,EAAE;IACpB,cAAc,CAAC,EAAE,MAAM,OAAO,CAAC,WAAW,CAAC,CAAA;IAC3C,UAAU,CAAC,EAAE,CACX,WAAW,EAAE,WAAW,GAAG,IAAI,KAC5B,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,OAAO,CAAA;CAClD;;wCAqBG,cAEU,+BAA+B,OAC9C;;EAnBA"}

package/dist/cjs/auth0.js

@@ -0,0 +1,59 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var auth0_exports = {};
+__export(auth0_exports, {
+  createAuth: () => createAuth
+});
+module.exports = __toCommonJS(auth0_exports);
+var import_auth = require("@redmix/auth");
+function createAuth(auth0Client, customProviderHooks) {
+  const authImplementation = createAuthImplementation(auth0Client);
+  return (0, import_auth.createAuthentication)(authImplementation, customProviderHooks);
+}
+function createAuthImplementation(auth0Client) {
+  return {
+    type: "auth0",
+    client: auth0Client,
+    restoreAuthState: async () => {
+      if (globalThis?.location?.search?.includes("code=") && globalThis?.location?.search?.includes("state=")) {
+        const { appState } = await auth0Client.handleRedirectCallback();
+        const url = appState?.targetUrl ? appState.targetUrl : window.location.pathname;
+        globalThis?.location?.assign(url);
+      }
+    },
+    login: async (options) => auth0Client.loginWithRedirect(options),
+    logout: async (options) => auth0Client.logout(options),
+    signup: async (options) => auth0Client.loginWithRedirect({
+      ...options,
+      authorizationParams: {
+        screen_hint: "signup",
+        prompt: "login"
+      }
+    }),
+    getToken: () => auth0Client.getTokenSilently(),
+    getUserMetadata: async () => {
+      const user = await auth0Client.getUser();
+      return user || null;
+    }
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createAuth
+});

package/dist/cjs/index.d.ts

@@ -0,0 +1,2 @@
+export { createAuth } from './auth0.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA"}

package/dist/cjs/index.js

@@ -0,0 +1,28 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var index_exports = {};
+__export(index_exports, {
+  createAuth: () => import_auth0.createAuth
+});
+module.exports = __toCommonJS(index_exports);
+var import_auth0 = require("./auth0.js");
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createAuth
+});

package/dist/cjs/package.json

@@ -0,0 +1 @@
+{"type":"commonjs"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { createAuth } from './auth0.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA"}

package/dist/index.js

@@ -0,0 +1,4 @@
+import { createAuth } from "./auth0.js";
+export {
+  createAuth
+};

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "@redmix/auth-auth0-web",
+  "version": "0.0.1",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/redmix-run/redmix.git",
+    "directory": "packages/auth-providers/auth0/web"
+  },
+  "license": "MIT",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "default": {
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      }
+    },
+    "./dist/auth0": {
+      "import": {
+        "types": "./dist/auth0.d.ts",
+        "default": "./dist/auth0.js"
+      },
+      "default": {
+        "types": "./dist/cjs/auth0.d.ts",
+        "default": "./dist/cjs/auth0.js"
+      }
+    }
+  },
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsx ./build.ts",
+    "build:pack": "yarn pack -o redmix-auth-auth0-web.tgz",
+    "build:types": "tsc --build --verbose ./tsconfig.build.json",
+    "build:types-cjs": "tsc --build --verbose ./tsconfig.cjs.json",
+    "build:watch": "nodemon --watch src --ext \"js,jsx,ts,tsx,template\" --ignore dist --exec \"yarn build\"",
+    "check:attw": "yarn rw-fwtools-attw",
+    "check:package": "concurrently npm:check:attw yarn:publint",
+    "prepublishOnly": "NODE_ENV=production yarn build",
+    "test": "vitest run",
+    "test:watch": "vitest watch"
+  },
+  "dependencies": {
+    "@redmix/auth": "0.0.1"
+  },
+  "devDependencies": {
+    "@auth0/auth0-spa-js": "2.1.3",
+    "@redmix/framework-tools": "0.0.1",
+    "@types/react": "^18.2.55",
+    "concurrently": "8.2.2",
+    "publint": "0.3.11",
+    "react": "19.0.0-rc-f2df5694-20240916",
+    "tsx": "4.19.3",
+    "typescript": "5.6.2",
+    "vitest": "2.1.9"
+  },
+  "peerDependencies": {
+    "@auth0/auth0-spa-js": "2.1.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "688027c97502c500ebbede9cdc7cc51545a8dcf3"
+}