@unchainedshop/plugins 1.1.3 → 1.1.4

package/src/payment/datatrans-v2/api/types.d.ts

@@ -0,0 +1,378 @@
+export type Address = {
+  gender?: 'female' | 'male';
+  title?: string;
+  name?: string;
+  firstName?: string;
+  lastName?: string;
+  email?: string;
+  street?: string;
+  street2?: string;
+  zipCode?: string;
+  city?: string;
+  country?: string;
+};
+
+export type BillingAddress = Address & {
+  countrySubdivision?: string;
+  sortingCode?: string;
+  phoneNumber?: string;
+};
+
+export type ShippingAddress = Address & {
+  countrySubdivision?: string;
+  sortingCode?: string;
+  phone?: string;
+  cellPhone?: string;
+  carrier?: string;
+  price?: number;
+  priceGross?: number;
+};
+
+export type Customer = Address & {
+  id?: string;
+  phone?: string;
+  cellPhone?: string;
+  birthDate?: string; // YYYY-MM-DD
+  language?: string;
+  type?: 'P' | 'C'; // c = company, companyRegisterNumber + name required
+  companyLegalForm?: string;
+  companyRegisterNumber?: string;
+  ipAddress?: string;
+};
+
+export type Order = {
+  articles: Record<string, unknown>;
+  taxAmount: number;
+  shippingAmount: number;
+  discountAmount: number;
+};
+
+export type DT2015Configuration = {
+  brandColor: string;
+  textColor: 'white' | 'black';
+  logoType: 'circle' | 'rectangle' | 'none';
+  logoBorderColor: string;
+  brandButton: string;
+  payButtonTextColor: string;
+  logoSrc: string;
+  initialView: 'list' | 'grid';
+  brandTitle: string;
+};
+
+export type SupportedLanguage =
+  | 'de'
+  | 'en'
+  | 'fr'
+  | 'it'
+  | 'es'
+  | 'el'
+  | 'no'
+  | 'da'
+  | 'pl'
+  | 'pt'
+  | 'ru'
+  | 'ja';
+
+export type PaymentMethod =
+  | 'ACC'
+  | 'ALP'
+  | 'APL'
+  | 'AMX'
+  | 'AZP'
+  | 'BON'
+  | 'CFY'
+  | 'CSY'
+  | 'CUP'
+  | 'DIN'
+  | 'DII'
+  | 'DIB'
+  | 'DIS'
+  | 'DNK'
+  | 'ECA'
+  | 'ELV'
+  | 'EPS'
+  | 'ESY'
+  | 'INT'
+  | 'JCB'
+  | 'JEL'
+  | 'KLN'
+  | 'MAU'
+  | 'MDP'
+  | 'MFX'
+  | 'MPX'
+  | 'MYO'
+  | 'PAP'
+  | 'PAY'
+  | 'PEF'
+  | 'PFC'
+  | 'PSC'
+  | 'REK'
+  | 'SAM'
+  | 'SWB'
+  | 'SCX'
+  | 'SWP'
+  | 'TWI'
+  | 'UAP'
+  | 'VIS'
+  | 'WEC';
+
+export type TransactionType = 'payment' | 'credit' | 'card_check';
+
+export type TransactionStatusCode =
+  | 'initialized'
+  | 'challenge_required'
+  | 'challenge_ongoing'
+  | 'authenticated'
+  | 'authorized'
+  | 'settled'
+  | 'canceled'
+  | 'transmitted'
+  | 'failed';
+
+export type ResponseError = {
+  error: {
+    code:
+      | 'UNKNOWN_ERROR'
+      | 'UNAUTHORIZED'
+      | 'INVALID_JSON_PAYLOAD'
+      | 'UNRECOGNIZED_PROPERTY'
+      | 'INVALID_PROPERTY'
+      | 'CLIENT_ERROR'
+      | 'SERVER_ERROR'
+      | 'INVALID_TRANSACTION_STATUS'
+      | 'TRANSACTION_NOT_FOUND'
+      | 'EXPIRED_CARD'
+      | 'INVALID_CARD'
+      | 'BLOCKED_CARD'
+      | 'UNSUPPORTED_CARD'
+      | 'INVALID_ALIAS'
+      | 'INVALID_CVV'
+      | 'DUPLICATE_REFNO'
+      | 'DECLINED'
+      | 'SOFT_DECLINED'
+      | 'INVALID_SIGN'
+      | 'BLOCKED_BY_VELOCITY_CHECKER'
+      | 'THIRD_PARTY_ERROR'
+      | 'REFERRAL'
+      | 'INVALID_SETUP';
+    message: string;
+  };
+};
+
+type Split = {
+  subMerchantId: string;
+  amount: number;
+  commission: number;
+};
+
+export type Marketplace = {
+  splits: Split[];
+};
+
+export type InitRequestPayload = {
+  endpoint: string;
+  secret: string;
+  merchantId: string;
+  currency: string;
+  refno: string;
+  refno2?: string; // optional
+  amount?: number; // omit if only for registration
+  customer?: Customer;
+  billing?: BillingAddress;
+  shipping?: ShippingAddress;
+  order?: Order;
+  card?: Record<string, unknown>;
+  BON?: Record<string, unknown>;
+  PAP?: Record<string, unknown>;
+  PFC?: Record<string, unknown>;
+  REK?: Record<string, unknown>;
+  KLN?: Record<string, unknown>;
+  TWI?: Record<string, unknown>;
+  INT?: Record<string, unknown>;
+  ESY?: Record<string, unknown>;
+  SWP?: Record<string, unknown>;
+  MFX?: Record<string, unknown>;
+  MPX?: Record<string, unknown>;
+  AZP?: Record<string, unknown>;
+  EPS?: Record<string, unknown>;
+  ALP?: Record<string, unknown>;
+  WEC?: Record<string, unknown>;
+  SWB?: Record<string, unknown>;
+  MDF?: Record<string, unknown>;
+  PSC?: Record<string, unknown>;
+  airlineData?: Record<string, unknown>;
+  language?: SupportedLanguage;
+  paymentMethods?: PaymentMethod[];
+  theme?: {
+    configuration: DT2015Configuration;
+  };
+  redirect?: {
+    successUrl?: string;
+    cancelUrl?: string;
+    errorUrl?: string;
+    startTarget?: string;
+    returnTarget?: string;
+    method?: 'GET' | 'POST';
+  };
+  option?: {
+    createAlias?: boolean;
+    returnMaskedCardNumber?: boolean;
+    returnCustomerCountry?: boolean;
+    authenticationOnly?: boolean;
+    rememberMe?: 'true' | 'checked';
+    returnMobileToken?: boolean;
+  };
+};
+
+export type InitResponseSuccess = {
+  transactionId: string;
+  mobileToken?: string;
+  WEC?: Record<string, unknown>;
+  ['3D']?: Record<string, unknown>;
+  location?: string;
+};
+
+export type StatusRequestPayload = {
+  transactionId: string;
+};
+
+export type StatusResponseSuccess = {
+  transactionId: string;
+  type: TransactionType;
+  status: TransactionStatusCode;
+  currency: string;
+  refno: string;
+  refno2: string;
+  paymentMethod: PaymentMethod;
+  detail: Record<string, unknown>;
+  customer?: Customer;
+  cdm?: Record<string, unknown>;
+  language: SupportedLanguage;
+  card?: Record<string, unknown>;
+  TWI?: Record<string, unknown>;
+  PAP?: Record<string, unknown>;
+  REK?: Record<string, unknown>;
+  ELV?: Record<string, unknown>;
+  KLN?: Record<string, unknown>;
+  INT?: Record<string, unknown>;
+  SWP?: Record<string, unknown>;
+  MFX?: Record<string, unknown>;
+  MPX?: Record<string, unknown>;
+  MDP?: Record<string, unknown>;
+  ESY?: Record<string, unknown>;
+  PFC?: Record<string, unknown>;
+  WEC?: Record<string, unknown>;
+  SCX?: Record<string, unknown>;
+  history: Record<string, unknown>[];
+  ep2?: Record<string, unknown>;
+};
+
+export type SecureFieldsRequestPayload = {
+  currency: string;
+  returnUrl?: string;
+  amount?: number;
+  ['3D']?: Record<string, unknown>;
+};
+
+export type SecureFieldsResponseSuccess = {
+  transactionId: string;
+};
+
+export type AuthorizeRequestPayload = {
+  amount: number;
+  currency: string;
+  refno: string;
+  refno2?: string;
+  autoSettle?: boolean;
+  customer?: Customer;
+  billing?: BillingAddress;
+  shipping?: ShippingAddress;
+  order?: Order;
+  card?: Record<string, unknown>;
+  BON?: Record<string, unknown>;
+  PAP?: Record<string, unknown>;
+  PFC?: Record<string, unknown>;
+  REK?: Record<string, unknown>;
+  KLN?: Record<string, unknown>;
+  TWI?: Record<string, unknown>;
+  INT?: Record<string, unknown>;
+  ESY?: Record<string, unknown>;
+  ACC?: Record<string, unknown>;
+  PAY?: Record<string, unknown>;
+  APL?: Record<string, unknown>;
+  SWB?: Record<string, unknown>;
+  airlineData?: Record<string, unknown>;
+  marketplace?: Marketplace;
+};
+
+export type AuthorizeResponseSuccess = {
+  transactionId: string;
+  acquirerAuthorizationCode?: string;
+};
+
+export type AuthorizeAuthenticatedRequestPayload = {
+  transactionId: string;
+  refno: string;
+  amount?: number;
+  currency?: string;
+  refno2?: string;
+  autoSettle?: boolean;
+  CDM?: Record<string, unknown>;
+  ['3D']?: Record<string, unknown>;
+};
+
+export type AuthorizeAuthenticatedResponseSuccess = {
+  acquirerAuthorizationCode: string;
+};
+
+export type ValidateRequestPayload = {
+  currency: string;
+  refno: string;
+  refno2?: string;
+  card?: Record<string, unknown>;
+  PFC?: Record<string, unknown>;
+  KLN?: Record<string, unknown>;
+  PAP?: Record<string, unknown>;
+  PAY?: Record<string, unknown>;
+  APL?: Record<string, unknown>;
+  ESY?: Record<string, unknown>;
+};
+
+export type ValidateResponseSuccess = {
+  transactionId: string;
+  acquirerAuthorizationCode?: string;
+};
+
+export type SettleRequestPayload = {
+  transactionId: string;
+  amount: number;
+  currency: string;
+  refno: string;
+  refno2?: string;
+  airlineData?: Record<string, unknown>;
+  marketplace?: Marketplace;
+  extensions?: Record<string, string>;
+};
+
+export type CancelRequestPayload = {
+  transactionId: string;
+  refno: string;
+};
+
+export type InitResponse = InitResponseSuccess | ResponseError;
+
+export type SecureFieldsResponse = SecureFieldsResponseSuccess | ResponseError;
+
+export type StatusResponse = StatusResponseSuccess | ResponseError;
+
+export type AuthorizeResponse = AuthorizeResponseSuccess | ResponseError;
+
+export type AuthorizeAuthenticatedResponse = AuthorizeAuthenticatedResponseSuccess | ResponseError;
+
+export type ValidateResponse = ValidateResponseSuccess | ResponseError;
+
+export type SettleResponse = true | ResponseError;
+
+export type CancelResponse = true | ResponseError;
+
+export type FetchDatatransFn = (path: string, body?: unknown) => Promise<Response>;

