@mcpher/gas-fakes 2.5.4 → 2.5.6

package/src/services/documentapp/fakeequationfunctionargumentseparator.js

@@ -0,0 +1,28 @@
+/**
+ * @file Provides a fake implementation of the EquationFunctionArgumentSeparator class.
+ */
+
+import { Proxies } from '../../support/proxies.js';
+import { FakeElement } from './fakeelement.js';
+import { registerElement } from './elementRegistry.js';
+
+/**
+ * A fake implementation of the EquationFunctionArgumentSeparator class.
+ * @class
+ * @extends {FakeElement}
+ * @implements {GoogleAppsScript.Document.EquationFunctionArgumentSeparator}
+ * @see https://developers.google.com/apps-script/reference/document/equation-function-argument-separator
+ */
+export class FakeEquationFunctionArgumentSeparator extends FakeElement {
+  constructor(shadowDocument, nameOrItem) {
+    super(shadowDocument, nameOrItem);
+  }
+}
+
+/**
+ * Creates a new fake EquationFunctionArgumentSeparator.
+ * @param {...any} args The arguments for the FakeEquationFunctionArgumentSeparator constructor.
+ * @returns {FakeEquationFunctionArgumentSeparator} A new proxied FakeEquationFunctionArgumentSeparator instance.
+ */
+export const newFakeEquationFunctionArgumentSeparator = (...args) => Proxies.guard(new FakeEquationFunctionArgumentSeparator(...args));
+registerElement('EQUATION_FUNCTION_ARGUMENT_SEPARATOR', newFakeEquationFunctionArgumentSeparator);

package/src/services/documentapp/fakeequationsymbol.js

@@ -0,0 +1,37 @@
+/**
+ * @file Provides a fake implementation of the EquationSymbol class.
+ */
+
+import { Proxies } from '../../support/proxies.js';
+import { FakeElement } from './fakeelement.js';
+import { registerElement } from './elementRegistry.js';
+
+/**
+ * A fake implementation of the EquationSymbol class.
+ * @class
+ * @extends {FakeElement}
+ * @implements {GoogleAppsScript.Document.EquationSymbol}
+ * @see https://developers.google.com/apps-script/reference/document/equation-symbol
+ */
+export class FakeEquationSymbol extends FakeElement {
+  constructor(shadowDocument, nameOrItem) {
+    super(shadowDocument, nameOrItem);
+  }
+
+  /**
+   * Retrieves the code corresponding to the equation symbol.
+   * @returns {string} the symbol code
+   * @see https://developers.google.com/apps-script/reference/document/equation-symbol#getCode()
+   */
+  getCode() {
+    return this.__elementMapItem.equationSymbolStyle?.code || "";
+  }
+}
+
+/**
+ * Creates a new fake EquationSymbol.
+ * @param {...any} args The arguments for the FakeEquationSymbol constructor.
+ * @returns {FakeEquationSymbol} A new proxied FakeEquationSymbol instance.
+ */
+export const newFakeEquationSymbol = (...args) => Proxies.guard(new FakeEquationSymbol(...args));
+registerElement('EQUATION_SYMBOL', newFakeEquationSymbol);

package/src/services/documentapp/fakefootersection.js

