@y1feng200156/sairin-core 1.1.2

package/lib/index.d.ts

@@ -0,0 +1,151 @@
+/// <reference types="lodash" />
+export type FrontMatter = {
+    path: string;
+};
+export type SairinConfig = {
+    siteConfig: {
+        title: string;
+        author?: string;
+        url?: string;
+    };
+    theme: any;
+    themeConfig: Record<string, any>;
+    allowUsers?: string[];
+};
+export declare class Sairin {
+    config: SairinConfig;
+    resolvedConfig: {
+        ghToken: string | undefined;
+        repo: string;
+        ghUserName: string;
+        repoSlug: string;
+    };
+    private PAGE_PATH_PLACEHOLDER;
+    private REVALIDATE;
+    private allowUsers;
+    private authHeaders;
+    private request;
+    constructor(config: SairinConfig);
+    getPostList: () => Promise<{
+        html: any;
+        attributes: FrontMatter;
+        id: string;
+        title: string;
+        url: string;
+        createdAt: string;
+        updatedAt: string;
+        body: string;
+        comments: {
+            nodes: {
+                url: string;
+                createdAt: string;
+                author: {
+                    login: string;
+                    url: string;
+                    avatarUrl: string;
+                };
+                body: string;
+            }[];
+        };
+        reactionGroups: {
+            content: string;
+            reactors: {
+                totalCount: number;
+            };
+        }[];
+        author: {
+            login: string;
+            url: string;
+            avatarUrl: any;
+        };
+    }[]>;
+    private processBody;
+    private getUser;
+    getStaticPaths: () => Promise<{
+        paths: string[];
+        fallback: boolean;
+    }>;
+    getHomePageStaticProps: () => Promise<{
+        props: {
+            posts: import("lodash").Omit<{
+                html: any;
+                attributes: FrontMatter;
+                id: string;
+                title: string;
+                url: string;
+                createdAt: string;
+                updatedAt: string;
+                body: string;
+                comments: {
+                    nodes: {
+                        url: string;
+                        createdAt: string;
+                        author: {
+                            login: string;
+                            url: string;
+                            avatarUrl: string;
+                        };
+                        body: string;
+                    }[];
+                };
+                reactionGroups: {
+                    content: string;
+                    reactors: {
+                        totalCount: number;
+                    };
+                }[];
+                author: {
+                    login: string;
+                    url: string;
+                    avatarUrl: any;
+                };
+            }, "body" | "html">[];
+            themeConfig: Record<string, any>;
+        };
+        revalidate: number;
+    }>;
+    getPostPageStaticProps: (ctx: any) => Promise<{
+        props: {
+            post: {
+                html: any;
+                attributes: FrontMatter;
+                id: string;
+                title: string;
+                url: string;
+                createdAt: string;
+                updatedAt: string;
+                body: string;
+                comments: {
+                    nodes: {
+                        url: string;
+                        createdAt: string;
+                        author: {
+                            login: string;
+                            url: string;
+                            avatarUrl: string;
+                        };
+                        body: string;
+                    }[];
+                };
+                reactionGroups: {
+                    content: string;
+                    reactors: {
+                        totalCount: number;
+                    };
+                }[];
+                author: {
+                    login: string;
+                    url: string;
+                    avatarUrl: any;
+                };
+            } | null;
+            themeConfig: Record<string, any>;
+        };
+        revalidate: number;
+    }>;
+    private generateFeed;
+    rssHandler: (req: any, res: any) => Promise<void>;
+    DocumentHead: () => import("react/jsx-runtime").JSX.Element;
+}
+export type HomePageThemeProps = Awaited<ReturnType<Sairin["getHomePageStaticProps"]>>["props"];
+export type PostPageThemeProps = Awaited<ReturnType<Sairin["getPostPageStaticProps"]>>["props"];

package/lib/index.js

