payrex-node 0.1.0

package/.prettierrc

@@ -0,0 +1,4 @@
+{
+  "trailingComma": "es5",
+  "singleQuote": true
+}

package/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## [0.1.0] - 2024-05-21
+
+- Initial alpha release.

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) Evolut10n Labs, Inc. (https://payrexhq.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,76 @@
+# PayRex Node.js
+
+PayRex Node library provides Node applications an easy access to the PayRex API. Explore various classes that represents PayRex API resources on object instantiation.
+
+## Requirements
+
+Node 12 or higher.
+
+## Gems
+
+If you want to use the package, run the following command:
+
+```sh
+npm install payrex-node
+# or
+yarn add payrex-node
+```
+
+## Getting Started
+
+Simple usage looks like:
+
+```js
+const payrex = require('payrex-node')('sk_test_...');
+
+payrex.paymentIntents.retrieve('pi_...')
+  .then(paymentIntent => console.log(paymentIntent.id))
+
+payrex.paymentIntents.create({
+  amount: 10000,
+  currency: 'PHP',
+  description: 'Dino Treat',
+  payment_methods: ['gcash', 'card']
+})
+  .then(paymentIntent => console.log(paymentIntent.id))
+```
+
+Or using async/await:
+
+```js
+const payrex = require('payrex-node')('sk_test_...');
+
+const paymentIntent = await payrex.paymentIntents.retrieve('pi_...');
+
+console.log(paymentIntent.id);
+```
+
+## Handle errors
+
+```js
+const payrex = require('payrex-node')('sk_test_...');
+
+payrex.paymentIntents.create({
+  amount: 10000
+})
+  .then(paymentIntent => console.log(paymentIntent.id))
+  .catch(error => {
+    // Handle errors
+    console.error(error.name);
+    console.error(error.errors);
+  });
+```
+
+## Verify webhook signature
+
+```js
+try {
+  payload = '{"id":"evt_...","resource":"event","type":"payment_intent.succeeded","data":{...';
+  signatureHeader = 't=1715236958,te=,li=...';
+  webhookSecretKey = 'whsk_...';
+
+  payrex.webhooks.parseEvent(payload, signatureHeader, webhookSecretKey);
+} catch (error) {
+  // Handle invalid signature
+}
+```

package/eslint.config.mjs

@@ -0,0 +1,9 @@
+import globals from "globals";
+import pluginJs from "@eslint/js";
+
+
+export default [
+  {files: ["**/*.js"], languageOptions: {sourceType: "commonjs"}},
+  {languageOptions: { globals: globals.browser }},
+  pluginJs.configs.recommended,
+];

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "payrex-node",
+  "version": "0.1.0",
+  "description": "PayRex Node JS Library",
+  "keywords": [
+    "payrex",
+    "payment processing",
+    "credit cards",
+    "api"
+  ],
+  "homepage": "https://github.com/payrexhq/payrex-node",
+  "author": "PayRex <support@payrexhq.com> (https://payrexhq.com/)",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/payrexhq/payrex-node.git"
+  },
+  "bugs": {
+    "url": "https://github.com/payrexhq/payrex-node/issues"
+  },
+  "engines": {
+    "node": ">=12.*"
+  },
+  "main": "src/Client.js",
+  "devDependencies": {
+    "@eslint/js": "^9.3.0",
+    "eslint": "^9.3.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.1.3",
+    "globals": "^15.3.0",
+    "prettier": "^3.2.5"
+  },
+  "dependencies": {
+    "axios": "^1.6.8",
+    "qs": "^6.12.1"
+  },
+  "license": "MIT",
+  "scripts": {
+    "lint": "eslint ."
+  }
+}

package/src/ApiResource.js

@@ -0,0 +1,5 @@
+function ApiResource(response) {
+  this.data = response;
+}
+
+module.exports = ApiResource;

package/src/Client.js

