google-spreadsheet 5.0.2 → 5.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "google-spreadsheet",
-  "version": "5.0.2",
+  "version": "5.1.0",
   "description": "Google Sheets API -- simple interface to read/write data and manage sheets",
   "keywords": [
     "google spreadsheets",
@@ -39,27 +39,37 @@
     "src/index.ts",
     "src/lib"
   ],
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "docs:preview": "docsify serve docs",
+    "lint": "eslint ./ --ext .ts",
+    "lint:fix": "bun run lint --fix",
+    "nodev": "node -v",
+    "readme:copy": "echo \"<!-- DO NOT EDIT THIS FILE, EDIT MAIN README.md AND RUN \\`bun readme:copy\\` instead -->\n\n_Welcome to the docs site for_\n\" | cat - README.md > docs/README.md",
+    "test": "vitest",
+    "test:ci": "vitest run"
+  },
   "dependencies": {
-    "es-toolkit": "^1.39.8",
-    "ky": "^1.8.2"
+    "es-toolkit": "^1.44.0",
+    "ky": "^1.14.3"
   },
   "devDependencies": {
-    "@changesets/cli": "^2.29.5",
-    "@types/node": "^24.2.0",
+    "@changesets/cli": "^2.29.8",
+    "@types/node": "^25.2.3",
     "@typescript-eslint/eslint-plugin": "^5.59.7",
     "@typescript-eslint/parser": "^5.59.7",
-    "auto-changelog": "^2.4.0",
     "docsify-cli": "^4.4.4",
     "eslint": "^8.41.0",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-config-airbnb-typescript": "^17.0.0",
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-no-floating-promise": "^1.0.2",
-    "google-auth-library": "^10.2.1",
-    "tsup": "^8.5.0",
-    "typescript": "^5.5.4",
-    "varlock": "^0.0.7",
-    "vitest": "^3.2.4"
+    "google-auth-library": "^10.5.0",
+    "tsdown": "^0.20.3",
+    "typescript": "^5.9.3",
+    "varlock": "^0.2.2",
+    "vitest": "^4.0.18"
   },
   "peerDependencies": {
     "google-auth-library": ">=8.8.0"
@@ -68,19 +78,5 @@
     "google-auth-library": {
       "optional": true
     }
-  },
-  "volta": {
-    "node": "20.17.0"
-  },
-  "scripts": {
-    "build": "tsup",
-    "dev": "tsup --watch",
-    "docs:preview": "docsify serve docs",
-    "lint": "eslint ./ --ext .ts",
-    "lint:fix": "pnpm run lint --fix",
-    "nodev": "node -v",
-    "readme:copy": "echo \"<!-- DO NOT EDIT THIS FILE, EDIT MAIN README.md AND RUN \\`npm readme:copy\\` instead -->\n\n_Welcome to the docs site for_\n\" | cat - README.md > docs/README.md",
-    "test": "vitest",
-    "test:ci": "vitest run"
   }
 }

package/src/lib/GoogleSpreadsheet.ts

@@ -3,7 +3,8 @@ import * as _ from './toolkit';
 import { GoogleSpreadsheetWorksheet } from './GoogleSpreadsheetWorksheet';
 import { getFieldMask } from './utils';
 import {
-  DataFilter, GridRange, NamedRangeId, SpreadsheetId, SpreadsheetProperties, WorksheetId, WorksheetProperties,
+  DataFilter, GridRange, NamedRangeId, ProtectedRange,
+  SpreadsheetId, SpreadsheetProperties, WorksheetId, WorksheetProperties,
 } from './types/sheets-types';
 import { PermissionRoles, PermissionsList, PublicPermissionRoles } from './types/drive-types';
 import { RecursivePartial } from './types/util-types';
