@mcpher/gas-fakes 1.0.7 → 1.0.8

package/deprec/deprec-test.js

@@ -8,7 +8,7 @@ import { mergeParamStrings } from '../src/support/utils.js';
 // all the fake services are here
 //import '@mcpher/gas-fakes/main.js'
 
-import '../main.js'
+import '../mainnpm.js'
 import { LRUCache } from 'google-auth-library/build/src/util.js';
 
 const testFakes = () => {

package/main.js

@@ -1 +1,2 @@
-import './src/index.js'
+// testing locally
+import './src/index.js'

package/package.json

@@ -21,20 +21,21 @@
   },
   "type": "module",
   "scripts": {
-    "test": "node --env-file=.env ./test/test.js",
-    "testdrive": "node --env-file=.env ./test/testdrive.js execute",
-    "testsheets": "node --env-file=.env ./test/testsheets.js execute",
-    "testfetch": "node --env-file=.env ./test/testfetch.js execute",
-    "testsession": "node --env-file=.env ./test/testsession.js execute",
-    "testutilities": "node --env-file=.env ./test/testutilities.js execute",
-    "teststores": "node --env-file=.env ./test/teststores.js execute",
-    "testscriptapp": "node --env-file=.env ./test/testscriptapp.js execute",
-    "pub": "npm publish --access public"
+    "test": "cp mainlocal.js main.js && node --env-file=.env ./test/test.js",
+    "testdrive": "cp mainlocal.js main.js && node --env-file=.env ./test/testdrive.js execute",
+    "testsheets": "cp mainlocal.js main.js && node --env-file=.env ./test/testsheets.js execute",
+    "testfetch": "cp mainlocal.js main.js && node --env-file=.env ./test/testfetch.js execute",
+    "testsession": "cp mainlocal.js main.js && node --env-file=.env ./test/testsession.js execute",
+    "testutilities": "cp mainlocal.js main.js && node --env-file=.env ./test/testutilities.js execute",
+    "teststores": "cp mainlocal.js main.js && node --env-file=.env ./test/teststores.js execute",
+    "testscriptapp": "cp mainlocal.js main.js &&  node --env-file=.env ./test/testscriptapp.js execute",
+    "testfiddler": "cp mainlocal.js main.js &&  node --env-file=.env ./test/testfiddler.js execute",
+    "pub": "cp mainlocal.js main.js && npm publish --access public"
   },
   "name": "@mcpher/gas-fakes",
-  "version": "1.0.7",
+  "version": "1.0.8",
   "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/src/services/advsheets/fakeadvsheetsspreadsheets.js

@@ -5,8 +5,10 @@
 
 import { Proxies } from '../../support/proxies.js'
 import { Syncit } from '../../support/syncit.js'
-import { notYetImplemented, isGood } from '../../support/helpers.js'
+import { notYetImplemented, ssError } from '../../support/helpers.js'
 import { newFakeSheetValues } from './fakeadvvalues.js'
+import { getWorkbookEntry, setWorkbookEntry, clearWorkbookCache } from "../../support/sheetscache.js"
+
 
 
 /**
@@ -18,8 +20,6 @@ class FakeAdvSheetsSpreadsheets {
 
     const props = [
       'getByDataFilter',
-      'batchUpdate',
-      'create',
       'DeveloperMetadata',
       'Sheets']
 
@@ -35,45 +35,96 @@ class FakeAdvSheetsSpreadsheets {
     return this.__sheets.toString()
   }
 
-  get Values () {
+  get Values() {
     return newFakeSheetValues(this.__sheets)
   }
 
+  /**
+   * batchUpdate: https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/batchUpdate
+   * note that the order of args -- requests first then id - is different to usual
+   * Batch request looks like this https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/request#request
+   * @param {object} request batch request {request:Request[]}
+   */
+  batchUpdate(requests, spreadsheetId, { ss = false } = {}) {
+
+    // note that in GAS adv sheet service doesnt take the requestBody parameter - it just sends requests as the arg
+    // so we need to wrap that in requestbody for the Node API
+    const requestBody = requests
+
+    const pack = {
+      prop: "spreadsheets",
+      method: "batchUpdate",
+      params: {
+        spreadsheetId,
+        requestBody
+      }
+    }
+
+    const { response, data } = Syncit.fxSheets(pack)
+    
+    // naive cache - was an update so zap everything
+    clearWorkbookCache(spreadsheetId)
+
+    // maybe we need to throw an error
+    ssError (response, pack.method, ss)
+
+    return data
+  }
+
   /**
    * get a spreadsheet
    * @param {string} id 
    * @param {object} options 
    */
