@teo_dev/vm-file-types

Type definitions for VM system modules. Provides autocomplete and type checking for scripts running in the Keen VM environment.

Install

npm install @teo_dev/vm-file-types

Usage

import { FilesManager, BaseFile, FilePDF, FileImage, FileMSExcel, FileMSWord, FileText, FileCSV } from 'system/files';

// Get a file as a typed object
const file = await FilesManager.getFileById('abc-123');
await file.download();

// PDF specific methods
const pdf = await FilesManager.getFileById('pdf-id');
await pdf.splitPages();
await pdf.extractImages();

// Raw JSON response
const raw = await FilesManager.getFileByIdRaw('abc-123');
console.log(raw.originalName, raw.mimeType, raw.size);

// Search files
const results = await FilesManager.searchFiles({ name: 'report.pdf' });

Available Exports

FilesManager

File management operations — upload, download, search, copy, delete, lock/unlock. Each method has a Raw variant that returns plain JSON (FileData) instead of a file object.

File Classes

| Class | Description | |-------|-------------| | BaseFile | Base file with common operations (download, copy, delete, lock, unlock) | | FilePDF | PDF operations (splitPages, extractImages) | | FileImage | Image files (.jpg, .jpeg, .png) | | FileText | Text files (.txt) | | FileCSV | CSV files (.csv) | | FileMSWord | Word documents (.doc, .docx) | | FileMSExcel | Excel spreadsheets (.xls, .xlsx) |

Interfaces

FileData, FileSearchFilters, UploadOptions, CopyOptions, CreateFromBase64Options, UpdateFromBase64Options