@thefittingroom/sdk 1.1.0 → 1.1.2

package/README.md

@@ -72,10 +72,6 @@ shop.user.setBrandUserId(brandUserId)
 // 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
@@ -84,39 +80,32 @@ We'll make references to `sku` several times here. This is the unique identifier
 from your inventory to our system.
 
 ```typescript
+// get the garment measurement locations for a particular style
+// This is used to pre-populate the size recommendation table with data before the user is logged into The Fitting Room
+// sku: string
+// returns: string[]
+const locations = await shop.getMeasurementLocationsFromSku(sku)
+
 // 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
+// following functions. You'll get back some data about the style, 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)
+// sku: string
+// returns: FirestoreColorwaySizeAsset
+const colorwaySizeAsset = await shop.getColorwaySizeAssetFromSku(sku)
 
 // 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 label for a particular style
-// returns: { recommendedSizeLabel, availableSizeLabels }
-// recommendedSizeLabel: string
-// availableSizeLabels: string[]
-const { recommendedSizeLabel, availableSizeLabels } = shop.getRecommendedSizesLabels(styleID)
-
-// 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)
+// The styleId can be extracted from the previous getColorwaySizeAssetFromSku function call.
+// styleId: string
+// returns: SizeRecommendation
+const sizeRecommendation = shop.getRecommendedSizes(styleId)
 ```
 
+[Types Reference](https://github.com/TheFittingRoom/shop-sdk/blob/main/src/types/index.ts)
+
 #### Errors
 
 ```typescript
-NoFramesFoundError
-RequestTimeoutError
+AvatarNotCreatedError
 UserNotLoggedInError
 NoColorwaySizeAssetsFoundError
-NoStylesFoundError
-RecommendedAvailableSizesError
-BrandUserIdNotSetError
 ```

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

@@ -11,8 +11,9 @@ export declare class TfrShop {
     getRecommendedSizes(styleId: string): Promise<SizeRecommendation>;
     submitTelephoneNumber(tel: string): Promise<void>;
     getColorwaySizeAssetFromSku(colorwaySizeAssetSku: string): Promise<types.FirestoreColorwaySizeAsset>;
-    getMeasurementLocationsFromSku(sku: string): Promise<any>;
+    getMeasurementLocationsFromSku(sku: string): Promise<string[]>;
     private getColorwaySizeAssets;
     private getStyleCategory;
+    private getGetTaxonomy;
 }
 export declare const initShop: (brandId: number, env?: string) => TfrShop;

package/dist/esm/helpers/errors.d.ts

@@ -1,35 +1,13 @@
 export interface ErrorResponse {
     error: string;
 }
-export interface ErrorOutsideRecommendedSizes {
-    error: string;
-    recommended_size_id: number;
-    available_size_ids: number[];
-}
 export declare class AvatarNotCreatedError extends Error {
     constructor();
 }
-export declare class NoFramesFoundError extends Error {
-    constructor();
-}
-export declare class RequestTimeoutError extends Error {
-    constructor();
-}
 export declare class UserNotLoggedInError extends Error {
     constructor();
 }
 export declare class NoColorwaySizeAssetsFoundError extends Error {
     constructor();
 }
-export declare class NoStylesFoundError extends Error {
-    constructor();
-}
-export declare class RecommendedAvailableSizesError extends Error {
-    recommended_size: string;
-    available_sizes: string[];
-    constructor(recommended_size: string, available_sizes: string[]);
-}
-export declare class BrandUserIdNotSetError extends Error {
-    constructor();
-}
 export declare const AvatarNotCreated = "avatar not created";

package/dist/esm/index.js

@@ -1,5 +1,5 @@
 /*!
-* thefittingroom v1.1.0 (2024-02-16T20:34:26.286Z)
+* thefittingroom v1.1.1 (2024-04-05T19:08:13.350Z)
 * Copyright 2022-present, TheFittingRoom, Inc. All rights reserved.
 */
 // Code generated by tygo. DO NOT EDIT.
@@ -22740,18 +22740,6 @@ class AvatarNotCreatedError extends Error {
         this.name = 'AvatarNotCreatedError';
     }
 }
-class NoFramesFoundError extends Error {
-    constructor() {
-        super('no frames found');
-        this.name = 'NoFramesFoundError';
-    }
-}
-class RequestTimeoutError extends Error {
-    constructor() {
-        super('request timeout');
-        this.name = 'RequestTimeoutError';
-    }
-}
 class UserNotLoggedInError extends Error {
     constructor() {
         super('user not logged in');
@@ -22764,39 +22752,14 @@ class NoColorwaySizeAssetsFoundError extends Error {
         this.name = 'NoColorwaySizeAssetsFoundError';
     }
 }
-class NoStylesFoundError extends Error {
-    constructor() {
-        super('no styles found');
-        this.name = 'NoStylesFoundError';
-    }
-}
-class RecommendedAvailableSizesError extends Error {
-    constructor(recommended_size, available_sizes) {
-        super('recommended available sizes error');
-        this.name = 'RecommendedAvailableSizesError';
-        this.recommended_size = recommended_size;
-        this.available_sizes = available_sizes;
-    }
-}
-class BrandUserIdNotSetError extends Error {
-    constructor() {
-        super('brand user id not set');
-        this.name = 'BrandUserIdNotSetError';
-    }
-}
 // Backend responses
 const AvatarNotCreated = 'avatar not created';
 
 var errors = /*#__PURE__*/Object.freeze({
     __proto__: null,
     AvatarNotCreatedError: AvatarNotCreatedError,
-    NoFramesFoundError: NoFramesFoundError,
-    RequestTimeoutError: RequestTimeoutError,
     UserNotLoggedInError: UserNotLoggedInError,
     NoColorwaySizeAssetsFoundError: NoColorwaySizeAssetsFoundError,
-    NoStylesFoundError: NoStylesFoundError,
-    RecommendedAvailableSizesError: RecommendedAvailableSizesError,
-    BrandUserIdNotSetError: BrandUserIdNotSetError,
     AvatarNotCreated: AvatarNotCreated
 });
 
@@ -23368,7 +23331,8 @@ class TfrShop {
         var _a;
         const asset = await this.getColorwaySizeAssetFromSku(sku);
         const styleCategory = await this.getStyleCategory(asset.style_id);
-        const classificationLocation = ((_a = Taxonomy[styleCategory.category]) === null || _a === void 0 ? void 0 : _a[styleCategory.sub_category]) || null;
+        const taxonomy = await this.getGetTaxonomy(styleCategory.style_garment_category_id);
+        const classificationLocation = ((_a = Taxonomy[taxonomy.style_category]) === null || _a === void 0 ? void 0 : _a[taxonomy.garment_category]) || null;
         return classificationLocation
             ? ClassificationLocations[classificationLocation].map((location) => MeasurementLocationName[location])
             : null;
@@ -23394,7 +23358,16 @@ class TfrShop {
     }
     async getStyleCategory(styleId) {
         try {
-            const doc = await this.firebase.getDoc('style_categories', String(styleId));
+            const doc = await this.firebase.getDoc('styles', String(styleId));
+            return doc;
+        }
+        catch (error) {
+            return getFirebaseError(error);
+        }
+    }
+    async getGetTaxonomy(styleId) {
+        try {
+            const doc = await this.firebase.getDoc('style_garment_categories', String(styleId));
             return doc;
         }
         catch (error) {