feat: ✨ Live Preview 2.0 Implementation

.github/workflows/check-branch.yml

@@ -12,9 +12,9 @@ jobs:
         uses: thollander/actions-comment-pull-request@v2
         with:
           message: |
-            We regret to inform you that you are currently not able to merge your changes into the master branch due to restrictions applied by our SRE team. To proceed with merging your changes, we kindly request that you create a pull request from the next branch. Our team will then review the changes and work with you to ensure a successful merge into the master branch.
+            We regret to inform you that you are currently not able to merge your changes into the master branch due to restrictions applied by our SRE team. To proceed with merging your changes, we kindly request that you create a pull request from the staging branch. Our team will then review the changes and work with you to ensure a successful merge into the master branch.
       - name: Check branch
-        if: github.base_ref == 'master' && github.head_ref != 'next'
+        if: github.base_ref == 'master' && github.head_ref != 'staging'
         run: |
-          echo "ERROR: We regret to inform you that you are currently not able to merge your changes into the master branch due to restrictions applied by our SRE team. To proceed with merging your changes, we kindly request that you create a pull request from the next branch. Our team will then review the changes and work with you to ensure a successful merge into the master branch."
+          echo "ERROR: We regret to inform you that you are currently not able to merge your changes into the master branch due to restrictions applied by our SRE team. To proceed with merging your changes, we kindly request that you create a pull request from the staging branch. Our team will then review the changes and work with you to ensure a successful merge into the master branch."
           exit 1

CHANGELOG.md

@@ -1,6 +1,8 @@
-### Version: 2.15.1
-#### Date: Oct-08-2024
+### Version: 2.16.0
+#### Date: Oct-11-2024
 
+##### Feat: 
+- Live Preview 2.0 Implementation
 ##### Fix: 
 - Removed exclusion of env when adding headers
 

Contentstack.AspNetCore/Contentstack.AspNetCore.csproj

@@ -31,6 +31,6 @@
     <PackageReference Include="NuGet.Build.Packaging" Version="0.2.2"><PrivateAssets>all</PrivateAssets>
 <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
 </PackageReference>
-    <PackageReference Include="contentstack.csharp" Version="2.13.0" />
+    <PackageReference Include="contentstack.csharp" Version="2.15.0" />
   </ItemGroup>
 </Project>

Contentstack.Core/Configuration/LivePreviewConfig.cs

@@ -7,6 +7,7 @@ namespace Contentstack.Core.Configuration
     public class LivePreviewConfig
     {
         public string ManagementToken { get; set; }
+        public string PreviewToken { get; set; }
         public bool Enable { get; set; }
         public string Host { get; set; }
         internal string LivePreview { get; set; }

Contentstack.Core/ContentstackClient.cs

@@ -123,7 +123,16 @@ public ContentstackClient(IOptions<ContentstackOptions> options)
             }
             if (this.LivePreviewConfig.Host == null)
             {
-                this.LivePreviewConfig.Host = "api.contentstack.io";
+                if (this.LivePreviewConfig.ManagementToken != null)
+                {
+                    this.LivePreviewConfig.Host = "api.contentstack.io";
+                }
+                else if (this.LivePreviewConfig.PreviewToken != null)
+                {
+                    this.LivePreviewConfig.Host = "rest-preview.contentstack.com";
+                } else {
+                    throw new InvalidOperationException("Add PreviewToken or ManagementToken in LivePreviewConfig");
+                }
             }
             this.SerializerSettings.DateParseHandling = DateParseHandling.None;
             this.SerializerSettings.DateFormatHandling = DateFormatHandling.IsoDateFormat;
@@ -347,7 +356,14 @@ private async Task<JObject> GetLivePreviewData()
                 }
             }
             mainJson.Add("live_preview", this.LivePreviewConfig.LivePreview ?? "init");
