@commercetools/connect-payments-sdk 0.0.1

package/dist/commercetools/services/ct-cart.service.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefaultCartService = void 0;
+const ct_api_error_1 = require("../errors/ct-api.error");
+/**
+ * Default implementation of the CartService interface.
+ */
+class DefaultCartService {
+    ctAPI;
+    constructor(opts) {
+        this.ctAPI = opts.ctAPI;
+    }
+    async getCart(opts) {
+        return await this.ctAPI.cart.getCartById(opts.id);
+    }
+    getPaymentAmount(opts) {
+        if (opts.cart.taxedPrice) {
+            return {
+                currencyCode: opts.cart.taxedPrice.totalGross.currencyCode,
+                centAmount: opts.cart.taxedPrice.totalGross.centAmount,
+            };
+        }
+        return {
+            currencyCode: opts.cart.totalPrice.currencyCode,
+            centAmount: opts.cart.totalPrice.centAmount,
+        };
+    }
+    async addPayment(opts) {
+        const maxRetries = 6;
+        let cartVersion = opts.resource.version;
+        let err;
+        for (let retries = 0; retries < maxRetries; retries++) {
+            try {
+                return await this.ctAPI.cart.addPayment({
+                    resource: { id: opts.resource.id, version: cartVersion },
+                    paymentId: opts.paymentId,
+                });
+            }
+            catch (e) {
+                err = e;
+                if (e instanceof ct_api_error_1.CommercetoolsAPIError && e.httpErrorStatus === 409) {
+                    const cart = await this.getCart({ id: opts.resource.id });
+                    cartVersion = cart.version;
+                    retries++;
+                }
+                else {
+                    throw e;
+                }
+            }
+        }
+        throw err;
+    }
+}
+exports.DefaultCartService = DefaultCartService;

package/dist/commercetools/services/ct-payment.service.d.ts

@@ -0,0 +1,20 @@
+import { Payment, PaymentDraft } from '@commercetools/platform-sdk';
+import { GetPayment, PaymentService, PaymentServiceOptions, UpdatePayment } from '../types/payment.type';
+/**
+ * This is the default implementation of the PaymentService interface.
+ */
+export declare class DefaultPaymentService implements PaymentService {
+    private ctAPI;
+    constructor(opts: PaymentServiceOptions);
+    getPayment(opts: GetPayment): Promise<Payment>;
+    createPayment(draft: PaymentDraft): Promise<Payment>;
+    updatePayment(opts: UpdatePayment): Promise<Payment>;
+    private consolidateUpdateActions;
+    private populateSetInterfaceIdAction;
+    private populateChangeTransactionInteractionId;
+    private populateAddTransactionAction;
+    private populateChangeTransactionState;
+    private populateSetPaymentMethod;
+    private findMatchingTransactions;
+    private consolidateTransactionChanges;
+}

package/dist/commercetools/services/ct-payment.service.js

