@borealise/api 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,569 @@
+import { AxiosRequestConfig, AxiosInstance } from 'axios';
+
+interface ApiConfig {
+    baseURL: string;
+    timeout?: number;
+    headers?: Record<string, string>;
+    /** Set to false to suppress all log output. Defaults to true. */
+    logging?: boolean;
+}
+interface ApiResponse<T = unknown> {
+    data: T;
+    status: number;
+    headers: Record<string, string>;
+}
+interface BackendErrorResponse {
+    success: false;
+    error: string;
+}
+declare class ApiError extends Error {
+    readonly status?: number;
+    readonly code?: string;
+    readonly response?: BackendErrorResponse;
+    constructor(message: string, status?: number, code?: string, response?: BackendErrorResponse);
+}
+declare class Api {
+    private static instance;
+    private readonly axios;
+    private readonly logger;
+    private readonly config;
+    private constructor();
+    static getInstance(config?: ApiConfig): Api;
+    /** Reset the singleton (useful for testing or re-initializing with a new config) */
+    static reset(): void;
+    private setupInterceptors;
+    private parseError;
+    setAuthToken(token: string | null): void;
+    setHeader(key: string, value: string): void;
+    removeHeader(key: string): void;
+    get<T = unknown>(url: string, config?: AxiosRequestConfig): Promise<ApiResponse<T>>;
+    post<T = unknown>(url: string, data?: unknown, config?: AxiosRequestConfig): Promise<ApiResponse<T>>;
+    put<T = unknown>(url: string, data?: unknown, config?: AxiosRequestConfig): Promise<ApiResponse<T>>;
+    patch<T = unknown>(url: string, data?: unknown, config?: AxiosRequestConfig): Promise<ApiResponse<T>>;
+    delete<T = unknown>(url: string, config?: AxiosRequestConfig): Promise<ApiResponse<T>>;
+    private wrapResponse;
+    get axiosInstance(): AxiosInstance;
+}
+
+declare class Logger {
+    private readonly name;
+    private enabled;
+    private constructor();
+    static create(name: string): Logger;
+    enable(): void;
+    disable(): void;
+    private log;
+    debug(message: string, ...args: unknown[]): void;
+    info(message: string, ...args: unknown[]): void;
+    success(message: string, ...args: unknown[]): void;
+    error(message: string, ...args: unknown[]): void;
+}
+
+interface PaginatedResponse<T> {
+    data: T[];
+    meta: {
+        total: number;
+        page: number;
+        perPage: number;
+        lastPage: number;
+    };
+}
+interface ResourceOptions {
+    params?: Record<string, unknown>;
+    headers?: Record<string, string>;
+}
+declare abstract class ApiResource<T = unknown> {
+    private _logger;
+    protected abstract readonly endpoint: string;
+    protected get api(): Api;
+    protected get logger(): Logger;
+    protected buildUrl(path?: string | number): string;
+    protected buildConfig(options?: ResourceOptions): AxiosRequestConfig;
+    index(options?: ResourceOptions): Promise<ApiResponse<T[]>>;
+    paginate(page?: number, perPage?: number, options?: ResourceOptions): Promise<ApiResponse<PaginatedResponse<T>>>;
+    show(id: string | number, options?: ResourceOptions): Promise<ApiResponse<T>>;
+    store(data: Partial<T>, options?: ResourceOptions): Promise<ApiResponse<T>>;
+    update(id: string | number, data: Partial<T>, options?: ResourceOptions): Promise<ApiResponse<T>>;
+    patch(id: string | number, data: Partial<T>, options?: ResourceOptions): Promise<ApiResponse<T>>;
+    destroy(id: string | number, options?: ResourceOptions): Promise<ApiResponse<void>>;
+    protected get<R = T>(path: string, options?: ResourceOptions): Promise<ApiResponse<R>>;
+    protected post<R = T>(path: string, data?: unknown, options?: ResourceOptions): Promise<ApiResponse<R>>;
+    protected put<R = T>(path: string, data?: unknown, options?: ResourceOptions): Promise<ApiResponse<R>>;
+    protected delete<R = void>(path: string, options?: ResourceOptions): Promise<ApiResponse<R>>;
+}
+
+interface AuthUser {
+    id: number;
+    email?: string;
+    username: string;
+    displayName: string | null;
+    bio: string | null;
+    globalRole: string;
+    flags?: number;
+    subscriptionType?: string;
+    subscriptionExpiresAt?: string | null;
+    emailVerified?: boolean;
+    createdAt?: string;
+}
+interface LoginCredentials {
+    login: string;
+    password: string;
+}
+interface RegisterData {
+    email: string;
+    username: string;
+    password: string;
+    displayName?: string;
+}
+interface AuthResponse {
+    success: boolean;
+    message?: string;
+    data: {
+        user: AuthUser;
+        accessToken: string;
+        refreshToken: string;
+        expiresAt: string;
+    };
+}
+interface RefreshResponse {
+    success: boolean;
+    data: {
+        accessToken: string;
+        refreshToken: string;
+        expiresAt: string;
+    };
+}
+interface MeResponse {
+    success: boolean;
+    data: {
+        user: AuthUser;
+    };
+}
+declare class AuthResource extends ApiResource<AuthUser> {
+    protected readonly endpoint = "/auth";
+    login(credentials: LoginCredentials): Promise<ApiResponse<AuthResponse>>;
+    register(data: RegisterData): Promise<ApiResponse<AuthResponse>>;
+    refresh(refreshToken: string): Promise<ApiResponse<RefreshResponse>>;
+    logout(): Promise<ApiResponse<{
+        success: boolean;
+        message: string;
+    }>>;
+    me(): Promise<ApiResponse<MeResponse>>;
+}
+declare const authResource: AuthResource;
+
+interface User extends AuthUser {
+}
+interface UpdateProfileData {
+    displayName?: string;
+    bio?: string;
+}
+interface UserResponse {
+    success: boolean;
+    data: {
+        user: User;
+    };
+}
+declare class UserResource extends ApiResource<User> {
+    protected readonly endpoint = "/users";
+    getById(id: number): Promise<ApiResponse<User>>;
+    getByUsername(username: string): Promise<ApiResponse<UserResponse>>;
+    updateProfile(data: UpdateProfileData): Promise<ApiResponse<UserResponse>>;
+    deleteAccount(): Promise<ApiResponse<{
+        success: boolean;
+        message: string;
+    }>>;
+}
+declare const userResource: UserResource;
+
+type RoomRole = 'user' | 'resident_dj' | 'bouncer' | 'manager' | 'cohost' | 'host';
+interface Room {
+    id: number;
+    slug: string;
+    name: string;
+    description: string | null;
+    welcomeMessage: string | null;
+    hostId: number;
+    minChatLevel: number;
+    isPrivate: boolean;
+    isNsfw: boolean;
+    waitlistLocked: boolean;
+    waitlistCycleEnabled: boolean;
+    population: number;
+    totalPlays: number;
+    isFeatured: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+interface RoomMember {
+    id: number;
+    roomId: number;
+    userId: number;
+    role: RoomRole;
+    createdAt: string;
+    updatedAt: string;
+    user?: {
+        id: number;
+        username: string;
+        displayName: string | null;
+    };
+}
+interface CreateRoomData {
+    slug: string;
+    name: string;
+    description?: string;
+    welcomeMessage?: string;
+    isPrivate?: boolean;
+    isNsfw?: boolean;
+}
+interface UpdateRoomData {
+    name?: string;
+    description?: string;
+    welcomeMessage?: string;
+    minChatLevel?: number;
+    isPrivate?: boolean;
+    isNsfw?: boolean;
+    waitlistLocked?: boolean;
+    waitlistCycleEnabled?: boolean;
+}
+interface RoomResponse {
+    success: boolean;
+    data: {
+        room: Room;
+    };
+}
+interface RoomsResponse {
+    success: boolean;
+    data: {
+        rooms: Room[];
+    };
+}
+interface RoomStaffResponse {
+    success: boolean;
+    data: {
+        staff: RoomMember[];
+    };
+}
+interface FeaturedRoomsResponse {
+    success: boolean;
+    data: {
+        rooms: Room[];
+    };
+}
+interface RoomUserState {
+    userId: number;
+    username: string;
+    displayName: string | null;
+    role: RoomRole;
+    joinedAt: number;
+}
+interface BoothDJ {
+    userId: number;
+    username: string;
+    displayName: string | null;
+    role: RoomRole;
+}
+interface BoothMedia {
+    id: number;
+    source: 'youtube' | 'soundcloud';
+    sourceId: string;
+    title: string;
+    artist: string | null;
+    duration: number;
+    thumbnail: string | null;
+    elapsed: number;
+}
+interface WaitlistUser {
+    id: number;
+    username: string;
+    displayName: string | null;
+}
+interface BoothState {
+    dj: BoothDJ | null;
+    media: BoothMedia | null;
+    waitlist: number[];
+    votes: {
+        woots: number;
+        mehs: number;
+        grabs: number;
+    };
+}
+interface JoinRoomResponse {
+    success: boolean;
+    data: {
+        room: {
+            id: number;
+            slug: string;
+            name: string;
+            waitlistLocked: boolean;
+            waitlistCycleEnabled: boolean;
+        };
+        role: RoomRole;
+        users: RoomUserState[];
+        booth: BoothState;
+    };
+}
+interface WaitlistResponse {
+    success: boolean;
+    data: {
+        waitlist: WaitlistUser[];
+        locked: boolean;
+    };
+}
+interface BoothResponse {
+    success: boolean;
+    data: BoothState;
+}
+interface VoteResponse {
+    success: boolean;
+    data: {
+        vote: 'woot' | 'meh';
+        votes: {
+            woots: number;
+            mehs: number;
+            grabs: number;
+        };
+    };
+}
+interface GrabResponse {
+    success: boolean;
+    data: {
+        playlistId: number;
+        message: string;
+    };
+}
+declare class RoomResource extends ApiResource<Room> {
+    protected readonly endpoint = "/rooms";
+    list(): Promise<ApiResponse<RoomsResponse>>;
+    featured(): Promise<ApiResponse<FeaturedRoomsResponse>>;
+    getBySlug(slug: string): Promise<ApiResponse<RoomResponse>>;
+    create(data: CreateRoomData): Promise<ApiResponse<RoomResponse>>;
+    updateRoom(slug: string, data: UpdateRoomData): Promise<ApiResponse<RoomResponse>>;
+    deleteRoom(slug: string): Promise<ApiResponse<{
+        success: boolean;
+    }>>;
+    getStaff(slug: string): Promise<ApiResponse<RoomStaffResponse>>;
+    updateStaffRole(slug: string, userId: number, role: RoomRole): Promise<ApiResponse<{
+        success: boolean;
+    }>>;
+    removeStaff(slug: string, userId: number): Promise<ApiResponse<{
+        success: boolean;
+    }>>;
+    join(slug: string): Promise<ApiResponse<JoinRoomResponse>>;
+    leave(slug: string): Promise<ApiResponse<{
+        success: boolean;
+    }>>;
+    getWaitlist(slug: string): Promise<ApiResponse<WaitlistResponse>>;
+    joinWaitlist(slug: string): Promise<ApiResponse<{
+        success: boolean;
+        data: {
+            position: number;
+        };
+    }>>;
+    leaveWaitlist(slug: string): Promise<ApiResponse<{
+        success: boolean;
+    }>>;
+    moveInWaitlist(slug: string, userId: number, position: number): Promise<ApiResponse<{
+        success: boolean;
+        data: {
+            waitlist: WaitlistUser[];
+        };
+    }>>;
+    removeFromWaitlist(slug: string, userId: number): Promise<ApiResponse<{
+        success: boolean;
+    }>>;
+    lockWaitlist(slug: string): Promise<ApiResponse<{
+        success: boolean;
+        data: {
+            locked: boolean;
+        };
+    }>>;
+    unlockWaitlist(slug: string): Promise<ApiResponse<{
+        success: boolean;
+        data: {
+            locked: boolean;
+        };
+    }>>;
+    getBooth(slug: string): Promise<ApiResponse<BoothResponse>>;
+    skipTrack(slug: string, options?: {
+        stayInBooth?: boolean;
+    }): Promise<ApiResponse<{
+        success: boolean;
+        data?: {
+            stayedInBooth: boolean;
+        };
+    }>>;
+    vote(slug: string, type: 'woot' | 'meh'): Promise<ApiResponse<VoteResponse>>;
+    grabTrack(slug: string, playlistId?: number): Promise<ApiResponse<GrabResponse>>;
+}
+declare const roomResource: RoomResource;
+
+interface ChatMessage {
+    id: string;
+    roomId: number;
+    userId: number;
+    username: string;
+    displayName: string | null;
+    role: RoomRole;
+    content: string;
+    timestamp: number;
+    deleted?: boolean;
+}
+interface SendMessageData {
+    content: string;
+}
+interface ChatMessagesResponse {
+    success: boolean;
+    data: {
+        messages: ChatMessage[];
+    };
+}
+interface ChatMessageResponse {
+    success: boolean;
+    data: {
+        message: ChatMessage;
+    };
+}
+declare class ChatResource extends ApiResource<ChatMessage> {
+    protected readonly endpoint = "/rooms";
+    sendMessage(slug: string, data: SendMessageData): Promise<ApiResponse<ChatMessageResponse>>;
+    getMessages(slug: string, before?: string, limit?: number): Promise<ApiResponse<ChatMessagesResponse>>;
+    deleteMessage(slug: string, messageId: string): Promise<ApiResponse<{
+        success: boolean;
+    }>>;
+}
+declare const chatResource: ChatResource;
+
+type MediaSource = 'youtube' | 'soundcloud';
+interface MediaItem {
+    id: number;
+    playlistId: number;
+    source: MediaSource;
+    sourceId: string;
+    title: string;
+    artist: string | null;
+    duration: number;
+    thumbnail: string | null;
+    position: number;
+    createdAt: string;
+    updatedAt: string;
+}
+interface Playlist {
+    id: number;
+    userId: number;
+    name: string;
+    isActive: boolean;
+    itemCount?: number;
+    items?: MediaItem[];
+    createdAt: string;
+    updatedAt: string;
+}
+interface PlaylistsResponse {
+    success: boolean;
+    data: {
+        playlists: Playlist[];
+    };
+}
+interface PlaylistResponse {
+    success: boolean;
+    data: {
+        playlist: Playlist;
+    };
+}
+interface MediaItemResponse {
+    success: boolean;
+    data: {
+        item: MediaItem;
+    };
+}
+interface AddMediaData {
+    source: MediaSource;
+    sourceId: string;
+}
+interface ShuffleResponse {
+    success: boolean;
+    data: {
+        shuffled: boolean;
+        items?: MediaItem[];
+    };
+}
+interface ImportPlaylistData {
+    source?: MediaSource;
+    url: string;
+}
+interface ImportResult {
+    imported: number;
+    skipped: number;
+    failed: number;
+    errors: string[];
+    reachedLimit: boolean;
+}
+interface ImportPlaylistResponse {
+    success: boolean;
+    data: ImportResult;
+}
+declare class PlaylistResource extends ApiResource<Playlist> {
+    protected readonly endpoint = "/playlists";
+    getAll(): Promise<ApiResponse<PlaylistsResponse>>;
+    getById(playlistId: number): Promise<ApiResponse<PlaylistResponse>>;
+    create(name: string): Promise<ApiResponse<PlaylistResponse>>;
+    rename(playlistId: number, name: string): Promise<ApiResponse<PlaylistResponse>>;
+    remove(playlistId: number): Promise<ApiResponse<{
+        success: boolean;
+    }>>;
+    activate(playlistId: number): Promise<ApiResponse<PlaylistResponse>>;
+    shuffle(playlistId: number): Promise<ApiResponse<ShuffleResponse>>;
+    addItem(playlistId: number, data: AddMediaData): Promise<ApiResponse<MediaItemResponse>>;
+    removeItem(playlistId: number, itemId: number): Promise<ApiResponse<{
+        success: boolean;
+    }>>;
+    moveItem(playlistId: number, itemId: number, position: number): Promise<ApiResponse<MediaItemResponse>>;
+    importPlaylist(playlistId: number, data: ImportPlaylistData): Promise<ApiResponse<ImportPlaylistResponse>>;
+}
+declare const playlistResource: PlaylistResource;
+
+interface MediaSearchResult {
+    source: MediaSource;
+    sourceId: string;
+    title: string;
+    artist: string;
+    duration: number;
+    thumbnail: string | null;
+    permalink?: string;
+}
+interface YouTubeSearchResponse {
+    success: boolean;
+    data: {
+        results: MediaSearchResult[];
+    };
+}
+interface YouTubeVideoResponse {
+    success: boolean;
+    data: {
+        video: MediaSearchResult;
+    };
+}
+interface SoundCloudSearchResponse {
+    success: boolean;
+    data: {
+        results: MediaSearchResult[];
+    };
+}
+interface SoundCloudTrackResponse {
+    success: boolean;
+    data: {
+        track: MediaSearchResult;
+    };
+}
+declare class SourceResource extends ApiResource<MediaSearchResult> {
+    protected readonly endpoint = "/sources";
+    searchYouTube(query: string, limit?: number): Promise<ApiResponse<YouTubeSearchResponse>>;
+    getYouTubeVideo(videoId: string): Promise<ApiResponse<YouTubeVideoResponse>>;
+    searchSoundCloud(query: string, limit?: number): Promise<ApiResponse<SoundCloudSearchResponse>>;
+    getSoundCloudTrack(trackId: string): Promise<ApiResponse<SoundCloudTrackResponse>>;
+    resolveSoundCloudUrl(url: string): Promise<ApiResponse<SoundCloudTrackResponse>>;
+    searchAll(query: string, limit?: number): Promise<MediaSearchResult[]>;
+}
+declare const sourceResource: SourceResource;
+
+export { type AddMediaData, Api, type ApiConfig, ApiError, ApiResource, type ApiResponse, AuthResource, type AuthResponse, type AuthUser, type BackendErrorResponse, type BoothDJ, type BoothMedia, type BoothResponse, type BoothState, type ChatMessage, type ChatMessageResponse, type ChatMessagesResponse, ChatResource, type CreateRoomData, type FeaturedRoomsResponse, type GrabResponse, type ImportPlaylistData, type ImportPlaylistResponse, type ImportResult, type JoinRoomResponse, Logger, type LoginCredentials, type MeResponse, type MediaItem, type MediaItemResponse, type MediaSearchResult, type MediaSource, type PaginatedResponse, type Playlist, PlaylistResource, type PlaylistResponse, type PlaylistsResponse, type RefreshResponse, type RegisterData, type ResourceOptions, type Room, type RoomMember, RoomResource, type RoomResponse, type RoomRole, type RoomStaffResponse, type RoomUserState, type RoomsResponse, type SendMessageData, type ShuffleResponse, type SoundCloudSearchResponse, type SoundCloudTrackResponse, SourceResource, type UpdateProfileData, type UpdateRoomData, type User, UserResource, type UserResponse, type VoteResponse, type WaitlistResponse, type WaitlistUser, type YouTubeSearchResponse, type YouTubeVideoResponse, authResource, chatResource, playlistResource, roomResource, sourceResource, userResource };