@thefittingroom/sdk 0.0.5 → 0.0.7

package/README.md

@@ -0,0 +1,96 @@
+# The Fitting Room - Shop SDK
+
+### Installation
+
+```bash
+npm i @thefittingroom/shop-sdk
+```
+
+or
+
+```bash
+yarn @thefittingroom/shop-sdk
+```
+
+### Build
+
+```bash
+npm run build
+```
+
+or
+
+```bash
+yarn build
+```
+
+### Development
+
+```bash
+npm run watch
+```
+
+or
+
+```bash
+yarn watch
+```
+
+## Usage
+
+```typescript
+import { initShop } from '@thefittingroom/sdk'
+
+// Your brandId: Number
+const brandId = 9001
+
+// The environment: 'development', 'dev', 'production', 'prod'
+const env = 'dev'
+const shop = initShop(brandId, env)
+```
+
+### Shop API
+
+#### Auth
+
+```typescript
+// Hook used to check authentication, return isLoggedIn Promise<boolean>
+await shop.onInit()
+
+// Login user with session
+shop.user.login(username, password)
+
+// Logout current user
+shop.user.logout()
+
+// Submit telephone number for link to iOS app
+// No spaces and must include country code e.g. +18005551234
+shop.submitTelephoneNumber(tel)
+```
+
+#### Shop
+
+```typescript
+// returns frames: types.TryOnFrames
+shop.tryOn(colorwaySizeAssetSku)
+
+// await for the avatar creation
+shop.awaitAvatarCreated()
+
+// get recommended sizes for use
+shop.getRecommendedSizes()
+
+// get available styles by ids: number[] or skus: string[]
+shop.getStyles(ids, skus)
+```
+
+#### Errors
+
+```typescript
+NoFramesFoundError
+RequestTimeoutError
+UserNotLoggedInError
+NoColorwaySizeAssetsFoundError
+NoStylesFoundError
+RecommendedAvailableSizesError
+```

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

