gdrivekit 1.0.0 → 1.0.3

package/README.md

@@ -1,15 +1,184 @@
-# googledrive
+## 🧩 gdrivekit
 
-To install dependencies:
+> **Google Drive file automation in just a few lines of code.**
+> Perform uploads, downloads, folder management, and advanced search operations effortlessly using TypeScript or Node.js.
+
+---
+
+### 🚀 Features
+
+* 📂 Upload, download, and manage Google Drive files
+* 🗂️ Create and organize folders
+* 🔍 Powerful search and filter utilities
+* ⚙️ Batch file operations
+* ⚡ Minimal setup, lightweight, and easy to use
+* 💡 Works with Node.js and Bun
+
+---
+
+### 📦 Installation
 
 ```bash
-bun install
+npm install gdrivekit
 ```
 
-To run:
+or
 
 ```bash
-bun run index.ts
+bun add gdrivekit
+```
+
+---
+
+### 💻 Example Usage
+
+### ⚙️ One-Time Setup (Token Generation)
+
+Before you can use Google Drive operations, you must generate **access and refresh tokens**.
+This only needs to be done **once** — the tokens will be stored locally and reused automatically.
+
+```ts
+import { generateCredentialsAndTokens } from "gdrivekit";
+
+await generateCredentialsAndTokens({
+  clientid: process.env.GOOGLE_CLIENT_ID!,
+  projectid: process.env.GOOGLE_PROJECT_ID!,
+  clientsecret: process.env.GOOGLE_CLIENT_SECRET!,
+  redirecturis: ["http://localhost:3000/oauth2callback"],
+});
+```
+
+✅ **Run this code once** to authenticate your app and save tokens (usually in `tokens.json`).
+After that, you **don’t need to call it again** unless you delete your tokens or change your Google credentials.
+
+---
+
+# 🔄 Initializing the Drive Service
+
+Once tokens are generated, you can initialize the Google Drive service and perform file operations:
+
+```ts
+import { operations, initDriveService } from "gdrivekit";
+
+async function main() {
+  initDriveService();
+
+  // Example: Search files by name
+  const files = await operations.searchByName("test");
+  console.log(files.data?.files);
+}
+
+main();
+```
+
+---
+
+## 🧠 Available Operations
+
+### 📁 **File Operations**
+
+| Method             | Description                               |
+| ------------------ | ----------------------------------------- |
+| `uploadFile()`     | Upload a new file to Google Drive         |
+| `downloadFile()`   | Download a file from Drive                |
+| `deleteFile()`     | Permanently delete a file                 |
+| `renameFile()`     | Rename an existing file                   |
+| `updateFile()`     | Update file metadata or content           |
+| `getFileInfo()`    | Get details of a specific file            |
+| `moveFile()`       | Move file to another folder using file ID |
+| `moveFileByName()` | Move file by its name                     |
+| `copyFile()`       | Make a copy of a file in Drive            |
+
+---
+
+### 🗂️ **Folder Operations**
+
+| Method                | Description                             |
+| --------------------- | --------------------------------------- |
+| `createFolder()`      | Create a new folder                     |
+| `deleteFolder()`      | Delete an existing folder               |
+| `listAllFolders()`    | List all folders in Drive               |
+| `listFilesInFolder()` | List all files within a specific folder |
+
+---
+
+### 🔍 **Search Operations**
+
+| Method                  | Description                            |
+| ----------------------- | -------------------------------------- |
+| `searchByName()`        | Search files containing a name         |
+| `searchByExactName()`   | Search files matching exact name       |
+| `searchByType()`        | Search by file type (e.g., PDF, image) |
+| `searchModifiedAfter()` | Find files modified after a given date |
+| `searchStarredFiles()`  | List all starred files                 |
+| `searchSharedFiles()`   | Find files shared with you             |
+| `searchByContent()`     | Search within file content             |
+
+---
+
+### 📋 **List Operations**
+
+| Method              | Description                           |
+| ------------------- | ------------------------------------- |
+| `listFiles()`       | List all files in Drive               |
+| `listRecentFiles()` | List recently modified or added files |
+| `listPDFs()`        | List all PDF files                    |
+| `listImages()`      | List all image files                  |
+
+---
+
+### 🧩 **Batch Operations**
+
+| Method                    | Description                          |
+| ------------------------- | ------------------------------------ |
+| `uploadMultipleFiles()`   | Upload multiple files at once        |
+| `deleteMultipleFiles()`   | Delete multiple files simultaneously |
+| `downloadMultipleFiles()` | Download multiple files in parallel  |
+
+---
+
+### 🧰 **Utility Operations**
+
+| Method                | Description                 |
+| --------------------- | --------------------------- |
+| `fileExists()`        | Check if a file exists      |
+| `getFolderIdByName()` | Fetch folder ID by its name |
+| `getFileIdByName()`   | Fetch file ID by its name   |
+
+---
+
+### ⚡ Example: Upload a File
+
+```ts
+await operations.uploadFile({
+  name: "report.pdf",
+  path: "./files/report.pdf",
+  mimeType: "application/pdf",
+});
+```
+
+---
+
+### ⚡ Example: Search and Download
+
+```ts
+const files = await operations.searchByName("invoice");
+if (files?.data?.files?.length) {
+  await operations.downloadFile(files.data.files[0].id, "./downloads/invoice.pdf");
+}
 ```
 
