@opendatalabs/vana-sdk 0.1.0-alpha.ffe4659 → 2.1.0

package/dist/storage/providers/google-drive.d.ts

@@ -0,0 +1,152 @@
+/**
+ * Google Drive Storage Provider for Vana SDK
+ *
+ * Implements storage interface for Google Drive using OAuth2 authentication.
+ * Based on patterns from dlp-ui-template with NextAuth integration.
+ */
+import { type StorageProvider, type StorageUploadResult, type StorageFile, type StorageListOptions, type StorageProviderConfig } from "../index";
+export interface GoogleDriveConfig {
+    /** OAuth2 access token */
+    accessToken: string;
+    /** Optional refresh token for token renewal */
+    refreshToken?: string;
+    /** OAuth2 client ID */
+    clientId?: string;
+    /** OAuth2 client secret */
+    clientSecret?: string;
+    /** Parent folder ID to upload files to */
+    folderId?: string;
+}
+/**
+ * Google Drive Storage Provider with folder management capabilities
+ *
+ * @remarks
+ * Implements storage interface for Google Drive using OAuth2 authentication.
+ * Provides file upload/download operations and advanced folder management
+ * including search, creation, and nested folder structures. Requires the
+ * `https://www.googleapis.com/auth/drive.file` OAuth scope for full functionality.
+ *
+ * @category Storage
+ *
+ * @example
+ * ```typescript
+ * const googleDriveStorage = new GoogleDriveStorage({
+ *   accessToken: "your-oauth-access-token",
+ *   refreshToken: "your-oauth-refresh-token",
+ *   clientId: "your-oauth-client-id",
+ *   clientSecret: "your-oauth-client-secret",
+ * });
+ *
+ * // Create folder structure and upload file
+ * const folderId = await googleDriveStorage.findOrCreateFolder("screenshots");
+ * const result = await googleDriveStorage.upload(fileBlob, "image.png");
+ * ```
+ */
+export declare class GoogleDriveStorage implements StorageProvider {
+    private config;
+    private readonly baseUrl;
+    private readonly uploadUrl;
+    constructor(config: GoogleDriveConfig);
+    upload(file: Blob, filename?: string): Promise<StorageUploadResult>;
+    download(url: string): Promise<Blob>;
+    list(options?: StorageListOptions): Promise<StorageFile[]>;
+    delete(url: string): Promise<boolean>;
+    getConfig(): StorageProviderConfig;
+    /**
+     * Make a Google Drive file publicly readable
+     *
+     * @param fileId - Google Drive file ID
+     */
+    private makeFilePublic;
+    /**
+     * Extract file ID from various Google Drive URL formats
+     *
+     * @param url - Google Drive URL
+     * @returns File ID or null if not found
+     */
+    private extractFileId;
+    /**
+     * Searches for an existing folder by name within a specified parent folder
+     *
+     * @remarks
+     * This method queries the Google Drive API to find a folder with the exact name
+     * within the specified parent directory. Only searches for folders (not files)
+     * and excludes trashed items.
+     *
+     * @param name - The exact name of the folder to search for
+     * @param parentId - The ID of the parent folder to search within (defaults to 'root')
+     * @returns Promise that resolves to the folder ID if found, or `null` if not found
+     * @throws {StorageError} When the Google Drive API request fails
+     *
+     * @example
+     * ```typescript
+     * // Search for a folder in the root directory
+     * const folderId = await googleDriveStorage.findFolder("screenshots");
+     * if (folderId) {
+     *   console.log("Found folder:", folderId);
+     * } else {
+     *   console.log("Folder not found");
+     * }
+     *
+     * // Search for a subfolder within another folder
+     * const subFolderId = await googleDriveStorage.findFolder("roasts", parentFolderId);
+     * ```
+     */
+    findFolder(name: string, parentId?: string): Promise<string | null>;
+    /**
+     * Creates a new folder within a specified parent folder
+     *
+     * @remarks
+     * This method creates a new folder using the Google Drive API. The folder will be
+     * created with the specified name as a child of the parent folder. Requires the
+     * `https://www.googleapis.com/auth/drive.file` OAuth scope.
+     *
+     * @param name - The name for the new folder
+     * @param parentId - The ID of the parent folder where the new folder will be created (defaults to 'root')
+     * @returns Promise that resolves to the ID of the newly created folder
+     * @throws {StorageError} When the Google Drive API request fails or folder creation is denied
+     *
+     * @example
+     * ```typescript
+     * // Create a folder in the root directory
+     * const folderId = await googleDriveStorage.createFolder("my-documents");
+     * console.log("Created folder:", folderId);
+     *
+     * // Create a subfolder within another folder
+     * const subFolderId = await googleDriveStorage.createFolder("reports", parentFolderId);
+     * ```
+     */
+    createFolder(name: string, parentId?: string): Promise<string>;
+    /**
+     * Finds an existing folder by name, or creates it if it doesn't exist
+     *
+     * @remarks
+     * This is a convenience method that combines `findFolder` and `createFolder`.
+     * It first searches for an existing folder with the specified name. If found,
+     * it returns the existing folder's ID. If not found, it creates a new folder
+     * and returns the new folder's ID.
+     *
+     * @param name - The name of the folder to find or create
+     * @param parentId - The ID of the parent folder to search within or create the folder in (defaults to 'root')
+     * @returns Promise that resolves to the folder ID (either existing or newly created)
+     * @throws {StorageError} When the Google Drive API request fails
+     *
+     * @example
+     * ```typescript
+     * // Ensure a folder exists, creating it if necessary
+     * const folderId = await googleDriveStorage.findOrCreateFolder("screenshots");
+     * console.log("Folder ID:", folderId); // Will be same ID if folder already existed
+     *
+     * // Create nested folder structure
+     * const parentId = await googleDriveStorage.findOrCreateFolder("projects");
+     * const childId = await googleDriveStorage.findOrCreateFolder("vana-app", parentId);
+     * ```
+     */
+    findOrCreateFolder(name: string, parentId?: string): Promise<string>;
+    /**
+     * Refresh the access token using refresh token
+     *
+     * @returns Promise with new access token
+     */
+    refreshAccessToken(): Promise<string>;
+}

