@adobe/ccweb-add-on-sdk-types 1.5.0 → 1.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/ccweb-add-on-sdk-types",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "author": "Adobe",
   "license": "MIT",
   "description": "Type definitions for Adobe Creative Cloud Web Add-on SDK.",

package/sandbox/express-document-sdk.d.ts

@@ -170,7 +170,7 @@ export declare interface BitmapImage {
  * <InlineAlert slots="text" variant="warning"/>
  * *Do not depend on the literal numeric values of these constants*, as they may change. Always reference the enum identifiers in your code.
  *
- * Determines how a scenende is composited on top of the content rendered below it.
+ * Determines how a scenenode is composited on top of the content rendered below it.
  *
  * If a node is inside a container whose blend mode anything other than {@link passThrough}, then the node's blend mode only
  * interacts with other siblings within the same container. See documentation below for details.
@@ -235,7 +235,7 @@ export declare interface Color {
 /**
  * Represents a solid-color fill.
  *
- * The most convenient way to create a stroke is via `Editor.makeColorFill()`.
+ * The most convenient way to create a fill is via `Editor.makeColorFill()`.
  */
 export declare interface ColorFill extends Fill {
     /**

package/ui/ui-sdk.d.ts

@@ -215,7 +215,13 @@ declare interface ApplicationBase {
      * @returns DisableDragToDocument - Callback to undo the changes made by enableDragToDocument
      */
     enableDragToDocument(element: HTMLElement, dragCallbacks: DragCallbacks): DisableDragToDocument;
-
+    /**
+     * @experimental - Experimental API
+     * Register iframe with the add-on SDK.
+     * @param element - HTMLIframeElement to be registered.
+     * @returns UnregisterIframe - Callback to unregister iframe from the add-on SDK.
+     */
+    registerIframe(element: HTMLIFrameElement): UnregisterIframe;
     /**
      * Show a modal dialog
      * @param dialogOptions - dialog options such as title, description, etc.
@@ -246,6 +252,11 @@ export declare interface AppThemeChangeEventData {
     theme: UiTheme;
 }
 
+/**
+ * Asset collection Id type.
+ */
+export declare type AssetCollectionId = `urn:aaid:sc:VA6C2:${string}`;
+
 /**
  * Request parameters to authorize a user using OAuth 2.0 PKCE based authorization.
  */
@@ -467,6 +478,10 @@ declare namespace Constants {
         RuntimeType,
         BleedUnit,
         VideoResolution,
+        EditorPanel,
+        MediaTabs,
+        ElementsTabs,
+        PanelActionType,
         AuthorizationStatus
     };
 }
@@ -671,6 +686,74 @@ export declare interface DragCompletionData {
 
 export declare type DragPreviewCallback = (element: HTMLElement) => URL;
 
+/**
+ * Express editor panels.
+ */
+export declare enum EditorPanel {
+    /**
+     * Editor search panel
+     */
+    search = "search",
+    /**
+     * Editor your stuff panel
+     */
+    yourStuff = "yourStuff",
+    /**
+     * Editor templates panel
+     */
+    templates = "templates",
+    /**
+     * Editor media panel
+     */
+    media = "media",
+    /**
+     * Editor text panel
+     */
+    text = "text",
+    /**
+     * Editor elements panel
+     */
+    elements = "elements",
+    /**
+     * Editor grids panel
+     */
+    grids = "grids",
+    /**
+     * Editor brands panel
+     */
+    brands = "brands",
+    /**
+     * Editor addOns panel
+     */
+    addOns = "addOns"
+}
+
+/**
+ * Tabs in editor Elements panel.
+ */
+export declare enum ElementsTabs {
+    /**
+     * Design assets tab.
+     */
+    designAssets = "designAssets",
+    /**
+     * Backgrounds tab.
+     */
+    backgrounds = "backgrounds",
+    /**
+     * Shapes assets tab.
+     */
+    shapes = "shapes",
+    /**
+     * Icons tab.
+     */
+    stockIcons = "stockIcons",
+    /**
+     * Charts tab.
+     */
+    charts = "charts"
+}
+
 export declare interface Field {
     /**
      * Label
@@ -825,6 +908,24 @@ export declare interface MediaAttributes {
     title: string;
 }
 
+/**
+ * Tabs in editor media panel.
+ */
+export declare enum MediaTabs {
+    /**
+     * Video tab.
+     */
+    video = "video",
+    /**
+     * Audio tab.
+     */
+    audio = "audio",
+    /**
+     * Photos tab.
+     */
+    photos = "photos"
+}
+
 export declare interface Mp4RenditionOptions extends RenditionOptions {
     /**
      * mp4 rendition format
@@ -840,6 +941,24 @@ export declare interface Mp4RenditionOptions extends RenditionOptions {
     customResolution?: number;
 }
 
+/**
+ * Navigation action that can be performed on Editor panels.
+ */
+export declare interface NavigateAction extends PanelAction {
+    /**
+     * Navigate to collection action type.
+     */
+    type: PanelActionType.navigate;
+    /**
+     *
+     */
+    tab?: ElementsTabs | MediaTabs;
+    /**
+     * collectionId of the asset collection to navigate to.
+     */
+    collectionId?: AssetCollectionId;
+}
+
 /**
  * OAuth 2.0 middleware for handling user sign-in.
  */
@@ -925,6 +1044,30 @@ export declare interface PageRendition extends Rendition {
     metadata: PageMetadata;
 }
 
+/**
+ * Represents the action to be performed on opening an Editor panel.
+ */
+export declare interface PanelAction {
+    /**
+     * Type of action to be performed on the Editor panel {@link PanelActionType}.
+     */
+    type: PanelActionType;
+}
+
+/**
+ * Types of actions that can be performed on Editor panels.
+ */
+export declare enum PanelActionType {
+    /**
+     * Action type to perform search action on Editor panel.
+     */
+    search = "search",
+    /**
+     * Action type to perform navigation within Editor panel.
+     */
+    navigate = "navigate"
+}
+
 /**
  * Represents a PDF Page box
  */
@@ -1237,6 +1380,20 @@ export declare enum RuntimeType {
     documentSandbox = "documentSandbox"
 }
 
+/**
+ * Search Action that can be performed on Editor Panel.
+ */
+export declare interface SearchAction extends PanelAction {
+    /**
+     * Search action type.
+     */
+    type: PanelActionType.search;
+    /**
+     * Query used to perform search action.
+     */
+    searchString: string;
+}
+
 export declare type SimpleDialogOptions = AlertDialogOptions | InputDialogOptions;
 
 /**
@@ -1255,6 +1412,13 @@ export declare interface UI {
      * Supported locales of the application
      */
     readonly locales: string[];
+    /**
+     * @experimental - Experimental API
+     * Opens an Editor Panel
+     * @param panel - one of {@link EditorPanel}
+     * @param action - optional action to be performed on the panel {@link PanelAction}
+     */
+    openEditorPanel(panel: EditorPanel, action?: PanelAction): void;
 }
 
 declare type UiTheme = "light" | "dark" | "lightest" | "darkest";
@@ -1272,6 +1436,12 @@ declare type Unpromisify<P> = P extends Promise<infer T> ? T : P;
  */
 declare type UnproxyOrClone<T> = T extends RemoteObject<ProxyMarked> ? Local<T> : T;
 
+/**
+ * @experimental - Experimental API
+ * Callback to unregister iframe from the add-on SDK.
+ */
+declare type UnregisterIframe = () => void;
+
 /**
  * Types of dialog variants supported.
  */
@@ -1329,3 +1499,4 @@ export declare enum VideoResolution {
 }
 
 export {};
+