Merge pull request #129 from AnonymusRaccoon/feat/models

Add a model package and a fetch component

front/Dockerfile

@@ -8,6 +8,7 @@ COPY apps/web/package.json apps/web/package.json
 COPY apps/mobile/package.json apps/mobile/package.json
 COPY packages/ui/package.json packages/ui/package.json
 COPY packages/primitives/package.json packages/primitives/package.json
+COPY packages/models/package.json packages/models/package.json
 RUN yarn --immutable
 
 COPY . .

front/Dockerfile.dev

@@ -8,6 +8,7 @@ COPY apps/web/package.json apps/web/package.json
 COPY apps/mobile/package.json apps/mobile/package.json
 COPY packages/ui/package.json packages/ui/package.json
 COPY packages/primitives/package.json packages/primitives/package.json
+COPY packages/models/package.json packages/models/package.json
 RUN yarn --immutable
 
 ENV NEXT_TELEMETRY_DISABLED 1

front/apps/mobile/app.json

@@ -4,7 +4,7 @@
 		"slug": "kyoo",
 		"scheme": "kyoo",
 		"version": "1.0.0",
-		"orientation": "portrait",
+		"orientation": "default",
 		"icon": "./assets/icon.png",
 		"entryPoint": "./index.ts",
 		"userInterfaceStyle": "light",

front/apps/mobile/app/_layout.tsx

@@ -22,6 +22,9 @@ import { Stack } from "expo-router";
 import { Avatar, ThemeSelector } from "@kyoo/primitives";
 import { useTheme } from "yoshiki/native";
 import { NavbarTitle } from "@kyoo/ui";
