Class GoogleDriveFileStorage

Example

// Create a backup copy of an important file
const copied = await driveStorage.CopyObject(
  'documents/contract.pdf',
  'backups/contract_2024-05-16.pdf'
);

if (copied) {
  console.log('File copied successfully');
} else {
  console.log('Failed to copy file');
}
Copy

Example

// Create a new directory structure
const created = await driveStorage.CreateDirectory('documents/reports/annual/');

if (created) {
  console.log('Directory created successfully');
} else {
  console.log('Failed to create directory');
}
Copy

Example

const downloadUrl = await CreatePreAuthDownloadUrl("report.pdf");
console.log(downloadUrl); // Use this URL to download your file directly
Copy

If a ProviderKey was previously returned by CreatePreAuthUploadUrl, use that as the objectName instead of the object's natural name:

const downloadUrl = await CreatePreAuthDownloadUrl(file.ProviderKey);
console.log(downloadUrl); // Use this URL to download your file directly
Copy

This method simplifies the process of securely sharing or accessing files stored in cloud storage by providing a direct, pre-authenticated link to the file. It's particularly useful in applications where files need to be accessed or shared without navigating through the storage provider's standard authentication flow each time.

Example

// Delete an empty directory
const deleted = await driveStorage.DeleteDirectory('documents/temp/');

// Delete a directory and all its contents
const recursivelyDeleted = await driveStorage.DeleteDirectory('documents/old_projects/', true);
Copy

Example

// Delete a temporary file
const deleted = await driveStorage.DeleteObject('temp/report-draft.pdf');

if (deleted) {
  console.log('File successfully deleted');
} else {
  console.log('Failed to delete file');
}
Copy

Example

// Check if a directory exists before trying to save files to it
const exists = await driveStorage.DirectoryExists('documents/reports/');

if (!exists) {
  console.log('Directory does not exist, creating it first');
  await driveStorage.CreateDirectory('documents/reports/');
}

// Now safe to use the directory
await driveStorage.PutObject('documents/reports/new-report.pdf', fileData);
Copy

Example

try {
  // Fast path: Use objectId (Google Drive file ID)
  const content = await driveStorage.GetObject({ objectId: '1a2b3c4d5e' });

  // Slow path: Use path
  const content2 = await driveStorage.GetObject({ fullPath: 'documents/config.json' });

  // Parse the JSON content
  const config = JSON.parse(content.toString('utf8'));
  console.log('Configuration loaded:', config);
} catch (error) {
  console.error('Failed to download file:', error.message);
}
Copy

Example

try {
  // Fast path: Use objectId (Google Drive file ID)
  const metadata = await driveStorage.GetObjectMetadata({ objectId: '1a2b3c4d5e' });

  // Slow path: Use path
  const metadata2 = await driveStorage.GetObjectMetadata({ fullPath: 'documents/report.pdf' });

  console.log(`File: ${metadata.name}`);
  console.log(`Size: ${metadata.size} bytes`);
  console.log(`Last modified: ${metadata.lastModified}`);
} catch (error) {
  console.error('File does not exist or cannot be accessed');
}
Copy

Example

Simple Deployment (Environment Variables)
const storage = new GoogleDriveFileStorage(); // Constructor loads env vars
await storage.initialize(); // No config - uses env vars
await storage.ListObjects('/');
Copy

Example

Multi-Tenant (Database Credentials)
const storage = new GoogleDriveFileStorage();
await storage.initialize({
  accountId: '12345',
  accountName: 'Google Drive Account',
  clientID: '...',
  clientSecret: '...',
  refreshToken: '...',
  rootFolderID: 'optional-folder-id'
});
Copy

Example

// List all files and directories in the documents folder
const result = await driveStorage.ListObjects('documents/');

// Process files
for (const file of result.objects) {
  console.log(`File: ${file.name}, Size: ${file.size}, Type: ${file.contentType}`);
}

// Process subdirectories
for (const dir of result.prefixes) {
  console.log(`Directory: ${dir}`);
}
Copy

Example

// Move a file from drafts to published folder
const success = await driveStorage.MoveObject(
  'drafts/report.docx',
  'published/final-report.docx'
);

if (success) {
  console.log('File successfully moved');
} else {
  console.log('Failed to move file');
}
Copy

Example

// Check if a file exists before attempting to use it
const exists = await driveStorage.ObjectExists('documents/report.pdf');

if (exists) {
  console.log('File exists, proceeding with download');
  const content = await driveStorage.GetObject('documents/report.pdf');
  // Process the content...
} else {
  console.log('File does not exist');
}
Copy

Example

// Upload a text file
const content = Buffer.from('Hello, World!', 'utf8');
const uploaded = await driveStorage.PutObject(
  'documents/hello.txt',
  content,
  'text/plain'
);

if (uploaded) {
  console.log('File uploaded successfully');
} else {
  console.log('Failed to upload file');
}
Copy

Example

// Simple name search
const results = await storage.SearchFiles('quarterly report');

// Search with file type filter
const pdfResults = await storage.SearchFiles('budget', {
  fileTypes: ['pdf'],
  modifiedAfter: new Date('2024-01-01')
});

// Content search
const contentResults = await storage.SearchFiles('machine learning', {
  searchContent: true,
  pathPrefix: 'documents/research/'
});
Copy