Class BaseLMSAction`Abstract`

Base class for all LMS-related actions. Provides common functionality and patterns for interacting with Learning Management Systems.

Hierarchy (View Summary)

BaseAction
- BaseLMSAction
  - LearnWorldsBaseAction

Constructors

constructor

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

Properties

`Protected` `Abstract`integrationName

integrationName: string

The integration name to look up in the Integration entity

`Protected` `Abstract`lmsProvider

lmsProvider: string

The LMS provider this action is designed for (e.g., 'LearnWorlds', 'Moodle', etc.)

`Static` `Readonly`AuthorizesCaller

AuthorizesCaller: boolean

True when the action authorizes its caller itself, so a public entry point such as the RunAction mutation may run it for an authenticated user without an MJ: Action Authorizations link. Set it only on an action that either checks an authorization the caller must hold, or reads and writes only with the caller's own permissions. Leave it false for an action that acts with more authority than its caller, or that reaches data or sends messages the caller chooses but could not otherwise reach.

The engine reads the marker only from the class that runs, never from its parent classes. A subclass that overrides a marked action must declare the marker again.

Methods

`Protected`buildErrorResult

buildErrorResult(
    code: string,
    message: string,
    params?: ActionParam[],
): ActionResultSimple
Build a standard error ActionResultSimple
Parameters
- code: string
- message: string
- Optionalparams: ActionParam[]
Returns ActionResultSimple
- Defined in BizApps/LMS/src/base/base-lms.action.ts:266

`Protected`buildLMSErrorMessage

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
- Defined in BizApps/LMS/src/base/base-lms.action.ts:213

`Protected`buildSuccessResult

buildSuccessResult(message: string, params?: ActionParam[]): ActionResultSimple
Build a standard success ActionResultSimple
Parameters
- message: string
- Optionalparams: ActionParam[]
Returns ActionResultSimple
- Defined in BizApps/LMS/src/base/base-lms.action.ts:254

`Protected`calculateProgressPercentage

calculateProgressPercentage(completed: number, total: number): number
Calculate progress percentage
Parameters
- completed: number
- total: number
Returns number
- Defined in BizApps/LMS/src/base/base-lms.action.ts:188

`Protected`formatDuration

formatDuration(seconds: number): string
Format duration in seconds to human readable format
Parameters
- seconds: number
Returns string
- Defined in BizApps/LMS/src/base/base-lms.action.ts:196

`Protected`formatLMSDate

formatLMSDate(date: Date): string
Standard date format for LMS systems (ISO 8601)
Parameters
- date: Date
Returns string
- Defined in BizApps/LMS/src/base/base-lms.action.ts:174

`Protected`getAPIBaseURL

getAPIBaseURL(integration: MJCompanyIntegrationEntity): Promise<string>
Gets the base URL for API calls
Parameters
- integration: MJCompanyIntegrationEntity
Returns Promise<string>
- Defined in BizApps/LMS/src/base/base-lms.action.ts:153

`Protected`getAPICredentials

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 }>
- Defined in BizApps/LMS/src/base/base-lms.action.ts:123

`Protected`getCommonLMSParams

getCommonLMSParams(): ActionParam[]
Common LMS parameters that many actions will need

Returns ActionParam[]
- Defined in BizApps/LMS/src/base/base-lms.action.ts:32

`Protected`getCompanyIntegration

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>
- Defined in BizApps/LMS/src/base/base-lms.action.ts:71

`Protected`getCredentialFromEnv

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
- Defined in BizApps/LMS/src/base/base-lms.action.ts:109

`Protected`getParamValue

getParamValue(params: ActionParam[], paramName: string): unknown
Helper to get parameter value from an ActionParam array
Parameters
- params: ActionParam[]
- paramName: string
Returns unknown
- Defined in BizApps/LMS/src/base/base-lms.action.ts:166

`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:57

`Protected`mapEnrollmentStatus

mapEnrollmentStatus(
status: string,
): "active" | "completed" | "expired" | "suspended" | "unknown"
Common enrollment status mapping
Parameters
- status: string
Returns "active" | "completed" | "expired" | "suspended" | "unknown"
- Defined in BizApps/LMS/src/base/base-lms.action.ts:225

`Protected`parseLMSDate

parseLMSDate(dateString: string): Date
Parse date from LMS format
Parameters
- dateString: string
Returns Date
- Defined in BizApps/LMS/src/base/base-lms.action.ts:181

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:49

`Protected`setOutputParam

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
- Defined in BizApps/LMS/src/base/base-lms.action.ts:242

`Protected`validateUUID

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
- Defined in BizApps/LMS/src/base/base-lms.action.ts:51

Class BaseLMSActionAbstract

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns BaseLMSAction

Properties

Protected AbstractintegrationName

Protected AbstractlmsProvider

Static ReadonlyAuthorizesCaller

Methods

ProtectedbuildErrorResult

Parameters

Returns ActionResultSimple

ProtectedbuildLMSErrorMessage

Parameters

Returns string

ProtectedbuildSuccessResult

Parameters

Returns ActionResultSimple

ProtectedcalculateProgressPercentage

Parameters

Returns number

ProtectedformatDuration

Parameters

Returns string

ProtectedformatLMSDate

Parameters

Returns string

ProtectedgetAPIBaseURL

Parameters

Returns Promise<string>

ProtectedgetAPICredentials

Parameters

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

ProtectedgetCommonLMSParams

Returns ActionParam[]

ProtectedgetCompanyIntegration

Parameters

Returns Promise<MJCompanyIntegrationEntity>

ProtectedgetCredentialFromEnv

Parameters

Returns string | undefined

ProtectedgetParamValue

Parameters

Returns unknown

Protected AbstractInternalRunAction

Parameters

Returns Promise<ActionResultSimple>

ProtectedmapEnrollmentStatus

Parameters

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

ProtectedparseLMSDate

Parameters

Returns Date

Run

Parameters

Returns Promise<ActionResultSimple>

ProtectedsetOutputParam

Parameters

Returns void

ProtectedvalidateUUID

Parameters

Returns string

Settings

On This Page

Class BaseLMSAction`Abstract`

`Protected` `Abstract`integrationName

`Protected` `Abstract`lmsProvider

`Static` `Readonly`AuthorizesCaller

`Protected`buildErrorResult

`Protected`buildLMSErrorMessage

`Protected`buildSuccessResult

`Protected`calculateProgressPercentage

`Protected`formatDuration

`Protected`formatLMSDate

`Protected`getAPIBaseURL

`Protected`getAPICredentials

`Protected`getCommonLMSParams

`Protected`getCompanyIntegration

`Protected`getCredentialFromEnv

`Protected`getParamValue

`Protected` `Abstract`InternalRunAction

`Protected`mapEnrollmentStatus

`Protected`parseLMSDate

`Protected`setOutputParam

`Protected`validateUUID