@opengovsg/formsg-sdk 7.4.1 → 7.5.0

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

@@ -1,5 +1,11 @@
 import { FormFieldsV3 } from './types';
-import { AdaptV3ToV4Options, FieldResponsesV4 } from './types-v4';
+import { AdaptV3ToV4Options, FieldResponsesV4, FormFieldMeta } from './types-v4';
+/**
+ * Derives question text from form field metadata, prefixing MyInfo fields.
+ * Shared between V3→V4 adaptation and the V4 question backfill in
+ * CryptoV3.decryptToV4 so the two stay consistent.
+ */
+export declare const deriveQuestionFromMeta: (meta?: FormFieldMeta) => string;
 /**
  * Converts V3 decrypted responses to V4 normalized shape.
  *

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

@@ -11,6 +11,7 @@ var __assign = (this && this.__assign) || function () {
     return __assign.apply(this, arguments);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.deriveQuestionFromMeta = void 0;
 exports.adaptV3ToV4 = adaptV3ToV4;
 var constants_v4_1 = require("./constants-v4");
 var crypto_1 = require("./util/crypto");
@@ -81,6 +82,13 @@ var convertSignatureAnswer = function (answer) {
         type: 'draw',
     };
 };
+/**
+ * Derives question text from form field metadata, prefixing MyInfo fields.
+ * Shared between V3→V4 adaptation and the V4 question backfill in
+ * CryptoV3.decryptToV4 so the two stay consistent.
+ */
+var deriveQuestionFromMeta = function (meta) { var _a, _b; return (meta === null || meta === void 0 ? void 0 : meta.myInfo) ? "[Myinfo] ".concat((_a = meta.question) !== null && _a !== void 0 ? _a : '') : ((_b = meta === null || meta === void 0 ? void 0 : meta.question) !== null && _b !== void 0 ? _b : ''); };
+exports.deriveQuestionFromMeta = deriveQuestionFromMeta;
 // 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)) {
