@adobe/ccweb-add-on-sdk-types 1.22.0 → 1.24.0

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.
package/ui/ui-sdk.d.ts CHANGED
@@ -887,7 +887,7 @@ export declare type DisableDragToDocument = () => void;
887
887
  */
888
888
  declare interface Document_2 {
889
889
  /**
890
- * Add image/Ps/Ai files to the current page
890
+ * Add image/PSD/AI assets to the current page
891
891
  */
892
892
  addImage(blob: Blob, attributes?: MediaAttributes, importAddOnData?: ImportAddOnData): Promise<void>;
893
893
  /**
@@ -947,7 +947,7 @@ declare interface Document_2 {
947
947
  */
948
948
  runPrintQualityCheck(options: PrintQualityCheckOptions): void;
949
949
  }
950
- export type { Document_2 as Document };
950
+ export { Document_2 as Document };
951
951
 
952
952
  /**
953
953
  * The payload data sent when the document's export permission status changes in review and approval workflow.
@@ -1012,6 +1012,10 @@ export declare interface DragCompletionData {
1012
1012
  * Media info
1013
1013
  */
1014
1014
  attributes?: MediaAttributes & SourceMimeTypeInfo;
1015
+ /**
1016
+ * Add-on specific metadata to attach to the imported asset.
1017
+ */
1018
+ importAddOnData?: ImportAddOnData;
1015
1019
  }
1016
1020
 
1017
1021
  /**
@@ -1150,7 +1154,15 @@ export declare enum EntrypointType {
1150
1154
  /**
1151
1155
  * Contextual bulk create entrypoint type.
1152
1156
  */
1153
- CONTEXTUAL_BULK_CREATE = "contextual.bulk-create"
1157
+ CONTEXTUAL_BULK_CREATE = "contextual.bulk-create",
1158
+ /**
1159
+ * Import hub entrypoint type.
1160
+ */
1161
+ IMPORT_HUB = "import-hub",
1162
+ /**
1163
+ * Quick action entrypoint type.
1164
+ */
1165
+ QUICK_ACTION = "quick-action"
1154
1166
  }
1155
1167
 
1156
1168
  export declare interface Field {
@@ -1227,19 +1239,22 @@ export declare enum FrameRate {
1227
1239
  }
1228
1240
 
1229
1241
  /**
1230
- * Represents the add-on data for a node.
1242
+ * Represents add-on-specific data that can be attached to imported media assets (nodes).
1243
+ * This data provides a way for add-ons to store custom metadata with imported assets across multiple import APIs.
1231
1244
  * Note: This support is not present for PSD/AI assets.
1232
1245
  */
1233
1246
  export declare interface ImportAddOnData {
1234
1247
  /**
1235
- * The node add-on data which will persist on the image frame even if the image content is replaced with a
1236
- * different one. This data can be accessed later via the MediaContainerNode.addOnData API.
1248
+ * Node-specific add-on data that persists with the individual asset container.
1249
+ * This data remains attached to the container node even when the asset content is replaced.
1250
+ * This data can be accessed later via document sandbox MediaContainerNode.addOnData API.
1237
1251
  */
1238
1252
  nodeAddOnData?: Record<string, string>;
1239
1253
  /**
1240
- * The media add-on data which will reset if the image is replaced with a different one. All copies of the
1241
- * same image in the document will share the same mediaAddOnData. This data can be accessed later via the
1242
- * MediaRectangleNode.mediaAddOnData API.
1254
+ * Media-specific add-on data that is tied to the actual asset content.
1255
+ * This data is shared across all copies of the same asset throughout the document
1256
+ * and will be reset if the asset content is replaced with different media.
1257
+ * This data can be accessed later via document sandbox MediaRectangleNode.mediaAddOnData API.
1243
1258
  */
1244
1259
  mediaAddOnData?: Record<string, string>;
1245
1260
  }
@@ -1516,6 +1531,10 @@ export declare interface PageMetadata {
1516
1531
  * Whether the page contains animated content
1517
1532
  */
1518
1533
  hasAnimatedContent: boolean;
1534
+ /**
1535
+ * The page's background color in ARGB format (32-bit integer)
1536
+ */
1537
+ backgroundARGB?: number;
1519
1538
  /**
1520
1539
  * Whether the page is blank
1521
1540
  */