@borealise/api 1.1.11 → 2.0.0-alpha.10

package/dist/index.d.ts

@@ -23,14 +23,10 @@ declare class ApiError extends Error {
     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;
+    constructor(config: ApiConfig);
     private setupInterceptors;
     private parseError;
     setAuthToken(token: string | null): void;
@@ -44,11 +40,12 @@ declare class Api {
     private wrapResponse;
     get axiosInstance(): AxiosInstance;
 }
+declare const createApi: (config: ApiConfig) => Api;
 
 declare class Logger {
     private readonly name;
     private enabled;
-    private constructor();
+    constructor(name: string, enabled?: boolean);
     static create(name: string): Logger;
     enable(): void;
     disable(): void;
@@ -59,39 +56,6 @@ declare class Logger {
     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;
@@ -144,8 +108,7 @@ interface MeResponse {
         user: AuthUser;
     };
 }
-declare class AuthResource extends ApiResource<AuthUser> {
-    protected readonly endpoint = "/auth";
+interface AuthResource {
     login(credentials: LoginCredentials): Promise<ApiResponse<AuthResponse>>;
     register(data: RegisterData): Promise<ApiResponse<AuthResponse>>;
     refresh(refreshToken: string): Promise<ApiResponse<RefreshResponse>>;
@@ -154,8 +117,14 @@ declare class AuthResource extends ApiResource<AuthUser> {
         message: string;
     }>>;
     me(): Promise<ApiResponse<MeResponse>>;
+    forgotPassword(email: string): Promise<ApiResponse<{
+        success: boolean;
+    }>>;
+    resetPassword(token: string, password: string): Promise<ApiResponse<{
+        success: boolean;
+    }>>;
 }
-declare const authResource: AuthResource;
+declare const createAuthResource: (api: Api) => AuthResource;
 
 interface User extends AuthUser {
 }
@@ -170,9 +139,23 @@ interface UserResponse {
         user: User;
     };
 }
-declare class UserResource extends ApiResource<User> {
-    protected readonly endpoint = "/users";
-    getById(id: number): Promise<ApiResponse<User>>;
+interface MyViolation {
+    id: number;
+    adminUsername: string;
+    reason: string;
+    revoked: boolean;
+    revokedAt: string | null;
+    createdAt: string;
+}
+interface MyViolationsResponse {
+    success: boolean;
+    data: {
+        violations: MyViolation[];
+        permanentBan: boolean;
+    };
+}
+interface UserResource {
+    getById(id: number): Promise<ApiResponse<UserResponse>>;
     getByUsername(username: string): Promise<ApiResponse<UserResponse>>;
     updateProfile(data: UpdateProfileData): Promise<ApiResponse<UserResponse>>;
     deleteAccount(): Promise<ApiResponse<{
@@ -184,8 +167,9 @@ declare class UserResource extends ApiResource<User> {
         success: boolean;
         data: null;
     }>>;
+    getMyViolations(): Promise<ApiResponse<MyViolationsResponse>>;
 }
-declare const userResource: UserResource;
+declare const createUserResource: (api: Api) => UserResource;
 
 type RoomRole = 'user' | 'resident_dj' | 'bouncer' | 'manager' | 'cohost' | 'host';
 interface Room {
@@ -368,11 +352,8 @@ interface BoothState {
     };
 }
 interface JoinMuteInfo {
-    /** ISO timestamp when the mute expires, or null if permanent */
     expiresAt: string | null;
-    /** Seconds remaining until unmute, or null if permanent */
     remainingSeconds: number | null;
-    /** Optional reason given by the moderator */
     reason: string | null;
 }
 interface JoinRoomResponse {
@@ -388,7 +369,6 @@ interface JoinRoomResponse {
         role: RoomRole;
         users: RoomUserState[];
         booth: BoothState;
-        /** Present when the joining user is currently muted in this room */
         mute: JoinMuteInfo | null;
     };
 }
@@ -458,9 +438,53 @@ interface RoomHistoryResponse {
         pagination: PaginationMeta;
     };
 }
-declare class RoomResource extends ApiResource<Room> {
-    protected readonly endpoint = "/rooms";
+type AuditAction = 'kick' | 'ban' | 'unban' | 'mute' | 'unmute' | 'role_change' | 'waitlist_move' | 'waitlist_remove' | 'track_skip';
+interface RoomAuditLog {
+    id: number;
+    actorId: number;
+    actorUsername: string;
+    targetId: number | null;
+    targetUsername: string | null;
+    action: AuditAction;
+    metadata: string | null;
+    createdAt: string;
+}
+interface RoomAuditLogResponse {
+    success: boolean;
+    data: {
+        logs: RoomAuditLog[];
+        hasMore: boolean;
+    };
+}
+type DashboardActivityType = 'play' | 'woot' | 'grab';
+interface DashboardActivityItem {
+    id: string;
+    type: DashboardActivityType;
+    room: {
+        id: number;
+        slug: string;
+        name: string;
+    };
+    media: {
+        id: number;
+        source: 'youtube' | 'soundcloud';
+        sourceId: string;
+        title: string;
+        artist: string | null;
+        thumbnail: string | null;
+    };
+    count: number | null;
+    createdAt: string;
+}
+interface DashboardActivityResponse {
+    success: boolean;
+    data: {
+        activities: DashboardActivityItem[];
+    };
+}
+interface RoomResource {
     list(): Promise<ApiResponse<RoomsResponse>>;
+    mine(limit?: number): Promise<ApiResponse<RoomsResponse>>;
     featured(): Promise<ApiResponse<FeaturedRoomsResponse>>;
     getBySlug(slug: string): Promise<ApiResponse<RoomResponse>>;
     create(data: CreateRoomData): Promise<ApiResponse<RoomResponse>>;
@@ -545,8 +569,10 @@ declare class RoomResource extends ApiResource<Room> {
     vote(slug: string, type: 'woot' | 'meh'): Promise<ApiResponse<VoteResponse>>;
     grabTrack(slug: string, playlistId?: number): Promise<ApiResponse<GrabResponse>>;
     getHistory(slug: string, page?: number, limit?: number): Promise<ApiResponse<RoomHistoryResponse>>;
+    getAuditLog(slug: string, limit?: number, before?: string): Promise<ApiResponse<RoomAuditLogResponse>>;
+    activity(limit?: number): Promise<ApiResponse<DashboardActivityResponse>>;
 }
-declare const roomResource: RoomResource;
+declare const createRoomResource: (api: Api) => RoomResource;
 
 interface ChatMessage {
     id: string;
@@ -578,8 +604,7 @@ interface ChatMessageResponse {
         message: ChatMessage;
     };
 }
-declare class ChatResource extends ApiResource<ChatMessage> {
-    protected readonly endpoint = "/rooms";
+interface ChatResource {
     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<{
@@ -587,13 +612,13 @@ declare class ChatResource extends ApiResource<ChatMessage> {
         data: null;
     }>>;
 }
-declare const chatResource: ChatResource;
+declare const createChatResource: (api: Api) => ChatResource;
 
-type MediaSource = 'youtube' | 'soundcloud';
+type MediaSource$1 = 'youtube' | 'soundcloud';
 interface MediaItem {
     id: number;
     playlistId: number;
-    source: MediaSource;
+    source: MediaSource$1;
     sourceId: string;
     title: string;
     artist: string | null;
@@ -632,7 +657,7 @@ interface MediaItemResponse {
     };
 }
 interface AddMediaData {
-    source: MediaSource;
+    source: MediaSource$1;
     sourceId: string;
 }
 interface ShuffleResponse {
@@ -643,7 +668,7 @@ interface ShuffleResponse {
     };
 }
 interface ImportPlaylistData {
-    source?: MediaSource;
+    source?: MediaSource$1;
     url: string;
 }
 interface ImportResult {
@@ -657,8 +682,7 @@ interface ImportPlaylistResponse {
     success: boolean;
     data: ImportResult;
 }
-declare class PlaylistResource extends ApiResource<Playlist> {
-    protected readonly endpoint = "/playlists";
+interface PlaylistResource {
     getAll(): Promise<ApiResponse<PlaylistsResponse>>;
     getById(playlistId: number): Promise<ApiResponse<PlaylistResponse>>;
     create(name: string): Promise<ApiResponse<PlaylistResponse>>;
@@ -675,8 +699,9 @@ declare class PlaylistResource extends ApiResource<Playlist> {
     moveItem(playlistId: number, itemId: number, position: number): Promise<ApiResponse<MediaItemResponse>>;
     importPlaylist(playlistId: number, data: ImportPlaylistData): Promise<ApiResponse<ImportPlaylistResponse>>;
 }
-declare const playlistResource: PlaylistResource;
+declare const createPlaylistResource: (api: Api) => PlaylistResource;
 
+type MediaSource = 'youtube' | 'soundcloud';
 interface MediaSearchResult {
     source: MediaSource;
     sourceId: string;
@@ -710,8 +735,7 @@ interface SoundCloudTrackResponse {
         track: MediaSearchResult;
     };
 }
-declare class SourceResource extends ApiResource<MediaSearchResult> {
-    protected readonly endpoint = "/sources";
+interface SourceResource {
     searchYouTube(query: string, limit?: number): Promise<ApiResponse<YouTubeSearchResponse>>;
     getYouTubeVideo(videoId: string): Promise<ApiResponse<YouTubeVideoResponse>>;
     searchSoundCloud(query: string, limit?: number): Promise<ApiResponse<SoundCloudSearchResponse>>;
@@ -719,16 +743,14 @@ declare class SourceResource extends ApiResource<MediaSearchResult> {
     resolveSoundCloudUrl(url: string): Promise<ApiResponse<SoundCloudTrackResponse>>;
     searchAll(query: string, limit?: number): Promise<MediaSearchResult[]>;
 }
-declare const sourceResource: SourceResource;
+declare const createSourceResource: (api: Api) => SourceResource;
 
 type AvatarUnlockType = 'free' | 'level' | 'subscription';
 interface AvatarCatalogItem {
     id: string;
     unlockType: AvatarUnlockType;
     requiredLevel: number | null;
-    /** Whether the user has unlocked (or has free access to) this avatar */
     unlocked: boolean;
-    /** Whether the user currently meets the requirement to unlock it */
     eligible: boolean;
 }
 interface AvatarCatalogResponse {
@@ -742,8 +764,7 @@ interface AvatarCatalogResponse {
 interface EquipAvatarData {
     avatarId: string;
 }
-declare class ShopResource extends ApiResource {
-    protected readonly endpoint = "/shop";
+interface ShopResource {
     getAvatarCatalog(): Promise<ApiResponse<AvatarCatalogResponse>>;
     unlockAvatar(avatarId: string): Promise<ApiResponse<{
         success: boolean;
@@ -759,7 +780,7 @@ declare class ShopResource extends ApiResource {
         };
     }>>;
 }
-declare const shopResource: ShopResource;
+declare const createShopResource: (api: Api) => ShopResource;
 
 type SubscriptionPlan = 'monthly' | 'yearly';
 interface SubscriptionStatus {
@@ -782,8 +803,7 @@ interface PortalResponse {
         url: string;
     };
 }
-declare class SubscriptionResource extends ApiResource {
-    protected readonly endpoint = "/subscriptions";
+interface SubscriptionResource {
     getStatus(): Promise<ApiResponse<{
         success: boolean;
         data: SubscriptionStatus;
@@ -794,7 +814,7 @@ declare class SubscriptionResource extends ApiResource {
     }>>;
     createPortal(): Promise<ApiResponse<PortalResponse>>;
 }
-declare const subscriptionResource: SubscriptionResource;
+declare const createSubscriptionResource: (api: Api) => SubscriptionResource;
 
 type FriendshipStatus = 'none' | 'pending_sent' | 'pending_received' | 'accepted' | 'blocked_by_me' | 'blocked_by_them';
 interface FriendEntry {
@@ -829,8 +849,7 @@ interface FriendActionResponse {
         status: FriendshipStatus;
     } | null;
 }
-declare class FriendResource extends ApiResource<FriendEntry> {
-    protected readonly endpoint = "/friends";
+interface FriendResource {
     list(): Promise<ApiResponse<FriendListResponse>>;
     getStatus(targetUserId: number): Promise<ApiResponse<FriendStatusResponse>>;
     sendRequest(targetUserId: number): Promise<ApiResponse<FriendActionResponse>>;
@@ -839,6 +858,124 @@ declare class FriendResource extends ApiResource<FriendEntry> {
     block(targetUserId: number): Promise<ApiResponse<FriendActionResponse>>;
     unblock(targetUserId: number): Promise<ApiResponse<FriendActionResponse>>;
 }
-declare const friendResource: FriendResource;
+declare const createFriendResource: (api: Api) => FriendResource;
+
+interface AdminUserEntry {
+    id: number;
+    username: string;
+    displayName: string | null;
+    email?: string;
+    avatarId: string;
+    globalRole: GlobalRole;
+    disabled: boolean;
+    permanentBan: boolean;
+    emailVerified: boolean;
+    xp: number;
+    createdAt: string;
+}
+interface AdminUsersResponse {
+    success: boolean;
+    data: {
+        users: AdminUserEntry[];
+        total: number;
+    };
+}
+interface AdminStatsRoom {
+    slug: string;
+    name: string;
+    population: number;
+}
+interface AdminStatsResponse {
+    success: boolean;
+    data: {
+        activeRooms: number;
+        totalOnlineUsers: number;
+        rooms: AdminStatsRoom[];
+    };
+}
+interface AdminListUsersParams {
+    search?: string;
+    role?: GlobalRole | '';
+    disabled?: boolean;
+    page?: number;
+    limit?: number;
+    sortBy?: 'id' | 'username' | 'createdAt';
+    sortDir?: 'asc' | 'desc';
+}
+interface AccountViolation {
+    id: number;
+    adminId: number;
+    adminUsername: string;
+    reason: string;
+    revoked: boolean;
+    revokedAt: string | null;
+    revokerId: number | null;
+    createdAt: string;
+}
+interface UserViolationsResponse {
+    success: boolean;
+    data: {
+        violations: AccountViolation[];
+        permanentBan: boolean;
+    };
+}
+interface AddViolationResponse {
+    success: boolean;
+    data: {
+        violation: AccountViolation;
+        permanentlyBanned: boolean;
+        activeViolations: number;
+    };
+}
+interface AdminResource {
+    listUsers(params?: AdminListUsersParams): Promise<ApiResponse<AdminUsersResponse>>;
+    enableUser(id: number): Promise<ApiResponse<{
+        success: boolean;
+        data: null;
+    }>>;
+    disableUser(id: number): Promise<ApiResponse<{
+        success: boolean;
+        data: null;
+    }>>;
+    updateRole(id: number, role: GlobalRole): Promise<ApiResponse<{
+        success: boolean;
+        data: null;
+    }>>;
+    broadcast(message: string): Promise<ApiResponse<{
+        success: boolean;
+        data: {
+            sent_to_rooms: number;
+        };
+    }>>;
+    setMaintenance(active: boolean, message?: string, endsAt?: number | null): Promise<ApiResponse<{
+        success: boolean;
+        data: {
+            active: boolean;
+        };
+    }>>;
+    getStats(): Promise<ApiResponse<AdminStatsResponse>>;
+    addViolation(userId: number, reason: string): Promise<ApiResponse<AddViolationResponse>>;
+    revokeViolation(violationId: number): Promise<ApiResponse<{
+        success: boolean;
+        data: null;
+    }>>;
+    getUserViolations(userId: number): Promise<ApiResponse<UserViolationsResponse>>;
+}
+declare const createAdminResource: (api: Api) => AdminResource;
+
+interface ApiClient {
+    api: Api;
+    auth: AuthResource;
+    user: UserResource;
+    room: RoomResource;
+    chat: ChatResource;
+    playlist: PlaylistResource;
+    source: SourceResource;
+    shop: ShopResource;
+    subscription: SubscriptionResource;
+    friend: FriendResource;
+    admin: AdminResource;
+}
+declare const createApiClient: (config: ApiConfig) => ApiClient;
 
-export { type AddMediaData, Api, type ApiConfig, ApiError, ApiResource, type ApiResponse, AuthResource, type AuthResponse, type AuthUser, type AvatarCatalogItem, type AvatarCatalogResponse, type AvatarUnlockType, type BackendErrorResponse, type BanResponse, type BoothDJ, type BoothMedia, type BoothResponse, type BoothState, type ChatMessage, type ChatMessageResponse, type ChatMessagesResponse, ChatResource, type CreateIntentResponse, type CreateRoomData, type EquipAvatarData, type FeaturedRoomsResponse, type FriendActionResponse, type FriendEntry, type FriendList, type FriendListResponse, FriendResource, type FriendStatusResponse, type FriendshipStatus, type GlobalRole, type GrabResponse, type ImportPlaylistData, type ImportPlaylistResponse, type ImportResult, type JoinMuteInfo, type JoinRoomResponse, Logger, type LoginCredentials, type MeResponse, type MediaItem, type MediaItemResponse, type MediaSearchResult, type MediaSource, type ModerateUserData, type MuteResponse, type PaginatedResponse, type PaginationMeta, type PlayHistoryItem, type Playlist, PlaylistResource, type PlaylistResponse, type PlaylistsResponse, type PortalResponse, type RefreshResponse, type RegisterData, type ResourceOptions, type Room, type RoomBan, type RoomBansResponse, type RoomHistoryResponse, type RoomMember, type RoomMute, type RoomMutesResponse, RoomResource, type RoomResponse, type RoomRole, type RoomStaffResponse, type RoomUserState, type RoomsResponse, type SendMessageData, ShopResource, type ShuffleResponse, type SoundCloudSearchResponse, type SoundCloudTrackResponse, SourceResource, type SubscriptionPlan, SubscriptionResource, type SubscriptionStatus, type UpdateProfileData, type UpdateRoomData, type User, UserResource, type UserResponse, type VoteResponse, type WaitlistResponse, type WaitlistUser, type YouTubeSearchResponse, type YouTubeVideoResponse, authResource, chatResource, friendResource, playlistResource, roomResource, shopResource, sourceResource, subscriptionResource, userResource };
+export { type AccountViolation, type AddMediaData, type AddViolationResponse, type AdminListUsersParams, type AdminResource, type AdminStatsResponse, type AdminStatsRoom, type AdminUserEntry, type AdminUsersResponse, Api, type ApiClient, type ApiConfig, ApiError, type ApiResponse, type AuditAction, type AuthResource, type AuthUser, type AvatarCatalogItem, type AvatarCatalogResponse, type AvatarUnlockType, type BackendErrorResponse, type BanResponse, type BoothDJ, type BoothMedia, type BoothResponse, type BoothState, type ChatMessage, type ChatMessageResponse, type ChatMessagesResponse, type ChatResource, type CreateIntentResponse, type CreateRoomData, type DashboardActivityItem, type DashboardActivityResponse, type DashboardActivityType, type EquipAvatarData, type FeaturedRoomsResponse, type FriendActionResponse, type FriendEntry, type FriendList, type FriendListResponse, type FriendResource, type FriendStatusResponse, type FriendshipStatus, type GlobalRole, type GrabResponse, type ImportPlaylistData, type ImportPlaylistResponse, type ImportResult, type JoinMuteInfo, type JoinRoomResponse, Logger, type MediaItem, type MediaItemResponse, type MediaSearchResult, type MediaSource, type ModerateUserData, type MuteResponse, type MyViolation, type MyViolationsResponse, type PaginationMeta, type PlayHistoryItem, type Playlist, type PlaylistResource, type PlaylistResponse, type PlaylistsResponse, type PortalResponse, type Room, type RoomAuditLog, type RoomBan, type RoomBansResponse, type RoomHistoryResponse, type RoomMember, type RoomMute, type RoomMutesResponse, type RoomResource, type RoomResponse, type RoomRole, type RoomStaffResponse, type RoomUserState, type RoomsResponse, type SendMessageData, type ShopResource, type ShuffleResponse, type SoundCloudSearchResponse, type SoundCloudTrackResponse, type SourceResource, type SubscriptionPlan, type SubscriptionResource, type SubscriptionStatus, type UpdateProfileData, type UpdateRoomData, type User, type UserResource, type UserResponse, type UserViolationsResponse, type VoteResponse, type WaitlistResponse, type WaitlistUser, type YouTubeSearchResponse, type YouTubeVideoResponse, createAdminResource, createApi, createApiClient, createAuthResource, createChatResource, createFriendResource, createPlaylistResource, createRoomResource, createShopResource, createSourceResource, createSubscriptionResource, createUserResource };