createAddCardFormRequest doesn't calculate signature #55

Author: Ottia

RELEASE_NOTES.md

@@ -0,0 +1,16 @@
+# Release 1.1.0
+
+## What's Changed
+
+**Breaking Change**: Refactored `createAddCardFormRequest` to internalize signature calculation and authentication parameters. This aligns the method with the rest of the SDK patterns and simplifies usage for developers. The `AddCardFormRequest` model no longer requires `checkoutAccount`, `checkoutMethod`, `checkoutNonce`, `checkoutTimestamp`, `checkoutAlgorithm`, or `signature` to be populated manually.
+
+### Features
+- Internalized signature calculation for `createAddCardFormRequest` (matches `createPayment` pattern).
+- Implemented Form Post style authentication (Body Auth) for add-card requests.
+
+### Refactoring
+- Removed manual authentication fields from `AddCardFormRequest` model.
+- Automatically injects merchant credentials and generates HMAC signature within the SDK.
+
+### Testing
+- Added unit tests to verify signature generation and payload structure for card form requests.

TESTING.md

@@ -0,0 +1,67 @@
+# Testing Guide
+
+This guide describes how to test the `paytrail-js-sdk` locally, focusing on the recent changes to `createAddCardFormRequest`.
+
+## Prerequisites
+
+- Node.js (>= 20)
+- npm
+
+## Running Automated Tests
+
+To run the unit tests, use the following command:
+
+```bash
+npm test
+```
+
+To run only the tests related to `createAddCardFormRequest`:
+
+```bash
+npm test -- tests/create-add-card-form.test.ts
+```
+
+## Manual / Integration Verification
+
+### Setup
+1. Ensure you have valid Paytrail Merchant credentials (Merchant ID and Secret Key).
+2. The current test suite uses default test credentials (`merchantId: 695861`, `secret: MONISAIPPUAKAUPPIAS`).
+
+### Test Flow
+1. Instantiate `PaytrailClient` with your credentials.
+2. Create an `AddCardFormRequest` object with only the business fields:
+   - `checkoutRedirectSuccessUrl`
+   - `checkoutRedirectCancelUrl`
+   - `language` (optional)
+   - `checkoutCallbackSuccessUrl` (optional)
+   - `checkoutCallbackCancelUrl` (optional)
+3. Call `client.createAddCardFormRequest(request)`.
+4. Inspect the result. It should contain a `redirectUrl`.
+
+### Example Code
+
+```typescript
+import { PaytrailClient, AddCardFormRequest } from '@paytrail/paytrail-js-sdk';
+
+const client = new PaytrailClient({
+  merchantId: 1072377,
+  secretKey: '226382458d7a1a75486c9732881472dd61fff6debfb193afab1f7e8b85131081418380be827a69fc',
+  platformName: 'test'
+});
+
+const run = async () => {
+    const request = new AddCardFormRequest();
+    request.checkoutRedirectSuccessUrl = 'https://example.com/success';
+    request.checkoutRedirectCancelUrl = 'https://example.com/cancel';
+    request.language = 'EN';
+
+    try {
+        const response = await client.createAddCardFormRequest(request);
+        console.log('Redirect URL:', response.data.redirectUrl);
+    } catch (error) {
+        console.error('Error:', error);
+    }
+};
+
+run();
+```

dist/models/request/add-card-form.model.d.ts