+import { useState } from "react";
+import { QueryClientProvider } from "@tanstack/react-query";
+import { createQueryClient } from "@kyoo/models";
 
 const ThemedStack = () => {
 	const theme = useTheme();
@@ -44,9 +47,13 @@ const ThemedStack = () => {
 };
 
 export default function Root() {
+	const [queryClient] = useState(() => createQueryClient());
+
 	return (
-		<ThemeSelector>
-			<ThemedStack />
-		</ThemeSelector>
+		<QueryClientProvider client={queryClient}>
+			<ThemeSelector>
+				<ThemedStack />
+			</ThemeSelector>
+		</QueryClientProvider>
 	);
 }

front/apps/mobile/app/index.tsx

@@ -18,6 +18,7 @@
  * along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
  */
 
+import { Navbar } from "@kyoo/ui";
 import { Text, View } from "react-native";
 import { useYoshiki } from "yoshiki/native";
 
@@ -26,7 +27,7 @@ const App = () => {
 
 	return (
 		<View {...css({ backgroundColor: (theme) => theme.background })}>
-			{/* <Navbar /> */}
+			<Navbar />
 			<Text>toto</Text>
 		</View>
 	);

front/apps/mobile/metro.config.js

@@ -1,4 +1,23 @@
-// Learn more https://docs.expo.dev/guides/monorepos
+/*
+ * Kyoo - A portable and vast media library solution.
+ * Copyright (c) Kyoo.
+ *
+ * See AUTHORS.md and LICENSE file in the project root for full license information.
+ *
+ * Kyoo is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * any later version.
+ *
+ * Kyoo is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
+ */
+
 const { getDefaultConfig } = require("expo/metro-config");
 const path = require("path");
 

front/apps/web/next.config.js

@@ -81,6 +81,7 @@ const nextConfig = {
 		transpilePackages: [
 			"@kyoo/ui",
 			"@kyoo/primitives",
+			"@kyoo/models",
 			"solito",
 			"react-native",
 			"react-native-web",

front/apps/web/package.json

@@ -14,12 +14,12 @@
 		"@emotion/react": "^11.9.3",
 		"@emotion/styled": "^11.9.3",
 		"@jellyfin/libass-wasm": "^4.1.1",
+		"@kyoo/models": "workspace:^",
 		"@kyoo/primitives": "workspace:^",
 		"@kyoo/ui": "workspace:^",
 		"@mui/icons-material": "^5.8.4",
 		"@mui/material": "^5.8.7",
 		"@mui/system": "^5.10.10",
-		"@tanstack/react-query": "^4.18.0",
 		"clsx": "^1.2.1",
 		"csstype": "^3.1.1",
 		"hls.js": "^1.2.8",

front/apps/web/src/models.ts

@@ -18,16 +18,4 @@
  * along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
  */
 
-import { z } from "zod";
-
-export const zdate = () => {
-	return z.preprocess((arg) => {
-		if (arg instanceof Date) return arg;
-
-		if (typeof arg === "string" && /\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z?/.test(arg)) {
-			return new Date(arg);
-		}
-
-		return undefined;
-	}, z.date());
-};
+export * from "@kyoo/models";

front/apps/web/src/pages/_app.tsx

@@ -24,7 +24,7 @@ import { useTheme, useMobileHover } from "yoshiki/web";
 import { createTheme, ThemeProvider as MTheme } from "@mui/material";
 import NextApp, { AppContext, type AppProps } from "next/app";
 import { Hydrate, QueryClientProvider } from "@tanstack/react-query";
-import { createQueryClient, fetchQuery, QueryIdentifier, QueryPage } from "~/utils/query";
+import { createQueryClient, fetchQuery, QueryIdentifier, QueryPage } from "@kyoo/models";
 import superjson from "superjson";
 import Head from "next/head";
 import { ThemeSelector as KThemeSelector } from "@kyoo/primitives";

front/apps/web/src/pages/browse/index.tsx

@@ -39,11 +39,11 @@ import { ErrorPage } from "~/components/errors";
 import { Navbar } from "@kyoo/ui";
 import { Poster, Image } from "@kyoo/primitives";
 import { ItemType, LibraryItem, LibraryItemP } from "~/models";
-import { getDisplayDate } from "~/models/utils";
+import { getDisplayDate } from "@kyoo/models";
 import { InfiniteScroll } from "~/utils/infinite-scroll";
 import { Link } from "~/utils/link";
 import { withRoute } from "~/utils/router";
-import { QueryIdentifier, QueryPage, useInfiniteFetch } from "~/utils/query";
+import { QueryIdentifier, QueryPage, useInfiniteFetch } from "@kyoo/models";
 import { px } from "yoshiki/native";
 
 enum SortBy {

front/packages/models/package.json

@@ -0,0 +1,23 @@
+{
+	"name": "@kyoo/models",
+	"main": "src/index.ts",
+	"types": "src/index.ts",
+	"packageManager": "yarn@3.2.4",
+	"devDependencies": {
+		"@types/react": "^18.0.25",
+		"typescript": "^4.9.3"
+	},
+	"peerDependencies": {
+		"react": "*",
+		"react-native": "*"
+	},
+	"peerDependenciesMeta": {
+		"react-native-web": {
+			"optional": true
+		}
+	},
+	"dependencies": {
+		"@tanstack/react-query": "^4.18.0",
+		"zod": "^3.19.1"
+	}
+}

front/packages/models/src/index.ts

@@ -18,7 +18,10 @@
  * along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
  */
 
+export * from "./resources";
+export * from "./traits";
 export * from "./page";
 export * from "./kyoo-errors";
-export * from "./traits";
-export * from "./resources";
+export * from "./utils"
+
+export * from "./query";

front/packages/models/src/query.tsx

@@ -27,10 +27,10 @@ import {
 	useQuery,
 } from "@tanstack/react-query";
 import { z } from "zod";
-import { KyooErrors, Page } from "~/models";
-import { Paged } from "~/models/page";
+import { KyooErrors } from "./kyoo-errors";
+import { Page, Paged } from "./page";
 
-const queryFn = async <Data>(
+const queryFn = async <Data,>(
 	type: z.ZodType<Data>,
 	context: QueryFunctionContext,
 ): Promise<Data> => {
@@ -104,13 +104,13 @@ export type QueryPage<Props = {}> = ComponentType<Props> & {
 	getLayout?: (page: ReactElement) => ReactNode;
 };
 
-const toQueryKey = <Data>(query: QueryIdentifier<Data>) => {
+const toQueryKey = <Data,>(query: QueryIdentifier<Data>) => {
 	if (query.params) {
 		return [
 			...query.path,
 			"?" +
 				Object.entries(query.params)
-					.filter(([k, v]) => v !== undefined)
+					.filter(([_, v]) => v !== undefined)
 					.map(([k, v]) => `${k}=${Array.isArray(v) ? v.join(",") : v}`)
 					.join("&"),
 		];
@@ -119,14 +119,14 @@ const toQueryKey = <Data>(query: QueryIdentifier<Data>) => {
 	}
 };
 
-export const useFetch = <Data>(query: QueryIdentifier<Data>) => {
+export const useFetch = <Data,>(query: QueryIdentifier<Data>) => {
 	return useQuery<Data, KyooErrors>({
 		queryKey: toQueryKey(query),
 		queryFn: (ctx) => queryFn(query.parser, ctx),
 	});
 };
 
-export const useInfiniteFetch = <Data>(query: QueryIdentifier<Data>) => {
+export const useInfiniteFetch = <Data,>(query: QueryIdentifier<Data>) => {
 	const ret = useInfiniteQuery<Page<Data>, KyooErrors>({
 		queryKey: toQueryKey(query),
 		queryFn: (ctx) => queryFn(Paged(query.parser), ctx),

front/packages/models/src/resources/episode.ts

@@ -19,7 +19,7 @@
  */
 
 import { z } from "zod";
-import { zdate } from "~/utils/zod";
+import { zdate } from "../utils";
 import { ImagesP } from "../traits";
 import { ResourceP } from "../traits/resource";
 

front/packages/models/src/resources/library-item.ts

@@ -34,7 +34,7 @@ export enum ItemType {
 
 export const LibraryItemP = z.preprocess(
 	(x: any) => {
-		x.aliases ??= [];
+		if (!x.aliases) x.aliases = [];
 		return x;
 	},
 	z.union([

front/packages/models/src/resources/movie.ts

@@ -19,7 +19,7 @@
  */
 
 import { z } from "zod";
-import { zdate } from "~/utils/zod";
+import { zdate } from "../utils";
 import { ImagesP, ResourceP } from "../traits";
 import { GenreP } from "./genre";
 import { StudioP } from "./studio";

front/packages/models/src/resources/season.ts

@@ -19,7 +19,7 @@
  */
 
 import { z } from "zod";
-import { zdate } from "~/utils/zod";
+import { zdate } from "../utils";
 import { ImagesP } from "../traits";
 import { ResourceP } from "../traits/resource";
 

front/packages/models/src/resources/show.ts

@@ -19,7 +19,7 @@
  */
 
 import { z } from "zod";
-import { zdate } from "~/utils/zod";
+import { zdate } from "../utils";
 import { ImagesP, ResourceP } from "../traits";
 import { GenreP } from "./genre";
 import { SeasonP } from "./season";

front/packages/models/src/resources/watch-item.ts

@@ -19,7 +19,7 @@
  */
 
 import { z } from "zod";
-import { zdate } from "~/utils/zod";
+import { zdate } from "../utils";
 import { ResourceP, ImagesP, imageFn } from "../traits";
 import { EpisodeP } from "./episode";
 

front/packages/models/src/utils.ts

@@ -19,6 +19,19 @@
  */
 
 import { Movie, Show } from "./resources";
+import { z } from "zod";
+
+export const zdate = () => {
+	return z.preprocess((arg) => {
+		if (arg instanceof Date) return arg;
+
+		if (typeof arg === "string" && /\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z?/.test(arg)) {
+			return new Date(arg);
+		}
+
+		return undefined;
+	}, z.date());
+};
 
 export const getDisplayDate = (data: Show | Movie) => {
 	const {

front/packages/models/tsconfig.json

@@ -0,0 +1,26 @@
+{
+	"compilerOptions": {
+		"target": "es5",
+		"lib": ["dom", "dom.iterable", "esnext"],
+		"declaration": true,
+		"sourceMap": true,
+		"noEmit": true,
+		"allowJs": true,
+		"skipLibCheck": true,
+		"strict": true,
+		"forceConsistentCasingInFileNames": true,
+		"esModuleInterop": true,
+		"module": "esnext",
+		"moduleResolution": "node",
+		"resolveJsonModule": true,
+		"isolatedModules": true,
+		"jsx": "react-jsx",
+		"incremental": true,
+		"baseUrl": ".",
+		"paths": {
+			"~/*": ["src/*"]
+		}
+	},
+	"include": ["**/*.ts", "**/*.tsx"],
+	"exclude": ["node_modules"]
+}

front/packages/primitives/package.json

@@ -20,6 +20,7 @@
 	"dependencies": {
 		"@expo/html-elements": "^0.2.2",
 		"@expo/vector-icons": "AnonymusRaccoon/expo-vector-icons#no-prepare",
+		"@tanstack/react-query": "^4.18.0",
 		"solito": "^2.0.5"
 	}
 }

front/packages/primitives/src/themes/catppuccin.ts

@@ -20,12 +20,14 @@
 
 import { ThemeBuilder } from "./theme";
 
+// Ref: https://github.com/catppuccin/catppuccin
 export const catppuccin: ThemeBuilder = {
 	fonts: {
 		heading: "Pacifico",
 		paragraph: "Poppins",
 	},
 	light: {
+		// Catppuccin latte
 		appbar: "#e64553",
 		contrast: "#cdd6f4",
 		subcontrast: "#bac2de",
@@ -45,8 +47,17 @@ export const catppuccin: ThemeBuilder = {
 			paragraph: "#5c5f77",
 			subtext: "#6c6f85",
 		},
+		colors: {
+			red: "#d20f39",
+			green: "#40a02b",
+			blue: "#1e66f5",
+			yellow: "#df8e1d",
+			black: "#4c4f69",
+			white: "#eff1f5",
+		},
 	},
 	dark: {
+		// Catppuccin mocha
 		appbar: "#94e2d5",
 		contrast: "#cdd6f4",
 		subcontrast: "#bac2de",
@@ -66,5 +77,13 @@ export const catppuccin: ThemeBuilder = {
 			paragraph: "#bac2de",
 			subtext: "#a6adc8",
 		},
+		colors: {
+			red: "#f38ba8",
+			green: "#a6e3a1",
+			blue: "#89b4fa",
+			yellow: "#f9e2af",
+			black: "#11111b",
+			white: "#cdd6f4",
+		},
 	},
 };

front/packages/primitives/src/themes/theme.tsx

@@ -39,6 +39,14 @@ type Mode = {
 	contrast: Property.Color;
 	subcontrast: Property.Color;
 	variant: Variant;
+	colors: {
+		red: Property.Color,
+		green: Property.Color,
+		blue: Property.Color,
+		yellow: Property.Color,
+		white: Property.Color,
+		black: Property.Color,
+	}
 };
 
 type Variant = {

front/packages/primitives/tsconfig.json

@@ -14,7 +14,7 @@
 		"moduleResolution": "node",
 		"resolveJsonModule": true,
 		"isolatedModules": true,
-		"jsx": "react-native",
+		"jsx": "react-jsx",
 		"incremental": true,
 		"baseUrl": ".",
 		"paths": {

front/packages/ui/package.json

@@ -4,6 +4,7 @@
 	"types": "src/index.ts",
 	"packageManager": "yarn@3.2.4",
 	"dependencies": {
+		"@kyoo/models": "workspace:^",
 		"@kyoo/primitives": "workspace:^",
 		"react-native-svg": "^13.6.0"
 	},

front/packages/ui/src/fetch.tsx

@@ -0,0 +1,73 @@
+/*
+ * Kyoo - A portable and vast media library solution.
+ * Copyright (c) Kyoo.
+ *
+ * See AUTHORS.md and LICENSE file in the project root for full license information.
+ *
+ * Kyoo is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * any later version.
+ *
+ * Kyoo is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+import { Page, QueryIdentifier, useFetch, KyooErrors } from "@kyoo/models";
+import { P } from "@kyoo/primitives";
+import { View } from "react-native";
+import { useYoshiki } from "yoshiki/native";
+
+export type WithLoading<Item> = (Item & { isLoading: false }) | { isLoading: true };
+
+const isPage = <T = unknown,>(obj: unknown): obj is Page<T> =>
+	(typeof obj === "object" && obj && "items" in obj) || false;
+
+export const Fetch = <Data,>({
+	query,
+	placeholderCount,
+	children,
+}: {
+	query: QueryIdentifier<Data>;
+	placeholderCount: number;
+	children: (
+		item: Data extends Page<infer Item> ? WithLoading<Item> : WithLoading<Data>,
+		i: number,
+	) => JSX.Element | null;
+}): JSX.Element | null => {
+	const { data, error } = useFetch(query);
+
+	if (error) return <ErrorView error={error} />;
+	if (!data)
+		return (
+			<>{[...Array(placeholderCount)].map((_, i) => children({ isLoading: true } as any, i))}</>
+		);
+	if (!isPage<object>(data))
+		return children(data ? { ...data, isLoading: false } : ({ isLoading: true } as any), 0);
+	return <>{data.items.map((item, i) => children({ ...item, isLoading: false } as any, i))}</>;
+};
+
+export const ErrorView = ({ error }: { error: KyooErrors }) => {
+	const { css } = useYoshiki();
+
+	return (
+		<View
+			{...css({
+				backgroundColor: (theme) => theme.colors.red,
+				flex: 1,
+				alignItems: "center"
+			})}
+		>
+			{error.errors.map((x, i) => (
+				<P key={i} {...css({ color: (theme) => theme.colors.white })}>
+					{x}
+				</P>
+			))}
+		</View>
+	);
+};

front/packages/ui/src/navbar/index.tsx

@@ -19,12 +19,11 @@
  */
 
 import useTranslation from "next-translate/useTranslation";
-/* import { Library, LibraryP, Page, Paged } from "~/models"; */
-/* import { QueryIdentifier, useFetch } from "~/utils/query"; */
-/* import { ErrorSnackbar } from "./errors"; */
-import { useYoshiki } from "yoshiki/native";
+import { Library, LibraryP, Page, Paged, QueryIdentifier } from "@kyoo/models";
 import { IconButton, Header, Avatar, A, ts } from "@kyoo/primitives";
-import { View } from "react-native";
+import { useYoshiki } from "yoshiki/native";
+import { Text, View } from "react-native";
+import { Fetch } from "../fetch";
 import { KyooLongLogo } from "./icon";
 
 const tooltip = (tooltip: string): object => ({});
@@ -34,7 +33,6 @@ export const NavbarTitle = KyooLongLogo;
 export const Navbar = () => {
 	const { css } = useYoshiki();
 	const { t } = useTranslation("common");
-	/* const { data, error, isSuccess, isError } = useFetch(Navbar.query()); */
 
 	return (
 		<Header
@@ -67,35 +65,36 @@ export const Navbar = () => {
 			<View
 				{...css({
 					flexGrow: 1,
+					flexShrink: 1,
 					flexDirection: "row",
 					display: { xs: "none", sm: "flex" },
-					marginLeft: ts(2),
+					marginX: ts(2),
 				})}
 			>
-				{
-					/*isSuccess
-					? data.items.map((library) => */ true
-						? [...Array(4)].map((_, i) => (
-								<A
-									href={`/browse/${i /* library.slug */}`}
-									key={i} //{library.slug}
-									{...css({
-										marginX: ts(1),
-										textTransform: "uppercase",
-										color: "white",
-									})}
-								>
-									Toto
-									{/* {library.name} */}
-								</A>
-						  ))
-						: [...Array(4)].map(
-								(_, i) => null,
-								/* <Typography key={i} variant="button" px=".25rem"> */
-								/* 	<Skeleton width="5rem" /> */
-								/* </Typography> */
-						  )
-				}
+				<Fetch query={Navbar.query()} placeholderCount={4}>
+					{(library, i) =>
+						!library.isLoading ? (
+							<A
+								href={`/browse/${library.slug}`}
+								key={library.slug}
+								{...css({
+									marginX: ts(1),
+									textTransform: "uppercase",
+									color: "white",
+								})}
+							>
+								{library.name}
+							</A>
+						) : (
+							<>
+								<Text>Toto</Text>
+								{/* <Typography key={i} variant="button" px=".25rem"> */}
+								{/* 	<Skeleton width="5rem" /> */}
+								{/* </Typography> */}
+							</>
+						)
+					}
+				</Fetch>
 			</View>
 			<A href="/auth/login" {...tooltip(t("navbar.login"))}>
 				<Avatar alt={t("navbar.login")} size={30} />
@@ -105,7 +104,7 @@ export const Navbar = () => {
 	);
 };
 
-/* Navbar.query = (): QueryIdentifier<Page<Library>> => ({ */
-/* 	parser: Paged(LibraryP), */
-/* 	path: ["libraries"], */
-/* }); */
+Navbar.query = (): QueryIdentifier<Page<Library>> => ({
+	parser: Paged(LibraryP),
+	path: ["libraries"],
+});

front/packages/ui/tsconfig.json

@@ -15,8 +15,6 @@
 		"resolveJsonModule": true,
 		"isolatedModules": true,
 		"jsx": "react-jsx",
-		"jsxImportSource": "@emotion/react",
-		"types": ["@emotion/react/types/css-prop"],
 		"incremental": true,
 		"baseUrl": ".",
 		"paths": {

front/yarn.lock

@@ -2341,12 +2341,30 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@kyoo/models@workspace:^, @kyoo/models@workspace:packages/models":
+  version: 0.0.0-use.local
+  resolution: "@kyoo/models@workspace:packages/models"
+  dependencies:
+    "@tanstack/react-query": ^4.18.0
+    "@types/react": ^18.0.25
+    typescript: ^4.9.3
+    zod: ^3.19.1
+  peerDependencies:
+    react: "*"
+    react-native: "*"
+  peerDependenciesMeta:
+    react-native-web:
+      optional: true
+  languageName: unknown
+  linkType: soft
+
 "@kyoo/primitives@workspace:^, @kyoo/primitives@workspace:packages/primitives":
   version: 0.0.0-use.local
   resolution: "@kyoo/primitives@workspace:packages/primitives"
   dependencies:
     "@expo/html-elements": ^0.2.2
     "@expo/vector-icons": "AnonymusRaccoon/expo-vector-icons#no-prepare"
+    "@tanstack/react-query": ^4.18.0
     "@types/react": ^18.0.25
     solito: ^2.0.5
     typescript: ^4.9.3
@@ -2364,6 +2382,7 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "@kyoo/ui@workspace:packages/ui"
   dependencies:
+    "@kyoo/models": "workspace:^"
     "@kyoo/primitives": "workspace:^"
     "@types/react": ^18.0.25
     react-native-svg: ^13.6.0
@@ -12907,12 +12926,12 @@ __metadata:
     "@emotion/react": ^11.9.3
     "@emotion/styled": ^11.9.3
     "@jellyfin/libass-wasm": ^4.1.1
+    "@kyoo/models": "workspace:^"
     "@kyoo/primitives": "workspace:^"
     "@kyoo/ui": "workspace:^"
     "@mui/icons-material": ^5.8.4
     "@mui/material": ^5.8.7
     "@mui/system": ^5.10.10
-    "@tanstack/react-query": ^4.18.0
     "@types/node": 18.11.9
     "@types/react": 18.0.25
     "@types/react-dom": 18.0.9