@freshheads/react-auth 0.0.1-alpha.1

package/README.md

@@ -0,0 +1,33 @@
+# react-vite-component-template
+
+Template for building a **React component library**, with **Vite**, **TypeScript** and **Storybook**.
+
+Check my post about this repository [here](https://victorlillo.dev/blog/react-typescript-vite-component-library).
+
+## Features
+
+- ⚛️ **React** component library with **TypeScript**.
+
+- 🏗️ **Vite** as development environment.
+
+- 🌳 **Tree shaking**, for not distributing dead-code.
+
+- 🧪 Testing with **Vitest** and **React Testing Library**.
+
+- ✅ Code quality tools with **ESLint**, **Prettier**
+
+## 🤖 Scripts
+
+|      Script       | Function                                                                           |
+| :---------------: | ---------------------------------------------------------------------------------- |
+|      `build`      | Build the `dist`, with types declarations, after checking types with TypeScript.   |
+|      `lint`       | Lint the project with **Eslint**.                                                  |
+|    `lint:fix`     | Lint and fix the project with **Eslint**.                                          |
+|     `format`      | Check the project format with **Prettier**.                                        |
+|   `format:fix`    | Format the project code with **Prettier**.                                         |
+|    `stylelint`    | Lint the styles code with **Stylelint**.                                           |
+|  `stylelint:fix`  | Lint and fix the styles code with **Stylelint**.                                   |
+|    `storybook`    | Start a Storybook development server.                                              |
+| `build-storybook` | Build the Storybook `dist`.                                                        |
+|      `test`       | Run the tests with **Vitest** using `jsdom` and starts a **Vitest UI** dev server. |
+|    `coverage`     | Generate a coverage report, with **v8**.                                           |

package/dist/hooks/useSignIn.d.ts

@@ -0,0 +1 @@
+export declare function useSignIn(): void;

package/dist/hooks/useSignOut.d.ts

@@ -0,0 +1 @@
+export declare function useSignOut(): void;

package/dist/main.d.ts

@@ -0,0 +1,3 @@
+export { useSignIn } from './hooks/useSignIn.ts';
+export { useSignOut } from './hooks/useSignOut.ts';
+export { default as withAuth } from './next/proxy.ts';

package/dist/main.js

@@ -0,0 +1,67 @@
+import { NextResponse as i } from "next/server.js";
+import { jwtDecode as f } from "jwt-decode";
+import { match as g } from "path-to-regexp";
+function y() {
+  throw new Error("useSignIn not yet implementend");
+}
+function S() {
+  throw new Error("useSignOut not yet implementend");
+}
+function p(e) {
+  if (!e.has("jwt_hp"))
+    return null;
+  const t = e.get("jwt_hp")?.value;
+  if (!t)
+    return null;
+  try {
+    return f(t).roles || null;
+  } catch (r) {
+    return console.error(r), null;
+  }
+}
+const m = (e, n) => {
+  const t = `{/:locale}${e}`;
+  return n ? t : e.replace(/\/\[\[\.\.\.([^\]]+)\]\]/g, "{/*$1}").replace(/\/\[\.\.\.([^\]]+)\]/g, "/*$1").replace(/\[([^\]]+)\]/g, ":$1");
+}, a = (e, n) => {
+  const t = Object.values(e).map(
+    (r) => g(m(r, n))
+  );
+  return (r) => t.some((c) => c(r) !== !1);
+}, w = (e, n, t) => {
+  const r = {
+    ...n.unauthenticated.routes,
+    ...n.open.routes
+  };
+  return !a(r, t)(e);
+}, R = (e, n, t) => a(
+  n.unauthenticated.routes,
+  t
+)(e), x = (e, n, t) => a(
+  n.open.routes,
+  t
+)(e), A = (e, n) => n[e]?.landing || n.default.landing, L = (e, n) => e.filter(
+  (t) => n.includes(t)
+), O = (e, n) => L(e, n).length > 0;
+function $(e) {
+  return function(t, r) {
+    const c = t.nextUrl.pathname, { rbac: u, authorizedRoles: d, withLocaleRoutePrefix: l } = e;
+    if (x(c, u, l))
+      return r ?? i.next();
+    const o = p(t.cookies), s = o !== null && o.length > 0, h = o === null || !s ? !1 : O(o, d);
+    return (!s || !h) && w(c, u, l) ? i.redirect(
+      new URL(u.default.login, t.url),
+      307
+    ) : s && R(c, u, l) ? o === null || o.length === 0 || o[0] === void 0 ? i.redirect(
+      new URL(u.default.login, t.url),
+      307
+    ) : i.redirect(
+      new URL(A(o[0], u), t.url),
+      307
+    ) : r ?? i.next();
+  };
+}
+export {
+  y as useSignIn,
+  S as useSignOut,
+  $ as withAuth
+};

package/dist/next/proxy.d.ts

@@ -0,0 +1,3 @@
+import { NextRequest, NextResponse } from 'next/server.js';
+import { AuthOptions } from '../types/options';
+export default function withAuth<ValidRoute extends string, AuthorizedRole extends string>(options: AuthOptions<ValidRoute, AuthorizedRole[]>): (request: NextRequest, response?: NextResponse) => NextResponse<unknown>;

package/dist/types/auth.d.ts

@@ -0,0 +1,9 @@
+export type Auth = {
+    token: string;
+    expiresAt: number;
+    user: {
+        id: string;
+        email: string;
+        name: string;
+    };
+};

package/dist/types/options.d.ts

@@ -0,0 +1,6 @@
+import { RbacRoutes } from './rbac.ts';
+export type AuthOptions<ValidRoute, AuthorizedRoles extends string[] = []> = {
+    rbac: RbacRoutes<ValidRoute, AuthorizedRoles>;
+    authorizedRoles: AuthorizedRoles;
+    withLocaleRoutePrefix: boolean;
+};

