@nestia/migrate 4.6.1-dev.20250117 → 4.6.2
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/README.md +92 -87
- package/lib/MigrateApplication.js +3 -3
- package/lib/bundles/NEST_TEMPLATE.js +84 -64
- package/lib/bundles/NEST_TEMPLATE.js.map +1 -1
- package/lib/bundles/SDK_TEMPLATE.js +30 -30
- package/lib/bundles/SDK_TEMPLATE.js.map +1 -1
- package/lib/index.mjs +118 -102
- package/lib/index.mjs.map +1 -1
- package/lib/programmers/MigrateApiNamespaceProgrammer.js +6 -6
- package/lib/programmers/MigrateApiNamespaceProgrammer.js.map +1 -1
- package/lib/programmers/{MigrateApiSimulatationProgrammer.d.ts → MigrateApiSimulationProgrammer.d.ts} +1 -1
- package/lib/programmers/{MigrateApiSimulatationProgrammer.js → MigrateApiSimulationProgrammer.js} +7 -7
- package/lib/programmers/MigrateApiSimulationProgrammer.js.map +1 -0
- package/lib/utils/openapi-down-convert/converter.js +2 -2
- package/package.json +6 -6
- package/src/MigrateApplication.ts +107 -107
- package/src/analyzers/MigrateApplicationAnalyzer.ts +18 -18
- package/src/analyzers/MigrateControllerAnalyzer.ts +51 -51
- package/src/archivers/MigrateFileArchiver.ts +38 -38
- package/src/bundles/NEST_TEMPLATE.ts +84 -64
- package/src/bundles/SDK_TEMPLATE.ts +30 -30
- package/src/executable/bundle.js +125 -125
- package/src/executable/migrate.ts +7 -7
- package/src/factories/TypeLiteralFactory.ts +57 -57
- package/src/index.ts +4 -4
- package/src/internal/MigrateCommander.ts +86 -86
- package/src/internal/MigrateInquirer.ts +89 -89
- package/src/module.ts +8 -8
- package/src/programmers/MigrateApiFileProgrammer.ts +49 -49
- package/src/programmers/MigrateApiFunctionProgrammer.ts +210 -210
- package/src/programmers/MigrateApiNamespaceProgrammer.ts +417 -417
- package/src/programmers/MigrateApiProgrammer.ts +103 -103
- package/src/programmers/{MigrateApiSimulatationProgrammer.ts → MigrateApiSimulationProgrammer.ts} +324 -324
- package/src/programmers/MigrateApiStartProgrammer.ts +194 -194
- package/src/programmers/MigrateDtoProgrammer.ts +87 -87
- package/src/programmers/MigrateE2eFileProgrammer.ts +117 -117
- package/src/programmers/MigrateE2eProgrammer.ts +34 -34
- package/src/programmers/MigrateImportProgrammer.ts +118 -118
- package/src/programmers/MigrateNestControllerProgrammer.ts +50 -50
- package/src/programmers/MigrateNestMethodProgrammer.ts +393 -393
- package/src/programmers/MigrateNestModuleProgrammer.ts +65 -65
- package/src/programmers/MigrateNestProgrammer.ts +81 -81
- package/src/programmers/MigrateSchemaProgrammer.ts +373 -373
- package/src/structures/IHttpMigrateController.ts +8 -8
- package/src/structures/IHttpMigrateDto.ts +8 -8
- package/src/structures/IHttpMigrateFile.ts +5 -5
- package/src/structures/IHttpMigrateProgram.ts +27 -27
- package/src/structures/IHttpMigrateRoute.ts +1 -1
- package/src/structures/IHttpMigrateSchema.ts +4 -4
- package/src/utils/FilePrinter.ts +36 -36
- package/src/utils/MapUtil.ts +13 -13
- package/src/utils/OpenApiTypeChecker.ts +73 -73
- package/src/utils/SetupWizard.ts +12 -12
- package/src/utils/StringUtil.ts +113 -113
- package/src/utils/openapi-down-convert/RefVisitor.ts +139 -139
- package/src/utils/openapi-down-convert/converter.ts +527 -527
- package/lib/programmers/MigrateApiSimulatationProgrammer.js.map +0 -1
package/lib/index.mjs
CHANGED
|
@@ -40,261 +40,277 @@ var MigrateApplicationAnalyzer;
|
|
|
40
40
|
const NEST_TEMPLATE = [ {
|
|
41
41
|
location: "",
|
|
42
42
|
file: ".env",
|
|
43
|
-
content: "# BASIC SERVER INFO\
|
|
43
|
+
content: "# BASIC SERVER INFO\nPROJECT_API_PORT=37001"
|
|
44
44
|
}, {
|
|
45
45
|
location: "",
|
|
46
46
|
file: ".eslintrc.cjs",
|
|
47
|
-
content: 'module.exports = {\
|
|
47
|
+
content: 'module.exports = {\n root: true,\n plugins: ["@typescript-eslint", "deprecation"],\n extends: ["plugin:@typescript-eslint/recommended"],\n parser: "@typescript-eslint/parser",\n parserOptions: {\n project: ["tsconfig.json", "test/tsconfig.json"],\n },\n overrides: [\n {\n files: ["src/**/*.ts", "test/**/*.ts"],\n rules: {\n "@typescript-eslint/consistent-type-definitions": "off",\n "@typescript-eslint/no-empty-function": "off",\n "@typescript-eslint/no-empty-interface": "off",\n "@typescript-eslint/no-explicit-any": "off",\n "@typescript-eslint/no-inferrable-types": "off",\n "@typescript-eslint/no-namespace": "off",\n "@typescript-eslint/no-non-null-assertion": "off",\n "@typescript-eslint/no-unused-vars": "off",\n "@typescript-eslint/no-var-requires": "off",\n "@typescript-eslint/no-floating-promises": "error",\n "@typescript-eslint/no-require-imports": "off",\n "@typescript-eslint/no-empty-object-type": "off",\n },\n },\n ],\n};\n'
|
|
48
48
|
}, {
|
|
49
49
|
location: ".github/workflows",
|
|
50
50
|
file: "build.yml",
|
|
51
|
-
content: "name: build\
|
|
51
|
+
content: "name: build\non:\n pull_request:\n paths:\n - 'src/**'\n - 'test/**'\n - 'package.json'\njobs:\n Ubuntu:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v4\n - uses: actions/setup-node@v4\n with:\n node-version: 20.x\n - uses: pnpm/action-setup@v4\n with:\n version: 8\n \n - name: Install Backend-Server\n run: pnpm install\n\n - name: Build Swagger\n run: npm run build:swagger\n\n - name: Build SDK\n run: npm run build:sdk\n\n - name: Compile Backend-Server\n run: npm run build\n\n - name: Run Test Program\n run: npm run test -- --simultaneous 16\n\n - name: EsLint\n run: npm run eslint\n"
|
|
52
|
+
}, {
|
|
53
|
+
location: ".github/workflows",
|
|
54
|
+
file: "typos.yml",
|
|
55
|
+
content: "name: typos\non:\n pull_request:\n\njobs:\n typos:\n runs-on: ubuntu-latest\n steps:\n - name: Checkout Actions Repository\n uses: actions/checkout@v4\n\n - uses: crate-ci/typos@master\n with:\n config: ./typos.toml\n"
|
|
52
56
|
}, {
|
|
53
57
|
location: "",
|
|
54
58
|
file: ".gitignore",
|
|
55
|
-
content: ".git/\
|
|
59
|
+
content: ".git/\nbin/\ndist/\nlib/\nnode_modules/\npackages/api/lib/\n\npackage-lock.json\npnpm-lock.yaml"
|
|
56
60
|
}, {
|
|
57
61
|
location: "",
|
|
58
62
|
file: ".prettierignore",
|
|
59
|
-
content: "dist\
|
|
63
|
+
content: "dist\nbin\nnode_modules\npackages\nsrc/api/functional\nsrc/api/utils/NestiaSimulator.ts\nREADME.md\ntsconfig.json"
|
|
60
64
|
}, {
|
|
61
65
|
location: ".vscode",
|
|
62
66
|
file: "launch.json",
|
|
63
|
-
content: '{\
|
|
67
|
+
content: '{\n // Use IntelliSense to learn about possible Node.js debug attributes.\n // Hover to view descriptions of existing attributes.\n // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387\n "version": "0.2.0",\n "configurations": [\n {\n "type": "node",\n "request": "launch",\n "name": "Backend Test",\n "program": "${workspaceRoot}/test/index.ts",\n "cwd": "${workspaceRoot}",\n "args": [\n // //----\n // // Not possible to reset DB in debugging mode\n // //\n // // Therefore, if you need DB reset, then do it \n // // through `npm run reset-for-debugging` command\n // //----\n // "--reset", "false",\n // "--mode", "local",\n \n //----\n // You can run specific test functions\n //\n // If you want to include or exclude multiple words,\n // then separate them with space character\n //----\n // "--include", "some-words-to-include",\n // "--exclude", "some-word another-word",\n ],\n "outFiles": ["${workspaceRoot}/bin/**/*.js"],\n }\n]\n}'
|
|
64
68
|
}, {
|
|
65
69
|
location: ".vscode",
|
|
66
70
|
file: "settings.json",
|
|
67
|
-
content: '{\
|
|
71
|
+
content: '{\n "editor.tabSize": 2,\n "editor.formatOnSave": true,\n "[javascript][typescript]": {\n "editor.defaultFormatter": "esbenp.prettier-vscode",\n "editor.codeActionsOnSave": {\n "source.fixAll.eslint": "explicit"\n },\n }\n}'
|
|
72
|
+
}, {
|
|
73
|
+
location: "",
|
|
74
|
+
file: "LICENSE",
|
|
75
|
+
content: 'MIT License\n\nCopyright (c) 2022 Jeongho Nam\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the "Software"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n'
|
|
76
|
+
}, {
|
|
77
|
+
location: "",
|
|
78
|
+
file: "README.md",
|
|
79
|
+
content: '# Nestia Template\n## Outline\n[](https://github.com/samchon/nestia-start/actions?query=workflow%3Abuild)\n\nA template repository for backend projects using [nestia](https://github.com/samchon/nestia).\n\nYou can create a new project from this boilerplate by running below command:\n\n```bash\nnpx nestia start <directory>\n```\n\nFor reference, this is a minimal boilerplate project concentrating only on [nestia](https://github.com/samchon/nestia) SDK generation. \n\nIf you wanna much detailed boilerplate project, visit [`@samchon/backend`](https://github.com/samchon/backend).\n\n\n\n\n## Directories and Files\nThis template project has categorized directories like below.\n\nAs you can see from the below, all of the Backend source files are placed into the [src](src/) directory. When you build the TypeScript source files, compiled files would be placed into the `lib` directory following the [tsconfig.json](tsconfig.json) configuration. Otherwise you build client [SDK](#32-sdk) library for npm publishing and their compiled files would be placed into the [packages](packages) directory.\n\n - [packages/api/](packages/api): SDK module built by `npm run build:api`\n - [src/](src): Backend source directory\n - [src/api/](src/api/): Client SDK that would be published to the `@ORGANIZATION/PROJECT-api`\n - [**src/api/functional/**](src/api/functional/): API functions generated by the [`nestia`](https://github.com/samchon/nestia)\n - [**src/api/structures/**](src/api/structures/): DTO structures\n - [src/controllers/](src/controllers/): Controller classes of the Main Program\n - [**test/**](test): Test Automation Program\n - [nestia.config.ts](nestia.config.ts): Configuration file of [`nestia`](https://github.com/samchon/nestia)\n - [package.json](package.json): NPM configuration\n - [tsconfig.json](tsconfig.json): TypeScript configuration for the main program\n - [tsconfig.api.json](tsconfig.api.json): TypeScript configuration for the SDK generation\n\n\n\n\n## NPM Run Commands\nList of the run commands defined in the [package.json](package.json) are like below:\n\n - Test\n - **`test`**: Run test automation program\n - `benchmark`: Run performance benchmark program\n - Build\n - `build`: Build everything\n - `build:main`: Build main program (`src` directory)\n - `build:test` Build test automation program (`test` directory)\n - `build:sdk`: Build SDK into main program only\n - `build:swagger`: Build Swagger Documents\n - **`dev`**: Incremental build for development (test program)\n - Deploy\n - `package:api`: Build and deploy the SDK library to the NPM\n - `start`: Start the backend server\n - `start:dev`: Start the backend server with incremental build and reload\n - Webpack\n - `webpack`: Run webpack bundler\n - `webpack:start`: Start the backend server built by webpack\n - `webpack:test`: Run test program to the webpack built\n\n\n\n\n## Specialization\nTransform this template project to be yours.\n\nWhen you\'ve created a new backend project through this template project, you can specialize it to be suitable for you by changing some words. Replace below words through IDE specific function like `Edit > Replace in Files` (*Ctrl + Shift + H*), who\'ve been supported by the VSCode.\n\n| Before | After\n|-----------------|----------------------------------------\n| ORGANIZATION | Your account or corporation name\n| PROJECT | Your own project name\n| AUTHOR | Author name\n| https://github.com/samchon/nestia-start | Your repository URL\n\n\n\n\n## Test Driven Development\nWith [nestia](https://github.com/samchon/nestia) helps to accomplish TDD (Test Driven Development). \n\nJust define DTOs and API controllers\' methods (only declarations) first. After the definitions, and build SDK (Software Development Kit) through [nestia](https://github.com/samchon/nestia) (`npm run build:sdk`). After buildling those SDK, develop test automation program using the SDK, following use-case scenarios in the framework of client side.\n\nDuring the test automation program development, you can find that which API is miss-designed or which requirement analysis is not exact. Development of the main program must be the last step after such validation process during TDD.\n\n> Visit the [samchon/backend](https://github.com/samchon/backend), then you may find much detailed story about this TDD.\n>\n> 1. Definitions\n> 2. SDK\n> 3. Test Automation Program\n> 4. Main Program\n\n```typescript\nimport {\n ArrayUtil,\n GaffComparator,\n RandomGenerator,\n TestValidator,\n} from "@nestia/e2e";\n\nimport api from "@ORGANIZATION/PROJECT-api/lib/index";\nimport { IBbsArticle } from "@ORGANIZATION/PROJECT-api/lib/structures/bbs/IBbsArticle";\nimport { IPage } from "@ORGANIZATION/PROJECT-api/lib/structures/common/IPage";\n\nexport async function test_api_bbs_article_index_sort(\n connection: api.IConnection,\n): Promise<void> {\n // GENERATE 100 ARTICLES\n const section: string = "general";\n await ArrayUtil.asyncRepeat(100)(() =>\n api.functional.bbs.articles.create(connection, section, {\n writer: RandomGenerator.name(),\n title: RandomGenerator.paragraph(5)(),\n body: RandomGenerator.content(8)()(),\n format: "txt",\n files: [],\n password: RandomGenerator.alphabets(8),\n }),\n );\n\n // PREPARE VALIDATOR\n const validator = TestValidator.sort("BbsArticleProvider.index()")(async (\n sort: IPage.Sort<IBbsArticle.IRequest.SortableColumns>,\n ) => {\n const page: IPage<IBbsArticle.ISummary> =\n await api.functional.bbs.articles.index(connection, section, {\n limit: 100,\n sort,\n });\n return page.data;\n });\n\n // DO VALIDATE\n const components = [\n validator("created_at")(GaffComparator.dates((x) => x.created_at)),\n validator("updated_at")(GaffComparator.dates((x) => x.updated_at)),\n validator("title")(GaffComparator.strings((x) => x.title)),\n validator("writer")(GaffComparator.strings((x) => x.writer)),\n validator(\n "writer",\n "title",\n )(GaffComparator.strings((x) => [x.writer, x.title])),\n ];\n for (const comp of components) {\n await comp("+", false);\n await comp("-", false);\n }\n}\n```\n\nFor reference, if you run `npm run benchmark` command, your test functions defined in the [test/features/api](test/features/api) directory would be utilized for performance benchmarking. If you want to see the performance bench result earlier, visit below link please:\n\n - [docs/benchmarks/AMD Ryzen 9 7940HS w Radeon 780M Graphics.md](https://github.com/samchon/nestia-start/blob/master/docs/benchmarks/AMD%20Ryzen%209%207940HS%20w%20Radeon%20780M%20Graphics.md)'
|
|
68
80
|
}, {
|
|
69
81
|
location: "docs/benchmarks",
|
|
70
82
|
file: "AMD Ryzen 9 7940HS w Radeon 780M Graphics.md",
|
|
71
|
-
content: '# Benchmark Report\
|
|
83
|
+
content: '# Benchmark Report\n> Generated by [`@nestia/benchmark`](https://github.com/samchon/nestia)\n\n - Specifications\n - CPU: AMD Ryzen 9 7940HS w/ Radeon 780M Graphics \n - RAM: 31 GB\n - NodeJS Version: v20.10.0\n - Backend Server: 1 core / 1 thread\n - Arguments\n - Count: 40,000\n - Threads: 4\n - Simultaneous: 32\n - Time\n - Start: 2024-10-29T19:14:35.941Z\n - Complete: 2024-10-29T19:16:11.418Z\n - Elapsed: 95,477 ms\n\nType | Count | Success | Mean. | Stdev. | Minimum | Maximum\n----|----|----|----|----|----|----\nTotal | 41,586 | 41,586 | 69.24 | 73.05 | 5 | 546\n\n> Unit: milliseconds\n\n## Memory Consumptions\n```mermaid\nxychart-beta\n x-axis "Time (second)"\n y-axis "Memory (MB)"\n line "Resident Set Size" [122, 156, 159, 142, 154, 165, 184, 185, 187, 189, 200, 205, 209, 217, 221, 225, 229, 224, 230, 235, 242, 250, 256, 262, 267, 272, 234, 237, 249, 259, 266, 273, 285, 292, 291, 216, 225, 235, 243, 200, 208, 214, 186, 186, 171, 177, 187, 199, 185, 192, 205, 171, 180, 158, 170, 179, 163, 163, 176, 188, 193, 202, 213, 219, 230, 239, 256, 265, 283, 301, 240, 249, 257, 267, 284, 282, 290, 202, 213, 166, 178, 188, 200, 203, 208, 180, 191, 199, 175]\n line "Heap Total" [85, 116, 120, 103, 114, 124, 146, 146, 147, 148, 158, 166, 170, 176, 180, 184, 187, 185, 190, 195, 203, 211, 217, 222, 225, 229, 194, 197, 209, 218, 225, 232, 241, 249, 247, 176, 185, 194, 202, 160, 168, 173, 146, 146, 130, 136, 146, 158, 145, 151, 165, 129, 139, 116, 128, 137, 120, 123, 136, 148, 152, 161, 172, 179, 189, 198, 215, 223, 241, 257, 200, 209, 216, 227, 244, 242, 249, 163, 174, 127, 136, 147, 159, 162, 166, 138, 150, 158, 132]\n line "Heap Used + External" [69, 94, 62, 82, 88, 107, 71, 83, 93, 107, 136, 72, 76, 85, 92, 106, 139, 48, 68, 69, 86, 95, 108, 116, 140, 175, 67, 74, 88, 112, 125, 136, 142, 169, 180, 91, 104, 105, 121, 60, 71, 91, 64, 74, 86, 110, 121, 135, 76, 82, 103, 70, 93, 66, 91, 107, 76, 75, 95, 101, 115, 127, 136, 154, 165, 168, 196, 193, 214, 232, 84, 94, 101, 118, 145, 147, 149, 86, 96, 72, 90, 112, 126, 133, 132, 78, 87, 107, 88]\n line "Heap Used Only" [66, 89, 59, 78, 83, 100, 68, 79, 88, 101, 129, 68, 72, 80, 86, 100, 131, 45, 64, 65, 81, 90, 103, 110, 133, 168, 64, 71, 84, 108, 120, 130, 136, 162, 173, 88, 100, 101, 117, 58, 68, 87, 61, 71, 83, 107, 118, 130, 73, 79, 99, 67, 89, 63, 88, 103, 74, 72, 91, 98, 111, 123, 132, 149, 160, 163, 190, 187, 208, 225, 81, 90, 97, 114, 140, 143, 145, 83, 93, 70, 87, 108, 122, 130, 128, 76, 84, 104, 85]\n```\n\n> - 🟦 Resident Set Size\n> - 🟢 Heap Total\n> - 🔴 Heap Used + External\n> - 🟡 Heap Used Only\n\n## Endpoints\nType | Count | Success | Mean. | Stdev. | Minimum | Maximum\n----|----|----|----|----|----|----\nPATCH /bbs/articles/:section | 6,439 | 6,439 | 108.37 | 76.56 | 6 | 546\nPUT /bbs/articles/:section/:id | 380 | 380 | 78.52 | 69.03 | 6 | 296\nGET /bbs/articles/:section/:id | 917 | 917 | 77.65 | 69.84 | 6 | 463\nDELETE /bbs/articles/:section/:id | 201 | 201 | 73.89 | 63.55 | 7 | 307\nPOST /bbs/articles/:section | 33,649 | 33,649 | 61.39 | 70.04 | 5 | 546\n\n> Unit: milliseconds\n\n## Failures\nMethod | Path | Count | Failures\n-------|------|-------|----------'
|
|
72
84
|
}, {
|
|
73
85
|
location: "",
|
|
74
|
-
file: "
|
|
75
|
-
content: '
|
|
86
|
+
file: "nest-cli.json",
|
|
87
|
+
content: '{\n "$schema": "https://json.schemastore.org/nest-cli",\n "collection": "@nestjs/schematics",\n "sourceRoot": "src",\n "entryFile": "executable/server",\n "compilerOptions": {\n "deleteOutDir": true\n }\n}\n'
|
|
76
88
|
}, {
|
|
77
89
|
location: "",
|
|
78
90
|
file: "nestia.config.ts",
|
|
79
|
-
content: '// nestia configuration file\
|
|
91
|
+
content: '// nestia configuration file\nimport type sdk from "@nestia/sdk";\nimport { NestFactory } from "@nestjs/core";\n\nimport { MyModule } from "./src/MyModule";\n\nconst NESTIA_CONFIG: sdk.INestiaConfig = {\n input: () => NestFactory.create(MyModule),\n output: "src/api",\n swagger: {\n output: "packages/api/swagger.json",\n servers: [\n {\n url: "http://localhost:37001",\n description: "Local Server",\n },\n ],\n beautify: true,\n },\n distribute: "packages/api",\n primitive: false,\n simulate: true,\n};\nexport default NESTIA_CONFIG;\n'
|
|
80
92
|
}, {
|
|
81
93
|
location: "",
|
|
82
94
|
file: "package.json",
|
|
83
|
-
content: '{\n "private": true,\n "name": "@ORGANIZATION/PROJECT",\n "version": "0.1.0",\n "description": "Starter kit of Nestia",\n "main": "lib/index.js",\n "scripts": {\n "benchmark": "node bin/test/benchmark",\n "test": "node bin/test",\n "test:webpack": "npm run webpack && node bin/test/webpack.js",\n "------------------------BUILDS------------------------": "",\n "build": "npm run build:sdk && npm run build:main && npm run build:test",\n "build:api": "rimraf packages/api/lib && nestia all && rimraf packages/api/lib && tsc -p packages/api/tsconfig.json && rollup -c packages/api/rollup.config.js",\n "build:main": "rimraf lib && tsc",\n "build:sdk": "rimraf src/api/functional && nestia sdk",\n "build:swagger": "npx nestia swagger",\n "build:test": "rimraf bin && tsc -p test/tsconfig.json",\n "dev": "npm run build:test -- --watch",\n "eslint": "eslint src && eslint test",\n "eslint:fix": "eslint --fix src && eslint --fix test",\n "prepare": "ts-patch install && typia patch",\n "prettier": "prettier src --write && prettier test --write",\n "------------------------WEBPACK------------------------": "",\n "webpack": "rimraf dist && webpack",\n "webpack:start": "cd dist && node dist/server",\n "webpack:test": "npm run webpack && node bin/test/webpack.js",\n "------------------------DEPLOYS------------------------": "",\n "package:api": "npm run build:api && cd packages/api && npm publish",\n "start": "node lib/executable/server",\n "start:swagger": "ts-node src/executable/swagger.ts"\n },\n "repository": {\n "type": "git",\n "url": "https://github.com/samchon/nestia-start"\n },\n "keywords": [\n "nestia",\n "template",\n "boilerplate"\n ],\n "author": "AUTHOR",\n "license": "MIT",\n "bugs": {\n "url": "https://github.com/samchon/nestia-start/issues"\n },\n "homepage": "https://github.com/samchon/nestia-start#readme",\n "devDependencies": {\n "@nestia/benchmark": "^0.3.0",\n "@nestia/e2e": "^0.
|
|
95
|
+
content: '{\n "private": true,\n "name": "@ORGANIZATION/PROJECT",\n "version": "0.1.0",\n "description": "Starter kit of Nestia",\n "main": "lib/index.js",\n "scripts": {\n "benchmark": "node bin/test/benchmark",\n "test": "node bin/test",\n "test:webpack": "npm run webpack && node bin/test/webpack.js",\n "------------------------BUILDS------------------------": "",\n "build": "npm run build:sdk && npm run build:main && npm run build:test",\n "build:api": "rimraf packages/api/lib && nestia all && rimraf packages/api/lib && tsc -p packages/api/tsconfig.json && rollup -c packages/api/rollup.config.js",\n "build:main": "rimraf lib && tsc",\n "build:sdk": "rimraf src/api/functional && nestia sdk",\n "build:swagger": "npx nestia swagger",\n "build:test": "rimraf bin && tsc -p test/tsconfig.json",\n "dev": "npm run build:test -- --watch",\n "eslint": "eslint src && eslint test",\n "eslint:fix": "eslint --fix src && eslint --fix test",\n "prepare": "ts-patch install && typia patch",\n "prettier": "prettier src --write && prettier test --write",\n "------------------------WEBPACK------------------------": "",\n "webpack": "rimraf dist && webpack",\n "webpack:start": "cd dist && node dist/server",\n "webpack:test": "npm run webpack && node bin/test/webpack.js",\n "------------------------DEPLOYS------------------------": "",\n "package:api": "npm run build:api && cd packages/api && npm publish",\n "start": "node lib/executable/server",\n "start:dev": "nest start --watch",\n "start:swagger": "ts-node src/executable/swagger.ts"\n },\n "repository": {\n "type": "git",\n "url": "https://github.com/samchon/nestia-start"\n },\n "keywords": [\n "nestia",\n "template",\n "boilerplate"\n ],\n "author": "AUTHOR",\n "license": "MIT",\n "bugs": {\n "url": "https://github.com/samchon/nestia-start/issues"\n },\n "homepage": "https://github.com/samchon/nestia-start#readme",\n "devDependencies": {\n "@nestia/benchmark": "^0.3.0",\n "@nestia/e2e": "^0.8.0",\n "@nestia/sdk": "^4.6.2",\n "@nestjs/cli": "^11.0.4",\n "@rollup/plugin-terser": "^0.4.4",\n "@rollup/plugin-typescript": "^11.1.6",\n "@trivago/prettier-plugin-sort-imports": "^4.3.0",\n "@types/cli": "^0.11.21",\n "@types/cli-progress": "^3.11.5",\n "@types/express": "^4.17.21",\n "@types/inquirer": "^8.2.5",\n "@types/node": "^18.11.0",\n "@types/uuid": "^8.3.4",\n "@typescript-eslint/eslint-plugin": "^8.1.0",\n "@typescript-eslint/parser": "^8.1.0",\n "chalk": "^4.1.2",\n "cli": "^1.0.1",\n "cli-progress": "^3.12.0",\n "copy-webpack-plugin": "^11.0.0",\n "eslint-plugin-deprecation": "^3.0.0",\n "express": "^4.18.2",\n "nestia": "^6.4.0",\n "prettier": "^3.2.4",\n "prettier-plugin-prisma": "^5.0.0",\n "rimraf": "^3.0.2",\n "rollup": "^4.18.0",\n "source-map-support": "^0.5.21",\n "swagger-ui-express": "^5.0.0",\n "ts-loader": "^9.5.1",\n "ts-node": "^10.9.1",\n "ts-patch": "^3.3.0",\n "typescript": "~5.7.3",\n "typescript-transform-paths": "^3.5.3",\n "webpack": "^5.89.0",\n "webpack-cli": "^5.1.4",\n "write-file-webpack-plugin": "^4.5.1"\n },\n "dependencies": {\n "@nestia/core": "^4.6.2",\n "@nestia/fetcher": "^4.6.2",\n "@nestjs/common": "^11.0.10",\n "@nestjs/core": "^11.0.10",\n "@nestjs/platform-express": "^11.0.10",\n "commander": "10.0.0",\n "dotenv": "^16.3.1",\n "dotenv-expand": "^10.0.0",\n "inquirer": "8.2.5",\n "serialize-error": "^4.1.0",\n "tgrid": "^1.0.2",\n "tstl": "^3.0.0",\n "typia": "^7.6.4",\n "uuid": "^9.0.0"\n },\n "stackblitz": {\n "startCommand": "npm run prepare && npm run build:test && npm run test"\n }\n}'
|
|
84
96
|
}, {
|
|
85
97
|
location: "packages/api",
|
|
86
98
|
file: ".gitignore",
|
|
87
|
-
content: "lib/\
|
|
99
|
+
content: "lib/\nnode_modules/\n\nswagger.json\nopenai.json"
|
|
88
100
|
}, {
|
|
89
101
|
location: "packages/api",
|
|
90
102
|
file: "LICENSE",
|
|
91
|
-
content: 'MIT License\
|
|
103
|
+
content: 'MIT License\n\nCopyright (c) 2021 ORGANIZATION\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the "Software"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.'
|
|
92
104
|
}, {
|
|
93
105
|
location: "packages/api",
|
|
94
|
-
file: "
|
|
95
|
-
content:
|
|
106
|
+
file: "README.md",
|
|
107
|
+
content: "# SDK Library\nThis is a SDK library generated by [`nestia`](https://nestia.io).\n\nWith this SDK library, you can easily and safely interact with backend server.\n\nJust import and call some API functions like gif image below:\n\n\n\n> Left is server code, and right is client code utilizing the SDK\n\n\n\n\n# What [`Nestia`](https://nestia.io) is:\n\n\n[](https://github.com/samchon/nestia/blob/master/LICENSE)\n[](https://www.npmjs.com/package/@nestia/core)\n[](https://www.npmjs.com/package/@nestia/core)\n[](https://github.com/samchon/nestia/actions?query=workflow%3Abuild)\n[](https://nestia.io/docs/)\n\nNestia is a set of helper libraries for NestJS, supporting below features:\n\n - `@nestia/core`: super-fast decorators\n - `@nestia/sdk`:\n - Swagger generator evolved than ever\n - SDK library generator for clients\n - Mockup Simulator for client applications\n - Automatic E2E test functions generator\n - `@nestia/migrate`: migration from Swagger to NestJS\n - `nestia`: just CLI (command line interface) tool\n\n> **Note**\n> \n> - **Only one line** required, with pure TypeScript type\n> - Enhance performance **30x** up\n> - Runtime validator is **20,000x faster** than `class-validator`\n> - JSON serialization is **200x faster** than `class-transformer`\n> - Software Development Kit\n> - SDK is a collection of `fetch` functions with type definitions like [tRPC](https://trpc.io/)\n> - Mockup simulator means embedded backend simulator in SDK\n> - similar with [msw](https://mswjs.io/), but fully automated"
|
|
96
108
|
}, {
|
|
97
109
|
location: "packages/api",
|
|
98
|
-
file: "
|
|
99
|
-
content: "
|
|
110
|
+
file: "package.json",
|
|
111
|
+
content: '{\n "name": "@ORGANIZATION/PROJECT-api",\n "version": "0.1.0",\n "description": "SDK library generated by Nestia",\n "main": "lib/index.js",\n "module": "lib/index.mjs",\n "typings": "lib/index.d.ts",\n "repository": {\n "type": "git",\n "url": "https://github.com/samchon/nestia"\n },\n "author": "Jeongho Nam",\n "license": "MIT",\n "bugs": {\n "url": "https://github.com/samchon/nestia/issues"\n },\n "homepage": "https://nestia.io",\n "files": [\n "lib",\n "package.json",\n "swagger.json",\n "openai.json",\n "README.md"\n ],\n "dependencies": {\n "@nestia/fetcher": "^4.6.2",\n "tgrid": "^1.1.0",\n "typia": "^7.6.4"\n }\n}'
|
|
100
112
|
}, {
|
|
101
113
|
location: "packages/api",
|
|
102
114
|
file: "rollup.config.js",
|
|
103
|
-
content: 'const typescript = require("@rollup/plugin-typescript");\
|
|
115
|
+
content: 'const typescript = require("@rollup/plugin-typescript");\nconst terser = require("@rollup/plugin-terser");\n\nmodule.exports = {\n input: `${__dirname}/../../src/api/index.ts`,\n output: {\n dir: `${__dirname}/lib`,\n format: "esm",\n entryFileNames: "[name].mjs",\n sourcemap: true,\n },\n plugins: [\n typescript({\n tsconfig: `${__dirname}/tsconfig.json`,\n module: "ESNext",\n target: "ESNext",\n }),\n terser({\n format: {\n comments: "some",\n beautify: true,\n ecma: "2020",\n },\n compress: false,\n mangle: false,\n module: true,\n }),\n ],\n};\n'
|
|
104
116
|
}, {
|
|
105
117
|
location: "packages/api",
|
|
106
118
|
file: "tsconfig.json",
|
|
107
|
-
content: '{\r\n "compilerOptions": {\r\n /* Visit https://aka.ms/tsconfig to read more about this file */\r\n /* Projects */\r\n // "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */\r\n // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */\r\n // "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */\r\n // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */\r\n // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */\r\n // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */\r\n /* Language and Environment */\r\n "target": "ES5", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */\r\n "lib": [\r\n "DOM",\r\n "ES2015"\r\n ], /* Specify a set of bundled library declaration files that describe the target runtime environment. */// "jsx": "preserve", /* Specify what JSX code is generated. */\r\n // "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */\r\n // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */\r\n // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. \'React.createElement\' or \'h\'. */\r\n // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. \'React.Fragment\' or \'Fragment\'. */\r\n // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using \'jsx: react-jsx*\'. */\r\n // "reactNamespace": "", /* Specify the object invoked for \'createElement\'. This only applies when targeting \'react\' JSX emit. */\r\n // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */\r\n // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */\r\n // "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */\r\n /* Modules */\r\n "module": "commonjs", /* Specify what module code is generated. */// "rootDir": "./", /* Specify the root folder within your source files. */\r\n // "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */\r\n // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */\r\n // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */\r\n // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */\r\n // "typeRoots": [], /* Specify multiple folders that act like \'./node_modules/@types\'. */\r\n // "types": [], /* Specify type package names to be included without being referenced in a source file. */\r\n // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */\r\n // "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */\r\n // "resolveJsonModule": true, /* Enable importing .json files. */\r\n // "noResolve": true, /* Disallow \'import\'s, \'require\'s or \'<reference>\'s from expanding the number of files TypeScript should add to a project. */\r\n /* JavaScript Support */\r\n // "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the \'checkJS\' option to get errors from these files. */\r\n // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */\r\n // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from \'node_modules\'. Only applicable with \'allowJs\'. */\r\n /* Emit */\r\n "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */// "declarationMap": true, /* Create sourcemaps for d.ts files. */\r\n // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */\r\n "sourceMap": true, /* Create source map files for emitted JavaScript files. */// "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. */\r\n "outDir": "./lib", /* Specify an output folder for all emitted files. */// "removeComments": true, /* Disable emitting comments. */\r\n // "noEmit": true, /* Disable emitting files from a compilation. */\r\n // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */\r\n // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */\r\n "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */\r\n // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */\r\n // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */\r\n // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */\r\n // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */\r\n "newLine": "lf", /* Set the newline character for emitting files. */// "stripInternal": true, /* Disable emitting declarations that have \'@internal\' in their JSDoc comments. */\r\n // "noEmitHelpers": true, /* Disable generating custom helper functions like \'__extends\' in compiled output. */\r\n // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */\r\n // "preserveConstEnums": true, /* Disable erasing \'const enum\' declarations in generated code. */\r\n // "declarationDir": "./", /* Specify the output directory for generated declaration files. */\r\n // "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */\r\n /* Interop Constraints */\r\n // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */\r\n // "allowSyntheticDefaultImports": true, /* Allow \'import x from y\' when a module doesn\'t have a default export. */\r\n "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. */\r\n "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. *//* Type Checking */\r\n "strict": true, /* Enable all strict type-checking options. */// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied \'any\' type. */\r\n // "strictNullChecks": true, /* When type checking, take into account \'null\' and \'undefined\'. */\r\n // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */\r\n // "strictBindCallApply": true, /* Check that the arguments for \'bind\', \'call\', and \'apply\' methods match the original function. */\r\n // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */\r\n // "noImplicitThis": true, /* Enable error reporting when \'this\' is given the type \'any\'. */\r\n // "useUnknownInCatchVariables": true, /* Default catch clause variables as \'unknown\' instead of \'any\'. */\r\n // "alwaysStrict": true, /* Ensure \'use strict\' is always emitted. */\r\n // "noUnusedLocals": true, /* Enable error reporting when local variables aren\'t read. */\r\n // "noUnusedParameters": true, /* Raise an error when a function parameter isn\'t read. */\r\n // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding \'undefined\'. */\r\n // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */\r\n // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */\r\n // "noUncheckedIndexedAccess": true, /* Add \'undefined\' to a type when accessed using an index. */\r\n // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */\r\n // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */\r\n // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */\r\n // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */\r\n /* Completeness */\r\n // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */\r\n "skipLibCheck": true, /* Skip type checking all .d.ts files. */\r\n "plugins": [\r\n {\r\n "transform": "typia/lib/transform"\r\n }\r\n ],\r\n "strictNullChecks": true\r\n },\r\n "include": [\r\n "../../src/api"\r\n ]\r\n}'
|
|
119
|
+
content: '{\n "compilerOptions": {\n /* Visit https://aka.ms/tsconfig to read more about this file */\n /* Projects */\n // "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */\n // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */\n // "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */\n // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */\n // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */\n // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */\n /* Language and Environment */\n "target": "ES5", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */\n "lib": [\n "DOM",\n "ES2015"\n ], /* Specify a set of bundled library declaration files that describe the target runtime environment. */// "jsx": "preserve", /* Specify what JSX code is generated. */\n // "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */\n // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */\n // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. \'React.createElement\' or \'h\'. */\n // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. \'React.Fragment\' or \'Fragment\'. */\n // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using \'jsx: react-jsx*\'. */\n // "reactNamespace": "", /* Specify the object invoked for \'createElement\'. This only applies when targeting \'react\' JSX emit. */\n // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */\n // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */\n // "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */\n /* Modules */\n "module": "commonjs", /* Specify what module code is generated. */// "rootDir": "./", /* Specify the root folder within your source files. */\n // "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */\n // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */\n // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */\n // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */\n // "typeRoots": [], /* Specify multiple folders that act like \'./node_modules/@types\'. */\n // "types": [], /* Specify type package names to be included without being referenced in a source file. */\n // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */\n // "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */\n // "resolveJsonModule": true, /* Enable importing .json files. */\n // "noResolve": true, /* Disallow \'import\'s, \'require\'s or \'<reference>\'s from expanding the number of files TypeScript should add to a project. */\n /* JavaScript Support */\n // "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the \'checkJS\' option to get errors from these files. */\n // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */\n // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from \'node_modules\'. Only applicable with \'allowJs\'. */\n /* Emit */\n "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */// "declarationMap": true, /* Create sourcemaps for d.ts files. */\n // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */\n "sourceMap": true, /* Create source map files for emitted JavaScript files. */// "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. */\n "outDir": "./lib", /* Specify an output folder for all emitted files. */// "removeComments": true, /* Disable emitting comments. */\n // "noEmit": true, /* Disable emitting files from a compilation. */\n // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */\n // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */\n "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */\n // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */\n // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */\n // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */\n // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */\n "newLine": "lf", /* Set the newline character for emitting files. */// "stripInternal": true, /* Disable emitting declarations that have \'@internal\' in their JSDoc comments. */\n // "noEmitHelpers": true, /* Disable generating custom helper functions like \'__extends\' in compiled output. */\n // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */\n // "preserveConstEnums": true, /* Disable erasing \'const enum\' declarations in generated code. */\n // "declarationDir": "./", /* Specify the output directory for generated declaration files. */\n // "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */\n /* Interop Constraints */\n // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */\n // "allowSyntheticDefaultImports": true, /* Allow \'import x from y\' when a module doesn\'t have a default export. */\n "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. */\n "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. *//* Type Checking */\n "strict": true, /* Enable all strict type-checking options. */// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied \'any\' type. */\n // "strictNullChecks": true, /* When type checking, take into account \'null\' and \'undefined\'. */\n // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */\n // "strictBindCallApply": true, /* Check that the arguments for \'bind\', \'call\', and \'apply\' methods match the original function. */\n // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */\n // "noImplicitThis": true, /* Enable error reporting when \'this\' is given the type \'any\'. */\n // "useUnknownInCatchVariables": true, /* Default catch clause variables as \'unknown\' instead of \'any\'. */\n // "alwaysStrict": true, /* Ensure \'use strict\' is always emitted. */\n // "noUnusedLocals": true, /* Enable error reporting when local variables aren\'t read. */\n // "noUnusedParameters": true, /* Raise an error when a function parameter isn\'t read. */\n // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding \'undefined\'. */\n // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */\n // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */\n // "noUncheckedIndexedAccess": true, /* Add \'undefined\' to a type when accessed using an index. */\n // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */\n // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */\n // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */\n // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */\n /* Completeness */\n // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */\n "skipLibCheck": true, /* Skip type checking all .d.ts files. */\n "plugins": [\n {\n "transform": "typia/lib/transform"\n }\n ],\n "strictNullChecks": true\n },\n "include": [\n "../../src/api"\n ]\n}'
|
|
108
120
|
}, {
|
|
109
121
|
location: "",
|
|
110
122
|
file: "prettier.config.js",
|
|
111
|
-
content: 'module.exports = {\
|
|
123
|
+
content: 'module.exports = {\n // DEFAULT CONFIGURATIONS\n parser: "typescript",\n printWidth: 80,\n semi: true,\n tabWidth: 2,\n trailingComma: "all",\n\n // PLUG-IN CONFIGURATIONS\n plugins: ["@trivago/prettier-plugin-sort-imports"],\n importOrder: [\n "<THIRD_PARTY_MODULES>",\n "^@ORGANIZATION/PROJECT-api(.*)$",\n "^[./]",\n ],\n importOrderSeparation: true,\n importOrderSortSpecifiers: true,\n importOrderParserPlugins: ["decorators-legacy", "typescript"],\n};\n'
|
|
112
124
|
}, {
|
|
113
|
-
location: "",
|
|
114
|
-
file: "
|
|
115
|
-
content: '
|
|
125
|
+
location: "src",
|
|
126
|
+
file: "MyBackend.ts",
|
|
127
|
+
content: 'import { INestApplication } from "@nestjs/common";\nimport { NestFactory } from "@nestjs/core";\n\nimport { MyConfiguration } from "./MyConfiguration";\nimport { MyModule } from "./MyModule";\n\nexport class MyBackend {\n private application_?: INestApplication;\n\n public async open(): Promise<void> {\n //----\n // OPEN THE BACKEND SERVER\n //----\n // MOUNT CONTROLLERS\n this.application_ = await NestFactory.create(MyModule, { logger: false });\n\n // DO OPEN\n this.application_.enableCors();\n await this.application_.listen(MyConfiguration.API_PORT(), "0.0.0.0");\n\n //----\n // POST-PROCESSES\n //----\n // INFORM TO THE PM2\n if (process.send) process.send("ready");\n\n // WHEN KILL COMMAND COMES\n process.on("SIGINT", async () => {\n await this.close();\n process.exit(0);\n });\n }\n\n public async close(): Promise<void> {\n if (this.application_ === undefined) return;\n\n // DO CLOSE\n await this.application_.close();\n delete this.application_;\n }\n}\n'
|
|
128
|
+
}, {
|
|
129
|
+
location: "src",
|
|
130
|
+
file: "MyConfiguration.ts",
|
|
131
|
+
content: 'import fs from "fs";\nimport path from "path";\n\nimport { MyGlobal } from "./MyGlobal";\n\nexport namespace MyConfiguration {\n export const API_PORT = () => Number(MyGlobal.env.PROJECT_API_PORT);\n\n export const ROOT = (() => {\n const split: string[] = __dirname.split(path.sep);\n return split.at(-1) === "src" && split.at(-2) === "bin"\n ? path.resolve(__dirname + "/../..")\n : fs.existsSync(__dirname + "/.env")\n ? __dirname\n : path.resolve(__dirname + "/..");\n })();\n}\n'
|
|
132
|
+
}, {
|
|
133
|
+
location: "src",
|
|
134
|
+
file: "MyGlobal.ts",
|
|
135
|
+
content: 'import dotenv from "dotenv";\nimport dotenvExpand from "dotenv-expand";\nimport { Singleton } from "tstl";\nimport typia from "typia";\n\n/* eslint-disable */\nexport class MyGlobal {\n public static testing: boolean = false;\n public static get env(): MyGlobal.IEnvironments {\n return environments.get();\n }\n}\nexport namespace MyGlobal {\n export interface IEnvironments {\n PROJECT_API_PORT: `${number}`;\n }\n}\n\nconst environments = new Singleton(() => {\n const env = dotenv.config();\n dotenvExpand.expand(env);\n return typia.assert<MyGlobal.IEnvironments>(process.env);\n});\n'
|
|
116
136
|
}, {
|
|
117
137
|
location: "src/api",
|
|
118
138
|
file: "HttpError.ts",
|
|
119
|
-
content: 'export { HttpError } from "@nestia/fetcher";\
|
|
139
|
+
content: 'export { HttpError } from "@nestia/fetcher";\n'
|
|
120
140
|
}, {
|
|
121
141
|
location: "src/api",
|
|
122
142
|
file: "IConnection.ts",
|
|
123
|
-
content: 'export type { IConnection } from "@nestia/fetcher";\
|
|
143
|
+
content: 'export type { IConnection } from "@nestia/fetcher";\n'
|
|
124
144
|
}, {
|
|
125
145
|
location: "src/api",
|
|
126
|
-
file: "
|
|
127
|
-
content: '
|
|
146
|
+
file: "Primitive.ts",
|
|
147
|
+
content: 'export type { Primitive } from "typia";\n'
|
|
128
148
|
}, {
|
|
129
149
|
location: "src/api",
|
|
130
|
-
file: "
|
|
131
|
-
content: 'export type
|
|
150
|
+
file: "Resolved.ts",
|
|
151
|
+
content: 'export type { Resolved } from "typia";\n'
|
|
132
152
|
}, {
|
|
133
153
|
location: "src/api",
|
|
134
|
-
file: "
|
|
135
|
-
content: '
|
|
154
|
+
file: "index.ts",
|
|
155
|
+
content: 'import * as api from "./module";\n\nexport * from "./module";\nexport default api;\n'
|
|
136
156
|
}, {
|
|
137
157
|
location: "src/api",
|
|
138
|
-
file: "
|
|
139
|
-
content: 'export type
|
|
158
|
+
file: "module.ts",
|
|
159
|
+
content: 'export type * from "./IConnection";\nexport * from "./HttpError";\n\nexport * as functional from "./functional";\n'
|
|
140
160
|
}, {
|
|
141
161
|
location: "src/api/structures/bbs",
|
|
142
162
|
file: "IBbsArticle.ts",
|
|
143
|
-
content: 'import { tags } from "typia";\
|
|
163
|
+
content: 'import { tags } from "typia";\n\nimport { IAttachmentFile } from "../common/IAttachmentFile";\nimport { IPage } from "../common/IPage";\n\n/**\n * BBS article.\n */\nexport interface IBbsArticle {\n /**\n * Primary Key.\n */\n id: string & tags.Format<"uuid">;\n\n /**\n * Section code.\n */\n section: string;\n\n /**\n * Name of nickname of writer.\n */\n writer: string;\n\n /**\n * List of snapshot contents.\n *\n * Whenever updating an article, its contents would be accumulated.\n */\n snapshots: IBbsArticle.ISnapshot[];\n\n /**\n * Creation time of the article.\n */\n created_at: string & tags.Format<"date-time">;\n}\n\nexport namespace IBbsArticle {\n /**\n * Page request info with some options.\n */\n export interface IRequest extends IPage.IRequest {\n /**\n * Searching options.\n */\n search?: IRequest.ISearch;\n\n /**\n * Sorting options.\n *\n * The plus sign means ASC and minus sign means DESC.\n */\n sort?: IPage.Sort<IRequest.SortableColumns>;\n }\n export namespace IRequest {\n /**\n * Searching options.\n */\n export interface ISearch {\n writer?: string;\n title?: string;\n body?: string;\n }\n\n /**\n * List of sortable columns.\n */\n export type SortableColumns =\n | "writer"\n | "title"\n | "created_at"\n | "updated_at";\n }\n\n /**\n * Summarized info.\n */\n export interface ISummary {\n id: string;\n writer: string;\n title: string;\n created_at: string;\n updated_at: string;\n }\n\n /**\n * Content info.\n */\n export interface ISnapshot extends Omit<IUpdate, "password"> {\n /**\n * Primary key of individual content.\n */\n id: string & tags.Format<"uuid">;\n\n /**\n * Creation time of this content.\n */\n created_at: string & tags.Format<"date-time">;\n }\n\n /**\n * Store info.\n */\n export interface ICreate extends IUpdate {\n /**\n * Name or nickname of the writer.\n */\n writer: string;\n }\n\n /**\n * Update info.\n */\n export interface IUpdate {\n /**\n * Title of the article.\n */\n title: string;\n\n /**\n * Content body.\n */\n body: string;\n\n /**\n * Format of the content body.\n */\n format: "md" | "html" | "txt";\n\n /**\n * List of files (to be) attached.\n */\n files: IAttachmentFile[];\n\n /**\n * Password of the article.\n */\n password: string;\n }\n\n /**\n * Erase info.\n */\n export interface IErase {\n /**\n * Password of the article.\n */\n password: string;\n }\n}\n'
|
|
144
164
|
}, {
|
|
145
165
|
location: "src/api/structures/common",
|
|
146
166
|
file: "IAttachmentFile.ts",
|
|
147
|
-
content: 'import { tags } from "typia";\
|
|
167
|
+
content: 'import { tags } from "typia";\n\nexport interface IAttachmentFile {\n name: null | (string & tags.MinLength<1> & tags.MaxLength<255>);\n extension: null | (string & tags.MinLength<1> & tags.MaxLength<8>);\n url: string & tags.Format<"url">;\n}\n'
|
|
148
168
|
}, {
|
|
149
169
|
location: "src/api/structures/common",
|
|
150
170
|
file: "IPage.ts",
|
|
151
|
-
content: 'import { tags } from "typia";\
|
|
171
|
+
content: 'import { tags } from "typia";\n\n/**\n * A page.\n *\n * Collection of records with pagination indformation.\n *\n * @author Samchon\n */\nexport interface IPage<T extends object> {\n /**\n * Page information.\n */\n pagination: IPage.IPagination;\n\n /**\n * List of records.\n */\n data: T[];\n}\nexport namespace IPage {\n /**\n * Page information.\n */\n export interface IPagination {\n /**\n * Current page number.\n */\n current: number & tags.Type<"uint32">;\n\n /**\n * Limitation of records per a page.\n *\n * @default 100\n */\n limit: number & tags.Type<"uint32">;\n\n /**\n * Count of total records in database.\n */\n records: number & tags.Type<"uint32">;\n\n /**\n * Number of total pages.\n *\n * Equal to {@link records} / {@link limit} with ceiling.\n */\n pages: number & tags.Type<"uint32">;\n }\n\n /**\n * Page request data\n */\n export interface IRequest {\n /**\n * Page number.\n */\n page?: number & tags.Type<"uint32">;\n\n /**\n * Limitation of records per a page.\n */\n limit?: number & tags.Type<"uint32">;\n }\n\n /**\n * Sorting column specialization.\n *\n * The plus means ascending order and the minus means descending order.\n */\n export type Sort<Literal extends string> = Array<\n `-${Literal}` | `+${Literal}`\n >;\n}\n'
|
|
152
172
|
}, {
|
|
153
173
|
location: "src/executable",
|
|
154
174
|
file: "server.ts",
|
|
155
|
-
content: 'import { MyBackend } from "../MyBackend";\
|
|
175
|
+
content: 'import { MyBackend } from "../MyBackend";\n\nconst EXTENSION = __filename.substring(__filename.length - 2);\nif (EXTENSION === "js") require("source-map-support/register");\n\nasync function main(): Promise<void> {\n // BACKEND SEVER\n const backend: MyBackend = new MyBackend();\n await backend.open();\n\n // UNEXPECTED ERRORS\n global.process.on("uncaughtException", console.error);\n global.process.on("unhandledRejection", console.error);\n}\nmain().catch((exp) => {\n console.log(exp);\n process.exit(-1);\n});\n'
|
|
156
176
|
}, {
|
|
157
177
|
location: "src/executable",
|
|
158
178
|
file: "swagger.ts",
|
|
159
|
-
content: 'import cp from "child_process";\
|
|
160
|
-
}, {
|
|
161
|
-
location: "src",
|
|
162
|
-
file: "MyBackend.ts",
|
|
163
|
-
content: 'import { INestApplication } from "@nestjs/common";\r\nimport { NestFactory } from "@nestjs/core";\r\n\r\nimport { MyConfiguration } from "./MyConfiguration";\r\nimport { MyModule } from "./MyModule";\r\n\r\nexport class MyBackend {\r\n private application_?: INestApplication;\r\n\r\n public async open(): Promise<void> {\r\n //----\r\n // OPEN THE BACKEND SERVER\r\n //----\r\n // MOUNT CONTROLLERS\r\n this.application_ = await NestFactory.create(MyModule, { logger: false });\r\n\r\n // DO OPEN\r\n this.application_.enableCors();\r\n await this.application_.listen(MyConfiguration.API_PORT(), "0.0.0.0");\r\n\r\n //----\r\n // POST-PROCESSES\r\n //----\r\n // INFORM TO THE PM2\r\n if (process.send) process.send("ready");\r\n\r\n // WHEN KILL COMMAND COMES\r\n process.on("SIGINT", async () => {\r\n await this.close();\r\n process.exit(0);\r\n });\r\n }\r\n\r\n public async close(): Promise<void> {\r\n if (this.application_ === undefined) return;\r\n\r\n // DO CLOSE\r\n await this.application_.close();\r\n delete this.application_;\r\n }\r\n}\r\n'
|
|
164
|
-
}, {
|
|
165
|
-
location: "src",
|
|
166
|
-
file: "MyConfiguration.ts",
|
|
167
|
-
content: 'import fs from "fs";\r\nimport path from "path";\r\n\r\nimport { MyGlobal } from "./MyGlobal";\r\n\r\nexport namespace MyConfiguration {\r\n export const API_PORT = () => Number(MyGlobal.env.PROJECT_API_PORT);\r\n\r\n export const ROOT = (() => {\r\n const splitted: string[] = __dirname.split(path.sep);\r\n return splitted.at(-1) === "src" && splitted.at(-2) === "bin"\r\n ? path.resolve(__dirname + "/../..")\r\n : fs.existsSync(__dirname + "/.env")\r\n ? __dirname\r\n : path.resolve(__dirname + "/..");\r\n })();\r\n}\r\n'
|
|
168
|
-
}, {
|
|
169
|
-
location: "src",
|
|
170
|
-
file: "MyGlobal.ts",
|
|
171
|
-
content: 'import dotenv from "dotenv";\r\nimport dotenvExpand from "dotenv-expand";\r\nimport { Singleton } from "tstl";\r\nimport typia from "typia";\r\n\r\n/* eslint-disable */\r\nexport class MyGlobal {\r\n public static testing: boolean = false;\r\n public static get env(): MyGlobal.IEnvironments {\r\n return environments.get();\r\n }\r\n}\r\nexport namespace MyGlobal {\r\n export interface IEnvironments {\r\n PROJECT_API_PORT: `${number}`;\r\n }\r\n}\r\n\r\nconst environments = new Singleton(() => {\r\n const env = dotenv.config();\r\n dotenvExpand.expand(env);\r\n return typia.assert<MyGlobal.IEnvironments>(process.env);\r\n});\r\n'
|
|
179
|
+
content: 'import cp from "child_process";\nimport express from "express";\n\nconst execute = (command: string): void => {\n console.log(`\\n$ ${command}\\n`);\n cp.execSync(command, { stdio: "inherit" });\n};\n\nconst main = async (): Promise<void> => {\n if (!process.argv.some((str) => str === "--skipBuild"))\n execute("npm run build:swagger");\n\n const docs = await import("../../packages/api/swagger.json" as any);\n\n const app = express();\n const swaggerUi = require("swagger-ui-express");\n app.use("/api-docs", swaggerUi.serve, swaggerUi.setup(docs));\n app.listen(37810);\n\n console.log("\\n");\n console.log("-----------------------------------------------------------");\n console.log("\\n Swagger UI Address: http://127.0.0.1:37810/api-docs \\n");\n console.log("-----------------------------------------------------------");\n};\nmain().catch((exp) => {\n console.log(exp);\n process.exit(-1);\n});\n'
|
|
172
180
|
}, {
|
|
173
181
|
location: "src/utils",
|
|
174
182
|
file: "ErrorUtil.ts",
|
|
175
|
-
content: 'import serializeError = require("serialize-error");\
|
|
183
|
+
content: 'import serializeError = require("serialize-error");\n\nexport namespace ErrorUtil {\n export const toJSON = (err: any): object =>\n err instanceof Object && err.toJSON instanceof Function\n ? err.toJSON()\n : serializeError(err);\n}\n'
|
|
176
184
|
}, {
|
|
177
185
|
location: "src/utils",
|
|
178
186
|
file: "MapUtil.ts",
|
|
179
|
-
content: "export namespace MapUtil {\
|
|
187
|
+
content: "export namespace MapUtil {\n export function take<Key, T>(\n dict: Map<Key, T>,\n key: Key,\n generator: () => T,\n ): T {\n const oldbie: T | undefined = dict.get(key);\n if (oldbie) return oldbie;\n\n const value: T = generator();\n dict.set(key, value);\n return value;\n }\n}\n"
|
|
188
|
+
}, {
|
|
189
|
+
location: "test",
|
|
190
|
+
file: "TestAutomation.ts",
|
|
191
|
+
content: 'import { DynamicExecutor } from "@nestia/e2e";\nimport chalk from "chalk";\nimport { sleep_for } from "tstl";\n\nimport { MyConfiguration } from "../src/MyConfiguration";\nimport api from "../src/api";\nimport { ArgumentParser } from "./helpers/ArgumentParser";\n\nexport namespace TestAutomation {\n export interface IProps<T> {\n open(options: IOptions): Promise<T>;\n close(backend: T): Promise<void>;\n }\n\n export interface IOptions {\n simultaneous: number;\n include?: string[];\n exclude?: string[];\n }\n\n export const execute = async <T>(props: IProps<T>): Promise<void> => {\n // OPEN BACKEND\n const options: IOptions = await getOptions();\n const backend: T = await props.open(options);\n\n // DO TEST\n const connection: api.IConnection = {\n host: `http://127.0.0.1:${MyConfiguration.API_PORT()}`,\n };\n const report: DynamicExecutor.IReport = await DynamicExecutor.validate({\n prefix: "test",\n location: __dirname + "/features",\n parameters: () => [\n {\n host: connection.host,\n encryption: connection.encryption,\n },\n ],\n filter: (func) =>\n (!options.include?.length ||\n (options.include ?? []).some((str) => func.includes(str))) &&\n (!options.exclude?.length ||\n (options.exclude ?? []).every((str) => !func.includes(str))),\n onComplete: (exec) => {\n const trace = (str: string) =>\n console.log(` - ${chalk.green(exec.name)}: ${str}`);\n if (exec.error === null) {\n const elapsed: number =\n new Date(exec.completed_at).getTime() -\n new Date(exec.started_at).getTime();\n trace(`${chalk.yellow(elapsed.toLocaleString())} ms`);\n } else trace(chalk.red(exec.error.name));\n },\n simultaneous: options.simultaneous,\n });\n\n // TERMINATE - WAIT FOR BACKGROUND EVENTS\n await sleep_for(2500);\n await props.close(backend);\n\n const failures: DynamicExecutor.IExecution[] = report.executions.filter(\n (exec) => exec.error !== null,\n );\n if (failures.length === 0) {\n console.log("Success");\n console.log("Elapsed time", report.time.toLocaleString(), `ms`);\n } else {\n for (const f of failures) console.log(f.error);\n process.exit(-1);\n }\n\n console.log(\n [\n `All: #${report.executions.length}`,\n `Success: #${report.executions.length - failures.length}`,\n `Failed: #${failures.length}`,\n ].join("\\n"),\n );\n };\n}\n\nconst getOptions = () =>\n ArgumentParser.parse<TestAutomation.IOptions>(\n async (command, prompt, action) => {\n command.option(\n "--simultaneous <number>",\n "number of simultaneous requests",\n );\n command.option("--include <string...>", "include feature files");\n command.option("--exclude <string...>", "exclude feature files");\n\n return action(async (options) => {\n options.simultaneous = Number(\n options.simultaneous ??\n (await prompt.number("simultaneous")(\n "Number of simultaneous requests to make",\n )),\n );\n return options as TestAutomation.IOptions;\n });\n },\n );\n'
|
|
180
192
|
}, {
|
|
181
193
|
location: "test/benchmark",
|
|
182
194
|
file: "index.ts",
|
|
183
|
-
content: 'import { DynamicBenchmarker } from "@nestia/benchmark";\
|
|
195
|
+
content: 'import { DynamicBenchmarker } from "@nestia/benchmark";\nimport cliProgress from "cli-progress";\nimport fs from "fs";\nimport os from "os";\nimport { IPointer } from "tstl";\n\nimport { MyBackend } from "../../src/MyBackend";\nimport { MyConfiguration } from "../../src/MyConfiguration";\nimport { MyGlobal } from "../../src/MyGlobal";\nimport { ArgumentParser } from "../helpers/ArgumentParser";\n\ninterface IOptions {\n include?: string[];\n exclude?: string[];\n count: number;\n threads: number;\n simultaneous: number;\n}\n\nconst getOptions = () =>\n ArgumentParser.parse<IOptions>(async (command, prompt, action) => {\n // command.option("--mode <string>", "target mode");\n // command.option("--reset <true|false>", "reset local DB or not");\n command.option("--include <string...>", "include feature files");\n command.option("--exclude <string...>", "exclude feature files");\n command.option("--count <number>", "number of requests to make");\n command.option("--threads <number>", "number of threads to use");\n command.option(\n "--simultaneous <number>",\n "number of simultaneous requests to make",\n );\n return action(async (options) => {\n // if (typeof options.reset === "string")\n // options.reset = options.reset === "true";\n // options.mode ??= await prompt.select("mode")("Select mode")([\n // "LOCAL",\n // "DEV",\n // "REAL",\n // ]);\n // options.reset ??= await prompt.boolean("reset")("Reset local DB");\n options.count = Number(\n options.count ??\n (await prompt.number("count")("Number of requests to make")),\n );\n options.threads = Number(\n options.threads ??\n (await prompt.number("threads")("Number of threads to use")),\n );\n options.simultaneous = Number(\n options.simultaneous ??\n (await prompt.number("simultaneous")(\n "Number of simultaneous requests to make",\n )),\n );\n return options as IOptions;\n });\n });\n\nconst main = async (): Promise<void> => {\n // CONFIGURATIONS\n const options: IOptions = await getOptions();\n MyGlobal.testing = true;\n\n // BACKEND SERVER\n const backend: MyBackend = new MyBackend();\n await backend.open();\n\n // DO BENCHMARK\n const prev: IPointer<number> = { value: 0 };\n const bar: cliProgress.SingleBar = new cliProgress.SingleBar(\n {},\n cliProgress.Presets.shades_classic,\n );\n bar.start(options.count, 0);\n\n const report: DynamicBenchmarker.IReport = await DynamicBenchmarker.master({\n servant: `${__dirname}/servant.js`,\n count: options.count,\n threads: options.threads,\n simultaneous: options.simultaneous,\n filter: (func) =>\n (!options.include?.length ||\n (options.include ?? []).some((str) => func.includes(str))) &&\n (!options.exclude?.length ||\n (options.exclude ?? []).every((str) => !func.includes(str))),\n progress: (value: number) => {\n if (value >= 100 + prev.value) {\n bar.update(value);\n prev.value = value;\n }\n },\n stdio: "ignore",\n });\n bar.stop();\n\n // DOCUMENTATION\n try {\n await fs.promises.mkdir(`${MyConfiguration.ROOT}/docs/benchmarks`, {\n recursive: true,\n });\n } catch {}\n await fs.promises.writeFile(\n `${MyConfiguration.ROOT}/docs/benchmarks/${os\n .cpus()[0]\n .model.trim()\n .split("\\\\")\n .join("")\n .split("/")\n .join("")}.md`,\n DynamicBenchmarker.markdown(report),\n "utf8",\n );\n\n // CLOSE\n await backend.close();\n};\nmain().catch((exp) => {\n console.error(exp);\n process.exit(-1);\n});\n'
|
|
184
196
|
}, {
|
|
185
197
|
location: "test/benchmark",
|
|
186
198
|
file: "servant.ts",
|
|
187
|
-
content: 'import { DynamicBenchmarker } from "@nestia/benchmark";\
|
|
199
|
+
content: 'import { DynamicBenchmarker } from "@nestia/benchmark";\n\nimport { MyConfiguration } from "../../src/MyConfiguration";\n\nDynamicBenchmarker.servant({\n connection: {\n host: `http://127.0.0.1:${MyConfiguration.API_PORT()}`,\n },\n location: `${__dirname}/../features`,\n parameters: (connection) => [connection],\n prefix: "test_api_",\n}).catch((exp) => {\n console.error(exp);\n process.exit(-1);\n});\n'
|
|
188
200
|
}, {
|
|
189
201
|
location: "test/helpers",
|
|
190
202
|
file: "ArgumentParser.ts",
|
|
191
|
-
content: 'import commander from "commander";\
|
|
203
|
+
content: 'import commander from "commander";\nimport * as inquirer from "inquirer";\n\nexport namespace ArgumentParser {\n export type Inquiry<T> = (\n command: commander.Command,\n prompt: (opt?: inquirer.StreamOptions) => inquirer.PromptModule,\n action: (closure: (options: Partial<T>) => Promise<T>) => Promise<T>,\n ) => Promise<T>;\n\n export interface Prompt {\n select: (\n name: string,\n ) => (\n message: string,\n ) => <Choice extends string>(choices: Choice[]) => Promise<Choice>;\n boolean: (name: string) => (message: string) => Promise<boolean>;\n number: (name: string) => (message: string) => Promise<number>;\n }\n\n export const parse = async <T>(\n inquiry: (\n command: commander.Command,\n prompt: Prompt,\n action: (closure: (options: Partial<T>) => Promise<T>) => Promise<T>,\n ) => Promise<T>,\n ): Promise<T> => {\n // TAKE OPTIONS\n const action = (closure: (options: Partial<T>) => Promise<T>) =>\n new Promise<T>((resolve, reject) => {\n commander.program.action(async (options) => {\n try {\n resolve(await closure(options));\n } catch (exp) {\n reject(exp);\n }\n });\n commander.program.parseAsync().catch(reject);\n });\n\n const select =\n (name: string) =>\n (message: string) =>\n async <Choice extends string>(choices: Choice[]): Promise<Choice> =>\n (\n await inquirer.createPromptModule()({\n type: "list",\n name,\n message,\n choices,\n })\n )[name];\n const boolean = (name: string) => async (message: string) =>\n (\n await inquirer.createPromptModule()({\n type: "confirm",\n name,\n message,\n })\n )[name] as boolean;\n const number = (name: string) => async (message: string) =>\n Number(\n (\n await inquirer.createPromptModule()({\n type: "number",\n name,\n message,\n })\n )[name],\n );\n\n const output: T | Error = await (async () => {\n try {\n return await inquiry(\n commander.program,\n { select, boolean, number },\n action,\n );\n } catch (error) {\n return error as Error;\n }\n })();\n\n // RETURNS\n if (output instanceof Error) throw output;\n return output;\n };\n}\n'
|
|
192
204
|
}, {
|
|
193
205
|
location: "test",
|
|
194
206
|
file: "index.ts",
|
|
195
|
-
content: 'import {
|
|
207
|
+
content: 'import { MyBackend } from "../src/MyBackend";\nimport { MyGlobal } from "../src/MyGlobal";\nimport { TestAutomation } from "./TestAutomation";\n\nconst main = async (): Promise<void> => {\n MyGlobal.testing = true;\n await TestAutomation.execute({\n open: async () => {\n const backend: MyBackend = new MyBackend();\n await backend.open();\n return backend;\n },\n close: (backend) => backend.close(),\n });\n};\nmain().catch((exp) => {\n console.log(exp);\n process.exit(-1);\n});\n'
|
|
196
208
|
}, {
|
|
197
209
|
location: "test",
|
|
198
210
|
file: "tsconfig.json",
|
|
199
|
-
content: '{\
|
|
211
|
+
content: '{\n "extends": "../tsconfig.json",\n "compilerOptions": {\n "outDir": "../bin",\n },\n "include": [".", "../src"]\n}'
|
|
200
212
|
}, {
|
|
201
213
|
location: "test",
|
|
202
214
|
file: "webpack.ts",
|
|
203
|
-
content: 'import
|
|
215
|
+
content: 'import cp from "child_process";\nimport { sleep_for } from "tstl";\n\nimport { MyConfiguration } from "../src/MyConfiguration";\nimport { MyGlobal } from "../src/MyGlobal";\nimport api from "../src/api";\nimport { TestAutomation } from "./TestAutomation";\n\nconst wait = async (): Promise<void> => {\n const connection: api.IConnection = {\n host: `http://localhost:${MyConfiguration.API_PORT()}`,\n };\n while (true)\n try {\n await api.functional.health(connection);\n return;\n } catch {\n await sleep_for(100);\n }\n};\n\nconst main = async (): Promise<void> => {\n MyGlobal.testing = true;\n await TestAutomation.execute({\n open: async () => {\n const backend: cp.ChildProcess = cp.fork(\n `${MyConfiguration.ROOT}/dist/server.js`,\n {\n cwd: `${MyConfiguration.ROOT}/dist`,\n },\n );\n await wait();\n return backend;\n },\n close: async (backend) => {\n backend.kill();\n },\n });\n};\nmain().catch((exp) => {\n console.log(exp);\n process.exit(-1);\n});\n'
|
|
204
216
|
}, {
|
|
205
217
|
location: "",
|
|
206
218
|
file: "tsconfig.json",
|
|
207
|
-
content: '{\r\n "compilerOptions": {\r\n /* Visit https://aka.ms/tsconfig to read more about this file */\r\n\r\n /* Projects */\r\n // "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */\r\n // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */\r\n // "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */\r\n // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */\r\n // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */\r\n // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */\r\n\r\n /* Language and Environment */\r\n "target": "ES2015", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */\r\n // "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */\r\n // "jsx": "preserve", /* Specify what JSX code is generated. */\r\n "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */\r\n "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */\r\n // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. \'React.createElement\' or \'h\'. */\r\n // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. \'React.Fragment\' or \'Fragment\'. */\r\n // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using \'jsx: react-jsx*\'. */\r\n // "reactNamespace": "", /* Specify the object invoked for \'createElement\'. This only applies when targeting \'react\' JSX emit. */\r\n // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */\r\n // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */\r\n // "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */\r\n\r\n /* Modules */\r\n "module": "commonjs", /* Specify what module code is generated. */\r\n // "rootDir": "./", /* Specify the root folder within your source files. */\r\n // "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */\r\n // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */\r\n "paths": {\r\n "@ORGANIZATION/PROJECT-api/lib/*": ["./src/api/*"],\r\n "@ORGANIZATION/PROJECT-api": ["./src/api"],\r\n }, /* Specify a set of entries that re-map imports to additional lookup locations. */\r\n // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */\r\n // "typeRoots": [], /* Specify multiple folders that act like \'./node_modules/@types\'. */\r\n // "types": [], /* Specify type package names to be included without being referenced in a source file. */\r\n // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */\r\n // "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */\r\n // "resolveJsonModule": true, /* Enable importing .json files. */\r\n // "noResolve": true, /* Disallow \'import\'s, \'require\'s or \'<reference>\'s from expanding the number of files TypeScript should add to a project. */\r\n\r\n /* JavaScript Support */\r\n // "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the \'checkJS\' option to get errors from these files. */\r\n // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */\r\n // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from \'node_modules\'. Only applicable with \'allowJs\'. */\r\n\r\n /* Emit */\r\n // "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */\r\n // "declarationMap": true, /* Create sourcemaps for d.ts files. */\r\n // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */\r\n "sourceMap": true, /* Create source map files for emitted JavaScript files. */\r\n // "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. */\r\n "outDir": "./lib", /* Specify an output folder for all emitted files. */\r\n // "removeComments": true, /* Disable emitting comments. */\r\n // "noEmit": true, /* Disable emitting files from a compilation. */\r\n // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */\r\n // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */\r\n // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */\r\n // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */\r\n // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */\r\n // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */\r\n // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */\r\n // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */\r\n "newLine": "lf", /* Set the newline character for emitting files. */\r\n "stripInternal": true, /* Disable emitting declarations that have \'@internal\' in their JSDoc comments. */\r\n // "noEmitHelpers": true, /* Disable generating custom helper functions like \'__extends\' in compiled output. */\r\n // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */\r\n // "preserveConstEnums": true, /* Disable erasing \'const enum\' declarations in generated code. */\r\n // "declarationDir": "./", /* Specify the output directory for generated declaration files. */\r\n // "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */\r\n\r\n /* Interop Constraints */\r\n // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */\r\n // "allowSyntheticDefaultImports": true, /* Allow \'import x from y\' when a module doesn\'t have a default export. */\r\n "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables \'allowSyntheticDefaultImports\' for type compatibility. */\r\n // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */\r\n "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */\r\n\r\n /* Type Checking */\r\n "strict": true, /* Enable all strict type-checking options. */\r\n // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied \'any\' type. */\r\n // "strictNullChecks": true, /* When type checking, take into account \'null\' and \'undefined\'. */\r\n // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */\r\n // "strictBindCallApply": true, /* Check that the arguments for \'bind\', \'call\', and \'apply\' methods match the original function. */\r\n // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */\r\n // "noImplicitThis": true, /* Enable error reporting when \'this\' is given the type \'any\'. */\r\n // "useUnknownInCatchVariables": true, /* Default catch clause variables as \'unknown\' instead of \'any\'. */\r\n // "alwaysStrict": true, /* Ensure \'use strict\' is always emitted. */\r\n "noUnusedLocals": true, /* Enable error reporting when local variables aren\'t read. */\r\n "noUnusedParameters": true, /* Raise an error when a function parameter isn\'t read. */\r\n // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding \'undefined\'. */\r\n "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */\r\n "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */\r\n // "noUncheckedIndexedAccess": true, /* Add \'undefined\' to a type when accessed using an index. */\r\n // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */\r\n // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */\r\n // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */\r\n // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */\r\n\r\n /* Completeness */\r\n // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */\r\n "skipLibCheck": true, /* Skip type checking all .d.ts files. */\r\n "plugins": [\r\n { "transform": "typescript-transform-paths" },\r\n { "transform": "typia/lib/transform" },\r\n { "transform": "@nestia/core/lib/transform" },\r\n ]\r\n },\r\n "include": [\r\n "src"\r\n ],\r\n "exclude": [\r\n "node_modules",\r\n "packages",\r\n ]\r\n}\r\n'
|
|
219
|
+
content: '{\n "compilerOptions": {\n /* Visit https://aka.ms/tsconfig to read more about this file */\n\n /* Projects */\n // "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */\n // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */\n // "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */\n // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */\n // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */\n // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */\n\n /* Language and Environment */\n "target": "ES2015", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */\n // "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */\n // "jsx": "preserve", /* Specify what JSX code is generated. */\n "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */\n "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */\n // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. \'React.createElement\' or \'h\'. */\n // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. \'React.Fragment\' or \'Fragment\'. */\n // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using \'jsx: react-jsx*\'. */\n // "reactNamespace": "", /* Specify the object invoked for \'createElement\'. This only applies when targeting \'react\' JSX emit. */\n // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */\n // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */\n // "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */\n\n /* Modules */\n "module": "commonjs", /* Specify what module code is generated. */\n // "rootDir": "./", /* Specify the root folder within your source files. */\n // "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */\n // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */\n "paths": {\n "@ORGANIZATION/PROJECT-api/lib/*": ["./src/api/*"],\n "@ORGANIZATION/PROJECT-api": ["./src/api"],\n }, /* Specify a set of entries that re-map imports to additional lookup locations. */\n // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */\n // "typeRoots": [], /* Specify multiple folders that act like \'./node_modules/@types\'. */\n // "types": [], /* Specify type package names to be included without being referenced in a source file. */\n // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */\n // "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */\n // "resolveJsonModule": true, /* Enable importing .json files. */\n // "noResolve": true, /* Disallow \'import\'s, \'require\'s or \'<reference>\'s from expanding the number of files TypeScript should add to a project. */\n\n /* JavaScript Support */\n // "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the \'checkJS\' option to get errors from these files. */\n // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */\n // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from \'node_modules\'. Only applicable with \'allowJs\'. */\n\n /* Emit */\n // "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */\n // "declarationMap": true, /* Create sourcemaps for d.ts files. */\n // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */\n "sourceMap": true, /* Create source map files for emitted JavaScript files. */\n // "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. */\n "outDir": "./lib", /* Specify an output folder for all emitted files. */\n // "removeComments": true, /* Disable emitting comments. */\n // "noEmit": true, /* Disable emitting files from a compilation. */\n // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */\n // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */\n // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */\n // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */\n // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */\n // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */\n // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */\n // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */\n "newLine": "lf", /* Set the newline character for emitting files. */\n "stripInternal": true, /* Disable emitting declarations that have \'@internal\' in their JSDoc comments. */\n // "noEmitHelpers": true, /* Disable generating custom helper functions like \'__extends\' in compiled output. */\n // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */\n // "preserveConstEnums": true, /* Disable erasing \'const enum\' declarations in generated code. */\n // "declarationDir": "./", /* Specify the output directory for generated declaration files. */\n // "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */\n\n /* Interop Constraints */\n // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */\n // "allowSyntheticDefaultImports": true, /* Allow \'import x from y\' when a module doesn\'t have a default export. */\n "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables \'allowSyntheticDefaultImports\' for type compatibility. */\n // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */\n "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */\n\n /* Type Checking */\n "strict": true, /* Enable all strict type-checking options. */\n // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied \'any\' type. */\n // "strictNullChecks": true, /* When type checking, take into account \'null\' and \'undefined\'. */\n // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */\n // "strictBindCallApply": true, /* Check that the arguments for \'bind\', \'call\', and \'apply\' methods match the original function. */\n // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */\n // "noImplicitThis": true, /* Enable error reporting when \'this\' is given the type \'any\'. */\n // "useUnknownInCatchVariables": true, /* Default catch clause variables as \'unknown\' instead of \'any\'. */\n // "alwaysStrict": true, /* Ensure \'use strict\' is always emitted. */\n "noUnusedLocals": true, /* Enable error reporting when local variables aren\'t read. */\n "noUnusedParameters": true, /* Raise an error when a function parameter isn\'t read. */\n // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding \'undefined\'. */\n "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */\n "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */\n // "noUncheckedIndexedAccess": true, /* Add \'undefined\' to a type when accessed using an index. */\n // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */\n // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */\n // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */\n // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */\n\n /* Completeness */\n // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */\n "skipLibCheck": true, /* Skip type checking all .d.ts files. */\n "plugins": [\n { "transform": "typescript-transform-paths" },\n { "transform": "typia/lib/transform" },\n { \n "transform": "@nestia/core/lib/transform",\n /**\n * Validate request body.\n * \n * - "assert": Use typia.assert() function\n * - "is": Use typia.is() function\n * - "validate": Use typia.validate() function\n * - "assertEquals": Use typia.assertEquals() function\n * - "equals": Use typia.equals() function\n * - "validateEquals": Use typia.validateEquals() function\n */\n "validate": "validate",\n /**\n * Validate JSON typed response body.\n * \n * - "assert": Use typia.assertStringify() function\n * - "is": Use typia.isStringify() function\n * - "validate": Use typia.validateStringify() function\n * - "validate.log": typia.validateStringify(), but do not throw and just log it\n * - "stringify": Use typia.stringify() function, but dangerous\n * - null: Just use JSON.stringify() function, without boosting\n */\n "stringify": "assert",\n },\n ]\n },\n "include": [\n "src"\n ],\n "exclude": [\n "node_modules",\n "packages",\n ]\n}\n'
|
|
220
|
+
}, {
|
|
221
|
+
location: "",
|
|
222
|
+
file: "typos.toml",
|
|
223
|
+
content: '[default]\nlocale = \'en-us\'\nextend-ignore-re = [\n "(?Rm)^.*(\x3c!--|#|//)\\\\s*spellchecker:disable-line(--\x3e|\\n)?$",\n "(?s)(\x3c!--|#|//)\\\\s*spellchecker:off\\\\s*(--\x3e|\\n).*?(\x3c!--|#|//)\\\\s*spellchecker:on",\n]\n\n[default.extend-words]\nJeongho = "Jeongho"\nNam = "Nam"\ntypia = "typia"\n\n[files]\nextend-exclude = ["*.json"]'
|
|
208
224
|
}, {
|
|
209
225
|
location: "",
|
|
210
226
|
file: "webpack.config.js",
|
|
211
|
-
content: 'const path = require("path");\
|
|
227
|
+
content: 'const path = require("path");\n\nconst CopyWebpackPlugin = require("copy-webpack-plugin");\nconst WriteFilePlugin = require("write-file-webpack-plugin");\nconst { IgnorePlugin } = require("webpack");\n\nconst lazyImports = [\n "@fastify/static",\n "@fastify/view",\n "@nestjs/microservices",\n "@nestjs/websockets",\n "class-transformer",\n "class-validator",\n];\n\n// @reference https://tech-blog.s-yoshiki.com/entry/297\nmodule.exports = {\n // CUSTOMIZE HERE\n entry: {\n server: "./src/executable/server.ts",\n },\n output: {\n path: path.join(__dirname, "dist"),\n filename: "[name].js",\n },\n optimization: {\n minimize: true,\n },\n\n // JUST KEEP THEM\n mode: "production",\n target: "node",\n module: {\n rules: [\n {\n test: /\\.ts$/,\n exclude: /node_modules/,\n loader: "ts-loader",\n },\n ],\n },\n resolve: {\n extensions: [".tsx", ".ts", ".js"],\n },\n plugins: [\n new CopyWebpackPlugin({\n patterns: [\n {\n from: ".env",\n to: "[name][ext]",\n },\n // {\n // from: "./node_modules/.prisma/client/*.node",\n // to: () => Promise.resolve("[path][name][ext]"),\n // globOptions: {\n // dot: true,\n // },\n // },\n ],\n }),\n new WriteFilePlugin(),\n new IgnorePlugin({\n checkResource: (resource) => {\n if (lazyImports.some((modulo) => resource.startsWith(modulo))) {\n try {\n require.resolve(resource);\n } catch (err) {\n return true;\n }\n }\n return false;\n },\n }),\n ],\n};\n'
|
|
212
228
|
} ];
|
|
213
229
|
|
|
214
230
|
const SDK_TEMPLATE = [ {
|
|
215
231
|
location: "",
|
|
216
232
|
file: ".gitignore",
|
|
217
|
-
content: ".git/\
|
|
233
|
+
content: ".git/\nbin/\nlib/\nnode_modules/\n\npackage-lock.json\npnpm-lock.yaml"
|
|
218
234
|
}, {
|
|
219
235
|
location: ".vscode",
|
|
220
236
|
file: "launch.json",
|
|
221
|
-
content: '{\
|
|
237
|
+
content: '{\n // Use IntelliSense to learn about possible Node.js debug attributes.\n // Hover to view descriptions of existing attributes.\n // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387\n "version": "0.2.0",\n "configurations": [\n {\n "type": "node",\n "request": "launch",\n "name": "JavaScript Test using SourceMap",\n "program": "${workspaceRoot}/test/index.ts",\n "cwd": "${workspaceRoot}",\n "args": [\n //----\n // You can run specific test functions\n //----\n // "--include", "something",\n // "--exclude", "nothing",\n ],\n "outFiles": ["${workspaceRoot}/bin/**/*.js"],\n }\n ]\n}'
|
|
222
238
|
}, {
|
|
223
239
|
location: ".vscode",
|
|
224
240
|
file: "settings.json",
|
|
225
|
-
content: '{\
|
|
241
|
+
content: '{\n "editor.tabSize": 2,\n "editor.formatOnSave": true,\n "[javascript][typescript]": {\n "editor.defaultFormatter": "esbenp.prettier-vscode",\n "editor.codeActionsOnSave": {\n "source.fixAll.eslint": "explicit"\n },\n },\n}'
|
|
226
242
|
}, {
|
|
227
243
|
location: "",
|
|
228
|
-
file: "
|
|
229
|
-
content: '
|
|
244
|
+
file: "LICENSE",
|
|
245
|
+
content: 'MIT License\n\nCopyright (c) 2024 Jeongho Nam\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the "Software"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n'
|
|
230
246
|
}, {
|
|
231
247
|
location: "",
|
|
232
|
-
file: "
|
|
233
|
-
content: '
|
|
248
|
+
file: "README.md",
|
|
249
|
+
content: '# Software Development Kit\nThis is a SDK library generated by [`@nestia/migrate`](https://nestia.io/docs/migrate) or [`@nestia/editor`](https://nestia.io/docs/editor).\n\nWith this SDK library, you can easily and safely interact with backend server.\n\nJust import and call some API functions like gif image below:\n\n\n\n> Left is server code, and right is client code utilizing the SDK\n\n\n\n\n## How to Test\n```bash\nnpm install\nnpm start # run only "test/start.ts" file\nnpm run test # everything under the "test/features" directory\nnpm run test:simulate # "test/features" with mockup simulation mode\n```\n\nIf you run `npm start` command, only [test/start.ts](test/start.ts) file would be executed.\n\nOtherwise you run `npm run test` command instead, run everything in the [test/features](test/features) directory.\n\nFor reference, the [test/features](test/features) directory and E2E test functions (for each API endpoints) would be automatically composed only when you\'ve configured the "E2E test function generation mode" of the `@nestia/migrate` (or `@nestia/editor`).\n\n```bash\nnpm install -g @nestia/migrate\nnpx @nestia/migrate\n? Migration mode (Use arrow keys):\n NestJS\n > SDK\n? Swagger file location: assets/input/clickhouse.json\n? Output directory path: assets/output/clickhouse-sdk-manual\n? Mokup Simulator: true\n? E2E Test Functions: true\n```\n\n\n\n\n## Deploy\n```bash\nnpm install\nnpm run deploy\n```\n\nJust run `npm run deploy` command, then your SDK library would be published.\n\nBy the way, the initial package name of this template repository is `@ORGANIZATION/PROJECT-api`. I think it would better to change the word to your own organization and project name. If you\'re utilizing `VsCode`, you can do it through `Edit > Replace in Files` (*Ctrl + Shift + H*) feature.\n\n-----------\n\n> ## What [`Nestia`](https://nestia.io) is:\n> \n> \n> [](https://github.com/samchon/nestia/blob/master/LICENSE)\n> [](https://www.npmjs.com/package/@nestia/core)\n> [](https://www.npmjs.com/package/@nestia/core)\n> [](https://github.com/samchon/nestia/actions?query=workflow%3Abuild)\n> [](https://nestia.io/docs/)\n> \n> Nestia is a set of helper libraries for NestJS, supporting below features:\n> \n> - `@nestia/core`: Super-fast decorators\n> - `@nestia/sdk`:\n> - Swagger generator evolved than ever\n> - SDK library generator for clients\n> - Mockup Simulator for client applications\n> - Automatic E2E test functions generator\n> - `@nestia/migrate`: Migration from Swagger to NestJS\n> - `@nestia/editor`: Online TypeScript Swagger Editor\n> - `nestia`: Just CLI (command line interface) tool\n> \n>> **Note**\n>> \n>> - **Only one line** required, with pure TypeScript type\n>> - Enhance performance **30x** up\n>> - Runtime validator is **20,000x faster** than `class-validator`\n>> - JSON serialization is **200x faster** than `class-transformer`\n>> - Software Development Kit\n>> - SDK is a collection of `fetch` functions with type definitions like [tRPC](https://> trpc.io/)\n>> - Mockup simulator means embedded backend simulator in SDK\n>> - similar with [msw](https://mswjs.io/), but fully automated'
|
|
234
250
|
}, {
|
|
235
251
|
location: "",
|
|
236
|
-
file: "
|
|
237
|
-
content: '
|
|
252
|
+
file: "hello.js",
|
|
253
|
+
content: 'function print(command, description) {\n return console.log(`\\x1b[1m${command}\\x1b[2m: ${description}\\x1b[0m`);\n}\n\nconsole.log("-----------------------------------------");\nconsole.log("\\x1b[7mGenerated by \\x1b[2m@nestia/editor\\x1b[0m");\nconsole.log("");\nconsole.log(" - \\x1b[36mhttps://nestia.io/docs/editor\\x1b[0m");\nconsole.log(" - \\x1b[36mhttps://github.com/samchon/nestia\\x1b[0m");\nconsole.log("-----------------------------------------");\n\nprint("npm run start", "Run only test/start.ts");\nprint("npm run test", "Run every test/features/**/*.ts files");\nprint("npm run test:simulate", "Test with mockup simulator");\n'
|
|
238
254
|
}, {
|
|
239
255
|
location: "",
|
|
240
|
-
file: "
|
|
241
|
-
content: 'module.
|
|
256
|
+
file: "package.json",
|
|
257
|
+
content: '{\n "name": "@ORGANIZATION/PROJECT-api",\n "version": "0.1.0",\n "description": "SDK library generated by Nestia",\n "main": "lib/index.js",\n "module": "lib/index.mjs",\n "typings": "lib/index.d.ts",\n "scripts": {\n "build": "rimraf lib && tsc && rollup -c",\n "build:test": "rimraf bin && tsc --project test/tsconfig.json",\n "deploy": "npm run build && npm publish",\n "dev": "npm run build:test -- --watch",\n "hello": "node hello",\n "prepare": "ts-patch install && typia patch",\n "start": "ts-node test/start.ts",\n "swagger": "ts-node test/swagger.ts",\n "test": "ts-node test/index.ts",\n "test:simulate": "ts-node test/index.ts --simulate true",\n "test:manual": "ts-node test/manual.ts"\n },\n "repository": {\n "type": "git",\n "url": "https://github.com/samchon/nestia"\n },\n "author": "Jeongho Nam",\n "license": "MIT",\n "bugs": {\n "url": "https://github.com/samchon/nestia/issues"\n },\n "homepage": "https://nestia.io",\n "files": [\n "lib",\n "swagger.json",\n "package.json",\n "README.md"\n ],\n "dependencies": {\n "@nestia/fetcher": "^4.6.2",\n "tgrid": "^1.1.0",\n "typia": "^7.6.4"\n },\n "devDependencies": {\n "@nestia/e2e": "^0.8.0",\n "@rollup/plugin-terser": "^0.4.4",\n "@rollup/plugin-typescript": "^11.1.6",\n "@trivago/prettier-plugin-sort-imports": "^4.3.0",\n "@types/express": "^4.17.21",\n "@types/inquirer": "8.2.5",\n "@types/swagger-ui-express": "^4.1.6",\n "chalk": "4.1.2",\n "commander": "^10.0.0",\n "express": "^4.19.2",\n "inquirer": "8.2.5",\n "prettier": "^3.2.5",\n "rimraf": "^5.0.5",\n "rollup": "^4.13.2",\n "swagger-ui-express": "^5.0.0",\n "ts-node": "^10.9.2",\n "ts-patch": "^3.3.0",\n "typescript": "~5.7.3",\n "typescript-transform-paths": "^3.5.3"\n }\n}'
|
|
242
258
|
}, {
|
|
243
259
|
location: "",
|
|
244
|
-
file: "
|
|
245
|
-
content: '
|
|
260
|
+
file: "prettier.config.js",
|
|
261
|
+
content: 'module.exports = {\n // DEFAULT CONFIGURATIONS\n parser: "typescript",\n printWidth: 80,\n semi: true,\n tabWidth: 2,\n trailingComma: "all",\n\n // PLUG-IN CONFIGURATIONS\n plugins: ["@trivago/prettier-plugin-sort-imports"],\n importOrder: ["<THIRD_PARTY_MODULES>", "^[./]"],\n importOrderSeparation: true,\n importOrderSortSpecifiers: true,\n importOrderParserPlugins: ["decorators-legacy", "typescript", "jsx"],\n};\n'
|
|
246
262
|
}, {
|
|
247
263
|
location: "",
|
|
248
264
|
file: "rollup.config.js",
|
|
249
|
-
content: 'const typescript = require("@rollup/plugin-typescript");\
|
|
265
|
+
content: 'const typescript = require("@rollup/plugin-typescript");\nconst terser = require("@rollup/plugin-terser");\n\nmodule.exports = {\n input: "./src/index.ts",\n output: {\n dir: "lib",\n format: "esm",\n entryFileNames: "[name].mjs",\n sourcemap: true,\n },\n plugins: [\n typescript({\n tsconfig: "tsconfig.json",\n module: "ES2020",\n target: "ES2020",\n }),\n terser({\n format: {\n comments: "some",\n beautify: true,\n ecma: "2020",\n },\n compress: false,\n mangle: false,\n module: true,\n }),\n ],\n};\n'
|
|
250
266
|
}, {
|
|
251
267
|
location: "src",
|
|
252
268
|
file: "HttpError.ts",
|
|
253
|
-
content: 'export { HttpError } from "@nestia/fetcher";\
|
|
269
|
+
content: 'export { HttpError } from "@nestia/fetcher";\n'
|
|
254
270
|
}, {
|
|
255
271
|
location: "src",
|
|
256
272
|
file: "IConnection.ts",
|
|
257
|
-
content: 'export type { IConnection } from "@nestia/fetcher";\
|
|
273
|
+
content: 'export type { IConnection } from "@nestia/fetcher";\n'
|
|
258
274
|
}, {
|
|
259
275
|
location: "src",
|
|
260
276
|
file: "index.ts",
|
|
261
|
-
content: 'import * as api from "./module";\
|
|
277
|
+
content: 'import * as api from "./module";\n\nexport * from "./module";\nexport default api;\n'
|
|
262
278
|
}, {
|
|
263
279
|
location: "src",
|
|
264
280
|
file: "module.ts",
|
|
265
|
-
content: 'export type * from "./IConnection";\
|
|
281
|
+
content: 'export type * from "./IConnection";\nexport * from "./HttpError";\n\nexport * as functional from "./functional";\n'
|
|
266
282
|
}, {
|
|
267
283
|
location: "",
|
|
268
284
|
file: "swagger.json",
|
|
269
|
-
content: '{\r\n "openapi": "3.0.1",\r\n "servers": [\r\n {\r\n "url": "http://localhost:37001",\r\n "description": "Local Server"\r\n }\r\n ],\r\n "info": {\r\n "version": "2.2.0",\r\n "title": "@samchon/bbs-backend",\r\n "description": "Backend for bbs",\r\n "license": {\r\n "name": "MIT"\r\n }\r\n },\r\n "paths": {\r\n "/bbs/articles": {\r\n "patch": {\r\n "tags": [\r\n "BBS"\r\n ],\r\n "parameters": [],\r\n "requestBody": {\r\n "description": "Request info of pagination and searching options.",\r\n "content": {\r\n "application/json": {\r\n "schema": {\r\n "$ref": "#/components/schemas/IBbsArticle.IRequest"\r\n }\r\n }\r\n },\r\n "required": true\r\n },\r\n "responses": {\r\n "200": {\r\n "description": "Paginated summarized articles.",\r\n "content": {\r\n "application/json": {\r\n "schema": {\r\n "$ref": "#/components/schemas/IPageIBbsArticle.ISummary"\r\n }\r\n }\r\n }\r\n }\r\n },\r\n "summary": "List up all summarized articles",\r\n "description": "List up all summarized articles.\\n\\nList up all summarized articles with pagination and searching options."\r\n },\r\n "post": {\r\n "tags": [\r\n "BBS"\r\n ],\r\n "parameters": [],\r\n "requestBody": {\r\n "description": "Article information to create.",\r\n "content": {\r\n "application/json": {\r\n "schema": {\r\n "$ref": "#/components/schemas/IBbsArticle.ICreate"\r\n }\r\n }\r\n },\r\n "required": true\r\n },\r\n "responses": {\r\n "201": {\r\n "description": "Newly created article.",\r\n "content": {\r\n "application/json": {\r\n "schema": {\r\n "$ref": "#/components/schemas/IBbsArticle"\r\n }\r\n }\r\n }\r\n }\r\n },\r\n "summary": "Create a new article",\r\n "description": "Create a new article.\\n\\nCreate a new article with its first {@link IBbsArticle.ISnapshot snapshot}."\r\n }\r\n },\r\n "/bbs/articles/abridges": {\r\n "patch": {\r\n "tags": [\r\n "BBS"\r\n ],\r\n "parameters": [],\r\n "requestBody": {\r\n "description": "Request info of pagination and searching options.",\r\n "content": {\r\n "application/json": {\r\n "schema": {\r\n "$ref": "#/components/schemas/IBbsArticle.IRequest"\r\n }\r\n }\r\n },\r\n "required": true\r\n },\r\n "responses": {\r\n "200": {\r\n "description": "Paginated abridged articles.",\r\n "content": {\r\n "application/json": {\r\n "schema": {\r\n "$ref": "#/components/schemas/IPageIBbsArticle.IAbridge"\r\n }\r\n }\r\n }\r\n }\r\n },\r\n "summary": "List up all abridged articles",\r\n "description": "List up all abridged articles.\\n\\nList up all abridged articles with pagination and searching options."\r\n }\r\n },\r\n "/bbs/articles/{id}": {\r\n "get": {\r\n "tags": [\r\n "BBS"\r\n ],\r\n "parameters": [\r\n {\r\n "name": "id",\r\n "in": "path",\r\n "schema": {\r\n "type": "string",\r\n "format": "uuid"\r\n },\r\n "description": "Target article\'s ",\r\n "required": true\r\n }\r\n ],\r\n "responses": {\r\n "200": {\r\n "description": "Article information",\r\n "content": {\r\n "application/json": {\r\n "schema": {\r\n "$ref": "#/components/schemas/IBbsArticle"\r\n }\r\n }\r\n }\r\n }\r\n },\r\n "summary": "Read individual article",\r\n "description": "Read individual article.\\n\\nReads an article with its every {@link IBbsArticle.ISnapshot snapshots}."\r\n },\r\n "put": {\r\n "tags": [\r\n "BBS"\r\n ],\r\n "parameters": [\r\n {\r\n "name": "id",\r\n "in": "path",\r\n "schema": {\r\n "type": "string",\r\n "format": "uuid"\r\n },\r\n "description": "Target article\'s ",\r\n "required": true\r\n }\r\n ],\r\n "requestBody": {\r\n "description": "Article information to update.",\r\n "content": {\r\n "application/json": {\r\n "schema": {\r\n "$ref": "#/components/schemas/IBbsArticle.IUpdate"\r\n }\r\n }\r\n },\r\n "required": true\r\n },\r\n "responses": {\r\n "200": {\r\n "description": "Newly accumulated snapshot information.",\r\n "content": {\r\n "application/json": {\r\n "schema": {\r\n "$ref": "#/components/schemas/IBbsArticle.ISnapshot"\r\n }\r\n }\r\n }\r\n }\r\n },\r\n "summary": "Update an article",\r\n "description": "Update an article.\\n\\nAccumulate a new {@link IBbsArticle.ISnapshot snapshot} record to the article."\r\n },\r\n "delete": {\r\n "tags": [\r\n "BBS"\r\n ],\r\n "parameters": [\r\n {\r\n "name": "id",\r\n "in": "path",\r\n "schema": {\r\n "type": "string",\r\n "format": "uuid"\r\n },\r\n "description": "Target article\'s ",\r\n "required": true\r\n }\r\n ],\r\n "requestBody": {\r\n "description": "Password of the article.",\r\n "content": {\r\n "application/json": {\r\n "schema": {\r\n "$ref": "#/components/schemas/IBbsArticle.IErase"\r\n }\r\n }\r\n },\r\n "required": true\r\n },\r\n "responses": {\r\n "200": {\r\n "description": ""\r\n }\r\n },\r\n "summary": "Erase an article",\r\n "description": "Erase an article.\\n\\nPerforms soft deletion to the article."\r\n }\r\n },\r\n "/bbs/articles/{articleId}/comments": {\r\n "patch": {\r\n "tags": [\r\n "BBS"\r\n ],\r\n "parameters": [\r\n {\r\n "name": "articleId",\r\n "in": "path",\r\n "schema": {\r\n "type": "string",\r\n "format": "uuid"\r\n },\r\n "description": "",\r\n "required": true\r\n }\r\n ],\r\n "requestBody": {\r\n "description": "Request info of pagination and searching options.",\r\n "content": {\r\n "application/json": {\r\n "schema": {\r\n "$ref": "#/components/schemas/IBbsArticleComment.IRequest"\r\n }\r\n }\r\n },\r\n "required": true\r\n },\r\n "responses": {\r\n "200": {\r\n "description": "Paginated summarized comments.",\r\n "content": {\r\n "application/json": {\r\n "schema": {\r\n "$ref": "#/components/schemas/IPageIBbsArticleComment"\r\n }\r\n }\r\n }\r\n }\r\n },\r\n "summary": "List up all summarized comments",\r\n "description": "List up all summarized comments.\\n\\nList up all summarized comments with pagination and searching options."\r\n },\r\n "post": {\r\n "tags": [\r\n "BBS"\r\n ],\r\n "parameters": [\r\n {\r\n "name": "articleId",\r\n "in": "path",\r\n "schema": {\r\n "type": "string",\r\n "format": "uuid"\r\n },\r\n "description": "Belonged article\'s ",\r\n "required": true\r\n }\r\n ],\r\n "requestBody": {\r\n "description": "Comment information to create.",\r\n "content": {\r\n "application/json": {\r\n "schema": {\r\n "$ref": "#/components/schemas/IBbsArticleComment.ICreate"\r\n }\r\n }\r\n },\r\n "required": true\r\n },\r\n "responses": {\r\n "201": {\r\n "description": "Newly created comment.",\r\n "content": {\r\n "application/json": {\r\n "schema": {\r\n "$ref": "#/components/schemas/IBbsArticleComment"\r\n }\r\n }\r\n }\r\n }\r\n },\r\n "summary": "Create a new comment",\r\n "description": "Create a new comment.\\n\\nCreate a new comment with its first {@link IBbsArticleComment.ISnapshot snapshot}."\r\n }\r\n },\r\n "/bbs/articles/{articleId}/comments/{id}": {\r\n "get": {\r\n "tags": [\r\n "BBS"\r\n ],\r\n "parameters": [\r\n {\r\n "name": "articleId",\r\n "in": "path",\r\n "schema": {\r\n "type": "string",\r\n "format": "uuid"\r\n },\r\n "description": "Belonged article\'s ",\r\n "required": true\r\n },\r\n {\r\n "name": "id",\r\n "in": "path",\r\n "schema": {\r\n "type": "string",\r\n "format": "uuid"\r\n },\r\n "description": "Target comment\'s ",\r\n "required": true\r\n }\r\n ],\r\n "responses": {\r\n "200": {\r\n "description": "Comment information",\r\n "content": {\r\n "application/json": {\r\n "schema": {\r\n "$ref": "#/components/schemas/IBbsArticleComment"\r\n }\r\n }\r\n }\r\n }\r\n },\r\n "summary": "Read individual comment",\r\n "description": "Read individual comment.\\n\\nReads a comment with its every {@link IBbsArticleComment.ISnapshot snapshots}."\r\n },\r\n "put": {\r\n "tags": [\r\n "BBS"\r\n ],\r\n "parameters": [\r\n {\r\n "name": "articleId",\r\n "in": "path",\r\n "schema": {\r\n "type": "string",\r\n "format": "uuid"\r\n },\r\n "description": "Belonged article\'s ",\r\n "required": true\r\n },\r\n {\r\n "name": "id",\r\n "in": "path",\r\n "schema": {\r\n "type": "string",\r\n "format": "uuid"\r\n },\r\n "description": "Target comment\'s ",\r\n "required": true\r\n }\r\n ],\r\n "requestBody": {\r\n "description": "Comment information to update.",\r\n "content": {\r\n "application/json": {\r\n "schema": {\r\n "$ref": "#/components/schemas/IBbsArticleComment.IUpdate"\r\n }\r\n }\r\n },\r\n "required": true\r\n },\r\n "responses": {\r\n "200": {\r\n "description": "Newly accumulated snapshot information.",\r\n "content": {\r\n "application/json": {\r\n "schema": {\r\n "$ref": "#/components/schemas/IBbsArticleComment.ISnapshot"\r\n }\r\n }\r\n }\r\n }\r\n },\r\n "summary": "Update a comment",\r\n "description": "Update a comment.\\n\\nAccumulate a new {@link IBbsArticleComment.ISnapshot snapshot} record to the comment."\r\n },\r\n "delete": {\r\n "tags": [\r\n "BBS"\r\n ],\r\n "parameters": [\r\n {\r\n "name": "articleId",\r\n "in": "path",\r\n "schema": {\r\n "type": "string",\r\n "format": "uuid"\r\n },\r\n "description": "Belonged article\'s ",\r\n "required": true\r\n },\r\n {\r\n "name": "id",\r\n "in": "path",\r\n "schema": {\r\n "type": "string",\r\n "format": "uuid"\r\n },\r\n "description": "Target comment\'s ",\r\n "required": true\r\n }\r\n ],\r\n "requestBody": {\r\n "description": "Password of the comment.",\r\n "content": {\r\n "application/json": {\r\n "schema": {\r\n "$ref": "#/components/schemas/IBbsArticleComment.IErase"\r\n }\r\n }\r\n },\r\n "required": true\r\n },\r\n "responses": {\r\n "200": {\r\n "description": ""\r\n }\r\n },\r\n "summary": "Erase a comment",\r\n "description": "Erase a comment.\\n\\nPerforms soft deletion to the comment."\r\n }\r\n },\r\n "/monitors/health": {\r\n "get": {\r\n "tags": [\r\n "Monitor"\r\n ],\r\n "parameters": [],\r\n "responses": {\r\n "200": {\r\n "description": ""\r\n }\r\n },\r\n "summary": "Health check API",\r\n "description": "Health check API."\r\n }\r\n },\r\n "/monitors/performance": {\r\n "get": {\r\n "tags": [\r\n "Monitor"\r\n ],\r\n "parameters": [],\r\n "responses": {\r\n "200": {\r\n "description": "Performance info",\r\n "content": {\r\n "application/json": {\r\n "schema": {\r\n "$ref": "#/components/schemas/IPerformance"\r\n }\r\n }\r\n }\r\n }\r\n },\r\n "summary": "Get performance information",\r\n "description": "Get performance information.\\n\\nGet perofmration information composed with CPU, memory and resource usage."\r\n }\r\n },\r\n "/monitors/system": {\r\n "get": {\r\n "tags": [\r\n "Monitor"\r\n ],\r\n "parameters": [],\r\n "responses": {\r\n "200": {\r\n "description": "System info",\r\n "content": {\r\n "application/json": {\r\n "schema": {\r\n "$ref": "#/components/schemas/ISystem"\r\n }\r\n }\r\n }\r\n }\r\n },\r\n "summary": "Get system information",\r\n "description": "Get system information.\\n\\nGet system information with commit and package information."\r\n }\r\n }\r\n },\r\n "components": {\r\n "schemas": {\r\n "IBbsArticle.IRequest": {\r\n "type": "object",\r\n "properties": {\r\n "search": {\r\n "$ref": "#/components/schemas/IBbsArticle.IRequest.ISearch",\r\n "title": "Search condition",\r\n "description": "Search condition."\r\n },\r\n "sort": {\r\n "type": "array",\r\n "items": {\r\n "type": "string",\r\n "enum": [\r\n "+created_at",\r\n "+title",\r\n "+updated_at",\r\n "+writer",\r\n "-created_at",\r\n "-title",\r\n "-updated_at",\r\n "-writer"\r\n ]\r\n },\r\n "title": "Sort condition",\r\n "description": "Sort condition."\r\n },\r\n "page": {\r\n "type": "integer",\r\n "title": "Page number",\r\n "description": "Page number."\r\n },\r\n "limit": {\r\n "type": "integer",\r\n "default": 100,\r\n "title": "Limitation of records per a page",\r\n "description": "Limitation of records per a page."\r\n }\r\n },\r\n "nullable": false\r\n },\r\n "IBbsArticle.IRequest.ISearch": {\r\n "type": "object",\r\n "properties": {\r\n "writer": {\r\n "type": "string"\r\n },\r\n "title": {\r\n "type": "string"\r\n },\r\n "body": {\r\n "type": "string"\r\n },\r\n "title_or_body": {\r\n "type": "string"\r\n },\r\n "from": {\r\n "type": "string",\r\n "format": "date-time"\r\n },\r\n "to": {\r\n "type": "string",\r\n "format": "date-time"\r\n }\r\n },\r\n "nullable": false,\r\n "description": "검색 정보."\r\n },\r\n "IPageIBbsArticle.ISummary": {\r\n "type": "object",\r\n "properties": {\r\n "pagination": {\r\n "$ref": "#/components/schemas/IPage.IPagination",\r\n "title": "Page information",\r\n "description": "Page information."\r\n },\r\n "data": {\r\n "type": "array",\r\n "items": {\r\n "$ref": "#/components/schemas/IBbsArticle.ISummary"\r\n },\r\n "title": "List of records",\r\n "description": "List of records."\r\n }\r\n },\r\n "nullable": false,\r\n "required": [\r\n "pagination",\r\n "data"\r\n ],\r\n "description": "A page.\\n\\nCollection of records with pagination indformation."\r\n },\r\n "IPage.IPagination": {\r\n "type": "object",\r\n "properties": {\r\n "current": {\r\n "type": "integer",\r\n "title": "Current page number",\r\n "description": "Current page number."\r\n },\r\n "limit": {\r\n "type": "integer",\r\n "default": 100,\r\n "title": "Limitation of records per a page",\r\n "description": "Limitation of records per a page."\r\n },\r\n "records": {\r\n "type": "integer",\r\n "title": "Total records in the database",\r\n "description": "Total records in the database."\r\n },\r\n "pages": {\r\n "type": "integer",\r\n "title": "Total pages",\r\n "description": "Total pages.\\n\\nEqual to {@link records } / {@link limit } with ceiling."\r\n }\r\n },\r\n "nullable": false,\r\n "required": [\r\n "current",\r\n "limit",\r\n "records",\r\n "pages"\r\n ],\r\n "description": "Page information."\r\n },\r\n "IBbsArticle.ISummary": {\r\n "type": "object",\r\n "properties": {\r\n "id": {\r\n "type": "string",\r\n "format": "uuid",\r\n "title": "Primary Key",\r\n "description": "Primary Key."\r\n },\r\n "writer": {\r\n "type": "string",\r\n "title": "Writer of the article",\r\n "description": "Writer of the article."\r\n },\r\n "title": {\r\n "type": "string",\r\n "title": "Title of the last snapshot",\r\n "description": "Title of the last snapshot."\r\n },\r\n "created_at": {\r\n "type": "string",\r\n "format": "date-time",\r\n "title": "Creation time of the article",\r\n "description": "Creation time of the article."\r\n },\r\n "updated_at": {\r\n "type": "string",\r\n "format": "date-time",\r\n "title": "Modification time of the article",\r\n "description": "Modification time of the article.\\n\\nIn other words, the time when the last snapshot was created."\r\n }\r\n },\r\n "nullable": false,\r\n "required": [\r\n "id",\r\n "writer",\r\n "title",\r\n "created_at",\r\n "updated_at"\r\n ],\r\n "description": "Summarized information of the article."\r\n },\r\n "IPageIBbsArticle.IAbridge": {\r\n "type": "object",\r\n "properties": {\r\n "pagination": {\r\n "$ref": "#/components/schemas/IPage.IPagination",\r\n "title": "Page information",\r\n "description": "Page information."\r\n },\r\n "data": {\r\n "type": "array",\r\n "items": {\r\n "$ref": "#/components/schemas/IBbsArticle.IAbridge"\r\n },\r\n "title": "List of records",\r\n "description": "List of records."\r\n }\r\n },\r\n "nullable": false,\r\n "required": [\r\n "pagination",\r\n "data"\r\n ],\r\n "description": "A page.\\n\\nCollection of records with pagination indformation."\r\n },\r\n "IBbsArticle.IAbridge": {\r\n "type": "object",\r\n "properties": {\r\n "id": {\r\n "type": "string",\r\n "format": "uuid",\r\n "title": "Primary Key",\r\n "description": "Primary Key."\r\n },\r\n "writer": {\r\n "type": "string",\r\n "title": "Writer of the article",\r\n "description": "Writer of the article."\r\n },\r\n "title": {\r\n "type": "string",\r\n "title": "Title of the last snapshot",\r\n "description": "Title of the last snapshot."\r\n },\r\n "created_at": {\r\n "type": "string",\r\n "format": "date-time",\r\n "title": "Creation time of the article",\r\n "description": "Creation time of the article."\r\n },\r\n "updated_at": {\r\n "type": "string",\r\n "format": "date-time",\r\n "title": "Modification time of the article",\r\n "description": "Modification time of the article.\\n\\nIn other words, the time when the last snapshot was created."\r\n },\r\n "format": {\r\n "$ref": "#/components/schemas/IBbsArticle.Format",\r\n "title": "Format of body",\r\n "description": "Format of body.\\n\\nSame meaning with extension like `html`, `md`, `txt`."\r\n },\r\n "body": {\r\n "type": "string",\r\n "title": "Content body of article",\r\n "description": "Content body of article."\r\n },\r\n "files": {\r\n "type": "array",\r\n "items": {\r\n "$ref": "#/components/schemas/IAttachmentFile.ICreate"\r\n },\r\n "title": "List of attachment files",\r\n "description": "List of attachment files."\r\n }\r\n },\r\n "nullable": false,\r\n "required": [\r\n "id",\r\n "writer",\r\n "title",\r\n "created_at",\r\n "updated_at",\r\n "format",\r\n "body",\r\n "files"\r\n ],\r\n "description": "Abriged information of the article."\r\n },\r\n "IBbsArticle.Format": {\r\n "type": "string",\r\n "enum": [\r\n "txt",\r\n "md",\r\n "html"\r\n ]\r\n },\r\n "IAttachmentFile.ICreate": {\r\n "type": "object",\r\n "properties": {\r\n "name": {\r\n "type": "string",\r\n "maxLength": 255,\r\n "title": "File name, except extension",\r\n "description": "File name, except extension."\r\n },\r\n "extension": {\r\n "type": "string",\r\n "maxLength": 8,\r\n "minLength": 1,\r\n "nullable": true,\r\n "title": "Extension",\r\n "description": "Extension.\\n\\nPossible to omit like `README` case."\r\n },\r\n "url": {\r\n "type": "string",\r\n "format": "uri",\r\n "title": "URL path of the real file",\r\n "description": "URL path of the real file."\r\n }\r\n },\r\n "nullable": false,\r\n "required": [\r\n "name",\r\n "extension",\r\n "url"\r\n ]\r\n },\r\n "IBbsArticle": {\r\n "type": "object",\r\n "properties": {\r\n "id": {\r\n "type": "string",\r\n "format": "uuid",\r\n "title": "Primary Key",\r\n "description": "Primary Key."\r\n },\r\n "writer": {\r\n "type": "string",\r\n "title": "Writer of article",\r\n "description": "Writer of article."\r\n },\r\n "snapshots": {\r\n "type": "array",\r\n "items": {\r\n "$ref": "#/components/schemas/IBbsArticle.ISnapshot"\r\n },\r\n "minItems": 1,\r\n "title": "List of snapshot contents",\r\n "description": "List of snapshot contents.\\n\\nIt is created for the first time when an article is created, and is\\naccumulated every time the article is modified."\r\n },\r\n "created_at": {\r\n "type": "string",\r\n "format": "date-time",\r\n "title": "Creation time of article",\r\n "description": "Creation time of article."\r\n }\r\n },\r\n "nullable": false,\r\n "required": [\r\n "id",\r\n "writer",\r\n "snapshots",\r\n "created_at"\r\n ],\r\n "description": "Article entity.\\n\\n`IBbsArticle* is a super-type entity of all kinds of articles in the current\\nbackend system, literally shaping individual articles of the bulletin board.\\n\\nAnd, as you can see, the elements that must inevitably exist in the article,\\nsuch as the `title` or the `body`, do not exist in the `IBbsArticle`, but exist\\nin the subsidiary entity, {@link IBbsArticle.ISnapshot }, as a 1: N relationship,\\nwhich is because a new snapshot record is published every time the article is\\nmodified.\\n\\nThe reason why a new snapshot record is published every time the article is\\nmodified is to preserve the evidence. Due to the nature of e-community, there\\nis always a threat of dispute among the participants. And it can happen that\\ndisputes arise through articles or {@link IBbsArticleComment comments}, and to\\nprevent such things as modifying existing articles to manipulate the situation,\\nthe article is designed in this structure.\\n\\nIn other words, to keep evidence, and prevent fraud."\r\n },\r\n "IBbsArticle.ISnapshot": {\r\n "type": "object",\r\n "properties": {\r\n "id": {\r\n "type": "string",\r\n "format": "uuid",\r\n "title": "Primary Key",\r\n "description": "Primary Key."\r\n },\r\n "created_at": {\r\n "type": "string",\r\n "format": "date-time",\r\n "title": "Creation time of snapshot record",\r\n "description": "Creation time of snapshot record.\\n\\nIn other words, creation time or update time or article."\r\n },\r\n "format": {\r\n "$ref": "#/components/schemas/IBbsArticle.Format",\r\n "title": "Format of body",\r\n "description": "Format of body.\\n\\nSame meaning with extension like `html`, `md`, `txt`."\r\n },\r\n "body": {\r\n "type": "string",\r\n "title": "Content body of article",\r\n "description": "Content body of article."\r\n },\r\n "files": {\r\n "type": "array",\r\n "items": {\r\n "$ref": "#/components/schemas/IAttachmentFile.ICreate"\r\n },\r\n "title": "List of attachment files",\r\n "description": "List of attachment files."\r\n },\r\n "title": {\r\n "type": "string",\r\n "title": "Title of article",\r\n "description": "Title of article."\r\n }\r\n },\r\n "nullable": false,\r\n "required": [\r\n "id",\r\n "created_at",\r\n "format",\r\n "body",\r\n "files",\r\n "title"\r\n ],\r\n "description": "Snapshot of article.\\n\\n`IBbsArticle.ISnapshot` is a snapshot entity that contains the contents of\\nthe article, as mentioned in {@link IBbsArticle }, the contents of the article\\nare separated from the article record to keep evidence and prevent fraud."\r\n },\r\n "IBbsArticle.ICreate": {\r\n "type": "object",\r\n "properties": {\r\n "writer": {\r\n "type": "string"\r\n },\r\n "format": {\r\n "type": "string",\r\n "enum": [\r\n "html",\r\n "md",\r\n "txt"\r\n ],\r\n "title": "Format of body",\r\n "description": "Format of body.\\n\\nSame meaning with extension like `html`, `md`, `txt`."\r\n },\r\n "title": {\r\n "type": "string",\r\n "title": "Title of article",\r\n "description": "Title of article."\r\n },\r\n "body": {\r\n "type": "string",\r\n "title": "Content body of article",\r\n "description": "Content body of article."\r\n },\r\n "files": {\r\n "type": "array",\r\n "items": {\r\n "$ref": "#/components/schemas/IAttachmentFile.ICreate"\r\n },\r\n "title": "List of attachment files",\r\n "description": "List of attachment files."\r\n },\r\n "password": {\r\n "type": "string",\r\n "title": "Password for modification",\r\n "description": "Password for modification."\r\n }\r\n },\r\n "nullable": false,\r\n "required": [\r\n "writer",\r\n "format",\r\n "title",\r\n "body",\r\n "files",\r\n "password"\r\n ],\r\n "description": "Store content type of the article."\r\n },\r\n "IBbsArticle.IUpdate": {\r\n "type": "object",\r\n "properties": {\r\n "format": {\r\n "type": "string",\r\n "enum": [\r\n "html",\r\n "md",\r\n "txt"\r\n ],\r\n "title": "Format of body",\r\n "description": "Format of body.\\n\\nSame meaning with extension like `html`, `md`, `txt`."\r\n },\r\n "title": {\r\n "type": "string",\r\n "title": "Title of article",\r\n "description": "Title of article."\r\n },\r\n "body": {\r\n "type": "string",\r\n "title": "Content body of article",\r\n "description": "Content body of article."\r\n },\r\n "files": {\r\n "type": "array",\r\n "items": {\r\n "$ref": "#/components/schemas/IAttachmentFile.ICreate"\r\n },\r\n "title": "List of attachment files",\r\n "description": "List of attachment files."\r\n },\r\n "password": {\r\n "type": "string",\r\n "title": "Password for modification",\r\n "description": "Password for modification."\r\n }\r\n },\r\n "nullable": false,\r\n "required": [\r\n "format",\r\n "title",\r\n "body",\r\n "files",\r\n "password"\r\n ]\r\n },\r\n "IBbsArticle.IErase": {\r\n "type": "object",\r\n "properties": {\r\n "password": {\r\n "type": "string"\r\n }\r\n },\r\n "nullable": false,\r\n "required": [\r\n "password"\r\n ]\r\n },\r\n "IBbsArticleComment.IRequest": {\r\n "type": "object",\r\n "properties": {\r\n "search": {\r\n "$ref": "#/components/schemas/IBbsArticleComment.IRequest.ISearch"\r\n },\r\n "sort": {\r\n "type": "array",\r\n "items": {\r\n "type": "string",\r\n "enum": [\r\n "+created_at",\r\n "+writer",\r\n "-created_at",\r\n "-writer"\r\n ]\r\n }\r\n },\r\n "page": {\r\n "type": "integer",\r\n "title": "Page number",\r\n "description": "Page number."\r\n },\r\n "limit": {\r\n "type": "integer",\r\n "default": 100,\r\n "title": "Limitation of records per a page",\r\n "description": "Limitation of records per a page."\r\n }\r\n },\r\n "nullable": false\r\n },\r\n "IBbsArticleComment.IRequest.ISearch": {\r\n "type": "object",\r\n "properties": {\r\n "writer": {\r\n "type": "string"\r\n },\r\n "body": {\r\n "type": "string"\r\n }\r\n },\r\n "nullable": false\r\n },\r\n "IPageIBbsArticleComment": {\r\n "type": "object",\r\n "properties": {\r\n "pagination": {\r\n "$ref": "#/components/schemas/IPage.IPagination",\r\n "title": "Page information",\r\n "description": "Page information."\r\n },\r\n "data": {\r\n "type": "array",\r\n "items": {\r\n "$ref": "#/components/schemas/IBbsArticleComment"\r\n },\r\n "title": "List of records",\r\n "description": "List of records."\r\n }\r\n },\r\n "nullable": false,\r\n "required": [\r\n "pagination",\r\n "data"\r\n ],\r\n "description": "A page.\\n\\nCollection of records with pagination indformation."\r\n },\r\n "IBbsArticleComment": {\r\n "type": "object",\r\n "properties": {\r\n "id": {\r\n "type": "string",\r\n "format": "uuid",\r\n "title": "Primary Key",\r\n "description": "Primary Key."\r\n },\r\n "parent_id": {\r\n "type": "string",\r\n "format": "uuid",\r\n "nullable": true,\r\n "title": "Parent comment\'s ID",\r\n "description": "Parent comment\'s ID."\r\n },\r\n "writer": {\r\n "type": "string",\r\n "title": "Writer of comment",\r\n "description": "Writer of comment."\r\n },\r\n "snapshots": {\r\n "type": "array",\r\n "items": {\r\n "$ref": "#/components/schemas/IBbsArticleComment.ISnapshot"\r\n },\r\n "minItems": 1,\r\n "title": "List of snapshot contents",\r\n "description": "List of snapshot contents.\\n\\nIt is created for the first time when a comment being created, and is\\naccumulated every time the comment is modified."\r\n },\r\n "created_at": {\r\n "type": "string",\r\n "format": "date-time",\r\n "title": "Creation time of comment",\r\n "description": "Creation time of comment."\r\n }\r\n },\r\n "nullable": false,\r\n "required": [\r\n "id",\r\n "parent_id",\r\n "writer",\r\n "snapshots",\r\n "created_at"\r\n ],\r\n "description": "Comment written on an article.\\n\\n`IBbsArticleComment` is an entity that shapes the comments written on an article.\\n\\nAnd for this comment, as in the previous relationship between\\n{@link IBbsArticle } and {@link IBbsArticle.ISnapshot }, the content body of the\\ncomment is stored in the sub {@link IBbsArticleComment.ISnapshot } table for\\nevidentialism, and a new snapshot record is issued every time the comment is modified.\\n\\nAlso, `IBbsArticleComment` is expressing the relationship of the hierarchical reply\\nstructure through the {@link IBbsArticleComment.parent_id } attribute."\r\n },\r\n "IBbsArticleComment.ISnapshot": {\r\n "type": "object",\r\n "properties": {\r\n "id": {\r\n "type": "string",\r\n "format": "uuid",\r\n "title": "Primary Key",\r\n "description": "Primary Key."\r\n },\r\n "created_at": {\r\n "type": "string",\r\n "format": "date-time",\r\n "title": "Creation time of snapshot record",\r\n "description": "Creation time of snapshot record.\\n\\nIn other words, creation time or update time or comment."\r\n },\r\n "format": {\r\n "$ref": "#/components/schemas/IBbsArticleComment.Format",\r\n "title": "Format of body",\r\n "description": "Format of body.\\n\\nSame meaning with extension like `html`, `md`, `txt`."\r\n },\r\n "body": {\r\n "type": "string",\r\n "title": "Content body of comment",\r\n "description": "Content body of comment."\r\n },\r\n "files": {\r\n "type": "array",\r\n "items": {\r\n "$ref": "#/components/schemas/IAttachmentFile.ICreate"\r\n },\r\n "title": "List of attachment files",\r\n "description": "List of attachment files."\r\n }\r\n },\r\n "nullable": false,\r\n "required": [\r\n "id",\r\n "created_at",\r\n "format",\r\n "body",\r\n "files"\r\n ],\r\n "description": "Snapshot of comment.\\n\\n`IBbsArticleComment.ISnapshot` is a snapshot entity that contains\\nthe contents of the comment.\\n\\nAs mentioned in {@link IBbsArticleComment }, designed to keep evidence\\nand prevent fraud."\r\n },\r\n "IBbsArticleComment.Format": {\r\n "type": "string",\r\n "enum": [\r\n "txt",\r\n "md",\r\n "html"\r\n ]\r\n },\r\n "IBbsArticleComment.ICreate": {\r\n "type": "object",\r\n "properties": {\r\n "writer": {\r\n "type": "string",\r\n "title": "Writer of comment",\r\n "description": "Writer of comment."\r\n },\r\n "format": {\r\n "type": "string",\r\n "enum": [\r\n "html",\r\n "md",\r\n "txt"\r\n ],\r\n "title": "Format of body",\r\n "description": "Format of body.\\n\\nSame meaning with extension like `html`, `md`, `txt`."\r\n },\r\n "body": {\r\n "type": "string",\r\n "title": "Content body of comment",\r\n "description": "Content body of comment."\r\n },\r\n "files": {\r\n "type": "array",\r\n "items": {\r\n "$ref": "#/components/schemas/IAttachmentFile.ICreate"\r\n },\r\n "title": "List of attachment files",\r\n "description": "List of attachment files."\r\n },\r\n "password": {\r\n "type": "string",\r\n "title": "Password for modification",\r\n "description": "Password for modification."\r\n }\r\n },\r\n "nullable": false,\r\n "required": [\r\n "writer",\r\n "format",\r\n "body",\r\n "files",\r\n "password"\r\n ]\r\n },\r\n "IBbsArticleComment.IUpdate": {\r\n "type": "object",\r\n "properties": {\r\n "format": {\r\n "type": "string",\r\n "enum": [\r\n "html",\r\n "md",\r\n "txt"\r\n ],\r\n "title": "Format of body",\r\n "description": "Format of body.\\n\\nSame meaning with extension like `html`, `md`, `txt`."\r\n },\r\n "body": {\r\n "type": "string",\r\n "title": "Content body of comment",\r\n "description": "Content body of comment."\r\n },\r\n "files": {\r\n "type": "array",\r\n "items": {\r\n "$ref": "#/components/schemas/IAttachmentFile.ICreate"\r\n },\r\n "title": "List of attachment files",\r\n "description": "List of attachment files."\r\n },\r\n "password": {\r\n "type": "string",\r\n "title": "Password for modification",\r\n "description": "Password for modification."\r\n }\r\n },\r\n "nullable": false,\r\n "required": [\r\n "format",\r\n "body",\r\n "files",\r\n "password"\r\n ]\r\n },\r\n "IBbsArticleComment.IErase": {\r\n "type": "object",\r\n "properties": {\r\n "password": {\r\n "type": "string"\r\n }\r\n },\r\n "nullable": false,\r\n "required": [\r\n "password"\r\n ]\r\n },\r\n "IPerformance": {\r\n "type": "object",\r\n "properties": {\r\n "cpu": {\r\n "$ref": "#/components/schemas/process.global.NodeJS.CpuUsage"\r\n },\r\n "memory": {\r\n "$ref": "#/components/schemas/process.global.NodeJS.MemoryUsage"\r\n },\r\n "resource": {\r\n "$ref": "#/components/schemas/process.global.NodeJS.ResourceUsage"\r\n }\r\n },\r\n "nullable": false,\r\n "required": [\r\n "cpu",\r\n "memory",\r\n "resource"\r\n ]\r\n },\r\n "process.global.NodeJS.CpuUsage": {\r\n "type": "object",\r\n "properties": {\r\n "user": {\r\n "type": "number"\r\n },\r\n "system": {\r\n "type": "number"\r\n }\r\n },\r\n "nullable": false,\r\n "required": [\r\n "user",\r\n "system"\r\n ]\r\n },\r\n "process.global.NodeJS.MemoryUsage": {\r\n "type": "object",\r\n "properties": {\r\n "rss": {\r\n "type": "number"\r\n },\r\n "heapTotal": {\r\n "type": "number"\r\n },\r\n "heapUsed": {\r\n "type": "number"\r\n },\r\n "external": {\r\n "type": "number"\r\n },\r\n "arrayBuffers": {\r\n "type": "number"\r\n }\r\n },\r\n "nullable": false,\r\n "required": [\r\n "rss",\r\n "heapTotal",\r\n "heapUsed",\r\n "external",\r\n "arrayBuffers"\r\n ]\r\n },\r\n "process.global.NodeJS.ResourceUsage": {\r\n "type": "object",\r\n "properties": {\r\n "fsRead": {\r\n "type": "number"\r\n },\r\n "fsWrite": {\r\n "type": "number"\r\n },\r\n "involuntaryContextSwitches": {\r\n "type": "number"\r\n },\r\n "ipcReceived": {\r\n "type": "number"\r\n },\r\n "ipcSent": {\r\n "type": "number"\r\n },\r\n "majorPageFault": {\r\n "type": "number"\r\n },\r\n "maxRSS": {\r\n "type": "number"\r\n },\r\n "minorPageFault": {\r\n "type": "number"\r\n },\r\n "sharedMemorySize": {\r\n "type": "number"\r\n },\r\n "signalsCount": {\r\n "type": "number"\r\n },\r\n "swappedOut": {\r\n "type": "number"\r\n },\r\n "systemCPUTime": {\r\n "type": "number"\r\n },\r\n "unsharedDataSize": {\r\n "type": "number"\r\n },\r\n "unsharedStackSize": {\r\n "type": "number"\r\n },\r\n "userCPUTime": {\r\n "type": "number"\r\n },\r\n "voluntaryContextSwitches": {\r\n "type": "number"\r\n }\r\n },\r\n "nullable": false,\r\n "required": [\r\n "fsRead",\r\n "fsWrite",\r\n "involuntaryContextSwitches",\r\n "ipcReceived",\r\n "ipcSent",\r\n "majorPageFault",\r\n "maxRSS",\r\n "minorPageFault",\r\n "sharedMemorySize",\r\n "signalsCount",\r\n "swappedOut",\r\n "systemCPUTime",\r\n "unsharedDataSize",\r\n "unsharedStackSize",\r\n "userCPUTime",\r\n "voluntaryContextSwitches"\r\n ]\r\n },\r\n "ISystem": {\r\n "type": "object",\r\n "properties": {\r\n "uid": {\r\n "type": "number",\r\n "title": "Random Unique ID",\r\n "description": "Random Unique ID."\r\n },\r\n "arguments": {\r\n "type": "array",\r\n "items": {\r\n "type": "string"\r\n },\r\n "description": "`process.argv`"\r\n },\r\n "commit": {\r\n "$ref": "#/components/schemas/ISystem.ICommit",\r\n "title": "Git commit info",\r\n "description": "Git commit info."\r\n },\r\n "package": {\r\n "$ref": "#/components/schemas/ISystem.IPackage",\r\n "description": "`package.json`"\r\n },\r\n "created_at": {\r\n "type": "string",\r\n "title": "Creation time of this server",\r\n "description": "Creation time of this server."\r\n }\r\n },\r\n "nullable": false,\r\n "required": [\r\n "uid",\r\n "arguments",\r\n "commit",\r\n "package",\r\n "created_at"\r\n ],\r\n "description": "System Information."\r\n },\r\n "ISystem.ICommit": {\r\n "type": "object",\r\n "properties": {\r\n "shortHash": {\r\n "type": "string"\r\n },\r\n "branch": {\r\n "type": "string"\r\n },\r\n "hash": {\r\n "type": "string"\r\n },\r\n "subject": {\r\n "type": "string"\r\n },\r\n "sanitizedSubject": {\r\n "type": "string"\r\n },\r\n "body": {\r\n "type": "string"\r\n },\r\n "author": {\r\n "$ref": "#/components/schemas/ISystem.ICommit.IUser"\r\n },\r\n "committer": {\r\n "$ref": "#/components/schemas/ISystem.ICommit.IUser"\r\n },\r\n "authored_at": {\r\n "type": "string"\r\n },\r\n "commited_at": {\r\n "type": "string"\r\n },\r\n "notes": {\r\n "type": "string"\r\n },\r\n "tags": {\r\n "type": "array",\r\n "items": {\r\n "type": "string"\r\n }\r\n }\r\n },\r\n "nullable": false,\r\n "required": [\r\n "shortHash",\r\n "branch",\r\n "hash",\r\n "subject",\r\n "sanitizedSubject",\r\n "body",\r\n "author",\r\n "committer",\r\n "authored_at",\r\n "commited_at",\r\n "tags"\r\n ],\r\n "description": "Git commit info."\r\n },\r\n "ISystem.ICommit.IUser": {\r\n "type": "object",\r\n "properties": {\r\n "name": {\r\n "type": "string"\r\n },\r\n "email": {\r\n "type": "string"\r\n }\r\n },\r\n "nullable": false,\r\n "required": [\r\n "name",\r\n "email"\r\n ],\r\n "description": "Git user account info."\r\n },\r\n "ISystem.IPackage": {\r\n "type": "object",\r\n "properties": {\r\n "name": {\r\n "type": "string"\r\n },\r\n "version": {\r\n "type": "string"\r\n },\r\n "description": {\r\n "type": "string"\r\n },\r\n "main": {\r\n "type": "string"\r\n },\r\n "typings": {\r\n "type": "string"\r\n },\r\n "scripts": {\r\n "$ref": "#/components/schemas/Recordstringstring"\r\n },\r\n "repository": {\r\n "type": "object",\r\n "properties": {\r\n "type": {\r\n "type": "string",\r\n "enum": [\r\n "git"\r\n ]\r\n },\r\n "url": {\r\n "type": "string"\r\n }\r\n },\r\n "nullable": false,\r\n "required": [\r\n "type",\r\n "url"\r\n ]\r\n },\r\n "author": {\r\n "type": "string"\r\n },\r\n "license": {\r\n "type": "string"\r\n },\r\n "bugs": {\r\n "type": "object",\r\n "properties": {\r\n "url": {\r\n "type": "string"\r\n }\r\n },\r\n "nullable": false,\r\n "required": [\r\n "url"\r\n ]\r\n },\r\n "homepage": {\r\n "type": "string"\r\n },\r\n "devDependencies": {\r\n "$ref": "#/components/schemas/Recordstringstring"\r\n },\r\n "dependencies": {\r\n "$ref": "#/components/schemas/Recordstringstring"\r\n },\r\n "publishConfig": {\r\n "type": "object",\r\n "properties": {\r\n "registry": {\r\n "type": "string"\r\n }\r\n },\r\n "nullable": false,\r\n "required": [\r\n "registry"\r\n ]\r\n },\r\n "files": {\r\n "type": "array",\r\n "items": {\r\n "type": "string"\r\n }\r\n }\r\n },\r\n "nullable": false,\r\n "required": [\r\n "name",\r\n "version",\r\n "description",\r\n "scripts",\r\n "repository",\r\n "author",\r\n "license",\r\n "bugs",\r\n "homepage",\r\n "dependencies"\r\n ],\r\n "description": "NPM package info."\r\n },\r\n "Recordstringstring": {\r\n "type": "object",\r\n "properties": {},\r\n "nullable": false,\r\n "description": "Construct a type with a set of properties K of type T"\r\n }\r\n }\r\n }\r\n}'
|
|
285
|
+
content: '{\n "openapi": "3.0.1",\n "servers": [\n {\n "url": "http://localhost:37001",\n "description": "Local Server"\n }\n ],\n "info": {\n "version": "2.2.0",\n "title": "@samchon/bbs-backend",\n "description": "Backend for bbs",\n "license": {\n "name": "MIT"\n }\n },\n "paths": {\n "/bbs/articles": {\n "patch": {\n "tags": [\n "BBS"\n ],\n "parameters": [],\n "requestBody": {\n "description": "Request info of pagination and searching options.",\n "content": {\n "application/json": {\n "schema": {\n "$ref": "#/components/schemas/IBbsArticle.IRequest"\n }\n }\n },\n "required": true\n },\n "responses": {\n "200": {\n "description": "Paginated summarized articles.",\n "content": {\n "application/json": {\n "schema": {\n "$ref": "#/components/schemas/IPageIBbsArticle.ISummary"\n }\n }\n }\n }\n },\n "summary": "List up all summarized articles",\n "description": "List up all summarized articles.\\n\\nList up all summarized articles with pagination and searching options."\n },\n "post": {\n "tags": [\n "BBS"\n ],\n "parameters": [],\n "requestBody": {\n "description": "Article information to create.",\n "content": {\n "application/json": {\n "schema": {\n "$ref": "#/components/schemas/IBbsArticle.ICreate"\n }\n }\n },\n "required": true\n },\n "responses": {\n "201": {\n "description": "Newly created article.",\n "content": {\n "application/json": {\n "schema": {\n "$ref": "#/components/schemas/IBbsArticle"\n }\n }\n }\n }\n },\n "summary": "Create a new article",\n "description": "Create a new article.\\n\\nCreate a new article with its first {@link IBbsArticle.ISnapshot snapshot}."\n }\n },\n "/bbs/articles/abridges": {\n "patch": {\n "tags": [\n "BBS"\n ],\n "parameters": [],\n "requestBody": {\n "description": "Request info of pagination and searching options.",\n "content": {\n "application/json": {\n "schema": {\n "$ref": "#/components/schemas/IBbsArticle.IRequest"\n }\n }\n },\n "required": true\n },\n "responses": {\n "200": {\n "description": "Paginated abridged articles.",\n "content": {\n "application/json": {\n "schema": {\n "$ref": "#/components/schemas/IPageIBbsArticle.IAbridge"\n }\n }\n }\n }\n },\n "summary": "List up all abridged articles",\n "description": "List up all abridged articles.\\n\\nList up all abridged articles with pagination and searching options."\n }\n },\n "/bbs/articles/{id}": {\n "get": {\n "tags": [\n "BBS"\n ],\n "parameters": [\n {\n "name": "id",\n "in": "path",\n "schema": {\n "type": "string",\n "format": "uuid"\n },\n "description": "Target article\'s ",\n "required": true\n }\n ],\n "responses": {\n "200": {\n "description": "Article information",\n "content": {\n "application/json": {\n "schema": {\n "$ref": "#/components/schemas/IBbsArticle"\n }\n }\n }\n }\n },\n "summary": "Read individual article",\n "description": "Read individual article.\\n\\nReads an article with its every {@link IBbsArticle.ISnapshot snapshots}."\n },\n "put": {\n "tags": [\n "BBS"\n ],\n "parameters": [\n {\n "name": "id",\n "in": "path",\n "schema": {\n "type": "string",\n "format": "uuid"\n },\n "description": "Target article\'s ",\n "required": true\n }\n ],\n "requestBody": {\n "description": "Article information to update.",\n "content": {\n "application/json": {\n "schema": {\n "$ref": "#/components/schemas/IBbsArticle.IUpdate"\n }\n }\n },\n "required": true\n },\n "responses": {\n "200": {\n "description": "Newly accumulated snapshot information.",\n "content": {\n "application/json": {\n "schema": {\n "$ref": "#/components/schemas/IBbsArticle.ISnapshot"\n }\n }\n }\n }\n },\n "summary": "Update an article",\n "description": "Update an article.\\n\\nAccumulate a new {@link IBbsArticle.ISnapshot snapshot} record to the article."\n },\n "delete": {\n "tags": [\n "BBS"\n ],\n "parameters": [\n {\n "name": "id",\n "in": "path",\n "schema": {\n "type": "string",\n "format": "uuid"\n },\n "description": "Target article\'s ",\n "required": true\n }\n ],\n "requestBody": {\n "description": "Password of the article.",\n "content": {\n "application/json": {\n "schema": {\n "$ref": "#/components/schemas/IBbsArticle.IErase"\n }\n }\n },\n "required": true\n },\n "responses": {\n "200": {\n "description": ""\n }\n },\n "summary": "Erase an article",\n "description": "Erase an article.\\n\\nPerforms soft deletion to the article."\n }\n },\n "/bbs/articles/{articleId}/comments": {\n "patch": {\n "tags": [\n "BBS"\n ],\n "parameters": [\n {\n "name": "articleId",\n "in": "path",\n "schema": {\n "type": "string",\n "format": "uuid"\n },\n "description": "",\n "required": true\n }\n ],\n "requestBody": {\n "description": "Request info of pagination and searching options.",\n "content": {\n "application/json": {\n "schema": {\n "$ref": "#/components/schemas/IBbsArticleComment.IRequest"\n }\n }\n },\n "required": true\n },\n "responses": {\n "200": {\n "description": "Paginated summarized comments.",\n "content": {\n "application/json": {\n "schema": {\n "$ref": "#/components/schemas/IPageIBbsArticleComment"\n }\n }\n }\n }\n },\n "summary": "List up all summarized comments",\n "description": "List up all summarized comments.\\n\\nList up all summarized comments with pagination and searching options."\n },\n "post": {\n "tags": [\n "BBS"\n ],\n "parameters": [\n {\n "name": "articleId",\n "in": "path",\n "schema": {\n "type": "string",\n "format": "uuid"\n },\n "description": "Belonged article\'s ",\n "required": true\n }\n ],\n "requestBody": {\n "description": "Comment information to create.",\n "content": {\n "application/json": {\n "schema": {\n "$ref": "#/components/schemas/IBbsArticleComment.ICreate"\n }\n }\n },\n "required": true\n },\n "responses": {\n "201": {\n "description": "Newly created comment.",\n "content": {\n "application/json": {\n "schema": {\n "$ref": "#/components/schemas/IBbsArticleComment"\n }\n }\n }\n }\n },\n "summary": "Create a new comment",\n "description": "Create a new comment.\\n\\nCreate a new comment with its first {@link IBbsArticleComment.ISnapshot snapshot}."\n }\n },\n "/bbs/articles/{articleId}/comments/{id}": {\n "get": {\n "tags": [\n "BBS"\n ],\n "parameters": [\n {\n "name": "articleId",\n "in": "path",\n "schema": {\n "type": "string",\n "format": "uuid"\n },\n "description": "Belonged article\'s ",\n "required": true\n },\n {\n "name": "id",\n "in": "path",\n "schema": {\n "type": "string",\n "format": "uuid"\n },\n "description": "Target comment\'s ",\n "required": true\n }\n ],\n "responses": {\n "200": {\n "description": "Comment information",\n "content": {\n "application/json": {\n "schema": {\n "$ref": "#/components/schemas/IBbsArticleComment"\n }\n }\n }\n }\n },\n "summary": "Read individual comment",\n "description": "Read individual comment.\\n\\nReads a comment with its every {@link IBbsArticleComment.ISnapshot snapshots}."\n },\n "put": {\n "tags": [\n "BBS"\n ],\n "parameters": [\n {\n "name": "articleId",\n "in": "path",\n "schema": {\n "type": "string",\n "format": "uuid"\n },\n "description": "Belonged article\'s ",\n "required": true\n },\n {\n "name": "id",\n "in": "path",\n "schema": {\n "type": "string",\n "format": "uuid"\n },\n "description": "Target comment\'s ",\n "required": true\n }\n ],\n "requestBody": {\n "description": "Comment information to update.",\n "content": {\n "application/json": {\n "schema": {\n "$ref": "#/components/schemas/IBbsArticleComment.IUpdate"\n }\n }\n },\n "required": true\n },\n "responses": {\n "200": {\n "description": "Newly accumulated snapshot information.",\n "content": {\n "application/json": {\n "schema": {\n "$ref": "#/components/schemas/IBbsArticleComment.ISnapshot"\n }\n }\n }\n }\n },\n "summary": "Update a comment",\n "description": "Update a comment.\\n\\nAccumulate a new {@link IBbsArticleComment.ISnapshot snapshot} record to the comment."\n },\n "delete": {\n "tags": [\n "BBS"\n ],\n "parameters": [\n {\n "name": "articleId",\n "in": "path",\n "schema": {\n "type": "string",\n "format": "uuid"\n },\n "description": "Belonged article\'s ",\n "required": true\n },\n {\n "name": "id",\n "in": "path",\n "schema": {\n "type": "string",\n "format": "uuid"\n },\n "description": "Target comment\'s ",\n "required": true\n }\n ],\n "requestBody": {\n "description": "Password of the comment.",\n "content": {\n "application/json": {\n "schema": {\n "$ref": "#/components/schemas/IBbsArticleComment.IErase"\n }\n }\n },\n "required": true\n },\n "responses": {\n "200": {\n "description": ""\n }\n },\n "summary": "Erase a comment",\n "description": "Erase a comment.\\n\\nPerforms soft deletion to the comment."\n }\n },\n "/monitors/health": {\n "get": {\n "tags": [\n "Monitor"\n ],\n "parameters": [],\n "responses": {\n "200": {\n "description": ""\n }\n },\n "summary": "Health check API",\n "description": "Health check API."\n }\n },\n "/monitors/performance": {\n "get": {\n "tags": [\n "Monitor"\n ],\n "parameters": [],\n "responses": {\n "200": {\n "description": "Performance info",\n "content": {\n "application/json": {\n "schema": {\n "$ref": "#/components/schemas/IPerformance"\n }\n }\n }\n }\n },\n "summary": "Get performance information",\n "description": "Get performance information.\\n\\nGet perofmration information composed with CPU, memory and resource usage."\n }\n },\n "/monitors/system": {\n "get": {\n "tags": [\n "Monitor"\n ],\n "parameters": [],\n "responses": {\n "200": {\n "description": "System info",\n "content": {\n "application/json": {\n "schema": {\n "$ref": "#/components/schemas/ISystem"\n }\n }\n }\n }\n },\n "summary": "Get system information",\n "description": "Get system information.\\n\\nGet system information with commit and package information."\n }\n }\n },\n "components": {\n "schemas": {\n "IBbsArticle.IRequest": {\n "type": "object",\n "properties": {\n "search": {\n "$ref": "#/components/schemas/IBbsArticle.IRequest.ISearch",\n "title": "Search condition",\n "description": "Search condition."\n },\n "sort": {\n "type": "array",\n "items": {\n "type": "string",\n "enum": [\n "+created_at",\n "+title",\n "+updated_at",\n "+writer",\n "-created_at",\n "-title",\n "-updated_at",\n "-writer"\n ]\n },\n "title": "Sort condition",\n "description": "Sort condition."\n },\n "page": {\n "type": "integer",\n "title": "Page number",\n "description": "Page number."\n },\n "limit": {\n "type": "integer",\n "default": 100,\n "title": "Limitation of records per a page",\n "description": "Limitation of records per a page."\n }\n },\n "nullable": false\n },\n "IBbsArticle.IRequest.ISearch": {\n "type": "object",\n "properties": {\n "writer": {\n "type": "string"\n },\n "title": {\n "type": "string"\n },\n "body": {\n "type": "string"\n },\n "title_or_body": {\n "type": "string"\n },\n "from": {\n "type": "string",\n "format": "date-time"\n },\n "to": {\n "type": "string",\n "format": "date-time"\n }\n },\n "nullable": false,\n "description": "검색 정보."\n },\n "IPageIBbsArticle.ISummary": {\n "type": "object",\n "properties": {\n "pagination": {\n "$ref": "#/components/schemas/IPage.IPagination",\n "title": "Page information",\n "description": "Page information."\n },\n "data": {\n "type": "array",\n "items": {\n "$ref": "#/components/schemas/IBbsArticle.ISummary"\n },\n "title": "List of records",\n "description": "List of records."\n }\n },\n "nullable": false,\n "required": [\n "pagination",\n "data"\n ],\n "description": "A page.\\n\\nCollection of records with pagination indformation."\n },\n "IPage.IPagination": {\n "type": "object",\n "properties": {\n "current": {\n "type": "integer",\n "title": "Current page number",\n "description": "Current page number."\n },\n "limit": {\n "type": "integer",\n "default": 100,\n "title": "Limitation of records per a page",\n "description": "Limitation of records per a page."\n },\n "records": {\n "type": "integer",\n "title": "Total records in the database",\n "description": "Total records in the database."\n },\n "pages": {\n "type": "integer",\n "title": "Total pages",\n "description": "Total pages.\\n\\nEqual to {@link records } / {@link limit } with ceiling."\n }\n },\n "nullable": false,\n "required": [\n "current",\n "limit",\n "records",\n "pages"\n ],\n "description": "Page information."\n },\n "IBbsArticle.ISummary": {\n "type": "object",\n "properties": {\n "id": {\n "type": "string",\n "format": "uuid",\n "title": "Primary Key",\n "description": "Primary Key."\n },\n "writer": {\n "type": "string",\n "title": "Writer of the article",\n "description": "Writer of the article."\n },\n "title": {\n "type": "string",\n "title": "Title of the last snapshot",\n "description": "Title of the last snapshot."\n },\n "created_at": {\n "type": "string",\n "format": "date-time",\n "title": "Creation time of the article",\n "description": "Creation time of the article."\n },\n "updated_at": {\n "type": "string",\n "format": "date-time",\n "title": "Modification time of the article",\n "description": "Modification time of the article.\\n\\nIn other words, the time when the last snapshot was created."\n }\n },\n "nullable": false,\n "required": [\n "id",\n "writer",\n "title",\n "created_at",\n "updated_at"\n ],\n "description": "Summarized information of the article."\n },\n "IPageIBbsArticle.IAbridge": {\n "type": "object",\n "properties": {\n "pagination": {\n "$ref": "#/components/schemas/IPage.IPagination",\n "title": "Page information",\n "description": "Page information."\n },\n "data": {\n "type": "array",\n "items": {\n "$ref": "#/components/schemas/IBbsArticle.IAbridge"\n },\n "title": "List of records",\n "description": "List of records."\n }\n },\n "nullable": false,\n "required": [\n "pagination",\n "data"\n ],\n "description": "A page.\\n\\nCollection of records with pagination indformation."\n },\n "IBbsArticle.IAbridge": {\n "type": "object",\n "properties": {\n "id": {\n "type": "string",\n "format": "uuid",\n "title": "Primary Key",\n "description": "Primary Key."\n },\n "writer": {\n "type": "string",\n "title": "Writer of the article",\n "description": "Writer of the article."\n },\n "title": {\n "type": "string",\n "title": "Title of the last snapshot",\n "description": "Title of the last snapshot."\n },\n "created_at": {\n "type": "string",\n "format": "date-time",\n "title": "Creation time of the article",\n "description": "Creation time of the article."\n },\n "updated_at": {\n "type": "string",\n "format": "date-time",\n "title": "Modification time of the article",\n "description": "Modification time of the article.\\n\\nIn other words, the time when the last snapshot was created."\n },\n "format": {\n "$ref": "#/components/schemas/IBbsArticle.Format",\n "title": "Format of body",\n "description": "Format of body.\\n\\nSame meaning with extension like `html`, `md`, `txt`."\n },\n "body": {\n "type": "string",\n "title": "Content body of article",\n "description": "Content body of article."\n },\n "files": {\n "type": "array",\n "items": {\n "$ref": "#/components/schemas/IAttachmentFile.ICreate"\n },\n "title": "List of attachment files",\n "description": "List of attachment files."\n }\n },\n "nullable": false,\n "required": [\n "id",\n "writer",\n "title",\n "created_at",\n "updated_at",\n "format",\n "body",\n "files"\n ],\n "description": "Abriged information of the article."\n },\n "IBbsArticle.Format": {\n "type": "string",\n "enum": [\n "txt",\n "md",\n "html"\n ]\n },\n "IAttachmentFile.ICreate": {\n "type": "object",\n "properties": {\n "name": {\n "type": "string",\n "maxLength": 255,\n "title": "File name, except extension",\n "description": "File name, except extension."\n },\n "extension": {\n "type": "string",\n "maxLength": 8,\n "minLength": 1,\n "nullable": true,\n "title": "Extension",\n "description": "Extension.\\n\\nPossible to omit like `README` case."\n },\n "url": {\n "type": "string",\n "format": "uri",\n "title": "URL path of the real file",\n "description": "URL path of the real file."\n }\n },\n "nullable": false,\n "required": [\n "name",\n "extension",\n "url"\n ]\n },\n "IBbsArticle": {\n "type": "object",\n "properties": {\n "id": {\n "type": "string",\n "format": "uuid",\n "title": "Primary Key",\n "description": "Primary Key."\n },\n "writer": {\n "type": "string",\n "title": "Writer of article",\n "description": "Writer of article."\n },\n "snapshots": {\n "type": "array",\n "items": {\n "$ref": "#/components/schemas/IBbsArticle.ISnapshot"\n },\n "minItems": 1,\n "title": "List of snapshot contents",\n "description": "List of snapshot contents.\\n\\nIt is created for the first time when an article is created, and is\\naccumulated every time the article is modified."\n },\n "created_at": {\n "type": "string",\n "format": "date-time",\n "title": "Creation time of article",\n "description": "Creation time of article."\n }\n },\n "nullable": false,\n "required": [\n "id",\n "writer",\n "snapshots",\n "created_at"\n ],\n "description": "Article entity.\\n\\n`IBbsArticle* is a super-type entity of all kinds of articles in the current\\nbackend system, literally shaping individual articles of the bulletin board.\\n\\nAnd, as you can see, the elements that must inevitably exist in the article,\\nsuch as the `title` or the `body`, do not exist in the `IBbsArticle`, but exist\\nin the subsidiary entity, {@link IBbsArticle.ISnapshot }, as a 1: N relationship,\\nwhich is because a new snapshot record is published every time the article is\\nmodified.\\n\\nThe reason why a new snapshot record is published every time the article is\\nmodified is to preserve the evidence. Due to the nature of e-community, there\\nis always a threat of dispute among the participants. And it can happen that\\ndisputes arise through articles or {@link IBbsArticleComment comments}, and to\\nprevent such things as modifying existing articles to manipulate the situation,\\nthe article is designed in this structure.\\n\\nIn other words, to keep evidence, and prevent fraud."\n },\n "IBbsArticle.ISnapshot": {\n "type": "object",\n "properties": {\n "id": {\n "type": "string",\n "format": "uuid",\n "title": "Primary Key",\n "description": "Primary Key."\n },\n "created_at": {\n "type": "string",\n "format": "date-time",\n "title": "Creation time of snapshot record",\n "description": "Creation time of snapshot record.\\n\\nIn other words, creation time or update time or article."\n },\n "format": {\n "$ref": "#/components/schemas/IBbsArticle.Format",\n "title": "Format of body",\n "description": "Format of body.\\n\\nSame meaning with extension like `html`, `md`, `txt`."\n },\n "body": {\n "type": "string",\n "title": "Content body of article",\n "description": "Content body of article."\n },\n "files": {\n "type": "array",\n "items": {\n "$ref": "#/components/schemas/IAttachmentFile.ICreate"\n },\n "title": "List of attachment files",\n "description": "List of attachment files."\n },\n "title": {\n "type": "string",\n "title": "Title of article",\n "description": "Title of article."\n }\n },\n "nullable": false,\n "required": [\n "id",\n "created_at",\n "format",\n "body",\n "files",\n "title"\n ],\n "description": "Snapshot of article.\\n\\n`IBbsArticle.ISnapshot` is a snapshot entity that contains the contents of\\nthe article, as mentioned in {@link IBbsArticle }, the contents of the article\\nare separated from the article record to keep evidence and prevent fraud."\n },\n "IBbsArticle.ICreate": {\n "type": "object",\n "properties": {\n "writer": {\n "type": "string"\n },\n "format": {\n "type": "string",\n "enum": [\n "html",\n "md",\n "txt"\n ],\n "title": "Format of body",\n "description": "Format of body.\\n\\nSame meaning with extension like `html`, `md`, `txt`."\n },\n "title": {\n "type": "string",\n "title": "Title of article",\n "description": "Title of article."\n },\n "body": {\n "type": "string",\n "title": "Content body of article",\n "description": "Content body of article."\n },\n "files": {\n "type": "array",\n "items": {\n "$ref": "#/components/schemas/IAttachmentFile.ICreate"\n },\n "title": "List of attachment files",\n "description": "List of attachment files."\n },\n "password": {\n "type": "string",\n "title": "Password for modification",\n "description": "Password for modification."\n }\n },\n "nullable": false,\n "required": [\n "writer",\n "format",\n "title",\n "body",\n "files",\n "password"\n ],\n "description": "Store content type of the article."\n },\n "IBbsArticle.IUpdate": {\n "type": "object",\n "properties": {\n "format": {\n "type": "string",\n "enum": [\n "html",\n "md",\n "txt"\n ],\n "title": "Format of body",\n "description": "Format of body.\\n\\nSame meaning with extension like `html`, `md`, `txt`."\n },\n "title": {\n "type": "string",\n "title": "Title of article",\n "description": "Title of article."\n },\n "body": {\n "type": "string",\n "title": "Content body of article",\n "description": "Content body of article."\n },\n "files": {\n "type": "array",\n "items": {\n "$ref": "#/components/schemas/IAttachmentFile.ICreate"\n },\n "title": "List of attachment files",\n "description": "List of attachment files."\n },\n "password": {\n "type": "string",\n "title": "Password for modification",\n "description": "Password for modification."\n }\n },\n "nullable": false,\n "required": [\n "format",\n "title",\n "body",\n "files",\n "password"\n ]\n },\n "IBbsArticle.IErase": {\n "type": "object",\n "properties": {\n "password": {\n "type": "string"\n }\n },\n "nullable": false,\n "required": [\n "password"\n ]\n },\n "IBbsArticleComment.IRequest": {\n "type": "object",\n "properties": {\n "search": {\n "$ref": "#/components/schemas/IBbsArticleComment.IRequest.ISearch"\n },\n "sort": {\n "type": "array",\n "items": {\n "type": "string",\n "enum": [\n "+created_at",\n "+writer",\n "-created_at",\n "-writer"\n ]\n }\n },\n "page": {\n "type": "integer",\n "title": "Page number",\n "description": "Page number."\n },\n "limit": {\n "type": "integer",\n "default": 100,\n "title": "Limitation of records per a page",\n "description": "Limitation of records per a page."\n }\n },\n "nullable": false\n },\n "IBbsArticleComment.IRequest.ISearch": {\n "type": "object",\n "properties": {\n "writer": {\n "type": "string"\n },\n "body": {\n "type": "string"\n }\n },\n "nullable": false\n },\n "IPageIBbsArticleComment": {\n "type": "object",\n "properties": {\n "pagination": {\n "$ref": "#/components/schemas/IPage.IPagination",\n "title": "Page information",\n "description": "Page information."\n },\n "data": {\n "type": "array",\n "items": {\n "$ref": "#/components/schemas/IBbsArticleComment"\n },\n "title": "List of records",\n "description": "List of records."\n }\n },\n "nullable": false,\n "required": [\n "pagination",\n "data"\n ],\n "description": "A page.\\n\\nCollection of records with pagination indformation."\n },\n "IBbsArticleComment": {\n "type": "object",\n "properties": {\n "id": {\n "type": "string",\n "format": "uuid",\n "title": "Primary Key",\n "description": "Primary Key."\n },\n "parent_id": {\n "type": "string",\n "format": "uuid",\n "nullable": true,\n "title": "Parent comment\'s ID",\n "description": "Parent comment\'s ID."\n },\n "writer": {\n "type": "string",\n "title": "Writer of comment",\n "description": "Writer of comment."\n },\n "snapshots": {\n "type": "array",\n "items": {\n "$ref": "#/components/schemas/IBbsArticleComment.ISnapshot"\n },\n "minItems": 1,\n "title": "List of snapshot contents",\n "description": "List of snapshot contents.\\n\\nIt is created for the first time when a comment being created, and is\\naccumulated every time the comment is modified."\n },\n "created_at": {\n "type": "string",\n "format": "date-time",\n "title": "Creation time of comment",\n "description": "Creation time of comment."\n }\n },\n "nullable": false,\n "required": [\n "id",\n "parent_id",\n "writer",\n "snapshots",\n "created_at"\n ],\n "description": "Comment written on an article.\\n\\n`IBbsArticleComment` is an entity that shapes the comments written on an article.\\n\\nAnd for this comment, as in the previous relationship between\\n{@link IBbsArticle } and {@link IBbsArticle.ISnapshot }, the content body of the\\ncomment is stored in the sub {@link IBbsArticleComment.ISnapshot } table for\\nevidentialism, and a new snapshot record is issued every time the comment is modified.\\n\\nAlso, `IBbsArticleComment` is expressing the relationship of the hierarchical reply\\nstructure through the {@link IBbsArticleComment.parent_id } attribute."\n },\n "IBbsArticleComment.ISnapshot": {\n "type": "object",\n "properties": {\n "id": {\n "type": "string",\n "format": "uuid",\n "title": "Primary Key",\n "description": "Primary Key."\n },\n "created_at": {\n "type": "string",\n "format": "date-time",\n "title": "Creation time of snapshot record",\n "description": "Creation time of snapshot record.\\n\\nIn other words, creation time or update time or comment."\n },\n "format": {\n "$ref": "#/components/schemas/IBbsArticleComment.Format",\n "title": "Format of body",\n "description": "Format of body.\\n\\nSame meaning with extension like `html`, `md`, `txt`."\n },\n "body": {\n "type": "string",\n "title": "Content body of comment",\n "description": "Content body of comment."\n },\n "files": {\n "type": "array",\n "items": {\n "$ref": "#/components/schemas/IAttachmentFile.ICreate"\n },\n "title": "List of attachment files",\n "description": "List of attachment files."\n }\n },\n "nullable": false,\n "required": [\n "id",\n "created_at",\n "format",\n "body",\n "files"\n ],\n "description": "Snapshot of comment.\\n\\n`IBbsArticleComment.ISnapshot` is a snapshot entity that contains\\nthe contents of the comment.\\n\\nAs mentioned in {@link IBbsArticleComment }, designed to keep evidence\\nand prevent fraud."\n },\n "IBbsArticleComment.Format": {\n "type": "string",\n "enum": [\n "txt",\n "md",\n "html"\n ]\n },\n "IBbsArticleComment.ICreate": {\n "type": "object",\n "properties": {\n "writer": {\n "type": "string",\n "title": "Writer of comment",\n "description": "Writer of comment."\n },\n "format": {\n "type": "string",\n "enum": [\n "html",\n "md",\n "txt"\n ],\n "title": "Format of body",\n "description": "Format of body.\\n\\nSame meaning with extension like `html`, `md`, `txt`."\n },\n "body": {\n "type": "string",\n "title": "Content body of comment",\n "description": "Content body of comment."\n },\n "files": {\n "type": "array",\n "items": {\n "$ref": "#/components/schemas/IAttachmentFile.ICreate"\n },\n "title": "List of attachment files",\n "description": "List of attachment files."\n },\n "password": {\n "type": "string",\n "title": "Password for modification",\n "description": "Password for modification."\n }\n },\n "nullable": false,\n "required": [\n "writer",\n "format",\n "body",\n "files",\n "password"\n ]\n },\n "IBbsArticleComment.IUpdate": {\n "type": "object",\n "properties": {\n "format": {\n "type": "string",\n "enum": [\n "html",\n "md",\n "txt"\n ],\n "title": "Format of body",\n "description": "Format of body.\\n\\nSame meaning with extension like `html`, `md`, `txt`."\n },\n "body": {\n "type": "string",\n "title": "Content body of comment",\n "description": "Content body of comment."\n },\n "files": {\n "type": "array",\n "items": {\n "$ref": "#/components/schemas/IAttachmentFile.ICreate"\n },\n "title": "List of attachment files",\n "description": "List of attachment files."\n },\n "password": {\n "type": "string",\n "title": "Password for modification",\n "description": "Password for modification."\n }\n },\n "nullable": false,\n "required": [\n "format",\n "body",\n "files",\n "password"\n ]\n },\n "IBbsArticleComment.IErase": {\n "type": "object",\n "properties": {\n "password": {\n "type": "string"\n }\n },\n "nullable": false,\n "required": [\n "password"\n ]\n },\n "IPerformance": {\n "type": "object",\n "properties": {\n "cpu": {\n "$ref": "#/components/schemas/process.global.NodeJS.CpuUsage"\n },\n "memory": {\n "$ref": "#/components/schemas/process.global.NodeJS.MemoryUsage"\n },\n "resource": {\n "$ref": "#/components/schemas/process.global.NodeJS.ResourceUsage"\n }\n },\n "nullable": false,\n "required": [\n "cpu",\n "memory",\n "resource"\n ]\n },\n "process.global.NodeJS.CpuUsage": {\n "type": "object",\n "properties": {\n "user": {\n "type": "number"\n },\n "system": {\n "type": "number"\n }\n },\n "nullable": false,\n "required": [\n "user",\n "system"\n ]\n },\n "process.global.NodeJS.MemoryUsage": {\n "type": "object",\n "properties": {\n "rss": {\n "type": "number"\n },\n "heapTotal": {\n "type": "number"\n },\n "heapUsed": {\n "type": "number"\n },\n "external": {\n "type": "number"\n },\n "arrayBuffers": {\n "type": "number"\n }\n },\n "nullable": false,\n "required": [\n "rss",\n "heapTotal",\n "heapUsed",\n "external",\n "arrayBuffers"\n ]\n },\n "process.global.NodeJS.ResourceUsage": {\n "type": "object",\n "properties": {\n "fsRead": {\n "type": "number"\n },\n "fsWrite": {\n "type": "number"\n },\n "involuntaryContextSwitches": {\n "type": "number"\n },\n "ipcReceived": {\n "type": "number"\n },\n "ipcSent": {\n "type": "number"\n },\n "majorPageFault": {\n "type": "number"\n },\n "maxRSS": {\n "type": "number"\n },\n "minorPageFault": {\n "type": "number"\n },\n "sharedMemorySize": {\n "type": "number"\n },\n "signalsCount": {\n "type": "number"\n },\n "swappedOut": {\n "type": "number"\n },\n "systemCPUTime": {\n "type": "number"\n },\n "unsharedDataSize": {\n "type": "number"\n },\n "unsharedStackSize": {\n "type": "number"\n },\n "userCPUTime": {\n "type": "number"\n },\n "voluntaryContextSwitches": {\n "type": "number"\n }\n },\n "nullable": false,\n "required": [\n "fsRead",\n "fsWrite",\n "involuntaryContextSwitches",\n "ipcReceived",\n "ipcSent",\n "majorPageFault",\n "maxRSS",\n "minorPageFault",\n "sharedMemorySize",\n "signalsCount",\n "swappedOut",\n "systemCPUTime",\n "unsharedDataSize",\n "unsharedStackSize",\n "userCPUTime",\n "voluntaryContextSwitches"\n ]\n },\n "ISystem": {\n "type": "object",\n "properties": {\n "uid": {\n "type": "number",\n "title": "Random Unique ID",\n "description": "Random Unique ID."\n },\n "arguments": {\n "type": "array",\n "items": {\n "type": "string"\n },\n "description": "`process.argv`"\n },\n "commit": {\n "$ref": "#/components/schemas/ISystem.ICommit",\n "title": "Git commit info",\n "description": "Git commit info."\n },\n "package": {\n "$ref": "#/components/schemas/ISystem.IPackage",\n "description": "`package.json`"\n },\n "created_at": {\n "type": "string",\n "title": "Creation time of this server",\n "description": "Creation time of this server."\n }\n },\n "nullable": false,\n "required": [\n "uid",\n "arguments",\n "commit",\n "package",\n "created_at"\n ],\n "description": "System Information."\n },\n "ISystem.ICommit": {\n "type": "object",\n "properties": {\n "shortHash": {\n "type": "string"\n },\n "branch": {\n "type": "string"\n },\n "hash": {\n "type": "string"\n },\n "subject": {\n "type": "string"\n },\n "sanitizedSubject": {\n "type": "string"\n },\n "body": {\n "type": "string"\n },\n "author": {\n "$ref": "#/components/schemas/ISystem.ICommit.IUser"\n },\n "committer": {\n "$ref": "#/components/schemas/ISystem.ICommit.IUser"\n },\n "authored_at": {\n "type": "string"\n },\n "commited_at": {\n "type": "string"\n },\n "notes": {\n "type": "string"\n },\n "tags": {\n "type": "array",\n "items": {\n "type": "string"\n }\n }\n },\n "nullable": false,\n "required": [\n "shortHash",\n "branch",\n "hash",\n "subject",\n "sanitizedSubject",\n "body",\n "author",\n "committer",\n "authored_at",\n "commited_at",\n "tags"\n ],\n "description": "Git commit info."\n },\n "ISystem.ICommit.IUser": {\n "type": "object",\n "properties": {\n "name": {\n "type": "string"\n },\n "email": {\n "type": "string"\n }\n },\n "nullable": false,\n "required": [\n "name",\n "email"\n ],\n "description": "Git user account info."\n },\n "ISystem.IPackage": {\n "type": "object",\n "properties": {\n "name": {\n "type": "string"\n },\n "version": {\n "type": "string"\n },\n "description": {\n "type": "string"\n },\n "main": {\n "type": "string"\n },\n "typings": {\n "type": "string"\n },\n "scripts": {\n "$ref": "#/components/schemas/Recordstringstring"\n },\n "repository": {\n "type": "object",\n "properties": {\n "type": {\n "type": "string",\n "enum": [\n "git"\n ]\n },\n "url": {\n "type": "string"\n }\n },\n "nullable": false,\n "required": [\n "type",\n "url"\n ]\n },\n "author": {\n "type": "string"\n },\n "license": {\n "type": "string"\n },\n "bugs": {\n "type": "object",\n "properties": {\n "url": {\n "type": "string"\n }\n },\n "nullable": false,\n "required": [\n "url"\n ]\n },\n "homepage": {\n "type": "string"\n },\n "devDependencies": {\n "$ref": "#/components/schemas/Recordstringstring"\n },\n "dependencies": {\n "$ref": "#/components/schemas/Recordstringstring"\n },\n "publishConfig": {\n "type": "object",\n "properties": {\n "registry": {\n "type": "string"\n }\n },\n "nullable": false,\n "required": [\n "registry"\n ]\n },\n "files": {\n "type": "array",\n "items": {\n "type": "string"\n }\n }\n },\n "nullable": false,\n "required": [\n "name",\n "version",\n "description",\n "scripts",\n "repository",\n "author",\n "license",\n "bugs",\n "homepage",\n "dependencies"\n ],\n "description": "NPM package info."\n },\n "Recordstringstring": {\n "type": "object",\n "properties": {},\n "nullable": false,\n "description": "Construct a type with a set of properties K of type T"\n }\n }\n }\n}'
|
|
286
|
+
}, {
|
|
287
|
+
location: "test",
|
|
288
|
+
file: "TestGlobal.ts",
|
|
289
|
+
content: 'import api from "@ORGANIZATION/PROJECT-api";\n\nexport namespace TestGlobal {\n export const connection = (): api.IConnection => ({\n host: `http://127.0.0.1:37001`,\n });\n}\n'
|
|
270
290
|
}, {
|
|
271
291
|
location: "test",
|
|
272
292
|
file: "index.ts",
|
|
273
|
-
content: 'import { DynamicExecutor } from "@nestia/e2e";\
|
|
293
|
+
content: 'import { DynamicExecutor } from "@nestia/e2e";\nimport chalk from "chalk";\n\nimport { TestGlobal } from "./TestGlobal";\nimport { ArgumentParser } from "./utils/ArgumentParser";\n\ninterface IOptions {\n simulate: boolean;\n include?: string[];\n exclude?: string[];\n trace: boolean;\n}\n\nconst getOptions = () =>\n ArgumentParser.parse<IOptions>(async (command, prompt, action) => {\n command.option("--simulate <boolean>", "Mockup Simultator");\n command.option("--include <string...>", "include feature files");\n command.option("--exclude <string...>", "exclude feature files");\n command.option("--trace <boolean>", "trace detailed errors");\n\n return action(async (options) => {\n if (typeof options.simulate === "string")\n options.simulate = options.simulate === "true";\n options.simulate ??= await prompt.boolean("simulate")("Mockup Simulator");\n options.trace = options.trace !== ("false" as any);\n return options as IOptions;\n });\n });\n\nconst main = async (): Promise<void> => {\n // DO TEST\n const options: IOptions = await getOptions();\n const report: DynamicExecutor.IReport = await DynamicExecutor.validate({\n prefix: "test",\n location: __dirname + "/features",\n extension: __filename.substring(__filename.length - 2),\n parameters: () => [\n {\n ...TestGlobal.connection(),\n simulate: options.simulate,\n },\n ],\n filter: (func) =>\n (!options.include?.length ||\n (options.include ?? []).some((str) => func.includes(str))) &&\n (!options.exclude?.length ||\n (options.exclude ?? []).every((str) => !func.includes(str))),\n onComplete: (exec) => {\n const trace = (str: string) =>\n console.log(` - ${chalk.green(exec.name)}: ${str}`);\n if (exec.error === null) {\n const elapsed: number =\n new Date(exec.completed_at).getTime() -\n new Date(exec.started_at).getTime();\n trace(`${chalk.yellow(elapsed.toLocaleString())} ms`);\n } else trace(chalk.red(exec.error.name));\n },\n });\n\n // REPORT EXCEPTIONS\n const exceptions: Error[] = report.executions\n .filter((exec) => exec.error !== null)\n .map((exec) => exec.error!);\n if (exceptions.length === 0) {\n console.log("Success");\n console.log("Elapsed time", report.time.toLocaleString(), `ms`);\n } else {\n if (options.trace !== false) for (const exp of exceptions) console.log(exp);\n console.log("Failed");\n console.log("Elapsed time", report.time.toLocaleString(), `ms`);\n }\n\n // TERMINATE\n if (exceptions.length) process.exit(-1);\n else process.exit(0);\n};\nmain().catch((exp) => {\n console.log(exp);\n process.exit(-1);\n});\n'
|
|
274
294
|
}, {
|
|
275
295
|
location: "test",
|
|
276
296
|
file: "start.ts",
|
|
277
|
-
content: 'import api from "@ORGANIZATION/PROJECT-api";\
|
|
297
|
+
content: 'import api from "@ORGANIZATION/PROJECT-api";\nimport { IBbsArticleComment } from "@ORGANIZATION/PROJECT-api/lib/structures/bbs/IBbsArticleComment";\nimport typia from "typia";\nimport type { Format } from "typia/lib/tags/Format";\n\nimport { TestGlobal } from "./TestGlobal";\n\nconst main = async () => {\n const connection: api.IConnection = {\n ...TestGlobal.connection(),\n simulate: true,\n };\n const output: IBbsArticleComment =\n await api.functional.bbs.articles.comments.create(\n connection,\n typia.random<string & Format<"uuid">>(),\n typia.random<IBbsArticleComment.ICreate>(),\n );\n typia.assert(output);\n};\nmain().catch((exp) => {\n console.log(exp);\n process.exit(-1);\n});\n'
|
|
278
298
|
}, {
|
|
279
299
|
location: "test",
|
|
280
300
|
file: "swagger.ts",
|
|
281
|
-
content: 'import express from "express";\
|
|
282
|
-
}, {
|
|
283
|
-
location: "test",
|
|
284
|
-
file: "TestGlobal.ts",
|
|
285
|
-
content: 'import api from "@ORGANIZATION/PROJECT-api";\r\n\r\nexport namespace TestGlobal {\r\n export const connection = (): api.IConnection => ({\r\n host: `http://127.0.0.1:37001`,\r\n });\r\n}\r\n'
|
|
301
|
+
content: 'import express from "express";\nimport ui from "swagger-ui-express";\n\nimport swagger from "../swagger.json";\n\nconst main = async (): Promise<void> => {\n const app = express();\n app.use("/", ui.serve, ui.setup(swagger));\n app.listen(3000);\n\n console.log("-----------------------------------------------------------");\n console.log("\\n Swagger UI Address: http://127.0.0.1:3000 \\n");\n console.log("-----------------------------------------------------------");\n};\nmain().catch((exp) => {\n console.log(exp);\n process.exit(-1);\n});\n'
|
|
286
302
|
}, {
|
|
287
303
|
location: "test",
|
|
288
304
|
file: "tsconfig.json",
|
|
289
|
-
content: '{\
|
|
305
|
+
content: '{\n "extends": "../tsconfig.json",\n "compilerOptions": {\n "outDir": "../bin",\n "paths": {\n "@ORGANIZATION/PROJECT-api": ["../src"],\n "@ORGANIZATION/PROJECT-api/lib/*": ["../src/*"],\n },\n "plugins": [\n { "transform": "typia/lib/transform" },\n { "transform": "typescript-transform-paths" },\n ],\n },\n "include": [\n ".", \n "../src",\n ],\n}'
|
|
290
306
|
}, {
|
|
291
307
|
location: "test/utils",
|
|
292
308
|
file: "ArgumentParser.ts",
|
|
293
|
-
content: 'import commander from "commander";\
|
|
309
|
+
content: 'import commander from "commander";\nimport * as inquirer from "inquirer";\n\nexport namespace ArgumentParser {\n export type Inquiry<T> = (\n command: commander.Command,\n prompt: (opt?: inquirer.StreamOptions) => inquirer.PromptModule,\n action: (closure: (options: Partial<T>) => Promise<T>) => Promise<T>,\n ) => Promise<T>;\n\n export interface Prompt {\n select: (\n name: string,\n ) => (\n message: string,\n ) => <Choice extends string>(choices: Choice[]) => Promise<Choice>;\n boolean: (name: string) => (message: string) => Promise<boolean>;\n }\n\n export const parse = async <T>(\n inquiry: (\n command: commander.Command,\n prompt: Prompt,\n action: (closure: (options: Partial<T>) => Promise<T>) => Promise<T>,\n ) => Promise<T>,\n ): Promise<T> => {\n // TAKE OPTIONS\n const action = (closure: (options: Partial<T>) => Promise<T>) =>\n new Promise<T>((resolve, reject) => {\n commander.program.action(async (options) => {\n try {\n resolve(await closure(options));\n } catch (exp) {\n reject(exp);\n }\n });\n commander.program.parseAsync().catch(reject);\n });\n\n const select =\n (name: string) =>\n (message: string) =>\n async <Choice extends string>(choices: Choice[]): Promise<Choice> =>\n (\n await inquirer.createPromptModule()({\n type: "list",\n name,\n message,\n choices,\n })\n )[name];\n const boolean = (name: string) => async (message: string) =>\n (\n await inquirer.createPromptModule()({\n type: "confirm",\n name,\n message,\n })\n )[name] as boolean;\n\n const output: T | Error = await (async () => {\n try {\n return await inquiry(commander.program, { select, boolean }, action);\n } catch (error) {\n return error as Error;\n }\n })();\n\n // RETURNS\n if (output instanceof Error) throw output;\n return output;\n };\n}\n'
|
|
294
310
|
}, {
|
|
295
311
|
location: "",
|
|
296
312
|
file: "tsconfig.json",
|
|
297
|
-
content: '{\r\n "compilerOptions": {\r\n /* Visit https://aka.ms/tsconfig to read more about this file */\r\n /* Projects */\r\n // "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */\r\n // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */\r\n // "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */\r\n // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */\r\n // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */\r\n // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */\r\n /* Language and Environment */\r\n "target": "ES5", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */\r\n "lib": [\r\n "DOM",\r\n "ES2015"\r\n ], /* Specify a set of bundled library declaration files that describe the target runtime environment. */// "jsx": "preserve", /* Specify what JSX code is generated. */\r\n // "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */\r\n // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */\r\n // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. \'React.createElement\' or \'h\'. */\r\n // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. \'React.Fragment\' or \'Fragment\'. */\r\n // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using \'jsx: react-jsx*\'. */\r\n // "reactNamespace": "", /* Specify the object invoked for \'createElement\'. This only applies when targeting \'react\' JSX emit. */\r\n // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */\r\n // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */\r\n // "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */\r\n /* Modules */\r\n "module": "commonjs", /* Specify what module code is generated. */// "rootDir": "./", /* Specify the root folder within your source files. */\r\n // "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */\r\n // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */\r\n "paths": {\r\n "@ORGANIZATION/PROJECT-api": ["../src"],\r\n "@ORGANIZATION/PROJECT-api/lib/*": ["../src/*"],\r\n }, /* Specify a set of entries that re-map imports to additional lookup locations. */\r\n // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */\r\n // "typeRoots": [], /* Specify multiple folders that act like \'./node_modules/@types\'. */\r\n // "types": [], /* Specify type package names to be included without being referenced in a source file. */\r\n // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */\r\n // "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */\r\n "resolveJsonModule": true, /* Enable importing .json files. */\r\n // "noResolve": true, /* Disallow \'import\'s, \'require\'s or \'<reference>\'s from expanding the number of files TypeScript should add to a project. */\r\n /* JavaScript Support */\r\n // "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the \'checkJS\' option to get errors from these files. */\r\n // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */\r\n // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from \'node_modules\'. Only applicable with \'allowJs\'. */\r\n /* Emit */\r\n "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */// "declarationMap": true, /* Create sourcemaps for d.ts files. */\r\n // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */\r\n "sourceMap": true, /* Create source map files for emitted JavaScript files. */// "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. */\r\n "outDir": "./lib", /* Specify an output folder for all emitted files. */// "removeComments": true, /* Disable emitting comments. */\r\n // "noEmit": true, /* Disable emitting files from a compilation. */\r\n // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */\r\n // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */\r\n "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */\r\n // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */\r\n // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */\r\n // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */\r\n // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */\r\n "newLine": "lf", /* Set the newline character for emitting files. */// "stripInternal": true, /* Disable emitting declarations that have \'@internal\' in their JSDoc comments. */\r\n // "noEmitHelpers": true, /* Disable generating custom helper functions like \'__extends\' in compiled output. */\r\n // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */\r\n // "preserveConstEnums": true, /* Disable erasing \'const enum\' declarations in generated code. */\r\n // "declarationDir": "./", /* Specify the output directory for generated declaration files. */\r\n // "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */\r\n /* Interop Constraints */\r\n // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */\r\n // "allowSyntheticDefaultImports": true, /* Allow \'import x from y\' when a module doesn\'t have a default export. */\r\n "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. */\r\n "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. *//* Type Checking */\r\n "strict": true, /* Enable all strict type-checking options. */// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied \'any\' type. */\r\n // "strictNullChecks": true, /* When type checking, take into account \'null\' and \'undefined\'. */\r\n // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */\r\n // "strictBindCallApply": true, /* Check that the arguments for \'bind\', \'call\', and \'apply\' methods match the original function. */\r\n // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */\r\n // "noImplicitThis": true, /* Enable error reporting when \'this\' is given the type \'any\'. */\r\n // "useUnknownInCatchVariables": true, /* Default catch clause variables as \'unknown\' instead of \'any\'. */\r\n // "alwaysStrict": true, /* Ensure \'use strict\' is always emitted. */\r\n // "noUnusedLocals": true, /* Enable error reporting when local variables aren\'t read. */\r\n // "noUnusedParameters": true, /* Raise an error when a function parameter isn\'t read. */\r\n // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding \'undefined\'. */\r\n // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */\r\n // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */\r\n // "noUncheckedIndexedAccess": true, /* Add \'undefined\' to a type when accessed using an index. */\r\n // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */\r\n // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */\r\n // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */\r\n // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */\r\n /* Completeness */\r\n // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */\r\n "skipLibCheck": true, /* Skip type checking all .d.ts files. */\r\n "plugins": [\r\n { "transform": "typia/lib/transform" },\r\n { "transform": "typescript-transform-paths" },\r\n ],\r\n },\r\n "include": ["src"],\r\n}'
|
|
313
|
+
content: '{\n "compilerOptions": {\n /* Visit https://aka.ms/tsconfig to read more about this file */\n /* Projects */\n // "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */\n // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */\n // "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */\n // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */\n // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */\n // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */\n /* Language and Environment */\n "target": "ES5", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */\n "lib": [\n "DOM",\n "ES2015"\n ], /* Specify a set of bundled library declaration files that describe the target runtime environment. */// "jsx": "preserve", /* Specify what JSX code is generated. */\n // "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */\n // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */\n // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. \'React.createElement\' or \'h\'. */\n // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. \'React.Fragment\' or \'Fragment\'. */\n // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using \'jsx: react-jsx*\'. */\n // "reactNamespace": "", /* Specify the object invoked for \'createElement\'. This only applies when targeting \'react\' JSX emit. */\n // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */\n // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */\n // "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */\n /* Modules */\n "module": "commonjs", /* Specify what module code is generated. */// "rootDir": "./", /* Specify the root folder within your source files. */\n // "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */\n // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */\n "paths": {\n "@ORGANIZATION/PROJECT-api": ["../src"],\n "@ORGANIZATION/PROJECT-api/lib/*": ["../src/*"],\n }, /* Specify a set of entries that re-map imports to additional lookup locations. */\n // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */\n // "typeRoots": [], /* Specify multiple folders that act like \'./node_modules/@types\'. */\n // "types": [], /* Specify type package names to be included without being referenced in a source file. */\n // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */\n // "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */\n "resolveJsonModule": true, /* Enable importing .json files. */\n // "noResolve": true, /* Disallow \'import\'s, \'require\'s or \'<reference>\'s from expanding the number of files TypeScript should add to a project. */\n /* JavaScript Support */\n // "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the \'checkJS\' option to get errors from these files. */\n // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */\n // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from \'node_modules\'. Only applicable with \'allowJs\'. */\n /* Emit */\n "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */// "declarationMap": true, /* Create sourcemaps for d.ts files. */\n // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */\n "sourceMap": true, /* Create source map files for emitted JavaScript files. */// "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. */\n "outDir": "./lib", /* Specify an output folder for all emitted files. */// "removeComments": true, /* Disable emitting comments. */\n // "noEmit": true, /* Disable emitting files from a compilation. */\n // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */\n // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */\n "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */\n // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */\n // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */\n // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */\n // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */\n "newLine": "lf", /* Set the newline character for emitting files. */// "stripInternal": true, /* Disable emitting declarations that have \'@internal\' in their JSDoc comments. */\n // "noEmitHelpers": true, /* Disable generating custom helper functions like \'__extends\' in compiled output. */\n // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */\n // "preserveConstEnums": true, /* Disable erasing \'const enum\' declarations in generated code. */\n // "declarationDir": "./", /* Specify the output directory for generated declaration files. */\n // "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */\n /* Interop Constraints */\n // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */\n // "allowSyntheticDefaultImports": true, /* Allow \'import x from y\' when a module doesn\'t have a default export. */\n "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. */\n "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. *//* Type Checking */\n "strict": true, /* Enable all strict type-checking options. */// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied \'any\' type. */\n // "strictNullChecks": true, /* When type checking, take into account \'null\' and \'undefined\'. */\n // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */\n // "strictBindCallApply": true, /* Check that the arguments for \'bind\', \'call\', and \'apply\' methods match the original function. */\n // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */\n // "noImplicitThis": true, /* Enable error reporting when \'this\' is given the type \'any\'. */\n // "useUnknownInCatchVariables": true, /* Default catch clause variables as \'unknown\' instead of \'any\'. */\n // "alwaysStrict": true, /* Ensure \'use strict\' is always emitted. */\n // "noUnusedLocals": true, /* Enable error reporting when local variables aren\'t read. */\n // "noUnusedParameters": true, /* Raise an error when a function parameter isn\'t read. */\n // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding \'undefined\'. */\n // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */\n // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */\n // "noUncheckedIndexedAccess": true, /* Add \'undefined\' to a type when accessed using an index. */\n // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */\n // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */\n // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */\n // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */\n /* Completeness */\n // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */\n "skipLibCheck": true, /* Skip type checking all .d.ts files. */\n "plugins": [\n { "transform": "typia/lib/transform" },\n { "transform": "typescript-transform-paths" },\n ],\n },\n "include": ["src"],\n}'
|
|
298
314
|
} ];
|
|
299
315
|
|
|
300
316
|
var FilePrinter;
|
|
@@ -492,10 +508,10 @@ var MigrateApiFunctionProgrammer;
|
|
|
492
508
|
};
|
|
493
509
|
})(MigrateApiFunctionProgrammer || (MigrateApiFunctionProgrammer = {}));
|
|
494
510
|
|
|
495
|
-
var
|
|
511
|
+
var MigrateApiSimulationProgrammer;
|
|
496
512
|
|
|
497
|
-
(function(
|
|
498
|
-
|
|
513
|
+
(function(MigrateApiSimulationProgrammer) {
|
|
514
|
+
MigrateApiSimulationProgrammer.random = components => importer => route => {
|
|
499
515
|
const output = route.success ? MigrateSchemaProgrammer.write(components)(importer)(route.success.schema) : TypeFactory.keyword("void");
|
|
500
516
|
return constant$1("random")(ts.factory.createArrowFunction(undefined, undefined, [ ts.factory.createParameterDeclaration(undefined, undefined, "g", ts.factory.createToken(ts.SyntaxKind.QuestionToken), ts.factory.createTypeReferenceNode(ts.factory.createIdentifier("Partial"), [ ts.factory.createTypeReferenceNode(`${importer.external({
|
|
501
517
|
type: "default",
|
|
@@ -507,7 +523,7 @@ var MigrateApiSimulatationProgrammer;
|
|
|
507
523
|
name: "typia"
|
|
508
524
|
})), "random"), [ output ], [ ts.factory.createIdentifier("g") ])));
|
|
509
525
|
};
|
|
510
|
-
|
|
526
|
+
MigrateApiSimulationProgrammer.simulate = components => importer => route => {
|
|
511
527
|
const caller = () => ts.factory.createCallExpression(ts.factory.createIdentifier("random"), undefined, [ ts.factory.createConditionalExpression(ts.factory.createLogicalAnd(ts.factory.createStrictEquality(ts.factory.createStringLiteral("object"), ts.factory.createTypeOfExpression(ts.factory.createIdentifier("connection.simulate"))), ts.factory.createStrictInequality(ts.factory.createNull(), ts.factory.createIdentifier("connection.simulate"))), undefined, ts.factory.createIdentifier("connection.simulate"), undefined, ts.factory.createIdentifier("undefined")) ]);
|
|
512
528
|
return constant$1("simulate")(ts.factory.createArrowFunction(undefined, undefined, MigrateApiFunctionProgrammer.writeParameterDeclarations(components)(importer)(route), ts.factory.createTypeReferenceNode(route.success ? "Output" : "void"), undefined, ts.factory.createBlock([ ...assert(components)(importer)(route), ts.factory.createReturnStatement(caller()) ], true)));
|
|
513
529
|
};
|
|
@@ -554,7 +570,7 @@ var MigrateApiSimulatationProgrammer;
|
|
|
554
570
|
library: "@nestia/fetcher",
|
|
555
571
|
name: "HttpError"
|
|
556
572
|
})) ], [ ts.factory.createIdentifier("exp") ])), ts.factory.createThrowStatement(ts.factory.createIdentifier("exp"))), ts.factory.createReturnStatement(ts.factory.createAsExpression(ts.factory.createObjectLiteralExpression([ ts.factory.createPropertyAssignment("success", ts.factory.createFalse()), ts.factory.createPropertyAssignment("status", ts.factory.createIdentifier("exp.status")), ts.factory.createPropertyAssignment("headers", ts.factory.createIdentifier("exp.headers")), ts.factory.createPropertyAssignment("data", ts.factory.createIdentifier("exp.toJSON().message")) ], true), TypeFactory.keyword("any"))) ], true)), undefined);
|
|
557
|
-
})(
|
|
573
|
+
})(MigrateApiSimulationProgrammer || (MigrateApiSimulationProgrammer = {}));
|
|
558
574
|
|
|
559
575
|
const constant$1 = name => expression => ts.factory.createVariableStatement([ ts.factory.createModifier(ts.SyntaxKind.ExportKeyword) ], ts.factory.createVariableDeclarationList([ ts.factory.createVariableDeclaration(ts.factory.createIdentifier(name), undefined, undefined, expression) ], ts.NodeFlags.Const));
|
|
560
576
|
|
|
@@ -563,7 +579,7 @@ var MigrateApiNamespaceProgrammer;
|
|
|
563
579
|
(function(MigrateApiNamespaceProgrammer) {
|
|
564
580
|
MigrateApiNamespaceProgrammer.write = config => components => importer => route => {
|
|
565
581
|
const types = writeTypes(components)(importer)(route);
|
|
566
|
-
return ts.factory.createModuleDeclaration([ ts.factory.createToken(ts.SyntaxKind.ExportKeyword) ], ts.factory.createIdentifier(route.accessor.at(-1)), ts.factory.createModuleBlock([ ...types, ...types.length ? [ FilePrinter.newLine() ] : [], writeMetadata(components)(importer)(route), FilePrinter.newLine(), writePath(components)(importer)(route), ...config.simulate ? [
|
|
582
|
+
return ts.factory.createModuleDeclaration([ ts.factory.createToken(ts.SyntaxKind.ExportKeyword) ], ts.factory.createIdentifier(route.accessor.at(-1)), ts.factory.createModuleBlock([ ...types, ...types.length ? [ FilePrinter.newLine() ] : [], writeMetadata(components)(importer)(route), FilePrinter.newLine(), writePath(components)(importer)(route), ...config.simulate ? [ MigrateApiSimulationProgrammer.random(components)(importer)(route), MigrateApiSimulationProgrammer.simulate(components)(importer)(route) ] : [] ]), ts.NodeFlags.Namespace);
|
|
567
583
|
};
|
|
568
584
|
MigrateApiNamespaceProgrammer.writePathCallExpression = route => ts.factory.createCallExpression(ts.factory.createIdentifier(`${route.accessor.at(-1)}.path`), undefined, [ ...route.parameters.map((p => ts.factory.createIdentifier(p.key))), ...route.query ? [ ts.factory.createIdentifier(route.query.key) ] : [] ]);
|
|
569
585
|
const writeTypes = components => importer => route => {
|
|
@@ -590,9 +606,9 @@ var MigrateApiNamespaceProgrammer;
|
|
|
590
606
|
const out = body => constant("path")(ts.factory.createArrowFunction([], [], [ ...route.parameters.map((p => IdentifierFactory.parameter(p.key, MigrateSchemaProgrammer.write(components)(importer)(p.schema)))), ...route.query ? [ IdentifierFactory.parameter(route.query.key, ts.factory.createTypeReferenceNode(`${route.accessor.at(-1)}.Query`)) ] : [] ], undefined, undefined, body));
|
|
591
607
|
const template = () => {
|
|
592
608
|
const path = getPath(route);
|
|
593
|
-
const
|
|
594
|
-
if (
|
|
595
|
-
return ts.factory.createTemplateExpression(ts.factory.createTemplateHead(
|
|
609
|
+
const split = path.split(":");
|
|
610
|
+
if (split.length === 1) return ts.factory.createStringLiteral(path);
|
|
611
|
+
return ts.factory.createTemplateExpression(ts.factory.createTemplateHead(split[0]), split.slice(1).map(((s, i, arr) => {
|
|
596
612
|
const name = s.split("/")[0];
|
|
597
613
|
return ts.factory.createTemplateSpan(ts.factory.createCallExpression(ts.factory.createIdentifier("encodeURIComponent"), undefined, [ ts.factory.createBinaryExpression(ts.factory.createIdentifier(route.parameters.find((p => p.name === name)).key), ts.factory.createToken(ts.SyntaxKind.QuestionQuestionToken), ts.factory.createStringLiteral("null")) ]), (i !== arr.length - 1 ? ts.factory.createTemplateMiddle : ts.factory.createTemplateTail)(s.substring(name.length)));
|
|
598
614
|
})));
|
|
@@ -8573,12 +8589,12 @@ class MigrateApplication {
|
|
|
8573
8589
|
};
|
|
8574
8590
|
return this.finalize(config, output);
|
|
8575
8591
|
}
|
|
8576
|
-
finalize(config,
|
|
8577
|
-
if (config.package)
|
|
8592
|
+
finalize(config, output) {
|
|
8593
|
+
if (config.package) output.files = output.files.map((file => ({
|
|
8578
8594
|
...file,
|
|
8579
8595
|
content: file.content.split(`@ORGANIZATION/PROJECT`).join(config.package)
|
|
8580
8596
|
})));
|
|
8581
|
-
return
|
|
8597
|
+
return output;
|
|
8582
8598
|
}
|
|
8583
8599
|
}
|
|
8584
8600
|
|