@spidunno/desmos-types 1.13.7 → 1.13.9

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.7
+npm install --save-dev @spidunno/desmos-types@~1.13.9
 ```
 
 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.7`), not npm's default caret (`^`), so you only
+are fixes to the types. Use a tilde range (`~1.13.9`), not npm's default caret (`^`), so you only
 get type fixes for the API version you load.
 
 ## Usage
@@ -366,10 +366,36 @@ g.events.unobserveEvent('.myMod');
 Moving the viewport this way doesn't add an undo step. Call
 `g.debounceUserRequestedViewportChange()` afterwards if you want one.
 
+### Which Desmos build a version matches
+
+Desmos updates the v1.13 bundle without changing its version, so the internal types are
+regenerated automatically whenever `Desmos.commit` changes, and each regeneration is published as a
+new patch version. The `desmos` field in `package.json` records the commit a version was generated
+from, and [CHANGELOG.md](CHANGELOG.md) lists every version's commit and what changed in the
+internals:
+
+```sh
+npm view @spidunno/desmos-types@1.13.9 desmos   # { version: 'v1.13-prerelease', commit: '…' }
+```
+
+```js
+// is the live bundle the one the installed types were generated from?
+console.log(Desmos.commit);
+```
+
 ### Regenerating for a new bundle
 
 ```sh
 curl -o calculator.js "https://www.desmos.com/api/v1.13/calculator.js?apiKey=YOUR_API_KEY"
+npm run update:bundle -- calculator.js
+```
+
+`update:bundle` does the whole update: it reads the bundle's commit (stopping if it's the one in
+`package.json`, unless you pass `--force`), runs both generators, runs `npm test`, bumps the patch
+version, records the commit and adds a CHANGELOG entry. It doesn't commit or publish. The
+generators can also be run on their own:
+
+```sh
 npm run generate:internals -- calculator.js
 npm run snapshot:sketches -- calculator.js
 npm test

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>;

package/internals/generated/actions.d.ts

@@ -1,6 +1,6 @@
 // AUTO-GENERATED by scripts/extract-internals.cjs. Do not edit by hand:
 // put precise types in the hand-written files in internals/ instead.
-// Source: Desmos v1.13-prerelease (commit c2616b6762c586165f75e322fbc6c7b6ab56b394).
+// Source: Desmos v1.13-prerelease (commit 7f0bcd732b59def63b568d6e527e004258e53995).
 // Actions accepted by each dispatch domain, from static analysis.
 declare namespace Desmos.Internals.Generated {
   /**

package/internals/generated/objects.d.ts

@@ -1,6 +1,6 @@
 // AUTO-GENERATED by scripts/extract-internals.cjs. Do not edit by hand:
 // put precise types in the hand-written files in internals/ instead.
-// Source: Desmos v1.13-prerelease (commit c2616b6762c586165f75e322fbc6c7b6ab56b394).
+// Source: Desmos v1.13-prerelease (commit 7f0bcd732b59def63b568d6e527e004258e53995).
 // Runtime shapes of internal objects.
 declare namespace Desmos.Internals.Generated {
   interface Controller {

package/internals/generated/views.d.ts

@@ -1,6 +1,6 @@
 // AUTO-GENERATED by scripts/extract-internals.cjs. Do not edit by hand:
 // put precise types in the hand-written files in internals/ instead.
-// Source: Desmos v1.13-prerelease (commit c2616b6762c586165f75e322fbc6c7b6ab56b394).
+// Source: Desmos v1.13-prerelease (commit 7f0bcd732b59def63b568d6e527e004258e53995).
 // Props and instance members of the views on Private.Fragile.
 declare namespace Desmos.Internals.Generated {
   /**