@@ -0,0 +1,208 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Sairin = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const axios_1 = __importDefault(require("axios"));
+const marked_1 = require("marked");
+const marked_katex_extension_1 = __importDefault(require("marked-katex-extension"));
+const front_matter_1 = __importDefault(require("front-matter"));
+const lodash_1 = require("lodash");
+const feed_1 = require("feed");
+const prism = __importStar(require("prismjs"));
+const queries_1 = require("./queries");
+class Sairin {
+    request(query) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield axios_1.default.post("https://api.github.com/graphql", query, {
+                headers: this.authHeaders,
+            });
+            return res.data.data;
+        });
+    }
+    constructor(config) {
+        var _a;
+        this.config = config;
+        this.resolvedConfig = (() => {
+            const ghToken = process.env.GITHUB_TOKEN || undefined;
+            const repo = process.env.REPO ||
+                `${process.env.VERCEL_GIT_REPO_OWNER}/${process.env.VERCEL_GIT_REPO_SLUG}`;
+            const [ghUserName, repoSlug] = repo.split("/");
+            return {
+                ghToken,
+                repo,
+                ghUserName,
+                repoSlug,
+            };
+        })();
+        this.PAGE_PATH_PLACEHOLDER = "path";
+        this.REVALIDATE = 60;
+        this.allowUsers = [this.resolvedConfig.ghUserName].concat(((_a = this.config) === null || _a === void 0 ? void 0 : _a.allowUsers) || []);
+        this.authHeaders = this.resolvedConfig.ghToken
+            ? {
+                Authorization: `bearer ${this.resolvedConfig.ghToken}`,
+            }
+            : {};
+        this.getPostList = () => __awaiter(this, void 0, void 0, function* () {
+            const result = yield this.request((0, queries_1.GetPostsQuery)({
+                owner: this.resolvedConfig.ghUserName,
+                repo: this.resolvedConfig.repoSlug,
+            }));
+            const posts = result.repository.issues.nodes
+                .filter((post) => {
+                return this.allowUsers.indexOf(post.author.login) !== -1;
+            })
+                .map((post) => {
+                const { html, attributes } = this.processBody(post.body);
+                post.comments.nodes = post.comments.nodes.map((comment) => {
+                    const { html } = this.processBody(comment.body);
+                    return Object.assign(Object.assign({}, comment), { html });
+                });
+                return Object.assign(Object.assign({}, post), { html,
+                    attributes });
+            });
+            return posts;
+        });
+        this.getStaticPaths = () => __awaiter(this, void 0, void 0, function* () {
+            const posts = yield this.getPostList();
+            return {
+                paths: posts.map((p) => {
+                    // TODO: the fallback path should be issue id
+                    return `/${p.attributes.path || ""}`;
+                }),
+                fallback: true,
+            };
+        });
+        this.getHomePageStaticProps = () => __awaiter(this, void 0, void 0, function* () {
+            const posts = (yield this.getPostList()).map((post) => {
+                return (0, lodash_1.omit)(post, ["body", "html"]);
+            });
+            return {
+                props: {
+                    // TODO: reduce post body size
+                    posts,
+                    themeConfig: this.config.themeConfig || {},
+                },
+                revalidate: this.REVALIDATE,
+            };
+        });
+        this.getPostPageStaticProps = (ctx) => __awaiter(this, void 0, void 0, function* () {
+            var _b;
+            const posts = yield this.getPostList();
+            const post = posts.find((p) => p.attributes.path === ctx.params[this.PAGE_PATH_PLACEHOLDER].join("/")) || null;
+            return {
+                props: {
+                    post,
+                    themeConfig: ((_b = this.config) === null || _b === void 0 ? void 0 : _b.themeConfig) || {},
+                },
+                revalidate: this.REVALIDATE,
+            };
+        });
+        this.generateFeed = () => __awaiter(this, void 0, void 0, function* () {
+            const feed = new feed_1.Feed({
+                title: this.config.siteConfig.title,
+                copyright: this.config.siteConfig.title,
+                id: this.config.siteConfig.title,
+                author: {
+                    name: this.config.siteConfig.author || this.resolvedConfig.ghUserName,
+                },
+            });
+            if (!this.config.siteConfig.url) {
+                return feed.atom1();
+            }
+            const posts = yield this.getPostList();
+            posts.forEach((post) => {
+                feed.addItem({
+                    date: new Date(post.updatedAt),
+                    link: `${this.config.siteConfig.url}/${post.attributes.path}`,
+                    title: post.title,
+                    content: post.html,
+                });
+            });
+            return feed.atom1();
+        });
+        this.rssHandler = (req, res) => __awaiter(this, void 0, void 0, function* () {
+            res.setHeader("Content-Type", "application/xml");
+            // https://vercel.com/docs/concepts/edge-network/caching#stale-while-revalidate
+            res.setHeader("Cache-Control", `s-maxage=1 stale-while-revalidate=${10 * 60}`);
+            res.send(yield this.generateFeed());
+        });
+        this.DocumentHead = () => {
+            var _a;
+            return ((0, jsx_runtime_1.jsx)(jsx_runtime_1.Fragment, { children: ((_a = this.config) === null || _a === void 0 ? void 0 : _a.theme.Head) && ((0, jsx_runtime_1.jsx)(this.config.theme.Head, { sairinConfig: this.config })) }));
+        };
+    }
+    processBody(body) {
+        const { body: rawBody, attributes } = (0, front_matter_1.default)(body);
+        marked_1.marked.use((0, marked_katex_extension_1.default)({
+            throwOnError: false,
+        }));
+        marked_1.marked.use({
+            renderer: {
+                code(code, lang, escaped) {
+                    code = this.options.highlight(code, lang);
+                    if (!lang) {
+                        return `<pre><code>${code}</code></pre>`;
+                    }
+                    var langClass = "language-" + lang;
+                    return `<pre class="${langClass}"><code class="${langClass}">${code}</code></pre>`;
+                },
+            },
+        });
+        const parsed = marked_1.marked.parse(rawBody, {
+            highlight: (code, lang) => {
+                if (prism.languages[lang]) {
+                    return prism.highlight(code, prism.languages[lang], lang);
+                }
+                else {
+                    return code;
+                }
+            },
+        });
+        return {
+            html: parsed,
+            attributes,
+        };
+    }
+    getUser(username) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield axios_1.default.get(`https://api.github.com/users/${username}`);
+            return res.data;
+        });
+    }
+}
+exports.Sairin = Sairin;

