writetrack 0.10.2 → 0.11.0

package/dist/ckeditor/index.d.ts

@@ -18,6 +18,8 @@ export interface WriteTrackPluginOptions {
   persist?: boolean;
   /** Callback fired every second with active session time. */
   onTick?: (data: { activeTime: number; totalTime: number }) => void;
+  /** Callback invoked when the tracker is created and ready (persistence loaded if applicable). Avoids polling for tracker availability. */
+  onReady?: (tracker: WriteTrack) => void;
 }
 
 /**

package/dist/ckeditor/index.js

@@ -1 +1 @@
-import{Plugin as a}from"ckeditor5";import{WriteTrack as c}from"writetrack";var n=class extends a{constructor(){super(...arguments);this._tracker=null;this._isTracking=!1;this._destroyed=!1}static get pluginName(){return"WriteTrack"}get tracker(){return this._tracker}get isTracking(){return this._isTracking}init(){let e=this.editor,t=e.config.get("writetrack")||{},o=t.autoStart!==!1;e.ui.once("ready",()=>{if(this._destroyed)return;let s=e.ui.getEditableElement();s&&(e.model.document.on("change:data",(r,i)=>{i.isUndo?this._currentSource="undo":i.isTyping?this._currentSource="keyboard":this._currentSource!=="paste"&&this._currentSource!=="drop"&&(this._currentSource=void 0)}),e.editing.view.document.on("clipboardInput",(r,i)=>{this._currentSource=i.method==="drop"?"drop":"paste"}),this._tracker=new c({target:s,license:t.license,userId:t.userId,contentId:t.contentId,metadata:t.metadata,wasmUrl:t.wasmUrl,persist:t.persist,cursorPositionProvider:()=>{let r=e.model.document.selection.getFirstPosition();return r?r.offset:0},inputSourceProvider:()=>this._currentSource}),t.onTick&&this._tracker.on("tick",t.onTick),o&&(t.persist?this._tracker.ready.then(()=>{this._tracker&&(this._tracker.start(),this._isTracking=!0)}):(this._tracker.start(),this._isTracking=!0)))})}destroy(){this._destroyed=!0,this._tracker&&(this._tracker.stop(),this._tracker=null,this._isTracking=!1),super.destroy()}};export{n as WriteTrackPlugin};
+import{Plugin as a}from"ckeditor5";import{WriteTrack as c}from"writetrack";var n=class extends a{constructor(){super(...arguments);this._tracker=null;this._isTracking=!1;this._destroyed=!1}static get pluginName(){return"WriteTrack"}get tracker(){return this._tracker}get isTracking(){return this._isTracking}init(){let e=this.editor,t=e.config.get("writetrack")||{},o=t.autoStart!==!1;e.ui.once("ready",()=>{if(this._destroyed)return;let s=e.ui.getEditableElement();s&&(e.model.document.on("change:data",(r,i)=>{i.isUndo?this._currentSource="undo":i.isTyping?this._currentSource="keyboard":this._currentSource!=="paste"&&this._currentSource!=="drop"&&(this._currentSource=void 0)}),e.editing.view.document.on("clipboardInput",(r,i)=>{this._currentSource=i.method==="drop"?"drop":"paste"}),this._tracker=new c({target:s,license:t.license,userId:t.userId,contentId:t.contentId,metadata:t.metadata,wasmUrl:t.wasmUrl,persist:t.persist,cursorPositionProvider:()=>{let r=e.model.document.selection.getFirstPosition();return r?r.offset:0},inputSourceProvider:()=>this._currentSource}),t.onTick&&this._tracker.on("tick",t.onTick),o?t.persist?this._tracker.ready.then(()=>{this._tracker&&(this._tracker.start(),this._isTracking=!0,t.onReady?.(this._tracker))}):(this._tracker.start(),this._isTracking=!0,t.onReady?.(this._tracker)):t.persist?this._tracker.ready.then(()=>{this._tracker&&t.onReady?.(this._tracker)}):t.onReady?.(this._tracker))})}destroy(){this._destroyed=!0,this._tracker&&(this._tracker.stop(),this._tracker=null,this._isTracking=!1),super.destroy()}};export{n as WriteTrackPlugin};

package/dist/esm/index.d.ts

@@ -1,9 +1,9 @@
 import { K as KeystrokeEvent, C as ClipboardEvent, U as UndoRedoEvent, S as SelectionEvent, P as ProgrammaticInsertionEvent, a as CompositionEvent, I as InputSource, W as WriteTrackDataSchema } from './index-Cy91q_po.js';
 export { D as DataQualityMetrics, M as ModifierState, b as SessionMetadata } from './index-Cy91q_po.js';
-import { WriteTrackSink } from './pipes.js';
-export { DatadogClient, DatadogOptions, OTelSpan, OTelTracer, OpenTelemetryOptions, SegmentClient, SegmentOptions, WebhookOptions, datadog, opentelemetry, segment, webhook } from './pipes.js';
+import { W as WriteTrackSink } from './types-B8bNI9P5.js';
 import { S as SessionAnalysis, a as SessionReport, I as IndicatorOutput } from './analysis-types-Cg3hzXZX.js';
 export { C as ContentOriginAnalysis, e as PhaseTransition, P as PhysicalPlausibilityAnalysis, R as RevisionBehaviorAnalysis, b as SessionContinuityAnalysis, c as TemporalPatternsAnalysis, T as TimingAuthenticityAnalysis, f as WindowFeatures, W as WritingProcessAnalysis, d as WritingProcessSegment } from './analysis-types-Cg3hzXZX.js';
+export { DatadogClient, DatadogOptions, OTelSpan, OTelTracer, OpenTelemetryOptions, SegmentClient, SegmentOptions, WebhookOptions, datadog, opentelemetry, segment, webhook } from './pipes.js';
 
 interface PersistedSessionInfo {
     contentId: string;
@@ -35,6 +35,12 @@ interface WriteTrackOptions {
      *  beforeinput classification. Rich text editors (TipTap, Lexical, etc.) can use
      *  this to supply definitive input source from their own transaction metadata. */
     inputSourceProvider?: () => InputSource | undefined;
