@valpro-labs/valorant-api 1.1.0 → 1.3.0

package/dist/endpoints/ThemesEndpoints.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ThemesEndpoints = void 0;
+const BaseEndpoint_1 = require("./BaseEndpoint");
+/**
+ * Provides access to the Valorant API themes endpoints.
+ */
+class ThemesEndpoints extends BaseEndpoint_1.BaseEndpoint {
+    constructor(config) {
+        super(config);
+    }
+    /**
+     * Get all themes.
+     * @returns An array of {@link ThemeResponse} objects.
+     */
+    async getThemesV1() {
+        return this.requestValorantApi('v1/themes');
+    }
+    /**
+     * Get a theme by its UUID.
+     * @param uuid - The UUID of the theme.
+     * @returns The {@link ThemeResponse} matching the given UUID.
+     */
+    async getThemeByUuidV1(uuid) {
+        return this.requestValorantApi(`v1/themes/${uuid}`);
+    }
+}
+exports.ThemesEndpoints = ThemesEndpoints;

package/dist/endpoints/VersionEndpoint.d.ts

@@ -1,7 +1,14 @@
 import { BaseEndpoint, ValorantApiConfig } from './BaseEndpoint';
 import { VersionResponse } from '../schemas';
+/**
+ * Provides access to the Valorant API version endpoint.
+ */
 declare class VersionEndpoint extends BaseEndpoint {
     constructor(config?: ValorantApiConfig);
+    /**
+     * Get the current Valorant build version info.
+     * @returns The current {@link VersionResponse} information.
+     */
     getVersionV1(): Promise<VersionResponse>;
 }
 export { VersionEndpoint };

package/dist/endpoints/VersionEndpoint.js

@@ -2,10 +2,17 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VersionEndpoint = void 0;
 const BaseEndpoint_1 = require("./BaseEndpoint");
