react-visualizer 4.0.0 → 4.1.0

package/bin/makeVisualizerPage.js

@@ -13,6 +13,9 @@ const { values: args } = parseArgs({
     fallbackVersion: {
       type: 'string',
     },
+    loadversion: {
+      type: 'string',
+    },
     cdn: {
       type: 'string',
     },
@@ -44,6 +47,13 @@ Options:
   --fallbackVersion <string>
       Visualizer version to use if it is not specified in the search url and not loaded from the view
 
+  --loadversion <'none' | 'exact' | 'major-latest'>
+      What version to load based on the version referenced by the view.
+        'exact': load exactly the version of the view.
+        'latest-major': use the major version of the view, but its latest version. 
+        'none': do not use the view to decide which version to load.
+      Default: 'none'
+      
   --cdn <string>
       CDN base URL for visualizer assets
 
@@ -51,8 +61,10 @@ Options:
       Output file path to which to write the html file
       Default: visualizer.html
 
-  --queryType <string>
-      Where the search parameters should be read from: 'fragment' or 'query'
+  --queryType <'fragment' | 'query'>
+      Where the search parameters should be read from.
+        'query': Uses the regular query string of the URL
+        'fragment': Uses the fragment identifier (aka hash) of the URL as query string
       Default: query
 `);
 }

package/dist/makeVisualizerPage.js

@@ -5,8 +5,11 @@ function makeVisualizerPage(options = {}) {
     cdn = "https://www.lactame.com/visualizer",
     fallbackVersion = "latest",
     queryType = "fragment",
+    loadversion = "none",
     scripts = []
   } = options;
+  validateQueryType(queryType);
+  validateLoadVersion(loadversion);
   const scriptsStr = scripts.reduce(function(value, script) {
     if (script.url) {
       return value + `<script src="${script.url}"><\/script>
@@ -18,6 +21,22 @@ function makeVisualizerPage(options = {}) {
       throw new Error("script must have url or content");
     }
   }, "");
-  return template.replaceAll("{{ cdn }}", cdn).replaceAll("{{ fallbackVersion }}", fallbackVersion).replace("{{ scripts }}", scriptsStr).replace("{{ queryType }}", queryType);
+  return template.replaceAll("{{ cdn }}", cdn).replaceAll("{{ fallbackVersion }}", fallbackVersion).replace("{{ scripts }}", scriptsStr).replace("{{ queryType }}", queryType).replace("{{ loadversion }}", loadversion);
 }
 module.exports = makeVisualizerPage;
+const validLoadversion = ["none", "exact", "latest-major"];
+function validateLoadVersion(loadversion) {
+  if (!validLoadversion.includes(loadversion)) {
+    throw new Error(
+      `Invalid "loadversion" parameter: ${loadversion}. Allowed values: ${validLoadversion.join(", ")}`
+    );
+  }
+}
+const validQueryType = ["fragment", "query"];
+function validateQueryType(queryType) {
+  if (!validQueryType.includes(queryType)) {
+    throw new Error(
+      `Invalid "queryType" parameter: ${queryType}, allowed values: ${validQueryType.join(", ")}`
+    );
+  }
+}

package/dist/visualizerTemplate.js

@@ -36,13 +36,13 @@ window.onload = function () {
   const search = new URLSearchParams(query.startsWith("#") ? query.slice(1) : query);
   const url = search.get('viewURL');
   const v = search.get('v');
-  const loadversion = search.get('loadversion');
+  const loadversion = search.get('loadversion') || '{{ loadversion }}';
   if (v) {
     addVisualizer(checkVersion(v));
     return;
   }
 
-  if (!loadversion || !url) {
+  if (loadversion === 'none' || !url) {
     addVisualizer('{{ fallbackVersion }}');
   } else {
     const viewReg = new RegExp('/view.json$');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-visualizer",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "description": "The visualizer in a react component",
   "main": "dist/index.js",
   "scripts": {