@gopherium/react-auth 0.4.0 → 0.6.0

package/dist/admin/index.d.ts

@@ -5,6 +5,7 @@ declare const userSchema: z.ZodObject<{
     email: z.ZodString;
     name: z.ZodString;
     disabled: z.ZodBoolean;
+    role: z.ZodDefault<z.ZodString>;
     created_at: z.ZodCoercedDate<unknown>;
 }, z.core.$strip>;
 export type User = z.infer<typeof userSchema>;
@@ -12,6 +13,7 @@ export interface NewUser {
     email: string;
     name: string;
     password: string;
+    role?: string;
 }
 /**
  * EmailTakenError is thrown when a new user's email is already in use.
@@ -24,6 +26,22 @@ export declare class EmailTakenError extends Error {
  */
 export declare class ValidationError extends Error {
 }
+/**
+ * RoleRefusedError is thrown when the actor holds no role the server admits.
+ */
+export declare class RoleRefusedError extends Error {
+}
+/**
+ * SelfRoleError is thrown when an account changes its own role.
+ */
+export declare class SelfRoleError extends Error {
+}
+/**
+ * LastPrivilegedError is thrown when a write would leave no enabled
+ * account holding a privileged role.
+ */
+export declare class LastPrivilegedError extends Error {
+}
 /**
  * Returns every user account.
  * @param signal - Aborts the in-flight request.
@@ -42,4 +60,10 @@ export declare function createUser(input: NewUser): Promise<User>;
  * @param disabled - Whether the account should be disabled.
  */
 export declare function setUserDisabled(id: string, disabled: boolean): Promise<void>;
+/**
+ * Sets the role an account holds.
+ * @param id - The identifier of the account to update.
+ * @param role - The role the account is to hold.
+ */
+export declare function setUserRole(id: string, role: string): Promise<void>;
 export {};

package/dist/admin/index.js

@@ -10,6 +10,7 @@ const userSchema = z.object({
     email: z.string(),
     name: z.string(),
     disabled: z.boolean(),
+    role: z.string().default(''),
     created_at: z.coerce.date(),
 });
 /**
@@ -23,7 +24,23 @@ export class EmailTakenError extends Error {
  */
 export class ValidationError extends Error {
 }
-const errorSchema = z.object({ error: z.string() });
+/**
+ * RoleRefusedError is thrown when the actor holds no role the server admits.
+ */
+export class RoleRefusedError extends Error {
+}
+/**
+ * SelfRoleError is thrown when an account changes its own role.
+ */
+export class SelfRoleError extends Error {
+}
+/**
+ * LastPrivilegedError is thrown when a write would leave no enabled
+ * account holding a privileged role.
+ */
+export class LastPrivilegedError extends Error {
+}
+const errorSchema = z.object({ error: z.string(), code: z.string().optional() });
 /**
  * Extracts the backend's explanation from a failed response body.
  * @param response - The failed HTTP response.
@@ -96,6 +113,49 @@ async function restSetUserDisabled(id, disabled) {
         throw new Error(`updating user failed with status ${response.status}`);
     }
 }
+/**
+ * Writes the role an account holds over REST.
+ * @param id - The identifier of the account to update.
+ * @param role - The role the account is to hold.
+ */
+async function restSetUserRole(id, role) {
+    const response = await fetch(`/api/users/${id}/role`, {
+        method: 'PUT',
+        headers: { 'Content-Type': 'application/json' },
+        body: JSON.stringify({ role }),
+    });
+    if (response.ok) {
+        return;
+    }
+    if (response.status === 401) {
+        throw new UnauthorizedError('session expired');
+    }
+    const refusal = await refusalOf(response);
+    if (refusal.code === 'role_insufficient') {
+        throw new RoleRefusedError(refusal.message);
+    }
+    if (refusal.code === 'self_role_refused') {
+        throw new SelfRoleError(refusal.message);
+    }
+    if (refusal.code === 'last_privileged_refused') {
+        throw new LastPrivilegedError(refusal.message);
+    }
+    throw new Error(`updating role failed with status ${response.status}`);
+}
+/**
+ * Returns the code and message a refused response carries.
+ * @param response - The refused HTTP response.
+ * @returns The refusal code, if any, and its message.
+ */
+async function refusalOf(response) {
+    try {
+        const held = errorSchema.parse(await response.json());
+        return { code: held.code, message: held.error };
+    }
+    catch {
+        return { message: __('the account could not be updated', DOMAIN) };
+    }
+}
 /**
  * Returns every user account.
  * @param signal - Aborts the in-flight request.
@@ -120,3 +180,11 @@ export async function createUser(input) {
 export async function setUserDisabled(id, disabled) {
     await resolveTransport('setUserDisabled', restSetUserDisabled)(id, disabled);
 }
+/**
+ * Sets the role an account holds.
+ * @param id - The identifier of the account to update.
+ * @param role - The role the account is to hold.
+ */
+export async function setUserRole(id, role) {
+    await resolveTransport('setUserRole', restSetUserRole)(id, role);
+}

