MediaPlatform SDK

TypeScript/JavaScript SDK for Media Platform API - Upload, manage, and share your media files with ease.

Installation

npm install @media-platform/sdk

Quick Start

import { createMediaPlatformClient } from 'mediaplatform-sdk'

// Initialize the client
const client = createMediaPlatformClient('your-api-key')

// Upload a file from browser
const fileInput = document.querySelector('input[type="file"]')
const file = fileInput.files[0]
const uploadedFile = await client.upload(file)

console.log('File uploaded:', uploadedFile.url)

Features

• ✅ File Upload - Upload files from browser or Node.js
• ✅ File Management - List, get, and delete files
• ✅ TypeScript Support - Full type definitions included
• ✅ Browser & Node.js - Works in both environments
• ✅ Promise-based - Modern async/await API
• ✅ Lightweight - Zero dependencies

API Reference

Initialize Client

import { createMediaPlatformClient } from 'mediaplatform-sdk'

const client = createMediaPlatformClient(apiKey, apiUrl?)

Parameters:

• apiKey (string): Your API key from MediaPlatform dashboard
• apiUrl (string, optional): API base URL (defaults to production)

Upload File

From File Object (Browser)

const fileInfo = await client.upload(file)

From Buffer (Node.js)

import fs from 'fs'

const buffer = fs.readFileSync('image.jpg')
const fileInfo = await client.uploadFromBuffer(buffer, 'image.jpg', 'image/jpeg')

List Files

const response = await client.listFiles(page?, limit?)

console.log(response.files) // Array of files
console.log(response.pagination) // Pagination info

Get File Details

const fileInfo = await client.getFile(fileId)

Delete File

await client.deleteFile(fileId)

Download File

const buffer = await client.downloadFile(fileId)

Get File URL

const url = await client.getFileUrl(fileId)

Types

FileInfo

interface FileInfo {
  id: string
  filename: string
  mimeType: string
  size: number
  url: string
  createdAt: string
}

ListResponse

interface ListResponse {
  files: FileInfo[]
  pagination: {
    page: number
    limit: number
    total: number
    pages: number
  }
}

Examples

React Component

import React, { useState } from 'react'
import { createMediaPlatformClient } from 'mediaplatform-sdk'

const client = createMediaPlatformClient('your-api-key')

function FileUploader() {
  const [uploading, setUploading] = useState(false)
  
  const handleUpload = async (event) => {
    const file = event.target.files[0]
    if (!file) return
    
    setUploading(true)
    try {
      const uploadedFile = await client.upload(file)
      console.log('Uploaded:', uploadedFile.url)
    } catch (error) {
      console.error('Upload failed:', error)
    } finally {
      setUploading(false)
    }
  }
  
  return (
    <div>
      <input type="file" onChange={handleUpload} disabled={uploading} />
      {uploading && <p>Uploading...</p>}
    </div>
  )
}

Node.js Script

import { createMediaPlatformClient } from 'mediaplatform-sdk'
import fs from 'fs'

const client = createMediaPlatformClient('your-api-key')

async function uploadAndList() {
  // Upload a file
  const buffer = fs.readFileSync('document.pdf')
  const file = await client.uploadFromBuffer(buffer, 'document.pdf', 'application/pdf')
  
  console.log('Uploaded:', file.url)
  
  // List all files
  const response = await client.listFiles()
  console.log(`Total files: ${response.pagination.total}`)
  
  response.files.forEach(file => {
    console.log(`- ${file.filename} (${file.size} bytes)`)
  })
}

uploadAndList().catch(console.error)

Error Handling

try {
  const file = await client.upload(file)
} catch (error) {
  if (error.message.includes('401')) {
    console.error('Invalid API key')
  } else if (error.message.includes('413')) {
    console.error('File too large')
  } else {
    console.error('Upload failed:', error.message)
  }
}

Supported File Types

• Images: JPEG, PNG, GIF, WebP
• Videos: MP4, WebM, QuickTime
• Documents: PDF, TXT, and more
• Maximum file size: 50MB

Getting Your API Key

1. Sign up at MediaPlatform
2. Go to your dashboard
3. Click on Settings → API Key
4. Generate a new API key

License

MIT

Support

• 📧 Email: [email protected]
• 🐛 Issues: GitHub Issues
• 📖 Documentation: Full Documentation