@mcpher/gas-fakes 1.0.21 → 1.0.23

package/README.RU.md

@@ -328,7 +328,6 @@ const getParentsIterator = ({
 - [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
 - [named colors](named-colors.md) - colors supported by Apps Script
-- [setup env](setup-env.md) - ([credit Eric Shapiro] - additional info on contents of .env file
 - [this file](README.md)
 - [named colors](named-colors.md)
 - [sandbox](sandbox.md)

package/README.md

@@ -120,7 +120,7 @@ When logging to the cloud, entries are sent to the `gas-fakes/console_logs` log
 
 #### Dynamic Control
 
-You can change the logging destination at any time during runtime using the `Logger.__setLogDestination()` method. This is especially useful for testing or for applications that need to change their logging behavior dynamically.
+You can change the logging destination at any time during runtime by setting the `Logger.__logDestination` property. This is especially useful for testing or for applications that need to change their logging behavior dynamically.
 
 The method accepts one of the following string values: `'CONSOLE'`, `'CLOUD'`, `'BOTH'`, or `'NONE'`.
 
@@ -137,13 +137,47 @@ To change the destination during runtime in your script:
 Logger.log('This goes to console and cloud');
 
 // Switch to only logging to the console
-Logger.__setLogDestination('CONSOLE');
+Logger.__logDestination='CONSOLE';
 Logger.log('This now only goes to the console');
 
 // Disable logging completely
-Logger.__setLogDestination('NONE');
+Logger.__logDestination='NONE';
 Logger.log('This goes nowhere');
 ```
+
+#### Link to Cloud log for this run
+
+If you have used Logging to cloud, you can get a link to the log data like this. 
+
+```javascript
+console.log ('....example cloud log link for this session',Logger.__cloudLogLink)
+```
+
+It contains a cloud logging query that will display any logging done in this session - the filter is based on the scriptId (from gasfakes.json), the projectId and userId (from Auth), as well as the start and end time of the session. 
+
+#### A note on .env location
+
+Optionally you can set the initial Logging environment in your .env file. By default it assumes you want to log to the console only.
+If you want to set an initial LOG_DESTINATION using that .env file, you have to let gas-fakes know where to find it. Let's assume it's in the same folder as your main script.
+```env
+node --env-file=.env yourapp.js
+```
+Some developers prefer to use [dotenv](https://www.npmjs.com/package/dotenv) to set the path of the .env file
+```javascript
+import dotenv from 'dotenv'
+dotenv.config({ path: '/custom/path/to/.env' })
+```
+Alternatively, instead of putting it in an env file, you can export it in your shell environment. 
+```sh
+export LOG_DESTINATION="BOTH"
+```
+Finally, another approach is to set it dynamically at the beginning of your app.
+```javascript
+Logger.__logDestination="BOTH"
+```
+
+Do whichever one suits you best.
+
 ### Pushing files to GAS
 
 There are a couple of syntactical differences between Node and Apps Script. Not in the body of the code but in how the IDE executes. The 2 main ones are
@@ -173,7 +207,6 @@ As I mentioned earlier, to take this further, I'm going to need a lot of help to
 - [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
 - [named colors](named-colors.md) - colors supported by Apps Script
-- [setup env](setup-env.md) - ([credit Eric Shapiro] - additional info on contents of .env file
 - [this file](README.md)
 - [named colors](named-colors.md)
 - [sandbox](sandbox.md)

package/gasmess/bruce/pbx.js

@@ -56,7 +56,7 @@ const tli = () => {
   deleteTempFile(id)
 
 }
-tli()
+// tli()
 
 const tx2 = () => {
   let doc = DocumentApp.create("abc")

package/gasmess/bruce/testlogging.js

@@ -0,0 +1,7 @@
+import '../../main.js';
+console.log(process.env.LOG_DESTINATION)
+Logger.__logDestination="BOTH"
+console.log(Logger.__destination)
+console.log (Logger.__cloudLogLink)
+
+

package/gprompts/gas-inventory.js

@@ -3,90 +3,94 @@ import * as cheerio from 'cheerio';
 import fs from 'fs/promises';
 import { URL } from 'url';
 
-const baseUrl = "https://developers.google.com/apps-script/reference/"
+const baseUrl = "https://developers.google.com/apps-script/reference/script/"
 const outputFile = './gas-inventory.json';
 
 const visited = new Map();
 const queue = [baseUrl]
 
+// the urls are kebab cased
 const kebabCamel = (s) => {
   return s.replace(/([-][a-z])/ig, ($1) => {
     return $1.toUpperCase()
       .replace('-', '')
   });
 };
-async function scrape() {
-  const inventory = {};
 
-  while (queue.length > 0) {
-    const url = queue.shift();
-    console.log(`Scraping ${url}`);
-    const response = await got(url);
-    const $ = cheerio.load(response.body);
-    const serviceName = $('h1').text().split('\n').map(f=>f.replace(/^\s+/,'').trim()).filter (f=>f)[0];
-    console.log ('...starting service name',serviceName)
-    inventory[serviceName] = {
-      name: serviceName,
-      link: url,
-      classes: {},
-    };
+function debugPageStructure($) {
+  console.log('=== PAGE STRUCTURE DEBUG ===');
 
-    $('a').each((i, el) => {
-      const href = $(el).attr('href');
-      if (href && href.startsWith('/apps-script/reference')) {
-        const absoluteUrl = new URL(href, url).href;
-        const parentUrl = absoluteUrl.replace (/#.*/, '')
-        const method = kebabCamel(absoluteUrl.match(/#(.*)/) || ['', ''][1])
-        if (!visited.has(parentUrl)) {
-          console.log ('...adding to queue',parentUrl)
-          queue.push(parentUrl);
-          visited.set(parentUrl, {
-            url: parentUrl,
-            methods: new Map ()
-          });
-        }
-        if (method) {
-          visited.get(parentUrl).methods.set(absoluteUrl, {
-            url: absoluteUrl,
-            method
-          })
-        }
-      }
-    });
+  // Check if main elements exist
+  console.log('#main-content exists:', $('#main-content').length > 0);
+  console.log('devsite-content exists:', $('devsite-content').length > 0);
+  console.log('article exists:', $('article').length > 0);
+  console.log('h1 elements:', $('h1').length);
 
-    // Extract classes and methods
-    $('h2').each((i, el) => {
-      const className = $(el).text().trim();
-      if (className) {
-        console.log ('...found class',className,'for service',serviceName)
-        inventory[serviceName].classes[className] = {
-          methods: {},
-          properties: {},
-        };
-
-        // Find the table of methods for the current class
-        const methodsTable = $(el).nextAll('table').first();
-        methodsTable.find('tbody tr').each((j, row) => {
-          const methodName = $(row).find('td').eq(1).text().trim();
-          const methodLink = $(row).find('td').eq(1).find('a').attr('href');
-          const returnType = $(row).find('td').eq(0).text().trim();
+  // Show all h1 texts
+  $('h1').each((i, el) => {
+    console.log(`H1[${i}]:`, $(el).text().trim());
+  });
 
-          if (methodName) {
-            inventory[serviceName].classes[className].methods[methodName] = {
-              link: methodLink ? new URL(methodLink, url).href : '',
-              returns: {
-                type: returnType,
-                link: '' // to be extracted later
-              }
-            };
-          }
-        });
-      }
+  // Show structure of main-content
+  const mainContent = $('#main-content');
+  if (mainContent.length > 0) {
+    console.log('Main-content children:', mainContent.children().length);
+    mainContent.children().each((i, el) => {
+      console.log(`Child ${i}:`, el.tagName, $(el).attr('class') || $(el).attr('id'));
     });
   }
+}
 
-  await fs.writeFile(outputFile, JSON.stringify(inventory, null, 2));
-  console.log(`Inventory saved to ${outputFile}`);
+
+const getNextCheer = async (u) => {
+  console.log(`Scraping ${u}`);
+  const response = await got(u);
+  return cheerio.load(response.body);
 }
 
-scrape().catch(console.error);
+const getHrefs = ($) => {
+  return $('a').map((i, el) => {
+    const r = $(el).attr('href');
+    if (r) {
+      const absolute = new URL(r, baseUrl).href;
+      // skip references to elsewhere and blank anchors
+      if (absolute.startsWith(baseUrl) && !absolute.endsWith('#')) return absolute;
+    }
+  }).get();
+}
+
+
+const s2 = async () => {
+  const umap = new Map();
+  const uset = new Set()
+  while (queue.length) {
+
+    const url = queue.shift();
+    console.log('working on url', url)
+    const $ = await getNextCheer(url);
+    debugPageStructure($);
+
+    // get all the hrefs
+    getHrefs($).forEach(f => {
+      // so a url could have an anchor for a method so we need to strip that out
+      const u = new URL(f);
+      const method = u.hash.substring(1);
+      const classUrl = u.origin + '/' + u.pathname
+      const methodUrl = u.href
+      if (!umap.has(classUrl)) {
+        umap.set(classUrl, {
+          parents: new Map(),
+          classUrl,
+          methods: new Map()
+        })
+        console.log ('pushing', classUrl)
+        queue.push (classUrl)
+      }
+      const ob = umap.get(classUrl)
+      ob.methods.set(method, { method, methodUrl })
+      ob.parents.set(url, { url })
+      console.log('adding', f)
+    })
+  }
+}
+s2().catch(console.error)

package/package.json

@@ -5,9 +5,9 @@
   "dependencies": {
     "@google-cloud/logging": "^11.2.1",
     "@mcpher/fake-gasenum": "^1.0.2",
-    "@mcpher/unit": "^1.1.11",
     "@sindresorhus/is": "^7.0.1",
     "archiver": "^7.0.1",
+    "exceljs": "^4.4.0",
     "fast-json-stable-stringify": "^2.1.0",
     "get-stream": "^9.0.1",
     "googleapis": "^157.0.0",
@@ -17,56 +17,58 @@
     "keyv": "^5.5.0",
     "keyv-file": "^5.1.3",
     "mime": "^4.0.7",
+    "sinon": "^21.0.0",
     "sleep-synchronously": "^2.0.0",
     "subsume": "^4.0.0",
     "to-readable-stream": "^4.0.0",
-    "unzipper": "^0.12.3"
+    "unzipper": "^0.12.3",
+    "yoctocolors": "^2.1.2"
   },
   "type": "module",
   "scripts": {
-    "test": "cp mainlocal.js main.js && node --env-file=.env ./test/test.js",
-    "testdrive": "cp mainlocal.js main.js && node --env-file=.env ./test/testdrive.js execute",
-    "testsheetsdatavalidations": "cp mainlocal.js main.js && node --env-file=.env ./test/testsheetsdatavalidations.js execute",
-    "testsheetspermissions": "cp mainlocal.js main.js && node --env-file=.env ./test/testsheetspermissions.js execute",
-    "testsheetsvalues": "cp mainlocal.js main.js && node --env-file=.env ./test/testsheetsvalues.js execute",
-    "testsheets": "cp mainlocal.js main.js && node --env-file=.env ./test/testsheets.js execute",
-    "testfetch": "cp mainlocal.js main.js && node --env-file=.env ./test/testfetch.js execute",
-    "testsession": "cp mainlocal.js main.js && node --env-file=.env ./test/testsession.js execute",
-    "testutilities": "cp mainlocal.js main.js && node --env-file=.env ./test/testutilities.js execute",
-    "teststores": "cp mainlocal.js main.js && node --env-file=.env ./test/teststores.js execute",
-    "testscriptapp": "cp mainlocal.js main.js &&  node --env-file=.env ./test/testscriptapp.js execute",
-    "testfiddler": "cp mainlocal.js main.js &&  node --env-file=.env ./test/testfiddler.js execute",
-    "testenums": "cp mainlocal.js main.js &&  node --env-file=.env ./test/testenums.js execute",
-    "testsheetssets": "cp mainlocal.js main.js &&  node --env-file=.env ./test/testsheetssets.js execute",
-    "testsheetsvui": "cp mainlocal.js main.js &&  node --env-file=.env ./test/testsheetsvui.js execute",
-    "testsheetsdeveloper": "cp mainlocal.js main.js &&  node --env-file=.env ./test/testsheetsdeveloper.js execute",
-    "testsheetsexotics": "cp mainlocal.js main.js &&  node --env-file=.env ./test/testsheetsexotics.js execute",
-    "testsheetsdata": "cp mainlocal.js main.js &&  node --env-file=.env ./test/testsheetsdata.js execute",
-    "testdocsadv": "cp mainlocal.js main.js &&  node --env-file=.env ./test/testdocsadv.js execute",
-    "testslidesadv": "cp mainlocal.js main.js &&  node --env-file=.env ./test/testslidesadv.js execute",
-    "testform": "cp mainlocal.js main.js &&  node --env-file=.env ./test/testform.js execute",
-    "testformsadv": "cp mainlocal.js main.js &&  node --env-file=.env ./test/testformsadv.js execute",
-    "testdocs": "cp mainlocal.js main.js &&  node --env-file=.env ./test/testdocs.js execute",
-    "testslides": "cp mainlocal.js main.js &&  node --env-file=.env ./test/testslides.js execute",
-    "testdocsnext": "cp mainlocal.js main.js &&  node --env-file=.env ./test/testdocsnext.js execute",
-    "testsheetstext": "cp mainlocal.js main.js &&  node --env-file=.env ./test/testsheetstext.js execute",
-    "testsheetsrange": "cp mainlocal.js main.js &&  node --env-file=.env ./test/testsheetsrange.js execute",
-    "testdocslistitems": "cp mainlocal.js main.js &&  node --env-file=.env ./test/testdocslistitems.js execute",
-    "testdocsall": "cp mainlocal.js main.js &&  node --env-file=.env ./test/testdocsall.js",
-    "testdocsheaders": "cp mainlocal.js main.js &&  node --env-file=.env ./test/testdocsheaders.js execute",
-    "testdocsfooters": "cp mainlocal.js main.js &&  node --env-file=.env ./test/testdocsfooters.js execute",
-    "testdocsfootnotes": "cp mainlocal.js main.js &&  node --env-file=.env ./test/testdocsfootnotes.js execute",
-    "testdocsimages": "cp mainlocal.js main.js &&  node --env-file=.env ./test/testdocsimages.js execute",
-    "testdocsstyles": "cp mainlocal.js main.js &&  node --env-file=.env ./test/testdocsstyles.js execute",
-    "testsandbox": "cp mainlocal.js main.js &&  node --env-file=.env ./test/testsandbox.js execute",
-    "testgmail": "cp mainlocal.js main.js &&  node --env-file=.env ./test/testgmail.js execute",
-    "testlogger": "cp mainlocal.js main.js &&  node --env-file=.env ./test/testlogger.js execute",
-    "pub": "cp mainlocal.js main.js && npm publish --access public"
+    "test": "cp mainlocal.js main.js && node  ./test/test.js",
+    "testdrive": "cp mainlocal.js main.js && node  ./test/testdrive.js execute",
+    "testsheetsdatavalidations": "cp mainlocal.js main.js && node  ./test/testsheetsdatavalidations.js execute",
+    "testsheetspermissions": "cp mainlocal.js main.js && node  ./test/testsheetspermissions.js execute",
+    "testsheetsvalues": "cp mainlocal.js main.js && node  ./test/testsheetsvalues.js execute",
+    "testsheets": "cp mainlocal.js main.js && node  ./test/testsheets.js execute",
+    "testfetch": "cp mainlocal.js main.js && node  ./test/testfetch.js execute",
+    "testsession": "cp mainlocal.js main.js && node  ./test/testsession.js execute",
+    "testutilities": "cp mainlocal.js main.js && node  ./test/testutilities.js execute",
+    "teststores": "cp mainlocal.js main.js && node  ./test/teststores.js execute",
+    "testscriptapp": "cp mainlocal.js main.js && node ./test/testscriptapp.js execute",
+    "testfiddler": "cp mainlocal.js main.js && node ./test/testfiddler.js execute",
+    "testenums": "cp mainlocal.js main.js && node ./test/testenums.js execute",
+    "testsheetssets": "cp mainlocal.js main.js && node ./test/testsheetssets.js execute",
+    "testsheetsvui": "cp mainlocal.js main.js && node ./test/testsheetsvui.js execute",
+    "testsheetsdeveloper": "cp mainlocal.js main.js && node ./test/testsheetsdeveloper.js execute",
+    "testsheetsexotics": "cp mainlocal.js main.js && node ./test/testsheetsexotics.js execute",
+    "testsheetsdata": "cp mainlocal.js main.js && node ./test/testsheetsdata.js execute",
+    "testdocsadv": "cp mainlocal.js main.js && node ./test/testdocsadv.js execute",
+    "testslidesadv": "cp mainlocal.js main.js && node ./test/testslidesadv.js execute",
+    "testform": "cp mainlocal.js main.js && node ./test/testform.js execute",
+    "testformsadv": "cp mainlocal.js main.js && node ./test/testformsadv.js execute",
+    "testdocs": "cp mainlocal.js main.js && node ./test/testdocs.js execute",
+    "testslides": "cp mainlocal.js main.js && node ./test/testslides.js execute",
+    "testdocsnext": "cp mainlocal.js main.js && node ./test/testdocsnext.js execute",
+    "testsheetstext": "cp mainlocal.js main.js && node ./test/testsheetstext.js execute",
+    "testsheetsrange": "cp mainlocal.js main.js && node ./test/testsheetsrange.js execute",
+    "testdocslistitems": "cp mainlocal.js main.js && node ./test/testdocslistitems.js execute",
+    "testdocsall": "cp mainlocal.js main.js && node ./test/testdocsall.js",
+    "testdocsheaders": "cp mainlocal.js main.js && node ./test/testdocsheaders.js execute",
+    "testdocsfooters": "cp mainlocal.js main.js && node ./test/testdocsfooters.js execute",
+    "testdocsfootnotes": "cp mainlocal.js main.js && node ./test/testdocsfootnotes.js execute",
+    "testdocsimages": "cp mainlocal.js main.js && node ./test/testdocsimages.js execute",
+    "testdocsstyles": "cp mainlocal.js main.js && node ./test/testdocsstyles.js execute",
+    "testsandbox": "cp mainlocal.js main.js && node ./test/testsandbox.js execute",
+    "testgmail": "cp mainlocal.js main.js && node ./test/testgmail.js execute",
+    "testlogger": "cp mainlocal.js main.js && node ./test/testlogger.js execute",
+    "pub": "cp mainlocal.js main.js  && npm publish --access public"
   },
   "name": "@mcpher/gas-fakes",
-  "version": "1.0.21",
+  "version": "1.0.23",
   "license": "MIT",
-  "main": "main.js",
+  "main": "main.js && node ",
   "description": "A proof of concept implementation of Apps Script Environment on Node",
   "repository": "github:brucemcpherson/gas-fakes",
   "homepage": "https://ramblings.mcpher.com/a-proof-of-concept-implementation-of-apps-script-environment-on-node/"

package/src/index.js

@@ -1,4 +1,9 @@
+import colors from 'yoctocolors'
 import './services/scriptapp/app.js'
+
+import {default as pf } from '../package.json' with { type: 'json' };
+console.log (`You are using ${colors.blueBright(pf.name)} package version ${colors.greenBright(pf.version)}`)
+ScriptApp.__gasFakesVersion = pf.version
 import './services/driveapp/app.js'
 import './services/logger/app.js'
 import './services/urlfetchapp/app.js'
@@ -16,7 +21,3 @@ import './services/documentapp/app.js'
 import './services/advforms/app.js'
 import './services/formapp/app.js'
 import './services/slidesapp/app.js'
-
-// force initilialization of scriptApp - which is always needed
-// scriptapp will always be fake here
-ScriptApp.isFake

package/src/services/logger/fakelogger.js

@@ -23,6 +23,11 @@ export class FakeLogger {
      * @type {string}
      */
     this.__destination = (process.env.LOG_DESTINATION || 'CONSOLE').toUpperCase();
+    this.__startedLoggingAt = new Date()
+    this.__cloudLogLink = 'No cloud logging enabled - use Logger.__logDestination = "CLOUD" or "BOTH" to enable'
+    if (['CLOUD','BOTH'].includes(this.__destination)) {
+      writeToCloudOrConsole("...Initializing cloud logging", this)
+    }
   }
 
   /**
@@ -58,6 +63,7 @@ export class FakeLogger {
     const message = format(formatOrData, ...values);
     this.__log.push(message);
 
+
     // Pass the destination and instance context to the writer function.
     writeToCloudOrConsole(message, this);
 
@@ -81,8 +87,16 @@ export class FakeLogger {
     if (['CONSOLE', 'CLOUD', 'BOTH', 'NONE'].includes(destination.toUpperCase())) {
       this.__destination = destination.toUpperCase();
     }
+    // we need to send a logger message to initialize and test
+    this.log (`...setting destination to ${this.__destination}`)
     return this;
   }
+
+  // to allow code compatibility without error on apps script, we should use the setter since it'll be undefined on Apps live Script
+  set __logDestination (destination) {
+    return this.__setLogDestination(destination);
+  }
+
 }
 
 /**
@@ -96,21 +110,23 @@ export const newFakeLogger = (...args) => Proxies.guard(new FakeLogger(...args))
  * @private
  * @param {FakeLogger} loggerInstance The logger instance, to access its destination.
  */
-const writeToCloudOrConsole =  (message, loggerInstance) => {
+const writeToCloudOrConsole = (message, loggerInstance) => {
   const logDestination = loggerInstance.__destination;
   const useConsoleLogging = logDestination === 'CONSOLE' || logDestination === 'BOTH';
   const useCloudLogging = logDestination === 'CLOUD' || logDestination === 'BOTH';
+  const logName = 'gas-fakes/console_logs';
+  const projectId = ScriptApp.__projectId;
+  const scriptId = ScriptApp.getScriptId();
+  const userId = ScriptApp.__userId;
 
   // Lazy-initialize the cloud logger if needed.
   const initializeCloudLogging = () => {
     if (cloudLog) return; // Already initialized.
     try {
-      const projectId = ScriptApp.__projectId;
       if (!projectId) {
         throw new Error('Could not determine Google Cloud Project ID for logging.');
       }
       const logging = new Logging({ projectId });
-      const logName = 'gas-fakes/console_logs';
       cloudLog = logging.log(logName);
       console.info(`gas-fakes: Cloud Logging is enabled, writing to log "${logName}".`);
     } catch (err) {
@@ -145,8 +161,8 @@ const writeToCloudOrConsole =  (message, loggerInstance) => {
       // not running on a specific GCP compute service.
       resource: { type: 'global' },
       labels: {
-        'gas-fakes-scriptId': ScriptApp.getScriptId(),
-        'gas-fakes-userId': ScriptApp.__userId,
+        'gas-fakes-scriptId': scriptId,
+        'gas-fakes-userId': userId,
       },
       jsonPayload: { message: message },
       severity: 'INFO',
@@ -156,7 +172,36 @@ const writeToCloudOrConsole =  (message, loggerInstance) => {
     // his allows us to catch errors, such as a disabled API or permission issues.
     // however we are firing and forgetting so an error might appear later on in execution
     if (cloudLog) {
-      cloudLog.write(cloudLog.entry(metadata)).catch(err=> console.error('gas-fakes: Failed to write to Cloud Logging.', err.message))
+      // filter on user/script/priject and run times
+      // we'll extend the end date filter to a little more than now
+      const aLittleMore = 7 * 1000
+      const endDate = new Date(new Date().getTime() + aLittleMore)
+      const startDate = loggerInstance.__startedLoggingAt
+
+      const base = `https://console.cloud.google.com/logs/query;`
+
+      // B. Build the RAW LQL Filter String (NO "query=" prefix here)
+      const lqlParts = [
+        // LogName filter
+        `logName="projects/${projectId}/logs/${logName.replace('/', '%2F')}"`,
+        // Labels filter
+        ...Object.keys(metadata.labels).map(k => `jsonPayload.labels.${k}="${metadata.labels[k]}"`),
+        // Date filter (recommended for query stability)
+        `timestamp>="${startDate.toISOString()}"`,
+        `timestamp<="${endDate.toISOString()}"`
+      ];
+      const fullLQLQuery = lqlParts.join(' AND ');
+
+      // C. Encode ONLY the filter content, then prepend the literal 'query='
+      const encodedQueryParam = `query=${encodeURIComponent(fullLQLQuery)}`;
+
+      // D. Create the timeRange parameter (correct casing)
+      const timeRangeParam = `;timeRange=${startDate.getTime()}/${endDate.getTime()}`;
+
+      // E. Assemble the final URL
+      loggerInstance.__cloudLogLink = base + encodedQueryParam + `?project=${projectId}`;
+      // fire and forget
+      cloudLog.write(cloudLog.entry(metadata)).catch(err => console.error('gas-fakes: Failed to write to Cloud Logging.', err.message))
     }
   }
-};
+};

