palbase 0.23.2 → 0.25.0

package/types/internal/src/modules/auth.d.ts

@@ -401,7 +401,7 @@ export type AdminTestUserCreateRequest = {
      */
     count?: number;
     /**
-     * Test users to create with exactly these credentials.
+     * Test users to create, each of the kind it says (AdminTestUserSpec).
      */
     users?: AdminTestUserSpec[];
     /**
@@ -416,9 +416,37 @@ export type AdminTestUserCredential = {
     access_token?: string;
     email: string;
     /**
-     * In clear. Shown once.
+     * The fixed code its email accepts, when it was given one.
      */
-    password: string;
+    email_otp?: string;
+    /**
+     * Whether its email is verified.
+     */
+    email_verified: boolean;
+    /**
+     * The second factor it was made with.
+     */
+    mfa?: "totp" | "sms" | "email";
+    /**
+     * Its phone's fixed code, when it has a phone.
+     */
+    otp?: string;
+    /**
+     * In clear. Shown once. Absent for a passwordless user.
+     */
+    password?: string;
+    /**
+     * Its phone, when it has one.
+     */
+    phone?: string;
+    /**
+     * A totp factor's key (base32), shown once: a test makes its codes with it.
+     */
+    totp_secret?: string;
+    /**
+     * A totp factor's otpauth:// address, shown once.
+     */
+    totp_url?: string;
     user_id: string;
 };
 export type AdminTestUserList = {
@@ -439,17 +467,39 @@ export type AdminTestUserPhoneRequest = {
     phone: string;
 };
 /**
- * One test user with exactly these credentials. phone and otp are given together or not at all.
+ * One test user, of the kind it says. What it leaves out is made: an address (test-…@test.invalid, which receives no mail — its mail is kept in its test inbox, GET /notify/test-users/{user_id}/messages), a password (unless passwordless), its phone's fixed code. A real address of the developer's gets its mail too.
  */
 export type AdminTestUserSpec = {
-    email: string;
     /**
-     * The fixed code this phone accepts at sign-in. Requires phone.
+     * Its address: made when omitted.
+     */
+    email?: string;
+    /**
+     * The fixed code its email accepts — its verification code and its email second factor — for a person with no inbox to read (an app store's reviewer). The mail is still sent, carrying it. Six digits.
+     */
+    email_otp?: string;
+    /**
+     * false makes its email unverified, for an app's verification to be tested on it (its code or link comes to its test inbox). Default true.
+     */
+    email_verified?: boolean;
+    /**
+     * A second factor it has from the start: totp (its key answered once, totp_secret), sms (its phone, with its fixed code) or email (a verified address).
+     */
+    mfa?: "totp" | "sms" | "email";
+    /**
+     * The fixed code its phone accepts at sign-in: its phone is texted nothing. Made when phone is given without it. Requires phone.
      */
     otp?: string;
-    password: string;
     /**
-     * E.164. Requires otp.
+     * Its password: made when omitted, unless passwordless.
+     */
+    password?: string;
+    /**
+     * No password: it signs in by a link, a code or a passkey. Not with password.
+     */
+    passwordless?: boolean;
+    /**
+     * E.164: a verified phone, texted nothing.
      */
     phone?: string;
 };
@@ -1038,9 +1088,9 @@ export type AuthSettings = {
      */
     risk_strict_step_up: number;
     /**
-     * The changes to how an account signs in that its user is mailed about, each with its own template (auth.security_<kind>): a password changed, the email address changed (told to the address the account had), a provider linked or unlinked, a second factor added or removed, a passkey added or removed. By default a second factor or a passkey added or removed (mfa_factor_enrolled, mfa_factor_removed, passkey_added, passkey_removed); the others as the project chooses. Mail goes to a confirmed address only, in the user's locale.
+     * The changes to how an account signs in that its user is mailed about, each with its own template (auth.security_<kind>): a password changed, the email address changed (told to the address the account had), a provider linked or unlinked, a second factor added or removed, a recovery code spent at a sign-in, a passkey added or removed. By default a second factor added or removed, a recovery code spent, a passkey added or removed (mfa_factor_enrolled, mfa_factor_removed, mfa_recovery_code_used, passkey_added, passkey_removed); the others as the project chooses. Mail goes to a confirmed address only, in the user's locale.
      */
-    security_notifications?: ("password_changed" | "email_changed" | "identity_linked" | "identity_unlinked" | "mfa_factor_enrolled" | "mfa_factor_removed" | "passkey_added" | "passkey_removed")[];
+    security_notifications?: ("password_changed" | "email_changed" | "identity_linked" | "identity_unlinked" | "mfa_factor_enrolled" | "mfa_factor_removed" | "mfa_recovery_code_used" | "passkey_added" | "passkey_removed")[];
     /**
      * Bind each session to the device it was opened on: a refresh from another device fingerprint, browser or operating system ends the session; a network change is recorded in the audit log. Default false.
      */
@@ -1121,9 +1171,9 @@ export type AuthSettingsUpdateRequest = {
      */
     risk_strict_step_up?: number;
     /**
-     * The changes to how an account signs in that its user is mailed about, each with its own template (auth.security_<kind>): a password changed, the email address changed (told to the address the account had), a provider linked or unlinked, a second factor added or removed, a passkey added or removed. By default a second factor or a passkey added or removed (mfa_factor_enrolled, mfa_factor_removed, passkey_added, passkey_removed); the others as the project chooses. Mail goes to a confirmed address only, in the user's locale. Present (even []) replaces the kinds; absent keeps them.
+     * The changes to how an account signs in that its user is mailed about, each with its own template (auth.security_<kind>): a password changed, the email address changed (told to the address the account had), a provider linked or unlinked, a second factor added or removed, a recovery code spent at a sign-in, a passkey added or removed. By default a second factor added or removed, a recovery code spent, a passkey added or removed (mfa_factor_enrolled, mfa_factor_removed, mfa_recovery_code_used, passkey_added, passkey_removed); the others as the project chooses. Mail goes to a confirmed address only, in the user's locale. Present (even []) replaces the kinds; absent keeps them.
      */
-    security_notifications?: ("password_changed" | "email_changed" | "identity_linked" | "identity_unlinked" | "mfa_factor_enrolled" | "mfa_factor_removed" | "passkey_added" | "passkey_removed")[];
+    security_notifications?: ("password_changed" | "email_changed" | "identity_linked" | "identity_unlinked" | "mfa_factor_enrolled" | "mfa_factor_removed" | "mfa_recovery_code_used" | "passkey_added" | "passkey_removed")[];
     /**
      * Bind each session to the device it was opened on: a refresh from another device fingerprint, browser or operating system ends the session; a network change is recorded in the audit log. Default false.
      */
@@ -3753,6 +3803,19 @@ export type WebAuthnSignupBeginResponse = {
      */
     user_id: string;
 };
+/**
+ * An address made for an app's sign-up to be tested with.
+ */
+export type TestSignupAddress = {
+    /**
+     * signup-…@test.invalid: a sign-up with it (POST /auth/signup) opens a test user, whose mail is kept in its test inbox.
+     */
+    email: string;
+    /**
+     * When it lapses unused (a day), freeing its place of the test-user cap.
+     */
+    expires_at: string;
+};
 /** The events this module sends the project's webhooks (x-palbase-events), by type: each one's payload, the event's data. */
 export interface Events {
     /**
@@ -4328,7 +4391,7 @@ export declare function client(t: Transport): {
     /**
      * Create test users
      *
-     * Creates test users, all or none, and returns their credentials once: passwords are never retrievable afterwards. Either send users (each with an email and password, and optionally a phone with the fixed code it accepts) or a count of users to create with generated credentials; users wins when both are present. At most 1000 per request. Test users are created email-verified, skip the breach check and the minimum password length, and are not counted as active users. with_tokens also returns an access token per user. 409 user_exists when an email is already taken; 409 test_user_cap_exceeded when the batch would exceed the project's test-user cap. Send an Idempotency-Key to make the call safe to retry.
+     * Creates test users, all or none, and returns their credentials once: passwords and totp keys are never retrievable afterwards. Either send users (each of the kind it says: an address and password of its own or made, passwordless, unverified, a phone with its fixed code, a fixed email code, a second factor) or a count of users to create with generated credentials; users wins when both are present. At most 1000 per request. Test users skip the breach check and the minimum password length, and are not counted as active users. Their mail and texts are kept in their test inbox (GET /notify/test-users/{user_id}/messages): a phone is texted nothing, a generated address (…@test.invalid) is mailed nothing, a real address is mailed as well. with_tokens also returns an access token per user. 409 user_exists when an email is already taken; 409 test_user_cap_exceeded when the batch would exceed the project's test-user cap (its test users and its unused sign-up addresses). Send an Idempotency-Key to make the call safe to retry.
      */
     adminCreateTestUsers(input: {
         headers?: {
@@ -4346,6 +4409,14 @@ export declare function client(t: Transport): {
         body: AdminTestUserPhoneRequest; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
         signal?: AbortSignal;
     }): Promise<Reply<204, undefined>>;
+    /**
+     * Make a sign-up address for a test
+     *
+     * Makes an address for an app's sign-up to be tested with: a sign-up with it (POST /auth/signup) opens a test user — its token says test, it is not counted as an active user, and its verification mail is kept in its test inbox (GET /notify/test-users/{user_id}/messages), never sent. Only the secret key makes one; it holds a place of the project's test-user cap until it is used (once) or lapses a day later. A sign-up with any other address opens an ordinary user. 409 test_user_cap_exceeded when the cap is full.
+     */
+    adminCreateTestSignupAddress(input?: {
+        signal?: AbortSignal;
+    }): Promise<Reply<201, TestSignupAddress>>;
     /**
      * Delete a test user
      *