+/**
+ * Provides access to the Valorant API version endpoint.
+ */
 class VersionEndpoint extends BaseEndpoint_1.BaseEndpoint {
     constructor(config) {
         super(config);
     }
+    /**
+     * Get the current Valorant build version info.
+     * @returns The current {@link VersionResponse} information.
+     */
     async getVersionV1() {
         return this.requestValorantApi('v1/version');
     }

package/dist/endpoints/WeaponsEndpoints.d.ts

@@ -1,8 +1,43 @@
 import { BaseEndpoint, ValorantApiConfig } from './BaseEndpoint';
-import { WeaponResponse, WeaponsResponse } from '../schemas';
+import { WeaponResponse, WeaponsResponse, SkinResponse, ChromaResponse, LevelResponse } from '../schemas';
+/**
+ * Provides access to the Valorant API weapons endpoints.
+ */
 declare class WeaponsEndpoints extends BaseEndpoint {
     constructor(config?: ValorantApiConfig);
+    /**
+     * Get all weapons.
+     * @returns An array of {@link WeaponResponse} objects.
+     */
     getWeaponsV1(): Promise<WeaponsResponse>;
+    /**
+     * Get a weapon by its UUID.
+     * @param uuid - The UUID of the weapon.
+     * @returns The {@link WeaponResponse} matching the given UUID.
+     */
     getWeaponByUuidV1(uuid: string): Promise<WeaponResponse>;
+    /**
+     * Get all weapon skins.
+     * @returns An array of {@link SkinResponse} objects.
+     */
+    getWeaponSkinsV1(): Promise<SkinResponse[]>;
+    /**
+     * Get a weapon skin by its UUID.
+     * @param uuid - The UUID of the weapon skin.
+     * @returns The {@link SkinResponse} matching the given UUID.
+     */
+    getWeaponSkinByUuidV1(uuid: string): Promise<SkinResponse>;
+    /**
+     * Get a weapon skin chroma by its UUID.
+     * @param uuid - The UUID of the weapon skin chroma.
+     * @returns The {@link ChromaResponse} matching the given UUID.
+     */
+    getWeaponSkinChromaByUuidV1(uuid: string): Promise<ChromaResponse>;
+    /**
+     * Get a weapon skin level by its UUID.
+     * @param uuid - The UUID of the weapon skin level.
+     * @returns The {@link LevelResponse} matching the given UUID.
+     */
+    getWeaponSkinLevelByUuidV1(uuid: string): Promise<LevelResponse>;
 }
 export { WeaponsEndpoints };

package/dist/endpoints/WeaponsEndpoints.js

@@ -2,15 +2,58 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WeaponsEndpoints = void 0;
 const BaseEndpoint_1 = require("./BaseEndpoint");
+/**
+ * Provides access to the Valorant API weapons endpoints.
+ */
 class WeaponsEndpoints extends BaseEndpoint_1.BaseEndpoint {
     constructor(config) {
         super(config);
     }
+    /**
+     * Get all weapons.
+     * @returns An array of {@link WeaponResponse} objects.
+     */
     async getWeaponsV1() {
         return this.requestValorantApi('v1/weapons');
     }
+    /**
+     * Get a weapon by its UUID.
+     * @param uuid - The UUID of the weapon.
+     * @returns The {@link WeaponResponse} matching the given UUID.
+     */
     async getWeaponByUuidV1(uuid) {
         return this.requestValorantApi(`v1/weapons/${uuid}`);
     }
+    /**
+     * Get all weapon skins.
+     * @returns An array of {@link SkinResponse} objects.
+     */
+    async getWeaponSkinsV1() {
+        return this.requestValorantApi('v1/weapons/skins');
+    }
+    /**
+     * Get a weapon skin by its UUID.
+     * @param uuid - The UUID of the weapon skin.
+     * @returns The {@link SkinResponse} matching the given UUID.
+     */
+    async getWeaponSkinByUuidV1(uuid) {
+        return this.requestValorantApi(`v1/weapons/skins/${uuid}`);
+    }
+    /**
+     * Get a weapon skin chroma by its UUID.
+     * @param uuid - The UUID of the weapon skin chroma.
+     * @returns The {@link ChromaResponse} matching the given UUID.
+     */
+    async getWeaponSkinChromaByUuidV1(uuid) {
+        return this.requestValorantApi(`v1/weapons/skinchromas/${uuid}`);
+    }
+    /**
+     * Get a weapon skin level by its UUID.
+     * @param uuid - The UUID of the weapon skin level.
+     * @returns The {@link LevelResponse} matching the given UUID.
+     */
+    async getWeaponSkinLevelByUuidV1(uuid) {
+        return this.requestValorantApi(`v1/weapons/skinlevels/${uuid}`);
+    }
 }
 exports.WeaponsEndpoints = WeaponsEndpoints;

package/dist/endpoints/index.d.ts

@@ -1,6 +1,7 @@
 export * from './AgentsEndpoints';
 export * from './BaseEndpoint';
 export * from './BuddiesEndpoints';
+export * from './CeremoniesEndpoints';
 export * from './BundlesEndpoints';
 export * from './CompetitiveTiersEndpoints';
 export * from './ContentTierEndpoints';
@@ -8,6 +9,7 @@ export * from './ContractsEndpoints';
 export * from './CurrenciesEndpoints';
 export * from './EventsEndpoints';
 export * from './FlexEndpoints';
+export * from './GearEndpoints';
 export * from './GameModesEndpoints';
 export * from './LevelBordersEndpoints';
 export * from './MapsEndpoints';
@@ -17,5 +19,6 @@ export * from './PlayerCardsEndpoints';
 export * from './PlayerTitlesEndpoints';
 export * from './SeasonsEndpoints';
 export * from './SpraysEndpoints';
+export * from './ThemesEndpoints';
 export * from './VersionEndpoint';
 export * from './WeaponsEndpoints';

package/dist/endpoints/index.js

@@ -17,6 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./AgentsEndpoints"), exports);
 __exportStar(require("./BaseEndpoint"), exports);
 __exportStar(require("./BuddiesEndpoints"), exports);
+__exportStar(require("./CeremoniesEndpoints"), exports);
 __exportStar(require("./BundlesEndpoints"), exports);
 __exportStar(require("./CompetitiveTiersEndpoints"), exports);
 __exportStar(require("./ContentTierEndpoints"), exports);
@@ -24,6 +25,7 @@ __exportStar(require("./ContractsEndpoints"), exports);
 __exportStar(require("./CurrenciesEndpoints"), exports);
 __exportStar(require("./EventsEndpoints"), exports);
 __exportStar(require("./FlexEndpoints"), exports);
+__exportStar(require("./GearEndpoints"), exports);
 __exportStar(require("./GameModesEndpoints"), exports);
 __exportStar(require("./LevelBordersEndpoints"), exports);
 __exportStar(require("./MapsEndpoints"), exports);
@@ -33,5 +35,6 @@ __exportStar(require("./PlayerCardsEndpoints"), exports);
 __exportStar(require("./PlayerTitlesEndpoints"), exports);
 __exportStar(require("./SeasonsEndpoints"), exports);
 __exportStar(require("./SpraysEndpoints"), exports);
+__exportStar(require("./ThemesEndpoints"), exports);
 __exportStar(require("./VersionEndpoint"), exports);
 __exportStar(require("./WeaponsEndpoints"), exports);

package/dist/schemas/AgentSchemas.d.ts

@@ -1,10 +1,13 @@
 import { z } from 'zod';
+/** Schema for a single agent's voice line media data. */
 export declare const VoiceLineMediaSchema: z.ZodObject<{
     id: z.ZodNumber;
     wwise: z.ZodString;
     wave: z.ZodString;
 }, z.core.$strip>;
+/** A single agent's voice line media data. */
 export type VoiceLineMediaResponse = z.infer<typeof VoiceLineMediaSchema>;
+/** Schema for a single agent's voice line, containing {@link VoiceLineMediaResponse | media data}. */
 export declare const VoiceLineSchema: z.ZodObject<{
     minDuration: z.ZodNumber;
     maxDuration: z.ZodNumber;
@@ -14,7 +17,9 @@ export declare const VoiceLineSchema: z.ZodObject<{
         wave: z.ZodString;
     }, z.core.$strip>>;
 }, z.core.$strip>;
+/** A single agent's voice line. */
 export type VoiceLineResponse = z.infer<typeof VoiceLineSchema>;
+/** Schema for a single agent ability. */
 export declare const AbilitySchema: z.ZodObject<{
     slot: z.ZodString;
     displayName: z.ZodString;
@@ -30,7 +35,9 @@ export declare const AbilitySchema: z.ZodObject<{
         }, z.core.$strip>>;
     }, z.core.$strip>;
 }, z.core.$strip>;
