@opengovsg/formsg-sdk 0.10.0 → 0.11.0

package/.github/workflows/ci.yml

@@ -6,13 +6,13 @@ on:
 jobs:
   build:
     name: build
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
       - name: Use Node.js
         uses: actions/setup-node@v1
         with:
-          node-version: '10.x'
+          node-version: 18
       - name: Cache Node.js modules
         uses: actions/cache@v2
         with:
@@ -27,13 +27,13 @@ jobs:
       - run: npm run build
   test:
     name: test
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
       - name: Use Node.js
         uses: actions/setup-node@v1
         with:
-          node-version: '10.x'
+          node-version: 18
       - name: Cache Node.js modules
         uses: actions/cache@v2
         with:

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Open Government Products
+
+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

@@ -7,6 +7,10 @@ _Please note that this is an SDK for webhooks integration, and_ **_not_** _the F
 
 This SDK provides convenient utilities for verifying FormSG webhooks and decrypting submissions in JavaScript and Node.js.
 
+Not using Javascript? Check out our sister SDKs:
+- [formsg-python-sdk](https://github.com/opengovsg/formsg-python-sdk)
+- [formsg-ruby-sdk](https://github.com/opengovsg/formsg-ruby-sdk)
+
 ## Installation
 
 Install the package with
@@ -132,7 +136,7 @@ of the returned object.
 Note that due to end-to-end encryption, FormSG servers are unable to verify the data format.
 
 However, the `decrypt` function exposed by this library [validates](https://github.com/opengovsg/formsg-javascript-sdk/blob/master/src/util/validate.ts) the decrypted content and will **return `null` if the
-decrypted content does not fit the schema displayed below.**
+decrypted content does not contain all of the fields displayed in the schema below.**
 
 | Key         | Type     | Description                                                                                              |
 | ----------- | -------- | -------------------------------------------------------------------------------------------------------- |
@@ -142,6 +146,9 @@ decrypted content does not fit the schema displayed below.**
 | fieldType   | string   | The type of field for the question.                                                                      |
 | \_id        | string   | A unique identifier of the form field. WARNING: Changes when new fields are created/removed in the form. |
 
+**Important Note: **
+Additional internal fields may be included in webhooks from time to time, which will then be published as part of our official schema once it is stable for public consumption. If you are applying your own validation, you should account for this e.g. by not rejecting the webhook if there are additional fields included.
+
 The full schema can be viewed in
 [`validate.ts`](https://github.com/opengovsg/formsg-javascript-sdk/tree/master/src/util/validate.ts).
 

package/dist/crypto.d.ts

@@ -1,4 +1,4 @@
-import { DecryptedContent, DecryptedContentAndAttachments, DecryptParams, EncryptedFileContent } from './types';
+import { DecryptedContent, DecryptedContentAndAttachments, DecryptParams, EncryptedContent, EncryptedFileContent } from './types';
 export default class Crypto {
     signingPublicKey?: string;
     constructor({ signingPublicKey }?: {
@@ -11,7 +11,7 @@ export default class Crypto {
      * @param signingPrivateKey Optional. Must be a base-64 encoded private key. If given, will be used to signing the given msg param prior to encrypting.
      * @returns The encrypted basestring.
      */
-    encrypt: (msg: any, encryptionPublicKey: string, signingPrivateKey?: string | undefined) => string;
+    encrypt: (msg: any, encryptionPublicKey: string, signingPrivateKey?: string) => EncryptedContent;
     /**
      * Decrypts an encrypted submission and returns it.
      * @param formSecretKey The base-64 secret key of the form to decrypt with.

package/dist/crypto.js

@@ -14,7 +14,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
             if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
             if (y = 0, t) op = [op[0] & 2, t.value];
             switch (op[0]) {
@@ -47,8 +47,8 @@ var validate_1 = require("./util/validate");
 var errors_1 = require("./errors");
 var Crypto = /** @class */ (function () {
     function Crypto(_a) {
+        var _b = _a === void 0 ? {} : _a, signingPublicKey = _b.signingPublicKey;
         var _this = this;
-        var signingPublicKey = (_a === void 0 ? {} : _a).signingPublicKey;
         /**
          * Encrypt input with a unique keypair for each submission
          * @param encryptionPublicKey The base-64 encoded public key for encrypting.
@@ -57,11 +57,11 @@ var Crypto = /** @class */ (function () {
          * @returns The encrypted basestring.
          */
         this.encrypt = function (msg, encryptionPublicKey, signingPrivateKey) {
-            var processedMsg = tweetnacl_util_1.decodeUTF8(JSON.stringify(msg));
+            var processedMsg = (0, tweetnacl_util_1.decodeUTF8)(JSON.stringify(msg));
             if (signingPrivateKey) {
-                processedMsg = tweetnacl_1.default.sign(processedMsg, tweetnacl_util_1.decodeBase64(signingPrivateKey));
+                processedMsg = tweetnacl_1.default.sign(processedMsg, (0, tweetnacl_util_1.decodeBase64)(signingPrivateKey));
             }
-            return crypto_1.encryptMessage(processedMsg, encryptionPublicKey);
+            return (0, crypto_1.encryptMessage)(processedMsg, encryptionPublicKey);
         };
         /**
          * Decrypts an encrypted submission and returns it.
@@ -78,12 +78,12 @@ var Crypto = /** @class */ (function () {
                 var encryptedContent = decryptParams.encryptedContent, verifiedContent = decryptParams.verifiedContent;
                 // Do not return the transformed object in `_decrypt` function as a signed
                 // object is not encoded in UTF8 and is encoded in Base-64 instead.
-                var decryptedContent = crypto_1.decryptContent(formSecretKey, encryptedContent);
+                var decryptedContent = (0, crypto_1.decryptContent)(formSecretKey, encryptedContent);
                 if (!decryptedContent) {
                     throw new Error('Failed to decrypt content');
                 }
-                var decryptedObject = JSON.parse(tweetnacl_util_1.encodeUTF8(decryptedContent));
-                if (!validate_1.determineIsFormFields(decryptedObject)) {
+                var decryptedObject = JSON.parse((0, tweetnacl_util_1.encodeUTF8)(decryptedContent));
+                if (!(0, validate_1.determineIsFormFields)(decryptedObject)) {
                     throw new Error('Decrypted object does not fit expected shape');
                 }
                 var returnedObject = {
@@ -96,12 +96,12 @@ var Crypto = /** @class */ (function () {
                     // Only care if it is the correct shape if verifiedContent exists, since
                     // we need to append it to the end.
                     // Decrypted message must be able to be authenticated by the public key.
-                    var decryptedVerifiedContent = crypto_1.decryptContent(formSecretKey, verifiedContent);
+                    var decryptedVerifiedContent = (0, crypto_1.decryptContent)(formSecretKey, verifiedContent);
                     if (!decryptedVerifiedContent) {
                         // Returns null if decrypting verified content failed.
                         throw new Error('Failed to decrypt verified content');
                     }
-                    var decryptedVerifiedObject = crypto_1.verifySignedMessage(decryptedVerifiedContent, _this.signingPublicKey);
+                    var decryptedVerifiedObject = (0, crypto_1.verifySignedMessage)(decryptedVerifiedContent, _this.signingPublicKey);
                     returnedObject.verified = decryptedVerifiedObject;
                 }
                 return returnedObject;
@@ -132,10 +132,11 @@ var Crypto = /** @class */ (function () {
             var internalValidationVersion = 1;
             var cipherResponse = _this.encrypt(testResponse, publicKey);
             // Use toString here since the return should be an empty array.
-            return (testResponse.toString() === ((_a = _this.decrypt(secretKey, {
-                encryptedContent: cipherResponse,
-                version: internalValidationVersion,
-            })) === null || _a === void 0 ? void 0 : _a.responses.toString()));
+            return (testResponse.toString() ===
+                ((_a = _this.decrypt(secretKey, {
+                    encryptedContent: cipherResponse,
+                    version: internalValidationVersion,
+                })) === null || _a === void 0 ? void 0 : _a.responses.toString()));
         };
         /**
          * Encrypt given binary file with a unique keypair for each submission.
@@ -151,8 +152,8 @@ var Crypto = /** @class */ (function () {
                 nonce = tweetnacl_1.default.randomBytes(24);
                 return [2 /*return*/, {
                         submissionPublicKey: submissionKeypair.publicKey,
-                        nonce: tweetnacl_util_1.encodeBase64(nonce),
-                        binary: tweetnacl_1.default.box(binary, nonce, tweetnacl_util_1.decodeBase64(formPublicKey), tweetnacl_util_1.decodeBase64(submissionKeypair.secretKey)),
+                        nonce: (0, tweetnacl_util_1.encodeBase64)(nonce),
+                        binary: tweetnacl_1.default.box(binary, nonce, (0, tweetnacl_util_1.decodeBase64)(formPublicKey), (0, tweetnacl_util_1.decodeBase64)(submissionKeypair.secretKey)),
                     }];
             });
         }); };
@@ -168,7 +169,7 @@ var Crypto = /** @class */ (function () {
             var submissionPublicKey = _a.submissionPublicKey, nonce = _a.nonce, encryptedBinary = _a.binary;
             return __awaiter(_this, void 0, void 0, function () {
                 return __generator(this, function (_b) {
-                    return [2 /*return*/, tweetnacl_1.default.box.open(encryptedBinary, tweetnacl_util_1.decodeBase64(nonce), tweetnacl_util_1.decodeBase64(submissionPublicKey), tweetnacl_util_1.decodeBase64(formSecretKey))];
+                    return [2 /*return*/, tweetnacl_1.default.box.open(encryptedBinary, (0, tweetnacl_util_1.decodeBase64)(nonce), (0, tweetnacl_util_1.decodeBase64)(submissionPublicKey), (0, tweetnacl_util_1.decodeBase64)(formSecretKey))];
                 });
             });
         };
@@ -202,7 +203,7 @@ var Crypto = /** @class */ (function () {
                         });
                         fieldIds = Object.keys(attachmentRecords);
                         // Check if all fieldIds are within filenames
-                        if (!crypto_1.areAttachmentFieldIdsValid(fieldIds, filenames)) {
+                        if (!(0, crypto_1.areAttachmentFieldIdsValid)(fieldIds, filenames)) {
                             return [2 /*return*/, null];
                         }
                         downloadPromises = fieldIds.map(function (fieldId) {
@@ -214,7 +215,7 @@ var Crypto = /** @class */ (function () {
                                 // Decrypt all the attachments
                                 .then(function (_a) {
                                 var downloadResponse = _a.data;
-                                var encryptedFile = crypto_1.convertEncryptedAttachmentToFileContent(downloadResponse);
+                                var encryptedFile = (0, crypto_1.convertEncryptedAttachmentToFileContent)(downloadResponse);
                                 return _this.decryptFile(formSecretKey, encryptedFile);
                             })
                                 .then(function (decryptedFile) {

package/dist/errors.js

@@ -3,16 +3,19 @@ var __extends = (this && this.__extends) || (function () {
     var extendStatics = function (d, b) {
         extendStatics = Object.setPrototypeOf ||
             ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
         return extendStatics(d, b);
     };
     return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
         extendStatics(d, b);
         function __() { this.constructor = d; }
         d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.AttachmentDecryptionError = exports.WebhookAuthenticateError = exports.MissingPublicKeyError = exports.MissingSecretKeyError = void 0;
 var MissingSecretKeyError = /** @class */ (function (_super) {
     __extends(MissingSecretKeyError, _super);
     function MissingSecretKeyError(message) {

package/dist/index.d.ts

@@ -2,11 +2,6 @@ import Crypto from './crypto';
 import { PackageInitParams } from './types';
 import Verification from './verification';
 import Webhooks from './webhooks';
-declare const _default: (config?: PackageInitParams) => {
-    webhooks: Webhooks;
-    crypto: Crypto;
-    verification: Verification;
-};
 /**
  * Entrypoint into the FormSG SDK
  *
@@ -15,4 +10,9 @@ declare const _default: (config?: PackageInitParams) => {
  * @param {string?} [config.webhookSecretKey] Optional. base64 secret key for signing webhooks. If provided, enables generating signature and headers to authenticate webhook data.
  * @param {VerificationOptions?} [config.verificationOptions] Optional. If provided, enables the usage of the verification module.
  */
+declare const _default: (config?: PackageInitParams) => {
+    webhooks: Webhooks;
+    crypto: Crypto;
+    verification: Verification;
+};
 export = _default;

package/dist/index.js

@@ -13,11 +13,11 @@ module.exports = function (config) {
      * Public key is used for decrypting signed verified content in the `crypto` module, and
      * also for verifying webhook signatures' authenticity in the `wehbooks` module.
      */
-    var signingPublicKey = publicKey_1.getSigningPublicKey(mode || 'production');
+    var signingPublicKey = (0, publicKey_1.getSigningPublicKey)(mode || 'production');
     /**
      * Public key is used for verifying verified field signatures' authenticity in the `verification` module.
      */
-    var verificationPublicKey = publicKey_1.getVerificationPublicKey(mode || 'production');
+    var verificationPublicKey = (0, publicKey_1.getVerificationPublicKey)(mode || 'production');
     return {
         webhooks: new webhooks_1.default({
             publicKey: signingPublicKey,

package/dist/resource/signing-keys.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.SIGNING_KEYS = void 0;
 // keys generated using nacl.sign.keyPair() from tweetnacl
 exports.SIGNING_KEYS = {
     staging: {

package/dist/resource/verification-keys.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.VERIFICATION_KEYS = void 0;
 // keys generated using nacl.sign.keyPair() from tweetnacl
 exports.VERIFICATION_KEYS = {
     staging: {

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-export declare type PackageInitParams = {
+export type PackageInitParams = {
     /** base64 secret key for signing webhooks. If provided, enables generating signature and headers to authenticate webhook data. */
     webhookSecretKey?: string;
     /** If provided, enables the usage of the verification module. */
@@ -6,8 +6,8 @@ export declare type PackageInitParams = {
     /** Initializes public key used for verifying and decrypting in this package. If not given, will default to "production". */
     mode?: PackageMode;
 };
-export declare type FieldType = 'section' | 'radiobutton' | 'dropdown' | 'checkbox' | 'nric' | 'email' | 'table' | 'number' | 'rating' | 'yes_no' | 'decimal' | 'textfield' | 'textarea' | 'attachment' | 'date' | 'mobile' | 'homeno';
-export declare type FormField = {
+export type FieldType = 'section' | 'radiobutton' | 'dropdown' | 'checkbox' | 'nric' | 'email' | 'table' | 'number' | 'rating' | 'yes_no' | 'decimal' | 'textfield' | 'textarea' | 'attachment' | 'date' | 'mobile' | 'homeno';
+export type FormField = {
     _id: string;
     question: string;
     fieldType: FieldType;
@@ -20,61 +20,61 @@ export declare type FormField = {
     answer?: never;
     answerArray: string[] | string[][];
 });
-export declare type EncryptedContent = string;
-export declare type EncryptedAttachmentRecords = Record<string, string>;
+export type EncryptedContent = string;
+export type EncryptedAttachmentRecords = Record<string, string>;
 export interface DecryptParams {
     encryptedContent: EncryptedContent;
     version: number;
     verifiedContent?: EncryptedContent;
     attachmentDownloadUrls?: EncryptedAttachmentRecords;
 }
-export declare type DecryptedContent = {
+export type DecryptedContent = {
     responses: FormField[];
     verified?: Record<string, any>;
 };
-export declare type DecryptedFile = {
+export type DecryptedFile = {
     filename: string;
     content: Uint8Array;
 };
-export declare type DecryptedAttachments = Record<string, DecryptedFile>;
-export declare type DecryptedContentAndAttachments = {
+export type DecryptedAttachments = Record<string, DecryptedFile>;
+export type DecryptedContentAndAttachments = {
     content: DecryptedContent;
     attachments: DecryptedAttachments;
 };
-export declare type EncryptedFileContent = {
+export type EncryptedFileContent = {
     submissionPublicKey: string;
     nonce: string;
     binary: Uint8Array;
 };
-export declare type EncryptedAttachmentContent = {
+export type EncryptedAttachmentContent = {
     encryptedFile: {
         submissionPublicKey: string;
         nonce: string;
         binary: string;
     };
 };
-export declare type Keypair = {
+export type Keypair = {
     publicKey: string;
     secretKey: string;
 };
-export declare type PackageMode = 'staging' | 'production' | 'development' | 'test';
-export declare type VerificationOptions = {
+export type PackageMode = 'staging' | 'production' | 'development' | 'test';
+export type VerificationOptions = {
     publicKey?: string;
     secretKey?: string;
     transactionExpiry?: number;
 };
-export declare type VerifiedAnswer = {
+export type VerifiedAnswer = {
     fieldId: string;
     answer: string;
 };
-export declare type VerificationSignatureOptions = VerifiedAnswer & {
+export type VerificationSignatureOptions = VerifiedAnswer & {
     transactionId: string;
     formId: string;
 };
-export declare type VerificationBasestringOptions = VerificationSignatureOptions & {
+export type VerificationBasestringOptions = VerificationSignatureOptions & {
     time: number;
 };
-export declare type VerificationAuthenticateOptions = VerifiedAnswer & {
+export type VerificationAuthenticateOptions = VerifiedAnswer & {
     signatureString: string;
     submissionCreatedAt: number;
 };

package/dist/util/crypto.d.ts

@@ -1,4 +1,4 @@
-import { Keypair, EncryptedAttachmentContent, EncryptedFileContent } from '../types';
+import { Keypair, EncryptedContent, EncryptedAttachmentContent, EncryptedFileContent } from '../types';
 /**
  * Helper method to generate a new keypair for encryption.
  * @returns The generated keypair.
@@ -11,14 +11,14 @@ export declare const generateKeypair: () => Keypair;
  * @returns The encrypted basestring
  * @throws error if any of the encrypt methods fail
  */
-export declare const encryptMessage: (msg: Uint8Array, theirPublicKey: string) => string;
+export declare const encryptMessage: (msg: Uint8Array, theirPublicKey: string) => EncryptedContent;
 /**
  * Helper method to decrypt an encrypted submission.
  * @param formPrivateKey base64
  * @param encryptedContent encrypted string encoded in base64
  * @return The decrypted content, or null if decryption failed.
  */
-export declare const decryptContent: (formPrivateKey: string, encryptedContent: string) => Uint8Array | null;
+export declare const decryptContent: (formPrivateKey: string, encryptedContent: EncryptedContent) => Uint8Array | null;
 /**
  * Helper method to verify a signed message.
  * @param msg the message to verify

package/dist/util/crypto.js

@@ -3,19 +3,21 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertEncryptedAttachmentToFileContent = exports.areAttachmentFieldIdsValid = exports.verifySignedMessage = exports.decryptContent = exports.encryptMessage = exports.generateKeypair = void 0;
 var tweetnacl_1 = __importDefault(require("tweetnacl"));
 var tweetnacl_util_1 = require("tweetnacl-util");
 /**
  * Helper method to generate a new keypair for encryption.
  * @returns The generated keypair.
  */
-exports.generateKeypair = function () {
+var generateKeypair = function () {
     var kp = tweetnacl_1.default.box.keyPair();
     return {
-        publicKey: tweetnacl_util_1.encodeBase64(kp.publicKey),
-        secretKey: tweetnacl_util_1.encodeBase64(kp.secretKey),
+        publicKey: (0, tweetnacl_util_1.encodeBase64)(kp.publicKey),
+        secretKey: (0, tweetnacl_util_1.encodeBase64)(kp.secretKey),
     };
 };
+exports.generateKeypair = generateKeypair;
 /**
  * Helper function to encrypt input with a unique keypair for each submission.
  * @param msg The message to encrypt
@@ -23,28 +25,30 @@ exports.generateKeypair = function () {
  * @returns The encrypted basestring
  * @throws error if any of the encrypt methods fail
  */
-exports.encryptMessage = function (msg, theirPublicKey) {
-    var submissionKeypair = exports.generateKeypair();
+var encryptMessage = function (msg, theirPublicKey) {
+    var submissionKeypair = (0, exports.generateKeypair)();
     var nonce = tweetnacl_1.default.randomBytes(24);
-    var encrypted = tweetnacl_util_1.encodeBase64(tweetnacl_1.default.box(msg, nonce, tweetnacl_util_1.decodeBase64(theirPublicKey), tweetnacl_util_1.decodeBase64(submissionKeypair.secretKey)));
-    return submissionKeypair.publicKey + ";" + tweetnacl_util_1.encodeBase64(nonce) + ":" + encrypted;
+    var encrypted = (0, tweetnacl_util_1.encodeBase64)(tweetnacl_1.default.box(msg, nonce, (0, tweetnacl_util_1.decodeBase64)(theirPublicKey), (0, tweetnacl_util_1.decodeBase64)(submissionKeypair.secretKey)));
+    return "".concat(submissionKeypair.publicKey, ";").concat((0, tweetnacl_util_1.encodeBase64)(nonce), ":").concat(encrypted);
 };
+exports.encryptMessage = encryptMessage;
 /**
  * Helper method to decrypt an encrypted submission.
  * @param formPrivateKey base64
  * @param encryptedContent encrypted string encoded in base64
  * @return The decrypted content, or null if decryption failed.
  */
-exports.decryptContent = function (formPrivateKey, encryptedContent) {
+var decryptContent = function (formPrivateKey, encryptedContent) {
     try {
         var _a = encryptedContent.split(';'), submissionPublicKey = _a[0], nonceEncrypted = _a[1];
         var _b = nonceEncrypted.split(':').map(tweetnacl_util_1.decodeBase64), nonce = _b[0], encrypted = _b[1];
-        return tweetnacl_1.default.box.open(encrypted, nonce, tweetnacl_util_1.decodeBase64(submissionPublicKey), tweetnacl_util_1.decodeBase64(formPrivateKey));
+        return tweetnacl_1.default.box.open(encrypted, nonce, (0, tweetnacl_util_1.decodeBase64)(submissionPublicKey), (0, tweetnacl_util_1.decodeBase64)(formPrivateKey));
     }
     catch (err) {
         return null;
     }
 };
+exports.decryptContent = decryptContent;
 /**
  * Helper method to verify a signed message.
  * @param msg the message to verify
@@ -52,28 +56,31 @@ exports.decryptContent = function (formPrivateKey, encryptedContent) {
  * @returns the signed message if successful, else an error will be thrown
  * @throws {Error} if the message cannot be verified
  */
-exports.verifySignedMessage = function (msg, publicKey) {
-    var openedMessage = tweetnacl_1.default.sign.open(msg, tweetnacl_util_1.decodeBase64(publicKey));
+var verifySignedMessage = function (msg, publicKey) {
+    var openedMessage = tweetnacl_1.default.sign.open(msg, (0, tweetnacl_util_1.decodeBase64)(publicKey));
     if (!openedMessage)
         throw new Error('Failed to open signed message with given public key');
-    return JSON.parse(tweetnacl_util_1.encodeUTF8(openedMessage));
+    return JSON.parse((0, tweetnacl_util_1.encodeUTF8)(openedMessage));
 };
+exports.verifySignedMessage = verifySignedMessage;
 /**
  * Helper method to check if all the field IDs given are within the filenames
  * @param fieldIds the list of fieldIds to check
  * @param filenames the filenames that should contain the fields
  * @returns boolean indicating whether the fields are valid
  */
-exports.areAttachmentFieldIdsValid = function (fieldIds, filenames) {
+var areAttachmentFieldIdsValid = function (fieldIds, filenames) {
     return fieldIds.every(function (fieldId) { return filenames[fieldId]; });
 };
+exports.areAttachmentFieldIdsValid = areAttachmentFieldIdsValid;
 /**
  * Converts an encrypted attachment to encrypted file content
  * @param encryptedAttachment The encrypted attachment
  * @returns EncryptedFileContent The encrypted file content
  */
-exports.convertEncryptedAttachmentToFileContent = function (encryptedAttachment) { return ({
+var convertEncryptedAttachmentToFileContent = function (encryptedAttachment) { return ({
     submissionPublicKey: encryptedAttachment.encryptedFile.submissionPublicKey,
     nonce: encryptedAttachment.encryptedFile.nonce,
-    binary: tweetnacl_util_1.decodeBase64(encryptedAttachment.encryptedFile.binary),
+    binary: (0, tweetnacl_util_1.decodeBase64)(encryptedAttachment.encryptedFile.binary),
 }); };
+exports.convertEncryptedAttachmentToFileContent = convertEncryptedAttachmentToFileContent;

package/dist/util/parser.d.ts

@@ -1,10 +1,10 @@
-export declare type HeaderSignature = {
+export type HeaderSignature = {
     v1: string;
     t: number;
     s: string;
     f: string;
 };
-export declare type VerificationSignature = {
+export type VerificationSignature = {
     v: string;
     t: number;
     s: string;

package/dist/util/parser.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseVerificationSignature = exports.parseSignatureHeader = void 0;
 /**
  * Helper function to retrieve keys-values in a signature.
  * @param signature The signature to convert to a keymap
@@ -20,18 +21,20 @@ var signatureToKeyMap = function (signature) {
  * @param header The X-FormSG-Signature header
  * @returns The signature header constituents
  */
-exports.parseSignatureHeader = function (header) {
+var parseSignatureHeader = function (header) {
     var parsedSignature = signatureToKeyMap(header);
     parsedSignature.t = Number(parsedSignature.t);
     return parsedSignature;
 };
+exports.parseSignatureHeader = parseSignatureHeader;
 /**
  * Parses the verification signature into its constituent
  * @param signature The verification signature
  * @returns The verification signature constituents
  */
-exports.parseVerificationSignature = function (signature) {
+var parseVerificationSignature = function (signature) {
     var parsedSignature = signatureToKeyMap(signature);
     parsedSignature.t = Number(parsedSignature.t);
     return parsedSignature;
 };
+exports.parseVerificationSignature = parseVerificationSignature;

package/dist/util/publicKey.js

@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getVerificationPublicKey = exports.getSigningPublicKey = void 0;
 var signing_keys_1 = require("../resource/signing-keys");
 var verification_keys_1 = require("../resource/verification-keys");
 var stage_1 = __importDefault(require("./stage"));

package/dist/util/signature.js

@@ -1,12 +1,29 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
 var __importStar = (this && this.__importStar) || function (mod) {
     if (mod && mod.__esModule) return mod;
     var result = {};
-    if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
-    result["default"] = mod;
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.verify = exports.sign = void 0;
 var tweetnacl = __importStar(require("tweetnacl"));
 var tweetnacl_util_1 = require("tweetnacl-util");
 /**
@@ -16,7 +33,7 @@ var tweetnacl_util_1 = require("tweetnacl-util");
  * @return base64 encoded signature
  */
 function sign(basestring, secretKey) {
-    return tweetnacl_util_1.encodeBase64(tweetnacl.sign.detached(tweetnacl_util_1.decodeUTF8(basestring), tweetnacl_util_1.decodeBase64(secretKey)));
+    return (0, tweetnacl_util_1.encodeBase64)(tweetnacl.sign.detached((0, tweetnacl_util_1.decodeUTF8)(basestring), (0, tweetnacl_util_1.decodeBase64)(secretKey)));
 }
 exports.sign = sign;
 /**
@@ -27,6 +44,6 @@ exports.sign = sign;
  * @return True if verification checks out, false otherwise
  */
 function verify(message, signature, publicKey) {
-    return tweetnacl.sign.detached.verify(tweetnacl_util_1.decodeUTF8(message), tweetnacl_util_1.decodeBase64(signature), tweetnacl_util_1.decodeBase64(publicKey));
+    return tweetnacl.sign.detached.verify((0, tweetnacl_util_1.decodeUTF8)(message), (0, tweetnacl_util_1.decodeBase64)(signature), (0, tweetnacl_util_1.decodeBase64)(publicKey));
 }
 exports.verify = verify;

package/dist/util/validate.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.determineIsFormFields = void 0;
 function determineIsFormFields(tbd) {
     if (!Array.isArray(tbd)) {
         return false;

package/dist/util/webhooks.js

@@ -1,12 +1,29 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
 var __importStar = (this && this.__importStar) || function (mod) {
     if (mod && mod.__esModule) return mod;
     var result = {};
-    if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
-    result["default"] = mod;
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.hasEpochExpired = exports.isSignatureHeaderValid = void 0;
 var url = __importStar(require("url"));
 var errors_1 = require("../errors");
 var signature_1 = require("./signature");
@@ -23,8 +40,8 @@ var isSignatureHeaderValid = function (uri, signatureHeader, publicKey) {
     if (!epoch || !signature || !submissionId || !formId) {
         throw new errors_1.WebhookAuthenticateError('X-FormSG-Signature header is invalid');
     }
-    var baseString = url.parse(uri).href + "." + submissionId + "." + formId + "." + epoch;
-    return signature_1.verify(baseString, signature, publicKey);
+    var baseString = "".concat(url.parse(uri).href, ".").concat(submissionId, ".").concat(formId, ".").concat(epoch);
+    return (0, signature_1.verify)(baseString, signature, publicKey);
 };
 exports.isSignatureHeaderValid = isSignatureHeaderValid;
 /**

package/dist/verification/index.js

@@ -33,27 +33,27 @@ var Verification = /** @class */ (function () {
                 throw new errors_1.MissingPublicKeyError();
             }
             try {
-                var _b = parser_1.parseVerificationSignature(signatureString), transactionId = _b.v, time = _b.t, formId = _b.f, signature = _b.s;
+                var _b = (0, parser_1.parseVerificationSignature)(signatureString), transactionId = _b.v, time = _b.t, formId = _b.f, signature = _b.s;
                 if (!time) {
                     throw new Error('Malformed signature string was passed into function');
                 }
-                if (utils_1.isSignatureTimeValid(time, submissionCreatedAt, _this.transactionExpiry)) {
-                    var data = utils_1.formatToBaseString({
+                if ((0, utils_1.isSignatureTimeValid)(time, submissionCreatedAt, _this.transactionExpiry)) {
+                    var data = (0, utils_1.formatToBaseString)({
                         transactionId: transactionId,
                         formId: formId,
                         fieldId: fieldId,
                         answer: answer,
                         time: time,
                     });
-                    return tweetnacl_1.default.sign.detached.verify(tweetnacl_util_1.decodeUTF8(data), tweetnacl_util_1.decodeBase64(signature), tweetnacl_util_1.decodeBase64(_this.verificationPublicKey));
+                    return tweetnacl_1.default.sign.detached.verify((0, tweetnacl_util_1.decodeUTF8)(data), (0, tweetnacl_util_1.decodeBase64)(signature), (0, tweetnacl_util_1.decodeBase64)(_this.verificationPublicKey));
                 }
                 else {
-                    console.info("Signature was expired for signatureString=\"" + signatureString + "\" signatureDate=\"" + time + "\" submissionCreatedAt=\"" + submissionCreatedAt + "\"");
+                    console.info("Signature was expired for signatureString=\"".concat(signatureString, "\" signatureDate=\"").concat(time, "\" submissionCreatedAt=\"").concat(submissionCreatedAt, "\""));
                     return false;
                 }
             }
             catch (error) {
-                console.error("An error occurred for             signatureString=\"" + signatureString + "\"             submissionCreatedAt=\"" + submissionCreatedAt + "\"             fieldId=\"" + fieldId + "\"             answer=\"" + answer + "\"             error=\"" + error + "\"");
+                console.error("An error occurred for             signatureString=\"".concat(signatureString, "\"             submissionCreatedAt=\"").concat(submissionCreatedAt, "\"             fieldId=\"").concat(fieldId, "\"             answer=\"").concat(answer, "\"             error=\"").concat(error, "\""));
                 return false;
             }
         };
@@ -63,15 +63,15 @@ var Verification = /** @class */ (function () {
                 throw new errors_1.MissingSecretKeyError('Provide a secret key when when initializing the Verification class to use this function.');
             }
             var time = Date.now();
-            var data = utils_1.formatToBaseString({
+            var data = (0, utils_1.formatToBaseString)({
                 transactionId: transactionId,
                 formId: formId,
                 fieldId: fieldId,
                 answer: answer,
                 time: time,
             });
-            var signature = tweetnacl_1.default.sign.detached(tweetnacl_util_1.decodeUTF8(data), tweetnacl_util_1.decodeBase64(_this.verificationSecretKey));
-            return "f=" + formId + ",v=" + transactionId + ",t=" + time + ",s=" + tweetnacl_util_1.encodeBase64(signature);
+            var signature = tweetnacl_1.default.sign.detached((0, tweetnacl_util_1.decodeUTF8)(data), (0, tweetnacl_util_1.decodeBase64)(_this.verificationSecretKey));
+            return "f=".concat(formId, ",v=").concat(transactionId, ",t=").concat(time, ",s=").concat((0, tweetnacl_util_1.encodeBase64)(signature));
         };
         this.verificationPublicKey = params === null || params === void 0 ? void 0 : params.publicKey;
         this.verificationSecretKey = params === null || params === void 0 ? void 0 : params.secretKey;

package/dist/verification/utils.js

@@ -1,20 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatToBaseString = exports.isSignatureTimeValid = void 0;
 /**
  * Checks if signature was made within the given expiry range before
  * submission was created.
  * @param signatureTime ms
  * @param submissionCreatedAt ms
  */
-exports.isSignatureTimeValid = function (signatureTime, submissionCreatedAt, transactionExpiry) {
+var isSignatureTimeValid = function (signatureTime, submissionCreatedAt, transactionExpiry) {
     var maxTime = submissionCreatedAt;
     var minTime = maxTime - transactionExpiry * 1000;
     return signatureTime > minTime && signatureTime < maxTime;
 };
+exports.isSignatureTimeValid = isSignatureTimeValid;
 /**
  * Formats given data into a string for signing
  */
-exports.formatToBaseString = function (_a) {
+var formatToBaseString = function (_a) {
     var transactionId = _a.transactionId, formId = _a.formId, fieldId = _a.fieldId, answer = _a.answer, time = _a.time;
-    return transactionId + "." + formId + "." + fieldId + "." + answer + "." + time;
+    return "".concat(transactionId, ".").concat(formId, ".").concat(fieldId, ".").concat(answer, ".").concat(time);
 };
+exports.formatToBaseString = formatToBaseString;

package/dist/webhooks.js

@@ -1,9 +1,25 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
 var __importStar = (this && this.__importStar) || function (mod) {
     if (mod && mod.__esModule) return mod;
     var result = {};
-    if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
-    result["default"] = mod;
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
@@ -14,8 +30,8 @@ var webhooks_1 = require("./util/webhooks");
 var errors_1 = require("./errors");
 var Webhooks = /** @class */ (function () {
     function Webhooks(_a) {
-        var _this = this;
         var publicKey = _a.publicKey, secretKey = _a.secretKey;
+        var _this = this;
         /**
          * Injects the webhook public key for authentication
          * @param header X-FormSG-Signature header
@@ -25,15 +41,15 @@ var Webhooks = /** @class */ (function () {
          */
         this.authenticate = function (header, uri) {
             // Parse the header
-            var signatureHeader = parser_1.parseSignatureHeader(header);
+            var signatureHeader = (0, parser_1.parseSignatureHeader)(header);
             var signature = signatureHeader.v1, epoch = signatureHeader.t, submissionId = signatureHeader.s, formId = signatureHeader.f;
             // Verify signature authenticity
-            if (!webhooks_1.isSignatureHeaderValid(uri, signatureHeader, _this.publicKey)) {
-                throw new errors_1.WebhookAuthenticateError("Signature could not be verified for uri=" + uri + " submissionId=" + submissionId + " formId=" + formId + " epoch=" + epoch + " signature=" + signature);
+            if (!(0, webhooks_1.isSignatureHeaderValid)(uri, signatureHeader, _this.publicKey)) {
+                throw new errors_1.WebhookAuthenticateError("Signature could not be verified for uri=".concat(uri, " submissionId=").concat(submissionId, " formId=").concat(formId, " epoch=").concat(epoch, " signature=").concat(signature));
             }
             // Verify epoch recency
-            if (webhooks_1.hasEpochExpired(epoch)) {
-                throw new errors_1.WebhookAuthenticateError("Signature is not recent for uri=" + uri + " submissionId=" + submissionId + " formId=" + formId + " epoch=" + epoch + " signature=" + signature);
+            if ((0, webhooks_1.hasEpochExpired)(epoch)) {
+                throw new errors_1.WebhookAuthenticateError("Signature is not recent for uri=".concat(uri, " submissionId=").concat(submissionId, " formId=").concat(formId, " epoch=").concat(epoch, " signature=").concat(signature));
             }
             // All checks pass.
             return true;
@@ -56,8 +72,8 @@ var Webhooks = /** @class */ (function () {
             if (!submissionId || !uri || !formId || !epoch) {
                 throw new TypeError('submissionId, uri, formId, or epoch must be provided to generate a webhook signature');
             }
-            var baseString = url.parse(uri).href + "." + submissionId + "." + formId + "." + epoch;
-            return signature_1.sign(baseString, _this.secretKey);
+            var baseString = "".concat(url.parse(uri).href, ".").concat(submissionId, ".").concat(formId, ".").concat(epoch);
+            return (0, signature_1.sign)(baseString, _this.secretKey);
         };
         /**
          * Constructs the `X-FormSG-Signature` header
@@ -74,7 +90,7 @@ var Webhooks = /** @class */ (function () {
             if (!_this.secretKey) {
                 throw new errors_1.MissingSecretKeyError();
             }
-            return "t=" + epoch + ",s=" + submissionId + ",f=" + formId + ",v1=" + signature;
+            return "t=".concat(epoch, ",s=").concat(submissionId, ",f=").concat(formId, ",v1=").concat(signature);
         };
         this.publicKey = publicKey;
         this.secretKey = secretKey;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opengovsg/formsg-sdk",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/opengovsg/formsg-javascript-sdk.git"
@@ -24,7 +24,7 @@
   "author": "Open Government Products (FormSG)",
   "license": "MIT",
   "dependencies": {
-    "axios": "^0.24.0",
+    "axios": "^1.6.2",
     "tweetnacl": "^1.0.3",
     "tweetnacl-util": "^0.15.1"
   },
@@ -32,8 +32,8 @@
     "@babel/cli": "^7.8.4",
     "@babel/core": "^7.9.0",
     "@babel/preset-env": "^7.9.0",
-    "@types/jest": "^27.0.3",
-    "@types/node": "^13.11.1",
+    "@types/jest": "^29.5.8",
+    "@types/node": "^18.18.9",
     "@typescript-eslint/eslint-plugin": "^4.25.0",
     "auto-changelog": "^2.4.0",
     "coveralls": "^3.1.1",
@@ -43,9 +43,9 @@
     "eslint-plugin-prettier": "^3.4.0",
     "eslint-plugin-simple-import-sort": "^7.0.0",
     "eslint-plugin-typesafe": "^0.5.2",
-    "jest": "^27.3.1",
-    "jest-mock-axios": "^4.4.0",
-    "ts-jest": "^27.0.7",
-    "typescript": "^3.8.3"
+    "jest": "^29.7.0",
+    "jest-mock-axios": "^4.7.3",
+    "ts-jest": "^29.1.1",
+    "typescript": "^4.9.5"
   }
 }