@openfn/language-mpesa 1.0.0

package/configuration-schema.json

@@ -0,0 +1,39 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "properties": {
+    "baseUrl": {
+      "title": "Base URL",
+      "description": "The base URL (https://api.safaricom.co.ke)",
+      "format": "uri",
+      "minLength": 1,
+      "examples": ["https://api.safaricom.co.ke"]
+    },
+    "short_code": {
+      "title": "Short code",
+      "type": "string",
+      "description": "This is the organization's shortcode used to identify YOUR organization. Usually a 5 to 6-digit account number",
+      "examples": ["654321"]
+    },
+    "pass_key": {
+      "title": "Pass key",
+      "type": "string",
+      "description": "Your app's pass key sent to you via email once you go live",
+      "examples": ["bfb279f9aa9bdbcf158e97dd71a467cd2e0c893059b10f78e6b72ada1ed2c919"]
+    },
+    "consumer_key": {
+      "title": "Consumer key",
+      "type": "string",
+      "description": "Your app's consumer key sent to you via email once you go live",
+      "examples": ["GA2PNftcXvv2uC2VdgNjxXyvF8eZ4td6iBsL7N7N2ZFnXzf3"]
+    },
+    "consumer_secret": {
+      "title": "Consumer key",
+      "type": "string",
+      "description": "Your app's consumer secret sent to you via email once you go live",
+      "examples": ["zKjr2j0jjihCtzIwzGtgnV0YgP82jZf1hY9RW6HygntWG6AGuf4tAUe3E5tPtiyA"]
+    }
+  },
+  "type": "object",
+  "additionalProperties": true,
+  "required": ["short_code", "pass_key", "consumer_key", "consumer_secret"]
+}

package/dist/index.cjs

