Add TypeScript definitions via pg-to-ts and refactor migrations

2025-11-22 10:51:36 +01:00 · 2024-09-10 17:29:57 +02:00
parent 8121be1d96
commit c5fbcdc8bd
50 changed files with 1525 additions and 1632 deletions
--- a/web-app/src/routes/(anonymous)/login/+page.server.ts
+++ b/web-app/src/routes/(anonymous)/login/+page.server.ts
@@ -10,7 +10,7 @@ export const actions: Actions = {
      headers: { "Content-Type": "application/json" },
      body: JSON.stringify({
        username: data.get("username"),
-        password: data.get("password")
+        pass: data.get("password")
      })
    });

--- a/web-app/src/routes/(anonymous)/register/+page.server.ts
+++ b/web-app/src/routes/(anonymous)/register/+page.server.ts
@@ -10,7 +10,7 @@ export const actions: Actions = {
      headers: { "Content-Type": "application/json" },
      body: JSON.stringify({
        username: data.get("username"),
-        password: data.get("password")
+        pass: data.get("password")
      })
    });

--- a/web-app/src/routes/(authenticated)/+page.server.ts
+++ b/web-app/src/routes/(authenticated)/+page.server.ts
@@ -2,6 +2,7 @@ import type { Actions, PageServerLoad } from "./$types";
 import { API_BASE_PREFIX } from "$lib/server/utils";
 import { rm } from "node:fs/promises";
 import { join } from "node:path";
+import type { Website, WebsiteInput } from "$lib/db-schema";

 export const load: PageServerLoad = async ({ fetch, cookies, url, locals }) => {
  const searchQuery = url.searchParams.get("website_search_query");
@@ -47,7 +48,7 @@ export const load: PageServerLoad = async ({ fetch, cookies, url, locals }) => {
    }
  });

-  const websites = await websiteData.json();
+  const websites: Website[] = await websiteData.json();

  return {
    totalWebsiteCount,
@@ -66,9 +67,9 @@ export const actions: Actions = {
        Authorization: `Bearer ${cookies.get("session_token")}`
      },
      body: JSON.stringify({
-        content_type: data.get("content-type"),
-        title: data.get("title")
-      })
+        content_type: data.get("content-type") as string,
+        title: data.get("title") as string
+      } satisfies WebsiteInput)
    });

    if (!res.ok) {
--- a/web-app/src/routes/(authenticated)/account/+page.server.ts
+++ b/web-app/src/routes/(authenticated)/account/+page.server.ts
@@ -23,7 +23,7 @@ export const actions: Actions = {
        Authorization: `Bearer ${cookies.get("session_token")}`
      },
      body: JSON.stringify({
-        password: data.get("password")
+        pass: data.get("password")
      })
    });

--- a/web-app/src/routes/(authenticated)/website/[websiteId]/+layout.server.ts
+++ b/web-app/src/routes/(authenticated)/website/[websiteId]/+layout.server.ts
@@ -1,6 +1,7 @@
 import type { LayoutServerLoad } from "./$types";
 import { API_BASE_PREFIX } from "$lib/server/utils";
 import { error } from "@sveltejs/kit";
