@fyul/embed-sdk 2.4.17 → 2.4.19

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 (31) 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 +14 -0
  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 +21 -7
  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 +5 -2
  14. package/dist/cjs/version.d.ts +1 -1
  15. package/dist/cjs/version.js +1 -1
  16. package/dist/esm/modules/eventTypes.d.ts +2 -2
  17. package/dist/esm/modules/events.d.ts +6 -0
  18. package/dist/esm/modules/mockup-generation/events.d.ts +6 -0
  19. package/dist/esm/modules/mockup-generation/events.js +3 -0
  20. package/dist/esm/modules/mockup-generation/mockupGenerationModule.d.ts +2 -1
  21. package/dist/esm/modules/mockup-generation/mockupGenerationModule.js +4 -0
  22. package/dist/esm/modules/mockup-generation/mockupService.d.ts +2 -1
  23. package/dist/esm/modules/mockup-generation/mockupService.js +4 -0
  24. package/dist/esm/modules/mockup-generation/types/data.types.d.ts +14 -0
  25. package/dist/esm/modules/mockup-generation/types/event/actionEvent.types.d.ts +3 -2
  26. package/dist/esm/modules/mockup-generation/types/event/actionEventPayload.types.d.ts +21 -7
  27. package/dist/esm/modules/mockup-generation/types/event/resultEvent.types.d.ts +3 -2
  28. package/dist/esm/modules/mockup-generation/types/event/resultEventPayload.types.d.ts +5 -2
  29. package/dist/esm/version.d.ts +1 -1
  30. package/dist/esm/version.js +1 -1
  31. package/package.json +1 -1
@@ -5,7 +5,7 @@ export declare const EVENT_TYPES: {
5
5
  readonly RESULT: "result";
6
6
  readonly BROADCAST: "broadcast";
7
7
  };
8
- 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("./edm/types").InitializeEdmAction | import("./edm/types").SaveDesignAction | import("./edm/types").AddImageAction | import("./edm/types").NavigateStepAction | import("./product-publish/types").GetProductPublishAction | import("./product-publish/types").GetSavedProductsAction | import("./product-publish/types").DeleteProductsAction | import("./catalog/types").GetCatalogCategoriesAction | import("./catalog/types").GetCatalogProductsByIdsAction | import("./catalog/types").GetCatalogProductsAction | import("./catalog/types").GetSingleCatalogProductAction;
8
+ 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").GetMoreMockupsAction | import("./mockup-generation/types").AdjustMockupAction | import("./edm/types").InitializeEdmAction | import("./edm/types").SaveDesignAction | import("./edm/types").AddImageAction | import("./edm/types").NavigateStepAction | import("./product-publish/types").GetProductPublishAction | import("./product-publish/types").GetSavedProductsAction | import("./product-publish/types").DeleteProductsAction | import("./catalog/types").GetCatalogCategoriesAction | import("./catalog/types").GetCatalogProductsByIdsAction | import("./catalog/types").GetCatalogProductsAction | import("./catalog/types").GetSingleCatalogProductAction;
9
9
  export declare function isNotification(event: AnyEvent): event is import("..").NotificationEvent;
10
- 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("./product-publish/types").GetSavedProductsResult | import("./product-publish/types").DeleteProductsResult | import("./edm/types").SaveDesignResultEvent | import("./edm/types").AddImageResultEvent | import("./edm/types").SetStyleResultEvent | import("./edm/types").NavigateStepResultEvent | import("./mockup-generation/types").GetMockupsResultEvent | import("./mockup-generation/types").AdjustMockupResultEvent;
10
+ 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("./product-publish/types").GetSavedProductsResult | import("./product-publish/types").DeleteProductsResult | import("./edm/types").SaveDesignResultEvent | import("./edm/types").AddImageResultEvent | import("./edm/types").SetStyleResultEvent | import("./edm/types").NavigateStepResultEvent | import("./mockup-generation/types").GetMockupsResultEvent | import("./mockup-generation/types").GetMoreMockupsResultEvent | import("./mockup-generation/types").AdjustMockupResultEvent;
11
11
  export declare function isBroadcast(event: AnyEvent): event is import("./edm/types/event/broadcastEvent.types").OnDesignStatusUpdateBroadcast | import("./edm/types/event/broadcastEvent.types").OnPricingStatusUpdateBroadcast | import("./edm/types/event/broadcastEvent.types").OnFilePickerRequestBroadcast | import("./edm/types/event/broadcastEvent.types").OnStepStatusUpdateBroadcast | import("./edm/types/event/broadcastEvent.types").OnErrorUpdateBroadcast;
