Skip to content

Commit

Permalink
Update to v4.19.22
Browse files Browse the repository at this point in the history
  • Loading branch information
undavide committed Jan 31, 2025
1 parent 9821871 commit 149da24
Show file tree
Hide file tree
Showing 14 changed files with 199 additions and 149 deletions.
14 changes: 13 additions & 1 deletion api-refs-sidebar.json
Original file line number Diff line number Diff line change
Expand Up @@ -787,6 +787,18 @@
{
"title": "interfaces",
"pages": [
{
"title": "AssetBase",
"path": "/v4/shared/src/types/Asset.types/interfaces/AssetBase.md"
},
{
"title": "Blob",
"path": "/v4/shared/src/types/Asset.types/interfaces/Blob.md"
},
{
"title": "DataTypeMap",
"path": "/v4/shared/src/types/Asset.types/interfaces/DataTypeMap.md"
},
{
"title": "OutputAsset",
"path": "/v4/shared/src/types/Asset.types/interfaces/OutputAsset.md"
Expand All @@ -800,7 +812,7 @@
"path": "/v4/shared/src/types/Asset.types/interfaces/Size.md"
}
],
"path": "/v4/shared/src/types/Asset.types/interfaces/OutputAsset.md"
"path": "/v4/shared/src/types/Asset.types/interfaces/AssetBase.md"
},
{
"title": "type-aliases",
Expand Down
17 changes: 16 additions & 1 deletion src/pages/guides/changelog/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,25 @@ title: Changelog
description: All notable changes are documented in this page.
contributors:
- https://github.com/nimithajalal
- https://github.com/undavide
---

# Changelog

## [4.19.22] 2025-01-31

### Enhancements

- Added a new [Embed SDK Developer Journey](../index.md#embed-sdk-developer-journey) map to help developers navigate the resources available at different stages of their integration.
- Added a new [Troubleshooting](../troubleshooting/express-unavailable-error.md) guide to help developers fix the "Adobe Express is Unavailable" error, also covering the "Missing Referrer Header" error and the proper use of wildcards for domain's allow-listing.
- Various small improvements and fixes across the documentation.

### Added

- [`CCEverywhere.ExportConfig.EditFurtherIntent`](../../v4/shared/src/types/ExportConfig.types/enumerations/EditFurtherIntent.md): Added two new intents in the Edit Image module, `INSERT_OBJECT` and `REMOVE_OBJECT`. Either can be preconfigured to run automatically when the module loads.
- Added coverage for the [Asset](../../v4/shared/src/types/Asset.types/index.md) type.
- Various performance improvements and bug fixes.

## [4.18.14] 2025-01-09

### Added
Expand All @@ -25,7 +40,7 @@ contributors:

### 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 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

Expand Down
19 changes: 0 additions & 19 deletions src/pages/v4/sdk/src/error/ErrorCodes/enumerations/SDKErrorCode.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,9 @@
| `SDK_NOT_INITIALIZED` | `"SDK_NOT_INITIALIZED"` |
| `WARMUP_FAILED` | `"WARMUP_FAILED"` |
| `WARMUP_CANCELLED` | `"WARMUP_CANCELLED"` |
| `WARMUP_NOT_SUPPORTED` | `"WARMUP_NOT_SUPPORTED"` |
| `INVALID_WORKFLOW` | `"INVALID_WORKFLOW"` |
| `WORKFLOW_ALREADY_IN_PROGRESS` | `"WORKFLOW_ALREADY_IN_PROGRESS"` |
| `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_ASPECT_RATIO_VALUE` | `"INVALID_ASPECT_RATIO_VALUE"` |
| `INVALID_SIZE_VALUE` | `"INVALID_SIZE_VALUE"` |
| `INVALID_IMAGE_DATA_URL` | `"INVALID_IMAGE_DATA_URL"` |
Expand All @@ -25,30 +22,14 @@
| `INVALID_ASSET_DATA_TYPE` | `"INVALID_ASSET_DATA_TYPE"` |
| `INVALID_PUBLISH_FILE_TYPE` | `"INVALID_PUBLISH_FILE_TYPE"` |
| `INVALID_DOWNLOAD_ALL_EXPORT_OPTION` | `"INVALID_DOWNLOAD_ALL_EXPORT_OPTION"` |
| `AUTHORIZATION_URL_NOT_RETRIEVED` | `"AUTHORIZATION_URL_NOT_RETRIEVED"` |
| `AUTHORIZATION_DETAILS_NOT_FOUND` | `"AUTHORIZATION_DETAILS_NOT_FOUND"` |
| `HTTP` | `"HTTP"` |
| `NO_INTERNET` | `"NO_INTERNET"` |
| `TARGET_LOAD_TIMED_OUT` | `"TARGET_LOAD_TIMED_OUT"` |
| `TARGET_LOAD_ERROR` | `"TARGET_LOAD_ERROR"` |
| `TARGET_LOAD_FAILED` | `"TARGET_LOAD_FAILED"` |
| `TARGET_LOAD_CANCELLED` | `"TARGET_LOAD_CANCELLED"` |
| `GENERIC_AUTH_ERROR` | `"GENERIC_AUTH_ERROR"` |
| `EXCHANGE_AUTH_CODE_ERROR` | `"EXCHANGE_AUTH_CODE_ERROR"` |
| `CONSENT_NOT_ACCEPTED` | `"CONSENT_NOT_ACCEPTED"` |
| `AUTH_CODE_NOT_FOUND` | `"AUTH_CODE_NOT_FOUND"` |
| `ACCESS_TOKEN_NOT_FOUND` | `"ACCESS_TOKEN_NOT_FOUND"` |
| `AUTH_PROVIDER_ERROR` | `"AUTH_PROVIDER_ERROR"` |
| `IMS_LIBRARY_NOT_READY` | `"IMS_LIBRARY_NOT_READY"` |
| `IMS_JUMP_FAILED` | `"IMS_JUMP_FAILED"` |
| `LOCAL_STORAGE_ERROR` | `"LOCAL_STORAGE_ERROR"` |
| `POPUP_CLOSED` | `"POPUP_CLOSED"` |
| `POPUP_BLOCKED` | `"POPUP_BLOCKED"` |
| `POPUP_ERROR` | `"POPUP_ERROR"` |
| `INVALID_ACCESS_TOKEN` | `"INVALID_ACCESS_TOKEN"` |
| `ANALYTICS_ERROR` | `"ANALYTICS_ERROR"` |
| `PERFORMANCE_LOGGING_ERROR` | `"PERFORMANCE_LOGGING_ERROR"` |
| `TEMPLATE_ERROR` | `"TEMPLATE_ERROR"` |
| `TEMPLATE_SEARCH_API_FAILED` | `"TEMPLATE_SEARCH_API_FAILED"` |
| `INVITATIONS_API_FAILED` | `"INVITATIONS_API_FAILED"` |
| `CDN_ACCESS_URL_API_FAILED` | `"CDN_ACCESS_URL_API_FAILED"` |
114 changes: 0 additions & 114 deletions src/pages/v4/sdk/src/error/ErrorCodes/variables/ErrorCode.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,18 +42,6 @@ WARMUP_FAILED: WARMUP_FAILED = 'WARMUP_FAILED';
WARMUP_CANCELLED: WARMUP_CANCELLED = 'WARMUP_CANCELLED';
```

### WARMUP\_NOT\_SUPPORTED

```ts
WARMUP_NOT_SUPPORTED: WARMUP_NOT_SUPPORTED = 'WARMUP_NOT_SUPPORTED';
```

### INVALID\_WORKFLOW

```ts
INVALID_WORKFLOW: INVALID_WORKFLOW = 'INVALID_WORKFLOW';
```

### WORKFLOW\_ALREADY\_IN\_PROGRESS

```ts
Expand All @@ -72,12 +60,6 @@ NO_ACTIVE_WORKFLOW: NO_ACTIVE_WORKFLOW = 'NO_ACTIVE_WORKFLOW';
ACTION_LAUNCH_ERROR: ACTION_LAUNCH_ERROR = 'ACTION_LAUNCH_ERROR';
```

### REQUIRED\_PROJECT\_ID\_OR\_IMAGE\_DATA\_URL

```ts
REQUIRED_PROJECT_ID_OR_IMAGE_DATA_URL: REQUIRED_PROJECT_ID_OR_IMAGE_DATA_URL = 'REQUIRED_PROJECT_ID_OR_IMAGE_DATA_URL';
```

### INVALID\_ASPECT\_RATIO\_VALUE

```ts
Expand Down Expand Up @@ -132,24 +114,12 @@ INVALID_PUBLISH_FILE_TYPE: INVALID_PUBLISH_FILE_TYPE = 'INVALID_PUBLISH_FILE_TYP
INVALID_DOWNLOAD_ALL_EXPORT_OPTION: INVALID_DOWNLOAD_ALL_EXPORT_OPTION = 'INVALID_DOWNLOAD_ALL_EXPORT_OPTION';
```

### AUTHORIZATION\_URL\_NOT\_RETRIEVED

```ts
AUTHORIZATION_URL_NOT_RETRIEVED: AUTHORIZATION_URL_NOT_RETRIEVED = 'AUTHORIZATION_URL_NOT_RETRIEVED';
```

### AUTHORIZATION\_DETAILS\_NOT\_FOUND

```ts
AUTHORIZATION_DETAILS_NOT_FOUND: AUTHORIZATION_DETAILS_NOT_FOUND = 'AUTHORIZATION_DETAILS_NOT_FOUND';
```

### HTTP

```ts
HTTP: HTTP = 'HTTP';
```

### NO\_INTERNET

```ts
Expand Down Expand Up @@ -180,84 +150,18 @@ TARGET_LOAD_FAILED: TARGET_LOAD_FAILED = 'TARGET_LOAD_FAILED';
TARGET_LOAD_CANCELLED: TARGET_LOAD_CANCELLED = 'TARGET_LOAD_CANCELLED';
```

### GENERIC\_AUTH\_ERROR

```ts
GENERIC_AUTH_ERROR: GENERIC_AUTH_ERROR = 'GENERIC_AUTH_ERROR';
```

### EXCHANGE\_AUTH\_CODE\_ERROR

```ts
EXCHANGE_AUTH_CODE_ERROR: EXCHANGE_AUTH_CODE_ERROR = 'EXCHANGE_AUTH_CODE_ERROR';
```

### CONSENT\_NOT\_ACCEPTED

```ts
CONSENT_NOT_ACCEPTED: CONSENT_NOT_ACCEPTED = 'CONSENT_NOT_ACCEPTED';
```

### AUTH\_CODE\_NOT\_FOUND

```ts
AUTH_CODE_NOT_FOUND: AUTH_CODE_NOT_FOUND = 'AUTH_CODE_NOT_FOUND';
```

### ACCESS\_TOKEN\_NOT\_FOUND

```ts
ACCESS_TOKEN_NOT_FOUND: ACCESS_TOKEN_NOT_FOUND = 'ACCESS_TOKEN_NOT_FOUND';
```

### AUTH\_PROVIDER\_ERROR

```ts
AUTH_PROVIDER_ERROR: AUTH_PROVIDER_ERROR = 'AUTH_PROVIDER_ERROR';
```

### IMS\_LIBRARY\_NOT\_READY

```ts
IMS_LIBRARY_NOT_READY: IMS_LIBRARY_NOT_READY = 'IMS_LIBRARY_NOT_READY';
```

### IMS\_JUMP\_FAILED

```ts
IMS_JUMP_FAILED: IMS_JUMP_FAILED = 'IMS_JUMP_FAILED';
```

### LOCAL\_STORAGE\_ERROR

```ts
LOCAL_STORAGE_ERROR: LOCAL_STORAGE_ERROR = 'LOCAL_STORAGE_ERROR';
```

### POPUP\_CLOSED

```ts
POPUP_CLOSED: POPUP_CLOSED = 'POPUP_CLOSED';
```

### POPUP\_BLOCKED

```ts
POPUP_BLOCKED: POPUP_BLOCKED = 'POPUP_BLOCKED';
```

### POPUP\_ERROR

```ts
POPUP_ERROR: POPUP_ERROR = 'POPUP_ERROR';
```

### INVALID\_ACCESS\_TOKEN

```ts
INVALID_ACCESS_TOKEN: INVALID_ACCESS_TOKEN = 'INVALID_ACCESS_TOKEN';
```

### ANALYTICS\_ERROR

```ts
Expand All @@ -270,30 +174,12 @@ ANALYTICS_ERROR: ANALYTICS_ERROR = 'ANALYTICS_ERROR';
PERFORMANCE_LOGGING_ERROR: PERFORMANCE_LOGGING_ERROR = 'PERFORMANCE_LOGGING_ERROR';
```

### TEMPLATE\_ERROR

```ts
TEMPLATE_ERROR: TEMPLATE_ERROR = 'TEMPLATE_ERROR';
```

### TEMPLATE\_SEARCH\_API\_FAILED

```ts
TEMPLATE_SEARCH_API_FAILED: TEMPLATE_SEARCH_API_FAILED = 'TEMPLATE_SEARCH_API_FAILED';
```

### INVITATIONS\_API\_FAILED

```ts
INVITATIONS_API_FAILED: INVITATIONS_API_FAILED = 'INVITATIONS_API_FAILED';
```

### CDN\_ACCESS\_URL\_API\_FAILED

```ts
CDN_ACCESS_URL_API_FAILED: CDN_ACCESS_URL_API_FAILED = 'CDN_ACCESS_URL_API_FAILED';
```

### INVALID\_PARAMETERS

```ts
Expand Down
3 changes: 3 additions & 0 deletions src/pages/v4/shared/src/types/Asset.types/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@

| Interface | Description |
| ------ | ------ |
| [Blob](interfaces/Blob.md) | Custom interface that represents a Blob object. Should be used instead of default Blob type. |
| [DataTypeMap](interfaces/DataTypeMap.md) | Represents a mapping of data types for assets. |
| [AssetBase](interfaces/AssetBase.md) | Base interface for all asset types. |
| [Size](interfaces/Size.md) | - |
| [PixelSize](interfaces/PixelSize.md) | - |
| [OutputAsset](interfaces/OutputAsset.md) | Information related to output asset. |
Expand Down
22 changes: 22 additions & 0 deletions src/pages/v4/shared/src/types/Asset.types/interfaces/AssetBase.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Interface: AssetBase<T\>

Base interface for all asset types.

## Extended by

- [`OutputAsset`](OutputAsset.md)

## Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* [`AssetDataType`](../enumerations/AssetDataType.md) |

## Properties

| Property | Type |
| ------ | ------ |
| `type` | [`AssetType`](../enumerations/AssetType.md) |
| `name?` | `string` |
| `dataType` | `T` |
| `data` | [`DataTypeMap`](DataTypeMap.md)\[`T`\] |
70 changes: 70 additions & 0 deletions src/pages/v4/shared/src/types/Asset.types/interfaces/Blob.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# Interface: Blob

Custom interface that represents a Blob object.
Should be used instead of default Blob type.

## Properties

| Property | Modifier | Type |
| ------ | ------ | ------ |
| `size` | `readonly` | `number` |
| `type` | `readonly` | `string` |

## Methods

### slice()

```ts
slice(
start?,
end?,
contentType?): Blob
```
#### Parameters
| Parameter | Type |
| ------ | ------ |
| `start`? | `number` |
| `end`? | `number` |
| `contentType`? | `string` |
#### Returns
[`Blob`](Blob.md)
***
### stream()
```ts
stream(): ReadableStream<any>
```
#### Returns
`ReadableStream`<`any`\>
***
### text()
```ts
text(): Promise<string>
```
#### Returns
`Promise`<`string`\>
***
### arrayBuffer()
```ts
arrayBuffer(): Promise<ArrayBuffer>
```
#### Returns
`Promise`<`ArrayBuffer`\>
Loading

0 comments on commit 149da24

Please sign in to comment.