+import type { Website, Home } from "$lib/db-schema";

 export const load: LayoutServerLoad = async ({ params, fetch, cookies }) => {
  const websiteData = await fetch(`${API_BASE_PREFIX}/website?id=eq.${params.websiteId}`, {
@@ -25,8 +26,8 @@ export const load: LayoutServerLoad = async ({ params, fetch, cookies }) => {
    }
  });

-  const website = await websiteData.json();
-  const home = await homeData.json();
+  const website: Website = await websiteData.json();
+  const home: Home = await homeData.json();

  return {
    website,
--- a/web-app/src/routes/(authenticated)/website/[websiteId]/+page.server.ts
+++ b/web-app/src/routes/(authenticated)/website/[websiteId]/+page.server.ts
@@ -1,5 +1,6 @@
 import type { Actions, PageServerLoad } from "./$types";
 import { API_BASE_PREFIX } from "$lib/server/utils";
+import type { Settings, Header, Footer } from "$lib/db-schema";

 export const load: PageServerLoad = async ({ params, fetch, cookies }) => {
  const globalSettingsData = await fetch(
@@ -32,9 +33,9 @@ export const load: PageServerLoad = async ({ params, fetch, cookies }) => {
    }
  });

-  const globalSettings = await globalSettingsData.json();
-  const header = await headerData.json();
-  const footer = await footerData.json();
+  const globalSettings: Settings = await globalSettingsData.json();
+  const header: Header = await headerData.json();
+  const footer: Footer = await footerData.json();

  return {
    globalSettings,
--- a/web-app/src/routes/(authenticated)/website/[websiteId]/articles/+page.server.ts
+++ b/web-app/src/routes/(authenticated)/website/[websiteId]/articles/+page.server.ts
@@ -1,5 +1,6 @@
 import type { Actions, PageServerLoad } from "./$types";
 import { API_BASE_PREFIX } from "$lib/server/utils";
+import type { Article, ArticleInput, DocsCategory } from "$lib/db-schema";

 export const load: PageServerLoad = async ({ params, fetch, cookies, url, parent, locals }) => {
  const searchQuery = url.searchParams.get("article_search_query");
@@ -54,7 +55,7 @@ export const load: PageServerLoad = async ({ params, fetch, cookies, url, parent
    }
  });

-  const articles = await articlesData.json();
+  const articles: (Article & { docs_category: DocsCategory | null })[] = await articlesData.json();

  return {
    totalArticleCount,
@@ -76,8 +77,8 @@ export const actions: Actions = {
      },
      body: JSON.stringify({
        website_id: params.websiteId,
-        title: data.get("title")
-      })
+        title: data.get("title") as string
+      } satisfies ArticleInput)
    });

    if (!res.ok) {
--- a/web-app/src/routes/(authenticated)/website/[websiteId]/articles/[articleId]/+page.server.ts
+++ b/web-app/src/routes/(authenticated)/website/[websiteId]/articles/[articleId]/+page.server.ts
@@ -1,5 +1,6 @@
 import type { Actions, PageServerLoad } from "./$types";
 import { API_BASE_PREFIX } from "$lib/server/utils";
+import type { Article, DocsCategory } from "$lib/db-schema";

 export const load: PageServerLoad = async ({ parent, params, cookies, fetch }) => {
  const articleData = await fetch(`${API_BASE_PREFIX}/article?id=eq.${params.articleId}`, {
@@ -22,8 +23,8 @@ export const load: PageServerLoad = async ({ parent, params, cookies, fetch }) =
    }
  );

-  const article = await articleData.json();
-  const categories = await categoryData.json();
+  const article: Article = await articleData.json();
+  const categories: DocsCategory[] = await categoryData.json();
  const { website } = await parent();

  return { website, article, categories, API_BASE_PREFIX };
--- a/web-app/src/routes/(authenticated)/website/[websiteId]/categories/+page.server.ts
+++ b/web-app/src/routes/(authenticated)/website/[websiteId]/categories/+page.server.ts
@@ -1,5 +1,6 @@
 import type { Actions, PageServerLoad } from "./$types";
 import { API_BASE_PREFIX } from "$lib/server/utils";
+import type { DocsCategory, DocsCategoryInput } from "$lib/db-schema";

 export const load: PageServerLoad = async ({ parent, params, cookies, fetch }) => {
  const categoryData = await fetch(
@@ -13,7 +14,7 @@ export const load: PageServerLoad = async ({ parent, params, cookies, fetch }) =
    }
  );

-  const categories = await categoryData.json();
+  const categories: DocsCategory[] = await categoryData.json();
  const { website, home } = await parent();

  return {
@@ -35,9 +36,9 @@ export const actions: Actions = {
      },
      body: JSON.stringify({
        website_id: params.websiteId,
-        category_name: data.get("category-name"),
-        category_weight: data.get("category-weight")
-      })
+        category_name: data.get("category-name") as string,
+        category_weight: data.get("category-weight") as unknown as number
+      } satisfies DocsCategoryInput)
    });

    if (!res.ok) {
--- a/web-app/src/routes/(authenticated)/website/[websiteId]/collaborators/+page.server.ts
+++ b/web-app/src/routes/(authenticated)/website/[websiteId]/collaborators/+page.server.ts
@@ -1,5 +1,6 @@
 import type { Actions, PageServerLoad } from "./$types";
 import { API_BASE_PREFIX } from "$lib/server/utils";
+import type { Collab, CollabInput, User } from "$lib/db-schema";

 export const load: PageServerLoad = async ({ parent, params, fetch, cookies }) => {
  const { website, home } = await parent();
@@ -15,7 +16,7 @@ export const load: PageServerLoad = async ({ parent, params, fetch, cookies }) =
    }
  );