@@ -0,0 +1,19 @@
+const Config = require('./Config');
+const services = require('./services');
+
+function initializeServices(client) {
+  for (const service in services) {
+    if (Object.prototype.hasOwnProperty.call(services, service)) {
+      client[service] = new services[service](client);
+    }
+  }
+}
+
+function Client(apiKey) {
+  this.config = new Config(apiKey);
+  initializeServices(this);
+
+  return this;
+}
+
+module.exports = Client;

package/src/Config.js

@@ -0,0 +1,6 @@
+function Config(apiKey) {
+  this.apiBaseUrl = 'https://api.payrexhq.com';
+  this.apiKey = apiKey;
+}
+
+module.exports = Config;

package/src/Error.js

@@ -0,0 +1,7 @@
+function Error(error) {
+  this.code = error.code;
+  this.detail = error.detail;
+  this.parameter = error.parameter;
+}
+
+module.exports = Error;

package/src/HttpClient.js

@@ -0,0 +1,55 @@
+const axios = require('axios');
+const qs = require('qs');
+
+const ApiResource = require('./ApiResource');
+const RequestInvalidError = require('./errors/RequestInvalidError');
+const AuthenticationInvalidError = require('./errors/AuthenticationInvalidError');
+const ResourceNotFoundError = require('./errors/ResourceNotFoundError');
+const BaseError = require('./errors/BaseError');
+
+function HttpClient(apiKey, baseUrl) {
+  this.apiKey = apiKey;
+  this.baseUrl = baseUrl;
+}
+
+HttpClient.prototype.request = async function ({ path, method, payload }) {
+  const url = `${this.baseUrl}/${path}`;
+
+  const auth = {
+    username: this.apiKey,
+    password: '',
+  };
+
+  const headers = {
+    'Content-Type': 'application/x-www-form-urlencoded',
+  };
+
+  let data = null;
+  if (method === 'post' || method === 'put') {
+    data = qs.stringify(payload, { arrayFormat: 'brackets' });
+  }
+
+  try {
+    const response = await axios.request({
+      method: method,
+      url: url,
+      auth: auth,
+      headers: headers,
+      data: data,
+    });
+
+    return new ApiResource(response.data);
+  } catch (error) {
+    if (error.response.status === 400) {
+      throw new RequestInvalidError(error.response.data);
+    } else if (error.status === 401) {
+      throw new AuthenticationInvalidError(error.response.data);
+    } else if (error.status === 404) {
+      throw new ResourceNotFoundError(error.response.data);
+    } else {
+      throw new BaseError(error.response.data);
+    }
+  }
+};
+
+module.exports = HttpClient;

package/src/entities/CheckoutSessionEntity.js

@@ -0,0 +1,26 @@
+function CheckoutSessionEntity(apiResource) {
+  const data = apiResource.data;
+
+  this.id = data.id;
+  this.resource = data.resource;
+  this.customerReferenceId = data.customer_reference_id;
+  this.clientSecret = data.client_secret;
+  this.status = data.status;
+  this.currency = data.currency;
+  this.lineItems = data.line_items;
+  this.livemode = data.livemode;
+  this.url = data.url;
+  this.paymentIntent = data.payment_intent;
+  this.metadata = data.metadata;
+  this.successUrl = data.success_url;
+  this.cancelUrl = data.cancel_url;
+  this.paymentMethods = data.payment_methods;
+  this.captureType = data.capture_type;
+  this.description = data.description;
+  this.submitType = data.submit_type;
+  this.expiresAt = data.expires_at;
+  this.createdAt = data.created_at;
+  this.updatedAt = data.updated_at;
+}
+
+module.exports = CheckoutSessionEntity;

package/src/entities/EventEntity.js

@@ -0,0 +1,13 @@
+function EventEntity(apiResource) {
+  const data = apiResource.data;
+
+  this.id = data.id;
+  this.data = data.data;
+  this.type = data.type;
+  this.pendingWebhooks = data.pending_webhooks;
+  this.previousAttributes = data.previous_attributes;
+  this.createdAt = data.created_at;
+  this.updatedAt = data.updated_at;
+}
+
+module.exports = EventEntity;

