rozod 2.0.1 → 2.0.2

package/lib/endpoints/gamejoinv1.js

@@ -0,0 +1,416 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.postTeamCreatePreemptive = exports.postTeamCreate = exports.postPlayWithUser = exports.postJoinReservedGame = exports.postJoinPrivateGame = exports.postJoinPlayTogetherGame = exports.postJoinGameInstance = exports.postJoinGame = void 0;
+const zod_1 = require("zod");
+const Roblox_GameJoin_Api_GameJoinRequest = zod_1.z.object({
+    gameJoinAttemptId: zod_1.z.string().uuid(),
+    placeId: zod_1.z.number().int(),
+    gamerTag: zod_1.z.string(),
+    isPartyLeader: zod_1.z.boolean(),
+    isPlayTogetherGame: zod_1.z.boolean(),
+    browserTrackerId: zod_1.z.number().int(),
+    isTeleport: zod_1.z.boolean(),
+    channelName: zod_1.z.string(),
+});
+const Roblox_Web_GameLaunch_ConnectionFlow_ServerConnection = zod_1.z.object({
+    Address: zod_1.z.string(),
+    Port: zod_1.z.number().int(),
+});
+const Roblox_Web_GameLaunch_ConnectionFlow_UdmuxEndpoint = zod_1.z.object({
+    Address: zod_1.z.string(),
+    Port: zod_1.z.number().int(),
+});
+const Roblox_Web_GameLaunch_ConnectionFlow_JoinInformation = zod_1.z.object({
+    ClientPort: zod_1.z.number().int(),
+    MachineAddress: zod_1.z.string(),
+    ServerPort: zod_1.z.number().int(),
+    ServerConnections: zod_1.z.array(Roblox_Web_GameLaunch_ConnectionFlow_ServerConnection),
+    UdmuxEndpoints: zod_1.z.array(Roblox_Web_GameLaunch_ConnectionFlow_UdmuxEndpoint),
+    DirectServerReturn: zod_1.z.boolean(),
+    TokenGenAlgorithm: zod_1.z.number().int(),
+    PepperId: zod_1.z.number().int(),
+    TokenValue: zod_1.z.string(),
+    PingUrl: zod_1.z.string(),
+    PingInterval: zod_1.z.number().int(),
+    UserName: zod_1.z.string(),
+    DisplayName: zod_1.z.string(),
+    HasVerifiedBadge: zod_1.z.boolean(),
+    SeleniumTestMode: zod_1.z.boolean(),
+    UserId: zod_1.z.number().int(),
+    RobloxLocale: zod_1.z.string(),
+    GameLocale: zod_1.z.string(),
+    SuperSafeChat: zod_1.z.boolean(),
+    FlexibleChatEnabled: zod_1.z.boolean(),
+    CharacterAppearance: zod_1.z.string(),
+    ClientTicket: zod_1.z.string(),
+    GameId: zod_1.z.string(),
+    PlaceId: zod_1.z.number().int(),
+    BaseUrl: zod_1.z.string(),
+    ChatStyle: zod_1.z.string(),
+    CreatorId: zod_1.z.number().int(),
+    CreatorTypeEnum: zod_1.z.string(),
+    MembershipType: zod_1.z.string(),
+    AccountAge: zod_1.z.number().int(),
+    CookieStoreFirstTimePlayKey: zod_1.z.string(),
+    CookieStoreFiveMinutePlayKey: zod_1.z.string(),
+    CookieStoreEnabled: zod_1.z.boolean(),
+    IsUnknownOrUnder13: zod_1.z.boolean(),
+    GameChatType: zod_1.z.string(),
+    SessionId: zod_1.z.string(),
+    AnalyticsSessionId: zod_1.z.string(),
+    DataCenterId: zod_1.z.number().int(),
+    UniverseId: zod_1.z.number().int(),
+    FollowUserId: zod_1.z.number().int(),
+    characterAppearanceId: zod_1.z.number().int(),
+    CountryCode: zod_1.z.string(),
+    AlternateName: zod_1.z.string(),
+    RandomSeed1: zod_1.z.string().regex(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/),
+    ClientPublicKeyData: zod_1.z.string(),
+    RccVersion: zod_1.z.string(),
+    ChannelName: zod_1.z.string(),
+    VerifiedAMP: zod_1.z.number().int(),
+});
+const Roblox_GameJoin_Api_GameJoinResponse = zod_1.z.object({
+    jobId: zod_1.z.string(),
+    status: zod_1.z.number().int(),
+    joinScriptUrl: zod_1.z.string(),
+    authenticationUrl: zod_1.z.string(),
+    authenticationTicket: zod_1.z.string(),
+    message: zod_1.z.string(),
+    joinScript: Roblox_Web_GameLaunch_ConnectionFlow_JoinInformation,
+    queuePosition: zod_1.z.number().int(),
+});
+const Roblox_GameJoin_Api_JoinGameInstanceRequest = zod_1.z.object({
+    gameId: zod_1.z.string().uuid(),
+    gameJoinAttemptId: zod_1.z.string().uuid(),
+    placeId: zod_1.z.number().int(),
+    gamerTag: zod_1.z.string(),
+    isPartyLeader: zod_1.z.boolean(),
+    isPlayTogetherGame: zod_1.z.boolean(),
+    browserTrackerId: zod_1.z.number().int(),
+    isTeleport: zod_1.z.boolean(),
+    channelName: zod_1.z.string(),
+});
+const Roblox_GameJoin_Api_JoinPlayTogetherGameRequest = zod_1.z.object({
+    conversationId: zod_1.z.number().int(),
+    gameJoinAttemptId: zod_1.z.string().uuid(),
+    placeId: zod_1.z.number().int(),
+    gamerTag: zod_1.z.string(),
+    isPartyLeader: zod_1.z.boolean(),
+    isPlayTogetherGame: zod_1.z.boolean(),
+    browserTrackerId: zod_1.z.number().int(),
+    isTeleport: zod_1.z.boolean(),
+    channelName: zod_1.z.string(),
+});
+const Roblox_GameJoin_Api_JoinPrivateGameRequest = zod_1.z.object({
+    accessCode: zod_1.z.string(),
+    linkCode: zod_1.z.string(),
+    gameJoinAttemptId: zod_1.z.string().uuid(),
+    placeId: zod_1.z.number().int(),
+    gamerTag: zod_1.z.string(),
+    isPartyLeader: zod_1.z.boolean(),
+    isPlayTogetherGame: zod_1.z.boolean(),
+    browserTrackerId: zod_1.z.number().int(),
+    isTeleport: zod_1.z.boolean(),
+    channelName: zod_1.z.string(),
+});
+const Roblox_GameJoin_Api_JoinReservedGameRequest = zod_1.z.object({
+    accessCode: zod_1.z.string(),
+    gameJoinAttemptId: zod_1.z.string().uuid(),
+    placeId: zod_1.z.number().int(),
+    gamerTag: zod_1.z.string(),
+    isPartyLeader: zod_1.z.boolean(),
+    isPlayTogetherGame: zod_1.z.boolean(),
+    browserTrackerId: zod_1.z.number().int(),
+    isTeleport: zod_1.z.boolean(),
+    channelName: zod_1.z.string(),
+});
+const Roblox_GameJoin_Api_PlayWithUserRequest = zod_1.z.object({
+    userIdToFollow: zod_1.z.number().int(),
+    gameJoinAttemptId: zod_1.z.string().uuid(),
+    placeId: zod_1.z.number().int(),
+    gamerTag: zod_1.z.string(),
+    isPartyLeader: zod_1.z.boolean(),
+    isPlayTogetherGame: zod_1.z.boolean(),
+    browserTrackerId: zod_1.z.number().int(),
+    isTeleport: zod_1.z.boolean(),
+    channelName: zod_1.z.string(),
+});
+const Roblox_GameJoin_Api_TeamCreateRequest = zod_1.z.object({
+    gameJoinAttemptId: zod_1.z.string().uuid(),
+    placeId: zod_1.z.number().int(),
+    gamerTag: zod_1.z.string(),
+    isPartyLeader: zod_1.z.boolean(),
+    isPlayTogetherGame: zod_1.z.boolean(),
+    browserTrackerId: zod_1.z.number().int(),
+    isTeleport: zod_1.z.boolean(),
+    channelName: zod_1.z.string(),
+});
+const Roblox_GameJoin_Api_TeamCreateResponse = zod_1.z.object({
+    status: zod_1.z.number().int(),
+    message: zod_1.z.string(),
+    settings: zod_1.z.object({}),
+});
+const schemas = {
+    Roblox_GameJoin_Api_GameJoinRequest,
+    Roblox_Web_GameLaunch_ConnectionFlow_ServerConnection,
+    Roblox_Web_GameLaunch_ConnectionFlow_UdmuxEndpoint,
+    Roblox_Web_GameLaunch_ConnectionFlow_JoinInformation,
+    Roblox_GameJoin_Api_GameJoinResponse,
+    Roblox_GameJoin_Api_JoinGameInstanceRequest,
+    Roblox_GameJoin_Api_JoinPlayTogetherGameRequest,
+    Roblox_GameJoin_Api_JoinPrivateGameRequest,
+    Roblox_GameJoin_Api_JoinReservedGameRequest,
+    Roblox_GameJoin_Api_PlayWithUserRequest,
+    Roblox_GameJoin_Api_TeamCreateRequest,
+    Roblox_GameJoin_Api_TeamCreateResponse,
+};
+/**
+ * @api post https://gamejoin.roblox.com/v1/join-game
+ * @param body The Roblox.GameJoin.Api.GameJoinRequest in JSON format
+ */
+exports.postJoinGame = {
+    method: 'post',
+    path: '/v1/join-game',
+    baseUrl: 'https://gamejoin.roblox.com',
+    requestFormat: 'json',
+    serializationMethod: {
+        body: {},
+    },
+    parameters: {
+        body: Roblox_GameJoin_Api_GameJoinRequest,
+    },
+    response: Roblox_GameJoin_Api_GameJoinResponse,
+    errors: [
+        {
+            status: 400,
+            description: `-1: An unknown error occurred.`,
+            schema: zod_1.z.void(),
+        },
+        {
+            status: 429,
+            description: `3: Too many requests, please slow down.`,
+            schema: zod_1.z.void(),
+        },
+    ],
+};
+/**
+ * @api post https://gamejoin.roblox.com/v1/join-game-instance
+ * @param body The Roblox.GameJoin.Api.JoinGameInstanceRequest in JSON format
+ */
+exports.postJoinGameInstance = {
+    method: 'post',
+    path: '/v1/join-game-instance',
+    baseUrl: 'https://gamejoin.roblox.com',
+    requestFormat: 'json',
+    serializationMethod: {
+        body: {},
+    },
+    parameters: {
+        body: Roblox_GameJoin_Api_JoinGameInstanceRequest,
+    },
+    response: Roblox_GameJoin_Api_GameJoinResponse,
+    errors: [
+        {
+            status: 400,
+            description: `-1: An unknown error occurred.`,
+            schema: zod_1.z.void(),
+        },
+        {
+            status: 429,
+            description: `3: Too many requests, please slow down.`,
+            schema: zod_1.z.void(),
+        },
+    ],
+};
+/**
+ * @api post https://gamejoin.roblox.com/v1/join-play-together-game
+ * @param body The Roblox.GameJoin.Api.JoinPlayTogetherGameRequest in JSON format
+ */
+exports.postJoinPlayTogetherGame = {
+    method: 'post',
+    path: '/v1/join-play-together-game',
+    baseUrl: 'https://gamejoin.roblox.com',
+    requestFormat: 'json',
+    serializationMethod: {
+        body: {},
+    },
+    parameters: {
+        body: Roblox_GameJoin_Api_JoinPlayTogetherGameRequest,
+    },
+    response: Roblox_GameJoin_Api_GameJoinResponse,
+    errors: [
+        {
+            status: 400,
+            description: `-1: An unknown error occurred.`,
+            schema: zod_1.z.void(),
+        },
+        {
+            status: 429,
+            description: `3: Too many requests, please slow down.`,
+            schema: zod_1.z.void(),
+        },
+    ],
+};
+/**
+ * @api post https://gamejoin.roblox.com/v1/join-private-game
+ * @param body The Roblox.GameJoin.Api.JoinPrivateGameRequest in JSON format
+ */
+exports.postJoinPrivateGame = {
+    method: 'post',
+    path: '/v1/join-private-game',
+    baseUrl: 'https://gamejoin.roblox.com',
+    requestFormat: 'json',
+    serializationMethod: {
+        body: {},
+    },
+    parameters: {
+        body: Roblox_GameJoin_Api_JoinPrivateGameRequest,
+    },
+    response: Roblox_GameJoin_Api_GameJoinResponse,
+    errors: [
+        {
+            status: 400,
+            description: `-1: An unknown error occurred.`,
+            schema: zod_1.z.void(),
+        },
+        {
+            status: 429,
+            description: `3: Too many requests, please slow down.`,
+            schema: zod_1.z.void(),
+        },
+    ],
+};
+/**
+ * @api post https://gamejoin.roblox.com/v1/join-reserved-game
+ * @param body The Roblox.GameJoin.Api.JoinReservedGameRequest in JSON format
+ */
+exports.postJoinReservedGame = {
+    method: 'post',
+    path: '/v1/join-reserved-game',
+    baseUrl: 'https://gamejoin.roblox.com',
+    requestFormat: 'json',
+    serializationMethod: {
+        body: {},
+    },
+    parameters: {
+        body: Roblox_GameJoin_Api_JoinReservedGameRequest,
+    },
+    response: Roblox_GameJoin_Api_GameJoinResponse,
+    errors: [
+        {
+            status: 400,
+            description: `-1: An unknown error occurred.`,
+            schema: zod_1.z.void(),
+        },
+        {
+            status: 429,
+            description: `3: Too many requests, please slow down.`,
+            schema: zod_1.z.void(),
+        },
+    ],
+};
+/**
+ * @api post https://gamejoin.roblox.com/v1/play-with-user
+ * @param body The Roblox.GameJoin.Api.PlayWithUserRequest in JSON format
+ */
+exports.postPlayWithUser = {
+    method: 'post',
+    path: '/v1/play-with-user',
+    baseUrl: 'https://gamejoin.roblox.com',
+    requestFormat: 'json',
+    serializationMethod: {
+        body: {},
+    },
+    parameters: {
+        body: Roblox_GameJoin_Api_PlayWithUserRequest,
+    },
+    response: Roblox_GameJoin_Api_GameJoinResponse,
+    errors: [
+        {
+            status: 400,
+            description: `-1: An unknown error occurred.`,
+            schema: zod_1.z.void(),
+        },
+        {
+            status: 429,
+            description: `3: Too many requests, please slow down.`,
+            schema: zod_1.z.void(),
+        },
+    ],
+};
+/**
+ * @api post https://gamejoin.roblox.com/v1/team-create
+ * @param body The Roblox.GameJoin.Api.TeamCreateRequest in JSON format
+ */
+exports.postTeamCreate = {
+    method: 'post',
+    path: '/v1/team-create',
+    baseUrl: 'https://gamejoin.roblox.com',
+    description: `Xsrf protection disabled because it will only be used on Roblox clients. Adding an extra
+round-trip would impact client performance.`,
+    requestFormat: 'json',
+    serializationMethod: {
+        body: {},
+    },
+    parameters: {
+        body: Roblox_GameJoin_Api_TeamCreateRequest,
+    },
+    response: Roblox_GameJoin_Api_TeamCreateResponse,
+    errors: [
+        {
+            status: 400,
+            description: `-1: An unknown error occurred.`,
+            schema: zod_1.z.void(),
+        },
+        {
+            status: 403,
+            description: `1: Request is not authorized from specified origin.
+2: User is invalid or does not exist.`,
+            schema: zod_1.z.void(),
+        },
+        {
+            status: 429,
+            description: `3: Too many requests, please slow down.`,
+            schema: zod_1.z.void(),
+        },
+    ],
+};
+/**
+ * @api post https://gamejoin.roblox.com/v1/team-create-preemptive
+ * @param body The Roblox.GameJoin.Api.TeamCreateRequest in JSON format
+ */
+exports.postTeamCreatePreemptive = {
+    method: 'post',
+    path: '/v1/team-create-preemptive',
+    baseUrl: 'https://gamejoin.roblox.com',
+    description: `Since the request origin might not be Roblox software, this endpoint implements a different set of security rules.
+More specifically, it requires Xsrf protection and disables user-agent check so that it can be called from browsers.`,
+    requestFormat: 'json',
+    serializationMethod: {
+        body: {},
+    },
+    parameters: {
+        body: Roblox_GameJoin_Api_TeamCreateRequest,
+    },
+    response: Roblox_GameJoin_Api_TeamCreateResponse,
+    errors: [
+        {
+            status: 400,
+            description: `-1: An unknown error occurred.`,
+            schema: zod_1.z.void(),
+        },
+        {
+            status: 403,
+            description: `0: Token Validation Failed
+1: Request is not authorized from specified origin.
+2: User is invalid or does not exist.`,
+            schema: zod_1.z.void(),
+        },
+        {
+            status: 429,
+            description: `3: Too many requests, please slow down.`,
+            schema: zod_1.z.void(),
+        },
+    ],
+};

