@fyul/embed-sdk 1.2.2 → 2.0.1

package/README.md

@@ -1,198 +1,7 @@
-# @fyulorg/embed-sdk
-
-A TypeScript SDK for integrating with Printful services via iframe-based cross-origin communication. The SDK provides a modular architecture for catalog browsing, mockup generation, and other Printful services through secure iframe messaging.
-
-## Features
-
-- 🎯 **Modular Architecture**: Separate modules for different services (Catalog, Mockup Generation, SDK core)
-- 🔒 **Secure Communication**: iframe-based cross-origin messaging with correlation ID tracking
-- 📦 **Dual Package Support**: Both ESM and CommonJS builds included
-- 🧪 **Fully Tested**: Comprehensive Jest test suite with 130+ tests and ~90% coverage
-- 🎨 **TypeScript First**: Complete type safety with extensive type definitions
-- 🔧 **Development Ready**: ESLint, Prettier, and modern tooling configured
+# @fyul/embed-sdk
 
 ## Installation
 
 ```bash
-npm install @fyulorg/embed-sdk
-```
-
-## Quick Start
-
-```typescript
-import { Embed } from '@fyulorg/embed-sdk';
-
-// Create SDK instance with your authentication nonce
-const embedSdk = new Embed('your-nonce-here', {
-  targetOrigin: 'https://your-domain.com',
-  modules: [
-    { name: 'catalog', data: { apiKey: 'your-api-key' } },
-    { name: 'mockupGeneration', data: { timeout: 30000 } }
-  ]
-});
-
-// Initialize connection
-await embedSdk.init();
-
-// Use catalog service
-const products = await embedSdk.catalog.getProducts(123);
-console.log('Products:', products);
-
-// Use mockup service
-const imageFile = new File(['...'], 'design.png', { type: 'image/png' });
-const mockups = await embedSdk.mockup.getMockups(imageFile, [1, 2, 3]);
-console.log('Generated mockups:', mockups);
-
-// Clean up when done
-embedSdk.destroy();
-```
-
-## API Reference
-
-### `new Embed(nonce, config?)`
-
-Creates a new SDK instance.
-
-**Parameters:**
-- `nonce` (string): Authentication token from your backend
-- `config` (optional): Configuration object
-  - `targetOrigin` (string): Target origin for iframe messages
-  - `modules` (array): Module configurations to initialize
-
-### Core Methods
-
-#### `embed.init(): Promise<void>`
-Initializes the SDK, creates iframe, and establishes communication channel.
-
-#### `embed.destroy(): void`
-Cleans up resources, removes iframe, and clears all pending messages.
-
-### Services
-
-#### Catalog Service (`embed.catalog`)
-```typescript
-// Get products by category
-const products = await embed.catalog.getProducts(categoryId);
-
-// Get all categories
-const categories = await embed.catalog.getCategories();
-```
-
-#### Mockup Service (`embed.mockup`)
-```typescript
-// Generate mockups from design file
-const mockups = await embed.mockup.getMockups(
-  designFile,      // Blob | File
-  productIds       // number[] (optional)
-);
-```
-
-## Module System
-
-The SDK uses a modular architecture where different services are loaded as separate modules:
-
-- **SDK Module**: Core functionality and initialization
-- **Catalog Module**: Product and category browsing
-- **Mockup Generation Module**: Design-to-mockup conversion
-
-Each module can be configured independently and loaded on-demand.
-
-## Event System
-
-The SDK implements a comprehensive event system for iframe communication:
-
-- **Action Events**: Commands sent to the iframe (e.g., initialize, load module)
-- **Result Events**: Successful responses from iframe operations
-- **Notification Events**: Status updates and error notifications
-
-All events include correlation IDs for request/response tracking.
-
-## TypeScript Support
-
-Full TypeScript support with extensive type definitions:
-
-```typescript
-import { 
-  Embed, 
-  CatalogModule, 
-  MockupGenerationModule,
-  NotificationEvent,
-  ResultEvent,
-  handleResponse
-} from '@fyulorg/embed-sdk';
-
-// All types are fully typed
-const embed = new Embed('nonce');
-const result: CatalogModule.GetProductsResult = await embed.catalog.getProducts(1);
-```
-
-## Development
-
-### Setup
-
-```bash
-# Install dependencies
-npm install
-
-# Run tests
-npm test
-npm run test:watch
-npm run test:coverage
-
-# Build
-npm run build
-
-# Lint and format
-npm run lint
-npm run prettier
-npm run lint:fix
-npm run prettier:fix
+npm install @fyul/embed-sdk
 ```
-
-### Project Structure
-
-```
-src/
-├── index.ts              # Main SDK export
-├── services/             # Core services
-│   ├── embedCommunicator.ts
-│   ├── iFrameManager.ts
-│   ├── messagebroker.ts
-│   └── moduleLoaderService.ts
-├── modules/              # Feature modules
-│   ├── catalog/
-│   ├── mockup-generation/
-│   └── sdk/
-├── types/                # Shared type definitions
-│   ├── event/
-│   └── module/
-└── helpers/              # Utility functions
-
-tests/                    # Test files (mirrors src structure)
-├── services/
-├── modules/
-└── helpers/
-```
-
-### Import Aliases
-
-The project uses `~` aliases for clean imports:
-
-```typescript
-import { EmbedCommunicator } from '~/services/embedCommunicator';
-import { CatalogModule } from '~/modules/catalog/catalogModule';
-import { Event } from '~/types/event/event.types';
-```
-
-## Building
-
-The project builds to both ESM and CommonJS formats:
-
-- **ESM**: `dist/esm/` - Modern ES modules
-- **CJS**: `dist/cjs/` - Compatible CommonJS modules
-
-The build process uses TypeScript compilation followed by `tsc-alias` for path resolution.
-
-## License
-
-ISC

