google-spreadsheet - npm Package Compare versions

Comparing version 4.0.0 to 4.0.1

dist/index.d.ts

 import * as axios from 'axios';
 import { AxiosInstance, InternalAxiosRequestConfig, AxiosResponse, AxiosError } from 'axios';
+import { Stream } from 'stream';
+import { ReadableStream } from 'node:stream/web';
 import { Headers } from 'google-auth-library/build/src/auth/oauth2client';
@@ -9,3 +11,3 @@
     /** the A1 row (1-indexed) */
-    readonly _rowNumber: number;
+    private _rowNumber;
     /** raw underlying data for row */
@@ -22,3 +24,10 @@ private _rawData;
     get deleted(): boolean;
+    /** row number (matches A1 notation, ie first row is 1) */
     get rowNumber(): number;
+    /**
+     * @internal
+     * Used internally to update row numbers after deleting rows.
+     * Should not be called directly.
+    */
+    _updateRowNumber(newRowNumber: number): void;
     get a1Range(): string;
@@ -39,2 +48,8 @@ /** get row's value of specific cell (by header key) */
     delete(): Promise<any>;
+    /**
+     * @internal
+     * Used internally to clear row data after calling sheet.clearRows
+     * Should not be called directly.
+    */
+    _clearRowData(): void;
 }
@@ -498,3 +513,3 @@
     /**
-     * error contained in the cell, which cna happen with a bad formula (maybe some other weird cases?)
+     * error contained in the cell, which can happen with a bad formula (maybe some other weird cases?)
      */
@@ -636,2 +651,3 @@ get errorValue(): GoogleSpreadsheetCellErrorValue | undefined;
     addRow(rowValues: RawRowData, options?: AddRowOptions): Promise<GoogleSpreadsheetRow<Record<string, any>>>;
+    private _rowCache;
     getRows<T extends Record<string, any>>(options?: {
@@ -643,2 +659,8 @@ /** skip first N rows */
     }): Promise<GoogleSpreadsheetRow<T>[]>;
