namirasoft-node 1.4.59 → 1.4.60

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/src/BaseTable.ts CHANGED
@@ -1,126 +1,126 @@
1
- import { ArraySchema, BaseTypeSchema, BaseVariableSchema, ObjectSchema } from "namirasoft-schema";
2
- import { BaseDatabase } from "./BaseDatabase";
3
- import { ErrorOperation, BaseUUID, NamingConvention } from "namirasoft-core";
4
-
5
- export abstract class BaseTable<D extends BaseDatabase, ModelColumnOption>
6
- {
7
- database: D;
8
- uuid: BaseUUID;
9
- constructor(database: D)
10
- {
11
- this.database = database;
12
- this.uuid = new BaseUUID(this.getShortName());
13
- }
14
- public abstract getName(): string;
15
- public abstract getShortName(): string;
16
- protected addSecureColumns(columns: string[]): string[]
17
- {
18
- return columns;
19
- }
20
- protected addReadOnlyColumns(columns: string[]): string[]
21
- {
22
- return columns;
23
- }
24
- public getSecureColumns(): string[]
25
- {
26
- let columns: string[] = [];
27
- return this.addSecureColumns(columns);
28
- }
29
- public getReadOnlyColumns(): string[]
30
- {
31
- let columns: string[] = [];
32
- return this.addReadOnlyColumns(columns);
33
- }
34
- public abstract forEachColumn(handler: (name: string, column: ModelColumnOption) => void): void;
35
- public getColumns(secure: boolean | null = false, read_only: boolean | null = null): string[]
36
- {
37
- let columns_secure: string[] = this.getSecureColumns();
38
- let columns_read_only: string[] = this.getReadOnlyColumns();
39
- let columns: string[] = [];
40
- this.forEachColumn((name, _) => columns.push(name));
41
- if (secure !== null)
42
- columns = columns.filter(name => columns_secure.includes(name) == secure);
43
- if (read_only !== null)
44
- columns = columns.filter(name => columns_read_only.includes(name) == read_only);
45
- return columns;
46
- }
47
- public checkColumn(column: string, secure: boolean | null, read_only: boolean | null)
48
- {
49
- let columns: string[] = this.getColumns(secure, read_only)
50
- if (!columns.includes(column))
51
- ErrorOperation.throwHTTP(404, `Column '${column}' not found`);
52
- }
53
- public getRealColumnName(column: string): string
54
- {
55
- return column;
56
- }
57
- public secure(obj: any)
58
- {
59
- if (obj.dataValues)
60
- obj = obj.dataValues;
61
- let secureColumns: string[] = this.getSecureColumns();
62
- secureColumns.forEach(col => delete obj[col]);
63
- return obj;
64
- }
65
- public getArraySchema(require: boolean, name?: string): ArraySchema
66
- {
67
- let ans = this.getSchema(require, name);
68
- return new ArraySchema(require, [ans]);
69
- }
70
- public getSchema(require: boolean, name?: string): ObjectSchema
71
- {
72
- if (!name)
73
- name = NamingConvention.lower_case_underscore.convert(this.getName(), NamingConvention.Pascal_Case);
74
- let columns_secure: string[] = this.getSecureColumns();
75
- let columns_read_only: string[] = this.getReadOnlyColumns();
76
- let ans = new ObjectSchema(name, require, null);
77
- this.forEachColumn((name, element) =>
78
- {
79
- if (!columns_secure.includes(name))
80
- ans.addField(this.getVariableSchema(name, element, columns_read_only.includes(name)));
81
- });
82
- return ans;
83
- }
84
- private getVariableSchema(name: string, element: ModelColumnOption, read_only: boolean): BaseVariableSchema
85
- {
86
- let schema = this.getTypeSchema(element);
87
- schema.read_only = read_only;
88
- let es = this.getExamples();
89
- schema.example = es[name] ?? "";
90
- return new BaseVariableSchema(name, schema);
91
- }
92
- protected abstract getTypeSchema(element: ModelColumnOption): BaseTypeSchema;
93
- protected getExamples(): { [name: string]: string }
94
- {
95
- return {};
96
- }
97
- public getSchemaNames(): string[]
98
- {
99
- return [];
100
- }
101
- public getSchemaByName(require: boolean, name?: string): ObjectSchema
102
- {
103
- let ans = this.getSchema(require, name);
104
- if (name)
105
- {
106
- let names = this.getSchemaNames();
107
- if (!names.includes(name))
108
- throw new Error("Wrong schema name was provided: " + name);
109
- this.setSchemaByName(ans);
110
- }
111
- return ans;
112
- }
113
- public getArraySchemaByName(require: boolean, name?: string): ArraySchema
114
- {
115
- let ans = this.getSchemaByName(require, name);
116
- return new ArraySchema(require, [ans]);
117
- }
118
- protected setSchemaByName(_: ObjectSchema): void
119
- {
120
- }
121
- public getNotFoundError(conditions: any | null)
122
- {
123
- let name = NamingConvention.lower_case_underscore.convert(this.getName(), NamingConvention.Pascal_Case);
124
- return ErrorOperation.getHTTP(404, "Could not find " + name + " for " + JSON.stringify(conditions));
125
- }
1
+ import { ArraySchema, BaseTypeSchema, BaseVariableSchema, ObjectSchema } from "namirasoft-schema";
2
+ import { BaseDatabase } from "./BaseDatabase";
3
+ import { ErrorOperation, BaseUUID, NamingConvention } from "namirasoft-core";
4
+
5
+ export abstract class BaseTable<D extends BaseDatabase, ModelColumnOption>
6
+ {
7
+ database: D;
8
+ uuid: BaseUUID;
9
+ constructor(database: D)
10
+ {
11
+ this.database = database;
12
+ this.uuid = new BaseUUID(this.getShortName());
13
+ }
14
+ public abstract getName(): string;
15
+ public abstract getShortName(): string;
16
+ protected addSecureColumns(columns: string[]): string[]
17
+ {
18
+ return columns;
19
+ }
20
+ protected addReadOnlyColumns(columns: string[]): string[]
21
+ {
22
+ return columns;
23
+ }
24
+ public getSecureColumns(): string[]
25
+ {
26
+ let columns: string[] = [];
27
+ return this.addSecureColumns(columns);
28
+ }
29
+ public getReadOnlyColumns(): string[]
30
+ {
31
+ let columns: string[] = [];
32
+ return this.addReadOnlyColumns(columns);
33
+ }
34
+ public abstract forEachColumn(handler: (name: string, column: ModelColumnOption) => void): void;
35
+ public getColumns(secure: boolean | null = false, read_only: boolean | null = null): string[]
36
+ {
37
+ let columns_secure: string[] = this.getSecureColumns();
38
+ let columns_read_only: string[] = this.getReadOnlyColumns();
39
+ let columns: string[] = [];
40
+ this.forEachColumn((name, _) => columns.push(name));
41
+ if (secure !== null)
42
+ columns = columns.filter(name => columns_secure.includes(name) == secure);
43
+ if (read_only !== null)
44
+ columns = columns.filter(name => columns_read_only.includes(name) == read_only);
45
+ return columns;
46
+ }
47
+ public checkColumn(column: string, secure: boolean | null, read_only: boolean | null)
48
+ {
49
+ let columns: string[] = this.getColumns(secure, read_only)
50
+ if (!columns.includes(column))
51
+ ErrorOperation.throwHTTP(404, `Column '${column}' not found`);
52
+ }
53
+ public getRealColumnName(column: string): string
54
+ {
55
+ return column;
56
+ }
57
+ public secure(obj: any)
58
+ {
59
+ if (obj.dataValues)
60
+ obj = obj.dataValues;
61
+ let secureColumns: string[] = this.getSecureColumns();
62
+ secureColumns.forEach(col => delete obj[col]);
63
+ return obj;
64
+ }
65
+ public getArraySchema(require: boolean, name?: string): ArraySchema
66
+ {
67
+ let ans = this.getSchema(require, name);
68
+ return new ArraySchema(require, [ans]);
69
+ }
70
+ public getSchema(require: boolean, name?: string): ObjectSchema
71
+ {
72
+ if (!name)
73
+ name = NamingConvention.lower_case_underscore.convert(this.getName(), NamingConvention.Pascal_Case);
74
+ let columns_secure: string[] = this.getSecureColumns();
75
+ let columns_read_only: string[] = this.getReadOnlyColumns();
76
+ let ans = new ObjectSchema(name, require, null);
77
+ this.forEachColumn((name, element) =>
78
+ {
79
+ if (!columns_secure.includes(name))
80
+ ans.addField(this.getVariableSchema(name, element, columns_read_only.includes(name)));
81
+ });
82
+ return ans;
83
+ }
84
+ private getVariableSchema(name: string, element: ModelColumnOption, read_only: boolean): BaseVariableSchema
85
+ {
86
+ let schema = this.getTypeSchema(element);
87
+ schema.read_only = read_only;
88
+ let es = this.getExamples();
89
+ schema.example = es[name] ?? "";
90
+ return new BaseVariableSchema(name, schema);
91
+ }
92
+ protected abstract getTypeSchema(element: ModelColumnOption): BaseTypeSchema;
93
+ protected getExamples(): { [name: string]: string }
94
+ {
95
+ return {};
96
+ }
97
+ public getSchemaNames(): string[]
98
+ {
99
+ return [];
100
+ }
101
+ public getSchemaByName(require: boolean, name?: string): ObjectSchema
102
+ {
103
+ let ans = this.getSchema(require, name);
104
+ if (name)
105
+ {
106
+ let names = this.getSchemaNames();
107
+ if (!names.includes(name))
108
+ throw new Error("Wrong schema name was provided: " + name);
109
+ this.setSchemaByName(ans);
110
+ }
111
+ return ans;
112
+ }
113
+ public getArraySchemaByName(require: boolean, name?: string): ArraySchema
114
+ {
115
+ let ans = this.getSchemaByName(require, name);
116
+ return new ArraySchema(require, [ans]);
117
+ }
118
+ protected setSchemaByName(_: ObjectSchema): void
119
+ {
120
+ }
121
+ public getNotFoundError(conditions: any | null)
122
+ {
123
+ let name = NamingConvention.lower_case_underscore.convert(this.getName(), NamingConvention.Pascal_Case);
124
+ return ErrorOperation.getHTTP(404, "Could not find " + name + " for " + JSON.stringify(conditions));
125
+ }
126
126
  }
@@ -1,33 +1,33 @@
1
- import { ExecException, exec, execSync } from 'child_process';
2
- import { ConsoleOperation } from 'namirasoft-core';
3
- export class CommandOperation
4
- {
5
- static exec(command: string, cwd: string | undefined)
6
- {
7
- exec(command, { cwd }, (error: ExecException | null, stdout: string, stderr: string) =>
8
- {
9
- if (error)
10
- {
11
- ConsoleOperation.error(`error: ${error.message}`);
12
- return;
13
- }
14
- if (stderr)
15
- {
16
- ConsoleOperation.error(`stderr: ${stderr}`);
17
- return;
18
- }
19
- ConsoleOperation.log(`stdout:\n${stdout}`);
20
- });
21
- }
22
- static execSync(command: string, cwd: string | undefined)
23
- {
24
- try
25
- {
26
- return execSync(command, { cwd, encoding: 'utf-8' });
27
- } catch (error: any)
28
- {
29
- ConsoleOperation.error(error.stdout);
30
- throw error;
31
- }
32
- }
1
+ import { ExecException, exec, execSync } from 'child_process';
2
+ import { ConsoleOperation } from 'namirasoft-core';
3
+ export class CommandOperation
4
+ {
5
+ static exec(command: string, cwd: string | undefined)
6
+ {
7
+ exec(command, { cwd }, (error: ExecException | null, stdout: string, stderr: string) =>
8
+ {
9
+ if (error)
10
+ {
11
+ ConsoleOperation.error(`error: ${error.message}`);
12
+ return;
13
+ }
14
+ if (stderr)
15
+ {
16
+ ConsoleOperation.error(`stderr: ${stderr}`);
17
+ return;
18
+ }
19
+ ConsoleOperation.log(`stdout:\n${stdout}`);
20
+ });
21
+ }
22
+ static execSync(command: string, cwd: string | undefined)
23
+ {
24
+ try
25
+ {
26
+ return execSync(command, { cwd, encoding: 'utf-8' });
27
+ } catch (error: any)
28
+ {
29
+ ConsoleOperation.error(error.stdout);
30
+ throw error;
31
+ }
32
+ }
33
33
  }
@@ -1,12 +1,12 @@
1
- import { BaseDatabase } from "./BaseDatabase";
2
-
3
- export class EmptyDatabase extends BaseDatabase
4
- {
5
- override async init() { }
6
- override connect() { }
7
- override async sync(_: boolean) { }
8
- public override getSortOptions(): string[]
9
- {
10
- return [];
11
- }
1
+ import { BaseDatabase } from "./BaseDatabase";
2
+
3
+ export class EmptyDatabase extends BaseDatabase
4
+ {
5
+ override async init() { }
6
+ override connect() { }
7
+ override async sync(_: boolean) { }
8
+ public override getSortOptions(): string[]
9
+ {
10
+ return [];
11
+ }
12
12
  }
@@ -1,23 +1,23 @@
1
- import smtpTransport from 'nodemailer-smtp-transport';
2
- import { BaseEmailService } from './BaseEmailService';
3
-
4
- export class GmailService extends BaseEmailService
5
- {
6
- password: string;
7
- constructor(username: string, password: string)
8
- {
9
- super(username);
10
- this.password = password;
11
- }
12
- protected override getTransform(): any
13
- {
14
- return smtpTransport({
15
- service: 'gmail',
16
- host: 'smtp.gmail.com',
17
- auth: {
18
- user: this.username,
19
- pass: this.password
20
- }
21
- });
22
- }
1
+ import smtpTransport from 'nodemailer-smtp-transport';
2
+ import { BaseEmailService } from './BaseEmailService';
3
+
4
+ export class GmailService extends BaseEmailService
5
+ {
6
+ password: string;
7
+ constructor(username: string, password: string)
8
+ {
9
+ super(username);
10
+ this.password = password;
11
+ }
12
+ protected override getTransform(): any
13
+ {
14
+ return smtpTransport({
15
+ service: 'gmail',
16
+ host: 'smtp.gmail.com',
17
+ auth: {
18
+ user: this.username,
19
+ pass: this.password
20
+ }
21
+ });
22
+ }
23
23
  }
@@ -1,39 +1,39 @@
1
- import * as express from 'express';
2
- import { getClientIp } from '@supercharge/request-ip';
3
- import { RequestHeaderService } from './RequestHeaderService';
4
- import { ErrorOperation } from 'namirasoft-core';
5
-
6
- export class IPOperation
7
- {
8
- static ERROR_MESSAGE_IP_IS_NOT_WHITELIST = `Ip does not match the whitelisted IP address: {0}`;
9
- static getIP(req: express.Request): string
10
- {
11
- let ip = new RequestHeaderService(req, 'cf-connecting-ip').getString();
12
- if (!ip)
13
- ip = new RequestHeaderService(req, 'x-forwarded-for').getString();
14
- if (!ip)
15
- ip = getClientIp(req) ?? "";
16
- ip = ip.split(',')[0];
17
- return ip;
18
- }
19
- static isWhitelist(req: express.Request, whitelist: string[])
20
- {
21
- let ip = this.getIP(req);
22
- if (!whitelist)
23
- return true;
24
- if (whitelist.length === 0)
25
- return true;
26
- if (whitelist.includes(ip))
27
- return true;
28
- for (let item of whitelist)
29
- if (ip.substring(0, item.length) === item)
30
- return true;
31
- return false;
32
- }
33
- static checkWhitelist(req: express.Request, whitelist: string[])
34
- {
35
- let valid = this.isWhitelist(req, whitelist);
36
- if (!valid)
37
- ErrorOperation.throwHTTP(403, this.ERROR_MESSAGE_IP_IS_NOT_WHITELIST, this.getIP(req));
38
- }
1
+ import * as express from 'express';
2
+ import { getClientIp } from '@supercharge/request-ip';
3
+ import { RequestHeaderService } from './RequestHeaderService';
4
+ import { ErrorOperation } from 'namirasoft-core';
5
+
6
+ export class IPOperation
7
+ {
8
+ static ERROR_MESSAGE_IP_IS_NOT_WHITELIST = `Ip does not match the whitelisted IP address: {0}`;
9
+ static getIP(req: express.Request): string
10
+ {
11
+ let ip = new RequestHeaderService(req, 'cf-connecting-ip').getString();
12
+ if (!ip)
13
+ ip = new RequestHeaderService(req, 'x-forwarded-for').getString();
14
+ if (!ip)
15
+ ip = getClientIp(req) ?? "";
16
+ ip = ip.split(',')[0];
17
+ return ip;
18
+ }
19
+ static isWhitelist(req: express.Request, whitelist: string[])
20
+ {
21
+ let ip = this.getIP(req);
22
+ if (!whitelist)
23
+ return true;
24
+ if (whitelist.length === 0)
25
+ return true;
26
+ if (whitelist.includes(ip))
27
+ return true;
28
+ for (let item of whitelist)
29
+ if (ip.substring(0, item.length) === item)
30
+ return true;
31
+ return false;
32
+ }
33
+ static checkWhitelist(req: express.Request, whitelist: string[])
34
+ {
35
+ let valid = this.isWhitelist(req, whitelist);
36
+ if (!valid)
37
+ ErrorOperation.throwHTTP(403, this.ERROR_MESSAGE_IP_IS_NOT_WHITELIST, this.getIP(req));
38
+ }
39
39
  }
package/src/Meta.ts CHANGED
@@ -1,42 +1,42 @@
1
- import * as express from 'express';
2
- import { IncomingHttpHeaders } from "http";
3
- import { IPOperation } from './IPOperation';
4
- import { HTTPMethod } from 'namirasoft-core';
5
-
6
- export class Meta
7
- {
8
- info: { name: string, tag: string, method: HTTPMethod, path: string, summary: string };
9
- ip: string;
10
- method: string;
11
- url: string;
12
- headers?: IncomingHttpHeaders;
13
- body?: any;
14
- start_time: Date | null = null;
15
- end_time: Date | null = null;
16
- duration: number | null = null;
17
- code: number = 200;
18
- message: string = "Success";
19
- error: Error | null = null;
20
- redirect_location: string | null = null;
21
- constructor(info: { name: string, tag: string, method: HTTPMethod, path: string, summary: string }, req: express.Request, sensitive: boolean)
22
- {
23
- this.info = info;
24
- this.ip = IPOperation.getIP(req);
25
- this.method = req.method;
26
- this.url = req.originalUrl;
27
- if (!sensitive)
28
- {
29
- this.headers = req.headers;
30
- this.body = req.body;
31
- }
32
- }
33
- onStart()
34
- {
35
- this.start_time = new Date();
36
- }
37
- onFinish()
38
- {
39
- this.end_time = new Date();
40
- this.duration = (this.end_time?.getTime() ?? 0) - (this.start_time?.getTime() ?? 0);
41
- }
1
+ import * as express from 'express';
2
+ import { IncomingHttpHeaders } from "http";
3
+ import { IPOperation } from './IPOperation';
4
+ import { HTTPMethod } from 'namirasoft-core';
5
+
6
+ export class Meta
7
+ {
8
+ info: { name: string, tag: string, method: HTTPMethod, path: string, summary: string };
9
+ ip: string;
10
+ method: string;
11
+ url: string;
12
+ headers?: IncomingHttpHeaders;
13
+ body?: any;
14
+ start_time: Date | null = null;
15
+ end_time: Date | null = null;
16
+ duration: number | null = null;
17
+ code: number = 200;
18
+ message: string = "Success";
19
+ error: Error | null = null;
20
+ redirect_location: string | null = null;
21
+ constructor(info: { name: string, tag: string, method: HTTPMethod, path: string, summary: string }, req: express.Request, sensitive: boolean)
22
+ {
23
+ this.info = info;
24
+ this.ip = IPOperation.getIP(req);
25
+ this.method = req.method;
26
+ this.url = req.originalUrl;
27
+ if (!sensitive)
28
+ {
29
+ this.headers = req.headers;
30
+ this.body = req.body;
31
+ }
32
+ }
33
+ onStart()
34
+ {
35
+ this.start_time = new Date();
36
+ }
37
+ onFinish()
38
+ {
39
+ this.end_time = new Date();
40
+ this.duration = (this.end_time?.getTime() ?? 0) - (this.start_time?.getTime() ?? 0);
41
+ }
42
42
  }