Class SharePointFileStorage

Example

// Copy a file to a new location with a different name
const copyResult = await storage.CopyObject(
  'templates/financial-report.xlsx',
  'reports/2024/q1-financial-report.xlsx'
);

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

Example

// Create a new folder
const createResult = await storage.CreateDirectory('documents/2024-reports');

if (createResult) {
  console.log('Folder created successfully');

  // Now we can put files in this folder
  await storage.PutObject(
    'documents/2024-reports/q1-results.xlsx',
    fileContent,
    'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
  );
} else {
  console.error('Failed to create folder');
}
Copy

Example

// Generate a pre-authenticated download URL that will work for 10 minutes
const downloadUrl = await storage.CreatePreAuthDownloadUrl('presentations/quarterly-update.pptx');
console.log(`Download the file using this URL: ${downloadUrl}`);

// You can share this URL with users who don't have SharePoint access
// The URL will expire after 10 minutes
Copy

Example

// This will throw an UnsupportedOperationError
try {
  await storage.CreatePreAuthUploadUrl('documents/report.docx');
} catch (error) {
  if (error instanceof UnsupportedOperationError) {
    console.log('Pre-authenticated upload URLs are not supported in SharePoint.');
    // Use PutObject instead
    await storage.PutObject('documents/report.docx', fileContent, 'application/vnd.openxmlformats-officedocument.wordprocessingml.document');
  }
}
Copy

Example

// Attempt to delete an empty folder
const deleteResult = await storage.DeleteDirectory('temp/empty-folder');

// Delete a folder and all its contents
const recursiveDeleteResult = await storage.DeleteDirectory('archive/old-data', true);

if (recursiveDeleteResult) {
  console.log('Folder and all its contents deleted successfully');
} else {
  console.error('Failed to delete folder');
}
Copy

Example

// Delete a file
const deleteResult = await storage.DeleteObject('temp/draft-document.docx');

if (deleteResult) {
  console.log('File deleted successfully or already didn\'t exist');
} else {
  console.error('Failed to delete file');
}
Copy

Example

// Check if a directory exists before creating a file in it
const dirExists = await storage.DirectoryExists('documents/reports');

if (!dirExists) {
  // Create the directory first
  await storage.CreateDirectory('documents/reports');
}

// Now we can safely put a file in this directory
await storage.PutObject('documents/reports/annual-summary.pdf', fileContent, 'application/pdf');
Copy

Example

try {
  // Fast path: Use objectId (SharePoint item ID)
  const fileContent = await storage.GetObject({ objectId: '01BYE5RZ6QN3VYRVNHHFDK2QJODWDDFR4E' });

  // Slow path: Use path
  const fileContent2 = await storage.GetObject({ fullPath: 'documents/notes.txt' });

  // Convert Buffer to string for text files
  const textContent = fileContent.toString('utf8');
  console.log('File content:', textContent);

  // For binary files, you can write the buffer to a local file
  // or process it as needed
} catch (error) {
  console.error('Error downloading file:', error.message);
}
Copy

Example

try {
  // Fast path: Use objectId (SharePoint item ID)
  const metadata = await storage.GetObjectMetadata({ objectId: '01BYE5RZ6QN3VYRVNHHFDK2QJODWDDFR4E' });

  // Slow path: Use path
  const metadata2 = await storage.GetObjectMetadata({ fullPath: 'presentations/quarterly-update.pptx' });

  console.log(`Name: ${metadata.name}`);
  console.log(`Size: ${metadata.size} bytes`);
  console.log(`Content Type: ${metadata.contentType}`);
  console.log(`Last Modified: ${metadata.lastModified}`);
  console.log(`Is Directory: ${metadata.isDirectory}`);
} catch (error) {
  console.error('Error getting metadata:', error.message);
}
Copy

Example

const storage = new SharePointFileStorage(); // Constructor loads env vars
await storage.initialize(); // No config - uses env vars
await storage.ListObjects('/'); // Ready to use
Copy

Multi-Tenant Enterprise (Database)

Use infrastructure utility which handles credential decryption automatically:

Example

const storage = await initializeDriverWithAccountCredentials({
  accountEntity: accountWithProvider.account,
  providerEntity: accountWithProvider.provider,
  contextUser
});
await storage.ListObjects('/'); // Credentials already decrypted and initialized
Copy

Example

// List all files and folders in the 'documents' directory
const result = await storage.ListObjects('documents');

// Process files
for (const obj of result.objects) {
  console.log(`Name: ${obj.name}, Size: ${obj.size}, Type: ${obj.isDirectory ? 'Folder' : 'File'}`);
}

// Process subfolders
for (const prefix of result.prefixes) {
  console.log(`Subfolder: ${prefix}`);
}
Copy

Example

// Move a file to a different folder
const moveResult = await storage.MoveObject(
  'documents/old-report.pdf',
  'archive/2023/annual-report.pdf'
);

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

Example

// Check if a file exists before attempting to download it
const exists = await storage.ObjectExists('presentations/quarterly-update.pptx');

if (exists) {
  // File exists, proceed with download
  const fileContent = await storage.GetObject('presentations/quarterly-update.pptx');
  // Process the file...
} else {
  console.log('File does not exist');
}
Copy

Example

// Create a text file
const textContent = Buffer.from('This is a sample document', 'utf8');
const uploadResult = await storage.PutObject(
  'documents/sample.txt',
  textContent,
  'text/plain'
);

// Upload a large file using chunked upload
const largeFileBuffer = fs.readFileSync('/path/to/large-presentation.pptx');
const largeUploadResult = await storage.PutObject(
  'presentations/quarterly-results.pptx',
  largeFileBuffer,
  'application/vnd.openxmlformats-officedocument.presentationml.presentation'
);

if (largeUploadResult) {
  console.log('Large file uploaded successfully');
} else {
  console.error('Failed to upload large file');
}
Copy

Example

// Simple text search in filenames
const results = await storage.SearchFiles('quarterly report', {
  maxResults: 20
});

// Search for PDFs only
const pdfResults = await storage.SearchFiles('budget', {
  fileTypes: ['pdf'],
  maxResults: 50
});

// Search with date range
const recentResults = await storage.SearchFiles('meeting notes', {
  modifiedAfter: new Date('2024-01-01'),
  modifiedBefore: new Date('2024-12-31'),
  searchContent: true
});

// Search within specific directory
const folderResults = await storage.SearchFiles('presentation', {
  pathPrefix: 'documents/reports',
  fileTypes: ['pptx', 'pdf']
});

// Advanced KQL query
const advancedResults = await storage.SearchFiles(
  'FileType:xlsx AND Created>=2024-01-01 AND Author:"John Smith"',
  { maxResults: 100 }
);
Copy