vls-openapi-generator 1.0.1

package/.commitlintrc.js

@@ -0,0 +1,5 @@
+module.exports = {
+    extends: ['@commitlint/config-conventional'],
+    plugins: [],
+    rules: {}
+};

package/.github/workflows/release.yaml

@@ -0,0 +1,58 @@
+name: CI/CD Pipeline
+
+on:
+    pull_request:
+        branches:
+            - main
+    push:
+        branches:
+            - main
+
+jobs:
+    release:
+        if: github.event_name == 'push'
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout code
+              uses: actions/checkout@v3
+
+            - name: Set up Node.js
+              uses: actions/setup-node@v3
+              with:
+                  node-version: '20'
+                  registry-url: 'https://registry.npmjs.org/'
+
+            - name: Install dependencies
+              run: npm install
+
+            - name: Build project
+              run: npm run build
+
+            - name: Release with Semantic
+              run: npx semantic-release
+              env:
+                  NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN_FOR_VLS }}
+
+    build:
+        if: github.event_name == 'pull_request'
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout code
+              uses: actions/checkout@v3
+
+            - name: Set up Node.js
+              uses: actions/setup-node@v3
+              with:
+                  node-version: '20'
+
+            - name: Install dependencies
+              run: npm install
+
+            - name: Run Prettier check
+              run: npx prettier --check .
+
+            - name: Lint check
+              run: npx eslint .
+
+            - name: Build project
+              run: npm run build

package/.github/workflows/security_allinone.yml

