@thefittingroom/sdk 0.0.1-alpha.10 → 0.0.6

package/.env.example

@@ -1,12 +1,21 @@
-FIREBASE_API_KEY
-FIREBASE_AUTH_DOMAIN
-FIREBASE_PROJECT_ID
-FIREBASE_STORAGE_BUCKET
-FIREBASE_MESSAGING_SENDER_ID
-FIREBASE_APP_ID
-FIREBASE_MEASUREMENT_ID
-API_ENDPOINT
-LANGUAGE_URL
-ASSETS_URL
-VTO_TIMEOUT_MS
-AVATAR_TIMEOUT_MS
+DEV_FIREBASE_API_KEY=
+DEV_FIREBASE_AUTH_DOMAIN=
+DEV_FIREBASE_PROJECT_ID=
+DEV_FIREBASE_STORAGE_BUCKET=
+DEV_FIREBASE_MESSAGING_SENDER_ID=
+DEV_FIREBASE_APP_ID=
+DEV_FIREBASE_MEASUREMENT_ID=
+DEV_API_ENDPOINT=
+DEV_VTO_TIMEOUT_MS=
+DEV_AVATAR_TIMEOUT_MS=
+
+PROD_FIREBASE_API_KEY=
+PROD_FIREBASE_AUTH_DOMAIN=
+PROD_FIREBASE_PROJECT_ID=
+PROD_FIREBASE_STORAGE_BUCKET=
+PROD_FIREBASE_MESSAGING_SENDER_ID=
+PROD_FIREBASE_APP_ID=
+PROD_FIREBASE_MEASUREMENT_ID=
+PROD_API_ENDPOINT=
+PROD_VTO_TIMEOUT_MS=
+PROD_AVATAR_TIMEOUT_MS=

package/README.md

@@ -0,0 +1,94 @@
+# 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)
+await shop.onInit()
+```
+
+### Shop API
+
+#### Auth
+
+```typescript
+// 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,9 +1,12 @@
 import { FirebaseUser } from '../firebase/firebase-user';
 export declare class Fetcher {
+    private static get endpoint();
     private static Fetch;
-    static Get(user: FirebaseUser, endpointPath: string): Promise<Response>;
-    static Post(user: FirebaseUser, endpointPath: string, body?: Record<string, any>): Promise<Response>;
-    static Put(user: FirebaseUser, endpointPath: string, body: Record<string, any>): Promise<Response>;
-    static Patch(user: FirebaseUser, endpointPath: string, body: Record<string, any>): Promise<Response>;
-    static Delete(user: FirebaseUser, endpointPath: string, body: Record<string, any>): Promise<Response>;
+    private static getUrl;
+    private static getHeaders;
+    static Get(user: FirebaseUser, endpointPath: string, useToken?: boolean): Promise<Response>;
+    static Post(user: FirebaseUser, endpointPath: string, body?: Record<string, any>, useToken?: boolean): Promise<Response>;
+    static Put(user: FirebaseUser, endpointPath: string, body: Record<string, any>, useToken?: boolean): Promise<Response>;
+    static Patch(user: FirebaseUser, endpointPath: string, body: Record<string, any>, useToken?: boolean): Promise<Response>;
+    static Delete(user: FirebaseUser, endpointPath: string, body: Record<string, any>, useToken?: boolean): Promise<Response>;
 }

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

