Merge pull request #584 from PinguApps/dev

Merge v0.4.5
PinguApps · Dec 19, 2024 · acd0ea3 · acd0ea3
2 parents b846635 + 865a4e1
commit acd0ea3
Show file tree

Hide file tree

Showing 14 changed files with 27 additions and 16 deletions.
diff --git a/src/PinguApps.Appwrite.Client/Clients/IAccountClient.cs b/src/PinguApps.Appwrite.Client/Clients/IAccountClient.cs
@@ -41,7 +41,7 @@ public interface IAccountClient
     /// Get the list of identities for the currently logged in user
     /// <para><see href="https://appwrite.io/docs/references/1.6.x/client-rest/account#listIdentities">Appwrite Docs</see></para>
     /// </summary>
-    /// <param name="queries">Array of query strings generated using the Query class provided by the SDK. <see href="https://appwrite.io/docs/queries">Learn more about queries</see>. Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: <c>userId</c>, <c>provider</c>, <c>providerUid</c>, <c>providerEmail</c>, <c>providerAccessTokenExpiry</c></param>
+    /// <param name="request">The request content</param>
     /// <returns>The Identities List</returns>
     Task<AppwriteResult<IdentitiesList>> ListIdentities(ListIdentitiesRequest request);
 
@@ -64,7 +64,7 @@ public interface IAccountClient
     /// Get the list of latest security activity logs for the currently logged in user. Each log returns user IP address, location and date and time of log.
     /// <para><see href="https://appwrite.io/docs/references/1.6.x/client-rest/account#listLogs">Appwrite Docs</see></para>
     /// </summary>
-    /// <param name="queries">Array of query strings generated using the Query class provided by the SDK. <see href="https://appwrite.io/docs/queries">Learn more about queries</see>. Only supported methods are limit and offset</param>
+    /// <param name="request">The request content</param>
     /// <returns>The Logs List</returns>
     Task<AppwriteResult<LogsList>> ListLogs(ListLogsRequest request);
 
@@ -88,7 +88,7 @@ public interface IAccountClient
     /// Add an authenticator app to be used as an MFA factor. Verify the authenticator using <see cref="VerifyAuthenticator"/>
     /// <para><see href="https://appwrite.io/docs/references/1.6.x/client-rest/account#createMfaAuthenticator">Appwrite Docs</see></para>
     /// </summary>
-    /// <param name="type">Type of authenticator. Must be `totp`</param>
+    /// <param name="request">The request content</param>
     /// <returns>The MfaType</returns>
     Task<AppwriteResult<MfaType>> AddAuthenticator(AddAuthenticatorRequest request);
 
@@ -97,7 +97,6 @@ public interface IAccountClient
     /// <para><see href="https://appwrite.io/docs/references/1.6.x/client-rest/account#updateMfaAuthenticator">Appwrite Docs</see></para>
     /// </summary>
     /// <param name="request">The request content</param>
-    /// <param name="type">Type of authenticator</param>
     /// <returns>The User</returns>
     Task<AppwriteResult<User>> VerifyAuthenticator(VerifyAuthenticatorRequest request);
 
@@ -180,7 +179,7 @@ public interface IAccountClient
     /// Update currently logged in user account preferences. The object you pass is stored as is, and replaces any previous value. The maximum allowed prefs size is 64kB and throws error if exceeded
     /// <para><see href="https://appwrite.io/docs/references/1.6.x/client-rest/account#updatePrefs">Appwrite Docs</see></para>
     /// </summary>
-    /// <param name="preferences">The request content</param>
+    /// <param name="request">The request content</param>
     /// <returns>The user</returns>
     Task<AppwriteResult<User>> UpdatePreferences(UpdatePreferencesRequest request);
 

