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

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "create-arkos",
-  "version": "2.0.0-next.16",
+  "version": "2.0.0-next.18",
   "type": "module",
   "description": "CLI for creating Arkos.js projects, see docs at www.arkosjs.com",
   "bin": {
-    "create-arkos": "dist/index.js"
+    "create-arkos": "./dist/index.js"
   },
   "scripts": {
     "test": "vitest --coverage",
@@ -26,23 +26,23 @@
   "bugs": {
     "url": "https://github.com/uanela/arkos/issues"
   },
-  "homepage": "https://www.arkosjs.com/docs/cli/create-arkos",
+  "homepage": "https://www.arkosjs.com/docs/tooling/cli/overviewcreate-arkos",
   "files": ["dist", "templates", "cli.js", "README.md"],
   "devDependencies": {
-    "@types/inquirer": "9.0.9",
+    "@types/inquirer": "8.1.0",
     "@types/node": "16.18.126",
-    "@vitest/coverage-v8": "4.1.7",
+    "@vitest/coverage-v8": "3.2.4",
     "rimraf": "6.1.3",
     "ts-node": "10.9.2",
     "tsx": "4.21.0",
     "typescript": "4.9.5",
-    "vitest": "4.1.7"
+    "vitest": "3.2.4"
   },
   "dependencies": {
     "@clack/prompts": "0.11.0",
-    "@inquirer/prompts": "7",
+    "@inquirer/prompts": "7.6.0",
     "chalk": "5.4.1",
-    "handlebars": "^4.7.9",
+    "handlebars": "4.7.8",
     "inquirer": "8.2.6"
   }
 }

package/templates/basic/README.md.hbs

@@ -1,13 +1,11 @@
-This is a [Arkos.js](https://arkosjs.com) project scaffolded with [`create-arkos`](https://arkosjs.com/docs/tooling/cli/overviewcreate-arkos).
+This is an [Arkos.js](https://arkosjs.com) project scaffolded with [`create-arkos`](https://arkosjs.com/docs/tooling/create-arkos).
 
 ## Getting Started
 
 First, run the development server:
 
 ```bash
-pnpm dev
-# or
-npm run dev
+{{packageManager}} run dev
 ```
 
 - Visit [http://localhost:8000/api/docs](http://localhost:8000/api/docs) with your browser to see the swagger api documentation.

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

@@ -1,5 +1,5 @@
 import { defineConfig } from "arkos/config"
-import prisma from "./src/utils/prisma"
+import prisma from "@/src/utils/prisma"
 
 const arkosConfig = defineConfig({
   globalPrefix: "/api",
@@ -45,7 +45,7 @@ const arkosConfig = defineConfig({
         noSchemaFound: true,
       },
     },
-  },
+  }
   {{/if}}
 })
 

package/templates/basic/jsconfig.json.hbs

@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
-    "target": "es2022",
-    "module": "es2022",
+    "target": "ES6",
+    "module": "es2020",
     "moduleResolution": "bundler",
     "rootDir": ".",
     "baseUrl": ".",

package/templates/basic/package.json.hbs

@@ -1,5 +1,7 @@
 {
   "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",
   "scripts": {
     "dev": "arkos dev",
@@ -16,18 +18,18 @@
     "@types/node": "24.0.12",
     "@types/express": "5.0.0",
     {{/if}}
-    "tsx-strict": "0.7.0",
-    "tsx": "4.21.0"{{#if (neq prisma.provider "none")}},
-    "prisma": "6.19.2"
+    "tsx-strict": "0.8.0",
+    "tsx": "4.23.1"{{#if (neq prisma.provider "none")}},
+    "prisma": "6.19.3"
     {{/if}}
   },
   "dependencies": {
-    "arkos": "2.0.0-next.16", 
-    "express": "4.22.1",
-    "@scalar/express-api-reference": "0.8.35",
-    "@scalar/api-reference": "1.55.3",
+    "arkos": "2.0.0-next.18", 
+    "express": "4.22.2",
+    "@scalar/express-api-reference": "0.10.2",
+    "@scalar/api-reference": "1.55.3"{{#if (or (neq prisma.provider "none") validation.type)}},{{/if}}
     {{#if (neq prisma.provider "none")}}
-    "@prisma/client": "6.19.2"{{#if validation.type}},{{/if}}
+    "@prisma/client": "6.19.3"{{#if validation.type}},{{/if}}
     {{/if}}
     {{#if (eq validation.type "class-validator")}}
     "reflect-metadata": "0.2.2",
@@ -35,7 +37,7 @@
     "class-validator": "0.14.1"
     {{/if}}
     {{#if (eq validation.type "zod")}}
-    "zod": "3.24.2"
+    "zod": "3.25.76"
     {{/if}}
   }
 }

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

@@ -24,7 +24,7 @@ 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: "none",

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/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

@@ -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/src/app.ts.hbs

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

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-permission/auth-permission.router.ts.hbs

@@ -1,19 +1,43 @@
-import { ArkosRouter{{#if typescript}}, RouteHook{{/if}} } from "arkos";
-{{#if authentication}}
-import authPermissionPolicy from "@/src/modules/auth-permission/auth-permission.policy";
-
-export const hook{{#if typescript}}: RouteHook{{/if}} = {
-  createOne: { authentication: authPermissionPolicy.Create },
-  findMany: { authentication: authPermissionPolicy.View },
-  findOne: { authentication: authPermissionPolicy.View },
-  updateOne: { authentication: authPermissionPolicy.Update },
-  deleteOne: { authentication: authPermissionPolicy.Delete },
-};
+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,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/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()
@@ -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,19 +1,43 @@
-import { ArkosRouter{{#if typescript}}, RouteHook{{/if}} } from "arkos";
-{{#if authentication}}
-import authRolePolicy from "@/src/modules/auth-role/auth-role.policy";
-
-export const hook{{#if typescript}}: RouteHook{{/if}} = {
-  createOne: { authentication: authRolePolicy.Create },
-  findMany: { authentication: authRolePolicy.View },
-  findOne: { authentication: authRolePolicy.View },
-  updateOne: { authentication: authRolePolicy.Update },
-  deleteOne: { authentication: authRolePolicy.Delete },
-};
+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/create-auth-role.dto.ts.hbs

@@ -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/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'
@@ -45,11 +46,7 @@ class UpdatePermissionForRoleDto {
   @IsNotEmpty()
   action!: string;
 
-  @IsOptional()
-  @IsString()
-  @Transform(({ value }) => value)
-  description?: string;
-
+  @IsEnum(ApiAction)
   @IsOptional()
   @IsString()
   apiAction?: ApiAction;

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

@@ -1,19 +1,32 @@
-import { ArkosRouter{{#if typescript}}, RouteHook{{/if}} } from "arkos";
-import config from "@/arkos.config"
-{{#if authentication}}
-import fileUploadPolicy from "@/src/modules/file-upload/file-upload.policy";
-
-export const hook{{#if typescript}}: RouteHook<"file-upload">{{/if}} = {
-  findFile: { authentication: fileUploadPolicy.View },
-  uploadFile: { authentication: fileUploadPolicy.Create },
-  updateFile: { authentication: fileUploadPolicy.Update },
-  deleteFile: { authentication: fileUploadPolicy.Delete },
-};
+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';
 
-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;