package/src/entities/ListingEntity.js

@@ -0,0 +1,6 @@
+function ListingEntity(data, hasMore) {
+  this.data = data;
+  this.hasMore = hasMore;
+}
+
+module.exports = ListingEntity;

package/src/entities/MerchantEntity.js

@@ -0,0 +1,12 @@
+function MerchantEntity(apiResource) {
+  const data = apiResource.data;
+
+  this.id = data.id;
+  this.resource = data.resource;
+  this.connectionType = data.connection_type;
+  this.livemode = data.livemode;
+  this.createdAt = data.created_at;
+  this.updatedAt = data.updated_at;
+}
+
+module.exports = MerchantEntity;

package/src/entities/PaymentIntentEntity.js

@@ -0,0 +1,24 @@
+function PaymentIntentEntity(apiResource) {
+  const data = apiResource.data;
+
+  this.id = data.id;
+  this.resource = data.resource;
+  this.amount = data.amount;
+  this.captureType = data.capture_type;
+  this.clientSecret = data.client_secret;
+  this.currency = data.currency;
+  this.description = data.description;
+  this.livemode = data.livemode;
+  this.metadata = data.metadata;
+  this.latestPayment = data.latest_payment;
+  this.paymentMethodId = data.payment_method_id;
+  this.paymentMethods = data.payment_methods;
+  this.status = data.status;
+  this.nextAction = data.next_action;
+  this.returnUrl = data.return_url;
+  this.captureBeforeAt = data.capture_before_at;
+  this.createdAt = data.created_at;
+  this.updatedAt = data.updated_at;
+}
+
+module.exports = PaymentIntentEntity;

package/src/entities/PaymentMethodEntity.js

@@ -0,0 +1,14 @@
+function PaymentMethodEntity(apiResource) {
+  const data = apiResource.data;
+
+  this.id = data.id;
+  this.resource = data.resource;
+  this.type = data.type;
+  this.billingDetails = data.billing_details;
+  this.livemode = data.livemode;
+  this.metadata = data.metadata;
+  this.createdAt = data.created_at;
+  this.updatedAt = data.updated_at;
+}
+
+module.exports = PaymentMethodEntity;

package/src/entities/RefundEntity.js

@@ -0,0 +1,19 @@
+function RefundEntity(apiResource) {
+  const data = apiResource.data;
+
+  this.id = data.id;
+  this.resource = data.resource;
+  this.amount = data.amount;
+  this.currency = data.currency;
+  this.livemode = data.livemode;
+  this.status = data.status;
+  this.description = data.description;
+  this.reason = data.reason;
+  this.remarks = data.remarks;
+  this.paymentId = data.payment_id;
+  this.metadata = data.metadata;
+  this.createdAt = data.created_at;
+  this.updatedAt = data.updated_at;
+}
+
+module.exports = RefundEntity;

package/src/entities/WebhookEntity.js

@@ -0,0 +1,16 @@
+function WebhookEntity(apiResource) {
+  const data = apiResource.data;
+
+  this.id = data.id;
+  this.resource = data.resource;
+  this.secretKey = data.secret_key;
+  this.status = data.status;
+  this.description = data.description;
+  this.livemode = data.livemode;
+  this.url = data.url;
+  this.events = data.events;
+  this.createdAt = data.created_at;
+  this.updatedAt = data.updated_at;
+}
+
+module.exports = WebhookEntity;

package/src/errors/AuthenticationInvalidError.js

@@ -0,0 +1,12 @@
+const BaseError = require('./BaseError');
+
+function AuthenticationInvalidError(response) {
+  return BaseError.call(this, response, 'AuthenticationInvalidError');
+}
+
+Object.setPrototypeOf(
+  AuthenticationInvalidError.prototype,
+  BaseError.prototype
+);
+
+module.exports = AuthenticationInvalidError;

