@mcpher/gas-fakes 1.0.18 → 1.0.19

package/.aiexclude

@@ -0,0 +1,6 @@
+testongas
+gaslibtests
+gasmess
+node_modules
+shells
+README.RU.md

package/gasmess/bruce/pbx.js

@@ -2,8 +2,58 @@ import '../../main.js';
 import { moveToTempFolder, deleteTempFile } from '../tempfolder.js';
 import { report, scl } from './dreport.js';
 
+
+
 const suffix = "-bruce"
 
+const tx2 = () => {
+  let doc = DocumentApp.create("abc")
+  const id = doc.getId()
+  moveToTempFolder(id, suffix)
+
+  let body = doc.getBody()
+
+  const p1 = body.appendParagraph("p1")
+  doc = scl(doc)
+  let d = Docs.Documents.get(id)
+  console.log(JSON.stringify(d))
+  
+  const attributesToSet = {
+    [DocumentApp.Attribute.HORIZONTAL_ALIGNMENT]: DocumentApp.HorizontalAlignment.CENTER,
+    [DocumentApp.Attribute.ITALIC]: true,
+    [DocumentApp.Attribute.FONT_FAMILY]: 'Comic Sans MS'
+  };
+
+  body = doc.getBody()
+  body.setAttributes(attributesToSet);
+  doc = scl(doc)
+  d = Docs.Documents.get(id)
+  console.log(JSON.stringify(d))
+
+
+  deleteTempFile(id)
+}
+
+tx2()
+const tx1 = () => {
+  let doc = DocumentApp.create("abc")
+  const id = doc.getId()
+  moveToTempFolder(id, suffix)
+
+
+
+  const body = doc.getBody();
+  const paraText = "p1";
+
+  const appendedPara = body.appendParagraph(paraText);
+  const paraToTest = body.getChild(1);
+  doc = scl(doc)
+  console.log(report(Docs.Documents.get(id, { includeTabsContent: true }), `\n1.empty document`))
+  const attributes = paraToTest.getAttributes();
+
+  deleteTempFile(id)
+}
+tx1()
 const tabsa = () => {
 
   let doc = DocumentApp.create("abc")
@@ -11,11 +61,11 @@ const tabsa = () => {
   moveToTempFolder(id, suffix)
 
   let body = doc.getBody()
-  console.log (body)
+  console.log(body)
   doc = scl(doc)
-  console.log(report(Docs.Documents.get(id, {includeTabsContent: true}), `\n1.empty document`))
+  console.log(report(Docs.Documents.get(id, { includeTabsContent: true }), `\n1.empty document`))
+
 
-  
   deleteTempFile(id)
 }
 
@@ -70,7 +120,7 @@ const pbnew = () => {
   console.log(report(Docs.Documents.get(id), `\n4.inserted para 2`))
 
   body = doc.getBody()
-  body.insertTable(1, [['eboo', 'fbar']]  )
+  body.insertTable(1, [['eboo', 'fbar']])
   doc = scl(doc)
   console.log(report(Docs.Documents.get(id), `\nt4.inserted table at child 1`))
 
@@ -81,12 +131,12 @@ const pbnew = () => {
 
   body = doc.getBody()
   let c = body.getChild(2)
-  c.appendText( 'p2 appended text')
+  c.appendText('p2 appended text')
   doc = scl(doc)
   console.log(report(Docs.Documents.get(id), `\n6.appended text to para 2`))
 
   body = doc.getBody()
-  body.insertTable(3, [['bar', 'foo'], ['barfoo', 'foobar'], ['eboo', 'fbar']]  )
+  body.insertTable(3, [['bar', 'foo'], ['barfoo', 'foobar'], ['eboo', 'fbar']])
   doc = scl(doc)
   console.log(report(Docs.Documents.get(id), `\nt6.inserted table at child 3`))
 
@@ -107,7 +157,7 @@ const pbnew = () => {
   console.log(report(Docs.Documents.get(id), `\n9.inserted page break in para 3`))
 
   body = doc.getBody()
-  c=body.getChild(3)
+  c = body.getChild(3)
   c.appendText('after pagebreak in 3')
   doc = scl(doc)
   console.log(report(Docs.Documents.get(id), `\n10.inserted text after pagebreak in 3`))
@@ -120,7 +170,7 @@ const pbnew = () => {
   deleteTempFile(id)
 }
 
-pbnew()
+
 
 
 

package/gasmess/bruce/sorting.js

@@ -0,0 +1,106 @@
+
+/**
+ * Compares two values using Google Sheets' ascending sort logic.
+ * @param {*} a first value to compare
+ * @param {*} b second value to compare
+ * @returns {number} a<b: -1, a===b: 0, a>b: 1
+ */
+const compareMixedValues = (a, b) => {
+  const isBlankA = (a === null || a === undefined || a === "");
+  const isBlankB = (b === null || b === undefined || b === "");
+
+  // Handle blanks - always sorted to the top in this ascending comparator
+  if (isBlankA && !isBlankB) return -1;
+  if (!isBlankA && isBlankB) return 1;
+  if (isBlankA && isBlankB) return 0;
+
+  // Get type priorities (lower number = sorts first)
+  const getTypePriority = (val) => {
+    // Correct Google Sheets ascending priority
+    if (typeof val === 'number') return 1;
+    if (typeof val === 'string') return 2;
+    if (typeof val === 'boolean') return 3;
+    if (val instanceof Date) return 4;
+    return 5;
+  };
+
+  const priorityA = getTypePriority(a);
+  const priorityB = getTypePriority(b);
+
+  // If different types, sort by type priority
+  if (priorityA !== priorityB) {
+    return priorityA < priorityB ? -1 : 1;
+  }
+
+  // Same types - compare values
+  if (typeof a === 'number' && typeof b === 'number') {
+    return a - b;
+  }
+  if (typeof a === 'string' && typeof b === 'string') {
+    return a.localeCompare(b, undefined, { sensitivity: 'base', numeric: true });
+  }
+  if (typeof a === 'boolean' && typeof b === 'boolean') {
+    return (a === b) ? 0 : (a ? 1 : -1); 
+  }
+  if (a instanceof Date && b instanceof Date) {
+    return a.getTime() - b.getTime();
+  }
+
+  // Fallback for other types
+  const strA = String(a);
+  const strB = String(b);
+  return strA.localeCompare(strB, undefined, { sensitivity: 'base' });
+};
+// ... your sort2d function remains correct, just pass the 'ascending' flag to compareMixedValues.
+export const sort2d = (spec, arr) => {
+  const deepCopy = arr.map(row => [...row]);
+  return deepCopy.sort((a, b) => {
+    for (const s of spec) {
+      const index = (typeof s === 'object' && s !== null) ? s.column - 1 : s - 1;
+      const ascending = (typeof s === 'object' && s !== null) ? s.ascending !== false : true;
+      let result = compareMixedValues(a[index], b[index]);
+      if (!ascending) {
+          result = -result;
+      }
+      if (result !== 0) {
+          return result;
+      }
+    }
+    return 0;
+  });
+};
+
+// Test function to verify behavior
+export const testSorting = (spec) => {
+  const testData = [
+    [false, 120, 'cheese', 'peach', 'armpit', 10],
+    ['kiwi', 'orange', 'apple', 'bub ble', 'bucket', 'armpit'],
+    ['plum', 'butter', 'buckle', 'grape', 65, 65],
+    [false, "", 'armpit', 'orange', 21, 'buckle'],
+    ['cherry', 'foo', 'butter', 21, 'red eye', 'foo'],
+    ['kiwi', 77, false, 'banana', 'red eye', 'apple'],
+    ['buckle', 'bar', 'foo', 21, 10, 'foo'],
+    ['bub ble', 65, 'butter', 'buckle', 'bub ble', null],
+    ['cheese', 'pear', 'pear', 77, 10, 'foo'],
+    [
+      'bub ble',
+      'armpit',
+      'melon',
+      'buckle',
+      'red eye',
+      3.141592653589793
+    ],
+    ['pear', false, 0.3963452962629548, 'foo', 'banana', 'plum'],
+    ['cherry', true, 'apple', 'cheese', 'butter', 'peach']
+  ]
+
+  console.log('Original:', testData);
+
+  // Sort by column 2 (booleans) ascending
+  const sorted = sort2d(spec, testData);
+  console.log('Sorted by column 2 (booleans ASC):', sorted);
+
+  return sorted;
+};
+const spec = [1,{column:2 , ascending:false}]
+testSorting(spec)

package/ghissues/issue-formapp-create-title-inconsistency.sh

@@ -0,0 +1,51 @@
+#!/bin/bash
+
+# A shell script to create a GitHub issue for the FormApp.create() title inconsistency.
+
+# Issue title
+TITLE="Discrepancy between FormApp.create(title) and Forms API behavior regarding form title and file name"
+
+# Issue body in markdown
+BODY=$(cat <<'EOF'
+### Summary
+
+There is a significant and counter-intuitive discrepancy between the documented behavior of `FormApp.create(title)` in Google Apps Script and the constraints of the underlying Google Forms API. `FormApp.create(title)` sets the Google Drive *file name* to the provided `title`, but leaves the form's internal title (retrieved by `form.getTitle()`) blank.
+
+This makes it impossible to accurately emulate the Apps Script behavior using the public Forms API, as the API requires a non-empty title for both creation and updates.
+
+### Live Apps Script Behavior
+
+When the following Apps Script code is executed:
+
+```javascript
+function testFormCreation() {
+  const formName = "foo-form";
+  const form = FormApp.create(formName);
+  const id = form.getId();
+  
+  console.log('Internal form title:', form.getTitle()); // Logs: "" (an empty string)
+  
+  const file = DriveApp.getFileById(id);
+  console.log('Drive file name:', file.getName());   // Logs: "foo-form"
+  
+  // cleanup
+  file.setTrashed(true);
+}
+```
+
+The output demonstrates that `FormApp.create()` uses the argument to set the Drive file name, but the form's own title property remains empty.
+
+### The Problem with API Emulation
+
+This behavior is problematic to replicate with the v1 Google Forms API because the `forms.create` method requires a non-empty `info.title`. Attempting to then `batchUpdate` the title to an empty string also fails, as the API rejects an empty title on update.
+
+### Conclusion
+
+This disconnect means it's impossible for developers using the public Forms API to programmatically create a form that exactly matches the state of one created by `FormApp.create()`. This poses a significant challenge for testing and emulation frameworks.
+
+The expected behavior would be for `FormApp.create(title)` to set both the Drive file name and the internal form title, or for the API to allow setting the title to an empty string via an update.
+EOF
+)
+
+# Create the issue using GitHub CLI
+gh issue create --title "$TITLE" --body "$BODY" --label "bug" --label "emulation-accuracy" --label "form-app"

package/ghissues/protection-editors-issue.sh

@@ -0,0 +1,33 @@
+#!/bin/bash
+
+# A shell script to create a GitHub issue for the Protection.getEditors() behavior.
+
+# Issue title
+TITLE="Align Protection.getEditors() behavior with Live Apps Script"
+
+# Issue body in markdown
+BODY=$(cat <<'EOF'
+## Summary
+
+There is a discrepancy between the live Google Apps Script environment and the `gas-fakes` emulation regarding the return value of `Protection.getEditors()` on a newly created protection.
+
+-   **Live Apps Script:** `protection.getEditors().length` returns `0`.
+-   **`gas-fakes` (current):** `protection.getEditors().length` incorrectly returns `1`.
+
+## Live Behavior Details
+
+In the live environment, the owner of a spreadsheet can always edit a protected range or sheet (`protection.canEdit()` returns `true`). However, the owner is **not** automatically included in the explicit list of editors returned by `getEditors()`. This is confirmed by live testing.
+
+## `gas-fakes` Behavior
+
+The `gas-fakes` implementation in `fakeprotection.js` was incorrectly adding the current user (as the owner) to the list of editors upon creation of a new `Protection` object.
+
+## TODO
+
+1.  Modify `fakeprotection.js` to no longer automatically add the owner to the `editors` list when a new protection is created. The `canEdit()` method should still return `true` for the owner.
+2.  Run the full test suite to ensure this change doesn't have unintended side effects and that the `Protection` tests now pass in both environments.
+EOF
+)
+
+# Create the issue using GitHub CLI
+gh issue create --title "$TITLE" --body "$BODY" --label "bug" --label "emulation-accuracy" --label "spreadsheet-app"

package/package.json

@@ -42,6 +42,8 @@
     "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",
@@ -53,14 +55,15 @@
     "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",
     "pub": "cp mainlocal.js main.js && npm publish --access public"
   },
   "name": "@mcpher/gas-fakes",
-  "version": "1.0.18",
+  "version": "1.0.19",
   "license": "MIT",
   "main": "main.js",
   "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/regenerate-progress-reports.sh

@@ -0,0 +1,38 @@
+#!/bin/bash
+ 
+
+# This script contains the prompts to regenerate the progress reports for all services.
+# Execute this script and paste the output to the Gemini agent.
+
+echo "Generating progress report for Docs service..."
+echo "now do https://developers.google.com/apps-script/reference/document into ./progress/Docs.MD"
+
+echo "Generating progress report for Drive service..."
+echo "now do https://developers.google.com/apps-script/reference/drive into ./progress/drive.MD"
+
+echo "Generating progress report for Forms service..."
+echo "now do https://developers.google.com/apps-script/reference/forms into ./progress/forms.MD"
+
+echo "Generating progress report for Slides service..."
+echo "now do https://developers.google.com/apps-script/reference/slides into ./progress/slides.MD"
+
+echo "Generating progress report for Spreadsheet service..."
+echo "now do https://developers.google.com/apps-script/reference/spreadsheet into ./progress/sheets.MD"
+
+echo "Generating progress report for Utilities service..."
+echo "now do https://developers.google.com/apps-script/reference/utilities into ./progress/utilities.MD"
+
+echo "Generating progress report for UrlFetch service..."
+echo "now do https://developers.google.com/apps-script/reference/url-fetch into ./progress/urlFetch.MD"
+
+echo "Generating progress report for Cache service..."
+echo "now do https://developers.google.com/apps-script/reference/cache into ./progress/cache.MD"
+
+echo "Generating progress report for Properties service..."
+echo "now do https://developers.google.com/apps-script/reference/properties into ./progress/properties.MD"
+
+echo "Generating progress report for Script service..."
+echo "now do https://developers.google.com/apps-script/reference/script into ./progress/script.MD"
+
+echo "Generating progress report for Base service..."
+echo "now do https://developers.google.com/apps-script/reference/base into ./progress/base.MD"

package/src/index.js

@@ -4,10 +4,12 @@ import './services/urlfetchapp/app.js'
 import './services/utilities/app.js'
 import './services/spreadsheetapp/app.js'
 import './services/stores/app.js'
-import './services/session/app.js'
+import './services/base/app.js'
 import './services/advdrive/app.js'
 import './services/advsheets/app.js'
 import './services/advdocs/app.js'
 import './services/advslides/app.js'
 import './services/documentapp/app.js'
+import './services/advforms/app.js'
+import './services/formapp/app.js'
 import './services/slidesapp/app.js'

package/src/services/advforms/app.js

@@ -0,0 +1,31 @@
+
+/**
+ * NOTE - Although Apps Script doesnt yet have a Forms advanced service
+ * we're going to funnel everything through here as if there was one.
+ * 
+ */
+import { newFakeAdvForms } from './fakeadvforms.js'
+import { Proxies } from '../../support/proxies.js'
+
+// This will eventually hold a proxy for Formsapp
+let _app = null
+
+/**
+ * adds to global space to mimic Apps Script behavior
+ */
+const name = "Forms"
+if (typeof globalThis[name] === typeof undefined) {
+
+  const getApp = () => {
+    // if it hasne been intialized yet then do that
+    if (!_app) {
+      console.log('...activating proxy for', name)
+      _app = newFakeAdvForms()
+    }
+    // this is the actual formsapp we'll return from the proxy
+    return _app
+  }
+
+  Proxies.registerProxy(name, getApp)
+
+}

package/src/services/advforms/fakeadvforms.js

@@ -0,0 +1,221 @@
+/**
+ * Advanced Forms service
+ */
+import { Proxies } from '../../support/proxies.js';
+import { advClassMaker } from '../../support/helpers.js';
+import { formsCacher } from '../../support/formscacher.js';
+import { newFakeAdvFormsForm } from './fakeadvformsform.js';
+
+class FakeAdvForms {
+  constructor() {
+    this.__fakeObjectType = "Forms"
+
+
+    const propLists = {
+      // Top-level batch update request
+      "newBatchUpdateFormRequest": [
+        "includeFormInResponse",
+        "requests",
+        "writeControl"
+      ],
+      // Individual request types that can be part of a batch update
+      "newCreateItemRequest": [
+        "item",
+        "location"
+      ],
+      "newDeleteItemRequest": [
+        "location"
+      ],
+      "newMoveItemRequest": [
+        "newLocation",
+        "originalLocation"
+      ],
+      "newUpdateFormInfoRequest": [
+        "info",
+        "updateMask"
+      ],
+      "newUpdateItemRequest": [
+        "item",
+        "location",
+        "updateMask"
+      ],
+      "newFormInfo": [
+        "title",
+        "documentTitle",
+        "description"
+      ],
+      "newUpdateSettingsRequest": [
+        "settings",
+        "updateMask"
+      ],
+      "newFormSettings": [
+        "emailCollectionType",
+        "quizSettings"
+      ],
+      "newQuizSettings" : [
+        "isQuiz"
+      ],
+      "newItem": [
+        "description",
+        "imageItem",
+        "item",
+        "itemId",
+        "pageBreakItem",
+        "questionGroupItem",
+        "questionItem",
+        "textItem",
+        "title",
+        "videoItem"
+      ],
+      "newQuestionItem": [
+        "question",
+        "image"
+      ],
+      "newQuestion": [
+        "choiceQuestion",
+        "dateQuestion",
+        "fileUploadQuestion",
+        "grading",
+        "questionId",
+        "ratingQuestion",
+        "required",
+        "rowQuestion",
+        "scaleQuestion",
+        "textQuestion",
+        "timeQuestion"
+      ],
+      "newLocation": [
+        "index"
+      ],
+      "newWriteControl": [
+        "requiredRevisionId",
+        "targetRevisionId"
+      ],
+      // The 'Request' schema itself, which is a oneOf type for batch updates
+      "newRequest": [
+        "createItem",
+        "deleteItem",
+        "moveItem",
+        "updateFormInfo",
+        "updateItem",
+        "updateSettings"
+      ],
+      // Further nested items that are builders
+      "newImageItem": [
+        "image"
+      ],
+      "newPageBreakItem": [], // No direct properties to set
+      "newQuestionGroupItem": [
+        "grid",
+        "image",
+        "questions"
+      ],
+      "newTextItem": [], // No direct properties to set
+      "newVideoItem": [
+        "caption",
+        "video"
+      ],
+      "newImage": [
+        "altText",
+        "contentUri",
+        "properties",
+        "sourceUri"
+      ],
+      "newMediaProperties": [
+        "alignment",
+        "width"
+      ],
+      "newGrid": [
+        "columns",
+        "shuffleQuestions"
+      ],
+      "newChoiceQuestion": [
+        "options",
+        "shuffle",
+        "type"
+      ],
+      "newDateQuestion": [
+        "includeTime",
+        "includeYear"
+      ],
+      "newFileUploadQuestion": [
+        "folderId",
+        "maxFiles",
+        "maxFileSize",
+        "types"
+      ],
+      "newGrading": [
+        "correctAnswers",
+        "generalFeedback",
+        "pointValue",
+        "whenRight",
+        "whenWrong"
+      ],
+      "newRatingQuestion": [
+        "iconType",
+        "ratingScaleLevel"
+      ],
+      "newRowQuestion": [
+        "title"
+      ],
+      "newScaleQuestion": [
+        "high",
+        "highLabel",
+        "low",
+        "lowLabel"
+      ],
+      "newTextQuestion": [
+        "paragraph"
+      ],
+      "newTimeQuestion": [
+        "duration"
+      ],
+      "newCorrectAnswers": [
+        "answers"
+      ],
+      "newCorrectAnswer": [
+        "value"
+      ],
+      "newOption": [
+        "goToAction",
+        "goToSectionId",
+        "image",
+        "isOther",
+        "value"
+      ],
+      "newVideo": [
+        "properties",
+        "youtubeUri"
+      ],
+        
+    }
+
+    Reflect.ownKeys(propLists).forEach(p => {
+      this[p] = () => advClassMaker(propLists[p])
+    })
+
+  }
+  toString() {
+    return 'AdvancedServiceIdentifier{name=forms, version=v1}'
+  }
+
+  getVersion() {
+    return 'v1'
+  }
+
+  get Form() {
+    return newFakeAdvFormsForm(this)
+  }
+  __addAllowed(id) {
+    if (ScriptApp.__behavior.sandBoxMode) {
+      ScriptApp.__behavior.addFile(id);
+    }
+    return id
+  }
+
+  __getFormsPerformance() {
+    return formsCacher.getPerformance()
+  }
+}
+
+export const newFakeAdvForms = (...args) => Proxies.guard(new FakeAdvForms(...args))