swapnil.bendal/TypeScript-Backend-Template
Template
1
0
Fork 5
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add chnanges

Browse Source
This commit is contained in:
Swapnil Bendal
2024-12-10 20:57:52 +05:30
parent ca6d4551ca
commit ac7b46c661
16 changed files with 2064 additions and 3965 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
.gitattributes vendored Normal file
View File

@@ -0,0 +1,3 @@
# Convert text file line endings to lf
* text eol=lf
*.js text

1
.husky/pre-commit Normal file
View File

@@ -0,0 +1 @@
npm test

3
.prettierignore Normal file
View File

@@ -0,0 +1,3 @@
# Ignore artifacts:
build
coverage

10
.prettierrc Normal file
View File

@@ -0,0 +1,10 @@
{
"semi": true,
"singleQuote": true,
"tabWidth": 2,
"useTabs": true,
"trailingComma": "es5",
"bracketSpacing": true,
"bracketSameLine": true,
"endOfLine": "lf"
}

9
eslint.config.mjs Normal file
View File

@@ -0,0 +1,9 @@
// @ts-check
import eslint from '@eslint/js';
import tseslint from 'typescript-eslint';
export default tseslint.config(
eslint.configs.recommended,
tseslint.configs.recommended,
);

3360
package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

76
package.json
View File

@@ -1,31 +1,49 @@
{
"dependencies": {
"cross-env": "^7.0.3",
"dotenv": "^16.4.5",
"express": "^4.21.1",
"inversify": "^6.1.4",
"morgan": "^1.10.0",
"mysql": "^2.14.1",
"reflect-metadata": "^0.1.13",
"request-ip": "^3.3.0",
"typeorm": "0.3.20",
"winston": "^3.17.0",
"yup": "^1.4.0"
},
"devDependencies": {
"@types/express": "^5.0.0",
"@types/morgan": "^1.9.9",
"@types/node": "^16.11.10",
"@types/request-ip": "^0.0.41",
"nodemon": "^3.1.7",
"ts-node": "10.9.2",
"ts-node-dev": "^2.0.0",
"typescript": "4.5.2"
},
"scripts": {
"dev": "cross-env NODE_ENV=development nodemon src/index.ts",
"start": "ts-node src/index.ts",
"build": "tsc",
"typeorm": "cross-env NODE_ENV=development typeorm-ts-node-commonjs"
}
"name": "tanami-backend",
"version": "v1.0.0",
"main": "src/index.ts",
"author": "Swapnil Bendal",
"license": "MIT",
"scripts": {
"dev": "cross-env NODE_ENV=development nodemon src/index.ts",
"start": "ts-node src/index.ts",
"typeorm": "cross-env NODE_ENV=development typeorm-ts-node-commonjs",
"build": "tsc",
"lint": "eslint .",
"lint:fix": "eslint . --fix",
"prettier": "prettier --check **/*.js",
"prettier:fix": "prettier --write **/*.js",
"prepare": "husky"
},
"dependencies": {
"cross-env": "^7.0.3",
"dotenv": "^16.4.5",
"express": "^4.21.1",
"inversify": "^6.1.4",
"morgan": "^1.10.0",
"mysql": "^2.14.1",
"reflect-metadata": "^0.1.13",
"request-ip": "^3.3.0",
"typeorm": "0.3.20",
"winston": "^3.17.0",
"yup": "^1.4.0"
},
"devDependencies": {
"@eslint/js": "^9.16.0",
"@types/express": "^5.0.0",
"@types/morgan": "^1.9.9",
"@types/node": "^16.11.10",
"@types/request-ip": "^0.0.41",
"@typescript-eslint/eslint-plugin": "^5.0.0",
"@typescript-eslint/parser": "^5.0.0",
"eslint": "^9.16.0",
"eslint-plugin-import": "^2.31.0",
"globals": "^15.13.0",
"husky": "^9.1.7",
"nodemon": "^3.1.7",
"ts-node": "10.9.2",
"ts-node-dev": "^2.0.0",
"typescript": "^5.7.2",
"typescript-eslint": "^8.18.0"
}
}

1
src/app.ts
View File

