field-redactor 1.0.0

package/dist/primitiveRedactor.d.ts

@@ -0,0 +1,28 @@
+import { PrimitiveRedactorConfig } from './types';
+/**
+ * Redacts primitive values based on the configuration provided in the constructor. Uses the redactor
+ * privded in the constructor to redact values, or a basic redactor which returns 'REDACTED' if no redactor
+ * provided. Null and undefined values are ignored by default.
+ */
+export declare class PrimitiveRedactor {
+    private static DEFAULT_REDACTED_TEXT;
+    private ignoreBooleans;
+    private ignoreNullOrUndefined;
+    private redactor;
+    /**
+     * Creates a PrimitiveRedactor with the specified configuration.
+     * @param config The PrimitiveRedactor configuration which specifies the redactor to use, whether to
+     * ignore booleans, and whether to ignore null or undefined values.
+     */
+    constructor(config: PrimitiveRedactorConfig);
+    /**
+     * Redacts the primitive value based on the configuration provided in the constructor.
+     * @param value The value to redact.
+     * @returns The redacted value.
+     */
+    redactValue(value: any): Promise<any>;
+    private redactNullOrUndefinedValue;
+    private redactBoolean;
+    private redactAny;
+}
+//# sourceMappingURL=primitiveRedactor.d.ts.map

package/dist/primitiveRedactor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"primitiveRedactor.d.ts","sourceRoot":"","sources":["../src/primitiveRedactor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAY,MAAM,SAAS,CAAC;AAE5D;;;;GAIG;AACH,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,MAAM,CAAC,qBAAqB,CAAc;IAClD,OAAO,CAAC,cAAc,CAAU;IAChC,OAAO,CAAC,qBAAqB,CAAU;IACvC,OAAO,CAAC,QAAQ,CAAoF;IAEpG;;;;OAIG;gBACS,MAAM,EAAE,uBAAuB;IAY3C;;;;OAIG;IACU,WAAW,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;YAUpC,0BAA0B;YAQ1B,aAAa;YAIb,SAAS;CAGxB"}

package/dist/primitiveRedactor.js

@@ -0,0 +1,75 @@
+"use strict";
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PrimitiveRedactor = void 0;
+/**
+ * Redacts primitive values based on the configuration provided in the constructor. Uses the redactor
+ * privded in the constructor to redact values, or a basic redactor which returns 'REDACTED' if no redactor
+ * provided. Null and undefined values are ignored by default.
+ */
+class PrimitiveRedactor {
+    /**
+     * Creates a PrimitiveRedactor with the specified configuration.
+     * @param config The PrimitiveRedactor configuration which specifies the redactor to use, whether to
+     * ignore booleans, and whether to ignore null or undefined values.
+     */
+    constructor(config) {
+        this.redactor = (val) => Promise.resolve(PrimitiveRedactor.DEFAULT_REDACTED_TEXT);
+        if (config.redactor) {
+            this.redactor = config.redactor;
+        }
+        this.ignoreBooleans = !!(config === null || config === void 0 ? void 0 : config.ignoreBooleans);
+        if (typeof (config === null || config === void 0 ? void 0 : config.ignoreNullOrUndefined) === 'boolean') {
+            this.ignoreNullOrUndefined = config.ignoreNullOrUndefined;
+        }
+        else {
+            this.ignoreNullOrUndefined = true;
+        }
+    }
+    /**
+     * Redacts the primitive value based on the configuration provided in the constructor.
+     * @param value The value to redact.
+     * @returns The redacted value.
+     */
+    redactValue(value) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (typeof value === 'boolean') {
+                return this.redactBoolean(value);
+            }
+            else if (!value) {
+                return this.redactNullOrUndefinedValue(value);
+            }
+            return this.redactAny(value);
+        });
+    }
+    redactNullOrUndefinedValue(value) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.ignoreNullOrUndefined) {
+                const result = yield Promise.resolve(value);
+                return result;
+            }
+            return this.ignoreNullOrUndefined ? Promise.resolve(value) : this.redactor(value);
+        });
+    }
+    redactBoolean(value) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.ignoreBooleans ? Promise.resolve(value) : this.redactor(value);
+        });
+    }
+    redactAny(value) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.redactor(value);
+        });
+    }
+}
+exports.PrimitiveRedactor = PrimitiveRedactor;
+PrimitiveRedactor.DEFAULT_REDACTED_TEXT = 'REDACTED';
+//# sourceMappingURL=primitiveRedactor.js.map