@@ -4,14 +4,17 @@ import { SizeRecommendation } from './responses';
 export declare class TfrShop {
     private readonly brandId;
     private readonly firebase;
-    private static AVATAR_TIMEOUT;
-    constructor(brandId: string, firebase: Firebase);
-    get user(): import("../firebase/firebase-user").FirebaseUser;
+    private static avatarTimeout;
+    static vtoTimeout: number;
+    constructor(brandId: number, firebase: Firebase);
+    get user(): import("..").FirebaseUser;
     get isLoggedIn(): boolean;
-    tryOn(colorwaySizeAssetSku: string): Promise<types.TryOnFrames>;
+    onInit(): Promise<boolean>;
+    tryOn(colorwaySizeAssetSku: string): Promise<any>;
     awaitAvatarCreated(): Promise<boolean>;
-    getRecommendedSize(brandStyleId: string): Promise<SizeRecommendation>;
+    getRecommendedSizes(brandStyleId: string): Promise<SizeRecommendation>;
     getStyles(ids: number[], skus: string[]): Promise<Map<number, types.FirestoreStyle>>;
+    submitTelephoneNumber(tel: string): Promise<void>;
     private awaitColorwaySizeAssetFrames;
     private requestThenGetColorwaySizeAssetFrames;
     private getColorwaySizeAssetFromSku;
@@ -19,4 +22,4 @@ export declare class TfrShop {
     private requestColorwaySizeAssetFrames;
     private getColorwaySizeAssetFrames;
 }
-export declare const initShop: (brandId: string) => TfrShop;
+export declare const initShop: (brandId: number, env?: string) => TfrShop;

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

@@ -7,7 +7,7 @@ export declare class FirebaseUser {
     private readonly auth;
     constructor(firestore: Firestore, app: firebase.FirebaseApp);
     get id(): string;
-    onInit(): Promise<void>;
+    onInit(): Promise<boolean>;
     setUser(user: firebaseAuth.User): void;
     getToken(): Promise<string>;
     getUserProfile(): Promise<import("@firebase/firestore").DocumentData>;

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

@@ -1,11 +1,10 @@
-import { DocumentData, QueryFieldFilterConstraint, QuerySnapshot } from 'firebase/firestore';
+import { DocumentData, Firestore, QueryFieldFilterConstraint, QuerySnapshot } from 'firebase/firestore';
 import { FirebaseUser } from './firebase-user';
 export declare class Firebase {
     user: FirebaseUser;
-    private static readonly App;
-    private readonly firestore;
+    readonly firestore: Firestore;
     constructor();
-    onInit(): Promise<void>;
+    onInit(): Promise<boolean>;
     query(collectionName: string, constraint: QueryFieldFilterConstraint): {
         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

@@ -0,0 +1,22 @@
+export declare class Config {
+    private static instance;
+    private env;
+    private constructor();
+    static getInstance(): Config;
+    setEnv(env: string): void;
+    get firebase(): {
+        apiKey: string;
+        authDomain: string;
+        projectId: string;
+        storageBucket: string;
+        messagingSenderId: string;
+        appId: string;
+    };
+    get api(): {
+        url: string;
+    };
+    get config(): {
+        avatarTimeout: number;
+        vtoTimeout: number;
+    };
+}

package/dist/esm/index.d.ts

@@ -2,5 +2,8 @@ export * as requests from './api/requests';
 export * as responses from './api/responses';
 export { initShop } from './api/shop';
 export type { TfrShop } from './api/shop';
+export type { Firebase } from './firebase/firebase';
+export type { FirebaseUser } from './firebase/firebase-user';
 export * as Errors from './helpers/errors';
 export * as types from './types';
+export declare const VTO_TIMEOUT_MS: number;

package/dist/esm/index.js

@@ -1,19 +1,7 @@
 /*!
-* thefittingroom v0.0.1-alpha.9 (2023-07-17T20:26:11.306Z)
+* thefittingroom v0.0.6 (2023-07-18T23:18:09.529Z)
 * Copyright 2022-present, TheFittingRoom, Inc. All rights reserved.
 */
-// Code generated by tygo. DO NOT EDIT.
-
-var requests = /*#__PURE__*/Object.freeze({
-    __proto__: null
-});
-
-// Code generated by tygo. DO NOT EDIT.
-
-var responses = /*#__PURE__*/Object.freeze({
-    __proto__: null
-});
-
 /**
  * @license
  * Copyright 2017 Google LLC
@@ -16314,6 +16302,76 @@ var version$1 = "9.15.0";
  */
 registerVersion(name$1, version$1, 'app');
 
+class Config {
+    constructor() { }
+    static getInstance() {
+        if (!Config.instance)
+            Config.instance = new Config();
+        return Config.instance;
+    }
+    setEnv(env) {
+        switch (env) {
+            case 'production':
+            case 'prod':
+                this.env = 'prod';
+                break;
+            case 'development':
+            case 'dev':
+            default:
+                this.env = 'dev';
+        }
+    }
+    get firebase() {
+        if (this.env === 'prod')
+            return prodKeys.firebase;
+        return devKeys.firebase;
+    }
+    get api() {
+        if (this.env === 'prod')
+            return prodKeys.api;
+        return devKeys.api;
+    }
+    get config() {
+        if (this.env === 'prod')
+            return prodKeys.config;
+        return devKeys.config;
+    }
+}
+const devKeys = {
+    firebase: {
+        apiKey: "AIzaSyDfjBWzpmzb-mhGN8VSURxzLg6nkzmKUD8",
+        authDomain: "fittingroom-dev-5d248.firebaseapp.com",
+        projectId: "fittingroom-dev-5d248",
+        storageBucket: "fittingroom-dev-5d248.appspot.com",
+        messagingSenderId: "2298664147",
+        appId: "1:2298664147:web:340bda75cd5d25f3997026",
+    },
+    api: {
+        url: "https://tfr.dev.thefittingroom.xyz",
+    },
+    config: {
+        avatarTimeout: Number("120000"),
+        vtoTimeout: Number("120000"),
+    },
+};
+const prodKeys = {
+    firebase: {
+        apiKey: "AIzaSyA3kQ6w1vkA9l9lgY0nNACVPXe-QmP5T1Y",
+        authDomain: "fittingroom-prod.firebaseapp.com",
+        projectId: "fittingroom-prod",
+        storageBucket: "fittingroom-prod.appspot.com",
+        messagingSenderId: "965656825574",
+        appId: "1:965656825574:web:933493cddc73213bd43527",
+    },
+    api: {
+        url: "https://tfr.p.thefittingroom.xyz",
+    },
+    config: {
+        avatarTimeout: Number("120000"),
+        vtoTimeout: Number("120000"),
+    },
+};
+
 /******************************************************************************
 Copyright (c) Microsoft Corporation.
 
@@ -22727,11 +22785,10 @@ class FirebaseUser {
     }
     onInit() {
         return new Promise((resolve) => {
-            this.auth.onAuthStateChanged((user) => {
+            const unsub = this.auth.onAuthStateChanged((user) => {
                 this.setUser(user);
-                if (user)
-                    return resolve();
-                throw new UserNotLoggedInError();
+                resolve(Boolean(user));
+                unsub();
             });
         });
     }
@@ -22777,8 +22834,10 @@ class Firebase {
             const promise = new Promise((resolve) => (unsub = jl(q, (snapshot) => resolve(snapshot))));
             return { promise, unsubscribe: () => unsub() };
         };
-        this.firestore = oh(Firebase.App);
-        this.user = new FirebaseUser(this.firestore, Firebase.App);
+        const firebaseKeys = Config.getInstance().firebase;
+        const firebaseApp = initializeApp(firebaseKeys);
+        this.firestore = oh(firebaseApp);
+        this.user = new FirebaseUser(this.firestore, firebaseApp);
     }
     onInit() {
         return this.user.onInit();
@@ -22792,14 +22851,6 @@ class Firebase {
         return Bl(q);
     }
 }
-Firebase.App = initializeApp({
-    apiKey: "AIzaSyDfjBWzpmzb-mhGN8VSURxzLg6nkzmKUD8",
-    authDomain: "fittingroom-dev-5d248.firebaseapp.com",
-    projectId: "fittingroom-dev-5d248",
-    storageBucket: "fittingroom-dev-5d248.appspot.com",
-    messagingSenderId: "2298664147",
-    appId: "1:2298664147:web:340bda75cd5d25f3997026",
-});
 
 const getFirebaseError = (e) => {
     switch (e.code) {
@@ -22811,15 +22862,16 @@ const getFirebaseError = (e) => {
 };
 
 const asyncTry = (promise) => promise.then((data) => [null, data]).catch((error) => [error]);
+const asyncWait = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
 
 class Fetcher {
-    static async Fetch({ user, endpointPath, method, body }) {
-        const url = "https://tfr.dev.thefittingroom.xyz/v1" + endpointPath;
-        const token = await user.getToken();
-        const headers = {
-            'Content-Type': 'application/json',
-            Authorization: `Bearer ${token}`,
-        };
+    static get endpoint() {
+        const api = Config.getInstance().api;
+        return api.url;
+    }
+    static async Fetch({ user, endpointPath, method, body, useToken = true }) {
+        const url = this.getUrl(endpointPath, useToken);
+        const headers = await this.getHeaders(user, useToken);
         const config = { method, headers, credentials: 'include' };
         if (body)
             config.body = JSON.stringify(body);
@@ -22831,20 +22883,32 @@ class Fetcher {
         const json = await res.json();
         return Promise.reject(json);
     }
-    static Get(user, endpointPath) {
-        return this.Fetch({ user, endpointPath, method: 'GET', body: null });
+    static getUrl(endpointPath, useToken) {
+        return useToken ? `${this.endpoint}/v1${endpointPath}` : this.endpoint + endpointPath;
+    }
+    static async getHeaders(user, useToken) {
+        if (!useToken)
+            return { 'Content-Type': 'application/json' };
+        const token = await user.getToken();
+        return {
+            'Content-Type': 'application/json',
+            Authorization: `Bearer ${token}`,
+        };
+    }
+    static Get(user, endpointPath, useToken) {
+        return this.Fetch({ user, endpointPath, method: 'GET', body: null, useToken });
     }
-    static Post(user, endpointPath, body = null) {
-        return this.Fetch({ user, endpointPath, method: 'POST', body });
+    static Post(user, endpointPath, body = null, useToken) {
+        return this.Fetch({ user, endpointPath, method: 'POST', body, useToken });
     }
-    static Put(user, endpointPath, body) {
-        return this.Fetch({ user, endpointPath, method: 'PUT', body });
+    static Put(user, endpointPath, body, useToken) {
+        return this.Fetch({ user, endpointPath, method: 'PUT', body, useToken });
     }
-    static Patch(user, endpointPath, body) {
-        return this.Fetch({ user, endpointPath, method: 'PATCH', body });
+    static Patch(user, endpointPath, body, useToken) {
+        return this.Fetch({ user, endpointPath, method: 'PATCH', body, useToken });
     }
-    static Delete(user, endpointPath, body) {
-        return this.Fetch({ user, endpointPath, method: 'DELETE', body });
+    static Delete(user, endpointPath, body, useToken) {
+        return this.Fetch({ user, endpointPath, method: 'DELETE', body, useToken });
     }
 }
 
@@ -22861,6 +22925,9 @@ class TfrShop {
     constructor(brandId, firebase) {
         this.brandId = brandId;
         this.firebase = firebase;
+        const config = Config.getInstance().config;
+        TfrShop.avatarTimeout = config.avatarTimeout ? Number(config.avatarTimeout) : 120000;
+        TfrShop.vtoTimeout = config.vtoTimeout ? Number(config.vtoTimeout) : 120000;
     }
     get user() {
         return this.firebase.user;
@@ -22868,6 +22935,9 @@ class TfrShop {
     get isLoggedIn() {
         return !this.firebase || Boolean(this.user.id);
     }
+    onInit() {
+        return this.firebase.onInit();
+    }
     async tryOn(colorwaySizeAssetSku) {
         if (!this.isLoggedIn)
             throw new UserNotLoggedInError();
@@ -22876,8 +22946,8 @@ class TfrShop {
             return frames;
         }
         catch (error) {
-            if (error instanceof NoFramesFoundError)
-                throw new NoFramesFoundError();
+            if (!(error instanceof NoFramesFoundError))
+                throw error;
             return this.requestThenGetColorwaySizeAssetFrames(colorwaySizeAssetSku);
         }
     }
@@ -22888,13 +22958,13 @@ class TfrShop {
         const cancel = setTimeout(() => {
             unsubscribe();
             throw new RequestTimeoutError();
-        }, TfrShop.AVATAR_TIMEOUT);
+        }, TfrShop.avatarTimeout);
         const snapshot = await promise;
         clearTimeout(cancel);
         const userProfile = snapshot.docs[0].data();
         return userProfile.avatar_status === 'CREATED';
     }
-    async getRecommendedSize(brandStyleId) {
+    async getRecommendedSizes(brandStyleId) {
         if (!this.isLoggedIn)
             throw new UserNotLoggedInError();
         const res = await Fetcher.Get(this.user, `/styles/${brandStyleId}/recommendation`);
@@ -22920,10 +22990,23 @@ class TfrShop {
             return getFirebaseError(error);
         }
     }
-    awaitColorwaySizeAssetFrames(colorwaySizeAssetSKU) {
+    async submitTelephoneNumber(tel) {
+        const sanitizedTel = tel.replace(/[^\+0-9]/g, '');
+        const res = await Fetcher.Post(this.user, '/ios-app-link', { phone_number: sanitizedTel }, false);
+        console.log(res);
+    }
+    async awaitColorwaySizeAssetFrames(colorwaySizeAssetSKU) {
         if (!this.isLoggedIn)
             throw new UserNotLoggedInError();
-        return this.getColorwaySizeAssetFrames(colorwaySizeAssetSKU);
+        console.log('polling');
+        try {
+            const frames = await this.getColorwaySizeAssetFrames(colorwaySizeAssetSKU);
+            return frames;
+        }
+        catch (_a) {
+            await asyncWait(1500);
+            return this.awaitColorwaySizeAssetFrames(colorwaySizeAssetSKU);
+        }
     }
     async requestThenGetColorwaySizeAssetFrames(colorwaySizeAssetSku) {
         var _a, _b;
@@ -22992,8 +23075,26 @@ class TfrShop {
         return frames;
     }
 }
-TfrShop.AVATAR_TIMEOUT = process.env.AVATAR_TIMEOUT ? Number(process.env.AVATAR_TIMEOUT) : 10000;
-const initShop = (brandId) => new TfrShop(brandId, new Firebase());
+TfrShop.avatarTimeout = 120000;
+TfrShop.vtoTimeout = 120000;
+const initShop = (brandId, env = 'dev') => {
+    if (env === 'dev' || env === 'development')
+        console.warn('TfrShop is in development mode');
+    Config.getInstance().setEnv(env);
+    return new TfrShop(brandId, new Firebase());
+};
+
+// Code generated by tygo. DO NOT EDIT.
+
+var requests = /*#__PURE__*/Object.freeze({
+    __proto__: null
+});
+
+// Code generated by tygo. DO NOT EDIT.
+
+var responses = /*#__PURE__*/Object.freeze({
+    __proto__: null
+});
 
 var AvatarState;
 (function (AvatarState) {
@@ -23007,5 +23108,7 @@ var index = /*#__PURE__*/Object.freeze({
     get AvatarState () { return AvatarState; }
 });
 
-export { errors as Errors, initShop, requests, responses, index as types };
+const VTO_TIMEOUT_MS = TfrShop.vtoTimeout;
+
+export { errors as Errors, VTO_TIMEOUT_MS, initShop, requests, responses, index as types };
 //# sourceMappingURL=index.js.map