package/src/payment/datatrans-v2/api/validate.ts

@@ -0,0 +1,13 @@
+import type { FetchDatatransFn, ValidateRequestPayload, ValidateResponse } from './types';
+
+export default async function validate(payload: ValidateRequestPayload): Promise<ValidateResponse> {
+  const { fetchDatatrans }: { fetchDatatrans: FetchDatatransFn } = this;
+
+  const reqBody = {
+    ...payload,
+  };
+
+  const result = await fetchDatatrans(`/v1/transactions/validate`, reqBody);
+  const json = await result.json();
+  return json;
+}

package/src/payment/datatrans-v2/generateSignature.ts

@@ -0,0 +1,24 @@
+import crypto from 'crypto';
+
+export const Security = {
+  NONE: '',
+  STATIC_SIGN: 'static-sign',
+  DYNAMIC_SIGN: 'dynamic-sign',
+};
+
+const generateSignature =
+  ({ security, signKey }: { security: '' | 'static-sign' | 'dynamic-sign'; signKey: string }) =>
+  (...parts) => {
+    // https://docs.datatrans.ch/docs/security-sign
+    if (security.toLowerCase() === Security.STATIC_SIGN) return signKey;
+    if (security.toLowerCase() === Security.NONE) return '';
+
+    const resultString = parts.filter(Boolean).join('');
+    const signKeyInBytes = Buffer.from(signKey, 'hex');
+
+    const signedString = crypto.createHmac('sha256', signKeyInBytes).update(resultString).digest('hex');
+
+    return signedString;
+  };
+
+export default generateSignature;