package/dist/primitiveRedactor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"primitiveRedactor.js","sourceRoot":"","sources":["../src/primitiveRedactor.ts"],"names":[],"mappings":";;;;;;;;;;;;AAEA;;;;GAIG;AACH,MAAa,iBAAiB;IAM5B;;;;OAIG;IACH,YAAY,MAA+B;QAPnC,aAAQ,GAAa,CAAC,GAAQ,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;QAQlG,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;YACpB,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;QAClC,CAAC;QACD,IAAI,CAAC,cAAc,GAAG,CAAC,CAAC,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,cAAc,CAAA,CAAC;QAC/C,IAAI,OAAO,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,qBAAqB,CAAA,KAAK,SAAS,EAAE,CAAC;YACvD,IAAI,CAAC,qBAAqB,GAAG,MAAM,CAAC,qBAAqB,CAAC;QAC5D,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC;QACpC,CAAC;IACH,CAAC;IAED;;;;OAIG;IACU,WAAW,CAAC,KAAU;;YACjC,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE,CAAC;gBAC/B,OAAO,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YACnC,CAAC;iBAAM,IAAI,CAAC,KAAK,EAAE,CAAC;gBAClB,OAAO,IAAI,CAAC,0BAA0B,CAAC,KAAK,CAAC,CAAC;YAChD,CAAC;YAED,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAC/B,CAAC;KAAA;IAEa,0BAA0B,CAAC,KAAuB;;YAC9D,IAAI,IAAI,CAAC,qBAAqB,EAAE,CAAC;gBAC/B,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;gBAC5C,OAAO,MAAM,CAAC;YAChB,CAAC;YACD,OAAO,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACpF,CAAC;KAAA;IAEa,aAAa,CAAC,KAAc;;YACxC,OAAO,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAC7E,CAAC;KAAA;IAEa,SAAS,CAAC,KAAU;;YAChC,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAC9B,CAAC;KAAA;;AApDH,8CAqDC;AApDgB,uCAAqB,GAAG,UAAU,AAAb,CAAc"}

package/dist/secretManager.d.ts

@@ -0,0 +1,32 @@
+import { SecretManagerConfig } from './types';
+/**
+ * Utility class for managing secrets and determining if a  given value is a secret of any type. If no secrets of
+ * any type are provided in the configuration then all values are considered secrets (but not deep or full secrets).
+ */
+export declare class SecretManager {
+    private secretKeys?;
+    private deepSecretKeys?;
+    private fullSecretKeys?;
+    constructor(config: SecretManagerConfig);
+    /**
+     * Determines if the given key is a secret. If no secrets of any type are provided then this function
+     * always returns true.
+     * @param key The key to check.
+     * @returns True if the key is a secret key or no secret keys exist, otherwise false.
+     */
+    isSecretKey(key: string): boolean;
+    /**
+     * Determines if a key is a deep secret based on the deepSecretKeys configuration provided in the constructor.
+     * @param key The key to check.
+     * @returns True if the key is a deep secret key, otherwise false.
+     */
+    isDeepSecretKey(key: string): boolean;
+    /**
+     * Determines if a key is a full secret based on the fullSecretKeys configuration provided in the constructor.
+     * @param key The key to check.
+     * @returns True if the key is a full secret key, otherwise false.
+     */
+    isFullSecretKey(key: string): boolean;
+    private static valueMatchesAnyRegexValue;
+}
+//# sourceMappingURL=secretManager.d.ts.map

package/dist/secretManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"secretManager.d.ts","sourceRoot":"","sources":["../src/secretManager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAE9C;;;GAGG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,UAAU,CAAC,CAAW;IAC9B,OAAO,CAAC,cAAc,CAAC,CAAW;IAClC,OAAO,CAAC,cAAc,CAAC,CAAW;gBAEtB,MAAM,EAAE,mBAAmB;IAWvC;;;;;OAKG;IACI,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAQxC;;;;OAIG;IACI,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAQ5C;;;;OAIG;IACI,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAQ5C,OAAO,CAAC,MAAM,CAAC,yBAAyB;CAGzC"}

