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

package/templates/basic/package.json.hbs

@@ -2,38 +2,53 @@
   "name": "{{projectName}}",
   "version": "1.0.0",
   "type": "module",
-  "description": "This RESTful API was generated by create-arkos, read more about Arkos.js at www.arkosjs.com",
+  "description": "This RESTful API was generated by create-arkos, read more about Arkos.js at [www.arkosjs.com](https://www.arkosjs.com)",
   "scripts": {
     "dev": "arkos dev",
     "build": "arkos build",
     "start": "arkos start",
     "arkos": "arkos"
   },
-  "prisma": {
-    "schema": "prisma/schema/"
-  },
   "devDependencies": {
     {{#if typescript}}
-    "typescript": "^5.7.3",
-    "@types/node": "^24.0.12",
-    "@types/express": "^5.0.0",
+    "typescript": "7.0.2",
+    "@types/node": "26.1.1",
+    "@types/express": "5.0.6",
+    {{/if}}
+    "tsx-strict": "0.8.0",
+    "tsx": "4.23.1"{{#if (neq prisma.provider "none")}},
+    "prisma": "7.9.0"
     {{/if}}
-    "tsx-strict": "^0.4.2",
-    "tsx": "^4.21.0",
-    "prisma": "^6.19.2"
   },
   "dependencies": {
-    "arkos": "^2.0.0-next.2", 
-    "express": "^4.22.1",
-    "@scalar/express-api-reference": "^0.8.35",
-    "@prisma/client": "^6.19.2"{{#if validation.type}},{{/if}}
+    "arkos": "2.0.0-next.20", 
+    "express": "5.2.1",
+    "@scalar/express-api-reference": "0.10.11",
+    "@scalar/api-reference": "1.63.0"{{#if (or (neq prisma.provider "none") validation.type)}},{{/if}}
+    {{#if (neq prisma.provider "none")}}
+    "@prisma/client": "7.9.0",
+    {{#if (eq prisma.provider "postgresql")}}
+    "@prisma/adapter-pg": "7.9.0",
+    {{/if}}
+    {{#if (eq prisma.provider "cockroachdb")}}
+    "@prisma/adapter-pg": "7.9.0",
+    {{/if}}
+    {{#if (eq prisma.provider "mysql")}}
+    "@prisma/adapter-mariadb": "7.9.0",
+    {{/if}}
+    {{#if (eq prisma.provider "sqlite")}}
+    "@prisma/adapter-better-sqlite3": "7.9.0",
+    {{/if}}
+    {{#if (eq prisma.provider "sqlserver")}}
+    "@prisma/adapter-mssql": "7.9.0",
+    {{/if}}
     {{#if (eq validation.type "class-validator")}}
-    "reflect-metadata": "^0.2.2",
-    "class-transformer": "^0.5.1",
-    "class-validator": "^0.14.1"
+    "reflect-metadata": "0.2.2",
+    "class-transformer": "0.5.1",
+    "class-validator": "0.15.1"
     {{/if}}
     {{#if (eq validation.type "zod")}}
-    "zod": "^3.24.2"
+    "zod": "4.4.3"
     {{/if}}
   }
 }

package/templates/basic/prisma/schema/__tests__/user-role.prisma.hbs.test.ts

@@ -24,10 +24,10 @@ describe("UserRole model template rendering", () => {
     const result1 = renderTemplate(templatePath, context1);
     expect(result1.trim()).toBe("");
 
-    // Test case 2: Define later authentication
+    // Test case 2: none authentication
     const context2 = {
       authentication: {
-        type: "define later",
+        type: "none",
         multipleRoles: false,
       },
       prisma: {

package/templates/basic/prisma/schema/__tests__/user.prisma.hbs.test.ts

@@ -65,10 +65,10 @@ describe("User model template rendering", () => {
     expect(result3).toContain("roles                UserRole[]");
   });
 
-  it('should handle "define later" authentication type', () => {
+  it('should handle "none" authentication type', () => {
     const context = {
       authentication: {
-        type: "define later",
+        type: "none",
         usernameField: "email",
       },
       prisma: {

package/templates/basic/prisma/schema/auth-permission.prisma.hbs

@@ -1,17 +1,11 @@
 model AuthPermission {
   id        String   {{{prisma.idDatabaseType}}}
   resource  String
-  {{#if (eq prisma.provider "sqlite")}}
   action    String   @default("View") 
-  {{else}}
-  action    String @default("View") 
-  {{/if}}
-  roleId    String    {{#if (eq prisma.provider "mongodb")}}@db.ObjectId{{/if}}
-  role      AuthRole  @relation(fields: [roleId], references: [id])
+  roles     AuthRole[] 
+  users     UserPermission[]
   createdAt DateTime  @default(now())
   updatedAt DateTime  @updatedAt
 
-  @@unique([resource, action, roleId])
+  @@unique([resource, action])
 }
-
-

package/templates/basic/prisma/schema/auth-role.prisma.hbs

@@ -4,7 +4,7 @@ model AuthRole {
   description String?
   permissions AuthPermission[]
   users       UserRole[]
-  createdAt DateTime @default(now())
-  updatedAt DateTime @updatedAt
+  createdAt   DateTime @default(now())
+  updatedAt   DateTime @updatedAt
 }
 

package/templates/basic/prisma/schema/schema.prisma.hbs

@@ -1,9 +1,8 @@
 generator client {
-  provider = "prisma-client-js"
+  provider = "prisma-client"
+  output   = "../../src/generated/prisma"
 }
 
 datasource db {
   provider = "{{prisma.provider}}"
-  url      = env("DATABASE_URL")
 }
-

package/templates/basic/prisma/schema/user-permission.prisma.hbs

@@ -0,0 +1,18 @@
+model UserPermission {
+  id           String  @id @default(uuid())
+  createdAt    DateTime   @default(now())
+  updatedAt    DateTime   @updatedAt
+
+  effect       UserPermissionEffect @default(Allow)
+  userId       String
+  user         User           @relation(fields: [userId], references: [id])
+  permissionId String
+  permission   AuthPermission @relation(fields: [permissionId], references: [id])
+
+  @@unique([userId, permissionId])
+}
+
+enum UserPermissionEffect {
+  Allow
+  Deny
+}

package/templates/basic/prisma/schema/user.prisma.hbs

@@ -1,4 +1,4 @@
-{{#if (neq authentication.type "define later")}}
+{{#if (neq authentication.type "none")}}
 model User {
   id                   String    {{{prisma.idDatabaseType}}}
   {{authentication.usernameField}}  String   @unique
@@ -30,9 +30,11 @@ model User {
       {{/if}}
     {{/if}}
   {{/if}}
+ {{#if (eq authentication.type "dynamic")}}
+  permissions          UserPermission[]
+  {{/if}}
   createdAt            DateTime @default(now())
   updatedAt            DateTime @updatedAt
-  // other fields for your application
 }
 
 {{#if (eq authentication.type "static")}}

package/templates/basic/prisma.config.ts.hbs

@@ -0,0 +1,11 @@
+import { loadEnvironmentVariables } from "arkos/utils";
+loadEnvironmentVariables()
+
+import { defineConfig, env } from "prisma/config";
+
+export default defineConfig({
+  datasource: {
+    url: env("DATABASE_URL"),
+  },
+  schema: "prisma/schema"
+});

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

@@ -1,12 +1,14 @@
 import arkos from "arkos";
-import router from "@/src/router"
-import loadables from "@/src/loadables"
+import router from "@/src/router";
 
-const app = arkos()
+const app = arkos();
 
-app.set("trust proxy", 1)
+app.set("trust proxy", 1);
+app.use(router);
 
-app.load(loadables)
-app.use(router)
+{{#if (eq entryPoint "src/app")}}
+app.listen();
+{{else}}
+export default app;
+{{/if}}
 
-app.listen()

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

@@ -1,5 +1,5 @@
 import { ArkosPolicy } from "arkos";
 
-const authPolicy = ArkosPolicy("auth-permission")
+const authPolicy = ArkosPolicy("auth")
 
 export default authPolicy;

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/dtos/login.dto.ts.hbs

@@ -8,7 +8,7 @@ const LoginDto = z.object({
 
 export default LoginDto;
 {{#if typescript}}
-export type LoginDtoType = z.infer<typeof LoginDto>;
+export type LoginDto = z.infer<typeof LoginDto>;
 {{/if}}
 {{/if}}
 {{#if (eq validation.type "class-validator")}}

package/templates/basic/src/modules/auth/dtos/signup.dto.ts.hbs

@@ -8,7 +8,7 @@ const SignupDto = z.object({
 
 export default SignupDto;
 {{#if typescript}}
-export type SignupDtoType = z.infer<typeof SignupDto>;
+export type SignupDto = z.infer<typeof SignupDto>;
 {{/if}}
 {{/if}}
 {{#if (eq validation.type "class-validator")}}

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

@@ -7,7 +7,7 @@ const UpdateMeDto = z.object({
 
 export default UpdateMeDto;
 {{#if typescript}}
-export type UpdateMeDtoType = z.infer<typeof UpdateMeDto>;
+export type UpdateMeDto = z.infer<typeof UpdateMeDto>;
 {{/if}}
 {{/if}}
 {{#if (eq validation.type "class-validator")}}

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

@@ -8,7 +8,7 @@ const UpdatePasswordDto = z.object({
 
 export default UpdatePasswordDto;
 {{#if typescript}}
-export type UpdatePasswordDtoType = z.infer<typeof UpdatePasswordDto>;
+export type UpdatePasswordDto = z.infer<typeof UpdatePasswordDto>;
 {{/if}}
 {{/if}}
 {{#if (eq validation.type "class-validator")}}

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/auth-permission.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 AuthPermissionService extends BaseService<"auth-permission"> {}
+{{#if typescript}}
+class AuthPermissionService extends ArkosPrismaService<"auth-permission"> {}
 {{else}}
-
-class AuthPermissionService extends BaseService {}
+class AuthPermissionService extends ArkosPrismaService {}
 {{/if}}
 
 const authPermissionService = new AuthPermissionService("auth-permission");

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

@@ -4,19 +4,19 @@ 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(),
 });
 
 export default CreateAuthPermissionDto;
 {{#if typescript}}
-export type CreateAuthPermissionDtoType = z.infer<typeof CreateAuthPermissionDto>;
+export type CreateAuthPermissionDto = 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,13 +35,10 @@ export default class CreateAuthPermissionDto {
   @Transform(({ value }) => value || 'View')
   action?: string = 'View';
 
-  @ValidateNested()
+  @ValidateNested({ each: true })
+  @IsArray()
   @Type(() => RoleConnectDto)
-  role!: RoleConnectDto;
-
   @IsOptional()
-  @IsString()
-  @Transform(({ value }) => value)
-  description?: string;
+  roles?: RoleConnectDto[];
 }
 {{/if}}

package/templates/basic/src/modules/auth-permission/dtos/{query-auth-role.dto.ts.hbs → query-auth-permission.dto.ts.hbs}

@@ -18,7 +18,7 @@ const QueryAuthPermissionDto = z.object({
 
 export default QueryAuthPermissionDto;
 {{#if typescript}}
-export type QueryAuthPermissionDtoType = z.infer<typeof QueryAuthPermissionDto>;
+export type QueryAuthPermissionDto = z.infer<typeof QueryAuthPermissionDto>;
 {{/if}}
 {{/if}}
 {{#if (eq validation.type "class-validator")}}

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

@@ -5,18 +5,27 @@ 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;
 {{#if typescript}}
-export type UpdateAuthPermissionDtoType = z.infer<typeof UpdateAuthPermissionDto>;
+export type UpdateAuthPermissionDto = 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()
@@ -24,11 +33,17 @@ export default class UpdateAuthPermissionDto {
 
   @IsOptional()
   @IsString()
-  @Transform(({ value }) => value)
+  @Transform(({ value }) => String(value))
   action?: string;
 
   @IsOptional()
   @IsString()
   description?: string;
+
+  @ValidateNested({ each: true })
+  @IsArray()
+  @Type(() => RoleConnectDto)
+  @IsOptional()
+  roles?: RoleConnectDto[];
 }
 {{/if}}

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/auth-role.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 AuthRoleService extends BaseService<"auth-role"> {}
+{{#if typescript}}
+class AuthRoleService extends ArkosPrismaService<"auth-role"> {}
 {{else}}
-
-class AuthRoleService extends BaseService {}
+class AuthRoleService extends ArkosPrismaService {}
 {{/if}}
 
 const authRoleService = new AuthRoleService("auth-role");

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

@@ -15,7 +15,7 @@ const CreateAuthRoleDto = z.object({
 
 export default CreateAuthRoleDto;
 {{#if typescript}}
-export type CreateAuthRoleDtoType = z.infer<typeof CreateAuthRoleDto>;
+export type CreateAuthRoleDto = z.infer<typeof CreateAuthRoleDto>;
 {{/if}}
 {{/if}}
 {{#if (eq validation.type "class-validator")}}
@@ -29,13 +29,8 @@ class CreatePermissionForRoleDto {
   resource!: string;
 
   @IsString()
-  @Transform(({ value }) => value || 'View')
-  action: string = 'View';
-
-  @IsOptional()
-  @IsString()
-  @Transform(({ value }) => value)
-  description?: string;
+  @Transform(({ value }) => String(value))
+  action!: string;
 }
 
 export default class CreateAuthRoleDto {

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

@@ -22,7 +22,7 @@ const QueryAuthRoleDto = z.object({
 
 export default QueryAuthRoleDto;
 {{#if typescript}}
-export type QueryAuthRoleDtoType = z.infer<typeof QueryAuthRoleDto>;
+export type QueryAuthRoleDto = z.infer<typeof QueryAuthRoleDto>;
 {{/if}}
 {{/if}}
 {{#if (eq validation.type "class-validator")}}

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

@@ -17,7 +17,7 @@ const UpdateAuthRoleDto = z.object({
 
 export default UpdateAuthRoleDto;
 {{#if typescript}}
-export type UpdateAuthRoleDtoType = z.infer<typeof UpdateAuthRoleDto>;
+export type UpdateAuthRoleDto = z.infer<typeof UpdateAuthRoleDto>;
 {{/if}}
 {{/if}}
 {{#if (eq validation.type "class-validator")}}
@@ -27,6 +27,7 @@ import 'reflect-metadata';
 
 export enum ApiAction {
   connect = 'connect',
+  disconnect = 'disconnect',
   delete = 'delete',
   create = 'create',
   update = 'update'
@@ -45,11 +46,7 @@ class UpdatePermissionForRoleDto {
   @IsNotEmpty()
   action!: string;
 
-  @IsOptional()
-  @IsString()
-  @Transform(({ value }) => value)
-  description?: string;
-
+  @IsEnum(ApiAction)
   @IsOptional()
   @IsString()
   apiAction?: ApiAction;