@productminds/article-events 0.0.1

package/dist/index.d.ts

@@ -0,0 +1,316 @@
+import { Schema } from '@effect/schema';
+export declare const ArticleSchema: Schema.Struct<{
+    id: typeof Schema.UUID;
+    title: typeof Schema.NonEmpty;
+    teaser: typeof Schema.NonEmpty;
+    content: typeof Schema.NonEmpty;
+    publishedAt: typeof Schema.Date;
+    updatedAt: typeof Schema.Date;
+    retrievedAt: typeof Schema.Date;
+    url: typeof Schema.NonEmpty;
+    site: typeof Schema.NonEmpty;
+    tags: Schema.Array$<Schema.Union<[Schema.Struct<{
+        type: Schema.Literal<["category"]>;
+        value: typeof Schema.NonEmpty;
+    }>, Schema.Struct<{
+        type: Schema.Literal<["articleReference"]>;
+        id: typeof Schema.UUID;
+    }>]>>;
+    authors: Schema.Array$<Schema.Struct<{
+        name: typeof Schema.NonEmpty;
+    }>>;
+    meta: Schema.optional<typeof Schema.Unknown>;
+}>;
+export declare const ArticleEventSchema: Schema.Struct<{
+    kind: Schema.Literal<["ARTICLE_EVENT"]>;
+    payload: Schema.Struct<{
+        article: Schema.Struct<{
+            id: typeof Schema.UUID;
+            title: typeof Schema.NonEmpty;
+            teaser: typeof Schema.NonEmpty;
+            content: typeof Schema.NonEmpty;
+            publishedAt: typeof Schema.Date;
+            updatedAt: typeof Schema.Date;
+            retrievedAt: typeof Schema.Date;
+            url: typeof Schema.NonEmpty;
+            site: typeof Schema.NonEmpty;
+            tags: Schema.Array$<Schema.Union<[Schema.Struct<{
+                type: Schema.Literal<["category"]>;
+                value: typeof Schema.NonEmpty;
+            }>, Schema.Struct<{
+                type: Schema.Literal<["articleReference"]>;
+                id: typeof Schema.UUID;
+            }>]>>;
+            authors: Schema.Array$<Schema.Struct<{
+                name: typeof Schema.NonEmpty;
+            }>>;
+            meta: Schema.optional<typeof Schema.Unknown>;
+        }>;
+        status: Schema.Literal<["NEW", "UPDATED"]>;
+        source: Schema.Literal<["INTERNAL", "EXTERNAL"]>;
+    }>;
+}>;
+export declare const decode: (u: unknown, overrideOptions?: import("@effect/schema/AST").ParseOptions) => import("effect/Either").Either<{
+    readonly kind: "ARTICLE_EVENT";
+    readonly payload: {
+        readonly article: {
+            readonly id: string;
+            readonly title: string;
+            readonly teaser: string;
+            readonly content: string;
+            readonly publishedAt: Date;
+            readonly updatedAt: Date;
+            readonly retrievedAt: Date;
+            readonly url: string;
+            readonly site: string;
+            readonly tags: readonly ({
+                readonly type: "category";
+                readonly value: string;
+            } | {
+                readonly type: "articleReference";
+                readonly id: string;
+            })[];
+            readonly authors: readonly {
+                readonly name: string;
+            }[];
+            readonly meta?: unknown;
+        };
+        readonly status: "NEW" | "UPDATED";
+        readonly source: "INTERNAL" | "EXTERNAL";
+    };
+}, import("@effect/schema/ParseResult").ParseError>;
+export declare const decodeExn: (u: unknown) => {
+    readonly kind: "ARTICLE_EVENT";
+    readonly payload: {
+        readonly article: {
+            readonly id: string;
+            readonly title: string;
+            readonly teaser: string;
+            readonly content: string;
+            readonly publishedAt: Date;
+            readonly updatedAt: Date;
+            readonly retrievedAt: Date;
+            readonly url: string;
+            readonly site: string;
+            readonly tags: readonly ({
+                readonly type: "category";
+                readonly value: string;
+            } | {
+                readonly type: "articleReference";
+                readonly id: string;
+            })[];
+            readonly authors: readonly {
+                readonly name: string;
+            }[];
+            readonly meta?: unknown;
+        };
+        readonly status: "NEW" | "UPDATED";
+        readonly source: "INTERNAL" | "EXTERNAL";
+    };
+};
+export declare const encode: (a: {
+    readonly kind: "ARTICLE_EVENT";
+    readonly payload: {
+        readonly article: {
+            readonly id: string;
+            readonly title: string;
+            readonly teaser: string;
+            readonly content: string;
+            readonly publishedAt: Date;
+            readonly updatedAt: Date;
+            readonly retrievedAt: Date;
+            readonly url: string;
+            readonly site: string;
+            readonly tags: readonly ({
+                readonly type: "category";
+                readonly value: string;
+            } | {
+                readonly type: "articleReference";
+                readonly id: string;
+            })[];
+            readonly authors: readonly {
+                readonly name: string;
+            }[];
+            readonly meta?: unknown;
+        };
+        readonly status: "NEW" | "UPDATED";
+        readonly source: "INTERNAL" | "EXTERNAL";
+    };
+}, overrideOptions?: import("@effect/schema/AST").ParseOptions) => import("effect/Either").Either<{
+    readonly kind: "ARTICLE_EVENT";
+    readonly payload: {
+        readonly article: {
+            readonly id: string;
+            readonly title: string;
+            readonly teaser: string;
+            readonly content: string;
+            readonly publishedAt: string;
+            readonly updatedAt: string;
+            readonly retrievedAt: string;
+            readonly url: string;
+            readonly site: string;
+            readonly tags: readonly ({
+                readonly type: "category";
+                readonly value: string;
+            } | {
+                readonly type: "articleReference";
+                readonly id: string;
+            })[];
+            readonly authors: readonly {
+                readonly name: string;
+            }[];
+            readonly meta?: unknown;
+        };
+        readonly status: "NEW" | "UPDATED";
+        readonly source: "INTERNAL" | "EXTERNAL";
+    };
+}, import("@effect/schema/ParseResult").ParseError>;
+export declare const encodeExn: (event: typeof ArticleEventSchema.Type) => {
+    readonly kind: "ARTICLE_EVENT";
+    readonly payload: {
+        readonly article: {
+            readonly id: string;
+            readonly title: string;
+            readonly teaser: string;
+            readonly content: string;
+            readonly publishedAt: string;
+            readonly updatedAt: string;
+            readonly retrievedAt: string;
+            readonly url: string;
+            readonly site: string;
+            readonly tags: readonly ({
+                readonly type: "category";
+                readonly value: string;
+            } | {
+                readonly type: "articleReference";
+                readonly id: string;
+            })[];
+            readonly authors: readonly {
+                readonly name: string;
+            }[];
+            readonly meta?: unknown;
+        };
+        readonly status: "NEW" | "UPDATED";
+        readonly source: "INTERNAL" | "EXTERNAL";
+    };
+};
+export declare const fromString: (msg: string) => import("effect/Either").Either<{
+    readonly kind: "ARTICLE_EVENT";
+    readonly payload: {
+        readonly article: {
+            readonly id: string;
+            readonly title: string;
+            readonly teaser: string;
+            readonly content: string;
+            readonly publishedAt: Date;
+            readonly updatedAt: Date;
+            readonly retrievedAt: Date;
+            readonly url: string;
+            readonly site: string;
+            readonly tags: readonly ({
+                readonly type: "category";
+                readonly value: string;
+            } | {
+                readonly type: "articleReference";
+                readonly id: string;
+            })[];
+            readonly authors: readonly {
+                readonly name: string;
+            }[];
+            readonly meta?: unknown;
+        };
+        readonly status: "NEW" | "UPDATED";
+        readonly source: "INTERNAL" | "EXTERNAL";
+    };
+}, import("@effect/schema/ParseResult").ParseError>;
+export declare const fromBuffer: (msg: Buffer) => import("effect/Either").Either<{
+    readonly kind: "ARTICLE_EVENT";
+    readonly payload: {
+        readonly article: {
+            readonly id: string;
+            readonly title: string;
+            readonly teaser: string;
+            readonly content: string;
+            readonly publishedAt: Date;
+            readonly updatedAt: Date;
+            readonly retrievedAt: Date;
+            readonly url: string;
+            readonly site: string;
+            readonly tags: readonly ({
+                readonly type: "category";
+                readonly value: string;
+            } | {
+                readonly type: "articleReference";
+                readonly id: string;
+            })[];
+            readonly authors: readonly {
+                readonly name: string;
+            }[];
+            readonly meta?: unknown;
+        };
+        readonly status: "NEW" | "UPDATED";
+        readonly source: "INTERNAL" | "EXTERNAL";
+    };
+}, import("@effect/schema/ParseResult").ParseError>;
+export declare const fromStringExn: (msg: string) => {
+    readonly kind: "ARTICLE_EVENT";
+    readonly payload: {
+        readonly article: {
+            readonly id: string;
+            readonly title: string;
+            readonly teaser: string;
+            readonly content: string;
+            readonly publishedAt: Date;
+            readonly updatedAt: Date;
+            readonly retrievedAt: Date;
+            readonly url: string;
+            readonly site: string;
+            readonly tags: readonly ({
+                readonly type: "category";
+                readonly value: string;
+            } | {
+                readonly type: "articleReference";
+                readonly id: string;
+            })[];
+            readonly authors: readonly {
+                readonly name: string;
+            }[];
+            readonly meta?: unknown;
+        };
+        readonly status: "NEW" | "UPDATED";
+        readonly source: "INTERNAL" | "EXTERNAL";
+    };
+};
+export declare const fromBufferExn: (msg: Buffer) => {
+    readonly kind: "ARTICLE_EVENT";
+    readonly payload: {
+        readonly article: {
+            readonly id: string;
+            readonly title: string;
+            readonly teaser: string;
+            readonly content: string;
+            readonly publishedAt: Date;
+            readonly updatedAt: Date;
+            readonly retrievedAt: Date;
+            readonly url: string;
+            readonly site: string;
+            readonly tags: readonly ({
+                readonly type: "category";
+                readonly value: string;
+            } | {
+                readonly type: "articleReference";
+                readonly id: string;
+            })[];
+            readonly authors: readonly {
+                readonly name: string;
+            }[];
+            readonly meta?: unknown;
+        };
+        readonly status: "NEW" | "UPDATED";
+        readonly source: "INTERNAL" | "EXTERNAL";
+    };
+};
+export declare const toString: (event: typeof ArticleEventSchema.Type) => string;
+export declare const toBuffer: (event: typeof ArticleEventSchema.Type) => Buffer;
+export declare const toStringExn: (event: typeof ArticleEventSchema.Type) => string;
+export declare const toBufferExn: (event: typeof ArticleEventSchema.Type) => Buffer;

