@inditextech/weave-sdk 5.7.0 → 5.8.0-SNAPSHOT.613.1

package/dist/lab.d.ts

@@ -0,0 +1,289 @@
+import Konva from "konva";
+import { WeavePlugin } from "@inditextech/weave-sdk";
+//#region src/actions/brush-tool/constants.d.ts
+/** Name under which the lab plugin registers itself. */
+declare const BRUSH_LAB_PLUGIN_NAME = "brushLab";
+//#endregion
+//#region src/actions/brush-tool/types.d.ts
+/** Input profile keys resolved for every stroke. */
+type WeaveBrushInputProfileKey = 'mouse' | 'touch' | 'pen.applePencil' | 'pen.desktop';
+type WeaveBrushCaptureConfig = {
+  /** `legacy`: one position per event. `coalesced`: every batched sample. */
+  source: 'legacy' | 'coalesced';
+  /** Time base for time-dependent filters. */
+  clock: 'now' | 'event';
+  /** Samples closer than this (screen px) to the last one are skipped. */
+  minMovePx: number;
+  /** Whether the speculative predicted tail is drawn. */
+  predicted: 'off' | 'tail';
+  /** Event used to read samples. */
+  event: 'pointermove' | 'pointerrawupdate';
+};
+type WeaveBrushPressureConfig = {
+  /** How a reported pen pressure of 0 is treated. */
+  zero: 'legacy' | 'keep' | 'holdLast';
+  filter: 'legacy' | 'timeEma' | 'oneEuro' | 'none';
+  /** Time constant (ms) of the `timeEma` filter. */
+  timeConstantMs: number;
+  /** `oneEuro` filter parameters. */
+  oneEuro: {
+    minCutoff: number;
+    beta: number;
+  };
+  /** Lowest pressure that is recorded. */
+  floor: number;
+  /** How the first point's pressure is chosen. */
+  start: 'backfill' | 'average' | 'none';
+  /** Number of readings averaged by the `average` start policy. */
+  startSamples: number;
+  /** How the last point's pressure is chosen. */
+  end: 'backfill' | 'none';
+};
+type WeaveBrushStabilizerConfig = {
+  type: 'none' | 'oneEuro' | 'pulledString' | 'streamline';
+  /** `oneEuro` minimum cutoff (Hz) and speed coefficient. */
+  minCutoff: number;
+  beta: number;
+  /** `pulledString` leash radius, in screen px. */
+  radiusPx: number;
+  /** `streamline` amount, 0 (none) to 1 (strongest). */
+  amount: number;
+  /** Distances are screen pixels (same effect at any zoom); otherwise canvas units. */
+  zoomAware: boolean;
+  /** Complete the stroke at the release position. */
+  catchUpOnEnd: boolean;
+};
+type WeaveBrushFinalizeConfig = {
+  mode: 'dp' | 'dpPressure' | 'bezierFit' | 'none';
+  /** Tolerance; undefined uses the tool-level `simplifyTolerance`. */
+  tolerance?: number;
+  /** `canvas`: canvas units. `screen`: pixels, converted with the zoom. */
+  toleranceUnit: 'canvas' | 'screen';
+  /** Distance units per pressure unit for `dpPressure`. */
+  pressureWeight: number;
+  /** Spacing (screen px) used to resample a fitted curve to points. */
+  resampleSpacingPx: number;
+};
+type WeaveBrushTouchGuardConfig = {
+  /** Wait before a finger stroke is committed. */
+  waitMs: number;
+  /** Movement (screen px) that commits the stroke before the wait ends. */
+  movePx: number;
+  /** Cancel the stroke when a second touch lands during the wait. */
+  cancelOnSecondTouch: boolean;
+  /** Finger input does not draw once a pen has been used. */
+  ignoreAfterPen: boolean;
+};
+type WeaveBrushInputProfile = {
+  capture: WeaveBrushCaptureConfig;
+  pressure: WeaveBrushPressureConfig;
+  stabilizer: WeaveBrushStabilizerConfig;
+  finalize: WeaveBrushFinalizeConfig;
+  touchGuard: WeaveBrushTouchGuardConfig;
+};
+/**
+ * What the brush tool reports to the lab plugin while it is active. Nothing
+ * here is stored by the tool: the plugin keeps it in memory only.
+ */
+type WeaveBrushTraceSink = {
+  isEnabled?: () => boolean;
+  onStrokeStart(info: {
+    profile: WeaveBrushInputProfileKey;
+    preset: string;
+    scenario?: string;
+    profileConfig: WeaveBrushInputProfile;
+    strokeWidth: number;
+    zoom: number;
+  }): void;
+  onSample(sample: {
+    raw: {
+      x: number;
+      y: number;
+    };
+    stabilized: {
+      x: number;
+      y: number;
+    };
+    pressure: number;
+    time: number;
+    predicted: boolean;
+  }): void;
+  onBatch(info: {
+    ms: number;
+    samples: number;
+  }): void;
+  onStrokeEnd(info: {
+    beforeFinalize: {
+      x: number;
+      y: number;
+      pressure: number;
+    }[];
+    finalPoints: {
+      x: number;
+      y: number;
+      pressure: number;
+    }[];
+    strokeWidth: number;
+    finalizeMs: number;
+  }): void;
+};
+//#endregion
+//#region src/plugins/brush-lab/types.d.ts
+type LabPoint = {
+  x: number;
+  y: number;
+};
+type LabPressurePoint = LabPoint & {
+  pressure: number;
+  /** Time of this sample's own event, in ms, when it has one. */
+  time?: number;
+};
+/** One sample the brush tool reported, as it was recorded. */
+type LabRecordedSample = {
+  raw: LabPoint;
+  stabilized: LabPoint;
+  pressure: number;
+  /** Time reported for the sample, in ms. */
+  time: number;
+  predicted: boolean;
+};
+/** Measurements of one finished stroke. */
+type WeaveBrushLabMetrics = {
+  profile: WeaveBrushInputProfileKey;
+  preset: string;
+  scenario?: string;
+  /** Samples the device reported (predicted ones left out). */
+  samples: number;
+  /** Points kept after finishing. */
+  points: number;
+  /** Consecutive samples at the same position. */
+  droppedDuplicates: number;
+  /** Samples per second over the stroke. */
+  effectiveRateHz: number;
+  /** Mean distance of a raw sample from the line through its neighbours. */
+  jitter: number;
+  /** Mean distance between each raw sample and where it was recorded. */
+  lag: number;
+  /** Largest distance a point moved by finishing the stroke. */
+  movedOnFinish: number;
+  /** Mean change of width between neighbouring points, in canvas units. */
+  widthRoughness: number;
+  /** Time spent processing and finishing the stroke, in ms. */
+  drawMs: number;
+};
+/** What the lab knows about the pointer devices it has seen. */
+type WeaveBrushLabDeviceReport = {
+  pointerType: string | null;
+  resolvedProfile: WeaveBrushInputProfileKey | null;
+  /** Pointer events per second. */
+  sampleRateHz: number;
+  /** Mean samples per event, coalesced ones included. */
+  samplesPerEvent: number;
+  pressure: {
+    min: number;
+    max: number;
+  } | null;
+  tilt: boolean;
+  predictedAvailable: boolean;
+  zoom: number;
+  fps: number;
+  warnings: WeaveBrushLabWarning[];
+};
+type WeaveBrushLabWarning = 'penReportsAsMouse';
+type WeaveBrushLabOverlays = {
+  raw: boolean;
+  stabilized: boolean;
+  final: boolean;
+  pressure: boolean;
+};
+/** One pointer event with every sample it carried (coalesced ones included). */
+type LabGestureEvent = {
+  /** Event time, in ms. */
+  time: number;
+  samples: LabPressurePoint[];
+};
+/** What the pointer did during one gesture, in container coordinates. */
+type LabGesture = {
+  events: LabGestureEvent[];
+};
+/** A stroke kept in memory for comparison. Never stored or sent anywhere. */
+type LabRecording = {
+  profileKey: WeaveBrushInputProfileKey;
+  gesture: LabGesture;
+  strokeWidth: number;
+  zoom: number;
+};
+/** What `compareLast` drew, or why it drew nothing. */
+type WeaveBrushLabCompareResult = {
+  lines: number;
+  events?: number;
+  reason?: string;
+};
+//#endregion
+//#region src/plugins/brush-lab/brush-lab.d.ts
+/**
+ * Lab for tuning the brush on real devices. It listens to the brush tool and
+ * draws overlays on a layer of its own. It never changes the document, and it
+ * keeps everything it records in memory only: nothing is stored, sent or
+ * written anywhere.
+ */
+declare class WeaveBrushLabPlugin extends WeavePlugin implements WeaveBrushTraceSink {
+  private overlays;
+  private reporter;
+  private recordings;
+  private current;
+  private last;
+  private lastMetrics;
+  private compareScenario;
+  private recorder;
+  private listeners;
+  private frameHandle;
+  constructor(params?: {
+    maxGhosts?: number;
+  });
+  initialize(): void;
+  getName(): string;
+  getLayerName(): string;
+  getLayer(): Konva.Layer | undefined;
+  onInit(): void;
+  onRender(): void;
+  enable(): void;
+  disable(): void;
+  /** Pointer event position in the stage's drawing coordinates. */
+  private toStagePoint;
+  private recorderEvent;
+  private attach;
+  private detach;
+  private countFrames;
+  getDeviceReport(): WeaveBrushLabDeviceReport;
+  getLastMetrics(): WeaveBrushLabMetrics | null;
+  getOverlays(): WeaveBrushLabOverlays;
+  getRecordingCount(): number;
+  setOverlay(name: keyof WeaveBrushLabOverlays, on: boolean): void;
+  setMaxGhosts(max: number): void;
+  /**
+   * Draws the last stroke again through each named brush (every one when none
+   * are given), so the same handwriting can be compared across them.
+   */
+  compareLast(scenarioId: string): WeaveBrushLabCompareResult;
+  /** Forgets every kept stroke and removes the ghosts. */
+  clearGhosts(): void;
+  onStrokeStart(info: Parameters<WeaveBrushTraceSink['onStrokeStart']>[0]): void;
+  onSample(sample: LabRecordedSample): void;
+  onBatch(info: {
+    ms: number;
+    samples: number;
+  }): void;
+  onStrokeEnd(info: Parameters<WeaveBrushTraceSink['onStrokeEnd']>[0]): void;
+  private markerRadius;
+  private redraw;
+}
+//#endregion
+//#region src/plugins/brush-lab/constants.d.ts
+declare const BRUSH_LAB_LAYER_ID = "brushLabLayer";
+declare const BRUSH_LAB_METRICS_EVENT = "onBrushLabMetrics";
+/** Strokes kept in memory for ghost comparison. */
+declare const BRUSH_LAB_DEFAULT_MAX_GHOSTS = 5;
+//#endregion
+export { BRUSH_LAB_DEFAULT_MAX_GHOSTS, BRUSH_LAB_LAYER_ID, BRUSH_LAB_METRICS_EVENT, BRUSH_LAB_PLUGIN_NAME, type LabGesture, type LabGestureEvent, type LabPoint, type LabPressurePoint, type LabRecordedSample, type LabRecording, type WeaveBrushLabCompareResult, type WeaveBrushLabDeviceReport, type WeaveBrushLabMetrics, type WeaveBrushLabOverlays, WeaveBrushLabPlugin, type WeaveBrushLabWarning };
+//# sourceMappingURL=lab.d.ts.map

