@mcpher/gas-fakes 1.2.10 → 1.2.12

package/README.RU.md

@@ -331,3 +331,31 @@ const getParentsIterator = ({
 - [this file](README.md)
 - [named colors](named-colors.md)
 - [sandbox](sandbox.md)
+
+## <img src="./logo.png" alt="gas-fakes logo" width="50" align="top">  Further Reading
+
+- [getting started](GETTING_STARTED.md) - how to handle authentication for restricted scopes.
+- [readme](README.md)
+- [initial idea and thoughts](https://ramblings.mcpher.com/a-proof-of-concept-implementation-of-apps-script-environment-on-node/)
+- [Inside the volatile world of a Google Document](https://ramblings.mcpher.com/inside-the-volatile-world-of-a-google-document/)
+- [Apps Script Services on Node – using apps script libraries](https://ramblings.mcpher.com/apps-script-services-on-node-using-apps-script-libraries/)
+- [Apps Script environment on Node – more services](https://ramblings.mcpher.com/apps-script-environment-on-node-more-services/)
+- [Turning async into synch on Node using workers](https://ramblings.mcpher.com/turning-async-into-synch-on-node-using-workers/)
+- [All about Apps Script Enums and how to fake them](https://ramblings.mcpher.com/all-about-apps-script-enums-and-how-to-fake-them/)
+- [Russian version](README.RU.md) ([credit Alex Ivanov](https://github.com/oshliaer)) - needs updating
+- [colaborators](collaborators.md) - additional information for collaborators
+- [oddities](oddities.md) - a collection of oddities uncovered during this project
+- [gemini](gemini-observations.md) - some reflections and experiences on using gemini to help code large projects
+- [named colors](named-colors.md)
+- [sandbox](sandbox.md)
+- [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)
+- [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/)
+- [gas-fakes-cli now has built in mcp server and gemini extension](https://ramblings.mcpher.com/gas-fakes-cli-now-has-built-in-mcp-server-and-gemini-extension/)
+- [gas-fakes CLI: Run apps script code directly from your terminal](https://ramblings.mcpher.com/gas-fakes-cli-run-apps-script-code-directly-from-your-terminal/)
+- [How to allow access to sensitive scopes with Application Default Credentials](https://ramblings.mcpher.com/how-to-allow-access-to-sensitive-scopes-with-application-default-credentials/)
+- [Supercharge Your Google Apps Script Caching with GasFlexCache](https://ramblings.mcpher.com/supercharge-your-google-apps-script-caching-with-gasflexcache/)
+- [Fake-Sandbox for Google Apps Script: Granular controls.](https://ramblings.mcpher.com/fake-sandbox-for-google-apps-script-granular-controls/)
+- [A Fake-Sandbox for Google Apps Script: Securely Executing Code Generated by Gemini CLI](https://ramblings.mcpher.com/gas-fakes-sandbox/)

package/README.md

@@ -150,6 +150,7 @@ For inspiration on pushing modified files to the IDE, see the togas.sh bash scri
 ## Help
 
 As I mentioned earlier, to take this further, I'm going to need a lot of help to extend the methods and services supported - so if you feel this would be useful to you, and would like to collaborate, please ping me on bruce@mcpher.com and we'll talk.
+
 ## <img src="./logo.png" alt="gas-fakes logo" width="50" align="top">  Further Reading
 
 - [getting started](GETTING_STARTED.md) - how to handle authentication for restricted scopes.
@@ -163,11 +164,17 @@ As I mentioned earlier, to take this further, I'm going to need a lot of help to
 - [Russian version](README.RU.md) ([credit Alex Ivanov](https://github.com/oshliaer)) - needs updating
 - [colaborators](collaborators.md) - additional information for collaborators
 - [oddities](oddities.md) - a collection of oddities uncovered during this project
-- [gemini](gemini.md) - some reflections and experiences on using gemini to help code large projects
+- [gemini](gemini-observations.md) - some reflections and experiences on using gemini to help code large projects
 - [named colors](named-colors.md)
 - [sandbox](sandbox.md)
 - [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)
-- [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/)
+- [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/)
+- [gas-fakes-cli now has built in mcp server and gemini extension](https://ramblings.mcpher.com/gas-fakes-cli-now-has-built-in-mcp-server-and-gemini-extension/)
+- [gas-fakes CLI: Run apps script code directly from your terminal](https://ramblings.mcpher.com/gas-fakes-cli-run-apps-script-code-directly-from-your-terminal/)
+- [How to allow access to sensitive scopes with Application Default Credentials](https://ramblings.mcpher.com/how-to-allow-access-to-sensitive-scopes-with-application-default-credentials/)
+- [Supercharge Your Google Apps Script Caching with GasFlexCache](https://ramblings.mcpher.com/supercharge-your-google-apps-script-caching-with-gasflexcache/)
+- [Fake-Sandbox for Google Apps Script: Granular controls.](https://ramblings.mcpher.com/fake-sandbox-for-google-apps-script-granular-controls/)
+- [A Fake-Sandbox for Google Apps Script: Securely Executing Code Generated by Gemini CLI](https://ramblings.mcpher.com/gas-fakes-sandbox/)

package/exgcp.sh

@@ -18,6 +18,8 @@ fi
 
 # Read the GCP_PROJECT_ID, remove quotes, and handle potential carriage returns
 GCP_PROJECT_ID_VALUE=$(grep -E '^GCP_PROJECT_ID=' "$ENV_FILE" | cut -d '=' -f2 | tr -d '"\r')
+GEMINI_API_KEY_VALUE=$(grep -E '^GEMINI_API_KEY=' "$ENV_FILE" | cut -d '=' -f2 | tr -d '"\r')
+GEMINI_MODEL_VALUE=$(grep -E '^GEMINI_MODEL=' "$ENV_FILE" | cut -d '=' -f2 | tr -d '"\r')
 
 # Check if a value was extracted
 if [ -z "$GCP_PROJECT_ID_VALUE" ]; then
@@ -25,7 +27,21 @@ if [ -z "$GCP_PROJECT_ID_VALUE" ]; then
   return 1
 fi
 
+if [ -z "GEMINI_API_KEY_VALUE" ]; then
+  echo "GEMINI_API_KEY not found or is empty in $ENV_FILE."
+else
+  echo "exported: GEMINI_API_KEY"
+  export GEMINI_API_KEY="$GEMINI_API_KEY_VALUE"
+fi  
+
+if [ -z "GEMINI_MODEL_VALUE" ]; then
+  echo "GEMINI_MODEL not found or is empty in $ENV_FILE."
+else
+  echo "exported: GEMINI_MODEL=$GEMINI_MODEL_VALUE"
+  export GEMINI_MODEL="$GEMINI_MODEL_VALUE"
+fi  
+
 # Export the variable for the current session
 export GOOGLE_CLOUD_PROJECT="$GCP_PROJECT_ID_VALUE"
 
-echo "Successfully exported: GOOGLE_CLOUD_PROJECT=$GOOGLE_CLOUD_PROJECT"
+echo "exported: GOOGLE_CLOUD_PROJECT=$GOOGLE_CLOUD_PROJECT"

package/gas-fakes.js

@@ -14,11 +14,17 @@ import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
 import { z } from "zod";
 
+// sync the version with gas fakes code since they share a package.json
+import { createRequire } from 'node:module';
+const require = createRequire(import.meta.url);
+const pjson = require('./package.json');
+const VERSION = pjson.version;
+
 // -----------------------------------------------------------------------------
 // CONSTANTS & UTILITIES
 // -----------------------------------------------------------------------------
 
-const VERSION = "0.0.5";
+const CLI_VERSION = "0.0.7";
 const MCP_VERSION = "0.0.3";
 const execAsync = promisify(exec);
 
@@ -155,7 +161,7 @@ function generateExecutionScript({ scriptText, useSandbox, sandboxConfig }) {
     '  await import("./main.js"); // This will trigger the fxInit call',
     gasScript,
     "}",
-    "runGas();",
+    "return runGas();",
   ].join("\n");
 
   return { mainScript, gasScript };
@@ -170,8 +176,15 @@ function generateExecutionScript({ scriptText, useSandbox, sandboxConfig }) {
  * @param {object} options The processed CLI options.
  */
 async function executeGasScript(options) {
-  const { filename, script, display, gfSettings, useSandbox, sandboxConfig } =
-    options;
+  const {
+    filename,
+    script,
+    display,
+    gfSettings,
+    useSandbox,
+    sandboxConfig,
+    args,
+  } = options;
 
   const scriptText = filename ? fs.readFileSync(filename, "utf8") : script;
 
@@ -194,8 +207,18 @@ async function executeGasScript(options) {
     configurable: true,
   });
 
-  const gasFunction = new Function(mainScript);
-  await gasFunction();
+  let res;
+  if (args) {
+    const gasFunction = new Function("args", mainScript);
+    res = await gasFunction(args);
+  } else {
+    const gasFunction = new Function(mainScript);
+    res = await gasFunction();
+  }
+  if (res) {
+    const output = typeof res == "string" ? res : JSON.stringify(res);
+    console.log(output); // Returned value from Google Apps Script.
+  }
 }
 
 // -----------------------------------------------------------------------------
@@ -428,6 +451,11 @@ async function main() {
       "Display the generated script before execution.",
       false
     )
+    .option(
+      "-a, --args <string>",
+      `Arguments for the function of Google Apps Script. Provide it as a JSON string. The name of the argument is "args" as a fixed name. For example, when the function of GAS is \`function sample(args) { script }\`, you can provide the arguments like \`-a '{"key": "value"}'\`.`,
+      null
+    )
     .action(async (options) => {
       if (Object.keys(options).length === 0) {
         program.help();
@@ -455,6 +483,18 @@ async function main() {
       const sandboxConfig = buildSandboxConfig(options);
       const useSandbox = !!options.sandbox || !!sandboxConfig;
 
+      let args = null;
+      if (options.args) {
+        try {
+          args = JSON.parse(
+            options.args.replace(/\n/g, "\\n").replace(/\r/g, "\\r")
+          );
+        } catch (err) {
+          console.error("Error: Invalid JSON provided to --args option.");
+          process.exit(1);
+        }
+      }
+
       await executeGasScript({
         filename,
         script,
@@ -462,6 +502,7 @@ async function main() {
         useSandbox,
         sandboxConfig,
         gfSettings: settingsPath,
+        args,
       });
     });
 

package/main.js

@@ -1,2 +1,8 @@
 // testing locally
+// sync the version with gas fakes code since they share a package.json
+import { createRequire } from 'node:module';
+const require = createRequire(import.meta.url);
+const pjson = require('./package.json');
+const VERSION = pjson.version;
+console.log (`...gas-fakes version ${VERSION}`)
 import './src/index.js'

package/package.json

@@ -30,11 +30,14 @@
   },
   "type": "module",
   "scripts": {
-    "pub": "npm publish --access public"
+    "pub": "npm publish --access public",
+    "includes": "node ./doccreation/include-docs.js",
+    "progress": "cd ./doccreation && bash pipeline.sh",
+    "docs": "npm run includes && npm run progress"
   },
   "name": "@mcpher/gas-fakes",
   "author": "bruce mcpherson",
-  "version": "1.2.10",
+  "version": "1.2.12",
   "license": "MIT",
   "main": "main.js",
   "description": "A proof of concept implementation of Apps Script Environment on Node",

package/src/index.js

@@ -1,3 +1,4 @@
+
 import './services/scriptapp/app.js'
 
 import './services/driveapp/app.js'
@@ -22,5 +23,6 @@ import './services/advforms/app.js'
 import './services/formapp/app.js'
 import './services/slidesapp/app.js'
 import './services/mimetype/app.js'
+import './services/lock/app.js'
 // should be last
 import './services/stores/app.js'

package/src/services/lock/app.js

@@ -0,0 +1,11 @@
+
+
+/**
+ * the idea here is to create an empty global entry for the singleton
+ * but only load it when it is actually used.
+ */
+import { newFakeLockService as maker } from './fakelockservice.js';
+import { lazyLoaderApp } from '../common/lazyloader.js'
+
+let _app = null;
+_app = lazyLoaderApp(_app, 'LockService', maker)

package/src/services/lock/fakelock.js

@@ -0,0 +1,65 @@
+import { Proxies } from '../../support/proxies.js';
+
+
+/**
+ * the lock service us meaningless here as we are running on node single threaded
+ * in apps script this would lock shared code that was being shared by multiple scripts
+ * so this is all provided for compatibility only
+ */
+class FakeLock {
+  constructor(domain) {
+    this.__fakeObjectType = 'Lock';
+    this.__domain = domain
+    this.__locked = false;
+  }
+
+  /**
+   * Returns true if the lock was acquired.
+   * @returns {boolean}
+   */
+  hasLock() {
+    return this.__locked;
+  }
+
+  /**
+   * Releases the lock.
+   */
+  releaseLock() {
+    this.__locked = false;
+  }
+
+  /**
+   * Attempts to acquire the lock.
+   * @param {number} timeoutInMillis 
+   * @returns {boolean}
+   */
+  tryLock(timeoutInMillis) {
+    if (this.hasLock()) {
+      return true;
+    }
+    // In a single-threaded fake, we can't wait. We fail only if timeout is negative.
+    if (timeoutInMillis < 0) {
+      return false;
+    }
+    this.__locked = true;
+    return true;
+  }
+
+  /**
+   * Attempts to acquire the lock, throwing an exception on timeout.
+   * @param {number} timeoutInMillis 
+   */
+  waitLock(timeoutInMillis) {
+    if (this.hasLock()) {
+      return; // Already acquired, no need to wait
+    }
+    // In a single-threaded fake, we can't wait. We fail only if timeout is negative.
+    if (timeoutInMillis < 0) {
+      throw new Error(`Lock timeout: another process was holding the lock for too long.`);
+    }
+    this.__locked = true;
+  }
+}
+
+
+export const newFakeLock = (...args) => Proxies.guard(new FakeLock(...args));

package/src/services/lock/fakelockservice.js

@@ -0,0 +1,37 @@
+import { Proxies } from '../../support/proxies.js';
+import { newFakeLock } from './fakelock.js';
+
+/**
+ * domains of lock supported
+ * @enum {string}
+ */
+const LockDomain = Object.freeze({
+  SCRIPT: 'SCRIPT',
+  USER: 'USER',
+  DOCUMENT: 'DOCUMENT'
+})
+/**
+ * the lock service us meaningless here as we are running on node single threaded
+ * in apps script this would lock shared code that was being shared by multiple scripts
+ * so this is all provided for compatibility only
+ */
+class FakeLockService {
+  constructor() {
+    this.__fakeObjectType = 'LockService';
+  }
+  getDocumentLock () {
+    // Per documentation, this should return null if not in the context of a document.
+    if (ScriptApp.__documentId) {
+      return newFakeLock(LockDomain.DOCUMENT);
+    }
+    return null;
+  }
+  getUserLock () {
+    return newFakeLock(LockDomain.USER) 
+  }
+  getScriptLock () {
+    return newFakeLock(LockDomain.SCRIPT)
+  }
+}
+
+export const newFakeLockService = (...args) => Proxies.guard(new FakeLockService(...args));