create-arkos 2.0.0-next.2 → 2.0.0-next.20

package/templates/basic/src/modules/file-upload/file-upload.router.ts.hbs

@@ -1,12 +1,32 @@
-import { ArkosRouter } from "arkos";
-{{#if authentication}}
-import fileUploadPolicy from "@/src/modules/file-upload/file-upload.policy";
+import { ArkosRouter, ArkosRouteHook } from 'arkos';
+{{#if (neq authentication.type "none")}}
+import fileUploadPolicy from '@/src/modules/file-upload/file-upload.policy';
 {{/if}}
-import config from "@/arkos.config"
+import config from '@/arkos.config';
 
-const fileUploadRouter = ArkosRouter({ 
-    prefix: config?.fileUpload?.baseRoute,
-    openapi: { tags: ["File Uploads"] } 
-  });
+const fileUploadRouteHook = ArkosRouteHook("file-upload");
+
+fileUploadRouteHook.findFile({
+  {{#if (neq authentication.type "none")}}authentication: fileUploadPolicy.View,{{/if}}
+});
+
+fileUploadRouteHook.uploadFile({
+  {{#if (neq authentication.type "none")}}authentication: fileUploadPolicy.Create,{{/if}}
+});
+
+fileUploadRouteHook.updateFile({
+  {{#if (neq authentication.type "none")}}authentication: fileUploadPolicy.Update,{{/if}}
+});
+
+fileUploadRouteHook.deleteFile({
+  {{#if (neq authentication.type "none")}}authentication: fileUploadPolicy.Delete,{{/if}}
+});
+
+const fileUploadRouter = ArkosRouter({
+  prefix: config?.fileUpload?.baseRoute,
+  openapi: { tags: ["File Upload"] },
+});
+
+fileUploadRouter.load(fileUploadRouteHook);
 
 export default fileUploadRouter;

package/templates/basic/src/modules/user/dtos/create-user.dto.ts.hbs

@@ -2,7 +2,7 @@
 import { z } from "zod";
 {{#if (eq authentication.type "static")}}
 {{#if (neq prisma.provider "sqlite")}}
-import { UserRole } from "@prisma/client";
+import { UserRole } from "@/src/generated/prisma/client";
 {{/if}}
 {{/if}}
 
@@ -20,9 +20,9 @@ const CreateUserDto = z.object({
   role: z.string(),
   {{else}}
   {{#if authentication.multipleRoles}}
-  roles: z.array(z.nativeEnum(UserRole)),
+  roles: z.array(z.enum(UserRole)),
   {{else}}
-  role: z.nativeEnum(UserRole),
+  role: z.enum(UserRole),
   {{/if}}
   {{/if}}
   {{else}}
@@ -40,7 +40,7 @@ const CreateUserDto = z.object({
 
 export default CreateUserDto;
 {{#if typescript}}
-export type CreateUserDtoType = z.infer<typeof CreateUserDto>;
+export type CreateUserDto = z.infer<typeof CreateUserDto>;
 {{/if}}
 {{/if}}
 {{#if (eq validation.type "class-validator")}}
@@ -59,7 +59,7 @@ import {
 import { Type } from "class-transformer";
 {{#if (eq authentication.type "static")}}
 {{#if (neq prisma.provider "sqlite")}}
-import { UserRole } from "@prisma/client";
+import { UserRole } from "@/src/generated/prisma/client";
 {{/if}}
 {{/if}}
 {{#if (eq authentication.type "dynamic")}}

package/templates/basic/src/modules/user/dtos/update-user.dto.ts.hbs

@@ -3,7 +3,7 @@ import { z } from "zod";
 import apiActions from "@/src/utils/validation/api-actions";
 {{#if (eq authentication.type "static")}}
 {{#if (neq prisma.provider "sqlite")}}
-import { UserRole } from "@prisma/client";
+import { UserRole } from "@/src/generated/prisma/client";
 {{/if}}
 {{/if}}
 
@@ -22,9 +22,9 @@ const UpdateUserDto = z.object({
   role: z.string().optional(),
   {{else}}
   {{#if authentication.multipleRoles}}
-  roles: z.array(z.nativeEnum(UserRole)).optional(),
+  roles: z.array(z.enum(UserRole)).optional(),
   {{else}}
-  role: z.nativeEnum(UserRole).optional(),
+  role: z.enum(UserRole).optional(),
   {{/if}}
   {{/if}}
   {{else}}
@@ -46,7 +46,7 @@ const UpdateUserDto = z.object({
 
 export default UpdateUserDto;
 {{#if typescript}}
-export type UpdateUserDtoType = z.infer<typeof UpdateUserDto>;
+export type UpdateUserDto = z.infer<typeof UpdateUserDto>;
 {{/if}}
 {{/if}}
 {{#if (eq validation.type "class-validator")}}
@@ -66,7 +66,7 @@ import { Type } from 'class-transformer';
 import apiActions from "@/src/utils/validation/api-actions";
 {{#if (eq authentication.type "static")}}
 {{#if (neq prisma.provider "sqlite")}}
-import { UserRole } from "@prisma/client";
+import { UserRole } from "@/src/generated/prisma/client";
 {{/if}}
 {{/if}}
 {{#if (eq authentication.type "dynamic")}}

package/templates/basic/src/modules/user/user.router.ts.hbs

@@ -1,11 +1,95 @@
-import { ArkosRouter } from "arkos";
-{{#if authentication}}
-import userPolicy from "@/src/modules/user/user.policy";
+import { ArkosRouter, ArkosRouteHook } from 'arkos';
+{{#if (neq authentication.type "none")}}
+import userPolicy from '@/src/modules/user/user.policy';
 {{/if}}
+{{#if validation.type}}
+import CreateUserDto from '@/src/modules/user/dtos/create-user.dto';
+import UpdateUserDto from '@/src/modules/user/dtos/update-user.dto';
+{{/if}}
+
+const userRouteHook = ArkosRouteHook("user");
+
+userRouteHook.createOne({
+  {{#if validation.type}}validation: { body: CreateUserDto },{{/if}}
+  {{#if (neq authentication.type "none")}}authentication: userPolicy.Create,{{/if}}
+  prismaArgs: {
+    omit: { password: true },
+  },
+});
+
+userRouteHook.findOne({
+  {{#if (neq authentication.type "none")}}authentication: userPolicy.View,{{/if}}
+  prismaArgs: {
+    omit: { password: true },
+    {{#if (eq authentication.type "dynamic")}}
+    include: {
+      {{#if authentication.multipleRoles}}
+      roles: {
+        include: {
+          role: {
+            include: {
+              permissions: true,
+            },
+          },
+        },
+      },
+      {{else}}
+      role: {
+        include: {
+          role: {
+            include: {
+              permissions: true,
+            },
+          },
+        },
+      },
+      {{/if}}
+    },
+    {{/if}}
+  },
+});
+
+userRouteHook.findMany({
+  {{#if (neq authentication.type "none")}}authentication: userPolicy.View,{{/if}}
+  prismaArgs: {
+    omit: { password: true },
+    {{#if (eq authentication.type "dynamic")}}
+    include: {
+      {{#if authentication.multipleRoles}}
+      roles: {
+        include: {
+          role: true,
+        },
+      },
+      {{else}}
+      role: {
+        include: {
+          role: true,
+        },
+      },
+      {{/if}}
+    },
+    {{/if}}
+  },
+});
+
+userRouteHook.updateOne({
+  {{#if validation.type}}validation: { body: UpdateUserDto },{{/if}}
+  {{#if (neq authentication.type "none")}}authentication: userPolicy.Update,{{/if}}
+  prismaArgs: {
+    omit: { password: true },
+  },
+});
+
+userRouteHook.deleteOne({
+  {{#if (neq authentication.type "none")}}authentication: userPolicy.Delete,{{/if}}
+});
+
+const userRouter = ArkosRouter({
+  prefix: "/users",
+  openapi: { tags: ["Users"] },
+});
 
-const userRouter = ArkosRouter({ 
-    prefix: "/users",
-    openapi: { tags: ["Users"] }
-  });
+userRouter.load(userRouteHook);
 
 export default userRouter;

package/templates/basic/src/modules/user/user.service.ts.hbs

@@ -1,11 +1,9 @@
-import { BaseService } from "arkos/services";
-{{#if typescript}}
-import { Prisma } from "@prisma/client"
+import { ArkosPrismaService } from "arkos/services";
 
-class UserService extends BaseService<"user"> {}
+{{#if typescript}}
+class UserService extends ArkosPrismaService<"user"> {}
 {{else}}
-
-class UserService extends BaseService {}
+class UserService extends ArkosPrismaService {}
 {{/if}}
 
 const userService = new UserService("user");

package/templates/basic/src/router.ts.hbs

@@ -1,6 +1,6 @@
 import { ArkosRouter } from "arkos";
 import fileUploadRouter from "@/src/modules/file-upload/file-upload.router";
-{{#if authentication.type}}
+{{#if (neq authentication.type "none")}}
 import authRouter from "@/src/modules/auth/auth.router";
 import userRouter from "@/src/modules/user/user.router";
 {{/if}}
@@ -12,7 +12,7 @@ import authPermissionRouter from "@/src/modules/auth-permission/auth-permission.
 const router = ArkosRouter();
 
 router.use(fileUploadRouter);
-{{#if authentication.type}}
+{{#if (neq authentication.type "none")}}
 router.use(userRouter);
 router.use(authRouter);
 {{/if}}

package/templates/basic/src/server.ts.hbs

@@ -0,0 +1,8 @@
+import app from "@/src/app";
+import http from "node:http";
+
+app.build();
+
+const server = http.createServer(app);
+
+app.listen(server);

package/templates/basic/src/utils/prisma/index.ts.hbs

@@ -1,5 +1,51 @@
-import { PrismaClient } from "@prisma/client";
+{{#if (eq prisma.provider "postgresql")}}
+import { PrismaClient } from "@/src/generated/prisma/client";
+import { PrismaPg } from "@prisma/adapter-pg";
 
-export const prisma = new PrismaClient();
+const adapter = new PrismaPg({ connectionString: process.env.DATABASE_URL{{#if typescript}} as string{{/if}} });
+export const prisma = new PrismaClient({ adapter });
+{{/if}}
+{{#if (eq prisma.provider "cockroachdb")}}
+import { PrismaClient } from "@/src/generated/prisma/client";
+import { PrismaPg } from "@prisma/adapter-pg";
+
+// CockroachDB uses the PostgreSQL wire protocol, so it shares the pg adapter
+const adapter = new PrismaPg({ connectionString: process.env.DATABASE_URL{{#if typescript}} as string{{/if}} });
+export const prisma = new PrismaClient({ adapter });
+{{/if}}
+{{#if (eq prisma.provider "mysql")}}
+import { PrismaClient } from "@/src/generated/prisma/client";
+import { PrismaMariaDb } from "@prisma/adapter-mariadb";
+
+const dbUrl = new URL(process.env.DATABASE_URL{{#if typescript}} as string{{/if}});
+const adapter = new PrismaMariaDb({
+  host: dbUrl.hostname,
+  port: Number(dbUrl.port) || 3306,
+  user: decodeURIComponent(dbUrl.username),
+  password: decodeURIComponent(dbUrl.password),
+  database: dbUrl.pathname.replace(/^\//, ""),
+  connectionLimit: 5,
+});
+export const prisma = new PrismaClient({ adapter });
+{{/if}}
+{{#if (eq prisma.provider "sqlite")}}
+import { PrismaClient } from "@/src/generated/prisma/client";
+import { PrismaBetterSqlite3 } from "@prisma/adapter-better-sqlite3";
+
+const adapter = new PrismaBetterSqlite3({
+  url: process.env.DATABASE_URL || "file:./dev.db",
+});
+export const prisma = new PrismaClient({ adapter });
+{{/if}}
+{{#if (eq prisma.provider "sqlserver")}}
+import { PrismaClient } from "@/src/generated/prisma/client";
+import { PrismaMssql } from "@prisma/adapter-mssql";
+
+const adapter = new PrismaMssql(process.env.DATABASE_URL{{#if typescript}} as string{{/if}});
+export const prisma = new PrismaClient({ adapter });
+{{/if}}
+{{#if (eq prisma.provider "none")}}
+export const prisma = null;
+{{/if}}
 
 export default prisma;

package/templates/basic/src/utils/validation/api-actions.ts.hbs

@@ -1,10 +1,10 @@
 /**
-* A simple array of available `apiAction` field when using auto generate API (That uses BaseService)
+* A simple array of available `apiAction` field when using auto generate API (That uses ArkosPrismaService)
 * class behind the scenes.
 * 
 * Is worth mentioning that this will be addded into `arkos` as an util.
 *
-* @see {@link https://www.arkosjs.com/docs/advanced-guide/handling-relation-fields-in-prisma-body-requests#the-apiaction-property} 
+* @see {@link https://www.arkosjs.com/docs/core-concepts/prisma-orm/handling-relations} 
 */
 const apiActions = ["connect", "disconnect", "delete", "update", "create"]{{#if typescript}} as const{{/if}};
 

package/templates/basic/tsconfig.json.hbs

@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
-    "target": "ES6",
-    "module": "es2020",
+    "target": "es2022",
+    "module": "es2022",
     "moduleResolution": "bundler",
     "rootDir": ".",
     "baseUrl": ".",
@@ -15,19 +15,12 @@
     "lib": ["es6", "dom"],
     "noImplicitAny": true,
     "paths": {
-      "@/*": ["./*"]
+      "@/*": ["./*"],
+      "@arkosjs/generated": ["./.arkos/index.d.ts"] 
     }
   },
-  "include": ["src/**/*.ts", "packages/**/*.ts", "arkos.config.ts"],
-  "exclude": [
-    "**/node_modules",
-    "node_modules",
-    ".build",
-    "build",
-    "temp",
-    "dist",
-    "uploads"
-  ],
+  "include": ["src/**/*.ts", "src/**/*.js", "src/**/*.tsx",  "src/**/*.jsx", "arkos.config.ts"],
+  "exclude": ["node_modules", ".build", "src/**/__tests__/**", "src/**/*.test", "src/**/*.spec", "temp", "dist", "build", "uploads", "src/generated", ".arkos"],
   "watchOptions": {
     "excludeDirectories": ["**/node_modules", "node_modules"]
   }

package/templates/basic/src/loadables.ts.hbs

@@ -1,29 +0,0 @@
-{{#if typescript}}
-import { ArkosLoadable } from "arkos";
-{{/if}}
-import fileUploadRouteHook from "@/src/modules/file-upload/file-upload.route-hook";
-{{#if authentication.type}}
-import userRouteHook from "@/src/modules/user/user.route-hook";
-import authRouteHook from "@/src/modules/auth/auth.route-hook";
-{{/if}}
-{{#if (eq authentication.type "dynamic")}}
-import authRoleRouteHook from "@/src/modules/auth-role/auth-role.route-hook";
-import authPermissionRouteHook from "@/src/modules/auth-permission/auth-permission.route-hook";
-{{/if}}
-
-{{#if typescript}}
-{{else}}
-/** @type import("arkos").ArkosLoadable */
-{{/if}}
-const loadables{{#if typescript}}: ArkosLoadable[]{{/if}} = [
-  fileUploadRouteHook,
-{{#if authentication.type}}
-  userRouteHook,
-  authRouteHook,
-{{/if}}
-{{#if (eq authentication.type "dynamic")}}
-  authRoleRouteHook,
-  authPermissionRouteHook,
-{{/if}}
-]
-export default loadables;

package/templates/basic/src/modules/auth/auth.route-hook.ts.hbs

@@ -1,66 +0,0 @@
-import { ArkosRouteHook } from 'arkos';
-{{#if validation.type}}
-import LoginDto from '@/src/modules/auth/dtos/login.dto';
-import SignupDto from '@/src/modules/auth/dtos/signup.dto';
-import UpdateMeDto from '@/src/modules/auth/dtos/update-me.dto';
-import UpdatePasswordDto from '@/src/modules/auth/dtos/update-password.dto';
-{{/if}}
-
-const authRouteHook = ArkosRouteHook("auth");
-
-authRouteHook.login({
-  {{#if validation.type}}validation: { body: LoginDto },{{/if}}
-});
-
-authRouteHook.signup({
-  {{#if validation.type}}validation: { body: SignupDto },{{/if}}
-  prismaArgs: {
-    omit: { password: true },
-  },
-});
-
-authRouteHook.getMe({
-  prismaArgs: {
-    omit: { password: true },
-    {{#if (eq authentication.type "dynamic")}}
-    include: {
-      {{#if authentication.multipleRoles}}
-      roles: {
-        include: {
-          role: {
-            include: {
-              permissions: true,
-            },
-          },
-        },
-      },
-      {{else}}
-      role: {
-        include: {
-          role: {
-            include: {
-              permissions: true,
-            },
-          },
-        },
-      },
-      {{/if}}
-    },
-    {{/if}}
-  },
-});
-
-authRouteHook.updateMe({
-  {{#if validation.type}}validation: { body: UpdateMeDto },{{/if}}
-  prismaArgs: {
-    omit: { password: true },
-  },
-});
-
-authRouteHook.updatePassword({
-  {{#if validation.type}}validation: { body: UpdatePasswordDto },{{/if}}
-});
-
-authRouteHook.logout({});
-
-export default authRouteHook;

package/templates/basic/src/modules/auth-permission/auth-permission.route-hook.ts.hbs

@@ -1,35 +0,0 @@
-import { ArkosRouteHook } from 'arkos';
-{{#if authentication}}
-import authPermissionPolicy from '@/src/modules/auth-permission/auth-permission.policy';
-{{/if}}
-{{#if validation.type}}
-import CreateAuthPermissionDto from '@/src/modules/auth-permission/dtos/create-auth-permission.dto';
-import UpdateAuthPermissionDto from '@/src/modules/auth-permission/dtos/update-auth-permission.dto';
-import QueryAuthPermissionDto from '@/src/modules/auth-permission/dtos/query-auth-permission.dto';
-{{/if}}
-const authPermissionRouteHook = ArkosRouteHook("auth-permission");
-
-authPermissionRouteHook.createOne({
-  {{#if validation.type}}validation: { body: CreateAuthPermissionDto },{{/if}}
-  {{#if authentication}}authentication: authPermissionPolicy.Create,{{/if}}
-});
-
-authPermissionRouteHook.findOne({
-  {{#if authentication}}authentication: authPermissionPolicy.View,{{/if}}
-});
-
-authPermissionRouteHook.findMany({
-  {{#if validation.type}}validation: { query: QueryAuthPermissionDto },{{/if}}
-  {{#if authentication}}authentication: authPermissionPolicy.View,{{/if}}
-});
-
-authPermissionRouteHook.updateOne({
-  {{#if validation.type}}validation: { body: UpdateAuthPermissionDto },{{/if}}
-  {{#if authentication}}authentication: authPermissionPolicy.Update,{{/if}}
-});
-
-authPermissionRouteHook.deleteOne({
-  {{#if authentication}}authentication: authPermissionPolicy.Delete,{{/if}}
-});
-
-export default authPermissionRouteHook;

package/templates/basic/src/modules/auth-role/auth-role.route-hook.ts.hbs

@@ -1,35 +0,0 @@
-import { ArkosRouteHook } from 'arkos';
-{{#if authentication}}
-import authRolePolicy from '@/src/modules/auth-role/auth-role.policy';
-{{/if}}
-{{#if validation.type}}
-import CreateAuthRoleDto from '@/src/modules/auth-role/dtos/create-auth-role.dto';
-import UpdateAuthRoleDto from '@/src/modules/auth-role/dtos/update-auth-role.dto';
-import QueryAuthRoleDto from '@/src/modules/auth-role/dtos/query-auth-role.dto';
-{{/if}}
-const authRoleRouteHook = ArkosRouteHook("auth-role");
-
-authRoleRouteHook.createOne({
-  {{#if validation.type}}validation: { body: CreateAuthRoleDto },{{/if}}
-  {{#if authentication}}authentication: authRolePolicy.Create,{{/if}}
-});
-
-authRoleRouteHook.findOne({
-  {{#if authentication}}authentication: authRolePolicy.View,{{/if}}
-});
-
-authRoleRouteHook.findMany({
-  {{#if validation.type}}validation: { query: QueryAuthRoleDto },{{/if}}
-  {{#if authentication}}authentication: authRolePolicy.View,{{/if}}
-});
-
-authRoleRouteHook.updateOne({
-  {{#if validation.type}}validation: { body: UpdateAuthRoleDto },{{/if}}
-  {{#if authentication}}authentication: authRolePolicy.Update,{{/if}}
-});
-
-authRoleRouteHook.deleteOne({
-  {{#if authentication}}authentication: authRolePolicy.Delete,{{/if}}
-});
-
-export default authRoleRouteHook;

package/templates/basic/src/modules/file-upload/file-upload.route-hook.ts.hbs

@@ -1,23 +0,0 @@
-import { ArkosRouteHook } from 'arkos';
-{{#if authentication}}
-import fileUploadPolicy from '@/src/modules/file-upload/file-upload.policy';
-{{/if}}
-const fileUploadRouteHook = ArkosRouteHook("file-upload");
-
-fileUploadRouteHook.findFile({
-  {{#if authentication}}authentication: fileUploadPolicy.View,{{/if}}
-});
-
-fileUploadRouteHook.uploadFile({
-  {{#if authentication}}authentication: fileUploadPolicy.Create,{{/if}}
-});
-
-fileUploadRouteHook.updateFile({
-  {{#if authentication}}authentication: fileUploadPolicy.Update,{{/if}}
-});
-
-fileUploadRouteHook.deleteFile({
-  {{#if authentication}}authentication: fileUploadPolicy.Delete,{{/if}}
-});
-
-export default fileUploadRouteHook;

package/templates/basic/src/modules/user/user.route-hook.ts.hbs

@@ -1,88 +0,0 @@
-import { ArkosRouteHook } from 'arkos';
-{{#if authentication}}
-import userPolicy from '@/src/modules/user/user.policy';
-{{/if}}
-{{#if validation.type}}
-import CreateUserDto from '@/src/modules/user/dtos/create-user.dto';
-import UpdateUserDto from '@/src/modules/user/dtos/update-user.dto';
-{{/if}}
-
-const userRouteHook = ArkosRouteHook("user");
-
-userRouteHook.createOne({
-  {{#if validation.type}}validation: { body: CreateUserDto },{{/if}}
-  {{#if authentication}}authentication: userPolicy.Create,{{/if}}
-  prismaArgs: {
-    omit: { password: true },
-  },
-});
-
-userRouteHook.findOne({
-  {{#if authentication}}authentication: userPolicy.View,{{/if}}
-  prismaArgs: {
-    omit: { password: true },
-    {{#if (eq authentication.type "dynamic")}}
-    include: {
-      {{#if authentication.multipleRoles}}
-      roles: {
-        include: {
-          role: {
-            include: {
-              permissions: true,
-            },
-          },
-        },
-      },
-      {{else}}
-      role: {
-        include: {
-          role: {
-            include: {
-              permissions: true,
-            },
-          },
-        },
-      },
-      {{/if}}
-    },
-    {{/if}}
-  },
-});
-
-userRouteHook.findMany({
-  {{#if authentication}}authentication: userPolicy.View,{{/if}}
-  prismaArgs: {
-    omit: { password: true },
-    {{#if (eq authentication.type "dynamic")}}
-    include: {
-      {{#if authentication.multipleRoles}}
-      roles: {
-        include: {
-          role: true,
-        },
-      },
-      {{else}}
-      role: {
-        include: {
-          role: true,
-        },
-      },
-      {{/if}}
-    },
-    {{/if}}
-  },
-});
-
-userRouteHook.updateOne({
-  {{#if validation.type}}validation: { body: UpdateUserDto },{{/if}}
-  {{#if authentication}}authentication: userPolicy.Update,{{/if}}
-  prismaArgs: {
-    omit: { password: true },
-  },
-});
-
-userRouteHook.deleteOne({
-  {{#if authentication}}authentication: userPolicy.Delete,{{/if}}
-});
-
-export default userRouteHook;