Version bump to 3.0.0

Author: acupofjose

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 3.0.0 - 2022-11-08
+
+- Re: [#54](https://github.com/supabase-community/postgrest-csharp/pull/54) Restructure Project to support DI and enable Nullity
+	- `Client` is no longer a singleton class.
+	- `StatelessClient` has been removed as `Client` performs the same essential functions.
+	- `Table` default constructor requires reference to `JsonSerializerSettings`
+	- `BaseModel` now keeps track of `BaseUrl` and `RequestClientOptions`. These are now used in the default (and overridable) `BaseModel.Update` and `BaseModel.Delete` methods (as they previously referenced the singleton).
+	- All publicly facing classes (that offer functionality) now include an Interface.
+	- `RequestException` is no longer thrown for attempting to update a record that does not exist, instead an empty `ModeledResponse` is returned.
+
 ## 2.1.1 - 2022-10-19
 
 - Re: [#50](https://github.com/supabase-community/postgrest-csharp/issues/50) & [#51](https://github.com/supabase-community/postgrest-csharp/pull/51) Adds `shouldFilterTopRows` as constructor parameter for `ReferenceAttribute` which defaults to `true` to match current API expectations.

Postgrest/Postgrest.csproj

@@ -19,16 +19,16 @@
 		</Description>
 		<PackageIconUrl>https://avatars.githubusercontent.com/u/54469796?s=200&amp;v=4</PackageIconUrl>
 		<PackageTags>supabase,postgrest</PackageTags>
-		<ReleaseVersion>2.1.1</ReleaseVersion>
-		<PackageVersion>2.1.1</PackageVersion>
+		<ReleaseVersion>3.0.0</ReleaseVersion>
+		<PackageVersion>3.0.0</PackageVersion>
 	</PropertyGroup>
 	<PropertyGroup>
 		<Nullable>enable</Nullable>
 		<LangVersion>8.0</LangVersion>
 		<WarningsAsErrors>CS8600;CS8602;CS8603</WarningsAsErrors>
 	</PropertyGroup>
 	<PropertyGroup Condition=" '$(Version)' == '' ">
-		<VersionPrefix Condition=" '$(VersionPrefix)' == '' ">2.1.1</VersionPrefix>
+		<VersionPrefix Condition=" '$(VersionPrefix)' == '' ">3.0.0</VersionPrefix>
 		<VersionSuffix Condition=" '$(VersionSuffix)' == '' ">
 		</VersionSuffix>
 		<Version Condition=" '$(VersionSuffix)' != '' ">$(VersionPrefix)-$(VersionSuffix)</Version>

PostgrestExample/PostgrestExample.csproj

@@ -3,7 +3,7 @@
   <PropertyGroup>
     <OutputType>Exe</OutputType>
     <TargetFramework>netcoreapp3.1</TargetFramework>
-    <ReleaseVersion>2.1.1</ReleaseVersion>
+    <ReleaseVersion>3.0.0</ReleaseVersion>
   </PropertyGroup>
 
   <ItemGroup>

PostgrestTests/PostgrestTests.csproj

@@ -3,7 +3,7 @@
 	<PropertyGroup>
 		<TargetFramework>netcoreapp3.1</TargetFramework>
 		<IsPackable>false</IsPackable>
-		<ReleaseVersion>2.1.1</ReleaseVersion>
+		<ReleaseVersion>3.0.0</ReleaseVersion>
 	</PropertyGroup>
 
 	<ItemGroup>

README.md

@@ -9,6 +9,30 @@
 </a>
 </p>
 
+---
+
+## BREAKING CHANGES MOVING FROM v2.x.x to v3.x.x
+
+- `Client` is no longer a singleton class.
+- `StatelessClient` has been removed as `Client` performs the same essential functions.
+- `Table` default constructor requires reference to `JsonSerializerSettings`
+- `BaseModel` now keeps track of `BaseUrl` and `RequestClientOptions`. These are now used in the default (and overridable) `BaseModel.Update` and `BaseModel.Delete` methods (as they previously referenced the singleton).
+- All publicly facing classes (that offer functionality) now include an Interface.
+- `RequestException` is no longer thrown for attempting to update a record that does not exist, instead an empty `ModeledResponse` is returned.
+
+In Short:
+```c#
+// What was:
+var client = Client.Initialize(baseUrl, options);
+var query = await client.Table<User>.Single();
+
+// Becomes:
+var client = new Client(baseUrl, options);
+var query = await client.Table<User>.Single();
+```
+
+---
+
 Documentation can be found [here](https://supabase-community.github.io/postgrest-csharp/api/Postgrest.html).
 
 Postgrest-csharp is written primarily as a helper library for [supabase/supabase-csharp](https://github.com/supabase/supabase-csharp), however, it should be easy enough to use outside of the supabase ecosystem.