@statelyai/agent 0.0.1

package/dist/index.d.mts

@@ -0,0 +1,3 @@
+declare function helloWorld(): string;
+
+export { helloWorld };

package/dist/index.d.ts

@@ -0,0 +1,28 @@
+import * as xstate from 'xstate';
+import { AnyEventObject } from 'xstate';
+import OpenAI from 'openai';
+
+/**
+ * Creates [promise actor logic](https://stately.ai/docs/promise-actors) that uses the OpenAI API to generate a completion.
+ *
+ * @param openai The OpenAI instance.
+ * @param inputFn A function that maps arbitrary input to OpenAI chat completion input.
+ *
+ */
+declare function fromChatCompletion<TInput>(openai: OpenAI, inputFn: (input: TInput) => OpenAI.Chat.Completions.ChatCompletionCreateParamsNonStreaming): xstate.PromiseActorLogic<OpenAI.Chat.Completions.ChatCompletion, TInput>;
+/**
+ * Creates [observable actor logic](https://stately.ai/docs/observable-actors) that uses the OpenAI API to generate a completion stream.
+ *
+ * @param openai The OpenAI instance to use.
+ * @param inputFn A function that maps arbitrary input to OpenAI chat completion input.
+ */
+declare function fromChatCompletionStream<TInput>(openai: OpenAI, inputFn: (input: TInput) => OpenAI.Chat.Completions.ChatCompletionCreateParamsStreaming): xstate.ObservableActorLogic<OpenAI.Chat.Completions.ChatCompletionChunk, TInput>;
+/**
+ * Creates [promise actor logic](https://stately.ai/docs/promise-actors) that passes the next possible transitions as functions to [OpenAI tool calls](https://platform.openai.com/docs/guides/function-calling) and returns an array of potential next events.
+ *
+ * @param openai The OpenAI instance to use.
+ * @param inputFn A function that maps arbitrary input to OpenAI chat completion input.
+ */
+declare function fromEventChoice<TInput>(openai: OpenAI, inputFn: (input: TInput) => OpenAI.Chat.Completions.ChatCompletionCreateParamsNonStreaming): xstate.PromiseActorLogic<AnyEventObject[] | undefined, TInput>;
+
+export { fromChatCompletion, fromChatCompletionStream, fromEventChoice };

package/dist/index.js

@@ -0,0 +1,124 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+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 __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  fromChatCompletion: () => fromChatCompletion,
+  fromChatCompletionStream: () => fromChatCompletionStream,
+  fromEventChoice: () => fromEventChoice
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/openai.ts
+var import_xstate = require("xstate");
+
+// src/utils.ts
+function getAllTransitions(state) {
+  const nodes = state._nodes;
+  const transitions = nodes.map((node) => [...node.transitions.values()]).flat(2);
+  return transitions;
+}
+
+// src/openai.ts
+function fromChatCompletion(openai, inputFn) {
+  return (0, import_xstate.fromPromise)(
+    async ({ input }) => {
+      const openAiInput = inputFn(input);
+      const response = await openai.chat.completions.create(openAiInput);
+      return response;
+    }
+  );
+}
+function fromChatCompletionStream(openai, inputFn) {
+  return (0, import_xstate.fromObservable)(
+    ({ input }) => {
+      const observers = /* @__PURE__ */ new Set();
+      (async () => {
+        const openAiInput = inputFn(input);
+        const stream = await openai.chat.completions.create({
+          ...openAiInput,
+          stream: true
+        });
+        for await (const part of stream) {
+          observers.forEach((observer) => {
+            observer.next?.(part);
+          });
+        }
+      })();
+      return {
+        subscribe: (...args) => {
+          const observer = (0, import_xstate.toObserver)(...args);
+          observers.add(observer);
+          return {
+            unsubscribe: () => {
+              observers.delete(observer);
+            }
+          };
+        }
+      };
+    }
+  );
+}
+function fromEventChoice(openai, inputFn) {
+  return (0, import_xstate.fromPromise)(
+    async ({ input, self }) => {
+      const transitions = getAllTransitions(self._parent.getSnapshot());
+      const functionNameMapping = {};
+      const tools = transitions.filter((t) => {
+        return !t.eventType.startsWith("xstate.");
+      }).map((t) => {
+        const name = t.eventType.replace(/\./g, "_");
+        functionNameMapping[name] = t.eventType;
+        return {
+          type: "function",
+          function: {
+            name,
+            description: t.description,
+            parameters: {
+              type: "object",
+              properties: t.meta?.parameters ?? {}
+            }
+          }
+        };
+      });
+      const openAiInput = inputFn(input);
+      const completion = await openai.chat.completions.create({
+        ...openAiInput,
+        tools
+      });
+      const toolCalls = completion.choices[0]?.message.tool_calls;
+      if (toolCalls) {
+        return toolCalls.map((tc) => {
+          return {
+            type: functionNameMapping[tc.function.name],
+            ...JSON.parse(tc.function.arguments)
+          };
+        });
+      }
+      return toolCalls ?? void 0;
+    }
+  );
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  fromChatCompletion,
+  fromChatCompletionStream,
+  fromEventChoice
+});

