@docstack/pouchdb-adapter-googledrive 0.0.1

package/lib/types.d.ts

@@ -0,0 +1,89 @@
+/** Google Drive API client type */
+export type DriveClient = any;
+/** Options for configuring the Google Drive adapter */
+export interface GoogleDriveAdapterOptions {
+    /** Configured Google Drive client (googleapis) */
+    drive: DriveClient;
+    /** Specific folder ID to use as the DB root */
+    folderId?: string;
+    /** Folder name to search/create if no ID provided */
+    folderName?: string;
+    /** Parent folder IDs for folder creation */
+    parents?: string[];
+    /** Interval in ms to check for remote changes */
+    pollingIntervalMs?: number;
+    /** Compaction threshold - number of change entries before auto-compact */
+    compactionThreshold?: number;
+    /** Compaction threshold - size in bytes before auto-compact */
+    compactionSizeThreshold?: number;
+    /** Cache size (number of documents) */
+    cacheSize?: number;
+}
+/** A single change entry in the append-only log */
+export interface ChangeEntry {
+    /** Sequence number of this change */
+    seq: number;
+    /** Document ID */
+    id: string;
+    /** New revision */
+    rev: string;
+    /** Whether document was deleted */
+    deleted?: boolean;
+    /** The document data (omitted for deletes) */
+    doc?: Record<string, any>;
+    /** Timestamp of the change */
+    timestamp: number;
+}
+/** Location pointer for lazy loading */
+export interface FilePointer {
+    fileId: string;
+    /** Optional offset/length for future optimization (packed files) */
+    offset?: number;
+    length?: number;
+}
+/** In-Memory Index Entry */
+export interface IndexEntry {
+    /** Current revision */
+    rev: string;
+    /** Sequence number where this rev was minted */
+    seq: number;
+    /** Whether it is a deletion marker */
+    deleted?: boolean;
+    /** Pointer to the file containing the body (changes-*.ndjson or snapshot-data-*.json) */
+    location: FilePointer;
+}
+/** Old Legacy Snapshot (Compact + Data) - Kept for migration */
+export interface LegacySnapshotData {
+    docs: Record<string, any>;
+    seq: number;
+    createdAt: number;
+}
+/** New Snapshot Index (Compact Metadata only) */
+export interface SnapshotIndex {
+    /** Map of DocID -> IndexEntry */
+    entries: Record<string, IndexEntry>;
+    /** Sequence number at snapshot time */
+    seq: number;
+    /** Timestamp */
+    createdAt: number;
+}
+/** New Snapshot Data (Bulk Content) */
+export interface SnapshotDataChunk {
+    /** Map of DocID -> Document Body */
+    docs: Record<string, any>;
+}
+/** Metadata file content */
+export interface MetaData {
+    /** Current sequence number */
+    seq: number;
+    /** List of active change log file IDs */
+    changeLogIds: string[];
+    /** Snapshot Index file ID */
+    snapshotIndexId: string | null;
+    /** Last compaction timestamp */
+    lastCompaction: number | null;
+    /** Database name */
+    dbName: string;
+    /** Schema Version (for migration) */
+    version?: number;
+}

package/lib/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@docstack/pouchdb-adapter-googledrive",
+  "version": "0.0.1",
+  "description": "PouchDB adapter for Google Drive",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "test": "jest"
+  },
+  "keywords": [
+    "pouchdb",
+    "adapter",
+    "google-drive"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/onyx-ac/docstack-pouchdb-adapter-gdrive.git"
+  },
+  "author": "Onyx <hello@onyx.ac> (https://onyx.ac)",
+  "license": "CC-BY-SA-4.0",
+  "bugs": {
+    "url": "https://github.com/onyx-ac/docstack-pouchdb-adapter-gdrive/issues"
+  },
+  "homepage": "https://onyx.ac/docstack",
+  "dependencies": {
+    "googleapis": "^126.0.0",
+    "pouchdb-core": "^7.3.1"
+  },
+  "devDependencies": {
+    "@types/jest": "^30.0.0",
+    "@types/node": "^20.0.0",
+    "@types/pouchdb-core": "^7.0.15",
+    "dotenv": "^17.2.3",
+    "jest": "^30.2.0",
+    "ts-jest": "^29.4.6",
+    "typescript": "^5.0.0"
+  }
+}