@oxyhq/services
Version:
Reusable OxyHQ module to handle authentication, user management, karma system, device-based session management and more 🚀
456 lines (423 loc) • 14.2 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.OxyServicesAssetsMixin = OxyServicesAssetsMixin;
/**
* Asset & File Methods Mixin
*/
function OxyServicesAssetsMixin(Base) {
return class extends Base {
constructor(...args) {
super(...args);
}
// ============================================================================
// FILE METHODS (Convenience wrappers using Asset Service)
// ============================================================================
/**
* Delete file
*/
async deleteFile(fileId) {
try {
// Central Asset Service delete with force=true behavior controlled by caller via assetDelete
return await this.makeRequest('DELETE', `/api/assets/${encodeURIComponent(fileId)}`, undefined, {
cache: false
});
} catch (error) {
throw this.handleError(error);
}
}
/**
* Get file download URL (synchronous - uses stream endpoint for images to avoid ORB blocking)
* The stream endpoint serves images directly with proper CORS headers, avoiding browser ORB blocking
* For better performance with signed URLs, use getFileDownloadUrlAsync when possible
*/
getFileDownloadUrl(fileId, variant, expiresIn) {
const base = this.getBaseURL();
const params = new URLSearchParams();
if (variant) params.set('variant', variant);
if (expiresIn) params.set('expiresIn', String(expiresIn));
params.set('fallback', 'placeholderVisible');
const token = this.getClient().getAccessToken();
if (token) params.set('token', token);
// Use stream endpoint which serves images directly with proper CORS headers
// This avoids ERR_BLOCKED_BY_ORB errors that occur with redirect-based endpoints
const qs = params.toString();
return `${base}/api/assets/${encodeURIComponent(fileId)}/stream${qs ? `?${qs}` : ''}`;
}
/**
* Get file download URL asynchronously (returns signed URL directly from CDN)
* This is more efficient than the synchronous version as it avoids redirects
* Use this when you can handle async operations (e.g., in useEffect, useMemo with async)
*/
async getFileDownloadUrlAsync(fileId, variant, expiresIn) {
try {
const url = await this.fetchAssetDownloadUrl(fileId, variant, this.getAssetUrlCacheTTL(expiresIn), expiresIn);
return url || this.getFileDownloadUrl(fileId, variant, expiresIn);
} catch (error) {
// Fallback to synchronous method on error
return this.getFileDownloadUrl(fileId, variant, expiresIn);
}
}
/**
* List user files
*/
async listUserFiles(limit, offset) {
try {
const paramsObj = {};
if (limit) paramsObj.limit = limit;
if (offset) paramsObj.offset = offset;
return await this.makeRequest('GET', '/api/assets', paramsObj, {
cache: false // Don't cache file lists - always get fresh data
});
} catch (error) {
throw this.handleError(error);
}
}
/**
* Get file content as text
*/
async getFileContentAsText(fileId, variant) {
try {
const downloadUrl = await this.fetchAssetDownloadUrl(fileId, variant, this.getAssetUrlCacheTTL());
if (!downloadUrl) {
throw new Error('No download URL returned for asset');
}
return await this.fetchAssetContent(downloadUrl, 'text');
} catch (error) {
throw this.handleError(error);
}
}
/**
* Get file content as blob
*/
async getFileContentAsBlob(fileId, variant) {
try {
const downloadUrl = await this.fetchAssetDownloadUrl(fileId, variant, this.getAssetUrlCacheTTL());
if (!downloadUrl) {
throw new Error('No download URL returned for asset');
}
return await this.fetchAssetContent(downloadUrl, 'blob');
} catch (error) {
throw this.handleError(error);
}
}
/**
* Get batch access to multiple files
* Returns URLs and access status for each file
*/
async getBatchFileAccess(fileIds, context) {
try {
return await this.makeRequest('POST', '/api/assets/batch-access', {
fileIds,
context
});
} catch (error) {
throw this.handleError(error);
}
}
/**
* Get download URLs for multiple files efficiently
*/
async getFileDownloadUrls(fileIds, context) {
const response = await this.getBatchFileAccess(fileIds, context);
const urls = {};
// response.results is the map
const results = response.results || {};
for (const [id, result] of Object.entries(results)) {
if (result.allowed && result.url) {
urls[id] = result.url;
}
}
return urls;
}
/**
* Upload raw file data
*/
async uploadRawFile(file, visibility, metadata) {
// Switch to Central Asset Service upload flow
return this.assetUpload(file, visibility, metadata);
}
// ============================================================================
// CENTRAL ASSET SERVICE METHODS
// ============================================================================
/**
* Calculate SHA256 hash of file content
*/
async calculateSHA256(file) {
const buffer = await file.arrayBuffer();
const hashBuffer = await crypto.subtle.digest('SHA-256', buffer);
const hashArray = Array.from(new Uint8Array(hashBuffer));
return hashArray.map(b => b.toString(16).padStart(2, '0')).join('');
}
/**
* Initialize asset upload - returns pre-signed URL and file ID
*/
async assetInit(sha256, size, mime) {
try {
return await this.makeRequest('POST', '/api/assets/init', {
sha256,
size,
mime
}, {
cache: false
});
} catch (error) {
throw this.handleError(error);
}
}
/**
* Complete asset upload - commit metadata and trigger variant generation
*/
async assetComplete(fileId, originalName, size, mime, visibility, metadata) {
try {
return await this.makeRequest('POST', '/api/assets/complete', {
fileId,
originalName,
size,
mime,
visibility,
metadata
}, {
cache: false
});
} catch (error) {
throw this.handleError(error);
}
}
/**
* Upload file using Central Asset Service
*/
async assetUpload(file, visibility, metadata, onProgress) {
try {
// Calculate SHA256
const sha256 = await this.calculateSHA256(file);
// Initialize upload
const initResponse = await this.assetInit(sha256, file.size, file.type);
// Try presigned URL first
try {
await this.uploadToPresignedUrl(initResponse.uploadUrl, file, onProgress);
} catch (e) {
// Fallback: direct upload via API to avoid CORS issues
const fd = new FormData();
fd.append('file', file);
// Use httpService directly for FormData uploads (bypasses caching for special handling)
await this.getClient().request({
method: 'POST',
url: `/api/assets/${encodeURIComponent(initResponse.fileId)}/upload-direct`,
data: fd,
cache: false
});
}
// Complete upload
return await this.assetComplete(initResponse.fileId, file.name, file.size, file.type, visibility, metadata);
} catch (error) {
throw this.handleError(error);
}
}
/**
* Upload file to pre-signed URL
*/
async uploadToPresignedUrl(url, file, onProgress) {
return new Promise((resolve, reject) => {
const xhr = new XMLHttpRequest();
xhr.upload.addEventListener('progress', event => {
if (event.lengthComputable && onProgress) {
const progress = event.loaded / event.total * 100;
onProgress(progress);
}
});
xhr.addEventListener('load', () => {
if (xhr.status >= 200 && xhr.status < 300) {
resolve();
} else {
reject(new Error(`Upload failed with status ${xhr.status}`));
}
});
xhr.addEventListener('error', () => {
reject(new Error('Upload failed'));
});
xhr.open('PUT', url);
xhr.setRequestHeader('Content-Type', file.type);
xhr.send(file);
});
}
/**
* Link asset to an entity
*/
async assetLink(fileId, app, entityType, entityId, visibility, webhookUrl) {
try {
const body = {
app,
entityType,
entityId
};
if (visibility) body.visibility = visibility;
if (webhookUrl) body.webhookUrl = webhookUrl;
return await this.makeRequest('POST', `/api/assets/${fileId}/links`, body, {
cache: false
});
} catch (error) {
throw this.handleError(error);
}
}
/**
* Unlink asset from an entity
*/
async assetUnlink(fileId, app, entityType, entityId) {
try {
return await this.makeRequest('DELETE', `/api/assets/${fileId}/links`, {
app,
entityType,
entityId
}, {
cache: false
});
} catch (error) {
throw this.handleError(error);
}
}
/**
* Get asset metadata
*/
async assetGet(fileId) {
try {
return await this.makeRequest('GET', `/api/assets/${fileId}`, undefined, {
cache: true,
cacheTTL: 5 * 60 * 1000 // 5 minutes cache
});
} catch (error) {
throw this.handleError(error);
}
}
/**
* Get asset URL (CDN or signed URL)
*/
async assetGetUrl(fileId, variant, expiresIn) {
try {
const params = {};
if (variant) params.variant = variant;
if (expiresIn) params.expiresIn = expiresIn;
return await this.makeRequest('GET', `/api/assets/${fileId}/url`, params, {
cache: true,
cacheTTL: 10 * 60 * 1000 // 10 minutes cache for URLs
});
} catch (error) {
throw this.handleError(error);
}
}
/**
* Restore asset from trash
*/
async assetRestore(fileId) {
try {
return await this.makeRequest('POST', `/api/assets/${fileId}/restore`, undefined, {
cache: false
});
} catch (error) {
throw this.handleError(error);
}
}
/**
* Delete asset with optional force
*/
async assetDelete(fileId, force = false) {
try {
const params = force ? {
force: 'true'
} : undefined;
return await this.makeRequest('DELETE', `/api/assets/${fileId}`, params, {
cache: false
});
} catch (error) {
throw this.handleError(error);
}
}
/**
* Get list of available variants for an asset
*/
async assetGetVariants(fileId) {
try {
const assetData = await this.assetGet(fileId);
return assetData.file?.variants || [];
} catch (error) {
throw this.handleError(error);
}
}
/**
* Update asset visibility
* @param fileId - The file ID
* @param visibility - New visibility level ('private', 'public', or 'unlisted')
* @returns Updated asset information
*/
async assetUpdateVisibility(fileId, visibility) {
try {
return await this.makeRequest('PATCH', `/api/assets/${fileId}/visibility`, {
visibility
}, {
cache: false
});
} catch (error) {
throw this.handleError(error);
}
}
/**
* Helper: Upload and link avatar with automatic public visibility
* @param file - The avatar file
* @param userId - User ID to link to
* @param app - App name (defaults to 'profiles')
* @returns The uploaded and linked asset
*/
async uploadAvatar(file, userId, app = 'profiles') {
try {
// Upload as public
const asset = await this.assetUpload(file, 'public');
// Link to user profile as avatar
await this.assetLink(asset.file.id, app, 'avatar', userId, 'public');
return asset;
} catch (error) {
throw this.handleError(error);
}
}
/**
* Helper: Upload and link profile banner with automatic public visibility
* @param file - The banner file
* @param userId - User ID to link to
* @param app - App name (defaults to 'profiles')
* @returns The uploaded and linked asset
*/
async uploadProfileBanner(file, userId, app = 'profiles') {
try {
// Upload as public
const asset = await this.assetUpload(file, 'public');
// Link to user profile as banner
await this.assetLink(asset.file.id, app, 'profile-banner', userId, 'public');
return asset;
} catch (error) {
throw this.handleError(error);
}
}
getAssetUrlCacheTTL(expiresIn) {
const desiredTtlMs = (expiresIn ?? 3600) * 1000;
return Math.min(desiredTtlMs, 10 * 60 * 1000);
}
async fetchAssetDownloadUrl(fileId, variant, cacheTTL, expiresIn) {
const params = {};
if (variant) params.variant = variant;
if (expiresIn) params.expiresIn = expiresIn;
const urlRes = await this.makeRequest('GET', `/api/assets/${encodeURIComponent(fileId)}/url`, Object.keys(params).length ? params : undefined, {
cache: true,
cacheTTL: cacheTTL ?? 10 * 60 * 1000 // default 10 minutes cache for URLs
});
return urlRes?.url || null;
}
async fetchAssetContent(url, type) {
const response = await fetch(url);
if (!response?.ok) {
throw new Error(`Failed to fetch asset content (status ${response?.status})`);
}
return type === 'text' ? response.text() : response.blob();
}
};
}
//# sourceMappingURL=OxyServices.assets.js.map