google-sheets-mapper 1.0.1 → 2.1.0

package/README.md

@@ -8,16 +8,16 @@
 
 ## Installation
 
-Package can be added using **yarn**:
-
 ```bash
-yarn add google-sheets-mapper
+npm install google-sheets-mapper
 ```
 
-Or, use **NPM**:
+```bash
+pnpm add google-sheets-mapper
+```
 
 ```bash
-npm install 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).
@@ -44,7 +44,7 @@ https://docs.google.com/spreadsheets/d/[THIS-IS-THE-SHEET-ID]/
 ### Get data from all sheets inside the spreadsheet
 
 ```js
-import { fetchGoogleSheetsData } from 'google-sheets-mapper';
+import { fetchGoogleSheetsData } from "google-sheets-mapper";
 
 const getData = async () => {
   try {
@@ -63,14 +63,14 @@ const getData = async () => {
 Don't use single quotes on sheet names, they will be removed because when using space in sheet name it will be returned wrapped with single quotes and plugin will remove them for clean string id.
 
 ```js
-import { fetchGoogleSheetsData } from 'google-sheets-mapper';
+import { fetchGoogleSheetsData } from "google-sheets-mapper";
 
 const getData = async () => {
   try {
     return await fetchGoogleSheetsData({
       apiKey: process.env.REACT_APP_GOOGLE_API_KEY,
       sheetId: process.env.REACT_APP_GOOGLE_SHEETS_ID,
-      sheetsNames: ['Sheet1'],
+      sheetsOptions: [{ id: "Sheet1" }],
     });
   } catch (error) {
     console.error(error);
@@ -84,15 +84,15 @@ const getData = async () => {
 
 The `GoogleSheetsMapper.fetchGoogleSheetsData` function takes an object with three properties:
 
-| Name        | Value  |
-| ----------- | ------ |
-| apiKey      | string |
-| sheetId     | string |
-| sheetsNames | array  |
+| Name          | Value  |
+| ------------- | ------ |
+| apiKey        | string |
+| sheetId       | string |
+| sheetsOptions | array  |
 
 - `apiKey` is a Google Sheets API v4 key from [Google Cloud Console](https://console.cloud.google.com/).
 - `sheetId` is the id of the sheet.
-- `sheetsNames` is an array of specific sheet names. Can be left out then it will fallback to all sheets inside the spreadsheet.
+- `sheetsOptions` is an array of specific objects `{ id, headerRowIndex }`. Can be left out then it will fallback to all sheets inside the spreadsheet and use first row from sheet as header.
 
 ### Exposed Data
 
@@ -109,19 +109,20 @@ try {
 }
 ```
 
-| Name | Value |
-| ---- | ----- |
-| data | array |
+| Name  | Value          |
+| ----- | -------------- |
+| data  | array          |
+| error | null or object |
 
 - `data` is an array of mapped data objects.
 
 ```js
 [
   {
-    id: 'Sheet1',
+    id: "Sheet1",
     data: [
-      { value: 'et', key: 'language' },
-      { value: 'Test sheet', key: 'title' },
+      { value: "et", key: "language" },
+      { value: "Test sheet", key: "title" },
     ],
   },
 ];
@@ -136,3 +137,9 @@ try {
   url: 'https://sheets.googleapis.com/v4/spreadsheets/...',
 }
 ```
+
+---
+
+## Migration from v1 to v2
+
+- Change `sheetsNames` array of string to `sheetsOptions` array of objects with `{ id: 'sheetName' }`

package/dist/index.cjs

@@ -0,0 +1,103 @@
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const GOOGLE_API_URL = "https://sheets.googleapis.com/v4/spreadsheets";
+const getRanges = (sheetNames = [])=>{
+    // ranges=Sheet1&ranges=Sheet2
+    return sheetNames.map((sheetName)=>`ranges=${sheetName}`).join("&");
+};
+const getSheetsTitleUrl = (sheetId, apiKey)=>{
+    return `${GOOGLE_API_URL}/${sheetId}?fields=sheets%2Fproperties%2Ftitle&key=${apiKey}`;
+};
+const getBatchUrl = (sheetId, ranges, apiKey)=>{
+    const rangesQueryString = getRanges(ranges);
+    return `${GOOGLE_API_URL}/${sheetId}?${rangesQueryString}&key=${apiKey}&includeGridData=true`;
+};
+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
+        });
+    }
+    return await response.json();
+};
+const mapRecords = (records, headerData)=>{
+    return records.filter((record)=>record.length > 0).map((record)=>record.reduce((obj, item, index)=>{
+            const key = headerData[index];
+            if (key !== undefined) {
+                obj[key] = item;
+            }
+            return obj;
+        }, {}));
+};
+const mapData = ({ sheets, sheetsOptions = [] })=>{
+    return sheets.map((sheet)=>{
+        const id = sheet.range.split("!")[0].replace(/'/g, "");
+        const rows = sheet.values || [];
+        if (rows.length > 0) {
+            const sheetsOptionsSheet = sheetsOptions.find((option)=>option.id === id);
+            const headerRowIndex = sheetsOptionsSheet?.headerRowIndex ?? 0;
+            const header = rows[headerRowIndex];
+            const records = rows.filter((_, index)=>index > headerRowIndex);
+            const recordsData = mapRecords(records, header);
+            return {
+                id,
+                data: recordsData
+            };
+        }
+        return {
+            id,
+            data: []
+        };
+    });
+};
+const fetchBatchData = async ({ apiKey, sheetId, sheetsOptions = [] })=>{
+    const sheetsNames = sheetsOptions.map((option)=>option.id);
+    const url = getBatchUrl(sheetId, sheetsNames, apiKey);
+    return await makeFetch(url);
+};
+const fetchAllSheetsData = async ({ apiKey, sheetId })=>{
+    const urlTitles = getSheetsTitleUrl(sheetId, apiKey);
+    const { sheets } = await makeFetch(urlTitles);
+    const sheetsOptions = sheets.map((sheet)=>({
+            id: sheet.properties.title
+        }));
+    return await fetchBatchData({
+        apiKey,
+        sheetId,
+        sheetsOptions
+    });
+};
+
+const GoogleSheetsMapper = {
+    async fetchGoogleSheetsData ({ apiKey, sheetId, sheetsOptions = [] }) {
+        const response = sheetsOptions.length === 0 ? await fetchAllSheetsData({
+            apiKey,
+            sheetId
+        }) : await fetchBatchData({
+            apiKey,
+            sheetId,
+            sheetsOptions
+        });
+        return mapData({
+            sheets: response.valueRanges,
+            sheetsOptions
+        });
+    }
+};
+const fetchGoogleSheetsData = GoogleSheetsMapper.fetchGoogleSheetsData;
+
+exports.default = GoogleSheetsMapper;
+exports.fetchGoogleSheetsData = fetchGoogleSheetsData;

package/dist/index.d.cts

@@ -0,0 +1,22 @@
+interface SheetsOption {
+    id: string;
+    headerRowIndex?: number;
+}
+interface MapperOptions {
+    apiKey: string;
+    sheetId: string;
+    sheetsOptions?: SheetsOption[];
+}
+interface MapperState {
+    id: string;
+    data: Record<string, string>[];
+}
+
+declare const GoogleSheetsMapper: {
+    fetchGoogleSheetsData({ apiKey, sheetId, sheetsOptions, }: MapperOptions): Promise<MapperState[]>;
+};
+
+declare const fetchGoogleSheetsData: ({ apiKey, sheetId, sheetsOptions, }: MapperOptions) => Promise<MapperState[]>;
+
+export { GoogleSheetsMapper as default, fetchGoogleSheetsData };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +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;;;;"}

package/dist/index.d.ts

@@ -1,6 +1,22 @@
-import { MapperOptions, MapperState } from './types';
-declare const GoogleSheetsMapper: {
-    fetchGoogleSheetsData({ apiKey, sheetId, sheetsNames, }: MapperOptions): Promise<MapperState[]>;
-};
-export default GoogleSheetsMapper;
-export declare const fetchGoogleSheetsData: ({ apiKey, sheetId, sheetsNames, }: MapperOptions) => Promise<MapperState[]>;
+interface SheetsOption {
+    id: string;
+    headerRowIndex?: number;
+}
+interface MapperOptions {
+    apiKey: string;
+    sheetId: string;
+    sheetsOptions?: SheetsOption[];
+}
+interface MapperState {
+    id: string;
+    data: Record<string, string>[];
+}
+
+declare const GoogleSheetsMapper: {
+    fetchGoogleSheetsData({ apiKey, sheetId, sheetsOptions, }: MapperOptions): Promise<MapperState[]>;
+};
+
+declare const fetchGoogleSheetsData: ({ apiKey, sheetId, sheetsOptions, }: MapperOptions) => Promise<MapperState[]>;
+
+export { GoogleSheetsMapper as default, fetchGoogleSheetsData };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +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;;;;"}

package/dist/index.js

@@ -1,8 +1,100 @@
+const GOOGLE_API_URL = "https://sheets.googleapis.com/v4/spreadsheets";
+const getRanges = (sheetNames = [])=>{
+    // ranges=Sheet1&ranges=Sheet2
+    return sheetNames.map((sheetName)=>`ranges=${sheetName}`).join("&");
+};
+const getSheetsTitleUrl = (sheetId, apiKey)=>{
+    return `${GOOGLE_API_URL}/${sheetId}?fields=sheets%2Fproperties%2Ftitle&key=${apiKey}`;
+};
+const getBatchUrl = (sheetId, ranges, apiKey)=>{
+    const rangesQueryString = getRanges(ranges);
+    return `${GOOGLE_API_URL}/${sheetId}?${rangesQueryString}&key=${apiKey}&includeGridData=true`;
+};
+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
+        });
+    }
+    return await response.json();
+};
+const mapRecords = (records, headerData)=>{
+    return records.filter((record)=>record.length > 0).map((record)=>record.reduce((obj, item, index)=>{
+            const key = headerData[index];
+            if (key !== undefined) {
+                obj[key] = item;
+            }
+            return obj;
+        }, {}));
+};
+const mapData = ({ sheets, sheetsOptions = [] })=>{
+    return sheets.map((sheet)=>{
+        const id = sheet.range.split("!")[0].replace(/'/g, "");
+        const rows = sheet.values || [];
+        if (rows.length > 0) {
+            const sheetsOptionsSheet = sheetsOptions.find((option)=>option.id === id);
+            const headerRowIndex = sheetsOptionsSheet?.headerRowIndex ?? 0;
+            const header = rows[headerRowIndex];
+            const records = rows.filter((_, index)=>index > headerRowIndex);
+            const recordsData = mapRecords(records, header);
+            return {
+                id,
+                data: recordsData
+            };
+        }
+        return {
+            id,
+            data: []
+        };
+    });
+};
+const fetchBatchData = async ({ apiKey, sheetId, sheetsOptions = [] })=>{
+    const sheetsNames = sheetsOptions.map((option)=>option.id);
+    const url = getBatchUrl(sheetId, sheetsNames, apiKey);
+    return await makeFetch(url);
+};
+const fetchAllSheetsData = async ({ apiKey, sheetId })=>{
+    const urlTitles = getSheetsTitleUrl(sheetId, apiKey);
+    const { sheets } = await makeFetch(urlTitles);
+    const sheetsOptions = sheets.map((sheet)=>({
+            id: sheet.properties.title
+        }));
+    return await fetchBatchData({
+        apiKey,
+        sheetId,
+        sheetsOptions
+    });
+};
 
-'use strict'
+const GoogleSheetsMapper = {
+    async fetchGoogleSheetsData ({ apiKey, sheetId, sheetsOptions = [] }) {
+        const response = sheetsOptions.length === 0 ? await fetchAllSheetsData({
+            apiKey,
+            sheetId
+        }) : await fetchBatchData({
+            apiKey,
+            sheetId,
+            sheetsOptions
+        });
+        return mapData({
+            sheets: response.valueRanges,
+            sheetsOptions
+        });
+    }
+};
+const fetchGoogleSheetsData = GoogleSheetsMapper.fetchGoogleSheetsData;
 
-if (process.env.NODE_ENV === 'production') {
-  module.exports = require('./google-sheets-mapper.cjs.production.min.js')
-} else {
-  module.exports = require('./google-sheets-mapper.cjs.development.js')
-}
+export { GoogleSheetsMapper as default, fetchGoogleSheetsData };

package/package.json

@@ -1,67 +1,62 @@
 {
   "name": "google-sheets-mapper",
+  "version": "2.1.0",
   "description": "### A library for getting data from Google Sheets API v4",
-  "version": "1.0.1",
-  "author": "Gert Glükmann <gglukmann@gmail.com>",
-  "license": "MIT",
+  "keywords": [
+    "google-sheets",
+    "google-sheets-api",
+    "google-sheets-api-v4",
+    "google-sheets-mapper"
+  ],
+  "homepage": "https://github.com/gglukmann/use-google-sheets#readme",
   "bugs": {
     "url": "https://github.com/gglukmann/use-google-sheets/issues"
   },
-  "homepage": "https://github.com/gglukmann/use-google-sheets#readme",
-  "directories": {
-    "test": "test"
-  },
+  "license": "MIT",
+  "author": "Gert Glükmann <gglukmann@gmail.com>",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/gglukmann/google-sheets-mapper.git"
   },
-  "keywords": [
-    "google-sheets-mapper",
-    "google-sheets",
-    "google-sheets-api",
-    "google-sheets-api-v4"
-  ],
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
   "files": [
     "dist",
     "src"
   ],
-  "engines": {
-    "node": ">=10"
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
   },
   "scripts": {
-    "start": "tsdx watch",
+    "dev": "tsdx dev",
     "build": "tsdx build",
     "test": "tsdx test",
     "lint": "tsdx lint",
-    "prepare": "tsdx build",
-    "size": "size-limit",
-    "analyze": "size-limit --why"
+    "format": "tsdx format",
+    "typecheck": "tsdx typecheck",
+    "prepublishOnly": "bun run build"
   },
-  "peerDependencies": {},
-  "husky": {
-    "hooks": {
-      "pre-commit": "tsdx lint"
-    }
-  },
-  "module": "dist/google-sheets-mapper.esm.js",
-  "size-limit": [
-    {
-      "path": "dist/google-sheets-mapper.cjs.production.min.js",
-      "limit": "10 KB"
-    },
-    {
-      "path": "dist/google-sheets-mapper.esm.js",
-      "limit": "10 KB"
-    }
-  ],
   "devDependencies": {
-    "@size-limit/preset-small-lib": "^4.7.0",
-    "husky": "^4.3.0",
-    "size-limit": "^4.7.0",
-    "tsdx": "^0.14.1",
-    "tslib": "^2.0.3",
-    "typescript": "^4.0.5"
+    "bunchee": "^6.9.4",
+    "oxfmt": "^0.27.0",
+    "oxlint": "^1.42.0",
+    "tsdx": "^2.0.0",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.18"
+  },
+  "engines": {
+    "node": ">=20"
   }
 }

