create-warlock 2.6.1 → 2.7.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "create-warlock",
-    "version": "2.6.1",
+    "version": "2.7.0",
     "main": "./esm/index.js",
     "license": "MIT",
     "type": "module",

package/templates/warlock/.env

@@ -0,0 +1,39 @@
+# App Configurations
+APP_NAME="gym-management"
+LOCALE_CODE=en
+
+TIMEZONE=UTC
+
+# Http Configurations
+HTTP_PORT=2030
+HTTP_HOST=127.0.0.1
+BASE_URL=http://${HOST}:${PORT}
+
+# Database Configurations
+DB_AUTH=admin
+DB_PORT=27017
+DB_HOST=127.0.0.1
+DB_NAME=gym-management
+DB_USERNAME=root
+DB_PASSWORD=root
+
+# Cache
+CACHE_DRIVER=memory
+## Redis
+REDIS_HOST=127.0.0.1
+REDIS_PORT=6379
+# or using redis url
+#REDIS_URL=
+
+# Mail
+MAIL_HOST=
+MAIL_PORT=465
+MAIL_ENCRYPTION=ssl
+MAIL_SECURE=true
+MAIL_USERNAME=
+MAIL_PASSWORD=
+MAIL_FROM_NAME=${APP_NAME}
+MAIL_FROM_ADDRESS=
+
+# JWT Secret
+JWT_SECRET=5Ulrs4caSEMqL5SwH41QdBOAC0NFCGnf

package/templates/warlock/.env.example

@@ -1,36 +1,36 @@
-# App Configurations
-APP_NAME="appName"
-LOCALE_CODE=en
-
-TIMEZONE=UTC
-
-# Http Configurations
-HTTP_PORT=1911
-HTTP_HOST=127.0.0.1
-BASE_URL=http://${HOST}:${PORT}
-
-# Database Configurations
-DB_AUTH=admin
-DB_PORT=27017
-DB_HOST=127.0.0.1
-DB_NAME=appName
-DB_USERNAME=root
-DB_PASSWORD=root
-
-# Cache
-CACHE_DRIVER=memory
-## Redis
-REDIS_HOST=127.0.0.1
-REDIS_PORT=6379
-# or using redis url
-#REDIS_URL=
-
-# Mail
-MAIL_HOST=
-MAIL_PORT=465
-MAIL_ENCRYPTION=ssl
-MAIL_SECURE=true
-MAIL_USERNAME=
-MAIL_PASSWORD=
-MAIL_FROM_NAME=${APP_NAME}
+# App Configurations
+APP_NAME="appName"
+LOCALE_CODE=en
+
+TIMEZONE=UTC
+
+# Http Configurations
+HTTP_PORT=2030
+HTTP_HOST=127.0.0.1
+BASE_URL=http://${HOST}:${PORT}
+
+# Database Configurations
+DB_AUTH=admin
+DB_PORT=27017
+DB_HOST=127.0.0.1
+DB_NAME=appName
+DB_USERNAME=root
+DB_PASSWORD=root
+
+# Cache
+CACHE_DRIVER=memory
+## Redis
+REDIS_HOST=127.0.0.1
+REDIS_PORT=6379
+# or using redis url
+#REDIS_URL=
+
+# Mail
+MAIL_HOST=
+MAIL_PORT=465
+MAIL_ENCRYPTION=ssl
+MAIL_SECURE=true
+MAIL_USERNAME=
+MAIL_PASSWORD=
+MAIL_FROM_NAME=${APP_NAME}
 MAIL_FROM_ADDRESS=

package/templates/warlock/.gitattributes

@@ -1 +1 @@
-* text=auto eol=lf
+* text=auto eol=lf

package/templates/warlock/package.json

