@mcpher/gas-fakes 1.0.19 → 1.0.21

package/README.md

@@ -33,15 +33,19 @@ In order to duplicate the OAuth management handled by GAS, we'll use Application
 
 #### Application default credentials
 
-At the very least you need to add the gcp project id you'll be using for testing, plus the id of some file you have access to - this'll be used to check that you have set up ADC properly.
+In order to avoid a bunch of Node specific code and credentials, yet still handle OAuth, I figured that we could simply rely on ADC. This is a problem I already wrote about here [Application Default Credentials with Google Cloud and Workspace APIs](https://ramblings.mcpher.com/application-default-credentials-with-google-cloud-and-workspace-apis/)
+
+At the very least you need to add the gcp project id and optionally the id of some file you have access to - this'll be used to check that you have set up ADC properly.
 
-There are other things in the .env-template you can ignore unless you're planning to run the test suite. More information on that is in [collaborators info](collaborators.md)
+#### Your .env file
 
+You can setup the .env file your self using the .env.template as a guide.
 
-These should be in your .env file to enable ADC authentication. The purpose of the DRIVE_TEST_FILE_ID is so that the script can check you've enabled ADC correctly by pinging a file you have access to. The GCP_PROJECT_ID is required as it will be used by gas-fakes to access the workspace apis on your behalf.
 ```
 # must set these
 GCP_PROJECT_ID="add your gcp project id here"
+
+# optional reference if you want to run a test after setting up
 DRIVE_TEST_FILE_ID="add the id of some test file you have access to here"
 
 # we'll use the default config for application default credentials
@@ -50,31 +54,13 @@ AC=default
 # these are the scopes set by default - take some of these out if you want to minimize access
 DEFAULT_SCOPES="https://www.googleapis.com/auth/userinfo.email,openid,https://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/sqlservice.login"
 EXTRA_SCOPES=",https://www.googleapis.com/auth/drive,https://www.googleapis.com/auth/spreadsheets"
+ 
+# optional logging destination
+# can be CONSOLE (default), CLOUD, BOTH, NONE
+LOG_DESTINATION="BOTH"
 
 ```
 
-- goto ./shells and execute sp.sh
-
-### OAuth
-
-There's 2 pieces to this solution.
-
-#### Application default credentials (ADC)
-
-In order to avoid a bunch of Node specific code and credentials, yet still handle OAuth, I figured that we could simply rely on ADC. This is a problem I already wrote about here [Application Default Credentials with Google Cloud and Workspace APIs](https://ramblings.mcpher.com/application-default-credentials-with-google-cloud-and-workspace-apis/)
-
-This section in your env file controls which scopes you plan to use.
-
-```
-we'll use the default config for application default credentials
-AC=default
-# these are the scopes set by default - take some of these out if you want to minimize access
-DEFAULT_SCOPES="https://www.googleapis.com/auth/userinfo.email,openid,https://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/sqlservice.login"
-EXTRA_SCOPES=",https://www.googleapis.com/auth/drive,https://www.googleapis.com/auth/spreadsheets"
-
-.....etc
-```
-
 #### Manifest file
 
 If you have an associated apps script project, you'll probably be using clasp to sync with the apps script IDE, and you'll have an appsscript.json available in your project folder
@@ -111,6 +97,53 @@ Optionally, gasfakes.json holds various location and behavior parameters to info
 | properties | string | /tmp/gas-fakes/properties        | gas-fakes uses a local file to emulate apps script's PropertiesService. This is where it should put the files. You may want to put it somewhere other than /tmp to avoid accidental deletion, but don't put it in a place that'll get commited to public git repo                        |
 | scriptId   | string | from clasp, or some random value | If you have a clasp file, it'll pick up the scriptId from there. If not you can enter your scriptId manually, or just leave it to create a fake one. It's use for the moment is to return something useful from ScriptApp.getScriptId() and to partition the cache and properties stores |
 
+
+
+### Cloud Logging Integration
+
+`gas-fakes` emulates the native Google Apps Script `Logger.log()` integration with Google Cloud Logging, allowing you to send structured logs from your local Node.js environment directly to your Google Cloud project. Note that console.log is the normal Node console and writes to the local console only. All messages from gas-fakes api still go to the console, so the Logger.log is for your own user messages as required.
+
+#### Initial Configuration
+
+The initial logging behavior is controlled by the `LOG_DESTINATION` environment variable in your `.env` file.
+
+| `LOG_DESTINATION` | Behavior |
+|---|---|
+| `CONSOLE` (Default) | Logs structured JSON to the console (`stdout`). This is the default behavior if the variable is not set. |
+| `CLOUD` | Sends logs directly to Google Cloud Logging. Nothing is written to the console. |
+| `BOTH` | Sends logs to both Google Cloud Logging and the console. |
+| `NONE` | Disables all output from `Logger.log()`. |
+
+When logging to the cloud, entries are sent to the `gas-fakes/console_logs` log name and include the following labels for easy filtering in the Log Explorer:
+- `gas-fakes-scriptId`
+- `gas-fakes-userId`
+
+#### 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.
+
+The method accepts one of the following string values: `'CONSOLE'`, `'CLOUD'`, `'BOTH'`, or `'NONE'`.
+
+#### Example Usage
+
+To set the initial destination, modify your `.env` file:
+```
+LOG_DESTINATION="BOTH"
+```
+
+To change the destination during runtime in your script:
+```javascript
+// Initially logs to BOTH (from .env)
+Logger.log('This goes to console and cloud');
+
+// Switch to only logging to the console
+Logger.__setLogDestination('CONSOLE');
+Logger.log('This now only goes to the console');
+
+// Disable logging completely
+Logger.__setLogDestination('NONE');
+Logger.log('This goes nowhere');
+```
 ### 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
@@ -120,16 +153,15 @@ There are a couple of syntactical differences between Node and Apps Script. Not
 // this required on Node but not on Apps Script
 if (ScriptApp.isFake) testFakes()
 ````
-For inspiration on pushing modified files to the IDE, see the [bash script](https://github.com/brucemcpherson/gas-fakes/blob/main/togas.bash) I use for the test suite. 
-
-
+For inspiration on pushing modified files to the IDE, see the togas.sh bash script I use for the test suite. 
 
 ## 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](mailto:bruce@mcpher.com) and we'll talk.
+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.
 
 ## Translations and writeups
 
+
 - [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/)
@@ -144,4 +176,5 @@ As I mentioned earlier, to take this further, I'm going to need a lot of help to
 - [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)
+- [sandbox](sandbox.md)
+- [named range identity](named-range-identity.md)

package/gasmess/bruce/pbx.js

@@ -5,6 +5,58 @@ import { report, scl } from './dreport.js';
 
 
 const suffix = "-bruce"
+const tli = () => {
+  let doc = DocumentApp.create("abc")
+  const id = doc.getId()
+  moveToTempFolder(id, suffix)
+  let body = doc.getBody();
+  let li = body.appendListItem("Initial list item text.");
+
+  doc = scl(doc)
+  let d = Docs.Documents.get(id)
+  console.log('after append item', doc.getBody().getNumChildren())
+  console.log(JSON.stringify(d.body.content))
+
+  body = doc.getBody()
+  li = body.getChild(1)
+  li.clear();
+
+  doc = scl(doc)
+  d = Docs.Documents.get(id)
+  console.log('after clear', doc.getBody().getNumChildren())
+  console.log(JSON.stringify(d.body.content))
+
+  body = doc.getBody()
+  li = body.getChild(1)
+  li.setText("New text after clear.");
+  doc = scl(doc)
+  d = Docs.Documents.get(id)
+  console.log('after new text', doc.getBody().getNumChildren())
+  console.log(JSON.stringify(d.body.content))
+
+  body = doc.getBody()
+  li = body.getChild(1)
+  li.setText("Image test: "); // setText returns void, so we can't chain.
+
+  doc = scl(doc)
+  d = Docs.Documents.get(id)
+  console.log('after image text', doc.getBody().getNumChildren())
+  console.log(JSON.stringify(d.body.content))
+
+
+  const imageUrl = 'https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png';
+  const imageBlob = UrlFetchApp.fetch(imageUrl).getBlob();
+  body = doc.getBody()
+  li = body.getChild(1)
+  li.appendInlineImage(imageBlob.copyBlob());
+
+  console.log('after inlinr image', doc.getBody().getNumChildren())
+  console.log(JSON.stringify(d.body.content))
+
+  deleteTempFile(id)
+
+}
+tli()
 
 const tx2 = () => {
   let doc = DocumentApp.create("abc")
@@ -34,7 +86,6 @@ const tx2 = () => {
   deleteTempFile(id)
 }
 
-tx2()
 const tx1 = () => {
   let doc = DocumentApp.create("abc")
   const id = doc.getId()
@@ -53,7 +104,7 @@ const tx1 = () => {
 
   deleteTempFile(id)
 }
-tx1()
+
 const tabsa = () => {
 
   let doc = DocumentApp.create("abc")

package/gprompts/gas-inventory.js

@@ -0,0 +1,92 @@
+import got from 'got';
+import * as cheerio from 'cheerio';
+import fs from 'fs/promises';
+import { URL } from 'url';
+
+const baseUrl = "https://developers.google.com/apps-script/reference/"
+const outputFile = './gas-inventory.json';
+
+const visited = new Map();
+const queue = [baseUrl]
+
+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: {},
+    };
+
+    $('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
+          })
+        }
+      }
+    });
+
+    // 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();
+
+          if (methodName) {
+            inventory[serviceName].classes[className].methods[methodName] = {
+              link: methodLink ? new URL(methodLink, url).href : '',
+              returns: {
+                type: returnType,
+                link: '' // to be extracted later
+              }
+            };
+          }
+        });
+      }
+    });
+  }
+
+  await fs.writeFile(outputFile, JSON.stringify(inventory, null, 2));
+  console.log(`Inventory saved to ${outputFile}`);
+}
+
+scrape().catch(console.error);