package/dist/index.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toBufferExn = exports.toStringExn = exports.toBuffer = exports.toString = exports.fromBufferExn = exports.fromStringExn = exports.fromBuffer = exports.fromString = exports.encodeExn = exports.encode = exports.decodeExn = exports.decode = exports.ArticleEventSchema = exports.ArticleSchema = void 0;
+const schema_1 = require("@effect/schema");
+const DateTimeSchema = schema_1.Schema.Date.annotations({
+    jsonSchema: { format: 'date-time' }
+});
+const CategoryTagSchema = schema_1.Schema.Struct({
+    type: schema_1.Schema.Literal('category'),
+    value: schema_1.Schema.NonEmpty
+});
+const ArticleReferenceSchema = schema_1.Schema.Struct({
+    type: schema_1.Schema.Literal('articleReference'),
+    id: schema_1.Schema.UUID
+});
+const TagSchema = schema_1.Schema.Union(CategoryTagSchema, ArticleReferenceSchema);
+const AuthorSchema = schema_1.Schema.Struct({
+    name: schema_1.Schema.NonEmpty
+});
+exports.ArticleSchema = schema_1.Schema.Struct({
+    id: schema_1.Schema.UUID,
+    title: schema_1.Schema.NonEmpty,
+    teaser: schema_1.Schema.NonEmpty,
+    content: schema_1.Schema.NonEmpty,
+    publishedAt: DateTimeSchema,
+    updatedAt: DateTimeSchema,
+    retrievedAt: DateTimeSchema,
+    url: schema_1.Schema.NonEmpty,
+    site: schema_1.Schema.NonEmpty,
+    tags: schema_1.Schema.Array(TagSchema),
+    authors: schema_1.Schema.Array(AuthorSchema),
+    meta: schema_1.Schema.optional(schema_1.Schema.Unknown)
+});
+exports.ArticleEventSchema = schema_1.Schema.Struct({
+    kind: schema_1.Schema.Literal('ARTICLE_EVENT'),
+    payload: schema_1.Schema.Struct({
+        article: exports.ArticleSchema,
+        status: schema_1.Schema.Literal('NEW', 'UPDATED'),
+        source: schema_1.Schema.Literal('INTERNAL', 'EXTERNAL')
+    })
+});
+exports.decode = schema_1.Schema.decodeUnknownEither(exports.ArticleEventSchema);
+const decodeExn = (u) => {
+    const decoded = (0, exports.decode)(u);
+    if (decoded._tag === 'Left') {
+        throw new Error('Failed to decode ArticleEvent');
+    }
+    return decoded.right;
+};
+exports.decodeExn = decodeExn;
+exports.encode = schema_1.Schema.encodeEither(exports.ArticleEventSchema);
+const encodeExn = (event) => {
+    const encoded = (0, exports.encode)(event);
+    if (encoded._tag === 'Left') {
+        throw new Error('Failed to encode ArticleEvent');
+    }
+    return encoded.right;
+};
+exports.encodeExn = encodeExn;
+const fromString = (msg) => (0, exports.decode)(JSON.parse(msg));
+exports.fromString = fromString;
+const fromBuffer = (msg) => (0, exports.decode)(JSON.parse(msg.toString()));
+exports.fromBuffer = fromBuffer;
+const fromStringExn = (msg) => (0, exports.decodeExn)(JSON.parse(msg));
+exports.fromStringExn = fromStringExn;
+const fromBufferExn = (msg) => (0, exports.fromStringExn)(msg.toString());
+exports.fromBufferExn = fromBufferExn;
+const toString = (event) => JSON.stringify((0, exports.encode)(event));
+exports.toString = toString;
+const toBuffer = (event) => Buffer.from((0, exports.toString)(event));
+exports.toBuffer = toBuffer;
+const toStringExn = (event) => JSON.stringify((0, exports.encodeExn)(event));
+exports.toStringExn = toStringExn;
+const toBufferExn = (event) => Buffer.from((0, exports.toStringExn)(event));
+exports.toBufferExn = toBufferExn;

