@adobe/ccweb-add-on-sdk-types 1.6.1 → 1.8.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/ccweb-add-on-sdk-types",
-  "version": "1.6.1",
+  "version": "1.8.0",
   "author": "Adobe",
   "license": "MIT",
   "description": "Type definitions for Adobe Creative Cloud Web Add-on SDK.",
@@ -39,6 +39,7 @@
   },
   "dependencies": {
     "tslib": "2.6.2",
+    "@swc/helpers": "0.5.12",
     "gl-matrix": "3.3.0"
   },
   "devDependencies": {

package/ui/ui-sdk.d.ts

@@ -130,6 +130,10 @@ export declare enum AppEvent {
      * triggered when the locale is changed in the application.
      */
     localechange = "localechange",
+    /**
+     * triggered when the regional format is changed in the application.
+     */
+    formatchange = "formatchange",
     /**
      * triggered when drag is started on the currently dragged element.
      */
@@ -157,6 +161,7 @@ export declare type AppEventHandlerType<Event extends AppEventType> = (data: App
 declare interface AppEventsTypeMap {
     [AppEvent.themechange]: AppThemeChangeEventData;
     [AppEvent.localechange]: AppLocaleChangeEventData;
+    [AppEvent.formatchange]: AppFormatChangeEventData;
     [AppEvent.dragstart]: AppDragStartEventData;
     [AppEvent.dragend]: AppDragEndEventData;
 
@@ -166,6 +171,13 @@ declare interface AppEventsTypeMap {
 
 export declare type AppEventType = keyof AppEventsTypeMap & string;
 
+/**
+ * The payload data sent to the App FormatChange event handler.
+ */
+export declare interface AppFormatChangeEventData {
+    format: string;
+}
+
 /**
  * Interface that represents the underlying Application.
  */
@@ -212,9 +224,14 @@ declare interface ApplicationBase {
      * Enable drag to document on the given element
      * @param element - Element to enable drag on.
      * @param dragCallbacks - Interface to pass all drag realated callbacks (previewCallback & completionCallback).
+     * @param dragOptions - Interface to pass all drag related options.
      * @returns DisableDragToDocument - Callback to undo the changes made by enableDragToDocument
      */
-    enableDragToDocument(element: HTMLElement, dragCallbacks: DragCallbacks): DisableDragToDocument;
+    enableDragToDocument(
+        element: HTMLElement,
+        dragCallbacks: DragCallbacks,
+        dragOptions?: DragOptions
+    ): DisableDragToDocument;
     /**
      * @experimental - Experimental API
      * Register iframe with the add-on SDK.
@@ -236,6 +253,12 @@ declare interface ApplicationBase {
      * @returns if the user is premium user or not
      */
     startPremiumUpgradeIfFreeUser(): Promise<boolean>;
+    /**
+     * @experimental - Experimental API
+     * Get information regarding current platform.
+     * @returns the details regarding the current platform.
+     */
+    getCurrentPlatform(): Promise<CurrentPlatformPayload>;
 }
 
 /**
@@ -482,11 +505,37 @@ declare namespace Constants {
         MediaTabs,
         ElementsTabs,
         PanelActionType,
+        PlatformEnvironment,
+        DeviceClass,
+        PlatformType,
         AuthorizationStatus
     };
 }
 export { Constants };
 
+/**
+ * @experimental - Experimental API
+ * Interface for the current platform
+ */
+export declare interface CurrentPlatformPayload {
+    /**
+     * Purchases are NOT allowed in the {@link PlatformEnvironment.app} as of now
+     */
+    inAppPurchaseAllowed: boolean;
+    /**
+     * Denotes the platform type
+     */
+    platform: PlatformType;
+    /**
+     * Denotes the current environment
+     */
+    environment: PlatformEnvironment;
+    /**
+     * Denotes the device class
+     */
+    deviceClass: DeviceClass;
+}
+
 /**
  * Represents the current logged-in user accessing the host application
  */
@@ -544,6 +593,25 @@ export declare interface DevFlags {
     simulateFreeUser: boolean;
 }
 
+/**
+ * @experimental - Experimental API
+ * Denotes the device class
+ */
+export declare enum DeviceClass {
+    /**
+     * Mobile Device
+     */
+    mobile = "mobile",
+    /**
+     * Tablet Device
+     */
+    tablet = "tablet",
+    /**
+     * Desktop
+     */
+    desktop = "desktop"
+}
+
 /**
  * Represents the Modal Dialog that the add-on has presented to the user.
  */
@@ -685,6 +753,16 @@ export declare interface DragCompletionData {
     attributes?: MediaAttributes;
 }
 
+/**
+ * Interface to provide drag options which can be passed to enableDragToDocument to change the drag behavior.
+ */
+declare interface DragOptions {
+    /**
+     * Use preview size for the drag image instead of the element size
+     */
+    usePreviewSizeForDragImage?: boolean;
+}
+
 export declare type DragPreviewCallback = (element: HTMLElement) => URL;
 
 /**
@@ -1147,6 +1225,68 @@ export declare interface PdfRenditionOptions extends RenditionOptions {
     pageBoxes?: PdfPageBoxes;
 }
 
+/**
+ * @experimental - Experimental API
+ * Denotes the enum for current environment
+ */
+export declare enum PlatformEnvironment {
+    /**
+     * App Environment
+     */
+    app = "app",
+    /**
+     * Web Environment
+     */
+    web = "web"
+}
+
+/**
+ * @experimental - Experimental API
+ * Denotes the type of platform
+ */
+export declare enum PlatformType {
+    /**
+     * iOS
+     */
+    iOS = "ios",
+    /**
+     * iPad
+     */
+    iPadOS = "ipad",
+    /**
+     * Chrome OS
+     */
+    chromeOS = "chromeOS",
+    /**
+     * Android
+     */
+    android = "android",
+    /**
+     * Chrome Browser
+     */
+    chromeBrowser = "chromeBrowser",
+    /**
+     * Firefox Browser
+     */
+    fireforxBrowser = "firefoxBrowser",
+    /**
+     * Edge Browser
+     */
+    edgeBrowser = "edgeBrowser",
+    /**
+     * Samsung Browser
+     */
+    samsungBrowser = "samsumgBrowser",
+    /**
+     * Safari Browser
+     */
+    safariBrowser = "safariBrowser",
+    /**
+     * Unknown Platform
+     */
+    unknown = "unknown"
+}
+
 export declare interface PngRenditionOptions extends RenditionOptions {
     /**
      * PNG rendition format
@@ -1413,6 +1553,10 @@ export declare interface UI {
      * Current locale of the application
      */
     readonly locale: string;
+    /**
+     * Current regional format of the application
+     */
+    readonly format: string;
     /**
      * Supported locales of the application
      */

package/tsconfig.json

@@ -1,28 +0,0 @@
-{
-    "compilerOptions": {
-        "allowSyntheticDefaultImports": true,
-        "declaration": true,
-        "declarationMap": true,
-        "emitDecoratorMetadata": true,
-        "esModuleInterop": true,
-        "experimentalDecorators": true,
-        "forceConsistentCasingInFileNames": true,
-        "importHelpers": true,
-        "incremental": true,
-        "isolatedModules": true,
-        "module": "ESNext",
-        "moduleResolution": "node",
-        "noImplicitOverride": false,
-        "noUnusedLocals": true,
-        "outDir": "dist",
-        "preserveConstEnums": true,
-        "sourceMap": true,
-        "strict": true,
-        "target": "ESNext",
-        "useUnknownInCatchVariables": false
-    },
-    "exclude": ["node_modules"],
-    "ts-node": {
-        "files": true
-    }
-}