package/lib/queries.d.ts

@@ -0,0 +1,45 @@
+export type GetPostQueryVar = {
+    owner: string;
+    repo: string;
+};
+export type GetPostQueryProps = {
+    repository: {
+        issues: {
+            nodes: {
+                id: string;
+                title: string;
+                url: string;
+                createdAt: string;
+                updatedAt: string;
+                body: string;
+                comments: {
+                    nodes: {
+                        url: string;
+                        createdAt: string;
+                        author: {
+                            login: string;
+                            url: string;
+                            avatarUrl: string;
+                        };
+                        body: string;
+                    }[];
+                };
+                reactionGroups: {
+                    content: string;
+                    reactors: {
+                        totalCount: number;
+                    };
+                }[];
+                author: {
+                    login: string;
+                    url: string;
+                    avatarUrl: any;
+                };
+            }[];
+        };
+    };
+};
+export declare const GetPostsQuery: (variables: GetPostQueryVar) => {
+    query: string;
+    variables: GetPostQueryVar;
+};

package/lib/queries.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetPostsQuery = void 0;
+const GetPostsQuery = (variables) => ({
+    query: `
+      query GetPosts($owner: String!, $repo: String!) { 
+  repository(owner: $owner, name: $repo) {
+    issues(first: 100, orderBy: {
+      field: CREATED_AT, direction: DESC
+    }, labels: ["published"]) {
+      nodes {
+        id,
+        url,
+        title,
+        updatedAt,
+        createdAt,
+        body,
+        comments (first: 100) {
+          nodes {
+            createdAt,
+            url,
+            author {
+              login,
+              url,
+              avatarUrl,
+            },
+            body
+          }
+        },
+        reactionGroups {
+          content,
+          reactors {
+            totalCount,
+          }
+        },
+        author {
+          login,
+          url,
+          avatarUrl
+        }
+      }
+    }
+  }
+}
+    `,
+    variables,
+});
+exports.GetPostsQuery = GetPostsQuery;

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@y1feng200156/sairin-core",
+  "version": "1.1.2",
+  "main": "lib/index.js",
+  "scripts": {
+    "dev": "tsc --watch",
+    "build": "tsc",
+    "prepublish": "npm run build"
+  },
+  "devDependencies": {
+    "@types/lodash": "^4.14.178",
+    "@types/node": "^17.0.45",
+    "typescript": "^4.5.5"
+  },
+  "dependencies": {
+    "@types/react": "^17.0.39",
+    "axios": "^0.26.0",
+    "debug": "^4.3.3",
+    "feed": "^4.2.2",
+    "front-matter": "^4.0.2",
+    "katex": "^0.16.27",
+    "lodash": "^4.17.21",
+    "marked": "^4.0.12",
+    "marked-katex-extension": "^5.1.6",
+    "prismjs": "^1.27.0"
+  }
+}

package/src/index.tsx

