@mcpher/gas-fakes 1.2.7 → 1.2.9

package/README.md

@@ -169,4 +169,5 @@ As I mentioned earlier, to take this further, I'm going to need a lot of help to
 - [named range identity](named-range-identity.md)
 - [adc and restricted scopes](https://ramblings.mcpher.com/how-to-allow-access-to-sensitive-scopes-with-application-default-credentials/)
 - [push test pull](pull-test-push.md)
-- [gas fakes cli](gas-fakes-cli.md)
+- [gas fakes cli](gas-fakes-cli.md)
+- [sharing cache and properties between gas-fakes and live apps script](https://ramblings.mcpher.com/sharing-cache-and-properties-between-gas-fakes-and-live-apps-script/)

package/gas-fakes.js

@@ -2,14 +2,18 @@
 
 /**
  * cli for gas-fakes
- * v0.0.1
  */
 import fs from "fs";
 import path from "path";
 import { Command } from "commander";
-import dotenv from 'dotenv'
+import dotenv from "dotenv";
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
+import z from "zod";
+import { exec } from "child_process";
+import { promisify } from "util";
 
-const version = "0.0.2";
+const version = "0.0.3";
 
 const program = new Command();
 
@@ -18,7 +22,6 @@ program
   .description("CLI tool for gas-fakes")
   .version(version, "-v, --version", "display the current version");
 
-
 program
   .description("Execute Google Apps Script using gas-fakes.")
   .option(
@@ -27,11 +30,13 @@ program
   )
   .option(
     "-e, --env <path>",
-    "provide path to your .env file for special options."
+    "provide path to your .env file for special options.",
+    "./.env"
   )
   .option(
     "-g, --gfsettings <path>",
-    "provide path to your gasfakes.json file for script options."
+    "provide path to your gasfakes.json file for script options.",
+    "./gasfakes.json"
   )
   .option(
     "-s, --script <string>",
@@ -55,24 +60,44 @@ program
     if (Object.keys(options).length == 0) {
       program.help();
     } else {
-      const { filename, script, sandbox, whitelist, json, display, env , gfsettings} = options;
+      const {
+        filename,
+        script,
+        sandbox,
+        whitelist,
+        json,
+        display,
+        env,
+        gfsettings,
+      } = options;
       const obj = { sandbox: !!sandbox, display };
-      if (!filename && !script) {
+
+      if (!filename && !script && !obj.script) {
         console.error(
           "error: Provide the filename or the script of Google Apps Script."
         );
         process.exit();
       }
-      if (gfsettings) {
-        obj.gfSettings = path.resolve(gfsettings);
-      }
+
       if (env) {
-        dotenv.config({ path: path.resolve(env) });
+        const envPath = path.resolve(process.cwd(), env);
+        console.log("...using env file in", envPath);
+        dotenv.config({ path: envPath, quiet: true });
+      }
+
+      // note this must come after any env file fiddling.
+      if (gfsettings) {
+        const gfPath = path.resolve(process.cwd(), gfsettings);
+        console.log("...using gasfakes settings file in", gfPath);
+        obj.gfSettings = gfPath;
+        // override whatever is in env
+        process.env.GF_SETTINGS_PATH = gfPath;
       }
+
       if (filename) {
         obj.filename = filename;
       }
-      if (script) {
+      if (!obj.script && script) {
         obj.script = script;
       }
 
@@ -96,15 +121,22 @@ program
     }
   });
 
+const execAsync = promisify(exec);
+program
+  .command("mcp")
+  .description("Launch gas-fakes as the MCP server")
+  .action(mcp_server);
+
 program.showHelpAfterError("(add --help for additional information)");
 program.parse();
 
 function __getImportScript(o) {
-  const { scriptText, sandbox, whitelistItems, json_sandbox, gfSettings } = o;
+  const { scriptText, sandbox, whitelistItems, json_sandbox } = o;
   if (scriptText.trim() == "") {
     console.error("error: Google Apps Script was not found.");
     process.exit();
   }
+  let gasScriptStr = "";
   const gasScriptAr = [];
   if (json_sandbox) {
     gasScriptAr.push(
@@ -167,8 +199,7 @@ function __getImportScript(o) {
         `const behavior = ScriptApp.__behavior;`,
         `behavior.sandboxMode = true;`,
         `behavior.strictSandbox = true;`,
-        `behavior.setIdWhitelist([${wl}]);`,
-        `\n\n${scriptText}\n\n`,
+        `behavior.setIdWhitelist([${wl}]);``\n\n${scriptText}\n\n`,
         `ScriptApp.__behavior.trash();`
       );
     } else {
@@ -177,10 +208,6 @@ function __getImportScript(o) {
   }
   const importScriptAr = [
     `async function runGas() {`,
-    // Pass the settings path to the init function if it's provided
-    gfSettings
-      ? `const settingsPath = "${gfSettings}";`
-      : `const settingsPath = undefined;`,
     `await import("./main.js");`, // This will trigger the fxInit call
     ...gasScriptAr,
     `};`,
@@ -195,13 +222,13 @@ function __getImportScript(o) {
 
 async function loadScript(o) {
   const { filename, script, display } = o;
-
   const scriptText = filename ? fs.readFileSync(filename, "utf8") : script;
-  const { mainScript, gasScript } = __getImportScript({ scriptText, ...o });
+  const { mainScript, gasScript } = __getImportScript({
+    scriptText: scriptText.replace(/\\n/g, "\n"),
+    ...o,
+  });
   if (display) {
-    console.log(`--- script ---`);
-    console.log(gasScript);
-    console.log(`--- /script ---`);
+    console.log(`\n--- script ---\n${gasScript}\n--- /script ---\n`);
   }
   const gasFunc = new Function(mainScript);
   // The script needs access to the settings path variable we just created
@@ -212,3 +239,71 @@ async function loadScript(o) {
   });
   gasFunc();
 }
+
+async function mcp_server() {
+  const server = new McpServer({
+    name: "gas-fakes-mcp",
+    version: "0.0.1",
+  });
+
+  const { name, schema, func } = {
+    name: "run-gas-by-gas-fakes",
+    schema: {
+      description:
+        "Use this to safely run Google Apps Script in a sandbox using gas-fakes.",
+      inputSchema: {
+        script: z.string().describe(`Provide Google Apps Script as a string.`),
+        sandbox: z
+          .boolean()
+          .describe("Use to run Google Apps Script in a sandbox."),
+        whitelist: z
+          .string()
+          .describe(
+            "Use this to use the specific files and folders on Google Drive. whitelist of file IDs. Set the file IDs in comma-separated list. In this case, the files of the file IDs are used for both read and write. When this is used, the script is run in a sandbox."
+          )
+          .optional(),
+        json: z
+          .string()
+          .describe(
+            `Use this to manage the sandbox more if the detailed information about the sandbox is provided. JSON string including parameters for managing a sandbox. Enclose it with ' or ". When this is used, the option "whitelist" is ignored. When this is used, the script is run in a sandbox.`
+          )
+          .optional(),
+      },
+    },
+    func: async (options = {}) => {
+      const { sandbox, whitelist, json } = options;
+      try {
+        const opts = [
+          { v: sandbox, k: "-x" },
+          { v: whitelist, k: "-w" },
+          { v: json, k: "-j" },
+        ].reduce((ar, { v, k }) => {
+          if (v) {
+            ar.push(k != "-x" ? `${k} ${v}` : `${k}`);
+          }
+          return ar;
+        }, []);
+        const scriptArg = JSON.stringify(options.script.toString());
+        const c = `gas-fakes ${opts.join(" ")} -s ${scriptArg.replace(
+          /\\n/g,
+          "\n"
+        )}`;
+        const { stdout } = await execAsync(c);
+        return {
+          content: [{ type: "text", text: stdout || "Done." }],
+          isError: false,
+        };
+      } catch (err) {
+        return {
+          content: [{ type: "text", text: err.message }],
+          isError: true,
+        };
+      }
+    },
+  };
+
+  server.registerTool(name, schema, func);
+
+  const transport = new StdioServerTransport();
+  await server.connect(transport);
+}

package/gasfakes.json

@@ -0,0 +1,8 @@
+{
+  "manifest": "./appsscript.json",
+  "clasp": "./.clasp.json",
+  "scriptId": "28780abe-aaec-4526-a0bf-9d5c104c68b8",
+  "documentId": null,
+  "cache": "/tmp/gas-fakes/cache",
+  "properties": "/tmp/gas-fakes/properties"
+}

package/package.json

@@ -5,6 +5,7 @@
   "dependencies": {
     "@mcpher/fake-gasenum": "^1.0.2",
     "@mcpher/gas-flex-cache": "^1.1.2",
+    "@modelcontextprotocol/sdk": "^1.20.2",
     "@sindresorhus/is": "^7.0.1",
     "archiver": "^7.0.1",
     "commander": "^14.0.1",
@@ -24,58 +25,16 @@
     "subsume": "^4.0.0",
     "to-readable-stream": "^4.0.0",
     "unzipper": "^0.12.3",
-    "yoctocolors": "^2.1.2"
+    "yoctocolors": "^2.1.2",
+    "zod": "^3.25.76"
   },
   "type": "module",
   "scripts": {
-    "test": "node --env-file=./.env ./test/test.js",
-    "testdrive": "node --env-file=./.env ./test/testdrive.js execute",
-    "testsheetsdatavalidations": "node --env-file=./.env ./test/testsheetsdatavalidations.js execute",
-    "testsheetspermissions": "node --env-file=./.env ./test/testsheetspermissions.js execute",
-    "testsheetsvalues": "node --env-file=./.env ./test/testsheetsvalues.js execute",
-    "testsheets": "node --env-file=./.env ./test/testsheets.js execute",
-    "testfetch": "node --env-file=./.env ./test/testfetch.js execute",
-    "testsession": "node --env-file=./.env ./test/testsession.js execute",
-    "testutilities": "node --env-file=./.env ./test/testutilities.js execute",
-    "teststores": "node --env-file=./.env ./test/teststores.js execute",
-    "testscriptapp": "node --env-file=./.env ./test/testscriptapp.js execute",
-    "testfiddler": "node --env-file=./.env ./test/testfiddler.js execute",
-    "testenums": "node --env-file=./.env ./test/testenums.js execute",
-    "testsheetssets": "node --env-file=./.env ./test/testsheetssets.js execute",
-    "testsheetsvui": "node --env-file=./.env ./test/testsheetsvui.js execute",
-    "testsheetsdeveloper": "node --env-file=./.env ./test/testsheetsdeveloper.js execute",
-    "testsheetsexotics": "node --env-file=./.env ./test/testsheetsexotics.js execute",
-    "testsheetsdata": "node --env-file=./.env ./test/testsheetsdata.js execute",
-    "testdocsadv": "node --env-file=./.env ./test/testdocsadv.js execute",
-    "testslidesadv": "node --env-file=./.env ./test/testslidesadv.js execute",
-    "testform": "node --env-file=./.env ./test/testform.js execute",
-    "testformsadv": "node --env-file=./.env ./test/testformsadv.js execute",
-    "testdocs": "node --env-file=./.env ./test/testdocs.js execute",
-    "testslides": "node --env-file=./.env ./test/testslides.js execute",
-    "testdocsnext": "node --env-file=./.env ./test/testdocsnext.js execute",
-    "testsheetstext": "node --env-file=./.env ./test/testsheetstext.js execute",
-    "testsheetsrange": "node --env-file=./.env ./test/testsheetsrange.js execute",
-    "testdocslistitems": "node --env-file=./.env ./test/testdocslistitems.js execute",
-    "testdocsall": "node --env-file=./.env ./test/testdocsall.js",
-    "testdocsheaders": "node --env-file=./.env ./test/testdocsheaders.js execute",
-    "testdocsfooters": "node --env-file=./.env ./test/testdocsfooters.js execute",
-    "testdocsfootnotes": "node --env-file=./.env ./test/testdocsfootnotes.js execute",
-    "testdocsimages": "node --env-file=./.env ./test/testdocsimages.js execute",
-    "testdocsstyles": "node --env-file=./.env ./test/testdocsstyles.js execute",
-    "testsandbox": "node --trace-warnings ./test/testsandbox.js execute",
-    "testgmail": "node --env-file=./.env ./test/testgmail.js execute",
-    "testlogger": "node --env-file=./.env ./test/testlogger.js execute",
-    "testchat": "node --env-file=./.env ./test/testchat.js execute",
-    "testpeople": "node --env-file=./.env ./test/testpeople.js execute",
-    "testtasks": "node --env-file=./.env ./test/testtasks.js execute",
-    "testcalendar": "node --env-file=./.env ./test/testcalendar.js execute",
-    "testworkspaceevents": "node --env-file=./.env ./test/testworkspaceevents.js execute",
-    "testmimetype": "node --env-file=./.env ./test/testmimetype.js execute",
     "pub": "npm publish --access public"
   },
   "name": "@mcpher/gas-fakes",
   "author": "bruce mcpherson",
-  "version": "1.2.7",
+  "version": "1.2.9",
   "license": "MIT",
   "main": "main.js",
   "description": "A proof of concept implementation of Apps Script Environment on Node",

package/src/support/sxauth.js

@@ -20,13 +20,12 @@ import path from 'path'
  * @param {string} p.authPath import the auth code 
  * @param {string} p.claspPath where to find the clasp file by default
  * @param {string} p.settingsPath where to find the settings file
- * @param {string} p.mainDir the directory the main app is running from
  * @param {string} p.cachePath the cache files
  * @param {string} p.propertiesPath the properties file location
  * @param {string} p.fakeId a fake script id to use if one isnt in the settings
  * @return {object} the finalized vesions of all the above 
  */
-export const sxInit = async ({ manifestPath, claspPath, settingsPath, mainDir, cachePath, propertiesPath, fakeId }) => {
+export const sxInit = async ({ manifestPath, claspPath, settingsPath, cachePath, propertiesPath, fakeId }) => {
 
 
 
@@ -47,13 +46,11 @@ export const sxInit = async ({ manifestPath, claspPath, settingsPath, mainDir, c
   }
 
   // files are relative to this main path
+  const settingsDir = path.dirname(settingsPath)
 
-  const settingsFile = path.resolve(mainDir, settingsPath)
-  const settingsDir = path.dirname(settingsFile)
-
-  // syncLog (JSON.stringify({mainDir,settingsPath,settingsDir,settingsFile}))
+  // syncLog (JSON.stringify({settingsPath,settingsDir,settingsPath}))
   // get the setting file if it exists
-  const _settings = await getIfExists(path.resolve(mainDir, settingsFile))
+  const _settings = await getIfExists(settingsPath)
   const settings = { ..._settings }
 
   // the content of the settings file take precedence over whatever is passed as the default
@@ -61,8 +58,8 @@ export const sxInit = async ({ manifestPath, claspPath, settingsPath, mainDir, c
   settings.manifest = settings.manifest || manifestPath
   settings.clasp = settings.clasp || claspPath
   const [manifest, clasp] = await Promise.all([
-    getIfExists(path.resolve(mainDir, settings.manifest)),
-    getIfExists(path.resolve(mainDir, settings.clasp))
+    getIfExists(path.resolve(settingsDir, settings.manifest)),
+    getIfExists(path.resolve(settingsDir, settings.clasp))
   ])
 
   /// if we dont have a scriptId we need to check in clasp or make a fakeone
@@ -82,8 +79,8 @@ export const sxInit = async ({ manifestPath, claspPath, settingsPath, mainDir, c
   const strSet = JSON.stringify(settings, null, 2)
   if (JSON.stringify(_settings, null, 2) !== strSet) {
     await mkdir(settingsDir, { recursive: true })
-    syncLog(`...writing to ${settingsFile}`);
-    writeFile(settingsFile, strSet, { flag: 'w' })
+    syncLog(`...writing to ${settingsPath}`);
+    writeFile(settingsPath, strSet, { flag: 'w' })
   }
 
   // get the required scopes and set them

package/src/support/syncit.js

@@ -262,10 +262,11 @@ const fxUnzipper = ({ blob }) => {
 const fxInit = ({
   manifestPath = manifestDefaultPath,
   claspPath = claspDefaultPath,
-  settingsPath = globalThis.settingsPath || settingsDefaultPath,
+  settingsPath = settingsDefaultPath,
   cachePath = cacheDefaultPath,
   propertiesPath = propertiesDefaultPath,
 } = {}) => {
+
   // this is the path of the runing main process
   const mainDir = path.dirname(process.argv[1]);