package/dist/index.mjs

@@ -0,0 +1,7 @@
+// src/index.ts
+function helloWorld() {
+  return "Hello World!";
+}
+export {
+  helloWorld
+};

package/examples/joke.ts

@@ -0,0 +1,185 @@
+import OpenAI from 'openai';
+import { assign, fromPromise, createActor, waitFor, setup } from 'xstate';
+import { fromEventChoice } from '../src/index';
+
+const openai = new OpenAI({
+  apiKey: process.env.OPENAI_API_KEY,
+});
+
+async function start() {
+  const promptTemplate = (topic: string) => `Tell me a joke about ${topic}.`;
+
+  const getJokeCompletion = fromPromise(
+    async ({ input }: { input: { topic: string } }) => {
+      const res = await openai.chat.completions.create({
+        messages: [
+          {
+            role: 'user',
+            content: promptTemplate(input.topic),
+          },
+        ],
+        model: 'gpt-3.5-turbo',
+        n: 1,
+      });
+
+      return res.choices[0]?.message.content;
+    }
+  );
+
+  const rateJoke = fromPromise(
+    async ({ input }: { input: { joke: string } }) => {
+      const res = await openai.chat.completions.create({
+        messages: [
+          {
+            role: 'user',
+            content: `Rate this joke on a scale of 1 to 10: ${input.joke}`,
+          },
+        ],
+        model: 'gpt-3.5-turbo',
+        n: 1,
+      });
+
+      return res.choices[0]?.message.content;
+    }
+  );
+
+  const getTopic = fromPromise(async () => {
+    const topic = await new Promise<string>((res) => {
+      console.log('Give me a topic: \n\n');
+      process.stdin.on('data', (data) => {
+        const eventType = data.toString().trim();
+        res(eventType);
+      });
+    });
+
+    return topic;
+  });
+
+  const chain = setup({
+    types: {
+      context: {} as {
+        topic: string;
+        jokes: string[];
+        desire: string | null;
+        lastRating: string | null;
+      },
+      input: {} as { topic: string },
+    },
+    actors: {
+      getJokeCompletion,
+      getTopic,
+      rateJoke,
+      decide: fromEventChoice(openai, (desire: string) => ({
+        model: 'gpt-4-1106-preview',
+        messages: [
+          {
+            role: 'user',
+            content: `Execute the function that best satisfies this desire:
+
+${desire}
+`,
+          },
+        ],
+      })),
+    },
+  }).createMachine({
+    context: ({ input }) => ({
+      topic: input.topic,
+      jokes: [],
+      desire: null,
+      lastRating: null,
+    }),
+    initial: 'waitingForTopic',
+    states: {
+      waitingForTopic: {
+        invoke: {
+          src: 'getTopic',
+          onDone: {
+            actions: assign({
+              topic: ({ event }) => event.output,
+            }),
+            target: 'tellingJoke',
+          },
+        },
+      },
+      tellingJoke: {
+        invoke: {
+          src: 'getJokeCompletion',
+          input: ({ context }) => ({ topic: context.topic }),
+          onDone: {
+            actions: assign({
+              jokes: ({ context, event }) =>
+                context.jokes.concat(event.output as string),
+            }),
+            target: 'rateJoke',
+          },
+        },
+      },
+      rateJoke: {
+        invoke: {
+          src: 'rateJoke',
+          input: ({ context }) => ({
+            joke: context.jokes[context.jokes.length - 1]!,
+          }),
+          onDone: {
+            actions: assign({
+              lastRating: ({ event }) => event.output as string,
+            }),
+            target: 'joked',
+          },
+        },
+      },
+      joked: {
+        invoke: {
+          src: 'getTopic',
+          onDone: {
+            actions: assign({
+              desire: ({ event }) => event.output,
+            }),
+            target: 'decide',
+          },
+        },
+      },
+      decide: {
+        invoke: {
+          src: 'decide',
+          input: ({ context }) => context.desire!,
+        },
+        on: {
+          askForTopic: {
+            target: 'waitingForTopic',
+            description:
+              'Ask for a new topic, because the last joke was almost perfect',
+          },
+          endJokes: {
+            target: 'end',
+            description: 'End the jokes, since the last joke was not too good',
+          },
+        },
+      },
+      end: {},
+    },
+  });
+
+  const actor = createActor(chain, {
+    input: {
+      topic: 'donuts',
+    },
+  });
+
+  actor.subscribe((st) => {
+    console.log('State: ', st.value);
+
+    if (st.context.jokes) {
+      console.log('Joke: ', st.context.jokes[st.context.jokes.length - 1]);
+    }
+  });
+
+  actor.start();
+
+  await waitFor(actor, (snap) => snap.status === 'done', {
+    timeout: Infinity,
+  });
+}
+
+start();

