@adobe-commerce/aio-toolkit 1.0.4 → 1.0.5

package/CHANGELOG.md

@@ -5,6 +5,51 @@ 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.5] - 2025-11-03
+
+### 🚀 API Enhancements, Security & Developer Experience Improvements
+
+This release focuses on improving security testing capabilities, refactoring
+logging for consistency, enhancing repository metadata, and improving the
+ShippingCarrier API for better developer experience and safety. All changes
+maintain backward compatibility except for the ShippingCarrier reset() method
+removal.
+
+#### 🔧 Commerce Components
+
+- **AdobeCommerceClient** `[Enhanced]` - HTTPS configuration support for
+  testing
+  - Added optional `httpsOptions` parameter to constructor
+  - Support for `rejectUnauthorized: false` for self-signed certificates
+  - Enables testing against local/staging environments with insecure SSL
+  - Options passed directly to `got` library's https configuration
+  - Fully backward compatible - parameter is optional
+
+- **AdobeCommerceClient, BasicAuthConnection, Oauth1aConnection** `[Refactored]`
+  - Logger initialization refactored to use CustomLogger
+  - Consistent null-safe logging across all commerce client classes
+  - Removed direct dependency on Core.Logger from @adobe/aio-sdk
+  - Simplified constructor logic with centralized logging
+  - Enhanced CustomLogger with variadic argument support for logging methods
+
+- **ShippingCarrier** `[Breaking Change]` - Removed reset() method and
+  immutable code property
+  - **BREAKING**: Removed `reset()` method - users should create new
+    ShippingCarrier instances
+  - Made `code` property immutable in `setData()` method
+  - Code is now preserved across all `setData()` calls
+  - Prevents accidental override of carrier identity
+  - Added `getAddedMethods()` public getter method
+  - Added `getRemovedMethods()` public getter method
+  - Better encapsulation with controlled access to method tracking arrays
+
+#### 🛠️ Framework Components
+
+- **CustomLogger** `[Enhanced]` - Variadic argument support
+  - Updated `debug()`, `info()`, and `error()` methods to accept variadic args
+  - Supports modern logging patterns like `logger.debug('User %s logged in', userId)`
+  - Full backward compatibility maintained
+
 ## [1.0.4] - 2025-10-29
 
 ### 🚀 Major Feature Release: Webhook Components & Shipping Carrier Builder

package/README.md

