create-arkos 2.0.0-next.17 → 2.0.0-next.18

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

@@ -1,11 +1,76 @@
-import { ArkosRouter } from "arkos";
-{{#if authentication}}
-import authPolicy from "@/src/modules/auth/auth.policy";
+import { ArkosRouter, ArkosRouteHook } from 'arkos';
+{{#if (neq authentication.type "none")}}
+import authPolicy from '@/src/modules/auth/auth.policy';
 {{/if}}
+{{#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({});
+
+const authRouter = ArkosRouter({
+  prefix: "/auth",
+  openapi: { tags: ["Authentication"] },
+});
 
-const authRouter = ArkosRouter({ 
-    prefix: "/auth",
-    openapi: { tags: ["Authentication"] } 
-  });
+authRouter.load(authRouteHook);
 
 export default authRouter;

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

@@ -1,11 +1,43 @@
-import { ArkosRouter } from "arkos";
-{{#if authentication}}
-import authPermissionPolicy from "@/src/modules/auth-permission/auth-permission.policy";
+import { ArkosRouter, ArkosRouteHook } from 'arkos';
+{{#if (neq authentication.type "none")}}
+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 (neq authentication.type "none")}}authentication: authPermissionPolicy.Create,{{/if}}
+});
+
+authPermissionRouteHook.findOne({
+  {{#if (neq authentication.type "none")}}authentication: authPermissionPolicy.View,{{/if}}
+});
+
+authPermissionRouteHook.findMany({
+  {{#if validation.type}}validation: { query: QueryAuthPermissionDto },{{/if}}
+  {{#if (neq authentication.type "none")}}authentication: authPermissionPolicy.View,{{/if}}
+});
+
+authPermissionRouteHook.updateOne({
+  {{#if validation.type}}validation: { body: UpdateAuthPermissionDto },{{/if}}
+  {{#if (neq authentication.type "none")}}authentication: authPermissionPolicy.Update,{{/if}}
+});
+
+authPermissionRouteHook.deleteOne({
+  {{#if (neq authentication.type "none")}}authentication: authPermissionPolicy.Delete,{{/if}}
+});
+
+const authPermissionRouter = ArkosRouter({
+  prefix: "/auth-permissions",
+  openapi: { tags: ["Auth Permissions"] },
+});
 
-const authPermissionRouter = ArkosRouter({ 
-    prefix: "/auth-permissions",
-    openapi: { tags: ["Auth Permissions"] } 
-  });
+authPermissionRouter.load(authPermissionRouteHook);
 
 export default authPermissionRouter;

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

@@ -4,9 +4,9 @@ import { z } from 'zod';
 const CreateAuthPermissionDto = z.object({
   resource: z.string().min(1, 'Resource is required'),
   action: z.string().default('View'),
-  role: z.object({
+  roles: z.array(z.object({
     id: z.string().min(1, 'Role ID is required'),
-  }),
+  })).optional(),
   description: z.string().optional(),
 });
 
@@ -16,7 +16,7 @@ export type CreateAuthPermissionDtoType = z.infer<typeof CreateAuthPermissionDto
 {{/if}}
 {{/if}}
 {{#if (eq validation.type "class-validator")}}
-import { IsString, IsNotEmpty, IsOptional, IsValidateNested } from 'class-validator';
+import { IsString, IsNotEmpty, IsOptional, IsArray, ValidateNested } from 'class-validator';
 import { Type, Transform } from 'class-transformer';
 import 'reflect-metadata';
 
@@ -35,7 +35,8 @@ export default class CreateAuthPermissionDto {
   @Transform(({ value }) => value || 'View')
   action?: string = 'View';
 
-  @ValidateNested()
+  @ValidateNested({ each: true })
+  @IsArray()
   @Type(() => RoleConnectDto)
   @IsOptional()
   roles?: RoleConnectDto[];

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

@@ -5,6 +5,9 @@ const UpdateAuthPermissionDto = z.object({
   resource: z.string().optional(),
   action: z.string().optional(),
   description: z.string().optional(),
+  roles: z.array(z.object({
+    id: z.string().min(1, 'Role ID is required'),
+  })).optional(),
 });
 
 export default UpdateAuthPermissionDto;
@@ -13,10 +16,16 @@ export type UpdateAuthPermissionDtoType = z.infer<typeof UpdateAuthPermissionDto
 {{/if}}
 {{/if}}
 {{#if (eq validation.type "class-validator")}}
-import { IsString, IsOptional } from 'class-validator';
-import { Transform } from 'class-transformer';
+import { IsString, IsOptional, IsArray, ValidateNested } from 'class-validator';
+import { Transform, Type } from 'class-transformer';
 import 'reflect-metadata';
 
+class RoleConnectDto {
+  @IsString()
+  @IsNotEmpty({ message: 'Role ID is required' })
+  id!: string;
+}
+
 export default class UpdateAuthPermissionDto {
   @IsOptional()
   @IsString()
@@ -25,7 +34,11 @@ export default class UpdateAuthPermissionDto {
   @IsOptional()
   @IsString()
   @Transform(({ value }) => String(value))
-  action?: string
+  action?: string;
+
+  @IsOptional()
+  @IsString()
+  description?: string;
 
   @ValidateNested({ each: true })
   @IsArray()

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

@@ -1,11 +1,43 @@
-import { ArkosRouter } from "arkos";
-{{#if authentication}}
-import authRolePolicy from "@/src/modules/auth-role/auth-role.policy";
+import { ArkosRouter, ArkosRouteHook } from 'arkos';
+{{#if (neq authentication.type "none")}}
+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 (neq authentication.type "none")}}authentication: authRolePolicy.Create,{{/if}}
+});
+
+authRoleRouteHook.findOne({
+  {{#if (neq authentication.type "none")}}authentication: authRolePolicy.View,{{/if}}
+});
+
+authRoleRouteHook.findMany({
+  {{#if validation.type}}validation: { query: QueryAuthRoleDto },{{/if}}
+  {{#if (neq authentication.type "none")}}authentication: authRolePolicy.View,{{/if}}
+});
+
+authRoleRouteHook.updateOne({
+  {{#if validation.type}}validation: { body: UpdateAuthRoleDto },{{/if}}
+  {{#if (neq authentication.type "none")}}authentication: authRolePolicy.Update,{{/if}}
+});
+
+authRoleRouteHook.deleteOne({
+  {{#if (neq authentication.type "none")}}authentication: authRolePolicy.Delete,{{/if}}
+});
 
 const authRoleRouter = ArkosRouter({
-    prefix: "/auth-roles",
-    openapi: { tags: ["Auth Roles"] } 
-  });
+  prefix: "/auth-roles",
+  openapi: { tags: ["Auth Roles"] },
+});
+
+authRoleRouter.load(authRoleRouteHook);
 
 export default authRoleRouter;

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

@@ -27,6 +27,7 @@ import 'reflect-metadata';
 
 export enum ApiAction {
   connect = 'connect',
+  disconnect = 'disconnect',
   delete = 'delete',
   create = 'create',
   update = 'update'

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 Uploads"] },
+});
+
+fileUploadRouter.load(fileUploadRouteHook);
 
 export default fileUploadRouter;

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/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";
+
+await app.build();
+
+const server = http.createServer(app);
+
+app.listen(server);

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

@@ -4,7 +4,7 @@
 * 
 * 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,6 +1,6 @@
 {
   "compilerOptions": {
-    "target": "ES6",
+    "target": "es2020",
     "module": "es2020",
     "moduleResolution": "bundler",
     "rootDir": ".",

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;