package/dist/secretManager.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SecretManager = void 0;
+/**
+ * Utility class for managing secrets and determining if a  given value is a secret of any type. If no secrets of
+ * any type are provided in the configuration then all values are considered secrets (but not deep or full secrets).
+ */
+class SecretManager {
+    constructor(config) {
+        this.deepSecretKeys = config.deepSecretKeys;
+        this.fullSecretKeys = config.fullSecretKeys;
+        if (!config.secretKeys && (config.deepSecretKeys || config.fullSecretKeys)) {
+            this.secretKeys = [];
+        }
+        else {
+            this.secretKeys = config.secretKeys;
+        }
+    }
+    /**
+     * Determines if the given key is a secret. If no secrets of any type are provided then this function
+     * always returns true.
+     * @param key The key to check.
+     * @returns True if the key is a secret key or no secret keys exist, otherwise false.
+     */
+    isSecretKey(key) {
+        if (!this.secretKeys) {
+            return true;
+        }
+        return SecretManager.valueMatchesAnyRegexValue(key, this.secretKeys);
+    }
+    /**
+     * Determines if a key is a deep secret based on the deepSecretKeys configuration provided in the constructor.
+     * @param key The key to check.
+     * @returns True if the key is a deep secret key, otherwise false.
+     */
+    isDeepSecretKey(key) {
+        if (!this.deepSecretKeys) {
+            return false;
+        }
+        return SecretManager.valueMatchesAnyRegexValue(key, this.deepSecretKeys);
+    }
+    /**
+     * Determines if a key is a full secret based on the fullSecretKeys configuration provided in the constructor.
+     * @param key The key to check.
+     * @returns True if the key is a full secret key, otherwise false.
+     */
+    isFullSecretKey(key) {
+        if (!this.fullSecretKeys) {
+            return false;
+        }
+        return SecretManager.valueMatchesAnyRegexValue(key, this.fullSecretKeys);
+    }
+    static valueMatchesAnyRegexValue(value, regexes) {
+        return regexes.some((regex) => regex.test(value));
+    }
+}
+exports.SecretManager = SecretManager;
+//# sourceMappingURL=secretManager.js.map

package/dist/secretManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"secretManager.js","sourceRoot":"","sources":["../src/secretManager.ts"],"names":[],"mappings":";;;AAEA;;;GAGG;AACH,MAAa,aAAa;IAKxB,YAAY,MAA2B;QACrC,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,CAAC;QAC5C,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,CAAC;QAE5C,IAAI,CAAC,MAAM,CAAC,UAAU,IAAI,CAAC,MAAM,CAAC,cAAc,IAAI,MAAM,CAAC,cAAc,CAAC,EAAE,CAAC;YAC3E,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QACvB,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC;QACtC,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,WAAW,CAAC,GAAW;QAC5B,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACrB,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,aAAa,CAAC,yBAAyB,CAAC,GAAG,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IACvE,CAAC;IAED;;;;OAIG;IACI,eAAe,CAAC,GAAW;QAChC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;YACzB,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,aAAa,CAAC,yBAAyB,CAAC,GAAG,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IAC3E,CAAC;IAED;;;;OAIG;IACI,eAAe,CAAC,GAAW;QAChC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;YACzB,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,aAAa,CAAC,yBAAyB,CAAC,GAAG,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IAC3E,CAAC;IAEO,MAAM,CAAC,yBAAyB,CAAC,KAAa,EAAE,OAAiB;QACvE,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IACpD,CAAC;CACF;AA3DD,sCA2DC"}

package/dist/types.d.ts

