roavatar-renderer 1.5.16 → 1.5.18

package/dist/index.d.ts

@@ -88,6 +88,8 @@ export declare const AllAnimations: AnimationProp[];
 
 export declare const AllAnimationSorts: ItemSort[];
 
+export declare const AllAvatarModelOutfitUpdateTypes: AvatarModelUpdateType[];
+
 export declare const AllBodyParts: number[];
 
 export declare const AllBodyPartsSorts: ItemSort[];
@@ -313,11 +315,28 @@ export declare const API: {
         WearOutfit: (auth: Authentication, outfit: Outfit, onlyItems: boolean) => Promise<[boolean, boolean]>;
         SaveOutfitNoRetry: (auth: Authentication, outfit: Outfit) => Promise<Response>;
         GetAvatarDetails: (userId: number) => Promise<Response | Outfit>;
+        GetAvatarModel: () => Promise<Response | OutfitModel>;
+        UpdateAvatarModel: (auth: Authentication, model: OutfitModel, updateTypes?: AvatarModelUpdateType[]) => Promise<Response>;
+        GetOutfitModel: (id: number | string, creatorId: number) => Promise<Response | OutfitModel>;
+        CreateOutfitModel: (auth: Authentication, model: OutfitModel) => Promise<Response>;
+        UpdateOutfitModel: (auth: Authentication, model: OutfitModel, id: number, updateTypes?: AvatarModelUpdateType[]) => Promise<Response>;
         GetHeadShapes: (pageToken: string | null | undefined) => Promise<AvatarInventory_Result | Response>;
         GetAvatarInventory: (sortOption: string, pageToken: string | null | undefined, itemInfos?: ItemSort[]) => Promise<AvatarInventory_Result | Response>;
+        /**
+         * @deprecated Use GetOutfitModel instead
+         */
         GetOutfitDetails: (outfitId: number | string, userId: number) => Promise<Response | Outfit>;
+        /**
+         * @deprecated Use CreateOutfitModel instead
+         */
         SaveOutfit: (auth: Authentication, outfit: Outfit) => Promise<Response>;
+        /**
+         * @deprecated Use UpdateOutfitModel instead
+         */
         UpdateOutfit: (auth: Authentication, outfitId: number | string, newOutfit: Outfit) => Promise<Response>;
+        /**
+         * @deprecated Use UpdateOutfitModel instead
+         */
         PatchOutfit: (auth: Authentication, outfitId: number | string, patchData: any) => Promise<Response>;
         DeleteOutfit: (auth: Authentication, outfitId: number | string) => Promise<Response>;
         GetUserOutfits: (userId: number) => Promise<Response | GetUserOutfits_Result>;
@@ -345,16 +364,16 @@ export declare const API: {
         IsLayered: (id: number) => Promise<boolean | Response>;
     };
     Catalog: {
-        GetNavigationMenuItems: () => Promise<NavigationMenuItems | Response>;
-        GetTopics: (auth: Authentication, body: GetTopics_Payload) => Promise<GetTopics_Result | Response>;
-        Search: ({ taxonomy, salesTypeFilter, sortType, categoryFilter, keyword, topics, creatorName, minPrice, maxPrice, includeNotForSale, limit }: Search_Payload, cursor?: string) => Promise<Search_Result | Response>;
-        GetBundleDetails: (bundleId: number | string) => Promise<BundleDetails_Result | Response>;
+        GetNavigationMenuItems: () => Promise<Response | NavigationMenuItems>;
+        GetTopics: (auth: Authentication, body: GetTopics_Payload) => Promise<Response | GetTopics_Result>;
+        Search: ({ taxonomy, salesTypeFilter, sortType, categoryFilter, keyword, topics, creatorName, minPrice, maxPrice, includeNotForSale, limit }: Search_Payload, cursor?: string) => Promise<Response | Search_Result>;
+        GetBundleDetails: (bundleId: number | string) => Promise<Response | BundleDetails_Result>;
         GetItemDetails: (auth: Authentication, items: {
             itemType: "Asset" | "Bundle";
             id: number;
-        }[]) => Promise<ItemDetails_Result | Response>;
-        GetMarketplaceWidgetsSearch: (query: string) => Promise<MarketplaceWidgets_Result | Response>;
-        GetMarketplaceWidgets: (context?: string) => Promise<MarketplaceWidgets_Result | Response>;
+        }[]) => Promise<Response | ItemDetails_Result>;
+        GetMarketplaceWidgetsSearch: (query: string) => Promise<Response | MarketplaceWidgets_Result>;
+        GetMarketplaceWidgets: (context?: string) => Promise<Response | MarketplaceWidgets_Result>;
     };
     Develop: {
         GetLatestVersions: (auth: Authentication, assetIds: number[]) => Promise<Response | LatestVersions_Result>;
@@ -366,7 +385,7 @@ export declare const API: {
     Users: {
         GetUserInfo: () => Promise<UserInfo | undefined>;
         GetIdsFromUsernames: (usernames: string[]) => Promise<any>;
-        GetInfoForId: (userId: number) => Promise<GetInfoForId_Result | Response>;
+        GetInfoForId: (userId: number) => Promise<Response | GetInfoForId_Result>;
         UserOmniSearch: (query: string, cursor?: string) => Promise<Response | UserOmniSearch_Result>;
     };
     Thumbnails: {
@@ -576,6 +595,19 @@ export declare class Authentication {
     getSessionUUID(): string;
 }
 
+declare interface AvatarConfigurations {
+    emotes?: {
+        assetId: number;
+        assetName: string;
+        position: number;
+    }[];
+    background?: {
+        backgroundAsset: AssetJson;
+    };
+    thumbnailCustomizations?: ThumbnailsCustomization_Payload[];
+    profileFrame: null;
+}
+
 /**@category API */
 export declare interface AvatarInventory_Result {
     avatarInventoryItems: {
@@ -616,6 +648,13 @@ export declare interface AvatarInventory_Result {
     nextPageToken: string | null;
 }
 
+export declare interface AvatarModel_Result {
+    avatarModel: OutfitJson;
+    avatarConfigurations: AvatarConfigurations | null;
+}
+
+export declare type AvatarModelUpdateType = "UpdateName" | "UpdateBodyColors" | "UpdateAssets" | "UpdateScales" | "UpdateBackground";
+
 /** @category Outfit */
 export declare type AvatarType = "R6" | "R15";
 
@@ -719,6 +758,12 @@ export declare type BodyColor3sJson = {
     leftArmColor3?: string;
     rightLegColor3?: string;
     leftLegColor3?: string;
+    headColor?: string;
+    torsoColor?: string;
+    rightArmColor?: string;
+    leftArmColor?: string;
+    rightLegColor?: string;
+    leftLegColor?: string;
 };
 
 /**@category Outfit */
@@ -929,6 +974,7 @@ export declare class CFrame {
     fromMatrix(m: Mat4x4): this;
     fromRotationMatrix(r00: number, r01: number, r02: number, r10: number, r11: number, r12: number, r20: number, r21: number, r22: number, order?: string): void;
     lookVector(): Vec3;
+    upVector(): Vec3;
     static lookAt(eye: Vec3, target: Vec3, up?: Vec3): CFrame;
     static fromEulerAngles(rx: number, ry: number, rz: number, order?: THREE.EulerOrder): CFrame;
     inverse(): CFrame;
@@ -1527,6 +1573,7 @@ export declare function gaussian_rbf(v0: Vec3, v1: Vec3, sigma?: number): number
  * @param gltfAutoDownload Automatically download gltf file
  * @returns ThumbnailResult, always a string for 2d thumbnails, 3d can be ArrayBuffer (glb, binary) or {[key: string]: unknown} (gltf, json)
  *
+ * @deprecated Use new Thumbnails category instead
  * @category ThumbnailGenerator
  *
  * @example
@@ -1555,6 +1602,8 @@ export declare function gaussian_rbf(v0: Vec3, v1: Vec3, sigma?: number): number
  */
 export declare function generateModelThumbnail(auth: Authentication, renderScene: RBXRendererScene, model: Instance, size?: Vec2, type?: ThumbnailType, quality?: number, gltfAutoDownload?: boolean, includeAnimations?: boolean): Promise<ThumbnailResult>;
 
+export declare function generateOutfitModelThumbnail(auth: Authentication, outfitModel: OutfitModel, options: Partial<OutfitModelThumbnailOptions>): Promise<ThumbnailResult>;
+
 /**
  * Generates a 2d or 3d thumbnail of an outfit
  * @param auth Authentication
@@ -1565,6 +1614,7 @@ export declare function generateModelThumbnail(auth: Authentication, renderScene
  * @param gltfAutoDownload Automatically download gltf file
  * @returns ThumbnailResult, always a string for 2d thumbnails, 3d can be ArrayBuffer (glb, binary) or {[key: string]: unknown} (gltf, json)
  *
+ * @deprecated Use new Thumbnails category instead
  * @category ThumbnailGenerator
  *
  * @example
@@ -1580,7 +1630,7 @@ export declare function generateModelThumbnail(auth: Authentication, renderScene
  * console.log(result)
  * ```
  */
-export declare function generateOutfitThumbnail(auth: Authentication, outfit: Outfit, size?: Vec2, type?: ThumbnailType, quality?: number, gltfAutoDownload?: boolean, includeAnimations?: boolean): Promise<ThumbnailResult>;
+export declare function generateOutfitThumbnail(auth: Authentication, outfit: Outfit, size?: Vec2, type?: ThumbnailType, quality?: number, gltfAutoDownload?: boolean, includeAnimations?: boolean, renderSceneParam?: RBXRendererScene): Promise<ThumbnailResult>;
 
 export declare function generateUUIDv4(): string;
 
@@ -1600,6 +1650,7 @@ export declare function getCameraCFrameForAvatarNonCustomized(rig: Instance): CF
  * @param yRot Customized yRot
  * @param distance Customized distanceScale
  * @returns Thumbnail camera cframe
+ * @deprecated Use new Thumbnails category instead
  * @category ThumbnailGenerator
  */
 export declare function getCameraCFrameForHeadshotCustomized(rig: Instance, fov: number, yRot: number, distance: number): CFrame | undefined;
@@ -1609,14 +1660,18 @@ export declare function getCameraCFrameForHeadshotCustomized(rig: Instance, fov:
  */
 export declare function getDistIndexArray(ref: FileMesh, dist: FileMesh): (number | undefined)[];
 
-/**@category ThumbnailGenerator */
+/**
+ * @deprecated Use new Thumbnails category instead
+ * @category ThumbnailGenerator */
 export declare function getExtents(cframe: CFrame, parts: Instance[]): [Vector3, Vector3];
 
-/**@category ThumbnailGenerator */
+/**
+ * @deprecated Use new Thumbnails category instead
+ * @category ThumbnailGenerator */
 export declare function getExtentsCenter(extents: [Vector3, Vector3]): Vector3;
 
 /**
- * @deprecated this is SO broken
+ * @deprecated Use new Thumbnails category instead
  * @category ThumbnailGenerator
  * */
 export declare function getExtentsForParts(parts: Instance[], includeTransform?: boolean): [Vector3, Vector3];
@@ -1676,9 +1731,10 @@ export declare interface GetSubscription_Result {
  * Calculates the CFrame the camera should be at when generating a thumbnail
  * @param model The model-like instance to get thumbnail camera for
  * @returns Thumbnail camera cframe
+ * @deprecated Use new Thumbnails category instead
  * @category ThumbnailGenerator
  */
-export declare function getThumbnailCameraCFrame(model: Instance): CFrame | undefined;
+export declare function getThumbnailCameraCFrame(model: Instance, fov: number, forceAngle?: Vec3): CFrame | undefined;
 
 /**@category API */
 export declare interface GetTopics_Payload {
@@ -1919,6 +1975,7 @@ export declare class Instance {
     get id(): string;
     set name(value: string);
     get name(): string;
+    get Parent(): Instance | undefined;
     createWrapper(): InstanceWrapper | undefined;
     get w(): InstanceWrapper | undefined;
     addConnectionReference(connection: Connection): void;
@@ -2157,11 +2214,16 @@ export declare class LocalOutfit {
     date: number;
     image?: string;
     buffer: string;
+    bg: number;
     constructor(outfit: Outfit);
     toJson(): LocalOutfitJson;
     fromJson(data: LocalOutfitJson): this;
     update(outfit: Outfit): void;
+    /**
+     * @deprecated Use toOutfitModel() instead
+     */
     toOutfit(auth: Authentication): Promise<Outfit>;
+    toOutfitModel(auth: Authentication): Promise<OutfitModel>;
 }
 
 export declare interface LocalOutfitJson {
@@ -2171,6 +2233,7 @@ export declare interface LocalOutfitJson {
     date: number;
     image: string | undefined;
     buffer: string;
+    bg?: number;
 }
 
 /**
@@ -2659,6 +2722,7 @@ export declare class Outfit {
     clone(): Outfit;
     toJson(removeNotOwnedAssets?: boolean): OutfitJson;
     toCleanJson(removeNotOwnedAssets?: boolean): OutfitJson;
+    toCleanJsonV4(removeNotOwnedAssets?: boolean): OutfitJson;
     fromJson(outfitJson: OutfitJson): void;
     /**
      * @deprecated Incorrect, use getValidationIssues() instead
@@ -2714,6 +2778,29 @@ export declare type OutfitJson = {
     scales?: ScaleJson;
 };
 
+export declare class OutfitModel {
+    outfit: Outfit;
+    emotes: Map<number, Asset>;
+    background?: Asset;
+    thumbnailCustomizations?: ThumbnailCustomization[];
+    profileFrame: undefined;
+    fromJson(outfitModel: AvatarModel_Result | OutfitModel_Result): OutfitModel;
+    clone(): OutfitModel;
+}
+
+export declare interface OutfitModel_Result {
+    outfitModel: OutfitJson;
+    outfitConfigurations: AvatarConfigurations | null;
+}
+
+export declare type OutfitModelThumbnailOptions = {
+    size: Vec2;
+    type: ThumbnailType;
+    quality: number;
+    gltfAutoDownload: boolean;
+    includeAnimations: boolean;
+};
+
 /** @category Outfit */
 export declare type OutfitOrigin = "WebAvatar" | "WebOutfit" | "Other" | "Look";
 
@@ -2760,7 +2847,7 @@ export declare class OutfitRenderer {
     /**
      * Updates the current rig, called internally by _updateOutfit()
      */
-    _setRigTo(newRigType: AvatarType): Promise<Response | Instance>;
+    _setRigTo(newRigType: AvatarType): Promise<Instance | Response>;
     /**
      * Rerenders the current outfit, called internally by setOutfit() and constructor
      */
@@ -3127,6 +3214,7 @@ export declare class RBXRenderer {
     static _createEffectComposer(renderScene?: RBXRendererScene): void;
     /**Removes an instance from the renderer */
     static removeInstance(instance: Instance, renderScene?: RBXRendererScene): void;
+    static getRenderDescs(instance: Instance): RenderDesc[];
     private static _addRenderDesc;
     /**Adds an instance to the renderer or updates it */
     static addInstance(instance: Instance, auth: Authentication, renderScene?: RBXRendererScene): void;
@@ -3391,6 +3479,7 @@ export declare class ScriptWrapper extends InstanceWrapper {
     created(): void;
     Run(): void;
     SoundPlayer(script: Instance): Promise<void>;
+    HatScript20(script: Instance): Promise<void>;
 }
 
 declare class ScriptWrapperData {
@@ -3455,6 +3544,7 @@ export declare interface Search_Result {
  * Gives a scene the default appearance for thumbnails
  * @param renderScene RBXRenderScene to setup
  *
+ * @deprecated Use new Thumbnails category instead
  * @category ThumbnailGenerator
  */
 export declare function setupThumbnailScene(renderScene: RBXRendererScene): void;
@@ -3561,6 +3651,18 @@ export declare const StringBufferProperties: string[];
 
 declare type ThreePoseCorrective = Vec3;
 
+export declare class ThumbnailCustomization {
+    thumbnailType: number;
+    emoteAssetId: number;
+    fieldOfViewDeg: number;
+    yRotDeg: number;
+    distanceScale: number;
+    constructor(thumbnailType: number);
+    fromJson(json: ThumbnailsCustomization_Payload): this;
+    toJson(): ThumbnailsCustomization_Payload;
+    clone(): ThumbnailCustomization;
+}
+
 /**@category API */
 export declare interface ThumbnailCustomizations_Result {
     "avatarThumbnailCustomizations": {
@@ -3574,7 +3676,9 @@ export declare interface ThumbnailCustomizations_Result {
     }[];
 }
 
-/**@category ThumbnailGenerator */
+/**
+ * @deprecated Use new Thumbnails category instead
+ * @category ThumbnailGenerator */
 export declare type ThumbnailResult = ArrayBuffer | {
     [key: string]: unknown;
 } | string | undefined;
@@ -3590,7 +3694,9 @@ export declare interface ThumbnailsCustomization_Payload {
     };
 }
 
-/**@category ThumbnailGenerator */
+/**
+ * @deprecated Use new Thumbnails category instead
+ * @category ThumbnailGenerator */
 export declare type ThumbnailType = "png" | "webp" | "gltf" | "glb";
 
 /**