package/examples/ticTacToe.ts

@@ -0,0 +1,249 @@
+import { assign, setup, assertEvent, createActor, raise } from 'xstate';
+import { fromChatCompletionStream, fromEventChoice } from '../src/openai';
+import OpenAI from 'openai';
+
+const openai = new OpenAI({
+  apiKey: process.env.OPENAI_API_KEY,
+});
+
+type Player = 'x' | 'o';
+
+const initialContext = {
+  board: Array(9).fill(null) as Array<Player | null>,
+  moves: 0,
+  player: 'x' as Player,
+  winner: undefined as Player | undefined,
+  gameReport: '',
+};
+
+export const ticTacToeMachine = setup({
+  types: {} as {
+    context: typeof initialContext;
+    events:
+      | { type: 'x.play'; index: number }
+      | {
+          type: 'o.play';
+          index: number;
+        }
+      | { type: 'RESET' };
+  },
+  actors: {
+    bot: fromEventChoice(
+      openai,
+      ({ context }: { context: typeof initialContext }) => ({
+        model: 'gpt-4-1106-preview',
+        messages: [
+          {
+            role: 'system',
+            content: `You are playing a game of tic tac toe. This is the current game state. The 3x3 board is represented by a 9-element array. The first element is the top-left cell, the second element is the top-middle cell, the third element is the top-right cell, the fourth element is the middle-left cell, and so on. The value of each cell is either null, x, or o. The value of null means that the cell is empty. The value of x means that the cell is occupied by an x. The value of o means that the cell is occupied by an o.
+
+${JSON.stringify(context, null, 2)}`,
+          },
+          {
+            role: 'user',
+            content:
+              'Execute the single best next move to try to win the game. Do not play on an existing cell.',
+          },
+        ],
+      })
+    ),
+    gameReporter: fromChatCompletionStream(
+      openai,
+      ({ context }: { context: typeof initialContext }) => ({
+        model: 'gpt-4-1106-preview',
+        messages: [
+          {
+            role: 'user',
+            content: `The tic-tac-toe game is over. The winner is ${
+              context.winner ?? 'nobody'
+            }. This was the ending board state:
+          
+${JSON.stringify(context.board, null, 2)}
+
+Provide a game report analyzing the game.`,
+          },
+        ],
+        stream: true,
+      })
+    ),
+  },
+  actions: {
+    updateBoard: assign({
+      board: ({ context, event }) => {
+        assertEvent(event, ['x.play', 'o.play']);
+        const updatedBoard = [...context.board];
+        updatedBoard[event.index] = context.player;
+        return updatedBoard;
+      },
+      moves: ({ context }) => context.moves + 1,
+      player: ({ context }) => (context.player === 'x' ? 'o' : 'x'),
+    }),
+    resetGame: assign(initialContext),
+    setWinner: assign({
+      winner: ({ context }) => (context.player === 'x' ? 'o' : 'x'),
+    }),
+  },
+  guards: {
+    checkWin: ({ context }) => {
+      const { board } = context;
+      const winningLines = [
+        [0, 1, 2],
+        [3, 4, 5],
+        [6, 7, 8],
+        [0, 3, 6],
+        [1, 4, 7],
+        [2, 5, 8],
+        [0, 4, 8],
+        [2, 4, 6],
+      ];
+
+      for (let line of winningLines) {
+        const xWon = line.every((index) => {
+          return board[index] === 'x';
+        });
+
+        if (xWon) {
+          return true;
+        }
+
+        const oWon = line.every((index) => {
+          return board[index] === 'o';
+        });
+
+        if (oWon) {
+          return true;
+        }
+      }
+
+      return false;
+    },
+    checkDraw: ({ context }) => {
+      return context.moves === 9;
+    },
+    isValidMove: ({ context, event }) => {
+      try {
+        assertEvent(event, ['o.play', 'x.play']);
+      } catch {
+        return false;
+      }
+
+      return context.board[event.index] === null;
+    },
+  },
+}).createMachine({
+  initial: 'playing',
+  context: initialContext,
+  states: {
+    playing: {
+      always: [
+        { target: 'gameOver.winner', guard: 'checkWin' },
+        { target: 'gameOver.draw', guard: 'checkDraw' },
+      ],
+      initial: 'x',
+      states: {
+        x: {
+          invoke: {
+            src: 'bot',
+            input: ({ context }) => ({ context }),
+            onDone: {
+              actions: raise(({ event }) => {
+                return event.output![0] as any;
+              }),
+            },
+          },
+          on: {
+            'x.play': [
+              {
+                target: 'o',
+                guard: 'isValidMove',
+                actions: 'updateBoard',
+                meta: {
+                  parameters: {
+                    index: {
+                      description: 'The index of the cell to play on',
+                      type: 'number',
+                      min: 0,
+                      max: 8,
+                    },
+                  },
+                },
+              },
+              { reenter: true },
+            ],
+          },
+        },
+        o: {
+          invoke: {
+            src: 'bot',
+            input: ({ context }) => ({ context }),
+            onDone: {
+              // @ts-ignore
+              actions: raise(({ event }) => {
+                console.log('output', event.output);
+                return event.output![0];
+              }),
+            },
+          },
+          on: {
+            'o.play': [
+              {
+                target: 'x',
+                guard: 'isValidMove',
+                actions: 'updateBoard',
+                meta: {
+                  parameters: {
+                    index: {
+                      description: 'The index of the cell to play on',
+                      type: 'number',
+                      min: 0,
+                      max: 8,
+                    },
+                  },
+                },
+              },
+              { reenter: true },
+            ],
+          },
+        },
+      },
+    },
+    gameOver: {
+      initial: 'winner',
+      invoke: {
+        src: 'gameReporter',
+        input: ({ context }) => ({ context }),
+        onSnapshot: {
+          actions: assign({
+            gameReport: ({ context, event }) => {
+              return (
+                context.gameReport +
+                (event.snapshot.context?.choices[0]?.delta.content ?? '')
+              );
+            },
+          }),
+        },
+      },
+      states: {
+        winner: {
+          tags: 'winner',
+          entry: 'setWinner',
+        },
+        draw: {
+          tags: 'draw',
+        },
+      },
+      on: {
+        RESET: {
+          target: 'playing',
+          actions: 'resetGame',
+        },
+      },
+    },
+  },
+});
+
+const actor = createActor(ticTacToeMachine);
+actor.subscribe((s) => {
+  console.log(s.value, s.context);
+});
+actor.start();

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@statelyai/agent",
+  "version": "0.0.1",
+  "description": "",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "lint": "tsc",
+    "test": "vitest run",
+    "prepublishOnly": "tsup src/index.ts --dts"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/node": "^20.10.6",
+    "tsup": "^8.0.1",
+    "typescript": "^5.3.3"
+  },
+  "dependencies": {
+    "openai": "^4.24.1",
+    "xstate": "^5.3.1"
+  }
+}

