PocketPages

User Management Functions

PocketPages provides two helper functions for creating users:

  • createUser() - Create a regular user account
  • createAnonymousUser() - Create an anonymous user account
  • createPasswordlessUser() - Create a passwordless user account
  • requestVerification() - Request email verification for a user
  • confirmVerification() - Confirm email verification for a user
  • requestOTP() - Request a one-time password for a user

createUser()

Creates a new user with the specified email and password.

// Create user in default 'users' collection
const user = createUser('[email protected]', 'password123')

// Create user in custom collection
const user = createUser('[email protected]', 'password123', {
  collection: 'customers',
})

// Create user without sending verification email
const user = createUser('[email protected]', 'password123', {
  sendVerificationEmail: false,
})

Parameters

  • email (string): User's email address
  • password (string): User's password
  • options (optional): User creation options
    • collection (string): Collection name for the user (defaults to 'users')
    • sendVerificationEmail (boolean): Whether to send verification email (defaults to true)

Returns

Returns the created user object.

Error Handling

Throws an error if:

  • Email is empty or only whitespace
  • Password is empty or only whitespace

createAnonymousUser()

Creates a user with randomly generated credentials.

// Create anonymous user in default 'users' collection
const { user, email, password } = createAnonymousUser()

// Create anonymous user in custom collection
const { user, email, password } = createAnonymousUser({
  collection: 'customers',
})

Parameters

  • options (optional): Authentication options
    • collection (string): Collection name for the user (defaults to 'users')

Returns

Returns an object containing:

  • user: The created user object
  • email: Generated email (format: anonymous-[numbers]@example.com)
  • password: Generated password

createPasswordlessUser()

Creates the specified user with randomly generated password.

// Create passwordless user in default 'users' collection
const { user, password } = createPasswordlessUser('[email protected]')

// Create passwordless user in custom collection
const { user, password } = createPasswordlessUser('[email protected]', {
  collection: 'customers',
})

// Create passwordless user without sending verification email
const { user, password } = createPasswordlessUser('[email protected]', {
  sendVerificationEmail: false,
})

Parameters

  • email (string): User's email address
  • options (optional): User creation options
    • collection (string): Collection name for the user (defaults to 'users')
    • sendVerificationEmail (boolean): Whether to send verification email (defaults to true)

Returns

Returns an object containing:

  • user: The created user object
  • password: Generated password

requestVerification()

Sends a verification email to the specified user's email address.

// Request verification for user in default 'users' collection
requestVerification('[email protected]')

// Request verification for user in custom collection
requestVerification('[email protected]', {
  collection: 'customers',
})

Parameters

  • email (string): User's email address
  • options (optional): Authentication options
    • collection (string): Collection name for the user (defaults to 'users')

Returns

Void - sends verification email to the specified address

confirmVerification()

Confirms a user's email verification using the provided token.

// Confirm verification for user in default 'users' collection
confirmVerification('VERIFICATION_TOKEN')

// Confirm verification for user in custom collection
confirmVerification('VERIFICATION_TOKEN', {
  collection: 'customers',
})

Parameters

  • token (string): Verification token received via email
  • options (optional): Authentication options
    • collection (string): Collection name for the user (defaults to 'users')

Returns

Void - verifies the user's email if token is valid

requestOTP()

Requests a one-time password for the specified email address. If the user doesn't exist, creates a passwordless user first.

// Request OTP for user in default 'users' collection
requestOTP('[email protected]')

// Request OTP for user in custom collection
requestOTP('[email protected]', {
  collection: 'customers',
})

Parameters

  • email (string): User's email address
  • options (optional): Authentication options
    • collection (string): Collection name for the user (defaults to 'users')

Returns

Returns the OTP request response from PocketBase.

Template Usage

<%
  // Create regular user
  try {
    const user = createUser('[email protected]', 'password123')
    info('Created user:', user.id)
  } catch (e) {
    error('Failed to create user:', e)
  }

  // Create user in custom collection
  const user = createUser('[email protected]', 'password123', {
    collection: 'customers'
  })

  // Create anonymous user
  const { user: anonUser } = createAnonymousUser()
  info('Created anonymous user:', anonUser.id)

  // Request email verification
  try {
    requestVerification('[email protected]')
    info('Verification email sent')
  } catch (e) {
    error('Failed to send verification:', e)
  }

  // Confirm verification
  try {
    confirmVerification(token)
    info('Email verified successfully')
  } catch (e) {
    error('Failed to verify email:', e)
  }
%>

Best Practices

  1. Error Handling
try {
  const user = createUser(email, password)
  // Handle success
} catch (e) {
  error('User creation failed:', e)
  // Handle error
}
  1. Anonymous Users
// Store credentials if needed
const { user, email, password } = createAnonymousUser()
// Save email/password for later authentication
  1. Custom Collections
// Use consistent collection names
const options = { collection: 'customers' }
const user = createUser(email, password, options)
const anonUser = createAnonymousUser(options)

Security Notes

  • Passwords are automatically hashed by PocketBase
  • Anonymous users are real users with random credentials
  • Consider implementing cleanup for anonymous users
  • Collection permissions still apply to user creation