@@ -0,0 +1,237 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.js
+var src_exports = {};
+__export(src_exports, {
+  buyGoods: () => buyGoods,
+  checkTransactionStatus: () => checkTransactionStatus,
+  cursor: () => import_language_common2.cursor,
+  dataPath: () => import_language_common2.dataPath,
+  dataValue: () => import_language_common2.dataValue,
+  dateFns: () => import_language_common2.dateFns,
+  default: () => src_default,
+  each: () => import_language_common2.each,
+  field: () => import_language_common2.field,
+  fields: () => import_language_common2.fields,
+  fn: () => import_language_common2.fn,
+  lastReferenceValue: () => import_language_common2.lastReferenceValue,
+  merge: () => import_language_common2.merge,
+  registerUrl: () => registerUrl,
+  remitTax: () => remitTax,
+  request: () => request2,
+  sourceValue: () => import_language_common2.sourceValue,
+  stkPush: () => stkPush
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/Adaptor.js
+var Adaptor_exports = {};
+__export(Adaptor_exports, {
+  buyGoods: () => buyGoods,
+  checkTransactionStatus: () => checkTransactionStatus,
+  cursor: () => import_language_common2.cursor,
+  dataPath: () => import_language_common2.dataPath,
+  dataValue: () => import_language_common2.dataValue,
+  dateFns: () => import_language_common2.dateFns,
+  each: () => import_language_common2.each,
+  field: () => import_language_common2.field,
+  fields: () => import_language_common2.fields,
+  fn: () => import_language_common2.fn,
+  lastReferenceValue: () => import_language_common2.lastReferenceValue,
+  merge: () => import_language_common2.merge,
+  registerUrl: () => registerUrl,
+  remitTax: () => remitTax,
+  request: () => request2,
+  sourceValue: () => import_language_common2.sourceValue,
+  stkPush: () => stkPush
+});
+var import_util2 = require("@openfn/language-common/util");
+
+// src/Utils.js
+var import_language_common = require("@openfn/language-common");
+var import_util = require("@openfn/language-common/util");
+var import_node_path = __toESM(require("path"), 1);
+var defaultBaseUrl = "https://api.safaricom.co.ke";
+var access_token;
+var prepareNextState = (state, response) => {
+  const { body, ...responseWithoutBody } = response;
+  if (!state.references) {
+    state.references = [];
+  }
+  return {
+    ...(0, import_language_common.composeNextState)(state, response.body),
+    response: responseWithoutBody
+  };
+};
+var pad = (num) => num < 10 ? String(num).padStart(2, "0") : num;
+var getTimestamp = () => {
+  const date = new Date();
+  return date.getFullYear().toString() + pad(date.getMonth() + 1) + pad(date.getDate()) + pad(date.getHours()) + pad(date.getMinutes()) + pad(date.getSeconds());
+};
+var getAccessToken = async (configuration) => {
+  const { consumer_key, consumer_secret, baseUrl = defaultBaseUrl } = configuration;
+  const auth_header = (0, import_util.makeBasicAuthHeader)(consumer_key, consumer_secret);
+  const { body: { access_token: access_token2 } } = await (0, import_util.request)("GET", "/oauth/v1/generate?grant_type=client_credentials", {
+    headers: {
+      ...auth_header,
+      "Content-Type": "application/json"
+    },
+    baseUrl
+  });
+  return access_token2;
+};
+var request = async (state, method, path, options) => {
+  var _a;
+  const { baseUrl = defaultBaseUrl } = state.configuration;
+  const errors = {
+    404: "Page not found"
+  };
+  if (!access_token && !((_a = options.headers) == null ? void 0 : _a.Authorization)) {
+    access_token = await getAccessToken(state.configuration);
+  }
+  let opts = {
+    parseAs: "json",
+    errors,
+    baseUrl,
+    ...options,
+    headers: {
+      "content-type": "application/json",
+      "Authorization": `Bearer ${access_token}`,
+      ...options.headers
+    }
+  };
+  const safePath = import_node_path.default.join(path);
+  return (0, import_util.request)(method, safePath, opts).then(import_util.logResponse);
+};
+
+// src/Adaptor.js
+var import_language_common2 = require("@openfn/language-common");
+function stkPush(data, options = {}) {
+  return async (state) => {
+    const { short_code, pass_key } = state.configuration;
+    const timestamp = getTimestamp();
+    const password = short_code + pass_key + timestamp;
+    const body = {
+      ...data,
+      BusinessShortCode: short_code,
+      Password: Buffer.from(password).toString("base64"),
+      Timestamp: timestamp,
+      TransactionType: "CustomerPayBillOnline"
+    };
+    console.log("Initiating STK Push request...");
+    const response = await request(state, "POST", "/mpesa/stkpush/v1/processrequest", { ...options, body });
+    return prepareNextState(state, response);
+  };
+}
+function checkTransactionStatus(data, options = {}) {
+  return async (state) => {
+    const { short_code, pass_key } = state.configuration;
+    const timestamp = getTimestamp();
+    const password = short_code + pass_key + timestamp;
+    const body = {
+      BusinessShortCode: short_code,
+      Password: Buffer.from(password).toString("base64"),
+      Timestamp: timestamp,
+      CommandID: "TransactionStatusQuery",
+      ...data
+    };
+    console.log("Initiating check transaction request...");
+    const response = await request(state, "POST", "/mpesa/transactionstatus/v1/query", { ...options, body });
+    return prepareNextState(state, response);
+  };
+}
+function registerUrl(data, options) {
+  return async (state) => {
+    console.log("Initiating register URL request...");
+    const response = await request(state, "POST", "/mpesa/c2b/v1/registerurl", { ...options, body: { ...data } });
+    return prepareNextState(state, response);
+  };
+}
+function remitTax(data, options = {}) {
+  return async (state) => {
+    const body = {
+      SenderIdentifierType: "4",
+      RecieverIdentifierType: "4",
+      PartyB: 572572,
+      CommandID: "PayTaxToKRA",
+      ...data
+    };
+    console.log("Initiating remit tax request...");
+    const response = await request(state, "POST", "/mpesa/b2b/v1/remittax", { ...options, body });
+    return prepareNextState(state, response);
+  };
+}
+function buyGoods(data, options = {}) {
+  return async (state) => {
+    const body = {
+      CommandID: "BusinessBuyGoods",
+      SenderIdentifierType: "4",
+      RecieverIdentifierType: "4",
+      ...data
+    };
+    console.log("Initiating buy goods request...");
+    const response = await request(state, "POST", "/mpesa/b2b/v1/paymentrequest", { ...options, body });
+    return prepareNextState(state, response);
+  };
+}
+function request2(method, path, body, options = {}) {
+  return async (state) => {
+    const [resolvedMethod, resolvedPath, resolvedBody, resolvedoptions] = (0, import_util2.expandReferences)(state, method, path, body, options);
+    console.log(`Initiating ${method} request to: ${resolvedPath}`);
+    const response = await request(
+      state,
+      resolvedMethod,
+      resolvedPath,
+      {
+        body: resolvedBody,
+        ...resolvedoptions
+      }
+    );
+    return prepareNextState(state, response);
+  };
+}
+
+// src/index.js
+var src_default = Adaptor_exports;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  buyGoods,
+  checkTransactionStatus,
+  cursor,
+  dataPath,
+  dataValue,
+  dateFns,
+  each,
+  field,
+  fields,
+  fn,
+  lastReferenceValue,
+  merge,
+  registerUrl,
+  remitTax,
+  request,
+  sourceValue,
+  stkPush
+});

