Store files from your app

Some apps need more than saved settings: a DJ app keeps its buyer's tracks, a photo app keeps their pictures. File storage gives each buyer their own space for large files inside your app, without you running a server. Small data such as settings and lists still belongs in window.panoplyStorage.

Who gets it

File storage is off by default. Panoply turns it on for an app at review and sets how much each buyer may store. If your app needs it, say so in your submission, with the amount per buyer and why. The figure is fixed at review, not chosen by you, because Panoply pays for the storage.

An app also needs its storage slot (the per-app database behind panoplyStorage), because the list of each buyer's files lives there. See the plan matrix on the pricing page.

The API

window.panoplyFiles is defined in every app, before your own scripts run. When file storage is off, every method rejects with the code files_not_enabled, so you can detect it without guarding a missing global.

• list() → the buyer's files: [{ id, name, type, size, createdAt }], newest first.
• usage() → { usedBytes, reservedBytes, quotaBytes, warnBytes }.
• upload(file, { name?, onProgress?, signal? }) → the stored file, with fresh usage. file is a File or Blob. onProgress gets { loaded, total }, and an AbortSignal cancels.
• url(id) → an address on your app for that file. Use it as the src of an <audio>, <video> or <img>. Seeking works, because the browser asks for byte ranges.
• get(id) → the file as a Response, so you can stream or read it.
• delete(id) → { usage }.

// Upload with a progress bar const track = await panoplyFiles.upload(fileFromInput, { onProgress: ({ loaded, total }) => bar.value = loaded / total, }) // Play it, seeking included audio.src = panoplyFiles.url(track.id) // Warn before the buyer runs out const u = await panoplyFiles.usage() if (u.warnBytes !== null && u.usedBytes >= u.warnBytes) showStorageWarning(u)

A failed call rejects with an error carrying a code, a status and, where useful, details:

Limits

Usage counts every finished file, plus uploads still in progress. An upload that is never finished stops counting after a day.

Scope and privacy

• Each buyer's files are their own. Another buyer of your app, or another app, cannot list, read or delete them. An agent that uses your app has its own files, separate from the person it works for.
• Files leave with the buyer. When a purchase is refunded and no other purchase of the app is left, or when the buyer deletes their account, their files and their saved panoplyStorage data in your app are deleted. If the app is taken down, buyers' files are kept, in case it comes back.
• Downloads are served safely. Audio, video, common image types and PDFs open in the page. Everything else, HTML and SVG included, is offered as a download. A file a buyer uploads can never run as part of your app.

Under the hood: the routes

You normally only need the methods above. For tools generating an app, or for debugging, these are the routes on your app's own address that the client calls. All of them need the buyer's session and refuse requests from other sites (403, code cross_origin).