@@ -0,0 +1,23 @@
+name: Security AllInOne
+on:
+    push:
+        branches:
+            - feature/*
+    pull_request:
+        types:
+            - opened
+            - closed
+            - ready_for_review
+jobs:
+    build:
+        runs-on:
+            group: default
+            labels: self-hosted
+        steps:
+            - name: Trigger to Insider Security
+              run: |
+                  curl -X POST -H "Content-Type: application/json" \
+                  -d '{"type": "security-allinone", "version": "v1", "repository": "${{ github.event.repository.name }}", "ref": "${{ github.head_ref || github.ref_name }}", "event_name": "${{ github.event_name }}", "event_action": "${{ github.event.action }}", "default_branch": "${{ github.event.repository.default_branch }}"}' \
+                  $INSECPROXY_HOOK
+              env:
+                  INSECPROXY_HOOK: ${{ secrets.INSECPROXY_HOOK }}

package/.husky/commit-msg

@@ -0,0 +1 @@
+npx --no-install commitlint --edit "$1"

package/.husky/pre-commit

@@ -0,0 +1,2 @@
+npm run check-format
+npm run check-lint

package/.prettierignore

@@ -0,0 +1,4 @@
+*.js
+dist
+node_modules
+.eslintcache

package/.prettierrc.json

@@ -0,0 +1,7 @@
+{
+    "semi": true,
+    "trailingComma": "none",
+    "singleQuote": true,
+    "printWidth": 120,
+    "tabWidth": 4
+}

package/README.md

@@ -0,0 +1,18 @@
+## Technologies
+
+-   [Node.js](https://nodejs.org/en/)
+-   [Typescript](https://www.typescriptlang.org/)
+
+## Dependent Libraries
+
+-   [Zod](https://www.npmjs.com/package/zod)
+
+## Optional Libraries
+
+-   [Zod-Openapi](https://www.npmjs.com/package/@anatine/zod-openapi)
+
+## Usage
+
+`npm install vls-openapi-generator`
+
+    npx run vls-openapi-generator

package/SECURITY.MD

@@ -0,0 +1,7 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+To securely report a vulnerability, please [Contact us!](mailto:security@useinsider.com?subject=[GitHub]_Vulnerability!).
+
+<!-- E26CADE3-DF7C-4FF8-A30A-4DD2F28E06BF -->

package/dist/generate-openapi.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import 'module-alias/register.js';

package/dist/generate-openapi.js

@@ -0,0 +1,137 @@
+#!/usr/bin/env node
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+const zod_openapi_1 = require("@anatine/zod-openapi");
+const child_process_1 = require("child_process");
+const fs_1 = require("fs");
+require("module-alias/register.js");
+const path = __importStar(require("path"));
+const util_1 = require("util");
+const zod_1 = require("zod");
+const OPENAPI_FILE = path.join(process.cwd(), 'openapi.json');
+const HANDLERS_DIR = path.join(process.cwd(), 'dist', 'src', 'handlers');
+const SCHEMAS_DIR = path.join(process.cwd(), 'dist', 'src', 'schemas');
+const OUTPUT_FILE = path.join(process.cwd(), 'openapi.json');
+const generateTemplate = async () => {
+    console.info('Generating Open API documentation...');
+    await (0, util_1.promisify)(child_process_1.exec)('npx tsc');
+    const handlerFiles = await fs_1.promises.readdir(HANDLERS_DIR);
+    const existingOpenAPIFile = JSON.parse(await fs_1.promises.readFile(OPENAPI_FILE, 'utf-8'));
+    existingOpenAPIFile.paths = {};
+    existingOpenAPIFile.components = {
+        parameters: {},
+        schemas: {}
+    };
+    for (const handler of handlerFiles) {
+        const fileName = path.parse(handler).name;
+        const { bodySchema, queryParametersSchema, eventResponseParametersSchema, eventResponseModulesSchema } = (await Promise.resolve(`${path.join(SCHEMAS_DIR, fileName + '.js')}`).then(s => __importStar(require(s))).catch(() => ({})));
+        const { OPENAPI_CONFIG: openAPIConfig } = (await Promise.resolve(`${path.join(HANDLERS_DIR, fileName + '.js')}`).then(s => __importStar(require(s))).catch(() => ({})));
+        const bodyComponent = (0, zod_openapi_1.generateSchema)(bodySchema ?? zod_1.z.never(), undefined, '3.0');
+        const queryParametersComponent = (0, zod_openapi_1.generateSchema)(queryParametersSchema ?? zod_1.z.never(), undefined, '3.0');
+        const eventResponseComponent = (0, zod_openapi_1.generateSchema)(zod_1.z.object({
+            ...(eventResponseParametersSchema ? { params: eventResponseParametersSchema } : {}),
+            ...(eventResponseModulesSchema ? { modules: eventResponseModulesSchema } : {})
+        }), undefined, '3.0');
+        if (bodySchema) {
+            existingOpenAPIFile.components.schemas[`${fileName}-request-body`] = bodyComponent;
+        }
+        const queryParameterKeys = [];
+        if (queryParametersSchema) {
+            for (const key in queryParametersComponent.properties) {
+                const properties = queryParametersComponent?.properties;
+                if (!properties || !properties[key]) {
+                    continue;
+                }
+                const queryParameterKey = `${fileName}-${key}-query-parameter`;
+                queryParameterKeys.push(queryParameterKey);
+                existingOpenAPIFile.components.parameters[queryParameterKey] = {
+                    name: key,
+                    in: 'query',
+                    required: true,
+                    schema: properties[key]
+                };
+            }
+        }
+        if (eventResponseParametersSchema || eventResponseModulesSchema) {
+            existingOpenAPIFile.components.schemas[`${fileName}-response`] = eventResponseComponent;
+        }
+        existingOpenAPIFile.paths['/' + fileName] = {
+            post: {
+                tags: openAPIConfig.tags,
+                parameters: queryParametersSchema
+                    ? queryParameterKeys.map((x) => {
+                        return {
+                            $ref: `#/components/parameters/${x}`
+                        };
+                    })
+                    : undefined,
+                requestBody: bodySchema
+                    ? {
+                        required: true,
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: `#/components/schemas/${fileName}-request-body`
+                                }
+                            }
+                        }
+                    }
+                    : undefined,
+                responses: {
+                    '200': {
+                        description: `Successful response.`,
+                        content: eventResponseParametersSchema || eventResponseModulesSchema
+                            ? {
+                                'application/json': {
+                                    schema: {
+                                        $ref: `#/components/schemas/${fileName}-response`
+                                    }
+                                }
+                            }
+                            : undefined
+                    }
+                }
+            }
+        };
+    }
+    await fs_1.promises.writeFile(OUTPUT_FILE, JSON.stringify(existingOpenAPIFile, undefined, 4));
+};
+generateTemplate()
+    .then(() => console.info('Open API documentation generated successfully'))
+    .catch((error) => {
+    console.error(error);
+    process.exit(1);
+});

package/dist/lambda-type.d.ts

@@ -0,0 +1,3 @@
+export type OpenAPIConfig = {
+    tags: string[];
+};

package/dist/lambda-type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/openapi-type.d.ts

@@ -0,0 +1,52 @@
+export type OpenAPI = {
+    openapi: '3.0.0';
+    info: {
+        title: string;
+        version: string;
+    };
+    servers: [
+        {
+            url: string;
+        },
+        {
+            url: string;
+        },
+        {
+            url: string;
+        }
+    ];
+    paths: Record<string, {
+        post: {
+            parameters: {
+                $ref: string;
+            }[] | undefined;
+            requestBody: {
+                required: true;
+                content: {
+                    'application/json': {
+                        schema: {
+                            $ref: `#/components/schemas/${string}-request-body`;
+                        };
+                    };
+                };
+            } | undefined;
+            responses: {
+                200: {
+                    description: string;
+                    content: {
+                        'application/json': {
+                            schema: {
+                                $ref: `#/components/schemas/${string}-response`;
+                            };
+                        };
+                    } | undefined;
+                };
+            };
+            tags: string[];
+        };
+    }>;
+    components: {
+        parameters: Record<string, object>;
+        schemas: Record<string, object>;
+    };
+};

package/dist/openapi-type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/eslint.config.mjs

@@ -0,0 +1,42 @@
+import eslintJS from '@eslint/js';
+import tseslint from 'typescript-eslint';
+
+const ignoreList = ['**/*.js', '**/*.mjs', 'dist/**/*', 'node_modules/**/*', '.eslintcache'];
+
+const targetList = ['src/**/*.ts'];
+
+export default tseslint.config(
+    {
+        ...eslintJS.configs.recommended,
+        ignores: ignoreList
+    },
+    ...tseslint.configs.recommendedTypeChecked.map((x) => ({
+        ...x,
+        files: targetList,
+        ignores: ignoreList
+    })),
+    ...tseslint.configs.stylistic.map((x) => ({
+        ...x,
+        files: targetList,
+        ignores: ignoreList
+    })),
+    {
+        ignores: ignoreList,
+        languageOptions: {
+            parserOptions: {
+                projectService: true,
+                tsconfigRootDir: import.meta.dirname
+            }
+        },
+        files: ['src/**/*.ts'],
+        rules: {
+            '@typescript-eslint/no-unused-vars': [
+                'error',
+                { caughtErrors: 'all', caughtErrorsIgnorePattern: '^_', destructuredArrayIgnorePattern: '^_' }
+            ],
+            curly: 'error',
+            '@typescript-eslint/consistent-type-definitions': ['error', 'type'],
+            'no-multiple-empty-lines': ['error', { max: 1, maxEOF: 1 }]
+        }
+    }
+);

