@opengovsg/formsg-sdk 7.1.4 → 7.2.0

package/dist/cjs/adapt-v3-to-v4.d.ts

@@ -0,0 +1,10 @@
+import { FormFieldsV3 } from './types';
+import { AdaptV3ToV4Options, FieldResponsesV4 } from './types-v4';
+/**
+ * Converts V3 decrypted responses to V4 normalized shape.
+ *
+ * @param v3Responses - The V3 responses record (field ID → { fieldType, answer })
+ * @param options - Optional provenance metadata to stamp on each response
+ * @returns V4 responses record
+ */
+export declare function adaptV3ToV4(v3Responses: FormFieldsV3, options?: AdaptV3ToV4Options): FieldResponsesV4;

package/dist/cjs/adapt-v3-to-v4.js

@@ -0,0 +1,139 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.adaptV3ToV4 = adaptV3ToV4;
+var constants_v4_1 = require("./constants-v4");
+var crypto_1 = require("./util/crypto");
+var convertStringAnswer = function (answer) {
+    return { value: answer };
+};
+var convertYesNoAnswer = function (answer) {
+    if (answer !== 'Yes' && answer !== 'No') {
+        throw new Error("Invalid yes_no answer: ".concat(answer));
+    }
+    return { value: answer };
+};
+var convertVerifiableAnswer = function (answer) {
+    return __assign({ value: answer.value }, (answer.signature !== undefined && { signature: answer.signature }));
+};
+var convertRadioAnswer = function (answer) {
+    if ('othersInput' in answer) {
+        return { value: answer.othersInput, isOthersInput: true };
+    }
+    return { value: answer.value, isOthersInput: false };
+};
+var convertCheckboxAnswer = function (answer) {
+    return __assign({ value: answer.value }, (answer.othersInput !== undefined && {
+        othersInput: answer.othersInput,
+    }));
+};
+var convertAttachmentAnswer = function (answer) {
+    return __assign({ value: answer.answer, hasBeenScanned: answer.hasBeenScanned }, (answer.md5Hash !== undefined && { md5Hash: answer.md5Hash }));
+};
+var convertTableAnswer = function (answer) {
+    var result = {};
+    for (var i = 0; i < answer.length; i++) {
+        var rowId = (0, crypto_1.generateUUID)();
+        result[rowId] = { rowNum: i, value: answer[i] };
+    }
+    return result;
+};
+var convertChildrenAnswer = function (answer) {
+    var _a;
+    var result = {};
+    for (var i = 0; i < answer.child.length; i++) {
+        var childKey = "child".concat(i);
+        var value = {};
+        for (var j = 0; j < answer.childFields.length; j++) {
+            var attr = answer.childFields[j];
+            value[attr] = {
+                value: (_a = answer.child[i][j]) !== null && _a !== void 0 ? _a : '',
+                myInfo: { attr: attr },
+            };
+        }
+        result[childKey] = { value: value };
+    }
+    return result;
+};
+var convertAddressAnswer = function (answer) {
+    var _a;
+    var subFields = answer.addressSubFields;
+    var result = {};
+    for (var _i = 0, ADDRESS_SUBFIELD_KEYS_1 = constants_v4_1.ADDRESS_SUBFIELD_KEYS; _i < ADDRESS_SUBFIELD_KEYS_1.length; _i++) {
+        var key = ADDRESS_SUBFIELD_KEYS_1[_i];
+        result[key] = { value: (_a = subFields[key]) !== null && _a !== void 0 ? _a : '' };
+    }
+    return result;
+};
+var convertSignatureAnswer = function (answer) {
+    return {
+        value: answer.value,
+        type: 'draw',
+    };
+};
+// since v3 answer types when decrypted in sdk are not well-typed, we do best-effort conversion based on field type
+var convertAnswer = function (fieldType, answer) {
+    if (constants_v4_1.GENERIC_STRING_FIELD_TYPES.has(fieldType)) {
+        return convertStringAnswer(answer);
+    }
+    switch (fieldType) {
+        case 'yes_no':
+            return convertYesNoAnswer(answer);
+        case 'email':
+        case 'mobile':
+            return convertVerifiableAnswer(answer);
+        case 'radiobutton':
+            return convertRadioAnswer(answer);
+        case 'checkbox':
+            return convertCheckboxAnswer(answer);
+        case 'attachment':
+            return convertAttachmentAnswer(answer);
+        case 'table':
+            return convertTableAnswer(answer);
+        case 'children':
+            return convertChildrenAnswer(answer);
+        case 'address':
+            return convertAddressAnswer(answer);
+        case 'signature':
+            return convertSignatureAnswer(answer);
+        default:
+            // Safety fallback: coerce to string for any future field types
+            return convertStringAnswer(String(answer));
+    }
+};
+/**
+ * Converts V3 decrypted responses to V4 normalized shape.
+ *
+ * @param v3Responses - The V3 responses record (field ID → { fieldType, answer })
+ * @param options - Optional provenance metadata to stamp on each response
+ * @returns V4 responses record
+ */
+function adaptV3ToV4(v3Responses, options) {
+    var _a, _b, _c, _d;
+    if (options === void 0) { options = {}; }
+    var provenance = (_a = options.provenance) !== null && _a !== void 0 ? _a : {
+        submittedAt: new Date().toISOString(),
+    };
+    var formFields = (_b = options.formFields) !== null && _b !== void 0 ? _b : {};
+    var v4Responses = {};
+    for (var _i = 0, _e = Object.entries(v3Responses); _i < _e.length; _i++) {
+        var _f = _e[_i], fieldId = _f[0], field = _f[1];
+        var meta = formFields[fieldId];
+        var myInfo = meta === null || meta === void 0 ? void 0 : meta.myInfo;
+        var question = myInfo
+            ? "[Myinfo] ".concat((_c = meta === null || meta === void 0 ? void 0 : meta.question) !== null && _c !== void 0 ? _c : '')
+            : ((_d = meta === null || meta === void 0 ? void 0 : meta.question) !== null && _d !== void 0 ? _d : '');
+        v4Responses[fieldId] = __assign({ fieldType: field.fieldType, question: question, answer: convertAnswer(field.fieldType, field.answer), provenance: provenance }, (myInfo && { myInfo: myInfo }));
+    }
+    return v4Responses;
+}

