Class BaseFormBuilderAction`Abstract`

Base class for all form builder-related actions. Provides common functionality and patterns for interacting with form/survey platforms.

Hierarchy (View Summary)

BaseAction
- BaseFormBuilderAction

Constructors

constructor

new BaseFormBuilderAction(): BaseFormBuilderAction
Returns BaseFormBuilderAction
Inherited from BaseAction.constructor

Properties

`Protected` `Abstract`formPlatform

formPlatform: string

The form platform this action is designed for (e.g., 'Typeform', 'Google Forms', etc.)

`Protected` `Abstract`integrationName

integrationName: string

The integration name to look up in the Integration entity

Methods

`Protected`buildFormErrorMessage

buildFormErrorMessage(
    operation: string,
    details: string,
    systemError?: any,
): string
Helper to build consistent error messages for form operations
Parameters
- operation: string
- details: string
- OptionalsystemError: any
Returns string
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:289

`Protected`calculateAverageCompletionTime

calculateAverageCompletionTime(responses: FormResponse[]): number
Calculate average completion time from responses
Parameters
- responses: FormResponse[]
Returns number
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:333

`Protected`calculateCompletionRate

calculateCompletionRate(completed: number, total: number): number
Calculate completion rate percentage
Parameters
- completed: number
- total: number
Returns number
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:263

`Protected`convertToCSV

convertToCSV(
    responses: FormResponse[],
    includeMetadata?: boolean,
    delimiter?: string,
): { csv: string; headers: string[] }
Convert responses to CSV format
Parameters
- responses: FormResponse[]
- includeMetadata: boolean = false
- delimiter: string = ','
Returns { csv: string; headers: string[] }
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:382

`Protected`createOAuth2Manager

createOAuth2Manager(
companyId: string,
contextUser: UserInfo,
): Promise<OAuth2Manager>
Creates an OAuth2Manager instance for the specified company. Override this method in provider-specific base classes to configure OAuth2 endpoints.
Parameters
- companyId: string
  The MemberJunction company ID
- contextUser: UserInfo
  The user context
Returns Promise<OAuth2Manager>
OAuth2Manager instance or null if OAuth2 is not configured
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:221

`Protected`extractEmailFromResponses

extractEmailFromResponses(responses: FormResponse[]): string[]
Extract email addresses from response answers
Parameters
- responses: FormResponse[]
Returns string[]
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:300

`Protected`findTopAnswers

findTopAnswers(
    responses: FormResponse[],
    fieldId: string,
    limit?: number,
): { answer: string; count: number }[]
Find most common answers for choice fields
Parameters
- responses: FormResponse[]
- fieldId: string
- limit: number = 10
Returns { answer: string; count: number }[]
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:356

`Protected`formatDuration

formatDuration(seconds: number): string
Format duration in seconds to human readable format
Parameters
- seconds: number
Returns string
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:271

`Protected`formatFormDate

formatFormDate(date: Date): string
Standard date format for form platforms (ISO 8601)
Parameters
- date: Date
Returns string
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:246

`Protected`getAPICredentials

getAPICredentials(
integration: MJCompanyIntegrationEntity,
): Promise<{ accessToken?: string; apiKey?: string; apiToken?: string }>
Gets API credentials - first tries environment variables, then falls back to database
Parameters
- integration: MJCompanyIntegrationEntity
Returns Promise<{ accessToken?: string; apiKey?: string; apiToken?: string }>
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:148

`Protected`getCommonFormParams

getCommonFormParams(): ActionParam[]
Common form builder parameters that many actions will need. CompanyID is required for secure credential lookup. FormID is the platform-specific form identifier.

Returns ActionParam[]
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:78

`Protected`getCompanyIntegration

getCompanyIntegration(
companyId: string,
contextUser: UserInfo,
): Promise<MJCompanyIntegrationEntity>
Gets the company integration record for the specified company and form platform
Parameters
- companyId: string
- contextUser: UserInfo
Returns Promise<MJCompanyIntegrationEntity>
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:96

`Protected`getCredentialFromEnv

getCredentialFromEnv(companyId: string, credentialType: string): string
Gets credentials from environment variables Format: BIZAPPS_{PROVIDER}{COMPANY_ID}{CREDENTIAL_TYPE} Example: BIZAPPS_TYPEFORM_12345_API_TOKEN