package/dist/api.d.ts

@@ -3,6 +3,7 @@ declare const userSchema: z.ZodObject<{
     id: z.ZodString;
     email: z.ZodString;
     name: z.ZodString;
+    role: z.ZodDefault<z.ZodString>;
 }, z.core.$strip>;
 export type User = z.infer<typeof userSchema>;
 /**

package/dist/api.js

@@ -5,6 +5,7 @@ const userSchema = z.object({
     id: z.string(),
     email: z.string(),
     name: z.string(),
+    role: z.string().default(''),
 });
 /**
  * InvalidCredentialsError is thrown when the backend rejects a login.

package/dist/languages/es-ES.json

@@ -1 +1 @@
-{ "": { "lang": "es-ES", "plural-forms": "nplurals=2; plural=(n != 1);" }, "Actions": ["Acciones"], "Active": ["Activo"], "Create user": ["Crear usuario"], "Disable": ["Desactivar"], "Disable %s": ["Desactivar a %s"], "Disabled": ["Desactivado"], "Enable": ["Activar"], "Enable %s": ["Activar a %s"], "Invalid email or password.": ["Correo o contraseña no válidos."], "Loading users…": ["Cargando usuarios…"], "Loading…": ["Cargando…"], "Log in": ["Iniciar sesión"], "Log out": ["Cerrar sesión"], "Login failed, please try again.": ["No se pudo iniciar sesión, inténtalo de nuevo."], "Logout failed, please try again.": ["No se pudo cerrar sesión, inténtalo de nuevo."], "Password": ["Contraseña"], "Something went wrong.": ["Algo ha ido mal."], "That email is already in use.": ["Ese correo ya está en uso."], "The user could not be created.": ["No se pudo crear el usuario."], "Too many attempts. Please wait a minute and try again.": ["Demasiados intentos. Espera un minuto e inténtalo de nuevo."], "Update failed.": ["No se pudo actualizar."], "Users could not be loaded.": ["No se pudieron cargar los usuarios."], "admin section\u0004Users": ["Usuarios"], "button\u0004New user": ["Nuevo usuario"], "column\u0004Email": ["Correo"], "column\u0004Name": ["Nombre"], "column\u0004Status": ["Estado"], "field label\u0004Email": ["Correo"], "field label\u0004Name": ["Nombre"], "invalid user details": ["datos de usuario no válidos"], "page heading\u0004New user": ["Nuevo usuario"], "page heading\u0004Users": ["Usuarios"] }
+{ "": { "lang": "es-ES", "plural-forms": "nplurals=2; plural=(n != 1);" }, "Actions": ["Acciones"], "Active": ["Activo"], "Create user": ["Crear usuario"], "Disable": ["Desactivar"], "Disable %s": ["Desactivar a %s"], "Disabled": ["Desactivado"], "Enable": ["Activar"], "Enable %s": ["Activar a %s"], "Invalid email or password.": ["Correo o contraseña no válidos."], "Loading users…": ["Cargando usuarios…"], "Loading…": ["Cargando…"], "Log in": ["Iniciar sesión"], "Log out": ["Cerrar sesión"], "Login failed, please try again.": ["No se pudo iniciar sesión, inténtalo de nuevo."], "Logout failed, please try again.": ["No se pudo cerrar sesión, inténtalo de nuevo."], "Password": ["Contraseña"], "Something went wrong.": ["Algo ha ido mal."], "That email is already in use.": ["Ese correo ya está en uso."], "The user could not be created.": ["No se pudo crear el usuario."], "Too many attempts. Please wait a minute and try again.": ["Demasiados intentos. Espera un minuto e inténtalo de nuevo."], "Update failed.": ["No se pudo actualizar."], "Users could not be loaded.": ["No se pudieron cargar los usuarios."], "admin section\u0004Users": ["Usuarios"], "button\u0004New user": ["Nuevo usuario"], "column\u0004Email": ["Correo"], "column\u0004Name": ["Nombre"], "column\u0004Status": ["Estado"], "field label\u0004Email": ["Correo"], "field label\u0004Name": ["Nombre"], "invalid user details": ["datos de usuario no válidos"], "page heading\u0004New user": ["Nuevo usuario"], "page heading\u0004Users": ["Usuarios"], "the account could not be updated": ["no se ha podido actualizar la cuenta"] }

package/dist/languages/languages/es-ES.json

@@ -1 +1 @@
-{"":{"lang":"es-ES","plural-forms":"nplurals=2; plural=(n != 1);"},"Actions":["Acciones"],"Active":["Activo"],"Create user":["Crear usuario"],"Disable":["Desactivar"],"Disable %s":["Desactivar a %s"],"Disabled":["Desactivado"],"Enable":["Activar"],"Enable %s":["Activar a %s"],"Invalid email or password.":["Correo o contraseña no válidos."],"Loading users…":["Cargando usuarios…"],"Loading…":["Cargando…"],"Log in":["Iniciar sesión"],"Log out":["Cerrar sesión"],"Login failed, please try again.":["No se pudo iniciar sesión, inténtalo de nuevo."],"Logout failed, please try again.":["No se pudo cerrar sesión, inténtalo de nuevo."],"Password":["Contraseña"],"Something went wrong.":["Algo ha ido mal."],"That email is already in use.":["Ese correo ya está en uso."],"The user could not be created.":["No se pudo crear el usuario."],"Too many attempts. Please wait a minute and try again.":["Demasiados intentos. Espera un minuto e inténtalo de nuevo."],"Update failed.":["No se pudo actualizar."],"Users could not be loaded.":["No se pudieron cargar los usuarios."],"admin section\u0004Users":["Usuarios"],"button\u0004New user":["Nuevo usuario"],"column\u0004Email":["Correo"],"column\u0004Name":["Nombre"],"column\u0004Status":["Estado"],"field label\u0004Email":["Correo"],"field label\u0004Name":["Nombre"],"invalid user details":["datos de usuario no válidos"],"page heading\u0004New user":["Nuevo usuario"],"page heading\u0004Users":["Usuarios"]}
+{"":{"lang":"es-ES","plural-forms":"nplurals=2; plural=(n != 1);"},"Actions":["Acciones"],"Active":["Activo"],"Create user":["Crear usuario"],"Disable":["Desactivar"],"Disable %s":["Desactivar a %s"],"Disabled":["Desactivado"],"Enable":["Activar"],"Enable %s":["Activar a %s"],"Invalid email or password.":["Correo o contraseña no válidos."],"Loading users…":["Cargando usuarios…"],"Loading…":["Cargando…"],"Log in":["Iniciar sesión"],"Log out":["Cerrar sesión"],"Login failed, please try again.":["No se pudo iniciar sesión, inténtalo de nuevo."],"Logout failed, please try again.":["No se pudo cerrar sesión, inténtalo de nuevo."],"Password":["Contraseña"],"Something went wrong.":["Algo ha ido mal."],"That email is already in use.":["Ese correo ya está en uso."],"The user could not be created.":["No se pudo crear el usuario."],"Too many attempts. Please wait a minute and try again.":["Demasiados intentos. Espera un minuto e inténtalo de nuevo."],"Update failed.":["No se pudo actualizar."],"Users could not be loaded.":["No se pudieron cargar los usuarios."],"admin section\u0004Users":["Usuarios"],"button\u0004New user":["Nuevo usuario"],"column\u0004Email":["Correo"],"column\u0004Name":["Nombre"],"column\u0004Status":["Estado"],"field label\u0004Email":["Correo"],"field label\u0004Name":["Nombre"],"invalid user details":["datos de usuario no válidos"],"page heading\u0004New user":["Nuevo usuario"],"page heading\u0004Users":["Usuarios"],"the account could not be updated":["no se ha podido actualizar la cuenta"]}

package/dist/session.d.ts

@@ -10,6 +10,7 @@ export declare function useSession(): import("@tanstack/react-query").UseQueryRe
     id: string;
     email: string;
     name: string;
+    role: string;
 } | null>, Error>;
 /**
  * Ends the current session and drops all cached data belonging to the

package/dist/testing/index.d.ts

@@ -11,6 +11,17 @@ export declare function installTestEnvironment(): void;
  * defaultUser is the canned account tests sign in as.
  */
 export declare const defaultUser: User;
