@selvajs/compute 4.3.0-beta.1 → 5.0.0-beta.2

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.
@@ -1,5 +1,15 @@
1
- import { A as RetryPolicy, N as ComputeError, O as ComputeAuth, _ as isDefinitionRef, a as extractFilesFromComputeResponse, c as ProcessedFile, g as SolveDefinition, h as DefinitionRef, k as ComputeConfig, o as FileBaseInfo, r as downloadFileData, s as FileData } from "./index-BR_XZvjj.js";
1
+ import { A as ServerTiming, D as ComputeConfig, E as ComputeAuth, O as RetryPolicy, g as SolveDefinition, j as ComputeError, o as FileBaseInfo } from "./index-C5T6o4Fr.js";
2
2
  //#region src/grasshopper/server/compute-server-stats.d.ts
3
+ interface ServerVersion {
4
+ rhino: string;
5
+ compute: string;
6
+ git_sha: string | null;
7
+ }
8
+ interface ServerStats {
9
+ isOnline: boolean;
10
+ version?: ServerVersion;
11
+ activeChildren?: number;
12
+ }
3
13
  /**
4
14
  * ComputeServerStats provides methods to query Rhino Compute server statistics.
5
15
  *
@@ -26,7 +36,6 @@ declare class ComputeServerStats {
26
36
  private readonly headers;
27
37
  private disposed;
28
38
  private activeMonitors;
29
- private activeTimeouts;
30
39
  /** Timeout (ms) for the fast read/monitoring endpoints. */
31
40
  private static readonly DEFAULT_TIMEOUT_MS;
32
41
  /** Timeout (ms) for child-lifecycle POSTs — a cold Windows child can take ~30s to spawn. */
@@ -39,11 +48,13 @@ declare class ComputeServerStats {
39
48
  * (`apiKey`, `apiKeyHeader`, `authToken`, `headers`).
40
49
  */
41
50
  constructor(serverUrl: string, auth?: string | ComputeAuth);
51
+ /** Aborts after `timeoutMs` so a hung connection can't stall a probe or `monitor()`; `0` disables it. */
52
+ private fetchWithTimeout;
42
53
  /**
43
- * `fetch` wrapper that aborts after `timeoutMs` so a hung connection can't stall
44
- * a probe (or the `monitor()` loop) forever. Pass `0` to disable the timeout.
54
+ * The response body of `path`, or `null` (logged) on a non-2xx or a network
55
+ * failure. Throws only when disposed.
45
56
  */
46
- private fetchWithTimeout;
57
+ private getText;
47
58
  /**
48
59
  * Check if the server is online.
49
60
  *
@@ -97,11 +108,7 @@ declare class ComputeServerStats {
97
108
  *
98
109
  * @returns Version object with rhino, compute, and git_sha, or null if unavailable
99
110
  */
100
- getVersion(): Promise<{
101
- rhino: string;
102
- compute: string;
103
- git_sha: string | null;
104
- } | null>;
111
+ getVersion(): Promise<ServerVersion | null>;
105
112
  /**
106
113
  * Get the plugins installed on the server.
107
114
  *
@@ -128,15 +135,7 @@ declare class ComputeServerStats {
128
135
  *
129
136
  * @returns Object containing server status and available stats
130
137
  */
131
- getServerStats(): Promise<{
132
- isOnline: boolean;
133
- version?: {
134
- rhino: string;
135
- compute: string;
136
- git_sha: string | null;
137
- };
138
- activeChildren?: number;
139
- }>;
138
+ getServerStats(): Promise<ServerStats>;
140
139
  /**
141
140
  * Purge the server's solve-results / URL-data cache.
142
141
  *
@@ -281,12 +280,7 @@ declare class ComputeServerStats {
281
280
  spawned: number[];
282
281
  active: number;
283
282
  } | null>;
284
- /**
285
- * POST a control endpoint that replies with a JSON object and return it,
286
- * degrading to `null` on any non-2xx, non-JSON, or network failure. Shared by
287
- * the child-lifecycle methods so their failure semantics stay identical. Uses
288
- * the longer lifecycle timeout since a spawn/recycle can take ~30s.
289
- */
283
+ /** A child-lifecycle POST: a spawn or recycle can take ~30 s. */
290
284
  private postJson;
291
285
  /**
292
286
  * Continuously monitor server stats at specified interval.
@@ -307,15 +301,12 @@ declare class ComputeServerStats {
307
301
  * stopMonitoring();
308
302
  * ```
309
303
  */
310
- monitor(callback: (stats: Awaited<ReturnType<typeof this.getServerStats>>) => void, intervalMs?: number): () => void;
304
+ monitor(callback: (stats: ServerStats) => void, intervalMs?: number): () => void;
311
305
  /**
312
306
  * Disposes of all resources and stops all active monitors.
313
307
  * Call this when you're done using the stats instance.
314
308
  */
315
309
  dispose(): Promise<void>;
316
- /**
317
- * Ensures the instance hasn't been disposed.
318
- */
319
310
  private ensureNotDisposed;
320
311
  }
321
312
  //#endregion
@@ -331,17 +322,9 @@ type InnerTreeData = { [path in DataTreePath]: DataItem[]; };
331
322
  /**
332
323
  * Tree with parameter metadata (used in compute requests and responses).
333
324
  *
334
- * Field casing varies by server branch: stock mcneel compute (8.x/9.x)
335
- * serializes `Resthopper.IO.DataTree` in PascalCase (`ParamName`/`InnerTree`
336
- * — the C# class carries no `[JsonProperty]` attributes), while
337
- * camelCase-serializing forks return `paramName`/`innerTree` instead. This
338
- * client always *sends* PascalCase (see `DataTree.toCompute()` in
339
- * `data-tree.ts`), so the PascalCase fields remain the canonical/required
340
- * shape; the optional camelCase fields exist so responses from camelCase
341
- * forks are representable without casts. Code that must read trees across
342
- * both server families should use `readField`/`hasField`
343
- * (`@/core/utils/read-field`, case-insensitive) rather than direct property
344
- * access — `warnOnEmptyInnerTrees` in `solve.ts` is the reference example.
325
+ * This client sends PascalCase (`TreeBuilder.toComputeFormat()`), so those
326
+ * fields are required; a response's casing varies by server branch, so read
327
+ * one with `readField` rather than by property.
345
328
  */
