init project

package.json

@@ -0,0 +1,35 @@
+{
+  "name": "customer-dashboard-api",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "build": "npx tsc",
+    "start": "node build/server.js",
+    "dev": "concurrently \"npx tsc --watch\" \"nodemon -q build/server.js | pino-pretty\""
+  },
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "bcrypt": "^5.1.1",
+    "body-parser": "^1.20.2",
+    "concurrently": "^8.2.2",
+    "dotenv": "^16.3.1",
+    "express": "^4.18.2",
+    "mariadb": "^3.2.3",
+    "pino": "^8.17.2",
+    "pino-pretty": "^10.3.1",
+    "sequelize": "^6.35.2",
+    "swagger-jsdoc": "^6.2.8",
+    "swagger-ui-express": "^5.0.0",
+    "uuid": "^9.0.1"
+  },
+  "devDependencies": {
+    "@types/bcrypt": "^5.0.2",
+    "@types/express": "^4.17.21",
+    "@types/swagger-jsdoc": "^6.0.4",
+    "@types/swagger-ui-express": "^4.1.6",
+    "@types/uuid": "^9.0.7",
+    "typescript": "^5.3.3"
+  }
+}

server.ts

@@ -0,0 +1,64 @@
+import express, { Express } from "express";
+import dotenv from "dotenv";
+import bodyParser from "body-parser";
+import swaggerUI from "swagger-ui-express";
+
+import userRoutes from "./src/routes/userRoutes";
+
+dotenv.config();
+
+import swaggerJsDoc from "swagger-jsdoc";
+import syncModels from "./src/models/index";
+import logger from "./src/logger/logger";
+const app: Express = express();
+const host = process.env.HOST || "localhost";
+const port = Number(process.env.PORT) || 3000;
+
+const options = {
+  definition: {
+    openapi: "3.0.0",
+    info: {
+      title: "PartyApp API",
+      version: "1.0.0",
+      //description: "PartyApp API",
+      //termsOfService: "http://example.com/terms/",
+      /*contact: {
+        name: "API Support",
+        url: "http://www.exmaple.com/support",
+        email: "support@example.com",
+      },*/
+    },
+
+    servers: [
+      {
+        url: "http://localhost:3000/api/v1",
+        //description: "PartyApp API Documentation",
+      },
+    ],
+  },
+  apis: ["./src/routes/*.ts"],
+};
+
+app.use(bodyParser.json());
+app.use("/api/v1/user", userRoutes);
+
+const specs = swaggerJsDoc(options);
+app.use("/api-docs", swaggerUI.serve, swaggerUI.setup(specs));
+
+app.use((req, res, next) => {
+  console.log("req not found, path:", req.path);
+  res.status(404).send("not found");
+});
+
+app.use((err: any, req: any, res: any, next: any) => {
+  console.log("req err", err.stack);
+  res.status(500).send({ err: "invalid request" });
+});
+
+syncModels();
+
+app.listen(port, host, () => {
+  //console.log(`⚡️[server]: Server is running at http://${host}:${port}`);
+
+  logger.info(`⚡️[server]: Server is running at http://${host}:${port}`);
+});

src/controllers/userController.ts

@@ -0,0 +1,72 @@
+import { Request, Response } from "express";
+import logger from "../logger/logger";
+import User from "../models/user";
+import { isPasswordValid, isUsernameValid } from "../validator/validator";
+import { Roles } from "../utils/constants";
+import {
+  decodeBase64,
+  hashPassword,
+  newUserId,
+  saveSession,
+} from "../utils/utils";
+
+export async function SignUp(req: Request, res: Response) {
+  try {
+    const { username, password } = req.body;
+
+    // validate request
+
+    if (!username || !password) {
+      return res.status(400).send({ err: "invalid request" });
+    }
+
+    if (!isUsernameValid(username)) {
+      return res.status(400).send({ err: "invalid request" });
+    }
+
+    // check if user already exists
+
+    const existingUser = await User.findOne({
+      where: {
+        username: username,
+      },
+    });
+
+    if (existingUser) {
+      logger.debug("User already exists with this username: %s", username);
+      return res.status(400).send({ err: "invalid request" });
+    }
+
+    // decode password
+
+    const decodedPassword = decodeBase64(password);
+
+    if (!isPasswordValid(decodedPassword)) {
+      logger.debug("Password is not valid");
+      return res.status(400).send({ err: "invalid request" });
+    }
+
+    const hashedPassword = await hashPassword(decodedPassword);
+
+    // create user
+
+    await User.create({
+      user_id: newUserId(),
+      role: Roles.Master,
+      username: username,
+      password: hashedPassword,
+    })
+      .then((user) => {
+        logger.debug("User created with username: %s", user.username);
+
+        saveSession(res, user.user_id, user.username);
+      })
+      .catch((err) => {
+        logger.error(err);
+        res.status(500).send({ err: "invalid request" });
+      });
+  } catch (error) {
+    logger.error(error);
+    res.status(500).send({ err: "invalid request" });
+  }
+}

