Web SDKの変更ログ

設定を一意に識別するために、クエリ フィルターの一部としてSettingカテゴリ名を使用しないことに関連するバグを修正します。

自己参照リレーションに関連するバグを修正します。自己参照リレーションの親側が変更され、リレーションの子側が変更されていない場合、リレーションの子側でリンクされているエンティティ(またはその逆)は保存時にクリアされます。

このリリースでは、Web SDKにいくつかの重要な構造変更が加えられ、リリース サイクル、依存関係の使用、およびさまざまなContent Hubバージョンとの互換性が向上します。

Web 3.4.0以降、SDKのリリース サイクルはContent Hubのリリース サイクルに関連付けられなくなりました。これにより、新機能が追加されたときやバグが修正されたときに、より頻繁にリリースすることができます。

Web SDKの多くの(内部およびサードパーティの)依存関係が削除されました。これにより、依存関係の1つ以上の変更によるWeb SDKへの予期しない変更が防止されます。

Web SDKは、NuGetに依存するものが少なくなったため、軽量にもなります。ただし、一部の統合では、次のいずれかのNuGetで提供されているモデルが使用されていた可能性があります。

これらのNuGetが1つ以上必要な場合は、手動で参照してください。

これまで、Content Hubは、バージョン3.0以降の任意のバージョンのWeb SDKと下位互換性がありました。今後、Web SDKは、Web SDKより新しいまたは古いContent Hubバージョンとも互換性を持つようになります (ただし、バージョン3.0以降でも同じです)。つまり、Content Hubのバージョンに関係なく、常に最新バージョンのWeb SDKに更新できる必要があります。

詳細については、「 互換性」を参照してください。

Web SDKでは、回復性のあるHTTP呼び出しにPollyが使用されるようになりました。Pollyは、タイムアウト、再試行、調整、および認証トークンの更新を管理するために使用されます。

このDiagnosticsClientは、監査やデバッグのために実行時にWeb SDKから追加情報を取得するために追加されました。HTTP要求と応答、キャッシュ イベント、ネットワークの問題、警告をログに記録するために使用できます (記事)。

必要に応じて、サーバーとSDK間の互換性チェックを無効にするフラグを追加しました (記事)。

ContentGroupプロパティがIMemberGroupインターフェイスに追加されました。

IEntityの基になるJSONペイロードからExtensionDataを取得するための拡張メソッドを追加しました。

AllowUpdatesプロパティは、リレーション定義でもサポートされるようになりました。以前は、これはプロパティ定義でのみサポートされていました。その結果、AllowUpdatesプロパティはIPropertyDefinitionからIMemberDefinitionに移動しました。これは、プロパティ定義とリレーション定義の両方の基本インターフェイスです。

キャッシュされたオーバーロードをエンティティ定義クライアントに追加しました。

カルチャ クライアントにキャッシュされたメソッドのオーバーロードを追加しました。

ILinkHelperのDefinitionsToLinksAsyncメソッドは削除されました。

このWebApiClientはWeb SDKに組み込まれました。この変更は主に内部的なものですが、その結果、名前空間が一部変更されます。最も注目すべき名前空間の変更は次のとおりです。

スロットルのサポートが追加されました (バック ポート)。

エンティティ定義クライアントに対するエンティティ定義の作成、変更、および削除操作が追加されました。(記事)

新しい通知クライアントを追加しました。(記事)

アセットクライアントを追加しました。(記事)

このリリースでは、最初の厳密に型指定されたエンティティが特徴となっています。アセットについては、IAssetが使用可能になりました。通知クライアントには、厳密に型指定されたエンティティIMailTemplateもあります。これらの厳密に型指定されたエンティティは、まだIEntityにすぎませんが、エンティティ メンバーは、より優れた開発エクスペリエンスのためのC#プロパティとメソッドとしても提供されます。将来的には、より強く型指定されたエンティティが追加され、既存のエンティティが拡張されます。