package/dist/index.js

@@ -0,0 +1,211 @@
+var __defProp = Object.defineProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+
+// src/Adaptor.js
+var Adaptor_exports = {};
+__export(Adaptor_exports, {
+  buyGoods: () => buyGoods,
+  checkTransactionStatus: () => checkTransactionStatus,
+  cursor: () => cursor,
+  dataPath: () => dataPath,
+  dataValue: () => dataValue,
+  dateFns: () => dateFns,
+  each: () => each,
+  field: () => field,
+  fields: () => fields,
+  fn: () => fn,
+  lastReferenceValue: () => lastReferenceValue,
+  merge: () => merge,
+  registerUrl: () => registerUrl,
+  remitTax: () => remitTax,
+  request: () => request2,
+  sourceValue: () => sourceValue,
+  stkPush: () => stkPush
+});
+import { expandReferences } from "@openfn/language-common/util";
+
+// src/Utils.js
+import { composeNextState } from "@openfn/language-common";
+import {
+  request as commonRequest,
+  logResponse,
+  makeBasicAuthHeader
+} from "@openfn/language-common/util";
+import nodepath from "path";
+var defaultBaseUrl = "https://api.safaricom.co.ke";
+var access_token;
+var prepareNextState = (state, response) => {
+  const { body, ...responseWithoutBody } = response;
+  if (!state.references) {
+    state.references = [];
+  }
+  return {
+    ...composeNextState(state, response.body),
+    response: responseWithoutBody
+  };
+};
+var pad = (num) => num < 10 ? String(num).padStart(2, "0") : num;
+var getTimestamp = () => {
+  const date = new Date();
+  return date.getFullYear().toString() + pad(date.getMonth() + 1) + pad(date.getDate()) + pad(date.getHours()) + pad(date.getMinutes()) + pad(date.getSeconds());
+};
+var getAccessToken = async (configuration) => {
+  const { consumer_key, consumer_secret, baseUrl = defaultBaseUrl } = configuration;
+  const auth_header = makeBasicAuthHeader(consumer_key, consumer_secret);
+  const { body: { access_token: access_token2 } } = await commonRequest("GET", "/oauth/v1/generate?grant_type=client_credentials", {
+    headers: {
+      ...auth_header,
+      "Content-Type": "application/json"
+    },
+    baseUrl
+  });
+  return access_token2;
+};
+var request = async (state, method, path, options) => {
+  var _a;
+  const { baseUrl = defaultBaseUrl } = state.configuration;
+  const errors = {
+    404: "Page not found"
+  };
+  if (!access_token && !((_a = options.headers) == null ? void 0 : _a.Authorization)) {
+    access_token = await getAccessToken(state.configuration);
+  }
+  let opts = {
+    parseAs: "json",
+    errors,
+    baseUrl,
+    ...options,
+    headers: {
+      "content-type": "application/json",
+      "Authorization": `Bearer ${access_token}`,
+      ...options.headers
+    }
+  };
+  const safePath = nodepath.join(path);
+  return commonRequest(method, safePath, opts).then(logResponse);
+};
+
+// src/Adaptor.js
+import {
+  dataPath,
+  dataValue,
+  dateFns,
+  cursor,
+  each,
+  field,
+  fields,
+  fn,
+  lastReferenceValue,
+  merge,
+  sourceValue
+} from "@openfn/language-common";
+function stkPush(data, options = {}) {
+  return async (state) => {
+    const { short_code, pass_key } = state.configuration;
+    const timestamp = getTimestamp();
+    const password = short_code + pass_key + timestamp;
+    const body = {
+      ...data,
+      BusinessShortCode: short_code,
+      Password: Buffer.from(password).toString("base64"),
+      Timestamp: timestamp,
+      TransactionType: "CustomerPayBillOnline"
+    };
+    console.log("Initiating STK Push request...");
+    const response = await request(state, "POST", "/mpesa/stkpush/v1/processrequest", { ...options, body });
+    return prepareNextState(state, response);
+  };
+}
+function checkTransactionStatus(data, options = {}) {
+  return async (state) => {
+    const { short_code, pass_key } = state.configuration;
+    const timestamp = getTimestamp();
+    const password = short_code + pass_key + timestamp;
+    const body = {
+      BusinessShortCode: short_code,
+      Password: Buffer.from(password).toString("base64"),
+      Timestamp: timestamp,
+      CommandID: "TransactionStatusQuery",
+      ...data
+    };
+    console.log("Initiating check transaction request...");
+    const response = await request(state, "POST", "/mpesa/transactionstatus/v1/query", { ...options, body });
+    return prepareNextState(state, response);
+  };
+}
+function registerUrl(data, options) {
+  return async (state) => {
+    console.log("Initiating register URL request...");
+    const response = await request(state, "POST", "/mpesa/c2b/v1/registerurl", { ...options, body: { ...data } });
+    return prepareNextState(state, response);
+  };
+}
+function remitTax(data, options = {}) {
+  return async (state) => {
+    const body = {
+      SenderIdentifierType: "4",
+      RecieverIdentifierType: "4",
+      PartyB: 572572,
+      CommandID: "PayTaxToKRA",
+      ...data
+    };
+    console.log("Initiating remit tax request...");
+    const response = await request(state, "POST", "/mpesa/b2b/v1/remittax", { ...options, body });
+    return prepareNextState(state, response);
+  };
+}
+function buyGoods(data, options = {}) {
+  return async (state) => {
+    const body = {
+      CommandID: "BusinessBuyGoods",
+      SenderIdentifierType: "4",
+      RecieverIdentifierType: "4",
+      ...data
+    };
+    console.log("Initiating buy goods request...");
+    const response = await request(state, "POST", "/mpesa/b2b/v1/paymentrequest", { ...options, body });
+    return prepareNextState(state, response);
+  };
+}
+function request2(method, path, body, options = {}) {
+  return async (state) => {
+    const [resolvedMethod, resolvedPath, resolvedBody, resolvedoptions] = expandReferences(state, method, path, body, options);
+    console.log(`Initiating ${method} request to: ${resolvedPath}`);
+    const response = await request(
+      state,
+      resolvedMethod,
+      resolvedPath,
+      {
+        body: resolvedBody,
+        ...resolvedoptions
+      }
+    );
+    return prepareNextState(state, response);
+  };
+}
+
+// src/index.js
+var src_default = Adaptor_exports;
+export {
+  buyGoods,
+  checkTransactionStatus,
+  cursor,
+  dataPath,
+  dataValue,
+  dateFns,
+  src_default as default,
+  each,
+  field,
+  fields,
+  fn,
+  lastReferenceValue,
+  merge,
+  registerUrl,
+  remitTax,
+  request2 as request,
+  sourceValue,
+  stkPush
+};

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@openfn/language-mpesa",
+  "version": "1.0.0",
+  "description": "OpenFn mpesa adaptor",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./types/index.d.ts",
+      "require": "./dist/index.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "author": "Open Function Group",
+  "license": "LGPLv3",
+  "files": [
+    "dist/",
+    "types/",
+    "ast.json",
+    "configuration-schema.json"
+  ],
+  "dependencies": {
+    "@openfn/language-common": "2.3.1"
+  },
+  "devDependencies": {
+    "assertion-error": "2.0.0",
+    "chai": "4.3.6",
+    "deep-eql": "4.1.1",
+    "esno": "^0.16.3",
+    "mocha": "^10.7.3",
+    "rimraf": "3.0.2",
+    "undici": "^5.22.1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/openfn/adaptors.git"
+  },
+  "types": "types/index.d.ts",
+  "main": "dist/index.cjs",
+  "scripts": {
+    "build": "pnpm clean && build-adaptor mpesa",
+    "test": "mocha --experimental-specifier-resolution=node --no-warnings",
+    "test:watch": "mocha -w --experimental-specifier-resolution=node --no-warnings",
+    "clean": "rimraf dist types docs",
+    "pack": "pnpm pack --pack-destination ../../dist",
+    "lint": "eslint src"
+  }
+}