cacophony 0.1.0 → 0.1.1

package/README.md

@@ -0,0 +1,102 @@
+Cacophony is a highly robust and versatile audio library for Typescript leveraging the WebAudio API, crafted to simplify audio management in complex applications. The core concept of Cacophony revolves around the creation and manipulation of three key elements: `Sound`, `Playback`, and `Group`.
+
+- A `Sound` represents a distinct audio source, derived from an `AudioBuffer` or a URL string pointing to an audio file.
+- A `Playback` refers to the act of playing a `Sound` and carries additional properties such as its position in a 3D audio scene, gain-node for volume control, and more.
+- A `Group` encapsulates multiple `Sound` instances to handle them as one entity, permitting the grouped sounds to be played, paused, or stopped synchronously.
+
+## Features
+
+- Multiple Audio Sources: Handle buffers, URLs, groups of sounds, and playbacks seamlessly.
+- Comprehensive Audio Control: Play, stop, pause, resume, infinite or finite loops, and volume adjustments.
+- 3D Audio Positioning: Precise control on 3D spatial positioning of the audio source.
+- Audio Filtering: Elevate audio output with filters - adding, removing, or applying directly to an audio source.
+- Volume Control: Mute, unmute, and volume adjustments on a global scale.
+
+## Quick Installation
+
+Cacophony is provided as a regular NPM module. Install it using:
+
+```bash
+$ npm install cacophony-ts
+```
+
+## Straightforward Usage
+
+Utilizing Cacophony in the codebase is effortless, demonstrated below:
+
+```typescript
+import { Cacophony } from 'cacophony-ts';
+
+async function playSampleSound() {
+  const cacophony = new Cacophony();
+  const sound = await cacophony.createSound('path/to/your/audio/file.mp3');
+
+  sound.play();
+  sound.moveTo(1, 1, 1); // Position the sound in 3D space
+}
+
+playSampleSound();
+```
+
+## Comprehensive Documentation
+
+### Main Class: `Cacophony`
+
+The centerpiece of the library delivers methods for creating sounds, managing global volumes, and more.
+
+#### Method: `async createSound(bufferOrUrl: AudioBuffer | string): Promise<Sound>`
+
+Crafts a `Sound` instance using either an `AudioBuffer` or a URL string leading to the desired audio file.
+
+#### Method: `async createGroup(sounds: Sound[]): Promise<Group>`
+
+Fabricates a `Group` entity from an array of `Sound` instances.
+
+#### Method: `async createGroupFromUrls(urls: string[]): Promise<Group>`
+
+Forms a `Group` instance from an array of URLs directing to the desired audio files.
+
+#### Method: `createBiquadFilter(type: BiquadFilterType): BiquadFilterNode`
+
+Generates a `BiquadFilterNode` ready to be applied to sounds.
+
+#### Method: `pause()`
+
+Halts all active audio.
+
+#### Method: `resume()`
+
+Resumes all paused audio.
+
+#### Method: `stopAll()`
+
+Complete cessation of all audio, irrespective of their current states.
+
+#### Method: `setGlobalVolume(volume: number)`
+
+Adjusts the global volume to the passed value.
+
+#### Method: `mute()`
+
+Silences all audio by setting the global volume to 0.
+
+#### Method: `unmute()`
+
+Resumes audio by restoring the global volume to its preceding value.
+
+### Shared Methods Across Sound Sources
+
+All classes representing sound sources (`Sound`, `Playback`, `Group`) offer the following methods for a consistent interface and user-friendly experience:
+
+- `play()`
+- `stop()`
+- `pause()`
+- `resume()`
+- `addFilter(filter: BiquadFilterNode)`
+- `removeFilter(filter: BiquadFilterNode)`
+- `moveTo(x: number, y: number, z: number)`
+- `loop(loopCount?: LoopCount)`: `LoopCount` can be a finite number or 'infinite'.
+
+## License
+
+Cacophony is freely available for incorporation into your projects under the [MIT License](LICENSE.txt).

