@pie-players/pie-assessment-player 0.3.17 → 0.3.20

package/README.md

@@ -8,7 +8,59 @@ Primary entrypoint:
 
 - `@pie-players/pie-assessment-player`
 
+## Debug logging
+
+Assessment-player now exposes a `debug` option on `pie-assessment-player-default`.
+
+- Enable verbose debug logs: `<pie-assessment-player-default debug="true">`
+- Disable verbose debug logs: `<pie-assessment-player-default debug="false">` (or `debug="0"`)
+
+The setting is forwarded to the rendered section-player instance and also applies
+the global flag (`window.PIE_DEBUG`) for shared runtime logging behavior.
+
 Component registration entrypoints:
 
 - `@pie-players/pie-assessment-player/components/assessment-player-default-element`
 - `@pie-players/pie-assessment-player/components/assessment-player-shell-element`
+
+## Instrumentation and observability
+
+Assessment-player instrumentation is provider-agnostic and built on the shared
+`InstrumentationProvider` contract used across players.
+
+Canonical provider injection paths:
+
+- `sectionPlayerRuntime.player.loaderConfig.instrumentationProvider`
+- `sectionPlayerPlayer.loaderConfig.instrumentationProvider` (fallback)
+
+Provider semantics:
+
+- With `trackPageActions: true`, missing/`undefined` provider values use the default New Relic provider path.
+- `instrumentationProvider: null` explicitly disables instrumentation.
+- Invalid provider objects are ignored (optional debug warning), also no-op.
+- Existing `item-player` behavior remains the compatibility anchor.
+- To keep production telemetry while debugging, use `CompositeInstrumentationProvider`
+  with `NewRelicInstrumentationProvider` and `DebugPanelInstrumentationProvider`.
+- Toolkit telemetry forwarding uses the same provider path, so tool/backend
+  operational events appear in production providers and debug overlays.
+
+Assessment-player owned canonical stream:
+
+- `pie-assessment-controller-ready`
+- `pie-assessment-navigation-requested`
+- `pie-assessment-route-changed`
+- `pie-assessment-session-applied`
+- `pie-assessment-session-changed`
+- `pie-assessment-progress-changed`
+- `pie-assessment-submission-state-changed`
+- `pie-assessment-error`
+
+Ownership boundary: assessment-player owns assessment semantics only. Section
+and toolkit semantics remain in their own streams to avoid overlap. Bridge
+dedupe is a safety net, not the primary correctness mechanism.
+
+Toolkit tool/backend operational stream (when toolkit is mounted):
+
+- `pie-tool-init-start|success|error`
+- `pie-tool-backend-call-start|success|error`
+- `pie-tool-library-load-start|success|error`

package/dist/components/AssessmentPlayerDefaultElement.d.ts

@@ -1,7 +1,7 @@
 import { Env } from '@pie-players/pie-players-shared/types';
 import { AssessmentControllerHandle } from '../controller/AssessmentController.js';
 import { AssessmentPlayerProgressSnapshot, AssessmentPlayerRuntimeHostContract, AssessmentPlayerSnapshot } from '../contracts/runtime-host-contract.js';
