Nook (DriveCRUD)

A reusable TypeScript module for using Google Drive as per-user cloud storage.

Install

npm install @ashish-um/nook

Quick Start

import { DriveCRUD } from "@ashish-um/nook";

const drive = new DriveCRUD(googleAccessToken);

// Create
await drive.create("notes/hello.json", { title: "Hello", body: "World" });

// Read
const note = await drive.read("notes/hello.json");

// Update
await drive.update("notes/hello.json", { title: "Hello", body: "Updated" });

// List
const allNotes = await drive.list("notes/");

// Delete
await drive.delete("notes/hello.json");

Documentation

• Full API Documentation — Detailed breakdown of every method, parameters, and error handling.
• React & Next.js Guide — How to cleanly integrate Google Identity Services and DriveCRUD using context providers and hooks.

API

new DriveCRUD(token, options?)

| Option | Type | Default | Description | |---|---|---|---| | appSpace | "appDataFolder" \| "drive" | "appDataFolder" | Where to store files |

Methods

| Method | Returns | Description | |---|---|---| | create(name, data) | Promise<DriveFile> | Create a new file. Throws ALREADY_EXISTS if it exists. | | read(name) | Promise<unknown> | Read and parse file content. Throws NOT_FOUND. | | update(name, data) | Promise<DriveFile> | Overwrite existing file. Throws NOT_FOUND. | | delete(name) | Promise<void> | Delete a file. Throws NOT_FOUND. | | list(prefix?) | Promise<DriveFile[]> | List files, optionally filtered by prefix. | | setToken(token) | void | Replace the stored access token. |

Error Handling

All errors are instances of DriveError with a typed code:

import { DriveError } from "@ashish-um/nook";

try {
  await drive.read("missing.json");
} catch (err) {
  if (err instanceof DriveError && err.code === "NOT_FOUND") {
    // handle gracefully
  }
}

Error codes: NOT_FOUND, ALREADY_EXISTS, INVALID_TYPE, AUTH_ERROR, API_ERROR.

OAuth2 Scope

Your app must request this scope:

https://www.googleapis.com/auth/drive.appdata

License

MIT