package/dist/index.js

@@ -0,0 +1,18 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./cacophony"), exports);
+//# sourceMappingURL=index.js.map

package/package.json

@@ -1,7 +1,25 @@
 {
   "name": "cacophony",
-  "version": "0.1.0",
-  "main": "index.js",
-  "author": "Wang Zuo <wangzuo@swiftcarrot.com> (https://swiftcarrot.com)",
-  "license": "MIT"
-}
+  "version": "0.1.1",
+  "description": "Typescript audio library with caching",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "npm run clean && tsc --build",
+    "clean": "tsc --build --clean",
+    "prepublishOnly": "npm run build",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "audio",
+    "webaudio"
+  ],
+  "author": "Christopher Toth",
+  "license": "ISC",
+  "devDependencies": {
+    "typescript": "^5.1.6"
+  },
+  "dependencies": {
+    "standardized-audio-context": "^25.3.55"
+  }
+}

package/src/cache.ts

@@ -0,0 +1,63 @@
+import { IAudioContext } from "standardized-audio-context";
+
+export class CacheManager {
+    private static pendingRequests = new Map<string, Promise<AudioBuffer>>();
+
+    private static async openCache(): Promise<Cache> {
+        try {
+            return await caches.open('audio-cache');
+        } catch (error) {
+            console.error('Failed to open cache:', error);
+            throw error;
+        }
+    }
+
+    private static async getAudioBufferFromCache(url: string, cache: Cache, context: IAudioContext): Promise<AudioBuffer | null> {
+        try {
+            const response = await cache.match(url);
+            if (response) {
+                const arrayBuffer = await response.arrayBuffer();
+                return context.decodeAudioData(arrayBuffer);
+            }
+            return null;
+        } catch (error) {
+            console.error('Failed to get audio data from cache:', error);
+            throw error;
+        }
+    }
+
+    private static async fetchAndCacheAudioBuffer(url: string, cache: Cache, context: IAudioContext): Promise<AudioBuffer> {
+        try {
+            const fetchResponse = await fetch(url);
+            const responseClone = fetchResponse.clone();
+            cache.put(url, responseClone);
+            const arrayBuffer = await fetchResponse.arrayBuffer();
+            return context.decodeAudioData(arrayBuffer);
+        } catch (error) {
+            console.error('Failed to fetch and cache audio data:', error);
+            throw error;
+        }
+    }
+
+    public static async getAudioBuffer(url: string, context: IAudioContext): Promise<AudioBuffer> {
+        const cache = await this.openCache();
+
+        // First, check if there's a pending request.
+        let pendingRequest = this.pendingRequests.get(url);
+        if (pendingRequest) {
+            return pendingRequest;
+        }
+
+        // Try getting the buffer from cache.
+        const bufferFromCache = await this.getAudioBufferFromCache(url, cache, context);
+        if (bufferFromCache) {
+            return bufferFromCache;
+        }
+
+        // If it's not in the cache, fetch and cache it.
+        pendingRequest = this.fetchAndCacheAudioBuffer(url, cache, context);
+        this.pendingRequests.set(url, pendingRequest);
+
+        return pendingRequest;
+    }
+}

package/src/cacophony.ts