-  get(id, options, { ss = false } ={}) {
+  get(id, options, { ss = false } = {}) {
 
-    const { response, data } = Syncit.fxSheets({
+    const pack = {
       prop: "spreadsheets",
       method: "get",
       params: {
         spreadsheetId: id,
         ...options
       }
-    })
+    }
+    const cache = getWorkbookEntry(id, pack)
+    if (cache) {
+      return cache
+    }
+
+    const { response, data } = Syncit.fxSheets(pack)
 
     // maybe we need to throw an error
-    if (!isGood(response)) {
-      //  driveapp throws this error with a bad id
-      if (ss) {
-        throw new Error("Unexpected error while getting the method or property openById on object SpreadsheetApp.")
-      } else {
-        // adv drive throws this one
-        throw new Error("GoogleJsonResponseException: API call to sheets.spreadsheets.get failed with error: Requested entity was not found.")
-      }
-    }
+    ssError (response, pack.method, ss)
 
-    // all is good
+    // all is good so write to cache
+    setWorkbookEntry(id, pack, data)
     return data
-
   }
 
+  /**
+   * @param {Spreadsheet} resource #https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets#SpreadsheetProperties
+   * @return {Spreadsheet} resource
+   */
+  create(resource, {ss=false} = {}) {
 
+    const pack = {
+      prop: "spreadsheets",
+      method: "create",
+      params: {
+        requestBody: resource
+      }
+    }
+
+    // create the sheet
+    const { response, data } = Syncit.fxSheets(pack)
+
+    // maybe we need to throw an error
+    ssError (response, pack.method, ss)
 
+    return data
+  }
 }
 
+
 export const newFakeAdvSheetsSpreadsheets = (...args) => Proxies.guard(new FakeAdvSheetsSpreadsheets(...args))
 

package/src/services/advsheets/fakeadvvalues.js

@@ -1,6 +1,7 @@
 import { Proxies } from '../../support/proxies.js'
-import { notYetImplemented, isGood, throwResponse } from '../../support/helpers.js'
+import { notYetImplemented, ssError } from '../../support/helpers.js'
 import { Syncit } from '../../support/syncit.js'
+import { getWorkbookEntry, setWorkbookEntry, clearWorkbookCache } from "../../support/sheetscache.js"
 /**
  * @file
  * @imports ../typedefs.js
@@ -35,7 +36,6 @@ class FakeSheetValues {
       'batchClearByDataFilter',
       'batchUpdateByDataFilter',
       'batchClear',
-      'batchUpdate',
       'batchGetByDataFilter',
       'clear',
       'update',
@@ -55,21 +55,61 @@ class FakeSheetValues {
 
   /**
    * @param {string} spreadsheetId the spreadsheet id
-   * @param {string} range the a1 style range including the name of the sheet
+   * @param {string} ranges the a1 style range including the name of the sheet
    * @param {object} options
    */