package/dist/cjs/adapt-v4-to-v3.d.ts

@@ -0,0 +1,9 @@
+import { FormFieldsV3 } from './types';
+import { FieldResponsesV4 } from './types-v4';
+/**
+ * Converts V4 normalized responses back to V3 decrypted response shape.
+ *
+ * @param v4Responses - The V4 responses record (field ID → { fieldType, answer, provenance })
+ * @returns V3 responses record (field ID → { fieldType, answer })
+ */
+export declare function adaptV4ToV3(v4Responses: FieldResponsesV4): FormFieldsV3;

package/dist/cjs/adapt-v4-to-v3.js

@@ -0,0 +1,132 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.adaptV4ToV3 = adaptV4ToV3;
+var constants_v4_1 = require("./constants-v4");
+function convertStringAnswerToV3(answer) {
+    return answer.value;
+}
+function convertYesNoAnswerToV3(answer) {
+    return answer.value;
+}
+function convertVerifiableAnswerToV3(answer) {
+    return __assign({ value: answer.value }, (answer.signature !== undefined && { signature: answer.signature }));
+}
+function convertRadioAnswerToV3(answer) {
+    if (answer.isOthersInput) {
+        return { othersInput: answer.value };
+    }
+    return { value: answer.value };
+}
+function convertCheckboxAnswerToV3(answer) {
+    return __assign({ value: answer.value }, (answer.othersInput !== undefined && {
+        othersInput: answer.othersInput,
+    }));
+}
+function convertAttachmentAnswerToV3(answer) {
+    return __assign({ answer: answer.value, hasBeenScanned: answer.hasBeenScanned }, (answer.md5Hash !== undefined && { md5Hash: answer.md5Hash }));
+}
+function convertTableAnswerToV3(answer) {
+    // Convert { rowId: { rowNum: 0, value: {...} } } to array sorted by rowNum
+    var rows = Object.values(answer).sort(function (a, b) { return a.rowNum - b.rowNum; });
+    return rows.map(function (row) {
+        var result = {};
+        for (var _i = 0, _a = Object.entries(row.value); _i < _a.length; _i++) {
+            var _b = _a[_i], columnId = _b[0], value = _b[1];
+            result[columnId] = String(value);
+        }
+        return result;
+    });
+}
+function convertChildrenAnswerToV3(answer) {
+    var _a, _b;
+    var childKeys = Object.keys(answer);
+    if (childKeys.length === 0) {
+        return { child: [], childFields: [] };
+    }
+    // Extract childFields from the first child
+    var firstChild = answer[childKeys[0]];
+    var childFields = Object.keys(firstChild.value);
+    // Build child array
+    var child = [];
+    for (var _i = 0, childKeys_1 = childKeys; _i < childKeys_1.length; _i++) {
+        var childKey = childKeys_1[_i];
+        var childEntry = answer[childKey];
+        var childValues = [];
+        for (var _c = 0, childFields_1 = childFields; _c < childFields_1.length; _c++) {
+            var attr = childFields_1[_c];
+            childValues.push((_b = (_a = childEntry.value[attr]) === null || _a === void 0 ? void 0 : _a.value) !== null && _b !== void 0 ? _b : '');
+        }
+        child.push(childValues);
+    }
+    return { child: child, childFields: childFields };
+}
+function convertAddressAnswerToV3(answer) {
+    var addressSubFields = {};
+    for (var _i = 0, ADDRESS_SUBFIELD_KEYS_1 = constants_v4_1.ADDRESS_SUBFIELD_KEYS; _i < ADDRESS_SUBFIELD_KEYS_1.length; _i++) {
+        var key = ADDRESS_SUBFIELD_KEYS_1[_i];
+        addressSubFields[key] = answer[key].value;
+    }
+    return { addressSubFields: addressSubFields };
+}
+function convertSignatureAnswerToV3(answer) {
+    return {
+        type: 'draw',
+        value: answer.value,
+    };
+}
+/** Main adaptor */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function convertAnswerToV3(fieldType, answer) {
+    if (constants_v4_1.GENERIC_STRING_FIELD_TYPES.has(fieldType)) {
+        return convertStringAnswerToV3(answer);
+    }
+    switch (fieldType) {
+        case 'yes_no':
+            return convertYesNoAnswerToV3(answer);
+        case 'email':
+        case 'mobile':
+            return convertVerifiableAnswerToV3(answer);
+        case 'radiobutton':
+            return convertRadioAnswerToV3(answer);
+        case 'checkbox':
+            return convertCheckboxAnswerToV3(answer);
+        case 'attachment':
+            return convertAttachmentAnswerToV3(answer);
+        case 'table':
+            return convertTableAnswerToV3(answer);
+        case 'children':
+            return convertChildrenAnswerToV3(answer);
+        case 'address':
+            return convertAddressAnswerToV3(answer);
+        case 'signature':
+            return convertSignatureAnswerToV3(answer);
+        default:
+            // Safety fallback: coerce to string for any future field types
+            return convertStringAnswerToV3(answer);
+    }
+}
+/**
+ * Converts V4 normalized responses back to V3 decrypted response shape.
+ *
+ * @param v4Responses - The V4 responses record (field ID → { fieldType, answer, provenance })
+ * @returns V3 responses record (field ID → { fieldType, answer })
+ */
+function adaptV4ToV3(v4Responses) {
+    var v3Responses = {};
+    for (var _i = 0, _a = Object.entries(v4Responses); _i < _a.length; _i++) {
+        var _b = _a[_i], fieldId = _b[0], field = _b[1];
+        v3Responses[fieldId] = __assign({ fieldType: field.fieldType, answer: convertAnswerToV3(field.fieldType, field.answer) }, (field.myInfo && { myInfo: field.myInfo }));
+    }
+    return v3Responses;
+}

