Files SDK

Files SDK: De Ultieme Universele Opslag SDK voor Ontwikkelaars

In het moderne landschap van cloud-ontwikkeling is het beheren van verschillende opslagproviders vaak een complexe uitdaging. Elke provider, van AWS S3 tot Cloudflare R2 en Vercel Blob, heeft zijn eigen subtiele verschillen in de SDK. Files SDK lost dit probleem op door een uniforme laag te bieden over object- en blob-backends heen. Met een focus op eenvoud en webstandaarden, stelt Files SDK ontwikkelaars in staat om een "small, honest API" te gebruiken die overal hetzelfde werkt.

Wat is Files SDK?

Files SDK is een unified storage SDK die specifiek is ontworpen om de inconsistenties tussen verschillende object storage SDK's te elimineren. Het exposeert de kernfuncties die bij elke provider hetzelfde zijn — zoals uploaden, downloaden, lijsten genereren en verwijderen — achter een enkele, overzichtelijke klasse. Hierdoor hoeft u zich geen zorgen meer te maken over de specifieke implementatiedetails van elke provider.

Files SDK is gebouwd met web-standaarden I/O in gedachten. Dit betekent dat het moeiteloos werkt met File, Blob, ReadableStream, ArrayBuffer en gewone strings. Of u nu bouwt op Node.js, Bun, Cloudflare Workers of Vercel, Files SDK functioneert overal waar fetch beschikbaar is.

Belangrijkste Kenmerken van Files SDK

1. Eén API voor Alle Providers

Met Files SDK hoeft u uw code niet volledig te herschrijven wanneer u besluit over te stappen van de ene opslagprovider naar de andere. De API blijft consistent, of u nu AWS S3, Google Cloud Storage of een lokale MinIO-instantie gebruikt.

2. Web-standaarden I/O

De SDK is toekomstbestendig door het gebruik van standaard web-API's. Dit zorgt voor maximale compatibiliteit met moderne JavaScript-omgevingen. Het accepteert diverse formaten, waardoor het verwerken van uploads en downloads uiterst flexibel is.

3. De 'Escape Hatch' via files.raw

Hoewel Files SDK de meest voorkomende acties vereenvoudigt, begrijpt het dat u soms toegang nodig heeft tot provider-specifieke functies zoals versioning, lifecycle management, ACL's of multipart-uploads. Via de eigenschap files.raw heeft u direct toegang tot de native client van de adapter, volledig getypeerd.

4. Voorspelbare Foutafhandeling

Niets is frustrerender dan verschillende foutcodes van verschillende SDK's. Files SDK introduceert een genormaliseerde FilesError met consistente codes over alle providers heen. De originele fout wordt altijd meegeleverd als 'cause', zodat u nooit informatie verliest.

5. Lichtgewicht en Modulair

De native SDK van elke provider is een optionele peer dependency. Dit betekent dat u alleen de pakketten installeert die u daadwerkelijk gebruikt, wat de uiteindelijke bundelgrootte van uw applicatie minimaliseert.

Hoe Files SDK te Gebruiken

Installatie

U kunt Files SDK installeren met uw favoriete package manager. Vergeet niet om ook de native SDK van de gewenste adapter te installeren.

# Via npm
npm install files-sdk

# Via pnpm
pnpm add files-sdk

# Via bun
bun add files-sdk

# Via yarn
yarn add files-sdk

Snel Aan de Slag

Om te beginnen, configureert u een Files instantie met de adapter van uw keuze. De adapter wordt vastgelegd tijdens de constructie om de call sites plat en leesbaar te houden.

import { Files } from "files-sdk";
import { s3 } from "files-sdk/s3";

// Configureer de Files SDK met een S3-adapter
const files = new Files({
  adapter: s3({ bucket: "uploads", region: "us-east-1" }),
});

// Een bestand uploaden
await files.upload("hallo.txt", "wereld");

// Een bestand downloaden
const file = await files.download("hallo.txt");

// Bestanden in een map oplijsten
const { items } = await files.list({ prefix: "hallo" });

// Een bestand verwijderen
await files.delete("hallo.txt");

Ondersteunde Adapters

Files SDK biedt een indrukwekkende compatibiliteitsmatrix. Bijna elke grote (en kleine) opslagprovider wordt ondersteund via een eigen adapter. Hieronder volgt een overzicht van de ondersteunde platforms:

• Cloud Providers: AWS S3, Cloudflare R2, Google Cloud Storage (GCS), Azure, Vercel Blob, Netlify Blobs.
• S3-Compatibel: MinIO, DigitalOcean Spaces, Hetzner, Akamai, Bunny Storage, Wasabi, Scaleway, OVHcloud, iDrive e2, Vultr, Filebase, Exoscale.
• Specifieke Platformen: Supabase, Firebase Storage, Appwrite, PocketBase, UploadThing, Cloudinary.
• Consumenten Opslag: Google Drive, OneDrive, SharePoint, Dropbox, Box.
• Andere: Filesystem (lokaal), Bun S3, Storj, Tigris, Yandex Object Storage.

Elke adapter implementeert de standaard tien methoden (upload, download, delete, list, head, exists, copy, url, signedUploadUrl), hoewel sommige URL-gerelateerde methoden kunnen variëren per provider.

Use Case: Waarom Kiezen voor Files SDK?

Multi-Cloud Strategieën

Bedrijven die niet afhankelijk willen zijn van één enkele vendor kunnen Files SDK gebruiken om hun applicatie eenvoudig draagbaar te maken tussen verschillende clouds. Wisselen van AWS naar Cloudflare R2 is slechts een kwestie van de adapterconfiguratie aanpassen.

Lokale Ontwikkeling en Testen

U kunt tijdens de ontwikkeling de Filesystem adapter of een lokale MinIO instantie gebruiken, en in productie naadloos overschakelen naar een enterprise oplossing zoals AWS S3 of Azure, zonder de logica van uw applicatie aan te tasten.

Edge Computing

Dankzij de compatibiliteit met webstandaarden is Files SDK de ideale keuze voor applicaties die draaien op de Edge (zoals Vercel of Cloudflare Workers), waar traditionele, zware SDK's vaak problemen geven.

Veelgestelde Vragen (FAQ)

V: Moet ik alle native SDK's installeren? A: Nee, Files SDK maakt gebruik van peer dependencies. U installeert alleen de SDK van de provider die u daadwerkelijk gebruikt. Als u een adapter probeert te importeren zonder de bijbehorende SDK, zal er een foutmelding verschijnen die aangeeft welk pakket er mist.

V: Wat als ik een specifieke functie nodig heb die niet in de Files SDK API zit? A: Hiervoor is de files.raw property aanwezig. Dit geeft u direct toegang tot de onderliggende native client, zodat u alle geavanceerde functies van die specifieke provider kunt benutten terwijl u de rest van de eenvoudige API behoudt.

V: Worden foutmeldingen consistent afgehandeld? A: Ja, Files SDK levert een FilesError met een genormaliseerde code. Dit maakt het schrijven van foutafhandeling een stuk eenvoudiger omdat u niet voor elke provider andere foutstructuren hoeft te parsen.

V: Is Files SDK geschikt voor Bun? A: Absoluut. Files SDK is ontworpen om overal te draaien waar fetch wordt ondersteund, inclusief Bun en Node.js.

---

Files SDK is een open-source project onder de MIT-licentie, ontwikkeld door Hayden Bleasel.