package/dist/types/rbac.d.ts

@@ -0,0 +1,17 @@
+export type RbacRoutes<ValidRoute, AuthorizedRoles extends string[] = []> = {
+    default: {
+        login: ValidRoute;
+        landing: ValidRoute;
+    };
+    open: {
+        routes: ValidRoute[];
+    };
+    unauthenticated: {
+        routes: ValidRoute[];
+    };
+} & {
+    [key in AuthorizedRoles[number]]: {
+        routes: ValidRoute[];
+        landing?: ValidRoute;
+    };
+};

package/dist/types/role.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/utilities/cookies.d.ts

@@ -0,0 +1,9 @@
+import { RequestCookies } from 'next/dist/server/web/spec-extension/cookies.js';
+/**
+ * Retrieves the user roles from JWT stored in cookies.
+ *
+ * Note: by reading cookies you will opt out of static rendering for the entire route (group).
+ *
+ * @returns A promise that resolves to the user roles as an array, or null if not found or on error.
+ */
+export declare function getRolesFromCookies<AuthorizedRole>(requestCookies: RequestCookies): AuthorizedRole[] | null;

package/dist/utilities/path.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Converts Next.js dynamic route segments to path-to-regexp format.
+ * - /[id] becomes /:id
+ * - /[...slug] becomes /*slug
+ * - /[[...slug]] becomes {/*slug}
+ */
+export declare const convertNextJsPathToRegexp: (path: string, withLocaleRoutePrefix: boolean) => string;
+/**
+ * Compiles a route path with parameters.
+ * Supports both Next.js dynamic segments and path-to-regexp syntax.
+ *
+ * Examples:
+ * - compileRoutePath('/member/:id', { id: '123' }) => '/member/123'
+ * - compileRoutePath('/member/[id]', { id: '123' }) => '/member/123'
+ * - compileRoutePath('/docs/[...slug]', { slug: ['a', 'b', 'c'] }) => '/docs/a/b/c'
+ * - compileRoutePath('/docs/[[...slug]]', { slug: ['a', 'b'] }) => '/docs/a/b'
+ */
+export declare const compileRoutePath: <ValidRoute>(path: string, params: Record<string, string | string[]> | undefined, withLocaleRoutePrefix: boolean) => ValidRoute;

package/dist/utilities/role.d.ts

@@ -0,0 +1 @@
+export declare const userRolesWithAccess: <Role extends string>(roles: Role[], authorizedRoles: Role[]) => Role[];

package/dist/utilities/route.d.ts

@@ -0,0 +1,10 @@
+import { RbacRoutes } from '../types/rbac.ts';
+/**
+ * Validates a given path against a set of routes.
+ * @returns true if the path matches any of the routes in the provided set.
+ */
+export declare const createMatchers: (routes: string[], withLocaleRoutePrefix: boolean) => (path: string) => boolean;
+export declare const isAuthenticatedRoute: <ValidRoute extends string>(pathname: string, RBACRoutes: RbacRoutes<ValidRoute>, withLocaleRoutePrefix: boolean) => boolean;
+export declare const isUnauthenticatedRoute: <ValidRoute extends string>(pathname: string, RBACRoutes: RbacRoutes<ValidRoute>, withLocaleRoutePrefix: boolean) => boolean;
+export declare const isOpenRoute: <ValidRoute extends string>(pathname: string, RBACRoutes: RbacRoutes<ValidRoute>, withLocaleRoutePrefix: boolean) => boolean;
+export declare const getLandingRouteByRole: <Role extends string, ValidRoute>(role: Role, RBACRoutes: RbacRoutes<ValidRoute>) => ValidRoute;

package/dist/utilities/user.d.ts

@@ -0,0 +1 @@
+export declare const userIsAuthorized: <Role extends string>(userRoles: Role[], authorizedRoles: Role[]) => boolean;

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@freshheads/react-auth",
+  "version": "0.0.1-alpha.1",
+  "type": "module",
+  "scripts": {
+    "build": "tsc -b && vite build",
+    "next:typegen": "next typegen",
+    "lint": "eslint . --ext ts,tsx",
+    "lint:fix": "eslint . --ext ts,tsx --fix"
+  },
+  "module": "./dist/main.js",
+  "exports": "./dist/main.js",
+  "files": [
+    "dist"
+  ],
+  "types": "./dist/main.d.ts",
+  "dependencies": {
+    "js-cookie": "^3.0.5",
+    "jwt-decode": "^4.0.0",
+    "path-to-regexp": "^8.3.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.39.1",
+    "@types/js-cookie": "^3.0.6",
+    "@types/node": "^24.10.12",
+    "@types/react": "^19.2.7",
+    "@types/react-dom": "^19.2.3",
+    "@vitejs/plugin-react-swc": "^4.3.0",
+    "eslint": "^9.39.1",
+    "eslint-config-next": "^16.1.6",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.5",
+    "eslint-plugin-react": "^7.37.5",
+    "eslint-plugin-react-hooks": "^7.0.1",
+    "eslint-plugin-react-refresh": "^0.4.24",
+    "glob": "^13.0.6",
+    "globals": "^16.5.0",
+    "prettier": "^3.8.1",
+    "prettier-plugin-organize-imports": "^4.3.0",
+    "react": "^19.2.4",
+    "typescript": "~5.9.3",
+    "typescript-eslint": "^8.48.0",
+    "vite": "^7.3.1",
+    "vite-plugin-dts": "^4.5.4",
+    "vite-plugin-externalize-deps": "^0.10.0"
+  },
+  "peerDependencies": {
+    "next": "^16.2.1",
+    "react": "^19.2.4",
+    "react-dom": "^19.2.4"
+  }
+}