@gopherium/react-auth 0.5.0 → 0.7.0

package/dist/admin/index.d.ts

@@ -5,7 +5,7 @@ declare const userSchema: z.ZodObject<{
     email: z.ZodString;
     name: z.ZodString;
     disabled: z.ZodBoolean;
-    rank: z.ZodDefault<z.ZodString>;
+    role: z.ZodDefault<z.ZodString>;
     created_at: z.ZodCoercedDate<unknown>;
 }, z.core.$strip>;
 export type User = z.infer<typeof userSchema>;
@@ -13,7 +13,7 @@ export interface NewUser {
     email: string;
     name: string;
     password: string;
-    rank?: string;
+    role?: string;
 }
 /**
  * EmailTakenError is thrown when a new user's email is already in use.
@@ -27,18 +27,18 @@ export declare class EmailTakenError extends Error {
 export declare class ValidationError extends Error {
 }
 /**
- * RankRefusedError is thrown when the actor holds no rank the server admits.
+ * RoleRefusedError is thrown when the actor holds no role the server admits.
  */
-export declare class RankRefusedError extends Error {
+export declare class RoleRefusedError extends Error {
 }
 /**
- * SelfRankError is thrown when an account changes its own rank.
+ * SelfRoleError is thrown when an account changes its own role.
  */
-export declare class SelfRankError extends Error {
+export declare class SelfRoleError extends Error {
 }
 /**
  * LastPrivilegedError is thrown when a write would leave no enabled
- * account holding a privileged rank.
+ * account holding a privileged role.
  */
 export declare class LastPrivilegedError extends Error {
 }
@@ -61,9 +61,9 @@ export declare function createUser(input: NewUser): Promise<User>;
  */
 export declare function setUserDisabled(id: string, disabled: boolean): Promise<void>;
 /**
- * Sets the rank an account holds.
+ * Sets the role an account holds.
  * @param id - The identifier of the account to update.
- * @param rank - The rank the account is to hold.
+ * @param role - The role the account is to hold.
  */
-export declare function setUserRank(id: string, rank: string): Promise<void>;
+export declare function setUserRole(id: string, role: string): Promise<void>;
 export {};

package/dist/admin/index.js

@@ -10,7 +10,7 @@ const userSchema = z.object({
     email: z.string(),
     name: z.string(),
     disabled: z.boolean(),
-    rank: z.string().default(''),
+    role: z.string().default(''),
     created_at: z.coerce.date(),
 });
 /**
@@ -25,18 +25,18 @@ export class EmailTakenError extends Error {
 export class ValidationError extends Error {
 }
 /**
- * RankRefusedError is thrown when the actor holds no rank the server admits.
+ * RoleRefusedError is thrown when the actor holds no role the server admits.
  */
-export class RankRefusedError extends Error {
+export class RoleRefusedError extends Error {
 }
 /**
- * SelfRankError is thrown when an account changes its own rank.
+ * SelfRoleError is thrown when an account changes its own role.
  */
-export class SelfRankError extends Error {
+export class SelfRoleError extends Error {
 }
 /**
  * LastPrivilegedError is thrown when a write would leave no enabled
- * account holding a privileged rank.
+ * account holding a privileged role.
  */
 export class LastPrivilegedError extends Error {
 }
@@ -114,15 +114,15 @@ async function restSetUserDisabled(id, disabled) {
     }
 }
 /**
- * Writes the rank an account holds over REST.
+ * Writes the role an account holds over REST.
  * @param id - The identifier of the account to update.
- * @param rank - The rank the account is to hold.
+ * @param role - The role the account is to hold.
  */
-async function restSetUserRank(id, rank) {
-    const response = await fetch(`/api/users/${id}/rank`, {
+async function restSetUserRole(id, role) {
+    const response = await fetch(`/api/users/${id}/role`, {
         method: 'PUT',
         headers: { 'Content-Type': 'application/json' },
-        body: JSON.stringify({ rank }),
+        body: JSON.stringify({ role }),
     });
     if (response.ok) {
         return;
@@ -130,24 +130,24 @@ async function restSetUserRank(id, rank) {
     if (response.status === 401) {
         throw new UnauthorizedError('session expired');
     }
-    const refusal = await refusalOf(response);
-    if (refusal.code === 'rank_insufficient') {
-        throw new RankRefusedError(refusal.message);
+    const failed = await errorOf(response);
+    if (failed.code === 'role_insufficient') {
+        throw new RoleRefusedError(failed.message);
     }
-    if (refusal.code === 'self_rank_refused') {
-        throw new SelfRankError(refusal.message);
+    if (failed.code === 'self_role_refused') {
+        throw new SelfRoleError(failed.message);
     }
-    if (refusal.code === 'last_privileged_refused') {
-        throw new LastPrivilegedError(refusal.message);
+    if (failed.code === 'last_privileged_refused') {
+        throw new LastPrivilegedError(failed.message);
     }
-    throw new Error(`updating rank failed with status ${response.status}`);
+    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.
+ * @returns The error code, if any, and its message.
  */
-async function refusalOf(response) {
+async function errorOf(response) {
     try {
         const held = errorSchema.parse(await response.json());
         return { code: held.code, message: held.error };
@@ -181,10 +181,10 @@ export async function setUserDisabled(id, disabled) {
     await resolveTransport('setUserDisabled', restSetUserDisabled)(id, disabled);
 }
 /**
- * Sets the rank an account holds.
+ * Sets the role an account holds.
  * @param id - The identifier of the account to update.
- * @param rank - The rank the account is to hold.
+ * @param role - The role the account is to hold.
  */
-export async function setUserRank(id, rank) {
-    await resolveTransport('setUserRank', restSetUserRank)(id, rank);
+export async function setUserRole(id, role) {
+    await resolveTransport('setUserRole', restSetUserRole)(id, role);
 }

package/dist/api.d.ts

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

package/dist/api.js

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

package/dist/session.d.ts

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

package/dist/testing/index.d.ts

@@ -12,16 +12,16 @@ export declare function installTestEnvironment(): void;
  */
 export declare const defaultUser: User;
 /**
- * Returns a canned account holding the given rank, one identifier per rank.
- * @param rank - The rank the account holds.
+ * 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 rankedUser(rank: string): User;
+export declare function userWithRole(role: string): User;
 /**
- * Accepts a rank change.
+ * Accepts a role change.
  * @returns The msw handler.
  */
-export declare function rankOk(): import("msw").HttpHandler;
+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,33 +25,33 @@ export const defaultUser = {
     id: '0198b2f0-0000-7000-8000-000000000001',
     email: 'grace@example.com',
     name: 'Grace Hopper',
-    rank: '',
+    role: '',
 };
 /**
- * Returns a canned account holding the given rank, one identifier per rank.
- * @param rank - The rank the account holds.
+ * Returns a canned account holding the given role, one identifier per role.
+ * @param role - The role the account holds.
  * @returns The account.
  */
-export function rankedUser(rank) {
+export function userWithRole(role) {
     let held = 2166136261;
-    for (const letter of rank) {
+    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: `${rank}@example.com`,
-        name: `Maria Perez the ${rank}`,
-        rank,
+        email: `${role}@example.com`,
+        name: `Maria Perez the ${role}`,
+        role,
     };
 }
 /**
- * Accepts a rank change.
+ * Accepts a role change.
  * @returns The msw handler.
  */
-export function rankOk() {
-    return http.put('/api/users/:id/rank', () => new HttpResponse(null, { status: 204 }));
+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.

package/dist/transport.d.ts

@@ -14,7 +14,7 @@ export interface AuthTransport {
     fetchUsers(signal?: AbortSignal): Promise<Account[]>;
     createUser(input: NewUser): Promise<Account>;
     setUserDisabled(id: string, disabled: boolean): Promise<void>;
-    setUserRank(id: string, rank: string): 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.5.0",
+  "version": "0.7.0",
   "description": "Session authentication for React apps backed by gouncer's authkit.",
   "license": "Apache-2.0",
   "type": "module",
@@ -48,7 +48,7 @@
   },
   "peerDependencies": {
     "@tanstack/react-query": "^5.101.2",
-    "@testing-library/jest-dom": "^6.9.1",
+    "@testing-library/jest-dom": "^6.9.1 || ^7.0.0",
     "@testing-library/react": "^16.3.2",
     "@wordpress/i18n": ">=6.26.0 <7.0.0",
     "@wordpress/theme": ">=1.0.0 <2.0.0",
@@ -79,7 +79,7 @@
   },
   "devDependencies": {
     "@tanstack/react-query": "^5.101.2",
-    "@testing-library/jest-dom": "^6.9.1",
+    "@testing-library/jest-dom": "^7.0.0",
     "@testing-library/react": "^16.3.2",
     "@testing-library/user-event": "^14.6.1",
     "@types/gettext-parser": "9.0.0",