@axium/client 0.34.0 → 0.35.0

package/dist/cli/cache.d.ts

@@ -34,8 +34,8 @@ export declare const meta: Handle<z.ZodObject<{
         user: z.ZodObject<{
             id: z.ZodUUID;
             name: z.ZodString;
-            username: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-            email: z.ZodEmail;
+            username: z.ZodString;
+            email: z.ZodOptional<z.ZodNullable<z.ZodEmail>>;
             emailVerified: z.ZodOptional<z.ZodNullable<z.ZodCoercedDate<unknown>>>;
             preferences: z.ZodLazy<z.ZodObject<{
                 debug: z.ZodDefault<z.ZodBoolean>;

package/dist/cli/config.d.ts

@@ -10,7 +10,7 @@ export declare function session(): {
     user: {
         id: string;
         name: string;
-        email: string;
+        username: string;
         preferences: {
             debug: boolean;
         };
@@ -19,7 +19,7 @@ export declare function session(): {
         registeredAt: Date;
         isAdmin: boolean;
         isSuspended: boolean;
-        username?: string | null | undefined;
+        email?: string | null | undefined;
         emailVerified?: Date | null | undefined;
     };
     name?: string | null | undefined;

package/dist/locales.d.ts

@@ -29,7 +29,6 @@ declare let currentLoaded: {
         readonly no_results: "No results";
     };
     readonly Login: {
-        readonly email: "Email";
         readonly register: "Register instead";
     };
     readonly Logout: {
@@ -37,9 +36,7 @@ declare let currentLoaded: {
         readonly question: "Are you sure you want to log out?";
     };
     readonly Register: {
-        readonly email: "Email";
         readonly login: "Login instead";
-        readonly name: "Display Name";
     };
     readonly SessionList: {
         readonly created: "Created {date}";
@@ -84,6 +81,8 @@ declare let currentLoaded: {
         readonly none: "None";
         readonly ok: "Okay";
         readonly preferences: "Preferences";
+        readonly recovery: "Recovery";
+        readonly recovery_method_disabled: "This recovery method is disabled and can't be used.";
         readonly register: "Register";
         readonly rename: "Rename";
         readonly sessions: "Sessions";
@@ -91,7 +90,7 @@ declare let currentLoaded: {
         readonly success: "Success";
         readonly unknown: "Unknown";
         readonly unnamed: "Unnamed";
-        readonly user_display_name: "Name";
+        readonly user_display_name: "Display name";
         readonly username: "Username";
         readonly yes: "Yes";
     };
@@ -127,6 +126,8 @@ declare let currentLoaded: {
                 readonly toast_updated: "Profile picture updated";
             };
             readonly preferences: "Preferences";
+            readonly remove_email: "Remove email";
+            readonly remove_email_confirm: "Are you sure you want to remove your recovery email?";
             readonly sessions: "Sessions";
             readonly title: "Your Account";
             readonly toast_username_updated: "Username updated";

package/dist/user.d.ts

@@ -1,4 +1,4 @@
-import type { NewSessionResponse, Passkey, PasskeyChangeable, Session, User, UserChangeable, UserPublic, Verification } from '@axium/core';
+import type { AuthInfo, NewSessionResponse, Passkey, PasskeyChangeable, Session, User, UserChangeable, UserPublic, Verification } from '@axium/core';
 import * as z from 'zod';
 import Cache from './cache.js';
 export declare function login(userId: string): Promise<NewSessionResponse>;
@@ -6,7 +6,7 @@ export declare function login(userId: string): Promise<NewSessionResponse>;
  * Create an elevated session for the user to perform sensitive actions.
  */
 export declare function elevate(userId: string): Promise<void>;
-export declare function loginByEmail(email: string): Promise<NewSessionResponse>;
+export declare function loginByUsername(username: string): Promise<NewSessionResponse>;
 export declare function getCurrentSession(): Promise<Session & {
     user: User;
 }>;
@@ -27,7 +27,10 @@ export declare function fullUserInfo(userId: string): Promise<User & {
  * @param deletingId The UUID of the user performing the deletion (for authentication). Defaults to userId.
  */
 export declare function deleteUser(userId: string, deletingId?: string): Promise<User>;
-export declare function emailVerificationEnabled(userId: string): Promise<boolean>;
+/**
+ * Get which authentication-related features are available, e.g. account recovery methods.
+ */
+export declare function getAuthInfo(userId: string): Promise<AuthInfo>;
 export declare function sendVerificationEmail(userId: string): Promise<Verification>;
 export declare function verifyEmail(userId: string, token: string): Promise<void>;
 export declare function getPasskeys(userId: string): Promise<Passkey[]>;

package/dist/user.js

@@ -1,7 +1,8 @@
+import { UserRegistrationInit } from '@axium/core/user';
 import { startAuthentication, startRegistration } from '@simplewebauthn/browser';
 import * as z from 'zod';
-import { fetchAPI } from './requests.js';
 import Cache from './cache.js';
+import { fetchAPI } from './requests.js';
 export async function login(userId) {
     const options = await fetchAPI('PUT', 'users/:id/auth', { type: 'login' }, userId);
     const response = await startAuthentication({ optionsJSON: options });
@@ -15,11 +16,8 @@ export async function elevate(userId) {
     const response = await startAuthentication({ optionsJSON: options });
     await fetchAPI('POST', 'users/:id/auth', response, userId);
 }
-export async function loginByEmail(email) {
-    const { id: userId } = await fetchAPI('POST', 'user_id', {
-        using: 'email',
-        value: email,
-    });
+export async function loginByUsername(username) {
+    const { id: userId } = await fetchAPI('POST', 'user_id', { using: 'username', value: username });
     return await login(userId);
 }
 let _currentSession = null;
@@ -44,15 +42,10 @@ export async function logoutCurrentSession() {
     return await fetchAPI('DELETE', 'session');
 }
 export async function register(_data) {
-    const data = z.object({ name: z.string(), email: z.email() }).parse(_data);
+    const data = UserRegistrationInit.parse(_data);
     const { options, userId } = await fetchAPI('PUT', 'register', data);
     const response = await startRegistration({ optionsJSON: options });
-    await fetchAPI('POST', 'register', {
-        userId,
-        name: data.name,
-        email: data.email,
-        response,
-    });
+    await fetchAPI('POST', 'register', { userId, response, ...data });
 }
 function _checkId(userId) {
     try {
@@ -91,10 +84,12 @@ export async function deleteUser(userId, deletingId = userId) {
     userCache.invalidate(userId);
     return result;
 }
-export async function emailVerificationEnabled(userId) {
+/**
+ * Get which authentication-related features are available, e.g. account recovery methods.
+ */
+export async function getAuthInfo(userId) {
     _checkId(userId);
-    const { enabled } = await fetchAPI('OPTIONS', 'users/:id/verify/email', {}, userId);
-    return enabled;
+    return await fetchAPI('OPTIONS', 'users/:id/auth', {}, userId);
 }
 export async function sendVerificationEmail(userId) {
     _checkId(userId);

package/lib/InlineEdit.svelte

@@ -16,7 +16,7 @@
 		/** The committed value being edited. */
 		value?: string | null;
 		/** Called with the new value when a change is confirmed. `null` means the value was cleared (only possible when `optional`). */
-		commit(value: string | null): unknown;
+		commit(value: string): unknown;
 		/** Called when editing ends, whether or not a change was committed. */
 		close(): void;
 		/** Validates the draft as the user types and before committing. Errors float above the input. */
@@ -42,7 +42,7 @@
 		const newValue = draft.trim() || null;
 		if (newValue === (value ?? null) || (newValue === null && !optional)) return close();
 		if (!validate(newValue)) return;
-		commit(newValue);
+		commit(newValue!);
 		close();
 	}
 </script>

package/lib/Login.svelte

@@ -1,16 +1,16 @@
 <script lang="ts">
-	import { loginByEmail, text } from '@axium/client';
+	import { loginByUsername, text } from '@axium/client';
 	import FormDialog from './FormDialog.svelte';
 	import authRedirect from './auth_redirect.js';
 
 	let { dialog = $bindable(), fullPage = false }: { dialog?: HTMLDialogElement; fullPage?: boolean } = $props();
 
-	async function submit(data: { email: string }) {
-		if (typeof data.email != 'string') {
-			throw 'Tried to upload a file for an email. Huh?!';
+	async function submit(data: { username: string }) {
+		if (typeof data.username != 'string') {
+			throw 'Tried to upload a file for a username. Huh?!';
 		}
 
-		await loginByEmail(data.email);
+		await loginByUsername(data.username);
 		const redirectAfter = await authRedirect();
 		if (fullPage && redirectAfter) location.href = redirectAfter;
 	}
@@ -18,8 +18,8 @@
 
 <FormDialog bind:dialog submitText={text('generic.login')} {submit} pageMode={fullPage}>
 	<div>
-		<label for="email">{text('Login.email')}</label>
-		<input name="email" type="email" required />
+		<label for="username">{text('generic.username')}</label>
+		<input name="username" type="text" required />
 	</div>
 	{#snippet footer()}
 		{#if fullPage}

package/lib/Register.svelte

@@ -14,12 +14,12 @@
 
 <FormDialog bind:dialog submitText={text('generic.register')} {submit} pageMode={fullPage}>
 	<div>
-		<label for="name">{text('Register.name')}</label>
+		<label for="name">{text('generic.user_display_name')}</label>
 		<input name="name" type="text" required />
 	</div>
 	<div>
-		<label for="email">{text('Register.email')}</label>
-		<input name="email" type="email" required />
+		<label for="username">{text('generic.username')}</label>
+		<input name="username" type="text" required />
 	</div>
 	{#snippet footer()}
 		{#if fullPage}

package/locales/en.json

@@ -23,7 +23,6 @@
 		"no_results": "No results"
 	},
 	"Login": {
-		"email": "Email",
 		"register": "Register instead"
 	},
 	"Logout": {
@@ -31,9 +30,7 @@
 		"question": "Are you sure you want to log out?"
 	},
 	"Register": {
-		"email": "Email",
-		"login": "Login instead",
-		"name": "Display Name"
+		"login": "Login instead"
 	},
 	"SessionList": {
 		"created": "Created {date}",
@@ -78,6 +75,8 @@
 		"none": "None",
 		"ok": "Okay",
 		"preferences": "Preferences",
+		"recovery": "Recovery",
+		"recovery_method_disabled": "This recovery method is disabled and can't be used.",
 		"register": "Register",
 		"rename": "Rename",
 		"sessions": "Sessions",
@@ -85,7 +84,7 @@
 		"success": "Success",
 		"unknown": "Unknown",
 		"unnamed": "Unnamed",
-		"user_display_name": "Name",
+		"user_display_name": "Display name",
 		"username": "Username",
 		"yes": "Yes"
 	},
@@ -121,6 +120,8 @@
 				"toast_updated": "Profile picture updated"
 			},
 			"preferences": "Preferences",
+			"remove_email": "Remove email",
+			"remove_email_confirm": "Are you sure you want to remove your recovery email?",
 			"sessions": "Sessions",
 			"title": "Your Account",
 			"toast_username_updated": "Username updated",

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@axium/client",
-	"version": "0.34.0",
+	"version": "0.35.0",
 	"author": "James Prevett <jp@jamespre.dev>",
 	"funding": {
 		"type": "individual",
@@ -49,7 +49,7 @@
 		"build": "tsc"
 	},
 	"peerDependencies": {
-		"@axium/core": ">=0.36.1",
+		"@axium/core": ">=0.37.0",
 		"ioium": "^1.7.0",
 		"semver": "^7.7.4",
 		"svelte": "^5.36.0",