update docs and package.json

README.md

@@ -1,8 +1,8 @@
 <p class='logo'>
- <img alt="logo" src="https://raw.githubusercontent.com/rahul-jha98/google-sheets-db/main/docs/assets/imgs/logo.svg" width="580">
+ <img alt="logo" src="https://raw.githubusercontent.com/rahul-jha98/sheets-database/main/docs/assets/imgs/logo.svg" width="480">
 </p>
 
-[![License](https://img.shields.io/badge/license-MIT-green)](https://raw.githubusercontent.com/rahul-jha98/google-sheets-db/main/LICENSE)
+[![License](https://img.shields.io/badge/license-MIT-green)](https://raw.githubusercontent.com/rahul-jha98/sheets-database/main/LICENSE)
 
 > Library to help use a Google Sheet as a database (or CMS)
 
@@ -14,10 +14,10 @@
 - Provides method to reduce memory and network usage to optimize for your use case.
 
  **Docs site -**
-Full docs available at [https://rahul-jha98.github.io/google-sheets-db/](https://rahul-jha98.github.io/google-sheets-db/) 
+Full docs available at [https://rahul-jha98.github.io/sheets-database/](https://rahul-jha98.github.io/sheets-database/) 
 
 
-> 🚀 **Installation** - `npm i google-sheets-db --save` or `yarn add google-sheets-db`
+> 🚀 **Installation** - `npm i sheets-database --save` or `yarn add sheets-database`
 
 ## Examples
 _the following examples are meant to give you an idea of just some of the things you can do_
@@ -27,13 +27,13 @@ _the following examples are meant to give you an idea of just some of the things
 
 ### Working with Tables
 ```javascript
-const { SheetDatabase } = require('google-sheets-db');
+const { SheetDatabase } = require('sheets-database');
 
 // Initialize the Database with doc ID (long id in the sheets URL)
 const db = new SheetDatabase('<the sheet ID from the url>');
 
 // Initialize Auth
-// see more available options at https://rahul-jha98.github.io/google-sheets-db/#/getting-started/authentication
+// see more available options at https://rahul-jha98.github.io/sheets-database/#/getting-started/authentication
 await db.useServiceAccount({
  client_email: process.env.GOOGLE_SERVICE_ACCOUNT_EMAIL,
  private_key: process.env.GOOGLE_PRIVATE_KEY,
@@ -58,7 +58,7 @@ await db.dropTable('newTable2');
 ```
 More info:
 - [Authentication](https://rahul-jha98.github.io//#/getting-started/authentication)
-- [SheetDatabase](https://rahul-jha98.github.io/google-sheets-db//#/classdocs/sheetdatabase)
+- [SheetDatabase](https://rahul-jha98.github.io/sheets-database//#/classdocs/sheetdatabase)
 
 
 ### Working with Table Entries
@@ -112,7 +112,7 @@ console.log(table.getData());
  */
 ```
 More Info:
-- [Table](https://rahul-jha98.github.io/google-sheets-db//#/classdocs/table)
+- [Table](https://rahul-jha98.github.io/sheets-database//#/classdocs/table)
 
 ## Why?
 > The library will let you worry only about the CRUD operation you wish to perfrom and handles the task of updating it to the spreadsheet internally.
@@ -124,9 +124,8 @@ But the Google Sheet's API v4 is a bit awkward with confusing docs, at least to
 The library aims to remove the learning curve completely by providing methods that lets you interact with the database without worrying about the Sheets API at all. 
 Moreover the API of the library is quite intuitive to get started with and provides functionalities for most of the database operations.
 
-
 ## Note
-`google-sheets-db` is heavily inspired by and borrows some code from [node-google-spreadsheet](https://github.com/theoephraim/node-google-spreadsheet).
+`sheets-database` is heavily inspired by and also borrows some code from [node-google-spreadsheet](https://github.com/theoephraim/node-google-spreadsheet).
 
 ## Contributions
 
@@ -137,3 +136,6 @@ Also, since I am new to Typescript and still exploring any help in improving the
 
 The docs site is generated using [docsify](https://docsify.js.org). To preview and run locally so you can make edits, install docsify_cli and run `docsify serve ./docs` in the project root folder and head to https://localhost:3000
 The content lives in markdown files in the docs folder.
+
+## License
+[MIT](https://github.com/rahul-jha98/sheets-database/blob/main/LICENSE)

docs/README.md

@@ -1,9 +1,9 @@
 _Welcome to the documentation site for_
 <p class='logo'>
- <img alt="logo" src="./assets/imgs/logo.svg" width="580">
+ <img alt="logo" src="./assets/imgs/logo.svg" width="480">
 </p>
 
-[![License](https://img.shields.io/badge/license-MIT-green)](https://raw.githubusercontent.com/rahul-jha98/google-sheets-db/main/LICENSE)
+[![License](https://img.shields.io/badge/license-MIT-green)](https://raw.githubusercontent.com/rahul-jha98/sheets-database/main/LICENSE)
 
 > Library to help use a Google Sheet as a database (or CMS)
 
@@ -15,10 +15,10 @@ _Welcome to the documentation site for_
 - Provides method to reduce memory and network usage to optimize for your use case.
 
 <!-- **Docs site -**
-Full docs available at [https://rahul-jha98.github.io/google-sheets-db/](https://rahul-jha98.github.io/google-sheets-db/) -->
+Full docs available at [https://rahul-jha98.github.io/sheets-database/](https://rahul-jha98.github.io/sheets-database/) -->
 
 
-> 🚀 **Installation** - `npm i google-sheets-db --save` or `yarn add google-sheets-db`
+> 🚀 **Installation** - `npm i sheets-database --save` or `yarn add sheets-database`
 
 ## Examples
 _the following examples are meant to give you an idea of just some of the things you can do_
@@ -28,13 +28,13 @@ _the following examples are meant to give you an idea of just some of the things
 
 ### Working with Tables
 ```javascript
-const { SheetDatabase } = require('google-sheets-db');
+const { SheetDatabase } = require('sheets-database');
 
 // Initialize the Database with doc ID (long id in the sheets URL)
 const db = new SheetDatabase('<the sheet ID from the url>');
 
 // Initialize Auth
-// see more available options at https://rahul-jha98.github.io/google-sheets-db/#/getting-started/authentication
+// see more available options at https://rahul-jha98.github.io/sheets-database/#/getting-started/authentication
 await db.useServiceAccount({
  client_email: process.env.GOOGLE_SERVICE_ACCOUNT_EMAIL,
  private_key: process.env.GOOGLE_PRIVATE_KEY,
@@ -59,7 +59,7 @@ await db.dropTable('newTable2');
 ```
 More info:
 - [Authentication](https://rahul-jha98.github.io//#/getting-started/authentication)
-- [SheetDatabase](https://rahul-jha98.github.io/google-sheets-db//#/classdocs/sheetdatabase)
+- [SheetDatabase](https://rahul-jha98.github.io/sheets-database//#/classdocs/sheetdatabase)
 
 
 ### Working with Table Entries
@@ -113,7 +113,7 @@ console.log(table.getData());
  */
 ```
 More Info:
-- [Table](https://rahul-jha98.github.io/google-sheets-db//#/classdocs/table)
+- [Table](https://rahul-jha98.github.io/sheets-database//#/classdocs/table)
 
 ## Why?
 > The library will let you worry only about the CRUD operation you wish to perfrom and handles the task of updating it to the spreadsheet internally.
@@ -125,9 +125,8 @@ But the Google Sheet's API v4 is a bit awkward with confusing docs, at least to
 The library aims to remove the learning curve completely by providing methods that lets you interact with the database without worrying about the Sheets API at all. 
 Moreover the API of the library is quite intuitive to get started with and provides functionalities for most of the database operations.
 
-
 ## Note
-`google-sheets-db` is heavily inspired by and borrows some code from [node-google-spreadsheet](https://github.com/theoephraim/node-google-spreadsheet).
+`sheets-database` is heavily inspired by and borrows some code from [node-google-spreadsheet](https://github.com/theoephraim/node-google-spreadsheet).
 
 ## Contributions
 
@@ -137,4 +136,7 @@ Contributions are welcome. Make sure to add relevant documentation along with co
 Also, since I am new to Typescript and still exploring any help in improving the code practices and conventions would be appreciated.
 
 The docs site is generated using [docsify](https://docsify.js.org). To preview and run locally so you can make edits, install docsify_cli and run `docsify serve ./docs` in the project root folder and head to https://localhost:3000
-The content lives in markdown files in the docs folder.
+The content lives in markdown files in the docs folder.
+
+## License
+[MIT](https://github.com/rahul-jha98/sheets-database/blob/main/LICENSE)

docs/_sidebar.md

@@ -1,6 +1,6 @@
 <!-- docs/_sidebar.md -->
 * **Getting Started**
- * [Overview](/ "google-sheets-db")
+ * [Overview](/ "sheets-database")
  * [Authentication](getting-started/authentication)
 * **Class Documentation**
  * [SheetDatabase](classdocs/sheetdatabase)

docs/index.html

@@ -2,10 +2,10 @@
 <html lang="en">
 <head>
  <meta charset="UTF-8">
- <title>google-sheets-db</title>
+ <title>sheets-database</title>
  <meta
  name="description"
- content="Library to help use Google Sheets as Database"
+ content="Library to help use Google Sheets as a Database"
  />
  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
@@ -20,8 +20,8 @@
  <script>
  window.$docsify = {
  auto2top: true,
- name: 'google-sheets-db',
- repo: 'https://github.com/rahul-jha98/google-sheets-db',
+ name: 'sheets-database',
+ repo: 'https://github.com/rahul-jha98/sheets-database',
  loadSidebar: true,
  subMaxLevel: 4,
  autoTitle: false,

package.json

@@ -1,5 +1,5 @@
 {
- "name": "google-sheets-db",
+ "name": "sheets-database",
  "version": "1.0.0",
  "description": "Library to help use a Google Sheet as a database",
  "main": "lib/src/index.js",
@@ -8,8 +8,26 @@
  "build": "rm -rf lib/ && tsc",
  "start": "npm run build && node lib/src/index.js",
  "test": "npm run build && jest --runInBand",
- "lintjs": "eslint './lib/src/**/*.{js,ts,tsx}' --quiet --fix"
+ "jest": "jest --runInBand",
+ "lintjs": "eslint './lib/src/**/*.{js,ts,tsx}' --quiet --fix",
+ "prepublishOnly": "npm run jest",
+ "version": "git add -A src",
+ "postversion" : "git push && git push --tags"
  },
+ "repository": {
+ "type": "git",
+ "url": "git+https://github.com/rahul-jha98/sheets-database.git"
+ },
+ "keywords": ["google", "sheets", "database", "db", "google sheets", "spreadsheets", "spreadsheet"],
+ "author": "Rahul Jha <[email protected]>",
+ "license": "MIT",
+ "bugs": {
+ "url": "https://github.com/rahul-jha98/sheets-database/issues"
+ },
+ "homepage": "https://rahul-jha98.github.io/sheets-database/",
+ "files": [
+ "lib/src/"
+ ],
  "jest": {
  "testMatch": [
  "**/__tests__/**/*.js?(x)",
@@ -20,19 +38,6 @@
  ],
  "testTimeout": 15000
  },
- "repository": {
- "type": "git",
- "url": "git+https://github.com/rahul-jha98/google-sheets-db.git"
- },
- "author": "Rahul Jha",
- "license": "MIT",
- "bugs": {
- "url": "https://github.com/rahul-jha98/google-sheets-db/issues"
- },
- "homepage": "https://github.com/rahul-jha98/google-sheets-db#readme",
- "files": [
- "lib/src/"
- ],
  "dependencies": {
  "axios": "^0.21.1",
  "google-auth-library": "^6.1.3"

src/dbhelper/Database.ts

@@ -225,7 +225,7 @@ export class Database {
  }
 
  async _requestBatchUpdate(requests: any) {
- const response = await this.axios.post(':batchUpdate', {
+ await this.axios.post(':batchUpdate', {
  requests,
  });
  }

src/dbhelper/Table.ts

@@ -1,5 +1,5 @@
-import {checkIfNameValid, columnNumberToName, reduceRowsToDelete} from './utils';
 import {Sheet, SheetData, SheetProperties} from './ResponseStructure';
+import {columnNumberToName, reduceRowsToDelete} from './utils';
 
 type primitiveTypes = string | boolean | number | null | undefined;
 type rowDataObject = Record<string, primitiveTypes>;
@@ -537,6 +537,7 @@ export class Table {
  }
 
  /**
+ * @private
  * resize the number of columns
  * @param columnCount new value of column count
  */

src/dbhelper/utils.ts

@@ -33,8 +33,8 @@ export function columnNameToNumber(columnName: string): number {
 
 export function reduceRowsToDelete(rowsToDelete: number[]) : number[][] {
  const rangeRowsToDelete = rowsToDelete.map((rowNo) => [rowNo, rowNo+1]);
- const reducedRowsToDelete : number[][] = []
- reducedRowsToDelete.push(rangeRowsToDelete[0])
+ const reducedRowsToDelete : number[][] = [];
+ reducedRowsToDelete.push(rangeRowsToDelete[0]);
  let lastIdx = 0;
 
  for (let i = 1; i < rangeRowsToDelete.length; i++) {
@@ -62,4 +62,4 @@ export function checkIfNameValid(data: string[] | string) : boolean {
  }
  const validRegex = /^[A-Za-z0-9_]+$/;
  return data.every((name) => name.match(validRegex) !== null);
-}
+}

test/entries.test.ts

@@ -106,12 +106,14 @@ describe('Handle CRUD Operations on Table Entries', () => {
  await table.updateRow(0, [1, null]);
  expect(table.getRow(0).index).toBe(1);
  });
- it('can update rows using objects', async() => {
+ it('can update rows using objects', async () => {
  await table.updateRow(0, {letter: 'changed'});
  expect(table.getRow(0).letter).toBe('changed');
  });
  it('can update multiple rows', async () => {
- await table.updateRows([0, 1, 2], (data) => {return {letter: data?.index}});
+ await table.updateRows([0, 1, 2], (data) => {
+ return {letter: data?.index};
+ });
  });
  });
 });

test/names.test.ts

@@ -26,7 +26,10 @@ describe('Prevent incorrect naming of tables and columns', () => {
  it('can prevent setting incorrect table headers', async () => {
  const table = await database.addTable('headers', ['header1', 'header2', 'header3']);
  expect(async () => await table.setColumnNames(['header@1', 'header2'])).rejects;
- table.drop();
+ });
+
+ afterAll(async () => {
+ await database.headers.drop();
  });
  });
 });