-            headerAll["authorization"] = this.LivePreviewConfig.ManagementToken;
+
+            if (!string.IsNullOrEmpty(this.LivePreviewConfig.ManagementToken)) {
+                headerAll["authorization"] = this.LivePreviewConfig.ManagementToken;
+            } else if (!string.IsNullOrEmpty(this.LivePreviewConfig.PreviewToken)) {
+                headerAll["preview_token"] = this.LivePreviewConfig.PreviewToken;
+            } else {
+                throw new InvalidOperationException("Either ManagementToken or PreviewToken is required in LivePreviewConfig");
+            }
 
             try
             {

Contentstack.Core/Internals/HttpRequestHandler.cs

@@ -48,7 +48,7 @@ public async Task<string> ProcessRequest(string Url, Dictionary<string, object>
             var request = (HttpWebRequest)WebRequest.Create(uri);
             request.Method = "GET";
             request.ContentType = "application/json";
-            request.Headers["x-user-agent"]="contentstack-delivery-dotnet/2.12.0";
+            request.Headers["x-user-agent"]="contentstack-delivery-dotnet/2.16.0";
             request.Timeout = timeout;
 
             if (proxy != null)

Contentstack.Core/Models/Entry.cs

@@ -48,7 +48,7 @@ private string _Url
 
         internal Dictionary<string, object> _metadata = new Dictionary<string, object>();
         #endregion
-
+
         #region Public Properties
         /// <summary>
         /// Title of an entry
@@ -123,9 +123,9 @@ private string _Url
         ///     });
         /// </code>
         /// </example>
-        public Dictionary<string, object> _variant { get; set; }
-
-
+        public Dictionary<string, object> _variant { get; set; }
+
+
         /// <summary>
         /// Set key/value attributes of an current entry instance.
         /// </summary>
@@ -1393,7 +1393,15 @@ public async Task<T> Fetch<T>()
             if (this.ContentTypeInstance.StackInstance.LivePreviewConfig.Enable == true && this.ContentTypeInstance.StackInstance.LivePreviewConfig.ContentTypeUID == this.ContentTypeInstance.ContentTypeId)
             {
                 mainJson.Add("live_preview", this.ContentTypeInstance.StackInstance.LivePreviewConfig.LivePreview ?? "init");
-                headerAll["authorization"] = this.ContentTypeInstance.StackInstance.LivePreviewConfig.ManagementToken;
+
+                if (!string.IsNullOrEmpty(this.ContentTypeInstance.StackInstance.LivePreviewConfig.ManagementToken)) {
+                    headerAll["authorization"] = this.ContentTypeInstance.StackInstance.LivePreviewConfig.ManagementToken;
+                } else if (!string.IsNullOrEmpty(this.ContentTypeInstance.StackInstance.LivePreviewConfig.PreviewToken)) {
+                    headerAll["preview_token"] = this.ContentTypeInstance.StackInstance.LivePreviewConfig.PreviewToken;
+                } else {
+                    throw new InvalidOperationException("Either ManagementToken or PreviewToken is required in LivePreviewConfig");
+                }
+
                 isLivePreview = true;
             }
 

Contentstack.Core/Models/Query.cs

@@ -1848,7 +1848,15 @@ private async Task<JObject> Exec()
                 && this.ContentTypeInstance.StackInstance.LivePreviewConfig.ContentTypeUID == this.ContentTypeInstance.ContentTypeId)
             {
                 mainJson.Add("live_preview", this.ContentTypeInstance.StackInstance.LivePreviewConfig.LivePreview ?? "init");
-                headerAll["authorization"] = this.ContentTypeInstance.StackInstance.LivePreviewConfig.ManagementToken;
+
+                if (!string.IsNullOrEmpty(this.ContentTypeInstance.StackInstance.LivePreviewConfig.ManagementToken)) {
+                    headerAll["authorization"] = this.ContentTypeInstance.StackInstance.LivePreviewConfig.ManagementToken;
+                } else if (!string.IsNullOrEmpty(this.ContentTypeInstance.StackInstance.LivePreviewConfig.PreviewToken)) {
+                    headerAll["preview_token"] = this.ContentTypeInstance.StackInstance.LivePreviewConfig.PreviewToken;
+                } else {
+                    throw new InvalidOperationException("Either ManagementToken or PreviewToken is required in LivePreviewConfig");
+                }
+
                 isLivePreview = true;
             }
 

Directory.Build.props

@@ -1,5 +1,5 @@
 <Project>
   <PropertyGroup>
-    <Version>2.15.1</Version>
+    <Version>2.16.0</Version>
   </PropertyGroup>
 </Project>