@@ -1,6 +1,6 @@
 import { FirebaseUser } from '../firebase/firebase-user';
 export declare class Fetcher {
-    private static endpoint;
+    private static get endpoint();
     private static Fetch;
     private static getUrl;
     private static getHeaders;

package/dist/esm/firebase/firebase-user.d.ts

@@ -1,6 +1,6 @@
 import * as firebase from 'firebase/app';
 import * as firebaseAuth from 'firebase/auth';
-import { Firestore } from 'firebase/firestore';
+import { DocumentData, Firestore, QuerySnapshot } from 'firebase/firestore';
 export declare class FirebaseUser {
     private readonly firestore;
     private user;
@@ -10,7 +10,8 @@ export declare class FirebaseUser {
     onInit(): Promise<boolean>;
     setUser(user: firebaseAuth.User): void;
     getToken(): Promise<string>;
-    getUserProfile(): Promise<import("@firebase/firestore").DocumentData>;
+    getUserProfile(): Promise<DocumentData>;
+    watchUserProfileForChanges(predicate: (data: QuerySnapshot<DocumentData>) => boolean, timeout: number): Promise<DocumentData>;
     login(username: string, password: string): Promise<void>;
     logout(): Promise<void>;
     sendPasswordResetEmail(email: string): Promise<void>;

package/dist/esm/firebase/firebase.d.ts

@@ -5,7 +5,7 @@ export declare class Firebase {
     readonly firestore: Firestore;
     constructor();
     onInit(): Promise<boolean>;
-    query(collectionName: string, constraint: QueryFieldFilterConstraint): {
+    query(collectionName: string, constraint: QueryFieldFilterConstraint, unsubscribeWhenData?: boolean): {
         promise: Promise<QuerySnapshot<DocumentData>>;
         unsubscribe: () => void;
     };

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

@@ -1 +1,2 @@
 export declare const asyncTry: <T>(promise: Promise<T>) => Promise<[Error, T] | [Error]>;
+export declare const asyncWait: (ms: number) => Promise<unknown>;

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

@@ -16,7 +16,7 @@ export declare class Config {
         url: string;
     };
     get config(): {
-        avatarTimeout: string;
-        vtoTimeout: string;
+        avatarTimeout: number;
+        vtoTimeout: number;
     };
 }

package/dist/esm/index.js

@@ -1,5 +1,5 @@
 /*!
-* thefittingroom v0.0.3 (2023-07-18T18:14:19.719Z)
+* thefittingroom v0.0.7 (2023-07-19T15:29:31.094Z)
 * Copyright 2022-present, TheFittingRoom, Inc. All rights reserved.
 */
 /**
@@ -16350,8 +16350,8 @@ const devKeys = {
         url: "https://tfr.dev.thefittingroom.xyz",
     },
     config: {
-        avatarTimeout: "120000",
-        vtoTimeout: "120000",
+        avatarTimeout: Number("120000"),
+        vtoTimeout: Number("120000"),
     },
 };
 const prodKeys = {
@@ -16367,8 +16367,8 @@ const prodKeys = {
         url: "https://tfr.p.thefittingroom.xyz",
     },
     config: {
-        avatarTimeout: "120000",
-        vtoTimeout: "120000",
+        avatarTimeout: Number("120000"),
+        vtoTimeout: Number("120000"),
     },
 };
 
@@ -22809,6 +22809,20 @@ class FirebaseUser {
         const userProfile = await Ol(Aa(this.firestore, 'users', this.id));
         return userProfile.data();
     }
+    watchUserProfileForChanges(predicate, timeout) {
+        let unsub;
+        const q = sl(Ta(this.firestore, 'users'), rl(Eh(), '==', this.id));
+        const cancel = setTimeout(() => unsub(), timeout);
+        return new Promise((resolve) => {
+            unsub = jl(q, (snapshot) => {
+                if (!predicate(snapshot))
+                    return;
+                clearTimeout(cancel);
+                unsub();
+                resolve(snapshot.docs[0].data());
+            });
+        });
+    }
     async login(username, password) {
         if (this.auth.currentUser)
             await this.auth.signOut();
@@ -22829,9 +22843,15 @@ class FirebaseUser {
 
 class Firebase {
     constructor() {
-        this.promisefyOnSnapshot = (q) => {
+        this.promisefyOnSnapshot = (q, unsubscribeWhenData) => {
             let unsub;
-            const promise = new Promise((resolve) => (unsub = jl(q, (snapshot) => resolve(snapshot))));
+            const promise = new Promise((resolve) => {
+                unsub = jl(q, (snapshot) => {
+                    resolve(snapshot);
+                    if (unsubscribeWhenData)
+                        unsub();
+                });
+            });
             return { promise, unsubscribe: () => unsub() };
         };
         const firebaseKeys = Config.getInstance().firebase;
@@ -22842,9 +22862,9 @@ class Firebase {
     onInit() {
         return this.user.onInit();
     }
-    query(collectionName, constraint) {
+    query(collectionName, constraint, unsubscribeWhenData = true) {
         const q = sl(Ta(this.firestore, collectionName), constraint);
-        return this.promisefyOnSnapshot(q);
+        return this.promisefyOnSnapshot(q, unsubscribeWhenData);
     }
     getDocs(collectionName, constraints) {
         const q = sl(Ta(this.firestore, collectionName), ...constraints);
@@ -22864,7 +22884,7 @@ const getFirebaseError = (e) => {
 const asyncTry = (promise) => promise.then((data) => [null, data]).catch((error) => [error]);
 
 class Fetcher {
-    static endpoint() {
+    static get endpoint() {
         const api = Config.getInstance().api;
         return api.url;
     }
@@ -22994,10 +23014,15 @@ class TfrShop {
         const res = await Fetcher.Post(this.user, '/ios-app-link', { phone_number: sanitizedTel }, false);
         console.log(res);
     }
-    awaitColorwaySizeAssetFrames(colorwaySizeAssetSKU) {
+    async awaitColorwaySizeAssetFrames(colorwaySizeAssetSKU) {
+        var _a, _b, _c, _d;
         if (!this.isLoggedIn)
             throw new UserNotLoggedInError();
-        return this.getColorwaySizeAssetFrames(colorwaySizeAssetSKU);
+        const predicate = (data) => { var _a, _b, _c; return Boolean((_c = (_b = (_a = data.docs[0].data()) === null || _a === void 0 ? void 0 : _a.vto) === null || _b === void 0 ? void 0 : _b[this.brandId]) === null || _c === void 0 ? void 0 : _c[colorwaySizeAssetSKU]); };
+        const userProfile = (await this.user.watchUserProfileForChanges(predicate, TfrShop.vtoTimeout));
+        if (!((_d = (_c = (_b = (_a = userProfile === null || userProfile === void 0 ? void 0 : userProfile.vto) === null || _a === void 0 ? void 0 : _a[this.brandId]) === null || _b === void 0 ? void 0 : _b[colorwaySizeAssetSKU]) === null || _c === void 0 ? void 0 : _c.frames) === null || _d === void 0 ? void 0 : _d.length))
+            throw new NoFramesFoundError();
+        return userProfile.vto[this.brandId][colorwaySizeAssetSKU].frames;
     }
     async requestThenGetColorwaySizeAssetFrames(colorwaySizeAssetSku) {
         var _a, _b;
@@ -23066,6 +23091,8 @@ class TfrShop {
         return frames;
     }
 }
+TfrShop.avatarTimeout = 120000;
+TfrShop.vtoTimeout = 120000;
 const initShop = (brandId, env = 'dev') => {
     if (env === 'dev' || env === 'development')
         console.warn('TfrShop is in development mode');