@adobe-commerce/aio-toolkit 1.0.10 → 1.0.11

package/CHANGELOG.md

@@ -5,35 +5,44 @@ 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.11] - 2026-01-04
+
+### 🐛 Bug Fixes
+
+- **fix(telemetry):** Revert lazy-loading pattern from v1.0.10 that caused missing logs in New Relic
+  - Lazy-loaded logger proxy was causing race conditions where early logs used fallback Core.Logger
+  - Logs (`-started`, `-headers`, `-body`) were not being sent to OpenTelemetry/New Relic
+  - Only late logs (like `-completed`) appeared because telemetry logger loaded after initial execution
+  - Reverted to synchronous imports for `@adobe/aio-lib-telemetry` and `NewRelicTelemetry`
+  - Ensures telemetry logger is immediately available and properly connected to trace context
+
+- **fix(telemetry):** Add automatic postinstall script to fix @adobe/aio-lib-telemetry exports bug
+  - **Problem**: `@adobe/aio-lib-telemetry@1.1.2` has incorrect exports configuration causing `ERR_PACKAGE_PATH_NOT_EXPORTED` error
+  - **Root Cause**: Package uses `"import"` instead of `"default"` in both import and require conditions
+  - **Solution**: Custom postinstall script (`scripts/postinstall.js`) automatically patches the telemetry package.json
+  - **Impact**: Zero configuration required by client projects - patch applies automatically during npm install
+  - **Compatibility**: Works with both CommonJS (require) and ESM (import) in TypeScript and JavaScript projects
+  - Added `@adobe/aio-lib-telemetry`, `@adobe/aio-lib-ims` to tsup external dependencies to prevent bundling
+  - Postinstall script runs automatically when toolkit is installed as a dependency
+  - Gracefully handles cases where telemetry package is not present
+  - No breaking changes - completely transparent to end users
+
+### 📝 Technical Details
+
+- Reverted changes from release v1.0.10 (commit d8229f7)
+- Restored synchronous telemetry initialization pattern from v1.0.9
+- All telemetry-related imports are now synchronous to prevent race conditions
+- Added `scripts/postinstall.js` to automatically fix third-party package exports bug
+- Updated `tsup.config.ts` to externalize Adobe SDK packages instead of bundling
+- Postinstall script detects and patches telemetry package in client project's node_modules
+
 ## [1.0.10] - 2026-01-01
 
 ### 🐛 Bug Fixes
 
-- **Telemetry** - Fixed `ERR_PACKAGE_PATH_NOT_EXPORTED` error when requiring the package
-  - Root cause: `@adobe/aio-lib-telemetry@1.1.2` has broken CommonJS exports in its package.json
-  - Solution: Implemented lazy-loading proxy pattern for OpenTelemetry logger
-  - `getLogger` is now dynamically imported only when `ENABLE_TELEMETRY=true`
-  - Maintains synchronous API with immediate logger availability
-  - Graceful fallback to `Core.Logger` if telemetry loading fails
-  - **Impact:** Zero breaking changes - existing client code works without modification
-  - **Benefits:** 
-    - Full OpenTelemetry integration preserved when telemetry is enabled
-    - Package size reduced by 92% (3.83 MB → 288 KB)
-    - No more import errors from broken dependency exports
-
-### 🔧 Technical Changes
-
-- **src/framework/telemetry/index.ts** - Implemented lazy-loading proxy pattern for `getLogger`
-- **src/framework/telemetry/types.ts** - Added local `EntrypointInstrumentationConfig` type definition
-- **src/commerce/adobe-auth/index.ts** - Changed to namespace import for ESM/CommonJS compatibility
-- **tsconfig.json** - Added `"module": "ES2020"` to support dynamic imports
-- **tsup.config.ts** - Configured to keep all dependencies external (not bundled)
-
-### ✅ Quality Assurance
-
-- Added 8 comprehensive test cases for lazy-loading telemetry behavior
-- Maintained 100% test coverage (1902 tests passing)
-- All validation checks passing (linting, formatting, type safety)
+- **fix(telemetry):** Resolve ERR_PACKAGE_PATH_NOT_EXPORTED error with lazy-loading pattern
+  - **Note:** This version introduced a regression with missing logs in New Relic
+  - **Recommendation:** Skip this version and use v1.0.11 instead
 
 ## [1.0.9] - 2025-12-23
 

