@simtest-js/funnel 1.0.0-beta.3 → 1.0.0-beta.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +2 -2
  2. package/src/index.ts +180 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@simtest-js/funnel",
3
- "version": "1.0.0-beta.3",
3
+ "version": "1.0.0-beta.5",
4
4
  "description": "Trajectory comparison library (WASM + TypeScript)",
5
5
  "type": "module",
6
6
  "license": "MIT",
@@ -15,7 +15,7 @@
15
15
  "src"
16
16
  ],
17
17
  "scripts": {
18
- "build:wasm": "wasm-pack build ../../crates/simtest-funnel-wasm --target bundler --out-dir ./src/wasm",
18
+ "build:wasm": "wasm-pack build ../../crates/simtest-funnel-wasm --target bundler --out-dir ../../packages/sdk/src/wasm",
19
19
  "build": "pnpm build:wasm && tsc",
20
20
  "test": "vitest run",
21
21
  "lint": "biome check .",
package/src/index.ts CHANGED
@@ -1 +1,180 @@
1
- export { compare, version } from './wasm/simtest_funnel_wasm.js';
1
+ import * as wasm from './wasm/simtest_funnel_wasm.js';
2
+
3
+ /** Tolerances passed to {@link compare}. */
4
+ export interface Tolerances {
5
+ atolx?: number;
6
+ atoly?: number;
7
+ ltolx?: number;
8
+ ltoly?: number;
9
+ rtolx?: number;
10
+ rtoly?: number;
11
+ }
12
+
13
+ /** X-range filter. */
14
+ export interface XRange {
15
+ lo: number;
16
+ hi: number;
17
+ }
18
+
19
+ /** Options for {@link compare}. */
20
+ export interface Options {
21
+ tolerances?: Tolerances;
22
+ xRange?: XRange;
23
+ }
24
+
25
+ /** Status codes (mirror `simtest_funnel_core::Status`). */
26
+ export const Status = {
27
+ Pass: 0,
28
+ Fail: -1,
29
+ MissingReference: 1,
30
+ MissingTest: 2,
31
+ NonMonotonic: 10,
32
+ LengthMismatch: 11,
33
+ EmptyRange: 12,
34
+ BufferTooSmall: 13,
35
+ InsufficientData: 14,
36
+ } as const;
37
+ export type StatusCode = (typeof Status)[keyof typeof Status];
38
+
39
+ /** Result of {@link compare}. Errors are signed. */
40
+ export interface CompareResult {
41
+ status: StatusCode;
42
+ lowerX: Float64Array;
43
+ lowerY: Float64Array;
44
+ upperX: Float64Array;
45
+ upperY: Float64Array;
46
+ errorsX: Float64Array;
47
+ errorsY: Float64Array;
48
+ }
49
+
50
+ function toF64(v: ArrayLike<number> | Float64Array): Float64Array {
51
+ return v instanceof Float64Array
52
+ ? v
53
+ : Float64Array.from(v as ArrayLike<number>);
54
+ }
55
+
56
+ /**
57
+ * Compare a test trajectory against a reference. Errors are signed
58
+ * (positive above upper, negative below lower).
59
+ */
60
+ export function compare(
61
+ referenceX: ArrayLike<number> | Float64Array,
62
+ referenceY: ArrayLike<number> | Float64Array,
63
+ testX: ArrayLike<number> | Float64Array,
64
+ testY: ArrayLike<number> | Float64Array,
65
+ options?: Options,
66
+ ): CompareResult {
67
+ const raw = wasm.compare(
68
+ toF64(referenceX),
69
+ toF64(referenceY),
70
+ toF64(testX),
71
+ toF64(testY),
72
+ // biome-ignore lint/suspicious/noExplicitAny: WASM glue returns `any`
73
+ (options ?? null) as any,
74
+ );
75
+ const r = raw as {
76
+ status: number;
77
+ lowerX: number[];
78
+ lowerY: number[];
79
+ upperX: number[];
80
+ upperY: number[];
81
+ errorsX: number[];
82
+ errorsY: number[];
83
+ };
84
+ return {
85
+ status: r.status as StatusCode,
86
+ lowerX: Float64Array.from(r.lowerX),
87
+ lowerY: Float64Array.from(r.lowerY),
88
+ upperX: Float64Array.from(r.upperX),
89
+ upperY: Float64Array.from(r.upperY),
90
+ errorsX: Float64Array.from(r.errorsX),
91
+ errorsY: Float64Array.from(r.errorsY),
92
+ };
93
+ }
94
+
95
+ /** Returns the default options. */
96
+ export function defaultOptions(): Options {
97
+ return wasm.defaultOptions() as Options;
98
+ }
99
+
100
+ /** Returns the core crate version. */
101
+ export function version(): string {
102
+ return wasm.version();
103
+ }
104
+
105
+ /**
106
+ * Plot interface shared with Plotly.js. We declare only the minimal
107
+ * surface we need so that users can bring their own Plotly build
108
+ * (peer dependency).
109
+ */
110
+ export interface PlotlyLike {
111
+ newPlot(
112
+ el: HTMLElement,
113
+ data: unknown[],
114
+ layout?: unknown,
115
+ config?: unknown,
116
+ ): Promise<unknown>;
117
+ }
118
+
119
+ /** Trace inputs to {@link createFunnelPlot}. */
120
+ export interface CreateFunnelPlotInputs {
121
+ reference: { x: ArrayLike<number>; y: ArrayLike<number>; name?: string };
122
+ test: { x: ArrayLike<number>; y: ArrayLike<number>; name?: string };
123
+ result: CompareResult;
124
+ }
125
+
126
+ /** Render a funnel plot into `el`. */
127
+ export async function createFunnelPlot(
128
+ plotly: PlotlyLike,
129
+ el: HTMLElement,
130
+ inputs: CreateFunnelPlotInputs,
131
+ layout?: Record<string, unknown>,
132
+ ): Promise<unknown> {
133
+ const traces = [
134
+ {
135
+ x: Array.from(inputs.reference.x),
136
+ y: Array.from(inputs.reference.y),
137
+ name: inputs.reference.name ?? 'reference',
138
+ mode: 'lines',
139
+ type: 'scatter',
140
+ },
141
+ {
142
+ x: Array.from(inputs.test.x),
143
+ y: Array.from(inputs.test.y),
144
+ name: inputs.test.name ?? 'test',
145
+ mode: 'lines',
146
+ type: 'scatter',
147
+ },
148
+ {
149
+ x: Array.from(inputs.result.lowerX),
150
+ y: Array.from(inputs.result.lowerY),
151
+ name: 'lower bound',
152
+ mode: 'lines',
153
+ line: { dash: 'dot' },
154
+ type: 'scatter',
155
+ },
156
+ {
157
+ x: Array.from(inputs.result.upperX),
158
+ y: Array.from(inputs.result.upperY),
159
+ name: 'upper bound',
160
+ mode: 'lines',
161
+ line: { dash: 'dot' },
162
+ type: 'scatter',
163
+ },
164
+ {
165
+ x: Array.from(inputs.result.errorsX),
166
+ y: Array.from(inputs.result.errorsY).map((v) => Math.abs(v)),
167
+ name: 'error',
168
+ mode: 'lines',
169
+ type: 'scatter',
170
+ yaxis: 'y2',
171
+ },
172
+ ];
173
+ const finalLayout = {
174
+ title: 'Funnel comparison',
175
+ yaxis: { title: 'value' },
176
+ yaxis2: { title: '|error|', overlaying: 'y', side: 'right' },
177
+ ...(layout ?? {}),
178
+ };
179
+ return plotly.newPlot(el, traces, finalLayout);
180
+ }