scorm-again 3.1.3 → 3.1.5

package/dist/types/Scorm2004API.d.ts

@@ -32,6 +32,16 @@ declare class Scorm2004API extends BaseAPI {
     GetErrorString: (CMIErrorCode: string | number) => string;
     GetDiagnostic: (CMIErrorCode: string | number) => string;
     reset(settings?: Settings): void;
+    private applyCurrentActivityLaunchData;
+    private applyDeliveredActivityLaunchData;
+    private applyActivityLaunchData;
+    private applyCurrentActivityObjectiveData;
+    private seedCurrentActivityObjectives;
+    private seedObjectiveReadMapValues;
+    private applyObjectiveReadStateToCMI;
+    private getSeedableObjectiveId;
+    private findOrSeedCMIObjective;
+    private getActivityObjectiveSuccessStatus;
     get version(): string;
     get globalObjectives(): CMIObjectivesObject[];
     set _globalObjectives(objectives: CMIObjectivesObject[]);
@@ -47,6 +57,7 @@ declare class Scorm2004API extends BaseAPI {
     lmsGetErrorString(CMIErrorCode: string | number): string;
     lmsGetDiagnostic(CMIErrorCode: string | number): string;
     setCMIValue(CMIElement: string, value: any): string;
+    private currentActivityAllowsGlobalObjectiveWrites;
     getChildElement(CMIElement: string, value: any, foundFirstIndex: boolean): BaseCMI | null;
     validateCorrectResponse(CMIElement: string, value: any): void;
     private _peekCMIValue;
@@ -63,6 +74,7 @@ declare class Scorm2004API extends BaseAPI {
     private configureSequencingControls;
     private configureRollupRules;
     private initializeSequencingService;
+    private buildSequencingEventListeners;
     getSequencingService(): SequencingService | null;
     setSequencingEventListeners(listeners: SequencingEventListeners): void;
     updateSequencingConfiguration(config: SequencingConfiguration): void;

package/dist/types/cmi/scorm2004/completion_status_evaluation.d.ts

@@ -0,0 +1,7 @@
+export type CompletionStatusThresholdInput = {
+    completionThreshold?: number | string | null | undefined;
+    progressMeasure?: number | string | null | undefined;
+    storedCompletionStatus?: string | null | undefined;
+};
+export declare function evaluateCompletionStatusFromThreshold({ completionThreshold, progressMeasure, storedCompletionStatus, }: CompletionStatusThresholdInput): string;
+//# sourceMappingURL=completion_status_evaluation.d.ts.map

package/dist/types/cmi/scorm2004/sequencing/activity.d.ts

@@ -34,6 +34,12 @@ export interface ActivityObjectiveState {
     satisfiedStatus: boolean;
     measureStatus: boolean;
     normalizedMeasure: number;
+    rawScore: string;
+    rawScoreKnown: boolean;
+    minScore: string;
+    minScoreKnown: boolean;
+    maxScore: string;
+    maxScoreKnown: boolean;
     progressMeasure: number;
     progressMeasureStatus: boolean;
     completionStatus: CompletionStatus;
@@ -41,6 +47,18 @@ export interface ActivityObjectiveState {
     minNormalizedMeasure?: number | null;
     progressStatus: boolean;
 }
+export interface ActivityObjectiveScoreState {
+    rawScore?: string;
+    minScore?: string;
+    maxScore?: string;
+}
+export interface ActivityObjectiveReadState extends ActivityObjectiveScoreState {
+    satisfiedStatus?: boolean;
+    normalizedMeasure?: number;
+    progressMeasure?: number;
+    completionStatus?: CompletionStatus;
+}
+export type ActivityObjectiveDirtyProperty = "satisfiedStatus" | "normalizedMeasure" | "completionStatus" | "progressMeasure" | "rawScore" | "minScore" | "maxScore";
 export type RollupConsiderationRequirement = "always" | "ifAttempted" | "ifNotSkipped" | "ifNotSuspended";
 export interface RollupConsiderationsConfig {
     requiredForSatisfied: RollupConsiderationRequirement;
@@ -68,6 +86,12 @@ export declare class ActivityObjective {
     private _satisfiedStatusKnown;
     private _measureStatus;
     private _normalizedMeasure;
+    private _rawScore;
+    private _rawScoreKnown;
+    private _minScore;
+    private _minScoreKnown;
+    private _maxScore;
+    private _maxScoreKnown;
     private _progressMeasure;
     private _progressMeasureStatus;
     private _completionStatus;
@@ -76,6 +100,9 @@ export declare class ActivityObjective {
     private _normalizedMeasureDirty;
     private _completionStatusDirty;
     private _progressMeasureDirty;
+    private _rawScoreDirty;
+    private _minScoreDirty;
+    private _maxScoreDirty;
     constructor(id: string, options?: ActivityObjectiveOptions);
     get id(): string;
     get description(): string | null;
@@ -95,6 +122,18 @@ export declare class ActivityObjective {
     set measureStatus(value: boolean);
     get normalizedMeasure(): number;
     set normalizedMeasure(value: number);
+    get rawScore(): string;
+    set rawScore(value: string);
+    get rawScoreKnown(): boolean;
+    set rawScoreKnown(value: boolean);
+    get minScore(): string;
+    set minScore(value: string);
+    get minScoreKnown(): boolean;
+    set minScoreKnown(value: boolean);
+    get maxScore(): string;
+    set maxScore(value: string);
+    get maxScoreKnown(): boolean;
+    set maxScoreKnown(value: boolean);
     get progressMeasure(): number;
     set progressMeasure(value: number);
     get progressMeasureStatus(): boolean;
@@ -103,10 +142,12 @@ export declare class ActivityObjective {
     set completionStatus(value: CompletionStatus);
     get progressStatus(): boolean;
     set progressStatus(value: boolean);
-    isDirty(property: 'satisfiedStatus' | 'normalizedMeasure' | 'completionStatus' | 'progressMeasure'): boolean;
-    clearDirty(property: 'satisfiedStatus' | 'normalizedMeasure' | 'completionStatus' | 'progressMeasure'): void;
+    isDirty(property: ActivityObjectiveDirtyProperty): boolean;
+    clearDirty(property: ActivityObjectiveDirtyProperty): void;
     clearAllDirty(): void;
     initializeFromCMI(satisfiedStatus: boolean, normalizedMeasure: number, measureStatus: boolean): void;
+    initializeScoreFromCMI(score: ActivityObjectiveScoreState): void;
+    applyReadMappedState(state: ActivityObjectiveReadState): void;
     resetState(): void;
     updateFromActivity(activity: Activity): void;
     applyToActivity(activity: Activity): void;
@@ -321,10 +362,10 @@ export declare class Activity extends BaseCMI {
     } | null;
     getAllObjectives(): ActivityObjective[];
     private updatePrimaryObjectiveFromActivity;
-    isObjectiveDirty(property: 'satisfiedStatus' | 'normalizedMeasure' | 'measureStatus'): boolean;
-    clearObjectiveDirty(property: 'satisfiedStatus' | 'normalizedMeasure' | 'measureStatus'): void;
+    isObjectiveDirty(property: "satisfiedStatus" | "normalizedMeasure" | "measureStatus"): boolean;
+    clearObjectiveDirty(property: "satisfiedStatus" | "normalizedMeasure" | "measureStatus"): void;
     clearAllObjectiveDirty(): void;
-    setPrimaryObjectiveState(satisfiedStatus: boolean, measureStatus: boolean, normalizedMeasure: number, progressMeasure: number, progressMeasureStatus: boolean, completionStatus: CompletionStatus): void;
+    setPrimaryObjectiveState(satisfiedStatus: boolean, measureStatus: boolean, normalizedMeasure: number, progressMeasure: number, progressMeasureStatus: boolean, completionStatus: CompletionStatus, objectiveProgressStatus?: boolean): void;
     getObjectiveStateSnapshot(): {
         primary: ActivityObjectiveState | null;
         objectives: ActivityObjectiveState[];
@@ -333,6 +374,7 @@ export declare class Activity extends BaseCMI {
         primary: ActivityObjectiveState | null;
         objectives: ActivityObjectiveState[];
     }): void;
+    private applyObjectiveScoreSnapshot;
     getAvailableChildren(): Activity[];
     setProcessedChildren(processedChildren: Activity[]): void;
     resetProcessedChildren(): void;

package/dist/types/cmi/scorm2004/sequencing/handlers/rte_data_transfer.d.ts

@@ -43,5 +43,6 @@ export declare class RteDataTransferService {
     transferPrimaryObjective(activity: Activity, cmiData: CMIDataForTransfer): void;
     transferNonPrimaryObjectives(activity: Activity, cmiData: CMIDataForTransfer): void;
     normalizeScore(score: ScoreData): number | null;
+    private getObjectiveScoreState;
 }
 //# sourceMappingURL=rte_data_transfer.d.ts.map

package/dist/types/cmi/scorm2004/sequencing/handlers/termination_handler.d.ts

@@ -40,6 +40,7 @@ export declare class TerminationHandler {
     };
     evaluatePostConditions(activity: Activity): PostConditionResult;
     private handleMultiLevelExit;
+    private applyAncestorExitActionRules;
     private processExitAtLevel;
     cleanupSuspendedActivity(): void;
     private terminateAll;

package/dist/types/cmi/scorm2004/sequencing/objectives/global_objective_synchronizer.d.ts

@@ -1,4 +1,4 @@
-import { Activity, ActivityObjective, ObjectiveMapInfo } from "../activity";
+import { Activity, ActivityObjective, ActivityObjectiveReadState, ObjectiveMapInfo } from "../activity";
 import { CompletionStatus } from "../../../../constants/enums";
 export type EventCallback = (eventType: string, data?: unknown) => void;
 export interface GlobalObjective {
@@ -7,6 +7,12 @@ export interface GlobalObjective {
     satisfiedStatusKnown: boolean;
     normalizedMeasure: number;
     normalizedMeasureKnown: boolean;
+    rawScore: string;
+    rawScoreKnown: boolean;
+    minScore: string;
+    minScoreKnown: boolean;
+    maxScore: string;
+    maxScoreKnown: boolean;
     progressMeasure: number;
     progressMeasureKnown: boolean;
     completionStatus: CompletionStatus;
@@ -27,6 +33,12 @@ export interface LocalObjectiveState {
     satisfiedStatus: boolean;
     measureStatus: boolean;
     normalizedMeasure: number;
+    rawScore: string;
+    rawScoreKnown: boolean;
+    minScore: string;
+    minScoreKnown: boolean;
+    maxScore: string;
+    maxScoreKnown: boolean;
     progressMeasure: number;
     progressMeasureStatus: boolean;
     completionStatus: CompletionStatus;
@@ -41,8 +53,12 @@ export declare class GlobalObjectiveSynchronizer {
     syncGlobalObjectivesReadPhase(activity: Activity, globalObjectives: Map<string, GlobalObjective>): void;
     synchronizeGlobalObjectives(activity: Activity, globalObjectives: Map<string, GlobalObjective>): void;
     syncObjectiveState(activity: Activity, objective: ActivityObjective, mapInfo: ObjectiveMapInfo, globalObjective: GlobalObjective): void;
+    static getGlobalObjectiveReadState(activity: Activity, objective: ActivityObjective, mapInfo: ObjectiveMapInfo, globalObjective: GlobalObjective): ActivityObjectiveReadState;
+    private applyGlobalObjectiveReadState;
     ensureGlobalObjectiveEntry(globalObjectives: Map<string, GlobalObjective>, targetId: string, objective: ActivityObjective): GlobalObjective;
     createDefaultMapInfo(objective: ActivityObjective): ObjectiveMapInfo;
+    private hasKnownSatisfiedStatus;
+    private canWriteGlobalObjectives;
     getLocalObjectiveState(activity: Activity, objective: ActivityObjective, isPrimary: boolean): LocalObjectiveState;
     updateActivityAttemptData(activity: Activity, globalObjective: GlobalObjective, objective: ActivityObjective): void;
 }

package/dist/types/cmi/scorm2004/sequencing/sequencing_rules.d.ts

@@ -36,6 +36,11 @@ export declare enum RuleActionType {
     PREVIOUS = "previous",
     EXIT = "exit"
 }
+export type RuleConditionEvaluation = boolean | "unknown";
+export declare function kleeneNot(value: RuleConditionEvaluation): RuleConditionEvaluation;
+export declare function kleeneAnd(values: RuleConditionEvaluation[]): RuleConditionEvaluation;
+export declare function kleeneOr(values: RuleConditionEvaluation[]): RuleConditionEvaluation;
+export declare function combineRuleConditionResults(values: RuleConditionEvaluation[], conditionCombination: string | RuleConditionOperator): RuleConditionEvaluation;
 export declare class RuleCondition extends BaseCMI {
     private _condition;
     private _operator;
@@ -56,7 +61,7 @@ export declare class RuleCondition extends BaseCMI {
     get referencedObjective(): string | null;
     set referencedObjective(objectiveId: string | null);
     private resolveReferencedObjective;
-    evaluate(activity: Activity): boolean;
+    evaluate(activity: Activity): RuleConditionEvaluation;
     private evaluateTimeLimitExceeded;
     private evaluateOutsideAvailableTimeRange;
     private parseISO8601Duration;

package/dist/types/cmi/scorm2004/sequencing/traversal/flow_traversal_service.d.ts

@@ -6,16 +6,19 @@ export interface FlowTreeTraversalResult {
     activity: Activity | null;
     endSequencingSession: boolean;
     exception?: string;
+    direction?: FlowSubprocessMode;
+    forwardOnlyCluster?: Activity;
 }
 export declare class FlowTraversalService {
     private activityTree;
     private ruleEngine;
     constructor(activityTree: ActivityTree, ruleEngine: RuleEvaluationEngine);
     flowSubprocess(fromActivity: Activity, direction: FlowSubprocessMode): FlowSubprocessResult;
-    flowTreeTraversalSubprocess(fromActivity: Activity, direction: FlowSubprocessMode, skipChildren?: boolean): FlowTreeTraversalResult;
+    flowTreeTraversalSubprocess(fromActivity: Activity, direction: FlowSubprocessMode, skipChildren?: boolean, forwardTraversalBoundary?: Activity | null): FlowTreeTraversalResult;
     private traverseForward;
     private traverseBackward;
-    private getLastDescendant;
+    private getBackwardTraversalEntry;
+    private isDescendantOfOrSelf;
     flowActivityTraversalSubprocess(activity: Activity, _direction: boolean, considerChildren: boolean, mode: FlowSubprocessMode): Activity | null;
     checkActivityProcess(activity: Activity): boolean;
     ensureSelectionAndRandomization(activity: Activity): void;

package/dist/types/constants/regex.d.ts

@@ -34,6 +34,7 @@ export declare const scorm2004_regex: {
     CMIString64000: string;
     CMILang: string;
     CMILangString250: string;
+    CMILangString: string;
     CMILangcr: string;
     CMILangString250cr: string;
     CMILangString4000: string;

package/dist/types/types/api_types.d.ts

@@ -175,6 +175,12 @@ export type GlobalObjectiveMapEntry = {
     satisfiedStatusKnown?: boolean;
     normalizedMeasure?: number;
     normalizedMeasureKnown?: boolean;
+    rawScore?: string;
+    rawScoreKnown?: boolean;
+    minScore?: string;
+    minScoreKnown?: boolean;
+    maxScore?: string;
+    maxScoreKnown?: boolean;
     progressMeasure?: number;
     progressMeasureKnown?: boolean;
     completionStatus?: string;
@@ -187,6 +193,12 @@ export type GlobalObjectiveMapEntry = {
     writeProgressMeasure?: boolean;
     readCompletionStatus?: boolean;
     writeCompletionStatus?: boolean;
+    readRawScore?: boolean;
+    writeRawScore?: boolean;
+    readMinScore?: boolean;
+    writeMinScore?: boolean;
+    readMaxScore?: boolean;
+    writeMaxScore?: boolean;
     lastUpdated?: string;
 };
 //# sourceMappingURL=api_types.d.ts.map

package/dist/types/types/sequencing_types.d.ts

@@ -17,6 +17,16 @@ export type AdlRollupConsiderationsSettings = {
     requiredForIncomplete?: AdlRollupConsiderationRequirement;
     measureSatisfactionIfActive?: boolean;
 };
+export type CompletionThresholdSettings = {
+    completedByMeasure?: boolean;
+    minProgressMeasure?: number;
+    progressWeight?: number;
+};
+export type DeliveryControlsSettings = {
+    tracked?: boolean;
+    completionSetByContent?: boolean;
+    objectiveSetByContent?: boolean;
+};
 export type ActivitySettings = {
     id: string;
     title: string;
@@ -38,8 +48,10 @@ export type ActivitySettings = {
     objectives?: ObjectiveSettings[];
     sequencingRules?: SequencingRulesSettings;
     sequencingControls?: SequencingControlsSettings;
+    deliveryControls?: DeliveryControlsSettings;
     rollupRules?: RollupRulesSettings;
     rollupConsiderations?: AdlRollupConsiderationsSettings;
+    completionThreshold?: CompletionThresholdSettings;
     selectionRandomizationState?: SelectionRandomizationStateSettings;
     hideLmsUi?: HideLmsUiItem[];
     sequencingCollectionRefs?: string | string[];
@@ -109,6 +121,7 @@ export type SequencingControlsSettings = {
     reorderChildren?: boolean;
     completionSetByContent?: boolean;
     objectiveSetByContent?: boolean;
+    tracked?: boolean;
 };
 export type SelectionRandomizationStateSettings = {
     childOrder?: string[];

package/dist/types/utilities/core.d.ts

@@ -15,7 +15,10 @@ export declare function unflatten(data: StringKeyMap): object;
 export declare function countDecimals(num: number): number;
 export declare function formatMessage(functionName: string, message: string, CMIElement?: string): string;
 export declare function stringMatches(str: string | null | undefined, tester: string): boolean;
-export declare function memoize<T extends (...args: any[]) => any>(fn: T, keyFn?: (...args: Parameters<T>) => string): T;
+export declare function memoize<T extends (...args: any[]) => any>(fn: T, keyFn?: (...args: Parameters<T>) => string, options?: {
+    maxEntries?: number;
+    maxKeyLength?: number;
+}): T;
 export type ParsedNavigationRequest = {
     command: string;
     targetActivityId: string | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "scorm-again",
-  "version": "3.1.3",
+  "version": "3.1.5",
   "description": "A modern SCORM JavaScript run-time library for SCORM 1.2 and SCORM 2004",
   "main": "dist/scorm-again.js",
   "types": "index.d.ts",