@spidunno/desmos-types 1.13.6 → 1.13.8

package/README.md

@@ -6,11 +6,11 @@ the graphing calculator, geometry tool, 3D calculator, and the four-function and
 ## Install
 
 ```sh
-npm install --save-dev @spidunno/desmos-types@~1.13.6
+npm install --save-dev @spidunno/desmos-types@~1.13.8
 ```
 
 The package's major and minor version match the Desmos API version it describes; patch releases
-are fixes to the types. Use a tilde range (`~1.13.6`), not npm's default caret (`^`), so you only
+are fixes to the types. Use a tilde range (`~1.13.8`), not npm's default caret (`^`), so you only
 get type fixes for the API version you load.
 
 ## Usage
@@ -124,7 +124,8 @@ members are typed separately (see [Internals](#internals)). `Desmos.TestInternal
 - `Desmos.Colors.GREEN` is `#348543`, not the documented `#388c46`. The palette still cycles through `#388c46` for new items.
 - `asyncScreenshot()` without a `mode` uses `'preserveX'` when the axes are square and `'stretch'` otherwise, not the documented `'contain'`.
 - On `Calculator3D`, `asyncScreenshot()` always throws, and `mathToPixels` / `pixelsToMath` are `undefined`. The types leave all three out.
-- `substitutions`, `regressionTemplates`, `intervalComprehensions` and `recursion` are accepted as options but never appear on `calculator.settings`.
+- The calculator accepts many options the docs don't mention, such as `complex`, `restrictGridToFirstQuadrant` and `advancedStyling`. All of them are typed (as `UndocumentedGraphingCalculatorConfig`, `InternalGraphingCalculatorOptions` and the undocumented members of `GraphSettings`), along with the deprecated aliases (`menus`, `solutions`, ...), which are marked `@deprecated`.
+- `substitutions`, `regressionTemplates`, `intervalComprehensions`, `recursion` and the internal and deprecated options are accepted but never appear on `calculator.settings`.
 - `setMathBounds()` also accepts `{ xmin, xmax, ymin, ymax }`, plus `zmin` / `zmax` on 3D.
 
 ## Internals

package/internals/controller.d.ts

@@ -225,7 +225,63 @@ declare namespace Desmos.Internals {
     controller: Controller;
   }
 
-  interface Grapher3D extends Generated.Grapher3D {}
+  /** A point in 3D math coordinates. */
+  interface Point3D {
+    x: number;
+    y: number;
+    z: number;
+  }
+
+  /** What the 3D grapher's worker found under the mouse. */
+  interface PickResult3D {
+    /** Where the ray from the mouse hit, in math coordinates. */
+    point: Point3D;
+  }
+
+  /** `grapher3d.controls`: mouse, touch and keyboard handling for the 3D graph paper. */
+  interface Grapher3DControls {
+    grapher3d: Grapher3D;
+    /** The graph paper element (`grapher3d.elt`). Desmos's wheel handler is attached here. */
+    domElement: HTMLElement;
+    /** -1 when idle, 0 while rotating with the mouse. */
+    state: -1 | 0;
+    /** Rotation speed while the graph is spinning, 0 when it isn't. */
+    speed3D: number;
+    /**
+     * `performance.now()` of the last wheel zoom, or 0. The tick calls
+     * `grapher3d.endZoom()` and resets it 100ms after the last one.
+     */
+    lastWheelEventTime: number;
+    /** Whether zoom and pan are disabled. */
+    isLocked(): boolean;
+    /** Whether rotating is disabled (the user lock, or the page is pinch zoomed). */
+    isRotationLocked(): boolean;
+    /** Set the viewport and commit it to history after a short delay. */
+    updateViewport(viewport: ViewportObject): void;
+  }
+
+  /** `grapher3d.viewportController`. */
+  interface Grapher3DViewportController {
+    getViewport(): Viewport;
+    /**
+     * Jump to a viewport. Invalid axes keep their current bounds, and each
+     * axis is clamped to a width between 1.34e-4 × its largest bound (at
+     * least 1.34e-4) and 134000, within ±67000.
+     */
+    setCurrentViewport(viewport: ViewportObject): void;
+  }
+
+  interface Grapher3D extends Generated.Grapher3D {
+    controls: Grapher3DControls;
+    viewportController: Grapher3DViewportController;
+    /** The 3D viewport always has z bounds (Desmos fills in defaults). */
+    getProjection(): { viewport: Viewport & { zmin: number; zmax: number } };
+    /**
+     * What's under the mouse, used as the center when zooming in with the
+     * scroll wheel. Undefined while the graph is spinning, or over nothing.
+     */
+    getZoomScrollWheelPickResult(): PickResult3D | null | undefined;
+  }
 
   interface Evaluator extends Generated.Evaluator {}
 

package/internals/fragile.d.ts

@@ -168,6 +168,17 @@ declare namespace Desmos.Internals {
 
   type FragileViewClass<P, Members> = DCGView.ViewClass<P, FragileView<P, Members>>;
 
+  /** Static helpers on `Fragile.MathquillView`. */
+  interface MathquillViewStatics {
+    /** The math field containing `document.activeElement`, if it's in one. */
+    getFocusedMathquill(): Desmos.MathQuillMathField | undefined;
+    /**
+     * Apply an arrow key to a math field. Returns true if the cursor was
+     * already at that edge (so focus should move to the next item).
+     */
+    applyArrowKeyAndReturnIfWasAtBounds(mathField: Desmos.MathQuillMathField, key: string, event: KeyboardEvent): boolean;
+  }
+
   /** The view classes on `Private.Fragile`. */
   interface FragileViews {
     ExpressionView: FragileViewClass<ExpressionViewProps, Generated.ExpressionViewMembers>;
@@ -176,7 +187,7 @@ declare namespace Desmos.Internals {
     ExpressionOptionsMenuView: FragileViewClass<ExpressionOptionsMenuViewProps, Generated.ExpressionOptionsMenuViewMembers>;
     ImageIconView: FragileViewClass<ImageIconViewProps, Generated.ImageIconViewMembers>;
     PromptSliderView: FragileViewClass<PromptSliderViewProps, Generated.PromptSliderViewMembers>;
-    MathquillView: FragileViewClass<MathquillViewProps, Generated.MathquillViewMembers>;
+    MathquillView: FragileViewClass<MathquillViewProps, Generated.MathquillViewMembers> & MathquillViewStatics;
     InlineMathInputView: FragileViewClass<InlineMathInputViewProps, Generated.InlineMathInputViewMembers>;
     StaticMathquillView: FragileViewClass<StaticMathquillViewProps, Generated.StaticMathquillViewMembers>;
     Checkbox: FragileViewClass<CheckboxProps, Generated.CheckboxMembers>;