package/dist/lab.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lab.d.ts","names":[],"sources":["../src/actions/brush-tool/constants.ts","../src/actions/brush-tool/types.ts","../src/plugins/brush-lab/types.ts","../src/plugins/brush-lab/brush-lab.ts","../src/plugins/brush-lab/constants.ts"],"mappings":";;;;cASa;;;;KCKD;KAMA;;EAEV;;EAEA;;EAEA;;EAEA;;EAEA;;KAGU;;EAEV;EACA;;EAEA;;EAEA;IAAW;IAAmB;;;EAE9B;;EAEA;;EAEA;;EAEA;;KAGU;EACV;;EAEA;EACA;;EAEA;;EAEA;;EAEA;;EAEA;;KAGU;EACV;;EAEA;;EAEA;;EAEA;;EAEA;;KAGU;;EAEV;;EAEA;;EAEA;;EAEA;;KAGU;EACV,SAAS;EACT,UAAU;EACV,YAAY;EACZ,UAAU;EACV,YAAY;;;;;;KAkEF;EACV;EACA,cAAc;IACZ,SAAS;IACT;IACA;IACA,eAAe;IACf;IACA;;EAEF,SAAS;IACP;MAAO;MAAW;;IAClB;MAAc;MAAW;;IACzB;IACA;IACA;;EAEF,QAAQ;IAAQ;IAAY;;EAC5B,YAAY;IACV;MAAkB;MAAW;MAAW;;IACxC;MAAe;MAAW;MAAW;;IACrC;IACA;;;;;KChLQ;EAAa;EAAW;;KACxB,mBAAmB;EAC7B;;EAEA;;;KAIU;EACV,KAAK;EACL,YAAY;EACZ;;EAEA;EACA;;;KAIU;EACV,SAAS;EACT;EACA;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA;;;KAIU;EACV;EACA,iBAAiB;;EAEjB;;EAEA;EACA;IAAY;IAAa;;EACzB;EACA;EACA;EACA;EACA,UAAU;;KAGA;KAEA;EACV;EACA;EACA;EACA;;;KAIU;;EAEV;EACA,SAAS;;;KAIC;EAAe,QAAQ;;;KAGvB;EACV,YAAY;EACZ,SAAS;EACT;EACA;;;KAIU;EACV;EACA;EACA;;;;;;;;;;cCpCW,4BACH,uBACG;UAEH;UAMA;UACA;UACA;UACA;UACA;UACA;UACA;UACA;UACA;EAEI,YAAA;IAAW;;EAMvB;EAIA;EAIA;EAIA,YAAY,MAAM;EAMlB;EAYA;EAIA;EAMA;;UAOQ;UAUA;UAoBA;UAsCA;UAcA;EAiBR,mBAAmB;EAInB,kBAAkB;EAIlB,eAAe;EAIf;EAMA,WAAW,YAAY,uBAAuB;EAO9C,aAAa;;;;;EASb,YAAY,qBAAqB;;EAwBjC;EAQA,cACE,MAAM,WAAW;EAkBnB,SAAS,QAAQ;EAiCjB,QAAQ;IAAQ;IAAY;;EAI5B,YAAY,MAAM,WAAW;UAsCrB;UAKA;;;;cCrYG;cACA;;cAEA"}