From bc2512a52f894403f2cd162d6a7db309f2386cde Mon Sep 17 00:00:00 2001 From: houjiazong Date: Tue, 31 Dec 2024 21:27:04 +0800 Subject: [PATCH] feat: add nodejs examples (#3) Co-authored-by: C.C --- .gitignore | 17 ++- tool-node-currency-converter/.env.example | 4 + tool-node-currency-converter/README.md | 135 +++++++++++++++++++++ tool-node-currency-converter/app.ts | 57 +++++++++ tool-node-currency-converter/package.json | 19 +++ tool-node-currency-converter/tsconfig.json | 111 +++++++++++++++++ tool-node-get-weather/.env.example | 4 + tool-node-get-weather/README.md | 135 +++++++++++++++++++++ tool-node-get-weather/app.ts | 51 ++++++++ tool-node-get-weather/package.json | 19 +++ tool-node-get-weather/tsconfig.json | 111 +++++++++++++++++ 11 files changed, 662 insertions(+), 1 deletion(-) create mode 100644 tool-node-currency-converter/.env.example create mode 100644 tool-node-currency-converter/README.md create mode 100644 tool-node-currency-converter/app.ts create mode 100644 tool-node-currency-converter/package.json create mode 100644 tool-node-currency-converter/tsconfig.json create mode 100644 tool-node-get-weather/.env.example create mode 100644 tool-node-get-weather/README.md create mode 100644 tool-node-get-weather/app.ts create mode 100644 tool-node-get-weather/package.json create mode 100644 tool-node-get-weather/tsconfig.json diff --git a/.gitignore b/.gitignore index d38e97a..f35c2ba 100644 --- a/.gitignore +++ b/.gitignore @@ -24,4 +24,19 @@ go.work.sum # yomo related *.yomo -yc.yml* \ No newline at end of file +yc.yml* +.env + +# node related +node_modules +.wrapper.ts +.wrapper.js + +# Logs +npm-debug.log* +yarn-debug.log* +yarn-error.log* +pnpm-debug.log* + +pnpm-lock.yaml +app.js diff --git a/tool-node-currency-converter/.env.example b/tool-node-currency-converter/.env.example new file mode 100644 index 0000000..c037ccc --- /dev/null +++ b/tool-node-currency-converter/.env.example @@ -0,0 +1,4 @@ +YOMO_SFN_NAME=my_first_llm_function_tool +YOMO_SFN_ZIPPER="zipper.vivgrid.com:9000" +YOMO_SFN_CREDENTIAL= +OPENEXCHANGERATES_API_KEY= \ No newline at end of file diff --git a/tool-node-currency-converter/README.md b/tool-node-currency-converter/README.md new file mode 100644 index 0000000..287149f --- /dev/null +++ b/tool-node-currency-converter/README.md @@ -0,0 +1,135 @@ +# LLM Function Calling - Currency Converter + +This is a serverless function for converting currency from USD to other currencies and vice versa. + +You can grab your api-key from [Exchange Rate API](https://www.exchangerate-api.com/) for free, then, add it to your `.env` file: + +```sh +YOMO_SFN_NAME=my_first_llm_function_tool +YOMO_SFN_ZIPPER=zipper.vivgrid.com:9000 +YOMO_SFN_CREDENTIAL= +OPENEXCHANGERATES_API_KEY= +``` + +Other environment variables can be found in the [vivgrid dashboard](https://dashboard.vivgrid.com/) serverless page + +## Development + +### 1. Install YoMo CLI + +```bash +curl -fsSL https://get.yomo.run | sh +``` + +Detail usages of the cli can be found on [Doc: YoMo CLI](https://yomo.run/docs/cli). + +### 2. Attach this function calling to your LLM Bridge + +```bash +yomo run app.ts -n llm-tool-currency-converter +``` + +### 3. Trigger the function calling + +Test in your terminal: + +```bash +curl https://api.vivgrid.com/v1/chat/completions \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer " \ + -d '{ + "model": "gpt-4o", + "messages": [ + { + "role": "user", + "content": "I have $10. Can I afford sunglasses that cost 1,499 yen?" + } + ] + }' +``` + +Based on the real time weather ifo, you may get response like: + +```json +{ + "id": "chatcmpl-Acss0I5tuh2ibDWr13E2p0X3LHVrG", + "object": "chat.completion", + "created": 1733830748, + "model": "gpt-4o-2024-08-06", + "choices": [ + { + "index": 0, + "message": { + "role": "assistant", + "content": "With $10, you have approximately 1,510.25 yen (using an exchange rate of about 151.02 JPY per USD). Since the sunglasses cost 1,499 yen, you can afford them." + }, + "finish_reason": "stop", + "content_filter_results": { + "hate": { + "filtered": false, + "severity": "safe" + }, + "self_harm": { + "filtered": false, + "severity": "safe" + }, + "sexual": { + "filtered": false, + "severity": "safe" + }, + "violence": { + "filtered": false, + "severity": "safe" + }, + "jailbreak": { + "filtered": false, + "detected": false + }, + "profanity": { + "filtered": false, + "detected": false + } + } + } + ], + "usage": { + "prompt_tokens": 226, + "completion_tokens": 118, + "total_tokens": 240, + "prompt_tokens_details": null, + "completion_tokens_details": null + }, + "system_fingerprint": "fp_04751d0b65", + "prompt_filter_results": [ + { + "index": 0, + "content_filter_results": { + "hate": { + "filtered": false, + "severity": "safe" + }, + "self_harm": { + "filtered": false, + "severity": "safe" + }, + "sexual": { + "filtered": false, + "severity": "safe" + }, + "violence": { + "filtered": false, + "severity": "safe" + }, + "jailbreak": { + "filtered": false, + "detected": false + }, + "profanity": { + "filtered": false, + "detected": false + } + } + } + ] +} +``` diff --git a/tool-node-currency-converter/app.ts b/tool-node-currency-converter/app.ts new file mode 100644 index 0000000..567f4b6 --- /dev/null +++ b/tool-node-currency-converter/app.ts @@ -0,0 +1,57 @@ +import 'dotenv/config' + +// Description outlines the functionality for the LLM Function Calling feature. +// It provides a detailed description of the function's purpose, essential for +// integration with LLM Function Calling. The presence of this function and its +// return value make the function discoverable and callable within the LLM +// ecosystem. For more information on Function Calling, refer to the OpenAI +// documentation at: https://platform.openai.com/docs/guides/function-calling +export const description = `if user asks currency exchange rate related questions, you should call this function. But if the source currency is other than USD (US Dollar), you should ignore calling tools.` + +// Tag specifies the data tag that this serverless function +// subscribes to, which is essential for data reception. When data with this +// tag is received, the Handler function will be triggered. +export const tag = 0x33 + +// Argument defines the arguments for the LLM Function Calling. These +// arguments are combined to form a prompt automatically. +export type Argument = { + sourceCurrency: string + targetCurrency: string + amount: number +} + +async function getRate(args: Argument) { + try { + const response = await fetch(`https://v6.exchangerate-api.com/v6/${process.env.OPENEXCHANGERATES_API_KEY}/latest/USD`) + if (!response.ok) { + return `Failed to fetch exchange rate for ${args.targetCurrency}` + } + const data = await response.json() + const rate = data.conversion_rates[args.targetCurrency] + if (!rate) { + return `Cannot get the target currency, target currency is ${args.targetCurrency}` + } + console.log('rate: ', rate) + return rate + } catch (error) { + console.error(error) + return 'can not get the target currency right now, please try later' + } +} + +/** + * + * Handler orchestrates the core processing logic of this function. + * @param args - LLM Function Calling Arguments(optional). + * @returns The result of the retrieval is returned to the LLM for processing. + */ +export async function handler(args: Argument) { + console.log('args', JSON.stringify(args)) + if (args.sourceCurrency !== 'USD') { + return 'Only USD is supported as the base currency.' + } + + const result = await getRate(args) + return result +} \ No newline at end of file diff --git a/tool-node-currency-converter/package.json b/tool-node-currency-converter/package.json new file mode 100644 index 0000000..28774d5 --- /dev/null +++ b/tool-node-currency-converter/package.json @@ -0,0 +1,19 @@ +{ + "name": "tool-node-currency-converter", + "version": "1.0.0", + "description": "LLM Function Calling - Currency Converter", + "main": ".wrapper.js", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "author": "", + "license": "ISC", + "devDependencies": { + "@types/node": "^22.10.1", + "typescript": "^5.7.2" + }, + "dependencies": { + "@yomo/sfn": "^1.0.5", + "dotenv": "^16.4.7" + } +} diff --git a/tool-node-currency-converter/tsconfig.json b/tool-node-currency-converter/tsconfig.json new file mode 100644 index 0000000..c9c555d --- /dev/null +++ b/tool-node-currency-converter/tsconfig.json @@ -0,0 +1,111 @@ +{ + "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. */ + // "rewriteRelativeImportExtensions": true, /* Rewrite '.ts', '.tsx', '.mts', and '.cts' file extensions in relative import paths to their JavaScript equivalent in output files. */ + // "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. */ + // "noUncheckedSideEffectImports": true, /* Check side effect 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 ''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. */ + // "noEmit": true, /* Disable emitting files from a compilation. */ + // "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": "./", /* Specify an output folder for all emitted files. */ + // "removeComments": true, /* Disable emitting comments. */ + // "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. */ + // "strictBuiltinIteratorReturn": true, /* Built-in iterators are instantiated with a 'TReturn' type of 'undefined' instead of 'any'. */ + // "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. */ + } +} diff --git a/tool-node-get-weather/.env.example b/tool-node-get-weather/.env.example new file mode 100644 index 0000000..207d208 --- /dev/null +++ b/tool-node-get-weather/.env.example @@ -0,0 +1,4 @@ +YOMO_SFN_NAME=my_first_llm_function_tool +YOMO_SFN_ZIPPER="zipper.vivgrid.com:9000" +YOMO_SFN_CREDENTIAL= +OPENWEATHERMAP_API_KEY= \ No newline at end of file diff --git a/tool-node-get-weather/README.md b/tool-node-get-weather/README.md new file mode 100644 index 0000000..e2fac09 --- /dev/null +++ b/tool-node-get-weather/README.md @@ -0,0 +1,135 @@ +# LLM Function Calling - Get Weather + +This is a serverless function for getting weather info. + +You can grab your api-key from [openweathermap.org](https://openweathermap.org) for free, then, add it to your `.env` file: + +```sh +YOMO_SFN_NAME=my_first_llm_function_tool +YOMO_SFN_ZIPPER=zipper.vivgrid.com:9000 +YOMO_SFN_CREDENTIAL= +OPENWEATHERMAP_API_KEY= +``` + +Other environment variables can be found in the [vivgrid dashboard](https://dashboard.vivgrid.com/) serverless page + +## Development + +### 1. Install YoMo CLI + +```bash +curl -fsSL https://get.yomo.run | sh +``` + +Detail usages of the cli can be found on [Doc: YoMo CLI](https://yomo.run/docs/cli). + +### 2. Attach this function calling to your LLM Bridge + +```bash +yomo run app.ts -n llm-tool-get-weather +``` + +### 3. Trigger the function calling + +Test in your terminal: + +```bash +curl https://api.vivgrid.com/v1/chat/completions \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer " \ + -d '{ + "model": "gpt-4o", + "messages": [ + { + "role": "user", + "content": "Is it raining in Paris and Sydney?" + } + ] + }' +``` + +Based on the real time weather ifo, you may get response like: + +```json +{ + "id": "chatcmpl-AcrlEtrh6nuOkz7fjGlwkCg2L7QpC", + "object": "chat.completion", + "created": 1733826484, + "model": "gpt-4o-2024-08-06", + "choices": [ + { + "index": 0, + "message": { + "role": "assistant", + "content": "Currently, it is not raining in either Paris or Sydney. \n\n- In **Paris**, the weather is characterized by broken clouds with a temperature of 6.1°C.\n- In **Sydney**, the weather also features broken clouds with a temperature of 20.82°C." + }, + "finish_reason": "stop", + "content_filter_results": { + "hate": { + "filtered": false, + "severity": "safe" + }, + "self_harm": { + "filtered": false, + "severity": "safe" + }, + "sexual": { + "filtered": false, + "severity": "safe" + }, + "violence": { + "filtered": false, + "severity": "safe" + }, + "jailbreak": { + "filtered": false, + "detected": false + }, + "profanity": { + "filtered": false, + "detected": false + } + } + } + ], + "usage": { + "prompt_tokens": 708, + "completion_tokens": 137, + "total_tokens": 730, + "prompt_tokens_details": null, + "completion_tokens_details": null + }, + "system_fingerprint": "fp_04751d0b65", + "prompt_filter_results": [ + { + "index": 0, + "content_filter_results": { + "hate": { + "filtered": false, + "severity": "safe" + }, + "self_harm": { + "filtered": false, + "severity": "safe" + }, + "sexual": { + "filtered": false, + "severity": "safe" + }, + "violence": { + "filtered": false, + "severity": "safe" + }, + "jailbreak": { + "filtered": false, + "detected": false + }, + "profanity": { + "filtered": false, + "detected": false + } + } + } + ] +} +``` diff --git a/tool-node-get-weather/app.ts b/tool-node-get-weather/app.ts new file mode 100644 index 0000000..ae31cbe --- /dev/null +++ b/tool-node-get-weather/app.ts @@ -0,0 +1,51 @@ +import 'dotenv/config' + +// Description outlines the functionality for the LLM Function Calling feature. +// It provides a detailed description of the function's purpose, essential for +// integration with LLM Function Calling. The presence of this function and its +// return value make the function discoverable and callable within the LLM +// ecosystem. For more information on Function Calling, refer to the OpenAI +// documentation at: https://platform.openai.com/docs/guides/function-calling +export const description = `Get current weather for a given city. If no city is provided, you + should ask to clarify the city. If the city name is given, you should + convert the city name to Latitude and Longitude geo coordinates, keeping + Latitude and Longitude in decimal format.` + +// Tag specifies the data tag that this serverless function +// subscribes to, which is essential for data reception. When data with this +// tag is received, the Handler function will be triggered. +export const tag = 0x33 + +// Argument defines the arguments for the LLM Function Calling. These +// arguments are combined to form a prompt automatically. +export type Argument = { + city: string + latitude: number + longitude: number +} + +async function getWeather(args: Argument) { + console.log('city: ', args.city, 'latitude: ', args.latitude, 'longitude: ', args.longitude) + try { + const response = await fetch(`https://api.openweathermap.org/data/2.5/weather?lat=${args.latitude}&lon=${args.longitude}&appid=${process.env.OPENWEATHERMAP_API_KEY}&units=metric`) + if (!response.ok) { + return 'can not get the weather information at the moment' + } + const data = await response.json() + return data + } catch (error) { + console.error(error) + return 'can not get the weather information at the moment' + } +} + +/** + * + * Handler orchestrates the core processing logic of this function. + * @param args - LLM Function Calling Arguments(optional). + * @returns The result of the retrieval is returned to the LLM for processing. + */ +export async function handler(args: Argument) { + const result = await getWeather(args) + return result +} \ No newline at end of file diff --git a/tool-node-get-weather/package.json b/tool-node-get-weather/package.json new file mode 100644 index 0000000..eade92e --- /dev/null +++ b/tool-node-get-weather/package.json @@ -0,0 +1,19 @@ +{ + "name": "tool-node-get-weather", + "version": "1.0.0", + "description": "LLM Function Calling - Get Weather", + "main": ".wrapper.js", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "author": "", + "license": "ISC", + "devDependencies": { + "@types/node": "^22.10.1", + "typescript": "^5.7.2" + }, + "dependencies": { + "@yomo/sfn": "^1.0.5", + "dotenv": "^16.4.7" + } +} diff --git a/tool-node-get-weather/tsconfig.json b/tool-node-get-weather/tsconfig.json new file mode 100644 index 0000000..c9c555d --- /dev/null +++ b/tool-node-get-weather/tsconfig.json @@ -0,0 +1,111 @@ +{ + "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. */ + // "rewriteRelativeImportExtensions": true, /* Rewrite '.ts', '.tsx', '.mts', and '.cts' file extensions in relative import paths to their JavaScript equivalent in output files. */ + // "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. */ + // "noUncheckedSideEffectImports": true, /* Check side effect 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 ''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. */ + // "noEmit": true, /* Disable emitting files from a compilation. */ + // "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": "./", /* Specify an output folder for all emitted files. */ + // "removeComments": true, /* Disable emitting comments. */ + // "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. */ + // "strictBuiltinIteratorReturn": true, /* Built-in iterators are instantiated with a 'TReturn' type of 'undefined' instead of 'any'. */ + // "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. */ + } +}