@@ -0,0 +1,234 @@
+import axios from "axios";
+import { marked } from "marked";
+import markedKatex from "marked-katex-extension";
+import fm from "front-matter";
+import { omit, pick } from "lodash";
+import { Feed } from "feed";
+
+import * as prism from "prismjs";
+import { GetPostQueryProps, GetPostsQuery } from "./queries";
+
+export type FrontMatter = {
+  path: string;
+};
+
+export type SairinConfig = {
+  siteConfig: {
+    title: string;
+    author?: string;
+    url?: string;
+  };
+  theme: any;
+  themeConfig: Record<string, any>;
+  allowUsers?: string[];
+};
+
+export class Sairin {
+  resolvedConfig = (() => {
+    const ghToken = (process.env.GITHUB_TOKEN as string) || undefined;
+    const repo =
+      process.env.REPO ||
+      (`${process.env.VERCEL_GIT_REPO_OWNER}/${process.env.VERCEL_GIT_REPO_SLUG}` as string);
+
+    const [ghUserName, repoSlug] = repo.split("/");
+
+    return {
+      ghToken,
+      repo,
+      ghUserName,
+      repoSlug,
+    };
+  })();
+
+  private PAGE_PATH_PLACEHOLDER = "path";
+
+  private REVALIDATE = 60;
+
+  private allowUsers: string[] = [this.resolvedConfig.ghUserName].concat(
+    this.config?.allowUsers || []
+  );
+
+  private authHeaders = this.resolvedConfig.ghToken
+    ? {
+        Authorization: `bearer ${this.resolvedConfig.ghToken}`,
+      }
+    : ({} as any);
+
+  private async request<T>(query: { query: string; variables: any }) {
+    const res = await axios.post("https://api.github.com/graphql", query, {
+      headers: this.authHeaders,
+    });
+    return res.data.data as T;
+  }
+
+  constructor(public config: SairinConfig) {}
+
+  getPostList = async () => {
+    const result = await this.request<GetPostQueryProps>(
+      GetPostsQuery({
+        owner: this.resolvedConfig.ghUserName,
+        repo: this.resolvedConfig.repoSlug,
+      })
+    );
+
+    const posts = result.repository.issues.nodes
+      .filter((post) => {
+        return this.allowUsers.indexOf(post.author.login) !== -1;
+      })
+      .map((post) => {
+        const { html, attributes } = this.processBody(post.body);
+        post.comments.nodes = post.comments.nodes.map((comment) => {
+          const { html } = this.processBody(comment.body);
+          return {
+            ...comment,
+            html,
+          };
+        });
+
+        return {
+          ...post,
+          html,
+          attributes,
+        };
+      });
+
+    return posts;
+  };
+
+  private processBody(body: string) {
+    const { body: rawBody, attributes } = fm<FrontMatter>(body);
+    marked.use(
+      markedKatex({
+        throwOnError: false,
+      } as any)
+    );
+    marked.use({
+      renderer: {
+        code(code, lang, escaped) {
+          code = this.options.highlight(code, lang);
+          if (!lang) {
+            return `<pre><code>${code}</code></pre>`;
+          }
+
+          var langClass = "language-" + lang;
+          return `<pre class="${langClass}"><code class="${langClass}">${code}</code></pre>`;
+        },
+      },
+    });
+    const parsed = marked.parse(rawBody, {
+      highlight: (code, lang) => {
+        if (prism.languages[lang]) {
+          return prism.highlight(code, prism.languages[lang], lang);
+        } else {
+          return code;
+        }
+      },
+    });
+    return {
+      html: parsed,
+      attributes,
+    };
+  }
+
+  private async getUser(username: string) {
+    const res = await axios.get(`https://api.github.com/users/${username}`);
+    return res.data;
+  }
+
+  getStaticPaths = async () => {
+    const posts = await this.getPostList();
+    return {
+      paths: posts.map((p) => {
+        // TODO: the fallback path should be issue id
+        return `/${p.attributes.path || ""}`;
+      }),
+      fallback: true,
+    };
+  };
+
+  getHomePageStaticProps = async () => {
+    const posts = (await this.getPostList()).map((post) => {
+      return omit(post, ["body", "html"]);
+    });
+
+    return {
+      props: {
+        // TODO: reduce post body size
+        posts,
+        themeConfig: this.config.themeConfig || {},
+      },
+      revalidate: this.REVALIDATE,
+    };
+  };
+
+  getPostPageStaticProps = async (ctx) => {
+    const posts = await this.getPostList();
+    const post =
+      posts.find(
+        (p) =>
+          p.attributes.path === ctx.params[this.PAGE_PATH_PLACEHOLDER].join("/")
+      ) || null;
+    return {
+      props: {
+        post,
+        themeConfig: this.config?.themeConfig || {},
+      },
+      revalidate: this.REVALIDATE,
+    };
+  };
+
+  private generateFeed = async () => {
+    const feed = new Feed({
+      title: this.config.siteConfig.title,
+      copyright: this.config.siteConfig.title,
+      id: this.config.siteConfig.title,
+      author: {
+        name: this.config.siteConfig.author || this.resolvedConfig.ghUserName,
+      },
+    });
+
+    if (!this.config.siteConfig.url) {
+      return feed.atom1();
+    }
+
+    const posts = await this.getPostList();
+
+    posts.forEach((post) => {
+      feed.addItem({
+        date: new Date(post.updatedAt),
+        link: `${this.config.siteConfig.url}/${post.attributes.path}`,
+        title: post.title,
+        content: post.html,
+      });
+    });
+
+    return feed.atom1();
+  };
+
+  rssHandler = async (req, res) => {
+    res.setHeader("Content-Type", "application/xml");
+    // https://vercel.com/docs/concepts/edge-network/caching#stale-while-revalidate
+    res.setHeader(
+      "Cache-Control",
+      `s-maxage=1 stale-while-revalidate=${10 * 60}`
+    );
+    res.send(await this.generateFeed());
+  };
+
+  DocumentHead = () => (
+    <>
+      {this.config?.theme.Head && (
+        <this.config.theme.Head
+          sairinConfig={this.config}
+        ></this.config.theme.Head>
+      )}
+    </>
+  );
+}
+
+export type HomePageThemeProps = Awaited<
+  ReturnType<Sairin["getHomePageStaticProps"]>
+>["props"];
+export type PostPageThemeProps = Awaited<
+  ReturnType<Sairin["getPostPageStaticProps"]>
+>["props"];

