rozod 1.0.0

package/lib/endpoints/usersv1.js

@@ -0,0 +1,344 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getV1userssearch = exports.getV1usersauthenticatedroles = exports.getV1usersauthenticatedcountryCode = exports.getV1usersauthenticatedageBracket = exports.getV1usersauthenticated = exports.getV1usersUserIdusernameHistory = exports.getV1usersUserIddisplayNamesvalidate = exports.patchV1usersUserIddisplayNames = exports.getV1usersUserId = exports.postV1users = exports.postV1usernamesusers = exports.getV1displayNamesvalidate = void 0;
+var zod_1 = require("zod");
+var Roblox_Web_WebAPI_ApiEmptyResponseModel = zod_1.z.object({}).partial();
+var Roblox_Users_Api_GetUserResponse = zod_1.z
+    .object({
+    description: zod_1.z.string(),
+    created: zod_1.z.string().datetime(),
+    isBanned: zod_1.z.boolean(),
+    externalAppDisplayName: zod_1.z.string(),
+    hasVerifiedBadge: zod_1.z.boolean(),
+    id: zod_1.z.number().int(),
+    name: zod_1.z.string(),
+    displayName: zod_1.z.string(),
+})
+    .partial();
+var Roblox_Users_Api_UsernameHistoryResponse = zod_1.z.object({ name: zod_1.z.string() }).partial();
+var Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Users_Api_UsernameHistoryResponse_ = zod_1.z
+    .object({
+    previousPageCursor: zod_1.z.string(),
+    nextPageCursor: zod_1.z.string(),
+    data: zod_1.z.array(Roblox_Users_Api_UsernameHistoryResponse),
+})
+    .partial();
+var Roblox_Users_Api_AuthenticatedUserResponse = zod_1.z
+    .object({ id: zod_1.z.number().int(), name: zod_1.z.string(), displayName: zod_1.z.string() })
+    .partial();
+var Roblox_Users_Api_UserAgeBracketResponse = zod_1.z.object({ ageBracket: zod_1.z.number().int() }).partial();
+var Roblox_Users_Api_UserCountryCodeResponse = zod_1.z.object({ countryCode: zod_1.z.string() }).partial();
+var Roblox_Users_Api_UserRolesResponse = zod_1.z.object({ roles: zod_1.z.array(zod_1.z.string()) }).partial();
+var Roblox_Users_Api_UserSearchResponse = zod_1.z
+    .object({
+    previousUsernames: zod_1.z.array(zod_1.z.string()),
+    hasVerifiedBadge: zod_1.z.boolean(),
+    id: zod_1.z.number().int(),
+    name: zod_1.z.string(),
+    displayName: zod_1.z.string(),
+})
+    .partial();
+var Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Users_Api_UserSearchResponse_ = zod_1.z
+    .object({
+    previousPageCursor: zod_1.z.string(),
+    nextPageCursor: zod_1.z.string(),
+    data: zod_1.z.array(Roblox_Users_Api_UserSearchResponse),
+})
+    .partial();
+var Roblox_Users_Api_MultiGetByUsernameRequest = zod_1.z
+    .object({ usernames: zod_1.z.array(zod_1.z.string()), excludeBannedUsers: zod_1.z.boolean() })
+    .partial();
+var Roblox_Users_Api_MultiGetUserByNameResponse = zod_1.z
+    .object({
+    requestedUsername: zod_1.z.string(),
+    hasVerifiedBadge: zod_1.z.boolean(),
+    id: zod_1.z.number().int(),
+    name: zod_1.z.string(),
+    displayName: zod_1.z.string(),
+})
+    .partial();
+var Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Users_Api_MultiGetUserByNameResponse_ = zod_1.z
+    .object({ data: zod_1.z.array(Roblox_Users_Api_MultiGetUserByNameResponse) })
+    .partial();
+var Roblox_Users_Api_MultiGetByUserIdRequest = zod_1.z
+    .object({ userIds: zod_1.z.array(zod_1.z.number()), excludeBannedUsers: zod_1.z.boolean() })
+    .partial();
+var Roblox_Users_Api_VerifiedBadgeUserResponse = zod_1.z
+    .object({
+    hasVerifiedBadge: zod_1.z.boolean(),
+    id: zod_1.z.number().int(),
+    name: zod_1.z.string(),
+    displayName: zod_1.z.string(),
+})
+    .partial();
+var Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Users_Api_VerifiedBadgeUserResponse_ = zod_1.z
+    .object({ data: zod_1.z.array(Roblox_Users_Api_VerifiedBadgeUserResponse) })
+    .partial();
+var Roblox_Users_Api_SetDisplayNameRequest = zod_1.z.object({ newDisplayName: zod_1.z.string() }).partial();
+var schemas = {
+    Roblox_Web_WebAPI_ApiEmptyResponseModel: Roblox_Web_WebAPI_ApiEmptyResponseModel,
+    Roblox_Users_Api_GetUserResponse: Roblox_Users_Api_GetUserResponse,
+    Roblox_Users_Api_UsernameHistoryResponse: Roblox_Users_Api_UsernameHistoryResponse,
+    Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Users_Api_UsernameHistoryResponse_: Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Users_Api_UsernameHistoryResponse_,
+    Roblox_Users_Api_AuthenticatedUserResponse: Roblox_Users_Api_AuthenticatedUserResponse,
+    Roblox_Users_Api_UserAgeBracketResponse: Roblox_Users_Api_UserAgeBracketResponse,
+    Roblox_Users_Api_UserCountryCodeResponse: Roblox_Users_Api_UserCountryCodeResponse,
+    Roblox_Users_Api_UserRolesResponse: Roblox_Users_Api_UserRolesResponse,
+    Roblox_Users_Api_UserSearchResponse: Roblox_Users_Api_UserSearchResponse,
+    Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Users_Api_UserSearchResponse_: Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Users_Api_UserSearchResponse_,
+    Roblox_Users_Api_MultiGetByUsernameRequest: Roblox_Users_Api_MultiGetByUsernameRequest,
+    Roblox_Users_Api_MultiGetUserByNameResponse: Roblox_Users_Api_MultiGetUserByNameResponse,
+    Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Users_Api_MultiGetUserByNameResponse_: Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Users_Api_MultiGetUserByNameResponse_,
+    Roblox_Users_Api_MultiGetByUserIdRequest: Roblox_Users_Api_MultiGetByUserIdRequest,
+    Roblox_Users_Api_VerifiedBadgeUserResponse: Roblox_Users_Api_VerifiedBadgeUserResponse,
+    Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Users_Api_VerifiedBadgeUserResponse_: Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Users_Api_VerifiedBadgeUserResponse_,
+    Roblox_Users_Api_SetDisplayNameRequest: Roblox_Users_Api_SetDisplayNameRequest,
+};
+exports.getV1displayNamesvalidate = {
+    method: 'get',
+    path: '/v1/display-names/validate',
+    baseUrl: 'https://users.roblox.com',
+    requestFormat: 'json',
+    parameters: {
+        displayName: zod_1.z.string(),
+        birthdate: zod_1.z.string().datetime(),
+    },
+    response: zod_1.z.object({}).partial(),
+    errors: [
+        {
+            status: 400,
+            description: "1: Display name is too short\n2: Display name is too long\n3: Display name contains invalid characters\n4: Display name has been moderated\n6: Request must contain a birthdate",
+            schema: zod_1.z.void(),
+        },
+        {
+            status: 429,
+            description: "5: Display name updates for this user have been throttled",
+            schema: zod_1.z.void(),
+        },
+    ],
+};
+exports.postV1usernamesusers = {
+    method: 'post',
+    path: '/v1/usernames/users',
+    baseUrl: 'https://users.roblox.com',
+    description: "This endpoint will also check previous usernames.\nDoes not require X-CSRF-Token protection because this is essentially a get request but as a POST to avoid URI limits.",
+    requestFormat: 'json',
+    parameters: {
+        body: Roblox_Users_Api_MultiGetByUsernameRequest,
+    },
+    response: Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Users_Api_MultiGetUserByNameResponse_,
+    errors: [
+        {
+            status: 400,
+            description: "2: Too many usernames.",
+            schema: zod_1.z.void(),
+        },
+    ],
+};
+exports.postV1users = {
+    method: 'post',
+    path: '/v1/users',
+    baseUrl: 'https://users.roblox.com',
+    description: "Does not require X-CSRF-Token protection because this is essentially a get request but as a POST to avoid URI limits.",
+    requestFormat: 'json',
+    parameters: {
+        body: Roblox_Users_Api_MultiGetByUserIdRequest,
+    },
+    response: Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Users_Api_VerifiedBadgeUserResponse_,
+    errors: [
+        {
+            status: 400,
+            description: "1: Too many ids.",
+            schema: zod_1.z.void(),
+        },
+    ],
+};
+exports.getV1usersUserId = {
+    method: 'get',
+    path: '/v1/users/:userId',
+    baseUrl: 'https://users.roblox.com',
+    requestFormat: 'json',
+    parameters: {
+        userId: zod_1.z.number().int(),
+    },
+    response: Roblox_Users_Api_GetUserResponse,
+    errors: [
+        {
+            status: 404,
+            description: "3: The user id is invalid.",
+            schema: zod_1.z.void(),
+        },
+    ],
+};
+exports.patchV1usersUserIddisplayNames = {
+    method: 'patch',
+    path: '/v1/users/:userId/display-names',
+    baseUrl: 'https://users.roblox.com',
+    requestFormat: 'json',
+    parameters: {
+        body: zod_1.z.object({ newDisplayName: zod_1.z.string() }).partial(),
+        userId: zod_1.z.number().int(),
+    },
+    response: zod_1.z.object({}).partial(),
+    errors: [
+        {
+            status: 400,
+            description: "1: Display name is too short\n2: Display name is too long\n3: Display name contains invalid characters\n4: Display name has been moderated",
+            schema: zod_1.z.void(),
+        },
+        {
+            status: 401,
+            description: "0: Authorization has been denied for this request.",
+            schema: zod_1.z.void(),
+        },
+        {
+            status: 403,
+            description: "0: Token Validation Failed\n7: The user id is invalid.",
+            schema: zod_1.z.void(),
+        },
+        {
+            status: 429,
+            description: "5: Display name updates for this user have been throttled",
+            schema: zod_1.z.void(),
+        },
+    ],
+};
+exports.getV1usersUserIddisplayNamesvalidate = {
+    method: 'get',
+    path: '/v1/users/:userId/display-names/validate',
+    baseUrl: 'https://users.roblox.com',
+    requestFormat: 'json',
+    parameters: {
+        userId: zod_1.z.number().int(),
+        displayName: zod_1.z.string(),
+    },
+    response: zod_1.z.object({}).partial(),
+    errors: [
+        {
+            status: 400,
+            description: "1: Display name is too short\n2: Display name is too long\n3: Display name contains invalid characters\n4: Display name has been moderated",
+            schema: zod_1.z.void(),
+        },
+        {
+            status: 401,
+            description: "0: Authorization has been denied for this request.",
+            schema: zod_1.z.void(),
+        },
+        {
+            status: 403,
+            description: "7: The user id is invalid.",
+            schema: zod_1.z.void(),
+        },
+        {
+            status: 429,
+            description: "5: Display name updates for this user have been throttled",
+            schema: zod_1.z.void(),
+        },
+    ],
+};
+exports.getV1usersUserIdusernameHistory = {
+    method: 'get',
+    path: '/v1/users/:userId/username-history',
+    baseUrl: 'https://users.roblox.com',
+    requestFormat: 'json',
+    parameters: {
+        userId: zod_1.z.number().int(),
+        limit: zod_1.z
+            .union([zod_1.z.literal(10), zod_1.z.literal(25), zod_1.z.literal(50), zod_1.z.literal(100)])
+            .optional()
+            .default(10),
+        cursor: zod_1.z.string().optional(),
+        sortOrder: zod_1.z.enum(['Asc', 'Desc']).optional().default('Asc'),
+    },
+    response: Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Users_Api_UsernameHistoryResponse_,
+    errors: [
+        {
+            status: 400,
+            description: "3: The user id is invalid.",
+            schema: zod_1.z.void(),
+        },
+    ],
+};
+exports.getV1usersauthenticated = {
+    method: 'get',
+    path: '/v1/users/authenticated',
+    baseUrl: 'https://users.roblox.com',
+    requestFormat: 'json',
+    response: Roblox_Users_Api_AuthenticatedUserResponse,
+    errors: [
+        {
+            status: 401,
+            description: "0: Authorization has been denied for this request.",
+            schema: zod_1.z.void(),
+        },
+    ],
+};
+exports.getV1usersauthenticatedageBracket = {
+    method: 'get',
+    path: '/v1/users/authenticated/age-bracket',
+    baseUrl: 'https://users.roblox.com',
+    requestFormat: 'json',
+    response: zod_1.z.object({ ageBracket: zod_1.z.number().int() }).partial(),
+    errors: [
+        {
+            status: 401,
+            description: "0: Authorization has been denied for this request.",
+            schema: zod_1.z.void(),
+        },
+    ],
+};
+exports.getV1usersauthenticatedcountryCode = {
+    method: 'get',
+    path: '/v1/users/authenticated/country-code',
+    baseUrl: 'https://users.roblox.com',
+    requestFormat: 'json',
+    response: zod_1.z.object({ countryCode: zod_1.z.string() }).partial(),
+    errors: [
+        {
+            status: 401,
+            description: "0: Authorization has been denied for this request.",
+            schema: zod_1.z.void(),
+        },
+    ],
+};
+exports.getV1usersauthenticatedroles = {
+    method: 'get',
+    path: '/v1/users/authenticated/roles',
+    baseUrl: 'https://users.roblox.com',
+    requestFormat: 'json',
+    response: Roblox_Users_Api_UserRolesResponse,
+    errors: [
+        {
+            status: 401,
+            description: "0: Authorization has been denied for this request.",
+            schema: zod_1.z.void(),
+        },
+    ],
+};
+exports.getV1userssearch = {
+    method: 'get',
+    path: '/v1/users/search',
+    baseUrl: 'https://users.roblox.com',
+    requestFormat: 'json',
+    parameters: {
+        keyword: zod_1.z.string(),
+        limit: zod_1.z
+            .union([zod_1.z.literal(10), zod_1.z.literal(25), zod_1.z.literal(50), zod_1.z.literal(100)])
+            .optional()
+            .default(10),
+        cursor: zod_1.z.string().optional(),
+    },
+    response: Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Users_Api_UserSearchResponse_,
+    errors: [
+        {
+            status: 400,
+            description: "5: The keyword was filtered.\n6: The keyword is too short.",
+            schema: zod_1.z.void(),
+        },
+        {
+            status: 429,
+            description: "4: Too many requests.",
+            schema: zod_1.z.void(),
+        },
+    ],
+};

