@mcpher/gas-fakes 1.2.19 → 1.2.21

package/.clasp.json

@@ -0,0 +1,4 @@
+{
+  "scriptId": "",
+  "rootDir": "./src/"
+}

package/.claspignore

@@ -0,0 +1,6 @@
+# Ignore local development files
+run.js
+node_modules/
+package.json
+package-lock.json
+.gemini/

package/gas-fakes.js

@@ -31,7 +31,7 @@ const VERSION = pjson.version;
 // CONSTANTS & UTILITIES
 // -----------------------------------------------------------------------------
 
-const CLI_VERSION = "0.0.12";
+const CLI_VERSION = "0.0.13";
 const MCP_VERSION = "0.0.3";
 const execAsync = promisify(exec);
 
@@ -475,9 +475,9 @@ async function main() {
         // We check if the command is not one of the others.
         const knownCommands = program.commands.map((cmd) => cmd.name());
         if (!process.argv.slice(2).some((arg) => knownCommands.includes(arg))) {
-          console.error(
-            "Error: You must provide a script via --filename or --script, or use a specific command (e.g., init, auth, mcp)."
-          );
+          // console.error(
+          //   "Error: You must provide a script via --filename or --script, or use a specific command (e.g., init, auth, mcp)."
+          // );
           program.help();
           process.exit(1);
         }

package/package.json

@@ -20,6 +20,7 @@
     "mime": "^4.0.7",
     "prompts": "^2.4.2",
     "sleep-synchronously": "^2.0.0",
+    "tape": "^5.9.0",
     "unzipper": "^0.12.3",
     "zod": "^3.25.76"
   },
@@ -32,7 +33,7 @@
   },
   "name": "@mcpher/gas-fakes",
   "author": "bruce mcpherson",
-  "version": "1.2.19",
+  "version": "1.2.21",
   "license": "MIT",
   "main": "main.js",
   "description": "A proof of concept implementation of Apps Script Environment on Node",

package/run.js

@@ -0,0 +1,35 @@
+import fs from 'fs';
+import path from 'path';
+import vm from 'vm';
+
+// Import gas-fakes to initialize the environment
+import '@mcpher/gas-fakes';
+
+// Create a sandboxed context
+const context = vm.createContext({
+  ScriptApp: global.ScriptApp,
+  console: console,
+  // Add other GAS globals you need here (e.g., DocumentApp, SpreadsheetApp)
+});
+
+// Read the user's script file
+const scriptPath = path.resolve('src/Code.js');
+const scriptCode = fs.readFileSync(scriptPath, 'utf8');
+
+// Run the user's script in the sandbox to define the functions
+vm.runInContext(scriptCode, context);
+
+// Define and run the calling logic to execute a function from the script
+const callingCode = `
+// 1. Enable sandbox mode for safety
+ScriptApp.__behavior.sandBoxMode = true;
+
+// 2. Call the specific function from your Code.js file
+// myFunction();
+
+// 3. Clean up the gas-fakes environment
+ScriptApp.__behavior.trash();
+`;
+
+// vm.runInContext(callingCode, context);
+console.log("Project initialized. Edit run.js to execute a function.");

package/setup.js

@@ -145,17 +145,18 @@ export async function initializeConfiguration(options = {}) {
       type: "text",
       name: "GCP_PROJECT_ID",
       message: "Enter your GCP Project ID",
-      initial: existingConfig.GCP_PROJECT_ID || process.env.GOOGLE_CLOUD_PROJECT,
+      initial:
+        existingConfig.GCP_PROJECT_ID || process.env.GOOGLE_CLOUD_PROJECT,
     },
     {
       type: "text",
       name: "DRIVE_TEST_FILE_ID",
-      message: "Enter a test Drive file ID for authentication checks (optional)",
+      message:
+        "Enter a test Drive file ID for authentication checks (optional)",
       initial: existingConfig.DRIVE_TEST_FILE_ID || "",
     },
   ];
 
