@nodots-llc/backgammon-api-utils/dist/users.d.ts

Shared utilities for nodots-backgammon API operations

/**
 * User and Authentication Types
 *
 * These types define user-related data structures shared between API and clients.
 */
import { Request } from 'express';
/**
 * User preference object
 */
export type Preference = {
    key: string;
    value: string | object;
};
/**
 * Backgammon-specific game preferences
 */
export type BackgammonGamePreferences = {
    diceAutoRoll: boolean;
    boardTheme?: string;
    showMoveHints?: boolean;
};
/**
 * All game preferences organized by game type
 */
export type GamePreferences = {
    backgammon?: BackgammonGamePreferences;
};
/**
 * User preferences
 */
export type UserPreferences = {
    username?: string;
    gender?: string;
    imageUri?: string;
    games?: GamePreferences;
    locale?: string;
    theme?: string;
    notifications?: boolean;
};
/**
 * User state values
 */
export type UserState = 'playing' | 'seeking' | 'suspended' | 'banned' | 'pending' | 'inactive' | 'logged-in';
/**
 * User type values
 */
export type UserType = 'human' | 'robot';
/**
 * External user representation (from Auth0 or other auth providers)
 */
export type ExternalUser = {
    source: string;
    externalId: string;
    email: string;
    userType: UserType;
    token?: string;
    state?: UserState;
    nickname?: string;
    firstName?: string;
    lastName?: string;
    imageUri?: string;
    preferences?: UserPreferences;
    locale?: string;
    lastActive?: Date;
    createdAt?: Date;
    updatedAt?: Date;
};
/**
 * Standard User type for API responses
 */
export interface User {
    id: string;
    email: string;
    firstName?: string;
    lastName?: string;
    nickname?: string;
    imageUri?: string;
    userType: UserType;
    state: UserState;
    lastActive: Date;
    createdAt: Date;
    updatedAt: Date;
    preferences?: UserPreferences;
}
/**
 * Express Request with authenticated user
 */
export interface AuthenticatedRequest extends Request {
    user?: {
        sub: string;
        email?: string;
        name?: string;
        [key: string]: any;
    };
}
//# sourceMappingURL=users.d.ts.map