@@ -0,0 +1,26 @@
+export type Redactor = (value: any) => Promise<string>;
+export declare enum CustomObjectMatchType {
+    Full = 0,
+    Deep = 1,
+    Shallow = 2,
+    Pass = 3,
+    Ignore = 4
+}
+export type CustomObject = {
+    [key: string]: CustomObjectMatchType | string;
+};
+export type PrimitiveRedactorConfig = {
+    redactor?: Redactor;
+    ignoreBooleans?: boolean;
+    ignoreNullOrUndefined?: boolean;
+};
+export type SecretManagerConfig = {
+    secretKeys?: RegExp[];
+    deepSecretKeys?: RegExp[];
+    fullSecretKeys?: RegExp[];
+};
+export type FieldRedactorConfig = PrimitiveRedactorConfig & SecretManagerConfig & {
+    redactor?: Redactor;
+    customObjects?: CustomObject[];
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,QAAQ,GAAG,CAAC,KAAK,EAAE,GAAG,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;AAEvD,oBAAY,qBAAqB;IAC/B,IAAI,IAAA;IACJ,IAAI,IAAA;IACJ,OAAO,IAAA;IACP,IAAI,IAAA;IACJ,MAAM,IAAA;CACP;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,CAAC,GAAG,EAAE,MAAM,GAAG,qBAAqB,GAAG,MAAM,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,uBAAuB,GACvD,mBAAmB,GAAG;IACpB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,aAAa,CAAC,EAAE,YAAY,EAAE,CAAC;CAChC,CAAC"}

package/dist/types.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomObjectMatchType = void 0;
+var CustomObjectMatchType;
+(function (CustomObjectMatchType) {
+    CustomObjectMatchType[CustomObjectMatchType["Full"] = 0] = "Full";
+    CustomObjectMatchType[CustomObjectMatchType["Deep"] = 1] = "Deep";
+    CustomObjectMatchType[CustomObjectMatchType["Shallow"] = 2] = "Shallow";
+    CustomObjectMatchType[CustomObjectMatchType["Pass"] = 3] = "Pass";
+    CustomObjectMatchType[CustomObjectMatchType["Ignore"] = 4] = "Ignore";
+})(CustomObjectMatchType || (exports.CustomObjectMatchType = CustomObjectMatchType = {}));
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAEA,IAAY,qBAMX;AAND,WAAY,qBAAqB;IAC/B,iEAAI,CAAA;IACJ,iEAAI,CAAA;IACJ,uEAAO,CAAA;IACP,iEAAI,CAAA;IACJ,qEAAM,CAAA;AACR,CAAC,EANW,qBAAqB,qCAArB,qBAAqB,QAMhC"}

package/jest.config.js

@@ -0,0 +1,20 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} **/
+module.exports = {
+  testEnvironment: "node",
+  transform: {
+    "^.+.tsx?$": ["ts-jest",{}],
+  },
+  cacheDirectory: './tmp/jest-cache',
+  coverageDirectory: './tmp/jest-coverage',
+  coveragePathIgnorePatterns: ['./node_modules/', './tests/mocks/'],
+  collectCoverage: true,
+  coverageThreshold: {
+    global: {
+      branches: 90,
+      functions: 90,
+      lines: 90,
+      statements: 90
+    }
+  },
+  verbose: true,
+};

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "field-redactor",
+  "version": "1.0.0",
+  "description": "Utility for redacting PII from complex JSON objects for which simpler redaction tools are insufficient.",
+  "author": {
+    "name": "Andrew Molony",
+    "url": "https://github.com/mologna"
+  },
+  "keywords": [
+    "redaction",
+    "pii",
+    "json",
+    "utility",
+    "redact"
+  ],
+  "homepage": "https://github.com/mologna/field-redactor",
+  "bugs": "https://github.com/mologna/field-redactor/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mologna/field-redactor"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "test": "jest",
+    "test:unit": "yarn test /tests/unit",
+    "test:integration": "yarn test /tests/integration",
+    "build": "tsc"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "rfdc": "^1.4.1"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.12",
+    "@types/node": "^22.10.5",
+    "jest": "^29.7.0",
+    "prettier": "^3.3.3",
+    "ts-jest": "^29.2.4",
+    "ts-node": "^10.9.2",
+    "tsc": "^2.0.4",
+    "typescript": "^5.7.2",
+    "yarn": "^1.22.22"
+  },
+  "prettier": {
+    "tabWidth": 2,
+    "singleQuote": true,
+    "trailingComma": "none",
+    "printWidth": 120
+  }
+}

package/tsconfig.json

@@ -0,0 +1,45 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Language and Environment */
+    "target": "es2015",                                  /* 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. */
+
+    /* Modules */
+    "module": "commonjs",
+    // "moduleResolution": "node",                         
+    "rootDir": "./src",                                  /* Specify the root folder within your source files. */
+
+    /* Emit */
+    "sourceMap": true,                                    /* Create source map files for emitted JavaScript files. */
+    "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "outFile": "index.js",                                  /* 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. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+
+    /* Interop Constraints */
+    "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'. */
+    "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    "allowUnreachableCode": false,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    "skipLibCheck": true,                                 /* Skip type checking all .d.ts files. */
+  },
+  "include": ["src/**/*"],
+  "exclude": ["tests/**/*"]
+}