-This project was created using `bun init` in bun v1.3.0. [Bun](https://bun.com) is a fast all-in-one JavaScript runtime.
+---
+
+### 🧑‍💻 Author
+
+**Vikash Khati**
+[GitHub](https://github.com/vikashkhati007) • [NPM](https://www.npmjs.com/~vikashkhati007)
+
+---
+
+### ⚖️ License
+
+**MIT License** — free to use, modify, and distribute.
+
+---

package/dist/index.js

@@ -778735,8 +778735,218 @@ __export(exports_operations, {
   copyFile: () => copyFile
 });
 
+// drivers/services.ts
+import fs3 from "fs";
+
+// drivers/GoogleDriveService.ts
+var import_googleapis = __toESM(require_src8(), 1);
+import * as fs2 from "fs";
+import * as path from "path";
+
+class GoogleDriveService {
+  oauth2Client;
+  drive;
+  constructor(credentials) {
+    const creds = credentials.web || credentials.installed || credentials;
+    const { client_id, client_secret } = creds;
+    const redirect_uri = "redirect_uris" in creds ? creds.redirect_uris[0] : credentials.redirect_uri;
+    this.oauth2Client = new import_googleapis.google.auth.OAuth2(client_id, client_secret, redirect_uri);
+    this.drive = import_googleapis.google.drive({ version: "v3", auth: this.oauth2Client });
+  }
+  setCredentials(tokens) {
+    this.oauth2Client.setCredentials(tokens);
+    this.oauth2Client.on("tokens", (newTokens) => {
+      if (newTokens.refresh_token) {
+        tokens.refresh_token = newTokens.refresh_token;
+      }
+      tokens.access_token = newTokens.access_token;
+      tokens.expiry_date = newTokens.expiry_date;
+      fs2.writeFileSync("./tokens.json", JSON.stringify(tokens, null, 2));
+      console.log("\uD83D\uDD04 Tokens refreshed and saved");
+    });
+  }
+  async listFiles(params = {}) {
+    try {
+      const response = await this.drive.files.list({
+        pageSize: params.pageSize || 10,
+        fields: "nextPageToken, files(id, name, mimeType, size, createdTime, modifiedTime)",
+        q: params.query || undefined,
+        orderBy: params.orderBy || "modifiedTime desc",
+        pageToken: params.pageToken || undefined
+      });
+      return {
+        success: true,
+        data: {
+          files: response.data.files,
+          nextPageToken: response.data.nextPageToken || undefined
+        }
+      };
+    } catch (error) {
+      return {
+        success: false,
+        error: error instanceof Error ? error.message : "Unknown error"
+      };
+    }
+  }
+  async getFileMetadata(fileId) {
+    try {
+      const response = await this.drive.files.get({
+        fileId,
+        fields: "id, name, mimeType, size, createdTime, modifiedTime, parents, webViewLink"
+      });
+      return {
+        success: true,
+        data: response.data
+      };
+    } catch (error) {
+      return {
+        success: false,
+        error: error instanceof Error ? error.message : "Unknown error"
+      };
+    }
+  }
+  async downloadFile(fileId, destPath) {
+    try {
+      const dest = fs2.createWriteStream(destPath);
+      const response = await this.drive.files.get({ fileId, alt: "media" }, { responseType: "stream" });
+      return new Promise((resolve, reject) => {
+        response.data.on("end", () => {
+          resolve({ success: true, data: { path: destPath } });
+        }).on("error", (err) => {
+          reject({ success: false, error: err.message });
+        }).pipe(dest);
+      });
+    } catch (error) {
+      return {
+        success: false,
+        error: error instanceof Error ? error.message : "Unknown error"
+      };
+    }
+  }
+  async uploadFile(filePath, metadata = {}) {
+    try {
+      const fileMetadata = {
+        name: metadata.name || path.basename(filePath),
+        parents: metadata.parents || []
+      };
+      const media = {
+        mimeType: metadata.mimeType,
+        body: fs2.createReadStream(filePath)
+      };
+      const response = await this.drive.files.create({
+        requestBody: fileMetadata,
+        media,
+        fields: "id, name, mimeType, size, webViewLink"
+      });
+      return {
+        success: true,
+        data: response.data
+      };
+    } catch (error) {
+      return {
+        success: false,
+        error: error instanceof Error ? error.message : "Unknown error"
+      };
+    }
+  }
+  async updateFileContent(fileId, filePath) {
+    try {
+      const media = {
+        body: fs2.createReadStream(filePath)
+      };
+      const response = await this.drive.files.update({
+        fileId,
+        media,
+        fields: "id, name, mimeType, modifiedTime"
+      });
+      return {
+        success: true,
+        data: response.data
+      };
+    } catch (error) {
+      return {
+        success: false,
+        error: error instanceof Error ? error.message : "Unknown error"
+      };
+    }
+  }
+  async updateFileMetadata(fileId, metadata) {
+    try {
+      const response = await this.drive.files.update({
+        fileId,
+        requestBody: metadata,
+        fields: "id, name, mimeType, modifiedTime"
+      });
+      return {
+        success: true,
+        data: response.data
+      };
+    } catch (error) {
+      return {
+        success: false,
+        error: error instanceof Error ? error.message : "Unknown error"
+      };
+    }
+  }
+  async deleteFile(fileId) {
+    try {
+      await this.drive.files.delete({
+        fileId
+      });
+      return {
+        success: true,
+        data: { message: "File deleted successfully" }
+      };
+    } catch (error) {
+      return {
+        success: false,
+        error: error instanceof Error ? error.message : "Unknown error"
+      };
+    }
+  }
+  async createFolder(folderName, parentFolderId) {
+    try {
+      const fileMetadata = {
+        name: folderName,
+        mimeType: "application/vnd.google-apps.folder"
+      };
+      if (parentFolderId) {
+        fileMetadata.parents = [parentFolderId];
+      }
+      const response = await this.drive.files.create({
+        requestBody: fileMetadata,
+        fields: "id, name, mimeType"
+      });
+      return {
+        success: true,
+        data: response.data
+      };
+    } catch (error) {
+      return {
+        success: false,
+        error: error instanceof Error ? error.message : "Unknown error"
+      };
+    }
+  }
+  async searchFiles(searchQuery, pageSize = 10) {
+    return this.listFiles({
+      query: searchQuery,
+      pageSize
+    });
+  }
+}
+
 // drivers/services.ts
 var driveService;
+async function initDriveService(creds, tokens) {
+  if (!driveService) {
+    const credentials = creds ?? JSON.parse(fs3.readFileSync("./credentials.json", "utf-8"));
+    driveService = new GoogleDriveService(credentials);
+    const tokenData = tokens ?? JSON.parse(fs3.readFileSync("./tokens.json", "utf-8"));
+    driveService.setCredentials(tokenData);
+  }
+  return driveService;
+}
 
 // types/index.ts
 var MIME_TYPES = {
@@ -778982,8 +779192,8 @@ var driveOperations = {
 };
 
 // auth.ts
-var import_googleapis = __toESM(require_src8(), 1);
-import * as fs2 from "fs";
+var import_googleapis2 = __toESM(require_src8(), 1);
+import * as fs4 from "fs";
 import * as http3 from "http";
 import * as url from "url";
 var CREDENTIALS_PATH = "./credentials.json";
@@ -778992,12 +779202,10 @@ async function generateCredentialsAndTokens({
   clientid,
   projectid,
   clientsecret,
-  redirecturis = [
-    "http://localhost:3000/oauth2callback",
-    "http://localhost:3000/oauth2/callback"
-  ]
+  redirecturis,
+  javascript_origin
 }) {
-  if (!fs2.existsSync(CREDENTIALS_PATH)) {
+  if (!fs4.existsSync(CREDENTIALS_PATH)) {
     const baseCredentials = {
       web: {
         client_id: clientid,
@@ -779006,21 +779214,21 @@ async function generateCredentialsAndTokens({
         token_uri: "https://oauth2.googleapis.com/token",
         auth_provider_x509_cert_url: "https://www.googleapis.com/oauth2/v1/certs",
         client_secret: clientsecret,
-        redirect_uris: redirecturis,
-        javascript_origins: ["http://localhost:3000"]
+        redirect_uris: redirecturis || ["http://localhost:3000/oauth2callback", "http://localhost:3000/oauth2/callback"],
+        javascript_origins: javascript_origin || ["http://localhost:3000"]
       }
     };
-    fs2.writeFileSync(CREDENTIALS_PATH, JSON.stringify(baseCredentials, null, 2));
+    fs4.writeFileSync(CREDENTIALS_PATH, JSON.stringify(baseCredentials, null, 2));
     console.log("✅ Created credentials.json");
   }
-  const credentials = JSON.parse(fs2.readFileSync(CREDENTIALS_PATH, "utf-8"));
+  const credentials = JSON.parse(fs4.readFileSync(CREDENTIALS_PATH, "utf-8"));
   const creds = credentials.web || credentials.installed || credentials;
   const client_id = creds.client_id;
   const client_secret = creds.client_secret;
   const redirect_uri = Array.isArray(creds.redirect_uris) ? creds.redirect_uris[0] : creds.redirect_uri;
-  const oauth2Client = new import_googleapis.google.auth.OAuth2(client_id, client_secret, redirect_uri);
-  if (fs2.existsSync(TOKENS_PATH)) {
-    const tokens = JSON.parse(fs2.readFileSync(TOKENS_PATH, "utf-8"));
+  const oauth2Client = new import_googleapis2.google.auth.OAuth2(client_id, client_secret, redirect_uri);
+  if (fs4.existsSync(TOKENS_PATH)) {
+    const tokens = JSON.parse(fs4.readFileSync(TOKENS_PATH, "utf-8"));
     oauth2Client.setCredentials(tokens);
     console.log("✅ Using existing tokens from tokens.json");
     return oauth2Client;
@@ -779049,7 +779257,7 @@ async function generateCredentialsAndTokens({
             throw new Error("No authorization code received");
           const { tokens } = await oauth2Client.getToken(code);
           oauth2Client.setCredentials(tokens);
-          fs2.writeFileSync(TOKENS_PATH, JSON.stringify(tokens, null, 2));
+          fs4.writeFileSync(TOKENS_PATH, JSON.stringify(tokens, null, 2));
           console.log("✅ Tokens saved to tokens.json");
           res.writeHead(200, { "Content-Type": "text/html" });
           res.end(`
@@ -779091,5 +779299,6 @@ async function generateCredentialsAndTokens({
 }
 export {
   exports_operations as operations,
+  initDriveService,
   generateCredentialsAndTokens
 };

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "gdrivekit",
-  "version": "1.0.0",
-  "description": "A lightweight Bun + TypeScript package for Google Drive OAuth2 authentication and file operations.",
+  "version": "1.0.3",
+  "description": "A lightweight Google Drive toolkit for File Management. Handle Google Drive operations easily — upload, download, and other file operations in a few lines of code.",
   "type": "module",
-  "main": "index.ts",
-  "types": "index.ts",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "scripts": {
     "dev": "bun run index.ts",
     "build": "bun build ./index.ts --outdir dist --target node",
@@ -12,13 +12,27 @@
   },
   "keywords": [
     "google-drive",
-    "bun",
-    "typescript",
+    "google drive",
+    "googledrive",
+    "gdrive",
+    "drive-api",
     "googleapis",
-    "oauth2"
+    "google drive api",
+    "google drive oauth2",
+    "google drive upload",
+    "google drive automation",
+    "gdrivekit"
   ],
   "author": "Vikash Khati",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/vikashkhati007/gdrivekit"
+  },
+  "homepage": "https://www.npmjs.com/package/gdrivekit",
+  "bugs": {
+    "url": "https://github.com/vikashkhati007/gdrivekit/issues"
+  },
   "dependencies": {
     "googleapis": "^164.1.0"
   },

package/index.ts

@@ -1,3 +0,0 @@
-import * as operations from "./operations";
-import { generateCredentialsAndTokens } from "./auth";
-export { generateCredentialsAndTokens, operations };