@@ -0,0 +1,129 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefaultPaymentService = void 0;
+const ct_api_error_1 = require("../errors/ct-api.error");
+/**
+ * This is the default implementation of the PaymentService interface.
+ */
+class DefaultPaymentService {
+    ctAPI;
+    constructor(opts) {
+        this.ctAPI = opts.ctAPI;
+    }
+    async getPayment(opts) {
+        return await this.ctAPI.payment.getPaymentById(opts.id);
+    }
+    async createPayment(draft) {
+        return await this.ctAPI.payment.createPayment(draft);
+    }
+    async updatePayment(opts) {
+        const maxRetries = 3;
+        let err;
+        for (let retries = 0; retries < maxRetries; retries++) {
+            const payment = await this.getPayment({ id: opts.id });
+            const actions = this.consolidateUpdateActions(payment, opts);
+            try {
+                const updatedPayment = await this.ctAPI.payment.updatePayment({
+                    resource: {
+                        id: payment.id,
+                        version: payment.version,
+                    },
+                    actions,
+                });
+                return updatedPayment;
+            }
+            catch (e) {
+                err = e;
+                if (e instanceof ct_api_error_1.CommercetoolsAPIError && e.httpErrorStatus === 409) {
+                    retries++;
+                }
+                else {
+                    throw e;
+                }
+            }
+        }
+        throw err;
+    }
+    consolidateUpdateActions(payment, updateInfo) {
+        const actions = [];
+        if (!payment.interfaceId && updateInfo.pspReference) {
+            actions.push(this.populateSetInterfaceIdAction(updateInfo.pspReference));
+        }
+        if (!payment.paymentMethodInfo.method && updateInfo.paymentMethod) {
+            actions.push(this.populateSetPaymentMethod(updateInfo.paymentMethod));
+        }
+        if (updateInfo.transaction) {
+            actions.push(...this.consolidateTransactionChanges(payment, updateInfo.transaction));
+        }
+        return actions;
+    }
+    populateSetInterfaceIdAction(interfaceId) {
+        return {
+            action: 'setInterfaceId',
+            interfaceId,
+        };
+    }
+    populateChangeTransactionInteractionId(txId, interactionId) {
+        return {
+            action: 'changeTransactionInteractionId',
+            transactionId: txId,
+            interactionId,
+        };
+    }
+    populateAddTransactionAction(draft) {
+        return {
+            action: 'addTransaction',
+            transaction: {
+                ...draft,
+                timestamp: new Date().toISOString(),
+            },
+        };
+    }
+    populateChangeTransactionState(txId, state) {
+        return {
+            action: 'changeTransactionState',
+            transactionId: txId,
+            state,
+        };
+    }
+    populateSetPaymentMethod(paymentMethod) {
+        return {
+            action: 'setMethodInfoMethod',
+            method: paymentMethod,
+        };
+    }
+    findMatchingTransactions(payment, transaction) {
+        return payment.transactions.filter((tx) => {
+            return (tx.type === transaction.type &&
+                tx.amount.centAmount === transaction.amount.centAmount &&
+                tx.amount.currencyCode === transaction.amount.currencyCode &&
+                transaction.interactionId &&
+                ((tx.interactionId && tx.interactionId === transaction.interactionId) ||
+                    (!tx.interactionId && tx.state === 'Initial')));
+        });
+    }
+    consolidateTransactionChanges(payment, transaction) {
+        const actions = [];
+        const matchingTxs = this.findMatchingTransactions(payment, transaction);
+        if (matchingTxs.length === 0) {
+            actions.push(this.populateAddTransactionAction(transaction));
+        }
+        else {
+            if (matchingTxs.length === 1) {
+                const tx = matchingTxs[0];
+                if ((tx.state !== transaction.state && tx.state === 'Initial') ||
+                    (tx.state === 'Pending' && (transaction.state === 'Success' || transaction.state === 'Failure'))) {
+                    actions.push(this.populateChangeTransactionState(tx.id, transaction.state));
+                    if (!tx.interactionId && transaction.interactionId) {
+                        actions.push(this.populateChangeTransactionInteractionId(tx.id, transaction.interactionId));
+                    }
+                }
+            }
+            else {
+                throw new Error('Multiple transactions found');
+            }
+        }
+        return actions;
+    }
+}
+exports.DefaultPaymentService = DefaultPaymentService;

package/dist/commercetools/types/api.type.d.ts

@@ -0,0 +1,32 @@
+import { Cart, Payment, PaymentDraft, PaymentPagedQueryResponse, PaymentUpdateAction } from '@commercetools/platform-sdk';
+import { ByProjectKeyRequestBuilder } from '@commercetools/platform-sdk/dist/declarations/src/generated/client/by-project-key-request-builder';
+export type CommercetoolsClient = ByProjectKeyRequestBuilder;
+export interface APIOpts {
+    client: CommercetoolsClient;
+}
+export type UpdateResource = {
+    id: string;
+    version: number;
+};
+export type AddPayment = {
+    resource: UpdateResource;
+    paymentId: string;
+};
+export type UpdatePayment = {
+    resource: UpdateResource;
+    actions: PaymentUpdateAction[];
+};
+export interface CartAPI {
+    getCartById(id: string): Promise<Cart>;
+    addPayment(opts: AddPayment): Promise<Cart>;
+}
+export interface PaymentAPI {
+    getPaymentById(id: string): Promise<Payment>;
+    find(queryPredicate: string): Promise<PaymentPagedQueryResponse>;
+    createPayment(paymentDraft: PaymentDraft): Promise<Payment>;
+    updatePayment(opts: UpdatePayment): Promise<Payment>;
+}
+export interface CommercetoolsAPI {
+    cart: CartAPI;
+    payment: PaymentAPI;
+}

package/dist/commercetools/types/api.type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/commercetools/types/cart.type.d.ts