IEntityDefinitionsClientの新機能:

IEntityLoadConfigurationにビルダーを追加しました。これを使用して、荷重構成を簡単に作成または拡張できます。(記事)

クエリ フィルターが拡張され、次の新しい文字列フィルターが使用できるようになりました (記事)。

Defaultsにさらにデフォルト値が追加されました。

IEntityDefinitionの新機能:IsNewプロパティを追加しました。

ILinkHelperの新機能 (Web SDK):

IUsersClientの新機能:

オプションでサーバーとSDK (バックポート) 間の互換性チェックを無効にするフラグを追加しました。

IEntity (バックポート) の基になるJSONペイロードからExtensionDataを取得する拡張メソッドが追加されました。

IRelationDefinitionにAssociatedLabelsプロパティを追加しました。

IMemberDefinitionの変更: IsSecuredプロパティはnull可能でなくなりました。

IRelationDefinitionの変更点:

QueryのEntityLoadOptionsプロパティとLoadConfigurationプロパティの両方が廃止されました。負荷構成は、常にQueryとは別に渡されるか、SDKによって自動的に解決されるようになりました。プロパティは、下位互換性のためだけにまだ存在しています。これは、LINQを使用する場合のWithProperties、WithRelations、InCultures、およびLoadConfigurationも廃止されたことも意味します。ただし、上記のように、負荷構成には同様のビルダーがあります。

すべてのロード・オプション (PropertyLoadOption、RelationLoadOption、CultureLoadOption) は、カスタム値をリストするためにIEnumerableの代わりに配列を使用するようになりました。

IEntity: LoadPropertiesAsync、LoadRelationsAsync、LoadMembersAsyncは遅延読み込みが不可能なときにスローしなくなりましたが、直接falseを返します。

フィルターなしでクエリを実行すると、バックエンドが例外をスローする問題を修正しました。フィルタなしでクエリを実行できるようになりました。これにより、たとえば、MのX個の最新のエンティティを取得できます。

スロットルのサポートが追加されました (バックポート)。

WebApiExceptionメッセージに詳細情報とHTTPステータスコードが含まれるようになりました。

ValidationExceptionのToStringに、検証の失敗が含まれるようになりました。

オプションでサーバーとSDK (バックポート) 間の互換性チェックを無効にするフラグを追加しました。

IEntity (バックポート) の基になるJSONペイロードからExtensionDataを取得する拡張メソッドが追加されました。

Stylelabs.M.Sdk.WebApiClient.Exceptions.WebApiExceptionをスローするのではなく、失敗したAPI呼び出しにStylelabs.M.Sdk.WebClient.Exceptions.WebApiExceptionする必要があります。

RelationMemberConditionエンティティIDではなくエンティティ定義IDを参照していました。

GetSettingsForCategoryAsyncは、カテゴリが存在しない場合、空のリストを返します。これは透明な動作ではなかったため、NotFoundExceptionがスローされます。

一部のデフォルト値が変更されました。

IMemberDefinitionモデル (実装) が公開されていない問題を修正しました。

範囲による定義がオフセットと合計カウントを入れ替えて結果を返したIEntityDefinitionsClientの問題を修正しました。

データ ソースの削除時に検証例外が発生した場合に、クライアントが間違った例外をスローしていたIDataSourcesClientの問題を修正しました。

カテゴリが存在しない場合GetCategoryIdAsyncnullではなく0を返すISettingsClientの問題を修正しました。

カルチャなしで明示的に作成されたエンティティを作成するときのエンティティ ファクトリの問題を修正しました。現在、カルチャに依存したプロパティは、カルチャなしで作成されたときにエンティティに存在しなくなりました。

定義が存在しないときにGetIdAsyncNullReferenceExceptionをスローするIEntityDefinitionsClientのバグを修正しました。

ネストされたプロパティがない場合に、IRelationDefinition上のNestedPropertiesが空のリストではなくnullされるバグを修正しました。

欠落しているレンディションを修正しました。