;
+}
+
+const defaultClasses = "grid-stack grid-stack-empty min-row";
+
+export const BoardEmptySection = ({ section, mainRef }: Props) => {
+ const { refs } = useGridstack({ section, mainRef });
+ const [isEditMode] = useEditMode();
+
+ return (
+ 0 || isEditMode ? defaultClasses : `${defaultClasses} gridstack-empty-wrapper`}
+ style={{ transitionDuration: "0s" }}
+ data-empty
+ data-section-id={section.id}
+ ref={refs.wrapper}
+ >
+
+ );
+};
diff --git a/apps/nextjs/src/components/board/sections/gridstack/init-gridstack.ts b/apps/nextjs/src/components/board/sections/gridstack/init-gridstack.ts
new file mode 100644
index 000000000..84378fc7f
--- /dev/null
+++ b/apps/nextjs/src/components/board/sections/gridstack/init-gridstack.ts
@@ -0,0 +1,52 @@
+import type { MutableRefObject, RefObject } from "react";
+
+import type { GridItemHTMLElement } from "@homarr/gridstack";
+import { GridStack } from "@homarr/gridstack";
+
+import type { Section } from "~/app/[locale]/boards/_types";
+
+interface InitializeGridstackProps {
+ section: Section;
+ refs: {
+ wrapper: RefObject;
+ items: MutableRefObject>>;
+ gridstack: MutableRefObject;
+ };
+ sectionColumnCount: number;
+}
+
+export const initializeGridstack = ({ section, refs, sectionColumnCount }: InitializeGridstackProps) => {
+ if (!refs.wrapper.current) return false;
+ // initialize gridstack
+ const newGrid = refs.gridstack;
+ newGrid.current = GridStack.init(
+ {
+ column: sectionColumnCount,
+ margin: Math.round(Math.max(Math.min(refs.wrapper.current.offsetWidth / 100, 10), 1)),
+ cellHeight: 128,
+ float: true,
+ alwaysShowResizeHandle: true,
+ acceptWidgets: true,
+ staticGrid: true,
+ minRow: 1,
+ animate: false,
+ styleInHead: true,
+ disableRemoveNodeOnDrop: true,
+ },
+ // selector of the gridstack item (it's eather category or wrapper)
+ `.grid-stack-${section.kind}[data-section-id='${section.id}']`,
+ );
+ const grid = newGrid.current;
+ if (!grid) return false;
+ // Must be used to update the column count after the initialization
+ grid.column(sectionColumnCount, "none");
+
+ grid.batchUpdate();
+ grid.removeAll(false);
+ section.items.forEach(({ id }) => {
+ const ref = refs.items.current[id]?.current;
+ ref && grid.makeWidget(ref);
+ });
+ grid.batchUpdate(false);
+ return true;
+};
diff --git a/apps/nextjs/src/components/board/sections/gridstack/use-gridstack.ts b/apps/nextjs/src/components/board/sections/gridstack/use-gridstack.ts
new file mode 100644
index 000000000..aad587972
--- /dev/null
+++ b/apps/nextjs/src/components/board/sections/gridstack/use-gridstack.ts
@@ -0,0 +1,181 @@
+import type { MutableRefObject, RefObject } from "react";
+import { createRef, useCallback, useEffect, useMemo, useRef } from "react";
+
+import type { GridItemHTMLElement, GridStack, GridStackNode } from "@homarr/gridstack";
+
+import type { Section } from "~/app/[locale]/boards/_types";
+import { useEditMode, useMarkSectionAsReady, useRequiredBoard } from "~/app/[locale]/boards/(content)/_context";
+import { useItemActions } from "../../items/item-actions";
+import { initializeGridstack } from "./init-gridstack";
+
+export interface UseGridstackRefs {
+ wrapper: RefObject;
+ items: MutableRefObject>>;
+ gridstack: MutableRefObject;
+}
+
+interface UseGristackReturnType {
+ refs: UseGridstackRefs;
+}
+
+interface UseGridstackProps {
+ section: Section;
+ mainRef?: RefObject;
+}
+
+export const useGridstack = ({ section, mainRef }: UseGridstackProps): UseGristackReturnType => {
+ const [isEditMode] = useEditMode();
+ const markAsReady = useMarkSectionAsReady();
+ const { moveAndResizeItem, moveItemToSection } = useItemActions();
+ // define reference for wrapper - is used to calculate the width of the wrapper
+ const wrapperRef = useRef(null);
+ // references to the diffrent items contained in the gridstack
+ const itemRefs = useRef>>({});
+ // reference of the gridstack object for modifications after initialization
+ const gridRef = useRef();
+
+ useCssVariableConfiguration({ mainRef, gridRef });
+
+ const board = useRequiredBoard();
+
+ const items = useMemo(() => section.items, [section.items]);
+
+ // define items in itemRefs for easy access and reference to items
+ if (Object.keys(itemRefs.current).length !== items.length) {
+ items.forEach(({ id }: { id: keyof typeof itemRefs.current }) => {
+ itemRefs.current[id] = itemRefs.current[id] ?? createRef();
+ });
+ }
+
+ useEffect(() => {
+ gridRef.current?.setStatic(!isEditMode);
+ }, [isEditMode]);
+
+ const onChange = useCallback(
+ (changedNode: GridStackNode) => {
+ const itemId = changedNode.el?.getAttribute("data-id");
+ if (!itemId) return;
+
+ // Updates the react-query state
+ moveAndResizeItem({
+ itemId,
+ xOffset: changedNode.x!,
+ yOffset: changedNode.y!,
+ width: changedNode.w!,
+ height: changedNode.h!,
+ });
+ },
+ [moveAndResizeItem],
+ );
+ const onAdd = useCallback(
+ (addedNode: GridStackNode) => {
+ const itemId = addedNode.el?.getAttribute("data-id");
+ if (!itemId) return;
+
+ // Updates the react-query state
+ moveItemToSection({
+ itemId,
+ sectionId: section.id,
+ xOffset: addedNode.x!,
+ yOffset: addedNode.y!,
+ width: addedNode.w!,
+ height: addedNode.h!,
+ });
+ },
+ [moveItemToSection, section.id],
+ );
+
+ useEffect(() => {
+ if (!isEditMode) return;
+ const currentGrid = gridRef.current;
+ // Add listener for moving items around in a wrapper
+ currentGrid?.on("change", (_, nodes) => {
+ nodes.forEach(onChange);
+ });
+
+ // Add listener for moving items in config from one wrapper to another
+ currentGrid?.on("added", (_, nodes) => {
+ nodes.forEach(onAdd);
+ });
+
+ return () => {
+ currentGrid?.off("change");
+ currentGrid?.off("added");
+ };
+ }, [isEditMode, onAdd, onChange]);
+
+ // initialize the gridstack
+ useEffect(() => {
+ const isReady = initializeGridstack({
+ section,
+ refs: {
+ items: itemRefs,
+ wrapper: wrapperRef,
+ gridstack: gridRef,
+ },
+ sectionColumnCount: board.columnCount,
+ });
+
+ if (isReady) {
+ markAsReady(section.id);
+ }
+
+ // Only run this effect when the section items change
+ // eslint-disable-next-line react-hooks/exhaustive-deps
+ }, [items.length, section.items.length, board.columnCount]);
+
+ return {
+ refs: {
+ items: itemRefs,
+ wrapper: wrapperRef,
+ gridstack: gridRef,
+ },
+ };
+};
+
+interface UseCssVariableConfiguration {
+ mainRef?: RefObject;
+ gridRef: UseGridstackRefs["gridstack"];
+}
+
+/**
+ * This hook is used to configure the css variables for the gridstack
+ * Those css variables are used to define the size of the gridstack items
+ * @see gridstack.scss
+ * @param mainRef reference to the main div wrapping all sections
+ * @param gridRef reference to the gridstack object
+ */
+const useCssVariableConfiguration = ({ mainRef, gridRef }: UseCssVariableConfiguration) => {
+ const board = useRequiredBoard();
+
+ // Get reference to the :root element
+ const typeofDocument = typeof document;
+ const root = useMemo(() => {
+ if (typeofDocument === "undefined") return;
+ return document.documentElement;
+ }, [typeofDocument]);
+
+ // Define widget-width by calculating the width of one column with mainRef width and column count
+ useEffect(() => {
+ if (typeof document === "undefined") return;
+ const onResize = () => {
+ if (!mainRef?.current) return;
+ const widgetWidth = mainRef.current.clientWidth / board.columnCount;
+ // widget width is used to define sizes of gridstack items within global.scss
+ root?.style.setProperty("--gridstack-widget-width", widgetWidth.toString());
+ gridRef.current?.cellHeight(widgetWidth);
+ };
+ onResize();
+ if (typeof window === "undefined") return;
+ window.addEventListener("resize", onResize);
+ return () => {
+ if (typeof window === "undefined") return;
+ window.removeEventListener("resize", onResize);
+ };
+ }, [board.columnCount, mainRef, root, gridRef]);
+
+ // Define column count by using the sectionColumnCount
+ useEffect(() => {
+ root?.style.setProperty("--gridstack-column-count", board.columnCount.toString());
+ }, [board.columnCount, root]);
+};
diff --git a/apps/nextjs/src/components/board/sections/item.module.css b/apps/nextjs/src/components/board/sections/item.module.css
new file mode 100644
index 000000000..aacc4803e
--- /dev/null
+++ b/apps/nextjs/src/components/board/sections/item.module.css
@@ -0,0 +1,10 @@
+.itemCard {
+ @mixin dark {
+ background-color: rgba(46, 46, 46, var(--opacity));
+ border-color: rgba(66, 66, 66, var(--opacity));
+ }
+ @mixin light {
+ background-color: rgba(255, 255, 255, var(--opacity));
+ border-color: rgba(222, 226, 230, var(--opacity));
+ }
+}
diff --git a/apps/nextjs/src/components/icons/picker/icon-picker.tsx b/apps/nextjs/src/components/icons/picker/icon-picker.tsx
new file mode 100644
index 000000000..1406b20e5
--- /dev/null
+++ b/apps/nextjs/src/components/icons/picker/icon-picker.tsx
@@ -0,0 +1,110 @@
+import type { FocusEventHandler } from "react";
+import { useState } from "react";
+import { Combobox, Group, Image, InputBase, Skeleton, Text, useCombobox } from "@mantine/core";
+
+import { clientApi } from "@homarr/api/client";
+import { useScopedI18n } from "@homarr/translation/client";
+
+interface IconPickerProps {
+ initialValue?: string;
+ onChange: (iconUrl: string) => void;
+ error?: string | null;
+ onFocus?: FocusEventHandler;
+ onBlur?: FocusEventHandler;
+}
+
+export const IconPicker = ({ initialValue, onChange, error, onFocus, onBlur }: IconPickerProps) => {
+ const [value, setValue] = useState(initialValue ?? "");
+ const [search, setSearch] = useState(initialValue ?? "");
+
+ const t = useScopedI18n("common");
+
+ const { data, isFetching } = clientApi.icon.findIcons.useQuery({
+ searchText: search,
+ });
+
+ const combobox = useCombobox({
+ onDropdownClose: () => combobox.resetSelectedOption(),
+ });
+
+ const notNullableData = data?.icons ?? [];
+
+ const totalOptions = notNullableData.reduce((acc, group) => acc + group.icons.length, 0);
+
+ const groups = notNullableData.map((group) => {
+ const options = group.icons.map((item) => (
+
+
+ {item.name}
+
+
+ ));
+
+ return (
+
+ {options}
+
+ );
+ });
+
+ return (
+ {
+ setValue(value);
+ setSearch(value);
+ onChange(value);
+ combobox.closeDropdown();
+ }}
+ store={combobox}
+ withinPortal
+ >
+
+
+
+
+
+ {t("iconPicker.header", { countIcons: data?.countIcons })}
+
+
+ {totalOptions > 0 ? (
+ groups
+ ) : !isFetching ? (
+ {t("search.nothingFound")}
+ ) : (
+ Array(15)
+ .fill(0)
+ .map((_, index: number) => (
+
+
+ ))
+ )}
+
+
+
+ );
+};
diff --git a/apps/nextjs/src/components/language/language-combobox.module.css b/apps/nextjs/src/components/language/language-combobox.module.css
new file mode 100644
index 000000000..fe98524ad
--- /dev/null
+++ b/apps/nextjs/src/components/language/language-combobox.module.css
@@ -0,0 +1,3 @@
+.flagIcon {
+ border-radius: 4px;
+}
diff --git a/apps/nextjs/src/components/language/language-combobox.tsx b/apps/nextjs/src/components/language/language-combobox.tsx
new file mode 100644
index 000000000..6bd362591
--- /dev/null
+++ b/apps/nextjs/src/components/language/language-combobox.tsx
@@ -0,0 +1,86 @@
+"use client";
+
+import React from "react";
+import { Combobox, Group, InputBase, Text, useCombobox } from "@mantine/core";
+import { IconCheck } from "@tabler/icons-react";
+
+import type { SupportedLanguage } from "@homarr/translation";
+import { localeAttributes, supportedLanguages } from "@homarr/translation";
+import { useChangeLocale, useCurrentLocale } from "@homarr/translation/client";
+
+import classes from "./language-combobox.module.css";
+
+export const LanguageCombobox = () => {
+ const combobox = useCombobox({
+ onDropdownClose: () => combobox.resetSelectedOption(),
+ });
+ const currentLocale = useCurrentLocale();
+ const changeLocale = useChangeLocale();
+
+ const handleOnOptionSubmit = React.useCallback(
+ (value: string) => {
+ if (!value) {
+ return;
+ }
+ changeLocale(value as SupportedLanguage);
+ combobox.closeDropdown();
+ },
+ [changeLocale, combobox],
+ );
+
+ const handleOnClick = React.useCallback(() => {
+ combobox.toggleDropdown();
+ }, [combobox]);
+
+ return (
+
+
+
+
+
+ {supportedLanguages.map((languageKey) => (
+
+
+ ))}
+
+
+
+ );
+};
+
+const OptionItem = ({
+ currentLocale,
+ localeKey,
+ showCheck,
+}: {
+ currentLocale: SupportedLanguage;
+ localeKey: SupportedLanguage;
+ showCheck?: boolean;
+}) => {
+ return (
+
+
+
+ {localeAttributes[localeKey].name}
+
+ ({localeAttributes[localeKey].translatedName})
+
+
+
+ {showCheck && localeKey === currentLocale &&
+ );
+};
diff --git a/apps/nextjs/src/components/layout/background.tsx b/apps/nextjs/src/components/layout/background.tsx
new file mode 100644
index 000000000..1c5b7c8b4
--- /dev/null
+++ b/apps/nextjs/src/components/layout/background.tsx
@@ -0,0 +1,58 @@
+import { usePathname } from "next/navigation";
+import type { AppShellProps } from "@mantine/core";
+
+import { useOptionalBoard } from "~/app/[locale]/boards/(content)/_context";
+
+const supportedVideoFormats = ["mp4", "webm", "ogg"];
+const isVideo = (url: string) => supportedVideoFormats.some((format) => url.toLowerCase().endsWith(`.${format}`));
+
+export const useOptionalBackgroundProps = (): Partial => {
+ const board = useOptionalBoard();
+ const pathname = usePathname();
+
+ if (!board?.backgroundImageUrl) return {};
+
+ // Check if we are on a client board page
+ if (pathname.split("/").length > 3) return {};
+
+ if (isVideo(board.backgroundImageUrl)) {
+ return {};
+ }
+
+ return {
+ bg: `url(${board?.backgroundImageUrl})`,
+ bgp: "center center",
+ bgsz: board?.backgroundImageSize ?? "cover",
+ bgr: board?.backgroundImageRepeat ?? "no-repeat",
+ bga: board?.backgroundImageAttachment ?? "fixed",
+ };
+};
+
+export const BoardBackgroundVideo = () => {
+ const board = useOptionalBoard();
+
+ if (!board?.backgroundImageUrl) return null;
+ if (!isVideo(board.backgroundImageUrl)) return null;
+
+ const videoFormat = board.backgroundImageUrl.split(".").pop()?.toLowerCase();
+
+ if (!videoFormat) return null;
+
+ return (
+
+
+ );
+};
diff --git a/apps/nextjs/src/components/layout/header.tsx b/apps/nextjs/src/components/layout/header.tsx
index 6a36bcd9f..dd5d51243 100644
--- a/apps/nextjs/src/components/layout/header.tsx
+++ b/apps/nextjs/src/components/layout/header.tsx
@@ -1,30 +1,38 @@
+import type { ReactNode } from "react";
import Link from "next/link";
+import { AppShellHeader, Group, UnstyledButton } from "@mantine/core";
-import { AppShellHeader, Group, UnstyledButton } from "@homarr/ui";
+import { Spotlight } from "@homarr/spotlight";
import { ClientBurger } from "./header/burger";
import { DesktopSearchInput, MobileSearchButton } from "./header/search";
-import { ClientSpotlight } from "./header/spotlight";
import { UserButton } from "./header/user";
-import { LogoWithTitle } from "./logo";
+import { HomarrLogoWithTitle } from "./logo/homarr-logo";
-export const MainHeader = () => {
+interface Props {
+ logo?: ReactNode;
+ actions?: ReactNode;
+ hasNavigation?: boolean;
+}
+
+export const MainHeader = ({ logo, actions, hasNavigation = true }: Props) => {
return (
-
-
+
+ {actions}
-
);
};
diff --git a/apps/nextjs/src/components/layout/header/burger.tsx b/apps/nextjs/src/components/layout/header/burger.tsx
index 02f3def9d..03ad0851a 100644
--- a/apps/nextjs/src/components/layout/header/burger.tsx
+++ b/apps/nextjs/src/components/layout/header/burger.tsx
@@ -1,18 +1,15 @@
"use client";
import { useCallback } from "react";
+import { Burger } from "@mantine/core";
import { atom, useAtom } from "jotai";
-import { Burger } from "@homarr/ui";
-
export const navigationCollapsedAtom = atom(true);
export const ClientBurger = () => {
const [collapsed, setCollapsed] = useAtom(navigationCollapsedAtom);
- const toggle = useCallback(() => setCollapsed((c) => !c), [setCollapsed]);
+ const toggle = useCallback(() => setCollapsed((collapsed) => !collapsed), [setCollapsed]);
- return (
- ;
+
+const headerButtonActionIconProps: ActionIconProps = {
+ variant: "subtle",
+ style: { border: "none" },
+ color: "gray",
+ size: "lg",
+};
+
+// eslint-disable-next-line react/display-name
+export const HeaderButton = forwardRef((props, ref) => {
+ if ("href" in props) {
+ return (
+ }
+ component={Link}
+ {...props}
+ {...headerButtonActionIconProps}
+ >
+ {props.children}
+
+ );
+ }
+ return (
+
+ {props.children}
+
+ );
+});
diff --git a/apps/nextjs/src/components/layout/header/search.tsx b/apps/nextjs/src/components/layout/header/search.tsx
index 1bb742640..4dad0404f 100644
--- a/apps/nextjs/src/components/layout/header/search.tsx
+++ b/apps/nextjs/src/components/layout/header/search.tsx
@@ -1,9 +1,12 @@
"use client";
-import { spotlight } from "@homarr/spotlight";
+import { TextInput, UnstyledButton } from "@mantine/core";
+import { IconSearch } from "@tabler/icons-react";
+
+import { openSpotlight } from "@homarr/spotlight";
import { useScopedI18n } from "@homarr/translation/client";
-import { ActionIcon, IconSearch, TextInput, UnstyledButton } from "@homarr/ui";
+import { HeaderButton } from "./button";
import classes from "./search.module.css";
export const DesktopSearchInput = () => {
@@ -16,7 +19,7 @@ export const DesktopSearchInput = () => {
w={400}
size="sm"
leftSection={
+
+
);
};
diff --git a/apps/nextjs/src/components/layout/header/spotlight.tsx b/apps/nextjs/src/components/layout/header/spotlight.tsx
deleted file mode 100644
index 61d2f70b4..000000000
--- a/apps/nextjs/src/components/layout/header/spotlight.tsx
+++ /dev/null
@@ -1,22 +0,0 @@
-"use client";
-
-import { Spotlight } from "@homarr/spotlight";
-import { useScopedI18n } from "@homarr/translation/client";
-import { IconSearch } from "@homarr/ui";
-
-export const ClientSpotlight = () => {
- const t = useScopedI18n("common.search");
-
- return (
-
-
+
+
+
+
);
};
diff --git a/apps/nextjs/src/components/layout/logo.tsx b/apps/nextjs/src/components/layout/logo.tsx
deleted file mode 100644
index 6a5fe592e..000000000
--- a/apps/nextjs/src/components/layout/logo.tsx
+++ /dev/null
@@ -1,33 +0,0 @@
-import Image from "next/image";
-
-import type { TitleOrder } from "@homarr/ui";
-import { Group, Title } from "@homarr/ui";
-
-interface LogoProps {
- size: number;
-}
-
-export const Logo = ({ size = 60 }: LogoProps) => (
- ;
-
-interface LogoWithTitleProps {
- size: keyof typeof logoWithTitleSizes;
-}
-
-export const LogoWithTitle = ({ size }: LogoWithTitleProps) => {
- const { logoSize, titleOrder } = logoWithTitleSizes[size];
-
- return (
-
- lparr
-
- );
-};
diff --git a/apps/nextjs/src/components/layout/logo/board-logo.tsx b/apps/nextjs/src/components/layout/logo/board-logo.tsx
new file mode 100644
index 000000000..096709431
--- /dev/null
+++ b/apps/nextjs/src/components/layout/logo/board-logo.tsx
@@ -0,0 +1,42 @@
+"use client";
+
+import { useRequiredBoard } from "~/app/[locale]/boards/(content)/_context";
+import { homarrLogoPath, homarrPageTitle } from "./homarr-logo";
+import type { LogoWithTitleProps } from "./logo";
+import { Logo, LogoWithTitle } from "./logo";
+
+interface LogoProps {
+ size: number;
+}
+
+const useImageOptions = () => {
+ const board = useRequiredBoard();
+ return {
+ src: board.logoImageUrl ?? homarrLogoPath,
+ alt: "Board logo",
+ shouldUseNextImage: false,
+ };
+};
+
+export const BoardLogo = ({ size }: LogoProps) => {
+ const imageOptions = useImageOptions();
+ return ;
+
+export interface LogoWithTitleProps {
+ size: keyof typeof logoWithTitleSizes;
+ title: string;
+ image: Omit;
+ hideTitleOnMobile?: boolean;
+}
+
+export const LogoWithTitle = ({ size, title, image, hideTitleOnMobile }: LogoWithTitleProps) => {
+ const { logoSize, titleOrder } = logoWithTitleSizes[size];
+
+ return (
+
+
+ {title}
+
+
+ );
+};
diff --git a/apps/nextjs/src/components/layout/navigation-link.tsx b/apps/nextjs/src/components/layout/navigation-link.tsx
new file mode 100644
index 000000000..c65f9381c
--- /dev/null
+++ b/apps/nextjs/src/components/layout/navigation-link.tsx
@@ -0,0 +1,65 @@
+"use client";
+
+import type { ReactNode } from "react";
+import Link from "next/link";
+import { usePathname } from "next/navigation";
+import { NavLink } from "@mantine/core";
+
+export const CommonNavLink = (props: ClientNavigationLink) =>
+ "href" in props ?
+ {props.items.map((item) => (
+
+);
+
+interface CommonNavigationLinkProps {
+ label: string;
+ icon: ReactNode;
+}
+
+interface NavigationLinkHref extends CommonNavigationLinkProps {
+ href: string;
+ external?: boolean;
+}
+interface NavigationLinkWithItems extends CommonNavigationLinkProps {
+ items: NavigationLinkHref[];
+}
+
+export type ClientNavigationLink = NavigationLinkHref | NavigationLinkWithItems;
diff --git a/apps/nextjs/src/components/layout/navigation.tsx b/apps/nextjs/src/components/layout/navigation.tsx
index 95dcc5ebe..c9a53aaad 100644
--- a/apps/nextjs/src/components/layout/navigation.tsx
+++ b/apps/nextjs/src/components/layout/navigation.tsx
@@ -1,12 +1,9 @@
-import Link from "next/link";
+import { AppShellNavbar, AppShellSection, ScrollArea } from "@mantine/core";
-import {
- AppShellNavbar,
- AppShellSection,
- NavLink,
- ScrollArea,
-} from "@homarr/ui";
-import type { TablerIconsProps } from "@homarr/ui";
+import type { TablerIcon } from "@homarr/ui";
+
+import type { ClientNavigationLink } from "./navigation-link";
+import { CommonNavLink } from "./navigation-link";
interface MainNavigationProps {
headerSection?: JSX.Element;
@@ -14,11 +11,7 @@ interface MainNavigationProps {
links: NavigationLink[];
}
-export const MainNavigation = ({
- headerSection,
- footerSection,
- links,
-}: MainNavigationProps) => {
+export const MainNavigation = ({ headerSection, footerSection, links }: MainNavigationProps) => {
return (
{headerSection && {headerSection} }
@@ -28,54 +21,34 @@ export const MainNavigation = ({
mb={footerSection ? "md" : undefined}
component={ScrollArea}
>
- {links.map((link) => (
- {footerSection} }
);
};
-const CommonNavLink = (props: NavigationLink) =>
- "href" in props ? (
- ) => {
const collapsed = useAtomValue(navigationCollapsedAtom);
+ const backgroundProps = useOptionalBackgroundProps();
return (
Promise;
+}
+
+export const AddBoardModal = createModal(({ actions, innerProps }) => {
+ const t = useI18n();
+ const form = useZodForm(
+ z.object({
+ name: boardSchemas.byName.shape.name.refine((value) => !innerProps.boardNames.includes(value), {
+ params: createCustomErrorParams("boardAlreadyExists"),
+ }),
+ }),
+ {
+ initialValues: {
+ name: "",
+ },
+ },
+ );
+
+ return (
+
+ );
+}).withOptions({
+ defaultTitle: (t) => t("management.page.board.action.new.label"),
+});
diff --git a/apps/nextjs/src/components/manage/danger-zone.tsx b/apps/nextjs/src/components/manage/danger-zone.tsx
new file mode 100644
index 000000000..5c515b4a0
--- /dev/null
+++ b/apps/nextjs/src/components/manage/danger-zone.tsx
@@ -0,0 +1,58 @@
+import { Fragment } from "react";
+import { Card, CardSection, Divider, Group, Stack, Text, Title } from "@mantine/core";
+
+import { getI18n } from "@homarr/translation/server";
+
+interface DangerZoneRootProps {
+ children: React.ReactNode[] | React.ReactNode;
+}
+
+export const DangerZoneRoot = async ({ children }: DangerZoneRootProps) => {
+ const t = await getI18n();
+
+ return (
+
+
+ {t("common.dangerZone")}
+
+
+
+ {Array.isArray(children)
+ ? children.map((child, index) => (
+
+ {child}
+ {index + 1 !== children.length && (
+
+
+ )}
+
+ ))
+ : children}
+
+
+
+ );
+};
+
+interface DangerZoneItemProps {
+ label: string;
+ description: string;
+ action: React.ReactNode;
+}
+
+export const DangerZoneItem = ({ label, description, action }: DangerZoneItemProps) => {
+ return (
+
+
+
+ {label}
+
+ {description}
+
+
+ {action}
+
+
+ );
+};
diff --git a/apps/nextjs/src/components/user-avatar-menu.tsx b/apps/nextjs/src/components/user-avatar-menu.tsx
new file mode 100644
index 000000000..0cd5e0726
--- /dev/null
+++ b/apps/nextjs/src/components/user-avatar-menu.tsx
@@ -0,0 +1,132 @@
+"use client";
+
+import type { ReactNode } from "react";
+import { useCallback, useEffect } from "react";
+import Link from "next/link";
+import { useRouter } from "next/navigation";
+import { Center, Menu, Stack, Text, useMantineColorScheme } from "@mantine/core";
+import { useTimeout } from "@mantine/hooks";
+import {
+ IconCheck,
+ IconHome,
+ IconLogin,
+ IconLogout,
+ IconMoon,
+ IconSettings,
+ IconSun,
+ IconTool,
+} from "@tabler/icons-react";
+
+import { signOut, useSession } from "@homarr/auth/client";
+import { createModal, useModalAction } from "@homarr/modals";
+import { useScopedI18n } from "@homarr/translation/client";
+
+import "flag-icons/css/flag-icons.min.css";
+
+import { LanguageCombobox } from "./language/language-combobox";
+
+interface UserAvatarMenuProps {
+ children: ReactNode;
+}
+
+export const UserAvatarMenu = ({ children }: UserAvatarMenuProps) => {
+ const t = useScopedI18n("common.userAvatar.menu");
+ const { colorScheme, toggleColorScheme } = useMantineColorScheme();
+
+ const ColorSchemeIcon = colorScheme === "dark" ? IconSun : IconMoon;
+
+ const colorSchemeText = colorScheme === "dark" ? t("switchToLightMode") : t("switchToDarkMode");
+
+ const session = useSession();
+ const router = useRouter();
+
+ const { openModal } = useModalAction(LogoutModal);
+
+ const handleSignout = useCallback(async () => {
+ await signOut({
+ redirect: false,
+ });
+ openModal({
+ onTimeout: () => {
+ router.refresh();
+ },
+ });
+ }, [openModal, router]);
+
+ return (
+
+
+
+
+ router.push("/auth/login")} leftSection={
+ )}
+
+ {children}
+
+ );
+};
+
+const LogoutModal = createModal<{ onTimeout: () => void }>(({ actions, innerProps }) => {
+ const t = useScopedI18n("common.userAvatar.menu");
+ const { start } = useTimeout(() => {
+ actions.closeModal();
+ innerProps.onTimeout();
+ }, 1500);
+
+ useEffect(() => {
+ start();
+ }, [start]);
+
+ return (
+
+
+
+ {t("loggedOut")}
+
+
+
+ );
+}).withOptions({
+ centered: true,
+ withCloseButton: false,
+ transitionProps: {
+ transition: "pop",
+ },
+ size: 200,
+ closeOnClickOutside: false,
+ closeOnEscape: false,
+});
diff --git a/apps/nextjs/src/components/user-avatar.tsx b/apps/nextjs/src/components/user-avatar.tsx
index 0c3e5bd39..d75606caf 100644
--- a/apps/nextjs/src/components/user-avatar.tsx
+++ b/apps/nextjs/src/components/user-avatar.tsx
@@ -1,6 +1,7 @@
-import { auth } from "@homarr/auth";
-import type { AvatarProps, MantineSize } from "@homarr/ui";
-import { Avatar } from "@homarr/ui";
+import type { AvatarProps, MantineSize } from "@mantine/core";
+import { Avatar } from "@mantine/core";
+
+import { auth } from "@homarr/auth/next";
interface UserAvatarProps {
size: MantineSize;
@@ -14,19 +15,9 @@ export const UserAvatar = async ({ size }: UserAvatarProps) => {
color: "primaryColor",
} satisfies Partial;
- if (!currentSession) return
- {currentSession.user.name!.substring(0, 2).toUpperCase()}
-
- );
+ return {currentSession.user.name!.substring(0, 2).toUpperCase()} ;
};
diff --git a/apps/nextjs/src/constants.ts b/apps/nextjs/src/constants.ts
new file mode 100644
index 000000000..d29bbaef0
--- /dev/null
+++ b/apps/nextjs/src/constants.ts
@@ -0,0 +1,2 @@
+export const fullHeightWithoutHeaderAndFooter =
+ "calc(100dvh - var(--app-shell-header-offset, 0px) - var(--app-shell-padding) - var(--app-shell-footer-offset, 0px) - var(--app-shell-padding))";
diff --git a/apps/nextjs/src/env.mjs b/apps/nextjs/src/env.mjs
index f098ee199..2e4452340 100644
--- a/apps/nextjs/src/env.mjs
+++ b/apps/nextjs/src/env.mjs
@@ -1,20 +1,32 @@
import { createEnv } from "@t3-oss/env-nextjs";
import { z } from "zod";
+const isUsingDbUrl = Boolean(process.env.DB_URL);
+const isUsingDbHost = Boolean(process.env.DB_HOST);
+const isUsingDbCredentials = process.env.DB_DRIVER === "mysql2";
+
export const env = createEnv({
shared: {
VERCEL_URL: z
.string()
.optional()
- .transform((v) => (v ? `https://${v}` : undefined)),
+ .transform((url) => (url ? `https://${url}` : undefined)),
PORT: z.coerce.number().default(3000),
+ NODE_ENV: z.enum(["development", "production", "test"]).default("development"),
},
/**
* Specify your server-side environment variables schema here. This way you can ensure the app isn't
* built with invalid env vars.
*/
server: {
- DB_URL: z.string(),
+ DB_DRIVER: z.enum(["better-sqlite3", "mysql2"]).default("better-sqlite3"),
+ // If the DB_HOST is set, the DB_URL is optional
+ DB_URL: isUsingDbHost ? z.string().optional() : z.string(),
+ DB_HOST: isUsingDbUrl ? z.string().optional() : z.string(),
+ DB_PORT: isUsingDbUrl ? z.number().optional() : z.number().min(1).default(3306),
+ DB_USER: isUsingDbCredentials ? z.string() : z.string().optional(),
+ DB_PASSWORD: isUsingDbCredentials ? z.string() : z.string().optional(),
+ DB_NAME: isUsingDbUrl ? z.string().optional() : z.string(),
},
/**
* Specify your client-side environment variables schema here.
@@ -30,10 +42,15 @@ export const env = createEnv({
VERCEL_URL: process.env.VERCEL_URL,
PORT: process.env.PORT,
DB_URL: process.env.DB_URL,
+ DB_HOST: process.env.DB_HOST,
+ DB_USER: process.env.DB_USER,
+ DB_PASSWORD: process.env.DB_PASSWORD,
+ DB_NAME: process.env.DB_NAME,
+ DB_PORT: process.env.DB_PORT,
+ DB_DRIVER: process.env.DB_DRIVER,
+ NODE_ENV: process.env.NODE_ENV,
// NEXT_PUBLIC_CLIENTVAR: process.env.NEXT_PUBLIC_CLIENTVAR,
},
skipValidation:
- !!process.env.CI ||
- !!process.env.SKIP_ENV_VALIDATION ||
- process.env.npm_lifecycle_event === "lint",
+ Boolean(process.env.CI) || Boolean(process.env.SKIP_ENV_VALIDATION) || process.env.npm_lifecycle_event === "lint",
});
diff --git a/apps/nextjs/src/errors/trpc-not-found.ts b/apps/nextjs/src/errors/trpc-not-found.ts
new file mode 100644
index 000000000..3ae693203
--- /dev/null
+++ b/apps/nextjs/src/errors/trpc-not-found.ts
@@ -0,0 +1,12 @@
+import "server-only";
+
+import { notFound } from "next/navigation";
+import { TRPCError } from "@trpc/server";
+
+export const catchTrpcNotFound = (err: unknown) => {
+ if (err instanceof TRPCError && err.code === "NOT_FOUND") {
+ notFound();
+ }
+
+ throw err;
+};
diff --git a/apps/nextjs/src/metadata.ts b/apps/nextjs/src/metadata.ts
new file mode 100644
index 000000000..856ecc9d3
--- /dev/null
+++ b/apps/nextjs/src/metadata.ts
@@ -0,0 +1 @@
+export const createMetaTitle = (name: string) => `${name} • Homarr`;
diff --git a/apps/nextjs/src/react-app-env.d.ts b/apps/nextjs/src/react-app-env.d.ts
new file mode 100644
index 000000000..0357e4f19
--- /dev/null
+++ b/apps/nextjs/src/react-app-env.d.ts
@@ -0,0 +1,4 @@
+declare module "*.png";
+declare module "*.svg";
+declare module "*.jpeg";
+declare module "*.jpg";
diff --git a/apps/nextjs/src/styles/gridstack.scss b/apps/nextjs/src/styles/gridstack.scss
new file mode 100644
index 000000000..e9906c7c1
--- /dev/null
+++ b/apps/nextjs/src/styles/gridstack.scss
@@ -0,0 +1,85 @@
+@import "@homarr/gridstack/dist/gridstack.min.css";
+
+:root {
+ --gridstack-widget-width: 64;
+ --gridstack-column-count: 12;
+}
+
+.grid-stack-placeholder > .placeholder-content {
+ background-color: rgb(248, 249, 250) !important;
+ border-radius: 12px;
+ border: 1px solid rgba(0, 0, 0, 0.05);
+}
+
+@media (prefers-color-scheme: dark) {
+ .grid-stack-placeholder > .placeholder-content {
+ background-color: rgba(255, 255, 255, 0.05) !important;
+ }
+}
+
+// Define min size for gridstack items
+.grid-stack > .grid-stack-item {
+ min-width: calc(100% / var(--gridstack-column-count));
+ min-height: calc(1px * var(--gridstack-widget-width));
+}
+
+// Styling for grid-stack main area
+@for $i from 1 to 96 {
+ .grid-stack > .grid-stack-item[gs-w="#{$i}"] {
+ width: calc(100% / #{var(--gridstack-column-count)} * #{$i});
+ }
+ .grid-stack > .grid-stack-item[gs-min-w="#{$i}"] {
+ min-width: calc(100% / #{var(--gridstack-column-count)} * #{$i});
+ }
+ .grid-stack > .grid-stack-item[gs-max-w="#{$i}"] {
+ max-width: calc(100% / #{var(--gridstack-column-count)} * #{$i});
+ }
+}
+
+@for $i from 1 to 96 {
+ .grid-stack > .grid-stack-item[gs-h="#{$i}"] {
+ height: calc(#{$i}px * #{var(--gridstack-widget-width)});
+ }
+ .grid-stack > .grid-stack-item[gs-min-h="#{$i}"] {
+ min-height: calc(#{$i}px * #{var(--gridstack-widget-width)});
+ }
+ .grid-stack > .grid-stack-item[gs-max-h="#{$i}"] {
+ max-height: calc(#{$i}px * #{var(--gridstack-widget-width)});
+ }
+}
+
+@for $i from 1 to 96 {
+ .grid-stack > .grid-stack-item[gs-x="#{$i}"] {
+ left: calc(100% / #{var(--gridstack-column-count)} * #{$i});
+ }
+}
+
+@for $i from 1 to 96 {
+ .grid-stack > .grid-stack-item[gs-y="#{$i}"] {
+ top: calc(#{$i}px * #{var(--gridstack-widget-width)});
+ }
+}
+
+// General gridstack styling
+.grid-stack > .grid-stack-item > .grid-stack-item-content,
+.grid-stack > .grid-stack-item > .placeholder-content {
+ inset: 10px;
+}
+
+.grid-stack > .grid-stack-item > .ui-resizable-se {
+ bottom: 10px;
+ right: 10px;
+}
+
+.grid-stack > .grid-stack-item > .grid-stack-item-content {
+ overflow-y: auto;
+}
+
+.grid-stack.grid-stack-animate {
+ transition: none;
+}
+
+.gridstack-empty-wrapper {
+ height: 0px;
+ min-height: 0px !important;
+}
diff --git a/apps/nextjs/src/styles/prismjs.scss b/apps/nextjs/src/styles/prismjs.scss
new file mode 100644
index 000000000..d9f1d6327
--- /dev/null
+++ b/apps/nextjs/src/styles/prismjs.scss
@@ -0,0 +1,225 @@
+[data-mantine-color-scheme="light"] {
+ code[class*="language-"],
+ pre[class*="language-"] {
+ color: #000;
+ background: 0 0;
+ text-shadow: 0 1px #fff;
+ font-family: Consolas, Monaco, "Andale Mono", "Ubuntu Mono", monospace;
+ font-size: 1em;
+ text-align: left;
+ white-space: pre;
+ word-spacing: normal;
+ word-break: normal;
+ word-wrap: normal;
+ line-height: 1.5;
+ -moz-tab-size: 4;
+ -o-tab-size: 4;
+ tab-size: 4;
+ -webkit-hyphens: none;
+ -moz-hyphens: none;
+ -ms-hyphens: none;
+ hyphens: none;
+ }
+ code[class*="language-"] ::-moz-selection,
+ code[class*="language-"]::-moz-selection,
+ pre[class*="language-"] ::-moz-selection,
+ pre[class*="language-"]::-moz-selection {
+ text-shadow: none;
+ background: #b3d4fc;
+ }
+ code[class*="language-"] ::selection,
+ code[class*="language-"]::selection,
+ pre[class*="language-"] ::selection,
+ pre[class*="language-"]::selection {
+ text-shadow: none;
+ background: #b3d4fc;
+ }
+ @media print {
+ code[class*="language-"],
+ pre[class*="language-"] {
+ text-shadow: none;
+ }
+ }
+ pre[class*="language-"] {
+ padding: 1em;
+ margin: 0.5em 0;
+ overflow: auto;
+ }
+ :not(pre) > code[class*="language-"],
+ pre[class*="language-"] {
+ background: #f5f2f0;
+ }
+ :not(pre) > code[class*="language-"] {
+ padding: 0.1em;
+ border-radius: 0.3em;
+ white-space: normal;
+ }
+ .token.cdata,
+ .token.comment,
+ .token.doctype,
+ .token.prolog {
+ color: #708090;
+ }
+ .token.punctuation {
+ color: #999;
+ }
+ .token.namespace {
+ opacity: 0.7;
+ }
+ .token.boolean,
+ .token.constant,
+ .token.deleted,
+ .token.number,
+ .token.property,
+ .token.symbol,
+ .token.tag {
+ color: #905;
+ }
+ .token.attr-name,
+ .token.builtin,
+ .token.char,
+ .token.inserted,
+ .token.selector,
+ .token.string {
+ color: #690;
+ }
+ .language-css .token.string,
+ .style .token.string,
+ .token.entity,
+ .token.operator,
+ .token.url {
+ color: #9a6e3a;
+ background: hsla(0, 0%, 100%, 0.5);
+ }
+ .token.atrule,
+ .token.attr-value,
+ .token.keyword {
+ color: #07a;
+ }
+ .token.class-name,
+ .token.function {
+ color: #dd4a68;
+ }
+ .token.important,
+ .token.regex,
+ .token.variable {
+ color: #e90;
+ }
+ .token.bold,
+ .token.important {
+ font-weight: 700;
+ }
+ .token.italic {
+ font-style: italic;
+ }
+ .token.entity {
+ cursor: help;
+ }
+}
+
+[data-mantine-color-scheme="dark"] {
+ code[class*="language-"],
+ pre[class*="language-"] {
+ color: #fff;
+ background: 0 0;
+ text-shadow: 0 -0.1em 0.2em #000;
+ font-family: Consolas, Monaco, "Andale Mono", "Ubuntu Mono", monospace;
+ font-size: 1em;
+ text-align: left;
+ white-space: pre;
+ word-spacing: normal;
+ word-break: normal;
+ word-wrap: normal;
+ line-height: 1.5;
+ -moz-tab-size: 4;
+ -o-tab-size: 4;
+ tab-size: 4;
+ -webkit-hyphens: none;
+ -moz-hyphens: none;
+ -ms-hyphens: none;
+ hyphens: none;
+ }
+ @media print {
+ code[class*="language-"],
+ pre[class*="language-"] {
+ text-shadow: none;
+ }
+ }
+ :not(pre) > code[class*="language-"],
+ pre[class*="language-"] {
+ background: #4c3f33;
+ }
+ pre[class*="language-"] {
+ padding: 1em;
+ margin: 0.5em 0;
+ overflow: auto;
+ border: 0.3em solid #7a6651;
+ border-radius: 0.5em;
+ box-shadow: 1px 1px 0.5em #000 inset;
+ }
+ :not(pre) > code[class*="language-"] {
+ padding: 0.15em 0.2em 0.05em;
+ border-radius: 0.3em;
+ border: 0.13em solid #7a6651;
+ box-shadow: 1px 1px 0.3em -0.1em #000 inset;
+ white-space: normal;
+ }
+ .token.cdata,
+ .token.comment,
+ .token.doctype,
+ .token.prolog {
+ color: #997f66;
+ }
+ .token.punctuation {
+ opacity: 0.7;
+ }
+ .token.namespace {
+ opacity: 0.7;
+ }
+ .token.boolean,
+ .token.constant,
+ .token.number,
+ .token.property,
+ .token.symbol,
+ .token.tag {
+ color: #d1939e;
+ }
+ .token.attr-name,
+ .token.builtin,
+ .token.char,
+ .token.inserted,
+ .token.selector,
+ .token.string {
+ color: #bce051;
+ }
+ .language-css .token.string,
+ .style .token.string,
+ .token.entity,
+ .token.operator,
+ .token.url,
+ .token.variable {
+ color: #f4b73d;
+ }
+ .token.atrule,
+ .token.attr-value,
+ .token.keyword {
+ color: #d1939e;
+ }
+ .token.important,
+ .token.regex {
+ color: #e90;
+ }
+ .token.bold,
+ .token.important {
+ font-weight: 700;
+ }
+ .token.italic {
+ font-style: italic;
+ }
+ .token.entity {
+ cursor: help;
+ }
+ .token.deleted {
+ color: red;
+ }
+}
diff --git a/apps/nextjs/src/trpc/react.ts b/apps/nextjs/src/trpc/react.ts
deleted file mode 100644
index 43339ff3c..000000000
--- a/apps/nextjs/src/trpc/react.ts
+++ /dev/null
@@ -1,7 +0,0 @@
-import { createTRPCReact } from "@trpc/react-query";
-
-import type { AppRouter } from "@homarr/api";
-
-export const api = createTRPCReact();
-
-export { type RouterInputs, type RouterOutputs } from "@homarr/api";
diff --git a/apps/nextjs/src/trpc/server.ts b/apps/nextjs/src/trpc/server.ts
deleted file mode 100644
index ac38dce73..000000000
--- a/apps/nextjs/src/trpc/server.ts
+++ /dev/null
@@ -1,61 +0,0 @@
-import { cache } from "react";
-import { headers } from "next/headers";
-import { createTRPCClient, loggerLink, TRPCClientError } from "@trpc/client";
-import { callProcedure } from "@trpc/server";
-import { observable } from "@trpc/server/observable";
-import type { TRPCErrorResponse } from "@trpc/server/rpc";
-import SuperJSON from "superjson";
-
-import { appRouter, createTRPCContext } from "@homarr/api";
-import { auth } from "@homarr/auth";
-
-/**
- * This wraps the `createTRPCContext` helper and provides the required context for the tRPC API when
- * handling a tRPC call from a React Server Component.
- */
-const createContext = cache(async () => {
- const heads = new Headers(headers());
- heads.set("x-trpc-source", "rsc");
-
- return createTRPCContext({
- auth: await auth(),
- headers: heads,
- });
-});
-
-export const api = createTRPCClient({
- transformer: SuperJSON,
- links: [
- loggerLink({
- enabled: (op) =>
- process.env.NODE_ENV === "development" ||
- (op.direction === "down" && op.result instanceof Error),
- }),
- /**
- * Custom RSC link that invokes procedures directly in the server component Don't be too afraid
- * about the complexity here, it's just wrapping `callProcedure` with an observable to make it a
- * valid ending link for tRPC.
- */
- () =>
- ({ op }) =>
- observable((observer) => {
- createContext()
- .then((ctx) => {
- return callProcedure({
- procedures: appRouter._def.procedures,
- path: op.path,
- getRawInput: () => Promise.resolve(op.input),
- ctx,
- type: op.type,
- });
- })
- .then((data) => {
- observer.next({ result: { data } });
- observer.complete();
- })
- .catch((cause: TRPCErrorResponse) => {
- observer.error(TRPCClientError.from(cause));
- });
- }),
- ],
-});
diff --git a/apps/nextjs/src/versions/package-reader.ts b/apps/nextjs/src/versions/package-reader.ts
new file mode 100644
index 000000000..c61da286b
--- /dev/null
+++ b/apps/nextjs/src/versions/package-reader.ts
@@ -0,0 +1,35 @@
+import fsPromises from "fs/promises";
+import { glob } from "glob";
+
+import packageJson from "~/../package.json";
+
+const getPackageVersion = () => packageJson.version;
+const getDependenciesAsync = async (): Promise => {
+ const pathNames = await glob("**/package.json", {
+ ignore: "node_modules/**",
+ cwd: "../../",
+ absolute: true,
+ });
+ const packageContents = await Promise.all(pathNames.map(async (path) => await fsPromises.readFile(path, "utf-8")));
+ const packageDependencies = packageContents
+ .map((packageContent) => (JSON.parse(packageContent) as PackageJson).dependencies)
+ .filter((dependencies) => dependencies !== undefined);
+
+ let dependencies = {};
+ for (const dependenciesOfPackage of packageDependencies) {
+ dependencies = { ...dependencies, ...dependenciesOfPackage };
+ }
+ return dependencies;
+};
+
+export const getPackageAttributesAsync = async () => {
+ return {
+ version: getPackageVersion(),
+ dependencies: await getDependenciesAsync(),
+ };
+};
+
+type PackageJsonDependencies = { [key in string]: string };
+interface PackageJson {
+ dependencies: PackageJsonDependencies | undefined;
+}
diff --git a/apps/tasks/package.json b/apps/tasks/package.json
new file mode 100644
index 000000000..7133523b8
--- /dev/null
+++ b/apps/tasks/package.json
@@ -0,0 +1,53 @@
+{
+ "name": "@homarr/tasks",
+ "version": "0.1.0",
+ "private": true,
+ "exports": {
+ ".": "./src/index.ts"
+ },
+ "main": "./src/main.ts",
+ "types": "./src/main.ts",
+ "license": "MIT",
+ "type": "module",
+ "scripts": {
+ "dev": "pnpm with-env tsx ./src/main.ts",
+ "build": "esbuild src/main.ts --bundle --platform=node --outfile=tasks.cjs",
+ "clean": "rm -rf .turbo node_modules",
+ "lint": "eslint .",
+ "format": "prettier --check . --ignore-path ../../.gitignore",
+ "typecheck": "tsc --noEmit",
+ "with-env": "dotenv -e ../../.env --"
+ },
+ "dependencies": {
+ "@homarr/common": "workspace:^0.1.0",
+ "@homarr/db": "workspace:^0.1.0",
+ "@homarr/definitions": "workspace:^0.1.0",
+ "@homarr/icons": "workspace:^0.1.0",
+ "@homarr/log": "workspace:^",
+ "@homarr/redis": "workspace:^0.1.0",
+ "@homarr/server-settings": "workspace:^0.1.0",
+ "@homarr/validation": "workspace:^0.1.0",
+ "dotenv": "^16.4.5",
+ "node-cron": "^3.0.3",
+ "superjson": "2.2.1"
+ },
+ "devDependencies": {
+ "@homarr/eslint-config": "workspace:^0.2.0",
+ "@homarr/prettier-config": "workspace:^0.1.0",
+ "@homarr/tsconfig": "workspace:^0.1.0",
+ "@types/node-cron": "^3.0.11",
+ "@types/node": "^20.12.12",
+ "dotenv-cli": "^7.4.2",
+ "eslint": "^8.57.0",
+ "prettier": "^3.2.5",
+ "tsx": "4.10.5",
+ "typescript": "^5.4.5"
+ },
+ "eslintConfig": {
+ "root": true,
+ "extends": [
+ "@homarr/eslint-config/base"
+ ]
+ },
+ "prettier": "@homarr/prettier-config"
+}
diff --git a/apps/tasks/src/index.ts b/apps/tasks/src/index.ts
new file mode 100644
index 000000000..48079af2d
--- /dev/null
+++ b/apps/tasks/src/index.ts
@@ -0,0 +1,3 @@
+import { client } from "./queues";
+
+export const queueClient = client;
diff --git a/apps/tasks/src/jobs.ts b/apps/tasks/src/jobs.ts
new file mode 100644
index 000000000..39fcb0113
--- /dev/null
+++ b/apps/tasks/src/jobs.ts
@@ -0,0 +1,11 @@
+import { iconsUpdaterJob } from "~/jobs/icons-updater";
+import { queuesJob } from "./jobs/queue";
+import { createJobGroup } from "./lib/cron-job/group";
+
+export const jobs = createJobGroup({
+ // Add your jobs here:
+
+ // This job is used to process queues.
+ queues: queuesJob,
+ iconsUpdater: iconsUpdaterJob,
+});
diff --git a/apps/tasks/src/jobs/icons-updater.ts b/apps/tasks/src/jobs/icons-updater.ts
new file mode 100644
index 000000000..7fd274dd0
--- /dev/null
+++ b/apps/tasks/src/jobs/icons-updater.ts
@@ -0,0 +1,97 @@
+import { Stopwatch } from "@homarr/common";
+import type { InferInsertModel } from "@homarr/db";
+import { db, inArray } from "@homarr/db";
+import { createId } from "@homarr/db/client";
+import { iconRepositories, icons } from "@homarr/db/schema/sqlite";
+import { fetchIconsAsync } from "@homarr/icons";
+import { logger } from "@homarr/log";
+
+import { EVERY_WEEK } from "~/lib/cron-job/constants";
+import { createCronJob } from "~/lib/cron-job/creator";
+
+export const iconsUpdaterJob = createCronJob(EVERY_WEEK, {
+ runOnStart: true,
+}).withCallback(async () => {
+ logger.info("Updating icon repository cache...");
+ const stopWatch = new Stopwatch();
+ const repositoryIconGroups = await fetchIconsAsync();
+ const countIcons = repositoryIconGroups
+ .map((group) => group.icons.length)
+ .reduce((partialSum, arrayLength) => partialSum + arrayLength, 0);
+ logger.info(
+ `Successfully fetched ${countIcons} icons from ${repositoryIconGroups.length} repositories within ${stopWatch.getElapsedInHumanWords()}`,
+ );
+
+ const databaseIconGroups = await db.query.iconRepositories.findMany({
+ with: {
+ icons: true,
+ },
+ });
+
+ const skippedChecksums: string[] = [];
+ let countDeleted = 0;
+ let countInserted = 0;
+
+ logger.info("Updating icons in database...");
+ stopWatch.reset();
+
+ const newIconRepositories: InferInsertModel[] = [];
+ const newIcons: InferInsertModel[] = [];
+
+ for (const repositoryIconGroup of repositoryIconGroups) {
+ if (!repositoryIconGroup.success) {
+ continue;
+ }
+
+ const repositoryInDb = databaseIconGroups.find((dbIconGroup) => dbIconGroup.slug === repositoryIconGroup.slug);
+ const repositoryIconGroupId: string = repositoryInDb?.id ?? createId();
+ if (!repositoryInDb?.id) {
+ newIconRepositories.push({
+ id: repositoryIconGroupId,
+ slug: repositoryIconGroup.slug,
+ });
+ }
+
+ for (const icon of repositoryIconGroup.icons) {
+ if (databaseIconGroups.flatMap((group) => group.icons).some((dbIcon) => dbIcon.checksum === icon.checksum)) {
+ skippedChecksums.push(icon.checksum);
+ continue;
+ }
+
+ newIcons.push({
+ id: createId(),
+ checksum: icon.checksum,
+ name: icon.fileNameWithExtension,
+ url: icon.imageUrl.href,
+ iconRepositoryId: repositoryIconGroupId,
+ });
+ countInserted++;
+ }
+ }
+
+ const deadIcons = databaseIconGroups
+ .flatMap((group) => group.icons)
+ .filter((icon) => !skippedChecksums.includes(icon.checksum));
+
+ await db.transaction(async (transaction) => {
+ if (newIconRepositories.length >= 1) {
+ await transaction.insert(iconRepositories).values(newIconRepositories);
+ }
+
+ if (newIcons.length >= 1) {
+ await transaction.insert(icons).values(newIcons);
+ }
+ if (deadIcons.length >= 1) {
+ await transaction.delete(icons).where(
+ inArray(
+ icons.checksum,
+ deadIcons.map((icon) => icon.checksum),
+ ),
+ );
+ }
+
+ countDeleted += deadIcons.length;
+ });
+
+ logger.info(`Updated database within ${stopWatch.getElapsedInHumanWords()} (-${countDeleted}, +${countInserted})`);
+});
diff --git a/apps/tasks/src/jobs/queue.ts b/apps/tasks/src/jobs/queue.ts
new file mode 100644
index 000000000..8eeb6f4e5
--- /dev/null
+++ b/apps/tasks/src/jobs/queue.ts
@@ -0,0 +1,8 @@
+import { EVERY_MINUTE } from "../lib/cron-job/constants";
+import { createCronJob } from "../lib/cron-job/creator";
+import { queueWorkerAsync } from "../lib/queue/worker";
+
+// This job processes queues, it runs every minute.
+export const queuesJob = createCronJob(EVERY_MINUTE).withCallback(async () => {
+ await queueWorkerAsync();
+});
diff --git a/apps/tasks/src/lib/cron-job/constants.ts b/apps/tasks/src/lib/cron-job/constants.ts
new file mode 100644
index 000000000..6f40f29cc
--- /dev/null
+++ b/apps/tasks/src/lib/cron-job/constants.ts
@@ -0,0 +1,7 @@
+export const EVERY_5_SECONDS = "*/5 * * * * *";
+export const EVERY_MINUTE = "* * * * *";
+export const EVERY_5_MINUTES = "*/5 * * * *";
+export const EVERY_10_MINUTES = "*/10 * * * *";
+export const EVERY_HOUR = "0 * * * *";
+export const EVERY_DAY = "0 0 * * */1";
+export const EVERY_WEEK = "0 0 * * 1";
diff --git a/apps/tasks/src/lib/cron-job/creator.ts b/apps/tasks/src/lib/cron-job/creator.ts
new file mode 100644
index 000000000..1dcb59fcc
--- /dev/null
+++ b/apps/tasks/src/lib/cron-job/creator.ts
@@ -0,0 +1,25 @@
+import cron from "node-cron";
+
+import type { MaybePromise } from "@homarr/common/types";
+
+interface CreateCronJobOptions {
+ runOnStart?: boolean;
+}
+
+export const createCronJob = (cronExpression: string, options: CreateCronJobOptions = { runOnStart: false }) => {
+ return {
+ withCallback: (callback: () => MaybePromise) => {
+ if (options.runOnStart) {
+ void callback();
+ }
+
+ const task = cron.schedule(cronExpression, () => void callback(), {
+ scheduled: false,
+ });
+ return {
+ _expression: cronExpression,
+ _task: task,
+ };
+ },
+ };
+};
diff --git a/apps/tasks/src/lib/cron-job/group.ts b/apps/tasks/src/lib/cron-job/group.ts
new file mode 100644
index 000000000..0854259df
--- /dev/null
+++ b/apps/tasks/src/lib/cron-job/group.ts
@@ -0,0 +1,45 @@
+import { objectEntries } from "@homarr/common";
+
+import type { createCronJob } from "./creator";
+import { jobRegistry } from "./registry";
+
+type Jobs = Record["withCallback"]>>;
+
+export const createJobGroup = (jobs: TJobs) => {
+ for (const [name, job] of objectEntries(jobs)) {
+ if (typeof name !== "string") continue;
+ jobRegistry.set(name, {
+ name,
+ expression: job._expression,
+ active: false,
+ task: job._task,
+ });
+ }
+
+ return {
+ start: (name: keyof TJobs) => {
+ const job = jobRegistry.get(name as string);
+ if (!job) return;
+ job.active = true;
+ job.task.start();
+ },
+ startAll: () => {
+ for (const job of jobRegistry.values()) {
+ job.active = true;
+ job.task.start();
+ }
+ },
+ stop: (name: keyof TJobs) => {
+ const job = jobRegistry.get(name as string);
+ if (!job) return;
+ job.active = false;
+ job.task.stop();
+ },
+ stopAll: () => {
+ for (const job of jobRegistry.values()) {
+ job.active = false;
+ job.task.stop();
+ }
+ },
+ };
+};
diff --git a/apps/tasks/src/lib/cron-job/registry.ts b/apps/tasks/src/lib/cron-job/registry.ts
new file mode 100644
index 000000000..d78b4bc5a
--- /dev/null
+++ b/apps/tasks/src/lib/cron-job/registry.ts
@@ -0,0 +1,9 @@
+import type cron from "node-cron";
+
+interface Job {
+ name: string;
+ expression: string;
+ active: boolean;
+ task: cron.ScheduledTask;
+}
+export const jobRegistry = new Map();
diff --git a/apps/tasks/src/lib/queue/client.ts b/apps/tasks/src/lib/queue/client.ts
new file mode 100644
index 000000000..b67cb968d
--- /dev/null
+++ b/apps/tasks/src/lib/queue/client.ts
@@ -0,0 +1,55 @@
+import { objectEntries, objectKeys } from "@homarr/common";
+import type { MaybePromise } from "@homarr/common/types";
+import { queueChannel } from "@homarr/redis";
+import type { z } from "@homarr/validation";
+
+import type { createQueue } from "./creator";
+
+interface Queue {
+ name: string;
+ callback: (input: z.infer) => MaybePromise;
+ inputValidator: TInput;
+}
+
+type Queues = Record["withCallback"]>>;
+
+export const createQueueClient = (queues: TQueues) => {
+ const queueRegistry = new Map();
+ for (const [name, queue] of objectEntries(queues)) {
+ if (typeof name !== "string") continue;
+ queueRegistry.set(name, {
+ name,
+ callback: queue._callback,
+ inputValidator: queue._input,
+ });
+ }
+
+ return {
+ queueRegistry,
+ client: objectKeys(queues).reduce(
+ (acc, name) => {
+ acc[name] = async (data: z.infer, options) => {
+ if (typeof name !== "string") return;
+ const queue = queueRegistry.get(name);
+ if (!queue) return;
+
+ await queueChannel.addAsync({
+ name,
+ data,
+ executionDate: typeof options === "object" && options.executionDate ? options.executionDate : new Date(),
+ });
+ };
+ return acc;
+ },
+ {} as Record<
+ keyof TQueues,
+ (
+ data: z.infer,
+ props: {
+ executionDate?: Date;
+ } | void,
+ ) => Promise
+ >,
+ ),
+ };
+};
diff --git a/apps/tasks/src/lib/queue/creator.ts b/apps/tasks/src/lib/queue/creator.ts
new file mode 100644
index 000000000..47dd05226
--- /dev/null
+++ b/apps/tasks/src/lib/queue/creator.ts
@@ -0,0 +1,14 @@
+import type { z } from "zod";
+
+import type { MaybePromise } from "@homarr/common/types";
+
+export const createQueue = (input: TInput) => {
+ return {
+ withCallback: (callback: (data: z.infer) => MaybePromise) => {
+ return {
+ _input: input,
+ _callback: callback,
+ };
+ },
+ };
+};
diff --git a/apps/tasks/src/lib/queue/worker.ts b/apps/tasks/src/lib/queue/worker.ts
new file mode 100644
index 000000000..40d9dde9b
--- /dev/null
+++ b/apps/tasks/src/lib/queue/worker.ts
@@ -0,0 +1,20 @@
+import { queueChannel } from "@homarr/redis";
+
+import { queueRegistry } from "~/queues";
+
+/**
+ * This function reads all the queue executions that are due and processes them.
+ * Those executions are stored in the redis queue channel.
+ */
+export const queueWorkerAsync = async () => {
+ const now = new Date();
+ const executions = await queueChannel.filterAsync((item) => {
+ return item.executionDate < now;
+ });
+ for (const execution of executions) {
+ const queue = queueRegistry.get(execution.name);
+ if (!queue) continue;
+ await queue.callback(execution.data);
+ await queueChannel.markAsDoneAsync(execution._id);
+ }
+};
diff --git a/apps/tasks/src/main.ts b/apps/tasks/src/main.ts
new file mode 100644
index 000000000..16327cd16
--- /dev/null
+++ b/apps/tasks/src/main.ts
@@ -0,0 +1,6 @@
+import { jobs } from "./jobs";
+import { seedServerSettingsAsync } from "./seed-server-settings";
+
+jobs.startAll();
+
+void seedServerSettingsAsync();
diff --git a/apps/tasks/src/queues.ts b/apps/tasks/src/queues.ts
new file mode 100644
index 000000000..18eb5bf62
--- /dev/null
+++ b/apps/tasks/src/queues.ts
@@ -0,0 +1,7 @@
+import { createQueueClient } from "./lib/queue/client";
+import { testQueue } from "./queues/test";
+
+export const { client, queueRegistry } = createQueueClient({
+ // Add your queues here
+ test: testQueue,
+});
diff --git a/apps/tasks/src/queues/test.ts b/apps/tasks/src/queues/test.ts
new file mode 100644
index 000000000..f6d7019bd
--- /dev/null
+++ b/apps/tasks/src/queues/test.ts
@@ -0,0 +1,11 @@
+import { z } from "@homarr/validation";
+
+import { createQueue } from "~/lib/queue/creator";
+
+export const testQueue = createQueue(
+ z.object({
+ id: z.string(),
+ }),
+).withCallback(({ id }) => {
+ console.log(`Test queue with id ${id}`);
+});
diff --git a/apps/tasks/src/seed-server-settings.ts b/apps/tasks/src/seed-server-settings.ts
new file mode 100644
index 000000000..885d4e64c
--- /dev/null
+++ b/apps/tasks/src/seed-server-settings.ts
@@ -0,0 +1,28 @@
+import SuperJSON from "superjson";
+
+import { db } from "@homarr/db";
+import { serverSettings } from "@homarr/db/schema/sqlite";
+import { logger } from "@homarr/log";
+
+import { defaultServerSettings, defaultServerSettingsKeys } from "../../../packages/server-settings";
+
+export const seedServerSettingsAsync = async () => {
+ const serverSettingsData = await db.query.serverSettings.findMany();
+ let insertedSettingsCount = 0;
+
+ for (const settingsKey of defaultServerSettingsKeys) {
+ if (serverSettingsData.some((setting) => setting.settingKey === settingsKey)) {
+ return;
+ }
+
+ await db.insert(serverSettings).values({
+ settingKey: settingsKey,
+ value: SuperJSON.stringify(defaultServerSettings[settingsKey]),
+ });
+ insertedSettingsCount++;
+ }
+
+ if (insertedSettingsCount > 0) {
+ logger.info(`Inserted ${insertedSettingsCount} missing settings`);
+ }
+};
diff --git a/apps/tasks/tsconfig.json b/apps/tasks/tsconfig.json
new file mode 100644
index 000000000..632d413db
--- /dev/null
+++ b/apps/tasks/tsconfig.json
@@ -0,0 +1,12 @@
+{
+ "extends": "@homarr/tsconfig/base.json",
+ "compilerOptions": {
+ "baseUrl": ".",
+ "paths": {
+ "~/*": ["src/*"]
+ },
+ "tsBuildInfoFile": "node_modules/.cache/tsbuildinfo.json"
+ },
+ "include": ["."],
+ "exclude": ["node_modules"]
+}
diff --git a/apps/websocket/package.json b/apps/websocket/package.json
new file mode 100644
index 000000000..e9d856950
--- /dev/null
+++ b/apps/websocket/package.json
@@ -0,0 +1,46 @@
+{
+ "name": "@homarr/websocket",
+ "version": "0.1.0",
+ "private": true,
+ "main": "./src/main.ts",
+ "types": "./src/main.ts",
+ "license": "MIT",
+ "type": "module",
+ "scripts": {
+ "dev": "pnpm with-env tsx ./src/main.ts",
+ "build": "esbuild src/main.ts --bundle --platform=node --outfile=wssServer.cjs --external:bcrypt --loader:.html=text",
+ "clean": "rm -rf .turbo node_modules",
+ "lint": "eslint .",
+ "format": "prettier --check . --ignore-path ../../.gitignore",
+ "typecheck": "tsc --noEmit",
+ "with-env": "dotenv -e ../../.env --"
+ },
+ "dependencies": {
+ "@homarr/api": "workspace:^0.1.0",
+ "@homarr/auth": "workspace:^0.1.0",
+ "@homarr/common": "workspace:^0.1.0",
+ "@homarr/db": "workspace:^0.1.0",
+ "@homarr/definitions": "workspace:^0.1.0",
+ "@homarr/log": "workspace:^",
+ "@homarr/redis": "workspace:^0.1.0",
+ "@homarr/validation": "workspace:^0.1.0",
+ "ws": "^8.17.0",
+ "dotenv": "^16.4.5"
+ },
+ "devDependencies": {
+ "@homarr/eslint-config": "workspace:^0.2.0",
+ "@homarr/prettier-config": "workspace:^0.1.0",
+ "@homarr/tsconfig": "workspace:^0.1.0",
+ "@types/ws": "^8.5.10",
+ "eslint": "^8.57.0",
+ "prettier": "^3.2.5",
+ "typescript": "^5.4.5"
+ },
+ "eslintConfig": {
+ "root": true,
+ "extends": [
+ "@homarr/eslint-config/base"
+ ]
+ },
+ "prettier": "@homarr/prettier-config"
+}
diff --git a/apps/websocket/src/main.ts b/apps/websocket/src/main.ts
new file mode 100644
index 000000000..ee742c58c
--- /dev/null
+++ b/apps/websocket/src/main.ts
@@ -0,0 +1,56 @@
+import { applyWSSHandler } from "@trpc/server/adapters/ws";
+import { WebSocketServer } from "ws";
+
+import { appRouter, createTRPCContext } from "@homarr/api/websocket";
+import { getSessionFromToken, sessionTokenCookieName } from "@homarr/auth";
+import { parseCookies } from "@homarr/common";
+import { db } from "@homarr/db";
+import { logger } from "@homarr/log";
+
+const wss = new WebSocketServer({
+ port: 3001,
+});
+const handler = applyWSSHandler({
+ wss,
+ router: appRouter,
+ // ignore error on next line because the createContext must be set with this name
+ // eslint-disable-next-line no-restricted-syntax
+ createContext: async ({ req }) => {
+ try {
+ const headers = Object.entries(req.headers).map(
+ ([key, value]) => [key, typeof value === "string" ? value : value?.[0]] as [string, string],
+ );
+ const nextHeaders = new Headers(headers);
+
+ const store = parseCookies(nextHeaders.get("cookie") ?? "");
+ const sessionToken = store[sessionTokenCookieName];
+
+ const session = await getSessionFromToken(db, sessionToken);
+
+ return createTRPCContext({
+ headers: nextHeaders,
+ session,
+ });
+ } catch (error) {
+ logger.error(error);
+ return createTRPCContext({
+ headers: new Headers(),
+ session: null,
+ });
+ }
+ },
+});
+
+wss.on("connection", (websocket, incomingMessage) => {
+ logger.info(`âž• Connection (${wss.clients.size}) ${incomingMessage.method} ${incomingMessage.url}`);
+ websocket.once("close", (code, reason) => {
+ logger.info(`âž– Connection (${wss.clients.size}) ${code} ${reason.toString()}`);
+ });
+});
+logger.info("✅ WebSocket Server listening on ws://localhost:3001");
+
+process.on("SIGTERM", () => {
+ logger.info("SIGTERM");
+ handler.broadcastReconnectNotification();
+ wss.close();
+});
diff --git a/apps/websocket/tsconfig.json b/apps/websocket/tsconfig.json
new file mode 100644
index 000000000..632d413db
--- /dev/null
+++ b/apps/websocket/tsconfig.json
@@ -0,0 +1,12 @@
+{
+ "extends": "@homarr/tsconfig/base.json",
+ "compilerOptions": {
+ "baseUrl": ".",
+ "paths": {
+ "~/*": ["src/*"]
+ },
+ "tsBuildInfoFile": "node_modules/.cache/tsbuildinfo.json"
+ },
+ "include": ["."],
+ "exclude": ["node_modules"]
+}
diff --git a/development/build.cmd b/development/build.cmd
new file mode 100644
index 000000000..88679ba0c
--- /dev/null
+++ b/development/build.cmd
@@ -0,0 +1 @@
+docker build -t homarr .
\ No newline at end of file
diff --git a/development/development.docker-compose.yml b/development/development.docker-compose.yml
new file mode 100644
index 000000000..9e8557808
--- /dev/null
+++ b/development/development.docker-compose.yml
@@ -0,0 +1,14 @@
+############################
+#
+# This compose file is only for development.
+# Do not use this in production.
+#
+############################
+
+name: development-docker-compose
+services:
+ redis:
+ container_name: redis
+ image: redis
+ ports:
+ - "6379:6379"
\ No newline at end of file
diff --git a/development/docker-run.cmd b/development/docker-run.cmd
new file mode 100644
index 000000000..36d3c7510
--- /dev/null
+++ b/development/docker-run.cmd
@@ -0,0 +1 @@
+docker run -p 3000:3000 -p 3001:3001 homarr:latest
\ No newline at end of file
diff --git a/package.json b/package.json
index 418c398e4..f45201e39 100644
--- a/package.json
+++ b/package.json
@@ -2,35 +2,49 @@
"name": "homarr",
"private": true,
"engines": {
- "node": ">=18.18.2"
+ "node": ">=20.13.1"
},
- "packageManager": "pnpm@8.11.0",
+ "packageManager": "pnpm@9.1.1",
"scripts": {
"build": "turbo build",
"clean": "git clean -xdf node_modules",
"clean:workspaces": "turbo clean",
- "postinstall": "pnpm lint:ws",
- "db:push": "pnpm -F db push",
+ "db:push": "pnpm -F db push:sqlite",
"db:studio": "pnpm -F db studio",
+ "db:migration:sqlite:generate": "pnpm -F db migration:sqlite:generate",
+ "db:migration:mysql:generate": "pnpm -F db migration:mysql:generate",
+ "db:migration:sqlite:run": "pnpm -F db migration:sqlite:run",
+ "db:migration:mysql:run": "pnpm -F db migration:mysql:run",
"dev": "turbo dev --parallel",
+ "docker:dev": "docker compose -f ./development/development.docker-compose.yml up",
"format": "turbo format --continue -- --cache --cache-location node_modules/.cache/.prettiercache",
"format:fix": "turbo format --continue -- --write --cache --cache-location node_modules/.cache/.prettiercache",
"lint": "turbo lint --continue -- --cache --cache-location node_modules/.cache/.eslintcache",
"lint:fix": "turbo lint --continue -- --fix --cache --cache-location node_modules/.cache/.eslintcache",
"lint:ws": "pnpm dlx sherif@latest",
+ "test": "cross-env NODE_ENV=development vitest run --coverage.enabled",
+ "test:ui": "cross-env NODE_ENV=development vitest --ui --coverage.enabled",
"typecheck": "turbo typecheck"
},
"devDependencies": {
"@homarr/prettier-config": "workspace:^0.1.0",
- "@turbo/gen": "^1.10.16",
- "prettier": "^3.1.0",
- "turbo": "^1.10.16",
- "typescript": "^5.3.3"
+ "@turbo/gen": "^1.13.3",
+ "@vitejs/plugin-react": "^4.2.1",
+ "@vitest/coverage-v8": "^1.6.0",
+ "@vitest/ui": "^1.6.0",
+ "cross-env": "^7.0.3",
+ "jsdom": "^24.0.0",
+ "prettier": "^3.2.5",
+ "turbo": "^1.13.3",
+ "typescript": "^5.4.5",
+ "vite-tsconfig-paths": "^4.3.2",
+ "vitest": "^1.6.0"
},
- "pnpm": {
- "overrides": {
- "@auth/core": "0.18.0"
- }
+ "dependencies": {
+ "@mantine/core": "^7.9.2",
+ "@mantine/dates": "^7.9.2",
+ "@tabler/icons-react": "^3.5.0",
+ "mantine-react-table": "2.0.0-beta.3"
},
"prettier": "@homarr/prettier-config"
}
\ No newline at end of file
diff --git a/packages/api/index.ts b/packages/api/index.ts
deleted file mode 100644
index 639e50c04..000000000
--- a/packages/api/index.ts
+++ /dev/null
@@ -1,18 +0,0 @@
-import type { inferRouterInputs, inferRouterOutputs } from "@trpc/server";
-
-import type { AppRouter } from "./src/root";
-
-export { appRouter, type AppRouter } from "./src/root";
-export { createTRPCContext } from "./src/trpc";
-
-/**
- * Inference helpers for input types
- * @example type HelloInput = RouterInputs['example']['hello']
- **/
-export type RouterInputs = inferRouterInputs;
-
-/**
- * Inference helpers for output types
- * @example type HelloOutput = RouterOutputs['example']['hello']
- **/
-export type RouterOutputs = inferRouterOutputs;
diff --git a/packages/api/package.json b/packages/api/package.json
index e281c5ad1..52fd9fb21 100644
--- a/packages/api/package.json
+++ b/packages/api/package.json
@@ -1,10 +1,17 @@
{
"name": "@homarr/api",
"version": "0.1.0",
+ "exports": {
+ ".": "./src/index.ts",
+ "./client": "./src/client.ts",
+ "./server": "./src/server.ts",
+ "./websocket": "./src/websocket.ts"
+ },
"private": true,
"main": "./index.ts",
"types": "./index.ts",
"license": "MIT",
+ "type": "module",
"scripts": {
"clean": "rm -rf .turbo node_modules",
"lint": "eslint .",
@@ -13,9 +20,14 @@
},
"dependencies": {
"@homarr/auth": "workspace:^0.1.0",
- "@homarr/definitions": "workspace:^0.1.0",
+ "@homarr/common": "workspace:^0.1.0",
"@homarr/db": "workspace:^0.1.0",
+ "@homarr/definitions": "workspace:^0.1.0",
+ "@homarr/log": "workspace:^",
+ "@homarr/redis": "workspace:^0.1.0",
+ "@homarr/tasks": "workspace:^0.1.0",
"@homarr/validation": "workspace:^0.1.0",
+ "@homarr/server-settings": "workspace:^0.1.0",
"@trpc/client": "next",
"@trpc/server": "next",
"superjson": "2.2.1"
@@ -24,9 +36,9 @@
"@homarr/eslint-config": "workspace:^0.2.0",
"@homarr/prettier-config": "workspace:^0.1.0",
"@homarr/tsconfig": "workspace:^0.1.0",
- "eslint": "^8.56.0",
- "prettier": "^3.1.0",
- "typescript": "^5.3.3"
+ "eslint": "^8.57.0",
+ "prettier": "^3.2.5",
+ "typescript": "^5.4.5"
},
"eslintConfig": {
"root": true,
diff --git a/packages/api/src/client.ts b/packages/api/src/client.ts
new file mode 100644
index 000000000..48f89771d
--- /dev/null
+++ b/packages/api/src/client.ts
@@ -0,0 +1,5 @@
+import { createTRPCReact } from "@trpc/react-query";
+
+import type { AppRouter } from ".";
+
+export const clientApi = createTRPCReact();
diff --git a/packages/api/src/index.ts b/packages/api/src/index.ts
new file mode 100644
index 000000000..1cbe6fdd7
--- /dev/null
+++ b/packages/api/src/index.ts
@@ -0,0 +1,33 @@
+import type { inferRouterInputs, inferRouterOutputs } from "@trpc/server";
+
+import type { AppRouter } from "./root";
+import { appRouter } from "./root";
+import { createCallerFactory, createTRPCContext } from "./trpc";
+
+/**
+ * Create a server-side caller for the tRPC API
+ * @example
+ * const trpc = createCaller(createContext);
+ * const res = await trpc.post.all();
+ * ^? Post[]
+ */
+const createCaller = createCallerFactory(appRouter);
+
+/**
+ * Inference helpers for input types
+ * @example
+ * type PostByIdInput = RouterInputs['post']['byId']
+ * ^? { id: number }
+ **/
+type RouterInputs = inferRouterInputs;
+
+/**
+ * Inference helpers for output types
+ * @example
+ * type AllPostsOutput = RouterOutputs['post']['all']
+ * ^? Post[]
+ **/
+type RouterOutputs = inferRouterOutputs;
+
+export { createTRPCContext, appRouter, createCaller };
+export type { AppRouter, RouterInputs, RouterOutputs };
diff --git a/packages/api/src/root.ts b/packages/api/src/root.ts
index f0b54cfc8..1395b871e 100644
--- a/packages/api/src/root.ts
+++ b/packages/api/src/root.ts
@@ -1,10 +1,30 @@
+import { appRouter as innerAppRouter } from "./router/app";
+import { boardRouter } from "./router/board";
+import { groupRouter } from "./router/group";
+import { homeRouter } from "./router/home";
+import { iconsRouter } from "./router/icons";
import { integrationRouter } from "./router/integration";
+import { inviteRouter } from "./router/invite";
+import { locationRouter } from "./router/location";
+import { logRouter } from "./router/log";
+import { serverSettingsRouter } from "./router/serverSettings";
import { userRouter } from "./router/user";
+import { widgetRouter } from "./router/widgets";
import { createTRPCRouter } from "./trpc";
export const appRouter = createTRPCRouter({
user: userRouter,
+ group: groupRouter,
+ invite: inviteRouter,
integration: integrationRouter,
+ board: boardRouter,
+ app: innerAppRouter,
+ widget: widgetRouter,
+ location: locationRouter,
+ log: logRouter,
+ icon: iconsRouter,
+ home: homeRouter,
+ serverSettings: serverSettingsRouter,
});
// export type definition of API
diff --git a/packages/api/src/router/app.ts b/packages/api/src/router/app.ts
new file mode 100644
index 000000000..38171a946
--- /dev/null
+++ b/packages/api/src/router/app.ts
@@ -0,0 +1,73 @@
+import { TRPCError } from "@trpc/server";
+
+import { asc, createId, eq } from "@homarr/db";
+import { apps } from "@homarr/db/schema/sqlite";
+import { validation } from "@homarr/validation";
+
+import { createTRPCRouter, publicProcedure } from "../trpc";
+
+export const appRouter = createTRPCRouter({
+ all: publicProcedure.query(async ({ ctx }) => {
+ return await ctx.db.query.apps.findMany({
+ orderBy: asc(apps.name),
+ });
+ }),
+ selectable: publicProcedure.query(async ({ ctx }) => {
+ return await ctx.db.query.apps.findMany({
+ columns: {
+ id: true,
+ name: true,
+ iconUrl: true,
+ },
+ orderBy: asc(apps.name),
+ });
+ }),
+ byId: publicProcedure.input(validation.app.byId).query(async ({ ctx, input }) => {
+ const app = await ctx.db.query.apps.findFirst({
+ where: eq(apps.id, input.id),
+ });
+
+ if (!app) {
+ throw new TRPCError({
+ code: "NOT_FOUND",
+ message: "App not found",
+ });
+ }
+
+ return app;
+ }),
+ create: publicProcedure.input(validation.app.manage).mutation(async ({ ctx, input }) => {
+ await ctx.db.insert(apps).values({
+ id: createId(),
+ name: input.name,
+ description: input.description,
+ iconUrl: input.iconUrl,
+ href: input.href,
+ });
+ }),
+ update: publicProcedure.input(validation.app.edit).mutation(async ({ ctx, input }) => {
+ const app = await ctx.db.query.apps.findFirst({
+ where: eq(apps.id, input.id),
+ });
+
+ if (!app) {
+ throw new TRPCError({
+ code: "NOT_FOUND",
+ message: "App not found",
+ });
+ }
+
+ await ctx.db
+ .update(apps)
+ .set({
+ name: input.name,
+ description: input.description,
+ iconUrl: input.iconUrl,
+ href: input.href,
+ })
+ .where(eq(apps.id, input.id));
+ }),
+ delete: publicProcedure.input(validation.app.byId).mutation(async ({ ctx, input }) => {
+ await ctx.db.delete(apps).where(eq(apps.id, input.id));
+ }),
+});
diff --git a/packages/api/src/router/board.ts b/packages/api/src/router/board.ts
new file mode 100644
index 000000000..c37e92c57
--- /dev/null
+++ b/packages/api/src/router/board.ts
@@ -0,0 +1,551 @@
+import { TRPCError } from "@trpc/server";
+import superjson from "superjson";
+
+import type { Database, SQL } from "@homarr/db";
+import { and, createId, eq, inArray, or } from "@homarr/db";
+import {
+ boardGroupPermissions,
+ boards,
+ boardUserPermissions,
+ groupMembers,
+ groupPermissions,
+ integrationItems,
+ items,
+ sections,
+ users,
+} from "@homarr/db/schema/sqlite";
+import type { WidgetKind } from "@homarr/definitions";
+import { getPermissionsWithParents, widgetKinds } from "@homarr/definitions";
+import type { BoardItemAdvancedOptions } from "@homarr/validation";
+import { createSectionSchema, sharedItemSchema, validation, z } from "@homarr/validation";
+
+import { zodUnionFromArray } from "../../../validation/src/enums";
+import { createTRPCRouter, permissionRequiredProcedure, protectedProcedure, publicProcedure } from "../trpc";
+import { throwIfActionForbiddenAsync } from "./board/board-access";
+
+export const boardRouter = createTRPCRouter({
+ getAllBoards: publicProcedure.query(async ({ ctx }) => {
+ const userId = ctx.session?.user.id;
+ const permissionsOfCurrentUserWhenPresent = await ctx.db.query.boardUserPermissions.findMany({
+ where: eq(boardUserPermissions.userId, userId ?? ""),
+ });
+
+ const permissionsOfCurrentUserGroupsWhenPresent = await ctx.db.query.groupMembers.findMany({
+ where: eq(groupMembers.userId, userId ?? ""),
+ with: {
+ group: {
+ with: {
+ boardPermissions: {},
+ },
+ },
+ },
+ });
+ const boardIds = permissionsOfCurrentUserWhenPresent
+ .map((permission) => permission.boardId)
+ .concat(
+ permissionsOfCurrentUserGroupsWhenPresent
+ .map((groupMember) => groupMember.group.boardPermissions.map((permission) => permission.boardId))
+ .flat(),
+ );
+
+ const currentUserWhenPresent = await ctx.db.query.users.findFirst({
+ where: eq(users.id, userId ?? ""),
+ });
+
+ const dbBoards = await ctx.db.query.boards.findMany({
+ columns: {
+ id: true,
+ name: true,
+ isPublic: true,
+ },
+ with: {
+ creator: {
+ columns: {
+ id: true,
+ name: true,
+ image: true,
+ },
+ },
+ userPermissions: {
+ where: eq(boardUserPermissions.userId, ctx.session?.user.id ?? ""),
+ },
+ groupPermissions: {
+ where:
+ permissionsOfCurrentUserGroupsWhenPresent.length >= 1
+ ? inArray(
+ boardGroupPermissions.groupId,
+ permissionsOfCurrentUserGroupsWhenPresent.map((groupMember) => groupMember.groupId),
+ )
+ : undefined,
+ },
+ },
+ // Allow viewing all boards if the user has the permission
+ where: ctx.session?.user.permissions.includes("board-view-all")
+ ? undefined
+ : or(
+ eq(boards.isPublic, true),
+ eq(boards.creatorId, ctx.session?.user.id ?? ""),
+ boardIds.length > 0 ? inArray(boards.id, boardIds) : undefined,
+ ),
+ });
+ return dbBoards.map((board) => ({
+ ...board,
+ isHome: currentUserWhenPresent?.homeBoardId === board.id,
+ }));
+ }),
+ createBoard: permissionRequiredProcedure
+ .requiresPermission("board-create")
+ .input(validation.board.create)
+ .mutation(async ({ ctx, input }) => {
+ const boardId = createId();
+ await ctx.db.transaction(async (transaction) => {
+ await transaction.insert(boards).values({
+ id: boardId,
+ name: input.name,
+ creatorId: ctx.session.user.id,
+ });
+ await transaction.insert(sections).values({
+ id: createId(),
+ kind: "empty",
+ position: 0,
+ boardId,
+ });
+ });
+ }),
+ renameBoard: protectedProcedure.input(validation.board.rename).mutation(async ({ ctx, input }) => {
+ await throwIfActionForbiddenAsync(ctx, eq(boards.id, input.id), "full-access");
+
+ await noBoardWithSimilarNameAsync(ctx.db, input.name, [input.id]);
+
+ await ctx.db.update(boards).set({ name: input.name }).where(eq(boards.id, input.id));
+ }),
+ changeBoardVisibility: protectedProcedure
+ .input(validation.board.changeVisibility)
+ .mutation(async ({ ctx, input }) => {
+ await throwIfActionForbiddenAsync(ctx, eq(boards.id, input.id), "full-access");
+
+ await ctx.db
+ .update(boards)
+ .set({ isPublic: input.visibility === "public" })
+ .where(eq(boards.id, input.id));
+ }),
+ deleteBoard: protectedProcedure.input(z.object({ id: z.string() })).mutation(async ({ ctx, input }) => {
+ await throwIfActionForbiddenAsync(ctx, eq(boards.id, input.id), "full-access");
+
+ await ctx.db.delete(boards).where(eq(boards.id, input.id));
+ }),
+ setHomeBoard: protectedProcedure.input(z.object({ id: z.string() })).mutation(async ({ ctx, input }) => {
+ await throwIfActionForbiddenAsync(ctx, eq(boards.id, input.id), "board-view");
+
+ await ctx.db.update(users).set({ homeBoardId: input.id }).where(eq(users.id, ctx.session.user.id));
+ }),
+ getHomeBoard: publicProcedure.query(async ({ ctx }) => {
+ const userId = ctx.session?.user.id;
+ const user = userId
+ ? await ctx.db.query.users.findFirst({
+ where: eq(users.id, userId),
+ })
+ : null;
+
+ const boardWhere = user?.homeBoardId ? eq(boards.id, user.homeBoardId) : eq(boards.name, "home");
+ await throwIfActionForbiddenAsync(ctx, boardWhere, "board-view");
+
+ return await getFullBoardWithWhereAsync(ctx.db, boardWhere, ctx.session?.user.id ?? null);
+ }),
+ getBoardByName: publicProcedure.input(validation.board.byName).query(async ({ input, ctx }) => {
+ const boardWhere = eq(boards.name, input.name);
+ await throwIfActionForbiddenAsync(ctx, boardWhere, "board-view");
+
+ return await getFullBoardWithWhereAsync(ctx.db, boardWhere, ctx.session?.user.id ?? null);
+ }),
+ savePartialBoardSettings: protectedProcedure
+ .input(validation.board.savePartialSettings.and(z.object({ id: z.string() })))
+ .mutation(async ({ ctx, input }) => {
+ await throwIfActionForbiddenAsync(ctx, eq(boards.id, input.id), "board-change");
+
+ await ctx.db
+ .update(boards)
+ .set({
+ // general settings
+ pageTitle: input.pageTitle,
+ metaTitle: input.metaTitle,
+ logoImageUrl: input.logoImageUrl,
+ faviconImageUrl: input.faviconImageUrl,
+
+ // background settings
+ backgroundImageUrl: input.backgroundImageUrl,
+ backgroundImageAttachment: input.backgroundImageAttachment,
+ backgroundImageRepeat: input.backgroundImageRepeat,
+ backgroundImageSize: input.backgroundImageSize,
+
+ // color settings
+ primaryColor: input.primaryColor,
+ secondaryColor: input.secondaryColor,
+ opacity: input.opacity,
+
+ // custom css
+ customCss: input.customCss,
+
+ // layout settings
+ columnCount: input.columnCount,
+ })
+ .where(eq(boards.id, input.id));
+ }),
+ saveBoard: protectedProcedure.input(validation.board.save).mutation(async ({ input, ctx }) => {
+ await throwIfActionForbiddenAsync(ctx, eq(boards.id, input.id), "board-change");
+
+ await ctx.db.transaction(async (transaction) => {
+ const dbBoard = await getFullBoardWithWhereAsync(transaction, eq(boards.id, input.id), ctx.session.user.id);
+
+ const addedSections = filterAddedItems(input.sections, dbBoard.sections);
+
+ if (addedSections.length > 0) {
+ await transaction.insert(sections).values(
+ addedSections.map((section) => ({
+ id: section.id,
+ kind: section.kind,
+ position: section.position,
+ name: "name" in section ? section.name : null,
+ boardId: dbBoard.id,
+ })),
+ );
+ }
+
+ const inputItems = input.sections.flatMap((section) =>
+ section.items.map((item) => ({ ...item, sectionId: section.id })),
+ );
+ const dbItems = dbBoard.sections.flatMap((section) =>
+ section.items.map((item) => ({ ...item, sectionId: section.id })),
+ );
+
+ const addedItems = filterAddedItems(inputItems, dbItems);
+
+ if (addedItems.length > 0) {
+ await transaction.insert(items).values(
+ addedItems.map((item) => ({
+ id: item.id,
+ kind: item.kind,
+ height: item.height,
+ width: item.width,
+ xOffset: item.xOffset,
+ yOffset: item.yOffset,
+ options: superjson.stringify(item.options),
+ advancedOptions: superjson.stringify(item.advancedOptions),
+ sectionId: item.sectionId,
+ })),
+ );
+ }
+
+ const inputIntegrationRelations = inputItems.flatMap(({ integrations, id: itemId }) =>
+ integrations.map((integration) => ({
+ integrationId: integration.id,
+ itemId,
+ })),
+ );
+ const dbIntegrationRelations = dbItems.flatMap(({ integrations, id: itemId }) =>
+ integrations.map((integration) => ({
+ integrationId: integration.id,
+ itemId,
+ })),
+ );
+ const addedIntegrationRelations = inputIntegrationRelations.filter(
+ (inputRelation) =>
+ !dbIntegrationRelations.some(
+ (dbRelation) =>
+ dbRelation.itemId === inputRelation.itemId && dbRelation.integrationId === inputRelation.integrationId,
+ ),
+ );
+
+ if (addedIntegrationRelations.length > 0) {
+ await transaction.insert(integrationItems).values(
+ addedIntegrationRelations.map((relation) => ({
+ itemId: relation.itemId,
+ integrationId: relation.integrationId,
+ })),
+ );
+ }
+
+ const updatedItems = filterUpdatedItems(inputItems, dbItems);
+
+ for (const item of updatedItems) {
+ await transaction
+ .update(items)
+ .set({
+ kind: item.kind,
+ height: item.height,
+ width: item.width,
+ xOffset: item.xOffset,
+ yOffset: item.yOffset,
+ options: superjson.stringify(item.options),
+ sectionId: item.sectionId,
+ })
+ .where(eq(items.id, item.id));
+ }
+
+ const updatedSections = filterUpdatedItems(input.sections, dbBoard.sections);
+
+ for (const section of updatedSections) {
+ const prev = dbBoard.sections.find((dbSection) => dbSection.id === section.id);
+ await transaction
+ .update(sections)
+ .set({
+ position: section.position,
+ name: prev?.kind === "category" && "name" in section ? section.name : null,
+ })
+ .where(eq(sections.id, section.id));
+ }
+
+ const removedIntegrationRelations = dbIntegrationRelations.filter(
+ (dbRelation) =>
+ !inputIntegrationRelations.some(
+ (inputRelation) =>
+ dbRelation.itemId === inputRelation.itemId && dbRelation.integrationId === inputRelation.integrationId,
+ ),
+ );
+
+ for (const relation of removedIntegrationRelations) {
+ await transaction
+ .delete(integrationItems)
+ .where(
+ and(
+ eq(integrationItems.itemId, relation.itemId),
+ eq(integrationItems.integrationId, relation.integrationId),
+ ),
+ );
+ }
+
+ const removedItems = filterRemovedItems(inputItems, dbItems);
+
+ const itemIds = removedItems.map((item) => item.id);
+ if (itemIds.length > 0) {
+ await transaction.delete(items).where(inArray(items.id, itemIds));
+ }
+
+ const removedSections = filterRemovedItems(input.sections, dbBoard.sections);
+ const sectionIds = removedSections.map((section) => section.id);
+
+ if (sectionIds.length > 0) {
+ await transaction.delete(sections).where(inArray(sections.id, sectionIds));
+ }
+ });
+ }),
+
+ getBoardPermissions: protectedProcedure.input(validation.board.permissions).query(async ({ input, ctx }) => {
+ await throwIfActionForbiddenAsync(ctx, eq(boards.id, input.id), "full-access");
+
+ const dbGroupPermissions = await ctx.db.query.groupPermissions.findMany({
+ where: inArray(
+ groupPermissions.permission,
+ getPermissionsWithParents(["board-view-all", "board-modify-all", "board-full-access"]),
+ ),
+ columns: {
+ groupId: false,
+ },
+ with: {
+ group: {
+ columns: {
+ id: true,
+ name: true,
+ },
+ },
+ },
+ });
+
+ const userPermissions = await ctx.db.query.boardUserPermissions.findMany({
+ where: eq(boardUserPermissions.boardId, input.id),
+ with: {
+ user: {
+ columns: {
+ id: true,
+ name: true,
+ image: true,
+ },
+ },
+ },
+ });
+
+ const dbGroupBoardPermission = await ctx.db.query.boardGroupPermissions.findMany({
+ where: eq(boardGroupPermissions.boardId, input.id),
+ with: {
+ group: {
+ columns: {
+ id: true,
+ name: true,
+ },
+ },
+ },
+ });
+
+ return {
+ inherited: dbGroupPermissions.sort((permissionA, permissionB) => {
+ return permissionA.group.name.localeCompare(permissionB.group.name);
+ }),
+ userPermissions: userPermissions
+ .map(({ user, permission }) => ({
+ user,
+ permission,
+ }))
+ .sort((permissionA, permissionB) => {
+ return (permissionA.user.name ?? "").localeCompare(permissionB.user.name ?? "");
+ }),
+ groupPermissions: dbGroupBoardPermission
+ .map(({ group, permission }) => ({
+ group: {
+ id: group.id,
+ name: group.name,
+ },
+ permission,
+ }))
+ .sort((permissionA, permissionB) => {
+ return permissionA.group.name.localeCompare(permissionB.group.name);
+ }),
+ };
+ }),
+ saveUserBoardPermissions: protectedProcedure
+ .input(validation.board.savePermissions)
+ .mutation(async ({ input, ctx }) => {
+ await throwIfActionForbiddenAsync(ctx, eq(boards.id, input.id), "full-access");
+
+ await ctx.db.transaction(async (transaction) => {
+ await transaction.delete(boardUserPermissions).where(eq(boardUserPermissions.boardId, input.id));
+ if (input.permissions.length === 0) {
+ return;
+ }
+ await transaction.insert(boardUserPermissions).values(
+ input.permissions.map((permission) => ({
+ userId: permission.itemId,
+ permission: permission.permission,
+ boardId: input.id,
+ })),
+ );
+ });
+ }),
+ saveGroupBoardPermissions: protectedProcedure
+ .input(validation.board.savePermissions)
+ .mutation(async ({ input, ctx }) => {
+ await throwIfActionForbiddenAsync(ctx, eq(boards.id, input.id), "full-access");
+
+ await ctx.db.transaction(async (transaction) => {
+ await transaction.delete(boardGroupPermissions).where(eq(boardGroupPermissions.boardId, input.id));
+ if (input.permissions.length === 0) {
+ return;
+ }
+ await transaction.insert(boardGroupPermissions).values(
+ input.permissions.map((permission) => ({
+ groupId: permission.itemId,
+ permission: permission.permission,
+ boardId: input.id,
+ })),
+ );
+ });
+ }),
+});
+
+const noBoardWithSimilarNameAsync = async (db: Database, name: string, ignoredIds: string[] = []) => {
+ const boards = await db.query.boards.findMany({
+ columns: {
+ id: true,
+ name: true,
+ },
+ });
+
+ const board = boards.find(
+ (board) => board.name.toLowerCase() === name.toLowerCase() && !ignoredIds.includes(board.id),
+ );
+
+ if (board) {
+ throw new TRPCError({
+ code: "CONFLICT",
+ message: "Board with similar name already exists",
+ });
+ }
+};
+
+const getFullBoardWithWhereAsync = async (db: Database, where: SQL, userId: string | null) => {
+ const groupsOfCurrentUser = await db.query.groupMembers.findMany({
+ where: eq(groupMembers.userId, userId ?? ""),
+ });
+ const board = await db.query.boards.findFirst({
+ where,
+ with: {
+ creator: {
+ columns: {
+ id: true,
+ name: true,
+ image: true,
+ },
+ },
+ sections: {
+ with: {
+ items: {
+ with: {
+ integrations: {
+ with: {
+ integration: true,
+ },
+ },
+ },
+ },
+ },
+ },
+ userPermissions: {
+ where: eq(boardUserPermissions.userId, userId ?? ""),
+ columns: {
+ permission: true,
+ },
+ },
+ groupPermissions: {
+ where: inArray(boardGroupPermissions.groupId, groupsOfCurrentUser.map((group) => group.groupId).concat("")),
+ },
+ },
+ });
+
+ if (!board) {
+ throw new TRPCError({
+ code: "NOT_FOUND",
+ message: "Board not found",
+ });
+ }
+
+ const { sections, ...otherBoardProperties } = board;
+
+ return {
+ ...otherBoardProperties,
+ sections: sections.map((section) =>
+ parseSection({
+ ...section,
+ items: section.items.map((item) => ({
+ ...item,
+ integrations: item.integrations.map((item) => item.integration),
+ advancedOptions: superjson.parse(item.advancedOptions),
+ options: superjson.parse>(item.options),
+ })),
+ }),
+ ),
+ };
+};
+
+const forKind = (kind: T) =>
+ z.object({
+ kind: z.literal(kind),
+ options: z.record(z.unknown()),
+ });
+
+const outputItemSchema = zodUnionFromArray(widgetKinds.map((kind) => forKind(kind))).and(sharedItemSchema);
+
+const parseSection = (section: unknown) => {
+ const result = createSectionSchema(outputItemSchema).safeParse(section);
+ if (!result.success) {
+ throw new Error(result.error.message);
+ }
+ return result.data;
+};
+
+const filterAddedItems = (inputArray: TInput[], dbArray: TInput[]) =>
+ inputArray.filter((inputItem) => !dbArray.some((dbItem) => dbItem.id === inputItem.id));
+
+const filterRemovedItems = (inputArray: TInput[], dbArray: TInput[]) =>
+ dbArray.filter((dbItem) => !inputArray.some((inputItem) => dbItem.id === inputItem.id));
+
+const filterUpdatedItems = (inputArray: TInput[], dbArray: TInput[]) =>
+ inputArray.filter((inputItem) => dbArray.some((dbItem) => dbItem.id === inputItem.id));
diff --git a/packages/api/src/router/board/board-access.ts b/packages/api/src/router/board/board-access.ts
new file mode 100644
index 000000000..d27d1cbe5
--- /dev/null
+++ b/packages/api/src/router/board/board-access.ts
@@ -0,0 +1,72 @@
+import { TRPCError } from "@trpc/server";
+
+import type { Session } from "@homarr/auth";
+import { constructBoardPermissions } from "@homarr/auth/shared";
+import type { Database, SQL } from "@homarr/db";
+import { eq, inArray } from "@homarr/db";
+import { boardGroupPermissions, boardUserPermissions, groupMembers } from "@homarr/db/schema/sqlite";
+import type { BoardPermission } from "@homarr/definitions";
+
+/**
+ * Throws NOT_FOUND if user is not allowed to perform action on board
+ * @param ctx trpc router context
+ * @param boardWhere where clause for the board
+ * @param permission permission required to perform action on board
+ */
+export const throwIfActionForbiddenAsync = async (
+ ctx: { db: Database; session: Session | null },
+ boardWhere: SQL,
+ permission: "full-access" | BoardPermission,
+) => {
+ const { db, session } = ctx;
+ const groupsOfCurrentUser = await db.query.groupMembers.findMany({
+ where: eq(groupMembers.userId, session?.user.id ?? ""),
+ });
+ const board = await db.query.boards.findFirst({
+ where: boardWhere,
+ columns: {
+ id: true,
+ creatorId: true,
+ isPublic: true,
+ },
+ with: {
+ userPermissions: {
+ where: eq(boardUserPermissions.userId, session?.user.id ?? ""),
+ },
+ groupPermissions: {
+ where: inArray(boardGroupPermissions.groupId, groupsOfCurrentUser.map((group) => group.groupId).concat("")),
+ },
+ },
+ });
+
+ if (!board) {
+ notAllowed();
+ }
+
+ const { hasViewAccess, hasChangeAccess, hasFullAccess } = constructBoardPermissions(board, session);
+
+ if (hasFullAccess) {
+ return; // As full access is required and user has full access, allow
+ }
+
+ if (["board-change", "board-view"].includes(permission) && hasChangeAccess) {
+ return; // As change access is required and user has change access, allow
+ }
+
+ if (permission === "board-view" && hasViewAccess) {
+ return; // As view access is required and user has view access, allow
+ }
+
+ notAllowed();
+};
+
+/**
+ * This method returns NOT_FOUND to prevent snooping on board existence
+ * A function is used to use the method without return statement
+ */
+function notAllowed(): never {
+ throw new TRPCError({
+ code: "NOT_FOUND",
+ message: "Board not found",
+ });
+}
diff --git a/packages/api/src/router/group.ts b/packages/api/src/router/group.ts
new file mode 100644
index 000000000..17a7749d1
--- /dev/null
+++ b/packages/api/src/router/group.ts
@@ -0,0 +1,200 @@
+import { TRPCError } from "@trpc/server";
+
+import type { Database } from "@homarr/db";
+import { and, createId, eq, like, not, sql } from "@homarr/db";
+import { groupMembers, groupPermissions, groups } from "@homarr/db/schema/sqlite";
+import { validation } from "@homarr/validation";
+
+import { createTRPCRouter, protectedProcedure } from "../trpc";
+
+export const groupRouter = createTRPCRouter({
+ getPaginated: protectedProcedure.input(validation.group.paginated).query(async ({ input, ctx }) => {
+ const whereQuery = input.search ? like(groups.name, `%${input.search.trim()}%`) : undefined;
+ const groupCount = await ctx.db
+ .select({
+ count: sql`count(*)`,
+ })
+ .from(groups)
+ .where(whereQuery);
+
+ const dbGroups = await ctx.db.query.groups.findMany({
+ with: {
+ members: {
+ with: {
+ user: {
+ columns: {
+ id: true,
+ name: true,
+ email: true,
+ image: true,
+ },
+ },
+ },
+ },
+ },
+ limit: input.pageSize,
+ offset: (input.page - 1) * input.pageSize,
+ where: whereQuery,
+ });
+
+ return {
+ items: dbGroups.map((group) => ({
+ ...group,
+ members: group.members.map((member) => member.user),
+ })),
+ totalCount: groupCount[0]!.count,
+ };
+ }),
+ getById: protectedProcedure.input(validation.group.byId).query(async ({ input, ctx }) => {
+ const group = await ctx.db.query.groups.findFirst({
+ where: eq(groups.id, input.id),
+ with: {
+ members: {
+ with: {
+ user: {
+ columns: {
+ id: true,
+ name: true,
+ email: true,
+ image: true,
+ },
+ },
+ },
+ },
+ permissions: {
+ columns: {
+ permission: true,
+ },
+ },
+ },
+ });
+
+ if (!group) {
+ throw new TRPCError({
+ code: "NOT_FOUND",
+ message: "Group not found",
+ });
+ }
+
+ return {
+ ...group,
+ members: group.members.map((member) => member.user),
+ permissions: group.permissions.map((permission) => permission.permission),
+ };
+ }),
+ selectable: protectedProcedure.query(async ({ ctx }) => {
+ return await ctx.db.query.groups.findMany({
+ columns: {
+ id: true,
+ name: true,
+ },
+ });
+ }),
+ createGroup: protectedProcedure.input(validation.group.create).mutation(async ({ input, ctx }) => {
+ const normalizedName = normalizeName(input.name);
+ await checkSimilarNameAndThrowAsync(ctx.db, normalizedName);
+
+ const id = createId();
+ await ctx.db.insert(groups).values({
+ id,
+ name: normalizedName,
+ ownerId: ctx.session.user.id,
+ });
+
+ return id;
+ }),
+ updateGroup: protectedProcedure.input(validation.group.update).mutation(async ({ input, ctx }) => {
+ await throwIfGroupNotFoundAsync(ctx.db, input.id);
+
+ const normalizedName = normalizeName(input.name);
+ await checkSimilarNameAndThrowAsync(ctx.db, normalizedName, input.id);
+
+ await ctx.db
+ .update(groups)
+ .set({
+ name: normalizedName,
+ })
+ .where(eq(groups.id, input.id));
+ }),
+ savePermissions: protectedProcedure.input(validation.group.savePermissions).mutation(async ({ input, ctx }) => {
+ await throwIfGroupNotFoundAsync(ctx.db, input.groupId);
+
+ await ctx.db.delete(groupPermissions).where(eq(groupPermissions.groupId, input.groupId));
+
+ await ctx.db.insert(groupPermissions).values(
+ input.permissions.map((permission) => ({
+ groupId: input.groupId,
+ permission,
+ })),
+ );
+ }),
+ transferOwnership: protectedProcedure.input(validation.group.groupUser).mutation(async ({ input, ctx }) => {
+ await throwIfGroupNotFoundAsync(ctx.db, input.groupId);
+
+ await ctx.db
+ .update(groups)
+ .set({
+ ownerId: input.userId,
+ })
+ .where(eq(groups.id, input.groupId));
+ }),
+ deleteGroup: protectedProcedure.input(validation.group.byId).mutation(async ({ input, ctx }) => {
+ await throwIfGroupNotFoundAsync(ctx.db, input.id);
+
+ await ctx.db.delete(groups).where(eq(groups.id, input.id));
+ }),
+ addMember: protectedProcedure.input(validation.group.groupUser).mutation(async ({ input, ctx }) => {
+ await throwIfGroupNotFoundAsync(ctx.db, input.groupId);
+
+ const user = await ctx.db.query.users.findFirst({
+ where: eq(groups.id, input.userId),
+ });
+
+ if (!user) {
+ throw new TRPCError({
+ code: "NOT_FOUND",
+ message: "User not found",
+ });
+ }
+
+ await ctx.db.insert(groupMembers).values({
+ groupId: input.groupId,
+ userId: input.userId,
+ });
+ }),
+ removeMember: protectedProcedure.input(validation.group.groupUser).mutation(async ({ input, ctx }) => {
+ await throwIfGroupNotFoundAsync(ctx.db, input.groupId);
+
+ await ctx.db
+ .delete(groupMembers)
+ .where(and(eq(groupMembers.groupId, input.groupId), eq(groupMembers.userId, input.userId)));
+ }),
+});
+
+const normalizeName = (name: string) => name.trim();
+
+const checkSimilarNameAndThrowAsync = async (db: Database, name: string, ignoreId?: string) => {
+ const similar = await db.query.groups.findFirst({
+ where: and(like(groups.name, `${name}`), not(eq(groups.id, ignoreId ?? ""))),
+ });
+
+ if (similar) {
+ throw new TRPCError({
+ code: "CONFLICT",
+ message: "Found group with similar name",
+ });
+ }
+};
+
+const throwIfGroupNotFoundAsync = async (db: Database, id: string) => {
+ const group = await db.query.groups.findFirst({
+ where: eq(groups.id, id),
+ });
+
+ if (!group) {
+ throw new TRPCError({
+ code: "NOT_FOUND",
+ message: "Group not found",
+ });
+ }
+};
diff --git a/packages/api/src/router/home.ts b/packages/api/src/router/home.ts
new file mode 100644
index 000000000..191698566
--- /dev/null
+++ b/packages/api/src/router/home.ts
@@ -0,0 +1,17 @@
+import { count } from "@homarr/db";
+import { apps, boards, groups, integrations, invites, users } from "@homarr/db/schema/sqlite";
+
+import { createTRPCRouter, protectedProcedure } from "../trpc";
+
+export const homeRouter = createTRPCRouter({
+ getStats: protectedProcedure.query(async ({ ctx }) => {
+ return {
+ countBoards: (await ctx.db.select({ count: count() }).from(boards))[0]?.count ?? 0,
+ countUsers: (await ctx.db.select({ count: count() }).from(users))[0]?.count ?? 0,
+ countGroups: (await ctx.db.select({ count: count() }).from(groups))[0]?.count ?? 0,
+ countInvites: (await ctx.db.select({ count: count() }).from(invites))[0]?.count ?? 0,
+ countIntegrations: (await ctx.db.select({ count: count() }).from(integrations))[0]?.count ?? 0,
+ countApps: (await ctx.db.select({ count: count() }).from(apps))[0]?.count ?? 0,
+ };
+ }),
+});
diff --git a/packages/api/src/router/icons.ts b/packages/api/src/router/icons.ts
new file mode 100644
index 000000000..e0c3c9a7c
--- /dev/null
+++ b/packages/api/src/router/icons.ts
@@ -0,0 +1,26 @@
+import { count, like } from "@homarr/db";
+import { icons } from "@homarr/db/schema/sqlite";
+import { validation } from "@homarr/validation";
+
+import { createTRPCRouter, publicProcedure } from "../trpc";
+
+export const iconsRouter = createTRPCRouter({
+ findIcons: publicProcedure.input(validation.icons.findIcons).query(async ({ ctx, input }) => {
+ return {
+ icons: await ctx.db.query.iconRepositories.findMany({
+ with: {
+ icons: {
+ columns: {
+ id: true,
+ name: true,
+ url: true,
+ },
+ where: input.searchText?.length ?? 0 > 0 ? like(icons.name, `%${input.searchText}%`) : undefined,
+ limit: 5,
+ },
+ },
+ }),
+ countIcons: (await ctx.db.select({ count: count() }).from(icons))[0]?.count ?? 0,
+ };
+ }),
+});
diff --git a/packages/api/src/router/integration.ts b/packages/api/src/router/integration.ts
index 1cfe85cca..ae807ef97 100644
--- a/packages/api/src/router/integration.ts
+++ b/packages/api/src/router/integration.ts
@@ -1,14 +1,11 @@
import crypto from "crypto";
import { TRPCError } from "@trpc/server";
+import type { Database } from "@homarr/db";
import { and, createId, eq } from "@homarr/db";
import { integrations, integrationSecrets } from "@homarr/db/schema/sqlite";
import type { IntegrationSecretKind } from "@homarr/definitions";
-import {
- getSecretKinds,
- integrationKinds,
- integrationSecretKindObject,
-} from "@homarr/definitions";
+import { getAllSecretKindOptions, integrationKinds, integrationSecretKindObject } from "@homarr/definitions";
import { validation } from "@homarr/validation";
import { createTRPCRouter, publicProcedure } from "../trpc";
@@ -25,219 +22,239 @@ export const integrationRouter = createTRPCRouter({
}))
.sort(
(integrationA, integrationB) =>
- integrationKinds.indexOf(integrationA.kind) -
- integrationKinds.indexOf(integrationB.kind),
+ integrationKinds.indexOf(integrationA.kind) - integrationKinds.indexOf(integrationB.kind),
);
}),
- byId: publicProcedure
- .input(validation.integration.byId)
- .query(async ({ ctx, input }) => {
- const integration = await ctx.db.query.integrations.findFirst({
- where: eq(integrations.id, input.id),
- with: {
- secrets: {
- columns: {
- kind: true,
- value: true,
- updatedAt: true,
- },
+ byId: publicProcedure.input(validation.integration.byId).query(async ({ ctx, input }) => {
+ const integration = await ctx.db.query.integrations.findFirst({
+ where: eq(integrations.id, input.id),
+ with: {
+ secrets: {
+ columns: {
+ kind: true,
+ value: true,
+ updatedAt: true,
},
},
+ },
+ });
+
+ if (!integration) {
+ throw new TRPCError({
+ code: "NOT_FOUND",
+ message: "Integration not found",
});
+ }
- if (!integration) {
- throw new TRPCError({
- code: "NOT_FOUND",
- message: "Integration not found",
- });
- }
+ return {
+ id: integration.id,
+ name: integration.name,
+ kind: integration.kind,
+ url: integration.url,
+ secrets: integration.secrets.map((secret) => ({
+ kind: secret.kind,
+ // Only return the value if the secret is public, so for example the username
+ value: integrationSecretKindObject[secret.kind].isPublic ? decryptSecret(secret.value) : null,
+ updatedAt: secret.updatedAt,
+ })),
+ };
+ }),
+ create: publicProcedure.input(validation.integration.create).mutation(async ({ ctx, input }) => {
+ const integrationId = createId();
+ await ctx.db.insert(integrations).values({
+ id: integrationId,
+ name: input.name,
+ url: input.url,
+ kind: input.kind,
+ });
- return {
- id: integration.id,
- name: integration.name,
- kind: integration.kind,
- url: integration.url,
- secrets: integration.secrets.map((secret) => ({
- kind: secret.kind,
- // Only return the value if the secret is public, so for example the username
- value: integrationSecretKindObject[secret.kind].isPublic
- ? decryptSecret(secret.value)
- : null,
- updatedAt: secret.updatedAt,
- })),
- };
- }),
- create: publicProcedure
- .input(validation.integration.create)
- .mutation(async ({ ctx, input }) => {
- const integrationId = createId();
- await ctx.db.insert(integrations).values({
- id: integrationId,
+ for (const secret of input.secrets) {
+ await ctx.db.insert(integrationSecrets).values({
+ kind: secret.kind,
+ value: encryptSecret(secret.value),
+ updatedAt: new Date(),
+ integrationId,
+ });
+ }
+ }),
+ update: publicProcedure.input(validation.integration.update).mutation(async ({ ctx, input }) => {
+ const integration = await ctx.db.query.integrations.findFirst({
+ where: eq(integrations.id, input.id),
+ with: {
+ secrets: true,
+ },
+ });
+
+ if (!integration) {
+ throw new TRPCError({
+ code: "NOT_FOUND",
+ message: "Integration not found",
+ });
+ }
+
+ await ctx.db
+ .update(integrations)
+ .set({
name: input.name,
url: input.url,
- kind: input.kind,
- });
+ })
+ .where(eq(integrations.id, input.id));
- for (const secret of input.secrets) {
- await ctx.db.insert(integrationSecrets).values({
- kind: secret.kind,
- value: encryptSecret(secret.value),
- updatedAt: new Date(),
- integrationId,
- });
+ const decryptedSecrets = integration.secrets.map((secret) => ({
+ ...secret,
+ value: decryptSecret(secret.value),
+ }));
+
+ const changedSecrets = input.secrets.filter(
+ (secret): secret is { kind: IntegrationSecretKind; value: string } =>
+ secret.value !== null && // only update secrets that have a value
+ !decryptedSecrets.find((dSecret) => dSecret.kind === secret.kind && dSecret.value === secret.value),
+ );
+
+ if (changedSecrets.length > 0) {
+ for (const changedSecret of changedSecrets) {
+ const secretInput = {
+ integrationId: input.id,
+ value: changedSecret.value,
+ kind: changedSecret.kind,
+ };
+ if (!decryptedSecrets.some((secret) => secret.kind === changedSecret.kind)) {
+ await addSecretAsync(ctx.db, secretInput);
+ } else {
+ await updateSecretAsync(ctx.db, secretInput);
+ }
}
- }),
- update: publicProcedure
- .input(validation.integration.update)
- .mutation(async ({ ctx, input }) => {
+ }
+ }),
+ delete: publicProcedure.input(validation.integration.delete).mutation(async ({ ctx, input }) => {
+ const integration = await ctx.db.query.integrations.findFirst({
+ where: eq(integrations.id, input.id),
+ });
+
+ if (!integration) {
+ throw new TRPCError({
+ code: "NOT_FOUND",
+ message: "Integration not found",
+ });
+ }
+
+ await ctx.db.delete(integrations).where(eq(integrations.id, input.id));
+ }),
+ testConnection: publicProcedure.input(validation.integration.testConnection).mutation(async ({ ctx, input }) => {
+ const secrets = input.secrets.filter((secret): secret is { kind: IntegrationSecretKind; value: string } =>
+ Boolean(secret.value),
+ );
+
+ // Find any matching secret kinds
+ let secretKinds = getAllSecretKindOptions(input.kind).find((secretKinds) =>
+ secretKinds.every((secretKind) => secrets.some((secret) => secret.kind === secretKind)),
+ );
+
+ if (!secretKinds && input.id === null) {
+ throw new TRPCError({
+ code: "BAD_REQUEST",
+ message: "SECRETS_NOT_DEFINED",
+ });
+ }
+
+ if (!secretKinds && input.id !== null) {
const integration = await ctx.db.query.integrations.findFirst({
where: eq(integrations.id, input.id),
with: {
secrets: true,
},
});
-
if (!integration) {
throw new TRPCError({
- code: "NOT_FOUND",
- message: "Integration not found",
+ code: "BAD_REQUEST",
+ message: "SECRETS_NOT_DEFINED",
});
}
-
- await ctx.db
- .update(integrations)
- .set({
- name: input.name,
- url: input.url,
- })
- .where(eq(integrations.id, input.id));
-
const decryptedSecrets = integration.secrets.map((secret) => ({
...secret,
value: decryptSecret(secret.value),
}));
- const changedSecrets = input.secrets.filter(
- (secret): secret is { kind: IntegrationSecretKind; value: string } =>
- secret.value !== null && // only update secrets that have a value
- !decryptedSecrets.find(
- (dSecret) =>
- dSecret.kind === secret.kind && dSecret.value === secret.value,
- ),
- );
-
- if (changedSecrets.length > 0) {
- for (const changedSecret of changedSecrets) {
- await ctx.db
- .update(integrationSecrets)
- .set({
- value: encryptSecret(changedSecret.value),
- updatedAt: new Date(),
- })
- .where(
- and(
- eq(integrationSecrets.integrationId, input.id),
- eq(integrationSecrets.kind, changedSecret.kind),
- ),
- );
+ // Add secrets that are not defined in the input from the database
+ for (const dbSecret of decryptedSecrets) {
+ if (!secrets.find((secret) => secret.kind === dbSecret.kind)) {
+ secrets.push({
+ kind: dbSecret.kind,
+ value: dbSecret.value,
+ });
}
}
- }),
- delete: publicProcedure
- .input(validation.integration.delete)
- .mutation(async ({ ctx, input }) => {
- const integration = await ctx.db.query.integrations.findFirst({
- where: eq(integrations.id, input.id),
- });
- if (!integration) {
- throw new TRPCError({
- code: "NOT_FOUND",
- message: "Integration not found",
- });
- }
-
- await ctx.db.delete(integrations).where(eq(integrations.id, input.id));
- }),
- testConnection: publicProcedure
- .input(validation.integration.testConnection)
- .mutation(async ({ ctx, input }) => {
- const secretKinds = getSecretKinds(input.kind);
- const secrets = input.secrets.filter(
- (secret): secret is { kind: IntegrationSecretKind; value: string } =>
- !!secret.value,
- );
- const everyInputSecretDefined = secretKinds.every((secretKind) =>
- secrets.some((secret) => secret.kind === secretKind),
+ secretKinds = getAllSecretKindOptions(input.kind).find((secretKinds) =>
+ secretKinds.every((secretKind) => secrets.some((secret) => secret.kind === secretKind)),
);
- if (!everyInputSecretDefined && input.id === null) {
+
+ if (!secretKinds) {
throw new TRPCError({
code: "BAD_REQUEST",
message: "SECRETS_NOT_DEFINED",
});
}
+ }
- if (!everyInputSecretDefined && input.id !== null) {
- const integration = await ctx.db.query.integrations.findFirst({
- where: eq(integrations.id, input.id),
- with: {
- secrets: true,
- },
- });
- if (!integration) {
- throw new TRPCError({
- code: "BAD_REQUEST",
- message: "SECRETS_NOT_DEFINED",
- });
- }
- const decryptedSecrets = integration.secrets.map((secret) => ({
- ...secret,
- value: decryptSecret(secret.value),
- }));
-
- // Add secrets that are not defined in the input from the database
- for (const dbSecret of decryptedSecrets) {
- if (!secrets.find((secret) => secret.kind === dbSecret.kind)) {
- secrets.push({
- kind: dbSecret.kind,
- value: dbSecret.value,
- });
- }
- }
- }
-
- // TODO: actually test the connection
- // Probably by calling a function on the integration class
- // getIntegration(input.kind).testConnection(secrets)
- // getIntegration(kind: IntegrationKind): Integration
- // interface Integration {
- // testConnection(): Promise;
- // }
- }),
+ // TODO: actually test the connection
+ // Probably by calling a function on the integration class
+ // getIntegration(input.kind).testConnection(secrets)
+ // getIntegration(kind: IntegrationKind): Integration
+ // interface Integration {
+ // testConnection(): Promise;
+ // }
+ }),
});
const algorithm = "aes-256-cbc"; //Using AES encryption
-const key = Buffer.from(
- "1d71cceced68159ba59a277d056a66173613052cbeeccbfbd15ab1c909455a4d",
- "hex",
-); // TODO: generate with const data = crypto.randomBytes(32).toString('hex')
+const key = Buffer.from("1d71cceced68159ba59a277d056a66173613052cbeeccbfbd15ab1c909455a4d", "hex"); // TODO: generate with const data = crypto.randomBytes(32).toString('hex')
//Encrypting text
-function encryptSecret(text: string): `${string}.${string}` {
- const iv = crypto.randomBytes(16);
- const cipher = crypto.createCipheriv(algorithm, Buffer.from(key), iv);
+export function encryptSecret(text: string): `${string}.${string}` {
+ const initializationVector = crypto.randomBytes(16);
+ const cipher = crypto.createCipheriv(algorithm, Buffer.from(key), initializationVector);
let encrypted = cipher.update(text);
encrypted = Buffer.concat([encrypted, cipher.final()]);
- return `${encrypted.toString("hex")}.${iv.toString("hex")}`;
+ return `${encrypted.toString("hex")}.${initializationVector.toString("hex")}`;
}
// Decrypting text
function decryptSecret(value: `${string}.${string}`) {
const [data, dataIv] = value.split(".") as [string, string];
- const iv = Buffer.from(dataIv, "hex");
+ const initializationVector = Buffer.from(dataIv, "hex");
const encryptedText = Buffer.from(data, "hex");
- const decipher = crypto.createDecipheriv(algorithm, Buffer.from(key), iv);
+ const decipher = crypto.createDecipheriv(algorithm, Buffer.from(key), initializationVector);
let decrypted = decipher.update(encryptedText);
decrypted = Buffer.concat([decrypted, decipher.final()]);
return decrypted.toString();
}
+
+interface UpdateSecretInput {
+ integrationId: string;
+ value: string;
+ kind: IntegrationSecretKind;
+}
+const updateSecretAsync = async (db: Database, input: UpdateSecretInput) => {
+ await db
+ .update(integrationSecrets)
+ .set({
+ value: encryptSecret(input.value),
+ updatedAt: new Date(),
+ })
+ .where(and(eq(integrationSecrets.integrationId, input.integrationId), eq(integrationSecrets.kind, input.kind)));
+};
+
+interface AddSecretInput {
+ integrationId: string;
+ value: string;
+ kind: IntegrationSecretKind;
+}
+const addSecretAsync = async (db: Database, input: AddSecretInput) => {
+ await db.insert(integrationSecrets).values({
+ kind: input.kind,
+ value: encryptSecret(input.value),
+ updatedAt: new Date(),
+ integrationId: input.integrationId,
+ });
+};
diff --git a/packages/api/src/router/invite.ts b/packages/api/src/router/invite.ts
new file mode 100644
index 000000000..cc6894115
--- /dev/null
+++ b/packages/api/src/router/invite.ts
@@ -0,0 +1,70 @@
+import { randomBytes } from "crypto";
+import { TRPCError } from "@trpc/server";
+
+import { asc, createId, eq } from "@homarr/db";
+import { invites } from "@homarr/db/schema/sqlite";
+import { z } from "@homarr/validation";
+
+import { createTRPCRouter, protectedProcedure } from "../trpc";
+
+export const inviteRouter = createTRPCRouter({
+ getAll: protectedProcedure.query(async ({ ctx }) => {
+ const dbInvites = await ctx.db.query.invites.findMany({
+ orderBy: asc(invites.expirationDate),
+ columns: {
+ token: false,
+ },
+ with: {
+ creator: {
+ columns: {
+ id: true,
+ name: true,
+ },
+ },
+ },
+ });
+ return dbInvites;
+ }),
+ createInvite: protectedProcedure
+ .input(
+ z.object({
+ expirationDate: z.date(),
+ }),
+ )
+ .mutation(async ({ ctx, input }) => {
+ const id = createId();
+ const token = randomBytes(20).toString("hex");
+
+ await ctx.db.insert(invites).values({
+ id,
+ expirationDate: input.expirationDate,
+ creatorId: ctx.session.user.id,
+ token,
+ });
+
+ return {
+ id,
+ token,
+ };
+ }),
+ deleteInvite: protectedProcedure
+ .input(
+ z.object({
+ id: z.string(),
+ }),
+ )
+ .mutation(async ({ ctx, input }) => {
+ const dbInvite = await ctx.db.query.invites.findFirst({
+ where: eq(invites.id, input.id),
+ });
+
+ if (!dbInvite) {
+ throw new TRPCError({
+ code: "NOT_FOUND",
+ message: "Invite not found",
+ });
+ }
+
+ await ctx.db.delete(invites).where(eq(invites.id, input.id));
+ }),
+});
diff --git a/packages/api/src/router/location.ts b/packages/api/src/router/location.ts
new file mode 100644
index 000000000..11e6e6770
--- /dev/null
+++ b/packages/api/src/router/location.ts
@@ -0,0 +1,14 @@
+import type { z } from "@homarr/validation";
+import { validation } from "@homarr/validation";
+
+import { createTRPCRouter, publicProcedure } from "../trpc";
+
+export const locationRouter = createTRPCRouter({
+ searchCity: publicProcedure
+ .input(validation.location.searchCity.input)
+ .output(validation.location.searchCity.output)
+ .query(async ({ input }) => {
+ const res = await fetch(`https://geocoding-api.open-meteo.com/v1/search?name=${input.query}`);
+ return (await res.json()) as z.infer;
+ }),
+});
diff --git a/packages/api/src/router/log.ts b/packages/api/src/router/log.ts
new file mode 100644
index 000000000..ac46ba9a3
--- /dev/null
+++ b/packages/api/src/router/log.ts
@@ -0,0 +1,18 @@
+import { observable } from "@trpc/server/observable";
+
+import { logger } from "@homarr/log";
+import type { LoggerMessage } from "@homarr/redis";
+import { loggingChannel } from "@homarr/redis";
+
+import { createTRPCRouter, publicProcedure } from "../trpc";
+
+export const logRouter = createTRPCRouter({
+ subscribe: publicProcedure.subscription(() => {
+ return observable((emit) => {
+ loggingChannel.subscribe((data) => {
+ emit.next(data);
+ });
+ logger.info("A tRPC client has connected to the logging procedure");
+ });
+ }),
+});
diff --git a/packages/api/src/router/serverSettings.ts b/packages/api/src/router/serverSettings.ts
new file mode 100644
index 000000000..8766836ca
--- /dev/null
+++ b/packages/api/src/router/serverSettings.ts
@@ -0,0 +1,41 @@
+import SuperJSON from "superjson";
+
+import { eq } from "@homarr/db";
+import { serverSettings } from "@homarr/db/schema/sqlite";
+import type { ServerSettings } from "@homarr/server-settings";
+import { defaultServerSettingsKeys } from "@homarr/server-settings";
+import { z } from "@homarr/validation";
+
+import { createTRPCRouter, protectedProcedure } from "../trpc";
+
+export const serverSettingsRouter = createTRPCRouter({
+ getAll: protectedProcedure.query(async ({ ctx }) => {
+ const settings = await ctx.db.query.serverSettings.findMany();
+
+ const data = {} as ServerSettings;
+ defaultServerSettingsKeys.forEach((key) => {
+ const settingValue = settings.find((setting) => setting.settingKey === key)?.value;
+ if (!settingValue) {
+ return;
+ }
+ data[key] = SuperJSON.parse(settingValue);
+ });
+ return data;
+ }),
+ saveSettings: protectedProcedure
+ .input(
+ z.object({
+ settingsKey: z.enum(defaultServerSettingsKeys),
+ value: z.record(z.string(), z.unknown()),
+ }),
+ )
+ .mutation(async ({ ctx, input }) => {
+ const databaseRunResult = await ctx.db
+ .update(serverSettings)
+ .set({
+ value: SuperJSON.stringify(input.value),
+ })
+ .where(eq(serverSettings.settingKey, input.settingsKey));
+ return databaseRunResult.changes === 1;
+ }),
+});
diff --git a/packages/api/src/router/test/app.spec.ts b/packages/api/src/router/test/app.spec.ts
new file mode 100644
index 000000000..db9550d0c
--- /dev/null
+++ b/packages/api/src/router/test/app.spec.ts
@@ -0,0 +1,209 @@
+import { describe, expect, test, vi } from "vitest";
+
+import type { Session } from "@homarr/auth";
+import { createId } from "@homarr/db";
+import { apps } from "@homarr/db/schema/sqlite";
+import { createDb } from "@homarr/db/test";
+
+import { appRouter } from "../app";
+
+// Mock the auth module to return an empty session
+vi.mock("@homarr/auth", () => ({ auth: () => ({}) as Session }));
+
+describe("all should return all apps", () => {
+ test("should return all apps", async () => {
+ const db = createDb();
+ const caller = appRouter.createCaller({
+ db,
+ session: null,
+ });
+
+ await db.insert(apps).values([
+ {
+ id: "2",
+ name: "Mantine",
+ description: "React components and hooks library",
+ iconUrl: "https://mantine.dev/favicon.svg",
+ href: "https://mantine.dev",
+ },
+ {
+ id: "1",
+ name: "Tabler Icons",
+ iconUrl: "https://tabler.io/favicon.ico",
+ },
+ ]);
+
+ const result = await caller.all();
+ expect(result.length).toBe(2);
+ expect(result[0]!.id).toBe("2");
+ expect(result[1]!.id).toBe("1");
+ expect(result[0]!.href).toBeDefined();
+ expect(result[0]!.description).toBeDefined();
+ expect(result[1]!.href).toBeNull();
+ expect(result[1]!.description).toBeNull();
+ });
+});
+
+describe("byId should return an app by id", () => {
+ test("should return an app by id", async () => {
+ const db = createDb();
+ const caller = appRouter.createCaller({
+ db,
+ session: null,
+ });
+
+ await db.insert(apps).values([
+ {
+ id: "2",
+ name: "Mantine",
+ description: "React components and hooks library",
+ iconUrl: "https://mantine.dev/favicon.svg",
+ href: "https://mantine.dev",
+ },
+ {
+ id: "1",
+ name: "Tabler Icons",
+ iconUrl: "https://tabler.io/favicon.ico",
+ },
+ ]);
+
+ const result = await caller.byId({ id: "2" });
+ expect(result.name).toBe("Mantine");
+ });
+
+ test("should throw an error if the app does not exist", async () => {
+ const db = createDb();
+ const caller = appRouter.createCaller({
+ db,
+ session: null,
+ });
+
+ const actAsync = async () => await caller.byId({ id: "2" });
+ await expect(actAsync()).rejects.toThrow("App not found");
+ });
+});
+
+describe("create should create a new app with all arguments", () => {
+ test("should create a new app", async () => {
+ const db = createDb();
+ const caller = appRouter.createCaller({
+ db,
+ session: null,
+ });
+ const input = {
+ name: "Mantine",
+ description: "React components and hooks library",
+ iconUrl: "https://mantine.dev/favicon.svg",
+ href: "https://mantine.dev",
+ };
+
+ await caller.create(input);
+
+ const dbApp = await db.query.apps.findFirst();
+ expect(dbApp).toBeDefined();
+ expect(dbApp!.name).toBe(input.name);
+ expect(dbApp!.description).toBe(input.description);
+ expect(dbApp!.iconUrl).toBe(input.iconUrl);
+ expect(dbApp!.href).toBe(input.href);
+ });
+
+ test("should create a new app only with required arguments", async () => {
+ const db = createDb();
+ const caller = appRouter.createCaller({
+ db,
+ session: null,
+ });
+ const input = {
+ name: "Mantine",
+ description: null,
+ iconUrl: "https://mantine.dev/favicon.svg",
+ href: null,
+ };
+
+ await caller.create(input);
+
+ const dbApp = await db.query.apps.findFirst();
+ expect(dbApp).toBeDefined();
+ expect(dbApp!.name).toBe(input.name);
+ expect(dbApp!.description).toBe(input.description);
+ expect(dbApp!.iconUrl).toBe(input.iconUrl);
+ expect(dbApp!.href).toBe(input.href);
+ });
+});
+
+describe("update should update an app", () => {
+ test("should update an app", async () => {
+ const db = createDb();
+ const caller = appRouter.createCaller({
+ db,
+ session: null,
+ });
+
+ const appId = createId();
+ const toInsert = {
+ id: appId,
+ name: "Mantine",
+ iconUrl: "https://mantine.dev/favicon.svg",
+ };
+
+ await db.insert(apps).values(toInsert);
+
+ const input = {
+ id: appId,
+ name: "Mantine2",
+ description: "React components and hooks library",
+ iconUrl: "https://mantine.dev/favicon.svg2",
+ href: "https://mantine.dev",
+ };
+
+ await caller.update(input);
+
+ const dbApp = await db.query.apps.findFirst();
+
+ expect(dbApp).toBeDefined();
+ expect(dbApp!.name).toBe(input.name);
+ expect(dbApp!.description).toBe(input.description);
+ expect(dbApp!.iconUrl).toBe(input.iconUrl);
+ expect(dbApp!.href).toBe(input.href);
+ });
+
+ test("should throw an error if the app does not exist", async () => {
+ const db = createDb();
+ const caller = appRouter.createCaller({
+ db,
+ session: null,
+ });
+
+ const actAsync = async () =>
+ await caller.update({
+ id: createId(),
+ name: "Mantine",
+ iconUrl: "https://mantine.dev/favicon.svg",
+ description: null,
+ href: null,
+ });
+ await expect(actAsync()).rejects.toThrow("App not found");
+ });
+});
+
+describe("delete should delete an app", () => {
+ test("should delete an app", async () => {
+ const db = createDb();
+ const caller = appRouter.createCaller({
+ db,
+ session: null,
+ });
+
+ const appId = createId();
+ await db.insert(apps).values({
+ id: appId,
+ name: "Mantine",
+ iconUrl: "https://mantine.dev/favicon.svg",
+ });
+
+ await caller.delete({ id: appId });
+
+ const dbApp = await db.query.apps.findFirst();
+ expect(dbApp).toBeUndefined();
+ });
+});
diff --git a/packages/api/src/router/test/board.spec.ts b/packages/api/src/router/test/board.spec.ts
new file mode 100644
index 000000000..11ac8c913
--- /dev/null
+++ b/packages/api/src/router/test/board.spec.ts
@@ -0,0 +1,1305 @@
+import SuperJSON from "superjson";
+import { describe, expect, it, test, vi } from "vitest";
+
+import type { Session } from "@homarr/auth";
+import type { Database } from "@homarr/db";
+import { createId, eq } from "@homarr/db";
+import {
+ boardGroupPermissions,
+ boards,
+ boardUserPermissions,
+ groupMembers,
+ groupPermissions,
+ groups,
+ integrationItems,
+ integrations,
+ items,
+ sections,
+ users,
+} from "@homarr/db/schema/sqlite";
+import { createDb } from "@homarr/db/test";
+import type { BoardPermission, GroupPermissionKey } from "@homarr/definitions";
+
+import type { RouterOutputs } from "../..";
+import { boardRouter } from "../board";
+import * as boardAccess from "../board/board-access";
+import { expectToBeDefined } from "./helper";
+
+const defaultCreatorId = createId();
+const defaultSession = {
+ user: {
+ id: defaultCreatorId,
+ permissions: [],
+ },
+ expires: new Date().toISOString(),
+} satisfies Session;
+
+// Mock the auth module to return an empty session
+vi.mock("@homarr/auth", () => ({ auth: () => ({}) as Session }));
+
+const createRandomUserAsync = async (db: Database) => {
+ const userId = createId();
+ await db.insert(users).values({
+ id: userId,
+ homeBoardId: null,
+ });
+ return userId;
+};
+
+describe("getAllBoards should return all boards accessable to the current user", () => {
+ test("without session it should return only public boards", async () => {
+ // Arrange
+ const db = createDb();
+ const caller = boardRouter.createCaller({ db, session: null });
+
+ const user1 = await createRandomUserAsync(db);
+ const user2 = await createRandomUserAsync(db);
+
+ await db.insert(boards).values([
+ {
+ id: createId(),
+ name: "public",
+ creatorId: user1,
+ isPublic: true,
+ },
+ {
+ id: createId(),
+ name: "private",
+ creatorId: user2,
+ isPublic: false,
+ },
+ ]);
+
+ // Act
+ const result = await caller.getAllBoards();
+
+ // Assert
+ expect(result.length).toBe(1);
+ expect(result[0]?.name).toBe("public");
+ });
+
+ test("with session containing board-view-all permission it should return all boards", async () => {
+ // Arrange
+ const db = createDb();
+ const caller = boardRouter.createCaller({
+ db,
+ session: {
+ user: {
+ id: defaultCreatorId,
+ permissions: ["board-view-all"],
+ },
+ expires: new Date().toISOString(),
+ },
+ });
+
+ const user1 = await createRandomUserAsync(db);
+ const user2 = await createRandomUserAsync(db);
+
+ await db.insert(boards).values([
+ {
+ id: createId(),
+ name: "public",
+ creatorId: user1,
+ isPublic: true,
+ },
+ {
+ id: createId(),
+ name: "private",
+ creatorId: user2,
+ isPublic: false,
+ },
+ ]);
+
+ // Act
+ const result = await caller.getAllBoards();
+
+ // Assert
+ expect(result.length).toBe(2);
+ expect(result.map((board) => board.name)).toEqual(["public", "private"]);
+ });
+
+ test("with session user beeing creator it should return all private boards of them", async () => {
+ // Arrange
+ const db = createDb();
+ const caller = boardRouter.createCaller({ db, session: defaultSession });
+
+ const user1 = await createRandomUserAsync(db);
+ const user2 = await createRandomUserAsync(db);
+ await db.insert(users).values({
+ id: defaultCreatorId,
+ });
+
+ await db.insert(boards).values([
+ {
+ id: createId(),
+ name: "public",
+ creatorId: user1,
+ isPublic: true,
+ },
+ {
+ id: createId(),
+ name: "private",
+ creatorId: user2,
+ isPublic: false,
+ },
+ {
+ id: createId(),
+ name: "private2",
+ creatorId: defaultCreatorId,
+ isPublic: false,
+ },
+ ]);
+
+ // Act
+ const result = await caller.getAllBoards();
+
+ // Assert
+ expect(result.length).toBe(2);
+ expect(result.map(({ name }) => name)).toStrictEqual(["public", "private2"]);
+ });
+
+ test.each([["board-view"], ["board-change"]] satisfies [BoardPermission][])(
+ "with %s group board permission it should show board",
+ async (permission) => {
+ // Arrange
+ const db = createDb();
+ const caller = boardRouter.createCaller({
+ db,
+ session: defaultSession,
+ });
+
+ const user1 = await createRandomUserAsync(db);
+ const user2 = await createRandomUserAsync(db);
+ await db.insert(users).values({
+ id: defaultCreatorId,
+ });
+ const boardId = createId();
+
+ await db.insert(boards).values([
+ {
+ id: createId(),
+ name: "public",
+ creatorId: user1,
+ isPublic: true,
+ },
+ {
+ id: boardId,
+ name: "private1",
+ creatorId: user2,
+ isPublic: false,
+ },
+ {
+ id: createId(),
+ name: "private2",
+ creatorId: user2,
+ isPublic: false,
+ },
+ ]);
+
+ const groupId = createId();
+ await db.insert(groups).values({
+ id: groupId,
+ name: "group1",
+ });
+
+ await db.insert(groupMembers).values({
+ userId: defaultSession.user.id,
+ groupId,
+ });
+
+ await db.insert(boardGroupPermissions).values({
+ groupId,
+ permission,
+ boardId,
+ });
+
+ // Act
+ const result = await caller.getAllBoards();
+
+ // Assert
+ expect(result.length).toBe(2);
+ expect(result.map(({ name }) => name)).toStrictEqual(["public", "private1"]);
+ },
+ );
+
+ test.each([["board-view"], ["board-change"]] satisfies [BoardPermission][])(
+ "with %s user board permission it should show board",
+ async (permission) => {
+ // Arrange
+ const db = createDb();
+ const caller = boardRouter.createCaller({
+ db,
+ session: defaultSession,
+ });
+
+ const user1 = await createRandomUserAsync(db);
+ const user2 = await createRandomUserAsync(db);
+ await db.insert(users).values({
+ id: defaultCreatorId,
+ });
+ const boardId = createId();
+
+ await db.insert(boards).values([
+ {
+ id: createId(),
+ name: "public",
+ creatorId: user1,
+ isPublic: true,
+ },
+ {
+ id: boardId,
+ name: "private1",
+ creatorId: user2,
+ isPublic: false,
+ },
+ {
+ id: createId(),
+ name: "private2",
+ creatorId: user2,
+ isPublic: false,
+ },
+ ]);
+
+ await db.insert(boardUserPermissions).values({
+ userId: defaultSession.user.id,
+ permission,
+ boardId,
+ });
+
+ // Act
+ const result = await caller.getAllBoards();
+
+ // Assert
+ expect(result.length).toBe(2);
+ expect(result.map(({ name }) => name)).toStrictEqual(["public", "private1"]);
+ },
+ );
+});
+
+describe("createBoard should create a new board", () => {
+ test("should create a new board with permission board-create", async () => {
+ // Arrange
+ const db = createDb();
+ const session = {
+ ...defaultSession,
+ user: {
+ ...defaultSession.user,
+ permissions: ["board-create"] satisfies GroupPermissionKey[],
+ },
+ };
+ const caller = boardRouter.createCaller({ db, session });
+
+ await db.insert(users).values({
+ id: defaultCreatorId,
+ });
+
+ // Act
+ await caller.createBoard({ name: "newBoard" });
+
+ // Assert
+ const dbBoard = await db.query.boards.findFirst();
+ expect(dbBoard).toBeDefined();
+ expect(dbBoard?.name).toBe("newBoard");
+ expect(dbBoard?.creatorId).toBe(defaultCreatorId);
+
+ const dbSection = await db.query.sections.findFirst();
+ expect(dbSection).toBeDefined();
+ expect(dbSection?.boardId).toBe(dbBoard?.id);
+ expect(dbSection?.kind).toBe("empty");
+ });
+
+ test("should throw error when user has no board-create permission", async () => {
+ // Arrange
+ const db = createDb();
+ const caller = boardRouter.createCaller({ db, session: defaultSession });
+
+ // Act
+ const actAsync = async () => await caller.createBoard({ name: "newBoard" });
+
+ // Assert
+ await expect(actAsync()).rejects.toThrowError("Permission denied");
+ });
+});
+
+describe("rename board should rename board", () => {
+ test("should rename board", async () => {
+ // Arrange
+ const db = createDb();
+ const caller = boardRouter.createCaller({ db, session: defaultSession });
+ const spy = vi.spyOn(boardAccess, "throwIfActionForbiddenAsync");
+
+ await db.insert(users).values({
+ id: defaultCreatorId,
+ });
+ const boardId = createId();
+ await db.insert(boards).values({
+ id: boardId,
+ name: "oldName",
+ creatorId: defaultCreatorId,
+ });
+
+ // Act
+ await caller.renameBoard({ id: boardId, name: "newName" });
+
+ // Assert
+ const dbBoard = await db.query.boards.findFirst({
+ where: eq(boards.id, boardId),
+ });
+ expect(dbBoard).toBeDefined();
+ expect(dbBoard?.name).toBe("newName");
+ expect(spy).toHaveBeenCalledWith(expect.anything(), expect.anything(), "full-access");
+ });
+
+ test("should throw error when similar board name exists", async () => {
+ // Arrange
+ const db = createDb();
+ const caller = boardRouter.createCaller({ db, session: defaultSession });
+
+ await db.insert(users).values({
+ id: defaultCreatorId,
+ });
+ const boardId = createId();
+ await db.insert(boards).values({
+ id: boardId,
+ name: "oldName",
+ creatorId: defaultCreatorId,
+ });
+ await db.insert(boards).values({
+ id: createId(),
+ name: "newName",
+ creatorId: defaultCreatorId,
+ });
+
+ // Act
+ const actAsync = async () => await caller.renameBoard({ id: boardId, name: "Newname" });
+
+ // Assert
+ await expect(actAsync()).rejects.toThrowError("Board with similar name already exists");
+ });
+
+ test("should throw error when board not found", async () => {
+ // Arrange
+ const db = createDb();
+ const caller = boardRouter.createCaller({ db, session: defaultSession });
+
+ // Act
+ const actAsync = async () => await caller.renameBoard({ id: "nonExistentBoardId", name: "newName" });
+
+ // Assert
+ await expect(actAsync()).rejects.toThrowError("Board not found");
+ });
+});
+
+describe("changeBoardVisibility should change board visibility", () => {
+ test.each([["public"], ["private"]] satisfies ["private" | "public"][])(
+ "should change board visibility to %s",
+ async (visibility) => {
+ // Arrange
+ const db = createDb();
+ const caller = boardRouter.createCaller({ db, session: defaultSession });
+ const spy = vi.spyOn(boardAccess, "throwIfActionForbiddenAsync");
+
+ await db.insert(users).values({
+ id: defaultCreatorId,
+ });
+ const boardId = createId();
+ await db.insert(boards).values({
+ id: boardId,
+ name: "board",
+ creatorId: defaultCreatorId,
+ isPublic: visibility === "public",
+ });
+
+ // Act
+ await caller.changeBoardVisibility({
+ id: boardId,
+ visibility,
+ });
+
+ // Assert
+ const dbBoard = await db.query.boards.findFirst({
+ where: eq(boards.id, boardId),
+ });
+ expect(dbBoard).toBeDefined();
+ expect(dbBoard?.isPublic).toBe(visibility === "public");
+ expect(spy).toHaveBeenCalledWith(expect.anything(), expect.anything(), "full-access");
+ },
+ );
+});
+
+describe("deleteBoard should delete board", () => {
+ test("should delete board", async () => {
+ // Arrange
+ const db = createDb();
+ const caller = boardRouter.createCaller({ db, session: defaultSession });
+ const spy = vi.spyOn(boardAccess, "throwIfActionForbiddenAsync");
+
+ await db.insert(users).values({
+ id: defaultCreatorId,
+ });
+ const boardId = createId();
+ await db.insert(boards).values({
+ id: boardId,
+ name: "board",
+ creatorId: defaultCreatorId,
+ });
+
+ // Act
+ await caller.deleteBoard({ id: boardId });
+
+ // Assert
+ const dbBoard = await db.query.boards.findFirst({
+ where: eq(boards.id, boardId),
+ });
+ expect(dbBoard).toBeUndefined();
+ expect(spy).toHaveBeenCalledWith(expect.anything(), expect.anything(), "full-access");
+ });
+
+ test("should throw error when board not found", async () => {
+ // Arrange
+ const db = createDb();
+ const caller = boardRouter.createCaller({ db, session: defaultSession });
+
+ // Act
+ const actAsync = async () => await caller.deleteBoard({ id: "nonExistentBoardId" });
+
+ // Assert
+ await expect(actAsync()).rejects.toThrowError("Board not found");
+ });
+});
+
+describe("getHomeBoard should return home board", () => {
+ it("should return home board", async () => {
+ // Arrange
+ const spy = vi.spyOn(boardAccess, "throwIfActionForbiddenAsync");
+ const db = createDb();
+ const caller = boardRouter.createCaller({ db, session: defaultSession });
+
+ const fullBoardProps = await createFullBoardAsync(db, "home");
+
+ // Act
+ const result = await caller.getHomeBoard();
+
+ // Assert
+ expectInputToBeFullBoardWithName(result, {
+ name: "home",
+ ...fullBoardProps,
+ });
+ expect(spy).toHaveBeenCalledWith(expect.anything(), expect.anything(), "board-view");
+ });
+});
+
+describe("getBoardByName should return board by name", () => {
+ it.each([["default"], ["something"]])("should return board by name %s when present", async (name) => {
+ // Arrange
+ const spy = vi.spyOn(boardAccess, "throwIfActionForbiddenAsync");
+ const db = createDb();
+ const caller = boardRouter.createCaller({ db, session: defaultSession });
+
+ const fullBoardProps = await createFullBoardAsync(db, name);
+
+ // Act
+ const result = await caller.getBoardByName({ name });
+
+ // Assert
+ expectInputToBeFullBoardWithName(result, {
+ name,
+ ...fullBoardProps,
+ });
+ expect(spy).toHaveBeenCalledWith(expect.anything(), expect.anything(), "board-view");
+ });
+
+ it("should throw error when not present", async () => {
+ // Arrange
+ const db = createDb();
+ const caller = boardRouter.createCaller({ db, session: defaultSession });
+ await createFullBoardAsync(db, "default");
+
+ // Act
+ const actAsync = async () => await caller.getBoardByName({ name: "nonExistentBoard" });
+
+ // Assert
+ await expect(actAsync()).rejects.toThrowError("Board not found");
+ });
+});
+
+describe("savePartialBoardSettings should save general settings", () => {
+ it("should save general settings", async () => {
+ // Arrange
+ const spy = vi.spyOn(boardAccess, "throwIfActionForbiddenAsync");
+ const db = createDb();
+ const caller = boardRouter.createCaller({ db, session: defaultSession });
+
+ const newPageTitle = "newPageTitle";
+ const newMetaTitle = "newMetaTitle";
+ const newLogoImageUrl = "http://logo.image/url.png";
+ const newFaviconImageUrl = "http://favicon.image/url.png";
+ const newBackgroundImageAttachment = "scroll";
+ const newBackgroundImageSize = "cover";
+ const newBackgroundImageRepeat = "repeat";
+ const newBackgroundImageUrl = "http://background.image/url.png";
+ const newColumnCount = 2;
+ const newCustomCss = "body { background-color: blue; }";
+ const newOpacity = 0.8;
+ const newPrimaryColor = "#0000ff";
+ const newSecondaryColor = "#ff00ff";
+
+ const { boardId } = await createFullBoardAsync(db, "default");
+
+ // Act
+ await caller.savePartialBoardSettings({
+ pageTitle: newPageTitle,
+ metaTitle: newMetaTitle,
+ logoImageUrl: newLogoImageUrl,
+ faviconImageUrl: newFaviconImageUrl,
+ backgroundImageAttachment: newBackgroundImageAttachment,
+ backgroundImageRepeat: newBackgroundImageRepeat,
+ backgroundImageSize: newBackgroundImageSize,
+ backgroundImageUrl: newBackgroundImageUrl,
+ columnCount: newColumnCount,
+ customCss: newCustomCss,
+ opacity: newOpacity,
+ primaryColor: newPrimaryColor,
+ secondaryColor: newSecondaryColor,
+ id: boardId,
+ });
+
+ // Assert
+ const dbBoard = await db.query.boards.findFirst({
+ where: eq(boards.id, boardId),
+ });
+ expect(dbBoard).toBeDefined();
+ expect(dbBoard?.pageTitle).toBe(newPageTitle);
+ expect(dbBoard?.metaTitle).toBe(newMetaTitle);
+ expect(dbBoard?.logoImageUrl).toBe(newLogoImageUrl);
+ expect(dbBoard?.faviconImageUrl).toBe(newFaviconImageUrl);
+ expect(dbBoard?.backgroundImageAttachment).toBe(newBackgroundImageAttachment);
+ expect(dbBoard?.backgroundImageRepeat).toBe(newBackgroundImageRepeat);
+ expect(dbBoard?.backgroundImageSize).toBe(newBackgroundImageSize);
+ expect(dbBoard?.backgroundImageUrl).toBe(newBackgroundImageUrl);
+ expect(dbBoard?.columnCount).toBe(newColumnCount);
+ expect(dbBoard?.customCss).toBe(newCustomCss);
+ expect(dbBoard?.opacity).toBe(newOpacity);
+ expect(dbBoard?.primaryColor).toBe(newPrimaryColor);
+ expect(dbBoard?.secondaryColor).toBe(newSecondaryColor);
+
+ expect(spy).toHaveBeenCalledWith(expect.anything(), expect.anything(), "board-change");
+ });
+
+ it("should throw error when board not found", async () => {
+ const db = createDb();
+ const caller = boardRouter.createCaller({ db, session: defaultSession });
+
+ const actAsync = async () =>
+ await caller.savePartialBoardSettings({
+ pageTitle: "newPageTitle",
+ metaTitle: "newMetaTitle",
+ logoImageUrl: "http://logo.image/url.png",
+ faviconImageUrl: "http://favicon.image/url.png",
+ id: "nonExistentBoardId",
+ });
+
+ await expect(actAsync()).rejects.toThrowError("Board not found");
+ });
+});
+
+describe("saveBoard should save full board", () => {
+ it("should remove section when not present in input", async () => {
+ const spy = vi.spyOn(boardAccess, "throwIfActionForbiddenAsync");
+ const db = createDb();
+ const caller = boardRouter.createCaller({ db, session: defaultSession });
+
+ const { boardId, sectionId } = await createFullBoardAsync(db, "default");
+
+ await caller.saveBoard({
+ id: boardId,
+ sections: [
+ {
+ id: createId(),
+ kind: "empty",
+ position: 0,
+ items: [],
+ },
+ ],
+ });
+
+ const board = await db.query.boards.findFirst({
+ where: eq(boards.id, boardId),
+ with: {
+ sections: true,
+ },
+ });
+
+ const section = await db.query.boards.findFirst({
+ where: eq(sections.id, sectionId),
+ });
+
+ const definedBoard = expectToBeDefined(board);
+ expect(definedBoard.sections.length).toBe(1);
+ expect(definedBoard.sections[0]?.id).not.toBe(sectionId);
+ expect(section).toBeUndefined();
+ expect(spy).toHaveBeenCalledWith(expect.anything(), expect.anything(), "board-change");
+ });
+ it("should remove item when not present in input", async () => {
+ const spy = vi.spyOn(boardAccess, "throwIfActionForbiddenAsync");
+ const db = createDb();
+ const caller = boardRouter.createCaller({ db, session: defaultSession });
+
+ const { boardId, itemId, sectionId } = await createFullBoardAsync(db, "default");
+
+ await caller.saveBoard({
+ id: boardId,
+ sections: [
+ {
+ id: sectionId,
+ kind: "empty",
+ position: 0,
+ items: [
+ {
+ id: createId(),
+ kind: "clock",
+ options: { is24HourFormat: true },
+ integrations: [],
+ height: 1,
+ width: 1,
+ xOffset: 0,
+ yOffset: 0,
+ advancedOptions: {},
+ },
+ ],
+ },
+ ],
+ });
+
+ const board = await db.query.boards.findFirst({
+ where: eq(boards.id, boardId),
+ with: {
+ sections: {
+ with: {
+ items: true,
+ },
+ },
+ },
+ });
+
+ const item = await db.query.items.findFirst({
+ where: eq(items.id, itemId),
+ });
+
+ const definedBoard = expectToBeDefined(board);
+ expect(definedBoard.sections.length).toBe(1);
+ const firstSection = expectToBeDefined(definedBoard.sections[0]);
+ expect(firstSection.items.length).toBe(1);
+ expect(firstSection.items[0]?.id).not.toBe(itemId);
+ expect(item).toBeUndefined();
+ expect(spy).toHaveBeenCalledWith(expect.anything(), expect.anything(), "board-change");
+ });
+ it("should remove integration reference when not present in input", async () => {
+ const spy = vi.spyOn(boardAccess, "throwIfActionForbiddenAsync");
+ const db = createDb();
+ const caller = boardRouter.createCaller({ db, session: defaultSession });
+ const anotherIntegration = {
+ id: createId(),
+ kind: "adGuardHome",
+ name: "AdGuard Home",
+ url: "http://localhost:3000",
+ } as const;
+
+ const { boardId, itemId, integrationId, sectionId } = await createFullBoardAsync(db, "default");
+ await db.insert(integrations).values(anotherIntegration);
+
+ await caller.saveBoard({
+ id: boardId,
+ sections: [
+ {
+ id: sectionId,
+ kind: "empty",
+ position: 0,
+ items: [
+ {
+ id: itemId,
+ kind: "clock",
+ options: { is24HourFormat: true },
+ integrations: [anotherIntegration],
+ height: 1,
+ width: 1,
+ xOffset: 0,
+ yOffset: 0,
+ advancedOptions: {},
+ },
+ ],
+ },
+ ],
+ });
+
+ const board = await db.query.boards.findFirst({
+ where: eq(boards.id, boardId),
+ with: {
+ sections: {
+ with: {
+ items: {
+ with: {
+ integrations: true,
+ },
+ },
+ },
+ },
+ },
+ });
+
+ const integration = await db.query.integrationItems.findFirst({
+ where: eq(integrationItems.integrationId, integrationId),
+ });
+
+ const definedBoard = expectToBeDefined(board);
+ expect(definedBoard.sections.length).toBe(1);
+ const firstSection = expectToBeDefined(definedBoard.sections[0]);
+ expect(firstSection.items.length).toBe(1);
+ const firstItem = expectToBeDefined(firstSection.items[0]);
+ expect(firstItem.integrations.length).toBe(1);
+ expect(firstItem.integrations[0]?.integrationId).not.toBe(integrationId);
+ expect(integration).toBeUndefined();
+ expect(spy).toHaveBeenCalledWith(expect.anything(), expect.anything(), "board-change");
+ });
+ it.each([[{ kind: "empty" as const }], [{ kind: "category" as const, name: "My first category" }]])(
+ "should add section when present in input",
+ async (partialSection) => {
+ const spy = vi.spyOn(boardAccess, "throwIfActionForbiddenAsync");
+ const db = createDb();
+ const caller = boardRouter.createCaller({ db, session: defaultSession });
+
+ const { boardId, sectionId } = await createFullBoardAsync(db, "default");
+
+ const newSectionId = createId();
+ await caller.saveBoard({
+ id: boardId,
+ sections: [
+ {
+ id: newSectionId,
+ position: 1,
+ items: [],
+ ...partialSection,
+ },
+ {
+ id: sectionId,
+ kind: "empty",
+ position: 0,
+ items: [],
+ },
+ ],
+ });
+
+ const board = await db.query.boards.findFirst({
+ where: eq(boards.id, boardId),
+ with: {
+ sections: true,
+ },
+ });
+
+ const section = await db.query.sections.findFirst({
+ where: eq(sections.id, newSectionId),
+ });
+
+ const definedBoard = expectToBeDefined(board);
+ expect(definedBoard.sections.length).toBe(2);
+ const addedSection = expectToBeDefined(definedBoard.sections.find((section) => section.id === newSectionId));
+ expect(addedSection).toBeDefined();
+ expect(addedSection.id).toBe(newSectionId);
+ expect(addedSection.kind).toBe(partialSection.kind);
+ expect(addedSection.position).toBe(1);
+ if ("name" in partialSection) {
+ expect(addedSection.name).toBe(partialSection.name);
+ }
+ expect(section).toBeDefined();
+ expect(spy).toHaveBeenCalledWith(expect.anything(), expect.anything(), "board-change");
+ },
+ );
+ it("should add item when present in input", async () => {
+ const spy = vi.spyOn(boardAccess, "throwIfActionForbiddenAsync");
+ const db = createDb();
+ const caller = boardRouter.createCaller({ db, session: defaultSession });
+
+ const { boardId, sectionId } = await createFullBoardAsync(db, "default");
+
+ const newItemId = createId();
+ await caller.saveBoard({
+ id: boardId,
+ sections: [
+ {
+ id: sectionId,
+ kind: "empty",
+ position: 0,
+ items: [
+ {
+ id: newItemId,
+ kind: "clock",
+ options: { is24HourFormat: true },
+ integrations: [],
+ height: 1,
+ width: 1,
+ xOffset: 3,
+ yOffset: 2,
+ advancedOptions: {},
+ },
+ ],
+ },
+ ],
+ });
+
+ const board = await db.query.boards.findFirst({
+ where: eq(boards.id, boardId),
+ with: {
+ sections: {
+ with: {
+ items: true,
+ },
+ },
+ },
+ });
+
+ const item = await db.query.items.findFirst({
+ where: eq(items.id, newItemId),
+ });
+
+ const definedBoard = expectToBeDefined(board);
+ expect(definedBoard.sections.length).toBe(1);
+ const firstSection = expectToBeDefined(definedBoard.sections[0]);
+ expect(firstSection.items.length).toBe(1);
+ const addedItem = expectToBeDefined(firstSection.items.find((item) => item.id === newItemId));
+ expect(addedItem).toBeDefined();
+ expect(addedItem.id).toBe(newItemId);
+ expect(addedItem.kind).toBe("clock");
+ expect(addedItem.options).toBe(SuperJSON.stringify({ is24HourFormat: true }));
+ expect(addedItem.height).toBe(1);
+ expect(addedItem.width).toBe(1);
+ expect(addedItem.xOffset).toBe(3);
+ expect(addedItem.yOffset).toBe(2);
+ expect(item).toBeDefined();
+ expect(spy).toHaveBeenCalledWith(expect.anything(), expect.anything(), "board-change");
+ });
+ it("should add integration reference when present in input", async () => {
+ const spy = vi.spyOn(boardAccess, "throwIfActionForbiddenAsync");
+ const db = createDb();
+ const caller = boardRouter.createCaller({ db, session: defaultSession });
+ const integration = {
+ id: createId(),
+ kind: "plex",
+ name: "Plex",
+ url: "http://plex.local",
+ } as const;
+
+ const { boardId, itemId, sectionId } = await createFullBoardAsync(db, "default");
+ await db.insert(integrations).values(integration);
+
+ await caller.saveBoard({
+ id: boardId,
+ sections: [
+ {
+ id: sectionId,
+ kind: "empty",
+ position: 0,
+ items: [
+ {
+ id: itemId,
+ kind: "clock",
+ options: { is24HourFormat: true },
+ integrations: [integration],
+ height: 1,
+ width: 1,
+ xOffset: 0,
+ yOffset: 0,
+ advancedOptions: {},
+ },
+ ],
+ },
+ ],
+ });
+
+ const board = await db.query.boards.findFirst({
+ where: eq(boards.id, boardId),
+ with: {
+ sections: {
+ with: {
+ items: {
+ with: {
+ integrations: true,
+ },
+ },
+ },
+ },
+ },
+ });
+
+ const integrationItem = await db.query.integrationItems.findFirst({
+ where: eq(integrationItems.integrationId, integration.id),
+ });
+
+ const definedBoard = expectToBeDefined(board);
+ expect(definedBoard.sections.length).toBe(1);
+ const firstSection = expectToBeDefined(definedBoard.sections[0]);
+ expect(firstSection.items.length).toBe(1);
+ const firstItem = expectToBeDefined(firstSection.items.find((item) => item.id === itemId));
+ expect(firstItem.integrations.length).toBe(1);
+ expect(firstItem.integrations[0]?.integrationId).toBe(integration.id);
+ expect(integrationItem).toBeDefined();
+ expect(spy).toHaveBeenCalledWith(expect.anything(), expect.anything(), "board-change");
+ });
+ it("should update section when present in input", async () => {
+ const db = createDb();
+ const caller = boardRouter.createCaller({ db, session: defaultSession });
+
+ const { boardId, sectionId } = await createFullBoardAsync(db, "default");
+ const newSectionId = createId();
+ await db.insert(sections).values({
+ id: newSectionId,
+ kind: "category",
+ name: "Before",
+ position: 1,
+ boardId,
+ });
+
+ await caller.saveBoard({
+ id: boardId,
+ sections: [
+ {
+ id: sectionId,
+ kind: "category",
+ position: 1,
+ name: "Test",
+ items: [],
+ },
+ {
+ id: newSectionId,
+ kind: "category",
+ name: "After",
+ position: 0,
+ items: [],
+ },
+ ],
+ });
+
+ const board = await db.query.boards.findFirst({
+ where: eq(boards.id, boardId),
+ with: {
+ sections: true,
+ },
+ });
+
+ const definedBoard = expectToBeDefined(board);
+ expect(definedBoard.sections.length).toBe(2);
+ const firstSection = expectToBeDefined(definedBoard.sections.find((section) => section.id === sectionId));
+ expect(firstSection.id).toBe(sectionId);
+ expect(firstSection.kind).toBe("empty");
+ expect(firstSection.position).toBe(1);
+ expect(firstSection.name).toBe(null);
+ const secondSection = expectToBeDefined(definedBoard.sections.find((section) => section.id === newSectionId));
+ expect(secondSection.id).toBe(newSectionId);
+ expect(secondSection.kind).toBe("category");
+ expect(secondSection.position).toBe(0);
+ expect(secondSection.name).toBe("After");
+ });
+ it("should update item when present in input", async () => {
+ const spy = vi.spyOn(boardAccess, "throwIfActionForbiddenAsync");
+ const db = createDb();
+ const caller = boardRouter.createCaller({ db, session: defaultSession });
+
+ const { boardId, itemId, sectionId } = await createFullBoardAsync(db, "default");
+
+ await caller.saveBoard({
+ id: boardId,
+ sections: [
+ {
+ id: sectionId,
+ kind: "empty",
+ position: 0,
+ items: [
+ {
+ id: itemId,
+ kind: "clock",
+ options: { is24HourFormat: false },
+ integrations: [],
+ height: 3,
+ width: 2,
+ xOffset: 7,
+ yOffset: 5,
+ advancedOptions: {},
+ },
+ ],
+ },
+ ],
+ });
+
+ const board = await db.query.boards.findFirst({
+ where: eq(boards.id, boardId),
+ with: {
+ sections: {
+ with: {
+ items: true,
+ },
+ },
+ },
+ });
+
+ const definedBoard = expectToBeDefined(board);
+ expect(definedBoard.sections.length).toBe(1);
+ const firstSection = expectToBeDefined(definedBoard.sections[0]);
+ expect(firstSection.items.length).toBe(1);
+ const firstItem = expectToBeDefined(firstSection.items.find((item) => item.id === itemId));
+ expect(firstItem.id).toBe(itemId);
+ expect(firstItem.kind).toBe("clock");
+ expect(SuperJSON.parse<{ is24HourFormat: boolean }>(firstItem.options).is24HourFormat).toBe(false);
+ expect(firstItem.height).toBe(3);
+ expect(firstItem.width).toBe(2);
+ expect(firstItem.xOffset).toBe(7);
+ expect(firstItem.yOffset).toBe(5);
+ expect(spy).toHaveBeenCalledWith(expect.anything(), expect.anything(), "board-change");
+ });
+ it("should fail when board not found", async () => {
+ const db = createDb();
+ const caller = boardRouter.createCaller({ db, session: defaultSession });
+
+ const actAsync = async () =>
+ await caller.saveBoard({
+ id: "nonExistentBoardId",
+ sections: [],
+ });
+
+ await expect(actAsync()).rejects.toThrowError("Board not found");
+ });
+});
+
+describe("getBoardPermissions should return board permissions", () => {
+ test("should return board permissions", async () => {
+ // Arrange
+ const db = createDb();
+ const caller = boardRouter.createCaller({ db, session: defaultSession });
+ const spy = vi.spyOn(boardAccess, "throwIfActionForbiddenAsync");
+
+ const user1 = await createRandomUserAsync(db);
+ const user2 = await createRandomUserAsync(db);
+ await db.insert(users).values({
+ id: defaultCreatorId,
+ });
+
+ const boardId = createId();
+ await db.insert(boards).values({
+ id: boardId,
+ name: "board",
+ creatorId: defaultCreatorId,
+ });
+
+ await db.insert(boardUserPermissions).values([
+ {
+ userId: user1,
+ permission: "board-view",
+ boardId,
+ },
+ {
+ userId: user2,
+ permission: "board-change",
+ boardId,
+ },
+ ]);
+
+ const groupId = createId();
+ await db.insert(groups).values({
+ id: groupId,
+ name: "group1",
+ });
+
+ await db.insert(boardGroupPermissions).values({
+ groupId,
+ permission: "board-view",
+ boardId,
+ });
+
+ await db.insert(groupPermissions).values({
+ groupId,
+ permission: "admin",
+ });
+
+ // Act
+ const result = await caller.getBoardPermissions({ id: boardId });
+
+ // Assert
+ expect(result.groupPermissions).toEqual([{ group: { id: groupId, name: "group1" }, permission: "board-view" }]);
+ expect(result.userPermissions).toEqual(
+ expect.arrayContaining([
+ {
+ user: { id: user1, name: null, image: null },
+ permission: "board-view",
+ },
+ {
+ user: { id: user2, name: null, image: null },
+ permission: "board-change",
+ },
+ ]),
+ );
+ expect(result.inherited).toEqual([{ group: { id: groupId, name: "group1" }, permission: "admin" }]);
+ expect(spy).toHaveBeenCalledWith(expect.anything(), expect.anything(), "full-access");
+ });
+});
+
+describe("saveUserBoardPermissions should save user board permissions", () => {
+ test.each([["board-view"], ["board-change"]] satisfies [BoardPermission][])(
+ "should save user board permissions",
+ async (permission) => {
+ // Arrange
+ const db = createDb();
+ const caller = boardRouter.createCaller({ db, session: defaultSession });
+ const spy = vi.spyOn(boardAccess, "throwIfActionForbiddenAsync");
+
+ const user1 = await createRandomUserAsync(db);
+ await db.insert(users).values({
+ id: defaultCreatorId,
+ });
+
+ const boardId = createId();
+ await db.insert(boards).values({
+ id: boardId,
+ name: "board",
+ creatorId: defaultCreatorId,
+ });
+
+ // Act
+ await caller.saveUserBoardPermissions({
+ id: boardId,
+ permissions: [
+ {
+ itemId: user1,
+ permission,
+ },
+ ],
+ });
+
+ // Assert
+ const dbUserPermission = await db.query.boardUserPermissions.findFirst({
+ where: eq(boardUserPermissions.userId, user1),
+ });
+ expect(dbUserPermission).toBeDefined();
+ expect(spy).toHaveBeenCalledWith(expect.anything(), expect.anything(), "full-access");
+ },
+ );
+});
+
+describe("saveGroupBoardPermissions should save group board permissions", () => {
+ test.each([["board-view"], ["board-change"]] satisfies [BoardPermission][])(
+ "should save group board permissions",
+ async (permission) => {
+ // Arrange
+ const db = createDb();
+ const caller = boardRouter.createCaller({ db, session: defaultSession });
+ const spy = vi.spyOn(boardAccess, "throwIfActionForbiddenAsync");
+
+ await db.insert(users).values({
+ id: defaultCreatorId,
+ });
+
+ const groupId = createId();
+ await db.insert(groups).values({
+ id: groupId,
+ name: "group1",
+ });
+
+ const boardId = createId();
+ await db.insert(boards).values({
+ id: boardId,
+ name: "board",
+ creatorId: defaultCreatorId,
+ });
+
+ // Act
+ await caller.saveGroupBoardPermissions({
+ id: boardId,
+ permissions: [
+ {
+ itemId: groupId,
+ permission,
+ },
+ ],
+ });
+
+ // Assert
+ const dbGroupPermission = await db.query.boardGroupPermissions.findFirst({
+ where: eq(boardGroupPermissions.groupId, groupId),
+ });
+ expect(dbGroupPermission).toBeDefined();
+ expect(spy).toHaveBeenCalledWith(expect.anything(), expect.anything(), "full-access");
+ },
+ );
+});
+
+const expectInputToBeFullBoardWithName = (
+ input: RouterOutputs["board"]["getHomeBoard"],
+ props: { name: string } & Awaited>,
+) => {
+ expect(input.id).toBe(props.boardId);
+ expect(input.name).toBe(props.name);
+ expect(input.sections.length).toBe(1);
+ const firstSection = expectToBeDefined(input.sections[0]);
+ expect(firstSection.id).toBe(props.sectionId);
+ expect(firstSection.items.length).toBe(1);
+ const firstItem = expectToBeDefined(firstSection.items[0]);
+ expect(firstItem.id).toBe(props.itemId);
+ expect(firstItem.kind).toBe("clock");
+ if (firstItem.kind === "clock") {
+ expect(firstItem.options.is24HourFormat).toBe(true);
+ }
+ expect(firstItem.integrations.length).toBe(1);
+ const firstIntegration = expectToBeDefined(firstItem.integrations[0]);
+ expect(firstIntegration.id).toBe(props.integrationId);
+ expect(firstIntegration.kind).toBe("adGuardHome");
+};
+
+const createFullBoardAsync = async (db: Database, name: string) => {
+ await db.insert(users).values({
+ id: defaultCreatorId,
+ });
+
+ const boardId = createId();
+ await db.insert(boards).values({
+ id: boardId,
+ name,
+ creatorId: defaultCreatorId,
+ });
+
+ const sectionId = createId();
+ await db.insert(sections).values({
+ id: sectionId,
+ kind: "empty",
+ position: 0,
+ boardId,
+ });
+
+ const itemId = createId();
+ await db.insert(items).values({
+ id: itemId,
+ kind: "clock",
+ height: 1,
+ width: 1,
+ xOffset: 0,
+ yOffset: 0,
+ sectionId,
+ options: SuperJSON.stringify({ is24HourFormat: true }),
+ });
+
+ const integrationId = createId();
+ await db.insert(integrations).values({
+ id: integrationId,
+ kind: "adGuardHome",
+ name: "AdGuard Home",
+ url: "http://localhost:3000",
+ });
+
+ await db.insert(integrationItems).values({
+ integrationId,
+ itemId,
+ });
+
+ return {
+ boardId,
+ sectionId,
+ itemId,
+ integrationId,
+ };
+};
diff --git a/packages/api/src/router/test/board/board-access.spec.ts b/packages/api/src/router/test/board/board-access.spec.ts
new file mode 100644
index 000000000..a9072f7e6
--- /dev/null
+++ b/packages/api/src/router/test/board/board-access.spec.ts
@@ -0,0 +1,151 @@
+import { describe, expect, test, vi } from "vitest";
+
+import * as authShared from "@homarr/auth/shared";
+import { createId, eq } from "@homarr/db";
+import { boards, users } from "@homarr/db/schema/sqlite";
+import { createDb } from "@homarr/db/test";
+
+import { throwIfActionForbiddenAsync } from "../../board/board-access";
+
+const defaultCreatorId = createId();
+
+const expectActToBeAsync = async (act: () => Promise, success: boolean) => {
+ if (!success) {
+ await expect(act()).rejects.toThrow("Board not found");
+ return;
+ }
+
+ await expect(act()).resolves.toBeUndefined();
+};
+
+// TODO: most of this test can be used for constructBoardPermissions
+// TODO: the tests for the board-access can be reduced to about 4 tests (as the unit has shrunk)
+
+describe("throwIfActionForbiddenAsync should check access to board and return boolean", () => {
+ test.each([
+ ["full-access" as const, true],
+ ["board-change" as const, true],
+ ["board-view" as const, true],
+ ])("with permission %s should return %s when hasFullAccess is true", async (permission, expectedResult) => {
+ // Arrange
+ const db = createDb();
+ const spy = vi.spyOn(authShared, "constructBoardPermissions");
+ spy.mockReturnValue({
+ hasFullAccess: true,
+ hasChangeAccess: false,
+ hasViewAccess: false,
+ });
+
+ await db.insert(users).values({ id: defaultCreatorId });
+ const boardId = createId();
+ await db.insert(boards).values({
+ id: boardId,
+ name: "test",
+ creatorId: defaultCreatorId,
+ });
+
+ // Act
+ const act = () => throwIfActionForbiddenAsync({ db, session: null }, eq(boards.id, boardId), permission);
+
+ // Assert
+ await expectActToBeAsync(act, expectedResult);
+ });
+
+ test.each([
+ ["full-access" as const, false],
+ ["board-change" as const, true],
+ ["board-view" as const, true],
+ ])("with permission %s should return %s when hasChangeAccess is true", async (permission, expectedResult) => {
+ // Arrange
+ const db = createDb();
+ const spy = vi.spyOn(authShared, "constructBoardPermissions");
+ spy.mockReturnValue({
+ hasFullAccess: false,
+ hasChangeAccess: true,
+ hasViewAccess: false,
+ });
+
+ await db.insert(users).values({ id: defaultCreatorId });
+ const boardId = createId();
+ await db.insert(boards).values({
+ id: boardId,
+ name: "test",
+ creatorId: defaultCreatorId,
+ });
+
+ // Act
+ const act = () => throwIfActionForbiddenAsync({ db, session: null }, eq(boards.id, boardId), permission);
+
+ // Assert
+ await expectActToBeAsync(act, expectedResult);
+ });
+
+ test.each([
+ ["full-access" as const, false],
+ ["board-change" as const, false],
+ ["board-view" as const, true],
+ ])("with permission %s should return %s when hasViewAccess is true", async (permission, expectedResult) => {
+ // Arrange
+ const db = createDb();
+ const spy = vi.spyOn(authShared, "constructBoardPermissions");
+ spy.mockReturnValue({
+ hasFullAccess: false,
+ hasChangeAccess: false,
+ hasViewAccess: true,
+ });
+
+ await db.insert(users).values({ id: defaultCreatorId });
+ const boardId = createId();
+ await db.insert(boards).values({
+ id: boardId,
+ name: "test",
+ creatorId: defaultCreatorId,
+ });
+
+ // Act
+ const act = () => throwIfActionForbiddenAsync({ db, session: null }, eq(boards.id, boardId), permission);
+
+ // Assert
+ await expectActToBeAsync(act, expectedResult);
+ });
+
+ test.each([
+ ["full-access" as const, false],
+ ["board-change" as const, false],
+ ["board-view" as const, false],
+ ])("with permission %s should return %s when hasViewAccess is false", async (permission, expectedResult) => {
+ // Arrange
+ const db = createDb();
+ const spy = vi.spyOn(authShared, "constructBoardPermissions");
+ spy.mockReturnValue({
+ hasFullAccess: false,
+ hasChangeAccess: false,
+ hasViewAccess: false,
+ });
+
+ await db.insert(users).values({ id: defaultCreatorId });
+ const boardId = createId();
+ await db.insert(boards).values({
+ id: boardId,
+ name: "test",
+ creatorId: defaultCreatorId,
+ });
+
+ // Act
+ const act = () => throwIfActionForbiddenAsync({ db, session: null }, eq(boards.id, boardId), permission);
+
+ // Assert
+ await expectActToBeAsync(act, expectedResult);
+ });
+
+ test("should throw when board is not found", async () => {
+ // Arrange
+ const db = createDb();
+
+ // Act
+ const act = () => throwIfActionForbiddenAsync({ db, session: null }, eq(boards.id, createId()), "full-access");
+
+ // Assert
+ await expect(act()).rejects.toThrow("Board not found");
+ });
+});
diff --git a/packages/api/src/router/test/group.spec.ts b/packages/api/src/router/test/group.spec.ts
new file mode 100644
index 000000000..2901ec32b
--- /dev/null
+++ b/packages/api/src/router/test/group.spec.ts
@@ -0,0 +1,644 @@
+import { describe, expect, test, vi } from "vitest";
+
+import type { Session } from "@homarr/auth";
+import { createId, eq } from "@homarr/db";
+import { groupMembers, groupPermissions, groups, users } from "@homarr/db/schema/sqlite";
+import { createDb } from "@homarr/db/test";
+
+import { groupRouter } from "../group";
+
+const defaultOwnerId = createId();
+const defaultSession = {
+ user: {
+ id: defaultOwnerId,
+ permissions: [],
+ },
+ expires: new Date().toISOString(),
+} satisfies Session;
+
+// Mock the auth module to return an empty session
+vi.mock("@homarr/auth", async () => {
+ const mod = await import("@homarr/auth/security");
+ return { ...mod, auth: () => ({}) as Session };
+});
+
+describe("paginated should return a list of groups with pagination", () => {
+ test.each([
+ [1, 3],
+ [2, 2],
+ ])(
+ "with 5 groups in database and pageSize set to 3 on page %s it should return %s groups",
+ async (page, expectedCount) => {
+ // Arrange
+ const db = createDb();
+ const caller = groupRouter.createCaller({ db, session: defaultSession });
+
+ await db.insert(groups).values(
+ [1, 2, 3, 4, 5].map((number) => ({
+ id: number.toString(),
+ name: `Group ${number}`,
+ })),
+ );
+
+ // Act
+ const result = await caller.getPaginated({
+ page,
+ pageSize: 3,
+ });
+
+ // Assert
+ expect(result.items.length).toBe(expectedCount);
+ },
+ );
+
+ test("with 5 groups in database and pagesize set to 3 it should return total count 5", async () => {
+ // Arrange
+ const db = createDb();
+ const caller = groupRouter.createCaller({ db, session: defaultSession });
+
+ await db.insert(groups).values(
+ [1, 2, 3, 4, 5].map((number) => ({
+ id: number.toString(),
+ name: `Group ${number}`,
+ })),
+ );
+
+ // Act
+ const result = await caller.getPaginated({
+ pageSize: 3,
+ });
+
+ // Assert
+ expect(result.totalCount).toBe(5);
+ });
+
+ test("groups should contain id, name, email and image of members", async () => {
+ // Arrange
+ const db = createDb();
+ const caller = groupRouter.createCaller({ db, session: defaultSession });
+
+ const user = createDummyUser();
+ await db.insert(users).values(user);
+ const groupId = createId();
+ await db.insert(groups).values({
+ id: groupId,
+ name: "Group",
+ });
+ await db.insert(groupMembers).values({
+ groupId,
+ userId: user.id,
+ });
+
+ // Act
+ const result = await caller.getPaginated({});
+
+ // Assert
+ const item = result.items[0];
+ expect(item).toBeDefined();
+ expect(item?.members.length).toBe(1);
+ const userKeys = Object.keys(item?.members[0] ?? {});
+ expect(userKeys.length).toBe(4);
+ expect(["id", "name", "email", "image"].some((key) => userKeys.includes(key)));
+ });
+
+ test.each([
+ [undefined, 5, "first"],
+ ["d", 2, "second"],
+ ["th", 3, "third"],
+ ["fi", 2, "first"],
+ ])(
+ "groups should be searchable by name with contains pattern, query %s should result in %s results",
+ async (query, expectedCount, firstKey) => {
+ // Arrange
+ const db = createDb();
+ const caller = groupRouter.createCaller({ db, session: defaultSession });
+
+ await db.insert(groups).values(
+ ["first", "second", "third", "forth", "fifth"].map((key, index) => ({
+ id: index.toString(),
+ name: key,
+ })),
+ );
+
+ // Act
+ const result = await caller.getPaginated({
+ search: query,
+ });
+
+ // Assert
+ expect(result.totalCount).toBe(expectedCount);
+ expect(result.items.at(0)?.name).toBe(firstKey);
+ },
+ );
+});
+
+describe("byId should return group by id including members and permissions", () => {
+ test('should return group with id "1" with members and permissions', async () => {
+ // Arrange
+ const db = createDb();
+ const caller = groupRouter.createCaller({ db, session: defaultSession });
+
+ const user = createDummyUser();
+ const groupId = "1";
+ await db.insert(users).values(user);
+ await db.insert(groups).values([
+ {
+ id: groupId,
+ name: "Group",
+ },
+ {
+ id: createId(),
+ name: "Another group",
+ },
+ ]);
+ await db.insert(groupMembers).values({
+ userId: user.id,
+ groupId,
+ });
+ await db.insert(groupPermissions).values({
+ groupId,
+ permission: "admin",
+ });
+
+ // Act
+ const result = await caller.getById({
+ id: groupId,
+ });
+
+ // Assert
+ expect(result.id).toBe(groupId);
+ expect(result.members.length).toBe(1);
+
+ const userKeys = Object.keys(result?.members[0] ?? {});
+ expect(userKeys.length).toBe(4);
+ expect(["id", "name", "email", "image"].some((key) => userKeys.includes(key)));
+ expect(result.permissions.length).toBe(1);
+ expect(result.permissions[0]).toBe("admin");
+ });
+
+ test("with group id 1 and group 2 in database it should throw NOT_FOUND error", async () => {
+ // Arrange
+ const db = createDb();
+ const caller = groupRouter.createCaller({ db, session: defaultSession });
+
+ await db.insert(groups).values({
+ id: "2",
+ name: "Group",
+ });
+
+ // Act
+ const actAsync = async () => await caller.getById({ id: "1" });
+
+ // Assert
+ await expect(actAsync()).rejects.toThrow("Group not found");
+ });
+});
+
+describe("create should create group in database", () => {
+ test("with valid input (64 character name) and non existing name it should be successful", async () => {
+ // Arrange
+ const db = createDb();
+ const caller = groupRouter.createCaller({ db, session: defaultSession });
+
+ const name = "a".repeat(64);
+ await db.insert(users).values(defaultSession.user);
+
+ // Act
+ const result = await caller.createGroup({
+ name,
+ });
+
+ // Assert
+ const item = await db.query.groups.findFirst({
+ where: eq(groups.id, result),
+ });
+
+ expect(item).toBeDefined();
+ expect(item?.id).toBe(result);
+ expect(item?.ownerId).toBe(defaultOwnerId);
+ expect(item?.name).toBe(name);
+ });
+
+ test("with more than 64 characters name it should fail while validation", async () => {
+ // Arrange
+ const db = createDb();
+ const caller = groupRouter.createCaller({ db, session: defaultSession });
+ const longName = "a".repeat(65);
+
+ // Act
+ const actAsync = async () =>
+ await caller.createGroup({
+ name: longName,
+ });
+
+ // Assert
+ await expect(actAsync()).rejects.toThrow("too_big");
+ });
+
+ test.each([
+ ["test", "Test"],
+ ["test", "Test "],
+ ["test", "test"],
+ ["test", " TeSt"],
+ ])("with similar name %s it should fail to create %s", async (similarName, nameToCreate) => {
+ // Arrange
+ const db = createDb();
+ const caller = groupRouter.createCaller({ db, session: defaultSession });
+
+ await db.insert(groups).values({
+ id: createId(),
+ name: similarName,
+ });
+
+ // Act
+ const actAsync = async () => await caller.createGroup({ name: nameToCreate });
+
+ // Assert
+ await expect(actAsync()).rejects.toThrow("similar name");
+ });
+});
+
+describe("update should update name with value that is no duplicate", () => {
+ test.each([
+ ["first", "second ", "second"],
+ ["first", " first", "first"],
+ ])("update should update name from %s to %s normalized", async (initialValue, updateValue, expectedValue) => {
+ // Arrange
+ const db = createDb();
+ const caller = groupRouter.createCaller({ db, session: defaultSession });
+
+ const groupId = createId();
+ await db.insert(groups).values([
+ {
+ id: groupId,
+ name: initialValue,
+ },
+ {
+ id: createId(),
+ name: "Third",
+ },
+ ]);
+
+ // Act
+ await caller.updateGroup({
+ id: groupId,
+ name: updateValue,
+ });
+
+ // Assert
+ const value = await db.query.groups.findFirst({
+ where: eq(groups.id, groupId),
+ });
+ expect(value?.name).toBe(expectedValue);
+ });
+
+ test.each([
+ ["Second ", "second"],
+ [" seCond", "second"],
+ ])("with similar name %s it should fail to update %s", async (updateValue, initialDuplicate) => {
+ // Arrange
+ const db = createDb();
+ const caller = groupRouter.createCaller({ db, session: defaultSession });
+
+ const groupId = createId();
+ await db.insert(groups).values([
+ {
+ id: groupId,
+ name: "Something",
+ },
+ {
+ id: createId(),
+ name: initialDuplicate,
+ },
+ ]);
+
+ // Act
+ const actAsync = async () =>
+ await caller.updateGroup({
+ id: groupId,
+ name: updateValue,
+ });
+
+ // Assert
+ await expect(actAsync()).rejects.toThrow("similar name");
+ });
+
+ test("with non existing id it should throw not found error", async () => {
+ // Arrange
+ const db = createDb();
+ const caller = groupRouter.createCaller({ db, session: defaultSession });
+
+ await db.insert(groups).values({
+ id: createId(),
+ name: "something",
+ });
+
+ // Act
+ const act = () =>
+ caller.updateGroup({
+ id: createId(),
+ name: "something else",
+ });
+
+ // Assert
+ await expect(act()).rejects.toThrow("Group not found");
+ });
+});
+
+describe("savePermissions should save permissions for group", () => {
+ test("with existing group and permissions it should save permissions", async () => {
+ // Arrange
+ const db = createDb();
+ const caller = groupRouter.createCaller({ db, session: defaultSession });
+
+ const groupId = createId();
+ await db.insert(groups).values({
+ id: groupId,
+ name: "Group",
+ });
+ await db.insert(groupPermissions).values({
+ groupId,
+ permission: "admin",
+ });
+
+ // Act
+ await caller.savePermissions({
+ groupId,
+ permissions: ["integration-use-all", "board-full-access"],
+ });
+
+ // Assert
+ const permissions = await db.query.groupPermissions.findMany({
+ where: eq(groupPermissions.groupId, groupId),
+ });
+
+ expect(permissions.length).toBe(2);
+ expect(permissions.map(({ permission }) => permission)).toEqual(["integration-use-all", "board-full-access"]);
+ });
+
+ test("with non existing group it should throw not found error", async () => {
+ // Arrange
+ const db = createDb();
+ const caller = groupRouter.createCaller({ db, session: defaultSession });
+
+ await db.insert(groups).values({
+ id: createId(),
+ name: "Group",
+ });
+
+ // Act
+ const actAsync = async () =>
+ await caller.savePermissions({
+ groupId: createId(),
+ permissions: ["integration-create", "board-full-access"],
+ });
+
+ // Assert
+ await expect(actAsync()).rejects.toThrow("Group not found");
+ });
+});
+
+describe("transferOwnership should transfer ownership of group", () => {
+ test("with existing group and user it should transfer ownership", async () => {
+ // Arrange
+ const db = createDb();
+ const caller = groupRouter.createCaller({ db, session: defaultSession });
+
+ const groupId = createId();
+ const newUserId = createId();
+ await db.insert(users).values([
+ {
+ id: newUserId,
+ name: "New user",
+ },
+ {
+ id: defaultOwnerId,
+ name: "Old user",
+ },
+ ]);
+ await db.insert(groups).values({
+ id: groupId,
+ name: "Group",
+ ownerId: defaultOwnerId,
+ });
+
+ // Act
+ await caller.transferOwnership({
+ groupId,
+ userId: newUserId,
+ });
+
+ // Assert
+ const group = await db.query.groups.findFirst({
+ where: eq(groups.id, groupId),
+ });
+
+ expect(group?.ownerId).toBe(newUserId);
+ });
+
+ test("with non existing group it should throw not found error", async () => {
+ // Arrange
+ const db = createDb();
+ const caller = groupRouter.createCaller({ db, session: defaultSession });
+
+ await db.insert(groups).values({
+ id: createId(),
+ name: "Group",
+ });
+
+ // Act
+ const actAsync = async () =>
+ await caller.transferOwnership({
+ groupId: createId(),
+ userId: createId(),
+ });
+
+ // Assert
+ await expect(actAsync()).rejects.toThrow("Group not found");
+ });
+});
+
+describe("deleteGroup should delete group", () => {
+ test("with existing group it should delete group", async () => {
+ // Arrange
+ const db = createDb();
+ const caller = groupRouter.createCaller({ db, session: defaultSession });
+
+ const groupId = createId();
+ await db.insert(groups).values([
+ {
+ id: groupId,
+ name: "Group",
+ },
+ {
+ id: createId(),
+ name: "Another group",
+ },
+ ]);
+
+ // Act
+ await caller.deleteGroup({
+ id: groupId,
+ });
+
+ // Assert
+ const dbGroups = await db.query.groups.findMany();
+
+ expect(dbGroups.length).toBe(1);
+ expect(dbGroups[0]?.id).not.toBe(groupId);
+ });
+
+ test("with non existing group it should throw not found error", async () => {
+ // Arrange
+ const db = createDb();
+ const caller = groupRouter.createCaller({ db, session: defaultSession });
+
+ await db.insert(groups).values({
+ id: createId(),
+ name: "Group",
+ });
+
+ // Act
+ const actAsync = async () =>
+ await caller.deleteGroup({
+ id: createId(),
+ });
+
+ // Assert
+ await expect(actAsync()).rejects.toThrow("Group not found");
+ });
+});
+
+describe("addMember should add member to group", () => {
+ test("with existing group and user it should add member", async () => {
+ // Arrange
+ const db = createDb();
+ const caller = groupRouter.createCaller({ db, session: defaultSession });
+
+ const groupId = createId();
+ const userId = createId();
+ await db.insert(users).values([
+ {
+ id: userId,
+ name: "User",
+ },
+ {
+ id: defaultOwnerId,
+ name: "Creator",
+ },
+ ]);
+ await db.insert(groups).values({
+ id: groupId,
+ name: "Group",
+ ownerId: defaultOwnerId,
+ });
+
+ // Act
+ await caller.addMember({
+ groupId,
+ userId,
+ });
+
+ // Assert
+ const members = await db.query.groupMembers.findMany({
+ where: eq(groupMembers.groupId, groupId),
+ });
+
+ expect(members.length).toBe(1);
+ expect(members[0]?.userId).toBe(userId);
+ });
+
+ test("with non existing group it should throw not found error", async () => {
+ // Arrange
+ const db = createDb();
+ const caller = groupRouter.createCaller({ db, session: defaultSession });
+
+ await db.insert(users).values({
+ id: createId(),
+ name: "User",
+ });
+
+ // Act
+ const actAsync = async () =>
+ await caller.addMember({
+ groupId: createId(),
+ userId: createId(),
+ });
+
+ // Assert
+ await expect(actAsync()).rejects.toThrow("Group not found");
+ });
+});
+
+describe("removeMember should remove member from group", () => {
+ test("with existing group and user it should remove member", async () => {
+ // Arrange
+ const db = createDb();
+ const caller = groupRouter.createCaller({ db, session: defaultSession });
+
+ const groupId = createId();
+ const userId = createId();
+ await db.insert(users).values([
+ {
+ id: userId,
+ name: "User",
+ },
+ {
+ id: defaultOwnerId,
+ name: "Creator",
+ },
+ ]);
+ await db.insert(groups).values({
+ id: groupId,
+ name: "Group",
+ ownerId: defaultOwnerId,
+ });
+ await db.insert(groupMembers).values({
+ groupId,
+ userId,
+ });
+
+ // Act
+ await caller.removeMember({
+ groupId,
+ userId,
+ });
+
+ // Assert
+ const members = await db.query.groupMembers.findMany({
+ where: eq(groupMembers.groupId, groupId),
+ });
+
+ expect(members.length).toBe(0);
+ });
+
+ test("with non existing group it should throw not found error", async () => {
+ // Arrange
+ const db = createDb();
+ const caller = groupRouter.createCaller({ db, session: defaultSession });
+
+ await db.insert(users).values({
+ id: createId(),
+ name: "User",
+ });
+
+ // Act
+ const actAsync = async () =>
+ await caller.removeMember({
+ groupId: createId(),
+ userId: createId(),
+ });
+
+ // Assert
+ await expect(actAsync()).rejects.toThrow("Group not found");
+ });
+});
+
+const createDummyUser = () => ({
+ id: createId(),
+ name: "username",
+ email: "user@gmail.com",
+ image: "example",
+ password: "secret",
+ salt: "secret",
+});
diff --git a/packages/api/src/router/test/helper.ts b/packages/api/src/router/test/helper.ts
new file mode 100644
index 000000000..f979bac5e
--- /dev/null
+++ b/packages/api/src/router/test/helper.ts
@@ -0,0 +1,11 @@
+import { expect } from "vitest";
+
+export const expectToBeDefined = (value: T) => {
+ if (value === undefined) {
+ expect(value).toBeDefined();
+ }
+ if (value === null) {
+ expect(value).not.toBeNull();
+ }
+ return value as Exclude;
+};
diff --git a/packages/api/src/router/test/integration.spec.ts b/packages/api/src/router/test/integration.spec.ts
new file mode 100644
index 000000000..2a68a8c39
--- /dev/null
+++ b/packages/api/src/router/test/integration.spec.ts
@@ -0,0 +1,486 @@
+import { describe, expect, it, vi } from "vitest";
+
+import type { Session } from "@homarr/auth";
+import { createId } from "@homarr/db";
+import { integrations, integrationSecrets } from "@homarr/db/schema/sqlite";
+import { createDb } from "@homarr/db/test";
+
+import type { RouterInputs } from "../..";
+import { encryptSecret, integrationRouter } from "../integration";
+import { expectToBeDefined } from "./helper";
+
+// Mock the auth module to return an empty session
+vi.mock("@homarr/auth", () => ({ auth: () => ({}) as Session }));
+
+describe("all should return all integrations", () => {
+ it("should return all integrations", async () => {
+ const db = createDb();
+ const caller = integrationRouter.createCaller({
+ db,
+ session: null,
+ });
+
+ await db.insert(integrations).values([
+ {
+ id: "1",
+ name: "Home assistant",
+ kind: "homeAssistant",
+ url: "http://homeassist.local",
+ },
+ {
+ id: "2",
+ name: "Home plex server",
+ kind: "plex",
+ url: "http://plex.local",
+ },
+ ]);
+
+ const result = await caller.all();
+ expect(result.length).toBe(2);
+ expect(result[0]!.kind).toBe("plex");
+ expect(result[1]!.kind).toBe("homeAssistant");
+ });
+});
+
+describe("byId should return an integration by id", () => {
+ it("should return an integration by id", async () => {
+ const db = createDb();
+ const caller = integrationRouter.createCaller({
+ db,
+ session: null,
+ });
+
+ await db.insert(integrations).values([
+ {
+ id: "1",
+ name: "Home assistant",
+ kind: "homeAssistant",
+ url: "http://homeassist.local",
+ },
+ {
+ id: "2",
+ name: "Home plex server",
+ kind: "plex",
+ url: "http://plex.local",
+ },
+ ]);
+
+ const result = await caller.byId({ id: "2" });
+ expect(result.kind).toBe("plex");
+ });
+
+ it("should throw an error if the integration does not exist", async () => {
+ const db = createDb();
+ const caller = integrationRouter.createCaller({
+ db,
+ session: null,
+ });
+
+ const actAsync = async () => await caller.byId({ id: "2" });
+ await expect(actAsync()).rejects.toThrow("Integration not found");
+ });
+
+ it("should only return the public secret values", async () => {
+ const db = createDb();
+ const caller = integrationRouter.createCaller({
+ db,
+ session: null,
+ });
+
+ await db.insert(integrations).values([
+ {
+ id: "1",
+ name: "Home assistant",
+ kind: "homeAssistant",
+ url: "http://homeassist.local",
+ },
+ ]);
+ await db.insert(integrationSecrets).values([
+ {
+ kind: "username",
+ value: encryptSecret("musterUser"),
+ integrationId: "1",
+ updatedAt: new Date(),
+ },
+ {
+ kind: "password",
+ value: encryptSecret("Password123!"),
+ integrationId: "1",
+ updatedAt: new Date(),
+ },
+ {
+ kind: "apiKey",
+ value: encryptSecret("1234567890"),
+ integrationId: "1",
+ updatedAt: new Date(),
+ },
+ ]);
+
+ const result = await caller.byId({ id: "1" });
+ expect(result.secrets.length).toBe(3);
+ const username = expectToBeDefined(result.secrets.find((secret) => secret.kind === "username"));
+ expect(username.value).not.toBeNull();
+ const password = expectToBeDefined(result.secrets.find((secret) => secret.kind === "password"));
+ expect(password.value).toBeNull();
+ const apiKey = expectToBeDefined(result.secrets.find((secret) => secret.kind === "apiKey"));
+ expect(apiKey.value).toBeNull();
+ });
+});
+
+describe("create should create a new integration", () => {
+ it("should create a new integration", async () => {
+ const db = createDb();
+ const caller = integrationRouter.createCaller({
+ db,
+ session: null,
+ });
+ const input = {
+ name: "Jellyfin",
+ kind: "jellyfin" as const,
+ url: "http://jellyfin.local",
+ secrets: [{ kind: "apiKey" as const, value: "1234567890" }],
+ };
+
+ const fakeNow = new Date("2023-07-01T00:00:00Z");
+ vi.useFakeTimers();
+ vi.setSystemTime(fakeNow);
+ await caller.create(input);
+ vi.useRealTimers();
+
+ const dbIntegration = await db.query.integrations.findFirst();
+ const dbSecret = await db.query.integrationSecrets.findFirst();
+ expect(dbIntegration).toBeDefined();
+ expect(dbIntegration!.name).toBe(input.name);
+ expect(dbIntegration!.kind).toBe(input.kind);
+ expect(dbIntegration!.url).toBe(input.url);
+
+ expect(dbSecret!.integrationId).toBe(dbIntegration!.id);
+ expect(dbSecret).toBeDefined();
+ expect(dbSecret!.kind).toBe(input.secrets[0]!.kind);
+ expect(dbSecret!.value).toMatch(/^[a-f0-9]+.[a-f0-9]+$/);
+ expect(dbSecret!.updatedAt).toEqual(fakeNow);
+ });
+});
+
+describe("update should update an integration", () => {
+ it("should update an integration", async () => {
+ const db = createDb();
+ const caller = integrationRouter.createCaller({
+ db,
+ session: null,
+ });
+
+ const lastWeek = new Date("2023-06-24T00:00:00Z");
+ const integrationId = createId();
+ const toInsert = {
+ id: integrationId,
+ name: "Pi Hole",
+ kind: "piHole" as const,
+ url: "http://hole.local",
+ };
+
+ await db.insert(integrations).values(toInsert);
+
+ const usernameToInsert = {
+ kind: "username" as const,
+ value: encryptSecret("musterUser"),
+ integrationId,
+ updatedAt: lastWeek,
+ };
+
+ const passwordToInsert = {
+ kind: "password" as const,
+ value: encryptSecret("Password123!"),
+ integrationId,
+ updatedAt: lastWeek,
+ };
+ await db.insert(integrationSecrets).values([usernameToInsert, passwordToInsert]);
+
+ const input = {
+ id: integrationId,
+ name: "Milky Way Pi Hole",
+ kind: "piHole" as const,
+ url: "http://milkyway.local",
+ secrets: [
+ { kind: "username" as const, value: "newUser" },
+ { kind: "password" as const, value: null },
+ { kind: "apiKey" as const, value: "1234567890" },
+ ],
+ };
+
+ const fakeNow = new Date("2023-07-01T00:00:00Z");
+ vi.useFakeTimers();
+ vi.setSystemTime(fakeNow);
+ await caller.update(input);
+ vi.useRealTimers();
+
+ const dbIntegration = await db.query.integrations.findFirst();
+ const dbSecrets = await db.query.integrationSecrets.findMany();
+
+ expect(dbIntegration).toBeDefined();
+ expect(dbIntegration!.name).toBe(input.name);
+ expect(dbIntegration!.kind).toBe(input.kind);
+ expect(dbIntegration!.url).toBe(input.url);
+
+ expect(dbSecrets.length).toBe(3);
+ const username = expectToBeDefined(dbSecrets.find((secret) => secret.kind === "username"));
+ const password = expectToBeDefined(dbSecrets.find((secret) => secret.kind === "password"));
+ const apiKey = expectToBeDefined(dbSecrets.find((secret) => secret.kind === "apiKey"));
+ expect(username.value).toMatch(/^[a-f0-9]+.[a-f0-9]+$/);
+ expect(password.value).toMatch(/^[a-f0-9]+.[a-f0-9]+$/);
+ expect(apiKey.value).toMatch(/^[a-f0-9]+.[a-f0-9]+$/);
+ expect(username.updatedAt).toEqual(fakeNow);
+ expect(password.updatedAt).toEqual(lastWeek);
+ expect(apiKey.updatedAt).toEqual(fakeNow);
+ expect(username.value).not.toEqual(usernameToInsert.value);
+ expect(password.value).toEqual(passwordToInsert.value);
+ expect(apiKey.value).not.toEqual(input.secrets[2]!.value);
+ });
+
+ it("should throw an error if the integration does not exist", async () => {
+ const db = createDb();
+ const caller = integrationRouter.createCaller({
+ db,
+ session: null,
+ });
+
+ const actAsync = async () =>
+ await caller.update({
+ id: createId(),
+ name: "Pi Hole",
+ url: "http://hole.local",
+ secrets: [],
+ });
+ await expect(actAsync()).rejects.toThrow("Integration not found");
+ });
+});
+
+describe("delete should delete an integration", () => {
+ it("should delete an integration", async () => {
+ const db = createDb();
+ const caller = integrationRouter.createCaller({
+ db,
+ session: null,
+ });
+
+ const integrationId = createId();
+ await db.insert(integrations).values({
+ id: integrationId,
+ name: "Home assistant",
+ kind: "homeAssistant",
+ url: "http://homeassist.local",
+ });
+
+ await db.insert(integrationSecrets).values([
+ {
+ kind: "username",
+ value: encryptSecret("example"),
+ integrationId,
+ updatedAt: new Date(),
+ },
+ ]);
+
+ await caller.delete({ id: integrationId });
+
+ const dbIntegration = await db.query.integrations.findFirst();
+ expect(dbIntegration).toBeUndefined();
+ const dbSecrets = await db.query.integrationSecrets.findMany();
+ expect(dbSecrets.length).toBe(0);
+ });
+});
+
+describe("testConnection should test the connection to an integration", () => {
+ it.each([
+ [
+ "nzbGet" as const,
+ [
+ { kind: "username" as const, value: null },
+ { kind: "password" as const, value: "Password123!" },
+ ],
+ ],
+ [
+ "nzbGet" as const,
+ [
+ { kind: "username" as const, value: "exampleUser" },
+ { kind: "password" as const, value: null },
+ ],
+ ],
+ ["sabNzbd" as const, [{ kind: "apiKey" as const, value: null }]],
+ [
+ "sabNzbd" as const,
+ [
+ { kind: "username" as const, value: "exampleUser" },
+ { kind: "password" as const, value: "Password123!" },
+ ],
+ ],
+ ])("should fail when a required secret is missing when creating %s integration", async (kind, secrets) => {
+ const db = createDb();
+ const caller = integrationRouter.createCaller({
+ db,
+ session: null,
+ });
+
+ const input: RouterInputs["integration"]["testConnection"] = {
+ id: null,
+ kind,
+ url: `http://${kind}.local`,
+ secrets,
+ };
+
+ const actAsync = async () => await caller.testConnection(input);
+ await expect(actAsync()).rejects.toThrow("SECRETS_NOT_DEFINED");
+ });
+
+ it.each([
+ [
+ "nzbGet" as const,
+ [
+ { kind: "username" as const, value: "exampleUser" },
+ { kind: "password" as const, value: "Password123!" },
+ ],
+ ],
+ ["sabNzbd" as const, [{ kind: "apiKey" as const, value: "1234567890" }]],
+ ])(
+ "should be successful when all required secrets are defined for creation of %s integration",
+ async (kind, secrets) => {
+ const db = createDb();
+ const caller = integrationRouter.createCaller({
+ db,
+ session: null,
+ });
+
+ const input: RouterInputs["integration"]["testConnection"] = {
+ id: null,
+ kind,
+ url: `http://${kind}.local`,
+ secrets,
+ };
+
+ const actAsync = async () => await caller.testConnection(input);
+ await expect(actAsync()).resolves.toBeUndefined();
+ },
+ );
+
+ it("should be successful when all required secrets are defined for updating an nzbGet integration", async () => {
+ const db = createDb();
+ const caller = integrationRouter.createCaller({
+ db,
+ session: null,
+ });
+
+ const input: RouterInputs["integration"]["testConnection"] = {
+ id: createId(),
+ kind: "nzbGet",
+ url: "http://nzbGet.local",
+ secrets: [
+ { kind: "username", value: "exampleUser" },
+ { kind: "password", value: "Password123!" },
+ ],
+ };
+
+ const actAsync = async () => await caller.testConnection(input);
+ await expect(actAsync()).resolves.toBeUndefined();
+ });
+
+ it("should be successful when overriding one of the secrets for an existing nzbGet integration", async () => {
+ const db = createDb();
+ const caller = integrationRouter.createCaller({
+ db,
+ session: null,
+ });
+
+ const integrationId = createId();
+ await db.insert(integrations).values({
+ id: integrationId,
+ name: "NZBGet",
+ kind: "nzbGet",
+ url: "http://nzbGet.local",
+ });
+
+ await db.insert(integrationSecrets).values([
+ {
+ kind: "username",
+ value: encryptSecret("exampleUser"),
+ integrationId,
+ updatedAt: new Date(),
+ },
+ {
+ kind: "password",
+ value: encryptSecret("Password123!"),
+ integrationId,
+ updatedAt: new Date(),
+ },
+ ]);
+
+ const input: RouterInputs["integration"]["testConnection"] = {
+ id: integrationId,
+ kind: "nzbGet",
+ url: "http://nzbGet.local",
+ secrets: [
+ { kind: "username", value: "newUser" },
+ { kind: "password", value: null },
+ ],
+ };
+
+ const actAsync = async () => await caller.testConnection(input);
+ await expect(actAsync()).resolves.toBeUndefined();
+ });
+
+ it("should fail when a required secret is missing for an existing nzbGet integration", async () => {
+ const db = createDb();
+ const caller = integrationRouter.createCaller({
+ db,
+ session: null,
+ });
+
+ const integrationId = createId();
+ await db.insert(integrations).values({
+ id: integrationId,
+ name: "NZBGet",
+ kind: "nzbGet",
+ url: "http://nzbGet.local",
+ });
+
+ await db.insert(integrationSecrets).values([
+ {
+ kind: "username",
+ value: encryptSecret("exampleUser"),
+ integrationId,
+ updatedAt: new Date(),
+ },
+ ]);
+
+ const input: RouterInputs["integration"]["testConnection"] = {
+ id: integrationId,
+ kind: "nzbGet",
+ url: "http://nzbGet.local",
+ secrets: [
+ { kind: "username", value: "newUser" },
+ { kind: "apiKey", value: "1234567890" },
+ ],
+ };
+
+ const actAsync = async () => await caller.testConnection(input);
+ await expect(actAsync()).rejects.toThrow("SECRETS_NOT_DEFINED");
+ });
+
+ it("should fail when the updating integration does not exist", async () => {
+ const db = createDb();
+ const caller = integrationRouter.createCaller({
+ db,
+ session: null,
+ });
+
+ const actAsync = async () =>
+ await caller.testConnection({
+ id: createId(),
+ kind: "nzbGet",
+ url: "http://nzbGet.local",
+ secrets: [
+ { kind: "username", value: null },
+ { kind: "password", value: "Password123!" },
+ ],
+ });
+ await expect(actAsync()).rejects.toThrow("SECRETS_NOT_DEFINED");
+ });
+});
diff --git a/packages/api/src/router/test/invite.spec.ts b/packages/api/src/router/test/invite.spec.ts
new file mode 100644
index 000000000..59f2fad68
--- /dev/null
+++ b/packages/api/src/router/test/invite.spec.ts
@@ -0,0 +1,191 @@
+import { describe, expect, test, vi } from "vitest";
+
+import type { Session } from "@homarr/auth";
+import { createId } from "@homarr/db";
+import { invites, users } from "@homarr/db/schema/sqlite";
+import { createDb } from "@homarr/db/test";
+
+import { inviteRouter } from "../invite";
+
+const defaultSession = {
+ user: {
+ id: createId(),
+ permissions: [],
+ },
+ expires: new Date().toISOString(),
+} satisfies Session;
+
+// Mock the auth module to return an empty session
+vi.mock("@homarr/auth", async () => {
+ const mod = await import("@homarr/auth/security");
+ return { ...mod, auth: () => ({}) as Session };
+});
+
+describe("all should return all existing invites without sensitive informations", () => {
+ test("invites should not contain sensitive informations", async () => {
+ // Arrange
+ const db = createDb();
+ const caller = inviteRouter.createCaller({
+ db,
+ session: defaultSession,
+ });
+
+ const userId = createId();
+ await db.insert(users).values({
+ id: userId,
+ name: "someone",
+ });
+
+ const inviteId = createId();
+ await db.insert(invites).values({
+ id: inviteId,
+ creatorId: userId,
+ expirationDate: new Date(2022, 5, 1),
+ token: "token",
+ });
+
+ // Act
+ const result = await caller.getAll();
+
+ // Assert
+ expect(result.length).toBe(1);
+ expect(result[0]?.id).toBe(inviteId);
+ expect(result[0]?.expirationDate).toEqual(new Date(2022, 5, 1));
+ expect(result[0]?.creator.id).toBe(userId);
+ expect(result[0]?.creator.name).toBe("someone");
+ expect("token" in result[0]!).toBe(false);
+ });
+
+ test("invites should be sorted ascending by expiration date", async () => {
+ // Arrange
+ const db = createDb();
+ const caller = inviteRouter.createCaller({
+ db,
+ session: defaultSession,
+ });
+
+ const userId = createId();
+ await db.insert(users).values({
+ id: userId,
+ name: "someone",
+ });
+
+ const inviteId = createId();
+ await db.insert(invites).values({
+ id: inviteId,
+ creatorId: userId,
+ expirationDate: new Date(2022, 5, 1),
+ token: "token",
+ });
+ await db.insert(invites).values({
+ id: createId(),
+ creatorId: userId,
+ expirationDate: new Date(2022, 5, 2),
+ token: "token2",
+ });
+
+ // Act
+ const result = await caller.getAll();
+
+ // Assert
+ expect(result.length).toBe(2);
+ expect(result[0]?.expirationDate.getDate()).toBe(1);
+ expect(result[1]?.expirationDate.getDate()).toBe(2);
+ });
+});
+
+describe("create should create a new invite expiring on the specified date with a token and id returned to generate url", () => {
+ test("creation should work with a date in the future, but less than 6 months.", async () => {
+ // Arrange
+ const db = createDb();
+ const caller = inviteRouter.createCaller({
+ db,
+ session: defaultSession,
+ });
+ await db.insert(users).values({
+ id: defaultSession.user.id,
+ });
+ const expirationDate = new Date(2024, 5, 1); // TODO: add mock date
+
+ // Act
+ const result = await caller.createInvite({
+ expirationDate,
+ });
+
+ // Assert
+ expect(result.id.length).toBeGreaterThan(10);
+ expect(result.token.length).toBeGreaterThan(20);
+
+ const createdInvite = await db.query.invites.findFirst();
+ expect(createdInvite).toBeDefined();
+ expect(createdInvite?.id).toBe(result.id);
+ expect(createdInvite?.token).toBe(result.token);
+ expect(createdInvite?.expirationDate).toEqual(expirationDate);
+ expect(createdInvite?.creatorId).toBe(defaultSession.user.id);
+ });
+});
+
+describe("delete should remove invite by id", () => {
+ test("deletion should remove present invite", async () => {
+ // Arrange
+ const db = createDb();
+ const caller = inviteRouter.createCaller({
+ db,
+ session: defaultSession,
+ });
+
+ const userId = createId();
+ await db.insert(users).values({
+ id: userId,
+ });
+ const inviteId = createId();
+ await db.insert(invites).values([
+ {
+ id: createId(),
+ creatorId: userId,
+ expirationDate: new Date(2023, 1, 1),
+ token: "first-token",
+ },
+ {
+ id: inviteId,
+ creatorId: userId,
+ expirationDate: new Date(2023, 1, 1),
+ token: "second-token",
+ },
+ ]);
+
+ // Act
+ await caller.deleteInvite({ id: inviteId });
+
+ // Assert
+ const dbInvites = await db.query.invites.findMany();
+ expect(dbInvites.length).toBe(1);
+ expect(dbInvites[0]?.id).not.toBe(inviteId);
+ });
+
+ test("deletion should throw with NOT_FOUND code when specified invite not present", async () => {
+ // Arrange
+ const db = createDb();
+ const caller = inviteRouter.createCaller({
+ db,
+ session: defaultSession,
+ });
+
+ const userId = createId();
+ await db.insert(users).values({
+ id: userId,
+ });
+ await db.insert(invites).values({
+ id: createId(),
+ creatorId: userId,
+ expirationDate: new Date(2023, 1, 1),
+ token: "first-token",
+ });
+
+ // Act
+ const actAsync = async () => await caller.deleteInvite({ id: createId() });
+
+ // Assert
+ await expect(actAsync()).rejects.toThrow("not found");
+ });
+});
diff --git a/packages/api/src/router/test/serverSettings.spec.ts b/packages/api/src/router/test/serverSettings.spec.ts
new file mode 100644
index 000000000..331631229
--- /dev/null
+++ b/packages/api/src/router/test/serverSettings.spec.ts
@@ -0,0 +1,131 @@
+import SuperJSON from "superjson";
+import { describe, expect, test, vi } from "vitest";
+
+import type { Session } from "@homarr/auth";
+import { createId } from "@homarr/db";
+import { serverSettings } from "@homarr/db/schema/sqlite";
+import { createDb } from "@homarr/db/test";
+import { defaultServerSettings, defaultServerSettingsKeys } from "@homarr/server-settings";
+
+import { serverSettingsRouter } from "../serverSettings";
+
+// Mock the auth module to return an empty session
+vi.mock("@homarr/auth", () => ({ auth: () => ({}) as Session }));
+
+const defaultSession = {
+ user: {
+ id: createId(),
+ permissions: [],
+ },
+ expires: new Date().toISOString(),
+} satisfies Session;
+
+describe("getAll server settings", () => {
+ test("getAll should throw error when unauthorized", async () => {
+ const db = createDb();
+ const caller = serverSettingsRouter.createCaller({
+ db,
+ session: null,
+ });
+
+ await db.insert(serverSettings).values([
+ {
+ settingKey: defaultServerSettingsKeys[0],
+ value: SuperJSON.stringify(defaultServerSettings.analytics),
+ },
+ ]);
+
+ const actAsync = async () => await caller.getAll();
+
+ await expect(actAsync()).rejects.toThrow();
+ });
+ test("getAll should return server", async () => {
+ const db = createDb();
+ const caller = serverSettingsRouter.createCaller({
+ db,
+ session: defaultSession,
+ });
+
+ await db.insert(serverSettings).values([
+ {
+ settingKey: defaultServerSettingsKeys[0],
+ value: SuperJSON.stringify(defaultServerSettings.analytics),
+ },
+ ]);
+
+ const result = await caller.getAll();
+
+ expect(result).toStrictEqual({
+ analytics: {
+ enableGeneral: true,
+ enableWidgetData: false,
+ enableIntegrationData: false,
+ enableUserData: false,
+ },
+ });
+ });
+});
+
+describe("saveSettings", () => {
+ test("saveSettings should return false when it did not update one", async () => {
+ const db = createDb();
+ const caller = serverSettingsRouter.createCaller({
+ db,
+ session: defaultSession,
+ });
+
+ const result = await caller.saveSettings({
+ settingsKey: "analytics",
+ value: {
+ enableGeneral: true,
+ enableWidgetData: true,
+ enableIntegrationData: true,
+ enableUserData: true,
+ },
+ });
+
+ expect(result).toBe(false);
+
+ const dbSettings = await db.select().from(serverSettings);
+ expect(dbSettings.length).toBe(0);
+ });
+ test("saveSettings should update settings and return true when it updated only one", async () => {
+ const db = createDb();
+ const caller = serverSettingsRouter.createCaller({
+ db,
+ session: defaultSession,
+ });
+
+ await db.insert(serverSettings).values([
+ {
+ settingKey: defaultServerSettingsKeys[0],
+ value: SuperJSON.stringify(defaultServerSettings.analytics),
+ },
+ ]);
+
+ const result = await caller.saveSettings({
+ settingsKey: "analytics",
+ value: {
+ enableGeneral: true,
+ enableWidgetData: true,
+ enableIntegrationData: true,
+ enableUserData: true,
+ },
+ });
+
+ expect(result).toBe(true);
+
+ const dbSettings = await db.select().from(serverSettings);
+ expect(dbSettings).toStrictEqual([
+ {
+ settingKey: "analytics",
+ value: SuperJSON.stringify({
+ enableGeneral: true,
+ enableWidgetData: true,
+ enableIntegrationData: true,
+ enableUserData: true,
+ }),
+ },
+ ]);
+ });
+});
diff --git a/packages/api/src/router/test/user.spec.ts b/packages/api/src/router/test/user.spec.ts
new file mode 100644
index 000000000..59c58436f
--- /dev/null
+++ b/packages/api/src/router/test/user.spec.ts
@@ -0,0 +1,327 @@
+import { describe, expect, it, test, vi } from "vitest";
+
+import type { Session } from "@homarr/auth";
+import { createId, eq, schema } from "@homarr/db";
+import { users } from "@homarr/db/schema/sqlite";
+import { createDb } from "@homarr/db/test";
+
+import { userRouter } from "../user";
+
+// Mock the auth module to return an empty session
+vi.mock("@homarr/auth", async () => {
+ const mod = await import("@homarr/auth/security");
+ return { ...mod, auth: () => ({}) as Session };
+});
+
+describe("initUser should initialize the first user", () => {
+ it("should throw an error if a user already exists", async () => {
+ const db = createDb();
+ const caller = userRouter.createCaller({
+ db,
+ session: null,
+ });
+
+ await db.insert(schema.users).values({
+ id: "test",
+ name: "test",
+ password: "test",
+ });
+
+ const actAsync = async () =>
+ await caller.initUser({
+ username: "test",
+ password: "12345678",
+ confirmPassword: "12345678",
+ });
+
+ await expect(actAsync()).rejects.toThrow("User already exists");
+ });
+
+ it("should create a user if none exists", async () => {
+ const db = createDb();
+ const caller = userRouter.createCaller({
+ db,
+ session: null,
+ });
+
+ await caller.initUser({
+ username: "test",
+ password: "12345678",
+ confirmPassword: "12345678",
+ });
+
+ const user = await db.query.users.findFirst({
+ columns: {
+ id: true,
+ },
+ });
+
+ expect(user).toBeDefined();
+ });
+
+ it("should not create a user if the password and confirmPassword do not match", async () => {
+ const db = createDb();
+ const caller = userRouter.createCaller({
+ db,
+ session: null,
+ });
+
+ const actAsync = async () =>
+ await caller.initUser({
+ username: "test",
+ password: "12345678",
+ confirmPassword: "12345679",
+ });
+
+ await expect(actAsync()).rejects.toThrow("passwordsDoNotMatch");
+ });
+
+ it("should not create a user if the password is too short", async () => {
+ const db = createDb();
+ const caller = userRouter.createCaller({
+ db,
+ session: null,
+ });
+
+ const actAsync = async () =>
+ await caller.initUser({
+ username: "test",
+ password: "1234567",
+ confirmPassword: "1234567",
+ });
+
+ await expect(actAsync()).rejects.toThrow("too_small");
+ });
+});
+
+describe("register should create a user with valid invitation", () => {
+ test("register should create a user with valid invitation", async () => {
+ // Arrange
+ const db = createDb();
+ const caller = userRouter.createCaller({
+ db,
+ session: null,
+ });
+
+ const userId = createId();
+ const inviteId = createId();
+ const inviteToken = "123";
+ vi.useFakeTimers();
+ vi.setSystemTime(new Date(2024, 0, 3));
+
+ await db.insert(users).values({
+ id: userId,
+ });
+ await db.insert(schema.invites).values({
+ id: inviteId,
+ token: inviteToken,
+ creatorId: userId,
+ expirationDate: new Date(2024, 0, 5),
+ });
+
+ // Act
+ await caller.register({
+ inviteId,
+ token: inviteToken,
+ username: "test",
+ password: "12345678",
+ confirmPassword: "12345678",
+ });
+
+ // Assert
+ const user = await db.query.users.findMany({
+ columns: {
+ name: true,
+ },
+ });
+ const invite = await db.query.invites.findMany({
+ columns: {
+ id: true,
+ },
+ });
+
+ expect(user).toHaveLength(2);
+ expect(invite).toHaveLength(0);
+ });
+
+ test.each([
+ [{ token: "fakeToken" }, new Date(2024, 0, 3)],
+ [{ inviteId: "fakeInviteId" }, new Date(2024, 0, 3)],
+ [{}, new Date(2024, 0, 5, 0, 0, 1)],
+ ])(
+ "register should throw an error with input %s and date %s if the invitation is invalid",
+ async (partialInput, systemTime) => {
+ // Arrange
+ const db = createDb();
+ const caller = userRouter.createCaller({
+ db,
+ session: null,
+ });
+
+ const userId = createId();
+ const inviteId = createId();
+ const inviteToken = "123";
+ vi.useFakeTimers();
+ vi.setSystemTime(systemTime);
+
+ await db.insert(users).values({
+ id: userId,
+ });
+ await db.insert(schema.invites).values({
+ id: inviteId,
+ token: inviteToken,
+ creatorId: userId,
+ expirationDate: new Date(2024, 0, 5),
+ });
+
+ // Act
+ const actAsync = async () =>
+ await caller.register({
+ inviteId,
+ token: inviteToken,
+ username: "test",
+ password: "12345678",
+ confirmPassword: "12345678",
+ ...partialInput,
+ });
+
+ // Assert
+ await expect(actAsync()).rejects.toThrow("Invalid invite");
+ },
+ );
+});
+
+describe("editProfile shoud update user", () => {
+ test("editProfile should update users and not update emailVerified when email not dirty", async () => {
+ // arrange
+ const db = createDb();
+ const caller = userRouter.createCaller({
+ db,
+ session: null,
+ });
+
+ const id = createId();
+ const emailVerified = new Date(2024, 0, 5);
+
+ await db.insert(schema.users).values({
+ id,
+ name: "TEST 1",
+ email: "abc@gmail.com",
+ emailVerified,
+ });
+
+ // act
+ await caller.editProfile({
+ id: id,
+ name: "ABC",
+ email: "",
+ });
+
+ // assert
+ const user = await db.select().from(schema.users).where(eq(schema.users.id, id));
+
+ expect(user).toHaveLength(1);
+ expect(user[0]).toStrictEqual({
+ id,
+ name: "ABC",
+ email: "abc@gmail.com",
+ emailVerified,
+ salt: null,
+ password: null,
+ image: null,
+ homeBoardId: null,
+ });
+ });
+
+ test("editProfile should update users and update emailVerified when email dirty", async () => {
+ // arrange
+ const db = createDb();
+ const caller = userRouter.createCaller({
+ db,
+ session: null,
+ });
+
+ const id = createId();
+
+ await db.insert(schema.users).values({
+ id,
+ name: "TEST 1",
+ email: "abc@gmail.com",
+ emailVerified: new Date(2024, 0, 5),
+ });
+
+ // act
+ await caller.editProfile({
+ id,
+ name: "ABC",
+ email: "myNewEmail@gmail.com",
+ });
+
+ // assert
+ const user = await db.select().from(schema.users).where(eq(schema.users.id, id));
+
+ expect(user).toHaveLength(1);
+ expect(user[0]).toStrictEqual({
+ id,
+ name: "ABC",
+ email: "myNewEmail@gmail.com",
+ emailVerified: null,
+ salt: null,
+ password: null,
+ image: null,
+ homeBoardId: null,
+ });
+ });
+});
+
+describe("delete should delete user", () => {
+ test("delete should delete user", async () => {
+ const db = createDb();
+ const caller = userRouter.createCaller({
+ db,
+ session: null,
+ });
+
+ const userToDelete = createId();
+
+ const initialUsers = [
+ {
+ id: createId(),
+ name: "User 1",
+ email: null,
+ emailVerified: null,
+ image: null,
+ password: null,
+ salt: null,
+ homeBoardId: null,
+ },
+ {
+ id: userToDelete,
+ name: "User 2",
+ email: null,
+ emailVerified: null,
+ image: null,
+ password: null,
+ salt: null,
+ homeBoardId: null,
+ },
+ {
+ id: createId(),
+ name: "User 3",
+ email: null,
+ emailVerified: null,
+ image: null,
+ password: null,
+ salt: null,
+ homeBoardId: null,
+ },
+ ];
+
+ await db.insert(schema.users).values(initialUsers);
+
+ await caller.delete(userToDelete);
+
+ const usersInDb = await db.select().from(schema.users);
+ expect(usersInDb).toStrictEqual([initialUsers[0], initialUsers[2]]);
+ });
+});
diff --git a/packages/api/src/router/user.ts b/packages/api/src/router/user.ts
index 2c9ed3b3c..7d3fbd100 100644
--- a/packages/api/src/router/user.ts
+++ b/packages/api/src/router/user.ts
@@ -1,39 +1,268 @@
-import "server-only";
-
import { TRPCError } from "@trpc/server";
+import { observable } from "@trpc/server/observable";
-import { createSalt, hashPassword } from "@homarr/auth";
-import { createId, schema } from "@homarr/db";
-import { validation } from "@homarr/validation";
+import { createSaltAsync, hashPasswordAsync } from "@homarr/auth";
+import type { Database } from "@homarr/db";
+import { and, createId, eq, schema } from "@homarr/db";
+import { invites, users } from "@homarr/db/schema/sqlite";
+import { exampleChannel } from "@homarr/redis";
+import { validation, z } from "@homarr/validation";
-import { createTRPCRouter, publicProcedure } from "../trpc";
+import { createTRPCRouter, protectedProcedure, publicProcedure } from "../trpc";
export const userRouter = createTRPCRouter({
- initUser: publicProcedure
- .input(validation.user.init)
- .mutation(async ({ ctx, input }) => {
- const firstUser = await ctx.db.query.users.findFirst({
+ initUser: publicProcedure.input(validation.user.init).mutation(async ({ ctx, input }) => {
+ const firstUser = await ctx.db.query.users.findFirst({
+ columns: {
+ id: true,
+ },
+ });
+
+ if (firstUser) {
+ throw new TRPCError({
+ code: "FORBIDDEN",
+ message: "User already exists",
+ });
+ }
+
+ await createUserAsync(ctx.db, input);
+ }),
+ register: publicProcedure.input(validation.user.registrationApi).mutation(async ({ ctx, input }) => {
+ const inviteWhere = and(eq(invites.id, input.inviteId), eq(invites.token, input.token));
+ const dbInvite = await ctx.db.query.invites.findFirst({
+ columns: {
+ id: true,
+ expirationDate: true,
+ },
+ where: inviteWhere,
+ });
+
+ if (!dbInvite || dbInvite.expirationDate < new Date()) {
+ throw new TRPCError({
+ code: "FORBIDDEN",
+ message: "Invalid invite",
+ });
+ }
+
+ if (!dbInvite || dbInvite.expirationDate < new Date()) {
+ throw new TRPCError({
+ code: "FORBIDDEN",
+ message: "Invalid invite",
+ });
+ }
+
+ await checkUsernameAlreadyTakenAndThrowAsync(ctx.db, input.username);
+
+ await createUserAsync(ctx.db, input);
+
+ // Delete invite as it's used
+ await ctx.db.delete(invites).where(inviteWhere);
+ }),
+ create: publicProcedure.input(validation.user.create).mutation(async ({ ctx, input }) => {
+ await checkUsernameAlreadyTakenAndThrowAsync(ctx.db, input.username);
+
+ await createUserAsync(ctx.db, input);
+ }),
+ setProfileImage: protectedProcedure
+ .input(
+ z.object({
+ userId: z.string(),
+ // Max image size of 256KB, only png and jpeg are allowed
+ image: z
+ .string()
+ .regex(/^data:image\/(png|jpeg|gif|webp);base64,[A-Za-z0-9/+]+=*$/g)
+ .max(262144)
+ .nullable(),
+ }),
+ )
+ .mutation(async ({ input, ctx }) => {
+ // Only admins can change other users profile images
+ if (ctx.session.user.id !== input.userId && !ctx.session.user.permissions.includes("admin")) {
+ throw new TRPCError({
+ code: "FORBIDDEN",
+ message: "You are not allowed to change other users profile images",
+ });
+ }
+
+ const user = await ctx.db.query.users.findFirst({
columns: {
id: true,
+ image: true,
},
+ where: eq(users.id, input.userId),
});
- if (firstUser) {
+ if (!user) {
throw new TRPCError({
- code: "FORBIDDEN",
- message: "User already exists",
+ code: "NOT_FOUND",
+ message: "User not found",
+ });
+ }
+
+ await ctx.db
+ .update(users)
+ .set({
+ image: input.image,
+ })
+ .where(eq(users.id, input.userId));
+ }),
+ getAll: publicProcedure.query(async ({ ctx }) => {
+ return ctx.db.query.users.findMany({
+ columns: {
+ id: true,
+ name: true,
+ email: true,
+ emailVerified: true,
+ image: true,
+ },
+ });
+ }),
+ selectable: publicProcedure.query(async ({ ctx }) => {
+ return await ctx.db.query.users.findMany({
+ columns: {
+ id: true,
+ name: true,
+ image: true,
+ },
+ });
+ }),
+ getById: publicProcedure.input(z.object({ userId: z.string() })).query(async ({ input, ctx }) => {
+ const user = await ctx.db.query.users.findFirst({
+ columns: {
+ id: true,
+ name: true,
+ email: true,
+ emailVerified: true,
+ image: true,
+ },
+ where: eq(users.id, input.userId),
+ });
+
+ if (!user) {
+ throw new TRPCError({
+ code: "NOT_FOUND",
+ message: "User not found",
+ });
+ }
+
+ return user;
+ }),
+ editProfile: publicProcedure.input(validation.user.editProfile).mutation(async ({ input, ctx }) => {
+ const user = await ctx.db.query.users.findFirst({
+ columns: { email: true },
+ where: eq(users.id, input.id),
+ });
+
+ if (!user) {
+ throw new TRPCError({
+ code: "NOT_FOUND",
+ message: "User not found",
+ });
+ }
+
+ await checkUsernameAlreadyTakenAndThrowAsync(ctx.db, input.name, input.id);
+
+ const emailDirty = input.email && user.email !== input.email;
+ await ctx.db
+ .update(users)
+ .set({
+ name: input.name,
+ email: emailDirty === true ? input.email : undefined,
+ emailVerified: emailDirty === true ? null : undefined,
+ })
+ .where(eq(users.id, input.id));
+ }),
+ delete: publicProcedure.input(z.string()).mutation(async ({ input, ctx }) => {
+ await ctx.db.delete(users).where(eq(users.id, input));
+ }),
+ changePassword: protectedProcedure.input(validation.user.changePasswordApi).mutation(async ({ ctx, input }) => {
+ const user = ctx.session.user;
+ // Only admins can change other users' passwords
+ if (!user.permissions.includes("admin") && user.id !== input.userId) {
+ throw new TRPCError({
+ code: "NOT_FOUND",
+ message: "User not found",
+ });
+ }
+
+ // Admins can change the password of other users without providing the previous password
+ const isPreviousPasswordRequired = ctx.session.user.id === input.userId;
+
+ if (isPreviousPasswordRequired) {
+ const dbUser = await ctx.db.query.users.findFirst({
+ columns: {
+ id: true,
+ password: true,
+ salt: true,
+ },
+ where: eq(users.id, input.userId),
+ });
+
+ if (!dbUser) {
+ throw new TRPCError({
+ code: "NOT_FOUND",
+ message: "User not found",
});
}
- const salt = await createSalt();
- const hashedPassword = await hashPassword(input.password, salt);
+ const previousPasswordHash = await hashPasswordAsync(input.previousPassword, dbUser.salt ?? "");
+ const isValid = previousPasswordHash === dbUser.password;
- const userId = createId();
- await ctx.db.insert(schema.users).values({
- id: userId,
- name: input.username,
+ if (!isValid) {
+ throw new TRPCError({
+ code: "FORBIDDEN",
+ message: "Invalid password",
+ });
+ }
+ }
+
+ const salt = await createSaltAsync();
+ const hashedPassword = await hashPasswordAsync(input.password, salt);
+ await ctx.db
+ .update(users)
+ .set({
password: hashedPassword,
- salt,
+ })
+ .where(eq(users.id, input.userId));
+ }),
+ setMessage: publicProcedure.input(z.string()).mutation(async ({ input }) => {
+ await exampleChannel.publishAsync({ message: input });
+ }),
+ test: publicProcedure.subscription(() => {
+ return observable<{ message: string }>((emit) => {
+ exampleChannel.subscribe((message) => {
+ emit.next(message);
});
- }),
+ });
+ }),
});
+
+const createUserAsync = async (db: Database, input: z.infer) => {
+ const salt = await createSaltAsync();
+ const hashedPassword = await hashPasswordAsync(input.password, salt);
+
+ const username = input.username.toLowerCase();
+
+ const userId = createId();
+ await db.insert(schema.users).values({
+ id: userId,
+ name: username,
+ email: input.email,
+ password: hashedPassword,
+ salt,
+ });
+};
+
+const checkUsernameAlreadyTakenAndThrowAsync = async (db: Database, username: string, ignoreId?: string) => {
+ const user = await db.query.users.findFirst({
+ where: eq(users.name, username.toLowerCase()),
+ });
+
+ if (!user) return;
+ if (ignoreId && user.id === ignoreId) return;
+
+ throw new TRPCError({
+ code: "CONFLICT",
+ message: "Username already taken",
+ });
+};
diff --git a/packages/api/src/router/widgets/index.ts b/packages/api/src/router/widgets/index.ts
new file mode 100644
index 000000000..ecd39a0a8
--- /dev/null
+++ b/packages/api/src/router/widgets/index.ts
@@ -0,0 +1,8 @@
+import { createTRPCRouter } from "../../trpc";
+import { notebookRouter } from "./notebook";
+import { weatherRouter } from "./weather";
+
+export const widgetRouter = createTRPCRouter({
+ notebook: notebookRouter,
+ weather: weatherRouter,
+});
diff --git a/packages/api/src/router/widgets/notebook.ts b/packages/api/src/router/widgets/notebook.ts
new file mode 100644
index 000000000..8fd369630
--- /dev/null
+++ b/packages/api/src/router/widgets/notebook.ts
@@ -0,0 +1,45 @@
+import { TRPCError } from "@trpc/server";
+import SuperJSON from "superjson";
+
+import { eq } from "@homarr/db";
+import { items } from "@homarr/db/schema/sqlite";
+import { z } from "@homarr/validation";
+
+import { createTRPCRouter, publicProcedure } from "../../trpc";
+
+export const notebookRouter = createTRPCRouter({
+ updateContent: publicProcedure
+ .input(
+ z.object({
+ itemId: z.string(),
+ content: z.string(),
+ boardId: z.string(),
+ }),
+ )
+ .mutation(async ({ ctx, input }) => {
+ const item = await ctx.db.query.items.findFirst({
+ where: eq(items.id, input.itemId),
+ with: {
+ section: {
+ columns: {
+ boardId: true,
+ },
+ },
+ },
+ });
+
+ if (!item || item.section.boardId !== input.boardId) {
+ throw new TRPCError({
+ code: "NOT_FOUND",
+ message: "Specified item was not found",
+ });
+ }
+
+ const options = SuperJSON.parse<{ content: string }>(item.options);
+ options.content = input.content;
+ await ctx.db
+ .update(items)
+ .set({ options: SuperJSON.stringify(options) })
+ .where(eq(items.id, input.itemId));
+ }),
+});
diff --git a/packages/api/src/router/widgets/weather.ts b/packages/api/src/router/widgets/weather.ts
new file mode 100644
index 000000000..a5440fd73
--- /dev/null
+++ b/packages/api/src/router/widgets/weather.ts
@@ -0,0 +1,15 @@
+import { validation } from "@homarr/validation";
+
+import { createTRPCRouter, publicProcedure } from "../../trpc";
+
+export const weatherRouter = createTRPCRouter({
+ atLocation: publicProcedure
+ .input(validation.widget.weather.atLocationInput)
+ .output(validation.widget.weather.atLocationOutput)
+ .query(async ({ input }) => {
+ const res = await fetch(
+ `https://api.open-meteo.com/v1/forecast?latitude=${input.latitude}&longitude=${input.longitude}&daily=weathercode,temperature_2m_max,temperature_2m_min¤t_weather=true&timezone=auto`,
+ );
+ return res.json();
+ }),
+});
diff --git a/packages/api/src/server.ts b/packages/api/src/server.ts
new file mode 100644
index 000000000..c7522c0af
--- /dev/null
+++ b/packages/api/src/server.ts
@@ -0,0 +1,21 @@
+import { cache } from "react";
+import { headers } from "next/headers";
+
+import { createCaller, createTRPCContext } from "@homarr/api";
+import { auth } from "@homarr/auth/next";
+
+/**
+ * This wraps the `createTRPCContext` helper and provides the required context for the tRPC API when
+ * handling a tRPC call from a React Server Component.
+ */
+const createContext = cache(async () => {
+ const heads = new Headers(headers());
+ heads.set("x-trpc-source", "rsc");
+
+ return createTRPCContext({
+ session: await auth(),
+ headers: heads,
+ });
+});
+
+export const api = createCaller(createContext);
diff --git a/packages/api/src/trpc.ts b/packages/api/src/trpc.ts
index 4a13bb468..5d231aae4 100644
--- a/packages/api/src/trpc.ts
+++ b/packages/api/src/trpc.ts
@@ -10,56 +10,33 @@ import { initTRPC, TRPCError } from "@trpc/server";
import superjson from "superjson";
import type { Session } from "@homarr/auth";
-import { auth } from "@homarr/auth";
import { db } from "@homarr/db";
+import type { GroupPermissionKey } from "@homarr/definitions";
+import { logger } from "@homarr/log";
import { ZodError } from "@homarr/validation";
/**
* 1. CONTEXT
*
- * This section defines the "contexts" that are available in the backend API
+ * This section defines the "contexts" that are available in the backend API.
*
- * These allow you to access things like the database, the session, etc, when
- * processing a request
+ * These allow you to access things when processing a request, like the database, the session, etc.
*
- */
-interface CreateContextOptions {
- session: Session | null;
-}
-
-/**
- * This helper generates the "internals" for a tRPC context. If you need to use
- * it, you can export it from here
+ * This helper generates the "internals" for a tRPC context. The API handler and RSC clients each
+ * wrap this and provides the required context.
*
- * Examples of things you may need it for:
- * - testing, so we dont have to mock Next.js' req/res
- * - trpc's `createSSGHelpers` where we don't have req/res
- * @see https://create.t3.gg/en/usage/trpc#-servertrpccontextts
- */
-const createInnerTRPCContext = (opts: CreateContextOptions) => {
- return {
- session: opts.session,
- db,
- };
-};
-
-/**
- * This is the actual context you'll use in your router. It will be used to
- * process every request that goes through your tRPC endpoint
- * @link https://trpc.io/docs/context
+ * @see https://trpc.io/docs/server/context
*/
-export const createTRPCContext = async (opts: {
- headers?: Headers;
- auth: Session | null;
-}) => {
- const session = opts.auth ?? (await auth());
- const source = opts.headers?.get("x-trpc-source") ?? "unknown";
+export const createTRPCContext = (opts: { headers: Headers; session: Session | null }) => {
+ const session = opts.session;
+ const source = opts.headers.get("x-trpc-source") ?? "unknown";
- console.log(">>> tRPC Request from", source, "by", session?.user);
+ logger.info(`tRPC request from ${source} by user '${session?.user.name} (${session?.user.id})'`, session?.user);
- return createInnerTRPCContext({
+ return {
session,
- });
+ db,
+ };
};
/**
@@ -70,18 +47,21 @@ export const createTRPCContext = async (opts: {
*/
const t = initTRPC.context().create({
transformer: superjson,
- errorFormatter({ shape, error }) {
- return {
- ...shape,
- data: {
- ...shape.data,
- zodError:
- error.cause instanceof ZodError ? error.cause.flatten() : null,
- },
- };
- },
+ errorFormatter: ({ shape, error }) => ({
+ ...shape,
+ data: {
+ ...shape.data,
+ zodError: error.cause instanceof ZodError ? error.cause.flatten() : null,
+ },
+ }),
});
+/**
+ * Create a server-side caller
+ * @see https://trpc.io/docs/server/server-side-calls
+ */
+export const createCallerFactory = t.createCallerFactory;
+
/**
* 3. ROUTER & PROCEDURE (THE IMPORTANT BIT)
*
@@ -130,3 +110,25 @@ const enforceUserIsAuthed = t.middleware(({ ctx, next }) => {
* @see https://trpc.io/docs/procedures
*/
export const protectedProcedure = t.procedure.use(enforceUserIsAuthed);
+
+/**
+ * Procedure that requires a specific permission
+ *
+ * If you want a query or mutation to ONLY be accessible to users with a specific permission, use
+ * this. It verifies that the user has the required permission
+ *
+ * @see https://trpc.io/docs/procedures
+ */
+export const permissionRequiredProcedure = {
+ requiresPermission: (permission: GroupPermissionKey) => {
+ return protectedProcedure.use(({ ctx, input, next }) => {
+ if (!ctx.session?.user.permissions.includes(permission)) {
+ throw new TRPCError({
+ code: "FORBIDDEN",
+ message: "Permission denied",
+ });
+ }
+ return next({ input, ctx });
+ });
+ },
+};
diff --git a/packages/api/src/websocket.ts b/packages/api/src/websocket.ts
new file mode 100644
index 000000000..4402d80e1
--- /dev/null
+++ b/packages/api/src/websocket.ts
@@ -0,0 +1,2 @@
+export { appRouter } from "./root";
+export { createTRPCContext } from "./trpc";
diff --git a/packages/auth/callbacks.ts b/packages/auth/callbacks.ts
new file mode 100644
index 000000000..3fdeb0c54
--- /dev/null
+++ b/packages/auth/callbacks.ts
@@ -0,0 +1,78 @@
+import { cookies } from "next/headers";
+import type { Adapter } from "@auth/core/adapters";
+import type { NextAuthConfig } from "next-auth";
+
+import type { Database } from "@homarr/db";
+import { eq, inArray } from "@homarr/db";
+import { groupMembers, groupPermissions } from "@homarr/db/schema/sqlite";
+import { getPermissionsWithChildren } from "@homarr/definitions";
+
+import { expireDateAfter, generateSessionToken, sessionMaxAgeInSeconds, sessionTokenCookieName } from "./session";
+
+export const getCurrentUserPermissionsAsync = async (db: Database, userId: string) => {
+ const dbGroupMembers = await db.query.groupMembers.findMany({
+ where: eq(groupMembers.userId, userId),
+ });
+ const groupIds = dbGroupMembers.map((groupMember) => groupMember.groupId);
+ const dbGroupPermissions = await db
+ .selectDistinct({
+ permission: groupPermissions.permission,
+ })
+ .from(groupPermissions)
+ .where(groupIds.length > 0 ? inArray(groupPermissions.groupId, groupIds) : undefined);
+ const permissionKeys = dbGroupPermissions.map(({ permission }) => permission);
+
+ return getPermissionsWithChildren(permissionKeys);
+};
+
+export const createSessionCallback = (db: Database): NextAuthCallbackOf<"session"> => {
+ return async ({ session, user }) => {
+ return {
+ ...session,
+ user: {
+ ...session.user,
+ id: user.id,
+ name: user.name,
+ permissions: await getCurrentUserPermissionsAsync(db, user.id),
+ },
+ };
+ };
+};
+
+export const createSignInCallback =
+ (adapter: Adapter, isCredentialsRequest: boolean): NextAuthCallbackOf<"signIn"> =>
+ async ({ user }) => {
+ if (!isCredentialsRequest) return true;
+
+ if (!user) return true;
+
+ // https://github.com/nextauthjs/next-auth/issues/6106
+ if (!adapter?.createSession) {
+ return false;
+ }
+
+ const sessionToken = generateSessionToken();
+ const sessionExpiry = expireDateAfter(sessionMaxAgeInSeconds);
+
+ await adapter.createSession({
+ sessionToken,
+ userId: user.id!,
+ expires: sessionExpiry,
+ });
+
+ cookies().set(sessionTokenCookieName, sessionToken, {
+ path: "/",
+ expires: sessionExpiry,
+ httpOnly: true,
+ sameSite: "lax",
+ secure: true,
+ });
+
+ return true;
+ };
+
+type NextAuthCallbackRecord = Exclude;
+export type NextAuthCallbackOf = Exclude<
+ NextAuthCallbackRecord[TKey],
+ undefined
+>;
diff --git a/packages/auth/client.ts b/packages/auth/client.ts
index 0fbefd91b..ab914304f 100644
--- a/packages/auth/client.ts
+++ b/packages/auth/client.ts
@@ -1 +1 @@
-export { signIn, signOut } from "next-auth/react";
+export { signIn, signOut, useSession, SessionProvider } from "next-auth/react";
diff --git a/packages/auth/configuration.ts b/packages/auth/configuration.ts
index 047f11491..290df5f10 100644
--- a/packages/auth/configuration.ts
+++ b/packages/auth/configuration.ts
@@ -5,56 +5,35 @@ import Credentials from "next-auth/providers/credentials";
import { db } from "@homarr/db";
-import { credentialsConfiguration } from "./providers/credentials";
+import { createSessionCallback, createSignInCallback } from "./callbacks";
+import { createCredentialsConfiguration } from "./providers/credentials";
import { EmptyNextAuthProvider } from "./providers/empty";
-import { expireDateAfter, generateSessionToken } from "./session";
+import { sessionMaxAgeInSeconds, sessionTokenCookieName } from "./session";
const adapter = DrizzleAdapter(db);
-const sessionMaxAgeInSeconds = 30 * 24 * 60 * 60; // 30 days
export const createConfiguration = (isCredentialsRequest: boolean) =>
NextAuth({
- adapter,
- providers: [Credentials(credentialsConfiguration), EmptyNextAuthProvider()],
- callbacks: {
- session: ({ session, user }) => ({
- ...session,
- user: {
- ...session.user,
- id: user.id,
- name: user.name,
- },
- }),
- signIn: async ({ user }) => {
- if (!isCredentialsRequest) return true;
-
- if (!user) return true;
-
- const sessionToken = generateSessionToken();
- const sessionExpiry = expireDateAfter(sessionMaxAgeInSeconds);
-
- // https://github.com/nextauthjs/next-auth/issues/6106
- if (!adapter?.createSession) {
- return false;
+ logger: {
+ error: (code, ...message) => {
+ // Remove the big error message for failed login attempts
+ // as it is not useful for the user.
+ if (code.name === "CredentialsSignin") {
+ console.warn("The login attempt of a user was not successful.");
+ return;
}
- await adapter.createSession({
- sessionToken: sessionToken,
- userId: user.id,
- expires: sessionExpiry,
- });
-
- cookies().set("next-auth.session-token", sessionToken, {
- path: "/",
- expires: sessionExpiry,
- httpOnly: true,
- sameSite: "lax",
- secure: true,
- });
-
- return true;
+ console.error(code, ...message);
},
},
+ trustHost: true,
+ adapter,
+ providers: [Credentials(createCredentialsConfiguration(db)), EmptyNextAuthProvider()],
+ callbacks: {
+ session: createSessionCallback(db),
+ signIn: createSignInCallback(adapter, isCredentialsRequest),
+ },
+ secret: "secret-is-not-defined-yet", // TODO: This should be added later
session: {
strategy: "database",
maxAge: sessionMaxAgeInSeconds,
@@ -65,7 +44,7 @@ export const createConfiguration = (isCredentialsRequest: boolean) =>
},
jwt: {
encode() {
- const cookie = cookies().get("next-auth.session-token")?.value;
+ const cookie = cookies().get(sessionTokenCookieName)?.value;
return cookie ?? "";
},
diff --git a/packages/auth/env.mjs b/packages/auth/env.mjs
index 2866529a5..2e7ddcad0 100644
--- a/packages/auth/env.mjs
+++ b/packages/auth/env.mjs
@@ -3,22 +3,11 @@ import { z } from "zod";
export const env = createEnv({
server: {
- AUTH_SECRET:
- process.env.NODE_ENV === "production"
- ? z.string().min(1)
- : z.string().min(1).optional(),
- AUTH_URL: z.preprocess(
- // This makes Vercel deployments not fail if you don't set NEXTAUTH_URL
- // Since NextAuth.js automatically uses the VERCEL_URL if present.
- (str) => process.env.VERCEL_URL ?? str,
- // VERCEL_URL doesn't include `https` so it cant be validated as a URL
- process.env.VERCEL ? z.string() : z.string().url(),
- ),
+ AUTH_SECRET: process.env.NODE_ENV === "production" ? z.string().min(1) : z.string().min(1).optional(),
},
client: {},
runtimeEnv: {
AUTH_SECRET: process.env.AUTH_SECRET,
- AUTH_URL: process.env.AUTH_URL,
},
- skipValidation: !!process.env.CI || !!process.env.SKIP_ENV_VALIDATION,
+ skipValidation: Boolean(process.env.CI) || Boolean(process.env.SKIP_ENV_VALIDATION),
});
diff --git a/packages/auth/index.ts b/packages/auth/index.ts
index 407e7fa2a..eed6a80b9 100644
--- a/packages/auth/index.ts
+++ b/packages/auth/index.ts
@@ -1,19 +1,22 @@
import type { DefaultSession } from "@auth/core/types";
+import type { GroupPermissionKey } from "@homarr/definitions";
+
import { createConfiguration } from "./configuration";
-export type { Session } from "next-auth";
+export type { Session } from "@auth/core/types";
-declare module "next-auth" {
+declare module "@auth/core/types" {
interface Session {
user: {
id: string;
+ permissions: GroupPermissionKey[];
} & DefaultSession["user"];
}
}
export * from "./security";
-export const createHandlers = (isCredentialsRequest: boolean) =>
- createConfiguration(isCredentialsRequest);
-export const { auth } = createConfiguration(false);
+export const createHandlers = (isCredentialsRequest: boolean) => createConfiguration(isCredentialsRequest);
+
+export { getSessionFromTokenAsync as getSessionFromToken, sessionTokenCookieName } from "./session";
diff --git a/packages/auth/next.ts b/packages/auth/next.ts
new file mode 100644
index 000000000..77b178d13
--- /dev/null
+++ b/packages/auth/next.ts
@@ -0,0 +1,11 @@
+import { cache } from "react";
+
+import { createConfiguration } from "./configuration";
+
+const { auth: defaultAuth } = createConfiguration(false);
+
+/**
+ * This is the main way to get session data for your RSCs.
+ * This will de-duplicate all calls to next-auth's default `auth()` function and only call it once per request
+ */
+export const auth = cache(defaultAuth);
diff --git a/packages/auth/package.json b/packages/auth/package.json
index 8325ce8d8..9f5732ff7 100644
--- a/packages/auth/package.json
+++ b/packages/auth/package.json
@@ -1,6 +1,15 @@
{
"name": "@homarr/auth",
"version": "0.1.0",
+ "type": "module",
+ "exports": {
+ ".": "./index.ts",
+ "./next": "./next.ts",
+ "./security": "./security.ts",
+ "./client": "./client.ts",
+ "./shared": "./shared.ts",
+ "./env.mjs": "./env.mjs"
+ },
"private": true,
"main": "./index.ts",
"types": "./index.ts",
@@ -13,26 +22,27 @@
},
"dependencies": {
"@homarr/db": "workspace:^0.1.0",
- "@auth/core": "^0.19.0",
- "@auth/drizzle-adapter": "^0.3.12",
- "@t3-oss/env-nextjs": "^0.7.1",
+ "@auth/core": "^0.31.0",
+ "@auth/drizzle-adapter": "^1.1.0",
+ "@t3-oss/env-nextjs": "^0.10.1",
"bcrypt": "^5.1.1",
"cookies": "^0.9.1",
- "next": "^14.0.4",
- "next-auth": "5.0.0-beta.5",
- "react": "18.2.0",
- "react-dom": "18.2.0"
+ "next": "^14.2.3",
+ "next-auth": "5.0.0-beta.18",
+ "react": "18.3.1",
+ "react-dom": "18.3.1"
},
"devDependencies": {
"@homarr/eslint-config": "workspace:^0.2.0",
"@homarr/prettier-config": "workspace:^0.1.0",
"@homarr/tsconfig": "workspace:^0.1.0",
"@homarr/validation": "workspace:^0.1.0",
+ "@homarr/definitions": "workspace:^0.1.0",
"@types/bcrypt": "5.0.2",
- "@types/cookies": "0.7.10",
- "eslint": "^8.56.0",
- "prettier": "^3.1.0",
- "typescript": "^5.3.3"
+ "@types/cookies": "0.9.0",
+ "eslint": "^8.57.0",
+ "prettier": "^3.2.5",
+ "typescript": "^5.4.5"
},
"eslintConfig": {
"root": true,
diff --git a/packages/auth/permissions/board-permissions.ts b/packages/auth/permissions/board-permissions.ts
new file mode 100644
index 000000000..a3adbe8f6
--- /dev/null
+++ b/packages/auth/permissions/board-permissions.ts
@@ -0,0 +1,39 @@
+import type { Session } from "@auth/core/types";
+
+export type BoardPermissionsProps = (
+ | {
+ creator: {
+ id: string;
+ } | null;
+ }
+ | {
+ creatorId: string | null;
+ }
+) & {
+ userPermissions: {
+ permission: string;
+ }[];
+ groupPermissions: {
+ permission: string;
+ }[];
+ isPublic: boolean;
+};
+
+export const constructBoardPermissions = (board: BoardPermissionsProps, session: Session | null) => {
+ const creatorId = "creator" in board ? board.creator?.id : board.creatorId;
+
+ return {
+ hasFullAccess: session?.user?.id === creatorId || session?.user.permissions.includes("board-full-access"),
+ hasChangeAccess:
+ session?.user?.id === creatorId ||
+ board.userPermissions.some(({ permission }) => permission === "board-change") ||
+ board.groupPermissions.some(({ permission }) => permission === "board-change") ||
+ session?.user.permissions.includes("board-modify-all"),
+ hasViewAccess:
+ session?.user?.id === creatorId ||
+ board.userPermissions.length >= 1 ||
+ board.groupPermissions.length >= 1 ||
+ board.isPublic ||
+ session?.user.permissions.includes("board-view-all"),
+ };
+};
diff --git a/packages/auth/permissions/index.ts b/packages/auth/permissions/index.ts
new file mode 100644
index 000000000..8090541aa
--- /dev/null
+++ b/packages/auth/permissions/index.ts
@@ -0,0 +1 @@
+export * from "./board-permissions";
diff --git a/packages/auth/permissions/test/board-permissions.spec.ts b/packages/auth/permissions/test/board-permissions.spec.ts
new file mode 100644
index 000000000..24b180836
--- /dev/null
+++ b/packages/auth/permissions/test/board-permissions.spec.ts
@@ -0,0 +1,279 @@
+import type { Session } from "@auth/core/types";
+import { describe, expect, test } from "vitest";
+
+import { getPermissionsWithChildren } from "@homarr/definitions";
+
+import { constructBoardPermissions } from "../board-permissions";
+
+describe("constructBoardPermissions", () => {
+ test("should return all board permissions as true when session user id is equal to creator id", () => {
+ // Arrange
+ const board = {
+ creator: {
+ id: "1",
+ },
+ userPermissions: [],
+ groupPermissions: [],
+ isPublic: false,
+ };
+ const session = {
+ user: {
+ id: "1",
+ permissions: [],
+ },
+ expires: new Date().toISOString(),
+ } satisfies Session;
+
+ // Act
+ const result = constructBoardPermissions(board, session);
+
+ // Assert
+ expect(result.hasFullAccess).toBe(true);
+ expect(result.hasChangeAccess).toBe(true);
+ expect(result.hasViewAccess).toBe(true);
+ });
+
+ test("should return hasFullAccess as true when session permissions include board-full-access", () => {
+ // Arrange
+ const board = {
+ creator: {
+ id: "1",
+ },
+ userPermissions: [],
+ groupPermissions: [],
+ isPublic: false,
+ };
+ const session = {
+ user: {
+ id: "2",
+ permissions: getPermissionsWithChildren(["board-full-access"]),
+ },
+ expires: new Date().toISOString(),
+ } satisfies Session;
+
+ // Act
+ const result = constructBoardPermissions(board, session);
+
+ // Assert
+ expect(result.hasFullAccess).toBe(true);
+ expect(result.hasChangeAccess).toBe(true);
+ expect(result.hasViewAccess).toBe(true);
+ });
+
+ test("should return hasChangeAccess as true when session permissions include board-modify-all", () => {
+ // Arrange
+ const board = {
+ creator: {
+ id: "1",
+ },
+ userPermissions: [],
+ groupPermissions: [],
+ isPublic: false,
+ };
+ const session = {
+ user: {
+ id: "2",
+ permissions: getPermissionsWithChildren(["board-modify-all"]),
+ },
+ expires: new Date().toISOString(),
+ } satisfies Session;
+
+ // Act
+ const result = constructBoardPermissions(board, session);
+
+ // Assert
+ expect(result.hasFullAccess).toBe(false);
+ expect(result.hasChangeAccess).toBe(true);
+ expect(result.hasViewAccess).toBe(true);
+ });
+
+ test('should return hasChangeAccess as true when board user permissions include "board-change"', () => {
+ // Arrange
+ const board = {
+ creator: {
+ id: "1",
+ },
+
+ userPermissions: [{ permission: "board-change" }],
+ groupPermissions: [],
+ isPublic: false,
+ };
+ const session = {
+ user: {
+ id: "2",
+ permissions: [],
+ },
+ expires: new Date().toISOString(),
+ } satisfies Session;
+
+ // Act
+ const result = constructBoardPermissions(board, session);
+
+ // Assert
+ expect(result.hasFullAccess).toBe(false);
+ expect(result.hasChangeAccess).toBe(true);
+ expect(result.hasViewAccess).toBe(true);
+ });
+
+ test("should return hasChangeAccess as true when board group permissions include board-change", () => {
+ // Arrange
+ const board = {
+ creator: {
+ id: "1",
+ },
+ userPermissions: [],
+ groupPermissions: [{ permission: "board-change" }],
+ isPublic: false,
+ };
+ const session = {
+ user: {
+ id: "2",
+ permissions: [],
+ },
+ expires: new Date().toISOString(),
+ } satisfies Session;
+
+ // Act
+ const result = constructBoardPermissions(board, session);
+
+ // Assert
+ expect(result.hasFullAccess).toBe(false);
+ expect(result.hasChangeAccess).toBe(true);
+ expect(result.hasViewAccess).toBe(true);
+ });
+
+ test("should return hasViewAccess as true when session permissions include board-view-all", () => {
+ // Arrange
+ const board = {
+ creator: {
+ id: "1",
+ },
+ userPermissions: [],
+ groupPermissions: [],
+ isPublic: false,
+ };
+ const session = {
+ user: {
+ id: "2",
+ permissions: getPermissionsWithChildren(["board-view-all"]),
+ },
+ expires: new Date().toISOString(),
+ } satisfies Session;
+
+ // Act
+ const result = constructBoardPermissions(board, session);
+
+ // Assert
+ expect(result.hasFullAccess).toBe(false);
+ expect(result.hasChangeAccess).toBe(false);
+ expect(result.hasViewAccess).toBe(true);
+ });
+
+ test("should return hasViewAccess as true when board user permissions length is greater than or equal to 1", () => {
+ // Arrange
+ const board = {
+ creator: {
+ id: "1",
+ },
+ userPermissions: [{ permission: "board-view" }],
+ groupPermissions: [],
+ isPublic: false,
+ };
+ const session = {
+ user: {
+ id: "2",
+ permissions: [],
+ },
+ expires: new Date().toISOString(),
+ } satisfies Session;
+
+ // Act
+ const result = constructBoardPermissions(board, session);
+
+ // Assert
+ expect(result.hasFullAccess).toBe(false);
+ expect(result.hasChangeAccess).toBe(false);
+ expect(result.hasViewAccess).toBe(true);
+ });
+
+ test("should return hasViewAccess as true when board group permissions length is greater than or equal to 1", () => {
+ // Arrange
+ const board = {
+ creator: {
+ id: "1",
+ },
+ userPermissions: [],
+ groupPermissions: [{ permission: "board-view" }],
+ isPublic: false,
+ };
+ const session = {
+ user: {
+ id: "2",
+ permissions: [],
+ },
+ expires: new Date().toISOString(),
+ } satisfies Session;
+
+ // Act
+ const result = constructBoardPermissions(board, session);
+
+ // Assert
+ expect(result.hasFullAccess).toBe(false);
+ expect(result.hasChangeAccess).toBe(false);
+ expect(result.hasViewAccess).toBe(true);
+ });
+
+ test("should return all false when board is not public and session user id is not equal to creator id and no permissions", () => {
+ // Arrange
+ const board = {
+ creator: {
+ id: "1",
+ },
+ userPermissions: [],
+ groupPermissions: [],
+ isPublic: false,
+ };
+ const session = {
+ user: {
+ id: "2",
+ permissions: [],
+ },
+ expires: new Date().toISOString(),
+ } satisfies Session;
+
+ // Act
+ const result = constructBoardPermissions(board, session);
+
+ // Assert
+ expect(result.hasFullAccess).toBe(false);
+ expect(result.hasChangeAccess).toBe(false);
+ expect(result.hasViewAccess).toBe(false);
+ });
+
+ test("should return hasViewAccess as true when board is public", () => {
+ // Arrange
+ const board = {
+ creator: {
+ id: "1",
+ },
+ userPermissions: [],
+ groupPermissions: [],
+ isPublic: true,
+ };
+ const session = {
+ user: {
+ id: "2",
+ permissions: [],
+ },
+ expires: new Date().toISOString(),
+ } satisfies Session;
+
+ // Act
+ const result = constructBoardPermissions(board, session);
+
+ // Assert
+ expect(result.hasFullAccess).toBe(false);
+ expect(result.hasChangeAccess).toBe(false);
+ expect(result.hasViewAccess).toBe(true);
+ });
+});
diff --git a/packages/auth/providers/credentials.ts b/packages/auth/providers/credentials.ts
index 114c8ecba..ecc101078 100644
--- a/packages/auth/providers/credentials.ts
+++ b/packages/auth/providers/credentials.ts
@@ -1,49 +1,53 @@
import type Credentials from "@auth/core/providers/credentials";
import bcrypt from "bcrypt";
-import { db, eq } from "@homarr/db";
+import type { Database } from "@homarr/db";
+import { eq } from "@homarr/db";
import { users } from "@homarr/db/schema/sqlite";
import { validation } from "@homarr/validation";
type CredentialsConfiguration = Parameters[0];
-export const credentialsConfiguration = {
- type: "credentials",
- name: "Credentials",
- credentials: {
- name: {
- label: "Username",
- type: "text",
+export const createCredentialsConfiguration = (db: Database) =>
+ ({
+ type: "credentials",
+ name: "Credentials",
+ credentials: {
+ name: {
+ label: "Username",
+ type: "text",
+ },
+ password: {
+ label: "Password",
+ type: "password",
+ },
},
- password: {
- label: "Password",
- type: "password",
+ // eslint-disable-next-line no-restricted-syntax
+ async authorize(credentials) {
+ const data = await validation.user.signIn.parseAsync(credentials);
+
+ const user = await db.query.users.findFirst({
+ where: eq(users.name, data.name),
+ });
+
+ if (!user?.password) {
+ console.log(`user ${data.name} was not found`);
+ return null;
+ }
+
+ console.log(`user ${user.name} is trying to log in. checking password...`);
+ const isValidPassword = await bcrypt.compare(data.password, user.password);
+
+ if (!isValidPassword) {
+ console.log(`password for user ${user.name} was incorrect`);
+ return null;
+ }
+
+ console.log(`user ${user.name} successfully authorized`);
+
+ return {
+ id: user.id,
+ name: user.name,
+ };
},
- },
- async authorize(credentials) {
- const data = await validation.user.signIn.parseAsync(credentials);
-
- const user = await db.query.users.findFirst({
- where: eq(users.name, data.name),
- });
-
- if (!user?.password) {
- return null;
- }
-
- console.log(`user ${user.name} is trying to log in. checking password...`);
- const isValidPassword = await bcrypt.compare(data.password, user.password);
-
- if (!isValidPassword) {
- console.log(`password for user ${user.name} was incorrect`);
- return null;
- }
-
- console.log(`user ${user.name} successfully authorized`);
-
- return {
- id: user.id,
- name: user.name,
- };
- },
-} satisfies CredentialsConfiguration;
+ }) satisfies CredentialsConfiguration;
diff --git a/packages/auth/providers/test/credentials.spec.ts b/packages/auth/providers/test/credentials.spec.ts
new file mode 100644
index 000000000..0f7c7c98b
--- /dev/null
+++ b/packages/auth/providers/test/credentials.spec.ts
@@ -0,0 +1,60 @@
+import { describe, expect, it } from "vitest";
+
+import { createId } from "@homarr/db";
+import { users } from "@homarr/db/schema/sqlite";
+import { createDb } from "@homarr/db/test";
+
+import { createSaltAsync, hashPasswordAsync } from "../../security";
+import { createCredentialsConfiguration } from "../credentials";
+
+describe("Credentials authorization", () => {
+ it("should authorize user with correct credentials", async () => {
+ const db = createDb();
+ const userId = createId();
+ const salt = await createSaltAsync();
+ await db.insert(users).values({
+ id: userId,
+ name: "test",
+ password: await hashPasswordAsync("test", salt),
+ salt,
+ });
+ const result = await createCredentialsConfiguration(db).authorize({
+ name: "test",
+ password: "test",
+ });
+
+ expect(result).toEqual({ id: userId, name: "test" });
+ });
+
+ const passwordsThatShouldNotAuthorize = ["wrong", "Test", "test ", " test", " test "];
+
+ passwordsThatShouldNotAuthorize.forEach((password) => {
+ it(`should not authorize user with incorrect credentials (${password})`, async () => {
+ const db = createDb();
+ const userId = createId();
+ const salt = await createSaltAsync();
+ await db.insert(users).values({
+ id: userId,
+ name: "test",
+ password: await hashPasswordAsync("test", salt),
+ salt,
+ });
+ const result = await createCredentialsConfiguration(db).authorize({
+ name: "test",
+ password,
+ });
+
+ expect(result).toBeNull();
+ });
+ });
+
+ it("should not authorize user for not existing user", async () => {
+ const db = createDb();
+ const result = await createCredentialsConfiguration(db).authorize({
+ name: "test",
+ password: "test",
+ });
+
+ expect(result).toBeNull();
+ });
+});
diff --git a/packages/auth/security.ts b/packages/auth/security.ts
index 90366c7ea..cc0c16c6b 100644
--- a/packages/auth/security.ts
+++ b/packages/auth/security.ts
@@ -1,9 +1,9 @@
import bcrypt from "bcrypt";
-export const createSalt = async () => {
+export const createSaltAsync = async () => {
return bcrypt.genSalt(10);
};
-export const hashPassword = async (password: string, salt: string) => {
+export const hashPasswordAsync = async (password: string, salt: string) => {
return bcrypt.hash(password, salt);
};
diff --git a/packages/auth/session.ts b/packages/auth/session.ts
index 3329a0ffa..3e893db04 100644
--- a/packages/auth/session.ts
+++ b/packages/auth/session.ts
@@ -1,4 +1,12 @@
import { randomUUID } from "crypto";
+import type { Session } from "@auth/core/types";
+
+import type { Database } from "@homarr/db";
+
+import { getCurrentUserPermissionsAsync } from "./callbacks";
+
+export const sessionMaxAgeInSeconds = 30 * 24 * 60 * 60; // 30 days
+export const sessionTokenCookieName = "next-auth.session-token";
export const expireDateAfter = (seconds: number) => {
return new Date(Date.now() + seconds * 1000);
@@ -7,3 +15,38 @@ export const expireDateAfter = (seconds: number) => {
export const generateSessionToken = () => {
return randomUUID();
};
+
+export const getSessionFromTokenAsync = async (db: Database, token: string | undefined): Promise => {
+ if (!token) {
+ return null;
+ }
+
+ const session = await db.query.sessions.findFirst({
+ where: ({ sessionToken }, { eq }) => eq(sessionToken, token),
+ columns: {
+ expires: true,
+ },
+ with: {
+ user: {
+ columns: {
+ id: true,
+ name: true,
+ email: true,
+ image: true,
+ },
+ },
+ },
+ });
+
+ if (!session) {
+ return null;
+ }
+
+ return {
+ user: {
+ ...session.user,
+ permissions: await getCurrentUserPermissionsAsync(db, session.user.id),
+ },
+ expires: session.expires.toISOString(),
+ };
+};
diff --git a/packages/auth/shared.ts b/packages/auth/shared.ts
new file mode 100644
index 000000000..972144448
--- /dev/null
+++ b/packages/auth/shared.ts
@@ -0,0 +1 @@
+export * from "./permissions";
diff --git a/packages/auth/test/callbacks.spec.ts b/packages/auth/test/callbacks.spec.ts
new file mode 100644
index 000000000..1dced2115
--- /dev/null
+++ b/packages/auth/test/callbacks.spec.ts
@@ -0,0 +1,188 @@
+import type { ResponseCookie } from "next/dist/compiled/@edge-runtime/cookies";
+import type { ReadonlyRequestCookies } from "next/dist/server/web/spec-extension/adapters/request-cookies";
+import { cookies } from "next/headers";
+import type { Adapter, AdapterUser } from "@auth/core/adapters";
+import type { Account, User } from "next-auth";
+import type { JWT } from "next-auth/jwt";
+import { describe, expect, it, test, vi } from "vitest";
+
+import { groupMembers, groupPermissions, groups, users } from "@homarr/db/schema/sqlite";
+import { createDb } from "@homarr/db/test";
+import * as definitions from "@homarr/definitions";
+
+import { createSessionCallback, createSignInCallback, getCurrentUserPermissionsAsync } from "../callbacks";
+
+describe("getCurrentUserPermissions", () => {
+ test("should return empty permissions when non existing user requested", async () => {
+ const db = createDb();
+
+ await db.insert(users).values({
+ id: "2",
+ });
+
+ const userId = "1";
+ const result = await getCurrentUserPermissionsAsync(db, userId);
+ expect(result).toEqual([]);
+ });
+ test("should return permissions for user", async () => {
+ const db = createDb();
+ const getPermissionsWithChildrenMock = vi
+ .spyOn(definitions, "getPermissionsWithChildren")
+ .mockReturnValue(["board-create"]);
+ const mockId = "1";
+
+ await db.insert(users).values({
+ id: mockId,
+ });
+ await db.insert(groups).values({
+ id: mockId,
+ name: "test",
+ });
+ await db.insert(groupMembers).values({
+ userId: mockId,
+ groupId: mockId,
+ });
+ await db.insert(groupPermissions).values({
+ groupId: mockId,
+ permission: "admin",
+ });
+
+ const result = await getCurrentUserPermissionsAsync(db, mockId);
+ expect(result).toEqual(["board-create"]);
+ expect(getPermissionsWithChildrenMock).toHaveBeenCalledWith(["admin"]);
+ });
+});
+
+describe("session callback", () => {
+ it("should add id and name to session user", async () => {
+ const user: AdapterUser = {
+ id: "id",
+ name: "name",
+ email: "email",
+ emailVerified: new Date("2023-01-13"),
+ };
+ const token: JWT = {};
+ const db = createDb();
+ const callback = createSessionCallback(db);
+ const result = await callback({
+ session: {
+ user: {
+ id: "no-id",
+ email: "no-email",
+ emailVerified: new Date("2023-01-13"),
+ permissions: [],
+ },
+ expires: "2023-01-13" as Date & string,
+ sessionToken: "token",
+ userId: "no-id",
+ },
+ user,
+ token,
+ trigger: "update",
+ newSession: {},
+ });
+ expect(result.user).toBeDefined();
+ expect(result.user!.id).toEqual(user.id);
+ expect(result.user!.name).toEqual(user.name);
+ });
+});
+
+type AdapterSessionInput = Parameters>[0];
+
+const createAdapter = () => {
+ const result = {
+ createSession: (input: AdapterSessionInput) => input,
+ };
+
+ vi.spyOn(result, "createSession");
+ return result;
+};
+
+// eslint-disable-next-line @typescript-eslint/consistent-type-imports
+type SessionExport = typeof import("../session");
+const mockSessionToken = "e9ef3010-6981-4a81-b9d6-8495d09cf3b5";
+const mockSessionExpiry = new Date("2023-07-01");
+vi.mock("../session", async (importOriginal) => {
+ const mod = await importOriginal();
+
+ const generateSessionToken = (): typeof mockSessionToken => mockSessionToken;
+ const expireDateAfter = (_seconds: number) => mockSessionExpiry;
+
+ return {
+ ...mod,
+ generateSessionToken,
+ expireDateAfter,
+ } satisfies SessionExport;
+});
+// eslint-disable-next-line @typescript-eslint/consistent-type-imports
+type HeadersExport = typeof import("next/headers");
+vi.mock("next/headers", async (importOriginal) => {
+ const mod = await importOriginal();
+
+ const result = {
+ set: (name: string, value: string, options: Partial) => options as ResponseCookie,
+ } as unknown as ReadonlyRequestCookies;
+
+ vi.spyOn(result, "set");
+
+ const cookies = () => result;
+
+ return { ...mod, cookies } satisfies HeadersExport;
+});
+
+describe("createSignInCallback", () => {
+ it("should return true if not credentials request", async () => {
+ const isCredentialsRequest = false;
+ const signInCallback = createSignInCallback(createAdapter(), isCredentialsRequest);
+ const result = await signInCallback({
+ user: { id: "1", emailVerified: new Date("2023-01-13") },
+ account: {} as Account,
+ });
+ expect(result).toBe(true);
+ });
+
+ it("should return true if no user", async () => {
+ const isCredentialsRequest = true;
+ const signInCallback = createSignInCallback(createAdapter(), isCredentialsRequest);
+ const result = await signInCallback({
+ user: undefined as unknown as User,
+ account: {} as Account,
+ });
+ expect(result).toBe(true);
+ });
+
+ it("should return false if no adapter.createSession", async () => {
+ const isCredentialsRequest = true;
+ const signInCallback = createSignInCallback(
+ // https://github.com/nextauthjs/next-auth/issues/6106
+ undefined as unknown as Adapter,
+ isCredentialsRequest,
+ );
+ const result = await signInCallback({
+ user: { id: "1", emailVerified: new Date("2023-01-13") },
+ account: {} as Account,
+ });
+ expect(result).toBe(false);
+ });
+
+ it("should call adapter.createSession with correct input", async () => {
+ const adapter = createAdapter();
+ const isCredentialsRequest = true;
+ const signInCallback = createSignInCallback(adapter, isCredentialsRequest);
+ const user = { id: "1", emailVerified: new Date("2023-01-13") };
+ const account = {} as Account;
+ await signInCallback({ user, account });
+ expect(adapter.createSession).toHaveBeenCalledWith({
+ sessionToken: mockSessionToken,
+ userId: user.id,
+ expires: mockSessionExpiry,
+ });
+ expect(cookies().set).toHaveBeenCalledWith("next-auth.session-token", mockSessionToken, {
+ path: "/",
+ expires: mockSessionExpiry,
+ httpOnly: true,
+ sameSite: "lax",
+ secure: true,
+ });
+ });
+});
diff --git a/packages/auth/test/security.spec.ts b/packages/auth/test/security.spec.ts
new file mode 100644
index 000000000..fed59513b
--- /dev/null
+++ b/packages/auth/test/security.spec.ts
@@ -0,0 +1,47 @@
+import { describe, expect, it } from "vitest";
+
+import { createSaltAsync, hashPasswordAsync } from "../security";
+
+describe("createSalt should return a salt", () => {
+ it("should return a salt", async () => {
+ const result = await createSaltAsync();
+ expect(result).toBeDefined();
+ expect(result.length).toBeGreaterThan(25);
+ });
+ it("should return a different salt each time", async () => {
+ const result1 = await createSaltAsync();
+ const result2 = await createSaltAsync();
+ expect(result1).not.toEqual(result2);
+ });
+});
+
+describe("hashPassword should return a hash", () => {
+ it("should return a hash", async () => {
+ const password = "password";
+ const salt = await createSaltAsync();
+ const result = await hashPasswordAsync(password, salt);
+ expect(result).toBeDefined();
+ expect(result.length).toBeGreaterThan(55);
+ expect(result).not.toEqual(password);
+ });
+ it("should return a different hash each time", async () => {
+ const password = "password";
+ const password2 = "another password";
+ const salt = await createSaltAsync();
+
+ const result1 = await hashPasswordAsync(password, salt);
+ const result2 = await hashPasswordAsync(password2, salt);
+
+ expect(result1).not.toEqual(result2);
+ });
+ it("should return a different hash for the same password with different salts", async () => {
+ const password = "password";
+ const salt1 = await createSaltAsync();
+ const salt2 = await createSaltAsync();
+
+ const result1 = await hashPasswordAsync(password, salt1);
+ const result2 = await hashPasswordAsync(password, salt2);
+
+ expect(result1).not.toEqual(result2);
+ });
+});
diff --git a/packages/auth/test/session.spec.ts b/packages/auth/test/session.spec.ts
new file mode 100644
index 000000000..27adfef2a
--- /dev/null
+++ b/packages/auth/test/session.spec.ts
@@ -0,0 +1,40 @@
+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
+
+import { z } from "@homarr/validation";
+
+import { expireDateAfter, generateSessionToken } from "../session";
+
+describe("expireDateAfter should calculate date after specified seconds", () => {
+ beforeEach(() => {
+ vi.useFakeTimers();
+ });
+
+ afterEach(() => {
+ vi.useRealTimers();
+ });
+
+ it.each([
+ ["2023-07-01T00:00:00Z", 60, "2023-07-01T00:01:00Z"], // 1 minute
+ ["2023-07-01T00:00:00Z", 60 * 60, "2023-07-01T01:00:00Z"], // 1 hour
+ ["2023-07-01T00:00:00Z", 60 * 60 * 24, "2023-07-02T00:00:00Z"], // 1 day
+ ["2023-07-01T00:00:00Z", 60 * 60 * 24 * 30, "2023-07-31T00:00:00Z"], // 30 days
+ ["2023-07-01T00:00:00Z", 60 * 60 * 24 * 365, "2024-06-30T00:00:00Z"], // 1 year
+ ["2023-07-01T00:00:00Z", 60 * 60 * 24 * 365 * 10, "2033-06-28T00:00:00Z"], // 10 years
+ ])("should calculate date %s and after %i seconds to equal %s", (initialDate, seconds, expectedDate) => {
+ vi.setSystemTime(new Date(initialDate));
+ const result = expireDateAfter(seconds);
+ expect(result).toEqual(new Date(expectedDate));
+ });
+});
+
+describe("generateSessionToken should return a random UUID", () => {
+ it("should return a random UUID", () => {
+ const result = generateSessionToken();
+ expect(z.string().uuid().safeParse(result).success).toBe(true);
+ });
+ it("should return a different token each time", () => {
+ const result1 = generateSessionToken();
+ const result2 = generateSessionToken();
+ expect(result1).not.toEqual(result2);
+ });
+});
diff --git a/packages/common/package.json b/packages/common/package.json
index 96b060a49..31cd7eabb 100644
--- a/packages/common/package.json
+++ b/packages/common/package.json
@@ -2,8 +2,10 @@
"name": "@homarr/common",
"private": true,
"version": "0.1.0",
+ "type": "module",
"exports": {
- ".": "./index.ts"
+ ".": "./index.ts",
+ "./types": "./src/types.ts"
},
"typesVersions": {
"*": {
@@ -23,8 +25,8 @@
"@homarr/eslint-config": "workspace:^0.2.0",
"@homarr/prettier-config": "workspace:^0.1.0",
"@homarr/tsconfig": "workspace:^0.1.0",
- "eslint": "^8.56.0",
- "typescript": "^5.3.3"
+ "eslint": "^8.57.0",
+ "typescript": "^5.4.5"
},
"eslintConfig": {
"extends": [
diff --git a/packages/common/src/array.ts b/packages/common/src/array.ts
new file mode 100644
index 000000000..823dc7794
--- /dev/null
+++ b/packages/common/src/array.ts
@@ -0,0 +1,7 @@
+export const splitToNChunks = (array: T[], chunks: number): T[][] => {
+ const result: T[][] = [];
+ for (let i = chunks; i > 0; i--) {
+ result.push(array.splice(0, Math.ceil(array.length / i)));
+ }
+ return result;
+};
diff --git a/packages/common/src/cookie.ts b/packages/common/src/cookie.ts
new file mode 100644
index 000000000..699dd9252
--- /dev/null
+++ b/packages/common/src/cookie.ts
@@ -0,0 +1,17 @@
+export function parseCookies(cookieString: string) {
+ const list: Record = {};
+ const cookieHeader = cookieString;
+ if (!cookieHeader) return list;
+
+ cookieHeader.split(";").forEach(function (cookie) {
+ const items = cookie.split("=");
+ let name = items.shift();
+ name = name?.trim();
+ if (!name) return;
+ const value = items.join("=").trim();
+ if (!value) return;
+ list[name] = decodeURIComponent(value);
+ });
+
+ return list;
+}
diff --git a/packages/common/src/index.ts b/packages/common/src/index.ts
index e136ba1f5..1089f3537 100644
--- a/packages/common/src/index.ts
+++ b/packages/common/src/index.ts
@@ -1,2 +1,5 @@
export * from "./object";
export * from "./string";
+export * from "./cookie";
+export * from "./array";
+export * from "./stopwatch";
diff --git a/packages/common/src/object.ts b/packages/common/src/object.ts
index 6bcb87a62..7e0ccde7f 100644
--- a/packages/common/src/object.ts
+++ b/packages/common/src/object.ts
@@ -6,5 +6,4 @@ type Entries = {
[K in keyof T]: [K, T[K]];
}[keyof T][];
-export const objectEntries = (obj: T) =>
- Object.entries(obj) as Entries;
+export const objectEntries = (obj: T) => Object.entries(obj) as Entries;
diff --git a/packages/common/src/stopwatch.ts b/packages/common/src/stopwatch.ts
new file mode 100644
index 000000000..ed15476f6
--- /dev/null
+++ b/packages/common/src/stopwatch.ts
@@ -0,0 +1,44 @@
+import dayjs from "dayjs";
+import relativeTime from "dayjs/plugin/relativeTime";
+import updateLocale from "dayjs/plugin/updateLocale";
+
+dayjs.extend(relativeTime);
+dayjs.extend(updateLocale);
+dayjs.updateLocale("en", {
+ relativeTime: {
+ future: "in %s",
+ past: "%s ago",
+ s: "one second",
+ ss: "%d seconds",
+ m: "a minute",
+ mm: "%d minutes",
+ h: "an hour",
+ hh: "%d hours",
+ d: "a day",
+ dd: "%d days",
+ M: "a month",
+ MM: "%d months",
+ y: "a year",
+ yy: "%d years",
+ },
+});
+
+export class Stopwatch {
+ private startTime: number;
+
+ constructor() {
+ this.startTime = performance.now();
+ }
+
+ getElapsedInHumanWords() {
+ const difference = performance.now() - this.startTime;
+ if (difference < 1000) {
+ return `${Math.floor(difference)} ms`;
+ }
+ return dayjs().millisecond(this.startTime).fromNow(true);
+ }
+
+ reset() {
+ this.startTime = performance.now();
+ }
+}
diff --git a/packages/common/src/test/object.spec.ts b/packages/common/src/test/object.spec.ts
new file mode 100644
index 000000000..d99ebd7cf
--- /dev/null
+++ b/packages/common/src/test/object.spec.ts
@@ -0,0 +1,21 @@
+import { describe, expect, it } from "vitest";
+
+import { objectEntries, objectKeys } from "../object";
+
+const testObjects = [{ a: 1, c: 3, b: 2 }, { a: 1, b: 2 }, { a: 1 }, {}] as const;
+
+describe("objectKeys should return all keys of an object", () => {
+ testObjects.forEach((obj) => {
+ it(`should return all keys of the object ${JSON.stringify(obj)}`, () => {
+ expect(objectKeys(obj)).toEqual(Object.keys(obj));
+ });
+ });
+});
+
+describe("objectEntries should return all entries of an object", () => {
+ testObjects.forEach((obj) => {
+ it(`should return all entries of the object ${JSON.stringify(obj)}`, () => {
+ expect(objectEntries(obj)).toEqual(Object.entries(obj));
+ });
+ });
+});
diff --git a/packages/common/src/test/string.spec.ts b/packages/common/src/test/string.spec.ts
new file mode 100644
index 000000000..df8b4461a
--- /dev/null
+++ b/packages/common/src/test/string.spec.ts
@@ -0,0 +1,19 @@
+import { describe, expect, it } from "vitest";
+
+import { capitalize } from "../string";
+
+const capitalizeTestCases = [
+ ["hello", "Hello"],
+ ["World", "World"],
+ ["123", "123"],
+ ["a", "A"],
+ ["two words", "Two words"],
+] as const;
+
+describe("capitalize should capitalize the first letter of a string", () => {
+ capitalizeTestCases.forEach(([input, expected]) => {
+ it(`should capitalize ${input} to ${expected}`, () => {
+ expect(capitalize(input)).toEqual(expected);
+ });
+ });
+});
diff --git a/packages/common/src/types.ts b/packages/common/src/types.ts
new file mode 100644
index 000000000..9cd354b34
--- /dev/null
+++ b/packages/common/src/types.ts
@@ -0,0 +1 @@
+export type MaybePromise = T | Promise;
diff --git a/packages/db/client.ts b/packages/db/client.ts
new file mode 100644
index 000000000..72b8e27b0
--- /dev/null
+++ b/packages/db/client.ts
@@ -0,0 +1 @@
+export { createId } from "@paralleldrive/cuid2";
diff --git a/packages/db/configs/mysql.config.ts b/packages/db/configs/mysql.config.ts
new file mode 100644
index 000000000..b3669df13
--- /dev/null
+++ b/packages/db/configs/mysql.config.ts
@@ -0,0 +1,17 @@
+import * as dotenv from "dotenv";
+import type { Config } from "drizzle-kit";
+
+dotenv.config({ path: "../../.env" });
+
+export default {
+ dialect: "mysql",
+ schema: "./schema",
+ dbCredentials: {
+ host: process.env.DB_HOST!,
+ user: process.env.DB_USER!,
+ password: process.env.DB_PASSWORD!,
+ database: process.env.DB_NAME!,
+ port: parseInt(process.env.DB_PORT!),
+ },
+ out: "./migrations/mysql",
+} satisfies Config;
diff --git a/packages/db/drizzle.config.ts b/packages/db/configs/sqlite.config.ts
similarity index 81%
rename from packages/db/drizzle.config.ts
rename to packages/db/configs/sqlite.config.ts
index 61d448cde..919cbfc0b 100644
--- a/packages/db/drizzle.config.ts
+++ b/packages/db/configs/sqlite.config.ts
@@ -4,7 +4,8 @@ import type { Config } from "drizzle-kit";
dotenv.config({ path: "../../.env" });
export default {
+ dialect: "sqlite",
schema: "./schema",
- driver: "better-sqlite",
dbCredentials: { url: process.env.DB_URL! },
+ out: "./migrations/sqlite",
} satisfies Config;
diff --git a/packages/db/driver.ts b/packages/db/driver.ts
new file mode 100644
index 000000000..2cea933ea
--- /dev/null
+++ b/packages/db/driver.ts
@@ -0,0 +1,65 @@
+import Database from "better-sqlite3";
+import type { Logger } from "drizzle-orm";
+import type { BetterSQLite3Database } from "drizzle-orm/better-sqlite3";
+import { drizzle as drizzleSqlite } from "drizzle-orm/better-sqlite3";
+import { drizzle as drizzleMysql } from "drizzle-orm/mysql2";
+import mysql from "mysql2";
+
+import { logger } from "@homarr/log";
+
+import * as mysqlSchema from "./schema/mysql";
+import * as sqliteSchema from "./schema/sqlite";
+
+type HomarrDatabase = BetterSQLite3Database;
+
+const init = () => {
+ if (!connection) {
+ switch (process.env.DB_DRIVER) {
+ case "mysql2":
+ initMySQL2();
+ break;
+ default:
+ initBetterSqlite();
+ break;
+ }
+ }
+};
+
+export let connection: Database.Database | mysql.Connection;
+export let database: HomarrDatabase;
+
+class WinstonDrizzleLogger implements Logger {
+ logQuery(query: string, _: unknown[]): void {
+ logger.debug(`Executed SQL query: ${query}`);
+ }
+}
+
+const initBetterSqlite = () => {
+ connection = new Database(process.env.DB_URL);
+ database = drizzleSqlite(connection, {
+ schema: sqliteSchema,
+ logger: new WinstonDrizzleLogger(),
+ }) as unknown as never;
+};
+
+const initMySQL2 = () => {
+ if (!process.env.DB_HOST) {
+ connection = mysql.createConnection({ uri: process.env.DB_URL });
+ } else {
+ connection = mysql.createConnection({
+ host: process.env.DB_HOST,
+ database: process.env.DB_NAME!,
+ port: Number(process.env.DB_PORT),
+ user: process.env.DB_USER,
+ password: process.env.DB_PASSWORD,
+ });
+ }
+
+ database = drizzleMysql(connection, {
+ schema: mysqlSchema,
+ mode: "default",
+ logger: new WinstonDrizzleLogger(),
+ }) as unknown as HomarrDatabase;
+};
+
+init();
diff --git a/packages/db/index.ts b/packages/db/index.ts
index 161b0a537..beec11606 100644
--- a/packages/db/index.ts
+++ b/packages/db/index.ts
@@ -1,14 +1,15 @@
import Database from "better-sqlite3";
-import { drizzle } from "drizzle-orm/better-sqlite3";
+import { database } from "./driver";
import * as sqliteSchema from "./schema/sqlite";
+// Export only the types from the sqlite schema as we're using that.
export const schema = sqliteSchema;
export * from "drizzle-orm";
-const sqlite = new Database(process.env.DB_URL!);
+export const db = database;
-export const db = drizzle(sqlite, { schema });
+export type Database = typeof db;
export { createId } from "@paralleldrive/cuid2";
diff --git a/packages/db/migrations/mysql/0000_harsh_photon.sql b/packages/db/migrations/mysql/0000_harsh_photon.sql
new file mode 100644
index 000000000..0aa47aca5
--- /dev/null
+++ b/packages/db/migrations/mysql/0000_harsh_photon.sql
@@ -0,0 +1,193 @@
+CREATE TABLE `account` (
+ `userId` varchar(64) NOT NULL,
+ `type` text NOT NULL,
+ `provider` varchar(64) NOT NULL,
+ `providerAccountId` varchar(64) NOT NULL,
+ `refresh_token` text,
+ `access_token` text,
+ `expires_at` int,
+ `token_type` text,
+ `scope` text,
+ `id_token` text,
+ `session_state` text,
+ CONSTRAINT `account_provider_providerAccountId_pk` PRIMARY KEY(`provider`,`providerAccountId`)
+);
+--> statement-breakpoint
+CREATE TABLE `app` (
+ `id` varchar(64) NOT NULL,
+ `name` text NOT NULL,
+ `description` text,
+ `icon_url` text NOT NULL,
+ `href` text,
+ CONSTRAINT `app_id` PRIMARY KEY(`id`)
+);
+--> statement-breakpoint
+CREATE TABLE `boardGroupPermission` (
+ `board_id` varchar(64) NOT NULL,
+ `group_id` varchar(64) NOT NULL,
+ `permission` varchar(128) NOT NULL,
+ CONSTRAINT `boardGroupPermission_board_id_group_id_permission_pk` PRIMARY KEY(`board_id`,`group_id`,`permission`)
+);
+--> statement-breakpoint
+CREATE TABLE `boardUserPermission` (
+ `board_id` varchar(64) NOT NULL,
+ `user_id` varchar(64) NOT NULL,
+ `permission` varchar(128) NOT NULL,
+ CONSTRAINT `boardUserPermission_board_id_user_id_permission_pk` PRIMARY KEY(`board_id`,`user_id`,`permission`)
+);
+--> statement-breakpoint
+CREATE TABLE `board` (
+ `id` varchar(64) NOT NULL,
+ `name` varchar(256) NOT NULL,
+ `is_public` boolean NOT NULL DEFAULT false,
+ `creator_id` varchar(64),
+ `page_title` text,
+ `meta_title` text,
+ `logo_image_url` text,
+ `favicon_image_url` text,
+ `background_image_url` text,
+ `background_image_attachment` text NOT NULL DEFAULT ('fixed'),
+ `background_image_repeat` text NOT NULL DEFAULT ('no-repeat'),
+ `background_image_size` text NOT NULL DEFAULT ('cover'),
+ `primary_color` text NOT NULL DEFAULT ('#fa5252'),
+ `secondary_color` text NOT NULL DEFAULT ('#fd7e14'),
+ `opacity` int NOT NULL DEFAULT 100,
+ `custom_css` text,
+ `column_count` int NOT NULL DEFAULT 10,
+ CONSTRAINT `board_id` PRIMARY KEY(`id`),
+ CONSTRAINT `board_name_unique` UNIQUE(`name`)
+);
+--> statement-breakpoint
+CREATE TABLE `groupMember` (
+ `groupId` varchar(64) NOT NULL,
+ `userId` varchar(64) NOT NULL,
+ CONSTRAINT `groupMember_groupId_userId_pk` PRIMARY KEY(`groupId`,`userId`)
+);
+--> statement-breakpoint
+CREATE TABLE `groupPermission` (
+ `groupId` varchar(64) NOT NULL,
+ `permission` text NOT NULL
+);
+--> statement-breakpoint
+CREATE TABLE `group` (
+ `id` varchar(64) NOT NULL,
+ `name` varchar(64) NOT NULL,
+ `owner_id` varchar(64),
+ CONSTRAINT `group_id` PRIMARY KEY(`id`)
+);
+--> statement-breakpoint
+CREATE TABLE `iconRepository` (
+ `iconRepository_id` varchar(64) NOT NULL,
+ `iconRepository_slug` varchar(150) NOT NULL,
+ CONSTRAINT `iconRepository_iconRepository_id` PRIMARY KEY(`iconRepository_id`)
+);
+--> statement-breakpoint
+CREATE TABLE `icon` (
+ `icon_id` varchar(64) NOT NULL,
+ `icon_name` varchar(250) NOT NULL,
+ `icon_url` text NOT NULL,
+ `icon_checksum` text NOT NULL,
+ `iconRepository_id` varchar(64) NOT NULL,
+ CONSTRAINT `icon_icon_id` PRIMARY KEY(`icon_id`)
+);
+--> statement-breakpoint
+CREATE TABLE `integration_item` (
+ `item_id` varchar(64) NOT NULL,
+ `integration_id` varchar(64) NOT NULL,
+ CONSTRAINT `integration_item_item_id_integration_id_pk` PRIMARY KEY(`item_id`,`integration_id`)
+);
+--> statement-breakpoint
+CREATE TABLE `integrationSecret` (
+ `kind` varchar(16) NOT NULL,
+ `value` text NOT NULL,
+ `updated_at` timestamp NOT NULL,
+ `integration_id` varchar(64) NOT NULL,
+ CONSTRAINT `integrationSecret_integration_id_kind_pk` PRIMARY KEY(`integration_id`,`kind`)
+);
+--> statement-breakpoint
+CREATE TABLE `integration` (
+ `id` varchar(64) NOT NULL,
+ `name` text NOT NULL,
+ `url` text NOT NULL,
+ `kind` varchar(128) NOT NULL,
+ CONSTRAINT `integration_id` PRIMARY KEY(`id`)
+);
+--> statement-breakpoint
+CREATE TABLE `invite` (
+ `id` varchar(64) NOT NULL,
+ `token` varchar(512) NOT NULL,
+ `expiration_date` timestamp NOT NULL,
+ `creator_id` varchar(64) NOT NULL,
+ CONSTRAINT `invite_id` PRIMARY KEY(`id`),
+ CONSTRAINT `invite_token_unique` UNIQUE(`token`)
+);
+--> statement-breakpoint
+CREATE TABLE `item` (
+ `id` varchar(64) NOT NULL,
+ `section_id` varchar(64) NOT NULL,
+ `kind` text NOT NULL,
+ `x_offset` int NOT NULL,
+ `y_offset` int NOT NULL,
+ `width` int NOT NULL,
+ `height` int NOT NULL,
+ `options` text NOT NULL DEFAULT ('{"json": {}}'),
+ CONSTRAINT `item_id` PRIMARY KEY(`id`)
+);
+--> statement-breakpoint
+CREATE TABLE `section` (
+ `id` varchar(64) NOT NULL,
+ `board_id` varchar(64) NOT NULL,
+ `kind` text NOT NULL,
+ `position` int NOT NULL,
+ `name` text,
+ CONSTRAINT `section_id` PRIMARY KEY(`id`)
+);
+--> statement-breakpoint
+CREATE TABLE `session` (
+ `sessionToken` varchar(512) NOT NULL,
+ `userId` varchar(64) NOT NULL,
+ `expires` timestamp NOT NULL,
+ CONSTRAINT `session_sessionToken` PRIMARY KEY(`sessionToken`)
+);
+--> statement-breakpoint
+CREATE TABLE `user` (
+ `id` varchar(64) NOT NULL,
+ `name` text,
+ `email` text,
+ `emailVerified` timestamp,
+ `image` text,
+ `password` text,
+ `salt` text,
+ CONSTRAINT `user_id` PRIMARY KEY(`id`)
+);
+--> statement-breakpoint
+CREATE TABLE `verificationToken` (
+ `identifier` varchar(64) NOT NULL,
+ `token` varchar(512) NOT NULL,
+ `expires` timestamp NOT NULL,
+ CONSTRAINT `verificationToken_identifier_token_pk` PRIMARY KEY(`identifier`,`token`)
+);
+--> statement-breakpoint
+ALTER TABLE `account` ADD CONSTRAINT `account_userId_user_id_fk` FOREIGN KEY (`userId`) REFERENCES `user`(`id`) ON DELETE cascade ON UPDATE no action;--> statement-breakpoint
+ALTER TABLE `boardGroupPermission` ADD CONSTRAINT `boardGroupPermission_board_id_board_id_fk` FOREIGN KEY (`board_id`) REFERENCES `board`(`id`) ON DELETE cascade ON UPDATE no action;--> statement-breakpoint
+ALTER TABLE `boardGroupPermission` ADD CONSTRAINT `boardGroupPermission_group_id_group_id_fk` FOREIGN KEY (`group_id`) REFERENCES `group`(`id`) ON DELETE cascade ON UPDATE no action;--> statement-breakpoint
+ALTER TABLE `boardUserPermission` ADD CONSTRAINT `boardUserPermission_board_id_board_id_fk` FOREIGN KEY (`board_id`) REFERENCES `board`(`id`) ON DELETE cascade ON UPDATE no action;--> statement-breakpoint
+ALTER TABLE `boardUserPermission` ADD CONSTRAINT `boardUserPermission_user_id_user_id_fk` FOREIGN KEY (`user_id`) REFERENCES `user`(`id`) ON DELETE cascade ON UPDATE no action;--> statement-breakpoint
+ALTER TABLE `board` ADD CONSTRAINT `board_creator_id_user_id_fk` FOREIGN KEY (`creator_id`) REFERENCES `user`(`id`) ON DELETE set null ON UPDATE no action;--> statement-breakpoint
+ALTER TABLE `groupMember` ADD CONSTRAINT `groupMember_groupId_group_id_fk` FOREIGN KEY (`groupId`) REFERENCES `group`(`id`) ON DELETE cascade ON UPDATE no action;--> statement-breakpoint
+ALTER TABLE `groupMember` ADD CONSTRAINT `groupMember_userId_user_id_fk` FOREIGN KEY (`userId`) REFERENCES `user`(`id`) ON DELETE cascade ON UPDATE no action;--> statement-breakpoint
+ALTER TABLE `groupPermission` ADD CONSTRAINT `groupPermission_groupId_group_id_fk` FOREIGN KEY (`groupId`) REFERENCES `group`(`id`) ON DELETE cascade ON UPDATE no action;--> statement-breakpoint
+ALTER TABLE `group` ADD CONSTRAINT `group_owner_id_user_id_fk` FOREIGN KEY (`owner_id`) REFERENCES `user`(`id`) ON DELETE set null ON UPDATE no action;--> statement-breakpoint
+ALTER TABLE `icon` ADD CONSTRAINT `icon_iconRepository_id_iconRepository_iconRepository_id_fk` FOREIGN KEY (`iconRepository_id`) REFERENCES `iconRepository`(`iconRepository_id`) ON DELETE cascade ON UPDATE no action;--> statement-breakpoint
+ALTER TABLE `integration_item` ADD CONSTRAINT `integration_item_item_id_item_id_fk` FOREIGN KEY (`item_id`) REFERENCES `item`(`id`) ON DELETE cascade ON UPDATE no action;--> statement-breakpoint
+ALTER TABLE `integration_item` ADD CONSTRAINT `integration_item_integration_id_integration_id_fk` FOREIGN KEY (`integration_id`) REFERENCES `integration`(`id`) ON DELETE cascade ON UPDATE no action;--> statement-breakpoint
+ALTER TABLE `integrationSecret` ADD CONSTRAINT `integrationSecret_integration_id_integration_id_fk` FOREIGN KEY (`integration_id`) REFERENCES `integration`(`id`) ON DELETE cascade ON UPDATE no action;--> statement-breakpoint
+ALTER TABLE `invite` ADD CONSTRAINT `invite_creator_id_user_id_fk` FOREIGN KEY (`creator_id`) REFERENCES `user`(`id`) ON DELETE cascade ON UPDATE no action;--> statement-breakpoint
+ALTER TABLE `item` ADD CONSTRAINT `item_section_id_section_id_fk` FOREIGN KEY (`section_id`) REFERENCES `section`(`id`) ON DELETE cascade ON UPDATE no action;--> statement-breakpoint
+ALTER TABLE `section` ADD CONSTRAINT `section_board_id_board_id_fk` FOREIGN KEY (`board_id`) REFERENCES `board`(`id`) ON DELETE cascade ON UPDATE no action;--> statement-breakpoint
+ALTER TABLE `session` ADD CONSTRAINT `session_userId_user_id_fk` FOREIGN KEY (`userId`) REFERENCES `user`(`id`) ON DELETE cascade ON UPDATE no action;--> statement-breakpoint
+CREATE INDEX `userId_idx` ON `account` (`userId`);--> statement-breakpoint
+CREATE INDEX `integration_secret__kind_idx` ON `integrationSecret` (`kind`);--> statement-breakpoint
+CREATE INDEX `integration_secret__updated_at_idx` ON `integrationSecret` (`updated_at`);--> statement-breakpoint
+CREATE INDEX `integration__kind_idx` ON `integration` (`kind`);--> statement-breakpoint
+CREATE INDEX `user_id_idx` ON `session` (`userId`);
\ No newline at end of file
diff --git a/packages/db/migrations/mysql/0001_wild_alex_wilder.sql b/packages/db/migrations/mysql/0001_wild_alex_wilder.sql
new file mode 100644
index 000000000..9c3c23f31
--- /dev/null
+++ b/packages/db/migrations/mysql/0001_wild_alex_wilder.sql
@@ -0,0 +1,2 @@
+ALTER TABLE `user` ADD `homeBoardId` varchar(64);--> statement-breakpoint
+ALTER TABLE `user` ADD CONSTRAINT `user_homeBoardId_board_id_fk` FOREIGN KEY (`homeBoardId`) REFERENCES `board`(`id`) ON DELETE set null ON UPDATE no action;
\ No newline at end of file
diff --git a/packages/db/migrations/mysql/0002_flimsy_deathbird.sql b/packages/db/migrations/mysql/0002_flimsy_deathbird.sql
new file mode 100644
index 000000000..57e15e767
--- /dev/null
+++ b/packages/db/migrations/mysql/0002_flimsy_deathbird.sql
@@ -0,0 +1 @@
+ALTER TABLE `item` ADD `advanced_options` text DEFAULT ('{"json": {}}') NOT NULL;
\ No newline at end of file
diff --git a/packages/db/migrations/mysql/0003_freezing_black_panther.sql b/packages/db/migrations/mysql/0003_freezing_black_panther.sql
new file mode 100644
index 000000000..b360ae7a0
--- /dev/null
+++ b/packages/db/migrations/mysql/0003_freezing_black_panther.sql
@@ -0,0 +1,6 @@
+CREATE TABLE `serverSetting` (
+ `key` varchar(64) NOT NULL,
+ `value` text NOT NULL DEFAULT ('{"json": {}}'),
+ CONSTRAINT `serverSetting_key` PRIMARY KEY(`key`),
+ CONSTRAINT `serverSetting_key_unique` UNIQUE(`key`)
+);
diff --git a/packages/db/migrations/mysql/meta/0000_snapshot.json b/packages/db/migrations/mysql/meta/0000_snapshot.json
new file mode 100644
index 000000000..fc8577328
--- /dev/null
+++ b/packages/db/migrations/mysql/meta/0000_snapshot.json
@@ -0,0 +1,1149 @@
+{
+ "version": "5",
+ "dialect": "mysql",
+ "id": "fdeaf6eb-cd62-4fa5-9b38-d7f80a60db9f",
+ "prevId": "00000000-0000-0000-0000-000000000000",
+ "tables": {
+ "account": {
+ "name": "account",
+ "columns": {
+ "userId": {
+ "name": "userId",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "type": {
+ "name": "type",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "provider": {
+ "name": "provider",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "providerAccountId": {
+ "name": "providerAccountId",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "refresh_token": {
+ "name": "refresh_token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "access_token": {
+ "name": "access_token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "expires_at": {
+ "name": "expires_at",
+ "type": "int",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "token_type": {
+ "name": "token_type",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "scope": {
+ "name": "scope",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "id_token": {
+ "name": "id_token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "session_state": {
+ "name": "session_state",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "userId_idx": {
+ "name": "userId_idx",
+ "columns": ["userId"],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "account_userId_user_id_fk": {
+ "name": "account_userId_user_id_fk",
+ "tableFrom": "account",
+ "tableTo": "user",
+ "columnsFrom": ["userId"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "account_provider_providerAccountId_pk": {
+ "name": "account_provider_providerAccountId_pk",
+ "columns": ["provider", "providerAccountId"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "app": {
+ "name": "app",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "description": {
+ "name": "description",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "icon_url": {
+ "name": "icon_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "href": {
+ "name": "href",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {},
+ "compositePrimaryKeys": {
+ "app_id": {
+ "name": "app_id",
+ "columns": ["id"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "boardGroupPermission": {
+ "name": "boardGroupPermission",
+ "columns": {
+ "board_id": {
+ "name": "board_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "group_id": {
+ "name": "group_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "permission": {
+ "name": "permission",
+ "type": "varchar(128)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "boardGroupPermission_board_id_board_id_fk": {
+ "name": "boardGroupPermission_board_id_board_id_fk",
+ "tableFrom": "boardGroupPermission",
+ "tableTo": "board",
+ "columnsFrom": ["board_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "boardGroupPermission_group_id_group_id_fk": {
+ "name": "boardGroupPermission_group_id_group_id_fk",
+ "tableFrom": "boardGroupPermission",
+ "tableTo": "group",
+ "columnsFrom": ["group_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "boardGroupPermission_board_id_group_id_permission_pk": {
+ "name": "boardGroupPermission_board_id_group_id_permission_pk",
+ "columns": ["board_id", "group_id", "permission"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "boardUserPermission": {
+ "name": "boardUserPermission",
+ "columns": {
+ "board_id": {
+ "name": "board_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "user_id": {
+ "name": "user_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "permission": {
+ "name": "permission",
+ "type": "varchar(128)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "boardUserPermission_board_id_board_id_fk": {
+ "name": "boardUserPermission_board_id_board_id_fk",
+ "tableFrom": "boardUserPermission",
+ "tableTo": "board",
+ "columnsFrom": ["board_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "boardUserPermission_user_id_user_id_fk": {
+ "name": "boardUserPermission_user_id_user_id_fk",
+ "tableFrom": "boardUserPermission",
+ "tableTo": "user",
+ "columnsFrom": ["user_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "boardUserPermission_board_id_user_id_permission_pk": {
+ "name": "boardUserPermission_board_id_user_id_permission_pk",
+ "columns": ["board_id", "user_id", "permission"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "board": {
+ "name": "board",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "varchar(256)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "is_public": {
+ "name": "is_public",
+ "type": "boolean",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": false
+ },
+ "creator_id": {
+ "name": "creator_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "page_title": {
+ "name": "page_title",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "meta_title": {
+ "name": "meta_title",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "logo_image_url": {
+ "name": "logo_image_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "favicon_image_url": {
+ "name": "favicon_image_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "background_image_url": {
+ "name": "background_image_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "background_image_attachment": {
+ "name": "background_image_attachment",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "('fixed')"
+ },
+ "background_image_repeat": {
+ "name": "background_image_repeat",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "('no-repeat')"
+ },
+ "background_image_size": {
+ "name": "background_image_size",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "('cover')"
+ },
+ "primary_color": {
+ "name": "primary_color",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "('#fa5252')"
+ },
+ "secondary_color": {
+ "name": "secondary_color",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "('#fd7e14')"
+ },
+ "opacity": {
+ "name": "opacity",
+ "type": "int",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": 100
+ },
+ "custom_css": {
+ "name": "custom_css",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "column_count": {
+ "name": "column_count",
+ "type": "int",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": 10
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "board_creator_id_user_id_fk": {
+ "name": "board_creator_id_user_id_fk",
+ "tableFrom": "board",
+ "tableTo": "user",
+ "columnsFrom": ["creator_id"],
+ "columnsTo": ["id"],
+ "onDelete": "set null",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "board_id": {
+ "name": "board_id",
+ "columns": ["id"]
+ }
+ },
+ "uniqueConstraints": {
+ "board_name_unique": {
+ "name": "board_name_unique",
+ "columns": ["name"]
+ }
+ }
+ },
+ "groupMember": {
+ "name": "groupMember",
+ "columns": {
+ "groupId": {
+ "name": "groupId",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "userId": {
+ "name": "userId",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "groupMember_groupId_group_id_fk": {
+ "name": "groupMember_groupId_group_id_fk",
+ "tableFrom": "groupMember",
+ "tableTo": "group",
+ "columnsFrom": ["groupId"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "groupMember_userId_user_id_fk": {
+ "name": "groupMember_userId_user_id_fk",
+ "tableFrom": "groupMember",
+ "tableTo": "user",
+ "columnsFrom": ["userId"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "groupMember_groupId_userId_pk": {
+ "name": "groupMember_groupId_userId_pk",
+ "columns": ["groupId", "userId"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "groupPermission": {
+ "name": "groupPermission",
+ "columns": {
+ "groupId": {
+ "name": "groupId",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "permission": {
+ "name": "permission",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "groupPermission_groupId_group_id_fk": {
+ "name": "groupPermission_groupId_group_id_fk",
+ "tableFrom": "groupPermission",
+ "tableTo": "group",
+ "columnsFrom": ["groupId"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "group": {
+ "name": "group",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "owner_id": {
+ "name": "owner_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "group_owner_id_user_id_fk": {
+ "name": "group_owner_id_user_id_fk",
+ "tableFrom": "group",
+ "tableTo": "user",
+ "columnsFrom": ["owner_id"],
+ "columnsTo": ["id"],
+ "onDelete": "set null",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "group_id": {
+ "name": "group_id",
+ "columns": ["id"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "iconRepository": {
+ "name": "iconRepository",
+ "columns": {
+ "iconRepository_id": {
+ "name": "iconRepository_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "iconRepository_slug": {
+ "name": "iconRepository_slug",
+ "type": "varchar(150)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {},
+ "compositePrimaryKeys": {
+ "iconRepository_iconRepository_id": {
+ "name": "iconRepository_iconRepository_id",
+ "columns": ["iconRepository_id"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "icon": {
+ "name": "icon",
+ "columns": {
+ "icon_id": {
+ "name": "icon_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "icon_name": {
+ "name": "icon_name",
+ "type": "varchar(250)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "icon_url": {
+ "name": "icon_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "icon_checksum": {
+ "name": "icon_checksum",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "iconRepository_id": {
+ "name": "iconRepository_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "icon_iconRepository_id_iconRepository_iconRepository_id_fk": {
+ "name": "icon_iconRepository_id_iconRepository_iconRepository_id_fk",
+ "tableFrom": "icon",
+ "tableTo": "iconRepository",
+ "columnsFrom": ["iconRepository_id"],
+ "columnsTo": ["iconRepository_id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "icon_icon_id": {
+ "name": "icon_icon_id",
+ "columns": ["icon_id"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "integration_item": {
+ "name": "integration_item",
+ "columns": {
+ "item_id": {
+ "name": "item_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "integration_id": {
+ "name": "integration_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "integration_item_item_id_item_id_fk": {
+ "name": "integration_item_item_id_item_id_fk",
+ "tableFrom": "integration_item",
+ "tableTo": "item",
+ "columnsFrom": ["item_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "integration_item_integration_id_integration_id_fk": {
+ "name": "integration_item_integration_id_integration_id_fk",
+ "tableFrom": "integration_item",
+ "tableTo": "integration",
+ "columnsFrom": ["integration_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "integration_item_item_id_integration_id_pk": {
+ "name": "integration_item_item_id_integration_id_pk",
+ "columns": ["item_id", "integration_id"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "integrationSecret": {
+ "name": "integrationSecret",
+ "columns": {
+ "kind": {
+ "name": "kind",
+ "type": "varchar(16)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "value": {
+ "name": "value",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "updated_at": {
+ "name": "updated_at",
+ "type": "timestamp",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "integration_id": {
+ "name": "integration_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "integration_secret__kind_idx": {
+ "name": "integration_secret__kind_idx",
+ "columns": ["kind"],
+ "isUnique": false
+ },
+ "integration_secret__updated_at_idx": {
+ "name": "integration_secret__updated_at_idx",
+ "columns": ["updated_at"],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "integrationSecret_integration_id_integration_id_fk": {
+ "name": "integrationSecret_integration_id_integration_id_fk",
+ "tableFrom": "integrationSecret",
+ "tableTo": "integration",
+ "columnsFrom": ["integration_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "integrationSecret_integration_id_kind_pk": {
+ "name": "integrationSecret_integration_id_kind_pk",
+ "columns": ["integration_id", "kind"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "integration": {
+ "name": "integration",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "url": {
+ "name": "url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "kind": {
+ "name": "kind",
+ "type": "varchar(128)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "integration__kind_idx": {
+ "name": "integration__kind_idx",
+ "columns": ["kind"],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {},
+ "compositePrimaryKeys": {
+ "integration_id": {
+ "name": "integration_id",
+ "columns": ["id"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "invite": {
+ "name": "invite",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "token": {
+ "name": "token",
+ "type": "varchar(512)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "expiration_date": {
+ "name": "expiration_date",
+ "type": "timestamp",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "creator_id": {
+ "name": "creator_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "invite_creator_id_user_id_fk": {
+ "name": "invite_creator_id_user_id_fk",
+ "tableFrom": "invite",
+ "tableTo": "user",
+ "columnsFrom": ["creator_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "invite_id": {
+ "name": "invite_id",
+ "columns": ["id"]
+ }
+ },
+ "uniqueConstraints": {
+ "invite_token_unique": {
+ "name": "invite_token_unique",
+ "columns": ["token"]
+ }
+ }
+ },
+ "item": {
+ "name": "item",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "section_id": {
+ "name": "section_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "kind": {
+ "name": "kind",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "x_offset": {
+ "name": "x_offset",
+ "type": "int",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "y_offset": {
+ "name": "y_offset",
+ "type": "int",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "width": {
+ "name": "width",
+ "type": "int",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "height": {
+ "name": "height",
+ "type": "int",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "options": {
+ "name": "options",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "('{\"json\": {}}')"
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "item_section_id_section_id_fk": {
+ "name": "item_section_id_section_id_fk",
+ "tableFrom": "item",
+ "tableTo": "section",
+ "columnsFrom": ["section_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "item_id": {
+ "name": "item_id",
+ "columns": ["id"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "section": {
+ "name": "section",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "board_id": {
+ "name": "board_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "kind": {
+ "name": "kind",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "position": {
+ "name": "position",
+ "type": "int",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "section_board_id_board_id_fk": {
+ "name": "section_board_id_board_id_fk",
+ "tableFrom": "section",
+ "tableTo": "board",
+ "columnsFrom": ["board_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "section_id": {
+ "name": "section_id",
+ "columns": ["id"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "session": {
+ "name": "session",
+ "columns": {
+ "sessionToken": {
+ "name": "sessionToken",
+ "type": "varchar(512)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "userId": {
+ "name": "userId",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "expires": {
+ "name": "expires",
+ "type": "timestamp",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "user_id_idx": {
+ "name": "user_id_idx",
+ "columns": ["userId"],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "session_userId_user_id_fk": {
+ "name": "session_userId_user_id_fk",
+ "tableFrom": "session",
+ "tableTo": "user",
+ "columnsFrom": ["userId"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "session_sessionToken": {
+ "name": "session_sessionToken",
+ "columns": ["sessionToken"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "user": {
+ "name": "user",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "email": {
+ "name": "email",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "emailVerified": {
+ "name": "emailVerified",
+ "type": "timestamp",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "image": {
+ "name": "image",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "password": {
+ "name": "password",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "salt": {
+ "name": "salt",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {},
+ "compositePrimaryKeys": {
+ "user_id": {
+ "name": "user_id",
+ "columns": ["id"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "verificationToken": {
+ "name": "verificationToken",
+ "columns": {
+ "identifier": {
+ "name": "identifier",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "token": {
+ "name": "token",
+ "type": "varchar(512)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "expires": {
+ "name": "expires",
+ "type": "timestamp",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {},
+ "compositePrimaryKeys": {
+ "verificationToken_identifier_token_pk": {
+ "name": "verificationToken_identifier_token_pk",
+ "columns": ["identifier", "token"]
+ }
+ },
+ "uniqueConstraints": {}
+ }
+ },
+ "_meta": {
+ "schemas": {},
+ "tables": {},
+ "columns": {}
+ }
+}
diff --git a/packages/db/migrations/mysql/meta/0001_snapshot.json b/packages/db/migrations/mysql/meta/0001_snapshot.json
new file mode 100644
index 000000000..1ba3799f4
--- /dev/null
+++ b/packages/db/migrations/mysql/meta/0001_snapshot.json
@@ -0,0 +1,1166 @@
+{
+ "version": "5",
+ "dialect": "mysql",
+ "id": "ba2dd885-4e7f-4a45-99a0-7b45cbd0a5c2",
+ "prevId": "fdeaf6eb-cd62-4fa5-9b38-d7f80a60db9f",
+ "tables": {
+ "account": {
+ "name": "account",
+ "columns": {
+ "userId": {
+ "name": "userId",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "type": {
+ "name": "type",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "provider": {
+ "name": "provider",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "providerAccountId": {
+ "name": "providerAccountId",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "refresh_token": {
+ "name": "refresh_token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "access_token": {
+ "name": "access_token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "expires_at": {
+ "name": "expires_at",
+ "type": "int",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "token_type": {
+ "name": "token_type",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "scope": {
+ "name": "scope",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "id_token": {
+ "name": "id_token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "session_state": {
+ "name": "session_state",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "userId_idx": {
+ "name": "userId_idx",
+ "columns": ["userId"],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "account_userId_user_id_fk": {
+ "name": "account_userId_user_id_fk",
+ "tableFrom": "account",
+ "tableTo": "user",
+ "columnsFrom": ["userId"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "account_provider_providerAccountId_pk": {
+ "name": "account_provider_providerAccountId_pk",
+ "columns": ["provider", "providerAccountId"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "app": {
+ "name": "app",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "description": {
+ "name": "description",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "icon_url": {
+ "name": "icon_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "href": {
+ "name": "href",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {},
+ "compositePrimaryKeys": {
+ "app_id": {
+ "name": "app_id",
+ "columns": ["id"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "boardGroupPermission": {
+ "name": "boardGroupPermission",
+ "columns": {
+ "board_id": {
+ "name": "board_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "group_id": {
+ "name": "group_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "permission": {
+ "name": "permission",
+ "type": "varchar(128)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "boardGroupPermission_board_id_board_id_fk": {
+ "name": "boardGroupPermission_board_id_board_id_fk",
+ "tableFrom": "boardGroupPermission",
+ "tableTo": "board",
+ "columnsFrom": ["board_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "boardGroupPermission_group_id_group_id_fk": {
+ "name": "boardGroupPermission_group_id_group_id_fk",
+ "tableFrom": "boardGroupPermission",
+ "tableTo": "group",
+ "columnsFrom": ["group_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "boardGroupPermission_board_id_group_id_permission_pk": {
+ "name": "boardGroupPermission_board_id_group_id_permission_pk",
+ "columns": ["board_id", "group_id", "permission"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "boardUserPermission": {
+ "name": "boardUserPermission",
+ "columns": {
+ "board_id": {
+ "name": "board_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "user_id": {
+ "name": "user_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "permission": {
+ "name": "permission",
+ "type": "varchar(128)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "boardUserPermission_board_id_board_id_fk": {
+ "name": "boardUserPermission_board_id_board_id_fk",
+ "tableFrom": "boardUserPermission",
+ "tableTo": "board",
+ "columnsFrom": ["board_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "boardUserPermission_user_id_user_id_fk": {
+ "name": "boardUserPermission_user_id_user_id_fk",
+ "tableFrom": "boardUserPermission",
+ "tableTo": "user",
+ "columnsFrom": ["user_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "boardUserPermission_board_id_user_id_permission_pk": {
+ "name": "boardUserPermission_board_id_user_id_permission_pk",
+ "columns": ["board_id", "user_id", "permission"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "board": {
+ "name": "board",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "varchar(256)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "is_public": {
+ "name": "is_public",
+ "type": "boolean",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": false
+ },
+ "creator_id": {
+ "name": "creator_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "page_title": {
+ "name": "page_title",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "meta_title": {
+ "name": "meta_title",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "logo_image_url": {
+ "name": "logo_image_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "favicon_image_url": {
+ "name": "favicon_image_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "background_image_url": {
+ "name": "background_image_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "background_image_attachment": {
+ "name": "background_image_attachment",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "('fixed')"
+ },
+ "background_image_repeat": {
+ "name": "background_image_repeat",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "('no-repeat')"
+ },
+ "background_image_size": {
+ "name": "background_image_size",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "('cover')"
+ },
+ "primary_color": {
+ "name": "primary_color",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "('#fa5252')"
+ },
+ "secondary_color": {
+ "name": "secondary_color",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "('#fd7e14')"
+ },
+ "opacity": {
+ "name": "opacity",
+ "type": "int",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": 100
+ },
+ "custom_css": {
+ "name": "custom_css",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "column_count": {
+ "name": "column_count",
+ "type": "int",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": 10
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "board_creator_id_user_id_fk": {
+ "name": "board_creator_id_user_id_fk",
+ "tableFrom": "board",
+ "tableTo": "user",
+ "columnsFrom": ["creator_id"],
+ "columnsTo": ["id"],
+ "onDelete": "set null",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "board_id": {
+ "name": "board_id",
+ "columns": ["id"]
+ }
+ },
+ "uniqueConstraints": {
+ "board_name_unique": {
+ "name": "board_name_unique",
+ "columns": ["name"]
+ }
+ }
+ },
+ "groupMember": {
+ "name": "groupMember",
+ "columns": {
+ "groupId": {
+ "name": "groupId",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "userId": {
+ "name": "userId",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "groupMember_groupId_group_id_fk": {
+ "name": "groupMember_groupId_group_id_fk",
+ "tableFrom": "groupMember",
+ "tableTo": "group",
+ "columnsFrom": ["groupId"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "groupMember_userId_user_id_fk": {
+ "name": "groupMember_userId_user_id_fk",
+ "tableFrom": "groupMember",
+ "tableTo": "user",
+ "columnsFrom": ["userId"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "groupMember_groupId_userId_pk": {
+ "name": "groupMember_groupId_userId_pk",
+ "columns": ["groupId", "userId"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "groupPermission": {
+ "name": "groupPermission",
+ "columns": {
+ "groupId": {
+ "name": "groupId",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "permission": {
+ "name": "permission",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "groupPermission_groupId_group_id_fk": {
+ "name": "groupPermission_groupId_group_id_fk",
+ "tableFrom": "groupPermission",
+ "tableTo": "group",
+ "columnsFrom": ["groupId"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "group": {
+ "name": "group",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "owner_id": {
+ "name": "owner_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "group_owner_id_user_id_fk": {
+ "name": "group_owner_id_user_id_fk",
+ "tableFrom": "group",
+ "tableTo": "user",
+ "columnsFrom": ["owner_id"],
+ "columnsTo": ["id"],
+ "onDelete": "set null",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "group_id": {
+ "name": "group_id",
+ "columns": ["id"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "iconRepository": {
+ "name": "iconRepository",
+ "columns": {
+ "iconRepository_id": {
+ "name": "iconRepository_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "iconRepository_slug": {
+ "name": "iconRepository_slug",
+ "type": "varchar(150)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {},
+ "compositePrimaryKeys": {
+ "iconRepository_iconRepository_id": {
+ "name": "iconRepository_iconRepository_id",
+ "columns": ["iconRepository_id"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "icon": {
+ "name": "icon",
+ "columns": {
+ "icon_id": {
+ "name": "icon_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "icon_name": {
+ "name": "icon_name",
+ "type": "varchar(250)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "icon_url": {
+ "name": "icon_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "icon_checksum": {
+ "name": "icon_checksum",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "iconRepository_id": {
+ "name": "iconRepository_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "icon_iconRepository_id_iconRepository_iconRepository_id_fk": {
+ "name": "icon_iconRepository_id_iconRepository_iconRepository_id_fk",
+ "tableFrom": "icon",
+ "tableTo": "iconRepository",
+ "columnsFrom": ["iconRepository_id"],
+ "columnsTo": ["iconRepository_id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "icon_icon_id": {
+ "name": "icon_icon_id",
+ "columns": ["icon_id"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "integration_item": {
+ "name": "integration_item",
+ "columns": {
+ "item_id": {
+ "name": "item_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "integration_id": {
+ "name": "integration_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "integration_item_item_id_item_id_fk": {
+ "name": "integration_item_item_id_item_id_fk",
+ "tableFrom": "integration_item",
+ "tableTo": "item",
+ "columnsFrom": ["item_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "integration_item_integration_id_integration_id_fk": {
+ "name": "integration_item_integration_id_integration_id_fk",
+ "tableFrom": "integration_item",
+ "tableTo": "integration",
+ "columnsFrom": ["integration_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "integration_item_item_id_integration_id_pk": {
+ "name": "integration_item_item_id_integration_id_pk",
+ "columns": ["item_id", "integration_id"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "integrationSecret": {
+ "name": "integrationSecret",
+ "columns": {
+ "kind": {
+ "name": "kind",
+ "type": "varchar(16)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "value": {
+ "name": "value",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "updated_at": {
+ "name": "updated_at",
+ "type": "timestamp",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "integration_id": {
+ "name": "integration_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "integration_secret__kind_idx": {
+ "name": "integration_secret__kind_idx",
+ "columns": ["kind"],
+ "isUnique": false
+ },
+ "integration_secret__updated_at_idx": {
+ "name": "integration_secret__updated_at_idx",
+ "columns": ["updated_at"],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "integrationSecret_integration_id_integration_id_fk": {
+ "name": "integrationSecret_integration_id_integration_id_fk",
+ "tableFrom": "integrationSecret",
+ "tableTo": "integration",
+ "columnsFrom": ["integration_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "integrationSecret_integration_id_kind_pk": {
+ "name": "integrationSecret_integration_id_kind_pk",
+ "columns": ["integration_id", "kind"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "integration": {
+ "name": "integration",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "url": {
+ "name": "url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "kind": {
+ "name": "kind",
+ "type": "varchar(128)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "integration__kind_idx": {
+ "name": "integration__kind_idx",
+ "columns": ["kind"],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {},
+ "compositePrimaryKeys": {
+ "integration_id": {
+ "name": "integration_id",
+ "columns": ["id"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "invite": {
+ "name": "invite",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "token": {
+ "name": "token",
+ "type": "varchar(512)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "expiration_date": {
+ "name": "expiration_date",
+ "type": "timestamp",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "creator_id": {
+ "name": "creator_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "invite_creator_id_user_id_fk": {
+ "name": "invite_creator_id_user_id_fk",
+ "tableFrom": "invite",
+ "tableTo": "user",
+ "columnsFrom": ["creator_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "invite_id": {
+ "name": "invite_id",
+ "columns": ["id"]
+ }
+ },
+ "uniqueConstraints": {
+ "invite_token_unique": {
+ "name": "invite_token_unique",
+ "columns": ["token"]
+ }
+ }
+ },
+ "item": {
+ "name": "item",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "section_id": {
+ "name": "section_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "kind": {
+ "name": "kind",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "x_offset": {
+ "name": "x_offset",
+ "type": "int",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "y_offset": {
+ "name": "y_offset",
+ "type": "int",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "width": {
+ "name": "width",
+ "type": "int",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "height": {
+ "name": "height",
+ "type": "int",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "options": {
+ "name": "options",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "('{\"json\": {}}')"
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "item_section_id_section_id_fk": {
+ "name": "item_section_id_section_id_fk",
+ "tableFrom": "item",
+ "tableTo": "section",
+ "columnsFrom": ["section_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "item_id": {
+ "name": "item_id",
+ "columns": ["id"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "section": {
+ "name": "section",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "board_id": {
+ "name": "board_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "kind": {
+ "name": "kind",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "position": {
+ "name": "position",
+ "type": "int",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "section_board_id_board_id_fk": {
+ "name": "section_board_id_board_id_fk",
+ "tableFrom": "section",
+ "tableTo": "board",
+ "columnsFrom": ["board_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "section_id": {
+ "name": "section_id",
+ "columns": ["id"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "session": {
+ "name": "session",
+ "columns": {
+ "sessionToken": {
+ "name": "sessionToken",
+ "type": "varchar(512)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "userId": {
+ "name": "userId",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "expires": {
+ "name": "expires",
+ "type": "timestamp",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "user_id_idx": {
+ "name": "user_id_idx",
+ "columns": ["userId"],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "session_userId_user_id_fk": {
+ "name": "session_userId_user_id_fk",
+ "tableFrom": "session",
+ "tableTo": "user",
+ "columnsFrom": ["userId"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "session_sessionToken": {
+ "name": "session_sessionToken",
+ "columns": ["sessionToken"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "user": {
+ "name": "user",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "email": {
+ "name": "email",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "emailVerified": {
+ "name": "emailVerified",
+ "type": "timestamp",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "image": {
+ "name": "image",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "password": {
+ "name": "password",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "salt": {
+ "name": "salt",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "homeBoardId": {
+ "name": "homeBoardId",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "user_homeBoardId_board_id_fk": {
+ "name": "user_homeBoardId_board_id_fk",
+ "tableFrom": "user",
+ "tableTo": "board",
+ "columnsFrom": ["homeBoardId"],
+ "columnsTo": ["id"],
+ "onDelete": "set null",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "user_id": {
+ "name": "user_id",
+ "columns": ["id"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "verificationToken": {
+ "name": "verificationToken",
+ "columns": {
+ "identifier": {
+ "name": "identifier",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "token": {
+ "name": "token",
+ "type": "varchar(512)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "expires": {
+ "name": "expires",
+ "type": "timestamp",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {},
+ "compositePrimaryKeys": {
+ "verificationToken_identifier_token_pk": {
+ "name": "verificationToken_identifier_token_pk",
+ "columns": ["identifier", "token"]
+ }
+ },
+ "uniqueConstraints": {}
+ }
+ },
+ "_meta": {
+ "schemas": {},
+ "tables": {},
+ "columns": {}
+ }
+}
diff --git a/packages/db/migrations/mysql/meta/0002_snapshot.json b/packages/db/migrations/mysql/meta/0002_snapshot.json
new file mode 100644
index 000000000..f098f20c9
--- /dev/null
+++ b/packages/db/migrations/mysql/meta/0002_snapshot.json
@@ -0,0 +1,1174 @@
+{
+ "version": "5",
+ "dialect": "mysql",
+ "id": "4e382d0d-a432-4953-bd5e-04f3f33e26a4",
+ "prevId": "fdeaf6eb-cd62-4fa5-9b38-d7f80a60db9f",
+ "tables": {
+ "account": {
+ "name": "account",
+ "columns": {
+ "userId": {
+ "name": "userId",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "type": {
+ "name": "type",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "provider": {
+ "name": "provider",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "providerAccountId": {
+ "name": "providerAccountId",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "refresh_token": {
+ "name": "refresh_token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "access_token": {
+ "name": "access_token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "expires_at": {
+ "name": "expires_at",
+ "type": "int",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "token_type": {
+ "name": "token_type",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "scope": {
+ "name": "scope",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "id_token": {
+ "name": "id_token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "session_state": {
+ "name": "session_state",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "userId_idx": {
+ "name": "userId_idx",
+ "columns": ["userId"],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "account_userId_user_id_fk": {
+ "name": "account_userId_user_id_fk",
+ "tableFrom": "account",
+ "tableTo": "user",
+ "columnsFrom": ["userId"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "account_provider_providerAccountId_pk": {
+ "name": "account_provider_providerAccountId_pk",
+ "columns": ["provider", "providerAccountId"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "app": {
+ "name": "app",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "description": {
+ "name": "description",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "icon_url": {
+ "name": "icon_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "href": {
+ "name": "href",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {},
+ "compositePrimaryKeys": {
+ "app_id": {
+ "name": "app_id",
+ "columns": ["id"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "boardGroupPermission": {
+ "name": "boardGroupPermission",
+ "columns": {
+ "board_id": {
+ "name": "board_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "group_id": {
+ "name": "group_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "permission": {
+ "name": "permission",
+ "type": "varchar(128)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "boardGroupPermission_board_id_board_id_fk": {
+ "name": "boardGroupPermission_board_id_board_id_fk",
+ "tableFrom": "boardGroupPermission",
+ "tableTo": "board",
+ "columnsFrom": ["board_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "boardGroupPermission_group_id_group_id_fk": {
+ "name": "boardGroupPermission_group_id_group_id_fk",
+ "tableFrom": "boardGroupPermission",
+ "tableTo": "group",
+ "columnsFrom": ["group_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "boardGroupPermission_board_id_group_id_permission_pk": {
+ "name": "boardGroupPermission_board_id_group_id_permission_pk",
+ "columns": ["board_id", "group_id", "permission"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "boardUserPermission": {
+ "name": "boardUserPermission",
+ "columns": {
+ "board_id": {
+ "name": "board_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "user_id": {
+ "name": "user_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "permission": {
+ "name": "permission",
+ "type": "varchar(128)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "boardUserPermission_board_id_board_id_fk": {
+ "name": "boardUserPermission_board_id_board_id_fk",
+ "tableFrom": "boardUserPermission",
+ "tableTo": "board",
+ "columnsFrom": ["board_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "boardUserPermission_user_id_user_id_fk": {
+ "name": "boardUserPermission_user_id_user_id_fk",
+ "tableFrom": "boardUserPermission",
+ "tableTo": "user",
+ "columnsFrom": ["user_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "boardUserPermission_board_id_user_id_permission_pk": {
+ "name": "boardUserPermission_board_id_user_id_permission_pk",
+ "columns": ["board_id", "user_id", "permission"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "board": {
+ "name": "board",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "varchar(256)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "is_public": {
+ "name": "is_public",
+ "type": "boolean",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": false
+ },
+ "creator_id": {
+ "name": "creator_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "page_title": {
+ "name": "page_title",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "meta_title": {
+ "name": "meta_title",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "logo_image_url": {
+ "name": "logo_image_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "favicon_image_url": {
+ "name": "favicon_image_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "background_image_url": {
+ "name": "background_image_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "background_image_attachment": {
+ "name": "background_image_attachment",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "('fixed')"
+ },
+ "background_image_repeat": {
+ "name": "background_image_repeat",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "('no-repeat')"
+ },
+ "background_image_size": {
+ "name": "background_image_size",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "('cover')"
+ },
+ "primary_color": {
+ "name": "primary_color",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "('#fa5252')"
+ },
+ "secondary_color": {
+ "name": "secondary_color",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "('#fd7e14')"
+ },
+ "opacity": {
+ "name": "opacity",
+ "type": "int",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": 100
+ },
+ "custom_css": {
+ "name": "custom_css",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "column_count": {
+ "name": "column_count",
+ "type": "int",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": 10
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "board_creator_id_user_id_fk": {
+ "name": "board_creator_id_user_id_fk",
+ "tableFrom": "board",
+ "tableTo": "user",
+ "columnsFrom": ["creator_id"],
+ "columnsTo": ["id"],
+ "onDelete": "set null",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "board_id": {
+ "name": "board_id",
+ "columns": ["id"]
+ }
+ },
+ "uniqueConstraints": {
+ "board_name_unique": {
+ "name": "board_name_unique",
+ "columns": ["name"]
+ }
+ }
+ },
+ "groupMember": {
+ "name": "groupMember",
+ "columns": {
+ "groupId": {
+ "name": "groupId",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "userId": {
+ "name": "userId",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "groupMember_groupId_group_id_fk": {
+ "name": "groupMember_groupId_group_id_fk",
+ "tableFrom": "groupMember",
+ "tableTo": "group",
+ "columnsFrom": ["groupId"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "groupMember_userId_user_id_fk": {
+ "name": "groupMember_userId_user_id_fk",
+ "tableFrom": "groupMember",
+ "tableTo": "user",
+ "columnsFrom": ["userId"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "groupMember_groupId_userId_pk": {
+ "name": "groupMember_groupId_userId_pk",
+ "columns": ["groupId", "userId"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "groupPermission": {
+ "name": "groupPermission",
+ "columns": {
+ "groupId": {
+ "name": "groupId",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "permission": {
+ "name": "permission",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "groupPermission_groupId_group_id_fk": {
+ "name": "groupPermission_groupId_group_id_fk",
+ "tableFrom": "groupPermission",
+ "tableTo": "group",
+ "columnsFrom": ["groupId"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "group": {
+ "name": "group",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "owner_id": {
+ "name": "owner_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "group_owner_id_user_id_fk": {
+ "name": "group_owner_id_user_id_fk",
+ "tableFrom": "group",
+ "tableTo": "user",
+ "columnsFrom": ["owner_id"],
+ "columnsTo": ["id"],
+ "onDelete": "set null",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "group_id": {
+ "name": "group_id",
+ "columns": ["id"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "iconRepository": {
+ "name": "iconRepository",
+ "columns": {
+ "iconRepository_id": {
+ "name": "iconRepository_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "iconRepository_slug": {
+ "name": "iconRepository_slug",
+ "type": "varchar(150)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {},
+ "compositePrimaryKeys": {
+ "iconRepository_iconRepository_id": {
+ "name": "iconRepository_iconRepository_id",
+ "columns": ["iconRepository_id"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "icon": {
+ "name": "icon",
+ "columns": {
+ "icon_id": {
+ "name": "icon_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "icon_name": {
+ "name": "icon_name",
+ "type": "varchar(250)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "icon_url": {
+ "name": "icon_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "icon_checksum": {
+ "name": "icon_checksum",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "iconRepository_id": {
+ "name": "iconRepository_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "icon_iconRepository_id_iconRepository_iconRepository_id_fk": {
+ "name": "icon_iconRepository_id_iconRepository_iconRepository_id_fk",
+ "tableFrom": "icon",
+ "tableTo": "iconRepository",
+ "columnsFrom": ["iconRepository_id"],
+ "columnsTo": ["iconRepository_id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "icon_icon_id": {
+ "name": "icon_icon_id",
+ "columns": ["icon_id"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "integration_item": {
+ "name": "integration_item",
+ "columns": {
+ "item_id": {
+ "name": "item_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "integration_id": {
+ "name": "integration_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "integration_item_item_id_item_id_fk": {
+ "name": "integration_item_item_id_item_id_fk",
+ "tableFrom": "integration_item",
+ "tableTo": "item",
+ "columnsFrom": ["item_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "integration_item_integration_id_integration_id_fk": {
+ "name": "integration_item_integration_id_integration_id_fk",
+ "tableFrom": "integration_item",
+ "tableTo": "integration",
+ "columnsFrom": ["integration_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "integration_item_item_id_integration_id_pk": {
+ "name": "integration_item_item_id_integration_id_pk",
+ "columns": ["item_id", "integration_id"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "integrationSecret": {
+ "name": "integrationSecret",
+ "columns": {
+ "kind": {
+ "name": "kind",
+ "type": "varchar(16)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "value": {
+ "name": "value",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "updated_at": {
+ "name": "updated_at",
+ "type": "timestamp",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "integration_id": {
+ "name": "integration_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "integration_secret__kind_idx": {
+ "name": "integration_secret__kind_idx",
+ "columns": ["kind"],
+ "isUnique": false
+ },
+ "integration_secret__updated_at_idx": {
+ "name": "integration_secret__updated_at_idx",
+ "columns": ["updated_at"],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "integrationSecret_integration_id_integration_id_fk": {
+ "name": "integrationSecret_integration_id_integration_id_fk",
+ "tableFrom": "integrationSecret",
+ "tableTo": "integration",
+ "columnsFrom": ["integration_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "integrationSecret_integration_id_kind_pk": {
+ "name": "integrationSecret_integration_id_kind_pk",
+ "columns": ["integration_id", "kind"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "integration": {
+ "name": "integration",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "url": {
+ "name": "url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "kind": {
+ "name": "kind",
+ "type": "varchar(128)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "integration__kind_idx": {
+ "name": "integration__kind_idx",
+ "columns": ["kind"],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {},
+ "compositePrimaryKeys": {
+ "integration_id": {
+ "name": "integration_id",
+ "columns": ["id"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "invite": {
+ "name": "invite",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "token": {
+ "name": "token",
+ "type": "varchar(512)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "expiration_date": {
+ "name": "expiration_date",
+ "type": "timestamp",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "creator_id": {
+ "name": "creator_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "invite_creator_id_user_id_fk": {
+ "name": "invite_creator_id_user_id_fk",
+ "tableFrom": "invite",
+ "tableTo": "user",
+ "columnsFrom": ["creator_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "invite_id": {
+ "name": "invite_id",
+ "columns": ["id"]
+ }
+ },
+ "uniqueConstraints": {
+ "invite_token_unique": {
+ "name": "invite_token_unique",
+ "columns": ["token"]
+ }
+ }
+ },
+ "item": {
+ "name": "item",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "section_id": {
+ "name": "section_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "kind": {
+ "name": "kind",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "x_offset": {
+ "name": "x_offset",
+ "type": "int",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "y_offset": {
+ "name": "y_offset",
+ "type": "int",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "width": {
+ "name": "width",
+ "type": "int",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "height": {
+ "name": "height",
+ "type": "int",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "options": {
+ "name": "options",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "('{\"json\": {}}')"
+ },
+ "advanced_options": {
+ "name": "advanced_options",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "('{\"json\": {}}')"
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "item_section_id_section_id_fk": {
+ "name": "item_section_id_section_id_fk",
+ "tableFrom": "item",
+ "tableTo": "section",
+ "columnsFrom": ["section_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "item_id": {
+ "name": "item_id",
+ "columns": ["id"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "section": {
+ "name": "section",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "board_id": {
+ "name": "board_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "kind": {
+ "name": "kind",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "position": {
+ "name": "position",
+ "type": "int",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "section_board_id_board_id_fk": {
+ "name": "section_board_id_board_id_fk",
+ "tableFrom": "section",
+ "tableTo": "board",
+ "columnsFrom": ["board_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "section_id": {
+ "name": "section_id",
+ "columns": ["id"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "session": {
+ "name": "session",
+ "columns": {
+ "sessionToken": {
+ "name": "sessionToken",
+ "type": "varchar(512)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "userId": {
+ "name": "userId",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "expires": {
+ "name": "expires",
+ "type": "timestamp",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "user_id_idx": {
+ "name": "user_id_idx",
+ "columns": ["userId"],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "session_userId_user_id_fk": {
+ "name": "session_userId_user_id_fk",
+ "tableFrom": "session",
+ "tableTo": "user",
+ "columnsFrom": ["userId"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "session_sessionToken": {
+ "name": "session_sessionToken",
+ "columns": ["sessionToken"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "user": {
+ "name": "user",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "email": {
+ "name": "email",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "emailVerified": {
+ "name": "emailVerified",
+ "type": "timestamp",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "image": {
+ "name": "image",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "password": {
+ "name": "password",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "salt": {
+ "name": "salt",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "homeBoardId": {
+ "name": "homeBoardId",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "user_homeBoardId_board_id_fk": {
+ "name": "user_homeBoardId_board_id_fk",
+ "tableFrom": "user",
+ "tableTo": "board",
+ "columnsFrom": ["homeBoardId"],
+ "columnsTo": ["id"],
+ "onDelete": "set null",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "user_id": {
+ "name": "user_id",
+ "columns": ["id"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "verificationToken": {
+ "name": "verificationToken",
+ "columns": {
+ "identifier": {
+ "name": "identifier",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "token": {
+ "name": "token",
+ "type": "varchar(512)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "expires": {
+ "name": "expires",
+ "type": "timestamp",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {},
+ "compositePrimaryKeys": {
+ "verificationToken_identifier_token_pk": {
+ "name": "verificationToken_identifier_token_pk",
+ "columns": ["identifier", "token"]
+ }
+ },
+ "uniqueConstraints": {}
+ }
+ },
+ "_meta": {
+ "schemas": {},
+ "tables": {},
+ "columns": {}
+ }
+}
diff --git a/packages/db/migrations/mysql/meta/0003_snapshot.json b/packages/db/migrations/mysql/meta/0003_snapshot.json
new file mode 100644
index 000000000..19b512ac9
--- /dev/null
+++ b/packages/db/migrations/mysql/meta/0003_snapshot.json
@@ -0,0 +1,1208 @@
+{
+ "version": "5",
+ "dialect": "mysql",
+ "id": "4e382d0d-a432-4953-bd5e-04f3f33e26a4",
+ "prevId": "e7a373e1-9f36-4910-9f2b-ac6fd5e79145",
+ "tables": {
+ "account": {
+ "name": "account",
+ "columns": {
+ "userId": {
+ "name": "userId",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "type": {
+ "name": "type",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "provider": {
+ "name": "provider",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "providerAccountId": {
+ "name": "providerAccountId",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "refresh_token": {
+ "name": "refresh_token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "access_token": {
+ "name": "access_token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "expires_at": {
+ "name": "expires_at",
+ "type": "int",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "token_type": {
+ "name": "token_type",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "scope": {
+ "name": "scope",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "id_token": {
+ "name": "id_token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "session_state": {
+ "name": "session_state",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "userId_idx": {
+ "name": "userId_idx",
+ "columns": ["userId"],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "account_userId_user_id_fk": {
+ "name": "account_userId_user_id_fk",
+ "tableFrom": "account",
+ "tableTo": "user",
+ "columnsFrom": ["userId"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "account_provider_providerAccountId_pk": {
+ "name": "account_provider_providerAccountId_pk",
+ "columns": ["provider", "providerAccountId"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "app": {
+ "name": "app",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "description": {
+ "name": "description",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "icon_url": {
+ "name": "icon_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "href": {
+ "name": "href",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {},
+ "compositePrimaryKeys": {
+ "app_id": {
+ "name": "app_id",
+ "columns": ["id"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "boardGroupPermission": {
+ "name": "boardGroupPermission",
+ "columns": {
+ "board_id": {
+ "name": "board_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "group_id": {
+ "name": "group_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "permission": {
+ "name": "permission",
+ "type": "varchar(128)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "boardGroupPermission_board_id_board_id_fk": {
+ "name": "boardGroupPermission_board_id_board_id_fk",
+ "tableFrom": "boardGroupPermission",
+ "tableTo": "board",
+ "columnsFrom": ["board_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "boardGroupPermission_group_id_group_id_fk": {
+ "name": "boardGroupPermission_group_id_group_id_fk",
+ "tableFrom": "boardGroupPermission",
+ "tableTo": "group",
+ "columnsFrom": ["group_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "boardGroupPermission_board_id_group_id_permission_pk": {
+ "name": "boardGroupPermission_board_id_group_id_permission_pk",
+ "columns": ["board_id", "group_id", "permission"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "boardUserPermission": {
+ "name": "boardUserPermission",
+ "columns": {
+ "board_id": {
+ "name": "board_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "user_id": {
+ "name": "user_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "permission": {
+ "name": "permission",
+ "type": "varchar(128)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "boardUserPermission_board_id_board_id_fk": {
+ "name": "boardUserPermission_board_id_board_id_fk",
+ "tableFrom": "boardUserPermission",
+ "tableTo": "board",
+ "columnsFrom": ["board_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "boardUserPermission_user_id_user_id_fk": {
+ "name": "boardUserPermission_user_id_user_id_fk",
+ "tableFrom": "boardUserPermission",
+ "tableTo": "user",
+ "columnsFrom": ["user_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "boardUserPermission_board_id_user_id_permission_pk": {
+ "name": "boardUserPermission_board_id_user_id_permission_pk",
+ "columns": ["board_id", "user_id", "permission"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "board": {
+ "name": "board",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "varchar(256)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "is_public": {
+ "name": "is_public",
+ "type": "boolean",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": false
+ },
+ "creator_id": {
+ "name": "creator_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "page_title": {
+ "name": "page_title",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "meta_title": {
+ "name": "meta_title",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "logo_image_url": {
+ "name": "logo_image_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "favicon_image_url": {
+ "name": "favicon_image_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "background_image_url": {
+ "name": "background_image_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "background_image_attachment": {
+ "name": "background_image_attachment",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "('fixed')"
+ },
+ "background_image_repeat": {
+ "name": "background_image_repeat",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "('no-repeat')"
+ },
+ "background_image_size": {
+ "name": "background_image_size",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "('cover')"
+ },
+ "primary_color": {
+ "name": "primary_color",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "('#fa5252')"
+ },
+ "secondary_color": {
+ "name": "secondary_color",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "('#fd7e14')"
+ },
+ "opacity": {
+ "name": "opacity",
+ "type": "int",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": 100
+ },
+ "custom_css": {
+ "name": "custom_css",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "column_count": {
+ "name": "column_count",
+ "type": "int",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": 10
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "board_creator_id_user_id_fk": {
+ "name": "board_creator_id_user_id_fk",
+ "tableFrom": "board",
+ "tableTo": "user",
+ "columnsFrom": ["creator_id"],
+ "columnsTo": ["id"],
+ "onDelete": "set null",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "board_id": {
+ "name": "board_id",
+ "columns": ["id"]
+ }
+ },
+ "uniqueConstraints": {
+ "board_name_unique": {
+ "name": "board_name_unique",
+ "columns": ["name"]
+ }
+ }
+ },
+ "groupMember": {
+ "name": "groupMember",
+ "columns": {
+ "groupId": {
+ "name": "groupId",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "userId": {
+ "name": "userId",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "groupMember_groupId_group_id_fk": {
+ "name": "groupMember_groupId_group_id_fk",
+ "tableFrom": "groupMember",
+ "tableTo": "group",
+ "columnsFrom": ["groupId"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "groupMember_userId_user_id_fk": {
+ "name": "groupMember_userId_user_id_fk",
+ "tableFrom": "groupMember",
+ "tableTo": "user",
+ "columnsFrom": ["userId"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "groupMember_groupId_userId_pk": {
+ "name": "groupMember_groupId_userId_pk",
+ "columns": ["groupId", "userId"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "groupPermission": {
+ "name": "groupPermission",
+ "columns": {
+ "groupId": {
+ "name": "groupId",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "permission": {
+ "name": "permission",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "groupPermission_groupId_group_id_fk": {
+ "name": "groupPermission_groupId_group_id_fk",
+ "tableFrom": "groupPermission",
+ "tableTo": "group",
+ "columnsFrom": ["groupId"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "group": {
+ "name": "group",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "owner_id": {
+ "name": "owner_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "group_owner_id_user_id_fk": {
+ "name": "group_owner_id_user_id_fk",
+ "tableFrom": "group",
+ "tableTo": "user",
+ "columnsFrom": ["owner_id"],
+ "columnsTo": ["id"],
+ "onDelete": "set null",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "group_id": {
+ "name": "group_id",
+ "columns": ["id"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "iconRepository": {
+ "name": "iconRepository",
+ "columns": {
+ "iconRepository_id": {
+ "name": "iconRepository_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "iconRepository_slug": {
+ "name": "iconRepository_slug",
+ "type": "varchar(150)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {},
+ "compositePrimaryKeys": {
+ "iconRepository_iconRepository_id": {
+ "name": "iconRepository_iconRepository_id",
+ "columns": ["iconRepository_id"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "icon": {
+ "name": "icon",
+ "columns": {
+ "icon_id": {
+ "name": "icon_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "icon_name": {
+ "name": "icon_name",
+ "type": "varchar(250)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "icon_url": {
+ "name": "icon_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "icon_checksum": {
+ "name": "icon_checksum",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "iconRepository_id": {
+ "name": "iconRepository_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "icon_iconRepository_id_iconRepository_iconRepository_id_fk": {
+ "name": "icon_iconRepository_id_iconRepository_iconRepository_id_fk",
+ "tableFrom": "icon",
+ "tableTo": "iconRepository",
+ "columnsFrom": ["iconRepository_id"],
+ "columnsTo": ["iconRepository_id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "icon_icon_id": {
+ "name": "icon_icon_id",
+ "columns": ["icon_id"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "integration_item": {
+ "name": "integration_item",
+ "columns": {
+ "item_id": {
+ "name": "item_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "integration_id": {
+ "name": "integration_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "integration_item_item_id_item_id_fk": {
+ "name": "integration_item_item_id_item_id_fk",
+ "tableFrom": "integration_item",
+ "tableTo": "item",
+ "columnsFrom": ["item_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "integration_item_integration_id_integration_id_fk": {
+ "name": "integration_item_integration_id_integration_id_fk",
+ "tableFrom": "integration_item",
+ "tableTo": "integration",
+ "columnsFrom": ["integration_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "integration_item_item_id_integration_id_pk": {
+ "name": "integration_item_item_id_integration_id_pk",
+ "columns": ["item_id", "integration_id"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "integrationSecret": {
+ "name": "integrationSecret",
+ "columns": {
+ "kind": {
+ "name": "kind",
+ "type": "varchar(16)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "value": {
+ "name": "value",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "updated_at": {
+ "name": "updated_at",
+ "type": "timestamp",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "integration_id": {
+ "name": "integration_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "integration_secret__kind_idx": {
+ "name": "integration_secret__kind_idx",
+ "columns": ["kind"],
+ "isUnique": false
+ },
+ "integration_secret__updated_at_idx": {
+ "name": "integration_secret__updated_at_idx",
+ "columns": ["updated_at"],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "integrationSecret_integration_id_integration_id_fk": {
+ "name": "integrationSecret_integration_id_integration_id_fk",
+ "tableFrom": "integrationSecret",
+ "tableTo": "integration",
+ "columnsFrom": ["integration_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "integrationSecret_integration_id_kind_pk": {
+ "name": "integrationSecret_integration_id_kind_pk",
+ "columns": ["integration_id", "kind"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "integration": {
+ "name": "integration",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "url": {
+ "name": "url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "kind": {
+ "name": "kind",
+ "type": "varchar(128)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "integration__kind_idx": {
+ "name": "integration__kind_idx",
+ "columns": ["kind"],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {},
+ "compositePrimaryKeys": {
+ "integration_id": {
+ "name": "integration_id",
+ "columns": ["id"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "invite": {
+ "name": "invite",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "token": {
+ "name": "token",
+ "type": "varchar(512)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "expiration_date": {
+ "name": "expiration_date",
+ "type": "timestamp",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "creator_id": {
+ "name": "creator_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "invite_creator_id_user_id_fk": {
+ "name": "invite_creator_id_user_id_fk",
+ "tableFrom": "invite",
+ "tableTo": "user",
+ "columnsFrom": ["creator_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "invite_id": {
+ "name": "invite_id",
+ "columns": ["id"]
+ }
+ },
+ "uniqueConstraints": {
+ "invite_token_unique": {
+ "name": "invite_token_unique",
+ "columns": ["token"]
+ }
+ }
+ },
+ "item": {
+ "name": "item",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "section_id": {
+ "name": "section_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "kind": {
+ "name": "kind",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "x_offset": {
+ "name": "x_offset",
+ "type": "int",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "y_offset": {
+ "name": "y_offset",
+ "type": "int",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "width": {
+ "name": "width",
+ "type": "int",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "height": {
+ "name": "height",
+ "type": "int",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "options": {
+ "name": "options",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "('{\"json\": {}}')"
+ },
+ "advanced_options": {
+ "name": "advanced_options",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "('{\"json\": {}}')"
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "item_section_id_section_id_fk": {
+ "name": "item_section_id_section_id_fk",
+ "tableFrom": "item",
+ "tableTo": "section",
+ "columnsFrom": ["section_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "item_id": {
+ "name": "item_id",
+ "columns": ["id"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "section": {
+ "name": "section",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "board_id": {
+ "name": "board_id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "kind": {
+ "name": "kind",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "position": {
+ "name": "position",
+ "type": "int",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "section_board_id_board_id_fk": {
+ "name": "section_board_id_board_id_fk",
+ "tableFrom": "section",
+ "tableTo": "board",
+ "columnsFrom": ["board_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "section_id": {
+ "name": "section_id",
+ "columns": ["id"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "serverSetting": {
+ "name": "serverSetting",
+ "columns": {
+ "key": {
+ "name": "key",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "value": {
+ "name": "value",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "('{\"json\": {}}')"
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {},
+ "compositePrimaryKeys": {
+ "serverSetting_key": {
+ "name": "serverSetting_key",
+ "columns": ["key"]
+ }
+ },
+ "uniqueConstraints": {
+ "serverSetting_key_unique": {
+ "name": "serverSetting_key_unique",
+ "columns": ["key"]
+ }
+ }
+ },
+ "session": {
+ "name": "session",
+ "columns": {
+ "sessionToken": {
+ "name": "sessionToken",
+ "type": "varchar(512)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "userId": {
+ "name": "userId",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "expires": {
+ "name": "expires",
+ "type": "timestamp",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "user_id_idx": {
+ "name": "user_id_idx",
+ "columns": ["userId"],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "session_userId_user_id_fk": {
+ "name": "session_userId_user_id_fk",
+ "tableFrom": "session",
+ "tableTo": "user",
+ "columnsFrom": ["userId"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "session_sessionToken": {
+ "name": "session_sessionToken",
+ "columns": ["sessionToken"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "user": {
+ "name": "user",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "email": {
+ "name": "email",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "emailVerified": {
+ "name": "emailVerified",
+ "type": "timestamp",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "image": {
+ "name": "image",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "password": {
+ "name": "password",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "salt": {
+ "name": "salt",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "homeBoardId": {
+ "name": "homeBoardId",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "user_homeBoardId_board_id_fk": {
+ "name": "user_homeBoardId_board_id_fk",
+ "tableFrom": "user",
+ "tableTo": "board",
+ "columnsFrom": ["homeBoardId"],
+ "columnsTo": ["id"],
+ "onDelete": "set null",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "user_id": {
+ "name": "user_id",
+ "columns": ["id"]
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "verificationToken": {
+ "name": "verificationToken",
+ "columns": {
+ "identifier": {
+ "name": "identifier",
+ "type": "varchar(64)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "token": {
+ "name": "token",
+ "type": "varchar(512)",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "expires": {
+ "name": "expires",
+ "type": "timestamp",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {},
+ "compositePrimaryKeys": {
+ "verificationToken_identifier_token_pk": {
+ "name": "verificationToken_identifier_token_pk",
+ "columns": ["identifier", "token"]
+ }
+ },
+ "uniqueConstraints": {}
+ }
+ },
+ "_meta": {
+ "schemas": {},
+ "tables": {},
+ "columns": {}
+ }
+}
diff --git a/packages/db/migrations/mysql/meta/_journal.json b/packages/db/migrations/mysql/meta/_journal.json
new file mode 100644
index 000000000..bb349fd94
--- /dev/null
+++ b/packages/db/migrations/mysql/meta/_journal.json
@@ -0,0 +1,34 @@
+{
+ "version": "6",
+ "dialect": "mysql",
+ "entries": [
+ {
+ "idx": 0,
+ "version": "5",
+ "when": 1715334452118,
+ "tag": "0000_harsh_photon",
+ "breakpoints": true
+ },
+ {
+ "idx": 1,
+ "version": "5",
+ "when": 1715885855801,
+ "tag": "0001_wild_alex_wilder",
+ "breakpoints": true
+ },
+ {
+ "idx": 2,
+ "version": "5",
+ "when": 1715980459023,
+ "tag": "0002_flimsy_deathbird",
+ "breakpoints": true
+ },
+ {
+ "idx": 3,
+ "version": "5",
+ "when": 1716148439439,
+ "tag": "0003_freezing_black_panther",
+ "breakpoints": true
+ }
+ ]
+}
diff --git a/packages/db/migrations/mysql/migrate.ts b/packages/db/migrations/mysql/migrate.ts
new file mode 100644
index 000000000..fd67b7f70
--- /dev/null
+++ b/packages/db/migrations/mysql/migrate.ts
@@ -0,0 +1,31 @@
+import { drizzle } from "drizzle-orm/mysql2";
+import { migrate } from "drizzle-orm/mysql2/migrator";
+import mysql from "mysql2";
+
+const migrationsFolder = process.argv[2] ?? ".";
+
+const mysql2 = mysql.createConnection(
+ process.env.DB_HOST
+ ? {
+ host: process.env.DB_HOST,
+ database: process.env.DB_NAME!,
+ port: Number(process.env.DB_PORT),
+ user: process.env.DB_USER,
+ password: process.env.DB_PASSWORD,
+ }
+ : { uri: process.env.DB_URL },
+);
+
+const db = drizzle(mysql2, {
+ mode: "default",
+});
+
+migrate(db, { migrationsFolder })
+ .then(() => {
+ console.log("Migration complete");
+ process.exit(0);
+ })
+ .catch((err) => {
+ console.log("Migration failed", err);
+ process.exit(1);
+ });
diff --git a/packages/db/migrations/sqlite/0000_talented_ben_parker.sql b/packages/db/migrations/sqlite/0000_talented_ben_parker.sql
new file mode 100644
index 000000000..247f822d7
--- /dev/null
+++ b/packages/db/migrations/sqlite/0000_talented_ben_parker.sql
@@ -0,0 +1,182 @@
+CREATE TABLE `account` (
+ `userId` text NOT NULL,
+ `type` text NOT NULL,
+ `provider` text NOT NULL,
+ `providerAccountId` text NOT NULL,
+ `refresh_token` text,
+ `access_token` text,
+ `expires_at` integer,
+ `token_type` text,
+ `scope` text,
+ `id_token` text,
+ `session_state` text,
+ PRIMARY KEY(`provider`, `providerAccountId`),
+ FOREIGN KEY (`userId`) REFERENCES `user`(`id`) ON UPDATE no action ON DELETE cascade
+);
+--> statement-breakpoint
+CREATE TABLE `app` (
+ `id` text PRIMARY KEY NOT NULL,
+ `name` text NOT NULL,
+ `description` text,
+ `icon_url` text NOT NULL,
+ `href` text
+);
+--> statement-breakpoint
+CREATE TABLE `boardGroupPermission` (
+ `board_id` text NOT NULL,
+ `group_id` text NOT NULL,
+ `permission` text NOT NULL,
+ PRIMARY KEY(`board_id`, `group_id`, `permission`),
+ FOREIGN KEY (`board_id`) REFERENCES `board`(`id`) ON UPDATE no action ON DELETE cascade,
+ FOREIGN KEY (`group_id`) REFERENCES `group`(`id`) ON UPDATE no action ON DELETE cascade
+);
+--> statement-breakpoint
+CREATE TABLE `boardUserPermission` (
+ `board_id` text NOT NULL,
+ `user_id` text NOT NULL,
+ `permission` text NOT NULL,
+ PRIMARY KEY(`board_id`, `permission`, `user_id`),
+ FOREIGN KEY (`board_id`) REFERENCES `board`(`id`) ON UPDATE no action ON DELETE cascade,
+ FOREIGN KEY (`user_id`) REFERENCES `user`(`id`) ON UPDATE no action ON DELETE cascade
+);
+--> statement-breakpoint
+CREATE TABLE `board` (
+ `id` text PRIMARY KEY NOT NULL,
+ `name` text NOT NULL,
+ `is_public` integer DEFAULT false NOT NULL,
+ `creator_id` text,
+ `page_title` text,
+ `meta_title` text,
+ `logo_image_url` text,
+ `favicon_image_url` text,
+ `background_image_url` text,
+ `background_image_attachment` text DEFAULT 'fixed' NOT NULL,
+ `background_image_repeat` text DEFAULT 'no-repeat' NOT NULL,
+ `background_image_size` text DEFAULT 'cover' NOT NULL,
+ `primary_color` text DEFAULT '#fa5252' NOT NULL,
+ `secondary_color` text DEFAULT '#fd7e14' NOT NULL,
+ `opacity` integer DEFAULT 100 NOT NULL,
+ `custom_css` text,
+ `column_count` integer DEFAULT 10 NOT NULL,
+ FOREIGN KEY (`creator_id`) REFERENCES `user`(`id`) ON UPDATE no action ON DELETE set null
+);
+--> statement-breakpoint
+CREATE TABLE `groupMember` (
+ `groupId` text NOT NULL,
+ `userId` text NOT NULL,
+ PRIMARY KEY(`groupId`, `userId`),
+ FOREIGN KEY (`groupId`) REFERENCES `group`(`id`) ON UPDATE no action ON DELETE cascade,
+ FOREIGN KEY (`userId`) REFERENCES `user`(`id`) ON UPDATE no action ON DELETE cascade
+);
+--> statement-breakpoint
+CREATE TABLE `groupPermission` (
+ `groupId` text NOT NULL,
+ `permission` text NOT NULL,
+ FOREIGN KEY (`groupId`) REFERENCES `group`(`id`) ON UPDATE no action ON DELETE cascade
+);
+--> statement-breakpoint
+CREATE TABLE `group` (
+ `id` text PRIMARY KEY NOT NULL,
+ `name` text NOT NULL,
+ `owner_id` text,
+ FOREIGN KEY (`owner_id`) REFERENCES `user`(`id`) ON UPDATE no action ON DELETE set null
+);
+--> statement-breakpoint
+CREATE TABLE `iconRepository` (
+ `iconRepository_id` text PRIMARY KEY NOT NULL,
+ `iconRepository_slug` text NOT NULL
+);
+--> statement-breakpoint
+CREATE TABLE `icon` (
+ `icon_id` text PRIMARY KEY NOT NULL,
+ `icon_name` text NOT NULL,
+ `icon_url` text NOT NULL,
+ `icon_checksum` text NOT NULL,
+ `iconRepository_id` text NOT NULL,
+ FOREIGN KEY (`iconRepository_id`) REFERENCES `iconRepository`(`iconRepository_id`) ON UPDATE no action ON DELETE cascade
+);
+--> statement-breakpoint
+CREATE TABLE `integration_item` (
+ `item_id` text NOT NULL,
+ `integration_id` text NOT NULL,
+ PRIMARY KEY(`integration_id`, `item_id`),
+ FOREIGN KEY (`item_id`) REFERENCES `item`(`id`) ON UPDATE no action ON DELETE cascade,
+ FOREIGN KEY (`integration_id`) REFERENCES `integration`(`id`) ON UPDATE no action ON DELETE cascade
+);
+--> statement-breakpoint
+CREATE TABLE `integrationSecret` (
+ `kind` text NOT NULL,
+ `value` text NOT NULL,
+ `updated_at` integer NOT NULL,
+ `integration_id` text NOT NULL,
+ PRIMARY KEY(`integration_id`, `kind`),
+ FOREIGN KEY (`integration_id`) REFERENCES `integration`(`id`) ON UPDATE no action ON DELETE cascade
+);
+--> statement-breakpoint
+CREATE TABLE `integration` (
+ `id` text PRIMARY KEY NOT NULL,
+ `name` text NOT NULL,
+ `url` text NOT NULL,
+ `kind` text NOT NULL
+);
+--> statement-breakpoint
+CREATE TABLE `invite` (
+ `id` text PRIMARY KEY NOT NULL,
+ `token` text NOT NULL,
+ `expiration_date` integer NOT NULL,
+ `creator_id` text NOT NULL,
+ FOREIGN KEY (`creator_id`) REFERENCES `user`(`id`) ON UPDATE no action ON DELETE cascade
+);
+--> statement-breakpoint
+CREATE TABLE `item` (
+ `id` text PRIMARY KEY NOT NULL,
+ `section_id` text NOT NULL,
+ `kind` text NOT NULL,
+ `x_offset` integer NOT NULL,
+ `y_offset` integer NOT NULL,
+ `width` integer NOT NULL,
+ `height` integer NOT NULL,
+ `options` text DEFAULT '{"json": {}}' NOT NULL,
+ FOREIGN KEY (`section_id`) REFERENCES `section`(`id`) ON UPDATE no action ON DELETE cascade
+);
+--> statement-breakpoint
+CREATE TABLE `section` (
+ `id` text PRIMARY KEY NOT NULL,
+ `board_id` text NOT NULL,
+ `kind` text NOT NULL,
+ `position` integer NOT NULL,
+ `name` text,
+ FOREIGN KEY (`board_id`) REFERENCES `board`(`id`) ON UPDATE no action ON DELETE cascade
+);
+--> statement-breakpoint
+CREATE TABLE `session` (
+ `sessionToken` text PRIMARY KEY NOT NULL,
+ `userId` text NOT NULL,
+ `expires` integer NOT NULL,
+ FOREIGN KEY (`userId`) REFERENCES `user`(`id`) ON UPDATE no action ON DELETE cascade
+);
+--> statement-breakpoint
+CREATE TABLE `user` (
+ `id` text PRIMARY KEY NOT NULL,
+ `name` text,
+ `email` text,
+ `emailVerified` integer,
+ `image` text,
+ `password` text,
+ `salt` text
+);
+--> statement-breakpoint
+CREATE TABLE `verificationToken` (
+ `identifier` text NOT NULL,
+ `token` text NOT NULL,
+ `expires` integer NOT NULL,
+ PRIMARY KEY(`identifier`, `token`)
+);
+--> statement-breakpoint
+CREATE INDEX `userId_idx` ON `account` (`userId`);--> statement-breakpoint
+CREATE UNIQUE INDEX `board_name_unique` ON `board` (`name`);--> statement-breakpoint
+CREATE INDEX `integration_secret__kind_idx` ON `integrationSecret` (`kind`);--> statement-breakpoint
+CREATE INDEX `integration_secret__updated_at_idx` ON `integrationSecret` (`updated_at`);--> statement-breakpoint
+CREATE INDEX `integration__kind_idx` ON `integration` (`kind`);--> statement-breakpoint
+CREATE UNIQUE INDEX `invite_token_unique` ON `invite` (`token`);--> statement-breakpoint
+CREATE INDEX `user_id_idx` ON `session` (`userId`);
\ No newline at end of file
diff --git a/packages/db/migrations/sqlite/0001_mixed_titanium_man.sql b/packages/db/migrations/sqlite/0001_mixed_titanium_man.sql
new file mode 100644
index 000000000..66b30f3e5
--- /dev/null
+++ b/packages/db/migrations/sqlite/0001_mixed_titanium_man.sql
@@ -0,0 +1,33 @@
+COMMIT TRANSACTION;
+--> statement-breakpoint
+PRAGMA foreign_keys = OFF;
+--> statement-breakpoint
+BEGIN TRANSACTION;
+--> statement-breakpoint
+ALTER TABLE `user` RENAME TO `__user_old`;
+--> statement-breakpoint
+CREATE TABLE `user` (
+ `id` text PRIMARY KEY NOT NULL,
+ `name` text,
+ `email` text,
+ `emailVerified` integer,
+ `image` text,
+ `password` text,
+ `salt` text,
+ `homeBoardId` text,
+ FOREIGN KEY (`homeBoardId`) REFERENCES `board`(`id`) ON UPDATE no action ON DELETE set null
+);
+--> statement-breakpoint
+INSERT INTO `user` SELECT `id`, `name`, `email`, `emailVerified`, `image`, `password`, `salt`, null FROM `__user_old`;
+--> statement-breakpoint
+DROP TABLE `__user_old`;
+--> statement-breakpoint
+ALTER TABLE `user` RENAME TO `__user_old`;
+--> statement-breakpoint
+ALTER TABLE `__user_old` RENAME TO `user`;
+--> statement-breakpoint
+COMMIT TRANSACTION;
+--> statement-breakpoint
+PRAGMA foreign_keys = ON;
+--> statement-breakpoint
+BEGIN TRANSACTION;
\ No newline at end of file
diff --git a/packages/db/migrations/sqlite/0002_cooing_sumo.sql b/packages/db/migrations/sqlite/0002_cooing_sumo.sql
new file mode 100644
index 000000000..a12cdb821
--- /dev/null
+++ b/packages/db/migrations/sqlite/0002_cooing_sumo.sql
@@ -0,0 +1 @@
+ALTER TABLE `item` ADD `advanced_options` text DEFAULT '{"json": {}}' NOT NULL;
\ No newline at end of file
diff --git a/packages/db/migrations/sqlite/0003_adorable_raider.sql b/packages/db/migrations/sqlite/0003_adorable_raider.sql
new file mode 100644
index 000000000..af0219b7c
--- /dev/null
+++ b/packages/db/migrations/sqlite/0003_adorable_raider.sql
@@ -0,0 +1,6 @@
+CREATE TABLE `serverSetting` (
+ `key` text PRIMARY KEY NOT NULL,
+ `value` text DEFAULT '{"json": {}}' NOT NULL
+);
+--> statement-breakpoint
+CREATE UNIQUE INDEX `serverSetting_key_unique` ON `serverSetting` (`key`);
\ No newline at end of file
diff --git a/packages/db/migrations/sqlite/meta/0000_snapshot.json b/packages/db/migrations/sqlite/meta/0000_snapshot.json
new file mode 100644
index 000000000..fd193e02f
--- /dev/null
+++ b/packages/db/migrations/sqlite/meta/0000_snapshot.json
@@ -0,0 +1,1097 @@
+{
+ "version": "6",
+ "dialect": "sqlite",
+ "id": "0575873a-9e10-4480-8d7d-c47198622c22",
+ "prevId": "00000000-0000-0000-0000-000000000000",
+ "tables": {
+ "account": {
+ "name": "account",
+ "columns": {
+ "userId": {
+ "name": "userId",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "type": {
+ "name": "type",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "provider": {
+ "name": "provider",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "providerAccountId": {
+ "name": "providerAccountId",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "refresh_token": {
+ "name": "refresh_token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "access_token": {
+ "name": "access_token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "expires_at": {
+ "name": "expires_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "token_type": {
+ "name": "token_type",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "scope": {
+ "name": "scope",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "id_token": {
+ "name": "id_token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "session_state": {
+ "name": "session_state",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "userId_idx": {
+ "name": "userId_idx",
+ "columns": ["userId"],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "account_userId_user_id_fk": {
+ "name": "account_userId_user_id_fk",
+ "tableFrom": "account",
+ "tableTo": "user",
+ "columnsFrom": ["userId"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "account_provider_providerAccountId_pk": {
+ "columns": ["provider", "providerAccountId"],
+ "name": "account_provider_providerAccountId_pk"
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "app": {
+ "name": "app",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "description": {
+ "name": "description",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "icon_url": {
+ "name": "icon_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "href": {
+ "name": "href",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {},
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "boardGroupPermission": {
+ "name": "boardGroupPermission",
+ "columns": {
+ "board_id": {
+ "name": "board_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "group_id": {
+ "name": "group_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "permission": {
+ "name": "permission",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "boardGroupPermission_board_id_board_id_fk": {
+ "name": "boardGroupPermission_board_id_board_id_fk",
+ "tableFrom": "boardGroupPermission",
+ "tableTo": "board",
+ "columnsFrom": ["board_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "boardGroupPermission_group_id_group_id_fk": {
+ "name": "boardGroupPermission_group_id_group_id_fk",
+ "tableFrom": "boardGroupPermission",
+ "tableTo": "group",
+ "columnsFrom": ["group_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "boardGroupPermission_board_id_group_id_permission_pk": {
+ "columns": ["board_id", "group_id", "permission"],
+ "name": "boardGroupPermission_board_id_group_id_permission_pk"
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "boardUserPermission": {
+ "name": "boardUserPermission",
+ "columns": {
+ "board_id": {
+ "name": "board_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "user_id": {
+ "name": "user_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "permission": {
+ "name": "permission",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "boardUserPermission_board_id_board_id_fk": {
+ "name": "boardUserPermission_board_id_board_id_fk",
+ "tableFrom": "boardUserPermission",
+ "tableTo": "board",
+ "columnsFrom": ["board_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "boardUserPermission_user_id_user_id_fk": {
+ "name": "boardUserPermission_user_id_user_id_fk",
+ "tableFrom": "boardUserPermission",
+ "tableTo": "user",
+ "columnsFrom": ["user_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "boardUserPermission_board_id_user_id_permission_pk": {
+ "columns": ["board_id", "permission", "user_id"],
+ "name": "boardUserPermission_board_id_user_id_permission_pk"
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "board": {
+ "name": "board",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "is_public": {
+ "name": "is_public",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": false
+ },
+ "creator_id": {
+ "name": "creator_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "page_title": {
+ "name": "page_title",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "meta_title": {
+ "name": "meta_title",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "logo_image_url": {
+ "name": "logo_image_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "favicon_image_url": {
+ "name": "favicon_image_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "background_image_url": {
+ "name": "background_image_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "background_image_attachment": {
+ "name": "background_image_attachment",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'fixed'"
+ },
+ "background_image_repeat": {
+ "name": "background_image_repeat",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'no-repeat'"
+ },
+ "background_image_size": {
+ "name": "background_image_size",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'cover'"
+ },
+ "primary_color": {
+ "name": "primary_color",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'#fa5252'"
+ },
+ "secondary_color": {
+ "name": "secondary_color",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'#fd7e14'"
+ },
+ "opacity": {
+ "name": "opacity",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": 100
+ },
+ "custom_css": {
+ "name": "custom_css",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "column_count": {
+ "name": "column_count",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": 10
+ }
+ },
+ "indexes": {
+ "board_name_unique": {
+ "name": "board_name_unique",
+ "columns": ["name"],
+ "isUnique": true
+ }
+ },
+ "foreignKeys": {
+ "board_creator_id_user_id_fk": {
+ "name": "board_creator_id_user_id_fk",
+ "tableFrom": "board",
+ "tableTo": "user",
+ "columnsFrom": ["creator_id"],
+ "columnsTo": ["id"],
+ "onDelete": "set null",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "groupMember": {
+ "name": "groupMember",
+ "columns": {
+ "groupId": {
+ "name": "groupId",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "userId": {
+ "name": "userId",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "groupMember_groupId_group_id_fk": {
+ "name": "groupMember_groupId_group_id_fk",
+ "tableFrom": "groupMember",
+ "tableTo": "group",
+ "columnsFrom": ["groupId"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "groupMember_userId_user_id_fk": {
+ "name": "groupMember_userId_user_id_fk",
+ "tableFrom": "groupMember",
+ "tableTo": "user",
+ "columnsFrom": ["userId"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "groupMember_groupId_userId_pk": {
+ "columns": ["groupId", "userId"],
+ "name": "groupMember_groupId_userId_pk"
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "groupPermission": {
+ "name": "groupPermission",
+ "columns": {
+ "groupId": {
+ "name": "groupId",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "permission": {
+ "name": "permission",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "groupPermission_groupId_group_id_fk": {
+ "name": "groupPermission_groupId_group_id_fk",
+ "tableFrom": "groupPermission",
+ "tableTo": "group",
+ "columnsFrom": ["groupId"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "group": {
+ "name": "group",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "owner_id": {
+ "name": "owner_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "group_owner_id_user_id_fk": {
+ "name": "group_owner_id_user_id_fk",
+ "tableFrom": "group",
+ "tableTo": "user",
+ "columnsFrom": ["owner_id"],
+ "columnsTo": ["id"],
+ "onDelete": "set null",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "iconRepository": {
+ "name": "iconRepository",
+ "columns": {
+ "iconRepository_id": {
+ "name": "iconRepository_id",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "iconRepository_slug": {
+ "name": "iconRepository_slug",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {},
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "icon": {
+ "name": "icon",
+ "columns": {
+ "icon_id": {
+ "name": "icon_id",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "icon_name": {
+ "name": "icon_name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "icon_url": {
+ "name": "icon_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "icon_checksum": {
+ "name": "icon_checksum",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "iconRepository_id": {
+ "name": "iconRepository_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "icon_iconRepository_id_iconRepository_iconRepository_id_fk": {
+ "name": "icon_iconRepository_id_iconRepository_iconRepository_id_fk",
+ "tableFrom": "icon",
+ "tableTo": "iconRepository",
+ "columnsFrom": ["iconRepository_id"],
+ "columnsTo": ["iconRepository_id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "integration_item": {
+ "name": "integration_item",
+ "columns": {
+ "item_id": {
+ "name": "item_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "integration_id": {
+ "name": "integration_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "integration_item_item_id_item_id_fk": {
+ "name": "integration_item_item_id_item_id_fk",
+ "tableFrom": "integration_item",
+ "tableTo": "item",
+ "columnsFrom": ["item_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "integration_item_integration_id_integration_id_fk": {
+ "name": "integration_item_integration_id_integration_id_fk",
+ "tableFrom": "integration_item",
+ "tableTo": "integration",
+ "columnsFrom": ["integration_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "integration_item_item_id_integration_id_pk": {
+ "columns": ["integration_id", "item_id"],
+ "name": "integration_item_item_id_integration_id_pk"
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "integrationSecret": {
+ "name": "integrationSecret",
+ "columns": {
+ "kind": {
+ "name": "kind",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "value": {
+ "name": "value",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "updated_at": {
+ "name": "updated_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "integration_id": {
+ "name": "integration_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "integration_secret__kind_idx": {
+ "name": "integration_secret__kind_idx",
+ "columns": ["kind"],
+ "isUnique": false
+ },
+ "integration_secret__updated_at_idx": {
+ "name": "integration_secret__updated_at_idx",
+ "columns": ["updated_at"],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "integrationSecret_integration_id_integration_id_fk": {
+ "name": "integrationSecret_integration_id_integration_id_fk",
+ "tableFrom": "integrationSecret",
+ "tableTo": "integration",
+ "columnsFrom": ["integration_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "integrationSecret_integration_id_kind_pk": {
+ "columns": ["integration_id", "kind"],
+ "name": "integrationSecret_integration_id_kind_pk"
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "integration": {
+ "name": "integration",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "url": {
+ "name": "url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "kind": {
+ "name": "kind",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "integration__kind_idx": {
+ "name": "integration__kind_idx",
+ "columns": ["kind"],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {},
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "invite": {
+ "name": "invite",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "token": {
+ "name": "token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "expiration_date": {
+ "name": "expiration_date",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "creator_id": {
+ "name": "creator_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "invite_token_unique": {
+ "name": "invite_token_unique",
+ "columns": ["token"],
+ "isUnique": true
+ }
+ },
+ "foreignKeys": {
+ "invite_creator_id_user_id_fk": {
+ "name": "invite_creator_id_user_id_fk",
+ "tableFrom": "invite",
+ "tableTo": "user",
+ "columnsFrom": ["creator_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "item": {
+ "name": "item",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "section_id": {
+ "name": "section_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "kind": {
+ "name": "kind",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "x_offset": {
+ "name": "x_offset",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "y_offset": {
+ "name": "y_offset",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "width": {
+ "name": "width",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "height": {
+ "name": "height",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "options": {
+ "name": "options",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'{\"json\": {}}'"
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "item_section_id_section_id_fk": {
+ "name": "item_section_id_section_id_fk",
+ "tableFrom": "item",
+ "tableTo": "section",
+ "columnsFrom": ["section_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "section": {
+ "name": "section",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "board_id": {
+ "name": "board_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "kind": {
+ "name": "kind",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "position": {
+ "name": "position",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "section_board_id_board_id_fk": {
+ "name": "section_board_id_board_id_fk",
+ "tableFrom": "section",
+ "tableTo": "board",
+ "columnsFrom": ["board_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "session": {
+ "name": "session",
+ "columns": {
+ "sessionToken": {
+ "name": "sessionToken",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "userId": {
+ "name": "userId",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "expires": {
+ "name": "expires",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "user_id_idx": {
+ "name": "user_id_idx",
+ "columns": ["userId"],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "session_userId_user_id_fk": {
+ "name": "session_userId_user_id_fk",
+ "tableFrom": "session",
+ "tableTo": "user",
+ "columnsFrom": ["userId"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "user": {
+ "name": "user",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "email": {
+ "name": "email",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "emailVerified": {
+ "name": "emailVerified",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "image": {
+ "name": "image",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "password": {
+ "name": "password",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "salt": {
+ "name": "salt",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {},
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "verificationToken": {
+ "name": "verificationToken",
+ "columns": {
+ "identifier": {
+ "name": "identifier",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "token": {
+ "name": "token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "expires": {
+ "name": "expires",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {},
+ "compositePrimaryKeys": {
+ "verificationToken_identifier_token_pk": {
+ "columns": ["identifier", "token"],
+ "name": "verificationToken_identifier_token_pk"
+ }
+ },
+ "uniqueConstraints": {}
+ }
+ },
+ "enums": {},
+ "_meta": {
+ "schemas": {},
+ "tables": {},
+ "columns": {}
+ }
+}
diff --git a/packages/db/migrations/sqlite/meta/0001_snapshot.json b/packages/db/migrations/sqlite/meta/0001_snapshot.json
new file mode 100644
index 000000000..e5b1558cf
--- /dev/null
+++ b/packages/db/migrations/sqlite/meta/0001_snapshot.json
@@ -0,0 +1,1114 @@
+{
+ "version": "6",
+ "dialect": "sqlite",
+ "id": "2ed0ffc3-8612-42e7-bd8e-f5f8f3338a39",
+ "prevId": "0575873a-9e10-4480-8d7d-c47198622c22",
+ "tables": {
+ "account": {
+ "name": "account",
+ "columns": {
+ "userId": {
+ "name": "userId",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "type": {
+ "name": "type",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "provider": {
+ "name": "provider",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "providerAccountId": {
+ "name": "providerAccountId",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "refresh_token": {
+ "name": "refresh_token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "access_token": {
+ "name": "access_token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "expires_at": {
+ "name": "expires_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "token_type": {
+ "name": "token_type",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "scope": {
+ "name": "scope",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "id_token": {
+ "name": "id_token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "session_state": {
+ "name": "session_state",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "userId_idx": {
+ "name": "userId_idx",
+ "columns": ["userId"],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "account_userId_user_id_fk": {
+ "name": "account_userId_user_id_fk",
+ "tableFrom": "account",
+ "tableTo": "user",
+ "columnsFrom": ["userId"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "account_provider_providerAccountId_pk": {
+ "columns": ["provider", "providerAccountId"],
+ "name": "account_provider_providerAccountId_pk"
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "app": {
+ "name": "app",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "description": {
+ "name": "description",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "icon_url": {
+ "name": "icon_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "href": {
+ "name": "href",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {},
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "boardGroupPermission": {
+ "name": "boardGroupPermission",
+ "columns": {
+ "board_id": {
+ "name": "board_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "group_id": {
+ "name": "group_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "permission": {
+ "name": "permission",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "boardGroupPermission_board_id_board_id_fk": {
+ "name": "boardGroupPermission_board_id_board_id_fk",
+ "tableFrom": "boardGroupPermission",
+ "tableTo": "board",
+ "columnsFrom": ["board_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "boardGroupPermission_group_id_group_id_fk": {
+ "name": "boardGroupPermission_group_id_group_id_fk",
+ "tableFrom": "boardGroupPermission",
+ "tableTo": "group",
+ "columnsFrom": ["group_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "boardGroupPermission_board_id_group_id_permission_pk": {
+ "columns": ["board_id", "group_id", "permission"],
+ "name": "boardGroupPermission_board_id_group_id_permission_pk"
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "boardUserPermission": {
+ "name": "boardUserPermission",
+ "columns": {
+ "board_id": {
+ "name": "board_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "user_id": {
+ "name": "user_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "permission": {
+ "name": "permission",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "boardUserPermission_board_id_board_id_fk": {
+ "name": "boardUserPermission_board_id_board_id_fk",
+ "tableFrom": "boardUserPermission",
+ "tableTo": "board",
+ "columnsFrom": ["board_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "boardUserPermission_user_id_user_id_fk": {
+ "name": "boardUserPermission_user_id_user_id_fk",
+ "tableFrom": "boardUserPermission",
+ "tableTo": "user",
+ "columnsFrom": ["user_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "boardUserPermission_board_id_user_id_permission_pk": {
+ "columns": ["board_id", "permission", "user_id"],
+ "name": "boardUserPermission_board_id_user_id_permission_pk"
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "board": {
+ "name": "board",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "is_public": {
+ "name": "is_public",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": false
+ },
+ "creator_id": {
+ "name": "creator_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "page_title": {
+ "name": "page_title",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "meta_title": {
+ "name": "meta_title",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "logo_image_url": {
+ "name": "logo_image_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "favicon_image_url": {
+ "name": "favicon_image_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "background_image_url": {
+ "name": "background_image_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "background_image_attachment": {
+ "name": "background_image_attachment",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'fixed'"
+ },
+ "background_image_repeat": {
+ "name": "background_image_repeat",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'no-repeat'"
+ },
+ "background_image_size": {
+ "name": "background_image_size",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'cover'"
+ },
+ "primary_color": {
+ "name": "primary_color",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'#fa5252'"
+ },
+ "secondary_color": {
+ "name": "secondary_color",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'#fd7e14'"
+ },
+ "opacity": {
+ "name": "opacity",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": 100
+ },
+ "custom_css": {
+ "name": "custom_css",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "column_count": {
+ "name": "column_count",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": 10
+ }
+ },
+ "indexes": {
+ "board_name_unique": {
+ "name": "board_name_unique",
+ "columns": ["name"],
+ "isUnique": true
+ }
+ },
+ "foreignKeys": {
+ "board_creator_id_user_id_fk": {
+ "name": "board_creator_id_user_id_fk",
+ "tableFrom": "board",
+ "tableTo": "user",
+ "columnsFrom": ["creator_id"],
+ "columnsTo": ["id"],
+ "onDelete": "set null",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "groupMember": {
+ "name": "groupMember",
+ "columns": {
+ "groupId": {
+ "name": "groupId",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "userId": {
+ "name": "userId",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "groupMember_groupId_group_id_fk": {
+ "name": "groupMember_groupId_group_id_fk",
+ "tableFrom": "groupMember",
+ "tableTo": "group",
+ "columnsFrom": ["groupId"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "groupMember_userId_user_id_fk": {
+ "name": "groupMember_userId_user_id_fk",
+ "tableFrom": "groupMember",
+ "tableTo": "user",
+ "columnsFrom": ["userId"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "groupMember_groupId_userId_pk": {
+ "columns": ["groupId", "userId"],
+ "name": "groupMember_groupId_userId_pk"
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "groupPermission": {
+ "name": "groupPermission",
+ "columns": {
+ "groupId": {
+ "name": "groupId",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "permission": {
+ "name": "permission",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "groupPermission_groupId_group_id_fk": {
+ "name": "groupPermission_groupId_group_id_fk",
+ "tableFrom": "groupPermission",
+ "tableTo": "group",
+ "columnsFrom": ["groupId"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "group": {
+ "name": "group",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "owner_id": {
+ "name": "owner_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "group_owner_id_user_id_fk": {
+ "name": "group_owner_id_user_id_fk",
+ "tableFrom": "group",
+ "tableTo": "user",
+ "columnsFrom": ["owner_id"],
+ "columnsTo": ["id"],
+ "onDelete": "set null",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "iconRepository": {
+ "name": "iconRepository",
+ "columns": {
+ "iconRepository_id": {
+ "name": "iconRepository_id",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "iconRepository_slug": {
+ "name": "iconRepository_slug",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {},
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "icon": {
+ "name": "icon",
+ "columns": {
+ "icon_id": {
+ "name": "icon_id",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "icon_name": {
+ "name": "icon_name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "icon_url": {
+ "name": "icon_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "icon_checksum": {
+ "name": "icon_checksum",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "iconRepository_id": {
+ "name": "iconRepository_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "icon_iconRepository_id_iconRepository_iconRepository_id_fk": {
+ "name": "icon_iconRepository_id_iconRepository_iconRepository_id_fk",
+ "tableFrom": "icon",
+ "tableTo": "iconRepository",
+ "columnsFrom": ["iconRepository_id"],
+ "columnsTo": ["iconRepository_id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "integration_item": {
+ "name": "integration_item",
+ "columns": {
+ "item_id": {
+ "name": "item_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "integration_id": {
+ "name": "integration_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "integration_item_item_id_item_id_fk": {
+ "name": "integration_item_item_id_item_id_fk",
+ "tableFrom": "integration_item",
+ "tableTo": "item",
+ "columnsFrom": ["item_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "integration_item_integration_id_integration_id_fk": {
+ "name": "integration_item_integration_id_integration_id_fk",
+ "tableFrom": "integration_item",
+ "tableTo": "integration",
+ "columnsFrom": ["integration_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "integration_item_item_id_integration_id_pk": {
+ "columns": ["integration_id", "item_id"],
+ "name": "integration_item_item_id_integration_id_pk"
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "integrationSecret": {
+ "name": "integrationSecret",
+ "columns": {
+ "kind": {
+ "name": "kind",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "value": {
+ "name": "value",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "updated_at": {
+ "name": "updated_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "integration_id": {
+ "name": "integration_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "integration_secret__kind_idx": {
+ "name": "integration_secret__kind_idx",
+ "columns": ["kind"],
+ "isUnique": false
+ },
+ "integration_secret__updated_at_idx": {
+ "name": "integration_secret__updated_at_idx",
+ "columns": ["updated_at"],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "integrationSecret_integration_id_integration_id_fk": {
+ "name": "integrationSecret_integration_id_integration_id_fk",
+ "tableFrom": "integrationSecret",
+ "tableTo": "integration",
+ "columnsFrom": ["integration_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "integrationSecret_integration_id_kind_pk": {
+ "columns": ["integration_id", "kind"],
+ "name": "integrationSecret_integration_id_kind_pk"
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "integration": {
+ "name": "integration",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "url": {
+ "name": "url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "kind": {
+ "name": "kind",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "integration__kind_idx": {
+ "name": "integration__kind_idx",
+ "columns": ["kind"],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {},
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "invite": {
+ "name": "invite",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "token": {
+ "name": "token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "expiration_date": {
+ "name": "expiration_date",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "creator_id": {
+ "name": "creator_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "invite_token_unique": {
+ "name": "invite_token_unique",
+ "columns": ["token"],
+ "isUnique": true
+ }
+ },
+ "foreignKeys": {
+ "invite_creator_id_user_id_fk": {
+ "name": "invite_creator_id_user_id_fk",
+ "tableFrom": "invite",
+ "tableTo": "user",
+ "columnsFrom": ["creator_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "item": {
+ "name": "item",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "section_id": {
+ "name": "section_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "kind": {
+ "name": "kind",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "x_offset": {
+ "name": "x_offset",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "y_offset": {
+ "name": "y_offset",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "width": {
+ "name": "width",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "height": {
+ "name": "height",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "options": {
+ "name": "options",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'{\"json\": {}}'"
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "item_section_id_section_id_fk": {
+ "name": "item_section_id_section_id_fk",
+ "tableFrom": "item",
+ "tableTo": "section",
+ "columnsFrom": ["section_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "section": {
+ "name": "section",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "board_id": {
+ "name": "board_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "kind": {
+ "name": "kind",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "position": {
+ "name": "position",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "section_board_id_board_id_fk": {
+ "name": "section_board_id_board_id_fk",
+ "tableFrom": "section",
+ "tableTo": "board",
+ "columnsFrom": ["board_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "session": {
+ "name": "session",
+ "columns": {
+ "sessionToken": {
+ "name": "sessionToken",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "userId": {
+ "name": "userId",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "expires": {
+ "name": "expires",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "user_id_idx": {
+ "name": "user_id_idx",
+ "columns": ["userId"],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "session_userId_user_id_fk": {
+ "name": "session_userId_user_id_fk",
+ "tableFrom": "session",
+ "tableTo": "user",
+ "columnsFrom": ["userId"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "user": {
+ "name": "user",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "email": {
+ "name": "email",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "emailVerified": {
+ "name": "emailVerified",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "image": {
+ "name": "image",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "password": {
+ "name": "password",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "salt": {
+ "name": "salt",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "homeBoardId": {
+ "name": "homeBoardId",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "user_homeBoardId_board_id_fk": {
+ "name": "user_homeBoardId_board_id_fk",
+ "tableFrom": "user",
+ "tableTo": "board",
+ "columnsFrom": ["homeBoardId"],
+ "columnsTo": ["id"],
+ "onDelete": "set null",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "verificationToken": {
+ "name": "verificationToken",
+ "columns": {
+ "identifier": {
+ "name": "identifier",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "token": {
+ "name": "token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "expires": {
+ "name": "expires",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {},
+ "compositePrimaryKeys": {
+ "verificationToken_identifier_token_pk": {
+ "columns": ["identifier", "token"],
+ "name": "verificationToken_identifier_token_pk"
+ }
+ },
+ "uniqueConstraints": {}
+ }
+ },
+ "enums": {},
+ "_meta": {
+ "schemas": {},
+ "tables": {},
+ "columns": {}
+ }
+}
diff --git a/packages/db/migrations/sqlite/meta/0002_snapshot.json b/packages/db/migrations/sqlite/meta/0002_snapshot.json
new file mode 100644
index 000000000..885a5df37
--- /dev/null
+++ b/packages/db/migrations/sqlite/meta/0002_snapshot.json
@@ -0,0 +1,1122 @@
+{
+ "version": "6",
+ "dialect": "sqlite",
+ "id": "5ad60251-8450-437d-9081-a456884120d2",
+ "prevId": "0575873a-9e10-4480-8d7d-c47198622c22",
+ "tables": {
+ "account": {
+ "name": "account",
+ "columns": {
+ "userId": {
+ "name": "userId",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "type": {
+ "name": "type",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "provider": {
+ "name": "provider",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "providerAccountId": {
+ "name": "providerAccountId",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "refresh_token": {
+ "name": "refresh_token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "access_token": {
+ "name": "access_token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "expires_at": {
+ "name": "expires_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "token_type": {
+ "name": "token_type",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "scope": {
+ "name": "scope",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "id_token": {
+ "name": "id_token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "session_state": {
+ "name": "session_state",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "userId_idx": {
+ "name": "userId_idx",
+ "columns": ["userId"],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "account_userId_user_id_fk": {
+ "name": "account_userId_user_id_fk",
+ "tableFrom": "account",
+ "tableTo": "user",
+ "columnsFrom": ["userId"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "account_provider_providerAccountId_pk": {
+ "columns": ["provider", "providerAccountId"],
+ "name": "account_provider_providerAccountId_pk"
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "app": {
+ "name": "app",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "description": {
+ "name": "description",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "icon_url": {
+ "name": "icon_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "href": {
+ "name": "href",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {},
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "boardGroupPermission": {
+ "name": "boardGroupPermission",
+ "columns": {
+ "board_id": {
+ "name": "board_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "group_id": {
+ "name": "group_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "permission": {
+ "name": "permission",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "boardGroupPermission_board_id_board_id_fk": {
+ "name": "boardGroupPermission_board_id_board_id_fk",
+ "tableFrom": "boardGroupPermission",
+ "tableTo": "board",
+ "columnsFrom": ["board_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "boardGroupPermission_group_id_group_id_fk": {
+ "name": "boardGroupPermission_group_id_group_id_fk",
+ "tableFrom": "boardGroupPermission",
+ "tableTo": "group",
+ "columnsFrom": ["group_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "boardGroupPermission_board_id_group_id_permission_pk": {
+ "columns": ["board_id", "group_id", "permission"],
+ "name": "boardGroupPermission_board_id_group_id_permission_pk"
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "boardUserPermission": {
+ "name": "boardUserPermission",
+ "columns": {
+ "board_id": {
+ "name": "board_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "user_id": {
+ "name": "user_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "permission": {
+ "name": "permission",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "boardUserPermission_board_id_board_id_fk": {
+ "name": "boardUserPermission_board_id_board_id_fk",
+ "tableFrom": "boardUserPermission",
+ "tableTo": "board",
+ "columnsFrom": ["board_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "boardUserPermission_user_id_user_id_fk": {
+ "name": "boardUserPermission_user_id_user_id_fk",
+ "tableFrom": "boardUserPermission",
+ "tableTo": "user",
+ "columnsFrom": ["user_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "boardUserPermission_board_id_user_id_permission_pk": {
+ "columns": ["board_id", "permission", "user_id"],
+ "name": "boardUserPermission_board_id_user_id_permission_pk"
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "board": {
+ "name": "board",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "is_public": {
+ "name": "is_public",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": false
+ },
+ "creator_id": {
+ "name": "creator_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "page_title": {
+ "name": "page_title",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "meta_title": {
+ "name": "meta_title",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "logo_image_url": {
+ "name": "logo_image_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "favicon_image_url": {
+ "name": "favicon_image_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "background_image_url": {
+ "name": "background_image_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "background_image_attachment": {
+ "name": "background_image_attachment",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'fixed'"
+ },
+ "background_image_repeat": {
+ "name": "background_image_repeat",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'no-repeat'"
+ },
+ "background_image_size": {
+ "name": "background_image_size",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'cover'"
+ },
+ "primary_color": {
+ "name": "primary_color",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'#fa5252'"
+ },
+ "secondary_color": {
+ "name": "secondary_color",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'#fd7e14'"
+ },
+ "opacity": {
+ "name": "opacity",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": 100
+ },
+ "custom_css": {
+ "name": "custom_css",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "column_count": {
+ "name": "column_count",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": 10
+ }
+ },
+ "indexes": {
+ "board_name_unique": {
+ "name": "board_name_unique",
+ "columns": ["name"],
+ "isUnique": true
+ }
+ },
+ "foreignKeys": {
+ "board_creator_id_user_id_fk": {
+ "name": "board_creator_id_user_id_fk",
+ "tableFrom": "board",
+ "tableTo": "user",
+ "columnsFrom": ["creator_id"],
+ "columnsTo": ["id"],
+ "onDelete": "set null",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "groupMember": {
+ "name": "groupMember",
+ "columns": {
+ "groupId": {
+ "name": "groupId",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "userId": {
+ "name": "userId",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "groupMember_groupId_group_id_fk": {
+ "name": "groupMember_groupId_group_id_fk",
+ "tableFrom": "groupMember",
+ "tableTo": "group",
+ "columnsFrom": ["groupId"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "groupMember_userId_user_id_fk": {
+ "name": "groupMember_userId_user_id_fk",
+ "tableFrom": "groupMember",
+ "tableTo": "user",
+ "columnsFrom": ["userId"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "groupMember_groupId_userId_pk": {
+ "columns": ["groupId", "userId"],
+ "name": "groupMember_groupId_userId_pk"
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "groupPermission": {
+ "name": "groupPermission",
+ "columns": {
+ "groupId": {
+ "name": "groupId",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "permission": {
+ "name": "permission",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "groupPermission_groupId_group_id_fk": {
+ "name": "groupPermission_groupId_group_id_fk",
+ "tableFrom": "groupPermission",
+ "tableTo": "group",
+ "columnsFrom": ["groupId"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "group": {
+ "name": "group",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "owner_id": {
+ "name": "owner_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "group_owner_id_user_id_fk": {
+ "name": "group_owner_id_user_id_fk",
+ "tableFrom": "group",
+ "tableTo": "user",
+ "columnsFrom": ["owner_id"],
+ "columnsTo": ["id"],
+ "onDelete": "set null",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "iconRepository": {
+ "name": "iconRepository",
+ "columns": {
+ "iconRepository_id": {
+ "name": "iconRepository_id",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "iconRepository_slug": {
+ "name": "iconRepository_slug",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {},
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "icon": {
+ "name": "icon",
+ "columns": {
+ "icon_id": {
+ "name": "icon_id",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "icon_name": {
+ "name": "icon_name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "icon_url": {
+ "name": "icon_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "icon_checksum": {
+ "name": "icon_checksum",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "iconRepository_id": {
+ "name": "iconRepository_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "icon_iconRepository_id_iconRepository_iconRepository_id_fk": {
+ "name": "icon_iconRepository_id_iconRepository_iconRepository_id_fk",
+ "tableFrom": "icon",
+ "tableTo": "iconRepository",
+ "columnsFrom": ["iconRepository_id"],
+ "columnsTo": ["iconRepository_id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "integration_item": {
+ "name": "integration_item",
+ "columns": {
+ "item_id": {
+ "name": "item_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "integration_id": {
+ "name": "integration_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "integration_item_item_id_item_id_fk": {
+ "name": "integration_item_item_id_item_id_fk",
+ "tableFrom": "integration_item",
+ "tableTo": "item",
+ "columnsFrom": ["item_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "integration_item_integration_id_integration_id_fk": {
+ "name": "integration_item_integration_id_integration_id_fk",
+ "tableFrom": "integration_item",
+ "tableTo": "integration",
+ "columnsFrom": ["integration_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "integration_item_item_id_integration_id_pk": {
+ "columns": ["integration_id", "item_id"],
+ "name": "integration_item_item_id_integration_id_pk"
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "integrationSecret": {
+ "name": "integrationSecret",
+ "columns": {
+ "kind": {
+ "name": "kind",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "value": {
+ "name": "value",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "updated_at": {
+ "name": "updated_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "integration_id": {
+ "name": "integration_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "integration_secret__kind_idx": {
+ "name": "integration_secret__kind_idx",
+ "columns": ["kind"],
+ "isUnique": false
+ },
+ "integration_secret__updated_at_idx": {
+ "name": "integration_secret__updated_at_idx",
+ "columns": ["updated_at"],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "integrationSecret_integration_id_integration_id_fk": {
+ "name": "integrationSecret_integration_id_integration_id_fk",
+ "tableFrom": "integrationSecret",
+ "tableTo": "integration",
+ "columnsFrom": ["integration_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "integrationSecret_integration_id_kind_pk": {
+ "columns": ["integration_id", "kind"],
+ "name": "integrationSecret_integration_id_kind_pk"
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "integration": {
+ "name": "integration",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "url": {
+ "name": "url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "kind": {
+ "name": "kind",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "integration__kind_idx": {
+ "name": "integration__kind_idx",
+ "columns": ["kind"],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {},
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "invite": {
+ "name": "invite",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "token": {
+ "name": "token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "expiration_date": {
+ "name": "expiration_date",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "creator_id": {
+ "name": "creator_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "invite_token_unique": {
+ "name": "invite_token_unique",
+ "columns": ["token"],
+ "isUnique": true
+ }
+ },
+ "foreignKeys": {
+ "invite_creator_id_user_id_fk": {
+ "name": "invite_creator_id_user_id_fk",
+ "tableFrom": "invite",
+ "tableTo": "user",
+ "columnsFrom": ["creator_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "item": {
+ "name": "item",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "section_id": {
+ "name": "section_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "kind": {
+ "name": "kind",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "x_offset": {
+ "name": "x_offset",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "y_offset": {
+ "name": "y_offset",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "width": {
+ "name": "width",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "height": {
+ "name": "height",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "options": {
+ "name": "options",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'{\"json\": {}}'"
+ },
+ "advanced_options": {
+ "name": "advanced_options",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'{\"json\": {}}'"
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "item_section_id_section_id_fk": {
+ "name": "item_section_id_section_id_fk",
+ "tableFrom": "item",
+ "tableTo": "section",
+ "columnsFrom": ["section_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "section": {
+ "name": "section",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "board_id": {
+ "name": "board_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "kind": {
+ "name": "kind",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "position": {
+ "name": "position",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "section_board_id_board_id_fk": {
+ "name": "section_board_id_board_id_fk",
+ "tableFrom": "section",
+ "tableTo": "board",
+ "columnsFrom": ["board_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "session": {
+ "name": "session",
+ "columns": {
+ "sessionToken": {
+ "name": "sessionToken",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "userId": {
+ "name": "userId",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "expires": {
+ "name": "expires",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "user_id_idx": {
+ "name": "user_id_idx",
+ "columns": ["userId"],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "session_userId_user_id_fk": {
+ "name": "session_userId_user_id_fk",
+ "tableFrom": "session",
+ "tableTo": "user",
+ "columnsFrom": ["userId"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "user": {
+ "name": "user",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "email": {
+ "name": "email",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "emailVerified": {
+ "name": "emailVerified",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "image": {
+ "name": "image",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "password": {
+ "name": "password",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "salt": {
+ "name": "salt",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "homeBoardId": {
+ "name": "homeBoardId",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "user_homeBoardId_board_id_fk": {
+ "name": "user_homeBoardId_board_id_fk",
+ "tableFrom": "user",
+ "tableTo": "board",
+ "columnsFrom": ["homeBoardId"],
+ "columnsTo": ["id"],
+ "onDelete": "set null",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "verificationToken": {
+ "name": "verificationToken",
+ "columns": {
+ "identifier": {
+ "name": "identifier",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "token": {
+ "name": "token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "expires": {
+ "name": "expires",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {},
+ "compositePrimaryKeys": {
+ "verificationToken_identifier_token_pk": {
+ "columns": ["identifier", "token"],
+ "name": "verificationToken_identifier_token_pk"
+ }
+ },
+ "uniqueConstraints": {}
+ }
+ },
+ "enums": {},
+ "_meta": {
+ "schemas": {},
+ "tables": {},
+ "columns": {}
+ }
+}
diff --git a/packages/db/migrations/sqlite/meta/0003_snapshot.json b/packages/db/migrations/sqlite/meta/0003_snapshot.json
new file mode 100644
index 000000000..7324558d3
--- /dev/null
+++ b/packages/db/migrations/sqlite/meta/0003_snapshot.json
@@ -0,0 +1,1152 @@
+{
+ "version": "6",
+ "dialect": "sqlite",
+ "id": "b72fe407-31bc-4dd0-8c36-dbb8e42ef708",
+ "prevId": "5ad60251-8450-437d-9081-a456884120d2",
+ "tables": {
+ "account": {
+ "name": "account",
+ "columns": {
+ "userId": {
+ "name": "userId",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "type": {
+ "name": "type",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "provider": {
+ "name": "provider",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "providerAccountId": {
+ "name": "providerAccountId",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "refresh_token": {
+ "name": "refresh_token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "access_token": {
+ "name": "access_token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "expires_at": {
+ "name": "expires_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "token_type": {
+ "name": "token_type",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "scope": {
+ "name": "scope",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "id_token": {
+ "name": "id_token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "session_state": {
+ "name": "session_state",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "userId_idx": {
+ "name": "userId_idx",
+ "columns": ["userId"],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "account_userId_user_id_fk": {
+ "name": "account_userId_user_id_fk",
+ "tableFrom": "account",
+ "tableTo": "user",
+ "columnsFrom": ["userId"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "account_provider_providerAccountId_pk": {
+ "columns": ["provider", "providerAccountId"],
+ "name": "account_provider_providerAccountId_pk"
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "app": {
+ "name": "app",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "description": {
+ "name": "description",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "icon_url": {
+ "name": "icon_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "href": {
+ "name": "href",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {},
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "boardGroupPermission": {
+ "name": "boardGroupPermission",
+ "columns": {
+ "board_id": {
+ "name": "board_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "group_id": {
+ "name": "group_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "permission": {
+ "name": "permission",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "boardGroupPermission_board_id_board_id_fk": {
+ "name": "boardGroupPermission_board_id_board_id_fk",
+ "tableFrom": "boardGroupPermission",
+ "tableTo": "board",
+ "columnsFrom": ["board_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "boardGroupPermission_group_id_group_id_fk": {
+ "name": "boardGroupPermission_group_id_group_id_fk",
+ "tableFrom": "boardGroupPermission",
+ "tableTo": "group",
+ "columnsFrom": ["group_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "boardGroupPermission_board_id_group_id_permission_pk": {
+ "columns": ["board_id", "group_id", "permission"],
+ "name": "boardGroupPermission_board_id_group_id_permission_pk"
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "boardUserPermission": {
+ "name": "boardUserPermission",
+ "columns": {
+ "board_id": {
+ "name": "board_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "user_id": {
+ "name": "user_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "permission": {
+ "name": "permission",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "boardUserPermission_board_id_board_id_fk": {
+ "name": "boardUserPermission_board_id_board_id_fk",
+ "tableFrom": "boardUserPermission",
+ "tableTo": "board",
+ "columnsFrom": ["board_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "boardUserPermission_user_id_user_id_fk": {
+ "name": "boardUserPermission_user_id_user_id_fk",
+ "tableFrom": "boardUserPermission",
+ "tableTo": "user",
+ "columnsFrom": ["user_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "boardUserPermission_board_id_user_id_permission_pk": {
+ "columns": ["board_id", "permission", "user_id"],
+ "name": "boardUserPermission_board_id_user_id_permission_pk"
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "board": {
+ "name": "board",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "is_public": {
+ "name": "is_public",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": false
+ },
+ "creator_id": {
+ "name": "creator_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "page_title": {
+ "name": "page_title",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "meta_title": {
+ "name": "meta_title",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "logo_image_url": {
+ "name": "logo_image_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "favicon_image_url": {
+ "name": "favicon_image_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "background_image_url": {
+ "name": "background_image_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "background_image_attachment": {
+ "name": "background_image_attachment",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'fixed'"
+ },
+ "background_image_repeat": {
+ "name": "background_image_repeat",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'no-repeat'"
+ },
+ "background_image_size": {
+ "name": "background_image_size",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'cover'"
+ },
+ "primary_color": {
+ "name": "primary_color",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'#fa5252'"
+ },
+ "secondary_color": {
+ "name": "secondary_color",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'#fd7e14'"
+ },
+ "opacity": {
+ "name": "opacity",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": 100
+ },
+ "custom_css": {
+ "name": "custom_css",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "column_count": {
+ "name": "column_count",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": 10
+ }
+ },
+ "indexes": {
+ "board_name_unique": {
+ "name": "board_name_unique",
+ "columns": ["name"],
+ "isUnique": true
+ }
+ },
+ "foreignKeys": {
+ "board_creator_id_user_id_fk": {
+ "name": "board_creator_id_user_id_fk",
+ "tableFrom": "board",
+ "tableTo": "user",
+ "columnsFrom": ["creator_id"],
+ "columnsTo": ["id"],
+ "onDelete": "set null",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "groupMember": {
+ "name": "groupMember",
+ "columns": {
+ "groupId": {
+ "name": "groupId",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "userId": {
+ "name": "userId",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "groupMember_groupId_group_id_fk": {
+ "name": "groupMember_groupId_group_id_fk",
+ "tableFrom": "groupMember",
+ "tableTo": "group",
+ "columnsFrom": ["groupId"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "groupMember_userId_user_id_fk": {
+ "name": "groupMember_userId_user_id_fk",
+ "tableFrom": "groupMember",
+ "tableTo": "user",
+ "columnsFrom": ["userId"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "groupMember_groupId_userId_pk": {
+ "columns": ["groupId", "userId"],
+ "name": "groupMember_groupId_userId_pk"
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "groupPermission": {
+ "name": "groupPermission",
+ "columns": {
+ "groupId": {
+ "name": "groupId",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "permission": {
+ "name": "permission",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "groupPermission_groupId_group_id_fk": {
+ "name": "groupPermission_groupId_group_id_fk",
+ "tableFrom": "groupPermission",
+ "tableTo": "group",
+ "columnsFrom": ["groupId"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "group": {
+ "name": "group",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "owner_id": {
+ "name": "owner_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "group_owner_id_user_id_fk": {
+ "name": "group_owner_id_user_id_fk",
+ "tableFrom": "group",
+ "tableTo": "user",
+ "columnsFrom": ["owner_id"],
+ "columnsTo": ["id"],
+ "onDelete": "set null",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "iconRepository": {
+ "name": "iconRepository",
+ "columns": {
+ "iconRepository_id": {
+ "name": "iconRepository_id",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "iconRepository_slug": {
+ "name": "iconRepository_slug",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {},
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "icon": {
+ "name": "icon",
+ "columns": {
+ "icon_id": {
+ "name": "icon_id",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "icon_name": {
+ "name": "icon_name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "icon_url": {
+ "name": "icon_url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "icon_checksum": {
+ "name": "icon_checksum",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "iconRepository_id": {
+ "name": "iconRepository_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "icon_iconRepository_id_iconRepository_iconRepository_id_fk": {
+ "name": "icon_iconRepository_id_iconRepository_iconRepository_id_fk",
+ "tableFrom": "icon",
+ "tableTo": "iconRepository",
+ "columnsFrom": ["iconRepository_id"],
+ "columnsTo": ["iconRepository_id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "integration_item": {
+ "name": "integration_item",
+ "columns": {
+ "item_id": {
+ "name": "item_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "integration_id": {
+ "name": "integration_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "integration_item_item_id_item_id_fk": {
+ "name": "integration_item_item_id_item_id_fk",
+ "tableFrom": "integration_item",
+ "tableTo": "item",
+ "columnsFrom": ["item_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ },
+ "integration_item_integration_id_integration_id_fk": {
+ "name": "integration_item_integration_id_integration_id_fk",
+ "tableFrom": "integration_item",
+ "tableTo": "integration",
+ "columnsFrom": ["integration_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "integration_item_item_id_integration_id_pk": {
+ "columns": ["integration_id", "item_id"],
+ "name": "integration_item_item_id_integration_id_pk"
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "integrationSecret": {
+ "name": "integrationSecret",
+ "columns": {
+ "kind": {
+ "name": "kind",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "value": {
+ "name": "value",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "updated_at": {
+ "name": "updated_at",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "integration_id": {
+ "name": "integration_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "integration_secret__kind_idx": {
+ "name": "integration_secret__kind_idx",
+ "columns": ["kind"],
+ "isUnique": false
+ },
+ "integration_secret__updated_at_idx": {
+ "name": "integration_secret__updated_at_idx",
+ "columns": ["updated_at"],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "integrationSecret_integration_id_integration_id_fk": {
+ "name": "integrationSecret_integration_id_integration_id_fk",
+ "tableFrom": "integrationSecret",
+ "tableTo": "integration",
+ "columnsFrom": ["integration_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {
+ "integrationSecret_integration_id_kind_pk": {
+ "columns": ["integration_id", "kind"],
+ "name": "integrationSecret_integration_id_kind_pk"
+ }
+ },
+ "uniqueConstraints": {}
+ },
+ "integration": {
+ "name": "integration",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "url": {
+ "name": "url",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "kind": {
+ "name": "kind",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "integration__kind_idx": {
+ "name": "integration__kind_idx",
+ "columns": ["kind"],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {},
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "invite": {
+ "name": "invite",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "token": {
+ "name": "token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "expiration_date": {
+ "name": "expiration_date",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "creator_id": {
+ "name": "creator_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "invite_token_unique": {
+ "name": "invite_token_unique",
+ "columns": ["token"],
+ "isUnique": true
+ }
+ },
+ "foreignKeys": {
+ "invite_creator_id_user_id_fk": {
+ "name": "invite_creator_id_user_id_fk",
+ "tableFrom": "invite",
+ "tableTo": "user",
+ "columnsFrom": ["creator_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "item": {
+ "name": "item",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "section_id": {
+ "name": "section_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "kind": {
+ "name": "kind",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "x_offset": {
+ "name": "x_offset",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "y_offset": {
+ "name": "y_offset",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "width": {
+ "name": "width",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "height": {
+ "name": "height",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "options": {
+ "name": "options",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'{\"json\": {}}'"
+ },
+ "advanced_options": {
+ "name": "advanced_options",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'{\"json\": {}}'"
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "item_section_id_section_id_fk": {
+ "name": "item_section_id_section_id_fk",
+ "tableFrom": "item",
+ "tableTo": "section",
+ "columnsFrom": ["section_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "section": {
+ "name": "section",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "board_id": {
+ "name": "board_id",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "kind": {
+ "name": "kind",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "position": {
+ "name": "position",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "section_board_id_board_id_fk": {
+ "name": "section_board_id_board_id_fk",
+ "tableFrom": "section",
+ "tableTo": "board",
+ "columnsFrom": ["board_id"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "serverSetting": {
+ "name": "serverSetting",
+ "columns": {
+ "key": {
+ "name": "key",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "value": {
+ "name": "value",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false,
+ "default": "'{\"json\": {}}'"
+ }
+ },
+ "indexes": {
+ "serverSetting_key_unique": {
+ "name": "serverSetting_key_unique",
+ "columns": ["key"],
+ "isUnique": true
+ }
+ },
+ "foreignKeys": {},
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "session": {
+ "name": "session",
+ "columns": {
+ "sessionToken": {
+ "name": "sessionToken",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "userId": {
+ "name": "userId",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "expires": {
+ "name": "expires",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {
+ "user_id_idx": {
+ "name": "user_id_idx",
+ "columns": ["userId"],
+ "isUnique": false
+ }
+ },
+ "foreignKeys": {
+ "session_userId_user_id_fk": {
+ "name": "session_userId_user_id_fk",
+ "tableFrom": "session",
+ "tableTo": "user",
+ "columnsFrom": ["userId"],
+ "columnsTo": ["id"],
+ "onDelete": "cascade",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "user": {
+ "name": "user",
+ "columns": {
+ "id": {
+ "name": "id",
+ "type": "text",
+ "primaryKey": true,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "name": {
+ "name": "name",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "email": {
+ "name": "email",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "emailVerified": {
+ "name": "emailVerified",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "image": {
+ "name": "image",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "password": {
+ "name": "password",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "salt": {
+ "name": "salt",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ },
+ "homeBoardId": {
+ "name": "homeBoardId",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": false,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {
+ "user_homeBoardId_board_id_fk": {
+ "name": "user_homeBoardId_board_id_fk",
+ "tableFrom": "user",
+ "tableTo": "board",
+ "columnsFrom": ["homeBoardId"],
+ "columnsTo": ["id"],
+ "onDelete": "set null",
+ "onUpdate": "no action"
+ }
+ },
+ "compositePrimaryKeys": {},
+ "uniqueConstraints": {}
+ },
+ "verificationToken": {
+ "name": "verificationToken",
+ "columns": {
+ "identifier": {
+ "name": "identifier",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "token": {
+ "name": "token",
+ "type": "text",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ },
+ "expires": {
+ "name": "expires",
+ "type": "integer",
+ "primaryKey": false,
+ "notNull": true,
+ "autoincrement": false
+ }
+ },
+ "indexes": {},
+ "foreignKeys": {},
+ "compositePrimaryKeys": {
+ "verificationToken_identifier_token_pk": {
+ "columns": ["identifier", "token"],
+ "name": "verificationToken_identifier_token_pk"
+ }
+ },
+ "uniqueConstraints": {}
+ }
+ },
+ "enums": {},
+ "_meta": {
+ "schemas": {},
+ "tables": {},
+ "columns": {}
+ }
+}
diff --git a/packages/db/migrations/sqlite/meta/_journal.json b/packages/db/migrations/sqlite/meta/_journal.json
new file mode 100644
index 000000000..5d9bc2d12
--- /dev/null
+++ b/packages/db/migrations/sqlite/meta/_journal.json
@@ -0,0 +1,34 @@
+{
+ "version": "6",
+ "dialect": "sqlite",
+ "entries": [
+ {
+ "idx": 0,
+ "version": "6",
+ "when": 1715334238443,
+ "tag": "0000_talented_ben_parker",
+ "breakpoints": true
+ },
+ {
+ "idx": 1,
+ "version": "6",
+ "when": 1715871797713,
+ "tag": "0001_mixed_titanium_man",
+ "breakpoints": true
+ },
+ {
+ "idx": 2,
+ "version": "6",
+ "when": 1715973963014,
+ "tag": "0002_cooing_sumo",
+ "breakpoints": true
+ },
+ {
+ "idx": 3,
+ "version": "6",
+ "when": 1716148434186,
+ "tag": "0003_adorable_raider",
+ "breakpoints": true
+ }
+ ]
+}
diff --git a/packages/db/migrations/sqlite/migrate.ts b/packages/db/migrations/sqlite/migrate.ts
new file mode 100644
index 000000000..abef5ea9d
--- /dev/null
+++ b/packages/db/migrations/sqlite/migrate.ts
@@ -0,0 +1,11 @@
+import Database from "better-sqlite3";
+import { drizzle } from "drizzle-orm/better-sqlite3";
+import { migrate } from "drizzle-orm/better-sqlite3/migrator";
+
+const migrationsFolder = process.argv[2] ?? ".";
+
+const sqlite = new Database(process.env.DB_URL?.replace("file:", ""));
+
+const db = drizzle(sqlite);
+
+migrate(db, { migrationsFolder });
diff --git a/packages/db/package.json b/packages/db/package.json
index 0b520e625..0f83d7466 100644
--- a/packages/db/package.json
+++ b/packages/db/package.json
@@ -1,35 +1,52 @@
{
"name": "@homarr/db",
"version": "0.1.0",
+ "type": "module",
+ "exports": {
+ ".": "./index.ts",
+ "./client": "./client.ts",
+ "./schema/sqlite": "./schema/sqlite.ts",
+ "./test": "./test/index.ts"
+ },
"private": true,
"main": "./index.ts",
"types": "./index.ts",
"license": "MIT",
"scripts": {
+ "build": "pnpm run build:sqlite && pnpm run build:mysql",
+ "build:sqlite": "esbuild migrations/sqlite/migrate.ts --bundle --platform=node --outfile=migrations/sqlite/migrate.cjs",
+ "build:mysql": "esbuild migrations/mysql/migrate.ts --bundle --platform=node --outfile=migrations/mysql/migrate.cjs",
"clean": "rm -rf .turbo node_modules",
"lint": "eslint .",
"format": "prettier --check . --ignore-path ../../.gitignore",
- "push": "drizzle-kit push:sqlite",
- "studio": "drizzle-kit studio",
+ "migration:sqlite:generate": "drizzle-kit generate --config ./configs/sqlite.config.ts",
+ "migration:sqlite:run": "drizzle-kit migrate --config ./configs/sqlite.config.ts",
+ "migration:mysql:generate": "drizzle-kit generate --config ./configs/mysql.config.ts",
+ "migration:mysql:run": "drizzle-kit migrate --config ./configs/mysql.config.ts",
+ "push:sqlite": "drizzle-kit push --config ./configs/sqlite.config.ts",
+ "push:mysql": "drizzle-kit push --config ./configs/mysql.config.ts",
+ "studio": "drizzle-kit studio --config ./configs/sqlite.config.ts",
"typecheck": "tsc --noEmit"
},
"dependencies": {
"@homarr/common": "workspace:^0.1.0",
"@homarr/definitions": "workspace:^0.1.0",
+ "@homarr/log": "workspace:^0.1.0",
"@paralleldrive/cuid2": "^2.2.2",
- "better-sqlite3": "^9.2.2",
- "drizzle-orm": "^0.29.3"
+ "better-sqlite3": "^10.0.0",
+ "drizzle-orm": "^0.30.10",
+ "mysql2": "3.9.7",
+ "drizzle-kit": "^0.21.2"
},
"devDependencies": {
"@homarr/eslint-config": "workspace:^0.2.0",
"@homarr/prettier-config": "workspace:^0.1.0",
"@homarr/tsconfig": "workspace:^0.1.0",
- "@types/better-sqlite3": "7.6.8",
- "dotenv-cli": "^7.3.0",
- "drizzle-kit": "^0.20.9",
- "eslint": "^8.56.0",
- "prettier": "^3.1.0",
- "typescript": "^5.3.3"
+ "@types/better-sqlite3": "7.6.10",
+ "dotenv-cli": "^7.4.2",
+ "eslint": "^8.57.0",
+ "prettier": "^3.2.5",
+ "typescript": "^5.4.5"
},
"eslintConfig": {
"root": true,
diff --git a/packages/db/schema/mysql.ts b/packages/db/schema/mysql.ts
new file mode 100644
index 000000000..d53a9ec30
--- /dev/null
+++ b/packages/db/schema/mysql.ts
@@ -0,0 +1,432 @@
+import type { AdapterAccount } from "@auth/core/adapters";
+import { relations } from "drizzle-orm";
+import type { AnyMySqlColumn } from "drizzle-orm/mysql-core";
+import { boolean, index, int, mysqlTable, primaryKey, text, timestamp, varchar } from "drizzle-orm/mysql-core";
+
+import type {
+ BackgroundImageAttachment,
+ BackgroundImageRepeat,
+ BackgroundImageSize,
+ BoardPermission,
+ GroupPermissionKey,
+ IntegrationKind,
+ IntegrationSecretKind,
+ SectionKind,
+ WidgetKind,
+} from "@homarr/definitions";
+import { backgroundImageAttachments, backgroundImageRepeats, backgroundImageSizes } from "@homarr/definitions";
+
+export const users = mysqlTable("user", {
+ id: varchar("id", { length: 64 }).notNull().primaryKey(),
+ name: text("name"),
+ email: text("email"),
+ emailVerified: timestamp("emailVerified"),
+ image: text("image"),
+ password: text("password"),
+ salt: text("salt"),
+ homeBoardId: varchar("homeBoardId", { length: 64 }).references((): AnyMySqlColumn => boards.id, {
+ onDelete: "set null",
+ }),
+});
+
+export const accounts = mysqlTable(
+ "account",
+ {
+ userId: varchar("userId", { length: 64 })
+ .notNull()
+ .references(() => users.id, { onDelete: "cascade" }),
+ type: text("type").$type().notNull(),
+ provider: varchar("provider", { length: 64 }).notNull(),
+ providerAccountId: varchar("providerAccountId", { length: 64 }).notNull(),
+ refresh_token: text("refresh_token"),
+ access_token: text("access_token"),
+ expires_at: int("expires_at"),
+ token_type: text("token_type"),
+ scope: text("scope"),
+ id_token: text("id_token"),
+ session_state: text("session_state"),
+ },
+ (account) => ({
+ compoundKey: primaryKey({
+ columns: [account.provider, account.providerAccountId],
+ }),
+ userIdIdx: index("userId_idx").on(account.userId),
+ }),
+);
+
+export const sessions = mysqlTable(
+ "session",
+ {
+ sessionToken: varchar("sessionToken", { length: 512 }).notNull().primaryKey(),
+ userId: varchar("userId", { length: 64 })
+ .notNull()
+ .references(() => users.id, { onDelete: "cascade" }),
+ expires: timestamp("expires").notNull(),
+ },
+ (session) => ({
+ userIdIdx: index("user_id_idx").on(session.userId),
+ }),
+);
+
+export const verificationTokens = mysqlTable(
+ "verificationToken",
+ {
+ identifier: varchar("identifier", { length: 64 }).notNull(),
+ token: varchar("token", { length: 512 }).notNull(),
+ expires: timestamp("expires").notNull(),
+ },
+ (verificationToken) => ({
+ compoundKey: primaryKey({
+ columns: [verificationToken.identifier, verificationToken.token],
+ }),
+ }),
+);
+
+export const groupMembers = mysqlTable(
+ "groupMember",
+ {
+ groupId: varchar("groupId", { length: 64 })
+ .notNull()
+ .references(() => groups.id, { onDelete: "cascade" }),
+ userId: varchar("userId", { length: 64 })
+ .notNull()
+ .references(() => users.id, { onDelete: "cascade" }),
+ },
+ (groupMember) => ({
+ compoundKey: primaryKey({
+ columns: [groupMember.groupId, groupMember.userId],
+ }),
+ }),
+);
+
+export const groups = mysqlTable("group", {
+ id: varchar("id", { length: 64 }).notNull().primaryKey(),
+ name: varchar("name", { length: 64 }).notNull(),
+ ownerId: varchar("owner_id", { length: 64 }).references(() => users.id, {
+ onDelete: "set null",
+ }),
+});
+
+export const groupPermissions = mysqlTable("groupPermission", {
+ groupId: varchar("groupId", { length: 64 })
+ .notNull()
+ .references(() => groups.id, { onDelete: "cascade" }),
+ permission: text("permission").$type().notNull(),
+});
+
+export const invites = mysqlTable("invite", {
+ id: varchar("id", { length: 64 }).notNull().primaryKey(),
+ token: varchar("token", { length: 512 }).notNull().unique(),
+ expirationDate: timestamp("expiration_date").notNull(),
+ creatorId: varchar("creator_id", { length: 64 })
+ .notNull()
+ .references(() => users.id, { onDelete: "cascade" }),
+});
+
+export const integrations = mysqlTable(
+ "integration",
+ {
+ id: varchar("id", { length: 64 }).notNull().primaryKey(),
+ name: text("name").notNull(),
+ url: text("url").notNull(),
+ kind: varchar("kind", { length: 128 }).$type().notNull(),
+ },
+ (integrations) => ({
+ kindIdx: index("integration__kind_idx").on(integrations.kind),
+ }),
+);
+
+export const integrationSecrets = mysqlTable(
+ "integrationSecret",
+ {
+ kind: varchar("kind", { length: 16 }).$type().notNull(),
+ value: text("value").$type<`${string}.${string}`>().notNull(),
+ updatedAt: timestamp("updated_at").notNull(),
+ integrationId: varchar("integration_id", { length: 64 })
+ .notNull()
+ .references(() => integrations.id, { onDelete: "cascade" }),
+ },
+ (integrationSecret) => ({
+ compoundKey: primaryKey({
+ columns: [integrationSecret.integrationId, integrationSecret.kind],
+ }),
+ kindIdx: index("integration_secret__kind_idx").on(integrationSecret.kind),
+ updatedAtIdx: index("integration_secret__updated_at_idx").on(integrationSecret.updatedAt),
+ }),
+);
+
+export const boards = mysqlTable("board", {
+ id: varchar("id", { length: 64 }).notNull().primaryKey(),
+ name: varchar("name", { length: 256 }).unique().notNull(),
+ isPublic: boolean("is_public").default(false).notNull(),
+ creatorId: varchar("creator_id", { length: 64 }).references(() => users.id, {
+ onDelete: "set null",
+ }),
+ pageTitle: text("page_title"),
+ metaTitle: text("meta_title"),
+ logoImageUrl: text("logo_image_url"),
+ faviconImageUrl: text("favicon_image_url"),
+ backgroundImageUrl: text("background_image_url"),
+ backgroundImageAttachment: text("background_image_attachment")
+ .$type()
+ .default(backgroundImageAttachments.defaultValue)
+ .notNull(),
+ backgroundImageRepeat: text("background_image_repeat")
+ .$type()
+ .default(backgroundImageRepeats.defaultValue)
+ .notNull(),
+ backgroundImageSize: text("background_image_size")
+ .$type()
+ .default(backgroundImageSizes.defaultValue)
+ .notNull(),
+ primaryColor: text("primary_color").default("#fa5252").notNull(),
+ secondaryColor: text("secondary_color").default("#fd7e14").notNull(),
+ opacity: int("opacity").default(100).notNull(),
+ customCss: text("custom_css"),
+ columnCount: int("column_count").default(10).notNull(),
+});
+
+export const boardUserPermissions = mysqlTable(
+ "boardUserPermission",
+ {
+ boardId: varchar("board_id", { length: 64 })
+ .notNull()
+ .references(() => boards.id, { onDelete: "cascade" }),
+ userId: varchar("user_id", { length: 64 })
+ .notNull()
+ .references(() => users.id, { onDelete: "cascade" }),
+ permission: varchar("permission", { length: 128 }).$type().notNull(),
+ },
+ (table) => ({
+ compoundKey: primaryKey({
+ columns: [table.boardId, table.userId, table.permission],
+ }),
+ }),
+);
+
+export const boardGroupPermissions = mysqlTable(
+ "boardGroupPermission",
+ {
+ boardId: varchar("board_id", { length: 64 })
+ .notNull()
+ .references(() => boards.id, { onDelete: "cascade" }),
+ groupId: varchar("group_id", { length: 64 })
+ .notNull()
+ .references(() => groups.id, { onDelete: "cascade" }),
+ permission: varchar("permission", { length: 128 }).$type().notNull(),
+ },
+ (table) => ({
+ compoundKey: primaryKey({
+ columns: [table.boardId, table.groupId, table.permission],
+ }),
+ }),
+);
+
+export const sections = mysqlTable("section", {
+ id: varchar("id", { length: 64 }).notNull().primaryKey(),
+ boardId: varchar("board_id", { length: 64 })
+ .notNull()
+ .references(() => boards.id, { onDelete: "cascade" }),
+ kind: text("kind").$type().notNull(),
+ position: int("position").notNull(),
+ name: text("name"),
+});
+
+export const items = mysqlTable("item", {
+ id: varchar("id", { length: 64 }).notNull().primaryKey(),
+ sectionId: varchar("section_id", { length: 64 })
+ .notNull()
+ .references(() => sections.id, { onDelete: "cascade" }),
+ kind: text("kind").$type().notNull(),
+ xOffset: int("x_offset").notNull(),
+ yOffset: int("y_offset").notNull(),
+ width: int("width").notNull(),
+ height: int("height").notNull(),
+ options: text("options").default('{"json": {}}').notNull(), // empty superjson object
+ advancedOptions: text("advanced_options").default('{"json": {}}').notNull(), // empty superjson object
+});
+
+export const apps = mysqlTable("app", {
+ id: varchar("id", { length: 64 }).notNull().primaryKey(),
+ name: text("name").notNull(),
+ description: text("description"),
+ iconUrl: text("icon_url").notNull(),
+ href: text("href"),
+});
+
+export const integrationItems = mysqlTable(
+ "integration_item",
+ {
+ itemId: varchar("item_id", { length: 64 })
+ .notNull()
+ .references(() => items.id, { onDelete: "cascade" }),
+ integrationId: varchar("integration_id", { length: 64 })
+ .notNull()
+ .references(() => integrations.id, { onDelete: "cascade" }),
+ },
+ (table) => ({
+ compoundKey: primaryKey({
+ columns: [table.itemId, table.integrationId],
+ }),
+ }),
+);
+
+export const icons = mysqlTable("icon", {
+ id: varchar("icon_id", { length: 64 }).notNull().primaryKey(),
+ name: varchar("icon_name", { length: 250 }).notNull(),
+ url: text("icon_url").notNull(),
+ checksum: text("icon_checksum").notNull(),
+ iconRepositoryId: varchar("iconRepository_id", { length: 64 })
+ .notNull()
+ .references(() => iconRepositories.id, { onDelete: "cascade" }),
+});
+
+export const iconRepositories = mysqlTable("iconRepository", {
+ id: varchar("iconRepository_id", { length: 64 }).notNull().primaryKey(),
+ slug: varchar("iconRepository_slug", { length: 150 }).notNull(),
+});
+
+export const serverSettings = mysqlTable("serverSetting", {
+ settingKey: varchar("key", { length: 64 }).notNull().unique().primaryKey(),
+ value: text("value").default('{"json": {}}').notNull(), // empty superjson object
+});
+
+export const accountRelations = relations(accounts, ({ one }) => ({
+ user: one(users, {
+ fields: [accounts.userId],
+ references: [users.id],
+ }),
+}));
+
+export const userRelations = relations(users, ({ many }) => ({
+ accounts: many(accounts),
+ boards: many(boards),
+ boardPermissions: many(boardUserPermissions),
+ groups: many(groupMembers),
+ ownedGroups: many(groups),
+ invites: many(invites),
+}));
+
+export const iconRelations = relations(icons, ({ one }) => ({
+ repository: one(iconRepositories, {
+ fields: [icons.iconRepositoryId],
+ references: [iconRepositories.id],
+ }),
+}));
+
+export const iconRepositoryRelations = relations(iconRepositories, ({ many }) => ({
+ icons: many(icons),
+}));
+
+export const inviteRelations = relations(invites, ({ one }) => ({
+ creator: one(users, {
+ fields: [invites.creatorId],
+ references: [users.id],
+ }),
+}));
+
+export const sessionRelations = relations(sessions, ({ one }) => ({
+ user: one(users, {
+ fields: [sessions.userId],
+ references: [users.id],
+ }),
+}));
+
+export const groupMemberRelations = relations(groupMembers, ({ one }) => ({
+ group: one(groups, {
+ fields: [groupMembers.groupId],
+ references: [groups.id],
+ }),
+ user: one(users, {
+ fields: [groupMembers.userId],
+ references: [users.id],
+ }),
+}));
+
+export const groupRelations = relations(groups, ({ one, many }) => ({
+ permissions: many(groupPermissions),
+ boardPermissions: many(boardGroupPermissions),
+ members: many(groupMembers),
+ owner: one(users, {
+ fields: [groups.ownerId],
+ references: [users.id],
+ }),
+}));
+
+export const groupPermissionRelations = relations(groupPermissions, ({ one }) => ({
+ group: one(groups, {
+ fields: [groupPermissions.groupId],
+ references: [groups.id],
+ }),
+}));
+
+export const boardUserPermissionRelations = relations(boardUserPermissions, ({ one }) => ({
+ user: one(users, {
+ fields: [boardUserPermissions.userId],
+ references: [users.id],
+ }),
+ board: one(boards, {
+ fields: [boardUserPermissions.boardId],
+ references: [boards.id],
+ }),
+}));
+
+export const boardGroupPermissionRelations = relations(boardGroupPermissions, ({ one }) => ({
+ group: one(groups, {
+ fields: [boardGroupPermissions.groupId],
+ references: [groups.id],
+ }),
+ board: one(boards, {
+ fields: [boardGroupPermissions.boardId],
+ references: [boards.id],
+ }),
+}));
+
+export const integrationRelations = relations(integrations, ({ many }) => ({
+ secrets: many(integrationSecrets),
+ items: many(integrationItems),
+}));
+
+export const integrationSecretRelations = relations(integrationSecrets, ({ one }) => ({
+ integration: one(integrations, {
+ fields: [integrationSecrets.integrationId],
+ references: [integrations.id],
+ }),
+}));
+
+export const boardRelations = relations(boards, ({ many, one }) => ({
+ sections: many(sections),
+ creator: one(users, {
+ fields: [boards.creatorId],
+ references: [users.id],
+ }),
+ userPermissions: many(boardUserPermissions),
+ groupPermissions: many(boardGroupPermissions),
+}));
+
+export const sectionRelations = relations(sections, ({ many, one }) => ({
+ items: many(items),
+ board: one(boards, {
+ fields: [sections.boardId],
+ references: [boards.id],
+ }),
+}));
+
+export const itemRelations = relations(items, ({ one, many }) => ({
+ section: one(sections, {
+ fields: [items.sectionId],
+ references: [sections.id],
+ }),
+ integrations: many(integrationItems),
+}));
+
+export const integrationItemRelations = relations(integrationItems, ({ one }) => ({
+ integration: one(integrations, {
+ fields: [integrationItems.integrationId],
+ references: [integrations.id],
+ }),
+ item: one(items, {
+ fields: [integrationItems.itemId],
+ references: [items.id],
+ }),
+}));
diff --git a/packages/db/schema/sqlite.ts b/packages/db/schema/sqlite.ts
index b25b99dce..f7c3c87e5 100644
--- a/packages/db/schema/sqlite.ts
+++ b/packages/db/schema/sqlite.ts
@@ -1,17 +1,20 @@
import type { AdapterAccount } from "@auth/core/adapters";
import type { InferSelectModel } from "drizzle-orm";
import { relations } from "drizzle-orm";
-import {
- index,
- integer,
- primaryKey,
- sqliteTable,
- text,
-} from "drizzle-orm/sqlite-core";
+import type { AnySQLiteColumn } from "drizzle-orm/sqlite-core";
+import { index, int, integer, primaryKey, sqliteTable, text } from "drizzle-orm/sqlite-core";
+import { backgroundImageAttachments, backgroundImageRepeats, backgroundImageSizes } from "@homarr/definitions";
import type {
+ BackgroundImageAttachment,
+ BackgroundImageRepeat,
+ BackgroundImageSize,
+ BoardPermission,
+ GroupPermissionKey,
IntegrationKind,
IntegrationSecretKind,
+ SectionKind,
+ WidgetKind,
} from "@homarr/definitions";
export const users = sqliteTable("user", {
@@ -22,6 +25,9 @@ export const users = sqliteTable("user", {
image: text("image"),
password: text("password"),
salt: text("salt"),
+ homeBoardId: text("homeBoardId").references((): AnySQLiteColumn => boards.id, {
+ onDelete: "set null",
+ }),
});
export const accounts = sqliteTable(
@@ -70,11 +76,56 @@ export const verificationTokens = sqliteTable(
token: text("token").notNull(),
expires: integer("expires", { mode: "timestamp_ms" }).notNull(),
},
- (vt) => ({
- compoundKey: primaryKey({ columns: [vt.identifier, vt.token] }),
+ (verificationToken) => ({
+ compoundKey: primaryKey({
+ columns: [verificationToken.identifier, verificationToken.token],
+ }),
+ }),
+);
+
+export const groupMembers = sqliteTable(
+ "groupMember",
+ {
+ groupId: text("groupId")
+ .notNull()
+ .references(() => groups.id, { onDelete: "cascade" }),
+ userId: text("userId")
+ .notNull()
+ .references(() => users.id, { onDelete: "cascade" }),
+ },
+ (groupMember) => ({
+ compoundKey: primaryKey({
+ columns: [groupMember.groupId, groupMember.userId],
+ }),
}),
);
+export const groups = sqliteTable("group", {
+ id: text("id").notNull().primaryKey(),
+ name: text("name").notNull(),
+ ownerId: text("owner_id").references(() => users.id, {
+ onDelete: "set null",
+ }),
+});
+
+export const groupPermissions = sqliteTable("groupPermission", {
+ groupId: text("groupId")
+ .notNull()
+ .references(() => groups.id, { onDelete: "cascade" }),
+ permission: text("permission").$type().notNull(),
+});
+
+export const invites = sqliteTable("invite", {
+ id: text("id").notNull().primaryKey(),
+ token: text("token").notNull().unique(),
+ expirationDate: int("expiration_date", {
+ mode: "timestamp",
+ }).notNull(),
+ creatorId: text("creator_id")
+ .notNull()
+ .references(() => users.id, { onDelete: "cascade" }),
+});
+
export const integrations = sqliteTable(
"integration",
{
@@ -83,8 +134,8 @@ export const integrations = sqliteTable(
url: text("url").notNull(),
kind: text("kind").$type().notNull(),
},
- (i) => ({
- kindIdx: index("integration__kind_idx").on(i.kind),
+ (integrations) => ({
+ kindIdx: index("integration__kind_idx").on(integrations.kind),
}),
);
@@ -98,15 +149,151 @@ export const integrationSecrets = sqliteTable(
.notNull()
.references(() => integrations.id, { onDelete: "cascade" }),
},
- (is) => ({
+ (integrationSecret) => ({
+ compoundKey: primaryKey({
+ columns: [integrationSecret.integrationId, integrationSecret.kind],
+ }),
+ kindIdx: index("integration_secret__kind_idx").on(integrationSecret.kind),
+ updatedAtIdx: index("integration_secret__updated_at_idx").on(integrationSecret.updatedAt),
+ }),
+);
+
+export const boards = sqliteTable("board", {
+ id: text("id").notNull().primaryKey(),
+ name: text("name").unique().notNull(),
+ isPublic: int("is_public", { mode: "boolean" }).default(false).notNull(),
+ creatorId: text("creator_id").references(() => users.id, {
+ onDelete: "set null",
+ }),
+ pageTitle: text("page_title"),
+ metaTitle: text("meta_title"),
+ logoImageUrl: text("logo_image_url"),
+ faviconImageUrl: text("favicon_image_url"),
+ backgroundImageUrl: text("background_image_url"),
+ backgroundImageAttachment: text("background_image_attachment")
+ .$type()
+ .default(backgroundImageAttachments.defaultValue)
+ .notNull(),
+ backgroundImageRepeat: text("background_image_repeat")
+ .$type()
+ .default(backgroundImageRepeats.defaultValue)
+ .notNull(),
+ backgroundImageSize: text("background_image_size")
+ .$type()
+ .default(backgroundImageSizes.defaultValue)
+ .notNull(),
+ primaryColor: text("primary_color").default("#fa5252").notNull(),
+ secondaryColor: text("secondary_color").default("#fd7e14").notNull(),
+ opacity: int("opacity").default(100).notNull(),
+ customCss: text("custom_css"),
+ columnCount: int("column_count").default(10).notNull(),
+});
+
+export const boardUserPermissions = sqliteTable(
+ "boardUserPermission",
+ {
+ boardId: text("board_id")
+ .notNull()
+ .references(() => boards.id, { onDelete: "cascade" }),
+ userId: text("user_id")
+ .notNull()
+ .references(() => users.id, { onDelete: "cascade" }),
+ permission: text("permission").$type().notNull(),
+ },
+ (table) => ({
+ compoundKey: primaryKey({
+ columns: [table.boardId, table.userId, table.permission],
+ }),
+ }),
+);
+
+export const boardGroupPermissions = sqliteTable(
+ "boardGroupPermission",
+ {
+ boardId: text("board_id")
+ .notNull()
+ .references(() => boards.id, { onDelete: "cascade" }),
+ groupId: text("group_id")
+ .notNull()
+ .references(() => groups.id, { onDelete: "cascade" }),
+ permission: text("permission").$type().notNull(),
+ },
+ (table) => ({
compoundKey: primaryKey({
- columns: [is.integrationId, is.kind],
+ columns: [table.boardId, table.groupId, table.permission],
}),
- kindIdx: index("integration_secret__kind_idx").on(is.kind),
- updatedAtIdx: index("integration_secret__updated_at_idx").on(is.updatedAt),
}),
);
+export const sections = sqliteTable("section", {
+ id: text("id").notNull().primaryKey(),
+ boardId: text("board_id")
+ .notNull()
+ .references(() => boards.id, { onDelete: "cascade" }),
+ kind: text("kind").$type().notNull(),
+ position: int("position").notNull(),
+ name: text("name"),
+});
+
+export const items = sqliteTable("item", {
+ id: text("id").notNull().primaryKey(),
+ sectionId: text("section_id")
+ .notNull()
+ .references(() => sections.id, { onDelete: "cascade" }),
+ kind: text("kind").$type().notNull(),
+ xOffset: int("x_offset").notNull(),
+ yOffset: int("y_offset").notNull(),
+ width: int("width").notNull(),
+ height: int("height").notNull(),
+ options: text("options").default('{"json": {}}').notNull(), // empty superjson object
+ advancedOptions: text("advanced_options").default('{"json": {}}').notNull(), // empty superjson object
+});
+
+export const apps = sqliteTable("app", {
+ id: text("id").notNull().primaryKey(),
+ name: text("name").notNull(),
+ description: text("description"),
+ iconUrl: text("icon_url").notNull(),
+ href: text("href"),
+});
+
+export const integrationItems = sqliteTable(
+ "integration_item",
+ {
+ itemId: text("item_id")
+ .notNull()
+ .references(() => items.id, { onDelete: "cascade" }),
+ integrationId: text("integration_id")
+ .notNull()
+ .references(() => integrations.id, { onDelete: "cascade" }),
+ },
+ (table) => ({
+ compoundKey: primaryKey({
+ columns: [table.itemId, table.integrationId],
+ }),
+ }),
+);
+
+export const icons = sqliteTable("icon", {
+ id: text("icon_id").notNull().primaryKey(),
+ name: text("icon_name").notNull(),
+ url: text("icon_url").notNull(),
+ checksum: text("icon_checksum").notNull(),
+ iconRepositoryId: text("iconRepository_id")
+ .notNull()
+ .references(() => iconRepositories.id, { onDelete: "cascade" }),
+});
+
+export const iconRepositories = sqliteTable("iconRepository", {
+ id: text("iconRepository_id").notNull().primaryKey(),
+ slug: text("iconRepository_slug").notNull(),
+});
+
+export const serverSettings = sqliteTable("serverSetting", {
+ settingKey: text("key").notNull().unique().primaryKey(),
+ value: text("value").default('{"json": {}}').notNull(), // empty superjson object
+});
+
export const accountRelations = relations(accounts, ({ one }) => ({
user: one(users, {
fields: [accounts.userId],
@@ -116,21 +303,136 @@ export const accountRelations = relations(accounts, ({ one }) => ({
export const userRelations = relations(users, ({ many }) => ({
accounts: many(accounts),
+ boards: many(boards),
+ boardPermissions: many(boardUserPermissions),
+ groups: many(groupMembers),
+ ownedGroups: many(groups),
+ invites: many(invites),
+}));
+
+export const iconRelations = relations(icons, ({ one }) => ({
+ repository: one(iconRepositories, {
+ fields: [icons.iconRepositoryId],
+ references: [iconRepositories.id],
+ }),
+}));
+
+export const iconRepositoryRelations = relations(iconRepositories, ({ many }) => ({
+ icons: many(icons),
+}));
+
+export const inviteRelations = relations(invites, ({ one }) => ({
+ creator: one(users, {
+ fields: [invites.creatorId],
+ references: [users.id],
+ }),
+}));
+
+export const sessionRelations = relations(sessions, ({ one }) => ({
+ user: one(users, {
+ fields: [sessions.userId],
+ references: [users.id],
+ }),
+}));
+
+export const groupMemberRelations = relations(groupMembers, ({ one }) => ({
+ group: one(groups, {
+ fields: [groupMembers.groupId],
+ references: [groups.id],
+ }),
+ user: one(users, {
+ fields: [groupMembers.userId],
+ references: [users.id],
+ }),
+}));
+
+export const groupRelations = relations(groups, ({ one, many }) => ({
+ permissions: many(groupPermissions),
+ boardPermissions: many(boardGroupPermissions),
+ members: many(groupMembers),
+ owner: one(users, {
+ fields: [groups.ownerId],
+ references: [users.id],
+ }),
+}));
+
+export const groupPermissionRelations = relations(groupPermissions, ({ one }) => ({
+ group: one(groups, {
+ fields: [groupPermissions.groupId],
+ references: [groups.id],
+ }),
+}));
+
+export const boardUserPermissionRelations = relations(boardUserPermissions, ({ one }) => ({
+ user: one(users, {
+ fields: [boardUserPermissions.userId],
+ references: [users.id],
+ }),
+ board: one(boards, {
+ fields: [boardUserPermissions.boardId],
+ references: [boards.id],
+ }),
+}));
+
+export const boardGroupPermissionRelations = relations(boardGroupPermissions, ({ one }) => ({
+ group: one(groups, {
+ fields: [boardGroupPermissions.groupId],
+ references: [groups.id],
+ }),
+ board: one(boards, {
+ fields: [boardGroupPermissions.boardId],
+ references: [boards.id],
+ }),
}));
export const integrationRelations = relations(integrations, ({ many }) => ({
secrets: many(integrationSecrets),
+ items: many(integrationItems),
}));
-export const integrationSecretRelations = relations(
- integrationSecrets,
- ({ one }) => ({
- integration: one(integrations, {
- fields: [integrationSecrets.integrationId],
- references: [integrations.id],
- }),
+export const integrationSecretRelations = relations(integrationSecrets, ({ one }) => ({
+ integration: one(integrations, {
+ fields: [integrationSecrets.integrationId],
+ references: [integrations.id],
}),
-);
+}));
+
+export const boardRelations = relations(boards, ({ many, one }) => ({
+ sections: many(sections),
+ creator: one(users, {
+ fields: [boards.creatorId],
+ references: [users.id],
+ }),
+ userPermissions: many(boardUserPermissions),
+ groupPermissions: many(boardGroupPermissions),
+}));
+
+export const sectionRelations = relations(sections, ({ many, one }) => ({
+ items: many(items),
+ board: one(boards, {
+ fields: [sections.boardId],
+ references: [boards.id],
+ }),
+}));
+
+export const itemRelations = relations(items, ({ one, many }) => ({
+ section: one(sections, {
+ fields: [items.sectionId],
+ references: [sections.id],
+ }),
+ integrations: many(integrationItems),
+}));
+
+export const integrationItemRelations = relations(integrationItems, ({ one }) => ({
+ integration: one(integrations, {
+ fields: [integrationItems.integrationId],
+ references: [integrations.id],
+ }),
+ item: one(items, {
+ fields: [integrationItems.itemId],
+ references: [items.id],
+ }),
+}));
export type User = InferSelectModel;
export type Account = InferSelectModel;
diff --git a/packages/db/test/db-mock.ts b/packages/db/test/db-mock.ts
new file mode 100644
index 000000000..d2befdfb9
--- /dev/null
+++ b/packages/db/test/db-mock.ts
@@ -0,0 +1,19 @@
+import Database from "better-sqlite3";
+import { drizzle } from "drizzle-orm/better-sqlite3";
+import { migrate } from "drizzle-orm/better-sqlite3/migrator";
+
+import { schema } from "..";
+
+export const createDb = (debug?: boolean) => {
+ const sqlite = new Database(":memory:");
+ const db = drizzle(sqlite, { schema, logger: debug });
+ migrate(db, {
+ migrationsFolder: "./packages/db/migrations/sqlite",
+ });
+
+ if (debug) {
+ console.log("Database created");
+ }
+
+ return db;
+};
diff --git a/packages/db/test/index.ts b/packages/db/test/index.ts
new file mode 100644
index 000000000..31046067d
--- /dev/null
+++ b/packages/db/test/index.ts
@@ -0,0 +1 @@
+export * from "./db-mock";
diff --git a/packages/db/test/schema.spec.ts b/packages/db/test/schema.spec.ts
new file mode 100644
index 000000000..78b8363e2
--- /dev/null
+++ b/packages/db/test/schema.spec.ts
@@ -0,0 +1,132 @@
+import type { Column, InferSelectModel } from "drizzle-orm";
+import type { ForeignKey as MysqlForeignKey, MySqlTableWithColumns } from "drizzle-orm/mysql-core";
+import type { ForeignKey as SqliteForeignKey, SQLiteTableWithColumns } from "drizzle-orm/sqlite-core";
+import { expect, expectTypeOf, test } from "vitest";
+
+import { objectEntries } from "@homarr/common";
+
+import * as mysqlSchema from "../schema/mysql";
+import * as sqliteSchema from "../schema/sqlite";
+
+test("schemas should match", () => {
+ expectTypeOf().toEqualTypeOf();
+ expectTypeOf().toEqualTypeOf();
+ expectTypeOf().toEqualTypeOf();
+ expectTypeOf().toEqualTypeOf();
+
+ objectEntries(sqliteSchema).forEach(([tableName, sqliteTable]) => {
+ Object.entries(sqliteTable).forEach(([columnName, sqliteColumn]: [string, object]) => {
+ if (!("isUnique" in sqliteColumn)) return;
+ if (!("uniqueName" in sqliteColumn)) return;
+ if (!("primary" in sqliteColumn)) return;
+
+ const mysqlTable = mysqlSchema[tableName];
+
+ const mysqlColumn = mysqlTable[columnName as keyof typeof mysqlTable] as object;
+ if (!("isUnique" in mysqlColumn)) return;
+ if (!("uniqueName" in mysqlColumn)) return;
+ if (!("primary" in mysqlColumn)) return;
+
+ expect(
+ sqliteColumn.isUnique,
+ `expect unique of column ${columnName} in table ${tableName} to be the same for both schemas`,
+ ).toEqual(mysqlColumn.isUnique);
+ expect(
+ sqliteColumn.uniqueName,
+ `expect uniqueName of column ${columnName} in table ${tableName} to be the same for both schemas`,
+ ).toEqual(mysqlColumn.uniqueName);
+ expect(
+ sqliteColumn.primary,
+ `expect primary of column ${columnName} in table ${tableName} to be the same for both schemas`,
+ ).toEqual(mysqlColumn.primary);
+ });
+
+ const mysqlTable = mysqlSchema[tableName];
+ const sqliteForeignKeys = sqliteTable[Symbol.for("drizzle:SQLiteInlineForeignKeys") as keyof typeof sqliteTable] as
+ | SqliteForeignKey[]
+ | undefined;
+ const mysqlForeignKeys = mysqlTable[Symbol.for("drizzle:MySqlInlineForeignKeys") as keyof typeof mysqlTable] as
+ | MysqlForeignKey[]
+ | undefined;
+
+ if (!sqliteForeignKeys && !mysqlForeignKeys) return;
+
+ expect(mysqlForeignKeys, `mysql foreign key for ${tableName} to be defined`).toBeDefined();
+ expect(sqliteForeignKeys, `sqlite foreign key for ${tableName} to be defined`).toBeDefined();
+
+ expect(
+ sqliteForeignKeys!.length,
+ `expect number of foreign keys in table ${tableName} to be the same for both schemas`,
+ ).toEqual(mysqlForeignKeys!.length);
+
+ sqliteForeignKeys?.forEach((sqliteForeignKey) => {
+ sqliteForeignKey.getName();
+ const mysqlForeignKey = mysqlForeignKeys!.find((key) => key.getName() === sqliteForeignKey.getName());
+ expect(
+ mysqlForeignKey,
+ `expect foreign key ${sqliteForeignKey.getName()} to be defined in mysql schema`,
+ ).toBeDefined();
+
+ expect(
+ sqliteForeignKey.onDelete,
+ `expect foreign key (${sqliteForeignKey.getName()}) onDelete to be the same for both schemas`,
+ ).toEqual(mysqlForeignKey!.onDelete);
+
+ expect(
+ sqliteForeignKey.onUpdate,
+ `expect foreign key (${sqliteForeignKey.getName()}) onUpdate to be the same for both schemas`,
+ ).toEqual(mysqlForeignKey!.onUpdate);
+
+ sqliteForeignKey.reference().foreignColumns.forEach((column) => {
+ expect(
+ mysqlForeignKey!.reference().foreignColumns.map((column) => column.name),
+ `expect foreign key (${sqliteForeignKey.getName()}) columns to be the same for both schemas`,
+ ).toContainEqual(column.name);
+ });
+
+ expect(
+ Object.keys(sqliteForeignKey.reference().foreignTable),
+ `expect foreign key (${sqliteForeignKey.getName()}) table to be the same for both schemas`,
+ ).toEqual(Object.keys(mysqlForeignKey!.reference().foreignTable));
+ });
+ });
+});
+
+type SqliteTables = {
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
+ [K in keyof typeof sqliteSchema]: (typeof sqliteSchema)[K] extends SQLiteTableWithColumns
+ ? InferSelectModel<(typeof sqliteSchema)[K]>
+ : never;
+};
+type MysqlTables = {
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
+ [K in keyof typeof mysqlSchema]: (typeof mysqlSchema)[K] extends MySqlTableWithColumns
+ ? InferSelectModel<(typeof mysqlSchema)[K]>
+ : never;
+};
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type InferColumnConfig> =
+ T extends Column ? Omit : never;
+
+type SqliteConfig = {
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
+ [K in keyof typeof sqliteSchema]: (typeof sqliteSchema)[K] extends SQLiteTableWithColumns
+ ? {
+ [C in keyof (typeof sqliteSchema)[K]["_"]["config"]["columns"]]: InferColumnConfig<
+ (typeof sqliteSchema)[K]["_"]["config"]["columns"][C]
+ >;
+ }
+ : never;
+};
+
+type MysqlConfig = {
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
+ [K in keyof typeof mysqlSchema]: (typeof mysqlSchema)[K] extends MySqlTableWithColumns
+ ? {
+ [C in keyof (typeof mysqlSchema)[K]["_"]["config"]["columns"]]: InferColumnConfig<
+ (typeof mysqlSchema)[K]["_"]["config"]["columns"][C]
+ >;
+ }
+ : never;
+};
diff --git a/packages/definitions/package.json b/packages/definitions/package.json
index a2e56ab5e..c93c62866 100644
--- a/packages/definitions/package.json
+++ b/packages/definitions/package.json
@@ -2,6 +2,7 @@
"name": "@homarr/definitions",
"private": true,
"version": "0.1.0",
+ "type": "module",
"exports": {
".": "./index.ts"
},
@@ -23,8 +24,8 @@
"@homarr/eslint-config": "workspace:^0.2.0",
"@homarr/prettier-config": "workspace:^0.1.0",
"@homarr/tsconfig": "workspace:^0.1.0",
- "eslint": "^8.56.0",
- "typescript": "^5.3.3"
+ "eslint": "^8.57.0",
+ "typescript": "^5.4.5"
},
"eslintConfig": {
"extends": [
diff --git a/packages/definitions/src/_definition.ts b/packages/definitions/src/_definition.ts
new file mode 100644
index 000000000..a99ecb382
--- /dev/null
+++ b/packages/definitions/src/_definition.ts
@@ -0,0 +1,17 @@
+export const createDefinition = (
+ values: TKeys,
+ options: TOptions,
+) => ({
+ values,
+ defaultValue: options?.defaultValue as TOptions extends {
+ defaultValue: infer T;
+ }
+ ? T
+ : undefined,
+});
+
+export type inferDefinitionType = TDefinition extends {
+ values: readonly (infer T)[];
+}
+ ? T
+ : never;
diff --git a/packages/definitions/src/board.ts b/packages/definitions/src/board.ts
new file mode 100644
index 000000000..302008550
--- /dev/null
+++ b/packages/definitions/src/board.ts
@@ -0,0 +1,14 @@
+import type { inferDefinitionType } from "./_definition";
+import { createDefinition } from "./_definition";
+
+export const backgroundImageAttachments = createDefinition(["fixed", "scroll"], { defaultValue: "fixed" });
+export const backgroundImageRepeats = createDefinition(["repeat", "repeat-x", "repeat-y", "no-repeat"], {
+ defaultValue: "no-repeat",
+});
+export const backgroundImageSizes = createDefinition(["cover", "contain"], {
+ defaultValue: "cover",
+});
+
+export type BackgroundImageAttachment = inferDefinitionType;
+export type BackgroundImageRepeat = inferDefinitionType;
+export type BackgroundImageSize = inferDefinitionType;
diff --git a/packages/definitions/src/index.ts b/packages/definitions/src/index.ts
index 852c5e31b..d72b9e8d1 100644
--- a/packages/definitions/src/index.ts
+++ b/packages/definitions/src/index.ts
@@ -1 +1,5 @@
+export * from "./board";
export * from "./integration";
+export * from "./section";
+export * from "./widget";
+export * from "./permissions";
diff --git a/packages/definitions/src/integration.ts b/packages/definitions/src/integration.ts
index 4c33ceb85..3f5650af4 100644
--- a/packages/definitions/src/integration.ts
+++ b/packages/definitions/src/integration.ts
@@ -11,114 +11,98 @@ export const integrationSecretKinds = objectKeys(integrationSecretKindObject);
export const integrationDefs = {
sabNzbd: {
name: "SABnzbd",
- secretKinds: ["apiKey"],
- iconUrl:
- "https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons@master/png/sabnzbd.png",
+ secretKinds: [["apiKey"]],
+ iconUrl: "https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons@master/png/sabnzbd.png",
category: ["useNetClient"],
},
nzbGet: {
name: "NZBGet",
- secretKinds: ["username", "password"],
- iconUrl:
- "https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons@master/png/nzbget.png",
+ secretKinds: [["username", "password"]],
+ iconUrl: "https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons@master/png/nzbget.png",
category: ["useNetClient"],
},
deluge: {
name: "Deluge",
- secretKinds: ["password"],
- iconUrl:
- "https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons@master/png/deluge.png",
+ secretKinds: [["password"]],
+ iconUrl: "https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons@master/png/deluge.png",
category: ["downloadClient"],
},
transmission: {
name: "Transmission",
- secretKinds: ["username", "password"],
- iconUrl:
- "https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons@master/png/transmission.png",
+ secretKinds: [["username", "password"]],
+ iconUrl: "https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons@master/png/transmission.png",
category: ["downloadClient"],
},
qBittorrent: {
name: "qBittorrent",
- secretKinds: ["username", "password"],
- iconUrl:
- "https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons@master/png/qbittorrent.png",
+ secretKinds: [["username", "password"]],
+ iconUrl: "https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons@master/png/qbittorrent.png",
category: ["downloadClient"],
},
sonarr: {
name: "Sonarr",
- secretKinds: ["apiKey"],
- iconUrl:
- "https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons@master/png/sonarr.png",
+ secretKinds: [["apiKey"]],
+ iconUrl: "https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons@master/png/sonarr.png",
category: ["calendar"],
},
radarr: {
name: "Radarr",
- secretKinds: ["apiKey"],
- iconUrl:
- "https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons@master/png/radarr.png",
+ secretKinds: [["apiKey"]],
+ iconUrl: "https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons@master/png/radarr.png",
category: ["calendar"],
},
lidarr: {
name: "Lidarr",
- secretKinds: ["apiKey"],
- iconUrl:
- "https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons@master/png/lidarr.png",
+ secretKinds: [["apiKey"]],
+ iconUrl: "https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons@master/png/lidarr.png",
category: ["calendar"],
},
readarr: {
name: "Readarr",
- secretKinds: ["apiKey"],
- iconUrl:
- "https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons@master/png/readarr.png",
+ secretKinds: [["apiKey"]],
+ iconUrl: "https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons@master/png/readarr.png",
category: ["calendar"],
},
jellyfin: {
name: "Jellyfin",
- secretKinds: ["username", "password"],
- iconUrl:
- "https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons@master/png/jellyfin.png",
+ secretKinds: [["username", "password"], ["apiKey"]],
+ iconUrl: "https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons@master/png/jellyfin.png",
category: ["mediaService"],
},
plex: {
name: "Plex",
- secretKinds: ["apiKey"],
- iconUrl:
- "https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons@master/png/plex.png",
+ secretKinds: [["apiKey"]],
+ iconUrl: "https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons@master/png/plex.png",
category: ["mediaService"],
},
jellyseerr: {
name: "Jellyseerr",
- secretKinds: ["apiKey"],
- iconUrl:
- "https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons@master/png/jellyseerr.png",
+ secretKinds: [["apiKey"]],
+ iconUrl: "https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons@master/png/jellyseerr.png",
category: ["mediaSearch", "mediaRequest"],
},
overseerr: {
name: "Overseerr",
- secretKinds: ["apiKey"],
- iconUrl:
- "https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons@master/png/overseerr.png",
+ secretKinds: [["apiKey"]],
+ iconUrl: "https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons@master/png/overseerr.png",
category: ["mediaSearch", "mediaRequest"],
},
piHole: {
name: "Pi-hole",
- secretKinds: ["apiKey"],
- iconUrl:
- "https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons@master/png/pi-hole.png",
+ secretKinds: [["apiKey"]],
+ iconUrl: "https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons@master/png/pi-hole.png",
category: ["dnsHole"],
},
adGuardHome: {
name: "AdGuard Home",
- secretKinds: ["username", "password"],
- iconUrl:
- "https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons@master/png/adguard-home.png",
+ secretKinds: [["username", "password"]],
+ iconUrl: "https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons@master/png/adguard-home.png",
category: ["dnsHole"],
},
homeAssistant: {
name: "Home Assistant",
- secretKinds: ["apiKey"],
- iconUrl:
- "https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons@master/png/home-assistant.png",
+ secretKinds: [["apiKey"]],
+ iconUrl: "https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons@master/png/home-assistant.png",
category: [],
},
} satisfies Record<
@@ -126,20 +110,21 @@ export const integrationDefs = {
{
name: string;
iconUrl: string;
- secretKinds: IntegrationSecretKind[];
+ secretKinds: [IntegrationSecretKind[], ...IntegrationSecretKind[][]]; // at least one secret kind set is required
category: IntegrationCategory[];
}
>;
-export const getIconUrl = (integration: IntegrationKind) =>
- integrationDefs[integration]?.iconUrl ?? null;
+export const getIconUrl = (integration: IntegrationKind) => integrationDefs[integration]?.iconUrl ?? null;
-export const getIntegrationName = (integration: IntegrationKind) =>
- integrationDefs[integration].name;
+export const getIntegrationName = (integration: IntegrationKind) => integrationDefs[integration].name;
-export const getSecretKinds = (
+export const getDefaultSecretKinds = (integration: IntegrationKind): IntegrationSecretKind[] =>
+ integrationDefs[integration]?.secretKinds[0];
+
+export const getAllSecretKindOptions = (
integration: IntegrationKind,
-): IntegrationSecretKind[] => integrationDefs[integration]?.secretKinds ?? null;
+): [IntegrationSecretKind[], ...IntegrationSecretKind[][]] => integrationDefs[integration]?.secretKinds;
export const integrationKinds = objectKeys(integrationDefs);
diff --git a/packages/definitions/src/permissions.ts b/packages/definitions/src/permissions.ts
new file mode 100644
index 000000000..827c78df9
--- /dev/null
+++ b/packages/definitions/src/permissions.ts
@@ -0,0 +1,69 @@
+import { objectEntries, objectKeys } from "@homarr/common";
+
+export const boardPermissions = ["board-view", "board-change"] as const;
+export const groupPermissions = {
+ board: ["create", "view-all", "modify-all", "full-access"],
+ integration: ["create", "use-all", "interact-all", "full-access"],
+ admin: true,
+} as const;
+
+/**
+ * In the following object is described how the permissions are related to each other.
+ * For example everybody with the permission "board-modify-all" also has the permission "board-view-all".
+ * Or admin has all permissions (board-full-access and integration-full-access which will resolve in an array of every permission).
+ */
+const groupPermissionParents = {
+ "board-modify-all": ["board-view-all"],
+ "board-full-access": ["board-modify-all", "board-create"],
+ "integration-interact-all": ["integration-use-all"],
+ "integration-full-access": ["integration-interact-all", "integration-create"],
+ admin: ["board-full-access", "integration-full-access"],
+} satisfies Partial>;
+
+export const getPermissionsWithParents = (permissions: GroupPermissionKey[]): GroupPermissionKey[] => {
+ const res = permissions.map((permission) => {
+ return objectEntries(groupPermissionParents)
+ .filter(([_key, value]: [string, GroupPermissionKey[]]) => value.includes(permission))
+ .map(([key]) => getPermissionsWithParents([key]))
+ .flat();
+ });
+
+ return permissions.concat(res.flat());
+};
+
+const getPermissionsInner = (permissionSet: Set, permissions: GroupPermissionKey[]) => {
+ permissions.forEach((permission) => {
+ const children = groupPermissionParents[permission as keyof typeof groupPermissionParents];
+ if (children) {
+ getPermissionsInner(permissionSet, children);
+ }
+
+ permissionSet.add(permission);
+ });
+};
+
+export const getPermissionsWithChildren = (permissions: GroupPermissionKey[]) => {
+ const permissionSet = new Set();
+ getPermissionsInner(permissionSet, permissions);
+ return Array.from(permissionSet);
+};
+
+type GroupPermissions = typeof groupPermissions;
+
+export type GroupPermissionKey = {
+ [key in keyof GroupPermissions]: GroupPermissions[key] extends readonly string[]
+ ? `${key}-${GroupPermissions[key][number]}`
+ : key;
+}[keyof GroupPermissions];
+
+export const groupPermissionKeys = objectKeys(groupPermissions).reduce((acc, key) => {
+ const item = groupPermissions[key];
+ if (typeof item !== "boolean") {
+ acc.push(...item.map((subKey) => `${key}-${subKey}` as GroupPermissionKey));
+ } else {
+ acc.push(key as GroupPermissionKey);
+ }
+ return acc;
+}, [] as GroupPermissionKey[]);
+
+export type BoardPermission = (typeof boardPermissions)[number];
diff --git a/packages/definitions/src/section.ts b/packages/definitions/src/section.ts
new file mode 100644
index 000000000..847581914
--- /dev/null
+++ b/packages/definitions/src/section.ts
@@ -0,0 +1,2 @@
+export const sectionKinds = ["category", "empty"] as const;
+export type SectionKind = (typeof sectionKinds)[number];
diff --git a/packages/definitions/src/test/integration.spec.ts b/packages/definitions/src/test/integration.spec.ts
new file mode 100644
index 000000000..bdb5194fd
--- /dev/null
+++ b/packages/definitions/src/test/integration.spec.ts
@@ -0,0 +1,14 @@
+import { describe, expect, it } from "vitest";
+
+import { objectEntries } from "@homarr/common";
+
+import { integrationDefs } from "../integration";
+
+describe("Icon url's of integrations should be valid and return 200", () => {
+ objectEntries(integrationDefs).forEach(([integration, { iconUrl }]) => {
+ it.concurrent(`should return 200 for ${integration}`, async () => {
+ const res = await fetch(iconUrl);
+ expect(res.status).toBe(200);
+ });
+ });
+});
diff --git a/packages/definitions/src/test/permissions.spec.ts b/packages/definitions/src/test/permissions.spec.ts
new file mode 100644
index 000000000..1a3572c45
--- /dev/null
+++ b/packages/definitions/src/test/permissions.spec.ts
@@ -0,0 +1,47 @@
+import { describe, expect, test } from "vitest";
+
+import type { GroupPermissionKey } from "../permissions";
+import { getPermissionsWithChildren, getPermissionsWithParents } from "../permissions";
+
+describe("getPermissionsWithParents should return the correct permissions", () => {
+ test.each([
+ [["board-view-all"], ["board-view-all", "board-modify-all", "board-full-access", "admin"]],
+ [["board-modify-all"], ["board-modify-all", "board-full-access", "admin"]],
+ [["board-create"], ["board-create", "board-full-access", "admin"]],
+ [["board-full-access"], ["board-full-access", "admin"]],
+ [["integration-use-all"], ["integration-use-all", "integration-interact-all", "integration-full-access", "admin"]],
+ [["integration-create"], ["integration-create", "integration-full-access", "admin"]],
+ [["integration-interact-all"], ["integration-interact-all", "integration-full-access", "admin"]],
+ [["integration-full-access"], ["integration-full-access", "admin"]],
+ [["admin"], ["admin"]],
+ ] satisfies [GroupPermissionKey[], GroupPermissionKey[]][])("expect %s to return %s", (input, expectedOutput) => {
+ expect(getPermissionsWithParents(input)).toEqual(expect.arrayContaining(expectedOutput));
+ });
+});
+
+describe("getPermissionsWithChildren should return the correct permissions", () => {
+ test.each([
+ [["board-view-all"], ["board-view-all"]],
+ [["board-modify-all"], ["board-view-all", "board-modify-all"]],
+ [["board-create"], ["board-create"]],
+ [["board-full-access"], ["board-full-access", "board-modify-all", "board-view-all"]],
+ [["integration-use-all"], ["integration-use-all"]],
+ [["integration-create"], ["integration-create"]],
+ [["integration-interact-all"], ["integration-interact-all", "integration-use-all"]],
+ [["integration-full-access"], ["integration-full-access", "integration-interact-all", "integration-use-all"]],
+ [
+ ["admin"],
+ [
+ "admin",
+ "board-full-access",
+ "board-modify-all",
+ "board-view-all",
+ "integration-full-access",
+ "integration-interact-all",
+ "integration-use-all",
+ ],
+ ],
+ ] satisfies [GroupPermissionKey[], GroupPermissionKey[]][])("expect %s to return %s", (input, expectedOutput) => {
+ expect(getPermissionsWithChildren(input)).toEqual(expect.arrayContaining(expectedOutput));
+ });
+});
diff --git a/packages/definitions/src/widget.ts b/packages/definitions/src/widget.ts
new file mode 100644
index 000000000..a095f01f1
--- /dev/null
+++ b/packages/definitions/src/widget.ts
@@ -0,0 +1,2 @@
+export const widgetKinds = ["clock", "weather", "app", "iframe", "video", "notebook"] as const;
+export type WidgetKind = (typeof widgetKinds)[number];
diff --git a/packages/form/package.json b/packages/form/package.json
index fb15caa5e..b964a10ea 100644
--- a/packages/form/package.json
+++ b/packages/form/package.json
@@ -23,8 +23,8 @@
"@homarr/eslint-config": "workspace:^0.2.0",
"@homarr/prettier-config": "workspace:^0.1.0",
"@homarr/tsconfig": "workspace:^0.1.0",
- "eslint": "^8.56.0",
- "typescript": "^5.3.3"
+ "eslint": "^8.57.0",
+ "typescript": "^5.4.5"
},
"eslintConfig": {
"extends": [
@@ -33,6 +33,8 @@
},
"prettier": "@homarr/prettier-config",
"dependencies": {
- "@mantine/form": "^7.4.0"
+ "@mantine/form": "^7.9.2",
+ "@homarr/validation": "workspace:^0.1.0",
+ "@homarr/translation": "workspace:^0.1.0"
}
}
diff --git a/packages/form/src/index.ts b/packages/form/src/index.ts
index 7211e1b1e..60a2f425e 100644
--- a/packages/form/src/index.ts
+++ b/packages/form/src/index.ts
@@ -1 +1,26 @@
-export const name = "form";
+import { useForm, zodResolver } from "@mantine/form";
+
+import { useI18n } from "@homarr/translation/client";
+import { z } from "@homarr/validation";
+import type { AnyZodObject, ZodEffects, ZodIntersection } from "@homarr/validation";
+import { zodErrorMap } from "@homarr/validation/form";
+
+export const useZodForm = <
+ TSchema extends AnyZodObject | ZodEffects | ZodIntersection,
+>(
+ schema: TSchema,
+ options: Omit<
+ Exclude>>[0], undefined>,
+ "validate" | "validateInputOnBlur" | "validateInputOnChange"
+ >,
+) => {
+ const t = useI18n();
+
+ z.setErrorMap(zodErrorMap(t));
+ return useForm>({
+ ...options,
+ validateInputOnBlur: true,
+ validateInputOnChange: true,
+ validate: zodResolver(schema),
+ });
+};
diff --git a/packages/form/src/messages.ts b/packages/form/src/messages.ts
new file mode 100644
index 000000000..51983fff1
--- /dev/null
+++ b/packages/form/src/messages.ts
@@ -0,0 +1,102 @@
+import type { TranslationObject } from "@homarr/translation";
+import type { ErrorMapCtx, z, ZodTooBigIssue, ZodTooSmallIssue } from "@homarr/validation";
+import { ZodIssueCode } from "@homarr/validation";
+
+const handleStringError = (issue: z.ZodInvalidStringIssue) => {
+ if (typeof issue.validation === "object") {
+ // Check if object contains startsWith / endsWith key to determine the error type. If not, it's an includes error. (see type of issue.validation)
+ if ("startsWith" in issue.validation) {
+ return {
+ key: "errors.string.startsWith",
+ params: {
+ startsWith: issue.validation.startsWith,
+ },
+ } as const;
+ } else if ("endsWith" in issue.validation) {
+ return {
+ key: "errors.string.endsWith",
+ params: {
+ endsWith: issue.validation.endsWith,
+ },
+ } as const;
+ }
+
+ return {
+ key: "errors.invalid_string.includes",
+ params: {
+ includes: issue.validation.includes,
+ },
+ } as const;
+ }
+
+ return {
+ message: issue.message,
+ };
+};
+
+const handleTooSmallError = (issue: ZodTooSmallIssue) => {
+ if (issue.type !== "string" && issue.type !== "number") {
+ return {
+ message: issue.message,
+ };
+ }
+
+ return {
+ key: `errors.tooSmall.${issue.type}`,
+ params: {
+ minimum: issue.minimum,
+ count: issue.minimum,
+ },
+ } as const;
+};
+
+const handleTooBigError = (issue: ZodTooBigIssue) => {
+ if (issue.type !== "string" && issue.type !== "number") {
+ return {
+ message: issue.message,
+ };
+ }
+
+ return {
+ key: `errors.tooBig.${issue.type}`,
+ params: {
+ maximum: issue.maximum,
+ count: issue.maximum,
+ },
+ } as const;
+};
+
+export const handleZodError = (issue: z.ZodIssueOptionalMessage, ctx: ErrorMapCtx) => {
+ if (ctx.defaultError === "Required") {
+ return {
+ key: "errors.required",
+ params: {},
+ } as const;
+ }
+ if (issue.code === ZodIssueCode.invalid_string) {
+ return handleStringError(issue);
+ }
+ if (issue.code === ZodIssueCode.too_small) {
+ return handleTooSmallError(issue);
+ }
+ if (issue.code === ZodIssueCode.too_big) {
+ return handleTooBigError(issue);
+ }
+ if (issue.code === ZodIssueCode.custom && issue.params?.i18n) {
+ const { i18n } = issue.params as CustomErrorParams;
+ return {
+ key: `errors.custom.${i18n.key}`,
+ } as const;
+ }
+
+ return {
+ message: issue.message,
+ };
+};
+
+export interface CustomErrorParams {
+ i18n: {
+ key: keyof TranslationObject["common"]["zod"]["errors"]["custom"];
+ params?: Record;
+ };
+}
diff --git a/packages/icons/index.ts b/packages/icons/index.ts
new file mode 100644
index 000000000..eb96ce46b
--- /dev/null
+++ b/packages/icons/index.ts
@@ -0,0 +1,2 @@
+export * from "./src/icons-fetcher";
+export * from "./src/types";
diff --git a/packages/icons/package.json b/packages/icons/package.json
new file mode 100644
index 000000000..f3883cad2
--- /dev/null
+++ b/packages/icons/package.json
@@ -0,0 +1,39 @@
+{
+ "name": "@homarr/icons",
+ "private": true,
+ "version": "0.1.0",
+ "type": "module",
+ "exports": {
+ ".": "./index.ts"
+ },
+ "typesVersions": {
+ "*": {
+ "*": [
+ "src/*"
+ ]
+ }
+ },
+ "license": "MIT",
+ "scripts": {
+ "clean": "rm -rf .turbo node_modules",
+ "lint": "eslint .",
+ "format": "prettier --check . --ignore-path ../../.gitignore",
+ "typecheck": "tsc --noEmit"
+ },
+ "dependencies": {
+ "@homarr/log": "workspace:^0.1.0"
+ },
+ "devDependencies": {
+ "@homarr/eslint-config": "workspace:^0.2.0",
+ "@homarr/prettier-config": "workspace:^0.1.0",
+ "@homarr/tsconfig": "workspace:^0.1.0",
+ "eslint": "^8.57.0",
+ "typescript": "^5.4.5"
+ },
+ "eslintConfig": {
+ "extends": [
+ "@homarr/eslint-config/base"
+ ]
+ },
+ "prettier": "@homarr/prettier-config"
+}
diff --git a/packages/icons/src/icons-fetcher.ts b/packages/icons/src/icons-fetcher.ts
new file mode 100644
index 000000000..32ba31af8
--- /dev/null
+++ b/packages/icons/src/icons-fetcher.ts
@@ -0,0 +1,34 @@
+import { GitHubIconRepository } from "./repositories/github.icon-repository";
+import { JsdelivrIconRepository } from "./repositories/jsdelivr.icon-repository";
+import type { RepositoryIconGroup } from "./types";
+
+const repositories = [
+ new GitHubIconRepository(
+ "Walkxcode",
+ "walkxcode/dashboard-icons",
+ undefined,
+ new URL("https://github.com/walkxcode/dashboard-icons"),
+ new URL("https://api.github.com/repos/walkxcode/dashboard-icons/git/trees/main?recursive=true"),
+ "https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons/{0}",
+ ),
+ new JsdelivrIconRepository(
+ "Papirus",
+ "PapirusDevelopmentTeam/papirus-icon-theme",
+ "GPL-3.0",
+ new URL("https://github.com/PapirusDevelopmentTeam/papirus-icon-theme"),
+ new URL("https://data.jsdelivr.com/v1/packages/gh/PapirusDevelopmentTeam/papirus_icons@master?structure=flat"),
+ "https://cdn.jsdelivr.net/gh/PapirusDevelopmentTeam/papirus_icons/{0}",
+ ),
+ new JsdelivrIconRepository(
+ "Homelab SVG assets",
+ "loganmarchione/homelab-svg-assets",
+ "MIT",
+ new URL("https://github.com/loganmarchione/homelab-svg-assets"),
+ new URL("https://data.jsdelivr.com/v1/packages/gh/loganmarchione/homelab-svg-assets@main?structure=flat"),
+ "https://cdn.jsdelivr.net/gh/loganmarchione/homelab-svg-assets/{0}",
+ ),
+];
+
+export const fetchIconsAsync = async (): Promise => {
+ return await Promise.all(repositories.map(async (repository) => await repository.getAllIconsAsync()));
+};
diff --git a/packages/icons/src/repositories/github.icon-repository.ts b/packages/icons/src/repositories/github.icon-repository.ts
new file mode 100644
index 000000000..3523bf930
--- /dev/null
+++ b/packages/icons/src/repositories/github.icon-repository.ts
@@ -0,0 +1,60 @@
+import type { IconRepositoryLicense } from "../types/icon-repository-license";
+import type { RepositoryIconGroup } from "../types/repository-icon-group";
+import { IconRepository } from "./icon-repository";
+
+export class GitHubIconRepository extends IconRepository {
+ constructor(
+ public readonly name: string,
+ public readonly slug: string,
+ public readonly license: IconRepositoryLicense,
+ public readonly repositoryUrl?: URL,
+ public readonly repositoryIndexingUrl?: URL,
+ public readonly repositoryBlobUrlTemplate?: string,
+ ) {
+ super(name, slug, license, repositoryUrl, repositoryIndexingUrl, repositoryBlobUrlTemplate);
+ }
+
+ protected async getAllIconsInternalAsync(): Promise {
+ if (!this.repositoryIndexingUrl || !this.repositoryBlobUrlTemplate) {
+ throw new Error("Repository URLs are required for this repository");
+ }
+
+ const response = await fetch(this.repositoryIndexingUrl);
+ const listOfFiles = (await response.json()) as GitHubApiResponse;
+
+ return {
+ success: true,
+ icons: listOfFiles.tree
+ .filter((treeItem) =>
+ this.allowedImageFileTypes.some((allowedExtension) => treeItem.path.includes(allowedExtension)),
+ )
+ .map((treeItem) => {
+ const fileNameWithExtension = this.getFileNameWithoutExtensionFromPath(treeItem.path);
+
+ return {
+ imageUrl: new URL(this.repositoryBlobUrlTemplate!.replace("{0}", treeItem.path)),
+ fileNameWithExtension: fileNameWithExtension,
+ local: false,
+ sizeInBytes: treeItem.size,
+ checksum: treeItem.sha,
+ };
+ }),
+ slug: this.slug,
+ };
+ }
+}
+
+interface GitHubApiResponse {
+ sha: string;
+ url: string;
+ tree: TreeItem[];
+ truncated: boolean;
+}
+
+export interface TreeItem {
+ path: string;
+ mode: string;
+ sha: string;
+ url: string;
+ size?: number;
+}
diff --git a/packages/icons/src/repositories/icon-repository.ts b/packages/icons/src/repositories/icon-repository.ts
new file mode 100644
index 000000000..358e48dfa
--- /dev/null
+++ b/packages/icons/src/repositories/icon-repository.ts
@@ -0,0 +1,36 @@
+import { logger } from "@homarr/log";
+
+import type { IconRepositoryLicense } from "../types/icon-repository-license";
+import type { RepositoryIconGroup } from "../types/repository-icon-group";
+
+export abstract class IconRepository {
+ protected readonly allowedImageFileTypes = [".png", ".svg", ".jpeg"];
+
+ protected constructor(
+ public readonly name: string,
+ public readonly slug: string,
+ public readonly license: IconRepositoryLicense,
+ public readonly repositoryUrl?: URL,
+ public readonly repositoryIndexingUrl?: URL,
+ public readonly repositoryBlobUrlTemplate?: string,
+ ) {}
+
+ public async getAllIconsAsync(): Promise {
+ try {
+ return await this.getAllIconsInternalAsync();
+ } catch (err) {
+ logger.error(`Unable to request icons from repository "${this.slug}": ${JSON.stringify(err)}`);
+ return {
+ success: false,
+ icons: [],
+ slug: this.slug,
+ };
+ }
+ }
+
+ protected abstract getAllIconsInternalAsync(): Promise;
+
+ protected getFileNameWithoutExtensionFromPath(path: string) {
+ return path.replace(/^.*[\\/]/, "");
+ }
+}
diff --git a/packages/icons/src/repositories/jsdelivr.icon-repository.ts b/packages/icons/src/repositories/jsdelivr.icon-repository.ts
new file mode 100644
index 000000000..919cdd2ba
--- /dev/null
+++ b/packages/icons/src/repositories/jsdelivr.icon-repository.ts
@@ -0,0 +1,51 @@
+import type { IconRepositoryLicense } from "../types/icon-repository-license";
+import type { RepositoryIconGroup } from "../types/repository-icon-group";
+import { IconRepository } from "./icon-repository";
+
+export class JsdelivrIconRepository extends IconRepository {
+ constructor(
+ public readonly name: string,
+ public readonly slug: string,
+ public readonly license: IconRepositoryLicense,
+ public readonly repositoryUrl: URL,
+ public readonly repositoryIndexingUrl: URL,
+ public readonly repositoryBlobUrlTemplate: string,
+ ) {
+ super(name, slug, license, repositoryUrl, repositoryIndexingUrl, repositoryBlobUrlTemplate);
+ }
+
+ protected async getAllIconsInternalAsync(): Promise {
+ const response = await fetch(this.repositoryIndexingUrl);
+ const listOfFiles = (await response.json()) as JsdelivrApiResponse;
+
+ return {
+ success: true,
+ icons: listOfFiles.files
+ .filter((file) =>
+ this.allowedImageFileTypes.some((allowedImageFileType) => file.name.includes(allowedImageFileType)),
+ )
+ .map((file) => {
+ const fileNameWithExtension = this.getFileNameWithoutExtensionFromPath(file.name);
+
+ return {
+ imageUrl: new URL(this.repositoryBlobUrlTemplate.replace("{0}", file.name)),
+ fileNameWithExtension: fileNameWithExtension,
+ local: false,
+ sizeInBytes: file.size,
+ checksum: file.hash,
+ };
+ }),
+ slug: this.slug,
+ };
+ }
+}
+
+interface JsdelivrApiResponse {
+ files: JsdelivrFile[];
+}
+
+interface JsdelivrFile {
+ name: string;
+ size: number;
+ hash: string;
+}
diff --git a/packages/icons/src/types/icon-repository-license.ts b/packages/icons/src/types/icon-repository-license.ts
new file mode 100644
index 000000000..a3ebe8728
--- /dev/null
+++ b/packages/icons/src/types/icon-repository-license.ts
@@ -0,0 +1 @@
+export type IconRepositoryLicense = "MIT" | "GPL-3.0" | undefined;
diff --git a/packages/icons/src/types/index.ts b/packages/icons/src/types/index.ts
new file mode 100644
index 000000000..c9e01bea7
--- /dev/null
+++ b/packages/icons/src/types/index.ts
@@ -0,0 +1,3 @@
+export * from "./icon-repository-license";
+export * from "./repository-icon-group";
+export * from "./repository-icon";
diff --git a/packages/icons/src/types/repository-icon-group.ts b/packages/icons/src/types/repository-icon-group.ts
new file mode 100644
index 000000000..7dcdc90fa
--- /dev/null
+++ b/packages/icons/src/types/repository-icon-group.ts
@@ -0,0 +1,7 @@
+import type { RepositoryIcon } from "./repository-icon";
+
+export interface RepositoryIconGroup {
+ icons: RepositoryIcon[];
+ success: boolean;
+ slug: string;
+}
diff --git a/packages/icons/src/types/repository-icon.ts b/packages/icons/src/types/repository-icon.ts
new file mode 100644
index 000000000..cb5884603
--- /dev/null
+++ b/packages/icons/src/types/repository-icon.ts
@@ -0,0 +1,7 @@
+export interface RepositoryIcon {
+ fileNameWithExtension: string;
+ sizeInBytes?: number;
+ imageUrl: URL;
+ local: boolean;
+ checksum: string;
+}
diff --git a/packages/icons/tsconfig.json b/packages/icons/tsconfig.json
new file mode 100644
index 000000000..cbe8483d9
--- /dev/null
+++ b/packages/icons/tsconfig.json
@@ -0,0 +1,8 @@
+{
+ "extends": "@homarr/tsconfig/base.json",
+ "compilerOptions": {
+ "tsBuildInfoFile": "node_modules/.cache/tsbuildinfo.json"
+ },
+ "include": ["*.ts", "src"],
+ "exclude": ["node_modules"]
+}
diff --git a/packages/log/package.json b/packages/log/package.json
new file mode 100644
index 000000000..18c403c27
--- /dev/null
+++ b/packages/log/package.json
@@ -0,0 +1,44 @@
+{
+ "name": "@homarr/log",
+ "private": true,
+ "version": "0.1.0",
+ "exports": {
+ ".": {
+ "types": "./src/index.d.ts",
+ "default": "./src/index.mjs"
+ },
+ "./override": "./src/override.cjs"
+ },
+ "typesVersions": {
+ "*": {
+ "*": [
+ "src/*"
+ ]
+ }
+ },
+ "license": "MIT",
+ "scripts": {
+ "clean": "rm -rf .turbo node_modules",
+ "lint": "eslint .",
+ "format": "prettier --check . --ignore-path ../../.gitignore",
+ "typecheck": "tsc --noEmit"
+ },
+ "dependencies": {
+ "ioredis": "5.4.1",
+ "superjson": "2.2.1",
+ "winston": "3.13.0"
+ },
+ "devDependencies": {
+ "@homarr/eslint-config": "workspace:^0.2.0",
+ "@homarr/prettier-config": "workspace:^0.1.0",
+ "@homarr/tsconfig": "workspace:^0.1.0",
+ "eslint": "^8.57.0",
+ "typescript": "^5.4.5"
+ },
+ "eslintConfig": {
+ "extends": [
+ "@homarr/eslint-config/base"
+ ]
+ },
+ "prettier": "@homarr/prettier-config"
+}
diff --git a/packages/log/src/index.d.ts b/packages/log/src/index.d.ts
new file mode 100644
index 000000000..628eec4f0
--- /dev/null
+++ b/packages/log/src/index.d.ts
@@ -0,0 +1,4 @@
+import type { Logger } from "winston";
+
+// The following is just to make prettier happy
+export const logger: Logger = undefined as unknown as Logger;
diff --git a/packages/log/src/index.mjs b/packages/log/src/index.mjs
new file mode 100644
index 000000000..1ef0b09d2
--- /dev/null
+++ b/packages/log/src/index.mjs
@@ -0,0 +1,14 @@
+import winston, { format, transports } from "winston";
+
+import { RedisTransport } from "./redis-transport.mjs";
+
+const logMessageFormat = format.printf(({ level, message, timestamp }) => {
+ return `${timestamp} ${level}: ${message}`;
+});
+
+const logger = winston.createLogger({
+ format: format.combine(format.colorize(), format.timestamp(), logMessageFormat),
+ transports: [new transports.Console(), new RedisTransport()],
+});
+
+export { logger };
diff --git a/packages/log/src/override.cjs b/packages/log/src/override.cjs
new file mode 100644
index 000000000..c8538f602
--- /dev/null
+++ b/packages/log/src/override.cjs
@@ -0,0 +1,45 @@
+void (async () => {
+ const { logger } = await import("./index.mjs");
+
+ // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-var-requires
+ const nextLogger = require("next/dist/build/output/log");
+
+ const getWinstonMethodForConsole = (consoleMethod) => {
+ switch (consoleMethod) {
+ case "error":
+ return (...messages) => logger.error(messages.join(" "));
+ case "warn":
+ return (...messages) => logger.warn(messages.join(" "));
+ case "debug":
+ return (...messages) => logger.debug(messages.join(" "));
+ case "log":
+ case "info":
+ default:
+ return (...messages) => logger.info(messages.join(" "));
+ }
+ };
+
+ const consoleMethods = ["log", "debug", "info", "warn", "error"];
+ consoleMethods.forEach((method) => {
+ console[method] = getWinstonMethodForConsole(method);
+ });
+
+ const getWinstonMethodForNext = (nextMethod) => {
+ switch (nextMethod) {
+ case "error":
+ return (...messages) => logger.error(messages.join(" "));
+ case "warn":
+ return (...messages) => logger.warn(messages.join(" "));
+ case "trace":
+ return (...messages) => logger.info(messages.join(" "));
+ default:
+ return (...messages) => logger.info(messages.join(" "));
+ }
+ };
+
+ // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-unsafe-member-access
+ Object.keys(nextLogger.prefixes).forEach((method) => {
+ // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+ nextLogger[method] = getWinstonMethodForNext(method);
+ });
+})();
diff --git a/packages/log/src/redis-transport.mjs b/packages/log/src/redis-transport.mjs
new file mode 100644
index 000000000..b63f81afe
--- /dev/null
+++ b/packages/log/src/redis-transport.mjs
@@ -0,0 +1,44 @@
+import { Redis } from "ioredis";
+import superjson from "superjson";
+import Transport from "winston-transport";
+
+//
+// Inherit from `winston-transport` so you can take advantage
+// of the base functionality and `.exceptions.handle()`.
+//
+export class RedisTransport extends Transport {
+ /** @type {Redis} */
+ redis;
+
+ /**
+ * Log the info to the Redis channel
+ * @param {{ message: string; timestamp: string; level: string; }} info
+ * @param {() => void} callback
+ */
+ log(info, callback) {
+ setImmediate(() => {
+ this.emit("logged", info);
+ });
+
+ if (!this.redis) {
+ // Is only initialized here because it did not work when initialized in the constructor or outside the class
+ this.redis = new Redis();
+ }
+
+ this.redis
+ .publish(
+ "pubSub:logging",
+ superjson.stringify({
+ message: info.message,
+ timestamp: info.timestamp,
+ level: info.level,
+ }),
+ )
+ .then(() => {
+ callback();
+ })
+ .catch(() => {
+ // Ignore errors
+ });
+ }
+}
diff --git a/packages/log/tsconfig.json b/packages/log/tsconfig.json
new file mode 100644
index 000000000..3fda3608b
--- /dev/null
+++ b/packages/log/tsconfig.json
@@ -0,0 +1,8 @@
+{
+ "extends": "@homarr/tsconfig/base.json",
+ "compilerOptions": {
+ "tsBuildInfoFile": "node_modules/.cache/tsbuildinfo.json"
+ },
+ "include": ["*.ts", "src", "index.mjs"],
+ "exclude": ["node_modules"]
+}
diff --git a/packages/modals/index.ts b/packages/modals/index.ts
new file mode 100644
index 000000000..f7a07beae
--- /dev/null
+++ b/packages/modals/index.ts
@@ -0,0 +1,2 @@
+export { ModalProvider, useModalAction, useConfirmModal } from "./src";
+export { createModal } from "./src/creator";
diff --git a/packages/modals/package.json b/packages/modals/package.json
new file mode 100644
index 000000000..9736781c6
--- /dev/null
+++ b/packages/modals/package.json
@@ -0,0 +1,39 @@
+{
+ "name": "@homarr/modals",
+ "private": true,
+ "version": "0.1.0",
+ "exports": {
+ ".": "./index.ts"
+ },
+ "typesVersions": {
+ "*": {
+ "*": [
+ "src/*"
+ ]
+ }
+ },
+ "license": "MIT",
+ "scripts": {
+ "clean": "rm -rf .turbo node_modules",
+ "lint": "eslint .",
+ "format": "prettier --check . --ignore-path ../../.gitignore",
+ "typecheck": "tsc --noEmit"
+ },
+ "dependencies": {
+ "@homarr/ui": "workspace:^0.1.0",
+ "@homarr/translation": "workspace:^0.1.0"
+ },
+ "devDependencies": {
+ "@homarr/eslint-config": "workspace:^0.2.0",
+ "@homarr/prettier-config": "workspace:^0.1.0",
+ "@homarr/tsconfig": "workspace:^0.1.0",
+ "eslint": "^8.57.0",
+ "typescript": "^5.4.5"
+ },
+ "eslintConfig": {
+ "extends": [
+ "@homarr/eslint-config/base"
+ ]
+ },
+ "prettier": "@homarr/prettier-config"
+}
diff --git a/packages/modals/src/confirm-modal.tsx b/packages/modals/src/confirm-modal.tsx
new file mode 100644
index 000000000..d1434b874
--- /dev/null
+++ b/packages/modals/src/confirm-modal.tsx
@@ -0,0 +1,77 @@
+import { useCallback, useState } from "react";
+import type { ComponentPropsWithoutRef, ReactNode } from "react";
+import type { ButtonProps, GroupProps } from "@mantine/core";
+import { Box, Button, Group } from "@mantine/core";
+
+import type { stringOrTranslation, TranslationFunction } from "@homarr/translation";
+import { translateIfNecessary } from "@homarr/translation";
+import { useI18n } from "@homarr/translation/client";
+
+import { createModal } from "./creator";
+
+type MaybePromise = T | Promise;
+
+export interface ConfirmModalProps {
+ title: string;
+ children: ReactNode;
+ onConfirm?: () => MaybePromise;
+ onCancel?: () => MaybePromise;
+ closeOnConfirm?: boolean;
+ closeOnCancel?: boolean;
+ cancelProps?: ButtonProps & ComponentPropsWithoutRef<"button">;
+ confirmProps?: ButtonProps & ComponentPropsWithoutRef<"button">;
+ groupProps?: GroupProps;
+
+ labels?: {
+ confirm?: stringOrTranslation;
+ cancel?: stringOrTranslation;
+ };
+}
+
+export const ConfirmModal = createModal>(({ actions, innerProps }) => {
+ const [loading, setLoading] = useState(false);
+ const t = useI18n();
+ const { children, onConfirm, onCancel, cancelProps, confirmProps, groupProps, labels } = innerProps;
+
+ const closeOnConfirm = innerProps.closeOnConfirm ?? true;
+ const closeOnCancel = innerProps.closeOnCancel ?? true;
+
+ const cancelLabel = labels?.cancel ?? ((t: TranslationFunction) => t("common.action.cancel"));
+ const confirmLabel = labels?.confirm ?? ((t: TranslationFunction) => t("common.action.confirm"));
+
+ const handleCancel = useCallback(
+ async (event: React.MouseEvent) => {
+ typeof cancelProps?.onClick === "function" && cancelProps?.onClick(event);
+ typeof onCancel === "function" && (await onCancel());
+ closeOnCancel && actions.closeModal();
+ },
+ [cancelProps?.onClick, onCancel, actions.closeModal],
+ );
+
+ const handleConfirm = useCallback(
+ async (event: React.MouseEvent) => {
+ setLoading(true);
+ typeof confirmProps?.onClick === "function" && confirmProps?.onClick(event);
+ typeof onConfirm === "function" && (await onConfirm());
+ closeOnConfirm && actions.closeModal();
+ setLoading(false);
+ },
+ [confirmProps?.onClick, onConfirm, actions.closeModal],
+ );
+
+ return (
+ <>
+ {children && {children} }
+
+
+
+ {cancelProps?.children || translateIfNecessary(t, cancelLabel)}
+
+
+
+ {confirmProps?.children || translateIfNecessary(t, confirmLabel)}
+
+
+
+ );
+}).withOptions({});
diff --git a/packages/modals/src/creator.ts b/packages/modals/src/creator.ts
new file mode 100644
index 000000000..ab91d378f
--- /dev/null
+++ b/packages/modals/src/creator.ts
@@ -0,0 +1,12 @@
+import type { CreateModalOptions, ModalComponent } from "./type";
+
+export const createModal = (component: ModalComponent) => {
+ return {
+ withOptions: (options: Partial) => {
+ return {
+ component,
+ options,
+ };
+ },
+ };
+};
diff --git a/packages/modals/src/index.tsx b/packages/modals/src/index.tsx
new file mode 100644
index 000000000..68876a6b6
--- /dev/null
+++ b/packages/modals/src/index.tsx
@@ -0,0 +1,152 @@
+"use client";
+
+import type { PropsWithChildren } from "react";
+import { createContext, useCallback, useContext, useEffect, useReducer, useRef, useState } from "react";
+import { getDefaultZIndex, Modal } from "@mantine/core";
+import { randomId } from "@mantine/hooks";
+
+import type { stringOrTranslation } from "@homarr/translation";
+import { translateIfNecessary } from "@homarr/translation";
+import { useI18n } from "@homarr/translation/client";
+
+import type { ConfirmModalProps } from "./confirm-modal";
+import { ConfirmModal } from "./confirm-modal";
+import type { ModalsState, ModalStateWithReference } from "./reducer";
+import { modalReducer } from "./reducer";
+import type { inferInnerProps, ModalDefinition } from "./type";
+
+interface ModalContextProps {
+ openModalInner: (props: {
+ modal: TModal;
+ innerProps: inferInnerProps;
+ options: OpenModalOptions;
+ }) => void;
+ closeModal: (id: string) => void;
+}
+
+export const ModalContext = createContext(null);
+
+export const ModalProvider = ({ children }: PropsWithChildren) => {
+ const [state, dispatch] = useReducer(modalReducer, {
+ modals: [],
+ current: null,
+ });
+ const stateRef = useRef(state);
+ stateRef.current = state;
+
+ const closeModal = useCallback(
+ (id: string, canceled?: boolean) => {
+ dispatch({ type: "CLOSE", modalId: id, canceled });
+ },
+ [stateRef, dispatch],
+ );
+
+ const openModalInner: ModalContextProps["openModalInner"] = useCallback(
+ ({ modal, innerProps, options }) => {
+ const id = randomId();
+ const { title, ...rest } = options;
+ dispatch({
+ type: "OPEN",
+ modal: {
+ id,
+ modal,
+ props: {
+ ...modal.options,
+ ...rest,
+ defaultTitle: title ?? modal.options.defaultTitle,
+ innerProps,
+ },
+ },
+ });
+ return id;
+ },
+ [dispatch],
+ );
+
+ const handleCloseModal = useCallback(
+ () => state.current && closeModal(state.current.id),
+ [closeModal, state.current?.id],
+ );
+
+ const activeModals = state.modals.filter((modal) => modal.id === state.current?.id || modal.props.keepMounted);
+
+ return (
+
+ {activeModals.map((modal) => (
+
+ );
+};
+
+interface ActiveModalProps {
+ modal: ModalStateWithReference;
+ state: ModalsState;
+ handleCloseModal: () => void;
+}
+
+const ActiveModal = ({ modal, state, handleCloseModal }: ActiveModalProps) => {
+ const t = useI18n();
+
+ // The below code is used to animate the modal when it opens (using the transition)
+ // It is necessary as transition is not working when the modal is directly mounted and run
+ const [opened, setOpened] = useState(false);
+ useEffect(() => {
+ setTimeout(() => setOpened(true), 0);
+ }, []);
+
+ const { defaultTitle: _ignored, ...otherModalProps } = modal.reference.modalProps;
+
+ return (
+
+ {modal.reference.content}
+
+ );
+};
+
+interface OpenModalOptions {
+ keepMounted?: boolean;
+ title?: stringOrTranslation;
+}
+
+export const useModalAction = (modal: TModal) => {
+ const context = useContext(ModalContext);
+
+ if (!context) throw new Error("ModalContext is not provided");
+
+ return {
+ openModal: (innerProps: inferInnerProps, options: OpenModalOptions | void) => {
+ context.openModalInner({ modal, innerProps, options: options ?? {} });
+ },
+ };
+};
+
+export const useConfirmModal = () => {
+ const { openModal } = useModalAction(ConfirmModal);
+
+ return {
+ openConfirmModal: (props: ConfirmModalProps) => openModal(props, { title: props.title }),
+ };
+};
diff --git a/packages/modals/src/reducer.tsx b/packages/modals/src/reducer.tsx
new file mode 100644
index 000000000..ab45cb386
--- /dev/null
+++ b/packages/modals/src/reducer.tsx
@@ -0,0 +1,118 @@
+"use client";
+
+import { useContext } from "react";
+
+import { ModalContext } from ".";
+import type { ModalDefinition, ModalState } from "./type";
+
+export type ModalStateWithReference = ModalState & {
+ /**
+ * Reference to modal component instance
+ * Used so the modal can be persisted between navigating in newer modals
+ */
+ reference: ReturnType;
+};
+
+export interface ModalsState {
+ modals: ModalStateWithReference[];
+
+ /**
+ * Modal that is currently open or was the last open one.
+ * Keeping the last one is necessary for providing a clean exit transition.
+ */
+ current: ModalStateWithReference | null;
+}
+
+interface OpenAction {
+ type: "OPEN";
+ modal: ModalState;
+}
+
+interface CloseAction {
+ type: "CLOSE";
+ modalId: string;
+ canceled?: boolean;
+}
+
+interface CloseAllAction {
+ type: "CLOSE_ALL";
+ canceled?: boolean;
+}
+
+export const modalReducer = (state: ModalsState, action: OpenAction | CloseAction | CloseAllAction): ModalsState => {
+ switch (action.type) {
+ case "OPEN": {
+ const newModal = {
+ ...action.modal,
+ reference: getModal(action.modal),
+ };
+ return {
+ current: newModal,
+ modals: [...state.modals, newModal],
+ };
+ }
+ case "CLOSE": {
+ const modal = state.modals.find((modal) => modal.id === action.modalId);
+ if (!modal) {
+ return state;
+ }
+
+ modal.props.onClose?.();
+
+ const remainingModals = state.modals.filter((modal) => modal.id !== action.modalId);
+
+ return {
+ current: remainingModals[remainingModals.length - 1] || state.current,
+ modals: remainingModals,
+ };
+ }
+ case "CLOSE_ALL": {
+ if (!state.modals.length) {
+ return state;
+ }
+
+ // Resolve modal stack from top to bottom
+ state.modals
+ .concat()
+ .reverse()
+ .forEach((modal) => {
+ modal.props.onClose?.();
+ });
+
+ return {
+ current: state.current,
+ modals: [],
+ };
+ }
+ default: {
+ return state;
+ }
+ }
+};
+
+const getModal = (modal: ModalState) => {
+ const ModalContent = modal.modal.component;
+
+ const { innerProps, ...rest } = modal.props;
+ const FullModal = () => {
+ const context = useContext(ModalContext);
+
+ if (!context) {
+ throw new Error("Modal component used outside of modal context");
+ }
+
+ return (
+ context.closeModal(modal.id),
+ }}
+ />
+ );
+ };
+
+ return {
+ modalProps: rest,
+ content: = (props: {
+ actions: { closeModal: () => void };
+ innerProps: TInnerProps;
+}) => ReactNode;
+
+export type CreateModalOptions = Pick<
+ ModalOptions,
+ | "size"
+ | "fullScreen"
+ | "centered"
+ | "keepMounted"
+ | "withCloseButton"
+ | "zIndex"
+ | "scrollAreaComponent"
+ | "yOffset"
+ | "transitionProps"
+ | "closeOnClickOutside"
+ | "closeOnEscape"
+> & {
+ defaultTitle: stringOrTranslation;
+};
+
+export interface ModalDefinition {
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
+ component: ModalComponent;
+ options: Partial;
+}
+
+type ModalOptions = Partial> & {
+ innerProps: TInnerProps;
+ defaultTitle?: stringOrTranslation;
+};
+
+export interface ModalState {
+ id: string;
+ modal: TModal;
+ props: ModalOptions>;
+}
+
+export type inferInnerProps =
+ TModal["component"] extends ModalComponent ? P : never;
diff --git a/packages/modals/tsconfig.json b/packages/modals/tsconfig.json
new file mode 100644
index 000000000..5f7c543a8
--- /dev/null
+++ b/packages/modals/tsconfig.json
@@ -0,0 +1,8 @@
+{
+ "extends": "@homarr/tsconfig/base.json",
+ "compilerOptions": {
+ "tsBuildInfoFile": "node_modules/.cache/tsbuildinfo.json"
+ },
+ "include": ["*.ts", "*.tsx", "src"],
+ "exclude": ["node_modules"]
+}
diff --git a/packages/notifications/package.json b/packages/notifications/package.json
index 60a01af91..73f13e79e 100644
--- a/packages/notifications/package.json
+++ b/packages/notifications/package.json
@@ -24,11 +24,11 @@
"@homarr/eslint-config": "workspace:^0.2.0",
"@homarr/prettier-config": "workspace:^0.1.0",
"@homarr/tsconfig": "workspace:^0.1.0",
- "eslint": "^8.56.0",
- "typescript": "^5.3.3"
+ "eslint": "^8.57.0",
+ "typescript": "^5.4.5"
},
"dependencies": {
- "@mantine/notifications": "^7.4.0",
+ "@mantine/notifications": "^7.9.2",
"@homarr/ui": "workspace:^0.1.0"
},
"eslintConfig": {
diff --git a/packages/notifications/src/index.tsx b/packages/notifications/src/index.tsx
index d0bf3514c..071496b20 100644
--- a/packages/notifications/src/index.tsx
+++ b/packages/notifications/src/index.tsx
@@ -1,18 +1,15 @@
import type { NotificationData } from "@mantine/notifications";
import { notifications } from "@mantine/notifications";
+import { IconCheck, IconX } from "@tabler/icons-react";
-import { IconCheck, IconX } from "@homarr/ui";
-
-type CommonNotificationProps = Pick 
+