@mcpher/gas-fakes 1.0.11 → 1.0.13

package/README.md

@@ -6,7 +6,7 @@ This is a proof of concept so I've implemented a subset of number of services an
 
 ## progress
 
-This is a pretty huge task, so I'm working on adding services a little bit at a time, with usually just a few methods added in each release.
+This is a pretty huge task, so I'm working on adding services a little bit at a time, with usually just a few methods added in each release. I'm using this readme to report not just on how to use this thing, but also on challenges and things I've learned along the way. So it's going to get pretty long.
 
 ## Getting started
 
@@ -18,10 +18,18 @@ npm i @mcpher/gas-fakes
 
 The idea is that you can run GAS services (so far implemented) locally on Node, and it will use various Google Workspace APIS to emulate what would happen if you were to run the same thing in the GAS environment. Other than logging in with application default credentials (see below) you don't have to do any intitialization and can start using the implemented Apps Script services directly from Node using the same syntax and getting equivalent responses.
 
+### Use exactly the same code as in Apps Script
+
 Just as on Apps Script, everything is executed synchronously so you don't need to bother with handling Promises/async/await. Note that the intended audience is Apps Script developers who want to run the same code and access the same services in both Node and Apps Script.
 
+### Where to use (and not use)
+
 If you don't plan on using Apps Script at all, the Node Workspace APIs (which I use in the background for all these services in any case) will be more efficient when operating in their normal asynchronous mode. On the other hand, if you only casually want to access workspace resources from Node, and can't be bothered digging into how the Node Workspace APIs work, you could still use this as part of your node project. Apps Script services are much simpler than the full API. Apps Script advanced services are also available via gas-fakes if you want a hybrid solution.
 
+### Development schedule
+
+As a background project I'm chipping away at this when I can. There's a mountain of work to do, and I'm not that bothered about the general order I do it in. If you would specifically like some service or method prioritized, let me know and I'll see if I can push it forward. Better still, if you'd like to have a crack at implementing it yourself, let me know and I'll get you started.
+
 ### Cloud project
 
 You don't have access to the GAS maintained cloud project, so you'll need to create a GCP project to use locally. In order to duplicate the OAuth management handled by GAS, we'll use Application Default Credentials.
@@ -71,6 +79,10 @@ TEST_SHEET_NAME="sharedlibraries"
 PUBLIC_SHARE_FILE_ID="1OFJk38kW9TRrEf-B9F1gTZk2uLV-ZSpR"
 SHARED_FILE_ID="1uz4cxEDxtQzu0cBb1B4h6fsjgWy7hNFf"
 PDF_ID="1v5kJ5SOY2nu3DI1LKwALb3seaBpF3kWu"
+SCRATCH_VIEWER="viewer@mcpher.com"
+SCRATCH_EDITOR="editor@mcpher.com"
+SCRATCH_B_VIEWER="viewer2@mcpher.com"
+SCRATCH_B_EDITOR="editor2@mcpher.com"
 
 # these are parameters for testing
 MIN_ROOT_PDFS=20
@@ -160,9 +172,30 @@ Beyond that, implementation is just a lot of busy work. If you are interested, h
 
 Although Apps Script supports async/await/promise syntax, it operates in blocking mode. I didn't really want to have to insist on async coding in code targeted at GAS, so I needed to find a way to emulate what the GAS environment probably does.
 
