@jtff/miztemplate-lib 2.1.7 → 3.0.0-rc1

package/lua/src/200-mission.lua

@@ -0,0 +1,3 @@
+--script for specific mission code
+--you can start code here
+--let's go crazy !

package/package.json

@@ -1,12 +1,14 @@
 {
   "name": "@jtff/miztemplate-lib",
-  "version": "2.1.7",
+  "version": "3.0.0-rc1",
   "description": "JTFF mission template library",
   "main": "index.js",
   "files": [
     "index.js",
     "scripts",
-    "lib"
+    "lib",
+    "lua",
+    "resources"
   ],
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
@@ -28,13 +30,12 @@
   },
   "homepage": "https://github.com/JTFF-mission-scripts/miztemplate-lib#readme",
   "dependencies": {
-    "fs": "^0.0.1-security",
     "ftp": "^0.3.10",
     "googleapis": "^92.0.0",
-    "jszip": "^3.7.1",
-    "lua-json": "^1.0.0",
+    "jszip": "^3.10.1",
+    "lua-json": "^1.0.1",
     "path": "^0.12.7",
     "prompt": "^1.3.0",
-    "util": "^0.12.4"
+    "util": "^0.12.5"
   }
 }

package/scripts/build.js

@@ -1,9 +1,10 @@
 const fs = require("fs");