@@ -8,23 +8,23 @@ export declare class AddCardFormRequest {
     /**
      * Paytrail account ID.
      */
-    checkoutAccount: number;
+    checkoutAccount?: number;
     /**
      * Used signature algorithm. The same as used by merchant when creating the payment.
      */
-    checkoutAlgorithm: string;
+    checkoutAlgorithm?: string;
     /**
      * HTTP verb of the request. Always POST for addcard-form.
      */
-    checkoutMethod: string;
+    checkoutMethod?: string;
     /**
      * Unique identifier for this request.
      */
-    checkoutNonce: string;
+    checkoutNonce?: string;
     /**
      * ISO 8601 date time.
      */
-    checkoutTimestamp: string;
+    checkoutTimestamp?: string;
     /**
      * Merchant's url for user redirect on successful card addition.
      */
@@ -36,7 +36,7 @@ export declare class AddCardFormRequest {
     /**
      * Signature calculated from 'checkout-' prefixed POST parameters the same way as calculating signature from headers.
      */
-    signature: string;
+    signature?: string;
     /**
      * Merchant's url called on successful card addition.
      */

dist/models/request/add-card-form.model.js

@@ -23,26 +23,31 @@ exports.AddCardFormRequest = AddCardFormRequest;
 __decorate([
     (0, class_validator_1.IsNotEmpty)(),
     (0, class_validator_1.IsNumber)(),
+    (0, class_validator_1.IsOptional)(),
     __metadata("design:type", Number)
 ], AddCardFormRequest.prototype, "checkoutAccount", void 0);
 __decorate([
     (0, class_validator_1.IsNotEmpty)(),
     (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsOptional)(),
     __metadata("design:type", String)
 ], AddCardFormRequest.prototype, "checkoutAlgorithm", void 0);
 __decorate([
     (0, class_validator_1.IsNotEmpty)(),
     (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsOptional)(),
     __metadata("design:type", String)
 ], AddCardFormRequest.prototype, "checkoutMethod", void 0);
 __decorate([
     (0, class_validator_1.IsNotEmpty)(),
     (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsOptional)(),
     __metadata("design:type", String)
 ], AddCardFormRequest.prototype, "checkoutNonce", void 0);
 __decorate([
     (0, class_validator_1.IsNotEmpty)(),
     (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsOptional)(),
     __metadata("design:type", String)
 ], AddCardFormRequest.prototype, "checkoutTimestamp", void 0);
 __decorate([
@@ -58,6 +63,7 @@ __decorate([
 __decorate([
     (0, class_validator_1.IsNotEmpty)(),
     (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsOptional)(),
     __metadata("design:type", String)
 ], AddCardFormRequest.prototype, "signature", void 0);
 __decorate([

dist/models/request/create-payment.model.js

@@ -18,6 +18,7 @@ const callback_url_model_1 = require("./request-model/callback-url.model");
 const payment_method_group_model_1 = require("./request-model/payment-method-group.model");
 const class_transformer_1 = require("class-transformer");
 require("reflect-metadata");
+const create_payment_validator_1 = require("../../validators/create-payment.validator");
 /**
  * Class CreatePaymentRequest
  *
@@ -66,6 +67,7 @@ __decorate([
     (0, class_validator_1.IsOptional)(),
     (0, class_validator_1.ValidateNested)({ each: true }),
     (0, class_transformer_1.Type)(() => item_model_1.Item),
+    (0, create_payment_validator_1.ValidateItemPrices)(),
     __metadata("design:type", Array)
 ], CreatePaymentRequest.prototype, "items", void 0);
 __decorate([

dist/models/request/request-model/item.model.d.ts

@@ -1,4 +1,3 @@
-import { Commission } from './commission.model';
 import 'reflect-metadata';
 /**
  * Class Item
@@ -11,6 +10,9 @@ export declare class Item {
     /**
      * Price per unit, VAT included, in each country's
      * minor unit, e.g. for Euros use cents.
+     * Min value -2147483648, max value 2147483647.
+     * Negative values are not allowed when usePricesWithoutVat is true
+     * or for Shop-in-Shop items.
      */
     unitPrice: number;
     /**
@@ -61,9 +63,4 @@ export declare class Item {
      * Required for Shop-in-Shop payments, do not use for normal payments.
      */
     merchant?: string;
-    /**
-     * Shop-in-Shop commission.
-     * Do not use for normal payments.
-     */
-    commission?: Commission;
 }

dist/models/request/request-model/item.model.js

@@ -11,8 +11,6 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Item = void 0;
 const class_validator_1 = require("class-validator");
-const commission_model_1 = require("./commission.model");
-const class_transformer_1 = require("class-transformer");
 require("reflect-metadata");
 /**
  * Class Item
@@ -27,7 +25,6 @@ exports.Item = Item;
 __decorate([
     (0, class_validator_1.IsNotEmpty)(),
     (0, class_validator_1.IsNumber)(),
-    (0, class_validator_1.Min)(0),
     __metadata("design:type", Number)
 ], Item.prototype, "unitPrice", void 0);
 __decorate([
@@ -82,9 +79,3 @@ __decorate([
     (0, class_validator_1.Length)(0, 50),
     __metadata("design:type", String)
 ], Item.prototype, "merchant", void 0);
-__decorate([
-    (0, class_validator_1.IsOptional)(),
-    (0, class_validator_1.ValidateNested)(),
-    (0, class_transformer_1.Type)(() => commission_model_1.Commission),
-    __metadata("design:type", commission_model_1.Commission)
-], Item.prototype, "commission", void 0);

dist/models/request/request-model/shop-in-shop-item.model.d.ts

@@ -1,13 +1,23 @@
+import { Item } from './item.model';
 import { Commission } from './commission.model';
 import 'reflect-metadata';
 /**
  * Class ShopInShopItem
+ *
+ * Shop-in-Shop item extends the base Item class with specific validations:
+ * - stamp is required
+ * - reference is required
+ * - merchant is required
+ * - commission can be given but is optional
+ * - unitPrice minimum is 0 (no negative values allowed)
  */
-export declare class ShopInShopItem {
+export declare class ShopInShopItem extends Item {
     /**
-     * Item level order ID (suborder ID). Mainly useful for Shop-in-Shop purchases.
+     * Price per unit, VAT included, in each country's
+     * minor unit, e.g. for Euros use cents.
+     * For Shop-in-Shop items, negative values are not allowed.
      */
-    orderId?: string;
+    unitPrice: number;
     /**
      * Unique identifier for this item. Required for Shop-in-Shop payments. Required for item refunds.
      */
@@ -21,7 +31,7 @@ export declare class ShopInShopItem {
      */
     merchant: string;
     /**
-     * Shop-in-Shop commission. Do not use for normal payments.
+     * Shop-in-Shop commission. Optional for Shop-in-Shop payments only.
      */
     commission?: Commission;
 }

dist/models/request/request-model/shop-in-shop-item.model.js

@@ -11,20 +11,29 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ShopInShopItem = void 0;
 const class_validator_1 = require("class-validator");
-const commission_model_1 = require("./commission.model");
+const item_model_1 = require("./item.model");
 const class_transformer_1 = require("class-transformer");
+const commission_model_1 = require("./commission.model");
 require("reflect-metadata");
 /**
  * Class ShopInShopItem
+ *
+ * Shop-in-Shop item extends the base Item class with specific validations:
+ * - stamp is required
+ * - reference is required
+ * - merchant is required
+ * - commission can be given but is optional
+ * - unitPrice minimum is 0 (no negative values allowed)
  */
-class ShopInShopItem {
+class ShopInShopItem extends item_model_1.Item {
 }
 exports.ShopInShopItem = ShopInShopItem;
 __decorate([
-    (0, class_validator_1.IsOptional)(),
-    (0, class_validator_1.IsString)(),
-    __metadata("design:type", String)
-], ShopInShopItem.prototype, "orderId", void 0);
+    (0, class_validator_1.IsNumber)(),
+    (0, class_validator_1.Min)(0),
+    (0, class_validator_1.Max)(2147483647),
+    __metadata("design:type", Number)
+], ShopInShopItem.prototype, "unitPrice", void 0);
 __decorate([
     (0, class_validator_1.IsNotEmpty)(),
     __metadata("design:type", String)
@@ -38,6 +47,7 @@ __decorate([
     __metadata("design:type", String)
 ], ShopInShopItem.prototype, "merchant", void 0);
 __decorate([
+    (0, class_validator_1.IsOptional)(),
     (0, class_validator_1.ValidateNested)(),
     (0, class_transformer_1.Type)(() => commission_model_1.Commission),
     __metadata("design:type", commission_model_1.Commission)

dist/models/response/add-card-form.model.d.ts

@@ -12,10 +12,6 @@ export declare class AddCardFormResponse extends Response {
  * Class AddCardFormData
  */
 export declare class AddCardFormData {
-    /**
-     * Assigned transaction ID for the payment.
-     */
-    transactionId: string;
     /**
      * URL to hosted payment gateway.
      */