コンバータプラグイン

ConverterプラグインはDoconutをドキュメント変換サービスに変えます。公開 DocumentConverter ファサードの背後にあるエンジンを提供し、オプトインで独自の HTTP 契約を持つドロップインウィジェットも提供するため、C# から、ウィジェットから、または自前で実装したフロントエンドからドキュメントを変換できます。

パッケージのインストール

最新の安定版 Converter プラグインをインストールします:

dotnet add package Doconut.NET6.Converter

現在の 26.7.0 リリースに固定したい場合は、バージョンを別途指定します:

dotnet add package Doconut.NET6.Converter --version 26.7.0

Converter パッケージは Doconut.NET6 と同じバージョンに保つ必要があります。パッケージ ID は Doconut.NET6.Converter で、.26.7.0 はダウンロードされた .nupkg ファイル名にのみ現れます。

プラグインの登録

AddConverter() メソッドはありません — Doconut のプラグインモデルは統一されています。すべてのプラグインは同じ方法で登録します: AddDoconut() 内で AddPlugin<TPlugin>() を呼び出すだけです。ConverterPlugin は独自の NuGet パッケージ Doconut.NET6.Converter に含まれ、ベースビューアーパッケージと共にインストールされます。

builder.Services.AddDoconut(options =>
{
    options.LicensePath = "Doconut.Viewer.lic";
    options.AddPlugin<Doconut.Plugins.Converter.ConverterPlugin>();
});

この呼び出しは、ライセンスが欠如している、レガシーな TRIAL ファイルがある、または Converter 機能を付与しない一時的でないライセンスがある場合に起動時に例外をスローします — AddDoconut() 内部から発生する InvalidOperationException です。デモ／NFR の一時ライセンスは受け付けられ、期限が切れた後も透かし付き出力で変換は利用可能です。無料のサイレントティアはありません。ライセンスの読み込み方法は License Setup を参照してください。

C# からの変換

すべての変換は位置 0 にシーク可能な MemoryStream を返し、すぐに読み取りまたはコピーできます。DocumentConverter は DI から取得してください — 設計上ステートレスなので、単一インスタンスをリクエスト間で安全に再利用できます。

// Inject DocumentConverter; its constructor is internal, so never `new` it.
Stream pdf = await converter.ConvertAsync("contract.docx", ConversionTarget.Pdf, ct: ct);

// sourceExtension includes the leading dot. password is null unless the document is protected.
Stream png = await converter.ConvertAsync(upload, ".xlsx", ConversionTarget.Png, password: null, ct: ct);

Stream html = await converter.WordToHtmlAsync("report.docx", ct);

Stream docx = await converter.HtmlToWordAsync(html, ConversionTarget.Docx, ct);

間違えやすいポイントが二つあります: ストリームオーバーロードの sourceExtension には先頭のドット (".xlsx") を含める必要があり、ドットなし ("xlsx") ではフォーマットカタログと照合できません。また、名前に反して WordToHtmlAsync は Task<Stream> を返し、Task<string> ではありません — HTML 文書（画像は Base64 埋め込み）をストリームとして取得します。これは他のすべての変換結果と同様です。

対象フォーマット

Pdf, Docx, Doc, Html, Xlsx, Pptx, Png, Jpeg, Csv, Tiff, Bmp, Gif, Svg, Xml,
Txt, Xls, Jp2, Rtf, Odt, Ods, Odp, Epub, Xps, Webp

すべてのソースがすべてのターゲットに変換できるわけではありません — プラグインは各ソースのフォーマットファミリー（Word、Excel、PowerPoint、PDF、CAD、Image、Email、Diagram、Project/Task、PSD、Web ドキュメント）を独自の許可されたターゲット集合にマッピングします。UI のターゲットリストとしてこの enum をハードコードしないでください: ?convert=open はアップロードされたファイルに対して実際の allowedTargets を返し、ピッカーはそれに基づくべきです。

ドロップインウィジェット