+const mizlib = require("./lib/mizlib.js");
 
 function build(jtffci) {
     fs.mkdirSync(jtffci.config.general.missionFolder, { recursive: true });
     jtffci.config.missionTemplates.forEach(async missionTemplate => {
-        await jtffci.mizUpdate([
+        await mizlib.mizUpdate([
             missionTemplate.prefix,
             '_',
             missionTemplate.theatre,

package/scripts/inject-scripts.js

@@ -1,14 +1,17 @@
-const fs = require("fs");
+const fs = require('fs');
 const path = require("path");
 const prompt = require('prompt');
+const mizlib = require("./lib/mizlib.js");
 
 function injectScripts(jtffci, env_mission) {
+    // create mission folder in dist (general) folder
     fs.mkdirSync(jtffci.config.general.missionFolder, { recursive: true });
     if (fs.existsSync([
         jtffci.config.general.missionFolder,
         "/",
         path.parse(env_mission).name
     ].join(""))) {
+        // if there is a specific mission folder (dist/env_mission), clean it
         fs.rmSync([
                 jtffci.config.general.missionFolder,
                 "/",
@@ -17,6 +20,7 @@ function injectScripts(jtffci, env_mission) {
             { recursive: true }
         );
     }
+    // create a settings folder
     fs.mkdirSync([
             jtffci.config.general.missionFolder,
             "/",
@@ -25,6 +29,7 @@ function injectScripts(jtffci, env_mission) {
         ].join(""),
         { recursive: true }
     );
+    // create a src folder
     fs.mkdirSync([
             jtffci.config.general.missionFolder,
             "/",
@@ -34,7 +39,6 @@ function injectScripts(jtffci, env_mission) {
         { recursive: true }
     );
 
-
     const prompt_properties = [
         {
             name: 'inject_tankers',
@@ -116,59 +120,60 @@ function injectScripts(jtffci, env_mission) {
         console.log('  inject_mission specific scripts: ' + (/^y\b|o\b|yes\b|oui\b/i).test(prompt_result.inject_mission));
         console.log('  inject_radio_presets scripts: ' + (/^y\b|o\b|yes\b|oui\b/i).test(prompt_result.inject_radio_presets));
 
-        const zip = await jtffci.mizOpen(env_mission);
-        jtffci.mizUpdateSrcLuaFiles(zip);
-        jtffci.mizUpdateLibLuaFiles(zip);
-        // injection des fichiers son Generaux
-        // const generalSoundFolder = zip.remove('General').folder('General');
-        // await jtffci.addFilesToZip(generalSoundFolder, 'resources/sounds/General', fs.readdirSync('resources/sounds/General'));
-        // injection des fichiers son Misc
-        const generalSoundFolder = zip.remove('Misc').folder('Misc');
-        await jtffci.addFilesToZip(generalSoundFolder, 'resources/sounds/Misc', fs.readdirSync('resources/sounds/Misc'));
-
-        const inputZip = await zip.generateAsync({
-            type: 'nodebuffer',
-            streamFiles: true,
-            compression: "DEFLATE",
-            compressionOptions: {
-                level: 9
-            }
-        });
-        fs.writeFileSync([
-                jtffci.config.general.missionFolder,
-                "/",
-                path.parse(env_mission).name,
-                "/",
-                path.basename(env_mission)
-            ].join(""),
-            inputZip);
-
-
-        const missionObject = await jtffci.getMissionObjectFromMiz(
-            [
-                jtffci.config.general.missionFolder,
-                "/",
-                path.parse(env_mission).name,
-                "/",
-                path.basename(env_mission)
-            ].join("")
-        );
-        let mapResourceObject = await jtffci.getMapResourceObjectFromMiz(
-            [
-                jtffci.config.general.missionFolder,
-                "/",
-                path.parse(env_mission).name,
-                "/",
-                path.basename(env_mission)
-            ].join("")
-        );
+        // open the miz input file for reading
+        const mizObject = await mizlib.getZipObjectFromMizPath(env_mission);
+        // inject all the lua files in the src folder into the source zip object
+        mizlib.injectLuaFilesFromFolderIntoZipObject(mizObject, "src");
+        // inject all the lua files in the lib folder into the source zip object
+        mizlib.injectLuaFilesFromFolderIntoZipObject(mizObject, "lib");
+        // injection des fichiers son Généraux si repertoire resources/sounds/General present
+        await mizlib.mizUpdateSingleSoundFolder(mizObject, 'General');
+        // On fait une sauvegarde dans le folder de destination
+        // fs.writeFileSync([
+        //         jtffci.config.general.missionFolder,
+        //         "/",
+        //         path.parse(env_mission).name,
+        //         "/",
+        //         path.basename(env_mission)
+        //     ].join(""),
+        //     await mizObject.generateAsync({
+        //         type: 'nodebuffer',
+        //         streamFiles: true,
+        //         compression: "DEFLATE",
+        //         compressionOptions: {
+        //             level: 9
+        //         }
+        //     })
+        // );
+        // injection des fichiers son Misc si repertoire resources/sounds/Misc present
+        await mizlib.mizUpdateSingleSoundFolder(mizObject, 'Misc');
+        // On fait une sauvegarde dans le folder de destination
+        // fs.writeFileSync([
+        //         jtffci.config.general.missionFolder,
+        //         "/",
+        //         path.parse(env_mission).name,
+        //         "/",
+        //         path.basename(env_mission)
+        //     ].join(""),
+        //     await mizObject.generateAsync({
+        //         type: 'nodebuffer',
+        //         streamFiles: true,
+        //         compression: "DEFLATE",
+        //         compressionOptions: {
+        //             level: 9
+        //         }
+        //     })
+        // );
+        const missionObject = await mizlib.getMissionObjectFromZipObject(mizObject);
+        let mapResourceObject = await mizlib.getMapResourceObjectFromZipObject(mizObject);
+        let settingsArray = [];
         if (Array.isArray(mapResourceObject)) {
             if (mapResourceObject.length === 0) {
                 mapResourceObject = {};
             }
         }
         // injection SplashDamage
-        let tuple = jtffci.injectScripts(
+        let tuple = mizlib.injectLuaScriptsInMissionObject(
             missionObject['trig'],
             missionObject['trigrules'],
             mapResourceObject,
@@ -181,7 +186,7 @@ function injectScripts(jtffci, env_mission) {
         missionObject['trigrules'] = tuple.trObject;
         mapResourceObject = tuple.mrObject;
         // injection Moose
-        tuple = jtffci.injectScripts(
+        tuple = mizlib.injectLuaScriptsInMissionObject(
             missionObject['trig'],
             missionObject['trigrules'],
             mapResourceObject,
@@ -194,7 +199,7 @@ function injectScripts(jtffci, env_mission) {
         missionObject['trigrules'] = tuple.trObject;
         mapResourceObject = tuple.mrObject;
         // injection Mist
-        tuple = jtffci.injectScripts(
+        tuple = mizlib.injectLuaScriptsInMissionObject(
             missionObject['trig'],
             missionObject['trigrules'],
             mapResourceObject,
@@ -207,7 +212,7 @@ function injectScripts(jtffci, env_mission) {
         missionObject['trigrules'] = tuple.trObject;
         mapResourceObject = tuple.mrObject;
         // injection Skynet
-        tuple = jtffci.injectScripts(
+        tuple = mizlib.injectLuaScriptsInMissionObject(
             missionObject['trig'],
             missionObject['trigrules'],
             mapResourceObject,
@@ -220,27 +225,29 @@ function injectScripts(jtffci, env_mission) {
         missionObject['trigrules'] = tuple.trObject;
         mapResourceObject = tuple.mrObject;
         // injection Librairies JTFF
-        tuple = jtffci.injectScripts(
+        settingsArray.push(
+            {
+                file: "settings-gemman.lua",
+            },
+            {
+                file: "settings-global.lua",
+            },
+        );
+        tuple = mizlib.injectLuaScriptsInMissionObject(
             missionObject['trig'],
             missionObject['trigrules'],
             mapResourceObject,
-            'Load Libraries',
+            'Load JTFF Libraries',
             ['010-root_menus.lua', '020-mission_functions.lua', 'gemman.lua'],
-            16,
+            17,
             '0xffff00ff'
         );
         missionObject['trig'] = tuple.tObject;
         missionObject['trigrules'] = tuple.trObject;
         mapResourceObject = tuple.mrObject;
 
-        let settingsArray = [];
-        settingsArray.push(
-            {
-                file: "settings-gemman.lua",
-            },
-        );
         // injection de la gestion des Set_Clients
-        tuple = jtffci.injectScripts(
+        tuple = mizlib.injectLuaScriptsInMissionObject(
             missionObject['trig'],
             missionObject['trigrules'],
             mapResourceObject,
@@ -264,7 +271,7 @@ function injectScripts(jtffci, env_mission) {
                     objectName: "OnDemandTankersConfig"
                 },
             );
-            tuple = jtffci.injectScripts(
+            tuple = mizlib.injectLuaScriptsInMissionObject(
                 missionObject['trig'],
                 missionObject['trigrules'],
                 mapResourceObject,
@@ -279,31 +286,7 @@ function injectScripts(jtffci, env_mission) {
         }
         if ((/^y\b|o\b|yes\b|oui\b/i).test(prompt_result.inject_airboss)) {
             // injection des fichiers son Airboss
-            const zip = await jtffci.mizOpen([
-                jtffci.config.general.missionFolder,
-                "/",
-                path.parse(env_mission).name,
-                "/",
-                path.basename(env_mission)
-            ].join(""));
-            const airbossSoundFolder = zip.remove('AIRBOSS').folder('AIRBOSS');
-            await jtffci.addFilesToZip(airbossSoundFolder, 'resources/sounds/AIRBOSS', fs.readdirSync('resources/sounds/AIRBOSS'));
-            const inputZip = await zip.generateAsync({
-                type: 'nodebuffer',
-                streamFiles: true,
-                compression: "DEFLATE",
-                compressionOptions: {
-                    level: 9
-                }
-            });
-            fs.writeFileSync([
-                    jtffci.config.general.missionFolder,
-                    "/",
-                    path.parse(env_mission).name,
-                    "/",
-                    path.basename(env_mission)
-                ].join(""),
-                inputZip);
+            // await mizlib.mizUpdateSingleSoundFolder(mizObject, 'AIRBOSS');
             settingsArray.push(
                 {
                     file: "settings-airboss.lua",
@@ -314,7 +297,7 @@ function injectScripts(jtffci, env_mission) {
                     objectName: "PedrosConfig"
                 },
             );
-            tuple = jtffci.injectScripts(
+            tuple = mizlib.injectLuaScriptsInMissionObject(
                 missionObject['trig'],
                 missionObject['trigrules'],
                 mapResourceObject,
@@ -334,7 +317,7 @@ function injectScripts(jtffci, env_mission) {
                     objectName: "BeaconsConfig"
                 },
             );
-            tuple = jtffci.injectScripts(
+            tuple = mizlib.injectLuaScriptsInMissionObject(
                 missionObject['trig'],
                 missionObject['trigrules'],
                 mapResourceObject,
@@ -358,7 +341,7 @@ function injectScripts(jtffci, env_mission) {
                     objectName: "AwacsOnDemandConfig"
                 },
             );
-            tuple = jtffci.injectScripts(
+            tuple = mizlib.injectLuaScriptsInMissionObject(
                 missionObject['trig'],
                 missionObject['trigrules'],
                 mapResourceObject,
@@ -373,38 +356,14 @@ function injectScripts(jtffci, env_mission) {
         }
         if ((/^y\b|o\b|yes\b|oui\b/i).test(prompt_result.inject_atis)) {
             // injection des fichiers son ATIS
-            // const zip = await jtffci.mizOpen([
-            //     jtffci.config.general.missionFolder,
-            //     "/",
-            //     path.parse(env_mission).name,
-            //     "/",
-            //     path.basename(env_mission)
-            // ].join(""));
-            // const atisSoundFolder = zip.remove('ATIS').folder('ATIS');
-            // await jtffci.addFilesToZip(atisSoundFolder, 'resources/sounds/ATIS', fs.readdirSync('resources/sounds/ATIS'));
-            // const inputZip = await zip.generateAsync({
-            //     type: 'nodebuffer',
-            //     streamFiles: true,
-            //     compression: "DEFLATE",
-            //     compressionOptions: {
-            //         level: 9
-            //     }
-            // });
-            // fs.writeFileSync([
-            //         jtffci.config.general.missionFolder,
-            //         "/",
-            //         path.parse(env_mission).name,
-            //         "/",
-            //         path.basename(env_mission)
-            //     ].join(""),
-            //     inputZip);
+            // await mizlib.mizUpdateSingleSoundFolder(mizObject, 'ATIS');
             settingsArray.push(
                 {
                     file: "settings-atis.lua",
                     objectName: "AtisConfig"
                 },
             );
-            tuple = jtffci.injectScripts(
+            tuple = mizlib.injectLuaScriptsInMissionObject(
                 missionObject['trig'],
                 missionObject['trigrules'],
                 mapResourceObject,
@@ -440,7 +399,7 @@ function injectScripts(jtffci, env_mission) {
                     objectName: "InterceptConfig"
                 },
             );
-            tuple = jtffci.injectScripts(
+            tuple = mizlib.injectLuaScriptsInMissionObject(
                 missionObject['trig'],
                 missionObject['trigrules'],
                 mapResourceObject,
@@ -455,38 +414,14 @@ function injectScripts(jtffci, env_mission) {
         }
         if ((/^y\b|o\b|yes\b|oui\b/i).test(prompt_result.inject_Logistics)) {
             // injection des fichiers son CTLD
-            const zip = await jtffci.mizOpen([
-                jtffci.config.general.missionFolder,
-                "/",
-                path.parse(env_mission).name,
-                "/",
-                path.basename(env_mission)
-            ].join(""));
-            const rangeSoundFolder = zip.remove('CTLD').folder('CTLD');
-            await jtffci.addFilesToZip(rangeSoundFolder, 'resources/sounds/CTLD', fs.readdirSync('resources/sounds/CTLD'));
-            const inputZip = await zip.generateAsync({
-                type: 'nodebuffer',
-                streamFiles: true,
-                compression: "DEFLATE",
-                compressionOptions: {
-                    level: 9
-                }
-            });
-            fs.writeFileSync([
-                    jtffci.config.general.missionFolder,
-                    "/",
-                    path.parse(env_mission).name,
-                    "/",
-                    path.basename(env_mission)
-                ].join(""),
-                inputZip);
+            await mizlib.mizUpdateSingleSoundFolder(mizObject, 'CTLD');
             settingsArray.push(
                 {
                     file: "settings-logistics.lua",
                     objectName: "CTLDConfig"
                 },
             );
-            tuple = jtffci.injectScripts(
+            tuple = mizlib.injectLuaScriptsInMissionObject(
                 missionObject['trig'],
                 missionObject['trigrules'],
                 mapResourceObject,
@@ -501,31 +436,7 @@ function injectScripts(jtffci, env_mission) {
         }
         if ((/^y\b|o\b|yes\b|oui\b/i).test(prompt_result.inject_A2G)) {
             // injection des fichiers son Range
-            // const zip = await jtffci.mizOpen([
-            //     jtffci.config.general.missionFolder,
-            //     "/",
-            //     path.parse(env_mission).name,
-            //     "/",
-            //     path.basename(env_mission)
-            // ].join(""));
-            // const rangeSoundFolder = zip.remove('RANGE').folder('RANGE');
-            // await jtffci.addFilesToZip(rangeSoundFolder, 'resources/sounds/RANGE', fs.readdirSync('resources/sounds/RANGE'));
-            // const inputZip = await zip.generateAsync({
-            //     type: 'nodebuffer',
-            //     streamFiles: true,
-            //     compression: "DEFLATE",
-            //     compressionOptions: {
-            //         level: 9
-            //     }
-            // });
-            // fs.writeFileSync([
-            //         jtffci.config.general.missionFolder,
-            //         "/",
-            //         path.parse(env_mission).name,
-            //         "/",
-            //         path.basename(env_mission)
-            //     ].join(""),
-            //     inputZip);
+            // await mizlib.mizUpdateSingleSoundFolder(mizObject, 'RANGE');
             settingsArray.push(
                 {
                     file: "settings-ranges.lua",
@@ -552,7 +463,7 @@ function injectScripts(jtffci, env_mission) {
                     objectName: "SkynetConfig"
                 },
             );
-            tuple = jtffci.injectScripts(
+            tuple = mizlib.injectLuaScriptsInMissionObject(
                 missionObject['trig'],
                 missionObject['trigrules'],
                 mapResourceObject,
@@ -566,46 +477,46 @@ function injectScripts(jtffci, env_mission) {
             mapResourceObject = tuple.mrObject;
         }
         if ((/^y\b|o\b|yes\b|oui\b/i).test(prompt_result.inject_mission)) {
-            fs.copyFileSync('templates/src/200-mission.lua',
-                [
-                    jtffci.config.general.missionFolder,
-                    "/",
-                    path.parse(env_mission).name,
-                    "/src/200-mission.lua"
-                ].join("")
-            );
-            const zip = await jtffci.mizOpen([
-                jtffci.config.general.missionFolder,
-                "/",
-                path.parse(env_mission).name,
-                "/",
-                path.basename(env_mission)
-            ].join(""));
-
-            jtffci.mizUpdateLuaFile(zip, [
-                    jtffci.config.general.missionFolder,
-                    "/",
-                    path.parse(env_mission).name,
-                    "/src/200-mission.lua"
-                ].join("")
-            );
-            const inputZip = await zip.generateAsync({
-                type: 'nodebuffer',
-                streamFiles: true,
-                compression: "DEFLATE",
-                compressionOptions: {
-                    level: 9
-                }
-            });
-            fs.writeFileSync([
-                    jtffci.config.general.missionFolder,
-                    "/",
-                    path.parse(env_mission).name,
-                    "/",
-                    path.basename(env_mission)
-                ].join(""),
-                inputZip);
-            tuple = jtffci.injectScripts(
+            // fs.copyFileSync('templates/src/200-mission.lua',
+            //     [
+            //         jtffci.config.general.missionFolder,
+            //         "/",
+            //         path.parse(env_mission).name,
+            //         "/src/200-mission.lua"
+            //     ].join("")
+            // );
+            // const zip = await mizlib.getZipObjectFromMizPath([
+            //     jtffci.config.general.missionFolder,
+            //     "/",
+            //     path.parse(env_mission).name,
+            //     "/",
+            //     path.basename(env_mission)
+            // ].join(""));
+            //
+            // mizlib.injectFileIntoZipObject(zip, [
+            //         jtffci.config.general.missionFolder,
+            //         "/",
+            //         path.parse(env_mission).name,
+            //         "/src/200-mission.lua"
+            //     ].join("")
+            // );
+            // const inputZip = await zip.generateAsync({
+            //     type: 'nodebuffer',
+            //     streamFiles: true,
+            //     compression: "DEFLATE",
+            //     compressionOptions: {
+            //         level: 9
+            //     }
+            // });
+            // fs.writeFileSync([
+            //         jtffci.config.general.missionFolder,
+            //         "/",
+            //         path.parse(env_mission).name,
+            //         "/",
+            //         path.basename(env_mission)
+            //     ].join(""),
+            //     inputZip);
+            tuple = mizlib.injectLuaScriptsInMissionObject(
                 missionObject['trig'],
                 missionObject['trigrules'],
                 mapResourceObject,
@@ -627,15 +538,9 @@ function injectScripts(jtffci, env_mission) {
                 "/",
                 path.basename(env_mission)
             ].join("") + ": injecting radio presets declared in resources/radios/" + path.parse(env_mission).name);
-            const zip = await jtffci.mizOpen([
-                jtffci.config.general.missionFolder,
-                "/",
-                path.parse(env_mission).name,
-                "/",
-                path.basename(env_mission)
-            ].join(""));
-            await jtffci.mizUpdateRadioPresets(zip, 'resources/radios/' + path.parse(env_mission).name);
+            await mizlib.mizUpdateRadioPresets(mizObject, 'resources/radios/' + path.parse(env_mission).name);
         }
+        //injection du trigger des settings
         for (let settingsObject of settingsArray) {
             fs.copyFileSync(
                 [
@@ -651,14 +556,7 @@ function injectScripts(jtffci, env_mission) {
                 ].join("")
             );
         }
-        await jtffci.mizInjectSettingsFolder(
-            [
-                jtffci.config.general.missionFolder,
-                "/",
-                path.parse(env_mission).name,
-                "/",
-                path.basename(env_mission)
-            ].join(""),
+        await mizlib.injectLuaSettingsFromFolderPathToZipObject(mizObject,
             [
                 jtffci.config.general.missionFolder,
                 "/",
@@ -667,7 +565,7 @@ function injectScripts(jtffci, env_mission) {
             ].join("")
         );
         if (settingsArray.length > 0) {
-            tuple = jtffci.injectScripts(
+            tuple = mizlib.injectLuaScriptsInMissionObject(
                 missionObject['trig'],
                 missionObject['trigrules'],
                 mapResourceObject,
@@ -681,7 +579,7 @@ function injectScripts(jtffci, env_mission) {
             mapResourceObject = tuple.mrObject;
         }
         // Sauvegarde de la mission avec scripts injectés
-        await jtffci.mizInjectMissionDataFile(
+        await mizlib.mizInjectMissionDataFile(
             [
                 jtffci.config.general.missionFolder,
                 "/",
@@ -691,7 +589,7 @@ function injectScripts(jtffci, env_mission) {
             ].join(""),
             { mission: missionObject }
         );
-        await jtffci.mizInjectMapResourceFile(
+        await mizlib.mizInjectMapResourceFile(
             [
                 jtffci.config.general.missionFolder,
                 "/",
@@ -706,5 +604,4 @@ function injectScripts(jtffci, env_mission) {
     });
 }
 
-
 module.exports = injectScripts

package/scripts/template-update.js

@@ -3,7 +3,7 @@ const fs = require("fs");
 function templateUpdate(jtffci) {
     fs.mkdirSync(jtffci.config.general.missionFolder, { recursive: true });
     jtffci.config.missionTemplates.map(async missionTemplate => {
-        await jtffci.mizUpdate([
+        await mizlib.mizUpdate([
             missionTemplate.prefix,
             '_',
             missionTemplate.theatre,