@fyul/embed-sdk 2.0.1 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (35) hide show
  1. package/dist/cjs/modules/eventTypes.d.ts +2 -2
  2. package/dist/cjs/modules/events.d.ts +6 -0
  3. package/dist/cjs/modules/mockup-generation/events.d.ts +6 -0
  4. package/dist/cjs/modules/mockup-generation/events.js +3 -0
  5. package/dist/cjs/modules/mockup-generation/mockupGenerationModule.d.ts +2 -1
  6. package/dist/cjs/modules/mockup-generation/mockupGenerationModule.js +4 -0
  7. package/dist/cjs/modules/mockup-generation/mockupService.d.ts +2 -1
  8. package/dist/cjs/modules/mockup-generation/mockupService.js +4 -0
  9. package/dist/cjs/modules/mockup-generation/types/data.types.d.ts +11 -2
  10. package/dist/cjs/modules/mockup-generation/types/event/actionEvent.types.d.ts +3 -2
  11. package/dist/cjs/modules/mockup-generation/types/event/actionEventPayload.types.d.ts +13 -1
  12. package/dist/cjs/modules/mockup-generation/types/event/resultEvent.types.d.ts +3 -2
  13. package/dist/cjs/modules/mockup-generation/types/event/resultEventPayload.types.d.ts +6 -3
  14. package/dist/cjs/modules/product-publish/types/event/actionEventPayload.types.d.ts +3 -0
  15. package/dist/cjs/types/module/module.types.d.ts +2 -1
  16. package/dist/cjs/version.d.ts +1 -1
  17. package/dist/cjs/version.js +1 -1
  18. package/dist/esm/modules/eventTypes.d.ts +2 -2
  19. package/dist/esm/modules/events.d.ts +6 -0
  20. package/dist/esm/modules/mockup-generation/events.d.ts +6 -0
  21. package/dist/esm/modules/mockup-generation/events.js +3 -0
  22. package/dist/esm/modules/mockup-generation/mockupGenerationModule.d.ts +2 -1
  23. package/dist/esm/modules/mockup-generation/mockupGenerationModule.js +4 -0
  24. package/dist/esm/modules/mockup-generation/mockupService.d.ts +2 -1
  25. package/dist/esm/modules/mockup-generation/mockupService.js +4 -0
  26. package/dist/esm/modules/mockup-generation/types/data.types.d.ts +11 -2
  27. package/dist/esm/modules/mockup-generation/types/event/actionEvent.types.d.ts +3 -2
  28. package/dist/esm/modules/mockup-generation/types/event/actionEventPayload.types.d.ts +13 -1
  29. package/dist/esm/modules/mockup-generation/types/event/resultEvent.types.d.ts +3 -2
  30. package/dist/esm/modules/mockup-generation/types/event/resultEventPayload.types.d.ts +6 -3
  31. package/dist/esm/modules/product-publish/types/event/actionEventPayload.types.d.ts +3 -0
  32. package/dist/esm/types/module/module.types.d.ts +2 -1
  33. package/dist/esm/version.d.ts +1 -1
  34. package/dist/esm/version.js +1 -1
  35. package/package.json +1 -1
@@ -4,6 +4,6 @@ export declare const EVENT_TYPES: {
4
4
  readonly NOTIFICATION: "notification";
5
5
  readonly RESULT: "result";
6
6
  };
7
- 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;
7
+ export declare function isAction(event: AnyEvent): event is import("./sdk/types").InitializeSdkAction | import("./sdk/types").LoadModuleAction | import("./mockup-generation/types").GetMockupsAction | import("./mockup-generation/types").AdjustMockupAction | import("./product-publish/types").GetProductPublishAction | import("./catalog/types").GetCatalogCategoriesAction | import("./catalog/types").GetCatalogProductsByIdsAction | import("./catalog/types").GetCatalogProductsAction | import("./catalog/types").GetSingleCatalogProductAction;
8
8
  export declare function isNotification(event: AnyEvent): event is import("..").NotificationEvent;