package/src/services/spreadsheetapp/fakeovergridimage.js

@@ -0,0 +1,47 @@
+import { Proxies } from "../../support/proxies.js";
+
+/**
+ * create a new FakeOverGridImage instance
+ * @param  {...any} args
+ * @returns {FakeOverGridImage}
+ */
+export const newFakeOverGridImage = (...args) => {
+  return Proxies.guard(new FakeOverGridImage(...args));
+};
+
+/**
+ * basic fake FakeOverGridImage
+ * @class FakeOverGridImage
+ */
+export class FakeOverGridImage {
+  /**
+   * @constructor
+   * @param {Sheet} sheet
+   * @param {Object} obj
+   * @returns {FakeOverGridImage}
+   */
+  constructor(sheet, obj) {
+    this.sheet = sheet;
+    this.object = obj;
+  }
+
+  getAnchorCell() {
+    return this.sheet.getRange(this.object.row + 1, this.object.col + 1);
+  }
+
+  getAnchorCellXOffset() {
+    return this.object.anchorCellXOffset;
+  }
+
+  getAnchorCellYOffset() {
+    return this.object.anchorCellYOffset;
+  }
+
+  getWidth() {
+    return this.object.width;
+  }
+
+  getHeight() {
+    return this.object.height;
+  }
+}

