Spaces:
Running
Running
File size: 12,796 Bytes
9557505 2b5a760 9557505 1c4d53b 9557505 1c4d53b 9557505 1c4d53b 9557505 1c4d53b 9557505 1c4d53b 9557505 1c4d53b 9557505 1c4d53b 9557505 2b5a760 9557505 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 |
import axios from "axios";
import dotenv from "dotenv";
import FormData from "form-data";
dotenv.config();
const READY_API_KEY = process.env.READY_API_KEY;
const READY_API_BASE = "https://api.readyplayer.me/v1";
const READY_MODELS_BASE = "https://models.readyplayer.me";
const READY_AVATARS_BASE = "https://avatars.readyplayer.me";
if (!READY_API_KEY) {
console.warn("READY_API_KEY not found in environment variables");
}
const getHeaders = (): Record<string, string> => ({
"X-API-Key": READY_API_KEY || "",
"Content-Type": "application/json",
});
export interface ReadyPlayerMeUser {
id: string;
applicationIds: string[];
partners: string[];
createdAt: string;
updatedAt: string;
}
export interface ReadyPlayerMeAsset {
id: string;
name: string;
type: string;
gender: string;
modelUrl: string;
iconUrl: string;
organizationId: string;
locked: boolean;
applications?: any[];
hasApps: boolean;
createdAt: string;
updatedAt: string;
}
export interface ReadyPlayerMeToken {
token: string;
}
export interface ReadyPlayerMeAvatarMetadata {
id: string;
url?: string;
[key: string]: any;
}
export class ReadyPlayerMeClient {
private apiKey: string;
private applicationId?: string;
constructor(applicationId?: string) {
this.apiKey = READY_API_KEY || "";
this.applicationId = applicationId;
}
async createGuestUser(applicationId: string): Promise<ReadyPlayerMeUser | null> {
try {
const response = await axios.post<{ data: ReadyPlayerMeUser }>(
`${READY_API_BASE}/users`,
{
data: {
applicationId,
},
},
{
headers: getHeaders(),
}
);
return response.data.data;
} catch (error: any) {
console.error("Error creating Ready Player Me guest user:", error.response?.data || error.message);
return null;
}
}
async getAuthToken(userId: string, partner: string): Promise<string | null> {
try {
const response = await axios.get<{ data: ReadyPlayerMeToken }>(
`${READY_API_BASE}/auth/token`,
{
params: { userId, partner },
headers: getHeaders(),
}
);
return response.data.data.token;
} catch (error: any) {
console.error("Error getting Ready Player Me token:", error.response?.data || error.message);
return null;
}
}
async getAvatarGLB(avatarId: string, options?: {
quality?: "low" | "medium" | "high" | "ultra";
lod?: number;
textureAtlas?: number | "none";
textureFormat?: "webp" | "jpeg" | "png";
useDracoMeshCompression?: boolean;
}): Promise<string> {
const params = new URLSearchParams();
if (options?.quality) params.append("quality", options.quality);
if (options?.lod !== undefined) params.append("lod", options.lod.toString());
if (options?.textureAtlas) params.append("textureAtlas", options.textureAtlas.toString());
if (options?.textureFormat) params.append("textureFormat", options.textureFormat);
if (options?.useDracoMeshCompression) params.append("useDracoMeshCompression", "true");
const queryString = params.toString();
return `${READY_AVATARS_BASE}/${avatarId}.glb${queryString ? `?${queryString}` : ""}`;
}
async getAvatar2DRender(avatarId: string, options?: {
size?: number;
quality?: number;
camera?: "portrait" | "fullbody" | "fit";
background?: string;
expression?: string;
pose?: string;
}): Promise<string> {
const params = new URLSearchParams();
if (options?.size) params.append("size", options.size.toString());
if (options?.quality) params.append("quality", options.quality.toString());
if (options?.camera) params.append("camera", options.camera);
if (options?.background) params.append("background", options.background);
if (options?.expression) params.append("expression", options.expression);
if (options?.pose) params.append("pose", options.pose);
const queryString = params.toString();
return `${READY_MODELS_BASE}/${avatarId}.png${queryString ? `?${queryString}` : ""}`;
}
async getAvatarMetadata(avatarId: string): Promise<ReadyPlayerMeAvatarMetadata | null> {
try {
const response = await axios.get<{ data: ReadyPlayerMeAvatarMetadata }>(
`${READY_MODELS_BASE}/${avatarId}.json`,
{
headers: getHeaders(),
}
);
return response.data.data;
} catch (error: any) {
console.error("Error getting avatar metadata:", error.response?.data || error.message);
return null;
}
}
async uploadAssetFile(fileBuffer: Buffer, filename: string, mimetype: string): Promise<string | null> {
try {
const formData = new FormData();
formData.append("file", fileBuffer, {
filename,
contentType: mimetype,
});
const headers = {
...getHeaders(),
...formData.getHeaders(),
};
console.log(`[Ready Player Me] Uploading file: ${filename} (${fileBuffer.length} bytes, ${mimetype})`);
const response = await axios.post<{ data: { url: string } }>(
`${READY_API_BASE}/temporary-media`,
formData,
{
headers,
maxContentLength: Infinity,
maxBodyLength: Infinity,
}
);
if (response.data?.data?.url) {
console.log(`[Ready Player Me] File uploaded successfully: ${response.data.data.url}`);
return response.data.data.url;
} else {
console.error("[Ready Player Me] Upload response missing URL:", response.data);
return null;
}
} catch (error: any) {
console.error("[Ready Player Me] Error uploading asset file:");
console.error(" Status:", error.response?.status);
console.error(" Status Text:", error.response?.statusText);
console.error(" Response Data:", JSON.stringify(error.response?.data, null, 2));
console.error(" Error Message:", error.message);
if (error.response?.data) {
console.error(" Full Error:", JSON.stringify(error.response.data, null, 2));
}
return null;
}
}
async createAsset(data: {
name: string;
type: string;
gender: "male" | "female" | "neutral";
modelUrl: string;
iconUrl: string;
organizationId: string;
locked?: boolean;
applications?: Array<{
id: string;
organizationId: string;
isVisibleInEditor?: boolean;
}>;
}): Promise<ReadyPlayerMeAsset | null> {
try {
console.log(`[Ready Player Me] Creating asset: ${data.name} (type: ${data.type}, gender: ${data.gender})`);
const response = await axios.post<{ data: ReadyPlayerMeAsset }>(
`${READY_API_BASE}/assets`,
{ data },
{
headers: getHeaders(),
}
);
if (response.data?.data) {
console.log(`[Ready Player Me] Asset created successfully: ${response.data.data.id}`);
return response.data.data;
} else {
console.error("[Ready Player Me] Create asset response missing data:", response.data);
return null;
}
} catch (error: any) {
console.error("[Ready Player Me] Error creating asset:");
console.error(" Status:", error.response?.status);
console.error(" Status Text:", error.response?.statusText);
console.error(" Response Data:", JSON.stringify(error.response?.data, null, 2));
console.error(" Error Message:", error.message);
if (error.response?.data) {
console.error(" Full Error:", JSON.stringify(error.response.data, null, 2));
}
return null;
}
}
async listAssets(filters?: {
type?: string[];
gender?: string[];
name?: string;
organizationId?: string;
applicationIds?: string[];
limit?: number;
page?: number;
}): Promise<{ data: ReadyPlayerMeAsset[]; pagination: any } | null> {
try {
const params = new URLSearchParams();
if (filters?.type) {
filters.type.forEach(t => params.append("type", t));
}
if (filters?.gender) {
filters.gender.forEach(g => params.append("gender", g));
}
if (filters?.name) params.append("name", filters.name);
if (filters?.organizationId) params.append("organizationId", filters.organizationId);
if (filters?.applicationIds) {
filters.applicationIds.forEach(id => params.append("applicationIds", id));
}
if (filters?.limit) params.append("limit", filters.limit.toString());
if (filters?.page) params.append("page", filters.page.toString());
const headers: Record<string, string> = { ...getHeaders() };
if (this.applicationId) {
headers["X-APP-ID"] = this.applicationId;
}
const response = await axios.get<{ data: ReadyPlayerMeAsset[]; pagination: any }>(
`${READY_API_BASE}/assets?${params.toString()}`,
{ headers }
);
return response.data;
} catch (error: any) {
console.error("Error listing assets:", error.response?.data || error.message);
return null;
}
}
async updateAsset(assetId: string, data: {
name?: string;
type?: string;
gender?: "male" | "female" | "neutral";
modelUrl?: string;
iconUrl?: string;
locked?: boolean;
applications?: Array<{
id: string;
organizationId: string;
isVisibleInEditor?: boolean;
}>;
}): Promise<ReadyPlayerMeAsset | null> {
try {
const response = await axios.patch<{ data: ReadyPlayerMeAsset }>(
`${READY_API_BASE}/assets/${assetId}`,
{ data },
{
headers: getHeaders(),
}
);
return response.data.data;
} catch (error: any) {
console.error("Error updating asset:", error.response?.data || error.message);
return null;
}
}
async equipAsset(avatarId: string, assetId: string): Promise<boolean> {
try {
await axios.put(
`${READY_API_BASE}/avatars/${avatarId}/equip`,
{
data: {
assetId,
},
},
{
headers: getHeaders(),
}
);
return true;
} catch (error: any) {
console.error("Error equipping asset:", error.response?.data || error.message);
return false;
}
}
async unequipAsset(avatarId: string, assetId: string): Promise<boolean> {
try {
await axios.put(
`${READY_API_BASE}/avatars/${avatarId}/unequip`,
{
data: {
assetId,
},
},
{
headers: getHeaders(),
}
);
return true;
} catch (error: any) {
console.error("Error unequipping asset:", error.response?.data || error.message);
return false;
}
}
async addAssetToApplication(assetId: string, applicationId: string, isVisibleInEditor: boolean = true): Promise<boolean> {
try {
await axios.post(
`${READY_API_BASE}/assets/${assetId}/application`,
{
data: {
applicationId,
isVisibleInEditor,
},
},
{
headers: getHeaders(),
}
);
return true;
} catch (error: any) {
console.error("Error adding asset to application:", error.response?.data || error.message);
return false;
}
}
async removeAssetFromApplication(assetId: string, applicationId: string): Promise<boolean> {
try {
await axios.delete(
`${READY_API_BASE}/assets/${assetId}/application`,
{
data: {
applicationId,
},
headers: getHeaders(),
}
);
return true;
} catch (error: any) {
console.error("Error removing asset from application:", error.response?.data || error.message);
return false;
}
}
async unlockAssetForUser(assetId: string, userId: string): Promise<boolean> {
try {
await axios.put(
`${READY_API_BASE}/assets/${assetId}/unlock`,
{
data: {
userId,
},
},
{
headers: getHeaders(),
}
);
return true;
} catch (error: any) {
console.error("Error unlocking asset:", error.response?.data || error.message);
return false;
}
}
async lockAssetForUser(assetId: string, userId: string): Promise<boolean> {
try {
await axios.put(
`${READY_API_BASE}/assets/${assetId}/lock`,
{
data: {
userId,
},
},
{
headers: getHeaders(),
}
);
return true;
} catch (error: any) {
console.error("Error locking asset:", error.response?.data || error.message);
return false;
}
}
}
export const readyPlayerMeClient = new ReadyPlayerMeClient();
|