package/index.ts

@@ -0,0 +1,84 @@
+import { Schema } from '@effect/schema';
+
+const DateTimeSchema = Schema.Date.annotations({
+  jsonSchema: { format: 'date-time' }
+});
+
+const CategoryTagSchema = Schema.Struct({
+  type: Schema.Literal('category'),
+  value: Schema.NonEmpty
+});
+
+const ArticleReferenceSchema = Schema.Struct({
+  type: Schema.Literal('articleReference'),
+  id: Schema.UUID
+});
+
+const TagSchema = Schema.Union(CategoryTagSchema, ArticleReferenceSchema);
+
+const AuthorSchema = Schema.Struct({
+  name: Schema.NonEmpty
+});
+
+export const ArticleSchema = Schema.Struct({
+  id: Schema.UUID,
+  title: Schema.NonEmpty,
+  teaser: Schema.NonEmpty,
+  content: Schema.NonEmpty,
+  publishedAt: DateTimeSchema,
+  updatedAt: DateTimeSchema,
+  retrievedAt: DateTimeSchema,
+  url: Schema.NonEmpty,
+  site: Schema.NonEmpty,
+  tags: Schema.Array(TagSchema),
+  authors: Schema.Array(AuthorSchema),
+  meta: Schema.optional(Schema.Unknown)
+});
+
+export const ArticleEventSchema = Schema.Struct({
+  kind: Schema.Literal('ARTICLE_EVENT'),
+  payload: Schema.Struct({
+    article: ArticleSchema,
+    status: Schema.Literal('NEW', 'UPDATED'),
+    source: Schema.Literal('INTERNAL', 'EXTERNAL')
+  })
+});
+
+export const decode = Schema.decodeUnknownEither(ArticleEventSchema);
+export const decodeExn = (u: unknown) => {
+  const decoded = decode(u);
+
+  if (decoded._tag === 'Left') {
+    throw new Error('Failed to decode ArticleEvent');
+  }
+
+  return decoded.right;
+};
+
+export const encode = Schema.encodeEither(ArticleEventSchema);
+export const encodeExn = (event: typeof ArticleEventSchema.Type) => {
+  const encoded = encode(event);
+
+  if (encoded._tag === 'Left') {
+    throw new Error('Failed to encode ArticleEvent');
+  }
+
+  return encoded.right;
+};
+
+export const fromString = (msg: string) => decode(JSON.parse(msg));
+export const fromBuffer = (msg: Buffer) => decode(JSON.parse(msg.toString()));
+
+export const fromStringExn = (msg: string) => decodeExn(JSON.parse(msg));
+export const fromBufferExn = (msg: Buffer) => fromStringExn(msg.toString());
+
+export const toString = (event: typeof ArticleEventSchema.Type) =>
+  JSON.stringify(encode(event));
+
+export const toBuffer = (event: typeof ArticleEventSchema.Type) =>
+  Buffer.from(toString(event));
+
+export const toStringExn = (event: typeof ArticleEventSchema.Type) =>
+  JSON.stringify(encodeExn(event));
+export const toBufferExn = (event: typeof ArticleEventSchema.Type) =>
+  Buffer.from(toStringExn(event));

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "@productminds/article-events",
+  "version": "0.0.1",
+  "description": "",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "build:watch": "tsc --watch",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "mbirkegaard",
+  "license": "ISC",
+  "devDependencies": {
+    "@types/node": "^20.14.11",
+    "typescript": "^5.5.3"
+  },
+  "dependencies": {
+    "@effect/schema": "^0.68.26"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,100 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+    /* Language and Environment */
+    "target": "es2016", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+    /* Modules */
+    "module": "commonjs", /* Specify what module code is generated. */
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    // "moduleResolution": "node10",                     /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
+    // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */
+    // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */
+    // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+    /* Emit */
+    "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+    "outDir": "./dist", /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
+    // "isolatedDeclarations": true,                     /* Require sufficient annotation on exports so other tools can trivially generate declaration files. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
+    /* Type Checking */
+    "strict": true, /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true /* Skip type checking all .d.ts files. */
+  }
+}