-  const collaborators = await collabData.json();
+  const collaborators: (Collab & { user: User })[] = await collabData.json();

  return {
    website,
@@ -37,6 +38,8 @@ export const actions: Actions = {
      }
    });

+    const user: User = await userData.json();
+
    const res = await fetch(`${API_BASE_PREFIX}/collab`, {
      method: "POST",
      headers: {
@@ -45,9 +48,9 @@ export const actions: Actions = {
      },
      body: JSON.stringify({
        website_id: params.websiteId,
-        user_id: (await userData.json()).id,
-        permission_level: data.get("permission-level")
-      })
+        user_id: user.id,
+        permission_level: data.get("permission-level") as unknown as number
+      } satisfies CollabInput)
    });

    if (!res.ok) {
--- a/web-app/src/routes/(authenticated)/website/[websiteId]/legal-information/+page.server.ts
+++ b/web-app/src/routes/(authenticated)/website/[websiteId]/legal-information/+page.server.ts
@@ -2,6 +2,7 @@ import type { Actions, PageServerLoad } from "./$types";
 import { API_BASE_PREFIX } from "$lib/server/utils";
 import { rm } from "node:fs/promises";
 import { join } from "node:path";
+import type { LegalInformation, LegalInformationInput } from "$lib/db-schema";

 export const load: PageServerLoad = async ({ parent, fetch, params, cookies }) => {
  const legalInformationData = await fetch(
@@ -16,7 +17,7 @@ export const load: PageServerLoad = async ({ parent, fetch, params, cookies }) =
    }
  );

-  const legalInformation = legalInformationData.ok ? await legalInformationData.json() : null;
+  const legalInformation: LegalInformation = await legalInformationData.json();
  const { website } = await parent();

  return {
@@ -39,8 +40,8 @@ export const actions: Actions = {
      },
      body: JSON.stringify({
        website_id: params.websiteId,
-        main_content: data.get("main-content")
-      })
+        main_content: data.get("main-content") as string
+      } satisfies LegalInformationInput)
    });

    if (!res.ok) {
--- a/web-app/src/routes/(authenticated)/website/[websiteId]/legal-information/+page.svelte
+++ b/web-app/src/routes/(authenticated)/website/[websiteId]/legal-information/+page.svelte
@@ -8,7 +8,7 @@

  const { data, form }: { data: PageServerData; form: ActionData } = $props();

-  let previewContent = $state(data.legalInformation?.main_content);
+  let previewContent = $state(data.legalInformation.main_content);
  let mainContentTextarea: HTMLTextAreaElement;
  let textareaScrollTop = $state(0);

@@ -80,14 +80,14 @@
          bind:value={previewContent}
          bind:this={mainContentTextarea}
          onscroll={updateScrollPercentage}
-          required>{data.legalInformation?.main_content ?? ""}</textarea
+          required>{data.legalInformation.main_content ?? ""}</textarea
        >
      </label>

      <button type="submit">Submit</button>
    </form>

-    {#if data.legalInformation?.main_content}
+    {#if data.legalInformation.main_content}
      <Modal id="delete-legal-information" text="Delete">
        <form
          action="?/deleteLegalInformation"
@@ -98,7 +98,6 @@
              await update();
              window.location.hash = "!";
              sending = false;
-              previewContent = null;
            };
          }}
        >
--- a/web-app/src/routes/(authenticated)/website/[websiteId]/publish/+page.server.ts
+++ b/web-app/src/routes/(authenticated)/website/[websiteId]/publish/+page.server.ts
@@ -1,6 +1,6 @@
 import { readFile, mkdir, writeFile } from "node:fs/promises";
 import { join } from "node:path";
