Uppy ファイルアップローダー
Uppy は、Transloadit が開発するブラウザー向けのオープンソースのファイルアップローダーです。GitHub で 31,000 を超えるスターを獲得している、世界第1位のファイルアップローダーです。tus を標準でサポートしているため、ネットワークの瞬断やブラウザーのクラッシュ、誤ったページ移動があってもアップロードを再開できます。ブラウザーと Transloadit を連携する際の推奨手段です。
Uppy の Transloadit プラグイン を使うと、Transloadit API と連携できます。他のすべての Uppy プラグインと併用でき、Instagram などのサードパーティーサービスからのインポートに対応したモーダル UI のファイルピッカーや、HTML フォームとの連携なども利用できます。
Transloadit は、再開可能なアップロード向けに tusd を、またエンコード API をホストしています。リモートソースを追加する場合は、Companion もホストします。
Uppy + Transloadit によるアップロード
Uppy はブラウザーでのアップロード UX、Transloadit は処理パイプラインと考えてください。
- Uppy がファイル(ローカル、カメラ、リモートソース)を収集し、tus による再開可能なアップロードを行います。
- Transloadit が Assembly を実行します(エンコード、最適化、分析、保存など)。
- 配信はお使いのストレージから行われ、必要に応じてお使いの CDN または Transloadit の CDN(TLCDN)を経由します。
アップロードと保存だけが必要であれば、Assembly は最小限の構成(/upload/handle とエクスポート処理のみ)にできます。変換が必要な場合は、該当する Robot を追加すれば、アップロード UX はそのまま維持できます。Uppy を変更する必要はありません。
この構成なら、統一されたアップロード UI を提供しながら、製品の進化に合わせて処理の各段階を簡単に差し替えたり、拡張したりできます。
フレームワーク別ガイド
まず Uppy の標準ガイドで Template とサーバー側の署名を設定し、使用する技術スタックのクライアントセクションに進んでください。
このガイドでは、Transloadit の Auth Secret をサーバー上に保持し、有効期間の短い Assembly オプションに署名して、ブラウザーには
@uppy/transloadit に必要な値だけを渡します。サーバーは署名前に、許可する Template を選択し、現在のユーザーの認可を行う必要があります。ブラウザーから渡された任意の処理設定に署名してはいけません。
使用例
デモとして、ピッカーと当社の CDN バンドルを使い、Transloadit の顔検出を行う正常系の例を紹介します。このコピーして実行できるデモでは、説明のために意図的に Auth Key と未署名の処理設定をブラウザー内に配置しています。テスト用の認証情報でのみ使用してください。本番環境では、上記のフレームワーク別ガイドにある、サーバーで署名する Template のフローを使用してください。
<!-- TEST/DEMO ONLY: uses test credentials and unsigned Instructions in the browser. -->
<!-- For production, use https://uppy.io/docs/guides/uppy-transloadit/ -->
<!-- This pulls Uppy from our CDN -->
<!-- For smaller self-hosted bundles, install Uppy and plugins manually: -->
<!-- npm i @uppy/core @uppy/dashboard @uppy/image-editor @uppy/remote-sources @uppy/transloadit -->
<link href="https://releases.transloadit.com/uppy/v6.0.6/uppy.min.css" rel="stylesheet" />
<button id="browse">Select Files</button>
<script type="module">
import {
Uppy,
Dashboard,
ImageEditor,
RemoteSources,
Transloadit,
} from 'https://releases.transloadit.com/uppy/v6.0.6/uppy.min.mjs'
const uppy = new Uppy()
.use(Transloadit, {
waitForEncoding: true,
alwaysRunAssembly: true,
assemblyOptions: {
params: {
// To avoid tampering, use Signature Authentication:
// https://transloadit.com/docs/api/authentication/
auth: {
key: 'YOUR_TRANSLOADIT_KEY',
},
// It's often better to store encoding instructions in your account
// and use a template_id instead of adding these steps inline
steps: {
':original': {
robot: '/upload/handle',
},
faces_detected: {
use: ':original',
robot: '/image/facedetect',
crop: true,
faces: 'max-confidence',
format: 'preserve',
crop_padding: '10%',
},
exported: {
use: ['faces_detected', ':original'],
robot: '/s3/store',
credentials: 'demo_s3_credentials',
url_prefix: 'https://demos.transloadit.com/',
},
},
},
},
})
.use(Dashboard, { trigger: '#browse' })
.use(ImageEditor, { target: Dashboard })
// Optional: only needed for remote sources. Local-device uploads do not need Companion.
.use(RemoteSources, {
companionUrl: 'https://api2.transloadit.com/companion',
companionAllowedHosts: /\.transloadit\.com$/,
})
.on('complete', ({ transloadit }) => {
// Due to waitForEncoding:true this is fired after encoding is done.
// Alternatively, set waitForEncoding to false and provide a notify_url
console.log(transloadit) // Array of Assembly Statuses
transloadit.forEach((assembly) => {
console.log(assembly.results) // Object of encoding results keyed by Step name
})
})
.on('error', (error) => {
console.error(error)
})
</script>
その他の例は、examples/を参照するか、実際に動かしてお試しください。Uppy と Transloadit は非常に汎用性が高いため、異なる要件がある場合でも、すでに対応している可能性が高いです。
ドキュメント
プラグイン API 全体については、Uppy の Transloadit プラグインの完全なドキュメントを参照してください。一連の連携を実装するには、まずフレームワーク別ガイドをご覧ください。