@@ -8,6 +8,7 @@ export declare const ALL_ACTION_EVENTS: {
8
8
  readonly GET_SAVED_PRODUCTS: "actionGetSavedProducts";
9
9
  readonly DELETE_PRODUCTS: "actionDeleteProducts";
10
10
  readonly GET_MOCKUPS: "actionGetMockups";
11
+ readonly GET_MORE_MOCKUPS: "actionGetMoreMockups";
11
12
  readonly ADJUST_MOCKUP: "actionAdjustMockup";
12
13
  readonly GET_CATALOG_PRODUCTS: "actionGetCatalogProducts";
13
14
  readonly GET_CATALOG_PRODUCTS_BY_IDS: "actionGetCatalogProductsByIds";
@@ -26,6 +27,7 @@ export declare const ALL_NOTIFICATION_EVENTS: {
26
27
  readonly GET_SAVED_PRODUCTS_FAILURE: "actionGetSavedProductsFailure";
27
28
  readonly DELETE_PRODUCTS_FAILURE: "actionDeleteProductsFailure";
28
29
  readonly GET_MOCKUPS_FAILURE: "notificationGetMockupsFailure";
30
+ readonly GET_MORE_MOCKUPS_FAILURE: "notificationGetMoreMockupsFailure";
29
31
  readonly ADJUST_MOCKUP_FAILURE: "actionAdjustMockupFailure";
30
32
  readonly GET_CATALOG_PRODUCTS_FAILURE: "actionGetCatalogProductsFailure";
31
33
  readonly GET_SINGLE_CATALOG_PRODUCT_FAILURE: "actionGetSingleCatalogProductFailure";
@@ -41,6 +43,7 @@ export declare const ALL_RESULT_EVENTS: {
41
43
  readonly GET_SAVED_PRODUCTS_RESULT: "resultGetSavedProducts";
42
44
  readonly DELETE_PRODUCTS_RESULT: "resultDeleteProducts";
43
45
  readonly GET_MOCKUPS_RESULT: "resultGetMockups";
46
+ readonly GET_MORE_MOCKUPS_RESULT: "resultGetMoreMockups";
44
47
  readonly ADJUST_MOCKUP_RESULT: "resultActionAdjustMockup";
45
48
  readonly GET_CATALOG_PRODUCTS_RESULT: "resultGetCatalogProducts";
46
49
  readonly GET_SINGLE_CATALOG_PRODUCT_RESULT: "resultGetSingleCatalogProduct";
@@ -67,6 +70,7 @@ export declare const ALL_EVENTS: {
67
70
  readonly GET_SAVED_PRODUCTS_RESULT: "resultGetSavedProducts";
68
71
  readonly DELETE_PRODUCTS_RESULT: "resultDeleteProducts";
69
72
  readonly GET_MOCKUPS_RESULT: "resultGetMockups";
73
+ readonly GET_MORE_MOCKUPS_RESULT: "resultGetMoreMockups";
70
74
  readonly ADJUST_MOCKUP_RESULT: "resultActionAdjustMockup";
71
75
  readonly GET_CATALOG_PRODUCTS_RESULT: "resultGetCatalogProducts";
72
76
  readonly GET_SINGLE_CATALOG_PRODUCT_RESULT: "resultGetSingleCatalogProduct";
@@ -80,6 +84,7 @@ export declare const ALL_EVENTS: {
80
84
  readonly GET_SAVED_PRODUCTS_FAILURE: "actionGetSavedProductsFailure";
81
85
  readonly DELETE_PRODUCTS_FAILURE: "actionDeleteProductsFailure";
82
86
  readonly GET_MOCKUPS_FAILURE: "notificationGetMockupsFailure";
87
+ readonly GET_MORE_MOCKUPS_FAILURE: "notificationGetMoreMockupsFailure";
83
88
  readonly ADJUST_MOCKUP_FAILURE: "actionAdjustMockupFailure";
84
89
  readonly GET_CATALOG_PRODUCTS_FAILURE: "actionGetCatalogProductsFailure";
85
90
  readonly GET_SINGLE_CATALOG_PRODUCT_FAILURE: "actionGetSingleCatalogProductFailure";
@@ -94,6 +99,7 @@ export declare const ALL_EVENTS: {
94
99
  readonly GET_SAVED_PRODUCTS: "actionGetSavedProducts";
95
100
  readonly DELETE_PRODUCTS: "actionDeleteProducts";
96
101
  readonly GET_MOCKUPS: "actionGetMockups";
102
+ readonly GET_MORE_MOCKUPS: "actionGetMoreMockups";
97
103
  readonly ADJUST_MOCKUP: "actionAdjustMockup";
98
104
  readonly GET_CATALOG_PRODUCTS: "actionGetCatalogProducts";
99
105
  readonly GET_CATALOG_PRODUCTS_BY_IDS: "actionGetCatalogProductsByIds";
@@ -1,20 +1,26 @@
1
1
  export declare const EVENTS_ACTION: {
2
2
  readonly GET_MOCKUPS: "actionGetMockups";
3
+ readonly GET_MORE_MOCKUPS: "actionGetMoreMockups";
3
4
  readonly ADJUST_MOCKUP: "actionAdjustMockup";
4
5
  };
5
6
  export declare const EVENTS_NOTIFICATION: {
6
7
  readonly GET_MOCKUPS_FAILURE: "notificationGetMockupsFailure";
8
+ readonly GET_MORE_MOCKUPS_FAILURE: "notificationGetMoreMockupsFailure";
7
9
  readonly ADJUST_MOCKUP_FAILURE: "actionAdjustMockupFailure";
8
10
  };
9
11
  export declare const EVENTS_RESULT: {
10
12
  readonly GET_MOCKUPS_RESULT: "resultGetMockups";
13
+ readonly GET_MORE_MOCKUPS_RESULT: "resultGetMoreMockups";
11
14
  readonly ADJUST_MOCKUP_RESULT: "resultActionAdjustMockup";
12
15
  };
13
16
  export declare const EVENTS: {
14
17
  readonly GET_MOCKUPS_RESULT: "resultGetMockups";
18
+ readonly GET_MORE_MOCKUPS_RESULT: "resultGetMoreMockups";
15
19
  readonly ADJUST_MOCKUP_RESULT: "resultActionAdjustMockup";
16
20
  readonly GET_MOCKUPS_FAILURE: "notificationGetMockupsFailure";
21
+ readonly GET_MORE_MOCKUPS_FAILURE: "notificationGetMoreMockupsFailure";
17
22
  readonly ADJUST_MOCKUP_FAILURE: "actionAdjustMockupFailure";
18
23
  readonly GET_MOCKUPS: "actionGetMockups";
24
+ readonly GET_MORE_MOCKUPS: "actionGetMoreMockups";
19
25
  readonly ADJUST_MOCKUP: "actionAdjustMockup";
20
26
  };
@@ -3,14 +3,17 @@ 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
+ GET_MORE_MOCKUPS: 'actionGetMoreMockups',
6
7
  ADJUST_MOCKUP: 'actionAdjustMockup',
7
8
  };
8
9
  exports.EVENTS_NOTIFICATION = {
9
10
  GET_MOCKUPS_FAILURE: 'notificationGetMockupsFailure',
11
+ GET_MORE_MOCKUPS_FAILURE: 'notificationGetMoreMockupsFailure',
10
12
  ADJUST_MOCKUP_FAILURE: 'actionAdjustMockupFailure',
11
13
  };
12
14
  exports.EVENTS_RESULT = {
13
15
  GET_MOCKUPS_RESULT: 'resultGetMockups',
16
+ GET_MORE_MOCKUPS_RESULT: 'resultGetMoreMockups',
14
17
  ADJUST_MOCKUP_RESULT: 'resultActionAdjustMockup',
15
18
  };
16
19
  exports.EVENTS = {
@@ -1,9 +1,10 @@
1
1
  import { IMockupGenerationModule } from '../../types/module/module.types';
2
2
  import { BaseModule } from '../../modules/baseModule';
3
- import { AdjustMockupPayload, AdjustMockupResultPayload, GetMockupsPayload, GetMockupsResultPayload } from '../../modules/mockup-generation/types';
3
+ import { AdjustMockupPayload, AdjustMockupResultPayload, GetMockupsPayload, GetMockupsResultPayload, GetMoreMockupsResultPayload, GetMoreMockupsPayload } 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
  constructor();
7
7
  getMockups(data: GetMockupsPayload): Promise<import("../..").HandledResponse<GetMockupsResultPayload, Error>>;
8
+ getMoreMockups(data: GetMoreMockupsPayload): Promise<import("../..").HandledResponse<GetMoreMockupsResultPayload, Error>>;
8
9
  adjustMockup(data: AdjustMockupPayload): Promise<import("../..").HandledResponse<AdjustMockupResultPayload, Error>>;
9
10
  }
@@ -13,6 +13,10 @@ class MockupGenerationModule extends baseModule_1.BaseModule {
13
13
  const response = await this.sendRequest(types_1.EVENTS_ACTION.GET_MOCKUPS, data).catch((e) => e);
14
14
  return (0, responseHandler_1.handleResponse)(response, 'Failed to get mockups');
15
15
  }
16
+ async getMoreMockups(data) {
17
+ const response = await this.sendRequest(types_1.EVENTS_ACTION.GET_MORE_MOCKUPS, data).catch((e) => e);
18
+ return (0, responseHandler_1.handleResponse)(response, 'Failed to get more mockups');
19
+ }
16
20
  async adjustMockup(data) {
17
21
  const response = await this.sendRequest(types_1.EVENTS_ACTION.ADJUST_MOCKUP, data).catch((e) => e);
18
22
  return (0, responseHandler_1.handleResponse)(response, 'Failed to get mockups');
@@ -1,7 +1,8 @@
1
1
  import { BaseModuleService } from '../../modules/baseModuleService';
2
- import { AdjustMockupPayload, GetMockupsPayload } from '../../modules/mockup-generation/types';
2
+ import { AdjustMockupPayload, GetMockupsPayload, GetMoreMockupsPayload } 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
+ getMoreMockups(data: GetMoreMockupsPayload): Promise<import("../..").HandledResponse<import("../../modules/mockup-generation/types").GetMoreMockupsResultPayload, Error>>;
6
7
  adjustMockup(data: AdjustMockupPayload): Promise<import("../..").HandledResponse<import("../../modules/mockup-generation/types").AdjustMockupResultPayload, Error>>;
7
8
  }
@@ -11,6 +11,10 @@ class MockupService extends baseModuleService_1.BaseModuleService {
11
11
  const module = await this.getMockupGenerationModule();
12
12
  return await module.getMockups(data);
13
13
  }
14
+ async getMoreMockups(data) {
15
+ const module = await this.getMockupGenerationModule();
16
+ return await module.getMoreMockups(data);
17
+ }
14
18
  async adjustMockup(data) {
15
19
  const module = await this.getMockupGenerationModule();
16
20
  return await module.adjustMockup(data);
@@ -18,3 +18,17 @@ export interface MockupGenerationData {
18
18
  height: number;
19
19
  };
20
20
  }
21
+ export interface MockupItem {
22
+ styleId: number;
23
+ blob: Blob;
24
+ view: string;
25
+ }
26
+ export interface MoreMockupGenerationData {
27
+ color: string | null | undefined;
28
+ size: string | null;
29
+ variantId: number;
30
+ baseImageUrl: string | null;
31
+ bgColor: string;
32
+ mockups: MockupItem[];
33
+ productId: number;
34
+ }
@@ -1,6 +1,7 @@
1
1
  import { EVENTS_ACTION } from '../../../../modules/mockup-generation/events';
2
- import { AdjustMockupPayload, GetMockupsPayload } from './actionEventPayload.types';
2
+ import { AdjustMockupPayload, GetMockupsPayload, GetMoreMockupsPayload } from '../../../../modules/mockup-generation/types/event/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 GetMoreMockupsAction = BaseActionEvent<typeof EVENTS_ACTION.GET_MORE_MOCKUPS, GetMoreMockupsPayload>;
5
6
  export type AdjustMockupAction = BaseActionEvent<typeof EVENTS_ACTION.ADJUST_MOCKUP, AdjustMockupPayload>;
6
- export type ActionEvent = GetMockupsAction | AdjustMockupAction;
7
+ export type ActionEvent = GetMockupsAction | AdjustMockupAction | GetMoreMockupsAction;
@@ -3,28 +3,42 @@ export interface GetMockupsPayload {
3
3
  file: Blob;
4
4
  products: {
5
5
  productId: number;
6
- /** Prefetch as many variants as necessary, so that switching colors/sizes
6
+ /** Prefetch as many variants as necessary so that switching colors/sizes
7
7
  * will be faster */
8
8
  variantIds?: number[];
9
9
  /** If not provided, the first variant from each product will be used */
10
10
  selectedVariantId?: number;
11
11
  /** If not provided, the default product technique will be used */
12
12
  selectedTechnique?: string;
13
+ /** Will return the front view of a specified option group if set. To find
14
+ * available option groups, use the Printful API:
15
+ * https://api.printful.com/mockup-generator/printfiles/{productId} */
16
+ optionGroup?: string;
13
17
  }[];
14
- /** If set to true, request will finish faster, and allow you
15
- * to show preview image on which mockup will be generated on */
18
+ /** If set to true, the request will finish faster and allow you
19
+ * to show a preview image on which mockup will be generated on */
16
20
  shouldReturnBlankMockups?: true;
17
21
  /** Used to position design on a product */
18
22
  designOptions?: DesignOption[];
19
23
  }
20
- export interface DesignOption {
21
- productId: number;
22
- variantId: number;
24
+ export interface DesignPosition {
23
25
  top?: number;
24
26
  left?: number;
25
27
  rotation?: number;
26
28
  width?: number;
27
29
  height?: number;
28
30
  }
31
+ export interface DesignOption extends DesignPosition {
32
+ productId: number;
33
+ variantId: number;
34
+ }
35
+ export interface GetMoreMockupsPayload {
36
+ file: Blob;
37
+ productId: number;
38
+ variantId?: number;
39
+ selectedTechnique?: string;
40
+ designOption?: DesignPosition;
41
+ optionGroup?: string;
42
+ }
29
43
  export type AdjustMockupPayload = DesignOption;
30
- export type ActionEventPayload = GetMockupsPayload | AdjustMockupPayload;
44
+ export type ActionEventPayload = GetMockupsPayload | GetMoreMockupsPayload | AdjustMockupPayload;
@@ -1,6 +1,7 @@
1
1
  import type { EVENTS_RESULT } from '../../../../modules/mockup-generation/events';
2
- import type { AdjustMockupResultPayload, GetMockupsResultPayload } from './resultEventPayload.types';
2
+ import type { AdjustMockupResultPayload, GetMockupsResultPayload, GetMoreMockupsResultPayload } from '../../../../modules/mockup-generation/types/event/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 GetMoreMockupsResultEvent = BaseResultEvent<typeof EVENTS_RESULT.GET_MORE_MOCKUPS_RESULT, GetMoreMockupsResultPayload>;
5
6
  export type AdjustMockupResultEvent = BaseResultEvent<typeof EVENTS_RESULT.ADJUST_MOCKUP_RESULT, AdjustMockupResultPayload>;
6
- export type ResultEvent = GetMockupsResultEvent | AdjustMockupResultEvent;
7
+ export type ResultEvent = GetMockupsResultEvent | GetMoreMockupsResultEvent | AdjustMockupResultEvent;
@@ -1,8 +1,11 @@
1
- import type { MockupGenerationData } from '../../../../modules/mockup-generation/types/data.types';
1
+ import { MockupGenerationData, MoreMockupGenerationData } from '../../../../modules/mockup-generation/types/data.types';
2
2
  export interface GetMockupsResultPayload {
3
3
  mockups: MockupGenerationData[];
4
4
  }
5
+ export interface GetMoreMockupsResultPayload {
6
+ mockups: MoreMockupGenerationData;
7
+ }
5
8
  export interface AdjustMockupResultPayload {
6
9
  mockup: MockupGenerationData;
7
10
  }
8
- export type MockupGenerationResultPayload = GetMockupsResultPayload | AdjustMockupResultPayload;
11
+ export type MockupGenerationResultPayload = GetMockupsResultPayload | AdjustMockupResultPayload | GetMoreMockupsResultPayload;
@@ -1 +1 @@
1
- export declare const VERSION: "2.4.17";
1
+ export declare const VERSION: "2.4.19";
@@ -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.4.17';
5
+ exports.VERSION = '2.4.19';
@@ -5,7 +5,7 @@ export declare const EVENT_TYPES: {
5
5
  readonly RESULT: "result";
6
6
  readonly BROADCAST: "broadcast";
7
7
  };
8
- 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("./edm/types").InitializeEdmAction | import("./edm/types").SaveDesignAction | import("./edm/types").AddImageAction | import("./edm/types").NavigateStepAction | import("./product-publish/types").GetProductPublishAction | import("./product-publish/types").GetSavedProductsAction | import("./product-publish/types").DeleteProductsAction | import("./catalog/types").GetCatalogCategoriesAction | import("./catalog/types").GetCatalogProductsByIdsAction | import("./catalog/types").GetCatalogProductsAction | import("./catalog/types").GetSingleCatalogProductAction;
8
+ 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").GetMoreMockupsAction | import("./mockup-generation/types").AdjustMockupAction | import("./edm/types").InitializeEdmAction | import("./edm/types").SaveDesignAction | import("./edm/types").AddImageAction | import("./edm/types").NavigateStepAction | import("./product-publish/types").GetProductPublishAction | import("./product-publish/types").GetSavedProductsAction | import("./product-publish/types").DeleteProductsAction | import("./catalog/types").GetCatalogCategoriesAction | import("./catalog/types").GetCatalogProductsByIdsAction | import("./catalog/types").GetCatalogProductsAction | import("./catalog/types").GetSingleCatalogProductAction;
9
9
  export declare function isNotification(event: AnyEvent): event is import("..").NotificationEvent;
10
- 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("./product-publish/types").GetSavedProductsResult | import("./product-publish/types").DeleteProductsResult | import("./edm/types").SaveDesignResultEvent | import("./edm/types").AddImageResultEvent | import("./edm/types").SetStyleResultEvent | import("./edm/types").NavigateStepResultEvent | import("./mockup-generation/types").GetMockupsResultEvent | import("./mockup-generation/types").AdjustMockupResultEvent;
10
+ 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("./product-publish/types").GetSavedProductsResult | import("./product-publish/types").DeleteProductsResult | import("./edm/types").SaveDesignResultEvent | import("./edm/types").AddImageResultEvent | import("./edm/types").SetStyleResultEvent | import("./edm/types").NavigateStepResultEvent | import("./mockup-generation/types").GetMockupsResultEvent | import("./mockup-generation/types").GetMoreMockupsResultEvent | import("./mockup-generation/types").AdjustMockupResultEvent;
11
11
  export declare function isBroadcast(event: AnyEvent): event is import("./edm/types/event/broadcastEvent.types").OnDesignStatusUpdateBroadcast | import("./edm/types/event/broadcastEvent.types").OnPricingStatusUpdateBroadcast | import("./edm/types/event/broadcastEvent.types").OnFilePickerRequestBroadcast | import("./edm/types/event/broadcastEvent.types").OnStepStatusUpdateBroadcast | import("./edm/types/event/broadcastEvent.types").OnErrorUpdateBroadcast;
@@ -8,6 +8,7 @@ export declare const ALL_ACTION_EVENTS: {
8
8
  readonly GET_SAVED_PRODUCTS: "actionGetSavedProducts";
9
9
  readonly DELETE_PRODUCTS: "actionDeleteProducts";
10
10
  readonly GET_MOCKUPS: "actionGetMockups";
11
+ readonly GET_MORE_MOCKUPS: "actionGetMoreMockups";
11
12
  readonly ADJUST_MOCKUP: "actionAdjustMockup";
12
13
  readonly GET_CATALOG_PRODUCTS: "actionGetCatalogProducts";
13
14
  readonly GET_CATALOG_PRODUCTS_BY_IDS: "actionGetCatalogProductsByIds";
@@ -26,6 +27,7 @@ export declare const ALL_NOTIFICATION_EVENTS: {
26
27
  readonly GET_SAVED_PRODUCTS_FAILURE: "actionGetSavedProductsFailure";
27
28
  readonly DELETE_PRODUCTS_FAILURE: "actionDeleteProductsFailure";
28
29
  readonly GET_MOCKUPS_FAILURE: "notificationGetMockupsFailure";
30
+ readonly GET_MORE_MOCKUPS_FAILURE: "notificationGetMoreMockupsFailure";
29
31
  readonly ADJUST_MOCKUP_FAILURE: "actionAdjustMockupFailure";
30
32
  readonly GET_CATALOG_PRODUCTS_FAILURE: "actionGetCatalogProductsFailure";
31
33
  readonly GET_SINGLE_CATALOG_PRODUCT_FAILURE: "actionGetSingleCatalogProductFailure";
@@ -41,6 +43,7 @@ export declare const ALL_RESULT_EVENTS: {
41
43
  readonly GET_SAVED_PRODUCTS_RESULT: "resultGetSavedProducts";
42
44
  readonly DELETE_PRODUCTS_RESULT: "resultDeleteProducts";
43
45
  readonly GET_MOCKUPS_RESULT: "resultGetMockups";
46
+ readonly GET_MORE_MOCKUPS_RESULT: "resultGetMoreMockups";
44
47
  readonly ADJUST_MOCKUP_RESULT: "resultActionAdjustMockup";
45
48
  readonly GET_CATALOG_PRODUCTS_RESULT: "resultGetCatalogProducts";
46
49
  readonly GET_SINGLE_CATALOG_PRODUCT_RESULT: "resultGetSingleCatalogProduct";
@@ -67,6 +70,7 @@ export declare const ALL_EVENTS: {
67
70
  readonly GET_SAVED_PRODUCTS_RESULT: "resultGetSavedProducts";
68
71
  readonly DELETE_PRODUCTS_RESULT: "resultDeleteProducts";
69
72
  readonly GET_MOCKUPS_RESULT: "resultGetMockups";
73
+ readonly GET_MORE_MOCKUPS_RESULT: "resultGetMoreMockups";
70
74
  readonly ADJUST_MOCKUP_RESULT: "resultActionAdjustMockup";
71
75
  readonly GET_CATALOG_PRODUCTS_RESULT: "resultGetCatalogProducts";
72
76
  readonly GET_SINGLE_CATALOG_PRODUCT_RESULT: "resultGetSingleCatalogProduct";
@@ -80,6 +84,7 @@ export declare const ALL_EVENTS: {
80
84
  readonly GET_SAVED_PRODUCTS_FAILURE: "actionGetSavedProductsFailure";
81
85
  readonly DELETE_PRODUCTS_FAILURE: "actionDeleteProductsFailure";
82
86
  readonly GET_MOCKUPS_FAILURE: "notificationGetMockupsFailure";
87
+ readonly GET_MORE_MOCKUPS_FAILURE: "notificationGetMoreMockupsFailure";
83
88
  readonly ADJUST_MOCKUP_FAILURE: "actionAdjustMockupFailure";
84
89
  readonly GET_CATALOG_PRODUCTS_FAILURE: "actionGetCatalogProductsFailure";
85
90
  readonly GET_SINGLE_CATALOG_PRODUCT_FAILURE: "actionGetSingleCatalogProductFailure";
@@ -94,6 +99,7 @@ export declare const ALL_EVENTS: {
94
99
  readonly GET_SAVED_PRODUCTS: "actionGetSavedProducts";
95
100
  readonly DELETE_PRODUCTS: "actionDeleteProducts";
96
101
  readonly GET_MOCKUPS: "actionGetMockups";
102
+ readonly GET_MORE_MOCKUPS: "actionGetMoreMockups";
97
103
  readonly ADJUST_MOCKUP: "actionAdjustMockup";
98
104
  readonly GET_CATALOG_PRODUCTS: "actionGetCatalogProducts";
99
105
  readonly GET_CATALOG_PRODUCTS_BY_IDS: "actionGetCatalogProductsByIds";
@@ -1,20 +1,26 @@
1
1
  export declare const EVENTS_ACTION: {
2
2
  readonly GET_MOCKUPS: "actionGetMockups";
3
+ readonly GET_MORE_MOCKUPS: "actionGetMoreMockups";
3
4
  readonly ADJUST_MOCKUP: "actionAdjustMockup";
4
5
  };
5
6
  export declare const EVENTS_NOTIFICATION: {
6
7
  readonly GET_MOCKUPS_FAILURE: "notificationGetMockupsFailure";
8
+ readonly GET_MORE_MOCKUPS_FAILURE: "notificationGetMoreMockupsFailure";
7
9
  readonly ADJUST_MOCKUP_FAILURE: "actionAdjustMockupFailure";
8
10
  };
9
11
  export declare const EVENTS_RESULT: {
10
12
  readonly GET_MOCKUPS_RESULT: "resultGetMockups";
13
+ readonly GET_MORE_MOCKUPS_RESULT: "resultGetMoreMockups";
11
14
  readonly ADJUST_MOCKUP_RESULT: "resultActionAdjustMockup";
12
15
  };
13
16
  export declare const EVENTS: {
14
17
  readonly GET_MOCKUPS_RESULT: "resultGetMockups";
18
+ readonly GET_MORE_MOCKUPS_RESULT: "resultGetMoreMockups";
15
19
  readonly ADJUST_MOCKUP_RESULT: "resultActionAdjustMockup";
16
20
  readonly GET_MOCKUPS_FAILURE: "notificationGetMockupsFailure";
21
+ readonly GET_MORE_MOCKUPS_FAILURE: "notificationGetMoreMockupsFailure";
17
22
  readonly ADJUST_MOCKUP_FAILURE: "actionAdjustMockupFailure";
18
23
  readonly GET_MOCKUPS: "actionGetMockups";
24
+ readonly GET_MORE_MOCKUPS: "actionGetMoreMockups";
19
25
  readonly ADJUST_MOCKUP: "actionAdjustMockup";
20
26
  };
@@ -1,13 +1,16 @@
1
1
  export const EVENTS_ACTION = {
2
2
  GET_MOCKUPS: 'actionGetMockups',
3
+ GET_MORE_MOCKUPS: 'actionGetMoreMockups',
3
4
  ADJUST_MOCKUP: 'actionAdjustMockup',
4
5
  };
5
6
  export const EVENTS_NOTIFICATION = {
6
7
  GET_MOCKUPS_FAILURE: 'notificationGetMockupsFailure',
8
+ GET_MORE_MOCKUPS_FAILURE: 'notificationGetMoreMockupsFailure',
7
9
  ADJUST_MOCKUP_FAILURE: 'actionAdjustMockupFailure',
8
10
  };
9
11
  export const EVENTS_RESULT = {
10
12
  GET_MOCKUPS_RESULT: 'resultGetMockups',
13
+ GET_MORE_MOCKUPS_RESULT: 'resultGetMoreMockups',
11
14
  ADJUST_MOCKUP_RESULT: 'resultActionAdjustMockup',
12
15
  };
13
16
  export const EVENTS = {
@@ -1,9 +1,10 @@
1
1
  import { IMockupGenerationModule } from '../../types/module/module.types';
2
2
  import { BaseModule } from '../../modules/baseModule';
3
- import { AdjustMockupPayload, AdjustMockupResultPayload, GetMockupsPayload, GetMockupsResultPayload } from '../../modules/mockup-generation/types';
3
+ import { AdjustMockupPayload, AdjustMockupResultPayload, GetMockupsPayload, GetMockupsResultPayload, GetMoreMockupsResultPayload, GetMoreMockupsPayload } 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
  constructor();
7
7
  getMockups(data: GetMockupsPayload): Promise<import("../..").HandledResponse<GetMockupsResultPayload, Error>>;
8
+ getMoreMockups(data: GetMoreMockupsPayload): Promise<import("../..").HandledResponse<GetMoreMockupsResultPayload, Error>>;
8
9
  adjustMockup(data: AdjustMockupPayload): Promise<import("../..").HandledResponse<AdjustMockupResultPayload, Error>>;
9
10
  }
@@ -10,6 +10,10 @@ export class MockupGenerationModule extends BaseModule {
10
10
  const response = await this.sendRequest(EVENTS_ACTION.GET_MOCKUPS, data).catch((e) => e);
11
11
  return handleResponse(response, 'Failed to get mockups');
12
12
  }
13
+ async getMoreMockups(data) {
14
+ const response = await this.sendRequest(EVENTS_ACTION.GET_MORE_MOCKUPS, data).catch((e) => e);
15
+ return handleResponse(response, 'Failed to get more mockups');
16
+ }
13
17
  async adjustMockup(data) {
14
18
  const response = await this.sendRequest(EVENTS_ACTION.ADJUST_MOCKUP, data).catch((e) => e);
15
19
  return handleResponse(response, 'Failed to get mockups');
@@ -1,7 +1,8 @@
1
1
  import { BaseModuleService } from '../../modules/baseModuleService';
2
- import { AdjustMockupPayload, GetMockupsPayload } from '../../modules/mockup-generation/types';
2
+ import { AdjustMockupPayload, GetMockupsPayload, GetMoreMockupsPayload } 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
+ getMoreMockups(data: GetMoreMockupsPayload): Promise<import("../..").HandledResponse<import("../../modules/mockup-generation/types").GetMoreMockupsResultPayload, Error>>;
6
7
  adjustMockup(data: AdjustMockupPayload): Promise<import("../..").HandledResponse<import("../../modules/mockup-generation/types").AdjustMockupResultPayload, Error>>;
7
8
  }
@@ -8,6 +8,10 @@ export class MockupService extends BaseModuleService {
8
8
  const module = await this.getMockupGenerationModule();
9
9
  return await module.getMockups(data);
10
10
  }
11
+ async getMoreMockups(data) {
12
+ const module = await this.getMockupGenerationModule();
13
+ return await module.getMoreMockups(data);
14
+ }
11
15
  async adjustMockup(data) {
12
16
  const module = await this.getMockupGenerationModule();
13
17
  return await module.adjustMockup(data);
@@ -18,3 +18,17 @@ export interface MockupGenerationData {
18
18
  height: number;
19
19
  };
20
20
  }
21
+ export interface MockupItem {
22
+ styleId: number;
23
+ blob: Blob;
24
+ view: string;
25
+ }
26
+ export interface MoreMockupGenerationData {
27
+ color: string | null | undefined;
28
+ size: string | null;
29
+ variantId: number;
30
+ baseImageUrl: string | null;
31
+ bgColor: string;
32
+ mockups: MockupItem[];
33
+ productId: number;
34
+ }
@@ -1,6 +1,7 @@
1
1
  import { EVENTS_ACTION } from '../../../../modules/mockup-generation/events';
2
- import { AdjustMockupPayload, GetMockupsPayload } from './actionEventPayload.types';
2
+ import { AdjustMockupPayload, GetMockupsPayload, GetMoreMockupsPayload } from '../../../../modules/mockup-generation/types/event/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 GetMoreMockupsAction = BaseActionEvent<typeof EVENTS_ACTION.GET_MORE_MOCKUPS, GetMoreMockupsPayload>;
5
6
  export type AdjustMockupAction = BaseActionEvent<typeof EVENTS_ACTION.ADJUST_MOCKUP, AdjustMockupPayload>;
6
- export type ActionEvent = GetMockupsAction | AdjustMockupAction;
7
+ export type ActionEvent = GetMockupsAction | AdjustMockupAction | GetMoreMockupsAction;
@@ -3,28 +3,42 @@ export interface GetMockupsPayload {
3
3
  file: Blob;
4
4
  products: {
5
5
  productId: number;
6
- /** Prefetch as many variants as necessary, so that switching colors/sizes
6
+ /** Prefetch as many variants as necessary so that switching colors/sizes
7
7
  * will be faster */
8
8
  variantIds?: number[];
9
9
  /** If not provided, the first variant from each product will be used */
10
10
  selectedVariantId?: number;
11
11
  /** If not provided, the default product technique will be used */
12
12
  selectedTechnique?: string;
13
+ /** Will return the front view of a specified option group if set. To find
14
+ * available option groups, use the Printful API:
15
+ * https://api.printful.com/mockup-generator/printfiles/{productId} */
16
+ optionGroup?: string;
13
17
  }[];
14
- /** If set to true, request will finish faster, and allow you
15
- * to show preview image on which mockup will be generated on */
18
+ /** If set to true, the request will finish faster and allow you
19
+ * to show a preview image on which mockup will be generated on */
16
20
  shouldReturnBlankMockups?: true;
17
21
  /** Used to position design on a product */
18
22
  designOptions?: DesignOption[];
19
23
  }
20
- export interface DesignOption {
21
- productId: number;
22
- variantId: number;
24
+ export interface DesignPosition {
23
25
  top?: number;
24
26
  left?: number;
25
27
  rotation?: number;
26
28
  width?: number;
27
29
  height?: number;
28
30
  }
31
+ export interface DesignOption extends DesignPosition {
32
+ productId: number;
33
+ variantId: number;
34
+ }
35
+ export interface GetMoreMockupsPayload {
36
+ file: Blob;
37
+ productId: number;
38
+ variantId?: number;
39
+ selectedTechnique?: string;
40
+ designOption?: DesignPosition;
41
+ optionGroup?: string;
42
+ }
29
43
  export type AdjustMockupPayload = DesignOption;
30
- export type ActionEventPayload = GetMockupsPayload | AdjustMockupPayload;
44
+ export type ActionEventPayload = GetMockupsPayload | GetMoreMockupsPayload | AdjustMockupPayload;
@@ -1,6 +1,7 @@
1
1
  import type { EVENTS_RESULT } from '../../../../modules/mockup-generation/events';
2
- import type { AdjustMockupResultPayload, GetMockupsResultPayload } from './resultEventPayload.types';
2
+ import type { AdjustMockupResultPayload, GetMockupsResultPayload, GetMoreMockupsResultPayload } from '../../../../modules/mockup-generation/types/event/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 GetMoreMockupsResultEvent = BaseResultEvent<typeof EVENTS_RESULT.GET_MORE_MOCKUPS_RESULT, GetMoreMockupsResultPayload>;
5
6
  export type AdjustMockupResultEvent = BaseResultEvent<typeof EVENTS_RESULT.ADJUST_MOCKUP_RESULT, AdjustMockupResultPayload>;
6
- export type ResultEvent = GetMockupsResultEvent | AdjustMockupResultEvent;
7
+ export type ResultEvent = GetMockupsResultEvent | GetMoreMockupsResultEvent | AdjustMockupResultEvent;
@@ -1,8 +1,11 @@
1
- import type { MockupGenerationData } from '../../../../modules/mockup-generation/types/data.types';
1
+ import { MockupGenerationData, MoreMockupGenerationData } from '../../../../modules/mockup-generation/types/data.types';
2
2
  export interface GetMockupsResultPayload {
3
3
  mockups: MockupGenerationData[];
4
4
  }
5
+ export interface GetMoreMockupsResultPayload {
6
+ mockups: MoreMockupGenerationData;
7
+ }
5
8
  export interface AdjustMockupResultPayload {
6
9
  mockup: MockupGenerationData;
7
10
  }
8
- export type MockupGenerationResultPayload = GetMockupsResultPayload | AdjustMockupResultPayload;
11
+ export type MockupGenerationResultPayload = GetMockupsResultPayload | AdjustMockupResultPayload | GetMoreMockupsResultPayload;
@@ -1 +1 @@
1
- export declare const VERSION: "2.4.17";
1
+ export declare const VERSION: "2.4.19";
@@ -1,2 +1,2 @@
1
1
  // AUTO-GENERATED
2
- export const VERSION = '2.4.17';
2
+ export const VERSION = '2.4.19';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fyul/embed-sdk",
3
- "version": "2.4.17",
3
+ "version": "2.4.19",
4
4
  "description": "",
5
5
  "main": "./dist/cjs/index.js",
6
6
  "module": "./dist/esm/index.js",