package/dist/cjs/adapters.d.ts

@@ -0,0 +1,3 @@
+export { adaptV3ToV4 } from './adapt-v3-to-v4';
+export { adaptV4ToV3 } from './adapt-v4-to-v3';
+export { isFieldResponsesV4 } from './crypto-v3';

package/dist/cjs/adapters.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isFieldResponsesV4 = exports.adaptV4ToV3 = exports.adaptV3ToV4 = void 0;
+var adapt_v3_to_v4_1 = require("./adapt-v3-to-v4");
+Object.defineProperty(exports, "adaptV3ToV4", { enumerable: true, get: function () { return adapt_v3_to_v4_1.adaptV3ToV4; } });
+var adapt_v4_to_v3_1 = require("./adapt-v4-to-v3");
+Object.defineProperty(exports, "adaptV4ToV3", { enumerable: true, get: function () { return adapt_v4_to_v3_1.adaptV4ToV3; } });
+var crypto_v3_1 = require("./crypto-v3");
+Object.defineProperty(exports, "isFieldResponsesV4", { enumerable: true, get: function () { return crypto_v3_1.isFieldResponsesV4; } });

package/dist/cjs/constants-v4.d.ts

@@ -0,0 +1,3 @@
+import { FieldType } from './types';
+export declare const GENERIC_STRING_FIELD_TYPES: Set<FieldType>;
+export declare const ADDRESS_SUBFIELD_KEYS: readonly ["postalCode", "blockNumber", "streetName", "buildingName", "levelNumber", "unitNumber"];

