@mcpher/gas-fakes 2.3.10 → 2.3.13

package/src/services/spreadsheetapp/fakegradientcondition.js

@@ -0,0 +1,71 @@
+import { Proxies } from '../../support/proxies.js';
+import { makeColorFromApi } from '../common/fakecolorbuilder.js';
+import { InterpolationType } from '../enums/sheetsenums.js';
+
+export const newFakeGradientCondition = (...args) => {
+  return Proxies.guard(new FakeGradientCondition(...args));
+};
+
+export class FakeGradientCondition {
+  constructor(apiGradient) {
+    this.__apiGradient = apiGradient || {};
+  }
+
+  __getColor(point) {
+    if (!point) return null;
+    if (point.colorStyle) return makeColorFromApi(point.colorStyle);
+    if (point.color) return makeColorFromApi({ rgbColor: point.color });
+    return null;
+  }
+
+  __getType(point) {
+    if (!point || !point.type) return null;
+    return InterpolationType[point.type] || null;
+  }
+
+  __getValue(point) {
+    if (!point) return "";
+    if (point.type === 'MIN' || point.type === 'MAX') return "";
+    return point.value !== undefined ? point.value : "";
+  }
+
+  getMaxColorObject() {
+    return this.__getColor(this.__apiGradient.maxpoint);
+  }
+
+  getMaxType() {
+    return this.__getType(this.__apiGradient.maxpoint);
+  }
+
+  getMaxValue() {
+    return this.__getValue(this.__apiGradient.maxpoint);
+  }
+
+  getMidColorObject() {
+    return this.__getColor(this.__apiGradient.midpoint);
+  }
+
+  getMidType() {
+    return this.__getType(this.__apiGradient.midpoint);
+  }
+
+  getMidValue() {
+    return this.__getValue(this.__apiGradient.midpoint);
+  }
+
+  getMinColorObject() {
+    return this.__getColor(this.__apiGradient.minpoint);
+  }
+
+  getMinType() {
+    return this.__getType(this.__apiGradient.minpoint);
+  }
+
+  getMinValue() {
+    return this.__getValue(this.__apiGradient.minpoint);
+  }
+
+  toString() {
+    return 'GradientCondition';
+  }
+}

package/src/services/spreadsheetapp/fakesheet.js

@@ -5,6 +5,7 @@ import { Utils } from "../../support/utils.js";
 import { SheetUtils } from "../../support/sheetutils.js";
 import { batchUpdate, makeSheetsGridRange } from "./sheetrangehelpers.js";
 import { newFakeFilter } from "./fakefilter.js";
+import { newFakeConditionalFormatRule } from "./fakeconditionalformatrule.js";
 import { newFakePivotTable } from "./fakepivottable.js";
 import { newFakeBanding } from "./fakebanding.js";
 import { newFakeDeveloperMetadataFinder } from "./fakedevelopermetadatafinder.js";
@@ -378,6 +379,68 @@ export class FakeSheet {
       : null;
   }
 