@@ -624,13 +624,18 @@ const carrier = new ShippingCarrier('fedex', (carrier) => {
 const carrierData = carrier.getData();
 console.log(carrierData);
 
+// Access added and removed methods
+const addedMethods = carrier.getAddedMethods();   // ['standard', 'express']
+const removedMethods = carrier.getRemovedMethods(); // ['overnight']
+
 // Generate webhook response operations
 const response = new ShippingCarrierResponse(carrier);
 const operations = response.generate();
 return operations; // Use in webhook action
 
+// Update carrier data (code is immutable)
 carrier.setData({
-  code: 'dps',
+  code: 'ups', // This will be ignored - code remains 'fedex'
   title: 'Demo Postal Service',
   stores: ['default'],
   countries: ['US', 'CA'],
@@ -640,8 +645,8 @@ carrier.setData({
   shipping_labels_available: true
 });
 
-// Reset carrier with new code
-carrier.reset('ups', (c) => {
+// Code property is immutable - create new instance if you need different code
+const newCarrier = new ShippingCarrier('ups', (c) => {
   c.addMethod('ground', (m) => {
     m.setMethodTitle('UPS Ground').setPrice(12.99);
   });
@@ -653,6 +658,8 @@ carrier.reset('ups', (c) => {
 - Validation for carrier and method codes (alphanumeric and underscores only)
 - Add and remove shipping methods dynamically
 - Configure carrier properties (title, stores, countries, sort order, etc.)
+- **Immutable code property** - prevents accidental carrier identity changes
+- Public getter methods: `getAddedMethods()` and `getRemovedMethods()`
 - Generate webhook response operations
 - Type-safe TypeScript interfaces
 
@@ -660,6 +667,7 @@ carrier.reset('ups', (c) => {
 - Carrier and method codes must contain only alphanumeric characters and underscores
 - No spaces, hyphens, dots, or special characters allowed
 - Empty or whitespace-only codes throw errors
+- Code property cannot be changed after initialization
 
 ### 🎨 Experience Components
 

package/dist/index.d.mts

@@ -453,12 +453,17 @@ interface Connection {
 interface ExtendedRequestError extends RequestError {
     responseBody?: any;
 }
+interface HttpsOptions {
+    rejectUnauthorized?: boolean;
+    [key: string]: any;
+}
 
 declare class AdobeCommerceClient {
     private baseUrl;
     private connection;
     private logger;
-    constructor(baseUrl: string, connection: Connection, logger?: any);
+    private httpsOptions;
+    constructor(baseUrl: string, connection: Connection, logger?: any, httpsOptions?: HttpsOptions);
     get(endpoint: string, headers?: Record<string, string>): Promise<any>;
     post(endpoint: string, headers?: Record<string, string>, payload?: any): Promise<any>;
     put(endpoint: string, headers?: Record<string, string>, payload?: any): Promise<any>;
@@ -521,17 +526,6 @@ declare class GenerateBasicAuthToken {
     getState(): Promise<any>;
 }
 
-interface ShippingCarrierData {
-    code: string;
-    title?: string;
-    stores?: string[];
-    countries?: string[];
-    sort_order?: number;
-    active?: boolean;
-    tracking_available?: boolean;
-    shipping_labels_available?: boolean;
-}
-
 interface ShippingCarrierMethodAdditionalData {
     key: string;
     value: any;
@@ -545,6 +539,17 @@ interface ShippingCarrierMethodData {
     additional_data: ShippingCarrierMethodAdditionalData[];
 }
 
+interface ShippingCarrierData {
+    code: string;
+    title?: string;
+    stores?: string[];
+    countries?: string[];
+    sort_order?: number;
+    active?: boolean;
+    tracking_available?: boolean;
+    shipping_labels_available?: boolean;
+}
+
 declare class ShippingCarrierMethod {
     private methodData;
     constructor(carrierCode: string, method: string);
@@ -572,8 +577,9 @@ declare class ShippingCarrier {
     setData(carrierData: ShippingCarrierData): this;
     addMethod(method: string, callback?: (builder: ShippingCarrierMethod) => void): this;
     removeMethod(method: string): this;
-    reset(code: string, callback?: (builder: ShippingCarrier) => void): this;
     getData(): ShippingCarrierData;
+    getAddedMethods(): ShippingCarrierMethodData[];
+    getRemovedMethods(): string[];
 }
 
 declare class ShippingCarrierResponse {

package/dist/index.d.ts

@@ -453,12 +453,17 @@ interface Connection {
 interface ExtendedRequestError extends RequestError {
     responseBody?: any;
 }
+interface HttpsOptions {
+    rejectUnauthorized?: boolean;
+    [key: string]: any;
+}
 
 declare class AdobeCommerceClient {
     private baseUrl;
     private connection;
     private logger;
-    constructor(baseUrl: string, connection: Connection, logger?: any);
+    private httpsOptions;
+    constructor(baseUrl: string, connection: Connection, logger?: any, httpsOptions?: HttpsOptions);
     get(endpoint: string, headers?: Record<string, string>): Promise<any>;
     post(endpoint: string, headers?: Record<string, string>, payload?: any): Promise<any>;
     put(endpoint: string, headers?: Record<string, string>, payload?: any): Promise<any>;
@@ -521,17 +526,6 @@ declare class GenerateBasicAuthToken {
     getState(): Promise<any>;
 }
 
-interface ShippingCarrierData {
-    code: string;
-    title?: string;
-    stores?: string[];
-    countries?: string[];
-    sort_order?: number;
-    active?: boolean;
-    tracking_available?: boolean;
-    shipping_labels_available?: boolean;
-}
-
 interface ShippingCarrierMethodAdditionalData {
     key: string;
     value: any;
@@ -545,6 +539,17 @@ interface ShippingCarrierMethodData {
     additional_data: ShippingCarrierMethodAdditionalData[];
 }
 
+interface ShippingCarrierData {
+    code: string;
+    title?: string;
+    stores?: string[];
+    countries?: string[];
+    sort_order?: number;
+    active?: boolean;
+    tracking_available?: boolean;
+    shipping_labels_available?: boolean;
+}
+
 declare class ShippingCarrierMethod {
     private methodData;
     constructor(carrierCode: string, method: string);
@@ -572,8 +577,9 @@ declare class ShippingCarrier {
     setData(carrierData: ShippingCarrierData): this;
     addMethod(method: string, callback?: (builder: ShippingCarrierMethod) => void): this;
     removeMethod(method: string): this;
-    reset(code: string, callback?: (builder: ShippingCarrier) => void): this;
     getData(): ShippingCarrierData;
+    getAddedMethods(): ShippingCarrierMethodData[];
+    getRemovedMethods(): string[];
 }
 
 declare class ShippingCarrierResponse {

package/dist/index.js

@@ -622,28 +622,31 @@ var _CustomLogger = class _CustomLogger {
   /**
    * Log debug message if logger is available
    * @param message - Debug message to log
+   * @param args - Additional arguments to pass to logger
    */
-  debug(message) {
+  debug(message, ...args) {
     if (this.logger && typeof this.logger.debug === "function") {
-      this.logger.debug(message);
+      this.logger.debug(message, ...args);
     }
   }
   /**
    * Log info message if logger is available
    * @param message - Info message to log
+   * @param args - Additional arguments to pass to logger
    */
-  info(message) {
+  info(message, ...args) {
     if (this.logger && typeof this.logger.info === "function") {
-      this.logger.info(message);
+      this.logger.info(message, ...args);
     }
   }
   /**
    * Log error message if logger is available
    * @param message - Error message to log
+   * @param args - Additional arguments to pass to logger
    */
-  error(message) {
+  error(message, ...args) {
     if (this.logger && typeof this.logger.error === "function") {
-      this.logger.error(message);
+      this.logger.error(message, ...args);
     }
   }
   /**
@@ -4986,26 +4989,22 @@ var AdobeAuth = _AdobeAuth;
 var adobe_auth_default = AdobeAuth;
 
 // src/commerce/adobe-commerce-client/index.ts
-var import_aio_sdk8 = require("@adobe/aio-sdk");
 var import_got = __toESM(require("got"));
 var _AdobeCommerceClient = class _AdobeCommerceClient {
   /**
    * @param baseUrl
    * @param connection
    * @param logger
+   * @param httpsOptions
    */
-  constructor(baseUrl, connection, logger = null) {
+  constructor(baseUrl, connection, logger = null, httpsOptions) {
     if (!baseUrl) {
       throw new Error("Commerce URL must be provided");
     }
     this.baseUrl = baseUrl;
     this.connection = connection;
-    if (logger === null) {
-      logger = import_aio_sdk8.Core.Logger("adobe-commerce-client", {
-        level: "debug"
-      });
-    }
-    this.logger = logger;
+    this.httpsOptions = httpsOptions;
+    this.logger = new custom_logger_default(logger);
   }
   /**
    * @param endpoint
@@ -5092,6 +5091,7 @@ var _AdobeCommerceClient = class _AdobeCommerceClient {
       headers: {
         "Content-Type": "application/json"
       },
+      ...this.httpsOptions && { https: this.httpsOptions },
       hooks: {
         beforeRequest: [
           (options) => this.logger.debug(`Request [${options.method}] ${options.url}`)
@@ -5127,11 +5127,8 @@ __name(_AdobeCommerceClient, "AdobeCommerceClient");
 var AdobeCommerceClient = _AdobeCommerceClient;
 var adobe_commerce_client_default = AdobeCommerceClient;
 
-// src/commerce/adobe-commerce-client/basic-auth-connection/index.ts
-var import_aio_sdk10 = require("@adobe/aio-sdk");
-
 // src/commerce/adobe-commerce-client/basic-auth-connection/generate-basic-auth-token/index.ts
-var import_aio_sdk9 = require("@adobe/aio-sdk");
+var import_aio_sdk8 = require("@adobe/aio-sdk");
 var _GenerateBasicAuthToken = class _GenerateBasicAuthToken {
   /**
    * @param baseUrl
@@ -5144,12 +5141,7 @@ var _GenerateBasicAuthToken = class _GenerateBasicAuthToken {
     this.username = username;
     this.password = password;
     this.key = "adobe_commerce_basic_auth_token";
-    if (logger === null) {
-      logger = import_aio_sdk9.Core.Logger("adobe-commerce-client", {
-        level: "debug"
-      });
-    }
-    this.logger = logger;
+    this.logger = new custom_logger_default(logger);
   }
   /**
    * @return string | null
@@ -5286,7 +5278,7 @@ var _GenerateBasicAuthToken = class _GenerateBasicAuthToken {
   async getState() {
     if (this.state === void 0) {
       try {
-        this.state = await import_aio_sdk9.State.init();
+        this.state = await import_aio_sdk8.State.init();
       } catch (error) {
         this.logger.debug("State API initialization failed, running without caching");
         this.state = null;
@@ -5311,12 +5303,7 @@ var _BasicAuthConnection = class _BasicAuthConnection {
     this.baseUrl = baseUrl;
     this.username = username;
     this.password = password;
-    if (logger === null) {
-      logger = import_aio_sdk10.Core.Logger("adobe-commerce-client", {
-        level: "debug"
-      });
-    }
-    this.logger = logger;
+    this.logger = new custom_logger_default(logger);
   }
   /**
    * @param commerceGot
@@ -5327,7 +5314,7 @@ var _BasicAuthConnection = class _BasicAuthConnection {
       this.baseUrl,
       this.username,
       this.password,
-      this.logger
+      this.logger.getLogger()
     );
     const token = await generateToken.execute();
     return commerceGot.extend({
@@ -5342,7 +5329,6 @@ var BasicAuthConnection = _BasicAuthConnection;
 var basic_auth_connection_default = BasicAuthConnection;
 
 // src/commerce/adobe-commerce-client/oauth1a-connection/index.ts
-var import_aio_sdk11 = require("@adobe/aio-sdk");
 var import_oauth_1 = __toESM(require("oauth-1.0a"));
 var crypto3 = __toESM(require("crypto"));
 var _Oauth1aConnection = class _Oauth1aConnection {
@@ -5358,12 +5344,7 @@ var _Oauth1aConnection = class _Oauth1aConnection {
     this.consumerSecret = consumerSecret;
     this.accessToken = accessToken;
     this.accessTokenSecret = accessTokenSecret;
-    if (logger === null) {
-      logger = import_aio_sdk11.Core.Logger("adobe-commerce-client", {
-        level: "debug"
-      });
-    }
-    this.logger = logger;
+    this.logger = new custom_logger_default(logger);
   }
   /**
    * @param commerceGot
@@ -5407,7 +5388,7 @@ var Oauth1aConnection = _Oauth1aConnection;
 var oauth1a_connection_default = Oauth1aConnection;
 
 // src/commerce/adobe-commerce-client/ims-connection/generate-ims-token/index.ts
-var import_aio_sdk12 = require("@adobe/aio-sdk");
+var import_aio_sdk9 = require("@adobe/aio-sdk");
 var _GenerateImsToken = class _GenerateImsToken {
   /**
    * @param clientId
@@ -5547,7 +5528,7 @@ var _GenerateImsToken = class _GenerateImsToken {
     if (this.state === void 0) {
       try {
         this.customLogger.debug("Initializing State API for token caching");
-        this.state = await import_aio_sdk12.State.init();
+        this.state = await import_aio_sdk9.State.init();
       } catch (error) {
         this.customLogger.error(`Failed to initialize State API: ${error.message}`);
         this.state = null;
@@ -5834,6 +5815,7 @@ var _ShippingCarrier = class _ShippingCarrier {
   }
   /**
    * Sets the carrier data from a ShippingCarrierData object
+   * Note: The code property cannot be changed once set in the constructor
    *
    * @param carrierData - Carrier data object
    * @returns The builder instance for method chaining
@@ -5853,8 +5835,11 @@ var _ShippingCarrier = class _ShippingCarrier {
    * ```
    */
   setData(carrierData) {
-    this.validateCarrierCode(carrierData.code);
-    this.carrierData = { ...carrierData };
+    const originalCode = this.carrierData.code;
+    if (carrierData.code !== void 0) {
+      this.validateCarrierCode(carrierData.code);
+    }
+    this.carrierData = { ...carrierData, code: originalCode };
     return this;
   }
   /**
@@ -5899,37 +5884,6 @@ var _ShippingCarrier = class _ShippingCarrier {
     this.removedMethods.push(method);
     return this;
   }
-  /**
-   * Resets the carrier and re-initializes it with new code and optional callback
-   *
-   * @param code - Carrier code
-   * @param callback - Optional callback function to configure the carrier
-   * @returns The builder instance for method chaining
-   *
-   * @example
-   * ```typescript
-   * carrier.reset('ups', (carrier) => {
-   *   carrier.addMethod('ground', (method) => {
-   *     method.setMethodTitle('UPS Ground').setPrice(12.99).setCost(8.00);
-   *   });
-   * });
-   * ```
-   */
-  reset(code, callback) {
-    this.validateCarrierCode(code);
-    this.carrierData = {
-      code,
-      active: true,
-      tracking_available: true,
-      shipping_labels_available: true
-    };
-    this.addedMethods = [];
-    this.removedMethods = [];
-    if (callback) {
-      callback(this);
-    }
-    return this;
-  }
   /**
    * Gets and returns the shipping carrier data as a JSON object
    *
@@ -5954,6 +5908,34 @@ var _ShippingCarrier = class _ShippingCarrier {
   getData() {
     return this.carrierData;
   }
+  /**
+   * Gets the list of methods that have been added to the carrier
+   *
+   * @returns Array of added shipping carrier methods
+   *
+   * @example
+   * ```typescript
+   * const addedMethods = carrier.getAddedMethods();
+   * // Returns: [{ carrier_code: 'fedex', method: 'standard', ... }, ...]
+   * ```
+   */
+  getAddedMethods() {
+    return this.addedMethods;
+  }
+  /**
+   * Gets the list of method codes that have been marked for removal
+   *
+   * @returns Array of method codes to be removed
+   *
+   * @example
+   * ```typescript
+   * const removedMethods = carrier.getRemovedMethods();
+   * // Returns: ['overnight', 'express']
+   * ```
+   */
+  getRemovedMethods() {
+    return this.removedMethods;
+  }
 };
 __name(_ShippingCarrier, "ShippingCarrier");
 var ShippingCarrier = _ShippingCarrier;