@@ -0,0 +1,21 @@
+import { Cart } from '@commercetools/platform-sdk';
+import { AddPayment, CommercetoolsAPI } from './api.type';
+import { PaymentAmount } from './payment.type';
+export type GetCart = {
+    id: string;
+    version?: number;
+};
+export type GetPaymentAmount = {
+    cart: Cart;
+};
+export type CartServiceOptions = {
+    ctAPI: CommercetoolsAPI;
+};
+/**
+ * Cart service interface exposes methods to interact with the commercetools platform API.
+ */
+export interface CartService {
+    getCart(opts: GetCart): Promise<Cart>;
+    getPaymentAmount(opts: GetPaymentAmount): PaymentAmount;
+    addPayment(opts: AddPayment): Promise<Cart>;
+}

package/dist/commercetools/types/cart.type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/commercetools/types/payment.type.d.ts

@@ -0,0 +1,38 @@
+import { Money, Payment, PaymentDraft, TransactionState, TransactionType } from '@commercetools/platform-sdk';
+import { CommercetoolsAPI } from './api.type';
+export type PaymentAmount = {
+    centAmount: number;
+    currencyCode: string;
+};
+export type PaymentServiceOptions = {
+    ctAPI: CommercetoolsAPI;
+};
+export type GetPayment = {
+    id: string;
+    version?: number;
+};
+export type PSPInteraction = {
+    request?: string;
+    response?: string;
+};
+export type TransactionData = {
+    type: TransactionType;
+    amount: Money;
+    interactionId?: string;
+    state: TransactionState;
+};
+export type UpdatePayment = {
+    id: string;
+    pspReference?: string;
+    pspInteraction?: PSPInteraction;
+    transaction?: TransactionData;
+    paymentMethod?: string;
+};
+/**
+ * Payment service interface exposes methods to interact with the commercetools platform API.
+ */
+export interface PaymentService {
+    getPayment(opts: GetPayment): Promise<Payment>;
+    createPayment(draft: PaymentDraft): Promise<Payment>;
+    updatePayment(opts: UpdatePayment): Promise<Payment>;
+}

package/dist/commercetools/types/payment.type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/errorx/errorx.d.ts

