@wavezfm/api 0.1.0

package/dist/types.d.ts

@@ -0,0 +1,374 @@
+export type ApiPrimitive = string | number | boolean | null;
+export type ApiQueryValue = ApiPrimitive | readonly ApiPrimitive[] | undefined;
+export type ApiQuery = Record<string, ApiQueryValue>;
+export type AuthMode = "session" | "auth-token" | "room-bot" | "none";
+export type ApiParseMode = "json" | "text" | "void";
+export type FetchImplementation = typeof fetch;
+export type WavezApiLocale = "en" | "pt-BR";
+export type WavezApiMessageKey = "fetchUnavailable" | "baseUrlRequired" | "requestTimedOut" | "roomPermissionManageRoom" | "roomNotFound" | "roomBotInvalid" | "roomBotScopeMismatch" | "roomBotOwnerMissing" | "roomBotOwnerBanned" | "roomBotPermissionDenied" | "roomBotForbidden" | "roomBotTokenRequired" | "roomBotMuted" | "roomBotWebsocketFactoryRequired" | "roomBotWebsocketListenerUnsupported" | "roomBotWebsocketNotConnected" | "roomBotWebsocketCreateFailed" | "roomBotWebsocketConnectFailed" | "roomBotCreateNameLengthInvalid" | "roomBotCreateAvatarUrlInvalid" | "roomBotCreateAvatarUrlDirectImageRequired" | "roomBotCreatePermissionsArrayRequired" | "roomBotCreatePermissionInvalid" | "roomBotCreatePermissionRequired" | "roomBotCreatePrefixLengthInvalid" | "roomBotCreatePrefixWhitespaceInvalid" | "roomBotCreateExpiryNumberInvalid" | "roomBotCreateExpiryRangeInvalid";
+export type WavezApiMessageValues = Record<string, string | number | boolean | null | undefined>;
+export type WavezApiMessages = Partial<Record<WavezApiMessageKey, string>>;
+export interface ApiSuccessResponse<T> {
+    data: T;
+    status: number;
+    headers: Headers;
+}
+export interface ApiRequestOptions<TBody = unknown> {
+    path: string;
+    method?: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
+    query?: ApiQuery;
+    body?: TBody;
+    headers?: HeadersInit;
+    credentials?: RequestCredentials;
+    cache?: RequestCache;
+    signal?: AbortSignal;
+    authMode?: AuthMode;
+    parseAs?: ApiParseMode;
+}
+export interface ApiClientConfig {
+    baseURL: string;
+    timeout?: number;
+    logging?: boolean;
+    headers?: HeadersInit;
+    credentials?: RequestCredentials;
+    fetch?: FetchImplementation;
+    authToken?: string | null;
+    roomBotToken?: string | null;
+    locale?: WavezApiLocale;
+    messages?: WavezApiMessages;
+}
+export interface ApiLike {
+    request<T, TBody = unknown>(options: ApiRequestOptions<TBody>): Promise<ApiSuccessResponse<T>>;
+    get<T>(path: string, options?: Omit<ApiRequestOptions<never>, "path" | "method" | "body">): Promise<ApiSuccessResponse<T>>;
+    post<T, TBody = unknown>(path: string, body?: TBody, options?: Omit<ApiRequestOptions<TBody>, "path" | "method" | "body">): Promise<ApiSuccessResponse<T>>;
+    put<T, TBody = unknown>(path: string, body?: TBody, options?: Omit<ApiRequestOptions<TBody>, "path" | "method" | "body">): Promise<ApiSuccessResponse<T>>;
+    patch<T, TBody = unknown>(path: string, body?: TBody, options?: Omit<ApiRequestOptions<TBody>, "path" | "method" | "body">): Promise<ApiSuccessResponse<T>>;
+    delete<T, TBody = unknown>(path: string, options?: Omit<ApiRequestOptions<TBody>, "path" | "method">): Promise<ApiSuccessResponse<T>>;
+    getBaseURL(): string;
+    getSiteURL(path?: string): string;
+    formatMessage(key: WavezApiMessageKey, values?: WavezApiMessageValues): string;
+    setAuthToken(token: string | null): void;
+    getAuthToken(): string | null;
+    setRoomBotToken(token: string | null): void;
+    getRoomBotToken(): string | null;
+}
+export interface AuthUser {
+    id: string;
+    userId?: string;
+    email?: string | null;
+    emailVerified?: boolean;
+    username: string;
+    displayUsername?: string | null;
+    /**
+     * @deprecated Use `displayUsername`.
+     */
+    displayName?: string | null;
+    name?: string | null;
+    bio?: string | null;
+    image?: string | null;
+    avatar?: string | null;
+    avatarId?: string | null;
+    avatarDjUrl?: string | null;
+    avatarFrameCount?: number;
+    platformRole?: string | null;
+    platformRoles?: string[];
+    infiniteLevel?: boolean;
+    level?: number;
+    xp?: number;
+    xpRequired?: number;
+    totalXp?: number;
+    fanCount?: number;
+    fans?: number;
+    isBanned?: boolean;
+    banReason?: string | null;
+    colorTheme?: string | null;
+    timeFormat?: "12h" | "24h" | string | null;
+    notifyChatMentions?: boolean;
+    playMentionSound?: boolean;
+    presenceStatus?: string | null;
+    selectedBadgeIds?: string[];
+    selectedBadges?: BadgeAssignment[];
+    showChatBadge?: boolean;
+    subscriptionStatus?: string | null;
+    subscriptionCycle?: string | null;
+    subscriptionCurrentPeriodStartAt?: string | null;
+    subscriptionCurrentPeriodEndAt?: string | null;
+    subscriptionCancelAtPeriodEnd?: boolean;
+    canClearAdminLogs?: boolean;
+    [key: string]: unknown;
+}
+export interface UserProfile extends AuthUser {
+    numericId?: number;
+    badges?: BadgeAssignment[];
+}
+export interface BadgeAssignment {
+    id: string;
+    name?: string;
+    title?: string;
+    iconKey?: string | null;
+    imageUrl?: string | null;
+    [key: string]: unknown;
+}
+export interface RoomSummary {
+    id: string;
+    slug: string;
+    name: string;
+    description?: string;
+    activeUsersCount?: number;
+    population?: number;
+    queueCount?: number;
+    isFeatured?: boolean;
+    isFavorited?: boolean;
+    verified?: boolean;
+    ownerUsername?: string | null;
+    currentPlayback?: {
+        title?: string;
+        artist?: string;
+        thumbnailUrl?: string | null;
+        [key: string]: unknown;
+    } | null;
+    [key: string]: unknown;
+}
+export interface PlaylistSummary {
+    id: string;
+    name: string;
+    isActive?: boolean;
+    totalTracks?: number;
+    itemCount?: number;
+    [key: string]: unknown;
+}
+export interface PlaylistTrack {
+    id: string;
+    source: string;
+    sourceId: string;
+    title: string;
+    artist?: string;
+    durationMs?: number;
+    thumbnailUrl?: string | null;
+    [key: string]: unknown;
+}
+export interface MediaSearchResult {
+    source: string;
+    sourceId: string;
+    title: string;
+    artist?: string;
+    thumbnailUrl?: string | null;
+    [key: string]: unknown;
+}
+export interface ChatMessage {
+    id: string;
+    userId: string;
+    username: string;
+    content: string;
+    timestamp?: string | number;
+    editedAt?: string | null;
+    avatar?: string | null;
+    role?: string;
+    platformRole?: string | null;
+    [key: string]: unknown;
+}
+export interface WalletBalance {
+    coins: number;
+    diamonds: number;
+    [key: string]: unknown;
+}
+export interface InventoryResponse {
+    ownedAvatarIds?: string[];
+    ownedBackgroundIds?: string[];
+    ownedBadgeIds?: string[];
+    ownedVideoFrameIds?: string[];
+    avatarId?: string | null;
+    equippedAvatarId?: string | null;
+    items?: InventoryCatalogEntry[];
+    avatars?: InventoryCatalogItem[];
+    badges?: InventoryCatalogItem[];
+    backgrounds?: InventoryCatalogItem[];
+    videoFrames?: InventoryCatalogItem[];
+    [key: string]: unknown;
+}
+export interface StoreCatalogResponse {
+    sections?: StoreCatalogSection[];
+    backgroundSections?: StoreCatalogSection[];
+    badgeSections?: StoreCatalogSection[];
+    videoFrameSections?: StoreCatalogSection[];
+    premiumShopEnabled?: boolean;
+    badgeShopEnabled?: boolean;
+    videoFrameShopEnabled?: boolean;
+    backgroundShopEnabled?: boolean;
+    [key: string]: unknown;
+}
+export interface StoreCatalogSection {
+    id: string;
+    label?: string;
+    items: StoreCatalogItem[];
+    [key: string]: unknown;
+}
+export interface StoreCatalogItem {
+    id: string;
+    name: string;
+    collection?: string;
+    type?: string;
+    price?: number;
+    currency?: string;
+    unlockLevel?: number | null;
+    url?: string | null;
+    djUrl?: string | null;
+    imageUrl?: string | null;
+    description?: string;
+    renderMode?: string;
+    iconKey?: string | null;
+    colorHex?: string | null;
+    isVisible?: boolean;
+    startAt?: string | null;
+    endAt?: string | null;
+    [key: string]: unknown;
+}
+export interface InventoryCatalogItem extends StoreCatalogItem {
+    purchasedAt?: string | null;
+    equippedAt?: string | null;
+}
+export interface InventoryCatalogEntry {
+    storeItemId: string;
+    category: "avatar" | "background" | "badge" | "videoframe" | string;
+    purchasedAt?: string | null;
+    equippedAt?: string | null;
+    [key: string]: unknown;
+}
+export interface RoomBotToken {
+    token: string;
+    tokenId: string;
+    roomId: string;
+    botUserId: string;
+    botName: string;
+    botAvatarUrl?: string | null;
+    commandPrefix: string;
+    permissions: string[];
+    issuedAt: string;
+    expiresAt: string;
+    actorRole?: string;
+    [key: string]: unknown;
+}
+export type RoomBotPermission = "read_state" | "read_chat" | "send_chat" | "manage_room";
+export interface RoomBotState {
+    bot: {
+        id: string;
+        tokenId: string;
+        roomId: string;
+        actorUserId: string;
+        roomRole?: string;
+        name: string;
+        avatarUrl?: string | null;
+        commandPrefix: string;
+        permissions: string[];
+        issuedAt?: string;
+        expiresAt?: string;
+        [key: string]: unknown;
+    };
+    snapshot: Record<string, unknown>;
+    customEmojis: unknown[];
+}
+export interface SystemPublicStats {
+    rooms?: number;
+    onlineUsers?: number;
+    tracksPlayed?: number;
+    users?: number;
+    [key: string]: unknown;
+}
+export interface SystemDonationGoal {
+    enabled: boolean;
+    title: string;
+    titlePtBr?: string;
+    titleEnUs?: string;
+    description: string;
+    descriptionPtBr?: string;
+    descriptionEnUs?: string;
+    localizedCurrencyEnabled?: boolean;
+    currency: string;
+    targetCents: number;
+    raisedCents: number;
+    [key: string]: unknown;
+}
+export interface SystemStatus {
+    maintenanceMode: boolean;
+    premiumShopEnabled: boolean;
+    badgeShopEnabled: boolean;
+    videoFrameShopEnabled: boolean;
+    backgroundShopEnabled: boolean;
+    spotifyEnabled: boolean;
+    soundcloudEnabled: boolean;
+    globalDonationGoal: SystemDonationGoal | null;
+    updatedAt?: string | null;
+    updatedByUserId?: string | null;
+    updatedByUsername?: string | null;
+    canBypass?: boolean;
+    [key: string]: unknown;
+}
+export interface CheckoutSessionResponse {
+    checkoutUrl: string;
+    [key: string]: unknown;
+}
+export interface UserSettings {
+    bio?: string | null;
+    colorTheme?: string | null;
+    timeFormat?: "12h" | "24h" | string | null;
+    notifyChatMentions?: boolean;
+    playMentionSound?: boolean;
+    presenceStatus?: "online" | "busy" | "away" | string | null;
+    selectedBadgeIds?: string[];
+    showChatBadge?: boolean;
+    [key: string]: unknown;
+}
+export interface TwoFactorStatus {
+    email: string;
+    emailVerified: boolean;
+    phoneNumber?: string | null;
+    phoneNumberMasked?: string | null;
+    phoneNumberVerified?: boolean;
+    twoFactorEnabled: boolean;
+    twoFactorMethod: "none" | "email" | "sms" | "authy";
+    twoFactorPendingMethod?: "email" | "sms" | "authy" | null;
+    smsEnabled?: boolean;
+    authyEnabled?: boolean;
+    smsAvailable?: boolean;
+    [key: string]: unknown;
+}
+export interface WsPacket<TPayload = Record<string, unknown>> {
+    type: "command" | "event" | "ack" | "error";
+    event: string;
+    requestId?: string;
+    version: "v1";
+    timestamp: string;
+    payload: TPayload;
+}
+export interface RoomBotRealtimeOptions {
+    baseURL: string;
+    botToken: string;
+    roomId: string;
+    autoJoinRoom?: boolean;
+    logging?: boolean;
+    protocols?: string | string[];
+    locale?: WavezApiLocale;
+    messages?: WavezApiMessages;
+    websocketFactory?: (url: string, protocols?: string | string[]) => WebSocketLike;
+}
+export interface WebSocketLike {
+    readonly readyState: number;
+    send(data: string): void;
+    close(code?: number, reason?: string): void;
+    addEventListener?: (type: string, listener: (event: unknown) => void) => void;
+    removeEventListener?: (type: string, listener: (event: unknown) => void) => void;
+    on?: (type: string, listener: (event: unknown) => void) => void;
+    off?: (type: string, listener: (event: unknown) => void) => void;
+}
+export interface RoomBotRealtimeClient {
+    connect(): Promise<void>;
+    disconnect(code?: number, reason?: string): void;
+    send<TPayload extends Record<string, unknown>>(event: string, payload?: TPayload, requestId?: string): void;
+    joinRoom(roomId?: string): void;
+    leaveRoom(roomId?: string): void;
+    ping(): void;
+    on(event: string, handler: (packet: WsPacket<Record<string, unknown>>) => void): () => void;
+    off(event: string, handler: (packet: WsPacket<Record<string, unknown>>) => void): void;
+    once(event: string, handler: (packet: WsPacket<Record<string, unknown>>) => void): () => void;
+    getSocket(): WebSocketLike | null;
+}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,97 @@
+{
+  "name": "@wavezfm/api",
+  "version": "0.1.0",
+  "description": "Official JavaScript/TypeScript API client for Wavez.",
+  "type": "module",
+  "license": "UNLICENSED",
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "devDependencies": {
+    "typescript": "^5.8.3"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./resources/auth": {
+      "types": "./dist/resources/auth.d.ts",
+      "import": "./dist/resources/auth.js"
+    },
+    "./resources/settings": {
+      "types": "./dist/resources/settings.d.ts",
+      "import": "./dist/resources/settings.js"
+    },
+    "./resources/user": {
+      "types": "./dist/resources/user.d.ts",
+      "import": "./dist/resources/user.js"
+    },
+    "./resources/room": {
+      "types": "./dist/resources/room.d.ts",
+      "import": "./dist/resources/room.js"
+    },
+    "./resources/playlist": {
+      "types": "./dist/resources/playlist.d.ts",
+      "import": "./dist/resources/playlist.js"
+    },
+    "./resources/source": {
+      "types": "./dist/resources/source.d.ts",
+      "import": "./dist/resources/source.js"
+    },
+    "./resources/chat": {
+      "types": "./dist/resources/chat.d.ts",
+      "import": "./dist/resources/chat.js"
+    },
+    "./resources/friend": {
+      "types": "./dist/resources/friend.d.ts",
+      "import": "./dist/resources/friend.js"
+    },
+    "./resources/shop": {
+      "types": "./dist/resources/shop.d.ts",
+      "import": "./dist/resources/shop.js"
+    },
+    "./resources/billing": {
+      "types": "./dist/resources/billing.d.ts",
+      "import": "./dist/resources/billing.js"
+    },
+    "./resources/system": {
+      "types": "./dist/resources/system.d.ts",
+      "import": "./dist/resources/system.js"
+    },
+    "./resources/room-bot": {
+      "types": "./dist/resources/roomBot.d.ts",
+      "import": "./dist/resources/roomBot.js"
+    },
+    "./realtime/room-bot": {
+      "types": "./dist/realtime/roomBot.d.ts",
+      "import": "./dist/realtime/roomBot.js"
+    },
+    "./types": {
+      "types": "./dist/types.d.ts",
+      "import": "./dist/types.js"
+    }
+  },
+  "keywords": [
+    "wavez",
+    "api",
+    "sdk",
+    "typescript",
+    "bots"
+  ]
+}