@@ -3,7 +3,7 @@
     "version": "1.0.0",
     "private": true,
     "scripts": {
-        "start": "warlock dev",
+        "dev": "warlock dev",
         "build": "tsc && warlock build",
         "prod": "warlock start",
         "postman": "warlock postman",
@@ -17,7 +17,8 @@
         "lint": "npx eslint --fix ./src --max-warnings=0",
         "format": "npx prettier --write ./src/**/*.{js,jsx,ts,tsx,css,md,json} --config ./.prettierrc.json",
         "tsc": "npx tsc --noEmit",
-        "prepare": "huskier-init && husky install"
+        "prepare": "huskier-init && husky install",
+        "lf": "find . -type d ( -name 'node_modules' -o -name '.git' ) -prune -o -type f -exec dos2unix {} ;"
     },
     "dependencies": {
         "@mongez/collection": "^1.2.0",
@@ -28,11 +29,12 @@
         "@mongez/dotenv": "^1.1.9",
         "@mongez/config": "^1.0.26",
         "@mongez/supportive-is": "^2.0.4",
-        "@warlock.js/auth": "2.6.1",
-        "@warlock.js/cache": "2.6.1",
-        "@warlock.js/cascade": "2.6.1",
-        "@warlock.js/core": "2.6.1",
-        "@warlock.js/logger": "2.6.1",
+        "@warlock.js/auth": "2.7.0",
+        "@warlock.js/cache": "2.7.0",
+        "@warlock.js/cascade": "2.7.0",
+        "@warlock.js/core": "2.7.0",
+        "@warlock.js/logger": "2.7.0",
+        "@faker-js/faker": "^9.2.0",
         "dayjs": "^1.11.13"
     },
     "devDependencies": {

package/templates/warlock/src/app/main.ts

@@ -1,12 +1,43 @@
-// this file is called before any main file in the other modules
-// This will be called directly when the app starts
-import { onceConnected } from "@warlock.js/cascade";
-
-// This function will be called once the app is connected to the database
-// it will be called on app start
-// If the app is running in development mode, this function will be called
-// every time a file is changed
-// it could be useful to test some code or do small database modifications
-onceConnected(() => {
-  //
-});
+// this file is called before any main file in the other modules
+// This will be called directly when the app starts
+import { onceConnected } from "@warlock.js/cascade";
+import { Post } from "./posts/models";
+import { User } from "./users/models/user";
+
+// This function will be called once the app is connected to the database
+// it will be called on app start
+// If the app is running in development mode, this function will be called
+// every time a file is changed
+// it could be useful to test some code or do small database modifications
+onceConnected(async () => {
+  const user = await User.findOrCreate(
+    {
+      email: "hassanzohdy@gmail.com",
+    },
+    {
+      name: "Hasan Zohdy",
+      email: "hassanzohdy@gmail.com",
+      password: "123456",
+    },
+  );
+
+  await Post.create({
+    author: user,
+    title: "My first post",
+    content: "This is my first post",
+  });
+
+  await Post.create({
+    author: user,
+    title: "My second post",
+    content: "This is my second post",
+  });
+
+  await Post.create({
+    author: user,
+    title: "My third post",
+    content: "This is my third post",
+  });
+
+  console.log("Done");
+});

package/templates/warlock/src/app/posts/controllers/create-new-post.request.ts

@@ -0,0 +1,26 @@
+import {
+  v,
+  type Request,
+  type RequestHandler,
+  type Response,
+} from "@warlock.js/core";
+import { Post } from "../models";
+
+export const createNewPostRequest: RequestHandler = async (
+  request: Request,
+  response: Response,
+) => {
+  const post = await Post.create(request.validated());
+
+  return response.success({
+    message: "Post created successfully",
+    post,
+  });
+};
+
+createNewPostRequest.validation = {
+  schema: v.object({
+    title: v.string().required().minLength(4),
+    content: v.string().required(),
+  }),
+};

package/templates/warlock/src/app/posts/controllers/get-all-posts.request.ts

@@ -0,0 +1,17 @@
+import {
+  type Request,
+  type RequestHandler,
+  type Response,
+} from "@warlock.js/core";
+import { Post } from "../models";
+
+export const getAllPostsRequest: RequestHandler = async (
+  request: Request,
+  response: Response,
+) => {
+  const posts = await Post.list();
+
+  return response.success({
+    posts,
+  });
+};

package/templates/warlock/src/app/posts/controllers/get-post.request.ts

@@ -0,0 +1,37 @@
+import {
+  v,
+  type Request,
+  type RequestHandler,
+  type Response,
+} from "@warlock.js/core";
+import { Post } from "../models";
+
+export const getPostRequest: RequestHandler = async (
+  request: Request,
+  response: Response,
+) => {
+  // 👇 look at the custom validation function
+  const post: Post = request.post;
+
+  return response.success({
+    post,
+  });
+};
+
+getPostRequest.validation = {
+  schema: v.object({
+    id: v.int().required(),
+  }),
+  validate: async (request: Request, response: Response) => {
+    const post = await Post.find(request.int("id"));
+
+    if (!post) {
+      return response.notFound({
+        error: "Post Not found",
+      });
+    }
+
+    // inject the post into the request object
+    request.post = post;
+  },
+};

package/templates/warlock/src/app/posts/models/index.ts

@@ -0,0 +1 @@
+export * from "./post.model";

package/templates/warlock/src/app/posts/models/post.model.ts

@@ -0,0 +1,22 @@
+import { Model, type Casts } from "@warlock.js/cascade";
+import { PostOutput } from "../output/post.output";
+
+export class Post extends Model {
+  /**
+   * Collection name
+   */
+  public static collection = "posts";
+
+  /**
+   * Output
+   */
+  public static output = PostOutput;
+
+  /**
+   * Casts
+   */
+  protected casts: Casts = {
+    title: "string",
+    content: "string",
+  };
+}

package/templates/warlock/src/app/posts/output/post.output.ts

@@ -0,0 +1,13 @@
+import { type FinalOutput, Output } from "@warlock.js/core";
+
+export class PostOutput extends Output {
+  /**
+   * {@inheritdoc}
+   */
+  protected output: FinalOutput = {
+    id: "int",
+    title: "string",
+    content: "string",
+    createdAt: "date",
+  };
+}

package/templates/warlock/src/app/posts/routes.ts

@@ -0,0 +1,12 @@
+import { router } from "@warlock.js/core";
+import { guarded } from "../utils/router";
+import { createNewPostRequest } from "./controllers/create-new-post.request";
+import { getAllPostsRequest } from "./controllers/get-all-posts.request";
+import { getPostRequest } from "./controllers/get-post.request";
+
+router.get("/posts", getAllPostsRequest);
+router.get("/posts/:id", getPostRequest);
+
+guarded(() => {
+  router.post("/posts", createNewPostRequest);
+});

package/templates/warlock/src/app/uploads/routes.ts

@@ -1,27 +1,27 @@
-import {
-  deleteFile,
-  getUploadedFile,
-  getUploadedFileUsingHash,
-  router,
-  uploadChunkedFiles,
-  uploadFiles,
-} from "@warlock.js/core";
-import { adminPath, guarded } from "app/utils/router";
-
-guarded(() => {
-  // Upload files
-  router.post(["/uploads", adminPath("/uploads")], uploadFiles);
-  // Upload chunked files
-  router.post(
-    ["/uploads/chunks", adminPath("/uploads/chunks")],
-    uploadChunkedFiles,
-  );
-  // Delete file by hash from the database
-  router.delete(["/uploads/:hash", adminPath("/uploads/:hash")], deleteFile);
-});
-
-// Please note that the uploaded files should not be grouped in protected middleware i.e guarded with JWT
-// Get uploaded file using the file path directly
-router.get("/uploads/*", getUploadedFile);
-// Get uploaded file using hash
-router.get("/uploads/:hash", getUploadedFileUsingHash);
+import {
+  deleteFile,
+  getUploadedFile,
+  getUploadedFileUsingHash,
+  router,
+  uploadChunkedFiles,
+  uploadFiles,
+} from "@warlock.js/core";
+import { adminPath, guarded } from "app/utils/router";
+
+guarded(() => {
+  // Upload files
+  router.post(["/uploads", adminPath("/uploads")], uploadFiles);
+  // Upload chunked files
+  router.post(
+    ["/uploads/chunks", adminPath("/uploads/chunks")],
+    uploadChunkedFiles,
+  );
+  // Delete file by hash from the database
+  router.delete(["/uploads/:hash", adminPath("/uploads/:hash")], deleteFile);
+});
+
+// Please note that the uploaded files should not be grouped in protected middleware i.e guarded with JWT
+// Get uploaded file using the file path directly
+router.get("/uploads/*", getUploadedFile);
+// Get uploaded file using hash
+router.get("/uploads/:hash", getUploadedFileUsingHash);

package/templates/warlock/src/app/users/controllers/auth/admin-login.ts

@@ -1,40 +1,40 @@
-import type { Request, Response } from "@warlock.js/core";
-import { User } from "app/users/models/user";
-
-export default async function adminLogin(request: Request, response: Response) {
-  const user = request.user;
-
-  const auth = await user.generateAccessToken();
-
-  return response.success({
-    user: {
-      ...(await user.toJSON()),
-      accessToken: auth,
-      userType: user.userType,
-    },
-  });
-}
-
-adminLogin.validation = {
-  rules: {
-    password: ["required"],
-    email: ["required", "email"],
-  },
-  validate: async (request: Request, response: Response) => {
-    const user = await User.attempt(request.only(["email", "password"]));
-
-    if (!user) {
-      return response.badRequest({
-        error: "Invalid credentials",
-      });
-    }
-
-    if (!user.get("isActive")) {
-      return response.badRequest({
-        error: "Your account is suspended!",
-      });
-    }
-
-    request.user = user;
-  },
-};
+import type { Request, Response } from "@warlock.js/core";
+import { User } from "app/users/models/user";
+
+export default async function adminLogin(request: Request, response: Response) {
+  const user = request.user;
+
+  const auth = await user.generateAccessToken();
+
+  return response.success({
+    user: {
+      ...(await user.toJSON()),
+      accessToken: auth,
+      userType: user.userType,
+    },
+  });
+}
+
+adminLogin.validation = {
+  rules: {
+    password: ["required"],
+    email: ["required", "email"],
+  },
+  validate: async (request: Request, response: Response) => {
+    const user = await User.attempt(request.only(["email", "password"]));
+
+    if (!user) {
+      return response.badRequest({
+        error: "Invalid credentials",
+      });
+    }
+
+    if (!user.get("isActive")) {
+      return response.badRequest({
+        error: "Your account is suspended!",
+      });
+    }
+
+    request.user = user;
+  },
+};

package/templates/warlock/src/app/users/controllers/auth/login.request.ts

@@ -1,49 +1,28 @@
-import { t, type Request, type Response } from "@warlock.js/core";
-import { User } from "app/users/models/user";
-
-export default async function login(
-  request: Request<User>,
-  response: Response,
-) {
-  const user = request.user;
-
-  const auth = await user.generateAccessToken();
-
-  user.save({
-    lastLogin: new Date(),
-  });
-
-  return response.success({
-    user: {
-      ...(await user.toJSON()),
-      accessToken: auth,
-      userType: user.userType,
-    },
-  });
-}
-
-login.validation = {
-  rules: {
-    email: ["required", "email"],
-    password: ["required", "string"],
-  },
-  validate: async (request: Request, response: Response) => {
-    const user = await User.attempt(request.only(["email", "password"]));
-
-    if (!user) {
-      return response.badRequest({
-        error: t("auth.invalidCredentials"),
-      });
-    }
-
-    if (!user.isActive) {
-      // you can send the activation code again
-      // or just return a bad request with an error message
-      return response.forbidden({
-        error: t("auth.accountNotActivated"),
-      });
-    }
-
-    request.user = user;
-  },
-};
+import {
+  type Request,
+  type RequestHandler,
+  type Response,
+} from "@warlock.js/core";
+import { User } from "app/users/models/user";
+
+export const loginRequest: RequestHandler = async (
+  request: Request,
+  response: Response,
+) => {
+  const user = await User.attempt(request.only(["email", "password"]));
+
+  if (!user) {
+    return response.badRequest({
+      message: "Invalid credentials",
+    });
+  }
+
+  // generate a JWT token for the logged-in user
+  const token = await user.generateAccessToken();
+
+  return response.success({
+    message: "User logged in successfully",
+    user,
+    accessToken: token,
+  });
+};

package/templates/warlock/src/app/users/controllers/auth/logout.ts

@@ -1,10 +1,10 @@
-import type { Request, Response } from "@warlock.js/core";
-import type { User } from "app/users/models/user";
-
-export default function logout(request: Request<User>, response: Response) {
-  const user = request.user;
-
-  user.removeAccessToken(request.accessToken);
-
-  return response.success();
-}
+import type { Request, Response } from "@warlock.js/core";
+import type { User } from "app/users/models/user";
+
+export default function logout(request: Request<User>, response: Response) {
+  const user = request.user;
+
+  user.removeAccessToken(request.accessToken);
+
+  return response.success();
+}

package/templates/warlock/src/app/users/controllers/auth/register.request.ts

@@ -0,0 +1,24 @@
+import { Random } from "@mongez/reinforcements";
+import type { RequestHandler } from "@warlock.js/core";
+import { v, type Request, type Response } from "@warlock.js/core";
+import { User } from "app/users/models/user";
+
+export const registerRequest: RequestHandler = async (
+  request: Request,
+  response: Response,
+) => {
+  User.create({
+    ...request.validated(),
+    activationCode: Random.int(100000, 999999),
+  });
+
+  return response.success();
+};
+
+registerRequest.validation = {
+  schema: v.object({
+    name: v.string().minLength(2).required(),
+    email: v.string().email().required().unique(User),
+    password: v.string().minLength(8).required(),
+  }),
+};