package/lib/index.d.ts

@@ -0,0 +1,85 @@
+import { z } from 'zod';
+type RequestMethod = 'get' | 'post' | 'put' | 'delete';
+type RequestFormat = 'json' | 'text';
+type EndpointSchema = {
+    method: RequestMethod;
+    path: string;
+    baseUrl: string;
+    requestFormat: RequestFormat;
+    parameters: Record<string, z.Schema<any>>;
+    response: z.Schema<any>;
+    errors: {
+        status: number;
+        description: string;
+        schema: z.Schema<any>;
+    }[];
+};
+type ExtractRequiredParams<S extends EndpointSchema> = {
+    [K in keyof S['parameters']]: S['parameters'][K] extends z.ZodOptional<any> | z.ZodDefault<any> ? never : K;
+}[keyof S['parameters']];
+type ExtractOptionalParams<S extends EndpointSchema> = {
+    [K in keyof S['parameters']]: S['parameters'][K] extends z.ZodOptional<any> | z.ZodDefault<any> ? K : never;
+}[keyof S['parameters']];
+type ExtractParams<S extends EndpointSchema> = {
+    [K in ExtractRequiredParams<S>]: z.infer<S['parameters'][K]>;
+} & Partial<{
+    [K in ExtractOptionalParams<S>]: z.infer<S['parameters'][K]>;
+}>;
+type ExtractResponse<S extends EndpointSchema> = z.infer<S['response']>;
+/**
+ * Fetches the data from the given endpoint and returns it.
+ *
+ * @param endpoint The endpoint to fetch from.
+ * @param params The parameters to pass to the endpoint.
+ * @param requestOptions Any additional options to pass to fetch.
+ * @returns The response from the endpoint.
+ */
+declare function fetchApi<S extends EndpointSchema>(endpoint: S, params: ExtractParams<S>, requestOptions?: RequestInit): Promise<ExtractResponse<S>>;
+/**
+ * Fetches the data from the given endpoint, but splits the request into multiple requests if the specified parameter is larger than max specified.
+ *
+ * @param endpoint The endpoint to fetch from.
+ * @param params The parameters to pass to the endpoint.
+ * @param max The maximum number of items to pass to the endpoint.
+ * @param transform A function that accepts the endpoint response and transforms it into the desired type.
+ * @param requestOptions Any additional options to pass to fetch.
+ * @returns The transformed response from the endpoint.
+ * @example
+ * ```ts
+ * const data = await fetchApiSplit(getV1gamesicons, { universeIds: [1, 2, 3, 4, 5] }, { universeIds: 100 }, (response) => response.data);
+ * console.log(data); // [[{ "targetId": 0, "state": "Completed", "imageUrl": "..." }], ...]
+ * ```
+ */
+declare function fetchApiSplit<S extends EndpointSchema, T = ExtractResponse<S>>(endpoint: S, params: ExtractParams<S>, max?: Partial<{
+    [K in keyof ExtractParams<S>]: number;
+}>, transform?: (response: ExtractResponse<S>) => T, requestOptions?: RequestInit): Promise<T[]>;
+/**
+ * Fetches all pages of results for the given endpoint and parameters.
+ *
+ * @param endpoint The endpoint to fetch.
+ * @param initialParams The initial parameters to use for the endpoint.
+ * @param requestOptions The options to use when making requests.
+ * @param limit The maximum number of pages to fetch.
+ * @returns An array of all results.
+ */
+declare function fetchApiPages<S extends EndpointSchema>(endpoint: S, initialParams: Omit<ExtractParams<S>, 'cursor'>, requestOptions?: RequestInit, limit?: number): Promise<ExtractResponse<S>[]>;
+/**
+ * Fetches all pages of results for the given endpoint and parameters.
+ * This is a generator function that yields each page as it is fetched.
+ *
+ * @param endpoint The endpoint to fetch.
+ * @param initialParams The initial parameters to use for the endpoint.
+ * @param requestOptions The options to use when making requests.
+ * @param limit The maximum number of pages to fetch.
+ * @returns An array of all results.
+ * @yields The next page of results.
+ * @example
+ * ```ts
+ * const pages = fetchApiPagesGenerator(getV1badgesicons, { badgeIds: [1, 2, 3] });
+ * for await (const page of pages) {
+ *    console.log(page.data);
+ * }
+ * ```
+ */
+declare function fetchApiPagesGenerator<S extends EndpointSchema>(endpoint: S, initialParams: Omit<ExtractParams<S>, 'cursor'>, requestOptions?: RequestInit, limit?: number): AsyncGenerator<ExtractResponse<S>, void, unknown>;
+export { fetchApi, fetchApiSplit, fetchApiPages, fetchApiPagesGenerator };