+/** A single agent ability. */
 export type AbilityResponse = z.infer<typeof AbilitySchema>;
+/** Schema for a single agent role. */
 export declare const RoleSchema: z.ZodObject<{
     uuid: z.ZodString;
     displayName: z.ZodString;
@@ -38,7 +45,9 @@ export declare const RoleSchema: z.ZodObject<{
     displayIcon: z.ZodString;
     assetPath: z.ZodString;
 }, z.core.$strip>;
+/** A single agent role. */
 export type RoleResponse = z.infer<typeof RoleSchema>;
+/** Schema for an agent's recruitment data. */
 export declare const RecruitmentDataSchema: z.ZodObject<{
     counterId: z.ZodString;
     milestoneId: z.ZodString;
@@ -48,7 +57,9 @@ export declare const RecruitmentDataSchema: z.ZodObject<{
     startDate: z.ZodString;
     endDate: z.ZodString;
 }, z.core.$strip>;
+/** An agent's recruitment data. */
 export type RecruitmentDataResponse = z.infer<typeof RecruitmentDataSchema>;
+/** Schema for a single agent, including its {@link RoleResponse | role}, {@link AbilityResponse | abilities}, and {@link RecruitmentDataResponse | recruitment data}. */
 export declare const AgentSchema: z.ZodObject<{
     uuid: z.ZodString;
     displayName: z.ZodString;
@@ -103,7 +114,9 @@ export declare const AgentSchema: z.ZodObject<{
         }, z.core.$strip>;
     }, z.core.$strip>>;
 }, z.core.$strip>;
+/** A single agent's data. */
 export type AgentResponse = z.infer<typeof AgentSchema>;
+/** Schema for a list of agents. */
 export declare const AgentsSchema: z.ZodArray<z.ZodObject<{
     uuid: z.ZodString;
     displayName: z.ZodString;
@@ -158,4 +171,5 @@ export declare const AgentsSchema: z.ZodArray<z.ZodObject<{
         }, z.core.$strip>;
     }, z.core.$strip>>;
 }, z.core.$strip>>;
