create-arkos 0.0.2 → 0.0.4

package/dist/index.js

@@ -28,7 +28,7 @@ function main() {
         const projectPath = config.projectPath;
         fs_1.default.mkdirSync(projectPath, { recursive: true });
         console.info(`\nCreating a new ${chalk_1.default.bold(chalk_1.default.cyan("Arkos.js"))} project in ${chalk_1.default.green(`./${config.projectName}`)}`);
-        const templatesDir = path_1.default.resolve(`./src/utils/templates/basic`);
+        const templatesDir = path_1.default.resolve(`./templates/basic`);
         yield template_compiler_1.default.compile(templatesDir, config);
         process.chdir(projectPath);
         console.info("\nInstalling dependencies...");

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,4CAAoB;AACpB,gDAAwB;AACxB,kDAA0B;AAC1B,iDAAyC;AACzC,8FAAoE;AACpE,kFAAyD;AACzD,4DAAoC;AAEpC,oBAAU,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;AACnD,oBAAU,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;AAEpD,SAAe,IAAI;;QACjB,MAAM,MAAM,GAAG,MAAM,iCAAqB,CAAC,GAAG,EAAE,CAAC;QAEjD,MAAM,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;QAEvC,YAAE,CAAC,SAAS,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAE/C,OAAO,CAAC,IAAI,CACV,oBAAoB,eAAK,CAAC,IAAI,CAAC,eAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,eAAe,eAAK,CAAC,KAAK,CAAC,KAAK,MAAM,CAAC,WAAW,EAAE,CAAC,EAAE,CAC9G,CAAC;QAEF,MAAM,YAAY,GAAG,cAAI,CAAC,OAAO,CAAC,6BAA6B,CAAC,CAAC;QACjE,MAAM,2BAAgB,CAAC,OAAO,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;QAErD,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAE3B,OAAO,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;QAC7C,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAE/B,IAAA,wBAAQ,EAAC,aAAa,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;QAE9C,OAAO,CAAC,IAAI,CAAC;IACX,eAAK,CAAC,IAAI,CAAC,eAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;;;UAG5B,MAAM,CAAC,WAAW;kBACV,eAAK,CAAC,IAAI,CAAC,cAAc,CAAC;;;;KAIvC,CAAC,CAAC;IACP,CAAC;CAAA;AAED,IAAI,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC","sourcesContent":["#!/usr/bin/env node\nimport fs from \"fs\";\nimport path from \"path\";\nimport chalk from \"chalk\";\nimport { execSync } from \"child_process\";\nimport projectConfigInquirer from \"./utils/project-config-inquirer\";\nimport templateCompiler from \"./utils/template-compiler\";\nimport Handlebars from \"handlebars\";\n\nHandlebars.registerHelper(\"eq\", (a, b) => a === b);\nHandlebars.registerHelper(\"neq\", (a, b) => a !== b);\n\nasync function main() {\n  const config = await projectConfigInquirer.run();\n\n  const projectPath = config.projectPath;\n\n  fs.mkdirSync(projectPath, { recursive: true });\n\n  console.info(\n    `\\nCreating a new ${chalk.bold(chalk.cyan(\"Arkos.js\"))} project in ${chalk.green(`./${config.projectName}`)}`\n  );\n\n  const templatesDir = path.resolve(`./src/utils/templates/basic`);\n  await templateCompiler.compile(templatesDir, config);\n\n  process.chdir(projectPath);\n\n  console.info(\"\\nInstalling dependencies...\");\n  console.info(\"\\nUsing npm.\\n\");\n\n  execSync(\"npm install\", { stdio: \"inherit\" });\n\n  console.info(`\n  ${chalk.bold(chalk.cyan(\"Arkos.js\"))} project created successfully!\n\n  Next steps:\n  1. cd ${config.projectName}\n  2. setup your ${chalk.cyan(\"DATABASE_URL\")} under .env\n  3. npx prisma db push\n  4. npx prisma generate\n  5. npm run dev\n    `);\n}\n\nmain().catch(console.error);\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,4CAAoB;AACpB,gDAAwB;AACxB,kDAA0B;AAC1B,iDAAyC;AACzC,8FAAoE;AACpE,kFAAyD;AACzD,4DAAoC;AAEpC,oBAAU,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;AACnD,oBAAU,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;AAEpD,SAAe,IAAI;;QACjB,MAAM,MAAM,GAAG,MAAM,iCAAqB,CAAC,GAAG,EAAE,CAAC;QAEjD,MAAM,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;QAEvC,YAAE,CAAC,SAAS,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAE/C,OAAO,CAAC,IAAI,CACV,oBAAoB,eAAK,CAAC,IAAI,CAAC,eAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,eAAe,eAAK,CAAC,KAAK,CAAC,KAAK,MAAM,CAAC,WAAW,EAAE,CAAC,EAAE,CAC9G,CAAC;QAEF,MAAM,YAAY,GAAG,cAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;QACvD,MAAM,2BAAgB,CAAC,OAAO,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;QAErD,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAE3B,OAAO,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;QAC7C,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAE/B,IAAA,wBAAQ,EAAC,aAAa,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;QAE9C,OAAO,CAAC,IAAI,CAAC;IACX,eAAK,CAAC,IAAI,CAAC,eAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;;;UAG5B,MAAM,CAAC,WAAW;kBACV,eAAK,CAAC,IAAI,CAAC,cAAc,CAAC;;;;KAIvC,CAAC,CAAC;IACP,CAAC;CAAA;AAED,IAAI,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC","sourcesContent":["#!/usr/bin/env node\nimport fs from \"fs\";\nimport path from \"path\";\nimport chalk from \"chalk\";\nimport { execSync } from \"child_process\";\nimport projectConfigInquirer from \"./utils/project-config-inquirer\";\nimport templateCompiler from \"./utils/template-compiler\";\nimport Handlebars from \"handlebars\";\n\nHandlebars.registerHelper(\"eq\", (a, b) => a === b);\nHandlebars.registerHelper(\"neq\", (a, b) => a !== b);\n\nasync function main() {\n  const config = await projectConfigInquirer.run();\n\n  const projectPath = config.projectPath;\n\n  fs.mkdirSync(projectPath, { recursive: true });\n\n  console.info(\n    `\\nCreating a new ${chalk.bold(chalk.cyan(\"Arkos.js\"))} project in ${chalk.green(`./${config.projectName}`)}`\n  );\n\n  const templatesDir = path.resolve(`./templates/basic`);\n  await templateCompiler.compile(templatesDir, config);\n\n  process.chdir(projectPath);\n\n  console.info(\"\\nInstalling dependencies...\");\n  console.info(\"\\nUsing npm.\\n\");\n\n  execSync(\"npm install\", { stdio: \"inherit\" });\n\n  console.info(`\n  ${chalk.bold(chalk.cyan(\"Arkos.js\"))} project created successfully!\n\n  Next steps:\n  1. cd ${config.projectName}\n  2. setup your ${chalk.cyan(\"DATABASE_URL\")} under .env\n  3. npx prisma db push\n  4. npx prisma generate\n  5. npm run dev\n    `);\n}\n\nmain().catch(console.error);\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-arkos",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "CLI for creating Arkos.js projects, see docs at www.arkosjs.com/docs",
   "bin": {
     "create-arkos": "./dist/index.js"
@@ -21,17 +21,17 @@
     "url": "https://github.com/uanela/arkos/issues"
   },
   "homepage": "https://www.arkosjs.com",
-  "files": ["dist", "cli.js", "README.md"],
+  "files": ["dist", "templates", "cli.js", "README.md"],
   "devDependencies": {
     "@types/inquirer": "^8.1.0",
     "@types/node": "^16.18.126",
-    "inquirer": "^8.2.6",
     "ts-node": "^10.9.2",
     "typescript": "^4.9.5"
   },
   "dependencies": {
     "@clack/prompts": "^0.11.0",
     "@inquirer/prompts": "^7.6.0",
+    "inquirer": "^8.2.6",
     "chalk": "^5.4.1",
     "handlebars": "^4.7.8"
   }

package/templates/basic/.env.hbs

@@ -0,0 +1 @@
+DATABASE_URL=your-db-url-here

package/templates/basic/.gitignore.hbs

@@ -0,0 +1,85 @@
+# Dependencies
+/node_modules
+/.pnp
+.pnp.js
+package-lock.json
+yarn.lock
+pnpm-lock.yaml
+.npm
+
+# Environment files
+.env
+.env.local
+.env.*.local
+.env.development
+.env.test
+.env.production
+*.env
+
+# Build and output directories
+/build
+/dist
+/.dist
+/out
+/.build
+/coverage
+/.nyc_output
+
+# Arkos.js' base uploads directory
+/uploads
+
+# TypeScript cache and declaration files
+*.tsbuildinfo
+/src/**/*.js.map
+/src/**/*.d.ts
+/types/generated/*
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# IDE and editor directories
+/.idea
+/.vscode
+*.swp
+*.swo
+.DS_Store
+.project
+.classpath
+.settings/
+
+# OS files
+.DS_Store
+Thumbs.db
+ehthumbs.db
+Desktop.ini
+$RECYCLE.BIN/
+
+# Testing
+/coverage
+/.nyc_output
+/cypress/screenshots
+/cypress/videos
+/.jest-cache
+
+# Temporary files
+*.tmp
+*.temp
+.cache/
+.eslintcache
+.stylelintcache
+
+# Misc
+.serverless/
+.fusebox/
+.dynamodb/
+.webpack/
+.next/
+.nuxt/
+.cache/
+.docz/
+.vercel

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

@@ -0,0 +1,10 @@
+{{#if TYPECSRIPT_ENABLED}}
+import { ArkosConfig } from 'arkos'
+
+const config: ArkosConfig = {}
+{{else}}
+/** @type {import('arkos').ArkosConfig} */
+const config = {}
+{{/if}}
+
+export default config

package/templates/basic/package.json.hbs

@@ -0,0 +1,27 @@
+{
+  "name": "{{projectName}}",
+  "version": "1.0.0",
+  "description": "This RESTful API was generated by Arkos.js, read more about Arkos.js at 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",
+    "ts-node": "^10.9.2",
+    "ts-node-dev": "^2.0.0",
+    "@types/node": "^24.0.12",
+    {{/if}}
+    "prisma": "^6.11.1"
+  },
+  "dependencies": {
+    "arkos": "^1.2.0-beta", 
+    "@prisma/client": "^6.11.1"
+  }
+}

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

