@shadimakhoul/ggcoach 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/config/config.ts +7 -0
- package/config/index.ts +2 -0
- package/config/initExpress.ts +27 -0
- package/config/redis.ts +38 -0
- package/config/swagger-ui.ts +84 -0
- package/config/swagger.ts +4417 -0
- package/dist/config/config.d.ts +8 -0
- package/dist/config/config.d.ts.map +1 -0
- package/dist/config/config.js +11 -0
- package/dist/config/config.js.map +1 -0
- package/dist/config/index.d.ts +3 -0
- package/dist/config/index.d.ts.map +1 -0
- package/dist/config/index.js +19 -0
- package/dist/config/index.js.map +1 -0
- package/dist/config/initExpress.d.ts +2 -0
- package/dist/config/initExpress.d.ts.map +1 -0
- package/dist/config/initExpress.js +29 -0
- package/dist/config/initExpress.js.map +1 -0
- package/dist/config/redis.d.ts +6 -0
- package/dist/config/redis.d.ts.map +1 -0
- package/dist/config/redis.js +34 -0
- package/dist/config/redis.js.map +1 -0
- package/dist/config/swagger-ui.d.ts +6 -0
- package/dist/config/swagger-ui.d.ts.map +1 -0
- package/dist/config/swagger-ui.js +88 -0
- package/dist/config/swagger-ui.js.map +1 -0
- package/dist/config/swagger.d.ts +9 -0
- package/dist/config/swagger.d.ts.map +1 -0
- package/dist/config/swagger.js +4406 -0
- package/dist/config/swagger.js.map +1 -0
- package/dist/index.d.ts +5 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +21 -0
- package/dist/index.js.map +1 -0
- package/dist/middleware/admin-auth.d.ts +4 -0
- package/dist/middleware/admin-auth.d.ts.map +1 -0
- package/dist/middleware/admin-auth.js +55 -0
- package/dist/middleware/admin-auth.js.map +1 -0
- package/dist/middleware/auth.d.ts +4 -0
- package/dist/middleware/auth.d.ts.map +1 -0
- package/dist/middleware/auth.js +86 -0
- package/dist/middleware/auth.js.map +1 -0
- package/dist/middleware/cors.d.ts +16 -0
- package/dist/middleware/cors.d.ts.map +1 -0
- package/dist/middleware/cors.js +45 -0
- package/dist/middleware/cors.js.map +1 -0
- package/dist/middleware/errorHandler.d.ts +3 -0
- package/dist/middleware/errorHandler.d.ts.map +1 -0
- package/dist/middleware/errorHandler.js +58 -0
- package/dist/middleware/errorHandler.js.map +1 -0
- package/dist/middleware/index.d.ts +9 -0
- package/dist/middleware/index.d.ts.map +1 -0
- package/dist/middleware/index.js +25 -0
- package/dist/middleware/index.js.map +1 -0
- package/dist/middleware/internalAuth.d.ts +4 -0
- package/dist/middleware/internalAuth.d.ts.map +1 -0
- package/dist/middleware/internalAuth.js +23 -0
- package/dist/middleware/internalAuth.js.map +1 -0
- package/dist/middleware/rateLimiter.d.ts +4 -0
- package/dist/middleware/rateLimiter.d.ts.map +1 -0
- package/dist/middleware/rateLimiter.js +24 -0
- package/dist/middleware/rateLimiter.js.map +1 -0
- package/dist/middleware/swagger.d.ts +16 -0
- package/dist/middleware/swagger.d.ts.map +1 -0
- package/dist/middleware/swagger.js +49 -0
- package/dist/middleware/swagger.js.map +1 -0
- package/dist/middleware/validation.d.ts +4 -0
- package/dist/middleware/validation.d.ts.map +1 -0
- package/dist/middleware/validation.js +24 -0
- package/dist/middleware/validation.js.map +1 -0
- package/dist/types/admin-auth.d.ts +44 -0
- package/dist/types/admin-auth.d.ts.map +1 -0
- package/dist/types/admin-auth.js +3 -0
- package/dist/types/admin-auth.js.map +1 -0
- package/dist/types/auth.d.ts +53 -0
- package/dist/types/auth.d.ts.map +1 -0
- package/dist/types/auth.js +3 -0
- package/dist/types/auth.js.map +1 -0
- package/dist/types/enums/auth.d.ts +7 -0
- package/dist/types/enums/auth.d.ts.map +1 -0
- package/dist/types/enums/auth.js +11 -0
- package/dist/types/enums/auth.js.map +1 -0
- package/dist/types/enums/index.d.ts +2 -0
- package/dist/types/enums/index.d.ts.map +1 -0
- package/dist/types/enums/index.js +18 -0
- package/dist/types/enums/index.js.map +1 -0
- package/dist/types/index.d.ts +4 -0
- package/dist/types/index.d.ts.map +1 -0
- package/dist/types/index.js +20 -0
- package/dist/types/index.js.map +1 -0
- package/dist/utils/index.d.ts +4 -0
- package/dist/utils/index.d.ts.map +1 -0
- package/dist/utils/index.js +20 -0
- package/dist/utils/index.js.map +1 -0
- package/dist/utils/jwt.d.ts +5 -0
- package/dist/utils/jwt.d.ts.map +1 -0
- package/dist/utils/jwt.js +67 -0
- package/dist/utils/jwt.js.map +1 -0
- package/dist/utils/logger.d.ts +6 -0
- package/dist/utils/logger.d.ts.map +1 -0
- package/dist/utils/logger.js +69 -0
- package/dist/utils/logger.js.map +1 -0
- package/dist/utils/openapi.d.ts +9 -0
- package/dist/utils/openapi.d.ts.map +1 -0
- package/dist/utils/openapi.js +90 -0
- package/dist/utils/openapi.js.map +1 -0
- package/dist/utils/validation.d.ts +12 -0
- package/dist/utils/validation.d.ts.map +1 -0
- package/dist/utils/validation.js +108 -0
- package/dist/utils/validation.js.map +1 -0
- package/index.ts +4 -0
- package/logs/combined.log +85182 -0
- package/logs/error.log +48814 -0
- package/middleware/admin-auth.ts +93 -0
- package/middleware/auth.ts +100 -0
- package/middleware/cors.ts +48 -0
- package/middleware/errorHandler.ts +62 -0
- package/middleware/index.ts +8 -0
- package/middleware/internalAuth.ts +25 -0
- package/middleware/rateLimiter.ts +18 -0
- package/middleware/swagger.ts +69 -0
- package/middleware/validation.ts +24 -0
- package/package.json +43 -0
- package/public/swagger.css +114 -0
- package/tsconfig.json +10 -0
- package/types/admin-auth.ts +47 -0
- package/types/auth.ts +66 -0
- package/types/enums/auth.ts +6 -0
- package/types/enums/index.ts +1 -0
- package/types/index.ts +3 -0
- package/utils/index.ts +3 -0
- package/utils/jwt.ts +66 -0
- package/utils/logger.ts +90 -0
- package/utils/openapi.ts +125 -0
package/types/auth.ts
ADDED
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
import { AccountType } from "./enums";
|
|
2
|
+
|
|
3
|
+
export interface JWTPayload {
|
|
4
|
+
id: number;
|
|
5
|
+
email: string;
|
|
6
|
+
phoneNumber: string | null;
|
|
7
|
+
firstName: string;
|
|
8
|
+
lastName: string;
|
|
9
|
+
accountType: string;
|
|
10
|
+
is_active: boolean;
|
|
11
|
+
emailVerified: boolean;
|
|
12
|
+
phoneVerified: boolean;
|
|
13
|
+
tokenVersion?: number;
|
|
14
|
+
tokenType?: 'access' | 'refresh';
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
export interface UserAttributes {
|
|
18
|
+
id: number;
|
|
19
|
+
firstName: string;
|
|
20
|
+
lastName: string;
|
|
21
|
+
email: string;
|
|
22
|
+
phoneNumber: string | null;
|
|
23
|
+
password: string;
|
|
24
|
+
accountType: AccountType;
|
|
25
|
+
is_active: boolean;
|
|
26
|
+
emailVerified: boolean;
|
|
27
|
+
emailVerifiedAt?: Date | null;
|
|
28
|
+
phoneVerified: boolean;
|
|
29
|
+
phoneVerifiedAt?: Date | null;
|
|
30
|
+
tokenVersion?: number;
|
|
31
|
+
created_at?: Date;
|
|
32
|
+
updated_at?: Date;
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
declare global {
|
|
36
|
+
namespace Express {
|
|
37
|
+
interface Request {
|
|
38
|
+
user?: JWTPayload;
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
export interface UserCreationAttributes extends Omit<
|
|
44
|
+
UserAttributes,
|
|
45
|
+
| 'id'
|
|
46
|
+
| 'is_active'
|
|
47
|
+
| 'created_at'
|
|
48
|
+
| 'updated_at'
|
|
49
|
+
| 'emailVerified'
|
|
50
|
+
| 'emailVerifiedAt'
|
|
51
|
+
| 'phoneVerified'
|
|
52
|
+
| 'phoneVerifiedAt'
|
|
53
|
+
> {}
|
|
54
|
+
|
|
55
|
+
export interface AuthResponse {
|
|
56
|
+
success: boolean;
|
|
57
|
+
message: string;
|
|
58
|
+
data?: {
|
|
59
|
+
user: Omit<UserAttributes, 'password'>;
|
|
60
|
+
tokens: {
|
|
61
|
+
access_token: string;
|
|
62
|
+
refresh_token: string;
|
|
63
|
+
};
|
|
64
|
+
};
|
|
65
|
+
error?: string;
|
|
66
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from './auth';
|
package/types/index.ts
ADDED
package/utils/index.ts
ADDED
package/utils/jwt.ts
ADDED
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
import jwt from 'jsonwebtoken';
|
|
2
|
+
import { JWTPayload, UserAttributes } from '../types/auth';
|
|
3
|
+
|
|
4
|
+
const JWT_SECRET = process.env.JWT_SECRET || 'your-super-secret-jwt-key-change-in-production';
|
|
5
|
+
const JWT_EXPIRES_IN = process.env.JWT_EXPIRES_IN || '7d';
|
|
6
|
+
|
|
7
|
+
export const generateToken = (user: UserAttributes): string => {
|
|
8
|
+
const payload: JWTPayload = {
|
|
9
|
+
id: user.id,
|
|
10
|
+
email: user.email,
|
|
11
|
+
phoneNumber: user.phoneNumber,
|
|
12
|
+
firstName: user.firstName,
|
|
13
|
+
lastName: user.lastName,
|
|
14
|
+
accountType: user.accountType,
|
|
15
|
+
is_active: user.is_active,
|
|
16
|
+
emailVerified: user.emailVerified,
|
|
17
|
+
phoneVerified: user.phoneVerified,
|
|
18
|
+
tokenVersion: user.tokenVersion ?? 0,
|
|
19
|
+
tokenType: 'access',
|
|
20
|
+
};
|
|
21
|
+
|
|
22
|
+
const options: jwt.SignOptions = {
|
|
23
|
+
expiresIn: JWT_EXPIRES_IN,
|
|
24
|
+
issuer: 'ggcoach-auth-service',
|
|
25
|
+
audience: 'ggcoach-app'
|
|
26
|
+
} as jwt.SignOptions;
|
|
27
|
+
|
|
28
|
+
return jwt.sign(payload, JWT_SECRET, options);
|
|
29
|
+
};
|
|
30
|
+
|
|
31
|
+
export const verifyToken = (token: string): JWTPayload => {
|
|
32
|
+
try {
|
|
33
|
+
const decoded = jwt.verify(token, JWT_SECRET, {
|
|
34
|
+
issuer: 'ggcoach-auth-service',
|
|
35
|
+
audience: 'ggcoach-app'
|
|
36
|
+
}) as JWTPayload;
|
|
37
|
+
|
|
38
|
+
return decoded;
|
|
39
|
+
} catch (error) {
|
|
40
|
+
throw new Error('Invalid or expired token');
|
|
41
|
+
}
|
|
42
|
+
};
|
|
43
|
+
|
|
44
|
+
export const generateRefreshToken = (user: UserAttributes): string => {
|
|
45
|
+
const payload: JWTPayload = {
|
|
46
|
+
id: user.id,
|
|
47
|
+
email: user.email,
|
|
48
|
+
phoneNumber: user.phoneNumber,
|
|
49
|
+
firstName: user.firstName,
|
|
50
|
+
lastName: user.lastName,
|
|
51
|
+
accountType: user.accountType,
|
|
52
|
+
is_active: user.is_active,
|
|
53
|
+
emailVerified: user.emailVerified,
|
|
54
|
+
phoneVerified: user.phoneVerified,
|
|
55
|
+
tokenVersion: user.tokenVersion ?? 0,
|
|
56
|
+
tokenType: 'refresh',
|
|
57
|
+
};
|
|
58
|
+
|
|
59
|
+
const options: jwt.SignOptions = {
|
|
60
|
+
expiresIn: '30d',
|
|
61
|
+
issuer: 'ggcoach-auth-service',
|
|
62
|
+
audience: 'ggcoach-app'
|
|
63
|
+
} as jwt.SignOptions;
|
|
64
|
+
|
|
65
|
+
return jwt.sign(payload, JWT_SECRET, options);
|
|
66
|
+
};
|
package/utils/logger.ts
ADDED
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
import winston from 'winston';
|
|
2
|
+
import path from 'path';
|
|
3
|
+
import fs from 'fs';
|
|
4
|
+
|
|
5
|
+
// Ensure logs directory exists
|
|
6
|
+
const logsDir = path.resolve(__dirname, '..', '..', 'logs');
|
|
7
|
+
if (!fs.existsSync(logsDir)) {
|
|
8
|
+
try {
|
|
9
|
+
fs.mkdirSync(logsDir, { recursive: true });
|
|
10
|
+
} catch (err) {
|
|
11
|
+
// If creating the logs directory fails, continue without file transports
|
|
12
|
+
// console.warn will be used as a fallback during bootstrap
|
|
13
|
+
// eslint-disable-next-line no-console
|
|
14
|
+
console.warn('Could not create logs directory:', err);
|
|
15
|
+
}
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
// Custom log levels as requested: info, error, crit, warn
|
|
19
|
+
const customLevels = {
|
|
20
|
+
levels: {
|
|
21
|
+
crit: 0,
|
|
22
|
+
error: 1,
|
|
23
|
+
warn: 2,
|
|
24
|
+
info: 3
|
|
25
|
+
},
|
|
26
|
+
colors: {
|
|
27
|
+
crit: 'magenta',
|
|
28
|
+
error: 'red',
|
|
29
|
+
warn: 'yellow',
|
|
30
|
+
info: 'green'
|
|
31
|
+
}
|
|
32
|
+
};
|
|
33
|
+
|
|
34
|
+
const { combine, timestamp, printf, colorize } = winston.format;
|
|
35
|
+
|
|
36
|
+
const logFormat = printf(({ level, message, timestamp: ts, ...meta }) => {
|
|
37
|
+
const metaString = Object.keys(meta).length ? ` ${JSON.stringify(meta)}` : '';
|
|
38
|
+
return `${ts} [${level}]: ${message}${metaString}`;
|
|
39
|
+
});
|
|
40
|
+
|
|
41
|
+
// Create transports
|
|
42
|
+
const transports: winston.transport[] = [];
|
|
43
|
+
|
|
44
|
+
// Console transport (always available)
|
|
45
|
+
transports.push(
|
|
46
|
+
new winston.transports.Console({
|
|
47
|
+
format: combine(colorize({ all: true }), timestamp(), logFormat)
|
|
48
|
+
})
|
|
49
|
+
);
|
|
50
|
+
|
|
51
|
+
// File transports (if logs directory is available)
|
|
52
|
+
try {
|
|
53
|
+
transports.push(
|
|
54
|
+
new winston.transports.File({
|
|
55
|
+
filename: path.join(logsDir, 'error.log'),
|
|
56
|
+
level: 'error',
|
|
57
|
+
format: combine(timestamp(), logFormat)
|
|
58
|
+
})
|
|
59
|
+
);
|
|
60
|
+
|
|
61
|
+
transports.push(
|
|
62
|
+
new winston.transports.File({
|
|
63
|
+
filename: path.join(logsDir, 'combined.log'),
|
|
64
|
+
level: 'info',
|
|
65
|
+
format: combine(timestamp(), logFormat)
|
|
66
|
+
})
|
|
67
|
+
);
|
|
68
|
+
} catch (err) {
|
|
69
|
+
// If file transports can't be created, proceed with console-only logging
|
|
70
|
+
// eslint-disable-next-line no-console
|
|
71
|
+
console.warn('File transports unavailable, using console only for logging.');
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
export const logger = winston.createLogger({
|
|
75
|
+
levels: customLevels.levels,
|
|
76
|
+
level: (process.env.LOG_LEVEL as string) || 'info',
|
|
77
|
+
transports,
|
|
78
|
+
exitOnError: false
|
|
79
|
+
});
|
|
80
|
+
|
|
81
|
+
winston.addColors(customLevels.colors);
|
|
82
|
+
|
|
83
|
+
// Attach a stream for morgan or other logging middleware
|
|
84
|
+
export const stream = {
|
|
85
|
+
write: (message: string) => {
|
|
86
|
+
// morgan adds a newline at the end
|
|
87
|
+
logger.info(message.trim());
|
|
88
|
+
}
|
|
89
|
+
};
|
|
90
|
+
|
package/utils/openapi.ts
ADDED
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
import { Express } from 'express';
|
|
2
|
+
import listEndpoints from 'express-list-endpoints';
|
|
3
|
+
|
|
4
|
+
type OpenApiSpec = Record<string, unknown>;
|
|
5
|
+
type OpenApiPaths = Record<string, Record<string, unknown>>;
|
|
6
|
+
|
|
7
|
+
type TagResolver = (path: string, method: string) => string[] | undefined;
|
|
8
|
+
|
|
9
|
+
type BuildOptions = {
|
|
10
|
+
tagResolver?: TagResolver;
|
|
11
|
+
};
|
|
12
|
+
|
|
13
|
+
type Endpoint = {
|
|
14
|
+
path: string;
|
|
15
|
+
methods: string[];
|
|
16
|
+
middlewares: string[];
|
|
17
|
+
};
|
|
18
|
+
|
|
19
|
+
const AUTH_MIDDLEWARES = new Set([
|
|
20
|
+
'authenticateToken',
|
|
21
|
+
'requireAdmin',
|
|
22
|
+
'requireSuperAdmin',
|
|
23
|
+
]);
|
|
24
|
+
|
|
25
|
+
const getRecord = (value: unknown): Record<string, unknown> => {
|
|
26
|
+
if (value && typeof value === 'object' && !Array.isArray(value)) {
|
|
27
|
+
return value as Record<string, unknown>;
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
return {};
|
|
31
|
+
};
|
|
32
|
+
|
|
33
|
+
const shouldSkipPath = (path: string): boolean => {
|
|
34
|
+
if (!path) {
|
|
35
|
+
return true;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
if (path === '*' || path === '/*') {
|
|
39
|
+
return true;
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
return path.startsWith('/api-docs');
|
|
43
|
+
};
|
|
44
|
+
|
|
45
|
+
const normalizePath = (path: string): string => {
|
|
46
|
+
const trimmed = path.endsWith('/') && path.length > 1 ? path.slice(0, -1) : path;
|
|
47
|
+
return trimmed || '/';
|
|
48
|
+
};
|
|
49
|
+
|
|
50
|
+
const buildPathsFromEndpoints = (
|
|
51
|
+
endpoints: Endpoint[],
|
|
52
|
+
tagResolver?: TagResolver
|
|
53
|
+
): OpenApiPaths => {
|
|
54
|
+
const paths: OpenApiPaths = {};
|
|
55
|
+
const allowedMethods = new Set(['GET', 'POST', 'PUT', 'DELETE', 'PATCH']);
|
|
56
|
+
|
|
57
|
+
endpoints.forEach((endpoint) => {
|
|
58
|
+
const path = normalizePath(endpoint.path);
|
|
59
|
+
if (shouldSkipPath(path)) {
|
|
60
|
+
return;
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
endpoint.methods
|
|
64
|
+
.map((method) => method.toUpperCase())
|
|
65
|
+
.filter((method) => allowedMethods.has(method))
|
|
66
|
+
.forEach((method) => {
|
|
67
|
+
const methodKey = method.toLowerCase();
|
|
68
|
+
if (!paths[path]) {
|
|
69
|
+
paths[path] = {};
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
if (paths[path][methodKey]) {
|
|
73
|
+
return;
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
const tags = tagResolver ? tagResolver(path, methodKey) : undefined;
|
|
77
|
+
|
|
78
|
+
const requiresAuth = endpoint.middlewares.some((m) => AUTH_MIDDLEWARES.has(m));
|
|
79
|
+
|
|
80
|
+
paths[path][methodKey] = {
|
|
81
|
+
summary: `${method} ${path}`,
|
|
82
|
+
...(tags && tags.length > 0 ? { tags } : {}),
|
|
83
|
+
...(requiresAuth ? { security: [{ bearerAuth: [] }] } : {}),
|
|
84
|
+
responses: {
|
|
85
|
+
'200': {
|
|
86
|
+
description: 'Success',
|
|
87
|
+
},
|
|
88
|
+
},
|
|
89
|
+
};
|
|
90
|
+
});
|
|
91
|
+
});
|
|
92
|
+
|
|
93
|
+
return paths;
|
|
94
|
+
};
|
|
95
|
+
|
|
96
|
+
const mergePaths = (basePaths: OpenApiPaths, generatedPaths: OpenApiPaths): OpenApiPaths => {
|
|
97
|
+
const merged: OpenApiPaths = { ...generatedPaths };
|
|
98
|
+
|
|
99
|
+
Object.entries(basePaths).forEach(([path, methods]) => {
|
|
100
|
+
const generatedMethods = merged[path] ?? {};
|
|
101
|
+
merged[path] = {
|
|
102
|
+
...generatedMethods,
|
|
103
|
+
...methods,
|
|
104
|
+
};
|
|
105
|
+
});
|
|
106
|
+
|
|
107
|
+
return merged;
|
|
108
|
+
};
|
|
109
|
+
|
|
110
|
+
export const buildOpenApiSpecFromExpress = (
|
|
111
|
+
app: Express,
|
|
112
|
+
baseSpec: OpenApiSpec,
|
|
113
|
+
options: BuildOptions = {}
|
|
114
|
+
): OpenApiSpec => {
|
|
115
|
+
const endpoints = listEndpoints(app) as Endpoint[];
|
|
116
|
+
const basePaths = getRecord(baseSpec.paths) as OpenApiPaths;
|
|
117
|
+
const generatedPaths = buildPathsFromEndpoints(endpoints, options.tagResolver);
|
|
118
|
+
|
|
119
|
+
return {
|
|
120
|
+
...baseSpec,
|
|
121
|
+
paths: {
|
|
122
|
+
...mergePaths(basePaths, generatedPaths),
|
|
123
|
+
},
|
|
124
|
+
};
|
|
125
|
+
};
|