+/** A list of agents. */
 export type AgentsResponse = z.infer<typeof AgentsSchema>;

package/dist/schemas/AgentSchemas.js

@@ -3,16 +3,19 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AgentsSchema = exports.AgentSchema = exports.RecruitmentDataSchema = exports.RoleSchema = exports.AbilitySchema = exports.VoiceLineSchema = exports.VoiceLineMediaSchema = void 0;
 const zod_1 = require("zod");
 const SharedSchemas_1 = require("./SharedSchemas");
+/** Schema for a single agent's voice line media data. */
 exports.VoiceLineMediaSchema = zod_1.z.object({
     id: zod_1.z.number().int(),
     wwise: zod_1.z.string(),
     wave: zod_1.z.string(),
 });
+/** Schema for a single agent's voice line, containing {@link VoiceLineMediaResponse | media data}. */
 exports.VoiceLineSchema = zod_1.z.object({
     minDuration: zod_1.z.number(),
     maxDuration: zod_1.z.number(),
     mediaList: zod_1.z.array(exports.VoiceLineMediaSchema),
 });
+/** Schema for a single agent ability. */
 exports.AbilitySchema = zod_1.z.object({
     slot: zod_1.z.string(),
     displayName: SharedSchemas_1.LocalizedStringSchema,
@@ -20,6 +23,7 @@ exports.AbilitySchema = zod_1.z.object({
     displayIcon: zod_1.z.string(),
     voiceLine: exports.VoiceLineSchema,
 });
+/** Schema for a single agent role. */
 exports.RoleSchema = zod_1.z.object({
     uuid: zod_1.z.string().uuid(),
     displayName: SharedSchemas_1.LocalizedStringSchema,
@@ -27,6 +31,7 @@ exports.RoleSchema = zod_1.z.object({
     displayIcon: zod_1.z.string(),
     assetPath: zod_1.z.string(),
 });
+/** Schema for an agent's recruitment data. */
 exports.RecruitmentDataSchema = zod_1.z.object({
     counterId: zod_1.z.string().uuid(),
     milestoneId: zod_1.z.string().uuid(),
@@ -36,6 +41,7 @@ exports.RecruitmentDataSchema = zod_1.z.object({
     startDate: zod_1.z.string().datetime(),
     endDate: zod_1.z.string().datetime(),
 });
+/** Schema for a single agent, including its {@link RoleResponse | role}, {@link AbilityResponse | abilities}, and {@link RecruitmentDataResponse | recruitment data}. */
 exports.AgentSchema = zod_1.z.object({
     uuid: zod_1.z.string().uuid(),
     displayName: SharedSchemas_1.LocalizedStringSchema,
@@ -62,4 +68,5 @@ exports.AgentSchema = zod_1.z.object({
     recruitmentData: exports.RecruitmentDataSchema,
     abilities: zod_1.z.array(exports.AbilitySchema),
 });
+/** Schema for a list of agents. */
 exports.AgentsSchema = zod_1.z.array(exports.AgentSchema);

package/dist/schemas/BuddySchemas.d.ts

@@ -1,11 +1,14 @@
 import { z } from 'zod';
+/** Schema for a single buddy level. */
 export declare const BuddyLevelSchema: z.ZodObject<{
     uuid: z.ZodString;
     displayName: z.ZodString;
     displayIcon: z.ZodString;
     assetPath: z.ZodString;
 }, z.core.$strip>;
+/** A single buddy level. */
 export type BuddyLevelResponse = z.infer<typeof BuddyLevelSchema>;
+/** Schema for a single buddy (gun charm), including its {@link BuddyLevelResponse | levels}. */
 export declare const BuddySchema: z.ZodObject<{
     uuid: z.ZodString;
     displayName: z.ZodString;
@@ -20,7 +23,9 @@ export declare const BuddySchema: z.ZodObject<{
         assetPath: z.ZodString;
     }, z.core.$strip>>;
 }, z.core.$strip>;
+/** A single buddy (gun charm). */
 export type BuddyResponse = z.infer<typeof BuddySchema>;
+/** Schema for a list of buddies. */
 export declare const BuddiesSchema: z.ZodArray<z.ZodObject<{
     uuid: z.ZodString;
     displayName: z.ZodString;
@@ -35,11 +40,14 @@ export declare const BuddiesSchema: z.ZodArray<z.ZodObject<{
         assetPath: z.ZodString;
     }, z.core.$strip>>;
 }, z.core.$strip>>;
+/** A list of buddies. */
 export type BuddiesResponse = z.infer<typeof BuddiesSchema>;
+/** Schema for a list of buddy levels. */
 export declare const BuddyLevelsSchema: z.ZodArray<z.ZodObject<{
     uuid: z.ZodString;
     displayName: z.ZodString;
     displayIcon: z.ZodString;
     assetPath: z.ZodString;
 }, z.core.$strip>>;
+/** A list of buddy levels. */
 export type BuddyLevelsResponse = z.infer<typeof BuddyLevelsSchema>;

package/dist/schemas/BuddySchemas.js

@@ -2,12 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BuddyLevelsSchema = exports.BuddiesSchema = exports.BuddySchema = exports.BuddyLevelSchema = void 0;
 const zod_1 = require("zod");
+/** Schema for a single buddy level. */
 exports.BuddyLevelSchema = zod_1.z.object({
     uuid: zod_1.z.string().uuid(),
     displayName: zod_1.z.string(),
     displayIcon: zod_1.z.string(),
     assetPath: zod_1.z.string(),
 });
+/** Schema for a single buddy (gun charm), including its {@link BuddyLevelResponse | levels}. */
 exports.BuddySchema = zod_1.z.object({
     uuid: zod_1.z.string().uuid(),
     displayName: zod_1.z.string(),
@@ -17,5 +19,7 @@ exports.BuddySchema = zod_1.z.object({
     assetPath: zod_1.z.string(),
     levels: zod_1.z.array(exports.BuddyLevelSchema),
 });
+/** Schema for a list of buddies. */
 exports.BuddiesSchema = zod_1.z.array(exports.BuddySchema);
+/** Schema for a list of buddy levels. */
 exports.BuddyLevelsSchema = zod_1.z.array(exports.BuddyLevelSchema);

package/dist/schemas/BundleSchemas.d.ts

@@ -1,4 +1,5 @@
 import { z } from 'zod';
+/** Schema for a single store bundle. */
 export declare const BundleSchema: z.ZodObject<{
     uuid: z.ZodString;
     displayName: z.ZodString;
@@ -9,10 +10,13 @@ export declare const BundleSchema: z.ZodObject<{
     useBackgroundGradient: z.ZodBoolean;
     displayIcon: z.ZodString;
     displayIcon2: z.ZodString;
+    displayIcon3: z.ZodString;
     verticalPromoImage: z.ZodString;
     assetPath: z.ZodString;
 }, z.core.$strip>;
+/** A single store bundle. */
 export type BundleResponse = z.infer<typeof BundleSchema>;
+/** Schema for a list of store bundles. */
 export declare const BundlesSchema: z.ZodArray<z.ZodObject<{
     uuid: z.ZodString;
     displayName: z.ZodString;
@@ -23,7 +27,9 @@ export declare const BundlesSchema: z.ZodArray<z.ZodObject<{
     useBackgroundGradient: z.ZodBoolean;
     displayIcon: z.ZodString;
     displayIcon2: z.ZodString;
+    displayIcon3: z.ZodString;
     verticalPromoImage: z.ZodString;
     assetPath: z.ZodString;
 }, z.core.$strip>>;
+/** A list of store bundles. */
 export type BundlesResponse = z.infer<typeof BundlesSchema>;

package/dist/schemas/BundleSchemas.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BundlesSchema = exports.BundleSchema = void 0;
 const zod_1 = require("zod");
+/** Schema for a single store bundle. */
 exports.BundleSchema = zod_1.z.object({
     uuid: zod_1.z.string().uuid(),
     displayName: zod_1.z.string(),
@@ -12,7 +13,9 @@ exports.BundleSchema = zod_1.z.object({
     useBackgroundGradient: zod_1.z.boolean(),
     displayIcon: zod_1.z.string(),
     displayIcon2: zod_1.z.string(),
+    displayIcon3: zod_1.z.string(),
     verticalPromoImage: zod_1.z.string(),
     assetPath: zod_1.z.string(),
 });
+/** Schema for a list of store bundles. */
 exports.BundlesSchema = zod_1.z.array(exports.BundleSchema);

package/dist/schemas/CeremonySchemas.d.ts

@@ -0,0 +1,17 @@
+import { z } from 'zod';
+/** Schema for a single ceremony. */
+export declare const CeremonySchema: z.ZodObject<{
+    uuid: z.ZodString;
+    displayName: z.ZodString;
+    assetPath: z.ZodString;
+}, z.core.$strip>;
+/** A single ceremony. */
+export type CeremonyResponse = z.infer<typeof CeremonySchema>;
+/** Schema for a list of ceremonies. */
+export declare const CeremoniesSchema: z.ZodArray<z.ZodObject<{
+    uuid: z.ZodString;
+    displayName: z.ZodString;
+    assetPath: z.ZodString;
+}, z.core.$strip>>;
+/** A list of ceremonies. */
+export type CeremoniesResponse = z.infer<typeof CeremoniesSchema>;

package/dist/schemas/CeremonySchemas.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CeremoniesSchema = exports.CeremonySchema = void 0;
+const zod_1 = require("zod");
+/** Schema for a single ceremony. */
+exports.CeremonySchema = zod_1.z.object({
+    uuid: zod_1.z.string().uuid(),
+    displayName: zod_1.z.string(),
+    assetPath: zod_1.z.string(),
+});
+/** Schema for a list of ceremonies. */
+exports.CeremoniesSchema = zod_1.z.array(exports.CeremonySchema);

package/dist/schemas/CompetitiveTierSchemas.d.ts

@@ -1,4 +1,5 @@
 import { z } from 'zod';
+/** Schema for a single competitive tier (rank). */
 export declare const TierSchema: z.ZodObject<{
     tier: z.ZodNumber;
     tierName: z.ZodString;
@@ -11,7 +12,9 @@ export declare const TierSchema: z.ZodObject<{
     rankTriangleDownIcon: z.ZodNullable<z.ZodString>;
     rankTriangleUpIcon: z.ZodNullable<z.ZodString>;
 }, z.core.$strip>;
+/** A single competitive tier (rank). */
 export type TierResponse = z.infer<typeof TierSchema>;
+/** Schema for a single competitive tier set, including its {@link TierResponse | tiers}. */
 export declare const CompetitiveTierSetSchema: z.ZodObject<{
     uuid: z.ZodString;
     assetObjectName: z.ZodString;
@@ -29,7 +32,9 @@ export declare const CompetitiveTierSetSchema: z.ZodObject<{
     }, z.core.$strip>>;
     assetPath: z.ZodString;
 }, z.core.$strip>;
+/** A single competitive tier set. */
 export type CompetitiveTierSetResponse = z.infer<typeof CompetitiveTierSetSchema>;
+/** Schema for a list of competitive tier sets. */
 export declare const CompetitiveTiersSchema: z.ZodArray<z.ZodObject<{
     uuid: z.ZodString;
     assetObjectName: z.ZodString;
@@ -47,4 +52,5 @@ export declare const CompetitiveTiersSchema: z.ZodArray<z.ZodObject<{
     }, z.core.$strip>>;
     assetPath: z.ZodString;
 }, z.core.$strip>>;
+/** A list of competitive tier sets. */
 export type CompetitiveTiersResponse = z.infer<typeof CompetitiveTiersSchema>;

package/dist/schemas/CompetitiveTierSchemas.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CompetitiveTiersSchema = exports.CompetitiveTierSetSchema = exports.TierSchema = void 0;
 const zod_1 = require("zod");
+/** Schema for a single competitive tier (rank). */
 exports.TierSchema = zod_1.z.object({
     tier: zod_1.z.number().int(),
     tierName: zod_1.z.string(),
@@ -14,10 +15,12 @@ exports.TierSchema = zod_1.z.object({
     rankTriangleDownIcon: zod_1.z.string().nullable(),
     rankTriangleUpIcon: zod_1.z.string().nullable(),
 });
+/** Schema for a single competitive tier set, including its {@link TierResponse | tiers}. */
 exports.CompetitiveTierSetSchema = zod_1.z.object({
     uuid: zod_1.z.string().uuid(),
     assetObjectName: zod_1.z.string(),
     tiers: zod_1.z.array(exports.TierSchema),
     assetPath: zod_1.z.string(),
 });
+/** Schema for a list of competitive tier sets. */
 exports.CompetitiveTiersSchema = zod_1.z.array(exports.CompetitiveTierSetSchema);

package/dist/schemas/ContentTierSchemas.d.ts

@@ -1,4 +1,5 @@
 import { z } from 'zod';
+/** Schema for a single content tier (rarity level). */
 export declare const ContentTierSchema: z.ZodObject<{
     uuid: z.ZodString;
     displayName: z.ZodString;
@@ -10,7 +11,9 @@ export declare const ContentTierSchema: z.ZodObject<{
     displayIcon: z.ZodString;
     assetPath: z.ZodString;
 }, z.core.$strip>;
+/** A single content tier (rarity level). */
 export type ContentTierResponse = z.infer<typeof ContentTierSchema>;
+/** Schema for a list of content tiers. */
 export declare const ContentTiersSchema: z.ZodArray<z.ZodObject<{
     uuid: z.ZodString;
     displayName: z.ZodString;
@@ -22,4 +25,5 @@ export declare const ContentTiersSchema: z.ZodArray<z.ZodObject<{
     displayIcon: z.ZodString;
     assetPath: z.ZodString;
 }, z.core.$strip>>;
+/** A list of content tiers. */
 export type ContentTiersResponse = z.infer<typeof ContentTiersSchema>;

package/dist/schemas/ContentTierSchemas.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ContentTiersSchema = exports.ContentTierSchema = void 0;
 const zod_1 = require("zod");
+/** Schema for a single content tier (rarity level). */
 exports.ContentTierSchema = zod_1.z.object({
     uuid: zod_1.z.string().uuid(),
     displayName: zod_1.z.string(),
@@ -13,4 +14,5 @@ exports.ContentTierSchema = zod_1.z.object({
     displayIcon: zod_1.z.string().url(),
     assetPath: zod_1.z.string(),
 });
+/** Schema for a list of content tiers. */
 exports.ContentTiersSchema = zod_1.z.array(exports.ContentTierSchema);

package/dist/schemas/ContractSchemas.d.ts

@@ -1,11 +1,14 @@
 import { z } from 'zod';
+/** Schema for a single contract reward. */
 export declare const RewardSchema: z.ZodObject<{
     type: z.ZodString;
     uuid: z.ZodString;
     amount: z.ZodNumber;
     isHighlighted: z.ZodBoolean;
 }, z.core.$strip>;
+/** A single contract reward. */
 export type RewardResponse = z.infer<typeof RewardSchema>;
+/** Schema for a single contract level, containing a {@link RewardResponse | reward}. */
 export declare const ContractLevelSchema: z.ZodObject<{
     reward: z.ZodObject<{
         type: z.ZodString;
@@ -19,7 +22,9 @@ export declare const ContractLevelSchema: z.ZodObject<{
     doughCost: z.ZodNumber;
     isPurchasableWithDough: z.ZodBoolean;
 }, z.core.$strip>;
+/** A single contract level. */
 export type ContractLevelResponse = z.infer<typeof ContractLevelSchema>;
+/** Schema for a single contract chapter, containing {@link ContractLevelResponse | levels} and {@link RewardResponse | free rewards}. */
 export declare const ChapterSchema: z.ZodObject<{
     isEpilogue: z.ZodBoolean;
     levels: z.ZodArray<z.ZodObject<{
@@ -42,7 +47,9 @@ export declare const ChapterSchema: z.ZodObject<{
         isHighlighted: z.ZodBoolean;
     }, z.core.$strip>>>;
 }, z.core.$strip>;
+/** A single contract chapter. */
 export type ChapterResponse = z.infer<typeof ChapterSchema>;
+/** Schema for a contract's content data, containing {@link ChapterResponse | chapters}. */
 export declare const ContractContentSchema: z.ZodObject<{
     relationType: z.ZodNullable<z.ZodString>;
     relationUuid: z.ZodNullable<z.ZodString>;
@@ -71,7 +78,9 @@ export declare const ContractContentSchema: z.ZodObject<{
     premiumRewardScheduleUuid: z.ZodNullable<z.ZodString>;
     premiumVPCost: z.ZodNumber;
 }, z.core.$strip>;
+/** A contract's content data. */
 export type ContractContentResponse = z.infer<typeof ContractContentSchema>;
+/** Schema for a single contract, including its {@link ContractContentResponse | content}. */
 export declare const ContractSchema: z.ZodObject<{
     uuid: z.ZodString;
     displayName: z.ZodString;
@@ -110,7 +119,9 @@ export declare const ContractSchema: z.ZodObject<{
     }, z.core.$strip>;
     assetPath: z.ZodString;
 }, z.core.$strip>;
+/** A single contract. */
 export type ContractResponse = z.infer<typeof ContractSchema>;
+/** Schema for a list of contracts. */
 export declare const ContractsSchema: z.ZodArray<z.ZodObject<{
     uuid: z.ZodString;
     displayName: z.ZodString;
@@ -149,4 +160,5 @@ export declare const ContractsSchema: z.ZodArray<z.ZodObject<{
     }, z.core.$strip>;
     assetPath: z.ZodString;
 }, z.core.$strip>>;
+/** A list of contracts. */
 export type ContractsResponse = z.infer<typeof ContractsSchema>;

package/dist/schemas/ContractSchemas.js

@@ -2,12 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ContractsSchema = exports.ContractSchema = exports.ContractContentSchema = exports.ChapterSchema = exports.ContractLevelSchema = exports.RewardSchema = void 0;
 const zod_1 = require("zod");
+/** Schema for a single contract reward. */
 exports.RewardSchema = zod_1.z.object({
     type: zod_1.z.string(),
     uuid: zod_1.z.string().uuid(),
     amount: zod_1.z.number().int(),
     isHighlighted: zod_1.z.boolean(),
 });
+/** Schema for a single contract level, containing a {@link RewardResponse | reward}. */
 exports.ContractLevelSchema = zod_1.z.object({
     reward: exports.RewardSchema,
     xp: zod_1.z.number().int(),
@@ -16,11 +18,13 @@ exports.ContractLevelSchema = zod_1.z.object({
     doughCost: zod_1.z.number().int(),
     isPurchasableWithDough: zod_1.z.boolean(),
 });
+/** Schema for a single contract chapter, containing {@link ContractLevelResponse | levels} and {@link RewardResponse | free rewards}. */
 exports.ChapterSchema = zod_1.z.object({
     isEpilogue: zod_1.z.boolean(),
     levels: zod_1.z.array(exports.ContractLevelSchema),
     freeRewards: zod_1.z.array(exports.RewardSchema).nullable(),
 });
+/** Schema for a contract's content data, containing {@link ChapterResponse | chapters}. */
 exports.ContractContentSchema = zod_1.z.object({
     relationType: zod_1.z.string().nullable(),
     relationUuid: zod_1.z.string().uuid().nullable(),
@@ -28,6 +32,7 @@ exports.ContractContentSchema = zod_1.z.object({
     premiumRewardScheduleUuid: zod_1.z.string().uuid().nullable(),
     premiumVPCost: zod_1.z.number().int(),
 });
+/** Schema for a single contract, including its {@link ContractContentResponse | content}. */
 exports.ContractSchema = zod_1.z.object({
     uuid: zod_1.z.string().uuid(),
     displayName: zod_1.z.string(),
@@ -39,4 +44,5 @@ exports.ContractSchema = zod_1.z.object({
     content: exports.ContractContentSchema,
     assetPath: zod_1.z.string(),
 });
+/** Schema for a list of contracts. */
 exports.ContractsSchema = zod_1.z.array(exports.ContractSchema);