Merge pull request #187 from AdobeDocs/barranca/cce-release-v4-dec24

Update to SDK v4.17.33 (December release)

api-refs-sidebar.json

@@ -833,6 +833,10 @@
                     "title": "ImageModuleFileTypes",
                     "path": "/v4/shared/src/types/Asset.types/type-aliases/ImageModuleFileTypes.md"
                   },
+                  {
+                    "title": "ProcessedImageDimensions",
+                    "path": "/v4/shared/src/types/Asset.types/type-aliases/ProcessedImageDimensions.md"
+                  },
                   {
                     "title": "UrlAsset",
                     "path": "/v4/shared/src/types/Asset.types/type-aliases/UrlAsset.md"

src/pages/guides/changelog/index.md

@@ -15,12 +15,16 @@ contributors:
 
 # Changelog
 
-## 2024-12-12
+## [4.17.33] 2024-12-16
 
 ### Enhancements
 
 Added a comprehensive [error code guide](../concepts/error-handling.md) for managing errors, ensuring the host application developers and end-users can navigate issues efficiently and effectively.
 
+### Added
+
+- [`CCEverywhere.appConfig.imageDimensions`](../../v4/shared/src/types/module/AppConfig.types/interfaces/TextToImageAppConfig.md#properties): in a `createImageFromText()` module, the aspect ratio with which assets are generated and exported can be passed as a parameter via `appConfig`.
+
 ## [4.16.11] - 2024-11-18
 
 ### Enhancements

src/pages/guides/troubleshooting/faq/index.md

@@ -76,4 +76,4 @@ The SDK follows a continous release model, with newer versions including bug fix
 
 V1 and V2 are deprecated and V3 will be deprecated in 2024.
 
-Please migrate to V4 as soon as possible: we've created a [Migration Guide](../concepts/migration_v3_v4.md) to help you with the transition.
+Please migrate to V4 as soon as possible: we've created a [Migration Guide](../../concepts/migration_v3_v4.md) to help you with the transition.

src/pages/v4/sdk/src/error/ErrorCodes/enumerations/SDKErrorCode.md

@@ -16,7 +16,8 @@
 | `NO_ACTIVE_WORKFLOW` | `"NO_ACTIVE_WORKFLOW"` |
 | `ACTION_LAUNCH_ERROR` | `"ACTION_LAUNCH_ERROR"` |
 | `REQUIRED_PROJECT_ID_OR_IMAGE_DATA_URL` | `"REQUIRED_PROJECT_ID_OR_IMAGE_DATA_URL"` |
-| `INVALID_IMAGE_DIMENSIONS` | `"INVALID_IMAGE_DIMENSIONS"` |
+| `INVALID_ASPECT_RATIO_VALUE` | `"INVALID_ASPECT_RATIO_VALUE"` |
+| `INVALID_SIZE_VALUE` | `"INVALID_SIZE_VALUE"` |
 | `INVALID_IMAGE_DATA_URL` | `"INVALID_IMAGE_DATA_URL"` |
 | `INVALID_VIDEO_DATA_URL` | `"INVALID_VIDEO_DATA_URL"` |
 | `INVALID_ASSET_TYPE_URL` | `"INVALID_ASSET_TYPE_URL"` |

src/pages/v4/sdk/src/error/ErrorCodes/variables/ErrorCode.md

@@ -78,10 +78,16 @@ ACTION_LAUNCH_ERROR: ACTION_LAUNCH_ERROR = 'ACTION_LAUNCH_ERROR';
 REQUIRED_PROJECT_ID_OR_IMAGE_DATA_URL: REQUIRED_PROJECT_ID_OR_IMAGE_DATA_URL = 'REQUIRED_PROJECT_ID_OR_IMAGE_DATA_URL';
 ```
 
-### INVALID\_IMAGE\_DIMENSIONS
+### INVALID\_ASPECT\_RATIO\_VALUE
 
 ```ts
-INVALID_IMAGE_DIMENSIONS: INVALID_IMAGE_DIMENSIONS = 'INVALID_IMAGE_DIMENSIONS';
+INVALID_ASPECT_RATIO_VALUE: INVALID_ASPECT_RATIO_VALUE = 'INVALID_ASPECT_RATIO_VALUE';
+```
+
+### INVALID\_SIZE\_VALUE
+
+```ts
+INVALID_SIZE_VALUE: INVALID_SIZE_VALUE = 'INVALID_SIZE_VALUE';
 ```
 
 ### INVALID\_IMAGE\_DATA\_URL

src/pages/v4/shared/src/error/ErrorData/interfaces/ErrorData.md

@@ -14,4 +14,5 @@
 | `message` | `string` |
 | `subError?` | `string` \| `number` \| `Error` |
 | `customData?` | `unknown` |
+| `debugId?` | `string` |
 | `stack?` | `string` |

src/pages/v4/shared/src/messenger/MessageData.types/enumerations/HostEventType.md

@@ -17,3 +17,5 @@
 | `ASSET_LOADED` | `"ASSET_LOADED"` |
 | `ALL_CONTENT_LOADED` | `"ALL_CONTENT_LOADED"` |
 | `DOCUMENT_LOADED_AND_WRITABLE` | `"DOCUMENT_LOADED_AND_WRITABLE"` |
+| `SET_TOU_STATE` | `"SET_TOU_STATE"` |
+| `CLEAR_TOU_STATE` | `"CLEAR_TOU_STATE"` |

src/pages/v4/shared/src/types/Asset.types/index.md

@@ -33,6 +33,7 @@
 | [Asset](type-aliases/Asset.md) | Asset interface used as an input data for all SDK workflows. |
 | [AspectRatio](type-aliases/AspectRatio.md) | - |
 | [ImageDimensions](type-aliases/ImageDimensions.md) | Represents the dimensions of an image. It takes the size of the image in pixels along with the aspect ratio. |
+| [ProcessedImageDimensions](type-aliases/ProcessedImageDimensions.md) | Represents the processed image dimensions. It includes the size of the image in pixels along with the aspect ratio. It would have computed the aspect ratio value if it was provided as a number in ImageDimensions by bucketing it into one of the predefined aspect ratios. |
 
 ### Variables
 

src/pages/v4/shared/src/types/Asset.types/type-aliases/ImageDimensions.md

@@ -9,15 +9,15 @@ It takes the size of the image in pixels along with the aspect ratio.
 
 ## Type declaration
 
-### size
+### size?
 
 ```ts
-size: PixelSize;
+optional size: PixelSize;
 ```
 
 The size of the image in pixels.
+If provided, it should conform to the exact aspectRatio value within a tolerance of 0.05.
 Maximum width and height values are as follows:
-
 - square: 2048x2048
 - portrait: 1792x2304
 - landscape: 2304x1792
@@ -26,12 +26,19 @@ Maximum width and height values are as follows:
 ### aspectRatio
 
 ```ts
-aspectRatio: AspectRatio;
+aspectRatio: AspectRatio | number;
 ```
 
 The aspect ratio of the image.
-The provided size should conform to the following aspect ratio values within a tolerance of 0.01:
-
+It can be either square, portrait, landscape, widescreen OR a number representing the aspect ratio value.
+If aspect ratio is provided as a number, it would be bucketed into one of the aspect ratios as below:
+- square: 0.9 - 1.1
+- portrait: 0.68 - 0.88
+- landscape: 1.18 - 1.38
+- widescreen: 1.65 - 1.85
+If the number does not fall within the above ranges, then an error will be thrown if the size is provided, else predefined aspect ratio will be ignored.
+
+Below are the exact aspect ratio values for each type:
 - square: 1
 - portrait: 0.78
 - landscape: 1.28

src/pages/v4/shared/src/types/Asset.types/type-aliases/ProcessedImageDimensions.md

@@ -0,0 +1,17 @@
+# Type Alias: ProcessedImageDimensions
+
+```ts
+type ProcessedImageDimensions: ImageDimensions & object;
+```
+
+Represents the processed image dimensions.
+It includes the size of the image in pixels along with the aspect ratio.
+It would have computed the aspect ratio value if it was provided as a number in ImageDimensions by bucketing it into one of the predefined aspect ratios.
+
+## Type declaration
+
+### aspectRatio
+
+```ts
+aspectRatio: AspectRatio;
+```

src/pages/v4/shared/src/types/ConfigManager.types/type-aliases/Config.md

@@ -90,6 +90,12 @@ ORIGINAL_PATHNAME: string;
 PLATFORM: string;
 ```
 
+### CLIENTS.CCX.QUERY\_PARAMS.KEYS.BUILD\_TAGS
+
+```ts
+BUILD_TAGS: string;
+```
+
 ### CLIENTS.CCX.EDITOR
 
 ```ts
@@ -744,6 +750,18 @@ ACROBAT_EXT: object;
 CLIENT_ID: string;
 ```
 
+### CLIENTS.ADOBE\_HOME
+
+```ts
+ADOBE_HOME: object;
+```
+
+### CLIENTS.ADOBE\_HOME.CLIENT\_ID
+
+```ts
+CLIENT_ID: string;
+```
+
 ### CLIENTS.TEST\_APP
 
 ```ts

src/pages/v4/shared/src/types/ExportConfig.types/enumerations/EditFurtherIntent.md

@@ -13,3 +13,5 @@
 | `CROP_IMAGE` | `"crop-image"` |
 | `APPLY_ADJUSTMENT` | `"apply-adjustment"` |
 | `GEN_FILL` | `"gen-fill"` |
+| `REMOVE_OBJECT` | `"remove-object"` |
+| `INSERT_OBJECT` | `"insert-object"` |

src/pages/v4/shared/src/types/FeatureFlags.types/type-aliases/FeatureFlags.md

@@ -3,3 +3,4 @@
 ```ts
 type FeatureFlags: Record<string, String | Number | Boolean>;
 ```
+

src/pages/v4/shared/src/types/HostInfo.types/enumerations/HostId.md

@@ -7,6 +7,7 @@
 | `OTHER` | `"Other"` |
 | `ACROBAT` | `"Acrobat"` |
 | `ACROBAT_EXT` | `"ACROBAT_EXT"` |
+| `ADOBE_HOME` | `"ADOBE_HOME"` |
 | `CCD` | `"CCD"` |
 | `CONTENT_CAL` | `"CONTENT_CAL"` |
 | `STOCK` | `"STOCK"` |

src/pages/v4/shared/src/types/index.md

@@ -206,6 +206,12 @@ Re-exports [ImageDimensions](Asset.types/type-aliases/ImageDimensions.md)
 
 ***
 
+### ProcessedImageDimensions
+
+Re-exports [ProcessedImageDimensions](Asset.types/type-aliases/ProcessedImageDimensions.md)
+
+***
+
 ### ValidateTokenError
 
 Re-exports [ValidateTokenError](Authentication.types/enumerations/ValidateTokenError.md)