コンバータプラグイン

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 のプラグインモデルは統一されています。すべてのプラグインは、Converter も含めて、同じ方法で登録されます：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 登録は受け付けられますが、カレンダー上の有効期限が切れると、変換は透かし付き出力で利用可能なままです。サイレントな無料ティアはありません。ライセンスのロード方法については、ライセンス設定 を参照してください。

C# から変換

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

// DocumentConverter を注入します。そのコンストラクタは internal なので、決して `new` しないでください。
Stream pdf = await converter.ConvertAsync("contract.docx", ConversionTarget.Pdf, ct: ct);

// sourceExtension には先頭のドットが含まれます。ドキュメントが保護されていない限り、password は null です。
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);

間違えやすい2つの詳細があります：ストリームオーバーロードの 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 ドキュメント）を独自の固定された許可対象セットにマッピングします。この enum を UI のターゲットリストとしてハードコードしないでください：?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 と応答し、ファイルは再度開く必要があります。変換結果は同じ保管領域に保存され、変換完了時に downloadToken は新たな 30 分間のウィンドウを取得します — 一方、resultToken は通常のビューアセッショントークンで、ビューアのセッションキャッシュに従い、保管領域とは独立しています。

sourceExt は open レスポンス内では先頭にドットがありません（例: "docx"） — これは DocumentConverter.ConvertAsync の sourceExtension パラメータがドットを必要とするのとは逆の規約です。

失敗モード（ルート別）:

リソース所有権

コンバータは位置がゼロに設定されたシーク可能な MemoryStream を返します。呼び出し側がそのストリームを所有し、コピーまたは内容を返した後に破棄すべきです。DocumentConverter サービス自体はステートレスで、依存性注入から解決されます。サービスを手動で構築したり破棄したりしないでください。

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

トラブルシューティング

ウォーターマーキング

ConverterPlugin が登録されている場合、ホストのライセンスは以下の 3 つの状態のいずれかになります：

両方の呼び出しパスは同じルールからフラグを計算します：DocumentConverter の C# ファサードはライセンスの IsViewerLicensed と IsTemporary の状態から内部的に導出し、ウィジェットの ?convert=run ハンドラは同等のチェック（IsViewerLicensed && !IsTrial && !IsTemporary）を行い、返却する watermarked フィールドを埋めます。統合は購入前に評価ライセンスでエンドツーエンドに構築・テストでき、変更されるのは出力バイトだけです。