@@ -17,7 +17,6 @@ export const newFakeFooterSection = (...args) => {
 /**
  * A fake implementation of the FooterSection class for DocumentApp.
  * @class FakeFooterSection
- * @extends {FakeContainerElement}
  * @extends {FakeSectionElement}
  * @implements {GoogleAppsScript.Document.FooterSection}
  * @see https://developers.google.com/apps-script/reference/document/footer-section
@@ -39,6 +38,70 @@ class FakeFooterSection extends FakeSectionElement {
   toString() {
     return 'FooterSection';
   }
+
+  appendHorizontalRule() {
+    return super.appendHorizontalRule();
+  }
+
+  appendImage(image) {
+    return super.appendImage(image);
+  }
+
+  appendListItem(listItemOrText) {
+    return super.appendListItem(listItemOrText);
+  }
+
+  appendParagraph(paragraphOrText) {
+    return super.appendParagraph(paragraphOrText);
+  }
+
+  appendTable(tableOrCells) {
+    return super.appendTable(tableOrCells);
+  }
+
+  clear() {
+    return super.clear();
+  }
+
+  editAsText() {
+    return super.editAsText();
+  }
+
+  getText() {
+    return super.getText();
+  }
+
+  insertHorizontalRule(childIndex) {
+    return super.insertHorizontalRule(childIndex);
+  }
+
+  insertImage(childIndex, image) {
+    return super.insertImage(childIndex, image);
+  }
+
+  insertListItem(childIndex, listItemOrText) {
+    return super.insertListItem(childIndex, listItemOrText);
+  }
+
+  insertParagraph(childIndex, paragraph) {
+    return super.insertParagraph(childIndex, paragraph);
+  }
+
+  insertTable(childIndex, table) {
+    return super.insertTable(childIndex, table);
+  }
+
+  removeChild(child) {
+    return super.removeChild(child);
+  }
+
+  setText(text) {
+    return super.setText(text);
+  }
+
+  removeFromParent() {
+    return super.removeFromParent();
+  }
 }
 
 registerElement('FOOTER_SECTION', newFakeFooterSection);

package/src/services/documentapp/fakeheadersection.js

@@ -39,6 +39,70 @@ class FakeHeaderSection extends FakeSectionElement {
   toString() {
     return 'HeaderSection';
   }
+
+  appendHorizontalRule() {
+    return super.appendHorizontalRule();
+  }
+
+  appendImage(image) {
+    return super.appendImage(image);
+  }
+
+  appendListItem(listItemOrText) {
+    return super.appendListItem(listItemOrText);
+  }
+
+  appendParagraph(paragraphOrText) {
+    return super.appendParagraph(paragraphOrText);
+  }
+
+  appendTable(tableOrCells) {
+    return super.appendTable(tableOrCells);
+  }
+
+  clear() {
+    return super.clear();
+  }
+
+  editAsText() {
+    return super.editAsText();
+  }
+
+  getText() {
+    return super.getText();
+  }
+
+  insertHorizontalRule(childIndex) {
+    return super.insertHorizontalRule(childIndex);
+  }
+
+  insertImage(childIndex, image) {
+    return super.insertImage(childIndex, image);
+  }
+
+  insertListItem(childIndex, listItemOrText) {
+    return super.insertListItem(childIndex, listItemOrText);
+  }
+
+  insertParagraph(childIndex, paragraph) {
+    return super.insertParagraph(childIndex, paragraph);
+  }
+
+  insertTable(childIndex, table) {
+    return super.insertTable(childIndex, table);
+  }
+
+  removeChild(child) {
+    return super.removeChild(child);
+  }
+
+  setText(text) {
+    return super.setText(text);
+  }
+
+  removeFromParent() {
+    return super.removeFromParent();
+  }
 }
 
 registerElement('HEADER_SECTION', newFakeHeaderSection);

package/src/services/documentapp/fakeperson.js

@@ -0,0 +1,67 @@
+/**
+ * @file Provides a fake implementation of the Person class.
+ */
+import { Proxies } from '../../support/proxies.js';
+import { signatureArgs } from '../../support/helpers.js';
+import { Utils } from '../../support/utils.js';
+import { FakeElement } from './fakeelement.js';
+import { registerElement } from './elementRegistry.js';
+
+const { is } = Utils;
+
+/**
+ * Creates a new proxied FakePerson instance.
+ * @param {...any} args The arguments for the FakePerson constructor.
+ * @returns {FakePerson} A new proxied FakePerson instance.
+ */
+export const newFakePerson = (...args) => {
+  return Proxies.guard(new FakePerson(...args));
+};
+
+/**
+ * A fake implementation of the Person class for DocumentApp.
+ * @class FakePerson
+ * @extends {FakeElement}
+ * @implements {GoogleAppsScript.Document.Person}
+ * @see https://developers.google.com/apps-script/reference/document/person
+ */
+export class FakePerson extends FakeElement {
+  /**
+   * @param {import('./shadowdocument.js').ShadowDocument} shadowDocument The shadow document manager.
+   * @param {string|object} nameOrItem The name of the element or the element's API resource.
+   * @private
+   */
+  constructor(shadowDocument, nameOrItem) {
+    super(shadowDocument, nameOrItem);
+  }
+
+  /**
+   * Returns the person's email address.
+   * @returns {string} The email address of the person.
+   */
+  getEmail() {
+    const { nargs, matchThrow } = signatureArgs(arguments, 'Person.getEmail');
+    if (nargs !== 0) matchThrow();
+
+    const person = this.__elementMapItem.person;
+    return person ? person.personId : null;
+  }
+
+  /**
+   * Returns the person's display name, if set.
+   * @returns {string} The display name of the person link.
+   */
+  getName() {
+    const { nargs, matchThrow } = signatureArgs(arguments, 'Person.getName');
+    if (nargs !== 0) matchThrow();
+
+    const person = this.__elementMapItem.person;
+    return person?.personProperties ? person.personProperties.name : null;
+  }
+
+  toString() {
+    return 'Person';
+  }
+}
+
+registerElement('PERSON', newFakePerson);

package/src/services/documentapp/fakerangeelement.js

@@ -9,8 +9,10 @@
  * @see https://developers.google.com/apps-script/reference/document/range-element
  */
 export class FakeRangeElement {
-  constructor({ element }) {
+  constructor({ element, startOffset = -1, endOffsetInclusive = -1 }) {
     this.element = element;
+    this.startOffset = startOffset;
+    this.endOffsetInclusive = endOffsetInclusive;
   }
 
   /**
@@ -21,6 +23,30 @@ export class FakeRangeElement {
   getElement() {
     return this.element;
   }
+
+  /**
+   * Gets the position of the start of a partial range within the range element.
+   * @returns {number} the index of the first character in the range, or -1
+   */
+  getStartOffset() {
+    return this.startOffset;
+  }
+
+  /**
+   * Gets the position of the end of a partial range within the range element.
+   * @returns {number} the index of the last character in the range, or -1
+   */
+  getEndOffsetInclusive() {
+    return this.endOffsetInclusive;
+  }
+
+  /**
+   * Determines whether this range element covers the entire element or a partial selection.
+   * @returns {boolean} true if the element is partially included
+   */
+  isPartial() {
+    return this.startOffset !== -1 || this.endOffsetInclusive !== -1;
+  }
 }
 
 /**

package/src/services/documentapp/fakerichlink.js

@@ -0,0 +1,79 @@
+/**
+ * @file Provides a fake implementation of the RichLink class.
+ */
+import { Proxies } from '../../support/proxies.js';
+import { signatureArgs } from '../../support/helpers.js';
+import { Utils } from '../../support/utils.js';
+import { FakeElement } from './fakeelement.js';
+import { registerElement } from './elementRegistry.js';
+
+const { is } = Utils;
+
+/**
+ * Creates a new proxied FakeRichLink instance.
+ * @param {...any} args The arguments for the FakeRichLink constructor.
+ * @returns {FakeRichLink} A new proxied FakeRichLink instance.
+ */
+export const newFakeRichLink = (...args) => {
+  return Proxies.guard(new FakeRichLink(...args));
+};
+
+/**
+ * A fake implementation of the RichLink class for DocumentApp.
+ * @class FakeRichLink
+ * @extends {FakeElement}
+ * @implements {GoogleAppsScript.Document.RichLink}
+ * @see https://developers.google.com/apps-script/reference/document/rich-link
+ */
+export class FakeRichLink extends FakeElement {
+  /**
+   * @param {import('./shadowdocument.js').ShadowDocument} shadowDocument The shadow document manager.
+   * @param {string|object} nameOrItem The name of the element or the element's API resource.
+   * @private
+   */
+  constructor(shadowDocument, nameOrItem) {
+    super(shadowDocument, nameOrItem);
+  }
+
+  /**
+   * Returns the MIME type of the link.
+   * @returns {string|null} The MIME type of the link.
+   */
+  getMimeType() {
+    const { nargs, matchThrow } = signatureArgs(arguments, 'RichLink.getMimeType');
+    if (nargs !== 0) matchThrow();
+
+    const richLink = this.__elementMapItem.richLink;
+    return richLink?.richLinkProperties ? richLink.richLinkProperties.mimeType : null;
+  }
+
+  /**
+   * Returns the link's displayed title.
+   * @returns {string} The display title of the link.
+   */
+  getTitle() {
+    const { nargs, matchThrow } = signatureArgs(arguments, 'RichLink.getTitle');
+    if (nargs !== 0) matchThrow();
+
+    const richLink = this.__elementMapItem.richLink;
+    return richLink?.richLinkProperties ? richLink.richLinkProperties.title : null;
+  }
+
+  /**
+   * Returns the URL of the resource.
+   * @returns {string} The URL of the resource.
+   */
+  getUrl() {
+    const { nargs, matchThrow } = signatureArgs(arguments, 'RichLink.getUrl');
+    if (nargs !== 0) matchThrow();
+
+    const richLink = this.__elementMapItem.richLink;
+    return richLink ? richLink.uri : null;
+  }
+
+  toString() {
+    return 'RichLink';
+  }
+}
+
+registerElement('RICH_LINK', newFakeRichLink);

package/src/services/documentapp/fakesectionelement.js

@@ -1,8 +1,9 @@
 /**
  * @file Provides a base class for HeaderSection and FooterSection.
  */
+import is from '@sindresorhus/is';
 import { FakeContainerElement } from './fakecontainerelement.js';
-import { notYetImplemented, signatureArgs } from '../../support/helpers.js';
+import { signatureArgs } from '../../support/helpers.js';
 import { getText } from './elementhelpers.js';
 import {
   appendParagraph,
@@ -11,6 +12,10 @@ import {
   insertTable,
   appendListItem,
   insertListItem,
+  appendImage,
+  insertImage,
+  appendHorizontalRule,
+  insertHorizontalRule
 } from './appenderhelpers.js';
 import { ElementType } from '../enums/docsenums.js';
 
@@ -31,19 +36,19 @@ export class FakeSectionElement extends FakeContainerElement {
 
   /**
    * Appends a horizontal rule.
-   * @returns {GoogleAppsScript.Document.HorizontalRule} The appended horizontal rule.
+   * @returns {GoogleAppsScript.Document.Paragraph} The appended paragraph acting as a horizontal rule.
    */
-  appendHorizontalRule() {
-    return notYetImplemented(`${this.toString()}.appendHorizontalRule`);
+  appendHorizontalRule(horizontalRule) {
+    return appendHorizontalRule(this, horizontalRule);
   }
 
   /**
    * Appends an image.
-   * @param {GoogleAppsScript.Base.BlobSource} image The image data.
+   * @param {GoogleAppsScript.Base.BlobSource|GoogleAppsScript.Document.InlineImage} image The image data.
    * @returns {GoogleAppsScript.Document.InlineImage} The appended image.
    */
   appendImage(image) {
-    return notYetImplemented(`${this.toString()}.appendImage`);
+    return appendImage(this, image);
   }
 
   /**
@@ -112,7 +117,7 @@ export class FakeSectionElement extends FakeContainerElement {
    * @returns {GoogleAppsScript.Document.Text} The contents as a Text element.
    */
   editAsText() {
-    return notYetImplemented(`${this.toString()}.editAsText`);
+    return super.editAsText();
   }
 
   /**
@@ -126,20 +131,20 @@ export class FakeSectionElement extends FakeContainerElement {
   /**
    * Inserts a horizontal rule at a specific index.
    * @param {number} childIndex The index to insert at.
-   * @returns {GoogleAppsScript.Document.HorizontalRule} The inserted horizontal rule.
+   * @returns {GoogleAppsScript.Document.Paragraph} The inserted horizontal rule (as a Paragraph).
    */
-  insertHorizontalRule(childIndex) {
-    return notYetImplemented(`${this.toString()}.insertHorizontalRule`);
+  insertHorizontalRule(childIndex, horizontalRule) {
+    return insertHorizontalRule(this, childIndex, horizontalRule);
   }
 
   /**
    * Inserts an image at a specific index.
    * @param {number} childIndex The index to insert at.
-   * @param {GoogleAppsScript.Base.BlobSource} image The image data.
+   * @param {GoogleAppsScript.Base.BlobSource|GoogleAppsScript.Document.InlineImage} image The image data.
    * @returns {GoogleAppsScript.Document.InlineImage} The inserted image.
    */
   insertImage(childIndex, image) {
-    return notYetImplemented(`${this.toString()}.insertImage`);
+    return insertImage(this, childIndex, image);
   }
 
   /**
@@ -181,6 +186,40 @@ export class FakeSectionElement extends FakeContainerElement {
     return insertTable(this, childIndex, table);
   }
 
+  /**
+   * Removes a child element from the section.
+   * @param {FakeElement} child The child element to remove.
+   * @returns {FakeSectionElement} The section.
+   */
+  removeChild(child) {
+    const { nargs, matchThrow } = signatureArgs(arguments, `${this.toString()}.removeChild`);
+    if (nargs !== 1) matchThrow();
+    child.removeFromParent();
+    return this;
+  }
+
+  /**
+   * Sets the text content of the section.
+   * @param {string} text The text to set.
+   * @returns {FakeSectionElement} The section.
+   */
+  setText(text) {
+    const { nargs, matchThrow } = signatureArgs(arguments, `${this.toString()}.setText`);
+    if (nargs !== 1 || !is.string(text)) matchThrow();
+
+    this.clear();
+
+    if (text) {
+      const shadow = this.shadowDocument;
+      const requests = [{
+        insertText: { location: { index: 0, segmentId: this.__segmentId, tabId: this.__tabId }, text }
+      }];
+      Docs.Documents.batchUpdate({ requests }, shadow.getId());
+      shadow.refresh();
+    }
+    return this;
+  }
+
   /**
    * Removes the element from its parent.
    * @returns {FakeSectionElement} The element, for chaining.

package/src/services/documentapp/faketablecell.js

@@ -3,9 +3,20 @@
  */
 
 import { Proxies } from '../../support/proxies.js';
+import { notYetImplemented, signatureArgs } from '../../support/helpers.js';
 import { FakeContainerElement } from './fakecontainerelement.js';
 import { getText } from './elementhelpers.js';
 import { registerElement } from './elementRegistry.js';
+import {
+  appendParagraph,
+  insertParagraph,
+  appendTable,
+  insertTable,
+  appendListItem,
+  insertListItem,
+  appendImage,
+  insertImage
+} from './appenderhelpers.js';
 
 /**
  * A fake implementation of the TableCell class.
@@ -27,6 +38,93 @@ export class FakeTableCell extends FakeContainerElement {
   getText() {
     return getText(this);
   }
+
+  /**
+   * Retrieves the TableRow containing the current TableCell.
+   * @returns {FakeTableRow|null} the table row containing the current cell
+   * @see https://developers.google.com/apps-script/reference/document/table-cell#getParentRow()
+   */
+  getParentRow() {
+    return this.getParent();
+  }
+
+  /**
+   * Retrieves the Table containing the current TableCell.
+   * @returns {FakeTable|null} the table containing the current cell
+   * @see https://developers.google.com/apps-script/reference/document/table-cell#getParentTable()
+   */
+  getParentTable() {
+    const row = this.getParentRow();
+    return row ? row.getParentTable() : null;
+  }
+
+  /**
+   * Retrieves the column span, which is the number of columns of table cells this cell spans.
+   * @returns {number} the column span
+   * @see https://developers.google.com/apps-script/reference/document/table-cell#getColSpan()
+   */
+  getColSpan() {
+    const style = this.__elementMapItem.tableCellStyle;
+    return style?.columnSpan || 1;
+  }
+
+  /**
+   * Retrieves the row span, which is the number of rows of table cells this cell spans.
+   * @returns {number} the row span
+   * @see https://developers.google.com/apps-script/reference/document/table-cell#getRowSpan()
+   */
+  getRowSpan() {
+    const style = this.__elementMapItem.tableCellStyle;
+    return style?.rowSpan || 1;
+  }
+
+  // --- Appender & Inserter Methods ---
+
+  appendHorizontalRule() {
+    return notYetImplemented(`${this.toString()}.appendHorizontalRule`);
+  }
+
+  appendImage(image) {
+    return appendImage(this, image);
+  }
+
+  appendListItem(listItemOrText) {
+    return appendListItem(this, listItemOrText);
+  }
+
+  appendParagraph(paragraphOrText) {
+    return appendParagraph(this, paragraphOrText);
+  }
+
+  appendTable(tableOrCells) {
+    return appendTable(this, tableOrCells);
+  }
+
+  insertHorizontalRule(childIndex) {
+    return notYetImplemented(`${this.toString()}.insertHorizontalRule`);
+  }
+
+  insertImage(childIndex, image) {
+    return insertImage(this, childIndex, image);
+  }
+
+  insertListItem(childIndex, listItemOrText) {
+    const { nargs } = signatureArgs(arguments, 'TableCell.insertListItem');
+    if (nargs === 1) return this.appendListItem(listItemOrText);
+    return insertListItem(this, childIndex, listItemOrText);
+  }
+
+  insertParagraph(childIndex, paragraphOrText) {
+    const { nargs } = signatureArgs(arguments, 'TableCell.insertParagraph');
+    if (nargs === 1) return this.appendParagraph(paragraphOrText);
+    return insertParagraph(this, childIndex, paragraphOrText);
+  }
+
+  insertTable(childIndex, tableOrCells) {
+    const { nargs } = signatureArgs(arguments, 'TableCell.insertTable');
+    if (nargs === 1) return this.appendTable(tableOrCells);
+    return insertTable(this, childIndex, tableOrCells);
+  }
 }
 
 /**

package/src/services/documentapp/nrhelpers.js

@@ -21,8 +21,9 @@ export const makeNrPrefix = (type = null, segmentId = null) => {
 // get all the relevant named ranges from the current document
 export const getCurrentNr = (data) => {
   // filter out unrelated namedranges, and add the rest for lookup later
+  // Include kix. for bookmarks.
   return Reflect.ownKeys(data.namedRanges || {})
-    .filter(key => key.startsWith(shadowPrefix))
+    .filter(key => key.startsWith(shadowPrefix) || key.startsWith('kix.'))
     .reduce((p, c) => {
       // strangly there's another level of .namedRanges property
       const nrs = data.namedRanges[c].namedRanges;

package/src/services/documentapp/shadowdocument.js

@@ -202,6 +202,9 @@ class ShadowDocument {
                 childElement.horizontalRule ||
                 childElement.footnoteReference ||
                 childElement.inlineObjectElement ||
+                childElement.person ||
+                childElement.richLink ||
+                childElement.date ||
                 (childElement.textRun && childElement.textRun.content && childElement.textRun.content !== '\n');
             });
         } else {
@@ -282,10 +285,24 @@ class ShadowDocument {
       footnoteSectionTree.children = footnoteTwigs;
     };
     mapFootnotes(footnotes);
+
+    // Filter out kix. bookmarks from deletion and add them to elementMap
+    const bookmarkNrs = currentNr.filter(r => r.name.startsWith('kix.'));
+    const remainingUnused = currentNr.filter(r => !r.name.startsWith('kix.'));
+
+    bookmarkNrs.forEach(r => {
+      // Add to elementMap so FakeBookmark can find it
+      this.__elementMap.set(r.name, {
+        ...r,
+        __type: 'BOOKMARK',
+        __name: r.name,
+        __twig: { name: r.name, children: [], parent: null }
+      });
+    });
+
     // delete the named ranges that weren't used
     // findOrCreate... consumes the currentNr list, so what's left are unused ranges.
-
-    const deleteRequests = currentNr.map(r => ({
+    const deleteRequests = remainingUnused.map(r => ({
       deleteNamedRange: {
         namedRangeId: r.namedRangeId
       }