Merge branch 'v4.0' of github.com:plotly/plotly.js into update-server-config

Author: marthacryan

.github/actions/setup-workspace/action.yml

@@ -1,17 +1,12 @@
 name: 'Setup Workspace'
 description: 'Setup Node.js, install dependencies, and download build artifacts'
 
-inputs:
-  node-version:
-    description: 'Node.js version to use'
-    default: '18'
-
 runs:
   using: 'composite'
   steps:
     - uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6
       with:
-        node-version: ${{ inputs.node-version }}
+        node-version-file: '.nvmrc'
         cache: 'npm'
 
     - name: Install dependencies

.github/workflows/ci.yml

@@ -14,9 +14,6 @@ concurrency:
   group: ci-${{ github.event.pull_request.number || github.ref }}
   cancel-in-progress: true
 
-env:
-  NODE_VERSION: '18'
-
 jobs:
   detect-changes:
     runs-on: ubuntu-latest
@@ -60,7 +57,7 @@ jobs:
 
       - uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6
         with:
-          node-version: ${{ env.NODE_VERSION }}
+          node-version-file: '.nvmrc'
           cache: 'npm'
 
       - name: Install dependencies
@@ -270,9 +267,9 @@ jobs:
           chrome-version: 'stable'
 
       - name: Run noCI tests
-        uses: coactions/setup-xvfb@b6b4fcfb9f5a895edadc3bc76318fae0ac17c8b3 # v1
+        uses: ./.github/actions/run-xvfb
         with:
-          run: ./tasks/noci_test.sh jasmine
+          run: npm run test-jasmine -- --tags=noCI,noCIdep --nowatch
 
   # ============================================================
   # Image baseline generation and comparison
@@ -579,6 +576,26 @@ jobs:
       - name: Run syntax tests on source files
         run: .github/scripts/test.sh source-syntax
 
+  typecheck:
+    needs: install-and-cibuild
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
+      - uses: ./.github/actions/setup-workspace
+
+      - name: Type-check TypeScript sources
+        run: npm run typecheck
+
+  generated-types-drift:
+    needs: install-and-cibuild
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
+      - uses: ./.github/actions/setup-workspace
+
+      - name: Verify generated types are in sync with schema
+        run: npm run schema-typegen-diff-check
+
   # ============================================================
   # Standalone jobs (no dependencies on install-and-cibuild)
   # ============================================================
@@ -593,7 +610,7 @@ jobs:
 
       - uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6
         with:
-          node-version: ${{ env.NODE_VERSION }}
+          node-version-file: '.nvmrc'
           cache: 'npm'
 
       - name: Set up build environment
@@ -624,7 +641,7 @@ jobs:
 
       - uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6
         with:
-          node-version: ${{ env.NODE_VERSION }}
+          node-version-file: '.nvmrc'
           cache: 'npm'
 
       - name: Set up build environment

.github/workflows/publish-dist.yml

@@ -25,7 +25,7 @@ jobs:
 
       - uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6
         with:
-          node-version: '22.14.0'
+          node-version-file: '.nvmrc'
           cache: 'npm'
 
       - name: Set up build environment

.gitignore

@@ -7,6 +7,9 @@ build/*
 dist/*.LICENSE.txt
 dist/*.css
 
+# Ignore local dev mocks/baselines
+test/image/**/dev_*.*
+
 npm-debug.log*
 *.sublime*
 *~
@@ -16,3 +19,4 @@ tags
 !.github/
 !.gitignore
 !.npmignore
+!.nvmrc

.nvmrc

@@ -0,0 +1 @@
+22.23.0

CONTRIBUTING.md