-  get(spreadsheetId, range, options) {
-    const { data } = Syncit.fxSheets({
+  get(spreadsheetId, range, options ={}) {
+
+    const pack = {
       subProp: "values",
       prop: "spreadsheets",
       method: "get",
       params: {
         spreadsheetId: spreadsheetId,
-        range: range,
+        range,
         ...options
       }
-    })
-    // should be values, majorDimension, range
+    }
+    const cache = getWorkbookEntry(spreadsheetId, pack)
+    if (cache) {
+      return cache
+    } 
+
+    const { data } = Syncit.fxSheets(pack)
+
+    setWorkbookEntry(spreadsheetId, pack, data)
+    return data
+  }
+
+
+  /**
+   * batchUpdate: https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets.values/batchUpdate
+   * note that the order of args -- requests first then id - is different to usual
+   * Batch request looks like this https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/request#request
+   * @param {object} request batch request {request:Request[]}
+   */
+  batchUpdate(requests, spreadsheetId, { ss = false } = {}) {
+
+    const requestBody = requests
+
+    const pack = {
+      subProp: "values",
+      prop: "spreadsheets",
+      method: "batchUpdate",
+      params: {
+        spreadsheetId,
+        requestBody
+      }
+    }
+
+    const { response, data } = Syncit.fxSheets(pack)
+    
+    // naive cache - was an update so zap everything
+    clearWorkbookCache(spreadsheetId)
+
+    // maybe we need to throw an error
+    ssError (response, pack.method, ss)
+
     return data
   }
 

package/src/services/spreadsheetapp/fakecolor.js

@@ -0,0 +1,42 @@
+import { Proxies } from '../../support/proxies.js'
+import { FakeColorBase } from './fakecolorbase.js'
+import { newFakeRgbColor } from './fakergbcolor.js'
+import { newFakeThemeColor } from './fakethemecolor.js'
+
+/**
+ * @file
+ * @imports ../typedefs.js
+ */
+
+/**
+ * create a new FakeColor instance
+ * @param  {...any} args 
+ * @returns {FakeColor}
+ */
+export const newFakeColor = (...args) => {
+  return Proxies.guard(new FakeColor(...args))
+}
+
+
+class FakeColor extends FakeColorBase {
+  constructor(builder) {
+    super()
+    this.__type = builder.__type
+    this.__color = builder.__color
+    this.__themeColorType = builder.__themeColorType
+  }
+  asRgbColor() {
+    this.__checkType('RGB', 'RgbColor')
+    return newFakeRgbColor(this.__color)
+  }
+  asThemeColor() {
+    this.__checkType('THEME', 'ThemeColor')
+    return newFakeThemeColor(this.__themeColorType)
+  }
+  toString() {
+    return 'Color'
+  }
+
+
+}
+

package/src/services/spreadsheetapp/fakecolorbase.js

@@ -0,0 +1,28 @@
+import { newNummery } from '../../support/nummery.js'
+
+/**
+ * @file
+ * @imports ../typedefs.js
+ */
+
+export class FakeColorBase {
+  // this is color type UNSUPPORTED until built
+  constructor() {
+    this.__type = 'UNSUPPORTED'
+    this.__themeColorType = 'UNSUPPORTED'
+    this.__color = null
+  }
+  __checkType(type, mess) {
+    if (type !== this.__type) throw new Error(`Object is not of type ${mess}.`)
+  }
+
+  getColorType() {
+    return newNummery(this.__type)
+  }
+
+  getThemeColorType() {
+    return newNummery(this.__themeColorType)
+  }
+
+}
+

package/src/services/spreadsheetapp/fakecolorbuilder.js

@@ -0,0 +1,68 @@
+import { Proxies } from '../../support/proxies.js'
+import { newFakeColor } from './fakecolor.js'
+import { newFakeRgbColor } from './fakergbcolor.js'
+import { FakeColorBase } from './fakecolorbase.js'
+import { newFakeThemeColor } from './fakethemecolor.js'
+/**
+ * @file
+ * @imports ../typedefs.js
+ */
+/**
+ * create a new FakeColorBuilder instance
+ * @param  {...any} args 
+ * @returns {FakeColorBuilder}
+ */
+export const newFakeColorBuilder = (...args) => {
+  return Proxies.guard(new FakeColorBuilder(...args))
+}
+
+
+class FakeColorBuilder extends FakeColorBase {
+  constructor() {
+    super()
+  }
+
+  asRgbColor() {
+    this.__checkType('RGB', 'RgbColor')
+    return newFakeRgbColor(this.__color)
+  }
+
+  asThemeColor() {
+    this.__checkType('THEME', 'ThemeColor')
+    return newFakeThemeColor  (this.__themeColorType)
+  }
+
+  /**
+   * setRgbColor(cssString) https://developers.google.com/apps-script/reference/spreadsheet/color-builder#setrgbcolorcssstring
+   * Sets as RGB color
+   * @param {string} cssString The RGB color in CSS notation (such as '#ffffff').
+   * @returns {FakeColorBuilder} self
+   */
+  setRgbColor(cssString) {
+    this.__color = cssString
+    this.__type = 'RGB'
+    return this
+  }
+  
+  /**
+   * setThemeColor(themeColorType) https://developers.google.com/apps-script/reference/spreadsheet/color-builder#setthemecolorthemecolortype
+   * Sets as theme color.
+   * @param {ThemeColorType} The theme color type.
+   * @returns {FakeColorBuilder} self
+   */
+  setThemeColor(themeColorType) {
+    this.__themeColorType = themeColorType
+    this.__type = 'THEME'
+    return this
+  }
+
+  build() {
+    return newFakeColor(this)
+  }
+  toString() {
+    return 'ColorBuilder'
+  }
+
+
+}
+

package/src/services/spreadsheetapp/fakergbcolor.js

@@ -0,0 +1,80 @@
+import { newNummery } from '../../support/nummery.js'
+import { Proxies } from '../../support/proxies.js'
+import { Utils } from '../../support/utils.js'
+const { validateHex } = Utils
+
+/**
+ * @file
+ * @imports ../typedefs.js
+ */
+/**
+ * create a new FakeRgbColor instance
+ * @param  {...any} args 
+ * @returns {FakeRgbColor}
+ */
+export const newFakeRgbColor = (...args) => {
+  return Proxies.guard(new FakeRgbColor(...args))
+}
+
+
+class FakeRgbColor {
+  constructor(color) {
+    this.__color = color
+    this.__type = newNummery('RGB')
+  }
+  toString() {
+    return 'RgbColor'
+  }
+
+  __checkHex() {
+    const v = validateHex(this.__color)
+    if (!v) throw this.__invalidArg(this.__color)
+    return v
+  }
+
+  __invalidArg(value) {
+    throw new Error(`Invalid argument ${value}`)
+  }
+  /**
+   * asHexString() https://developers.google.com/apps-script/reference/base/rgb-color.html#ashexstring
+   * Returns the color as a CSS-style 7 character hexadecimal string (#rrggbb) or 9 character hexadecimal string (#aarrggbb).
+   * @returns {string}
+   */
+  asHexString() {
+    return this.__checkHex().hex
+  }
+
+  /**
+   * getBlue() https://developers.google.com/apps-script/reference/base/rgb-color.html#getblue
+   * The blue channel of this color, as a number from 0 to 255.
+   * @returns {number}
+   */
+  getBlue() {
+    return this.__checkHex().b
+  }
+  /**
+   * getColorType() https://developers.google.com/apps-script/reference/base/rgb-color.html#getcolortype
+   * Get the type of this color.
+   * @returns {ColorType}
+   */
+  getColorType() {
+    return this.__type
+  }
+  /**
+   * getGreen() https://developers.google.com/apps-script/reference/base/rgb-color.html#getgreen
+   * The green channel of this color, as a number from 0 to 255.
+   * @returns {number}
+   */
+  getGreen() {
+    return this.__checkHex().g
+  }
+  /**
+   * getRed() https://developers.google.com/apps-script/reference/base/rgb-color.html#getred
+   * The red channel of this color, as a number from 0 to 255.
+   * @returns {number}
+   */
+  getRed() {
+    return this.__checkHex().r
+  }
+}
+