@leo-h/create-nodejs-app 1.0.37 → 1.0.39

package/templates/react-vite/scripts/orval-generate-api-definition.ts

@@ -1,9 +1,9 @@
+import { privateEnv } from "@/private-env";
 import { execSync } from "node:child_process";
 import { existsSync } from "node:fs";
 import { mkdir, readdir, readFile, rm, writeFile } from "node:fs/promises";
 import { dirname, resolve } from "node:path";
 import { generate } from "orval";
-import { z } from "zod";
 import { orvalCustomConfig } from "../orval.config";
 
 export type OrvalCustomConfig = {
@@ -19,25 +19,8 @@ export type OrvalCustomConfig = {
   };
 };
 
-const envSchemaFromNodeEnvironment = z.object({
-  API_JSON_DOCS_URL: z
-    .string()
-    .url()
-    .transform(val => new URL(val).toString()),
-});
-
-const parsedEnv = envSchemaFromNodeEnvironment.safeParse(process.env);
-
-if (!parsedEnv.success) {
-  console.error(parsedEnv.error.flatten().fieldErrors);
-
-  throw new Error("Invalid environment variables.");
-}
-
-const env = parsedEnv.data;
-
 (async () => {
-  const apiJsonDocsResponse = await fetch(env.API_JSON_DOCS_URL);
+  const apiJsonDocsResponse = await fetch(privateEnv.API_JSON_DOCS_URL);
   const apiJsonDocs = await apiJsonDocsResponse.text();
   const apiJsonDocsDirPath = dirname(orvalCustomConfig.apiDocs.outputPath);
 

package/templates/react-vite/src/app.tsx

@@ -1,14 +1,6 @@
-import { Helmet, HelmetProvider } from "react-helmet-async";
 import { RouterProvider } from "react-router/dom";
-import { env } from "./env";
 import { router } from "./routes";
 
 export function App() {
-  return (
-    <HelmetProvider>
-      <Helmet titleTemplate={`%s | ${env.APP_NAME}`}></Helmet>
-
-      <RouterProvider router={router} />
-    </HelmetProvider>
-  );
+  return <RouterProvider router={router} />;
 }

package/templates/react-vite/src/lib/zod-i18n-pt-br-translation.json

@@ -0,0 +1,101 @@
+{
+  "types": {
+    "number": "número",
+    "string": "texto",
+    "integer": "número inteiro",
+    "boolean": "verdadeiro ou falso",
+    "date": "data",
+    "bigint": "número",
+    "undefined": "vazio",
+    "null": "vazio",
+    "array": "lista",
+    "object": "objeto"
+  },
+  "errors": {
+    "invalid_type": "O campo deve ser {{expected}}, foi recebido {{received}}.",
+    "invalid_type_received_undefined": "O campo é obrigatório.",
+    "invalid_type_received_null": "O campo não pode estar nulo.",
+    "invalid_literal": "O campo deve ser apenas '{{expected}}'.",
+    "unrecognized_keys": "O campo contém chave(s) não reconhecida(s) no objeto: {{- keys}}.",
+    "invalid_union": "O campo é inválido.",
+    "invalid_union_discriminator": "O campo deve conter apenas os seguintes valores: {{- options}}.",
+    "invalid_enum_value": "O campo deve conter apenas os seguintes valores: {{- options}}.",
+    "invalid_date": "A data é inválida.",
+    "custom": "O campo é inválido.",
+    "invalid_intersection_types": "O campo '{{path}}' não pode conter valores mesclados.",
+    "not_multiple_of": "O número deve ser múltiplo de {{multipleOf}}.",
+    "not_finite": "O número não pode ser infinito.",
+    "invalid_string": {
+      "email": "O e-mail é inválido.",
+      "url": "A URL é inválida.",
+      "uuid": "O UUID é inválido.",
+      "cuid": "O CUID é inválido.",
+      "regex": "O campo é inválido.",
+      "datetime": "A data e a hora são inválidos.",
+      "startsWith": "O campo só pode iniciar com \"{{startsWith}}\".",
+      "endsWith": "O campo só pode iniciar com \"{{endsWith}}\"."
+    },
+    "too_small": {
+      "array": {
+        "exact": "Adicione exatamente {{minimum}} item / itens.",
+        "inclusive": "Adicione no mínimo {{minimum}} item / itens.",
+        "not_inclusive": "Adicione mais de {{minimum}} item / itens."
+      },
+      "string": {
+        "exact": "O campo deve conter exatamente {{minimum}} caractere(s).",
+        "inclusive": "O campo deve conter no mínimo {{minimum}} caractere(s).",
+        "not_inclusive": "O campo deve conter mais de {{minimum}} caractere(s)."
+      },
+      "number": {
+        "exact": "O número deve conter exatamente {{minimum}} caractere(s).",
+        "inclusive": "O número deve ser maior ou igual a {{minimum}}.",
+        "not_inclusive": "O número deve ser maior que {{minimum}}."
+      },
+      "set": {
+        "exact": "O campo é inválido.",
+        "inclusive": "O campo é inválido.",
+        "not_inclusive": "O campo é inválido."
+      },
+      "date": {
+        "exact": "A data deve ser exatamente igual a {{- maximum, datetime}}.",
+        "inclusive": "A data deve ser maior ou igual a {{- minimum, datetime}}.",
+        "not_inclusive": "A data deve ser maior que {{- minimum, datetime}}."
+      }
+    },
+    "too_big": {
+      "array": {
+        "exact": "Adicione exatamente {{maximum}} item / itens.",
+        "inclusive": "Adicione no máximo {{maximum}} item / itens.",
+        "not_inclusive": "Adicione menos de {{maximum}} item / itens."
+      },
+      "string": {
+        "exact": "O campo deve conter exatamente {{maximum}} caractere(s).",
+        "inclusive": "O campo deve conter no máximo {{maximum}} caractere(s).",
+        "not_inclusive": "O campo deve conter menos de {{maximum}} caractere(s)."
+      },
+      "number": {
+        "exact": "O número deve conter exatamente {{maximum}} caractere(s).",
+        "inclusive": "O número deve ser menor ou igual a {{maximum}}.",
+        "not_inclusive": "O número deve ser menor que {{maximum}}."
+      },
+      "set": {
+        "exact": "O campo é inválido.",
+        "inclusive": "O campo é inválido.",
+        "not_inclusive": "O campo é inválido."
+      },
+      "date": {
+        "exact": "A data deve ser exatamente igual a {{- maximum, datetime}}.",
+        "inclusive": "A data deve ser menor ou igual a {{- maximum, datetime}}.",
+        "not_inclusive": "A data deve ser menor que {{- maximum, datetime}}."
+      }
+    }
+  },
+  "validations": {
+    "email": "email",
+    "url": "url",
+    "uuid": "uuid",
+    "cuid": "cuid",
+    "regex": "regex",
+    "datetime": "datetime"
+  }
+}

package/templates/react-vite/src/lib/zod-i18n.ts

@@ -2,19 +2,27 @@ import i18next from "i18next";
 import { z } from "zod";
 import { zodI18nMap } from "zod-i18n-map";
 import translation from "zod-i18n-map/locales/pt/zod.json";
-import zodI18nTranslationForEndUsers from "./zod-i18n-translation-for-end-users.json";
+import zodI18nPtBrTranslation from "./zod-i18n-pt-br-translation.json";
 
 export function startZodWithI18n() {
   i18next.init({
     lng: "pt",
     resources: {
       pt: {
-        zod: { ...translation, ...zodI18nTranslationForEndUsers },
+        zod: {
+          ...translation,
+          ...zodI18nPtBrTranslation,
+          errors: {
+            ...translation.errors,
+            ...zodI18nPtBrTranslation.errors,
+          },
+        },
       },
     },
+    interpolation: {
+      escapeValue: false,
+    },
   });
 
   z.setErrorMap(zodI18nMap);
 }
-
-export { z };

package/templates/react-vite/src/pages/_layouts/app.tsx

@@ -1,13 +1,15 @@
-import { useCurrentRouteHandleParams } from "@/hooks/use-current-route-handle-params";
-import { Helmet } from "react-helmet-async";
-import { Outlet } from "react-router";
+import { privateRoutes } from "@/routes";
+import { Outlet, useLocation } from "react-router";
 
 export function AppLayout() {
-  const { handleParams } = useCurrentRouteHandleParams();
+  const { pathname } = useLocation();
+  const currentPublicRoute = Object.values(privateRoutes).find(privateRoute => {
+    return privateRoute.path === pathname;
+  });
 
   return (
     <>
-      <Helmet title={handleParams.metadata.title} />
+      {currentPublicRoute && <title>{currentPublicRoute.title}</title>}
 
       <div>
         <Outlet />

package/templates/react-vite/src/pages/_layouts/auth.tsx

@@ -1,13 +1,15 @@
-import { useCurrentRouteHandleParams } from "@/hooks/use-current-route-handle-params";
-import { Helmet } from "react-helmet-async";
-import { Outlet } from "react-router";
+import { publicRoutes } from "@/routes";
+import { Outlet, useLocation } from "react-router";
 
 export function AuthLayout() {
-  const { handleParams } = useCurrentRouteHandleParams();
+  const { pathname } = useLocation();
+  const currentPublicRoute = Object.values(publicRoutes).find(publicRoute => {
+    return publicRoute.path === pathname;
+  });
 
   return (
     <>
-      <Helmet title={handleParams.metadata.title} />
+      {currentPublicRoute && <title>{currentPublicRoute.title}</title>}
 
       <div>
         <Outlet />

package/templates/react-vite/src/pages/app/dashboard/dashboard.tsx

@@ -1,3 +1,4 @@
+import { publicRoutes } from "@/routes";
 import { Link } from "react-router";
 import "./styles.css";
 
@@ -6,7 +7,7 @@ export function Dashboard() {
     <div className="dashboard-wrapper">
       <h1>Hello world!</h1>
 
-      <Link to="/sign-in">Sign out</Link>
+      <Link to={publicRoutes.signIn.path}>Sign out</Link>
     </div>
   );
 }

package/templates/react-vite/src/pages/auth/sign-in/index.tsx

@@ -1,3 +1,4 @@
+import { privateRoutes } from "@/routes";
 import { zodResolver } from "@hookform/resolvers/zod";
 import { useForm } from "react-hook-form";
 import { useNavigate } from "react-router";
@@ -12,6 +13,8 @@ const signInFormSchema = z.object({
 type SignInForm = z.infer<typeof signInFormSchema>;
 
 export function SignIn() {
+  const navigate = useNavigate();
+
   const signInForm = useForm<SignInForm>({
     resolver: zodResolver(signInFormSchema),
     defaultValues: {
@@ -19,10 +22,9 @@ export function SignIn() {
       password: "",
     },
   });
-  const navigate = useNavigate();
   const onSignIn = async (input: SignInForm) => {
     console.log(input);
-    navigate("/dashboard");
+    navigate(privateRoutes.dashboard.path);
   };
 
   return (

package/templates/react-vite/src/private-env.ts

@@ -0,0 +1,18 @@
+import { z } from "zod";
+
+const schema = z.object({
+  API_JSON_DOCS_URL: z
+    .string()
+    .url()
+    .transform(url => new URL(url)),
+});
+
+const parsedEnv = schema.safeParse(process.env);
+
+if (!parsedEnv.success) {
+  console.error(parsedEnv.error.flatten().fieldErrors);
+
+  throw new Error("Invalid private environment variables.");
+}
+
+export const privateEnv = parsedEnv.data;

package/templates/react-vite/src/public-env.ts

@@ -0,0 +1,30 @@
+import { z } from "zod";
+
+type PublicEnvironmentVariables = {
+  PUBLIC_APP_NAME: string;
+  PUBLIC_API_BASE_URL: string;
+};
+
+const publicEnvironmentVariables = import.meta.env as ImportMetaEnv &
+  PublicEnvironmentVariables;
+
+const schema = z.object({
+  APP_NAME: z.string(),
+  API_BASE_URL: z
+    .string()
+    .url()
+    .transform(url => new URL(url)),
+});
+
+const parsedEnv = schema.safeParse({
+  APP_NAME: publicEnvironmentVariables.PUBLIC_APP_NAME,
+  API_BASE_URL: publicEnvironmentVariables.PUBLIC_API_BASE_URL,
+});
+
+if (!parsedEnv.success) {
+  console.error(parsedEnv.error.flatten().fieldErrors);
+
+  throw new Error("Invalid public environment variables.");
+}
+
+export const publicEnv = parsedEnv.data;

package/templates/react-vite/src/routes.tsx

@@ -1,65 +1,49 @@
-import { createBrowserRouter } from "react-router";
-import {
-  CustomRouteDefinition,
-  ReactRouterRouteDefinition,
-} from "./@types/routes";
+import { createBrowserRouter, RouteObject } from "react-router";
 import { AppLayout } from "./pages/_layouts/app";
 import { AuthLayout } from "./pages/_layouts/auth";
-import { SignIn } from "./pages/auth/sign-in";
 import { Dashboard } from "./pages/app/dashboard/dashboard";
+import { SignIn } from "./pages/auth/sign-in";
+import { publicEnv } from "./public-env";
 
-export const authNavigationRoutes = [
-  {
-    path: "/sign-in",
-    label: "Sign In",
+export const publicRoutes = Object.freeze({
+  signIn: {
+    path: "/",
+    element: <SignIn />,
+    title: createTitleTemplate("Sign In"),
   },
-] as const satisfies CustomRouteDefinition[];
+} as const);
 
-export const appNavigationRoutes = [
-  {
+export const privateRoutes = Object.freeze({
+  dashboard: {
     path: "/dashboard",
-    label: "Dashboard",
+    element: <Dashboard />,
+    title: createTitleTemplate("Dashboard"),
   },
-] as const satisfies CustomRouteDefinition[];
+} as const);
 
 export const router = createBrowserRouter([
   {
     element: <AuthLayout />,
     children: [
-      {
-        path: "*",
-        element: <SignIn />,
+      ...Object.values(publicRoutes).map<RouteObject>(publicRoute => ({
+        path: publicRoute.path,
+        element: publicRoute.element,
         index: true,
-        handle: {
-          metadata: {
-            title: "Sign In",
-          },
-        },
-      },
-      {
-        path: "/sign-in",
-        element: <SignIn />,
-        index: true,
-        handle: {
-          metadata: {
-            title: "Sign In",
-          },
-        },
-      },
-    ] satisfies ReactRouterRouteDefinition<typeof authNavigationRoutes>[],
+      })),
+    ],
   },
   {
     element: <AppLayout />,
     children: [
-      {
-        path: "/dashboard",
-        element: <Dashboard />,
-        handle: {
-          metadata: {
-            title: "Dashboard",
-          },
-        },
-      },
-    ] satisfies ReactRouterRouteDefinition<typeof appNavigationRoutes>[],
+      ...Object.values(privateRoutes).map<RouteObject>(publicRoute => ({
+        path: publicRoute.path,
+        element: publicRoute.element,
+        index: true,
+      })),
+    ],
   },
 ]);
+
+function createTitleTemplate(title: string) {
+  return `${title} | ${publicEnv.APP_NAME}`;
+}

package/templates/react-vite/tsconfig.app.json

@@ -25,8 +25,9 @@
     /* Custom */
     "baseUrl": ".",
     "paths": {
-      "@/*": ["./src/*"]
+      "@/*": ["./src/*"],
+      "@api/*": ["./api/*"]
     }
   },
-  "include": ["src"]
+  "include": ["src", "api"]
 }

package/templates/react-vite/tsconfig.json

@@ -7,7 +7,8 @@
   "compilerOptions": {
     "baseUrl": ".",
     "paths": {
-      "@/*": ["./src/*"]
+      "@/*": ["./src/*"],
+      "@api/*": ["./api/*"]
     }
   }
 }

package/templates/react-vite/tsconfig.node.json

@@ -18,7 +18,13 @@
     "noUnusedLocals": true,
     "noUnusedParameters": true,
     "noFallthroughCasesInSwitch": true,
-    "noUncheckedSideEffectImports": true
+    "noUncheckedSideEffectImports": true,
+
+    /* Custom */
+    "baseUrl": ".",
+    "paths": {
+      "@/*": ["./src/*"]
+    }
   },
-  "include": ["vite.config.ts"]
+  "include": ["vite.config.ts", "scripts"]
 }

package/templates/react-vite/vite.config.ts

@@ -5,5 +5,5 @@ import tsconfigPaths from "vite-tsconfig-paths";
 // https://vite.dev/config/
 export default defineConfig({
   plugins: [react(), tsconfigPaths()],
-  envPrefix: "APP",
+  envPrefix: "PUBLIC",
 });

package/templates/react-vite/src/api/errors/api-error.ts

@@ -1,7 +0,0 @@
-export class ApiError {
-  public constructor(
-    public readonly statusCode: number,
-    public readonly error: string,
-    public readonly message: string,
-  ) {}
-}

package/templates/react-vite/src/api/errors/api-unexpected-response-error.ts

@@ -1,8 +0,0 @@
-const defaultMessage =
-  "Houve uma falha inesperada ao se comunicar com nosso servidor. Por favor, contate nosso suporte." as const;
-
-export class ApiUnexpectedResponseError {
-  static message = defaultMessage;
-
-  constructor(public message = defaultMessage) {}
-}

package/templates/react-vite/src/env.ts

@@ -1,19 +0,0 @@
-import { z } from "zod";
-
-const schema = z.object({
-  APP_NAME: z.string(),
-  APP_API_BASE_URL: z
-    .string()
-    .url()
-    .transform(val => new URL(val).toString()),
-});
-
-const parsedEnv = schema.safeParse(import.meta.env);
-
-if (!parsedEnv.success) {
-  console.error(parsedEnv.error.flatten().fieldErrors);
-
-  throw new Error("Invalid environment variables.");
-}
-
-export const env = parsedEnv.data;

package/templates/react-vite/src/hooks/use-current-route-handle-params.ts

@@ -1,16 +0,0 @@
-import { ReactRouterRouteHandleDefinition } from "@/@types/routes";
-import { useLocation, useMatches } from "react-router";
-
-export function useCurrentRouteHandleParams() {
-  const { pathname } = useLocation();
-  const routeMatches = useMatches();
-  const currentRouteHandleParams = routeMatches.find(routeMatch => {
-    return routeMatch.pathname === pathname && routeMatch.handle;
-  });
-
-  return {
-    pathname,
-    handleParams:
-      currentRouteHandleParams?.handle as ReactRouterRouteHandleDefinition,
-  };
-}

package/templates/react-vite/src/lib/zod-i18n-translation-for-end-users.json

@@ -1,103 +0,0 @@
-{
-  "types": {
-    "number": "número",
-    "string": "texto",
-    "integer": "número inteiro",
-    "boolean": "verdadeiro ou falso",
-    "date": "data",
-    "bigint": "número",
-    "undefined": "vazio",
-    "null": "vazio",
-    "array": "lista",
-    "object": "objeto"
-  },
-  "errors": {
-    "invalid_type": "O campo deve ser {{expected}}, foi recebido {{received}}.",
-    "invalid_type_received_undefined": "O campo é obrigatório.",
-    "invalid_type_received_null": "O campo é obrigatório.",
-    "invalid_literal": "O campo deve ser apenas \"{{expected}}\".",
-    "unrecognized_keys": "Chave(s) não reconhecida(s) no objeto: {{- keys}}.",
-    "invalid_union": "Entrada inválida.",
-    "invalid_union_discriminator": "O campo deve conter apenas os seguintes valores: {{- options}}.",
-    "invalid_enum_value": "O campo deve conter apenas os seguintes valores: {{- options}}.",
-    "invalid_arguments": "Argumento de função inválido.",
-    "invalid_return_type": "Tipo de retorno de função inválido.",
-    "invalid_date": "A data é inválida.",
-    "custom": "A entrada é inválida.",
-    "invalid_intersection_types": "Os valores não podem ser mesclados.",
-    "not_multiple_of": "O número deverá ser múltiplo de {{multipleOf}}.",
-    "not_finite": "O número não pode ser infinito.",
-    "invalid_string": {
-      "email": "O e-mail é inválido.",
-      "url": "A URL é inválida.",
-      "uuid": "O UUID é inválido.",
-      "cuid": "O CUID é inválido.",
-      "regex": "A combinação é inválida.",
-      "datetime": "A data e a hora são inválidos.",
-      "startsWith": "O campo só pode iniciar com \"{{startsWith}}\".",
-      "endsWith": "O campo só pode iniciar com \"{{endsWith}}\"."
-    },
-    "too_small": {
-      "array": {
-        "exact": "A lista deve conter exatamente {{minimum}} item / itens.",
-        "inclusive": "A lista deve conter no mínimo {{minimum}} item / itens.",
-        "not_inclusive": "A lista deve conter mais de {{minimum}} item / itens."
-      },
-      "string": {
-        "exact": "O campo deve conter exatamente {{minimum}} caracter(es).",
-        "inclusive": "O campo é obrigatório com no mínimo {{minimum}} caracter(es).",
-        "not_inclusive": "O campo deve conter mais de {{minimum}} caracter(es)."
-      },
-      "number": {
-        "exact": "O número deve conter exatamente {{minimum}} caracter(es).",
-        "inclusive": "O número deve ser maior ou igual a {{minimum}}.",
-        "not_inclusive": "O número deve ser maior que {{minimum}}."
-      },
-      "set": {
-        "exact": "Entrada inválida.",
-        "inclusive": "Entrada inválida.",
-        "not_inclusive": "Entrada inválida."
-      },
-      "date": {
-        "exact": "A data deve ser exatamente {{- maximum, datetime}}.",
-        "inclusive": "A data deve ser maior ou igual a {{- minimum, datetime}}.",
-        "not_inclusive": "A data deve ser maior que {{- minimum, datetime}}."
-      }
-    },
-    "too_big": {
-      "array": {
-        "exact": "A lista deve conter exatamente {{minimum}} item / itens.",
-        "inclusive": "A lista deve conter no mínimo {{minimum}} item / itens.",
-        "not_inclusive": "A lista deve conter mais de {{minimum}} item / itens."
-      },
-      "string": {
-        "exact": "O campo deve conter exatamente {{minimum}} caracter(es).",
-        "inclusive": "O campo deve conter pelo menos {{minimum}} caracter(es).",
-        "not_inclusive": "O campo deve conter mais de {{minimum}} caracter(es)."
-      },
-      "number": {
-        "exact": "O número deve conter exatamente {{minimum}} caracter(es).",
-        "inclusive": "O número deve ser maior ou igual a {{minimum}}.",
-        "not_inclusive": "O número deve ser maior que {{minimum}}."
-      },
-      "set": {
-        "exact": "Entrada inválida.",
-        "inclusive": "Entrada inválida.",
-        "not_inclusive": "Entrada inválida."
-      },
-      "date": {
-        "exact": "A data deve ser exatamente {{- maximum, datetime}}.",
-        "inclusive": "A data deve ser maior ou igual a {{- minimum, datetime}}.",
-        "not_inclusive": "A data deve ser maior que {{- minimum, datetime}}."
-      }
-    }
-  },
-  "validations": {
-    "email": "email",
-    "url": "url",
-    "uuid": "uuid",
-    "cuid": "cuid",
-    "regex": "regex",
-    "datetime": "datetime"
-  }
-}