@@ -78,7 +78,7 @@ We use the following [labels](https://github.com/plotly/plotly.js/labels) to tra
 #### Prerequisites
 
 - git
-- [node.js](https://nodejs.org/en/). We recommend using node.js v18.x.
+- [node.js](https://nodejs.org/en/). We recommend using node.js v22.x.
   Upgrading and managing node versions can be easily done using
   [`nvm`](https://github.com/nvm-sh/nvm) or its Windows alternatives.
 - [`npm`](https://www.npmjs.com/) v10.x and up to ensure that the
@@ -405,8 +405,10 @@ All traces modules set:
   This object is used to generate the plot-schema JSON.
 - `_module.supplyDefaults`: Takes in input trace settings and coerces them into "full" settings
   under `gd._fullData`. This one is called during the figure-wide `Plots.supplyDefaults` routine.
-  Note that the `supplyDefaults` method performance should scale with the number of attributes (**not** the
-  number of data points - so it should not loop over any data arrays).
+  As a rule, `supplyDefaults` performance should scale with the number of attributes rather than
+  the number of data points, so avoid looping over data arrays in this function. That being said,
+  there are a few exceptions to this rule due to technical requirements (`fitbounds` on map subplots).
+  The same guidance applies to `_module.supplyLayoutDefaults`.
 - `_module.calc`: Converts inputs data into "calculated" (or sanitized) data. This one is called during
   the figure-wide `Plots.doCalcdata` routine. The `calc` method is allowed to
   scale with the number of data points and is in general more costly than `supplyDefaults`.
@@ -432,7 +434,7 @@ Other methods used by some trace modules:
   selections.
 - `_module.convert`: Sometimes separated from `_module.plot` or `_module.calc` to convert the
   plotly.js settings to another framework e.g. to `gl-plot3d` for `gl3d` traces, to
-  `mapbox-gl` for `mapbox` traces. This split can make the logic easier to test.
+  `maplibre-gl` for `map` traces. This split can make the logic easier to test.
   If you make a `convert`, you should call it from either `calc` or `plot`.
 
 ## Coding style

CUSTOM_BUNDLE.md

@@ -5,8 +5,9 @@ Make sure you have the versions of node/npm that's recommended:
 - plotly.js before 2.5: Node 12/npm 6
 - plotly.js from 2.5: Node 16/npm 8
 - plotly.js from 2.35: Node 18/npm 10
+- plotly.js from 4.0: Node 22/npm 10
 
-To download a specific node version look [here](https://nodejs.org/en/download/package-manager).
+To download a specific node version look [here](https://nodejs.org/en/download).
 
 Note: For CI, it's faster to do `git clone --depth 1` to only get one commit.
 

README.md

@@ -95,17 +95,23 @@ While non-minified source files may contain characters outside UTF-8, it is reco
 > Please note that as of v2 the "plotly-latest" outputs (e.g. https://cdn.plot.ly/plotly-latest.min.js) will no longer be updated on the CDN, and will stay at the last v1 patch v1.58.5. Therefore, to use the CDN with plotly.js v2 and higher, you must specify an exact plotly.js version.
 
 ### MathJax
-You can load either version two or version three of MathJax files. For example:
+plotly.js supports using MathJax v3 or v4 to render mathematical expressions within plots.
+
+MathJax is not included in the plotly.js bundle, so it must be loaded separately as a script on the webpage.
+
+For MathJax v4:
 ```html
-<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js?config=TeX-AMS-MML_SVG.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/mathjax@4.1.3/tex-svg.js"></script>
 ```
 
+For MathJax v3:
 ```html
 <script src="https://cdn.jsdelivr.net/npm/mathjax@3.2.2/es5/tex-svg.js"></script>
 ```
 
-> When using MathJax version 3, it is also possible to use `chtml` output on the other parts of the page in addition to `svg` output for the plotly graph.
-Please refer to `devtools/test_dashboard/index-mathjax3chtml.html` to see an example.
+When MathJax is available, any string contained within `$..$` signs will be rendered using the MathJax engine. This applies to plot titles, axis labels, tick label text, and annotations.
+
+plotly.js's use of the MathJax `svg` renderer should not prevent using other MathJax renderers elsewhere on the page, nor will it affect the global MathJax config. See `devtools/test_dashboard/index-mathjax3chtml.html` for an example of a webpage which uses the MathJax `chtml` renderer in the main page, and also displays Plotly charts containing MathJax equations rendered as `svg`.
 
 ### Need to have several WebGL graphs on a page?
 You may simply load the [virtual-webgl](https://github.com/greggman/virtual-webgl) script for WebGL 1 (not WebGL 2) before loading other scripts.

devtools/test_dashboard/devtools.js

@@ -4,7 +4,6 @@
 
 var Fuse = require('fuse.js/dist/fuse.common.js');
 var mocks = require('../../build/test_dashboard_mocks.json');
-var credentials = require('../../build/credentials.json');
 var Lib = require('../../src/lib');
 
 require('./perf');
@@ -18,9 +17,6 @@ var Tabs = {
 
             // use local topojson files
             topojsonURL: "../../topojson/dist",
-            // register mapbox access token
-            // run `npm run preset` if you haven't yet
-            mapboxAccessToken: credentials.MAPBOX_ACCESS_TOKEN,
 
             // show all logs in console
             logging: 2

devtools/test_dashboard/index-mathjax3.html

@@ -17,7 +17,7 @@
 
   <section id="mocks-list"></section>
 
-  <p id="pWithMathJax">MathJax $V^3$ with $svg$ output on the page as well as plotly graphs</p>
+  <p>MathJax \(V^3\) with \(svg\) output on the page as well as plotly graphs</p>
   <h4>no MathJax: Apple: $2, Orange: $3</h4>
 
   <div id="plots">
@@ -27,18 +27,12 @@ <h4>no MathJax: Apple: $2, Orange: $3</h4>
 
   <script>
     window.MathJax = {
-      startup: {
-        elements: [
-          document.getElementById('pWithMathJax')
-        ],
-        // typeset: false,
-        // in case the elements array is empty one could disable startup typeset
-        // https://docs.mathjax.org/en/latest/options/startup/startup.html#the-configuration-block
-      }
+      // MathJax config options can be set here, although
+      // none are strictly needed for this page.
     };
   </script>
   <script src="../../node_modules/@plotly/mathjax-v3/es5/tex-svg.js"></script>
-  <script charset="utf-8" id="source" src="../../build/plotly.js" type="module"></script>
+  <script charset="utf-8" id="source" src="../../build/plotly.js"></script>
   <script charset="utf-8" src="../../build/test_dashboard-bundle.js"></script>
 </body>
 </html>