-import { AssessmentDefinition, AssessmentPlayerHooks } from '../types.js';
+import { AssessmentDefinition, AssessmentPlayerHooks, AssessmentPlayerRuntimeConfig } from '../types.js';
 export declare class AssessmentPlayerDefaultElement extends HTMLElement implements AssessmentPlayerRuntimeHostContract {
     static get observedAttributes(): string[];
     assessmentId: string;
@@ -13,24 +13,37 @@ export declare class AssessmentPlayerDefaultElement extends HTMLElement implemen
     showNavigation: boolean | string | null | undefined;
     sectionPlayerLayout: "splitpane" | "vertical";
     playerType: "iife" | "esm" | "preloaded";
+    private _debug;
     private controller;
     private controllerReadyPromise;
     private controllerReadyResolve;
     private sectionHost;
     private sectionControllerRef;
     private unsubscribeController?;
+    private detachInstrumentationBridge?;
+    private _sectionPlayerRuntime;
+    private _sectionPlayerPlayer;
     private readiness;
     constructor();
     attributeChangedCallback(name: string, _oldValue: string | null, value: string | null): void;
+    get debug(): boolean | string | null | undefined;
+    set debug(value: boolean | string | null | undefined);
+    get sectionPlayerRuntime(): AssessmentPlayerRuntimeConfig["sectionPlayerRuntime"];
+    set sectionPlayerRuntime(value: AssessmentPlayerRuntimeConfig["sectionPlayerRuntime"]);
+    get sectionPlayerPlayer(): AssessmentPlayerRuntimeConfig["sectionPlayerPlayer"];
+    set sectionPlayerPlayer(value: AssessmentPlayerRuntimeConfig["sectionPlayerPlayer"]);
     connectedCallback(): void;
     disconnectedCallback(): void;
     private dispatch;
     private bootstrapController;
+    private resolveInstrumentationProvider;
+    private attachInstrumentationBridge;
     private renderEmptyState;
     private buildSectionPlayerTag;
     private syncCurrentSectionSessionIntoAssessment;
     private attachSectionControllerReadyListener;
     private render;
+    private applyDebugFlag;
     getSnapshot(): AssessmentPlayerSnapshot;
     selectNavigation(): import('../contracts/runtime-host-contract.js').AssessmentPlayerNavigationSnapshot;
     selectReadiness(): {

package/dist/components/AssessmentPlayerDefaultElement.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AssessmentPlayerDefaultElement.d.ts","sourceRoot":"","sources":["../../src/components/AssessmentPlayerDefaultElement.ts"],"names":[],"mappings":"AAAA,OAAO,6EAA6E,CAAC;AACrF,OAAO,4EAA4E,CAAC;AACpF,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,uCAAuC,CAAC;AAEjE,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,uCAAuC,CAAC;AAQxF,OAAO,KAAK,EACX,gCAAgC,EAChC,mCAAmC,EACnC,wBAAwB,EACxB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,KAAK,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AAoB/E,qBAAa,8BACZ,SAAQ,WACR,YAAW,mCAAmC;IAE9C,MAAM,KAAK,kBAAkB,aAQ5B;IAED,YAAY,SAAM;IAClB,SAAS,SAAM;IACf,UAAU,EAAE,oBAAoB,GAAG,IAAI,CAAQ;IAC/C,GAAG,EAAE,GAAG,GAAG,IAAI,CAAQ;IACvB,WAAW,EAAE,OAAO,CAAQ;IAC5B,KAAK,EAAE,qBAAqB,GAAG,IAAI,CAAQ;IAC3C,cAAc,EAAE,OAAO,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,CAAQ;IAC3D,mBAAmB,EAAE,WAAW,GAAG,UAAU,CAAe;IAC5D,UAAU,EAAE,MAAM,GAAG,KAAK,GAAG,WAAW,CAAU;IAElD,OAAO,CAAC,UAAU,CAA2C;IAC7D,OAAO,CAAC,sBAAsB,CACxB;IACN,OAAO,CAAC,sBAAsB,CACxB;IACN,OAAO,CAAC,WAAW,CAA4B;IAC/C,OAAO,CAAC,oBAAoB,CAAwC;IACpE,OAAO,CAAC,qBAAqB,CAAC,CAAa;IAC3C,OAAO,CAAC,SAAS,CAEf;;IASF,wBAAwB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAerF,iBAAiB;IAiBjB,oBAAoB;IAKpB,OAAO,CAAC,QAAQ;YAWF,mBAAmB;IAwDjC,OAAO,CAAC,gBAAgB;IAQxB,OAAO,CAAC,qBAAqB;IAM7B,OAAO,CAAC,uCAAuC;IAe/C,OAAO,CAAC,oCAAoC;IAqB5C,OAAO,CAAC,MAAM;IAiHd,WAAW,IAAI,wBAAwB;IA6BvC,gBAAgB;IAIhB,eAAe;;;IAIf,cAAc,IAAI,gCAAgC;IAIlD,UAAU,CAAC,iBAAiB,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO;IAgCvD,YAAY,IAAI,OAAO;IAqBvB,gBAAgB,IAAI,OAAO;IAqB3B,uBAAuB,IAAI,0BAA0B,GAAG,IAAI;IAItD,2BAA2B,CAAC,SAAS,SAAO;CASlD"}
+{"version":3,"file":"AssessmentPlayerDefaultElement.d.ts","sourceRoot":"","sources":["../../src/components/AssessmentPlayerDefaultElement.ts"],"names":[],"mappings":"AAAA,OAAO,6EAA6E,CAAC;AACrF,OAAO,4EAA4E,CAAC;AAMpF,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,uCAAuC,CAAC;AAEjE,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,uCAAuC,CAAC;AAQxF,OAAO,KAAK,EACX,gCAAgC,EAChC,mCAAmC,EACnC,wBAAwB,EACxB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,KAAK,EACX,oBAAoB,EACpB,qBAAqB,EACrB,6BAA6B,EAC7B,MAAM,aAAa,CAAC;AAoBrB,qBAAa,8BACZ,SAAQ,WACR,YAAW,mCAAmC;IAE9C,MAAM,KAAK,kBAAkB,aAS5B;IAED,YAAY,SAAM;IAClB,SAAS,SAAM;IACf,UAAU,EAAE,oBAAoB,GAAG,IAAI,CAAQ;IAC/C,GAAG,EAAE,GAAG,GAAG,IAAI,CAAQ;IACvB,WAAW,EAAE,OAAO,CAAQ;IAC5B,KAAK,EAAE,qBAAqB,GAAG,IAAI,CAAQ;IAC3C,cAAc,EAAE,OAAO,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,CAAQ;IAC3D,mBAAmB,EAAE,WAAW,GAAG,UAAU,CAAe;IAC5D,UAAU,EAAE,MAAM,GAAG,KAAK,GAAG,WAAW,CAAU;IAClD,OAAO,CAAC,MAAM,CAAkD;IAEhE,OAAO,CAAC,UAAU,CAA2C;IAC7D,OAAO,CAAC,sBAAsB,CACxB;IACN,OAAO,CAAC,sBAAsB,CACxB;IACN,OAAO,CAAC,WAAW,CAA4B;IAC/C,OAAO,CAAC,oBAAoB,CAAwC;IACpE,OAAO,CAAC,qBAAqB,CAAC,CAAa;IAC3C,OAAO,CAAC,2BAA2B,CAAC,CAAa;IACjD,OAAO,CAAC,qBAAqB,CACvB;IACN,OAAO,CAAC,oBAAoB,CACtB;IACN,OAAO,CAAC,SAAS,CAEf;;IASF,wBAAwB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAkBrF,IAAI,KAAK,IAAI,OAAO,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,CAE/C;IAED,IAAI,KAAK,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,EAGnD;IAED,IAAI,oBAAoB,IAAI,6BAA6B,CAAC,sBAAsB,CAAC,CAEhF;IAED,IAAI,oBAAoB,CAAC,KAAK,EAAE,6BAA6B,CAAC,sBAAsB,CAAC,EAKpF;IAED,IAAI,mBAAmB,IAAI,6BAA6B,CAAC,qBAAqB,CAAC,CAE9E;IAED,IAAI,mBAAmB,CAAC,KAAK,EAAE,6BAA6B,CAAC,qBAAqB,CAAC,EAKlF;IAED,iBAAiB;IAmBjB,oBAAoB;IAOpB,OAAO,CAAC,QAAQ;YAWF,mBAAmB;IAgEjC,OAAO,CAAC,8BAA8B;IAQtC,OAAO,CAAC,2BAA2B;IAenC,OAAO,CAAC,gBAAgB;IAQxB,OAAO,CAAC,qBAAqB;IAM7B,OAAO,CAAC,uCAAuC;IAe/C,OAAO,CAAC,oCAAoC;IAqB5C,OAAO,CAAC,MAAM;IA6Hd,OAAO,CAAC,cAAc;IActB,WAAW,IAAI,wBAAwB;IA6BvC,gBAAgB;IAIhB,eAAe;;;IAIf,cAAc,IAAI,gCAAgC;IAIlD,UAAU,CAAC,iBAAiB,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO;IAgCvD,YAAY,IAAI,OAAO;IAqBvB,gBAAgB,IAAI,OAAO;IAqB3B,uBAAuB,IAAI,0BAA0B,GAAG,IAAI;IAItD,2BAA2B,CAAC,SAAS,SAAO;CASlD"}