@opengovsg/formsg-sdk 7.5.0 → 8.0.0

package/cjs-entry.cjs

@@ -2,4 +2,7 @@
 // TypeScript compiles `export default function` to `exports.default = fn`,
 // but CJS consumers expect `require('@opengovsg/formsg-sdk')` to return
 // the function directly (matching the old v0.15.0 behavior).
-module.exports = require('./dist/cjs/index.js').default
+// Object.assign preserves named exports (adaptV3ToV4, etc.) on the
+// callable default so both `formsg(config)` and `formsg.adaptV3ToV4` work.
+const mod = require('./dist/cjs/index.js')
+module.exports = Object.assign(mod.default, mod)

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

@@ -1,6 +1,6 @@
 import CryptoBase from './crypto-base';
 import { DecryptedContentV3, DecryptParams, DecryptParamsV3, EncryptedContentV3 } from './types';
-import { DecryptedContentV4, FieldResponsesV4, FormFieldMeta } from './types-v4';
+import { DecryptedContentV4, DecryptParamsV4, FieldResponsesV4, FormFieldMeta } from './types-v4';
 /**
  * Checks whether decrypted responses are already in V4 format.
  * V4 entries have a `provenance` object, which V3 entries lack.
@@ -49,7 +49,7 @@ export default class CryptoV3 extends CryptoBase {
      * @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;
+    decryptToV4: (formSecretKey: string, decryptParams: DecryptParamsV4, 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

@@ -209,8 +209,16 @@ var CryptoV3 = /** @class */ (function (_super) {
             var responses = isFieldResponsesV4(decrypted.responses)
                 ? backfillMissingQuestions(decrypted.responses, formFields)
                 : (0, adapt_v3_to_v4_1.adaptV3ToV4)(decrypted.responses, { formFields: formFields });
+            var stepToken = undefined;
+            if (decryptParams.encryptedStepToken) {
+                var decryptedStepToken = (0, crypto_1.decryptContent)(formSecretKey, decryptParams.encryptedStepToken);
+                if (decryptedStepToken) {
+                    stepToken = (0, tweetnacl_util_1.encodeUTF8)(decryptedStepToken);
+                }
+            }
             return {
                 submissionSecretKey: decrypted.submissionSecretKey,
+                stepToken: stepToken,
                 responses: responses,
                 verified: decrypted.verified,
             };

package/dist/cjs/index.d.ts

@@ -7,6 +7,7 @@ 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 { generateUUID } from './util/crypto';
 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';
 /**

package/dist/cjs/index.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.GENERIC_STRING_FIELD_TYPES = exports.ADDRESS_SUBFIELD_KEYS = exports.isFieldResponsesV4 = exports.adaptV4ToV3 = exports.adaptV3ToV4 = void 0;
+exports.generateUUID = 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"));
@@ -19,6 +19,8 @@ Object.defineProperty(exports, "isFieldResponsesV4", { enumerable: true, get: fu
 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; } });
+var crypto_2 = require("./util/crypto");
+Object.defineProperty(exports, "generateUUID", { enumerable: true, get: function () { return crypto_2.generateUUID; } });
 /**
  * Entrypoint into the FormSG SDK
  *

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

@@ -1,4 +1,4 @@
-import { FieldType } from './types';
+import { DecryptParamsV3, EncryptedContent, FieldType } from './types';
 export type ResponseProvenance = {
     submittedAt?: string;
     stepNumber?: number;
@@ -140,8 +140,12 @@ export type AdaptV3ToV4Options = {
     /** Form field definitions keyed by field ID, used to populate question text and myInfo. */
     formFields?: Record<string, FormFieldMeta>;
 };
+export interface DecryptParamsV4 extends DecryptParamsV3 {
+    encryptedStepToken?: EncryptedContent;
+}
 export type DecryptedContentV4 = {
     submissionSecretKey: string;
+    stepToken?: string;
     responses: FieldResponsesV4;
     verified?: Record<string, any>;
 };

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

@@ -1,6 +1,6 @@
 import CryptoBase from './crypto-base';
 import { DecryptedContentV3, DecryptParams, DecryptParamsV3, EncryptedContentV3 } from './types';
-import { DecryptedContentV4, FieldResponsesV4, FormFieldMeta } from './types-v4';
+import { DecryptedContentV4, DecryptParamsV4, FieldResponsesV4, FormFieldMeta } from './types-v4';
 /**
  * Checks whether decrypted responses are already in V4 format.
  * V4 entries have a `provenance` object, which V3 entries lack.
@@ -49,7 +49,7 @@ export default class CryptoV3 extends CryptoBase {
      * @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;
+    decryptToV4: (formSecretKey: string, decryptParams: DecryptParamsV4, 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/esm/crypto-v3.js

@@ -203,8 +203,16 @@ var CryptoV3 = /** @class */ (function (_super) {
             var responses = isFieldResponsesV4(decrypted.responses)
                 ? backfillMissingQuestions(decrypted.responses, formFields)
                 : adaptV3ToV4(decrypted.responses, { formFields: formFields });
+            var stepToken = undefined;
+            if (decryptParams.encryptedStepToken) {
+                var decryptedStepToken = decryptContent(formSecretKey, decryptParams.encryptedStepToken);
+                if (decryptedStepToken) {
+                    stepToken = encodeUTF8(decryptedStepToken);
+                }
+            }
             return {
                 submissionSecretKey: decrypted.submissionSecretKey,
+                stepToken: stepToken,
                 responses: responses,
                 verified: decrypted.verified,
             };

package/dist/esm/index.d.ts

@@ -7,6 +7,7 @@ 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 { generateUUID } from './util/crypto';
 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';
 /**

package/dist/esm/index.js

@@ -7,6 +7,7 @@ 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 { generateUUID } from './util/crypto';
 /**
  * Entrypoint into the FormSG SDK
  *

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

@@ -1,4 +1,4 @@
-import { FieldType } from './types';
+import { DecryptParamsV3, EncryptedContent, FieldType } from './types';
 export type ResponseProvenance = {
     submittedAt?: string;
     stepNumber?: number;
@@ -140,8 +140,12 @@ export type AdaptV3ToV4Options = {
     /** Form field definitions keyed by field ID, used to populate question text and myInfo. */
     formFields?: Record<string, FormFieldMeta>;
 };
+export interface DecryptParamsV4 extends DecryptParamsV3 {
+    encryptedStepToken?: EncryptedContent;
+}
 export type DecryptedContentV4 = {
     submissionSecretKey: string;
+    stepToken?: string;
     responses: FieldResponsesV4;
     verified?: Record<string, any>;
 };

package/package.json

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