@adobe-commerce/aio-toolkit 1.0.16 → 1.0.17

package/CHANGELOG.md

@@ -5,6 +5,24 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.17] - 2026-02-25
+
+### ✨ Features
+
+- **feat(publish-event):** Add optional `eventId` parameter to `PublishEvent.execute()`
+  - Allows callers to supply custom event IDs for idempotency, correlation, or tracking
+  - Falls back to auto-generated UUID when not provided
+  - New signature: `execute(providerId, eventCode, payload, eventId?, subject?)`
+
+### ⚠️ Breaking Changes
+
+- **BREAKING(publish-event):** Parameter order changed for `PublishEvent.execute()`
+  - `subject` has moved from 4th to 5th position
+  - When passing subject without custom eventId, use: `execute(providerId, eventCode, payload, undefined, subject)`
+  - Previous call: `execute(providerId, eventCode, payload, subject)` → Update to: `execute(providerId, eventCode, payload, undefined, subject)`
+
+---
+
 ## [1.0.16] - 2026-02-23
 
 ### ✨ Features

package/README.md

@@ -171,12 +171,13 @@ const result = await publishEvent.execute(
     customerId: 'CUST-789',
     amount: 199.99,
     currency: 'USD'
-  }
+  },
+  'eventId'
 );
 
 console.log(`Event published: ${result.eventId}, Status: ${result.status}`);
 
-// Publish an event with subject
+// Publish an event with subject (eventId is optional; pass undefined to use auto-generated ID)
 const orderResult = await publishEvent.execute(
   'commerce-provider',
   'com.adobe.commerce.order.shipped',
@@ -186,6 +187,7 @@ const orderResult = await publishEvent.execute(
     carrier: 'UPS',
     estimatedDelivery: '2023-12-05T18:00:00Z'
   },
+  undefined,
   'orders/ORD-123456'
 );
 

package/dist/index.d.mts

@@ -220,7 +220,7 @@ declare class PublishEvent {
     private readonly accessToken;
     private readonly customLogger;
     constructor(imsOrgId: string, apiKey: string, accessToken: string, logger?: any);
-    execute(providerId: string, eventCode: string, payload: any, subject?: string): Promise<PublishEventResult>;
+    execute(providerId: string, eventCode: string, payload: any, eventId?: string, subject?: string): Promise<PublishEventResult>;
 }
 
 declare enum WebhookActionOperation {

package/dist/index.d.ts

@@ -220,7 +220,7 @@ declare class PublishEvent {
     private readonly accessToken;
     private readonly customLogger;
     constructor(imsOrgId: string, apiKey: string, accessToken: string, logger?: any);
-    execute(providerId: string, eventCode: string, payload: any, subject?: string): Promise<PublishEventResult>;
+    execute(providerId: string, eventCode: string, payload: any, eventId?: string, subject?: string): Promise<PublishEventResult>;
 }
 
 declare enum WebhookActionOperation {

package/dist/index.js

@@ -3034,12 +3034,13 @@ var _PublishEvent = class _PublishEvent {
    * @param providerId - The Adobe I/O Events provider ID
    * @param eventCode - The event type identifier (e.g., 'commerce.order.created')
    * @param payload - The event payload data
+   * @param eventId - Optional custom event ID; if not provided, a UUID will be generated
    * @param subject - Optional subject for the event
    * @returns Promise<PublishEventResult> - The publish result
    *
    * @throws Error when providerId or eventCode is invalid or publishing fails
    */
-  async execute(providerId, eventCode, payload, subject) {
+  async execute(providerId, eventCode, payload, eventId, subject) {
     try {
       if (!providerId?.trim()) {
         throw new Error("providerId is required and cannot be empty");
@@ -3051,7 +3052,7 @@ var _PublishEvent = class _PublishEvent {
         throw new Error("payload is required");
       }
       this.customLogger.info(`Publishing event to provider: ${providerId}`);
-      const eventId = (0, import_uuid.v4)();
+      eventId = eventId ?? (0, import_uuid.v4)();
       const cloudEvent = new import_cloudevents.CloudEvent({
         id: eventId,
         source: `urn:uuid:${providerId}`,