package/dist/cjs/constants-v4.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ADDRESS_SUBFIELD_KEYS = exports.GENERIC_STRING_FIELD_TYPES = void 0;
+exports.GENERIC_STRING_FIELD_TYPES = new Set([
+    'section',
+    'statement',
+    'image',
+    'number',
+    'decimal',
+    'textfield',
+    'textarea',
+    'homeno',
+    'dropdown',
+    'rating',
+    'nric',
+    'uen',
+    'date',
+    'country_region',
+]);
+exports.ADDRESS_SUBFIELD_KEYS = [
+    'postalCode',
+    'blockNumber',
+    'streetName',
+    'buildingName',
+    'levelNumber',
+    'unitNumber',
+];

package/dist/cjs/crypto-v3.d.ts

@@ -1,5 +1,11 @@
 import CryptoBase from './crypto-base';
 import { DecryptedContentV3, DecryptParams, DecryptParamsV3, EncryptedContentV3 } from './types';
+import { DecryptedContentV4, FieldResponsesV4, FormFieldMeta } from './types-v4';
+/**
+ * Checks whether decrypted responses are already in V4 format.
+ * V4 entries have a `provenance` object, which V3 entries lack.
+ */
+export declare function isFieldResponsesV4(responses: Record<string, unknown>): responses is FieldResponsesV4;
 export default class CryptoV3 extends CryptoBase {
     signingPublicKey?: string;
     constructor({ signingPublicKey }?: {
@@ -32,6 +38,17 @@ export default class CryptoV3 extends CryptoBase {
      * @throws {MissingPublicKeyError} if a public key is not provided when instantiating this class and is needed for verifying signed content.
      */
     decrypt: (formSecretKey: string, decryptParams: DecryptParamsV3) => DecryptedContentV3 | null;
+    /**
+     * Decrypts an encrypted submission and returns it in V4 format.
+     * If the decrypted data is already in V4 format, it is returned directly.
+     * If the decrypted data is in V3 format, it is adapted to V4 using the provided formFields metadata.
+     * @param formSecretKey The base-64 encoded form secret key for decrypting the submission.
+     * @param decryptParams The params containing encrypted content, encrypted submission key and information.
+     * @param formFields A record mapping field IDs to their metadata (question text, myInfo attrs, etc).
+     * @returns The decrypted content in V4 format if successful. Else, null will be returned.
+     * @throws {MissingPublicKeyError} if a public key is not provided when instantiating this class and is needed for verifying signed content.
+     */
+    decryptToV4: (formSecretKey: string, decryptParams: DecryptParamsV3, formFields: Record<string, FormFieldMeta>) => DecryptedContentV4 | null;
     /**
      * Returns true if a pair of public & secret keys are associated with each other
      * @param publicKey The public key to verify against.

package/dist/cjs/crypto-v3.js

@@ -40,11 +40,24 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.isFieldResponsesV4 = isFieldResponsesV4;
 var tweetnacl_util_1 = require("tweetnacl-util");
 var crypto_1 = require("./util/crypto");
 var validate_1 = require("./util/validate");
+var adapt_v3_to_v4_1 = require("./adapt-v3-to-v4");
 var crypto_base_1 = __importDefault(require("./crypto-base"));
 var errors_1 = require("./errors");
+/**
+ * Checks whether decrypted responses are already in V4 format.
+ * V4 entries have a `provenance` object, which V3 entries lack.
+ */
+function isFieldResponsesV4(responses) {
+    var entries = Object.values(responses);
+    if (entries.length === 0)
+        return false;
+    var first = entries[0];
+    return typeof first.provenance === 'object' && first.provenance !== null;
+}
 var CryptoV3 = /** @class */ (function (_super) {
     __extends(CryptoV3, _super);
     function CryptoV3(_a) {
@@ -56,6 +69,7 @@ var CryptoV3 = /** @class */ (function (_super) {
          * @param form The base-64 encoded form public key for encrypting.
          * @returns The encrypted basestring.
          */
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         _this.encrypt = function (msg, formPublicKey) {
             var submissionKeypair = (0, crypto_1.generateKeypair)();
             var encryptedSubmissionSecretKey = (0, crypto_1.encryptMessage)((0, tweetnacl_util_1.decodeBase64)(submissionKeypair.secretKey), formPublicKey);
@@ -151,6 +165,30 @@ var CryptoV3 = /** @class */ (function (_super) {
                 return null;
             }
         };
+        /**
+         * Decrypts an encrypted submission and returns it in V4 format.
+         * If the decrypted data is already in V4 format, it is returned directly.
+         * If the decrypted data is in V3 format, it is adapted to V4 using the provided formFields metadata.
+         * @param formSecretKey The base-64 encoded form secret key for decrypting the submission.
+         * @param decryptParams The params containing encrypted content, encrypted submission key and information.
+         * @param formFields A record mapping field IDs to their metadata (question text, myInfo attrs, etc).
+         * @returns The decrypted content in V4 format if successful. Else, null will be returned.
+         * @throws {MissingPublicKeyError} if a public key is not provided when instantiating this class and is needed for verifying signed content.
+         */
+        _this.decryptToV4 = function (formSecretKey, decryptParams, formFields) {
+            var decrypted = _this.decrypt(formSecretKey, decryptParams);
+            if (!decrypted)
+                return null;
+            // If the decrypted responses are already in V4 format, return directly
+            var responses = isFieldResponsesV4(decrypted.responses)
+                ? decrypted.responses
+                : (0, adapt_v3_to_v4_1.adaptV3ToV4)(decrypted.responses, { formFields: formFields });
+            return {
+                submissionSecretKey: decrypted.submissionSecretKey,
+                responses: responses,
+                verified: decrypted.verified,
+            };
+        };
         /**
          * Returns true if a pair of public & secret keys are associated with each other
          * @param publicKey The public key to verify against.

package/dist/cjs/index.d.ts

@@ -1,9 +1,14 @@
-export type { DecryptedContent, DecryptedContentV3, DecryptParams, DecryptParamsV3, EncryptedAttachmentContent, EncryptedAttachmentRecords, EncryptedContent, EncryptedContentV3, EncryptedFileContent, FieldType, FormField, FormFieldsV3, Keypair, PackageMode, VerificationOptions, } from './types';
 import Crypto from './crypto';
 import CryptoV3 from './crypto-v3';
 import { PackageInitParams } from './types';
 import Verification from './verification';
 import Webhooks from './webhooks';
+export { adaptV3ToV4 } from './adapt-v3-to-v4';
+export { adaptV4ToV3 } from './adapt-v4-to-v3';
+export { isFieldResponsesV4 } from './crypto-v3';
+export { ADDRESS_SUBFIELD_KEYS, GENERIC_STRING_FIELD_TYPES, } from './constants-v4';
+export type { DecryptedContent, DecryptedContentV3, DecryptParams, DecryptParamsV3, EncryptedAttachmentContent, EncryptedAttachmentRecords, EncryptedContent, EncryptedContentV3, EncryptedFileContent, FieldType, FormField, FormFieldsV3, Keypair, PackageMode, VerificationOptions, } from './types';
+export type { AdaptV3ToV4Options, AnswerV4, AddressAnswerV4, AttachmentAnswerV4, CheckboxAnswerV4, ChildrenAnswerV4, DecryptedContentV4, FieldResponsesV4, FieldResponseV4, FormFieldMeta, FormFieldV4, FormFieldsV4, RadioAnswerV4, ResponseProvenance, SignatureAnswerV4, StringAnswerV4, TableAnswerV4, VerifiableAnswerV4, } from './types-v4';
 /**
  * Entrypoint into the FormSG SDK
  *

package/dist/cjs/index.js

@@ -3,12 +3,22 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.GENERIC_STRING_FIELD_TYPES = exports.ADDRESS_SUBFIELD_KEYS = exports.isFieldResponsesV4 = exports.adaptV4ToV3 = exports.adaptV3ToV4 = void 0;
 exports.default = default_1;
 var publicKey_1 = require("./util/publicKey");
 var crypto_1 = __importDefault(require("./crypto"));
 var crypto_v3_1 = __importDefault(require("./crypto-v3"));
 var verification_1 = __importDefault(require("./verification"));
 var webhooks_1 = __importDefault(require("./webhooks"));
+var adapt_v3_to_v4_1 = require("./adapt-v3-to-v4");
+Object.defineProperty(exports, "adaptV3ToV4", { enumerable: true, get: function () { return adapt_v3_to_v4_1.adaptV3ToV4; } });
+var adapt_v4_to_v3_1 = require("./adapt-v4-to-v3");
+Object.defineProperty(exports, "adaptV4ToV3", { enumerable: true, get: function () { return adapt_v4_to_v3_1.adaptV4ToV3; } });
+var crypto_v3_2 = require("./crypto-v3");
+Object.defineProperty(exports, "isFieldResponsesV4", { enumerable: true, get: function () { return crypto_v3_2.isFieldResponsesV4; } });
+var constants_v4_1 = require("./constants-v4");
+Object.defineProperty(exports, "ADDRESS_SUBFIELD_KEYS", { enumerable: true, get: function () { return constants_v4_1.ADDRESS_SUBFIELD_KEYS; } });
+Object.defineProperty(exports, "GENERIC_STRING_FIELD_TYPES", { enumerable: true, get: function () { return constants_v4_1.GENERIC_STRING_FIELD_TYPES; } });
 /**
  * Entrypoint into the FormSG SDK
  *

package/dist/cjs/types-v4.d.ts

@@ -0,0 +1,148 @@
+import { FieldType } from './types';
+export type ResponseProvenance = {
+    submittedAt?: string;
+    stepNumber?: number;
+};
+export type PreviousAnswer = {
+    answer: AnswerV4;
+    provenance?: ResponseProvenance;
+};
+/** Answer Types */
+export type StringAnswerV4 = {
+    value: string;
+};
+export type YesNoAnswerV4 = {
+    value: 'Yes' | 'No';
+};
+export type VerifiableAnswerV4 = {
+    value: string;
+    signature?: string;
+};
+export type RadioAnswerV4 = {
+    value: string;
+    isOthersInput: boolean;
+};
+export type CheckboxAnswerV4 = {
+    value: string[];
+    othersInput?: string;
+};
+export type AttachmentAnswerV4 = {
+    value: string;
+    hasBeenScanned: boolean;
+    md5Hash?: string;
+};
+export type TableRowV4 = {
+    rowNum: number;
+    value: {
+        [columnId: string]: string | number;
+    };
+};
+export type TableAnswerV4 = {
+    [rowId: string]: TableRowV4;
+};
+export type ChildSubFieldAnswerV4 = {
+    value: string;
+    myInfo?: {
+        attr: string;
+    };
+};
+export type ChildEntryV4 = {
+    value: {
+        [attr: string]: ChildSubFieldAnswerV4;
+    };
+    type?: string;
+};
+export type ChildrenAnswerV4 = {
+    [childKey: string]: ChildEntryV4;
+};
+export type AddressAnswerV4 = {
+    postalCode: StringAnswerV4;
+    blockNumber: StringAnswerV4;
+    streetName: StringAnswerV4;
+    buildingName: StringAnswerV4;
+    levelNumber: StringAnswerV4;
+    unitNumber: StringAnswerV4;
+};
+export type SignatureAnswerV4 = {
+    value: [number, number, number][][];
+    type: 'draw';
+};
+export type MyInfoMetaV4 = {
+    attr: string;
+};
+export type AnswerV4 = StringAnswerV4 | YesNoAnswerV4 | VerifiableAnswerV4 | RadioAnswerV4 | CheckboxAnswerV4 | AttachmentAnswerV4 | TableAnswerV4 | ChildrenAnswerV4 | AddressAnswerV4 | SignatureAnswerV4;
+export type FieldResponseV4 = {
+    fieldType: FieldType;
+    answer: AnswerV4;
+    question: string;
+    provenance: ResponseProvenance;
+    previousAnswers?: PreviousAnswer[];
+    myInfo?: MyInfoMetaV4;
+};
+export type FieldResponsesV4 = Record<string, FieldResponseV4>;
+type BaseFieldResponseV4 = {
+    provenance: ResponseProvenance;
+    previousAnswers?: PreviousAnswer[];
+    myInfo?: MyInfoMetaV4;
+    question: string;
+};
+export type StringFieldResponseV4 = BaseFieldResponseV4 & {
+    fieldType: 'section' | 'number' | 'decimal' | 'textfield' | 'textarea' | 'homeno' | 'dropdown' | 'rating' | 'nric' | 'uen' | 'date' | 'country_region';
+    answer: StringAnswerV4;
+};
+export type YesNoFieldResponseV4 = BaseFieldResponseV4 & {
+    fieldType: 'yes_no';
+    answer: YesNoAnswerV4;
+};
+export type VerifiableFieldResponseV4 = BaseFieldResponseV4 & {
+    fieldType: 'email' | 'mobile';
+    answer: VerifiableAnswerV4;
+};
+export type RadioFieldResponseV4 = BaseFieldResponseV4 & {
+    fieldType: 'radiobutton';
+    answer: RadioAnswerV4;
+};
+export type CheckboxFieldResponseV4 = BaseFieldResponseV4 & {
+    fieldType: 'checkbox';
+    answer: CheckboxAnswerV4;
+};
+export type AttachmentFieldResponseV4 = BaseFieldResponseV4 & {
+    fieldType: 'attachment';
+    answer: AttachmentAnswerV4;
+};
+export type TableFieldResponseV4 = BaseFieldResponseV4 & {
+    fieldType: 'table';
+    answer: TableAnswerV4;
+};
+export type ChildrenFieldResponseV4 = BaseFieldResponseV4 & {
+    fieldType: 'children';
+    answer: ChildrenAnswerV4;
+};
+export type AddressFieldResponseV4 = BaseFieldResponseV4 & {
+    fieldType: 'address';
+    answer: AddressAnswerV4;
+};
+export type SignatureFieldResponseV4 = BaseFieldResponseV4 & {
+    fieldType: 'signature';
+    answer: SignatureAnswerV4;
+};
+export type FormFieldV4 = StringFieldResponseV4 | YesNoFieldResponseV4 | VerifiableFieldResponseV4 | RadioFieldResponseV4 | CheckboxFieldResponseV4 | AttachmentFieldResponseV4 | TableFieldResponseV4 | ChildrenFieldResponseV4 | AddressFieldResponseV4 | SignatureFieldResponseV4;
+export type FormFieldsV4 = Record<string, FormFieldV4>;
+export type FormFieldMeta = {
+    question: string;
+    myInfo?: {
+        attr: string;
+    };
+};
+export type AdaptV3ToV4Options = {
+    /** Provenance to stamp on every converted response. */
+    provenance?: ResponseProvenance;
+    /** Form field definitions keyed by field ID, used to populate question text and myInfo. */
+    formFields?: Record<string, FormFieldMeta>;
+};
+export type DecryptedContentV4 = {
+    submissionSecretKey: string;
+    responses: FieldResponsesV4;
+    verified?: Record<string, any>;
+};
+export {};

package/dist/cjs/types-v4.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/util/crypto.d.ts

@@ -40,3 +40,9 @@ export declare const areAttachmentFieldIdsValid: (fieldIds: string[], filenames:
  * @returns EncryptedFileContent The encrypted file content
  */
 export declare const convertEncryptedAttachmentToFileContent: (encryptedAttachment: EncryptedAttachmentContent) => EncryptedFileContent;
+/**
+ * Generates a v4 UUID using the Web Crypto API (crypto.getRandomValues),
+ * which is available in both browsers and Node.js (unlike the 'crypto' module).
+ * https://stackoverflow.com/questions/105034/how-do-i-create-a-guid-uuid
+ */
+export declare const generateUUID: () => string;

package/dist/cjs/util/crypto.js

@@ -3,7 +3,7 @@ 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;
+exports.generateUUID = 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");
 /**
@@ -84,3 +84,15 @@ var convertEncryptedAttachmentToFileContent = function (encryptedAttachment) { r
     binary: (0, tweetnacl_util_1.decodeBase64)(encryptedAttachment.encryptedFile.binary),
 }); };
 exports.convertEncryptedAttachmentToFileContent = convertEncryptedAttachmentToFileContent;
+/**
+ * Generates a v4 UUID using the Web Crypto API (crypto.getRandomValues),
+ * which is available in both browsers and Node.js (unlike the 'crypto' module).
+ * https://stackoverflow.com/questions/105034/how-do-i-create-a-guid-uuid
+ */
+var generateUUID = function () {
+    return '10000000-1000-4000-8000-100000000000'.replace(/[018]/g, function (c) {
+        return (+c ^
+            (crypto.getRandomValues(new Uint8Array(1))[0] & (15 >> (+c / 4)))).toString(16);
+    });
+};
+exports.generateUUID = generateUUID;