package/src/payment/datatrans-v2/getPaths.ts

@@ -0,0 +1,24 @@
+const {
+  ROOT_URL,
+  DATATRANS_WEBHOOK_PATH,
+  DATATRANS_SUCCESS_PATH,
+  DATATRANS_ERROR_PATH,
+  DATATRANS_CANCEL_PATH,
+  DATATRANS_RETURN_PATH,
+} = process.env;
+
+type Paths = {
+  postUrl: string;
+  cancelUrl: string;
+  successUrl: string;
+  errorUrl: string;
+  returnUrl: string;
+};
+
+export default (relative = false): Paths => ({
+  postUrl: `${relative ? '' : ROOT_URL}${DATATRANS_WEBHOOK_PATH || '/payment/datatrans/webhook'}`,
+  successUrl: `${relative ? '' : ROOT_URL}${DATATRANS_SUCCESS_PATH || '/payment/datatrans/success'}`,
+  cancelUrl: `${relative ? '' : ROOT_URL}${DATATRANS_CANCEL_PATH || '/payment/datatrans/cancel'}`,
+  errorUrl: `${relative ? '' : ROOT_URL}${DATATRANS_ERROR_PATH || '/payment/datatrans/error'}`,
+  returnUrl: `${relative ? '' : ROOT_URL}${DATATRANS_RETURN_PATH || '/payment/datatrans/return'}`,
+});