Bundler SDK

A JavaScript SDK for interacting with the Bundler upload service.

Installation

npm install bundler-upload-sdk

Usage

Node.js

import { BundlerSDK } from 'bundler-upload-sdk';

// Initialize the SDK with your endpoint and API key
const bundler = new BundlerSDK('http://127.0.0.1:8000', 'your-api-key');

// Upload multiple files with their associated tags
try {
  const txHash = await bundler.upload([
    {
      file: paperFileBuffer,
      tags: {
        'content-type': 'text/plain',
        'filename': 'paper.txt'
      }
    },
    {
      file: woodFileBuffer,
      tags: {
        'content-type': 'text/plain',
        'filename': 'wood.txt'
      }
    }
  ]);
  console.log('Upload successful! Transaction hash:', txHash);
} catch (error) {
  console.error('Upload failed:', error.message);
}

// Upload a single file with tags
try {
  const txHash = await bundler.upload([
    {
      file: fileBuffer,
      tags: {
        'content-type': 'image/jpeg',
        'category': 'photos',
        'userId': '123'
      }
    }
  ]);
  console.log('Upload successful! Transaction hash:', txHash);
} catch (error) {
  console.error('Upload failed:', error.message);
}

Browser

For browser environments, you need to use the browser-specific version of the SDK:

import { BundlerSDK } from 'bundler-upload-sdk/browser';

// Initialize the SDK with your endpoint and API key
const bundler = new BundlerSDK('http://127.0.0.1:8000', 'your-api-key');

// Example: Upload a file from a file input element
document.getElementById('fileInput').addEventListener('change', async (event) => {
  const file = event.target.files[0];
  if (!file) return;
  
  try {
    const txHash = await bundler.upload([
      {
        file: file,
        tags: {
          'content-type': file.type,
          'filename': file.name
        }
      }
    ]);
    console.log('Upload successful! Transaction hash:', txHash);
  } catch (error) {
    console.error('Upload failed:', error.message);
  }
});

// Example: Upload a Blob created in the browser
const blob = new Blob(['Hello, world!'], { type: 'text/plain' });
try {
  const txHash = await bundler.upload([
    {
      file: blob,
      tags: {
        'content-type': 'text/plain',
        'filename': 'hello.txt'
      }
    }
  ]);
  console.log('Upload successful! Transaction hash:', txHash);
} catch (error) {
  console.error('Upload failed:', error.message);
}

API Reference

new BundlerSDK(endpoint, apiKey)

Creates a new BundlerSDK instance.

• endpoint (string): The API endpoint URL
• apiKey (string): The API key for authentication

upload(uploads)

Uploads one or more files with their associated tags.

• uploads (Array): An array of upload objects, each containing:
  • file: The file to upload
    • In Node.js: Can be a Buffer, Blob, or File object
    • In browser: Can be a Blob or File object
  • tags (Object, optional): Key-value pairs of tags to attach to the file
• Returns: Promise - Resolves with the transaction hash
• Throws: Error if the upload fails or network error occurs

Usage in different environments

Node.js

import { BundlerSDK } from 'bundler-upload-sdk';

Browser

import { BundlerSDK } from 'bundler-upload-sdk/browser';

Bundlers (Webpack, Rollup, etc.)

The package.json includes the browser field, so most bundlers will automatically use the browser version when bundling for browser environments.

Example curl command equivalent to the SDK usage:

curl -X POST http://127.0.0.1:8000/upload \
  -H "Authorization: your-api-key" \
  -F "[email protected]" \
  -F "tag_content-type=text/plain" \
  -F "tag_filename=paper.txt" \
  -F "[email protected]" \
  -F "tag_content-type=text/plain" \
  -F "tag_filename=wood.txt"

Error Handling

The SDK throws errors in the following cases:

• Missing required parameters (endpoint, apiKey)
• Empty uploads array or missing files
• Network errors during upload
• Server errors (non-200 responses)
• Invalid or missing API key
• Malformed server response

Development

The Node.js version of this SDK uses:

• form-data for handling multipart form data uploads
• node-fetch for making HTTP requests

The browser version uses native browser APIs:

• Built-in fetch API for making HTTP requests
• Built-in FormData API for multipart form data uploads

License

MIT