ttfm-socket 1.6.10 → 1.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Hangout FM Socket Client <!-- omit in toc -->
|
|
2
2
|
|
|
3
|
-
Welcome to the
|
|
3
|
+
Welcome to the Hangout FM Socket Client! This package provides a TypeScript client to communicate with rooms on Hangout FM.
|
|
4
4
|
|
|
5
5
|
- [Installation](#installation)
|
|
6
6
|
- [Joining a Room](#joining-a-room)
|
|
@@ -44,7 +44,7 @@ To join a room, you'll need to retrieve the UUID for that room using [this endpo
|
|
|
44
44
|
import { SocketClient } from "ttfm-socket";
|
|
45
45
|
|
|
46
46
|
const client = new SocketClient("https://socket.prod.tt.fm");
|
|
47
|
-
const token = "{your
|
|
47
|
+
const token = "{your Hangout FM JWT}";
|
|
48
48
|
|
|
49
49
|
const { state } = await client.joinRoom(token, {
|
|
50
50
|
roomUuid: "{room uuid}",
|
|
@@ -214,4 +214,4 @@ Sent by the server after someone hits the `/resetRoom` endpoint for that room. T
|
|
|
214
214
|
|
|
215
215
|
## Support
|
|
216
216
|
|
|
217
|
-
If you have any questions or feedback about this package, please reach out to us on [Discord](https://discord.gg/
|
|
217
|
+
If you have any questions or feedback about this package, please reach out to us on [Discord](https://discord.gg/3AXbhwYTHu) or at help@hangout.fm.
|
|
@@ -59,15 +59,17 @@ export declare type MinimalCrateSongResDTO = {
|
|
|
59
59
|
trackName: string;
|
|
60
60
|
genre: string | null;
|
|
61
61
|
duration: number;
|
|
62
|
+
description: string | null;
|
|
62
63
|
isrc: string | null;
|
|
63
|
-
musicProviders: MusicProvidersDTO;
|
|
64
64
|
playbackToken: string | null;
|
|
65
|
-
thumbnails: ThumbnailsDTO;
|
|
66
65
|
songShortId?: string;
|
|
66
|
+
explicit: boolean;
|
|
67
|
+
musicProviders: MusicProvidersDTO;
|
|
68
|
+
thumbnails: ThumbnailsDTO;
|
|
69
|
+
isGenerated: boolean;
|
|
67
70
|
crateSongUuid?: string;
|
|
68
71
|
status?: MinimalCrateSongResDTO.status;
|
|
69
72
|
position?: number;
|
|
70
|
-
explicit: boolean;
|
|
71
73
|
};
|
|
72
74
|
export declare namespace MinimalCrateSongResDTO {
|
|
73
75
|
enum status {
|
|
@@ -196,10 +198,13 @@ export declare type OtherUserProfileResDto = {
|
|
|
196
198
|
instagram: string;
|
|
197
199
|
twitter: string;
|
|
198
200
|
snapchat: string;
|
|
199
|
-
tiktok: string;
|
|
200
201
|
discord: string;
|
|
201
|
-
|
|
202
|
+
tiktok: string;
|
|
203
|
+
youtube: string;
|
|
204
|
+
twitch: string;
|
|
205
|
+
badges: Array<"VERIFIED" | "PLATINUM" | "DOUBLE_PLATINUM" | "JQBX" | "STAFF" | "IDENTITY_VERIFIED">;
|
|
202
206
|
priceForGig: number;
|
|
207
|
+
verifiedAt: string | null;
|
|
203
208
|
};
|
|
204
209
|
export type Consumable = {
|
|
205
210
|
id: string;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { MinimalCrateSongResDTO, OtherUserProfileResDto, RoomDto, TokenRole, UserRoles } from "./services";
|
|
2
|
-
export type GhostUserProfile = Pick<OtherUserProfileResDto, "color" | "uuid" | "avatarId" | "nickname">;
|
|
2
|
+
export type GhostUserProfile = Pick<OtherUserProfileResDto, "color" | "uuid" | "avatarId" | "nickname" | "verifiedAt">;
|
|
3
3
|
export type ServerDj = {
|
|
4
4
|
userUuid: string;
|
|
5
5
|
/** The key where the song was saved in the Actionhero cache. */
|
package/package.json
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "ttfm-socket",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.7.0",
|
|
4
4
|
"main": "./dist-client/client/index.js",
|
|
5
5
|
"typings": "./dist-client/client/index.d.ts",
|
|
6
6
|
"devDependencies": {
|
|
7
7
|
"@faker-js/faker": "^9.7.0",
|
|
8
|
-
"@ttfm-labs/nestjs-backend": "^2.
|
|
8
|
+
"@ttfm-labs/nestjs-backend": "^2.4.2",
|
|
9
9
|
"@types/amqplib": "^0.10.7",
|
|
10
10
|
"@types/glob": "^8.1.0",
|
|
11
11
|
"@types/jest": "^29.5.3",
|