feat: add getQuestion instance method to form field schema

package.json

@@ -172,6 +172,7 @@
     "@types/node": "^14.0.13",
     "@types/nodemailer": "^6.4.0",
     "@types/nodemailer-direct-transport": "^1.0.31",
+    "@types/uid-generator": "^2.0.2",
     "@types/uuid": "^8.0.0",
     "@types/validator": "^13.0.0",
     "@typescript-eslint/eslint-plugin": "^3.3.0",

src/app/models/field/baseField.ts

@@ -10,6 +10,7 @@ import {
   BasicFieldType,
   IFieldSchema,
   IMyInfoSchema,
+  ITableFieldSchema,
   MyInfoAttribute,
   ResponseMode,
 } from '../../../types'
@@ -125,7 +126,24 @@ const createBaseFieldSchema = (db: Mongoose) => {
     return next()
   })
 
+  // Instance methods
+  FieldSchema.methods.getQuestion = function (this: IFieldSchema) {
+    // Return concatenation of all column titles as question string.
+    if (isTableField(this)) {
+      const columnTitles = this.columns.map((col) => col.title)
+      return `${this.title} (${columnTitles.join(', ')})`
+    }
+
+    // Default question is the field title.
+    return this.title
+  }
+
   return FieldSchema
 }
 
+// Typeguards
+const isTableField = (field: IFieldSchema): field is ITableFieldSchema => {
+  return field.fieldType === BasicFieldType.Table
+}
+
 export default createBaseFieldSchema

src/app/models/field/tableField.ts