Falls back to: BIZAPPS_{PROVIDER}_{CREDENTIAL_TYPE} if no company-specific credential found Example fallback: BIZAPPS_TYPEFORM_API_TOKEN
Parameters
- companyId: string
- credentialType: string
Returns string
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:128

`Protected`getParamValue

getParamValue(params: ActionParam[], paramName: string): any
Helper to get parameter value with type safety
Parameters
- params: ActionParam[]
- paramName: string
Returns any
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:238

`Protected`getSecureAPIToken

getSecureAPIToken(companyId: string, contextUser: UserInfo): Promise<string>
Helper to securely retrieve API token for a company. This method should be used by all form builder actions instead of accepting tokens as parameters.
Parameters
- companyId: string
  The MemberJunction company ID (required)
- contextUser: UserInfo
  The user context for database queries
Returns Promise<string>
The API token for the specified company

Throws
Error if no credentials are found or company integration is not configured
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:183

`Protected`groupResponsesByDate

groupResponsesByDate(responses: FormResponse[]): Record<string, number>
Group responses by date
Parameters
- responses: FormResponse[]
Returns Record<string, number>
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:319

`Protected` `Abstract`InternalRunAction

InternalRunAction(params: RunActionParams): Promise<ActionResultSimple>
Internal method that must be implemented by derived action classes. This is where the actual action logic should be implemented.
Parameters
- params: RunActionParams
  The action execution parameters including typed context
Returns Promise<ActionResultSimple>
Promise resolving to the action result
Inherited from BaseAction.InternalRunAction
- Defined in Engine/dist/generic/BaseAction.d.ts:45

`Protected`parseFormDate

parseFormDate(dateString: string | number): Date
Parse date from form platform format
Parameters
- dateString: string | number
Returns Date
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:253

Run

Run(params: RunActionParams): Promise<ActionResultSimple>
Executes the action with the provided parameters.
Parameters
- params: RunActionParams
  The action execution parameters including context
Returns Promise<ActionResultSimple>
Promise resolving to the action result
Inherited from BaseAction.Run
- Defined in Engine/dist/generic/BaseAction.d.ts:37

Class BaseFormBuilderActionAbstract

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns BaseFormBuilderAction

Properties

Protected AbstractformPlatform

Protected AbstractintegrationName

Methods

ProtectedbuildFormErrorMessage

Parameters

Returns string

ProtectedcalculateAverageCompletionTime

Parameters

Returns number

ProtectedcalculateCompletionRate

Parameters

Returns number

ProtectedconvertToCSV

Parameters

Returns { csv: string; headers: string[] }

ProtectedcreateOAuth2Manager

Parameters

Returns Promise<OAuth2Manager>

ProtectedextractEmailFromResponses

Parameters

Returns string[]

ProtectedfindTopAnswers

Parameters

Returns { answer: string; count: number }[]

ProtectedformatDuration

Parameters

Returns string

ProtectedformatFormDate

Parameters

Returns string

ProtectedgetAPICredentials

Parameters

Returns Promise<{ accessToken?: string; apiKey?: string; apiToken?: string }>

ProtectedgetCommonFormParams

Returns ActionParam[]

ProtectedgetCompanyIntegration

Parameters

Returns Promise<MJCompanyIntegrationEntity>

ProtectedgetCredentialFromEnv

Parameters

Returns string

ProtectedgetParamValue

Parameters

Returns any

ProtectedgetSecureAPIToken

Parameters

Returns Promise<string>

Throws

ProtectedgroupResponsesByDate

Parameters

Returns Record<string, number>

Protected AbstractInternalRunAction

Parameters

Returns Promise<ActionResultSimple>

ProtectedparseFormDate

Parameters

Returns Date

Run

Parameters

Returns Promise<ActionResultSimple>

Settings

On This Page

Class BaseFormBuilderAction`Abstract`

`Protected` `Abstract`formPlatform

`Protected` `Abstract`integrationName

`Protected`buildFormErrorMessage

`Protected`calculateAverageCompletionTime

`Protected`calculateCompletionRate

`Protected`convertToCSV

`Protected`createOAuth2Manager

`Protected`extractEmailFromResponses

`Protected`findTopAnswers

`Protected`formatDuration

`Protected`formatFormDate

`Protected`getAPICredentials

`Protected`getCommonFormParams

`Protected`getCompanyIntegration

`Protected`getCredentialFromEnv

`Protected`getParamValue

`Protected`getSecureAPIToken

`Protected`groupResponsesByDate

`Protected` `Abstract`InternalRunAction

`Protected`parseFormDate