+    /** Override the document used for selection and visibility listeners.
+     *  Required for iframe-based editors (e.g., TinyMCE iframe mode). */
+    documentOverride?: Document;
+    /** Override the window used for focus/blur listeners.
+     *  Required for iframe-based editors (e.g., TinyMCE iframe mode). */
+    windowOverride?: Window;
 }
 declare class WriteTrack {
     /** @internal */ keystrokeEvents: KeystrokeEvent[];
@@ -72,9 +78,17 @@ declare class WriteTrack {
     private _persist;
     private readonly cursorPositionProvider?;
     private readonly inputSourceProvider?;
+    private readonly _document;
+    private readonly _window;
     private pendingInputSource;
     private _sinks;
     private _listeners;
+    private _readyFired;
+    private _keydownCount;
+    private _analysisThrottle;
+    private _analysisTimer;
+    private _analysisDirty;
+    private _analysisRunning;
     /**
      * Create a WriteTrack instance
      * @param optionsOrTarget - Either an HTMLElement (localhost evaluation) or WriteTrackOptions object
@@ -156,6 +170,12 @@ declare class WriteTrack {
     isTargetDetached(): boolean;
     start(): void;
     stop(): void;
+    /**
+     * Stop tracking and wait for any pending IndexedDB save to complete.
+     * Use this instead of `stop()` when you need to delete persisted data afterwards.
+     * When persist is not enabled, behaves identically to `stop()`.
+     */
+    stopAndWait(): Promise<void>;
     /**
      * Remove any persisted session data from IndexedDB for this field.
      * No-op when persist is not enabled.
@@ -168,14 +188,43 @@ declare class WriteTrack {
     pipe(sink: WriteTrackSink): this;
     /**
      * Register an event listener.
-     * Supported events: 'pipe:error', 'tick'
+     * Supported events: 'ready', 'change', 'analysis', 'tick', 'wasm:ready', 'wasm:error', 'stop', 'pipe:error'
      *
      * The `tick` event fires every ~1 second while the session is active and the
      * tab is visible. The handler receives `{ activeTime: number, totalTime: number }`
      * (both in milliseconds).
+     *
+     * @returns An unsubscribe function that removes the listener when called.
+     */
+    on(event: 'ready', handler: () => void): () => void;
+    on(event: 'change', handler: (payload: {
+        eventCount: number;
+        keystrokeCount: number;
+    }) => void): () => void;
+    on(event: 'analysis', handler: (analysis: SessionAnalysis) => void, opts?: {
+        throttle?: number;
+    }): () => void;
+    on(event: 'tick', handler: (payload: {
+        activeTime: number;
+        totalTime: number;
+    }) => void): () => void;
+    on(event: 'wasm:ready', handler: () => void): () => void;
+    on(event: 'wasm:error', handler: (error: Error) => void): () => void;
+    on(event: 'stop', handler: () => void): () => void;
+    on(event: 'pipe:error', handler: (error: Error, sink: WriteTrackSink) => void): () => void;
+    /**
+     * Remove a specific event listener.
      */
-    on(event: string, handler: (...args: unknown[]) => void): this;
+    off(event: string, handler: (...args: unknown[]) => void): void;
+    /**
+     * Remove all listeners for a given event, or all listeners if no event is specified.
+     */
+    removeAllListeners(event?: string): void;
+    private _emitChange;
     private _emit;
+    private _triggerWasmLoad;
+    private _scheduleAnalysis;
+    private _runAnalysis;
     private _dispatchToSinks;
     private startTickInterval;
     private stopTickInterval;
@@ -224,6 +273,27 @@ declare class WriteTrack {
     static deletePersistedSession(contentId: string, fieldId?: string): Promise<void>;
 }
 
+/**
+ * Convenience accessors for SessionAnalysis.
+ *
+ * These helpers extract commonly needed values so consumers don't have
+ * to navigate the nested analysis structure directly.
+ */
+
+/** Extract session duration in milliseconds. */
+declare function getSessionDurationMs(analysis: SessionAnalysis): number;
+/** Compute characters-per-minute and words-per-minute from keydown count and session duration. */
+declare function getTypingSpeed(analysis: SessionAnalysis): {
+    cpm: number;
+    wpm: number;
+};
+/** Extract the content origin breakdown (typed / pasted / autocompleted ratios, 0-1 each). */
+declare function getContentOriginBreakdown(analysis: SessionAnalysis): {
+    typed: number;
+    pasted: number;
+    autocompleted: number;
+};
+
 /**
  * Format WT-NNN indicator codes into human-readable strings.
  *
@@ -278,4 +348,4 @@ declare function createSessionReport(rawData: unknown, options?: AnalyzeEventsOp
  */
 declare function getHighResolutionTime(): number;
 
-export { type AnalyzeEventsOptions, ClipboardEvent, CompositionEvent, IndicatorOutput, InputSource, KeystrokeEvent, type PersistedSessionInfo, ProgrammaticInsertionEvent, SelectionEvent, SessionAnalysis, SessionReport, UndoRedoEvent, WriteTrack, WriteTrackDataSchema, type WriteTrackOptions, WriteTrackSink, analyzeEvents, createSessionReport, WriteTrack as default, formatIndicator, getHighResolutionTime };
+export { type AnalyzeEventsOptions, ClipboardEvent, CompositionEvent, IndicatorOutput, InputSource, KeystrokeEvent, type PersistedSessionInfo, ProgrammaticInsertionEvent, SelectionEvent, SessionAnalysis, SessionReport, UndoRedoEvent, WriteTrack, WriteTrackDataSchema, type WriteTrackOptions, WriteTrackSink, analyzeEvents, createSessionReport, WriteTrack as default, formatIndicator, getContentOriginBreakdown, getHighResolutionTime, getSessionDurationMs, getTypingSpeed };