-Since asynchonicity is fundamental to Node, there's no real simple way to convert async to sync. However, there is such a thing as a [child-process](https://nodejs.org/api/child_process.html#child-process) which you can start up to run things, and it features an [execSync](https://nodejs.org/api/child_process.html#child_processexecsynccommand-options) method which delays the return from the child process until the promise queue is all settled. So the simplest solution is to run an async method in a child process, wait till it's done, and return the results synchronously. I found that [Sindre Sorhus](https://github.com/sindresorhus) uses this approach with [make-synchronous](https://github.com/sindresorhus/make-synchronous), so I'm using that.
+Since asynchonicity is fundamental to Node, there's no real simple way to convert async to sync. However, there is such a thing as a [child-process](https://nodejs.org/api/child_process.html#child-process) which you can start up to run things, and it features an [execSync](https://nodejs.org/api/child_process.html#child_processexecsynccommand-options) method which delays the return from the child process until the promise queue is all settled. So the simplest solution is to run an async method in a child process, wait till it's done, and return the results synchronously. I found that [Sindre Sorhus](https://github.com/sindresorhus) uses this approach with [make-synchronous](https://github.com/sindresorhus/make-synchronous).However, runnng up a child process in Node is pretty expensive and slow, and each subprocess has to reimport the google apis and go through a reauth chain which can take up to 1.5 secs per call.
+
+#### Worker Update
+
+I'm now upgrading to use a worker thread to handle all activities that need to be performed synchronously. It's a lot more tricky to implement and handle exceptions, but worth the effort.
+
+- The worker thread only needs to be authed once on initialization and retains state between each call.
+- Control to shared memory is via [Node Atomics](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Atomics) which gives a mutex style control.
+- Node has built in [worker threads](https://nodejs.org/api/worker_threads.html), so there's no need for any external libraries
+- Only arguments that can be stringified can be passed to and from a worker - but this is the same limitiation as passing arguments to a subprocess
+- To avoid grabbing too much shared memory,I use a temporary file to pass huge amounts of data - but this will be a rarish exception.
+- There are lot of async gotchas with workers so your async handling needs to be very precise. I spent a lot of time trying to track down potentially unsettled promises only to discover that worker.unref() is required to prevent the worker from stopping the main process exiting.
+- console.log doesnt work reliable in a worker, even if you redirect the workers stdout & stder
 
-Runnng up a child process in Node is pretty expensive and slow, so I'll be looking for ways to speed that up when I get to it.
+```js
+worker.stdout.pipe(process.stdout);
+worker.stderr.pipe(process.stderr);
+```
+
+This is because console.log is async, and never shows. You need a sync version of console.log - as implemented in `./src/support/workersync/synclogger`
+
+The result is a dramatic speed up over the subprocess approach (x5). So much so, that I had to add exponential backup to the worker threads to overcome quota limits on the workspace APIS to be able to run the test suite. Having said that it is still very much slower (x4 but variable) than most of the same calls in Apps Script - which appears to feature some mixture of in memory shadowing, caching and api call bundling - which I don't intend to mimic in this fake enironment (for now anyway) as this is not about improving the speed of Apps Script but about emulating it.
+
+It's additionally slowed down because there are an unnatural amount of rapid, consecutive calls in the test suite which means that we get an unnatural amount of delay waiting for a quota window (sometimes as much as 15 seconds) added due to exponential back off delays when running the full test suite (I assume Apps script doesn't have the same quota restrictions). In normal operation this is unlikely to be problem.
 
 ### Global intialization
 
@@ -170,7 +203,7 @@ This was a little problematic to sequence, but I wanted to make sure that any GA
 
 Only a subset of methods are currently available for some of them - the rest are work in progress. My approach is to start with a little bit of each service to prove feasibility and provide a base to build on.
 
-v1.0.10
+v1.0.13
 
 - `DriveApp` - 50%
 - `ScriptApp` - almost all
@@ -184,7 +217,11 @@ v1.0.10
 - `Blob` - all
 - `User` - all
 - `Drive (Advanced Service)` - 40%
-- `Sheets (Advanced Service)` - 40%
+- `Sheets (Advanced Service)` - 60%
+- `Slides (Advanced Service)` - 2%
+- `Docs (Advanced Service)` - 75%
+- `DocumentApp` - 10%
+- `SlidesApp` - placeholder
 
 ### Testing coverage
 
@@ -238,7 +275,7 @@ In the main, these will be slight differences in error message text, which I'll
 
 ### Tradeoffs
 
-I've come across various Apps Script bugs/issues as I work through this which I've reported to the GAS team, and added workarounds in the gas fakes code - not sure at this point whether to duplicate the buggy behavior or simulate what would seem to be the correct one. This is not a complete list, so any things you come across please use the issues in the repo to report. 
+I've come across various Apps Script bugs/issues as I work through this which I've reported to the GAS team, and added workarounds in the gas fakes code - not sure at this point whether to duplicate the buggy behavior or simulate what would seem to be the correct one. This is not a complete list, so any things you come across please use the issues in the repo to report.
 
 ## Oddities
 
@@ -734,6 +771,110 @@ In the Apps Script DataValidation builder, setting showCustomUi is achieved via
 
 Despite the various defaults, a missing value for these properties returned via the Sheets API always means false, and a missing displayStyle with showCustomUi set to true default is "ARROW".
 
+### Document API
+
+Getting started on the advanced services of the Document API. These notes are for my TIL (things I learned today), but may be useful if you are digging into the Document API yourself.
+
+#### Tabs
+
+Tabs are a recent addition to Docs, and have added a bit of complication to handling Document responses. Here's what they say happens.
+
+```
+[docs](https://developers.google.com/workspace/docs/api/reference/rest/v1/documents/get)
+
+suggestionsViewMode	- enum (SuggestionsViewMode)
+
+The suggestions view mode to apply to the document. This allows viewing the document with all suggestions inline, accepted or rejected. If one is not specified, DEFAULT_FOR_CURRENT_ACCESS is used.
+
+includeTabsContent	- boolean
+
+Whether to populate the Document.tabs field instead of the text content fields like body and documentStyle on Document.
+
+When True: Document content populates in the Document.tabs field instead of the text content fields in Document.
+
+When False: The content of the document's first tab populates the content fields in Document excluding Document.tabs. If a document has only one tab, then that tab is used to populate the document content. Document.tabs will be empty.
+```
+
+It's actually a little more complicated than that - here are the properties of the each response variation.
+
+##### case 1 {includeTabsContent: false}
+
+{ r1k:
+
+r2k:
+[ 'suggestionsViewMode',
+'documentId',
+'tabs',
+'title',
+'revisionId' ],
+r3k:
+[ 'title',
+'body',
+'namedStyles',
+'revisionId',
+'documentId',
+'suggestionsViewMode',
+'documentStyle' ] }
+14:09:40 Info { r1b: [ 'content' ],
+r2b: [ 'documentTab', 'tabProperties' ],
+r3b: [ 'content' ],
+r2tb: [ 'documentStyle', 'body', 'namedStyles' ] }
+
+Response has these properties:
+
+```
+     'revisionId',
+     'documentStyle',
+     'body',
+     'title',
+     'suggestionsViewMode',
+     'documentId',
+     'namedStyles'
+```
+
+The body contains just 1 property - `content`
+
+##### case 2 {includeTabsContent: true}
+
+Response has these properties:
+
+```
+    'suggestionsViewMode',
+    'documentId',
+    'tabs',
+    'title',
+    'revisionId'
+```
+
+The tabs property is an array of tabs, the first of which contains these properties
+
+```
+  documentTab, tabProperties
+```
+
+The documentTab has these properties - so the tab[0] in a document with no tabs isn't exactly the same as the legacy style as implied in the docs, since the document metadata is not repeated in each tab.  
+````
+  'documentStyle', 'body', 'namedStyles'
+````
+The tab properties has these properties
+````
+  'tabId', 'title', 'index'
+````
+
+##### case 3 - default
+
+Response includes thes same keys as case 1. As an aside, the property orders are all unpredictable so you can't just compare stringified versions of the response.
+
+```
+  'title',
+  'body',
+  'namedStyles',
+  'revisionId',
+  'documentId',
+  'suggestionsViewMode',
+  'documentStyle'
+```
+
 ### Enums
 
 All Apps Script enums are imitated using a seperate class 'newFakeGasenum()'. A complete write up of that is in [fakegasenum](https://github.com/brucemcpherson/fakegasenum). The same functionality is also available as an Apps Script library if you'd like to make your own enums over on GAS just like you find in Apps Script.
@@ -742,7 +883,6 @@ All Apps Script enums are imitated using a seperate class 'newFakeGasenum()'. A
 
 Sometime between v144 and v150 of googleapis library, it appeared to become mandatory to include the project id in the auth pattern for API clients. Since we get the project id from the ADC, we actually have to do double auths. One to get the project id (which is async), and another to get an auth with the scopes required for the sheets, drive etc client (which is not async). All this now taken care of during the init phase, so look at an existing getauthenticated client function for how if you are adding a new service,
 
-
 ## Some experiences with using Gemini code assist
 
 I tried using Gemini to generate the code and test cases for a number of method types. The results were mixed ranging from 'wow, how did it do that' to endless hallucinatory loops with Gemini insisting it was right despite the evidence. In the end I think it was mildly helpful but probably didnt save me any time or effort. It was just a different kind of effort.
@@ -751,10 +891,9 @@ Another annoyance is after deep sessions of back and forwards, code assist is ge
 
 I also dislike the habit gemini has of 'mansplaining' back to me the answer I've just provided to correct some of it's code.
 
-
 #### range.banding
 
-This was a fairly convoluted section. I used gemini code assist heavily on this to do the legwork and all in all it made a pretty decent job of it, although with the endlessly repeated updates and test refactoring it took longer from start to finish than I would have expected it to take had I done it from scratch manually as all the previous classes. I think the right approach going forward is mainly manual with gemini doing the busy work. The tests Gemini came up with were aldo far from exhaustive, and pretty much ignored edge cases, so it needed additional requests to add more robust tests. On the plus side, it very quickly figured out how to reuse functions that already existed.
+This was a fairly convoluted section. I used gemini code assist heavily on this to do the legwork and all in all it made a pretty decent job of it, although with the endlessly repeated updates and test refactoring it took longer from start to finish than I would have expected it to take had I done it from scratch manually as all the previous classes. I think the right approach going forward is mainly manual with gemini doing the busy work. The tests Gemini came up with were also far from exhaustive, and pretty much ignored edge cases, so it needed additional requests to add more robust tests. On the plus side, it very quickly figured out how to reuse functions that already existed.
 
 #### developer meta data
 
@@ -796,10 +935,11 @@ The Sheets API doesn't know about these, so all r1c1 style methods such as setFo
 
 I'm torn. On the one hand, it's been great at doing busy work like writing test cases and detecting dependencies that I might otherwise have missed. It can often be pretty good at refactoring/renaming things. On the other hand, if it gets it wrong, it's very hard to get it back on track as it tries bury itself deeper and deeper into previous misconceptions. It also has huge difficulty in updating large files no matter the detailed guidance. The usual end game is to restart a fresh context and/or copy and paste the content into a file you create manually.
 
-There were ocassions when the content Gemini provided content to be copied and pasted that was invalid syntax, or worse, dropped lines of code in sections it didn't plan to make any changes. In particular, code that had something like `ob[method](args)` was regularily truncated to just `ob`
+There were ocassions when the content Gemini provided content to be copied and pasted that was invalid syntax, or worse, dropped lines of code in sections it didn't plan to make any changes. In particular, code that had something like `ob[method](args)` was regularily truncated to just `obmethod`. I've found that if you enter `ob[method](args)` in the code assist chat window it will also interpret it as `obmethod` unless you escape the brackets (which of course you wouldnt do in code).
 
-Overall it saves some time, for sure. However, the result is often suboptimal, wordy, lacking in reusability and not something I would be be happy to put my name to. From a coder perspective, the role becomes one of repetetive specification, debugging, checking and testing, while failing to develop a deep understanding of the work in hand. I like coding, so from a satisfaction perspective, I'm not entirely convinced yet. I've found it's very impressive when creating small, standalone scripts but deteriorates rapidly both in speed and effectiveness as the codebase and dependencies grows. There's a point at which it becomes more trouble than it's worth.
+Another issue is that Gemini can take 10 mins or more to create the full content for a large class in its chat window, sometimes ending in the gray screen of death. I've found it's best to completely avoid using Gemini to make minor changes, but to just make them manually.
 
+Overall it saves some time, for sure. However, the result is often suboptimal, wordy, lacking in reusability and not something I would be be happy to put my name to. From a coder perspective, the role becomes one of repetetive specification, debugging, checking and testing, while failing to develop a deep understanding of the work in hand. I like coding, so from a satisfaction perspective, I'm not entirely convinced yet. I've found it's very impressive when creating small, standalone scripts but deteriorates rapidly both in speed and effectiveness as the codebase and dependencies grows. There's a point at which it becomes more trouble than it's worth.
 
 ## Testing
 

package/package.json

@@ -38,10 +38,13 @@
     "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",
+    "testdocs": "cp mainlocal.js main.js &&  node --env-file=.env ./test/testdocs.js execute",
     "pub": "cp mainlocal.js main.js && npm publish --access public"
   },
   "name": "@mcpher/gas-fakes",
-  "version": "1.0.11",
+  "version": "1.0.13",
   "license": "MIT",
   "main": "main.js",
   "description": "A proof of concept implementation of Apps Script Environment on Node",

package/src/index.js

@@ -6,4 +6,7 @@ import './services/spreadsheetapp/app.js'
 import './services/stores/app.js'
 import './services/session/app.js'
 import './services/advdrive/app.js'
-import './services/advsheets/app.js'
+import './services/advsheets/app.js'
+import './services/advdocs/app.js'
+import './services/advslides/app.js'
+import './services/documentapp/app.js'

package/src/services/advdocs/app.js

@@ -0,0 +1,31 @@
+
+/**
+ * the idea here is to create a global entry for the singleton 
+ * before we actually have everything we need to create it. 
+ * We do this by using a proxy, intercepting calls to the 
+ * initial sigleton and diverting them to a completed one
+ */
+import { newFakeAdvDocs } from './fakeadvdocs.js'
+import { Proxies } from '../../support/proxies.js'
+
+// This will eventually hold a proxy for DriveApp
+let _app = null
+
+/**
+ * adds to global space to mimic Apps Script behavior
+ */
+const name = "Docs"
+if (typeof globalThis[name] === typeof undefined) {
+
+  const getApp = () => {
+    // if it hasne been intialized yet then do that
+    if (!_app) {
+      _app = newFakeAdvDocs()
+    }
+    // this is the actual driveApp we'll return from the proxy
+    return _app
+  }
+
+  Proxies.registerProxy (name, getApp)
+
+}

package/src/services/{driveapp/drapis.js → advdocs/docapis.js}

@@ -1,20 +1,20 @@
 import { google } from "googleapis";
 import { Auth } from '../../support/auth.js'
 
-let driveClient = null
+let _client = null
 
 export const getApiClient = (auth) => {
-  if (!driveClient) {
-    driveClient =  google.drive({version: 'v3', auth});
+  if (!_client) {
+    _client =  google.docs({version: 'v1', auth});
   }
-  return driveClient
+  return _client
 }
 
 export const getAuthedClient = () => {
 
-  if (!driveClient) {
+  if (!_client) {
     const auth = Auth.getAuth()
     return getApiClient (auth)
   }
-  return driveClient
-}
+  return _client
+}

package/src/services/advdocs/fakeadvdocs.js

@@ -0,0 +1,33 @@
+/**
+ * Advanced sheets service
+ */
+import { Proxies } from '../../support/proxies.js'
+import { advClassMaker, notYetImplemented } from '../../support/helpers.js'
+import { getAuthedClient } from './docapis.js'
+import { newFakeAdvDocuments } from './fakeadvdocuments.js'
+
+class FakeAdvDocs {
+  constructor() {
+    this.client = Proxies.guard(getAuthedClient())
+    this.__fakeObjectType = "Docs"
+
+    const propLists = { "newNamedStyles": ["styles"], "newHorizontalRule": ["suggestedDeletionIds", "suggestedInsertionIds", "suggestedTextStyleChanges", "textStyle"], "newUpdateTextStyleRequest": ["fields", "range", "textStyle"], "newCreateHeaderRequest": ["sectionBreakLocation", "type"], "newDeleteHeaderRequest": ["headerId", "tabId"], "newSectionColumnProperties": ["paddingEnd", "width"], "newTableCell": ["content", "endIndex", "startIndex", "suggestedDeletionIds", "suggestedInsertionIds", "suggestedTableCellStyleChanges", "tableCellStyle"], "newBatchUpdateDocumentRequest": ["requests", "writeControl"], "newReplaceAllTextRequest": ["containsText", "replaceText", "tabsCriteria"], "newDeleteContentRangeRequest": ["range"], "newTabsCriteria": ["tabIds"], "newUpdateTableColumnPropertiesRequest": ["columnIndices", "fields", "tableColumnProperties", "tableStartLocation"], "newRequest": ["createFooter", "createFootnote", "createHeader", "createNamedRange", "createParagraphBullets", "deleteContentRange", "deleteFooter", "deleteHeader", "deleteNamedRange", "deleteParagraphBullets", "deletePositionedObject", "deleteTableColumn", "deleteTableRow", "insertInlineImage", "insertPageBreak", "insertSectionBreak", "insertTable", "insertTableColumn", "insertTableRow", "insertText", "mergeTableCells", "pinTableHeaderRows", "replaceAllText", "replaceImage", "replaceNamedRangeContent", "unmergeTableCells", "updateDocumentStyle", "updateParagraphStyle", "updateSectionStyle", "updateTableCellStyle", "updateTableColumnProperties", "updateTableRowStyle", "updateTextStyle"], "newUpdateDocumentStyleRequest": ["documentStyle", "fields", "tabId"], "newCreateParagraphBulletsRequest": ["bulletPreset", "range"], "newBody": ["content"], "newParagraphBorder": ["color", "dashStyle", "padding", "width"], "newDocumentTab": ["body", "documentStyle", "footers", "footnotes", "headers", "inlineObjects", "lists", "namedRanges", "namedStyles", "positionedObjects", "suggestedDocumentStyleChanges", "suggestedNamedStylesChanges"], "newSectionStyle": ["columnProperties", "columnSeparatorStyle", "contentDirection", "defaultFooterId", "defaultHeaderId", "evenPageFooterId", "evenPageHeaderId", "firstPageFooterId", "firstPageHeaderId", "flipPageOrientation", "marginBottom", "marginFooter", "marginHeader", "marginLeft", "marginRight", "marginTop", "pageNumberStart", "sectionType", "useFirstPageHeaderFooter"], "newUpdateParagraphStyleRequest": ["fields", "paragraphStyle", "range"], "newAutoText": ["suggestedDeletionIds", "suggestedInsertionIds", "suggestedTextStyleChanges", "textStyle", "type"], "newPerson": ["personId", "personProperties", "suggestedDeletionIds", "suggestedInsertionIds", "suggestedTextStyleChanges", "textStyle"], "newNamedStyle": ["namedStyleType", "paragraphStyle", "textStyle"], "newInsertInlineImageRequest": ["endOfSegmentLocation", "location", "objectSize", "uri"], "newDocument": ["body", "documentId", "documentStyle", "footers", "footnotes", "headers", "inlineObjects", "lists", "namedRanges", "namedStyles", "positionedObjects", "revisionId", "suggestedDocumentStyleChanges", "suggestedNamedStylesChanges", "suggestionsViewMode", "tabs", "title"], "newInsertTableRequest": ["columns", "endOfSegmentLocation", "location", "rows"], "newEquation": ["suggestedDeletionIds", "suggestedInsertionIds"], "newInsertSectionBreakRequest": ["endOfSegmentLocation", "location", "sectionType"], "newStructuralElement": ["endIndex", "paragraph", "sectionBreak", "startIndex", "table", "tableOfContents"], "newDeleteNamedRangeRequest": ["name", "namedRangeId", "tabsCriteria"], "newInsertPageBreakRequest": ["endOfSegmentLocation", "location"], "newRange": ["endIndex", "segmentId", "startIndex", "tabId"], "newUpdateTableCellStyleRequest": ["fields", "tableCellStyle", "tableRange", "tableStartLocation"], "newPinTableHeaderRowsRequest": ["pinnedHeaderRowsCount", "tableStartLocation"], "newColor": ["rgbColor"], "newInsertTextRequest": ["endOfSegmentLocation", "location", "text"], "newColumnBreak": ["suggestedDeletionIds", "suggestedInsertionIds", "suggestedTextStyleChanges", "textStyle"], "newFootnoteReference": ["footnoteId", "footnoteNumber", "suggestedDeletionIds", "suggestedInsertionIds", "suggestedTextStyleChanges", "textStyle"], "newTableColumnProperties": ["width", "widthType"], "newEndOfSegmentLocation": ["segmentId", "tabId"], "newReplaceImageRequest": ["imageObjectId", "imageReplaceMethod", "tabId", "uri"], "newInsertTableRowRequest": ["insertBelow", "tableCellLocation"], "newUpdateSectionStyleRequest": ["fields", "range", "sectionStyle"], "newTab": ["childTabs", "documentTab", "tabProperties"], "newTextRun": ["content", "suggestedDeletionIds", "suggestedInsertionIds", "suggestedTextStyleChanges", "textStyle"], "newInlineObjectElement": ["inlineObjectId", "suggestedDeletionIds", "suggestedInsertionIds", "suggestedTextStyleChanges", "textStyle"], "newTabStop": ["alignment", "offset"], "newParagraphStyle": ["alignment", "avoidWidowAndOrphan", "borderBetween", "borderBottom", "borderLeft", "borderRight", "borderTop", "direction", "headingId", "indentEnd", "indentFirstLine", "indentStart", "keepLinesTogether", "keepWithNext", "lineSpacing", "namedStyleType", "pageBreakBefore", "shading", "spaceAbove", "spaceBelow", "spacingMode", "tabStops"], "newSubstringMatchCriteria": ["matchCase", "searchByRegex", "text"], "newDeleteTableColumnRequest": ["tableCellLocation"], "newShading": ["backgroundColor"], "newTabProperties": ["index", "nestingLevel", "parentTabId", "tabId", "title"], "newRgbColor": ["blue", "green", "red"], "newSize": ["height", "width"], "newOptionalColor": ["color"], "newDeleteTableRowRequest": ["tableCellLocation"], "newPersonProperties": ["email", "name"], "newBullet": ["listId", "nestingLevel", "textStyle"], "newDimension": ["magnitude", "unit"], "newCreateFootnoteRequest": ["endOfSegmentLocation", "location"], "newPageBreak": ["suggestedDeletionIds", "suggestedInsertionIds", "suggestedTextStyleChanges", "textStyle"], "newCreateNamedRangeRequest": ["name", "range"], "newLink": ["bookmark", "bookmarkId", "heading", "headingId", "tabId", "url"], "newLocation": ["index", "segmentId", "tabId"], "newUpdateTableRowStyleRequest": ["fields", "rowIndices", "tableRowStyle", "tableStartLocation"], "newRichLinkProperties": ["mimeType", "title", "uri"], "newDeleteParagraphBulletsRequest": ["range"], "newBookmarkLink": ["id", "tabId"], "newTableRange": ["columnSpan", "rowSpan", "tableCellLocation"], "newDocumentStyle": ["background", "defaultFooterId", "defaultHeaderId", "evenPageFooterId", "evenPageHeaderId", "firstPageFooterId", "firstPageHeaderId", "flipPageOrientation", "marginBottom", "marginFooter", "marginHeader", "marginLeft", "marginRight", "marginTop", "pageNumberStart", "pageSize", "useCustomHeaderFooterMargins", "useEvenPageHeaderFooter", "useFirstPageHeaderFooter"], "newRichLink": ["richLinkId", "richLinkProperties", "suggestedDeletionIds", "suggestedInsertionIds", "suggestedTextStyleChanges", "textStyle"], "newTableRowStyle": ["minRowHeight", "preventOverflow", "tableHeader"], "newDeleteFooterRequest": ["footerId", "tabId"], "newTableCellStyle": ["backgroundColor", "borderBottom", "borderLeft", "borderRight", "borderTop", "columnSpan", "contentAlignment", "paddingBottom", "paddingLeft", "paddingRight", "paddingTop", "rowSpan"], "newTextStyle": ["backgroundColor", "baselineOffset", "bold", "fontSize", "foregroundColor", "italic", "link", "smallCaps", "strikethrough", "underline", "weightedFontFamily"], "newInsertTableColumnRequest": ["insertRight", "tableCellLocation"], "newMergeTableCellsRequest": ["tableRange"], "newTableRow": ["endIndex", "startIndex", "suggestedDeletionIds", "suggestedInsertionIds", "suggestedTableRowStyleChanges", "tableCells", "tableRowStyle"], "newHeadingLink": ["id", "tabId"], "newParagraphElement": ["autoText", "columnBreak", "endIndex", "equation", "footnoteReference", "horizontalRule", "inlineObjectElement", "pageBreak", "person", "richLink", "startIndex", "textRun"], "newTableOfContents": ["content", "suggestedDeletionIds", "suggestedInsertionIds"], "newTableStyle": ["tableColumnProperties"], "newWriteControl": ["requiredRevisionId", "targetRevisionId"], "newBackground": ["color"], "newTableCellBorder": ["color", "dashStyle", "width"], "newTableCellLocation": ["columnIndex", "rowIndex", "tableStartLocation"], "newWeightedFontFamily": ["fontFamily", "weight"], "newReplaceNamedRangeContentRequest": ["namedRangeId", "namedRangeName", "tabsCriteria", "text"], "newTable": ["columns", "rows", "suggestedDeletionIds", "suggestedInsertionIds", "tableRows", "tableStyle"], "newParagraph": ["bullet", "elements", "paragraphStyle", "positionedObjectIds", "suggestedBulletChanges", "suggestedParagraphStyleChanges", "suggestedPositionedObjectIds"], "newUnmergeTableCellsRequest": ["tableRange"], "newSectionBreak": ["sectionStyle", "suggestedDeletionIds", "suggestedInsertionIds"], "newDeletePositionedObjectRequest": ["objectId", "tabId"], "newCreateFooterRequest": ["sectionBreakLocation", "type"] }
+
+    Reflect.ownKeys(propLists).forEach(p => {
+      this[p] = () => advClassMaker(propLists[p])
+    })
+
+  }
+  toString() {
+    return 'AdvancedServiceIdentifier{name=docs, version=v1}'
+  }
+  getVersion() {
+    return 'v1'
+  }
+  get Documents() {
+    return newFakeAdvDocuments(this)
+  }
+}
+
+export const newFakeAdvDocs = (...args) => Proxies.guard(new FakeAdvDocs(...args))
+

package/src/services/advdocs/fakeadvdocuments.js

@@ -0,0 +1,91 @@
+/**
+ * Advanced docs service
+ */
+
+import { Proxies } from '../../support/proxies.js'
+import {  signatureArgs, ssError } from '../../support/helpers.js'
+import { docsCacher } from '../../support/docscacher.js';
+import { Syncit } from '../../support/syncit.js'
+import is from '@sindresorhus/is'
+import { FakeAdvResource } from '../common/fakeadvresource.js';
+
+/**
+ * the advanced docs Apps Script service faked - Documents class
+ * @class FakeAdvDocuments
+ */
+class FakeAdvDocuments extends FakeAdvResource {
+  constructor(docs) {
+    super(docs, 'documents', Syncit.fxDocs);
+    this.__fakeObjectType = "Docs.Documents";
+  }
+
+  create (resource, options) {
+    const { nargs, matchThrow } = signatureArgs(arguments, "Docs.Documents.create")
+    if (nargs < 1 || nargs > 2) matchThrow('Invalid number of arguments provided. Expected 1-2 only')
+    if (!is.object(resource) || (nargs > 1 && !is.object(options))) {
+      matchThrow("API call to docs.documents.create failed with error: Invalid JSON payload received.")
+    }
+    const { response, data } = this._call("create", {
+      requestBody: resource
+    }, options);
+
+    // maybe we need to throw an error
+    ssError(response, "create")
+
+    return data
+  }
+
+  batchUpdate(requests, documentId) {
+    const { nargs, matchThrow } = signatureArgs(arguments, "Docs.Documents.batchUpdate");
+    if (nargs !== 2) matchThrow('Invalid number of arguments provided. Expected 2 only');
+    if (!is.object(requests) || !is.string(documentId)) {
+      matchThrow("API call to docs.documents.batchUpdate failed with error: Invalid JSON payload received.");
+    }
+
+    // Invalidate the cache for this document since we are updating it.
+    docsCacher.clear(documentId);
+
+    const { response, data } = this._call("batchUpdate", {
+      documentId: documentId,
+      requestBody: requests
+    });
+
+    ssError(response, "batchUpdate");
+
+    return data;
+  }
+
+  /**
+   * often the 2nd options args is for standard gapi params
+   * however in the case of documentid they are actuallly the 2 query parameters
+   * suggestionsViewMode, includeTabsContent
+   * https://developers.google.com/workspace/docs/api/reference/rest/v1/documents/get
+   * @param {} documentId 
+   * @param {*} options 
+   * @returns 
+   */
+  get(documentId, options) {
+    const { nargs, matchThrow } = signatureArgs(arguments, "Docs.Documents.get");
+    if (nargs < 1 || nargs > 2) matchThrow('Invalid number of arguments provided. Expected 1-2 only');
+    if (!is.string(documentId) || (nargs > 1 && !is.object(options))) {
+      matchThrow("API call to docs.documents.get failed with error: Invalid JSON payload received.");
+    }
+    const optionsSet = new Set(["suggestionsViewMode", "includeTabsContent"]);
+
+    if (nargs === 2 && !Reflect.ownKeys(options || {}).every(f => optionsSet.has(f))) matchThrow();
+
+    const params = { documentId, ...(options || {}) };
+    const cachedData = docsCacher.getEntry(documentId, options || {});
+    if (cachedData) {
+      return cachedData;
+    }
+
+    const { response, data } = this._call("get", params);
+    ssError(response, 'get');
+
+    docsCacher.setEntry(documentId, options || {}, data);
+    return data;
+  }
+}
+
+export const newFakeAdvDocuments = (...args) => Proxies.guard(new FakeAdvDocuments(...args))

package/src/services/advdrive/app.js

@@ -8,7 +8,7 @@
 import { newFakeAdvDrive} from './fakeadvdrive.js'
 import { Proxies } from '../../support/proxies.js'
 
-// This will eventually hold a proxy for DriveApp
+
 let _app = null
 
 /**

package/src/services/advdrive/drapis.js

@@ -0,0 +1,11 @@
+import { google } from "googleapis";
+import { Auth } from '../../support/auth.js'
+
+export const getApiClient = (auth) => {
+  return google.drive({ version: 'v3', auth });
+}
+
+export const getAuthedClient = () => {
+  const auth = Auth.getAuth()
+  return getApiClient(auth)
+}

package/src/services/advdrive/fakeadvdrive.js

@@ -3,11 +3,11 @@
  */
 import { Proxies } from '../../support/proxies.js'
 import { notYetImplemented } from '../../support/helpers.js'
-import { getAuthedClient } from '../driveapp/drapis.js'
+import { getAuthedClient } from './drapis.js'
 import { newFakeAdvDriveAbout } from './fakeadvdriveabout.js'
 import { newFakeAdvDriveFiles } from './fakeadvdrivefiles.js';
 import { newFakeAdvDriveApps } from './fakeadvdriveapps.js'
-import { newFakeDrivePermissions } from './fakeadvdrivepermissions.js'
+import { newFakeAdvDrivePermissions } from './fakeadvdrivepermissions.js'
 
 /**
  * the advanced Drive Apps Script service faked
@@ -55,7 +55,7 @@ class FakeAdvDrive {
     )
   }
   get Permissions() {
-    return newFakeDrivePermissions(this)
+    return newFakeAdvDrivePermissions(this)
   }
   get Replies() {
     return notYetImplemented()

package/src/services/advdrive/fakeadvdrivepermissions.js

@@ -1,36 +1,56 @@
+import { Proxies } from '../../support/proxies.js';
+import { notYetImplemented, signatureArgs } from '../../support/helpers.js';
+import { FakeAdvResource } from '../common/fakeadvresource.js';
+import { Syncit } from '../../support/syncit.js';
 
-import { Syncit } from '../../support/syncit.js'
-import { checkResponse } from '../../support/filecache.js';
-import { mergeParamStrings } from '../../support/utils.js';
-import { notYetImplemented,  minPermissionFields } from '../../support/helpers.js'
-import { Proxies } from '../../support/proxies.js'
-
-class FakeAdvDrivePermissions {
+class FakeAdvDrivePermissions extends FakeAdvResource {
   constructor(drive) {
-    this.drive = drive
-    this.apiProp = "permissions"
-    this.__fakeObjectType ="Drive.Permissions"
-  }
-  create() {
-    return notYetImplemented('create')
-  }
-  delete() {
-    return notYetImplemented('delete')
+    // The service name is 'permissions', and it uses the main Drive sync method.
+    super(drive, 'permissions', Syncit.fxDrive);
+    this.__fakeObjectType = "Drive.Permissions";
+
+    const props = ['get', 'update'];
+    props.forEach(f => {
+      if (!this[f]) {
+        this[f] = () => notYetImplemented(f);
+      }
+    });
   }
-  get() {
-    return notYetImplemented('get')
+
+  create(resource, fileId, optionalArgs) {
+    const { nargs, matchThrow } = signatureArgs(arguments, "Drive.Permissions.create");
+    if (nargs < 2 || nargs > 3) matchThrow();
+
+    const params = {
+      resource,
+      fileId,
+      ...(optionalArgs || {})
+    };
+    const { data } = this._call('create', params);
+    return data;
   }
-  list(fileId, params = {}) {
-    params = { ...params, fileId }
-    params.fields = mergeParamStrings(params.fields || "", `permissions(${minPermissionFields})`)
-    const { response, data } = Syncit.fxDrive({ prop: this.apiProp, method: 'list', params })
-    // maybe we need to throw an error
-    checkResponse(fileId, response, false)
-    return data
+
+  delete(fileId, permissionId, optionalArgs) {
+    const { nargs, matchThrow } = signatureArgs(arguments, "Drive.Permissions.delete");
+    if (nargs < 2 || nargs > 3) matchThrow();
+
+    const params = {
+      fileId,
+      permissionId,
+      ...(optionalArgs || {})
+    };
+    // Delete returns an empty body on success, so we don't need to return anything.
+    this._call('delete', params);
   }
-  update() {
-    return notYetImplemented('update')
+
+  list(fileId, optionalArgs) {
+    const { nargs, matchThrow } = signatureArgs(arguments, "Drive.Permissions.list");
+    if (nargs < 1 || nargs > 2) matchThrow();
+
+    const params = { fileId, ...(optionalArgs || {}) };
+    const { data } = this._call('list', params);
+    return data;
   }
 }
 
-export const newFakeDrivePermissions = (...args) => Proxies.guard(new FakeAdvDrivePermissions(...args))
+export const newFakeAdvDrivePermissions = (...args) => Proxies.guard(new FakeAdvDrivePermissions(...args));

package/src/services/advsheets/app.js

@@ -1,4 +1,4 @@
-// fake Apps Script DriveApp
+
 /**
  * the idea here is to create a global entry for the singleton 
  * before we actually have everything we need to create it. 
@@ -8,7 +8,7 @@
 import { newFakeAdvSheets } from './fakeadvsheets.js'
 import { Proxies } from '../../support/proxies.js'
 
-// This will eventually hold a proxy for DriveApp
+
 let _app = null
 
 /**