Feature: Add Release Notes (#491)

Co-authored-by: Vijay A <vraravam@users.noreply.github.com>
Co-authored-by: Ricardo Cino <ricardo@cino.io>

1 files changed, 65 insertions, 0 deletions

diff --git a/src/helpers/update-helpers.ts b/src/helpers/update-helpers.ts
new file mode 100644
index 000000000..daeef5413
--- /dev/null
+++ b/src/helpers/update-helpers.ts
@@ -0,0 +1,65 @@
+import { Octokit } from '@octokit/core';
+import { defineMessages, IntlShape } from 'react-intl';
+
+export function getFerdiumVersion(
+  currentLocation: string,
+  ferdiumVersion: string,
+): string {
+  const matches = currentLocation?.match(/version=([^&]*)/);
+  if (matches !== null) {
+    return `v${matches[1]}`;
+  }
+  return `v${ferdiumVersion}`;
+}
+
+export function updateVersionParse(updateVersion: string): string {
+  return updateVersion !== '' ? `?version=${updateVersion}` : '';
+}
+
+export function onAuthGoToReleaseNotes(
+  currentLocation: string,
+  updateVersionParsed: string = '',
+): string {
+  return currentLocation.includes('#/auth')
+    ? `#/auth/releasenotes${updateVersionParsed}`
+    : `#/releasenotes${updateVersionParsed}`;
+}
+
+const messages = defineMessages({
+  connectionError: {
+    id: 'settings.releasenotes.connectionError',
+    defaultMessage:
+      'An error occured when connecting to Github, please try again later.',
+  },
+  connectionErrorPageMissing: {
+    id: 'settings.releasenotes.connectionErrorPageMissing',
+    defaultMessage:
+      'An error occured when connecting to Github, the page you are looking for is missing.',
+  },
+});
+
+export async function getUpdateInfoFromGH(
+  currentLocation: string,
+  ferdiumVersion: string,
+  intl: IntlShape,
+): Promise<string> {
+  const octokit = new Octokit();
+  try {
+    const response = await octokit.request(
+      'GET /repos/{owner}/{repo}/releases/tags/{tag}',
+      {
+        owner: 'ferdium',
+        repo: 'ferdium-app',
+        tag: getFerdiumVersion(currentLocation, ferdiumVersion),
+      },
+    );
+
+    if (response.status === 200) {
+      const json = response.data.body;
+      return json || `### ${intl.formatMessage(messages.connectionError)}`;
+    }
+    return `### ${intl.formatMessage(messages.connectionError)}`;
+  } catch {
+    return `### ${intl.formatMessage(messages.connectionErrorPageMissing)}`;
+  }
+}