@verii/data-loader 1.0.0-pre.1752076816

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/jest.config.js

@@ -0,0 +1,20 @@
+/**
+ * Copyright 2023 Velocity Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+const jestConfig = require('../../jest.config.base');
+const pack = require('./package.json');
+
+module.exports = jestConfig(pack.name);

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@verii/data-loader",
+  "version": "1.0.0-pre.1752076816",
+  "description": "A tool for uploading data to the different target systems.",
+  "repository": "https://github.com/LFDT-Verii/core",
+  "main": "src/index.js",
+  "bin": {
+    "data-loader": "src/index.js"
+  },
+  "scripts": {
+    "test": "jest --config ./jest.config.js --runInBand --coverage --passWithNoTests",
+    "lint": "eslint . --format json >> eslint.json",
+    "lint:fix": "eslint --fix --ext .js ."
+  },
+  "author": "Itay Podhajcer",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "eslint": "8.57.1",
+    "eslint-config-airbnb-base": "14.2.1",
+    "eslint-config-prettier": "8.10.0",
+    "eslint-plugin-better-mutation": "1.7.0",
+    "eslint-plugin-import": "2.32.0",
+    "eslint-plugin-prettier": "4.2.1",
+    "eslint-watch": "7.0.0",
+    "jest": "29.7.0",
+    "nock": "14.0.5",
+    "prettier": "2.8.8"
+  },
+  "dependencies": {
+    "chalk": "~4.1.2",
+    "commander": "~13.1.0",
+    "csv-parser": "~3.2.0",
+    "date-fns": "3.6.0",
+    "got": "11.8.6",
+    "handlebars": "^4.7.7",
+    "inquirer": "^8.0.0",
+    "lodash": "^4.17.21",
+    "nanoid": "3.3.11",
+    "strip-bom-stream": "^4.0.0"
+  },
+  "gitHead": "5885ce94149cc0102b2bc9cde18834293174bfaf"
+}

package/src/batch-issuing/README.md

@@ -0,0 +1,97 @@
+# vendor-credentials command
+
+Used for generating ready-to-claim qr-code from a csv that can be shared in order to claim credentials.
+
+## Guidelines
+
+- **Currently only a single credential can be issued per user.**
+- **The CSV must**
+  - have a header row as the first row
+  - the person's email address must be the first column
+- **Credentials are specified as a handlebars templates.** The data is populated from
+  - the csv specified with variable names the same as the headers
+  - the `-d` arg passed in. It is available in your template as `{{did}}`
+  - any `-v` arg passed in. Such a value is an override value
+
+### Steps
+1. Create a template of the offer based on examples [here](../../test/data)
+2. Create a CSV containing the email as the first column and all other required variables in the rest of the columns. Ensure there is a header row.
+3. Identify the following option values
+   1. Credential Agent endpoint and necessary auth token.
+   2. Identify the DID of the issuer organization
+   3. Identify the URL that hosts the terms and conditions.
+   4. Identify any customizations required for the purpose, activatesIn & expiresIn options
+4. Do a dry run and ensure no errors occur
+5. Execute the script without the dryrun flag
+
+## How to Use
+
+`data-loader batchissuing [options]`
+
+### Options
+
+`-d --did [DID]` DID of the issuing organization. One of `tenant` or `did` must be specified.
+
+`-n --tenant [TENANT_ID]` Id of the issuing organization's tenant. One of `tenant` or `did` must be specified.
+
+`-o [OFFER_TEMPLATE_PATH]` **required** path to an offer handlebars template. Use moustaches around variables such as `{{email}}`
+
+`-c [CSV_PATH]` **required** path to the csv file containig variables. The person's mail must be the first column.
+
+`--var=[VAR_NAME]=[VAR_VALUE]` optional variables. Can be used within templates. They override any csv values of the same name
+
+`-p [/PATH/FOO]` **required** path to write the QR code image to. This path must already exist
+
+`--legacy` fallback to legacy batch issuing which will create a QR code per holder
+
+`-e [URL]` **required** url of the target credential agent server
+
+`-a [AUTH_TOKEN]` **required** bearer token to use when calling the credential agent server
+
+`-t [URL]` **required** terms and conditions url for the holder to accept
+
+`--purpose [STRING]` optional purpose to display to the user. Use a maximum for 64 chars. Default is "Career Credential Issuing" 
+
+`--authTokenExpiresIn [AUTH_TOKEN_EXPIRES_IN]` optional time in minutes that the token will expire in after calling `/submit-identification`. Default is 10080 minutes expiry
+
+`-x` optional output a csv file containing the deeplink and path to the qr code
+
+`--x-name` optional 'The file name for the output CSV. Default is "output"'
+
+`-y --credential-type [CREDENTIAL_TYPE]` optional 'The type of credentials 
+(EmailV1.0, PhoneV1.0, DriversLicenseV1.0). Default is EmailV1.0.'
+
+`--x-vendor-userid-name` optional The column name to use for the vendor user id in the output csv. Default is "email"
+
+`-i --disclosure` optional. If with value, allows the offers and identities to be added to an existing disclosure. If without value, turn on interractive mode
+where need to select available disclosure. If neither --disclosure or --new is provided, it will start interactive mode.
+
+`--new` optional. The offers and identities will be added to a new disclosure.
+
+### Examples
+Executing batch issuing
+
+```
+./data-loader batchissuing -d did:ion:EiAbP9xvCYnUOiLwqgbkV4auH_26Pv7BT2pYYT3masvvhw -o ./test/data/badge-offer.template.json -c ./test/data/batch-vars.csv -p ./tmp -t https://www.example.com/terms.html -e https://devagent.velocitycareerlabs.io -a eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyIjoidmVsb2NpdHkuYWRtaW5AZXhhbXBsZS5jb20ifQ.EoDg_46Qi28tScPD5xwHW4TCdEtN8-gzYoAgFa34fCQ  
+```
+
+Executing batch issuing that produces an output csv named output.csv and email as the first column.
+
+```
+./data-loader batchissuing -x -d did:ion:EiAbP9xvCYnUOiLwqgbkV4auH_26Pv7BT2pYYT3masvvhw -o ./test/data/badge-offer.template.json -c ./test/data/batch-vars.csv -p ./tmp -t https://www.example.com/terms.html -e https://devagent.velocitycareerlabs.io -a eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyIjoidmVsb2NpdHkuYWRtaW5AZXhhbXBsZS5jb20ifQ.EoDg_46Qi28tScPD5xwHW4TCdEtN8-gzYoAgFa34fCQ  
+```
+
+Dry runs that print out the offers that would be issued should omit the `-e` and `-a` props and instead pass in `--dryrun`
+```
+./data-loader batchissuing -d did:ion:EiAbP9xvCYnUOiLwqgbkV4auH_26Pv7BT2pYYT3masvvhw -o ./test/data/badge-offer.template.json -c ./test/data/batch-vars.csv -p ./tmp -t https://www.example.com/terms.html --dryrun
+```
+
+Executing batch issuing with new disclosure.
+```
+./data-loader batchissuing -d did:ion:EiApMLdMb4NPb8sae9-hXGHP79W1gisApVSE80USPEbtJA -o ./data-loader/test/data/badge-offer.template.json -c ./data-loader/test/data/batch-vars.csv -p ./tmp -t https://www.example.com/terms.html -e https://devagent.velocitycareerlabs.io -a eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyIjoidmVsb2NpdHkuYWRtaW5AZXhhbXBsZS5jb20ifQ.EoDg_46Qi28tScPD5xwHW4TCdEtN8-gzYoAgFa34fCQ --new
+```
+
+Executing batch issuing with existing disclosure (interactive mode).
+```
+./data-loader batchissuing -d did:ion:EiApMLdMb4NPb8sae9-hXGHP79W1gisApVSE80USPEbtJA -o ./data-loader/test/data/badge-offer.template.json -c ./data-loader/test/data/batch-vars.csv -p ./tmp -t https://www.example.com/terms.html -e https://devagent.velocitycareerlabs.io -a eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyIjoidmVsb2NpdHkuYWRtaW5AZXhhbXBsZS5jb20ifQ.EoDg_46Qi28tScPD5xwHW4TCdEtN8-gzYoAgFa34fCQ --disclosure
+```

package/src/batch-issuing/constants.js

@@ -0,0 +1,33 @@
+const DisclosureType = {
+  NEW: 'new',
+  EXISTING: 'existing',
+};
+
+const CREDENTIAL_TYPES = {
+  EMAIL: 'EmailV1.0',
+  PHONE: 'PhoneV1.0',
+  DRIVER_LICENSE: 'DriversLicenseV1.0',
+  ID_DOCUMENT: 'IdDocumentV1.0',
+  NATIONAL_ID_CARD: 'NationalIdCardV1.0',
+  PASSPORT: 'PassportV1.0',
+  PROOF_OF_AGE: 'ProofOfAgeV1.0',
+  RESIDENT_PERMIT: 'ResidentPermitV1.0',
+};
+const DEFAULT_ID_DOCUMENT_CREDENTIALS_PATH =
+  '$.idDocumentCredentials[*].credentialSubject.identifier';
+const idCredentialTypeToPick = {
+  [CREDENTIAL_TYPES.EMAIL]: '$.emails',
+  [CREDENTIAL_TYPES.PHONE]: '$.phones',
+  [CREDENTIAL_TYPES.DRIVER_LICENSE]: DEFAULT_ID_DOCUMENT_CREDENTIALS_PATH,
+  [CREDENTIAL_TYPES.ID_DOCUMENT]: DEFAULT_ID_DOCUMENT_CREDENTIALS_PATH,
+  [CREDENTIAL_TYPES.NATIONAL_ID_CARD]: DEFAULT_ID_DOCUMENT_CREDENTIALS_PATH,
+  [CREDENTIAL_TYPES.PASSPORT]: DEFAULT_ID_DOCUMENT_CREDENTIALS_PATH,
+  [CREDENTIAL_TYPES.PROOF_OF_AGE]: DEFAULT_ID_DOCUMENT_CREDENTIALS_PATH,
+  [CREDENTIAL_TYPES.RESIDENT_PERMIT]: DEFAULT_ID_DOCUMENT_CREDENTIALS_PATH,
+};
+
+module.exports = {
+  DisclosureType,
+  CREDENTIAL_TYPES,
+  idCredentialTypeToPick,
+};

package/src/batch-issuing/fetchers.js

@@ -0,0 +1,114 @@
+const { env } = require('node:process');
+const got = require('got');
+const { map, isEmpty } = require('lodash/fp');
+const { printInfo } = require('../helpers/common');
+
+const setupGot = ({ endpoint, authToken }) => {
+  const options = {};
+  if (endpoint != null) {
+    options.prefixUrl = `${endpoint}/operator-api/v0.8`;
+  }
+  if (authToken != null) {
+    options.headers = { Authorization: `Bearer ${authToken}` };
+  }
+  if (env.NODE_TLS_REJECT_UNAUTHORIZED === '0') {
+    options.https = {
+      rejectUnauthorized: false,
+    };
+  }
+  return got.extend(options);
+};
+
+const initFetchers = (options) => {
+  const credentialAgentTenantGot = setupGot(options);
+  const param = getTenantsRouteParam(options);
+  return {
+    getTenant: async () => {
+      printInfo('Retrieving tenant');
+      return credentialAgentTenantGot.get(`tenants/${param}`).json();
+    },
+    createDisclosure: async (disclosureRequest) => {
+      printInfo('Creating disclosure');
+      return credentialAgentTenantGot
+        .post(`tenants/${param}/disclosures`, {
+          json: disclosureRequest,
+        })
+        .json();
+    },
+    getDisclosureList: async (vendorEndpoints) => {
+      printInfo('Retrieving disclosure list');
+      const url = new URL(
+        `tenants/${param}/disclosures`,
+        credentialAgentTenantGot.defaults.options.prefixUrl
+      );
+
+      if (!isEmpty(vendorEndpoints)) {
+        vendorEndpoints.forEach((vendorEndpoint) => {
+          url.searchParams.append('vendorEndpoint', vendorEndpoint);
+        });
+      }
+
+      return credentialAgentTenantGot.get(url).json();
+    },
+    getDisclosure: async (disclosureId) => {
+      printInfo('Retrieving disclosure');
+      return credentialAgentTenantGot
+        .get(`tenants/${param}/disclosures/${disclosureId}`)
+        .json();
+    },
+    createOfferExchange: async (newExchange) => {
+      printInfo('Creating exchange');
+      return credentialAgentTenantGot
+        .post(`tenants/${param}/exchanges`, {
+          json: newExchange,
+        })
+        .json();
+    },
+    createOffer: async (exchange, newOffer) => {
+      printInfo(
+        `Adding offer ${newOffer.offerId} to exchange id: ${exchange.id}`
+      );
+      return credentialAgentTenantGot
+        .post(`tenants/${param}/exchanges/${exchange.id}/offers`, {
+          json: newOffer,
+        })
+        .json();
+    },
+    submitCompleteOffer: async (exchange, offers) => {
+      printInfo(
+        `Completing exchange id: ${exchange.id} with offers ${map(
+          'id',
+          offers
+        )}`
+      );
+      return credentialAgentTenantGot
+        .post(`tenants/${param}/exchanges/${exchange.id}/offers/complete`)
+        .json();
+    },
+    loadExchangeQrcode: async (exchange) =>
+      (
+        await credentialAgentTenantGot.get(
+          `tenants/${param}/exchanges/${exchange.id}/qrcode.png`
+        )
+      ).rawBody,
+    loadExchangeDeeplink: async (exchange) =>
+      credentialAgentTenantGot
+        .get(`tenants/${param}/exchanges/${exchange.id}/qrcode.uri`)
+        .text(),
+    loadDisclosureQrcode: async (disclosure) =>
+      (
+        await credentialAgentTenantGot.get(
+          `tenants/${param}/disclosures/${disclosure.id}/qrcode.png`
+        )
+      ).rawBody,
+    loadDisclosureDeeplink: async (disclosure) =>
+      credentialAgentTenantGot
+        .get(`tenants/${param}/disclosures/${disclosure.id}/qrcode.uri`)
+        .text(),
+  };
+};
+
+const getTenantsRouteParam = (options) => options.tenant ?? options.did;
+module.exports = {
+  initFetchers,
+};

package/src/batch-issuing/file-readers.js

@@ -0,0 +1,15 @@
+const fsPromises = require('fs').promises;
+const { join } = require('path');
+
+const loadFilePath = (jsonName, { path }) => {
+  const fileName = `${jsonName}.json`;
+  return join(path, fileName);
+};
+
+const readJsonFile = async ({ filePath, jsonName }, options) => {
+  const readFilePath = filePath ?? loadFilePath(jsonName, options);
+  const jsonString = await fsPromises.readFile(readFilePath);
+  return JSON.parse(jsonString);
+};
+
+module.exports = { readJsonFile };

package/src/batch-issuing/file-writers.js

@@ -0,0 +1,34 @@
+const fsPromises = require('fs').promises;
+const { join } = require('path');
+const fs = require('fs');
+
+const OUTPUT_CSV_HEADERS = ['deeplink', 'qrcodepath'];
+
+const writeQrCodeFile = async (identifier, qrcode, { path }) => {
+  const fileName = `${identifier}.png`;
+  const filePath = join(path, fileName);
+  await fsPromises.writeFile(filePath, qrcode);
+  return { fileName, filePath };
+};
+
+const writeJsonFile = async (obj, jsonName, { path }) => {
+  const fileName = `${jsonName}.json`;
+  const filePath = join(path, fileName);
+  await fsPromises.writeFile(filePath, JSON.stringify(obj));
+  return { fileName, filePath };
+};
+
+const writeOutputCsv = (data, { path, outputCsvName, vendorUserIdColName }) => {
+  const fileName = `${outputCsvName}.csv`;
+  const filePath = join(path, fileName);
+  const buff = fs.createWriteStream(filePath, {});
+  buff.write([vendorUserIdColName, ...OUTPUT_CSV_HEADERS].join(','));
+  for (const { vendorUserId, deeplink, qrcodeFilePath } of data) {
+    buff.write(`\n${vendorUserId},${deeplink},${qrcodeFilePath}`);
+  }
+  buff.end();
+
+  return { filePath };
+};
+
+module.exports = { writeQrCodeFile, writeOutputCsv, writeJsonFile };