346
329
  interface DataTree {
347
330
  /** PascalCase — stock mcneel servers, and the request shape this client sends. */
@@ -353,7 +336,6 @@ interface DataTree {
353
336
  /** camelCase — sent instead of `ParamName` by camelCase server forks. */
354
337
  paramName?: string;
355
338
  }
356
- type OutputType = 'System.String' | 'System.Double' | 'System.Int32' | 'System.Boolean' | 'Rhino.Geometry.Point3d' | 'Rhino.Geometry.Line' | 'Rhino.Geometry.Circle' | 'Rhino.Geometry.Arc' | 'Rhino.Geometry.NurbsCurve' | 'Rhino.Geometry.Brep' | 'Rhino.Geometry.Mesh' | 'Rhino.Geometry.Vector3d' | 'Rhino.Geometry.Plane' | 'Rhino.Geometry.Box' | (string & {});
357
339
  /**
358
340
  * Union type for all possible default value types
359
341
  */
@@ -428,7 +410,7 @@ interface FileInputType extends BaseInputType {
428
410
  default: DefaultValue<object | string>;
429
411
  }
430
412
  /**
431
- * Color input type (stored as hex string)
413
+ * Color input type. Values are `"R, G, B"` strings (`"255, 0, 0"`), not hex.
432
414
  */
433
415
  interface ColorInputType extends BaseInputType {
434
416
  paramType: 'Color';
@@ -487,55 +469,19 @@ interface GrasshopperDefinitionSource {
487
469
  filename?: string | null;
488
470
  }
489
471
  /**
490
- * Configuration for Grasshopper compute operations
491
- * Combines server config with optional Grasshopper-specific computation settings
492
- *
493
- * Note: The definition source (pointer/algo) is NOT part of config.
494
- * Instead, pass the definition directly to methods like solve(), getIO(), etc.
495
- */
496
- interface GrasshopperComputeConfig extends ComputeConfig {
497
- /** Absolute tolerance used in computation */
498
- absolutetolerance?: number | null;
499
- /** Angular tolerance used in computation */
500
- angletolerance?: number | null;
501
- /** Model units used */
502
- modelunits?: RhinoModelUnit | null;
503
- /** Data version (7 or 8) */
504
- dataversion?: 7 | 8 | null;
505
- /** Whether to use cached solution */
506
- cachesolve?: boolean | null;
507
- /**
508
- * Opt-in: cache a solve even when the definition reported GH errors. See
509
- * {@link GrasshopperBaseSchema.cacheerroredsolves}. Only meaningful with
510
- * `cachesolve`.
511
- */
512
- cacheerroredsolves?: boolean | null;
513
- /** Per-solve live-event callback; see {@link SelvaEventTarget}. */
514
- selvaevents?: SelvaEventTarget | null;
515
- }
516
- /**
517
- * Arguments sent to Grasshopper compute endpoint
518
- * Includes config options + definition source + input values
472
+ * Server config plus the Grasshopper solve settings. The definition is not part
473
+ * of it: pass that to `solve()` and friends.
519
474
  */
520
- interface GrasshopperRequestSchema extends GrasshopperBaseSchema, GrasshopperDefinitionSource {
521
- /** Input values organized by parameter */
522
- values?: DataTree[];
475
+ interface GrasshopperComputeConfig extends ComputeConfig, GrasshopperBaseSchema {
523
476
  /** Per-solve live-event callback; see {@link SelvaEventTarget}. */
524
477
  selvaevents?: SelvaEventTarget | null;
525
478
  }
526
479
  /**
527
- * Response from Grasshopper compute server
528
- * Includes all schema fields + computed results
529
- *
530
- * `pointer` is deliberately excluded (`Omit`): the solve layer (`runSolve` in
531
- * `solve.ts`) splits the server's echoed `pointer` off as the solve's
532
- * `cacheKey` and strips it from the returned response, so client-returned
533
- * responses never carry it.
480
+ * Response from Grasshopper compute server.
534
481
  *
535
- * The schema-echo fields (`cachesolve`/`modelunits`/`dataversion`) stay
536
- * optional as inherited from {@link GrasshopperBaseSchema}: the server echoes
537
- * them back when set, but nothing client-side enforces their presence — don't
538
- * rely on them without a fallback.
482
+ * No `pointer`: the solve returns the server's echoed pointer as its `cacheKey`
483
+ * instead. The echoed settings (`cachesolve`, `dataversion`) stay optional:
484
+ * nothing client-side enforces them.
539
485
  */
540
486
  interface GrasshopperComputeResponse extends GrasshopperBaseSchema, Omit<GrasshopperDefinitionSource, 'pointer'> {
541
487
  /**
@@ -545,12 +491,7 @@ interface GrasshopperComputeResponse extends GrasshopperBaseSchema, Omit<Grassho
545
491
  * hand-built mock may omit it at runtime.
546
492
  */
547
493
  modelunits: RhinoModelUnit;
548
- /**
549
- * The server echoes the request's full base64 definition back as `algo`, but the client strips
550
- * it before returning — retaining it would pin a multi-MB copy of the definition per response,
551
- * multiplied by every cache that holds responses. Always `undefined` on client-returned
552
- * responses (inherited optional field from {@link GrasshopperDefinitionSource}).
553
- */
494
+ /** Always `undefined` on a client-returned response: the solve strips it. */
554
495
  algo?: string | null;
555
496
  /** Filename of the definition (always present in response) */
556
497
  filename: string | null;
@@ -617,20 +558,19 @@ interface InputParamSchema {
617
558
  }
618
559
  //#endregion
619
560
  //#region src/grasshopper/types/outputs.d.ts
620
- /**
621
- * Parsed input/output structure with raw schemas.
622
- *
623
- * `loadWarnings` / `loadErrors` carry the server's definition-load diagnostics
624
- * (missing plugin, broken component, etc.) from the `/io` response. They are
625
- * distinct from per-input parse failures (`InputParseError`): these come from
626
- * the server loading the definition, those from the client typing an input.
627
- */
561
+ /** Input/output schemas as the `/io` endpoint reports them, keys canonicalized. */
628
562
  interface GrasshopperParsedIORaw {
629
563
  inputs: InputParamSchema[];
630
564
  outputs: OutputParamSchema[];
631
- /** Server-side definition-load warnings, if any. */
565
+ /**
566
+ * Warnings the server raised loading the definition (e.g. an obsolete
567
+ * component). Distinct from `parseErrors`, the client failing to type an input.
568
+ */
632
569
  loadWarnings?: string[];
633
- /** Server-side definition-load errors, if any (e.g. missing plugin). */
570
+ /**
571
+ * Errors the server raised loading the definition (e.g. a missing plugin).
572
+ * When present, `inputs`/`outputs` may be incomplete.
573
+ */
634
574
  loadErrors?: string[];
635
575
  }
636
576
  /**
@@ -649,43 +589,26 @@ interface InputParseError {
649
589
  /** Error code from the underlying ComputeError, if available. */
650
590
  code?: string;
651
591
  }
652
- /**
653
- * Parsed input/output structure with processed types.
654
- *
655
- * `parseErrors` is populated when one or more inputs failed validation and
656
- * fell back to a safe default. The result is still usable, but the UI should
657
- * surface these so the user can fix their definition.
658
- */
659
- interface GrasshopperParsedIO {
592
+ /** {@link GrasshopperParsedIORaw} with each input parsed into its typed {@link InputParam}. */
593
+ interface GrasshopperParsedIO extends Omit<GrasshopperParsedIORaw, 'inputs'> {
660
594
  inputs: InputParam[];
661
- outputs: OutputParamSchema[];
662
- parseErrors?: InputParseError[];
663
595
  /**
664
- * Server-side definition-load warnings from the `/io` response (e.g. an
665
- * obsolete component). Surface these so the user understands a degraded IO
666
- * list. Distinct from `parseErrors` (client-side input typing failures).
596
+ * Inputs that failed validation and got a safe default. The result is still
597
+ * usable, but surface these so the user can fix their definition.
667
598
  */
668
- loadWarnings?: string[];
669
- /**
670
- * Server-side definition-load errors from the `/io` response (e.g. a missing
671
- * plugin that left inputs unresolved). When present, the inputs/outputs may
672
- * be incomplete — the user needs to fix their server/definition.
673
- */
674
- loadErrors?: string[];
599
+ parseErrors?: InputParseError[];
675
600
  }
676
601
  //#endregion
677
602
  //#region src/grasshopper/scheduler/types.d.ts
678
603
  /**
679
- * Scheduling mode — controls how concurrent `solve()` calls interact.
604
+ * How concurrent `solve()` calls interact.
680
605
  *
681
- * - `latest-wins`: One in flight at a time. New calls supersede any pending
682
- * call (in-flight one is aborted). Optimal for slider scrubs / live UIs.
683
- * - `queue`: FIFO queue. Each solve runs to completion. Concurrency capped
684
- * by `maxConcurrent`. Use for "submit job" flows where every request matters.
685
- * - `parallel`: No scheduling — calls run concurrently up to `maxConcurrent`.
686
- * Closest to plain `client.solve()` but with shared cancel/state.
606
+ * - `latest-wins`: one in flight at a time. A new call supersedes the pending
607
+ * one and aborts the one in flight. For slider scrubs and live UIs.
608
+ * - `queue`: FIFO, every call runs to completion, up to `maxConcurrent` at
609
+ * once (default 1). For "submit job" flows where every request matters.
687
610
  */
688
- type SchedulerMode = 'latest-wins' | 'queue' | 'parallel';
611
+ type SchedulerMode = 'latest-wins' | 'queue';
689
612
  interface CacheOptions {
690
613
  /**
691
614
  * Total byte budget for retained responses, evicted LRU. The only size bound
@@ -729,7 +652,7 @@ interface SolveSchedulerOptions {
729
652
  * excluding the ones already in flight). When the queue is full, a new
730
653
  * `solve()` is rejected immediately with `code: QUEUE_FULL` (retryable, meant to
731
654
  * map to HTTP 503 + Retry-After) instead of piling up unbounded. Bounds the
732
- * miss path under load. Only applies to `queue` / `parallel` modes —
655
+ * miss path under load. Only applies to `queue` mode —
733
656
  * `latest-wins` has an intrinsic depth of 1. Default: unbounded.
734
657
  */
735
658
  maxQueueDepth?: number;
@@ -737,8 +660,7 @@ interface SolveSchedulerOptions {
737
660
  * Backpressure — max time (ms) a call may sit queued before it starts
738
661
  * executing. If it's still waiting after this long it's rejected with
739
662
  * `code: QUEUE_TIMEOUT` rather than burning compute on a stale request.
740
- * Bounds tail latency. Only applies to `queue` / `parallel` modes. Default:
741
- * no deadline.
663
+ * Bounds tail latency. Only applies to `queue` mode. Default: no deadline.
742
664
  */
743
665
  queueWaitMs?: number;
744
666
  timeoutMs?: number;
@@ -750,15 +672,11 @@ interface SolveSchedulerOptions {
750
672
  */
751
673
  cache?: false | CacheOptions;
752
674
  /**
753
- * Reuse the server's definition cache key so a large (base64/binary)
754
- * definition is uploaded once and subsequent solves reference it by
755
- * `pointer` instead of re-sending the full payload. Hugely cheaper for
756
- * multi-MB definitions on a live UI (slider scrubs, etc.).
757
- *
758
- * Requires a `cacheKeyExecutor` to be supplied (the client wires one). Has no
759
- * effect for URL-pointer definitions (already a reference). On a server-side
760
- * cache miss the executor transparently falls back to a full upload, so this
761
- * is safe to leave on. Default: `true` when a `cacheKeyExecutor` is present.
675
+ * Upload a definition once, then solve it by the server's cache key (`pointer`)
676
+ * instead of re-sending the bytes; a `DefinitionRef` also skips its `load()`.
677
+ * When the server has evicted the key, the solve falls back to a full upload,
678
+ * so this is safe to leave on. No effect for URL definitions, which are
679
+ * already a reference. Default `true`.
762
680
  */
763
681
  reuseServerDefinitionCache?: boolean;
764
682
  /** Lifecycle hooks — fired in order. Errors thrown by hooks are logged, not rethrown. */
@@ -780,12 +698,10 @@ type SolveResult = {
780
698
  durationMs: number;
781
699
  fromCache: boolean;
782
700
  /**
783
- * Definition-cache telemetry for a real compute call (not a Selva-cache
784
- * `fromCache` hit). `false` → the server reused its cached definition via
785
- * the pointer (no upload); `true` → the pointer was cold/stale so the full
786
- * definition was re-uploaded. `undefined` when the server-definition-cache
787
- * fast path didn't run (reuse disabled, or a non-reusable definition such
788
- * as a remote URL).
701
+ * Whether this solve uploaded the full definition: `true` on its first
702
+ * solve or after the server evicted the cache key, `false` when the server
703
+ * reused its cached copy via the pointer. `undefined` for a `fromCache`
704
+ * hit, or when reuse is off or the definition is a URL.
789
705
  */
790
706
  definitionReuploaded?: boolean;
791
707
  } | {
@@ -795,39 +711,45 @@ type SolveResult = {
795
711
  } | {
796
712
  status: 'superseded';
797
713
  };
798
- type SolveExecutor = (definition: SolveDefinition, dataTree: DataTree[], config: GrasshopperComputeConfig) => Promise<GrasshopperComputeResponse>;
799
714
  /**
800
- * Cache-key-aware executor. When `cacheKey` is provided, the executor solves by
801
- * reference (`pointer: cacheKey`) and falls back to a full upload on a server
802
- * cache miss. Always reports the (possibly refreshed) `cacheKey` so the
803
- * scheduler can update its definition→key map, plus whether the fast path
804
- * `missed` (for telemetry). When `cacheKey` is null it's a first solve — upload
805
- * fully and capture the key the server assigns.
806
- *
807
- * Supplied by the client (which owns the solve primitives); the scheduler stays
808
- * decoupled from the transport.
715
+ * Solves by `cacheKey` when given one, otherwise uploads. Reports the server's
716
+ * (possibly new) key and whether the full definition was uploaded (`missed`).
717
+ * The scheduler passes `null` whenever server-definition reuse is off.
809
718
  */
810
- type CacheKeyExecutor = (definition: SolveDefinition, dataTree: DataTree[], cacheKey: string | null, config: GrasshopperComputeConfig) => Promise<{
719
+ type SolveExecutor = (definition: SolveDefinition, dataTree: DataTree[], cacheKey: string | null, config: GrasshopperComputeConfig) => Promise<{
811
720
  response: GrasshopperComputeResponse;
812
721
  cacheKey: string | null;
813
722
  missed: boolean;
814
723
  }>;
724
+ interface SchedulerSolveOptions {
725
+ signal?: AbortSignal;
726
+ /** Per-solve live-event callback. Not part of the cache key: it names where events go, not what is solved. */
727
+ selvaevents?: SelvaEventTarget;
728
+ /**
729
+ * This call's `Server-Timing` breakdown, after the client config's own `onServerTiming`.
730
+ * Never fires for a `fromCache` hit, which sends no request.
731
+ */
732
+ onServerTiming?: (timing: ServerTiming, requestId: string) => void;
733
+ }
734
+ /** What `solveDetailed()` resolves with: the response plus how this call got it. */
735
+ interface SolveDetail {
736
+ response: GrasshopperComputeResponse;
737
+ /** Served from the scheduler's response cache without a request. */
738
+ fromCache: boolean;
739
+ /** Same meaning as on {@link SolveResult}. */
740
+ definitionReuploaded?: boolean;
741
+ /** Executor wall time; `0` for a `fromCache` hit. */
742
+ durationMs: number;
743
+ }
815
744
  //#endregion
816
745
  //#region src/grasshopper/scheduler/solve-scheduler.d.ts
817
746
  /**
818
- * Robust scheduler for Grasshopper solves.
819
- *
820
- * Sits between your application code and the underlying compute call,
821
- * adding:
822
- * - Configurable scheduling (latest-wins for sliders, queue for jobs)
823
- * - Backpressure (bounded queue depth + queue-wait deadline) for the miss path
824
- * - In-flight cancellation (per-call signal + cancelAll)
747
+ * Adds to a plain solve call:
748
+ * - Scheduling (latest-wins for sliders, queue for jobs)
749
+ * - Backpressure (bounded queue depth + queue-wait deadline)
750
+ * - Cancellation (per-call signal + cancelAll)
825
751
  * - Optional response caching for repeated inputs
826
- * - Lifecycle hooks for UI indicators (start / settle / superseded)
827
- * - State observability via subscribe()
828
- *
829
- * Multiple schedulers can share a single GrasshopperClient — typically one
830
- * per UI surface (e.g. one for slider scrubs, one for long-running submits).
752
+ * - Lifecycle hooks (start / settle / superseded) and state via subscribe()
831
753
  *
832
754
  * @example
833
755
  * ```ts
@@ -850,11 +772,6 @@ export declare class SolveScheduler {
850
772
  private readonly executor;
851
773
  private readonly baseConfig;
852
774
  private readonly mode;
853
- /**
854
- * Mutable via {@link setMaxConcurrent}: the compute server's worker pool can grow
855
- * or shrink while this scheduler is alive, and the dispatch loops re-read this on
856
- * every pass rather than capturing it.
857
- */
858
775
  private maxConcurrent;
859
776
  private readonly maxQueueDepth;
860
777
  private readonly queueWaitMs;
@@ -865,21 +782,12 @@ export declare class SolveScheduler {
865
782
  private readonly cacheTtl;
866
783
  private readonly cacheErroredSolves;
867
784
  private readonly cache;
868
- /** Sum of `sizeBytes` across retained cache entries. */
869
785
  private cacheBytes;
870
- /**
871
- * Cumulative hit/miss/eviction counters for {@link cacheStats}. Deliberately
872
- * NOT reset by `clearCache()` — they measure this scheduler's whole lifetime,
873
- * so a hit rate stays comparable across a session rather than restarting at
874
- * every clear.
875
- */
876
786
  private cacheHits;
877
787
  private cacheMisses;
878
788
  private cacheEvictions;
879
- /** Optional cache-key-aware executor and whether server-def-cache reuse is on. */
880
- private readonly cacheKeyExecutor?;
881
789
  private readonly reuseServerDefinitionCache;
882
- /** definition identity → server cache key (`pointer`) learned from past solves. */
790
+ /** Definition hash → the server's cache key (`pointer`) for it. */
883
791
  private readonly serverCacheKeys;
884
792
  private readonly onStart?;
885
793
  private readonly onSettle?;
@@ -891,12 +799,11 @@ export declare class SolveScheduler {
891
799
  private _lastResult;
892
800
  private _lastError;
893
801
  private _lastDurationMs;
894
- /** Ordinal handed to each solve() call. */
895
802
  private solveSeq;
896
- /** seq of the solve that last wrote _lastResult/_lastError — see writeLastState. */
803
+ /** seq of the solve that last wrote `_lastResult`/`_lastError`. */
897
804
  private lastStateSeq;
898
805
  private disposed;
899
- constructor(executor: SolveExecutor, baseConfig: GrasshopperComputeConfig, options?: SolveSchedulerOptions, cacheKeyExecutor?: CacheKeyExecutor);
806
+ constructor(executor: SolveExecutor, baseConfig: GrasshopperComputeConfig, options?: SolveSchedulerOptions);
900
807
  get isSolving(): boolean;
901
808
  get hasPending(): boolean;
902
809
  get inFlightCount(): number;
@@ -925,23 +832,16 @@ export declare class SolveScheduler {
925
832
  * - Rejects with `code: ErrorCodes.SUPERSEDED` when the call was canceled because
926
833
  * newer values arrived (latest-wins mode).
927
834
  * - Rejects with `code: ErrorCodes.ABORTED` when the call was canceled via
928
- * caller-supplied signal or `cancelAll()`.
835
+ * its own `signal` (queued or running) or `cancelAll()`.
929
836
  * - Rejects with `code: ErrorCodes.QUEUE_FULL` when `maxQueueDepth` is set and
930
837
  * the queue was already full (backpressure; `statusCode: 503`).
931
838
  * - Rejects with `code: ErrorCodes.QUEUE_TIMEOUT` when `queueWaitMs` is set and
932
839
  * the call sat queued longer than that before starting (`statusCode: 503`).
933
840
  *
934
- * Caller-supplied `signal` cancels just this call (rejects with `ABORTED`) —
935
- * including while the call is still queued, before execution starts.
936
- *
937
- * A {@link DefinitionRef} definition is keyed by its `key` (result cache and
938
- * server-pointer map alike) without materializing bytes — `load()` runs only
939
- * when an upload is unavoidable. Its immutability contract is trusted here:
940
- * a reused key serves the other content's cached solve.
941
- *
942
- * Responses served from the cache (and via `lastResult`) are shared objects,
943
- * not copies — treat them as immutable. Mutating one poisons every later
944
- * cache hit for that key.
841
+ * Don't mutate a `Uint8Array` definition after solving it. Responses served
842
+ * from the cache (and via `lastResult`) are shared objects, not copies —
843
+ * treat them as immutable. Mutating one poisons every later cache hit for
844
+ * that key.
945
845
  *
946
846
  * Partial-success contract: unlike `GrasshopperClient.solve()`, which throws
947
847
  * `COMPUTATION_ERROR` when the response carries solver errors, this RESOLVES
@@ -949,79 +849,44 @@ export declare class SolveScheduler {
949
849
  * success must not be treated as a result (see `cacheErroredSolves` for the
950
850
  * caching side of the same distinction).
951
851
  */
952
- solve(definition: SolveDefinition, dataTree: DataTree[], options?: {
953
- signal?: AbortSignal;
954
- selvaevents?: SelvaEventTarget;
955
- }): Promise<GrasshopperComputeResponse>;
956
- /**
957
- * Record last-result state, but only if no newer solve has written since —
958
- * a slow solve settling late must not overwrite the state a newer solve
959
- * (or cache hit) already published.
960
- */
852
+ solve(definition: SolveDefinition, dataTree: DataTree[], options?: SchedulerSolveOptions): Promise<GrasshopperComputeResponse>;
853
+ /** {@link solve}, also resolving with whether this call hit the cache and how long it took. */
854
+ solveDetailed(definition: SolveDefinition, dataTree: DataTree[], options?: SchedulerSolveOptions): Promise<SolveDetail>;
855
+ /** A slow solve settling late must not overwrite state a newer solve or cache hit published. */
961
856
  private writeLastState;
962
857
  /** latest-wins: supersede the pending item and abort everything in flight. */
963
858
  private supersedeCurrent;
964
- /** Settle a still-queued item as ABORTED and remove it from its queue. */
859
+ private dequeue;
965
860
  private abortQueuedItem;
966
- /**
967
- * Backpressure: settle an incoming item as QUEUE_FULL without ever enqueuing
968
- * it. The structured context lets an HTTP layer map it to 503 + Retry-After.
969
- */
861
+ /** The structured context lets an HTTP layer map QUEUE_FULL to 503 + Retry-After. */
970
862
  private shedAsQueueFull;
971
- /**
972
- * Arm the queue-wait deadline for an item about to be queued. If the item is
973
- * still waiting when it fires, it's rejected as QUEUE_TIMEOUT and removed from
974
- * the queue. Cleared on execute/settle via {@link clearQueueWaitTimer}.
975
- */
976
863
  private armQueueWaitTimer;
977
- /** Clear a queued item's wait-deadline timer, if one is pending. */
978
864
  private clearQueueWaitTimer;
979
865
  private enqueue;
980
866
  private execute;
981
- /**
982
- * Run the solve, using the server-definition-cache fast path when it's
983
- * enabled and the definition is reusable. Learns/updates the definition's
984
- * server cache key from the result so later solves can reference it.
985
- *
986
- * `definitionHash` is the {@link hashDefinition} result already computed at
987
- * `solve()` entry — threaded through rather than recomputed, so each solve
988
- * pays exactly one linear pass over the definition (issue 57).
989
- */
990
867
  private runExecutor;
991
868
  private drainNext;
992
869
  private supersede;
993
870
  private makeAbortError;
994
871
  /**
995
- * Settle a pending/in-flight item exactly once with an error.
996
- *
997
- * A solve promise can be settled from four concurrent sources — the executor
998
- * resolving, the executor rejecting, `supersede`, and `cancelAll` — and a JS
999
- * promise silently ignores a second settle. This guard is the single place the
1000
- * settle-once invariant lives: it makes the *first* settle win and reports
1001
- * whether this call was that winner, so callers fire their own hook only when
1002
- * they actually settled. Any new settle path must go through here (or
1003
- * {@link settleSuccess}) so the guard can't be forgotten.
1004
- *
1005
- * @returns `true` if this call settled the item; `false` if it was already settled.
872
+ * The executor, `supersede`, `cancelAll`, abort and the queue limits can all race to settle one
873
+ * item, and a promise ignores a second settle silently. The first settle wins; the return value
874
+ * says whether this call won, so only the winner fires its hook. Every settle path goes through
875
+ * here or {@link settleSuccess}.
1006
876
  */
1007
877
  private settleError;
1008
878
  /**
1009
- * Settle a pending/in-flight item exactly once with a successful response.
1010
- * The success counterpart to {@link settleError}; see it for the invariant.
1011
- *
1012
- * @returns `true` if this call settled the item; `false` if it was already settled.
879
+ * Fires `onSettle` for queued items too, so a consumer counting solves in progress doesn't
880
+ * leak one. A supersede settles through {@link settleError} and fires `onSuperseded` instead.
1013
881
  */
882
+ private fail;
1014
883
  private settleSuccess;
1015
- /** Detach the queued-phase abort listener, if one is still attached. */
1016
884
  private removeQueuedAbortHandler;
1017
- private isAbortLikeError;
1018
885
  private normalizeExecutionError;
1019
886
  /** Cancel everything — in-flight and pending. */
1020
887
  cancelAll(): void;
1021
- private rejectAsAborted;
1022
888
  private readCache;
1023
889
  private writeCache;
1024
- /** Remove one cache entry and release its bytes from the running total. */
1025
890
  private dropCacheEntry;
1026
891
  clearCache(): void;
1027
892
  /**
@@ -1061,6 +926,19 @@ interface SolveOptions {
1061
926
  /** Per-solve live-event callback, forwarded onto the request body. */
1062
927
  selvaevents?: SelvaEventTarget;
1063
928
  }
929
+ /** Options for {@link GrasshopperClient.create} that shape construction, not the solves. */
930
+ interface CreateClientOptions {
931
+ /**
932
+ * Retry ladder for the liveness probe: `attempts` retries after the first probe (default 2),
933
+ * with exponential backoff from `baseDelayMs` (default 250) capped at `maxDelayMs` (default 1000).
934
+ * Independent of `config.retry`, which governs solves only.
935
+ */
936
+ probe?: {
937
+ attempts?: number;
938
+ baseDelayMs?: number;
939
+ maxDelayMs?: number;
940
+ };
941
+ }
1064
942
  /**
1065
943
  * GrasshopperClient provides a simple API for interacting with a Rhino Compute server and grasshopper.
1066
944
  *
@@ -1078,7 +956,8 @@ interface SolveOptions {
1078
956
  * });
1079
957
  *
1080
958
  * try {
1081
- * const result = await client.solve(definitionUrl, { x: 1, y: 2 });
959
+ * const io = await client.getIO(definitionUrl);
960
+ * const result = await client.solve(definitionUrl, TreeBuilder.fromInputParams(io.inputs));
1082
961
  * } finally {
1083
962
  * await client.dispose(); // Clean up resources
1084
963
  * }
@@ -1109,16 +988,12 @@ declare class GrasshopperClient {
1109
988
  * a user who clicked Solve, so the retry ladder must not spend its whole
1110
989
  * budget confirming that a machine is switched off.
1111
990
  *
1112
- * Each probe is bounded by {@link CREATE_PROBE_TIMEOUT_MS} rather than the
1113
- * stats default: a healthy `GET /` answers in milliseconds, so a longer
1114
- * per-probe timeout only multiplies the wait when the server is unreachable.
1115
- *
1116
991
  * @throws {ComputeError} with code NETWORK_ERROR if the server stays
1117
992
  * unreachable across all attempts. `context.probeVerdict` carries the
1118
993
  * {@link ProbeVerdict} so callers can render a specific cause.
1119
994
  * @throws {ComputeError} with code INVALID_CONFIG if configuration is invalid
1120
995
  */
1121
- static create(config: GrasshopperComputeConfig): Promise<GrasshopperClient>;
996
+ static create(config: GrasshopperComputeConfig, options?: CreateClientOptions): Promise<GrasshopperClient>;
1122
997
  /**
1123
998
  * Gets the client's configuration.
1124
999
  * Useful for passing to lower-level functions.
@@ -1162,16 +1037,7 @@ declare class GrasshopperClient {
1162
1037
  * Call this when you're done using the client.
1163
1038
  */
1164
1039
  dispose(): Promise<void>;
1165
- /**
1166
- * Ensures the client hasn't been disposed.
1167
- */
1168
1040
  private ensureNotDisposed;
1169
- /**
1170
- * Validates and normalizes a compute configuration.
1171
- *
1172
- * @throws {ComputeError} with code INVALID_CONFIG if configuration is invalid
1173
- */
1174
- private normalizeComputeConfig;
1175
1041
  }
1176
1042
  //#endregion
1177
1043
  //#region src/grasshopper/io/output/response-processors.d.ts
@@ -1200,39 +1066,13 @@ interface GetValuesResult<T = ParsedContext> {
1200
1066
  }
1201
1067
  //#endregion
1202
1068
  //#region src/grasshopper/client/grasshopper-response-processor.d.ts
1203
- /**
1204
- * High-level wrapper for interacting with Grasshopper Compute responses.
1205
- *
1206
- * This class exposes a clean, consistent API for accessing parsed values,
1207
- * geometry, and produced files. It is designed to be the primary interface
1208
- * when working with Grasshopper results in client applications.
1209
- */
1069
+ /** Reads parsed values and produced files out of one compute response. */
1210
1070
  declare class GrasshopperResponseProcessor {
1211
- /**
1212
- * The raw compute response. Public so callers can hand it to a renderer-side parser — e.g.
1213
- * `getThreeMeshesFromComputeResponse` in `@selvajs/visualization/parse`, which replaced this
1214
- * class's former `extractMeshesFromResponse()`.
1215
- */
1071
+ /** Hand it to a mesh parser such as `@selvajs/visualization/parse`. */
1216
1072
  readonly response: GrasshopperComputeResponse;
1217
- /**
1218
- * Retained for call-signature compatibility. Its only consumer was the removed
1219
- * `extractMeshesFromResponse()`, which merged it into the parse options; pass `debug`
1220
- * directly to the parser in `@selvajs/visualization/parse` instead.
1221
- */
1222
- readonly debug: boolean;
1223
1073
  constructor(
1224
- /**
1225
- * The raw compute response. Public so callers can hand it to a renderer-side parser — e.g.
1226
- * `getThreeMeshesFromComputeResponse` in `@selvajs/visualization/parse`, which replaced this
1227
- * class's former `extractMeshesFromResponse()`.
1228
- */
1229
- response: GrasshopperComputeResponse,
1230
- /**
1231
- * Retained for call-signature compatibility. Its only consumer was the removed
1232
- * `extractMeshesFromResponse()`, which merged it into the parse options; pass `debug`
1233
- * directly to the parser in `@selvajs/visualization/parse` instead.
1234
- */
1235
- debug?: boolean);
1074
+ /** Hand it to a mesh parser such as `@selvajs/visualization/parse`. */
1075
+ response: GrasshopperComputeResponse);
1236
1076
  /**
1237
1077
  * Extract all values in the response.
1238
1078
  *
@@ -1269,19 +1109,6 @@ declare class GrasshopperResponseProcessor {
1269
1109
  } | {
1270
1110
  byId: string;
1271
1111
  }, options?: GetValuesOptions): any;
1272
- /**
1273
- * REMOVED: `extractMeshesFromResponse()`. Mesh decoding lives in `@selvajs/visualization` now, so
1274
- * this package stays pure solve/data and carries no `three` dependency. Call the parser directly
1275
- * with the raw response:
1276
- *
1277
- * ```ts
1278
- * import { getThreeMeshesFromComputeResponse } from '@selvajs/visualization/parse';
1279
- *
1280
- * const meshes = await getThreeMeshesFromComputeResponse(processor.response, { rhino });
1281
- * scene.add(...meshes);
1282
- * ```
1283
- */
1284
- private getFileData;
1285
1112
  /**
1286
1113
  * Download all files generated by Grasshopper, optionally including
1287
1114
  * additional user-provided files.
@@ -1315,100 +1142,54 @@ declare class GrasshopperResponseProcessor {
1315
1142
  * (false misses are harmless; false hits serve the wrong cached solve).
1316
1143
  */
1317
1144
  export declare function stableStringify(value: unknown): string;
1318
- /**
1319
- * Hash definition and data tree into a stable cache key.
1320
- *
1321
- * The definition is the *identity* of what we solve, so a binary definition is
1322
- * hashed over its full content (`fnv1aBytes`) — a length-only or sampled key
1323
- * would let two different `.gh` files collide and serve one's cached solve for
1324
- * the other. `.gh` files are small enough that a single linear pass is
1325
- * negligible. A {@link DefinitionRef} is keyed by its `key` alone — the
1326
- * caller-declared identity of immutable bytes — so no bytes are materialized
1327
- * or hashed at all.
1328
- *
1329
- * The key keeps the definition and tree hashes as separate parts rather than
1330
- * collapsing them into one 32-bit hash: a single FNV pass over the pair would
1331
- * birthday-collide quadratically in cache size, while requiring both 32-bit
1332
- * parts (plus lengths) to collide at once makes that negligible.
1333
- */
1145
+ /** The scheduler's solve-cache key for a definition and its input tree. */
1334
1146
  export declare function hashSolveInput(definition: SolveDefinition, dataTree: unknown): string;
1335
1147
  /**
1336
- * Stable identity of a definition alone (no inputs) — used to key the
1337
- * server-cache-key map so the same definition reuses its `pointer` across solves
1338
- * with different inputs. Same full-content hashing as {@link hashSolveInput}: a
1339
- * binary definition is hashed over all its bytes so two distinct `.gh` files of
1340
- * equal length can't share a cache key. A {@link DefinitionRef} is keyed by its
1341
- * `key` verbatim (refs are short identities like UUIDs, safe as Map keys) —
1342
- * its immutability contract makes the key equivalent to a content hash.
1148
+ * A definition's identity, without its inputs. Strings and bytes are hashed over their full
1149
+ * content, so two files of equal length never share a key; a `DefinitionRef` uses its `key`.
1343
1150
  */
1344
1151
  export declare function hashDefinition(definition: SolveDefinition): string;
1345
1152
  //#endregion
1346
1153
  //#region src/grasshopper/solve.d.ts
1347
1154
  /**
1348
- * Runs a Rhino Compute job using the provided tree prototypes and Grasshopper definition.
1155
+ * Run one solve. `GrasshopperClient.solve()` adds input validation and throws on solver errors.
1349
1156
  *
1350
- * @public Use this for direct compute control. For high-level API, use `GrasshopperClient.solve()`.
1351
- *
1352
- * @param dataTree - An array of `DataTree` objects representing the input data for the compute job.
1353
- * @param definition - The Grasshopper definition, which can be:
1354
- * - A URL string (e.g., 'https://example.com/definition.gh')
1355
- * - A base64-encoded string of the .gh file
1356
- * - A plain string (will be base64-encoded)
1357
- * - A Uint8Array of the .gh file (will be base64-encoded)
1358
- * - A `DefinitionRef` (bytes are loaded via `ref.load()` for the upload)
1359
- * @param config - Compute configuration (server URL, API key, etc. along with optional timeout, units, etc.)
1360
- * @returns An object containing the compute result and extracted file data.
1157
+ * @param definition - A URL (sent as a pointer), base64 `.gh` content, raw `.gh` bytes, or a
1158
+ * `DefinitionRef` (loaded for the upload). Any other string is encoded as the definition text.
1159
+ * @returns The compute response, without the server's `pointer` and echoed `algo`.
1361
1160
  *
1362
1161
  * @example
1363
- * // Using a URL
1364
1162
  * await solveGrasshopperDefinition(trees, 'https://example.com/definition.gh', config);
1365
- *
1366
- * // Using a base64 string
1367
- * await solveGrasshopperDefinition(trees, 'UEsDBBQAAAAIAL...', config);
1368
- *
1369
- * // Using binary data
1370
- * const fileData = new Uint8Array([...]);
1371
- * await solveGrasshopperDefinition(trees, fileData, config);
1163
+ * await solveGrasshopperDefinition(trees, new Uint8Array(await readFile('model.gh')), config);
1372
1164
  */
1373
1165
  export declare function solveGrasshopperDefinition(dataTree: DataTree[], definition: SolveDefinition, config: GrasshopperComputeConfig): Promise<GrasshopperComputeResponse>;
1374
1166
  //#endregion
1375
1167
  //#region src/grasshopper/io/definition-io.d.ts
1376
1168
  /**
1377
- * Fetches raw input/output schemas from a Grasshopper definition.
1169
+ * Fetches a definition's input/output schemas without per-type parsing.
1378
1170
  *
1379
- * "Raw" means no per-type parsing (no default coercion, no discriminated-union
1380
- * typing) — but NOT byte-for-byte wire data. The response IS normalized:
1381
- * per-param field KEYS are canonicalized to camelCase across server branches
1382
- * ({@link normalizeInputSchema} / {@link normalizeOutputSchema}, with honest
1383
- * fallbacks for missing required fields), missing/non-array `inputs`/`outputs`
1384
- * coerce to `[]`, and server load diagnostics surface as
1385
- * `loadWarnings`/`loadErrors` (coerced to strings). Field VALUES — notably
1386
- * `default` and the `values` dropdown-label map — pass through verbatim.
1171
+ * Field KEYS are canonicalized to camelCase and missing required fields get a
1172
+ * fallback ({@link normalizeInputSchema}); a missing or non-array `inputs` /
1173
+ * `outputs` becomes `[]`. Field VALUES, notably `default` and the `values`
1174
+ * label map, pass through verbatim.
1387
1175
  *
1388
- * @param definition - The Grasshopper definition (URL, base64 string, or Uint8Array)
1389
- * @param config - Compute configuration (server URL, API key, etc.)
1390
- * @returns Key-normalized inputs and outputs with no per-type processing
1391
1176
  * @throws {ComputeError} If fetch fails or response is invalid
1392
1177
  *
1393
1178
  * @public Use `fetchParsedDefinitionIO()` for processed, type-safe inputs
1394
1179
  */
1395
1180
  export declare function fetchDefinitionIO(definition: string | Uint8Array, config: ComputeConfig): Promise<GrasshopperParsedIORaw>;
1396
1181
  /**
1397
- * Fetches and processes input/output schemas from a Grasshopper definition.
1398
- * Returns strongly-typed, validated input parameters ready for use.
1399
- *
1400
- * @public This is the recommended way to fetch definition I/O schemas.
1182
+ * Fetches a definition's input/output schemas and parses each input into its
1183
+ * typed `InputParam`. An input that fails to parse gets a safe default
1184
+ * and an entry in `parseErrors`.
1401
1185
  *
1402
- * @param definition - The Grasshopper definition (URL, base64 string, or Uint8Array)
1403
- * @param config - Compute configuration (server URL, API key, etc.)
1404
- * @returns Processed inputs with discriminated union types and outputs
1405
1186
  * @throws {ComputeError} If fetch fails or response is invalid
1406
1187
  *
1407
1188
  * @example
1408
1189
  * ```typescript
1409
1190
  * const { inputs, outputs } = await fetchParsedDefinitionIO(
1410
1191
  * 'https://example.com/definition.gh',
1411
- * { serverUrl: 'https://compute.rhino3d.com', apiKey: 'YOUR_KEY' }
1192
+ * { serverUrl: 'http://localhost:6500', apiKey: 'YOUR_KEY' }
1412
1193
  * );
1413
1194
  *
1414
1195
  * // Inputs are now strongly typed
@@ -1433,101 +1214,87 @@ interface SchemaEndpointResult<TSchema = unknown> {
1433
1214
  * Read compute's `/grasshopper/schema` body: `[{ FileName, Schemas }]` per
1434
1215
  * uploaded file, or a bare object for a single file.
1435
1216
  *
1436
- * Use this rather than unwrapping the body by hand. The wrapper's casing varies
1437
- * by server branch — mcneel serializes `FileName`/`Schemas`, the VektorNode fork
1438
- * `fileName`/`schemas` — so a fixed-key read silently yields `undefined` against
1439
- * half the servers, and the endpoint answers 200 either way. The failure looks
1440
- * like "this definition has no schemas", which sends you debugging the wrong
1441
- * thing entirely.
1442
- *
1443
- * A blanket key-rewrite (the old `camelcaseKeys` approach) is NOT the fix: it
1444
- * reaches inside the schemas and mangles user-authored names — `"Display3d"` →
1445
- * `"display3d"`, value-list labels like `"Option A"` → `"optionA"`. Only the two
1446
- * wrapper keys are read here; schema CONTENTS pass through untouched, which is
1447
- * why `TSchema` is a pass-through type parameter this module never inspects.
1217
+ * Use this rather than unwrapping the body by hand: the wrapper keys' casing
1218
+ * varies by server branch, and a fixed-key read yields "no schemas" with a 200.
1219
+ * Only the two wrapper keys are read; schema contents pass through untouched.
1448
1220
  *
1449
1221
  * @typeParam TSchema - Your schema type (e.g. `UISchema`). Not inspected.
1450
- * @param raw - The parsed JSON body.
1451
1222
  */
1452
1223
  export declare function readSchemaResults<TSchema = unknown>(raw: unknown): SchemaEndpointResult<TSchema>[];
1453
1224
  //#endregion
1454
1225
  //#region src/grasshopper/io/normalize-ui-schema.d.ts
1455
1226
  /**
1456
- * Canonicalize a `/grasshopper/schema` body's key CASING.
1457
- *
1458
- * ## Why this exists
1459
- *
1460
- * Compute serializes the plugin's `UISchema` POCO, whose camelCase wire names
1461
- * live in Newtonsoft `[JsonProperty]` attributes. `Selva.gha` ILRepack-merges
1462
- * Newtonsoft into itself, so those attributes have type
1463
- * `Selva!Newtonsoft.Json.JsonPropertyAttribute`. When the serializer that runs is
1464
- * compute's OWN Newtonsoft assembly, it does not recognize that type as its own
1465
- * attribute, reads no attributes at all, and falls back to raw CLR member names —
1466
- * emitting `Inputs`/`Layout`/`SchemaVersion`.
1467
- *
1468
- * Nothing throws on the wire. Every consumer reads `schema.inputs` as
1469
- * `undefined`, so the definition renders with no inputs, and `schemaVersion`
1470
- * reads `undefined` — which also silently disables the newer-plugin version gate.
1471
- *
1472
- * This is the schema-body counterpart to {@link normalizeInputSchema}, which
1473
- * solves the same split for the `/io` endpoint's param records.
1474
- *
1475
- * ## Why a casing rule, and not a key allowlist
1476
- *
1477
- * The wire names are the CLR names run through Newtonsoft's camelCase strategy,
1478
- * so reproducing that strategy covers every key. An allowlist would have to
1479
- * enumerate every structural key in `UISchema` and drift out of date each time
1480
- * the schema gains a field, failing silently and in exactly this way again.
1481
- *
1482
- * ## What it does NOT touch
1227
+ * Canonicalize a `/grasshopper/schema` body's key casing.
1483
1228
  *
1484
- * `options`, `defaultOptions` and `values` hold USER-AUTHORED keys — dropdown
1485
- * labels like `"Standart Beschichtung"`, `"Use 10 Elements instead"`, `"True"`.
1486
- * Those maps are copied verbatim; only the key naming them is canonicalized.
1487
- * Rewriting their contents is the exact regression that motivated deleting the
1488
- * old global `camelcaseKeys` pass (see `read-field.ts`), which mangled
1489
- * `"Option A"` into `"optionA"` and silently changed what a definition solved
1490
- * with.
1229
+ * Compute serializes the plugin's `UISchema`, whose camelCase wire names live in
1230
+ * Newtonsoft `[JsonProperty]` attributes. `Selva.gha` ILRepack-merges Newtonsoft,
1231
+ * so those attributes are `Selva!Newtonsoft.Json.JsonPropertyAttribute`. When
1232
+ * compute's OWN Newtonsoft serializes, it doesn't recognize them, reads no
1233
+ * attributes, and emits raw CLR names (`Inputs`, `SchemaVersion`). Nothing throws:
1234
+ * `schema.inputs` reads `undefined`, and so does the `schemaVersion` gate.
1491
1235
  *
1492
- * Values are never inspected — only object keys are rewritten.
1236
+ * A casing rule, not a key allowlist: the wire names are the CLR names run
1237
+ * through Newtonsoft's camelCase strategy, so reproducing it covers every key
1238
+ * without drifting each time `UISchema` gains a field.
1493
1239
  */
1494
1240
  /**
1495
- * Returns a schema whose structural keys are camelCase, regardless of which
1496
- * Newtonsoft serialized it. A body that is already camelCase passes through
1497
- * unchanged in shape (it is still rebuilt, so the result is always a fresh
1498
- * object the caller may mutate).
1499
- *
1500
- * Safe to call on any parsed JSON value; non-objects are returned as-is.
1241
+ * Returns a schema whose structural keys are camelCase, whichever Newtonsoft
1242
+ * serialized it. Always a fresh object the caller may mutate; non-objects are
1243
+ * returned as-is.
1501
1244
  */
1502
1245
  export declare function normalizeUISchemaCasing<T>(raw: T): T;
1503
1246
  //#endregion
1504
1247
  //#region src/grasshopper/io/input/input-processors.d.ts
1505
1248
  /**
1506
1249
  * Parse one raw Grasshopper input schema into a typed {@link InputParam}.
1507
- * Validation failures are swallowed and replaced with a safe default; use
1508
- * {@link processInputWithError} to receive them.
1250
+ * A validation failure is swallowed and replaced with a safe default.
1509
1251
  */
1510
1252
  export declare function processInput(rawInput: InputParamSchema): InputParam;
1511
1253
  //#endregion
1512
- //#region src/grasshopper/data-tree/data-tree.d.ts
1254
+ //#region src/grasshopper/io/output/rhino-objects.d.ts
1513
1255
  /**
1514
- * Value types that can be stored in a DataTree
1256
+ * Sentinel a Rhino geometry decode returns when a decode was attempted
1257
+ * and failed hard (a registered decoder or `CommonObject.decode` threw). Carries
1258
+ * the original payload so callers can log or retry. Use
1259
+ * {@link isRhinoDecodeError} to detect it.
1515
1260
  */
1516
- type DataTreeValue = string | number | boolean | object | null;
1517
- /**
1518
- * Simple data item for compute requests (not to be confused with DataItem interface for responses).
1519
- * Note: While TypeScript defines this as string, Rhino Compute accepts boolean/number primitives in JSON.
1520
- */
1521
- interface ComputeDataItem {
1522
- data: string | boolean | number;
1261
+ interface RhinoDecodeError {
1262
+ __decodeError: true;
1263
+ /** The Rhino type name the failed decode was attempted for. */
1264
+ type: string;
1265
+ /** The original (undecoded) payload. */
1266
+ raw: unknown;
1523
1267
  }
1268
+ /** Type guard for the {@link RhinoDecodeError} sentinel. */
1269
+ export declare function isRhinoDecodeError(value: unknown): value is RhinoDecodeError;
1524
1270
  /**
1525
- * InnerTree data structure for compute requests.
1271
+ * Free every rhino3dm WASM object reachable from `value`.
1272
+ *
1273
+ * rhino3dm objects are emscripten bindings — JS GC never reclaims their WASM
1274
+ * heap allocation, so everything decoded from a solve response (`getValues`,
1275
+ * `getValue`) must be deleted explicitly or the heap
1276
+ * grows monotonically across solves (e.g. a UI decoding per slider tick).
1277
+ *
1278
+ * Walks arrays and plain objects recursively; anything exposing a `delete()`
1279
+ * method is treated as a WASM binding and freed (skipped if already deleted).
1280
+ * Safe to call more than once and on values containing no WASM objects.
1526
1281
  */
1527
- type ComputeInnerTreeData = { [path in DataTreePath]: ComputeDataItem[]; };
1282
+ export declare function disposeRhinoObjects(value: unknown): void;
1283
+ //#endregion
1284
+ //#region src/grasshopper/data-tree/data-tree.d.ts
1285
+ type DataTreeValue = string | number | boolean | object | null;
1286
+ /** One input's value for {@link TreeBuilder.fromValues}. */
1287
+ interface TreeValueEntry {
1288
+ paramName: string;
1289
+ /** Matched case-insensitively. */
1290
+ paramType: string;
1291
+ /** A scalar, an array (branch `{0}`), or a branch-path map like `{ '{0;1}': [1, 2] }`. */
1292
+ value: unknown;
1293
+ minimum?: number | null;
1294
+ maximum?: number | null;
1295
+ }
1528
1296
  /**
1529
- * Standalone TreeBuilder class for constructing Grasshopper TreeBuilder structures.
1530
- * Does not depend on RhinoCompute library.
1297
+ * Builds the Grasshopper data trees a solve takes as input.
1531
1298
  *
1532
1299
  * @example
1533
1300
  * ```ts
@@ -1541,247 +1308,70 @@ export declare class TreeBuilder {
1541
1308
  private innerTree;
1542
1309
  private paramName;
1543
1310
  constructor(paramName: string);
1544
- /**
1545
- * Append values to a specific path in the tree.
1546
- *
1547
- * @param path - Array of integers representing the branch path (e.g., [0], [0, 1])
1548
- * @param items - Values to append at this path
1549
- * @returns this for method chaining
1550
- */
1311
+ /** Append values to the branch at `path` (`[0, 1]` is `{0;1}`). */
1551
1312
  append(path: number[], items: DataTreeValue[]): this;
1552
- /**
1553
- * Append a single value to a path.
1554
- *
1555
- * @param path - Branch path
1556
- * @param item - Single value to append
1557
- * @returns this for method chaining
1558
- */
1559
- appendSingle(path: number[], item: DataTreeValue): this;
1560
- /**
1561
- * Set values from a DataTreeDefault structure.
1562
- * Replaces any existing tree data.
1563
- *
1564
- * @param treeData - TreeBuilder structure with path keys like "{0;1}"
1565
- * @returns this for method chaining
1566
- */
1313
+ /** Replace the tree with a branch-path map like `{ '{0;1}': [1, 2] }`. */
1567
1314
  fromDataTreeDefault(treeData: DataTreeDefault): this;
1568
- /**
1569
- * Append flattened values to path [0].
1570
- * Useful for simple flat inputs.
1571
- *
1572
- * @param values - Single value or array of values
1573
- * @returns this for method chaining
1574
- */
1315
+ /** Append a value, or each value of an array, to branch `{0}`. */
1575
1316
  appendFlat(values: DataTreeValue | DataTreeValue[]): this;
1576
- /**
1577
- * Get the flattened list of all values in the tree.
1578
- *
1579
- * @returns Array of all values across all branches
1580
- */
1317
+ /** Every value across all branches. */
1581
1318
  flatten(): DataTreeValue[];
1582
- /**
1583
- * Get all paths in the tree.
1584
- *
1585
- * @returns Array of path strings
1586
- */
1587
- getPaths(): DataTreePath[];
1588
- /**
1589
- * Get values at a specific path.
1590
- *
1591
- * @param path - Path to retrieve values from
1592
- * @returns Array of values or undefined if path doesn't exist
1593
- */
1594
- getPath(path: number[]): DataTreeValue[] | undefined;
1595
- /**
1596
- * Convert to format compatible with Grasshopper Compute API.
1597
- *
1598
- * @returns InnerTree object ready for compute
1599
- */
1319
+ /** The tree in the shape a solve request sends. */
1600
1320
  toComputeFormat(): DataTree;
1601
- /**
1602
- * Get the raw InnerTree data structure.
1603
- *
1604
- * @returns InnerTree data
1605
- */
1606
- getInnerTree(): ComputeInnerTreeData;
1607
- /**
1608
- * Get the parameter name.
1609
- *
1610
- * @returns Parameter name
1611
- */
1612
1321
  getParamName(): string;
1613
1322
  /**
1614
- * Create DataTrees from an array of InputParam definitions.
1615
- * Handles tree access, numeric constraints, and value parsing.
1616
- *
1617
- * @param inputs - Array of input parameter definitions
1618
- * @returns Array of InnerTree instances ready for compute
1619
- *
1620
- * @example
1621
- * ```ts
1622
- * const trees = TreeBuilder.fromInputParams(inputs);
1623
- * ```
1323
+ * One tree per input that has a default, keyed by its nickname. Defaults are coerced and
1324
+ * clamped by the same rules as {@link TreeBuilder.fromValues}.
1624
1325
  */
1625
1326
  static fromInputParams(inputs: InputParam[]): DataTree[];
1626
1327
  /**
1627
- * Create a TreeBuilder from a single InputParam.
1628
- *
1629
- * @param input - Input parameter definition
1630
- * @returns InnerTree ready for compute or undefined if value is invalid
1328
+ * One tree per entry, coercing UI values the way Grasshopper reads them. Number and Integer
1329
+ * items go through the numeric coercion (Integer rounds) and are clamped to
1330
+ * `minimum`/`maximum`; Boolean items also accept `'true'`/`'false'`; every other type passes
1331
+ * through. An item that fails coercion is dropped with a warning. An entry left with no items
1332
+ * is omitted, so Grasshopper uses its own value; `''` is an item, not an empty value.
1631
1333
  */
1632
- static fromInputParam(input: InputParam): DataTree | undefined;
1334
+ static fromValues(entries: TreeValueEntry[]): DataTree[];
1335
+ private static branchesOf;
1336
+ /** `null` means the item was rejected. */
1337
+ private static itemCoercer;
1633
1338
  /**
1634
- * Set or replace a parameter value within a TreeBuilder or InnerTree array.
1635
- *
1636
- * Supports both high-level `DataTree[]` instances and low-level `InnerTree[]` format.
1637
- *
1638
- * **Architecture Note:**
1639
- * - Use with `DataTree[]` when building/modifying before computation
1640
- * - Use with `InnerTree[]` when modifying compute API results
1641
- * - `DataTree` is the high-level builder; `InnerTree` is the Rhino Compute format
1642
- *
1643
- * Copy-on-write: returns a new array; the caller's array is never mutated.
1644
- *
1645
- * @overload For TreeBuilder instances (high-level builder)
1646
- * @param trees - Array of TreeBuilder instances to read from (not mutated)
1647
- * @param paramName - The parameter name to set or replace
1648
- * @param newValue - The new value (scalar, array, or TreeBuilder structure)
1649
- * @returns A new TreeBuilder array with the updated parameter
1650
- *
1651
- * @overload For compiled InnerTree (low-level API format)
1652
- * @param trees - The compiled InnerTree array (typically from `client.solve()`; not mutated)
1653
- * @param paramName - The parameter name to set or replace
1654
- * @param newValue - The new value (scalar, array, or TreeBuilder structure)
1655
- * @returns A new InnerTree array with the updated parameter
1656
- *
1657
- * @example
1658
- * ```ts
1659
- * // With TreeBuilder instances (high-level)
1660
- * let trees = [new TreeBuilder('X'), new TreeBuilder('Y')];
1661
- * trees = TreeBuilder.replaceTreeValue(trees, 'X', 42);
1662
- * const result = await client.solve(definitionUrl,
1663
- * trees.map(t => t.toComputeFormat())
1664
- * );
1665
- * ```
1666
- *
1667
- * @example
1668
- * ```ts
1669
- * // With InnerTree format (low-level, from API)
1670
- * let trees = await client.solve(definitionUrl, initialInputs);
1671
- * trees = TreeBuilder.replaceTreeValue(trees, 'X', 42);
1672
- * trees = TreeBuilder.replaceTreeValue(trees, 'Y', [1, 2, 3]);
1673
- * ```
1339
+ * Set or add `paramName`'s tree to `newValue`: a scalar, an array (branch `{0}`), or a
1340
+ * branch-path map. Copy-on-write: returns a new array and leaves the caller's untouched, so
1341
+ * assign the result.
1674
1342
  */
1675
- static replaceTreeValue(trees: TreeBuilder[], paramName: string, newValue: DataTreeValue): TreeBuilder[];
1676
1343
  static replaceTreeValue(trees: DataTree[], paramName: string, newValue: DataTreeValue): DataTree[];
1344
+ private static buildFromValue;
1677
1345
  /**
1678
- * Build a TreeBuilder from a single value, dispatching on shape:
1679
- * DataTreeDefault structure, array, or scalar.
1346
+ * `paramName`'s whole tree from a solve result's `values`, keyed by branch path (`'{0;1}'`).
1347
+ * `null` when no tree has that param, an empty `Map` when it has no branches. An item without
1348
+ * `data` reads as `null` in place, so indices don't shift.
1680
1349
  */
1681
- private static buildFromValue;
1350
+ static getTree(trees: DataTree[], paramName: string): Map<DataTreePath, DataTreeValue[]> | null;
1682
1351
  /**
1683
- * Extract a value from a TreeBuilder or InnerTree array by parameter name.
1684
- *
1685
- * Automatically unwraps single values for convenience.
1686
- * Works with both high-level `DataTree[]` instances and low-level `InnerTree[]` format.
1687
- *
1688
- * **Architecture Note:**
1689
- * - Use with `DataTree[]` to read builder instances
1690
- * - Use with `InnerTree[]` to read compute API responses
1691
- * - Return behavior is consistent across both formats
1692
- *
1693
- * **Return Value Behavior:**
1694
- * - Single value → unwrapped (returns `5` not `[5]`)
1695
- * - Multiple values → array of values
1696
- * - Not found → `null`
1697
- *
1698
- * @overload For TreeBuilder instances
1699
- * @param trees - Array of TreeBuilder instances to read from
1700
- * @param paramName - The parameter name to retrieve
1701
- * @returns The unwrapped value, array of values, or null if parameter not found
1352
+ * `paramName`'s value when its tree has a single branch: one item unwrapped (`5`, not `[5]`),
1353
+ * several as an array. `null` for a missing param or an empty tree.
1702
1354
  *
1703
- * @overload For compiled InnerTree
1704
- * @param trees - The compiled InnerTree array (typically from `client.solve()`)
1705
- * @param paramName - The parameter name to retrieve
1706
- * @returns The unwrapped value, array of values, or null if parameter not found
1707
- *
1708
- * @example
1709
- * ```ts
1710
- * // With TreeBuilder instances
1711
- * const trees = [new TreeBuilder('X'), new TreeBuilder('Y')];
1712
- * trees[0].appendFlat(42);
1713
- * const x = TreeBuilder.getTreeValue(trees, 'X'); // Returns 42
1714
- * ```
1715
- *
1716
- * @example
1717
- * ```ts
1718
- * // With InnerTree from compute results
1719
- * const result = await client.solve(definitionUrl, inputs);
1720
- * const x = TreeBuilder.getTreeValue(result, 'X'); // Returns 42 (not [42])
1721
- * const points = TreeBuilder.getTreeValue(result, 'Points'); // Returns [point1, point2, ...]
1722
- * ```
1355
+ * @throws {ComputeError} `INVALID_INPUT` when the tree has more than one branch; read those
1356
+ * with {@link TreeBuilder.getTree}.
1723
1357
  */
1724
- static getTreeValue(trees: TreeBuilder[], paramName: string): DataTreeValue | null;
1725
1358
  static getTreeValue(trees: DataTree[], paramName: string): DataTreeValue | null;
1359
+ private static paramNameOf;
1726
1360
  /**
1727
- * Read all values for `paramName` across every branch of the matching builder.
1728
- * Returns null when the builder isn't found.
1729
- */
1730
- private static readFromBuilders;
1731
- /**
1732
- * Read values from the first branch of the matching compiled InnerTree
1733
- * (multi-branch responses are not flattened — current semantics, pinned by
1734
- * the "reads from the first branch path only" test).
1735
- */
1736
- private static readFromDataTrees;
1737
- /**
1738
- * Parse a TreeBuilder path string like "{0;1;2}" into [0, 1, 2].
1739
- * Negative indices ("{-1;2}") and the root path "{}" are valid.
1361
+ * Parse a branch path like `"{0;1;2}"` into `[0, 1, 2]`.
1740
1362
  *
1741
- * @param pathStr - Path string
1742
- * @returns Array of path indices
1743
- * @throws {ComputeError} `INVALID_INPUT` when the path string is not a valid
1744
- * Grasshopper branch path. Malformed keys must never silently collapse to a
1745
- * default branch — two distinct unparseable keys would merge their items
1746
- * into one branch.
1363
+ * @throws {ComputeError} `INVALID_INPUT` for a malformed path, rather than
1364
+ * collapsing it to a default branch where two bad keys would merge.
1747
1365
  */
1748
1366
  static parsePathString(pathStr: string): number[];
1749
- /**
1750
- * Format a path array into TreeBuilder path string format.
1751
- *
1752
- * @param path - Path as number array
1753
- * @returns Formatted path string like "{0;1;2}"
1754
- */
1367
+ /** `[0, 1, 2]` → `"{0;1;2}"`. */
1755
1368
  static formatPathString(path: number[]): DataTreePath;
1756
- /** Apply numeric constraints to all tree values. */
1757
- private applyNumericConstraints;
1758
- /**
1759
- * Serialize a value for compute requests.
1760
- * Preserves booleans and numbers as primitives for proper Grasshopper parameter handling.
1761
- */
1369
+ /** Booleans and numbers stay primitives: Grasshopper reads them typed. */
1762
1370
  private static serializeValue;
1763
- /**
1764
- * Deserialize a value back to its original type.
1765
- * Handles both string-encoded values and primitive values.
1766
- */
1767
1371
  private static deserializeValue;
1768
- /**
1769
- * Check if a value is valid for inclusion in a DataTree.
1770
- */
1771
1372
  private static hasValidValue;
1772
- /**
1773
- * Check if input is numeric type.
1774
- */
1775
- private static isNumericInput;
1776
- /**
1777
- * Process array of values based on input type.
1778
- */
1779
- private static processValues;
1780
- /**
1781
- * Clamp numeric value to constraints.
1782
- */
1783
1373
  private static clampValue;
1784
1374
  }
1785
1375
  //#endregion
1786
- export { type BooleanInputType, type CacheOptions, ComputeServerStats, type DataItem, type DataTree, type DataTreeDefault, type DataTreePath, type DataTreeValue, type DefaultValue, type DefinitionRef, type FileBaseInfo, type FileData, type FileInputType, type GeometryInputType, type GetValuesOptions, type GetValuesResult, GrasshopperClient, type GrasshopperComputeConfig, type GrasshopperComputeResponse, type GrasshopperParsedIO, type GrasshopperParsedIORaw, type GrasshopperRequestSchema, GrasshopperResponseProcessor, type InnerTreeData, type InputParam, type InputParamSchema, type NumericInputType, type OutputParamSchema, type OutputType, type ParsedContext, type ProcessedFile, type RhinoModelUnit, type SchedulerMode, type SchemaEndpointResult, type SelvaEventTarget, type SelvaResponseBlock, type SolveContext, type SolveDefinition, type SolveOptions, type SolveResult, type SolveSchedulerOptions, type TextInputType, type ValueListInputType, downloadFileData, extractFilesFromComputeResponse, isDefinitionRef };
1376
+ export { type BooleanInputType, type CacheOptions, type ColorInputType, ComputeServerStats, type CreateClientOptions, type DataItem, type DataTree, type DataTreeDefault, type DataTreePath, type DataTreeValue, type DefaultValue, type FileInputType, type GeometryInputType, type GetValuesOptions, type GetValuesResult, GrasshopperClient, type GrasshopperComputeConfig, type GrasshopperComputeResponse, type GrasshopperParsedIO, type GrasshopperParsedIORaw, GrasshopperResponseProcessor, type InnerTreeData, type InputParam, type InputParamSchema, type InputParseError, type NumericInputType, type OutputParamSchema, type ParsedContext, type RhinoDecodeError, type RhinoModelUnit, type SchedulerMode, type SchedulerSolveOptions, type SchemaEndpointResult, type SelvaEventTarget, type SelvaResponseBlock, type ServerStats, type ServerVersion, type SolveContext, type SolveDetail, type SolveExecutor, type SolveOptions, type SolveResult, type SolveSchedulerOptions, type TextInputType, type TreeValueEntry, type ValueListInputType };
1787
1377
  //# sourceMappingURL=grasshopper.d.ts.map