diff --git a/src/PinguApps.Appwrite.Client/PinguApps.Appwrite.Client.csproj b/src/PinguApps.Appwrite.Client/PinguApps.Appwrite.Client.csproj
@@ -22,6 +22,8 @@
     <Copyright>Copyright 2024 (c) Pingu. All rights reserved.</Copyright>
 
     <TargetsForTfmSpecificBuildOutput>$(TargetsForTfmSpecificBuildOutput);CopyProjectReferencesToPackage</TargetsForTfmSpecificBuildOutput>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <NoWarn>$(NoWarn);1591</NoWarn>
   </PropertyGroup>
 
   <ItemGroup>
@@ -36,7 +38,7 @@
   <ItemGroup>
     <ProjectReference Include="..\PinguApps.Appwrite.Shared\PinguApps.Appwrite.Shared.csproj">
       <ReferenceOutputAssembly>true</ReferenceOutputAssembly>
-      <IncludeAssets>PinguApps.Appwrite.Shared.dll</IncludeAssets>
+      <IncludeAssets>PinguApps.Appwrite.Shared.dll;PinguApps.Appwrite.Shared.xml;PinguApps.Appwrite.Shared.pdb</IncludeAssets>
     </ProjectReference>
   </ItemGroup>
 
@@ -48,6 +50,8 @@
   <Target DependsOnTargets="ResolveReferences" Name="CopyProjectReferencesToPackage">
     <ItemGroup>
       <BuildOutputInPackage Include="@(ReferenceCopyLocalPaths->WithMetadataValue('ReferenceSourceTarget', 'ProjectReference'))"/>
+      <BuildOutputInPackage Include="@(ReferenceCopyLocalPaths->WithMetadataValue('ReferenceSourceTarget', 'ProjectReference')->Replace('.dll', '.xml'))"/>
+      <BuildOutputInPackage Include="@(ReferenceCopyLocalPaths->WithMetadataValue('ReferenceSourceTarget', 'ProjectReference')->Replace('.dll', '.pdb'))"/>
     </ItemGroup>
   </Target>
 

diff --git a/src/PinguApps.Appwrite.Playground/PinguApps.Appwrite.Playground.csproj b/src/PinguApps.Appwrite.Playground/PinguApps.Appwrite.Playground.csproj
@@ -24,6 +24,7 @@
   <ItemGroup>
     <ProjectReference Include="..\PinguApps.Appwrite.Client\PinguApps.Appwrite.Client.csproj" />
     <ProjectReference Include="..\PinguApps.Appwrite.Server\PinguApps.Appwrite.Server.csproj" />
+    <ProjectReference Include="..\PinguApps.Appwrite.Shared\PinguApps.Appwrite.Shared.csproj" />
   </ItemGroup>
 
 </Project>
diff --git a/src/PinguApps.Appwrite.Server/Clients/IAccountClient.cs b/src/PinguApps.Appwrite.Server/Clients/IAccountClient.cs
@@ -22,7 +22,7 @@ public interface IAccountClient
     Task<AppwriteResult<User>> Create(CreateAccountRequest request);
 
     /// <summary>
-    /// Use this endpoint to allow a new user to register an anonymous account in your project. This route will also create a new session for the user. To allow the new user to convert an anonymous account to a normal account, you need to call <see cref="UpdateEmail(UpdateEmailRequest)"/> or create an OAuth2 session
+    /// Use this endpoint to allow a new user to register an anonymous account in your project. This route will also create a new session for the user. To allow the new user to convert an anonymous account to a normal account, you need to call <see href="https://appwrite.io/docs/references/1.6.x/client-rest/account#updateEmail">Update Email on client</see> or create an OAuth2 session
     /// <para><see href="https://appwrite.io/docs/references/1.6.x/server-rest/account#createAnonymousSession">Appwrite Docs</see></para>
     /// </summary>
     /// <returns>The Session</returns>