package/dist/cjs/modules/catalog/catalogModule.d.ts

@@ -1,9 +1,10 @@
 import { ICatalogModule } from '../../types/module/module.types';
 import { BaseModule } from '../../modules/baseModule';
-import { GetCatalogCategoriesResultPayload, GetCatalogProductsResultPayload, GetSingleCatalogProductResultPayload } from './types';
+import { GetCatalogCategoriesResultPayload, GetCatalogProductsByIdsPayload, GetCatalogProductsPayload, GetCatalogProductsResultPayload, GetSingleCatalogProductPayload, GetSingleCatalogProductResultPayload } from './types';
 import { WithHandledResponses } from '../../helpers/typeHelper.types';
 export declare class CatalogModule extends BaseModule implements WithHandledResponses<ICatalogModule> {
-    getProducts(categoryId: number, page?: number): Promise<import("../..").HandledResponse<GetCatalogProductsResultPayload, Error>>;
-    getProduct(productId: number): Promise<import("../..").HandledResponse<GetSingleCatalogProductResultPayload, Error>>;
+    getProducts(data: GetCatalogProductsPayload): Promise<import("../..").HandledResponse<GetCatalogProductsResultPayload, Error>>;
+    getProductsByIds(data: GetCatalogProductsByIdsPayload): Promise<import("../..").HandledResponse<GetCatalogProductsResultPayload, Error>>;
+    getProduct(data: GetSingleCatalogProductPayload): Promise<import("../..").HandledResponse<GetSingleCatalogProductResultPayload, Error>>;
     getCategories(): Promise<import("../..").HandledResponse<GetCatalogCategoriesResultPayload, Error>>;
 }

package/dist/cjs/modules/catalog/catalogModule.js