package/src/errors/BaseError.js

@@ -0,0 +1,13 @@
+const PayrexError = require('../Error');
+
+function BaseError(response, className = 'BaseError') {
+  const baseError = new Error();
+  baseError.name = className;
+  baseError.errors = (response.errors || []).map(
+    (error) => new PayrexError(error)
+  );
+
+  return baseError;
+}
+
+module.exports = BaseError;

package/src/errors/RequestInvalidError.js

@@ -0,0 +1,9 @@
+const BaseError = require('./BaseError');
+
+function RequestInvalidError(response) {
+  return BaseError.call(this, response, 'RequestInvalidError');
+}
+
+Object.setPrototypeOf(RequestInvalidError.prototype, BaseError.prototype);
+
+module.exports = RequestInvalidError;

package/src/errors/ResourceNotFoundError.js

@@ -0,0 +1,9 @@
+const BaseError = require('./BaseError');
+
+function ResourceNotFoundError(response) {
+  return BaseError.call(this, response, 'ResourceNotFoundError');
+}
+
+Object.setPrototypeOf(ResourceNotFoundError.prototype, BaseError.prototype);
+
+module.exports = ResourceNotFoundError;

package/src/errors/SignatureInvalidError.js

@@ -0,0 +1,8 @@
+function SignatureInvalidError(message) {
+  const error = new Error(message);
+  error.name = SignatureInvalidError.name;
+
+  return error;
+}
+
+module.exports = SignatureInvalidError;

package/src/errors/ValueUnexpectedError.js

@@ -0,0 +1,8 @@
+function ValueUnexpectedError(message) {
+  const error = new Error(message);
+  error.name = ValueUnexpectedError.name;
+
+  return error;
+}
+
+module.exports = ValueUnexpectedError;

package/src/services/BaseService.js

@@ -0,0 +1,18 @@
+const HttpClient = require('../HttpClient');
+
+function BaseService(client) {
+  this.httpClient = new HttpClient(
+    client.config.apiKey,
+    client.config.apiBaseUrl
+  );
+}
+
+BaseService.prototype.request = function ({ path, method, payload = null }) {
+  return this.httpClient.request({
+    method: method,
+    path: path,
+    payload: payload,
+  });
+};
+
+module.exports = BaseService;

package/src/services/CheckoutSessionService.js

@@ -0,0 +1,60 @@
+const BaseService = require('./BaseService');
+const CheckoutSessionEntity = require('../entities/CheckoutSessionEntity');
+const ListingEntity = require('../entities/ListingEntity');
+const ApiResource = require('../ApiResource');
+
+function CheckoutSessionService(client) {
+  BaseService.call(this, client);
+  this.path = 'checkout_sessions';
+}
+
+CheckoutSessionService.prototype.create = function (payload) {
+  return this.request({
+    path: this.path,
+    payload: payload,
+    method: 'post',
+  }).then(function (response) {
+    return new CheckoutSessionEntity(response);
+  });
+};
+
+CheckoutSessionService.prototype.expire = function (id, payload) {
+  return this.request({
+    path: `${this.path}/${id}/expire`,
+    payload: payload,
+    method: 'post',
+  }).then(function (response) {
+    return new CheckoutSessionEntity(response);
+  });
+};
+
+CheckoutSessionService.prototype.list = function (payload) {
+  return this.request({
+    path: this.path,
+    payload: payload,
+    method: 'get',
+  }).then(function (response) {
+    const sessionsData = response.data.data;
+
+    const data = sessionsData.map((session) => {
+      const apiResource = new ApiResource(session);
+
+      return new CheckoutSessionEntity(apiResource);
+    });
+
+    return new ListingEntity(data, response.data.has_more);
+  });
+};
+
+CheckoutSessionService.prototype.retrieve = function (id) {
+  return this.request({
+    path: `${this.path}/${id}`,
+    method: 'get',
+  }).then(function (response) {
+    return new CheckoutSessionEntity(response);
+  });
+};
+
+Object.setPrototypeOf(CheckoutSessionService.prototype, BaseService.prototype);
+
+module.exports = CheckoutSessionService;

