sizebay-core-sdk 1.12.0-dev.1 → 1.12.0-dev.3

package/README.md

@@ -4,6 +4,7 @@ A modular SDK for integrating Sizebay services into your application. Features e
 
 - Event tracking
 - AI image recommendations (similar / complementary / sizing)
+- Fashion looks (grouped looks with try-ons)
 - Session & profile management
 - Environment-aware endpoints (`-dev` / `-prod`)
 - Full TypeScript typings
@@ -16,6 +17,7 @@ A modular SDK for integrating Sizebay services into your application. Features e
 2. [Quick Start](#quick-start)
 3. [Tracker Module](#tracker-module)
 4. [AI Image Service Module](#ai-image-service-module)
+5. [Fashion Looks Module](#fashion-looks-module)
 6. [Session Module](#session-module)
 7. [DTO Reference](#dto-reference)
 
@@ -296,129 +298,86 @@ console.log(imgComp.baseProduct, imgComp.complementary);
 
 ---
 
-## Permalink Search Services
+## Fashion Looks Module
 
-### `searchSimilarByPermalink(payload: GetSimilarByPermalinkBodyDto): Promise<GetSimilarProductsResponse>`
+### `getGroupedLooks(params: GetGroupedLooksParams): Promise<GroupedLooksListResponse>`
 
-Find visually similar items from a product permalink or productId using AI-powered image analysis.
+Get grouped looks with optional filters and pagination (Public endpoint).
 
-#### Payload
+#### Parameters
 
-<!-- DOCGEN:params GetSimilarByPermalinkBodyDto -->
+<!-- DOCGEN:params GetGroupedLooksParams -->
 | Field | Type | Required | Description |
 | ----- | ---- | :------: | ----------- |
-| `permalink` | string |  No  | The URL permalink of the reference product for the similarity search. |
-| `productId` | string |  No  | Product ID (either permalink or productId must be provided). |
-| `ageRange` | string |  No  | Target age range. |
-| `gender` | string |  No  | User gender (optional). |
-| `style` | string |  No  | Preferred style hint. |
-| `color` | string |  No  | Main color of interest. |
-| `productClass` | ProductClass |  No  | Target product class. |
-| `clothType` | ClothType |  No  | Target cloth type for filtering results. |
-| `page` | number |  No  | Current page number. |
-| `perPage` | number |  No  | Number of results per page. |
-| `similarityThreshold` | number |  No  | Similarity threshold for matching (0-1). |
-| `tenantId` | number |  Yes  | Tenant (client) ID. |
-| `collectionName` | string |  Yes  | Embeddings collection name (namespace). |
-| `sid` | string |  Yes  | Session identifier (`sid`) for the user. |
-| `sizeSystem` | string |  Yes  | Size system code (e.g., 'BR', 'EU', 'US'). |
-| `locale` | string |  Yes  | Locale for internationalized responses (language and region). |
-| `currency` | string |  Yes  | Currency code for pricing information in responses. |
-| `filterByWhatFitsMe` | boolean |  No  | Whether to apply What Fits Me logic. |
-| `personaHash` | string |  No  | Hash representing the user persona (required if WFM is enabled). |
+| `tenantId` | number |  Yes  | Tenant ID (required). |
+| `limit` | number |  No  | Maximum number of looks to return per page (1-100).<br>Use smaller values for faster responses, larger for comprehensive results. |
+| `offset` | number |  No  | Number of looks to skip before returning results.<br>Use with limit to implement pagination: page 2 = offset 50 (if limit is 50). |
+| `order` | SortOrder |  No  | Sort order by creation date.<br>Use 'desc' to show newest looks first, 'asc' for oldest first. |
+| `permalink` | string |  No  | Filter by product permalink.<br>Find all looks that include this specific product. Useful for showing<br>styling suggestions when a user views a product page. |
+| `gender` | Gender |  No  | Filter by target gender.<br>Show only looks designed for MALE or FEMALE audiences. |
+| `ageGroup` | AgeGroup |  No  | Filter by target age group.<br>Show only looks appropriate for the specified age range. |
+| `style` | Style |  No  | Filter by style category.<br>Show only looks matching the desired style (casual, formal, party, etc.). |
+| `collection` | Collection |  No  | Filter by seasonal collection.<br>Show only looks from a specific season (spring, summer, fall, winter). |
+| `status` | GroupedLookStatus |  No  | Filter by active status.<br>Use 'enabled' to show only active looks, 'disabled' for inactive ones. |
 <!-- /DOCGEN -->
 
 #### Returns
 
-<!-- DOCGEN:returns GetSimilarProductsResponse -->
-> **`GetSimilarProductsResponse`**
-> * `data`: `ProductDto[]` — An array of products that are visually similar to the reference item.<br>The results are ordered by their similarity score.
-> * `page`: `number` — The current page number of the results.
-> * `perPage`: `number` — The number of items per page.
-> * `total`: `number` — The total number of similar products found.
-> * `invalidPersonaHash`: `boolean` — Indicates if the provided persona hash is invalid or expired,<br>which may affect personalized results.
+<!-- DOCGEN:returns GroupedLooksListResponse -->
+> **`GroupedLooksListResponse`**
+> * `data`: `GroupedLookResponseDto[]` — Fashion looks for the current page.<br>Display these looks to users. Each look contains styled outfits with try-on images.
+> * `total`: `number` — Total number of looks matching your filters across all pages.<br>Use this to show "Showing X of Y looks" or calculate total pages.
+> * `pagination`: `PaginationInfo` — Pagination information for navigating between pages.<br>Use this to implement pagination controls in your UI.
 <!-- /DOCGEN -->
 
 #### Example
 
 ```typescript
-const similarProducts = await client.searchSimilarByPermalink({
-  tenantId: 123,
-  collectionName: "products",
-  sid: "session123",
-  sizeSystem: "BR",
-  locale: "pt-BR",
-  currency: "BRL",
-  permalink: "https://example.com/products/red-dress-456",
-  similarityThreshold: 0.7,
-  page: 1,
-  perPage: 10,
-  style: "Casual",
-  color: "red"
+const looks = await client.getGroupedLooks({
+  tenantId: 1,
+  limit: 50,
+  gender: 'FEMALE',
+  style: 'casual',
+  collection: 'summer',
 });
-console.log(similarProducts.data);
+console.log(looks.data, looks.total);
 ```
 
-### `searchComplementaryByPermalink(payload: GetComplementaryByPermalinkBodyDto): Promise<GetComplementaryProductsResponse>`
+---
 
-Find complementary products from a product permalink or productId using AI-powered analysis.
+### `getGroupedLookById(id: string, tenantId: number): Promise<GroupedLookResponseDto>`
 
-#### Payload
+Get a specific grouped look by ID (Public endpoint).
 
-<!-- DOCGEN:params GetComplementaryByPermalinkBodyDto -->
-| Field | Type | Required | Description |
-| ----- | ---- | :------: | ----------- |
-| `permalink` | string |  No  | The URL permalink of the reference product. |
-| `productId` | string |  No  | Product ID (either permalink or productId must be provided). |
-| `similarityThreshold` | number |  Yes  | The minimum similarity score (0-1) for recommended products.<br>A higher value yields more similar items, while a lower value provides more variety. |
-| `baseClothType` | ClothType |  No  | Base cloth type for the reference product. |
-| `targetClothType` | ClothType |  No  | Target cloth type for complementary products. |
-| `ageRange` | string |  No  | Target age range. |
-| `gender` | string |  No  | User gender (optional). |
-| `style` | string |  No  | Preferred style hint. |
-| `color` | string |  No  | Main color of interest. |
-| `productClass` | ProductClass |  No  | Target product class. |
-| `page` | number |  No  | Current page number. |
-| `perPage` | number |  No  | Number of results per page. |
-| `tenantId` | number |  Yes  | Tenant (client) ID. |
-| `collectionName` | string |  Yes  | Embeddings collection name (namespace). |
-| `sid` | string |  Yes  | Session identifier (`sid`) for the user. |
-| `sizeSystem` | string |  Yes  | Size system code (e.g., 'BR', 'EU', 'US'). |
-| `locale` | string |  Yes  | Locale for internationalized responses (language and region). |
-| `currency` | string |  Yes  | Currency code for pricing information in responses. |
-| `filterByWhatFitsMe` | boolean |  No  | Whether to apply What Fits Me logic. |
-| `personaHash` | string |  No  | Hash representing the user persona (required if WFM is enabled). |
-<!-- /DOCGEN -->
+#### Parameters
+
+| Parameter   | Type   | Required | Description                |
+| ----------- | ------ | :------: | -------------------------- |
+| `id`        | string |   Yes    | Grouped look UUID          |
+| `tenantId`  | number |   Yes    | Tenant ID                  |
 
 #### Returns
 
-<!-- DOCGEN:returns GetComplementaryProductsResponse -->
-> **`GetComplementaryProductsResponse`**
-> * `baseProduct`: `ProductDto` — The reference product used to generate recommendations.<br>This is the item that corresponds to the permalink from the request.
-> * `complementary`: `ComplementaryPairDto[]` — A list of recommended pairs of products that are complementary to the base product.
-> * `invalidPersonaHash`: `boolean` — Indicates if the provided persona hash is invalid or has expired.<br>If true, personalization may be affected.
+<!-- DOCGEN:returns GroupedLookResponseDto -->
+> **`GroupedLookResponseDto`**
+> * `id`: `string` — Unique identifier for this fashion look (UUID).<br>Use this to fetch the look again or reference it in other operations.
+> * `tenantId`: `number` — Tenant ID that owns this look.
+> * `gender`: `Gender` — Target gender for this look (MALE or FEMALE).<br>Use to filter or categorize looks by target audience.
+> * `ageGroup`: `AgeGroup` — Target age group for this look.<br>Use to show age-appropriate looks to users.
+> * `style`: `Style` — Style category of this look.<br>Use to filter looks by style preference or display style tags.
+> * `collection`: `Collection` — Seasonal collection this look belongs to.<br>Use to show seasonal looks or filter by collection.
+> * `rate`: `number` — Quality rating of this look (0-5).<br>Higher ratings indicate better quality. Use to sort or filter by quality.
+> * `status`: `GroupedLookStatus` — Current status of this look.<br>Only show 'enabled' looks to users, hide 'disabled' ones.
+> * `timestamp`: `string` — When this look was created (ISO 8601 format).<br>Use to sort by date or show "new" looks.
+> * `tryons`: `TryonGroup[]` — All virtual try-on images organized by body type and skin tone.<br>Iterate through this to display all try-on variations. Each group represents<br>a body type, and each group contains try-ons for different skin tones.
+> * `feedback`: `GroupedLookFeedbackResponseDto` — User feedback for this look, if any has been submitted.<br>Use to display feedback or quality metrics to users.
 <!-- /DOCGEN -->
 
 #### Example
 
 ```typescript
-const complementaryProducts = await client.searchComplementaryByPermalink({
-  tenantId: 123,
-  collectionName: "products",
-  sid: "session123",
-  sizeSystem: "BR",
-  locale: "pt-BR",
-  currency: "BRL",
-  productId: "12345",
-  similarityThreshold: 0.3,
-  baseClothType: ClothType.BOTTOM,
-  targetClothType: ClothType.TOP,
-  page: 1,
-  perPage: 10,
-  style: "Casual",
-  color: "blue"
-});
-console.log(complementaryProducts.baseProduct, complementaryProducts.complementary);
+const look = await client.getGroupedLookById('uuid-here', 1);
+console.log(look.id, look.style, look.tryons);
 ```
 
 ---
@@ -589,3 +548,60 @@ ClothType.BOTTOM      // For pants, skirts, shorts
 ClothType.FULL_BODY   // For dresses, jumpsuits
 ClothType.SHOE_ACCESSORY // For shoes, accessories
 ```
+
+### `GroupedLookResponseDto`
+
+<!-- DOCGEN:params GroupedLookResponseDto -->
+| Field | Type | Required | Description |
+| ----- | ---- | :------: | ----------- |
+| `id` | string |  Yes  | Unique identifier for this fashion look (UUID).<br>Use this to fetch the look again or reference it in other operations. |
+| `tenantId` | number |  Yes  | Tenant ID that owns this look. |
+| `gender` | Gender |  Yes  | Target gender for this look (MALE or FEMALE).<br>Use to filter or categorize looks by target audience. |
+| `ageGroup` | AgeGroup |  Yes  | Target age group for this look.<br>Use to show age-appropriate looks to users. |
+| `style` | Style |  Yes  | Style category of this look.<br>Use to filter looks by style preference or display style tags. |
+| `collection` | Collection |  Yes  | Seasonal collection this look belongs to.<br>Use to show seasonal looks or filter by collection. |
+| `rate` | number |  Yes  | Quality rating of this look (0-5).<br>Higher ratings indicate better quality. Use to sort or filter by quality. |
+| `status` | GroupedLookStatus |  Yes  | Current status of this look.<br>Only show 'enabled' looks to users, hide 'disabled' ones. |
+| `timestamp` | string |  Yes  | When this look was created (ISO 8601 format).<br>Use to sort by date or show "new" looks. |
+| `tryons` | TryonGroup[] |  Yes  | All virtual try-on images organized by body type and skin tone.<br>Iterate through this to display all try-on variations. Each group represents<br>a body type, and each group contains try-ons for different skin tones. |
+| `feedback` | GroupedLookFeedbackResponseDto |  No  | User feedback for this look, if any has been submitted.<br>Use to display feedback or quality metrics to users. |
+<!-- /DOCGEN -->
+
+### `GroupedLooksListResponse`
+
+<!-- DOCGEN:params GroupedLooksListResponse -->
+| Field | Type | Required | Description |
+| ----- | ---- | :------: | ----------- |
+| `data` | GroupedLookResponseDto[] |  Yes  | Fashion looks for the current page.<br>Display these looks to users. Each look contains styled outfits with try-on images. |
+| `total` | number |  Yes  | Total number of looks matching your filters across all pages.<br>Use this to show "Showing X of Y looks" or calculate total pages. |
+| `pagination` | PaginationInfo |  Yes  | Pagination information for navigating between pages.<br>Use this to implement pagination controls in your UI. |
+<!-- /DOCGEN -->
+
+### `PaginationInfo`
+
+<!-- DOCGEN:params PaginationInfo -->
+| Field | Type | Required | Description |
+| ----- | ---- | :------: | ----------- |
+| `limit` | number |  Yes  | Number of looks returned in this page.<br>Matches the limit parameter you sent in the request. |
+| `offset` | number |  Yes  | Number of looks skipped to reach this page.<br>Matches the offset parameter you sent in the request. |
+| `hasNext` | boolean |  Yes  | Whether there are more looks available after this page.<br>Use this to show/hide "Next" button or load more functionality. |
+| `hasPrevious` | boolean |  Yes  | Whether there are looks before this page.<br>Use this to show/hide "Previous" button. |
+<!-- /DOCGEN -->
+
+### `TryonGroup`
+
+<!-- DOCGEN:params TryonGroup -->
+| Field | Type | Required | Description |
+| ----- | ---- | :------: | ----------- |
+| `bmi` | string |  Yes  | Body type identifier (e.g., 'slim', 'regular', 'plus'). |
+| `skinTones` | TryonDetails[] |  Yes  | Try-on images for different skin tones within this body type.<br>Iterate through these to show all skin tone variations for the same body type. |
+<!-- /DOCGEN -->
+
+### `TryonDetails`
+
+<!-- DOCGEN:params TryonDetails -->
+| Field | Type | Required | Description |
+| ----- | ---- | :------: | ----------- |
+| `skinTone` | string |  Yes  | Skin tone identifier (e.g., 'light', 'brown', 'dark'). |
+| `tryonDetails` | Record<string, any> |  Yes  | Try-on image data including URL and rendering metadata.<br>Contains the actual image URL and other properties needed to display the try-on. |
+<!-- /DOCGEN -->

package/dist/config/index.d.ts

@@ -2,11 +2,9 @@ import { SDKConfigOptions } from '../types';
 export declare class Config {
     private endpoints;
     private serviceOverrides;
-    private fashionLooksToken?;
     constructor(options: SDKConfigOptions);
     getEndpoint(serviceName: string): string;
     getServiceConfig(serviceName: string): {
         [key: string]: any;
     };
-    getFashionLooksToken(): string | undefined;
 }

package/dist/modules/fashion-looks.d.ts

@@ -0,0 +1,9 @@
+import { Config } from '../config';
+import { GetGroupedLooksParams, GroupedLooksListResponse, GroupedLookResponseDto } from '../types/fashion-looks';
+export declare class FashionLooks {
+    private endpoint;
+    constructor(config: Config);
+    private appendQueryParams;
+    getGroupedLooks(params: GetGroupedLooksParams): Promise<GroupedLooksListResponse>;
+    getGroupedLookById(id: string, tenantId: number): Promise<GroupedLookResponseDto>;
+}

package/dist/modules/index.d.ts

@@ -1,10 +1,5 @@
 import { Tracker } from './tracker';
 import { AIImageService } from './ai-image-service';
 import { SessionManager } from './sessions';
-import { FashionLooksAuth } from './fashion-looks/auth';
-import { FashionLooksWallet } from './fashion-looks/wallet';
-import { FashionLooksPlans } from './fashion-looks/plans';
-import { FashionLooksTryon } from './fashion-looks/tryon';
-import { FashionLooksGroupedLooks } from './fashion-looks/grouped-looks';
-import { FashionLooksGroupedLooksFeedback } from './fashion-looks/grouped-looks-feedback';
-export declare const moduleClasses: (typeof Tracker | typeof AIImageService | typeof SessionManager | typeof FashionLooksAuth | typeof FashionLooksWallet | typeof FashionLooksPlans | typeof FashionLooksTryon | typeof FashionLooksGroupedLooks | typeof FashionLooksGroupedLooksFeedback)[];
+import { FashionLooks } from './fashion-looks';
+export declare const moduleClasses: (typeof Tracker | typeof AIImageService | typeof SessionManager | typeof FashionLooks)[];