+  /**
+   * clearConditionalFormatRules() https://developers.google.com/apps-script/reference/spreadsheet/sheet#clearconditionalformatrules
+   * Removes all conditional format rules from the sheet. Equivalent to calling setConditionalFormatRules(rules) with an empty array as input.
+   */
+  clearConditionalFormatRules() {
+    this.setConditionalFormatRules([]);
+  }
+
+  /**
+   * getConditionalFormatRules() https://developers.google.com/apps-script/reference/spreadsheet/sheet#getconditionalformatrules
+   * Get all conditional format rules in this sheet.
+   * @returns {FakeConditionalFormatRule[]} An array of all rules in the sheet.
+   */
+  getConditionalFormatRules() {
+    const meta = this.getParent().__getMetaProps(
+      `sheets(conditionalFormats,properties.sheetId)`
+    );
+    const sheetMeta = meta.sheets.find(
+      (s) => s.properties.sheetId === this.getSheetId()
+    );
+    const rules = sheetMeta?.conditionalFormats || [];
+    return rules.map(rule => newFakeConditionalFormatRule(rule, this));
+  }
+
+  /**
+   * setConditionalFormatRules(rules) https://developers.google.com/apps-script/reference/spreadsheet/sheet#setconditionalformatrulesrules
+   * Replaces all currently existing conditional format rules in the sheet with the input rules. Rules are evaluated in their input order.
+   * @param {FakeConditionalFormatRule[]} rules The array of conditional format rules to set.
+   */
+  setConditionalFormatRules(rules) {
+    const { nargs, matchThrow } = signatureArgs(arguments, "Sheet.setConditionalFormatRules");
+    if (nargs !== 1 || !Array.isArray(rules)) matchThrow();
+
+    const requests = [];
+
+    // Delete existing rules
+    const existingRules = this.getConditionalFormatRules();
+    const existingCount = existingRules.length;
+    for (let i = existingCount - 1; i >= 0; i--) {
+      requests.push({
+        deleteConditionalFormatRule: {
+          sheetId: this.getSheetId(),
+          index: i
+        }
+      });
+    }
+
+    // Add new rules
+    rules.forEach((rule, index) => {
+      requests.push({
+        addConditionalFormatRule: {
+          rule: rule.__apiRule,
+          index: index
+        }
+      });
+    });
+
+    if (requests.length > 0) {
+      Sheets.Spreadsheets.batchUpdate({ requests: requests }, this.__parent.getId());
+    }
+  }
+
   getPivotTables() {
     const meta = this.getParent().__getMetaProps(
       `sheets(data(rowData(values(pivotTable))),properties.sheetId)`

package/src/services/spreadsheetapp/fakesheetrange.js

@@ -2611,6 +2611,17 @@ skipFilteredRows	Boolean	Whether to avoid clearing filtered rows.
     // options = { valueInputOption: "RAW" },
     options = { valueInputOption: "USER_ENTERED" },
   }) {
+    // Intercept FakeCellImage objects and convert to =IMAGE(url) formula
+    const processedValues = values.map(row => 
+      row.map(cell => {
+        if (cell && typeof cell === 'object' && cell.toString() === 'CellImage') {
+          const url = cell._properties?.sourceUrl || null;
+          return url ? `=IMAGE("${url}")` : "";
+        }
+        return cell;
+      })
+    );
+
     const range = single
       ? this.__getRangeWithSheet(this.__getTopLeft())
       : this.__getWithSheet();
@@ -2620,7 +2631,7 @@ skipFilteredRows	Boolean	Whether to avoid clearing filtered rows.
         {
           majorDimension: "ROWS",
           range,
-          values,
+          values: processedValues,
         },
       ],
     };

package/src/services/spreadsheetapp/fakespreadsheet.js

@@ -152,17 +152,6 @@ export class FakeSpreadsheet {
       "deleteColumn",
       "getImages",
       "find",
-      "sort",
-      "addEditor",
-      "addEditors",
-      "addViewers",
-      "addViewer",
-      "removeViewer",
-      "removeEditor",
-
-      // these convert to a pdf so we'll need to figure out how to do that
-      // probably using the Drive export
-      "getAs",
       "getBlob",
     ];
 
@@ -181,6 +170,36 @@ export class FakeSpreadsheet {
     return this.__getFirstSheet();
   }
 
