@thefittingroom/sdk 0.0.8 → 0.0.9

package/README.md

@@ -58,30 +58,50 @@ const shop = initShop(brandId, env)
 await shop.onInit()
 
 // Login user with session
-shop.user.login(username, password)
+shop.user.login(email, password)
 
 // Logout current user
 shop.user.logout()
 
-// Submit telephone number for link to iOS app
+// In order for the user to create an avatar, they'll need to download the mobile application.
+// This will send an SMS to the given phone number with a link to the iOS app
 // No spaces and must include country code e.g. +18005551234
 shop.submitTelephoneNumber(tel)
+
+// await for the avatar creation
+// Returns boolean on whether the avatar is created or not after the configured `avatarTimeout` period
+shop.awaitAvatarCreated()
 ```
 
 #### Shop
 
+We'll make references to `sku` several times here. This is the unique identifier that matches a styles particular size
+from your inventory to our system.
+
 ```typescript
-// returns frames: types.TryOnFrames
-shop.tryOn(colorwaySizeAssetSku)
+// A good first step would be to ensure your style and size exists in the fitting room system before executing any of the
+// following functions. You'll get back some data about the style(s), such as the ID of the style, which you can use
+// for the getRecommendedSizes function below.
+// ids: number[] or skus: string[]
+// At least one parameter must not be null
+shop.getStyles(ids, skus)
 
-// await for the avatar creation
-shop.awaitAvatarCreated()
+// get recommended sizes for a particular style
+// The styleID can be extracted from the previous getStyles function call.
+const sizeRecommendation = shop.getRecommendedSizes(styleID)
 
-// get recommended sizes for use
-shop.getRecommendedSizes()
+// get recommended sizes label for a particular style
+// returns: { recommendedSizeLabel, availableSizeLabels }
+// recommendedSizeLabel: string
+// availableSizeLabels: string[]
+const { recommendedSizeLabel, availableSizeLabels } = shop.getRecommendedSizesLabels(styleID)
 
-// get available styles by ids: number[] or skus: string[]
-shop.getStyles(ids, skus)
+// Once the user has downloaded the mobile application and has created an avatar, they may now virtually try on a size.
+// The size they try on must be one of the recommended sizes from the previous function call. or an error will get returned.
+// returns frames: types.TryOnFrames
+// These `frames` are images that can be used to cycle through the VTO 360 degrees.
+// NOTE: this process can take a minute or two
+const frames = await this.shop.tryOn(sku)
 ```
 
 #### Errors

package/dist/esm/api/shop.d.ts

@@ -12,7 +12,11 @@ export declare class TfrShop {
     onInit(): Promise<boolean>;
     tryOn(colorwaySizeAssetSku: string): Promise<types.TryOnFrames>;
     awaitAvatarCreated(): Promise<boolean>;
-    getRecommendedSizes(brandStyleId: string): Promise<SizeRecommendation>;
+    getRecommendedSizes(styleId: string): Promise<SizeRecommendation>;
+    getRecommendedSizesLabels(styleId: string): Promise<{
+        recommendedSizeLabel: string;
+        availableSizeLabels: string[];
+    }>;
     getStyles(ids: number[], skus: string[]): Promise<Map<number, types.FirestoreStyle>>;
     submitTelephoneNumber(tel: string): Promise<void>;
     private awaitColorwaySizeAssetFrames;

package/dist/esm/index.js

@@ -1,5 +1,5 @@
 /*!
-* thefittingroom v0.0.8 (2023-07-19T17:34:22.852Z)
+* thefittingroom v0.0.9 (2023-07-26T23:07:17.052Z)
 * Copyright 2022-present, TheFittingRoom, Inc. All rights reserved.
 */
 /**
@@ -22993,11 +22993,11 @@ class TfrShop {
         const userProfile = snapshot.docs[0].data();
         return userProfile.avatar_status === 'CREATED';
     }
-    async getRecommendedSizes(brandStyleId) {
+    async getRecommendedSizes(styleId) {
         if (!this.isLoggedIn)
             throw new UserNotLoggedInError();
         try {
-            const res = await Fetcher.Get(this.user, `/styles/${brandStyleId}/recommendation`);
+            const res = await Fetcher.Get(this.user, `/styles/${styleId}/recommendation`);
             const json = await res.json();
             return json;
         }
@@ -23007,6 +23007,12 @@ class TfrShop {
             throw error;
         }
     }
+    async getRecommendedSizesLabels(styleId) {
+        const sizeRecommendation = await this.getRecommendedSizes(styleId);
+        const recommendedSizeLabel = sizeRecommendation.recommended_sizes.label || sizeRecommendation.recommended_sizes.size_value.size;
+        const availableSizeLabels = sizeRecommendation.available_sizes.map((size) => size.label || size.size_value.size);
+        return { recommendedSizeLabel, availableSizeLabels };
+    }
     async getStyles(ids, skus) {
         const constraints = [rl('brand_id', '==', this.brandId)];
         if ((ids === null || ids === void 0 ? void 0 : ids.length) > 0)