Skip to content

Commit f4533a2

Browse files
authored
Merge branch 'main' into broken_link
2 parents 6fb1e8b + c1220fa commit f4533a2

File tree

10 files changed

+110
-24
lines changed

10 files changed

+110
-24
lines changed

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"url": "https://github.com/AdobeDocs/commerce-extensibility"
77
},
88
"dependencies": {
9-
"@adobe/gatsby-theme-aio": "4.14.13",
9+
"@adobe/gatsby-theme-aio": "4.14.17",
1010
"gatsby": "4.22.0",
1111
"react": "^17.0.2",
1212
"react-dom": "^17.0.2"

src/pages/admin-ui-sdk/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,9 @@ The following sequence diagram illustrates the authentication process.
3333
## Code samples
3434

3535
The [Adobe Commerce Samples repository](https://github.com/adobe/adobe-commerce-samples/tree/main/admin-ui-sdk) contains samples for different extension points of the Adobe Commerce Admin UI SDK. Use these samples to gain insight on how the Admin SDK injects menus and pages into the Admin.
36+
37+
## Admin UI SDK and Adobe Extensions
38+
39+
Adobe App Builder supports [extensions](https://developer.adobe.com/app-builder/docs/guides/extensions/), which allow developers to integrate their applications with specific Adobe products, such as the Admin UI SDK. Extensions act as a bridge between Adobe products and the applications built using Adobe App Builder. As a result, these applications can be easily integrated and extended within Adobe's ecosystem.
40+
41+
App Builder projects support `application` and `extension` configurations within the `app.config.yaml` file. The Admin UI SDK supports both of these types as well. The SDK is not affected if you [migrate](https://developer.adobe.com/app-builder/docs/guides/extensions/extension_migration_guide/) an existing App Builder project that uses an `application` configuration to use an `extension` configuration.

src/pages/admin-ui-sdk/publish.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,13 @@ During the testing phase, an administrator of your enterprise organization perfo
2626

2727
## Update an already published application
2828

29-
To update an already published application, you must revoke it and go through the approval process again.
29+
To deploy code changes to an already published application, you can perform a force deploy:
30+
31+
```bash
32+
aio app deploy --force-deploy
33+
```
34+
35+
To update the credentials or services used by an already published application, you must revoke it and go through the approval process again.
3036

3137
1. Ask an enterprise organization administrator to revoke your published application in the [Adobe Exchange Manage panel](https://exchange.adobe.com/manage). Note that once revoked, your application will no longer be public.
3238

src/pages/events/api.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,3 +140,35 @@ curl -i -X PUT \
140140
}' \
141141
'<ADOBE_COMMERCE_URL>/rest/all/V1/eventing/updateConfiguration'
142142
```
143+
144+
## Get configured event provider information
145+
146+
The `GET /rest/<store_view_code>/V1/eventing/getEventProviders` endpoint returns information about the event provider configured for the Commerce instance.
147+
148+
**Headers:**
149+
150+
`Authorization: Bearer <administrator token>`
151+
152+
The administrator must be granted access to the `Magento_AdobeIoEventsClient::event_provider_list` resource.
153+
154+
**Example usage:**
155+
156+
The following cURL command retrieves information about the configured event provider:
157+
158+
```bash
159+
curl -H "Authorization:Bearer <AUTH_TOKEN>" \
160+
'<ADOBE_COMMERCE_URL>/rest/all/V1/eventing/getEventProviders' \
161+
```
162+
163+
**Example response:**
164+
165+
```json
166+
[
167+
{
168+
"provider_id": "ad667bc6-1678-49ff-99fc-215d71ebf82f",
169+
"instance_id": "my_instance",
170+
"label": "my_provider",
171+
"description": "Provides out-of-process extensibility for Adobe Commerce"
172+
}
173+
]
174+
```

src/pages/events/convert-field-values.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,8 @@ In the following example, the `TestConverterVisibility` converter class updates
4242
```php
4343
<?php
4444
/**
45-
* Copyright &copy; Magento, Inc. All rights reserved.
46-
* See COPYING.txt for license details.
45+
* Copyright [first year code created] Adobe
46+
* All rights reserved.
4747
*/
4848
declare(strict_types=1);
4949

src/pages/events/custom-event-fields.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,8 @@ In the following example, the `TestProcessorOrderStatus` class adds the `order_s
7474
```php
7575
<?php
7676
/**
77-
* Copyright &copy; Magento, Inc. All rights reserved.
78-
* See COPYING.txt for license details.
77+
* Copyright [first year code created] Adobe
78+
* All rights reserved.
7979
*/
8080
declare(strict_types=1);
8181

src/pages/events/release-notes.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,16 @@ These release notes describe the latest version of Adobe I/O Events for Adobe Co
1212

1313
See [Update Adobe I/O Events for Adobe Commerce](installation.md#update-adobe-io-events-for-adobe-commerce) for upgrade instructions.
1414

15+
## Version 1.10.0
16+
17+
### Release date
18+
19+
December 10, 2024
20+
21+
### Enhancements
22+
23+
* Added the `GET /rest/<store_view_code>/V1/eventing/getEventProviders` REST endpoint for retrieving information about the configured event provider. <!---CEXT-3913 -->
24+
1525
## Version 1.9.0
1626

1727
### Release date

src/pages/webhooks/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The resolution of a remote call also determines whether you should implement a w
2727

2828
Use these guidelines to develop your own webhooks:
2929

30-
1. Identify the Adobe Commerce event that triggers a webhook. Adobe Commerce merchants can browse the available events from the Admin by selecting **System** > Events > **Events** to display the Events list page.
30+
1. Identify the Adobe Commerce event that triggers a webhook. Adobe Commerce merchants can browse the available events from the Admin by selecting **System** > Events > **Events List** to display the Events list page.
3131

3232
1. Understand the default payload of the corresponding webhook by running the [`bin/magento webhooks:info` command](commands.md#display-the-payload-of-a-webhook).
3333

src/pages/webhooks/signature-verification.md

Lines changed: 35 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,27 @@ To verify the signature in the App Builder action, set the `raw-http` annotation
8888
raw-http: true
8989
```
9090
91+
Store the public key in the `PUBLIC_KEY` parameter in the `.env` file using the same format as provided in the Adobe Commerce Admin:
92+
93+
```env
94+
# Other secrets and configuration
95+
# ...............................
96+
97+
PUBLIC_KEY="-----BEGIN PUBLIC KEY-----
98+
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAtglXYVz5pVn3HDluGG5T
99+
t9coO5NKSWjx3xCDMHVa3CEqVM76PKg8UJH9fQOA57xoNv7Llc916pF0UswtudQh
100+
Fyg+WQCFFadqGZOyL2nUKI9xWBiUi4dN8+9yMd3TE1fszVUBnk/XdLKNDQn4O6ic
101+
doQZi5arrjNjInkimtcT2jPXs34p9G9P5CvCubPUmbGsWDgwo5an9LEX/nJfnCdZ
102+
R10XPkRWzEM7o1OGzf7CYo06Xl+msGVM02Er265PsMAWB11cWwKmyg6dLPa8q+Qh
103+
KNXZiEMvdVusV8aA6EkCZYFdWSBXv+jltn6NnY5qvYcuQ3SujQ9xKEANjeMWcW90
104+
PwIDAQAB
105+
-----END PUBLIC KEY-----"
106+
```
107+
108+
**Note:** Do not commit the `.env` file to version control.
109+
110+
[App Builder Configuration Files](https://developer.adobe.com/app-builder/docs/guides/configuration/#env) describes `.env` file usage in detail.
111+
91112
The following code example below shows how the signature can be verified in the App Builder action:
92113

93114
```javascript
@@ -109,9 +130,20 @@ async function main (params) {
109130
if (isSignatureValid) {
110131
logger.info('The signature is valid.');
111132
// Here will be performed real action logic
112-
operations.push({
113-
op: 'success'
114-
});
133+
// payload is base64 encoded, so we need to decode it before using
134+
const payload = JSON.parse(atob(params.__ow_body))
135+
136+
// a simple validation if the provided postcode from Commerce webhook is less than 50000
137+
if (payload.address.postcode > 50000) {
138+
operations.push({
139+
op: 'exception',
140+
message: 'The postcode is not allowed. Provided postcode: ' + payload.address.postcode
141+
});
142+
} else {
143+
operations.push({
144+
op: 'success'
145+
});
146+
}
115147
} else {
116148
logger.info('The signature is invalid.');
117149
operations.push({

yarn.lock

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ __metadata:
3333
languageName: node
3434
linkType: hard
3535

36-
"@adobe/gatsby-theme-aio@npm:4.14.13":
37-
version: 4.14.13
38-
resolution: "@adobe/gatsby-theme-aio@npm:4.14.13"
36+
"@adobe/gatsby-theme-aio@npm:4.14.17":
37+
version: 4.14.17
38+
resolution: "@adobe/gatsby-theme-aio@npm:4.14.17"
3939
dependencies:
4040
"@adobe/focus-ring-polyfill": ^0.1.5
4141
"@adobe/gatsby-source-github-file-contributors": ^0.3.1
@@ -131,7 +131,7 @@ __metadata:
131131
gatsby: ^4.22.0
132132
react: ^17.0.2
133133
react-dom: ^17.0.2
134-
checksum: 00ce55db9ec96c66f31a0b83298fbccf40c8a28355c3effcb3525892fcbb5c785d5b18de38e31d8233887e32230178b408d4136f070ba256bfb473812ee53e90
134+
checksum: 929ed9cc32b048ec243dbcd75be3ee822294946e336600bf57b67490632fcd0a0e375e4683a2980eb756b80ee023d5e9605dd91a6a6ebc910d6dac08530aee13
135135
languageName: node
136136
linkType: hard
137137

@@ -7337,7 +7337,7 @@ __metadata:
73377337
version: 0.0.0-use.local
73387338
resolution: "commerce-extensibility@workspace:."
73397339
dependencies:
7340-
"@adobe/gatsby-theme-aio": 4.14.13
7340+
"@adobe/gatsby-theme-aio": 4.14.17
73417341
gatsby: 4.22.0
73427342
react: ^17.0.2
73437343
react-dom: ^17.0.2
@@ -7695,15 +7695,15 @@ __metadata:
76957695
linkType: hard
76967696

76977697
"cross-spawn@npm:^6.0.0, cross-spawn@npm:^6.0.5":
7698-
version: 6.0.5
7699-
resolution: "cross-spawn@npm:6.0.5"
7698+
version: 6.0.6
7699+
resolution: "cross-spawn@npm:6.0.6"
77007700
dependencies:
77017701
nice-try: ^1.0.4
77027702
path-key: ^2.0.1
77037703
semver: ^5.5.0
77047704
shebang-command: ^1.2.0
77057705
which: ^1.2.9
7706-
checksum: f893bb0d96cd3d5751d04e67145bdddf25f99449531a72e82dcbbd42796bbc8268c1076c6b3ea51d4d455839902804b94bc45dfb37ecbb32ea8e54a6741c3ab9
7706+
checksum: a6e2e5b04a0e0f806c1df45f92cd079b65f95fbe5a7650ee1ab60318c33a6c156a8a2f8b6898f57764f7363ec599a0625e9855dfa78d52d2d73dbd32eb11c25e
77077707
languageName: node
77087708
linkType: hard
77097709

@@ -8764,8 +8764,8 @@ __metadata:
87648764
linkType: hard
87658765

87668766
"elliptic@npm:^6.5.3, elliptic@npm:^6.5.5":
8767-
version: 6.5.7
8768-
resolution: "elliptic@npm:6.5.7"
8767+
version: 6.6.0
8768+
resolution: "elliptic@npm:6.6.0"
87698769
dependencies:
87708770
bn.js: ^4.11.9
87718771
brorand: ^1.1.0
@@ -8774,7 +8774,7 @@ __metadata:
87748774
inherits: ^2.0.4
87758775
minimalistic-assert: ^1.0.1
87768776
minimalistic-crypto-utils: ^1.0.1
8777-
checksum: af0ffddffdbc2fea4eeec74388cd73e62ed5a0eac6711568fb28071566319785df529c968b0bf1250ba4bc628e074b2d64c54a633e034aa6f0c6b152ceb49ab8
8777+
checksum: e912349b883e694bfe65005214237a470c9a098a6ba36fd24396d0ab07feb399920c0738aeed1aed6cf5dca9c64fd479e212faed3a75c9d81453671ef0de5157
87788778
languageName: node
87798779
linkType: hard
87808780

@@ -15352,11 +15352,11 @@ __metadata:
1535215352
linkType: hard
1535315353

1535415354
"nanoid@npm:^3.3.4":
15355-
version: 3.3.4
15356-
resolution: "nanoid@npm:3.3.4"
15355+
version: 3.3.8
15356+
resolution: "nanoid@npm:3.3.8"
1535715357
bin:
1535815358
nanoid: bin/nanoid.cjs
15359-
checksum: 2fddd6dee994b7676f008d3ffa4ab16035a754f4bb586c61df5a22cf8c8c94017aadd360368f47d653829e0569a92b129979152ff97af23a558331e47e37cd9c
15359+
checksum: dfe0adbc0c77e9655b550c333075f51bb28cfc7568afbf3237249904f9c86c9aaaed1f113f0fddddba75673ee31c758c30c43d4414f014a52a7a626efc5958c9
1536015360
languageName: node
1536115361
linkType: hard
1536215362

0 commit comments

Comments
 (0)