@adaptivestone/framework 5.0.0-beta.9 → 5.0.0-rc.1
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/LICENCE +1 -1
- package/README.md +66 -2
- package/dist/Cli.d.ts +7 -0
- package/dist/Cli.js +19 -0
- package/dist/Cli.js.map +1 -0
- package/dist/cluster.d.ts +1 -0
- package/dist/cluster.js +67 -0
- package/dist/cluster.js.map +1 -0
- package/dist/codegen/appTypes.d.ts +19 -0
- package/dist/codegen/appTypes.js +126 -0
- package/dist/codegen/appTypes.js.map +1 -0
- package/dist/codegen/astEmit.d.ts +53 -0
- package/dist/codegen/astEmit.js +242 -0
- package/dist/codegen/astEmit.js.map +1 -0
- package/dist/codegen/astExtract.d.ts +78 -0
- package/dist/codegen/astExtract.js +539 -0
- package/dist/codegen/astExtract.js.map +1 -0
- package/dist/codegen/astModel.d.ts +14 -0
- package/dist/codegen/astModel.js +73 -0
- package/dist/codegen/astModel.js.map +1 -0
- package/dist/codegen/astResolve.d.ts +53 -0
- package/dist/codegen/astResolve.js +276 -0
- package/dist/codegen/astResolve.js.map +1 -0
- package/dist/codegen/astSpec.d.ts +25 -0
- package/dist/codegen/astSpec.js +63 -0
- package/dist/codegen/astSpec.js.map +1 -0
- package/dist/codegen/collectMetadata.d.ts +39 -0
- package/dist/codegen/collectMetadata.js +7 -0
- package/dist/codegen/collectMetadata.js.map +1 -0
- package/dist/codegen/emit.d.ts +30 -0
- package/dist/codegen/emit.js +213 -0
- package/dist/codegen/emit.js.map +1 -0
- package/dist/codegen/index.d.ts +30 -0
- package/dist/codegen/index.js +76 -0
- package/dist/codegen/index.js.map +1 -0
- package/dist/codegen/paths.d.ts +9 -0
- package/dist/codegen/paths.js +25 -0
- package/dist/codegen/paths.js.map +1 -0
- package/dist/commands/CreateUser.d.ts +32 -0
- package/dist/commands/CreateUser.js +85 -0
- package/dist/commands/CreateUser.js.map +1 -0
- package/dist/commands/DropIndex.d.ts +16 -0
- package/dist/commands/DropIndex.js +30 -0
- package/dist/commands/DropIndex.js.map +1 -0
- package/dist/commands/GenerateRandomBytes.d.ts +7 -0
- package/dist/commands/GenerateRandomBytes.js +18 -0
- package/dist/commands/GenerateRandomBytes.js.map +1 -0
- package/dist/commands/GenerateTypes.d.ts +13 -0
- package/dist/commands/GenerateTypes.js +34 -0
- package/dist/commands/GenerateTypes.js.map +1 -0
- package/dist/commands/SyncIndexes.d.ts +6 -0
- package/dist/commands/SyncIndexes.js +31 -0
- package/dist/commands/SyncIndexes.js.map +1 -0
- package/dist/commands/migration/Create.d.ts +18 -0
- package/dist/commands/migration/Create.js +57 -0
- package/dist/commands/migration/Create.js.map +1 -0
- package/dist/commands/migration/Migrate.d.ts +6 -0
- package/dist/commands/migration/Migrate.js +73 -0
- package/dist/commands/migration/Migrate.js.map +1 -0
- package/dist/config/auth.d.ts +11 -0
- package/dist/config/auth.js +18 -0
- package/dist/config/auth.js.map +1 -0
- package/dist/config/http.d.ts +22 -0
- package/dist/config/http.js +40 -0
- package/dist/config/http.js.map +1 -0
- package/dist/config/i18n.d.ts +13 -0
- package/dist/config/i18n.js +13 -0
- package/dist/config/i18n.js.map +1 -0
- package/dist/config/ipDetector.d.ts +5 -0
- package/dist/config/ipDetector.js +15 -0
- package/dist/config/ipDetector.js.map +1 -0
- package/dist/config/log.d.ts +11 -0
- package/dist/config/log.js +21 -0
- package/dist/config/log.js.map +1 -0
- package/dist/config/mongo.d.ts +4 -0
- package/dist/config/mongo.js +4 -0
- package/dist/config/mongo.js.map +1 -0
- package/dist/config/rateLimiter.d.ts +13 -0
- package/dist/config/rateLimiter.js +17 -0
- package/dist/config/rateLimiter.js.map +1 -0
- package/dist/config/redis.d.ts +5 -0
- package/dist/config/redis.js +5 -0
- package/dist/config/redis.js.map +1 -0
- package/dist/controllers/Auth.d.ts +59 -0
- package/dist/controllers/Auth.js +356 -0
- package/dist/controllers/Auth.js.map +1 -0
- package/dist/controllers/Auth.routes.gen.d.ts +57 -0
- package/dist/controllers/Auth.routes.gen.js +10 -0
- package/dist/controllers/Auth.routes.gen.js.map +1 -0
- package/dist/controllers/Home.d.ts +14 -0
- package/dist/controllers/Home.js +26 -0
- package/dist/controllers/Home.js.map +1 -0
- package/dist/controllers/Home.routes.gen.d.ts +13 -0
- package/dist/controllers/Home.routes.gen.js +10 -0
- package/dist/controllers/Home.routes.gen.js.map +1 -0
- package/dist/controllers/index.d.ts +107 -0
- package/dist/controllers/index.js +548 -0
- package/dist/controllers/index.js.map +1 -0
- package/dist/folderConfig.d.ts +34 -0
- package/dist/folderConfig.js +14 -0
- package/dist/folderConfig.js.map +1 -0
- package/dist/helpers/appInstance.d.ts +10 -0
- package/dist/helpers/appInstance.js +19 -0
- package/dist/helpers/appInstance.js.map +1 -0
- package/dist/helpers/crypto.d.ts +26 -0
- package/dist/helpers/crypto.js +160 -0
- package/dist/helpers/crypto.js.map +1 -0
- package/dist/helpers/deprecation.d.ts +8 -0
- package/dist/helpers/deprecation.js +19 -0
- package/dist/helpers/deprecation.js.map +1 -0
- package/dist/helpers/env.d.ts +8 -0
- package/dist/helpers/env.js +15 -0
- package/dist/helpers/env.js.map +1 -0
- package/dist/helpers/files.d.ts +16 -0
- package/dist/helpers/files.js +83 -0
- package/dist/helpers/files.js.map +1 -0
- package/dist/helpers/logger.d.ts +6 -0
- package/dist/helpers/logger.js +34 -0
- package/dist/helpers/logger.js.map +1 -0
- package/dist/helpers/redis/clearNamespace.d.ts +10 -0
- package/dist/helpers/redis/clearNamespace.js +31 -0
- package/dist/helpers/redis/clearNamespace.js.map +1 -0
- package/dist/helpers/redis/redisConnection.d.ts +8 -0
- package/dist/helpers/redis/redisConnection.js +63 -0
- package/dist/helpers/redis/redisConnection.js.map +1 -0
- package/dist/helpers/yup.d.ts +22 -0
- package/dist/helpers/yup.js +39 -0
- package/dist/helpers/yup.js.map +1 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +8 -0
- package/dist/index.js.map +1 -0
- package/{locales → dist/locales}/en/translation.json +5 -0
- package/{locales → dist/locales}/ru/translation.json +5 -0
- package/dist/models/KeyValue.d.ts +22 -0
- package/dist/models/KeyValue.js +17 -0
- package/dist/models/KeyValue.js.map +1 -0
- package/dist/models/Lock.d.ts +99 -0
- package/dist/models/Lock.js +123 -0
- package/dist/models/Lock.js.map +1 -0
- package/dist/models/Migration.d.ts +13 -0
- package/dist/models/Migration.js +14 -0
- package/dist/models/Migration.js.map +1 -0
- package/dist/models/Sequence.d.ts +28 -0
- package/dist/models/Sequence.js +31 -0
- package/dist/models/Sequence.js.map +1 -0
- package/dist/models/User.d.ts +769 -0
- package/dist/models/User.js +336 -0
- package/dist/models/User.js.map +1 -0
- package/dist/models/UserOld.d.ts +191 -0
- package/dist/models/UserOld.js +231 -0
- package/dist/models/UserOld.js.map +1 -0
- package/dist/modules/AbstractCommand.d.ts +51 -0
- package/dist/modules/AbstractCommand.js +60 -0
- package/dist/modules/AbstractCommand.js.map +1 -0
- package/dist/modules/AbstractConnector.d.ts +5 -0
- package/dist/modules/AbstractConnector.js +8 -0
- package/dist/modules/AbstractConnector.js.map +1 -0
- package/dist/modules/AbstractController.d.ts +99 -0
- package/dist/modules/AbstractController.js +83 -0
- package/dist/modules/AbstractController.js.map +1 -0
- package/dist/modules/AbstractModel.d.ts +29 -0
- package/dist/modules/AbstractModel.js +42 -0
- package/dist/modules/AbstractModel.js.map +1 -0
- package/dist/modules/Base.d.ts +29 -0
- package/dist/modules/Base.js +62 -0
- package/dist/modules/Base.js.map +1 -0
- package/dist/modules/BaseCli.d.ts +25 -0
- package/dist/modules/BaseCli.js +159 -0
- package/dist/modules/BaseCli.js.map +1 -0
- package/dist/modules/BaseModel.d.ts +57 -0
- package/dist/modules/BaseModel.js +37 -0
- package/dist/modules/BaseModel.js.map +1 -0
- package/dist/server.d.ts +130 -0
- package/dist/server.js +603 -0
- package/dist/server.js.map +1 -0
- package/dist/services/cache/Cache.d.ts +31 -0
- package/dist/services/cache/Cache.js +146 -0
- package/dist/services/cache/Cache.js.map +1 -0
- package/dist/services/http/HttpServer.d.ts +46 -0
- package/dist/services/http/HttpServer.js +114 -0
- package/dist/services/http/HttpServer.js.map +1 -0
- package/dist/services/http/files.d.ts +18 -0
- package/dist/services/http/files.js +19 -0
- package/dist/services/http/files.js.map +1 -0
- package/dist/services/http/middleware/AbstractMiddleware.d.ts +58 -0
- package/dist/services/http/middleware/AbstractMiddleware.js +73 -0
- package/dist/services/http/middleware/AbstractMiddleware.js.map +1 -0
- package/dist/services/http/middleware/Auth.d.ts +22 -0
- package/dist/services/http/middleware/Auth.js +30 -0
- package/dist/services/http/middleware/Auth.js.map +1 -0
- package/dist/services/http/middleware/Cors.d.ts +12 -0
- package/dist/services/http/middleware/Cors.js +45 -0
- package/dist/services/http/middleware/Cors.js.map +1 -0
- package/dist/services/http/middleware/GetUserByToken.d.ts +36 -0
- package/dist/services/http/middleware/GetUserByToken.js +59 -0
- package/dist/services/http/middleware/GetUserByToken.js.map +1 -0
- package/dist/services/http/middleware/I18n.d.ts +23 -0
- package/dist/services/http/middleware/I18n.js +61 -0
- package/dist/services/http/middleware/I18n.js.map +1 -0
- package/dist/services/http/middleware/IpDetector.d.ts +14 -0
- package/dist/services/http/middleware/IpDetector.js +80 -0
- package/dist/services/http/middleware/IpDetector.js.map +1 -0
- package/dist/services/http/middleware/Pagination.d.ts +26 -0
- package/dist/services/http/middleware/Pagination.js +70 -0
- package/dist/services/http/middleware/Pagination.js.map +1 -0
- package/dist/services/http/middleware/PrepareAppInfo.d.ts +8 -0
- package/dist/services/http/middleware/PrepareAppInfo.js +17 -0
- package/dist/services/http/middleware/PrepareAppInfo.js.map +1 -0
- package/dist/services/http/middleware/RateLimiter.d.ts +31 -0
- package/dist/services/http/middleware/RateLimiter.js +118 -0
- package/dist/services/http/middleware/RateLimiter.js.map +1 -0
- package/dist/services/http/middleware/RequestLogger.d.ts +8 -0
- package/dist/services/http/middleware/RequestLogger.js +20 -0
- package/dist/services/http/middleware/RequestLogger.js.map +1 -0
- package/dist/services/http/middleware/RequestParser.d.ts +15 -0
- package/dist/services/http/middleware/RequestParser.js +112 -0
- package/dist/services/http/middleware/RequestParser.js.map +1 -0
- package/dist/services/http/middleware/Role.d.ts +12 -0
- package/dist/services/http/middleware/Role.js +27 -0
- package/dist/services/http/middleware/Role.js.map +1 -0
- package/dist/services/http/routing/ExpressAdapter.d.ts +12 -0
- package/dist/services/http/routing/ExpressAdapter.js +95 -0
- package/dist/services/http/routing/ExpressAdapter.js.map +1 -0
- package/dist/services/http/routing/RouteNode.d.ts +105 -0
- package/dist/services/http/routing/RouteNode.js +21 -0
- package/dist/services/http/routing/RouteNode.js.map +1 -0
- package/dist/services/http/routing/RouteRegistry.d.ts +37 -0
- package/dist/services/http/routing/RouteRegistry.js +244 -0
- package/dist/services/http/routing/RouteRegistry.js.map +1 -0
- package/dist/services/http/routing/formatTree.d.ts +23 -0
- package/dist/services/http/routing/formatTree.js +159 -0
- package/dist/services/http/routing/formatTree.js.map +1 -0
- package/dist/services/http/routing/match.d.ts +31 -0
- package/dist/services/http/routing/match.js +164 -0
- package/dist/services/http/routing/match.js.map +1 -0
- package/dist/services/http/routing/middlewareNormalization.d.ts +11 -0
- package/dist/services/http/routing/middlewareNormalization.js +23 -0
- package/dist/services/http/routing/middlewareNormalization.js.map +1 -0
- package/dist/services/http/types.d.ts +74 -0
- package/dist/services/http/types.js +8 -0
- package/dist/services/http/types.js.map +1 -0
- package/dist/services/i18n/I18n.d.ts +15 -0
- package/dist/services/i18n/I18n.js +58 -0
- package/dist/services/i18n/I18n.js.map +1 -0
- package/dist/services/logging/SentryTransport.d.ts +13 -0
- package/dist/services/logging/SentryTransport.js +134 -0
- package/dist/services/logging/SentryTransport.js.map +1 -0
- package/dist/services/validate/ValidateService.d.ts +54 -0
- package/dist/services/validate/ValidateService.js +144 -0
- package/dist/services/validate/ValidateService.js.map +1 -0
- package/dist/services/validate/ValidationError.d.ts +35 -0
- package/dist/services/validate/ValidationError.js +90 -0
- package/dist/services/validate/ValidationError.js.map +1 -0
- package/dist/services/validate/contentType.d.ts +18 -0
- package/dist/services/validate/contentType.js +30 -0
- package/dist/services/validate/contentType.js.map +1 -0
- package/dist/services/validate/defineSchema.d.ts +23 -0
- package/dist/services/validate/defineSchema.js +25 -0
- package/dist/services/validate/defineSchema.js.map +1 -0
- package/dist/services/validate/drivers/StandardSchemaDriver.d.ts +15 -0
- package/dist/services/validate/drivers/StandardSchemaDriver.js +38 -0
- package/dist/services/validate/drivers/StandardSchemaDriver.js.map +1 -0
- package/dist/services/validate/drivers/YupDriver.d.ts +21 -0
- package/dist/services/validate/drivers/YupDriver.js +81 -0
- package/dist/services/validate/drivers/YupDriver.js.map +1 -0
- package/dist/services/validate/types.d.ts +104 -0
- package/dist/services/validate/types.js +11 -0
- package/dist/services/validate/types.js.map +1 -0
- package/dist/tests/frameworkVitestSetup.d.ts +1 -0
- package/dist/tests/frameworkVitestSetup.js +9 -0
- package/dist/tests/frameworkVitestSetup.js.map +1 -0
- package/dist/tests/globalSetupVitest.d.ts +3 -0
- package/dist/tests/globalSetupVitest.js +29 -0
- package/dist/tests/globalSetupVitest.js.map +1 -0
- package/dist/tests/setupVitest.d.ts +1 -0
- package/dist/tests/setupVitest.js +101 -0
- package/dist/tests/setupVitest.js.map +1 -0
- package/dist/tests/testHelpers.d.ts +361 -0
- package/dist/tests/testHelpers.js +48 -0
- package/dist/tests/testHelpers.js.map +1 -0
- package/dist/types.d.ts +4 -0
- package/dist/types.js +5 -0
- package/dist/types.js.map +1 -0
- package/package.json +83 -39
- package/.env.example +0 -18
- package/CHANGELOG.md +0 -956
- package/Cli.js +0 -21
- package/cluster.js +0 -25
- package/commands/CreateUser.js +0 -106
- package/commands/Documentation.js +0 -17
- package/commands/DropIndex.js +0 -38
- package/commands/GenerateRandomBytes.js +0 -21
- package/commands/GetOpenApiJson.js +0 -336
- package/commands/SyncIndexes.js +0 -40
- package/commands/migration/Create.js +0 -72
- package/commands/migration/Migrate.js +0 -56
- package/config/auth.js +0 -9
- package/config/http.js +0 -9
- package/config/i18n.js +0 -12
- package/config/ipDetector.js +0 -14
- package/config/log.js +0 -22
- package/config/mongo.js +0 -3
- package/config/rateLimiter.js +0 -16
- package/config/redis.js +0 -4
- package/config/validate.js +0 -3
- package/controllers/Auth.js +0 -201
- package/controllers/Home.js +0 -28
- package/controllers/index.js +0 -60
- package/eslint.config.js +0 -68
- package/folderConfig.js +0 -13
- package/helpers/files.js +0 -76
- package/helpers/logger.js +0 -16
- package/helpers/redis/clearNamespace.js +0 -14
- package/helpers/yup.js +0 -22
- package/index.js +0 -8
- package/jsconfig.json +0 -9
- package/models/Lock.js +0 -107
- package/models/Migration.js +0 -15
- package/models/Sequence.js +0 -22
- package/models/User.js +0 -280
- package/modules/AbstractCommand.js +0 -52
- package/modules/AbstractConnector.js +0 -9
- package/modules/AbstractController.js +0 -406
- package/modules/AbstractModel.d.ts +0 -48
- package/modules/AbstractModel.js +0 -92
- package/modules/Base.d.ts +0 -37
- package/modules/Base.js +0 -64
- package/modules/BaseCli.js +0 -157
- package/server.d.ts +0 -100
- package/server.js +0 -439
- package/services/cache/Cache.d.ts +0 -35
- package/services/cache/Cache.js +0 -124
- package/services/documentation/DocumentationGenerator.js +0 -169
- package/services/http/HttpServer.js +0 -89
- package/services/http/middleware/AbstractMiddleware.js +0 -51
- package/services/http/middleware/Auth.js +0 -20
- package/services/http/middleware/Cors.js +0 -46
- package/services/http/middleware/GetUserByToken.js +0 -47
- package/services/http/middleware/I18n.js +0 -117
- package/services/http/middleware/IpDetector.js +0 -59
- package/services/http/middleware/Pagination.js +0 -57
- package/services/http/middleware/PrepareAppInfo.js +0 -18
- package/services/http/middleware/RateLimiter.js +0 -134
- package/services/http/middleware/RequestLogger.js +0 -22
- package/services/http/middleware/RequestParser.js +0 -40
- package/services/http/middleware/Role.js +0 -29
- package/services/messaging/email/templates/.gitkeep +0 -0
- package/services/validate/ValidateService.js +0 -157
- package/services/validate/drivers/AbstractValidator.js +0 -37
- package/services/validate/drivers/CustomValidator.js +0 -51
- package/services/validate/drivers/YupValidator.js +0 -103
- package/tests/globalSetupVitest.js +0 -35
- package/tests/setup.js +0 -120
- package/tests/setupVitest.js +0 -111
- package/types/Expand.d.ts +0 -11
- package/types/ICommandArguments.d.ts +0 -41
- package/types/TFoldersConfig.d.ts +0 -20
- package/views/404.pug +0 -3
- package/views/home.pug +0 -3
- package/views/layouts/base.pug +0 -39
- package/vitest.config.js +0 -17
- /package/{commands → dist/migrations}/.gitkeep +0 -0
- /package/{services → dist/services}/messaging/email/resources/.gitkeep +0 -0
- /package/{migrations → dist/services/messaging/email/templates}/.gitkeep +0 -0
- /package/{services → dist/services}/messaging/email/templates/recovery/html.pug +0 -0
- /package/{services → dist/services}/messaging/email/templates/recovery/subject.pug +0 -0
- /package/{services → dist/services}/messaging/email/templates/recovery/text.pug +0 -0
- /package/{services → dist/services}/messaging/email/templates/verification/html.pug +0 -0
- /package/{services → dist/services}/messaging/email/templates/verification/subject.pug +0 -0
- /package/{services → dist/services}/messaging/email/templates/verification/text.pug +0 -0
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import type winston from 'winston';
|
|
2
|
+
import type { IApp } from '../server.ts';
|
|
3
|
+
declare class Base {
|
|
4
|
+
#private;
|
|
5
|
+
app: IApp;
|
|
6
|
+
constructor(app: IApp);
|
|
7
|
+
/**
|
|
8
|
+
* In case of logging sometimes we might need to replace name
|
|
9
|
+
*/
|
|
10
|
+
getConstructorName(): string;
|
|
11
|
+
/**
|
|
12
|
+
* Optimzation to lazy load logger. It will be inited only on request
|
|
13
|
+
*/
|
|
14
|
+
get logger(): winston.Logger;
|
|
15
|
+
/**
|
|
16
|
+
* Get winston loger for given label
|
|
17
|
+
* @param {string} label name of logger
|
|
18
|
+
*/
|
|
19
|
+
getLogger(label: string): winston.Logger;
|
|
20
|
+
getFilesPathWithInheritance(internalFolder: string, externalFolder: string, isUseSimpleLogger?: boolean): Promise<{
|
|
21
|
+
path: string;
|
|
22
|
+
file: string;
|
|
23
|
+
}[]>;
|
|
24
|
+
/**
|
|
25
|
+
* Return logger group. Just to have all logs groupped logically
|
|
26
|
+
*/
|
|
27
|
+
static get loggerGroup(): string;
|
|
28
|
+
}
|
|
29
|
+
export default Base;
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
import { getFilesPathWithInheritance } from "../helpers/files.js";
|
|
2
|
+
import { consoleLogger, noopLogger } from "../helpers/logger.js";
|
|
3
|
+
class Base {
|
|
4
|
+
#realLogger = null;
|
|
5
|
+
app;
|
|
6
|
+
constructor(app) {
|
|
7
|
+
this.app = app;
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* In case of logging sometimes we might need to replace name
|
|
11
|
+
*/
|
|
12
|
+
getConstructorName() {
|
|
13
|
+
return this.constructor.name;
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* Optimzation to lazy load logger. It will be inited only on request
|
|
17
|
+
*/
|
|
18
|
+
get logger() {
|
|
19
|
+
let current;
|
|
20
|
+
try {
|
|
21
|
+
current = this.#realLogger;
|
|
22
|
+
}
|
|
23
|
+
catch {
|
|
24
|
+
// `this` is not a real `Base` instance (private field read threw) — e.g.
|
|
25
|
+
// accessed through a model proxy. Warn (every access, as before) and
|
|
26
|
+
// return the no-op logger so callers never get null.
|
|
27
|
+
console.warn('logger accessed outside a Base instance (e.g. a model proxy); using a no-op logger — logs from this context are dropped. This can be ok for models.');
|
|
28
|
+
return noopLogger;
|
|
29
|
+
}
|
|
30
|
+
if (!current) {
|
|
31
|
+
const { loggerGroup } = this.constructor;
|
|
32
|
+
current = this.getLogger(loggerGroup + this.getConstructorName());
|
|
33
|
+
this.#realLogger = current;
|
|
34
|
+
}
|
|
35
|
+
return current;
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* Get winston loger for given label
|
|
39
|
+
* @param {string} label name of logger
|
|
40
|
+
*/
|
|
41
|
+
getLogger(label) {
|
|
42
|
+
return this.app.logger.child({ label });
|
|
43
|
+
}
|
|
44
|
+
async getFilesPathWithInheritance(internalFolder, externalFolder, isUseSimpleLogger = false) {
|
|
45
|
+
const logger = isUseSimpleLogger
|
|
46
|
+
? (m) => consoleLogger('info', m)
|
|
47
|
+
: (m) => this.logger?.verbose(m);
|
|
48
|
+
return getFilesPathWithInheritance({
|
|
49
|
+
internalFolder,
|
|
50
|
+
externalFolder,
|
|
51
|
+
logger,
|
|
52
|
+
});
|
|
53
|
+
}
|
|
54
|
+
/**
|
|
55
|
+
* Return logger group. Just to have all logs groupped logically
|
|
56
|
+
*/
|
|
57
|
+
static get loggerGroup() {
|
|
58
|
+
return 'Base_please_overwrite_';
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
export default Base;
|
|
62
|
+
//# sourceMappingURL=Base.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Base.js","sourceRoot":"","sources":["../../src/modules/Base.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,2BAA2B,EAAE,MAAM,qBAAqB,CAAC;AAClE,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAGjE,MAAM,IAAI;IACR,WAAW,GAA0B,IAAI,CAAC;IAE1C,GAAG,CAAO;IAEV,YAAY,GAAS;QACnB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IACjB,CAAC;IAED;;OAEG;IACH,kBAAkB;QAChB,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IAC/B,CAAC;IAED;;OAEG;IACH,IAAI,MAAM;QACR,IAAI,OAA8B,CAAC;QACnC,IAAI,CAAC;YACH,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC;QAC7B,CAAC;QAAC,MAAM,CAAC;YACP,yEAAyE;YACzE,qEAAqE;YACrE,qDAAqD;YACrD,OAAO,CAAC,IAAI,CACV,qJAAqJ,CACtJ,CAAC;YACF,OAAO,UAAU,CAAC;QACpB,CAAC;QAED,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC,WAA0B,CAAC;YACxD,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC,CAAC;YAClE,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC;QAC7B,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;OAGG;IACH,SAAS,CAAC,KAAa;QACrB,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IAC1C,CAAC;IAED,KAAK,CAAC,2BAA2B,CAC/B,cAAsB,EACtB,cAAsB,EACtB,iBAAiB,GAAG,KAAK;QAEzB,MAAM,MAAM,GAAG,iBAAiB;YAC9B,CAAC,CAAC,CAAC,CAAS,EAAE,EAAE,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC,CAAC;YACzC,CAAC,CAAC,CAAC,CAAS,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;QAC3C,OAAO,2BAA2B,CAAC;YACjC,cAAc;YACd,cAAc;YACd,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,MAAM,KAAK,WAAW;QACpB,OAAO,wBAAwB,CAAC;IAClC,CAAC;CACF;AAED,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import type { ParseArgsOptionDescriptor } from 'node:util';
|
|
2
|
+
import type AbstractCommand from '../modules/AbstractCommand.ts';
|
|
3
|
+
import type Server from '../server.ts';
|
|
4
|
+
import Base from './Base.ts';
|
|
5
|
+
export interface ParseArgsOptionsConfigExtended extends ParseArgsOptionDescriptor {
|
|
6
|
+
/**
|
|
7
|
+
* A description of the option.
|
|
8
|
+
*/
|
|
9
|
+
description?: string;
|
|
10
|
+
/**
|
|
11
|
+
* Is it required?
|
|
12
|
+
*/
|
|
13
|
+
required?: boolean;
|
|
14
|
+
}
|
|
15
|
+
declare class Cli extends Base {
|
|
16
|
+
server: Server;
|
|
17
|
+
commands: Record<string, string>;
|
|
18
|
+
constructor(server: Server);
|
|
19
|
+
loadCommands(): Promise<boolean>;
|
|
20
|
+
printCommandTable(): Promise<void>;
|
|
21
|
+
static showHelp(Command: typeof AbstractCommand, finalArguments: Record<string, ParseArgsOptionsConfigExtended>): void;
|
|
22
|
+
run(command: string): Promise<boolean | undefined>;
|
|
23
|
+
static get loggerGroup(): string;
|
|
24
|
+
}
|
|
25
|
+
export default Cli;
|
|
@@ -0,0 +1,159 @@
|
|
|
1
|
+
var __rewriteRelativeImportExtension = (this && this.__rewriteRelativeImportExtension) || function (path, preserveJsx) {
|
|
2
|
+
if (typeof path === "string" && /^\.\.?\//.test(path)) {
|
|
3
|
+
return path.replace(/\.(tsx)$|((?:\.d)?)((?:\.[^./]+?)?)\.([cm]?)ts$/i, function (m, tsx, d, ext, cm) {
|
|
4
|
+
return tsx ? preserveJsx ? ".jsx" : ".js" : d && (!ext || !cm) ? m : (d + ext + "." + cm.toLowerCase() + "js");
|
|
5
|
+
});
|
|
6
|
+
}
|
|
7
|
+
return path;
|
|
8
|
+
};
|
|
9
|
+
import path from 'node:path';
|
|
10
|
+
import * as url from 'node:url';
|
|
11
|
+
import { parseArgs } from 'node:util';
|
|
12
|
+
import Base from "./Base.js";
|
|
13
|
+
class Cli extends Base {
|
|
14
|
+
server;
|
|
15
|
+
commands;
|
|
16
|
+
constructor(server) {
|
|
17
|
+
super(server.app);
|
|
18
|
+
this.server = server;
|
|
19
|
+
this.commands = {};
|
|
20
|
+
}
|
|
21
|
+
async loadCommands() {
|
|
22
|
+
if (Object.keys(this.commands).length) {
|
|
23
|
+
return true;
|
|
24
|
+
}
|
|
25
|
+
console.info('Loading commands...');
|
|
26
|
+
console.time('Loading commands. Time');
|
|
27
|
+
const dirname = url.fileURLToPath(new URL('.', import.meta.url));
|
|
28
|
+
const commandsToLoad = await this.getFilesPathWithInheritance(path.join(dirname, '../commands'), this.server.app.foldersConfig.commands, true);
|
|
29
|
+
for (const com of commandsToLoad) {
|
|
30
|
+
if (com.file.endsWith('.js') || com.file.endsWith('.ts')) {
|
|
31
|
+
const c = com.file.replace(/\.[jt]s$/, ''); // strip only the extension suffix
|
|
32
|
+
if (this.commands[c.toLowerCase()]) {
|
|
33
|
+
this.logger?.warn(`Command ${c.toLowerCase()} already exists with full path ${this.commands[c.toLowerCase()]}. Possible problems - you have two commands with "ts" and "js" extensions. Skipping...`);
|
|
34
|
+
continue;
|
|
35
|
+
}
|
|
36
|
+
this.commands[c.toLowerCase()] = com.path;
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
console.timeEnd('Loading commands. Time');
|
|
40
|
+
console.log(' ');
|
|
41
|
+
return true;
|
|
42
|
+
}
|
|
43
|
+
async printCommandTable() {
|
|
44
|
+
const commands = Object.keys(this.commands).sort();
|
|
45
|
+
const maxLength = commands.reduce((max, c) => Math.max(max, c.length), 0);
|
|
46
|
+
console.log('Available commands:');
|
|
47
|
+
const commandsClasses = [];
|
|
48
|
+
for (const c of commands) {
|
|
49
|
+
commandsClasses.push(import(__rewriteRelativeImportExtension(this.commands[c])));
|
|
50
|
+
}
|
|
51
|
+
const commandsClassesLoaded = await Promise.all(commandsClasses);
|
|
52
|
+
for (const [key, c] of Object.entries(commands)) {
|
|
53
|
+
console.log(` \x1b[36m${c.padEnd(maxLength)}\x1b[0m - ${commandsClassesLoaded[+key].default.description}`);
|
|
54
|
+
}
|
|
55
|
+
console.log('\nUsage (use one of option): \n node cli.ts <command> [options] \n npm run cli <command> -- [options]');
|
|
56
|
+
}
|
|
57
|
+
static showHelp(Command, finalArguments) {
|
|
58
|
+
console.log(`\n\x1b[32m${Command.description}\x1b[0m`);
|
|
59
|
+
let output = '';
|
|
60
|
+
Object.entries(finalArguments).forEach(([key, opt]) => {
|
|
61
|
+
const outputLocal = [];
|
|
62
|
+
outputLocal.push(`\n\x1b[36m --${key} \x1b[0m`);
|
|
63
|
+
if (opt.type !== 'boolean') {
|
|
64
|
+
outputLocal.push(`<${opt.type}>`);
|
|
65
|
+
}
|
|
66
|
+
if (opt.required) {
|
|
67
|
+
outputLocal.push('(required)');
|
|
68
|
+
}
|
|
69
|
+
outputLocal.push(`\n \x1b[2m${opt.description}`);
|
|
70
|
+
if (opt.default !== undefined) {
|
|
71
|
+
outputLocal.push(` (default: ${opt.default})`);
|
|
72
|
+
}
|
|
73
|
+
outputLocal.push('\x1b[0m');
|
|
74
|
+
output += outputLocal.join(' ');
|
|
75
|
+
});
|
|
76
|
+
console.log(output);
|
|
77
|
+
}
|
|
78
|
+
async run(command) {
|
|
79
|
+
await this.loadCommands();
|
|
80
|
+
if (!command) {
|
|
81
|
+
console.log('Please provide command name');
|
|
82
|
+
await this.printCommandTable();
|
|
83
|
+
return false;
|
|
84
|
+
}
|
|
85
|
+
if (!this.commands[command]) {
|
|
86
|
+
console.log(`Command ${command} not found `);
|
|
87
|
+
await this.printCommandTable();
|
|
88
|
+
return false;
|
|
89
|
+
}
|
|
90
|
+
console.info(`Running command: '${command}'`);
|
|
91
|
+
const commandModule = await import(__rewriteRelativeImportExtension(this.commands[command]));
|
|
92
|
+
const Command = commandModule.default;
|
|
93
|
+
const defaultArgs = {
|
|
94
|
+
help: {
|
|
95
|
+
type: 'boolean',
|
|
96
|
+
description: 'Show help',
|
|
97
|
+
},
|
|
98
|
+
};
|
|
99
|
+
const finalArguments = {
|
|
100
|
+
...Command.commandArguments,
|
|
101
|
+
...defaultArgs,
|
|
102
|
+
};
|
|
103
|
+
let parsedArgs;
|
|
104
|
+
try {
|
|
105
|
+
parsedArgs = parseArgs({
|
|
106
|
+
args: process.argv.slice(3), // remove command name
|
|
107
|
+
options: finalArguments,
|
|
108
|
+
tokens: true,
|
|
109
|
+
allowNegative: true,
|
|
110
|
+
});
|
|
111
|
+
}
|
|
112
|
+
catch (e) {
|
|
113
|
+
// strict parseArgs throws on an unknown flag — show usage instead of an
|
|
114
|
+
// uncaught crash.
|
|
115
|
+
console.log(`\x1b[31m${e instanceof Error ? e.message : e}\x1b[0m`);
|
|
116
|
+
Cli.showHelp(Command, finalArguments);
|
|
117
|
+
return false;
|
|
118
|
+
}
|
|
119
|
+
if (parsedArgs.values.help) {
|
|
120
|
+
Cli.showHelp(Command, finalArguments);
|
|
121
|
+
return true;
|
|
122
|
+
}
|
|
123
|
+
for (const [key, opt] of Object.entries(finalArguments)) {
|
|
124
|
+
// `=== undefined` so an explicitly-provided falsy value (`--name=""`,
|
|
125
|
+
// `--flag=false`) still satisfies a required check.
|
|
126
|
+
if (opt.required && parsedArgs.values[key] === undefined) {
|
|
127
|
+
console.log(`\x1b[31mRequired field not proivded. Please provide "${key}" argument\x1b[0m`);
|
|
128
|
+
Cli.showHelp(Command, finalArguments);
|
|
129
|
+
return false;
|
|
130
|
+
}
|
|
131
|
+
}
|
|
132
|
+
if (Command.isShouldGetModelPaths) {
|
|
133
|
+
console.info(`Command ${command} isShouldGetModelPaths called. We are loading model paths`);
|
|
134
|
+
await this.server.getModelFilesPathsWithInheritance();
|
|
135
|
+
}
|
|
136
|
+
if (Command.isShouldInitModels) {
|
|
137
|
+
console.info(`Command ${command} isShouldInitModels called. If you want to skip loading and init models, please set isShouldInitModels to false in your command`);
|
|
138
|
+
// Only set when the operator hasn't — don't clobber a user-provided value.
|
|
139
|
+
if (!process.env.MONGO_APP_NAME) {
|
|
140
|
+
process.env.MONGO_APP_NAME = Command.getMongoConnectionName(command, parsedArgs.values);
|
|
141
|
+
}
|
|
142
|
+
await this.server.initAllModels({ waitForConnection: true });
|
|
143
|
+
}
|
|
144
|
+
else {
|
|
145
|
+
console.info(`Command ${command} NOT need to isShouldInitModels`);
|
|
146
|
+
}
|
|
147
|
+
const c = new Command(this.app, this.commands, parsedArgs.values);
|
|
148
|
+
const result = await c.run().catch((e) => {
|
|
149
|
+
this.logger?.error(e.stack);
|
|
150
|
+
return undefined;
|
|
151
|
+
});
|
|
152
|
+
return result;
|
|
153
|
+
}
|
|
154
|
+
static get loggerGroup() {
|
|
155
|
+
return 'CLI_';
|
|
156
|
+
}
|
|
157
|
+
}
|
|
158
|
+
export default Cli;
|
|
159
|
+
//# sourceMappingURL=BaseCli.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"BaseCli.js","sourceRoot":"","sources":["../../src/modules/BaseCli.ts"],"names":[],"mappings":";;;;;;;;AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,KAAK,GAAG,MAAM,UAAU,CAAC;AAEhC,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAGtC,OAAO,IAAI,MAAM,WAAW,CAAC;AAe7B,MAAM,GAAI,SAAQ,IAAI;IACpB,MAAM,CAAS;IACf,QAAQ,CAAyB;IAEjC,YAAY,MAAc;QACxB,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAClB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;IACrB,CAAC;IAED,KAAK,CAAC,YAAY;QAChB,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,EAAE,CAAC;YACtC,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;QACpC,OAAO,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;QACvC,MAAM,OAAO,GAAG,GAAG,CAAC,aAAa,CAAC,IAAI,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QACjE,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,2BAA2B,CAC3D,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,aAAa,CAAC,EACjC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,QAAQ,EACtC,IAAI,CACL,CAAC;QACF,KAAK,MAAM,GAAG,IAAI,cAAc,EAAE,CAAC;YACjC,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzD,MAAM,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,CAAC,kCAAkC;gBAC9E,IAAI,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;oBACnC,IAAI,CAAC,MAAM,EAAE,IAAI,CACf,WAAW,CAAC,CAAC,WAAW,EAAE,kCAAkC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,wFAAwF,CACnL,CAAC;oBACF,SAAS;gBACX,CAAC;gBACD,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC;YAC5C,CAAC;QACH,CAAC;QACD,OAAO,CAAC,OAAO,CAAC,wBAAwB,CAAC,CAAC;QAC1C,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAEjB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,iBAAiB;QACrB,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC;QACnD,MAAM,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;QAC1E,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;QACnC,MAAM,eAAe,GAAG,EAAE,CAAC;QAC3B,KAAK,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC;YACzB,eAAe,CAAC,IAAI,CAAC,MAAM,kCAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAC,CAAC,CAAC;QACjD,CAAC;QACD,MAAM,qBAAqB,GAEvB,MAAM,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;QACvC,KAAK,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;YAChD,OAAO,CAAC,GAAG,CACT,YAAY,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,aAAa,qBAAqB,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,CAC9F,CAAC;QACJ,CAAC;QACD,OAAO,CAAC,GAAG,CACT,wGAAwG,CACzG,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,QAAQ,CACb,OAA+B,EAC/B,cAA8D;QAE9D,OAAO,CAAC,GAAG,CAAC,aAAa,OAAO,CAAC,WAAW,SAAS,CAAC,CAAC;QACvD,IAAI,MAAM,GAAG,EAAE,CAAC;QAEhB,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,EAAE;YACpD,MAAM,WAAW,GAAG,EAAE,CAAC;YACvB,WAAW,CAAC,IAAI,CAAC,iBAAiB,GAAG,UAAU,CAAC,CAAC;YACjD,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;gBAC3B,WAAW,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC;YACpC,CAAC;YACD,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;gBACjB,WAAW,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACjC,CAAC;YACD,WAAW,CAAC,IAAI,CAAC,kBAAkB,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC;YACtD,IAAI,GAAG,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;gBAC9B,WAAW,CAAC,IAAI,CAAC,cAAc,GAAG,CAAC,OAAO,GAAG,CAAC,CAAC;YACjD,CAAC;YACD,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC5B,MAAM,IAAI,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;QAEH,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACtB,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,OAAe;QACvB,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;QAE1B,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC;YAC3C,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC/B,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;YAC5B,OAAO,CAAC,GAAG,CAAC,WAAW,OAAO,aAAa,CAAC,CAAC;YAC7C,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC/B,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,qBAAqB,OAAO,GAAG,CAAC,CAAC;QAC9C,MAAM,aAAa,GAAwC,MAAM,MAAM,kCACrE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EACvB,CAAC;QACF,MAAM,OAAO,GAA2B,aAAa,CAAC,OAAO,CAAC;QAE9D,MAAM,WAAW,GAAmD;YAClE,IAAI,EAAE;gBACJ,IAAI,EAAE,SAAS;gBACf,WAAW,EAAE,WAAW;aACzB;SACF,CAAC;QAEF,MAAM,cAAc,GAAG;YACrB,GAAG,OAAO,CAAC,gBAAgB;YAC3B,GAAG,WAAW;SACf,CAAC;QAEF,IAAI,UAAwC,CAAC;QAC7C,IAAI,CAAC;YACH,UAAU,GAAG,SAAS,CAAC;gBACrB,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,sBAAsB;gBACnD,OAAO,EAAE,cAAc;gBACvB,MAAM,EAAE,IAAI;gBACZ,aAAa,EAAE,IAAI;aACpB,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,wEAAwE;YACxE,kBAAkB;YAClB,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;YACpE,GAAG,CAAC,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;YACtC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,UAAU,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;YAC3B,GAAG,CAAC,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;YACtC,OAAO,IAAI,CAAC;QACd,CAAC;QAED,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC;YACxD,sEAAsE;YACtE,oDAAoD;YACpD,IAAI,GAAG,CAAC,QAAQ,IAAI,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE,CAAC;gBACzD,OAAO,CAAC,GAAG,CACT,wDAAwD,GAAG,mBAAmB,CAC/E,CAAC;gBACF,GAAG,CAAC,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;gBACtC,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;QAED,IAAI,OAAO,CAAC,qBAAqB,EAAE,CAAC;YAClC,OAAO,CAAC,IAAI,CACV,WAAW,OAAO,2DAA2D,CAC9E,CAAC;YACF,MAAM,IAAI,CAAC,MAAM,CAAC,iCAAiC,EAAE,CAAC;QACxD,CAAC;QAED,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC;YAC/B,OAAO,CAAC,IAAI,CACV,WAAW,OAAO,iIAAiI,CACpJ,CAAC;YACF,2EAA2E;YAC3E,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC;gBAChC,OAAO,CAAC,GAAG,CAAC,cAAc,GAAG,OAAO,CAAC,sBAAsB,CACzD,OAAO,EACP,UAAU,CAAC,MAAM,CAClB,CAAC;YACJ,CAAC;YACD,MAAM,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,CAAC;QAC/D,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,IAAI,CAAC,WAAW,OAAO,iCAAiC,CAAC,CAAC;QACpE,CAAC;QAED,MAAM,CAAC,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;QAElE,MAAM,MAAM,GAAG,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC,CAAqB,EAAE,EAAE;YAC3D,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;YAC5B,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,MAAM,KAAK,WAAW;QACpB,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAED,eAAe,GAAG,CAAC"}
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
import type { HydratedDocument, InferRawDocType, Schema } from 'mongoose';
|
|
2
|
+
import { type Model } from 'mongoose';
|
|
3
|
+
export type Merge<M, N> = Omit<M, keyof N> & N;
|
|
4
|
+
export type WithTimestamps<TOptions> = TOptions extends {
|
|
5
|
+
timestamps: true;
|
|
6
|
+
} ? {
|
|
7
|
+
createdAt: Schema.Types.Date;
|
|
8
|
+
updatedAt: Schema.Types.Date;
|
|
9
|
+
} : TOptions extends {
|
|
10
|
+
timestamps: false;
|
|
11
|
+
} ? object : {
|
|
12
|
+
createdAt: Schema.Types.Date;
|
|
13
|
+
updatedAt: Schema.Types.Date;
|
|
14
|
+
};
|
|
15
|
+
export type ExtractProperty<T, K extends PropertyKey, Default = object> = T extends {
|
|
16
|
+
[P in K]: infer R;
|
|
17
|
+
} ? R : Default;
|
|
18
|
+
export type GetModelSchemaTypeFromClass<T extends typeof BaseModel> = Schema<InferRawDocType<ExtractProperty<T, 'modelSchema'> & WithTimestamps<Merge<typeof defaultOptions, ExtractProperty<T, 'schemaOptions'>>>>, // TRawDocType
|
|
19
|
+
Model<InferRawDocType<ExtractProperty<T, 'modelSchema'> & WithTimestamps<Merge<typeof defaultOptions, ExtractProperty<T, 'schemaOptions'>>>>, object, // TQueryHelpers
|
|
20
|
+
ExtractProperty<T, 'modelInstanceMethods'>, // TInstanceMethods
|
|
21
|
+
ExtractProperty<T, 'modelVirtuals'>>, // TModelType
|
|
22
|
+
ExtractProperty<T, 'modelInstanceMethods'>, // TInstanceMethods
|
|
23
|
+
object, // TQueryHelpers
|
|
24
|
+
ExtractProperty<T, 'modelVirtuals'>, // TVirtuals
|
|
25
|
+
ExtractProperty<T, 'modelStatics'>, // TStaticMethods
|
|
26
|
+
ExtractProperty<T, 'schemaOptions'>>;
|
|
27
|
+
export type VirtualType<T> = {
|
|
28
|
+
[P in keyof T]: T[P] extends {
|
|
29
|
+
get: () => infer R;
|
|
30
|
+
} ? R : never;
|
|
31
|
+
};
|
|
32
|
+
export type GetModelTypeFromClass<T extends typeof BaseModel> = Model<InferRawDocType<ExtractProperty<T, 'modelSchema'> & WithTimestamps<Merge<typeof defaultOptions, ExtractProperty<T, 'schemaOptions'>>>>, // TRawDocType
|
|
33
|
+
object, // TQueryHelpers
|
|
34
|
+
ExtractProperty<T, 'modelInstanceMethods'>, // TInstanceMethods
|
|
35
|
+
ExtractProperty<T, 'modelVirtuals'>, // TVirtuals
|
|
36
|
+
HydratedDocument<InferRawDocType<ExtractProperty<T, 'modelSchema'> & WithTimestamps<Merge<typeof defaultOptions, ExtractProperty<T, 'schemaOptions'>>>>, //TRawDocType
|
|
37
|
+
//TRawDocType
|
|
38
|
+
VirtualType<ExtractProperty<T, 'modelVirtuals'>> & ExtractProperty<T, 'modelInstanceMethods'> & {
|
|
39
|
+
id: string;
|
|
40
|
+
}, // TVirtuals & TInstanceMethods
|
|
41
|
+
object, // TQueryHelpers
|
|
42
|
+
ExtractProperty<T, 'modelVirtuals'>>, GetModelSchemaTypeFromClass<T>> & ExtractProperty<T, 'modelStatics'>;
|
|
43
|
+
export type GetModelTypeLiteFromSchema<T extends typeof BaseModel.modelSchema, TOptions = object> = Model<InferRawDocType<T & WithTimestamps<Merge<typeof defaultOptions, TOptions>>>>;
|
|
44
|
+
export declare const defaultOptions: {
|
|
45
|
+
readonly timestamps: true;
|
|
46
|
+
readonly minimize: false;
|
|
47
|
+
};
|
|
48
|
+
export type TBaseModel = GetModelTypeFromClass<typeof BaseModel>;
|
|
49
|
+
export declare class BaseModel {
|
|
50
|
+
static get modelSchema(): {};
|
|
51
|
+
static get schemaOptions(): {};
|
|
52
|
+
static get modelInstanceMethods(): {};
|
|
53
|
+
static get modelVirtuals(): {};
|
|
54
|
+
static get modelStatics(): {};
|
|
55
|
+
static initHooks(_schema: Schema): void;
|
|
56
|
+
static initialize<T extends typeof BaseModel>(this: T): GetModelTypeFromClass<T>;
|
|
57
|
+
}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import mongoose, {} from 'mongoose';
|
|
2
|
+
export const defaultOptions = { timestamps: true, minimize: false };
|
|
3
|
+
// biome-ignore lint/complexity/noStaticOnlyClass: TODO think about it in future
|
|
4
|
+
export class BaseModel {
|
|
5
|
+
static get modelSchema() {
|
|
6
|
+
return {};
|
|
7
|
+
}
|
|
8
|
+
static get schemaOptions() {
|
|
9
|
+
return {};
|
|
10
|
+
}
|
|
11
|
+
static get modelInstanceMethods() {
|
|
12
|
+
return {};
|
|
13
|
+
}
|
|
14
|
+
static get modelVirtuals() {
|
|
15
|
+
return {};
|
|
16
|
+
}
|
|
17
|
+
static get modelStatics() {
|
|
18
|
+
return {};
|
|
19
|
+
}
|
|
20
|
+
static initHooks(_schema) {
|
|
21
|
+
// Add hooks here
|
|
22
|
+
}
|
|
23
|
+
// Properly typed static method with generic constraints
|
|
24
|
+
static initialize() {
|
|
25
|
+
const schema = new mongoose.Schema(this.modelSchema, {
|
|
26
|
+
...defaultOptions,
|
|
27
|
+
...this.schemaOptions,
|
|
28
|
+
methods: this.modelInstanceMethods,
|
|
29
|
+
statics: this.modelStatics,
|
|
30
|
+
virtuals: this.modelVirtuals,
|
|
31
|
+
});
|
|
32
|
+
this.initHooks(schema);
|
|
33
|
+
const mongooseModel = mongoose.model(this.name, schema);
|
|
34
|
+
return mongooseModel;
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
//# sourceMappingURL=BaseModel.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"BaseModel.js","sourceRoot":"","sources":["../../src/modules/BaseModel.ts"],"names":[],"mappings":"AAOA,OAAO,QAAQ,EAAE,EAAc,MAAM,UAAU,CAAC;AAgFhD,MAAM,CAAC,MAAM,cAAc,GAAG,EAAE,UAAU,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAW,CAAC;AAG7E,gFAAgF;AAChF,MAAM,OAAO,SAAS;IACpB,MAAM,KAAK,WAAW;QACpB,OAAO,EAAW,CAAC;IACrB,CAAC;IAED,MAAM,KAAK,aAAa;QACtB,OAAO,EAAW,CAAC;IACrB,CAAC;IAED,MAAM,KAAK,oBAAoB;QAC7B,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,KAAK,aAAa;QACtB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,KAAK,YAAY;QACrB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,CAAC,SAAS,CAAC,OAAe;QAC9B,iBAAiB;IACnB,CAAC;IAED,wDAAwD;IACjD,MAAM,CAAC,UAAU;QACtB,MAAM,MAAM,GAAG,IAAI,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE;YACnD,GAAG,cAAc;YACjB,GAAI,IAAI,CAAC,aAA+B;YACxC,OAAO,EAAE,IAAI,CAAC,oBAAoB;YAClC,OAAO,EAAE,IAAI,CAAC,YAAY;YAC1B,QAAQ,EAAE,IAAI,CAAC,aAAa;SAC7B,CAAmC,CAAC;QAErC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAEvB,MAAM,aAAa,GAAG,QAAQ,CAAC,KAAK,CAClC,IAAI,CAAC,IAAI,EACT,MAAM,CACqB,CAAC;QAE9B,OAAO,aAAa,CAAC;IACvB,CAAC;CACF"}
|
package/dist/server.d.ts
ADDED
|
@@ -0,0 +1,130 @@
|
|
|
1
|
+
import EventEmitter from 'node:events';
|
|
2
|
+
import winston from 'winston';
|
|
3
|
+
import type ControllerManager from './controllers/index.ts';
|
|
4
|
+
import type { TFolderConfig, TFolderConfigFolders } from './folderConfig.ts';
|
|
5
|
+
import type AbstractModel from './modules/AbstractModel.ts';
|
|
6
|
+
import type BaseCli from './modules/BaseCli.ts';
|
|
7
|
+
import type { BaseModel, TBaseModel } from './modules/BaseModel.ts';
|
|
8
|
+
import Cache from './services/cache/Cache.ts';
|
|
9
|
+
import type HttpServer from './services/http/HttpServer.ts';
|
|
10
|
+
import type { I18n } from './services/i18n/I18n.ts';
|
|
11
|
+
interface AppCache {
|
|
12
|
+
configs: Map<string, unknown>;
|
|
13
|
+
models: Map<string, AbstractModel['mongooseModel'] | TBaseModel>;
|
|
14
|
+
modelConstructors: Map<string, typeof AbstractModel | typeof BaseModel>;
|
|
15
|
+
modelPaths: {
|
|
16
|
+
path: string;
|
|
17
|
+
file: string;
|
|
18
|
+
}[];
|
|
19
|
+
}
|
|
20
|
+
export interface IApp {
|
|
21
|
+
getConfig(configName: string): Record<string, unknown>;
|
|
22
|
+
getModel(modelName: string): AbstractModel['mongooseModel'] | false | TBaseModel;
|
|
23
|
+
runCliCommand(commandName: string): Promise<boolean | undefined>;
|
|
24
|
+
updateConfig(configName: string, config: Record<string, unknown>): Record<string, unknown>;
|
|
25
|
+
getI18nService(): Promise<I18n>;
|
|
26
|
+
foldersConfig: TFolderConfigFolders;
|
|
27
|
+
events: EventEmitter;
|
|
28
|
+
readonly cache: Cache;
|
|
29
|
+
readonly logger: winston.Logger;
|
|
30
|
+
httpServer: null | HttpServer;
|
|
31
|
+
controllerManager: null | ControllerManager;
|
|
32
|
+
frameworkFolder: string;
|
|
33
|
+
internalFilesCache: AppCache;
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
* Main framework class.
|
|
37
|
+
*/
|
|
38
|
+
declare class Server {
|
|
39
|
+
#private;
|
|
40
|
+
cli: null | BaseCli;
|
|
41
|
+
config: TFolderConfig;
|
|
42
|
+
cache: AppCache;
|
|
43
|
+
cacheService: null | Cache;
|
|
44
|
+
app: IApp;
|
|
45
|
+
/**
|
|
46
|
+
* Construct new server
|
|
47
|
+
* @param {Object} config main config object
|
|
48
|
+
* @param {Object} config.folders folders config
|
|
49
|
+
* @param {String} config.folders.config path to folder with config files
|
|
50
|
+
* @param {String} config.folders.models path to folder with moidels files
|
|
51
|
+
* @param {String} config.folders.controllers path to folder with controllers files
|
|
52
|
+
* @param {String} config.folders.locales path to folder with locales files
|
|
53
|
+
* @param {String} [config.folders.emails] path to folder with emails files
|
|
54
|
+
* @param {String} config.folders.commands path to folder with commands files
|
|
55
|
+
* @param {String} config.folders.migrations path to folder with migrations files
|
|
56
|
+
*/
|
|
57
|
+
constructor(config: TFolderConfig);
|
|
58
|
+
/**
|
|
59
|
+
* Start server (http + init all http ralated functions)
|
|
60
|
+
* @param {Function} callbackBefore404 code that should be executed before adding page 404
|
|
61
|
+
*/
|
|
62
|
+
startServer(callbackBefore404?: () => Promise<void>): Promise<void>;
|
|
63
|
+
/**
|
|
64
|
+
* Do an initialization (config reading, etc)
|
|
65
|
+
*/
|
|
66
|
+
init({ isSkipModelInit, isSkipModelLoading, }?: {
|
|
67
|
+
isSkipModelInit?: boolean | undefined;
|
|
68
|
+
isSkipModelLoading?: boolean | undefined;
|
|
69
|
+
}): Promise<boolean>;
|
|
70
|
+
/**
|
|
71
|
+
* Load model and init them.
|
|
72
|
+
*
|
|
73
|
+
* `waitForConnection` (model-using CLI commands): block until the mongoose
|
|
74
|
+
* connection is actually established before returning, so the command's first
|
|
75
|
+
* query doesn't race a not-yet-ready connection. The HTTP server leaves it
|
|
76
|
+
* `false` — it kicks the connection off and lets requests buffer until ready.
|
|
77
|
+
* Schema registration below never needs a live connection either way.
|
|
78
|
+
*/
|
|
79
|
+
initAllModels({ waitForConnection, }?: {
|
|
80
|
+
waitForConnection?: boolean;
|
|
81
|
+
}): Promise<void>;
|
|
82
|
+
getModelFilesPathsWithInheritance(): Promise<{
|
|
83
|
+
path: string;
|
|
84
|
+
file: string;
|
|
85
|
+
}[]>;
|
|
86
|
+
/**
|
|
87
|
+
* Add error logging on promise reject
|
|
88
|
+
*/
|
|
89
|
+
addErrorHandling(): void;
|
|
90
|
+
/**
|
|
91
|
+
* Return config from {configName} (file name) on config folder.
|
|
92
|
+
* Support cache and updating confing into cache
|
|
93
|
+
* Also will update config based on NODE_ENV. If config.js and config.production.js
|
|
94
|
+
* and NODE_ENV is production then we will load base config (config.js) and the load
|
|
95
|
+
* environment config (config.production.js) and overwrite base config options
|
|
96
|
+
* @see updateConfig
|
|
97
|
+
* @param {String} configName name on config file to load
|
|
98
|
+
* @returns {Object} config object. Structure depends of config file
|
|
99
|
+
*/
|
|
100
|
+
getConfig(configName: string): Record<string, unknown>;
|
|
101
|
+
/**
|
|
102
|
+
* Return or create new logger instance. This is a main logger instance
|
|
103
|
+
*/
|
|
104
|
+
getLogger(): winston.Logger;
|
|
105
|
+
/**
|
|
106
|
+
* Primary designed for tests when we need to update some configs before start testing
|
|
107
|
+
* Should be called before any initialization was done
|
|
108
|
+
* @TODO send event to all inited components to update config
|
|
109
|
+
* @param {String} configName
|
|
110
|
+
* @param {Object} config
|
|
111
|
+
*/
|
|
112
|
+
updateConfig(configName: string, config: Record<string, unknown>): Record<string, unknown>;
|
|
113
|
+
getI18nService(): Promise<I18n>;
|
|
114
|
+
/**
|
|
115
|
+
* Return model from {modelName} (file name) on model folder.
|
|
116
|
+
* Support cache
|
|
117
|
+
* @param {String} modelName name on config file to load
|
|
118
|
+
*/
|
|
119
|
+
getModel(modelName: string): AbstractModel['mongooseModel'] | TBaseModel | false;
|
|
120
|
+
/**
|
|
121
|
+
* Run cli command into framework (http, ws, etc)
|
|
122
|
+
* @param {String} commandName name of command to load
|
|
123
|
+
*/
|
|
124
|
+
runCliCommand(commandName: string): Promise<boolean | undefined>;
|
|
125
|
+
/**
|
|
126
|
+
* Get internal cache service
|
|
127
|
+
*/
|
|
128
|
+
getCache(): Cache;
|
|
129
|
+
}
|
|
130
|
+
export default Server;
|