package/package.json

@@ -0,0 +1,39 @@
+{
+    "name": "vls-openapi-generator",
+    "version": "1.0.1",
+    "main": "dist/generate-template.js",
+    "types": "dist/lambda-type.d.ts",
+    "scripts": {
+        "check-format": "prettier . --check",
+        "fix-format": "prettier . --write",
+        "build": "tsc",
+        "check-lint": "eslint . --cache",
+        "fix-lint": "eslint . --fix",
+        "prepare": "husky"
+    },
+    "author": "Volans Team",
+    "license": "ISC",
+    "description": "VLS Open API Generator",
+    "dependencies": {
+        "@anatine/zod-openapi": "^2.2.7",
+        "module-alias": "^2.2.3"
+    },
+    "devDependencies": {
+        "@commitlint/config-conventional": "^19.5.0",
+        "@eslint/js": "^9.12.0",
+        "@semantic-release/git": "^10.0.1",
+        "@semantic-release/npm": "^12.0.1",
+        "@types/node": "^20.14.8",
+        "commitlint": "^19.5.0",
+        "eslint": "^9.12.0",
+        "globals": "^15.11.0",
+        "husky": "^9.1.6",
+        "prettier": "^2.7.1",
+        "semantic-release": "^24.1.2",
+        "typescript": "^5.6.3",
+        "typescript-eslint": "^8.9.0"
+    },
+    "bin": {
+        "vls-openapi-generator": "dist/generate-template.js"
+    }
+}

package/release.config.js

@@ -0,0 +1,15 @@
+module.exports = {
+    branches: ['main'],
+    plugins: [
+        '@semantic-release/commit-analyzer',
+        '@semantic-release/release-notes-generator',
+        '@semantic-release/npm',
+        [
+            '@semantic-release/git',
+            {
+                assets: ['package.json'],
+                message: 'chore(release): ${nextRelease.version} [skip ci]'
+            }
+        ]
+    ]
+};

