@gopherium/react-auth 0.1.2 → 0.2.0

package/dist/admin/index.js

@@ -1,6 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 import { z } from 'zod';
 import { UnauthorizedError } from '../api.js';
+import { resolveTransport } from '../transport.js';
 export const usersQueryKey = ['users'];
 const userSchema = z.object({
     id: z.string(),
@@ -36,11 +37,11 @@ async function errorMessage(response, fallback) {
     }
 }
 /**
- * Returns every user account.
+ * Lists the accounts over REST.
  * @param signal - Aborts the in-flight request.
  * @returns The parsed list of users.
  */
-export async function fetchUsers(signal) {
+async function restFetchUsers(signal) {
     const response = await fetch('/api/users', { signal });
     if (response.status === 401) {
         throw new UnauthorizedError('session expired');
@@ -51,11 +52,11 @@ export async function fetchUsers(signal) {
     return z.array(userSchema).parse(await response.json());
 }
 /**
- * Creates a user account and returns it.
+ * Creates an account over REST.
  * @param input - The email, name, and password of the new account.
  * @returns The created user.
  */
-export async function createUser(input) {
+async function restCreateUser(input) {
     const response = await fetch('/api/users', {
         method: 'POST',
         headers: { 'Content-Type': 'application/json' },
@@ -76,11 +77,11 @@ export async function createUser(input) {
     return userSchema.parse(await response.json());
 }
 /**
- * Sets whether a user may log in.
+ * Updates an account's disabled flag over REST.
  * @param id - The identifier of the user to update.
  * @param disabled - Whether the account should be disabled.
  */
-export async function setUserDisabled(id, disabled) {
+async function restSetUserDisabled(id, disabled) {
     const response = await fetch(`/api/users/${id}`, {
         method: 'PATCH',
         headers: { 'Content-Type': 'application/json' },
@@ -93,3 +94,27 @@ export async function setUserDisabled(id, disabled) {
         throw new Error(`updating user failed with status ${response.status}`);
     }
 }
+/**
+ * Returns every user account.
+ * @param signal - Aborts the in-flight request.
+ * @returns The parsed list of users.
+ */
+export async function fetchUsers(signal) {
+    return resolveTransport('fetchUsers', restFetchUsers)(signal);
+}
+/**
+ * Creates a user account and returns it.
+ * @param input - The email, name, and password of the new account.
+ * @returns The created user.
+ */
+export async function createUser(input) {
+    return resolveTransport('createUser', restCreateUser)(input);
+}
+/**
+ * Sets whether a user may log in.
+ * @param id - The identifier of the user to update.
+ * @param disabled - Whether the account should be disabled.
+ */
+export async function setUserDisabled(id, disabled) {
+    await resolveTransport('setUserDisabled', restSetUserDisabled)(id, disabled);
+}

package/dist/api.js

@@ -1,5 +1,6 @@
 // SPDX-License-Identifier: Apache-2.0
 import { z } from 'zod';
+import { resolveTransport } from './transport.js';
 const userSchema = z.object({
     id: z.string(),
     email: z.string(),
@@ -23,11 +24,11 @@ export class UnauthorizedError extends Error {
 export class RateLimitedError extends Error {
 }
 /**
- * Returns the logged-in user, or null when no session is active.
+ * Loads the session over REST.
  * @param signal - Aborts the in-flight request.
  * @returns The current user, or null when unauthenticated.
  */
-export async function fetchSession(signal) {
+async function restFetchSession(signal) {
     const response = await fetch('/api/auth/session', { signal });
     if (response.status === 401) {
         return null;
@@ -38,12 +39,12 @@ export async function fetchSession(signal) {
     return userSchema.parse(await response.json());
 }
 /**
- * Logs in with the given credentials and returns the user.
+ * Logs in over REST.
  * @param email - The account email address.
  * @param password - The account password.
  * @returns The authenticated user.
  */
-export async function login(email, password) {
+async function restLogin(email, password) {
     const response = await fetch('/api/auth/login', {
         method: 'POST',
         headers: { 'Content-Type': 'application/json' },
@@ -61,11 +62,34 @@ export async function login(email, password) {
     return userSchema.parse(await response.json());
 }
 /**
- * Ends the current session.
+ * Ends the session over REST.
  */
-export async function logout() {
+async function restLogout() {
     const response = await fetch('/api/auth/logout', { method: 'POST' });
     if (!response.ok) {
         throw new Error(`logout failed with status ${response.status}`);
     }
 }
+/**
+ * Returns the logged-in user, or null when no session is active.
+ * @param signal - Aborts the in-flight request.
+ * @returns The current user, or null when unauthenticated.
+ */
+export async function fetchSession(signal) {
+    return resolveTransport('fetchSession', restFetchSession)(signal);
+}
+/**
+ * Logs in with the given credentials and returns the user.
+ * @param email - The account email address.
+ * @param password - The account password.
+ * @returns The authenticated user.
+ */
+export async function login(email, password) {
+    return resolveTransport('login', restLogin)(email, password);
+}
+/**
+ * Ends the current session.
+ */
+export async function logout() {
+    await resolveTransport('logout', restLogout)();
+}

package/dist/index.d.ts

@@ -4,3 +4,5 @@ export { AuthGate } from './AuthGate.js';
 export { isSessionRevoked } from './probe.js';
 export { createAuthQueryClient } from './queryClient.js';
 export { sessionQueryKey, useLogout, useSession } from './session.js';
+export { configureAuthTransport, resetAuthTransport } from './transport.js';
+export type { AuthTransport } from './transport.js';

package/dist/index.js

@@ -4,3 +4,4 @@ export { AuthGate } from './AuthGate.js';
 export { isSessionRevoked } from './probe.js';
 export { createAuthQueryClient } from './queryClient.js';
 export { sessionQueryKey, useLogout, useSession } from './session.js';
+export { configureAuthTransport, resetAuthTransport } from './transport.js';

package/dist/probe.js

@@ -1,15 +1,24 @@
 // SPDX-License-Identifier: Apache-2.0
+import { resolveTransport } from './transport.js';
 /**
- * Reports whether the backend considers the session gone, distinguishing
- * a revoked login from a transient outage after a stream failure.
+ * Probes the session over REST.
  * @param signal - Aborts the in-flight request.
- * @returns True when the session is revoked, false when the backend still
- * accepts it.
+ * @returns True when the session is revoked.
  */
-export async function isSessionRevoked(signal) {
+async function restIsSessionRevoked(signal) {
     const response = await fetch('/api/auth/session', {
         credentials: 'include',
         signal,
     });
     return response.status === 401;
 }
+/**
+ * Reports whether the backend considers the session gone, distinguishing
+ * a revoked login from a transient outage after a stream failure.
+ * @param signal - Aborts the in-flight request.
+ * @returns True when the session is revoked, false when the backend still
+ * accepts it.
+ */
+export async function isSessionRevoked(signal) {
+    return resolveTransport('isSessionRevoked', restIsSessionRevoked)(signal);
+}

package/dist/transport.d.ts

@@ -0,0 +1,34 @@
+import type { User as Account, NewUser } from './admin/index.js';
+import type { User } from './api.js';
+/**
+ * AuthTransport carries every backend call of the package, so a consumer
+ * can replace the REST transport with its own while keeping the screens,
+ * hooks, and error contract. Implementations must throw the same error
+ * classes the REST transport throws.
+ */
+export interface AuthTransport {
+    fetchSession(signal?: AbortSignal): Promise<User | null>;
+    login(email: string, password: string): Promise<User>;
+    logout(): Promise<void>;
+    isSessionRevoked(signal?: AbortSignal): Promise<boolean>;
+    fetchUsers(signal?: AbortSignal): Promise<Account[]>;
+    createUser(input: NewUser): Promise<Account>;
+    setUserDisabled(id: string, disabled: boolean): Promise<void>;
+}
+/**
+ * Replaces backend calls with the given implementations, keeping the REST
+ * transport for every operation not named.
+ * @param transport - The operations to override.
+ */
+export declare function configureAuthTransport(transport: Partial<AuthTransport>): void;
+/**
+ * Restores the REST transport for every operation.
+ */
+export declare function resetAuthTransport(): void;
+/**
+ * Returns the configured implementation of one operation, or the fallback.
+ * @param name - The operation to resolve.
+ * @param fallback - The REST implementation used when not overridden.
+ * @returns The active implementation.
+ */
+export declare function resolveTransport<K extends keyof AuthTransport>(name: K, fallback: AuthTransport[K]): AuthTransport[K];

package/dist/transport.js

@@ -0,0 +1,25 @@
+// SPDX-License-Identifier: Apache-2.0
+let overrides = {};
+/**
+ * Replaces backend calls with the given implementations, keeping the REST
+ * transport for every operation not named.
+ * @param transport - The operations to override.
+ */
+export function configureAuthTransport(transport) {
+    overrides = { ...overrides, ...transport };
+}
+/**
+ * Restores the REST transport for every operation.
+ */
+export function resetAuthTransport() {
+    overrides = {};
+}
+/**
+ * Returns the configured implementation of one operation, or the fallback.
+ * @param name - The operation to resolve.
+ * @param fallback - The REST implementation used when not overridden.
+ * @returns The active implementation.
+ */
+export function resolveTransport(name, fallback) {
+    return overrides[name] ?? fallback;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gopherium/react-auth",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "description": "Session authentication for React apps backed by gouncer's authkit.",
   "license": "Apache-2.0",
   "type": "module",
@@ -85,6 +85,7 @@
     "@wordpress/ui": "0.19.0",
     "eslint": "^9.39.1",
     "eslint-plugin-jsdoc": "^63.0.13",
+    "eslint-plugin-sonarjs": "^4.2.0",
     "eslint-plugin-tsdoc": "^0.4.0",
     "jsdom": "^29.1.1",
     "msw": "^2.15.0",