+  addViewer(emailAddress) {
+    this.__file.addViewer(emailAddress);
+    return this;
+  }
+
+  addEditor(emailAddress) {
+    this.__file.addEditor(emailAddress);
+    return this;
+  }
+
+  addViewers(emailAddresses) {
+    this.__file.addViewers(emailAddresses);
+    return this;
+  }
+
+  addEditors(emailAddresses) {
+    this.__file.addEditors(emailAddresses);
+    return this;
+  }
+
+  removeViewer(emailAddress) {
+    this.__file.removeViewer(emailAddress);
+    return this;
+  }
+
+  removeEditor(emailAddress) {
+    this.__file.removeEditor(emailAddress);
+    return this;
+  }
+
   
   addDeveloperMetadata(key, value, visibility) {
     const { nargs, matchThrow } = signatureArgs(

package/src/services/spreadsheetapp/fakespreadsheetapp.js

@@ -12,8 +12,10 @@ import { newFakeRichTextValueBuilder } from "../common/fakerichtextvalue.js";
 import { newFakeTextStyleBuilder } from "../common/faketextstylebuilder.js";
 import { newFakeFilterCriteriaBuilder } from "./fakefiltercriteriabuilder.js";
 import { newFakeDataValidationBuilder } from "./fakedatavalidationbuilder.js";
+import { newFakeConditionalFormatRuleBuilder } from "./fakeconditionalformatrulebuilder.js";
 import { newFakeDataSourceSpecBuilder } from "./fakedatasourcespecbuilder.js";
-import { FakeTextFinder, newFakeTextFinder } from "./faketextfinder.js";
+import { newFakeTextFinder } from "./faketextfinder.js";
+import { newFakeCellImageBuilder } from "./fakecellimagebuilder.js";
 
 import * as Enums from "../enums/sheetsenums.js";
 
@@ -79,7 +81,6 @@ export class FakeSpreadsheetApp {
 
     const props = [
       "getActive",
-      "newConditionalFormatRule",
       "getActiveSheet",
       "getCurrentCell",
       "getActiveRange",
@@ -89,7 +90,6 @@ export class FakeSpreadsheetApp {
       "setCurrentCell",
       "setActiveRange",
       "setActiveRangeList",
-      "newCellImage",
       "getUi",
       "open",
 
@@ -228,6 +228,15 @@ export class FakeSpreadsheetApp {
     return this.openById(match[1]);
   }
 
+  /**
+   * newCellImage() https://developers.google.com/apps-script/reference/spreadsheet/spreadsheet-app#newcellimage
+   * Creates a builder for a CellImage.
+   * @returns {FakeCellImageBuilder}
+   */
+  newCellImage() {
+    return newFakeCellImageBuilder();
+  }
+
   /**
    * newColor() https://developers.google.com/apps-script/reference/spreadsheet/spreadsheet-app#newcolor
    * Creates a builder for a Color.
@@ -237,6 +246,15 @@ export class FakeSpreadsheetApp {
     return newFakeColorBuilder();
   }
 
+  /**
+   * newConditionalFormatRule() https://developers.google.com/apps-script/reference/spreadsheet/spreadsheet-app#newconditionalformatrule
+   * Creates a builder for a conditional formatting rule.
+   * @returns {FakeConditionalFormatRuleBuilder}
+   */
+  newConditionalFormatRule() {
+    return newFakeConditionalFormatRuleBuilder();
+  }
+
   /**
    * newTextStyle() https://developers.google.com/apps-script/reference/spreadsheet/spreadsheet-app#newTextStyle()
    * Creates a builder for a TextStyle.

package/src/services/urlfetchapp/app.js

@@ -116,6 +116,37 @@ const fetchAll = (requests) => {
   return responses.map(({ data }) => responsify(data))
 }
 
+const getRequest = (url, options = {}) => {
+  const defaultMethod = 'get';
+  const request = {
+    url: url,
+    method: (options.method || defaultMethod).toLowerCase(),
+    headers: options.headers || {},
+  };
+
+  // Apps Script defaults
+  if (options.contentType) {
+    request.contentType = options.contentType;
+  }
+  
+  if (options.payload) {
+    request.payload = options.payload;
+  }
+  
+  if (options.useIntranet !== undefined) {
+    request.useIntranet = options.useIntranet;
+  }
+
+  // Add standard fetch behavior
+  if (request.method === 'post' || request.method === 'put' || request.method === 'patch') {
+     if (!request.contentType) {
+       request.contentType = 'application/x-www-form-urlencoded';
+     }
+  }
+
+  return request;
+}
+
 
 // This will eventually hold a proxy for DriveApp
 let _app = null
@@ -131,7 +162,8 @@ if (typeof globalThis[name] === typeof undefined) {
     if (!_app) {
       _app = {
         fetch,
-        fetchAll
+        fetchAll,
+        getRequest
       }
     }
     // this is the actual driveApp we'll return from the proxy

package/src/support/fileiterators.js

@@ -31,7 +31,9 @@ export const getPermissionIterator = ({
         pageToken = nextPageToken
 
         // format the results into the folder or file object
-        tank = permissions
+        // we must copy the array because the cache returns a reference 
+        // and splicing it would empty the cache for subsequent calls
+        tank = [...permissions]
       }
 
       // if we've got anything in the tank send back the oldest one

package/src/support/filesharers.js

@@ -4,14 +4,18 @@ import { newFakeUser } from '../services/common/fakeuser.js';
 
 /**
  * get the file sharers
- * @returns {FakeUser} the file viewers
+ * @param {string} id the file id
+ * @param {string|string[]} roles the role or roles to filter by
+ * @returns {FakeUser[]} the file viewers
  */
-export const getSharers = (id, role) => {
+export const getSharers = (id, roles) => {
+  const roleList = Array.isArray(roles) ? roles : [roles]
   const pit = getPermissionIterator({ id })
   const viewers = []
   while (pit.hasNext()) {
     const permission = pit.next()
-    if (permission.role === role && permission.type === "user") viewers.push(makeUserFromPermission(permission))
+    // console.log(`...DEBUG: permission for ${id}:`, JSON.stringify(permission))
+    if (roleList.includes(permission.role) && permission.type === "user") viewers.push(makeUserFromPermission(permission))
   }
   return viewers
 }

package/src/support/peeker.js

@@ -8,13 +8,19 @@ class Peeker {
   /**
    * @constructor 
    * @param {function} generator the generator function to add a hasNext() to
+   * @param {function} [continuationHandler] a function to return a continuation token
    * @returns {Peeker}
    */
-  constructor(generator) {
+  constructor(generator, continuationHandler) {
     this.generator = generator
     // in order to be able to do a hasnext we have to actually get the value
     // this is the next value stored
     this.peeked = generator.next()
+    this.continuationHandler = continuationHandler
+  }
+
+  getContinuationToken() {
+    return this.continuationHandler ? this.continuationHandler(this.peeked) : null
   }
 
   /**
@@ -37,7 +43,7 @@ class Peeker {
     // instead of returning the next, we return the prepeeked next
     const value = this.peeked.value
     this.peeked = this.generator.next()
-    return value
+    return value?.__fakeResolved ?? value
   }
 }
 

package/src/support/sheetutils.js

@@ -256,4 +256,5 @@ export const SheetUtils = {
   fromRange,
   a1ToR1C1,
   r1c1ToA1,
+  columnToLetter,
 }

package/src/support/sxdrive.js

@@ -550,25 +550,36 @@ const sxStreamer = async ({
   params,
   options = {},
   method = 'get' }) => {
-  // this is the node drive service
-  const drive = getDriveApiClient();
-  const streamed = await drive.files[method](params, {
-    responseType: 'stream',
-    ...options
-  })
-  const response = responseSyncify(streamed)
-  if (response.status === 200) {
-    const buf = await getStreamAsBuffer(streamed.data)
-    const data = Array.from(buf)
+  try {
+    // this is the node drive service
+    const drive = getDriveApiClient();
+    const streamed = await drive.files[method](params, {
+      responseType: 'stream',
+      ...options
+    })
+    const response = responseSyncify(streamed)
+    if (response.status === 200) {
+      const buf = await getStreamAsBuffer(streamed.data)
+      const data = Array.from(buf)
 
-    return {
-      data,
-      response
+      return {
+        data,
+        response
+      }
+    } else {
+      return {
+        data: null,
+        response
+      }
     }
-  } else {
+  } catch (err) {
+    // We don't want to crash the worker if the API call fails
+    // (e.g. exporting a non-exportable file)
+    const response = responseSyncify(err?.response || { status: err?.code || 500, statusText: err?.message })
     return {
       data: null,
-      response
+      response,
+      error: err?.response?.data || err?.message || err
     }
   }
 }

package/src/support/syncit.js

@@ -70,10 +70,8 @@ const register = (id, cacher, result, allow404 = false, params) => {
   const { data, response } = result;
 
   if (checkResponseCacher(id, response, allow404, cacher)) {
-    return {
-      ...result,
-      data: cacher.setEntry(id, params, data),
-    };
+    cacher.setEntry(id, params, normalizeSerialization(data));
+    return result;
   } else {
     return result;
   }
@@ -147,7 +145,7 @@ const fxGeneric = ({
     const data = cacher.getEntry(resourceId, otherParams);
     if (data) {
       return {
-        data,
+        data: normalizeSerialization(data),
         response: {
           status: 200,
           fromCache: true,
@@ -203,7 +201,7 @@ const fxDriveGet = ({
     const { cachedFile, good } = getFromFileCache(id, params.fields);
     if (good)
       return {
-        data: cachedFile,
+        data: normalizeSerialization(cachedFile),
         // fake a good sxresponse
         response: {
           status: 200,

package/src/support/workersync/synchronizer.js

@@ -101,7 +101,12 @@ function cleanup() {
 }
 
 // The 'exit' event is for when the process is already shutting down normally.
-process.on('exit', cleanup);
+process.on('exit', () => {
+  // Only terminate the worker if we aren't in the middle of an interactive CLI session
+  if (!process.env.GF_CLI_INTERACTIVE) {
+    cleanup();
+  }
+});
 // By not listening for 'SIGINT', we allow Node.js to perform its default action,
 // which is to exit the process. The 'exit' event will then be fired to clean up the worker.
 process.on('SIGTERM', cleanup); // Catches `kill`
@@ -181,10 +186,25 @@ export function callSync(method, ...args) {
 
   if (hasError) {
     // Re-hydrate the error object on the main thread.
-    const err = new Error(resultData.message);
+    // The error message from the worker might be a simple string or a JSON object from an API response
+    let message = resultData.message || resultString || "Unknown worker error";
+    
+    // If it's a Drive API error object, the message is often nested
+    if (resultData.error?.message) {
+      message = resultData.error.message;
+    }
+
+    const err = new Error(message);
     err.stack = resultData.stack;
-    // Copy other properties if they exist.
-    Object.assign(err, resultData);
+    
+    // Copy other important properties if they exist, except the ones we've handled
+    const skip = ['message', 'stack', 'name'];
+    Object.keys(resultData).forEach(key => {
+      if (!skip.includes(key)) {
+        err[key] = resultData[key];
+      }
+    });
+
     throw err;
   }
 

package/src/support/workersync/worker.js

@@ -54,11 +54,23 @@ async function writeResult(result) {
  * @param {Error} error The error to write.
  */
 function writeError(error) {
-  const errorObject = {
+  let errorObject = {
     message: error.message,
     stack: error.stack,
     name: error.name,
   };
+
+  // If the message is a JSON string (common for API errors that have been caught and re-thrown),
+  // try to parse it and merge the properties for better re-hydration on the main thread.
+  if (error.message && error.message.startsWith('{') && error.message.endsWith('}')) {
+    try {
+      const parsedMessage = JSON.parse(error.message);
+      errorObject = { ...errorObject, ...parsedMessage };
+    } catch (e) {
+      // Not valid JSON, keep as is
+    }
+  }
+
   const errorString = JSON.stringify(errorObject);
   const encodedError = textEncoder.encode(errorString);
 
@@ -142,7 +154,6 @@ parentPort.on('message', async (task) => {
     await writeResult(result);
 
   } catch (error) {
-    syncError('An unhandled error occurred in the worker', error);
     writeError(error);
   } finally {
     // 3. Signal completion and wake up the main thread.

package/summarize_advanced.js

@@ -1,69 +0,0 @@
-import './main.js';
-
-try {
-  console.log('Searching for emails from Martin...');
-  
-  // Search Gmail for messages from Martin (getting up to 10 recent threads)
-  const threads = GmailApp.search('from:Martin', 0, 10);
-  
-  if (threads.length === 0) {
-    console.log('No emails found from Martin.');
-    process.exit(0);
-  }
-
-  console.log(`Found ${threads.length} threads. Creating summary doc...`);
-
-  // Create the Document
-  const doc = DocumentApp.create('Email Summary: Martin');
-  const body = doc.getBody();
-  
-  // Add a title
-  body.appendParagraph('Summary of Recent Emails from Martin')
-      .setHeading(DocumentApp.ParagraphHeading.TITLE);
-  
-  body.appendParagraph(`Generated on: ${new Date().toLocaleString()}`);
-  body.appendParagraph(''); 
-
-  // We have to use the advanced Gmail service directly because gas-fakes' 
-  // FakeGmailMessage does not yet support getSubject(), getDate(), or getSnippet()
-  for (const thread of threads) {
-    // Get the raw thread resource from the Gmail API
-    const threadResource = Gmail.Users.Threads.get('me', thread.getId());
-    if (!threadResource.messages || threadResource.messages.length === 0) continue;
-    
-    const firstMsg = threadResource.messages[0];
-    
-    // Extract Subject from headers
-    const headers = firstMsg.payload && firstMsg.payload.headers ? firstMsg.payload.headers : [];
-    const subjectHeader = headers.find(h => h.name.toLowerCase() === 'subject');
-    const dateHeader = headers.find(h => h.name.toLowerCase() === 'date');
-    
-    const subject = subjectHeader ? subjectHeader.value : 'No Subject';
-    const date = dateHeader ? dateHeader.value : 'Unknown Date';
-    
-    body.appendParagraph(`Subject: ${subject}`)
-        .setHeading(DocumentApp.ParagraphHeading.HEADING1);
-    
-    for (const msg of threadResource.messages) {
-      const msgHeaders = msg.payload && msg.payload.headers ? msg.payload.headers : [];
-      const msgDateHeader = msgHeaders.find(h => h.name.toLowerCase() === 'date');
-      const msgDate = msgDateHeader ? msgDateHeader.value : 'Unknown Date';
-      
-      body.appendParagraph(`Date: ${msgDate}`)
-          .setHeading(DocumentApp.ParagraphHeading.HEADING3);
-      
-      const snippet = msg.snippet || "No content.";
-      body.appendParagraph(snippet);
-    }
-    
-    body.appendParagraph(''); // Spacing
-  }
-
-  doc.saveAndClose();
-
-  console.log(`Successfully created document "${doc.getName()}"`);
-  console.log(`Document URL: ${doc.getUrl()}`);
-
-} catch (error) {
-  console.error(`Error: ${error.message}`);
-}