@mediaclip/designer-api 14.0.0-cd.26746 → 14.1.0-cd.28896

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 (2) hide show
  1. package/designer-api.d.ts +40 -4
  2. package/package.json +1 -1
package/designer-api.d.ts CHANGED
@@ -94,6 +94,7 @@ export class PhotoSelection extends RemoteObject {
94
94
  name:string;
95
95
  photos:string[];
96
96
  }
97
+
97
98
  export type StepNames =
98
99
  | 'PRODUCT_SELECTION'
99
100
  | 'EDITION'
@@ -273,6 +274,38 @@ export class PendingPhoto {
273
274
  getPreview?:(width:number, height:number) => Promise<Blob>;
274
275
  }
275
276
 
277
+ export type ModalSeverity = 'info' | 'error';
278
+
279
+ export interface IModalContext {
280
+ close:() => void;
281
+ updateTitle:(title:string | undefined) => void;
282
+ updateMessage:(msg:string | undefined) => void;
283
+ updateMessageHTML:(element:HTMLElement | undefined) => void;
284
+ updateSeverity:(severity:ModalSeverity) => void;
285
+ updatePrimaryButton:(buttonOptions:Partial<IModalButtonOptions> | undefined) => void;
286
+ updateSecondaryButton:(buttonOptions:Partial<IModalButtonOptions> | undefined) => void;
287
+ updateBlocking:(blocking:boolean) => void;
288
+ isOpen:() => boolean;
289
+ isDestroyed:() => boolean;
290
+ }
291
+
292
+ export interface IModalButtonOptions {
293
+ label:string;
294
+ callback:(context:IModalContext) => void;
295
+ disabled?:boolean;
296
+ }
297
+
298
+ export interface IModalOptions {
299
+ title?:string;
300
+ severity?:ModalSeverity;
301
+ message?:string;
302
+ messageHTML?:HTMLElement;
303
+ primaryButton?:IModalButtonOptions;
304
+ secondaryButton?:IModalButtonOptions;
305
+ blocking?:boolean;
306
+ onClose?:(context:IModalContext) => void;
307
+ }
308
+
276
309
  export interface IDesignerFunctions {
277
310
  addPendingPhotos(pendingPhotos:PendingPhoto[], skipAutofill:boolean):void;
278
311
  addPhotosToProject(photosToAdd:AutofillSource):void;
@@ -286,12 +319,14 @@ export interface IDesignerFunctions {
286
319
  getProjectPhotos():ImageSize[];
287
320
  hasEmptyElements(checkForPhotos:boolean, checkForTexts:boolean, includeOptionalElements:boolean):boolean;
288
321
  lock():void;
289
- navigateAlbums(cat:any[]):void;
322
+ navigateAlbums(albumIds:string[]):void;
290
323
  reloadAlbums():void;
291
324
  replacePhotoFilename(from:string, to:string):Promise<void>;
292
325
  retryFailedRequests():void;
326
+ removePhotoFromProject(filename:string):void;
293
327
  save():void;
294
328
  setCorrelationId(id:string | undefined):void;
329
+ showModal(modalOptions:IModalOptions):IModalContext;
295
330
  unlock():void;
296
331
  updateAuthorizationHeader(authorizationHeader:string):void;
297
332
  updateSessionId(id:string):void;
@@ -310,9 +345,9 @@ export interface IDesignerEvents {
310
345
  onGetPhotos:(deferred:Deferred<Photo[]>, filenames:string[]) => boolean;
311
346
  onGetPhotosSubset:(deferred:Deferred<Photo[]>, filenames:string[]) => boolean;
312
347
  onGetPhotoSources:(deferred:Deferred<PhotoSource[]>) => boolean;
348
+ onGetRecoveryId:() => string | null;
313
349
  onLoad:(deferred:Deferred<Project>, projectName:string) => boolean;
314
350
  onLoadComplete:() => Promise<void>;
315
- onGetRecoveryId:() => string;
316
351
  onReady:(deferred:Deferred<void>) => boolean;
317
352
  onRedirect:(url:string) => boolean;
318
353
  onReload:() => boolean;
@@ -330,7 +365,6 @@ export type ColorTheme =
330
365
  ;
331
366
 
332
367
  export interface IMediaclipConfig {
333
- allowedDomains?:string[];
334
368
  browserNotSupportedRedirectUrl?:string;
335
369
  clientId?:string;
336
370
  defaultCulture?:string;
@@ -380,6 +414,7 @@ export interface IMediaclipConfig {
380
414
  text?:boolean;
381
415
  allowAutofill?:boolean;
382
416
  allowAutoFontSize?:boolean;
417
+ allowChangeProjectName?:boolean;
383
418
  allowChangeYear?:boolean;
384
419
  allowFittingModeChangesInPrintModule?:boolean;
385
420
  alwaysShowMargins?:boolean;
@@ -388,9 +423,10 @@ export interface IMediaclipConfig {
388
423
  blockAddToCartWhenMissingTexts?:boolean;
389
424
  blockFittingModeChangesWhenNotCustomizable?:boolean;
390
425
  defaultPanel?:string;
391
- editionSteps?:string[];
426
+ editionSteps?:string;
392
427
  eyeDropper?:boolean;
393
428
  freeform?:boolean;
429
+ layoutSuggestionsCount?:number;
394
430
  plainColorBackgrounds?:boolean;
395
431
  replaceStylesWithThemes?:boolean;
396
432
  requirePreview?:boolean;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mediaclip/designer-api",
3
- "version": "14.0.0-cd.26746",
3
+ "version": "14.1.0-cd.28896",
4
4
  "description": "Mediaclip Designer Javascript API Typings",
5
5
  "types": "designer-api.d.ts",
6
6
  "main": "index.js",