google-spreadsheet 5.1.0 → 5.2.0

package/README.md

@@ -22,6 +22,7 @@
 - managing worksheets - add, remove, resize, update properties (ex: title), duplicate to same or other document
 - managing docs - create new doc, delete doc, basic sharing/permissions
 - export - download sheet/docs in various formats
+- automatic retries with exponential backoff for failed/rate-limited requests (powered by [ky](https://github.com/sindresorhus/ky), [customizable](https://theoephraim.github.io/node-google-spreadsheet/#/classes/google-spreadsheet#fn-newGoogleSpreadsheet))
 
 **Docs site -**
 Full docs available at [https://theoephraim.github.io/node-google-spreadsheet](https://theoephraim.github.io/node-google-spreadsheet)
@@ -197,6 +198,7 @@ Contributions are welcome, but please follow the existing conventions, use the l
 
 The docs site is generated using [docsify](https://docsify.js.org). To preview and run locally so you can make edits, run `npm run docs:preview` and head to http://localhost:3000
 The content lives in markdown files in the docs folder.
+The package manager for this project is `bun`.
 
 ## License
 

package/dist/index.cjs

@@ -72,6 +72,12 @@ var GoogleSpreadsheetRow = class {
 		this._worksheet = _worksheet;
 		this._rowNumber = _rowNumber;
 		this._rawData = _rawData;
+		this._padRawData();
+	}
+	/** pad _rawData with empty strings so it always matches header length */
+	_padRawData() {
+		const headerLength = this._worksheet.headerValues.length;
+		while (this._rawData.length < headerLength) this._rawData.push("");
 	}
 	_deleted = false;
 	get deleted() {
@@ -143,7 +149,8 @@ var GoogleSpreadsheetRow = class {
 				majorDimension: "ROWS",
 				values: [this._rawData]
 			}
-		})).json()).updatedData.values[0];
+		})).json()).updatedData.values?.[0] || [];
+		this._padRawData();
 	}
 	/** delete this row */
 	async delete() {
@@ -320,8 +327,8 @@ var GoogleSpreadsheetCell = class {
 		return this.value;
 	}
 	set stringValue(val) {
-		if (val?.startsWith("=")) throw new Error("Use cell.formula to set formula values");
-		this.value = val;
+		this._draftData.valueType = "stringValue";
+		this._draftData.value = val || "";
 	}
 	/**
 	* Hyperlink contained within the cell.
@@ -674,6 +681,7 @@ var GoogleSpreadsheetWorksheet = class {
 				return `${this.a1SheetName}!${filter}`;
 			}
 			if (es_toolkit_compat.isObject(filter)) {
+				if ("developerMetadataLookup" in filter) return filter;
 				const filterAny = filter;
 				if (filterAny.sheetId && filterAny.sheetId !== this.sheetId) throw new Error("Leave sheet ID blank or set to matching ID of this sheet");
 				return {
@@ -1600,7 +1608,8 @@ var GoogleSpreadsheet = class GoogleSpreadsheet {
 	* initialize new GoogleSpreadsheet
 	* @category Initialization
 	* */
-	constructor(spreadsheetId, auth) {
+	constructor(spreadsheetId, auth, options) {
+		const { retryConfig } = options || {};
 		this.spreadsheetId = spreadsheetId;
 		this.auth = auth;
 		this._rawSheets = {};
@@ -1611,14 +1620,16 @@ var GoogleSpreadsheet = class GoogleSpreadsheet {
 			hooks: {
 				beforeRequest: [(r) => this._setAuthRequestHook(r)],
 				beforeError: [(e) => this._errorHook(e)]
-			}
+			},
+			retry: retryConfig
 		});
 		this.driveApi = ky.default.create({
 			prefixUrl: `${DRIVE_API_BASE_URL}/${spreadsheetId}`,
 			hooks: {
 				beforeRequest: [(r) => this._setAuthRequestHook(r)],
 				beforeError: [(e) => this._errorHook(e)]
-			}
+			},
+			retry: retryConfig
 		});
 	}
 	/** @internal */
@@ -1798,6 +1809,7 @@ var GoogleSpreadsheet = class GoogleSpreadsheet {
 			if (es_toolkit_compat.isString(filter)) return readOnlyMode ? filter : { a1Range: filter };
 			if (es_toolkit_compat.isObject(filter)) {
 				if (readOnlyMode) throw new Error("Only A1 ranges are supported when fetching cells with read-only access (using only an API key)");
+				if ("developerMetadataLookup" in filter) return { developerMetadataLookup: filter.developerMetadataLookup };
 				return { gridRange: filter };
 			}
 			throw new Error("Each filter must be an A1 range string or a gridrange object");
@@ -1912,6 +1924,15 @@ var GoogleSpreadsheet = class GoogleSpreadsheet {
 	async deletePermission(permissionId) {
 		await this.driveApi.delete(`permissions/${permissionId}`);
 	}
+	/**
+	* search for developer metadata entries matching the given filters
+	* @see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.developerMetadata/search
+	*/
+	async searchDeveloperMetadata(filters) {
+		const data = await (await this.sheetsApi.post("developerMetadata:search", { json: { dataFilters: filters } })).json();
+		if (!data.matchedDeveloperMetadata) return [];
+		return data.matchedDeveloperMetadata.map((m) => m.developerMetadata);
+	}
 	static async createNewSpreadsheetDocument(auth, properties) {
 		if (getAuthMode(auth) === AUTH_MODES.API_KEY) throw new Error("Cannot use api key only to create a new spreadsheet - it is only usable for read-only access of public docs");
 		const authConfig = await getRequestAuthConfig(auth);