@depup/africastalking 0.7.9-depup.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Africa's Talking
+
+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,32 @@
+# @depup/africastalking
+
+> Dependency-bumped version of [africastalking](https://www.npmjs.com/package/africastalking)
+
+Generated by [DepUp](https://github.com/depup/npm) -- all production
+dependencies bumped to latest versions.
+
+## Installation
+
+```bash
+npm install @depup/africastalking
+```
+
+| Field | Value |
+|-------|-------|
+| Original | [africastalking](https://www.npmjs.com/package/africastalking) @ 0.7.9 |
+| Processed | 2026-03-19 |
+| Smoke test | passed |
+| Deps updated | 2 |
+
+## Dependency Changes
+
+| Dependency | From | To |
+|------------|------|-----|
+| axios | 1.13.5 | ^1.13.6 |
+| dotenv | 17.2.4 | ^17.3.1 |
+
+---
+
+Source: https://github.com/depup/npm | Original: https://www.npmjs.com/package/africastalking
+
+License inherited from the original package.

package/changes.json

@@ -0,0 +1,14 @@
+{
+  "bumped": {
+    "axios": {
+      "from": "1.13.5",
+      "to": "^1.13.6"
+    },
+    "dotenv": {
+      "from": "17.2.4",
+      "to": "^17.3.1"
+    }
+  },
+  "timestamp": "2026-03-19T03:32:18.199Z",
+  "totalUpdated": 2
+}

package/index.js

@@ -0,0 +1,3 @@
+'use strict'
+
+module.exports = require('./lib')

package/lib/actionbuilder.js

@@ -0,0 +1,329 @@
+const Joi = require('joi')
+const _ = require('lodash')
+
+const playSchema = Joi.object().keys({
+  url: Joi.string().uri({ scheme: 'https' }).required()
+})
+
+const saySchema = Joi.object().keys({
+  text: Joi.string().required(),
+  voice: Joi.string().optional(),
+  playBeep: Joi.boolean().optional()
+})
+
+class ActionBuilder {
+  constructor () {
+    this.finalized = false
+    this.xml = '<?xml version="1.0" encoding="UTF-8"?><Response>'
+
+    this.buildAction = function (action) {
+      const {
+        tag,
+        text,
+        children,
+        attributes
+      } = action
+
+      this.xml = this.xml.concat('<' + tag)
+
+      if (attributes && Object.keys(attributes).length > 0) {
+        Object.entries(attributes)
+          .forEach(([key, value]) => {
+            this.xml = this.xml.concat(` ${key}="${value}"`)
+          })
+      }
+
+      if (children && Object.keys(children).length > 0) {
+        this.xml = this.xml.concat('>')
+        Object.entries(children)
+          .forEach(([child, options]) => {
+            switch (child) {
+              case 'say':
+                this.say(options.text, options.attributes)
+                break
+              case 'play':
+                this.play(options.url)
+                break
+              case 'getDigits':
+                this.getDigits(options.children, options.attributes)
+                break
+              case 'dial':
+                this.dial(options.phoneNumbers, options.attributes)
+                break
+              case 'record':
+                this.record(options.children, options.attributes)
+                break
+              case 'enqueue':
+                this.enqueue(options.attributes)
+                break
+              case 'dequeue':
+                this.dequeue(options.phoneNumber, options.attributes)
+                break
+              case 'redirect':
+                this.redirect(options.text)
+                break
+              case 'conference':
+                this.conference()
+                break
+              case 'reject':
+                this.redirect()
+                break
+              default:
+                throw new Error('Invalid child')
+            }
+          })
+        this.xml = this.xml.concat(`</${tag}>`)
+      } else {
+        if (text) {
+          this.xml = this.xml.concat(`>${text}</${tag}>`)
+        } else {
+          this.xml = this.xml.concat('/>')
+        }
+      }
+    }
+  }
+
+  build () {
+    if (this.finalized) throw new Error('This builder has been finalized by a call to build()')
+
+    this.finalized = true
+    this.xml = this.xml.concat('</Response>')
+    return this.xml
+  }
+
+  say (text, attributes = {}) {
+    const { error } = saySchema.required().validate({ ...attributes, text })
+
+    if (error) {
+      const msg = error.details.map(detail => detail.message).join(';')
+      throw new Error(msg)
+    }
+
+    const action = {
+      tag: 'Say',
+      text,
+      attributes
+    }
+
+    this.buildAction(action)
+    return this
+  }
+
+  play (url) {
+    const attributes = { url }
+
+    const { error } = playSchema.required().validate(attributes)
+
+    if (error) {
+      const msg = error.details.map(detail => detail.message).join(';')
+      throw new Error(msg)
+    }
+
+    const action = {
+      tag: 'Play',
+      attributes
+    }
+
+    this.buildAction(action)
+    return this
+  }
+
+  getDigits (children, attributes = {}) {
+    const params = {
+      children: _.cloneDeep(children),
+      attributes: _.cloneDeep(attributes)
+    }
+
+    const schema = Joi.object().keys({
+      attributes: Joi.object().keys({
+        finishOnKey: Joi.string().max(1).default('#'),
+        numDigits: Joi.number().integer().positive(),
+        timeout: Joi.number().integer().positive(),
+        callbackUrl: Joi.string().uri({ scheme: 'https' })
+      }).required(),
+
+      children: Joi.object().keys({
+        say: saySchema,
+        play: playSchema
+      })
+        .nand('say', 'play')
+        .required()
+    }).required()
+
+    const { error } = schema.validate(params)
+
+    if (error) {
+      const msg = error.details.map(detail => detail.message).join(';')
+      throw new Error(msg)
+    }
+
+    const action = {
+      tag: 'GetDigits',
+      children,
+      attributes
+    }
+
+    this.buildAction(action)
+    return this
+  }
+
+  dial (phoneNumbers, attributes = {}) {
+    const params = _.cloneDeep(attributes)
+    params.phoneNumbers = phoneNumbers
+
+    const schema = Joi.object().keys({
+      callerId: Joi.string().optional(),
+      phoneNumbers: Joi.string().required(),
+      record: Joi.boolean().optional(),
+      sequential: Joi.boolean().optional(),
+      maxDuration: Joi.number().integer().positive(),
+      ringBackTone: Joi.string().uri({ scheme: 'https' })
+    }).required()
+
+    const { error } = schema.validate(params)
+
+    if (error) {
+      const msg = error.details.map(detail => detail.message).join(';')
+      throw new Error(msg)
+    }
+
+    const action = {
+      tag: 'Dial',
+      attributes: params
+    }
+
+    this.buildAction(action)
+    return this
+  }
+
+  record (children, attributes = {}) {
+    const params = {
+      children: _.cloneDeep(children),
+      attributes: _.cloneDeep(attributes)
+    }
+
+    const schema = Joi.object().keys({
+      attributes: Joi.object().keys({
+        finishOnKey: Joi.string().max(1).default('#'),
+        maxLength: Joi.number().integer().positive(),
+        timeout: Joi.number().integer().positive(),
+        playBeep: Joi.boolean().optional(),
+        trimSilence: Joi.boolean().optional(),
+        callbackUrl: Joi.string().uri({ scheme: 'https' })
+      }),
+
+      children: Joi.object().keys({
+        say: saySchema,
+        play: playSchema
+      })
+        .nand('say', 'play')
+        .required()
+    }).required()
+
+    const { error } = schema.validate(params)
+
+    if (error) {
+      const msg = error.details.map(detail => detail.message).join(';')
+      throw new Error(msg)
+    }
+
+    const action = {
+      tag: 'Record',
+      children,
+      attributes
+    }
+
+    this.buildAction(action)
+    return this
+  }
+
+  enqueue (attributes) {
+    const params = _.cloneDeep(attributes)
+
+    const schema = Joi.object().keys({
+      holdMusic: Joi.string().uri({ scheme: 'https' }),
+      name: Joi.string()
+    }).optional()
+
+    const { error } = schema.validate(params)
+
+    if (error) {
+      const msg = error.details.map(detail => detail.message).join(';')
+      throw new Error(msg)
+    }
+
+    const action = {
+      tag: 'Enqueue',
+      attributes
+    }
+
+    this.buildAction(action)
+    return this
+  }
+
+  dequeue (phoneNumber, attributes = {}) {
+    const params = _.cloneDeep(attributes)
+    params.phoneNumber = phoneNumber
+
+    const schema = Joi.object().keys({
+      phoneNumber: Joi.string().required(),
+      name: Joi.string().optional()
+    }).required()
+
+    const { error } = schema.validate(params)
+
+    if (error) {
+      const msg = error.details.map(detail => detail.message).join(';')
+      throw new Error(msg)
+    }
+
+    const action = {
+      tag: 'Dequeue',
+      attributes: params
+    }
+
+    this.buildAction(action)
+    return this
+  }
+
+  redirect (url) {
+    const schema = Joi.object().keys({
+      url: Joi.string().uri({ scheme: 'https' }).required()
+    }).required()
+
+    const { error } = schema.validate({ url })
+
+    if (error) {
+      const msg = error.details.map(detail => detail.message).join(';')
+      throw new Error(msg)
+    }
+
+    const action = {
+      tag: 'Redirect',
+      text: url
+    }
+
+    this.buildAction(action)
+    return this
+  }
+
+  conference () {
+    const action = {
+      tag: 'Conference'
+    }
+
+    this.buildAction(action)
+    return this
+  }
+
+  reject () {
+    const action = {
+      tag: 'Reject'
+    }
+
+    this.buildAction(action)
+    return this
+  }
+}
+
+module.exports = ActionBuilder

package/lib/airtime.js

@@ -0,0 +1,93 @@
+'use strict'
+
+const Joi = require('joi')
+const Common = require('./common')
+
+const initializeAxios = require('./customAxios')
+
+class Airtime {
+  constructor (config) {
+    this.config = config
+  }
+
+  send (options) {
+    return new Promise((resolve, reject) => {
+      const { error, value } = this.validateOptions(options)
+
+      if (error) {
+        const combinedMessages = error.details.map(detail => detail.message).join(';')
+        reject(new Error(combinedMessages))
+        return
+      }
+
+      const rawRecipients = value.recipients
+      const recipients = rawRecipients.map(r => ({
+        phoneNumber: r.phoneNumber,
+        amount: `${r.currencyCode} ${r.amount}`
+      }))
+      const customAxios = value.idempotencyKey ? initializeAxios(this.config, value.idempotencyKey) : initializeAxios(this.config)
+
+      const requestBody = {
+        recipients: JSON.stringify(recipients)
+      }
+
+      if (options.maxNumRetry && (options.maxNumRetry > 0)) {
+        requestBody.maxNumRetry = Number(options.maxNumRetry)
+      };
+
+      customAxios.airtime.sendAirtimeRequest(requestBody)
+        .then(function (response) {
+          if (response.status === 201) {
+            resolve(response.data)
+          } else {
+            reject(response.data || response.error)
+          }
+        })
+        .catch(function (err) {
+          reject(err)
+        })
+    })
+  }
+
+  findTransactionStatus (transactionId) {
+    return new Promise((resolve, reject) => {
+      if (!transactionId) {
+        throw new Error('transactionId should be provided')
+      }
+
+      const { airtime } = initializeAxios(this.config)
+
+      airtime.findTransactionStatus(transactionId)
+        .then(function (resp) {
+          const httpStatus = resp.status
+          if (httpStatus === 200) {
+            resolve(resp.data)
+          } else {
+            reject(resp.data)
+          };
+        }).catch(function (error) {
+          return reject(error)
+        })
+    })
+  }
+
+  validateOptions (options) {
+    const schema = Joi.object().keys({
+      idempotencyKey: Joi.string().optional(),
+      recipients: Joi.array().items(
+        Joi.object({
+          phoneNumber: Joi.string().required().custom((value) => {
+            return Common.phoneUtil.isValidNumber(value) ? value : new Error(`the phone number ${value} is invalid`)
+          }),
+          currencyCode: Joi.string().required(),
+          amount: Joi.number().required()
+        })
+      ).min(1).required(),
+      maxNumRetry: Joi.number().optional()
+    }).required()
+
+    return schema.validate(options)
+  }
+}
+
+module.exports = Airtime

package/lib/application.js

@@ -0,0 +1,35 @@
+'use strict'
+
+const initializeAxios = require('./customAxios')
+
+class Application {
+  constructor (config) {
+    this.config = config
+  }
+
+  fetchApplicationData () {
+    return new Promise((resolve, reject) => {
+      const customAxios = initializeAxios(this.config)
+
+      customAxios.application.getApplicationData()
+        .then(function (response) {
+          if (response.status === 200) {
+            resolve(response.data)
+          } else {
+            reject(response.data || response.error)
+          }
+        })
+        .catch(function (err) {
+          reject(err)
+        })
+    })
+  }
+
+  /* backward compatibility */
+  fetchAccount () {
+    return this.fetchApplicationData()
+  }
+  /*  end backward compatibility */
+}
+
+module.exports = Application

package/lib/common.js

@@ -0,0 +1,50 @@
+'use strict'
+const phoneNumberUtil = require('google-libphonenumber').PhoneNumberUtil.getInstance()
+
+const BASE_DOMAIN = 'africastalking.com'
+const BASE_SANDBOX_DOMAIN = 'sandbox.' + BASE_DOMAIN
+
+const initUrls = function (sandbox) {
+  const baseDomain = sandbox ? BASE_SANDBOX_DOMAIN : BASE_DOMAIN
+  const baseUrl = 'https://api.' + baseDomain + '/version1'
+
+  exports.BASE_URL = baseUrl
+
+  exports.CHECKOUT_TOKEN_URL = 'https://api.' + baseDomain + '/checkout/token/create'
+
+  exports.AUTH_TOKEN_URL = 'https://api.' + baseDomain + '/auth-token/generate'
+
+  exports.USER_URL = baseUrl + '/user'
+
+  exports.SMS_URL = baseUrl + '/messaging'
+
+  exports.AIRTIME_URL = baseUrl + '/airtime/send'
+
+  exports.VOICE_URL = 'https://voice.' + baseDomain
+
+  exports.MOBILE_DATA_URL = 'https://bundles.' + baseDomain
+
+  exports.CONTENT_URL = sandbox
+    ? baseUrl
+    : 'https://content.' + baseDomain + '/version1'
+
+  exports.INSIGHTS_URL = 'https://insights.' + baseDomain
+}
+
+// no sandbox by default
+initUrls(false)
+
+exports.enableSandbox = function () {
+  initUrls(true)
+}
+
+exports.phoneUtil = {
+  isValidNumber: (value) => {
+    const phoneNumber = phoneNumberUtil.parse(value)
+    let isValid = phoneNumberUtil.isValidNumber(phoneNumber)
+    if (!isValid) {
+      isValid = /(\+|00)(297|93|244|1264|358|355|376|971|54|374|1684|1268|61|43|994|257|32|229|226|880|359|973|1242|387|590|375|501|1441|591|55|1246|673|975|267|236|1|61|41|56|86|225|237|243|242|682|57|269|238|506|53|5999|61|1345|357|420|49|253|1767|45|1809|1829|1849|213|593|20|291|212|34|372|251|358|679|500|33|298|691|241|44|995|44|233|350|224|590|220|245|240|30|1473|299|502|594|1671|592|852|504|385|509|36|62|44|91|246|353|98|964|354|972|39|1876|44|962|81|76|77|254|996|855|686|1869|82|383|965|856|961|231|218|1758|423|94|266|370|352|371|853|590|212|377|373|261|960|52|692|389|223|356|95|382|976|1670|258|222|1664|596|230|265|60|262|264|687|227|672|234|505|683|31|47|977|674|64|968|92|507|64|51|63|680|675|48|1787|1939|850|351|595|970|689|974|262|40|7|250|966|249|221|65|500|4779|677|232|503|378|252|508|381|211|239|597|421|386|46|268|1721|248|963|1649|235|228|66|992|690|993|670|676|1868|216|90|688|886|255|256|380|598|1|998|3906698|379|1784|58|1284|1340|84|678|681|685|967|27|260|263)(9[976]\d|8[987530]\d|6[987]\d|5[90]\d|42\d|3[875]\d|2[98654321]\d|9[8543210]|8[6421]|6[6543210]|5[87654321]|4[987654310]|3[9643210]|2[70]|7|1)\d{4,10}$/.test(value)
+    }
+    return isValid
+  }
+}

package/lib/customAxios/airtime.js

@@ -0,0 +1,20 @@
+function airtime ({ createAxiosInstance, endpoints, username }) {
+  return {
+    sendAirtimeRequest: data => {
+      return createAxiosInstance().post(endpoints.SEND_AIRTIME, new URLSearchParams({
+        ...data,
+        username
+      }).toString())
+    },
+    findTransactionStatus: transactionId => {
+      return createAxiosInstance('application/json').get(endpoints.FIND_AIRTIME_TRANSACTION, {
+        params: {
+          transactionId,
+          username
+        }
+      })
+    }
+  }
+};
+
+module.exports = airtime

package/lib/customAxios/application.js

@@ -0,0 +1,11 @@
+function application ({ createAxiosInstance, endpoints, username }) {
+  return {
+    getApplicationData: () => {
+      return createAxiosInstance().get(endpoints.GET_APPLICATION_DATA, {
+        params: { username }
+      })
+    }
+  }
+};
+
+module.exports = application

package/lib/customAxios/index.js

@@ -0,0 +1,43 @@
+const axios = require('axios')
+const airtime = require('./airtime')
+const application = require('./application')
+
+function initializeAxios (config, idempotencyKey = null) {
+  const { username, apiKey, format } = config
+
+  const baseURL = username === 'sandbox'
+    ? 'https://api.sandbox.africastalking.com'
+    : 'https://api.africastalking.com'
+
+  const createAxiosInstance = (contentType) => {
+    const headers = {
+      apiKey,
+      Accept: format,
+      ...(contentType && { 'Content-Type': contentType }),
+      ...(idempotencyKey && { 'Idempotency-Key': idempotencyKey })
+    }
+    return axios.create({
+      baseURL,
+      headers
+    })
+  }
+
+  const endpoints = {
+    SEND_AIRTIME: '/version1/airtime/send',
+    FIND_AIRTIME_TRANSACTION: '/query/transaction/find',
+    GET_APPLICATION_DATA: '/version1/user'
+  }
+
+  const opts = {
+    createAxiosInstance,
+    endpoints,
+    username
+  }
+
+  return {
+    airtime: airtime(opts),
+    application: application(opts)
+  }
+};
+
+module.exports = initializeAxios