+    /**
+     * @internal
+     * Used internally to update row numbers after deleting rows.
+     * Should not be called directly.
+     * */
+    _shiftRowCache(deletedRowNumber: number): void;
     clearRows(options?: {
@@ -748,7 +770,13 @@ start?: number;
     /** exports worksheet as CSV file (comma-separated values) */
-    downloadAsCSV(returnStreamInsteadOfBuffer?: boolean): Promise<any>;
+    downloadAsCSV(): Promise<ArrayBuffer>;
+    downloadAsCSV(returnStreamInsteadOfBuffer: false): Promise<ArrayBuffer>;
+    downloadAsCSV(returnStreamInsteadOfBuffer: true): Promise<ReadableStream>;
     /** exports worksheet as TSC file (tab-separated values) */
-    downloadAsTSV(returnStreamInsteadOfBuffer?: boolean): Promise<any>;
+    downloadAsTSV(): Promise<ArrayBuffer>;
+    downloadAsTSV(returnStreamInsteadOfBuffer: false): Promise<ArrayBuffer>;
+    downloadAsTSV(returnStreamInsteadOfBuffer: true): Promise<ReadableStream>;
     /** exports worksheet as PDF */
-    downloadAsPDF(returnStreamInsteadOfBuffer?: boolean): Promise<any>;
+    downloadAsPDF(): Promise<ArrayBuffer>;
+    downloadAsPDF(returnStreamInsteadOfBuffer: false): Promise<ArrayBuffer>;
+    downloadAsPDF(returnStreamInsteadOfBuffer: true): Promise<ReadableStream>;
 }
@@ -921,3 +949,3 @@
      */
-    _downloadAs(fileType: ExportFileTypes, worksheetId?: WorksheetId, returnStreamInsteadOfBuffer?: boolean): Promise<any>;
+    _downloadAs(fileType: ExportFileTypes, worksheetId: WorksheetId | undefined, returnStreamInsteadOfBuffer?: boolean): Promise<any>;
     /**
@@ -927,2 +955,9 @@ * exports entire document as html file (zipped)
      * */
+    downloadAsZippedHTML(): Promise<ArrayBuffer>;
+    downloadAsZippedHTML(returnStreamInsteadOfBuffer: false): Promise<ArrayBuffer>;
+    downloadAsZippedHTML(returnStreamInsteadOfBuffer: true): Promise<Stream>;
+    /**
+     * @deprecated
+     * use `doc.downloadAsZippedHTML()` instead
+     * */
     downloadAsHTML(returnStreamInsteadOfBuffer?: boolean): Promise<any>;
@@ -933,3 +968,5 @@ /**
      * */
-    downloadAsXLSX(returnStreamInsteadOfBuffer?: boolean): Promise<any>;
+    downloadAsXLSX(): Promise<ArrayBuffer>;
+    downloadAsXLSX(returnStreamInsteadOfBuffer: false): Promise<ArrayBuffer>;
+    downloadAsXLSX(returnStreamInsteadOfBuffer: true): Promise<Stream>;
     /**
@@ -939,3 +976,5 @@ * exports entire document as ods spreadsheet (Open Office)
     */
-    downloadAsODS(returnStreamInsteadOfBuffer?: boolean): Promise<any>;
+    downloadAsODS(): Promise<ArrayBuffer>;
+    downloadAsODS(returnStreamInsteadOfBuffer: false): Promise<ArrayBuffer>;
+    downloadAsODS(returnStreamInsteadOfBuffer: true): Promise<Stream>;
     delete(): Promise<any>;
@@ -942,0 +981,0 @@ /**

package.json

 {
   "name": "google-spreadsheet",
-  "version": "4.0.0",
+  "version": "4.0.1",
   "description": "Google Sheets API -- simple interface to read/write data and manage sheets",
@@ -64,3 +64,3 @@ "keywords": [
     "axios": "^1.4.0",
-    "lodash-es": "^4.17.21"
+    "lodash": "^4.17.21"
   },
@@ -72,3 +72,2 @@ "devDependencies": {
     "@types/lodash": "^4.14.195",
-    "@types/lodash-es": "^4.17.7",
     "@types/node": "^20.2.5",
@@ -91,3 +90,2 @@ "@typescript-eslint/eslint-plugin": "^5.59.7",
     "jest-junit": "^16.0.0",
-    "lodash": "^4.17.21",
     "release-it": "^15.11.0",
@@ -94,0 +92,0 @@ "ts-node": "^10.9.1",

src/lib/GoogleSpreadsheet.ts

@@ -1,2 +0,1 @@
-import * as _ from 'lodash-es';
 import Axios, {
@@ -7,2 +6,3 @@ AxiosError, AxiosInstance, AxiosResponse, InternalAxiosRequestConfig,
 import { Stream } from 'stream';
+import * as _ from './lodash';
 import { GoogleSpreadsheetWorksheet } from './GoogleSpreadsheetWorksheet';
@@ -275,3 +275,2 @@ import { axiosParamsSerializer, getFieldMask } from './utils';
 
-
   resetLocalCache() {
@@ -278,0 +277,0 @@ this._rawProperties = null;

src/lib/GoogleSpreadsheetCell.ts

 /* eslint-disable max-classes-per-file */
-import * as _ from 'lodash-es';
+import * as _ from './lodash';
 
@@ -4,0 +4,0 @@ import { columnToLetter } from './utils';

src/lib/GoogleSpreadsheetWorksheet.ts

@@ -1,4 +0,4 @@
-import * as _ from 'lodash-es';
+import { ReadableStream } from 'node:stream/web';
+import * as _ from './lodash';
 
-import { ReadableStream } from 'node:stream/web';
 import { GoogleSpreadsheetRow } from './GoogleSpreadsheetRow';
@@ -5,0 +5,0 @@ import { GoogleSpreadsheetCell } from './GoogleSpreadsheetCell';

src/lib/utils.ts

@@ -1,2 +0,2 @@
-import * as _ from 'lodash-es';
+import * as _ from './lodash';
 
@@ -3,0 +3,0 @@ export function getFieldMask(obj: Record<string, unknown>) {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

211134

increased by2.9%

Dev dependency count

25

decreased by-7.41%

Number of package files

17

increased by6.25%

Lines of code

3569

increased by2.29%

Number of medium supply chain risk alerts

0

decreased by-100%

Dependency changes

• + Addedlodash@^4.17.21

• + Addedlodash@4.17.21(transitive)

• - Removedlodash-es@^4.17.21

• - Removedlodash-es@4.17.21(transitive)