9
- 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;
9
+ 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 | import("./mockup-generation/types").AdjustMockupResultEvent;
@@ -1,6 +1,7 @@
1
1
  export declare const ALL_ACTION_EVENTS: {
2
2
  readonly PRODUCT_PUBLISH: "actionProductPublish";
3
3
  readonly GET_MOCKUPS: "actionGetMockups";
4
+ readonly ADJUST_MOCKUP: "actionAdjustMockup";
4
5
  readonly GET_CATALOG_PRODUCTS: "actionGetCatalogProducts";
5
6
  readonly GET_CATALOG_PRODUCTS_BY_IDS: "actionGetCatalogProductsByIds";
6
7
  readonly GET_SINGLE_CATALOG_PRODUCT: "actionGetSingleCatalogProduct";
@@ -11,6 +12,7 @@ export declare const ALL_ACTION_EVENTS: {
11
12
  export declare const ALL_NOTIFICATION_EVENTS: {
12
13
  readonly GET_PRODUCT_PUBLISH_FAILURE: "actionGetProductPublishFailure";
13
14
  readonly GET_MOCKUPS_FAILURE: "notificationGetMockupsFailure";
15
+ readonly ADJUST_MOCKUP_FAILURE: "actionAdjustMockupFailure";
14
16
  readonly GET_CATALOG_PRODUCTS_FAILURE: "actionGetCatalogProductsFailure";
15
17
  readonly GET_SINGLE_CATALOG_PRODUCT_FAILURE: "actionGetSingleCatalogProductFailure";
16
18
  readonly GET_CATALOG_CATEGORIES_FAILURE: "actionGetCatalogCategoriesFailure";
@@ -19,6 +21,7 @@ export declare const ALL_NOTIFICATION_EVENTS: {
19
21
  export declare const ALL_RESULT_EVENTS: {
20
22
  readonly GET_PRODUCT_PUBLISH_RESULT: "resultGetProductPublish";
21
23
  readonly GET_MOCKUPS_RESULT: "resultGetMockups";
24
+ readonly ADJUST_MOCKUP_RESULT: "resultActionAdjustMockup";
22
25
  readonly GET_CATALOG_PRODUCTS_RESULT: "resultGetCatalogProducts";
23
26
  readonly GET_SINGLE_CATALOG_PRODUCT_RESULT: "resultGetSingleCatalogProduct";
24
27
  readonly GET_CATALOG_CATEGORIES_RESULT: "resultGetCatalogCategories";
@@ -26,17 +29,20 @@ export declare const ALL_RESULT_EVENTS: {
26
29
  export declare const ALL_EVENTS: {
27
30
  readonly GET_PRODUCT_PUBLISH_RESULT: "resultGetProductPublish";
28
31
  readonly GET_MOCKUPS_RESULT: "resultGetMockups";
32
+ readonly ADJUST_MOCKUP_RESULT: "resultActionAdjustMockup";
29
33
  readonly GET_CATALOG_PRODUCTS_RESULT: "resultGetCatalogProducts";
30
34
  readonly GET_SINGLE_CATALOG_PRODUCT_RESULT: "resultGetSingleCatalogProduct";
31
35
  readonly GET_CATALOG_CATEGORIES_RESULT: "resultGetCatalogCategories";
32
36
  readonly GET_PRODUCT_PUBLISH_FAILURE: "actionGetProductPublishFailure";
33
37
  readonly GET_MOCKUPS_FAILURE: "notificationGetMockupsFailure";
38
+ readonly ADJUST_MOCKUP_FAILURE: "actionAdjustMockupFailure";
34
39
  readonly GET_CATALOG_PRODUCTS_FAILURE: "actionGetCatalogProductsFailure";
35
40
  readonly GET_SINGLE_CATALOG_PRODUCT_FAILURE: "actionGetSingleCatalogProductFailure";
36
41
  readonly GET_CATALOG_CATEGORIES_FAILURE: "actionGetCatalogCategoriesFailure";
37
42
  readonly SDK_INITIALIZATION_SUCCESS: "notificationSdkInitializationSuccess";
38
43
  readonly PRODUCT_PUBLISH: "actionProductPublish";
39
44
  readonly GET_MOCKUPS: "actionGetMockups";
45
+ readonly ADJUST_MOCKUP: "actionAdjustMockup";
40
46
  readonly GET_CATALOG_PRODUCTS: "actionGetCatalogProducts";
41
47
  readonly GET_CATALOG_PRODUCTS_BY_IDS: "actionGetCatalogProductsByIds";
42
48
  readonly GET_SINGLE_CATALOG_PRODUCT: "actionGetSingleCatalogProduct";
@@ -1,14 +1,20 @@
1
1
  export declare const EVENTS_ACTION: {
2
2
  readonly GET_MOCKUPS: "actionGetMockups";
3
+ readonly ADJUST_MOCKUP: "actionAdjustMockup";
3
4
  };
4
5
  export declare const EVENTS_NOTIFICATION: {
5
6
  readonly GET_MOCKUPS_FAILURE: "notificationGetMockupsFailure";
7
+ readonly ADJUST_MOCKUP_FAILURE: "actionAdjustMockupFailure";
6
8
  };
7
9
  export declare const EVENTS_RESULT: {
8
10
  readonly GET_MOCKUPS_RESULT: "resultGetMockups";
11
+ readonly ADJUST_MOCKUP_RESULT: "resultActionAdjustMockup";
9
12
  };
10
13
  export declare const EVENTS: {
11
14
  readonly GET_MOCKUPS_RESULT: "resultGetMockups";
15
+ readonly ADJUST_MOCKUP_RESULT: "resultActionAdjustMockup";
12
16
  readonly GET_MOCKUPS_FAILURE: "notificationGetMockupsFailure";
17
+ readonly ADJUST_MOCKUP_FAILURE: "actionAdjustMockupFailure";
13
18
  readonly GET_MOCKUPS: "actionGetMockups";
19
+ readonly ADJUST_MOCKUP: "actionAdjustMockup";
14
20
  };
@@ -3,12 +3,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.EVENTS = exports.EVENTS_RESULT = exports.EVENTS_NOTIFICATION = exports.EVENTS_ACTION = void 0;
4
4
  exports.EVENTS_ACTION = {
5
5
  GET_MOCKUPS: 'actionGetMockups',
6
+ ADJUST_MOCKUP: 'actionAdjustMockup',
6
7
  };
7
8
  exports.EVENTS_NOTIFICATION = {
8
9
  GET_MOCKUPS_FAILURE: 'notificationGetMockupsFailure',
10
+ ADJUST_MOCKUP_FAILURE: 'actionAdjustMockupFailure',
9
11
  };
10
12
  exports.EVENTS_RESULT = {
11
13
  GET_MOCKUPS_RESULT: 'resultGetMockups',
14
+ ADJUST_MOCKUP_RESULT: 'resultActionAdjustMockup',
12
15
  };
13
16
  exports.EVENTS = {
14
17
  ...exports.EVENTS_ACTION,
@@ -1,7 +1,8 @@
1
1
  import { IMockupGenerationModule } from '../../types/module/module.types';
2
2
  import { BaseModule } from '../../modules/baseModule';
3
- import { GetMockupsPayload, GetMockupsResultPayload } from '../../modules/mockup-generation/types';
3
+ import { AdjustMockupPayload, AdjustMockupResultPayload, GetMockupsPayload, GetMockupsResultPayload } from '../../modules/mockup-generation/types';
4
4
  import { WithHandledResponses } from '../../helpers/typeHelper.types';
5
5
  export declare class MockupGenerationModule extends BaseModule implements WithHandledResponses<IMockupGenerationModule> {
6
6
  getMockups(data: GetMockupsPayload): Promise<import("../..").HandledResponse<GetMockupsResultPayload, Error>>;
7
+ adjustMockup(data: AdjustMockupPayload): Promise<import("../..").HandledResponse<AdjustMockupResultPayload, Error>>;
7
8
  }
@@ -9,5 +9,9 @@ class MockupGenerationModule extends baseModule_1.BaseModule {
9
9
  const response = await this.sendRequest(types_1.EVENTS_ACTION.GET_MOCKUPS, data).catch((e) => e);
10
10
  return (0, responseHandler_1.handleResponse)(response, 'Failed to get mockups');
11
11
  }
12
+ async adjustMockup(data) {
13
+ const response = await this.sendRequest(types_1.EVENTS_ACTION.ADJUST_MOCKUP, data).catch((e) => e);
14
+ return (0, responseHandler_1.handleResponse)(response, 'Failed to get mockups');
15
+ }
12
16
  }
13
17
  exports.MockupGenerationModule = MockupGenerationModule;
@@ -1,6 +1,7 @@
1
1
  import { BaseModuleService } from '../../modules/baseModuleService';
2
- import { GetMockupsPayload } from '../../modules/mockup-generation/types';
2
+ import { AdjustMockupPayload, GetMockupsPayload } from '../../modules/mockup-generation/types';
3
3
  export declare class MockupService extends BaseModuleService {
4
4
  private getMockupGenerationModule;
5
5
  getMockups(data: GetMockupsPayload): Promise<import("../..").HandledResponse<import("../../modules/mockup-generation/types").GetMockupsResultPayload, Error>>;
6
+ adjustMockup(data: AdjustMockupPayload): Promise<import("../..").HandledResponse<import("../../modules/mockup-generation/types").AdjustMockupResultPayload, Error>>;
6
7
  }
@@ -11,5 +11,9 @@ class MockupService extends baseModuleService_1.BaseModuleService {
11
11
  const module = await this.getMockupGenerationModule();
12
12
  return await module.getMockups(data);
13
13
  }
14
+ async adjustMockup(data) {
15
+ const module = await this.getMockupGenerationModule();
16
+ return await module.adjustMockup(data);
17
+ }
14
18
  }
15
19
  exports.MockupService = MockupService;
@@ -4,7 +4,16 @@ export interface MockupGenerationData {
4
4
  baseImageUrl: string | null;
5
5
  bgColor: string;
6
6
  blob: Blob | null;
7
- }
8
- export interface MockupDataWithProductData extends MockupGenerationData {
9
7
  productId: number;
8
+ designArea: {
9
+ width: number;
10
+ height: number;
11
+ };
12
+ designPosition: {
13
+ top: number;
14
+ left: number;
15
+ rotation: number;
16
+ width: number;
17
+ height: number;
18
+ };
10
19
  }
@@ -1,5 +1,6 @@
1
1
  import { EVENTS_ACTION } from '../../../../modules/mockup-generation/events';
2
- import type { GetMockupsPayload } from './actionEventPayload.types';
2
+ import { AdjustMockupPayload, GetMockupsPayload } from './actionEventPayload.types';
3
3
  import { BaseActionEvent } from '../../../../types/event/action/actionEvent.types';
4
4
  export type GetMockupsAction = BaseActionEvent<typeof EVENTS_ACTION.GET_MOCKUPS, GetMockupsPayload>;
5
- export type ActionEvent = GetMockupsAction;
5
+ export type AdjustMockupAction = BaseActionEvent<typeof EVENTS_ACTION.ADJUST_MOCKUP, AdjustMockupPayload>;
6
+ export type ActionEvent = GetMockupsAction | AdjustMockupAction;
@@ -12,5 +12,17 @@ export interface GetMockupsPayload {
12
12
  /** If set to true, request will finish faster, and allow you
13
13
  * to show preview image on which mockup will be generated on */
14
14
  shouldReturnBlankMockups?: true;
15
+ /** Used to position design on a product */
16
+ designOptions?: DesignOption[];
15
17
  }
16
- export type ActionEventPayload = GetMockupsPayload;
18
+ export interface DesignOption {
19
+ productId: number;
20
+ variantId: number;
21
+ top?: number;
22
+ left?: number;
23
+ rotation?: number;
24
+ width?: number;
25
+ height?: number;
26
+ }
27
+ export type AdjustMockupPayload = DesignOption;
28
+ export type ActionEventPayload = GetMockupsPayload | AdjustMockupPayload;
@@ -1,5 +1,6 @@
1
1
  import type { EVENTS_RESULT } from '../../../../modules/mockup-generation/events';
2
- import type { GetMockupsResultPayload } from './resultEventPayload.types';
2
+ import type { AdjustMockupResultPayload, GetMockupsResultPayload } from './resultEventPayload.types';
3
3
  import { BaseResultEvent } from '../../../../types/event/result/resultEvent.types';
4
4
  export type GetMockupsResultEvent = BaseResultEvent<typeof EVENTS_RESULT.GET_MOCKUPS_RESULT, GetMockupsResultPayload>;
5
- export type ResultEvent = GetMockupsResultEvent;
5
+ export type AdjustMockupResultEvent = BaseResultEvent<typeof EVENTS_RESULT.ADJUST_MOCKUP_RESULT, AdjustMockupResultPayload>;
6
+ export type ResultEvent = GetMockupsResultEvent | AdjustMockupResultEvent;
@@ -1,5 +1,8 @@
1
- import type { MockupDataWithProductData } from '../../../../modules/mockup-generation/types/data.types';
1
+ import type { MockupGenerationData } from '../../../../modules/mockup-generation/types/data.types';
2
2
  export interface GetMockupsResultPayload {
3
- mockups: MockupDataWithProductData[];
3
+ mockups: MockupGenerationData[];
4
4
  }
5
- export type MockupGenerationResultPayload = GetMockupsResultPayload;
5
+ export interface AdjustMockupResultPayload {
6
+ mockup: MockupGenerationData;
7
+ }
8
+ export type MockupGenerationResultPayload = GetMockupsResultPayload | AdjustMockupResultPayload;
@@ -1,3 +1,4 @@
1
+ import type { DesignOption } from '../../../../modules/mockup-generation/types';
1
2
  export interface GetProductPublishPayload {
2
3
  file: Blob;
3
4
  /** List of all products and their variants to generate templates for */
@@ -6,5 +7,7 @@ export interface GetProductPublishPayload {
6
7
  /** Should not be empty, otherwise will fail to publish */
7
8
  variantIds: number[];
8
9
  }[];
10
+ /** Used to position design on a product */
11
+ designOptions?: DesignOption[];
9
12
  }
10
13
  export type ActionEventPayload = GetProductPublishPayload;
@@ -1,5 +1,5 @@
1
1
  import type { MODULE_NAMES } from '../../modules/modules';
2
- import { GetMockupsPayload, GetMockupsResultPayload } from '../../modules/mockup-generation/types';
2
+ import { AdjustMockupPayload, AdjustMockupResultPayload, GetMockupsPayload, GetMockupsResultPayload } from '../../modules/mockup-generation/types';
3
3
  import { SdkModuleConfigData } from '../../modules/sdk/types';
4
4
  import { GetCatalogCategoriesResultPayload, GetCatalogProductsByIdsPayload, GetCatalogProductsPayload, GetCatalogProductsResultPayload, GetSingleCatalogProductPayload, GetSingleCatalogProductResultPayload } from '../../modules/catalog/types';
5
5
  import { NotificationEventPayload } from '../../types/event/notification/notificationEventPayload.types';
@@ -17,6 +17,7 @@ export interface ICatalogModule {
17
17
  }
18
18
  export interface IMockupGenerationModule {
19
19
  getMockups(data: GetMockupsPayload): GetMockupsResultPayload;
20
+ adjustMockup(data: AdjustMockupPayload): AdjustMockupResultPayload;
20
21
  }
21
22
  export interface IProductPublishModule {
22
23
  productPublish(data: GetProductPublishPayload): ProductPublishData;
@@ -1 +1 @@
1
- export declare const VERSION: "2.0.1";
1
+ export declare const VERSION: "2.1.0";
@@ -2,4 +2,4 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.VERSION = void 0;
4
4
  // AUTO-GENERATED
5
- exports.VERSION = '2.0.1';
5
+ exports.VERSION = '2.1.0';
@@ -4,6 +4,6 @@ export declare const EVENT_TYPES: {
4
4
  readonly NOTIFICATION: "notification";
5
5
  readonly RESULT: "result";
6
6
  };
7
- 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;
7
+ export declare function isAction(event: AnyEvent): event is import("./sdk/types").InitializeSdkAction | import("./sdk/types").LoadModuleAction | import("./mockup-generation/types").GetMockupsAction | import("./mockup-generation/types").AdjustMockupAction | import("./product-publish/types").GetProductPublishAction | import("./catalog/types").GetCatalogCategoriesAction | import("./catalog/types").GetCatalogProductsByIdsAction | import("./catalog/types").GetCatalogProductsAction | import("./catalog/types").GetSingleCatalogProductAction;
8
8
  export declare function isNotification(event: AnyEvent): event is import("..").NotificationEvent;
9
- 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;
9
+ 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 | import("./mockup-generation/types").AdjustMockupResultEvent;
@@ -1,6 +1,7 @@
1
1
  export declare const ALL_ACTION_EVENTS: {
2
2
  readonly PRODUCT_PUBLISH: "actionProductPublish";
3
3
  readonly GET_MOCKUPS: "actionGetMockups";
4
+ readonly ADJUST_MOCKUP: "actionAdjustMockup";
4
5
  readonly GET_CATALOG_PRODUCTS: "actionGetCatalogProducts";
5
6
  readonly GET_CATALOG_PRODUCTS_BY_IDS: "actionGetCatalogProductsByIds";
6
7
  readonly GET_SINGLE_CATALOG_PRODUCT: "actionGetSingleCatalogProduct";
@@ -11,6 +12,7 @@ export declare const ALL_ACTION_EVENTS: {
11
12
  export declare const ALL_NOTIFICATION_EVENTS: {
12
13
  readonly GET_PRODUCT_PUBLISH_FAILURE: "actionGetProductPublishFailure";
13
14
  readonly GET_MOCKUPS_FAILURE: "notificationGetMockupsFailure";
15
+ readonly ADJUST_MOCKUP_FAILURE: "actionAdjustMockupFailure";
14
16
  readonly GET_CATALOG_PRODUCTS_FAILURE: "actionGetCatalogProductsFailure";
15
17
  readonly GET_SINGLE_CATALOG_PRODUCT_FAILURE: "actionGetSingleCatalogProductFailure";
16
18
  readonly GET_CATALOG_CATEGORIES_FAILURE: "actionGetCatalogCategoriesFailure";
@@ -19,6 +21,7 @@ export declare const ALL_NOTIFICATION_EVENTS: {
19
21
  export declare const ALL_RESULT_EVENTS: {
20
22
  readonly GET_PRODUCT_PUBLISH_RESULT: "resultGetProductPublish";
21
23
  readonly GET_MOCKUPS_RESULT: "resultGetMockups";
24
+ readonly ADJUST_MOCKUP_RESULT: "resultActionAdjustMockup";
22
25
  readonly GET_CATALOG_PRODUCTS_RESULT: "resultGetCatalogProducts";
23
26
  readonly GET_SINGLE_CATALOG_PRODUCT_RESULT: "resultGetSingleCatalogProduct";
24
27
  readonly GET_CATALOG_CATEGORIES_RESULT: "resultGetCatalogCategories";
@@ -26,17 +29,20 @@ export declare const ALL_RESULT_EVENTS: {
26
29
  export declare const ALL_EVENTS: {
27
30
  readonly GET_PRODUCT_PUBLISH_RESULT: "resultGetProductPublish";
28
31
  readonly GET_MOCKUPS_RESULT: "resultGetMockups";
32
+ readonly ADJUST_MOCKUP_RESULT: "resultActionAdjustMockup";
29
33
  readonly GET_CATALOG_PRODUCTS_RESULT: "resultGetCatalogProducts";
30
34
  readonly GET_SINGLE_CATALOG_PRODUCT_RESULT: "resultGetSingleCatalogProduct";
31
35
  readonly GET_CATALOG_CATEGORIES_RESULT: "resultGetCatalogCategories";
32
36
  readonly GET_PRODUCT_PUBLISH_FAILURE: "actionGetProductPublishFailure";
33
37
  readonly GET_MOCKUPS_FAILURE: "notificationGetMockupsFailure";
38
+ readonly ADJUST_MOCKUP_FAILURE: "actionAdjustMockupFailure";
34
39
  readonly GET_CATALOG_PRODUCTS_FAILURE: "actionGetCatalogProductsFailure";
35
40
  readonly GET_SINGLE_CATALOG_PRODUCT_FAILURE: "actionGetSingleCatalogProductFailure";
36
41
  readonly GET_CATALOG_CATEGORIES_FAILURE: "actionGetCatalogCategoriesFailure";
37
42
  readonly SDK_INITIALIZATION_SUCCESS: "notificationSdkInitializationSuccess";
38
43
  readonly PRODUCT_PUBLISH: "actionProductPublish";
39
44
  readonly GET_MOCKUPS: "actionGetMockups";
45
+ readonly ADJUST_MOCKUP: "actionAdjustMockup";
40
46
  readonly GET_CATALOG_PRODUCTS: "actionGetCatalogProducts";
41
47
  readonly GET_CATALOG_PRODUCTS_BY_IDS: "actionGetCatalogProductsByIds";
42
48
  readonly GET_SINGLE_CATALOG_PRODUCT: "actionGetSingleCatalogProduct";
@@ -1,14 +1,20 @@
1
1
  export declare const EVENTS_ACTION: {
2
2
  readonly GET_MOCKUPS: "actionGetMockups";
3
+ readonly ADJUST_MOCKUP: "actionAdjustMockup";
3
4
  };
4
5
  export declare const EVENTS_NOTIFICATION: {
5
6
  readonly GET_MOCKUPS_FAILURE: "notificationGetMockupsFailure";
7
+ readonly ADJUST_MOCKUP_FAILURE: "actionAdjustMockupFailure";
6
8
  };
7
9
  export declare const EVENTS_RESULT: {
8
10
  readonly GET_MOCKUPS_RESULT: "resultGetMockups";
11
+ readonly ADJUST_MOCKUP_RESULT: "resultActionAdjustMockup";
9
12
  };
10
13
  export declare const EVENTS: {
11
14
  readonly GET_MOCKUPS_RESULT: "resultGetMockups";
15
+ readonly ADJUST_MOCKUP_RESULT: "resultActionAdjustMockup";
12
16
  readonly GET_MOCKUPS_FAILURE: "notificationGetMockupsFailure";
17
+ readonly ADJUST_MOCKUP_FAILURE: "actionAdjustMockupFailure";
13
18
  readonly GET_MOCKUPS: "actionGetMockups";
19
+ readonly ADJUST_MOCKUP: "actionAdjustMockup";
14
20
  };
@@ -1,11 +1,14 @@
1
1
  export const EVENTS_ACTION = {
2
2
  GET_MOCKUPS: 'actionGetMockups',
3
+ ADJUST_MOCKUP: 'actionAdjustMockup',
3
4
  };
4
5
  export const EVENTS_NOTIFICATION = {
5
6
  GET_MOCKUPS_FAILURE: 'notificationGetMockupsFailure',
7
+ ADJUST_MOCKUP_FAILURE: 'actionAdjustMockupFailure',
6
8
  };
7
9
  export const EVENTS_RESULT = {
8
10
  GET_MOCKUPS_RESULT: 'resultGetMockups',
11
+ ADJUST_MOCKUP_RESULT: 'resultActionAdjustMockup',
9
12
  };
10
13
  export const EVENTS = {
11
14
  ...EVENTS_ACTION,
@@ -1,7 +1,8 @@
1
1
  import { IMockupGenerationModule } from '../../types/module/module.types';
2
2
  import { BaseModule } from '../../modules/baseModule';
3
- import { GetMockupsPayload, GetMockupsResultPayload } from '../../modules/mockup-generation/types';
3
+ import { AdjustMockupPayload, AdjustMockupResultPayload, GetMockupsPayload, GetMockupsResultPayload } from '../../modules/mockup-generation/types';
4
4
  import { WithHandledResponses } from '../../helpers/typeHelper.types';
5
5
  export declare class MockupGenerationModule extends BaseModule implements WithHandledResponses<IMockupGenerationModule> {
6
6
  getMockups(data: GetMockupsPayload): Promise<import("../..").HandledResponse<GetMockupsResultPayload, Error>>;
7
+ adjustMockup(data: AdjustMockupPayload): Promise<import("../..").HandledResponse<AdjustMockupResultPayload, Error>>;
7
8
  }
@@ -6,4 +6,8 @@ export class MockupGenerationModule extends BaseModule {
6
6
  const response = await this.sendRequest(EVENTS_ACTION.GET_MOCKUPS, data).catch((e) => e);
7
7
  return handleResponse(response, 'Failed to get mockups');
8
8
  }
9
+ async adjustMockup(data) {
10
+ const response = await this.sendRequest(EVENTS_ACTION.ADJUST_MOCKUP, data).catch((e) => e);
11
+ return handleResponse(response, 'Failed to get mockups');
12
+ }
9
13
  }
@@ -1,6 +1,7 @@
1
1
  import { BaseModuleService } from '../../modules/baseModuleService';
2
- import { GetMockupsPayload } from '../../modules/mockup-generation/types';
2
+ import { AdjustMockupPayload, GetMockupsPayload } from '../../modules/mockup-generation/types';
3
3
  export declare class MockupService extends BaseModuleService {
4
4
  private getMockupGenerationModule;
5
5
  getMockups(data: GetMockupsPayload): Promise<import("../..").HandledResponse<import("../../modules/mockup-generation/types").GetMockupsResultPayload, Error>>;
6
+ adjustMockup(data: AdjustMockupPayload): Promise<import("../..").HandledResponse<import("../../modules/mockup-generation/types").AdjustMockupResultPayload, Error>>;
6
7
  }
@@ -8,4 +8,8 @@ export class MockupService extends BaseModuleService {
8
8
  const module = await this.getMockupGenerationModule();
9
9
  return await module.getMockups(data);
10
10
  }
11
+ async adjustMockup(data) {
12
+ const module = await this.getMockupGenerationModule();
13
+ return await module.adjustMockup(data);
14
+ }
11
15
  }
@@ -4,7 +4,16 @@ export interface MockupGenerationData {
4
4
  baseImageUrl: string | null;
5
5
  bgColor: string;
6
6
  blob: Blob | null;
7
- }
8
- export interface MockupDataWithProductData extends MockupGenerationData {
9
7
  productId: number;
8
+ designArea: {
9
+ width: number;
10
+ height: number;
11
+ };
12
+ designPosition: {
13
+ top: number;
14
+ left: number;
15
+ rotation: number;
16
+ width: number;
17
+ height: number;
18
+ };
10
19
  }
@@ -1,5 +1,6 @@
1
1
  import { EVENTS_ACTION } from '../../../../modules/mockup-generation/events';
2
- import type { GetMockupsPayload } from './actionEventPayload.types';
2
+ import { AdjustMockupPayload, GetMockupsPayload } from './actionEventPayload.types';
3
3
  import { BaseActionEvent } from '../../../../types/event/action/actionEvent.types';
4
4
  export type GetMockupsAction = BaseActionEvent<typeof EVENTS_ACTION.GET_MOCKUPS, GetMockupsPayload>;
5
- export type ActionEvent = GetMockupsAction;
5
+ export type AdjustMockupAction = BaseActionEvent<typeof EVENTS_ACTION.ADJUST_MOCKUP, AdjustMockupPayload>;
6
+ export type ActionEvent = GetMockupsAction | AdjustMockupAction;
@@ -12,5 +12,17 @@ export interface GetMockupsPayload {
12
12
  /** If set to true, request will finish faster, and allow you
13
13
  * to show preview image on which mockup will be generated on */
14
14
  shouldReturnBlankMockups?: true;
15
+ /** Used to position design on a product */
16
+ designOptions?: DesignOption[];
15
17
  }
16
- export type ActionEventPayload = GetMockupsPayload;
18
+ export interface DesignOption {
19
+ productId: number;
20
+ variantId: number;
21
+ top?: number;
22
+ left?: number;
23
+ rotation?: number;
24
+ width?: number;
25
+ height?: number;
26
+ }
27
+ export type AdjustMockupPayload = DesignOption;
28
+ export type ActionEventPayload = GetMockupsPayload | AdjustMockupPayload;
@@ -1,5 +1,6 @@
1
1
  import type { EVENTS_RESULT } from '../../../../modules/mockup-generation/events';
2
- import type { GetMockupsResultPayload } from './resultEventPayload.types';
2
+ import type { AdjustMockupResultPayload, GetMockupsResultPayload } from './resultEventPayload.types';
3
3
  import { BaseResultEvent } from '../../../../types/event/result/resultEvent.types';
4
4
  export type GetMockupsResultEvent = BaseResultEvent<typeof EVENTS_RESULT.GET_MOCKUPS_RESULT, GetMockupsResultPayload>;
5
- export type ResultEvent = GetMockupsResultEvent;
5
+ export type AdjustMockupResultEvent = BaseResultEvent<typeof EVENTS_RESULT.ADJUST_MOCKUP_RESULT, AdjustMockupResultPayload>;
6
+ export type ResultEvent = GetMockupsResultEvent | AdjustMockupResultEvent;
@@ -1,5 +1,8 @@
1
- import type { MockupDataWithProductData } from '../../../../modules/mockup-generation/types/data.types';
1
+ import type { MockupGenerationData } from '../../../../modules/mockup-generation/types/data.types';
2
2
  export interface GetMockupsResultPayload {
3
- mockups: MockupDataWithProductData[];
3
+ mockups: MockupGenerationData[];
4
4
  }
5
- export type MockupGenerationResultPayload = GetMockupsResultPayload;
5
+ export interface AdjustMockupResultPayload {
6
+ mockup: MockupGenerationData;
7
+ }
8
+ export type MockupGenerationResultPayload = GetMockupsResultPayload | AdjustMockupResultPayload;
@@ -1,3 +1,4 @@
1
+ import type { DesignOption } from '../../../../modules/mockup-generation/types';
1
2
  export interface GetProductPublishPayload {
2
3
  file: Blob;
3
4
  /** List of all products and their variants to generate templates for */
@@ -6,5 +7,7 @@ export interface GetProductPublishPayload {
6
7
  /** Should not be empty, otherwise will fail to publish */
7
8
  variantIds: number[];
8
9
  }[];
10
+ /** Used to position design on a product */
11
+ designOptions?: DesignOption[];
9
12
  }
10
13
  export type ActionEventPayload = GetProductPublishPayload;
@@ -1,5 +1,5 @@
1
1
  import type { MODULE_NAMES } from '../../modules/modules';
2
- import { GetMockupsPayload, GetMockupsResultPayload } from '../../modules/mockup-generation/types';
2
+ import { AdjustMockupPayload, AdjustMockupResultPayload, GetMockupsPayload, GetMockupsResultPayload } from '../../modules/mockup-generation/types';
3
3
  import { SdkModuleConfigData } from '../../modules/sdk/types';
4
4
  import { GetCatalogCategoriesResultPayload, GetCatalogProductsByIdsPayload, GetCatalogProductsPayload, GetCatalogProductsResultPayload, GetSingleCatalogProductPayload, GetSingleCatalogProductResultPayload } from '../../modules/catalog/types';
5
5
  import { NotificationEventPayload } from '../../types/event/notification/notificationEventPayload.types';
@@ -17,6 +17,7 @@ export interface ICatalogModule {
17
17
  }
18
18
  export interface IMockupGenerationModule {
19
19
  getMockups(data: GetMockupsPayload): GetMockupsResultPayload;
20
+ adjustMockup(data: AdjustMockupPayload): AdjustMockupResultPayload;
20
21
  }
21
22
  export interface IProductPublishModule {
22
23
  productPublish(data: GetProductPublishPayload): ProductPublishData;
@@ -1 +1 @@
1
- export declare const VERSION: "2.0.1";
1
+ export declare const VERSION: "2.1.0";
@@ -1,2 +1,2 @@
1
1
  // AUTO-GENERATED
2
- export const VERSION = '2.0.1';
2
+ export const VERSION = '2.1.0';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fyul/embed-sdk",
3
- "version": "2.0.1",
3
+ "version": "2.1.0",
4
4
  "description": "",
5
5
  "main": "./dist/cjs/index.js",
6
6
  "module": "./dist/esm/index.js",