@rbxts/types 1.0.694 → 1.0.696

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.
@@ -2749,13 +2749,17 @@ interface AvatarEditorService extends Instance {
2749
2749
  *
2750
2750
  * Tags: Yields
2751
2751
  */
2752
- GetAvatarRules(this: AvatarEditorService): object;
2752
+ GetAvatarRules(this: AvatarEditorService): AvatarRules;
2753
2753
  /**
2754
2754
  * Gets the item details for a list of items at once. More efficient than AvatarEditorService:GetItemDetails if you need to get all the item details of a list.
2755
2755
  *
2756
2756
  * Tags: Yields
2757
2757
  */
2758
- GetBatchItemDetails(this: AvatarEditorService, itemIds: Array<any>, itemType: CastsToEnum<Enum.AvatarItemType>): unknown;
2758
+ GetBatchItemDetails(
2759
+ this: AvatarEditorService,
2760
+ itemIds: ReadonlyArray<number>,
2761
+ itemType: CastsToEnum<Enum.AvatarItemType>,
2762
+ ): ReadonlyArray<ItemDetails>;
2759
2763
  /**
2760
2764
  * This function returns if the [Players.LocalPlayer](https://developer.roblox.com/en-us/api-reference/property/Players/LocalPlayer) has favorited the given bundle or asset.
2761
2765
  *
@@ -2778,7 +2782,7 @@ interface AvatarEditorService extends Instance {
2778
2782
  *
2779
2783
  * Tags: Yields
2780
2784
  */
2781
- GetInventory(this: AvatarEditorService, assetTypes: Array<any>): InventoryPages;
2785
+ GetInventory(this: AvatarEditorService, assetTypes: ReadonlyArray<Enum.AvatarAssetType>): InventoryPages;
2782
2786
  /**
2783
2787
  * This function returns the item details for the given item. It accepts two parameters - the first indicating the ID of the item being retrieved and the second indicating its [ItemType](https://developer.roblox.com/en-us/api-reference/enum/ItemType).
2784
2788
  *
@@ -2830,7 +2834,7 @@ interface AvatarEditorService extends Instance {
2830
2834
  *
2831
2835
  * Tags: Yields
2832
2836
  */
2833
- GetItemDetails(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType>): object;
2837
+ GetItemDetails(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType>): ItemDetails;
2834
2838
  /**
2835
2839
  * Tags: Yields
2836
2840
  */
@@ -2916,7 +2920,11 @@ interface AvatarEditorService extends Instance {
2916
2920
  *
2917
2921
  * Tags: Yields
2918
2922
  */
2919
- GetRecommendedAssets(this: AvatarEditorService, assetType: CastsToEnum<Enum.AvatarAssetType>, contextAssetId?: number): unknown;
2923
+ GetRecommendedAssets(
2924
+ this: AvatarEditorService,
2925
+ assetType: CastsToEnum<Enum.AvatarAssetType>,
2926
+ contextAssetId?: number,
2927
+ ): ReadonlyArray<RecommendedAsset>;
2920
2928
  /**
2921
2929
  * This function returns a list of recommended bundles for a given bundle id.
2922
2930
  *
@@ -2957,7 +2965,7 @@ interface AvatarEditorService extends Instance {
2957
2965
  *
2958
2966
  * Tags: Yields
2959
2967
  */
2960
- GetRecommendedBundles(this: AvatarEditorService, bundleId: number): unknown;
2968
+ GetRecommendedBundles(this: AvatarEditorService, bundleId: number): ReadonlyArray<RecommendedBundle>;
2961
2969
  /**
2962
2970
  * This function returns a [CatalogPages](https://developer.roblox.com/en-us/api-reference/class/CatalogPages) object containing the result of the given search.
2963
2971
  *
@@ -25869,7 +25877,7 @@ interface AudioPages extends Pages {
25869
25877
  readonly _nominal_AudioPages: unique symbol;
25870
25878
  }
25871
25879
 
25872
- interface CatalogPages extends Pages {
25880
+ interface CatalogPages extends Pages<SearchCatalogResult> {
25873
25881
  /**
25874
25882
  * **DO NOT USE!**
25875
25883
  *
@@ -26017,7 +26025,14 @@ interface EmotesPages extends InventoryPages {
26017
26025
  readonly _nominal_EmotesPages: unique symbol;
26018
26026
  }
26019
26027
 
26020
- interface OutfitPages extends Pages {
26028
+ interface OutfitPages
26029
+ extends Pages<
26030
+ ReadonlyArray<{
26031
+ Id: number;
26032
+ Name: string;
26033
+ IsEditable: boolean;
26034
+ }>
26035
+ > {
26021
26036
  /**
26022
26037
  * **DO NOT USE!**
26023
26038
  *
@@ -530,6 +530,176 @@ interface PolicyInfo {
530
530
  IsSubjectToChinaPolicies: boolean;
531
531
  }
532
532
 
533
+ interface AvatarRulesBodyColorsPalette {
534
+ HexColor: string;
535
+ Name: string;
536
+ BrickColorId: number;
537
+ }
538
+
539
+ interface AvatarRules {
540
+ BodyColorsPalette: ReadonlyArray<AvatarRulesBodyColorsPalette>;
541
+ BundlesEnabledForUser: boolean;
542
+ MinimumDeltaEBodyColorDifference: number;
543
+ WearableAssetTypes: ReadonlyArray<{
544
+ Id: number;
545
+ MaxNumber: number;
546
+ Name: string;
547
+ }>;
548
+ ProportionsAndBodyTypeEnabledForUser: boolean;
549
+ PlayerAvatarTypes: ReadonlyArray<string>;
550
+ Scales: {
551
+ BodyType: {
552
+ Max: number;
553
+ Increment: number;
554
+ Min: number;
555
+ };
556
+ Head: {
557
+ Max: number;
558
+ Increment: number;
559
+ Min: number;
560
+ };
561
+ Height: {
562
+ Max: number;
563
+ Increment: number;
564
+ Min: number;
565
+ };
566
+ Proportion: {
567
+ Max: number;
568
+ Increment: number;
569
+ Min: number;
570
+ };
571
+ Width: {
572
+ Max: number;
573
+ Increment: number;
574
+ Min: number;
575
+ };
576
+ };
577
+ DefaultClothingAssetLists: {
578
+ DefaultPantAssetIds: ReadonlyArray<number>;
579
+ DefaultShirtAssetIds: ReadonlyArray<number>;
580
+ };
581
+ EmotesEnabledForUser: boolean;
582
+ BasicBodyColorsPalette: ReadonlyArray<AvatarRulesBodyColorsPalette>;
583
+ }
584
+
585
+ interface ItemDetails {
586
+ CreatorHasVerifiedBadge: boolean;
587
+ Genres: ReadonlyArray<"All">;
588
+ Price: number;
589
+ AssetType: string;
590
+ ProductId: number;
591
+ ItemRestrictions: ReadonlyArray<"Limited">;
592
+ ItemStatus: ReadonlyArray<"New">;
593
+ SaleLocationType: string;
594
+ FavoriteCount: number;
595
+ ItemType: string;
596
+ Id: number;
597
+ Name: string;
598
+ Description: string;
599
+ CreatorTargetId: number;
600
+ CreatorName: string;
601
+ CreatorType: string;
602
+ }
603
+
604
+ interface RecommendedAsset {
605
+ Item: {
606
+ AssetId: number;
607
+ Name: string;
608
+ Price: number;
609
+ PremiumPrice: number;
610
+ AbsoluteUrl: string;
611
+ AudioUrl: string;
612
+ };
613
+ Creator: {
614
+ CreatorId: number;
615
+ CreatorType: string;
616
+ Name: string;
617
+ CreatorProfileLink: string;
618
+ };
619
+ Product: {
620
+ Id: number;
621
+ PriceInRobux: number;
622
+ IsForSale: boolean;
623
+ IsPublicDomain: boolean;
624
+ IsResellable: boolean;
625
+ IsLimited: boolean;
626
+ IsLimitedUnique: boolean;
627
+ SerialNumber: number;
628
+ IsRental: boolean;
629
+ RentalDurationInHours: number;
630
+ BcRequirement: number;
631
+ TotalPrivateSales: number;
632
+ SellerId: number;
633
+ SellerName: string;
634
+ LowestPrivateSaleUserAssetId: number;
635
+ IsXboxExclusiveItem: boolean;
636
+ OffsaleDeadline: string;
637
+ NoPriceText: string;
638
+ IsFree: boolean;
639
+ };
640
+ }
641
+
642
+ interface RecommendedBundle {
643
+ Id: number;
644
+ Name: string;
645
+ Description: string;
646
+ BundleType: string;
647
+ Items: ReadonlyArray<{
648
+ Owned: boolean;
649
+ Id: number;
650
+ Name: string;
651
+ Type: string;
652
+ }>;
653
+ Creator: {
654
+ Id: number;
655
+ Name: string;
656
+ Type: string;
657
+ };
658
+ Product: {
659
+ Id: number;
660
+ Type: string;
661
+ IsPublicDomain: boolean;
662
+ IsForSale: boolean;
663
+ PriceInRobux: number;
664
+ PremiumPricing: {
665
+ PremiumDiscountPercentage: number;
666
+ PremiumPriceInRobux: number;
667
+ };
668
+ };
669
+ }
670
+
671
+ interface SearchCatalogResult {
672
+ Id: number;
673
+ ItemType: "Asset";
674
+ AssetType: "Image";
675
+ BundleType: "BodyParts";
676
+ Name: string;
677
+ Description: string;
678
+ ProductId: number;
679
+ Genres: ReadonlyArray<"All">;
680
+ BundledItems: ReadonlyArray<{
681
+ Owned: boolean;
682
+ Id: number;
683
+ Name: string;
684
+ Type: string;
685
+ }>;
686
+ ItemStatus: ReadonlyArray<"New">;
687
+ ItemRestrictions: ReadonlyArray<"ThirteenPlus">;
688
+ CreatorType: "User";
689
+ CreatorTargetId: number;
690
+ CreatorName: string;
691
+ Price: number;
692
+ PremiumPricing: {
693
+ PremiumDiscountPercentage: number;
694
+ PremiumPriceInRobux: number;
695
+ };
696
+ LowestPrice: number;
697
+ PriceStatus: string;
698
+ UnitsAvailableForConsumption: number;
699
+ PurchaseCount: number;
700
+ FavoriteCount: number;
701
+ }
702
+
533
703
  /**
534
704
  * RBXScriptConnection, also known as a Connection,
535
705
  * is a special object returned by the Connect method of an Event (RBXScriptSignal).
@@ -1045,11 +1215,28 @@ interface CatalogSearchParams {
1045
1215
  * @deprecated
1046
1216
  */
1047
1217
  readonly _nominal_CatalogSearchParams: unique symbol;
1218
+ /** The keyword to search for catalog results with. */
1048
1219
  SearchKeyword: string;
1049
- CategoryFilter: Enum.CatalogCategoryFilter;
1220
+ /** The minimum item price to search for. */
1221
+ MinPrice: number;
1222
+ /** The maximum item price to search for. */
1223
+ MaxPrice: number;
1224
+ /** The order in which to sort the results. */
1050
1225
  SortType: Enum.CatalogSortType;
1051
- BundleTypes: string;
1052
- AssetTypes: string;
1226
+ /** The time period to use to aggregate the sort results. */
1227
+ SortAggregation: Enum.CatalogSortAggregation;
1228
+ /** The category to filter the search by. */
1229
+ CategoryFilter: Enum.CatalogCategoryFilter;
1230
+ /** The sales type filter the search by. */
1231
+ SalesTypeFilter: Enum.SalesTypeFilter;
1232
+ /** An array containing BundleType values to filter the search by. */
1233
+ BundleTypes: ReadonlyArray<Enum.BundleType>;
1234
+ /** An array containing AvatarAssetType values to filter the search by. */
1235
+ AssetTypes: ReadonlyArray<Enum.AvatarAssetType>;
1236
+ /** Whether off sale items should be included in the results. */
1237
+ IncludeOffSale: boolean;
1238
+ /** Search for items with the given creator. */
1239
+ CreatorName: string;
1053
1240
  }
1054
1241
 
1055
1242
  interface CatalogSearchParamsConstructor {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rbxts/types",
3
- "version": "1.0.694",
3
+ "version": "1.0.696",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },