From bb3dfb4e06bb0aa8f354d25ebb040ae23ee4f0fe Mon Sep 17 00:00:00 2001 From: Matthew Parker Date: Thu, 19 Dec 2024 17:41:41 +0000 Subject: [PATCH 1/3] Adjusted proj files to include pdb and xml files in the nugets --- .../PinguApps.Appwrite.Client.csproj | 6 +++++- .../PinguApps.Appwrite.Playground.csproj | 1 + .../PinguApps.Appwrite.Server.csproj | 6 +++++- .../PinguApps.Appwrite.Shared.csproj | 3 +++ 4 files changed, 14 insertions(+), 2 deletions(-) diff --git a/src/PinguApps.Appwrite.Client/PinguApps.Appwrite.Client.csproj b/src/PinguApps.Appwrite.Client/PinguApps.Appwrite.Client.csproj index 86dc910d..a082cae0 100644 --- a/src/PinguApps.Appwrite.Client/PinguApps.Appwrite.Client.csproj +++ b/src/PinguApps.Appwrite.Client/PinguApps.Appwrite.Client.csproj @@ -22,6 +22,8 @@ Copyright 2024 (c) Pingu. All rights reserved. $(TargetsForTfmSpecificBuildOutput);CopyProjectReferencesToPackage + true + $(NoWarn);1591 @@ -36,7 +38,7 @@ true - PinguApps.Appwrite.Shared.dll + PinguApps.Appwrite.Shared.dll;PinguApps.Appwrite.Shared.xml;PinguApps.Appwrite.Shared.pdb @@ -48,6 +50,8 @@ + + diff --git a/src/PinguApps.Appwrite.Playground/PinguApps.Appwrite.Playground.csproj b/src/PinguApps.Appwrite.Playground/PinguApps.Appwrite.Playground.csproj index 9c725139..e8f419cf 100644 --- a/src/PinguApps.Appwrite.Playground/PinguApps.Appwrite.Playground.csproj +++ b/src/PinguApps.Appwrite.Playground/PinguApps.Appwrite.Playground.csproj @@ -24,6 +24,7 @@ + diff --git a/src/PinguApps.Appwrite.Server/PinguApps.Appwrite.Server.csproj b/src/PinguApps.Appwrite.Server/PinguApps.Appwrite.Server.csproj index fb24d1b8..4d08491c 100644 --- a/src/PinguApps.Appwrite.Server/PinguApps.Appwrite.Server.csproj +++ b/src/PinguApps.Appwrite.Server/PinguApps.Appwrite.Server.csproj @@ -22,6 +22,8 @@ Copyright 2024 (c) Pingu. All rights reserved. $(TargetsForTfmSpecificBuildOutput);CopyProjectReferencesToPackage + true + $(NoWarn);1591 @@ -36,7 +38,7 @@ true - PinguApps.Appwrite.Shared.dll + PinguApps.Appwrite.Shared.dll;PinguApps.Appwrite.Shared.xml;PinguApps.Appwrite.Shared.pdb @@ -48,6 +50,8 @@ + + diff --git a/src/PinguApps.Appwrite.Shared/PinguApps.Appwrite.Shared.csproj b/src/PinguApps.Appwrite.Shared/PinguApps.Appwrite.Shared.csproj index 4dbf2dcd..09499f7c 100644 --- a/src/PinguApps.Appwrite.Shared/PinguApps.Appwrite.Shared.csproj +++ b/src/PinguApps.Appwrite.Shared/PinguApps.Appwrite.Shared.csproj @@ -4,6 +4,9 @@ netstandard2.1 enable latest + + true + $(NoWarn);1591 From 9d67b62cf273de9bf299cfc6c6e1e754e043509a Mon Sep 17 00:00:00 2001 From: Matthew Parker Date: Thu, 19 Dec 2024 17:55:33 +0000 Subject: [PATCH 2/3] Fixed xml doc issues --- src/PinguApps.Appwrite.Client/Clients/IAccountClient.cs | 9 ++++----- src/PinguApps.Appwrite.Server/Clients/IAccountClient.cs | 2 +- src/PinguApps.Appwrite.Server/Clients/ITeamsClient.cs | 2 +- src/PinguApps.Appwrite.Shared/AppwriteResultOfT.cs | 2 +- .../Responses/IdentitiesList.cs | 2 +- src/PinguApps.Appwrite.Shared/Responses/Jwt.cs | 2 +- 6 files changed, 9 insertions(+), 10 deletions(-) diff --git a/src/PinguApps.Appwrite.Client/Clients/IAccountClient.cs b/src/PinguApps.Appwrite.Client/Clients/IAccountClient.cs index 377b872f..9bcc073c 100644 --- 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 /// Appwrite Docs /// - /// Array of query strings generated using the Query class provided by the SDK. Learn more about queries. Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, provider, providerUid, providerEmail, providerAccessTokenExpiry + /// The request content /// The Identities List Task> 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. /// Appwrite Docs /// - /// Array of query strings generated using the Query class provided by the SDK. Learn more about queries. Only supported methods are limit and offset + /// The request content /// The Logs List Task> 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 /// Appwrite Docs /// - /// Type of authenticator. Must be `totp` + /// The request content /// The MfaType Task> AddAuthenticator(AddAuthenticatorRequest request); @@ -97,7 +97,6 @@ public interface IAccountClient /// Appwrite Docs /// /// The request content - /// Type of authenticator /// The User Task> 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 /// Appwrite Docs /// - /// The request content + /// The request content /// The user Task> UpdatePreferences(UpdatePreferencesRequest request); diff --git a/src/PinguApps.Appwrite.Server/Clients/IAccountClient.cs b/src/PinguApps.Appwrite.Server/Clients/IAccountClient.cs index 0b29e1a9..43e79d5e 100644 --- a/src/PinguApps.Appwrite.Server/Clients/IAccountClient.cs +++ b/src/PinguApps.Appwrite.Server/Clients/IAccountClient.cs @@ -22,7 +22,7 @@ public interface IAccountClient Task> Create(CreateAccountRequest request); /// - /// 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 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 Update Email on client or create an OAuth2 session /// Appwrite Docs /// /// The Session diff --git a/src/PinguApps.Appwrite.Server/Clients/ITeamsClient.cs b/src/PinguApps.Appwrite.Server/Clients/ITeamsClient.cs index e469d974..273a4251 100644 --- a/src/PinguApps.Appwrite.Server/Clients/ITeamsClient.cs +++ b/src/PinguApps.Appwrite.Server/Clients/ITeamsClient.cs @@ -64,7 +64,7 @@ public interface ITeamsClient /// /// 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. /// 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. - /// Use the url parameter to redirect the user from the invitation email to your app. After the user is redirected, use to allow the user to accept the invitation to the team. + /// Use the url parameter to redirect the user from the invitation email to your app. After the user is redirected, use UpdateTeamMembershipStatus to allow the user to accept the invitation to the team. /// Please note that to avoid a Redirect Attack Appwrite will accept the only redirect URLs under the domains you have added as a platform on the Appwrite Console. /// Appwrite Docs /// diff --git a/src/PinguApps.Appwrite.Shared/AppwriteResultOfT.cs b/src/PinguApps.Appwrite.Shared/AppwriteResultOfT.cs index 95c2cff7..0f6a76d2 100644 --- a/src/PinguApps.Appwrite.Shared/AppwriteResultOfT.cs +++ b/src/PinguApps.Appwrite.Shared/AppwriteResultOfT.cs @@ -12,7 +12,7 @@ public AppwriteResult(OneOf result) } /// - /// /// The result of making the API call. Can be , or depending on what happened + /// The result of making the API call. Can be , or depending on what happened /// public new OneOf Result { get; } diff --git a/src/PinguApps.Appwrite.Shared/Responses/IdentitiesList.cs b/src/PinguApps.Appwrite.Shared/Responses/IdentitiesList.cs index 3a606182..3939fe9a 100644 --- 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; /// /// An Appwrite Identities List object /// -/// Total number of identities documents that matched your query. +/// Total number of identities documents that matched your query. /// List of identities. Can be one of: 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 index 9a49f2a4..d2f0e4ba 100644 --- 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; /// /// A JWT response object /// -/// JWT encoded string +/// JWT encoded string public record Jwt( [property: JsonPropertyName("jwt")] string Token ); From 858998d9358b3c1d90c2f0d5d185c8c002b11a88 Mon Sep 17 00:00:00 2001 From: Matthew Parker Date: Thu, 19 Dec 2024 17:56:39 +0000 Subject: [PATCH 3/3] bump version --- src/PinguApps.Appwrite.Shared/Constants.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/PinguApps.Appwrite.Shared/Constants.cs b/src/PinguApps.Appwrite.Shared/Constants.cs index 3641eb4a..38186e18 100644 --- 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"; }