@opengovsg/formsg-sdk 0.12.0-alpha.1 → 0.13.0

package/CHANGELOG.md

@@ -4,6 +4,42 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+#### [v0.13.0](https://github.com/opengovsg/formsg-javascript-sdk/compare/v0.12.0...v0.13.0)
+
+- add address to field type [`#111`](https://github.com/opengovsg/formsg-javascript-sdk/pull/111)
+
+#### [v0.12.0](https://github.com/opengovsg/formsg-javascript-sdk/compare/v0.12.0-alpha.1...v0.12.0)
+
+> 9 September 2024
+
+- build(deps): bump axios from 1.6.4 to 1.7.4 [`#110`](https://github.com/opengovsg/formsg-javascript-sdk/pull/110)
+- chore: update readme for paymentContent [`#105`](https://github.com/opengovsg/formsg-javascript-sdk/pull/105)
+- fix: package.json & package-lock.json to reduce vulnerabilities [`#103`](https://github.com/opengovsg/formsg-javascript-sdk/pull/103)
+
+#### [v0.12.0-alpha.1](https://github.com/opengovsg/formsg-javascript-sdk/compare/v0.11.0...v0.12.0-alpha.1)
+
+> 15 December 2023
+
+- build: bump version to 0.12.0-alpha.1 [`#102`](https://github.com/opengovsg/formsg-javascript-sdk/pull/102)
+- feat: mrf crypto [`#101`](https://github.com/opengovsg/formsg-javascript-sdk/pull/101)
+
+#### [v0.11.0](https://github.com/opengovsg/formsg-javascript-sdk/compare/v0.10.0...v0.11.0)
+
+> 6 December 2023
+
+- build: bump version to 0.11.0 [`#100`](https://github.com/opengovsg/formsg-javascript-sdk/pull/100)
+- Create LICENSE [`#95`](https://github.com/opengovsg/formsg-javascript-sdk/pull/95)
+- chore: upgrade axios to 1.6.2 [`#93`](https://github.com/opengovsg/formsg-javascript-sdk/pull/93)
+- build(deps-dev): bump @babel/traverse from 7.16.3 to 7.23.3 [`#99`](https://github.com/opengovsg/formsg-javascript-sdk/pull/99)
+- build(deps-dev): bump word-wrap from 1.2.3 to 1.2.5 [`#97`](https://github.com/opengovsg/formsg-javascript-sdk/pull/97)
+- Update ci.yml [`#96`](https://github.com/opengovsg/formsg-javascript-sdk/pull/96)
+- chore(readme): add wording for period inclusion of unstable fields [`#94`](https://github.com/opengovsg/formsg-javascript-sdk/pull/94)
+- Update README.md to include existence of sister SDks [`#90`](https://github.com/opengovsg/formsg-javascript-sdk/pull/90)
+- fix: upgrade axios from 0.24.0 to 0.25.0 [`#81`](https://github.com/opengovsg/formsg-javascript-sdk/pull/81)
+- build(deps): bump json5 from 1.0.1 to 1.0.2 [`#88`](https://github.com/opengovsg/formsg-javascript-sdk/pull/88)
+- build: release v0.10.0 [`#87`](https://github.com/opengovsg/formsg-javascript-sdk/pull/87)
+- docs: add changelog and version script [`f207c3e`](https://github.com/opengovsg/formsg-javascript-sdk/commit/f207c3e42cb81347e1fbb9a080f506d6373b54df)
+
 #### [v0.10.0](https://github.com/opengovsg/formsg-javascript-sdk/compare/v0.9.0...v0.10.0)
 
 > 16 December 2022

package/README.md

@@ -103,6 +103,9 @@ The underlying cryptosystem is `x25519-xsalsa20-poly1305` which is implemented b
 | encryptedContent       | string                 | The encrypted submission in base64.                                                                      |
 | created                | string                 | Creation timestamp.                                                                                      |
 | attachmentDownloadUrls | Record<string, string> | (Optional) Records containing field IDs and URLs where encrypted uploaded attachments can be downloaded. |
+| paymentContent         | Record<string, string> | (Optional) Records containing payment details for forms with payments[1]                                 |
+
+[1] Forms with the deprecated Fixed Payment Type is not supported
 
 ### Format of Decrypted Submissions
 
@@ -130,7 +133,7 @@ decrypt and open the signed decrypted content with the package's own
 The resulting decrypted verifiedContent will be assigned to the `verified` key
 of the returned object.
 
-> **NOTE** <br>
+> **Note:** <br>
 > If any errors occur, either from the failure to decrypt either `encryptedContent` or `verifiedContent`, or the failure to authenticate the decrypted signed message in `verifiedContent`, `null` will be returned.
 
 Note that due to end-to-end encryption, FormSG servers are unable to verify the data format.
@@ -146,8 +149,8 @@ decrypted content does not contain all of the fields displayed in the schema bel
 | 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.
+> **Note:** <br>
+> 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).
@@ -178,6 +181,24 @@ Attachments are end-to-end encrypted in the same way as normal form submissions,
 
 _Warning:_ We do not have the ability to scan any attachments for malicious content (e.g. spyware or viruses), so careful handling is needed.
 
+### Format of Payment Content
+
+These fields will be available if the submission is a payment submission, otherwise, the value will be an empty `{}`.
+
+| Key            | Type             | Description                                      |
+| -------------- | ---------------- | ------------------------------------------------ |
+| type           | 'payment_charge' | Payment event associated with this webhook       |
+| status         | string           | Status of the payment intent                     |
+| payer          | string           | The email associated with this email             |
+| url            | string           | The url of the proof of payment for this payment |
+| paymentIntent  | string           | The payment intent associated with this payment  |
+| amount         | string           | The amount charged to the user                   |
+| productService | string           | The product or service name of the payment       |
+| dateTime       | string           | The time of which this payment was transacted    |
+| transactionFee | string           | The fees charged for this transaction            |
+
+
+
 ## Verifying Signatures Manually
 
 You can use the following information to create a custom solution, although we recommend using this SDK.

package/dist/types.d.ts

@@ -6,7 +6,7 @@ export type PackageInitParams = {
     /** Initializes public key used for verifying and decrypting in this package. If not given, will default to "production". */
     mode?: PackageMode;
 };
-export type FieldType = 'section' | 'radiobutton' | 'dropdown' | 'checkbox' | 'nric' | 'email' | 'table' | 'number' | 'rating' | 'yes_no' | 'decimal' | 'textfield' | 'textarea' | 'attachment' | 'date' | 'mobile' | 'homeno' | 'statement' | 'image' | 'country_region' | 'uen' | 'children';
+export type FieldType = 'section' | 'radiobutton' | 'dropdown' | 'checkbox' | 'nric' | 'email' | 'table' | 'number' | 'rating' | 'yes_no' | 'decimal' | 'textfield' | 'textarea' | 'attachment' | 'date' | 'mobile' | 'homeno' | 'statement' | 'image' | 'country_region' | 'uen' | 'children' | 'address';
 export type FormField = {
     _id: string;
     question: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opengovsg/formsg-sdk",
-  "version": "0.12.0-alpha.1",
+  "version": "0.13.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": "^1.6.2",
+    "axios": "^1.6.4",
     "tweetnacl": "^1.0.3",
     "tweetnacl-util": "^0.15.1"
   },