@@ -0,0 +1,396 @@
+import { AudioContext, IAudioBuffer, IAudioBufferSourceNode, IAudioListener, IBiquadFilterNode, IGainNode, IPannerNode } from 'standardized-audio-context';
+import { CacheManager } from './cache';
+
+
+type GainNode = IGainNode<AudioContext>;
+type BiquadFilterNode = IBiquadFilterNode<AudioContext>;
+
+type AudioBufferSourceNode = IAudioBufferSourceNode<AudioContext>;
+type PannerNode = IPannerNode<AudioContext>;
+
+type LoopCount = number | 'infinite';
+
+export type FadeType = 'linear' | 'exponential'
+
+export interface BaseSound {
+    // the stuff you should be able to do with anything that makes sound including groups, sounds, and playbacks.
+    play(): Playback[];
+    stop(): void;
+    pause(): void;
+    resume(): void;
+    addFilter(filter: BiquadFilterNode): void;
+    removeFilter(filter: BiquadFilterNode): void;
+    moveTo(x: number, y: number, z: number): void;
+    loop(loopCount?: LoopCount): LoopCount;
+}
+
+export class Cacophony {
+    context: AudioContext;
+    globalGainNode: GainNode;
+    listener: IAudioListener;
+    private prevVolume: number = 1;
+
+    constructor(context?: AudioContext) {
+        this.context = context || new AudioContext();
+        this.listener = this.context.listener;
+        this.globalGainNode = this.context.createGain();
+        this.globalGainNode.connect(this.context.destination);
+    }
+
+    async createSound(buffer: AudioBuffer): Promise<Sound>
+
+    async createSound(url: string): Promise<Sound>
+
+    async createSound(bufferOrUrl: AudioBuffer | string): Promise<Sound> {
+        if (bufferOrUrl instanceof AudioBuffer) {
+            return Promise.resolve(new Sound(bufferOrUrl, this.context, this.globalGainNode));
+        }
+        const url = bufferOrUrl;
+        return CacheManager.getAudioBuffer(url, this.context).then(buffer => new Sound(buffer, this.context, this.globalGainNode));
+    }
+
+    async createGroup(sounds: Sound[]): Promise<Group> {
+        const group = new Group();
+        sounds.forEach(sound => group.addSound(sound));
+        return group;
+    }
+
+    async createGroupFromUrls(urls: string[]): Promise<Group> {
+        const group = new Group();
+        const sounds = await Promise.all(urls.map(url => this.createSound(url)));
+        sounds.forEach(sound => group.addSound(sound));
+        return group;
+    }
+
+    createBiquadFilter(type: BiquadFilterType): BiquadFilterNode {
+        const filter = this.context.createBiquadFilter();
+        filter.type = type;
+        return filter;
+    }
+
+
+    pause() {
+        if ('suspend' in this.context) {
+            this.context.suspend();
+        }
+    }
+
+    resume() {
+        if ('resume' in this.context) {
+            this.context.resume();
+        }
+    }
+
+    stopAll() {
+        if ('close' in this.context) {
+            this.context.close();
+        }
+    }
+
+    setGlobalVolume(volume: number) {
+        this.globalGainNode.gain.value = volume;
+    }
+
+    mute() {
+        this.prevVolume = this.globalGainNode.gain.value;
+        this.setGlobalVolume(0);
+    }
+
+    unmute() {
+        this.setGlobalVolume(this.prevVolume);
+    }
+
+}
+
+
+class FilterManager {
+    protected filters: BiquadFilterNode[] = [];
+
+    addFilter(filter: BiquadFilterNode): void {
+        this.filters.push(filter);
+    }
+
+    removeFilter(filter: BiquadFilterNode): void {
+        this.filters = this.filters.filter(f => f !== filter);
+    }
+
+    applyFilters(connection: any): any {
+        this.filters.reduce((prevConnection, filter) => {
+            prevConnection.connect(filter);
+            return filter;
+        }, connection);
+        return this.filters.length > 0 ? this.filters[this.filters.length - 1] : connection;
+    }
+}
+
+
+export class Sound extends FilterManager implements BaseSound {
+    buffer: IAudioBuffer;
+    context: AudioContext;
+    playbacks: Playback[] = [];
+    globalGainNode: GainNode;
+    position: number[] = [0, 0, 0];
+    loopCount: LoopCount = 0;
+
+    constructor(buffer: AudioBuffer, context: AudioContext, globalGainNode: IGainNode<AudioContext>) {
+        super();
+        this.buffer = buffer;
+        this.context = context;
+        this.globalGainNode = globalGainNode;
+    }
+
+    preplay(): Playback[] {
+        const source = this.context.createBufferSource();
+        source.buffer = this.buffer;
+        const gainNode = this.context.createGain();
+        source.connect(gainNode);
+        gainNode.connect(this.globalGainNode);
+        const playback = new Playback(source, gainNode, this.context, this.loopCount);
+        this.filters.forEach(filter => playback.addFilter(filter));
+        playback.moveTo(this.position[0], this.position[1], this.position[2]);
+        this.playbacks.push(playback);
+        return [playback];
+    }
+
+    play(): Playback[] {
+        const playback = this.preplay();
+        playback.forEach(p => p.source.start());
+        return playback;
+    }
+
+    stop(): void {
+        this.playbacks.forEach(p => p.stop());
+    }
+
+    pause(): void {
+        if ('suspend' in this.context) {
+            this.context.suspend();
+        }
+    }
+
+    resume(): void {
+        if ('resume' in this.context) {
+            this.context.resume();
+        }
+    }
+
+    moveTo(x: number, y: number, z: number): void {
+        this.position = [x, y, z];
+        this.playbacks.forEach(p => p.moveTo(x, y, z));
+    }
+
+    loop(loopCount?: LoopCount): LoopCount {
+        if (loopCount === undefined) {
+            return this.loopCount;
+        }
+        this.loopCount = loopCount;
+        this.playbacks.forEach(p => p.source.loop = true);
+        return this.loopCount;
+    }
+
+    addFilter(filter: BiquadFilterNode): void {
+        super.addFilter(filter);
+        this.playbacks.forEach(p => p.addFilter(filter));
+    }
+
+    removeFilter(filter: BiquadFilterNode): void {
+        super.removeFilter(filter);
+        this.playbacks.forEach(p => p.removeFilter(filter));
+    }
+}
+
+
+class Playback extends FilterManager implements BaseSound {
+    context: AudioContext;
+    source: AudioBufferSourceNode;
+    gainNode: GainNode;
+    panner: PannerNode;
+    loopCount: LoopCount = 0;
+    currentLoop: number = 0;
+    buffer: IAudioBuffer | null = null;
+
+    constructor(source: AudioBufferSourceNode, gainNode: GainNode, context: AudioContext, loopCount: LoopCount = 0) {
+        super();
+        this.loopCount = loopCount;
+        this.source = source;
+        this.buffer = source.buffer;
+        this.source.onended = this.handleLoop.bind(this);
+        this.gainNode = gainNode;
+        this.context = context;
+        this.panner = context.createPanner();
+        source.connect(this.panner).connect(this.gainNode);
+        this.refreshFilters();
+        source.start();
+    }
+
+
+    handleLoop(): void {
+        if (this.loopCount === 'infinite' || this.currentLoop < this.loopCount) {
+            this.currentLoop++;
+            this.source = this.context.createBufferSource();
+            this.source.buffer = this.buffer;
+            this.play();
+        }
+    }
+
+    play() {
+        this.source.start();
+        return [this];
+    }
+
+    set volume(v: number) {
+        this.gainNode.gain.value = v;
+    }
+
+    fadeIn(time: number, FfadeType: FadeType = 'linear'): Promise<void> {
+        return new Promise(resolve => {
+            // Setting the initial gain value to 0
+            this.gainNode.gain.setValueAtTime(0, this.context.currentTime);
+            switch (FfadeType) {
+                case 'exponential':
+                    // Scheduling an exponential fade up
+                    this.gainNode.gain.exponentialRampToValueAtTime(1, this.context.currentTime + time);
+                    break;
+                case 'linear':
+                    // Scheduling a linear ramp to the target gain value over the given duration
+                    this.gainNode.gain.linearRampToValueAtTime(1, this.context.currentTime + time);
+            }
+            // Resolving the Promise after the fade-in time
+            setTimeout(() => resolve(), time * 1000);
+        });
+    }
+
+    fadeOut(time: number, fadeType: FadeType = 'linear'): Promise<void> {
+        return new Promise(resolve => {
+            // Storing the current gain value
+            const initialVolume = this.gainNode.gain.value;
+            switch (fadeType) {
+                case 'exponential':
+                    // Scheduling an exponential fade down
+                    this.gainNode.gain.exponentialRampToValueAtTime(0.01, this.context.currentTime + time);
+                    break;
+                case 'linear':
+
+                    // Scheduling a linear ramp to 0 over the given duration
+                    this.gainNode.gain.linearRampToValueAtTime(0, this.context.currentTime + time);
+            }
+            // Resolving the Promise after the fade-out time
+            setTimeout(() => resolve(), time * 1000);
+        });
+    }
+
+    loop(loopCount?: LoopCount): LoopCount {
+        if (loopCount === undefined) {
+            return this.source.loop === true ? 'infinite' : 0;
+        }
+        this.source.loop = true;
+        this.source.loopEnd = this.source.buffer?.duration || 0;
+        this.source.loopStart = 0;
+        return this.source.loop === true ? 'infinite' : 0;
+    }
+
+    stop(): void {
+        this.source.stop();
+    }
+
+    pause(): void {
+        if ('suspend' in this.source.context) {
+            this.source.context.suspend();
+        }
+
+    }
+    resume(): void {
+        if ('resume' in this.source.context) {
+            this.source.context.resume();
+        }
+    }
+
+    addFilter(filter: BiquadFilterNode): void {
+        super.addFilter(filter);
+        this.refreshFilters();
+    }
+
+    removeFilter(filter: BiquadFilterNode): void {
+        super.removeFilter(filter);
+        this.refreshFilters();
+    }
+
+    moveTo(x: number, y: number, z: number): void {
+        this.panner.positionX.value = x;
+        this.panner.positionY.value = y;
+        this.panner.positionZ.value = z;
+    }
+
+    private refreshFilters(): void {
+        let connection = this.source;
+        this.source.disconnect();
+        connection = this.applyFilters(connection);
+        connection.connect(this.gainNode);
+    }
+}
+
+
+export class Group implements BaseSound {
+    sounds: Sound[] = [];
+    position: number[] = [0, 0, 0];
+    loopCount: LoopCount = 0;
+
+    addSound(sound: Sound): void {
+        this.sounds.push(sound);
+    }
+
+    preplay(): Playback[] {
+        return this.sounds.reduce<Playback[]>((playbacks, sound) => {
+            sound.loop(this.loopCount);
+            return playbacks.concat(sound.preplay());
+        }, []);
+    }
+
+    play(): Playback[] {
+        return this.preplay().map(playback => {
+            playback.play();
+            return playback;
+        });
+    }
+
+    stop(): void {
+        this.sounds.forEach(sound => sound.stop());
+    }
+
+    pause(): void {
+        this.sounds.forEach(sound => sound.pause());
+    }
+
+    resume(): void {
+        this.sounds.forEach(sound => {
+            if ('resume' in sound.context) {
+                sound.context.resume();
+            }
+        });
+    }
+
+    loop(loopCount?: LoopCount): LoopCount {
+        if (loopCount === undefined) {
+            return this.loopCount;
+        }
+        this.loopCount = loopCount;
+        this.sounds.forEach(sound => sound.loop(loopCount));
+        return this.loopCount;
+    }
+
+    addFilter(filter: BiquadFilterNode): void {
+        this.sounds.forEach(sound => sound.addFilter(filter));
+    }
+
+    removeFilter(filter: BiquadFilterNode): void {
+        this.sounds.forEach(sound => sound.removeFilter(filter));
+    }
+
+    moveTo(x: number, y: number, z: number): void {
+        this.position = [x, y, z];
+        this.sounds.forEach(sound => sound.moveTo(x, y, z));
+    }
+
+
+}
+

package/src/index.ts

@@ -0,0 +1 @@
+export * from './cacophony';

package/tsconfig.json

@@ -0,0 +1,104 @@
+{
+  "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": "ES6", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    "lib": [
+      "ES6",
+      "DOM"
+    ], /* 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": "./src", /* 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. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
+    "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
+    /* Type Checking */
+    "strict": true, /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true /* Skip type checking all .d.ts files. */
+  }
+}