+/**
+ * Returns a canned account holding the given role, one identifier per role.
+ * @param role - The role the account holds.
+ * @returns The account.
+ */
+export declare function userWithRole(role: string): User;
+/**
+ * Accepts a role change.
+ * @returns The msw handler.
+ */
+export declare function roleOk(): import("msw").HttpHandler;
 /**
  * Seeds the cached session so components render signed in without a fetch.
  * @param client - The query client under test.

package/dist/testing/index.js

@@ -25,7 +25,34 @@ export const defaultUser = {
     id: '0198b2f0-0000-7000-8000-000000000001',
     email: 'grace@example.com',
     name: 'Grace Hopper',
+    role: '',
 };
+/**
+ * Returns a canned account holding the given role, one identifier per role.
+ * @param role - The role the account holds.
+ * @returns The account.
+ */
+export function userWithRole(role) {
+    let held = 2166136261;
+    for (const letter of role) {
+        held ^= letter.charCodeAt(0);
+        held = Math.imul(held, 16777619);
+    }
+    held >>>= 0;
+    return {
+        id: `0198b2f0-0000-7000-8000-${String(held).padStart(12, '0')}`,
+        email: `${role}@example.com`,
+        name: `Maria Perez the ${role}`,
+        role,
+    };
+}
+/**
+ * Accepts a role change.
+ * @returns The msw handler.
+ */
+export function roleOk() {
+    return http.put('/api/users/:id/role', () => new HttpResponse(null, { status: 204 }));
+}
 /**
  * Seeds the cached session so components render signed in without a fetch.
  * @param client - The query client under test.

package/dist/transport.d.ts

@@ -14,6 +14,7 @@ export interface AuthTransport {
     fetchUsers(signal?: AbortSignal): Promise<Account[]>;
     createUser(input: NewUser): Promise<Account>;
     setUserDisabled(id: string, disabled: boolean): Promise<void>;
+    setUserRole(id: string, role: string): Promise<void>;
 }
 /**
  * Replaces backend calls with the given implementations, keeping the REST

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gopherium/react-auth",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "Session authentication for React apps backed by gouncer's authkit.",
   "license": "Apache-2.0",
   "type": "module",