src/database/database.ts

@@ -0,0 +1,60 @@
+import { Sequelize } from "sequelize";
+import logger from "../logger/logger";
+import dotenv from "dotenv";
+
+dotenv.config();
+
+const sequelize = new Sequelize(
+  process.env.MARIADB_DATABASE as string,
+  process.env.MARIADB_USER as string,
+  process.env.MARIADB_PASSWORD as string,
+  {
+    host: process.env.MARIADB_HOST as string,
+    port: Number(process.env.MARIADB_PORT),
+    dialect: "mariadb",
+    logging: false,
+  }
+);
+
+sequelize
+  .authenticate()
+  .then(() => {
+    logger.info("⚡️[DB]: Connection has been established successfully.");
+  })
+  .catch((err: Error) => {
+    console.error("⚡️[DB]: Unable to connect to the database:", err);
+  });
+
+export default sequelize;
+
+/*
+export let sequelize: Sequelize;
+
+export function initDatabase() {
+  sequelize = new Sequelize(
+    process.env.MARIADB_DATABASE as string,
+    process.env.MARIADB_USER as string,
+    process.env.MARIADB_PASSWORD as string,
+    {
+      host: process.env.MARIADB_HOST as string,
+      port: Number(process.env.MARIADB_PORT),
+      dialect: "mariadb",
+    }
+  );
+
+  sequelize
+    .authenticate()
+    .then(() => {
+      logger.info("Connection has been established successfully.");
+    })
+    .catch((err: Error) => {
+      console.error("Unable to connect to the database:", err);
+    });
+}
+
+export function syncDatabase() {
+  sequelize.sync({ force: true }).then(() => {
+    console.log(`Database & tables created!`);
+  });
+}
+ */

src/logger/logger.ts

@@ -0,0 +1,5 @@
+import pino from "pino";
+
+const logger = pino({ level: "debug" });
+
+export default logger;

src/models/index.ts

@@ -0,0 +1,9 @@
+import Session from "./session";
+import User from "./user";
+
+function syncModels() {
+  User.sync({ alter: true });
+  Session.sync({ alter: true });
+}
+
+export default syncModels;

src/models/session.ts

@@ -0,0 +1,39 @@
+import { DataTypes, Model } from "sequelize";
+import sequelize from "../database/database";
+
+interface SessionAttributes {
+  session_id: string;
+  user_id: string;
+  expires: Date;
+}
+
+class Session extends Model<SessionAttributes> implements SessionAttributes {
+  declare session_id: string;
+  declare user_id: string;
+  declare expires: Date;
+}
+
+Session.init(
+  {
+    // Model attributes are defined here
+    session_id: {
+      primaryKey: true,
+      type: DataTypes.STRING,
+      allowNull: false,
+    },
+    user_id: {
+      type: DataTypes.STRING,
+      allowNull: false,
+    },
+    expires: {
+      type: DataTypes.DATE,
+      allowNull: false,
+    },
+  },
+  {
+    tableName: "sessions",
+    sequelize, // passing the `sequelize` instance is required
+  }
+);
+
+export default Session;

src/models/user.ts

@@ -0,0 +1,57 @@
+import { DataTypes, Model } from "sequelize";
+import sequelize from "../database/database";
+
+interface UserAttributes {
+  user_id: string;
+  master_user_id?: string;
+  role: string;
+  username: string;
+  password: string;
+  calendar_settings?: string;
+}
+
+class User extends Model<UserAttributes> implements UserAttributes {
+  declare user_id: string;
+  declare master_user_id: string;
+  declare role: string;
+  declare username: string;
+  declare password: string;
+  declare calendar_settings: string;
+}
+
+User.init(
+  {
+    // Model attributes are defined here
+    user_id: {
+      primaryKey: true,
+      type: DataTypes.STRING,
+      allowNull: false,
+    },
+    master_user_id: {
+      type: DataTypes.STRING,
+      // allowNull defaults to true
+    },
+    role: {
+      type: DataTypes.STRING,
+      // allowNull defaults to true
+    },
+    username: {
+      type: DataTypes.STRING,
+      allowNull: false,
+    },
+    password: {
+      type: DataTypes.STRING,
+      allowNull: false,
+    },
+    calendar_settings: {
+      type: DataTypes.STRING,
+      // allowNull defaults to true
+    },
+  },
+  {
+    tableName: "users",
+    sequelize, // passing the `sequelize` instance is required
+  }
+);
+
+export default User;