ウィジェットの ?convert=open|run|download エンドポイントはオプトインで、デフォルトでは無効化されています — デフォルトでセキュアです。サーバー側で有効化し、プラグイン登録と同時に設定してください:

builder.Services.AddDoconut(options =>
{
    options.LicensePath = "Doconut.Viewer.lic";
    options.AddPlugin<Doconut.Plugins.Converter.ConverterPlugin>();
    options.AddConverterWidget(widget =>
    {
        widget.MaxUploadMb = 25;
    });
});

<div id="doconut-convert"></div>
<script src="/doconut-res/js/doconutConverter.js"></script>
<script>
  Doconut.convert('#doconut-convert', { basePath: '/doconut', resPath: '/doconut-res', maxUploadMb: 25 });
</script>

AddConverterWidget() を呼び出さないと、3 つの ?convert= エンドポイントはすべて 404 を返します — ただし JS ファイル自体は依然として配信されます（単なる埋め込み静的リソースで、通信先エンドポイントだけがゲートされます）。AddConverterWidget() は Converter プラグインが登録され、Converter を付与するライセンスがあることを前提とします — それ自体で変換権限を付与するわけではありません。

ウィジェットのカスタマイズ

Doconut.convert(selector, options) に渡す初期オプション:

コールバック:

Doconut.convert() はウィジェットインスタンス自体を返します — 取得してプログラムからウィジェットを操作できます:

const conv = Doconut.convert('#doconut-convert', { basePath: '/doconut' });
conv.reset();         // アイドル/ドロップ画面に戻す。onReady は再発火しない
conv.loadFile(file);  // File オブジェクトでフロー開始。アイドル時以外は無操作
conv.destroy();       // リスナーを削除し、マウントを空にする。以後インスタンスは使用不可

独自フロントエンドの構築

ウィジェットはこの HTTP 契約のクライアントに過ぎません — 直接この契約に対して独自フロントエンドを構築すれば、別の UX を実現できます。3 つのルートはすべて UseDoconut() がマウントされている ASP.NET ブランチ（通常は /doconut）の下に配置されます:

アップロードされたソースバイトはサーバー側で 30 分の TTL と共に保管されます。この期間が過ぎると run は 404 を返し、再度 open からやり直す必要があります。変換結果も同じ保管領域に残り、downloadToken は変換完了時に新たな 30 分間のウィンドウを取得します。一方 resultToken はビューアーセッションのキャッシュ寿命に従う普通のセッショントークンです。

open 応答の sourceExt には先頭のドットがありません（例: "docx"） — これは DocumentConverter.ConvertAsync の sourceExtension パラメータ（ドット必須）とは逆の規約です。

失敗モード（ルート別）

リソースの所有権

コンバータは位置 0 にシークされた MemoryStream を返します。呼び出し側がそのストリームを所有し、コピーまたは内容を返した後に破棄する必要があります。DocumentConverter サービス自体はステートレスで、依存性注入から取得します。手動でインスタンス化したり破棄したりしないでください。

Web ウィジェットの場合、アップロードとダウンロードの保管はそれぞれ独立した 30 分 TTL を持ちます。ビューアーの resultToken はビューアーセッションの寿命に従います。ビューアー結果を閉じても有効なダウンロード保管は削除されず、ブラウザウィジェットをリセットしても TTL は延長されません。

トラブルシューティング

透かし処理

ConverterPlugin が登録されている場合、ホストのライセンスは次の 3 つの状態のいずれかです:

両方の呼び出し経路は同じルールでフラグを算出します: DocumentConverter の C# ファサードは内部でライセンスの IsViewerLicensed と IsTemporary 状態から導出し、ウィジェットの ?convert=run ハンドラも同等のチェック (IsViewerLicensed && !IsTrial && !IsTemporary) を行って watermarked フィールドを設定します。評価ライセンスでエンドツーエンドの統合を構築・テストでき、購入後は出力バイトだけが変わります。