package/src/index.ts

@@ -1,22 +1,17 @@
-import { MapperOptions, MapperState, ValueRangesResponse } from './types';
-import { fetchBatchData, fetchAllSheetsData, mapData } from './utils';
+import type { MapperOptions, MapperState, ValueRangesResponse } from "./types";
+import { fetchBatchData, fetchAllSheetsData, mapData } from "./utils";
 
 const GoogleSheetsMapper = {
   async fetchGoogleSheetsData({
     apiKey,
     sheetId,
-    sheetsNames = [],
+    sheetsOptions = [],
   }: MapperOptions): Promise<MapperState[]> {
-    try {
-      const response: ValueRangesResponse =
-        sheetsNames.length === 0
-          ? await fetchAllSheetsData({ apiKey, sheetId })
-          : await fetchBatchData({ apiKey, sheetId, sheetsNames });
-
-      return mapData(response.valueRanges);
-    } catch (error) {
-      throw error;
-    }
+    const response: ValueRangesResponse =
+      sheetsOptions.length === 0
+        ? await fetchAllSheetsData({ apiKey, sheetId })
+        : await fetchBatchData({ apiKey, sheetId, sheetsOptions });
+    return mapData({ sheets: response.valueRanges, sheetsOptions });
   },
 };
 

package/src/types.ts

@@ -1,18 +1,23 @@
+export interface SheetsOption {
+  id: string;
+  headerRowIndex?: number;
+}
+
 export interface MapperOptions {
   apiKey: string;
   sheetId: string;
-  sheetsNames?: Array<string>;
+  sheetsOptions?: SheetsOption[];
 }
 
 export interface ValueRange {
   majorDimensions: string;
   range: string;
-  values: Array<string[]>;
+  values: string[][];
 }
 
 export interface ValueRangesResponse {
   spreadsheetId: string;
-  valueRanges: Array<ValueRange>;
+  valueRanges: ValueRange[];
 }
 
 export interface PropertiesFromResponse {
@@ -29,7 +34,7 @@ export interface SheetsResponse {
 
 export interface MapperState {
   id: string;
-  data: Array<object>;
+  data: Record<string, string>[];
 }
 
 export interface ApiResponse {