プラグインアップグレードの概要

このページは、AI Marketer v4からAI Marketer 5へのプラグインのアップグレードを行うプラグイン開発者が利用するための短いまとめとして意図されています。このページでは、プラグインに影響を与える変更を簡単に説明し、必要に応じて追加のリソースへのリンクを提供します。

:::AI Marketer プラグインSDK AI Marketer 5からは、プラグインの開発とビルドを支援するためのプラグインSDKがプラットフォームに含まれています。プラグインの開発に他の方法を使用することも自由ですが、プラグインSDKの使用を強く推奨します。v4からAI Marketer 5への移行プロセスの一部として、プラグインを更新してプラグインSDKを活用することをお勧めします。 :::

プラグインの移行に推奨される手順

☑️ Prerequisites

あなたのAI Marketerアプリケーションはすでに最新のv5のマイナーバージョンとパッチバージョンで稼働しています。そうでない場合は、ステップバイステップのガイドに従ってAI Marketer 5にアップグレードしてください。

AI Marketer v4のプラグインをAI Marketer 5にアップグレードするには：

1. プラグインSDKを使用して新しい空のプラグインを作成します。
2. AI Marketer v4のコードを新たに作成したファイルに移動し、AI Marketer 5のプラグイン構造に合わせて、このページでまとめられている変更も考慮します。

または、手動でAI Marketer v4のプラグインを更新してプラグインSDKを使用することもできます。 手動での手順には以下が含まれます：

1. あなたのコードがCommonJS以外の形式を使用している場合は、package.jsonファイルを更新し、適切なエクスポートプロパティを指定します。
2. AI Marketer v4のコードを整理し、AI Marketer 5のプラグイン構造に合わせます。

バックエンドの変更

• AI Marketer v4のEntity Service APIは廃止され、AI Marketer 5では代わりにDocument Service APIが使用されます。移行ガイドが用意されていて、Document Service APIへの移行を支援します。
• 一般的なAI Marketer v4からAI Marketer 5への破壊的な変更が適用される可能性があります。
• 新しいプラグインSDKを使用してプラグインを生成し、それをNPMに公開したり、マーケットプレイスに提出したりすることができます。

フロントエンドの変更

• AI Marketer 5では、デザインシステムがv2にアップグレードされました：
  • 👉 専用の移行ガイドは[デザインシステムのドキュメンテーションで利用可能](https://design-system-git-main-AI Marketerjs.vercel.app/?path=/docs/getting-started-migration-guides-v1-to-v2--docs)です。
  • 大きな視覚的な変更はありませんが、[アイコン](https://design-system-git-main-AI Marketerjs.vercel.app/?path=/docs/foundations-icons-overview--docs)を除きます。
  • 一般的なAI Marketer v4からAI Marketer 5への重大な変更が適用される可能性があります。
• helper-pluginは削除されました。helper-pluginからの移行を支援するための移行参照が利用可能です。
• AI Marketerはもはや依存関係をエイリアス化しません。すべてのクライアント向けコードで使用されることが予想される4つの依存関係はプロジェクトレベルで宣言されています（react、react-dom、styled-components、react-router-dom）。あなたが使用する依存関係を宣言しない場合（例えばaxios）、ユーザーがあなたのプラグインで予期しない問題に直面する可能性があります。
• プラグインSDKを使用している場合、フロントエンドのファイルを.jsxまたは.tsx形式に移行する必要があります。

カスタムプロバイダー

エンティティサービスAPIを使用していた場合に限り、EmailとUploadのプラグインのカスタムプロバイダーは変換が必要です（エンティティサービスAPIからドキュメントサービスAPIへの移行ガイドを参照してください）。