openapi-sync 1.0.7 → 1.0.9

package/README.md

@@ -1,11 +1,37 @@
-## Install Openapi-sync
+# Openapi-sync
 
-`npm i openapi-sync`
+**Openapi-sync** leverages the power of OpenAPI schemas, just like Swagger UI, Postman, Redoc, and other popular tools. This package automates the creation of endpoint URIs and all defined types (including shared types) in a simple and developer-friendly manner and ensures your API remains up-to-date by checking for updates at intervals or right before committing your code (pre-commit).
 
-## Add a Openapi-sync config file
+## Installation
 
-Add a `openapi.sync.json` file at the root of your project (check out `openapi.sync.sample.json`)
+To install `openapi-sync`, run the following command:
 
-## Run `openapi-sync`
+```bash
+npm install openapi-sync
+```
 
-Run `openapi-sync` in terminal to start (you can also add it as a script in package.json)
+## Configuration
+
+Create an `openapi.sync.json` file at the root of your project to configure openapi-sync. You can use the provided `openapi.sync.sample.json` as a reference.
+
+## Usage
+
+To start using openapi-sync, simply run the following command in your terminal:
+
+```bash
+npx openapi-sync
+```
+
+You can also add it as a script in your package.json for easy access:
+
+```bash
+"scripts": {
+  "api-sync": "openapi-sync",
+}
+```
+
+## Features
+
+- Endpoint URI Generation: Automatically generate endpoint URIs from your OpenAPI schema.
+- Types Generation: Generate all defined types, including shared types, from your OpenAPI schema.
+- CLI Commands: Use the command-line interface to regenerate files at any time—on app start, pre-commit, or whenever needed.

package/bin/cli.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+require("../dist/index");

package/dist/Openapi-sync/components/helpers.js

@@ -28,8 +28,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseSchemaToType = exports.getEndpointDetails = exports.getSharedComponentName = exports.capitalize = exports.yamlStringToJson = exports.isYamlString = exports.isJson = void 0;
 const regex_1 = require("./regex");
-const property_expr_1 = __importDefault(require("property-expr"));
 const yaml = __importStar(require("js-yaml"));
+const lodash_1 = __importDefault(require("lodash"));
 const isJson = (value) => {
     return ["object"].includes(typeof value) && !(value instanceof Blob);
 };
