Feat: Data download for debugging (#198)

Co-authored-by: Matt Potts <matt@@mrpotts.uk>

Author: misterpotts

docs/_config.yml

@@ -1,4 +1,4 @@
-title: Fabricate 0.10.4
+title: Fabricate 0.10.5
 email: matt@misterpotts.uk
 description: >- 
   End user documentation for the Foundry Virtual Tabletop (VTT) Module, "Fabricate".

docs/api/index.md

@@ -144,6 +144,12 @@ interface FabricateAPI {
      */
     export(craftingSystemId: string): Promise<FabricateExportModel>;
 
+    /**
+     * Downloads a copy of all Fabricate data as a JSON file. This function is used for debugging and troubleshooting.
+     * If you want to export data from Fabricate for use in another Foundry VTT world, use {@link FabricateAPI#export}
+     */
+    downloadData(): void;
+
 }
 ```
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "fabricate",
-  "version": "0.10.4",
+  "version": "0.10.5",
   "description": "A system-agnostic, flexible crafting module for FoundryVT",
   "main": "index.js",
   "type": "module",

src/scripts/api/FabricateAPI.ts

@@ -211,6 +211,12 @@ interface FabricateAPI {
      */
     export(craftingSystemId: string): Promise<FabricateExportModel>;
 
+    /**
+     * Downloads a copy of all Fabricate data as a JSON file. This function is used for debugging and troubleshooting.
+     * If you want to export data from Fabricate for use in another Foundry VTT world, use {@link FabricateAPI#export}
+     */
+    downloadData(): void;
+
 }
 
 export { FabricateAPI }
@@ -259,6 +265,18 @@ class DefaultFabricateAPI implements FabricateAPI {
         this.settingMigrationAPI = settingMigrationAPI;
     }
 
+    downloadData(): void {
+        const allFabricateSettingValues = Array.from(game.settings.storage.get("world").values())
+            .filter((setting: any) => setting.key.search(new RegExp("fabricate", "i")) >= 0);
+        const fileContents = JSON.stringify(allFabricateSettingValues, null, 2);
+        const dateTime = new Date();
+        const postfix = dateTime.toISOString()
+            .replace(/:\s*/g, "-")
+            .replace(".", "-");
+        const fileName = `fabricate-data-extract-${postfix}.json`;
+        saveDataToFile(fileContents, "application/json", fileName);
+    }
+
     get documentManager(): DocumentManager {
         return this._documentManager;
     }
@@ -448,7 +466,6 @@ class DefaultFabricateAPI implements FabricateAPI {
 
     async import(importData: FabricateExportModel): Promise<CraftingSystemData> {
 
-
         importData = this.upgradeV1ImportData(importData);
         await this.validateImportData(importData);