Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feature/KAYA-59-Update-enforcer-middlewares-with-new-type-converter #15

Merged
merged 1 commit into from
Feb 17, 2024
Merged

feature/KAYA-59-Update-enforcer-middlewares-with-new-type-converter #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 4 additions & 7 deletions auth-server/src/middlewares/require-body.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,10 @@ import { RequestHandler, Router } from 'express';
import httpErrors from 'http-errors';

type ExpectedObject = Record<string, any>;
type BodyEnforcer<O extends ExpectedObject = {}> = RequestHandler<any, any, O>;
type EnforcedBody<T extends ExpectedObject, K extends keyof T> = Partial<T> & Required<Pick<T, K>>;
type BodyEnforcer<T extends ExpectedObject, K extends keyof T> = RequestHandler<any, any, EnforcedBody<T, K>>;

export default function <O extends ExpectedObject>(
...keys: Array<keyof O>
): BodyEnforcer<O> {
export default function <T extends ExpectedObject, K extends keyof T>(...keys: Array<K>): BodyEnforcer<T, K> {
return (request, _response, next) => {
try {
if (!request.body) {
Expand All @@ -20,9 +19,7 @@ export default function <O extends ExpectedObject>(
)
);
if (missingKeys.length) {
const terminationPhrase = `propert${
missingKeys.length > 1 ? 'ies' : 'y'
}`;
const terminationPhrase = `propert${missingKeys.length > 1 ? 'ies' : 'y'}`;
throw httpErrors.BadRequest(`Request body is missing ${terminationPhrase}: ${missingKeys.join()} `);
}
next();
Expand Down
9 changes: 5 additions & 4 deletions auth-server/src/routers/auth-router.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,10 @@ import { Http } from "../config/environment.js";
const authRouter = Router();

type TokenGenReqBody = Record<"username" | "password", string>;

authRouter.post(
"/auth/token",
requireBody<TokenGenReqBody>("username", "password"),
requireBody<TokenGenReqBody, "username" | "password">("username", "password"),
async (req, res, next) => {
try {
const { username, password } = req.body;
Expand All @@ -24,12 +25,12 @@ authRouter.post(
email: username
}
});

if (!user) {
throw httpErrors.NotFound("User not found");
}

if ((await compare(password, user.password)) === false) {
if (await compare(password, user.password) === false) {
throw httpErrors.Unauthorized("Invalid credentials");
}

Expand Down Expand Up @@ -57,7 +58,7 @@ authRouter.get(
"/auth/verify",
requireHeaders("Cookie"),
requireAccessToken(),
async (req, res, next) => {
async (_req, res, next) => {
try {
if (Http.responseVerifyTokenCacheEnable) {
res.append("Cache-Control", `public, max-age=${Http.responseVerifyTokenCacheMaxAge}`);
Expand Down
8 changes: 5 additions & 3 deletions auth-server/src/routers/user-router.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,11 @@ interface CreateUserBody {
readonly roles: string[];
}

type RequiredKeys = "firstName" | "lastName" | "email" | "password" | "roles";

userRouter.post(
'/users/register',
requireBody<CreateUserBody>('firstName', 'lastName', 'email', 'password'),
requireBody<CreateUserBody, RequiredKeys>("firstName", "lastName", "email", "password", "roles"),
async (req, res, next) => {
try {
const { firstName, middleName, lastName, email, password, roles } = req.body;
Expand Down Expand Up @@ -53,12 +55,12 @@ userRouter.post(
password: passwordHash,
UserRoles: {
createMany: {
data: matchedRoles.map((role) => ({ roleId: role.id }))
data: matchedRoles.map((role) => ({ roleId: role.id }))
}
}
}
})
.then(({ password, ...rest }) => rest);
.then(({ password, ...rest }) => rest);

res.status(httpStatus.CREATED).json(newUser);
} catch (error) {
Expand Down
47 changes: 20 additions & 27 deletions auth-server/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
{
"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": "es2016", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
"lib": ["ES2015"], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
"target": "ES5", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
"lib": [
"ESNext"
], /* 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. */
Expand All @@ -23,11 +23,10 @@
// "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": "ESNext", /* Specify what module code is generated. */
"rootDir": "src", /* Specify the root folder within your source files. */
"moduleResolution": "Node10", /* Specify how TypeScript looks up a file from a given module specifier. */
"module": "Node16", /* Specify what module code is generated. */
"rootDir": "src", /* Specify the root folder within your source files. */
"moduleResolution": "Node16", /* 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. */
Expand All @@ -42,21 +41,19 @@
// "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": "dist", /* Specify an output folder for all emitted files. */
"removeComments": true, /* Disable emitting comments. */
"outDir": "dist", /* 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. */
Expand All @@ -72,17 +69,15 @@
// "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. */
"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. */
"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. */

"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
/* Type Checking */
"strict": true, /* Enable all strict type-checking options. */
"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. */
Expand All @@ -95,19 +90,17 @@
// "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. */
"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. */
"skipLibCheck": true /* Skip type checking all .d.ts files. */
},
"ts-node": {
"esm": true,
"experimentalSpecifierResolution": "node"
}
}
"include": [
"src"
]
}