@@ -4,7 +4,6 @@ import config from "./config/config";
import morgan from "./config/morgan";
import path from 'path';
import logger from './config/logger';
import productRouter from "./routes/productRoutes";
import ApiError from './utils/helper/ApiError';
import error from './middleware/error';
import routes from './routes';

2
src/config/config.ts
View File

@@ -72,7 +72,7 @@ function getConfig() {
},
};
} catch (error: any) {
} catch (error: unknown) {
if (error instanceof yup.ValidationError) {
console.error("Validation Errors:", error.errors.join(", "));
} else {

10
src/controllers/productController.ts
View File

@@ -1,4 +1,4 @@
import { NextFunction, Request, Response } from 'express';
import { Request, Response } from 'express';
import { IProductInteractor } from '../interfaces/IProductInteractor';
import ApiResponse from '../utils/helper/ApiResponse';
import { AsyncHandler } from '../utils/handler/async.handler';
@@ -11,16 +11,16 @@ export class ProductController {
}
@AsyncHandler()
async onCreateProduct(req: Request, res: Response, next: NextFunction) {
async onCreateProduct(req: Request, res: Response) {
const data = await this.interactor.createProduct(req.body);
res.status(201).json(new ApiResponse(201, data, 'Successfully created'));
}
@AsyncHandler()
async onGetProducts(req: Request, res: Response, next: NextFunction) {
async onGetProducts(req: Request, res: Response) {
const offset = Number.isInteger(Number(req.query.offset)) ? parseInt(`${req.query.offset}`, 10) : 0;
const limit = Number.isInteger(Number(req.query.limit)) ? parseInt(`(${req.query.limit}`, 10) : 10;
const data = await this.interactor.getProducts(limit, offset);
if (data.length === 0) {
@@ -32,7 +32,7 @@ export class ProductController {
}
@AsyncHandler()
async onUpdateStock(req: Request, res: Response, next: NextFunction) {
async onUpdateStock(req: Request, res: Response) {
const data = await this.interactor.updateStock(parseInt(`${req.params.id}`, 10), parseInt(`${req.body.stock}`, 10));
res.status(200).json(new ApiResponse(200, data, 'Successfully updated'));
}

2
src/interactors/productInteractor.ts
View File

@@ -10,7 +10,7 @@ export class ProductInteractor implements IProductInteractor {
this.repository = respository
}
async createProduct(input: any): Promise<Product> {
async createProduct(input: never): Promise<Product> {
return await this.repository.create(input)
}
async updateStock(id: number, stock: number): Promise<Product> {

2
src/interfaces/IProductInteractor.ts
View File

@@ -1,7 +1,7 @@
import { Product } from "../entities/Product";
export interface IProductInteractor {
createProduct(input: any): Promise<Product>;
createProduct(input: never): Promise<Product>;
updateStock(id: number, stock: number): Promise<Product>;
getProducts(limit: number, offset: number): Promise<Product[]>;
}

38
src/middleware/error.ts
View File

@@ -5,40 +5,42 @@ import logger from '../config/logger';
class error {
static errorConverter(
err: any,
err: ApiError,
req: Request,
res: Response,
next: NextFunction
): void {
let error = err;
// Define a broader type for error
let error: ApiError | Error & { statusCode?: number; errors?: Error[] } = err;
// Handle Sequelize validation and unique constraint errors
const messages = error.errors.map((e: Error) => e.message);
error = new ApiError(
400,
messages.join(', '),
messages,
true,
err.stack
);
if (error.errors && Array.isArray(error.errors)) {
const messages = error.errors.map((e: Error) => e.message);
error = new ApiError(
400,
messages.join(', '),
messages,
true,
err.stack
);
}
if (!(error instanceof ApiError)) {
// Handle other errors
const statusCode =
error.statusCode
? 400
: 500;
const statusCode = error.statusCode || 500;
const message = error.message || "Something went wrong";
error = new ApiError(statusCode, message, error, false, err.stack);
error = new ApiError(statusCode, message, [], false, err.stack);
}
next(error);
}
static errorHandler(
err: any,
err: ApiError,
req: Request,
res: Response,
next: NextFunction
res: Response
): void {
let { statusCode, message } = err;

11
src/middleware/validate.ts
View File

@@ -1,7 +1,7 @@
import { pick } from '../utils/handler/pick.handler';
import { Request, Response, NextFunction } from 'express';
import * as Yup from 'yup';
import { ObjectSchema, ValidationError } from 'yup';
import ApiError from '../utils/helper/ApiError';
import { pick } from '../utils/handler/pick.handler';
/**
* Validation middleware for Express routes.
@@ -9,7 +9,7 @@ import ApiError from '../utils/helper/ApiError';
* @returns Middleware function to validate request properties.
*/
const validate =
(schema: Partial<Record<keyof Request, Yup.ObjectSchema<any>>>) =>
(schema: Partial<Record<keyof Request, ObjectSchema<never>>>) =>
(req: Request, res: Response, next: NextFunction): void => {
// Define valid request keys explicitly
const validRequestKeys = ['params', 'query', 'body', 'file', 'files'] as (keyof Request)[];
@@ -31,11 +31,12 @@ const validate =
// Assign validated values back to the request object
validatedValues.forEach((value, index) => {
const key = Object.keys(validSchema)[index];
(req as any)[key] = value; // Type assertion since req is mutable
// Safely assign the validated value to the request object
req[key as keyof Request] = value; // Use `Request` here instead of `Request.ResBody`
});
next();
})
.catch((err: Yup.ValidationError) => {
.catch((err: ValidationError) => {
// Collect and format error messages
const errorMessage = err.inner.map((detail) => detail.message).join(', ');
next(new ApiError(400, errorMessage));

160
tsconfig.json
View File

@@ -1,114 +1,48 @@
{
"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": "es6", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
"lib": [
"es5",
"es6"
], /* 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": "node", /* 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. */
// "rewriteRelativeImportExtensions": true, /* Rewrite '.ts', '.tsx', '.mts', and '.cts' file extensions in relative import paths to their JavaScript equivalent in output files. */
// "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. */
// "noUncheckedSideEffectImports": true, /* Check side effect 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. */
// "noEmit": true, /* Disable emitting files from a compilation. */
// "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. */
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
// "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. */
/* 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. */
// "isolatedDeclarations": true, /* Require sufficient annotation on exports so other tools can trivially generate declaration files. */
// "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. */
// "strictBuiltinIteratorReturn": true, /* Built-in iterators are instantiated with a 'TReturn' type of 'undefined' instead of 'any'. */
// "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. */
},
}
"compilerOptions": {
/* Language and Environment */
"target": "es2016", /* Set the JavaScript language version for emitted JavaScript */
"experimentalDecorators": true, /* Enable experimental support for legacy decorators */
"emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations */
/* Modules */
"module": "commonjs", /* Specify the module system to use */
"esModuleInterop": true, /* Enable interop with CommonJS modules */
"forceConsistentCasingInFileNames": true, /* Ensure that file names are case-sensitive */
/* Type Checking */
"strict": true, /* Enable all strict type-checking options */
"skipLibCheck": true, /* Skip type checking of declaration files */
/* Emit */
"sourceMap": true, /* Create source map files for emitted JavaScript */
"declaration": true, /* Generate .d.ts files from TypeScript */
"outDir": "./dist", /* Specify an output folder for emitted files */
"removeComments": true, /* Disable emitting comments in output */
/* Interop Constraints */
"allowSyntheticDefaultImports": true, /* Allow default imports from modules without default exports */
"resolveJsonModule": true, /* Allow importing JSON files */
/* Optional Features */
"lib": ["es2016", "dom"], /* Specify the set of library files to include */
"moduleResolution": "node", /* Specify module resolution strategy (Node.js style) */
/* JavaScript Support */
"allowJs": true, /* Allow JavaScript files to be part of the project */
/* Paths and Base URL */
"baseUrl": "./", /* Set the base directory to resolve non-relative module names */
"paths": { /* Provide paths mapping for module resolution */
"*": ["node_modules/*", "src/types/*"]
}
},
"include": [
"src/**/*.ts" /* Specify the source directory */
],
"exclude": [
"node_modules", /* Exclude node_modules from being compiled */
"dist" /* Exclude dist folder to avoid compilation of output files */
]
}

2341
yarn.lock
View File

File diff suppressed because it is too large Load Diff