package/src/services/MerchantService.js

@@ -0,0 +1,21 @@
+const BaseService = require('./BaseService');
+const MerchantEntity = require('../entities/MerchantEntity');
+
+function MerchantService(client) {
+  BaseService.call(this, client);
+  this.path = 'merchants';
+}
+
+MerchantService.prototype.create = function (payload) {
+  return this.request({
+    path: this.path,
+    payload: payload,
+    method: 'post',
+  }).then(function (response) {
+    return new MerchantEntity(response);
+  });
+};
+
+Object.setPrototypeOf(MerchantService.prototype, BaseService.prototype);
+
+module.exports = MerchantService;

package/src/services/PaymentIntentService.js

@@ -0,0 +1,40 @@
+const BaseService = require('./BaseService');
+const PaymentIntentEntity = require('../entities/PaymentIntentEntity');
+
+function PaymentIntentService(client) {
+  BaseService.call(this, client);
+  this.path = 'payment_intents';
+}
+
+PaymentIntentService.prototype.capture = function (id, payload) {
+  return this.request({
+    path: `${this.path}/${id}/capture`,
+    payload: payload,
+    method: 'post',
+  }).then(function (response) {
+    return new PaymentIntentEntity(response);
+  });
+};
+
+PaymentIntentService.prototype.create = function (payload) {
+  return this.request({
+    path: this.path,
+    payload: payload,
+    method: 'post',
+  }).then(function (response) {
+    return new PaymentIntentEntity(response);
+  });
+};
+
+PaymentIntentService.prototype.retrieve = function (id) {
+  return this.request({
+    path: `${this.path}/${id}`,
+    method: 'get',
+  }).then(function (response) {
+    return new PaymentIntentEntity(response);
+  });
+};
+
+Object.setPrototypeOf(PaymentIntentService.prototype, BaseService.prototype);
+
+module.exports = PaymentIntentService;

package/src/services/PaymentMethodService.js

@@ -0,0 +1,21 @@
+const BaseService = require('./BaseService');
+const PaymentMethodEntity = require('../entities/PaymentMethodEntity');
+
+function PaymentMethodService(client) {
+  BaseService.call(this, client);
+  this.path = 'payment_methods';
+}
+
+PaymentMethodService.prototype.create = function (payload) {
+  return this.request({
+    path: this.path,
+    payload: payload,
+    method: 'post',
+  }).then(function (response) {
+    return new PaymentMethodEntity(response);
+  });
+};
+
+Object.setPrototypeOf(PaymentMethodService.prototype, BaseService.prototype);
+
+module.exports = PaymentMethodService;

package/src/services/RefundService.js

@@ -0,0 +1,21 @@
+const BaseService = require('./BaseService');
+const RefundEntity = require('../entities/RefundEntity');
+
+function RefundService(client) {
+  BaseService.call(this, client);
+  this.path = 'refunds';
+}
+
+RefundService.prototype.create = function (payload) {
+  return this.request({
+    path: this.path,
+    payload: payload,
+    method: 'post',
+  }).then(function (response) {
+    return new RefundEntity(response);
+  });
+};
+
+Object.setPrototypeOf(RefundService.prototype, BaseService.prototype);
+
+module.exports = RefundService;

package/src/services/WebhookService.js