package/src/generate-openapi.ts

@@ -0,0 +1,141 @@
+#!/usr/bin/env node
+
+import { generateSchema, OpenApiZodAny } from '@anatine/zod-openapi';
+import { exec } from 'child_process';
+import { promises as fs } from 'fs';
+import 'module-alias/register.js';
+import * as path from 'path';
+import { promisify } from 'util';
+import { z } from 'zod';
+import { OpenAPIConfig } from './lambda-type';
+import { OpenAPI } from './openapi-type';
+
+const OPENAPI_FILE = path.join(process.cwd(), 'openapi.json');
+const HANDLERS_DIR = path.join(process.cwd(), 'dist', 'src', 'handlers');
+const SCHEMAS_DIR = path.join(process.cwd(), 'dist', 'src', 'schemas');
+const OUTPUT_FILE = path.join(process.cwd(), 'openapi.json');
+
+const generateTemplate = async (): Promise<void> => {
+    console.info('Generating Open API documentation...');
+
+    await promisify(exec)('npx tsc');
+
+    const handlerFiles = await fs.readdir(HANDLERS_DIR);
+    const existingOpenAPIFile = JSON.parse(await fs.readFile(OPENAPI_FILE, 'utf-8')) as OpenAPI;
+
+    existingOpenAPIFile.paths = {};
+    existingOpenAPIFile.components = {
+        parameters: {},
+        schemas: {}
+    };
+
+    for (const handler of handlerFiles) {
+        const fileName = path.parse(handler).name;
+
+        const { bodySchema, queryParametersSchema, eventResponseParametersSchema, eventResponseModulesSchema } =
+            (await import(path.join(SCHEMAS_DIR, fileName + '.js')).catch(() => ({}))) as {
+                bodySchema?: OpenApiZodAny;
+                eventResponseParametersSchema?: OpenApiZodAny;
+                eventResponseModulesSchema?: OpenApiZodAny;
+                queryParametersSchema?: OpenApiZodAny;
+            };
+
+        const { OPENAPI_CONFIG: openAPIConfig } = (await import(path.join(HANDLERS_DIR, fileName + '.js')).catch(
+            () => ({})
+        )) as {
+            OPENAPI_CONFIG: OpenAPIConfig;
+        };
+
+        const bodyComponent = generateSchema(bodySchema ?? z.never(), undefined, '3.0');
+        const queryParametersComponent = generateSchema(queryParametersSchema ?? z.never(), undefined, '3.0');
+        const eventResponseComponent = generateSchema(
+            z.object({
+                ...(eventResponseParametersSchema ? { params: eventResponseParametersSchema } : {}),
+                ...(eventResponseModulesSchema ? { modules: eventResponseModulesSchema } : {})
+            }),
+            undefined,
+            '3.0'
+        );
+
+        if (bodySchema) {
+            existingOpenAPIFile.components.schemas[`${fileName}-request-body`] = bodyComponent;
+        }
+
+        const queryParameterKeys = [];
+
+        if (queryParametersSchema) {
+            for (const key in queryParametersComponent.properties) {
+                const properties = queryParametersComponent?.properties;
+
+                if (!properties || !properties[key]) {
+                    continue;
+                }
+
+                const queryParameterKey = `${fileName}-${key}-query-parameter`;
+
+                queryParameterKeys.push(queryParameterKey);
+
+                existingOpenAPIFile.components.parameters[queryParameterKey] = {
+                    name: key,
+                    in: 'query',
+                    required: true,
+                    schema: properties[key]
+                };
+            }
+        }
+
+        if (eventResponseParametersSchema || eventResponseModulesSchema) {
+            existingOpenAPIFile.components.schemas[`${fileName}-response`] = eventResponseComponent;
+        }
+
+        existingOpenAPIFile.paths['/' + fileName] = {
+            post: {
+                tags: openAPIConfig.tags,
+                parameters: queryParametersSchema
+                    ? queryParameterKeys.map((x) => {
+                          return {
+                              $ref: `#/components/parameters/${x}`
+                          };
+                      })
+                    : undefined,
+                requestBody: bodySchema
+                    ? {
+                          required: true,
+                          content: {
+                              'application/json': {
+                                  schema: {
+                                      $ref: `#/components/schemas/${fileName}-request-body`
+                                  }
+                              }
+                          }
+                      }
+                    : undefined,
+                responses: {
+                    '200': {
+                        description: `Successful response.`,
+                        content:
+                            eventResponseParametersSchema || eventResponseModulesSchema
+                                ? {
+                                      'application/json': {
+                                          schema: {
+                                              $ref: `#/components/schemas/${fileName}-response`
+                                          }
+                                      }
+                                  }
+                                : undefined
+                    }
+                }
+            }
+        };
+    }
+
+    await fs.writeFile(OUTPUT_FILE, JSON.stringify(existingOpenAPIFile, undefined, 4));
+};
+
+generateTemplate()
+    .then(() => console.info('Open API documentation generated successfully'))
+    .catch((error) => {
+        console.error(error);
+
+        process.exit(1);
+    });

