globalpayments-api 2.0.1 → 3.1.0

package/.eslintignore

@@ -0,0 +1,9 @@
+bin/
+config/
+examples/
+lib/
+netsuite/
+
+/**/node_modules/*
+node_modules/
+tsconfig.json

package/.eslintrc.cjs

@@ -0,0 +1,39 @@
+/* eslint-env node */
+module.exports = {
+  extends: [
+    "plugin:@typescript-eslint/recommended",
+    "plugin:prettier/recommended",
+  ],
+  parser: "@typescript-eslint/parser",
+  plugins: ["@typescript-eslint"],
+  parserOptions: {
+    tsconfigRootDir: __dirname,
+  },
+  root: true,
+  overrides: [
+    {
+      files: ["./src/*.ts"],
+      extends: ["plugin:@typescript-eslint/disable-type-checked"],
+      rules: {
+        "@typescript-eslint/tslint/config": ["off"],
+      },
+    },
+  ],
+  rules: {
+    "@typescript-eslint/ban-types": "off",
+    "@typescript-eslint/no-explicit-any": "off",
+    "@typescript-eslint/no-misused-new": "off",
+    "@typescript-eslint/ban-ts-comment": "off",
+    indent: [
+      "error",
+      2,
+      {
+        SwitchCase: 1,
+        ObjectExpression: 1,
+        MemberExpression: 1,
+        FunctionDeclaration: { body: 1, parameters: 2 },
+        ignoredNodes: ["ConditionalExpression"],
+      },
+    ],
+  },
+};

package/.prettierrc

@@ -1,4 +1,14 @@
-{
-  "arrowParens": "always",
-  "trailingComma": "all"
-}
+{
+  "arrowParens": "always",
+  "trailingComma": "all",
+  "indent": [
+    "error",
+    2,
+    {
+      "SwitchCase": 1,
+      "ObjectExpression": 1,
+      "MemberExpression": 1,
+      "FunctionDeclaration": { "body": 1, "parameters": 2 }
+    }
+  ]
+}

package/CHANGELOG.md

@@ -1,26 +1,44 @@
-# Changelog
-
-## Latest
-
-#### Configuration via Service Containers
-
-- From now on we are going to use containers in order to configure the services in Node SDK.
-
-## v1.4.9 (05/17/23)
-
-#### Profac Enhancements
-
-- Profac Implementation - Implement profac functionality.
-
-#### Reporting Enhancements
-
-- SdkNameVersion Identifier: Name and Version of the SDK used for integration, where applicable. 
-
-## v1.4.8 (12/13/22)
-
-#### Enhancements
-
-- Portico Connector: WalletData element added to process ApplePay/GooglePay Transactions using 
-  Digital Tokens
-
-## v1.4.7 (11/17/22)
+# Changelog
+
+## Latest - v3.1.0 (10/31/23)
+
+### Enhancements:
+
+- [GP-API] Generate Access Token for GP API users
+  - https://developer.globalpay.com/api/access-token
+
+### Bug Fixes:
+
+- Change tslint with eslint and fix existing lint errors
+
+## v3.0.0 (10/03/23)
+
+### Enhancements:
+
+- Upgrade Typescript to v5 to use latest functionalities
+
+## v2.0.0 (09/21/23)
+
+### Enhancements:
+
+- [GP-ECOM] Add configuration and use it in existing functionality
+- From now on we are going to use containers in order to configure the services in Node SDK.
+
+## v1.4.9 (05/17/23)
+
+#### Profac Enhancements
+
+- Profac Implementation - Implement profac functionality.
+
+#### Reporting Enhancements
+
+- SdkNameVersion Identifier: Name and Version of the SDK used for integration, where applicable. 
+
+## v1.4.8 (12/13/22)
+
+#### Enhancements
+
+- Portico Connector: WalletData element added to process ApplePay/GooglePay Transactions using 
+  Digital Tokens
+
+## v1.4.7 (11/17/22)

package/package.json

