-
Notifications
You must be signed in to change notification settings - Fork 78
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(frontend): write FieldVerificationService in TypeScript (#1259)
* feat(FieldVfnSvc): rewrite frontend service in TypeScript * feat: replace usage of Verification module in verifiable-field with new FieldVerificationService * feat: replace usage of Verification module in submit-form directive * fix: make getErrorMessage backwards compatible axios returns errors as AxiosErrors, will need to extract out the error response text to make it behave the same way as the previous implementation * feat: remove verification.client.factory file * ref: convert ITransaction from interface to type and extend empty obj * feat(VfnCtl): return empty obj if no transaction needs to be created * fix: frontend to check if transaction data is an empty obj or not * test: add unit tests for FieldVerificationService * feat: correct JSDoc for FetchNewTransactionResponse type * test: fix vfn ctl tests for no transactions needed * ref(verifiableField): import entire service instead of destructuring * test: update test description for resetVerifiedField success case Co-authored-by: Antariksh Mahajan <antarikshmahajan@gmail.com> * feat: wrap promises with angularjs $q * ref(FieldVfnSvc): add spacing between jest tests Co-authored-by: Antariksh Mahajan <antarikshmahajan@gmail.com>
- Loading branch information
1 parent
9e026f8
commit 72ad2d2
Showing
11 changed files
with
287 additions
and
91 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,8 @@ | ||
| import { IVerificationSchema } from '../../../types' | ||
|
|
||
| export interface ITransaction { | ||
| transactionId: IVerificationSchema['_id'] | ||
| expireAt: IVerificationSchema['expireAt'] | ||
| } | ||
| export type Transaction = | ||
| | { | ||
| transactionId: IVerificationSchema['_id'] | ||
| expireAt: IVerificationSchema['expireAt'] | ||
| } | ||
| | Record<string, never> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
50 changes: 0 additions & 50 deletions
50
src/public/modules/forms/services/verification.client.factory.js
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| import axios from 'axios' | ||
| import { Opaque } from 'type-fest' | ||
|
|
||
| export type JsonDate = Opaque<string, 'JsonDate'> | ||
|
|
||
| /** | ||
| * Response when retrieving new transaction. Can be an empty object if the | ||
| * current form does not have any verifiable fields. | ||
| */ | ||
| export type FetchNewTransactionResponse = | ||
| | { expireAt: JsonDate; transactionId: string } | ||
| | Record<string, never> | ||
|
|
||
| type VerifiedFieldSignature = Opaque<string, 'VerifiedFieldSignature'> | ||
|
|
||
| /** Exported for testing */ | ||
| export const TRANSACTION_ENDPOINT = '/transaction' | ||
|
|
||
| /** | ||
| * Create a transaction for given form. | ||
| * @param formId The id of the form to create a transaction for | ||
| * @returns transaction metadata on success. Can be empty if no transactions are found in the form. | ||
| */ | ||
| export const createTransactionForForm = async ( | ||
| formId: string, | ||
| ): Promise<FetchNewTransactionResponse> => { | ||
| return axios | ||
| .post<FetchNewTransactionResponse>(TRANSACTION_ENDPOINT, { | ||
| formId, | ||
| }) | ||
| .then(({ data }) => data) | ||
| } | ||
|
|
||
| /** | ||
| * Sends an OTP to given answer. | ||
| * @param transactionId The generated transaction id for the form | ||
| * @param fieldId The id of the verification field | ||
| * @param answer The value of the verification field to verify. Usually an email or phone number | ||
| * @returns 201 Created status if successfully sent | ||
| */ | ||
| export const triggerSendOtp = async ({ | ||
| transactionId, | ||
| fieldId, | ||
| answer, | ||
| }: { | ||
| transactionId: string | ||
| fieldId: string | ||
| answer: string | ||
| }): Promise<void> => { | ||
| return axios.post(`${TRANSACTION_ENDPOINT}/${transactionId}/otp`, { | ||
| fieldId, | ||
| answer, | ||
| }) | ||
| } | ||
|
|
||
| /** | ||
| * Verifies given OTP for given fieldId | ||
| * @param transactionId The generated transaction id for the form | ||
| * @param fieldId The id of the verification field | ||
| * @param otp The user-entered OTP value to verify against | ||
| * @returns The verified signature on success | ||
| */ | ||
| export const verifyOtp = async ({ | ||
| transactionId, | ||
| fieldId, | ||
| otp, | ||
| }: { | ||
| transactionId: string | ||
| fieldId: string | ||
| otp: string | ||
| }): Promise<VerifiedFieldSignature> => { | ||
| return axios | ||
| .post<VerifiedFieldSignature>( | ||
| `${TRANSACTION_ENDPOINT}/${transactionId}/otp/verify`, | ||
| { | ||
| fieldId, | ||
| otp, | ||
| }, | ||
| ) | ||
| .then(({ data }) => data) | ||
| } | ||
|
|
||
| /** | ||
| * Reset the field in the transaction, removing the previously saved signature. | ||
| * | ||
| * @param transactionId The generated transaction id for the form | ||
| * @param fieldId The id of the verification field to reset | ||
| * @returns 200 OK status if successfully reset | ||
| */ | ||
| export const resetVerifiedField = async ({ | ||
| transactionId, | ||
| fieldId, | ||
| }: { | ||
| transactionId: string | ||
| fieldId: string | ||
| }): Promise<void> => { | ||
| return axios.post(`${TRANSACTION_ENDPOINT}/${transactionId}/reset`, { | ||
| fieldId, | ||
| }) | ||
| } |
Oops, something went wrong.