package/src/services/spreadsheetapp/fakesheet.js

@@ -13,6 +13,10 @@ import { FakeTextFinder, newFakeTextFinder } from "./faketextfinder.js";
 
 import { newFakeNamedRange } from "./fakenamedrange.js";
 import { newFakeProtection } from "./fakeprotection.js";
+import { newFakeOverGridImage } from "./fakeovergridimage.js";
+
+import { Syncit } from "../../support/syncit.js";
+// import ExcelJS from "exceljs"; // When test_getImages() is used, use this.
 
 const { is, isEnum } = Utils;
 
@@ -35,7 +39,7 @@ export class FakeSheet {
       "insertChart",
       "removeChart",
       "updateChart",
-      "getImages",
+      // "getImages",
       "insertImage",
       "removeImage",
       // "getNamedRanges",
@@ -1063,6 +1067,30 @@ export class FakeSheet {
     return [];
   }
 
+  // This function is used for testing getImages without a worker.
+  // async test_getImages() {
+  //   const url = `https://docs.google.com/spreadsheets/export?exportFormat=xlsx&id=${
+  //     this.__parent.__meta.spreadsheetId
+  //   }&access_token=${ScriptApp.getOAuthToken()}`;
+  //   const res = UrlFetchApp.fetch(url);
+  //   const buf = new Uint8Array(res.getBlob()._data).buffer;
+  //   const workbook = new ExcelJS.Workbook();
+  //   await workbook.xlsx.load(buf);
+  //   const worksheet = workbook.worksheets[this.getIndex() - 1];
+  //   const images = worksheet.getImages();
+  //   console.log(images);
+  // }
+
+  getImages() {
+    const url = `https://docs.google.com/spreadsheets/export?exportFormat=xlsx&id=${
+      this.__parent.__meta.spreadsheetId
+    }&access_token=${ScriptApp.getOAuthToken()}`;
+    const idx = this.getIndex() - 1;
+    const ar = Syncit.fxGetImagesFromXlsx({ url, idx });
+    const sheet = this;
+    return ar.map((e) => newFakeOverGridImage(sheet, e));
+  }
+
   __batchUpdate({ spreadsheetId, requests }) {
     return Sheets.Spreadsheets.batchUpdate({ requests }, spreadsheetId);
   }

package/src/support/sxxlsx.js

@@ -0,0 +1,41 @@
+import got from "got";
+import ExcelJS from "exceljs";
+
+async function __getWorkbook(url) {
+  const res = await got(url, { responseType: "buffer" });
+  let buf;
+  if (res.rawBody && Buffer.isBuffer(res.rawBody)) {
+    buf = res.rawBody;
+  } else if (res.body && Buffer.isBuffer(res.body)) {
+    buf = res.body;
+  } else {
+    throw new Error(res);
+  }
+  const workbook = new ExcelJS.Workbook();
+  await workbook.xlsx.load(buf);
+  return workbook;
+}
+
+export const sxGetImagesFromXlsx = async (_, { url, idx }) => {
+  const workbook = await __getWorkbook(url);
+  const worksheet = workbook.worksheets[idx];
+  const ar = worksheet.getImages().reduce((arr, image) => {
+    const imageId = image.imageId;
+    if (image.range.tl.nativeColOff != 0 && image.range.tl.nativeRowOff != 0) {
+      const col = image.range.tl.nativeCol;
+      const row = image.range.tl.nativeRow;
+      const { width, height } = image.range.ext;
+      arr.push({
+        imageId,
+        row,
+        col,
+        width,
+        height,
+        anchorCellXOffset: image.range.tl.nativeColOff,
+        anchorCellYOffset: image.range.tl.nativeRowOff,
+      });
+    }
+    return arr;
+  }, []);
+  return ar;
+};