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

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:

package/dist/modules/tracker.d.ts

@@ -1,5 +1,5 @@
-import { TrackData, TrackResponse } from '../types';
 import { Config } from '../config';
+import { TrackData, TrackResponse } from '../types';
 export declare class Tracker {
     private endpoint;
     constructor(config: Config);

package/dist/sizebay-core-sdk.es.js

@@ -56,7 +56,14 @@ class S {
         const o = await i.text();
         throw new Error(`Request error: ${i.status} - ${o}`);
       }
-      return await i.json();
+      try {
+        return await i.json();
+      } catch {
+        return {
+          statusCode: 201,
+          message: "Event successfully created."
+        };
+      }
     } catch (i) {
       throw i;
     }
@@ -310,7 +317,7 @@ class T {
     });
   }
 }
-class O {
+class u {
   constructor(t) {
     this.sid = null, this.sessionId = null;
     const e = t.getEndpoint("session");
@@ -366,13 +373,13 @@ class O {
     }
   }
 }
-const u = [
+const O = [
   S,
   T,
-  O
+  u
 ];
 function m(r = {}) {
-  const t = new l(r), e = u.map((n) => new n(t)), s = {};
+  const t = new l(r), e = O.map((n) => new n(t)), s = {};
   return e.forEach((n) => {
     [
       ...Object.getOwnPropertyNames(n),
@@ -395,7 +402,7 @@ const E = {
   WETSUIT_FULL_BODY: "WETSUIT_FULL_BODY",
   WETSUIT_BOTTOM: "WETSUIT_BOTTOM",
   WETSUIT_TOP: "WETSUIT_TOP"
-}, f = {
+}, y = {
   T_SHIRT: "t-shirt",
   SHIRT: "shirt",
   BLOUSE: "blouse",
@@ -438,6 +445,6 @@ const E = {
 };
 export {
   E as ClothType,
-  f as ProductClass,
+  y as ProductClass,
   m as createClient
 };

package/dist/sizebay-core-sdk.umd.js

@@ -1 +1 @@
-(function(o,a){typeof exports=="object"&&typeof module<"u"?a(exports):typeof define=="function"&&define.amd?define(["exports"],a):(o=typeof globalThis<"u"?globalThis:o||self,a(o["sizebay-core-sdk"]={}))})(this,(function(o){"use strict";const a={tracker:{production:"https://data-event-service.internalsizebay.com",development:"https://data-event-service-dev.internalsizebay.com"},aiImageService:{production:"https://ai-image-service.internalsizebay.com",development:"https://ai-image-service-dev.internalsizebay.com"},session:{production:"https://vfr-v3-production.sizebay.technology/api/me",development:"https://vfr-v3-staging.sizebay.eu/api/me"}};class l{constructor(e){const t=e.env||"development";this.serviceOverrides=e.services||{},this.endpoints={};for(const s in a)if(Object.prototype.hasOwnProperty.call(a,s)){const i=a[s][t];if(!i)continue;this.endpoints[s]=i}}getEndpoint(e){const t=this.endpoints[e];if(!t)throw new Error(`Endpoint for service '${e}' is not configured.`);return t}getServiceConfig(e){return this.serviceOverrides[e]||{}}}class S{constructor(e){this.endpoint=e.getEndpoint("tracker")}async track(e,t){const s={eventName:e,...t},n=new URL(`${this.endpoint}/events`);try{const i=await fetch(n,{method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify(s)});if(!i.ok){const r=await i.text();throw new Error(`Request error: ${i.status} - ${r}`)}return await i.json()}catch(i){throw i}}}class p extends Error{constructor(e,t){let s;try{const n=JSON.parse(t);s=(n==null?void 0:n.message)||t}catch{s=t}super(s),this.statusCode=e,this.details=t,Object.setPrototypeOf(this,p.prototype)}}async function d(c,e){let t;try{t=await fetch(c,e)}catch(n){throw new p(0,n.message)}const s=await t.text();if(!t.ok)throw new p(t.status,s);return JSON.parse(s)}class u{constructor(e){this.endpoint=e.getEndpoint("aiImageService")}appendQueryParams(e,t){Object.entries(t).forEach(([s,n])=>{n!=null&&e.searchParams.append(s,String(n))})}getSimilarProducts(e){const t=new URL(`${this.endpoint}/recommendations/similar`);return this.appendQueryParams(t,e),d(t.toString(),{method:"GET",headers:{"Content-Type":"application/json"}})}getComplementaryProducts(e){const t=new URL(`${this.endpoint}/recommendations/complementary`);return this.appendQueryParams(t,e),d(t.toString(),{method:"GET",headers:{"Content-Type":"application/json"}})}searchSimilarByImage(e){const t=`${this.endpoint}/image-search/similar`;return d(t,{method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify(e)})}searchComplementaryByImage(e){const t=`${this.endpoint}/image-search/complementary`;return d(t,{method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify(e)})}searchSimilarByPermalink(e){const t=`${this.endpoint}/image-search/similar-by-permalink`;return d(t,{method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify(e)})}searchComplementaryByPermalink(e){const t=`${this.endpoint}/image-search/complementary-by-permalink`;return d(t,{method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify(e)})}}class T{constructor(e){this.sid=null,this.sessionId=null;const t=e.getEndpoint("session");this.sessionEndpoint=`${t}/`,this.profileEndpoint=`${t}/user/profile`}async getSessionInfo(){if(this.sid&&this.sessionId!==null)return{sid:this.sid,sessionId:this.sessionId};const e=await fetch(this.sessionEndpoint,{credentials:"include"});if(!e.ok){const s=await e.text();throw new Error(`Failed to fetch session info: ${e.status} – ${s}`)}const t=await e.json();return this.sid=t.catalogUser.id,this.sessionId=t.sessionId,{sid:this.sid,sessionId:this.sessionId}}async sendProfile(e,t){const s=t??(await this.getSessionInfo()).sid,n=new URL(this.profileEndpoint);n.searchParams.set("sid",s);const i=await fetch(n.toString(),{credentials:"include",method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify({userId:s,id:null,...e})});if(!i.ok){const r=await i.text();throw new Error(`Failed to send profile: ${i.status} – ${r}`)}}}const O=[S,u,T];function m(c={}){const e=new l(c),t=O.map(n=>new n(e)),s={};return t.forEach(n=>{[...Object.getOwnPropertyNames(n),...Object.getOwnPropertyNames(Object.getPrototypeOf(n))].forEach(r=>{if(r==="constructor")return;const h=n[r];typeof h=="function"&&(s[r]||(s[r]=(...y)=>h.apply(n,y)))})}),s}const f={TOP:"TOP",BOTTOM:"BOTTOM",SHOE_ACCESSORY:"SHOE_ACCESSORY",FULL_BODY:"FULL_BODY",UNDERWEAR_FULL_BODY:"UNDERWEAR_FULL_BODY",UNDERWEAR_BOTTOM:"UNDERWEAR_BOTTOM",UNDERWEAR_TOP:"UNDERWEAR_TOP",WETSUIT_FULL_BODY:"WETSUIT_FULL_BODY",WETSUIT_BOTTOM:"WETSUIT_BOTTOM",WETSUIT_TOP:"WETSUIT_TOP"},E={T_SHIRT:"t-shirt",SHIRT:"shirt",BLOUSE:"blouse",SWEATER:"sweater",HOODIE:"hoodie",JACKET:"jacket",COAT:"coat",CARDIGAN:"cardigan",BLAZER:"blazer",VEST:"vest",SWEATSHIRT:"sweatshirt",POLO_SHIRT:"polo shirt",TANK_TOP:"tank top",SKIRT:"skirt",TROUSERS:"trousers",JEANS:"jeans",SHORTS:"shorts",SNEAKERS:"sneakers",RUNNING_SHOES:"running shoes",BOOTS:"boots",ANKLE_BOOTS:"ankle boots",HIGH_HEELS:"high heels",FLATS:"flats",LOAFERS:"loafers",OXFORDS:"oxfords",SLIPPERS:"slippers",SANDALS:"sandals",DRESS:"dress",JUMPSUIT:"jumpsuit",SUIT:"suit",PANTIES:"panties",BRA:"bra",BIKINI:"bikini",BRIEFS:"briefs",BOXERS:"boxers",THONG:"thong",SWIMSUIT:"swimsuit",ONE_PIECE_SWIMSUIT:"one-piece swimsuit",WETSUIT:"wetsuit"};o.ClothType=f,o.ProductClass=E,o.createClient=m,Object.defineProperty(o,Symbol.toStringTag,{value:"Module"})}));
+(function(o,a){typeof exports=="object"&&typeof module<"u"?a(exports):typeof define=="function"&&define.amd?define(["exports"],a):(o=typeof globalThis<"u"?globalThis:o||self,a(o["sizebay-core-sdk"]={}))})(this,(function(o){"use strict";const a={tracker:{production:"https://data-event-service.internalsizebay.com",development:"https://data-event-service-dev.internalsizebay.com"},aiImageService:{production:"https://ai-image-service.internalsizebay.com",development:"https://ai-image-service-dev.internalsizebay.com"},session:{production:"https://vfr-v3-production.sizebay.technology/api/me",development:"https://vfr-v3-staging.sizebay.eu/api/me"}};class l{constructor(e){const t=e.env||"development";this.serviceOverrides=e.services||{},this.endpoints={};for(const s in a)if(Object.prototype.hasOwnProperty.call(a,s)){const i=a[s][t];if(!i)continue;this.endpoints[s]=i}}getEndpoint(e){const t=this.endpoints[e];if(!t)throw new Error(`Endpoint for service '${e}' is not configured.`);return t}getServiceConfig(e){return this.serviceOverrides[e]||{}}}class u{constructor(e){this.endpoint=e.getEndpoint("tracker")}async track(e,t){const s={eventName:e,...t},n=new URL(`${this.endpoint}/events`);try{const i=await fetch(n,{method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify(s)});if(!i.ok){const r=await i.text();throw new Error(`Request error: ${i.status} - ${r}`)}try{return await i.json()}catch{return{statusCode:201,message:"Event successfully created."}}}catch(i){throw i}}}class p extends Error{constructor(e,t){let s;try{const n=JSON.parse(t);s=(n==null?void 0:n.message)||t}catch{s=t}super(s),this.statusCode=e,this.details=t,Object.setPrototypeOf(this,p.prototype)}}async function d(c,e){let t;try{t=await fetch(c,e)}catch(n){throw new p(0,n.message)}const s=await t.text();if(!t.ok)throw new p(t.status,s);return JSON.parse(s)}class S{constructor(e){this.endpoint=e.getEndpoint("aiImageService")}appendQueryParams(e,t){Object.entries(t).forEach(([s,n])=>{n!=null&&e.searchParams.append(s,String(n))})}getSimilarProducts(e){const t=new URL(`${this.endpoint}/recommendations/similar`);return this.appendQueryParams(t,e),d(t.toString(),{method:"GET",headers:{"Content-Type":"application/json"}})}getComplementaryProducts(e){const t=new URL(`${this.endpoint}/recommendations/complementary`);return this.appendQueryParams(t,e),d(t.toString(),{method:"GET",headers:{"Content-Type":"application/json"}})}searchSimilarByImage(e){const t=`${this.endpoint}/image-search/similar`;return d(t,{method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify(e)})}searchComplementaryByImage(e){const t=`${this.endpoint}/image-search/complementary`;return d(t,{method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify(e)})}searchSimilarByPermalink(e){const t=`${this.endpoint}/image-search/similar-by-permalink`;return d(t,{method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify(e)})}searchComplementaryByPermalink(e){const t=`${this.endpoint}/image-search/complementary-by-permalink`;return d(t,{method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify(e)})}}class T{constructor(e){this.sid=null,this.sessionId=null;const t=e.getEndpoint("session");this.sessionEndpoint=`${t}/`,this.profileEndpoint=`${t}/user/profile`}async getSessionInfo(){if(this.sid&&this.sessionId!==null)return{sid:this.sid,sessionId:this.sessionId};const e=await fetch(this.sessionEndpoint,{credentials:"include"});if(!e.ok){const s=await e.text();throw new Error(`Failed to fetch session info: ${e.status} – ${s}`)}const t=await e.json();return this.sid=t.catalogUser.id,this.sessionId=t.sessionId,{sid:this.sid,sessionId:this.sessionId}}async sendProfile(e,t){const s=t??(await this.getSessionInfo()).sid,n=new URL(this.profileEndpoint);n.searchParams.set("sid",s);const i=await fetch(n.toString(),{credentials:"include",method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify({userId:s,id:null,...e})});if(!i.ok){const r=await i.text();throw new Error(`Failed to send profile: ${i.status} – ${r}`)}}}const O=[u,S,T];function m(c={}){const e=new l(c),t=O.map(n=>new n(e)),s={};return t.forEach(n=>{[...Object.getOwnPropertyNames(n),...Object.getOwnPropertyNames(Object.getPrototypeOf(n))].forEach(r=>{if(r==="constructor")return;const h=n[r];typeof h=="function"&&(s[r]||(s[r]=(...y)=>h.apply(n,y)))})}),s}const f={TOP:"TOP",BOTTOM:"BOTTOM",SHOE_ACCESSORY:"SHOE_ACCESSORY",FULL_BODY:"FULL_BODY",UNDERWEAR_FULL_BODY:"UNDERWEAR_FULL_BODY",UNDERWEAR_BOTTOM:"UNDERWEAR_BOTTOM",UNDERWEAR_TOP:"UNDERWEAR_TOP",WETSUIT_FULL_BODY:"WETSUIT_FULL_BODY",WETSUIT_BOTTOM:"WETSUIT_BOTTOM",WETSUIT_TOP:"WETSUIT_TOP"},E={T_SHIRT:"t-shirt",SHIRT:"shirt",BLOUSE:"blouse",SWEATER:"sweater",HOODIE:"hoodie",JACKET:"jacket",COAT:"coat",CARDIGAN:"cardigan",BLAZER:"blazer",VEST:"vest",SWEATSHIRT:"sweatshirt",POLO_SHIRT:"polo shirt",TANK_TOP:"tank top",SKIRT:"skirt",TROUSERS:"trousers",JEANS:"jeans",SHORTS:"shorts",SNEAKERS:"sneakers",RUNNING_SHOES:"running shoes",BOOTS:"boots",ANKLE_BOOTS:"ankle boots",HIGH_HEELS:"high heels",FLATS:"flats",LOAFERS:"loafers",OXFORDS:"oxfords",SLIPPERS:"slippers",SANDALS:"sandals",DRESS:"dress",JUMPSUIT:"jumpsuit",SUIT:"suit",PANTIES:"panties",BRA:"bra",BIKINI:"bikini",BRIEFS:"briefs",BOXERS:"boxers",THONG:"thong",SWIMSUIT:"swimsuit",ONE_PIECE_SWIMSUIT:"one-piece swimsuit",WETSUIT:"wetsuit"};o.ClothType=f,o.ProductClass=E,o.createClient=m,Object.defineProperty(o,Symbol.toStringTag,{value:"Module"})}));

package/dist/types/event/responses/track-response.dto.d.ts

@@ -1,4 +1,4 @@
-import { TrackSuccessResponse } from './track-success-response.dto';
 import { TrackBadRequestResponse } from './track-bad-request-response.dto';
 import { TrackServerErrorResponse } from './track-server-error-response.dto';
+import { TrackSuccessResponse } from './track-success-response.dto';
 export type TrackResponse = TrackSuccessResponse | TrackBadRequestResponse | TrackServerErrorResponse;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sizebay-core-sdk",
-  "version": "1.11.0-dev.1",
+  "version": "1.11.0-dev.3",
   "description": "A SDK designed for integrating multiple services (such as event tracking, AI services, etc.) into your application.",
   "main": "dist/sizebay-core-sdk.umd.js",
   "module": "dist/sizebay-core-sdk.es.js",