@pie-players/pie-section-player 0.3.74 → 1.0.0-beta.0

package/dist/contracts/runtime-host-contract.d.ts

@@ -1,4 +1,3 @@
-import { SectionPlayerReadinessChangeDetail } from './public-events.js';
 import { SectionControllerHandle } from '@pie-players/pie-assessment-toolkit';
 export type SectionPlayerNavigationSnapshot = {
     currentIndex: number;
@@ -8,7 +7,6 @@ export type SectionPlayerNavigationSnapshot = {
     currentItemId?: string;
 };
 export type SectionPlayerSnapshot = {
-    readiness: SectionPlayerReadinessChangeDetail;
     composition: {
         itemsCount: number;
         passagesCount: number;
@@ -17,9 +15,6 @@ export type SectionPlayerSnapshot = {
 };
 export interface SectionPlayerRuntimeHostContract {
     getSnapshot(): SectionPlayerSnapshot;
-    selectComposition(): SectionPlayerSnapshot["composition"];
-    selectNavigation(): SectionPlayerNavigationSnapshot;
-    selectReadiness(): SectionPlayerReadinessChangeDetail;
     navigateTo(index: number): boolean;
     navigateNext(): boolean;
     navigatePrevious(): boolean;

package/dist/controllers/SectionController.d.ts

@@ -4,16 +4,24 @@ import { MediaTimeSource, TimedMediaSectionProjection } from '@pie-players/pie-p
 import { SectionControllerHandle, SectionSessionPersistenceConfig, SectionControllerRuntimeState, SectionControllerSessionState } from './toolkit-section-contracts.js';
 import { ItemEntity } from '@pie-players/pie-players-shared';
 import { NavigationResult, SectionControllerChangeListener, SectionCompositionModel, SectionNavigationState, SectionViewModel, SessionChangedResult } from './types.js';
+/**
+ * Owns aggregate section state: item sessions and navigation, the renderable
+ * lifecycle, completion, formative delivery, and timed-media cue state with its
+ * Media Time Source port. Item-level controllers share contracts with it but
+ * are not composed here.
+ */
 export declare class SectionController implements SectionControllerHandle {
     private readonly contentService;
     private readonly sessionService;
     private readonly itemNavigationService;
     private sessionPersistence;
     private pendingSessionCommit;
+    private saveQueue;
     private state;
     private readonly listeners;
     private readonly trackedRenderables;
     private readonly loadedRenderableKeys;
+    private readonly heldContentLoads;
     private readonly itemCompletionByCanonicalId;
     private readonly elementCompletionByCanonicalId;
     private readonly reportedCompletionIds;
@@ -52,6 +60,12 @@ export declare class SectionController implements SectionControllerHandle {
     updateInput(input?: unknown): Promise<void>;
     configureSessionPersistence(config: SectionSessionPersistenceConfig): void;
     hydrate(): Promise<void>;
+    /**
+     * Saves run one at a time, in call order, so a slow older write can never
+     * land after a newer one. The snapshot is copied at the call, since
+     * `getSession()` shares the live session objects, and a failed save
+     * rejects only its own caller.
+     */
     persist(): Promise<void>;
     dispose(): void;
     getViewModel(): SectionViewModel;
@@ -241,12 +255,9 @@ export declare class SectionController implements SectionControllerHandle {
      */
     getRuntimeState(): SectionControllerRuntimeState | null;
     /**
-     * Snapshot of currently-loaded renderables in registration order.
-     *
-     * Walks `trackedRenderables` (preserves insertion order) and emits an entry
-     * for each entry whose key is in `loadedRenderableKeys`. Used by the
-     * coordinator to replay `content-loaded` events to subscribers that
-     * attach after a renderable has finished loading.
+     * Loaded renderables in registration order, which `trackedRenderables`
+     * preserves. The coordinator replays `content-loaded` from this to
+     * subscribers that attach after a renderable has finished loading.
      */
     private collectLoadedRenderableSnapshot;
     getCurrentItem(): ItemEntity | null;
@@ -314,6 +325,10 @@ export declare class SectionController implements SectionControllerHandle {
     private evaluateSectionLoadingState;
     private replayPendingAppliedSession;
     private normalizeApplySession;
+    /**
+     * Accepts a canonical entry (an `itemIdentifier` plus a `session` object) or
+     * a bare one: `{ session, complete? }`, or the item session itself.
+     */
     private normalizeItemSessionEntry;
     private applyNormalizedSessionToState;
     private cloneForRead;

package/dist/controllers/types.d.ts

@@ -1,6 +1,6 @@
 import { TestAttemptSession } from '@pie-players/pie-assessment-toolkit';
 import { ItemSessionUpdateIntent, SessionCommitReason, AssessmentItemRef, AssessmentSection, ItemEntity, PassageEntity, RubricBlock } from '@pie-players/pie-players-shared';
-import { ConfigContainerEntity } from '@pie-players/pie-players-shared/types';
+import { ConfigContainerEntity, ItemSettings } from '@pie-players/pie-players-shared/types';
 import { FormativeFeedbackReveal, FormativeItemPolicy, FormativeMasteryRollup, FormativeSectionProjection, FormativeSectionSlice, FormativeTryOutcome } from '@pie-players/pie-players-shared/formative';
 import { TimedMediaDegradation, TimedMediaSectionProjection, TimedMediaSectionSessionSlice, TimedMediaValidationError } from '@pie-players/pie-players-shared/timed-media';
 export type SectionView = "candidate" | "scorer" | "author" | "proctor" | "testConstructor" | "tutor";
@@ -23,6 +23,8 @@ export interface SectionContentModel {
          * that identifier, and two implementations of one mapping.
          */
         formative?: FormativeItemPolicy;
+        /** The item ref's policy settings, carried for the same reason. */
+        settings?: ItemSettings;
     }>;
     /**
      * How an authored `timedMedia.stimulusRef` resolves to a renderable.
@@ -119,6 +121,11 @@ export interface SectionCanonicalItemViewModel {
     index: number;
     isCurrent: boolean;
     session: unknown;
+    /**
+     * The item ref's policy settings, which the item's scope registers; they
+     * govern the item's own toolbar.
+     */
+    settings?: ItemSettings;
 }
 export interface SectionAttemptSessionSliceLoadedRenderable {
     itemId: string;

package/dist/item-section/index.d.ts

@@ -0,0 +1,22 @@
+import { AssessmentSection, ItemConfig, SectionControllerSessionState } from '@pie-players/pie-players-shared/types';
+export interface ItemSectionOptions {
+    /** Defaults to the item config's id. */
+    sectionId?: string;
+    itemVId?: string;
+    /** The item's session, in the shape `<pie-item-player session>` takes. */
+    session?: unknown;
+}
+export interface ItemSection {
+    section: AssessmentSection;
+    session: SectionControllerSessionState | null;
+}
+/**
+ * Build the `section` and `session` a section player layout takes from one item
+ * config and, optionally, its session.
+ *
+ * The item ref's `identifier` and the item's `id` are the config's `id`, so
+ * every `itemId` the section reports is the id the host already holds. The item
+ * and its passage carry no `baseId` or `version`. The host sets `section-id` to
+ * `section.identifier`.
+ */
+export declare function sectionFromItem(config: ItemConfig, options?: ItemSectionOptions): ItemSection;

package/dist/item-section/index.js

@@ -0,0 +1,37 @@
+function d(e) {
+  return !!e.pie;
+}
+function r(e) {
+  const s = { ...e.pie };
+  e.instructorResources !== void 0 && s.instructorResources === void 0 && (s.instructorResources = e.instructorResources), e.defaultExtraModels !== void 0 && s.defaultExtraModels === void 0 && (s.defaultExtraModels = e.defaultExtraModels);
+  const t = {
+    id: e.id,
+    config: s
+  };
+  return e.passage && (t.passage = {
+    id: e.passage.id,
+    config: e.passage
+  }), t;
+}
+function n(e, s = {}) {
+  const t = d(e) ? r(e) : {
+    id: e.id,
+    config: e
+  }, i = {
+    identifier: e.id,
+    item: t
+  };
+  return s.itemVId !== void 0 && (i.itemVId = s.itemVId), {
+    section: {
+      identifier: s.sectionId ?? e.id,
+      assessmentItemRefs: [i]
+    },
+    session: s.session == null ? null : {
+      currentItemIndex: 0,
+      itemSessions: { [e.id]: s.session }
+    }
+  };
+}
+export {
+  n as sectionFromItem
+};

package/dist/pie-section-player.d.ts

@@ -1,10 +1,8 @@
-export type { SectionPlayerLayoutContract, SectionPlayerLayoutName, SectionPlayerLayoutCapability, SectionPlayerBasicPropName, SectionPlayerAdvancedPropName, SectionPlayerLayoutPropName, SectionPlayerLayoutCommandName, } from './contracts/layout-contract.js';
-export type { SectionPlayerPublicEventName, SectionPlayerReadinessPhase, SectionPlayerReadinessChangeDetail, } from './contracts/public-events.js';
-export { SECTION_PLAYER_PUBLIC_EVENTS } from './contracts/public-events.js';
 export type { SectionPlayerRuntimeHostContract, SectionPlayerNavigationSnapshot, SectionPlayerSnapshot, } from './contracts/runtime-host-contract.js';
-export { SPLITPANE_LAYOUT_CONTRACT, TABBED_LAYOUT_CONTRACT, VERTICAL_LAYOUT_CONTRACT, } from './contracts/layout-parity-metadata.js';
-export type { ReadinessPolicyAdapter, SectionPlayerPolicies, SectionPlayerReadinessPolicy, SectionPlayerPreloadPolicy, SectionPlayerTelemetryPolicy, } from './policies/types.js';
-export { DEFAULT_SECTION_PLAYER_POLICIES, isPreloadEnabled, isTelemetryEnabled, } from './policies/index.js';
+export type { SectionPlayerPolicies, SectionPlayerReadinessPolicy, SectionPlayerPreloadPolicy, SectionPlayerTelemetryPolicy, } from './policies/types.js';
+export { DEFAULT_SECTION_PLAYER_POLICIES } from './policies/index.js';
+export { sectionFromItem } from './item-section/index.js';
+export type { ItemSection, ItemSectionOptions } from './item-section/index.js';
 export type { SectionPlayerCardTitleContext, SectionPlayerCardTitleFormatter, SectionPlayerItemTitleContext, SectionPlayerPassageTitleContext, } from './contracts/card-title-formatters.js';
 export type { SectionPlayerHostHooks } from './contracts/host-hooks.js';
 export type { SectionPlayerBackendResolver, SectionPlayerBackendResolverContext, SectionPlayerRuntimeConfig, SectionPlayerRuntimePlayerConfig, } from './components/shared/section-player-backend-delivery.js';