package/gprompts/gas-inventory.json

@@ -0,0 +1,176 @@
+{
+  "Forms Service": {
+    "name": "Forms Service",
+    "link": "https://developers.google.com/apps-script/reference/forms",
+    "classes": {
+      "Classes": {
+        "methods": {},
+        "properties": {}
+      },
+      "Alignment": {
+        "methods": {},
+        "properties": {}
+      },
+      "CheckboxGridItem": {
+        "methods": {},
+        "properties": {}
+      },
+      "CheckboxGridValidation": {
+        "methods": {},
+        "properties": {}
+      },
+      "CheckboxGridValidationBuilder": {
+        "methods": {},
+        "properties": {}
+      },
+      "CheckboxItem": {
+        "methods": {},
+        "properties": {}
+      },
+      "CheckboxValidation": {
+        "methods": {},
+        "properties": {}
+      },
+      "CheckboxValidationBuilder": {
+        "methods": {},
+        "properties": {}
+      },
+      "Choice": {
+        "methods": {},
+        "properties": {}
+      },
+      "DateItem": {
+        "methods": {},
+        "properties": {}
+      },
+      "DateTimeItem": {
+        "methods": {},
+        "properties": {}
+      },
+      "DestinationType": {
+        "methods": {},
+        "properties": {}
+      },
+      "DurationItem": {
+        "methods": {},
+        "properties": {}
+      },
+      "FeedbackType": {
+        "methods": {},
+        "properties": {}
+      },
+      "Form": {
+        "methods": {},
+        "properties": {}
+      },
+      "FormApp": {
+        "methods": {},
+        "properties": {}
+      },
+      "FormResponse": {
+        "methods": {},
+        "properties": {}
+      },
+      "GridItem": {
+        "methods": {},
+        "properties": {}
+      },
+      "GridValidation": {
+        "methods": {},
+        "properties": {}
+      },
+      "GridValidationBuilder": {
+        "methods": {},
+        "properties": {}
+      },
+      "ImageItem": {
+        "methods": {},
+        "properties": {}
+      },
+      "Item": {
+        "methods": {},
+        "properties": {}
+      },
+      "ItemResponse": {
+        "methods": {},
+        "properties": {}
+      },
+      "ItemType": {
+        "methods": {},
+        "properties": {}
+      },
+      "ListItem": {
+        "methods": {},
+        "properties": {}
+      },
+      "MultipleChoiceItem": {
+        "methods": {},
+        "properties": {}
+      },
+      "PageBreakItem": {
+        "methods": {},
+        "properties": {}
+      },
+      "PageNavigationType": {
+        "methods": {},
+        "properties": {}
+      },
+      "ParagraphTextItem": {
+        "methods": {},
+        "properties": {}
+      },
+      "ParagraphTextValidation": {
+        "methods": {},
+        "properties": {}
+      },
+      "ParagraphTextValidationBuilder": {
+        "methods": {},
+        "properties": {}
+      },
+      "QuizFeedback": {
+        "methods": {},
+        "properties": {}
+      },
+      "QuizFeedbackBuilder": {
+        "methods": {},
+        "properties": {}
+      },
+      "RatingIconType": {
+        "methods": {},
+        "properties": {}
+      },
+      "RatingItem": {
+        "methods": {},
+        "properties": {}
+      },
+      "ScaleItem": {
+        "methods": {},
+        "properties": {}
+      },
+      "SectionHeaderItem": {
+        "methods": {},
+        "properties": {}
+      },
+      "TextItem": {
+        "methods": {},
+        "properties": {}
+      },
+      "TextValidation": {
+        "methods": {},
+        "properties": {}
+      },
+      "TextValidationBuilder": {
+        "methods": {},
+        "properties": {}
+      },
+      "TimeItem": {
+        "methods": {},
+        "properties": {}
+      },
+      "VideoItem": {
+        "methods": {},
+        "properties": {}
+      }
+    }
+  }
+}

package/gprompts/inventory-list.json

@@ -0,0 +1 @@
+["forms"]

package/gprompts/model.json

@@ -0,0 +1,34 @@
+{
+  "name": "Document Service",
+  "link": "https://developers.google.com/apps-script/reference/document",
+  "classes": {
+    "DocumentApp": {
+      "methods": {
+        "create": {
+          "link": "https://developers.google.com/apps-script/reference/document/document-app#create(String)",
+          "returns": {
+            "type": "Document",
+            "link": "https://developers.google.com/apps-script/reference/document/document"
+          }
+        },
+        "properties": {
+          "Attribute": {
+            "type": "Attribute",
+            "link": "https://developers.google.com/apps-script/reference/document/attribute"
+            }
+          }
+        },
+        "Bookmark": {
+          "methods": {
+            "getId": {
+              "link": "https://developers.google.com/apps-script/reference/document/bookmark#getId()",
+              "returns": {
+                "type": "String",
+                "link": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String"
+              }
+            }
+          }
+        }
+      }
+    }
+  }