package/src/lambda-type.ts

@@ -0,0 +1,3 @@
+export type OpenAPIConfig = {
+    tags: string[];
+};

package/src/openapi-type.ts

@@ -0,0 +1,53 @@
+export type OpenAPI = {
+    openapi: '3.0.0';
+    info: { title: string; version: string };
+    servers: [
+        { url: string },
+        {
+            url: string;
+        },
+
+        {
+            url: string;
+        }
+    ];
+    paths: Record<
+        string,
+        {
+            post: {
+                parameters: { $ref: string }[] | undefined;
+                requestBody:
+                    | {
+                          required: true;
+                          content: {
+                              'application/json': {
+                                  schema: {
+                                      $ref: `#/components/schemas/${string}-request-body`;
+                                  };
+                              };
+                          };
+                      }
+                    | undefined;
+                responses: {
+                    200: {
+                        description: string;
+                        content:
+                            | {
+                                  'application/json': {
+                                      schema: {
+                                          $ref: `#/components/schemas/${string}-response`;
+                                      };
+                                  };
+                              }
+                            | undefined;
+                    };
+                };
+                tags: string[];
+            };
+        }
+    >;
+    components: {
+        parameters: Record<string, object>;
+        schemas: Record<string, object>;
+    };
+};

package/tsconfig.json

@@ -0,0 +1,110 @@
+{
+    "compilerOptions": {
+        /* Visit https://aka.ms/tsconfig to read more about this file */
+
+        /* Projects */
+        // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+        // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+        // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+        // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+        // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+        // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+        /* Language and Environment */
+        "target": "ES2020" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
+        // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+        // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+        "experimentalDecorators": true /* Enable experimental support for legacy experimental decorators. */,
+        "emitDecoratorMetadata": true /* Emit design-type metadata for decorated declarations in source files. */,
+        // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+        // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+        // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+        // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+        // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+        // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+        // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+        /* Modules */
+        "module": "commonjs" /* Specify what module code is generated. */,
+        "rootDir": "src" /* Specify the root folder within your source files. */,
+        // "moduleResolution": "node10",                     /* Specify how TypeScript looks up a file from a given module specifier. */
+        // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+        // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+        // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+        // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+        // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+        // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+        // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+        // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
+        // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */
+        // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */
+        // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
+        "resolveJsonModule": true /* Enable importing .json files. */,
+        // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
+        // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+        /* JavaScript Support */
+        // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+        // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+        // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+        /* Emit */
+        "declaration": true /* Generate .d.ts files from TypeScript and JavaScript files in your project. */,
+        // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+        // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+        //  "sourceMap": true /* Create source map files for emitted JavaScript files. */,
+        // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+        // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+        "outDir": "dist" /* Specify an output folder for all emitted files. */,
+        // "removeComments": true,                           /* Disable emitting comments. */
+        // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+        // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+        // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
+        // "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. */
+        // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+        // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+        // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+        // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+        // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+        // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+        // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+        "preserveConstEnums": true /* Disable erasing 'const enum' declarations in generated code. */,
+        // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+        // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+        /* Interop Constraints */
+        // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+        // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
+        // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+        "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
+        // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+        "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
+
+        /* Type Checking */
+        "strict": true /* Enable all strict type-checking options. */,
+        "noImplicitAny": true /* Enable error reporting for expressions and declarations with an implied 'any' type. */,
+        // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+        // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+        // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+        // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+        // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+        // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+        // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+        // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+        // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+        // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+        // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+        // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+        // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+        // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+        // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+        // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+        // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+        /* Completeness */
+        // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+        "skipLibCheck": true /* Skip type checking all .d.ts files. */
+    },
+    "exclude": ["node_modules", "dist"]
+}