package/src/queries.ts

@@ -0,0 +1,86 @@
+
+export type GetPostQueryVar = {
+  owner: string,
+  repo: string
+}
+export type GetPostQueryProps = {
+  repository: {
+    issues: {
+      nodes: {
+        id: string;
+        title: string;
+        url: string;
+        createdAt: string;
+        updatedAt: string;
+        body: string;
+        comments: {
+          nodes: {
+            url: string,
+            createdAt: string,
+            author: {
+              login: string;
+              url: string;
+              avatarUrl: string;
+            };
+            body: string;
+          }[];
+        };
+        reactionGroups: {
+          content: string;
+          reactors: {
+            totalCount: number;
+          };
+        }[];
+        author: {
+          login: string;
+          url: string;
+          avatarUrl;
+        };
+      }[];
+    };
+  };
+};
+export const GetPostsQuery = (variables: GetPostQueryVar) => ({
+  query: `
+      query GetPosts($owner: String!, $repo: String!) { 
+  repository(owner: $owner, name: $repo) {
+    issues(first: 100, orderBy: {
+      field: CREATED_AT, direction: DESC
+    }, labels: ["published"]) {
+      nodes {
+        id,
+        url,
+        title,
+        updatedAt,
+        createdAt,
+        body,
+        comments (first: 100) {
+          nodes {
+            createdAt,
+            url,
+            author {
+              login,
+              url,
+              avatarUrl,
+            },
+            body
+          }
+        },
+        reactionGroups {
+          content,
+          reactors {
+            totalCount,
+          }
+        },
+        author {
+          login,
+          url,
+          avatarUrl
+        }
+      }
+    }
+  }
+}
+    `,
+  variables,
+});

package/tsconfig.json

@@ -0,0 +1,105 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+    "rootDir": "src",
+    "outDir": "lib",
+
+    /* Projects */
+    // "incremental": true,                              /* Enable incremental compilation */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./",                          /* Specify the folder for .tsbuildinfo incremental compilation files. */
+    // "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": "react-jsx",
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft 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. */
+
+    /* Modules */
+    "module": "commonjs",                                /* Specify what module code is generated. */
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    // "moduleResolution": "node",                       /* 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. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files */
+    // "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. */
+    // "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. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "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. */
+    // "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,               /* Type catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when a 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,                 /* Include 'undefined' in index signature results */
+    // "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. */
+  }
+}