@@ -1,55 +1,65 @@
-{
-  "name": "globalpayments-api",
-  "version": "2.0.1",
-  "description": "Global Payments SDK for NodeJS for Heartland and Global Payments eCommerce gateways",
-  "author": "Heartland Payment Systems",
-  "license": "GPL-2.0",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/globalpayments/node-sdk.git"
-  },
-  "main": "./lib/src/index.js",
-  "typings": "./lib/src/index",
-  "scripts": {
-    "build": "tsc",
-    "build:netsuite": "webpack --env.GP_NETSUITE_BUILD --config config/webpack.netsuite.js && node bin/netsuite-post.js",
-    "build:clean": "rimraf lib",
-    "docs": "typedoc --mode file --name \"GlobalPayments.Api\" --project tsconfig.json --out docs src",
-    "format": "prettier --write --config .prettierrc 'src/**/*.ts' 'test/**/*.ts' '*.md'",
-    "prepublish": "npm-run-all build",
-    "pretest": "npm-run-all build:clean build",
-    "test": "ava",
-    "test:lint": "tslint --project tsconfig.json src"
-  },
-  "dependencies": {
-    "@azz/elementtree": "^0.1.6",
-    "es6-promise": "^4.2.8",
-    "sha1": "^1.1.1",
-    "typedarray": "^0.0.6",
-    "url": "^0.11.0"
-  },
-  "devDependencies": {
-    "@hitc/netsuite-types": "^2017.2.32",
-    "@types/node": "^12.20.7",
-    "ava": "^0.17.0",
-    "awesome-typescript-loader": "^3.5.0",
-    "npm-run-all": "^4.1.5",
-    "prettier": "^1.18.2",
-    "rimraf": "^2.6.3",
-    "tslint": "^4.5.1",
-    "typedoc": "^0.22.13",
-    "typescript": "4.2.3",
-    "webpack": "^3.12.0"
-  },
-  "ava": {
-    "concurrency": 1,
-    "timeout": "5m",
-    "failFast": true,
-    "files": [
-      "lib/test/**/*Test.js"
-    ],
-    "source": [
-      "lib/src/**/*.js"
-    ]
-  }
-}
+{
+  "name": "globalpayments-api",
+  "version" : "3.1.0",
+  "description": "Global Payments SDK for NodeJS for Heartland and Global Payments eCommerce gateways",
+  "author": "Heartland Payment Systems",
+  "license": "GPL-2.0",
+  "engines": {
+    "node": ">=16.20.2"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/globalpayments/node-sdk.git"
+  },
+  "main": "./lib/src/index.js",
+  "typings": "./lib/src/index",
+  "scripts": {
+    "build": "tsc",
+    "build:netsuite": "webpack --env.GP_NETSUITE_BUILD --config config/webpack.netsuite.js && node bin/netsuite-post.js",
+    "build:clean": "rimraf lib",
+    "docs": "typedoc --mode file --name \"GlobalPayments.Api\" --project tsconfig.json --out docs src",
+    "format": "prettier --write --config .prettierrc 'src/**/*.ts' 'test/**/*.ts' '*.md'",
+    "prebuild": "npm-run-all test:lint",
+    "prepublish": "npm-run-all build",
+    "pretest": "npm-run-all build:clean test:lint build",
+    "test:without-report": "ava",
+    "test": "ava --tap | npx tap-nyan",
+    "test:lint": "eslint \"src/**/*.ts*\" \"test/**/*.ts\""
+  },
+  "dependencies": {
+    "@azz/elementtree": "^0.1.6",
+    "es6-promise": "^4.2.8",
+    "eslint-config-prettier": "^9.0.0",
+    "sha1": "^1.1.1",
+    "typedarray": "^0.0.6",
+    "url": "^0.11.0"
+  },
+  "devDependencies": {
+    "@hitc/netsuite-types": "^2017.2.32",
+    "@types/node": "20.6.0",
+    "@typescript-eslint/eslint-plugin": "^6.7.3",
+    "@typescript-eslint/parser": "^6.7.3",
+    "ava": "^5.3.1",
+    "eslint": "^8.50.0",
+    "eslint-plugin-prettier": "^5.0.0",
+    "npm-run-all": "^4.1.5",
+    "prettier": "3.0.3",
+    "rimraf": "^2.6.3",
+    "tslint": "^6.1.3",
+    "typedoc": "0.25.1",
+    "typescript": "5.2.2",
+    "webpack": "^5.88.2"
+  },
+  "ava": {
+    "concurrency": 1,
+    "timeout": "5m",
+    "failFast": false,
+    "failWithoutAssertions": false,
+    "files": [
+      "lib/test/**/*Test.js"
+    ],
+    "source": [
+      "lib/src/**/*.js"
+    ]
+  }
+}

