llmasaservice-client 0.0.1

package/.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

package/.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@3.0.2/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "restricted",
+  "baseBranch": "master",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

package/README.md

@@ -0,0 +1 @@
+# LLMAsAService.io for React Clients

package/dist/index.d.mts

@@ -0,0 +1,26 @@
+import React from 'react';
+
+type LLMAsAServiceCustomer = {
+    customer_id: string;
+    customer_name?: string;
+    customer_user_id?: string;
+    customer_user_email?: string;
+};
+interface LLMServiceType {
+    project_id: string | undefined;
+    customer: LLMAsAServiceCustomer;
+}
+declare const LLMService: React.Context<LLMServiceType | undefined>;
+
+declare const useLLM: (options?: LLMServiceType) => {
+    response: string;
+    send: (prompt: string, messages?: {
+        role: string;
+        content: string;
+    }[], stream?: boolean, abortController?: AbortController, service?: string | null) => Promise<ReadableStreamDefaultReader<any> | string | undefined>;
+    stop: (controller: AbortController | null) => void;
+    idle: boolean;
+    error: string;
+};
+
+export { LLMService as LLMAsAService, useLLM };

package/dist/index.d.ts

@@ -0,0 +1,26 @@
+import React from 'react';
+
+type LLMAsAServiceCustomer = {
+    customer_id: string;
+    customer_name?: string;
+    customer_user_id?: string;
+    customer_user_email?: string;
+};
+interface LLMServiceType {
+    project_id: string | undefined;
+    customer: LLMAsAServiceCustomer;
+}
+declare const LLMService: React.Context<LLMServiceType | undefined>;
+
+declare const useLLM: (options?: LLMServiceType) => {
+    response: string;
+    send: (prompt: string, messages?: {
+        role: string;
+        content: string;
+    }[], stream?: boolean, abortController?: AbortController, service?: string | null) => Promise<ReadableStreamDefaultReader<any> | string | undefined>;
+    stop: (controller: AbortController | null) => void;
+    idle: boolean;
+    error: string;
+};
+
+export { LLMService as LLMAsAService, useLLM };

package/dist/index.js

