@noloco/google-spreadsheet - npm Package Compare versions

Comparing version 4.1.2 to 4.1.3

dist/index.d.ts

@@ -583,3 +583,3 @@ import * as axios from 'axios';
     save(): Promise<void>;
-    createDeveloperMetadata(metadataKey: DeveloperMetadataKey, metadataValue: DeveloperMetadataValue, visibility: DeveloperMetadataVisibility, metadataId: DeveloperMetadataId): Promise<any>;
+    createDeveloperMetadata(metadataKey: DeveloperMetadataKey, metadataValue: DeveloperMetadataValue, visibility?: DeveloperMetadataVisibility, metadataId?: DeveloperMetadataId): Promise<any>;
     getDeveloperMetadata(): Promise<any>;
@@ -640,2 +640,4 @@ /**
     get rightToLeft(): WorksheetProperties['rightToLeft'];
+    get rowMetadata(): any[];
+    get columnMetadata(): any[];
     set sheetId(newVal: WorksheetProperties['sheetId']);
@@ -764,3 +766,3 @@ set title(newVal: WorksheetProperties['title']);
     deleteBanding(): Promise<void>;
-    createDeveloperMetadata(metadataKey: DeveloperMetadataKey, metadataValue: DeveloperMetadataValue, visibility: DeveloperMetadataVisibility, metadataId: DeveloperMetadataId): Promise<any>;
+    createDeveloperMetadata(metadataKey: DeveloperMetadataKey, metadataValue: DeveloperMetadataValue, visibility?: DeveloperMetadataVisibility, metadataId?: DeveloperMetadataId): Promise<any>;
     updateDeveloperMetadata(): Promise<void>;
@@ -1012,7 +1014,7 @@ deleteDeveloperMetadata(): Promise<void>;
     static createNewSpreadsheetDocument(auth: GoogleApiAuth, properties?: Partial<SpreadsheetProperties>): Promise<GoogleSpreadsheet>;
-    _createDeveloperMetadata(metadataKey: DeveloperMetadataKey, metadataValue: DeveloperMetadataValue, location: Partial<DeveloperMetadataLocation>, visibility: DeveloperMetadataVisibility, metadataId: DeveloperMetadataId): Promise<any>;
+    _createDeveloperMetadata(metadataKey: DeveloperMetadataKey, metadataValue: DeveloperMetadataValue, location: Partial<DeveloperMetadataLocation>, visibility?: DeveloperMetadataVisibility, metadataId?: DeveloperMetadataId): Promise<any>;
     _getDeveloperMetadata(dataFilter: DataFilterObject): Promise<any>;
     getMetadataById(metadataId: DeveloperMetadataId): Promise<any>;
-    createSheetDeveloperMetadata(metadataKey: DeveloperMetadataKey, metadataValue: DeveloperMetadataValue, sheetId: number, visibility: DeveloperMetadataVisibility, metadataId: DeveloperMetadataId): Promise<any>;
-    createRangeDeveloperMetadata(metadataKey: DeveloperMetadataKey, metadataValue: DeveloperMetadataValue, range: DimensionRange, visibility: DeveloperMetadataVisibility, metadataId: DeveloperMetadataId): Promise<any>;
+    createSheetDeveloperMetadata(metadataKey: DeveloperMetadataKey, metadataValue: DeveloperMetadataValue, sheetId: number, visibility?: DeveloperMetadataVisibility, metadataId?: DeveloperMetadataId): Promise<any>;
+    createRangeDeveloperMetadata(metadataKey: DeveloperMetadataKey, metadataValue: DeveloperMetadataValue, range: DimensionRange, visibility?: DeveloperMetadataVisibility, metadataId?: DeveloperMetadataId): Promise<any>;
     getDeveloperMetadataByA1Range(a1Range: A1Range): Promise<any>;
@@ -1022,2 +1024,2 @@ getDeveloperMetadataByGridRange(gridRange: GridRange): Promise<any>;
 
-export { GoogleSpreadsheet, GoogleSpreadsheetCell, GoogleSpreadsheetCellErrorValue, GoogleSpreadsheetRow, GoogleSpreadsheetWorksheet };
+export { GetValuesRequestOptions, GoogleSpreadsheet, GoogleSpreadsheetCell, GoogleSpreadsheetCellErrorValue, GoogleSpreadsheetRow, GoogleSpreadsheetWorksheet };

package.json

 {
   "name": "@noloco/google-spreadsheet",
-  "version": "4.1.2",
+  "version": "4.1.3",
   "description": "Google Sheets API -- simple interface to read/write data and manage sheets",
@@ -5,0 +5,0 @@ "keywords": [

src/index.ts

@@ -6,1 +6,2 @@ export { GoogleSpreadsheet } from './lib/GoogleSpreadsheet';
 export { GoogleSpreadsheetCellErrorValue } from './lib/GoogleSpreadsheetCellErrorValue';
+export type { GetValuesRequestOptions } from './lib/types/sheets-types';

src/lib/GoogleSpreadsheet.ts

 import Axios, {AxiosError, AxiosInstance, AxiosResponse, InternalAxiosRequestConfig,} from 'axios';
-
 import {Stream} from 'stream';
@@ -684,4 +683,4 @@ import * as _ from './lodash';
     location:Partial<DeveloperMetadataLocation>,
-    visibility:DeveloperMetadataVisibility,
-    metadataId:DeveloperMetadataId
+    visibility?:DeveloperMetadataVisibility,
+    metadataId?:DeveloperMetadataId
   ) {
@@ -723,4 +722,4 @@ // Request type = `createDeveloperMetadata`
     sheetId: number,
-    visibility:DeveloperMetadataVisibility,
-    metadataId:DeveloperMetadataId
+    visibility?:DeveloperMetadataVisibility,
+    metadataId?:DeveloperMetadataId
   ) {
@@ -742,4 +741,4 @@ return this._createDeveloperMetadata(
     range: DimensionRange,
-    visibility:DeveloperMetadataVisibility,
-    metadataId:DeveloperMetadataId
+    visibility?: DeveloperMetadataVisibility,
+    metadataId?: DeveloperMetadataId
   ) {
@@ -746,0 +745,0 @@ return this._createDeveloperMetadata(

src/lib/GoogleSpreadsheetCell.ts

@@ -252,6 +252,6 @@ /* eslint-disable max-classes-per-file */
   async createDeveloperMetadata(
-    metadataKey:DeveloperMetadataKey,
-    metadataValue:DeveloperMetadataValue,
-    visibility:DeveloperMetadataVisibility,
-    metadataId:DeveloperMetadataId
+    metadataKey: DeveloperMetadataKey,
+    metadataValue: DeveloperMetadataValue,
+    visibility?: DeveloperMetadataVisibility,
+    metadataId?: DeveloperMetadataId
   ) {
@@ -258,0 +258,0 @@ return this._sheet._spreadsheet.createRangeDeveloperMetadata(

src/lib/GoogleSpreadsheetWorksheet.ts

 import {ReadableStream} from 'node:stream/web';
 import * as _ from './lodash';
-
 import {GoogleSpreadsheetRow} from './GoogleSpreadsheetRow';
 import {GoogleSpreadsheetCell} from './GoogleSpreadsheetCell';
-
 import {checkForDuplicateHeaders, columnToLetter, getFieldMask, letterToColumn,} from './utils';
@@ -184,2 +182,4 @@ import {GoogleSpreadsheet} from './GoogleSpreadsheet';
   get rightToLeft() { return this._getProp('rightToLeft'); }
+  get rowMetadata(): any[] { return this._rowMetadata; }
+  get columnMetadata(): any[] { return this._columnMetadata; }
 
@@ -505,10 +505,18 @@ set sheetId(newVal: WorksheetProperties['sheetId']) { this._setProp('sheetId', newVal); }
     // However, you can retrieve the relevant data and sort through it as needed in your application
-    const offset = options?.offset || 0;
-    const limit = options?.limit || this.rowCount - 1;
-    const valueRequestOptions = {
-      ...options,
-      limit: undefined,
-      offset: undefined,
-    };
+    const offset = options?.offset ?? 0;
+    const limit = options?.limit ?? this.rowCount - 1;
+    let valueRequestOptions: GetValuesRequestOptions | undefined;
 
+    if (options?.majorDimension) {
+      valueRequestOptions = { majorDimension: options.majorDimension };
+    }
+
+    if (options?.valueRenderOption) {
+      if (!valueRequestOptions) {
+        valueRequestOptions = { valueRenderOption: options.valueRenderOption };
+      } else {
+        valueRequestOptions.valueRenderOption = options.valueRenderOption;
+      }
+    }
+
     await this._ensureHeaderRowLoaded();
@@ -904,4 +912,4 @@
     metadataValue: DeveloperMetadataValue,
-    visibility: DeveloperMetadataVisibility,
-    metadataId: DeveloperMetadataId
+    visibility?: DeveloperMetadataVisibility,
+    metadataId?: DeveloperMetadataId
   ) {
@@ -908,0 +916,0 @@ // Request type = `createDeveloperMetadata`

Fixed alerts

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

226475

increased by0.48%

Lines of code

3863

increased by0.29%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes