4.1.2

4.1.2 updates the SDK to pass the access token in the headers instead of in the URL. For websocket connections this means the access token is now passed in the Sec-WebSocket-Protocol header.

Node.js Usage with Cloud Configuration

If you are using node.js with Cloud configuration and are providing a webSocketFactoryFunction in your device connection configuration you will need to update your function to create a websocket that passes the access token in the Sec-WebSocket-Protocol header. An example can be found here and here.
If you want to use the https://www.npmjs.com/package/ws implementation, you can create a global variable in your code like global.WebSocket = require('ws') and then you are not required to use the webSocketFactoryFunction parameter.

Browser Based

If you have a browser based implementation you likely won't need to change anything.

4.0.6

Correctly serialize requests with array parameters i.e. PrintRequest.setText

4.0.5

Update remote-pay-cloud-api model reference.

4.0.3

• Connection improvements.

4.0.2

Minor fix for TypeScript consumers. Previously, the typings file we were generating was invalid (exported TS source).

4.0.0

Surcharge

Updated AdditionalChargeAmount and AdditionalChargeType to support surcharges.

Incremental Preauthorization

Added a new request/response pair: IncrementPreauthRequest and IncrementPreauthResponse. This can be sent on an open preauthorization to request an increase in the authorized amount.

3.1.0

Updated baseTransactionRequest

The baseTransactionRequest object now includes the externalReferenceId field. This field can be used to associate a Clover transaction with the merchant's order identifier (such as an invoice or purchase order number).

Updated TipSuggestion setting with amounts

A TipSuggestion can now be set with dollar amounts or with percentages of the order total.

Bug fixes

This release includes several bug fixes to improve the performance and stability of the SDK.

3.0.1

Simpler connection configuration

The SDK now includes builders for network and cloud connections to Clover devices. These classes are easier to use and understand than the constructors provided in previous versions.

New language and locale information

The SDK now receives and passes a language indicator from the customer’s card. This information can be used by an integrated point of sale to print a transaction receipt in the customer’s preferred language.

Regional enhancements for Argentina and Canada

The SDK now supports transaction processing for Argentine and Canadian merchants. The example point-of-sale app has been updated to show how regional parameters can be set.

Loyalty API

Clover now supports the exchange of customer loyalty information between a Clover device and a point of sale. This communication channel provides the ability to recognize customers using unique identifiers. An identifier could be the customer’s name, phone number, or email address; their loyalty card number stored by a barcode or stripe; or an Apple Pass or Google SmartTap NFC payload broadcast by the customer’s phone.

Both the point-of-sale software and custom activities on the Clover device can access the data to perform database lookups and then customize the customer experience using the data.

New displayReceiptOptions method

The displayReceiptOptions method shows the receipt options screen for a credit, refund, or payment. This addition enhances the SDK by deprecating the displayPaymentReceiptOptions method that only worked with payments.

Updated transaction settings

The per-transaction settings have been updated with a passThroughValues object. This can be used for external system IDs or other values that will not need to be retrieved from the Clover API.

CloverConnector API cleanup

The following methods previously marked obsolete have been removed in v3.0:

• cancel

• getMessageTypeFromLastRequest (now resultSuccessToResponseCode/resultStatusToResponseCode)

• getV3TipModeFromRequestTipMode

• onPendingPaymentsResponseHandler

• printImage

• printImageFromURL

• printText

• displayPaymentReceiptOptions (use displayReceiptOptions instead)

• showPaymentReceiptOptions

ICloverConnectorListener API additions

The following methods have been added to the ICloverConnectorListener:

• onCustomerProvidedDataMessage
• onDisplayReceiptOptionsResponse
• onInvalidStateTransitionResponse
• sendDebugLog
• onPaymentRefundVoidResponse

The following are called only if the transaction request sets disablePrinting = true.

• onPrintManualRefundReceipt
• onPrintManualRefundDeclineReceipt
• onPrintPaymentReceipt
• onPrintPaymentDeclineReceipt

Bug fixes

• #147 – Wrong error about already connected friendlyId
• #142 – Unhandled error when using unescaped special characters in friendly id
• #141 – Error when building for Angular 5

1.4.3

• The tip screen will now be properly suppressed if the 'disableTipOnScreen' flag on SaleRequest is set to 'true'.
• Remote message version is now being handled properly which will allow chunking to work properly (for printing large images).
• The 'success' flag is now properly set to true/false for TipAdjustAuthResponse.
• The 'success' flag is now properly set to false in VaultedCardResponse for vault card requests that are cancelled.

1.4.2

IMPROVED

• Now publishing JavaScript bundle that could be included via script tag.
• Added the auth token setting for WebSocket paired configuration to allow for efficient reuse.
• Added unit tests initial implementation.
• Added typescript type definitions.
• The SDK now clears the last request on device reset.

FIXED

• Fixed build issues preventing Windows usage.
  • Changed method to build. Use npm run build.
• Fixed issue where removing a listener from a Clover Connector causes it to be replaced by an empty array and throws the following error: TypeError: listener.onRetrieveDeviceStatusResponse is not a function.
  *Fixed problem where you can't close WebSocket in Internet Explorer.
  Fixed Regression error where RemoteSourceSDK, RemoteApplicationID are not being sent.