@thefittingroom/sdk 2.0.0 → 2.0.2

package/README.md

@@ -1,110 +1,104 @@
-# The Fitting Room - Shop SDK
+# The Fitting Room – Shop SDK
 
-### Installation
+Modern ESM SDK for integrating **The Fitting Room** into Shopify storefronts.
 
-```bash
-npm i @thefittingroom/shop-sdk
-```
+* **Production-ready** bundle published to npm and the `unpkg` CDN.
+* **Type-safe** API (written in TypeScript).
+* Supports both **development** and **production** environments.
 
-or
+---
+
+## ✨ Quick Start
 
 ```bash
-yarn @thefittingroom/shop-sdk
+# Stable / production build
+npm install @thefittingroom/sdk
+
+# Next / development build
+npm install @thefittingroom/sdk@next
 ```
 
-### Build
+```ts
+import { initShop } from "@thefittingroom/sdk"
 
-```bash
-npm run build
+const brandId = 9001
+// env = "prod" | "dev"
+const shop   = initShop(brandId, "prod")
 ```
 
-or
+### Via CDN
 
-```bash
-yarn build
-```
+```html
+<!-- Latest production build -->
+<script type="module" src="https://unpkg.com/@thefittingroom/sdk@latest/dist/index.mjs"></script>
 
-### Development
+<!-- Specific version (recommended) -->
+<script type="module" src="https://unpkg.com/@thefittingroom/sdk@1.2.3/dist/index.mjs"></script>
 
-```bash
-npm run watch
+<!-- Development build -->
+<script type="module" src="https://unpkg.com/@thefittingroom/sdk@next/dist/index.mjs"></script>
 ```
 
-or
+---
 
-```bash
-yarn watch
-```
+## 🔖 Semantic Versioning & Release Channels
 
-## Usage
+This package follows [SemVer 2.0.0](https://semver.org/): **MAJOR.MINOR.PATCH**
 
-```typescript
-import { initShop } from '@thefittingroom/sdk'
+* **MAJOR** – Breaking changes. Partners must opt-in to upgrade.
+* **MINOR** – Back-compatible feature additions.
+* **PATCH** – Back-compatible bug fixes.
 
-// Your brandId: Number
-const brandId = 9001
+### Automated release pipeline (GitHub Actions)
 
-// The environment: 'development', 'dev', 'production', 'prod'
-const env = 'dev'
-const shop = initShop(brandId, env)
-```
+| Trigger | Workflow | Result |
+|---------|----------|--------|
+| Pull request → `main` | `PR Label Guard` | PR must carry `patch`, `minor`, or `major` label – otherwise CI fails and merge is blocked. |
+| Merge → `main` | `Deploy to dev` | CI bumps version (according to PR label), publishes build to npm with `next` tag, and uploads assets to dev S3 bucket. |
+| GitHub Release | `Production Release` | Tag (e.g. `v2.3.0`) is published to npm with `latest` tag and assets uploaded to prod S3 bucket. |
+
+Guidelines for consumers:
 
-### Shop API
+```text
+^1.x   → always safe (only minor/patches)
+~1.2.0 → locks to patch updates only
+1.2.3  → locks to a specific publish
+```
 
-#### Auth
+## 🛠️ Scripts
 
-```typescript
-// Hook used to check authentication, return isLoggedIn Promise<boolean>
-await shop.onInit()
+| Command | Description |
+|---------|-------------|
+| `npm run build`  | Create production bundle in `dist/` |
+| `npm run watch`  | Re-build on change (development) |
 
-// Login user with session
-shop.user.login(email, password)
+---
 
-// Logout current user
-shop.user.logout()
+## 📚 API Overview
 
-// Set the brand userId, the internal userId used by the shop/brand
-// This is a required field for requesting a VTO
-// string | number
-shop.user.setBrandUserId(brandUserId)
+### Authentication
 
-// 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)
+```ts
+await shop.onInit()                 // isLoggedIn: boolean
+shop.user.login(email, password)    // start session
+shop.user.logout()                  // end session
+shop.user.setBrandUserId(id)        // required for VTO
+shop.submitTelephoneNumber('+18005551234')
 ```
 
-#### 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
-// 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, such as the ID of the style, which you can use
-// for the getRecommendedSizes function below.
-// 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 getColorwaySizeAssetFromSku function call.
-// styleId: string
-// returns: SizeRecommendation
+### Shop helpers
+
+```ts
+const locations          = await shop.getMeasurementLocationsFromSku(sku)
+const colorwaySizeAsset  = await shop.getColorwaySizeAssetFromSku(sku)
 const sizeRecommendation = shop.getRecommendedSizes(styleId)
 ```
 
-[Types Reference](https://github.com/TheFittingRoom/shop-sdk/blob/main/src/types/index.ts)
+Full type definitions live in [`src/types`](./src/types/index.ts).
 
-#### Errors
+### Error classes
 
-```typescript
+```ts
 AvatarNotCreatedError
 UserNotLoggedInError
 NoColorwaySizeAssetsFoundError

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

@@ -6,10 +6,10 @@ export declare class Firebase {
     constructor();
     onInit(brandId: number): Promise<boolean>;
     query(collectionName: string, constraint: QueryFieldFilterConstraint, unsubscribeWhenData?: boolean): {
-        promise: Promise<QuerySnapshot<DocumentData>>;
+        promise: Promise<QuerySnapshot<DocumentData, DocumentData>>;
         unsubscribe: () => void;
     };
-    getDocs(collectionName: string, constraints: QueryFieldFilterConstraint[]): Promise<QuerySnapshot<DocumentData>>;
+    getDocs(collectionName: string, constraints: QueryFieldFilterConstraint[]): Promise<QuerySnapshot<DocumentData, DocumentData>>;
     getDoc(collectionName: string, id: string): Promise<DocumentData>;
     private promisefyOnSnapshot;
 }