Class BaseLMSActionAbstract

Protected AbstractintegrationName

Protected AbstractlmsProvider

ProtectedbuildErrorResult

• buildErrorResult(
      code: string,
      message: string,
      params?: ActionParam[],
  ): ActionResultSimple

  Build a standard error ActionResultSimple

  Parameters

  • code: string
  • message: string
  • Optionalparams: ActionParam[]

  Returns ActionResultSimple

ProtectedbuildLMSErrorMessage

• buildLMSErrorMessage(
      operation: string,
      details: string,
      systemError?: string | Error | { message?: string },
  ): string

  Helper to build consistent error messages for LMS operations

  Parameters

  • operation: string
  • details: string
  • OptionalsystemError: string | Error | { message?: string }

  Returns string

ProtectedbuildSuccessResult

• buildSuccessResult(message: string, params?: ActionParam[]): ActionResultSimple

  Build a standard success ActionResultSimple

  Parameters

  • message: string
  • Optionalparams: ActionParam[]

  Returns ActionResultSimple

ProtectedcalculateProgressPercentage

• calculateProgressPercentage(completed: number, total: number): number

  Calculate progress percentage

  Parameters

  • completed: number
  • total: number

  Returns number

ProtectedformatDuration

• formatDuration(seconds: number): string

  Format duration in seconds to human readable format

  Parameters

  • seconds: number

  Returns string

ProtectedformatLMSDate

• formatLMSDate(date: Date): string

  Standard date format for LMS systems (ISO 8601)

  Parameters

  • date: Date

  Returns string

ProtectedgetAPIBaseURL

• getAPIBaseURL(integration: MJCompanyIntegrationEntity): Promise<string>

  Gets the base URL for API calls

  Parameters

  • integration: MJCompanyIntegrationEntity

  Returns Promise<string>

ProtectedgetAPICredentials

• getAPICredentials(
      integration: MJCompanyIntegrationEntity,
  ): Promise<{ accessToken?: string; apiKey?: string; apiSecret?: string }>

  Gets API credentials - first tries environment variables, then falls back to database

  Parameters

  • integration: MJCompanyIntegrationEntity

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

ProtectedgetCommonLMSParams

• getCommonLMSParams(): ActionParam[]

  Common LMS parameters that many actions will need

  Returns ActionParam[]

ProtectedgetCompanyIntegration

• getCompanyIntegration(
      companyId: string,
      contextUser: UserInfo,
  ): Promise<MJCompanyIntegrationEntity>

  Gets the company integration record for the specified company and LMS

  Parameters

  • companyId: string
  • contextUser: UserInfo

  Returns Promise<MJCompanyIntegrationEntity>

ProtectedgetCredentialFromEnv

• getCredentialFromEnv(
      companyId: string,
      credentialType: string,
  ): string | undefined

  Gets credentials from environment variables Format: BIZAPPS_{PROVIDER}{COMPANY_ID}{CREDENTIAL_TYPE} Example: BIZAPPS_LEARNWORLDS_12345_API_KEY

  Parameters

  • companyId: string
  • credentialType: string

  Returns string | undefined

ProtectedgetParamValue

• getParamValue(params: ActionParam[], paramName: string): unknown

  Helper to get parameter value from an ActionParam array

  Parameters

  • params: ActionParam[]
  • paramName: string

  Returns unknown

ProtectedmapEnrollmentStatus

• mapEnrollmentStatus(
      status: string,
  ): "active" | "completed" | "expired" | "suspended" | "unknown"

  Common enrollment status mapping

  Parameters

  • status: string

  Returns "active" | "completed" | "expired" | "suspended" | "unknown"

ProtectedparseLMSDate

• parseLMSDate(dateString: string): Date

  Parse date from LMS format

  Parameters

  • dateString: string

  Returns Date

ProtectedsetOutputParam

• setOutputParam(params: ActionParam[], name: string, value: unknown): void

  Helper to set an output parameter, creating it if it doesn't exist

  Parameters

  • params: ActionParam[]
  • name: string
  • value: unknown

  Returns void

ProtectedvalidateUUID

• validateUUID(value: string, paramName: string): string

  Validates that a string is a valid UUID format to prevent SQL injection. Exposed as a reusable helper for subclasses to validate CompanyID, UserID, etc.

  Parameters

  • value: string
  • paramName: string

  Returns string