@@ -1,3 +1,4 @@
+import { isEmpty } from 'lodash'
 import { Schema } from 'mongoose'
 
 import {
@@ -64,6 +65,9 @@ const createTableFieldSchema = () => {
   })
 
   TableFieldSchema.pre<ITableFieldSchema>('validate', function (next) {
+    if (isEmpty(this.columns)) {
+      return next(Error('There must be at least 1 column in a Table field.'))
+    }
     if (!this.addMoreRows && !!this.maximumRows) {
       this.maximumRows = undefined
     }

src/app/utils/response.js

@@ -1,5 +1,4 @@
 const validateField = require('./field-validation')
-const getQuestionFromField = require('./question')
 const logicUtil = require('../../shared/util/logic')
 const _ = require('lodash')
 const { ConflictError } = require('./custom-errors.js')
@@ -71,12 +70,16 @@ const getParsedResponses = function (form, bodyResponses, modeFilter) {
   // Validate each field in the form and construct parsed responses for downstream processing
   const parsedResponses = responses.map((response) => {
     const { _id } = response
-    const formField = fieldMap[_id] // In FormValidator, we have checked that all the form field ids exist, so this wont be null
+    // In FormValidator, we have checked that all the form field ids exist, so
+    // this wont be null.
+    const formField = fieldMap[_id]
     response.isVisible = visibleFieldIds.has(_id)
     validateField(form._id, formField, response)
-    response.question = getQuestionFromField(formField)
+    // Instance method of base field schema.
+    response.question = formField.getQuestion()
     if (formField.isVerifiable) {
-      // This is only correct because validateField should have thrown an error if the signature was wrong.
+      // This is only correct because validateField should have thrown an error
+      // if the signature was wrong.
       response.isUserVerified = true
     }
 

src/types/field/attachmentField.ts

@@ -1,4 +1,4 @@
-import { IField } from './baseField'
+import { IField, IFieldSchema } from './baseField'
 
 export enum AttachmentSize {
   OneMb = '1',
@@ -9,3 +9,7 @@ export enum AttachmentSize {
 export interface IAttachmentField extends IField {
   attachmentSize: AttachmentSize
 }
+
+export interface IAttachmentFieldSchema
+  extends IAttachmentField,
+    IFieldSchema {}

src/types/field/baseField.ts

@@ -31,6 +31,13 @@ export interface IFieldSchema extends IField, Document {
   ownerDocument(): IFormSchema
   /** Returns this sub-documents parent document. */
   parent(): IFormSchema
+
+  // Instance methods
+  /**
+   * Returns the string to be displayed as the asked question in form
+   * responses.
+   */
+  getQuestion(): string
 }
 
 // We don't store a fieldValue in the database, but the client

src/types/field/checkboxField.ts

@@ -1,7 +1,4 @@
-import { Document } from 'mongoose'
-
-import { IFormSchema } from '../form'
-import { IField } from './baseField'
+import { IField, IFieldSchema } from './baseField'
 
 export type CheckboxValidationOptions = {
   customMax: number
@@ -15,10 +12,4 @@ export interface ICheckboxField extends IField {
   validateByValue: boolean
 }
 
-// Manual override since mongoose types don't have generics yet.
-export interface ICheckboxFieldSchema extends ICheckboxField, Document {
-  /** Returns the top level document of this sub-document. */
-  ownerDocument(): IFormSchema
-  /** Returns this sub-documents parent document. */
-  parent(): IFormSchema
-}
+export interface ICheckboxFieldSchema extends ICheckboxField, IFieldSchema {}

src/types/field/dateField.ts

@@ -1,7 +1,4 @@
-import { Document } from 'mongoose'
-
-import { IFormSchema } from '../form'
-import { IField } from './baseField'
+import { IField, IFieldSchema } from './baseField'
 
 export enum DateSelectedValidation {
   NoPast = 'Disallow past dates',
@@ -20,10 +17,4 @@ export interface IDateField extends IField {
   dateValidation: DateValidationOptions
 }
 
-// Manual override since mongoose types don't have generics yet.
-export interface IDateFieldSchema extends IDateField, Document {
-  /** Returns the top level document of this sub-document. */
-  ownerDocument(): IFormSchema
-  /** Returns this sub-documents parent document. */
-  parent(): IFormSchema
-}
+export interface IDateFieldSchema extends IDateField, IFieldSchema {}

src/types/field/decimalField.ts

@@ -1,7 +1,4 @@
-import { Document } from 'mongoose'
-
-import { IFormSchema } from '../form'
-import { IField } from './baseField'
+import { IField, IFieldSchema } from './baseField'
 
 export type DecimalValidationOptions = {
   customMax: number
@@ -13,10 +10,4 @@ export interface IDecimalField extends IField {
   validateByValue: boolean
 }
 
-// Manual override since mongoose types don't have generics yet.
-export interface IDecimalFieldSchema extends IDecimalField, Document {
-  /** Returns the top level document of this sub-document. */
-  ownerDocument(): IFormSchema
-  /** Returns this sub-documents parent document. */
-  parent(): IFormSchema
-}
+export interface IDecimalFieldSchema extends IDecimalField, IFieldSchema {}

src/types/field/dropdownField.ts

@@ -1,16 +1,7 @@
-import { Document } from 'mongoose'
-
-import { IFormSchema } from '../form'
-import { IField } from './baseField'
+import { IField, IFieldSchema } from './baseField'
 
 export interface IDropdownField extends IField {
   fieldOptions: string[]
 }
 
-// Manual override since mongoose types don't have generics yet.
-export interface IDropdownFieldSchema extends IDropdownField, Document {
-  /** Returns the top level document of this sub-document. */
-  ownerDocument(): IFormSchema
-  /** Returns this sub-documents parent document. */
-  parent(): IFormSchema
-}
+export interface IDropdownFieldSchema extends IDropdownField, IFieldSchema {}

src/types/field/emailField.ts

@@ -1,7 +1,4 @@
-import { Document } from 'mongoose'
-
-import { IFormSchema } from '../form'
-import { IField } from './baseField'
+import { IField, IFieldSchema } from './baseField'
 
 export type AutoReplyOptions = {
   hasAutoReply: boolean
@@ -16,10 +13,4 @@ export interface IEmailField extends IField {
   isVerifiable: boolean
 }
 
-// Manual override since mongoose types don't have generics yet.
-export interface IEmailFieldSchema extends IEmailField, Document {
-  /** Returns the top level document of this sub-document. */
-  ownerDocument(): IFormSchema
-  /** Returns this sub-documents parent document. */
-  parent(): IFormSchema
-}
+export interface IEmailFieldSchema extends IEmailField, IFieldSchema {}

src/types/field/homeNoField.ts

@@ -1,16 +1,7 @@
-import { Document } from 'mongoose'
-
-import { IFormSchema } from '../form'
-import { IField } from './baseField'
+import { IField, IFieldSchema } from './baseField'
 
 export interface IHomenoField extends IField {
   allowIntlNumbers: boolean
 }
 
-// Manual override since mongoose types don't have generics yet.
-export interface IHomenoFieldSchema extends IHomenoField, Document {
-  /** Returns the top level document of this sub-document. */
-  ownerDocument(): IFormSchema
-  /** Returns this sub-documents parent document. */
-  parent(): IFormSchema
-}
+export interface IHomenoFieldSchema extends IHomenoField, IFieldSchema {}

src/types/field/imageField.ts

@@ -1,7 +1,4 @@
-import { Document } from 'mongoose'
-
-import { IFormSchema } from '../form'
-import { IField } from './baseField'
+import { IField, IFieldSchema } from './baseField'
 
 export interface IImageField extends IField {
   url: string
@@ -10,10 +7,4 @@ export interface IImageField extends IField {
   size: string
 }
 
-// Manual override since mongoose types don't have generics yet.
-export interface IImageFieldSchema extends IImageField, Document {
-  /** Returns the top level document of this sub-document. */
-  ownerDocument(): IFormSchema
-  /** Returns this sub-documents parent document. */
-  parent(): IFormSchema
-}
+export interface IImageFieldSchema extends IImageField, IFieldSchema {}

src/types/field/longTextField.ts

@@ -1,7 +1,4 @@
-import { Document } from 'mongoose'
-
-import { IFormSchema } from '../form'
-import { IField } from './baseField'
+import { IField, IFieldSchema } from './baseField'
 
 export enum LongTextSelectedValidation {
   Max = 'Maximum',
@@ -21,10 +18,4 @@ export interface ILongTextField extends IField {
   ValidationOptions: LongTextValidationOptions
 }
 
-// Manual override since mongoose types don't have generics yet.
-export interface ILongTextFieldSchema extends ILongTextField, Document {
-  /** Returns the top level document of this sub-document. */
-  ownerDocument(): IFormSchema
-  /** Returns this sub-documents parent document. */
-  parent(): IFormSchema
-}
+export interface ILongTextFieldSchema extends ILongTextField, IFieldSchema {}

src/types/field/mobileField.ts

@@ -1,17 +1,8 @@
-import { Document } from 'mongoose'
-
-import { IFormSchema } from '../form'
-import { IField } from './baseField'
+import { IField, IFieldSchema } from './baseField'
 
 export interface IMobileField extends IField {
   allowIntlNumbers: boolean
   isVerifiable: boolean
 }
 
-// Manual override since mongoose types don't have generics yet.
-export interface IMobileFieldSchema extends IMobileField, Document {
-  /** Returns the top level document of this sub-document. */
-  ownerDocument(): IFormSchema
-  /** Returns this sub-documents parent document. */
-  parent(): IFormSchema
-}
+export interface IMobileFieldSchema extends IMobileField, IFieldSchema {}

src/types/field/nricField.ts

@@ -1,14 +1,5 @@
-import { Document } from 'mongoose'
-
-import { IFormSchema } from '../form'
-import { IField } from './baseField'
+import { IField, IFieldSchema } from './baseField'
 
 export interface INricField extends IField {}
 
-// Manual override since mongoose types don't have generics yet.
-export interface INricFieldSchema extends INricField, Document {
-  /** Returns the top level document of this sub-document. */
-  ownerDocument(): IFormSchema
-  /** Returns this sub-documents parent document. */
-  parent(): IFormSchema
-}
+export interface INricFieldSchema extends INricField, IFieldSchema {}

src/types/field/numberField.ts

@@ -1,7 +1,4 @@
-import { Document } from 'mongoose'
-
-import { IFormSchema } from '../form'
-import { IField } from './baseField'
+import { IField, IFieldSchema } from './baseField'
 
 export enum NumberSelectedValidation {
   Max = 'Maximum',
@@ -21,10 +18,4 @@ export interface INumberField extends IField {
   ValidationOptions: NumberValidationOptions
 }
 
-// Manual override since mongoose types don't have generics yet.
-export interface INumberFieldSchema extends INumberField, Document {
-  /** Returns the top level document of this sub-document. */
-  ownerDocument(): IFormSchema
-  /** Returns this sub-documents parent document. */
-  parent(): IFormSchema
-}
+export interface INumberFieldSchema extends INumberField, IFieldSchema {}

src/types/field/radioField.ts

@@ -1,17 +1,8 @@
-import { Document } from 'mongoose'
-
-import { IFormSchema } from '../form'
-import { IField } from './baseField'
+import { IField, IFieldSchema } from './baseField'
 
 export interface IRadioField extends IField {
   fieldOptions: string[]
   othersRadioButton: boolean
 }
 
-// Manual override since mongoose types don't have generics yet.
-export interface IRadioFieldSchema extends IRadioField, Document {
-  /** Returns the top level document of this sub-document. */
-  ownerDocument(): IFormSchema
-  /** Returns this sub-documents parent document. */
-  parent(): IFormSchema
-}
+export interface IRadioFieldSchema extends IRadioField, IFieldSchema {}