@sails-pay/paystack 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 The Sailscasts Company
+
+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/adapter.js

@@ -0,0 +1,6 @@
+const methods = require('./machines')
+module.exports = {
+  identity: 'sails-paystack',
+  config: {},
+  checkout: methods.checkout
+}

package/helpers/fetch.js

@@ -0,0 +1,31 @@
+const { fetch: undiciFetch } = require('undici')
+
+const baseUrl = 'https://api.paystack.co'
+const defaultHeaders = {
+  Accept: 'application/json',
+  'Content-Type': 'application/json'
+}
+
+const fetchImpl = undiciFetch
+
+const fetch = async (path, options = {}) => {
+  const url = new URL(path, baseUrl).toString()
+  const mergedOptions = {
+    ...options,
+    headers: {
+      ...defaultHeaders,
+      ...(options.headers || {})
+    }
+  }
+
+  try {
+    const response = await fetchImpl(url, mergedOptions)
+    const jsonResponse = await response.json()
+    return jsonResponse
+  } catch (error) {
+    console.error('Error occurred during fetch:', error)
+    throw error
+  }
+}
+
+module.exports = fetch

package/helpers/parameters.js

@@ -0,0 +1,21 @@
+/**
+ * Common input definitions (i.e. parameter definitions) that are shared by multiple files.
+ *
+ * @type {Dictionary}
+ * @constant
+ */
+
+module.exports = {
+  PAYSTACK_API_KEY: {
+    type: 'string',
+    friendlyName: 'API Key',
+    description: 'A valid Paystack API Key',
+    protect: true,
+    whereToGet: {
+      url: 'https://dashboard.paystack.com/#/settings/developers',
+      description: 'Generate an API key in your Paystack dashboard.',
+      extendedDescription:
+        'To generate an API key, you will first need to log in to your Paystack account, or sign up for one if you have not already done so.'
+    }
+  }
+}

package/machines/checkout.js

@@ -0,0 +1,140 @@
+const fetch = require('../helpers/fetch')
+module.exports = require('machine').build({
+  friendlyName: 'Checkout',
+  description: 'Creates and return a checkout authorization URL',
+  moreInfoUrl: 'https://paystack.com/docs/api/transaction/#initialize',
+  inputs: {
+    apiKey: require('../helpers/parameters').PAYSTACK_API_KEY,
+    amount: {
+      type: 'number',
+      description: 'Amount should be in the subunit of the supported currency'
+    },
+    email: {
+      type: 'string',
+      description: "Customer's email address"
+    },
+    currency: {
+      type: 'string',
+      description:
+        'The transaction currency. Defaults to your integration currency.'
+    },
+    reference: {
+      type: 'string',
+      description:
+        'Unique transaction reference. Only alphanumeric characters, hyphens (-), periods (.), and equal signs (=) are allowed.'
+    },
+    callbackUrl: {
+      type: 'string',
+      description:
+        'Fully qualified url, e.g. https://example.com. Use this to override the callback url provided on the dashboard for this transaction'
+    },
+    plan: {
+      type: 'string',
+      description:
+        'If transaction is to create a subscription to a predefined plan, provide plan code here. This would invalidate the value provided in amount'
+    },
+    invoiceLimit: {
+      type: 'number',
+      description:
+        'Number of times to charge customer during subscription to plan'
+    },
+    metadata: {
+      type: 'string',
+      description: 'Stringified JSON object of custom data.',
+      moreInfoUrl: 'https://paystack.com/docs/payments/metadata/'
+    },
+    channels: {
+      type: 'ref',
+      description:
+        'An array of payment channels to control what channels you want to make available to the user to make a payment with.',
+      extendedDescription:
+        'Available channels include: ["card", "bank", "ussd", "qr", "mobile_money", "bank_transfer", "eft"]'
+    },
+    splitCode: {
+      type: 'string',
+      description: 'The split code of the transaction split.'
+    },
+    subaccount: {
+      type: 'string',
+      description: 'The code for the subaccount that owns the payment.'
+    },
+    transactionCharge: {
+      type: 'number',
+      description:
+        'An amount used to override the split configuration for a single split payment.',
+      extendedDescription:
+        'If set, the amount specified goes to the main account regardless of the split configuration.'
+    },
+    bearer: {
+      type: 'string',
+      description:
+        'Use this param to indicate who bears the transaction charges',
+      extendedDescription:
+        'Allowed values are: account or subaccount (defaults to account).'
+    }
+  },
+  exits: {
+    success: {
+      description: 'The checkout url.',
+      outputVariableName: 'checkoutUrl',
+      outputType: 'string'
+    },
+    couldNotCreateCheckoutUrl: {
+      description: 'Checkout URL could not be created.',
+      extendedDescription:
+        'This indicates that an error was encountered during checkout url creation.',
+      outputFriendlyName: 'Create checkout URL error report.',
+      outputVariableName: 'errors'
+    }
+  },
+  fn: async function (
+    {
+      apiKey,
+      amount,
+      email,
+      currency,
+      reference,
+      callbackUrl,
+      plan,
+      invoiceLimit,
+      metadata,
+      channels,
+      splitCode,
+      subaccount,
+      transactionCharge,
+      bearer
+    },
+    exits
+  ) {
+    const adapterConfig = require('../adapter').config
+    const payload = JSON.stringify({
+      amount,
+      email,
+      currency,
+      reference,
+      callback_url: callbackUrl,
+      plan,
+      invoice_limit: invoiceLimit,
+      metadata,
+      channels,
+      split_code: splitCode,
+      subaccount,
+      transaction_charge: transactionCharge,
+      bearer
+    })
+    const checkout = await fetch('/transaction/initialize', {
+      method: 'POST',
+      headers: {
+        authorization: `Bearer ${apiKey || adapterConfig.apiKey}`
+      },
+      body: payload
+    })
+    if (!checkout.status) {
+      const errors = checkout
+      return exits.couldNotCreateCheckoutUrl(errors)
+    }
+
+    const checkoutUrl = checkout.data.authorization_url
+    return exits.success(checkoutUrl)
+  }
+})

package/machines/index.js

@@ -0,0 +1,3 @@
+module.exports = {
+  checkout: require('./checkout')
+}

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@sails-pay/paystack",
+  "version": "0.0.1",
+  "description": "Paystack adapter for Sails Pay",
+  "main": "adapter.js",
+  "scripts": {
+    "test": "npm run test"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sailscastshq/sails-pay.git",
+    "directory": "packages/sails-lemonsqueezy"
+  },
+  "keywords": [
+    "Paystack",
+    "Sails",
+    "Pay",
+    "Payments",
+    "payment-gateway",
+    "online-payments",
+    "sails",
+    "sails.js",
+    "payment-integration"
+  ],
+  "author": "Kelvin Omereshone <kelvin@sailscasts.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/sailscastshq/sails-pay/issues"
+  },
+  "homepage": "https://github.com/sailscastshq/sails-pay#readme",
+  "dependencies": {
+    "machine": "^15.2.3",
+    "undici": "^6.19.2"
+  }
+}