@mcpher/gas-fakes 2.5.4 → 2.5.6

package/src/services/documentapp/fakedate.js

@@ -0,0 +1,92 @@
+/**
+ * @file Provides a fake implementation of the Date 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 FakeDate instance.
+ * @param {...any} args The arguments for the FakeDate constructor.
+ * @returns {FakeDate} A new proxied FakeDate instance.
+ */
+export const newFakeDate = (...args) => {
+  return Proxies.guard(new FakeDate(...args));
+};
+
+/**
+ * A fake implementation of the Date class for DocumentApp.
+ * @class FakeDate
+ * @extends {FakeElement}
+ * @implements {GoogleAppsScript.Document.Date}
+ * @see https://developers.google.com/apps-script/reference/document/date
+ */
+export class FakeDate 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 display value that's rendered in the document.
+   * @returns {string} The display value.
+   */
+  getDisplayText() {
+    const { nargs, matchThrow } = signatureArgs(arguments, 'Date.getDisplayText');
+    if (nargs !== 0) matchThrow();
+
+    const date = this.getTimestamp();
+    const locale = this.getLocale() || 'en';
+
+    // Format using a default representation if we can't perfectly mimic GAS.
+    return date.toLocaleDateString(locale, {
+      year: 'numeric',
+      month: 'short',
+      day: 'numeric',
+    });
+  }
+
+  /**
+   * Returns the date's locale used for the display value.
+   * @returns {string} The locale of the date.
+   */
+  getLocale() {
+    const { nargs, matchThrow } = signatureArgs(arguments, 'Date.getLocale');
+    if (nargs !== 0) matchThrow();
+
+    // The API doesn't expose a per-date locale. 
+    // It's likely inherited from the document.
+    return null; 
+  }
+
+  /**
+   * Returns the timestamp associated with the date.
+   * @returns {Date} The timestamp.
+   */
+  getTimestamp() {
+    const { nargs, matchThrow } = signatureArgs(arguments, 'Date.getTimestamp');
+    if (nargs !== 0) matchThrow();
+
+    const item = this.__elementMapItem;
+    const dateResource = item.date;
+    if (!dateResource || !dateResource.timestamp) {
+      throw new Error('Date element missing timestamp.');
+    }
+    
+    return new Date(dateResource.timestamp.seconds * 1000);
+  }
+
+  toString() {
+    return 'Date';
+  }
+}
+
+registerElement('DATE', newFakeDate);

package/src/services/documentapp/fakedocument.js

@@ -8,6 +8,8 @@ import { newFakeBody } from './fakebody.js';
 import { newFakeRangeBuilder } from './fakerangebuilder.js';
 import { newFakeHeaderSection } from './fakeheadersection.js';
 import { newFakeFooterSection } from './fakefootersection.js';
+import { newFakePosition } from './fakeposition.js';
+import { newFakeBookmark } from './fakebookmark.js';
 import { shadowPrefix } from './nrhelpers.js';
 import { defaultDocumentStyleRequests } from './elementblasters.js';
 
@@ -343,6 +345,55 @@ class FakeDocument {
     return newFakeRangeBuilder();
   }
 
+  newPosition(element, offset) {
+    const { nargs, matchThrow } = signatureArgs(arguments, 'Document.newPosition');
+    if (nargs !== 2) matchThrow();
+    return newFakePosition(element, offset);
+  }
+
+  addBookmark(position) {
+    const { nargs, matchThrow } = signatureArgs(arguments, 'Document.addBookmark');
+    if (nargs !== 1) matchThrow();
+
+    const shadow = this.__shadowDocument;
+    const element = position.getElement();
+    const offset = position.getOffset();
+    
+    // We use a NamedRange to emulate the bookmark.
+    // Use the prefix 'kix.' as it's what FakeBookmark expects.
+    const name = 'kix.' + Utilities.getUuid();
+    
+    const requests = [{
+      createNamedRange: {
+        name,
+        range: {
+          startIndex: element.__elementMapItem.startIndex + offset,
+          endIndex: element.__elementMapItem.startIndex + offset + 1,
+          segmentId: shadow.__segmentId,
+          tabId: shadow.__tabId
+        }
+      }
+    }];
+
+    Docs.Documents.batchUpdate({ requests }, shadow.getId());
+    shadow.refresh();
+
+    return this.getBookmark(name.substring(4)); 
+  }
+
+  getBookmark(id) {
+    const { nargs, matchThrow } = signatureArgs(arguments, 'Document.getBookmark');
+    if (nargs !== 1) matchThrow();
+
+    const shadow = this.__shadowDocument;
+    const name = 'kix.' + id;
+    
+    // Refresh to ensure we have the latest named ranges
+    const item = shadow.getElement(name);
+    if (!item) return null;
+
+    return newFakeBookmark(shadow, name);
+  }
 
   // these are all actually preformed by the Drive api
   addEditor(emailAddress) {

package/src/services/documentapp/fakedocumenttab.js

@@ -35,35 +35,19 @@ class FakeDocumentTab extends FakeElement {
     }
 
     addBookmark(position) {
-        return notYetImplemented('DocumentTab.addBookmark(position)');
-    }
-
-    addFooter() {
-        return notYetImplemented('DocumentTab.addFooter()');
-    }
-
-    addFooter() {
-        return this.__document.addFooter();
-    }
-
-    addHeader() {
-        return this.__document.addHeader();
+        return this.__document.addBookmark(position);
     }
 
     addNamedRange(name, range) {
-        return notYetImplemented('DocumentTab.addNamedRange(name, range)');
+        return this.__document.addNamedRange(name, range);
     }
 
     getBookmark(id) {
-        return notYetImplemented('DocumentTab.getBookmark(id)');
+        return this.__document.getBookmark(id);
     }
 
     getBookmarks() {
-        return notYetImplemented('DocumentTab.getBookmarks()');
-    }
-
-    getFooter() {
-        return notYetImplemented('DocumentTab.getFooter()');
+        return this.__document.getBookmarks();
     }
 
     getFooter() {
@@ -71,7 +55,7 @@ class FakeDocumentTab extends FakeElement {
     }
 
     getFootnotes() {
-        return notYetImplemented('DocumentTab.getFootnotes()');
+        return this.__document.getFootnotes();
     }
 
     getHeader() {
@@ -79,19 +63,19 @@ class FakeDocumentTab extends FakeElement {
     }
 
     getNamedRangeById(id) {
-        return notYetImplemented('DocumentTab.getNamedRangeById(id)');
+        return this.__document.getNamedRangeById(id);
     }
 
     getNamedRanges() {
-        return notYetImplemented('DocumentTab.getNamedRanges()');
+        return this.__document.getNamedRanges();
     }
 
     newPosition(element, offset) {
-        return notYetImplemented('DocumentTab.newPosition(element, offset)');
+        return this.__document.newPosition(element, offset);
     }
 
     newRange() {
-        return notYetImplemented('DocumentTab.newRange()');
+        return this.__document.newRange();
     }