♻️ Regenerate frontend client (#1156)

frontend/src/client/models.ts

@@ -22,7 +22,7 @@ export type ItemCreate = {
 
 
 
-export type ItemOut = {
+export type ItemPublic = {
 	title: string;
 	description?: string | null;
 	id: number;
@@ -38,8 +38,8 @@ export type ItemUpdate = {
 
 
 
-export type ItemsOut = {
-	data: Array<ItemOut>;
+export type ItemsPublic = {
+	data: Array<ItemPublic>;
 	count: number;
 };
 
@@ -82,7 +82,7 @@ export type UserCreate = {
 
 
 
-export type UserOut = {
+export type UserPublic = {
 	email: string;
 	is_active?: boolean;
 	is_superuser?: boolean;
@@ -117,8 +117,8 @@ export type UserUpdateMe = {
 
 
 
-export type UsersOut = {
-	data: Array<UserOut>;
+export type UsersPublic = {
+	data: Array<UserPublic>;
 	count: number;
 };
 

frontend/src/client/schemas.ts

@@ -68,7 +68,7 @@ export const $ItemCreate = {
 	},
 } as const;
 
-export const $ItemOut = {
+export const $ItemPublic = {
 	properties: {
 		title: {
 	type: 'string',
@@ -114,12 +114,12 @@ export const $ItemUpdate = {
 	},
 } as const;
 
-export const $ItemsOut = {
+export const $ItemsPublic = {
 	properties: {
 		data: {
 	type: 'array',
 	contains: {
-		type: 'ItemOut',
+		type: 'ItemPublic',
 	},
 	isRequired: true,
 },
@@ -207,7 +207,7 @@ export const $UserCreate = {
 	},
 } as const;
 
-export const $UserOut = {
+export const $UserPublic = {
 	properties: {
 		email: {
 	type: 'string',
@@ -315,12 +315,12 @@ export const $UserUpdateMe = {
 	},
 } as const;
 
-export const $UsersOut = {
+export const $UsersPublic = {
 	properties: {
 		data: {
 	type: 'array',
 	contains: {
-		type: 'UserOut',
+		type: 'UserPublic',
 	},
 	isRequired: true,
 },

frontend/src/client/services.ts

@@ -2,7 +2,7 @@ import type { CancelablePromise } from './core/CancelablePromise';
 import { OpenAPI } from './core/OpenAPI';
 import { request as __request } from './core/request';
 
-import type { Body_login_login_access_token,Message,NewPassword,Token,UserOut,UpdatePassword,UserCreate,UserRegister,UsersOut,UserUpdate,UserUpdateMe,ItemCreate,ItemOut,ItemsOut,ItemUpdate } from './models';
+import type { Body_login_login_access_token,Message,NewPassword,Token,UserPublic,UpdatePassword,UserCreate,UserRegister,UsersPublic,UserUpdate,UserUpdateMe,ItemCreate,ItemPublic,ItemsPublic,ItemUpdate } from './models';
 
 export type TDataLoginAccessToken = {
                 formData: Body_login_login_access_token
@@ -47,10 +47,10 @@ formData,
 	/**
 	 * Test Token
 	 * Test access token
-	 * @returns UserOut Successful Response
+	 * @returns UserPublic Successful Response
 	 * @throws ApiError
 	 */
-	public static testToken(): CancelablePromise<UserOut> {
+	public static testToken(): CancelablePromise<UserPublic> {
 				return __request(OpenAPI, {
 			method: 'POST',
 			url: '/api/v1/login/test-token',
@@ -164,10 +164,10 @@ export class UsersService {
 	/**
 	 * Read Users
 	 * Retrieve users.
-	 * @returns UsersOut Successful Response
+	 * @returns UsersPublic Successful Response
 	 * @throws ApiError
 	 */
-	public static readUsers(data: TDataReadUsers = {}): CancelablePromise<UsersOut> {
+	public static readUsers(data: TDataReadUsers = {}): CancelablePromise<UsersPublic> {
 		const {
 limit = 100,
 skip = 0,
@@ -187,10 +187,10 @@ skip = 0,
 	/**
 	 * Create User
 	 * Create new user.
-	 * @returns UserOut Successful Response
+	 * @returns UserPublic Successful Response
 	 * @throws ApiError
 	 */
-	public static createUser(data: TDataCreateUser): CancelablePromise<UserOut> {
+	public static createUser(data: TDataCreateUser): CancelablePromise<UserPublic> {
 		const {
 requestBody,
 } = data;
@@ -208,10 +208,10 @@ requestBody,
 	/**
 	 * Read User Me
 	 * Get current user.
-	 * @returns UserOut Successful Response
+	 * @returns UserPublic Successful Response
 	 * @throws ApiError
 	 */
-	public static readUserMe(): CancelablePromise<UserOut> {
+	public static readUserMe(): CancelablePromise<UserPublic> {
 				return __request(OpenAPI, {
 			method: 'GET',
 			url: '/api/v1/users/me',
@@ -221,10 +221,10 @@ requestBody,
 	/**
 	 * Update User Me
 	 * Update own user.
-	 * @returns UserOut Successful Response
+	 * @returns UserPublic Successful Response
 	 * @throws ApiError
 	 */
-	public static updateUserMe(data: TDataUpdateUserMe): CancelablePromise<UserOut> {
+	public static updateUserMe(data: TDataUpdateUserMe): CancelablePromise<UserPublic> {
 		const {
 requestBody,
 } = data;
@@ -263,10 +263,10 @@ requestBody,
 	/**
 	 * Register User
 	 * Create new user without the need to be logged in.
-	 * @returns UserOut Successful Response
+	 * @returns UserPublic Successful Response
 	 * @throws ApiError
 	 */
-	public static registerUser(data: TDataRegisterUser): CancelablePromise<UserOut> {
+	public static registerUser(data: TDataRegisterUser): CancelablePromise<UserPublic> {
 		const {
 requestBody,
 } = data;
@@ -284,10 +284,10 @@ requestBody,
 	/**
 	 * Read User By Id
 	 * Get a specific user by id.
-	 * @returns UserOut Successful Response
+	 * @returns UserPublic Successful Response
 	 * @throws ApiError
 	 */
-	public static readUserById(data: TDataReadUserById): CancelablePromise<UserOut> {
+	public static readUserById(data: TDataReadUserById): CancelablePromise<UserPublic> {
 		const {
 userId,
 } = data;
@@ -306,10 +306,10 @@ userId,
 	/**
 	 * Update User
 	 * Update a user.
-	 * @returns UserOut Successful Response
+	 * @returns UserPublic Successful Response
 	 * @throws ApiError
 	 */
-	public static updateUser(data: TDataUpdateUser): CancelablePromise<UserOut> {
+	public static updateUser(data: TDataUpdateUser): CancelablePromise<UserPublic> {
 		const {
 requestBody,
 userId,
@@ -411,10 +411,10 @@ export class ItemsService {
 	/**
 	 * Read Items
 	 * Retrieve items.
-	 * @returns ItemsOut Successful Response
+	 * @returns ItemsPublic Successful Response
 	 * @throws ApiError
 	 */
-	public static readItems(data: TDataReadItems = {}): CancelablePromise<ItemsOut> {
+	public static readItems(data: TDataReadItems = {}): CancelablePromise<ItemsPublic> {
 		const {
 limit = 100,
 skip = 0,
@@ -434,10 +434,10 @@ skip = 0,
 	/**
 	 * Create Item
 	 * Create new item.
-	 * @returns ItemOut Successful Response
+	 * @returns ItemPublic Successful Response
 	 * @throws ApiError
 	 */
-	public static createItem(data: TDataCreateItem): CancelablePromise<ItemOut> {
+	public static createItem(data: TDataCreateItem): CancelablePromise<ItemPublic> {
 		const {
 requestBody,
 } = data;
@@ -455,10 +455,10 @@ requestBody,
 	/**
 	 * Read Item
 	 * Get item by ID.
-	 * @returns ItemOut Successful Response
+	 * @returns ItemPublic Successful Response
 	 * @throws ApiError
 	 */
-	public static readItem(data: TDataReadItem): CancelablePromise<ItemOut> {
+	public static readItem(data: TDataReadItem): CancelablePromise<ItemPublic> {
 		const {
 id,
 } = data;
@@ -477,10 +477,10 @@ id,
 	/**
 	 * Update Item
 	 * Update an item.
-	 * @returns ItemOut Successful Response
+	 * @returns ItemPublic Successful Response
 	 * @throws ApiError
 	 */
-	public static updateItem(data: TDataUpdateItem): CancelablePromise<ItemOut> {
+	public static updateItem(data: TDataUpdateItem): CancelablePromise<ItemPublic> {
 		const {
 id,
 requestBody,

frontend/src/components/Admin/EditUser.tsx

@@ -19,7 +19,7 @@ import { useMutation, useQueryClient } from "@tanstack/react-query"
 
 import {
   type ApiError,
-  type UserOut,
+  type UserPublic,
   type UserUpdate,
   UsersService,
 } from "../../client"
@@ -27,7 +27,7 @@ import useCustomToast from "../../hooks/useCustomToast"
 import { emailPattern } from "../../utils"
 
 interface EditUserProps {
-  user: UserOut
+  user: UserPublic
   isOpen: boolean
   onClose: () => void
 }

frontend/src/components/Common/ActionsMenu.tsx

@@ -9,14 +9,14 @@ import {
 import { BsThreeDotsVertical } from "react-icons/bs"
 import { FiEdit, FiTrash } from "react-icons/fi"
 
-import type { ItemOut, UserOut } from "../../client"
+import type { ItemPublic, UserPublic } from "../../client"
 import EditUser from "../Admin/EditUser"
 import EditItem from "../Items/EditItem"
 import Delete from "./DeleteAlert"
 
 interface ActionsMenuProps {
   type: string
-  value: ItemOut | UserOut
+  value: ItemPublic | UserPublic
   disabled?: boolean
 }
 
@@ -50,13 +50,13 @@ const ActionsMenu = ({ type, value, disabled }: ActionsMenuProps) => {
         </MenuList>
         {type === "User" ? (
           <EditUser
-            user={value as UserOut}
+            user={value as UserPublic}
             isOpen={editUserModal.isOpen}
             onClose={editUserModal.onClose}
           />
         ) : (
           <EditItem
-            item={value as ItemOut}
+            item={value as ItemPublic}
             isOpen={editUserModal.isOpen}
             onClose={editUserModal.onClose}
           />

frontend/src/components/Common/Sidebar.tsx

@@ -16,7 +16,7 @@ import { FiLogOut, FiMenu } from "react-icons/fi"
 import { useQueryClient } from "@tanstack/react-query"
 
 import Logo from "../../assets/images/fastapi-logo.svg"
-import type { UserOut } from "../../client"
+import type { UserPublic } from "../../client"
 import useAuth from "../../hooks/useAuth"
 import SidebarItems from "./SidebarItems"
 
@@ -25,7 +25,7 @@ const Sidebar = () => {
   const bgColor = useColorModeValue("ui.light", "ui.dark")
   const textColor = useColorModeValue("ui.dark", "ui.light")
   const secBgColor = useColorModeValue("ui.secondary", "ui.darkSlate")
-  const currentUser = queryClient.getQueryData<UserOut>(["currentUser"])
+  const currentUser = queryClient.getQueryData<UserPublic>(["currentUser"])
   const { isOpen, onOpen, onClose } = useDisclosure()
   const { logout } = useAuth()
 

frontend/src/components/Common/SidebarItems.tsx

@@ -3,7 +3,7 @@ import { Link } from "@tanstack/react-router"
 import { FiBriefcase, FiHome, FiSettings, FiUsers } from "react-icons/fi"
 import { useQueryClient } from "@tanstack/react-query"
 
-import type { UserOut } from "../../client"
+import type { UserPublic } from "../../client"
 
 const items = [
   { icon: FiHome, title: "Dashboard", path: "/" },
@@ -19,7 +19,7 @@ const SidebarItems = ({ onClose }: SidebarItemsProps) => {
   const queryClient = useQueryClient()
   const textColor = useColorModeValue("ui.main", "ui.light")
   const bgActive = useColorModeValue("#E2E8F0", "#4A5568")
-  const currentUser = queryClient.getQueryData<UserOut>(["currentUser"])
+  const currentUser = queryClient.getQueryData<UserPublic>(["currentUser"])
 
   const finalItems = currentUser?.is_superuser
     ? [...items, { icon: FiUsers, title: "Admin", path: "/admin" }]

frontend/src/components/Items/EditItem.tsx

@@ -17,14 +17,14 @@ import { useMutation, useQueryClient } from "@tanstack/react-query"
 
 import {
   type ApiError,
-  type ItemOut,
+  type ItemPublic,
   type ItemUpdate,
   ItemsService,
 } from "../../client"
 import useCustomToast from "../../hooks/useCustomToast"
 
 interface EditItemProps {
-  item: ItemOut
+  item: ItemPublic
   isOpen: boolean
   onClose: () => void
 }

frontend/src/components/UserSettings/DeleteConfirmation.tsx

@@ -11,7 +11,7 @@ import React from "react"
 import { useForm } from "react-hook-form"
 import { useMutation, useQueryClient } from "@tanstack/react-query"
 
-import { type ApiError, type UserOut, UsersService } from "../../client"
+import { type ApiError, type UserPublic, UsersService } from "../../client"
 import useAuth from "../../hooks/useAuth"
 import useCustomToast from "../../hooks/useCustomToast"
 
@@ -28,7 +28,7 @@ const DeleteConfirmation = ({ isOpen, onClose }: DeleteProps) => {
     handleSubmit,
     formState: { isSubmitting },
   } = useForm()
-  const currentUser = queryClient.getQueryData<UserOut>(["currentUser"])
+  const currentUser = queryClient.getQueryData<UserPublic>(["currentUser"])
   const { logout } = useAuth()
 
   const mutation = useMutation({

frontend/src/components/UserSettings/UserInformation.tsx

@@ -17,7 +17,7 @@ import { useMutation, useQueryClient } from "@tanstack/react-query"
 
 import {
   type ApiError,
-  type UserOut,
+  type UserPublic,
   type UserUpdateMe,
   UsersService,
 } from "../../client"
@@ -37,7 +37,7 @@ const UserInformation = () => {
     reset,
     getValues,
     formState: { isSubmitting, errors, isDirty },
-  } = useForm<UserOut>({
+  } = useForm<UserPublic>({
     mode: "onBlur",
     criteriaMode: "all",
     defaultValues: {

frontend/src/hooks/useAuth.ts

@@ -6,7 +6,7 @@ import {
   type Body_login_login_access_token as AccessToken,
   type ApiError,
   LoginService,
-  type UserOut,
+  type UserPublic,
   UsersService,
 } from "../client"
 
@@ -17,7 +17,7 @@ const isLoggedIn = () => {
 const useAuth = () => {
   const [error, setError] = useState<string | null>(null)
   const navigate = useNavigate()
-  const { data: user, isLoading } = useQuery<UserOut | null, Error>({
+  const { data: user, isLoading } = useQuery<UserPublic | null, Error>({
     queryKey: ["currentUser"],
     queryFn: UsersService.readUserMe,
     enabled: isLoggedIn(),

frontend/src/routes/_layout/admin.tsx

@@ -16,7 +16,7 @@ import {
 import { createFileRoute } from "@tanstack/react-router"
 import { useQuery, useQueryClient } from "@tanstack/react-query"
 
-import { type UserOut, UsersService } from "../../client"
+import { type UserPublic, UsersService } from "../../client"
 import ActionsMenu from "../../components/Common/ActionsMenu"
 import Navbar from "../../components/Common/Navbar"
 import useCustomToast from "../../hooks/useCustomToast"
@@ -28,7 +28,7 @@ export const Route = createFileRoute("/_layout/admin")({
 function Admin() {
   const queryClient = useQueryClient()
   const showToast = useCustomToast()
-  const currentUser = queryClient.getQueryData<UserOut>(["currentUser"])
+  const currentUser = queryClient.getQueryData<UserPublic>(["currentUser"])
   const {
     data: users,
     isLoading,

frontend/src/routes/_layout/index.tsx

@@ -2,7 +2,7 @@ import { Box, Container, Text } from "@chakra-ui/react"
 import { createFileRoute } from "@tanstack/react-router"
 import { useQueryClient } from "@tanstack/react-query"
 
-import type { UserOut } from "../../client"
+import type { UserPublic } from "../../client"
 
 export const Route = createFileRoute("/_layout/")({
   component: Dashboard,
@@ -11,7 +11,7 @@ export const Route = createFileRoute("/_layout/")({
 function Dashboard() {
   const queryClient = useQueryClient()
 
-  const currentUser = queryClient.getQueryData<UserOut>(["currentUser"])
+  const currentUser = queryClient.getQueryData<UserPublic>(["currentUser"])
 
   return (
     <>

frontend/src/routes/_layout/settings.tsx

@@ -10,7 +10,7 @@ import {
 import { createFileRoute } from "@tanstack/react-router"
 import { useQueryClient } from "@tanstack/react-query"
 
-import type { UserOut } from "../../client"
+import type { UserPublic } from "../../client"
 import Appearance from "../../components/UserSettings/Appearance"
 import ChangePassword from "../../components/UserSettings/ChangePassword"
 import DeleteAccount from "../../components/UserSettings/DeleteAccount"
@@ -29,7 +29,7 @@ export const Route = createFileRoute("/_layout/settings")({
 
 function UserSettings() {
   const queryClient = useQueryClient()
-  const currentUser = queryClient.getQueryData<UserOut>(["currentUser"])
+  const currentUser = queryClient.getQueryData<UserPublic>(["currentUser"])
   const finalTabs = currentUser?.is_superuser
     ? tabsConfig.slice(0, 3)
     : tabsConfig