@@ -0,0 +1,28 @@
+{{#if (neq prisma.provider "sqlite")}}
+enum AuthPermissionAction {
+  View
+  Create
+  Update
+  Delete
+ // Add more custom actions
+}
+{{/if}}
+
+model AuthPermission {
+  id        String   {{prisma.idDatabaseType}}
+  resource  String
+  {{#if (eq prisma.provider "sqlite")}}
+  action    String   @default("View") 
+  {{else}}
+  action    AuthPermissionAction @default(View) 
+  {{/if}}
+  roleId    String
+  role      AuthRole  @relation(fields: [roleId], references: [id])
+  description String?
+  createdAt DateTime  @default(now())
+  updatedAt DateTime  @default(now())
+
+  @@unique([resource, action, roleId])
+}
+
+

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

@@ -0,0 +1,10 @@
+model AuthRole {
+  id          String          {{prisma.idDatabaseType}}
+  name        String          @unique
+  description String?
+  permissions AuthPermission[]
+  users       UserRole[]
+  createdAt DateTime @default(now())
+  updatedAt DateTime @default(now())
+}
+

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

@@ -0,0 +1,9 @@
+generator client {
+  provider        = "prisma-client-js"
+}
+
+datasource db {
+  provider = "{{prisma.provider}}"
+  url      = env("DATABASE_URL")
+}
+

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

@@ -0,0 +1,63 @@
+model User {
+  id                   String    {{prisma.idDatabaseType}}
+  {{authentication.usernameField}}  String   @unique
+  password             String
+  passwordChangedAt    DateTime?
+  lastLoginAt          DateTime?
+  isSuperUser          Boolean   @default(false)
+  isStaff              Boolean   @default(false)
+  deletedSelfAccountAt DateTime?
+  isActive             Boolean   @default(true)
+  {{#if authentication.multipleRoles}}
+  {{#if (eq prisma.provider "sqlite")}}
+  roles                String[] // Roles examples: Admin, User
+  {{else}}
+  roles                UserRole[]
+  {{/if}}
+  {{else}}
+  {{#if (eq authentication.type "dynamic")}}
+  role                 UserRole?
+  {{else}}
+  {{#if (eq prisma.provider "sqlite")}}
+  role                 String // Roles examples: Admin, User
+  {{else}}
+  role                 UserRole
+  {{/if}}
+  {{/if}}
+  {{/if}}
+  createdAt            DateTime @default(now())
+  updatedAt            DateTime @default(now())
+  // other fields for your application
+}
+
+{{#if (eq authentication.type "dynamic")}}
+model UserRole {
+  id        String     {{prisma.idDatabaseType}}
+  {{#if authentication.multipleRoles}}
+  userId    String     
+  {{else}}
+  userId    String     @unique
+  {{/if}}
+  user      User       @relation(fields: [userId], references: [id])
+  roleId    String
+  role      AuthRole   @relation(fields: [roleId], references: [id])
+  createdAt DateTime   @default(now())
+  updatedAt DateTime   @default(now())
+  {{#if authentication.multipleRoles}}
+
+  @@unique([userId, roleId])
+  {{/if}}
+}
+{{/if}}
+
+{{#if (eq authentication.type "static")}}
+{{#if (eq prisma.provider "sqlite")}}
+{{else}}
+enum UserRole {
+  Admin
+  User
+  // change or add new roles
+}
+{{/if}}
+{{/if}}
+

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

@@ -0,0 +1,17 @@
+import arkos from 'arkos';
+
+arkos.init({
+  {{#if authentication.type}}
+  authentication: {
+    mode: '{{authentication.type}}',
+    login: {
+      allowedUsernames: ['{{authentication.usernameField}}'],
+    }
+  },
+  {{/if}}
+  {{#if validation.type}}
+  validation: {
+    resolver: '{{validation.type}}'
+  },
+  {{/if}}
+});

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

@@ -0,0 +1,5 @@
+import { PrismaClient } from "@prisma/client";
+
+const prisma = new PrismaClient();
+
+export default prisma;