package/src/index.ts

@@ -0,0 +1,5 @@
+export {
+  fromChatCompletion,
+  fromChatCompletionStream,
+  fromEventChoice,
+} from './openai';

package/src/openai.ts

@@ -0,0 +1,135 @@
+import OpenAI from 'openai';
+import {
+  AnyEventObject,
+  Observer,
+  fromObservable,
+  fromPromise,
+  toObserver,
+} from 'xstate';
+import { getAllTransitions } from './utils';
+
+/**
+ * Creates [promise actor logic](https://stately.ai/docs/promise-actors) that uses the OpenAI API to generate a completion.
+ *
+ * @param openai The OpenAI instance.
+ * @param inputFn A function that maps arbitrary input to OpenAI chat completion input.
+ *
+ */
+export function fromChatCompletion<TInput>(
+  openai: OpenAI,
+  inputFn: (
+    input: TInput
+  ) => OpenAI.Chat.Completions.ChatCompletionCreateParamsNonStreaming
+) {
+  return fromPromise<OpenAI.Chat.Completions.ChatCompletion, TInput>(
+    async ({ input }) => {
+      const openAiInput = inputFn(input);
+      const response = await openai.chat.completions.create(openAiInput);
+
+      return response;
+    }
+  );
+}
+
+/**
+ * Creates [observable actor logic](https://stately.ai/docs/observable-actors) that uses the OpenAI API to generate a completion stream.
+ *
+ * @param openai The OpenAI instance to use.
+ * @param inputFn A function that maps arbitrary input to OpenAI chat completion input.
+ */
+export function fromChatCompletionStream<TInput>(
+  openai: OpenAI,
+  inputFn: (
+    input: TInput
+  ) => OpenAI.Chat.Completions.ChatCompletionCreateParamsStreaming
+) {
+  return fromObservable<OpenAI.Chat.Completions.ChatCompletionChunk, TInput>(
+    ({ input }) => {
+      const observers = new Set<Observer<any>>();
+
+      (async () => {
+        const openAiInput = inputFn(input);
+        const stream = await openai.chat.completions.create({
+          ...openAiInput,
+          stream: true,
+        });
+
+        for await (const part of stream) {
+          observers.forEach((observer) => {
+            observer.next?.(part);
+          });
+        }
+      })();
+
+      return {
+        subscribe: (...args) => {
+          const observer = toObserver(...(args as any));
+          observers.add(observer);
+
+          return {
+            unsubscribe: () => {
+              observers.delete(observer);
+            },
+          };
+        },
+      };
+    }
+  );
+}
+
+/**
+ * Creates [promise actor logic](https://stately.ai/docs/promise-actors) that passes the next possible transitions as functions to [OpenAI tool calls](https://platform.openai.com/docs/guides/function-calling) and returns an array of potential next events.
+ *
+ * @param openai The OpenAI instance to use.
+ * @param inputFn A function that maps arbitrary input to OpenAI chat completion input.
+ */
+export function fromEventChoice<TInput>(
+  openai: OpenAI,
+  inputFn: (
+    input: TInput
+  ) => OpenAI.Chat.Completions.ChatCompletionCreateParamsNonStreaming
+) {
+  return fromPromise<AnyEventObject[] | undefined, TInput>(
+    async ({ input, self }) => {
+      const transitions = getAllTransitions(self._parent!.getSnapshot());
+      const functionNameMapping: Record<string, string> = {};
+      const tools = transitions
+        .filter((t) => {
+          return !t.eventType.startsWith('xstate.');
+        })
+        .map((t) => {
+          const name = t.eventType.replace(/\./g, '_');
+          functionNameMapping[name] = t.eventType;
+          return {
+            type: 'function',
+            function: {
+              name,
+              description: t.description,
+              parameters: {
+                type: 'object',
+                properties: t.meta?.parameters ?? {},
+              },
+            },
+          } as const;
+        });
+      const openAiInput = inputFn(input);
+      const completion = await openai.chat.completions.create({
+        ...openAiInput,
+        tools,
+      });
+
+      const toolCalls = completion.choices[0]?.message.tool_calls;
+
+      if (toolCalls) {
+        return toolCalls.map((tc) => {
+          return {
+            type: functionNameMapping[tc.function.name],
+            ...JSON.parse(tc.function.arguments),
+          };
+        });
+      }
+
+      return toolCalls ?? undefined;
+    }
+  );
+}

package/src/utils.ts

@@ -0,0 +1,10 @@
+import { AnyMachineSnapshot, AnyStateNode } from 'xstate';
+
+export function getAllTransitions(state: AnyMachineSnapshot) {
+  const nodes = state._nodes;
+  const transitions = (nodes as AnyStateNode[])
+    .map((node) => [...(node as AnyStateNode).transitions.values()])
+    .flat(2);
+
+  return transitions;
+}

package/tsconfig.json

@@ -0,0 +1,109 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "es2020" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    "module": "commonjs" /* Specify what module code is generated. */,
+    // "rootDir": "./",                                  /* 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. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
+
+    /* Type Checking */
+    "strict": true /* Enable all strict type-checking options. */,
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    "noUncheckedIndexedAccess": true /* Add 'undefined' to a type when accessed using an index. */,
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true /* Skip type checking all .d.ts files. */
+  }
+}