Add Twitch v5 deprecation notice

awsr · Jul 16, 2021 · ff60ebc · ff60ebc
1 parent f7872ca
commit ff60ebc
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 2 deletions.
diff --git a/Module/StreamXRef.psd1 b/Module/StreamXRef.psd1
@@ -6,7 +6,7 @@
 
     CompanyName = 'Alex Wiser'
 
-    ModuleVersion = '3.4.0'
+    ModuleVersion = '3.4.1'
 
     GUID = '8c89ef10-5110-4406-a876-82b8eadf5bb2'
 
@@ -41,6 +41,11 @@
             IconUri = 'https://raw.githubusercontent.com/awsr/PS-StreamXRef/master/sxr.png'
 
             ReleaseNotes = @'
+## 3.4.1
+
+* Added deprecation warning due to Twitch shutting down the v5 API in February, 2022.
+* Added error message if module is run after this date
+
 ## 3.4.0
 
 * Future-proofing by assuming Twitch will use 64-bit integers after running out of 32-bit integers for video ids.

diff --git a/Module/StreamXRef.psm1 b/Module/StreamXRef.psm1
@@ -1,5 +1,13 @@
 Set-StrictMode -Version 3
 
+# Deprecation error/warning due to Twitch shutting down v5 API at the end of February, 2022
+if ([datetime]::UtcNow -ge [datetime]::new(2022, 3, 1)) {
+    Write-Error "Twitch v5 API has been shut down. Upgrade module, if available, or uninstall."
+}
+else {
+    Write-Warning "Twitch v5 API will be shut down by the end of February, 2022."
+}
+
 # Add type data
 Add-Type -Path "$PSScriptRoot/typedata/StreamXRefTypes.dll"
 

diff --git a/src/StreamXRef.psd1 b/src/StreamXRef.psd1
@@ -6,7 +6,7 @@
 
     CompanyName = 'Alex Wiser'
 
-    ModuleVersion = '3.4.0'
+    ModuleVersion = '3.4.1'
 
     GUID = '8c89ef10-5110-4406-a876-82b8eadf5bb2'
 
@@ -41,6 +41,11 @@
             IconUri = 'https://raw.githubusercontent.com/awsr/PS-StreamXRef/master/sxr.png'
 
             ReleaseNotes = @'
+## 3.4.1
+
+* Added deprecation warning due to Twitch shutting down the v5 API in February, 2022.
+* Added error message if module is run after this date
+
 ## 3.4.0
 
 * Future-proofing by assuming Twitch will use 64-bit integers after running out of 32-bit integers for video ids.

diff --git a/src/StreamXRef.psm1 b/src/StreamXRef.psm1
@@ -1,5 +1,13 @@
 Set-StrictMode -Version 3
 
+# Deprecation error/warning due to Twitch shutting down v5 API at the end of February, 2022
+if ([datetime]::UtcNow -ge [datetime]::new(2022, 3, 1)) {
+    Write-Error "Twitch v5 API has been shut down. Upgrade module, if available, or uninstall."
+}
+else {
+    Write-Warning "Twitch v5 API will be shut down by the end of February, 2022."
+}
+
 # Add type data
 Add-Type -Path "$PSScriptRoot/typedata/StreamXRefTypes.dll"