-import { md } from "$lib/utils";
+import { type WebsiteOverview } from "$lib/utils";
 import type { Actions, PageServerLoad } from "./$types";
 import { API_BASE_PREFIX } from "$lib/server/utils";
 import { render } from "svelte/server";
@@ -10,34 +10,9 @@ import DocsIndex from "$lib/templates/docs/DocsIndex.svelte";
 import DocsArticle from "$lib/templates/docs/DocsArticle.svelte";
 import { dev } from "$app/environment";

-interface WebsiteData {
-  id: string;
-  content_type: "Blog" | "Docs";
-  favicon_image: string | null;
-  title: string;
-  logo_type: "text" | "image";
-  logo_text: string | null;
-  logo_image: string | null;
-  main_content: string;
-  additional_text: string;
-  accent_color_light_theme: string;
-  accent_color_dark_theme: string;
-  articles: {
-    cover_image: string | null;
-    title: string;
-    publication_date: string;
-    meta_description: string;
-    main_content: string;
-  }[];
-  categorized_articles: {
-    [key: string]: { title: string; publication_date: string; meta_description: string }[];
-  };
-  legal_information_main_content: string | null;
-}
-
-export const load: PageServerLoad = async ({ params, fetch, cookies, parent }) => {
+export const load: PageServerLoad = async ({ params, fetch, cookies }) => {
  const websiteOverviewData = await fetch(
-    `${API_BASE_PREFIX}/website_overview?id=eq.${params.websiteId}`,
+    `${API_BASE_PREFIX}/website?id=eq.${params.websiteId}&select=*,settings(*),header(*),home(*),footer(*),article(*,docs_category(*)),legal_information(*)`,
    {
      method: "GET",
      headers: {
@@ -48,8 +23,7 @@ export const load: PageServerLoad = async ({ params, fetch, cookies, parent }) =
    }
  );

-  const websiteOverview = await websiteOverviewData.json();
-  const { website } = await parent();
+  const websiteOverview: WebsiteOverview = await websiteOverviewData.json();

  generateStaticFiles(websiteOverview);

@@ -70,15 +44,14 @@ export const load: PageServerLoad = async ({ params, fetch, cookies, parent }) =
  return {
    websiteOverview,
    websitePreviewUrl,
-    websiteProdUrl,
-    website
+    websiteProdUrl
  };
 };

 export const actions: Actions = {
  publishWebsite: async ({ fetch, params, cookies }) => {
    const websiteOverviewData = await fetch(
-      `${API_BASE_PREFIX}/website_overview?id=eq.${params.websiteId}`,
+      `${API_BASE_PREFIX}/website?id=eq.${params.websiteId}&select=*,settings(*),header(*),home(*),footer(*),article(*,docs_category(*)),legal_information(*)`,
      {
        method: "GET",
        headers: {
@@ -112,54 +85,9 @@ export const actions: Actions = {
  }
 };

-const generateStaticFiles = async (websiteData: WebsiteData, isPreview: boolean = true) => {
-  let head = "";
-  let body = "";
-
-  switch (websiteData.content_type) {
-    case "Blog":
-      {
-        ({ head, body } = render(BlogIndex, {
-          props: {
-            favicon: websiteData.favicon_image
-              ? `${API_BASE_PREFIX}/rpc/retrieve_file?id=${websiteData.favicon_image}`
-              : "",
-            title: websiteData.title,
-            logoType: websiteData.logo_type,
-            logo:
-              websiteData.logo_type === "text"
-                ? (websiteData.logo_text ?? "")
-                : `${API_BASE_PREFIX}/rpc/retrieve_file?id=${websiteData.logo_image}`,
-            mainContent: md(websiteData.main_content ?? "", false),
-            articles: websiteData.articles ?? [],
-            footerAdditionalText: md(websiteData.additional_text ?? "")
-          }
-        }));
-      }
-      break;
-    case "Docs":
-      {
-        ({ head, body } = render(DocsIndex, {
-          props: {
-            favicon: websiteData.favicon_image
-              ? `${API_BASE_PREFIX}/rpc/retrieve_file?id=${websiteData.favicon_image}`
-              : "",
-            title: websiteData.title,
-            logoType: websiteData.logo_type,
-            logo:
-              websiteData.logo_type === "text"
-                ? (websiteData.logo_text ?? "")
-                : `${API_BASE_PREFIX}/rpc/retrieve_file?id=${websiteData.logo_image}`,
-            mainContent: md(websiteData.main_content ?? "", false),
-            categorizedArticles: websiteData.categorized_articles ?? [],
-            footerAdditionalText: md(websiteData.additional_text ?? "")
-          }
-        }));
-      }
-      break;
-  }
-
-  const indexFileContents = `
+const generateStaticFiles = async (websiteData: WebsiteOverview, isPreview: boolean = true) => {
+  const fileContents = (head: string, body: string) => {
+    return `
 <!DOCTYPE html>
 <html lang="en">
  <head>
@@ -169,6 +97,15 @@ const generateStaticFiles = async (websiteData: WebsiteData, isPreview: boolean
    ${body}
  </body>
 </html>`;
+  };
+
+  const { head, body } = render(websiteData.content_type === "Blog" ? BlogIndex : DocsIndex, {
+    props: {
+      websiteOverview: websiteData,
+      apiUrl: API_BASE_PREFIX,
+      isLegalPage: false
+    }
+  });

  let uploadDir = "";

@@ -179,138 +116,38 @@ const generateStaticFiles = async (websiteData: WebsiteData, isPreview: boolean
  }

  await mkdir(uploadDir, { recursive: true });
-  await writeFile(join(uploadDir, "index.html"), indexFileContents);
+  await writeFile(join(uploadDir, "index.html"), fileContents(head, body));
  await mkdir(join(uploadDir, "articles"), {
    recursive: true
  });

-  for (const article of websiteData.articles ?? []) {
+  for (const article of websiteData.article ?? []) {
    const articleFileName = article.title.toLowerCase().split(" ").join("-");

-    let head = "";
-    let body = "";
+    const { head, body } = render(websiteData.content_type === "Blog" ? BlogArticle : DocsArticle, {
+      props: {
+        websiteOverview: websiteData,
+        article,
+        apiUrl: API_BASE_PREFIX
+      }
+    });

-    switch (websiteData.content_type) {
-      case "Blog":
-        {
-          ({ head, body } = render(BlogArticle, {
-            props: {
-              favicon: websiteData.favicon_image
-                ? `${API_BASE_PREFIX}/rpc/retrieve_file?id=${websiteData.favicon_image}`
-                : "",
-              title: article.title,
-              logoType: websiteData.logo_type,
-              logo:
-                websiteData.logo_type === "text"
-                  ? (websiteData.logo_text ?? "")
-                  : `${API_BASE_PREFIX}/rpc/retrieve_file?id=${websiteData.logo_image}`,
-              coverImage: article.cover_image
-                ? `${API_BASE_PREFIX}/rpc/retrieve_file?id=${article.cover_image}`
-                : "",
-              publicationDate: article.publication_date,
-              mainContent: md(article.main_content ?? ""),
-              footerAdditionalText: md(websiteData.additional_text ?? ""),
-              metaDescription: article.meta_description
-            }
-          }));
-        }
-        break;
-      case "Docs":
-        {
-          ({ head, body } = render(DocsArticle, {
-            props: {
-              favicon: websiteData.favicon_image
-                ? `${API_BASE_PREFIX}/rpc/retrieve_file?id=${websiteData.favicon_image}`
-                : "",
-              title: article.title,
-              logoType: websiteData.logo_type,
-              logo:
-                websiteData.logo_type === "text"
-                  ? (websiteData.logo_text ?? "")
-                  : `${API_BASE_PREFIX}/rpc/retrieve_file?id=${websiteData.logo_image}`,
-              mainContent: md(article.main_content ?? ""),
-              categorizedArticles: websiteData.categorized_articles ?? [],
-              footerAdditionalText: md(websiteData.additional_text ?? ""),
-              metaDescription: article.meta_description
-            }
-          }));
-        }
-        break;
-    }
-
-    const articleFileContents = `
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    ${head}
-  </head>
-  <body>
-    ${body}
-  </body>
-</html>`;
-
-    await writeFile(join(uploadDir, "articles", `${articleFileName}.html`), articleFileContents);
+    await writeFile(
+      join(uploadDir, "articles", `${articleFileName}.html`),
+      fileContents(head, body)
+    );
  }

-  if (websiteData.legal_information_main_content) {
-    let head = "";
-    let body = "";
+  if (websiteData.legal_information) {
+    const { head, body } = render(websiteData.content_type === "Blog" ? BlogIndex : DocsIndex, {
+      props: {
+        websiteOverview: websiteData,
+        apiUrl: API_BASE_PREFIX,
+        isLegalPage: true
+      }
+    });

-    switch (websiteData.content_type) {
-      case "Blog":
-        {
-          ({ head, body } = render(BlogIndex, {
-            props: {
-              favicon: websiteData.favicon_image
-                ? `${API_BASE_PREFIX}/rpc/retrieve_file?id=${websiteData.favicon_image}`
-                : "",
-              title: "Legal information",
-              logoType: websiteData.logo_type,
-              logo:
-                websiteData.logo_type === "text"
-                  ? (websiteData.logo_text ?? "")
-                  : `${API_BASE_PREFIX}/rpc/retrieve_file?id=${websiteData.logo_image}`,
-              mainContent: md(websiteData.legal_information_main_content ?? "", false),
-              articles: [],
-              footerAdditionalText: md(websiteData.additional_text ?? "")
-            }
-          }));
-        }
-        break;
-      case "Docs":
-        {
-          ({ head, body } = render(DocsIndex, {
-            props: {
-              favicon: websiteData.favicon_image
-                ? `${API_BASE_PREFIX}/rpc/retrieve_file?id=${websiteData.favicon_image}`
-                : "",
-              title: "Legal information",
-              logoType: websiteData.logo_type,
-              logo:
-                websiteData.logo_type === "text"
-                  ? (websiteData.logo_text ?? "")
-                  : `${API_BASE_PREFIX}/rpc/retrieve_file?id=${websiteData.logo_image}`,
-              mainContent: md(websiteData.legal_information_main_content ?? "", false),
-              categorizedArticles: {},
-              footerAdditionalText: md(websiteData.additional_text ?? "")
-            }
-          }));
-        }
-        break;
-    }
-
-    const legalInformationFileContents = `
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    ${head}
-  </head>
-  <body>
-    ${body}
-  </body>
-</html>`;
-
-    await writeFile(join(uploadDir, "legal-information.html"), legalInformationFileContents);
+    await writeFile(join(uploadDir, "legal-information.html"), fileContents(head, body));
  }

  const commonStyles = await readFile(`${process.cwd()}/template-styles/common-styles.css`, {
@@ -328,14 +165,14 @@ const generateStaticFiles = async (websiteData: WebsiteData, isPreview: boolean
      .concat(specificStyles)
      .replace(
        /--color-accent:\s*(.*?);/,
-        `--color-accent: ${websiteData.accent_color_dark_theme};`
+        `--color-accent: ${websiteData.settings.accent_color_dark_theme};`
      )
      .replace(
        /@media\s*\(prefers-color-scheme:\s*dark\)\s*{[^}]*--color-accent:\s*(.*?);/,
        (match) =>
          match.replace(
            /--color-accent:\s*(.*?);/,
-            `--color-accent: ${websiteData.accent_color_light_theme};`
+            `--color-accent: ${websiteData.settings.accent_color_light_theme};`
          )
      )
  );
--- a/web-app/src/routes/(authenticated)/website/[websiteId]/publish/+page.svelte
+++ b/web-app/src/routes/(authenticated)/website/[websiteId]/publish/+page.svelte
@@ -17,9 +17,9 @@
 {/if}

 <WebsiteEditor
-  id={data.website.id}
-  contentType={data.website.content_type}
-  title={data.website.title}
+  id={data.websiteOverview.id}
+  contentType={data.websiteOverview.content_type}
+  title={data.websiteOverview.title}
  previewContent={data.websitePreviewUrl}
  fullPreview={true}
 >
@@ -46,7 +46,7 @@
      <button type="submit">Publish</button>
    </form>

-    {#if data.website.is_published}
+    {#if data.websiteOverview.is_published}
      <section id="publication-status">
        <h3>
          <a href="#publication-status">Publication status</a>