package/lib/endpoints/gamesv1.d.ts

@@ -280,6 +280,7 @@ export declare const getGamesPlaceidPrivateServers: {
             id: string;
             name: string;
             playing: number;
+            accessCode: string;
             maxPlayers: number;
             playerTokens: string[];
             players: {
@@ -291,7 +292,6 @@ export declare const getGamesPlaceidPrivateServers: {
             fps: number;
             ping: number;
             vipServerId: number;
-            accessCode: string;
             owner: {
                 id: number;
                 name: string;
@@ -302,6 +302,7 @@ export declare const getGamesPlaceidPrivateServers: {
             id: string;
             name: string;
             playing: number;
+            accessCode: string;
             maxPlayers: number;
             playerTokens: string[];
             players: {
@@ -313,7 +314,6 @@ export declare const getGamesPlaceidPrivateServers: {
             fps: number;
             ping: number;
             vipServerId: number;
-            accessCode: string;
             owner: {
                 id: number;
                 name: string;
@@ -326,6 +326,7 @@ export declare const getGamesPlaceidPrivateServers: {
             id: string;
             name: string;
             playing: number;
+            accessCode: string;
             maxPlayers: number;
             playerTokens: string[];
             players: {
@@ -337,7 +338,6 @@ export declare const getGamesPlaceidPrivateServers: {
             fps: number;
             ping: number;
             vipServerId: number;
-            accessCode: string;
             owner: {
                 id: number;
                 name: string;
@@ -352,6 +352,7 @@ export declare const getGamesPlaceidPrivateServers: {
             id: string;
             name: string;
             playing: number;
+            accessCode: string;
             maxPlayers: number;
             playerTokens: string[];
             players: {
@@ -363,7 +364,6 @@ export declare const getGamesPlaceidPrivateServers: {
             fps: number;
             ping: number;
             vipServerId: number;
-            accessCode: string;
             owner: {
                 id: number;
                 name: string;
@@ -475,6 +475,7 @@ export declare const getGamesPlaceidServersServertype: {
             id: string;
             name: string;
             playing: number;
+            accessCode: string;
             maxPlayers: number;
             playerTokens: string[];
             players: {
@@ -486,7 +487,6 @@ export declare const getGamesPlaceidServersServertype: {
             fps: number;
             ping: number;
             vipServerId: number;
-            accessCode: string;
             owner: {
                 id: number;
                 name: string;
@@ -497,6 +497,7 @@ export declare const getGamesPlaceidServersServertype: {
             id: string;
             name: string;
             playing: number;
+            accessCode: string;
             maxPlayers: number;
             playerTokens: string[];
             players: {
@@ -508,7 +509,6 @@ export declare const getGamesPlaceidServersServertype: {
             fps: number;
             ping: number;
             vipServerId: number;
-            accessCode: string;
             owner: {
                 id: number;
                 name: string;
@@ -521,6 +521,7 @@ export declare const getGamesPlaceidServersServertype: {
             id: string;
             name: string;
             playing: number;
+            accessCode: string;
             maxPlayers: number;
             playerTokens: string[];
             players: {
@@ -532,7 +533,6 @@ export declare const getGamesPlaceidServersServertype: {
             fps: number;
             ping: number;
             vipServerId: number;
-            accessCode: string;
             owner: {
                 id: number;
                 name: string;
@@ -547,6 +547,7 @@ export declare const getGamesPlaceidServersServertype: {
             id: string;
             name: string;
             playing: number;
+            accessCode: string;
             maxPlayers: number;
             playerTokens: string[];
             players: {
@@ -558,7 +559,6 @@ export declare const getGamesPlaceidServersServertype: {
             fps: number;
             ping: number;
             vipServerId: number;
-            accessCode: string;
             owner: {
                 id: number;
                 name: string;
@@ -2304,6 +2304,7 @@ export declare const postGamesVipServersUniverseid: {
         id: string;
         name: string;
         playing: number;
+        accessCode: string;
         maxPlayers: number;
         playerTokens: string[];
         players: {
@@ -2315,7 +2316,6 @@ export declare const postGamesVipServersUniverseid: {
         fps: number;
         ping: number;
         vipServerId: number;
-        accessCode: string;
         owner: {
             id: number;
             name: string;
@@ -2326,6 +2326,7 @@ export declare const postGamesVipServersUniverseid: {
         id: string;
         name: string;
         playing: number;
+        accessCode: string;
         maxPlayers: number;
         playerTokens: string[];
         players: {
@@ -2337,7 +2338,6 @@ export declare const postGamesVipServersUniverseid: {
         fps: number;
         ping: number;
         vipServerId: number;
-        accessCode: string;
         owner: {
             id: number;
             name: string;
@@ -2465,6 +2465,7 @@ export declare const getPrivateServers: {
             id: string;
             name: string;
             playing: number;
+            accessCode: string;
             maxPlayers: number;
             playerTokens: string[];
             players: {
@@ -2476,7 +2477,6 @@ export declare const getPrivateServers: {
             fps: number;
             ping: number;
             vipServerId: number;
-            accessCode: string;
             owner: {
                 id: number;
                 name: string;
@@ -2487,6 +2487,7 @@ export declare const getPrivateServers: {
             id: string;
             name: string;
             playing: number;
+            accessCode: string;
             maxPlayers: number;
             playerTokens: string[];
             players: {
@@ -2498,7 +2499,6 @@ export declare const getPrivateServers: {
             fps: number;
             ping: number;
             vipServerId: number;
-            accessCode: string;
             owner: {
                 id: number;
                 name: string;
@@ -2511,6 +2511,7 @@ export declare const getPrivateServers: {
             id: string;
             name: string;
             playing: number;
+            accessCode: string;
             maxPlayers: number;
             playerTokens: string[];
             players: {
@@ -2522,7 +2523,6 @@ export declare const getPrivateServers: {
             fps: number;
             ping: number;
             vipServerId: number;
-            accessCode: string;
             owner: {
                 id: number;
                 name: string;
@@ -2535,6 +2535,7 @@ export declare const getPrivateServers: {
             id: string;
             name: string;
             playing: number;
+            accessCode: string;
             maxPlayers: number;
             playerTokens: string[];
             players: {
@@ -2546,7 +2547,6 @@ export declare const getPrivateServers: {
             fps: number;
             ping: number;
             vipServerId: number;
-            accessCode: string;
             owner: {
                 id: number;
                 name: string;

package/lib/index.d.ts

@@ -6,7 +6,7 @@ export type EndpointSchema = {
     path: string;
     baseUrl: string;
     serializationMethod?: Record<string, {
-        style: string;
+        style?: string;
         explode?: boolean;
     }>;
     requestFormat?: RequestFormat;

package/lib/index.js

@@ -53,7 +53,7 @@ async function fetchApi(endpoint, params, requestOptions = { mode: 'cors', crede
             continue;
         }
         const { style, explode } = endpoint.serializationMethod[key];
-        if (!Array.isArray(value)) {
+        if (!Array.isArray(value) || !style) {
             queryParams[key] = String(value);
             continue;
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rozod",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "description": "Wrapper for Roblox API using Zod and custom API Client using fetch",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -35,6 +35,7 @@
     "ts-jest": "^29.1.0",
     "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0",
+    "typedoc": "^0.24.6",
     "typescript": "^5.0.4"
   },
   "keywords": [],