package/tsconfig.eslint.json

@@ -0,0 +1,15 @@
+{
+    // extend your base config to share compilerOptions, etc
+    "extends": "./tsconfig.json",
+    "compilerOptions": {
+      // ensure that nobody can accidentally use this config for a build
+      "noEmit": true
+    },
+    "include": [
+      // whatever paths you intend to lint
+      "src",
+      "test",
+      "tools"
+    ]
+  }
+

package/lib/src/Builders/AuthorizationBuilder.d.ts

@@ -1,325 +0,0 @@
-import { Address, AddressType, AliasAction, EcommerceInfo, GiftCard, HostedPaymentData, InquiryType, IPaymentMethod, RecurringSequence, RecurringType, StoredCredentialInitiator, Transaction } from "../";
-import { TransactionBuilder } from "./TransactionBuilder";
-export declare class AuthorizationBuilder extends TransactionBuilder<Transaction> {
-    alias: string;
-    aliasAction: AliasAction;
-    allowDuplicates: boolean;
-    allowPartialAuth: boolean;
-    amount: string | number;
-    authAmount: string | number;
-    balanceInquiryType: InquiryType;
-    billingAddress: Address;
-    cardBrandTransactionId: string;
-    cashBackAmount: string | number;
-    clientTransactionId: string;
-    currency: string;
-    customerId: string;
-    customerIpAddress: string;
-    cvn: string;
-    description: string;
-    dynamicDescriptor: string;
-    ecommerceInfo: EcommerceInfo;
-    gratuity: string | number;
-    convenienceAmt: string | number;
-    shippingAmt: string | number;
-    hostedPaymentData: HostedPaymentData;
-    invoiceNumber: string;
-    level2Request: boolean;
-    offlineAuthCode: string;
-    oneTimePayment: boolean;
-    orderId: string;
-    productId: string;
-    recurringSequence: RecurringSequence;
-    recurringType: RecurringType;
-    requestMultiUseToken: boolean;
-    replacementCard: GiftCard;
-    scheduleId: string;
-    shippingAddress: Address;
-    timestamp: string;
-    transactionInitiator: StoredCredentialInitiator;
-    constructor(type: number, paymentMethod?: IPaymentMethod);
-    /**
-     * Executes the authorization builder against the gateway.
-     *
-     * @returns Promise<Transaction>
-     */
-    execute(configName?: string): Promise<Transaction>;
-    /**
-     * Serializes an authorization builder for hosted payment page requests.
-     *
-     * Requires the gateway and account support hosted payment pages.
-     *
-     * @throws UnsupportedTransactionError Thrown when gateway doesn't support hosted payments
-     * @returns string
-     */
-    serialize(): string;
-    protected setupValidations(): void;
-    /**
-     * Sets an address value; where applicable.
-     *
-     * Currently supports billing and shipping addresses.
-     *
-     * @param address The desired address information
-     * @param addressType The desired address type
-     * @returns AuthorizationBuilder
-     */
-    withAddress(address?: Address, addressType?: AddressType): this;
-    withAlias(aliasAction: AliasAction, alias?: string): this;
-    /**
-     * Allows duplicate transactions by skipping the
-     * gateway's duplicate checking.
-     *
-     * @param allowDuplicates The duplicate skip flag
-     * @returns AuthorizationBuilder
-     */
-    withAllowDuplicates(allowDuplicates?: boolean): this;
-    /**
-     * Allows partial authorizations to occur.
-     *
-     *
-     * @param allowPartialAuth The allow partial flag
-     * @returns AuthorizationBuilder
-     */
-    withAllowPartialAuth(allowPartialAuth?: boolean): this;
-    /**
-     * Sets the transaction's amount
-     *
-     * @param amount The amount
-     * @returns AuthorizationBuilder
-     */
-    withAmount(amount?: string | number): this;
-    /**
-     * Sets the transaction's authorization amount; where applicable.
-     *
-     * This is a specialized field. In most cases,
-     * `Authorization.withAmount` should be used.
-     *
-     * @param authAmount The authorization amount
-     * @returns AuthorizationBuilder
-     */
-    withAuthAmount(authAmount?: string | number): this;
-    withBalanceInquiryType(inquiry?: InquiryType): this;
-    /**
-     * Sets Credential on File fields
-     */
-    withCardBrandStorage(transactionInitiator: StoredCredentialInitiator, value?: string): this;
-    /**
-     * Sets the cash back amount.
-     *
-     * This is a specialized field for debit or EBT transactions.
-     *
-     * @param amount The desired cash back amount
-     * @returns AuthorizationBuilder
-     */
-    withCashBack(amount?: string | number): this;
-    /**
-     * Sets the client transaction ID.
-     *
-     * This is an application derived value that can be used to identify a
-     * transaction in case a gateway transaction ID is not returned, e.g.
-     * in cases of timeouts.
-     *
-     * The supplied value should be unique to the configured merchant or
-     * terminal account.
-     *
-     * @param clientTransactionId The client transaction ID
-     * @returns AuthorizationBuilder
-     */
-    withClientTransactionId(clientTransactionId?: string): this;
-    /**
-     * Sets the transaction's currency; where applicable.
-     *
-     * The formatting for the supplied value will currently depend on
-     * the configured gateway's requirements.
-     *
-     * @param currency The currency
-     * @returns AuthorizationBuilder
-     */
-    withCurrency(currency?: string): this;
-    /**
-     * Sets the customer ID; where applicable.
-     *
-     * This is an application/merchant generated value.
-     *
-     * @param customerId The customer ID
-     * @returns AuthorizationBuilder
-     */
-    withCustomerId(customerId?: string): this;
-    /**
-     * Sets the customer's IP address; where applicable.
-     *
-     * This value should be obtained during the payment process.
-     *
-     * @param customerIpAddress The customer's IP address
-     * @returns AuthorizationBuilder
-     */
-    withCustomerIpAddress(customerIpAddress?: string): this;
-    /**
-     * Sets the CVN value for recurring payments; where applicable.
-     *
-     * @param cvn CVN value to use in the request
-     * @returns AuthorizationBuilder
-     */
-    withCvn(cvn?: string): this;
-    /**
-     * Sets the transaction's description.
-     *
-     * This value is not guaranteed to be sent in the authorization
-     * or settlement process.
-     *
-     * @param description The description
-     * @returns AuthorizationBuilder
-     */
-    withDescription(description?: string): this;
-    /**
-     * Sets the transaction's dynamic descriptor.
-     *
-     * This value is sent during the authorization process and is displayed
-     * in the consumer's account.
-     *
-     * @param dynamicDescriptor The dynamic descriptor
-     * @returns AuthorizationBuilder
-     */
-    withDynamicDescriptor(dynamicDescriptor?: string): this;
-    /**
-     * Sets eCommerce specific data; where applicable.
-     *
-     * This can include:
-     *
-     *   - Consumer authentication (3DSecure) data
-     *   - Direct market data
-     *
-     * @param ecommerceInfo The eCommerce data
-     * @returns AuthorizationBuilder
-     */
-    withEcommerceInfo(ecommerceInfo?: EcommerceInfo): this;
-    /**
-     * Sets the gratuity amount; where applicable.
-     *
-     * This value is information only and does not affect
-     * the authorization amount.
-     *
-     * @param gratuity The gratuity amount
-     * @returns AuthorizationBuilder
-     */
-    withGratuity(gratuity?: string | number): this;
-    /**
-     * Sets the Convenience amount; where applicable.
-     *
-     * @param convenienceAmt The Convenience amount
-     * @returns AuthorizationBuilder
-     */
-    withConvenienceAmt(convenienceAmt?: string | number): this;
-    /**
-     * Sets the Shipping amount; where applicable.
-     *
-     * @param shippingAmt The Shipping amount
-     * @returns AuthorizationBuilder
-     */
-    withShippingAmt(shippingAmt?: string | number): this;
-    /**
-     * Additional hosted payment specific information for Realex HPP implementation.
-     *
-     * @param hostedPaymentData The hosted payment data
-     * @returns AuthorizationBuilder
-     */
-    withHostedPaymentData(hostedPaymentData?: HostedPaymentData): this;
-    /**
-     * Sets the invoice number; where applicable.
-     *
-     * @param invoiceNumber The invoice number
-     * @returns AuthorizationBuilder
-     */
-    withInvoiceNumber(invoiceNumber?: string): this;
-    /**
-     * Sets the commercial request flag; where applicable.
-     *
-     * This flag indicates commercial purchase cards are accepted/expected.
-     * The application should inspect the transaction response and pass the
-     * appropriate Level II data when necessary.
-     *
-     * @param level2Request The commercial request flag
-     * @returns AuthorizationBuilder
-     */
-    withCommercialRequest(level2Request?: boolean): this;
-    /**
-     * Sets the offline authorization code; where applicable.
-     *
-     * The merchant is required to supply this value as obtained when
-     * calling the issuing bank for the authorization.
-     *
-     * @param offlineAuthCode The offline authorization code
-     * @returns AuthorizationBuilder
-     */
-    withOfflineAuthCode(offlineAuthCode?: string): this;
-    /**
-     * Sets the one-time payment flag; where applicable.
-     *
-     * This is only useful when using recurring payment profiles for
-     * one-time payments that are not a part of a recurring schedule.
-     *
-     * @param oneTimePayment The one-time flag
-     * @returns AuthorizationBuilder
-     */
-    withOneTimePayment(oneTimePayment?: boolean): this;
-    /**
-     * Sets the transaction's order ID; where applicable.
-     *
-     * @param orderId The order ID
-     * @returns AuthorizationBuilder
-     */
-    withOrderId(orderId?: string): this;
-    /**
-     * Sets the transaction's product ID; where applicable.
-     *
-     * @param productId The product ID
-     * @returns AuthorizationBuilder
-     */
-    withProductId(productId?: string): this;
-    /**
-     * Sets the Recurring Info for Realex based recurring payments;
-     * where applicable.
-     *
-     * @param type The value can be 'fixed' or 'variable' depending on whether
-     *             the amount will change for each transaction.
-     * @param sequence  Indicates where in the recurring sequence the transaction
-     *                  occurs. Must be 'first' for the first transaction for this
-     *                  card, 'subsequent' for transactions after that, and 'last'
-     *                  for the final transaction of the set.
-     * @returns AuthorizationBuilder
-     */
-    withRecurringInfo(type?: RecurringType, sequence?: RecurringSequence): this;
-    /**
-     * Requests multi-use tokenization / card storage.
-     *
-     * This will depend on a successful transaction. If there was a failure
-     * or decline, the multi-use tokenization / card storage will not be
-     * successful.
-     *
-     * @param requestMultiUseToken The request flag
-     * @returns AuthorizationBuilder
-     */
-    withRequestMultiUseToken(requestMultiUseToken?: boolean): this;
-    withReplacementCard(replacementCard?: GiftCard): this;
-    /**
-     * Sets the schedule ID associated with the transaction; where applicable.
-     *
-     * This is specific to transactions against recurring profiles that are
-     * a part of a recurring schedule.
-     *
-     * @param scheduleId The schedule ID
-     * @returns AuthorizationBuilder
-     */
-    withScheduleId(scheduleId?: string): this;
-    /**
-     * Sets the related gateway transaction ID; where applicable.
-     *
-     * This value is used to associated a previous transaction with the
-     * current transaction.
-     *
-     * @param transactionId The gateway transaction ID
-     * @returns AuthorizationBuilder
-     */
-    withTransactionId(transactionId?: string): this;
-    withTimestamp(timestamp?: string): this;
-}