diff --git a/src/PinguApps.Appwrite.Server/Clients/ITeamsClient.cs b/src/PinguApps.Appwrite.Server/Clients/ITeamsClient.cs
@@ -64,7 +64,7 @@ public interface ITeamsClient
     /// <summary>
     /// <para>Invite a new member to join your team. Provide an ID for existing users, or invite unregistered users using an email or phone number. If initiated from a Client SDK, Appwrite will send an email or sms with a link to join the team to the invited user, and an account will be created for them if one doesn't exist. If initiated from a Server SDK, the new member will be added automatically to the team.</para>
     /// <para>You only need to provide one of a user ID, email, or phone number. Appwrite will prioritize accepting the user ID > email > phone number if you provide more than one of these parameters.</para>
-    /// <para>Use the url parameter to redirect the user from the invitation email to your app. After the user is redirected, use <see cref="UpdateTeamMembershipStatus(UpdateTeamMembershipStatusRequest)"/> to allow the user to accept the invitation to the team.</para>
+    /// <para>Use the url parameter to redirect the user from the invitation email to your app. After the user is redirected, use <see href="https://appwrite.io/docs/references/cloud/client-web/teams#updateMembershipStatus">UpdateTeamMembershipStatus</see> to allow the user to accept the invitation to the team.</para>
     /// <para>Please note that to avoid a <see href="https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md">Redirect Attack</see> Appwrite will accept the only redirect URLs under the domains you have added as a platform on the Appwrite Console.</para>
     /// <para><see href="https://appwrite.io/docs/references/1.6.x/server-rest/teams#createMembership">Appwrite Docs</see></para>
     /// </summary>

diff --git a/src/PinguApps.Appwrite.Server/PinguApps.Appwrite.Server.csproj b/src/PinguApps.Appwrite.Server/PinguApps.Appwrite.Server.csproj
@@ -22,6 +22,8 @@
     <Copyright>Copyright 2024 (c) Pingu. All rights reserved.</Copyright>
 
     <TargetsForTfmSpecificBuildOutput>$(TargetsForTfmSpecificBuildOutput);CopyProjectReferencesToPackage</TargetsForTfmSpecificBuildOutput>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <NoWarn>$(NoWarn);1591</NoWarn>
   </PropertyGroup>
 
   <ItemGroup>
@@ -36,7 +38,7 @@
   <ItemGroup>
     <ProjectReference Include="..\PinguApps.Appwrite.Shared\PinguApps.Appwrite.Shared.csproj">
       <ReferenceOutputAssembly>true</ReferenceOutputAssembly>
-      <IncludeAssets>PinguApps.Appwrite.Shared.dll</IncludeAssets>
+      <IncludeAssets>PinguApps.Appwrite.Shared.dll;PinguApps.Appwrite.Shared.xml;PinguApps.Appwrite.Shared.pdb</IncludeAssets>
     </ProjectReference>
   </ItemGroup>
 
@@ -48,6 +50,8 @@
   <Target DependsOnTargets="ResolveReferences" Name="CopyProjectReferencesToPackage">
     <ItemGroup>
       <BuildOutputInPackage Include="@(ReferenceCopyLocalPaths->WithMetadataValue('ReferenceSourceTarget', 'ProjectReference'))"/>
+      <BuildOutputInPackage Include="@(ReferenceCopyLocalPaths->WithMetadataValue('ReferenceSourceTarget', 'ProjectReference')->Replace('.dll', '.xml'))"/>
+      <BuildOutputInPackage Include="@(ReferenceCopyLocalPaths->WithMetadataValue('ReferenceSourceTarget', 'ProjectReference')->Replace('.dll', '.pdb'))"/>
     </ItemGroup>
   </Target>
 

diff --git a/src/PinguApps.Appwrite.Shared/AppwriteResultOfT.cs b/src/PinguApps.Appwrite.Shared/AppwriteResultOfT.cs
@@ -12,7 +12,7 @@ public AppwriteResult(OneOf<TResult, AppwriteError, InternalError> result)
     }
 
     /// <summary>
