@rdfc/js-runner 1.0.0 → 2.0.0-alpha.2

package/.husky/pre-commit

@@ -0,0 +1,6 @@
+echo Husky format!
+npm run format
+echo Husky Lint!
+npm run lint
+echo Husky Test!
+npm test

package/.prettierrc

@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "semi": false
+}

package/README.md

@@ -1,40 +1,5 @@
-# Js-runner
+# RDFC-2 Javascript runner
 
-[![Build and tests with Node.js](https://github.com/rdf-connect/js-runner/actions/workflows/build-test.yml/badge.svg)](https://github.com/rdf-connect/js-runner/actions/workflows/build-test.yml) [![npm](https://img.shields.io/npm/v/@rdfc/js-runner.svg?style=popout)](https://npmjs.com/package/@rdfc/js-runner)
+Communitcates with the rdfc orchestrator though grpc.
 
-Typescript/Javascript executor for an [RDF-Connect](https://rdf-connect.github.io/rdfc.github.io/) pipeline. Starting from a declarative RDF file describing the pipeline.
-
-## Process definition
-
-Each js process must have `js:file`, `js:function` and `js:mapping` objects.
-
-- `js:file` points to the location of the main javascript file, containing the function.
-- `js:location` points to the starting location for `js:file` relative from the current file.
-- `js:function` points to the function name in the file.
-- `js:mapping` is a `fno:Mapping` object that links properties to function arguments.
-
-When you declare a new js process, it is required to add a SHACL shape.
-Each `sh:property` is accounted for, noting the type `sh:class` or `sh:datatype`.
-
-Example definitions are available in `processor/configs/*.ttl`.
-
-## Pipeline configuration
-
-In a js pipeline you can use all declared js processes, as defined in their SHACL shapes.
-
-An example can be found in `input.ttl`, here a `js:Send` process and a `js:Resc` process are defined.
-`js:Send` takes in a message to send, and a channel to send it to.
-`js:Resc` only takes a channel to read from.
-
-(implementation can be found in `procossor/test.js`)
-
-Note: currently Websockets are configured, but changing the configuration to use the JsReaderChannel and JsWriterChannel will work too, even without a serialization step.
-
-You can execute this pipeline with
-
-```bash
-tsc
-npx bin/js-runner.js input.ttl 
-```
-
-This example input configuration file uses `owl:imports` to specify additional configuration files.
+Take a look at the example pipeline at `./examples/echo/` for example processors and an example pipeline.

package/__tests__/channels.test.ts

@@ -0,0 +1,133 @@
+import { describe, expect, test } from 'vitest'
+import { DataChunk, RunnerClient } from '@rdfc/proto'
+import { ClientReadableStream } from '@grpc/grpc-js'
+import * as grpc from '@grpc/grpc-js'
+import { ReaderInstance } from '../src/reader'
+import { createLogger } from 'winston'
+import winston from 'winston/lib/winston/transports'
+import { ClientReadableStreamImpl } from '@grpc/grpc-js/build/src/call'
+
+const encoder = new TextEncoder()
+class TestClient extends RunnerClient {
+  next: (stream: ClientReadableStream<DataChunk>) => unknown
+
+  constructor() {
+    super('localhost:5400', grpc.credentials.createInsecure())
+  }
+
+  nextStream(): Promise<ClientReadableStream<DataChunk>> {
+    return new Promise((res) => (this.next = res))
+  }
+
+  receiveStreamMessage(): ClientReadableStream<DataChunk> {
+    const stream = new ClientReadableStreamImpl<DataChunk>((data: Buffer) => {
+      console.log('Debug', data)
+      return { data }
+    })
+    this.next(stream)
+    return stream
+  }
+}
+
+async function one<T>(iter: AsyncIterable<T>): Promise<T | undefined> {
+  for await (const item of iter) {
+    return item
+  }
+}
+
+describe('Reader', async () => {
+  const client = new TestClient()
+  const uri = 'someUri'
+  const logger = createLogger({
+    transports: new winston.Console({ level: process.env['DEBUG'] && 'debug' }),
+  })
+
+  test('handles string', async () => {
+    const reader = new ReaderInstance(uri, client, logger)
+
+    const promise = one(reader.strings())
+    reader.handleMsg({ data: encoder.encode('Hello world'), channel: uri })
+    const out = await promise
+
+    expect(out).toEqual('Hello world')
+  })
+
+  test('handles closed string', async () => {
+    const reader = new ReaderInstance(uri, client, logger)
+
+    const promise = one(reader.strings())
+    reader.close()
+    const out = await promise
+
+    expect(out).toEqual(undefined)
+  })
+
+  test('handles strings', async () => {
+    const reader = new ReaderInstance(uri, client, logger)
+
+    const msgsPromise = (async () => {
+      const msgs: string[] = []
+      for await (const msg of reader.strings()) {
+        msgs.push(msg)
+      }
+      return msgs
+    })()
+    reader.handleMsg({ data: encoder.encode('Hello'), channel: uri })
+    reader.handleMsg({ data: encoder.encode('World'), channel: uri })
+    reader.close()
+
+    const msgs = await msgsPromise
+
+    expect(msgs).toEqual(['Hello', 'World'])
+  })
+
+  test('handles buffer', async () => {
+    const reader = new ReaderInstance(uri, client, logger)
+
+    const data = encoder.encode('Hello world')
+    const promise = one(reader.buffers())
+    reader.handleMsg({ data, channel: uri })
+    const out = await promise
+
+    expect(out).toEqual(data)
+  })
+
+  test('handles buffers', async () => {
+    const reader = new ReaderInstance(uri, client, logger)
+
+    const data = encoder.encode('Hello world')
+    const promise = one(reader.buffers())
+    reader.handleMsg({ data, channel: uri })
+    const out = await promise
+
+    expect(out).toEqual(data)
+  })
+
+  test('handles stream', async () => {
+    const reader = new ReaderInstance(uri, client, logger)
+
+    const nextStream = client.nextStream()
+    const promise = one(reader.streams())
+    reader.handleStreamingMessage({ id: { id: 5 }, channel: uri })
+    const stream = await nextStream
+
+    stream.push('Hello')
+    stream.push('World')
+    console.log(stream.eventNames())
+
+    const out = await promise
+    const msgsPromise = (async () => {
+      const msgs: Uint8Array[] = []
+      for await (const msg of out!) {
+        msgs.push(msg)
+      }
+      return msgs
+    })()
+
+    stream.emit('end')
+    stream.emit('close')
+
+    const msgs = await msgsPromise
+    console.log(msgs)
+  })
+})

package/bin/runner.js

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+
+import { start } from '../lib/client.js'
+
+const host = process.argv[2]
+const uri = process.argv[3]
+
+start(host, uri)

package/eslint.config.mjs

@@ -0,0 +1,21 @@
+import globals from 'globals'
+import pluginJs from '@eslint/js'
+import tseslint from 'typescript-eslint'
+
+/** @type {import('eslint').Linter.Config[]} */
+export default [
+  {
+    files: ['src/**/*.{js,mjs,cjs,ts}'],
+  },
+  { languageOptions: { globals: globals.browser } },
+  pluginJs.configs.recommended,
+  ...tseslint.configs.recommended,
+  {
+    ignores: ['src/generated/', '**/lib/', 'coverage/'],
+  },
+  {
+    languageOptions: {
+      globals: { process: 'readable' },
+    },
+  },
+]

package/examples/echo/package-lock.json

@@ -0,0 +1,80 @@
+{
+  "name": "echo",
+  "version": "1.0.0",
+  "lockfileVersion": 3,
+  "requires": true,
+  "packages": {
+    "": {
+      "name": "echo",
+      "version": "1.0.0",
+      "license": "ISC",
+      "dependencies": {
+        "@rdfc/js-runner": "file:../.."
+      },
+      "devDependencies": {
+        "typescript": "^5.8.2"
+      }
+    },
+    "../..": {
+      "name": "@rdfc/js-runner",
+      "version": "1.0.0",
+      "license": "ISC",
+      "dependencies": {
+        "@grpc/grpc-js": "^1.12.6",
+        "@rdfc/proto": "^0.1.1",
+        "@treecg/types": "^0.4.6",
+        "jsonld": "^8.3.3",
+        "jsonld-streaming-parser": "^5.0.0",
+        "n3": "^1.23.1",
+        "rdf-lens": "^1.3.5",
+        "winston": "^3.17.0",
+        "winston-transport": "^4.9.0"
+      },
+      "bin": {
+        "js-runner": "bin/runner.js"
+      },
+      "devDependencies": {
+        "@eslint/js": "^9.21.0",
+        "@rdfjs/types": "^2.0.1",
+        "@types/jest": "^29.5.14",
+        "@types/jsonld": "^1.5.15",
+        "@types/n3": "^1.21.1",
+        "@types/node": "^22.13.5",
+        "@typescript-eslint/eslint-plugin": "^8.25.0",
+        "@typescript-eslint/parser": "^8.25.0",
+        "@vitest/coverage-v8": "^3.0.7",
+        "eslint": "^9.21.0",
+        "eslint-config-prettier": "^10.0.1",
+        "eslint-plugin-prettier": "^5.2.3",
+        "globals": "^16.0.0",
+        "husky": "^9.1.7",
+        "jest": "^29.7.0",
+        "lint-staged": "^15.4.3",
+        "prettier": "^3.5.2",
+        "ts-jest": "^29.2.6",
+        "tsc-alias": "^1.8.10",
+        "typescript": "^5.7.3",
+        "typescript-eslint": "^8.25.0",
+        "vitest": "^3.0.7"
+      }
+    },
+    "node_modules/@rdfc/js-runner": {
+      "resolved": "../..",
+      "link": true
+    },
+    "node_modules/typescript": {
+      "version": "5.8.2",
+      "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.8.2.tgz",
+      "integrity": "sha512-aJn6wq13/afZp/jT9QZmwEjDqqvSGp1VT5GVg+f/t6/oVyrgXM6BY1h9BRh/O5p3PlUPAe+WuiEZOmb/49RqoQ==",
+      "dev": true,
+      "license": "Apache-2.0",
+      "bin": {
+        "tsc": "bin/tsc",
+        "tsserver": "bin/tsserver"
+      },
+      "engines": {
+        "node": ">=14.17"
+      }
+    }
+  }
+}

package/examples/echo/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "echo",
+  "version": "1.0.0",
+  "main": "index.js",
+  "scripts": {
+    "build": "tsc"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "description": "",
+  "dependencies": {
+    "@rdfc/js-runner": "file:../.."
+  },
+  "devDependencies": {
+    "typescript": "^5.8.2"
+  }
+}

package/examples/echo/pipeline.ttl

@@ -0,0 +1,30 @@
+@prefix owl: <http://www.w3.org/2002/07/owl#>.
+@prefix rdfc: <https://w3id.org/rdf-connect/ontology#>.
+
+<> owl:imports <./processors.ttl>.
+<> a rdfc:Pipeline;
+  rdfc:dependency <>;
+  rdfc:processor <sender>, <echo>, <log>, <test>;
+  rdfc:runner rdfc:JsRunner.
+
+<1> a rdfc:Writer, rdfc:Reader.
+<2> a rdfc:Writer, rdfc:Reader.
+<sender> a rdfc:SendProcessor;
+  rdfc:writer <1>;
+  rdfc:msg "hallo", "world".
+
+<echo> a rdfc:EchoProcessor;
+  rdfc:reader <1>;
+  rdfc:writer <2>.
+
+<log> a rdfc:LogProcessor;
+  rdfc:reader <2>.
+
+<test> a rdfc:Test;
+  rdfc:path ( <a> <b> );
+  rdfc:path "help";
+  rdfc:cbd [
+    a rdfc:Something;
+    rdfc:else [ a rdfc:SomethingElse ];
+  ].
+

package/examples/echo/processors.ttl

@@ -0,0 +1,84 @@
+@prefix owl: <http://www.w3.org/2002/07/owl#>.
+@prefix ex: <http://example.org/>.
+@prefix foaf: <http://xmlns.com/foaf/0.1/>.
+@prefix rdfl: <https://w3id.org/rdf-lens/ontology#>.
+@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>.
+@prefix xsd: <http://www.w3.org/2001/XMLSchema#>.
+@prefix sh: <http://www.w3.org/ns/shacl#>.
+@prefix rdfc: <https://w3id.org/rdf-connect/ontology#>.
+
+<> owl:imports <../../index.ttl>.
+
+rdfc:Test a rdfc:JsProcessor;
+  rdfc:entrypoint <./>;
+  rdfc:file <./lib/processors.js>;
+  rdfc:class "TestProcessor".
+
+[ ] a sh:NodeShape;
+  sh:targetClass rdfc:Test;
+  sh:property [
+    sh:path rdfc:path;
+    sh:name "path";
+    sh:class rdfl:Path;
+  ], [
+    sh:path rdfc:cbd;
+    sh:name "cbd";
+    sh:class rdfl:CBD;
+  ].
+
+
+rdfc:EchoProcessor a rdfc:JsProcessor, owl:Class;
+  rdfc:entrypoint <./>;
+  rdfc:file <./lib/processors.js>;
+  rdfc:class "EchoProcessor".
+
+[ ] a sh:NodeShape;
+  sh:targetClass rdfc:EchoProcessor;
+  sh:property [
+    sh:path rdfc:reader;
+    sh:name "reader";
+    sh:minCount 1;
+    sh:maxCount 1;
+    sh:class rdfc:Reader;
+  ], [
+    sh:path rdfc:writer;
+    sh:name "writer";
+    sh:minCount 1;
+    sh:maxCount 1;
+    sh:class rdfc:Writer;
+  ].
+
+rdfc:LogProcessor a rdfc:JsProcessor;
+  rdfc:entrypoint <./>;
+  rdfc:file <./lib/processors.js>;
+  rdfc:class "LogProcessor".
+
+[ ] a sh:NodeShape;
+  sh:targetClass rdfc:LogProcessor;
+  sh:property [
+    sh:path rdfc:reader;
+    sh:name "reader";
+    sh:minCount 1;
+    sh:maxCount 1;
+    sh:class rdfc:Reader;
+  ].
+
+rdfc:SendProcessor a rdfc:JsProcessor;
+  rdfc:entrypoint <./>;
+  rdfc:file <./lib/processors.js>;
+  rdfc:class "SendProcessor".
+
+[ ] a sh:NodeShape;
+  sh:targetClass rdfc:SendProcessor;
+  sh:property [
+    sh:path rdfc:writer;
+    sh:name "writer";
+    sh:minCount 1;
+    sh:maxCount 1;
+    sh:class rdfc:Writer;
+  ], [
+    sh:path rdfc:msg;
+    sh:name "msgs";
+    sh:datatype xsd:string;
+  ].
+

package/examples/echo/src/processors.ts

@@ -0,0 +1,75 @@
+import { Processor, Reader, Writer } from '@rdfc/js-runner'
+
+export class TestProcessor extends Processor<unknown> {
+  async init(this: this): Promise<void> {
+    this.logger.info(JSON.stringify(this.args, undefined, 2))
+  }
+  async transform(this: this): Promise<void> {}
+  async produce(this: this): Promise<void> {}
+}
+
+type EchoArgs = {
+  reader: Reader
+  writer: Writer
+}
+
+export class EchoProcessor extends Processor<EchoArgs> {
+  async init(this: this & EchoArgs): Promise<void> {
+    this.logger.info('Init echo processor')
+  }
+
+  async transform(this: EchoArgs & this): Promise<void> {
+    for await (const msg of this.reader.streams()) {
+      this.logger.info('Echoing message')
+      await this.writer.stream(msg)
+    }
+    await this.writer.close()
+    this.logger.info('closed')
+  }
+
+  async produce(this: this & EchoArgs): Promise<void> {
+    // nothing
+  }
+}
+
+type LogArgs = {
+  reader: Reader
+  writer: Writer
+}
+
+export class LogProcessor extends Processor<LogArgs> {
+  async init(): Promise<void> {
+    this.logger.info('Init log processor')
+  }
+
+  async transform(this: LogArgs & this): Promise<void> {
+    for await (const msg of this.args.reader.strings()) {
+      this.logger.info('Got msg' + msg)
+    }
+  }
+
+  async produce() {}
+}
+
+type SendArgs = {
+  msgs: string[]
+  writer: Writer
+}
+
+export class SendProcessor extends Processor<SendArgs> {
+  async init(): Promise<void> {
+    this.logger.info('Init send processor')
+  }
+
+  async transform(): Promise<void> {}
+  async produce(): Promise<void> {
+    for (const msg of this.get('msgs')) {
+      await this.get('writer').string(msg)
+
+      this.logger.info('Sending ' + msg)
+      await new Promise((res) => setTimeout(res, 1000))
+    }
+    await this.get('writer').close()
+    this.logger.info('Closed')
+  }
+}

package/examples/echo/test.ttl

@@ -0,0 +1,14 @@
+@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>.
+@prefix sh: <http://www.w3.org/ns/shacl#>.
+
+[] a rdf:Seq;
+  rdf:first [].
+
+<AnyJsProcessor> a sh:NodeShape;
+  sh:property [
+    sh:path sh:prop;
+    sh:node [ sh:property [
+      sh:path sh:prop;
+    ] ];
+  ].
+

package/examples/echo/tsconfig.json

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