src/routes/userRoutes.ts

@@ -0,0 +1,8 @@
+import express from "express";
+const router = express.Router();
+
+import * as userController from "../controllers/userController";
+
+router.post("/signup", userController.SignUp);
+
+export default router;

src/utils/constants.ts

@@ -0,0 +1,16 @@
+export const DEFAULT_SESSION_EXPIRY = 365 * 24 * 60 * 60 * 1000; // 365 days
+
+export const USERNAME_MIN_LENGTH = 3;
+export const USERNAME_MAX_LENGTH = 20;
+
+export const PASSWORD_MIN_LENGTH = 8;
+export const PASSWORD_MAX_LENGTH = 64;
+
+export const Roles = {
+  // admin of the whole system independent of stores
+  Admin: "admin",
+  // owner of a store
+  Master: "master",
+  // worker of a store belonging to a master
+  Worker: "worker",
+};

src/utils/utils.ts

@@ -0,0 +1,50 @@
+import crypto from "crypto";
+import bcrypt from "bcrypt";
+import { v4 as uuidv4 } from "uuid";
+import { Response } from "express";
+import Session from "../models/session";
+import { DEFAULT_SESSION_EXPIRY } from "./constants";
+
+export async function matchPassword(decodedPassword: string, password: string) {
+  return await bcrypt.compare(decodedPassword, password);
+}
+
+export async function hashPassword(password: string) {
+  return await bcrypt.hash(password, 10);
+}
+
+export function decodeBase64(value: string) {
+  return Buffer.from(value, "base64").toString("utf-8");
+}
+
+export function newUserId() {
+  return uuidv4();
+}
+
+export function newUserSession() {
+  return crypto.randomBytes(32).toString("hex");
+}
+
+export async function saveSession(
+  res: Response,
+  userId: string,
+  username: string
+) {
+  try {
+    const userSession = newUserSession();
+
+    await Session.create({
+      user_id: userId,
+      session_id: userSession,
+      expires: new Date(Date.now() + DEFAULT_SESSION_EXPIRY),
+    });
+
+    res.status(200).json({
+      XAuthorization: userSession,
+      Username: username,
+    });
+  } catch (err) {
+    console.log(err);
+    res.status(500).send({ err: "invalid request" });
+  }
+}

src/validator/validator.ts

@@ -0,0 +1,22 @@
+import {
+  USERNAME_MIN_LENGTH,
+  USERNAME_MAX_LENGTH,
+  PASSWORD_MIN_LENGTH,
+  PASSWORD_MAX_LENGTH,
+} from "../utils/constants";
+
+// TODO: regex for username
+export function isUsernameValid(username: string) {
+  return (
+    username.length >= USERNAME_MIN_LENGTH &&
+    username.length <= USERNAME_MAX_LENGTH
+  );
+}
+
+// TODO: regex for password
+export function isPasswordValid(password: string) {
+  return (
+    password.length >= PASSWORD_MIN_LENGTH &&
+    password.length <= PASSWORD_MAX_LENGTH
+  );
+}

start.sh

@@ -0,0 +1,2 @@
+screen -dmS customer-dashboard-api | exit 0
+screen -S customer-dashboard-api -p 0 -X stuff 'npm run dev\n'

tsconfig.json

@@ -0,0 +1,109 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "ESNext" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    "module": "commonjs" /* Specify what module code is generated. */,
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    // "moduleResolution": "node10",                     /* Specify how TypeScript looks up a file from a given module specifier. */
+    "baseUrl": "./" /* Specify the base directory to resolve non-relative module names. */,
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
+    // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */
+    // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */
+    // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+    /* Emit */
+    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+    "outDir": "./build" /* Specify an output folder for all emitted files. */,
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
+
+    /* Type Checking */
+    "strict": true /* Enable all strict type-checking options. */,
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true /* Skip type checking all .d.ts files. */
+  }
+}