@@ -0,0 +1,150 @@
+export type ErrorxAdditionalOpts = {
+    privateFields?: object;
+    privateMessage?: string;
+    fields?: object;
+    skipLog?: boolean;
+    cause?: Error | unknown;
+};
+export type ErrorxBaseOpts = {
+    message: string;
+    code: string;
+    httpErrorStatus: number;
+};
+export type ErrorxOpts = ErrorxBaseOpts & ErrorxAdditionalOpts;
+/**
+ * Errorx is a custom error class that extends the native Error class.
+ */
+export declare class Errorx extends Error {
+    code: string;
+    httpErrorStatus: number;
+    cause?: Error | unknown;
+    privateFields?: object;
+    privateMessage?: string;
+    fields?: object;
+    skipLog?: boolean;
+    constructor(opts: ErrorxOpts);
+}
+export declare class MultiErrorx extends Error {
+    errors: Errorx[];
+    constructor(errors: Errorx[]);
+}
+/**
+ * AuthErrorResponse (https://docs.commercetools.com/api/errors#autherrorresponse)
+ * Represents errors related to authentication and authorization in a format conforming to the OAuth 2.0 specification.
+ * {
+ *   "statusCode": 401,
+ *   "message": "invalid_token",
+ *   "errors": [
+ *     {
+ *       "code": "invalid_token",
+ *       "message": "invalid_token"
+ *     }
+ *   ],
+ *   "error": "invalid_token"
+ * }
+ */
+export declare class ErrorAuthErrorResponse extends Errorx {
+    constructor(additionalOpts?: ErrorxAdditionalOpts);
+}
+/**
+ * General (https://docs.commercetools.com/api/errors#general)
+ * Returned when a server-side problem occurs.
+ */
+export declare class ErrorGeneral extends Errorx {
+    constructor(msg?: string, additionalOpts?: ErrorxAdditionalOpts);
+}
+/**
+ * MissingProjectKey
+ * Missing the project key in the path.
+ */
+export declare class ErrorMissingProjectKey extends Errorx {
+    constructor(additionalOpts?: ErrorxAdditionalOpts);
+}
+/**
+ * InvalidJsonInput (https://docs.commercetools.com/api/errors#invalidjsoninput)
+ * Returned when an invalid JSON input has been sent. Either the JSON is syntactically incorrect or does not conform to the expected shape (for example is missing a required field).
+ *
+ * The client application should validate the input according to the constraints described in the error message before sending the request.
+ */
+export declare class ErrorInvalidJsonInput extends Errorx {
+    constructor(detailedErrorMessage?: string, additionalOpts?: ErrorxAdditionalOpts);
+}
+/**
+ * InvalidOperation (https://docs.commercetools.com/api/errors#invalidoperation)
+ * Returned when the resources involved in the request are not in a valid state for the operation.
+ *
+ * The client application should validate the constraints described in the error message before sending the request.
+ */
+export declare class ErrorInvalidOperation extends Errorx {
+    constructor(message: string, additionalOpts?: ErrorxAdditionalOpts);
+}
+/**
+ * InvalidField (https://docs.commercetools.com/api/errors#invalidfield)
+ * Returned when a field has an invalid value.
+ */
+export declare class ErrorInvalidField extends Errorx {
+    constructor(field: string, invalidValue: string, allowedValues: string, additionalOpts?: ErrorxAdditionalOpts);
+}
+/**
+ * InternalConstraintViolated (https://docs.commercetools.com/api/errors#internalconstraintviolated)
+ * Returned when certain API-specific constraints were not met. For example, the specified Discount Code was never applied and cannot be updated.
+ */
+export declare class ErrorInternalConstraintViolated extends Errorx {
+    constructor(message: string, additionalOpts?: ErrorxAdditionalOpts);
+}
+/**
+ * MoneyOverflow (https://docs.commercetools.com/api/errors#moneyoverflow)
+ * Returned when a Money operation overflows the 64-bit integer range. See Money usage for more information.
+ */
+export declare class ErrorMoneyOverflow extends Errorx {
+    constructor(limit: number, resourceTypeId: string, additionalOpts?: ErrorxAdditionalOpts);
+}
+/**
+ * ObjectNotFound (https://docs.commercetools.com/api/errors#objectnotfound)
+ * Returned when the requested resource was not found.
+ */
+export declare class ErrorObjectNotFound extends Errorx {
+    constructor(resourceTypeId: string, id: string, additionalOpts?: ErrorxAdditionalOpts);
+}
+/**
+ * InvalidField (https://docs.commercetools.com/api/errors#invalidfield)
+ * Returned when a field has an invalid value.
+ */
+export declare class ErrorReferenceExists extends Errorx {
+    constructor(resource: string, referencedBy?: string, additionalOpts?: ErrorxAdditionalOpts);
+}
+/**
+ * ReferencedResourceNotFound (https://docs.commercetools.com/api/errors#referencedresourcenotfound)
+ * Returned when a resource referenced by a Reference or a ResourceIdentifier could not be found.
+ */
+export declare class ErrorReferencedResourceNotFound extends Errorx {
+    constructor(typeId: string, id?: string, key?: string, additionalOpts?: ErrorxAdditionalOpts);
+}
+/**
+ * ReferencedResourceNotFound (https://docs.commercetools.com/api/errors#referencedresourcenotfound)
+ * Returned when a resource referenced by a Reference or a ResourceIdentifier could not be found.
+ */
+export declare class ErrorRequiredField extends Errorx {
+    constructor(field: string, additionalOpts?: ErrorxAdditionalOpts);
+}
+/**
+ * SyntaxError (https://docs.commercetools.com/api/errors#syntaxerror)
+ * Returned when a Discount predicate, API Extension predicate, or search query does not have the correct syntax.
+ */
+export declare class ErrorSyntaxError extends Errorx {
+    constructor(fieldDefinition: string, additionalOpts?: ErrorxAdditionalOpts);
+}
+/**
+ * ResourceNotFound (https://docs.commercetools.com/api/errors#resourcenotfound)
+ * Returned when the resource addressed by the request URL does not exist.
+ */
+export declare class ErrorResourceNotFound extends Errorx {
+    constructor(resourceId: string, additionalOpts?: ErrorxAdditionalOpts);
+}
+/**
+ * ConcurrentModification (https://docs.commercetools.com/api/errors#concurrentmodification)
+ * Returned when the request conflicts with the current state of the involved resources. Typically, the request attempts to modify a resource that is out of date (that is modified by another client since it was last retrieved). The client application should resolve the conflict (with or without involving the end-user) before retrying the request.
+ */
+export declare class ErrorConcurrentModification extends Errorx {
+    constructor(resourceId: string, expectedVersion: number, currentVersion: number, additionalOpts?: ErrorxAdditionalOpts);
+}