@@ -5,17 +5,16 @@ const baseModule_1 = require("../../modules/baseModule");
 const types_1 = require("./types");
 const responseHandler_1 = require("../../helpers/responseHandler");
 class CatalogModule extends baseModule_1.BaseModule {
-    async getProducts(categoryId, page = 1) {
-        const response = await this.sendRequest(types_1.EVENTS_ACTION.GET_CATALOG_PRODUCTS, {
-            categoryId,
-            page,
-        }).catch((e) => e);
+    async getProducts(data) {
+        const response = await this.sendRequest(types_1.EVENTS_ACTION.GET_CATALOG_PRODUCTS, data).catch((e) => e);
         return (0, responseHandler_1.handleResponse)(response, 'Failed to get catalog products');
     }
-    async getProduct(productId) {
-        const response = await this.sendRequest(types_1.EVENTS_ACTION.GET_SINGLE_CATALOG_PRODUCT, {
-            productId,
-        }).catch((e) => e);
+    async getProductsByIds(data) {
+        const response = await this.sendRequest(types_1.EVENTS_ACTION.GET_CATALOG_PRODUCTS_BY_IDS, data).catch((e) => e);
+        return (0, responseHandler_1.handleResponse)(response, 'Failed to get catalog products');
+    }
+    async getProduct(data) {
+        const response = await this.sendRequest(types_1.EVENTS_ACTION.GET_SINGLE_CATALOG_PRODUCT, data).catch((e) => e);
         return (0, responseHandler_1.handleResponse)(response, 'Failed to get catalog products');
     }
     async getCategories() {

package/dist/cjs/modules/catalog/catalogService.d.ts

@@ -1,7 +1,9 @@
 import { BaseModuleService } from '../../modules/baseModuleService';
+import { GetCatalogProductsByIdsPayload, GetCatalogProductsPayload, GetSingleCatalogProductPayload } from '../../modules/catalog/types';
 export declare class CatalogService extends BaseModuleService {
     private getCatalogModule;
-    getCategories(): Promise<import("../..").HandledResponse<import("./types").GetCatalogCategoriesResultPayload, Error>>;
-    getProducts(categoryId: number, page?: number): Promise<import("../..").HandledResponse<import("./types").GetCatalogProductsResultPayload, Error>>;
-    getProduct(productId: number): Promise<import("../..").HandledResponse<import("./types").GetSingleCatalogProductResultPayload, Error>>;
+    getCategories(): Promise<import("../..").HandledResponse<import("../../modules/catalog/types").GetCatalogCategoriesResultPayload, Error>>;
+    getProducts(data: GetCatalogProductsPayload): Promise<import("../..").HandledResponse<import("../../modules/catalog/types").GetCatalogProductsResultPayload, Error>>;
+    getProductsByIds(data: GetCatalogProductsByIdsPayload): Promise<import("../..").HandledResponse<import("../../modules/catalog/types").GetCatalogProductsResultPayload, Error> | null>;
+    getProduct(data: GetSingleCatalogProductPayload): Promise<import("../..").HandledResponse<import("../../modules/catalog/types").GetSingleCatalogProductResultPayload, Error>>;
 }

package/dist/cjs/modules/catalog/catalogService.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.CatalogService = void 0;
 const baseModuleService_1 = require("../../modules/baseModuleService");
 const modules_1 = require("../../modules/modules");
+const messageLogger_1 = require("../../helpers/messageLogger");
 class CatalogService extends baseModuleService_1.BaseModuleService {
     async getCatalogModule() {
         return this.ensureModuleLoaded(modules_1.MODULE_NAMES.CATALOG);
@@ -11,13 +12,24 @@ class CatalogService extends baseModuleService_1.BaseModuleService {
         const module = await this.getCatalogModule();
         return module.getCategories();
     }
-    async getProducts(categoryId, page = 1) {
+    async getProducts(data) {
         const module = await this.getCatalogModule();
-        return module.getProducts(categoryId, page);
+        return module.getProducts(data);
     }
-    async getProduct(productId) {
+    async getProductsByIds(data) {
+        if (!data.productIds.length) {
+            (0, messageLogger_1.logEmbedMessage)({
+                logType: messageLogger_1.LOG_TYPES.ERROR,
+                message: 'Empty productIds argument!',
+            });
+            return null;
+        }
         const module = await this.getCatalogModule();
-        return module.getProduct(productId);
+        return module.getProductsByIds(data);
+    }
+    async getProduct(data) {
+        const module = await this.getCatalogModule();
+        return module.getProduct(data);
     }
 }
 exports.CatalogService = CatalogService;

package/dist/cjs/modules/catalog/events.d.ts

@@ -1,5 +1,6 @@
 export declare const EVENTS_ACTION: {
     readonly GET_CATALOG_PRODUCTS: "actionGetCatalogProducts";
+    readonly GET_CATALOG_PRODUCTS_BY_IDS: "actionGetCatalogProductsByIds";
     readonly GET_SINGLE_CATALOG_PRODUCT: "actionGetSingleCatalogProduct";
     readonly GET_CATALOG_CATEGORIES: "actionGetCatalogCategories";
 };
@@ -21,6 +22,7 @@ export declare const EVENTS: {
     readonly GET_SINGLE_CATALOG_PRODUCT_FAILURE: "actionGetSingleCatalogProductFailure";
     readonly GET_CATALOG_CATEGORIES_FAILURE: "actionGetCatalogCategoriesFailure";
     readonly GET_CATALOG_PRODUCTS: "actionGetCatalogProducts";
+    readonly GET_CATALOG_PRODUCTS_BY_IDS: "actionGetCatalogProductsByIds";
     readonly GET_SINGLE_CATALOG_PRODUCT: "actionGetSingleCatalogProduct";
     readonly GET_CATALOG_CATEGORIES: "actionGetCatalogCategories";
 };

package/dist/cjs/modules/catalog/events.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.EVENTS = exports.EVENTS_RESULT = exports.EVENTS_NOTIFICATION = exports.EVENTS_ACTION = void 0;
 exports.EVENTS_ACTION = {
     GET_CATALOG_PRODUCTS: 'actionGetCatalogProducts',
+    GET_CATALOG_PRODUCTS_BY_IDS: 'actionGetCatalogProductsByIds',
     GET_SINGLE_CATALOG_PRODUCT: 'actionGetSingleCatalogProduct',
     GET_CATALOG_CATEGORIES: 'actionGetCatalogCategories',
 };

package/dist/cjs/modules/catalog/types/data.types.d.ts

@@ -3,6 +3,7 @@ export interface CatalogProduct {
     productId: number;
     title: string;
     price?: number;
+    priceWithTax?: number;
     currency?: string;
     urlImage?: string;
     colorsSizes: {
@@ -82,6 +83,7 @@ export interface ProductVariant {
 }
 export interface VariantPriceData {
     price: number;
+    priceWithTax: number;
     currency: string;
     currencySymbol: string;
 }

package/dist/cjs/modules/catalog/types/event/actionEvent.types.d.ts

@@ -1,7 +1,8 @@
 import { EVENTS_ACTION } from '../../../../modules/catalog/events';
-import type { GetCatalogCategoriesPayload, GetCatalogProductsPayload, GetSingleCatalogProductPayload } from '../../../../modules/catalog/types';
+import type { GetCatalogCategoriesPayload, GetCatalogProductsByIdsPayload, GetCatalogProductsPayload, GetSingleCatalogProductPayload } from '../../../../modules/catalog/types';
 import { BaseActionEvent } from '../../../../types/event/action/actionEvent.types';
 export type GetCatalogProductsAction = BaseActionEvent<typeof EVENTS_ACTION.GET_CATALOG_PRODUCTS, GetCatalogProductsPayload>;
+export type GetCatalogProductsByIdsAction = BaseActionEvent<typeof EVENTS_ACTION.GET_CATALOG_PRODUCTS_BY_IDS, GetCatalogProductsByIdsPayload>;
 export type GetSingleCatalogProductAction = BaseActionEvent<typeof EVENTS_ACTION.GET_SINGLE_CATALOG_PRODUCT, GetSingleCatalogProductPayload>;
 export type GetCatalogCategoriesAction = BaseActionEvent<typeof EVENTS_ACTION.GET_CATALOG_CATEGORIES, GetCatalogCategoriesPayload>;
-export type ActionEvent = GetCatalogCategoriesAction | GetCatalogProductsAction | GetSingleCatalogProductAction;
+export type ActionEvent = GetCatalogCategoriesAction | GetCatalogProductsByIdsAction | GetCatalogProductsAction | GetSingleCatalogProductAction;

package/dist/cjs/modules/catalog/types/event/actionEventPayload.types.d.ts

@@ -1,6 +1,10 @@
 export interface GetCatalogProductsPayload {
     categoryId: number;
-    page: number;
+    page?: number;
+}
+export interface GetCatalogProductsByIdsPayload {
+    productIds: number[];
+    page?: number;
 }
 export interface GetSingleCatalogProductPayload {
     productId: number;
@@ -8,4 +12,4 @@ export interface GetSingleCatalogProductPayload {
 export interface GetCatalogCategoriesPayload {
     level: number;
 }
-export type ActionEventPayload = GetCatalogCategoriesPayload | GetCatalogProductsPayload | GetSingleCatalogProductPayload;
+export type ActionEventPayload = GetCatalogProductsByIdsPayload | GetCatalogCategoriesPayload | GetCatalogProductsPayload | GetSingleCatalogProductPayload;

package/dist/cjs/modules/eventTypes.d.ts

@@ -4,6 +4,6 @@ export declare const EVENT_TYPES: {
     readonly NOTIFICATION: "notification";
     readonly RESULT: "result";
 };
-export declare function isAction(event: AnyEvent): event is import("./sdk/types").InitializeSdkAction | import("./sdk/types").LoadModuleAction | import("./mockup-generation/types").GetMockupsAction | import("./product-publish/types").GetProductPublishAction | import("./catalog/types").GetCatalogCategoriesAction | import("./catalog/types").GetCatalogProductsAction | import("./catalog/types").GetSingleCatalogProductAction;
+export declare function isAction(event: AnyEvent): event is import("./sdk/types").InitializeSdkAction | import("./sdk/types").LoadModuleAction | import("./mockup-generation/types").GetMockupsAction | import("./product-publish/types").GetProductPublishAction | import("./catalog/types").GetCatalogCategoriesAction | import("./catalog/types").GetCatalogProductsByIdsAction | import("./catalog/types").GetCatalogProductsAction | import("./catalog/types").GetSingleCatalogProductAction;
 export declare function isNotification(event: AnyEvent): event is import("..").NotificationEvent;
 export declare function isResult(event: AnyEvent): event is import("./catalog/types").GetCatalogProductsResult | import("./catalog/types").GetSingleCatalogProductResult | import("./catalog/types").GetCatalogCategoriesResult | import("./product-publish/types").GetProductPublishResult | import("./mockup-generation/types").GetMockupsResultEvent;

package/dist/cjs/modules/events.d.ts

@@ -2,6 +2,7 @@ export declare const ALL_ACTION_EVENTS: {
     readonly PRODUCT_PUBLISH: "actionProductPublish";
     readonly GET_MOCKUPS: "actionGetMockups";
     readonly GET_CATALOG_PRODUCTS: "actionGetCatalogProducts";
+    readonly GET_CATALOG_PRODUCTS_BY_IDS: "actionGetCatalogProductsByIds";
     readonly GET_SINGLE_CATALOG_PRODUCT: "actionGetSingleCatalogProduct";
     readonly GET_CATALOG_CATEGORIES: "actionGetCatalogCategories";
     readonly INITIALIZE_SDK: "actionInitializeSdk";
@@ -37,6 +38,7 @@ export declare const ALL_EVENTS: {
     readonly PRODUCT_PUBLISH: "actionProductPublish";
     readonly GET_MOCKUPS: "actionGetMockups";
     readonly GET_CATALOG_PRODUCTS: "actionGetCatalogProducts";
+    readonly GET_CATALOG_PRODUCTS_BY_IDS: "actionGetCatalogProductsByIds";
     readonly GET_SINGLE_CATALOG_PRODUCT: "actionGetSingleCatalogProduct";
     readonly GET_CATALOG_CATEGORIES: "actionGetCatalogCategories";
     readonly INITIALIZE_SDK: "actionInitializeSdk";

package/dist/cjs/modules/mockup-generation/types/data.types.d.ts

@@ -1,29 +1,8 @@
-export interface ProductMockupEntry {
-    productId: number;
-    isSizeBased: boolean;
-    productMockups: unknown[];
-    mockupPlacements: unknown[];
-    placementTemplates: unknown[];
-}
 export interface MockupGenerationData {
-    imgUrl: string | null;
-    id: number;
-    styleName: string;
-    styleNameTranslation: string;
     color: string | null | undefined;
     size: string | null;
-    placement: string;
-    mockupVariantId: number;
-    isBlankMockup: boolean;
     baseImageUrl: string | null;
     bgColor: string;
-    isTransparent: boolean;
-    canMockupHaveDynamicBackground: boolean;
-    isLoading: boolean;
-    failed: boolean;
-    error: string | Error | null;
-    isCleared: boolean;
-    processId: string;
     blob: Blob | null;
 }
 export interface MockupDataWithProductData extends MockupGenerationData {

package/dist/cjs/modules/mockup-generation/types/event/actionEventPayload.types.d.ts

@@ -1,11 +1,16 @@
-export interface InitializeMockupDataPayload {
-    productIds: number[];
-}
 export interface GetMockupsPayload {
-    file: Blob | null;
-    mockupData: {
+    /** File from which to generate mockups */
+    file: Blob;
+    /** List of all products and their variants to fetch mockups for */
+    products: {
         productId: number;
-        variantIds: number[];
+        variantIds?: number[];
     }[];
+    /** Optional mapping of productId → selected variantId.
+     *  If not provided, the first variant from each product will be used. */
+    selectedVariants?: Record<string, number>;
+    /** If set to true, request will finish faster, and allow you
+     * to show preview image on which mockup will be generated on */
+    shouldReturnBlankMockups?: true;
 }
-export type ActionEventPayload = GetMockupsPayload | InitializeMockupDataPayload;
+export type ActionEventPayload = GetMockupsPayload;

package/dist/cjs/modules/product-publish/types/event/actionEventPayload.types.d.ts

@@ -1,7 +1,9 @@
 export interface GetProductPublishPayload {
-    blob: Blob | null;
-    publishData: {
+    file: Blob;
+    /** List of all products and their variants to generate templates for */
+    products: {
         productId: number;
+        /** Should not be empty, otherwise will fail to publish */
         variantIds: number[];
     }[];
 }

package/dist/cjs/types/event/action/actionEvent.types.d.ts

@@ -1,4 +1,4 @@
-import { ActionEvent as SdkActionEvent, LoadModuleAction } from '../../../modules/sdk/types/event/actionEvent.types';
+import { ActionEvent as SdkActionEvent } from '../../../modules/sdk/types/event/actionEvent.types';
 import { ActionEvent as CatalogActionEvent } from '../../../modules/catalog/types/event/actionEvent.types';
 import { ActionEvent as MockupGenerationActionEvent } from '../../../modules/mockup-generation/types/event/actionEvent.types';
 import { ActionEvent as ProductPublishActionEvent } from '../../../modules/product-publish/types/event/actionEvent.types';
@@ -8,4 +8,4 @@ import { EVENT_TYPES } from '../../../modules/eventTypes';
 import { ActionEventPayload } from './actionEventPayload.types';
 export type ActionEventName = (typeof ALL_ACTION_EVENTS)[keyof typeof ALL_ACTION_EVENTS];
 export type BaseActionEvent<TName extends ActionEventName, TPayload extends ActionEventPayload> = Event<TName, typeof EVENT_TYPES.ACTION, TPayload>;
-export type ActionEvent = LoadModuleAction | MockupGenerationActionEvent | CatalogActionEvent | ProductPublishActionEvent | SdkActionEvent;
+export type ActionEvent = MockupGenerationActionEvent | CatalogActionEvent | ProductPublishActionEvent | SdkActionEvent;

package/dist/cjs/types/module/module.types.d.ts

@@ -1,7 +1,7 @@
 import type { MODULE_NAMES } from '../../modules/modules';
 import { GetMockupsPayload, GetMockupsResultPayload } from '../../modules/mockup-generation/types';
 import { SdkModuleConfigData } from '../../modules/sdk/types';
-import { GetCatalogCategoriesResultPayload, GetCatalogProductsResultPayload, GetSingleCatalogProductResultPayload } from '../../modules/catalog/types';
+import { GetCatalogCategoriesResultPayload, GetCatalogProductsByIdsPayload, GetCatalogProductsPayload, GetCatalogProductsResultPayload, GetSingleCatalogProductPayload, GetSingleCatalogProductResultPayload } from '../../modules/catalog/types';
 import { NotificationEventPayload } from '../../types/event/notification/notificationEventPayload.types';
 import { GetProductPublishPayload, ProductPublishData } from '../../modules/product-publish/types';
 /** This file ensures that Iframe and SDK has the same source of truth for return values */
@@ -10,8 +10,9 @@ export interface ISdkModule {
     setup(config?: SdkModuleConfigData): Promise<NotificationEventPayload> | Promise<void>;
 }
 export interface ICatalogModule {
-    getProducts(categoryId: number): GetCatalogProductsResultPayload;
-    getProduct(productId: number): GetSingleCatalogProductResultPayload;
+    getProducts(data: GetCatalogProductsPayload): GetCatalogProductsResultPayload;
+    getProductsByIds(data: GetCatalogProductsByIdsPayload): GetCatalogProductsResultPayload;
+    getProduct(data: GetSingleCatalogProductPayload): GetSingleCatalogProductResultPayload;
     getCategories(): GetCatalogCategoriesResultPayload;
 }
 export interface IMockupGenerationModule {

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const VERSION: "1.2.2";
+export declare const VERSION: "2.0.1";

package/dist/cjs/version.js

@@ -2,4 +2,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
 // AUTO-GENERATED
-exports.VERSION = '1.2.2';
+exports.VERSION = '2.0.1';

package/dist/esm/modules/catalog/catalogModule.d.ts

@@ -1,9 +1,10 @@
 import { ICatalogModule } from '../../types/module/module.types';
 import { BaseModule } from '../../modules/baseModule';
-import { GetCatalogCategoriesResultPayload, GetCatalogProductsResultPayload, GetSingleCatalogProductResultPayload } from './types';
+import { GetCatalogCategoriesResultPayload, GetCatalogProductsByIdsPayload, GetCatalogProductsPayload, GetCatalogProductsResultPayload, GetSingleCatalogProductPayload, GetSingleCatalogProductResultPayload } from './types';
 import { WithHandledResponses } from '../../helpers/typeHelper.types';
 export declare class CatalogModule extends BaseModule implements WithHandledResponses<ICatalogModule> {
-    getProducts(categoryId: number, page?: number): Promise<import("../..").HandledResponse<GetCatalogProductsResultPayload, Error>>;
-    getProduct(productId: number): Promise<import("../..").HandledResponse<GetSingleCatalogProductResultPayload, Error>>;
+    getProducts(data: GetCatalogProductsPayload): Promise<import("../..").HandledResponse<GetCatalogProductsResultPayload, Error>>;
+    getProductsByIds(data: GetCatalogProductsByIdsPayload): Promise<import("../..").HandledResponse<GetCatalogProductsResultPayload, Error>>;
+    getProduct(data: GetSingleCatalogProductPayload): Promise<import("../..").HandledResponse<GetSingleCatalogProductResultPayload, Error>>;
     getCategories(): Promise<import("../..").HandledResponse<GetCatalogCategoriesResultPayload, Error>>;
 }

package/dist/esm/modules/catalog/catalogModule.js

@@ -2,17 +2,16 @@ import { BaseModule } from '../../modules/baseModule';
 import { EVENTS_ACTION, } from './types';
 import { handleResponse } from '../../helpers/responseHandler';
 export class CatalogModule extends BaseModule {
-    async getProducts(categoryId, page = 1) {
-        const response = await this.sendRequest(EVENTS_ACTION.GET_CATALOG_PRODUCTS, {
-            categoryId,
-            page,
-        }).catch((e) => e);
+    async getProducts(data) {
+        const response = await this.sendRequest(EVENTS_ACTION.GET_CATALOG_PRODUCTS, data).catch((e) => e);
         return handleResponse(response, 'Failed to get catalog products');
     }
-    async getProduct(productId) {
-        const response = await this.sendRequest(EVENTS_ACTION.GET_SINGLE_CATALOG_PRODUCT, {
-            productId,
-        }).catch((e) => e);
+    async getProductsByIds(data) {
+        const response = await this.sendRequest(EVENTS_ACTION.GET_CATALOG_PRODUCTS_BY_IDS, data).catch((e) => e);
+        return handleResponse(response, 'Failed to get catalog products');
+    }
+    async getProduct(data) {
+        const response = await this.sendRequest(EVENTS_ACTION.GET_SINGLE_CATALOG_PRODUCT, data).catch((e) => e);
         return handleResponse(response, 'Failed to get catalog products');
     }
     async getCategories() {

package/dist/esm/modules/catalog/catalogService.d.ts

@@ -1,7 +1,9 @@
 import { BaseModuleService } from '../../modules/baseModuleService';
+import { GetCatalogProductsByIdsPayload, GetCatalogProductsPayload, GetSingleCatalogProductPayload } from '../../modules/catalog/types';
 export declare class CatalogService extends BaseModuleService {
     private getCatalogModule;
-    getCategories(): Promise<import("../..").HandledResponse<import("./types").GetCatalogCategoriesResultPayload, Error>>;
-    getProducts(categoryId: number, page?: number): Promise<import("../..").HandledResponse<import("./types").GetCatalogProductsResultPayload, Error>>;
-    getProduct(productId: number): Promise<import("../..").HandledResponse<import("./types").GetSingleCatalogProductResultPayload, Error>>;
+    getCategories(): Promise<import("../..").HandledResponse<import("../../modules/catalog/types").GetCatalogCategoriesResultPayload, Error>>;
+    getProducts(data: GetCatalogProductsPayload): Promise<import("../..").HandledResponse<import("../../modules/catalog/types").GetCatalogProductsResultPayload, Error>>;
+    getProductsByIds(data: GetCatalogProductsByIdsPayload): Promise<import("../..").HandledResponse<import("../../modules/catalog/types").GetCatalogProductsResultPayload, Error> | null>;
+    getProduct(data: GetSingleCatalogProductPayload): Promise<import("../..").HandledResponse<import("../../modules/catalog/types").GetSingleCatalogProductResultPayload, Error>>;
 }

package/dist/esm/modules/catalog/catalogService.js

@@ -1,5 +1,6 @@
 import { BaseModuleService } from '../../modules/baseModuleService';
 import { MODULE_NAMES } from '../../modules/modules';
+import { LOG_TYPES, logEmbedMessage } from '../../helpers/messageLogger';
 export class CatalogService extends BaseModuleService {
     async getCatalogModule() {
         return this.ensureModuleLoaded(MODULE_NAMES.CATALOG);
@@ -8,12 +9,23 @@ export class CatalogService extends BaseModuleService {
         const module = await this.getCatalogModule();
         return module.getCategories();
     }
-    async getProducts(categoryId, page = 1) {
+    async getProducts(data) {
         const module = await this.getCatalogModule();
-        return module.getProducts(categoryId, page);
+        return module.getProducts(data);
     }
-    async getProduct(productId) {
+    async getProductsByIds(data) {
+        if (!data.productIds.length) {
+            logEmbedMessage({
+                logType: LOG_TYPES.ERROR,
+                message: 'Empty productIds argument!',
+            });
+            return null;
+        }
         const module = await this.getCatalogModule();
-        return module.getProduct(productId);
+        return module.getProductsByIds(data);
+    }
+    async getProduct(data) {
+        const module = await this.getCatalogModule();
+        return module.getProduct(data);
     }
 }

package/dist/esm/modules/catalog/events.d.ts

@@ -1,5 +1,6 @@
 export declare const EVENTS_ACTION: {
     readonly GET_CATALOG_PRODUCTS: "actionGetCatalogProducts";
+    readonly GET_CATALOG_PRODUCTS_BY_IDS: "actionGetCatalogProductsByIds";
     readonly GET_SINGLE_CATALOG_PRODUCT: "actionGetSingleCatalogProduct";
     readonly GET_CATALOG_CATEGORIES: "actionGetCatalogCategories";
 };
@@ -21,6 +22,7 @@ export declare const EVENTS: {
     readonly GET_SINGLE_CATALOG_PRODUCT_FAILURE: "actionGetSingleCatalogProductFailure";
     readonly GET_CATALOG_CATEGORIES_FAILURE: "actionGetCatalogCategoriesFailure";
     readonly GET_CATALOG_PRODUCTS: "actionGetCatalogProducts";
+    readonly GET_CATALOG_PRODUCTS_BY_IDS: "actionGetCatalogProductsByIds";
     readonly GET_SINGLE_CATALOG_PRODUCT: "actionGetSingleCatalogProduct";
     readonly GET_CATALOG_CATEGORIES: "actionGetCatalogCategories";
 };

package/dist/esm/modules/catalog/events.js

@@ -1,5 +1,6 @@
 export const EVENTS_ACTION = {
     GET_CATALOG_PRODUCTS: 'actionGetCatalogProducts',
+    GET_CATALOG_PRODUCTS_BY_IDS: 'actionGetCatalogProductsByIds',
     GET_SINGLE_CATALOG_PRODUCT: 'actionGetSingleCatalogProduct',
     GET_CATALOG_CATEGORIES: 'actionGetCatalogCategories',
 };

package/dist/esm/modules/catalog/types/data.types.d.ts

@@ -3,6 +3,7 @@ export interface CatalogProduct {
     productId: number;
     title: string;
     price?: number;
+    priceWithTax?: number;
     currency?: string;
     urlImage?: string;
     colorsSizes: {
@@ -82,6 +83,7 @@ export interface ProductVariant {
 }
 export interface VariantPriceData {
     price: number;
+    priceWithTax: number;
     currency: string;
     currencySymbol: string;
 }

package/dist/esm/modules/catalog/types/event/actionEvent.types.d.ts

@@ -1,7 +1,8 @@
 import { EVENTS_ACTION } from '../../../../modules/catalog/events';
-import type { GetCatalogCategoriesPayload, GetCatalogProductsPayload, GetSingleCatalogProductPayload } from '../../../../modules/catalog/types';
+import type { GetCatalogCategoriesPayload, GetCatalogProductsByIdsPayload, GetCatalogProductsPayload, GetSingleCatalogProductPayload } from '../../../../modules/catalog/types';
 import { BaseActionEvent } from '../../../../types/event/action/actionEvent.types';
 export type GetCatalogProductsAction = BaseActionEvent<typeof EVENTS_ACTION.GET_CATALOG_PRODUCTS, GetCatalogProductsPayload>;
+export type GetCatalogProductsByIdsAction = BaseActionEvent<typeof EVENTS_ACTION.GET_CATALOG_PRODUCTS_BY_IDS, GetCatalogProductsByIdsPayload>;
 export type GetSingleCatalogProductAction = BaseActionEvent<typeof EVENTS_ACTION.GET_SINGLE_CATALOG_PRODUCT, GetSingleCatalogProductPayload>;
 export type GetCatalogCategoriesAction = BaseActionEvent<typeof EVENTS_ACTION.GET_CATALOG_CATEGORIES, GetCatalogCategoriesPayload>;
-export type ActionEvent = GetCatalogCategoriesAction | GetCatalogProductsAction | GetSingleCatalogProductAction;
+export type ActionEvent = GetCatalogCategoriesAction | GetCatalogProductsByIdsAction | GetCatalogProductsAction | GetSingleCatalogProductAction;

package/dist/esm/modules/catalog/types/event/actionEventPayload.types.d.ts

@@ -1,6 +1,10 @@
 export interface GetCatalogProductsPayload {
     categoryId: number;
-    page: number;
+    page?: number;
+}
+export interface GetCatalogProductsByIdsPayload {
+    productIds: number[];
+    page?: number;
 }
 export interface GetSingleCatalogProductPayload {
     productId: number;
@@ -8,4 +12,4 @@ export interface GetSingleCatalogProductPayload {
 export interface GetCatalogCategoriesPayload {
     level: number;
 }
-export type ActionEventPayload = GetCatalogCategoriesPayload | GetCatalogProductsPayload | GetSingleCatalogProductPayload;
+export type ActionEventPayload = GetCatalogProductsByIdsPayload | GetCatalogCategoriesPayload | GetCatalogProductsPayload | GetSingleCatalogProductPayload;

package/dist/esm/modules/eventTypes.d.ts

@@ -4,6 +4,6 @@ export declare const EVENT_TYPES: {
     readonly NOTIFICATION: "notification";
     readonly RESULT: "result";
 };
-export declare function isAction(event: AnyEvent): event is import("./sdk/types").InitializeSdkAction | import("./sdk/types").LoadModuleAction | import("./mockup-generation/types").GetMockupsAction | import("./product-publish/types").GetProductPublishAction | import("./catalog/types").GetCatalogCategoriesAction | import("./catalog/types").GetCatalogProductsAction | import("./catalog/types").GetSingleCatalogProductAction;
+export declare function isAction(event: AnyEvent): event is import("./sdk/types").InitializeSdkAction | import("./sdk/types").LoadModuleAction | import("./mockup-generation/types").GetMockupsAction | import("./product-publish/types").GetProductPublishAction | import("./catalog/types").GetCatalogCategoriesAction | import("./catalog/types").GetCatalogProductsByIdsAction | import("./catalog/types").GetCatalogProductsAction | import("./catalog/types").GetSingleCatalogProductAction;
 export declare function isNotification(event: AnyEvent): event is import("..").NotificationEvent;
 export declare function isResult(event: AnyEvent): event is import("./catalog/types").GetCatalogProductsResult | import("./catalog/types").GetSingleCatalogProductResult | import("./catalog/types").GetCatalogCategoriesResult | import("./product-publish/types").GetProductPublishResult | import("./mockup-generation/types").GetMockupsResultEvent;

package/dist/esm/modules/events.d.ts

@@ -2,6 +2,7 @@ export declare const ALL_ACTION_EVENTS: {
     readonly PRODUCT_PUBLISH: "actionProductPublish";
     readonly GET_MOCKUPS: "actionGetMockups";
     readonly GET_CATALOG_PRODUCTS: "actionGetCatalogProducts";
+    readonly GET_CATALOG_PRODUCTS_BY_IDS: "actionGetCatalogProductsByIds";
     readonly GET_SINGLE_CATALOG_PRODUCT: "actionGetSingleCatalogProduct";
     readonly GET_CATALOG_CATEGORIES: "actionGetCatalogCategories";
     readonly INITIALIZE_SDK: "actionInitializeSdk";
@@ -37,6 +38,7 @@ export declare const ALL_EVENTS: {
     readonly PRODUCT_PUBLISH: "actionProductPublish";
     readonly GET_MOCKUPS: "actionGetMockups";
     readonly GET_CATALOG_PRODUCTS: "actionGetCatalogProducts";
+    readonly GET_CATALOG_PRODUCTS_BY_IDS: "actionGetCatalogProductsByIds";
     readonly GET_SINGLE_CATALOG_PRODUCT: "actionGetSingleCatalogProduct";
     readonly GET_CATALOG_CATEGORIES: "actionGetCatalogCategories";
     readonly INITIALIZE_SDK: "actionInitializeSdk";

package/dist/esm/modules/mockup-generation/types/data.types.d.ts

@@ -1,29 +1,8 @@
-export interface ProductMockupEntry {
-    productId: number;
-    isSizeBased: boolean;
-    productMockups: unknown[];
-    mockupPlacements: unknown[];
-    placementTemplates: unknown[];
-}
 export interface MockupGenerationData {
-    imgUrl: string | null;
-    id: number;
-    styleName: string;
-    styleNameTranslation: string;
     color: string | null | undefined;
     size: string | null;
-    placement: string;
-    mockupVariantId: number;
-    isBlankMockup: boolean;
     baseImageUrl: string | null;
     bgColor: string;
-    isTransparent: boolean;
-    canMockupHaveDynamicBackground: boolean;
-    isLoading: boolean;
-    failed: boolean;
-    error: string | Error | null;
-    isCleared: boolean;
-    processId: string;
     blob: Blob | null;
 }
 export interface MockupDataWithProductData extends MockupGenerationData {

package/dist/esm/modules/mockup-generation/types/event/actionEventPayload.types.d.ts

@@ -1,11 +1,16 @@
-export interface InitializeMockupDataPayload {
-    productIds: number[];
-}
 export interface GetMockupsPayload {
-    file: Blob | null;
-    mockupData: {
+    /** File from which to generate mockups */
+    file: Blob;
+    /** List of all products and their variants to fetch mockups for */
+    products: {
         productId: number;
-        variantIds: number[];
+        variantIds?: number[];
     }[];
+    /** Optional mapping of productId → selected variantId.
+     *  If not provided, the first variant from each product will be used. */
+    selectedVariants?: Record<string, number>;
+    /** If set to true, request will finish faster, and allow you
+     * to show preview image on which mockup will be generated on */
+    shouldReturnBlankMockups?: true;
 }
-export type ActionEventPayload = GetMockupsPayload | InitializeMockupDataPayload;
+export type ActionEventPayload = GetMockupsPayload;

package/dist/esm/modules/product-publish/types/event/actionEventPayload.types.d.ts

@@ -1,7 +1,9 @@
 export interface GetProductPublishPayload {
-    blob: Blob | null;
-    publishData: {
+    file: Blob;
+    /** List of all products and their variants to generate templates for */
+    products: {
         productId: number;
+        /** Should not be empty, otherwise will fail to publish */
         variantIds: number[];
     }[];
 }

package/dist/esm/types/event/action/actionEvent.types.d.ts

@@ -1,4 +1,4 @@
-import { ActionEvent as SdkActionEvent, LoadModuleAction } from '../../../modules/sdk/types/event/actionEvent.types';
+import { ActionEvent as SdkActionEvent } from '../../../modules/sdk/types/event/actionEvent.types';
 import { ActionEvent as CatalogActionEvent } from '../../../modules/catalog/types/event/actionEvent.types';
 import { ActionEvent as MockupGenerationActionEvent } from '../../../modules/mockup-generation/types/event/actionEvent.types';
 import { ActionEvent as ProductPublishActionEvent } from '../../../modules/product-publish/types/event/actionEvent.types';
@@ -8,4 +8,4 @@ import { EVENT_TYPES } from '../../../modules/eventTypes';
 import { ActionEventPayload } from './actionEventPayload.types';
 export type ActionEventName = (typeof ALL_ACTION_EVENTS)[keyof typeof ALL_ACTION_EVENTS];
 export type BaseActionEvent<TName extends ActionEventName, TPayload extends ActionEventPayload> = Event<TName, typeof EVENT_TYPES.ACTION, TPayload>;
-export type ActionEvent = LoadModuleAction | MockupGenerationActionEvent | CatalogActionEvent | ProductPublishActionEvent | SdkActionEvent;
+export type ActionEvent = MockupGenerationActionEvent | CatalogActionEvent | ProductPublishActionEvent | SdkActionEvent;

package/dist/esm/types/module/module.types.d.ts

@@ -1,7 +1,7 @@
 import type { MODULE_NAMES } from '../../modules/modules';
 import { GetMockupsPayload, GetMockupsResultPayload } from '../../modules/mockup-generation/types';
 import { SdkModuleConfigData } from '../../modules/sdk/types';
-import { GetCatalogCategoriesResultPayload, GetCatalogProductsResultPayload, GetSingleCatalogProductResultPayload } from '../../modules/catalog/types';
+import { GetCatalogCategoriesResultPayload, GetCatalogProductsByIdsPayload, GetCatalogProductsPayload, GetCatalogProductsResultPayload, GetSingleCatalogProductPayload, GetSingleCatalogProductResultPayload } from '../../modules/catalog/types';
 import { NotificationEventPayload } from '../../types/event/notification/notificationEventPayload.types';
 import { GetProductPublishPayload, ProductPublishData } from '../../modules/product-publish/types';
 /** This file ensures that Iframe and SDK has the same source of truth for return values */
@@ -10,8 +10,9 @@ export interface ISdkModule {
     setup(config?: SdkModuleConfigData): Promise<NotificationEventPayload> | Promise<void>;
 }
 export interface ICatalogModule {
-    getProducts(categoryId: number): GetCatalogProductsResultPayload;
-    getProduct(productId: number): GetSingleCatalogProductResultPayload;
+    getProducts(data: GetCatalogProductsPayload): GetCatalogProductsResultPayload;
+    getProductsByIds(data: GetCatalogProductsByIdsPayload): GetCatalogProductsResultPayload;
+    getProduct(data: GetSingleCatalogProductPayload): GetSingleCatalogProductResultPayload;
     getCategories(): GetCatalogCategoriesResultPayload;
 }
 export interface IMockupGenerationModule {

package/dist/esm/version.d.ts

@@ -1 +1 @@
-export declare const VERSION: "1.2.2";
+export declare const VERSION: "2.0.1";

package/dist/esm/version.js

@@ -1,2 +1,2 @@
 // AUTO-GENERATED
-export const VERSION = '1.2.2';
+export const VERSION = '2.0.1';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fyul/embed-sdk",
-  "version": "1.2.2",
+  "version": "2.0.1",
   "description": "",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",