@mediaclip/designer-api 14.0.0-cd.26746 → 14.0.1

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 +35 -0
  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;
@@ -290,8 +323,10 @@ export interface IDesignerFunctions {
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;
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.0.1",
4
4
  "description": "Mediaclip Designer Javascript API Typings",
5
5
  "types": "designer-api.d.ts",
6
6
  "main": "index.js",