@@ -125,6 +126,7 @@ export class GoogleSpreadsheet {
     // create a ky instance with sheet root URL and hooks to handle auth
     this.sheetsApi = ky.create({
       prefixUrl: `${SHEETS_API_BASE_URL}/${spreadsheetId}`,
+      timeout: 180_000,
       hooks: {
         beforeRequest: [(r) => this._setAuthRequestHook(r)],
         beforeError: [(e) => this._errorHook(e)],
@@ -143,7 +145,7 @@ export class GoogleSpreadsheet {
   // INTERNAL UTILITY FUNCTIONS ////////////////////////////////////////////////////////////////////
 
   /** @internal */
-  async _setAuthRequestHook(req: Request) {
+  async _setAuthRequestHook(req: Request): Promise<Request> {
     const authConfig = await getRequestAuthConfig(this.auth);
     if (authConfig.headers) {
       Object.entries(authConfig.headers).forEach(([key, val]) => {
@@ -239,13 +241,13 @@ export class GoogleSpreadsheet {
   _updateRawProperties(newProperties: SpreadsheetProperties) { this._rawProperties = newProperties; }
 
   /** @internal */
-  _updateOrCreateSheet(sheetInfo: { properties: WorksheetProperties, data: any }) {
-    const { properties, data } = sheetInfo;
+  _updateOrCreateSheet(sheetInfo: { properties: WorksheetProperties, data: any, protectedRanges?: ProtectedRange[] }) {
+    const { properties, data, protectedRanges } = sheetInfo;
     const { sheetId } = properties;
     if (!this._rawSheets[sheetId]) {
-      this._rawSheets[sheetId] = new GoogleSpreadsheetWorksheet(this, properties, data);
+      this._rawSheets[sheetId] = new GoogleSpreadsheetWorksheet(this, properties, data, protectedRanges);
     } else {
-      this._rawSheets[sheetId].updateRawData(properties, data);
+      this._rawSheets[sheetId].updateRawData(properties, data, protectedRanges);
     }
   }
 
@@ -367,9 +369,11 @@ export class GoogleSpreadsheet {
   ) {
     // TODO: add named range to local cache
     return this._makeSingleUpdateRequest('addNamedRange', {
-      name,
-      namedRangeId,
-      range,
+      namedRange: {
+        name,
+        namedRangeId,
+        range,
+      },
     });
   }
 
@@ -619,6 +623,14 @@ export class GoogleSpreadsheet {
     return shareReq.json();
   }
 
+  /**
+   * delete a permission by its ID
+   * @see https://developers.google.com/drive/api/v3/reference/permissions/delete
+   */
+  async deletePermission(permissionId: string) {
+    await this.driveApi.delete(`permissions/${permissionId}`);
+  }
+
   //
   // CREATE NEW DOC ////////////////////////////////////////////////////////////////////////////////
   static async createNewSpreadsheetDocument(auth: GoogleApiAuth, properties?: Partial<SpreadsheetProperties>) {

package/src/lib/GoogleSpreadsheetCell.ts

@@ -15,6 +15,7 @@ export class GoogleSpreadsheetCell {
   private _rawData?: CellData;
   private _draftData: any = {};
   private _error?: GoogleSpreadsheetCellErrorValue;
+  private _deleted = false;
 
   constructor(
     readonly _sheet: GoogleSpreadsheetWorksheet,
@@ -26,6 +27,8 @@ export class GoogleSpreadsheetCell {
     this._rawData = rawCellData; // so TS does not complain
   }
 
+  get deleted() { return this._deleted; }
+
   // TODO: figure out how to deal with empty rawData
   // newData can be undefined/null if the cell is totally empty and unformatted
   /**
@@ -49,6 +52,25 @@ export class GoogleSpreadsheetCell {
   get a1Row() { return this._rowIndex + 1; } // a1 row numbers start at 1 instead of 0
   get a1Address() { return `${this.a1Column}${this.a1Row}`; }
 
+  /**
+   * @internal
+   * Used internally to update cell indices after deleting rows/columns.
+   * Should not be called directly.
+   */
+  _updateIndices(rowIndex: RowIndex, columnIndex: ColumnIndex) {
+    this._rowIndex = rowIndex;
+    this._columnIndex = columnIndex;
+  }
+
+  /**
+   * @internal
+   * Used internally to mark cell as deleted.
+   * Should not be called directly.
+   */
+  _markDeleted() {
+    this._deleted = true;
+  }
+
   // CELL CONTENTS - VALUE/FORMULA/NOTES ///////////////////////////////////////////////////////////
   get value(): number | boolean | string | null | GoogleSpreadsheetCellErrorValue {
     // const typeKey = _.keys(this._rawData.effectiveValue)[0];
@@ -60,6 +82,8 @@ export class GoogleSpreadsheetCell {
 
 
   set value(newValue: number | boolean | Date | string | null | undefined | GoogleSpreadsheetCellErrorValue) {
+    if (this._deleted) throw new Error('This cell has been deleted - reload cells before making updates.');
+
     // had to include the GoogleSpreadsheetCellErrorValue in the type to make TS happy
     if (newValue instanceof GoogleSpreadsheetCellErrorValue) {
       throw new Error("You can't manually set a value to an error");

package/src/lib/GoogleSpreadsheetRow.ts

@@ -29,6 +29,16 @@ export class GoogleSpreadsheetRow<T extends Record<string, any> = Record<string,
   _updateRowNumber(newRowNumber: number) {
     this._rowNumber = newRowNumber;
   }
+
+  /**
+   * @internal
+   * Used internally to mark row as deleted.
+   * Should not be called directly.
+   */
+  _markDeleted() {
+    this._deleted = true;
+  }
+
   get a1Range() {
     return [
       this._worksheet.a1SheetName,