-    /// /// The result of making the API call. Can be <see cref="TResult"/>, <see cref="AppwriteError"/> or <see cref="InternalError"/> depending on what happened
+    /// The result of making the API call. Can be <typeparamref name="TResult"/>, <see cref="AppwriteError"/> or <see cref="InternalError"/> depending on what happened
     /// </summary>
     public new OneOf<TResult, AppwriteError, InternalError> Result { get; }
 

diff --git a/src/PinguApps.Appwrite.Shared/Constants.cs b/src/PinguApps.Appwrite.Shared/Constants.cs
@@ -1,5 +1,5 @@
 namespace PinguApps.Appwrite.Shared;
 public static class Constants
 {
-    public const string Version = "0.4.4";
+    public const string Version = "0.4.5";
 }
diff --git a/src/PinguApps.Appwrite.Shared/PinguApps.Appwrite.Shared.csproj b/src/PinguApps.Appwrite.Shared/PinguApps.Appwrite.Shared.csproj
@@ -4,6 +4,9 @@
     <TargetFramework>netstandard2.1</TargetFramework>
     <Nullable>enable</Nullable>
     <LangVersion>latest</LangVersion>
+
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <NoWarn>$(NoWarn);1591</NoWarn>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/src/PinguApps.Appwrite.Shared/Responses/IdentitiesList.cs b/src/PinguApps.Appwrite.Shared/Responses/IdentitiesList.cs
@@ -6,7 +6,7 @@ namespace PinguApps.Appwrite.Shared.Responses;
 /// <summary>
 /// An Appwrite Identities List object
 /// </summary>
-/// <param name="Count">Total number of identities documents that matched your query.</param>
+/// <param name="Total">Total number of identities documents that matched your query.</param>
 /// <param name="Identities">List of identities. Can be one of: <see cref="IdentityModel"/></param>
 public record IdentitiesList(
     [property: JsonPropertyName("total")] int Total,

diff --git a/src/PinguApps.Appwrite.Shared/Responses/Jwt.cs b/src/PinguApps.Appwrite.Shared/Responses/Jwt.cs
@@ -5,7 +5,7 @@ namespace PinguApps.Appwrite.Shared.Responses;
 /// <summary>
 /// A JWT response object
 /// </summary>
-/// <param name="token">JWT encoded string</param>
+/// <param name="Token">JWT encoded string</param>
 public record Jwt(
     [property: JsonPropertyName("jwt")] string Token
 );
diff --git a/tests/PinguApps.Appwrite.Client.Tests/PinguApps.Appwrite.Client.Tests.csproj b/tests/PinguApps.Appwrite.Client.Tests/PinguApps.Appwrite.Client.Tests.csproj
@@ -18,7 +18,7 @@
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.12.0" />
     <PackageReference Include="RichardSzalay.MockHttp" Version="7.0.0" />
     <PackageReference Include="xunit" Version="2.9.2" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="2.8.2" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="3.0.0" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/tests/PinguApps.Appwrite.Server.Tests/PinguApps.Appwrite.Server.Tests.csproj b/tests/PinguApps.Appwrite.Server.Tests/PinguApps.Appwrite.Server.Tests.csproj
@@ -19,7 +19,7 @@
     <PackageReference Include="Moq" Version="4.20.71" />
     <PackageReference Include="RichardSzalay.MockHttp" Version="7.0.0" />
     <PackageReference Include="xunit" Version="2.9.2" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="2.8.2" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="3.0.0" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/tests/PinguApps.Appwrite.Shared.Tests/PinguApps.Appwrite.Shared.Tests.csproj b/tests/PinguApps.Appwrite.Shared.Tests/PinguApps.Appwrite.Shared.Tests.csproj
@@ -19,7 +19,7 @@
     <PackageReference Include="Moq" Version="4.20.71" />
     <PackageReference Include="RichardSzalay.MockHttp" Version="7.0.0" />
     <PackageReference Include="xunit" Version="2.9.2" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="2.8.2" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="3.0.0" />
   </ItemGroup>
 
   <ItemGroup>