Files
api/web/store/updateOsChangelog.ts
2024-01-31 11:02:37 -08:00

130 lines
4.4 KiB
TypeScript

import { marked } from 'marked';
import { baseUrl } from 'marked-base-url';
import { defineStore } from 'pinia';
import prerelease from 'semver/functions/prerelease';
import { computed, ref, watch } from 'vue';
import { DOCS_RELEASE_NOTES } from '~/helpers/urls';
import { request } from '~/composables/services/request';
import { useCallbackStore } from '~/store/callbackActions';
// import { useServerStore } from '~/store/server';
import type { ServerUpdateOsResponse } from '~/types/server';
export const useUpdateOsChangelogStore = defineStore('updateOsChangelog', () => {
const callbackStore = useCallbackStore();
// const serverStore = useServerStore();
// const osVersionBranch = computed(() => serverStore.osVersionBranch);
const releaseForUpdate = ref<ServerUpdateOsResponse | null>(null);
watch(releaseForUpdate, async (newVal, oldVal) => {
console.debug('[releaseForUpdate] watch', newVal, oldVal);
resetChangelogDetails(); // reset values when setting and unsetting a selected release
// Fetch and parse the changelog when the user selects a release
if (newVal) {
await fetchAndParseChangelog();
}
});
const changelogUrl = computed((): string => {
if (!releaseForUpdate.value || !releaseForUpdate.value?.changelog) {
return '';
}
return releaseForUpdate.value?.changelog ?? `https://raw.githubusercontent.com/unraid/docs/main/docs/unraid-os/release-notes/${releaseForUpdate.value.version}.md`;
});
const isReleaseForUpdateStable = computed(() => releaseForUpdate.value ? prerelease(releaseForUpdate.value.version) === null : false);
const parsedChangelog = ref<string>('');
const parseChangelogFailed = ref<string>('');
// used to remove the first <h1></h1> and it's contents from the parsedChangelog
const mutatedParsedChangelog = computed(() => {
if (parsedChangelog.value) {
return parsedChangelog.value.replace(/<h1>(.*?)<\/h1>/, '');
}
return parsedChangelog.value;
});
// used to extract the first <h1></h1> and it's contents from the parsedChangelog for the modal header title
const parsedChangelogTitle = computed(() => {
if (parseChangelogFailed.value) {
return parseChangelogFailed.value;
}
if (parsedChangelog.value) {
return parsedChangelog.value.match(/<h1>(.*?)<\/h1>/)?.[1] ?? `Version ${releaseForUpdate.value?.version} ${releaseForUpdate.value?.date}`;
}
return '';
});
const setReleaseForUpdate = (release: ServerUpdateOsResponse | null) => {
console.debug('[setReleaseForUpdate]', release);
releaseForUpdate.value = release;
};
const resetChangelogDetails = () => {
console.debug('[resetChangelogDetails]');
parsedChangelog.value = '';
parseChangelogFailed.value = '';
};
const fetchAndParseChangelog = async () => {
console.debug('[fetchAndParseChangelog]');
try {
const changelogMarkdownRaw = await request
.url(changelogUrl.value ?? '')
.get()
.text();
// set base url for relative links
marked.use(baseUrl(DOCS_RELEASE_NOTES.toString()));
// open links in new tab & replace .md from links
const renderer = new marked.Renderer();
const anchorRender = {
options: {
sanitize: true,
},
render: marked.Renderer.prototype.link
};
renderer.link = function (href, title, text) {
const anchor = anchorRender.render(href, title, text);
return anchor
.replace('<a', '<a target=\'_blank\' ') // open links in new tab
.replace('.md', ''); // remove .md from links
};
marked.setOptions({
renderer
});
parsedChangelog.value = await marked.parse(changelogMarkdownRaw);
} catch (error: unknown) {
const caughtError = error as Error;
parseChangelogFailed.value =
caughtError && caughtError?.message
? caughtError.message
: `Failed to parse ${releaseForUpdate.value?.version} changelog`;
}
};
const fetchAndConfirmInstall = (sha256: string) => {
callbackStore.send(
window.location.href,
[{
sha256,
type: 'updateOs',
}],
undefined,
'forUpc',
);
};
return {
// state
parseChangelogFailed,
releaseForUpdate,
// getters
isReleaseForUpdateStable,
mutatedParsedChangelog,
parsedChangelogTitle,
// actions
setReleaseForUpdate,
fetchAndConfirmInstall,
};
});