google-sheets-mapper 2.1.0 → 2.2.0

package/README.md

@@ -20,7 +20,7 @@ pnpm add google-sheets-mapper
 bun add google-sheets-mapper
 ```
 
-UMD build available on [unpkg](https://www.unpkg.com/browse/google-sheets-mapper@1.0.0/dist/google-sheets-mapper.cjs.production.min.js).
+UMD build available on [unpkg](https://www.unpkg.com/browse/google-sheets-mapper/).
 
 ---
 

package/dist/index.cjs

@@ -10,25 +10,17 @@ const getSheetsTitleUrl = (sheetId, apiKey)=>{
 };
 const getBatchUrl = (sheetId, ranges, apiKey)=>{
     const rangesQueryString = getRanges(ranges);
-    return `${GOOGLE_API_URL}/${sheetId}?${rangesQueryString}&key=${apiKey}&includeGridData=true`;
+    return `${GOOGLE_API_URL}/${sheetId}/values:batchGet?${rangesQueryString}&key=${apiKey}`;
 };
-class ApiResponseError extends Error {
-    constructor(message, response){
-        super(message);
-        Object.setPrototypeOf(this, ApiResponseError.prototype);
-        this.response = response;
-        if (Error.captureStackTrace) {
-            Error.captureStackTrace(this, ApiResponseError);
-        }
-    }
-}
 const makeFetch = async (url, config = {})=>{
     const response = await fetch(url, config);
     if (!response.ok) {
-        throw new ApiResponseError(`Request to '${url}' failed with ${response.status}${response.statusText ? `: ${response.statusText}` : ""}`, {
-            status: response.status,
-            statusText: response.statusText,
-            url: response.url
+        throw new Error(`Request to '${url}' failed with ${response.status}${response.statusText ? `: ${response.statusText}` : ""}`, {
+            cause: {
+                status: response.status,
+                statusText: response.statusText,
+                url: response.url
+            }
         });
     }
     return await response.json();
@@ -42,7 +34,7 @@ const mapRecords = (records, headerData)=>{
             return obj;
         }, {}));
 };
-const mapData = ({ sheets, sheetsOptions = [] })=>{
+const mapData = ({ sheets = [], sheetsOptions = [] })=>{
     return sheets.map((sheet)=>{
         const id = sheet.range.split("!")[0].replace(/'/g, "");
         const rows = sheet.values || [];
@@ -70,7 +62,7 @@ const fetchBatchData = async ({ apiKey, sheetId, sheetsOptions = [] })=>{
 };
 const fetchAllSheetsData = async ({ apiKey, sheetId })=>{
     const urlTitles = getSheetsTitleUrl(sheetId, apiKey);
-    const { sheets } = await makeFetch(urlTitles);
+    const { sheets = [] } = await makeFetch(urlTitles);
     const sheetsOptions = sheets.map((sheet)=>({
             id: sheet.properties.title
         }));

package/dist/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","sources":["../src/types.ts","../src/index.ts"],"sourcesContent":["export interface SheetsOption {\n  id: string;\n  headerRowIndex?: number;\n}\n\nexport interface MapperOptions {\n  apiKey: string;\n  sheetId: string;\n  sheetsOptions?: SheetsOption[];\n}\n\nexport interface ValueRange {\n  majorDimensions: string;\n  range: string;\n  values: string[][];\n}\n\nexport interface ValueRangesResponse {\n  spreadsheetId: string;\n  valueRanges: ValueRange[];\n}\n\nexport interface PropertiesFromResponse {\n  title: string;\n}\n\nexport interface SheetFromResponse {\n  properties: PropertiesFromResponse;\n}\n\nexport interface SheetsResponse {\n  sheets: SheetFromResponse[];\n}\n\nexport interface MapperState {\n  id: string;\n  data: Record<string, string>[];\n}\n\nexport interface ApiResponse {\n  url: string;\n  status: number;\n  statusText: string;\n}\n\nexport interface ErrorResponse {\n  response: ApiResponse;\n}\n","import type { MapperOptions, MapperState, ValueRangesResponse } from \"./types\";\nimport { fetchBatchData, fetchAllSheetsData, mapData } from \"./utils\";\n\nconst GoogleSheetsMapper = {\n  async fetchGoogleSheetsData({\n    apiKey,\n    sheetId,\n    sheetsOptions = [],\n  }: MapperOptions): Promise<MapperState[]> {\n    const response: ValueRangesResponse =\n      sheetsOptions.length === 0\n        ? await fetchAllSheetsData({ apiKey, sheetId })\n        : await fetchBatchData({ apiKey, sheetId, sheetsOptions });\n    return mapData({ sheets: response.valueRanges, sheetsOptions });\n  },\n};\n\nexport default GoogleSheetsMapper;\nexport const fetchGoogleSheetsData = GoogleSheetsMapper.fetchGoogleSheetsData;\n"],"names":[],"mappings":"AAAO,UAAA,YAAA;AACP;AACA;AACA;AACO,UAAA,aAAA;AACP;AACA;AACA,oBAAA,YAAA;AACA;AAmBO,UAAA,WAAA;AACP;AACA,UAAA,MAAA;AACA;;AC7BA,cAAA,kBAAA;AACA,+DAAA,aAAA,GAAA,OAAA,CAAA,WAAA;AACA;;AAEO,cAAA,qBAAA,wCAAA,aAAA,KAAA,OAAA,CAAA,WAAA;;;;"}
+{"version":3,"file":"index.d.cts","sources":["../src/types.ts","../src/index.ts"],"sourcesContent":["export interface SheetsOption {\n  id: string;\n  headerRowIndex?: number;\n}\n\nexport interface MapperOptions {\n  apiKey: string;\n  sheetId: string;\n  sheetsOptions?: SheetsOption[];\n}\n\nexport interface ValueRange {\n  majorDimensions: string;\n  range: string;\n  values: string[][];\n}\n\nexport interface ValueRangesResponse {\n  spreadsheetId: string;\n  valueRanges: ValueRange[];\n}\n\nexport interface PropertiesFromResponse {\n  title: string;\n}\n\nexport interface SheetFromResponse {\n  properties: PropertiesFromResponse;\n}\n\nexport interface SheetsResponse {\n  sheets: SheetFromResponse[];\n}\n\nexport interface MapperState {\n  id: string;\n  data: Record<string, string>[];\n}\n","import type { MapperOptions, MapperState, ValueRangesResponse } from \"./types\";\nimport { fetchBatchData, fetchAllSheetsData, mapData } from \"./utils\";\n\nconst GoogleSheetsMapper = {\n  async fetchGoogleSheetsData({\n    apiKey,\n    sheetId,\n    sheetsOptions = [],\n  }: MapperOptions): Promise<MapperState[]> {\n    const response: ValueRangesResponse =\n      sheetsOptions.length === 0\n        ? await fetchAllSheetsData({ apiKey, sheetId })\n        : await fetchBatchData({ apiKey, sheetId, sheetsOptions });\n    return mapData({ sheets: response.valueRanges, sheetsOptions });\n  },\n};\n\nexport default GoogleSheetsMapper;\nexport const fetchGoogleSheetsData = GoogleSheetsMapper.fetchGoogleSheetsData;\n"],"names":[],"mappings":"AAAO,UAAA,YAAA;AACP;AACA;AACA;AACO,UAAA,aAAA;AACP;AACA;AACA,oBAAA,YAAA;AACA;AAmBO,UAAA,WAAA;AACP;AACA,UAAA,MAAA;AACA;;AC7BA,cAAA,kBAAA;AACA,+DAAA,aAAA,GAAA,OAAA,CAAA,WAAA;AACA;;AAEO,cAAA,qBAAA,wCAAA,aAAA,KAAA,OAAA,CAAA,WAAA;;;;"}

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sources":["../src/types.ts","../src/index.ts"],"sourcesContent":["export interface SheetsOption {\n  id: string;\n  headerRowIndex?: number;\n}\n\nexport interface MapperOptions {\n  apiKey: string;\n  sheetId: string;\n  sheetsOptions?: SheetsOption[];\n}\n\nexport interface ValueRange {\n  majorDimensions: string;\n  range: string;\n  values: string[][];\n}\n\nexport interface ValueRangesResponse {\n  spreadsheetId: string;\n  valueRanges: ValueRange[];\n}\n\nexport interface PropertiesFromResponse {\n  title: string;\n}\n\nexport interface SheetFromResponse {\n  properties: PropertiesFromResponse;\n}\n\nexport interface SheetsResponse {\n  sheets: SheetFromResponse[];\n}\n\nexport interface MapperState {\n  id: string;\n  data: Record<string, string>[];\n}\n\nexport interface ApiResponse {\n  url: string;\n  status: number;\n  statusText: string;\n}\n\nexport interface ErrorResponse {\n  response: ApiResponse;\n}\n","import type { MapperOptions, MapperState, ValueRangesResponse } from \"./types\";\nimport { fetchBatchData, fetchAllSheetsData, mapData } from \"./utils\";\n\nconst GoogleSheetsMapper = {\n  async fetchGoogleSheetsData({\n    apiKey,\n    sheetId,\n    sheetsOptions = [],\n  }: MapperOptions): Promise<MapperState[]> {\n    const response: ValueRangesResponse =\n      sheetsOptions.length === 0\n        ? await fetchAllSheetsData({ apiKey, sheetId })\n        : await fetchBatchData({ apiKey, sheetId, sheetsOptions });\n    return mapData({ sheets: response.valueRanges, sheetsOptions });\n  },\n};\n\nexport default GoogleSheetsMapper;\nexport const fetchGoogleSheetsData = GoogleSheetsMapper.fetchGoogleSheetsData;\n"],"names":[],"mappings":"AAAO,UAAA,YAAA;AACP;AACA;AACA;AACO,UAAA,aAAA;AACP;AACA;AACA,oBAAA,YAAA;AACA;AAmBO,UAAA,WAAA;AACP;AACA,UAAA,MAAA;AACA;;AC7BA,cAAA,kBAAA;AACA,+DAAA,aAAA,GAAA,OAAA,CAAA,WAAA;AACA;;AAEO,cAAA,qBAAA,wCAAA,aAAA,KAAA,OAAA,CAAA,WAAA;;;;"}
+{"version":3,"file":"index.d.ts","sources":["../src/types.ts","../src/index.ts"],"sourcesContent":["export interface SheetsOption {\n  id: string;\n  headerRowIndex?: number;\n}\n\nexport interface MapperOptions {\n  apiKey: string;\n  sheetId: string;\n  sheetsOptions?: SheetsOption[];\n}\n\nexport interface ValueRange {\n  majorDimensions: string;\n  range: string;\n  values: string[][];\n}\n\nexport interface ValueRangesResponse {\n  spreadsheetId: string;\n  valueRanges: ValueRange[];\n}\n\nexport interface PropertiesFromResponse {\n  title: string;\n}\n\nexport interface SheetFromResponse {\n  properties: PropertiesFromResponse;\n}\n\nexport interface SheetsResponse {\n  sheets: SheetFromResponse[];\n}\n\nexport interface MapperState {\n  id: string;\n  data: Record<string, string>[];\n}\n","import type { MapperOptions, MapperState, ValueRangesResponse } from \"./types\";\nimport { fetchBatchData, fetchAllSheetsData, mapData } from \"./utils\";\n\nconst GoogleSheetsMapper = {\n  async fetchGoogleSheetsData({\n    apiKey,\n    sheetId,\n    sheetsOptions = [],\n  }: MapperOptions): Promise<MapperState[]> {\n    const response: ValueRangesResponse =\n      sheetsOptions.length === 0\n        ? await fetchAllSheetsData({ apiKey, sheetId })\n        : await fetchBatchData({ apiKey, sheetId, sheetsOptions });\n    return mapData({ sheets: response.valueRanges, sheetsOptions });\n  },\n};\n\nexport default GoogleSheetsMapper;\nexport const fetchGoogleSheetsData = GoogleSheetsMapper.fetchGoogleSheetsData;\n"],"names":[],"mappings":"AAAO,UAAA,YAAA;AACP;AACA;AACA;AACO,UAAA,aAAA;AACP;AACA;AACA,oBAAA,YAAA;AACA;AAmBO,UAAA,WAAA;AACP;AACA,UAAA,MAAA;AACA;;AC7BA,cAAA,kBAAA;AACA,+DAAA,aAAA,GAAA,OAAA,CAAA,WAAA;AACA;;AAEO,cAAA,qBAAA,wCAAA,aAAA,KAAA,OAAA,CAAA,WAAA;;;;"}

package/dist/index.js

@@ -8,25 +8,17 @@ const getSheetsTitleUrl = (sheetId, apiKey)=>{
 };
 const getBatchUrl = (sheetId, ranges, apiKey)=>{
     const rangesQueryString = getRanges(ranges);
-    return `${GOOGLE_API_URL}/${sheetId}?${rangesQueryString}&key=${apiKey}&includeGridData=true`;
+    return `${GOOGLE_API_URL}/${sheetId}/values:batchGet?${rangesQueryString}&key=${apiKey}`;
 };
-class ApiResponseError extends Error {
-    constructor(message, response){
-        super(message);
-        Object.setPrototypeOf(this, ApiResponseError.prototype);
-        this.response = response;
-        if (Error.captureStackTrace) {
-            Error.captureStackTrace(this, ApiResponseError);
-        }
-    }
-}
 const makeFetch = async (url, config = {})=>{
     const response = await fetch(url, config);
     if (!response.ok) {
-        throw new ApiResponseError(`Request to '${url}' failed with ${response.status}${response.statusText ? `: ${response.statusText}` : ""}`, {
-            status: response.status,
-            statusText: response.statusText,
-            url: response.url
+        throw new Error(`Request to '${url}' failed with ${response.status}${response.statusText ? `: ${response.statusText}` : ""}`, {
+            cause: {
+                status: response.status,
+                statusText: response.statusText,
+                url: response.url
+            }
         });
     }
     return await response.json();
@@ -40,7 +32,7 @@ const mapRecords = (records, headerData)=>{
             return obj;
         }, {}));
 };
-const mapData = ({ sheets, sheetsOptions = [] })=>{
+const mapData = ({ sheets = [], sheetsOptions = [] })=>{
     return sheets.map((sheet)=>{
         const id = sheet.range.split("!")[0].replace(/'/g, "");
         const rows = sheet.values || [];
@@ -68,7 +60,7 @@ const fetchBatchData = async ({ apiKey, sheetId, sheetsOptions = [] })=>{
 };
 const fetchAllSheetsData = async ({ apiKey, sheetId })=>{
     const urlTitles = getSheetsTitleUrl(sheetId, apiKey);
-    const { sheets } = await makeFetch(urlTitles);
+    const { sheets = [] } = await makeFetch(urlTitles);
     const sheetsOptions = sheets.map((sheet)=>({
             id: sheet.properties.title
         }));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "google-sheets-mapper",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "### A library for getting data from Google Sheets API v4",
   "keywords": [
     "google-sheets",

package/src/types.ts

@@ -36,13 +36,3 @@ export interface MapperState {
   id: string;
   data: Record<string, string>[];
 }
-
-export interface ApiResponse {
-  url: string;
-  status: number;
-  statusText: string;
-}
-
-export interface ErrorResponse {
-  response: ApiResponse;
-}

package/src/utils.ts

@@ -1,7 +1,6 @@
 import type {
   MapperOptions,
   MapperState,
-  ApiResponse,
   ValueRange,
   SheetsResponse,
   SheetFromResponse,
@@ -23,33 +22,23 @@ const getSheetsTitleUrl = (sheetId: string, apiKey: string): string => {
 const getBatchUrl = (sheetId: string, ranges: Array<string>, apiKey: string): string => {
   const rangesQueryString = getRanges(ranges);
 
-  return `${GOOGLE_API_URL}/${sheetId}?${rangesQueryString}&key=${apiKey}&includeGridData=true`;
+  return `${GOOGLE_API_URL}/${sheetId}/values:batchGet?${rangesQueryString}&key=${apiKey}`;
 };
 
-class ApiResponseError extends Error {
-  response: ApiResponse;
-  constructor(message: string, response: ApiResponse) {
-    super(message);
-    Object.setPrototypeOf(this, ApiResponseError.prototype);
-    this.response = response;
-    if (Error.captureStackTrace) {
-      Error.captureStackTrace(this, ApiResponseError);
-    }
-  }
-}
-
 const makeFetch = async <T>(url: string, config = {}): Promise<T> => {
   const response = await fetch(url, config);
 
   if (!response.ok) {
-    throw new ApiResponseError(
+    throw new Error(
       `Request to '${url}' failed with ${response.status}${
         response.statusText ? `: ${response.statusText}` : ""
       }`,
       {
-        status: response.status,
-        statusText: response.statusText,
-        url: response.url,
+        cause: {
+          status: response.status,
+          statusText: response.statusText,
+          url: response.url,
+        },
       },
     );
   }
@@ -75,10 +64,10 @@ const mapRecords = (
 };
 
 export const mapData = ({
-  sheets,
+  sheets = [],
   sheetsOptions = [],
 }: {
-  sheets: ValueRange[];
+  sheets?: ValueRange[];
   sheetsOptions?: SheetsOption[];
 }): MapperState[] => {
   return sheets.map((sheet: ValueRange) => {
@@ -121,7 +110,7 @@ export const fetchAllSheetsData = async ({
   sheetId,
 }: MapperOptions): Promise<ValueRangesResponse> => {
   const urlTitles = getSheetsTitleUrl(sheetId, apiKey);
-  const { sheets }: SheetsResponse = await makeFetch(urlTitles);
+  const { sheets = [] }: SheetsResponse = await makeFetch(urlTitles);
   const sheetsOptions = sheets.map((sheet: SheetFromResponse) => ({
     id: sheet.properties.title,
   }));