@salesforce/b2c-tooling-sdk 1.15.1 → 1.17.0

package/data/script-api/dw.order.hooks.TaxHooks.md

@@ -0,0 +1,495 @@
+<!-- prettier-ignore-start -->
+# Class TaxHooks
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.order.hooks.TaxHooks](dw.order.hooks.TaxHooks.md)
+
+This interface represents tax extension points for Commerce App tax providers.
+
+
+These hooks provide integration points for external tax calculation services installed via the Commerce App
+framework. They are distinct from the legacy `dw.order.calculateTax` extension point.
+
+
+**IMPORTANT:** These hooks should **only** be implemented and registered by Commerce Apps
+(applications installed via the Commerce App framework with a CAP file). They are not intended for custom merchant
+cartridges or storefront implementations. Merchants who want custom tax calculation logic should use the legacy
+`dw.order.calculateTax` extension point instead.
+
+
+Hook Registration A function must be defined inside a JavaScript source and must be exported. The script
+with the exported hook function must be located inside a site cartridge. Inside the site cartridge a
+`package.json` file with a 'hooks' entry must exist:
+
+
+```
+"hooks": "./hooks.json"
+```
+
+
+
+The hooks entry links to a JSON file, relative to the `package.json` file. This file lists all registered
+hooks inside the hooks property:
+
+
+
+
+```
+"hooks": [
+   {"name": "sfcc.app.tax.calculate", "script": "./calculate.js"},
+   {"name": "sfcc.app.tax.commit", "script": "./commit.js"},
+   {"name": "sfcc.app.tax.cancel", "script": "./cancel.js"}
+]
+```
+
+
+
+A hook entry has a `name` and a `script` property:
+
+
+
+- The `name`contains the extension point name (the hook name).
+- The `script`contains the script path relative to the hooks file, with the exported hook  function.
+
+
+
+**Function Naming Convention:** The exported JavaScript function name must match the last segment of the
+extension point name, for example, `calculate`, `commit`, `cancel`..
+
+
+Order Lifecycle Context Each hook fires at a specific point in the order lifecycle:
+
+- **calculate:**Fires during basket calculation on every basket operation (e.g., adding items,  changing quantities, updating shipping). Calculates tax amounts for the basket line items.
+- **commit:**Fires immediately after successful order creation (order status `CREATED`).  Notifies the tax provider that the order has been created and tax amounts should be committed.
+- **cancel:**Fires on order cancellation or failure. Notifies the tax provider to void or cancel  previously committed tax amounts.
+
+Hook Precedence
+
+- When `sfcc.app.tax.calculate`is registered, it takes precedence over the legacy  `dw.order.calculateTax`hook.
+- If the Commerce App hook is not registered, the platform falls back to `dw.order.calculateTax`(if  registered).
+- If neither hook is available, the platform uses default platform tax calculation.
+
+
+
+**Important:** If you override the `dw.order.calculate` hook (the parent basket calculation
+hook), the platform's tax hook selection logic is bypassed entirely. In this case, if you want to use Commerce App
+tax providers, you must manually invoke the `sfcc.app.tax.calculate` hook from within your custom
+`dw.order.calculate` implementation.
+
+
+SCAPI Behavior
+
+
+SCAPI requests with `ScapiHookExecutionEnabled` disabled bypass all hooks (both Commerce App tax hooks and
+the legacy `dw.order.calculateTax` hook) and go straight to the default platform tax calculation.
+
+
+Hook Arguments and Return Types
+
+- **calculate:**Receives a `dw.order.LineItemCtnr`(typically a  `dw.order.Basket`) as the first argument. Must return a `dw.system.Status`object (or  `null`for success).
+- **commit:**Receives a `dw.order.Order`object as the first argument. Must return a  `dw.system.Status`object (or `null`for success).
+- **cancel:**Receives a `dw.order.Order`object as the first argument. Must return a  `dw.system.Status`object (or `null`for success).
+
+Error Handling
+For calculate hook:
+
+- **Always blocks on error:**Both returning a `Status.ERROR`and throwing an exception  prevent the basket calculation from completing successfully. The platform logs the error and halts the current basket  operation. Since order creation requires a successful basket calculation, this also prevents orders from being  created with incorrect tax amounts.
+
+For commit hook:
+
+
+The Commerce App developer chooses whether errors should block order creation by how they handle errors in their hook
+implementation:
+
+
+
+- **Non-blocking error:**Catch exceptions and return a `Status.ERROR`. The platform logs  the error as a warning and continues with the order lifecycle. Use this when the tax provider is temporarily  unavailable but the order should still be created.    
+  ```
+  return new Status(Status.ERROR, 'TAX_COMMIT_FAILED', 'Details about the failure');
+  ```
+
+- **Blocking error:**Let exceptions propagate (don't catch them). The platform logs the error and  rolls back the order lifecycle operation, preventing the order from being created.    
+  ```
+  throw new Error('Tax provider unavailable');
+  ```
+
+
+For cancel hook:
+
+
+The Commerce App developer chooses whether errors should block order cancellation by how they handle errors in their
+hook implementation:
+
+
+
+- **Non-blocking error:**Catch exceptions and return a `Status.ERROR`. The platform logs  the error as a warning and continues with the order lifecycle. Use this when the tax provider is temporarily  unavailable but the order cancellation should still proceed.    
+  ```
+  return new Status(Status.ERROR, 'TAX_CANCEL_FAILED', 'Details about the failure');
+  ```
+
+- **Blocking error:**Let exceptions propagate (don't catch them). The platform logs the error and  rolls back the order cancellation operation.    
+  ```
+  throw new Error('Tax provider unavailable');
+  ```
+
+
+
+## Constant Summary
+
+| Constant | Description |
+| --- | --- |
+| [extensionPointAppCalculateTax](#extensionpointappcalculatetax): [String](TopLevel.String.md) = "sfcc.app.tax.calculate" | The extension point name sfcc.app.tax.calculate. |
+| [extensionPointAppCancelTax](#extensionpointappcanceltax): [String](TopLevel.String.md) = "sfcc.app.tax.cancel" | The extension point name sfcc.app.tax.cancel. |
+| [extensionPointAppCommitTax](#extensionpointappcommittax): [String](TopLevel.String.md) = "sfcc.app.tax.commit" | The extension point name sfcc.app.tax.commit. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [calculate](dw.order.hooks.TaxHooks.md#calculatelineitemctnr)([LineItemCtnr](dw.order.LineItemCtnr.md)) | The function is called by extension point [extensionPointAppCalculateTax](dw.order.hooks.TaxHooks.md#extensionpointappcalculatetax). |
+| [cancel](dw.order.hooks.TaxHooks.md#cancelorder)([Order](dw.order.Order.md)) | The function is called by extension point [extensionPointAppCancelTax](dw.order.hooks.TaxHooks.md#extensionpointappcanceltax) during OrderMgr.failOrder() or  OrderMgr.cancelOrder(). |
+| [commit](dw.order.hooks.TaxHooks.md#commitorder)([Order](dw.order.Order.md)) | The function is called by extension point [extensionPointAppCommitTax](dw.order.hooks.TaxHooks.md#extensionpointappcommittax) during order creation in the order  creation transaction. |
+
+### Methods inherited from class Object
+
+[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
+## Constant Details
+
+### extensionPointAppCalculateTax
+
+- extensionPointAppCalculateTax: [String](TopLevel.String.md) = "sfcc.app.tax.calculate"
+  - : The extension point name sfcc.app.tax.calculate.
+
+
+---
+
+### extensionPointAppCancelTax
+
+- extensionPointAppCancelTax: [String](TopLevel.String.md) = "sfcc.app.tax.cancel"
+  - : The extension point name sfcc.app.tax.cancel.
+
+
+---
+
+### extensionPointAppCommitTax
+
+- extensionPointAppCommitTax: [String](TopLevel.String.md) = "sfcc.app.tax.commit"
+  - : The extension point name sfcc.app.tax.commit.
+
+
+---
+
+## Method Details
+
+### calculate(LineItemCtnr)
+- calculate(lineItemCtnr: [LineItemCtnr](dw.order.LineItemCtnr.md)): [Status](dw.system.Status.md)
+  - : The function is called by extension point [extensionPointAppCalculateTax](dw.order.hooks.TaxHooks.md#extensionpointappcalculatetax). It calculates tax amounts for
+      the basket line items during basket calculation. This hook fires on every basket operation (e.g., adding items,
+      changing quantities, updating shipping), not only before order creation.
+      
+      
+      **Note:** If the `dw.order.calculate` hook is overridden, the platform's automatic tax
+      hook selection is bypassed. You must manually invoke this hook from within your custom
+      `dw.order.calculate` implementation if you want to use Commerce App tax providers.
+      
+      
+      
+      
+      **Error Handling:** Both returning a `Status.ERROR` and throwing an exception will
+      prevent the basket calculation from completing successfully. The platform logs the error and halts the current
+      basket operation. Since order creation requires a successful basket calculation, this also prevents orders from
+      being created with incorrect tax amounts.
+      
+      
+      
+      
+      **SCAPI Behavior:** When `ScapiHookExecutionEnabled` is disabled, SCAPI requests bypass
+      this hook and use default platform tax calculation.
+      
+      
+      
+      
+      **Sample Implementation:**
+      
+      
+      
+      
+      ```
+      function calculate(basket) {
+          var TaxMgr = require('dw/order/TaxMgr');
+          var Status = require('dw/system/Status');
+          var HTTPClient = require('dw/net/HTTPClient');
+      
+          // 1. Extract shipping address and line items
+          var shipment = basket.getDefaultShipment();
+          var shippingAddress = shipment.getShippingAddress();
+      
+          // 2. Build request for external tax provider
+          var taxRequest = {
+              addresses: {
+                  shipTo: {
+                      line1: shippingAddress.getAddress1(),
+                      city: shippingAddress.getCity(),
+                      region: shippingAddress.getStateCode(),
+                      country: shippingAddress.getCountryCode().getValue(),
+                      postalCode: shippingAddress.getPostalCode()
+                  }
+              },
+              lines: []
+          };
+      
+          // Add product line items
+          var pliIterator = basket.getProductLineItems().iterator();
+          while (pliIterator.hasNext()) {
+              var pli = pliIterator.next();
+              taxRequest.lines.push({
+                  itemCode: pli.getProductID(),
+                  quantity: pli.getQuantityValue(),
+                  amount: pli.getAdjustedPrice().getValue(),
+                  taxCode: pli.getTaxClassID() // Product tax category
+              });
+          }
+      
+          // 3. Call external tax service
+          var httpClient = new HTTPClient();
+          httpClient.open('POST', 'https://api.taxprovider.com/calculate');
+          httpClient.setRequestHeader('Authorization', 'Bearer ' + apiKey);
+          httpClient.send(JSON.stringify(taxRequest));
+      
+          if (httpClient.statusCode !== 200) {
+              return new Status(Status.ERROR, 'TAX_CALC_FAILED', 'Tax calculation failed: ' + httpClient.errorText);
+          }
+      
+          var taxResponse = JSON.parse(httpClient.text);
+      
+          // 4. Apply tax amounts to basket line items using TaxMgr
+          taxResponse.lines.forEach(function(line, index) {
+              var pli = basket.getProductLineItems()[index];
+              TaxMgr.setProductLineTax(pli, line.tax);
+          });
+      
+          // Set shipping tax if applicable
+          if (taxResponse.shippingTax) {
+              TaxMgr.setShippingTax(shipment, taxResponse.shippingTax);
+          }
+      
+          return new Status(Status.OK);
+      }
+      
+      exports.calculate = calculate;
+      ```
+      
+      
+      
+      **Common APIs used:** `dw.order.TaxMgr` (setProductLineTax, setShippingTax),
+      dw.net.HTTPClient, `dw.order.LineItemCtnr` (getProductLineItems, getShipments),
+      `dw.order.ProductLineItem` (getProductID, getTaxClassID), `dw.order.OrderAddress`
+      (getAddress1, getCity, getStateCode).
+
+
+    **Parameters:**
+    - lineItemCtnr - the line item container (basket) for which tax should be calculated.
+
+    **Returns:**
+    - `Status.OK` or `null` for success; `Status.ERROR` to block the basket
+              calculation with details about the failure. Throwing an exception will also block the basket calculation.
+
+
+
+---
+
+### cancel(Order)
+- cancel(order: [Order](dw.order.Order.md)): [Status](dw.system.Status.md)
+  - : The function is called by extension point [extensionPointAppCancelTax](dw.order.hooks.TaxHooks.md#extensionpointappcanceltax) during OrderMgr.failOrder() or
+      OrderMgr.cancelOrder(). It notifies the Commerce App tax provider that the order has been cancelled or has
+      failed, and that previously committed tax amounts should be voided or cancelled in the tax provider.
+      
+      
+      **Error Handling:**
+      
+      
+      
+      - **Non-blocking error:**Return `Status.ERROR`. The platform logs the error as a  warning and continues with the order lifecycle. Use this when the tax provider is temporarily unavailable but the  order cancellation should still proceed.
+      - **Blocking error:**Throw an exception. The platform logs the error and rolls back the order  lifecycle operation.
+      
+      
+      
+      **SCAPI Behavior:** When `ScapiHookExecutionEnabled` is disabled, SCAPI requests bypass
+      this hook.
+      
+      
+      
+      
+      **Sample Implementation:**
+      
+      
+      
+      
+      ```
+      function cancel(order) {
+          var Status = require('dw/system/Status');
+          var HTTPClient = require('dw/net/HTTPClient');
+      
+          // 1. Retrieve the external transaction ID stored during commit
+          var taxProviderTransactionId = order.custom.taxProviderTransactionId;
+      
+          if (!taxProviderTransactionId) {
+              // No transaction to cancel - tax was never committed
+              return new Status(Status.OK);
+          }
+      
+          // 2. Build void/cancel request for external tax provider
+          var cancelRequest = {
+              code: order.getOrderNo(),
+              type: 'SalesInvoice'
+          };
+      
+          // 3. Call external tax service to void/cancel the transaction
+          var httpClient = new HTTPClient();
+          httpClient.open('POST', 'https://api.taxprovider.com/transactions/' + taxProviderTransactionId + '/void');
+          httpClient.setRequestHeader('Authorization', 'Bearer ' + apiKey);
+          httpClient.send(JSON.stringify(cancelRequest));
+      
+          if (httpClient.statusCode !== 200 && httpClient.statusCode !== 204) {
+              // Non-blocking error: log warning but allow order cancellation to proceed
+              return new Status(Status.ERROR, 'TAX_CANCEL_FAILED',
+                  'Failed to void tax transaction in provider, order cancellation will proceed. Error: ' + httpClient.errorText);
+          }
+      
+          return new Status(Status.OK);
+      }
+      
+      exports.cancel = cancel;
+      ```
+      
+      
+      
+      **Common APIs used:** dw.net.HTTPClient, `dw.order.Order` (getOrderNo, custom
+      attributes), dw.system.Status.
+
+
+    **Parameters:**
+    - order - the order that has been cancelled and for which tax should be voided.
+
+    **Returns:**
+    - `Status.OK` or `null` for success; `Status.ERROR` to log a warning
+              without blocking the order cancellation. Throwing an exception will roll back the order cancellation
+              operation.
+
+
+
+---
+
+### commit(Order)
+- commit(order: [Order](dw.order.Order.md)): [Status](dw.system.Status.md)
+  - : The function is called by extension point [extensionPointAppCommitTax](dw.order.hooks.TaxHooks.md#extensionpointappcommittax) during order creation in the order
+      creation transaction. It notifies the Commerce App tax provider that the order has been successfully created and
+      that tax amounts should be committed to the tax provider. The order is in `CREATED` status at this
+      point (before being placed).
+      
+      
+      **Error Handling:**
+      
+      
+      
+      - **Non-blocking error:**Return `Status.ERROR`. The platform logs the error as a  warning and continues with the order lifecycle. Use this when the tax provider is temporarily unavailable but the  order should still be created.
+      - **Blocking error:**Throw an exception. The platform logs the error and rolls back the order  lifecycle operation, preventing the order from being created.
+      
+      
+      
+      **SCAPI Behavior:** When `ScapiHookExecutionEnabled` is disabled, SCAPI requests bypass
+      this hook.
+      
+      
+      
+      
+      **Sample Implementation:**
+      
+      
+      
+      
+      ```
+      function commit(order) {
+          var Transaction = require('dw/system/Transaction');
+          var Status = require('dw/system/Status');
+          var HTTPClient = require('dw/net/HTTPClient');
+      
+          // 1. Build commit request for external tax provider
+          var commitRequest = {
+              code: order.getOrderNo(), // Use order number as unique transaction ID
+              type: 'SalesInvoice',
+              companyCode: 'DEFAULT',
+              date: order.getCreationDate(),
+              customerCode: order.getCustomerNo(),
+              addresses: {
+                  shipTo: {
+                      line1: order.getDefaultShipment().getShippingAddress().getAddress1(),
+                      city: order.getDefaultShipment().getShippingAddress().getCity(),
+                      region: order.getDefaultShipment().getShippingAddress().getStateCode(),
+                      country: order.getDefaultShipment().getShippingAddress().getCountryCode().getValue(),
+                      postalCode: order.getDefaultShipment().getShippingAddress().getPostalCode()
+                  }
+              },
+              lines: [],
+              commit: true // Tell provider to commit the transaction
+          };
+      
+          // Add order line items
+          var pliIterator = order.getProductLineItems().iterator();
+          while (pliIterator.hasNext()) {
+              var pli = pliIterator.next();
+              commitRequest.lines.push({
+                  itemCode: pli.getProductID(),
+                  quantity: pli.getQuantityValue(),
+                  amount: pli.getAdjustedPrice().getValue(),
+                  tax: pli.getAdjustedTax().getValue()
+              });
+          }
+      
+          // 2. Call external tax service to commit transaction
+          var httpClient = new HTTPClient();
+          httpClient.open('POST', 'https://api.taxprovider.com/transactions');
+          httpClient.setRequestHeader('Authorization', 'Bearer ' + apiKey);
+          httpClient.send(JSON.stringify(commitRequest));
+      
+          if (httpClient.statusCode !== 200 && httpClient.statusCode !== 201) {
+              // Non-blocking error: log warning but allow order to proceed
+              return new Status(Status.ERROR, 'TAX_COMMIT_FAILED',
+                  'Failed to commit tax to provider, order will proceed. Error: ' + httpClient.errorText);
+          }
+      
+          var commitResponse = JSON.parse(httpClient.text);
+      
+          // 3. Store external transaction ID in order custom attribute for later reference (cancel/refund)
+          Transaction.wrap(function() {
+              order.custom.taxProviderTransactionId = commitResponse.id;
+          });
+      
+          return new Status(Status.OK);
+      }
+      
+      exports.commit = commit;
+      ```
+      
+      
+      
+      **Common APIs used:** dw.system.Transaction, dw.net.HTTPClient, `dw.order.Order`
+      (getOrderNo, getProductLineItems, getDefaultShipment, custom attributes), `dw.order.ProductLineItem`
+      (getAdjustedTax).
+
+
+    **Parameters:**
+    - order - the order that has been created and for which tax should be committed.
+
+    **Returns:**
+    - `Status.OK` or `null` for success; `Status.ERROR` to log a warning
+              without blocking the order. Throwing an exception will roll back the order creation.
+
+
+
+---
+
+<!-- prettier-ignore-end -->

package/data/script-api/dw.order.hooks.md

@@ -10,3 +10,4 @@
 | [PaymentHooks](dw.order.hooks.PaymentHooks.md) | This interface represents all script hooks that can be registered to  customize the order center payment functionality. |
 | [ReturnHooks](dw.order.hooks.ReturnHooks.md) | This interface represents all script hooks that can be registered to  customizing the order center return resource. |
 | [ShippingOrderHooks](dw.order.hooks.ShippingOrderHooks.md) | This interface represents all script hooks that can be registered around  shipping order lifecycle. |
+| [TaxHooks](dw.order.hooks.TaxHooks.md) | This interface represents tax extension points for Commerce App tax providers. |

package/data/script-api/dw.order.md

@@ -24,6 +24,7 @@
 | [InvoiceItem](dw.order.InvoiceItem.md) | Represents a specific item in an [Invoice](dw.order.Invoice.md). |
 | [LineItem](dw.order.LineItem.md) | Common line item base class. |
 | [LineItemCtnr](dw.order.LineItemCtnr.md) | A container for line items, such as ProductLineItems, CouponLineItems, GiftCertificateLineItems. |
+| [LineItemTax](dw.order.LineItemTax.md) | A tax on a line item: tax identifier, rate, and optional amount. |
 | [Order](dw.order.Order.md) | The Order class represents an order. |
 | [OrderAddress](dw.order.OrderAddress.md) | The Address class represents a customer's address. |
 | [OrderItem](dw.order.OrderItem.md) | Defines _extensions_ to [ProductLineItem](dw.order.ProductLineItem.md)s and  [ShippingLineItem](dw.order.ShippingLineItem.md)s belonging to an [order](dw.order.Order.md). |

package/data/script-api/dw.sitemap.SitemapFile.md

@@ -129,7 +129,7 @@ This class does not have a constructor, so you cannot create it directly.
 
 
     **Returns:**
-    - `true` if the {@code SitemapFile} is valid, `false` otherwise.
+    - `true` if the `SitemapFile` is valid, `false` otherwise.
 
 
 ---

package/data/script-api/dw.sitemap.SitemapMgr.md

@@ -42,6 +42,7 @@ This class does not have a constructor, so you cannot create it directly.
 | static [deleteCustomSitemapFiles](dw.sitemap.SitemapMgr.md#deletecustomsitemapfiles)() | Deletes all custom sitemap files for all hostnames from the appservers shared file system. |
 | static [deleteCustomSitemapFiles](dw.sitemap.SitemapMgr.md#deletecustomsitemapfilesstring)([String](TopLevel.String.md)) | Deletes all custom sitemap files for the given hostname from the appservers shared file system. |
 | static [getCustomSitemapFiles](dw.sitemap.SitemapMgr.md#getcustomsitemapfiles)() | Reads all existing custom sitemap files from files system of the appservers custom sitemap directory into memory  and returns them in a Map containing mappings like  <ul>  <li>Hostname 1 => \[SitemapFile hostname1\_sitemapfile1, SitemapFile hostname1\_sitemapfile2\]</li>  <li>Hostname 2 => \[SitemapFile hostname2\_sitemapfile1\]</li>  </ul> |
+| static [getSitemap](dw.sitemap.SitemapMgr.md#getsitemapstring)([String](TopLevel.String.md)) | Reads the content of the specified sitemap file and returns it as a String. |
 
 ### Methods inherited from class Object
 
@@ -137,6 +138,28 @@ This class does not have a constructor, so you cannot create it directly.
     - The created map containing the list of SitemapFiles.
 
 
+---
+
+### getSitemap(String)
+- static getSitemap(fileName: [String](TopLevel.String.md)): [String](TopLevel.String.md)
+  - : Reads the content of the specified sitemap file and returns it as a String.
+      
+      
+      The file is looked up in the shared sitemap directory for the current site,
+      using the hostname from the current storefront request. If the file is not found
+      in the new framework location ({@code .../sitemaps/<hostname>/}), the old
+      location ({@code .../sitemaps/}) is used as a fallback.
+
+
+    **Parameters:**
+    - fileName - The name of the sitemap file to read (e.g. "sitemap\_index.xml").             Must not be {@code null}, empty, or contain path traversal sequences.
+
+    **Returns:**
+    - The sitemap file content as a String, or {@code null} if the fileName is
+              invalid, the file does not exist, or the request context is unavailable.
+
+
+
 ---
 
 <!-- prettier-ignore-end -->

package/data/script-api/dw.system.Request.md

@@ -394,7 +394,6 @@ Use [Response.addHttpCookie(Cookie)](dw.system.Response.md#addhttpcookiecookie)
 :::
     **API Version:**
 :::note
-No longer available as of version 99.2.
 This method is deprecated and will be removed in the next API version.
 :::
 

package/data/script-api/dw.util.Assert.md

@@ -16,6 +16,8 @@ This class does not have a constructor, so you cannot create it directly.
 | --- | --- |
 | static [areEqual](dw.util.Assert.md#areequalobject-object)([Object](TopLevel.Object.md), [Object](TopLevel.Object.md)) | Propagates an assertion  if the specified objects are not equal. |
 | static [areEqual](dw.util.Assert.md#areequalobject-object-string)([Object](TopLevel.Object.md), [Object](TopLevel.Object.md), [String](TopLevel.String.md)) | Propagates an assertion using the specified message  if the specified objects are not equal. |
+| static [areNotEqual](dw.util.Assert.md#arenotequalobject-object)([Object](TopLevel.Object.md), [Object](TopLevel.Object.md)) | Propagates an assertion  if the specified objects are equal. |
+| static [areNotEqual](dw.util.Assert.md#arenotequalobject-object-string)([Object](TopLevel.Object.md), [Object](TopLevel.Object.md), [String](TopLevel.String.md)) | Propagates an assertion using the specified message  if the specified objects are equal. |
 | static [areSame](dw.util.Assert.md#aresameobject-object)([Object](TopLevel.Object.md), [Object](TopLevel.Object.md)) | Propagates an assertion  if the specified objects are not the same. |
 | static [areSame](dw.util.Assert.md#aresameobject-object-string)([Object](TopLevel.Object.md), [Object](TopLevel.Object.md), [String](TopLevel.String.md)) | Propagates an assertion using the specified message  if the specified objects are not the same. |
 | static [fail](dw.util.Assert.md#fail)() | Propagates a failure assertion. |
@@ -65,6 +67,33 @@ This class does not have a constructor, so you cannot create it directly.
     - msg - the assertion message.
 
 
+---
+
+### areNotEqual(Object, Object)
+- static areNotEqual(arg1: [Object](TopLevel.Object.md), arg2: [Object](TopLevel.Object.md)): void
+  - : Propagates an assertion
+      if the specified objects are equal.
+
+
+    **Parameters:**
+    - arg1 - the first object to check.
+    - arg2 - the second object to check.
+
+
+---
+
+### areNotEqual(Object, Object, String)
+- static areNotEqual(arg1: [Object](TopLevel.Object.md), arg2: [Object](TopLevel.Object.md), msg: [String](TopLevel.String.md)): void
+  - : Propagates an assertion using the specified message
+      if the specified objects are equal.
+
+
+    **Parameters:**
+    - arg1 - the first object to check.
+    - arg2 - the second object to check.
+    - msg - the assertion message.
+
+
 ---
 
 ### areSame(Object, Object)

package/data/script-api/dw.util.Locale.md

@@ -35,7 +35,7 @@ This class does not have a constructor, so you cannot create it directly.
 | [getISO3Country](dw.util.Locale.md#getiso3country)() | Returns the uppercase ISO 3166 3-letter country/region code for this Locale. |
 | [getISO3Language](dw.util.Locale.md#getiso3language)() | Returns the 3-letter ISO 639 language code for this Locale. |
 | [getLanguage](dw.util.Locale.md#getlanguage)() | Returns the lowercase ISO 639 language code for this Locale. |
-| static [getLocale](dw.util.Locale.md#getlocalestring)([String](TopLevel.String.md)) | Returns a Locale instance for the given localeId, or  `null` if no such Locale could be found. |
+| static [getLocale](dw.util.Locale.md#getlocalestring---variant-1)([String](TopLevel.String.md)) | Returns a Locale instance for the given localeId, or  `null` if no such Locale could be found. |
 | [toString](dw.util.Locale.md#tostring)() | Returns the String representation of the localeID. |
 
 ### Methods inherited from class Object
@@ -239,7 +239,7 @@ This class does not have a constructor, so you cannot create it directly.
 
 ---
 
-### getLocale(String)
+### getLocale(String) - Variant 1
 - static getLocale(localeId: [String](TopLevel.String.md)): [Locale](dw.util.Locale.md)
   - : Returns a Locale instance for the given localeId, or
       `null` if no such Locale could be found.
@@ -253,6 +253,9 @@ This class does not have a constructor, so you cannot create it directly.
               `null` if no such Locale could be found.
 
 
+    **API Version:**
+:::note
+:::
 
 ---