-
   const basicInfoResponses = await prompts(basicInfoQuestions);
   if (typeof basicInfoResponses.GCP_PROJECT_ID === "undefined") {
     console.log("Initialization cancelled.");
@@ -176,7 +177,6 @@ export async function initializeConfiguration(options = {}) {
   DEFAULT_SCOPES_VALUES.forEach((scope) => console.log(`  - ${scope}`));
   responses.DEFAULT_SCOPES = DEFAULT_SCOPES_VALUES;
 
-
   const extraScopeQuestion = {
     type: "multiselect",
     name: "EXTRA_SCOPES",
@@ -220,10 +220,11 @@ export async function initializeConfiguration(options = {}) {
         title: "Gmail compose",
         value: "https://www.googleapis.com/auth/gmail.compose",
       },
-
     ].map((scope) => ({
       ...scope,
-      title: scope.sensitivity ? `[${scope.sensitivity}] ${scope.title}` : scope.title,
+      title: scope.sensitivity
+        ? `[${scope.sensitivity}] ${scope.title}`
+        : scope.title,
       // because we always need drive for ant extra scopes
       selected:
         existingExtraScopes.length > 0
@@ -252,15 +253,17 @@ export async function initializeConfiguration(options = {}) {
     selectedExtraScopes.includes(s.value)
   );
 
-
   if (usesSensitiveScopes) {
     console.log("\n--------------------------------------------------");
-    console.log("You have selected sensitive or restricted scopes. Google requires an OAuth client credential file for these.");
-    console.log('See the getting started guide https://github.com/brucemcpherson/gas-fakes/blob/main/GETTING_STARTED.md for how.')
+    console.log(
+      "You have selected sensitive or restricted scopes. Google requires an OAuth client credential file for these."
+    );
+    console.log(
+      "See the getting started guide https://github.com/brucemcpherson/gas-fakes/blob/main/GETTING_STARTED.md for how."
+    );
     console.log("--------------------------------------------------");
   }
 
-
   const clientCredentialQuestion = {
     type: "text",
     name: "CLIENT_CREDENTIAL_FILE",
@@ -306,45 +309,46 @@ export async function initializeConfiguration(options = {}) {
       ? `\n  - Extra:   [${responses.EXTRA_SCOPES.join(", ")}]`
       : "\n  - Extra:   [None]";
 
-  const remainingQuestions = [{
-    type: "toggle",
-    name: "QUIET",
-    message: "Run gas-fakes package in quiet mode",
-    initial: existingConfig.QUIET === "true" ? true : false,
-  },
-  {
-    type: "select",
-    name: "LOG_DESTINATION",
-    message: `Selected Scopes:${defaultScopesDisplay}${extraScopesDisplay}\n\nEnter logging destination`,
-    choices: [
-      { title: "CONSOLE", value: "CONSOLE" },
-      { title: "CLOUD", value: "CLOUD" },
-      { title: "BOTH", value: "BOTH" },
-      { title: "NONE", value: "NONE" },
-    ],
-    initial:
-      ["CONSOLE", "CLOUD", "BOTH", "NONE"].indexOf(
-        existingConfig.LOG_DESTINATION
-      ) > -1
-        ? ["CONSOLE", "CLOUD", "BOTH", "NONE"].indexOf(
+  const remainingQuestions = [
+    {
+      type: "toggle",
+      name: "QUIET",
+      message: "Run gas-fakes package in quiet mode",
+      initial: existingConfig.QUIET === "true" ? true : false,
+    },
+    {
+      type: "select",
+      name: "LOG_DESTINATION",
+      message: `Selected Scopes:${defaultScopesDisplay}${extraScopesDisplay}\n\nEnter logging destination`,
+      choices: [
+        { title: "CONSOLE", value: "CONSOLE" },
+        { title: "CLOUD", value: "CLOUD" },
+        { title: "BOTH", value: "BOTH" },
+        { title: "NONE", value: "NONE" },
+      ],
+      initial:
+        ["CONSOLE", "CLOUD", "BOTH", "NONE"].indexOf(
           existingConfig.LOG_DESTINATION
-        )
-        : 0,
-  },
-  {
-    type: "select",
-    name: "STORE_TYPE",
-    message: "Enter storage type",
-    choices: [
-      { title: "FILE", value: "FILE" },
-      { title: "UPSTASH", value: "UPSTASH" },
-    ],
-    initial:
-      ["FILE", "UPSTASH"].indexOf(existingConfig.STORE_TYPE?.toUpperCase()) >
+        ) > -1
+          ? ["CONSOLE", "CLOUD", "BOTH", "NONE"].indexOf(
+              existingConfig.LOG_DESTINATION
+            )
+          : 0,
+    },
+    {
+      type: "select",
+      name: "STORE_TYPE",
+      message: "Enter storage type",
+      choices: [
+        { title: "FILE", value: "FILE" },
+        { title: "UPSTASH", value: "UPSTASH" },
+      ],
+      initial:
+        ["FILE", "UPSTASH"].indexOf(existingConfig.STORE_TYPE?.toUpperCase()) >
         -1
-        ? ["FILE", "UPSTASH"].indexOf(existingConfig.STORE_TYPE.toUpperCase())
-        : 0,
-  }
+          ? ["FILE", "UPSTASH"].indexOf(existingConfig.STORE_TYPE.toUpperCase())
+          : 0,
+    },
   ];
 
   const remainingResponses = await prompts(remainingQuestions);
@@ -406,16 +410,22 @@ export async function initializeConfiguration(options = {}) {
   }
 
   // --- File Writing Logic ---
-  console.log(`Writing configuration to ${envPath}...`);
-  const inits = responses.STORE_TYPE !== "UPSTASH" ? { UPSTASH_REDIS_REST_TOKEN: "", UPSTASH_REDIS_REST_URL: "" } : {}
+  console.log(`Writing configuration to "${envPath}"...`);
+  const inits =
+    responses.STORE_TYPE !== "UPSTASH"
+      ? { UPSTASH_REDIS_REST_TOKEN: "", UPSTASH_REDIS_REST_URL: "" }
+      : {};
   const finalConfig = { ...existingConfig, ...responses, ...inits };
 
-  const envContent = Reflect.ownKeys(finalConfig).map((key) => {
-
-    const item = finalConfig[key];
-        console.log (key, item)
-    return `${key}="${(item.toString() || "").trim()}"`;
-  }).join("\n")
+  console.log("\n------------------ Final output ------------------");
+  const envContent = Reflect.ownKeys(finalConfig)
+    .map((key) => {
+      const item = finalConfig[key];
+      const res = `${key}="${(item.toString() || "").trim()}"`;
+      console.log(res);
+      return res;
+    })
+    .join("\n");
   /* replacing this to include existing values
     let envContent = `
   # Google Cloud Project ID (required)

package/src/Code.js

@@ -0,0 +1,3 @@
+function myFunction() {
+  console.log('Hello from Google Apps Script!');
+}

package/src/appsscript.json

@@ -0,0 +1,5 @@
+{
+  "dependencies": {},
+  "exceptionLogging": "STACKDRIVER",
+  "runtimeVersion": "V8"
+}

package/src/services/advforms/fakeadvforms.js

@@ -42,7 +42,8 @@ class FakeAdvForms {
       "newFormInfo": [
         "title",
         "documentTitle",
-        "description"
+        "description",
+        "state"
       ],
       "newUpdateSettingsRequest": [
         "settings",

package/src/services/advforms/fakeadvformsform.js

@@ -4,6 +4,7 @@ import { signatureArgs, ssError, gError } from '../../support/helpers.js';
 
 import { Proxies } from '../../support/proxies.js';
 import { Utils } from '../../support/utils.js';
+import { newFakeResponses } from './fakeresponses.js';
 const { is } = Utils
 
 export const newFakeAdvFormsForm = (...args) => Proxies.guard(new FakeAdvFormsForm(...args))
@@ -13,6 +14,17 @@ class FakeAdvFormsForm extends FakeAdvResource {
     super(mainService, 'forms', Syncit.fxForms);
     this.forms = mainService;
     this.__fakeObjectType = 'Forms.Forms';
+    this.__responses = null;
+  }
+
+  /**
+   * @returns {import('./fakeresponses.js').FakeResponses}
+   */
+  get Responses() {
+    if (!this.__responses) {
+      this.__responses = newFakeResponses(this);
+    }
+    return this.__responses;
   }
 
   /**

package/src/services/advforms/fakeresponses.js

@@ -0,0 +1,30 @@
+import { Proxies } from '../../support/proxies.js';
+import { Utils } from '../../support/utils.js';
+
+export const newFakeResponses = (...args) => {
+  return Proxies.guard(new FakeResponses(...args));
+};
+
+/**
+ * @class FakeResponses
+ * @see https://developers.google.com/forms/api/reference/rest/v1/forms.responses
+ */
+export class FakeResponses {
+  constructor(mainService) {
+    this.forms = mainService;
+    this.__fakeObjectType = 'Forms.Responses';
+  }
+
+  /**
+   * Lists the responses of a form.
+   * @param {string} formId The form's ID.
+   * @returns {{responses: object[]}} A list of responses.
+   */
+  list(formId) {
+    // this.forms is the FakeAdvFormsForm instance, which has the _call method
+    // from FakeAdvResource to interact with the syncit data source.
+    // We use subProp to specify the nested 'responses' object, following the library's pattern.
+    const { data } = this.forms._call('list', { formId }, null, 'responses');
+    return data || { responses: [] };
+  }
+}

package/src/services/formapp/fakecheckboxgriditem.js

@@ -0,0 +1,105 @@
+import { Proxies } from '../../support/proxies.js';
+import { FakeFormItem } from './fakeformitem.js';
+import { registerFormItem } from './formitemregistry.js';
+import { signatureArgs } from '../../support/helpers.js';
+import { Utils } from '../../support/utils.js';
+import { ItemType } from '../enums/formsenums.js';
+
+export const newFakeCheckboxGridItem = (...args) => {
+  return Proxies.guard(new FakeCheckboxGridItem(...args));
+};
+
+/**
+ * @class FakeCheckboxGridItem
+ * A fake for the CheckboxGridItem class in Apps Script.
+ * @see https://developers.google.com/apps-script/reference/forms/checkbox-grid-item
+ */
+export class FakeCheckboxGridItem extends FakeFormItem {
+  constructor(form, itemId) {
+    super(form, itemId);
+  }
+
+  /**
+   * Gets the values for every column in the grid.
+   * @returns {string[]} an array of column values
+   */
+  getColumns() {
+    const choiceQuestion = this.__resource.questionGroupItem?.grid?.columns;
+    if (!choiceQuestion || !choiceQuestion.options) {
+      return [];
+    }
+    return choiceQuestion.options.map(option => option.value);
+  }
+
+  /**
+   * Gets the values for every row in the grid.
+   * @returns {string[]} an array of row values
+   */
+  getRows() {
+    const questions = this.__resource.questionGroupItem?.questions;
+    if (!questions) {
+      return [];
+    }
+    return questions.map(question => question.rowQuestion?.title || null).filter(f => f);
+  }
+
+  /**
+   * Sets the columns of the grid based on an array of values.
+   * @param {string[]} columns an array of column values
+   * @returns {FakeCheckboxGridItem} this item, for chaining
+   */
+  setColumns(columns) {
+    const { nargs, matchThrow } = signatureArgs(arguments, 'CheckboxGridItem.setColumns');
+    if (nargs !== 1 || !Utils.is.array(columns) || !columns.every(Utils.is.string)) {
+      matchThrow('Invalid arguments: expected a string array.');
+    }
+    if (columns.length === 0) {
+      throw new Error('The array of columns cannot be empty.');
+    }
+
+    const updatedResource = JSON.parse(JSON.stringify(this.__resource));
+    updatedResource.questionGroupItem.grid.columns.options = columns.map(c => ({ value: c }));
+
+    const updateRequest = Forms.newRequest().setUpdateItem({
+      item: updatedResource,
+      location: { index: this.getIndex() },
+      updateMask: 'questionGroupItem.grid.columns.options',
+    });
+
+    return this.__update(updateRequest);
+  }
+
+  /**
+   * Sets the rows of the grid based on an array of values.
+   * @param {string[]} rows an array of row values
+   * @returns {FakeCheckboxGridItem} this item, for chaining
+   */
+  setRows(rows) {
+    const { nargs, matchThrow } = signatureArgs(arguments, 'CheckboxGridItem.setRows');
+    if (nargs !== 1 || !Utils.is.array(rows) || !rows.every(Utils.is.string)) {
+      matchThrow('Invalid arguments: expected a string array.');
+    }
+    if (rows.length === 0) {
+      throw new Error('The array of rows cannot be empty.');
+    }
+
+    const updatedResource = JSON.parse(JSON.stringify(this.__resource));
+    updatedResource.questionGroupItem.questions = rows.map(r => ({
+      rowQuestion: { title: r },
+    }));
+
+    const updateRequest = Forms.newRequest().setUpdateItem({
+      item: updatedResource,
+      location: { index: this.getIndex() },
+      updateMask: 'questionGroupItem.questions',
+    });
+
+    return this.__update(updateRequest);
+  }
+
+  toString() {
+    return 'CheckboxGridItem';
+  }
+}
+
+registerFormItem(ItemType.CHECKBOX_GRID, newFakeCheckboxGridItem);

package/src/services/formapp/fakecheckboxitem.js

@@ -1,5 +1,5 @@
 import { Proxies } from '../../support/proxies.js';
-import { FakeFormItem } from './fakeformitem.js';
+import { FakeChoiceItem } from './fakechoiceitem.js';
 import { signatureArgs } from '../../support/helpers.js';
 import { Utils } from '../../support/utils.js';
 const { is } = Utils;
@@ -16,7 +16,7 @@ export const newFakeCheckboxItem = (...args) => {
  * A fake for the CheckboxItem class in Apps Script.
  * @see https://developers.google.com/apps-script/reference/forms/checkbox-item
  */
-export class FakeCheckboxItem extends FakeFormItem {
+export class FakeCheckboxItem extends FakeChoiceItem {
   /**
    * @param {import('./fakeform.js').FakeForm} form The parent form.
    * @param {string} itemId The ID of the item.
@@ -25,114 +25,6 @@ export class FakeCheckboxItem extends FakeFormItem {
     super(form, itemId);
   }
 
-  /**
-   * Creates a new choice for this item.
-   * @param {string} value The value of the choice.
-   * @param {boolean} [isCorrect] Whether the choice is correct.
-   * @returns {import('./fakechoice.js').FakeChoice} The new choice.
-   */
-  createChoice(value, isCorrect) {
-    const { nargs, matchThrow } = signatureArgs(arguments, 'CheckboxItem.createChoice');
-    if (nargs < 1 || nargs > 2 || !is.string(value) || (nargs === 2 && !is.boolean(isCorrect))) {
-      matchThrow('Invalid arguments');
-    }
-    // For now, navigation is not supported.
-    return newFakeChoice(value, isCorrect || false, null, null);
-  }
-
-  /**
-   * Gets the choices for this item.
-   * @returns {import('./fakechoice.js').FakeChoice[]} An array of Choice objects.
-   */
-  getChoices() {
-    const choiceQuestion = this.__resource.questionItem?.question?.choiceQuestion;
-    if (!choiceQuestion || !choiceQuestion.options) {
-      return [];
-    }
-    return choiceQuestion.options.map(option => {
-      return newFakeChoice(option.value, false, null, null);
-    });
-  }
-
-  /**
-   * Sets the choices for this item.
-   * @param {import('./fakechoice.js').FakeChoice[]} choices An array of Choice objects.
-   * @returns {FakeCheckboxItem} This item, for chaining.
-   */
-  setChoices(choices) {
-    const { nargs, matchThrow } = signatureArgs(arguments, 'CheckboxItem.setChoices');
-    if (nargs !== 1 || !is.array(choices) || !choices.every(c => c.toString() === 'Choice')) {
-      matchThrow('Invalid arguments: expected an array of Choice objects.');
-    }
-
-    const newOptions = choices.map(choice => Forms.newOption().setValue(choice.getValue()));
-    const currentIndex = this._getCurrentIndex();
-
-    const updateRequest = Forms.newRequest().setUpdateItem({
-      item: {
-        itemId: this.getId(),
-        questionItem: {
-          question: {
-            choiceQuestion: {
-              options: newOptions,
-            },
-          },
-        },
-      },
-      location: {
-        index: currentIndex,
-      },
-      updateMask: 'questionItem.question.choiceQuestion.options',
-    });
-
-    const batchRequest = Forms.newBatchUpdateFormRequest().setRequests([updateRequest]);
-    Forms.Form.batchUpdate(batchRequest, this.__form.getId());
-
-    return this;
-  }
-
-  /**
-   * Sets whether this item is required.
-   * @param {boolean} enabled Whether the item is required.
-   * @returns {FakeCheckboxItem} This item, for chaining.
-   */
-  setRequired(enabled) {
-    const { nargs, matchThrow } = signatureArgs(arguments, 'CheckboxItem.setRequired');
-    if (nargs !== 1 || !is.boolean(enabled)) {
-      matchThrow('Invalid arguments: expected a boolean.');
-    }
-
-    const currentIndex = this._getCurrentIndex();
-
-    const updateRequest = Forms.newRequest().setUpdateItem({
-      item: {
-        itemId: this.getId(),
-        questionItem: {
-          question: {
-            required: enabled,
-          },
-        },
-      },
-      location: {
-        index: currentIndex,
-      },
-      updateMask: 'questionItem.question.required',
-    });
-
-    const batchRequest = Forms.newBatchUpdateFormRequest().setRequests([updateRequest]);
-    Forms.Form.batchUpdate(batchRequest, this.__form.getId());
-
-    return this;
-  }
-
-  /**
-   * Returns whether this item is required.
-   * @returns {boolean} True if the item is required, false otherwise.
-   */
-  isRequired() {
-    return this.__resource.questionItem?.question?.required || false;
-  }
-
   toString() {
     return 'CheckboxItem';
   }

package/src/services/formapp/fakechoice.js

@@ -1,4 +1,6 @@
 import { Proxies } from '../../support/proxies.js';
+import { PageNavigationType, ItemType } from '../enums/formsenums.js';
+import { newFakePageBreakItem } from './fakepagebreakitem.js';
 
 export const newFakeChoice = (...args) => {
   return Proxies.guard(new FakeChoice(...args));
@@ -10,33 +12,48 @@ export const newFakeChoice = (...args) => {
  * @see https://developers.google.com/apps-script/reference/forms/choice
  */
 export class FakeChoice {
-  /**
-   * @param {string} value The value of the choice.
-   * @param {boolean} isCorrect Whether the choice is correct.
-   * @param {import('./pagebreakitem.js').FakePageBreakItem} page The page to navigate to.
-   * @param {FormApp.PageNavigationType} navigationType The navigation type.
-   */
-  constructor(value, isCorrect, page, navigationType) {
+  constructor(value, navType, pageId, form, parentItemType) {
     this.__value = value;
-    this.__isCorrect = isCorrect;
-    this.__page = page;
-    this.__navigationType = navigationType;
-  }
-
-  getGotoPage() {
-    return this.__page;
+    this.__navType = navType;
+    this.__pageId = pageId;
+    this.__form = form;
+    this.__parentItemType = parentItemType;
   }
 
-  getIsCorrect() {
-    return this.__isCorrect;
+  getValue() {
+    return this.__value;
   }
 
+  /**
+   * Gets the page navigation type for this choice.
+   * @returns {import('../enums/formsenums.js').PageNavigationType | null} The page navigation type, or null if no navigation is set.
+   */
   getPageNavigationType() {
-    return this.__navigationType;
+    if (this.__navType) {
+      // The navType is stored as a string like 'goToPage' or 'CONTINUE'.
+      // We need to return the corresponding enum value.
+      const navEnum = PageNavigationType[this.__navType.toUpperCase()];
+      return navEnum || null;
+    }
+    return null;
   }
 
-  getValue() {
-    return this.__value;
+  /**
+   * Gets the page-break item that this choice navigates to.
+   * @returns {import('./fakepagebreakitem.js').FakePageBreakItem | null} The page-break item, or null if the choice does not navigate to a page.
+   */
+  getGoToPage() {
+    // Per live documentation, this method only applies to choices from a MultipleChoiceItem.
+    if (this.__parentItemType !== ItemType.MULTIPLE_CHOICE) {
+      throw new TypeError('getGoToPage is not a function');
+    }
+
+    if (this.__navType === 'GO_TO_PAGE' && this.__pageId && this.__form) {
+      // We need the form context to find the item by its ID.
+      const item = this.__form.getItemById(this.__pageId);
+      return item ? item.asPageBreakItem() : null;
+    }
+    return null;
   }
 
   toString() {