@@ -0,0 +1,128 @@
+const crypto = require('crypto');
+const BaseService = require('./BaseService');
+const WebhookEntity = require('../entities/WebhookEntity');
+const ListingEntity = require('../entities/ListingEntity');
+const ApiResource = require('../ApiResource');
+const EventEntity = require('../entities/EventEntity');
+const ValueUnexpectedError = require('../errors/ValueUnexpectedError');
+const SignatureInvalidError = require('../errors/SignatureInvalidError');
+
+function WebhookService(client) {
+  BaseService.call(this, client);
+  this.path = 'webhooks';
+}
+
+WebhookService.prototype.create = function (payload) {
+  return this.request({
+    path: this.path,
+    payload: payload,
+    method: 'post',
+  }).then(function (response) {
+    return new WebhookEntity(response);
+  });
+};
+
+WebhookService.prototype.update = function (id, payload) {
+  return this.request({
+    path: `${this.path}/${id}`,
+    payload: payload,
+    method: 'put',
+  }).then(function (response) {
+    return new WebhookEntity(response);
+  });
+};
+
+WebhookService.prototype.list = function (payload) {
+  return this.request({
+    path: this.path,
+    payload: payload,
+    method: 'get',
+  }).then(function (response) {
+    const webhooksData = response.data.data;
+
+    const data = webhooksData.map((session) => {
+      const apiResource = new ApiResource(session);
+
+      return new WebhookEntity(apiResource);
+    });
+
+    return new ListingEntity(data, response.data.has_more);
+  });
+};
+
+WebhookService.prototype.retrieve = function (id) {
+  return this.request({
+    path: `${this.path}/${id}`,
+    method: 'get',
+  }).then(function (response) {
+    return new WebhookEntity(response);
+  });
+};
+
+WebhookService.prototype.enable = function (id) {
+  return this.request({
+    path: `${this.path}/${id}/enable`,
+    method: 'post',
+  }).then(function (response) {
+    return new WebhookEntity(response);
+  });
+};
+
+WebhookService.prototype.disable = function (id) {
+  return this.request({
+    path: `${this.path}/${id}/disable`,
+    method: 'post',
+  }).then(function (response) {
+    return new WebhookEntity(response);
+  });
+};
+
+WebhookService.prototype.delete = function (id) {
+  return this.request({
+    path: `${this.path}/${id}`,
+    method: 'delete',
+  }).then(function (response) {
+    return new WebhookEntity(response);
+  });
+};
+
+WebhookService.prototype.parseEvent = function (
+  payload,
+  signatureHeader,
+  webhookSecretKey
+) {
+  if (typeof signatureHeader !== 'string') {
+    throw new ValueUnexpectedError('The signature must be a string.');
+  }
+
+  const signatureArray = signatureHeader.split(',');
+
+  if (signatureArray.length < 3) {
+    throw new ValueUnexpectedError(
+      `The format of signature ${signatureHeader} is invalid.`
+    );
+  }
+
+  const timestamp = signatureArray[0].split('=')[1];
+  const testModeSignature = signatureArray[1].split('=')[1];
+  const liveModeSignature = signatureArray[2].split('=')[1];
+
+  const comparisonSignature = liveModeSignature || testModeSignature;
+
+  const computedHash = crypto
+    .createHmac('sha256', webhookSecretKey)
+    .update(`${timestamp}.${payload}`)
+    .digest('hex');
+
+  if (computedHash !== comparisonSignature) {
+    throw new SignatureInvalidError('The signature is invalid.');
+  }
+
+  const apiResource = new ApiResource(JSON.parse(payload));
+
+  return new EventEntity(apiResource);
+};
+
+Object.setPrototypeOf(WebhookService.prototype, BaseService.prototype);
+
+module.exports = WebhookService;

package/src/services/index.js

@@ -0,0 +1,15 @@
+const CheckoutSessionService = require('./CheckoutSessionService');
+const MerchantService = require('./MerchantService');
+const PaymentIntentService = require('./PaymentIntentService');
+const PaymentMethodService = require('./PaymentMethodService');
+const RefundService = require('./RefundService');
+const WebhookService = require('./WebhookService');
+
+module.exports = {
+  checkoutSessions: CheckoutSessionService,
+  merchants: MerchantService,
+  paymentIntents: PaymentIntentService,
+  paymentMethods: PaymentMethodService,
+  refunds: RefundService,
+  webhooks: WebhookService,
+};