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

package/README.dev.md

@@ -1,12 +1,12 @@
 # Sizebay Core SDK - Development Guide
 
 This guide is intended to help developers understand the project structure, how to create and integrate new modules, run tests, and configure automated releases with Semantic Release.
-
+-- teste bot publish
 ---
 
 ## Project Structure
 
-The project is organized as follows:
+The project is organized as follows: 
 
 ```
 📦src

package/README.md

@@ -296,6 +296,133 @@ console.log(imgComp.baseProduct, imgComp.complementary);
 
 ---
 
+## Permalink Search Services
+
+### `searchSimilarByPermalink(payload: GetSimilarByPermalinkBodyDto): Promise<GetSimilarProductsResponse>`
+
+Find visually similar items from a product permalink or productId using AI-powered image analysis.
+
+#### Payload
+
+<!-- DOCGEN:params GetSimilarByPermalinkBodyDto -->
+| 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). |
+<!-- /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 -->
+
+#### 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"
+});
+console.log(similarProducts.data);
+```
+
+### `searchComplementaryByPermalink(payload: GetComplementaryByPermalinkBodyDto): Promise<GetComplementaryProductsResponse>`
+
+Find complementary products from a product permalink or productId using AI-powered analysis.
+
+#### Payload
+
+<!-- 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 -->
+
+#### 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 -->
+
+#### 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);
+```
+
+---
+
 ## Session Module
 
 Retrieves and caches session context:
@@ -461,4 +588,4 @@ ClothType.TOP         // For shirts, blouses, jackets
 ClothType.BOTTOM      // For pants, skirts, shorts
 ClothType.FULL_BODY   // For dresses, jumpsuits
 ClothType.SHOE_ACCESSORY // For shoes, accessories
-```
+```

package/dist/config/index.d.ts

@@ -2,9 +2,11 @@ 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/helpers/auth-helper.d.ts

@@ -0,0 +1,5 @@
+export interface AuthHeaders {
+    Authorization?: string;
+    'x-credit-api-key'?: string;
+}
+export declare function buildAuthHeaders(token?: string, apiKey?: string): AuthHeaders;

package/dist/modules/ai-image-service.d.ts

@@ -1,5 +1,5 @@
 import { Config } from '../config';
-import { GetSimilarProductsParams, GetComplementaryProductsParams, GetSimilarByImageBodyDto, GetComplementaryByImageBodyDto, GetSimilarProductsResponse, GetComplementaryProductsResponse, GetComplementaryProductsByImageResponse } from '../types/ai-image';
+import { GetSimilarProductsParams, GetComplementaryProductsParams, GetSimilarByImageBodyDto, GetComplementaryByImageBodyDto, GetSimilarByPermalinkBodyDto, GetComplementaryByPermalinkBodyDto, GetSimilarProductsResponse, GetComplementaryProductsResponse, GetComplementaryProductsByImageResponse } from '../types/ai-image';
 export declare class AIImageService {
     private endpoint;
     constructor(config: Config);
@@ -8,4 +8,6 @@ export declare class AIImageService {
     getComplementaryProducts(params: GetComplementaryProductsParams): Promise<GetComplementaryProductsResponse>;
     searchSimilarByImage(payload: GetSimilarByImageBodyDto): Promise<GetSimilarProductsResponse>;
     searchComplementaryByImage(payload: GetComplementaryByImageBodyDto): Promise<GetComplementaryProductsByImageResponse>;
+    searchSimilarByPermalink(payload: GetSimilarByPermalinkBodyDto): Promise<GetSimilarProductsResponse>;
+    searchComplementaryByPermalink(payload: GetComplementaryByPermalinkBodyDto): Promise<GetComplementaryProductsResponse>;
 }

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

@@ -0,0 +1,9 @@
+import { Config } from '../../config';
+import { GenerateTokenDto, TokenResponseDto, ValidateTokenResponseDto } from '../../types/fashion-looks';
+export declare class FashionLooksAuth {
+    private endpoint;
+    private config;
+    constructor(config: Config);
+    generateToken(payload: GenerateTokenDto): Promise<TokenResponseDto>;
+    validateToken(token?: string): Promise<ValidateTokenResponseDto>;
+}

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

@@ -0,0 +1,8 @@
+import { Config } from '../../config';
+import { CreateGroupedLookFeedbackDto, GroupedLookFeedbackResponseDto } from '../../types/fashion-looks';
+export declare class FashionLooksGroupedLooksFeedback {
+    private endpoint;
+    private config;
+    constructor(config: Config);
+    createFeedback(payload: CreateGroupedLookFeedbackDto): Promise<GroupedLookFeedbackResponseDto>;
+}

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

@@ -0,0 +1,15 @@
+import { Config } from '../../config';
+import { GroupedLookResponseDto, UpdateGroupedLookDto, GetGroupedLooksParams, GetGroupedLooksResponse } from '../../types/fashion-looks';
+export declare class FashionLooksGroupedLooks {
+    private endpoint;
+    private config;
+    constructor(config: Config);
+    private appendQueryParams;
+    getGroupedLooks(params?: GetGroupedLooksParams): Promise<GetGroupedLooksResponse>;
+    getGroupedLookById(id: string): Promise<GroupedLookResponseDto>;
+    updateGroupedLook(id: string, payload: UpdateGroupedLookDto): Promise<GroupedLookResponseDto>;
+    getPublicGroupedLooks(params: GetGroupedLooksParams & {
+        tenantId: number;
+    }): Promise<GetGroupedLooksResponse>;
+    getPublicGroupedLookById(id: string, tenantId: number): Promise<GroupedLookResponseDto>;
+}

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

@@ -0,0 +1,6 @@
+export { FashionLooksAuth } from './auth';
+export { FashionLooksWallet } from './wallet';
+export { FashionLooksPlans } from './plans';
+export { FashionLooksTryon } from './tryon';
+export { FashionLooksGroupedLooks } from './grouped-looks';
+export { FashionLooksGroupedLooksFeedback } from './grouped-looks-feedback';

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

@@ -0,0 +1,10 @@
+import { Config } from '../../config';
+import { Plan } from '../../types/fashion-looks';
+export declare class FashionLooksPlans {
+    private endpoint;
+    private config;
+    constructor(config: Config);
+    getAllPlans(): Promise<Plan[]>;
+    getPlanById(planId: string): Promise<Plan>;
+    getTenantActivePlan(tenantId: number): Promise<Plan>;
+}

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

@@ -0,0 +1,14 @@
+import { Config } from '../../config';
+import { GenerateTryonDto, TryonTaskResponseDto, TryonDetails, FindProductByTenantDto, ProductItemResponseDto } from '../../types/fashion-looks';
+export declare class FashionLooksTryon {
+    private endpoint;
+    private config;
+    constructor(config: Config);
+    generateTryon(payload: GenerateTryonDto): Promise<TryonTaskResponseDto>;
+    getTryonById(id: string): Promise<TryonDetails>;
+    getTryonHistory(params?: {
+        limit?: number;
+        offset?: number;
+    }): Promise<TryonDetails[]>;
+    findProductsByTenant(payload: FindProductByTenantDto): Promise<ProductItemResponseDto>;
+}

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

@@ -0,0 +1,12 @@
+import { Config } from '../../config';
+import { WalletBalanceDto, TransactionHistoryResponse } from '../../types/fashion-looks';
+export declare class FashionLooksWallet {
+    private endpoint;
+    private config;
+    constructor(config: Config);
+    getBalance(): Promise<WalletBalanceDto>;
+    getTransactionHistory(params?: {
+        limit?: number;
+        offset?: number;
+    }): Promise<TransactionHistoryResponse>;
+}

package/dist/modules/index.d.ts

@@ -1,4 +1,10 @@
 import { Tracker } from './tracker';
 import { AIImageService } from './ai-image-service';
 import { SessionManager } from './sessions';
-export declare const moduleClasses: (typeof Tracker | typeof AIImageService | typeof SessionManager)[];
+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)[];