@@ -119,20 +127,18 @@ var convertAnswer = function (fieldType, answer) {
  * @returns V4 responses record
  */
 function adaptV3ToV4(v3Responses, options) {
-    var _a, _b, _c, _d;
+    var _a, _b;
     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];
+    for (var _i = 0, _c = Object.entries(v3Responses); _i < _c.length; _i++) {
+        var _d = _c[_i], fieldId = _d[0], field = _d[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 : '');
+        var question = (0, exports.deriveQuestionFromMeta)(meta);
         v4Responses[fieldId] = __assign({ fieldType: field.fieldType, question: question, answer: convertAnswer(field.fieldType, field.answer), provenance: provenance }, (myInfo && { myInfo: myInfo }));
     }
     return v4Responses;

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

@@ -40,7 +40,8 @@ export default class CryptoV3 extends CryptoBase {
     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 already in V4 format, it is returned with any
+     * missing question text backfilled from the provided formFields metadata.
      * 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.

package/dist/cjs/crypto-v3.js

@@ -58,6 +58,30 @@ function isFieldResponsesV4(responses) {
     var first = entries[0];
     return typeof first.provenance === 'object' && first.provenance !== null;
 }
+/**
+ * Backfills question text (and myInfo metadata) on V4 responses stored
+ * without them, in place. V4 blobs written from wire bodies lack question
+ * text: the receiver shim adapts V3 bodies without the form definition in
+ * scope, and thin V4 wire bodies omit `question` entirely (the server strips
+ * it). Enrich empty questions from the form definition at read time instead.
+ * Responses that already carry a question are left untouched.
+ */
+function backfillMissingQuestions(responses, formFields) {
+    for (var _i = 0, _a = Object.entries(responses); _i < _a.length; _i++) {
+        var _b = _a[_i], fieldId = _b[0], response = _b[1];
+        if (response.question)
+            continue;
+        // Tolerate an omitted formFields map from untyped (JS) callers
+        var meta = formFields === null || formFields === void 0 ? void 0 : formFields[fieldId];
+        if (!meta)
+            continue;
+        response.question = (0, adapt_v3_to_v4_1.deriveQuestionFromMeta)(meta);
+        if (meta.myInfo && !response.myInfo) {
+            response.myInfo = meta.myInfo;
+        }
+    }
+    return responses;
+}
 var CryptoV3 = /** @class */ (function (_super) {
     __extends(CryptoV3, _super);
     function CryptoV3(_a) {
@@ -167,7 +191,8 @@ var CryptoV3 = /** @class */ (function (_super) {
         };
         /**
          * 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 already in V4 format, it is returned with any
+         * missing question text backfilled from the provided formFields metadata.
          * 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.
@@ -179,9 +204,10 @@ var CryptoV3 = /** @class */ (function (_super) {
             var decrypted = _this.decrypt(formSecretKey, decryptParams);
             if (!decrypted)
                 return null;
-            // If the decrypted responses are already in V4 format, return directly
+            // If the decrypted responses are already in V4 format, return them with
+            // any missing question text backfilled from the form definition.
             var responses = isFieldResponsesV4(decrypted.responses)
-                ? decrypted.responses
+                ? backfillMissingQuestions(decrypted.responses, formFields)
                 : (0, adapt_v3_to_v4_1.adaptV3ToV4)(decrypted.responses, { formFields: formFields });
             return {
                 submissionSecretKey: decrypted.submissionSecretKey,

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

@@ -1,5 +1,11 @@
 import { FormFieldsV3 } from './types';
-import { AdaptV3ToV4Options, FieldResponsesV4 } from './types-v4';
+import { AdaptV3ToV4Options, FieldResponsesV4, FormFieldMeta } from './types-v4';
+/**
+ * Derives question text from form field metadata, prefixing MyInfo fields.
+ * Shared between V3→V4 adaptation and the V4 question backfill in
+ * CryptoV3.decryptToV4 so the two stay consistent.
+ */
+export declare const deriveQuestionFromMeta: (meta?: FormFieldMeta) => string;
 /**
  * Converts V3 decrypted responses to V4 normalized shape.
  *

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

@@ -78,6 +78,12 @@ var convertSignatureAnswer = function (answer) {
         type: 'draw',
     };
 };
+/**
+ * Derives question text from form field metadata, prefixing MyInfo fields.
+ * Shared between V3→V4 adaptation and the V4 question backfill in
+ * CryptoV3.decryptToV4 so the two stay consistent.
+ */
+export var deriveQuestionFromMeta = function (meta) { var _a, _b; return (meta === null || meta === void 0 ? void 0 : meta.myInfo) ? "[Myinfo] ".concat((_a = meta.question) !== null && _a !== void 0 ? _a : '') : ((_b = meta === null || meta === void 0 ? void 0 : meta.question) !== null && _b !== void 0 ? _b : ''); };
 // 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 (GENERIC_STRING_FIELD_TYPES.has(fieldType)) {
@@ -116,20 +122,18 @@ var convertAnswer = function (fieldType, answer) {
  * @returns V4 responses record
  */
 export function adaptV3ToV4(v3Responses, options) {
-    var _a, _b, _c, _d;
+    var _a, _b;
     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];
+    for (var _i = 0, _c = Object.entries(v3Responses); _i < _c.length; _i++) {
+        var _d = _c[_i], fieldId = _d[0], field = _d[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 : '');
+        var question = deriveQuestionFromMeta(meta);
         v4Responses[fieldId] = __assign({ fieldType: field.fieldType, question: question, answer: convertAnswer(field.fieldType, field.answer), provenance: provenance }, (myInfo && { myInfo: myInfo }));
     }
     return v4Responses;

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

@@ -40,7 +40,8 @@ export default class CryptoV3 extends CryptoBase {
     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 already in V4 format, it is returned with any
+     * missing question text backfilled from the provided formFields metadata.
      * 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.

package/dist/esm/crypto-v3.js

@@ -38,7 +38,7 @@ var __rest = (this && this.__rest) || function (s, e) {
 import { decodeBase64, decodeUTF8, encodeBase64, encodeUTF8, } from 'tweetnacl-util';
 import { decryptContent, encryptMessage, generateKeypair, verifySignedMessage, } from './util/crypto';
 import { determineIsFormFieldsV3 } from './util/validate';
-import { adaptV3ToV4 } from './adapt-v3-to-v4';
+import { adaptV3ToV4, deriveQuestionFromMeta } from './adapt-v3-to-v4';
 import CryptoBase from './crypto-base';
 import { MissingPublicKeyError } from './errors';
 /**
@@ -52,6 +52,30 @@ export function isFieldResponsesV4(responses) {
     var first = entries[0];
     return typeof first.provenance === 'object' && first.provenance !== null;
 }
+/**
+ * Backfills question text (and myInfo metadata) on V4 responses stored
+ * without them, in place. V4 blobs written from wire bodies lack question
+ * text: the receiver shim adapts V3 bodies without the form definition in
+ * scope, and thin V4 wire bodies omit `question` entirely (the server strips
+ * it). Enrich empty questions from the form definition at read time instead.
+ * Responses that already carry a question are left untouched.
+ */
+function backfillMissingQuestions(responses, formFields) {
+    for (var _i = 0, _a = Object.entries(responses); _i < _a.length; _i++) {
+        var _b = _a[_i], fieldId = _b[0], response = _b[1];
+        if (response.question)
+            continue;
+        // Tolerate an omitted formFields map from untyped (JS) callers
+        var meta = formFields === null || formFields === void 0 ? void 0 : formFields[fieldId];
+        if (!meta)
+            continue;
+        response.question = deriveQuestionFromMeta(meta);
+        if (meta.myInfo && !response.myInfo) {
+            response.myInfo = meta.myInfo;
+        }
+    }
+    return responses;
+}
 var CryptoV3 = /** @class */ (function (_super) {
     __extends(CryptoV3, _super);
     function CryptoV3(_a) {
@@ -161,7 +185,8 @@ var CryptoV3 = /** @class */ (function (_super) {
         };
         /**
          * 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 already in V4 format, it is returned with any
+         * missing question text backfilled from the provided formFields metadata.
          * 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.
@@ -173,9 +198,10 @@ var CryptoV3 = /** @class */ (function (_super) {
             var decrypted = _this.decrypt(formSecretKey, decryptParams);
             if (!decrypted)
                 return null;
-            // If the decrypted responses are already in V4 format, return directly
+            // If the decrypted responses are already in V4 format, return them with
+            // any missing question text backfilled from the form definition.
             var responses = isFieldResponsesV4(decrypted.responses)
-                ? decrypted.responses
+                ? backfillMissingQuestions(decrypted.responses, formFields)
                 : adaptV3ToV4(decrypted.responses, { formFields: formFields });
             return {
                 submissionSecretKey: decrypted.submissionSecretKey,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opengovsg/formsg-sdk",
-  "version": "7.4.1",
+  "version": "7.5.0",
   "main": "./cjs-entry.cjs",
   "module": "./dist/esm/index.js",
   "types": "./dist/cjs/index.d.ts",