@@ -0,0 +1,186 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var __async = (__this, __arguments, generator) => {
+  return new Promise((resolve, reject) => {
+    var fulfilled = (value) => {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var rejected = (value) => {
+      try {
+        step(generator.throw(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
+    step((generator = generator.apply(__this, __arguments)).next());
+  });
+};
+
+// index.ts
+var useLLM_exports = {};
+__export(useLLM_exports, {
+  LLMAsAService: () => LLMAsAService_default,
+  useLLM: () => useLLM_default
+});
+module.exports = __toCommonJS(useLLM_exports);
+
+// src/useLLM.ts
+var import_react2 = require("react");
+
+// src/LLMAsAService.tsx
+var import_react = __toESM(require("react"));
+var LLMService = (0, import_react.createContext)(void 0);
+var LLMAsAService_default = LLMService;
+
+// src/useLLM.ts
+var useLLM = (options) => {
+  var _a;
+  const [response, setResponse] = (0, import_react2.useState)("");
+  const [idle, setIdle] = (0, import_react2.useState)(true);
+  const [error, setError] = (0, import_react2.useState)("");
+  const context = (_a = (0, import_react2.useContext)(LLMService)) != null ? _a : options;
+  if (!context) {
+    throw new Error(
+      "useLLM must be used within a LLMServiceProvider or constructed with options in your useLLM() call."
+    );
+  }
+  const stop = (controller) => {
+    if (controller) controller.abort();
+    setIdle(true);
+  };
+  function send(_0) {
+    return __async(this, arguments, function* (prompt, messages = [{ role: "system", content: "You are a useful assistant." }], stream = true, abortController = new AbortController(), service = null) {
+      var _a2, _b, _c;
+      setResponse("");
+      setIdle(false);
+      let errorInFetch = "";
+      const url = "https://chat.llmasaservice.io/";
+      const responseBody = JSON.stringify({
+        projectId: (_a2 = context == null ? void 0 : context.project_id) != null ? _a2 : "",
+        serviceId: service,
+        prompt,
+        messages,
+        customer: (_b = context == null ? void 0 : context.customer) != null ? _b : {}
+      });
+      const options2 = {
+        method: "POST",
+        signal: abortController.signal,
+        mode: "cors",
+        headers: {
+          "Content-Type": "text/plain"
+          //"x-Amz-Content-Sha256": sha256.create().update(responseBody).hex(),
+          //"x-Amz-Content-Sha256": "UNSIGNED-PAYLOAD",
+        },
+        body: responseBody
+      };
+      try {
+        const response2 = yield fetch(url, options2);
+        if (!response2.ok) {
+          errorInFetch = `Error: Network error for service. (${response2.status} ${response2.statusText})`;
+        } else {
+          const reader = (_c = response2 == null ? void 0 : response2.body) == null ? void 0 : _c.getReader();
+          const decoder = new TextDecoder("utf-8");
+          setIdle(false);
+          if (!stream) {
+            setResponse(
+              yield readStream(reader, decoder, stream, {
+                signal: options2.signal
+              })
+            );
+          } else {
+            readStream(reader, decoder, stream, {
+              signal: options2.signal
+            });
+            return reader;
+          }
+        }
+      } catch (errorObject) {
+        errorInFetch = `Error: Having trouble connecting to chat service. (${errorObject.message})`;
+      }
+      if (errorInFetch !== "") {
+        setError(errorInFetch);
+        console.error(`Error: Error in fetch. (${errorInFetch})`);
+      }
+    });
+  }
+  function readStream(_0, _1) {
+    return __async(this, arguments, function* (reader, decoder, stream = true, { signal }) {
+      let errorInRead = "";
+      let result = "";
+      while (true) {
+        try {
+          if (signal.aborted) {
+            reader.cancel();
+            setIdle(true);
+            break;
+          }
+          const { value, done } = yield reader.read();
+          if (decoder.decode(value).startsWith("Error:")) {
+            errorInRead = decoder.decode(value).substring(6);
+            break;
+          }
+          if (done) {
+            setIdle(true);
+            break;
+          }
+          result += decoder.decode(value);
+          if (stream) setResponse((prevState) => result);
+        } catch (error2) {
+          if (error2.name === "AbortError") {
+            break;
+          }
+          errorInRead = `Reading error  ${error2.message}`;
+          break;
+        } finally {
+          if (signal.aborted) {
+            reader.releaseLock();
+          }
+        }
+      }
+      if (errorInRead !== "") {
+        setError(errorInRead);
+        reader.cancel();
+        setIdle(true);
+      }
+      return result;
+    });
+  }
+  return { response, send, stop, idle, error };
+};
+var useLLM_default = useLLM;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  LLMAsAService,
+  useLLM
+});

package/dist/index.mjs

@@ -0,0 +1,149 @@
+var __async = (__this, __arguments, generator) => {
+  return new Promise((resolve, reject) => {
+    var fulfilled = (value) => {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var rejected = (value) => {
+      try {
+        step(generator.throw(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
+    step((generator = generator.apply(__this, __arguments)).next());
+  });
+};
+
+// src/useLLM.ts
+import { useContext, useState } from "react";
+
+// src/LLMAsAService.tsx
+import React, { createContext } from "react";
+var LLMService = createContext(void 0);
+var LLMAsAService_default = LLMService;
+
+// src/useLLM.ts
+var useLLM = (options) => {
+  var _a;
+  const [response, setResponse] = useState("");
+  const [idle, setIdle] = useState(true);
+  const [error, setError] = useState("");
+  const context = (_a = useContext(LLMService)) != null ? _a : options;
+  if (!context) {
+    throw new Error(
+      "useLLM must be used within a LLMServiceProvider or constructed with options in your useLLM() call."
+    );
+  }
+  const stop = (controller) => {
+    if (controller) controller.abort();
+    setIdle(true);
+  };
+  function send(_0) {
+    return __async(this, arguments, function* (prompt, messages = [{ role: "system", content: "You are a useful assistant." }], stream = true, abortController = new AbortController(), service = null) {
+      var _a2, _b, _c;
+      setResponse("");
+      setIdle(false);
+      let errorInFetch = "";
+      const url = "https://chat.llmasaservice.io/";
+      const responseBody = JSON.stringify({
+        projectId: (_a2 = context == null ? void 0 : context.project_id) != null ? _a2 : "",
+        serviceId: service,
+        prompt,
+        messages,
+        customer: (_b = context == null ? void 0 : context.customer) != null ? _b : {}
+      });
+      const options2 = {
+        method: "POST",
+        signal: abortController.signal,
+        mode: "cors",
+        headers: {
+          "Content-Type": "text/plain"
+          //"x-Amz-Content-Sha256": sha256.create().update(responseBody).hex(),
+          //"x-Amz-Content-Sha256": "UNSIGNED-PAYLOAD",
+        },
+        body: responseBody
+      };
+      try {
+        const response2 = yield fetch(url, options2);
+        if (!response2.ok) {
+          errorInFetch = `Error: Network error for service. (${response2.status} ${response2.statusText})`;
+        } else {
+          const reader = (_c = response2 == null ? void 0 : response2.body) == null ? void 0 : _c.getReader();
+          const decoder = new TextDecoder("utf-8");
+          setIdle(false);
+          if (!stream) {
+            setResponse(
+              yield readStream(reader, decoder, stream, {
+                signal: options2.signal
+              })
+            );
+          } else {
+            readStream(reader, decoder, stream, {
+              signal: options2.signal
+            });
+            return reader;
+          }
+        }
+      } catch (errorObject) {
+        errorInFetch = `Error: Having trouble connecting to chat service. (${errorObject.message})`;
+      }
+      if (errorInFetch !== "") {
+        setError(errorInFetch);
+        console.error(`Error: Error in fetch. (${errorInFetch})`);
+      }
+    });
+  }
+  function readStream(_0, _1) {
+    return __async(this, arguments, function* (reader, decoder, stream = true, { signal }) {
+      let errorInRead = "";
+      let result = "";
+      while (true) {
+        try {
+          if (signal.aborted) {
+            reader.cancel();
+            setIdle(true);
+            break;
+          }
+          const { value, done } = yield reader.read();
+          if (decoder.decode(value).startsWith("Error:")) {
+            errorInRead = decoder.decode(value).substring(6);
+            break;
+          }
+          if (done) {
+            setIdle(true);
+            break;
+          }
+          result += decoder.decode(value);
+          if (stream) setResponse((prevState) => result);
+        } catch (error2) {
+          if (error2.name === "AbortError") {
+            break;
+          }
+          errorInRead = `Reading error  ${error2.message}`;
+          break;
+        } finally {
+          if (signal.aborted) {
+            reader.releaseLock();
+          }
+        }
+      }
+      if (errorInRead !== "") {
+        setError(errorInRead);
+        reader.cancel();
+        setIdle(true);
+      }
+      return result;
+    });
+  }
+  return { response, send, stop, idle, error };
+};
+var useLLM_default = useLLM;
+export {
+  LLMAsAService_default as LLMAsAService,
+  useLLM_default as useLLM
+};

package/index.ts

@@ -0,0 +1,2 @@
+export { default as useLLM } from './src/useLLM';
+export { default as LLMAsAService } from './src/LLMAsAService';

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "llmasaservice-client",
+  "license": "MIT",
+  "version": "0.0.1",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsup index.ts --format cjs,esm --dts",
+    "lint": "tsc"
+  },
+  "peerDependencies": {
+    "react": "^18.3.0",
+    "react-dom": "^18.3.1"
+  },
+  "devDependencies": {
+    "@changesets/cli": "^2.27.7",
+    "@types/react": "^18.3.3",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "tsup": "^8.1.0",
+    "typescript": "^5.5.3"
+  },
+  "description": "HOC and hook to use the LLMAsAService.io LLM load balancer and firewall",
+  "author": "CASEY, Inc. <support@heycasey.io>"
+}

package/src/LLMAsAService.tsx

@@ -0,0 +1,35 @@
+import React, { createContext, ReactNode } from "react";
+
+export type LLMAsAServiceCustomer = {
+  customer_id: string;
+  customer_name?: string;
+  customer_user_id?: string;
+  customer_user_email?: string;
+};
+
+export interface LLMServiceType {
+  project_id: string | undefined;
+  customer: LLMAsAServiceCustomer;
+}
+
+export const LLMService = createContext<LLMServiceType | undefined>(undefined);
+
+interface UserProviderProps {
+  children: ReactNode;
+  project_id: string | undefined;
+  customer: LLMAsAServiceCustomer;
+}
+
+export const LLMServiceProvider: React.FC<UserProviderProps> = ({
+  children,
+  project_id,
+  customer,
+}) => {
+  return (
+    <LLMService.Provider value={{ project_id, customer }}>
+      {children}
+    </LLMService.Provider>
+  );
+};
+
+export default LLMService;

package/src/useLLM.ts

@@ -0,0 +1,165 @@
+import { useContext, useState } from "react";
+import { LLMService, LLMServiceType } from "./LLMAsAService";
+
+const useLLM = (options?: LLMServiceType) => {
+  const [response, setResponse] = useState<string>("");
+  const [idle, setIdle] = useState<boolean>(true);
+  const [error, setError] = useState<string>("");
+
+  const context = useContext(LLMService) ?? options;
+  if (!context) {
+    throw new Error(
+      "useLLM must be used within a LLMServiceProvider or constructed with options in your useLLM() call."
+    );
+  }
+
+  /**
+   * Stops the fetch request and returns the hook to an idle state. Use this to add abort functionality to your UI.
+   * 
+   * @param controller An AbortController object to stop the fetch request and return this hook to an idle state, the controller should be the same one passed to the send function.
+   */
+  const stop = (controller: AbortController | null) => {
+    if (controller) controller.abort();
+    setIdle(true);
+  };
+
+  /**
+   * Calls the LLM as a service with the given prompt and messages. The response is returned in the response property of the hook.
+   *
+   * @param prompt The prompt to send the the LLM service.
+   * @param messages The history and context messages to send to the LLM service. as an array of {role: string, content: string} objects. for example, [{ role: "system", content: "You are a useful assistant." }]
+   * @param stream  Determines whether to stream results back in the response property as they return from the service or batch them up and return them all at once in the response property as a string.
+   * @param abortController The AbortController used to abort this request once its started. This allows you to add a stop button to your UI.
+   * @param service The service to use for the request. If null, load balancing will be applied. This is typically only used for testing.
+   * @returns a StreamReader object if stream is true, otherwise a string of the response. Typically this isn't used when streaming, the stream is exposed in the response property.
+   */
+  async function send(
+    prompt: string,
+    messages = [{ role: "system", content: "You are a useful assistant." }],
+    stream: boolean = true,
+    abortController: AbortController = new AbortController(),
+    service: string | null = null // null means use the default service and apply services load balancing
+  ): Promise<ReadableStreamDefaultReader<any> | string | undefined> {
+    setResponse("");
+    setIdle(false);
+
+    let errorInFetch = "";
+    const url = "https://chat.llmasaservice.io/";
+
+    const responseBody = JSON.stringify({
+      projectId: context?.project_id ?? "",
+      serviceId: service,
+      prompt: prompt,
+      messages: messages,
+      customer: context?.customer ?? {},
+    });
+
+    // trying to get cloudfront oac going. posts need to be signed, but when i add this the call fails...
+    const options = {
+      method: "POST",
+      signal: abortController.signal,
+      mode: "cors" as RequestMode,
+      headers: {
+        "Content-Type": "text/plain",
+        //"x-Amz-Content-Sha256": sha256.create().update(responseBody).hex(),
+        //"x-Amz-Content-Sha256": "UNSIGNED-PAYLOAD",
+      },
+      body: responseBody,
+    };
+
+    try {
+      const response = await fetch(url, options);
+      if (!response.ok) {
+        errorInFetch = `Error: Network error for service. (${response.status} ${response.statusText})`;
+      } else {
+        const reader =
+          response?.body?.getReader() as ReadableStreamDefaultReader;
+        const decoder = new TextDecoder("utf-8");
+        setIdle(false);
+
+        if (!stream) {
+          setResponse(
+            await readStream(reader, decoder, stream, {
+              signal: options.signal,
+            })
+          );
+        } else {
+          readStream(reader, decoder, stream, {
+            signal: options.signal,
+          });
+
+          return reader;
+        }
+      }
+    } catch (errorObject: any) {
+      errorInFetch = `Error: Having trouble connecting to chat service. (${errorObject.message})`;
+    }
+
+    if (errorInFetch !== "") {
+      setError(errorInFetch);
+      console.error(`Error: Error in fetch. (${errorInFetch})`);
+    }
+  }
+
+  async function readStream(
+    reader: ReadableStreamDefaultReader,
+    decoder: TextDecoder,
+    stream: Boolean = true,
+    { signal: signal }: { signal: AbortSignal }
+  ): Promise<string> {
+    let errorInRead = "";
+    let result = "";
+
+    while (true) {
+      try {
+        // Check if the stream has been aborted
+        if (signal.aborted) {
+          reader.cancel();
+          setIdle(true);
+          break;
+        }
+
+        // Read a chunk of data from the stream
+        const { value, done } = await reader.read();
+
+        if (decoder.decode(value).startsWith("Error:")) {
+          errorInRead = decoder.decode(value).substring(6);
+          break;
+        }
+
+        // If the stream has been read to the end, exit the loop
+        if (done) {
+          setIdle(true);
+          break;
+        }
+
+        // Process the chunk of data
+        result += decoder.decode(value);
+        if (stream) setResponse((prevState: any) => result);
+      } catch (error: any) {
+        if (error.name === "AbortError") {
+          break;
+        }
+
+        errorInRead = `Reading error  ${error.message}`;
+        break;
+      } finally {
+        if (signal.aborted) {
+          reader.releaseLock();
+        }
+      }
+    }
+
+    if (errorInRead !== "") {
+      setError(errorInRead);
+      reader.cancel();
+      setIdle(true);
+    }
+
+    return result;
+  }
+
+  return { response, send, stop, idle, error };
+};
+
+export default useLLM;

package/tsconfig.json

@@ -0,0 +1,108 @@
+{
+  "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": "./",                                   /* 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. */
+  }
+}