@protobase/client 0.53.7 → 0.54.0

package/dist/auth-types.d.ts

@@ -32,7 +32,8 @@ export type SamlSignIn = {
 /**
  * `needsAdmin` while no user exists yet; `signInMethods` the ways to sign in the server's policy leaves on;
  * `signInFirst` when the sign-in page leads with an emailed code, with the password behind "Use a password"; `passwordReset` when the server can email reset links; `changeEmail` when it can email the code that confirms a new
- * address (see `account.requestEmailChange`); `signUp` when anyone can make their own account (see
+ * address (see `account.requestEmailChange`); `accountDeletion` when people may delete their own account (see
+ * `deleteAccount`); `signUp` when anyone can make their own account (see
  * `sendSignUpCode`); `socialProviders` the ids of the sign-in providers, for example
  * `github`; `platformSignIn` the one of them the platform adds; `samlProviders` the app's SAML identity providers; `staffSignIn` the operator provider's name when its staff
  * can sign in as people; `organizations` when the app has them; `anonymous` when visitors may browse what the project's
@@ -46,6 +47,7 @@ export type SetupStatus = {
   signInFirst?: 'emailCode';
   passwordReset: boolean;
   changeEmail?: boolean;
+  accountDeletion?: boolean;
   signUp?: boolean;
   socialProviders: string[];
   platformSignIn?: PlatformSignIn;

package/dist/auth.d.ts

@@ -43,6 +43,12 @@ export declare const createAuthSession: (options?: AuthSessionOptions) => {
    */
   signInSaml: (providerId: string, callbackURL: string) => Promise<string>;
   signOut: () => Promise<void>;
+  /**
+   * Deletes the signed-in person's account with its sessions and sign-in methods, when the server allows it
+   * (`status().accountDeletion`), and signs this device out. Without `password` the session must have signed in within
+   * the last day (`SESSION_EXPIRED`); the last admin (`LAST_ADMIN`) and a locked account (`ACCOUNT_LOCKED`) are refused.
+   */
+  deleteAccount: (password?: string) => Promise<void>;
   /**
    * Emails a reset link when an account has this address; the answer is the same either way. The link leads back to
    * `redirectTo`, with `token` (or `error=INVALID_TOKEN`) added to its query.

package/dist/auth.js

@@ -79,6 +79,7 @@ const createAuthSession = (options = {}) => {
 				...body.signInFirst === "emailCode" && { signInFirst: "emailCode" },
 				passwordReset: Boolean(body.passwordReset),
 				...body.changeEmail && { changeEmail: true },
+				...body.accountDeletion && { accountDeletion: true },
 				...body.signUp && { signUp: true },
 				socialProviders: body.socialProviders ?? [],
 				...body.platformSignIn && { platformSignIn: body.platformSignIn },
@@ -135,6 +136,16 @@ const createAuthSession = (options = {}) => {
 			await client.signOut();
 		},
 		/**
+		* Deletes the signed-in person's account with its sessions and sign-in methods, when the server allows it
+		* (`status().accountDeletion`), and signs this device out. Without `password` the session must have signed in within
+		* the last day (`SESSION_EXPIRED`); the last admin (`LAST_ADMIN`) and a locked account (`ACCOUNT_LOCKED`) are refused.
+		*/
+		deleteAccount: async (password) => {
+			const { error } = await client.deleteUser(password ? { password } : {});
+			if (error) throw authError(error, "Could not delete your account");
+			forget();
+		},
+		/**
 		* Emails a reset link when an account has this address; the answer is the same either way. The link leads back to
 		* `redirectTo`, with `token` (or `error=INVALID_TOKEN`) added to its query.
 		*/

package/dist/static-session.js

@@ -42,6 +42,7 @@ const createStaticSession = (token, user = {
 	signInSocial: unsupported("sign in with a provider"),
 	signInSaml: unsupported("sign in with a provider"),
 	signOut: async () => void 0,
+	deleteAccount: unsupported("delete its account"),
 	requestPasswordReset: async () => void 0,
 	resetPassword: async () => void 0,
 	account: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@protobase/client",
-  "version": "0.53.7",
+  "version": "0.54.0",
   "description": "Typed fetch client for the Protobase REST API.",
   "license": "Apache-2.0",
   "repository": {
@@ -30,8 +30,8 @@
   },
   "dependencies": {
     "@better-auth/passkey": "^1.7.12",
-    "@protobase/layout": "0.53.7",
-    "@protobase/schema": "0.53.7",
+    "@protobase/layout": "0.54.0",
+    "@protobase/schema": "0.54.0",
     "@simplewebauthn/browser": "^13.3.0",
     "better-auth": "^1.7.12"
   }