package/dist/index.d.mts

@@ -1,4 +1,5 @@
 import openwhisk, { Dict, Activation } from 'openwhisk';
+import { EntrypointInstrumentationConfig } from '@adobe/aio-lib-telemetry';
 import { LogRecordProcessor } from '@opentelemetry/sdk-logs';
 import { SdkLogRecord } from '@adobe/aio-lib-telemetry/otel';
 import { Response } from 'node-fetch';
@@ -276,7 +277,6 @@ declare class RuntimeApiGatewayService {
     delete(endpoint: string, additionalHeaders?: Record<string, string>): Promise<any>;
 }
 
-type EntrypointInstrumentationConfig = any;
 interface BaseTelemetryValidator {
     isConfigured(params: Record<string, unknown>): boolean;
     validateConfiguration(params: Record<string, unknown>): void;
@@ -289,7 +289,6 @@ interface BaseTelemetry {
 
 declare class Telemetry {
     static createLogger(name: string, params: Record<string, unknown>): any;
-    private static wrapLogger;
     static formatError(error: unknown): Record<string, unknown>;
     static initialize(action: (params: Record<string, unknown>) => any): (params: Record<string, unknown>) => any;
 }
@@ -956,4 +955,4 @@ declare class AdminUiSdk {
     getRegistration(): AdminUiSdkRegistration;
 }
 
-export { AdminUiSdk, type AdminUiSdkRegistration, AdobeAuth, AdobeCommerceClient, type AdobeIMSConfig, type BaseTelemetry, type BaseTelemetryValidator, BasicAuthConnection, BearerToken, type BearerTokenInfo, type CommerceEvent, type CommerceEventConfig, type CommerceEventField, type Connection, type CreateEventResult, CreateEvents, type CreateProviderParams, type CreateProviderResult, type CreateRegistrationResult, CreateRegistrations, type EntrypointInstrumentationConfig, type ErrorResponse, EventConsumerAction, type EventData, type EventMetadata, type EventMetadataInputModel, type EventMetadataListResponse, EventMetadataManager, type ExtendedRequestError, type FileMetadata, type FileRecord, FileRepository, GenerateBasicAuthToken, type GetProviderQueryParams, type GetRegistrationQueryParams, GraphQlAction, type HALLink, type Headers, HttpMethod, HttpStatus, IOEventsApiError, type IOEventsError, ImsConnection, ImsToken, type ImsTokenResult, InfiniteLoopBreaker, type InfiniteLoopData, IoEventsGlobals, JsonMessageProcessor, type ListProvidersQueryParams, type ListRegistrationQueryParams, type MenuItem, Oauth1aConnection, OnboardCommerce, type OnboardCommerceConfig, type OnboardCommerceResult, OnboardEvents, type OnboardEventsInput, type OnboardEventsResponse, OnboardEvents as OnboardIOEvents, Openwhisk, OpenwhiskAction, type Page, Parameters, type Provider, type ProviderInputModel, ProviderManager, PublishEvent, type PublishEventResult, type Registration, type RegistrationCreateModel, type RegistrationListResponse, RegistrationManager, RestClient, RuntimeAction, RuntimeActionResponse, type RuntimeActionResponseType, RuntimeApiGatewayService, ShippingCarrier, type ShippingCarrierData, ShippingCarrierMethod, type ShippingCarrierMethodAdditionalData, type ShippingCarrierMethodData, ShippingCarrierResponse, SignatureVerification, SuccessChecker, type SuccessResponse, Telemetry, TelemetryInputError, type TokenResult, Validator, WebhookAction, type WebhookActionAddResponse, type WebhookActionExceptionResponse, WebhookActionOperation, type WebhookActionRemoveResponse, type WebhookActionReplaceResponse, WebhookActionResponse, type WebhookActionResponseType, type WebhookActionSuccessResponse, type WorkspaceConfig };
+export { AdminUiSdk, type AdminUiSdkRegistration, AdobeAuth, AdobeCommerceClient, type AdobeIMSConfig, type BaseTelemetry, type BaseTelemetryValidator, BasicAuthConnection, BearerToken, type BearerTokenInfo, type CommerceEvent, type CommerceEventConfig, type CommerceEventField, type Connection, type CreateEventResult, CreateEvents, type CreateProviderParams, type CreateProviderResult, type CreateRegistrationResult, CreateRegistrations, type ErrorResponse, EventConsumerAction, type EventData, type EventMetadata, type EventMetadataInputModel, type EventMetadataListResponse, EventMetadataManager, type ExtendedRequestError, type FileMetadata, type FileRecord, FileRepository, GenerateBasicAuthToken, type GetProviderQueryParams, type GetRegistrationQueryParams, GraphQlAction, type HALLink, type Headers, HttpMethod, HttpStatus, IOEventsApiError, type IOEventsError, ImsConnection, ImsToken, type ImsTokenResult, InfiniteLoopBreaker, type InfiniteLoopData, IoEventsGlobals, JsonMessageProcessor, type ListProvidersQueryParams, type ListRegistrationQueryParams, type MenuItem, Oauth1aConnection, OnboardCommerce, type OnboardCommerceConfig, type OnboardCommerceResult, OnboardEvents, type OnboardEventsInput, type OnboardEventsResponse, OnboardEvents as OnboardIOEvents, Openwhisk, OpenwhiskAction, type Page, Parameters, type Provider, type ProviderInputModel, ProviderManager, PublishEvent, type PublishEventResult, type Registration, type RegistrationCreateModel, type RegistrationListResponse, RegistrationManager, RestClient, RuntimeAction, RuntimeActionResponse, type RuntimeActionResponseType, RuntimeApiGatewayService, ShippingCarrier, type ShippingCarrierData, ShippingCarrierMethod, type ShippingCarrierMethodAdditionalData, type ShippingCarrierMethodData, ShippingCarrierResponse, SignatureVerification, SuccessChecker, type SuccessResponse, Telemetry, TelemetryInputError, type TokenResult, Validator, WebhookAction, type WebhookActionAddResponse, type WebhookActionExceptionResponse, WebhookActionOperation, type WebhookActionRemoveResponse, type WebhookActionReplaceResponse, WebhookActionResponse, type WebhookActionResponseType, type WebhookActionSuccessResponse, type WorkspaceConfig };

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import openwhisk, { Dict, Activation } from 'openwhisk';
+import { EntrypointInstrumentationConfig } from '@adobe/aio-lib-telemetry';
 import { LogRecordProcessor } from '@opentelemetry/sdk-logs';
 import { SdkLogRecord } from '@adobe/aio-lib-telemetry/otel';
 import { Response } from 'node-fetch';
@@ -276,7 +277,6 @@ declare class RuntimeApiGatewayService {
     delete(endpoint: string, additionalHeaders?: Record<string, string>): Promise<any>;
 }
 
-type EntrypointInstrumentationConfig = any;
 interface BaseTelemetryValidator {
     isConfigured(params: Record<string, unknown>): boolean;
     validateConfiguration(params: Record<string, unknown>): void;
@@ -289,7 +289,6 @@ interface BaseTelemetry {
 
 declare class Telemetry {
     static createLogger(name: string, params: Record<string, unknown>): any;
-    private static wrapLogger;
     static formatError(error: unknown): Record<string, unknown>;
     static initialize(action: (params: Record<string, unknown>) => any): (params: Record<string, unknown>) => any;
 }
@@ -956,4 +955,4 @@ declare class AdminUiSdk {
     getRegistration(): AdminUiSdkRegistration;
 }
 
-export { AdminUiSdk, type AdminUiSdkRegistration, AdobeAuth, AdobeCommerceClient, type AdobeIMSConfig, type BaseTelemetry, type BaseTelemetryValidator, BasicAuthConnection, BearerToken, type BearerTokenInfo, type CommerceEvent, type CommerceEventConfig, type CommerceEventField, type Connection, type CreateEventResult, CreateEvents, type CreateProviderParams, type CreateProviderResult, type CreateRegistrationResult, CreateRegistrations, type EntrypointInstrumentationConfig, type ErrorResponse, EventConsumerAction, type EventData, type EventMetadata, type EventMetadataInputModel, type EventMetadataListResponse, EventMetadataManager, type ExtendedRequestError, type FileMetadata, type FileRecord, FileRepository, GenerateBasicAuthToken, type GetProviderQueryParams, type GetRegistrationQueryParams, GraphQlAction, type HALLink, type Headers, HttpMethod, HttpStatus, IOEventsApiError, type IOEventsError, ImsConnection, ImsToken, type ImsTokenResult, InfiniteLoopBreaker, type InfiniteLoopData, IoEventsGlobals, JsonMessageProcessor, type ListProvidersQueryParams, type ListRegistrationQueryParams, type MenuItem, Oauth1aConnection, OnboardCommerce, type OnboardCommerceConfig, type OnboardCommerceResult, OnboardEvents, type OnboardEventsInput, type OnboardEventsResponse, OnboardEvents as OnboardIOEvents, Openwhisk, OpenwhiskAction, type Page, Parameters, type Provider, type ProviderInputModel, ProviderManager, PublishEvent, type PublishEventResult, type Registration, type RegistrationCreateModel, type RegistrationListResponse, RegistrationManager, RestClient, RuntimeAction, RuntimeActionResponse, type RuntimeActionResponseType, RuntimeApiGatewayService, ShippingCarrier, type ShippingCarrierData, ShippingCarrierMethod, type ShippingCarrierMethodAdditionalData, type ShippingCarrierMethodData, ShippingCarrierResponse, SignatureVerification, SuccessChecker, type SuccessResponse, Telemetry, TelemetryInputError, type TokenResult, Validator, WebhookAction, type WebhookActionAddResponse, type WebhookActionExceptionResponse, WebhookActionOperation, type WebhookActionRemoveResponse, type WebhookActionReplaceResponse, WebhookActionResponse, type WebhookActionResponseType, type WebhookActionSuccessResponse, type WorkspaceConfig };
+export { AdminUiSdk, type AdminUiSdkRegistration, AdobeAuth, AdobeCommerceClient, type AdobeIMSConfig, type BaseTelemetry, type BaseTelemetryValidator, BasicAuthConnection, BearerToken, type BearerTokenInfo, type CommerceEvent, type CommerceEventConfig, type CommerceEventField, type Connection, type CreateEventResult, CreateEvents, type CreateProviderParams, type CreateProviderResult, type CreateRegistrationResult, CreateRegistrations, type ErrorResponse, EventConsumerAction, type EventData, type EventMetadata, type EventMetadataInputModel, type EventMetadataListResponse, EventMetadataManager, type ExtendedRequestError, type FileMetadata, type FileRecord, FileRepository, GenerateBasicAuthToken, type GetProviderQueryParams, type GetRegistrationQueryParams, GraphQlAction, type HALLink, type Headers, HttpMethod, HttpStatus, IOEventsApiError, type IOEventsError, ImsConnection, ImsToken, type ImsTokenResult, InfiniteLoopBreaker, type InfiniteLoopData, IoEventsGlobals, JsonMessageProcessor, type ListProvidersQueryParams, type ListRegistrationQueryParams, type MenuItem, Oauth1aConnection, OnboardCommerce, type OnboardCommerceConfig, type OnboardCommerceResult, OnboardEvents, type OnboardEventsInput, type OnboardEventsResponse, OnboardEvents as OnboardIOEvents, Openwhisk, OpenwhiskAction, type Page, Parameters, type Provider, type ProviderInputModel, ProviderManager, PublishEvent, type PublishEventResult, type Registration, type RegistrationCreateModel, type RegistrationListResponse, RegistrationManager, RestClient, RuntimeAction, RuntimeActionResponse, type RuntimeActionResponseType, RuntimeApiGatewayService, ShippingCarrier, type ShippingCarrierData, ShippingCarrierMethod, type ShippingCarrierMethodAdditionalData, type ShippingCarrierMethodData, ShippingCarrierResponse, SignatureVerification, SuccessChecker, type SuccessResponse, Telemetry, TelemetryInputError, type TokenResult, Validator, WebhookAction, type WebhookActionAddResponse, type WebhookActionExceptionResponse, WebhookActionOperation, type WebhookActionRemoveResponse, type WebhookActionReplaceResponse, WebhookActionResponse, type WebhookActionResponseType, type WebhookActionSuccessResponse, type WorkspaceConfig };