@@ -100,7 +100,7 @@ const parseSchemaToType = (apiDoc, schema, name, isRequired, options) => {
             let pathToComponentParts = (schema.$ref || "").split("/");
             pathToComponentParts.shift();
             const pathToComponent = pathToComponentParts.join(".");
-            const component = property_expr_1.default.getter(pathToComponent)(apiDoc);
+            const component = lodash_1.default.get(apiDoc, pathToComponent, null);
             if (component) {
                 const componentName = pathToComponentParts[pathToComponentParts.length - 1];
                 // Reference component via import instead of parsing

package/package.json

@@ -1,16 +1,23 @@
 {
   "name": "openapi-sync",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "description": "sync openapi variables",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "bin": {
-    "openapi-sync": "./bin/cli"
+    "openapi-sync": "./bin/cli.js"
   },
+  "files": [
+    "bin",
+    "dist",
+    "LICENSE",
+    "README.md",
+    "package.json"
+  ],
   "scripts": {
     "test": "echo \"Error: no test specified\"",
     "build": "tsc",
-    "publish": "npm run build && npm version patch && npm publish && exit 0",
+    "publish-package": "npm run build && npm version patch &&  npm publish",
     "start": "ts-node index.ts"
   },
   "author": "P-Technologies",
@@ -28,7 +35,6 @@
     "axios-retry": "^4.5.0",
     "dotenv": "^16.4.5",
     "js-yaml": "^4.1.0",
-    "lodash": "^4.17.21",
-    "property-expr": "^2.0.6"
+    "lodash": "^4.17.21"
   }
 }

package/Openapi-sync/components/helpers.ts

@@ -1,150 +0,0 @@
-import { IOpenApiSpec, IOpenApSchemaSpec } from "../types";
-import { variableNameChar } from "./regex";
-import propertyExpr from "property-expr";
-import * as yaml from "js-yaml";
-
-export const isJson = (value: any) => {
-  return ["object"].includes(typeof value) && !(value instanceof Blob);
-};
-export const isYamlString = (fileContent: string) => {
-  try {
-    yaml.load(fileContent);
-    return true;
-  } catch (en) {
-    const e = en as any;
-    if (e instanceof yaml.YAMLException) {
-      return false;
-    } else {
-      throw e;
-    }
-  }
-};
-
-export const yamlStringToJson = (fileContent: string) => {
-  if (isYamlString(fileContent)) {
-    const content = yaml.load(fileContent);
-
-    const jsonString = JSON.stringify(content, null, 2);
-    const json = JSON.parse(jsonString);
-    return json;
-  }
-};
-
-export const capitalize = (text: string) => {
-  const capitalizedWord =
-    text.substring(0, 1).toUpperCase() + text.substring(1);
-  return capitalizedWord;
-};
-
-export const getSharedComponentName = (componentName: string) =>
-  `IApi${capitalize(componentName)}`;
-
-export const getEndpointDetails = (path: string, method: string) => {
-  const pathParts = path.split("/");
-  let name = `${capitalize(method)}`;
-  const variables: string[] = [];
-  pathParts.forEach((part) => {
-    // check if part is a variable
-    if (part[0] === "{" && part[part.length - 1] === "}") {
-      const s = part.replace(/{/, "").replace(/}/, "");
-      variables.push(s);
-      part = `$${s}`;
-    }
-
-    // parse to variable name
-    let partVal = "";
-    part.split("").forEach((char) => {
-      let c = char;
-      if (!variableNameChar.test(char)) c = "/";
-      partVal += c;
-    });
-
-    partVal.split("/").forEach((val) => {
-      name += capitalize(val);
-    });
-  });
-
-  return { name, variables, pathParts };
-};
-
-export const parseSchemaToType = (
-  apiDoc: IOpenApiSpec,
-  schema: IOpenApSchemaSpec,
-  name: string,
-  isRequired?: boolean,
-  options?: {
-    noSharedImport?: boolean;
-  }
-) => {
-  let typeName = name ? `\t${name}${isRequired ? "" : "?"}: ` : "";
-  let type = "";
-  if (schema.$ref) {
-    if (schema.$ref[0] === "#") {
-      let pathToComponentParts = (schema.$ref || "").split("/");
-      pathToComponentParts.shift();
-      const pathToComponent = pathToComponentParts.join(".");
-      const component = propertyExpr.getter(pathToComponent)(
-        apiDoc
-      ) as IOpenApSchemaSpec;
-
-      if (component) {
-        const componentName =
-          pathToComponentParts[pathToComponentParts.length - 1];
-        // Reference component via import instead of parsing
-        type += `${
-          options?.noSharedImport ? "" : "Shared."
-        }${getSharedComponentName(componentName)}`;
-        // type += `${parseSchemaToType(apiDoc, component, "", isRequired)}`;
-      }
-    } else {
-      type += "";
-      //TODO $ref is a uri - use axios to fetch doc
-    }
-  } else if (schema.type) {
-    if (schema.enum && schema.enum.length > 0) {
-      if (schema.enum.length > 1) type += "(";
-      type += schema.enum
-        .map((v) => `"${v}"`)
-        .join("|")
-        .toString();
-      if (schema.enum.length > 1) type += ")";
-    } else if (["string", "integer", "number", "array"].includes(schema.type)) {
-      if (schema.type === "string") {
-        type += `string`;
-      } else if (["integer", "number"].includes(schema.type)) {
-        type += `number`;
-      } else if (schema.type === "array") {
-        if (schema.items) {
-          type += `${parseSchemaToType(
-            apiDoc,
-            schema.items,
-            "",
-            false,
-            options
-          )}[]`;
-        } else {
-          type += "any[]";
-        }
-      }
-    } else if (schema.type === "object") {
-      if (schema.properties) {
-        //parse object key one at a time
-        const objKeys = Object.keys(schema.properties);
-        const requiredKeys = schema.required || [];
-        type += "{\n";
-        objKeys.forEach((key) => {
-          type += `${parseSchemaToType(
-            apiDoc,
-            schema.properties?.[key] as IOpenApSchemaSpec,
-            key,
-            requiredKeys.includes(key),
-            options
-          )}`;
-        });
-        type += "}";
-      }
-    }
-  }
-
-  return type.length > 0 ? `${typeName}${type}${name ? ";\n" : ""}` : "";
-};

package/Openapi-sync/components/regex.ts

@@ -1,2 +0,0 @@
-export const variableName = /^[A-Za-z_$][A-Za-z0-9_$]*$/;
-export const variableNameChar = /[A-Za-z0-9_$]/;

package/Openapi-sync/index.ts

@@ -1,252 +0,0 @@
-import fs from "fs";
-import path from "path";
-import {
-  getEndpointDetails,
-  getSharedComponentName,
-  isJson,
-  isYamlString,
-  parseSchemaToType,
-  yamlStringToJson,
-} from "./components/helpers";
-import {
-  IOpenApiMediaTypeSpec,
-  IOpenApiParameterSpec,
-  IOpenApiRequestBodySpec,
-  IOpenApiResponseSpec,
-  IOpenApiSpec,
-  IOpenApSchemaSpec,
-} from "./types";
-import { isEqual } from "lodash";
-import axios from "axios";
-import axiosRetry from "axios-retry";
-import { bundleFromString, createConfig } from "@redocly/openapi-core";
-import { getState, setState } from "./state";
-
-const rootUsingCwd = process.cwd();
-let fetchTimeout: null | NodeJS.Timeout = null;
-
-// Create an Axios instance
-const apiClient = axios.create({
-  timeout: 30000, // Timeout after 30 seconds
-});
-
-// Configure axios-retry
-axiosRetry(apiClient, {
-  retries: 20, // Number of retry attempts
-  retryCondition: (error) => {
-    // Retry on network error
-    return (
-      error.code === "ECONNABORTED" || error.message.includes("Network Error")
-    );
-  },
-  retryDelay: (retryCount) => {
-    return retryCount * 1000; // Exponential back-off: 1s, 2s, 3s, etc.
-  },
-});
-
-const OpenapiSync = async (apiUrl: string, apiName: string) => {
-  const specResponse = await apiClient.get(apiUrl);
-
-  const redoclyConfig = await createConfig({
-    extends: ["minimal"],
-  });
-
-  const source = JSON.stringify(
-    isJson(specResponse.data)
-      ? specResponse.data
-      : yamlStringToJson(specResponse.data)
-  );
-
-  const lintResults = await bundleFromString({
-    source,
-    config: redoclyConfig,
-  });
-
-  // Load config file
-  const config = require(path.join(rootUsingCwd, "openapi.sync.json"));
-  const folderPath = path.join(config.folder || "", apiName);
-
-  const spec: IOpenApiSpec = lintResults.bundle.parsed;
-  // auto update only on dev
-  if (
-    !(
-      process.env.NODE_ENV &&
-      ["production", "prod", "test", "staging"].includes(process.env.NODE_ENV)
-    )
-  ) {
-    // compare new spec with old spec, continuing only if spec it different
-    // auto sync at interval
-    if (fetchTimeout) clearTimeout(fetchTimeout);
-
-    if (!isNaN(config.refetchInterval) && config.refetchInterval) {
-      // use config interval or 1 hour
-      fetchTimeout = setTimeout(
-        () => OpenapiSync(apiUrl, apiName),
-        config.refetchInterval || 60000
-      );
-    }
-
-    const prevSpec = getState(apiName);
-    if (isEqual(prevSpec, spec)) return;
-
-    setState(apiName, spec);
-  }
-
-  let endpointsFileContent = "";
-  let typesFileContent = "";
-  let sharedTypesFileContent = "";
-
-  if (spec.components && spec.components.schemas) {
-    // Create components (shared) types
-    const components: Record<string, IOpenApiMediaTypeSpec> =
-      spec.components.schemas;
-    const contentKeys = Object.keys(components);
-    // only need 1 schema so will us the first schema provided
-    contentKeys.forEach((key) => {
-      const typeCnt = `${parseSchemaToType(
-        spec,
-        components[key] as IOpenApSchemaSpec,
-        "",
-        true,
-        {
-          noSharedImport: true,
-        }
-      )}`;
-      if (typeCnt) {
-        sharedTypesFileContent += `export type ${getSharedComponentName(
-          key
-        )} = ${typeCnt};\n`;
-      }
-    });
-  }
-
-  const getBodySchemaType = (requestBody: IOpenApiRequestBodySpec) => {
-    let typeCnt = "";
-    if (requestBody.content) {
-      const contentKeys = Object.keys(requestBody.content);
-      // only need 1 schema so will us the first schema provided
-      if (contentKeys[0] && requestBody.content[contentKeys[0]].schema) {
-        typeCnt += `${parseSchemaToType(
-          spec,
-          requestBody.content[contentKeys[0]].schema as IOpenApSchemaSpec,
-          ""
-        )}`;
-      }
-    }
-    return typeCnt;
-  };
-
-  Object.keys(spec.paths || {}).forEach((endpointPath) => {
-    const endpointSpec = spec.paths[endpointPath];
-    const endpointMethods = Object.keys(endpointSpec);
-    endpointMethods.forEach((method: string) => {
-      const endpoint = getEndpointDetails(endpointPath, method);
-
-      const endpointUrlTxt = endpoint.pathParts
-        .map((part) => {
-          // check if part is a variable
-          if (part[0] === "{" && part[part.length - 1] === "}") {
-            const s = part.replace(/{/, "").replace(/}/, "");
-            part = `\${${s}}`;
-          }
-          return part;
-        })
-        .join("/");
-
-      let endpointUrl = `"${endpointUrlTxt}"`;
-      if (endpoint.variables.length > 0) {
-        const params = endpoint.variables.map((v) => `${v}:string`).join(",");
-        endpointUrl = `(${params})=> \`${endpointUrlTxt}\``;
-      }
-      // Add the endpoint url
-      endpointsFileContent += `export const ${endpoint.name} = ${endpointUrl}; 
-`;
-
-      if (endpointSpec[method]?.parameters) {
-        // create query parameters types
-        const parameters: IOpenApiParameterSpec[] =
-          endpointSpec[method]?.parameters;
-        let typeCnt = "";
-        parameters.forEach((param) => {
-          if (param.in === "query" && param.name) {
-            typeCnt += `${parseSchemaToType(
-              spec,
-              param.schema as any,
-              param.name,
-              param.required
-            )}`;
-          }
-        });
-
-        if (typeCnt) {
-          typesFileContent += `export type I${endpoint.name}Query = {\n${typeCnt}};\n`;
-        }
-      }
-
-      if (endpointSpec[method]?.requestBody) {
-        //create requestBody types
-        const requestBody: IOpenApiRequestBodySpec =
-          endpointSpec[method]?.requestBody;
-
-        let typeCnt = getBodySchemaType(requestBody);
-        if (typeCnt) {
-          typesFileContent += `export type I${endpoint.name}DTO = ${typeCnt};\n`;
-        }
-      }
-
-      if (endpointSpec[method]?.responses) {
-        // create request response types
-        const responses: IOpenApiResponseSpec = endpointSpec[method]?.responses;
-        const resCodes = Object.keys(responses);
-        resCodes.forEach((code) => {
-          let typeCnt = getBodySchemaType(responses[code]);
-          if (typeCnt) {
-            typesFileContent += `export type I${endpoint.name}${code}Response = ${typeCnt};\n`;
-          }
-        });
-      }
-    });
-  });
-
-  // Create the necessary directories
-  const endpointsFilePath = path.join(rootUsingCwd, folderPath, "endpoints.ts");
-  await fs.promises.mkdir(path.dirname(endpointsFilePath), { recursive: true });
-  // Create the file asynchronously
-  await fs.promises.writeFile(endpointsFilePath, endpointsFileContent);
-
-  if (sharedTypesFileContent.length > 0) {
-    // Create the necessary directories
-    const sharedTypesFilePath = path.join(
-      rootUsingCwd,
-      folderPath,
-      "types",
-      "shared.ts"
-    );
-    await fs.promises.mkdir(path.dirname(sharedTypesFilePath), {
-      recursive: true,
-    });
-    // Create the file asynchronously
-    await fs.promises.writeFile(sharedTypesFilePath, sharedTypesFileContent);
-  }
-
-  if (typesFileContent.length > 0) {
-    // Create the necessary directories
-    const typesFilePath = path.join(
-      rootUsingCwd,
-      folderPath,
-      "types",
-      "index.ts"
-    );
-    await fs.promises.mkdir(path.dirname(typesFilePath), { recursive: true });
-    // Create the file asynchronously
-    await fs.promises.writeFile(
-      typesFilePath,
-      `${
-        sharedTypesFileContent.length > 0
-          ? `import * as  Shared from "./shared";\n\n`
-          : ""
-      }${typesFileContent}`
-    );
-  }
-};
-export default OpenapiSync;

package/Openapi-sync/state.ts

@@ -1,15 +0,0 @@
-import { IOpenApiSpec } from "./types";
-
-let state: Record<string, IOpenApiSpec> = {};
-
-export const setState = (key: string, value: IOpenApiSpec) => {
-  state[key] = value;
-};
-
-export const getState = (key: string): IOpenApiSpec | undefined => {
-  return state[key];
-};
-
-export const resetState = () => {
-  state = {};
-};

package/Openapi-sync/types.ts

@@ -1,43 +0,0 @@
-export type IOpenApiSpec = Record<"openapi", string> & Record<string, any>;
-
-export type IOpenApSchemaSpec = {
-  type: "string" | "integer" | "number" | "array" | "object";
-  example?: any;
-  enum?: string[];
-  format?: string;
-  items?: IOpenApSchemaSpec;
-  required?: string[];
-  $ref?: string;
-  properties?: Record<string, IOpenApSchemaSpec>;
-};
-
-export type IOpenApiParameterSpec = {
-  name: string;
-  in: string;
-  enum?: string[];
-  description?: string;
-  required?: boolean;
-  deprecated?: boolean;
-  allowEmptyValue?: boolean;
-  style?: string;
-  explode?: boolean;
-  allowReserved?: boolean;
-  schema?: IOpenApSchemaSpec;
-  example?: any;
-  examples?: any[];
-};
-
-export type IOpenApiMediaTypeSpec = {
-  schema?: IOpenApSchemaSpec;
-  example?: any;
-  examples?: any[];
-  encoding?: any;
-};
-
-export type IOpenApiRequestBodySpec = {
-  description?: string;
-  required?: boolean;
-  content: Record<string, IOpenApiMediaTypeSpec>;
-};
-
-export type IOpenApiResponseSpec = Record<string, IOpenApiRequestBodySpec>;

package/bin/cli

@@ -1,4 +0,0 @@
-#!/usr/bin/env sh
-
-
-npm run start

package/index.d.ts

@@ -1 +0,0 @@
-export * from "./Openapi-sync/types";

package/index.ts

@@ -1,24 +0,0 @@
-import OpenapiSync from "./Openapi-sync";
-import dotenv from "dotenv";
-import path from "path";
-import { resetState } from "./Openapi-sync/state";
-
-dotenv.config();
-
-const rootUsingCwd = process.cwd();
-
-const Init = async () => {
-  // Load config file
-  const config = require(path.join(rootUsingCwd, "openapi.sync.json"));
-  const apiNames = Object.keys(config.api);
-
-  resetState();
-  for (let i = 0; i < apiNames.length; i += 1) {
-    const apiName = apiNames[i];
-    const apiUrl = config.api[apiName];
-
-    OpenapiSync(apiUrl, apiName);
-  }
-};
-
-Init();

package/openapi.sync.sample.json

@@ -1,8 +0,0 @@
-{
-  "refetchInterval": 5000,
-  "folder": "inputed/path",
-  "api": {
-    "example1": "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json",
-    "example2": "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.yaml"
-  }
-}

package/tsconfig.json

@@ -1,108 +0,0 @@
-{
-  "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": "es2016",                                  /* 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": "./",                                  /* 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. */
-    // "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. */
-
-    /* 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. */
-    // "isolatedDeclarations": true,                     /* Require sufficient annotation on exports so other tools can trivially generate declaration files. */
-    // "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. */
-  }
-}