From 503eabd9d4d51b2abce3cbd14eb4690c334a8ece Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Efruz=20Y=C4=B1ld=C4=B1r=C4=B1r?=
 <30903352+yldrefruz@users.noreply.github.com>
Date: Wed, 26 Jan 2022 17:16:54 +0300
Subject: [PATCH] Api-Like map save option (#730)

* Added Save Option for Api-like json export.
Will be updated and set to a scheme

* Save Option for Api-like added

* Moved UI of json export to export dialog.
Moved json export to another file named export-json.js

* Added Seperated json export selections
- all JSON : exports all json data.
- minimal JSON : exports json data without cells data.
- cells JSON : exports json data only with pack.cells data.

* More Stable Cell Export...
---
 .gitignore             |   4 +-
 index.html             |   9 +-
 modules/export-json.js | 362 +++++++++++++++++++++++++++++++++++++++++
 modules/save.js        |   2 +
 4 files changed, 375 insertions(+), 2 deletions(-)
 create mode 100644 modules/export-json.js

diff --git a/.gitignore b/.gitignore
index eb169d8d..8cd42a0d 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,4 @@
 .bat
-.vscode
\ No newline at end of file
+.vscode
+.idea
+.idea/Fantasy-Map-Generator.iml
diff --git a/index.html b/index.html
index ebb2b775..871503bf 100644
--- a/index.html
+++ b/index.html
@@ -978,7 +978,7 @@
               <input id="mapName" data-stored="mapName" class="long" autocorrect="off" spellcheck="false" type="text">
             </td>
             <td>
-              <i data-tip="Regenerate map name" onclick="Names.getMapName(true)" class="icon-arrows-cw"></i>
+              <i data-tip="Regenerate map name" onclick="Names.MapName(true)" class="icon-arrows-cw"></i>
             </td>
           </tr>
 
@@ -3607,6 +3607,12 @@
       <p>GeoJSON format is used in GIS tools such as QGIS. Check out <a href="https://github.com/Azgaar/Fantasy-Map-Generator/wiki/GIS-data-export" target="_blank">wiki-page</a> for guidance.</p>
       <p>Generator uses pop-up window to download files. Please ensure your browser does not block popups.</p>
       <p>It's also possible to export map to <i>Foundry VTT</i>, see <a href="https://github.com/Ethck/azgaar-foundry" target="_blank">the module.</a></p>
+      <div style="margin: 1em 0 .3em; font-weight: bold">Export To Json</div>
+      <div>
+        <button onclick="downloadMapDataAPIJson()" data-tip="Downlads Full Data as a .json file. WARNING: This data can be huge. Use at your own risk. You can use other buttons for smaller and filtered files.">all json</button>
+        <button onclick="downloadMapDataMinimalAPIJson()" data-tip="Download a json file that looks like API response. Includes global data and doesn't include cell data. For cell data you must use cells json button">minimal json</button>
+        <button onclick="downloadCellsDataJSON()" data-tip="Download a json file that only contains cell data. And related map info.">cells json</button>
+      </div>
     </div>
 
     <div id="saveMapData" style="display: none" class="dialog">
@@ -4400,6 +4406,7 @@
   <script defer src="modules/load.js"></script>
   <script defer src="modules/cloud.js"></script>
   <script defer src="main.js"></script>
+  <script defer src="modules/export-json.js"></script>
   <script defer src="modules/save.js"></script>
   <script defer src="modules/export.js"></script>
   <script defer src="modules/relief-icons.js"></script>
diff --git a/modules/export-json.js b/modules/export-json.js
new file mode 100644
index 00000000..174a303a
--- /dev/null
+++ b/modules/export-json.js
@@ -0,0 +1,362 @@
+
+/**
+ * Downloads created data of getMapDataAPIJson()
+ * Download all data generated
+ *
+ * @see getMapDataAPIJson
+ */
+function downloadMapDataAPIJson() {
+    if (customization) return tip("Map cannot be saved when edit mode is active, please exit the mode and retry", false, "error");
+    closeDialogs("#alert");
+
+    const mapData = getMapDataAPIJson();
+    const blob = new Blob([mapData], {type: "application/json"});
+    const URL = window.URL.createObjectURL(blob);
+    const link = document.createElement("a");
+    link.download = getFileName() + "All.json";
+    link.href = URL;
+    link.click();
+    tip(`${link.download} is saved. Open "Downloads" screen (CTRL + J) to check`, true, "success", 7000);
+    window.URL.revokeObjectURL(URL);
+}
+
+/**
+ * Downloads created data of getMinimalMapJSONData()
+ * Downloads data without cells
+ *
+ * @see getMinimalMapJSONData
+ */
+function downloadMapDataMinimalAPIJson() {
+    if (customization) return tip("Map cannot be saved when edit mode is active, please exit the mode and retry", false, "error");
+    closeDialogs("#alert");
+
+    const mapData = getMinimalMapJSONData();
+    const blob = new Blob([mapData], {type: "application/json"});
+    const URL = window.URL.createObjectURL(blob);
+    const link = document.createElement("a");
+    link.download = getFileName() + "MinimalDataAPI.json";
+    link.href = URL;
+    link.click();
+    tip(`${link.download} is saved. Open "Downloads" screen (CTRL + J) to check`, true, "success", 7000);
+    window.URL.revokeObjectURL(URL);
+}
+
+
+/**
+ * Downloads created data of getCellJSONData()
+ *
+ * @see getCellJSONData
+ */
+function downloadCellsDataJSON() {
+    if (customization) return tip("Map cannot be saved when edit mode is active, please exit the mode and retry", false, "error");
+    closeDialogs("#alert");
+    const mapData = getCellJSONData();
+    const blob = new Blob([mapData], {type: "application/json"});
+    const URL = window.URL.createObjectURL(blob);
+    const link = document.createElement("a");
+    link.download = getFileName() + "CellsData.json";
+    link.href = URL;
+    link.click();
+    tip(`${link.download} is saved. Open "Downloads" screen (CTRL + J) to check`, true, "success", 7000);
+    window.URL.revokeObjectURL(URL);
+}
+
+
+
+
+
+
+
+
+/**
+ * Gets current loaded map data as a JSON string.
+ * The file contains data looks like:
+ * - info
+ * - settings (because population and other things are related to this)
+ * - coords
+ * - notes
+ * - pack
+ *
+ *  @returns {string} JSONString of loaded and constructed data object
+ */
+function getMapDataAPIJson() {
+
+    TIME && console.time("createMapDataJson");
+
+    const date = new Date();
+    const dateString = date.getFullYear() + "-" + (date.getMonth() + 1) + "-" + date.getDate();
+    const info = {
+        "version": version,
+        "description": "Api-Like Output File Gathered From: azgaar.github.io/Fantasy-map-generator",
+        "creation-date":dateString,
+        "seed" : seed,
+        "mapId":mapId,
+        "mapName" : mapName.value
+    }
+
+    const settings = {
+        "distanceUnit" : distanceUnitInput.value,
+        "distanceScale": distanceScaleInput.value,
+        "areaUnit" : areaUnit.value,
+        "heightUnit" : heightUnit.value,
+        "heightExponent" : heightExponentInput.value,
+        "temperatureScale" : temperatureScale.value,
+        "barSize" : barSizeInput.value,
+        "barLabel" : barLabel.value,
+        "barBackOpacity" : barBackOpacity.value,
+        "barBackColor" : barBackColor.value,
+        "barPosX" : barPosX.value,
+        "barPosY" : barPosY.value,
+        "populationRate" : populationRate,
+        "urbanization" : urbanization,
+        "mapSize" : mapSizeOutput.value,
+        "latitudeO" : latitudeOutput.value,
+        "temperatureEquator" : temperatureEquatorOutput.value,
+        "temperaturePole" : temperaturePoleOutput.value,
+        "prec" : precOutput.value,
+        "options" : options,
+        "mapName" : mapName.value,
+        "hideLabels" : hideLabels.checked,
+        "stylePreset" : stylePreset.value,
+        "rescaleLabels" : rescaleLabels.checked,
+        "urbanDensity" : urbanDensity
+    };
+    const coords = mapCoordinates;
+    const CellConverted = {
+        "i" : Array.from(pack.cells.i),
+        "v" : pack.cells.v,
+        "c" : pack.cells.c,
+        "p" : pack.cells.p,
+        "g" : Array.from(pack.cells.g),
+        "h" : Array.from(pack.cells.h),
+        "area" : Array.from(pack.cells.area),
+        "f" : Array.from(pack.cells.f),
+        "t" : Array.from(pack.cells.t),
+        "haven" : Array.from(pack.cells.haven),
+        "harbor" : Array.from(pack.cells.harbor),
+        "fl" : Array.from(pack.cells.fl),
+        "r" : Array.from(pack.cells.r),
+        "conf" : Array.from(pack.cells.conf),
+        "biome" : Array.from(pack.cells.biome),
+        "s" : Array.from(pack.cells.s),
+        "pop" : Array.from(pack.cells.pop),
+        "culture" : Array.from(pack.cells.culture),
+        "burg" : Array.from(pack.cells.burg),
+        "road" : Array.from(pack.cells.road),
+        "crossroad" : Array.from(pack.cells.crossroad),
+        "state" : Array.from(pack.cells.state),
+        "religion" : Array.from(pack.cells.religion),
+        "province" : Array.from(pack.cells.province)
+    };
+    const cellObjArr = [];
+    {
+        CellConverted.i.forEach(value => {
+            const cellobj = {
+                "i" : value,
+                "v" : CellConverted.v[value],
+                "c" : CellConverted.c[value],
+                "p" : CellConverted.p[value],
+                "g" : CellConverted.g[value],
+                "h" : CellConverted.h[value],
+                "area" : CellConverted.area[value],
+                "f" : CellConverted.f[value],
+                "t" : CellConverted.t[value],
+                "haven" : CellConverted.haven[value],
+                "harbor" : CellConverted.harbor[value],
+                "fl" : CellConverted.fl[value],
+                "r" : CellConverted.r[value],
+                "conf" : CellConverted.conf[value],
+                "biome" : CellConverted.biome[value],
+                "s" : CellConverted.s[value],
+                "pop" : CellConverted.pop[value],
+                "culture" : CellConverted.culture[value],
+                "burg" : CellConverted.burg[value],
+                "road" : CellConverted.road[value],
+                "crossroad" : CellConverted.crossroad[value],
+                "state" : CellConverted.state[value],
+                "religion" : CellConverted.religion[value],
+                "province" : CellConverted.province[value]
+            }
+            cellObjArr.push(cellobj)
+        })
+    };
+    const packs = {
+        "cells": cellObjArr,
+        "features":pack.features,
+        "cultures":pack.cultures,
+        "burgs":pack.burgs,
+        "states":pack.states,
+        "provinces":pack.provinces,
+        "religions":pack.religions,
+        "rivers":pack.rivers,
+        "markers":pack.markers,
+    }
+    const biomes = biomesData;
+
+    const ExportData = {info,settings,coords,packs,biomes,notes,nameBases}
+
+    TIME && console.timeEnd("createMapDataJson");
+    return JSON.stringify(ExportData);
+}
+
+
+/**
+*   For exporting as JSON without pack.cells
+*   This can become handy if user don't want a huge data.
+*   For assigning data to cells user must download cells data with downloadCellsData().
+*
+*   @returns {string} JSONString data of the created object
+*/
+function getMinimalMapJSONData(){
+
+    TIME && console.time("createMapDataMinimalJson");
+
+    const date = new Date();
+    const dateString = date.getFullYear() + "-" + (date.getMonth() + 1) + "-" + date.getDate();
+    const info = {
+        "version": version,
+        "description": "Api-Like Output File Gathered From: azgaar.github.io/Fantasy-map-generator",
+        "creation-date":dateString,
+        "seed" : seed,
+        "mapId":mapId,
+        "mapName" : mapName.value
+    }
+
+    const settings = {
+        "distanceUnit" : distanceUnitInput.value,
+        "distanceScale": distanceScaleInput.value,
+        "areaUnit" : areaUnit.value,
+        "heightUnit" : heightUnit.value,
+        "heightExponent" : heightExponentInput.value,
+        "temperatureScale" : temperatureScale.value,
+        "barSize" : barSizeInput.value,
+        "barLabel" : barLabel.value,
+        "barBackOpacity" : barBackOpacity.value,
+        "barBackColor" : barBackColor.value,
+        "barPosX" : barPosX.value,
+        "barPosY" : barPosY.value,
+        "populationRate" : populationRate,
+        "urbanization" : urbanization,
+        "mapSize" : mapSizeOutput.value,
+        "latitudeO" : latitudeOutput.value,
+        "temperatureEquator" : temperatureEquatorOutput.value,
+        "temperaturePole" : temperaturePoleOutput.value,
+        "prec" : precOutput.value,
+        "options" : options,
+        "mapName" : mapName.value,
+        "hideLabels" : hideLabels.checked,
+        "stylePreset" : stylePreset.value,
+        "rescaleLabels" : rescaleLabels.checked,
+        "urbanDensity" : urbanDensity
+    };
+    const coords = mapCoordinates;
+    const packs = {
+        "features":pack.features,
+        "cultures":pack.cultures,
+        "burgs":pack.burgs,
+        "states":pack.states,
+        "provinces":pack.provinces,
+        "religions":pack.religions,
+        "rivers":pack.rivers,
+        "markers":pack.markers,
+    }
+    const biomes = biomesData;
+
+    const ExportData = {info,settings,coords,packs,biomes,notes,nameBases}
+
+    TIME && console.timeEnd("createMapDataMinimalJson");
+    return JSON.stringify(ExportData);
+}
+/**
+ * Gets data that created with info and pack.cell
+ * This function is created for primarly pack.cell data is too big.
+ * for speeding up the proccess the main data and cell data is seperated as two files.
+ *
+ * exported data look like:
+ *      - info
+ *      - cells
+ *
+ * @see pack
+ * @see getMinimalMapJSONData
+ * @returns {string} The JSONString of pack.cell
+ */
+function getCellJSONData() {
+    TIME && console.time("createMapDataMinimalJson");
+
+    const date = new Date();
+    const dateString = date.getFullYear() + "-" + (date.getMonth() + 1) + "-" + date.getDate();
+    const info = {
+        "version": version,
+        "description": "Api-Like Output File Gathered From: azgaar.github.io/Fantasy-map-generator",
+        "creation-date":dateString,
+        "seed" : seed,
+        "mapId":mapId,
+        "mapName" : mapName.value
+    }
+    const CellConverted = {
+        "i" : Array.from(pack.cells.i),
+        "v" : pack.cells.v,
+        "c" : pack.cells.c,
+        "p" : pack.cells.p,
+        "g" : Array.from(pack.cells.g),
+        "h" : Array.from(pack.cells.h),
+        "area" : Array.from(pack.cells.area),
+        "f" : Array.from(pack.cells.f),
+        "t" : Array.from(pack.cells.t),
+        "haven" : Array.from(pack.cells.haven),
+        "harbor" : Array.from(pack.cells.harbor),
+        "fl" : Array.from(pack.cells.fl),
+        "r" : Array.from(pack.cells.r),
+        "conf" : Array.from(pack.cells.conf),
+        "biome" : Array.from(pack.cells.biome),
+        "s" : Array.from(pack.cells.s),
+        "pop" : Array.from(pack.cells.pop),
+        "culture" : Array.from(pack.cells.culture),
+        "burg" : Array.from(pack.cells.burg),
+        "road" : Array.from(pack.cells.road),
+        "crossroad" : Array.from(pack.cells.crossroad),
+        "state" : Array.from(pack.cells.state),
+        "religion" : Array.from(pack.cells.religion),
+        "province" : Array.from(pack.cells.province)
+    };
+    const cellObjArr = [];
+    {
+        CellConverted.i.forEach(value => {
+            const cellobj = {
+                "i" : value,
+                "v" : CellConverted.v[value],
+                "c" : CellConverted.c[value],
+                "p" : CellConverted.p[value],
+                "g" : CellConverted.g[value],
+                "h" : CellConverted.h[value],
+                "area" : CellConverted.area[value],
+                "f" : CellConverted.f[value],
+                "t" : CellConverted.t[value],
+                "haven" : CellConverted.haven[value],
+                "harbor" : CellConverted.harbor[value],
+                "fl" : CellConverted.fl[value],
+                "r" : CellConverted.r[value],
+                "conf" : CellConverted.conf[value],
+                "biome" : CellConverted.biome[value],
+                "s" : CellConverted.s[value],
+                "pop" : CellConverted.pop[value],
+                "culture" : CellConverted.culture[value],
+                "burg" : CellConverted.burg[value],
+                "road" : CellConverted.road[value],
+                "crossroad" : CellConverted.crossroad[value],
+                "state" : CellConverted.state[value],
+                "religion" : CellConverted.religion[value],
+                "province" : CellConverted.province[value]
+            }
+            cellObjArr.push(cellobj)
+        })
+    };
+    const cells = cellObjArr;
+
+    const ExportData = {info, cells}
+
+    TIME && console.timeEnd("createMapDataMinimalJson");
+    return JSON.stringify(ExportData);
+}
+
+
diff --git a/modules/save.js b/modules/save.js
index 04f3e665..52e1d30e 100644
--- a/modules/save.js
+++ b/modules/save.js
@@ -120,6 +120,7 @@ function getMapData() {
   return mapData;
 }
 
+
 // Download .map file
 function dowloadMap() {
   if (customization) return tip("Map cannot be saved when edit mode is active, please exit the mode and retry", false, "error");
@@ -136,6 +137,7 @@ function dowloadMap() {
   window.URL.revokeObjectURL(URL);
 }
 
+
 async function saveToDropbox() {
   if (customization) return tip("Map cannot be saved when edit mode is active, please exit the mode and retry", false, "error");
   closeDialogs("#alert");