package/dist/storage/providers/google-drive.js

@@ -0,0 +1,494 @@
+import {
+  StorageError
+} from "../index";
+class GoogleDriveStorage {
+  constructor(config) {
+    this.config = config;
+    if (!config.accessToken) {
+      throw new StorageError(
+        "Google Drive access token is required",
+        "MISSING_ACCESS_TOKEN",
+        "google-drive"
+      );
+    }
+  }
+  baseUrl = "https://www.googleapis.com/drive/v3";
+  uploadUrl = "https://www.googleapis.com/upload/drive/v3";
+  async upload(file, filename) {
+    try {
+      const fileName = filename ?? `vana-file-${Date.now()}.dat`;
+      const metadata = {
+        name: fileName,
+        parents: this.config.folderId ? [this.config.folderId] : void 0
+      };
+      const delimiter = "-------314159265358979323846";
+      const closeDelim = `\r
+--${delimiter}--`;
+      const metadataBlob = new Blob([JSON.stringify(metadata)], {
+        type: "application/json"
+      });
+      const multipartRequestBody = [
+        `--${delimiter}`,
+        "Content-Type: application/json",
+        "",
+        await metadataBlob.text(),
+        `--${delimiter}`,
+        `Content-Type: ${file.type || "application/octet-stream"}`,
+        "",
+        ""
+      ].join("\r\n");
+      const requestBody = new Blob([multipartRequestBody, file, closeDelim]);
+      const response = await fetch(
+        `${this.uploadUrl}/files?uploadType=multipart`,
+        {
+          method: "POST",
+          headers: {
+            Authorization: `Bearer ${this.config.accessToken}`,
+            "Content-Type": `multipart/related; boundary="${delimiter}"`
+          },
+          body: requestBody
+        }
+      );
+      if (!response.ok) {
+        const error = await response.text();
+        throw new StorageError(
+          `Failed to upload to Google Drive: ${error}`,
+          "UPLOAD_FAILED",
+          "google-drive"
+        );
+      }
+      const result = await response.json();
+      await this.makeFilePublic(result.id);
+      return {
+        url: `https://drive.google.com/uc?id=${result.id}&export=download`,
+        size: file.size,
+        contentType: file.type || "application/octet-stream",
+        metadata: {
+          id: result.id,
+          name: result.name,
+          driveUrl: `https://drive.google.com/file/d/${result.id}/view`
+        }
+      };
+    } catch (error) {
+      if (error instanceof StorageError) {
+        throw error;
+      }
+      throw new StorageError(
+        `Google Drive upload error: ${error instanceof Error ? error.message : "Unknown error"}`,
+        "UPLOAD_ERROR",
+        "google-drive"
+      );
+    }
+  }
+  async download(url) {
+    try {
+      const fileId = this.extractFileId(url);
+      if (!fileId) {
+        throw new StorageError(
+          "Invalid Google Drive URL format",
+          "INVALID_URL",
+          "google-drive"
+        );
+      }
+      const response = await fetch(
+        `${this.baseUrl}/files/${fileId}?alt=media`,
+        {
+          headers: {
+            Authorization: `Bearer ${this.config.accessToken}`
+          }
+        }
+      );
+      if (!response.ok) {
+        const error = await response.text();
+        throw new StorageError(
+          `Failed to download from Google Drive: ${error}`,
+          "DOWNLOAD_FAILED",
+          "google-drive"
+        );
+      }
+      const blob = await response.blob();
+      if (blob.type === "text/html") {
+        throw new StorageError(
+          "Received HTML content instead of file data. This suggests an authentication or URL formatting issue with Google Drive.",
+          "AUTHENTICATION_ERROR",
+          "google-drive"
+        );
+      }
+      return blob;
+    } catch (error) {
+      if (error instanceof StorageError) {
+        throw error;
+      }
+      throw new StorageError(
+        `Google Drive download error: ${error instanceof Error ? error.message : "Unknown error"}`,
+        "DOWNLOAD_ERROR",
+        "google-drive"
+      );
+    }
+  }
+  async list(options) {
+    try {
+      let query = "trashed = false";
+      if (this.config.folderId) {
+        query += ` and '${this.config.folderId}' in parents`;
+      }
+      if (options?.namePattern) {
+        query += ` and name contains '${options.namePattern}'`;
+      }
+      const params = new URLSearchParams({
+        q: query,
+        fields: "files(id,name,size,mimeType,createdTime,webViewLink)",
+        pageSize: (options?.limit ?? 100).toString()
+      });
+      if (options?.offset && typeof options.offset === "string") {
+        params.set("pageToken", options.offset);
+      }
+      const response = await fetch(`${this.baseUrl}/files?${params}`, {
+        headers: {
+          Authorization: `Bearer ${this.config.accessToken}`
+        }
+      });
+      if (!response.ok) {
+        const error = await response.text();
+        throw new StorageError(
+          `Failed to list Google Drive files: ${error}`,
+          "LIST_FAILED",
+          "google-drive"
+        );
+      }
+      const result = await response.json();
+      return result.files.map((file) => ({
+        id: file.id,
+        name: file.name,
+        url: `https://drive.google.com/uc?id=${file.id}&export=download`,
+        size: parseInt(file.size) || 0,
+        contentType: file.mimeType,
+        createdAt: new Date(file.createdTime),
+        metadata: {
+          id: file.id,
+          driveUrl: file.webViewLink
+        }
+      }));
+    } catch (error) {
+      if (error instanceof StorageError) {
+        throw error;
+      }
+      throw new StorageError(
+        `Google Drive list error: ${error instanceof Error ? error.message : "Unknown error"}`,
+        "LIST_ERROR",
+        "google-drive"
+      );
+    }
+  }
+  async delete(url) {
+    try {
+      const fileId = this.extractFileId(url);
+      if (!fileId) {
+        throw new StorageError(
+          "Invalid Google Drive URL format",
+          "INVALID_URL",
+          "google-drive"
+        );
+      }
+      const response = await fetch(`${this.baseUrl}/files/${fileId}`, {
+        method: "DELETE",
+        headers: {
+          Authorization: `Bearer ${this.config.accessToken}`
+        }
+      });
+      if (!response.ok && response.status !== 404) {
+        const error = await response.text();
+        throw new StorageError(
+          `Failed to delete from Google Drive: ${error}`,
+          "DELETE_FAILED",
+          "google-drive"
+        );
+      }
+      return true;
+    } catch (error) {
+      if (error instanceof StorageError) {
+        throw error;
+      }
+      throw new StorageError(
+        `Google Drive delete error: ${error instanceof Error ? error.message : "Unknown error"}`,
+        "DELETE_ERROR",
+        "google-drive"
+      );
+    }
+  }
+  getConfig() {
+    return {
+      name: "Google Drive",
+      type: "google-drive",
+      requiresAuth: true,
+      features: {
+        upload: true,
+        download: true,
+        list: true,
+        delete: true
+      }
+    };
+  }
+  /**
+   * Make a Google Drive file publicly readable
+   *
+   * @param fileId - Google Drive file ID
+   */
+  async makeFilePublic(fileId) {
+    try {
+      await fetch(`${this.baseUrl}/files/${fileId}/permissions`, {
+        method: "POST",
+        headers: {
+          Authorization: `Bearer ${this.config.accessToken}`,
+          "Content-Type": "application/json"
+        },
+        body: JSON.stringify({
+          role: "reader",
+          type: "anyone"
+        })
+      });
+    } catch (error) {
+      console.warn("Failed to make Google Drive file public:", error);
+    }
+  }
+  /**
+   * Extract file ID from various Google Drive URL formats
+   *
+   * @param url - Google Drive URL
+   * @returns File ID or null if not found
+   */
+  extractFileId(url) {
+    const patterns = [
+      /\/file\/d\/([a-zA-Z0-9-_]+)/,
+      // https://drive.google.com/file/d/FILE_ID/view
+      /id=([a-zA-Z0-9-_]+)/,
+      // https://drive.google.com/uc?id=FILE_ID
+      /^([a-zA-Z0-9-_]+)$/
+      // Just the file ID
+    ];
+    for (const pattern of patterns) {
+      const match = url.match(pattern);
+      if (match) {
+        return match[1];
+      }
+    }
+    return null;
+  }
+  /**
+   * Searches for an existing folder by name within a specified parent folder
+   *
+   * @remarks
+   * This method queries the Google Drive API to find a folder with the exact name
+   * within the specified parent directory. Only searches for folders (not files)
+   * and excludes trashed items.
+   *
+   * @param name - The exact name of the folder to search for
+   * @param parentId - The ID of the parent folder to search within (defaults to 'root')
+   * @returns Promise that resolves to the folder ID if found, or `null` if not found
+   * @throws {StorageError} When the Google Drive API request fails
+   *
+   * @example
+   * ```typescript
+   * // Search for a folder in the root directory
+   * const folderId = await googleDriveStorage.findFolder("screenshots");
+   * if (folderId) {
+   *   console.log("Found folder:", folderId);
+   * } else {
+   *   console.log("Folder not found");
+   * }
+   *
+   * // Search for a subfolder within another folder
+   * const subFolderId = await googleDriveStorage.findFolder("roasts", parentFolderId);
+   * ```
+   */
+  async findFolder(name, parentId = "root") {
+    try {
+      const query = `name='${name}' and '${parentId}' in parents and mimeType='application/vnd.google-apps.folder' and trashed = false`;
+      const params = new URLSearchParams({
+        q: query,
+        fields: "files(id,name,mimeType)"
+      });
+      const response = await fetch(`${this.baseUrl}/files?${params}`, {
+        headers: {
+          Authorization: `Bearer ${this.config.accessToken}`
+        }
+      });
+      if (!response.ok) {
+        const error = await response.text();
+        throw new StorageError(
+          `Failed to search Google Drive folders: ${error}`,
+          "FIND_FOLDER_FAILED",
+          "google-drive"
+        );
+      }
+      const result = await response.json();
+      if (result.files && result.files.length > 0) {
+        return result.files[0].id;
+      }
+      return null;
+    } catch (error) {
+      if (error instanceof StorageError) {
+        throw error;
+      }
+      throw new StorageError(
+        `Google Drive findFolder error: ${error instanceof Error ? error.message : "Unknown error"}`,
+        "FIND_FOLDER_ERROR",
+        "google-drive"
+      );
+    }
+  }
+  /**
+   * Creates a new folder within a specified parent folder
+   *
+   * @remarks
+   * This method creates a new folder using the Google Drive API. The folder will be
+   * created with the specified name as a child of the parent folder. Requires the
+   * `https://www.googleapis.com/auth/drive.file` OAuth scope.
+   *
+   * @param name - The name for the new folder
+   * @param parentId - The ID of the parent folder where the new folder will be created (defaults to 'root')
+   * @returns Promise that resolves to the ID of the newly created folder
+   * @throws {StorageError} When the Google Drive API request fails or folder creation is denied
+   *
+   * @example
+   * ```typescript
+   * // Create a folder in the root directory
+   * const folderId = await googleDriveStorage.createFolder("my-documents");
+   * console.log("Created folder:", folderId);
+   *
+   * // Create a subfolder within another folder
+   * const subFolderId = await googleDriveStorage.createFolder("reports", parentFolderId);
+   * ```
+   */
+  async createFolder(name, parentId = "root") {
+    try {
+      const metadata = {
+        name,
+        mimeType: "application/vnd.google-apps.folder",
+        parents: [parentId]
+      };
+      const response = await fetch(`${this.baseUrl}/files`, {
+        method: "POST",
+        headers: {
+          Authorization: `Bearer ${this.config.accessToken}`,
+          "Content-Type": "application/json"
+        },
+        body: JSON.stringify(metadata)
+      });
+      if (!response.ok) {
+        const error = await response.text();
+        throw new StorageError(
+          `Failed to create Google Drive folder: ${error}`,
+          "CREATE_FOLDER_FAILED",
+          "google-drive"
+        );
+      }
+      const result = await response.json();
+      return result.id;
+    } catch (error) {
+      if (error instanceof StorageError) {
+        throw error;
+      }
+      throw new StorageError(
+        `Google Drive createFolder error: ${error instanceof Error ? error.message : "Unknown error"}`,
+        "CREATE_FOLDER_ERROR",
+        "google-drive"
+      );
+    }
+  }
+  /**
+   * Finds an existing folder by name, or creates it if it doesn't exist
+   *
+   * @remarks
+   * This is a convenience method that combines `findFolder` and `createFolder`.
+   * It first searches for an existing folder with the specified name. If found,
+   * it returns the existing folder's ID. If not found, it creates a new folder
+   * and returns the new folder's ID.
+   *
+   * @param name - The name of the folder to find or create
+   * @param parentId - The ID of the parent folder to search within or create the folder in (defaults to 'root')
+   * @returns Promise that resolves to the folder ID (either existing or newly created)
+   * @throws {StorageError} When the Google Drive API request fails
+   *
+   * @example
+   * ```typescript
+   * // Ensure a folder exists, creating it if necessary
+   * const folderId = await googleDriveStorage.findOrCreateFolder("screenshots");
+   * console.log("Folder ID:", folderId); // Will be same ID if folder already existed
+   *
+   * // Create nested folder structure
+   * const parentId = await googleDriveStorage.findOrCreateFolder("projects");
+   * const childId = await googleDriveStorage.findOrCreateFolder("vana-app", parentId);
+   * ```
+   */
+  async findOrCreateFolder(name, parentId = "root") {
+    try {
+      const existingFolderId = await this.findFolder(name, parentId);
+      if (existingFolderId) {
+        return existingFolderId;
+      }
+      return await this.createFolder(name, parentId);
+    } catch (error) {
+      if (error instanceof StorageError) {
+        throw error;
+      }
+      throw new StorageError(
+        `Google Drive findOrCreateFolder error: ${error instanceof Error ? error.message : "Unknown error"}`,
+        "FIND_OR_CREATE_FOLDER_ERROR",
+        "google-drive"
+      );
+    }
+  }
+  /**
+   * Refresh the access token using refresh token
+   *
+   * @returns Promise with new access token
+   */
+  async refreshAccessToken() {
+    if (!this.config.refreshToken || !this.config.clientId || !this.config.clientSecret) {
+      throw new StorageError(
+        "Refresh token, client ID, and client secret are required for token refresh",
+        "MISSING_REFRESH_CONFIG",
+        "google-drive"
+      );
+    }
+    try {
+      const response = await fetch("https://oauth2.googleapis.com/token", {
+        method: "POST",
+        headers: {
+          "Content-Type": "application/x-www-form-urlencoded"
+        },
+        body: new URLSearchParams({
+          client_id: this.config.clientId,
+          client_secret: this.config.clientSecret,
+          refresh_token: this.config.refreshToken,
+          grant_type: "refresh_token"
+        })
+      });
+      if (!response.ok) {
+        const error = await response.text();
+        throw new StorageError(
+          `Failed to refresh Google Drive token: ${error}`,
+          "TOKEN_REFRESH_FAILED",
+          "google-drive"
+        );
+      }
+      const result = await response.json();
+      this.config.accessToken = result.access_token;
+      return result.access_token;
+    } catch (error) {
+      if (error instanceof StorageError) {
+        throw error;
+      }
+      throw new StorageError(
+        `Google Drive token refresh error: ${error instanceof Error ? error.message : "Unknown error"}`,
+        "TOKEN_REFRESH_ERROR",
+        "google-drive"
+      );
+    }
+  }
+}
+export {
+  GoogleDriveStorage
+};
+//# sourceMappingURL=google-drive.js.map